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