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