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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_auth_basic</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_auth_basic.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ja/mod/mod_auth_basic.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Basic authentication</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>auth_basic_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_auth_basic.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module allows the use of HTTP Basic Authentication to
  35     restrict access by looking up users in the given providers.
  36     HTTP Digest Authentication is provided by
  37     <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>.</p>
  38 </div>
  39 <div id="quickview"><h3 class="directives">Directives</h3>
  40 <ul id="toc">
  41 <li><img alt="" src="../images/down.gif" /> <a href="#authbasicauthoritative">AuthBasicAuthoritative</a></li>
  42 <li><img alt="" src="../images/down.gif" /> <a href="#authbasicprovider">AuthBasicProvider</a></li>
  43 </ul>
  44 <h3>See also</h3>
  45 <ul class="seealso">
  46 <li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li>
  47 <li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li>
  48 </ul></div>
  49
  50 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  51 <div class="directive-section"><h2><a name="AuthBasicAuthoritative" id="AuthBasicAuthoritative">AuthBasicAuthoritative</a> <a name="authbasicauthoritative" id="authbasicauthoritative">Directive</a></h2>
  52 <table class="directive">
  53 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization and authentication are passed to
  54 lower level modules</td></tr>
  55 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBasicAuthoritative On|Off</code></td></tr>
  56 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBasicAuthoritative On</code></td></tr>
  57 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  58 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  59 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  60 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_basic</td></tr>
  61 </table>
  62     <p>Setting the <code class="directive">AuthBasicAuthoritative</code> directive
  63     explicitly to <code>Off</code> allows for both
  64     authentication and authorization to be passed on to lower level
  65     modules (as defined in the <code>modules.c</code> files) if there is
  66     <strong>no userID</strong> or <strong>rule</strong> matching the
  67     supplied userID. If there is a userID and/or rule specified, the usual
  68     password and access checks will be applied and a failure will give
  69     an "Authentication Required" reply.</p>
  70
  71     <p>So if a userID appears in the database of more than one module;
  72     or if a valid <code class="directive"><a href="../mod/core.html#require">Require</a></code>
  73     directive applies to more than one module; then the first module
  74     will verify the credentials; and no access is passed on;
  75     regardless of the <code class="directive">AuthBasicAuthoritative</code>
  76     setting.</p>
  77
  78     <p>By default control is not passed on and an unknown userID or
  79     rule will result in an "Authentication Required" reply. Not setting
  80     it thus keeps the system secure and forces an NCSA compliant
  81     behaviour.</p>
  82
  83 </div>
  84 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  85 <div class="directive-section"><h2><a name="AuthBasicProvider" id="AuthBasicProvider">AuthBasicProvider</a> <a name="authbasicprovider" id="authbasicprovider">Directive</a></h2>
  86 <table class="directive">
  87 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the authentication provider(s) for this location</td></tr>
  88 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBasicProvider On|Off|<var>provider-name</var>
  89 [<var>provider-name</var>] ...</code></td></tr>
  90 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBasicProvider On</code></td></tr>
  91 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  92 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  93 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  94 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_basic</td></tr>
  95 </table>
  96     <p>The <code class="directive">AuthBasicProvider</code> directive sets
  97     which provider is used to authenticate the users for this location.
  98     Setting the value to <code>On</code> will choose the default provider
  99     (<code>file</code>). Since the <code>file</code> provider is implemented
 100     by the <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> module, you have to make sure,
 101     that the module is present in the server.</p>
 102
 103     <div class="example"><h3>Example</h3><p><code>
 104       &lt;Location /secure&gt;<br />
 105       <span class="indent">
 106         AuthBasicProvider  dbm<br />
 107         AuthDBMType        SDBM<br />
 108         AuthDBMUserFile    /www/etc/dbmpasswd<br />
 109         Require            valid-user<br />
 110       </span>
 111       &lt;/Location&gt;
 112     </code></p></div>
 113
 114     <p>See <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code> and <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>
 115     for providers.</p>
 116
 117     <p>The value <code>Off</code> clears the provider list and sets it back
 118     to the default.</p>
 119
 120 </div>
 121 </div>
 122 <div class="bottomlang">
 123 <p><span>Available Languages: </span><a href="../en/mod/mod_auth_basic.html" title="English">&nbsp;en&nbsp;</a> |
 124 <a href="../ja/mod/mod_auth_basic.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a></p>
 125 </div><div id="footer">
 126 <p class="apache">Copyright 1999-2004 The Apache Software Foundation</p>
 127 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 128 </body></html>