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

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