Gecko [ thearyasamaj.org ]

Name	Size	Permission
index.html	4.66 KB	-rw-r--r--
mod_auth.html	39.51 KB	-rw-r--r--
mod_auth_file.html	9.21 KB	-rw-r--r--
mod_auth_pam.html	5.79 KB	-rw-r--r--
mod_auth_unix.html	10.76 KB	-rw-r--r--
mod_cap.html	8.1 KB	-rw-r--r--
mod_core.html	126.18 KB	-rw-r--r--
mod_ctrls.html	11.58 KB	-rw-r--r--
mod_delay.html	11.43 KB	-rw-r--r--
mod_dso.html	16.33 KB	-rw-r--r--
mod_facl.html	2.22 KB	-rw-r--r--
mod_facts.html	10.83 KB	-rw-r--r--
mod_ident.html	2.78 KB	-rw-r--r--
mod_lang.html	11.19 KB	-rw-r--r--
mod_log.html	20.14 KB	-rw-r--r--
mod_ls.html	8.95 KB	-rw-r--r--
mod_memcache.html	5.05 KB	-rw-r--r--
mod_redis.html	13.45 KB	-rw-r--r--
mod_rlimit.html	9.55 KB	-rw-r--r--
mod_site.html	905 B	-rw-r--r--
mod_xfer.html	24.84 KB	-rw-r--r--

Code Editor : mod_rlimit.html

<!DOCTYPE html>
<html>
<head>
<title>ProFTPD module mod_rlimit</title>
</head>

<hr>
<center>
<h2>ProFTPD module <code>mod_rlimit</code></h2>
</center>
<hr>

The <code>mod_rlimit</code> module handles setting and enforcement of
resource limits such as CPU, memory, and file descriptor usage.

