pure-ftpd.8

功能强大的ftp服务器源代码

.\"
.\" Troll-FTPd is Copyright 1995-2000 Trolltech AS, and Copyright 2001-2002 Arnt Gulbrandsen.
.\" Pure-FTPd is (C)opyleft 2001-2003 by Frank DENIS <[e-mail]> and the Pure-FTPd team.
.\"
.\" Use, modification and distribution is allowed without limitation, warranty, or liability of any kind.
.\"
.TH "pure-ftpd" "8" "1.0.17" "Pure-FTPd Team" "Pure-FTPd"
.SH "NAME"
pure\-ftpd \- simple File Transfer Protocol server

.SH "SYNOPSIS"
.B pure\-ftpd [\-0] [\-1] [\-4] [\-a gid] [\-A] [\-b] [\-B] [\-c clients] [\-C cnx/ip] [\-d [\-d]] [\-D] [\-e] [\-E] [\-f facility] [\-F fortunes file] [\-g pidfile] [\-G] [\-H] [\-i] [\-I] [\-j] [\-k percentage] [\-K] [\-l authentication[:config file]] [\-L max files:max depth] [\-m maxload] [\-M] [\-n maxfiles:maxsize] [\-N] [\-o] [\-O format:log file] [\-p first:last] [\-P ip address or host name] [\-q upload:download ratio] [\-Q upload:download ratio] [\-r] [\-R] [\-s] [\-S [address,][port]] [\-t upload bandwidth:download bandwidth] [\-T upload bandwidth:download bandwidth] [\-u uid] [\-U umask files:umask dirs] [\-V ip address] [\-w] [\-W] [\-x] [\-X] [\-y max user sessions:max anon sessions] [\-Y tls behavior] [\-z] [\-Z]

.br
Alternative style :
.br
\-0 \-\-notruncate
.br
\-1 \-\-logpid
.br
\-4 \-\-ipv4only
.br
\-a \-\-trustedgid
.br
\-A \-\-chrooteveryone
.br
\-b \-\-brokenclientscompatibility
.br
\-B \-\-daemonize
.br
\-c \-\-maxclientsnumber
.br
\-C \-\-maxclientsperip
.br
\-d \-\-verboselog
.br
\-D \-\-displaydotfiles
.br
\-e \-\-anonymousonly
.br
\-E \-\-noanonymous
.br
\-f \-\-syslogfacility
.br
\-F \-\-fortunesfile
.br
\-g \-\-pidfile
.br
\-G \-\-norename
.br
\-h \-\-help
.br
\-H \-\-dontresolve
.br
\-i \-\-anonymouscantupload
.br
\-I \-\-maxidletime
.br
\-j \-\-createhomedir
.br
\-k \-\-maxdiskusagepct
.br
\-K \-\-keepallfiles
.br
\-l \-\-login
.br
\-L \-\-limitrecursion
.br
\-m \-\-maxload
.br
\-M \-\-anonymouscancreatedirs
.br
\-n \-\-quota
.br
\-N \-\-natmode
.br
\-o \-\-uploadscript
.br
\-O \-\-altlog
.br
\-p \-\-passiveportrange
.br
\-P \-\-forcepassiveip
.br
\-q \-\-anonymousratio
.br
\-Q \-\-userratio
.br
\-r \-\-autorename
.br
\-R \-\-nochmod
.br
\-s \-\-antiwarez
.br
\-S \-\-bind
.br
\-t \-\-anonymousbandwidth
.br
\-T \-\-userbandwidth
.br
\-u \-\-minuid
.br
\-U \-\-umask
.br
\-V \-\-trustedip
.br
\-w \-\-allowuserfxp
.br
\-W \-\-allowanonymousfxp
.br
\-x \-\-prohibitdotfileswrite
.br
\-X \-\-prohibitdotfilesread
.br
\-y \-\-peruserlimits
.br
\-Y \-\-tls
.br
\-z \-\-allowdotfiles
.br
\-Z \-\-customerproof

