Annotation of src/usr.bin/htpasswd/htpasswd.1, Revision 1.5
1.5 ! florian 1: .\" $OpenBSD: htpasswd.1,v 1.4 2014/03/18 17:47:04 florian Exp $
1.1 florian 2: .\"
3: .\" Copyright (c) 2014 Florian Obser <florian@openbsd.org>
4: .\"
5: .\" Permission to use, copy, modify, and distribute this software for any
6: .\" purpose with or without fee is hereby granted, provided that the above
7: .\" copyright notice and this permission notice appear in all copies.
8: .\"
9: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: .\"
1.5 ! florian 17: .Dd $Mdocdate: March 18 2014 $
1.1 florian 18: .Dt HTPASSWD 1
19: .Os
20: .Sh NAME
21: .Nm htpasswd
22: .Nd create and update user authentication files
23: .Sh SYNOPSIS
24: .Nm
25: .Op Ar file
26: .Ar login
1.4 florian 27: .Nm
1.5 ! florian 28: .Fl I
1.4 florian 29: .Op Ar file
1.1 florian 30: .Sh DESCRIPTION
31: .Nm
32: is used to create and update user authentication files for
1.3 jmc 33: HTTP daemons such as
34: .Xr nginx 8 .
35: .Pp
1.4 florian 36: The options are as follows:
37: .Bl -tag -width Ds
1.5 ! florian 38: .It Fl I
1.4 florian 39: Switch to batch mode.
40: .Nm
41: reads exactly one line from standard input and splits it at the first
42: .Qo : Qc .
43: The first part is the login, the second part is the password which
44: .Nm
45: then hashes using
46: .Xr bcrypt 3 .
47: .El
48: .Pp
1.1 florian 49: .Nm
50: prompts for a password and generates a hash using
51: .Xr bcrypt 3 .
1.3 jmc 52: A line suitable for a password file,
53: such as
1.1 florian 54: .Ic auth_basic_user_file
1.3 jmc 55: in
56: .Xr nginx 8 ,
57: is written to standard output.
58: If invoked with two arguments
1.4 florian 59: .Po
60: or one argument if the
1.5 ! florian 61: .Fl I
1.4 florian 62: flag is used
63: .Pc
1.3 jmc 64: user authentication
1.1 florian 65: .Ar file
1.3 jmc 66: is updated.
1.1 florian 67: .Sh SEE ALSO
68: .Xr bcrypt 3 ,
1.2 jmc 69: .Xr nginx.conf 5 ,
70: .Xr nginx 8
1.1 florian 71: .Sh HISTORY
72: This reimplemented version of
73: .Nm
74: has been available since
75: .Ox 5.6 .
76: .Sh AUTHORS
77: .An Florian Obser Aq Mt florian@openbsd.org
78: implemented
79: .Nm
80: from scratch after httpd was removed from
81: .Ox
82: base.