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_RecipientInfo)
69 DECLARE_ASN1_ITEM(CMS_KeyTransRecipientInfo)
70 DECLARE_ASN1_ITEM(CMS_KEKRecipientInfo)
71 DECLARE_ASN1_ITEM(CMS_OtherKeyAttribute)
73 DECLARE_STACK_OF(CMS_RecipientInfo)
75 static CMS_EnvelopedData *cms_get0_enveloped(CMS_ContentInfo *cms)
77 if (OBJ_obj2nid(cms->contentType) != NID_pkcs7_enveloped)
79 CMSerr(CMS_F_CMS_GET0_ENVELOPED,
80 CMS_R_CONTENT_TYPE_NOT_ENVELOPED_DATA);
83 return cms->d.envelopedData;
86 static CMS_EnvelopedData *cms_enveloped_data_init(CMS_ContentInfo *cms)
88 if (cms->d.other == NULL)
90 cms->d.envelopedData = M_ASN1_new_of(CMS_EnvelopedData);
91 if (!cms->d.envelopedData)
93 CMSerr(CMS_F_CMS_ENVELOPED_DATA_INIT,
94 ERR_R_MALLOC_FAILURE);
97 cms->d.envelopedData->version = 0;
98 cms->d.envelopedData->encryptedContentInfo->contentType =
99 OBJ_nid2obj(NID_pkcs7_data);
100 ASN1_OBJECT_free(cms->contentType);
101 cms->contentType = OBJ_nid2obj(NID_pkcs7_enveloped);
102 return cms->d.envelopedData;
104 return cms_get0_enveloped(cms);
107 STACK_OF(CMS_RecipientInfo) *CMS_get0_RecipientInfos(CMS_ContentInfo *cms)
109 CMS_EnvelopedData *env;
110 env = cms_get0_enveloped(cms);
113 return env->recipientInfos;
116 int CMS_RecipientInfo_type(CMS_RecipientInfo *ri)
121 CMS_ContentInfo *CMS_EnvelopedData_create(const EVP_CIPHER *cipher)
123 CMS_ContentInfo *cms;
124 CMS_EnvelopedData *env;
125 cms = CMS_ContentInfo_new();
128 env = cms_enveloped_data_init(cms);
131 if (!cms_EncryptedContent_init(env->encryptedContentInfo,
137 CMS_ContentInfo_free(cms);
138 CMSerr(CMS_F_CMS_ENVELOPEDDATA_CREATE, ERR_R_MALLOC_FAILURE);
142 /* Add a recipient certificate. For now only handle key transport.
143 * If we ever handle key agreement will need updating.
145 CMS_RecipientInfo *CMS_add1_recipient_cert(CMS_ContentInfo *cms,
146 X509 *recip, unsigned int flags)
148 CMS_RecipientInfo *ri = NULL;
149 CMS_KeyTransRecipientInfo *ktri;
150 CMS_EnvelopedData *env;
153 env = cms_get0_enveloped(cms);
157 /* Initialize recipient info */
158 ri = M_ASN1_new_of(CMS_RecipientInfo);
162 /* Initialize and add key transport recipient info */
164 ri->d.ktri = M_ASN1_new_of(CMS_KeyTransRecipientInfo);
167 ri->type = CMS_RECIPINFO_TRANS;
171 X509_check_purpose(recip, -1, -1);
172 pk = X509_get_pubkey(recip);
175 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
176 CMS_R_ERROR_GETTING_PUBLIC_KEY);
179 CRYPTO_add(&recip->references, 1, CRYPTO_LOCK_X509);
183 if (flags & CMS_USE_KEYID)
186 type = CMS_RECIPINFO_KEYIDENTIFIER;
191 type = CMS_RECIPINFO_ISSUER_SERIAL;
194 /* Not a typo: RecipientIdentifier and SignerIdentifier are the
198 if (!cms_set1_SignerIdentifier(ktri->rid, recip, type))
201 if (pk->ameth && pk->ameth->pkey_ctrl)
203 i = pk->ameth->pkey_ctrl(pk, ASN1_PKEY_CTRL_CMS_ENVELOPE,
207 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
208 CMS_R_NOT_SUPPORTED_FOR_THIS_KEY_TYPE);
213 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT,
219 if (!sk_CMS_RecipientInfo_push(env->recipientInfos, ri))
225 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT, ERR_R_MALLOC_FAILURE);
228 M_ASN1_free_of(ri, CMS_RecipientInfo);
233 int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo *ri,
235 ASN1_OCTET_STRING **pid,
236 ASN1_GENERALIZEDTIME **pdate,
237 ASN1_OBJECT **potherid,
238 ASN1_TYPE **pothertype)
240 CMS_KEKIdentifier *rkid;
241 if (ri->type != CMS_RECIPINFO_KEK)
243 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_GET0_ID, CMS_R_NOT_KEK);
246 rkid = ri->d.kekri->kekid;
248 *palg = ri->d.kekri->keyEncryptionAlgorithm;
250 *pid = rkid->keyIdentifier;
256 *potherid = rkid->other->keyAttrId;
263 *pothertype = rkid->other->keyAttr;
270 /* For now hard code AES key wrap info */
272 static int aes_wrap_keylen(int nid)
276 case NID_id_aes128_wrap:
279 case NID_id_aes192_wrap:
282 case NID_id_aes256_wrap:
291 CMS_RecipientInfo *CMS_add0_recipient_key(CMS_ContentInfo *cms, int nid,
292 unsigned char *key, size_t keylen,
293 unsigned char *id, size_t idlen,
294 ASN1_GENERALIZEDTIME *date,
295 ASN1_OBJECT *otherTypeId,
296 ASN1_TYPE *otherType)
298 CMS_RecipientInfo *ri = NULL;
299 CMS_EnvelopedData *env;
300 CMS_KEKRecipientInfo *kekri;
301 size_t exp_keylen = 0;
302 env = cms_get0_enveloped(cms);
306 exp_keylen = aes_wrap_keylen(nid);
310 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY,
311 CMS_R_UNSUPPORTED_KEK_ALGORITHM);
315 if (keylen != exp_keylen)
317 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY, CMS_R_INVALID_KEY_LENGTH);
321 /* Initialize recipient info */
322 ri = M_ASN1_new_of(CMS_RecipientInfo);
326 ri->d.kekri = M_ASN1_new_of(CMS_KEKRecipientInfo);
329 ri->type = CMS_RECIPINFO_KEK;
335 kekri->kekid->other = M_ASN1_new_of(CMS_OtherKeyAttribute);
336 if (kekri->kekid->other == NULL)
340 if (!sk_CMS_RecipientInfo_push(env->recipientInfos, ri))
343 /* After this point no calls can fail */
348 kekri->keylen = keylen;
350 ASN1_STRING_set0(kekri->kekid->keyIdentifier, id, idlen);
352 kekri->kekid->date = date;
354 kekri->kekid->other->keyAttrId = otherTypeId;
355 kekri->kekid->other->keyAttr = otherType;
357 X509_ALGOR_set0(kekri->keyEncryptionAlgorithm,
358 OBJ_nid2obj(nid), V_ASN1_UNDEF, NULL);
363 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY, ERR_R_MALLOC_FAILURE);
366 M_ASN1_free_of(ri, CMS_RecipientInfo);
371 int CMS_RecipientInfo_ktri_get0_algs(CMS_RecipientInfo *ri,
372 EVP_PKEY **pk, X509 **recip,
375 CMS_KeyTransRecipientInfo *ktri;
376 if (ri->type != CMS_RECIPINFO_TRANS)
378 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_ALGS,
379 CMS_R_NOT_KEY_TRANSPORT);
388 *recip = ktri->recip;
390 *palg = ktri->keyEncryptionAlgorithm;
394 int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo *ri,
395 ASN1_OCTET_STRING **keyid,
396 X509_NAME **issuer, ASN1_INTEGER **sno)
398 CMS_KeyTransRecipientInfo *ktri;
399 if (ri->type != CMS_RECIPINFO_TRANS)
401 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_SIGNER_ID,
402 CMS_R_NOT_KEY_TRANSPORT);
407 return cms_SignerIdentifier_get0_signer_id(ktri->rid,
411 int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo *ri, X509 *cert)
413 if (ri->type != CMS_RECIPINFO_TRANS)
415 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_CERT_CMP,
416 CMS_R_NOT_KEY_TRANSPORT);
419 return cms_SignerIdentifier_cert_cmp(ri->d.ktri->rid, cert);
422 int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo *ri, EVP_PKEY *pkey)
424 if (ri->type != CMS_RECIPINFO_TRANS)
426 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_PKEY,
427 CMS_R_NOT_KEY_TRANSPORT);
430 ri->d.ktri->pkey = pkey;
434 int CMS_RecipientInfo_set0_key(CMS_RecipientInfo *ri,
435 unsigned char *key, size_t keylen)
437 CMS_KEKRecipientInfo *kekri;
439 if (ri->type != CMS_RECIPINFO_KEK)
441 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_KEY, CMS_R_NOT_KEK);
444 wrap_nid = OBJ_obj2nid(kekri->keyEncryptionAlgorithm->algorithm);
445 if (aes_wrap_keylen(wrap_nid) != keylen)
447 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_KEY,
448 CMS_R_INVALID_KEY_LENGTH);
452 kekri->keylen = keylen;
456 /* Encrypt content key in key transport recipient info */
458 static int cms_RecipientInfo_ktri_encrypt(CMS_ContentInfo *cms,
459 CMS_RecipientInfo *ri)
461 CMS_KeyTransRecipientInfo *ktri;
462 CMS_EncryptedContentInfo *ec;
463 EVP_PKEY_CTX *pctx = NULL;
464 unsigned char *ek = NULL;
469 if (ri->type != CMS_RECIPINFO_TRANS)
471 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT,
472 CMS_R_NOT_KEY_TRANSPORT);
476 ec = cms->d.envelopedData->encryptedContentInfo;
478 pctx = EVP_PKEY_CTX_new(ktri->pkey, NULL);
482 if (EVP_PKEY_encrypt_init(pctx) <= 0)
485 if (EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_ENCRYPT,
486 EVP_PKEY_CTRL_CMS_ENCRYPT, 0, ri) <= 0)
488 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT, CMS_R_CTRL_ERROR);
492 if (EVP_PKEY_encrypt(pctx, NULL, &eklen, ec->key, ec->keylen) <= 0)
495 ek = OPENSSL_malloc(eklen);
499 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT,
500 ERR_R_MALLOC_FAILURE);
504 if (EVP_PKEY_encrypt(pctx, ek, &eklen, ec->key, ec->keylen) <= 0)
507 ASN1_STRING_set0(ktri->encryptedKey, ek, eklen);
514 EVP_PKEY_CTX_free(pctx);
521 static int cms_RecipientInfo_ktri_decrypt(CMS_ContentInfo *cms,
522 CMS_RecipientInfo *ri)
524 CMS_KeyTransRecipientInfo *ktri = ri->d.ktri;
525 EVP_PKEY_CTX *pctx = NULL;
526 unsigned char *ek = NULL;
530 if (ktri->pkey == NULL)
532 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT,
533 CMS_R_NO_PRIVATE_KEY);
537 pctx = EVP_PKEY_CTX_new(ktri->pkey, NULL);
541 if (EVP_PKEY_decrypt_init(pctx) <= 0)
544 if (EVP_PKEY_CTX_ctrl(pctx, -1, EVP_PKEY_OP_DECRYPT,
545 EVP_PKEY_CTRL_CMS_DECRYPT, 0, ri) <= 0)
547 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT, CMS_R_CTRL_ERROR);
551 if (EVP_PKEY_decrypt(pctx, NULL, &eklen,
552 ktri->encryptedKey->data,
553 ktri->encryptedKey->length) <= 0)
556 ek = OPENSSL_malloc(eklen);
560 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT,
561 ERR_R_MALLOC_FAILURE);
565 if (EVP_PKEY_decrypt(pctx, ek, &eklen,
566 ktri->encryptedKey->data,
567 ktri->encryptedKey->length) <= 0)
569 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT, CMS_R_CMS_LIB);
575 cms->d.envelopedData->encryptedContentInfo->key = ek;
576 cms->d.envelopedData->encryptedContentInfo->keylen = eklen;
580 EVP_PKEY_CTX_free(pctx);
588 /* Encrypt content key in KEK recipient info */
590 static int cms_RecipientInfo_kekri_encrypt(CMS_ContentInfo *cms,
591 CMS_RecipientInfo *ri)
593 CMS_EncryptedContentInfo *ec;
594 CMS_KEKRecipientInfo *kekri;
596 unsigned char *wkey = NULL;
600 ec = cms->d.envelopedData->encryptedContentInfo;
606 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT, CMS_R_NO_KEY);
610 if (AES_set_encrypt_key(kekri->key, kekri->keylen << 3, &actx))
612 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT,
613 CMS_R_ERROR_SETTING_KEY);
617 wkey = OPENSSL_malloc(ec->keylen + 8);
621 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT,
622 ERR_R_MALLOC_FAILURE);
626 wkeylen = AES_wrap_key(&actx, NULL, wkey, ec->key, ec->keylen);
630 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT, CMS_R_WRAP_ERROR);
634 ASN1_STRING_set0(kekri->encryptedKey, wkey, wkeylen);
642 OPENSSL_cleanse(&actx, sizeof(actx));
648 static int cms_RecipientInfo_kekri_decrypt(CMS_ContentInfo *cms,
649 CMS_RecipientInfo *ri)
651 CMS_EncryptedContentInfo *ec;
652 CMS_KEKRecipientInfo *kekri;
654 unsigned char *ukey = NULL;
658 ec = cms->d.envelopedData->encryptedContentInfo;
664 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT, CMS_R_NO_KEY);
668 /* If encrypted key length is invalid don't bother */
670 if (kekri->encryptedKey->length < 16)
672 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
673 CMS_R_INVALID_ENCRYPTED_KEY_LENGTH);
677 if (AES_set_decrypt_key(kekri->key, kekri->keylen << 3, &actx))
679 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
680 CMS_R_ERROR_SETTING_KEY);
684 ukey = OPENSSL_malloc(kekri->encryptedKey->length - 8);
688 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
689 ERR_R_MALLOC_FAILURE);
693 ukeylen = AES_unwrap_key(&actx, NULL, ukey,
694 kekri->encryptedKey->data,
695 kekri->encryptedKey->length);
699 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT,
705 ec->keylen = ukeylen;
713 OPENSSL_cleanse(&actx, sizeof(actx));
719 int CMS_RecipientInfo_decrypt(CMS_ContentInfo *cms, CMS_RecipientInfo *ri)
723 case CMS_RECIPINFO_TRANS:
724 return cms_RecipientInfo_ktri_decrypt(cms, ri);
726 case CMS_RECIPINFO_KEK:
727 return cms_RecipientInfo_kekri_decrypt(cms, ri);
730 CMSerr(CMS_F_CMS_RECIPIENTINFO_DECRYPT,
731 CMS_R_UNSUPPORTED_RECPIENTINFO_TYPE);
736 BIO *cms_EnvelopedData_init_bio(CMS_ContentInfo *cms)
738 CMS_EncryptedContentInfo *ec;
739 STACK_OF(CMS_RecipientInfo) *rinfos;
740 CMS_RecipientInfo *ri;
744 /* Get BIO first to set up key */
746 ec = cms->d.envelopedData->encryptedContentInfo;
747 ret = cms_EncryptedContent_init_bio(ec);
749 /* If error or no cipher end of processing */
751 if (!ret || !ec->cipher)
754 rinfos = cms->d.envelopedData->recipientInfos;
756 for (i = 0; i < sk_CMS_RecipientInfo_num(rinfos); i++)
758 ri = sk_CMS_RecipientInfo_value(rinfos, i);
762 case CMS_RECIPINFO_TRANS:
763 r = cms_RecipientInfo_ktri_encrypt(cms, ri);
766 case CMS_RECIPINFO_KEK:
767 r = cms_RecipientInfo_kekri_encrypt(cms, ri);
771 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO,
772 CMS_R_UNSUPPORTED_RECIPIENT_TYPE);
778 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO,
779 CMS_R_ERROR_SETTING_RECIPIENTINFO);
790 OPENSSL_cleanse(ec->key, ec->keylen);
791 OPENSSL_free(ec->key);