f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter This file is generated from xml source: DO NOT EDIT
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<title>mod_authz_dbm - Apache HTTP Server Version 2.5</title>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<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" />
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<script src="/style/scripts/prettify.min.js" type="text/javascript">
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<link href="/images/favicon.ico" rel="shortcut icon" /></head>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.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>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<p class="apache">Apache HTTP Server Version 2.5</p>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<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.5</a> > <a href="./">Modules</a></div>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<div id="preamble"><h1>Apache Module mod_authz_dbm</h1>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<p><span>Available Languages: </span><a href="/en/mod/mod_authz_dbm.html" title="English"> en </a> |
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<a href="/fr/mod/mod_authz_dbm.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<a href="/ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using DBM files</td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>authz_dbm_module</td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_authz_dbm.c</td></tr></table>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>This module provides authorization capabilities so that
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter authenticated users can be allowed or denied access to portions
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter of the web site by group membership. Similar functionality is
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter provided by <code class="module"><a href="/mod/mod_authz_groupfile.html">mod_authz_groupfile</a></code>.</p>
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<li><img alt="" src="/images/down.gif" /> <a href="#requiredirectives">The Require Directives</a></li>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<li><img alt="" src="/images/down.gif" /> <a href="#examples">Example usage</a></li>
80d0bd38268c02fd32f62b02ae59f19229ca1a79Pavel Březina<li><img alt="" src="/images/down.gif" /> <a href="#authdbmgroupfile">AuthDBMGroupFile</a></li>
f7adbb15dbdcb79e291f7cf361a400ce25f7b382Pavel Březina<li><img alt="" src="/images/down.gif" /> <a href="#authzdbmtype">AuthzDBMType</a></li>
80d0bd38268c02fd32f62b02ae59f19229ca1a79Pavel Březina<li><code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code></li>
80d0bd38268c02fd32f62b02ae59f19229ca1a79Pavel Březina</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
b742179ac0790068380618ab72a06af18544f09cPavel Březina<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
b742179ac0790068380618ab72a06af18544f09cPavel Březina<h2><a name="requiredirectives" id="requiredirectives">The Require Directives</a></h2>
b742179ac0790068380618ab72a06af18544f09cPavel Březina <p>Apache's <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code>
b742179ac0790068380618ab72a06af18544f09cPavel Březina directives are used during the authorization phase to ensure that
b742179ac0790068380618ab72a06af18544f09cPavel Březina a user is allowed to access a resource. mod_authz_dbm extends the
b742179ac0790068380618ab72a06af18544f09cPavel Březina authorization types with <code>dbm-group</code>.</p>
b742179ac0790068380618ab72a06af18544f09cPavel Březina <p>Since v2.4.8, <a href="/expr.html">expressions</a> are supported
b742179ac0790068380618ab72a06af18544f09cPavel Březina within the DBM require directives.</p>
b742179ac0790068380618ab72a06af18544f09cPavel Březina<h3><a name="reqgroup" id="reqgroup">Require dbm-group</a></h3>
b742179ac0790068380618ab72a06af18544f09cPavel Březina <p>This directive specifies group membership that is required for the
b742179ac0790068380618ab72a06af18544f09cPavel Březina user to gain access.</p>
80d0bd38268c02fd32f62b02ae59f19229ca1a79Pavel Březina <pre class="prettyprint lang-config">Require dbm-group admin</pre>
42c28b9424b6ef8a0021b124773e171dd5defaddJakub Hrozek<h3><a name="reqfilegroup" id="reqfilegroup">Require dbm-file-group</a></h3>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>When this directive is specified, the user must be a member of the group
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter assigned to the file being accessed.</p>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter <pre class="prettyprint lang-config">Require dbm-file-group</pre>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<h2><a name="examples" id="examples">Example usage</a></h2>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<p><em>Note that using mod_authz_dbm requires you to require <code>dbm-group</code>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<pre class="prettyprint lang-config"><Directory "/foo/bar">
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter AuthType Basic
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter AuthName "Secure Area"
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter AuthBasicProvider dbm
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter Require dbm-group admin
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek</Directory></pre>
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<div class="directive-section"><h2><a name="AuthDBMGroupFile" id="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile" id="authdbmgroupfile">Directive</a></h2>
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the database file containing the list
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMGroupFile <var>file-path</var></code></td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>The <code class="directive">AuthDBMGroupFile</code> directive sets the
4f7f714e118e95896fac5239c7a8b529c39a4758Jakub Hrozek name of a DBM file containing the list of user groups for user
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter authorization. <var>File-path</var> is the absolute path to the
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter group file.</p>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>The group file is keyed on the username. The value for a
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter user is a comma-separated list of the groups to which the users
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter belongs. There must be no whitespace within the value, and it
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter must never contain any colons.</p>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>Make sure that the <code class="directive">AuthDBMGroupFile</code> is
66277b21179d95f6e96abed01a20ccbccf27ce99Pavel Březina stored outside the document tree of the web-server. Do
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <strong>not</strong> put it in the directory that it protects.
71c9027d4192bf149afa4fcf9fef93bf6e901121Pavel Březina Otherwise, clients will be able to download the
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <code class="directive">AuthDBMGroupFile</code> unless otherwise
71c9027d4192bf149afa4fcf9fef93bf6e901121Pavel Březina protected.</p>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>Combining Group and Password DBM files: In some cases it is
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter easier to manage a single database which contains both the
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter password and group details for each user. This simplifies any
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter support programs that need to be written: they now only have to
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter deal with writing to and locking a single DBM file. This can be
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter accomplished by first setting the group and password files to
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter point to the same DBM:</p>
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <pre class="prettyprint lang-config">AuthDBMGroupFile "/www/userbase"
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>The key for the single DBM is the username. The value consists
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter Encrypted Password : List of Groups [ : (ignored) ]
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter <p>The password section contains the encrypted
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter password as before. This is followed by a colon and the comma
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter separated list of groups. Other data may optionally be left in the
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter DBM file after another colon; it is ignored by the authorization
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter module. This is what www.telescope.org uses for its combined
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter password and group database.</p>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<div class="directive-section"><h2><a name="AuthzDBMType" id="AuthzDBMType">AuthzDBMType</a> <a name="authzdbmtype" id="authzdbmtype">Directive</a></h2>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMType default</code></td></tr>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter <p>Sets the type of database file that is used to store the list
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter of user groups.
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter The default database type is determined at compile time. The
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter availability of other types of database files also depends on
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter <a href="/install.html#dbm">compile-time settings</a>.</p>
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter <p>It is crucial that whatever program you use to create your group
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek files is configured to use the same type of database.</p>
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<p><span>Available Languages: </span><a href="/en/mod/mod_authz_dbm.html" title="English"> en </a> |
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<a href="/fr/mod/mod_authz_dbm.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<a href="/ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek</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>
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek<script type="text/javascript"><!--//--><![CDATA[//><!--
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Waltervar comments_shortname = 'httpd';
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Waltervar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authz_dbm.html';
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter(function(w, d) {
06b7bc8ca2e005ed510210d3b8dee16afbabbcc9Stef Walter if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
6b01dae732eedee808f32a9cdd4b5656a9f839c4Jakub Hrozek d.write('<div id="comments_thread"><\/div>');
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter var s = d.createElement('script');
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
626d8217a2e578ba641ae3c968752aa15284a210Petr Čech d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter})(window, document);
9fa95168d80beba04b333b06edc492ecb8b085a1Pavel Březina<p class="apache">Copyright 2015 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>
626d8217a2e578ba641ae3c968752aa15284a210Petr Čech<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.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[//><!--
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walterif (typeof(prettyPrint) !== 'undefined') {
f5e47e1d65f80ffdb1893feab18583a74d661214Stef Walter prettyPrint();