secure/usr.bin/openssl/man/pkcs8.1

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