f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<?xml version="1.0"?>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>

d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd

d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd

7db9f691a00ead175b03335457ca296a33ddf31bnd<modulesynopsis metafile="mod_authn_anon.xml.meta">

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<name>mod_authn_anon</name>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<description>Allows "anonymous" user access to authenticated

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz areas</description>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<status>Extension</status>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<sourcefile>mod_authn_anon.c</sourcefile>

169280c7e65362d4ed444ec262c3f22a6a280166nd<identifier>authn_anon_module</identifier>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<compatibility>Available in Apache 2.1 and later</compatibility>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<summary>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>This module provides authentication front-ends such as

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <module>mod_auth_basic</module> to authenticate users similar

3604deb3632beeca54cfdb3864d872715971c300slive to anonymous-ftp sites, <em>i.e.</em> have a 'magic' user id

3604deb3632beeca54cfdb3864d872715971c300slive 'anonymous' and the email address as a password. These email

3604deb3632beeca54cfdb3864d872715971c300slive addresses can be logged.</p>

3604deb3632beeca54cfdb3864d872715971c300slive

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>Combined with other (database) access control methods, this

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz allows for effective user tracking and customization according

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz to a user profile while still keeping the site open for

92988aaf68a67c9fa417556cb944eba6bb82ef92rbowen 'unregistered' users. One advantage of using Auth-based user

92988aaf68a67c9fa417556cb944eba6bb82ef92rbowen tracking is that, unlike magic-cookies and funny URL

92988aaf68a67c9fa417556cb944eba6bb82ef92rbowen pre/postfixes, it is completely browser independent and it

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz allows users to share URLs.</p>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>When using <module>mod_auth_basic</module>, this module is invoked

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz via the <directive module="mod_auth_basic">AuthBasicProvider</directive>

3604deb3632beeca54cfdb3864d872715971c300slive directive with the <code>anon</code> value.</p>

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd</summary>

3604deb3632beeca54cfdb3864d872715971c300slive

f07998c217193b829f55c5ca8f4313ad5ba28f84nd<section id="example"><title>Example</title>

f07998c217193b829f55c5ca8f4313ad5ba28f84nd <p>The example below is combined with "normal" htpasswd-file based

f07998c217193b829f55c5ca8f4313ad5ba28f84nd authentication and allows users in additionally as 'guests' with the

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz following properties:</p>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <ul>

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <li>It insists that the user enters a userID.

3604deb3632beeca54cfdb3864d872715971c300slive (<directive module="mod_authn_anon"

3604deb3632beeca54cfdb3864d872715971c300slive >Anonymous_NoUserID</directive>)</li>

3604deb3632beeca54cfdb3864d872715971c300slive

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <li>It insists that the user enters a password.

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd (<directive module="mod_authn_anon"

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd >Anonymous_MustGiveEmail</directive>)</li>

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd

3604deb3632beeca54cfdb3864d872715971c300slive <li>The password entered must be a valid email address, <em>i.e.</em>

a5bff87eecd8413fcbee33eae01db42945b76becrbowen contain at least one '@' and a '.'.

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd (<directive module="mod_authn_anon"

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd >Anonymous_VerifyEmail</directive>)</li>

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <li>The userID must be one of <code>anonymous guest www test

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd welcome</code> and comparison is <strong>not</strong> case

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd sensitive. (<directive module="mod_authn_anon"

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd >Anonymous</directive>)</li>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz

3604deb3632beeca54cfdb3864d872715971c300slive <li>And the Email addresses entered in the passwd field are

3604deb3632beeca54cfdb3864d872715971c300slive logged to the error log file.

3604deb3632beeca54cfdb3864d872715971c300slive (<directive module="mod_authn_anon"

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz >Anonymous_LogEmail</directive>)</li>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz </ul>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <example><title>Example</title>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz &lt;Directory /var/www/html/private&gt;

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <indent>

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd AuthName "Use 'anonymous' &amp; Email address for guest entry"<br />

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd AuthType Basic<br />

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd AuthBasicProvider file anon<br />

