| blob | 9bcadcda429985b89c643c6b58966333d0e6c000 |
1 .\" $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sh \" Subsection heading
8 .br
9 .if t .Sp
10 .ne 5
11 .PP
12 \fB\\$1\fR
13 .PP
14 ..
15 .de Sp \" Vertical space (when we can't use .PP)
16 .if t .sp .5v
17 .if n .sp
18 ..
19 .de Vb \" Begin verbatim text
20 .ft CW
21 .nf
22 .ne \\$1
23 ..
24 .de Ve \" End verbatim text
25 .ft R
26 .fi
27 ..
28 .\" Set up some character translations and predefined strings. \*(-- will
29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
30 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
31 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
32 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
33 .\" nothing in troff, for use with C<>.
34 .tr \(*W-
35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
36 .ie n \{\
37 . ds -- \(*W-
38 . ds PI pi
39 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
40 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
41 . ds L" ""
42 . ds R" ""
43 . ds C` ""
44 . ds C' ""
45 'br\}
46 .el\{\
47 . ds -- \|\(em\|
48 . ds PI \(*p
49 . ds L" ``
50 . ds R" ''
51 'br\}
52 .\"
53 .\" Escape single quotes in literal strings from groff's Unicode transform.
54 .ie \n(.g .ds Aq \(aq
55 .el .ds Aq '
56 .\"
57 .\" If the F register is turned on, we'll generate index entries on stderr for
58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
59 .\" entries marked with X<> in POD. Of course, you'll have to process the
60 .\" output yourself in some meaningful fashion.
61 .ie \nF \{\
62 . de IX
63 . tm Index:\\$1\t\\n%\t"\\$2"
64 ..
65 . nr % 0
66 . rr F
67 .\}
68 .el \{\
69 . de IX
70 ..
71 .\}
72 .\"
73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
74 .\" Fear. Run. Save yourself. No user-serviceable parts.
75 . \" fudge factors for nroff and troff
76 .if n \{\
77 . ds #H 0
78 . ds #V .8m
79 . ds #F .3m
80 . ds #[ \f1
81 . ds #] \fP
82 .\}
83 .if t \{\
84 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . ds #V .6m
86 . ds #F 0
87 . ds #[ \&
88 . ds #] \&
89 .\}
90 . \" simple accents for nroff and troff
91 .if n \{\
92 . ds ' \&
93 . ds ` \&
94 . ds ^ \&
95 . ds , \&
96 . ds ~ ~
97 . ds /
98 .\}
99 .if t \{\
100 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
101 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
102 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
103 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
104 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
105 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
106 .\}
107 . \" troff and (daisy-wheel) nroff accents
108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
115 .ds ae a\h'-(\w'a'u*4/10)'e
116 .ds Ae A\h'-(\w'A'u*4/10)'E
117 . \" corrections for vroff
118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
120 . \" for low resolution devices (crt and lpr)
121 .if \n(.H>23 .if \n(.V>19 \
122 \{\
123 . ds : e
124 . ds 8 ss
125 . ds o a
126 . ds d- d\h'-1'\(ga
127 . ds D- D\h'-1'\(hy
128 . ds th \o'bp'
129 . ds Th \o'LP'
130 . ds ae ae
131 . ds Ae AE
132 .\}
133 .rm #[ #] #H #V #F C
134 .\" ========================================================================
135 .\"
136 .IX Title "PKCS8 1"
137 .TH PKCS8 1 "2009-04-15" "1.1.0-dev" "OpenSSL"
138 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
139 .\" way too many mistakes in technical documents.
140 .if n .ad l
141 .nh
142 .SH "NAME"
143 pkcs8 \- PKCS#8 format private key conversion tool
144 .SH "LIBRARY"
145 libcrypto, -lcrypto
146 .SH "SYNOPSIS"
147 .IX Header "SYNOPSIS"
148 \&\fBopenssl\fR \fBpkcs8\fR
149 [\fB\-topk8\fR]
150 [\fB\-inform PEM|DER\fR]
151 [\fB\-outform PEM|DER\fR]
152 [\fB\-in filename\fR]
153 [\fB\-passin arg\fR]
154 [\fB\-out filename\fR]
155 [\fB\-passout arg\fR]
156 [\fB\-noiter\fR]
157 [\fB\-nocrypt\fR]
158 [\fB\-nooct\fR]
159 [\fB\-embed\fR]
160 [\fB\-nsdb\fR]
161 [\fB\-v2 alg\fR]
162 [\fB\-v1 alg\fR]
163 [\fB\-engine id\fR]
164 .SH "DESCRIPTION"
165 .IX Header "DESCRIPTION"
166 The \fBpkcs8\fR command processes private keys in PKCS#8 format. It can handle
167 both unencrypted PKCS#8 PrivateKeyInfo format and EncryptedPrivateKeyInfo
168 format with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms.
169 .SH "COMMAND OPTIONS"
170 .IX Header "COMMAND OPTIONS"
171 .IP "\fB\-topk8\fR" 4
172 .IX Item "-topk8"
173 Normally a PKCS#8 private key is expected on input and a traditional format
174 private key will be written. With the \fB\-topk8\fR option the situation is
175 reversed: it reads a traditional format private key and writes a PKCS#8
176 format key.
177 .IP "\fB\-inform DER|PEM\fR" 4
178 .IX Item "-inform DER|PEM"
179 This specifies the input format. If a PKCS#8 format key is expected on input
180 then either a \fB\s-1DER\s0\fR or \fB\s-1PEM\s0\fR encoded version of a PKCS#8 key will be
181 expected. Otherwise the \fB\s-1DER\s0\fR or \fB\s-1PEM\s0\fR format of the traditional format
182 private key is used.
183 .IP "\fB\-outform DER|PEM\fR" 4
184 .IX Item "-outform DER|PEM"
185 This specifies the output format, the options have the same meaning as the
186 \&\fB\-inform\fR option.
187 .IP "\fB\-in filename\fR" 4
188 .IX Item "-in filename"
189 This specifies the input filename to read a key from or standard input if this
190 option is not specified. If the key is encrypted a pass phrase will be
191 prompted for.
192 .IP "\fB\-passin arg\fR" 4
193 .IX Item "-passin arg"
194 the input file password source. For more information about the format of \fBarg\fR
195 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
196 .IP "\fB\-out filename\fR" 4
197 .IX Item "-out filename"
198 This specifies the output filename to write a key to or standard output by
199 default. If any encryption options are set then a pass phrase will be
200 prompted for. The output filename should \fBnot\fR be the same as the input
201 filename.
202 .IP "\fB\-passout arg\fR" 4
203 .IX Item "-passout arg"
204 the output file password source. For more information about the format of \fBarg\fR
205 see the \fB\s-1PASS\s0 \s-1PHRASE\s0 \s-1ARGUMENTS\s0\fR section in \fIopenssl\fR\|(1).
206 .IP "\fB\-nocrypt\fR" 4
207 .IX Item "-nocrypt"
208 PKCS#8 keys generated or input are normally PKCS#8 EncryptedPrivateKeyInfo
209 structures using an appropriate password based encryption algorithm. With
210 this option an unencrypted PrivateKeyInfo structure is expected or output.
211 This option does not encrypt private keys at all and should only be used
212 when absolutely necessary. Certain software such as some versions of Java
213 code signing software used unencrypted private keys.
214 .IP "\fB\-nooct\fR" 4
215 .IX Item "-nooct"
216 This option generates \s-1RSA\s0 private keys in a broken format that some software
217 uses. Specifically the private key should be enclosed in a \s-1OCTET\s0 \s-1STRING\s0
218 but some software just includes the structure itself without the
219 surrounding \s-1OCTET\s0 \s-1STRING\s0.
220 .IP "\fB\-embed\fR" 4
221 .IX Item "-embed"
222 This option generates \s-1DSA\s0 keys in a broken format. The \s-1DSA\s0 parameters are
223 embedded inside the PrivateKey structure. In this form the \s-1OCTET\s0 \s-1STRING\s0
224 contains an \s-1ASN1\s0 \s-1SEQUENCE\s0 consisting of two structures: a \s-1SEQUENCE\s0 containing
225 the parameters and an \s-1ASN1\s0 \s-1INTEGER\s0 containing the private key.
226 .IP "\fB\-nsdb\fR" 4
227 .IX Item "-nsdb"
228 This option generates \s-1DSA\s0 keys in a broken format compatible with Netscape
229 private key databases. The PrivateKey contains a \s-1SEQUENCE\s0 consisting of
230 the public and private keys respectively.
231 .IP "\fB\-v2 alg\fR" 4
232 .IX Item "-v2 alg"
233 This option enables the use of PKCS#5 v2.0 algorithms. Normally PKCS#8
234 private keys are encrypted with the password based encryption algorithm
235 called \fBpbeWithMD5AndDES\-CBC\fR this uses 56 bit \s-1DES\s0 encryption but it
236 was the strongest encryption algorithm supported in PKCS#5 v1.5. Using
237 the \fB\-v2\fR option PKCS#5 v2.0 algorithms are used which can use any
238 encryption algorithm such as 168 bit triple \s-1DES\s0 or 128 bit \s-1RC2\s0 however
239 not many implementations support PKCS#5 v2.0 yet. If you are just using
240 private keys with OpenSSL then this doesn't matter.
241 .Sp
242 The \fBalg\fR argument is the encryption algorithm to use, valid values include
243 \&\fBdes\fR, \fBdes3\fR and \fBrc2\fR. It is recommended that \fBdes3\fR is used.
244 .IP "\fB\-v1 alg\fR" 4
245 .IX Item "-v1 alg"
246 This option specifies a PKCS#5 v1.5 or PKCS#12 algorithm to use. A complete
247 list of possible algorithms is included below.
248 .IP "\fB\-engine id\fR" 4
249 .IX Item "-engine id"
250 specifying an engine (by its unique \fBid\fR string) will cause \fBpkcs8\fR
251 to attempt to obtain a functional reference to the specified engine,
252 thus initialising it if needed. The engine will then be set as the default
253 for all available algorithms.
254 .SH "NOTES"
255 .IX Header "NOTES"
256 The encrypted form of a \s-1PEM\s0 encode PKCS#8 files uses the following
257 headers and footers:
258 .PP
259 .Vb 2
260 \& \-\-\-\-\-BEGIN ENCRYPTED PRIVATE KEY\-\-\-\-\-
261 \& \-\-\-\-\-END ENCRYPTED PRIVATE KEY\-\-\-\-\-
262 .Ve
263 .PP
264 The unencrypted form uses:
265 .PP
266 .Vb 2
267 \& \-\-\-\-\-BEGIN PRIVATE KEY\-\-\-\-\-
268 \& \-\-\-\-\-END PRIVATE KEY\-\-\-\-\-
269 .Ve
270 .PP
271 Private keys encrypted using PKCS#5 v2.0 algorithms and high iteration
272 counts are more secure that those encrypted using the traditional
273 SSLeay compatible formats. So if additional security is considered
274 important the keys should be converted.
275 .PP
276 The default encryption is only 56 bits because this is the encryption
277 that most current implementations of PKCS#8 will support.
278 .PP
279 Some software may use PKCS#12 password based encryption algorithms
280 with PKCS#8 format private keys: these are handled automatically
281 but there is no option to produce them.
282 .PP
283 It is possible to write out \s-1DER\s0 encoded encrypted private keys in
284 PKCS#8 format because the encryption details are included at an \s-1ASN1\s0
285 level whereas the traditional format includes them at a \s-1PEM\s0 level.
286 .SH "PKCS#5 v1.5 and PKCS#12 algorithms."
287 .IX Header "PKCS#5 v1.5 and PKCS#12 algorithms."
288 Various algorithms can be used with the \fB\-v1\fR command line option,
289 including PKCS#5 v1.5 and PKCS#12. These are described in more detail
290 below.
291 .IP "\fB\s-1PBE\-MD2\-DES\s0 \s-1PBE\-MD5\-DES\s0\fR" 4
292 .IX Item "PBE-MD2-DES PBE-MD5-DES"
293 These algorithms were included in the original PKCS#5 v1.5 specification.
294 They only offer 56 bits of protection since they both use \s-1DES\s0.
295 .IP "\fB\s-1PBE\-SHA1\-RC2\-64\s0 \s-1PBE\-MD2\-RC2\-64\s0 \s-1PBE\-MD5\-RC2\-64\s0 \s-1PBE\-SHA1\-DES\s0\fR" 4
296 .IX Item "PBE-SHA1-RC2-64 PBE-MD2-RC2-64 PBE-MD5-RC2-64 PBE-SHA1-DES"
297 These algorithms are not mentioned in the original PKCS#5 v1.5 specification
298 but they use the same key derivation algorithm and are supported by some
299 software. They are mentioned in PKCS#5 v2.0. They use either 64 bit \s-1RC2\s0 or
300 56 bit \s-1DES\s0.
301 .IP "\fB\s-1PBE\-SHA1\-RC4\-128\s0 \s-1PBE\-SHA1\-RC4\-40\s0 \s-1PBE\-SHA1\-3DES\s0 \s-1PBE\-SHA1\-2DES\s0 \s-1PBE\-SHA1\-RC2\-128\s0 \s-1PBE\-SHA1\-RC2\-40\s0\fR" 4
302 .IX Item "PBE-SHA1-RC4-128 PBE-SHA1-RC4-40 PBE-SHA1-3DES PBE-SHA1-2DES PBE-SHA1-RC2-128 PBE-SHA1-RC2-40"
303 These algorithms use the PKCS#12 password based encryption algorithm and
304 allow strong encryption algorithms like triple \s-1DES\s0 or 128 bit \s-1RC2\s0 to be used.
305 .SH "EXAMPLES"
306 .IX Header "EXAMPLES"
307 Convert a private from traditional to PKCS#5 v2.0 format using triple
308 \&\s-1DES:\s0
309 .PP
310 .Vb 1
311 \& openssl pkcs8 \-in key.pem \-topk8 \-v2 des3 \-out enckey.pem
312 .Ve
313 .PP
314 Convert a private key to PKCS#8 using a PKCS#5 1.5 compatible algorithm
315 (\s-1DES\s0):
316 .PP
317 .Vb 1
318 \& openssl pkcs8 \-in key.pem \-topk8 \-out enckey.pem
319 .Ve
320 .PP
321 Convert a private key to PKCS#8 using a PKCS#12 compatible algorithm
322 (3DES):
323 .PP
324 .Vb 1
325 \& openssl pkcs8 \-in key.pem \-topk8 \-out enckey.pem \-v1 PBE\-SHA1\-3DES
326 .Ve
327 .PP
328 Read a \s-1DER\s0 unencrypted PKCS#8 format private key:
329 .PP
330 .Vb 1
331 \& openssl pkcs8 \-inform DER \-nocrypt \-in key.der \-out key.pem
332 .Ve
333 .PP
334 Convert a private key from any PKCS#8 format to traditional format:
335 .PP
336 .Vb 1
337 \& openssl pkcs8 \-in pk8.pem \-out key.pem
338 .Ve
339 .SH "STANDARDS"
340 .IX Header "STANDARDS"
341 Test vectors from this PKCS#5 v2.0 implementation were posted to the
342 pkcs-tng mailing list using triple \s-1DES\s0, \s-1DES\s0 and \s-1RC2\s0 with high iteration
343 counts, several people confirmed that they could decrypt the private
344 keys produced and Therefore it can be assumed that the PKCS#5 v2.0
345 implementation is reasonably accurate at least as far as these
346 algorithms are concerned.
347 .PP
348 The format of PKCS#8 \s-1DSA\s0 (and other) private keys is not well documented:
349 it is hidden away in PKCS#11 v2.01, section 11.9. OpenSSL's default \s-1DSA\s0
350 PKCS#8 private key format complies with this standard.
351 .SH "BUGS"
352 .IX Header "BUGS"
353 There should be an option that prints out the encryption algorithm
354 in use and other details such as the iteration count.
355 .PP
356 PKCS#8 using triple \s-1DES\s0 and PKCS#5 v2.0 should be the default private
357 key format for OpenSSL: for compatibility several of the utilities use
358 the old format at present.
359 .SH "SEE ALSO"
360 .IX Header "SEE ALSO"
361 \&\fIopenssl_dsa\fR\|(1), \fIopenssl_rsa\fR\|(1), \fIopenssl_genrsa\fR\|(1),
362 \&\fIopenssl_gendsa\fR\|(1)