trAvis - MANAGER
Edit File: mod_rlimit.html
<!-- $Id: mod_rlimit.html,v 1.4 2014-01-31 17:08:10 castaglia Exp $ --> <!-- $Source: /home/proftpd-core/backup/proftp-cvsroot/proftpd/doc/modules/mod_rlimit.html,v $ --> <html> <head> <title>ProFTPD module mod_rlimit</title> </head> <body bgcolor=white> <hr> <center> <h2><b>ProFTPD module <code>mod_rlimit</code></b></h2> </center> <hr><br> <p> The <code>mod_rlimit</code> module handles setting and enforcement of resource limits such as CPU, memory, and file descriptor usage. <p> 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>. <p> This module is contained in the <code>mod_rlimit.c</code> file for ProFTPD 1.3.<i>x</i>, and is compiled by default. See the <a href="#Installation">installation</a> section for more details. <p> 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> <p> <hr> <h2><a name="RLimitChroot">RLimitChroot</a></h2> <strong>Syntax:</strong> RLimitChroot <em>on|off</em><br> <strong>Default:</strong> <em>on</em><br> <strong>Context:</strong> "server config", <code><VirtualHost></code>, <code><Global></code><br> <strong>Module:</strong> mod_rlimit<br> <strong>Compatibility:</strong> 1.3.5rc5 <p> 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> <p> When a session is chrooted, <i>e.g.</i> via the <code>DefaultRoot</code> directive <i>or</i> by <code><Anonymous></code> login, the checks for the "sensitive" directories are automatically enabled. To disable these checks, use: <pre> RLimitChroot off </pre> <b>Note</b>: We <b>strongly recommend</b> that you do <b>not</b> disable these checks. <p> 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 '<i>/etc/file</i>' within chroot '<i>/home/user</i>', rejecting </pre> <p> <hr> <h2><a name="RLimitCPU">RLimitCPU</a></h2> <strong>Syntax:</strong> RLimitCPU <em>[scope] soft-limit|"max" [hard-limit|"max"]</em><br> <strong>Default:</strong> System defaults<br> <strong>Context:</strong> "server config", <code><VirtualHost></code>, <code><Global></code><br> <strong>Module:</strong> mod_rlimit<br> <strong>Compatibility:</strong> 1.3.5rc2 <p> The <code>RLimitCPU</code> directive is used to set a limit on the CPU usage, expressed as a maximum number of seconds. <p> <code>RLimitCPU</code> takes from one to three parameters. The first parameter is an optional <em>scope</em> parameter, indicating the scope of the resource limit. The <em>scope</em> parameter may be one of: <ul> <li>"daemon" (applies the resource limit only to the <i>daemon</i> process) <li>"session" (which applies the limit only to <i>session</i> 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. <p> 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. <p> 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> <p> <hr> <h2><a name="RLimitMemory">RLimitMemory</a></h2> <strong>Syntax:</strong> RLimitMemory <em>[scope] soft-limit|"max" [hard-limit|"max"]</em><br> <strong>Default:</strong> System defaults<br> <strong>Context:</strong> "server config", <code><VirtualHost></code>, <code><Global></code><br> <strong>Module:</strong> mod_rlimit<br> <strong>Compatibility:</strong> 1.3.5rc2 <p> The <code>RLimitMemory</code> directive is used to set a limit on the memory usage, expressed as a maximum number of bytes. <p> <code>RLimitMemory</code> takes from one to three parameters. The first parameter is an optional <em>scope</em> parameter, indicating the scope of the resource limit. The <em>scope</em> parameter may be one of: <ul> <li>"daemon" (applies the resource limit only to the <i>daemon</i> process) <li>"session" (which applies the limit only to <i>session</i> 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. <p> 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. <p> Example: <pre> # Limit a given session to 128MB minutes of memory RLimitMemory 128MB </pre> <p> <hr> <h2><a name="RLimitOpenFiles">RLimitOpenFiles</a></h2> <strong>Syntax:</strong> RLimitOpenFiles <em>[scope] soft-limit|"max" [hard-limit|"max"]</em><br> <strong>Default:</strong> System defaults<br> <strong>Context:</strong> "server config", <code><VirtualHost></code>, <code><Global></code><br> <strong>Module:</strong> mod_rlimit<br> <strong>Compatibility:</strong> 1.3.5rc2 <p> The <code>RLimitOpenFiles</code> directive is used to set a limit on the file descriptors, expressed as counts. <p> <code>RLimitOpenFiles</code> takes from one to three parameters. The first parameter is an optional <em>scope</em> parameter, indicating the scope of the resource limit. The <em>scope</em> parameter may be one of: <ul> <li>"daemon" (applies the resource limit only to the <i>daemon</i> process) <li>"session" (which applies the limit only to <i>session</i> 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. <p> 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. <p> Example: <pre> # Limit a given session to 12 open file descriptors RLimitMemory session 12 </pre> <p> <hr> <h2><a name="Installation">Installation</a></h2> The <code>mod_rlimit</code> module is compiled into <code>proftpd</code> by default. <p> <hr><br> Author: <i>$Author: castaglia $</i><br> Last Updated: <i>$Date: 2014-01-31 17:08:10 $</i><br> <br><hr> <font size=2><b><i> © Copyright 2013-2014 TJ Saunders<br> All Rights Reserved<br> </i></b></font> <hr><br> </body> </html>