60ea339aeaa58cba89f70bd86e8a4c392fb37adc
[openssl.git] / crypto / cms / cms_asn1.c
1 /* crypto/cms/cms_asn1.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project.
4  */
5 /* ====================================================================
6  * Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
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
18  *    distribution.
19  *
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/)"
24  *
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.
29  *
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.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
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  * ====================================================================
52  */
53
54 #include <openssl/asn1t.h>
55 #include <openssl/pem.h>
56 #include "cms.h"
57 #include "cms_lcl.h"
58
59
60 ASN1_SEQUENCE(CMS_IssuerAndSerialNumber) = {
61         ASN1_SIMPLE(CMS_IssuerAndSerialNumber, issuer, X509_NAME),
62         ASN1_SIMPLE(CMS_IssuerAndSerialNumber, serialNumber, ASN1_INTEGER)
63 } ASN1_SEQUENCE_END(CMS_IssuerAndSerialNumber)
64
65 ASN1_SEQUENCE(CMS_OtherCertificateFormat) = {
66         ASN1_SIMPLE(CMS_OtherCertificateFormat, otherCertFormat, ASN1_OBJECT),
67         ASN1_OPT(CMS_OtherCertificateFormat, otherCert, ASN1_ANY)
68 } ASN1_SEQUENCE_END(CMS_OtherCertificateFormat)
69
70 ASN1_CHOICE(CMS_CertificateChoices) = {
71         ASN1_SIMPLE(CMS_CertificateChoices, d.certificate, X509),
72         ASN1_IMP(CMS_CertificateChoices, d.extendedCertificate, ASN1_SEQUENCE, 0),
73         ASN1_IMP(CMS_CertificateChoices, d.v1AttrCert, ASN1_SEQUENCE, 1),
74         ASN1_IMP(CMS_CertificateChoices, d.v2AttrCert, ASN1_SEQUENCE, 2),
75         ASN1_IMP(CMS_CertificateChoices, d.other, CMS_OtherCertificateFormat, 3)
76 } ASN1_CHOICE_END(CMS_CertificateChoices)
77
78 ASN1_CHOICE(CMS_SignerIdentifier) = {
79         ASN1_SIMPLE(CMS_SignerIdentifier, d.issuerAndSerialNumber, CMS_IssuerAndSerialNumber),
80         ASN1_IMP(CMS_SignerIdentifier, d.subjectKeyIdentifier, ASN1_OCTET_STRING, 0)
81 } ASN1_CHOICE_END(CMS_SignerIdentifier)
82
83 ASN1_NDEF_SEQUENCE(CMS_EncapsulatedContentInfo) = {
84         ASN1_SIMPLE(CMS_EncapsulatedContentInfo, eContentType, ASN1_OBJECT),
85         ASN1_NDEF_EXP_OPT(CMS_EncapsulatedContentInfo, eContent, ASN1_OCTET_STRING_NDEF, 0)
86 } ASN1_NDEF_SEQUENCE_END(CMS_EncapsulatedContentInfo)
87
88 /* Minor tweak to operation: free up EVP_PKEY */
89 static int cms_si_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
90                                                         void *exarg)
91 {
92         if(operation == ASN1_OP_FREE_POST) {
93                 CMS_SignerInfo *si = (CMS_SignerInfo *)*pval;
94                 if (si->pkey)
95                         EVP_PKEY_free(si->pkey);
96                 if (si->signer)
97                         X509_free(si->signer);
98         }
99         return 1;
100 }
101
102 ASN1_SEQUENCE_cb(CMS_SignerInfo, cms_si_cb) = {
103         ASN1_SIMPLE(CMS_SignerInfo, version, LONG),
104         ASN1_SIMPLE(CMS_SignerInfo, sid, CMS_SignerIdentifier),
105         ASN1_SIMPLE(CMS_SignerInfo, digestAlgorithm, X509_ALGOR),
106         ASN1_IMP_SET_OF_OPT(CMS_SignerInfo, signedAttrs, X509_ATTRIBUTE, 0),
107         ASN1_SIMPLE(CMS_SignerInfo, signatureAlgorithm, X509_ALGOR),
108         ASN1_SIMPLE(CMS_SignerInfo, signature, ASN1_OCTET_STRING),
109         ASN1_IMP_SET_OF_OPT(CMS_SignerInfo, unsignedAttrs, X509_ATTRIBUTE, 1)
110 } ASN1_SEQUENCE_END_cb(CMS_SignerInfo, CMS_SignerInfo)
111
112 ASN1_SEQUENCE(CMS_OtherRevocationInfoFormat) = {
113         ASN1_SIMPLE(CMS_OtherRevocationInfoFormat, otherRevInfoFormat, ASN1_OBJECT),
114         ASN1_OPT(CMS_OtherRevocationInfoFormat, otherRevInfo, ASN1_ANY)
115 } ASN1_SEQUENCE_END(CMS_OtherRevocationInfoFormat)
116
117 ASN1_CHOICE(CMS_RevocationInfoChoice) = {
118         ASN1_SIMPLE(CMS_RevocationInfoChoice, d.crl, X509_CRL),
119         ASN1_IMP(CMS_RevocationInfoChoice, d.other, CMS_OtherRevocationInfoFormat, 1)
120 } ASN1_CHOICE_END(CMS_RevocationInfoChoice)
121
122 ASN1_NDEF_SEQUENCE(CMS_SignedData) = {
123         ASN1_SIMPLE(CMS_SignedData, version, LONG),
124         ASN1_SET_OF(CMS_SignedData, digestAlgorithms, X509_ALGOR),
125         ASN1_SIMPLE(CMS_SignedData, encapContentInfo, CMS_EncapsulatedContentInfo),
126         ASN1_IMP_SET_OF_OPT(CMS_SignedData, certificates, CMS_CertificateChoices, 0),
127         ASN1_IMP_SET_OF_OPT(CMS_SignedData, crls, CMS_RevocationInfoChoice, 1),
128         ASN1_SET_OF(CMS_SignedData, signerInfos, CMS_SignerInfo)
129 } ASN1_NDEF_SEQUENCE_END(CMS_SignedData)
130
131 ASN1_SEQUENCE(CMS_OriginatorInfo) = {
132         ASN1_IMP_SET_OF_OPT(CMS_SignedData, certificates, CMS_CertificateChoices, 0),
133         ASN1_IMP_SET_OF_OPT(CMS_SignedData, crls, CMS_RevocationInfoChoice, 1)
134 } ASN1_SEQUENCE_END(CMS_OriginatorInfo)
135
136 ASN1_NDEF_SEQUENCE(CMS_EncryptedContentInfo) = {
137         ASN1_SIMPLE(CMS_EncryptedContentInfo, contentType, ASN1_OBJECT),
138         ASN1_SIMPLE(CMS_EncryptedContentInfo, contentEncryptionAlgorithm, X509_ALGOR),
139         ASN1_IMP_OPT(CMS_EncryptedContentInfo, encryptedContent, ASN1_OCTET_STRING_NDEF, 0)
140 } ASN1_NDEF_SEQUENCE_END(CMS_EncryptedContentInfo)
141
142 ASN1_SEQUENCE(CMS_KeyTransRecipientInfo) = {
143         ASN1_SIMPLE(CMS_KeyTransRecipientInfo, version, LONG),
144         ASN1_SIMPLE(CMS_KeyTransRecipientInfo, rid, CMS_SignerIdentifier),
145         ASN1_SIMPLE(CMS_KeyTransRecipientInfo, keyEncryptionAlgorithm, X509_ALGOR),
146         ASN1_SIMPLE(CMS_KeyTransRecipientInfo, encryptedKey, ASN1_OCTET_STRING)
147 } ASN1_SEQUENCE_END(CMS_KeyTransRecipientInfo)
148
149 ASN1_SEQUENCE(CMS_OtherKeyAttribute) = {
150         ASN1_SIMPLE(CMS_OtherKeyAttribute, keyAttrId, ASN1_OBJECT),
151         ASN1_OPT(CMS_OtherKeyAttribute, keyAttr, ASN1_ANY)
152 } ASN1_SEQUENCE_END(CMS_OtherKeyAttribute)
153
154 ASN1_SEQUENCE(CMS_RecipientKeyIdentifier) = {
155         ASN1_SIMPLE(CMS_RecipientKeyIdentifier, subjectKeyIdentifier, ASN1_OCTET_STRING),
156         ASN1_OPT(CMS_RecipientKeyIdentifier, date, ASN1_GENERALIZEDTIME),
157         ASN1_OPT(CMS_RecipientKeyIdentifier, other, CMS_OtherKeyAttribute)
158 } ASN1_SEQUENCE_END(CMS_RecipientKeyIdentifier)
159
160 ASN1_CHOICE(CMS_KeyAgreeRecipientIdentifier) = {
161   ASN1_SIMPLE(CMS_KeyAgreeRecipientIdentifier, d.issuerAndSerialNumber, CMS_IssuerAndSerialNumber),
162   ASN1_IMP(CMS_KeyAgreeRecipientIdentifier, d.rKeyId, CMS_RecipientKeyIdentifier, 0)
163 } ASN1_CHOICE_END(CMS_KeyAgreeRecipientIdentifier)
164
165 ASN1_SEQUENCE(CMS_RecipientEncryptedKey) = {
166         ASN1_SIMPLE(CMS_RecipientEncryptedKey, rid, CMS_KeyAgreeRecipientIdentifier),
167         ASN1_SIMPLE(CMS_RecipientEncryptedKey, encryptedKey, ASN1_OCTET_STRING)
168 } ASN1_SEQUENCE_END(CMS_RecipientEncryptedKey)
169
170 ASN1_SEQUENCE(CMS_OriginatorPublicKey) = {
171   ASN1_SIMPLE(CMS_OriginatorPublicKey, algorithm, X509_ALGOR),
172   ASN1_SIMPLE(CMS_OriginatorPublicKey, publicKey, ASN1_BIT_STRING)
173 } ASN1_SEQUENCE_END(CMS_OriginatorPublicKey)
174
175 ASN1_CHOICE(CMS_OriginatorIdentifierOrKey) = {
176   ASN1_SIMPLE(CMS_OriginatorIdentifierOrKey, d.issuerAndSerialNumber, CMS_IssuerAndSerialNumber),
177   ASN1_IMP(CMS_OriginatorIdentifierOrKey, d.subjectKeyIdentifier, ASN1_OCTET_STRING, 0),
178   ASN1_IMP(CMS_OriginatorIdentifierOrKey, d.originatorKey, CMS_OriginatorPublicKey, 1)
179 } ASN1_CHOICE_END(CMS_OriginatorIdentifierOrKey)
180
181 ASN1_SEQUENCE(CMS_KeyAgreeRecipientInfo) = {
182         ASN1_SIMPLE(CMS_KeyAgreeRecipientInfo, version, LONG),
183         ASN1_EXP(CMS_KeyAgreeRecipientInfo, originator, CMS_OriginatorIdentifierOrKey, 0),
184         ASN1_EXP_OPT(CMS_KeyAgreeRecipientInfo, ukm, ASN1_OCTET_STRING, 1),
185         ASN1_SIMPLE(CMS_KeyAgreeRecipientInfo, keyEncryptionAlgorithm, X509_ALGOR),
186         ASN1_SEQUENCE_OF(CMS_KeyAgreeRecipientInfo, recipientEncryptedKeys, CMS_RecipientEncryptedKey)
187 } ASN1_SEQUENCE_END(CMS_KeyAgreeRecipientInfo)
188
189 ASN1_SEQUENCE(CMS_KEKIdentifier) = {
190         ASN1_SIMPLE(CMS_KEKIdentifier, keyIdentifier, ASN1_OCTET_STRING),
191         ASN1_OPT(CMS_KEKIdentifier, date, ASN1_GENERALIZEDTIME),
192         ASN1_OPT(CMS_KEKIdentifier, other, CMS_OtherKeyAttribute)
193 } ASN1_SEQUENCE_END(CMS_KEKIdentifier)
194
195 ASN1_SEQUENCE(CMS_KEKRecipientInfo) = {
196         ASN1_SIMPLE(CMS_KEKRecipientInfo, version, LONG),
197         ASN1_SIMPLE(CMS_KEKRecipientInfo, kekid, CMS_KEKIdentifier),
198         ASN1_SIMPLE(CMS_KEKRecipientInfo, keyEncryptionAlgorithm, X509_ALGOR),
199         ASN1_SIMPLE(CMS_KEKRecipientInfo, encryptedKey, ASN1_OCTET_STRING)
200 } ASN1_SEQUENCE_END(CMS_KEKRecipientInfo)
201
202 ASN1_SEQUENCE(CMS_PasswordRecipientInfo) = {
203         ASN1_SIMPLE(CMS_PasswordRecipientInfo, version, LONG),
204         ASN1_IMP_OPT(CMS_PasswordRecipientInfo, keyDerivationAlgorithm, X509_ALGOR, 0),
205         ASN1_SIMPLE(CMS_PasswordRecipientInfo, keyEncryptionAlgorithm, X509_ALGOR),
206         ASN1_SIMPLE(CMS_PasswordRecipientInfo, encryptedKey, ASN1_OCTET_STRING)
207 } ASN1_SEQUENCE_END(CMS_PasswordRecipientInfo)
208
209 ASN1_SEQUENCE(CMS_OtherRecipientInfo) = {
210   ASN1_SIMPLE(CMS_OtherRecipientInfo, oriType, ASN1_OBJECT),
211   ASN1_OPT(CMS_OtherRecipientInfo, oriValue, ASN1_ANY)
212 } ASN1_SEQUENCE_END(CMS_OtherRecipientInfo)
213
214 ASN1_CHOICE(CMS_RecipientInfo) = {
215         ASN1_SIMPLE(CMS_RecipientInfo, d.ktri, CMS_KeyTransRecipientInfo),
216         ASN1_IMP(CMS_RecipientInfo, d.kari, CMS_KeyAgreeRecipientInfo, 1),
217         ASN1_IMP(CMS_RecipientInfo, d.kekri, CMS_KEKRecipientInfo, 2),
218         ASN1_IMP(CMS_RecipientInfo, d.pwri, CMS_PasswordRecipientInfo, 3),
219         ASN1_IMP(CMS_RecipientInfo, d.ori, CMS_OtherRecipientInfo, 4)
220 } ASN1_CHOICE_END(CMS_RecipientInfo)
221
222 ASN1_NDEF_SEQUENCE(CMS_EnvelopedData) = {
223         ASN1_SIMPLE(CMS_EnvelopedData, version, LONG),
224         ASN1_IMP_OPT(CMS_EnvelopedData, originatorInfo, CMS_OriginatorInfo, 0),
225         ASN1_SET_OF(CMS_EnvelopedData, recipientInfos, CMS_RecipientInfo),
226         ASN1_SIMPLE(CMS_EnvelopedData, encryptedContentInfo, CMS_EncryptedContentInfo),
227         ASN1_IMP_SET_OF_OPT(CMS_EnvelopedData, unprotectedAttrs, X509_ATTRIBUTE, 1)
228 } ASN1_NDEF_SEQUENCE_END(CMS_EnvelopedData)
229
230 ASN1_NDEF_SEQUENCE(CMS_DigestedData) = {
231         ASN1_SIMPLE(CMS_DigestedData, version, LONG),
232         ASN1_SIMPLE(CMS_DigestedData, digestAlgorithm, X509_ALGOR),
233         ASN1_SIMPLE(CMS_DigestedData, encapContentInfo, CMS_EncapsulatedContentInfo),
234         ASN1_SIMPLE(CMS_DigestedData, digest, ASN1_OCTET_STRING)
235 } ASN1_NDEF_SEQUENCE_END(CMS_DigestedData)
236
237 ASN1_NDEF_SEQUENCE(CMS_EncryptedData) = {
238         ASN1_SIMPLE(CMS_EncryptedData, version, LONG),
239         ASN1_SIMPLE(CMS_EncryptedData, encryptedContentInfo, CMS_EncryptedContentInfo),
240         ASN1_IMP_SET_OF_OPT(CMS_EncryptedData, unprotectedAttrs, X509_ATTRIBUTE, 1)
241 } ASN1_NDEF_SEQUENCE_END(CMS_EncryptedData)
242
243 ASN1_NDEF_SEQUENCE(CMS_AuthenticatedData) = {
244         ASN1_SIMPLE(CMS_AuthenticatedData, version, LONG),
245         ASN1_IMP_OPT(CMS_AuthenticatedData, originatorInfo, CMS_OriginatorInfo, 0),
246         ASN1_SET_OF(CMS_AuthenticatedData, recipientInfos, CMS_RecipientInfo),
247         ASN1_SIMPLE(CMS_AuthenticatedData, macAlgorithm, X509_ALGOR),
248         ASN1_IMP(CMS_AuthenticatedData, digestAlgorithm, X509_ALGOR, 1),
249         ASN1_SIMPLE(CMS_AuthenticatedData, encapContentInfo, CMS_EncapsulatedContentInfo),
250         ASN1_IMP_SET_OF_OPT(CMS_AuthenticatedData, authAttrs, X509_ALGOR, 2),
251         ASN1_SIMPLE(CMS_AuthenticatedData, mac, ASN1_OCTET_STRING),
252         ASN1_IMP_SET_OF_OPT(CMS_AuthenticatedData, unauthAttrs, X509_ALGOR, 3)
253 } ASN1_NDEF_SEQUENCE_END(CMS_AuthenticatedData)
254
255 ASN1_NDEF_SEQUENCE(CMS_CompressedData) = {
256         ASN1_SIMPLE(CMS_CompressedData, version, LONG),
257         ASN1_SIMPLE(CMS_CompressedData, compressionAlgorithm, X509_ALGOR),
258         ASN1_SIMPLE(CMS_CompressedData, encapContentInfo, CMS_EncapsulatedContentInfo),
259 } ASN1_NDEF_SEQUENCE_END(CMS_CompressedData)
260
261 /* This is the ANY DEFINED BY table for the top level ContentInfo structure */
262
263 ASN1_ADB_TEMPLATE(cms_default) = ASN1_EXP(CMS_ContentInfo, d.other, ASN1_ANY, 0);
264
265 ASN1_ADB(CMS_ContentInfo) = {
266         ADB_ENTRY(NID_pkcs7_data, ASN1_NDEF_EXP(CMS_ContentInfo, d.data, ASN1_OCTET_STRING_NDEF, 0)),
267         ADB_ENTRY(NID_pkcs7_signed, ASN1_NDEF_EXP(CMS_ContentInfo, d.signedData, CMS_SignedData, 0)),
268         ADB_ENTRY(NID_pkcs7_enveloped, ASN1_NDEF_EXP(CMS_ContentInfo, d.envelopedData, CMS_EnvelopedData, 0)),
269         ADB_ENTRY(NID_pkcs7_digest, ASN1_NDEF_EXP(CMS_ContentInfo, d.digestedData, CMS_DigestedData, 0)),
270         ADB_ENTRY(NID_pkcs7_encrypted, ASN1_NDEF_EXP(CMS_ContentInfo, d.encryptedData, CMS_EncryptedData, 0)),
271         ADB_ENTRY(NID_id_smime_ct_authData, ASN1_NDEF_EXP(CMS_ContentInfo, d.authenticatedData, CMS_AuthenticatedData, 0)),
272         ADB_ENTRY(NID_id_smime_ct_compressedData, ASN1_NDEF_EXP(CMS_ContentInfo, d.compressedData, CMS_CompressedData, 0)),
273 } ASN1_ADB_END(CMS_ContentInfo, 0, contentType, 0, &cms_default_tt, NULL);
274
275 /* CMS streaming support */
276 static int cms_cb(int operation, ASN1_VALUE **pval, const ASN1_ITEM *it,
277                                                         void *exarg)
278 {
279         ASN1_STREAM_ARG *sarg = exarg;
280         CMS_ContentInfo *cms;
281         if (pval)
282                 cms = (CMS_ContentInfo *)*pval;
283         switch(operation)
284                 {
285
286                 case ASN1_OP_STREAM_PRE:
287                 if (CMS_stream(&sarg->boundary, cms) <= 0)
288                         return 0;
289                 case ASN1_OP_DETACHED_PRE:
290                 sarg->ndef_bio = CMS_dataInit(cms, sarg->out);
291                 if (!sarg->ndef_bio)
292                         return 0;
293                 break;
294
295                 case ASN1_OP_STREAM_POST:
296                 case ASN1_OP_DETACHED_POST:
297                 if (CMS_dataFinal(cms, sarg->ndef_bio) <= 0)
298                         return 0;
299                 break;
300
301                 }
302         return 1;
303 }
304
305 ASN1_NDEF_SEQUENCE_cb(CMS_ContentInfo, cms_cb) = {
306         ASN1_SIMPLE(CMS_ContentInfo, contentType, ASN1_OBJECT),
307         ASN1_ADB_OBJECT(CMS_ContentInfo)
308 } ASN1_NDEF_SEQUENCE_END_cb(CMS_ContentInfo, CMS_ContentInfo)
309
310 /* Specials for signed attributes */
311
312 /* When signing attributes we want to reorder them to match the sorted
313  * encoding.
314  */
315
316 ASN1_ITEM_TEMPLATE(CMS_Attributes_Sign) = 
317         ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SET_ORDER, 0, CMS_ATTRIBUTES, X509_ATTRIBUTE)
318 ASN1_ITEM_TEMPLATE_END(CMS_Attributes_Sign)
319
320 /* When verifying attributes we need to use the received order. So 
321  * we use SEQUENCE OF and tag it to SET OF
322  */
323
324 ASN1_ITEM_TEMPLATE(CMS_Attributes_Verify) = 
325         ASN1_EX_TEMPLATE_TYPE(ASN1_TFLG_SEQUENCE_OF | ASN1_TFLG_IMPTAG | ASN1_TFLG_UNIVERSAL,
326                                 V_ASN1_SET, CMS_ATTRIBUTES, X509_ATTRIBUTE)
327 ASN1_ITEM_TEMPLATE_END(CMS_Attributes_Verify)
328