1227825Stheraven=pod 2227825Stheraven 3227825Stheraven=head1 NAME 4227825Stheraven 5227825Stheravenpkcs8 - PKCS#8 format private key conversion tool 6227825Stheraven 7227825Stheraven=head1 SYNOPSIS 8227825Stheraven 9227825StheravenB<openssl> B<pkcs8> 10227825Stheraven[B<-topk8>] 11227825Stheraven[B<-inform PEM|DER>] 12227825Stheraven[B<-outform PEM|DER>] 13227825Stheraven[B<-in filename>] 14227825Stheraven[B<-passin arg>] 15227825Stheraven[B<-out filename>] 16227825Stheraven[B<-passout arg>] 17227825Stheraven[B<-noiter>] 18227825Stheraven[B<-nocrypt>] 19227825Stheraven[B<-nooct>] 20227825Stheraven[B<-embed>] 21227825Stheraven[B<-nsdb>] 22227825Stheraven[B<-v2 alg>] 23227825Stheraven[B<-v1 alg>] 24227825Stheraven[B<-engine id>] 25227825Stheraven 26227825Stheraven=head1 DESCRIPTION 27227825Stheraven 28227825StheravenThe B<pkcs8> command processes private keys in PKCS#8 format. It can handle 29227825Stheravenboth unencrypted PKCS#8 PrivateKeyInfo format and EncryptedPrivateKeyInfo 30227825Stheravenformat with a variety of PKCS#5 (v1.5 and v2.0) and PKCS#12 algorithms. 31227825Stheraven 32227825Stheraven=head1 COMMAND OPTIONS 33227825Stheraven 34227825Stheraven=over 4 35227825Stheraven 36227825Stheraven=item B<-topk8> 37232950Stheraven 38227825StheravenNormally a PKCS#8 private key is expected on input and a traditional format 39227825Stheravenprivate key will be written. With the B<-topk8> option the situation is 40227825Stheravenreversed: it reads a traditional format private key and writes a PKCS#8 41227825Stheravenformat key. 42227825Stheraven 43227825Stheraven=item B<-inform DER|PEM> 44227825Stheraven 45227825StheravenThis specifies the input format. If a PKCS#8 format key is expected on input 46227825Stheraventhen either a B<DER> or B<PEM> encoded version of a PKCS#8 key will be 47227825Stheravenexpected. Otherwise the B<DER> or B<PEM> format of the traditional format 48227825Stheravenprivate key is used. 49227825Stheraven 50227825Stheraven=item B<-outform DER|PEM> 51227825Stheraven 52227825StheravenThis specifies the output format, the options have the same meaning as the 53227825StheravenB<-inform> option. 54227825Stheraven 55227825Stheraven=item B<-in filename> 56227825Stheraven 57227825StheravenThis specifies the input filename to read a key from or standard input if this 58227825Stheravenoption is not specified. If the key is encrypted a pass phrase will be 59227825Stheravenprompted for. 60227825Stheraven 61227825Stheraven=item B<-passin arg> 62227825Stheraven 63227825Stheraventhe input file password source. For more information about the format of B<arg> 64227825Stheravensee the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>. 65227825Stheraven 66227825Stheraven=item B<-out filename> 67227825Stheraven 68227825StheravenThis specifies the output filename to write a key to or standard output by 69227825Stheravendefault. If any encryption options are set then a pass phrase will be 70227825Stheravenprompted for. The output filename should B<not> be the same as the input 71227825Stheravenfilename. 72227825Stheraven 73227825Stheraven=item B<-passout arg> 74227825Stheraven 75227825Stheraventhe output file password source. For more information about the format of B<arg> 76227825Stheravensee the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>. 77227825Stheraven 78227825Stheraven=item B<-nocrypt> 79227825Stheraven 80227825StheravenPKCS#8 keys generated or input are normally PKCS#8 EncryptedPrivateKeyInfo 81227825Stheravenstructures using an appropriate password based encryption algorithm. With 82227825Stheraventhis option an unencrypted PrivateKeyInfo structure is expected or output. 83227825StheravenThis option does not encrypt private keys at all and should only be used 84227825Stheravenwhen absolutely necessary. Certain software such as some versions of Java 85227825Stheravencode signing software used unencrypted private keys. 86227825Stheraven 87227825Stheraven=item B<-nooct> 88227825Stheraven 89227825StheravenThis option generates RSA private keys in a broken format that some software 90227825Stheravenuses. Specifically the private key should be enclosed in a OCTET STRING 91227825Stheravenbut some software just includes the structure itself without the 92227825Stheravensurrounding OCTET STRING. 93227825Stheraven 94227825Stheraven=item B<-embed> 95227825Stheraven 96227825StheravenThis option generates DSA keys in a broken format. The DSA parameters are 97227825Stheravenembedded inside the PrivateKey structure. In this form the OCTET STRING 98227825Stheravencontains an ASN1 SEQUENCE consisting of two structures: a SEQUENCE containing 99227825Stheraventhe parameters and an ASN1 INTEGER containing the private key. 100227825Stheraven 101227825Stheraven=item B<-nsdb> 102227825Stheraven 103227825StheravenThis option generates DSA keys in a broken format compatible with Netscape 104227825Stheravenprivate key databases. The PrivateKey contains a SEQUENCE consisting of 105227825Stheraventhe public and private keys respectively. 106227825Stheraven 107227825Stheraven=item B<-v2 alg> 108227825Stheraven 109227825StheravenThis option enables the use of PKCS#5 v2.0 algorithms. Normally PKCS#8 110227825Stheravenprivate keys are encrypted with the password based encryption algorithm 111227825Stheravencalled B<pbeWithMD5AndDES-CBC> this uses 56 bit DES encryption but it 112227825Stheravenwas the strongest encryption algorithm supported in PKCS#5 v1.5. Using 113227825Stheraventhe B<-v2> option PKCS#5 v2.0 algorithms are used which can use any 114227825Stheravenencryption algorithm such as 168 bit triple DES or 128 bit RC2 however 115227825Stheravennot many implementations support PKCS#5 v2.0 yet. If you are just using 116227825Stheravenprivate keys with OpenSSL then this doesn't matter. 117227825Stheraven 118227825StheravenThe B<alg> argument is the encryption algorithm to use, valid values include 119227825StheravenB<des>, B<des3> and B<rc2>. It is recommended that B<des3> is used. 120227825Stheraven 121227825Stheraven=item B<-v1 alg> 122227825Stheraven 123227825StheravenThis option specifies a PKCS#5 v1.5 or PKCS#12 algorithm to use. A complete 124227825Stheravenlist of possible algorithms is included below. 125227825Stheraven 126227825Stheraven=item B<-engine id> 127227825Stheraven 128227825Stheravenspecifying an engine (by its unique B<id> string) will cause B<pkcs8> 129227825Stheravento attempt to obtain a functional reference to the specified engine, 130227825Stheraventhus initialising it if needed. The engine will then be set as the default 131227825Stheravenfor all available algorithms. 132227825Stheraven 133227825Stheraven=back 134227825Stheraven 135227825Stheraven=head1 NOTES 136227825Stheraven 137227825StheravenThe encrypted form of a PEM encode PKCS#8 files uses the following 138227825Stheravenheaders and footers: 139227825Stheraven 140227825Stheraven -----BEGIN ENCRYPTED PRIVATE KEY----- 141227825Stheraven -----END ENCRYPTED PRIVATE KEY----- 142227825Stheraven 143227825StheravenThe unencrypted form uses: 144227825Stheraven 145227825Stheraven -----BEGIN PRIVATE KEY----- 146227825Stheraven -----END PRIVATE KEY----- 147227825Stheraven 148227825StheravenPrivate keys encrypted using PKCS#5 v2.0 algorithms and high iteration 149227825Stheravencounts are more secure that those encrypted using the traditional 150227825StheravenSSLeay compatible formats. So if additional security is considered 151227825Stheravenimportant the keys should be converted. 152227825Stheraven 153227825StheravenThe default encryption is only 56 bits because this is the encryption 154227825Stheraventhat most current implementations of PKCS#8 will support. 155227825Stheraven 156227825StheravenSome software may use PKCS#12 password based encryption algorithms 157227825Stheravenwith PKCS#8 format private keys: these are handled automatically 158227825Stheravenbut there is no option to produce them. 159227825Stheraven 160227825StheravenIt is possible to write out DER encoded encrypted private keys in 161227825StheravenPKCS#8 format because the encryption details are included at an ASN1 162227825Stheravenlevel whereas the traditional format includes them at a PEM level. 163232950Stheraven 164227825Stheraven=head1 PKCS#5 v1.5 and PKCS#12 algorithms. 165227825Stheraven 166227825StheravenVarious algorithms can be used with the B<-v1> command line option, 167227825Stheravenincluding PKCS#5 v1.5 and PKCS#12. These are described in more detail 168232950Stheravenbelow. 169227825Stheraven 170227825Stheraven=over 4 171227825Stheraven 172227825Stheraven=item B<PBE-MD2-DES PBE-MD5-DES> 173227825Stheraven 174227825StheravenThese algorithms were included in the original PKCS#5 v1.5 specification. 175227825StheravenThey only offer 56 bits of protection since they both use DES. 176227825Stheraven 177227825Stheraven=item B<PBE-SHA1-RC2-64 PBE-MD2-RC2-64 PBE-MD5-RC2-64 PBE-SHA1-DES> 178227825Stheraven 179227825StheravenThese algorithms are not mentioned in the original PKCS#5 v1.5 specification 180227825Stheravenbut they use the same key derivation algorithm and are supported by some 181227825Stheravensoftware. They are mentioned in PKCS#5 v2.0. They use either 64 bit RC2 or 182232950Stheraven56 bit DES. 183227825Stheraven 184227825Stheraven=item B<PBE-SHA1-RC4-128 PBE-SHA1-RC4-40 PBE-SHA1-3DES PBE-SHA1-2DES PBE-SHA1-RC2-128 PBE-SHA1-RC2-40> 185227825Stheraven 186227825StheravenThese algorithms use the PKCS#12 password based encryption algorithm and 187227825Stheravenallow strong encryption algorithms like triple DES or 128 bit RC2 to be used. 188227825Stheraven 189227825Stheraven=back 190227825Stheraven 191227825Stheraven=head1 EXAMPLES 192227825Stheraven 193227825StheravenConvert a private from traditional to PKCS#5 v2.0 format using triple 194227825StheravenDES: 195227825Stheraven 196227825Stheraven openssl pkcs8 -in key.pem -topk8 -v2 des3 -out enckey.pem 197227825Stheraven 198227825StheravenConvert a private key to PKCS#8 using a PKCS#5 1.5 compatible algorithm 199227825Stheraven(DES): 200227825Stheraven 201227825Stheraven openssl pkcs8 -in key.pem -topk8 -out enckey.pem 202227825Stheraven 203227825StheravenConvert a private key to PKCS#8 using a PKCS#12 compatible algorithm 204227825Stheraven(3DES): 205227825Stheraven 206227825Stheraven openssl pkcs8 -in key.pem -topk8 -out enckey.pem -v1 PBE-SHA1-3DES 207227825Stheraven 208227825StheravenRead a DER unencrypted PKCS#8 format private key: 209227825Stheraven 210227825Stheraven openssl pkcs8 -inform DER -nocrypt -in key.der -out key.pem 211227825Stheraven 212227825StheravenConvert a private key from any PKCS#8 format to traditional format: 213227825Stheraven 214227825Stheraven openssl pkcs8 -in pk8.pem -out key.pem 215227825Stheraven 216227825Stheraven=head1 STANDARDS 217227825Stheraven 218227825StheravenTest vectors from this PKCS#5 v2.0 implementation were posted to the 219227825Stheravenpkcs-tng mailing list using triple DES, DES and RC2 with high iteration 220227825Stheravencounts, several people confirmed that they could decrypt the private 221227825Stheravenkeys produced and Therefore it can be assumed that the PKCS#5 v2.0 222227825Stheravenimplementation is reasonably accurate at least as far as these 223227825Stheravenalgorithms are concerned. 224227825Stheraven 225227825StheravenThe format of PKCS#8 DSA (and other) private keys is not well documented: 226227825Stheravenit is hidden away in PKCS#11 v2.01, section 11.9. OpenSSL's default DSA 227227825StheravenPKCS#8 private key format complies with this standard. 228227825Stheraven 229227825Stheraven=head1 BUGS 230227825Stheraven 231227825StheravenThere should be an option that prints out the encryption algorithm 232227825Stheravenin use and other details such as the iteration count. 233227825Stheraven 234227825StheravenPKCS#8 using triple DES and PKCS#5 v2.0 should be the default private 235227825Stheravenkey format for OpenSSL: for compatibility several of the utilities use 236227825Stheraventhe old format at present. 237227825Stheraven 238227825Stheraven=head1 SEE ALSO 239227825Stheraven 240227825StheravenL<dsa(1)|dsa(1)>, L<rsa(1)|rsa(1)>, L<genrsa(1)|genrsa(1)>, 241227825StheravenL<gendsa(1)|gendsa(1)> 242227825Stheraven 243227825Stheraven=cut 244227825Stheraven