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