Document the new SHA256 and SHA512 password generation options
[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<-help>]
11 [B<-crypt>]
12 [B<-1>]
13 [B<-apr1>]
14 [B<-5>]
15 [B<-6>]
16 [B<-salt> I<string>]
17 [B<-in> I<file>]
18 [B<-stdin>]
19 [B<-noverify>]
20 [B<-quiet>]
21 [B<-table>]
22 {I<password>}
23
24 =head1 DESCRIPTION
25
26 The B<passwd> command computes the hash of a password typed at
27 run-time or the hash of each password in a list.  The password list is
28 taken from the named file for option B<-in file>, from stdin for
29 option B<-stdin>, or from the command line, or from the terminal otherwise.
30 The Unix standard algorithm B<crypt> and the MD5-based BSD password
31 algorithm B<1> and its Apache variant B<apr1> are available.
32
33 =head1 OPTIONS
34
35 =over 4
36
37 =item B<-help>
38
39 Print out a usage message.
40
41 =item B<-crypt>
42
43 Use the B<crypt> algorithm (default).
44
45 =item B<-1>
46
47 Use the MD5 based BSD password algorithm B<1>.
48
49 =item B<-apr1>
50
51 Use the B<apr1> algorithm (Apache variant of the BSD algorithm).
52
53 =item B<-5>
54
55 =item B<-6>
56
57 Use the B<SHA256> / B<SHA512> based algorithms defined by Ulrich Drepper.
58 See L<https://www.akkadia.org/drepper/SHA-crypt.txt>.
59
60 =item B<-salt> I<string>
61
62 Use the specified salt.
63 When reading a password from the terminal, this implies B<-noverify>.
64
65 =item B<-in> I<file>
66
67 Read passwords from I<file>.
68
69 =item B<-stdin>
70
71 Read passwords from B<stdin>.
72
73 =item B<-noverify>
74
75 Don't verify when reading a password from the terminal.
76
77 =item B<-quiet>
78
79 Don't output warnings when passwords given at the command line are truncated.
80
81 =item B<-table>
82
83 In the output list, prepend the cleartext password and a TAB character
84 to each password hash.
85
86 =back
87
88 =head1 EXAMPLES
89
90 B<openssl passwd -crypt -salt xx password> prints B<xxj31ZMTZzkVA>.
91
92 B<openssl passwd -1 -salt xxxxxxxx password> prints B<$1$xxxxxxxx$UYCIxa628.9qXjpQCjM4a.>.
93
94 B<openssl passwd -apr1 -salt xxxxxxxx password> prints B<$apr1$xxxxxxxx$dxHfLAsjHkDRmG83UXe8K0>.
95
96 =head1 COPYRIGHT
97
98 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
99
100 Licensed under the OpenSSL license (the "License").  You may not use
101 this file except in compliance with the License.  You can obtain a copy
102 in the file LICENSE in the source distribution or at
103 L<https://www.openssl.org/source/license.html>.
104
105 =cut