]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_authn_anon.html.en
fix transformation
[apache] / docs / manual / mod / mod_authn_anon.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_authn_anon - 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.3</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/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
21 <div id="page-content">
22 <div id="preamble"><h1>Apache Module mod_authn_anon</h1>
23 <div class="toplang">
24 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_anon.html" title="English">&nbsp;en&nbsp;</a> |
25 <a href="../ja/mod/mod_authn_anon.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
26 <a href="../ko/mod/mod_authn_anon.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
27 </div>
28 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Allows "anonymous" user access to authenticated
29     areas</td></tr>
30 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
31 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_anon_module</td></tr>
32 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_anon.c</td></tr>
33 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
34 <h3>Summary</h3>
35
36     <p>This module provides authentication front-ends such as
37     <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> to authenticate users similar
38     to anonymous-ftp sites, <em>i.e.</em> have a 'magic' user id
39     'anonymous' and the email address as a password. These email
40     addresses can be logged.</p>
41
42     <p>Combined with other (database) access control methods, this
43     allows for effective user tracking and customization according
44     to a user profile while still keeping the site open for
45     'unregistered' users. One advantage of using Auth-based user
46     tracking is that, unlike magic-cookies and funny URL
47     pre/postfixes, it is completely browser independent and it
48     allows users to share URLs.</p>
49
50     <p>When using <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code>, this module is invoked
51     via the <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code>
52     directive with the <code>anon</code> value.</p>
53 </div>
54 <div id="quickview"><h3 class="directives">Directives</h3>
55 <ul id="toc">
56 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous">Anonymous</a></li>
57 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_logemail">Anonymous_LogEmail</a></li>
58 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a></li>
59 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_nouserid">Anonymous_NoUserID</a></li>
60 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_verifyemail">Anonymous_VerifyEmail</a></li>
61 </ul>
62 <h3>Topics</h3>
63 <ul id="topics">
64 <li><img alt="" src="../images/down.gif" /> <a href="#example">Example</a></li>
65 </ul></div>
66 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
67 <div class="section">
68 <h2><a name="example" id="example">Example</a></h2>
69     <p>The example below is combined with "normal" htpasswd-file based
70     authentication and allows users in additionally as 'guests' with the
71     following properties:</p>
72
73     <ul>
74       <li>It insists that the user enters a userID.
75       (<code class="directive"><a href="#anonymous_nouserid">Anonymous_NoUserID</a></code>)</li>
76
77       <li>It insists that the user enters a password.
78       (<code class="directive"><a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a></code>)</li>
79
80       <li>The password entered must be a valid email address, <em>i.e.</em>
81       contain at least one '@' and a '.'.
82       (<code class="directive"><a href="#anonymous_verifyemail">Anonymous_VerifyEmail</a></code>)</li>
83
84       <li>The userID must be one of <code>anonymous guest www test
85       welcome</code> and comparison is <strong>not</strong> case
86       sensitive. (<code class="directive"><a href="#anonymous">Anonymous</a></code>)</li>
87
88       <li>And the Email addresses entered in the passwd field are
89       logged to the error log file.
90       (<code class="directive"><a href="#anonymous_logemail">Anonymous_LogEmail</a></code>)</li>
91     </ul>
92
93     <div class="example"><h3>Example</h3><p><code>
94       &lt;Directory /foo&gt;
95       <span class="indent">
96         AuthName "Use 'anonymous' &amp; Email address for guest entry"<br />
97         AuthType Basic<br />
98         AuthBasicProvider file anon<br />
99         AuthUserFile /path/to/your/.htpasswd<br />
100         <br />
101         Anonymous_NoUserID off<br />
102         Anonymous_MustGiveEmail on<br />
103         Anonymous_VerifyEmail on<br />
104         Anonymous_LogEmail on<br />
105         Anonymous anonymous guest www test welcome<br />
106         <br />
107         Order Deny,Allow<br />
108         Allow from all<br />
109         <br />
110         Require valid-user<br />
111       </span>
112       &lt;/Directory&gt;
113     </code></p></div>
114 </div>
115 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
116 <div class="directive-section"><h2><a name="Anonymous" id="Anonymous">Anonymous</a> <a name="anonymous" id="anonymous">Directive</a></h2>
117 <table class="directive">
118 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies userIDs that are allowed access without
119 password verification</td></tr>
120 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous <var>user</var> [<var>user</var>] ...</code></td></tr>
121 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
122 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
123 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
124 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
125 </table>
126     <p>A list of one or more 'magic' userIDs which are allowed
127     access without password verification. The userIDs are space
128     separated. It is possible to use the ' and " quotes to allow a
129     space in a userID as well as the \ escape character.</p>
130
131     <p>Please note that the comparison is
132     <strong>case-IN-sensitive</strong>.<br />
133     It's strongly recommended that the magic username
134     '<code>anonymous</code>' is always one of the allowed
135     userIDs.</p>
136
137     <div class="example"><h3>Example:</h3><p><code>
138       Anonymous anonymous "Not Registered" "I don't know"
139     </code></p></div>
140
141     <p>This would allow the user to enter without password
142     verification by using the userIDs "anonymous",
143     "AnonyMous", "Not Registered" and "I Don't Know".</p>
144
145     <p>As of Apache 2.1 it is possible to specify the userID as
146     "<code>*</code>". That allows <em>any</em> supplied userID to be
147     accepted.</p>
148
149 </div>
150 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
151 <div class="directive-section"><h2><a name="Anonymous_LogEmail" id="Anonymous_LogEmail">Anonymous_LogEmail</a> <a name="anonymous_logemail" id="anonymous_logemail">Directive</a></h2>
152 <table class="directive">
153 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether the password entered will be logged in the
154 error log</td></tr>
155 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_LogEmail On|Off</code></td></tr>
156 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_LogEmail On</code></td></tr>
157 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
158 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
159 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
160 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
161 </table>
162     <p>When set <code>On</code>, the default, the 'password' entered
163     (which hopefully contains a sensible email address) is logged in
164     the error log.</p>
165
166 </div>
167 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
168 <div class="directive-section"><h2><a name="Anonymous_MustGiveEmail" id="Anonymous_MustGiveEmail">Anonymous_MustGiveEmail</a> <a name="anonymous_mustgiveemail" id="anonymous_mustgiveemail">Directive</a></h2>
169 <table class="directive">
170 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies whether blank passwords are allowed</td></tr>
171 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_MustGiveEmail On|Off</code></td></tr>
172 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_MustGiveEmail On</code></td></tr>
173 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
174 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
175 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
176 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
177 </table>
178     <p>Specifies whether the user must specify an email address as
179     the password. This prohibits blank passwords.</p>
180
181 </div>
182 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
183 <div class="directive-section"><h2><a name="Anonymous_NoUserID" id="Anonymous_NoUserID">Anonymous_NoUserID</a> <a name="anonymous_nouserid" id="anonymous_nouserid">Directive</a></h2>
184 <table class="directive">
185 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether the userID field may be empty</td></tr>
186 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_NoUserID On|Off</code></td></tr>
187 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_NoUserID Off</code></td></tr>
188 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
189 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
190 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
191 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
192 </table>
193     <p>When set <code>On</code>, users can leave the userID (and
194     perhaps the password field) empty. This can be very convenient for
195     MS-Explorer users who can just hit return or click directly on the
196     OK button; which seems a natural reaction.</p>
197
198 </div>
199 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
200 <div class="directive-section"><h2><a name="Anonymous_VerifyEmail" id="Anonymous_VerifyEmail">Anonymous_VerifyEmail</a> <a name="anonymous_verifyemail" id="anonymous_verifyemail">Directive</a></h2>
201 <table class="directive">
202 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether to check the password field for a correctly
203 formatted email address</td></tr>
204 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_VerifyEmail On|Off</code></td></tr>
205 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_VerifyEmail Off</code></td></tr>
206 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
207 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
208 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
209 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
210 </table>
211     <p>When set <code>On</code> the 'password' entered is checked for
212     at least one '@' and a '.' to encourage users to enter valid email
213     addresses (see the above <code class="directive"><a href="#anonymous_logemail">Anonymous_LogEmail</a></code>).</p>
214
215 </div>
216 </div>
217 <div class="bottomlang">
218 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_anon.html" title="English">&nbsp;en&nbsp;</a> |
219 <a href="../ja/mod/mod_authn_anon.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
220 <a href="../ko/mod/mod_authn_anon.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
221 </div><div id="footer">
222 <p class="apache">Copyright 2006 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>
223 <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>
224 </body></html>