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