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

   1 .\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
   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 >0, 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 "2019-05-28" "1.0.2s" "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 openssl\-pkcs8,
 143 pkcs8 \- PKCS#8 format private key conversion tool
 144 .SH "SYNOPSIS"
 145 .IX Header "SYNOPSIS"
 146 \&\fBopenssl\fR \fBpkcs8\fR
 147 [\fB\-topk8\fR]
 148 [\fB\-inform PEM|DER\fR]
 149 [\fB\-outform PEM|DER\fR]
 150 [\fB\-in filename\fR]
 151 [\fB\-passin arg\fR]
 152 [\fB\-out filename\fR]
 153 [\fB\-passout arg\fR]
 154 [\fB\-noiter\fR]
 155 [\fB\-nocrypt\fR]
 156 [\fB\-nooct\fR]
 157 [\fB\-embed\fR]
 158 [\fB\-nsdb\fR]
 159 [\fB\-v2 alg\fR]
 160 [\fB\-v2prf alg\fR]
 161 [\fB\-v1 alg\fR]
 162 [\fB\-engine id\fR]
 163 .SH "DESCRIPTION"
 164 .IX Header "DESCRIPTION"
 165 The \fBpkcs8\fR command processes private keys in PKCS#8 format. It can handle
 166 both unencrypted PKCS#8 PrivateKeyInfo format and EncryptedPrivateKeyInfo
 167 format with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms.
 168 .SH "COMMAND OPTIONS"
 169 .IX Header "COMMAND OPTIONS"
 170 .IP "\fB\-topk8\fR" 4
 171 .IX Item "-topk8"
 172 Normally a PKCS#8 private key is expected on input and a traditional format
 173 private key will be written. With the \fB\-topk8\fR option the situation is
 174 reversed: it reads a traditional format private key and writes a PKCS#8
 175 format key.
 176 .IP "\fB\-inform DER|PEM\fR" 4
 177 .IX Item "-inform DER|PEM"
 178 This specifies the input format. If a PKCS#8 format key is expected on input
 179 then either a \fB\s-1DER\s0\fR or \fB\s-1PEM\s0\fR encoded version of a PKCS#8 key will be
 180 expected. Otherwise the \fB\s-1DER\s0\fR or \fB\s-1PEM\s0\fR format of the traditional format
 181 private key is used.
 182 .IP "\fB\-outform DER|PEM\fR" 4
 183 .IX Item "-outform DER|PEM"
 184 This specifies the output format, the options have the same meaning as the
 185 \&\fB\-inform\fR option.
 186 .IP "\fB\-in filename\fR" 4
 187 .IX Item "-in filename"
 188 This specifies the input filename to read a key from or standard input if this
 189 option is not specified. If the key is encrypted a pass phrase will be
 190 prompted for.
 191 .IP "\fB\-passin arg\fR" 4
 192 .IX Item "-passin arg"
 193 the input file password source. For more information about the format of \fBarg\fR
 194 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
 195 .IP "\fB\-out filename\fR" 4
 196 .IX Item "-out filename"
 197 This specifies the output filename to write a key to or standard output by
 198 default. If any encryption options are set then a pass phrase will be
 199 prompted for. The output filename should \fBnot\fR be the same as the input
 200 filename.
 201 .IP "\fB\-passout arg\fR" 4
 202 .IX Item "-passout arg"
 203 the output file password source. For more information about the format of \fBarg\fR
 204 see the \fB\s-1PASS PHRASE ARGUMENTS\s0\fR section in \fBopenssl\fR\|(1).
 205 .IP "\fB\-nocrypt\fR" 4
 206 .IX Item "-nocrypt"
 207 PKCS#8 keys generated or input are normally PKCS#8 EncryptedPrivateKeyInfo
 208 structures using an appropriate password based encryption algorithm. With
 209 this option an unencrypted PrivateKeyInfo structure is expected or output.
 210 This option does not encrypt private keys at all and should only be used
 211 when absolutely necessary. Certain software such as some versions of Java
 212 code signing software used unencrypted private keys.
 213 .IP "\fB\-nooct\fR" 4
 214 .IX Item "-nooct"
 215 This option generates \s-1RSA\s0 private keys in a broken format that some software
 216 uses. Specifically the private key should be enclosed in a \s-1OCTET STRING\s0
 217 but some software just includes the structure itself without the
 218 surrounding \s-1OCTET STRING.\s0
 219 .IP "\fB\-embed\fR" 4
 220 .IX Item "-embed"
 221 This option generates \s-1DSA\s0 keys in a broken format. The \s-1DSA\s0 parameters are
 222 embedded inside the PrivateKey structure. In this form the \s-1OCTET STRING\s0
 223 contains an \s-1ASN1 SEQUENCE\s0 consisting of two structures: a \s-1SEQUENCE\s0 containing
 224 the parameters and an \s-1ASN1 INTEGER\s0 containing the private key.
 225 .IP "\fB\-nsdb\fR" 4
 226 .IX Item "-nsdb"
 227 This option generates \s-1DSA\s0 keys in a broken format compatible with Netscape
 228 private key databases. The PrivateKey contains a \s-1SEQUENCE\s0 consisting of
 229 the public and private keys respectively.
 230 .IP "\fB\-v2 alg\fR" 4
 231 .IX Item "-v2 alg"
 232 This option enables the use of PKCS#5 v2.0 algorithms. Normally PKCS#8
 233 private keys are encrypted with the password based encryption algorithm
 234 called \fBpbeWithMD5AndDES\-CBC\fR this uses 56 bit \s-1DES\s0 encryption but it
 235 was the strongest encryption algorithm supported in PKCS#5 v1.5. Using
 236 the \fB\-v2\fR option PKCS#5 v2.0 algorithms are used which can use any
 237 encryption algorithm such as 168 bit triple \s-1DES\s0 or 128 bit \s-1RC2\s0 however
 238 not many implementations support PKCS#5 v2.0 yet. If you are just using
 239 private keys with OpenSSL then this doesn't matter.
 240 .Sp
 241 The \fBalg\fR argument is the encryption algorithm to use, valid values include
 242 \&\fBdes\fR, \fBdes3\fR and \fBrc2\fR. It is recommended that \fBdes3\fR is used.
 243 .IP "\fB\-v2prf alg\fR" 4
 244 .IX Item "-v2prf alg"
 245 This option sets the \s-1PRF\s0 algorithm to use with PKCS#5 v2.0. A typical value
 246 values would be \fBhmacWithSHA256\fR. If this option isn't set then the default
 247 for the cipher is used or \fBhmacWithSHA1\fR if there is no default.
 248 .IP "\fB\-v1 alg\fR" 4
 249 .IX Item "-v1 alg"
 250 This option specifies a PKCS#5 v1.5 or PKCS#12 algorithm to use. A complete
 251 list of possible algorithms is included below.
 252 .IP "\fB\-engine id\fR" 4
 253 .IX Item "-engine id"
 254 specifying an engine (by its unique \fBid\fR string) will cause \fBpkcs8\fR
 255 to attempt to obtain a functional reference to the specified engine,
 256 thus initialising it if needed. The engine will then be set as the default
 257 for all available algorithms.
 258 .SH "NOTES"
 259 .IX Header "NOTES"
 260 The encrypted form of a \s-1PEM\s0 encode PKCS#8 files uses the following
 261 headers and footers:
 262 .PP
 263 .Vb 2
 264 \& \-\-\-\-\-BEGIN ENCRYPTED PRIVATE KEY\-\-\-\-\-
 265 \& \-\-\-\-\-END ENCRYPTED PRIVATE KEY\-\-\-\-\-
 266 .Ve
 267 .PP
 268 The unencrypted form uses:
 269 .PP
 270 .Vb 2
 271 \& \-\-\-\-\-BEGIN PRIVATE KEY\-\-\-\-\-
 272 \& \-\-\-\-\-END PRIVATE KEY\-\-\-\-\-
 273 .Ve
 274 .PP
 275 Private keys encrypted using PKCS#5 v2.0 algorithms and high iteration
 276 counts are more secure that those encrypted using the traditional
 277 SSLeay compatible formats. So if additional security is considered
 278 important the keys should be converted.
 279 .PP
 280 The default encryption is only 56 bits because this is the encryption
 281 that most current implementations of PKCS#8 will support.
 282 .PP
 283 Some software may use PKCS#12 password based encryption algorithms
 284 with PKCS#8 format private keys: these are handled automatically
 285 but there is no option to produce them.
 286 .PP
 287 It is possible to write out \s-1DER\s0 encoded encrypted private keys in
 288 PKCS#8 format because the encryption details are included at an \s-1ASN1\s0
 289 level whereas the traditional format includes them at a \s-1PEM\s0 level.
 290 .SH "PKCS#5 v1.5 and PKCS#12 algorithms."
 291 .IX Header "PKCS#5 v1.5 and PKCS#12 algorithms."
 292 Various algorithms can be used with the \fB\-v1\fR command line option,
 293 including PKCS#5 v1.5 and PKCS#12. These are described in more detail
 294 below.
 295 .IP "\fB\s-1PBE\-MD2\-DES PBE\-MD5\-DES\s0\fR" 4
 296 .IX Item "PBE-MD2-DES PBE-MD5-DES"
 297 These algorithms were included in the original PKCS#5 v1.5 specification.
 298 They only offer 56 bits of protection since they both use \s-1DES.\s0
 299 .IP "\fB\s-1PBE\-SHA1\-RC2\-64 PBE\-MD2\-RC2\-64 PBE\-MD5\-RC2\-64 PBE\-SHA1\-DES\s0\fR" 4
 300 .IX Item "PBE-SHA1-RC2-64 PBE-MD2-RC2-64 PBE-MD5-RC2-64 PBE-SHA1-DES"
 301 These algorithms are not mentioned in the original PKCS#5 v1.5 specification
 302 but they use the same key derivation algorithm and are supported by some
 303 software. They are mentioned in PKCS#5 v2.0. They use either 64 bit \s-1RC2\s0 or
 304 56 bit \s-1DES.\s0
 305 .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
 306 .IX Item "PBE-SHA1-RC4-128 PBE-SHA1-RC4-40 PBE-SHA1-3DES PBE-SHA1-2DES PBE-SHA1-RC2-128 PBE-SHA1-RC2-40"
 307 These algorithms use the PKCS#12 password based encryption algorithm and
 308 allow strong encryption algorithms like triple \s-1DES\s0 or 128 bit \s-1RC2\s0 to be used.
 309 .SH "EXAMPLES"
 310 .IX Header "EXAMPLES"
 311 Convert a private from traditional to PKCS#5 v2.0 format using triple
 312 \&\s-1DES:\s0
 313 .PP
 314 .Vb 1
 315 \& openssl pkcs8 \-in key.pem \-topk8 \-v2 des3 \-out enckey.pem
 316 .Ve
 317 .PP
 318 Convert a private from traditional to PKCS#5 v2.0 format using \s-1AES\s0 with
 319 256 bits in \s-1CBC\s0 mode and \fBhmacWithSHA256\fR \s-1PRF:\s0
 320 .PP
 321 .Vb 1
 322 \& openssl pkcs8 \-in key.pem \-topk8 \-v2 aes\-256\-cbc \-v2prf hmacWithSHA256 \-out enckey.pem
 323 .Ve
 324 .PP
 325 Convert a private key to PKCS#8 using a PKCS#5 1.5 compatible algorithm
 326 (\s-1DES\s0):
 327 .PP
 328 .Vb 1
 329 \& openssl pkcs8 \-in key.pem \-topk8 \-out enckey.pem
 330 .Ve
 331 .PP
 332 Convert a private key to PKCS#8 using a PKCS#12 compatible algorithm
 333 (3DES):
 334 .PP
 335 .Vb 1
 336 \& openssl pkcs8 \-in key.pem \-topk8 \-out enckey.pem \-v1 PBE\-SHA1\-3DES
 337 .Ve
 338 .PP
 339 Read a \s-1DER\s0 unencrypted PKCS#8 format private key:
 340 .PP
 341 .Vb 1
 342 \& openssl pkcs8 \-inform DER \-nocrypt \-in key.der \-out key.pem
 343 .Ve
 344 .PP
 345 Convert a private key from any PKCS#8 format to traditional format:
 346 .PP
 347 .Vb 1
 348 \& openssl pkcs8 \-in pk8.pem \-out key.pem
 349 .Ve
 350 .SH "STANDARDS"
 351 .IX Header "STANDARDS"
 352 Test vectors from this PKCS#5 v2.0 implementation were posted to the
 353 pkcs-tng mailing list using triple \s-1DES, DES\s0 and \s-1RC2\s0 with high iteration
 354 counts, several people confirmed that they could decrypt the private
 355 keys produced and Therefore it can be assumed that the PKCS#5 v2.0
 356 implementation is reasonably accurate at least as far as these
 357 algorithms are concerned.
 358 .PP
 359 The format of PKCS#8 \s-1DSA\s0 (and other) private keys is not well documented:
 360 it is hidden away in PKCS#11 v2.01, section 11.9. OpenSSL's default \s-1DSA\s0
 361 PKCS#8 private key format complies with this standard.
 362 .SH "BUGS"
 363 .IX Header "BUGS"
 364 There should be an option that prints out the encryption algorithm
 365 in use and other details such as the iteration count.
 366 .PP
 367 PKCS#8 using triple \s-1DES\s0 and PKCS#5 v2.0 should be the default private
 368 key format for OpenSSL: for compatibility several of the utilities use
 369 the old format at present.
 370 .SH "SEE ALSO"
 371 .IX Header "SEE ALSO"
 372 \&\fBdsa\fR\|(1), \fBrsa\fR\|(1), \fBgenrsa\fR\|(1),
 373 \&\fBgendsa\fR\|(1)