granicus.if.org Git - apache/blob - docs/manual/mod/mod_authz_dbm.html.en

   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.min.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/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>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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.5</a> &gt; <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">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_authz_dbm.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using DBM files</td></tr>
  32 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  33 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_dbm_module</td></tr>
  34 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_dbm.c</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="#authzdbmtype">AuthzDBMType</a></li>
  46 </ul>
  47 <h3>Topics</h3>
  48 <ul id="topics">
  49 <li><img alt="" src="../images/down.gif" /> <a href="#requiredirectives">The Require Directives</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Example usage</a></li>
  51 </ul><h3>See also</h3>
  52 <ul class="seealso">
  53 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
  54 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  55 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  56 <div class="section">
  57 <h2><a name="requiredirectives" id="requiredirectives">The Require Directives</a></h2>
  58
  59     <p>Apache's <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code>
  60     directives are used during the authorization phase to ensure that
  61     a user is allowed to access a resource.  mod_authz_dbm extends the
  62     authorization types with <code>dbm-group</code>.</p>
  63
  64     <p>Since v2.5.0, <a href="../expr.html">expressions</a> are supported
  65     within the DBM require directives.</p>
  66
  67 <h3><a name="reqgroup" id="reqgroup">Require dbm-group</a></h3>
  68
  69     <p>This directive specifies group membership that is required for the
  70     user to gain access.</p>
  71
  72     <pre class="prettyprint lang-config">
  73       Require dbm-group admin
  74     </pre>
  75
  76
  77
  78
  79 <h3><a name="reqfilegroup" id="reqfilegroup">Require dbm-file-group</a></h3>
  80
  81     <p>When this directive is specified, the user must be a member of the group
  82     assigned to the file being accessed.</p>
  83
  84     <pre class="prettyprint lang-config">
  85       Require dbm-file-group
  86     </pre>
  87
  88
  89
  90
  91 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  92 <div class="section">
  93 <h2><a name="examples" id="examples">Example usage</a></h2>
  94
  95 <p><em>Note that using mod_authz_dbm requires you to require <code>dbm-group</code>
  96 instead of <code>group</code>:</em>
  97 </p>
  98 <pre class="prettyprint lang-config">
  99 &lt;Directory "/foo/bar"&gt;
 100   AuthType Basic
 101   AuthName "Secure Area"
 102   AuthBasicProvider dbm
 103   AuthDBMUserFile site/data/users
 104   AuthDBMGroupFile site/data/users
 105   Require dbm-group admin
 106 &lt;/Directory&gt;
 107 </pre>
 108
 109 </div>
 110 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 111 <div class="directive-section"><h2><a name="AuthDBMGroupFile" id="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile" id="authdbmgroupfile">Directive</a></h2>
 112 <table class="directive">
 113 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the database file containing the list
 114 of user groups for authorization</td></tr>
 115 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMGroupFile <var>file-path</var></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>The <code class="directive">AuthDBMGroupFile</code> directive sets the
 122     name of a DBM file containing the list of user groups for user
 123     authorization.  <var>File-path</var> is the absolute path to the
 124     group file.</p>
 125
 126     <p>The group file is keyed on the username. The value for a
 127     user is a comma-separated list of the groups to which the users
 128     belongs. There must be no whitespace within the value, and it
 129     must never contain any colons.</p>
 130
 131     <div class="warning"><h3>Security</h3>
 132       <p>Make sure that the <code class="directive">AuthDBMGroupFile</code> is
 133       stored outside the document tree of the web-server. Do
 134       <strong>not</strong> put it in the directory that it protects.
 135       Otherwise, clients will be able to download the
 136       <code class="directive">AuthDBMGroupFile</code> unless otherwise
 137       protected.</p>
 138     </div>
 139
 140     <p>Combining Group and Password DBM files: In some cases it is
 141     easier to manage a single database which contains both the
 142     password and group details for each user. This simplifies any
 143     support programs that need to be written: they now only have to
 144     deal with writing to and locking a single DBM file. This can be
 145     accomplished by first setting the group and password files to
 146     point to the same DBM:</p>
 147
 148     <pre class="prettyprint lang-config">
 149 AuthDBMGroupFile /www/userbase
 150 AuthDBMUserFile /www/userbase
 151     </pre>
 152
 153
 154     <p>The key for the single DBM is the username. The value consists
 155     of</p>
 156
 157     <div class="example"><p><code>
 158       Encrypted Password : List of Groups [ : (ignored) ]
 159     </code></p></div>
 160
 161     <p>The password section contains the encrypted
 162     password as before. This is followed by a colon and the comma
 163     separated list of groups. Other data may optionally be left in the
 164     DBM file after another colon; it is ignored by the authorization
 165     module. This is what www.telescope.org uses for its combined
 166     password and group database.</p>
 167
 168 </div>
 169 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 170 <div class="directive-section"><h2><a name="AuthzDBMType" id="AuthzDBMType">AuthzDBMType</a> <a name="authzdbmtype" id="authzdbmtype">Directive</a></h2>
 171 <table class="directive">
 172 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
 173 store list of user groups</td></tr>
 174 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
 175 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMType default</code></td></tr>
 176 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 177 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 178 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 179 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 180 </table>
 181     <p>Sets the type of database file that is used to store the list
 182     of user groups.
 183     The default database type is determined at compile time.  The
 184     availability of other types of database files also depends on
 185     <a href="../install.html#dbm">compile-time settings</a>.</p>
 186
 187     <p>It is crucial that whatever program you use to create your group
 188     files is configured to use the same type of database.</p>
 189
 190 </div>
 191 </div>
 192 <div class="bottomlang">
 193 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_dbm.html" title="English">&nbsp;en&nbsp;</a> |
 194 <a href="../fr/mod/mod_authz_dbm.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 195 <a href="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 196 </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&amp;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>
 197 <script type="text/javascript"><!--//--><![CDATA[//><!--
 198 var comments_shortname = 'httpd';
 199 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authz_dbm.html';
 200 (function(w, d) {
 201     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 202         d.write('<div id="comments_thread"><\/div>');
 203         var s = d.createElement('script');
 204         s.type = 'text/javascript';
 205         s.async = true;
 206         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 207         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 208     }
 209     else {
 210         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 211     }
 212 })(window, document);
 213 //--><!]]></script></div><div id="footer">
 214 <p class="apache">Copyright 2014 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>
 215 <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[//><!--
 216 if (typeof(prettyPrint) !== 'undefined') {
 217     prettyPrint();
 218 }
 219 //--><!]]></script>
 220 </body></html>