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