8a789463cd1a403c5c01b2bcd9354718900c5c35
[openssl.git] / doc / apps / genpkey.pod
1 =pod
2
3 =head1 NAME
4
5 genpkey - generate a private key
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<genpkey>
10 [B<-help>]
11 [B<-out filename>]
12 [B<-outform PEM|DER>]
13 [B<-pass arg>]
14 [B<-cipher>]
15 [B<-engine id>]
16 [B<-paramfile file>]
17 [B<-algorithm alg>]
18 [B<-pkeyopt opt:value>]
19 [B<-genparam>]
20 [B<-text>]
21
22 =head1 DESCRIPTION
23
24 The B<genpkey> command generates a private key.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-help>
31
32 Print out a usage message.
33
34 =item B<-out filename>
35
36 Output the key to the specified file. If this argument is not specified then
37 standard output is used.
38
39 =item B<-outform DER|PEM>
40
41 This specifies the output format DER or PEM.
42
43 =item B<-pass arg>
44
45 the output file password source. For more information about the format of B<arg>
46 see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
47
48 =item B<-cipher>
49
50 This option encrypts the private key with the supplied cipher. Any algorithm
51 name accepted by EVP_get_cipherbyname() is acceptable such as B<des3>.
52
53 =item B<-engine id>
54
55 specifying an engine (by its unique B<id> string) will cause B<genpkey>
56 to attempt to obtain a functional reference to the specified engine,
57 thus initialising it if needed. The engine will then be set as the default
58 for all available algorithms. If used this option should precede all other
59 options.
60
61 =item B<-algorithm alg>
62
63 public key algorithm to use such as RSA, DSA or DH. If used this option must
64 precede any B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm>
65 are mutually exclusive.
66
67 =item B<-pkeyopt opt:value>
68
69 set the public key algorithm option B<opt> to B<value>. The precise set of
70 options supported depends on the public key algorithm used and its
71 implementation. See B<KEY GENERATION OPTIONS> below for more details.
72
73 =item B<-genparam>
74
75 generate a set of parameters instead of a private key. If used this option must
76 precede any B<-algorithm>, B<-paramfile> or B<-pkeyopt> options.
77
78 =item B<-paramfile filename>
79
80 Some public key algorithms generate a private key based on a set of parameters.
81 They can be supplied using this option. If this option is used the public key
82 algorithm used is determined by the parameters. If used this option must
83 precede any B<-pkeyopt> options. The options B<-paramfile> and B<-algorithm>
84 are mutually exclusive.
85
86 =item B<-text>
87
88 Print an (unencrypted) text representation of private and public keys and
89 parameters along with the PEM or DER structure.
90
91 =back
92
93 =head1 KEY GENERATION OPTIONS
94
95 The options supported by each algorithm and indeed each implementation of an
96 algorithm can vary. The options for the OpenSSL implementations are detailed
97 below.
98
99 =head1 RSA KEY GENERATION OPTIONS
100
101 =over 4
102
103 =item B<rsa_keygen_bits:numbits>
104
105 The number of bits in the generated key. If not specified 1024 is used.
106
107 =item B<rsa_keygen_pubexp:value>
108
109 The RSA public exponent value. This can be a large decimal or
110 hexadecimal value if preceded by B<0x>. Default value is 65537.
111
112 =back
113
114 =head1 DSA PARAMETER GENERATION OPTIONS
115
116 =over 4
117
118 =item B<dsa_paramgen_bits:numbits>
119
120 The number of bits in the generated parameters. If not specified 1024 is used.
121
122 =back
123
124 =head1 DH PARAMETER GENERATION OPTIONS
125
126 =over 4
127
128 =item B<dh_paramgen_prime_len:numbits>
129
130 The number of bits in the prime parameter B<p>.
131
132 =item B<dh_paramgen_generator:value>
133
134 The value to use for the generator B<g>.
135
136 =item B<dh_rfc5114:num>
137
138 If this option is set then the appropriate RFC5114 parameters are used
139 instead of generating new parameters. The value B<num> can take the
140 values 1, 2 or 3 corresponding to RFC5114 DH parameters consisting of
141 1024 bit group with 160 bit subgroup, 2048 bit group with 224 bit subgroup
142 and 2048 bit group with 256 bit subgroup as mentioned in RFC5114 sections
143 2.1, 2.2 and 2.3 respectively.
144
145 =back
146
147 =head1 EC PARAMETER GENERATION OPTIONS
148
149 The EC parameter generation options below can also
150 be supplied as EC key generation options. This can (for example) generate a
151 key from a named curve without the need to use an explicit parameter file.
152
153 =over 4
154
155 =item B<ec_paramgen_curve:curve>
156
157 the EC curve to use. OpenSSL supports NIST curve names such as "P-256".
158
159 =item B<ec_param_enc:encoding>
160
161 the encoding to use for parameters. The "encoding" parameter must be either
162 "named_curve" or "explicit".
163
164 =back
165
166 =head1 GOST2001 KEY GENERATION AND PARAMETER OPTIONS
167
168 Gost 2001 support is not enabled by default. To enable this algorithm,
169 one should load the ccgost engine in the OpenSSL configuration file.
170 See README.gost file in the engines/ccgost directory of the source
171 distribution for more details.
172
173 Use of a parameter file for the GOST R 34.10 algorithm is optional.
174 Parameters can be specified during key generation directly as well as
175 during generation of parameter file.
176
177 =over 4
178
179 =item B<paramset:name>
180
181 Specifies GOST R 34.10-2001 parameter set according to RFC 4357.
182 Parameter set can be specified using abbreviated name, object short name or
183 numeric OID. Following parameter sets are supported:
184
185   paramset   OID               Usage
186   A          1.2.643.2.2.35.1  Signature
187   B          1.2.643.2.2.35.2  Signature
188   C          1.2.643.2.2.35.3  Signature
189   XA         1.2.643.2.2.36.0  Key exchange
190   XB         1.2.643.2.2.36.1  Key exchange
191   test       1.2.643.2.2.35.0  Test purposes
192
193 =back
194
195
196
197 =head1 NOTES
198
199 The use of the genpkey program is encouraged over the algorithm specific
200 utilities because additional algorithm options and ENGINE provided algorithms
201 can be used.
202
203 =head1 EXAMPLES
204
205 Generate an RSA private key using default parameters:
206
207  openssl genpkey -algorithm RSA -out key.pem
208
209 Encrypt output private key using 128 bit AES and the passphrase "hello":
210
211  openssl genpkey -algorithm RSA -out key.pem -aes-128-cbc -pass pass:hello
212
213 Generate a 2048 bit RSA key using 3 as the public exponent:
214
215  openssl genpkey -algorithm RSA -out key.pem -pkeyopt rsa_keygen_bits:2048 \
216                                                 -pkeyopt rsa_keygen_pubexp:3
217
218 Generate 1024 bit DSA parameters:
219
220  openssl genpkey -genparam -algorithm DSA -out dsap.pem \
221                                                 -pkeyopt dsa_paramgen_bits:1024
222
223 Generate DSA key from parameters:
224
225  openssl genpkey -paramfile dsap.pem -out dsakey.pem
226
227 Generate 1024 bit DH parameters:
228
229  openssl genpkey -genparam -algorithm DH -out dhp.pem \
230                                         -pkeyopt dh_paramgen_prime_len:1024
231
232 Output RFC5114 2048 bit DH parameters with 224 bit subgroup:
233
234  openssl genpkey -genparam -algorithm DH -out dhp.pem -pkeyopt dh_rfc5114:2
235
236 Generate DH key from parameters:
237
238  openssl genpkey -paramfile dhp.pem -out dhkey.pem
239
240 Generate EC parameters:
241
242  openssl genpkey -genparam -algorithm EC -out ecp.pem \
243         -pkeyopt ec_paramgen_curve:secp384r1 \
244         -pkeyopt ec_param_enc:named_curve
245
246 Generate EC key from parameters:
247
248  openssl genpkey -paramfile ecp.pem -out eckey.pem
249
250 Generate EC key directly:
251
252  openssl genpkey -algorithm EC -out eckey.pem \
253         -pkeyopt ec_paramgen_curve:P-384 \
254         -pkeyopt ec_param_enc:named_curve
255
256 =head1 HISTORY
257
258 The ability to use NIST curve names, and to generate an EC key directly,
259 were added in OpenSSL 1.0.2.
260
261 =head1 COPYRIGHT
262
263 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
264
265 Licensed under the OpenSSL license (the "License").  You may not use
266 this file except in compliance with the License.  You can obtain a copy
267 in the file LICENSE in the source distribution or at
268 L<https://www.openssl.org/source/license.html>.
269
270 =cut