Enhanced PHP File Manager

⬆️ Go Up (..)

📊 Server Information

Server:

nginx/1.28.0

System:

Linux 6.8.0-90-generic

PHP Version:

8.4.15

User:

alqudsvolunteers

Directory:

/home/alqudsvolunteers/rootlink/usr/share/doc/proftpd-doc/contrib

Free Space:

81.7 GB

🔧 Quick Actions

✏️ Editing: mod_wrap2.html

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

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

The <code>mod_wrap2</code> package allows the <code>proftpd</code> daemon to
provide <code>tcpwrapper</code>-like access control rules while running
in standalone mode. It also allows for those access rules to be stored
in various formats, such as files (e.g. <code>/etc/hosts.allow</code>
and <code>/etc/hosts.deny</code>) or in SQL tables. Note that the
<code>mod_wrap2</code> module does not require or use the
standard tcpwrappers <code>libwrap</code> library, and instead implements
the same functionality internally (in order to support SQL-based access rules).
Please read the <a href="#Usage">usage</a> documentation for more details.

This module is contained in <code>mod_wrap2.c</code>,
<code>mod_wrap2.h</code>, and in the submodules source files, for
ProFTPD 1.3.x. These modules are not enabled by default. Installation
<a href="#Installation">notes</a> follow the directive documentation.

The most current version of <code>mod_wrap2</code>'s submodules supports
storage of access table information in various formats:
<a name="submodules"></a>
<ul>
 <li><a href="mod_wrap2_file.html"><code>mod_wrap2_file</code></a> for file-based access tables 
 <li><a href="mod_wrap2_redis.html"><code>mod_wrap2_redis</code></a> for Redis-based access lists/sets 
 <li><a href="mod_wrap2_sql.html"><code>mod_wrap2_sql</code></a> for SQL-based access tables 
</ul>

The most current version of <code>mod_wrap2</code> is distributed with the
ProFTPD source code.

<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>

Many, many thanks to Wietse Venema for writing the <code>tcpwrappers</code>
package and its <code>libwrap</code> library, from which this module drew
much of its code.

2002-12-12: Thanks to Steve Grubb for pointing out a few cases where
interrupted functions were not being properly handled, and for reviewing
the module code.

<h2>Directives</h2>
<ul>
 <li><a href="#WrapAllowMsg">WrapAllowMsg</a>
 <li><a href="#WrapDenyMsg">WrapDenyMsg</a>
 <li><a href="#WrapEngine">WrapEngine</a>
 <li><a href="#WrapGroupTables">WrapGroupTables</a>
 <li><a href="#WrapLog">WrapLog</a>
 <li><a href="#WrapOptions">WrapOptions</a>
 <li><a href="#WrapServiceName">WrapServiceName</a>
 <li><a href="#WrapTables">WrapTables</a>
 <li><a href="#WrapUserTables">WrapUserTables</a>
</ul>

<hr>
<h3><a name="WrapAllowMsg">WrapAllowMsg</a></h3>
Syntax: WrapAllowMsg mesg 
Default: None 
Context: server config, <code>&lt;VirtualHost</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

The <code>WrapAllowMsg</code> directive configures a message that will be
added to <code>proftpd</code>'s response to the connecting client when that
client is allowed by <code>mod_wrap2</code>'s access check. In the
mesg parameter, the magic cookie '%u' is replaced with the username
specified by the client during login.

Example:
<pre>
 WrapAllowMsg "User '%u' allowed by access rules"
</pre>

<hr>
<h3><a name="WrapDenyMsg">WrapDenyMsg</a></h3>
Syntax: WrapDenyMsg mesg 
Default: None 
Context: server config, <code>&lt;VirtualHost</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

The <code>WrapDenyMsg</code> directive configures a message that will be
sent to the connecting client when that client is denied by
<code>mod_wrap2</code>'s access check, and disconnected. In the mesg
parameter, the magic cookie '%u' is replaced with the username specified by
the client during login.

Example:
<pre>
 WrapDenyMsg "User '%u' denied by access rules"
</pre>

<hr>
<h3><a name="WrapEngine">WrapEngine</a></h3>
Syntax: WrapEngine on|off 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

