home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278510_dbmmanage.xml < prev    next >
Extensible Markup Language  |  2004-02-09  |  8KB  |  168 lines
  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.  
  5. <!--
  6.  Copyright 2003-2004 The Apache Software Foundation
  7.  
  8.  Licensed under the Apache License, Version 2.0 (the "License");
  9.  you may not use this file except in compliance with the License.
  10.  You may obtain a copy of the License at
  11.  
  12.      http://www.apache.org/licenses/LICENSE-2.0
  13.  
  14.  Unless required by applicable law or agreed to in writing, software
  15.  distributed under the License is distributed on an "AS IS" BASIS,
  16.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17.  See the License for the specific language governing permissions and
  18.  limitations under the License.
  19. -->
  20.  
  21. <manualpage metafile="dbmmanage.xml.meta">
  22. <parentdocument href="./">Programs</parentdocument>
  23.  
  24. <title>dbmmanage - Manage user authentication files in DBM format</title>
  25.  
  26. <summary>
  27.     <p><code>dbmmanage</code> is used to create and update the DBM format files
  28.     used to store usernames and password for basic authentication of HTTP users.
  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 <a href="htpasswd.html">htpasswd</a>.</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.     <a href="httpd.html">httpd</a> see the httpd manual, which is part of
  37.     the Apache distribution or can be found at <a
  38.     href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
  39. </summary>
  40. <seealso><a href="httpd.html">httpd</a></seealso>
  41. <seealso><module>mod_auth_dbm</module></seealso>
  42.  
  43. <section id="synopsis"><title>Synopsis</title>
  44.     <p><code><strong>dbmmanage</strong> [ <var>encoding</var> ]
  45.     <var>filename</var> add|adduser|check|delete|update
  46.     <var>username</var>
  47.     [ <var>encpasswd</var>
  48.       [ <var>group</var>[,<var>group</var>...]
  49.         [ <var>comment</var> ] ] ]</code></p>
  50.  
  51.     <p><code><strong>dbmmanage</strong> <var>filename</var>
  52.     view [ <var>username</var> ]</code></p>
  53.  
  54.     <p><code><strong>dbmmanage</strong> <var>filename</var> import</code></p>
  55. </section>
  56.  
  57. <section id="options"><title>Options</title>
  58.     <dl>
  59.     <dt><code><var>filename</var></code></dt>
  60.     <dd>The filename of the DBM format file. Usually without the extension
  61.     <code>.db</code>, <code>.pag</code>, or <code>.dir</code>.</dd>
  62.  
  63.     <dt><code><var>username</var></code></dt>
  64.     <dd>The user for which the operations are performed. The <var>username</var>
  65.     may not contain a colon (<code>:</code>).</dd>
  66.  
  67.     <dt><code><var>encpasswd</var></code></dt>
  68.     <dd>This is the already encrypted password to use for the
  69.     <code>update</code> and <code>add</code> commands. You may use a hyphen
  70.     (<code>-</code>) if you want to get prompted for the password, but fill
  71.     in the fields afterwards. Additionally when using the <code>update</code>
  72.     command, a period (<code>.</code>) keeps the original password
  73.     untouched.</dd>
  74.  
  75.     <dt><code><var>group</var></code></dt>
  76.     <dd>A group, which the user is member of. A groupname may not contain a
  77.     colon (<code>:</code>). You may use a hyphen (<code>-</code>) if you don't
  78.     want to assign the user to a group, but fill in the comment field.
  79.     Additionally when using the <code>update</code> command, a period
  80.     (<code>.</code>) keeps the original groups untouched.</dd>
  81.  
  82.     <dt><code><var>comment</var></code></dt>
  83.     <dd>This is the place for your opaque comments about the user, like
  84.     realname, mailaddress or such things. The server will ignore this
  85.     field.</dd>
  86.     </dl>
  87.  
  88.     <section id="options.encodings"><title>Encodings</title>
  89.       <dl>
  90.       <dt><code>-d</code></dt>
  91.       <dd>crypt encryption (default, except on Win32, Netware)</dd>
  92.  
  93.       <dt><code>-m</code></dt>
  94.       <dd>MD5 encryption (default on Win32, Netware)</dd>
  95.  
  96.       <dt><code>-s</code></dt>
  97.       <dd>SHA1 encryption</dd>
  98.  
  99.       <dt><code>-p</code></dt>
  100.       <dd>plaintext (<em>not recommended</em>)</dd>
  101.       </dl>
  102.     </section>
  103.  
  104.     <section id="options.commands"><title>Commands</title>
  105.       <dl>
  106.       <dt><code>add</code></dt>
  107.       <dd>Adds an entry for <var>username</var> to <var>filename</var> using the
  108.       encrypted password <var>encpasswd</var>.</dd>
  109.  
  110.       <dt><code>adduser</code></dt>
  111.       <dd>Asks for a password and then adds an entry for <var>username</var> to
  112.       <var>filename</var>.</dd>
  113.  
  114.       <dt><code>check</code></dt>
  115.       <dd>Asks for a password and then checks if <var>username</var> is in
  116.       <var>filename</var> and if it's password matches the specified one.</dd>
  117.  
  118.       <dt><code>delete</code></dt>
  119.       <dd>Deletes the <var>username</var> entry from <var>filename</var>.</dd>
  120.  
  121.       <dt><code>import</code></dt>
  122.       <dd>Reads <code><var>username</var>:<var>password</var></code> entries
  123.       (one per line) from <code>STDIN</code> and adds them to
  124.       <var>filename</var>. The passwords already have to be crypted.</dd>
  125.  
  126.       <dt><code>update</code></dt>
  127.       <dd>Same as the <code>adduser</code> command, except that it makes
  128.       sure <var>username</var> already exists in <var>filename</var>.</dd>
  129.  
  130.       <dt><code>view</code></dt>
  131.       <dd>Just displays the contents of the DBM file. If you specify a
  132.       <var>username</var>, it displays the particular record only.</dd>
  133.       </dl>
  134.     </section>
  135. </section>
  136.  
  137. <section id="bugs"><title>Bugs</title>
  138.     <p>One should be aware that there are a number of different DBM file formats
  139.     in existence, and with all likelihood, libraries for more than one format
  140.     may exist on your system. The three primary examples are SDBM, NDBM, the GNU
  141.     project's GDBM, and Berkeley DB 2. Unfortunately, all these libraries use
  142.     different file formats, and you must make sure that the file format used
  143.     by <var>filename</var> is the same format that <code>dbmmanage</code>
  144.     expects to see. <code>dbmmanage</code> currently has no way of determining
  145.     what type of DBM file it is looking at. If used against the wrong format,
  146.     will simply return nothing, or may create a different DBM file with a
  147.     different name, or at worst, it may corrupt the DBM file if you were
  148.     attempting to write to it.</p>
  149.  
  150.     <p><code>dbmmanage</code> has a list of DBM format preferences, defined by
  151.     the <code>@AnyDBM::ISA</code> array near the beginning of the program. Since
  152.     we prefer the Berkeley DB 2 file format, the order in which
  153.     <code>dbmmanage</code> will look for system libraries is Berkeley DB 2,
  154.     then NDBM, then GDBM and then SDBM. The first library found will be the
  155.     library <code>dbmmanage</code> will attempt to use for all DBM file
  156.     transactions. This ordering is slightly  different than the standard
  157.     <code>@AnyDBM::ISA</code> ordering in Perl, as well as the ordering used by
  158.     the simple <code>dbmopen()</code> call in Perl, so if you use any other
  159.     utilities to manage your DBM files, they must also follow this preference
  160.     ordering. Similar care must be taken if using programs in other languages,
  161.     like C, to access these files.</p>
  162.  
  163.     <p>One can usually use the <code>file</code> program supplied with most
  164.     Unix systems to see what format a DBM file is in.</p>
  165. </section>
  166.  
  167. </manualpage>
  168.