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

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