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" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.min.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p> 19<p class="apache">Apache HTTP Server Version 2.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_authn_anon</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_authn_anon.html" title="English"> en </a> | 28<a href="/fr/mod/mod_authn_anon.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 29<a href="/ja/mod/mod_authn_anon.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 30<a href="/ko/mod/mod_authn_anon.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 31</div> 32<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Allows "anonymous" user access to authenticated 33 areas</td></tr> 34<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 35<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>authn_anon_module</td></tr> 36<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_authn_anon.c</td></tr> 37<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table> 38<h3>Summary</h3> 39 40 <p>This module provides authentication front-ends such as 41 <code class="module"><a href="/mod/mod_auth_basic.html">mod_auth_basic</a></code> to authenticate users similar 42 to anonymous-ftp sites, <em>i.e.</em> have a 'magic' user id 43 'anonymous' and the email address as a password. These email 44 addresses can be logged.</p> 45 46 <p>Combined with other (database) access control methods, this 47 allows for effective user tracking and customization according 48 to a user profile while still keeping the site open for 49 'unregistered' users. One advantage of using Auth-based user 50 tracking is that, unlike magic-cookies and funny URL 51 pre/postfixes, it is completely browser independent and it 52 allows users to share URLs.</p> 53 54 <p>When using <code class="module"><a href="/mod/mod_auth_basic.html">mod_auth_basic</a></code>, this module is invoked 55 via the <code class="directive"><a href="/mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> 56 directive with the <code>anon</code> value.</p> 57</div> 58<div id="quickview"><h3 class="directives">Directives</h3> 59<ul id="toc"> 60<li><img alt="" src="/images/down.gif" /> <a href="#anonymous">Anonymous</a></li> 61<li><img alt="" src="/images/down.gif" /> <a href="#anonymous_logemail">Anonymous_LogEmail</a></li> 62<li><img alt="" src="/images/down.gif" /> <a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a></li> 63<li><img alt="" src="/images/down.gif" /> <a href="#anonymous_nouserid">Anonymous_NoUserID</a></li> 64<li><img alt="" src="/images/down.gif" /> <a href="#anonymous_verifyemail">Anonymous_VerifyEmail</a></li> 65</ul> 66<h3>Topics</h3> 67<ul id="topics"> 68<li><img alt="" src="/images/down.gif" /> <a href="#example">Example</a></li> 69</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 70<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 71<div class="section"> 72<h2><a name="example" id="example">Example</a></h2> 73 <p>The example below is combined with "normal" htpasswd-file based 74 authentication and allows users in additionally as 'guests' with the 75 following properties:</p> 76 77 <ul> 78 <li>It insists that the user enters a userID. 79 (<code class="directive"><a href="#anonymous_nouserid">Anonymous_NoUserID</a></code>)</li> 80 81 <li>It insists that the user enters a password. 82 (<code class="directive"><a href="#anonymous_mustgiveemail">Anonymous_MustGiveEmail</a></code>)</li> 83 84 <li>The password entered must be a valid email address, <em>i.e.</em> 85 contain at least one '@' and a '.'. 86 (<code class="directive"><a href="#anonymous_verifyemail">Anonymous_VerifyEmail</a></code>)</li> 87 88 <li>The userID must be one of <code>anonymous guest www test 89 welcome</code> and comparison is <strong>not</strong> case 90 sensitive. (<code class="directive"><a href="#anonymous">Anonymous</a></code>)</li> 91 92 <li>And the Email addresses entered in the passwd field are 93 logged to the error log file. 94 (<code class="directive"><a href="#anonymous_logemail">Anonymous_LogEmail</a></code>)</li> 95 </ul> 96 97 <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><Directory /var/www/html/private> 98 AuthName "Use 'anonymous' & Email address for guest entry" 99 AuthType Basic 100 AuthBasicProvider file anon 101 AuthUserFile /path/to/your/.htpasswd 102 103 Anonymous_NoUserID off 104 Anonymous_MustGiveEmail on 105 Anonymous_VerifyEmail on 106 Anonymous_LogEmail on 107 Anonymous anonymous guest www test welcome 108 109 Require valid-user 110</Directory></pre> 111</div> 112</div> 113<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 114<div class="directive-section"><h2><a name="Anonymous" id="Anonymous">Anonymous</a> <a name="anonymous" id="anonymous">Directive</a></h2> 115<table class="directive"> 116<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Specifies userIDs that are allowed access without 117password verification</td></tr> 118<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Anonymous <var>user</var> [<var>user</var>] ...</code></td></tr> 119<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 120<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 121<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 122<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_anon</td></tr> 123</table> 124 <p>A list of one or more 'magic' userIDs which are allowed 125 access without password verification. The userIDs are space 126 separated. It is possible to use the ' and " quotes to allow a 127 space in a userID as well as the \ escape character.</p> 128 129 <p>Please note that the comparison is 130 <strong>case-IN-sensitive</strong>.<br /> 131 It's strongly recommended that the magic username 132 '<code>anonymous</code>' is always one of the allowed 133 userIDs.</p> 134 135 <div class="example"><h3>Example:</h3><pre class="prettyprint lang-config">Anonymous anonymous "Not Registered" "I don't know"</pre> 136</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 151error 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 200formatted 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"> en </a> | 216<a href="/fr/mod/mod_authn_anon.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 217<a href="/ja/mod/mod_authn_anon.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 218<a href="/ko/mod/mod_authn_anon.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 219</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 220<script type="text/javascript"><!--//--><![CDATA[//><!-- 221var comments_shortname = 'httpd'; 222var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_authn_anon.html'; 223(function(w, d) { 224 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 225 d.write('<div id="comments_thread"><\/div>'); 226 var s = d.createElement('script'); 227 s.type = 'text/javascript'; 228 s.async = true; 229 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 230 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 231 } 232 else { 233 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 234 } 235})(window, document); 236//--><!]]></script></div><div id="footer"> 237<p class="apache">Copyright 2014 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> 238<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 239if (typeof(prettyPrint) !== 'undefined') { 240 prettyPrint(); 241} 242//--><!]]></script> 243</body></html>