github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_authn_file.html.en (about) 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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" /> 5 <!-- 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 This file is generated from xml source: DO NOT EDIT 8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 9 --> 10 <title>mod_authn_file - Apache HTTP Server Version 2.2</title> 11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 13 <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" /> 14 <script src="../style/scripts/prettify.min.js" type="text/javascript"> 15 </script> 16 17 <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_authn_file.html" rel="canonical" /></head> 18 <body> 19 <div id="page-header"> 20 <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> 21 <p class="apache">Apache HTTP Server Version 2.2</p> 22 <img alt="" src="../images/feather.gif" /></div> 23 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> 24 <div id="path"> 25 <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> 26 <div id="page-content"> 27 <div class="retired"><h4>Please note</h4> 28 <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p> 29 <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_authn_file.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_authn_file</h1> 30 <div class="toplang"> 31 <p><span>Available Languages: </span><a href="../en/mod/mod_authn_file.html" title="English"> en </a> | 32 <a href="../fr/mod/mod_authn_file.html" hreflang="fr" rel="alternate" title="Français"> fr </a> | 33 <a href="../ja/mod/mod_authn_file.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 34 <a href="../ko/mod/mod_authn_file.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> 35 </div> 36 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using text files</td></tr> 37 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> 38 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_file_module</td></tr> 39 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_file.c</td></tr> 40 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table> 41 <h3>Summary</h3> 42 43 <p>This module provides authentication front-ends such as 44 <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> 45 to authenticate users by looking up users in plain text password files. 46 Similar functionality is provided by <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>.</p> 47 48 <p>When using <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or 49 <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>, this module is invoked via the 50 <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or 51 <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> 52 with the <code>file</code> value.</p> 53 </div> 54 <div id="quickview"><h3 class="directives">Directives</h3> 55 <ul id="toc"> 56 <li><img alt="" src="../images/down.gif" /> <a href="#authuserfile">AuthUserFile</a></li> 57 </ul> 58 <h3>See also</h3> 59 <ul class="seealso"> 60 <li> 61 <code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> 62 </li> 63 <li> 64 <code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code> 65 </li> 66 <li><code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code></li> 67 <li><code class="program"><a href="../programs/htdigest.html">htdigest</a></code></li> 68 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 69 70 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 71 <div class="directive-section"><h2><a name="AuthUserFile" id="AuthUserFile">AuthUserFile</a> <a name="authuserfile" id="authuserfile">Directive</a></h2> 72 <table class="directive"> 73 <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 74 passwords for authentication</td></tr> 75 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthUserFile <var>file-path</var></code></td></tr> 76 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 77 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> 78 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 79 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_file</td></tr> 80 </table> 81 <p>The <code class="directive">AuthUserFile</code> directive sets the name 82 of a textual file containing the list of users and passwords for 83 user authentication. <var>File-path</var> is the path to the user 84 file. If it is not absolute, it is treated as relative to the 85 <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p> 86 87 <p>Each line of the user file contains a username followed by 88 a colon, followed by the encrypted password. If the same user 89 ID is defined multiple times, <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> will 90 use the first occurrence to verify the password.</p> 91 92 <p>The utility <code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code> 93 which is installed as part of the binary distribution, or which 94 can be found in <code>src/support</code>, is used to maintain 95 the password file for <em>HTTP Basic Authentication</em>. See the 96 <a href="../programs/htpasswd.html">man page</a> for more details. 97 In short:</p> 98 99 <p>Create a password file <code>Filename</code> with 100 <code>username</code> as the initial ID. It will prompt for 101 the password:</p> 102 103 <div class="example"><p><code> 104 htpasswd -c Filename username 105 </code></p></div> 106 107 <p>Add or modify <code>username2</code> in the password file 108 <code>Filename</code>:</p> 109 110 <div class="example"><p><code> 111 htpasswd Filename username2 112 </code></p></div> 113 114 <p>Note that searching large text files is <em>very</em> 115 inefficient; <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code> should be used 116 instead.</p> 117 118 <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. 119 You have to 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> 122 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> 129 </div> 130 131 </div> 132 </div> 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/2.2/mod/mod_authn_file.html'; 142 (function(w, d) { 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'; 147 s.async = true; 148 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 149 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 150 } 151 else { 152 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 153 } 154 })(window, document); 155 //--><!]]></script></div><div id="footer"> 156 <p class="apache">Copyright 2017 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') { 159 prettyPrint(); 160 } 161 //--><!]]></script> 162 </body></html>