Implement MD5-based "apr1" password hash.
[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<-apr1>]
12 [B<-salt string>]
13 [B<-in file>]
14 [B<-stdin>]
15 [B<-quiet>]
16 [B<-table>]
17 {B<password>}
18
19 =head1 DESCRIPTION
20
21 The B<passwd> command computes the hash of a password typed at
22 run-time or the hash of each password in a list.  The password list is
23 taken from the named file for option B<-in file>, from stdin for
24 option B<-stdin>, and from the command line otherwise.
25 The Unix standard algorithm B<crypt> and the MD5-based B<apr1> algorithm
26 are available.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-crypt>
33
34 Use the B<crypt> algorithm (default).
35
36 =item B<-apr1>
37
38 Use the B<apr1> algorithm.
39
40 =item B<-salt string>
41
42 Use the specified salt.
43
44 =item B<-in file>
45
46 Read passwords from B<file>.
47
48 =item B<-stdin>
49
50 Read passwords from B<stdin>.
51
52 =item B<-quiet>
53
54 Don't output warnings when passwords given at the command line are truncated.
55
56 =item B<-table>
57
58 In the output list, prepend the cleartext password and a TAB character
59 to each password hash.
60
61 =back
62
63 =head1 EXAMPLE
64
65 B<openssl passwd -crypt -salt xx password> prints B<xxj31ZMTZzkVA>.
66
67 B<openssl passwd -apr1 -salt xx password> prints B<$apr1$xx$2eRrCdRwKOfJOth0w31wR.>.
68
69 =cut