One Hat Cyber Team

Edit File: mod_ls.html

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

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

The <code>mod_ls</code> module handles the <code>LIST</code>,
<code>NLST</code>, and <code>STAT</code> FTP commands.

<h2>Directives</h2>
<ul>
 <li><a href="#DirFakeGroup">DirFakeGroup</a>
 <li><a href="#DirFakeMode">DirFakeMode</a>
 <li><a href="#DirFakeUser">DirFakeUser</a>
 <li><a href="#ListOptions">ListOptions</a>
 <li><a href="#ListStyle">ListStyle</a>
 <li><a href="#ShowSymlinks">ShowSymlinks</a>
 <li><a href="#UseGlobbing">UseGlobbing</a>
</ul>

<hr>
<h3><a name="DirFakeGroup">DirFakeGroup</a></h3>
Syntax: DirFakeGroup off|on [display-name] 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code>, <code>&lt;Directory&gt;</code>, .ftpaccess 
Module: mod_ls 
Compatibility: All versions

The <code>DirFakeGroup</code> directive can be used to hide the true group
ownership of files (including directories, FIFOs, etc) in directory
listings. If simply turned on, <code>DirFakeGroup</code> will display
all files as being owned by group "ftp". Optionally, the display-name
parameter can be used to specify a group other than "ftp". A
display-name of "~" can be used as the parameter, in order to display
the primary group name of the current user.

Both <code>DirFakeGroup</code> and
<a href="#DirFakeUser"><code>DirFakeUser</code></a> are completely
cosmetic; the display-names configured do not need to exist
on the system, and neither directive affects permissions, real ownership or
access control in any way.

<hr>
<h3><a name="DirFakeMode">DirFakeMode</a></h3>
Syntax: DirFakeMode display-mode 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code>, <code>&lt;Directory&gt;</code>, .ftpaccess 
Module: mod_ls 
Compatibility: All versions

The <code>DirFakeMode</code> directive configures the mode (or
permissions) which will be displayed for all files and directories in
directory listings. For each subset of permissions (i.e. user, group,
other), the "execute" permission for directories is added in listings if the
"read" permission is specified by this directive.

As with <a href="#DirFakeUser"><code>DirFakeUser</code></a>, and
<a href="#DirFakeGroup"><code>DirFakeGroup</code></a>, the "fake" permissions
shown in directory listings are cosmetic only; they do not affect real
permissions or access control in any way on the server. Note,
however, that <code>DirFakeMode</code> can affect the real permissions,
for example, for FTP mirroring tools. Such tools tend to create a mirror from
what the tool sees (e.g. <code>DirFakeMode</code> permissions) on the
source FTP server.

Examples:
<pre>
 # Display everything as read-only
 DirFakeMode 0444
</pre>

<hr>
<h3><a name="DirFakeUser">DirFakeUser</a></h3>
Syntax: DirFakeUser off|on [display-name] 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code>, <code>&lt;Directory&gt;</code>, .ftpaccess 
Module: mod_ls 
Compatibility: All versions

The <code>DirFakeUser</code> directive can be used to hide the true user
ownership of files (including directories, FIFOs, etc) in directory
listings. If simply turned on, <code>DirFakeUser</code> will display
all files as being owned by user "ftp". Optionally, the display-name
parameter can be used to specify a user other than "ftp". A
display-name parameter of "~" can be used in order to display the name
of the current user.

Both <a href="#DirFakeGroup"><code>DirFakeGroup</code></a> and
<code>DirFakeUser</code> are completely cosmetic; the
display-names specified do not need to exist on the system,
and neither directive affects permissions, real ownership or access control
in any way.

