feature: created preliminary ProFTPd installation task handler that configures ProFTPd

host_vars/vps1

@@ -56,6 +56,7 @@ users:
   # @NOTE key/field names MUST match value of 'username' key or field of its object
   senpai:
     username: senpai
+    id: 1000
     password: !vault |
           $ANSIBLE_VAULT;1.2;AES256;vps1-senpai
           62626662666239376237616464626630393562373130623934653764333139346337313539613863
@@ -113,6 +114,7 @@ users:
       email: ajt95@prole.biz
   ftp:
     username: ftp
+    id: 999
     password: ~
     shell: /sbin/nologin
     home: /srv/ftp

roles/bootstrap/handlers/proftpd.yml

@@ -3,4 +3,67 @@
 # handlers file for bootstrap
 - name: Configure ProFTPd server
   listen: proftpd
+  become: true
   block:
+    - name: Create ProFTPd non-web user subdirectories
+      ansible.builtin.file:
+        follow: true
+        force: true
+        group: "{{ item.value.chown.split(':')[0] }}"
+        owner: "{{ item.value.chown.split(':')[1] }}"
+        path: "{{ item.value.chroot }}"
+        state: directory
+      loop: "{{ lookup('ansible.builtin.dict', config.proftpd.vusers) }}"
+    # @TODO complete below commented out tasks
+    # - name: Provide TLS/SSL resources for FTPS capabilities with ProFTPd
+    # - name: Load prerequisite modules for intended configuration
+    - name: Configure ProFTPd main control server
+      ansible.builtin.template:
+        backup: true
+        comment_end_string: "#}"
+        comment_start_string: "{#"
+        dest: /etc/proftpd/proftpd.conf
+        follow: true
+        force: true
+        group: root
+        owner: root
+        src: proftpd/proftpd.conf.j2
+        validate: proftpd --configtest
+      vars:
+        ftp_server_name: init
+    - name: Configure ProFTPd global settings
+      ansible.builtin.template:
+        backup: true
+        comment_end_string: "#}"
+        comment_start_string: "{#"
+        dest: /etc/proftpd/conf.d/global.conf
+        follow: true
+        force: true
+        group: root
+        owner: root
+        src: proftpd/conf.d/global.conf.j2
+        validate: proftpd --configtest
+      vars:
+        pasv_ports: "49152 65534"
+        max_conns: 30
+        allow_symlinks: false
+    - name: Create ProFTPd FTPS virtual host
+      ansible.builtin.template:
+        backup: true
+        comment_end_string: "#}"
+        comment_start_string: "{#"
+        dest: "/etc/proftpd/conf.d/{{ config.proftpd.name.lowercase() }}.conf"
+        follow: true
+        force: true
+        group: root
+        owner: root
+        src: proftpd/conf.d/vhost@vps1.conf.j2
+        validate: proftpd --configtest
+      vars:
+        ftp_server_name: "{{ config.proftpd.name }}'s Archive'"
+    # @TODO finish constructing below block task
+    # - name: Add virtual users to ProFTPd FTPS virtual host
+    #   block:
+    #     - name: Create the virtual users
+    #     - name: Specify what virtual users are allowed login
+    #     - name: Specify restrictions for virtual users on the directories they will reside in

roles/bootstrap/tasks/create_users@linux.yml

@@ -5,7 +5,7 @@
   ansible.builtin.group:
     name: "{{ item.value.group_name }}"
     state: present
-    system: "{{ 'true' if item.value.type == 'system' else 'false' }}"
+    system: "{{ item.value.type == 'system' }}"
   loop: "{{ lookup('ansible.builtin.dict', hostvars[inventory_hostname].groups) }}"
 - name: Create users
   block:
@@ -20,10 +20,11 @@
         ssh_key_type: "ed25519"
         group: "{{ item.value.group | default(item.value.username) }}"
         name: "{{ item.value.username }}"
