Merge from 1.0.0-stable branch.
[openssl.git] / doc / apps / passwd.pod
1 =pod
2
3 =head1 NAME
4
5 passwd - compute password hashes
6
7 =head1 SYNOPSIS
8
9 B<openssl passwd>
10 [B<-crypt>]
11 [B<-1>]
12 [B<-apr1>]
13 [B<-salt> I<string>]
14 [B<-in> I<file>]
15 [B<-stdin>]
16 [B<-noverify>]
17 [B<-quiet>]
18 [B<-table>]
19 {I<password>}
20
21 =head1 DESCRIPTION
22
23 The B<passwd> command computes the hash of a password typed at
24 run-time or the hash of each password in a list.  The password list is
25 taken from the named file for option B<-in file>, from stdin for
26 option B<-stdin>, or from the command line, or from the terminal otherwise.
27 The Unix standard algorithm B<crypt> and the MD5-based BSD password
28 algorithm B<1> and its Apache variant B<apr1> are available.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-crypt>
35
36 Use the B<crypt> algorithm (default).
37
38 =item B<-1>
39
40 Use the MD5 based BSD password algorithm B<1>.
41
42 =item B<-apr1>
43
44 Use the B<apr1> algorithm (Apache variant of the BSD algorithm).
45
46 =item B<-salt> I<string>
47
48 Use the specified salt.
49 When reading a password from the terminal, this implies B<-noverify>.
50
51 =item B<-in> I<file>
52
53 Read passwords from I<file>.
54
55 =item B<-stdin>
56
57 Read passwords from B<stdin>.
58
59 =item B<-noverify>
60
61 Don't verify when reading a password from the terminal.
62
63 =item B<-quiet>
64
65 Don't output warnings when passwords given at the command line are truncated.
66
67 =item B<-table>
68
69 In the output list, prepend the cleartext password and a TAB character
70 to each password hash.
71
72 =back
73
74 =head1 EXAMPLES
75
76 B<openssl passwd -crypt -salt xx password> prints B<xxj31ZMTZzkVA>.
77
78 B<openssl passwd -1 -salt xxxxxxxx password> prints B<$1$xxxxxxxx$UYCIxa628.9qXjpQCjM4a.>.
79
80 B<openssl passwd -apr1 -salt xxxxxxxx password> prints B<$apr1$xxxxxxxx$dxHfLAsjHkDRmG83UXe8K0>.
81
82 =cut