Home
Main website
Display Sidebar
Hide Ads
Recent Changes
View Source:
htpasswd(1)
Edit
PageHistory
Diff
Info
LikePages
htpasswd !!!htpasswd NAME SYNOPSIS DESCRIPTION OPTIONS EXIT STATUS EXAMPLES SECURITY CONSIDERATIONS RESTRICTIONS SEE ALSO ---- !!NAME htpasswd - Create and update user authentication files !!SYNOPSIS __htpasswd__ [[ __-c__ ] [[ __-m__ | __-d__ | __-s__ | __-p__ ] ''passwdfile username''__ htpasswd -b__ [[ __-c__ ] [[ __-m__ | __-d__ | __-s__ | __-p__ ] ''passwdfile username password''__ htpasswd -n__ [[ __-m__ | __-d__ | __-s__ | __-p__ ] ''username''__ htpasswd -nb__ [[ __-m__ | __-d__ | __-s__ | __-p__ ] ''username password'' !!DESCRIPTION __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. Resources available from the __apache__ Apache web 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__. __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()''. This manual page only lists the command line arguments. For details of the directives necessary to configure user authentication in __apache__ see the Apache manual, which is part of the Apache distribution or can be found at __ !!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 ''passwdfile''. If ''passwdfile'' 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 password records acceptable to Apache for inclusion in non-text data stores. This option changes the syntax of the command line, since the ''passwdfile'' argument (usually the first one) is omitted. It cannot be combined with the __-c__ option. -m Use Apache's modified MD5 algorithm for passwords. Passwords encrypted with this algorithm are transportable to any platform (Windows, Unix, BeOS, et cetera) running Apache 1.3.9 or later. On Windows and TPF, this flag is the default. -d Use crypt() encryption for passwords. The default on all platforms but Windows and TPF. Though possibly supported by __htpasswd__ on all platforms, it is not supported by the __apache__ server on Windows and TPF. -s Use SHA encryption for passwords. Faciliates migration from/to Netscape servers using the LDAP Directory Interchange Format (ldif). -p Use plaintext passwords. Though __htpasswd__ will support creation on all platforms, the __apache__ deamon will only accept plain text passwords on Windows and TPF. ''passwdfile'' 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. ''username'' The username to create or update in __passwdfile__. If ''username'' does not exist in this file, an entry is added. If it does exist, the password is changed. ''password'' The plaintext password to be encrypted and stored in the file. Only used with the ''-b'' flag. !!EXIT STATUS __htpasswd__ returns a zero status ( __passwdfile''. __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), and 6 if the username contains illegal characters (see the __RESTRICTIONS__ section). !!EXAMPLES __htpasswd /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 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. __htpasswd -c /home/doe/public_html/.htpasswd jane__ 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. __htpasswd -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 files such as those managed by __htpasswd__ 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 __htpasswd__ are limited to no more than 255 characters in length. Longer passwords will be truncated to 255 characters. The MD5 algorithm used by __htpasswd__ 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 __apache(8)__ and the scripts in support/SHA1 which come with the distribution. ----
One page links to
htpasswd(1)
:
Man1h
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
