mirror of
https://github.com/apache/httpd.git
synced 2025-04-26 12:28:56 +03:00
bc06af4721
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1891400 13f79535-47bb-0310-9956-ffa450edef68
281 lines
17 KiB
XML
281 lines
17 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
|
||
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
||
<!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_authn_core - Apache HTTP Server Version 2.5</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" />
|
||
<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" />
|
||
<script src="../style/scripts/prettify.min.js" type="text/javascript">
|
||
</script>
|
||
|
||
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
|
||
<body>
|
||
<div id="page-header">
|
||
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
|
||
<p class="apache">Apache HTTP Server Version 2.5</p>
|
||
<img alt="" src="../images/feather.png" /></div>
|
||
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
||
<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.5</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> |
|
||
<a href="../fr/mod/mod_authn_core.html" hreflang="fr" rel="alternate" title="Français"> fr </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#Status">Status:</a></th><td>Base</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#SourceFile">Source File:</a></th><td>mod_authn_core.c</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>Topics</h3>
|
||
<ul id="topics">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#authnalias">Creating Authentication Provider Aliases</a></li>
|
||
</ul><h3 class="directives">Directives</h3>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#authname">AuthName</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#authnprovideralias"><AuthnProviderAlias></a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#authtype">AuthType</a></li>
|
||
</ul>
|
||
<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_authn_core">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_authn_core">Report a bug</a></li></ul><h3>See also</h3>
|
||
<ul class="seealso">
|
||
<li><a href="#comments_section">Comments</a></li></ul></div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="authnalias" id="authnalias">Creating Authentication Provider Aliases</a> <a title="Permanent link" href="#authnalias" class="permalink">¶</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">Examples</a></h3>
|
||
|
||
<p>This example checks for passwords in two different text
|
||
files.</p>
|
||
|
||
<div class="example"><h3>Checking multiple text password files</h3><pre class="prettyprint lang-config"># Check here first
|
||
<AuthnProviderAlias file file1>
|
||
AuthUserFile "/www/conf/passwords1"
|
||
</AuthnProviderAlias>
|
||
|
||
# Then check here
|
||
<AuthnProviderAlias file file2>
|
||
AuthUserFile "/www/conf/passwords2"
|
||
</AuthnProviderAlias>
|
||
|
||
<Directory "/var/web/pages/secure">
|
||
AuthBasicProvider file1 file2
|
||
|
||
AuthType Basic
|
||
AuthName "Protected Area"
|
||
Require valid-user
|
||
</Directory></pre>
|
||
</div>
|
||
|
||
<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>Checking multiple LDAP servers</h3><pre class="prettyprint lang-config"><AuthnProviderAlias ldap ldap-alias1>
|
||
AuthLDAPBindDN "cn=youruser,o=ctx"
|
||
AuthLDAPBindPassword yourpassword
|
||
AuthLDAPURL "ldap://ldap.host/o=ctx"
|
||
</AuthnProviderAlias>
|
||
<AuthnProviderAlias ldap ldap-other-alias>
|
||
AuthLDAPBindDN "cn=yourotheruser,o=dev"
|
||
AuthLDAPBindPassword yourotherpassword
|
||
AuthLDAPURL "ldap://other.ldap.host/o=dev?cn"
|
||
</AuthnProviderAlias>
|
||
|
||
Alias "/secure" "/webpages/secure"
|
||
<Directory "/webpages/secure">
|
||
AuthBasicProvider ldap-other-alias ldap-alias1
|
||
|
||
AuthType Basic
|
||
AuthName "LDAP Protected Place"
|
||
Require valid-user
|
||
# Note that Require ldap-* would not work here, since the
|
||
# AuthnProviderAlias does not provide the config to authorization providers
|
||
# that are implemented in the same module as the authentication provider.
|
||
</Directory></pre>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="AuthName" id="AuthName">AuthName</a> <a name="authname" id="authname">Directive</a> <a title="Permanent link" href="#authname" class="permalink">¶</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>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_core</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>
|
||
|
||
<pre class="prettyprint lang-config">AuthName "Top Secret"</pre>
|
||
|
||
|
||
<p>The string provided for the <code>AuthName</code> is what will
|
||
appear in the password dialog provided by most browsers.</p>
|
||
|
||
<p>From 2.5.0, <a href="../expr.html">expression syntax</a> can be
|
||
used inside the directive to produce the name dynamically.</p>
|
||
|
||
<p>For example:</p>
|
||
|
||
<pre class="prettyprint lang-config">AuthName "%{HTTP_HOST}"</pre>
|
||
|
||
|
||
|
||
<h3>See also</h3>
|
||
<ul>
|
||
<li><a href="../howto/auth.html">Authentication, Authorization, and
|
||
Access Control</a></li>
|
||
<li><code class="module"><a href="../mod/mod_authz_core.html">mod_authz_core</a></code></li>
|
||
</ul>
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="AuthnProviderAlias" id="AuthnProviderAlias"><AuthnProviderAlias></a> <a name="authnprovideralias" id="authnprovideralias">Directive</a> <a title="Permanent link" href="#authnprovideralias" class="permalink">¶</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>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_core</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 class="note">This directive has no affect on authorization, even for modules that
|
||
provide both authentication and authorization.</div>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="AuthType" id="AuthType">AuthType</a> <a name="authtype" id="authtype">Directive</a> <a title="Permanent link" href="#authtype" class="permalink">¶</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>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_core</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
|
||
as <code class="module"><a href="../mod/mod_authz_user.html">mod_authz_user</a></code>.</p>
|
||
|
||
<p>The authentication type <code>None</code> disables authentication.
|
||
When authentication is enabled, it is normally inherited by each
|
||
subsequent <a href="../sections.html#mergin">configuration section</a>,
|
||
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
|
||
<code>/www/docs/public</code> directory without authenticating:</p>
|
||
|
||
<pre class="prettyprint lang-config"><Directory "/www/docs">
|
||
AuthType Basic
|
||
AuthName Documents
|
||
AuthBasicProvider file
|
||
AuthUserFile "/usr/local/apache/passwd/passwords"
|
||
Require valid-user
|
||
</Directory>
|
||
|
||
<Directory "/www/docs/public">
|
||
AuthType None
|
||
Require all granted
|
||
</Directory></pre>
|
||
|
||
|
||
<p>From 2.5.0, <a href="../expr.html">expression syntax</a> can be
|
||
used inside the directive to specify the type dynamically.</p>
|
||
|
||
<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>
|
||
<li><a href="../howto/auth.html">Authentication, Authorization,
|
||
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> |
|
||
<a href="../fr/mod/mod_authn_core.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
|
||
</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 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
|
||
<script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
var comments_shortname = 'httpd';
|
||
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authn_core.html';
|
||
(function(w, d) {
|
||
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
|
||
d.write('<div id="comments_thread"><\/div>');
|
||
var s = d.createElement('script');
|
||
s.type = 'text/javascript';
|
||
s.async = true;
|
||
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
|
||
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
|
||
}
|
||
else {
|
||
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
|
||
}
|
||
})(window, document);
|
||
//--><!]]></script></div><div id="footer">
|
||
<p class="apache">Copyright 2021 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/quickreference.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[//><!--
|
||
if (typeof(prettyPrint) !== 'undefined') {
|
||
prettyPrint();
|
||
}
|
||
//--><!]]></script>
|
||
</body></html> |