By default, the <code>mod_rlimit</code> module will impose one resource
restriction on new session processes: the <code>RLIMIT_NPROC</code> (see
<code>getrlimit(2)</code> limit, which controls the number of processes
which can be forked from this process, is set to zero. There is absolutely
no reason for a <code>proftpd</code> session process to need to create a new
process via <code>fork(2)</code>.

This module is contained in the <code>mod_rlimit.c</code> file for
ProFTPD 1.3.x, and is compiled by default. See the
<a href="#Installation">installation</a> section for more details.

The most current version of <code>mod_rlimit</code> can be found in the
ProFTPD source distribution:
<pre>
 <a href="http://www.proftpd.org/">http://www.proftpd.org/</a>
</pre>

<h2>Directives</h2>
<ul>
 <li><a href="#RLimitChroot">RLimitChroot</a>
 <li><a href="#RLimitCPU">RLimitCPU</a>
 <li><a href="#RLimitMemory">RLimitMemory</a>
 <li><a href="#RLimitOpenFiles">RLimitOpenFiles</a>
</ul>

<hr>
<h3><a name="RLimitChroot">RLimitChroot</a></h3>
Syntax: RLimitChroot on|off 
Default: RLimitChroot on 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_rlimit 
Compatibility: 1.3.5rc5

The <code>RLimitChroot</code> directive is used to enable/disable checks
for modifications to "sensitive" directories when a session is chrooted. These
checks are designed to mitigate and guard against attacks such as the
"Roaring Beast" attack; see:
<ul>
 <li><a href="https://auscert.org.au/15286">https://auscert.org.au/15286</a>
 <li><a href="https://auscert.org.au/15526">https://auscert.org.au/15526</a>
</ul>

When a session is chrooted, e.g. via the <code>DefaultRoot</code>
directive or by <code>&lt;Anonymous&gt;</code> login, the checks
for the "sensitive" directories are automatically enabled. To disable these
checks, use:
<pre>
 RLimitChroot off
</pre>
Note: We strongly recommend that you do not disable
these checks.

The checks in question will specifically prevent any attempts to upload
files into the <code>/etc</code> and <code>/lib</code> directories, or
attempts to delete, create, rename, link, or otherwise try to change anything
in these directories. All attempts to make modifications will be rejected
with "Permission denied" errors. In addition, the following message will
be logged (at debug level 2):
<pre>
 WARNING: attempt to use sensitive path '/etc/file' within chroot '/home/user', rejecting
</pre>

The <code>RLimitChroot</code> directive is not intended to prevent
"Roaring Beast" style attacks entirely; the guarded <code>/etc</code> and
<code>/lib</code> directories might be created via other means, outside of
ProFTPD, which would also allow for the attack. The <code>RLimitChroot</code>
directive is meant to mitigate (not prevent) the attacks by
making sure it cannot be done using just ProFTPD.

<hr>
<h3><a name="RLimitCPU">RLimitCPU</a></h3>
Syntax: RLimitCPU [scope] soft-limit|"max" [hard-limit|"max"] 
Default: System defaults 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_rlimit 
Compatibility: 1.3.5rc2

The <code>RLimitCPU</code> directive is used to set a limit on the CPU usage,
expressed as a maximum number of seconds.

<code>RLimitCPU</code> takes from one to three parameters. The first parameter
is an optional scope parameter, indicating the scope of the resource
limit. The scope parameter may be one of:
<ul>
 <li>"daemon" (applies the resource limit only to the daemon process)
 <li>"session" (which applies the limit only to session processes handling each client)
 <li>"none" (which disables any possibly inherited limits)
</ul>
If none of these keywords are used, the resource limit is assumed to apply to
both daemon and session processes.

The next parameters indicate the actual resource limits, both the so-called
"soft limit" and any "hard limit". These parameters may be a number
(indicating the number of seconds), or the value "max" to indicate that
maximum resource limit value allowed is to be used.

Example:
<pre>
 # Limit a given session to 30 minutes of CPU time (which can take
 # considerably longer than 30 minutes of wall time, due to CPU scheduling)
 RLimitCPU 1800
</pre>

<hr>
<h3><a name="RLimitMemory">RLimitMemory</a></h3>
Syntax: RLimitMemory [scope] soft-limit|"max" [hard-limit|"max"] 
Default: System defaults 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_rlimit 
Compatibility: 1.3.5rc2

The <code>RLimitMemory</code> directive is used to set a limit on the
memory usage, expressed as a maximum number of bytes.

<code>RLimitMemory</code> takes from one to three parameters. The first
parameter is an optional scope parameter, indicating the scope of the
resource limit. The scope parameter may be one of:
<ul>
 <li>"daemon" (applies the resource limit only to the daemon process)
 <li>"session" (which applies the limit only to session processes handling each client)
 <li>"none" (which disables any possibly inherited limits)
</ul>
If none of these keywords are used, the resource limit is assumed to apply to
both daemon and session processes.

The next parameters indicate the actual resource limits, both the so-called
"soft limit" and any "hard limit". These parameters may be a number
(indicating the number of bytes), or the value "max" to indicate that
maximum resource limit value allowed is to be used.

Example:
<pre>
 # Limit a given session to 128MB minutes of memory
 RLimitMemory 128MB
</pre>

Note: If you use <code>RLimitMemory</code>, e.g.:
<pre>
 &lt;IfModule mod_rlimit.c&gt;
 RLimitMemory session 64M
 &lt;/IfModule&gt;
</pre>
and you use <a href="../contrib/mod_tls.html"><code>mod_tls</code></a>
for FTPS transfers:
<pre>
 &lt;IfModule mod_tls.c&gt;
 ...
 &lt;/IfModule&gt;
</pre>
then your transfers are likely to fail. Why? Because OpenSSL will need to
allocate memory for the TLS support, in addition to the memory that ProFTPD
already allocates for data transfers. Depending on the specific ciphersuites
negotiated, and the specific memory limit configured, you are very likely to
hit the <code>RLimitMemory</code> limit. In short, your
<code>RLimitMemory</code> might be too low, and not allowing ProFTPD and
OpenSSL enough memory for the transfer.

<hr>
<h3><a name="RLimitOpenFiles">RLimitOpenFiles</a></h3>
Syntax: RLimitOpenFiles [scope] soft-limit|"max" [hard-limit|"max"] 
Default: System defaults 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_rlimit 
Compatibility: 1.3.5rc2

The <code>RLimitOpenFiles</code> directive is used to set a limit on the
file descriptors, expressed as counts.

<code>RLimitOpenFiles</code> takes from one to three parameters. The first
parameter is an optional scope parameter, indicating the scope of the
resource limit. The scope parameter may be one of:
<ul>
 <li>"daemon" (applies the resource limit only to the daemon process)
 <li>"session" (which applies the limit only to session processes handling each client)
 <li>"none" (which disables any possibly inherited limits)
</ul>
If none of these keywords are used, the resource limit is assumed to apply to
both daemon and session processes.

The next parameters indicate the actual resource limits, both the so-called
"soft limit" and any "hard limit". These parameters may be a number, or the
value "max" to indicate that maximum resource limit value allowed is to be
used.

Example:
<pre>
 # Limit a given session to 12 open file descriptors
 RLimitOpenFiles session 12
</pre>

<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_rlimit</code> module is compiled into <code>proftpd</code> by
default.

<a name="FAQ">FAQ</a>
Frequently Asked Questions

Question: Why can't I create directories named "lib"
or "etc" in the root directory? For example, my FTP client fails like so:
<code>
 Command:	MKD lib
 Response:	550 lib: Permission denied
 Command:	MKD /lib
 Response:	550 /lib: Permission denied
</code>
Although I don't have anything in my <code>proftpd.conf</code> that would block
these commands, and the filesystem permissions are OK. Why does this
happen? 
Answer: For the answer to this, see the description for
the <a href="#RLimitChroot"><code>RLimitChroot</code></a> directive.

</body>
</html>

${this.title}

Code Editor : mod_rlimit.html