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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_authz_dbm - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_authz_dbm</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_dbm.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_authz_dbm.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  32 </div>
  33 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using DBM files</td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_dbm_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_dbm.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>This module provides authorization capabilities so that
  40        authenticated users can be allowed or denied access to portions
  41        of the web site by group membership. Similar functionality is
  42        provided by <code class="module"><a href="../mod/mod_authz_groupfile.html">mod_authz_groupfile</a></code>.</p>
  43 </div>
  44 <div id="quickview"><h3>Topics</h3>
  45 <ul id="topics">
  46 <li><img alt="" src="../images/down.gif" /> <a href="#requiredirectives">The Require Directives</a></li>
  47 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Example usage</a></li>
  48 </ul><h3 class="directives">Directives</h3>
  49 <ul id="toc">
  50 <li><img alt="" src="../images/down.gif" /> <a href="#authdbmgroupfile">AuthDBMGroupFile</a></li>
  51 <li><img alt="" src="../images/down.gif" /> <a href="#authzdbmtype">AuthzDBMType</a></li>
  52 </ul>
  53 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_authz_dbm">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_authz_dbm">Report a bug</a></li></ul><h3>See also</h3>
  54 <ul class="seealso">
  55 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
  56 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  57 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  58 <div class="section">
  59 <h2><a name="requiredirectives" id="requiredirectives">The Require Directives</a></h2>
  60
  61     <p>Apache's <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code>
  62     directives are used during the authorization phase to ensure that
  63     a user is allowed to access a resource.  mod_authz_dbm extends the
  64     authorization types with <code>dbm-group</code>.</p>
  65
  66     <p>Since v2.4.8, <a href="../expr.html">expressions</a> are supported
  67     within the DBM require directives.</p>
  68
  69 <h3><a name="reqgroup" id="reqgroup">Require dbm-group</a></h3>
  70
  71     <p>This directive specifies group membership that is required for the
  72     user to gain access.</p>
  73
  74     <pre class="prettyprint lang-config">Require dbm-group admin</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">Require dbm-file-group</pre>
  85
  86
  87
  88
  89 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  90 <div class="section">
  91 <h2><a name="examples" id="examples">Example usage</a></h2>
  92
  93 <p><em>Note that using mod_authz_dbm requires you to require <code>dbm-group</code>
  94 instead of <code>group</code>:</em>
  95 </p>
  96 <pre class="prettyprint lang-config">&lt;Directory "/foo/bar"&gt;
  97   AuthType Basic
  98   AuthName "Secure Area"
  99   AuthBasicProvider dbm
 100   AuthDBMUserFile "site/data/users"
 101   AuthDBMGroupFile "site/data/users"
 102   Require dbm-group admin
 103 &lt;/Directory&gt;</pre>
 104
 105 </div>
 106 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 107 <div class="directive-section"><h2><a name="AuthDBMGroupFile" id="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile" id="authdbmgroupfile">Directive</a></h2>
 108 <table class="directive">
 109 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the database file containing the list
 110 of user groups for authorization</td></tr>
 111 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMGroupFile <var>file-path</var></code></td></tr>
 112 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 113 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 114 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 115 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 116 </table>
 117     <p>The <code class="directive">AuthDBMGroupFile</code> directive sets the
 118     name of a DBM file containing the list of user groups for user
 119     authorization.  <var>File-path</var> is the absolute path to the
 120     group file.</p>
 121
 122     <p>The group file is keyed on the username. The value for a
 123     user is a comma-separated list of the groups to which the users
 124     belongs. There must be no whitespace within the value, and it
 125     must never contain any colons.</p>
 126
 127     <div class="warning"><h3>Security</h3>
 128       <p>Make sure that the <code class="directive">AuthDBMGroupFile</code> is
 129       stored outside the document tree of the web-server. Do
 130       <strong>not</strong> put it in the directory that it protects.
 131       Otherwise, clients will be able to download the
 132       <code class="directive">AuthDBMGroupFile</code> unless otherwise
 133       protected.</p>
 134     </div>
 135
 136     <p>Combining Group and Password DBM files: In some cases it is
 137     easier to manage a single database which contains both the
 138     password and group details for each user. This simplifies any
 139     support programs that need to be written: they now only have to
 140     deal with writing to and locking a single DBM file. This can be
 141     accomplished by first setting the group and password files to
 142     point to the same DBM:</p>
 143
 144     <pre class="prettyprint lang-config">AuthDBMGroupFile "/www/userbase"
 145 AuthDBMUserFile "/www/userbase"</pre>
 146
 147
 148     <p>The key for the single DBM is the username. The value consists
 149     of</p>
 150
 151     <div class="example"><p><code>
 152       Encrypted Password : List of Groups [ : (ignored) ]
 153     </code></p></div>
 154
 155     <p>The password section contains the encrypted
 156     password as before. This is followed by a colon and the comma
 157     separated list of groups. Other data may optionally be left in the
 158     DBM file after another colon; it is ignored by the authorization
 159     module. This is what www.telescope.org uses for its combined
 160     password and group database.</p>
 161
 162 </div>
 163 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 164 <div class="directive-section"><h2><a name="AuthzDBMType" id="AuthzDBMType">AuthzDBMType</a> <a name="authzdbmtype" id="authzdbmtype">Directive</a></h2>
 165 <table class="directive">
 166 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
 167 store list of user groups</td></tr>
 168 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
 169 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMType default</code></td></tr>
 170 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 171 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 172 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 173 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 174 </table>
 175     <p>Sets the type of database file that is used to store the list
 176     of user groups.
 177     The default database type is determined at compile time.  The
 178     availability of other types of database files also depends on
 179     <a href="../install.html#dbm">compile-time settings</a>.</p>
 180
 181     <p>It is crucial that whatever program you use to create your group
 182     files is configured to use the same type of database.</p>
 183
 184 </div>
 185 </div>
 186 <div class="bottomlang">
 187 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_dbm.html" title="English">&nbsp;en&nbsp;</a> |
 188 <a href="../fr/mod/mod_authz_dbm.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 189 <a href="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 190 </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>
 191 <script type="text/javascript"><!--//--><![CDATA[//><!--
 192 var comments_shortname = 'httpd';
 193 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authz_dbm.html';
 194 (function(w, d) {
 195     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 196         d.write('<div id="comments_thread"><\/div>');
 197         var s = d.createElement('script');
 198         s.type = 'text/javascript';
 199         s.async = true;
 200         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 201         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 202     }
 203     else {
 204         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 205     }
 206 })(window, document);
 207 //--><!]]></script></div><div id="footer">
 208 <p class="apache">Copyright 2016 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>
 209 <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[//><!--
 210 if (typeof(prettyPrint) !== 'undefined') {
 211     prettyPrint();
 212 }
 213 //--><!]]></script>
 214 </body></html>