1 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
4 /* ====================================================================
5 * Copyright (c) 2005 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. All advertising materials mentioning features or use of this
20 * software must display the following acknowledgment:
21 * "This product includes software developed by the OpenSSL Project
22 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 * endorse or promote products derived from this software without
26 * prior written permission. For written permission, please contact
27 * licensing@OpenSSL.org.
29 * 5. Products derived from this software may not be called "OpenSSL"
30 * nor may "OpenSSL" appear in their names without prior written
31 * permission of the OpenSSL Project.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 * ====================================================================
52 * This product includes cryptographic software written by Eric Young
53 * (eay@cryptsoft.com). This product includes software written by Tim
54 * Hudson (tjh@cryptsoft.com).
58 /* Support for PVK format keys and related structures (such a PUBLICKEYBLOB
59 * and PRIVATEKEYBLOB).
63 #include <openssl/pem.h>
64 #include <openssl/rand.h>
66 /* Utility function: read a DWORD (4 byte unsigned integer) in little endian
70 static unsigned int read_ledword(const unsigned char **in)
72 const unsigned char *p = *in;
82 /* Read a BIGNUM in little endian format. The docs say that this should take up
86 static int read_lebn(const unsigned char **in, unsigned int nbyte, BIGNUM **r)
88 const unsigned char *p;
89 unsigned char *tmpbuf, *q;
92 tmpbuf = OPENSSL_malloc(nbyte);
96 for (i = 0; i < nbyte; i++)
98 *r = BN_bin2bn(tmpbuf, nbyte, NULL);
110 /* Convert private key blob to EVP_PKEY: RSA and DSA keys supported */
112 #define MS_PUBLICKEYBLOB 0x6
113 #define MS_PRIVATEKEYBLOB 0x7
114 #define MS_RSA1MAGIC 0x31415352L
115 #define MS_RSA2MAGIC 0x32415352L
116 #define MS_DSS1MAGIC 0x31535344L
117 #define MS_DSS2MAGIC 0x32535344L
119 #define MS_KEYALG_RSA_KEYX 0xa400
120 #define MS_KEYALG_DSS_SIGN 0x2200
122 #define MS_KEYTYPE_KEYX 0x1
123 #define MS_KEYTYPE_SIGN 0x2
125 /* The PVK file magic number: seems to spell out "bobsfile", who is Bob? */
126 #define MS_PVKMAGIC 0xb0b5f11eL
127 /* Salt length for PVK files */
128 #define PVK_SALTLEN 0x10
130 static EVP_PKEY *b2i_rsa(const unsigned char **in, unsigned int length,
131 unsigned int bitlen, int ispub);
132 static EVP_PKEY *b2i_dss(const unsigned char **in, unsigned int length,
133 unsigned int bitlen, int ispub);
135 static int do_blob_header(const unsigned char **in, unsigned int length,
136 unsigned int *pmagic, unsigned int *pbitlen,
137 int *pisdss, int *pispub)
139 const unsigned char *p = *in;
143 if (*p == MS_PUBLICKEYBLOB)
147 PEMerr(PEM_F_DO_BLOB_HEADER,
148 PEM_R_EXPECTING_PRIVATE_KEY_BLOB);
153 else if (*p == MS_PRIVATEKEYBLOB)
157 PEMerr(PEM_F_DO_BLOB_HEADER,
158 PEM_R_EXPECTING_PUBLIC_KEY_BLOB);
169 PEMerr(PEM_F_DO_BLOB_HEADER, PEM_R_BAD_VERSION_NUMBER);
172 /* Ignore reserved, aiKeyAlg */
174 *pmagic = read_ledword(&p);
175 *pbitlen = read_ledword(&p);
185 PEMerr(PEM_F_DO_BLOB_HEADER,
186 PEM_R_EXPECTING_PRIVATE_KEY_BLOB);
196 PEMerr(PEM_F_DO_BLOB_HEADER,
197 PEM_R_EXPECTING_PUBLIC_KEY_BLOB);
203 PEMerr(PEM_F_DO_BLOB_HEADER, PEM_R_BAD_MAGIC_NUMBER);
210 static unsigned int blob_length(unsigned bitlen, int isdss, int ispub)
212 unsigned int nbyte, hnbyte;
213 nbyte = (bitlen + 7) >> 3;
214 hnbyte = (bitlen + 15) >> 4;
218 /* Expected length: 20 for q + 3 components bitlen each + 24
219 * for seed structure.
222 return 44 + 3 * nbyte;
223 /* Expected length: 20 for q, priv, 2 bitlen components + 24
224 * for seed structure.
227 return 64 + 2 * nbyte;
231 /* Expected length: 4 for 'e' + 'n' */
235 /* Expected length: 4 for 'e' and 7 other components.
236 * 2 components are bitlen size, 5 are bitlen/2
238 return 4 + 2*nbyte + 5*hnbyte;
243 static EVP_PKEY *do_b2i(const unsigned char **in, unsigned int length,
246 const unsigned char *p = *in;
247 unsigned int bitlen, magic;
249 if (do_blob_header(&p, length, &magic, &bitlen, &isdss, &ispub) <= 0)
251 PEMerr(PEM_F_DO_B2I, PEM_R_KEYBLOB_HEADER_PARSE_ERROR);
255 if (length < blob_length(bitlen, isdss, ispub))
257 PEMerr(PEM_F_DO_B2I, PEM_R_KEYBLOB_TOO_SHORT);
261 return b2i_dss(&p, length, bitlen, ispub);
263 return b2i_rsa(&p, length, bitlen, ispub);
266 static EVP_PKEY *do_b2i_bio(BIO *in, int ispub)
268 const unsigned char *p;
269 unsigned char hdr_buf[16], *buf = NULL;
270 unsigned int bitlen, magic, length;
272 EVP_PKEY *ret = NULL;
273 if (BIO_read(in, hdr_buf, 16) != 16)
275 PEMerr(PEM_F_DO_B2I_BIO, PEM_R_KEYBLOB_TOO_SHORT);
279 if (do_blob_header(&p, 16, &magic, &bitlen, &isdss, &ispub) <= 0)
282 length = blob_length(bitlen, isdss, ispub);
283 buf = OPENSSL_malloc(length);
286 PEMerr(PEM_F_DO_B2I_BIO, ERR_R_MALLOC_FAILURE);
290 if (BIO_read(in, buf, length) != (int)length)
292 PEMerr(PEM_F_DO_B2I_BIO, PEM_R_KEYBLOB_TOO_SHORT);
297 ret = b2i_dss(&p, length, bitlen, ispub);
299 ret = b2i_rsa(&p, length, bitlen, ispub);
307 static EVP_PKEY *b2i_dss(const unsigned char **in, unsigned int length,
308 unsigned int bitlen, int ispub)
310 const unsigned char *p = *in;
311 EVP_PKEY *ret = NULL;
315 nbyte = (bitlen + 7) >> 3;
318 ret = EVP_PKEY_new();
321 if (!read_lebn(&p, nbyte, &dsa->p))
323 if (!read_lebn(&p, 20, &dsa->q))
325 if (!read_lebn(&p, nbyte, &dsa->g))
329 if (!read_lebn(&p, nbyte, &dsa->pub_key))
334 if (!read_lebn(&p, 20, &dsa->priv_key))
336 /* Calculate public key */
337 if (!(dsa->pub_key = BN_new()))
339 if (!(ctx = BN_CTX_new()))
342 if (!BN_mod_exp(dsa->pub_key, dsa->g,
343 dsa->priv_key, dsa->p, ctx))
349 EVP_PKEY_set1_DSA(ret, dsa);
355 PEMerr(PEM_F_B2I_DSS, ERR_R_MALLOC_FAILURE);
365 static EVP_PKEY *b2i_rsa(const unsigned char **in, unsigned int length,
366 unsigned int bitlen, int ispub)
369 const unsigned char *p = *in;
370 EVP_PKEY *ret = NULL;
372 unsigned int nbyte, hnbyte;
373 nbyte = (bitlen + 7) >> 3;
374 hnbyte = (bitlen + 15) >> 4;
376 ret = EVP_PKEY_new();
382 if (!BN_set_word(rsa->e, read_ledword(&p)))
384 if (!read_lebn(&p, nbyte, &rsa->n))
388 if (!read_lebn(&p, hnbyte, &rsa->p))
390 if (!read_lebn(&p, hnbyte, &rsa->q))
392 if (!read_lebn(&p, hnbyte, &rsa->dmp1))
394 if (!read_lebn(&p, hnbyte, &rsa->dmq1))
396 if (!read_lebn(&p, hnbyte, &rsa->iqmp))
398 if (!read_lebn(&p, nbyte, &rsa->d))
402 EVP_PKEY_set1_RSA(ret, rsa);
407 PEMerr(PEM_F_B2I_RSA, ERR_R_MALLOC_FAILURE);
415 EVP_PKEY *b2i_PrivateKey(const unsigned char **in, long length)
417 return do_b2i(in, length, 0);
420 EVP_PKEY *b2i_PublicKey(const unsigned char **in, long length)
422 return do_b2i(in, length, 1);
426 EVP_PKEY *b2i_PrivateKey_bio(BIO *in)
428 return do_b2i_bio(in, 0);
431 EVP_PKEY *b2i_PublicKey_bio(BIO *in)
433 return do_b2i_bio(in, 1);
436 static void write_ledword(unsigned char **out, unsigned int dw)
438 unsigned char *p = *out;
440 *p++ = (dw>>8) & 0xff;
441 *p++ = (dw>>16) & 0xff;
442 *p++ = (dw>>24) & 0xff;
446 static void write_lebn(unsigned char **out, const BIGNUM *bn, int len)
449 unsigned char *p = *out, *q, c;
450 nb = BN_num_bytes(bn);
453 /* In place byte order reversal */
454 for (i = 0; i < nb/2; i++)
461 /* Pad with zeroes if we have to */
467 memset(*out, 0, len);
474 static int check_bitlen_rsa(RSA *rsa, int ispub, unsigned int *magic);
475 static int check_bitlen_dsa(DSA *dsa, int ispub, unsigned int *magic);
477 static void write_rsa(unsigned char **out, RSA *rsa, int ispub);
478 static void write_dsa(unsigned char **out, DSA *dsa, int ispub);
480 static int do_i2b(unsigned char **out, EVP_PKEY *pk, int ispub)
483 unsigned int bitlen, magic = 0, keyalg;
484 int outlen, noinc = 0;
485 if (pk->type == EVP_PKEY_DSA)
487 bitlen = check_bitlen_dsa(pk->pkey.dsa, ispub, &magic);
488 keyalg = MS_KEYALG_DSS_SIGN;
490 else if (pk->type == EVP_PKEY_RSA)
492 bitlen = check_bitlen_rsa(pk->pkey.rsa, ispub, &magic);
493 keyalg = MS_KEYALG_RSA_KEYX;
499 outlen = 16 + blob_length(bitlen,
500 keyalg == MS_KEYALG_DSS_SIGN ? 1 : 0, ispub);
507 p = OPENSSL_malloc(outlen);
514 *p++ = MS_PUBLICKEYBLOB;
516 *p++ = MS_PRIVATEKEYBLOB;
520 write_ledword(&p, keyalg);
521 write_ledword(&p, magic);
522 write_ledword(&p, bitlen);
523 if (keyalg == MS_KEYALG_DSS_SIGN)
524 write_dsa(&p, pk->pkey.dsa, ispub);
526 write_rsa(&p, pk->pkey.rsa, ispub);
532 static int do_i2b_bio(BIO *out, EVP_PKEY *pk, int ispub)
534 unsigned char *tmp = NULL;
536 outlen = do_i2b(&tmp, pk, ispub);
539 wrlen = BIO_write(out, tmp, outlen);
546 static int check_bitlen_dsa(DSA *dsa, int ispub, unsigned int *pmagic)
549 bitlen = BN_num_bits(dsa->p);
550 if ((bitlen & 7) || (BN_num_bits(dsa->q) != 160)
551 || (BN_num_bits(dsa->g) > bitlen))
555 if (BN_num_bits(dsa->pub_key) > bitlen)
557 *pmagic = MS_DSS1MAGIC;
561 if (BN_num_bits(dsa->priv_key) > 160)
563 *pmagic = MS_DSS2MAGIC;
568 PEMerr(PEM_F_CHECK_BITLEN_DSA, PEM_R_UNSUPPORTED_KEY_COMPONENTS);
572 static int check_bitlen_rsa(RSA *rsa, int ispub, unsigned int *pmagic)
574 int nbyte, hnbyte, bitlen;
575 if (BN_num_bits(rsa->e) > 32)
577 bitlen = BN_num_bits(rsa->n);
578 nbyte = BN_num_bytes(rsa->n);
579 hnbyte = (BN_num_bits(rsa->n) + 15) >> 4;
582 *pmagic = MS_RSA1MAGIC;
587 *pmagic = MS_RSA2MAGIC;
588 /* For private key each component must fit within nbyte or
591 if (BN_num_bytes(rsa->d) > nbyte)
593 if ((BN_num_bytes(rsa->iqmp) > hnbyte)
594 || (BN_num_bytes(rsa->p) > hnbyte)
595 || (BN_num_bytes(rsa->q) > hnbyte)
596 || (BN_num_bytes(rsa->dmp1) > hnbyte)
597 || (BN_num_bytes(rsa->dmq1) > hnbyte))
602 PEMerr(PEM_F_CHECK_BITLEN_RSA, PEM_R_UNSUPPORTED_KEY_COMPONENTS);
607 static void write_rsa(unsigned char **out, RSA *rsa, int ispub)
610 nbyte = BN_num_bytes(rsa->n);
611 hnbyte = (BN_num_bits(rsa->n) + 15) >> 4;
612 write_lebn(out, rsa->e, 4);
613 write_lebn(out, rsa->n, -1);
616 write_lebn(out, rsa->p, hnbyte);
617 write_lebn(out, rsa->q, hnbyte);
618 write_lebn(out, rsa->dmp1, hnbyte);
619 write_lebn(out, rsa->dmq1, hnbyte);
620 write_lebn(out, rsa->iqmp, hnbyte);
621 write_lebn(out, rsa->d, nbyte);
625 static void write_dsa(unsigned char **out, DSA *dsa, int ispub)
628 nbyte = BN_num_bytes(dsa->p);
629 write_lebn(out, dsa->p, nbyte);
630 write_lebn(out, dsa->q, 20);
631 write_lebn(out, dsa->g, nbyte);
633 write_lebn(out, dsa->pub_key, nbyte);
635 write_lebn(out, dsa->priv_key, 20);
636 /* Set "invalid" for seed structure values */
637 memset(*out, 0xff, 24);
643 int i2b_PrivateKey_bio(BIO *out, EVP_PKEY *pk)
645 return do_i2b_bio(out, pk, 0);
648 int i2b_PublicKey_bio(BIO *out, EVP_PKEY *pk)
650 return do_i2b_bio(out, pk, 1);
653 static int do_PVK_header(const unsigned char **in, unsigned int length,
655 unsigned int *psaltlen, unsigned int *pkeylen)
658 const unsigned char *p = *in;
659 unsigned int pvk_magic, keytype, is_encrypted;
664 PEMerr(PEM_F_DO_PVK_HEADER, PEM_R_PVK_TOO_SHORT);
673 PEMerr(PEM_F_DO_PVK_HEADER, PEM_R_PVK_TOO_SHORT);
677 pvk_magic = read_ledword(&p);
678 if (pvk_magic != MS_PVKMAGIC)
680 PEMerr(PEM_F_DO_PVK_HEADER, PEM_R_BAD_MAGIC_NUMBER);
686 keytype = read_ledword(&p);
687 is_encrypted = read_ledword(&p);
688 *psaltlen = read_ledword(&p);
689 *pkeylen = read_ledword(&p);
691 if (is_encrypted && !*psaltlen)
693 PEMerr(PEM_F_DO_PVK_HEADER, PEM_R_INCONSISTENT_HEADER);
701 static int derive_pvk_key(unsigned char *key,
702 const unsigned char *salt, unsigned int saltlen,
703 const unsigned char *pass, int passlen)
706 EVP_MD_CTX_init(&mctx);
707 EVP_DigestInit_ex(&mctx, EVP_sha1(), NULL);
708 EVP_DigestUpdate(&mctx, salt, saltlen);
709 EVP_DigestUpdate(&mctx, pass, passlen);
710 EVP_DigestFinal_ex(&mctx, key, NULL);
711 EVP_MD_CTX_cleanup(&mctx);
716 static EVP_PKEY *do_PVK_body(const unsigned char **in,
717 unsigned int saltlen, unsigned int keylen,
718 pem_password_cb *cb, void *u)
720 EVP_PKEY *ret = NULL;
721 const unsigned char *p = *in;
723 unsigned char *enctmp = NULL, *q;
726 char psbuf[PEM_BUFSIZE];
727 unsigned char keybuf[20];
729 int enctmplen, inlen;
731 inlen=cb(psbuf,PEM_BUFSIZE,0,u);
733 inlen=PEM_def_callback(psbuf,PEM_BUFSIZE,0,u);
736 PEMerr(PEM_F_DO_PVK_BODY,PEM_R_BAD_PASSWORD_READ);
739 enctmp = OPENSSL_malloc(keylen + 8);
742 PEMerr(PEM_F_DO_PVK_BODY, ERR_R_MALLOC_FAILURE);
745 if (!derive_pvk_key(keybuf, p, saltlen,
746 (unsigned char *)psbuf, inlen))
749 /* Copy BLOBHEADER across, decrypt rest */
750 memcpy(enctmp, p, 8);
754 EVP_CIPHER_CTX_init(&cctx);
755 EVP_DecryptInit_ex(&cctx, EVP_rc4(), NULL, keybuf, NULL);
756 EVP_DecryptUpdate(&cctx, q, &enctmplen, p, inlen);
757 EVP_DecryptFinal_ex(&cctx, q + enctmplen, &enctmplen);
758 magic = read_ledword((const unsigned char **)&q);
759 if (magic != MS_RSA2MAGIC && magic != MS_DSS2MAGIC)
762 memset(keybuf + 5, 0, 11);
763 EVP_DecryptInit_ex(&cctx, EVP_rc4(), NULL, keybuf,
765 OPENSSL_cleanse(keybuf, 20);
766 EVP_DecryptUpdate(&cctx, q, &enctmplen, p, inlen);
767 EVP_DecryptFinal_ex(&cctx, q + enctmplen,
769 magic = read_ledword((const unsigned char **)&q);
770 if (magic != MS_RSA2MAGIC && magic != MS_DSS2MAGIC)
772 EVP_CIPHER_CTX_cleanup(&cctx);
773 PEMerr(PEM_F_DO_PVK_BODY, PEM_R_BAD_DECRYPT);
778 OPENSSL_cleanse(keybuf, 20);
779 EVP_CIPHER_CTX_cleanup(&cctx);
783 ret = b2i_PrivateKey(&p, keylen);
785 if (enctmp && saltlen)
786 OPENSSL_free(enctmp);
791 EVP_PKEY *b2i_PVK_bio(BIO *in, pem_password_cb *cb, void *u)
793 unsigned char pvk_hdr[24], *buf = NULL;
794 const unsigned char *p;
796 EVP_PKEY *ret = NULL;
797 unsigned int saltlen, keylen;
798 if (BIO_read(in, pvk_hdr, 24) != 24)
800 PEMerr(PEM_F_B2I_PVK_BIO, PEM_R_PVK_DATA_TOO_SHORT);
805 if (!do_PVK_header(&p, 24, 0, &saltlen, &keylen))
807 buflen = (int) keylen + saltlen;
808 buf = OPENSSL_malloc(buflen);
811 PEMerr(PEM_F_B2I_PVK_BIO, ERR_R_MALLOC_FAILURE);
815 if (BIO_read(in, buf, buflen) != buflen)
817 PEMerr(PEM_F_B2I_PVK_BIO, PEM_R_PVK_DATA_TOO_SHORT);
820 ret = do_PVK_body(&p, saltlen, keylen, cb, u);
825 OPENSSL_cleanse(buf, buflen);
833 static int i2b_PVK(unsigned char **out, EVP_PKEY*pk, int enclevel,
834 pem_password_cb *cb, void *u)
836 int outlen = 24, noinc, pklen;
837 unsigned char *p, *salt = NULL;
839 outlen += PVK_SALTLEN;
840 pklen = do_i2b(NULL, pk, 0);
853 p = OPENSSL_malloc(outlen);
856 PEMerr(PEM_F_I2B_PVK,ERR_R_MALLOC_FAILURE);
863 write_ledword(&p, MS_PVKMAGIC);
864 write_ledword(&p, 0);
865 if (pk->type == EVP_PKEY_DSA)
866 write_ledword(&p, MS_KEYTYPE_SIGN);
868 write_ledword(&p, MS_KEYTYPE_KEYX);
869 write_ledword(&p, enclevel ? 1 : 0);
870 write_ledword(&p, enclevel ? PVK_SALTLEN: 0);
871 write_ledword(&p, pklen);
874 if (RAND_bytes(p, PVK_SALTLEN) <= 0)
884 char psbuf[PEM_BUFSIZE];
885 unsigned char keybuf[20];
887 int enctmplen, inlen;
889 inlen=cb(psbuf,PEM_BUFSIZE,1,u);
891 inlen=PEM_def_callback(psbuf,PEM_BUFSIZE,1,u);
894 PEMerr(PEM_F_I2B_PVK,PEM_R_BAD_PASSWORD_READ);
897 if (!derive_pvk_key(keybuf, salt, PVK_SALTLEN,
898 (unsigned char *)psbuf, inlen))
901 memset(keybuf + 5, 0, 11);
902 p = salt + PVK_SALTLEN + 8;
903 EVP_CIPHER_CTX_init(&cctx);
904 EVP_EncryptInit_ex(&cctx, EVP_rc4(), NULL, keybuf, NULL);
905 OPENSSL_cleanse(keybuf, 20);
906 EVP_DecryptUpdate(&cctx, p, &enctmplen, p, pklen - 8);
907 EVP_DecryptFinal_ex(&cctx, p + enctmplen, &enctmplen);
908 EVP_CIPHER_CTX_cleanup(&cctx);
916 int i2b_PVK_bio(BIO *out, EVP_PKEY *pk, int enclevel,
917 pem_password_cb *cb, void *u)
919 unsigned char *tmp = NULL;
921 outlen = i2b_PVK(&tmp, pk, enclevel, cb, u);
924 wrlen = BIO_write(out, tmp, outlen);
928 PEMerr(PEM_F_I2B_PVK_BIO, PEM_R_BIO_WRITE_FAILURE);