granicus.if.org Git - apache/blob - 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.5</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.5</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 /var/www/html/private&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         Require valid-user<br />
 108       </span>
 109       &lt;/Directory&gt;
 110     </code></p></div>
 111 </div>
 112 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 113 <div class="directive-section"><h2><a name="Anonymous" id="Anonymous">Anonymous</a> <a name="anonymous" id="anonymous">Directive</a></h2>
 114 <table class="directive">
 115 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies userIDs that are allowed access without
 116 password verification</td></tr>
 117 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous <var>user</var> [<var>user</var>] ...</code></td></tr>
 118 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 119 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 120 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 121 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
 122 </table>
 123     <p>A list of one or more 'magic' userIDs which are allowed
 124     access without password verification. The userIDs are space
 125     separated. It is possible to use the ' and " quotes to allow a
 126     space in a userID as well as the \ escape character.</p>
 127
 128     <p>Please note that the comparison is
 129     <strong>case-IN-sensitive</strong>.<br />
 130     It's strongly recommended that the magic username
 131     '<code>anonymous</code>' is always one of the allowed
 132     userIDs.</p>
 133
 134     <div class="example"><h3>Example:</h3><p><code>
 135       Anonymous anonymous "Not Registered" "I don't know"
 136     </code></p></div>
 137
 138     <p>This would allow the user to enter without password
 139     verification by using the userIDs "anonymous",
 140     "AnonyMous", "Not Registered" and "I Don't Know".</p>
 141
 142     <p>As of Apache 2.1 it is possible to specify the userID as
 143     "<code>*</code>". That allows <em>any</em> supplied userID to be
 144     accepted.</p>
 145
 146 </div>
 147 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 148 <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>
 149 <table class="directive">
 150 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether the password entered will be logged in the
 151 error log</td></tr>
 152 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_LogEmail On|Off</code></td></tr>
 153 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_LogEmail On</code></td></tr>
 154 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 155 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 156 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 157 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
 158 </table>
 159     <p>When set <code>On</code>, the default, the 'password' entered
 160     (which hopefully contains a sensible email address) is logged in
 161     the error log.</p>
 162
 163 </div>
 164 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 165 <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>
 166 <table class="directive">
 167 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies whether blank passwords are allowed</td></tr>
 168 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_MustGiveEmail On|Off</code></td></tr>
 169 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_MustGiveEmail On</code></td></tr>
 170 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 171 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 172 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 173 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
 174 </table>
 175     <p>Specifies whether the user must specify an email address as
 176     the password. This prohibits blank passwords.</p>
 177
 178 </div>
 179 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 180 <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>
 181 <table class="directive">
 182 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether the userID field may be empty</td></tr>
 183 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_NoUserID On|Off</code></td></tr>
 184 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_NoUserID Off</code></td></tr>
 185 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 186 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 187 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 188 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
 189 </table>
 190     <p>When set <code>On</code>, users can leave the userID (and
 191     perhaps the password field) empty. This can be very convenient for
 192     MS-Explorer users who can just hit return or click directly on the
 193     OK button; which seems a natural reaction.</p>
 194
 195 </div>
 196 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 197 <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>
 198 <table class="directive">
 199 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether to check the password field for a correctly
 200 formatted email address</td></tr>
 201 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous_VerifyEmail On|Off</code></td></tr>
 202 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Anonymous_VerifyEmail Off</code></td></tr>
 203 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 204 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 205 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 206 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr>
 207 </table>
 208     <p>When set <code>On</code> the 'password' entered is checked for
 209     at least one '@' and a '.' to encourage users to enter valid email
 210     addresses (see the above <code class="directive"><a href="#anonymous_logemail">Anonymous_LogEmail</a></code>).</p>
 211
 212 </div>
 213 </div>
 214 <div class="bottomlang">
 215 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_anon.html" title="English">&nbsp;en&nbsp;</a> |
 216 <a href="../ja/mod/mod_authn_anon.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 217 <a href="../ko/mod/mod_authn_anon.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 218 </div><div id="footer">
 219 <p class="apache">Copyright 2012 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>
 220 <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>
 221 </body></html>