1
2                        ProFTPD 1.3 README.modules
3                        ==========================
4
5
6Core ProFTPD Modules (modules subdirectory)
7-------------------------------------------
8
9Modules always included:
10
11    mod_auth
12        Implements FTP authentication commands (USER, PASS, ACCT, REIN).
13
14    mod_core
15        Implements core configuration directives and most RFC-959 FTP
16        commands (CWD, CDUP, MKD, PWD, RMD, DELE, RNTO, RNFR, PASV, PORT,
17        SYST, HELP, QUIT, NOOP), and the MDTM and SIZE extensions.
18
19    mod_delay
20        Implements algorithms to protect against information leaks
21        via timing attacks.
22
23    mod_log
24        Interface to Unix message logging (syslog or file).
25
26    mod_ls
27        Implements the FTP LIST, NLST and STAT commands.
28
29    mod_facts
30        Implements the FTP MFF, MFMT, MLSD, and MLST commands.
31
32    mod_site
33        Implements the FTP SITE command, and the HELP, CHGRP, CHMOD
34        subcommands.
35
36    mod_auth_file
37        Interface to file-based authentication (AuthUserFile, AuthGroupFile)
38
39    mod_auth_unix
40        Interface to the native Unix password system.
41
42    mod_xfer
43        Implements FTP file transfer commands (STOR, RETR, APPE, REST,
44        ABOR, TYPE, STRU, MODE, ALLO, SMNT, STOU).
45
46    mod_ident
47        Implements RFC1413 identity lookups (IdentLookups).
48
49Modules automatically included when supported by the OS:
50
51    mod_auth_pam
52        PAM (Pluggable Authentication Modules) authentication.
53        See README.PAM.
54        Originally contributed by MacGyver <macgyver@tos.net>.
55
56    mod_cap, libcap
57        POSIX 1e (IEEE 1003.1e draft) security model enhancements
58        (capabilities and capability sets), available for Linux kernels
59        2.1.104 and later. See README.capabilities.
60
61
62Modules included upon request:
63
64    mod_ctrls
65        Provides the server-side listener for control requests
66        (see README.controls)
67
68    mod_dso
69        Handles loading and unloading of DSO modules (see README.DSO)
70
71    mod_facl
72        Handles checking of POSIX ACLs (see README.facl)
73
74    mod_lang
75        Handles the LANG command (see README.NLS)
76
77    mod_memcache
78        Handles Memcache support
79
80Contributed ProFTPD Modules (contrib/ subdirectory)
81--------------------------------------------------
82
83Also, see contrib/README.
84
85Security/encryption modules:
86
87    mod_sftp, mod_sftp_pam, mod_sftp_sql
88        SSH2, SFTP, SCP protocol implementation
89        See doc/contrib/mod_sftp.html
90        Contributed by TJ Saunders <tj@castaglia.org>
91
92    mod_tls, mod_tls_memcache, mod_tls_shmcache
93        SSL/TLS authentication/encryption
94        See doc/contrib/mod_tls.html
95        Originally by Peter Runestig
96        Contributed by TJ Saunders <tj@castaglia.org>
97
98Authentication modules:
99
100    mod_ldap
101        LDAP (Light-weight Directory Access Protocol) authentication.
102        See README.LDAP.
103        Contributed by John Morrissey <jwm@horde.net>.
104
105    mod_sql, mod_sql_mysql, mod_sql_postgres, mod_sql_odbc, mod_sql_sqlite
106        SQL (Structured Query Language) database authentication and
107        other functions, with backends for MySQL, PostgreSQL, ODBC, and SQLite.
108        See doc/contrib/mod_sql.html
109        Contributed by Johnie Ingram <johnie@netgod.net>.
110
111    mod_radius
112       RADIUS (RFC2865) authentication and accounting
113       See doc/contrib/mod_radius.html
114       Contributed by TJ Saunders <tj@castaglia.org>.
115
116Feature modules:
117
118    mod_ban
119        Dynamic blacklisting.
120        See doc/contrib/mod_ban.html
121        Contributed by TJ Saunders <tj@castaglia.org>.
122
123    mod_ctrls_admin
124        Common administrative control actions
125        See doc/contrib/mod_ctrls_admin.html
126        Contributed by TJ Saunders <tj@castaglia.org>
127
128    mod_dynmasq
129        Automatic refreshing of IP address for MasqueradeAddress DNS name,
130        for sites that use DynDNS-type services
131        See doc/contrib/mod_dynmasq.html
132        Contributed by TJ Saunders <tj@castaglia.org>
133
134    mod_exec
135        Execute custom external scripts based on session actions/events.
136        See doc/contrib/mod_exec.html
137        Contributed by TJ Saunders <tj@castaglia.org>
138
139    mod_geoip
140        Look up geographic information based on the client IP address.
141        See doc/contrib/mod_geoip.html
142        Contributed by TJ Saunders <tj@castaglia.org>
143
144    mod_ifsession
145        Conditional per-user, per-group, per-class configurations
146        See doc/contrib/mod_ifsession.html
147        Contributed by TJ Saunders <tj@castaglia.org>
148
149    mod_load
150        Reject connections based on system load
151        See doc/contrib/mod_load.html
152        Contributed by TJ Saunders <tj@castaglia.org>
153
154    mod_log_forensic
155        Only write log information when criteria are met.
156        See doc/contrib/mod_log_forensic.html
157        Contributed by TJ Saunders <tj@castaglia.org>
158
159    mod_qos
160        Tweak the network TCP QoS bits for better routing
161        See doc/contrib/mod_qos.html
162        Contributed by Philip Prindeville
163
164    mod_quotatab, mod_quotatab_file, mod_quotatab_ldap, mod_quotatab_radius,
165      mod_quotatab_sql
166        User/group/class quotas.
167        See doc/contrib/mod_quotatab.html
168        Contributed by TJ Saunders <tj@castaglia.org>
169
170    mod_ratio
171        User upload/download ratios.
172        See contrib/README.ratio and the comments in mod_ratio.c.
173        Contributed by Johnie Ingram <johnie@netgod.net>
174        and Jim Dogopoulos <jd@dynw.com>/<jd@downcity.net>.
175
176    mod_readme
177        Display "readme" files, controlled by the "DisplayReadme" directive.
178        Originally contributed by <jan.menzel@gmx.de>.
179
180    mod_rewrite
181        Powerful regular expression-based command parameter rewrite engine
182        See doc/contrib/mod_rewrite.html
183        Contributed by TJ Saunders <tj@castaglia.org>
184
185    mod_shaper
186        Throttling of data transfers across the entire server.
187        See doc/contrib/mod_shaper.html
188
189    mod_site_misc
190        Miscellaneous SITE commands (e.g. SITE SYLINK, SITE UTIME)
191        See doc/contrib/mod_site_misc.html
192
193    mod_unique_id
194        Provides a unique ID for each FTP session, useful for session
195        tracking in log files and databases
196        See doc/contrib/mod_unique_id.html
197        Contributed by TJ Saunders <tj@castaglia.org>
198
199    mod_wrap
200        TCP Wrappers.
201        See contrib/README.mod_wrap and doc/contrib/mod_wrap.html.
202        Contributed by TJ Saunders <tj@castaglia.org>.
203
204    mod_wrap2, mod_wrap2_file, mod_wrap2_sql
205        TCP wrappers functionality, extended to include SQL tables
206        See doc/contrib/mod_wrap2.html
207        Contributed by TJ Saunders <tj@castaglia.org>.
208
209
210Other ProFTPD modules (not included in the source distribution)
211---------------------------------------------------------------
212
213Please see
214
215    http://www.proftpd.org/module_news.html
216
217for a current third-party module list. These modules (and patches) are
218neither evaluated nor sanctioned in any way.
219