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