github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_auth_basic.html.en (about) 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_auth_basic - Apache HTTP Server Version 2.2</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" /><link href="http://httpd.apache.org/docs/current/mod/mod_auth_basic.html" rel="canonical" /></head> 18 <body> 19 <div id="page-header"> 20 <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> 21 <p class="apache">Apache HTTP Server Version 2.2</p> 22 <img alt="" src="../images/feather.gif" /></div> 23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> 24 <div id="path"> 25 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> 26 <div id="page-content"> 27 <div class="retired"><h4>Please note</h4> 28 <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p> 29 <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_auth_basic.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_auth_basic</h1> 30 <div class="toplang"> 31 <p><span>Available Languages: </span><a href="../en/mod/mod_auth_basic.html" title="English"> en </a> | 32 <a href="../fr/mod/mod_auth_basic.html" hreflang="fr" rel="alternate" title="Français"> fr </a> | 33 <a href="../ja/mod/mod_auth_basic.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 34 <a href="../ko/mod/mod_auth_basic.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 35 </div> 36 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Basic authentication</td></tr> 37 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> 38 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>auth_basic_module</td></tr> 39 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_auth_basic.c</td></tr> 40 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table> 41 <h3>Summary</h3> 42 43 <p>This module allows the use of HTTP Basic Authentication to 44 restrict access by looking up users in the given providers. 45 HTTP Digest Authentication is provided by 46 <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>. This module should 47 usually be combined with at least one authentication module 48 such as <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> and one authorization 49 module such as <code class="module"><a href="../mod/mod_authz_user.html">mod_authz_user</a></code>.</p> 50 </div> 51 <div id="quickview"><h3 class="directives">Directives</h3> 52 <ul id="toc"> 53 <li><img alt="" src="../images/down.gif" /> <a href="#authbasicauthoritative">AuthBasicAuthoritative</a></li> 54 <li><img alt="" src="../images/down.gif" /> <a href="#authbasicprovider">AuthBasicProvider</a></li> 55 </ul> 56 <h3>See also</h3> 57 <ul class="seealso"> 58 <li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li> 59 <li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li> 60 <li><code class="directive"><a href="../mod/core.html#require">Require</a></code></li> 61 <li><code class="directive"><a href="../mod/core.html#satisfy">Satisfy</a></code></li> 62 <li><a href="../howto/auth.html">Authentication howto</a></li> 63 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 64 65 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 66 <div class="directive-section"><h2><a name="AuthBasicAuthoritative" id="AuthBasicAuthoritative">AuthBasicAuthoritative</a> <a name="authbasicauthoritative" id="authbasicauthoritative">Directive</a></h2> 67 <table class="directive"> 68 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization and authentication are passed to 69 lower level modules</td></tr> 70 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBasicAuthoritative On|Off</code></td></tr> 71 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBasicAuthoritative On</code></td></tr> 72 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 73 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 74 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 75 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_basic</td></tr> 76 </table> 77 <p>Normally, each authorization module listed in <code class="directive"><a href="#authbasicprovider">AuthBasicProvider</a></code> will attempt 78 to verify the user, and if the user is not found in any provider, 79 access will be denied. Setting the 80 <code class="directive">AuthBasicAuthoritative</code> directive explicitly 81 to <code>Off</code> allows for both authentication and 82 authorization to be passed on to other non-provider-based modules 83 if there is <strong>no userID</strong> or <strong>rule</strong> 84 matching the supplied userID. This should only be necessary when 85 combining <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> with third-party modules 86 that are not configured with the <code class="directive"><a href="#authbasicprovider">AuthBasicProvider</a></code> 87 directive. When using such modules, the order of processing 88 is determined in the modules' source code and is not configurable.</p> 89 90 </div> 91 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 92 <div class="directive-section"><h2><a name="AuthBasicProvider" id="AuthBasicProvider">AuthBasicProvider</a> <a name="authbasicprovider" id="authbasicprovider">Directive</a></h2> 93 <table class="directive"> 94 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the authentication provider(s) for this location</td></tr> 95 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBasicProvider <var>provider-name</var> 96 [<var>provider-name</var>] ...</code></td></tr> 97 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBasicProvider file</code></td></tr> 98 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 99 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 100 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 101 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_basic</td></tr> 102 </table> 103 <p>The <code class="directive">AuthBasicProvider</code> directive sets 104 which provider is used to authenticate the users for this location. 105 The default <code>file</code> provider is implemented 106 by the <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> module. Make sure 107 that the chosen provider module is present in the server.</p> 108 109 <div class="example"><h3>Example</h3><p><code> 110 <Location /secure><br /> 111 <span class="indent"> 112 AuthType basic<br /> 113 AuthName "private area"<br /> 114 AuthBasicProvider dbm<br /> 115 AuthDBMType SDBM<br /> 116 AuthDBMUserFile /www/etc/dbmpasswd<br /> 117 Require valid-user<br /> 118 </span> 119 </Location> 120 </code></p></div> 121 122 <p> Providers are queried in order until a provider finds a match 123 for the requested username, at which point this sole provider will 124 attempt to check the password. A failure to verify the password does 125 not result in control being passed on to subsequent providers.</p> 126 127 <p>Providers are implemented by <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>, 128 <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>, <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code>, 129 and <code class="module"><a href="../mod/mod_authnz_ldap.html">mod_authnz_ldap</a></code>.</p> 130 131 </div> 132 </div> 133 <div class="bottomlang"> 134 <p><span>Available Languages: </span><a href="../en/mod/mod_auth_basic.html" title="English"> en </a> | 135 <a href="../fr/mod/mod_auth_basic.html" hreflang="fr" rel="alternate" title="Français"> fr </a> | 136 <a href="../ja/mod/mod_auth_basic.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 137 <a href="../ko/mod/mod_auth_basic.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 138 </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> 139 <script type="text/javascript"><!--//--><![CDATA[//><!-- 140 var comments_shortname = 'httpd'; 141 var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_auth_basic.html'; 142 (function(w, d) { 143 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 144 d.write('<div id="comments_thread"><\/div>'); 145 var s = d.createElement('script'); 146 s.type = 'text/javascript'; 147 s.async = true; 148 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 149 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 150 } 151 else { 152 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 153 } 154 })(window, document); 155 //--><!]]></script></div><div id="footer"> 156 <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> 157 <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[//><!-- 158 if (typeof(prettyPrint) !== 'undefined') { 159 prettyPrint(); 160 } 161 //--><!]]></script> 162 </body></html>