Hi,
Attempt to make a htdbm utility manual.
Index: index.html
===================================================================
RCS file: /home/cvspublic/httpd-2.0/docs/manual/programs/index.html,v
retrieving revision 1.2
diff -u -r1.2 index.html
--- index.html 2001/09/22 19:38:35 1.2
+++ index.html 2001/11/21 09:48:30
@@ -50,6 +50,11 @@
<dd>Create and update user authentication files for basic
authentication</dd>
+ <dt><a href="htdbm.html">htdbm</a></dt>
+
+ <dd>Create and update user authentication databases for basic
+ authentication</dd>
+
<dt><a href="logresolve.html">logresolve</a></dt>
<dd>Resolve hostnames for IP-addresses in Apache
MT.
Title: Manual Page: htpasswd - Apache HTTP Server
Manual Page: htdbm
NAME
htdbm - Create and update user authentication files
SYNOPSIS
htdbm [ -c | -v | -x] [ -m ] database username
htdbm -b [ -c | -v ] [ -m | -d | -p | -s ] database
username password
htdbm -n [ -m | -d | -s | -p ] username
htdbm -nb [ -m | -d | -s | -p ] username password
htdbm -l database
DESCRIPTION
htdbm is used to create and update the DBM database used to
store usernames and password for basic authentication of
HTTP users. If htdbm cannot access a file, such as not being
being able to write to the output file or not being able to
read the file in order to update it, it returns an error
status and makes no changes.
Resources available from the httpd Apache web server can be
restricted to just the users listed in the files created by
htdbm. This program can only manage usernames and passwords
words stored in a default APR DBM database format.
htdbm encrypts passwords using either a version of MD5
modified for Apache, or the system's crypt() routine. Files
managed by htdbm may contain both types of passwords; some
user records may have MD5-encrypted passwords while others
in the same file may have passwords encrypted with crypt().
This manual page only lists the command line arguments. For
details of the directives necessary to configure user
authentication in httpd see the Apache manual, which is part
of the Apache distribution or can be found at
<URL:http://www.apache.org/>.
OPTIONS
-b Use batch mode; i.e., get the password from the command
line rather than prompting for it. This option should
be used with extreme care, since the password is
clearly visible on the command line.
-c Create the database. If database already exists, it is
rewritten and truncated. This option cannot be combined
with the -n option.
-n Display the results on standard output rather than
updating a file. This is useful for generating pass-
word records acceptable to Apache for inclusion in
non-text data stores. This option changes the syntax
of the command line, since the database argument
(usually the first one) is omitted. It cannot be com-
bined with the -c option.
-m Use MD5 encryption for passwords. On Windows and TPF,
this is the default.
-d Use crypt() encryption for passwords. The default on
all platforms but Windows and TPF. Though possibly sup-
ported by htdbm on all platforms, it is not supported
by the httpd server on Windows and TPF.
-s Use SHA encryption for passwords. Facilitates migration
from/to Netscape servers using the LDAP Directory
Interchange Format (ldif).
-p Use plaintext passwords. Though htdbm will support
creation on all platforms, the httpd daemon will only
accept plain text passwords on Windows and TPF.
-v Verify the username/password record in the database.
-x Remove the username record from the database.
-l Print the contend of the database to the stdout.
database
Name of the file to contain the user name and password.
If -c is given, this database is created if it does not
already exist, or rewritten and truncated if it does
exist.
username
The username to create or update in database. If
username does not exist in this database, an entry is
added. If it does exist, the password is changed.
password
The plaintext password to be encrypted and stored in
the database. Only used with the -b flag.
EXIT STATUS
htdbm returns a zero status ("true") if the username and
password have been successfully added or updated in the
passwdfile. htdbm returns 1 if it encounters some problem
accessing files, 2 if there was a syntax problem with the
command line, 3 if the password was entered interactively
and the verification entry didn't match, 4 if its operation
was interrupted, 5 if a value is too long (username,
filename, password, or final computed record), and 6 if the
username contains illegal characters (see the RESTRICTIONS
section).
EXAMPLES
htdbm /usr/local/etc/apache/.htpasswd-users jsmith
Adds or modifies the password for user jsmith. The user
is prompted for the password. If executed on a Windows
system, the password will be encrypted using the modi-
fied Apache MD5 algorithm; otherwise, the system's
crypt() routine will be used. If the database does not
exist, htdbm will do nothing except return an error.
htdbm -c /home/doe/public_html/.htpasswd jane
Creates a new database and stores a record in it for
user jane. The user is prompted for the password. If
the database exists and cannot be read, or cannot be
written, it is not altered and htdbm will display a
message and return an error status.
htdbm -mb /usr/web/.htpasswd-all jones Pwd4Steve
Encrypts the password from the command line (Pwd4Steve)
using the MD5 algorithm, and stores it in the specified
file.
SECURITY CONSIDERATIONS
Web password database such as those managed by htdbm should
not be within the Web server's URI space -- that is, they
should not be fetchable with a browser.
The use of the -b option is discouraged, since when it is
used the unencrypted password appears on the command line.
RESTRICTIONS
On the Windows and MPE platforms, passwords encrypted with
htdbm are limited to no more than 255 characters in length
Longer passwords will be truncated to 255 characters.
The MD5 algorithm used by htdbm is specific to the Apache
software; passwords encrypted using it will not be usable
with other Web servers.
Usernames are limited to 255 bytes and may not include the
character ':'.
SEE ALSO
httpd(8) and the scripts in support/SHA1 which come with the
distribution.
|
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
