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