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