The <code>WrapEngine</code> directive enables or disables the module's runtime
access control engine. If it is set to off this module does no runtime
processing at all. Use this directive to disable the module instead of
commenting out all <code>mod_wrap2</code> directives.

<hr>
<h3><a name="WrapGroupTables">WrapGroupTables</a></h3>
Syntax: WrapGroupTables group-AND-expression source-type:allow-source-info source-type:deny-source-info [source-type:options-source-info] 
Default: None 
Context: server config, <code>&lt;VirtualHost</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

The <code>WrapGroupTables</code> directive configures the information necessary
for <code>mod_wrap2</code> to locate and use the tables containing the access
rules for specific groups.

The group-AND-expression parameter is a logical AND expression, which
means that the connecting user must be a member of all the groups
listed for this directive to apply. Group names may be negated with a
<code>!</code> prefix.

The next two parameters specify two tables, an allow and a deny table, each of
which contain the IP addresses, networks or host/network masks to be allowed or
denied.

Please consult the relevant <a href="#submodule">submodule</a> documentation
for details on that module's syntax for specifying tables. The service name
for which <code>mod_wrap2</code> will look in the indicated access tables is
&quot;proftpd&quot; by default; this can be configured via the
<a href="#WrapServiceName"><code>WrapServiceName</code></a> directive.

See also:
 <a href="#WrapServiceName">WrapServiceName</a>,
 <a href="#WrapTables">WrapTables</a>,
 <a href="#WrapUserTables">WrapUserTables</a>

<hr>
<h3><a name="WrapLog">WrapLog</a></h3>
Syntax: WrapLog file|&quot;none&quot; 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

The <code>WrapLog</code> directive is used to specify a log file for
<code>mod_wrap2</code> reporting, and can be done a per-server basis.
The file parameter must be the full path to the file to use for
logging. Note that this path must not be to a world-writeable
directory and, unless <code>AllowLogSymlinks</code> is explicitly set to
on (generally a bad idea), the path must not be a symbolic
link.

If file is &quot;none&quot;, no logging will be done at all; this
setting can be used to override a <code>WrapLog</code> setting inherited from
a <code>&lt;Global&gt;</code> context.

<hr>
<h3><a name="WrapOptions">WrapOptions</a></h3>
Syntax: WrapOptions opt1 ... 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.4rc1 and later

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

Example:
<pre>
 WrapOptions CheckOnConnect
</pre>

The currently implemented options are:
<ul>
 <li><code>CheckAllNames</code> 
 
 This causes <code>mod_wrap2</code> to check all of the known
 DNS names for the client IP address against the DNS names/patterns
 in the access rules, rather than just checking the first DNS name
 returned for the client IP address.
 </li>

<li><code>CheckOnConnect</code> 
 
 This causes <code>mod_wrap2</code> to check the allow/deny tables when
 the client first connects, rather than waiting until the client has
 authenticated before checking the access rules. This means that
 per-user/group allow/deny tables, and the use of the tilde (~) notation
 in table paths, is not supported when this option is used.

In addition, if <code>mod_wrap2_sql</code> is used, the order in
 which that module is loaded is very important. The <code>mod_sql</code>
 module must appear after the <code>mod_wrap2</code> module
 in the <code>--with-modules</code> configure option, e.g.:
<pre>
 --with-modules=mod_wrap2:mod_wrap2_sql:mod_sql:mod_sql_mysql
</pre>
 Or, if you are using shared/DSO modules, then you must ensure that
 the modules are loaded in the correct order via <code>LoadModule</code>:
<pre>
 ...
 LoadModule mod_wrap2.c
 LoadModule mod_wrap2_sql.c
 ...
 LoadModule mod_sql.c
 LoadModule mod_sql_mysql.c
 ...
</pre>
 
 You will also need to ensure that <code>mod_sql</code> creates a
 database connection at connect time, using the <code>PERCONNECTION</code>
 connection policy; see
 <a href="mod_sql.html#SQLConnectInfo"><code>SQLConnectInfo</code></a> for
 more details:
<pre>
 SQLConnectInfo database user password PERCONNECTION
</pre>

Without this, the database connection will not be created at connect
 time, and the <code>mod_wrap2</code> module will be unable to check
 any allow/deny rules stored in SQL tables when the client connects.
 </li>
</ul>

