← Back to branch summary

~ubuntu-branches/ubuntu/feisty/apache2/feisty

« back to all changes in this revision

Viewing changes to docs/man/htpasswd.1

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Barth
  • Date: 2006-12-09 21:05:45 UTC
  • mfrom: (0.6.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061209210545-h70s0xaqc2v8vqr2
Tags: 2.2.3-3.2
http://bugs.debian.org/396265
* Non-maintainer upload.
* 043_ajp_connection_reuse: Patch from upstream Bugzilla, fixing a critical
  issue with regard to connection reuse in mod_proxy_ajp.
  Closes: #396265

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/htpasswd.1
 
1
.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
2
.\" DO NOT EDIT! Generated from XML source.
 
3
.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
4
.de Sh \" Subsection
 
5
.br
 
6
.if t .Sp
 
7
.ne 5
 
8
.PP
 
9
\fB\\$1\fR
 
10
.PP
 
11
..
 
12
.de Sp \" Vertical space (when we can't use .PP)
 
13
.if t .sp .5v
 
14
.if n .sp
 
15
..
 
16
.de Ip \" List item
 
17
.br
 
18
.ie \\n(.$>=3 .ne \\$3
 
19
.el .ne 3
 
20
.IP "\\$1" \\$2
 
21
..
 
22
.TH "HTPASSWD" 1 "2003-11-25" "Apache HTTP Server" "htpasswd"
 
23
 
 
24
.SH NAME
 
25
htpasswd \- Manage user files for basic authentication
 
26
 
 
27
.SH "SYNOPSIS"
 
28
 
 
29
.PP
 
30
\fBhtpasswd\fR [ -\fBc\fR ] [ -\fBm\fR ] [ -\fBD\fR ] \fIpasswdfile\fR \fIusername\fR
 
31
 
 
32
.PP
 
33
\fBhtpasswd\fR -\fBb\fR [ -\fBc\fR ] [ -\fBm\fR | -\fBd\fR | -\fBp\fR | -\fBs\fR ] [ -\fBD\fR ] \fIpasswdfile\fR \fIusername\fR \fIpassword\fR
 
34
 
 
35
.PP
 
36
\fBhtpasswd\fR -\fBn\fR [ -\fBm\fR | -\fBd\fR | -\fBs\fR | -\fBp\fR ] \fIusername\fR
 
37
 
 
38
.PP
 
39
\fBhtpasswd\fR -\fBnb\fR [ -\fBm\fR | -\fBd\fR | -\fBs\fR | -\fBp\fR ] \fIusername\fR \fIpassword\fR
 
40
 
 
41
 
 
42
.SH "SUMMARY"
 
43
 
 
44
.PP
 
45
htpasswd is used to create and update the flat-files used to store usernames and password for basic authentication of HTTP users\&. If htpasswd cannot access a file, such as not 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\&.
 
46
 
 
47
.PP
 
48
Resources available from the Apache HTTP server can be restricted to just the users listed in the files created by htpasswd\&. This program can only manage usernames and passwords stored in a flat-file\&. It can encrypt and display password information for use in other types of data stores, though\&. To use a DBM database see dbmmanage\&.
 
49
 
 
50
.PP
 
51
htpasswd encrypts passwords using either a version of MD5 modified for Apache, or the system's crypt() routine\&. Files managed by htpasswd 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()\&.
 
52
 
 
53
.PP
 
54
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 http://httpd\&.apache\&.org/\&.
 
55
 
 
56
 
 
57
.SH "OPTIONS"
 
58
 
 
59
 
 
60
.TP
 
61
-b
 
62
Use batch mode; \fIi\&.e\&.\fR, get the password from the command line rather than prompting for it\&. This option should be used with extreme care, since \fBthe password is clearly visible\fR on the command line\&.  
 
63
.TP
 
64
-c
 
65
Create the \fIpasswdfile\fR\&. If \fIpasswdfile\fR already exists, it is rewritten and truncated\&. This option cannot be combined with the -n option\&.  
 
66
.TP
 
67
-n
 
68
Display the results on standard output rather than updating a file\&. This is useful for generating password records acceptable to Apache for inclusion in non-text data stores\&. This option changes the syntax of the command line, since the \fIpasswdfile\fR argument (usually the first one) is omitted\&. It cannot be combined with the -c option\&.  
 
69
.TP
 
70
-m
 
71
Use MD5 encryption for passwords\&. On Windows, Netware and TPF, this is the default\&.  
 
72
.TP
 
73
-d
 
74
Use crypt() encryption for passwords\&. The default on all platforms but Windows, Netware and TPF\&. Though possibly supported by htpasswd on all platforms, it is not supported by the httpd server on Windows, Netware and TPF\&.  
 
75
.TP
 
76
-s
 
77
Use SHA encryption for passwords\&. Facilitates migration from/to Netscape servers using the LDAP Directory Interchange Format (ldif)\&.  
 
78
.TP
 
79
-p
 
80
Use plaintext passwords\&. Though htpasswd will support creation on all platforms, the httpd daemon will only accept plain text passwords on Windows, Netware and TPF\&.  
 
81
.TP
 
82
-D
 
83
Delete user\&. If the username exists in the specified htpasswd file, it will be deleted\&.  
 
84
.TP
 
85
\fIpasswdfile\fR
 
86
Name of the file to contain the user name and password\&. If -c is given, this file is created if it does not already exist, or rewritten and truncated if it does exist\&.  
 
87
.TP
 
88
\fIusername\fR
 
89
The username to create or update in \fIpasswdfile\fR\&. If \fIusername\fR does not exist in this file, an entry is added\&. If it does exist, the password is changed\&.  
 
90
.TP
 
91
\fIpassword\fR
 
92
The plaintext password to be encrypted and stored in the file\&. Only used with the -b flag\&.  
 
93
 
 
94
.SH "EXIT STATUS"
 
95
 
 
96
.PP
 
97
htpasswd returns a zero status ("true") if the username and password have been successfully added or updated in the \fIpasswdfile\fR\&. htpasswd 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), 6 if the username contains illegal characters (see the Restrictions section), and 7 if the file is not a valid password file\&.
 
98
 
 
99
.SH "EXAMPLES"
 
100
 
 
101
.nf
 
102
 
 
103
      htpasswd /usr/local/etc/apache/\&.htpasswd-users jsmith
 
104
    
 
105
.fi
 
106
 
 
107
.PP
 
108
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 modified Apache MD5 algorithm; otherwise, the system's crypt() routine will be used\&. If the file does not exist, htpasswd will do nothing except return an error\&.
 
109
 
 
110
.nf
 
111
 
 
112
      htpasswd -c /home/doe/public_html/\&.htpasswd jane
 
113
    
 
114
.fi
 
115
 
 
116
.PP
 
117
Creates a new file and stores a record in it for user jane\&. The user is prompted for the password\&. If the file exists and cannot be read, or cannot be written, it is not altered and htpasswd will display a message and return an error status\&.
 
118
 
 
119
.nf
 
120
 
 
121
      htpasswd -mb /usr/web/\&.htpasswd-all jones Pwd4Steve
 
122
    
 
123
.fi
 
124
 
 
125
.PP
 
126
Encrypts the password from the command line (Pwd4Steve) using the MD5 algorithm, and stores it in the specified file\&.
 
127
 
 
128
.SH "SECURITY CONSIDERATIONS"
 
129
 
 
130
.PP
 
131
Web password files such as those managed by htpasswd should \fInot\fR be within the Web server's URI space -- that is, they should not be fetchable with a browser\&.
 
132
 
 
133
.PP
 
134
The use of the -b option is discouraged, since when it is used the unencrypted password appears on the command line\&.
 
135
 
 
136
.SH "RESTRICTIONS"
 
137
 
 
138
.PP
 
139
On the Windows and MPE platforms, passwords encrypted with htpasswd are limited to no more than 255 characters in length\&. Longer passwords will be truncated to 255 characters\&.
 
140
 
 
141
.PP
 
142
The MD5 algorithm used by htpasswd is specific to the Apache software; passwords encrypted using it will not be usable with other Web servers\&.
 
143
 
 
144
.PP
 
145
Usernames are limited to 255 bytes and may not include the character :\&.
 
146