granicus.if.org Git - apache/blob - 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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>dbmmanage - Manage user authentication files in DBM format - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body id="manual-page"><div id="page-header">
  19 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  20 <p class="apache">Apache HTTP Server Version 2.5</p>
  21 <img alt="" src="../images/feather.png" /></div>
  22 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  23 <div id="path">
  24 <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.5</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>dbmmanage - Manage user authentication files in DBM format</h1>
  25 <div class="toplang">
  26 <p><span>Available Languages: </span><a href="../en/programs/dbmmanage.html" title="English">&nbsp;en&nbsp;</a> |
  27 <a href="../fr/programs/dbmmanage.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  28 <a href="../ko/programs/dbmmanage.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  29 <a href="../tr/programs/dbmmanage.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
  30 </div>
  31
  32     <p><code>dbmmanage</code> is used to create and update the DBM format files
  33     used to store usernames and password for basic authentication of HTTP users
  34     via <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>.
  35     Resources available from the Apache HTTP server can be restricted to just
  36     the users listed in the files created by <code>dbmmanage</code>. This
  37     program can only be used when the usernames are stored in a DBM file. To
  38     use a flat-file database see <code class="program"><a href="../programs/htpasswd.html">htpasswd</a></code>.</p>
  39
  40     <p>Another tool to maintain a DBM password database is
  41     <code class="program"><a href="../programs/htdbm.html">htdbm</a></code>.</p>
  42
  43     <p>This manual page only lists the command line arguments. For details of
  44     the directives necessary to configure user authentication in
  45     <code class="program"><a href="../programs/httpd.html">httpd</a></code> see the httpd manual, which is part of
  46     the Apache distribution or can be found at <a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
  47 </div>
  48 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
  49 <li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
  50 <li><img alt="" src="../images/down.gif" /> <a href="#bugs">Bugs</a></li>
  51 </ul><h3>See also</h3><ul class="seealso"><li><code class="program"><a href="../programs/httpd.html">httpd</a></code></li><li><code class="program"><a href="../programs/htdbm.html">htdbm</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><li><a href="#comments_section">Comments</a></li></ul></div>
  52 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  53 <div class="section">
  54 <h2><a name="synopsis" id="synopsis">Synopsis</a> <a title="Permanent link" href="#synopsis" class="permalink">&para;</a></h2>
  55     <p><code><strong>dbmmanage</strong> [ <var>encoding</var> ]
  56     <var>filename</var> add|adduser|check|delete|update
  57     <var>username</var>
  58     [ <var>encpasswd</var>
  59       [ <var>group</var>[,<var>group</var>...]
  60         [ <var>comment</var> ] ] ]</code></p>
  61
  62     <p><code><strong>dbmmanage</strong> <var>filename</var>
  63     view [ <var>username</var> ]</code></p>
  64
  65     <p><code><strong>dbmmanage</strong> <var>filename</var> import</code></p>
  66 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  67 <div class="section">
  68 <h2><a name="options" id="options">Options</a> <a title="Permanent link" href="#options" class="permalink">&para;</a></h2>
  69     <dl>
  70     <dt><code><var>filename</var></code></dt>
  71     <dd>The filename of the DBM format file. Usually without the extension
  72     <code>.db</code>, <code>.pag</code>, or <code>.dir</code>.</dd>
  73
  74     <dt><code><var>username</var></code></dt>
  75     <dd>The user for which the operations are performed. The <var>username</var>
  76     may not contain a colon (<code>:</code>).</dd>
  77
  78     <dt><code><var>encpasswd</var></code></dt>
  79     <dd>This is the already encrypted password to use for the
  80     <code>update</code> and <code>add</code> commands. You may use a hyphen
  81     (<code>-</code>) if you want to get prompted for the password, but fill
  82     in the fields afterwards. Additionally when using the <code>update</code>
  83     command, a period (<code>.</code>) keeps the original password
  84     untouched.</dd>
  85
  86     <dt><code><var>group</var></code></dt>
  87     <dd>A group, which the user is member of. A groupname may not contain a
  88     colon (<code>:</code>). You may use a hyphen (<code>-</code>) if you don't
  89     want to assign the user to a group, but fill in the comment field.
  90     Additionally when using the <code>update</code> command, a period
  91     (<code>.</code>) keeps the original groups untouched.</dd>
  92
  93     <dt><code><var>comment</var></code></dt>
  94     <dd>This is the place for your opaque comments about the user, like
  95     realname, mailaddress or such things. The server will ignore this
  96     field.</dd>
  97     </dl>
  98
  99     <h3><a name="options.encodings" id="options.encodings">Encodings</a></h3>
 100       <dl>
 101       <dt><code>-d</code></dt>
 102       <dd>crypt encryption (default, except on Win32, Netware)</dd>
 103
 104       <dt><code>-m</code></dt>
 105       <dd>MD5 encryption (default on Win32, Netware)</dd>
 106
 107       <dt><code>-s</code></dt>
 108       <dd>SHA1 encryption</dd>
 109
 110       <dt><code>-p</code></dt>
 111       <dd>plaintext (<em>not recommended</em>)</dd>
 112       </dl>
 113
 114
 115     <h3><a name="options.commands" id="options.commands">Commands</a></h3>
 116       <dl>
 117       <dt><code>add</code></dt>
 118       <dd>Adds an entry for <var>username</var> to <var>filename</var> using the
 119       encrypted password <var>encpasswd</var>.
 120
 121       <div class="example"><p><code>dbmmanage passwords.dat add rbowen foKntnEF3KSXA</code></p></div>
 122       </dd>
 123
 124       <dt><code>adduser</code></dt>
 125       <dd>Asks for a password and then adds an entry for <var>username</var> to
 126       <var>filename</var>.
 127
 128       <div class="example"><p><code>dbmmanage passwords.dat adduser krietz</code></p></div>
 129       </dd>
 130
 131       <dt><code>check</code></dt>
 132       <dd>Asks for a password and then checks if <var>username</var> is in
 133       <var>filename</var> and if it's password matches the specified one.
 134
 135       <div class="example"><p><code>dbmmanage passwords.dat check rbowen</code></p></div>
 136       </dd>
 137
 138       <dt><code>delete</code></dt>
 139       <dd>Deletes the <var>username</var> entry from <var>filename</var>.
 140
 141       <div class="example"><p><code>dbmmanage passwords.dat delete rbowen</code></p></div>
 142       </dd>
 143
 144       <dt><code>import</code></dt>
 145       <dd>Reads <code><var>username</var>:<var>password</var></code> entries
 146       (one per line) from <code>STDIN</code> and adds them to
 147       <var>filename</var>. The passwords already have to be crypted.</dd>
 148
 149       <dt><code>update</code></dt>
 150       <dd>Same as the <code>adduser</code> command, except that it makes
 151       sure <var>username</var> already exists in <var>filename</var>.
 152
 153       <div class="example"><p><code>dbmmanage passwords.dat update rbowen</code></p></div>
 154       </dd>
 155
 156       <dt><code>view</code></dt>
 157       <dd>Just displays the contents of the DBM file. If you specify a
 158       <var>username</var>, it displays the particular record only.
 159
 160       <div class="example"><p><code>dbmmanage passwords.dat view</code></p></div>
 161       </dd>
 162       </dl>
 163
 164 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 165 <div class="section">
 166 <h2><a name="bugs" id="bugs">Bugs</a> <a title="Permanent link" href="#bugs" class="permalink">&para;</a></h2>
 167     <p>One should be aware that there are a number of different DBM file formats
 168     in existence, and with all likelihood, libraries for more than one format
 169     may exist on your system. The three primary examples are SDBM, NDBM, the GNU
 170     project's GDBM, and Berkeley DB 2. Unfortunately, all these libraries use
 171     different file formats, and you must make sure that the file format used
 172     by <var>filename</var> is the same format that <code>dbmmanage</code>
 173     expects to see. <code>dbmmanage</code> currently has no way of determining
 174     what type of DBM file it is looking at. If used against the wrong format,
 175     will simply return nothing, or may create a different DBM file with a
 176     different name, or at worst, it may corrupt the DBM file if you were
 177     attempting to write to it.</p>
 178
 179     <p><code>dbmmanage</code> has a list of DBM format preferences, defined by
 180     the <code>@AnyDBM::ISA</code> array near the beginning of the program. Since
 181     we prefer the Berkeley DB 2 file format, the order in which
 182     <code>dbmmanage</code> will look for system libraries is Berkeley DB 2,
 183     then NDBM, then GDBM and then SDBM. The first library found will be the
 184     library <code>dbmmanage</code> will attempt to use for all DBM file
 185     transactions. This ordering is slightly  different than the standard
 186     <code>@AnyDBM::ISA</code> ordering in Perl, as well as the ordering used by
 187     the simple <code>dbmopen()</code> call in Perl, so if you use any other
 188     utilities to manage your DBM files, they must also follow this preference
 189     ordering. Similar care must be taken if using programs in other languages,
 190     like C, to access these files.</p>
 191
 192     <p>One can usually use the <code>file</code> program supplied with most
 193     Unix systems to see what format a DBM file is in.</p>
 194 </div></div>
 195 <div class="bottomlang">
 196 <p><span>Available Languages: </span><a href="../en/programs/dbmmanage.html" title="English">&nbsp;en&nbsp;</a> |
 197 <a href="../fr/programs/dbmmanage.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 198 <a href="../ko/programs/dbmmanage.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 199 <a href="../tr/programs/dbmmanage.html" hreflang="tr" rel="alternate" title="Türkçe">&nbsp;tr&nbsp;</a></p>
 200 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 201 <script type="text/javascript"><!--//--><![CDATA[//><!--
 202 var comments_shortname = 'httpd';
 203 var comments_identifier = 'http://httpd.apache.org/docs/trunk/programs/dbmmanage.html';
 204 (function(w, d) {
 205     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 206         d.write('<div id="comments_thread"><\/div>');
 207         var s = d.createElement('script');
 208         s.type = 'text/javascript';
 209         s.async = true;
 210         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 211         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 212     }
 213     else {
 214         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 215     }
 216 })(window, document);
 217 //--><!]]></script></div><div id="footer">
 218 <p class="apache">Copyright 2019 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>
 219 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 220 if (typeof(prettyPrint) !== 'undefined') {
 221     prettyPrint();
 222 }
 223 //--><!]]></script>
 224 </body></html>