mod_authn_dbm.xml revision d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacd
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Copyright 2002-2004 Apache Software Foundation
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Licensed under the Apache License, Version 2.0 (the "License");
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd you may not use this file except in compliance with the License.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd You may obtain a copy of the License at
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Unless required by applicable law or agreed to in writing, software
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd distributed under the License is distributed on an "AS IS" BASIS,
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd See the License for the specific language governing permissions and
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd limitations under the License.
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<description>User authentication using DBM files</description>
169280c7e65362d4ed444ec262c3f22a6a280166nd<compatibility>Available in Apache 2.1 and later</compatibility>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>This module provides authentication front-ends such as
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <module>mod_auth_digest</module> and <module>mod_auth_basic</module>
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd to authenticate users by looking up users in <dfn>dbm</dfn> password
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd files. Similar functionality is provided by
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>When using <module>mod_auth_basic</module> or
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <module>mod_auth_digest</module>, this module is invoked via the
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <directive module="mod_auth_basic">AuthBasicProvider</directive> or
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <directive module="mod_auth_digest">AuthDigestProvider</directive>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<seealso><directive module="core">AuthName</directive></seealso>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<seealso><directive module="core">AuthType</directive></seealso>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <directive module="mod_auth_basic">AuthBasicProvider</directive>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <directive module="mod_auth_digest">AuthDigestProvider</directive>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<directivesynopsis>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<description>Sets the name of a database file containing the list of users and
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantzpasswords for authentication</description>
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd<contextlist><context>directory</context><context>.htaccess</context>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz</contextlist>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>The <directive>AuthDBMUserFile</directive> directive sets the
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz name of a DBM file containing the list of users and passwords for
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd user authentication. <var>File-path</var> is the absolute path to
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz the user file.</p>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>The user file is keyed on the username. The value for a user is
e32acaab1dda74d937a24fac7840058dbd7f77a2nd the encrypted password, optionally followed by a colon and arbitrary
e32acaab1dda74d937a24fac7840058dbd7f77a2nd data. The colon and the data following it will be ignored by the
e32acaab1dda74d937a24fac7840058dbd7f77a2nd server.</p>
e32acaab1dda74d937a24fac7840058dbd7f77a2nd <p>Make sure that the <directive>AuthDBMUserFile</directive> is stored
e32acaab1dda74d937a24fac7840058dbd7f77a2nd outside the document tree of the web-server; do <em>not</em> put it in
e32acaab1dda74d937a24fac7840058dbd7f77a2nd the directory that it protects. Otherwise, clients will be able to
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>Important compatibility note: The implementation of
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <code>dbmopen</code> in the apache modules reads the string length of
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd the hashed values from the DBM data structures, rather than relying
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz upon the string being NULL-appended. Some applications, such as
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz the Netscape web server, rely upon the string being
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz NULL-appended, so if you are having trouble using DBM files
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz interchangeably between applications this may be a part of the
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz problem.</p>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <p>A perl script called
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz <a href="/programs/dbmmanage.html">dbmmanage</a> is included with
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz Apache. This program can be used to create and update DBM
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz format password files for use with this module.</p>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz</directivesynopsis>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<directivesynopsis>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<description>Sets the type of database file that is used to
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantzstore passwords</description>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz<syntax>AuthDBMType default|SDBM|GDBM|NDBM|DB</syntax>
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd<contextlist><context>directory</context><context>.htaccess</context>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz</contextlist>
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <p>Sets the type of database file that is used to store the passwords.
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd The default database type is determined at compile time. The
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd availability of other types of database files also depends on
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <a href="/install.html#dbm">compile-time settings</a>.</p>
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <p>It is crucial that whatever program you use to create your password
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd files is configured to use the same type of database.</p>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz</directivesynopsis>
f43ed9051a7f4db461d67ed4f7ece175b3dbca7cjerenkrantz</modulesynopsis>