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