home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278236_mod_auth_anon.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  8KB  |  222 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.5.2.8 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_auth_anon.xml.meta">
  23.  
  24. <name>mod_auth_anon</name>
  25. <description>Allows "anonymous" user access to authenticated
  26. areas</description>
  27. <status>Extension</status>
  28. <sourcefile>mod_auth_anon.c</sourcefile>
  29. <identifier>auth_anon_module</identifier>
  30. <compatibility>Available only in versions prior to 2.1</compatibility>
  31.  
  32. <summary>
  33.     <p>This module does access control in a manner similar to
  34.     anonymous-ftp sites; <em>i.e.</em> have a 'magic' user id
  35.     'anonymous' and the email address as a password. These email
  36.     addresses can be logged.</p>
  37.  
  38.     <p>Combined with other (database) access control methods, this
  39.     allows for effective user tracking and customization according
  40.     to a user profile while still keeping the site open for
  41.     'unregistered' users. One advantage of using Auth-based user
  42.     tracking is that, unlike magic-cookies and funny URL
  43.     pre/postfixes, it is completely browser independent and it
  44.     allows users to share URLs.</p>
  45. </summary>
  46.  
  47. <section id="example"><title>Example</title>
  48.  
  49.     <p>The example below (when combined with the Auth directives of a
  50.     htpasswd-file based (or GDM, mSQL etc.) base access
  51.     control system allows users in as 'guests' with the following
  52.     properties:</p>
  53.  
  54.     <ul>
  55.       <li>It insists that the user enters a userID.
  56.       (<code>Anonymous_NoUserID</code>)</li>
  57.  
  58.       <li>It insists that the user enters a password.
  59.       (<code>Anonymous_MustGiveEmail</code>)</li>
  60.  
  61.       <li>The password entered must be a valid email address, ie.
  62.       contain at least one '@' and a '.'.
  63.       (<code>Anonymous_VerifyEmail</code>)</li>
  64.  
  65.       <li>The userID must be one of <code>anonymous guest www test
  66.       welcome</code> and comparison is <strong>not</strong> case
  67.       sensitive. (<code>Anonymous</code>)</li>
  68.  
  69.       <li>And the Email addresses entered in the passwd field are
  70.       logged to the error log file.
  71.       (<code>Anonymous_LogEmail</code>)</li>
  72.     </ul>
  73.  
  74.     <example><title>Excerpt of httpd.conf:</title>
  75.       Anonymous_NoUserID off<br />
  76.       Anonymous_MustGiveEmail on<br />
  77.       Anonymous_VerifyEmail on<br />
  78.       Anonymous_LogEmail on<br />
  79.       Anonymous anonymous guest www test welcome<br />
  80.       <br />
  81.       AuthName "Use 'anonymous' & Email address for guest entry"<br />
  82.       AuthType basic<br />
  83.       <br />
  84.       # An
  85.       AuthUserFile/AuthDBUserFile/AuthDBMUserFile<br />
  86.       # directive must be specified, or use<br />
  87.       # Anonymous_Authoritative for public access.<br />
  88.       # In the .htaccess for the public directory, add:<br />
  89.       <Files *><br />
  90.       <indent>
  91.         Order Deny,Allow<br />
  92.         Allow from all<br />
  93.         <br />
  94.         Require valid-user<br />
  95.       </indent>
  96.       </Files>
  97.     </example>
  98. </section>
  99.  
  100. <directivesynopsis>
  101. <name>Anonymous</name>
  102. <description>Specifies userIDs that are allowed access without
  103. password verification</description>
  104. <syntax>Anonymous <var>user</var> [<var>user</var>] ...</syntax>
  105. <contextlist><context>directory</context><context>.htaccess</context>
  106. </contextlist>
  107. <override>AuthConfig</override>
  108.  
  109. <usage>
  110.     <p>A list of one or more 'magic' userIDs which are allowed
  111.     access without password verification. The userIDs are space
  112.     separated. It is possible to use the ' and " quotes to allow a
  113.     space in a userID as well as the \ escape character.</p>
  114.  
  115.     <p>Please note that the comparison is
  116.     <strong>case-IN-sensitive</strong>.<br />
  117.      I strongly suggest that the magic username
  118.     '<code>anonymous</code>' is always one of the allowed
  119.     userIDs.</p>
  120.  
  121.     <example><title>Example:</title>
  122.       Anonymous anonymous "Not Registered" "I don't know"
  123.     </example>
  124.  
  125.     <p>This would allow the user to enter without password
  126.     verification by using the userIDs "anonymous",
  127.     "AnonyMous", "Not Registered" and "I Don't Know".</p>
  128. </usage>
  129. </directivesynopsis>
  130.  
  131. <directivesynopsis>
  132. <name>Anonymous_Authoritative</name>
  133. <description>Configures if authorization will fall-through
  134. to other methods</description>
  135. <syntax>Anonymous_Authoritative On|Off</syntax>
  136. <default>Anonymous_Authoritative Off</default>
  137. <contextlist><context>directory</context><context>.htaccess</context>
  138. </contextlist>
  139. <override>AuthConfig</override>
  140.  
  141. <usage>
  142.     <p>When set <code>On</code>, there is no fall-through to other
  143.     authentication methods. So if a userID does not match the values
  144.     specified in the <directive module="mod_auth_anon">Anonymous</directive>
  145.     directive, access is denied.</p>
  146.  
  147.     <p>Be sure you know what you are doing when you decide to
  148.     switch it on. And remember that the order in which the Authentication
  149.     modules are queried is defined in the modules.c files at compile
  150.     time.</p>
  151. </usage>
  152. </directivesynopsis>
  153.  
  154. <directivesynopsis>
  155. <name>Anonymous_LogEmail</name>
  156. <description>Sets whether the password entered will be logged in the
  157. error log</description>
  158. <syntax>Anonymous_LogEmail On|Off</syntax>
  159. <default>Anonymous_LogEmail On</default>
  160. <contextlist><context>directory</context><context>.htaccess</context>
  161. </contextlist>
  162. <override>AuthConfig</override>
  163.  
  164. <usage>
  165.     <p>When set <code>On</code>, the default, the 'password' entered
  166.     (which hopefully contains a sensible email address) is logged in
  167.     the error log.</p>
  168. </usage>
  169. </directivesynopsis>
  170.  
  171. <directivesynopsis>
  172. <name>Anonymous_MustGiveEmail</name>
  173. <description>Specifies whether blank passwords are allowed</description>
  174. <syntax>Anonymous_MustGiveEmail On|Off</syntax>
  175. <default>Anonymous_MustGiveEmail On</default>
  176. <contextlist><context>directory</context><context>.htaccess</context>
  177. </contextlist>
  178. <override>AuthConfig</override>
  179.  
  180. <usage>
  181.     <p>Specifies whether the user must specify an email address as
  182.     the password. This prohibits blank passwords.</p>
  183. </usage>
  184. </directivesynopsis>
  185.  
  186. <directivesynopsis>
  187. <name>Anonymous_NoUserID</name>
  188. <description>Sets whether the userID field may be empty</description>
  189. <syntax>Anonymous_NoUserID On|Off</syntax>
  190. <default>Anonymous_NoUserID Off</default>
  191. <contextlist><context>directory</context><context>.htaccess</context>
  192. </contextlist>
  193. <override>AuthConfig</override>
  194.  
  195. <usage>
  196.     <p>When set <code>On</code>, users can leave the userID (and
  197.     perhaps the password field) empty. This can be very convenient for
  198.     MS-Explorer users who can just hit return or click directly on the
  199.     OK button; which seems a natural reaction.</p>
  200. </usage>
  201. </directivesynopsis>
  202.  
  203. <directivesynopsis>
  204. <name>Anonymous_VerifyEmail</name>
  205. <description>Sets whether to check the password field for a correctly
  206. formatted email address</description>
  207. <syntax>Anonymous_VerifyEmail On|Off</syntax>
  208. <default>Anonymous_VerifyEmail Off</default>
  209. <contextlist><context>directory</context><context>.htaccess</context>
  210. </contextlist>
  211. <override>AuthConfig</override>
  212.  
  213. <usage>
  214.     <p>When set <code>On</code> the 'password' entered is checked for
  215.     at least one '@' and a '.' to encourage users to enter valid email
  216.     addresses (see the above <directive
  217.     module="mod_auth_anon">Anonymous_LogEmail</directive>).</p>
  218. </usage>
  219. </directivesynopsis>
  220.  
  221. </modulesynopsis>
  222.