Gecko [ www.thearyasamaj.org ]

Name	Size	Permission
ftpasswd.html	14.61 KB	-rw-r--r--
ftpmail.html	8 KB	-rw-r--r--
ftpquota.html	10.9 KB	-rw-r--r--
index.html	9.04 KB	-rw-r--r--
mod_auth_otp.html	16.5 KB	-rw-r--r--
mod_ban.html	22.53 KB	-rw-r--r--
mod_copy.html	4.85 KB	-rw-r--r--
mod_ctrls_admin.html	15.05 KB	-rw-r--r--
mod_deflate.html	6.89 KB	-rw-r--r--
mod_digest.html	12.92 KB	-rw-r--r--
mod_dnsbl.html	6.1 KB	-rw-r--r--
mod_dynmasq.html	3.26 KB	-rw-r--r--
mod_exec.html	23.89 KB	-rw-r--r--
mod_geoip.html	17.06 KB	-rw-r--r--
mod_ifsession.html	11.02 KB	-rw-r--r--
mod_ifversion.html	4.96 KB	-rw-r--r--
mod_ldap.html	32.32 KB	-rw-r--r--
mod_load.html	2.97 KB	-rw-r--r--
mod_log_forensic.html	9.78 KB	-rw-r--r--
mod_qos.html	2.62 KB	-rw-r--r--
mod_quotatab.html	25.02 KB	-rw-r--r--
mod_quotatab_file.html	2.23 KB	-rw-r--r--
mod_quotatab_ldap.html	2.63 KB	-rw-r--r--
mod_quotatab_radius.html	2.08 KB	-rw-r--r--
mod_quotatab_sql.html	10.93 KB	-rw-r--r--
mod_radius.html	22.11 KB	-rw-r--r--
mod_ratio.html	6.99 KB	-rw-r--r--
mod_readme.html	2.69 KB	-rw-r--r--
mod_rewrite.html	30.06 KB	-rw-r--r--
mod_sftp.html	93.71 KB	-rw-r--r--
mod_sftp_pam.html	5.47 KB	-rw-r--r--
mod_sftp_sql.html	5.63 KB	-rw-r--r--
mod_shaper.html	23.28 KB	-rw-r--r--
mod_site_misc.html	5.81 KB	-rw-r--r--
mod_snmp.html	42.38 KB	-rw-r--r--
mod_sql.html	62.81 KB	-rw-r--r--
mod_sql_odbc.html	10.2 KB	-rw-r--r--
mod_sql_passwd.html	24.44 KB	-rw-r--r--
mod_sql_sqlite.html	2.95 KB	-rw-r--r--
mod_statcache.html	8.29 KB	-rw-r--r--
mod_tls.html	85.34 KB	-rw-r--r--
mod_tls_fscache.html	2.73 KB	-rw-r--r--
mod_tls_memcache.html	3.91 KB	-rw-r--r--
mod_tls_redis.html	3.6 KB	-rw-r--r--
mod_tls_shmcache.html	6.78 KB	-rw-r--r--
mod_unique_id.html	3.54 KB	-rw-r--r--
mod_wrap.html	12.38 KB	-rw-r--r--
mod_wrap2.html	24.83 KB	-rw-r--r--
mod_wrap2_file.html	4.69 KB	-rw-r--r--
mod_wrap2_redis.html	5.33 KB	-rw-r--r--
mod_wrap2_sql.html	8.33 KB	-rw-r--r--

Code Editor : mod_ifsession.html

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

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

The purpose of <code>mod_ifsession</code> is to provide a flexible way of
specifying that certain configuration directives only apply to certain sessions,
based on credentials such as connection class, user, or group membership.

For class-based qualifications, <code>mod_ifsession</code> will apply 
configuration directives to the current session as soon as the client has
connected to the server; for user- and group-based qualifications,
<code>mod_ifsession</code> applies configuration directives to the current
session, if applicable, only after the client has successfully authenticated.
This means that <code>mod_ifsession</code> cannot change the effect of some
user- and group-qualified configuration directives, particularly those that
influence the session prior to authentication. These directives include:
<pre>
 AccessDenyMsg
 AccessGrantMsg
 AnonRequirePassword
 &lt;Anonymous&gt;
 AuthGroupFile
 AuthUserFile
 CreateHome
 DefaultChdir
 DefaultRoot
 DefaultTransferMode
 DisplayConnect
 ExtendedLog
 MaxInstances
 RequireValidShell
 RootLogin
 ServerIdent
 ServerName
 ShowSymlinks
 TransferLog
 UseFtpUsers
 WtmpLog