<hr>
<h3><a name="WrapServiceName">WrapServiceName</a></h3>
Syntax: WrapServiceName name 
Default: <code>WrapServiceName proftpd</code> 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

<code>WrapServiceName</code> is used to configure the name of the service under
which <code>mod_wrap2</code> will check the allow/deny tables. By default, this
is the name of the program started, i.e. &quot;proftpd&quot;. However,
some administrators may want to use a different, more generic service name,
such as &quot;ftpd&quot;; use this directive for such needs. The lookup
using the configured name is case-sensitive.

<hr>
<h3><a name="WrapTables">WrapTables</a></h3>
Syntax: WrapTables source-type:allow-source-info source-info:deny-source-info 
Default: None 
Context: server config, <code>&lt;VirtualHost</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

The <code>WrapTables</code> directive configures the information necessary
for <code>mod_wrap2</code> to locate and use the tables containing the access
rules for all clients.

The two parameters specify two tables, an allow and a deny table, each of which
contain the IP addresses, networks or host/network masks to be allowed or
denied.

See also:
 <a href="#WrapGroupTables">WrapGroupTables</a>,
 <a href="#WrapServiceName">WrapServiceName</a>,
 <a href="#WrapUserTables">WrapUserTables</a>

<hr>
<h3><a name="WrapUserTables">WrapUserTables</a></h3>
Syntax: WrapUserTables user-OR-expression source-type:allow-source-info source-type:deny-source-info [source-type:option-source-info] 
Default: None 
Context: server config, <code>&lt;VirtualHost</code>, <code>&lt;Global&gt;</code>, <code>&lt;Anonymous&gt;</code> 
Module: mod_wrap2 
Compatibility: 1.3.1rc1 and later

The <code>WrapUserTables</code> directive configures the information necessary
for <code>mod_wrap2</code> to locate and use the tables containing the access
rules for specific users.

The user-OR-expression parameter is a logical OR expression, which
means that the connecting user can be any the users listed for this
directive to apply. User names may be negated with a <code>!</code> prefix.

The next two parameters specify two tables, an allow and a deny table, each of
which contain the IP addresses, networks or host/network masks to be allowed or
denied.

See also:
 <a href="#WrapGroupTables">WrapGroupTables</a>,
 <a href="#WrapServiceName">WrapServiceName</a>,
 <a href="#WrapTables">WrapTables</a>

<hr>
<h2><a name="Usage">Usage</a></h2>
To use <code>mod_wrap2</code>'s functionality, you must first define the tables
that together contain the access rules. Access rules are composed of
daemon lists, client lists, and optional options lists.
daemon lists are used so that the access rules can be configured for
multiple daemons; <code>mod_wrap2</code> ignores all daemons except that
configured for <code>proftpd</code>. client lists are the heart of
the access rules, specifying the host names, IP addresses, etc to
be allowed or denied. The handling of options lists is done only if
<code>mod_wrap2</code> is configured with the
<code>--enable-wrapper-options</code> option.

There is a built-in precedence to the <code>WrapUserTables</code>,
<code>WrapGroupTables</code>, and <code>WrapTables</code> directives, if all
are used. <code>mod_wrap2</code> will look for applicable
<code>WrapUserTables</code> for the connecting user first. If no applicable
<code>WrapUserTables</code> are found, <code>mod_wrap2</code> will search for
<code>WrapGroupTables</code> which pertain to the connecting user. If not
found, <code>mod_wrap2</code> will then look for the server-wide
<code>WrapTables</code> directive. This allows for access control to be set
on a per-server basis, and allow for per-user or per-group access control
to be handled without interfering with the overall server access rules.

When checking the tables, <code>mod_wrap2</code> always checks the allow
table first. If the client has been explicitly allowed by the rules in
that table, processing stops and <code>mod_wrap2</code> allows the client
to continue the session. If not explicitly allowed, <code>mod_wrap2</code>
will then check the deny table's access rules. If the client has been
explicitly denied by rules in that table, <code>mod_wrap2</code> will
disconnect the client. By default, if neither explicitly allowed or
explicitly denied, <code>mod_wrap2</code> will allow the client to continue.

