440dc0363ace940fa75212b5420c5ded2b9d963b
[openssl.git] / doc / man1 / passwd.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-passwd,
6 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 [B<-rand file...>]
25 [B<-writerand file>]
26 {I<password>}
27
28 =head1 DESCRIPTION
29
30 The B<passwd> command computes the hash of a password typed at
31 run-time or the hash of each password in a list.  The password list is
32 taken from the named file for option B<-in file>, from stdin for
33 option B<-stdin>, or from the command line, or from the terminal otherwise.
34 The Unix standard algorithm B<crypt> and the MD5-based BSD password
35 algorithm B<1>, its Apache variant B<apr1>, and its AIX variant are available.
36
37 =head1 OPTIONS
38
39 =over 4
40
41 =item B<-help>
42
43 Print out a usage message.
44
45 =item B<-crypt>
46
47 Use the B<crypt> algorithm (default).
48
49 =item B<-1>
50
51 Use the MD5 based BSD password algorithm B<1>.
52
53 =item B<-apr1>
54
55 Use the B<apr1> algorithm (Apache variant of the BSD algorithm).
56
57 =item B<-aixmd5>
58
59 Use the B<AIX MD5> algorithm (AIX variant of the BSD algorithm).
60
61 =item B<-5>
62
63 =item B<-6>
64
65 Use the B<SHA256> / B<SHA512> based algorithms defined by Ulrich Drepper.
66 See L<https://www.akkadia.org/drepper/SHA-crypt.txt>.
67
68 =item B<-salt> I<string>
69
70 Use the specified salt.
71 When reading a password from the terminal, this implies B<-noverify>.
72
73 =item B<-in> I<file>
74
75 Read passwords from I<file>.
76
77 =item B<-stdin>
78
79 Read passwords from B<stdin>.
80
81 =item B<-noverify>
82
83 Don't verify when reading a password from the terminal.
84
85 =item B<-quiet>
86
87 Don't output warnings when passwords given at the command line are truncated.
88
89 =item B<-table>
90
91 In the output list, prepend the cleartext password and a TAB character
92 to each password hash.
93
94 =item B<-rand file...>
95
96 A file or files containing random data used to seed the random number
97 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 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-2018 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