diff options
Diffstat (limited to 'docs/manual/mod/mod_authn_socache.html.en')
| -rw-r--r-- | docs/manual/mod/mod_authn_socache.html.en | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/docs/manual/mod/mod_authn_socache.html.en b/docs/manual/mod/mod_authn_socache.html.en index 051bb6a..2436be4 100644 --- a/docs/manual/mod/mod_authn_socache.html.en +++ b/docs/manual/mod/mod_authn_socache.html.en @@ -1,7 +1,7 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> +<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> -<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> +<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> <!-- XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT @@ -27,13 +27,13 @@ <div id="preamble"><h1>Apache Module mod_authn_socache</h1> <div class="toplang"> <p><span>Available Languages: </span><a href="../en/mod/mod_authn_socache.html" title="English"> en </a> | -<a href="../fr/mod/mod_authn_socache.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> +<a href="../fr/mod/mod_authn_socache.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> </div> <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Manages a cache of authentication credentials to relieve the load on backends</td></tr> <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> -<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_socache_module</td></tr> -<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_socache.c</td></tr> +<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_socache_module</td></tr> +<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_socache.c</td></tr> <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.3 and later</td></tr></table> <h3>Summary</h3> @@ -42,9 +42,9 @@ the load on backends</td></tr> </div> <div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3>Topics</h3> <ul id="topics"> -<li><img alt="" src="../images/down.gif" /> <a href="#intro">Authentication Cacheing</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#intro">Authentication Caching</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#usage">Usage</a></li> -<li><img alt="" src="../images/down.gif" /> <a href="#dev">Cacheing with custom modules</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#dev">Caching with custom modules</a></li> </ul><h3 class="directives">Directives</h3> <ul id="toc"> <li><img alt="" src="../images/down.gif" /> <a href="#authncachecontext">AuthnCacheContext</a></li> @@ -58,7 +58,7 @@ the load on backends</td></tr> <li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> -<h2><a name="intro" id="intro">Authentication Cacheing</a></h2> +<h2><a name="intro" id="intro">Authentication Caching</a></h2> <p>Some users of more heavyweight authentication such as SQL database lookups (<code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code>) have reported it putting an unacceptable load on their authentication provider. A typical case @@ -66,7 +66,7 @@ the load on backends</td></tr> (images, scripts, stylesheets, media, etc), and a request to the page generates hundreds of effectively-immediate requests for authenticated additional contents.</p> - <p>mod_authn_socache provides a solution to this problem by + <p><code class="module"><a href="../mod/mod_authn_socache.html">mod_authn_socache</a></code> provides a solution to this problem by maintaining a cache of authentication credentials.</p> </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> @@ -76,16 +76,16 @@ the load on backends</td></tr> network. Authentication by file (<code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>) or dbm (<code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>) are unlikely to benefit, as these are fast and lightweight in their own right (though in some - cases, such as a network-mounted file, cacheing may be worthwhile). + cases, such as a network-mounted file, caching may be worthwhile). Other providers such as SQL or LDAP based authentication are more likely to benefit, particularly where there is an observed 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 <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code> will usually benefit from this cache.</p> <p>The basic rules to cache for a provider are:</p> - <ol><li>Include the provider you're cacheing for in an - <code class="directive">AuthnCacheProvideFor</code> directive.</li> + <ol><li>Include the provider you're caching for in an + <code class="directive"><a href="#authncacheprovidefor">AuthnCacheProvideFor</a></code> directive.</li> <li>List <var>socache</var> ahead of the provider you're - 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> + caching 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> </ol> <p>A simple usage example to accelerate <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code> using dbm as a cache engine:</p> @@ -104,19 +104,19 @@ AuthnCacheSOCache dbm </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> -<h2><a name="dev" id="dev">Cacheing with custom modules</a></h2> +<h2><a name="dev" id="dev">Caching with custom modules</a></h2> <p>Module developers should note that their modules must be enabled - for cacheing with mod_authn_socache. A single optional API function + for caching with <code class="module"><a href="../mod/mod_authn_socache.html">mod_authn_socache</a></code>. A single optional API function <var>ap_authn_cache_store</var> is provided to cache credentials a provider has just looked up or generated. Usage examples are - available in <a href="http://svn.eu.apache.org/viewvc?view=revision&revision=957072">r957072</a>, in which three authn providers are enabled for cacheing.</p> + available in <a href="http://svn.eu.apache.org/viewvc?view=revision&revision=957072">r957072</a>, in which three authn providers are enabled for caching.</p> </div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="directive-section"><h2><a name="AuthnCacheContext" id="AuthnCacheContext">AuthnCacheContext</a> <a name="authncachecontext" id="authncachecontext">Directive</a></h2> <table class="directive"> <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specify a context string for use in the cache key</td></tr> -<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheContext <var>directory|server|custom-string</var></code></td></tr> -<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>directory</code></td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheContext directory|server|<var>custom-string</var></code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthnCacheContext directory</code></td></tr> <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr> <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr> @@ -125,10 +125,10 @@ AuthnCacheSOCache dbm username (and realm in the case of Digest Authentication) in constructing a cache key. This serves to disambiguate identical usernames serving different authentication areas on the server.</p> - <p>Two special values for this are <var>directory</var>, which uses - the directory context of the request as a string, and <var>server</var> + <p>Two special values for this are <code>directory</code>, which uses + the directory context of the request as a string, and <code>server</code> which uses the virtual host name.</p> - <p>The default is <var>directory</var>, which is also the most + <p>The default is <code>directory</code>, which is also the most conservative setting. This is likely to be less than optimal, as it (for example) causes <var>$app-base</var>, <var>$app-base/images</var>, <var>$app-base/scripts</var> and <var>$app-base/media</var> each to @@ -151,7 +151,7 @@ AuthnCacheSOCache dbm <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr> </table> <p>This directive is not normally necessary: it is implied if - authentication cacheing is enabled anywhere in <var>httpd.conf</var>. + authentication caching is enabled anywhere in <var>httpd.conf</var>. However, if it is not enabled anywhere in <var>httpd.conf</var> it will by default not be initialised, and is therefore not available in a <var>.htaccess</var> context. This directive @@ -171,7 +171,7 @@ AuthnCacheSOCache dbm </table> <p>This directive specifies an authentication provider or providers to cache for. Credentials found by a provider not listed in an - AuthnCacheProvideFor directive will not be cached.</p> + <code class="directive">AuthnCacheProvideFor</code> directive will not be cached.</p> <p>For example, to cache credentials found by <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code> or by a custom provider <var>myprovider</var>, but leave those looked @@ -204,14 +204,14 @@ Apache HTTP Server 2.4.7 and later</td></tr> <table class="directive"> <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set a timeout for cache entries</td></tr> <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthnCacheTimeout <var>timeout</var> (seconds)</code></td></tr> -<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>300 (5 minutes)</code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthnCacheTimeout 300 (5 minutes)</code></td></tr> <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_socache</td></tr> </table> - <p>Cacheing authentication data can be a security issue, though short-term - cacheing is unlikely to be a problem. Typically a good solution is to + <p>Caching authentication data can be a security issue, though short-term + caching is unlikely to be a problem. Typically a good solution is to cache credentials for as long as it takes to relieve the load on a backend, but no longer, though if changes to your users and passwords are infrequent then a longer timeout may suit you. The default 300 @@ -227,8 +227,8 @@ Apache HTTP Server 2.4.7 and later</td></tr> </div> <div class="bottomlang"> <p><span>Available Languages: </span><a href="../en/mod/mod_authn_socache.html" title="English"> en </a> | -<a href="../fr/mod/mod_authn_socache.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> -</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&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> +<a href="../fr/mod/mod_authn_socache.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p> +</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&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div> <script type="text/javascript"><!--//--><![CDATA[//><!-- var comments_shortname = 'httpd'; var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_authn_socache.html'; @@ -246,7 +246,7 @@ var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_authn_socach } })(window, document); //--><!]]></script></div><div id="footer"> -<p class="apache">Copyright 2019 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> +<p class="apache">Copyright 2024 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> <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!-- if (typeof(prettyPrint) !== 'undefined') { prettyPrint(); |