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