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