granicus.if.org Git - apache/blob - docs/manual/mod/mod_authn_dbm.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_authn_dbm.xml.meta">
  24
  25 <name>mod_authn_dbm</name>
  26 <description>User authentication using DBM files</description>
  27 <status>Extension</status>
  28 <sourcefile>mod_authn_dbm.c</sourcefile>
  29 <identifier>authn_dbm_module</identifier>
  30 <compatibility>Available in Apache 2.1 and later</compatibility>
  31
  32 <summary>
  33     <p>This module provides authentication front-ends such as
  34     <module>mod_auth_digest</module> and <module>mod_auth_basic</module>
  35     to authenticate users by looking up users in <dfn>dbm</dfn> password
  36     files. Similar functionality is provided by
  37     <module>mod_authn_file</module>.</p>
  38
  39     <p>When using <module>mod_auth_basic</module> or
  40     <module>mod_auth_digest</module>, this module is invoked via the
  41     <directive module="mod_auth_basic">AuthBasicProvider</directive> or
  42     <directive module="mod_auth_digest">AuthDigestProvider</directive>
  43     with the <code>dbm</code> value.</p>
  44 </summary>
  45
  46 <seealso><directive module="mod_authn_core">AuthName</directive></seealso>
  47 <seealso><directive module="mod_authn_core">AuthType</directive></seealso>
  48 <seealso>
  49   <directive module="mod_auth_basic">AuthBasicProvider</directive>
  50 </seealso>
  51 <seealso>
  52   <directive module="mod_auth_digest">AuthDigestProvider</directive>
  53 </seealso>
  54
  55 <directivesynopsis>
  56 <name>AuthDBMUserFile</name>
  57 <description>Sets the name of a database file containing the list of users and
  58 passwords for authentication</description>
  59 <syntax>AuthDBMUserFile <var>file-path</var></syntax>
  60 <contextlist><context>directory</context><context>.htaccess</context>
  61 </contextlist>
  62 <override>AuthConfig</override>
  63
  64 <usage>
  65     <p>The <directive>AuthDBMUserFile</directive> directive sets the
  66     name of a DBM file containing the list of users and passwords for
  67     user authentication. <var>File-path</var> is the absolute path to
  68     the user file.</p>
  69
  70     <p>The user file is keyed on the username. The value for a user is
  71     the encrypted password, optionally followed by a colon and arbitrary
  72     data. The colon and the data following it will be ignored by the
  73     server.</p>
  74
  75     <note type="warning"><title>Security:</title>
  76       <p>Make sure that the <directive>AuthDBMUserFile</directive> is stored
  77       outside the document tree of the web-server; do <em>not</em> put it in
  78       the directory that it protects. Otherwise, clients will be able to
  79       download the <directive>AuthDBMUserFile</directive>.</p>
  80     </note>
  81
  82     <p>Important compatibility note: The implementation of
  83     <code>dbmopen</code> in the apache modules reads the string length of
  84     the hashed values from the DBM data structures, rather than relying
  85     upon the string being NULL-appended. Some applications, such as
  86     the Netscape web server, rely upon the string being
  87     NULL-appended, so if you are having trouble using DBM files
  88     interchangeably between applications this may be a part of the
  89     problem.</p>
  90
  91     <p>A perl script called
  92     <program>dbmmanage</program> is included with
  93     Apache. This program can be used to create and update DBM
  94     format password files for use with this module.</p>
  95 </usage>
  96 </directivesynopsis>
  97
  98 <directivesynopsis>
  99 <name>AuthDBMType</name>
 100 <description>Sets the type of database file that is used to
 101 store passwords</description>
 102 <syntax>AuthDBMType default|SDBM|GDBM|NDBM|DB</syntax>
 103 <default>AuthDBMType default</default>
 104 <contextlist><context>directory</context><context>.htaccess</context>
 105 </contextlist>
 106 <override>AuthConfig</override>
 107
 108 <usage>
 109     <p>Sets the type of database file that is used to store the passwords.
 110     The default database type is determined at compile time.  The
 111     availability of other types of database files also depends on
 112     <a href="../install.html#dbm">compile-time settings</a>.</p>
 113
 114     <p>It is crucial that whatever program you use to create your password
 115     files is configured to use the same type of database.</p>
 116 </usage>
 117 </directivesynopsis>
 118
 119 </modulesynopsis>