granicus.if.org Git - apache/blob - docs/manual/mod/mod_authn_file.html.en

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