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_tls_shmcache.html

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

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

The <code>mod_tls_shmcache</code> submodule is contained in the
<code>mod_tls_shmcache.c</code> file, and is not compiled by default.
Installation instructions are discussed <a href="#Installation">here</a>.

This submodule provides a SysV shared memory-based implementation of
an external SSL session cache for use by the <code>mod_tls</code> module's
<a href="mod_tls.html#TLSSessionCache"><code>TLSSessionCache</code></a>
directive. The module also implements a SysV shared memory-based
implementation of an external OCSP response cache for the
<a href="mod_tls.html#TLSStaplingCache"><code>TLSStaplingCache</code></a>
directive.

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/).

This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).

<h2>Author</h2>

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

The <code>mod_tls_shmcache</code> module supports the &quot;shm&quot; string
for the type parameter of the
<a href="mod_tls.html#TLSSessionCache"><code>TLSSessionCache</code></a>
configuration directive. The info parameter for
<code>mod_tls_shmcache</code> must be formatted like:
<pre>
 /file=/path/to/cache/file[&amp;size=bytes]
</pre>
The configured path is used for synchronizing access to the shared memory
segment among the various server processes. The default shared memory
segment size allocated is 1.5MB; use the optional size key to
configure a different size, in bytes. Note that the configured size
must be able to hold at least one cached session; if a too-small size
is configured, that size will be ignored and the default size will be used.

The <code>mod_tls_shmcache</code> module also supports the &quot;shm&quot;
string for the type parameter of the
<a href="mod_tls.html#TLSStaplingCache"><code>TLStaplingCache</code></a>
configuration directive. The info parameter for
<code>mod_tls_shmcache</code> must be formatted like:
<pre>
 /file=/path/to/cache/file[&amp;size=bytes]
</pre>
The configured path is used for synchronizing access to the shared memory
segment among the various server processes. The default shared memory
segment size allocated is 1.5MB; use the optional size key to
configure a different size, in bytes. Note that the configured size
must be able to hold at least one cached OCSP response; if a too-small
size is configured, that size will be ignored and the default size will be used.

Examples

Use the default shared memory segment size and timeout:
<pre>
 &lt;IfModule mod_tls.c&gt;
 ...

&lt;IfModule mod_tls_shmcache.c&gt;
 TLSSessionCache shm:/file=/var/ftpd/sess_cache
 TLSStaplingCache shm:/file=/var/ftpd/ocsp_pcache
 &lt;/IfModule&gt;
 &lt;/IfModule&gt;
</pre>

Use a larger shared memory segment size:
<pre>
 &lt;IfModule mod_tls.c&gt;
 ...

&lt;IfModule mod_tls_shmcache.c&gt;
 TLSSessionCache shm:/file=/var/ftpd/sess_cache&amp;size=2097152
 TLSStaplingCache shm:/file=/var/ftpd/ocsp_cache&amp;size=2097152
 &lt;/IfModule&gt;
 &lt;/IfModule&gt;
</pre>

Use a smaller shared memory size, and a shorter timeout:
<pre>
 &lt;IfModule mod_tls.c&gt;
 ...

&lt;IfModule mod_tls_shmcache.c&gt;
      TLSSessionCache shm:/file=/var/ftpd/sess_cache&amp;size=512000 600

# Note that TLSStaplingCache does not use a timeout
 TLSStaplingCache shm:/file=/var/ftpd/ocsp_cache&amp;size=512000
 &lt;/IfModule&gt;
 &lt;/IfModule&gt;
</pre>

<hr>
<h2><a name="Installation">Installation</a></h2>
The <code>mod_tls_shmcache</code> module is distributed with the ProFTPD
source code. Simply follow the normal steps for using third-party modules
in ProFTPD, being sure to include the <code>mod_tls</code> module (on which
<code>mod_tls_shmcache</code> depends):
<pre>
 $ ./configure --with-modules=mod_tls:mod_tls_shmcache
 $ 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_tls_shmcache</code> as
a shared module:
<pre>
 $ prxs -c -i -d mod_tls_shmcache.c
</pre>

Note: If using <code>mod_tls_shmcache</code> as a shared module, make
sure that this module is loaded after the <code>mod_tls</code> module,
i.e.:
<pre>
 # Load mod_tls first
 LoadModule mod_tls.c
 
 # Then load any SSL caching modules
 LoadModule mod_tls_shmcache.c
</pre>

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

Logging 
The <code>mod_tls_shmcache</code> module supports <a href="../howto/Tracing.html">trace logging</a>, via the module-specific log channels:
<ul>
 <li>tls.shmcache
</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 tls.shmcache:20
</pre>
This trace logging can generate large files; it is intended for debugging use
only, and should be removed from any production configuration.

<a name="FAQ">
Frequently Asked Questions

<a name="TLSShmcacheEmptyFile">
Question: I configured a <code>TLSSessionCache</code> file, but it is empty. Is <code>mod_tls_shmcache</code> not working properly? 
Answer: Yes, <code>mod_tls_shmcache</code> is working
properly. The actual cache of SSL/TLS session data is stored in shared memory,
not on the filesystem. Storing data in system shared memory requires a unique
key; the <code>mod_tls_shmcache</code> uses the configured file to create
this unique key. The module also uses the configured
<code>TLSSessionCache</code> file for locking, as when handling a
<code>ftpdctl</code> request to clear the cache.

<a name="TLSShmcacheUndefinedSymbol">
Question: I am trying to use
<code>mod_tls_shmcache</code> as a shared module, but my <code>proftpd</code>
server fails to start up, failing with this error:
<pre>
 proftpd: symbol lookup error: /usr/local/libexec/mod_tls_shmcache.so: undefined symbol: tls_sess_cache_register
</pre>
Answer: This happens when your configuration is
loading the <code>mod_tls_shmcache</code> module before the
<code>mod_tls</code> has been loaded. The fix, then, is to make sure
your config looks something like this:
<pre>
 LoadModule mod_tls.c
 LoadModule mod_tls_shmcache.c
</pre>

</body>
</html>

${this.title}

Code Editor : mod_tls_shmcache.html