doc/man1/openssl-pkcs8.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 openssl-pkcs8 - PKCS#8 format private key conversion tool
   6
   7 =head1 SYNOPSIS
   8
   9 B<openssl> B<pkcs8>
  10 [B<-help>]
  11 [B<-topk8>]
  12 [B<-inform> B<DER>|B<PEM>]
  13 [B<-outform> B<DER>|B<PEM>]
  14 [B<-in> I<filename>]
  15 [B<-passin> I<arg>]
  16 [B<-out> I<filename>]
  17 [B<-passout> I<arg>]
  18 [B<-iter> I<count>]
  19 [B<-noiter>]
  20 [B<-rand> I<files>]
  21 [B<-writerand> I<file>]
  22 [B<-nocrypt>]
  23 [B<-traditional>]
  24 [B<-v2> I<alg>]
  25 [B<-v2prf> I<alg>]
  26 [B<-v1> I<alg>]
  27 [B<-engine> I<id>]
  28 [B<-scrypt>]
  29 [B<-scrypt_N> I<N>]
  30 [B<-scrypt_r> I<r>]
  31 [B<-scrypt_p> I<p>]
  32
  33 =for openssl ifdef engine scrypt scrypt_N scrypt_r scrypt_p
  34
  35 =head1 DESCRIPTION
  36
  37 This command processes private keys in PKCS#8 format. It can handle
  38 both unencrypted PKCS#8 PrivateKeyInfo format and EncryptedPrivateKeyInfo
  39 format with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms.
  40
  41 =head1 OPTIONS
  42
  43 =over 4
  44
  45 =item B<-help>
  46
  47 Print out a usage message.
  48
  49 =item B<-topk8>
  50
  51 Normally a PKCS#8 private key is expected on input and a private key will be
  52 written to the output file. With the B<-topk8> option the situation is
  53 reversed: it reads a private key and writes a PKCS#8 format key.
  54
  55 =item B<-inform> B<DER>|B<PEM>
  56
  57 This specifies the input format: see L<KEY FORMATS> for more details. The default
  58 format is PEM.
  59
  60 =item B<-outform> B<DER>|B<PEM>
  61
  62 This specifies the output format: see L<KEY FORMATS> for more details. The default
  63 format is PEM.
  64
  65 =item B<-traditional>
  66
  67 When this option is present and B<-topk8> is not a traditional format private
  68 key is written.
  69
  70 =item B<-in> I<filename>
  71
  72 This specifies the input filename to read a key from or standard input if this
  73 option is not specified. If the key is encrypted a pass phrase will be
  74 prompted for.
  75
  76 =item B<-passin> I<arg>, B<-passout> I<arg>
  77
  78 The password source for the input and output file.
  79 For more information about the format of B<arg>
  80 see L<openssl(1)/Pass Phrase Options>.
  81
  82 =item B<-out> I<filename>
  83
  84 This specifies the output filename to write a key to or standard output by
  85 default. If any encryption options are set then a pass phrase will be
  86 prompted for. The output filename should B<not> be the same as the input
  87 filename.
  88
  89 =item B<-iter> I<count>
  90
  91 When creating new PKCS#8 containers, use a given number of iterations on
  92 the password in deriving the encryption key for the PKCS#8 output.
  93 High values increase the time required to brute-force a PKCS#8 container.
  94
  95 =item B<-nocrypt>
  96
  97 PKCS#8 keys generated or input are normally PKCS#8 EncryptedPrivateKeyInfo
  98 structures using an appropriate password based encryption algorithm. With
  99 this option an unencrypted PrivateKeyInfo structure is expected or output.
 100 This option does not encrypt private keys at all and should only be used
 101 when absolutely necessary. Certain software such as some versions of Java
 102 code signing software used unencrypted private keys.
 103
 104 =item B<-rand> I<files>
 105
 106 The files containing random data used to seed the random number generator.
 107 Multiple files can be specified separated by an OS-dependent character.
 108 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
 109 all others.
 110
 111 =item B<-writerand> I<file>
 112
 113 Writes random data to the specified I<file> upon exit.
 114 This can be used with a subsequent B<-rand> flag.
 115
 116 =item B<-v2> I<alg>
 117
 118 This option sets the PKCS#5 v2.0 algorithm.
 119
 120 The I<alg> argument is the encryption algorithm to use, valid values include
 121 B<aes128>, B<aes256> and B<des3>. If this option isn't specified then B<aes256>
 122 is used.
 123
 124 =item B<-v2prf> I<alg>
 125
 126 This option sets the PRF algorithm to use with PKCS#5 v2.0. A typical value
 127 value would be B<hmacWithSHA256>. If this option isn't set then the default
 128 for the cipher is used or B<hmacWithSHA256> if there is no default.
 129
 130 Some implementations may not support custom PRF algorithms and may require
 131 the B<hmacWithSHA1> option to work.
 132
 133 =item B<-v1> I<alg>
 134
 135 This option indicates a PKCS#5 v1.5 or PKCS#12 algorithm should be used.  Some
 136 older implementations may not support PKCS#5 v2.0 and may require this option.
 137 If not specified PKCS#5 v2.0 form is used.
 138
 139 =item B<-engine> I<id>
 140
 141 Specifying an engine (by its unique I<id> string) will cause this command
 142 to attempt to obtain a functional reference to the specified engine,
 143 thus initialising it if needed. The engine will then be set as the default
 144 for all available algorithms.
 145
 146 =item B<-scrypt>
 147
 148 Uses the B<scrypt> algorithm for private key encryption using default
 149 parameters: currently N=16384, r=8 and p=1 and AES in CBC mode with a 256 bit
 150 key. These parameters can be modified using the B<-scrypt_N>, B<-scrypt_r>,
 151 B<-scrypt_p> and B<-v2> options.
 152
 153 =item B<-scrypt_N> I<N>, B<-scrypt_r> I<r>, B<-scrypt_p> I<p>
 154
 155 Sets the scrypt I<N>, I<r> or I<p> parameters.
 156
 157 =back
 158
 159 =head1 KEY FORMATS
 160
 161 Various different formats are used by this command. These are detailed
 162 below.
 163
 164 If a key is being converted from PKCS#8 form (i.e. the B<-topk8> option is
 165 not used) then the input file must be in PKCS#8 format. An encrypted
 166 key is expected unless B<-nocrypt> is included.
 167
 168 If B<-topk8> is not used and B<PEM> mode is set the output file will be an
 169 unencrypted private key in PKCS#8 format. If the B<-traditional> option is
 170 used then a traditional format private key is written instead.
 171
 172 If B<-topk8> is not used and B<DER> mode is set the output file will be an
 173 unencrypted private key in traditional DER format.
 174
 175 If B<-topk8> is used then any supported private key can be used for the input
 176 file in a format specified by B<-inform>. The output file will be encrypted
 177 PKCS#8 format using the specified encryption parameters unless B<-nocrypt>
 178 is included.
 179
 180 =head1 NOTES
 181
 182 By default, when converting a key to PKCS#8 format, PKCS#5 v2.0 using 256 bit
 183 AES with HMAC and SHA256 is used.
 184
 185 Some older implementations do not support PKCS#5 v2.0 format and require
 186 the older PKCS#5 v1.5 form instead, possibly also requiring insecure weak
 187 encryption algorithms such as 56 bit DES.
 188
 189 The encrypted form of a PEM encode PKCS#8 files uses the following
 190 headers and footers:
 191
 192  -----BEGIN ENCRYPTED PRIVATE KEY-----
 193  -----END ENCRYPTED PRIVATE KEY-----
 194
 195 The unencrypted form uses:
 196
 197  -----BEGIN PRIVATE KEY-----
 198  -----END PRIVATE KEY-----
 199
 200 Private keys encrypted using PKCS#5 v2.0 algorithms and high iteration
 201 counts are more secure that those encrypted using the traditional
 202 SSLeay compatible formats. So if additional security is considered
 203 important the keys should be converted.
 204
 205 It is possible to write out DER encoded encrypted private keys in
 206 PKCS#8 format because the encryption details are included at an ASN1
 207 level whereas the traditional format includes them at a PEM level.
 208
 209 =head1 PKCS#5 V1.5 AND PKCS#12 ALGORITHMS
 210
 211 Various algorithms can be used with the B<-v1> command line option,
 212 including PKCS#5 v1.5 and PKCS#12. These are described in more detail
 213 below.
 214
 215 =over 4
 216
 217 =item B<PBE-MD2-DES PBE-MD5-DES>
 218
 219 These algorithms were included in the original PKCS#5 v1.5 specification.
 220 They only offer 56 bits of protection since they both use DES.
 221
 222 =item B<PBE-SHA1-RC2-64>, B<PBE-MD2-RC2-64>, B<PBE-MD5-RC2-64>, B<PBE-SHA1-DES>
 223
 224 These algorithms are not mentioned in the original PKCS#5 v1.5 specification
 225 but they use the same key derivation algorithm and are supported by some
 226 software. They are mentioned in PKCS#5 v2.0. They use either 64 bit RC2 or
 227 56 bit DES.
 228
 229 =item B<PBE-SHA1-RC4-128>, B<PBE-SHA1-RC4-40>, B<PBE-SHA1-3DES>, B<PBE-SHA1-2DES>, B<PBE-SHA1-RC2-128>, B<PBE-SHA1-RC2-40>
 230
 231 These algorithms use the PKCS#12 password based encryption algorithm and
 232 allow strong encryption algorithms like triple DES or 128 bit RC2 to be used.
 233
 234 =back
 235
 236 =head1 EXAMPLES
 237
 238 Convert a private key to PKCS#8 format using default parameters (AES with
 239 256 bit key and B<hmacWithSHA256>):
 240
 241  openssl pkcs8 -in key.pem -topk8 -out enckey.pem
 242
 243 Convert a private key to PKCS#8 unencrypted format:
 244
 245  openssl pkcs8 -in key.pem -topk8 -nocrypt -out enckey.pem
 246
 247 Convert a private key to PKCS#5 v2.0 format using triple DES:
 248
 249  openssl pkcs8 -in key.pem -topk8 -v2 des3 -out enckey.pem
 250
 251 Convert a private key to PKCS#5 v2.0 format using AES with 256 bits in CBC
 252 mode and B<hmacWithSHA512> PRF:
 253
 254  openssl pkcs8 -in key.pem -topk8 -v2 aes-256-cbc -v2prf hmacWithSHA512 -out enckey.pem
 255
 256 Convert a private key to PKCS#8 using a PKCS#5 1.5 compatible algorithm
 257 (DES):
 258
 259  openssl pkcs8 -in key.pem -topk8 -v1 PBE-MD5-DES -out enckey.pem
 260
 261 Convert a private key to PKCS#8 using a PKCS#12 compatible algorithm
 262 (3DES):
 263
 264  openssl pkcs8 -in key.pem -topk8 -out enckey.pem -v1 PBE-SHA1-3DES
 265
 266 Read a DER unencrypted PKCS#8 format private key:
 267
 268  openssl pkcs8 -inform DER -nocrypt -in key.der -out key.pem
 269
 270 Convert a private key from any PKCS#8 encrypted format to traditional format:
 271
 272  openssl pkcs8 -in pk8.pem -traditional -out key.pem
 273
 274 Convert a private key to PKCS#8 format, encrypting with AES-256 and with
 275 one million iterations of the password:
 276
 277  openssl pkcs8 -in key.pem -topk8 -v2 aes-256-cbc -iter 1000000 -out pk8.pem
 278
 279 =head1 STANDARDS
 280
 281 Test vectors from this PKCS#5 v2.0 implementation were posted to the
 282 pkcs-tng mailing list using triple DES, DES and RC2 with high iteration
 283 counts, several people confirmed that they could decrypt the private
 284 keys produced and Therefore it can be assumed that the PKCS#5 v2.0
 285 implementation is reasonably accurate at least as far as these
 286 algorithms are concerned.
 287
 288 The format of PKCS#8 DSA (and other) private keys is not well documented:
 289 it is hidden away in PKCS#11 v2.01, section 11.9. OpenSSL's default DSA
 290 PKCS#8 private key format complies with this standard.
 291
 292 =head1 BUGS
 293
 294 There should be an option that prints out the encryption algorithm
 295 in use and other details such as the iteration count.
 296
 297 =head1 SEE ALSO
 298
 299 L<openssl(1)>,
 300 L<openssl-dsa(1)>,
 301 L<openssl-rsa(1)>,
 302 L<openssl-genrsa(1)>,
 303 L<openssl-gendsa(1)>
 304
 305 =head1 HISTORY
 306
 307 The B<-iter> option was added in OpenSSL 1.1.0.
 308
 309 =head1 COPYRIGHT
 310
 311 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
 312
 313 Licensed under the Apache License 2.0 (the "License").  You may not use
 314 this file except in compliance with the License.  You can obtain a copy
 315 in the file LICENSE in the source distribution or at
 316 L<https://www.openssl.org/source/license.html>.
 317
 318 =cut