+        uid: "{{ item.value.id }}"
         shell: "{{ item.value.shell }}"
         password: "{{ item.value.password }}"
         state: present
-        system: "{{ 'true' if item.value.type == 'system' else 'false' }}"
+        system: "{{ item.value.type == 'system' }}"
         update_password: always
       loop: "{{ lookup('ansible.builtin.dict', hostvars[inventory_hostname].users) }}"
     - name: Create regular users
@@ -35,10 +36,11 @@
         generate_ssh_key: true
         group: "{{ item.value.group | default(item.value.username) }}"
         name: "{{ item.value.username }}"
+        uid: "{{ item.value.id }}"
         shell: "{{ item.value.shell }}"
         password: "{{ item.value.password }}"
         state: present
-        system: "{{ 'true' if item.value.type == 'system' else 'false' }}"
+        system: "{{ item.value.type == 'system' }}"
         update_password: always
       loop: "{{ lookup('ansible.builtin.dict', hostvars[inventory_hostname].users) }}"
     - name: Create users for managing data related to services
@@ -49,9 +51,10 @@
         home: "{{ item.value.home | default('/home/' ~ item.value.username) }}"
         group: "{{ item.value.group | default(item.value.username) }}"
         name: "{{ item.value.username }}"
+        uid: "{{ item.value.id }}"
         shell: "{{ item.value.shell }}"
         state: present
-        system: "{{ 'true' if item.value.type == 'system' else 'false' }}"
+        system: "{{ item.value.type == 'system' }}"
       loop: "{{ lookup('ansible.builtin.dict', hostvars[inventory_hostname].users) }}"
 - name: Adjust users' groups
   when: item.value.groups is not None and len(item.value.groups) > 0

roles/bootstrap/templates/proftpd/conf.d/global.conf.j2

@@ -0,0 +1,22 @@
+<Global>
+    PassivePorts {{ pasv_ports }}
+    RequireValidShell off
+    MaxInstances {{ max_conns }}
+    {% if allow_symlinks %}
+    ShowSymlinks on
+    {% else %}
+    ShowSymlinks off
+    {% endif %}
+
+    DisplayLogin WELCOME.msg
+    DisplayChdir .README.md true
+    DisplayConnect BANNER.msg
+    DisplayFileTransfer SUCCESS.msg
+
+    TimeoutNoTransfer 3600
+    TimeoutStalled 210
+    TimeoutIdle 1400
+
+    Umask 022 022
+    AllowOverwrite on
+</Global>

roles/bootstrap/templates/proftpd/conf.d/vhost@vps1.conf.j2

@@ -0,0 +1,43 @@
+<VirtualHost 0.0.0.0>
+    ServerName {{ ftp_server_name }}
+    ServerIdent on "You have arrived at {{ server_name }}!"
+    ServerAlias {{ hostvars[inventory_hostname].fqdn }}
+    ServerAlias ftp.{{ hostvars[inventory_hostname].fqdn }}
+    ServerAlias {{ hostvars[inventory_hostname].fqdn.split('.')[0] }}
+    ServerLog /var/log/proftpd/{{ hostvars[inventory_hostname].fqdn.split('.')[0] }}.log
+    Protocols ftps
+    Port 990
+
+    # AuthOrder mod_auth_pam.c mod_auth_unix.c*
+    AuthOrder mod_auth_file.c
+    AuthUserFile /etc/proftpd/ftpd.passwd
+    AuthGroupFile /etc/proftpd/ftpd.group
+    AuthFileOptions SyntaxCheck
+
+    TLSEngine on
+    TLSLog /var/log/proftpd/tls.log
+    # @NOTW: "AALv23" means all SSL versions
+    TLSProtocol SSLv23
+    TLSOptions AllowClientRenegotiations
+    TLSVerifyClient off
+    TLSRequired on
+    TLSRenegotiate required off
+
+    TLSECCertificateFile {{ config.proftpd.tls_paths.cert }}
+    TLSECCertificateKeyFile {{ config.proftpd.tls_paths.privkey }}
+    TLSCACertificateFile {{ config.proftpd.tls_paths.cert }}
+
+    <Anonymous /srv/ftp/public>
+        UserAlias anon smuggler
+
+        <Directory *>
+            <Limit WRITE CDUP CWD PWD>
+                DenyAll
+            </Limit>
+
+            <Limit READ>
+                AllowAll
+            </Limit>
+        </Directory>
+    </Anonymous>
+<VirtualHost>

