8525ff8cf6020c9cd9ef3fb5e252245811785725
[openssl.git] / crypto / cms / cms_lib.c
1 /* crypto/cms/cms_lib.c */
2 /*
3  * Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
4  * project.
5  */
6 /* ====================================================================
7  * Copyright (c) 2008 The OpenSSL Project.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in
18  *    the documentation and/or other materials provided with the
19  *    distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *    software must display the following acknowledgment:
23  *    "This product includes software developed by the OpenSSL Project
24  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *    endorse or promote products derived from this software without
28  *    prior written permission. For written permission, please contact
29  *    licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *    nor may "OpenSSL" appear in their names without prior written
33  *    permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *    acknowledgment:
37  *    "This product includes software developed by the OpenSSL Project
38  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  */
54
55 #include <openssl/asn1t.h>
56 #include <openssl/x509v3.h>
57 #include <openssl/err.h>
58 #include <openssl/pem.h>
59 #include <openssl/bio.h>
60 #include <openssl/asn1.h>
61 #include <openssl/cms.h>
62 #include "cms_lcl.h"
63
64 IMPLEMENT_ASN1_FUNCTIONS(CMS_ContentInfo)
65 IMPLEMENT_ASN1_PRINT_FUNCTION(CMS_ContentInfo)
66
67 DECLARE_ASN1_ITEM(CMS_CertificateChoices)
68 DECLARE_ASN1_ITEM(CMS_RevocationInfoChoice)
69 DECLARE_STACK_OF(CMS_CertificateChoices)
70 DECLARE_STACK_OF(CMS_RevocationInfoChoice)
71
72 const ASN1_OBJECT *CMS_get0_type(CMS_ContentInfo *cms)
73 {
74     return cms->contentType;
75 }
76
77 CMS_ContentInfo *cms_Data_create(void)
78 {
79     CMS_ContentInfo *cms;
80     cms = CMS_ContentInfo_new();
81     if (cms) {
82         cms->contentType = OBJ_nid2obj(NID_pkcs7_data);
83         /* Never detached */
84         CMS_set_detached(cms, 0);
85     }
86     return cms;
87 }
88
89 BIO *cms_content_bio(CMS_ContentInfo *cms)
90 {
91     ASN1_OCTET_STRING **pos = CMS_get0_content(cms);
92     if (!pos)
93         return NULL;
94     /* If content detached data goes nowhere: create NULL BIO */
95     if (!*pos)
96         return BIO_new(BIO_s_null());
97     /*
98      * If content not detached and created return memory BIO
99      */
100     if (!*pos || ((*pos)->flags == ASN1_STRING_FLAG_CONT))
101         return BIO_new(BIO_s_mem());
102     /* Else content was read in: return read only BIO for it */
103     return BIO_new_mem_buf((*pos)->data, (*pos)->length);
104 }
105
106 BIO *CMS_dataInit(CMS_ContentInfo *cms, BIO *icont)
107 {
108     BIO *cmsbio, *cont;
109     if (icont)
110         cont = icont;
111     else
112         cont = cms_content_bio(cms);
113     if (!cont) {
114         CMSerr(CMS_F_CMS_DATAINIT, CMS_R_NO_CONTENT);
115         return NULL;
116     }
117     switch (OBJ_obj2nid(cms->contentType)) {
118
119     case NID_pkcs7_data:
120         return cont;
121
122     case NID_pkcs7_signed:
123         cmsbio = cms_SignedData_init_bio(cms);
124         break;
125
126     case NID_pkcs7_digest:
127         cmsbio = cms_DigestedData_init_bio(cms);
128         break;
129 #ifdef ZLIB
130     case NID_id_smime_ct_compressedData:
131         cmsbio = cms_CompressedData_init_bio(cms);
132         break;
133 #endif
134
135     case NID_pkcs7_encrypted:
136         cmsbio = cms_EncryptedData_init_bio(cms);
137         break;
138
139     case NID_pkcs7_enveloped:
140         cmsbio = cms_EnvelopedData_init_bio(cms);
141         break;
142
143     default:
144         CMSerr(CMS_F_CMS_DATAINIT, CMS_R_UNSUPPORTED_TYPE);
145         return NULL;
146     }
147
148     if (cmsbio)
149         return BIO_push(cmsbio, cont);
150
151     if (!icont)
152         BIO_free(cont);
153     return NULL;
154
155 }
156
157 int CMS_dataFinal(CMS_ContentInfo *cms, BIO *cmsbio)
158 {
159     ASN1_OCTET_STRING **pos = CMS_get0_content(cms);
160     if (!pos)
161         return 0;
162     /* If ebmedded content find memory BIO and set content */
163     if (*pos && ((*pos)->flags & ASN1_STRING_FLAG_CONT)) {
164         BIO *mbio;
165         unsigned char *cont;
166         long contlen;
167         mbio = BIO_find_type(cmsbio, BIO_TYPE_MEM);
168         if (!mbio) {
169             CMSerr(CMS_F_CMS_DATAFINAL, CMS_R_CONTENT_NOT_FOUND);
170             return 0;
171         }
172         contlen = BIO_get_mem_data(mbio, &cont);
173         /* Set bio as read only so its content can't be clobbered */
174         BIO_set_flags(mbio, BIO_FLAGS_MEM_RDONLY);
175         BIO_set_mem_eof_return(mbio, 0);
176         ASN1_STRING_set0(*pos, cont, contlen);
177         (*pos)->flags &= ~ASN1_STRING_FLAG_CONT;
178     }
179
180     switch (OBJ_obj2nid(cms->contentType)) {
181
182     case NID_pkcs7_data:
183     case NID_pkcs7_enveloped:
184     case NID_pkcs7_encrypted:
185     case NID_id_smime_ct_compressedData:
186         /* Nothing to do */
187         return 1;
188
189     case NID_pkcs7_signed:
190         return cms_SignedData_final(cms, cmsbio);
191
192     case NID_pkcs7_digest:
193         return cms_DigestedData_do_final(cms, cmsbio, 0);
194
195     default:
196         CMSerr(CMS_F_CMS_DATAFINAL, CMS_R_UNSUPPORTED_TYPE);
197         return 0;
198     }
199 }
200
201 /*
202  * Return an OCTET STRING pointer to content. This allows it to be accessed
203  * or set later.
204  */
205
206 ASN1_OCTET_STRING **CMS_get0_content(CMS_ContentInfo *cms)
207 {
208     switch (OBJ_obj2nid(cms->contentType)) {
209
210     case NID_pkcs7_data:
211         return &cms->d.data;
212
213     case NID_pkcs7_signed:
214         return &cms->d.signedData->encapContentInfo->eContent;
215
216     case NID_pkcs7_enveloped:
217         return &cms->d.envelopedData->encryptedContentInfo->encryptedContent;
218
219     case NID_pkcs7_digest:
220         return &cms->d.digestedData->encapContentInfo->eContent;
221
222     case NID_pkcs7_encrypted:
223         return &cms->d.encryptedData->encryptedContentInfo->encryptedContent;
224
225     case NID_id_smime_ct_authData:
226         return &cms->d.authenticatedData->encapContentInfo->eContent;
227
228     case NID_id_smime_ct_compressedData:
229         return &cms->d.compressedData->encapContentInfo->eContent;
230
231     default:
232         if (cms->d.other->type == V_ASN1_OCTET_STRING)
233             return &cms->d.other->value.octet_string;
234         CMSerr(CMS_F_CMS_GET0_CONTENT, CMS_R_UNSUPPORTED_CONTENT_TYPE);
235         return NULL;
236
237     }
238 }
239
240 /*
241  * Return an ASN1_OBJECT pointer to content type. This allows it to be
242  * accessed or set later.
243  */
244
245 static ASN1_OBJECT **cms_get0_econtent_type(CMS_ContentInfo *cms)
246 {
247     switch (OBJ_obj2nid(cms->contentType)) {
248
249     case NID_pkcs7_signed:
250         return &cms->d.signedData->encapContentInfo->eContentType;
251
252     case NID_pkcs7_enveloped:
253         return &cms->d.envelopedData->encryptedContentInfo->contentType;
254
255     case NID_pkcs7_digest:
256         return &cms->d.digestedData->encapContentInfo->eContentType;
257
258     case NID_pkcs7_encrypted:
259         return &cms->d.encryptedData->encryptedContentInfo->contentType;
260
261     case NID_id_smime_ct_authData:
262         return &cms->d.authenticatedData->encapContentInfo->eContentType;
263
264     case NID_id_smime_ct_compressedData:
265         return &cms->d.compressedData->encapContentInfo->eContentType;
266
267     default:
268         CMSerr(CMS_F_CMS_GET0_ECONTENT_TYPE, CMS_R_UNSUPPORTED_CONTENT_TYPE);
269         return NULL;
270
271     }
272 }
273
274 const ASN1_OBJECT *CMS_get0_eContentType(CMS_ContentInfo *cms)
275 {
276     ASN1_OBJECT **petype;
277     petype = cms_get0_econtent_type(cms);
278     if (petype)
279         return *petype;
280     return NULL;
281 }
282
283 int CMS_set1_eContentType(CMS_ContentInfo *cms, const ASN1_OBJECT *oid)
284 {
285     ASN1_OBJECT **petype, *etype;
286     petype = cms_get0_econtent_type(cms);
287     if (!petype)
288         return 0;
289     if (!oid)
290         return 1;
291     etype = OBJ_dup(oid);
292     if (!etype)
293         return 0;
294     ASN1_OBJECT_free(*petype);
295     *petype = etype;
296     return 1;
297 }
298
299 int CMS_is_detached(CMS_ContentInfo *cms)
300 {
301     ASN1_OCTET_STRING **pos;
302     pos = CMS_get0_content(cms);
303     if (!pos)
304         return -1;
305     if (*pos)
306         return 0;
307     return 1;
308 }
309
310 int CMS_set_detached(CMS_ContentInfo *cms, int detached)
311 {
312     ASN1_OCTET_STRING **pos;
313     pos = CMS_get0_content(cms);
314     if (!pos)
315         return 0;
316     if (detached) {
317         ASN1_OCTET_STRING_free(*pos);
318         *pos = NULL;
319         return 1;
320     }
321     if (!*pos)
322         *pos = ASN1_OCTET_STRING_new();
323     if (*pos) {
324         /*
325          * NB: special flag to show content is created and not read in.
326          */
327         (*pos)->flags |= ASN1_STRING_FLAG_CONT;
328         return 1;
329     }
330     CMSerr(CMS_F_CMS_SET_DETACHED, ERR_R_MALLOC_FAILURE);
331     return 0;
332 }
333
334 /* Create a digest BIO from an X509_ALGOR structure */
335
336 BIO *cms_DigestAlgorithm_init_bio(X509_ALGOR *digestAlgorithm)
337 {
338     BIO *mdbio = NULL;
339     ASN1_OBJECT *digestoid;
340     const EVP_MD *digest;
341     X509_ALGOR_get0(&digestoid, NULL, NULL, digestAlgorithm);
342     digest = EVP_get_digestbyobj(digestoid);
343     if (!digest) {
344         CMSerr(CMS_F_CMS_DIGESTALGORITHM_INIT_BIO,
345                CMS_R_UNKNOWN_DIGEST_ALGORIHM);
346         goto err;
347     }
348     mdbio = BIO_new(BIO_f_md());
349     if (!mdbio || !BIO_set_md(mdbio, digest)) {
350         CMSerr(CMS_F_CMS_DIGESTALGORITHM_INIT_BIO, CMS_R_MD_BIO_INIT_ERROR);
351         goto err;
352     }
353     return mdbio;
354  err:
355     BIO_free(mdbio);
356     return NULL;
357 }
358
359 /* Locate a message digest content from a BIO chain based on SignerInfo */
360
361 int cms_DigestAlgorithm_find_ctx(EVP_MD_CTX *mctx, BIO *chain,
362                                  X509_ALGOR *mdalg)
363 {
364     int nid;
365     ASN1_OBJECT *mdoid;
366     X509_ALGOR_get0(&mdoid, NULL, NULL, mdalg);
367     nid = OBJ_obj2nid(mdoid);
368     /* Look for digest type to match signature */
369     for (;;) {
370         EVP_MD_CTX *mtmp;
371         chain = BIO_find_type(chain, BIO_TYPE_MD);
372         if (chain == NULL) {
373             CMSerr(CMS_F_CMS_DIGESTALGORITHM_FIND_CTX,
374                    CMS_R_NO_MATCHING_DIGEST);
375             return 0;
376         }
377         BIO_get_md_ctx(chain, &mtmp);
378         if (EVP_MD_CTX_type(mtmp) == nid
379             /*
380              * Workaround for broken implementations that use signature
381              * algorithm OID instead of digest.
382              */
383             || EVP_MD_pkey_type(EVP_MD_CTX_md(mtmp)) == nid)
384             return EVP_MD_CTX_copy_ex(mctx, mtmp);
385         chain = BIO_next(chain);
386     }
387 }
388
389 static STACK_OF(CMS_CertificateChoices)
390 **cms_get0_certificate_choices(CMS_ContentInfo *cms)
391 {
392     switch (OBJ_obj2nid(cms->contentType)) {
393
394     case NID_pkcs7_signed:
395         return &cms->d.signedData->certificates;
396
397     case NID_pkcs7_enveloped:
398         return &cms->d.envelopedData->originatorInfo->certificates;
399
400     default:
401         CMSerr(CMS_F_CMS_GET0_CERTIFICATE_CHOICES,
402                CMS_R_UNSUPPORTED_CONTENT_TYPE);
403         return NULL;
404
405     }
406 }
407
408 CMS_CertificateChoices *CMS_add0_CertificateChoices(CMS_ContentInfo *cms)
409 {
410     STACK_OF(CMS_CertificateChoices) **pcerts;
411     CMS_CertificateChoices *cch;
412     pcerts = cms_get0_certificate_choices(cms);
413     if (!pcerts)
414         return NULL;
415     if (!*pcerts)
416         *pcerts = sk_CMS_CertificateChoices_new_null();
417     if (!*pcerts)
418         return NULL;
419     cch = M_ASN1_new_of(CMS_CertificateChoices);
420     if (!cch)
421         return NULL;
422     if (!sk_CMS_CertificateChoices_push(*pcerts, cch)) {
423         M_ASN1_free_of(cch, CMS_CertificateChoices);
424         return NULL;
425     }
426     return cch;
427 }
428
429 int CMS_add0_cert(CMS_ContentInfo *cms, X509 *cert)
430 {
431     CMS_CertificateChoices *cch;
432     STACK_OF(CMS_CertificateChoices) **pcerts;
433     int i;
434     pcerts = cms_get0_certificate_choices(cms);
435     if (!pcerts)
436         return 0;
437     for (i = 0; i < sk_CMS_CertificateChoices_num(*pcerts); i++) {
438         cch = sk_CMS_CertificateChoices_value(*pcerts, i);
439         if (cch->type == CMS_CERTCHOICE_CERT) {
440             if (!X509_cmp(cch->d.certificate, cert)) {
441                 CMSerr(CMS_F_CMS_ADD0_CERT,
442                        CMS_R_CERTIFICATE_ALREADY_PRESENT);
443                 return 0;
444             }
445         }
446     }
447     cch = CMS_add0_CertificateChoices(cms);
448     if (!cch)
449         return 0;
450     cch->type = CMS_CERTCHOICE_CERT;
451     cch->d.certificate = cert;
452     return 1;
453 }
454
455 int CMS_add1_cert(CMS_ContentInfo *cms, X509 *cert)
456 {
457     int r;
458     r = CMS_add0_cert(cms, cert);
459     if (r > 0)
460         CRYPTO_add(&cert->references, 1, CRYPTO_LOCK_X509);
461     return r;
462 }
463
464 static STACK_OF(CMS_RevocationInfoChoice)
465 **cms_get0_revocation_choices(CMS_ContentInfo *cms)
466 {
467     switch (OBJ_obj2nid(cms->contentType)) {
468
469     case NID_pkcs7_signed:
470         return &cms->d.signedData->crls;
471
472     case NID_pkcs7_enveloped:
473         return &cms->d.envelopedData->originatorInfo->crls;
474
475     default:
476         CMSerr(CMS_F_CMS_GET0_REVOCATION_CHOICES,
477                CMS_R_UNSUPPORTED_CONTENT_TYPE);
478         return NULL;
479
480     }
481 }
482
483 CMS_RevocationInfoChoice *CMS_add0_RevocationInfoChoice(CMS_ContentInfo *cms)
484 {
485     STACK_OF(CMS_RevocationInfoChoice) **pcrls;
486     CMS_RevocationInfoChoice *rch;
487     pcrls = cms_get0_revocation_choices(cms);
488     if (!pcrls)
489         return NULL;
490     if (!*pcrls)
491         *pcrls = sk_CMS_RevocationInfoChoice_new_null();
492     if (!*pcrls)
493         return NULL;
494     rch = M_ASN1_new_of(CMS_RevocationInfoChoice);
495     if (!rch)
496         return NULL;
497     if (!sk_CMS_RevocationInfoChoice_push(*pcrls, rch)) {
498         M_ASN1_free_of(rch, CMS_RevocationInfoChoice);
499         return NULL;
500     }
501     return rch;
502 }
503
504 int CMS_add0_crl(CMS_ContentInfo *cms, X509_CRL *crl)
505 {
506     CMS_RevocationInfoChoice *rch;
507     rch = CMS_add0_RevocationInfoChoice(cms);
508     if (!rch)
509         return 0;
510     rch->type = CMS_REVCHOICE_CRL;
511     rch->d.crl = crl;
512     return 1;
513 }
514
515 int CMS_add1_crl(CMS_ContentInfo *cms, X509_CRL *crl)
516 {
517     int r;
518     r = CMS_add0_crl(cms, crl);
519     if (r > 0)
520         CRYPTO_add(&crl->references, 1, CRYPTO_LOCK_X509_CRL);
521     return r;
522 }
523
524 STACK_OF(X509) *CMS_get1_certs(CMS_ContentInfo *cms)
525 {
526     STACK_OF(X509) *certs = NULL;
527     CMS_CertificateChoices *cch;
528     STACK_OF(CMS_CertificateChoices) **pcerts;
529     int i;
530     pcerts = cms_get0_certificate_choices(cms);
531     if (!pcerts)
532         return NULL;
533     for (i = 0; i < sk_CMS_CertificateChoices_num(*pcerts); i++) {
534         cch = sk_CMS_CertificateChoices_value(*pcerts, i);
535         if (cch->type == 0) {
536             if (!certs) {
537                 certs = sk_X509_new_null();
538                 if (!certs)
539                     return NULL;
540             }
541             if (!sk_X509_push(certs, cch->d.certificate)) {
542                 sk_X509_pop_free(certs, X509_free);
543                 return NULL;
544             }
545             CRYPTO_add(&cch->d.certificate->references, 1, CRYPTO_LOCK_X509);
546         }
547     }
548     return certs;
549
550 }
551
552 STACK_OF(X509_CRL) *CMS_get1_crls(CMS_ContentInfo *cms)
553 {
554     STACK_OF(X509_CRL) *crls = NULL;
555     STACK_OF(CMS_RevocationInfoChoice) **pcrls;
556     CMS_RevocationInfoChoice *rch;
557     int i;
558     pcrls = cms_get0_revocation_choices(cms);
559     if (!pcrls)
560         return NULL;
561     for (i = 0; i < sk_CMS_RevocationInfoChoice_num(*pcrls); i++) {
562         rch = sk_CMS_RevocationInfoChoice_value(*pcrls, i);
563         if (rch->type == 0) {
564             if (!crls) {
565                 crls = sk_X509_CRL_new_null();
566                 if (!crls)
567                     return NULL;
568             }
569             if (!sk_X509_CRL_push(crls, rch->d.crl)) {
570                 sk_X509_CRL_pop_free(crls, X509_CRL_free);
571                 return NULL;
572             }
573             CRYPTO_add(&rch->d.crl->references, 1, CRYPTO_LOCK_X509_CRL);
574         }
575     }
576     return crls;
577 }
578
579 int cms_ias_cert_cmp(CMS_IssuerAndSerialNumber *ias, X509 *cert)
580 {
581     int ret;
582     ret = X509_NAME_cmp(ias->issuer, X509_get_issuer_name(cert));
583     if (ret)
584         return ret;
585     return ASN1_INTEGER_cmp(ias->serialNumber, X509_get_serialNumber(cert));
586 }
587
588 int cms_keyid_cert_cmp(ASN1_OCTET_STRING *keyid, X509 *cert)
589 {
590     X509_check_purpose(cert, -1, -1);
591     if (!cert->skid)
592         return -1;
593     return ASN1_OCTET_STRING_cmp(keyid, cert->skid);
594 }
595
596 int cms_set1_ias(CMS_IssuerAndSerialNumber **pias, X509 *cert)
597 {
598     CMS_IssuerAndSerialNumber *ias;
599     ias = M_ASN1_new_of(CMS_IssuerAndSerialNumber);
600     if (!ias)
601         goto err;
602     if (!X509_NAME_set(&ias->issuer, X509_get_issuer_name(cert)))
603         goto err;
604     if (!ASN1_STRING_copy(ias->serialNumber, X509_get_serialNumber(cert)))
605         goto err;
606     M_ASN1_free_of(*pias, CMS_IssuerAndSerialNumber);
607     *pias = ias;
608     return 1;
609  err:
610     M_ASN1_free_of(ias, CMS_IssuerAndSerialNumber);
611     CMSerr(CMS_F_CMS_SET1_IAS, ERR_R_MALLOC_FAILURE);
612     return 0;
613 }
614
615 int cms_set1_keyid(ASN1_OCTET_STRING **pkeyid, X509 *cert)
616 {
617     ASN1_OCTET_STRING *keyid = NULL;
618     X509_check_purpose(cert, -1, -1);
619     if (!cert->skid) {
620         CMSerr(CMS_F_CMS_SET1_KEYID, CMS_R_CERTIFICATE_HAS_NO_KEYID);
621         return 0;
622     }
623     keyid = ASN1_STRING_dup(cert->skid);
624     if (!keyid) {
625         CMSerr(CMS_F_CMS_SET1_KEYID, ERR_R_MALLOC_FAILURE);
626         return 0;
627     }
628     ASN1_OCTET_STRING_free(*pkeyid);
629     *pkeyid = keyid;
630     return 1;
631 }