granicus.if.org Git - apache/blob - docs/manual/mod/mod_authn_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_authn_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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_authn_dbm</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_dbm.html" title="English">&nbsp;en&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using DBM files</td></tr>
  27 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  28 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_dbm_module</td></tr>
  29 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_dbm.c</td></tr>
  30 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
  31 <h3>Summary</h3>
  32
  33     <p>This module provides authentication front-ends such as
  34     <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code> and <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code>
  35     to authenticate users by looking up users in <dfn>dbm</dfn> password
  36     files. Similar functionality is provided by
  37     <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>.</p>
  38
  39     <p>When using <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
  40     <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>, this module is invoked via the
  41     <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or
  42     <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
  43     with the <code>dbm</code> value.</p>
  44 </div>
  45 <div id="quickview"><h3 class="directives">Directives</h3>
  46 <ul id="toc">
  47 <li><img alt="" src="../images/down.gif" /> <a href="#authdbmtype">AuthDBMType</a></li>
  48 <li><img alt="" src="../images/down.gif" /> <a href="#authdbmuserfile">AuthDBMUserFile</a></li>
  49 </ul>
  50 <h3>See also</h3>
  51 <ul class="seealso">
  52 <li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li>
  53 <li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li>
  54 <li>
  55   <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code>
  56 </li>
  57 <li>
  58   <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
  59 </li>
  60 </ul></div>
  61
  62 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  63 <div class="directive-section"><h2><a name="AuthDBMType" id="AuthDBMType">AuthDBMType</a> <a name="authdbmtype" id="authdbmtype">Directive</a></h2>
  64 <table class="directive">
  65 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
  66 store passwords</td></tr>
  67 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
  68 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDBMType default</code></td></tr>
  69 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  70 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  71 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  72 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_dbm</td></tr>
  73 </table>
  74     <p>Sets the type of database file that is used to store the passwords.
  75     The default database type is determined at compile time.  The
  76     availability of other types of database files also depends on
  77     <a href="../install.html#dbm">compile-time settings</a>.</p>
  78
  79     <p>It is crucial that whatever program you use to create your password
  80     files is configured to use the same type of database.</p>
  81
  82 </div>
  83 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  84 <div class="directive-section"><h2><a name="AuthDBMUserFile" id="AuthDBMUserFile">AuthDBMUserFile</a> <a name="authdbmuserfile" id="authdbmuserfile">Directive</a></h2>
  85 <table class="directive">
  86 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of a database file containing the list of users and
  87 passwords for authentication</td></tr>
  88 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMUserFile <var>file-path</var></code></td></tr>
  89 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  90 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  91 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  92 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_dbm</td></tr>
  93 </table>
  94     <p>The <code class="directive">AuthDBMUserFile</code> directive sets the
  95     name of a DBM file containing the list of users and passwords for
  96     user authentication. <var>File-path</var> is the absolute path to
  97     the user file.</p>
  98
  99     <p>The user file is keyed on the username. The value for a user is
 100     the encrypted password, optionally followed by a colon and arbitrary
 101     data. The colon and the data following it will be ignored by the
 102     server.</p>
 103
 104     <div class="warning"><h3>Security:</h3>
 105       <p>Make sure that the <code class="directive">AuthDBMUserFile</code> is stored
 106       outside the document tree of the web-server; do <em>not</em> put it in
 107       the directory that it protects. Otherwise, clients will be able to
 108       download the <code class="directive">AuthDBMUserFile</code>.</p>
 109     </div>
 110
 111     <p>Important compatibility note: The implementation of
 112     <code>dbmopen</code> in the apache modules reads the string length of
 113     the hashed values from the DBM data structures, rather than relying
 114     upon the string being NULL-appended. Some applications, such as
 115     the Netscape web server, rely upon the string being
 116     NULL-appended, so if you are having trouble using DBM files
 117     interchangeably between applications this may be a part of the
 118     problem.</p>
 119
 120     <p>A perl script called
 121     <a href="../programs/dbmmanage.html">dbmmanage</a> is included with
 122     Apache. This program can be used to create and update DBM
 123     format password files for use with this module.</p>
 124
 125 </div>
 126 </div>
 127 <div class="bottomlang">
 128 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_dbm.html" title="English">&nbsp;en&nbsp;</a></p>
 129 </div><div id="footer">
 130 <p class="apache">Copyright 1999-2004 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>
 131 <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>
 132 </body></html>