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 if (env->version < 2)
190 type = CMS_RECIPINFO_KEYIDENTIFIER;
195 type = CMS_RECIPINFO_ISSUER_SERIAL;
198 /* Not a typo: RecipientIdentifier and SignerIdentifier are the
202 if (!cms_set1_SignerIdentifier(ktri->rid, recip, type))
205 if (pk->ameth && pk->ameth->pkey_ctrl)
207 i = pk->ameth->pkey_ctrl(pk, ASN1_PKEY_CTRL_CMS_ENVELOPE,
211 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
212 CMS_R_NOT_SUPPORTED_FOR_THIS_KEY_TYPE);
217 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
223 if (!sk_CMS_RecipientInfo_push(env->recipientInfos, ri))
229 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT, ERR_R_MALLOC_FAILURE);
232 M_ASN1_free_of(ri, CMS_RecipientInfo);
237 int CMS_RecipientInfo_ktri_get0_algs(CMS_RecipientInfo *ri,
238 EVP_PKEY **pk, X509 **recip,
241 CMS_KeyTransRecipientInfo *ktri;
242 if (ri->type != CMS_RECIPINFO_TRANS)
244 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_ALGS,
245 CMS_R_NOT_KEY_TRANSPORT);
254 *recip = ktri->recip;
256 *palg = ktri->keyEncryptionAlgorithm;
260 int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri,
261 ASN1_OCTET_STRING **keyid,
262 X509_NAME **issuer, ASN1_INTEGER **sno)
264 CMS_KeyTransRecipientInfo *ktri;
265 if (ri->type != CMS_RECIPINFO_TRANS)
267 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_SIGNER_ID,
268 CMS_R_NOT_KEY_TRANSPORT);
273 return cms_SignerIdentifier_get0_signer_id(ktri->rid,
277 int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert)
279 if (ri->type != CMS_RECIPINFO_TRANS)
281 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_CERT_CMP,
282 CMS_R_NOT_KEY_TRANSPORT);
285 return cms_SignerIdentifier_cert_cmp(ri->d.ktri->rid, cert);
288 int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey)
290 if (ri->type != CMS_RECIPINFO_TRANS)
292 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_PKEY,
293 CMS_R_NOT_KEY_TRANSPORT);
296 ri->d.ktri->pkey = pkey;
300 /* Encrypt content key in key transport recipient info */
302 static int cms_RecipientInfo_ktri_encrypt(CMS_ContentInfo *cms,
303 CMS_RecipientInfo *ri)
305 CMS_KeyTransRecipientInfo *ktri;
306 CMS_EncryptedContentInfo *ec;
307 EVP_PKEY_CTX *pctx = NULL;
308 unsigned char *ek = NULL;
313 if (ri->type != CMS_RECIPINFO_TRANS)
315 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT,
316 CMS_R_NOT_KEY_TRANSPORT);
320 ec = cms->d.envelopedData->encryptedContentInfo;
322 pctx = EVP_PKEY_CTX_new(ktri->pkey, NULL);
326 if (EVP_PKEY_encrypt_init(pctx) <= 0)
329 if (EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_ENCRYPT,
330 EVP_PKEY_CTRL_CMS_ENCRYPT, 0, ri) <= 0)
332 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT, CMS_R_CTRL_ERROR);
336 if (EVP_PKEY_encrypt(pctx, NULL, &eklen, ec->key, ec->keylen) <= 0)
339 ek = OPENSSL_malloc(eklen);
343 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT,
344 ERR_R_MALLOC_FAILURE);
348 if (EVP_PKEY_encrypt(pctx, ek, &eklen, ec->key, ec->keylen) <= 0)
351 ASN1_STRING_set0(ktri->encryptedKey, ek, eklen);
358 EVP_PKEY_CTX_free(pctx);
365 /* Decrypt content key from KTRI */
367 static int cms_RecipientInfo_ktri_decrypt(CMS_ContentInfo *cms,
368 CMS_RecipientInfo *ri)
370 CMS_KeyTransRecipientInfo *ktri = ri->d.ktri;
371 EVP_PKEY_CTX *pctx = NULL;
372 unsigned char *ek = NULL;
375 CMS_EncryptedContentInfo *ec;
376 ec = cms->d.envelopedData->encryptedContentInfo;
378 if (ktri->pkey == NULL)
380 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT,
381 CMS_R_NO_PRIVATE_KEY);
385 pctx = EVP_PKEY_CTX_new(ktri->pkey, NULL);
389 if (EVP_PKEY_decrypt_init(pctx) <= 0)
392 if (EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DECRYPT,
393 EVP_PKEY_CTRL_CMS_DECRYPT, 0, ri) <= 0)
395 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT, CMS_R_CTRL_ERROR);
399 if (EVP_PKEY_decrypt(pctx, NULL, &eklen,
400 ktri->encryptedKey->data,
401 ktri->encryptedKey->length) <= 0)
404 ek = OPENSSL_malloc(eklen);
408 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT,
409 ERR_R_MALLOC_FAILURE);
413 if (EVP_PKEY_decrypt(pctx, ek, &eklen,
414 ktri->encryptedKey->data,
415 ktri->encryptedKey->length) <= 0)
417 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT, CMS_R_CMS_LIB);
425 OPENSSL_cleanse(ec->key, ec->keylen);
426 OPENSSL_free(ec->key);
434 EVP_PKEY_CTX_free(pctx);
441 /* Key Encrypted Key (KEK) RecipientInfo routines */
443 int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo *ri,
444 const unsigned char *id, size_t idlen)
446 ASN1_OCTET_STRING tmp_os;
447 CMS_KEKRecipientInfo *kekri;
448 if (ri->type != CMS_RECIPINFO_KEK)
450 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ID_CMP, CMS_R_NOT_KEK);
454 tmp_os.type = V_ASN1_OCTET_STRING;
456 tmp_os.data = (unsigned char *)id;
457 tmp_os.length = (int)idlen;
458 return ASN1_OCTET_STRING_cmp(&tmp_os, kekri->kekid->keyIdentifier);
461 /* For now hard code AES key wrap info */
463 static size_t aes_wrap_keylen(int nid)
467 case NID_id_aes128_wrap:
470 case NID_id_aes192_wrap:
473 case NID_id_aes256_wrap:
481 CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid,
482 unsigned char *key, size_t keylen,
483 unsigned char *id, size_t idlen,
484 ASN1_GENERALIZEDTIME *date,
485 ASN1_OBJECT *otherTypeId,
486 ASN1_TYPE *otherType)
488 CMS_RecipientInfo *ri = NULL;
489 CMS_EnvelopedData *env;
490 CMS_KEKRecipientInfo *kekri;
491 env = cms_get0_enveloped(cms);
495 if (nid == NID_undef)
500 nid = NID_id_aes128_wrap;
504 nid = NID_id_aes192_wrap;
508 nid = NID_id_aes256_wrap;
512 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY,
513 CMS_R_INVALID_KEY_LENGTH);
521 size_t exp_keylen = aes_wrap_keylen(nid);
525 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY,
526 CMS_R_UNSUPPORTED_KEK_ALGORITHM);
530 if (keylen != exp_keylen)
532 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY,
533 CMS_R_INVALID_KEY_LENGTH);
539 /* Initialize recipient info */
540 ri = M_ASN1_new_of(CMS_RecipientInfo);
544 ri->d.kekri = M_ASN1_new_of(CMS_KEKRecipientInfo);
547 ri->type = CMS_RECIPINFO_KEK;
553 kekri->kekid->other = M_ASN1_new_of(CMS_OtherKeyAttribute);
554 if (kekri->kekid->other == NULL)
558 if (!sk_CMS_RecipientInfo_push(env->recipientInfos, ri))
562 /* After this point no calls can fail */
567 kekri->keylen = keylen;
569 ASN1_STRING_set0(kekri->kekid->keyIdentifier, id, idlen);
571 kekri->kekid->date = date;
573 if (kekri->kekid->other)
575 kekri->kekid->other->keyAttrId = otherTypeId;
576 kekri->kekid->other->keyAttr = otherType;
579 X509_ALGOR_set0(kekri->keyEncryptionAlgorithm,
580 OBJ_nid2obj(nid), V_ASN1_UNDEF, NULL);
585 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY, ERR_R_MALLOC_FAILURE);
588 M_ASN1_free_of(ri, CMS_RecipientInfo);
593 int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri,
595 ASN1_OCTET_STRING **pid,
596 ASN1_GENERALIZEDTIME **pdate,
597 ASN1_OBJECT **potherid,
598 ASN1_TYPE **pothertype)
600 CMS_KEKIdentifier *rkid;
601 if (ri->type != CMS_RECIPINFO_KEK)
603 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_GET0_ID, CMS_R_NOT_KEK);
606 rkid = ri->d.kekri->kekid;
608 *palg = ri->d.kekri->keyEncryptionAlgorithm;
610 *pid = rkid->keyIdentifier;
616 *potherid = rkid->other->keyAttrId;
623 *pothertype = rkid->other->keyAttr;
630 int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri,
631 unsigned char *key, size_t keylen)
633 CMS_KEKRecipientInfo *kekri;
634 if (ri->type != CMS_RECIPINFO_KEK)
636 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_KEY, CMS_R_NOT_KEK);
642 kekri->keylen = keylen;
647 /* Encrypt content key in KEK recipient info */
649 static int cms_RecipientInfo_kekri_encrypt(CMS_ContentInfo *cms,
650 CMS_RecipientInfo *ri)
652 CMS_EncryptedContentInfo *ec;
653 CMS_KEKRecipientInfo *kekri;
655 unsigned char *wkey = NULL;
659 ec = cms->d.envelopedData->encryptedContentInfo;
665 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT, CMS_R_NO_KEY);
669 if (AES_set_encrypt_key(kekri->key, kekri->keylen << 3, &actx))
671 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT,
672 CMS_R_ERROR_SETTING_KEY);
676 wkey = OPENSSL_malloc(ec->keylen + 8);
680 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT,
681 ERR_R_MALLOC_FAILURE);
685 wkeylen = AES_wrap_key(&actx, NULL, wkey, ec->key, ec->keylen);
689 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT, CMS_R_WRAP_ERROR);
693 ASN1_STRING_set0(kekri->encryptedKey, wkey, wkeylen);
701 OPENSSL_cleanse(&actx, sizeof(actx));
707 /* Decrypt content key in KEK recipient info */
709 static int cms_RecipientInfo_kekri_decrypt(CMS_ContentInfo *cms,
710 CMS_RecipientInfo *ri)
712 CMS_EncryptedContentInfo *ec;
713 CMS_KEKRecipientInfo *kekri;
715 unsigned char *ukey = NULL;
719 ec = cms->d.envelopedData->encryptedContentInfo;
725 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT, CMS_R_NO_KEY);
729 wrap_nid = OBJ_obj2nid(kekri->keyEncryptionAlgorithm->algorithm);
730 if (aes_wrap_keylen(wrap_nid) != kekri->keylen)
732 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
733 CMS_R_INVALID_KEY_LENGTH);
737 /* If encrypted key length is invalid don't bother */
739 if (kekri->encryptedKey->length < 16)
741 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
742 CMS_R_INVALID_ENCRYPTED_KEY_LENGTH);
746 if (AES_set_decrypt_key(kekri->key, kekri->keylen << 3, &actx))
748 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
749 CMS_R_ERROR_SETTING_KEY);
753 ukey = OPENSSL_malloc(kekri->encryptedKey->length - 8);
757 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
758 ERR_R_MALLOC_FAILURE);
762 ukeylen = AES_unwrap_key(&actx, NULL, ukey,
763 kekri->encryptedKey->data,
764 kekri->encryptedKey->length);
768 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
774 ec->keylen = ukeylen;
782 OPENSSL_cleanse(&actx, sizeof(actx));
788 int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri)
792 case CMS_RECIPINFO_TRANS:
793 return cms_RecipientInfo_ktri_decrypt(cms, ri);
795 case CMS_RECIPINFO_KEK:
796 return cms_RecipientInfo_kekri_decrypt(cms, ri);
798 case CMS_RECIPINFO_PASS:
799 return cms_RecipientInfo_pwri_crypt(cms, ri, 0);
802 CMSerr(CMS_F_CMS_RECIPIENTINFO_DECRYPT,
803 CMS_R_UNSUPPORTED_RECPIENTINFO_TYPE);
808 BIO *cms_EnvelopedData_init_bio(CMS_ContentInfo *cms)
810 CMS_EncryptedContentInfo *ec;
811 STACK_OF(CMS_RecipientInfo) *rinfos;
812 CMS_RecipientInfo *ri;
816 /* Get BIO first to set up key */
818 ec = cms->d.envelopedData->encryptedContentInfo;
819 ret = cms_EncryptedContent_init_bio(ec);
821 /* If error or no cipher end of processing */
823 if (!ret || !ec->cipher)
826 /* Now encrypt content key according to each RecipientInfo type */
828 rinfos = cms->d.envelopedData->recipientInfos;
830 for (i = 0; i < sk_CMS_RecipientInfo_num(rinfos); i++)
832 ri = sk_CMS_RecipientInfo_value(rinfos, i);
836 case CMS_RECIPINFO_TRANS:
837 r = cms_RecipientInfo_ktri_encrypt(cms, ri);
840 case CMS_RECIPINFO_KEK:
841 r = cms_RecipientInfo_kekri_encrypt(cms, ri);
844 case CMS_RECIPINFO_PASS:
845 r = cms_RecipientInfo_pwri_crypt(cms, ri, 1);
849 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO,
850 CMS_R_UNSUPPORTED_RECIPIENT_TYPE);
856 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO,
857 CMS_R_ERROR_SETTING_RECIPIENTINFO);
868 OPENSSL_cleanse(ec->key, ec->keylen);
869 OPENSSL_free(ec->key);