1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->
<!--
Copyright 2002-2005 The Apache Software Foundation or its licensors, as
applicable.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<modulesynopsis metafile="mod_authn_core.xml.meta">
<name>mod_authn_core</name>
<description>Core Authentication</description>
<status>Base</status>
<sourcefile>mod_authn_core.c</sourcefile>
<identifier>authn_core_module</identifier>
<compatibility>Available in Apache 2.3 and later</compatibility>
<summary>
<p>This module provides core authentication capabilities to
allow or deny access to portions of the web site.
<module>mod_authn_core</module> provides directives that are
common to all authentication providers.</p>
</summary>
<directivesynopsis>
<name>AuthName</name>
<description>Authorization realm for use in HTTP
authentication</description>
<syntax>AuthName <var>auth-domain</var></syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
<usage>
<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.
<directive>AuthName</directive> takes a single argument; if the
realm name contains spaces, it must be enclosed in quotation
marks. It must be accompanied by <directive
module="mod_authn_core">AuthType</directive> and <directive
module="mod_authz_core">Require</directive> directives, and directives such
as <directive module="mod_authn_file">AuthUserFile</directive> and
<directive module="mod_authz_groupfile">AuthGroupFile</directive> to
work.</p>
<p>For example:</p>
<example>
AuthName "Top Secret"
</example>
<p>The string provided for the <code>AuthName</code> is what will
appear in the password dialog provided by most browsers.</p>
</usage>
<seealso><a
href="../howto/auth.html">Authentication, Authorization, and
Access Control</a></seealso>
</directivesynopsis>
<directivesynopsis>
<name>AuthType</name>
<description>Type of user authentication</description>
<syntax>AuthType Basic|Digest</syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<override>AuthConfig</override>
<usage>
<p>This directive selects the type of user authentication for a
directory. The authentication types available are
<code>Basic</code> (implemented by
<module>mod_auth_basic</module>) and <code>Digest</code>
(implemented by <module>mod_auth_digest</module>).</p>
<p>To implement authentication, you must also use the <directive
module="mod_authn_core">AuthName</directive> and <directive
module="mod_authz_core">Require</directive> directives. In addition, the
server must have an authentication-provider module such as
<module>mod_authn_file</module> and an authorization module such
as <module>mod_authz_user</module>.</p>
</usage>
<seealso><a href="../howto/auth.html">Authentication, Authorization,
and Access Control</a></seealso>
</directivesynopsis>
</modulesynopsis>
|
