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