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>
65 #ifndef OPENSSL_NO_DSA
66 static int dsa_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8inf, EVP_PKEY *pkey);
69 static int eckey_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8inf, EVP_PKEY *pkey);
72 /* Extract a private key from a PKCS8 structure */
74 EVP_PKEY *EVP_PKCS82PKEY (PKCS8_PRIV_KEY_INFO *p8)
76 EVP_PKEY *pkey = NULL;
77 #ifndef OPENSSL_NO_RSA
80 #ifndef OPENSSL_NO_DSA
83 ASN1_INTEGER *privkey;
84 STACK_OF(ASN1_TYPE) *ndsa = NULL;
88 const unsigned char *p_tmp;
90 #if !defined(OPENSSL_NO_DSA) || !defined(OPENSSL_NO_EC)
91 ASN1_TYPE *param = NULL;
96 const unsigned char *p;
97 const unsigned char *cp;
102 if(p8->pkey->type == V_ASN1_OCTET_STRING) {
103 p8->broken = PKCS8_OK;
104 p = p8->pkey->value.octet_string->data;
105 pkeylen = p8->pkey->value.octet_string->length;
107 p8->broken = PKCS8_NO_OCTET;
108 p = p8->pkey->value.sequence->data;
109 pkeylen = p8->pkey->value.sequence->length;
111 if (!(pkey = EVP_PKEY_new())) {
112 EVPerr(EVP_F_EVP_PKCS82PKEY,ERR_R_MALLOC_FAILURE);
116 nid = OBJ_obj2nid(a->algorithm);
119 #ifndef OPENSSL_NO_RSA
120 case NID_rsaEncryption:
122 if (!(rsa = d2i_RSAPrivateKey (NULL,&cp, pkeylen))) {
123 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
126 EVP_PKEY_assign_RSA (pkey, rsa);
129 #ifndef OPENSSL_NO_DSA
131 /* PKCS#8 DSA is weird: you just get a private key integer
132 * and parameters in the AlgorithmIdentifier the pubkey must
136 /* Check for broken DSA PKCS#8, UGH! */
137 if(*p == (V_ASN1_SEQUENCE|V_ASN1_CONSTRUCTED)) {
138 if(!(ndsa = ASN1_seq_unpack_ASN1_TYPE(p, pkeylen,
141 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
144 if(sk_ASN1_TYPE_num(ndsa) != 2 ) {
145 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
148 /* Handle Two broken types:
149 * SEQUENCE {parameters, priv_key}
150 * SEQUENCE {pub_key, priv_key}
153 t1 = sk_ASN1_TYPE_value(ndsa, 0);
154 t2 = sk_ASN1_TYPE_value(ndsa, 1);
155 if(t1->type == V_ASN1_SEQUENCE) {
156 p8->broken = PKCS8_EMBEDDED_PARAM;
158 } else if(a->parameter->type == V_ASN1_SEQUENCE) {
159 p8->broken = PKCS8_NS_DB;
160 param = a->parameter;
162 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
166 if(t2->type != V_ASN1_INTEGER) {
167 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
170 privkey = t2->value.integer;
172 if (!(privkey=d2i_ASN1_INTEGER (NULL, &p, pkeylen))) {
173 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
176 param = p8->pkeyalg->parameter;
178 if (!param || (param->type != V_ASN1_SEQUENCE)) {
179 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
182 cp = p = param->value.sequence->data;
183 plen = param->value.sequence->length;
184 if (!(dsa = d2i_DSAparams (NULL, &cp, plen))) {
185 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
188 /* We have parameters now set private key */
189 if (!(dsa->priv_key = ASN1_INTEGER_to_BN(privkey, NULL))) {
190 EVPerr(EVP_F_EVP_PKCS82PKEY,EVP_R_BN_DECODE_ERROR);
193 /* Calculate public key (ouch!) */
194 if (!(dsa->pub_key = BN_new())) {
195 EVPerr(EVP_F_EVP_PKCS82PKEY,ERR_R_MALLOC_FAILURE);
198 if (!(ctx = BN_CTX_new())) {
199 EVPerr(EVP_F_EVP_PKCS82PKEY,ERR_R_MALLOC_FAILURE);
203 if (!BN_mod_exp(dsa->pub_key, dsa->g,
204 dsa->priv_key, dsa->p, ctx)) {
206 EVPerr(EVP_F_EVP_PKCS82PKEY,EVP_R_BN_PUBKEY_ERROR);
210 EVP_PKEY_assign_DSA(pkey, dsa);
212 if(ndsa) sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
213 else ASN1_INTEGER_free(privkey);
217 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
223 #ifndef OPENSSL_NO_EC
224 case NID_X9_62_id_ecPublicKey:
226 /* extract the ec parameters */
227 param = p8->pkeyalg->parameter;
229 if (!param || ((param->type != V_ASN1_SEQUENCE) &&
230 (param->type != V_ASN1_OBJECT)))
232 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
236 if (param->type == V_ASN1_SEQUENCE)
238 cp = p = param->value.sequence->data;
239 plen = param->value.sequence->length;
241 if (!(eckey = d2i_ECParameters(NULL, &cp, plen)))
243 EVPerr(EVP_F_EVP_PKCS82PKEY,
250 cp = p = param->value.object->data;
251 plen = param->value.object->length;
253 /* type == V_ASN1_OBJECT => the parameters are given
256 if ((eckey = EC_KEY_new()) == NULL)
258 EVPerr(EVP_F_EVP_PKCS82PKEY,
259 ERR_R_MALLOC_FAILURE);
262 if ((eckey->group = EC_GROUP_new_by_nid(
263 OBJ_obj2nid(a->parameter->value.object))) == NULL)
265 EC_GROUP_set_asn1_flag(eckey->group,
266 OPENSSL_EC_NAMED_CURVE);
269 /* We have parameters now set private key */
270 if (!d2i_ECPrivateKey(&eckey, &p_tmp, pkeylen))
272 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_DECODE_ERROR);
276 /* calculate public key (if necessary) */
279 /* the public key was not included in the SEC1 private
280 * key => calculate the public key */
281 eckey->pub_key = EC_POINT_new(eckey->group);
284 EVPerr(EVP_F_EVP_PKCS82PKEY, ERR_R_EC_LIB);
287 if (!EC_POINT_copy(eckey->pub_key,
288 EC_GROUP_get0_generator(eckey->group)))
290 EVPerr(EVP_F_EVP_PKCS82PKEY, ERR_R_EC_LIB);
293 if (!EC_POINT_mul(eckey->group, eckey->pub_key,
294 eckey->priv_key, NULL, NULL, ctx))
296 EVPerr(EVP_F_EVP_PKCS82PKEY, ERR_R_EC_LIB);
301 EVP_PKEY_assign_EC_KEY(pkey, eckey);
315 EVPerr(EVP_F_EVP_PKCS82PKEY, EVP_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM);
316 if (!a->algorithm) BUF_strlcpy (obj_tmp, "NULL", sizeof obj_tmp);
317 else i2t_ASN1_OBJECT(obj_tmp, 80, a->algorithm);
318 ERR_add_error_data(2, "TYPE=", obj_tmp);
319 EVP_PKEY_free (pkey);
325 PKCS8_PRIV_KEY_INFO *EVP_PKEY2PKCS8(EVP_PKEY *pkey)
327 return EVP_PKEY2PKCS8_broken(pkey, PKCS8_OK);
330 /* Turn a private key into a PKCS8 structure */
332 PKCS8_PRIV_KEY_INFO *EVP_PKEY2PKCS8_broken(EVP_PKEY *pkey, int broken)
334 PKCS8_PRIV_KEY_INFO *p8;
336 if (!(p8 = PKCS8_PRIV_KEY_INFO_new())) {
337 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
341 ASN1_INTEGER_set (p8->version, 0);
342 if (!(p8->pkeyalg->parameter = ASN1_TYPE_new ())) {
343 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
344 PKCS8_PRIV_KEY_INFO_free (p8);
347 p8->pkey->type = V_ASN1_OCTET_STRING;
348 switch (EVP_PKEY_type(pkey->type)) {
349 #ifndef OPENSSL_NO_RSA
352 if(p8->broken == PKCS8_NO_OCTET) p8->pkey->type = V_ASN1_SEQUENCE;
354 p8->pkeyalg->algorithm = OBJ_nid2obj(NID_rsaEncryption);
355 p8->pkeyalg->parameter->type = V_ASN1_NULL;
356 if (!ASN1_pack_string ((char *)pkey, i2d_PrivateKey,
357 &p8->pkey->value.octet_string)) {
358 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
359 PKCS8_PRIV_KEY_INFO_free (p8);
364 #ifndef OPENSSL_NO_DSA
366 if(!dsa_pkey2pkcs8(p8, pkey)) {
367 PKCS8_PRIV_KEY_INFO_free (p8);
373 #ifndef OPENSSL_NO_EC
375 if (!eckey_pkey2pkcs8(p8, pkey))
377 PKCS8_PRIV_KEY_INFO_free(p8);
383 EVPerr(EVP_F_EVP_PKEY2PKCS8, EVP_R_UNSUPPORTED_PRIVATE_KEY_ALGORITHM);
384 PKCS8_PRIV_KEY_INFO_free (p8);
387 RAND_add(p8->pkey->value.octet_string->data,
388 p8->pkey->value.octet_string->length, 0.0);
392 PKCS8_PRIV_KEY_INFO *PKCS8_set_broken(PKCS8_PRIV_KEY_INFO *p8, int broken)
397 p8->broken = PKCS8_OK;
402 p8->broken = PKCS8_NO_OCTET;
403 p8->pkey->type = V_ASN1_SEQUENCE;
408 EVPerr(EVP_F_EVP_PKCS8_SET_BROKEN,EVP_R_PKCS8_UNKNOWN_BROKEN_TYPE);
415 #ifndef OPENSSL_NO_DSA
416 static int dsa_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8, EVP_PKEY *pkey)
421 STACK_OF(ASN1_TYPE) *ndsa;
422 unsigned char *p, *q;
425 p8->pkeyalg->algorithm = OBJ_nid2obj(NID_dsa);
426 len = i2d_DSAparams (pkey->pkey.dsa, NULL);
427 if (!(p = OPENSSL_malloc(len))) {
428 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
429 PKCS8_PRIV_KEY_INFO_free (p8);
433 i2d_DSAparams (pkey->pkey.dsa, &q);
434 params = ASN1_STRING_new();
435 ASN1_STRING_set(params, p, len);
437 /* Get private key into integer */
438 if (!(prkey = BN_to_ASN1_INTEGER (pkey->pkey.dsa->priv_key, NULL))) {
439 EVPerr(EVP_F_EVP_PKEY2PKCS8,EVP_R_ENCODE_ERROR);
448 if (!ASN1_pack_string((char *)prkey, i2d_ASN1_INTEGER,
449 &p8->pkey->value.octet_string)) {
450 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
451 M_ASN1_INTEGER_free (prkey);
455 M_ASN1_INTEGER_free (prkey);
456 p8->pkeyalg->parameter->value.sequence = params;
457 p8->pkeyalg->parameter->type = V_ASN1_SEQUENCE;
463 p8->pkeyalg->parameter->value.sequence = params;
464 p8->pkeyalg->parameter->type = V_ASN1_SEQUENCE;
465 ndsa = sk_ASN1_TYPE_new_null();
466 ttmp = ASN1_TYPE_new();
467 if (!(ttmp->value.integer = BN_to_ASN1_INTEGER (pkey->pkey.dsa->pub_key, NULL))) {
468 EVPerr(EVP_F_EVP_PKEY2PKCS8,EVP_R_ENCODE_ERROR);
469 PKCS8_PRIV_KEY_INFO_free(p8);
472 ttmp->type = V_ASN1_INTEGER;
473 sk_ASN1_TYPE_push(ndsa, ttmp);
475 ttmp = ASN1_TYPE_new();
476 ttmp->value.integer = prkey;
477 ttmp->type = V_ASN1_INTEGER;
478 sk_ASN1_TYPE_push(ndsa, ttmp);
480 p8->pkey->value.octet_string = ASN1_OCTET_STRING_new();
482 if (!ASN1_seq_pack_ASN1_TYPE(ndsa, i2d_ASN1_TYPE,
483 &p8->pkey->value.octet_string->data,
484 &p8->pkey->value.octet_string->length)) {
486 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
487 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
488 M_ASN1_INTEGER_free(prkey);
491 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
494 case PKCS8_EMBEDDED_PARAM:
496 p8->pkeyalg->parameter->type = V_ASN1_NULL;
497 ndsa = sk_ASN1_TYPE_new_null();
498 ttmp = ASN1_TYPE_new();
499 ttmp->value.sequence = params;
500 ttmp->type = V_ASN1_SEQUENCE;
501 sk_ASN1_TYPE_push(ndsa, ttmp);
503 ttmp = ASN1_TYPE_new();
504 ttmp->value.integer = prkey;
505 ttmp->type = V_ASN1_INTEGER;
506 sk_ASN1_TYPE_push(ndsa, ttmp);
508 p8->pkey->value.octet_string = ASN1_OCTET_STRING_new();
510 if (!ASN1_seq_pack_ASN1_TYPE(ndsa, i2d_ASN1_TYPE,
511 &p8->pkey->value.octet_string->data,
512 &p8->pkey->value.octet_string->length)) {
514 EVPerr(EVP_F_EVP_PKEY2PKCS8,ERR_R_MALLOC_FAILURE);
515 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
516 M_ASN1_INTEGER_free (prkey);
519 sk_ASN1_TYPE_pop_free(ndsa, ASN1_TYPE_free);
526 #ifndef OPENSSL_NO_EC
527 static int eckey_pkey2pkcs8(PKCS8_PRIV_KEY_INFO *p8, EVP_PKEY *pkey)
530 unsigned char *p, *pp;
532 unsigned int tmp_flags;
534 if (pkey->pkey.eckey == NULL || pkey->pkey.eckey->group == NULL)
536 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, EVP_R_MISSING_PARAMETERS);
539 eckey = pkey->pkey.eckey;
541 /* set the ec parameters OID */
542 if (p8->pkeyalg->algorithm)
543 ASN1_OBJECT_free(p8->pkeyalg->algorithm);
545 p8->pkeyalg->algorithm = OBJ_nid2obj(NID_X9_62_id_ecPublicKey);
547 /* set the ec parameters */
549 if (p8->pkeyalg->parameter)
551 ASN1_TYPE_free(p8->pkeyalg->parameter);
552 p8->pkeyalg->parameter = NULL;
555 if ((p8->pkeyalg->parameter = ASN1_TYPE_new()) == NULL)
557 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
561 if (EC_GROUP_get_asn1_flag(eckey->group)
562 && (nid = EC_GROUP_get_nid(eckey->group)))
564 /* we have a 'named curve' => just set the OID */
565 p8->pkeyalg->parameter->type = V_ASN1_OBJECT;
566 p8->pkeyalg->parameter->value.object = OBJ_nid2obj(nid);
568 else /* explicit parameters */
570 if ((i = i2d_ECParameters(eckey, NULL)) == 0)
572 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
575 if ((p = (unsigned char *) OPENSSL_malloc(i)) == NULL)
577 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
581 if (!i2d_ECParameters(eckey, &pp))
583 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
587 p8->pkeyalg->parameter->type = V_ASN1_SEQUENCE;
588 if ((p8->pkeyalg->parameter->value.sequence
589 = ASN1_STRING_new()) == NULL)
591 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_ASN1_LIB);
595 ASN1_STRING_set(p8->pkeyalg->parameter->value.sequence, p, i);
599 /* set the private key */
601 /* do not include the parameters in the SEC1 private key
602 * see PKCS#11 12.11 */
603 tmp_flags = pkey->pkey.eckey->enc_flag;
604 pkey->pkey.eckey->enc_flag |= EC_PKEY_NO_PARAMETERS;
605 i = i2d_ECPrivateKey(pkey->pkey.eckey, NULL);
608 pkey->pkey.eckey->enc_flag = tmp_flags;
609 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
612 p = (unsigned char *) OPENSSL_malloc(i);
615 pkey->pkey.eckey->enc_flag = tmp_flags;
616 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
620 if (!i2d_ECPrivateKey(pkey->pkey.eckey, &pp))
622 pkey->pkey.eckey->enc_flag = tmp_flags;
623 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_EC_LIB);
627 /* restore old encoding flags */
628 pkey->pkey.eckey->enc_flag = tmp_flags;
633 p8->pkey->value.octet_string = ASN1_OCTET_STRING_new();
634 if (!p8->pkey->value.octet_string ||
635 !M_ASN1_OCTET_STRING_set(p8->pkey->value.octet_string,
639 EVPerr(EVP_F_EC_KEY_PKEY2PKCS8, ERR_R_MALLOC_FAILURE);
644 case PKCS8_NO_OCTET: /* RSA specific */
645 case PKCS8_NS_DB: /* DSA specific */
646 case PKCS8_EMBEDDED_PARAM: /* DSA specific */
648 EVPerr(EVP_F_EVP_PKEY2PKCS8,EVP_R_ENCODE_ERROR);
650 OPENSSL_cleanse(p, (size_t)i);