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/directives.html">Directives</a> | <a href="../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="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  29 </div>
  30 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using DBM files</td></tr>
  31 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  32 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_dbm_module</td></tr>
  33 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_dbm.c</td></tr>
  34 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</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>See also</h3>
  48 <ul class="seealso">
  49 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
  50 </ul></div>
  51
  52 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  53 <div class="directive-section"><h2><a name="AuthDBMGroupFile" id="AuthDBMGroupFile">AuthDBMGroupFile</a> <a name="authdbmgroupfile" id="authdbmgroupfile">Directive</a></h2>
  54 <table class="directive">
  55 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the database file containing the list
  56 of user groups for authorization</td></tr>
  57 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMGroupFile <var>file-path</var></code></td></tr>
  58 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  59 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  60 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  61 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
  62 </table>
  63     <p>The <code class="directive">AuthDBMGroupFile</code> directive sets the
  64     name of a DBM file containing the list of user groups for user
  65     authorization.  <var>File-path</var> is the absolute path to the
  66     group file.</p>
  67
  68     <p>The group file is keyed on the username. The value for a
  69     user is a comma-separated list of the groups to which the users
  70     belongs. There must be no whitespace within the value, and it
  71     must never contain any colons.</p>
  72
  73     <div class="warning"><h3>Security</h3>
  74       <p>Make sure that the <code class="directive">AuthDBMGroupFile</code> is
  75       stored outside the document tree of the web-server. Do
  76       <strong>not</strong> put it in the directory that it protects.
  77       Otherwise, clients will be able to download the
  78       <code class="directive">AuthDBMGroupFile</code> unless otherwise
  79       protected.</p>
  80     </div>
  81
  82     <p>Combining Group and Password DBM files: In some cases it is
  83     easier to manage a single database which contains both the
  84     password and group details for each user. This simplifies any
  85     support programs that need to be written: they now only have to
  86     deal with writing to and locking a single DBM file. This can be
  87     accomplished by first setting the group and password files to
  88     point to the same DBM:</p>
  89
  90     <pre class="prettyprint lang-config">
  91 AuthDBMGroupFile /www/userbase
  92 AuthDBMUserFile /www/userbase
  93     </pre>
  94
  95
  96     <p>The key for the single DBM is the username. The value consists
  97     of</p>
  98
  99     <div class="example"><p><code>
 100       Encrypted Password : List of Groups [ : (ignored) ]
 101     </code></p></div>
 102
 103     <p>The password section contains the encrypted
 104     password as before. This is followed by a colon and the comma
 105     separated list of groups. Other data may optionally be left in the
 106     DBM file after another colon; it is ignored by the authorization
 107     module. This is what www.telescope.org uses for its combined
 108     password and group database.</p>
 109
 110 </div>
 111 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 112 <div class="directive-section"><h2><a name="AuthzDBMType" id="AuthzDBMType">AuthzDBMType</a> <a name="authzdbmtype" id="authzdbmtype">Directive</a></h2>
 113 <table class="directive">
 114 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
 115 store list of user groups</td></tr>
 116 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
 117 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzDBMType default</code></td></tr>
 118 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 119 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 120 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 121 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_dbm</td></tr>
 122 </table>
 123     <p>Sets the type of database file that is used to store the list
 124     of user groups.
 125     The default database type is determined at compile time.  The
 126     availability of other types of database files also depends on
 127     <a href="../install.html#dbm">compile-time settings</a>.</p>
 128
 129     <p>It is crucial that whatever program you use to create your group
 130     files is configured to use the same type of database.</p>
 131
 132 </div>
 133 </div>
 134 <div class="bottomlang">
 135 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_dbm.html" title="English">&nbsp;en&nbsp;</a> |
 136 <a href="../ko/mod/mod_authz_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 137 </div><div id="footer">
 138 <p class="apache">Copyright 2012 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>
 139 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 140 if (typeof(prettyPrint) !== undefined) {
 141     prettyPrint();
 142 }
 143 //--><!]]></script>
 144 </body></html>