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" />
12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
14 <div id="page-header">
15 <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>
16 <p class="apache">Apache HTTP Server Version 2.3</p>
17 <img alt="" src="../images/feather.gif" /></div>
18 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
20 <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.3</a> > <a href="./">Modules</a></div>
21 <div id="page-content">
22 <div id="preamble"><h1>Apache Module mod_authn_file</h1>
24 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_file.html" title="English"> en </a> |
25 <a href="../fr/mod/mod_authn_file.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
26 <a href="../ja/mod/mod_authn_file.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
27 <a href="../ko/mod/mod_authn_file.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using text files</td></tr>
30 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
31 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_file_module</td></tr>
32 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_file.c</td></tr>
33 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
36 <p>This module provides authentication front-ends such as
37 <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>
38 to authenticate users by looking up users in plain text password files.
39 Similar functionality is provided by <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>.</p>
41 <p>When using <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
42 <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>, this module is invoked via the
43 <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or
44 <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
45 with the <code>file</code> value.</p>
47 <div id="quickview"><h3 class="directives">Directives</h3>
49 <li><img alt="" src="../images/down.gif" /> <a href="#authuserfile">AuthUserFile</a></li>
54 <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code>
57 <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
59 <li><code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code></li>
60 <li><code class="program"><a href="../programs/htdigest.html">htdigest</a></code></li>
63 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
64 <div class="directive-section"><h2><a name="AuthUserFile" id="AuthUserFile">AuthUserFile</a> <a name="authuserfile" id="authuserfile">Directive</a></h2>
65 <table class="directive">
66 <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
67 passwords for authentication</td></tr>
68 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthUserFile <var>file-path</var></code></td></tr>
69 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
70 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
71 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
72 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_file</td></tr>
74 <p>The <code class="directive">AuthUserFile</code> directive sets the name
75 of a textual file containing the list of users and passwords for
76 user authentication. <var>File-path</var> is the path to the user
77 file. If it is not absolute, it is treated as relative to the
78 <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
80 <p>Each line of the user file contains a username followed by
81 a colon, followed by the encrypted password. If the same user
82 ID is defined multiple times, <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> will
83 use the first occurrence to verify the password.</p>
85 <p>The utility <code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code>
86 which is installed as part of the binary distribution, or which
87 can be found in <code>src/support</code>, is used to maintain
88 the password file for <em>HTTP Basic Authentication</em>. See the
89 <a href="../programs/htpasswd.html">man page</a> for more details.
92 <p>Create a password file <code>Filename</code> with
93 <code>username</code> as the initial ID. It will prompt for
96 <div class="example"><p><code>
97 htpasswd -c Filename username
100 <p>Add or modify <code>username2</code> in the password file
101 <code>Filename</code>:</p>
103 <div class="example"><p><code>
104 htpasswd Filename username2
107 <p>Note that searching large text files is <em>very</em>
108 inefficient; <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code> should be used
111 <p>If you are using <em>HTTP Digest Authentication</em>, the <code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code> tool is not sufficient.
112 You have to use <code class="program"><a href="../programs/htdigest.html">htdigest</a></code>
113 instead. Note that you cannot mix user data for Digest Authentication
114 and Basic Authentication within the same file.</p>
116 <div class="warning"><h3>Security</h3>
117 <p>Make sure that the <code class="directive">AuthUserFile</code> is
118 stored outside the document tree of the web-server. Do
119 <strong>not</strong> put it in the directory that it protects.
120 Otherwise, clients may be able to download the
121 <code class="directive">AuthUserFile</code>.</p>
126 <div class="bottomlang">
127 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_file.html" title="English"> en </a> |
128 <a href="../fr/mod/mod_authn_file.html" hreflang="fr" rel="alternate" title="Français"> fr </a> |
129 <a href="../ja/mod/mod_authn_file.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
130 <a href="../ko/mod/mod_authn_file.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
131 </div><div id="footer">
132 <p class="apache">Copyright 2009 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>
133 <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>