apache/docs/manual/programs/htdigest.html.en

   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>htdigest - manage user files for digest 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.3</p>
  16 <img alt="" src="../images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  18 <div id="path">
  19 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>htdigest - manage user files for digest authentication</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="../en/programs/htdigest.html" title="English">&nbsp;en&nbsp;</a> |
  22 <a href="../ko/programs/htdigest.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  23 <a href="../tr/programs/htdigest.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  24 </div>
  25
  26     <p><code>htdigest</code> is used to create and update the flat-files used
  27     to store usernames, realm and password for digest authentication of HTTP
  28     users. Resources available from the Apache HTTP server can be restricted
  29     to just the users listed in the files created by <code>htdigest</code>.</p>
  30
  31     <p>This manual page only lists the command line arguments. For details of
  32     the directives necessary to configure digest authentication in
  33     <code class="program"><a href="../programs/httpd.html">httpd</a></code> see the Apache manual, which is part
  34     of the Apache distribution or can be found at
  35     <a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
  36 </div>
  37 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
  38 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
  39 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Considerations</a></li>
  40 </ul><h3>See also</h3><ul class="seealso"><li><code class="program"><a href="../programs/httpd.html">httpd</a></code></li><li><code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code></li></ul></div>
  41 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  42 <div class="section">
  43 <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
  44     <p><code><strong>htdigest</strong> [ -<strong>c</strong> ]
  45     <var>passwdfile</var> <var>realm</var> <var>username</var></code></p>
  46 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  47 <div class="section">
  48 <h2><a name="options" id="options">Options</a></h2>
  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.</dd>
  61
  62     <dt><code><var>username</var></code></dt>
  63     <dd>The user name to create or update in <var>passwdfile</var>. If
  64     <var>username</var> does not exist is this file, an entry is added. If it
  65     does exist, the password is changed.</dd>
  66     </dl>
  67 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  68 <div class="section">
  69 <h2><a name="security" id="security">Security Considerations</a></h2>
  70     <p>This program is not safe as a setuid executable. Do <em>not</em> make it
  71     setuid.</p>
  72 </div></div>
  73 <div class="bottomlang">
  74 <p><span>Available Languages: </span><a href="../en/programs/htdigest.html" title="English">&nbsp;en&nbsp;</a> |
  75 <a href="../ko/programs/htdigest.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  76 <a href="../tr/programs/htdigest.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  77 </div><div id="footer">
  78 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
  79 <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>
  80 </body></html>