| blob | 791f909e809ba2a9e8ed4bdf01b0c3f198f69168 |
1 .\" $NetBSD: openssl_genpkey.1,v 1.14 2015/06/12 17:01:15 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
10 ..
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
15 ..
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
19 ..
20 .\" Set up some character translations and predefined strings. \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
23 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 . ds -- \(*W-
30 . ds PI pi
31 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
33 . ds L" ""
34 . ds R" ""
35 . ds C` ""
36 . ds C' ""
37 'br\}
38 .el\{\
39 . ds -- \|\(em\|
40 . ds PI \(*p
41 . ds L" ``
42 . ds R" ''
43 . ds C`
44 . ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
58 ..
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 . if \nF \{
63 . de IX
64 . tm Index:\\$1\t\\n%\t"\\$2"
65 ..
66 . if !\nF==2 \{
67 . nr % 0
68 . nr F 2
69 . \}
70 . \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear. Run. Save yourself. No user-serviceable parts.
76 . \" fudge factors for nroff and troff
77 .if n \{\
78 . ds #H 0
79 . ds #V .8m
80 . ds #F .3m
81 . ds #[ \f1
82 . ds #] \fP
83 .\}
84 .if t \{\
85 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 . ds #V .6m
87 . ds #F 0
88 . ds #[ \&
89 . ds #] \&
90 .\}
91 . \" simple accents for nroff and troff
92 .if n \{\
93 . ds ' \&
94 . ds ` \&
95 . ds ^ \&
96 . ds , \&
97 . ds ~ ~
98 . ds /
99 .\}
100 .if t \{\
101 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
107 .\}
108 . \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 . \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 . \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
123 \{\
124 . ds : e
125 . ds 8 ss
126 . ds o a
127 . ds d- d\h'-1'\(ga
128 . ds D- D\h'-1'\(hy
129 . ds th \o'bp'
130 . ds Th \o'LP'
131 . ds ae ae
132 . ds Ae AE
133 .\}
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
136 .\"
137 .IX Title "GENPKEY 1"
138 .TH GENPKEY 1 "2010-01-24" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
142 .nh
143 .SH "NAME"
144 genpkey \- generate a private key
145 .SH "LIBRARY"
146 libcrypto, -lcrypto
147 .SH "SYNOPSIS"
148 .IX Header "SYNOPSIS"
149 \&\fBopenssl\fR \fBgenpkey\fR
150 [\fB\-out filename\fR]
151 [\fB\-outform PEM|DER\fR]
152 [\fB\-pass arg\fR]
153 [\fB\-cipher\fR]
154 [\fB\-engine id\fR]
155 [\fB\-paramfile file\fR]
156 [\fB\-algorithm alg\fR]
157 [\fB\-pkeyopt opt:value\fR]
158 [\fB\-genparam\fR]
159 [\fB\-text\fR]
160 .SH "DESCRIPTION"
161 .IX Header "DESCRIPTION"
162 The \fBgenpkey\fR command generates a private key.
163 .SH "OPTIONS"
164 .IX Header "OPTIONS"
165 .IP "\fB\-out filename\fR" 4
166 .IX Item "-out filename"
167 the output filename. If this argument is not specified then standard output is
168 used.
169 .IP "\fB\-outform DER|PEM\fR" 4
170 .IX Item "-outform DER|PEM"
171 This specifies the output format \s-1DER\s0 or \s-1PEM.\s0
172 .IP "\fB\-pass arg\fR" 4
173 .IX Item "-pass arg"
174 the output file password source. For more information about the format of \fBarg\fR
175 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
176 .IP "\fB\-cipher\fR" 4
177 .IX Item "-cipher"
178 This option encrypts the private key with the supplied cipher. Any algorithm
179 name accepted by \fIEVP_get_cipherbyname()\fR is acceptable such as \fBdes3\fR.
180 .IP "\fB\-engine id\fR" 4
181 .IX Item "-engine id"
182 specifying an engine (by its unique \fBid\fR string) will cause \fBgenpkey\fR
183 to attempt to obtain a functional reference to the specified engine,
184 thus initialising it if needed. The engine will then be set as the default
185 for all available algorithms. If used this option should precede all other
186 options.
187 .IP "\fB\-algorithm alg\fR" 4
188 .IX Item "-algorithm alg"
189 public key algorithm to use such as \s-1RSA, DSA\s0 or \s-1DH.\s0 If used this option must
190 precede any \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR
191 are mutually exclusive.
192 .IP "\fB\-pkeyopt opt:value\fR" 4
193 .IX Item "-pkeyopt opt:value"
194 set the public key algorithm option \fBopt\fR to \fBvalue\fR. The precise set of
195 options supported depends on the public key algorithm used and its
196 implementation. See \fB\s-1KEY GENERATION OPTIONS\s0\fR below for more details.
197 .IP "\fB\-genparam\fR" 4
198 .IX Item "-genparam"
199 generate a set of parameters instead of a private key. If used this option must
200 precede and \fB\-algorithm\fR, \fB\-paramfile\fR or \fB\-pkeyopt\fR options.
201 .IP "\fB\-paramfile filename\fR" 4
202 .IX Item "-paramfile filename"
203 Some public key algorithms generate a private key based on a set of parameters.
204 They can be supplied using this option. If this option is used the public key
205 algorithm used is determined by the parameters. If used this option must
206 precede and \fB\-pkeyopt\fR options. The options \fB\-paramfile\fR and \fB\-algorithm\fR
207 are mutually exclusive.
208 .IP "\fB\-text\fR" 4
209 .IX Item "-text"
210 Print an (unencrypted) text representation of private and public keys and
211 parameters along with the \s-1PEM\s0 or \s-1DER\s0 structure.
212 .SH "KEY GENERATION OPTIONS"
213 .IX Header "KEY GENERATION OPTIONS"
214 The options supported by each algorith and indeed each implementation of an
215 algorithm can vary. The options for the OpenSSL implementations are detailed
216 below.
217 .SH "RSA KEY GENERATION OPTIONS"
218 .IX Header "RSA KEY GENERATION OPTIONS"
219 .IP "\fBrsa_keygen_bits:numbits\fR" 4
220 .IX Item "rsa_keygen_bits:numbits"
221 The number of bits in the generated key. If not specified 1024 is used.
222 .IP "\fBrsa_keygen_pubexp:value\fR" 4
223 .IX Item "rsa_keygen_pubexp:value"
224 The \s-1RSA\s0 public exponent value. This can be a large decimal or
225 hexadecimal value if preceded by \fB0x\fR. Default value is 65537.
226 .SH "DSA PARAMETER GENERATION OPTIONS"
227 .IX Header "DSA PARAMETER GENERATION OPTIONS"
228 .IP "\fBdsa_paramgen_bits:numbits\fR" 4
229 .IX Item "dsa_paramgen_bits:numbits"
230 The number of bits in the generated parameters. If not specified 1024 is used.
231 .SH "DH PARAMETER GENERATION OPTIONS"
232 .IX Header "DH PARAMETER GENERATION OPTIONS"
233 .IP "\fBdh_paramgen_prime_len:numbits\fR" 4
234 .IX Item "dh_paramgen_prime_len:numbits"
235 The number of bits in the prime parameter \fBp\fR.
236 .IP "\fBdh_paramgen_generator:value\fR" 4
237 .IX Item "dh_paramgen_generator:value"
238 The value to use for the generator \fBg\fR.
239 .SH "EC PARAMETER GENERATION OPTIONS"
240 .IX Header "EC PARAMETER GENERATION OPTIONS"
241 .IP "\fBec_paramgen_curve:curve\fR" 4
242 .IX Item "ec_paramgen_curve:curve"
243 the \s-1EC\s0 curve to use.
244 .SH "GOST2001 KEY GENERATION AND PARAMETER OPTIONS"
245 .IX Header "GOST2001 KEY GENERATION AND PARAMETER OPTIONS"
246 Gost 2001 support is not enabled by default. To enable this algorithm,
247 one should load the ccgost engine in the OpenSSL configuration file.
248 See \s-1README\s0.gost file in the engines/ccgost directiry of the source
249 distribution for more details.
250 .PP
251 Use of a parameter file for the \s-1GOST R 34.10\s0 algorithm is optional.
252 Parameters can be specified during key generation directly as well as
253 during generation of parameter file.
254 .IP "\fBparamset:name\fR" 4
255 .IX Item "paramset:name"
256 Specifies \s-1GOST R 34.10\-2001\s0 parameter set according to \s-1RFC 4357.\s0
257 Parameter set can be specified using abbreviated name, object short name or
258 numeric \s-1OID.\s0 Following parameter sets are supported:
259 .Sp
260 .Vb 7
261 \& paramset OID Usage
262 \& A 1.2.643.2.2.35.1 Signature
263 \& B 1.2.643.2.2.35.2 Signature
264 \& C 1.2.643.2.2.35.3 Signature
265 \& XA 1.2.643.2.2.36.0 Key exchange
266 \& XB 1.2.643.2.2.36.1 Key exchange
267 \& test 1.2.643.2.2.35.0 Test purposes
268 .Ve
269 .SH "NOTES"
270 .IX Header "NOTES"
271 The use of the genpkey program is encouraged over the algorithm specific
272 utilities because additional algorithm options and \s-1ENGINE\s0 provided algorithms
273 can be used.
274 .SH "EXAMPLES"
275 .IX Header "EXAMPLES"
276 Generate an \s-1RSA\s0 private key using default parameters:
277 .PP
278 .Vb 1
279 \& openssl genpkey \-algorithm RSA \-out key.pem
280 .Ve
281 .PP
282 Encrypt output private key using 128 bit \s-1AES\s0 and the passphrase \*(L"hello\*(R":
283 .PP
284 .Vb 1
285 \& openssl genpkey \-algorithm RSA \-out key.pem \-aes\-128\-cbc \-pass pass:hello
286 .Ve
287 .PP
288 Generate a 2048 bit \s-1RSA\s0 key using 3 as the public exponent:
289 .PP
290 .Vb 2
291 \& openssl genpkey \-algorithm RSA \-out key.pem \-pkeyopt rsa_keygen_bits:2048 \e
292 \& \-pkeyopt rsa_keygen_pubexp:3
293 .Ve
294 .PP
295 Generate 1024 bit \s-1DSA\s0 parameters:
296 .PP
297 .Vb 2
298 \& openssl genpkey \-genparam \-algorithm DSA \-out dsap.pem \e
299 \& \-pkeyopt dsa_paramgen_bits:1024
300 .Ve
301 .PP
302 Generate \s-1DSA\s0 key from parameters:
303 .PP
304 .Vb 1
305 \& openssl genpkey \-paramfile dsap.pem \-out dsakey.pem
306 .Ve
307 .PP
308 Generate 1024 bit \s-1DH\s0 parameters:
309 .PP
310 .Vb 2
311 \& openssl genpkey \-genparam \-algorithm DH \-out dhp.pem \e
312 \& \-pkeyopt dh_paramgen_prime_len:1024
313 .Ve
314 .PP
315 Generate \s-1DH\s0 key from parameters:
316 .PP
317 .Vb 1
318 \& openssl genpkey \-paramfile dhp.pem \-out dhkey.pem
319 .Ve