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" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.min.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="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.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_authn_dbm</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_authn_dbm.html" title="English"> en </a> | 28<a href="/fr/mod/mod_authn_dbm.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 29<a href="/ja/mod/mod_authn_dbm.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 30<a href="/ko/mod/mod_authn_dbm.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 31</div> 32<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using DBM files</td></tr> 33<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 34<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>authn_dbm_module</td></tr> 35<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_authn_dbm.c</td></tr> 36<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table> 37<h3>Summary</h3> 38 39 <p>This module provides authentication front-ends such as 40 <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> 41 to authenticate users by looking up users in <dfn>dbm</dfn> password 42 files. Similar functionality is provided by 43 <code class="module"><a href="/mod/mod_authn_file.html">mod_authn_file</a></code>.</p> 44 45 <p>When using <code class="module"><a href="/mod/mod_auth_basic.html">mod_auth_basic</a></code> or 46 <code class="module"><a href="/mod/mod_auth_digest.html">mod_auth_digest</a></code>, this module is invoked via the 47 <code class="directive"><a href="/mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or 48 <code class="directive"><a href="/mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> 49 with the <code>dbm</code> value.</p> 50</div> 51<div id="quickview"><h3 class="directives">Directives</h3> 52<ul id="toc"> 53<li><img alt="" src="/images/down.gif" /> <a href="#authdbmtype">AuthDBMType</a></li> 54<li><img alt="" src="/images/down.gif" /> <a href="#authdbmuserfile">AuthDBMUserFile</a></li> 55</ul> 56<h3>See also</h3> 57<ul class="seealso"> 58<li><code class="directive"><a href="/mod/mod_authn_core.html#authname">AuthName</a></code></li> 59<li><code class="directive"><a href="/mod/mod_authn_core.html#authtype">AuthType</a></code></li> 60<li> 61 <code class="directive"><a href="/mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> 62</li> 63<li> 64 <code class="directive"><a href="/mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> 65</li> 66<li><code class="program"><a href="/programs/htpasswd.html">htpasswd</a></code></li> 67<li><code class="program"><a href="/programs/htdbm.html">htdbm</a></code></li> 68<li><a href="/misc/password_encryptions.html">Password Formats</a></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 75store 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 96passwords 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>The encrypted password format depends on which authentication 121 frontend (e.g. <code class="module"><a href="/mod/mod_auth_basic.html">mod_auth_basic</a></code> or 122 <code class="module"><a href="/mod/mod_auth_digest.html">mod_auth_digest</a></code>) is being used. See <a href="/misc/password_encryptions.html">Password Formats</a> for 123 more information.</p> 124 125 <p>Important compatibility note: The implementation of 126 <code>dbmopen</code> in the apache modules reads the string length of 127 the hashed values from the DBM data structures, rather than relying 128 upon the string being NULL-appended. Some applications, such as 129 the Netscape web server, rely upon the string being 130 NULL-appended, so if you are having trouble using DBM files 131 interchangeably between applications this may be a part of the 132 problem.</p> 133 134 <p>A perl script called 135 <code class="program"><a href="/programs/dbmmanage.html">dbmmanage</a></code> is included with 136 Apache. This program can be used to create and update DBM 137 format password files for use with this module. Another 138 tool for maintaining the DBM files is the included program 139 <code class="program"><a href="/programs/htdbm.html">htdbm</a></code>.</p> 140 141</div> 142</div> 143<div class="bottomlang"> 144<p><span>Available Languages: </span><a href="/en/mod/mod_authn_dbm.html" title="English"> en </a> | 145<a href="/fr/mod/mod_authn_dbm.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 146<a href="/ja/mod/mod_authn_dbm.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 147<a href="/ko/mod/mod_authn_dbm.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 148</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&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> 149<script type="text/javascript"><!--//--><![CDATA[//><!-- 150var comments_shortname = 'httpd'; 151var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_authn_dbm.html'; 152(function(w, d) { 153 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 154 d.write('<div id="comments_thread"><\/div>'); 155 var s = d.createElement('script'); 156 s.type = 'text/javascript'; 157 s.async = true; 158 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 159 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 160 } 161 else { 162 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 163 } 164})(window, document); 165//--><!]]></script></div><div id="footer"> 166<p class="apache">Copyright 2014 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> 167<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[//><!-- 168if (typeof(prettyPrint) !== 'undefined') { 169 prettyPrint(); 170} 171//--><!]]></script> 172</body></html>