roles/bootstrap/templates/proftpd/proftpd.conf.j2

@@ -0,0 +1,186 @@
+#
+# /etc/proftpd/proftpd.conf -- This is a basic ProFTPD configuration file.
+# To really apply changes, reload proftpd after modifications, if
+# it runs in daemon mode. It is not required in inetd/xinetd mode.
+#
+
+# Includes DSO modules
+Include /etc/proftpd/modules.conf
+
+# Set off to disable IPv6 support which is annoying on IPv4 only boxes.
+UseIPv6 on
+# If set on you can experience a longer connection delay in many cases.
+<IfModule mod_ident.c>
+    IdentLookups off
+</IfModule>
+
+ServerName "{{ ftp_server_name }}"
+# Set to inetd only if you would run proftpd by inetd/xinetd/socket.
+# Read README.Debian for more information on proper configuration.
+ServerType standalone
+DeferWelcome off
+
+# Disable MultilineRFC2228 per https://github.com/proftpd/proftpd/issues/1085
+# MultilineRFC2228on
+DefaultServer on
+
+DenyFilter \*.*/
+
+# Use this to jail all users in their homes 
+DefaultRoot ~
+
+# Users require a valid shell listed in /etc/shells to login.
+# Use this directive to release that constrain.
+# RequireValidShell off
+
+# Port 21 is the standard FTP port.
+Port 21
+
+# If your host was NATted, this option is useful in order to
+# allow passive tranfers to work. You have to use your public
+# address and opening the passive ports used on your firewall as well.
+# MasqueradeAddress 1.2.3.4
+
+# This is useful for masquerading address with dynamic IPs:
+# refresh any configured MasqueradeAddress directives every 8 hours
+# <IfModule mod_dynmasq.c>
+# DynMasqRefresh 28800
+# </IfModule>
+
+# Set the user and group that the server normally runs at.
+User proftpd
+Group nogroup
+
+# Uncomment this if you are using NIS or LDAP via NSS to retrieve passwords:
+# PersistentPasswd off
+
+# This is required to use both PAM-based authentication and local passwords
+# AuthOrder mod_auth_pam.c* mod_auth_unix.c
+
+# Be warned: use of this directive impacts CPU average load!
+# Uncomment this if you like to see progress and transfer rate with ftpwho
+# in downloads. That is not needed for uploads rates.
+#
+# UseSendFile off
+
+TransferLog /var/log/proftpd/transfer.log
+SystemLog /var/log/proftpd/connection.log
+
+# Logging onto /var/log/lastlog is enabled but set to off by default
+#UseLastlog on
+
+# In order to keep log file dates consistent after chroot, use timezone info
+# from /etc/localtime.  If this is not set, and proftpd is configured to
+# chroot (e.g. DefaultRoot or <Anonymous>), it will use the non-daylight
+# savings timezone regardless of whether DST is in effect.
+#SetEnv TZ :/etc/localtime
+
+<IfModule mod_quotatab.c>
+    QuotaEngine off
+</IfModule>
+
+<IfModule mod_ratio.c>
+    Ratios off
+</IfModule>
+
+
+# Delay engine reduces impact of the so-called Timing Attack described in
+# http://www.securityfocus.com/bid/11430/discuss
+# It is on by default. 
+<IfModule mod_delay.c>
+    DelayEngine on
+</IfModule>
+
+<IfModule mod_ctrls.c>
+    ControlsEngine off
+    ControlsMaxClients 2
+    ControlsLog /var/log/proftpd/controls.log
+    ControlsInterval 5
+    ControlsSocket /var/run/proftpd/proftpd.sock
+</IfModule>
+
+<IfModule mod_ctrls_admin.c>
+    AdminControlsEngine off
+</IfModule>
+
+#
+# Alternative authentication frameworks
+#
+#Include /etc/proftpd/ldap.conf
+#Include /etc/proftpd/sql.conf
+
+#
+# This is used for FTPS connections
+#
+#Include /etc/proftpd/tls.conf
+
+#
+# This is used for SFTP connections
+#
+#Include /etc/proftpd/sftp.conf
+
+#
+# This is used for other add-on modules
+#
+#Include /etc/proftpd/dnsbl.conf
+#Include /etc/proftpd/geoip.conf
+#Include /etc/proftpd/snmp.conf
+
+#
+# Useful to keep VirtualHost/VirtualRoot directives separated
+#
+#Include /etc/proftpd/virtuals.conf
+
+# A basic anonymous configuration, no upload directories.
+
+# <Anonymous ~ftp>
+#   User ftp
+#   Group nogroup
+#   # We want clients to be able to login with "anonymous" as well as "ftp"
+#   UserAlias anonymous ftp
+#   # Cosmetic changes, all files belongs to ftp user
+#   DirFakeUser on ftp
+#   DirFakeGroup on ftp
+# 
+#   RequireValidShell off
+# 
+#   # Limit the maximum number of anonymous logins
+#   MaxClients 10
+# 
+#   # We want 'welcome.msg' displayed at login, and '.message' displayed
+#   # in each newly chdired directory.
+#   DisplayLogin welcome.msg
+#   DisplayChdir .message
+# 
+#   # Limit WRITE everywhere in the anonymous chroot
+#   <Directory *>
+#     <Limit WRITE>
+#       DenyAll
+#     </Limit>
+#   </Directory>
+# 
+#   # Uncomment this if you're brave.
+#   # <Directory incoming>
+#   #   # Umask 022 is a good standard umask to prevent new files and dirs
+#   #   # (second parm) from being group and world writable.
+#   #   Umask 022  022
+#   #   <Limit READ WRITE>
+#   #     DenyAll
+#   #     </Limit>
+#   #       <Limit STOR>
+#   #         AllowAll
+#   #     </Limit>
+#   # </Directory>
+# 
+# </Anonymous>
+
+<Limit LOGIN>
+    DenyAll
+</Limit>
+
+# Include other custom configuration files
+# !! Please note, that this statement will read /all/ file from this subdir,
+# i.e. backup files created by your editor, too !!!
+# Eventually create file patterns like this: /etc/proftpd/conf.d/*.conf
+# 
+Include /etc/proftpd/conf.d/

roles/bootstrap/vars/main/software.yml

@@ -214,4 +214,22 @@ config:
   git:
     sys:
       editor: nvim
+  proftpd:
+    name: "{{ hostvars[inventory_hostname].fqdn.split('.')[0] }}"
+    vusers:
+      # webmaster:
+      #   username: webmaster
+      #   chroot: "/srv/www/{{ fqdn }}"
+      #   chown: "caddy:caddy"
+      #   # @TODO create vaulted password for this ProFTPd virtual user
+      #   password: ~
+      smuggler:
+        username: smuggler
+        chroot: /srv/ftp/smuggler
+        chown: "{{ hostvars[inventory_hostname].users.ftp.username }}:{{ hostvars[inventory_hostname].users.ftp.group | default(hostvars[inventory_hostname].users.ftp.username) }}"
+        # @TODO create vaulted password for this ProFTPd virtual user
+        password: ~
+    tls_paths:
+      cert: /etc/proftpd/certs/cert.pem
+      privkey: /etc/proftpd/certs/private-key.pem