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
8 <title>mod_authn_file - 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">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
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.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
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.5</a> > <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_authn_file</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_file.html" title="English"> en </a> |
28 <a href="../fr/mod/mod_authn_file.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
29 <a href="../ja/mod/mod_authn_file.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
30 <a href="../ko/mod/mod_authn_file.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using text files</td></tr>
33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_file_module</td></tr>
35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_file.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>
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 plain text password files.
42 Similar functionality is provided by <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>.</p>
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>file</code> value.</p>
50 <div id="quickview"><h3 class="directives">Directives</h3>
52 <li><img alt="" src="../images/down.gif" /> <a href="#authuserfile">AuthUserFile</a></li>
57 <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code>
60 <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
62 <li><code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code></li>
63 <li><code class="program"><a href="../programs/htdigest.html">htdigest</a></code></li>
64 <li><a href="../misc/password_encryptions.html">Password Formats</a></li>
65 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
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="AuthUserFile" id="AuthUserFile">AuthUserFile</a> <a name="authuserfile" id="authuserfile">Directive</a></h2>
69 <table class="directive">
70 <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
71 passwords for authentication</td></tr>
72 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthUserFile <var>file-path</var></code></td></tr>
73 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
74 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
75 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
76 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_file</td></tr>
78 <p>The <code class="directive">AuthUserFile</code> directive sets the name
79 of a textual file containing the list of users and passwords for
80 user authentication. <var>File-path</var> is the path to the user
81 file. If it is not absolute, it is treated as relative to the
82 <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
84 <p>Each line of the user file contains a username followed by
85 a colon, followed by the encrypted password. If the same user
86 ID is defined multiple times, <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> will
87 use the first occurrence to verify the password.</p>
89 <p>The encrypted password format depends on which authentication
90 frontend (e.g. <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
91 <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
94 <p>For <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code>, use the utility <code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code>
95 which is installed as part of the binary distribution, or which
96 can be found in <code>src/support</code>. See the
97 <a href="../programs/htpasswd.html">man page</a> for more details.
100 <p>Create a password file <code>Filename</code> with
101 <code>username</code> as the initial ID. It will prompt for
104 <div class="example"><p><code>
105 htpasswd -c Filename username
108 <p>Add or modify <code>username2</code> in the password file
109 <code>Filename</code>:</p>
111 <div class="example"><p><code>
112 htpasswd Filename username2
115 <p>Note that searching large text files is <em>very</em>
116 inefficient; <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code> should be used
119 <p>For <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>, use <code class="program"><a href="../programs/htdigest.html">htdigest</a></code>
120 instead. Note that you cannot mix user data for Digest Authentication
121 and Basic Authentication within the same file.</p>
123 <div class="warning"><h3>Security</h3>
124 <p>Make sure that the <code class="directive">AuthUserFile</code> is
125 stored outside the document tree of the web-server. Do
126 <strong>not</strong> put it in the directory that it protects.
127 Otherwise, clients may be able to download the
128 <code class="directive">AuthUserFile</code>.</p>
133 <div class="bottomlang">
134 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_file.html" title="English"> en </a> |
135 <a href="../fr/mod/mod_authn_file.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
136 <a href="../ja/mod/mod_authn_file.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
137 <a href="../ko/mod/mod_authn_file.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
138 </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>
139 <script type="text/javascript"><!--//--><![CDATA[//><!--
140 var comments_shortname = 'httpd';
141 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authn_file.html';
143 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
144 d.write('<div id="comments_thread"><\/div>');
145 var s = d.createElement('script');
146 s.type = 'text/javascript';
148 s.src = 'https://c.apaste.info/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
149 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
152 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
154 })(window, document);
155 //--><!]]></script></div><div id="footer">
156 <p class="apache">Copyright 2012 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>
157 <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[//><!--
158 if (typeof(prettyPrint) !== 'undefined') {