</pre>
and the directives from the <code>mod_auth_pam</code> module. All of these
can set on based on class qualifications, however.

While the above list of configuration directives is daunting, there are
still valid uses for this module, e.g. configuring
<code>&lt;Directory&gt;</code> and/or <code>&lt;Limit&gt;</code> for certain
sessions, <code>Filter</code> directives, transfer rates, maximum file sizes,
etc. Plus, some of the above directives (e.g. <code>DefaultChdir</code>,
<code>DefaultRoot</code>) already have their own configurable restrictions
(group expressions in the case of <code>DefaultChdir</code> and
<code>DefaultRoot</code>), so all is not entirely lost.

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

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

<h2>Author</h2>

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

<h2>Directives</h2>
<ul>
 <li><a href="#IfAuthenticated">&lt;IfAuthenticated&gt;</a>
 <li><a href="#IfClass">&lt;IfClass&gt;</a>
 <li><a href="#IfGroup">&lt;IfGroup&gt;</a>
 <li><a href="#IfUser">&lt;IfUser&gt;</a>
</ul>

<hr>
<h3><a name="IfAuthenticated">&lt;IfAuthenticated&gt;</a></h3>
Syntax: &lt;IfAuthenticated&gt; 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_ifsession 
Compatibility: 1.3.5rc1 and later

The <code>&lt;IfAuthenticated&gt;</code> context should contain any
configuration directives that should be in effect for any sessions where
the client has successfully authenticated.

Examples:
<pre>
 # Only configure SQL logging for authenticated users, to avoid cluttering
 # database tables with fail login data
 &lt;IfAuthenticated&gt;
 SQLLog ...
 &lt;/IfAuthenticated&gt;
</pre>

See also: <a href="#IfGroup">&lt;IfGroup&gt;</a>, <a href="#IfUser">&lt;IfUser&gt;</a>

<hr>
<h3><a name="IfClass">&lt;IfClass&gt;</a></h3>
Syntax: &lt;IfClass [&quot;AND&quot;|&quot;OR&quot;] class-expression|&quot;regex&quot; regexp&gt; 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_ifsession 
Compatibility: 1.2.8rc1 and later

The <code>&lt;IfClass&gt;</code> context should contain any configuration
directives that should be in effect for any sessions that match the
class-expression. <code>Classes</code> must be enabled for this
context to work properly; the connecting client must be in any of the classes
listed in the expression for the directives contained to be applied. Note
that <code>!</code> notation in front of a class name in the expression is
supported.

The given class-expression may optionally be prefixed
with either the &quot;AND&quot; or &quot;OR&quot; keywords, which affect how
the expression is evaluated: if &quot;AND&quot; is used, then all
portions of the expression must evaluate to TRUE for the configuration context
to be applied to the current session; if &quot;OR&quot; is used, then any
portion of the expression must be TRUE for the context to be applied. The
default setting for <code>&lt;IfClass&gt;</code> is &quot;OR&quot;.

If the &quot;regex&quot; keyword is used, the regexp should be a
regular expression to match class names.

Examples:
<pre>
 # Give friends, and local users, better transfer rates
 &lt;IfClass local, friends&gt;
 TransferRate RETR 8192
 &lt;/IfClass&gt;

TransferRate RETR 4096
</pre>

See also: <a href="#IfGroup">&lt;IfGroup&gt;</a>, <a href="#IfUser">&lt;IfUser&gt;</a>

<hr>
<h3><a name="IfGroup">&lt;IfGroup&gt;</a></h3>
Syntax: &lt;IfGroup [&quot;AND&quot;|&quot;OR&quot;] group-expression|&quot;regex&quot; regexp&gt; 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_ifsession 
Compatibility: 1.2.8rc1 and later

The <code>&lt;IfGroup&gt;</code> context should contain any configuration
directives that should be in effect for any sessions that match the
group-AND-expression. The authenticated user must be in all of
the groups listed in the expression for the directives contained to be
applied. Note that <code>!</code> notation in front of a group name in the
expression is supported.

The given group-expression may optionally be prefixed
with either the &quot;AND&quot; or &quot;OR&quot; keywords, which affect how
the expression is evaluated: if &quot;AND&quot; is used, then all
portions of the expression must evaluate to TRUE for the configuration context
to be applied to the current session; if &quot;OR&quot; is used, then any
portion of the expression must be TRUE for the context to be applied. The
default setting for <code>&lt;IfGroup&gt;</code> is &quot;AND&quot;.

If the &quot;regex&quot; keyword is used, the regexp should be a
regular expression to match group names.