.SH "DESCRIPTION"
.B Pure\-FTPd
is a small, simple server for the old and hairy File Transfer
Protocol, designed to use less resources than older servers, be
smaller and very secure, and to never execute any external program.
.PP
It support most\-used features and commands of FTP (including many modern
extensions), and leaves out everything which is deprecated, meaningless,
insecure, or correlates with trouble.
.PP
IPv6 is fully supported.

.SH "OPTIONS"
.TP
.B \-0
When a file is uploaded and there is already a previous version of the
file with the same name, the old file will neither get removed nor truncated.
Upload will take place in a temporary file and once the upload is complete,
the switch to the new version will be atomic. This option should not be used
together with virtual quotas.
.TP
.B \-1
Add the PID to the syslog output. Ignored if 
.B -f
.B none
is set.
.TP
.B \-4
Listen only for IPv4 connections. MANDATORY FOR IPv4 NETWORKS ON
OPENBSD, NETBSD, MICROBSD and FREEBSD 5.
.TP
.B \-a gid
Regular users will be chrooted to their home directories, unless
they belong to the specified gid. Note that root is always trusted,
and that chroot() occurs only for anonymous ftp without this option.
.TP
.B \-A
Chroot() everyone, but root.
.TP
.B \-b
Be broken. Turns on some compatibility hacks for shoddy clients, and for broken Netfilter gateways.
.TP
.B \-B
Start the standalone server in background (daemonize).
.TP
.B \-c clients
Allow a maximum of
.I clients
to be connected.
.I clients
must be at least 1, and if you combine it with
.B \-p
it will be forced down to half the number of ports specified by
.B \-p.
If more than
.I clients
are connected, new clients are rejected at once, even clients wishing
to upload, or to log in as normal users. Therefore, it is advisable
to use
.B \-m
as primary overload protection. The default value is 50.
.TP
.B \-C max connection per ip
Limit the number of simultanous connections
coming from the same IP address. This is yet another very effective way to
prevent stupid denial of services and bandwidth starvation by a single user.
It works only when the server is launched in standalone mode (if you use a
super\-server, it is supposed to do that). If the server is launched with
.B \-C 2
, it doesn't mean that the total number of connection is limited to 2.
But the same client, coming from the same machine (or at least the same IP),
can't have more than two simultaneous connections. This features needs some
memory to track IP addresses, but it's recommended to use it.
.TP
.B \-d
turns on debug logging. Every command is logged, except that the argument
to PASS is changed to "<password>". If you repeat
.B \-d
, responses too are logged.
.TP
.B \-e
Only allow anonymous users to log in.
.TP
.B \-E
Only allow authenticated login. Anonymous users are prohibited.
.TP
.B \-f facility
makes ftpd use
.I facility
for all
.BR syslog (3)
messages.
.I facility
defaults to
.BR ftp .
The facility names are normally listed in
.IR /usr/include/sys/syslog.h .
Note that if
.B \-f
is not the first option on the command line, a couple of messages may
be logged to local2 before the
.B \-f
option is parsed.
Use
.B \-f none
to disable logging.
.TP
.B \-F fortunes file
Display a funny random message in the initial login banner. The
random cookies are extracted from a text file, in the standard
.B fortune
format. If you installed the
.B fortune
package, you should have a directory
(usually
.B /usr/share/fortune
) with binary files (
.B xxxx.dat
) and text files
(without the
.B .dat
extension).
.TP
.B \-g pidfile
In standalone mode, write the pid to that file in instead of
/var/run/pure-ftpd.pid .
.TP
.B \-G
When this option is enabled, people can no more change the name of already
uploaded files, even if they own those files or their directory.
.TP
.B \-H
Don't resolve host names ("192.0.34.166" will be logged instead of
"www.example.com"). It can significantly speed up connections and reduce
bandwidth usage on busy servers. Use it especially on public FTP sites.
.TP
.B \-i
Disallow upload for anonymous users, whatever directory permissions
are. This option is especially useful for virtual hosting, to avoid your
users create warez sites in their account.
.TP
.B \-I timeout
Change the maximum idle time. The timeout is in minutes, and defaults to 15.
.TP
.B \-j
If the home directory of an user doesn't exist, automatically
create it. The newly created home directory belongs to the user, and
permissions are set according to the current directory mask. To avoid local
attacks, the parent directory should never belong to an untrusted user.
.TP
.B \-k percentage
Disallow upload if the partition is more than
.B percentage
full. Example:
\-k 95 will ensure that your disk will never get filled more than 95% by FTP
users.
.TP
.B \-K
Allow users to resume and upload files, but NOT to delete them. Directories
can be removed, but only if they are empty.
.TP
.B \-l authentication:file
Enable a new authentication method. It can be one of :
.I -l unix
For standard (/etc/passwd) authentication.
.I -l pam
For PAM authentication.
.I -l ldap:LDAP config file
For LDAP directories.
.I -l mysql:MySQL config file
For MySQL databases.
.I -l pgsql:Postgres config file
For Postgres databases.
.I -l puredb:PureDB database file
For PureDB databases.
.I -l extauth:path to pure-authd socket
For external authentication handlers.
.br
Different authentication methods can be mixed together. For instance if you
run the server with
.I -lpuredb:/etc/pwd.pdb -lmysql:/etc/my.cf -lunix
Accounts will first be authenticated from a PureDB database. If it fails, a
MySQL server will be asked. If the account is still not found is the
database, standard unix accounts will be scanned. Authentication methods are
tried in the order you give the -l options.
.br
See the
.I README.LDAP
and
.I README.MySQL
files for info about the built\-in LDAP and SQL directory support.
.TP
.B \-L max files:max depth
Avoid denial\-of\-service attacks by limiting the number of displayed files
in a 'ls' and the maximum depth of a recursive 'ls'. Defaults are 2000:5
(2000 files displayed for a single 'ls' and walk through 5 subdirectories
max).
.TP
.B \-m load
Do not allow anonymous users to download files if the load is above
.I load
when the user connects. Uploads and file listings are still allowed,
as are downloads by real users. The user is not told about this until
he/she tries to download a file.
.TP
.B \-M
Allow anonymous users to create directories.
.TP
.B \-n maxfiles:maxsize
Enable
.B virtual quotas
When virtual quotas are enabled, .ftpquota files are created, and the
number of files for an user is restricted to 'maxfiles'. The max total size
of his directory is also restricted to 'maxsize' Megabytes. Members of the
trusted group aren't subject to quotas.
.TP
.B \-N
NAT mode. Force
.B active
mode. If your FTP server is behind a NAT box
that doesn't support applicative FTP proxying, or if you use port
redirection without a transparent FTP proxy, use this. Well... the previous
sentence isn't very clear. Okay: if your network looks like this:
.br
FTP\-\-NAT.gateway/router\-\-Internet
.br
and if you want people coming from the internet to have access to your FTP
server, please try without this option first. If Netscape clients can
connect without any problem, your NAT gateway rulez. If Netscape doesn't
display directory listings, your NAT gateway sucks. Use
\fB\-N\fR
as a workaround.
.TP
.B \-o
Enable
.IR pure\-uploadscript .
.TP
.B \-O format:log file
Record all file transfers into a specific log
file, in an alternative format. Currently, three formats are supported : CLF,
Stats and W3C.
.br
If you add
.br
\fB\-O clf:/var/log/pureftpd.log\fR
.br
to your starting options,
Pure-FTPd will log transfers in
\fB/var/log/pureftpd.log\fR
in a format similar to
the Apache web server in default configuration.
.br
If you add
.br
\fB\-O stats:/var/log/pureftpd.log\fR
.br
to your starting options,
Pure-FTPd will create accurate log files designed for traffic analys
software like ftpStats.
.br
If you add
.br
\fB\-O w3c:/var/log/pureftpd.log\fR
.br
to your starting options,
Pure-FTPd will create W3C\-conformant log files.
.br
For security purposes, the path must be absolute
(eg.
\fB/var/log/pureftpd.log\fR, not \fB ../log/pureftpd.log\fR).
.TP
.B \-p first:last
Use only ports in the range \fIfirst\fR to \fIlast\fR
inclusive for passive\-mode downloads. This means that clients will
not try to open connections to TCP ports outside the range \fIfirst \- last\fR,
which makes pure\-ftpd more compatible with packet filters. Note that
the maximum number of clients (specified with \fB\-c\fR)
is forced down to \fI(last + 1 \- first)/2\fR
if it is greater, as the default is. (The syntax for the port range
is, conveniently, the same as that of
.BR iptables).
.TP
.B \-P ip address or host name
Force the specified IP address in reply to a
.B PASV/EPSV/SPSV
command. If the server is behind a masquerading (NAT) box that doesn't
properly handle stateful FTP masquerading, put the ip address of that box
here. If you have a dynamic IP address, you can use a symbolic host name
(probably the one of your gateway), that will be resolved every time a new
client will connect.
.TP
.B \-q upload:download
Enable an upload/download ratio for anonymous users (ex:
.I \-q 1:5
means that 1 Mb of goodies have to be uploaded to leech 5 Mb).
.TP
.B \-Q upload:download
Enable ratios for anonymous and non\-anonymous users. If the
.I \-a
option is also used, users from the trusted group have no ratio.
.TP
.B \-r
Never overwrite existing files. Uploading a file whoose name
already exists cause an automatic rename. Files are called xyz.1, xyz.2,
xyz.3, etc.
.TP
.B \-R
Disallow users (even non-anonymous ones) usage of the CHMOD
command. On hosting services, it may prevent newbies from doing mistakes,
like setting bad permissions on their home directory. Only root can use
CHMOD when this switch is enabled.
.TP
.B \-s
Don't allow anonymous users to retrieve files owned by "ftp"
(generally, files uploaded by other anonymous users).
.TP
.B \-S [{ip address|hostname}] [,{port|service name}]
This option is
only effective when the server is launched as a standalone server.
Connections are accepted on the specified IP and port. IPv4 and IPv6 are
supported. Numeric and fully\-qualified host names are accepted. A service
name (see /etc/services) can be used instead of a numeric port number.
.TP
.B \-t bandwidth
or
.B \-t upload bandwidth:download bandwidth
Enable process priority lowering and bandwidth throttling for anonymous
users. Delay should be in kilobytes/seconds.
.TP
.B \-T bandwidth
or
.B \-T upload bandwidth:download bandwidth
Enable process priority lowering and bandwidth throttling for *ALL*
users.
Pure\-FTPd should have been explicitely compiled with throttling support
to have these flags work.
It is possible to have different bandwidth limits for uploads and for
downloads. '\-t' and '\-T' can indeed be followed by two numbers delimited by
a column (':'). The first number is the upload bandwidth and the next one
applies only to downloads. One of them can be left blank which means infinity.
A single number without any column means that the same limit applies to upload
and download.
.TP
.B \-u uid
Do not allow uids below \fIuid\fR
to log in (typically, low\-numbered \fIuid\fRs
are used for administrative accounts).
.B "\-u 100"
is sufficient to deny access to all administrative accounts on many
linux boxes, where 99 is the last administrative account. Anonymous
FTP is allowed even if the uid of the ftp user is smaller than
.IR uid .
.B "\-u 1"
denies access only to root accounts. The default is to allow FTP
access to all accounts.
.TP
.B \-U umask files:umask dirs
Change the mask for creation of new files and directories. The default are 133 (files are
readable -but not writable- by other users) and 022 (same thing for directory, with the execute bit on).
If new files should only be readable by the user, use 177:077. If you want uploaded files to be executable,
use 022:022 (files will be readable by other people) or 077:077 (files will only be
readable by their owner).
.TP
.B \-V ip address
Allow non-anonymous FTP access only on this specific
local IP address. All other IP addresses are only anonymous. With that
option, you can have routed IPs for public access, and a local IP (like
10.x.x.x) for administration. You can also have a routable trusted IP
protected by firewall rules, and only that IP can be used to login as a
non-anonymous user.
.TP
.B \-w
Enable support for the FXP protocol, for non\-anonymous users only.
.TP
.B \-W
Enable the FXP protocol for everyone.
\fIFXP IS AN UNSECURE PROTOCOL. NEVER ENABLE IT ON UNTRUSTED NETWORKS.\fR