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 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.4.8, <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">Require dbm-group admin</pre>
  73
  74
  75
  76
  77 <h3><a name="reqfilegroup" id="reqfilegroup">Require dbm-file-group</a></h3>
  78
  79     <p>When this directive is specified, the user must be a member of the group
  80     assigned to the file being accessed.</p>
  81
  82     <pre class="prettyprint lang-config">Require dbm-file-group</pre>
  83
  84
  85
  86
  87 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  88 <div class="section">
  89 <h2><a name="examples" id="examples">Example usage</a></h2>
  90
  91 <p><em>Note that using mod_authz_dbm requires you to require <code>dbm-group</code>
  92 instead of <code>group</code>:</em>
  93 </p>
  94 <pre class="prettyprint lang-config">&lt;Directory "/foo/bar"&gt;
  95   AuthType Basic
  96   AuthName "Secure Area"
  97   AuthBasicProvider dbm
  98   AuthDBMUserFile "site/data/users"
  99   AuthDBMGroupFile "site/data/users"
 100   Require dbm-group admin
 101 &lt;/Directory&gt;</pre>
 102
 103 </div>
 104 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 105 <div class="directive-section"><h2><a name="AuthDBMGroupFile" id="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile" id="authdbmgroupfile">Directive</a></h2>
 106 <table class="directive">
 107 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the database file containing the list
 108 of user groups for authorization</td></tr>
 109 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMGroupFile <var>file-path</var></code></td></tr>
 110 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 111 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 112 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 113 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 114 </table>
 115     <p>The <code class="directive">AuthDBMGroupFile</code> directive sets the
 116     name of a DBM file containing the list of user groups for user
 117     authorization.  <var>File-path</var> is the absolute path to the
 118     group file.</p>
 119
 120     <p>The group file is keyed on the username. The value for a
 121     user is a comma-separated list of the groups to which the users
 122     belongs. There must be no whitespace within the value, and it
 123     must never contain any colons.</p>
 124
 125     <div class="warning"><h3>Security</h3>
 126       <p>Make sure that the <code class="directive">AuthDBMGroupFile</code> is
 127       stored outside the document tree of the web-server. Do
 128       <strong>not</strong> put it in the directory that it protects.
 129       Otherwise, clients will be able to download the
 130       <code class="directive">AuthDBMGroupFile</code> unless otherwise
 131       protected.</p>
 132     </div>
 133
 134     <p>Combining Group and Password DBM files: In some cases it is
 135     easier to manage a single database which contains both the
 136     password and group details for each user. This simplifies any
 137     support programs that need to be written: they now only have to
 138     deal with writing to and locking a single DBM file. This can be
 139     accomplished by first setting the group and password files to
 140     point to the same DBM:</p>
 141
 142     <pre class="prettyprint lang-config">AuthDBMGroupFile "/www/userbase"
 143 AuthDBMUserFile "/www/userbase"</pre>
 144
 145
 146     <p>The key for the single DBM is the username. The value consists
 147     of</p>
 148
 149     <div class="example"><p><code>
 150       Encrypted Password : List of Groups [ : (ignored) ]
 151     </code></p></div>
 152
 153     <p>The password section contains the encrypted
 154     password as before. This is followed by a colon and the comma
 155     separated list of groups. Other data may optionally be left in the
 156     DBM file after another colon; it is ignored by the authorization
 157     module. This is what www.telescope.org uses for its combined
 158     password and group database.</p>
 159
 160 </div>
 161 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 162 <div class="directive-section"><h2><a name="AuthzDBMType" id="AuthzDBMType">AuthzDBMType</a> <a name="authzdbmtype" id="authzdbmtype">Directive</a></h2>
 163 <table class="directive">
 164 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
 165 store list of user groups</td></tr>
 166 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
 167 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMType default</code></td></tr>
 168 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 169 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 170 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 171 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 172 </table>
 173     <p>Sets the type of database file that is used to store the list
 174     of user groups.
 175     The default database type is determined at compile time.  The
 176     availability of other types of database files also depends on
 177     <a href="../install.html#dbm">compile-time settings</a>.</p>
 178
 179     <p>It is crucial that whatever program you use to create your group
 180     files is configured to use the same type of database.</p>
 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>