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" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p> 19<p class="apache">Apache HTTP Server Version 2.2</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_authz_dbm</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_authz_dbm.html" title="English"> en </a> | 28<a href="/ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 29</div> 30<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using DBM files</td></tr> 31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>authz_dbm_module</td></tr> 33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_authz_dbm.c</td></tr> 34<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table> 35<h3>Summary</h3> 36 37 <p>This module provides authorization capabilities so that 38 authenticated users can be allowed or denied access to portions 39 of the web site by group membership. Similar functionality is 40 provided by <code class="module"><a href="/mod/mod_authz_groupfile.html">mod_authz_groupfile</a></code>.</p> 41</div> 42<div id="quickview"><h3 class="directives">Directives</h3> 43<ul id="toc"> 44<li><img alt="" src="/images/down.gif" /> <a href="#authdbmgroupfile">AuthDBMGroupFile</a></li> 45<li><img alt="" src="/images/down.gif" /> <a href="#authzdbmauthoritative">AuthzDBMAuthoritative</a></li> 46<li><img alt="" src="/images/down.gif" /> <a href="#authzdbmtype">AuthzDBMType</a></li> 47</ul> 48<h3>See also</h3> 49<ul class="seealso"> 50<li><code class="directive"><a href="/mod/core.html#require">Require</a></code></li> 51<li><code class="directive"><a href="/mod/core.html#satisfy">Satisfy</a></code></li> 52</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 53 54<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 55<div class="directive-section"><h2><a name="AuthDBMGroupFile" id="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile" id="authdbmgroupfile">Directive</a></h2> 56<table class="directive"> 57<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the database file containing the list 58of user groups for authorization</td></tr> 59<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMGroupFile <var>file-path</var></code></td></tr> 60<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 61<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 62<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 63<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr> 64</table> 65 <p>The <code class="directive">AuthDBMGroupFile</code> directive sets the 66 name of a DBM file containing the list of user groups for user 67 authorization. <var>File-path</var> is the absolute path to the 68 group file.</p> 69 70 <p>The group file is keyed on the username. The value for a 71 user is a comma-separated list of the groups to which the users 72 belongs. There must be no whitespace within the value, and it 73 must never contain any colons.</p> 74 75 <div class="warning"><h3>Security</h3> 76 <p>Make sure that the <code class="directive">AuthDBMGroupFile</code> is 77 stored outside the document tree of the web-server. Do 78 <strong>not</strong> put it in the directory that it protects. 79 Otherwise, clients will be able to download the 80 <code class="directive">AuthDBMGroupFile</code> unless otherwise 81 protected.</p> 82 </div> 83 84 <p>Combining Group and Password DBM files: In some cases it is 85 easier to manage a single database which contains both the 86 password and group details for each user. This simplifies any 87 support programs that need to be written: they now only have to 88 deal with writing to and locking a single DBM file. This can be 89 accomplished by first setting the group and password files to 90 point to the same DBM:</p> 91 92 <div class="example"><p><code> 93 AuthDBMGroupFile /www/userbase<br /> 94 AuthDBMUserFile /www/userbase 95 </code></p></div> 96 97 <p>The key for the single DBM is the username. The value consists 98 of</p> 99 100 <div class="example"><p><code> 101 Encrypted Password : List of Groups [ : (ignored) ] 102 </code></p></div> 103 104 <p>The password section contains the encrypted 105 password as before. This is followed by a colon and the comma 106 separated list of groups. Other data may optionally be left in the 107 DBM file after another colon; it is ignored by the authorization 108 module. This is what www.telescope.org uses for its combined 109 password and group database.</p> 110 111</div> 112<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 113<div class="directive-section"><h2><a name="AuthzDBMAuthoritative" id="AuthzDBMAuthoritative">AuthzDBMAuthoritative</a> <a name="authzdbmauthoritative" id="authzdbmauthoritative">Directive</a></h2> 114<table class="directive"> 115<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization will be passed on to lower level 116modules</td></tr> 117<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMAuthoritative On|Off</code></td></tr> 118<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMAuthoritative On</code></td></tr> 119<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 120<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 121<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 122<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr> 123</table> 124 <p>Setting the <code class="directive">AuthzDBMAuthoritative</code> 125 directive explicitly to <code>Off</code> allows group authorization 126 to be passed on to lower level modules (as defined in the 127 <code>modules.c</code> file) if there is no group found 128 for the supplied userID. If there are any groups 129 specified, the usual checks will be applied and a failure will 130 give an Authentication Required reply.</p> 131 132 <p>So if a userID appears in the database of more than one module; 133 or if a valid <code class="directive"><a href="/mod/core.html#require">Require</a></code> 134 directive applies to more than one module; then the first module 135 will verify the credentials; and no access is passed on; 136 regardless of the <code class="directive">AuthAuthoritative</code> setting.</p> 137 138 <p>A common use for this is in conjunction with one of the 139 auth providers; such as <code class="module"><a href="/mod/mod_authn_dbm.html">mod_authn_dbm</a></code> or 140 <code class="module"><a href="/mod/mod_authn_file.html">mod_authn_file</a></code>. Whereas this DBM module supplies 141 the bulk of the user credential checking; a few (administrator) related 142 accesses fall through to a lower level with a well protected 143 <code>.htpasswd</code> file.</p> 144 145 <p>By default, control is not passed on and an unknown group 146 will result in an Authentication Required reply. Not 147 setting it thus keeps the system secure and forces an NCSA 148 compliant behaviour.</p> 149 150 <div class="warning"><h3>Security</h3> 151 <p>Do consider the implications of allowing a user to 152 allow fall-through in his .htaccess file; and verify that this 153 is really what you want; Generally it is easier to just secure 154 a single <code>.htpasswd</code> file, than it is to secure a 155 database which might have more access interfaces.</p> 156 </div> 157 158</div> 159<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 160<div class="directive-section"><h2><a name="AuthzDBMType" id="AuthzDBMType">AuthzDBMType</a> <a name="authzdbmtype" id="authzdbmtype">Directive</a></h2> 161<table class="directive"> 162<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to 163store list of user groups</td></tr> 164<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr> 165<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMType default</code></td></tr> 166<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 167<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 168<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 169<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr> 170</table> 171 <p>Sets the type of database file that is used to store the list 172 of user groups. 173 The default database type is determined at compile time. The 174 availability of other types of database files also depends on 175 <a href="/install.html#dbm">compile-time settings</a>.</p> 176 177 <p>It is crucial that whatever program you use to create your group 178 files is configured to use the same type of database.</p> 179 180</div> 181</div> 182<div class="bottomlang"> 183<p><span>Available Languages: </span><a href="/en/mod/mod_authz_dbm.html" title="English"> en </a> | 184<a href="/ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 185</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 186<script type="text/javascript"><!--//--><![CDATA[//><!-- 187var comments_shortname = 'httpd'; 188var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_authz_dbm.html'; 189(function(w, d) { 190 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 191 d.write('<div id="comments_thread"><\/div>'); 192 var s = d.createElement('script'); 193 s.type = 'text/javascript'; 194 s.async = true; 195 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 196 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 197 } 198 else { 199 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 200 } 201})(window, document); 202//--><!]]></script></div><div id="footer"> 203<p class="apache">Copyright 2013 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> 204<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 205if (typeof(prettyPrint) !== 'undefined') { 206 prettyPrint(); 207} 208//--><!]]></script> 209</body></html>
