mod_authn_core.html.en revision 08cf4a15275e4cb65a424b3a1db5410bfb51085c
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_authn_core - Apache HTTP Server</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<body>
<div id="page-header">
<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>
<p class="apache">Apache HTTP Server Version 2.3</p>
<div id="path">
<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.3</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_authn_core</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="/en/mod/mod_authn_core.html" title="English"> en </a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Authentication</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>authn_core_module</td></tr>
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3 and later</td></tr></table>
<h3>Summary</h3>
<p>This module provides core authentication capabilities to
allow or deny access to portions of the web site.
<code class="module"><a href="/mod/mod_authn_core.html">mod_authn_core</a></code> provides directives that are
common to all authentication providers.</p>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="/images/down.gif" /> <a href="#authnprovideralias"><AuthnProviderAlias></a></li>
</ul>
<h3>Topics</h3>
<ul id="topics">
<li><img alt="" src="/images/down.gif" /> <a href="#authnalias">Creating Authentication Provider Aliases</a></li>
</ul></div>
<div class="section">
<h2><a name="authnalias" id="authnalias">Creating Authentication Provider Aliases</a></h2>
<p>Extended authentication providers can be created
within the configuration file and assigned an alias name. The alias
providers can then be referenced through the directives
<code class="directive"><a href="/mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or
<code class="directive"><a href="/mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> in
the same way as a base authentication provider. Besides the ability
to create and alias an extended provider, it also allows the same
extended authentication provider to be reference by multiple
locations.</p>
<h3><a name="example" id="example">Example</a></h3>
<p>The example below creates two different ldap authentication
provider aliases based on the ldap provider. This allows
a single authenticated location to be serviced by multiple ldap
hosts:</p>
<div class="example"><h3>Example</h3><p><code>
<AuthnProviderAlias ldap ldap-alias1><br />
<span class="indent">
AuthLDAPBindDN cn=youruser,o=ctx<br />
AuthLDAPBindPassword yourpassword<br />
AuthLDAPURL ldap://ldap.host/o=ctx<br />
</span>
</AuthnProviderAlias><br /><br />
<AuthnProviderAlias ldap ldap-other-alias><br />
<span class="indent">
AuthLDAPBindDN cn=yourotheruser,o=dev<br />
AuthLDAPBindPassword yourotherpassword<br />
AuthLDAPURL ldap://other.ldap.host/o=dev?cn<br />
</span>
</AuthnProviderAlias><br /><br />
<span class="indent">
Order deny,allow<br />
Allow from all<br /><br />
AuthBasicProvider ldap-other-alias ldap-alias1<br /><br />
AuthType Basic<br />
AuthName LDAP_Protected_Place<br />
Require valid-user<br />
</span>
</Directory><br />
</code></p></div>
</div>
<div class="directive-section"><h2><a name="AuthName" id="AuthName">AuthName</a> <a name="authname" id="authname">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Authorization realm for use in HTTP
authentication</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthName <var>auth-domain</var></code></td></tr>
</table>
<p>This directive sets the name of the authorization realm for a
directory. This realm is given to the client so that the user
knows which username and password to send.
<code class="directive">AuthName</code> takes a single argument; if the
realm name contains spaces, it must be enclosed in quotation
marks. It must be accompanied by <code class="directive"><a href="#authtype">AuthType</a></code> and <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directives, and directives such
as <code class="directive"><a href="/mod/mod_authn_file.html#authuserfile">AuthUserFile</a></code> and
<code class="directive"><a href="/mod/mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></code> to
work.</p>
<p>For example:</p>
<div class="example"><p><code>
AuthName "Top Secret"
</code></p></div>
<p>The string provided for the <code>AuthName</code> is what will
appear in the password dialog provided by most browsers.</p>
<h3>See also</h3>
<ul>
Access Control</a></li>
</ul>
</div>
<div class="directive-section"><h2><a name="AuthnProviderAlias" id="AuthnProviderAlias"><AuthnProviderAlias></a> <a name="authnprovideralias" id="authnprovideralias">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that represent an
extension of a base authentication provider and referenced by
the specified alias</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><AuthnProviderAlias <var>baseProvider Alias</var>>
... </AuthnProviderAlias></code></td></tr>
</table>
<p><code><AuthnProviderAlias></code> and
<code></AuthnProviderAlias></code> are used to enclose a group of
authentication directives that can be referenced by the alias name
using one of the directives <code class="directive"><a href="/mod/mod_auth_basic.html# authbasicprovider">
AuthBasicProvider</a></code> or <code class="directive"><a href="/mod/mod_auth_digest.html# authdigestprovider">
AuthDigestProvider</a></code>.</p>
</div>
<div class="directive-section"><h2><a name="AuthType" id="AuthType">AuthType</a> <a name="authtype" id="authtype">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Type of user authentication</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthType None|Basic|Digest|Form</code></td></tr>
</table>
<p>This directive selects the type of user authentication for a
directory. The authentication types available are <code>None</code>,
<code>Basic</code> (implemented by
<code class="module"><a href="/mod/mod_auth_basic.html">mod_auth_basic</a></code>), <code>Digest</code>
(implemented by <code class="module"><a href="/mod/mod_auth_digest.html">mod_auth_digest</a></code>), and
<code>Form</code> (implemented by <code class="module"><a href="/mod/mod_auth_form.html">mod_auth_form</a></code>).</p>
<p>To implement authentication, you must also use the <code class="directive"><a href="#authname">AuthName</a></code> and <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> directives. In addition, the
server must have an authentication-provider module such as
<code class="module"><a href="/mod/mod_authn_file.html">mod_authn_file</a></code> and an authorization module such
<p>The authentication type <code>None</code> disables authentication.
When authentication is enabled, it is normally inherited by each
unless a different authentication type is specified. If no
authentication is desired for a subsection of an authenticated
section, the authentication type <code>None</code> may be used;
in the following example, clients may access the
<div class="example"><p><code>
<span class="indent">
AuthType Basic<br />
AuthName Documents<br />
AuthBasicProvider file<br />
Require valid-user
</span>
</Directory><br />
<br />
<span class="indent">
AuthType None<br />
Require all granted
</span>
</Directory>
</code></p></div>
<div class="note">When disabling authentication, note that clients which have
already authenticated against another portion of the server's document
tree will typically continue to send authentication HTTP headers
or cookies with each request, regardless of whether the server
actually requires authentication for every resource.</div>
<h3>See also</h3>
<ul>
and Access Control</a></li>
</ul>
</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/mod/mod_authn_core.html" title="English"> en </a></p>
</div><div id="footer">
<p class="apache">Copyright 2008 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>
<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>
</body></html>