| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --><title>mod_authn_file - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body><div id="page-header"><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><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_authn_file</h1><table class="module"><tr><th><a href="module-dict.html#Description">Description: |
| </a></th><td>User authentication using text files</td></tr><tr><th><a href="module-dict.html#Status">Status: |
| </a></th><td>Base</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier: |
| </a></th><td>authn_file_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source File: |
| </a></th><td>mod_authn_file.c</td></tr><tr><th><a href="module-dict.html#Compatibility">Compatibility: |
| </a></th><td>Available in Apache 2.0.42 and later</td></tr></table><h3>Summary</h3> |
| |
| <p>This module provides authentication front-ends such as |
| <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> |
| to authenticate users by looking up users in plain text password files. |
| Similar functionality is provided by <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>.</p> |
| |
| <p>When using <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or |
| <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>, this module is invoked via the |
| <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or |
| <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> |
| with the 'file' value.</p> |
| |
| </div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#authuserfile">AuthUserFile</a></li></ul><h3>See also</h3><ul class="seealso"><li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li><li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li><li> |
| <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> |
| </li><li> |
| <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> |
| </li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="AuthUserFile" id="AuthUserFile">AuthUserFile</a> <a name="authuserfile" id="authuserfile">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: |
| </a></th><td>Sets the name of a text file containing the list of users and |
| passwords for authentication</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax: |
| </a></th><td>AuthUserFile <em>file-path</em></td></tr><tr><th><a href="directive-dict.html#Context">Context: |
| </a></th><td>directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override: |
| </a></th><td>AuthConfig</td></tr><tr><th><a href="directive-dict.html#Status">Status: |
| </a></th><td>Base</td></tr><tr><th><a href="directive-dict.html#Module">Module: |
| </a></th><td>mod_authn_file</td></tr></table> |
| <p>The <code class="directive">AuthUserFile</code> directive sets the name |
| of a textual file containing the list of users and passwords for |
| user authentication. <em>File-path</em> is the path to the user |
| file. If it is not absolute (<em>i.e.</em>, if it doesn't begin |
| with a slash), it is treated as relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p> |
| |
| <p>Each line of the user file contains a username followed by |
| a colon, followed by the <code>crypt()</code> encrypted |
| password. The behavior of multiple occurrences of the same user is |
| undefined.</p> |
| |
| <p>The utility <a href="../programs/htpasswd.html">htpasswd</a> |
| which is installed as part of the binary distribution, or which |
| can be found in <code>src/support</code>, is used to maintain |
| this password file. See the <code>man</code> page for more |
| details. In short:</p> |
| |
| <p>Create a password file 'Filename' with 'username' as the |
| initial ID. It will prompt for the password:</p> |
| <div class="example"><p><code>htpasswd -c Filename username</code></p></div> |
| |
| <p>Add or modify 'username2' in the password file 'Filename':</p> |
| <div class="example"><p><code>htpasswd Filename username2</code></p></div> |
| |
| <p>Note that searching large text files is <em>very</em> |
| inefficient; <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code> should be used |
| instead.</p> |
| |
| <div class="note"><h3>Security</h3> |
| <p>Make sure that the <code class="directive">AuthUserFile</code> is |
| stored outside the document tree of the web-server; do <em>not</em> |
| put it in the directory that it protects. Otherwise, clients will |
| be able to download the <code class="directive">AuthUserFile</code>.</p> |
| </div> |
| </div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><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></body></html> |
