docs/manual/programs/htdigest.xml

<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->

<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->

<manualpage metafile="htdigest.xml.meta">
<parentdocument href="./">Programs</parentdocument>

<title>htdigest - manage user files for digest authentication</title>

<summary>
    <p><program>htdigest</program> is used to create and update the flat-files used
    to store usernames, realm and password for digest authentication of HTTP
    users. Resources available from the Apache HTTP server can be restricted
    to just the users listed in the files created by <program>htdigest</program>.</p>

    <p>This manual page only lists the command line arguments. For details of
    the directives necessary to configure digest authentication in
    <program>httpd</program> see the Apache manual, which is part
    of the Apache distribution or can be found at
    <a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
</summary>
<seealso><program>httpd</program></seealso>
<seealso><module>mod_auth_digest</module></seealso>

<section id="synopsis"><title>Synopsis</title>
    <p><code><strong>htdigest</strong> [ -<strong>c</strong> ]
    <var>passwdfile</var> <var>realm</var> <var>username</var></code></p>
</section>

<section id="options"><title>Options</title>
    <dl>
    <dt><code>-c</code></dt>
    <dd>Create the <var>passwdfile</var>. If <var>passwdfile</var> already
    exists, it is deleted first.</dd>

    <dt><code><var>passwdfile</var></code></dt>
    <dd>Name of the file to contain the username, realm and password. If
    <code>-c</code> is given, this file is created if it does not already
    exist, or deleted and recreated if it does exist.</dd>

    <dt><code><var>realm</var></code></dt>
    <dd>The realm name to which the user name belongs. See
    <rfc section="3.2.1">2617</rfc> for more details.
    </dd>

    <dt><code><var>username</var></code></dt>
    <dd>The user name to create or update in <var>passwdfile</var>. If
    <var>username</var> does not exist is this file, an entry is added. If it
    does exist, the password is changed.</dd>
    </dl>
</section>

<section id="security"><title>Security Considerations</title>
    <p>This program is not safe as a setuid executable. Do <em>not</em> make it
    setuid.</p>
</section>

<section id="files"><title>Files</title>

<p>The digest authentication file path is specified as an argument on the
command line and may be located anywhere on the filesystem.</p>

<dl>
<dt><var>passwdfile</var></dt>
<dd>The flat-file containing usernames, realms, and password hashes.</dd>
</dl>

</section>

</manualpage>