Example:
<pre>
 # Only members of group webusers can upload/download HTML files
 &lt;IfGroup !webusers&gt;
 PathDenyFilter \.htm$|\.html$
 &lt;/IfGroup&gt;
</pre>

See also: <a href="#IfClass">&lt;IfClass&gt;</a>, <a href="#IfUser">&lt;IfUser&gt;</a>

<hr>
<h3><a name="IfUser">&lt;IfUser&gt;</a></h3>
Syntax: &lt;IfUser [&quot;AND&quot;|&quot;OR&quot;] user-expression|&quot;regex&quot; regexp&gt; 
Default: None 
Context: server config, <code>&lt;VirtualHost&gt;</code>, <code>&lt;Global&gt;</code> 
Module: mod_ifsession 
Compatibility: 1.2.8rc1 and later

The <code>&lt;IfUser&gt;</code> context should contain any configuration
directives that should be in effect for any sessions that match the
user-OR-expression. The authenticated user must be one of the users
listed in the expression for the directives contained to be applied. Note
that <code>!</code> notation in front of a user name in the expression is
supported.

The given user-expression may optionally be prefixed
with either the &quot;AND&quot; or &quot;OR&quot; keywords, which affect how
the expression is evaluated: if &quot;AND&quot; is used, then all
portions of the expression must evaluate to TRUE for the configuration context
to be applied to the current session; if &quot;OR&quot; is used, then any
portion of the expression must be TRUE for the context to be applied. The
default setting for <code>&lt;IfUser&gt;</code> is &quot;OR&quot;.

If the &quot;regex&quot; keyword is used, the regexp should be a
regular expression to match user names.

Example:
<pre>
 # Alter the view of files for everyone except the admin
 &lt;IfUser !ftpadm&gt;
 &lt;Directory /&gt;
 DirFakeUser on ~
 DirFakeGroup on ~
 DirFakeMode 0440
 &lt;/Directory&gt;
 &lt;/IfUser&gt;

# Impose a PathDenyFilter on ftp users
 &lt;IfUser regex ^ftp&gt;
 PathDenyFilter \.conf$
 &lt;/IfUser&gt;
</pre>

See also: <a href="#IfClass">&lt;IfClass&gt;</a>, <a href="#IfGroup">&lt;IfGroup&gt;</a>

<hr>
<h2><a name="Usage">Usage</a></h2>

As a Shared Module 
If your <code>proftpd</code> is compiled with <code>mod_ifsession</code>
as a shared module, then you must make sure that
<code>mod_ifsession</code> is loaded last:
<pre>
 &lt;IfModule mod_dso.c&gt;
 LoadModule mod_sql.c
 LoadModule mod_sql_mysql.c
 LoadModule mod_tls.c
 LoadModule mod_rewrite.c
 LoadModule mod_ifsession.c
 &lt;/IfModule&gt;
</pre>
Failure to ensure that <code>mod_ifsession</code> is loaded last will mean
that the per-user/group/class functionality will not work as you expect.

Todo 
Expressions, AND vs OR

<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_ifsession</code> module is distributed with ProFTPD. Follow the
usual steps for using third-party modules in ProFTPD:
<pre>
 $ ./configure --with-modules=mod_ifsession
 $ make
 $ make install
</pre>
Note that <code>mod_ifsession</code> should be the last module
in the <code>--with-modules</code> list, if multiple modules are listed.
This makes sure that <code>mod_ifsession</code>'s changes will be seen
properly by other modules.

To build <code>mod_ifsession</code> as a DSO module:
<pre>
 $ ./configure --enable-dso --with-shared=mod_ifsession
</pre>
Then follow the usual steps:
<pre>
 $ make 
 $ make install
</pre>

Alternatively, if your <code>proftpd</code> was compiled with DSO support, you
can use the <code>prxs</code> tool to build <code>mod_ifsession</code> as a
shared module:
<pre>
 $ prxs -c -i -d mod_ifsession.c
</pre>

Logging 
The <code>mod_ifsession</code> module supports <a href="../howto/Tracing.html">trace logging</a>, via the module-specific log channels:
<ul>
 <li>ifsession
</ul>
Thus for trace logging, to aid in debugging, you would use the following in
your <code>proftpd.conf</code>:
<pre>
 TraceLog /path/to/ftpd/trace.log
 Trace ifsession:20
</pre>
This trace logging can generate large files; it is intended for debugging use
only, and should be removed from any production configuration.

</body>
</html>

${this.title}

Code Editor : mod_ifsession.html