github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/programs/dbmmanage.html.en (about)

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