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