1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org" />
<title>Apache module mod_auth_db</title>
</head>
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
<body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#000080" alink="#FF0000">
<!--#include virtual="header.html" -->
<h1 align="CENTER">Module mod_auth_db</h1>
<p>This module provides for user authentication using Berkeley
DB files.</p>
<p><a href="module-dict.html#Status"
rel="Help"><strong>Status:</strong></a> Extension<br />
<a href="module-dict.html#SourceFile"
rel="Help"><strong>Source File:</strong></a>
mod_auth_db.c<br />
<a href="module-dict.html#ModuleIdentifier"
rel="Help"><strong>Module Identifier:</strong></a>
auth_db_module</p>
<h2>Summary</h2>
<p>This module provides an alternative to <a
href="mod_auth_dbm.html">DBM</a> files for those systems which
support DB and not DBM. It is only available in Apache 1.1 and
later.</p>
<p>On some BSD systems (<em>e.g.</em>, FreeBSD and NetBSD) dbm
is automatically mapped to Berkeley DB. You can use either <a
href="mod_auth_dbm.html">mod_auth_dbm</a> or mod_auth_db. The
latter makes it more obvious that it's Berkeley DB. On other
platforms where you want to use the DB library you usually have
to install it first. See <a
href="http://www.sleepycat.com/">http://www.sleepycat.com/</a>
for the distribution. The interface this module uses is the one
from DB version 1.85 and 1.86, but DB version 2.x can also be
used when compatibility mode is enabled.</p>
<h2>Directives</h2>
<ul>
<li><a href="#authdbgroupfile">AuthDBGroupFile</a></li>
<li><a href="#authdbuserfile">AuthDBUserFile</a></li>
<li><a
href="#authdbauthoritative">AuthDBAuthoritative</a></li>
</ul>
<p>See also: <a href="core.html#satisfy">satisfy</a> and <a
href="core.html#require">require</a>.</p>
<hr />
<h2><a id="authdbgroupfile"
name="authdbgroupfile">AuthDBGroupFile directive</a></h2>
<!--%plaintext <?INDEX {\tt AuthDBGroupFile} directive> -->
<a href="directive-dict.html#Syntax"
rel="Help"><strong>Syntax:</strong></a> AuthDBGroupFile
<em>file-path</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 AuthDBGroupFile directive sets the name of a DB file
containing the list of user groups for user authentication.
<em>File-path</em> is the absolute path to the group file.</p>
<p>The group file is keyed on the username. The value for a
user is a comma-separated list of the groups to which the users
belongs. There must be no whitespace within the value, and it
must never contain any colons.</p>
<p>Security: make sure that the AuthDBGroupFile 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 AuthDBGroupFile unless otherwise
protected.</p>
<p>Combining Group and Password DB files: In some cases it is
easier to manage a single database which contains both the
password and group details for each user. This simplifies any
support programs that need to be written: they now only have to
deal with writing to and locking a single DBM file. This can be
accomplished by first setting the group and 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
<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 id="authdbuserfile"
name="authdbuserfile">AuthDBUserFile</a> directive</h2>
<!--%plaintext <?INDEX {\tt AuthDBUserFile} directive> -->
<a href="directive-dict.html#Syntax"
rel="Help"><strong>Syntax:</strong></a> AuthDBUserFile
<em>file-path</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>File-path</em> is the absolute path to the
user file.</p>
<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>
<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>
<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>
<p>A perl script called
href="../programs/dbmmanage.html">dbmmanage is included with
Apache. This program can be used to create and update DB format
password files for use with this module.</p>
See also <a href="core.html#authname">AuthName</a>, <a
href="core.html#authtype">AuthType</a> and <a
href="#authdbgroupfile">AuthDBGroupFile</a>.
<hr />
<h2><a id="authdbauthoritative"
name="authdbauthoritative">AuthDBAuthoritative</a>
directive</h2>
<!--%plaintext <?INDEX {\tt AuthDBAuthoritative} directive> -->
<a href="directive-dict.html#Syntax"
rel="Help"><strong>Syntax:</strong></a> AuthDBAuthoritative
on|off<br />
<a href="directive-dict.html#Default"
rel="Help"><strong>Default:</strong></a>
<code>AuthDBAuthoritative on</code><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>
<p>So if a userID appears in the database of more than one
module; or if a valid <code>Require</code> 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>
<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>
<p>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>
<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>
<p>See also <a href="core.html#authname">AuthName</a>, <a
href="core.html#authtype">AuthType</a> and <a
href="#authdbgroupfile">AuthDBGroupFile</a>.</p>
<p><!--#include virtual="footer.html" -->
</p>
</body>
</html>
|
