htpasswd - 管理用于basic认证的用户文件

概要

htpasswd [ -c ] [ -m ] passwdfile username

htpasswd -b [ -c ] [ -m | -d | -p | -s ] passwdfile username password

htpasswd -n [ -m | -d | -s | -p ] username

htpasswd -nb [ -m | -d | -s | -p ] username password

选项

-b

使用批处理方式; 即, 从命令行中获得密码，而不显示提示要求输入。 此选项的使用应该极为谨慎，因为命令行中的密码是清晰可见的。

-c

建立passwdfile文件。如果passwdfile已经存在，则它被重写并截断。 此选项不能与-n选项同时使用。

-n

在标准输出设备上显示结果，而不更新文件。 用于生成可以为Apache非文本输出存储格式所接受的密码记录。 此选项在命令行中的语法有所改变，因为passwdfile参数(通常是第一个)被省略了。 此选项不能与-c选项同时使用。

-m

使用MD5加密密码。在Windows, Netware 和TPF上，这是默认的。

-d

使用crypt()加密密码。在除了Windows, Netware和TPF的平台上，这是默认的。 虽然它在所有平台上可以为htpasswd所支持， 但是在Windows, Netware和TPF上不能为httpd服务器所支持。

-s

使用SHA加密密码。 它是为了方便转入或移植到使用LDAP Directory Interchange Format (ldif)的Netscape而设计的。

-p

使用纯文本的密码。虽然在所有平台上htpasswd都可以建立这样的密码， 但是httpd后台只在Windows, Netware和TPF上支持纯文本的密码。

passwdfile

包含用户名和密码的文件的名称。 如果使用了-c，而此文件不存在则建立，如果已经存在，则重写并截断此文件。

username

需要在passwdfile中建立或更新的用户名。 如果此文件中username不存在，则增加一项，如果已经存在，则改变其密码。

password

将被加密并存储到文件中的纯文本的密码。仅用于和-b选项同时使用。

返回值

如果htpasswd成功地在passwdfile中增加或修改了用户名和密码， 则其返回值是0("真")； 如果存取文件发生某种错误，则返回1； 如果命令行语法有问题，则返回2； 如果进入交互状态而两次输入的密码不相同，则返回3； 如果操作被中断，则返回4； 如果一个值太长(用户名、文件名、密码或者最后得到的记录长度)，则返回5； 如果用户名包含非法字符(见Restrictions section)，则返回6。

举例

此例增加或修改了用户jsmith的密码。程序会给出提示要求输入密码。 如果在Windows系统中运行，此密码将以专为Apache修改过的MD5算法加密； 在其他平台上，则使用系统函数crypt()。 如果文件不存在，则htpasswd不作任何操作并返回一个出错代码。

此例建立一个新的文件，并在其中为用户jane存储一个记录。 程序会给出提示要求输入密码。如果文件存在但是不能读或写， 则htpasswd会显示一个消息并返回一个出错代码。

使用MD5算法加密从命令行得到的密码(Pwd4Steve)，并存储在指定的文件中。

安全方面的提示

由诸如htpasswd管理的网站密码文件都不应该位于网站服务器的URI空间中， -- 也就是说，不应该被浏览器读取。

不鼓励使用-b选项，因为未经加密的密码会出现在命令行中。

限制

在Windows和MPE平台上， 由htpasswd加密的密码的长度上限是255个字符。 太长的密码会被截断为255个字符。

htpasswd使用的MD5算法是专供Apache软件使用的； 其加密的密码不能为其他网站服务器所使用。

用户名的长度上限是255个字节，并不能包含字符:。