69c642cdf7a3c414c9ffa93a88d5d2735a2a0963
[openssl.git] / doc / man1 / openssl-genpkey.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-genpkey - generate a private key
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<genpkey>
10 [B<-help>]
11 [B<-out> I<filename>]
12 [B<-outform> B<DER>|B<PEM>]
13 [B<-pass> I<arg>]
14 [B<-I<cipher>>]
15 [B<-engine> I<id>]
16 [B<-paramfile> I<file>]
17 [B<-algorithm> I<alg>]
18 [B<-pkeyopt> I<opt>:I<value>]
19 [B<-genparam>]
20 [B<-text>]
21
22 =for openssl ifdef engine
23
24 =head1 DESCRIPTION
25
26 This command generates a private key.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item B<-help>
33
34 Print out a usage message.
35
36 =item B<-out> I<filename>
37
38 Output the key to the specified file. If this argument is not specified then
39 standard output is used.
40
41 =item B<-outform> B<DER>|B<PEM>
42
43 The output format; the default is B<PEM>.
44 See L<openssl(1)/Format Options> for details.
45
46 =item B<-pass> I<arg>
47
48 The output file password source. For more information about the format of I<arg>
49 see L<openssl(1)/Pass Phrase Options>.
50
51 =item B<-I<cipher>>
52
53 This option encrypts the private key with the supplied cipher. Any algorithm
54 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
55
56 =item B<-engine> I<id>
57
58 Specifying an engine (by its unique I<id> string) will cause this command
59 to attempt to obtain a functional reference to the specified engine,
60 thus initialising it if needed. The engine will then be set as the default
61 for all available algorithms. If used this option should precede all other
62 options.
63
64 =item B<-algorithm> I<alg>
65
66 Public key algorithm to use such as RSA, DSA or DH. If used this option must
67 precede any B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm>
68 are mutually exclusive. Engines may add algorithms in addition to the standard
69 built-in ones.
70
71 Valid built-in algorithm names for private key generation are RSA, RSA-PSS, EC,
72 X25519, X448, ED25519 and ED448.
73
74 Valid built-in algorithm names for parameter generation (see the B<-genparam>
75 option) are DH, DSA and EC.
76
77 Note that the algorithm name X9.42 DH may be used as a synonym for the DH
78 algorithm. These are identical and do not indicate the type of parameters that
79 will be generated. Use the B<dh_paramgen_type> option to indicate whether PKCS#3
80 or X9.42 DH parameters are required. See L</DH Parameter Generation Options>
81 below for more details.
82
83 =item B<-pkeyopt> I<opt>:I<value>
84
85 Set the public key algorithm option I<opt> to I<value>. The precise set of
86 options supported depends on the public key algorithm used and its
87 implementation. See L</KEY GENERATION OPTIONS> and
88 L</PARAMETER GENERATION OPTIONS> below for more details.
89
90 =item B<-genparam>
91
92 Generate a set of parameters instead of a private key. If used this option must
93 precede any B<-algorithm>, B<-paramfile> or B<-pkeyopt> options.
94
95 =item B<-paramfile> I<filename>
96
97 Some public key algorithms generate a private key based on a set of parameters.
98 They can be supplied using this option. If this option is used the public key
99 algorithm used is determined by the parameters. If used this option must
100 precede any B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm>
101 are mutually exclusive.
102
103 =item B<-text>
104
105 Print an (unencrypted) text representation of private and public keys and
106 parameters along with the PEM or DER structure.
107
108 =back
109
110 =head1 KEY GENERATION OPTIONS
111
112 The options supported by each algorithm and indeed each implementation of an
113 algorithm can vary. The options for the OpenSSL implementations are detailed
114 below. There are no key generation options defined for the X25519, X448, ED25519
115 or ED448 algorithms.
116
117 =head2 RSA Key Generation Options
118
119 =over 4
120
121 =item B<rsa_keygen_bits:numbits>
122
123 The number of bits in the generated key. If not specified 2048 is used.
124
125 =item B<rsa_keygen_primes:numprimes>
126
127 The number of primes in the generated key. If not specified 2 is used.
128
129 =item B<rsa_keygen_pubexp:value>
130
131 The RSA public exponent value. This can be a large decimal or
132 hexadecimal value if preceded by C<0x>. Default value is 65537.
133
134 =back
135
136 =head2 RSA-PSS Key Generation Options
137
138 Note: by default an B<RSA-PSS> key has no parameter restrictions.
139
140 =over 4
141
142 =item B<rsa_keygen_bits>:I<numbits>, B<rsa_keygen_primes>:I<numprimes>,
143 B<rsa_keygen_pubexp>:I<value>
144
145 These options have the same meaning as the B<RSA> algorithm.
146
147 =item B<rsa_pss_keygen_md>:I<digest>
148
149 If set the key is restricted and can only use I<digest> for signing.
150
151 =item B<rsa_pss_keygen_mgf1_md>:I<digest>
152
153 If set the key is restricted and can only use I<digest> as it's MGF1
154 parameter.
155
156 =item B<rsa_pss_keygen_saltlen>:I<len>
157
158 If set the key is restricted and I<len> specifies the minimum salt length.
159
160 =back
161
162 =head2 EC Key Generation Options
163
164 The EC key generation options can also be used for parameter generation.
165
166 =over 4
167
168 =item B<ec_paramgen_curve>:I<curve>
169
170 The EC curve to use. OpenSSL supports NIST curve names such as "P-256".
171
172 =item B<ec_param_enc>:I<encoding>
173
174 The encoding to use for parameters. The I<encoding> parameter must be either
175 B<named_curve> or B<explicit>. The default value is B<named_curve>.
176
177 =back
178
179 =head1 PARAMETER GENERATION OPTIONS
180
181 The options supported by each algorithm and indeed each implementation of an
182 algorithm can vary. The options for the OpenSSL implementations are detailed
183 below.
184
185 =head2 DSA Parameter Generation Options
186
187 =over 4
188
189 =item B<dsa_paramgen_bits>:I<numbits>
190
191 The number of bits in the generated prime. If not specified 2048 is used.
192
193 =item B<dsa_paramgen_q_bits>:I<numbits>
194
195 The number of bits in the q parameter. Must be one of 160, 224 or 256. If not
196 specified 224 is used.
197
198 =item B<dsa_paramgen_md>:I<digest>
199
200 The digest to use during parameter generation. Must be one of B<sha1>, B<sha224>
201 or B<sha256>. If set, then the number of bits in B<q> will match the output size
202 of the specified digest and the B<dsa_paramgen_q_bits> parameter will be
203 ignored. If not set, then a digest will be used that gives an output matching
204 the number of bits in B<q>, i.e. B<sha1> if q length is 160, B<sha224> if it 224
205 or B<sha256> if it is 256.
206
207 =back
208
209 =head2 DH Parameter Generation Options
210
211 =over 4
212
213 =item B<dh_paramgen_prime_len>:I<numbits>
214
215 The number of bits in the prime parameter I<p>. The default is 2048.
216
217 =item B<dh_paramgen_subprime_len>:I<numbits>
218
219 The number of bits in the sub prime parameter I<q>. The default is 256 if the
220 prime is at least 2048 bits long or 160 otherwise. Only relevant if used in
221 conjunction with the B<dh_paramgen_type> option to generate X9.42 DH parameters.
222
223 =item B<dh_paramgen_generator>:I<value>
224
225 The value to use for the generator I<g>. The default is 2.
226
227 =item B<dh_paramgen_type>:I<value>
228
229 The type of DH parameters to generate. Use 0 for PKCS#3 DH and 1 for X9.42 DH.
230 The default is 0.
231
232 =item B<dh_rfc5114>:I<num>
233
234 If this option is set, then the appropriate RFC5114 parameters are used
235 instead of generating new parameters. The value I<num> can be one of
236 1, 2 or 3 corresponding to RFC5114 DH parameters consisting of
237 1024 bit group with 160 bit subgroup, 2048 bit group with 224 bit subgroup
238 and 2048 bit group with 256 bit subgroup as mentioned in RFC5114 sections
239 2.1, 2.2 and 2.3 respectively. If present this overrides all other DH parameter
240 options.
241
242 =back
243
244 =head2 EC Parameter Generation Options
245
246 The EC parameter generation options are the same as for key generation. See
247 L</EC Key Generation Options> above.
248
249 =head1 NOTES
250
251 The use of the genpkey program is encouraged over the algorithm specific
252 utilities because additional algorithm options and ENGINE provided algorithms
253 can be used.
254
255 =head1 EXAMPLES
256
257 Generate an RSA private key using default parameters:
258
259  openssl genpkey -algorithm RSA -out key.pem
260
261 Encrypt output private key using 128 bit AES and the passphrase "hello":
262
263  openssl genpkey -algorithm RSA -out key.pem -aes-128-cbc -pass pass:hello
264
265 Generate a 2048 bit RSA key using 3 as the public exponent:
266
267  openssl genpkey -algorithm RSA -out key.pem \
268      -pkeyopt rsa_keygen_bits:2048 -pkeyopt rsa_keygen_pubexp:3
269
270 Generate 2048 bit DSA parameters:
271
272  openssl genpkey -genparam -algorithm DSA -out dsap.pem \
273      -pkeyopt dsa_paramgen_bits:2048
274
275 Generate DSA key from parameters:
276
277  openssl genpkey -paramfile dsap.pem -out dsakey.pem
278
279 Generate 2048 bit DH parameters:
280
281  openssl genpkey -genparam -algorithm DH -out dhp.pem \
282      -pkeyopt dh_paramgen_prime_len:2048
283
284 Generate 2048 bit X9.42 DH parameters:
285
286  openssl genpkey -genparam -algorithm DH -out dhpx.pem \
287      -pkeyopt dh_paramgen_prime_len:2048 \
288      -pkeyopt dh_paramgen_type:1
289
290 Output RFC5114 2048 bit DH parameters with 224 bit subgroup:
291
292  openssl genpkey -genparam -algorithm DH -out dhp.pem -pkeyopt dh_rfc5114:2
293
294 Generate DH key from parameters:
295
296  openssl genpkey -paramfile dhp.pem -out dhkey.pem
297
298 Generate EC parameters:
299
300  openssl genpkey -genparam -algorithm EC -out ecp.pem \
301         -pkeyopt ec_paramgen_curve:secp384r1 \
302         -pkeyopt ec_param_enc:named_curve
303
304 Generate EC key from parameters:
305
306  openssl genpkey -paramfile ecp.pem -out eckey.pem
307
308 Generate EC key directly:
309
310  openssl genpkey -algorithm EC -out eckey.pem \
311         -pkeyopt ec_paramgen_curve:P-384 \
312         -pkeyopt ec_param_enc:named_curve
313
314 Generate an X25519 private key:
315
316  openssl genpkey -algorithm X25519 -out xkey.pem
317
318 Generate an ED448 private key:
319
320  openssl genpkey -algorithm ED448 -out xkey.pem
321
322 =head1 HISTORY
323
324 The ability to use NIST curve names, and to generate an EC key directly,
325 were added in OpenSSL 1.0.2.
326 The ability to generate X25519 keys was added in OpenSSL 1.1.0.
327 The ability to generate X448, ED25519 and ED448 keys was added in OpenSSL 1.1.1.
328
329 =head1 COPYRIGHT
330
331 Copyright 2006-2019 The OpenSSL Project Authors. All Rights Reserved.
332
333 Licensed under the Apache License 2.0 (the "License").  You may not use
334 this file except in compliance with the License.  You can obtain a copy
335 in the file LICENSE in the source distribution or at
336 L<https://www.openssl.org/source/license.html>.
337
338 =cut