rubbos/app/apache2/manual/mod/mod_auth_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_auth_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.0</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.0</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_auth_anon</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_auth_anon.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Allows "anonymous" user access to authenticated
  27 areas</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>auth_anon_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_auth_anon.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available only in versions prior to 2.1</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module does access control in a manner similar to
  35     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>
  38
  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>
  46 </div>
  47 <div id="quickview"><h3 class="directives">Directives</h3>
  48 <ul id="toc">
  49 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous">Anonymous</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_authoritative">Anonymous_Authoritative</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_logemail">Anonymous_LogEmail</a></li>
  52 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_nouserid">Anonymous_NoUserID</a></li>
  54 <li><img alt="" src="../images/down.gif" /> <a href="#anonymous_verifyemail">Anonymous_VerifyEmail</a></li>
  55 </ul>
  56 <h3>Topics</h3>
  57 <ul id="topics">
  58 <li><img alt="" src="../images/down.gif" /> <a href="#example">Example</a></li>
  59 </ul></div>
  60 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  61 <div class="section">
  62 <h2><a name="example" id="example">Example</a></h2>
  63
  64     <p>The example below (when combined with the Auth directives of a
  65     htpasswd-file based (or GDM, mSQL etc.) base access
  66     control system allows users in as 'guests' with the following
  67     properties:</p>
  68
  69     <ul>
  70       <li>It insists that the user enters a userID.
  71       (<code>Anonymous_NoUserID</code>)</li>
  72
  73       <li>It insists that the user enters a password.
  74       (<code>Anonymous_MustGiveEmail</code>)</li>
  75
  76       <li>The password entered must be a valid email address, ie.
  77       contain at least one '@' and a '.'.
  78       (<code>Anonymous_VerifyEmail</code>)</li>
  79
  80       <li>The userID must be one of <code>anonymous guest www test
  81       welcome</code> and comparison is <strong>not</strong> case
  82       sensitive. (<code>Anonymous</code>)</li>
  83
  84       <li>And the Email addresses entered in the passwd field are
  85       logged to the error log file.
  86       (<code>Anonymous_LogEmail</code>)</li>
  87     </ul>
  88
  89     <div class="example"><h3>Excerpt of httpd.conf:</h3><p><code>
  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 />
  95       <br />
  96       AuthName "Use 'anonymous' &amp; Email address for guest entry"<br />
  97       AuthType basic<br />
  98       <br />
  99       # An
 100       AuthUserFile/AuthDBUserFile/AuthDBMUserFile<br />
 101       # directive must be specified, or use<br />
 102       # Anonymous_Authoritative for public access.<br />
 103       # In the .htaccess for the public directory, add:<br />
 104       &lt;Files *&gt;<br />
 105       <span class="indent">
 106         Order Deny,Allow<br />
 107         Allow from all<br />
 108         <br />
 109         Require valid-user<br />
 110       </span>
 111       &lt;/Files&gt;
 112     </code></p></div>
 113 </div>
 114 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 115 <div class="directive-section"><h2><a name="Anonymous" id="Anonymous">Anonymous</a> <a name="anonymous" id="anonymous">Directive</a></h2>
 116 <table class="directive">
 117 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies userIDs that are allowed access without
 118 password verification</td></tr>
 119 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous <var>user</var> [<var>user</var>] ...</code></td></tr>
 120 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 121 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 122 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 123 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_anon</td></tr>
 124 </table>
 125     <p>A list of one or more 'magic' userIDs which are allowed
 126     access without password verification. The userIDs are space
 127     separated. It is possible to use the ' and " quotes to allow a
 128     space in a userID as well as the \ escape character.</p>
 129
 130     <p>Please note that the comparison is
 131     <strong>case-IN-sensitive</strong>.<br />
 132      I strongly suggest that the magic username
 133     '<code>anonymous</code>' is always one of the allowed
 134     userIDs.</p>
 135
 136     <div class="example"><h3>Example:</h3><p><code>
 137       Anonymous anonymous "Not Registered" "I don't know"
 138     </code></p></div>
 139
 140     <p>This would allow the user to enter without password
 141     verification by using the userIDs "anonymous",
 142     "AnonyMous", "Not Registered" and "I Don't Know".</p>
 143
 144 </div>
 145 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 146 <div class="directive-section"><h2><a name="Anonymous_Authoritative" id="Anonymous_Authoritative">Anonymous_Authoritative</a> <a name="anonymous_authoritative" id="anonymous_authoritative">Directive</a></h2>
 147 <table class="directive">
 148 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures if authorization will fall-through
 149 to other methods</td></tr>
 150 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_Authoritative On|Off</code></td></tr>
 151 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_Authoritative Off</code></td></tr>
 152 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 153 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 154 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 155 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_anon</td></tr>
 156 </table>
 157     <p>When set <code>On</code>, there is no fall-through to other
 158     authentication methods. So if a userID does not match the values
 159     specified in the <code class="directive"><a href="#anonymous">Anonymous</a></code>
 160     directive, access is denied.</p>
 161
 162     <p>Be sure you know what you are doing when you decide to
 163     switch it on. And remember that the order in which the Authentication
 164     modules are queried is defined in the modules.c files at compile
 165     time.</p>
 166
 167 </div>
 168 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 169 <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>
 170 <table class="directive">
 171 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether the password entered will be logged in the
 172 error log</td></tr>
 173 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_LogEmail On|Off</code></td></tr>
 174 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_LogEmail On</code></td></tr>
 175 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 176 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 177 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 178 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_anon</td></tr>
 179 </table>
 180     <p>When set <code>On</code>, the default, the 'password' entered
 181     (which hopefully contains a sensible email address) is logged in
 182     the error log.</p>
 183
 184 </div>
 185 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 186 <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>
 187 <table class="directive">
 188 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies whether blank passwords are allowed</td></tr>
 189 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_MustGiveEmail On|Off</code></td></tr>
 190 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_MustGiveEmail On</code></td></tr>
 191 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 192 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 193 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 194 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_anon</td></tr>
 195 </table>
 196     <p>Specifies whether the user must specify an email address as
 197     the password. This prohibits blank passwords.</p>
 198
 199 </div>
 200 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 201 <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>
 202 <table class="directive">
 203 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether the userID field may be empty</td></tr>
 204 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_NoUserID On|Off</code></td></tr>
 205 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_NoUserID 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_auth_anon</td></tr>
 210 </table>
 211     <p>When set <code>On</code>, users can leave the userID (and
 212     perhaps the password field) empty. This can be very convenient for
 213     MS-Explorer users who can just hit return or click directly on the
 214     OK button; which seems a natural reaction.</p>
 215
 216 </div>
 217 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 218 <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>
 219 <table class="directive">
 220 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether to check the password field for a correctly
 221 formatted email address</td></tr>
 222 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_VerifyEmail On|Off</code></td></tr>
 223 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_VerifyEmail Off</code></td></tr>
 224 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 225 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 226 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 227 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_anon</td></tr>
 228 </table>
 229     <p>When set <code>On</code> the 'password' entered is checked for
 230     at least one '@' and a '.' to encourage users to enter valid email
 231     addresses (see the above <code class="directive"><a href="#anonymous_logemail">Anonymous_LogEmail</a></code>).</p>
 232
 233 </div>
 234 </div>
 235 <div class="bottomlang">
 236 <p><span>Available Languages: </span><a href="../en/mod/mod_auth_anon.html" title="English">&nbsp;en&nbsp;</a></p>
 237 </div><div id="footer">
 238 <p class="apache">Copyright 2009 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>
 239 <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>
 240 </body></html>