~ubuntu-branches/ubuntu/feisty/apache2/feisty

« back to all changes in this revision

Viewing changes to docs/manual/mod/mod_authz_dbm.html.en

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Barth
  • Date: 2006-12-09 21:05:45 UTC
  • mfrom: (0.6.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061209210545-h70s0xaqc2v8vqr2
Tags: 2.2.3-3.2
* Non-maintainer upload.
* 043_ajp_connection_reuse: Patch from upstream Bugzilla, fixing a critical
  issue with regard to connection reuse in mod_proxy_ajp.
  Closes: #396265

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
3
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
 
4
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
5
              This file is generated from xml source: DO NOT EDIT
 
6
        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
7
      -->
 
8
<title>mod_authz_dbm - Apache HTTP Server</title>
 
9
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
 
10
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
 
11
<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
 
12
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
 
13
<body>
 
14
<div id="page-header">
 
15
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
 
16
<p class="apache">Apache HTTP Server Version 2.2</p>
 
17
<img alt="" src="../images/feather.gif" /></div>
 
18
<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
 
19
<div id="path">
 
20
<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.2</a> &gt; <a href="./">Modules</a></div>
 
21
<div id="page-content">
 
22
<div id="preamble"><h1>Apache Module mod_authz_dbm</h1>
 
23
<div class="toplang">
 
24
<p><span>Available Languages: </span><a href="../en/mod/mod_authz_dbm.html" title="English">&nbsp;en&nbsp;</a> |
 
25
<a href="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
26
</div>
 
27
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using DBM files</td></tr>
 
28
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 
29
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>authz_dbm_module</td></tr>
 
30
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_authz_dbm.c</td></tr>
 
31
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
 
32
<h3>Summary</h3>
 
33
 
 
34
    <p>This module provides authorization capabilities so that
 
35
       authenticated users can be allowed or denied access to portions
 
36
       of the web site by group membership. Similar functionality is
 
37
       provided by <code class="module"><a href="../mod/mod_authz_groupfile.html">mod_authz_groupfile</a></code>.</p>
 
38
</div>
 
39
<div id="quickview"><h3 class="directives">Directives</h3>
 
40
<ul id="toc">
 
41
<li><img alt="" src="../images/down.gif" /> <a href="#authdbmgroupfile">AuthDBMGroupFile</a></li>
 
42
<li><img alt="" src="../images/down.gif" /> <a href="#authzdbmauthoritative">AuthzDBMAuthoritative</a></li>
 
43
<li><img alt="" src="../images/down.gif" /> <a href="#authzdbmtype">AuthzDBMType</a></li>
 
44
</ul>
 
45
<h3>See also</h3>
 
46
<ul class="seealso">
 
47
<li><code class="directive"><a href="../mod/core.html#require">Require</a></code></li>
 
48
<li><code class="directive"><a href="../mod/core.html#satisfy">Satisfy</a></code></li>
 
49
</ul></div>
 
50
 
 
51
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
52
<div class="directive-section"><h2><a name="AuthDBMGroupFile" id="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile" id="authdbmgroupfile">Directive</a></h2>
 
53
<table class="directive">
 
54
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the database file containing the list
 
55
of user groups for authorization</td></tr>
 
56
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMGroupFile <var>file-path</var></code></td></tr>
 
57
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 
58
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 
59
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 
60
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 
61
</table>
 
62
    <p>The <code class="directive">AuthDBMGroupFile</code> directive sets the
 
63
    name of a DBM file containing the list of user groups for user
 
64
    authorization.  <var>File-path</var> is the absolute path to the
 
65
    group file.</p>
 
66
 
 
67
    <p>The group file is keyed on the username. The value for a
 
68
    user is a comma-separated list of the groups to which the users
 
69
    belongs. There must be no whitespace within the value, and it
 
70
    must never contain any colons.</p>
 
71
 
 
72
    <div class="warning"><h3>Security</h3>
 
73
      <p>Make sure that the <code class="directive">AuthDBMGroupFile</code> is
 
74
      stored outside the document tree of the web-server. Do
 
75
      <strong>not</strong> put it in the directory that it protects.
 
76
      Otherwise, clients will be able to download the
 
77
      <code class="directive">AuthDBMGroupFile</code> unless otherwise
 
78
      protected.</p>
 
79
    </div>
 
80
 
 
81
    <p>Combining Group and Password DBM files: In some cases it is
 
82
    easier to manage a single database which contains both the
 
83
    password and group details for each user. This simplifies any
 
84
    support programs that need to be written: they now only have to
 
85
    deal with writing to and locking a single DBM file. This can be
 
86
    accomplished by first setting the group and password files to
 
87
    point to the same DBM:</p>
 
88
 
 
89
    <div class="example"><p><code>
 
90
      AuthDBMGroupFile /www/userbase<br />
 
91
      AuthDBMUserFile /www/userbase
 
92
    </code></p></div>
 
93
 
 
94
    <p>The key for the single DBM is the username. The value consists
 
95
    of</p>
 
96
 
 
97
    <div class="example"><p><code>
 
98
      Encrypted Password : List of Groups [ : (ignored) ]
 
99
    </code></p></div>
 
100
 
 
101
    <p>The password section contains the encrypted
 
102
    password as before. This is followed by a colon and the comma
 
103
    separated list of groups. Other data may optionally be left in the
 
104
    DBM file after another colon; it is ignored by the authorization
 
105
    module. This is what www.telescope.org uses for its combined
 
106
    password and group database.</p>
 
107
 
 
108
</div>
 
109
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
110
<div class="directive-section"><h2><a name="AuthzDBMAuthoritative" id="AuthzDBMAuthoritative">AuthzDBMAuthoritative</a> <a name="authzdbmauthoritative" id="authzdbmauthoritative">Directive</a></h2>
 
111
<table class="directive">
 
112
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization will be passed on to lower level
 
113
modules</td></tr>
 
114
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMAuthoritative On|Off</code></td></tr>
 
115
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMAuthoritative On</code></td></tr>
 
116
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 
117
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 
118
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 
119
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 
120
</table>
 
121
    <p>Setting the <code class="directive">AuthzDBMAuthoritative</code>
 
122
    directive explicitly to <code>Off</code> allows group authorization
 
123
    to be passed on to lower level modules (as defined in the
 
124
    <code>modules.c</code> file) if there is no group found
 
125
    for the the supplied userID. If there are any groups
 
126
    specified, the usual checks will be applied and a failure will
 
127
    give an Authentication Required reply.</p>
 
128
 
 
129
    <p>So if a userID appears in the database of more than one module;
 
130
    or if a valid <code class="directive"><a href="../mod/core.html#require">Require</a></code>
 
131
    directive applies to more than one module; then the first module
 
132
    will verify the credentials; and no access is passed on;
 
133
    regardless of the <code class="directive">AuthAuthoritative</code> setting.</p>
 
134
 
 
135
    <p>A common use for this is in conjunction with one of the
 
136
    auth providers; such as <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code> or
 
137
    <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>. Whereas this DBM module supplies
 
138
    the bulk of the user credential checking; a few (administrator) related
 
139
    accesses fall through to a lower level with a well protected
 
140
    <code>.htpasswd</code> file.</p>
 
141
 
 
142
    <p>By default, control is not passed on and an unknown group
 
143
    will result in an Authentication Required reply. Not
 
144
    setting it thus keeps the system secure and forces an NCSA
 
145
    compliant behaviour.</p>
 
146
 
 
147
    <div class="warning"><h3>Security</h3>
 
148
      <p>Do consider the implications of allowing a user to
 
149
      allow fall-through in his .htaccess file; and verify that this
 
150
      is really what you want; Generally it is easier to just secure
 
151
      a single <code>.htpasswd</code> file, than it is to secure a
 
152
      database which might have more access interfaces.</p>
 
153
    </div>
 
154
 
 
155
</div>
 
156
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
157
<div class="directive-section"><h2><a name="AuthzDBMType" id="AuthzDBMType">AuthzDBMType</a> <a name="authzdbmtype" id="authzdbmtype">Directive</a></h2>
 
158
<table class="directive">
 
159
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
 
160
store list of user groups</td></tr>
 
161
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
 
162
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMType default</code></td></tr>
 
163
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 
164
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 
165
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 
166
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 
167
</table>
 
168
    <p>Sets the type of database file that is used to store the list
 
169
    of user groups.
 
170
    The default database type is determined at compile time.  The
 
171
    availability of other types of database files also depends on
 
172
    <a href="../install.html#dbm">compile-time settings</a>.</p>
 
173
 
 
174
    <p>It is crucial that whatever program you use to create your group
 
175
    files is configured to use the same type of database.</p>
 
176
 
 
177
</div>
 
178
</div>
 
179
<div class="bottomlang">
 
180
<p><span>Available Languages: </span><a href="../en/mod/mod_authz_dbm.html" title="English">&nbsp;en&nbsp;</a> |
 
181
<a href="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
182
</div><div id="footer">
 
183
<p class="apache">Copyright 2006 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 
184
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 
185
</body></html>
 
 
b'\\ No newline at end of file'