github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/programs/htpasswd.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>htpasswd - Manage user files for basic authentication - 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/programs/htpasswd.html" rel="canonical" /></head> 18 <body id="manual-page"><div id="page-header"> 19 <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> 20 <p class="apache">Apache HTTP Server Version 2.2</p> 21 <img alt="" src="../images/feather.gif" /></div> 22 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> 23 <div id="path"> 24 <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="./">Programs</a></div><div id="page-content"><div class="retired"><h4>Please note</h4> 25 <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> 26 <p>You may follow <a href="http://httpd.apache.org/docs/current/programs/htpasswd.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>htpasswd - Manage user files for basic authentication</h1> 27 <div class="toplang"> 28 <p><span>Available Languages: </span><a href="../en/programs/htpasswd.html" title="English"> en </a> | 29 <a href="../ko/programs/htpasswd.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 30 <a href="../tr/programs/htpasswd.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> 31 </div> 32 33 <p><code>htpasswd</code> is used to create and update the flat-files used to 34 store usernames and password for basic authentication of HTTP users. If 35 <code>htpasswd</code> cannot access a file, such as not being able to write 36 to the output file or not being able to read the file in order to update it, 37 it returns an error status and makes no changes.</p> 38 39 <p>Resources available from the Apache HTTP server can be restricted to 40 just the users listed in the files created by <code>htpasswd</code>. This 41 program can only manage usernames and passwords stored in a flat-file. It 42 can encrypt and display password information for use in other types of data 43 stores, though. To use a DBM database see <code class="program"><a href="../programs/dbmmanage.html">dbmmanage</a></code>.</p> 44 45 <p><code>htpasswd</code> encrypts passwords using either a version of MD5 46 modified for Apache, or the system's <code>crypt()</code> routine. Files 47 managed by <code>htpasswd</code> may contain both types of passwords; some 48 user records may have MD5-encrypted passwords while others in the same file 49 may have passwords encrypted with <code>crypt()</code>.</p> 50 51 <p>This manual page only lists the command line arguments. For details of 52 the directives necessary to configure user authentication in 53 <code class="program"><a href="../programs/httpd.html">httpd</a></code> see the Apache manual, which is part of the 54 Apache distribution or can be found at <a href="http://httpd.apache.org">http://httpd.apache.org/</a>.</p> 55 </div> 56 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li> 57 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li> 58 <li><img alt="" src="../images/down.gif" /> <a href="#exit">Exit Status</a></li> 59 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li> 60 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Considerations</a></li> 61 <li><img alt="" src="../images/down.gif" /> <a href="#restrictions">Restrictions</a></li> 62 </ul><h3>See also</h3><ul class="seealso"><li><code class="program"><a href="../programs/httpd.html">httpd</a></code></li><li>The scripts in support/SHA1 which come with the 63 distribution.</li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 64 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 65 <div class="section"> 66 <h2><a name="synopsis" id="synopsis">Synopsis</a></h2> 67 <p><code><strong>htpasswd</strong> 68 [ -<strong>c</strong> ] 69 [ -<strong>m</strong> ] 70 [ -<strong>D</strong> ] <var>passwdfile</var> <var>username</var></code></p> 71 72 <p><code><strong>htpasswd</strong> -<strong>b</strong> 73 [ -<strong>c</strong> ] 74 [ -<strong>m</strong> | 75 -<strong>d</strong> | 76 -<strong>p</strong> | 77 -<strong>s</strong> ] 78 [ -<strong>D</strong> ] <var>passwdfile</var> <var>username</var> 79 <var>password</var></code></p> 80 81 <p><code><strong>htpasswd</strong> -<strong>n</strong> 82 [ -<strong>m</strong> | 83 -<strong>d</strong> | 84 -<strong>s</strong> | 85 -<strong>p</strong> ] <var>username</var></code></p> 86 87 <p><code><strong>htpasswd</strong> -<strong>nb</strong> 88 [ -<strong>m</strong> | 89 -<strong>d</strong> | 90 -<strong>s</strong> | 91 -<strong>p</strong> ] <var>username</var> <var>password</var></code></p> 92 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 93 <div class="section"> 94 <h2><a name="options" id="options">Options</a></h2> 95 <dl> 96 <dt><code>-b</code></dt> 97 <dd>Use batch mode; <em>i.e.</em>, get the password from the command line 98 rather than prompting for it. This option should be used with extreme care, 99 since <strong>the password is clearly visible</strong> on the command 100 line.</dd> 101 102 <dt><code>-c</code></dt> 103 <dd>Create the <var>passwdfile</var>. If <var>passwdfile</var> already 104 exists, it is rewritten and truncated. This option cannot be combined with 105 the <code>-n</code> option.</dd> 106 107 <dt><code>-n</code></dt> 108 <dd>Display the results on standard output rather than updating a file. 109 This is useful for generating password records acceptable to Apache for 110 inclusion in non-text data stores. This option changes the syntax of the 111 command line, since the <var>passwdfile</var> argument (usually the first 112 one) is omitted. It cannot be combined with the <code>-c</code> option.</dd> 113 114 <dt><code>-m</code></dt> 115 <dd>Use MD5 encryption for passwords. This is the default (since version 116 2.2.18).</dd> 117 118 <dt><code>-d</code></dt> 119 <dd>Use <code>crypt()</code> encryption for passwords. This is not 120 supported by the <code class="program"><a href="../programs/httpd.html">httpd</a></code> server on Windows and 121 Netware and TPF. This algorithm limits the password length to 8 122 characters. This algorithm is <strong>insecure</strong> by today's 123 standards. It used to be the default algorithm until version 2.2.17.</dd> 124 125 <dt><code>-s</code></dt> 126 <dd>Use SHA encryption for passwords. Facilitates migration from/to Netscape 127 servers using the LDAP Directory Interchange Format (ldif).</dd> 128 129 <dt><code>-p</code></dt> 130 <dd>Use plaintext passwords. Though <code>htpasswd</code> will support 131 creation on all platforms, the <code class="program"><a href="../programs/httpd.html">httpd</a></code> daemon will 132 only accept plain text passwords on Windows, Netware and TPF.</dd> 133 134 <dt><code>-D</code></dt> 135 <dd>Delete user. If the username exists in the specified htpasswd file, it 136 will be deleted.</dd> 137 138 <dt><code><var>passwdfile</var></code></dt> 139 <dd>Name of the file to contain the user name and password. If 140 <code>-c</code> is given, this file is created if it does not already exist, 141 or rewritten and truncated if it does exist.</dd> 142 143 <dt><code><var>username</var></code></dt> 144 <dd>The username to create or update in <var>passwdfile</var>. If 145 <var>username</var> does not exist in this file, an entry is added. If it 146 does exist, the password is changed.</dd> 147 148 <dt><code><var>password</var></code></dt> 149 <dd>The plaintext password to be encrypted and stored in the file. Only 150 used with the <code>-b</code> flag.</dd> 151 </dl> 152 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 153 <div class="section"> 154 <h2><a name="exit" id="exit">Exit Status</a></h2> 155 <p><code>htpasswd</code> returns a zero status ("true") if the username and 156 password have been successfully added or updated in the 157 <var>passwdfile</var>. <code>htpasswd</code> returns <code>1</code> if it 158 encounters some problem accessing files, <code>2</code> if there was a 159 syntax problem with the command line, <code>3</code> if the password was 160 entered interactively and the verification entry didn't match, 161 <code>4</code> if its operation was interrupted, <code>5</code> if a value 162 is too long (username, filename, password, or final computed record), 163 <code>6</code> if the username contains illegal characters (see the 164 <a href="#restrictions">Restrictions section</a>), and <code>7</code> 165 if the file is not a valid password file.</p> 166 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 167 <div class="section"> 168 <h2><a name="examples" id="examples">Examples</a></h2> 169 <div class="example"><p><code> 170 htpasswd /usr/local/etc/apache/.htpasswd-users jsmith 171 </code></p></div> 172 173 <p>Adds or modifies the password for user <code>jsmith</code>. The user 174 is prompted for the password. The password will be encrypted using the 175 modified Apache MD5 algorithm. If the file does not exist, 176 <code>htpasswd</code> will do nothing except return an error.</p> 177 178 <div class="example"><p><code> 179 htpasswd -c /home/doe/public_html/.htpasswd jane 180 </code></p></div> 181 182 <p>Creates a new file and stores a record in it for user <code>jane</code>. 183 The user is prompted for the password. If the file exists and cannot be 184 read, or cannot be written, it is not altered and <code>htpasswd</code> 185 will display a message and return an error status.</p> 186 187 <div class="example"><p><code> 188 htpasswd -db /usr/web/.htpasswd-all jones Pwd4Steve 189 </code></p></div> 190 191 <p>Encrypts the password from the command line (<code>Pwd4Steve</code>) 192 using the <code>crypt()</code> algorithm, and stores it in the specified 193 file.</p> 194 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 195 <div class="section"> 196 <h2><a name="security" id="security">Security Considerations</a></h2> 197 <p>Web password files such as those managed by <code>htpasswd</code> should 198 <em>not</em> be within the Web server's URI space -- that is, they should 199 not be fetchable with a browser.</p> 200 201 <p>This program is not safe as a setuid executable. Do <em>not</em> make it 202 setuid.</p> 203 204 <p>The use of the <code>-b</code> option is discouraged, since when it is 205 used the unencrypted password appears on the command line.</p> 206 207 <p>When using the <code>crypt()</code> algorithm, note that only the first 208 8 characters of the password are used to form the password. If the supplied 209 password is longer, the extra characters will be silently discarded.</p> 210 211 <p>The SHA encryption format does not use salting: for a given password, 212 there is only one encrypted representation. The <code>crypt()</code> and 213 MD5 formats permute the representation by prepending a random salt string, 214 to make dictionary attacks against the passwords more difficult.</p> 215 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> 216 <div class="section"> 217 <h2><a name="restrictions" id="restrictions">Restrictions</a></h2> 218 <p>On the Windows and MPE platforms, passwords encrypted with 219 <code>htpasswd</code> are limited to no more than <code>255</code> 220 characters in length. Longer passwords will be truncated to 255 221 characters.</p> 222 223 <p>The MD5 algorithm used by <code>htpasswd</code> is specific to the Apache 224 software; passwords encrypted using it will not be usable with other Web 225 servers.</p> 226 227 <p>Usernames are limited to <code>255</code> bytes and may not include the 228 character <code>:</code>.</p> 229 </div></div> 230 <div class="bottomlang"> 231 <p><span>Available Languages: </span><a href="../en/programs/htpasswd.html" title="English"> en </a> | 232 <a href="../ko/programs/htpasswd.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> | 233 <a href="../tr/programs/htpasswd.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p> 234 </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> 235 <script type="text/javascript"><!--//--><![CDATA[//><!-- 236 var comments_shortname = 'httpd'; 237 var comments_identifier = 'http://httpd.apache.org/docs/2.2/programs/htpasswd.html'; 238 (function(w, d) { 239 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 240 d.write('<div id="comments_thread"><\/div>'); 241 var s = d.createElement('script'); 242 s.type = 'text/javascript'; 243 s.async = true; 244 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 245 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 246 } 247 else { 248 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 249 } 250 })(window, document); 251 //--><!]]></script></div><div id="footer"> 252 <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> 253 <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[//><!-- 254 if (typeof(prettyPrint) !== 'undefined') { 255 prettyPrint(); 256 } 257 //--><!]]></script> 258 </body></html>