--- categories: web title: Howto ProFTPD ... * Documentation : [ProFTPD](http://www.proftpd.org/) est un serveur [FTP](https://fr.wikipedia.org/wiki/File_Transfer_Protocol) libre. Il est particulièrement configurable grâce à des modules. Il permet notamment de facilement restreindre un compte dans un répertoire donné ("_chroot_") ou d'utiliser les protocoles FTPS (FTP over SSL/TLS) et SFTP/SCP (FTP over SSH). ## Installation ~~~{bash} # apt install proftpd # proftpd -v ProFTPD Version 1.3.5b # systemctl status proftpd ● proftpd.service - LSB: Starts ProFTPD daemon Loaded: loaded (/etc/init.d/proftpd; generated; vendor preset: enabled) Docs: man:systemd-sysv-generator(8) Process: 28249 ExecStop=/etc/init.d/proftpd stop (code=exited, status=0/SUCCESS) Process: 22916 ExecReload=/etc/init.d/proftpd reload (code=exited, status=0/SUCCESS) Process: 28259 ExecStart=/etc/init.d/proftpd start (code=exited, status=0/SUCCESS) Tasks: 1 (limit: 4915) CGroup: /system.slice/proftpd.service └─28267 proftpd: (accepting connections) ~~~ ## Configuration ### Configuration simple Le fichier de configuration principal est `/etc/proftpd/proftpd.conf`. Vous pouvez aussi ajouter des fichiers `.conf` pour customiser la configuration dans `/etc/proftpd/conf.d`, qui sont inclus à la fin de `/etc/proftpd/proftpd.conf` et permettent d'écraser les directives générales. Voici les directives que nous conseillons de changer : ~~~ ServerName "Foo FTP Server" PassivePorts 60000 61000 MaxInstances 50 MaxClients 40 MaxClientsPerHost 20 Umask 137 027 UseReverseDNS off IdentLookups off TimesGMT off DefaultRoot ~ RequireValidShell off UseFtpUsers off ServerIdent on "FTP Server Ready" AccessGrantMsg "Hey, bienvenue %u sur le serveur FTP example.com !" # Allow RESUME (REST command) AllowStoreRestart on AllowUser $ftp_user AllowGroup $ftp_group DenyAll ~~~ Dans cette configuration, un utilisateur doit être dans le groupe `$ftp_group` (à créer) pour utiliser le FTP. Si l'IPv6 n'est pas fonctionnel sur votre serveur : ~~~ UseIPv6 off ~~~ **Configuration des firewalls** Sur le firewall côté serveur, il faut ouvrir les ports 20 et 21, et les ports passifs : ~~~ iptables -A INPUT -p tcp --dport 60000:61000 -m state --state NEW,ESTABLISHED -j ACCEPT ~~~ S'il y a également des restrictions côté client (dans le cas d'un serveur voulant accéder en FTP à un autre), il faut autoriser les paquets entrants : ~~~ iptables -A INPUT -p tcp --sport 20 --dport 1024:65535 -m state --state ESTABLISHED -j ACCEPT iptables -A INPUT -p tcp --sport 21 --dport 1024:65535 -m state --state ESTABLISHED -j ACCEPT iptables -A INPUT -p tcp --sport 60000:61000 --dport 1024:65535 -m state --state NEW,ESTABLISHED -j ACCEPT ~~~ ### Configuration dans différents VirtualHost D'une manière similaire à [Apache](HowtoApache), on peut isoler des configurations FTP dans différents VirtualHost. Cela permet notamment de faire écouter ProFTPD sur 2 ports différents en même temps. Par exemple, pour mettre en place à la fois un FTP classique et un SFTP. Note : A Evolix, nous ne proposons pour l'instant pas, sauf exception, les protocoles SFTP et FTPS. Autre exemple : on laisse la configuration par défaut écouter sur le port 21, et on fait écouter un VirtualHost sur le port 8887. La balise `VirtualHost` accepte les adresses IP et les noms de domaine. Voici un exemple de configuration classique qui écoute sur un port différent dans un VirtualHost : ~~~ # vim /etc/proftpd/conf.d/my_vhost.conf ServerName "FTP Server" ServerIdent on "FTP Server Ready" AccessGrantMsg "Hey, bienvenue %u sur le serveur FTP !" SFTPEngine on Port 8887 DefaultRoot ~ PassivePorts 60000 61000 UseReverseDNS off IdentLookups off TimesGMT off # Local permissions DefaultRoot ~ Umask 137 027 RequireValidShell off UseFtpUsers off # Allow RESUME (REST command) AllowStoreRestart on ~~~ Si l'on veut faire écouter deux VirtualHost sur deux IPs différentes (publique ou LAN) mais sur le même port, il faut utiliser ces options avant la directive `` : ~~~ Port 0 SocketBindTight on ~~~ Cela va forcer à utiliser l'IP configurée dans la directive `` avec le port indiqué dans celui-ci. Exemple avec une configuration SFTP : ~~~ Port 0 SocketBindTight on SFTPEngine on Port 22 DefaultRoot ~ RequireValidShell off AuthUserFile /etc/proftpd/vpasswd ~~~ Les VirtualHosts ont de nombreuses autres fonctionnalités, comme les Alias par exemple. Voir la documentation : . ### NAT En mode passif, si le serveur ProFTPd se trouve derrière un NAT, autrement dit qu'il n'a pas adresse IP publique assignée à l'une de ses interface, il faut forcer l'IP que le client va recevoir afin qu'il puisse se connecter au serveur. Dans ProFTPd ça se fait avec la directive [`MasqueradeAddress`](http://www.proftpd.org/docs/howto/NAT.html). ``` From 192.0.2.0/24 MasqueradeAddress 203.0.113.1 ``` Ici, les clients FTP en dehors du sous-réseau `192.0.2.0/24` recevrons l'IP `203.0.113.1` à laquelle ils vont essayer de se connecter pour passer en mode FTP passif. ## Gestion des utilisateurs ProFTPD permet l'authentification via les comptes Unix, un fichier de configuration simple, PAM, une base de données SQL, LDAP. Les comptes ont les mêmes attributs qu'un compte Unix : username, password, uid, gid, gecos, homedir, shell. Lorsqu'un compte FTP utilise un UID et un GID non définis dans `/etc/passwd`, il est dit "virtuel". On détaille ici l'utilisation de comptes définis dans un fichier `/etc/proftpd/vpasswd`. Il faut ajouter dans `/etc/proftpd/proftpd.conf` : ~~~ AuthOrder mod_auth_file.c AuthUserFile /etc/proftpd/vpasswd ~~~ **Attention :** Le fichier `/etc/proftpd/vpasswd` doit avoir les droits en 600, sinon ProFTPD refuse de se lancer. La gestion des comptes se fait ensuite via le script Perl `ftpasswd` inclu avec ProFTPD. Documentation : * * ### Ajouter un compte #### Dans un répertoire existant, appartenant déjà à un utilisateur Unix Dans ce cas, les `$ftp_uid` et `$ftp_gid` doivent être ceux du compte Unix propriétaire du répertoire : ~~~{bash} # ftp_home=... # répertoire racine du compte FTP # ftp_uid=$(stat -c '%u' "${ftp_home}") # UID du compte FTP # ftp_gid=$(stat -c '%g' "${ftp_home}") # GID du compte FTP # ftp_user=... # nom du futur utilisateur FTP # apg -n 1 -m 14 # génération du mot de passe # ftpasswd --file=/etc/proftpd/vpasswd --name="${ftp_user}" --home="${ftp_home}" --shell=/bin/false --uid="${ftp_uid}" --gid="${ftp_gid}" --passwd ~~~ #### Avec un nouveau répertoire racine, dédié à l'utilisateur FTP Dans ce cas, on choisit des `$ftp_uid` et `$ftp_gid` qui ne sont pas utilisés dans `/etc/passwd`. Pour lister les UID et GID déjà utilisés : `cut -d: -f1,3,4 /etc/passwd` Puis, on crée le répertoire racine, possédé par les numéros `$ftp_uid` et `$ftp_gid` de l'utilisateur FTP. Attention : **ne pas utiliser le nom du compte FTP dans `chown`** (Unix ne le reconnaît pas car le compte FTP n'est pas dans `/etc/passwd`). ~~~{bash} # ftp_home=... # répertoire racine du compte FTP # ftp_uid=... # UID du compte FTP # ftp_gid=... # GID du compte FTP # mkdir "${ftp_home}" # chown "${ftp_uid}:${ftp_gid}" -R "${ftp_home}" # ftp_user=... # nom du futur utilisateur FTP # apg -n 1 -m 12 # génération du mot de passe # ftpasswd --passwd --file=/etc/proftpd/vpasswd --name="${ftp_user}" --home="${ftp_home}" --shell=/bin/false --uid="${ftp_uid}" --gid="${ftp_gid}" ~~~ ### Changer le mot de passe Pour changer le mot de passe d'un compte : ~~~{bash} # ftp_user=... # nom du compte FTP # apg -n 1 -m 12 # génération du mot de passe # ftpasswd --passwd --file /etc/proftpd/vpasswd --name="${ftp_user}" --change-password ~~~ ### Supprimer un compte Pour supprimer un compte : ~~~{bash} # ftp_user=... # nom du compte FTP à supprimer # ftpasswd --passwd --file=/etc/proftpd/vpasswd --name="${ftp_user}" --delete-user ~~~ ## Restriction des commandes et accès avec la directive Limit Documentation : * * La directive `Limit` permet d'autoriser ou empêcher l'exécution de commandes FTP bas niveau. **Attention :** C'est puissant et dangereux, car on pourrait croire que l'on empêche la lecture d'un fichier, mais il faut avoir en tête qu'il existe plusieurs commandes FTP pour faire cela. Il existe des groupes de commandes : LOGIN, DIRS, READ, WRITE et enfin ALL (tout sauf LOGIN). Si on a plusieurs vhost qui doivent avoir les mêmes limites, on créé un fichier `/etc/proftpd/access_control.conf` dans lequel on définit la gestion commune des droits. Puis, on l'inclus dans les différents vhost avec la directive `Include /etc/proftpd/access_control.conf`. ### Empêcher toutes les opérations sauf dans un répertoire ~~~ DenyAll AllowAll ~~~ ### Autoriser uniquement le dépôt de fichiers dans un répertoire ~~~ DenyAll AllowAll ~~~ ### Avoir un utilisateur en lecture seule, confiné dans son `$ftp_home` ~~~ AllowUser $ftp_user DenyUser $ftp_user ~~~ ### Blacklister les connexions depuis une IP ou un hôte, en autorisant seulement certains comptes ~~~ Deny from $IP AllowUser $ftp_user1 AllowUser $ftp_user2 ~~~ Cette configuration refuse toutes les connexions au serveur depuis `$IP`, mais accepte les connexions aux utilisateurs `$ftp_user1` et `$ftp_user2`, à l'exception de tous les autres utilisateurs. **Attention :** Dans ce dernier cas, s'il y a plusieurs blocs / directives LOGIN dans la configuration ou le VirtualHost, il faut autoriser les utilisateurs dans toutes ces directives, sinon l'accès sera refusé tout le temps. ### Filtrer l'accès à un compte par IP (whitelist) ~~~ AllowUser $ftp_user1 AllowUser $ftp_user2 AllowUser $ftp_user3 DenyAll Allow from $IP1 $IP2/24 Allow from $IP3 # Et autres ACLs DenyAll ~~~ **Attention** : Bien respecter l'ordre des directives et des blocs, sinon l'effet sera différents de celui attendu. ## Divers Pour limiter les uploads de fichiers de taille supérieure à 50 Mo : ~~~ MaxStoreFileSize 50 Mb ~~~ Forcer les droits 640 en fichier et 750 en répertoire avec l'umask: ~~~ Umask 0137 0027 DenyAll ~~~ ## Quota Pour activer les quotas spécifiquement à ProFTPD avec gestion via fichiers : ~~~{bash} # cd /etc/proftpd # ftpquota --create-table --type=limit # ftpquota --create-table --type=tally ~~~ Puis ajouter dans la configuration : ~~~ QuotaEngine on QuotaLimitTable file:/etc/proftpd/ftpquota.limittab QuotaTallyTable file:/etc/proftpd/ftpquota.tallytab ~~~ On peut ensuite positionner des quotas, par exemple pour limiter les données uploadées à 200 Go : ~~~{bash} # ftpquota --add-record --type=limit --bytes-upload=200 --units=Gb --name=foo --quota-type=user ~~~ Imaginons que vous positionnez le quota alors que l'utilisateur a déjà 170 Go, vous devez mettre à jour son compteur : ~~~{bash} # ftpquota --update-record --type=tally --bytes-upload=170 --units=Gb --name=foo --quota-type=user ~~~ On peut lister les données de quota sur le serveur ainsi : ~~~{bash} # ftpquota --show-records --type=tally ------------------------------------------- Name: foo Quota Type: User Uploaded bytes: 182536110080.00 Downloaded bytes: 0.00 Transferred bytes: 0.00 Uploaded files: 0 Downloaded files: 0 Transferred files: 0 # ftpquota --show-records --type=limit ------------------------------------------- Name: foo Quota Type: User Per Session: False Limit Type: Hard Uploaded bytes: 214748364800.00 Downloaded bytes: unlimited Transferred bytes: unlimited Uploaded files: unlimited Downloaded files: unlimited Transferred files: unlimited ~~~ Via FTP, vous pourrez voir les données de quota ainsi : ~~~{bash} ftp> quote SITE QUOTA 200-Quota pour la session actuelle [courant / limite]: 200-Nom: foo 200-Type quota: Utilisateur 200-Par session : Faux 200-Type de limite : matérielle 200- bytes: 182536110080.00/193273528320.00 envoyés 200- bytes: unlimited reçus 200- bytes: unlimited téléchargés 200- files: unlimited envoyés 200- files: unlimited reçus 200- files: unlimited téléchargés 200 Veuillez contacter ftpmaster@example.com si ces données sont inexactes ~~~ Enfin, on peut réinitialiser un compteur (tous les jours par exemple) : ~~~{bash} # ftpquota --update-record --type=tally --name=foo --quota-type=user ~~~ Ou même effacer toutes les données de quota d'un utilisateur : ~~~{bash} # ftpquota --delete-record --type=limit --name=foo --quota-type=user # ftpquota --delete-record --type=tally --name=foo --quota-type=user ~~~ ## FTPS (FTP over SSL/TLS) Note : A Evolix, nous ne proposons pour l'instant pas, sauf exception, les protocoles SFTP et FTPS. On peut activer SSL/TLS en créant un fichier `/etc/proftpd/tls.conf` contenant les directives suivantes : ~~~{bash} # vim /etc/proftpd/tls.conf TLSEngine on TLSLog /var/log/proftpd/tls.log TLSProtocol SSLv23 TLSRSACertificateFile /etc/proftpd/ssl/proftpd.crt TLSCACertificateFile /etc/proftpd/ssl/proftpd.ca.crt TLSRSACertificateKeyFile /etc/proftpd/ssl/proftpd.key ~~~ Vérifiez que les certificats et la clé privé existent bien. Il faut vérifier que le fichier est bien chargé par la configuration principale `/etc/proftpd/proftpd.conf` : ~~~{bash} # vim /etc/proftpd/proftpd.conf Include /etc/proftpd/tls.conf ~~~ Testez la configuration et rechargez la configuration : ~~~{bash} # proftpd -t && systemctl reload proftpd.service ~~~ Testez la connexion : ~~~{bash} # host=... # IP ou domaine # lftp $host lftp host:~> set ftp:ssl-force true lftp host:~> login $ftp_user Mot de passe : lftp $ftp_user@host:~> ls ~~~ Si l'on peut lire le contenu du répertoire, alors la connexion est fonctionnelle. ## SFTP (FTP over SSH) A Evolix, sauf exception, nous préférons utiliser OpenSSH, [qui propose lui aussi le protocole SFTP](HowtoOpenSSH#sftp). Généralement, on souhaite conserver un service FTP "classique" en parallèle de SFTP. On met donc sa configuration dans un VirtualHost, pour pouvoir écouter sur un deuxième port : ~~~ $ vim /etc/proftpd/conf.d/sftp.conf LoadModule mod_sftp.c SFTPEngine on Port 2022 DefaultRoot ~ SFTPLog /var/log/proftpd/sftp.log SFTPAuthMethods password publickey # Uncomment ed25519 if ProFTPD >= 1.3.7 (Bullseye) # SFTPHostKey /etc/ssh/ssh_host_ed25519_key SFTPHostKey /etc/ssh/ssh_host_ecdsa_key SFTPHostKey /etc/ssh/ssh_host_rsa_key SFTPAuthorizedUserKeys file:/etc/proftpd/sftp.passwd.keys/%u AuthOrder mod_auth_file.c AuthUserFile /etc/proftpd/vpasswd RequireValidShell off ~~~ Note : Les clés publiques SSH des comptes SFTP dans le répertoire indiqué dans la directive [`SFTPAuthorizedUserKeys`](http://www.proftpd.org/docs/contrib/mod_sftp.html#SFTPAuthorizedUserKeys) doivent être au format de la RFC 4716, qui n'est pas le format par défaut de SSH. **Si votre version de ProFTPd est antérieur à la 1.3.7 (Debian Bullseye) :** Les clés SSH indiquées dans ler directives `SFTPHostKey` doivent être au format de la RFC 4716, qui n'est pas le format par défaut de SSH. Pour créer les clés privées compatibles côté serveur : ~~~{bash} # ssh-keygen -f /etc/ssh/ssh_host_rsa_key -t rsa -N '' -m PEM # ssh-keygen -f /etc/ssh/ssh_host_ecdsa_key -t ecdsa -N '' -m PEM ~~~ Si les fingerprints des clés sont stockées dans un système d'information, pensez à le mettre à jour (`ssh-keyscan localhost` est votre ami). ### Ajouter un compte SFTP avec clé SSH Suivre d'abord la section [Ajouter un compte](#ajouter-un-compte). Puis, convertir la clé publique au format de la RFC 4716 et ajuster les droits : ~~~{bash} $ ssh-keygen -e -f > /etc/proftpd/sftp.authorized_keys/ $ chmod 600 /etc/proftpd/sftp.authorized_keys/ ~~~ Dans la configuration SFTP (`/etc/proftpd/conf.d/sftp.conf`), ajouter le nouvel utilisateur à la directive `AllowUser` . Tester la configuration et la recharger : ~~~{bash} # proftpd -t && systemctl reload proftpd.service ~~~ Tester la connexion via un mot de passe : ~~~{bash} # lftp sftp://@: Mot de passe : lftp @:~> ls ~~~ ou bien : ~~~ $ sftp -P @ @'s password: Connected to sftp> ls ~~~ Si l'on peut lire le contenu du répertoire, alors la connexion est fonctionnelle. ### Troobleshooting clés SSH * Dans la configuration SFTP (`/etc/proftpd/conf.d/sftp.conf`), vérifier que la directive `SFTPAuthMethods` inclue `publickey` et que l'utilisateur est dans la liste des `AllowUser`. * Vérifier les permission du répertoire des clés publique SSH : ~~~ chmod 700 /etc/proftpd/sftp.authorized_keys/ ~~~ * Les fichiers de clés doivent être accessibles par l'utilisateur sous lequel ProFTPd tourne. Si les directives `User` et/ou `Group` sont utilisées, il faut ajuster les droits. Par exemple, avec `User=proftpd` et `Group=proftpd`, il faut (au minimum) que le dossier soit en `root:proftpd 0750` et les fichiers soient en `root:proftpd 0640`. * Les clés publiques SSH des comptes SFTP dans le répertoire indiqué dans la directive [`SFTPAuthorizedUserKeys`](http://www.proftpd.org/docs/contrib/mod_sftp.html#SFTPAuthorizedUserKeys) doivent être au format de la RFC 4716, qui n'est pas le format par défaut de SSH. * Si votre version de ProFTPd est antérieur à la 1.3.7, les clés SSH indiquées dans ler directives `SFTPHostKey` doivent être au format de la RFC 4716, qui n'est pas le format par défaut de SSH. ## Logs [fichier xferlog](http://www.castaglia.org/proftpd/doc/xferlog.html) ## Troubleshooting ### Problème d'envoi de fichier avec erreur `open for write: permission denied` L'erreur est provoquée lorsque l'on veut écraser un fichier existant, il faut rajouter la directive `AllowOverwrite on` dans le la configuration de ProFTPD ou du VirtualHost concerné. On la positionne dans une balise `` comme ceci : ~~~ AllowOverwrite on ~~~ ### Problèmes d'accès En cas d'erreurs d'accès, bien vérifier que les ports 20 et 21 sont ouverts, ainsi que les ports passifs : ~~~ iptables -A INPUT -p tcp --dport 60000:61000 -m state --state NEW,ESTABLISHED -j ACCEPT ~~~ En cas d'erreurs de permission, il vérifier que l’UID et le GID sont bien mis explicitement (en chiffres) comme propriétaires des répertoires et fichiers auxquels l'utilisateur FTP est censée avoir accès. En effet, ProFTPd n’est pas capable de lire les noms des utilisateurs Unix dans `/etc/passwd`. ### Client sent GLOBAL_REQUEST, denying D'après la [documentation de ProFTPd](http://www.proftpd.org/docs/howto/KeepAlives.html), ce message dans les logs n'est pas une erreur mais fait partie des mécanismes normaux de keep-alive de SSH : ~~~ 2023-06-26 11:31:50,812 mod_sftp/0.9.9[15505]: client sent GLOBAL_REQUEST for 'keepalive@jcraft.com', denying ~~~ On peut le vérifier dans la fonction `handle_global_request_msg()` du [code-source](https://github.com/proftpd/proftpd/blob/master/contrib/mod_sftp/packet.c), en cas de `GLOBAL_REQUEST`, ce message est toujours écrit dans les logs.