github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_authn_dbm.html.en (about)

     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_authn_dbm - Apache HTTP Server Version 2.2</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" /><link href="http://httpd.apache.org/docs/current/mod/mod_authn_dbm.html" rel="canonical" /></head>
    18  <body>
    19  <div id="page-header">
    20  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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.2</p>
    22  <img alt="" src="../images/feather.gif" /></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.2</a> &gt; <a href="./">Modules</a></div>
    26  <div id="page-content">
    27  <div class="retired"><h4>Please note</h4>
    28              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    29          <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_authn_dbm.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_authn_dbm</h1>
    30  <div class="toplang">
    31  <p><span>Available Languages: </span><a href="../en/mod/mod_authn_dbm.html" title="English">&nbsp;en&nbsp;</a> |
    32  <a href="../ja/mod/mod_authn_dbm.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
    33  <a href="../ko/mod/mod_authn_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
    34  </div>
    35  <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using DBM files</td></tr>
    36  <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
    37  <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_dbm_module</td></tr>
    38  <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_dbm.c</td></tr>
    39  <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
    40  <h3>Summary</h3>
    41  
    42      <p>This module provides authentication front-ends such as
    43      <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>
    44      to authenticate users by looking up users in <dfn>dbm</dfn> password
    45      files. Similar functionality is provided by
    46      <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>.</p>
    47  
    48      <p>When using <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
    49      <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>, this module is invoked via the
    50      <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or
    51      <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
    52      with the <code>dbm</code> value.</p>
    53  </div>
    54  <div id="quickview"><h3 class="directives">Directives</h3>
    55  <ul id="toc">
    56  <li><img alt="" src="../images/down.gif" /> <a href="#authdbmtype">AuthDBMType</a></li>
    57  <li><img alt="" src="../images/down.gif" /> <a href="#authdbmuserfile">AuthDBMUserFile</a></li>
    58  </ul>
    59  <h3>See also</h3>
    60  <ul class="seealso">
    61  <li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li>
    62  <li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li>
    63  <li>
    64    <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code>
    65  </li>
    66  <li>
    67    <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
    68  </li>
    69  </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    70  
    71  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    72  <div class="directive-section"><h2><a name="AuthDBMType" id="AuthDBMType">AuthDBMType</a> <a name="authdbmtype" id="authdbmtype">Directive</a></h2>
    73  <table class="directive">
    74  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the type of database file that is used to
    75  store passwords</td></tr>
    76  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMType default|SDBM|GDBM|NDBM|DB</code></td></tr>
    77  <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDBMType default</code></td></tr>
    78  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
    79  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
    80  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
    81  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_dbm</td></tr>
    82  </table>
    83      <p>Sets the type of database file that is used to store the passwords.
    84      The default database type is determined at compile time.  The
    85      availability of other types of database files also depends on
    86      <a href="../install.html#dbm">compile-time settings</a>.</p>
    87  
    88      <p>It is crucial that whatever program you use to create your password
    89      files is configured to use the same type of database.</p>
    90  
    91  </div>
    92  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    93  <div class="directive-section"><h2><a name="AuthDBMUserFile" id="AuthDBMUserFile">AuthDBMUserFile</a> <a name="authdbmuserfile" id="authdbmuserfile">Directive</a></h2>
    94  <table class="directive">
    95  <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
    96  passwords for authentication</td></tr>
    97  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBMUserFile <var>file-path</var></code></td></tr>
    98  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
    99  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
   100  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
   101  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_dbm</td></tr>
   102  </table>
   103      <p>The <code class="directive">AuthDBMUserFile</code> directive sets the
   104      name of a DBM file containing the list of users and passwords for
   105      user authentication. <var>File-path</var> is the absolute path to
   106      the user file.</p>
   107  
   108      <p>The user file is keyed on the username. The value for a user is
   109      the encrypted password, optionally followed by a colon and arbitrary
   110      data. The colon and the data following it will be ignored by the
   111      server.</p>
   112  
   113      <div class="warning"><h3>Security:</h3>
   114        <p>Make sure that the <code class="directive">AuthDBMUserFile</code> is stored
   115        outside the document tree of the web-server; do <em>not</em> put it in
   116        the directory that it protects. Otherwise, clients will be able to
   117        download the <code class="directive">AuthDBMUserFile</code>.</p>
   118      </div>
   119  
   120      <p>Important compatibility note: The implementation of
   121      <code>dbmopen</code> in the apache modules reads the string length of
   122      the hashed values from the DBM data structures, rather than relying
   123      upon the string being NULL-appended. Some applications, such as
   124      the Netscape web server, rely upon the string being
   125      NULL-appended, so if you are having trouble using DBM files
   126      interchangeably between applications this may be a part of the
   127      problem.</p>
   128  
   129      <p>A perl script called
   130      <code class="program"><a href="../programs/dbmmanage.html">dbmmanage</a></code> is included with
   131      Apache. This program can be used to create and update DBM
   132      format password files for use with this module.</p>
   133  
   134  </div>
   135  </div>
   136  <div class="bottomlang">
   137  <p><span>Available Languages: </span><a href="../en/mod/mod_authn_dbm.html" title="English">&nbsp;en&nbsp;</a> |
   138  <a href="../ja/mod/mod_authn_dbm.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
   139  <a href="../ko/mod/mod_authn_dbm.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
   140  </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>
   141  <script type="text/javascript"><!--//--><![CDATA[//><!--
   142  var comments_shortname = 'httpd';
   143  var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_authn_dbm.html';
   144  (function(w, d) {
   145      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   146          d.write('<div id="comments_thread"><\/div>');
   147          var s = d.createElement('script');
   148          s.type = 'text/javascript';
   149          s.async = true;
   150          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   151          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   152      }
   153      else { 
   154          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   155      }
   156  })(window, document);
   157  //--><!]]></script></div><div id="footer">
   158  <p class="apache">Copyright 2017 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>
   159  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!--
   160  if (typeof(prettyPrint) !== 'undefined') {
   161      prettyPrint();
   162  }
   163  //--><!]]></script>
   164  </body></html>