docs/manual/programs/dbmmanage.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>dbmmanage - Manage user authentication files in DBM format - 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>dbmmanage - Manage user authentication files in DBM format</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="../en/programs/dbmmanage.html" title="English">&nbsp;en&nbsp;</a> |
  22 <a href="../ko/programs/dbmmanage.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  23 <a href="../tr/programs/dbmmanage.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  24 </div>
  25
  26     <p><code>dbmmanage</code> is used to create and update the DBM format files
  27     used to store usernames and password for basic authentication of HTTP users
  28     via <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>.
  29     Resources available from the Apache HTTP server can be restricted to just
  30     the users listed in the files created by <code>dbmmanage</code>. This
  31     program can only be used when the usernames are stored in a DBM file. To
  32     use a flat-file database see <code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code>.</p>
  33
  34     <p>This manual page only lists the command line arguments. For details of
  35     the directives necessary to configure user authentication in
  36     <code class="program"><a href="../programs/httpd.html">httpd</a></code> see the httpd manual, which is part of
  37     the Apache distribution or can be found at <a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
  38 </div>
  39 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
  40 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
  41 <li><img alt="" src="../images/down.gif" /> <a href="#bugs">Bugs</a></li>
  42 </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_authn_dbm.html">mod_authn_dbm</a></code></li><li><code class="module"><a href="../mod/mod_authz_dbm.html">mod_authz_dbm</a></code></li></ul></div>
  43 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  44 <div class="section">
  45 <h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
  46     <p><code><strong>dbmmanage</strong> [ <var>encoding</var> ]
  47     <var>filename</var> add|adduser|check|delete|update
  48     <var>username</var>
  49     [ <var>encpasswd</var>
  50       [ <var>group</var>[,<var>group</var>...]
  51         [ <var>comment</var> ] ] ]</code></p>
  52
  53     <p><code><strong>dbmmanage</strong> <var>filename</var>
  54     view [ <var>username</var> ]</code></p>
  55
  56     <p><code><strong>dbmmanage</strong> <var>filename</var> import</code></p>
  57 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  58 <div class="section">
  59 <h2><a name="options" id="options">Options</a></h2>
  60     <dl>
  61     <dt><code><var>filename</var></code></dt>
  62     <dd>The filename of the DBM format file. Usually without the extension
  63     <code>.db</code>, <code>.pag</code>, or <code>.dir</code>.</dd>
  64
  65     <dt><code><var>username</var></code></dt>
  66     <dd>The user for which the operations are performed. The <var>username</var>
  67     may not contain a colon (<code>:</code>).</dd>
  68
  69     <dt><code><var>encpasswd</var></code></dt>
  70     <dd>This is the already encrypted password to use for the
  71     <code>update</code> and <code>add</code> commands. You may use a hyphen
  72     (<code>-</code>) if you want to get prompted for the password, but fill
  73     in the fields afterwards. Additionally when using the <code>update</code>
  74     command, a period (<code>.</code>) keeps the original password
  75     untouched.</dd>
  76
  77     <dt><code><var>group</var></code></dt>
  78     <dd>A group, which the user is member of. A groupname may not contain a
  79     colon (<code>:</code>). You may use a hyphen (<code>-</code>) if you don't
  80     want to assign the user to a group, but fill in the comment field.
  81     Additionally when using the <code>update</code> command, a period
  82     (<code>.</code>) keeps the original groups untouched.</dd>
  83
  84     <dt><code><var>comment</var></code></dt>
  85     <dd>This is the place for your opaque comments about the user, like
  86     realname, mailaddress or such things. The server will ignore this
  87     field.</dd>
  88     </dl>
  89
  90     <h3><a name="options.encodings" id="options.encodings">Encodings</a></h3>
  91       <dl>
  92       <dt><code>-d</code></dt>
  93       <dd>crypt encryption (default, except on Win32, Netware)</dd>
  94
  95       <dt><code>-m</code></dt>
  96       <dd>MD5 encryption (default on Win32, Netware)</dd>
  97
  98       <dt><code>-s</code></dt>
  99       <dd>SHA1 encryption</dd>
 100
 101       <dt><code>-p</code></dt>
 102       <dd>plaintext (<em>not recommended</em>)</dd>
 103       </dl>
 104
 105
 106     <h3><a name="options.commands" id="options.commands">Commands</a></h3>
 107       <dl>
 108       <dt><code>add</code></dt>
 109       <dd>Adds an entry for <var>username</var> to <var>filename</var> using the
 110       encrypted password <var>encpasswd</var>.
 111
 112       <div class="example"><p><code>dbmmanage passwords.dat add rbowen foKntnEF3KSXA</code></p></div>
 113       </dd>
 114
 115       <dt><code>adduser</code></dt>
 116       <dd>Asks for a password and then adds an entry for <var>username</var> to
 117       <var>filename</var>.
 118
 119       <div class="example"><p><code>dbmmanage passwords.dat adduser krietz</code></p></div>
 120       </dd>
 121
 122       <dt><code>check</code></dt>
 123       <dd>Asks for a password and then checks if <var>username</var> is in
 124       <var>filename</var> and if it's password matches the specified one.
 125
 126       <div class="example"><p><code>dbmmanage passwords.dat check rbowen</code></p></div>
 127       </dd>
 128
 129       <dt><code>delete</code></dt>
 130       <dd>Deletes the <var>username</var> entry from <var>filename</var>.
 131
 132       <div class="example"><p><code>dbmmanage passwords.dat delete rbowen</code></p></div>
 133       </dd>
 134
 135       <dt><code>import</code></dt>
 136       <dd>Reads <code><var>username</var>:<var>password</var></code> entries
 137       (one per line) from <code>STDIN</code> and adds them to
 138       <var>filename</var>. The passwords already have to be crypted.</dd>
 139
 140       <dt><code>update</code></dt>
 141       <dd>Same as the <code>adduser</code> command, except that it makes
 142       sure <var>username</var> already exists in <var>filename</var>.
 143
 144       <div class="example"><p><code>dbmmanage passwords.dat update rbowen</code></p></div>
 145       </dd>
 146
 147       <dt><code>view</code></dt>
 148       <dd>Just displays the contents of the DBM file. If you specify a
 149       <var>username</var>, it displays the particular record only.
 150
 151       <div class="example"><p><code>dbmmanage passwords.dat view</code></p></div>
 152       </dd>
 153       </dl>
 154
 155 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 156 <div class="section">
 157 <h2><a name="bugs" id="bugs">Bugs</a></h2>
 158     <p>One should be aware that there are a number of different DBM file formats
 159     in existence, and with all likelihood, libraries for more than one format
 160     may exist on your system. The three primary examples are SDBM, NDBM, the GNU
 161     project's GDBM, and Berkeley DB 2. Unfortunately, all these libraries use
 162     different file formats, and you must make sure that the file format used
 163     by <var>filename</var> is the same format that <code>dbmmanage</code>
 164     expects to see. <code>dbmmanage</code> currently has no way of determining
 165     what type of DBM file it is looking at. If used against the wrong format,
 166     will simply return nothing, or may create a different DBM file with a
 167     different name, or at worst, it may corrupt the DBM file if you were
 168     attempting to write to it.</p>
 169
 170     <p><code>dbmmanage</code> has a list of DBM format preferences, defined by
 171     the <code>@AnyDBM::ISA</code> array near the beginning of the program. Since
 172     we prefer the Berkeley DB 2 file format, the order in which
 173     <code>dbmmanage</code> will look for system libraries is Berkeley DB 2,
 174     then NDBM, then GDBM and then SDBM. The first library found will be the
 175     library <code>dbmmanage</code> will attempt to use for all DBM file
 176     transactions. This ordering is slightly  different than the standard
 177     <code>@AnyDBM::ISA</code> ordering in Perl, as well as the ordering used by
 178     the simple <code>dbmopen()</code> call in Perl, so if you use any other
 179     utilities to manage your DBM files, they must also follow this preference
 180     ordering. Similar care must be taken if using programs in other languages,
 181     like C, to access these files.</p>
 182
 183     <p>One can usually use the <code>file</code> program supplied with most
 184     Unix systems to see what format a DBM file is in.</p>
 185 </div></div>
 186 <div class="bottomlang">
 187 <p><span>Available Languages: </span><a href="../en/programs/dbmmanage.html" title="English">&nbsp;en&nbsp;</a> |
 188 <a href="../ko/programs/dbmmanage.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 189 <a href="../tr/programs/dbmmanage.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 190 </div><div id="footer">
 191 <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>
 192 <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>
 193 </body></html>