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