granicus.if.org Git - apache/blob - docs/manual/mod/mod_session_crypto.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
   4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_session_crypto - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_session_crypto</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_session_crypto.html" title="English">&nbsp;en&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Session encryption support</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>session_crypto_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_session_crypto.c</td></tr>
  35 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table>
  36 <h3>Summary</h3>
  37
  38     <div class="warning"><h3>Warning</h3>
  39       <p>The session modules make use of HTTP cookies, and as such can fall
  40       victim to Cross Site Scripting attacks, or expose potentially private
  41       information to clients. Please ensure that the relevant risks have
  42       been taken into account before enabling the session functionality on
  43       your server.</p>
  44     </div>
  45
  46     <p>This submodule of <code class="module"><a href="../mod/mod_session.html">mod_session</a></code> provides support for the
  47     encryption of user sessions before being written to a local database, or
  48     written to a remote browser via an HTTP cookie.</p>
  49
  50     <p>This can help provide privacy to user sessions where the contents of
  51     the session should be kept private from the user, or where protection is
  52     needed against the effects of cross site scripting attacks.</p>
  53
  54     <p>For more details on the session interface, see the documentation for
  55     the <code class="module"><a href="../mod/mod_session.html">mod_session</a></code> module.</p>
  56
  57 </div>
  58 <div id="quickview"><h3>Topics</h3>
  59 <ul id="topics">
  60 <li><img alt="" src="../images/down.gif" /> <a href="#basicusage">Basic Usage</a></li>
  61 </ul><h3 class="directives">Directives</h3>
  62 <ul id="toc">
  63 <li><img alt="" src="../images/down.gif" /> <a href="#sessioncryptocipher">SessionCryptoCipher</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#sessioncryptodriver">SessionCryptoDriver</a></li>
  65 <li><img alt="" src="../images/down.gif" /> <a href="#sessioncryptopassphrase">SessionCryptoPassphrase</a></li>
  66 <li><img alt="" src="../images/down.gif" /> <a href="#sessioncryptopassphrasefile">SessionCryptoPassphraseFile</a></li>
  67 </ul>
  68 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_session_crypto">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_session_crypto">Report a bug</a></li></ul><h3>See also</h3>
  69 <ul class="seealso">
  70 <li><code class="module"><a href="../mod/mod_session.html">mod_session</a></code></li>
  71 <li><code class="module"><a href="../mod/mod_session_cookie.html">mod_session_cookie</a></code></li>
  72 <li><code class="module"><a href="../mod/mod_session_dbd.html">mod_session_dbd</a></code></li>
  73 <li><a href="#comments_section">Comments</a></li></ul></div>
  74 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  75 <div class="section">
  76 <h2><a name="basicusage" id="basicusage">Basic Usage</a></h2>
  77
  78       <p>To create a simple encrypted session and store it in a cookie called
  79       <var>session</var>, configure the session as follows:</p>
  80
  81       <div class="example"><h3>Browser based encrypted session</h3><pre class="prettyprint lang-config">Session On
  82 SessionCookieName session path=/
  83 SessionCryptoPassphrase secret</pre>
  84 </div>
  85
  86       <p>The session will be encrypted with the given key. Different servers can
  87       be configured to share sessions by ensuring the same encryption key is used
  88       on each server.</p>
  89
  90       <p>If the encryption key is changed, sessions will be invalidated
  91       automatically.</p>
  92
  93       <p>For documentation on how the session can be used to store username
  94       and password details, see the <code class="module"><a href="../mod/mod_auth_form.html">mod_auth_form</a></code> module.</p>
  95
  96     </div>
  97 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  98 <div class="directive-section"><h2><a name="SessionCryptoCipher" id="SessionCryptoCipher">SessionCryptoCipher</a> <a name="sessioncryptocipher" id="sessioncryptocipher">Directive</a></h2>
  99 <table class="directive">
 100 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The crypto cipher to be used to encrypt the session</td></tr>
 101 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SessionCryptoCipher <var>name</var></code></td></tr>
 102 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>aes256</code></td></tr>
 103 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 104 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 105 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_session_crypto</td></tr>
 106 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.0 and later</td></tr>
 107 </table>
 108     <p>The <code class="directive">SessionCryptoCipher</code> directive allows the cipher to
 109     be used during encryption. If not specified, the cipher defaults to
 110     <code>aes256</code>.</p>
 111
 112     <p>Possible values depend on the crypto driver in use, and could be one of:</p>
 113
 114     <ul><li>3des192</li><li>aes128</li><li>aes192</li><li>aes256</li></ul>
 115
 116
 117 </div>
 118 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 119 <div class="directive-section"><h2><a name="SessionCryptoDriver" id="SessionCryptoDriver">SessionCryptoDriver</a> <a name="sessioncryptodriver" id="sessioncryptodriver">Directive</a></h2>
 120 <table class="directive">
 121 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The crypto driver to be used to encrypt the session</td></tr>
 122 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SessionCryptoDriver <var>name</var> <var>[param[=value]]</var></code></td></tr>
 123 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 124 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 125 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 126 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_session_crypto</td></tr>
 127 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.0 and later</td></tr>
 128 </table>
 129     <p>The <code class="directive">SessionCryptoDriver</code> directive specifies the name of
 130     the crypto driver to be used for encryption. If not specified, the driver defaults
 131     to the recommended driver compiled into APR-util.</p>
 132
 133     <p>The <var>NSS</var> crypto driver requires some parameters for configuration,
 134     which are specified as parameters with optional values after the driver name.</p>
 135
 136     <div class="example"><h3>NSS without a certificate database</h3><pre class="prettyprint lang-config">SessionCryptoDriver nss</pre>
 137 </div>
 138
 139     <div class="example"><h3>NSS with certificate database</h3><pre class="prettyprint lang-config">SessionCryptoDriver nss dir=certs</pre>
 140 </div>
 141
 142     <div class="example"><h3>NSS with certificate database and parameters</h3><pre class="prettyprint lang-config">SessionCryptoDriver nss dir=certs key3=key3.db cert7=cert7.db secmod=secmod</pre>
 143 </div>
 144
 145     <div class="example"><h3>NSS with paths containing spaces</h3><pre class="prettyprint lang-config">SessionCryptoDriver nss "dir=My Certs" key3=key3.db cert7=cert7.db secmod=secmod</pre>
 146 </div>
 147
 148     <p>The <var>NSS</var> crypto driver might have already been
 149     configured by another part of the server, for example from
 150     <code>mod_nss</code> or <code class="module"><a href="../mod/mod_ldap.html">mod_ldap</a></code>. If found to
 151     have already been configured, a warning will be logged, and the
 152     existing configuration will have taken affect.  To avoid this
 153     warning, use the noinit parameter as follows.</p>
 154
 155     <div class="example"><h3>NSS with certificate database</h3><pre class="prettyprint lang-config">SessionCryptoDriver nss noinit</pre>
 156 </div>
 157
 158     <p>To prevent confusion, ensure that all modules requiring NSS are configured with
 159     identical parameters.</p>
 160
 161     <p>The <var>openssl</var> crypto driver supports an optional parameter to specify
 162     the engine to be used for encryption.</p>
 163
 164     <div class="example"><h3>OpenSSL with engine support</h3><pre class="prettyprint lang-config">SessionCryptoDriver openssl engine=name</pre>
 165 </div>
 166
 167
 168 </div>
 169 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 170 <div class="directive-section"><h2><a name="SessionCryptoPassphrase" id="SessionCryptoPassphrase">SessionCryptoPassphrase</a> <a name="sessioncryptopassphrase" id="sessioncryptopassphrase">Directive</a></h2>
 171 <table class="directive">
 172 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The key used to encrypt the session</td></tr>
 173 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SessionCryptoPassphrase <var>secret</var> [ <var>secret</var> ... ] </code></td></tr>
 174 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 175 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 176 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 177 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_session_crypto</td></tr>
 178 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.0 and later</td></tr>
 179 </table>
 180     <p>The <code class="directive">SessionCryptoPassphrase</code> directive specifies the keys
 181     to be used to enable symmetrical encryption on the contents of the session before
 182     writing the session, or decrypting the contents of the session after reading the
 183     session.</p>
 184
 185     <p>Keys are more secure when they are long, and consist of truly random characters.
 186     Changing the key on a server has the effect of invalidating all existing sessions.</p>
 187
 188     <p>Multiple keys can be specified in order to support key rotation. The first key
 189     listed will be used for encryption, while all keys listed will be attempted for
 190     decryption. To rotate keys across multiple servers over a period of time, add a new
 191     secret to the end of the list, and once rolled out completely to all servers, remove
 192     the first key from the start of the list.</p>
 193
 194     <p>As of version 2.4.7 if the value begins with <var>exec:</var> the resulting command
 195     will be executed and the first line returned to standard output by the program will be
 196     used as the key.</p>
 197 <div class="example"><pre>#key used as-is
 198 SessionCryptoPassphrase secret
 199
 200 #Run /path/to/program to get key
 201 SessionCryptoPassphrase exec:/path/to/program
 202
 203 #Run /path/to/otherProgram and provide arguments
 204 SessionCryptoPassphrase "exec:/path/to/otherProgram argument1"</pre></div>
 205
 206
 207 </div>
 208 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 209 <div class="directive-section"><h2><a name="SessionCryptoPassphraseFile" id="SessionCryptoPassphraseFile">SessionCryptoPassphraseFile</a> <a name="sessioncryptopassphrasefile" id="sessioncryptopassphrasefile">Directive</a></h2>
 210 <table class="directive">
 211 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>File containing keys used to encrypt the session</td></tr>
 212 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SessionCryptoPassphraseFile <var>filename</var></code></td></tr>
 213 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr>
 214 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 215 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 216 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_session_crypto</td></tr>
 217 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.0 and later</td></tr>
 218 </table>
 219     <p>The <code class="directive">SessionCryptoPassphraseFile</code> directive specifies the
 220     name of a configuration file containing the keys to use for encrypting or decrypting
 221     the session, specified one per line. The file is read on server start, and a graceful
 222     restart will be necessary for httpd to pick up changes to the keys.</p>
 223
 224     <p>Unlike the <code class="directive">SessionCryptoPassphrase</code> directive, the keys are
 225     not exposed within the httpd configuration and can be hidden by protecting the file
 226     appropriately.</p>
 227
 228     <p>Multiple keys can be specified in order to support key rotation. The first key
 229     listed will be used for encryption, while all keys listed will be attempted for
 230     decryption. To rotate keys across multiple servers over a period of time, add a new
 231     secret to the end of the list, and once rolled out completely to all servers, remove
 232     the first key from the start of the list.</p>
 233
 234
 235 </div>
 236 </div>
 237 <div class="bottomlang">
 238 <p><span>Available Languages: </span><a href="../en/mod/mod_session_crypto.html" title="English">&nbsp;en&nbsp;</a></p>
 239 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 240 <script type="text/javascript"><!--//--><![CDATA[//><!--
 241 var comments_shortname = 'httpd';
 242 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_session_crypto.html';
 243 (function(w, d) {
 244     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 245         d.write('<div id="comments_thread"><\/div>');
 246         var s = d.createElement('script');
 247         s.type = 'text/javascript';
 248         s.async = true;
 249         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 250         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 251     }
 252     else {
 253         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 254     }
 255 })(window, document);
 256 //--><!]]></script></div><div id="footer">
 257 <p class="apache">Copyright 2016 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 258 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 259 if (typeof(prettyPrint) !== 'undefined') {
 260     prettyPrint();
 261 }
 262 //--><!]]></script>
 263 </body></html>