granicus.if.org Git - apache/blob - docs/manual/programs/htdigest.xml

   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 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <manualpage metafile="htdigest.xml.meta">
  24 <parentdocument href="./">Programs</parentdocument>
  25
  26 <title>htdigest - manage user files for digest authentication</title>
  27
  28 <summary>
  29     <p><code>htdigest</code> is used to create and update the flat-files used
  30     to store usernames, realm and password for digest authentication of HTTP
  31     users. Resources available from the Apache HTTP server can be restricted
  32     to just the users listed in the files created by <code>htdigest</code>.</p>
  33
  34     <p>This manual page only lists the command line arguments. For details of
  35     the directives necessary to configure digest authentication in
  36     <program>httpd</program> see the Apache manual, which is part
  37     of the Apache distribution or can be found at
  38     <a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
  39 </summary>
  40 <seealso><program>httpd</program></seealso>
  41 <seealso><module>mod_auth_digest</module></seealso>
  42
  43 <section id="synopsis"><title>Synopsis</title>
  44     <p><code><strong>htdigest</strong> [ -<strong>c</strong> ]
  45     <var>passwdfile</var> <var>realm</var> <var>username</var></code></p>
  46 </section>
  47
  48 <section id="options"><title>Options</title>
  49     <dl>
  50     <dt><code>-c</code></dt>
  51     <dd>Create the <var>passwdfile</var>. If <var>passwdfile</var> already
  52     exists, it is deleted first.</dd>
  53
  54     <dt><code><var>passwdfile</var></code></dt>
  55     <dd>Name of the file to contain the username, realm and password. If
  56     <code>-c</code> is given, this file is created if it does not already
  57     exist, or deleted and recreated if it does exist.</dd>
  58
  59     <dt><code><var>realm</var></code></dt>
  60     <dd>The realm name to which the user name belongs. See
  61     <a href="http://tools.ietf.org/html/rfc2617#section-3.2.1">
  62     http://tools.ietf.org/html/rfc2617#section-3.2.1</a> for more details.
  63     </dd>
  64
  65     <dt><code><var>username</var></code></dt>
  66     <dd>The user name to create or update in <var>passwdfile</var>. If
  67     <var>username</var> does not exist is this file, an entry is added. If it
  68     does exist, the password is changed.</dd>
  69     </dl>
  70 </section>
  71
  72 <section id="security"><title>Security Considerations</title>
  73     <p>This program is not safe as a setuid executable. Do <em>not</em> make it
  74     setuid.</p>
  75 </section>
  76
  77 </manualpage>