granicus.if.org Git - apache/blob - docs/manual/mod/mod_authn_socache.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_authn_socache - 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_authn_socache</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_socache.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_authn_socache.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Manages a cache of authentication credentials to relieve
  33 the load on backends</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_socache_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_socache.c</td></tr>
  37 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.3 and later</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>Maintains a cache of authentication credentials, so that a new backend
  41     lookup is not required for every authenticated request.</p>
  42 </div>
  43 <div id="quickview"><h3>Topics</h3>
  44 <ul id="topics">
  45 <li><img alt="" src="../images/down.gif" /> <a href="#intro">Authentication Cacheing</a></li>
  46 <li><img alt="" src="../images/down.gif" /> <a href="#usage">Usage</a></li>
  47 <li><img alt="" src="../images/down.gif" /> <a href="#dev">Cacheing with custom modules</a></li>
  48 </ul><h3 class="directives">Directives</h3>
  49 <ul id="toc">
  50 <li><img alt="" src="../images/down.gif" /> <a href="#authncachecontext">AuthnCacheContext</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#authncacheenable">AuthnCacheEnable</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#authncacheprovidefor">AuthnCacheProvideFor</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#authncachesocache">AuthnCacheSOCache</a></li>
  54 <li><img alt="" src="../images/down.gif" /> <a href="#authncachetimeout">AuthnCacheTimeout</a></li>
  55 </ul>
  56 <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_authn_socache">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_authn_socache">Report a bug</a></li></ul><h3>See also</h3>
  57 <ul class="seealso">
  58 <li><a href="#comments_section">Comments</a></li></ul></div>
  59 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  60 <div class="section">
  61 <h2><a name="intro" id="intro">Authentication Cacheing</a></h2>
  62     <p>Some users of more heavyweight authentication such as SQL database
  63     lookups (<code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code>) have reported it putting an
  64     unacceptable load on their authentication provider.  A typical case
  65     in point is where an HTML page contains hundreds of objects
  66     (images, scripts, stylesheets, media, etc), and a request to the page
  67     generates hundreds of effectively-immediate requests for authenticated
  68     additional contents.</p>
  69     <p>mod_authn_socache provides a solution to this problem by
  70     maintaining a cache of authentication credentials.</p>
  71 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  72 <div class="section">
  73 <h2><a name="usage" id="usage">Usage</a></h2>
  74     <p>The authentication cache should be used where authentication
  75     lookups impose a significant load on the server, or a backend or
  76     network.  Authentication by file (<code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>)
  77     or dbm (<code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>) are unlikely to benefit,
  78     as these are fast and lightweight in their own right (though in some
  79     cases, such as a network-mounted file, cacheing may be worthwhile).
  80     Other providers such as SQL or LDAP based authentication are more
  81     likely to benefit, particularly where there is an observed
  82     performance issue.  Amongst the standard modules, <code class="module"><a href="../mod/mod_authnz_ldap.html">mod_authnz_ldap</a></code> manages its own cache, so only
  83     <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code> will usually benefit from this cache.</p>
  84     <p>The basic rules to cache for a provider are:</p>
  85     <ol><li>Include the provider you're cacheing for in an
  86             <code class="directive">AuthnCacheProvideFor</code> directive.</li>
  87         <li>List <var>socache</var> ahead of the provider you're
  88             cacheing for in your <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> directive.</li>
  89     </ol>
  90     <p>A simple usage example to accelerate <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code>
  91     using dbm as a cache engine:</p>
  92     <pre class="prettyprint lang-config">#AuthnCacheSOCache is optional.  If specified, it is server-wide
  93 AuthnCacheSOCache dbm
  94 &lt;Directory "/usr/www/myhost/private"&gt;
  95     AuthType Basic
  96     AuthName "Cached Authentication Example"
  97     AuthBasicProvider socache dbd
  98     AuthDBDUserPWQuery "SELECT password FROM authn WHERE user = %s"
  99     AuthnCacheProvideFor dbd
 100     Require valid-user
 101     #Optional
 102     AuthnCacheContext dbd-authn-example
 103 &lt;/Directory&gt;</pre>
 104
 105 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 106 <div class="section">
 107 <h2><a name="dev" id="dev">Cacheing with custom modules</a></h2>
 108     <p>Module developers should note that their modules must be enabled
 109     for cacheing with mod_authn_socache.  A single optional API function
 110     <var>ap_authn_cache_store</var> is provided to cache credentials
 111     a provider has just looked up or generated.  Usage examples are
 112     available in <a href="http://svn.eu.apache.org/viewvc?view=revision&amp;revision=957072">r957072</a>, in which three authn providers are enabled for cacheing.</p>
 113 </div>
 114 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 115 <div class="directive-section"><h2><a name="AuthnCacheContext" id="AuthnCacheContext">AuthnCacheContext</a> <a name="authncachecontext" id="authncachecontext">Directive</a></h2>
 116 <table class="directive">
 117 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify a context string for use in the cache key</td></tr>
 118 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheContext <var>directory|server|custom-string</var></code></td></tr>
 119 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>directory</code></td></tr>
 120 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 121 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 122 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr>
 123 </table>
 124     <p>This directive specifies a string to be used along with the supplied
 125     username (and realm in the case of Digest Authentication) in constructing
 126     a cache key.  This serves to disambiguate identical usernames serving
 127     different authentication areas on the server.</p>
 128     <p>Two special values for this are <var>directory</var>, which uses
 129     the directory context of the request as a string, and <var>server</var>
 130     which uses the virtual host name.</p>
 131     <p>The default is <var>directory</var>, which is also the most
 132     conservative setting.  This is likely to be less than optimal, as it
 133     (for example) causes <var>$app-base</var>, <var>$app-base/images</var>,
 134     <var>$app-base/scripts</var> and <var>$app-base/media</var> each to
 135     have its own separate cache key.  A better policy is to name the
 136     <code class="directive">AuthnCacheContext</code> for the password
 137     provider: for example a <var>htpasswd</var> file or database table.</p>
 138     <p>Contexts can be shared across different areas of a server, where
 139     credentials are shared.  However, this has potential to become a vector
 140     for cross-site or cross-application security breaches, so this directive
 141     is not permitted in <var>.htaccess</var> contexts.</p>
 142
 143 </div>
 144 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 145 <div class="directive-section"><h2><a name="AuthnCacheEnable" id="AuthnCacheEnable">AuthnCacheEnable</a> <a name="authncacheenable" id="authncacheenable">Directive</a></h2>
 146 <table class="directive">
 147 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable Authn caching configured anywhere</td></tr>
 148 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheEnable</code></td></tr>
 149 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 150 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 151 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr>
 152 </table>
 153     <p>This directive is not normally necessary: it is implied if
 154     authentication cacheing is enabled anywhere in <var>httpd.conf</var>.
 155     However, if it is not enabled anywhere in <var>httpd.conf</var>
 156     it will by default not be initialised, and is therefore not
 157     available in a <var>.htaccess</var> context.  This directive
 158     ensures it is initialised so it can be used in <var>.htaccess</var>.</p>
 159
 160 </div>
 161 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 162 <div class="directive-section"><h2><a name="AuthnCacheProvideFor" id="AuthnCacheProvideFor">AuthnCacheProvideFor</a> <a name="authncacheprovidefor" id="authncacheprovidefor">Directive</a></h2>
 163 <table class="directive">
 164 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify which authn provider(s) to cache for</td></tr>
 165 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheProvideFor <var>authn-provider</var> [...]</code></td></tr>
 166 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None</code></td></tr>
 167 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 168 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 169 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 170 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr>
 171 </table>
 172     <p>This directive specifies an authentication provider or providers
 173     to cache for.  Credentials found by a provider not listed in an
 174     AuthnCacheProvideFor directive will not be cached.</p>
 175
 176     <p>For example, to cache credentials found by <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code>
 177     or by a custom provider <var>myprovider</var>, but leave those looked
 178     up by lightweight providers like file or dbm lookup alone:</p>
 179     <pre class="prettyprint lang-config">AuthnCacheProvideFor dbd myprovider</pre>
 180
 181
 182 </div>
 183 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 184 <div class="directive-section"><h2><a name="AuthnCacheSOCache" id="AuthnCacheSOCache">AuthnCacheSOCache</a> <a name="authncachesocache" id="authncachesocache">Directive</a></h2>
 185 <table class="directive">
 186 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Select socache backend provider to use</td></tr>
 187 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheSOCache <var>provider-name[:provider-args]</var></code></td></tr>
 188 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
 189 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 190 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr>
 191 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Optional provider arguments are available in
 192 Apache HTTP Server 2.4.7 and later</td></tr>
 193 </table>
 194     <p>This is a server-wide setting to select a provider for the
 195     <a href="../socache.html">shared object cache</a>, followed by
 196     optional arguments for that provider.
 197     Some possible values for <var>provider-name</var> are "dbm", "dc",
 198     "memcache", or "shmcb", each subject to the appropriate module
 199     being loaded.  If not set, your platform's default will be used.</p>
 200
 201 </div>
 202 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 203 <div class="directive-section"><h2><a name="AuthnCacheTimeout" id="AuthnCacheTimeout">AuthnCacheTimeout</a> <a name="authncachetimeout" id="authncachetimeout">Directive</a></h2>
 204 <table class="directive">
 205 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set a timeout for cache entries</td></tr>
 206 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheTimeout <var>timeout</var> (seconds)</code></td></tr>
 207 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>300 (5 minutes)</code></td></tr>
 208 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 209 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 210 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 211 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr>
 212 </table>
 213     <p>Cacheing authentication data can be a security issue, though short-term
 214     cacheing is unlikely to be a problem.  Typically a good solution is to
 215     cache credentials for as long as it takes to relieve the load on a
 216     backend, but no longer, though if changes to your users and passwords
 217     are infrequent then a longer timeout may suit you.  The default 300
 218     seconds (5 minutes) is both cautious and ample to keep the load
 219     on a backend such as dbd (SQL database queries) down.</p>
 220     <p>This should not be confused with session timeout, which is an
 221     entirely separate issue.  However, you may wish to check your
 222     session-management software for whether cached credentials can
 223     "accidentally" extend a session, and bear it in mind when setting
 224     your timeout.</p>
 225
 226 </div>
 227 </div>
 228 <div class="bottomlang">
 229 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_socache.html" title="English">&nbsp;en&nbsp;</a> |
 230 <a href="../fr/mod/mod_authn_socache.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 231 </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>
 232 <script type="text/javascript"><!--//--><![CDATA[//><!--
 233 var comments_shortname = 'httpd';
 234 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authn_socache.html';
 235 (function(w, d) {
 236     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 237         d.write('<div id="comments_thread"><\/div>');
 238         var s = d.createElement('script');
 239         s.type = 'text/javascript';
 240         s.async = true;
 241         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 242         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 243     }
 244     else {
 245         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 246     }
 247 })(window, document);
 248 //--><!]]></script></div><div id="footer">
 249 <p class="apache">Copyright 2017 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>
 250 <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[//><!--
 251 if (typeof(prettyPrint) !== 'undefined') {
 252     prettyPrint();
 253 }
 254 //--><!]]></script>
 255 </body></html>