2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
4 <!-- $Revision: 1.11 $ -->
7 Copyright 2002-2004 The Apache Software Foundation
9 Licensed under the Apache License, Version 2.0 (the "License");
10 you may not use this file except in compliance with the License.
11 You may obtain a copy of the License at
13 http://www.apache.org/licenses/LICENSE-2.0
15 Unless required by applicable law or agreed to in writing, software
16 distributed under the License is distributed on an "AS IS" BASIS,
17 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 See the License for the specific language governing permissions and
19 limitations under the License.
22 <modulesynopsis metafile="mod_authn_anon.xml.meta">
24 <name>mod_authn_anon</name>
25 <description>Allows "anonymous" user access to authenticated
27 <status>Extension</status>
28 <sourcefile>mod_authn_anon.c</sourcefile>
29 <identifier>authn_anon_module</identifier>
30 <compatibility>Available in Apache 2.1 and later</compatibility>
33 <p>This module provides authentication front-ends such as
34 <module>mod_auth_basic</module> to authenticate users similar
35 to anonymous-ftp sites, <em>i.e.</em> have a 'magic' user id
36 'anonymous' and the email address as a password. These email
37 addresses can be logged.</p>
39 <p>Combined with other (database) access control methods, this
40 allows for effective user tracking and customization according
41 to a user profile while still keeping the site open for
42 'unregistered' users. One advantage of using Auth-based user
43 tracking is that, unlike magic-cookies and funny URL
44 pre/postfixes, it is completely browser independent and it
45 allows users to share URLs.</p>
47 <p>When using <module>mod_auth_basic</module>, this module is invoked
48 via the <directive module="mod_auth_basic">AuthBasicProvider</directive>
49 directive with the <code>anon</code> value.</p>
52 <section id="example"><title>Example</title>
53 <p>The example below is combined with "normal" htpasswd-file based
54 authentication and allows users in additionally as 'guests' with the
55 following properties:</p>
58 <li>It insists that the user enters a userID.
59 (<directive module="mod_authn_anon"
60 >Anonymous_NoUserID</directive>)</li>
62 <li>It insists that the user enters a password.
63 (<directive module="mod_authn_anon"
64 >Anonymous_MustGiveEmail</directive>)</li>
66 <li>The password entered must be a valid email address, <em>i.e.</em>
67 contain at least one '@' and a '.'.
68 (<directive module="mod_authn_anon"
69 >Anonymous_VerifyEmail</directive>)</li>
71 <li>The userID must be one of <code>anonymous guest www test
72 welcome</code> and comparison is <strong>not</strong> case
73 sensitive. (<directive module="mod_authn_anon"
74 >Anonymous</directive>)</li>
76 <li>And the Email addresses entered in the passwd field are
77 logged to the error log file.
78 (<directive module="mod_authn_anon"
79 >Anonymous_LogEmail</directive>)</li>
82 <example><title>Example</title>
83 <Directory /foo>
85 AuthName "Use 'anonymous' & Email address for guest entry"<br />
87 AuthBasicProvider file anon<br />
88 AuthUserFile /path/to/your/.htpasswd<br />
90 Anonymous_NoUserID off<br />
91 Anonymous_MustGiveEmail on<br />
92 Anonymous_VerifyEmail on<br />
93 Anonymous_LogEmail on<br />
94 Anonymous anonymous guest www test welcome<br />
96 Order Deny,Allow<br />
99 Require valid-user<br />
106 <name>Anonymous</name>
107 <description>Specifies userIDs that are allowed access without
108 password verification</description>
109 <syntax>Anonymous <var>user</var> [<var>user</var>] ...</syntax>
110 <contextlist><context>directory</context><context>.htaccess</context>
112 <override>AuthConfig</override>
115 <p>A list of one or more 'magic' userIDs which are allowed
116 access without password verification. The userIDs are space
117 separated. It is possible to use the ' and " quotes to allow a
118 space in a userID as well as the \ escape character.</p>
120 <p>Please note that the comparison is
121 <strong>case-IN-sensitive</strong>.<br />
122 It's strongly recommended that the magic username
123 '<code>anonymous</code>' is always one of the allowed
126 <example><title>Example:</title>
127 Anonymous anonymous "Not Registered" "I don't know"
130 <p>This would allow the user to enter without password
131 verification by using the userIDs "anonymous",
132 "AnonyMous", "Not Registered" and "I Don't Know".</p>
134 <p>As of Apache 2.1 it is possible to specify the userID as
135 "<code>*</code>". That allows <em>any</em> supplied userID to be
141 <name>Anonymous_LogEmail</name>
142 <description>Sets whether the password entered will be logged in the
143 error log</description>
144 <syntax>Anonymous_LogEmail On|Off</syntax>
145 <default>Anonymous_LogEmail On</default>
146 <contextlist><context>directory</context><context>.htaccess</context>
148 <override>AuthConfig</override>
151 <p>When set <code>On</code>, the default, the 'password' entered
152 (which hopefully contains a sensible email address) is logged in
158 <name>Anonymous_MustGiveEmail</name>
159 <description>Specifies whether blank passwords are allowed</description>
160 <syntax>Anonymous_MustGiveEmail On|Off</syntax>
161 <default>Anonymous_MustGiveEmail On</default>
162 <contextlist><context>directory</context><context>.htaccess</context>
164 <override>AuthConfig</override>
167 <p>Specifies whether the user must specify an email address as
168 the password. This prohibits blank passwords.</p>
173 <name>Anonymous_NoUserID</name>
174 <description>Sets whether the userID field may be empty</description>
175 <syntax>Anonymous_NoUserID On|Off</syntax>
176 <default>Anonymous_NoUserID Off</default>
177 <contextlist><context>directory</context><context>.htaccess</context>
179 <override>AuthConfig</override>
182 <p>When set <code>On</code>, users can leave the userID (and
183 perhaps the password field) empty. This can be very convenient for
184 MS-Explorer users who can just hit return or click directly on the
185 OK button; which seems a natural reaction.</p>
190 <name>Anonymous_VerifyEmail</name>
191 <description>Sets whether to check the password field for a correctly
192 formatted email address</description>
193 <syntax>Anonymous_VerifyEmail On|Off</syntax>
194 <default>Anonymous_VerifyEmail Off</default>
195 <contextlist><context>directory</context><context>.htaccess</context>
197 <override>AuthConfig</override>
200 <p>When set <code>On</code> the 'password' entered is checked for
201 at least one '@' and a '.' to encourage users to enter valid email
202 addresses (see the above <directive
203 module="mod_authn_anon">Anonymous_LogEmail</directive>).</p>