trAvis - MANAGER

Edit File: mod_vroot.html

<html>
<head>
<title>ProFTPD module mod_vroot</title>
</head>

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

This module is contained in the <code>mod_vroot.c</code> file for
ProFTPD 1.3.x, and is not compiled by default. Installation
instructions are discussed <a href="#Installation">here</a>.

The purpose of this module to is to implement a virtual chroot capability
that does not require root privileges. The <code>mod_vroot</code> module
provides this capability by using ProFTPD's FS API, available as of 1.2.8rc1.

The most current version of <code>mod_vroot</code> can be found at:
<pre>
 <a href="http://www.castaglia.org/proftpd/">http://www.castaglia.org/proftpd/</a>
</pre>

<h2>Author</h2>

Please contact TJ Saunders &lt;tj at castaglia.org&gt; with any
questions, concerns, or suggestions regarding this module.

<h2>Thanks</h2>

2003-08-26: Thanks to Oskar Liljeblad for the elegant patch that added
symlink support.

<h2>Directives</h2>
<ul>
 <li><a href="#VRootAlias">VRootAlias</a>
 <li><a href="#VRootEngine">VRootEngine</a>
 <li><a href="#VRootLog">VRootLog</a>
 <li><a href="#VRootOptions">VRootOptions</a>
 <li><a href="#VRootServerRoot">VRootServerRoot</a>
</ul>

<hr>
<h2><a name="VRootAlias">VRootAlias</a></h2>
Syntax: VRootAlias src-path dst-path 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_vroot 
Compatibility: 1.3.2 and later

The <code>VRootAlias</code> directive is used to create an "alias" of a
directory outside of the chroot area into the chroot. The dst-path
parameter is a relative path, relative to the chroot area (i.e.
the directory in which the session starts). The src-path parameter,
on the other hand, is an absolute path, and may be to a file or
directory.

For example, you might map a shared upload directory into a user's home
directory using:
<pre>
 &lt;IfModule mod_vroot.c&gt;
 VRootEngine on

DefaultRoot ~
 VRootAlias /var/ftp/upload ~/upload
 &lt;/IfModule&gt;
</pre>
This will automatically create an "upload" directory to appear in the
chroot area (in this case, the user's home directory).

Note that this directive will not work if the
<code>VRootServerRoot</code> is used.

<hr>
<h2><a name="VRootEngine">VRootEngine</a></h2>
Syntax: VRootEngine on|off 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_vroot 
Compatibility: 1.2.8rc1 and later

The <code>VRootEngine</code> directive enables the virtual chroot engine
implemented by <code>mod_vroot</code>. If enabled, the virtual chroot will
be used in place of the operating system's <code>chroot(2)</code>. This
directive affects any <code>DefaultRoot</code> directives and any
<code>&lt;Anonymous&gt;</code> contexts within the server context in which
the <code>VRootEngine</code> directive appears.

<hr>
<h2><a name="VRootLog">VRootLog</a></h2>
Syntax: VRootLog file 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_vroot 
Compatibility: 1.3.0rc1 and later

The <code>VRootLog</code> directive is used to specify a log file for
<code>mod_vroot</code>'s reporting on a per-server basis. The file
parameter given must be the full path to the file to use for logging.

<hr>
<h2><a name="VRootOptions">VRootOptions</a></h2>
Syntax: VRootOptions opt1 ... 
Default: None 
Context: &quot;server config&quot; <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_vroot 
Compatibility: 1.2.9rc2 and later

The <code>VRootOptions</code> directive is used to configure various optional
behavior of <code>mod_vroot</code>.

Example:
<pre>
 VRootOptions allowSymlinks
</pre>

The currently implemented options are:
<ul>
 <li><code>allowSymlinks</code> 
 
 Normally, any symlinks that point outside of the vroot area simply do
 not work. When the <code>allowSymlinks</code> option is enabled, these
 symlinks will be allowed. Note that by enabling symlinks, the efficacy
 of the vroot &quot;jail&quot; is reduced.
 </li>
</ul>

<hr>
<h2><a name="VRootServerRoot">VRootServerRoot</a></h2>
Syntax: VRootServerRoot path 
Default: None 
Context: &quot;server config&quot; <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_vroot 
Compatibility: 1.3.2rc1 and later

The <code>VRootServerRoot</code> directive is used to configure a directory
to which the <code>mod_vroot</code> module will perform a real chroot.
The idea is that each <code>&lt;VirtualHost&gt;</code> can have its own
directory to which a real <code>chroot(2)</code> system call is made;
the user-specific home directories will be virtual roots underneath this
directory. Thus some measure of security, via the <code>chroot(2)</code>
system call, is provided by the kernel, while still allowing symlinked shared
folders among users of this <code>&lt;VirtualHost&gt;</code>.

For example:
<pre>
 &lt;VirtualHost a.b.c.d&gt;
 VRootEngine on
 VRootServerRoot /etc/ftpd/a.b.c.d/
 VRootOptions allowSymlinks
 DefaultRoot ~
 ...

&lt;/VirtualHost&gt;
</pre>

See also: <a href="#VRootOptions"><code>VRootOptions</code></a>

<hr>
<h2><a name="Installation">Installation</a></h2>
After unpacking and patching the latest proftpd-1.3.x source code, copy
the <code>mod_vroot.c</code> file into:
<pre>
 proftpd-dir/contrib/
</pre>
Then follow the normal steps for using third-party modules in proftpd:
<pre>
 ./configure --with-modules=mod_vroot
 make
 make install
</pre>

<hr>
Author: $Author: tj $ 
Last Updated: $Date: 2009/10/19 16:30:18 $ 
<hr>