1 /* crypto/cms/cms_env.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
5 /* ====================================================================
6 * Copyright (c) 2008 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 * ====================================================================
55 #include <openssl/asn1t.h>
56 #include <openssl/pem.h>
57 #include <openssl/x509v3.h>
58 #include <openssl/err.h>
59 #include <openssl/cms.h>
60 #include <openssl/rand.h>
61 #include <openssl/aes.h>
63 #include "asn1_locl.h"
65 /* CMS EnvelopedData Utilities */
67 DECLARE_ASN1_ITEM(CMS_EnvelopedData)
68 DECLARE_ASN1_ITEM(CMS_KeyTransRecipientInfo)
69 DECLARE_ASN1_ITEM(CMS_KEKRecipientInfo)
70 DECLARE_ASN1_ITEM(CMS_OtherKeyAttribute)
72 DECLARE_STACK_OF(CMS_RecipientInfo)
74 CMS_EnvelopedData *cms_get0_enveloped(CMS_ContentInfo *cms)
76 if (OBJ_obj2nid(cms->contentType) != NID_pkcs7_enveloped)
78 CMSerr(CMS_F_CMS_GET0_ENVELOPED,
79 CMS_R_CONTENT_TYPE_NOT_ENVELOPED_DATA);
82 return cms->d.envelopedData;
85 static CMS_EnvelopedData *cms_enveloped_data_init(CMS_ContentInfo *cms)
87 if (cms->d.other == NULL)
89 cms->d.envelopedData = M_ASN1_new_of(CMS_EnvelopedData);
90 if (!cms->d.envelopedData)
92 CMSerr(CMS_F_CMS_ENVELOPED_DATA_INIT,
93 ERR_R_MALLOC_FAILURE);
96 cms->d.envelopedData->version = 0;
97 cms->d.envelopedData->encryptedContentInfo->contentType =
98 OBJ_nid2obj(NID_pkcs7_data);
99 ASN1_OBJECT_free(cms->contentType);
100 cms->contentType = OBJ_nid2obj(NID_pkcs7_enveloped);
101 return cms->d.envelopedData;
103 return cms_get0_enveloped(cms);
106 STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms)
108 CMS_EnvelopedData *env;
109 env = cms_get0_enveloped(cms);
112 return env->recipientInfos;
115 int CMS_RecipientInfo_type(CMS_RecipientInfo *ri)
120 CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher)
122 CMS_ContentInfo *cms;
123 CMS_EnvelopedData *env;
124 cms = CMS_ContentInfo_new();
127 env = cms_enveloped_data_init(cms);
130 if (!cms_EncryptedContent_init(env->encryptedContentInfo,
136 CMS_ContentInfo_free(cms);
137 CMSerr(CMS_F_CMS_ENVELOPEDDATA_CREATE, ERR_R_MALLOC_FAILURE);
141 /* Key Transport Recipient Info (KTRI) routines */
143 /* Add a recipient certificate. For now only handle key transport.
144 * If we ever handle key agreement will need updating.
147 CMS_RecipientInfo *CMS_add1_recipient_cert(CMS_ContentInfo *cms,
148 X509 *recip, unsigned int flags)
150 CMS_RecipientInfo *ri = NULL;
151 CMS_KeyTransRecipientInfo *ktri;
152 CMS_EnvelopedData *env;
155 env = cms_get0_enveloped(cms);
159 /* Initialize recipient info */
160 ri = M_ASN1_new_of(CMS_RecipientInfo);
164 /* Initialize and add key transport recipient info */
166 ri->d.ktri = M_ASN1_new_of(CMS_KeyTransRecipientInfo);
169 ri->type = CMS_RECIPINFO_TRANS;
173 X509_check_purpose(recip, -1, -1);
174 pk = X509_get_pubkey(recip);
177 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
178 CMS_R_ERROR_GETTING_PUBLIC_KEY);
181 CRYPTO_add(&recip->references, 1, CRYPTO_LOCK_X509);
185 if (flags & CMS_USE_KEYID)
188 type = CMS_RECIPINFO_KEYIDENTIFIER;
193 type = CMS_RECIPINFO_ISSUER_SERIAL;
196 /* Not a typo: RecipientIdentifier and SignerIdentifier are the
200 if (!cms_set1_SignerIdentifier(ktri->rid, recip, type))
203 if (pk->ameth && pk->ameth->pkey_ctrl)
205 i = pk->ameth->pkey_ctrl(pk, ASN1_PKEY_CTRL_CMS_ENVELOPE,
209 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
210 CMS_R_NOT_SUPPORTED_FOR_THIS_KEY_TYPE);
215 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
221 if (!sk_CMS_RecipientInfo_push(env->recipientInfos, ri))
227 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT, ERR_R_MALLOC_FAILURE);
230 M_ASN1_free_of(ri, CMS_RecipientInfo);
235 int CMS_RecipientInfo_ktri_get0_algs(CMS_RecipientInfo *ri,
236 EVP_PKEY **pk, X509 **recip,
239 CMS_KeyTransRecipientInfo *ktri;
240 if (ri->type != CMS_RECIPINFO_TRANS)
242 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_ALGS,
243 CMS_R_NOT_KEY_TRANSPORT);
252 *recip = ktri->recip;
254 *palg = ktri->keyEncryptionAlgorithm;
258 int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri,
259 ASN1_OCTET_STRING **keyid,
260 X509_NAME **issuer, ASN1_INTEGER **sno)
262 CMS_KeyTransRecipientInfo *ktri;
263 if (ri->type != CMS_RECIPINFO_TRANS)
265 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_SIGNER_ID,
266 CMS_R_NOT_KEY_TRANSPORT);
271 return cms_SignerIdentifier_get0_signer_id(ktri->rid,
275 int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert)
277 if (ri->type != CMS_RECIPINFO_TRANS)
279 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_CERT_CMP,
280 CMS_R_NOT_KEY_TRANSPORT);
283 return cms_SignerIdentifier_cert_cmp(ri->d.ktri->rid, cert);
286 int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey)
288 if (ri->type != CMS_RECIPINFO_TRANS)
290 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_PKEY,
291 CMS_R_NOT_KEY_TRANSPORT);
294 ri->d.ktri->pkey = pkey;
298 /* Encrypt content key in key transport recipient info */
300 static int cms_RecipientInfo_ktri_encrypt(CMS_ContentInfo *cms,
301 CMS_RecipientInfo *ri)
303 CMS_KeyTransRecipientInfo *ktri;
304 CMS_EncryptedContentInfo *ec;
305 EVP_PKEY_CTX *pctx = NULL;
306 unsigned char *ek = NULL;
311 if (ri->type != CMS_RECIPINFO_TRANS)
313 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT,
314 CMS_R_NOT_KEY_TRANSPORT);
318 ec = cms->d.envelopedData->encryptedContentInfo;
320 pctx = EVP_PKEY_CTX_new(ktri->pkey, NULL);
324 if (EVP_PKEY_encrypt_init(pctx) <= 0)
327 if (EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_ENCRYPT,
328 EVP_PKEY_CTRL_CMS_ENCRYPT, 0, ri) <= 0)
330 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT, CMS_R_CTRL_ERROR);
334 if (EVP_PKEY_encrypt(pctx, NULL, &eklen, ec->key, ec->keylen) <= 0)
337 ek = OPENSSL_malloc(eklen);
341 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT,
342 ERR_R_MALLOC_FAILURE);
346 if (EVP_PKEY_encrypt(pctx, ek, &eklen, ec->key, ec->keylen) <= 0)
349 ASN1_STRING_set0(ktri->encryptedKey, ek, eklen);
356 EVP_PKEY_CTX_free(pctx);
363 /* Decrypt content key from KTRI */
365 static int cms_RecipientInfo_ktri_decrypt(CMS_ContentInfo *cms,
366 CMS_RecipientInfo *ri)
368 CMS_KeyTransRecipientInfo *ktri = ri->d.ktri;
369 EVP_PKEY_CTX *pctx = NULL;
370 unsigned char *ek = NULL;
374 if (ktri->pkey == NULL)
376 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT,
377 CMS_R_NO_PRIVATE_KEY);
381 pctx = EVP_PKEY_CTX_new(ktri->pkey, NULL);
385 if (EVP_PKEY_decrypt_init(pctx) <= 0)
388 if (EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DECRYPT,
389 EVP_PKEY_CTRL_CMS_DECRYPT, 0, ri) <= 0)
391 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT, CMS_R_CTRL_ERROR);
395 if (EVP_PKEY_decrypt(pctx, NULL, &eklen,
396 ktri->encryptedKey->data,
397 ktri->encryptedKey->length) <= 0)
400 ek = OPENSSL_malloc(eklen);
404 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT,
405 ERR_R_MALLOC_FAILURE);
409 if (EVP_PKEY_decrypt(pctx, ek, &eklen,
410 ktri->encryptedKey->data,
411 ktri->encryptedKey->length) <= 0)
413 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT, CMS_R_CMS_LIB);
419 cms->d.envelopedData->encryptedContentInfo->key = ek;
420 cms->d.envelopedData->encryptedContentInfo->keylen = eklen;
424 EVP_PKEY_CTX_free(pctx);
431 /* Key Encrypted Key (KEK) RecipientInfo routines */
433 int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri,
434 const unsigned char *id, size_t idlen)
436 ASN1_OCTET_STRING tmp_os;
437 CMS_KEKRecipientInfo *kekri;
438 if (ri->type != CMS_RECIPINFO_KEK)
440 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ID_CMP, CMS_R_NOT_KEK);
444 tmp_os.type = V_ASN1_OCTET_STRING;
446 tmp_os.data = (unsigned char *)id;
447 tmp_os.length = (int)idlen;
448 return ASN1_OCTET_STRING_cmp(&tmp_os, kekri->kekid->keyIdentifier);
451 /* For now hard code AES key wrap info */
453 static size_t aes_wrap_keylen(int nid)
457 case NID_id_aes128_wrap:
460 case NID_id_aes192_wrap:
463 case NID_id_aes256_wrap:
471 CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid,
472 unsigned char *key, size_t keylen,
473 unsigned char *id, size_t idlen,
474 ASN1_GENERALIZEDTIME *date,
475 ASN1_OBJECT *otherTypeId,
476 ASN1_TYPE *otherType)
478 CMS_RecipientInfo *ri = NULL;
479 CMS_EnvelopedData *env;
480 CMS_KEKRecipientInfo *kekri;
481 env = cms_get0_enveloped(cms);
485 if (nid == NID_undef)
490 nid = NID_id_aes128_wrap;
494 nid = NID_id_aes192_wrap;
498 nid = NID_id_aes256_wrap;
502 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY,
503 CMS_R_INVALID_KEY_LENGTH);
511 size_t exp_keylen = aes_wrap_keylen(nid);
515 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY,
516 CMS_R_UNSUPPORTED_KEK_ALGORITHM);
520 if (keylen != exp_keylen)
522 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY,
523 CMS_R_INVALID_KEY_LENGTH);
529 /* Initialize recipient info */
530 ri = M_ASN1_new_of(CMS_RecipientInfo);
534 ri->d.kekri = M_ASN1_new_of(CMS_KEKRecipientInfo);
537 ri->type = CMS_RECIPINFO_KEK;
543 kekri->kekid->other = M_ASN1_new_of(CMS_OtherKeyAttribute);
544 if (kekri->kekid->other == NULL)
548 if (!sk_CMS_RecipientInfo_push(env->recipientInfos, ri))
552 /* After this point no calls can fail */
557 kekri->keylen = keylen;
559 ASN1_STRING_set0(kekri->kekid->keyIdentifier, id, idlen);
561 kekri->kekid->date = date;
563 if (kekri->kekid->other)
565 kekri->kekid->other->keyAttrId = otherTypeId;
566 kekri->kekid->other->keyAttr = otherType;
569 X509_ALGOR_set0(kekri->keyEncryptionAlgorithm,
570 OBJ_nid2obj(nid), V_ASN1_UNDEF, NULL);
575 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY, ERR_R_MALLOC_FAILURE);
578 M_ASN1_free_of(ri, CMS_RecipientInfo);
583 int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri,
585 ASN1_OCTET_STRING **pid,
586 ASN1_GENERALIZEDTIME **pdate,
587 ASN1_OBJECT **potherid,
588 ASN1_TYPE **pothertype)
590 CMS_KEKIdentifier *rkid;
591 if (ri->type != CMS_RECIPINFO_KEK)
593 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_GET0_ID, CMS_R_NOT_KEK);
596 rkid = ri->d.kekri->kekid;
598 *palg = ri->d.kekri->keyEncryptionAlgorithm;
600 *pid = rkid->keyIdentifier;
606 *potherid = rkid->other->keyAttrId;
613 *pothertype = rkid->other->keyAttr;
620 int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri,
621 unsigned char *key, size_t keylen)
623 CMS_KEKRecipientInfo *kekri;
624 if (ri->type != CMS_RECIPINFO_KEK)
626 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_KEY, CMS_R_NOT_KEK);
632 kekri->keylen = keylen;
637 /* Encrypt content key in KEK recipient info */
639 static int cms_RecipientInfo_kekri_encrypt(CMS_ContentInfo *cms,
640 CMS_RecipientInfo *ri)
642 CMS_EncryptedContentInfo *ec;
643 CMS_KEKRecipientInfo *kekri;
645 unsigned char *wkey = NULL;
649 ec = cms->d.envelopedData->encryptedContentInfo;
655 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT, CMS_R_NO_KEY);
659 if (AES_set_encrypt_key(kekri->key, kekri->keylen << 3, &actx))
661 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT,
662 CMS_R_ERROR_SETTING_KEY);
666 wkey = OPENSSL_malloc(ec->keylen + 8);
670 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT,
671 ERR_R_MALLOC_FAILURE);
675 wkeylen = AES_wrap_key(&actx, NULL, wkey, ec->key, ec->keylen);
679 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT, CMS_R_WRAP_ERROR);
683 ASN1_STRING_set0(kekri->encryptedKey, wkey, wkeylen);
691 OPENSSL_cleanse(&actx, sizeof(actx));
697 /* Decrypt content key in KEK recipient info */
699 static int cms_RecipientInfo_kekri_decrypt(CMS_ContentInfo *cms,
700 CMS_RecipientInfo *ri)
702 CMS_EncryptedContentInfo *ec;
703 CMS_KEKRecipientInfo *kekri;
705 unsigned char *ukey = NULL;
709 ec = cms->d.envelopedData->encryptedContentInfo;
715 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT, CMS_R_NO_KEY);
719 wrap_nid = OBJ_obj2nid(kekri->keyEncryptionAlgorithm->algorithm);
720 if (aes_wrap_keylen(wrap_nid) != kekri->keylen)
722 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
723 CMS_R_INVALID_KEY_LENGTH);
727 /* If encrypted key length is invalid don't bother */
729 if (kekri->encryptedKey->length < 16)
731 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
732 CMS_R_INVALID_ENCRYPTED_KEY_LENGTH);
736 if (AES_set_decrypt_key(kekri->key, kekri->keylen << 3, &actx))
738 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
739 CMS_R_ERROR_SETTING_KEY);
743 ukey = OPENSSL_malloc(kekri->encryptedKey->length - 8);
747 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
748 ERR_R_MALLOC_FAILURE);
752 ukeylen = AES_unwrap_key(&actx, NULL, ukey,
753 kekri->encryptedKey->data,
754 kekri->encryptedKey->length);
758 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
764 ec->keylen = ukeylen;
772 OPENSSL_cleanse(&actx, sizeof(actx));
778 int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri)
782 case CMS_RECIPINFO_TRANS:
783 return cms_RecipientInfo_ktri_decrypt(cms, ri);
785 case CMS_RECIPINFO_KEK:
786 return cms_RecipientInfo_kekri_decrypt(cms, ri);
788 case CMS_RECIPINFO_PASS:
789 return cms_RecipientInfo_pwri_crypt(cms, ri, 0);
792 CMSerr(CMS_F_CMS_RECIPIENTINFO_DECRYPT,
793 CMS_R_UNSUPPORTED_RECPIENTINFO_TYPE);
798 BIO *cms_EnvelopedData_init_bio(CMS_ContentInfo *cms)
800 CMS_EncryptedContentInfo *ec;
801 STACK_OF(CMS_RecipientInfo) *rinfos;
802 CMS_RecipientInfo *ri;
806 /* Get BIO first to set up key */
808 ec = cms->d.envelopedData->encryptedContentInfo;
809 ret = cms_EncryptedContent_init_bio(ec);
811 /* If error or no cipher end of processing */
813 if (!ret || !ec->cipher)
816 /* Now encrypt content key according to each RecipientInfo type */
818 rinfos = cms->d.envelopedData->recipientInfos;
820 for (i = 0; i < sk_CMS_RecipientInfo_num(rinfos); i++)
822 ri = sk_CMS_RecipientInfo_value(rinfos, i);
826 case CMS_RECIPINFO_TRANS:
827 r = cms_RecipientInfo_ktri_encrypt(cms, ri);
830 case CMS_RECIPINFO_KEK:
831 r = cms_RecipientInfo_kekri_encrypt(cms, ri);
834 case CMS_RECIPINFO_PASS:
835 r = cms_RecipientInfo_pwri_crypt(cms, ri, 1);
839 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO,
840 CMS_R_UNSUPPORTED_RECIPIENT_TYPE);
846 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO,
847 CMS_R_ERROR_SETTING_RECIPIENTINFO);
858 OPENSSL_cleanse(ec->key, ec->keylen);
859 OPENSSL_free(ec->key);