home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 November / PCWorld_2003-11_cd.bin / Komunik / apache / apache_2.0.47-win32-x86-no_ssl.msi / Data.Cab / F251278_htpasswd.html.en < prev    next >
Extensible Markup Language  |  2003-06-04  |  12KB  |  213 lines
  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>htpasswd - Manage user files for basic authentication - 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 id="manual-page"><div id="page-header">
  14. <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>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="../images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>htpasswd - Manage user files for basic authentication</h1>
  20. <div class="toplang">
  21. <p><span>Available Languages: </span><a href="../en/programs/htpasswd.html" title="English"> en </a></p>
  22. </div>
  23.  
  24.     <p><code>htpasswd</code> is used to create and update the flat-files used to
  25.     store usernames and password for basic authentication of HTTP users. If
  26.     <code>htpasswd</code> cannot access a file, such as not being able to write
  27.     to the output file or not being able to read the file in order to update it,
  28.     it returns an error status and makes no changes.</p>
  29.  
  30.     <p>Resources available from the Apache HTTP server can be restricted to
  31.     just the users listed in the files created by <code>htpasswd</code>. This
  32.     program can only manage usernames and passwords stored in a flat-file. It
  33.     can encrypt and display password information for use in other types of data
  34.     stores, though. To use a DBM database see <a href="dbmmanage.html">dbmmanage</a>.</p>
  35.  
  36.     <p><code>htpasswd</code> encrypts passwords using either a version of MD5
  37.     modified for Apache, or the system's <code>crypt()</code> routine. Files
  38.     managed by <code>htpasswd</code> may contain both types of passwords; some
  39.     user records may have MD5-encrypted passwords while others in the same file
  40.     may have passwords encrypted with <code>crypt()</code>.</p>
  41.  
  42.     <p>This manual page only lists the command line arguments. For details of
  43.     the directives necessary to configure user authentication in
  44.     <a href="httpd.html">httpd</a> see the Apache manual, which is part of the
  45.     Apache distribution or can be found at <a href="http://httpd.apache.org">http://httpd.apache.org/</a>.</p>
  46. </div>
  47. <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
  48. <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
  49. <li><img alt="" src="../images/down.gif" /> <a href="#exit">Exit Status</a></li>
  50. <li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li>
  51. <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Considerations</a></li>
  52. <li><img alt="" src="../images/down.gif" /> <a href="#restrictions">Restrictions</a></li>
  53. </ul><h3>See also</h3><ul class="seealso"><li><a href="httpd.html">httpd</a></li><li>The scripts in support/SHA1 which come with the
  54. distribution.</li></ul></div>
  55. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  56. <div class="section">
  57. <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
  58.     <p><code><strong>htpasswd</strong>
  59.     [ -<strong>c</strong> ]
  60.     [ -<strong>m</strong> ]
  61.     [ -<strong>D</strong> ] <var>passwdfile</var> <var>username</var></code></p>
  62.  
  63.     <p><code><strong>htpasswd</strong> -<strong>b</strong>
  64.     [ -<strong>c</strong> ]
  65.     [ -<strong>m</strong> |
  66.       -<strong>d</strong> |
  67.       -<strong>p</strong> |
  68.       -<strong>s</strong> ] 
  69.     [ -<strong>D</strong> ]  <var>passwdfile</var> <var>username</var>
  70.     <var>password</var></code></p>
  71.  
  72.     <p><code><strong>htpasswd</strong> -<strong>n</strong>
  73.     [ -<strong>m</strong> |
  74.       -<strong>d</strong> |
  75.       -<strong>s</strong> |
  76.       -<strong>p</strong> ] <var>username</var></code></p>
  77.  
  78.     <p><code><strong>htpasswd</strong> -<strong>nb</strong>
  79.     [ -<strong>m</strong> |
  80.       -<strong>d</strong> |
  81.       -<strong>s</strong> |
  82.       -<strong>p</strong> ] <var>username</var> <var>password</var></code></p>
  83. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  84. <div class="section">
  85. <h2><a name="options" id="options">Options</a></h2>
  86.     <dl>
  87.     <dt><code>-b</code></dt>
  88.     <dd>Use batch mode; <em>i.e.</em>, get the password from the command line
  89.     rather than prompting for it. This option should be used with extreme care,
  90.     since <strong>the password is clearly visible</strong> on the command
  91.     line.</dd>
  92.  
  93.     <dt><code>-c</code></dt>
  94.     <dd>Create the <var>passwdfile</var>. If <var>passwdfile</var> already
  95.     exists, it is rewritten and truncated. This option cannot be combined with
  96.     the <code>-n</code> option.</dd>
  97.  
  98.     <dt><code>-n</code></dt>
  99.     <dd>Display the results on standard output rather than updating a file.
  100.     This is useful for generating password records acceptable to Apache for
  101.     inclusion in non-text data stores. This option changes the syntax of the
  102.     command line, since the <var>passwdfile</var> argument (usually the first
  103.     one) is omitted. It cannot be combined with the <code>-c</code> option.</dd>
  104.  
  105.     <dt><code>-m</code></dt>
  106.     <dd>Use MD5 encryption for passwords. On Windows, Netware and TPF, this is
  107.     the default.</dd>
  108.  
  109.     <dt><code>-d</code></dt>
  110.     <dd>Use <code>crypt()</code> encryption for passwords. The default on all
  111.     platforms but Windows, Netware and TPF. Though possibly supported by
  112.     <code>htpasswd</code> on all platforms, it is not supported by the
  113.     <a href="httpd.html">httpd</a> server on Windows, Netware and TPF.</dd>
  114.  
  115.     <dt><code>-s</code></dt>
  116.     <dd>Use SHA encryption for passwords. Facilitates migration from/to Netscape
  117.     servers using the LDAP Directory Interchange Format (ldif).</dd>
  118.  
  119.     <dt><code>-p</code></dt>
  120.     <dd>Use plaintext passwords. Though <code>htpasswd</code> will support
  121.     creation on all platforms, the <a href="httpd.html">httpd</a> daemon will
  122.     only accept plain text passwords on Windows, Netware and TPF.</dd>
  123.  
  124.     <dt><code>-D</code></dt>
  125.     <dd>Delete user. If the username exists in the specified htpasswd file, it
  126.     will be deleted.</dd>
  127.     
  128.     <dt><code><var>passwdfile</var></code></dt>
  129.     <dd>Name of the file to contain the user name and password. If
  130.     <code>-c</code> is given, this file is created if it does not already exist,
  131.     or rewritten and truncated if it does exist.</dd>
  132.  
  133.     <dt><code><var>username</var></code></dt>
  134.     <dd>The username to create or update in <var>passwdfile</var>. If
  135.     <var>username</var> does not exist in this file, an entry is added. If it
  136.     does exist, the password is changed.</dd>
  137.  
  138.     <dt><code><var>password</var></code></dt>
  139.     <dd>The plaintext password to be encrypted and stored  in the file. Only
  140.     used with the <code>-b</code> flag.</dd>
  141.     </dl>
  142. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  143. <div class="section">
  144. <h2><a name="exit" id="exit">Exit Status</a></h2>
  145.     <p><code>htpasswd</code> returns a zero status ("true") if the username and
  146.     password have been successfully added or updated in the
  147.     <var>passwdfile</var>. <code>htpasswd</code> returns <code>1</code> if it
  148.     encounters some problem accessing files, <code>2</code> if there was a
  149.     syntax problem with the command line, <code>3</code> if the password was
  150.     entered interactively and the verification entry didn't match,
  151.     <code>4</code> if its operation was interrupted, <code>5</code> if a value
  152.     is too long (username, filename, password, or final computed record),
  153.     <code>6</code> if the username contains illegal characters (see the
  154.     <a href="#restrictions">Restrictions section</a>), and <code>7</code>
  155.     if the file is not a valid password file.</p>
  156. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  157. <div class="section">
  158. <h2><a name="examples" id="examples">Examples</a></h2>
  159.     <div class="example"><p><code>
  160.       htpasswd /usr/local/etc/apache/.htpasswd-users jsmith
  161.     </code></p></div>
  162.  
  163.     <p>Adds or modifies the password for user <code>jsmith</code>. The user
  164.     is prompted for the password. If executed on a Windows system, the password
  165.     will be encrypted using the  modified Apache MD5 algorithm; otherwise, the
  166.     system's <code>crypt()</code> routine will be used. If the file does not
  167.     exist, <code>htpasswd</code> will do nothing except return an error.</p>
  168.  
  169.     <div class="example"><p><code>
  170.       htpasswd -c /home/doe/public_html/.htpasswd jane
  171.     </code></p></div>
  172.  
  173.     <p>Creates a new file and stores a record in it for user <code>jane</code>.
  174.     The user is prompted for the password. If the file exists and cannot be
  175.     read, or cannot be written, it is not altered and <code>htpasswd</code>
  176.     will display a message and return an error status.</p>
  177.  
  178.     <div class="example"><p><code>
  179.       htpasswd -mb /usr/web/.htpasswd-all jones Pwd4Steve
  180.     </code></p></div>
  181.  
  182.     <p>Encrypts the password from the command line (<code>Pwd4Steve</code>)
  183.     using the MD5 algorithm, and stores it in the specified file.</p>
  184. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  185. <div class="section">
  186. <h2><a name="security" id="security">Security Considerations</a></h2>
  187.     <p>Web password files such as those managed by <code>htpasswd</code> should
  188.     <em>not</em> be within the Web server's URI space -- that is, they should
  189.     not be fetchable with a browser.</p>
  190.  
  191.     <p>The use of the <code>-b</code> option is discouraged, since when it is
  192.     used the unencrypted password appears on the command line.</p>
  193. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  194. <div class="section">
  195. <h2><a name="restrictions" id="restrictions">Restrictions</a></h2>
  196.     <p>On the Windows and MPE platforms, passwords encrypted with
  197.     <code>htpasswd</code> are limited to no more than <code>255</code>
  198.     characters in length. Longer passwords will be truncated to 255
  199.     characters.</p>
  200.  
  201.     <p>The MD5 algorithm used by <code>htpasswd</code> is specific to the Apache
  202.     software; passwords encrypted using it will not be usable with other Web
  203.     servers.</p>
  204.  
  205.     <p>Usernames are limited to <code>255</code> bytes and may not include the
  206.     character <code>:</code>.</p>
  207. </div></div>
  208. <div class="bottomlang">
  209. <p><span>Available Languages: </span><a href="../en/programs/htpasswd.html" title="English"> en </a></p>
  210. </div><div id="footer">
  211. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  212. <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>
  213. </body></html>