35ffb30f57f777dbf3f17c5a5ddf706559942c16nd AuthUserFile /path/to/your/.htpasswd<br />

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <br />

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz Anonymous_NoUserID off<br />

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz Anonymous_MustGiveEmail on<br />

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz Anonymous_VerifyEmail on<br />

3604deb3632beeca54cfdb3864d872715971c300slive Anonymous_LogEmail on<br />

3604deb3632beeca54cfdb3864d872715971c300slive Anonymous anonymous guest www test welcome<br />

3604deb3632beeca54cfdb3864d872715971c300slive <br />

3604deb3632beeca54cfdb3864d872715971c300slive Require all granted<br />

3604deb3632beeca54cfdb3864d872715971c300slive <br />

3604deb3632beeca54cfdb3864d872715971c300slive Require valid-user<br />

3604deb3632beeca54cfdb3864d872715971c300slive </indent>

3604deb3632beeca54cfdb3864d872715971c300slive &lt;/Directory&gt;

3604deb3632beeca54cfdb3864d872715971c300slive </example>

3604deb3632beeca54cfdb3864d872715971c300slive</section>

3604deb3632beeca54cfdb3864d872715971c300slive

3604deb3632beeca54cfdb3864d872715971c300slive<directivesynopsis>

3604deb3632beeca54cfdb3864d872715971c300slive<name>Anonymous</name>

3604deb3632beeca54cfdb3864d872715971c300slive<description>Specifies userIDs that are allowed access without

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantzpassword verification</description>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<syntax>Anonymous <var>user</var> [<var>user</var>] ...</syntax>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<contextlist><context>directory</context><context>.htaccess</context>

f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz</contextlist>

<override>AuthConfig</override>

<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 />

It's strongly recommended that the magic username

'<code>anonymous</code>' is always one of the allowed

userIDs.</p>

<example><title>Example:</title>

Anonymous anonymous "Not Registered" "I don't know"

</example>

<p>This would allow the user to enter without password

verification by using the userIDs "anonymous",

"AnonyMous", "Not Registered" and "I Don't Know".</p>

<p>As of Apache 2.1 it is possible to specify the userID as

"<code>*</code>". That allows <em>any</em> supplied userID to be

accepted.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>Anonymous_LogEmail</name>

<description>Sets whether the password entered will be logged in the

error log</description>

<syntax>Anonymous_LogEmail On|Off</syntax>

<default>Anonymous_LogEmail On</default>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>AuthConfig</override>

<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>

</directivesynopsis>

<directivesynopsis>

<name>Anonymous_MustGiveEmail</name>

<description>Specifies whether blank passwords are allowed</description>

<syntax>Anonymous_MustGiveEmail On|Off</syntax>

<default>Anonymous_MustGiveEmail On</default>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>AuthConfig</override>

<usage>

<p>Specifies whether the user must specify an email address as

the password. This prohibits blank passwords.</p>

</usage>

</directivesynopsis>

<directivesynopsis>

<name>Anonymous_NoUserID</name>

<description>Sets whether the userID field may be empty</description>

<syntax>Anonymous_NoUserID On|Off</syntax>

<default>Anonymous_NoUserID Off</default>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>AuthConfig</override>

<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>

</directivesynopsis>

<directivesynopsis>

<name>Anonymous_VerifyEmail</name>

<description>Sets whether to check the password field for a correctly

formatted email address</description>

<syntax>Anonymous_VerifyEmail On|Off</syntax>

<default>Anonymous_VerifyEmail Off</default>

<contextlist><context>directory</context><context>.htaccess</context>

</contextlist>

<override>AuthConfig</override>

<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 <directive

module="mod_authn_anon">Anonymous_LogEmail</directive>).</p>

</usage>

</directivesynopsis>

</modulesynopsis>