2 /* Written by Dr Stephen N Henson (shenson@bigfoot.com) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 1999-2002 The OpenSSL Project. All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
20 * 3. All advertising materials mentioning features or use of this
21 * software must display the following acknowledgment:
22 * "This product includes software developed by the OpenSSL Project
23 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26 * endorse or promote products derived from this software without
27 * prior written permission. For written permission, please contact
28 * licensing@OpenSSL.org.
30 * 5. Products derived from this software may not be called "OpenSSL"
31 * nor may "OpenSSL" appear in their names without prior written
32 * permission of the OpenSSL Project.
34 * 6. Redistributions of any form whatsoever must retain the following
36 * "This product includes software developed by the OpenSSL Project
37 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
43 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50 * OF THE POSSIBILITY OF SUCH DAMAGE.
51 * ====================================================================
53 * This product includes cryptographic software written by Eric Young
54 * (eay@cryptsoft.com). This product includes software written by Tim
55 * Hudson (tjh@cryptsoft.com).
62 #include <openssl/x509.h>
63 #include <openssl/rand.h>
64 #include <openssl/rsa.h>
65 #include <openssl/dsa.h>
67 #ifndef OPENSSL_NO_DSA
68 static int dsa_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8inf, EVP_PKEY *pkey);
71 static int eckey_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8inf, EVP_PKEY *pkey);
74 /* Extract a private key from a PKCS8 structure */
76 EVP_PKEY *EVP_PKCS82PKEY (PKCS8_PRIV_KEY_INFO *p8)
78 EVP_PKEY *pkey = NULL;
79 #ifndef OPENSSL_NO_RSA
82 #ifndef OPENSSL_NO_DSA
85 ASN1_INTEGER *privkey;
86 STACK_OF(ASN1_TYPE) *ndsa = NULL;
90 const unsigned char *p_tmp;
92 #if !defined(OPENSSL_NO_DSA) || !defined(OPENSSL_NO_EC)
93 ASN1_TYPE *param = NULL;
98 const unsigned char *p;
99 const unsigned char *cp;
104 if(p8->pkey->type == V_ASN1_OCTET_STRING) {
105 p8->broken = PKCS8_OK;
106 p = p8->pkey->value.octet_string->data;
107 pkeylen = p8->pkey->value.octet_string->length;
109 p8->broken = PKCS8_NO_OCTET;
110 p = p8->pkey->value.sequence->data;
111 pkeylen = p8->pkey->value.sequence->length;
113 if (!(pkey = EVP_PKEY_new())) {
114 EVPerr(EVP_F_EVP_PKCS82PKEY,ERR_R_MALLOC_FAILURE);
118 nid = OBJ_obj2nid(a->algorithm);
121 #ifndef OPENSSL_NO_RSA
122 case NID_rsaEncryption:
124 if (!(rsa = d2i_RSAPrivateKey (NULL,&cp, pkeylen))) {
125 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
128 EVP_PKEY_assign_RSA (pkey, rsa);
131 #ifndef OPENSSL_NO_DSA
133 /* PKCS#8 DSA is weird: you just get a private key integer
134 * and parameters in the AlgorithmIdentifier the pubkey must
138 /* Check for broken DSA PKCS#8, UGH! */
139 if(*p == (V_ASN1_SEQUENCE|V_ASN1_CONSTRUCTED)) {
140 if(!(ndsa = ASN1_seq_unpack_ASN1_TYPE(p, pkeylen,
143 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
146 if(sk_ASN1_TYPE_num(ndsa) != 2 ) {
147 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
150 /* Handle Two broken types:
151 * SEQUENCE {parameters, priv_key}
152 * SEQUENCE {pub_key, priv_key}
155 t1 = sk_ASN1_TYPE_value(ndsa, 0);
156 t2 = sk_ASN1_TYPE_value(ndsa, 1);
157 if(t1->type == V_ASN1_SEQUENCE) {
158 p8->broken = PKCS8_EMBEDDED_PARAM;
160 } else if(a->parameter->type == V_ASN1_SEQUENCE) {
161 p8->broken = PKCS8_NS_DB;
162 param = a->parameter;
164 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
168 if(t2->type != V_ASN1_INTEGER) {
169 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
172 privkey = t2->value.integer;
174 if (!(privkey=d2i_ASN1_INTEGER (NULL, &p, pkeylen))) {
175 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
178 param = p8->pkeyalg->parameter;
180 if (!param || (param->type != V_ASN1_SEQUENCE)) {
181 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
184 cp = p = param->value.sequence->data;
185 plen = param->value.sequence->length;
186 if (!(dsa = d2i_DSAparams (NULL, &cp, plen))) {
187 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
190 /* We have parameters now set private key */
191 if (!(dsa->priv_key = ASN1_INTEGER_to_BN(privkey, NULL))) {
192 EVPerr(EVP_F_EVP_PKCS82PKEY,EVP_R_BN_DECODE_ERROR);
195 /* Calculate public key (ouch!) */
196 if (!(dsa->pub_key = BN_new())) {
197 EVPerr(EVP_F_EVP_PKCS82PKEY,ERR_R_MALLOC_FAILURE);
200 if (!(ctx = BN_CTX_new())) {
201 EVPerr(EVP_F_EVP_PKCS82PKEY,ERR_R_MALLOC_FAILURE);
205 if (!BN_mod_exp(dsa->pub_key, dsa->g,
206 dsa->priv_key, dsa->p, ctx)) {
208 EVPerr(EVP_F_EVP_PKCS82PKEY,EVP_R_BN_PUBKEY_ERROR);
212 EVP_PKEY_assign_DSA(pkey, dsa);
214 if(ndsa) sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
215 else ASN1_INTEGER_free(privkey);
219 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
225 #ifndef OPENSSL_NO_EC
226 case NID_X9_62_id_ecPublicKey:
228 /* extract the ec parameters */
229 param = p8->pkeyalg->parameter;
231 if (!param || ((param->type != V_ASN1_SEQUENCE) &&
232 (param->type != V_ASN1_OBJECT)))
234 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
238 if (param->type == V_ASN1_SEQUENCE)
240 cp = p = param->value.sequence->data;
241 plen = param->value.sequence->length;
243 if (!(eckey = d2i_ECParameters(NULL, &cp, plen)))
245 EVPerr(EVP_F_EVP_PKCS82PKEY,
252 cp = p = param->value.object->data;
253 plen = param->value.object->length;
255 /* type == V_ASN1_OBJECT => the parameters are given
258 if ((eckey = EC_KEY_new()) == NULL)
260 EVPerr(EVP_F_EVP_PKCS82PKEY,
261 ERR_R_MALLOC_FAILURE);
264 if ((eckey->group = EC_GROUP_new_by_nid(
265 OBJ_obj2nid(a->parameter->value.object))) == NULL)
267 EC_GROUP_set_asn1_flag(eckey->group,
268 OPENSSL_EC_NAMED_CURVE);
271 /* We have parameters now set private key */
272 if (!d2i_ECPrivateKey(&eckey, &p_tmp, pkeylen))
274 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
278 /* calculate public key (if necessary) */
281 /* the public key was not included in the SEC1 private
282 * key => calculate the public key */
283 eckey->pub_key = EC_POINT_new(eckey->group);
286 EVPerr(EVP_F_EVP_PKCS82PKEY, ERR_R_EC_LIB);
289 if (!EC_POINT_copy(eckey->pub_key,
290 EC_GROUP_get0_generator(eckey->group)))
292 EVPerr(EVP_F_EVP_PKCS82PKEY, ERR_R_EC_LIB);
295 if (!EC_POINT_mul(eckey->group, eckey->pub_key,
296 eckey->priv_key, NULL, NULL, ctx))
298 EVPerr(EVP_F_EVP_PKCS82PKEY, ERR_R_EC_LIB);
303 EVP_PKEY_assign_EC_KEY(pkey, eckey);
317 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM);
318 if (!a->algorithm) BUF_strlcpy (obj_tmp, "NULL", sizeof obj_tmp);
319 else i2t_ASN1_OBJECT(obj_tmp, 80, a->algorithm);
320 ERR_add_error_data(2, "TYPE=", obj_tmp);
321 EVP_PKEY_free (pkey);
327 PKCS8_PRIV_KEY_INFO *EVP_PKEY2PKCS8(EVP_PKEY *pkey)
329 return EVP_PKEY2PKCS8_broken(pkey, PKCS8_OK);
332 /* Turn a private key into a PKCS8 structure */
334 PKCS8_PRIV_KEY_INFO *EVP_PKEY2PKCS8_broken(EVP_PKEY *pkey, int broken)
336 PKCS8_PRIV_KEY_INFO *p8;
338 if (!(p8 = PKCS8_PRIV_KEY_INFO_new())) {
339 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
343 ASN1_INTEGER_set (p8->version, 0);
344 if (!(p8->pkeyalg->parameter = ASN1_TYPE_new ())) {
345 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
346 PKCS8_PRIV_KEY_INFO_free (p8);
349 p8->pkey->type = V_ASN1_OCTET_STRING;
350 switch (EVP_PKEY_type(pkey->type)) {
351 #ifndef OPENSSL_NO_RSA
354 if(p8->broken == PKCS8_NO_OCTET) p8->pkey->type = V_ASN1_SEQUENCE;
356 p8->pkeyalg->algorithm = OBJ_nid2obj(NID_rsaEncryption);
357 p8->pkeyalg->parameter->type = V_ASN1_NULL;
358 if (!ASN1_pack_string ((char *)pkey, i2d_PrivateKey,
359 &p8->pkey->value.octet_string)) {
360 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
361 PKCS8_PRIV_KEY_INFO_free (p8);
366 #ifndef OPENSSL_NO_DSA
368 if(!dsa_pkey2pkcs8(p8, pkey)) {
369 PKCS8_PRIV_KEY_INFO_free (p8);
375 #ifndef OPENSSL_NO_EC
377 if (!eckey_pkey2pkcs8(p8, pkey))
379 PKCS8_PRIV_KEY_INFO_free(p8);
385 EVPerr(EVP_F_EVP_PKEY2PKCS8, EVP_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM);
386 PKCS8_PRIV_KEY_INFO_free (p8);
389 RAND_add(p8->pkey->value.octet_string->data,
390 p8->pkey->value.octet_string->length, 0.0);
394 PKCS8_PRIV_KEY_INFO *PKCS8_set_broken(PKCS8_PRIV_KEY_INFO *p8, int broken)
399 p8->broken = PKCS8_OK;
404 p8->broken = PKCS8_NO_OCTET;
405 p8->pkey->type = V_ASN1_SEQUENCE;
410 EVPerr(EVP_F_EVP_PKCS8_SET_BROKEN,EVP_R_PKCS8_UNKNOWN_BROKEN_TYPE);
417 #ifndef OPENSSL_NO_DSA
418 static int dsa_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8, EVP_PKEY *pkey)
423 STACK_OF(ASN1_TYPE) *ndsa;
424 unsigned char *p, *q;
427 p8->pkeyalg->algorithm = OBJ_nid2obj(NID_dsa);
428 len = i2d_DSAparams (pkey->pkey.dsa, NULL);
429 if (!(p = OPENSSL_malloc(len))) {
430 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
431 PKCS8_PRIV_KEY_INFO_free (p8);
435 i2d_DSAparams (pkey->pkey.dsa, &q);
436 params = ASN1_STRING_new();
437 ASN1_STRING_set(params, p, len);
439 /* Get private key into integer */
440 if (!(prkey = BN_to_ASN1_INTEGER (pkey->pkey.dsa->priv_key, NULL))) {
441 EVPerr(EVP_F_EVP_PKEY2PKCS8,EVP_R_ENCODE_ERROR);
450 if (!ASN1_pack_string((char *)prkey, i2d_ASN1_INTEGER,
451 &p8->pkey->value.octet_string)) {
452 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
453 M_ASN1_INTEGER_free (prkey);
457 M_ASN1_INTEGER_free (prkey);
458 p8->pkeyalg->parameter->value.sequence = params;
459 p8->pkeyalg->parameter->type = V_ASN1_SEQUENCE;
465 p8->pkeyalg->parameter->value.sequence = params;
466 p8->pkeyalg->parameter->type = V_ASN1_SEQUENCE;
467 ndsa = sk_ASN1_TYPE_new_null();
468 ttmp = ASN1_TYPE_new();
469 if (!(ttmp->value.integer = BN_to_ASN1_INTEGER (pkey->pkey.dsa->pub_key, NULL))) {
470 EVPerr(EVP_F_EVP_PKEY2PKCS8,EVP_R_ENCODE_ERROR);
471 PKCS8_PRIV_KEY_INFO_free(p8);
474 ttmp->type = V_ASN1_INTEGER;
475 sk_ASN1_TYPE_push(ndsa, ttmp);
477 ttmp = ASN1_TYPE_new();
478 ttmp->value.integer = prkey;
479 ttmp->type = V_ASN1_INTEGER;
480 sk_ASN1_TYPE_push(ndsa, ttmp);
482 p8->pkey->value.octet_string = ASN1_OCTET_STRING_new();
484 if (!ASN1_seq_pack_ASN1_TYPE(ndsa, i2d_ASN1_TYPE,
485 &p8->pkey->value.octet_string->data,
486 &p8->pkey->value.octet_string->length)) {
488 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
489 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
490 M_ASN1_INTEGER_free(prkey);
493 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
496 case PKCS8_EMBEDDED_PARAM:
498 p8->pkeyalg->parameter->type = V_ASN1_NULL;
499 ndsa = sk_ASN1_TYPE_new_null();
500 ttmp = ASN1_TYPE_new();
501 ttmp->value.sequence = params;
502 ttmp->type = V_ASN1_SEQUENCE;
503 sk_ASN1_TYPE_push(ndsa, ttmp);
505 ttmp = ASN1_TYPE_new();
506 ttmp->value.integer = prkey;
507 ttmp->type = V_ASN1_INTEGER;
508 sk_ASN1_TYPE_push(ndsa, ttmp);
510 p8->pkey->value.octet_string = ASN1_OCTET_STRING_new();
512 if (!ASN1_seq_pack_ASN1_TYPE(ndsa, i2d_ASN1_TYPE,
513 &p8->pkey->value.octet_string->data,
514 &p8->pkey->value.octet_string->length)) {
516 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
517 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
518 M_ASN1_INTEGER_free (prkey);
521 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
528 #ifndef OPENSSL_NO_EC
529 static int eckey_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8, EVP_PKEY *pkey)
532 unsigned char *p, *pp;
534 unsigned int tmp_flags;
536 if (pkey->pkey.eckey == NULL || pkey->pkey.eckey->group == NULL)
538 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, EVP_R_MISSING_PARAMETERS);
541 eckey = pkey->pkey.eckey;
543 /* set the ec parameters OID */
544 if (p8->pkeyalg->algorithm)
545 ASN1_OBJECT_free(p8->pkeyalg->algorithm);
547 p8->pkeyalg->algorithm = OBJ_nid2obj(NID_X9_62_id_ecPublicKey);
549 /* set the ec parameters */
551 if (p8->pkeyalg->parameter)
553 ASN1_TYPE_free(p8->pkeyalg->parameter);
554 p8->pkeyalg->parameter = NULL;
557 if ((p8->pkeyalg->parameter = ASN1_TYPE_new()) == NULL)
559 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
563 if (EC_GROUP_get_asn1_flag(eckey->group)
564 && (nid = EC_GROUP_get_nid(eckey->group)))
566 /* we have a 'named curve' => just set the OID */
567 p8->pkeyalg->parameter->type = V_ASN1_OBJECT;
568 p8->pkeyalg->parameter->value.object = OBJ_nid2obj(nid);
570 else /* explicit parameters */
572 if ((i = i2d_ECParameters(eckey, NULL)) == 0)
574 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
577 if ((p = (unsigned char *) OPENSSL_malloc(i)) == NULL)
579 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
583 if (!i2d_ECParameters(eckey, &pp))
585 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
589 p8->pkeyalg->parameter->type = V_ASN1_SEQUENCE;
590 if ((p8->pkeyalg->parameter->value.sequence
591 = ASN1_STRING_new()) == NULL)
593 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_ASN1_LIB);
597 ASN1_STRING_set(p8->pkeyalg->parameter->value.sequence, p, i);
601 /* set the private key */
603 /* do not include the parameters in the SEC1 private key
604 * see PKCS#11 12.11 */
605 tmp_flags = pkey->pkey.eckey->enc_flag;
606 pkey->pkey.eckey->enc_flag |= EC_PKEY_NO_PARAMETERS;
607 i = i2d_ECPrivateKey(pkey->pkey.eckey, NULL);
610 pkey->pkey.eckey->enc_flag = tmp_flags;
611 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
614 p = (unsigned char *) OPENSSL_malloc(i);
617 pkey->pkey.eckey->enc_flag = tmp_flags;
618 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
622 if (!i2d_ECPrivateKey(pkey->pkey.eckey, &pp))
624 pkey->pkey.eckey->enc_flag = tmp_flags;
625 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
629 /* restore old encoding flags */
630 pkey->pkey.eckey->enc_flag = tmp_flags;
635 p8->pkey->value.octet_string = ASN1_OCTET_STRING_new();
636 if (!p8->pkey->value.octet_string ||
637 !M_ASN1_OCTET_STRING_set(p8->pkey->value.octet_string,
641 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
646 case PKCS8_NO_OCTET: /* RSA specific */
647 case PKCS8_NS_DB: /* DSA specific */
648 case PKCS8_EMBEDDED_PARAM: /* DSA specific */
650 EVPerr(EVP_F_EVP_PKEY2PKCS8,EVP_R_ENCODE_ERROR);
652 OPENSSL_cleanse(p, (size_t)i);