<a name="builtin"></a>
In addition to the various formats supported by the
<a href="#submodules">submodules</a>, there is a special source type:
&quot;builtin&quot;. This is used in the situations where the administrator
wishes to configure &quot;mostly closed&quot; access rules, the most common
situation. For example, if all clients are to be denied by
<code>mod_wrap2</code> by default, unless that client is granted access via an
allow table entry, then the administrator can use:
<pre>
 builtin:all
</pre>
as the deny table parameter (e.g. in a <code>WrapUserTables</code>,
<code>WrapGroupTables</code>, or <code>WrapTables</code> directive), rather
than configuring a static deny table that always says ALL.

<h3><a name="AccessRules">Access Rules</a></h3>
When checking access rules, the check terminates when the first match is
found. A client list is a list of one or more host names, host
addresses, patterns or wildcards (see below) that will be matched against the
client host name or address. The more complex daemon@host and
user@host forms are explained in the sections on server endpoint
patterns and on client username lookups, respectively. With the exception of
NIS/YP netgroup lookups, all access control checks are case insensitive.

Patterns 
The access control language implements the following patterns:
<ul>
 <li>A string that begins with a `.' character. A host name is matched if the
 last components of its name match the specified pattern. For example, the
 pattern <code>.castaglia.org</code> matches the host name
 <code>golem.devlan.castaglia.org</code>.

<li>A string that ends with a `.' character. A host address is matched if its
 first numeric fields match the given string. For example, the pattern
 <code>131.155.</code> matches the address of (almost) every host on the
 Eindhoven University network (<code>131.155.x.x</code>).

<li>A string that begins with an `@' character is treated as an NIS (formerly
 YP) netgroup name. A host name is matched if it is a host member of the
 specified netgroup. Netgroup matches are not supported for client user
 names. Note that <code>mod_wrap2</code> must be configured for NIS
 support for netgroup lookups to occur.

<li>An expression of the form n.n.n.n/m.m.m.m is interpreted as
 an IPv4 <code>net/mask</code> pair. An IPv4 address is matched if the
 <code>net</code> portion is equal to the bitwise AND of the address and the
 <code>mask</code> portion. For example, the <code>net/mask</code> pattern
 <code>131.155.72.0/255.255.254.0</code> matches every address in the range
 <code>131.155.72.0</code> through <code>131.155.73.255</code>.

<li>An expression of the form [address]/number is interpreted as
 an IPv6 <code>net/mask</code> pair. An IPv6 address is matched if the
 first number bits match the rule address. For example,
 <code>[3ffe:505:2:1::]/64</code> matches every address in the range
 <code>3ffe:505:2:1::</code> through <code>3ffe:505:2:1:ffff:ffff:ffff:ffff:</code>.

<li>A string that begins with a `/' character is treated as a file name.
 A host name or address is matched if it matches any host name or address
 pattern listed in the named file. The file format is zero or more lines
 with zero or more host name or address patterns separated by whitespace.
 A file name pattern can be used anywhere a host name or address pattern
 can be used.

<li>Wildcards `*' and `?' can be used to match hostnames or IP addresses.
 This method of matching cannot be used in conjunction with
 <code>net/mask</code> matching, hostname matching beginning with `.' or
 IP address matching ending with `.'.
</ul>

Wildcards 
The access control language supports explicit wildcards: 
<ul>
 <li>ALL 
 The universal wildcard, always matches.

<li>LOCAL 
 Matches any host whose name does not contain a dot character.

<li>UNKNOWN 
 Matches any user whose name is unknown, and matches any host whose name or
 address are unknown. This pattern should be used with care: host names may
 be unavailable due to temporary name server problems.

<li>KNOWN 
 Matches any user whose name is known, and matches any host whose name and
 address are known. This pattern should be used with care: host names may be
 unavailable due to temporary name server problems.

<li>PARANOID 
 Matches any host whose name does not match its address, before looking
 at the access control tables.
</ul>

Operators 
<ul>
 <li>EXCEPT 
 Intended use is of the form:
<pre>
 list1 EXCEPT list2
</pre>
 This construct matches anything that matches list1 unless it
 matches list2. The EXCEPT operator can be used in daemon
 lists and client lists. The EXCEPT operator can be nested: if
 the control language would permit the use of parentheses:
<pre>
 a EXCEPT b EXCEPT c
</pre>
 would parse as
