c51bbaa63e77e7b08a6ba88d6722a63ab6086c98
[openssl.git] / doc / man1 / dhparam.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-dhparam,
6 dhparam - DH parameter manipulation and generation
7
8 =head1 SYNOPSIS
9
10 B<openssl dhparam>
11 [B<-help>]
12 [B<-inform DER|PEM>]
13 [B<-outform DER|PEM>]
14 [B<-in> I<filename>]
15 [B<-out> I<filename>]
16 [B<-dsaparam>]
17 [B<-check>]
18 [B<-noout>]
19 [B<-text>]
20 [B<-C>]
21 [B<-2>]
22 [B<-3>]
23 [B<-5>]
24 [B<-rand file...>]
25 [B<-writerand file>]
26 [B<-engine id>]
27 [I<numbits>]
28
29 =head1 DESCRIPTION
30
31 This command is used to manipulate DH parameter files.
32
33 =head1 OPTIONS
34
35 =over 4
36
37 =item B<-help>
38
39 Print out a usage message.
40
41 =item B<-inform DER|PEM>
42
43 This specifies the input format. The B<DER> option uses an ASN1 DER encoded
44 form compatible with the PKCS#3 DHparameter structure. The PEM form is the
45 default format: it consists of the B<DER> format base64 encoded with
46 additional header and footer lines.
47
48 =item B<-outform DER|PEM>
49
50 This specifies the output format, the options have the same meaning and default
51 as the B<-inform> option.
52
53 =item B<-in> I<filename>
54
55 This specifies the input filename to read parameters from or standard input if
56 this option is not specified.
57
58 =item B<-out> I<filename>
59
60 This specifies the output filename parameters to. Standard output is used
61 if this option is not present. The output filename should B<not> be the same
62 as the input filename.
63
64 =item B<-dsaparam>
65
66 If this option is used, DSA rather than DH parameters are read or created;
67 they are converted to DH format.  Otherwise, "strong" primes (such
68 that (p-1)/2 is also prime) will be used for DH parameter generation.
69
70 DH parameter generation with the B<-dsaparam> option is much faster,
71 and the recommended exponent length is shorter, which makes DH key
72 exchange more efficient.  Beware that with such DSA-style DH
73 parameters, a fresh DH key should be created for each use to
74 avoid small-subgroup attacks that may be possible otherwise.
75
76 =item B<-check>
77
78 Performs numerous checks to see if the supplied parameters are valid and
79 displays a warning if not.
80
81 =item B<-2>, B<-3>, B<-5>
82
83 The generator to use, either 2, 3 or 5. If present then the
84 input file is ignored and parameters are generated instead. If not
85 present but B<numbits> is present, parameters are generated with the
86 default generator 2.
87
88 =item B<-rand file...>
89
90 A file or files containing random data used to seed the random number
91 generator.
92 Multiple files can be specified separated by an OS-dependent character.
93 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
94 all others.
95
96 =item [B<-writerand file>]
97
98 Writes random data to the specified I<file> upon exit.
99 This can be used with a subsequent B<-rand> flag.
100
101 =item I<numbits>
102
103 This option specifies that a parameter set should be generated of size
104 I<numbits>. It must be the last option. If this option is present then
105 the input file is ignored and parameters are generated instead. If
106 this option is not present but a generator (B<-2>, B<-3> or B<-5>) is
107 present, parameters are generated with a default length of 2048 bits.
108 The minimim length is 512 bits. The maximum length is 10000 bits.
109
110 =item B<-noout>
111
112 This option inhibits the output of the encoded version of the parameters.
113
114 =item B<-text>
115
116 This option prints out the DH parameters in human readable form.
117
118 =item B<-C>
119
120 This option converts the parameters into C code. The parameters can then
121 be loaded by calling the get_dhNNNN() function.
122
123 =item B<-engine id>
124
125 Specifying an engine (by its unique B<id> string) will cause B<dhparam>
126 to attempt to obtain a functional reference to the specified engine,
127 thus initialising it if needed. The engine will then be set as the default
128 for all available algorithms.
129
130 =back
131
132 =head1 WARNINGS
133
134 The program B<dhparam> combines the functionality of the programs B<dh> and
135 B<gendh> in previous versions of OpenSSL. The B<dh> and B<gendh>
136 programs are retained for now but may have different purposes in future
137 versions of OpenSSL.
138
139 =head1 NOTES
140
141 PEM format DH parameters use the header and footer lines:
142
143  -----BEGIN DH PARAMETERS-----
144  -----END DH PARAMETERS-----
145
146 OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42
147 DH.
148
149 This program manipulates DH parameters not keys.
150
151 =head1 BUGS
152
153 There should be a way to generate and manipulate DH keys.
154
155 =head1 SEE ALSO
156
157 L<dsaparam(1)>
158
159 =head1 COPYRIGHT
160
161 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
162
163 Licensed under the Apache License 2.0 (the "License").  You may not use
164 this file except in compliance with the License.  You can obtain a copy
165 in the file LICENSE in the source distribution or at
166 L<https://www.openssl.org/source/license.html>.
167
168 =cut