<hr>
<h3><a name="ListOptions">ListOptions</a></h3>
Syntax: ListOptions options [strict [maxdepth depth] [maxfiles count] [maxdirs count] [LISTOnly] [NLSTOnly] [NoErrorIfAbsent] [AdjustedSymlinks] [SortedNLST] 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code>, <code>&lt;Directory&gt;</code>, .ftpaccess 
Module: mod_ls 
Compatibility: 1.2.8rc1 and later

The <code>ListOptions</code> directive is used to configure various optional
behavior of <code>mod_ls</code>. Note: all of the configured
<code>ListOptions</code> parameters must appear on the same line in the
configuration; only the first <code>ListOptions</code> directive that
appears in the configuration is used.

The currently supported flags are:
<ul>
 <li><code>LISTOnly</code> 
 
 This flag tells <code>mod_ls</code> to apply the
 <code>ListOptions</code> configuration only to FTP <code>LIST</code>
 commands, and not to e.g. <code>NLST</code>/<code>STAT</code>
 commands.
 </li>

<li><code>NLSTOnly</code> 
 
 This flag tells <code>mod_ls</code> to apply the
 <code>ListOptions</code> configuration only to FTP <code>NLST</code>
 commands, and not to e.g. <code>LIST</code>/<code>STAT</code>
 commands.
 </li>

<li><code>NoErrorIfAbsent</code> 
 
 This flag tells <code>mod_ls</code> to return the FTP 226
 response code for <code>LIST</code>/<code>NLST</code> commands for
 files/paths which do not exist, rather than returning the 450 error
 code.
 </li>

<li><code>AdjustedSymlinks</code> 
 
 This flag tells <code>mod_ls</code> to try to automatically
 adjust any symlink destination paths when the FTP session is chrooted,
 so that the adjusted symlinks work properly e.g. for FTP clients.

Note that this flag first appeared in
 <code>proftpd-1.3.7rc1</code>.
 </li>

<li><code>SortedNLST</code> 
 
 By default, <code>mod_ls</code> returns <code>NLST</code> results
 in an unordered list, i.e. the sort order used by the
 underlying filesystem and the <code>readdir(3)</code> library function.
 Some FTP clients, however, may want/expect to have <code>NLST</code>
 results sorted alphabetically. Use this flag to achieve that sorted
 <code>NLST</code> behavior.

Note that this flag first appeared in
 <code>proftpd-1.3.6rc3</code>.
 </li>
</ul>

See also: <a href="../howto/ListOptions.html">ListOptions</a>

<hr>
<h3><a name="ListStyle">ListStyle</a></h3>
Syntax: ListStyle Unix|Windows 
Default: <code>ListStyle Unix</code> 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_ls 
Compatibility: 1.3.8rc1 and later

The <code>ListStyle</code> directive can be used to emit Windows-style directory
listings for the <code>LIST</code> command, rather than default Unix-style
directory listings. This is mainly to support certain FTP clients which only
expect/support the Windows-style listings.

For example, using:
<pre>
 ListStyle Windows
</pre>
leads to a directory listing like this, for the basic command-line
<code>ftp(1)</code> Unix client:
<pre>
 ftp&gt; ls
 229 Entering Extended Passive Mode (|||57644|)
 150 Opening ASCII mode data connection for file list
 11-30-15 07:29PM &lt;DIR&gt; a_folder
 11-30-15 07:29PM 16 file
 226 Transfer complete
</pre>

<hr>
<h3><a name="ShowSymlinks">ShowSymlinks</a></h3>
Syntax: ShowSymlinks on|off 
Default: <code>ShowSymlinks on</code> 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_ls 
Compatibility: All versions

The <code>ShowSymlinks</code> directive configures whether symbolic links are
displayed as such in directory listings, or whether they are not displayed
to the client. If <code>ShowSymlinks</code> is off, then the linked
file's permissions and ownership are used in the directory listing.

<hr>
<h3><a name="UseGlobbing">UseGlobbing</a></h3>
Syntax: UseGlobbing on|off 
Default: <code>UseGlobbing on</code> 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_ls 
Compatibility: 1.2.5rc1 and later

The <code>UseGlobbing</code> directive controls the use of <code>glob(3)</code>
functionality, which is needed for supporting wildcard characters such as "*"
in directory listing requests from FTP clients.

The <code>glob(3)</code> functionality in FTP servers has been knowwn to
cause security issues (see <a href="http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2001-0249">CVE-2001-0249</a>), thus should be disabled when not needed.

Examples:
<pre>
 # Turn off support for globs in LIST/NLST commands
 UseGlobbing off
</pre>

<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_ls</code>module is always installed.

<a name="FAQ">
Frequently Asked Questions

<a name="NLSTNamesOnly">
Question: I have a legacy FTP application which sends
the <code>NLST</code> command, and expects to receive only file
names, without any directory prefix (relative or absolute). I cannot
change this application. How can I configure ProFTPD to return only names
for the <code>NLST</code> command? 
Answer: You can use the
<a href="#ListOptions"><code>ListOptions</code></a> directive to achieve
this, like so:
<pre>
 # We want only names, no hidden files, and only for NLST
 ListOptions '-A -1 NLSTOnly'
</pre>

<hr>