<pre>
 (a EXCEPT (b EXCEPT c))
</pre>
</ul>

Server Endpoint Patterns 
In order to distinguish clients by the network address that they connect to,
use patterns of the form:
<pre>
 process-name@host-pattern : client-list ...
</pre>
Patterns like these can be used when the machine has different Internet
addresses with different Internet hostnames. Service providers can use this
facility to offer FTP, GOPHER or WWW archives with Internet names that may even
belong to different organizations. Some systems can have more than one
Internet address on one physical interface.

The host-pattern obeys the same syntax rules as host names and addresses
in client lists.

Client Username Lookup 
When the client host supports the RFC 931 protocol, the <code>proftpd</code>
daemon can retrieve additional information about the owner of a connection.
Client username information, when available (i.e. when
<code>IdentLookups</code> are not disabled), is logged together with the client
host name, and can be used to match patterns like:
<pre>
 daemon-list : ... user-pattern@host-pattern ...
</pre>

A user-pattern has the same syntax as a daemon pattern, so the same
wildcards apply (netgroup membership is not supported). One should not get
carried away with username lookups, though:
<ul>
 <li>The client username information cannot be trusted when it is needed
 most, i.e. when the client system has been compromised. In
 general, ALL and (UN)KNOWN are the only user name patterns that make sense.

<li>Username lookups are possible only when the client host runs a suitable
 daemon; in all other cases the result is "unknown".
</ul>

<h3><a name="AccessOptions">Access Options</a></h3>
This section describes optional options list portion the access control
language described above. The options list syntax uses the following
format:
<pre>
 opt1 : opt2 ...
</pre>
Any `:' characters within options should be protected with a backslash.

An option is of the form <code>&quot;keyword&quot;</code> or
<code>&quot;keyword value&quot;</code>. Options are processed in the
specified order. For the sake of backwards compatibility with earlier
versions, a `=' is permitted between keyword and value.
<ul>
 <li>ALLOW 
 Grant service. This option must appear at the end of a rule.
 </li>

<li>DENY 
 Deny service. This option must appear at the end of a rule.
 </li>
</ul>

The allow and deny keywords make it possible to keep all access control
rules within a single file, for example in the <code>hosts.allow</code>
file. To permit access from specific hosts only:
<pre>
 ALL: .friendly.domain: ALLOW
 ALL: ALL: DENY
</pre>
To permit access from all hosts except a few trouble makers:
<pre>
 ALL: .bad.domain: DENY
 ALL: ALL: ALLOW
</pre>
Notice the leading dot on the domain name patterns.

<ul>
 
 <li>nice [number] 
 Change the nice value of the process (default 10). Specify a positive
 value to spend more CPU resources on other processes.

<li>setenv name=value 
 Place a <code>name=value</code> pair into the process environment. The
 value may contain whitespace (but leading and trailing blanks are stripped
 off).
</ul>

Diagnostics 
When a syntax error is found in an options list, the error is reported in the
<code>WrapLog</code> and the access option will be ignored.

<hr>
<h2><a name="Installation">Installation</a></h2>
Follow the usual steps for using third-party modules in ProFTPD:
<pre>
 $ ./configure --with-modules=wrap-modules
 $ make
 $ make install
</pre>
where wrap-modules will depend on the types of access tables you wish
to support.

For file-based access tables, include the <code>mod_wrap2_file</code>
submodule, e.g.:
<pre>
 mod_wrap2:mod_wrap2_file
</pre>
For SQL-based access tables, include the <code>mod_wrap2_sql</code>
submodule, e.g.:
<pre>
 mod_wrap2:mod_wrap2_sql
</pre>
And, if you wish to support both file- and SQL-based access tables, use:
<pre>
 mod_wrap2:mod_wrap2_file:mod_wrap2_sql
</pre>
Note that SQL tables require that a correct installation of <code>mod_sql</code>
(and any of its backend modules) also be used. Consult the <code>mod_sql</code>
documentation for installation instructions for that module.

</body>
</html>

❌ Cancel

🗂️ Enhanced PHP File Manager

📊 Server Information

🔧 Quick Actions

✏️ Editing: mod_wrap2.html

📤 Upload File

📁 Create Folder

📄 Create File

✏️ Rename Item

🗑️ Delete Confirmation