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>
64 /* CMS EnvelopedData Utilities */
66 DECLARE_ASN1_ITEM(CMS_EnvelopedData
)
67 DECLARE_ASN1_ITEM(CMS_RecipientInfo
)
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 static 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 /* Since we have no EVP_PKEY_ASN1_METHOD in OpenSSL 0.9.8,
204 * hard code algorithm parameters.
207 if (pk
->type
== EVP_PKEY_RSA
)
209 X509_ALGOR_set0(ktri
->keyEncryptionAlgorithm
,
210 OBJ_nid2obj(NID_rsaEncryption
),
215 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT
,
216 CMS_R_NOT_SUPPORTED_FOR_THIS_KEY_TYPE
);
220 if (!sk_CMS_RecipientInfo_push(env
->recipientInfos
, ri
))
226 CMSerr(CMS_F_CMS_ADD1_RECIPIENT_CERT
, ERR_R_MALLOC_FAILURE
);
229 M_ASN1_free_of(ri
, CMS_RecipientInfo
);
234 int CMS_RecipientInfo_ktri_get0_algs(CMS_RecipientInfo
*ri
,
235 EVP_PKEY
**pk
, X509
**recip
,
238 CMS_KeyTransRecipientInfo
*ktri
;
239 if (ri
->type
!= CMS_RECIPINFO_TRANS
)
241 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_ALGS
,
242 CMS_R_NOT_KEY_TRANSPORT
);
251 *recip
= ktri
->recip
;
253 *palg
= ktri
->keyEncryptionAlgorithm
;
257 int CMS_RecipientInfo_ktri_get0_signer_id(CMS_RecipientInfo
*ri
,
258 ASN1_OCTET_STRING
**keyid
,
259 X509_NAME
**issuer
, ASN1_INTEGER
**sno
)
261 CMS_KeyTransRecipientInfo
*ktri
;
262 if (ri
->type
!= CMS_RECIPINFO_TRANS
)
264 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_GET0_SIGNER_ID
,
265 CMS_R_NOT_KEY_TRANSPORT
);
270 return cms_SignerIdentifier_get0_signer_id(ktri
->rid
,
274 int CMS_RecipientInfo_ktri_cert_cmp(CMS_RecipientInfo
*ri
, X509
*cert
)
276 if (ri
->type
!= CMS_RECIPINFO_TRANS
)
278 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_CERT_CMP
,
279 CMS_R_NOT_KEY_TRANSPORT
);
282 return cms_SignerIdentifier_cert_cmp(ri
->d
.ktri
->rid
, cert
);
285 int CMS_RecipientInfo_set0_pkey(CMS_RecipientInfo
*ri
, EVP_PKEY
*pkey
)
287 if (ri
->type
!= CMS_RECIPINFO_TRANS
)
289 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_PKEY
,
290 CMS_R_NOT_KEY_TRANSPORT
);
293 ri
->d
.ktri
->pkey
= pkey
;
297 /* Encrypt content key in key transport recipient info */
299 static int cms_RecipientInfo_ktri_encrypt(CMS_ContentInfo
*cms
,
300 CMS_RecipientInfo
*ri
)
302 CMS_KeyTransRecipientInfo
*ktri
;
303 CMS_EncryptedContentInfo
*ec
;
304 unsigned char *ek
= NULL
;
309 if (ri
->type
!= CMS_RECIPINFO_TRANS
)
311 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT
,
312 CMS_R_NOT_KEY_TRANSPORT
);
316 ec
= cms
->d
.envelopedData
->encryptedContentInfo
;
318 eklen
= EVP_PKEY_size(ktri
->pkey
);
320 ek
= OPENSSL_malloc(eklen
);
324 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_ENCRYPT
,
325 ERR_R_MALLOC_FAILURE
);
329 eklen
= EVP_PKEY_encrypt(ek
, ec
->key
, ec
->keylen
, ktri
->pkey
);
334 ASN1_STRING_set0(ktri
->encryptedKey
, ek
, eklen
);
346 /* Decrypt content key from KTRI */
348 static int cms_RecipientInfo_ktri_decrypt(CMS_ContentInfo
*cms
,
349 CMS_RecipientInfo
*ri
)
351 CMS_KeyTransRecipientInfo
*ktri
= ri
->d
.ktri
;
352 unsigned char *ek
= NULL
;
356 if (ktri
->pkey
== NULL
)
358 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT
,
359 CMS_R_NO_PRIVATE_KEY
);
363 eklen
= EVP_PKEY_size(ktri
->pkey
);
365 ek
= OPENSSL_malloc(eklen
);
369 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT
,
370 ERR_R_MALLOC_FAILURE
);
374 eklen
= EVP_PKEY_decrypt(ek
,
375 ktri
->encryptedKey
->data
,
376 ktri
->encryptedKey
->length
, ktri
->pkey
);
379 CMSerr(CMS_F_CMS_RECIPIENTINFO_KTRI_DECRYPT
, CMS_R_CMS_LIB
);
385 cms
->d
.envelopedData
->encryptedContentInfo
->key
= ek
;
386 cms
->d
.envelopedData
->encryptedContentInfo
->keylen
= eklen
;
395 /* Key Encrypted Key (KEK) RecipientInfo routines */
397 int CMS_RecipientInfo_kekri_id_cmp(CMS_RecipientInfo
*ri
,
398 const unsigned char *id
, size_t idlen
)
400 ASN1_OCTET_STRING tmp_os
;
401 CMS_KEKRecipientInfo
*kekri
;
402 if (ri
->type
!= CMS_RECIPINFO_KEK
)
404 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ID_CMP
, CMS_R_NOT_KEK
);
408 tmp_os
.type
= V_ASN1_OCTET_STRING
;
410 tmp_os
.data
= (unsigned char *)id
;
411 tmp_os
.length
= (int)idlen
;
412 return ASN1_OCTET_STRING_cmp(&tmp_os
, kekri
->kekid
->keyIdentifier
);
415 /* For now hard code AES key wrap info */
417 static size_t aes_wrap_keylen(int nid
)
421 case NID_id_aes128_wrap
:
424 case NID_id_aes192_wrap
:
427 case NID_id_aes256_wrap
:
435 CMS_RecipientInfo
*CMS_add0_recipient_key(CMS_ContentInfo
*cms
, int nid
,
436 unsigned char *key
, size_t keylen
,
437 unsigned char *id
, size_t idlen
,
438 ASN1_GENERALIZEDTIME
*date
,
439 ASN1_OBJECT
*otherTypeId
,
440 ASN1_TYPE
*otherType
)
442 CMS_RecipientInfo
*ri
= NULL
;
443 CMS_EnvelopedData
*env
;
444 CMS_KEKRecipientInfo
*kekri
;
445 env
= cms_get0_enveloped(cms
);
449 if (nid
== NID_undef
)
454 nid
= NID_id_aes128_wrap
;
458 nid
= NID_id_aes192_wrap
;
462 nid
= NID_id_aes256_wrap
;
466 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY
,
467 CMS_R_INVALID_KEY_LENGTH
);
475 size_t exp_keylen
= aes_wrap_keylen(nid
);
479 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY
,
480 CMS_R_UNSUPPORTED_KEK_ALGORITHM
);
484 if (keylen
!= exp_keylen
)
486 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY
,
487 CMS_R_INVALID_KEY_LENGTH
);
493 /* Initialize recipient info */
494 ri
= M_ASN1_new_of(CMS_RecipientInfo
);
498 ri
->d
.kekri
= M_ASN1_new_of(CMS_KEKRecipientInfo
);
501 ri
->type
= CMS_RECIPINFO_KEK
;
507 kekri
->kekid
->other
= M_ASN1_new_of(CMS_OtherKeyAttribute
);
508 if (kekri
->kekid
->other
== NULL
)
512 if (!sk_CMS_RecipientInfo_push(env
->recipientInfos
, ri
))
516 /* After this point no calls can fail */
521 kekri
->keylen
= keylen
;
523 ASN1_STRING_set0(kekri
->kekid
->keyIdentifier
, id
, idlen
);
525 kekri
->kekid
->date
= date
;
527 if (kekri
->kekid
->other
)
529 kekri
->kekid
->other
->keyAttrId
= otherTypeId
;
530 kekri
->kekid
->other
->keyAttr
= otherType
;
533 X509_ALGOR_set0(kekri
->keyEncryptionAlgorithm
,
534 OBJ_nid2obj(nid
), V_ASN1_UNDEF
, NULL
);
539 CMSerr(CMS_F_CMS_ADD0_RECIPIENT_KEY
, ERR_R_MALLOC_FAILURE
);
542 M_ASN1_free_of(ri
, CMS_RecipientInfo
);
547 int CMS_RecipientInfo_kekri_get0_id(CMS_RecipientInfo
*ri
,
549 ASN1_OCTET_STRING
**pid
,
550 ASN1_GENERALIZEDTIME
**pdate
,
551 ASN1_OBJECT
**potherid
,
552 ASN1_TYPE
**pothertype
)
554 CMS_KEKIdentifier
*rkid
;
555 if (ri
->type
!= CMS_RECIPINFO_KEK
)
557 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_GET0_ID
, CMS_R_NOT_KEK
);
560 rkid
= ri
->d
.kekri
->kekid
;
562 *palg
= ri
->d
.kekri
->keyEncryptionAlgorithm
;
564 *pid
= rkid
->keyIdentifier
;
570 *potherid
= rkid
->other
->keyAttrId
;
577 *pothertype
= rkid
->other
->keyAttr
;
584 int CMS_RecipientInfo_set0_key(CMS_RecipientInfo
*ri
,
585 unsigned char *key
, size_t keylen
)
587 CMS_KEKRecipientInfo
*kekri
;
588 if (ri
->type
!= CMS_RECIPINFO_KEK
)
590 CMSerr(CMS_F_CMS_RECIPIENTINFO_SET0_KEY
, CMS_R_NOT_KEK
);
596 kekri
->keylen
= keylen
;
601 /* Encrypt content key in KEK recipient info */
603 static int cms_RecipientInfo_kekri_encrypt(CMS_ContentInfo
*cms
,
604 CMS_RecipientInfo
*ri
)
606 CMS_EncryptedContentInfo
*ec
;
607 CMS_KEKRecipientInfo
*kekri
;
609 unsigned char *wkey
= NULL
;
613 ec
= cms
->d
.envelopedData
->encryptedContentInfo
;
619 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT
, CMS_R_NO_KEY
);
623 if (AES_set_encrypt_key(kekri
->key
, kekri
->keylen
<< 3, &actx
))
625 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT
,
626 CMS_R_ERROR_SETTING_KEY
);
630 wkey
= OPENSSL_malloc(ec
->keylen
+ 8);
634 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT
,
635 ERR_R_MALLOC_FAILURE
);
639 wkeylen
= AES_wrap_key(&actx
, NULL
, wkey
, ec
->key
, ec
->keylen
);
643 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_ENCRYPT
, CMS_R_WRAP_ERROR
);
647 ASN1_STRING_set0(kekri
->encryptedKey
, wkey
, wkeylen
);
655 OPENSSL_cleanse(&actx
, sizeof(actx
));
661 /* Decrypt content key in KEK recipient info */
663 static int cms_RecipientInfo_kekri_decrypt(CMS_ContentInfo
*cms
,
664 CMS_RecipientInfo
*ri
)
666 CMS_EncryptedContentInfo
*ec
;
667 CMS_KEKRecipientInfo
*kekri
;
669 unsigned char *ukey
= NULL
;
673 ec
= cms
->d
.envelopedData
->encryptedContentInfo
;
679 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT
, CMS_R_NO_KEY
);
683 wrap_nid
= OBJ_obj2nid(kekri
->keyEncryptionAlgorithm
->algorithm
);
684 if (aes_wrap_keylen(wrap_nid
) != kekri
->keylen
)
686 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT
,
687 CMS_R_INVALID_KEY_LENGTH
);
691 /* If encrypted key length is invalid don't bother */
693 if (kekri
->encryptedKey
->length
< 16)
695 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT
,
696 CMS_R_INVALID_ENCRYPTED_KEY_LENGTH
);
700 if (AES_set_decrypt_key(kekri
->key
, kekri
->keylen
<< 3, &actx
))
702 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT
,
703 CMS_R_ERROR_SETTING_KEY
);
707 ukey
= OPENSSL_malloc(kekri
->encryptedKey
->length
- 8);
711 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT
,
712 ERR_R_MALLOC_FAILURE
);
716 ukeylen
= AES_unwrap_key(&actx
, NULL
, ukey
,
717 kekri
->encryptedKey
->data
,
718 kekri
->encryptedKey
->length
);
722 CMSerr(CMS_F_CMS_RECIPIENTINFO_KEKRI_DECRYPT
,
728 ec
->keylen
= ukeylen
;
736 OPENSSL_cleanse(&actx
, sizeof(actx
));
742 int CMS_RecipientInfo_decrypt(CMS_ContentInfo
*cms
, CMS_RecipientInfo
*ri
)
746 case CMS_RECIPINFO_TRANS
:
747 return cms_RecipientInfo_ktri_decrypt(cms
, ri
);
749 case CMS_RECIPINFO_KEK
:
750 return cms_RecipientInfo_kekri_decrypt(cms
, ri
);
753 CMSerr(CMS_F_CMS_RECIPIENTINFO_DECRYPT
,
754 CMS_R_UNSUPPORTED_RECPIENTINFO_TYPE
);
759 BIO
*cms_EnvelopedData_init_bio(CMS_ContentInfo
*cms
)
761 CMS_EncryptedContentInfo
*ec
;
762 STACK_OF(CMS_RecipientInfo
) *rinfos
;
763 CMS_RecipientInfo
*ri
;
767 /* Get BIO first to set up key */
769 ec
= cms
->d
.envelopedData
->encryptedContentInfo
;
770 ret
= cms_EncryptedContent_init_bio(ec
);
772 /* If error or no cipher end of processing */
774 if (!ret
|| !ec
->cipher
)
777 /* Now encrypt content key according to each RecipientInfo type */
779 rinfos
= cms
->d
.envelopedData
->recipientInfos
;
781 for (i
= 0; i
< sk_CMS_RecipientInfo_num(rinfos
); i
++)
783 ri
= sk_CMS_RecipientInfo_value(rinfos
, i
);
787 case CMS_RECIPINFO_TRANS
:
788 r
= cms_RecipientInfo_ktri_encrypt(cms
, ri
);
791 case CMS_RECIPINFO_KEK
:
792 r
= cms_RecipientInfo_kekri_encrypt(cms
, ri
);
796 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO
,
797 CMS_R_UNSUPPORTED_RECIPIENT_TYPE
);
803 CMSerr(CMS_F_CMS_ENVELOPEDDATA_INIT_BIO
,
804 CMS_R_ERROR_SETTING_RECIPIENTINFO
);
815 OPENSSL_cleanse(ec
->key
, ec
->keylen
);
816 OPENSSL_free(ec
->key
);