mod_auth_db.html revision fc891500135b18740c60ea32a7ea0a069e8eafd7
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<HTML>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<HEAD>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<TITLE>Apache module mod_auth_db</TITLE>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye</HEAD>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<BODY
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye BGCOLOR="#FFFFFF"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye TEXT="#000000"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye LINK="#0000FF"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye VLINK="#000080"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye ALINK="#FF0000"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<!--#include virtual="header.html" -->
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<H1 ALIGN="CENTER">Module mod_auth_db</H1>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye
227f3e817570457e2b34a36e6ba522a3b224248eTrond NorbyeThis module is contained in the <CODE>mod_auth_db.c</CODE> file, and
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeis not compiled in by default. It provides for user authentication using
227f3e817570457e2b34a36e6ba522a3b224248eTrond NorbyeBerkeley DB files. It is an alternative to <A HREF="mod_auth_dbm.html">DBM</A>
f9fd2b96d1c5ea62664f74da0e34a04b6511a8ffLubos Koscofiles for those systems which support DB and not DBM. It is only
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeavailable in Apache 1.1 and later.
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<P>
227f3e817570457e2b34a36e6ba522a3b224248eTrond NorbyeOn some BSD systems (<EM>e.g.</EM>, FreeBSD and NetBSD) dbm is automatically mapped to
227f3e817570457e2b34a36e6ba522a3b224248eTrond NorbyeBerkeley DB. You can use either <A HREF="mod_auth_dbm.html">mod_auth_dbm</A>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeor mod_auth_db. The latter makes it more obvious that it's Berkeley DB. On
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeother platforms where you want to use the DB library you usually have to
eb32a77fdb57f20c042b7b79b28a4fb4060cb949Lubos Koscoinstall it first. See
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<A HREF="http://www.sleepycat.com/">http://www.sleepycat.com/</A> for the
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyedistribution. The interface this module uses is the one from DB version 1.85
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeand 1.86, but DB version 2.x can also be used when compatibility mode is
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeenabled.
eb32a77fdb57f20c042b7b79b28a4fb4060cb949Lubos Kosco
8dc938f5c6296cffbadd8e06925dc0762dd79c5aLubos Kosco<MENU>
8dc938f5c6296cffbadd8e06925dc0762dd79c5aLubos Kosco<LI><A HREF="#authdbgroupfile">AuthDBGroupFile</A>
8dc938f5c6296cffbadd8e06925dc0762dd79c5aLubos Kosco<LI><A HREF="#authdbuserfile">AuthDBUserFile</A>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<LI><A HREF="#authdbauthoritative">AuthDBAuthoritative</A>
b645988bdc1cf4f2f82b8c00ed041ddddd822c24Lubos Kosco</MENU>
b645988bdc1cf4f2f82b8c00ed041ddddd822c24Lubos Kosco<HR>
f9fd2b96d1c5ea62664f74da0e34a04b6511a8ffLubos Kosco
b645988bdc1cf4f2f82b8c00ed041ddddd822c24Lubos Kosco
b645988bdc1cf4f2f82b8c00ed041ddddd822c24Lubos Kosco<H2><A NAME="authdbgroupfile">AuthDBGroupFile</A></H2>
817883e9f0d419428e8236a09b77cdeeaa034df7Knut Anders Hatlen<!--%plaintext &lt;?INDEX {\tt AuthDBGroupFile} directive&gt; -->
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<A
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye HREF="directive-dict.html#Syntax"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye REL="Help"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye><STRONG>Syntax:</STRONG></A> AuthDBGroupFile <EM>filename</EM><BR>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<A
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye HREF="directive-dict.html#Context"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye REL="Help"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye<A
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders Hatlen HREF="directive-dict.html#Override"
817883e9f0d419428e8236a09b77cdeeaa034df7Knut Anders Hatlen REL="Help"
b645988bdc1cf4f2f82b8c00ed041ddddd822c24Lubos Kosco><STRONG>Override:</STRONG></A> AuthConfig<BR>
eb32a77fdb57f20c042b7b79b28a4fb4060cb949Lubos Kosco<A
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders Hatlen HREF="directive-dict.html#Status"
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders Hatlen REL="Help"
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders Hatlen><STRONG>Status:</STRONG></A> Extension<BR>
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders Hatlen<A
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye HREF="directive-dict.html#Module"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye REL="Help"
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye><STRONG>Module:</STRONG></A> mod_auth_db<P>
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders Hatlen
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders HatlenThe AuthDBGroupFile directive sets the name of a DB file containing the list
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeof user groups for user authentication. <EM>Filename</EM> is the absolute path
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeto the group file.<P>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders HatlenThe group file is keyed on the username. The value for a user is a
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyecomma-separated list of the groups to which the users belongs. There must
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyebe no whitespace within the value, and it must never contain any colons.<P>
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbye
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders HatlenSecurity: make sure that the AuthDBGroupFile is stored outside the
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyedocument tree of the web-server; do <EM>not</EM> put it in the directory that
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeit protects. Otherwise, clients will be able to download the
227f3e817570457e2b34a36e6ba522a3b224248eTrond NorbyeAuthDBGroupFile unless otherwise protected.<P>
3bcef4c7a069f6d4980d579d963243bdfec1c43eKnut Anders Hatlen
227f3e817570457e2b34a36e6ba522a3b224248eTrond NorbyeCombining Group and Password DB files: In some cases it is easier to
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyemanage a single database which contains both the password and group
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyedetails for each user. This simplifies any support programs that need
f9fd2b96d1c5ea62664f74da0e34a04b6511a8ffLubos Koscoto be written: they now only have to deal with writing to and locking
474ac6921d21d2e44cf9c1e91f17d6bcbb15c9e8Lubos Koscoa single DBM file. This can be accomplished by first setting the group
227f3e817570457e2b34a36e6ba522a3b224248eTrond Norbyeand password files to point to the same DB file:<P>
<BLOCKQUOTE><CODE>
AuthDBGroupFile /www/userbase<BR>
AuthDBUserFile /www/userbase
</CODE></BLOCKQUOTE>
The key for the single DB record is the username. The value consists of <P>
<BLOCKQUOTE><CODE>
Unix Crypt-ed Password : List of Groups [ : (ignored) ]
</CODE></BLOCKQUOTE>
The password section contains the Unix crypt() password as before. This is
followed by a colon and the comma separated list of groups. Other data may
optionally be left in the DB file after another colon; it is ignored by the
authentication module. <P>
See also <A HREF="core.html#authname">AuthName</A>,
<A HREF="core.html#authtype">AuthType</A> and
<A HREF="#authdbuserfile">AuthDBUserFile</A>.<P><HR>
<H2><A NAME="authdbuserfile">AuthDBUserFile</A></H2>
<!--%plaintext &lt;?INDEX {\tt AuthDBUserFile} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AuthDBUserFile <EM>filename</EM><BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
<A
HREF="directive-dict.html#Override"
REL="Help"
><STRONG>Override:</STRONG></A> AuthConfig<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Extension<BR>
<A
HREF="directive-dict.html#Module"
REL="Help"
><STRONG>Module:</STRONG></A> mod_auth_db<P>
The AuthDBUserFile directive sets the name of a DB file containing the list
of users and passwords for user authentication. <EM>Filename</EM> is the
absolute path to the user file.<P>
The user file is keyed on the username. The value for a user is the
crypt() encrypted password, optionally followed by a colon and
arbitrary data. The colon and the data following it will be ignored
by the server.<P>
Security: make sure that the AuthDBUserFile is stored outside the
document tree of the web-server; do <EM>not</EM> put it in the directory that
it protects. Otherwise, clients will be able to download the
AuthDBUserFile.<P>
Important compatibility note: The implementation of "dbmopen" in the
apache modules reads the string length of the hashed values from the
DB data structures, rather than relying upon the string being
NULL-appended. Some applications, such as the Netscape web server,
rely upon the string being NULL-appended, so if you are having trouble
using DB files interchangeably between applications this may be a
part of the problem. <P>
See also <A HREF="core.html#authname">AuthName</A>,
<A HREF="core.html#authtype">AuthType</A> and
<A HREF="#authdbgroupfile">AuthDBGroupFile</A>.<P>
<HR>
<H2><A NAME="authdbauthoritative">AuthDBAuthoritative</A></H2>
<!--%plaintext &lt;?INDEX {\tt AuthDBAuthoritative} directive&gt; -->
<A
HREF="directive-dict.html#Syntax"
REL="Help"
><STRONG>Syntax:</STRONG></A> AuthDBAuthoritative &lt;
<STRONG> on</STRONG>(default) | off &gt; <BR>
<A
HREF="directive-dict.html#Context"
REL="Help"
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
<A
HREF="directive-dict.html#Override"
REL="Help"
><STRONG>Override:</STRONG></A> AuthConfig<BR>
<A
HREF="directive-dict.html#Status"
REL="Help"
><STRONG>Status:</STRONG></A> Base<BR>
<A
HREF="directive-dict.html#Module"
REL="Help"
><STRONG>Module:</STRONG></A> mod_auth<P>
Setting the AuthDBAuthoritative directive explicitly to <STRONG>'off'</STRONG>
allows for both authentication and authorization to be passed on
to lower level modules (as defined in the <CODE>Configuration</CODE>
and <CODE>modules.c</CODE> file if there is <STRONG>no userID</STRONG> or
<STRONG>rule</STRONG> matching the supplied userID. If there is a userID
and/or rule specified; the usual password and access checks will
be applied and a failure will give an Authorization Required reply.
<P>
So if a userID appears in the database of more than one module; or
if a valid require directive applies to more than one module; then
the first module will verify the credentials; and no access is
passed on; regardless of the AuthAuthoritative setting. <P>
A common use for this is in conjunction with one of the basic auth
modules; such as <A HREF="mod_auth.html"><CODE>mod_auth.c</CODE></A>.
Whereas this DB module supplies the bulk of the user credential
checking; a few (administrator) related accesses fall through to
a lower level with a well protected .htpasswd file. <P>
<A
HREF="directive-dict.html#Default"
REL="Help"
><STRONG>Default:</STRONG></A> By default; control is not passed on; and an
unknown
userID or rule will result in an Authorization Required reply. Not
setting it thus keeps the system secure; and forces an NCSA compliant
behaviour. <P>
Security: Do consider the implications of allowing a user to allow
fall-through in his .htaccess file; and verify that this is really
what you want; Generally it is easier to just secure a single
.htpasswd file, than it is to secure a database which might have
more access interfaces.
<P>
See also <A HREF="core.html#authname">AuthName</A>,
<A HREF="core.html#authtype">AuthType</A> and
<A HREF="#authdbgroupfile">AuthDBGroupFile</A>.<P>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>