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.2</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<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> 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"> en </a> | 28<a href="/fr/mod/mod_auth_basic.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 29<a href="/ja/mod/mod_auth_basic.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 30<a href="/ko/mod/mod_auth_basic.html" hreflang="ko" rel="alternate" title="Korean"> ko </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/core.html#authname">AuthName</a></code></li> 55<li><code class="directive"><a href="/mod/core.html#authtype">AuthType</a></code></li> 56<li><code class="directive"><a href="/mod/core.html#require">Require</a></code></li> 57<li><code class="directive"><a href="/mod/core.html#satisfy">Satisfy</a></code></li> 58<li><a href="/howto/auth.html">Authentication howto</a></li> 59</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 60 61<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 62<div class="directive-section"><h2><a name="AuthBasicAuthoritative" id="AuthBasicAuthoritative">AuthBasicAuthoritative</a> <a name="authbasicauthoritative" id="authbasicauthoritative">Directive</a></h2> 63<table class="directive"> 64<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization and authentication are passed to 65lower level modules</td></tr> 66<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBasicAuthoritative On|Off</code></td></tr> 67<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBasicAuthoritative On</code></td></tr> 68<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 69<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 70<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 71<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_basic</td></tr> 72</table> 73 <p>Normally, each authorization module listed in <code class="directive"><a href="#authbasicprovider">AuthBasicProvider</a></code> will attempt 74 to verify the user, and if the user is not found in any provider, 75 access will be denied. Setting the 76 <code class="directive">AuthBasicAuthoritative</code> directive explicitly 77 to <code>Off</code> allows for both authentication and 78 authorization to be passed on to other non-provider-based modules 79 if there is <strong>no userID</strong> or <strong>rule</strong> 80 matching the supplied userID. This should only be necessary when 81 combining <code class="module"><a href="/mod/mod_auth_basic.html">mod_auth_basic</a></code> with third-party modules 82 that are not configured with the <code class="directive"><a href="#authbasicprovider">AuthBasicProvider</a></code> 83 directive. When using such modules, the order of processing 84 is determined in the modules' source code and is not configurable.</p> 85 86</div> 87<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 88<div class="directive-section"><h2><a name="AuthBasicProvider" id="AuthBasicProvider">AuthBasicProvider</a> <a name="authbasicprovider" id="authbasicprovider">Directive</a></h2> 89<table class="directive"> 90<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the authentication provider(s) for this location</td></tr> 91<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBasicProvider <var>provider-name</var> 92[<var>provider-name</var>] ...</code></td></tr> 93<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBasicProvider file</code></td></tr> 94<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 95<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 96<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 97<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_basic</td></tr> 98</table> 99 <p>The <code class="directive">AuthBasicProvider</code> directive sets 100 which provider is used to authenticate the users for this location. 101 The default <code>file</code> provider is implemented 102 by the <code class="module"><a href="/mod/mod_authn_file.html">mod_authn_file</a></code> module. Make sure 103 that the chosen provider module is present in the server.</p> 104 105 <div class="example"><h3>Example</h3><p><code> 106 <Location /secure><br /> 107 <span class="indent"> 108 AuthType basic<br /> 109 AuthName "private area"<br /> 110 AuthBasicProvider dbm<br /> 111 AuthDBMType SDBM<br /> 112 AuthDBMUserFile /www/etc/dbmpasswd<br /> 113 Require valid-user<br /> 114 </span> 115 </Location> 116 </code></p></div> 117 118 <p> Providers are queried in order until a provider finds a match 119 for the requested username, at which point this sole provider will 120 attempt to check the password. A failure to verify the password does 121 not result in control being passed on to subsequent providers.</p> 122 123 <p>Providers are implemented by <code class="module"><a href="/mod/mod_authn_dbm.html">mod_authn_dbm</a></code>, 124 <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>, 125 and <code class="module"><a href="/mod/mod_authnz_ldap.html">mod_authnz_ldap</a></code>.</p> 126 127</div> 128</div> 129<div class="bottomlang"> 130<p><span>Available Languages: </span><a href="/en/mod/mod_auth_basic.html" title="English"> en </a> | 131<a href="/fr/mod/mod_auth_basic.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 132<a href="/ja/mod/mod_auth_basic.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 133<a href="/ko/mod/mod_auth_basic.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 134</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> 135<script type="text/javascript"><!--//--><![CDATA[//><!-- 136var comments_shortname = 'httpd'; 137var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_auth_basic.html'; 138(function(w, d) { 139 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 140 d.write('<div id="comments_thread"><\/div>'); 141 var s = d.createElement('script'); 142 s.type = 'text/javascript'; 143 s.async = true; 144 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 145 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 146 } 147 else { 148 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 149 } 150})(window, document); 151//--><!]]></script></div><div id="footer"> 152<p class="apache">Copyright 2013 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> 153<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[//><!-- 154if (typeof(prettyPrint) !== 'undefined') { 155 prettyPrint(); 156} 157//--><!]]></script> 158</body></html>
