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 / F278238_mod_auth_dbm.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  9KB  |  213 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.6 $ -->
  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_dbm.xml.meta">
  23.  
  24. <name>mod_auth_dbm</name>
  25. <description>Provides for user authentication using DBM
  26.     files</description>
  27. <status>Extension</status>
  28. <sourcefile>mod_auth_dbm.c</sourcefile>
  29. <identifier>auth_dbm_module</identifier>
  30. <compatibility>Available only in versions prior to 2.1</compatibility>
  31.  
  32. <summary>
  33.     <p>This module provides for HTTP Basic Authentication, where
  34.     the usernames and passwords are stored in DBM type database
  35.     files. It is an alternative to the plain text password files
  36.     provided by <module>mod_auth</module>.</p>
  37. </summary>
  38.  
  39. <seealso><directive module="core">AuthName</directive></seealso>
  40. <seealso><directive module="core">AuthType</directive></seealso>
  41. <seealso><directive module="core">Require</directive></seealso>
  42. <seealso><directive module="core">Satisfy</directive></seealso>
  43.  
  44. <directivesynopsis>
  45. <name>AuthDBMGroupFile</name>
  46. <description>Sets the name of the database file containing the list
  47. of user groups for authentication</description>
  48. <syntax>AuthDBMGroupFile <var>file-path</var></syntax>
  49. <contextlist><context>directory</context><context>.htaccess</context>
  50. </contextlist>
  51. <override>AuthConfig</override>
  52.  
  53. <usage>
  54.     <p>The <directive>AuthDBMGroupFile</directive> directive sets the
  55.     name of a DBM file containing the list of user groups for user
  56.     authentication. <var>File-path</var> is the absolute path to the
  57.     group file.</p>
  58.  
  59.     <p>The group file is keyed on the username. The value for a
  60.     user is a comma-separated list of the groups to which the users
  61.     belongs. There must be no whitespace within the value, and it
  62.     must never contain any colons.</p>
  63.  
  64.     <p>Security: make sure that the
  65.     <directive>AuthDBMGroupFile</directive> is stored outside the
  66.     document tree of the web-server; do <em>not</em> put it in the
  67.     directory that it protects. Otherwise, clients will be able to
  68.     download the <directive>AuthDBMGroupFile</directive> unless
  69.     otherwise protected.</p>
  70.  
  71.     <p>Combining Group and Password DBM files: In some cases it is
  72.     easier to manage a single database which contains both the
  73.     password and group details for each user. This simplifies any
  74.     support programs that need to be written: they now only have to
  75.     deal with writing to and locking a single DBM file. This can be
  76.     accomplished by first setting the group and password files to
  77.     point to the same DBM:</p>
  78.  
  79.     <example>
  80.       AuthDBMGroupFile /www/userbase<br />
  81.       AuthDBMUserFile /www/userbase
  82.     </example>
  83.  
  84.     <p>The key for the single DBM is the username. The value consists
  85.     of</p>
  86.  
  87.     <example>
  88.       <var>Unix Crypt-ed Password</var>:<var>List of Groups</var>[:(ignored)]
  89.     </example>
  90.  
  91.     <p>The password section contains the encrypted password as before.
  92.     This is followed by a colon and the comma separated list of groups.
  93.     Other data may optionally be left in the DBM file after another colon;
  94.     it is ignored by the authentication module. This is what
  95.     www.telescope.org uses for its combined password and group database.</p>
  96. </usage>
  97. </directivesynopsis>
  98.  
  99. <directivesynopsis>
  100. <name>AuthDBMUserFile</name>
  101. <description>Sets thename of a database file containing the list of users and
  102. passwords for authentication</description>
  103. <syntax>AuthDBMUserFile <var>file-path</var></syntax>
  104. <contextlist><context>directory</context><context>.htaccess</context>
  105. </contextlist>
  106. <override>AuthConfig</override>
  107.  
  108. <usage>
  109.     <p>The <directive>AuthDBMUserFile</directive> directive sets the
  110.     name of a DBM file containing the list of users and passwords for
  111.     user authentication. <var>File-path</var> is the absolute path to
  112.     the user file.</p>
  113.  
  114.     <p>The user file is keyed on the username. The value for a user is
  115.     the encrypted password, optionally followed by a colon and arbitrary
  116.     data. The colon and the data following it will be ignored by the
  117.     server.</p>
  118.  
  119.     <note type="warning"><title>Security:</title>
  120.       <p>Make sure that the <directive>AuthDBMUserFile</directive> is stored
  121.       outside the document tree of the web-server; do <em>not</em> put it in
  122.       the directory that it protects. Otherwise, clients will be able to
  123.       download the <directive>AuthDBMUserFile</directive>.</p>
  124.     </note>
  125.  
  126.     <p>Important compatibility note: The implementation of
  127.     "dbmopen" in the apache modules reads the string length of the
  128.     hashed values from the DBM data structures, rather than relying
  129.     upon the string being NULL-appended. Some applications, such as
  130.     the Netscape web server, rely upon the string being
  131.     NULL-appended, so if you are having trouble using DBM files
  132.     interchangeably between applications this may be a part of the
  133.     problem.</p>
  134.  
  135.     <p>A perl script called
  136.     <a href="../programs/dbmmanage.html">dbmmanage</a> is included with
  137.     Apache. This program can be used to create and update DBM
  138.     format password files for use with this module.</p>
  139. </usage>
  140. </directivesynopsis>
  141.  
  142. <directivesynopsis>
  143. <name>AuthDBMType</name>
  144. <description>Sets the type of database file that is used to
  145. store passwords</description>
  146. <syntax>AuthDBMType default|SDBM|GDBM|NDBM|DB</syntax>
  147. <default>AuthDBMType default</default>
  148. <contextlist><context>directory</context><context>.htaccess</context>
  149. </contextlist>
  150. <override>AuthConfig</override>
  151. <compatibility>Available in version 2.0.30 and later.</compatibility>
  152.  
  153. <usage>
  154.     <p>Sets the type of database file that is used to store the passwords.
  155.     The default database type is determined at compile time.  The
  156.     availability of other types of database files also depends on
  157.     <a href="../install.html#dbm">compile-time settings</a>.</p>
  158.  
  159.     <p>It is crucial that whatever program you use to create your password
  160.     files is configured to use the same type of database.</p>
  161. </usage>
  162. </directivesynopsis>
  163.  
  164. <directivesynopsis>
  165. <name>AuthDBMAuthoritative</name>
  166. <description>Sets whether authentication and authorization will be
  167. passwed on to lower level modules</description>
  168. <syntax>AuthDBMAuthoritative On|Off</syntax>
  169. <default>AuthDBMAuthoritative On</default>
  170. <contextlist><context>directory</context><context>.htaccess</context>
  171. </contextlist>
  172. <override>AuthConfig</override>
  173.  
  174. <usage>
  175.     <p>Setting the <directive>AuthDBMAuthoritative</directive>
  176.     directive explicitly to <code>Off</code> allows for both
  177.     authentication and authorization to be passed on to lower level
  178.     modules (as defined in the <code>modules.c</code> files) if there
  179.     is <strong>no userID</strong> or <strong>rule</strong> matching the
  180.     supplied userID. If there is a userID and/or rule specified; the
  181.     usual password and access checks will be applied and a failure will
  182.     give an "Authentication Required" reply.</p>
  183.  
  184.     <p>So if a userID appears in the database of more than one module;
  185.     or if a valid <directive module="core">Require</directive>
  186.     directive applies to more than one module; then the first module
  187.     will verify the credentials; and no access is passed on;
  188.     regardless of the <directive>AuthDBMAuthoritative</directive>
  189.     setting.</p>
  190.  
  191.     <p>A common use for this is in conjunction with one of the
  192.     basic auth modules; such as <module>mod_auth</module>. Whereas this
  193.     DBM module supplies the bulk of the user credential checking; a
  194.     few (administrator) related accesses fall through to a lower
  195.     level with a well protected <code>.htpasswd</code> file.</p>
  196.  
  197.     <p>By default, control is not passed on and an unknown userID
  198.     or rule will result in an "Authentication Required" reply. Not
  199.     setting it thus keeps the system secure and forces an NCSA
  200.     compliant behaviour.</p>
  201.  
  202.     <note type="warning"><title>Security:</title>
  203.       <p>Do consider the implications of allowing a user to allow
  204.       fall-through in his <code>.htaccess</code> file; and verify that this
  205.       is really what you want; Generally it is easier to just secure
  206.       a single <code>.htpasswd</code> file, than it is to secure a
  207.       database which might have more access interfaces.</p>
  208.     </note>
  209. </usage>
  210. </directivesynopsis>
  211.  
  212. </modulesynopsis>
  213.