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