mod_auth_anon.html revision 1b55e9e0a3c5fb40d9e46d3e6f711516a9a807fa
b6c1232fd4529b7cb25d801404f6c440d549f311slive<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
b6c1232fd4529b7cb25d801404f6c440d549f311sliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
b6c1232fd4529b7cb25d801404f6c440d549f311slive This file is generated from xml source: DO NOT EDIT
b6c1232fd4529b7cb25d801404f6c440d549f311sliveXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
b6c1232fd4529b7cb25d801404f6c440d549f311slive--><title>mod_auth_anon - Apache HTTP Server</title><link href="/style/manual.css" type="text/css" rel="stylesheet"/></head><body><blockquote><div align="center"><img alt="[APACHE DOCUMENTATION]" src="/images/sub.gif"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_auth_anon</h1><table cellspacing="1" cellpadding="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td><description>Allows "anonymous" user access to authenticated
b6c1232fd4529b7cb25d801404f6c440d549f311slive areas</description></td></tr><tr><td><a href="module-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="module-dict.html#ModuleIdentifier" class="help">Module&nbsp;Identifier:</a></td><td>auth_anon_module</td></tr></table></td></tr></table><h2>Summary</h2><summary>
b6c1232fd4529b7cb25d801404f6c440d549f311slive <p>This module does access control in a manner similar to
b6c1232fd4529b7cb25d801404f6c440d549f311slive anonymous-ftp sites; <em>i.e.</em> have a 'magic' user id
b6c1232fd4529b7cb25d801404f6c440d549f311slive 'anonymous' and the email address as a password. These email
b6c1232fd4529b7cb25d801404f6c440d549f311slive addresses can be logged.</p>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive <p>Combined with other (database) access control methods, this
b6c1232fd4529b7cb25d801404f6c440d549f311slive allows for effective user tracking and customization according
b6c1232fd4529b7cb25d801404f6c440d549f311slive to a user profile while still keeping the site open for
b6c1232fd4529b7cb25d801404f6c440d549f311slive 'unregistered' users. One advantage of using Auth-based user
b6c1232fd4529b7cb25d801404f6c440d549f311slive tracking is that, unlike magic-cookies and funny URL
b6c1232fd4529b7cb25d801404f6c440d549f311slive pre/postfixes, it is completely browser independent and it
b6c1232fd4529b7cb25d801404f6c440d549f311slive allows users to share URLs.</p>
b6c1232fd4529b7cb25d801404f6c440d549f311slive</summary><h2>Directives</h2><ul><li><a href="#anonymous">Anonymous</a></li><li><a href="#anonymous_authoritative">Anonymous_Authoritative</a></li><li><a href="#anonymous_logemail">Anonymous_LogEmail</a></li><li><a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a></li><li><a href="#anonymous_nouserid">Anonymous_NoUserID</a></li><li><a href="#anonymous_verifyemail">Anonymous_VerifyEmail</a></li></ul><h2>Example</h2>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive <p>The example below (when combined with the Auth directives of a
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd htpasswd-file based (or GDM, mSQL <em>etc.</em>) base access
a78048ccbdb6256da15e6b0e7e95355e480c2301nd control system allows users in as 'guests' with the following
a78048ccbdb6256da15e6b0e7e95355e480c2301nd properties:</p>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd <ul>
b6c1232fd4529b7cb25d801404f6c440d549f311slive <li>It insists that the user enters a userId.
b6c1232fd4529b7cb25d801404f6c440d549f311slive (<code>Anonymous_NoUserId</code>)</li>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive <li>It insists that the user enters a password.
b6c1232fd4529b7cb25d801404f6c440d549f311slive (<code>Anonymous_MustGiveEmail</code>)</li>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive <li>The password entered must be a valid email address, ie.
b6c1232fd4529b7cb25d801404f6c440d549f311slive contain at least one '@' and a '.'.
b6c1232fd4529b7cb25d801404f6c440d549f311slive (<code>Anonymous_VerifyEmail</code>)</li>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive <li>The userID must be one of <code>anonymous guest www test
b6c1232fd4529b7cb25d801404f6c440d549f311slive welcome</code> and comparison is <strong>not</strong> case
b6c1232fd4529b7cb25d801404f6c440d549f311slive sensitive.</li>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive <li>And the Email addresses entered in the passwd field are
b6c1232fd4529b7cb25d801404f6c440d549f311slive logged to the error log file
b6c1232fd4529b7cb25d801404f6c440d549f311slive (<code>Anonymous_LogEmail</code>)</li>
b6c1232fd4529b7cb25d801404f6c440d549f311slive </ul>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive <p>Excerpt of httpd.conf:</p>
b6c1232fd4529b7cb25d801404f6c440d549f311slive
b6c1232fd4529b7cb25d801404f6c440d549f311slive<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>
b6c1232fd4529b7cb25d801404f6c440d549f311slive Anonymous_NoUserId off<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive Anonymous_MustGiveEmail on<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive Anonymous_VerifyEmail on<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive Anonymous_LogEmail on<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive Anonymous anonymous guest www test welcome<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive AuthName "Use 'anonymous' &amp; Email address for
b6c1232fd4529b7cb25d801404f6c440d549f311slive guest entry"<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive AuthType basic<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive # An
b6c1232fd4529b7cb25d801404f6c440d549f311slive AuthUserFile/AuthDBUserFile/AuthDBMUserFile<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive # directive must be specified, or use<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive # Anonymous_Authoritative for public access.<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive # In the .htaccess for the public directory, add:<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive &lt;Files *&gt;<br>
b6c1232fd4529b7cb25d801404f6c440d549f311slive Order Deny,Allow<br>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd Allow from all<br>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd<br>
a78048ccbdb6256da15e6b0e7e95355e480c2301nd Require valid-user<br>
3b3b7fc78d1f5bfc2769903375050048ff41ff26nd &lt;/Files&gt;<br>
35714556a25fceb7c9bf9c4e01791b2e2a4c27c3nd</code></td></tr></table></blockquote>
b6c1232fd4529b7cb25d801404f6c440d549f311slive<hr/><h2><a name="Anonymous">Anonymous</a> <a name="anonymous">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Specifies userIDs that areallowed access without
b6c1232fd4529b7cb25d801404f6c440d549f311slivepassword verification</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous <em>user</em> [<em>user</em>] ...</syntax></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
<p>A list of one or more 'magic' userIDs which are allowed
access without password verification. The userIDs are space
separated. It is possible to use the ' and " quotes to allow a
space in a userID as well as the \ escape character.</p>
<p>Please note that the comparison is
<strong>case-IN-sensitive</strong>.<br>
I strongly suggest that the magic username
'<code>anonymous</code>' is always one of the allowed
userIDs.</p>
<p>Example:</p>
<blockquote><table cellpadding="10"><tr><td bgcolor="#eeeeee"><code>Anonymous anonymous "Not Registered" 'I don\'t know'</code></td></tr></table></blockquote>
<p>This would allow the user to enter without password
verification by using the userId's 'anonymous',
'AnonyMous','Not Registered' and 'I Don't Know'.</p>
</usage><hr/><h2><a name="Anonymous_Authoritative">Anonymous_Authoritative</a> <a name="anonymous_authoritative">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Configures if authorization will fall-through
to other methods</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_Authoritative on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_Authoritative off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
<p>When set 'on', there is no fall-through to other authorization
methods. So if a userID does not match the values specified in the
<a href="#anonymous" class="directive"><code class="directive">Anonymous</code></a> directive,
access is denied.</p>
<p>Be sure you know what you are doing when you decide to
switch it on. And remember that it is the linking order of the
modules (in the Configuration / Make file) which details the
order in which the Authorization modules are queried.</p>
</usage><hr/><h2><a name="Anonymous_LogEmail">Anonymous_LogEmail</a> <a name="anonymous_logemail">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether the password entered will be logged in the
error log</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_LogEmail on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_LogEmail on</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
<p>When set <code>on</code>, the default, the 'password' entered
(which hopefully contains a sensible email address) is logged in
the error log.</p>
</usage><hr/><h2><a name="Anonymous_MustGiveEmail">Anonymous_MustGiveEmail</a> <a name="anonymous_mustgiveemail">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Specifies whether blank passwords are allowed</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_MustGiveEmail on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_MustGiveEmail on</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
<p>Specifies whether the user must specify an email address as
the password. This prohibits blank passwords.</p>
</usage><hr/><h2><a name="Anonymous_NoUserID">Anonymous_NoUserID</a> <a name="anonymous_nouserid">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether the userID field may be empty</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_NoUserID on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_NoUserID off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
<p>When set <code>on</code>, users can leave the userID (and
perhaps the password field) empty. This can be very convenient for
MS-Explorer users who can just hit return or click directly on the
OK button; which seems a natural reaction.</p>
</usage><hr/><h2><a name="Anonymous_VerifyEmail">Anonymous_VerifyEmail</a> <a name="anonymous_verifyemail">Directive</a></h2><table cellpadding="1" cellspacing="0" border="0" bgcolor="#cccccc"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Sets whether to check the password field for a correctly
formatted email address</td></tr><tr><td><a href="directive-dict.html#Syntax" class="help">Syntax:</a></td><td><syntax>Anonymous_VerifyEmail on|off</syntax></td></tr><tr><td><a href="directive-dict.html#Default" class="help">Default:</a></td><td><code>Anonymous_VerifyEmail off</code></td></tr><tr><td><a href="directive-dict.html#Context" class="help">Context:</a></td><td>directory, .htaccess</td></tr><tr><td><a href="directive-dict.html#Override" class="help">Override:</a></td><td>AuthConfig</td></tr><tr><td><a href="directive-dict.html#Status" class="help">Status:</a></td><td>Extension</td></tr><tr><td><a href="directive-dict.html#Module" class="help">Module:</a></td><td>mod_auth_anon</td></tr></table></td></tr></table><usage>
<p>When set <code>on</code> the 'password' entered is checked for
at least one '@' and a '.' to encourage users to enter valid email
addresses (see the above <a href="#auth_logemail" class="directive"><code class="directive">Auth_LogEmail</code></a>).</p>
</usage><hr/><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img alt="Index" src="/images/index.gif"/></a><a href="../"><img alt="Home" src="/images/home.gif"/></a></blockquote></body></html>