Add libctx support to CMS.
[openssl.git] / crypto / cms / cms_ess.c
1 /*
2  * Copyright 2008-2020 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include "internal/cryptlib.h"
11 #include <openssl/asn1t.h>
12 #include <openssl/pem.h>
13 #include <openssl/rand.h>
14 #include <openssl/x509v3.h>
15 #include <openssl/err.h>
16 #include <openssl/cms.h>
17 #include <openssl/ess.h>
18 #include "crypto/ess.h"
19 #include "crypto/cms.h"
20 #include "crypto/x509.h"
21 #include "cms_local.h"
22
23 DEFINE_STACK_OF(GENERAL_NAMES)
24 DEFINE_STACK_OF(CMS_SignerInfo)
25 DEFINE_STACK_OF(ESS_CERT_ID)
26 DEFINE_STACK_OF(ESS_CERT_ID_V2)
27 DEFINE_STACK_OF(X509)
28
29 IMPLEMENT_ASN1_FUNCTIONS(CMS_ReceiptRequest)
30
31 /* ESS services */
32
33 int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr)
34 {
35     ASN1_STRING *str;
36     CMS_ReceiptRequest *rr;
37     ASN1_OBJECT *obj = OBJ_nid2obj(NID_id_smime_aa_receiptRequest);
38
39     if (prr != NULL)
40         *prr = NULL;
41     str = CMS_signed_get0_data_by_OBJ(si, obj, -3, V_ASN1_SEQUENCE);
42     if (str == NULL)
43         return 0;
44
45     rr = ASN1_item_unpack(str, ASN1_ITEM_rptr(CMS_ReceiptRequest));
46     if (rr == NULL)
47         return -1;
48     if (prr != NULL)
49         *prr = rr;
50     else
51         CMS_ReceiptRequest_free(rr);
52     return 1;
53 }
54
55 /*
56     First, get the ESS_SIGNING_CERT(V2) signed attribute from |si|.
57     Then check matching of each cert of trust |chain| with one of 
58     the |cert_ids|(Hash+IssuerID) list from this ESS_SIGNING_CERT.
59     Derived from ts_check_signing_certs()
60 */
61 int ess_check_signing_certs(CMS_SignerInfo *si, STACK_OF(X509) *chain)
62 {
63     ESS_SIGNING_CERT *ss = NULL;
64     ESS_SIGNING_CERT_V2 *ssv2 = NULL;
65     X509 *cert;
66     int i = 0, ret = 0;
67
68     if (cms_signerinfo_get_signing_cert(si, &ss) > 0 && ss->cert_ids != NULL) {
69         STACK_OF(ESS_CERT_ID) *cert_ids = ss->cert_ids;
70
71         cert = sk_X509_value(chain, 0);
72         if (ess_find_cert(cert_ids, cert) != 0)
73             goto err;
74
75         /*
76          * Check the other certificates of the chain.
77          * Fail if no signing certificate ids found for each certificate.
78          */
79         if (sk_ESS_CERT_ID_num(cert_ids) > 1) {
80             /* for each chain cert, try to find its cert id */
81             for (i = 1; i < sk_X509_num(chain); ++i) {
82                 cert = sk_X509_value(chain, i);
83                 if (ess_find_cert(cert_ids, cert) < 0)
84                     goto err;
85             }
86         }
87     } else if (cms_signerinfo_get_signing_cert_v2(si, &ssv2) > 0
88                    && ssv2->cert_ids!= NULL) {
89         STACK_OF(ESS_CERT_ID_V2) *cert_ids_v2 = ssv2->cert_ids;
90
91         cert = sk_X509_value(chain, 0);
92         if (ess_find_cert_v2(cert_ids_v2, cert) != 0)
93             goto err;
94
95         /*
96          * Check the other certificates of the chain.
97          * Fail if no signing certificate ids found for each certificate.
98          */
99         if (sk_ESS_CERT_ID_V2_num(cert_ids_v2) > 1) {
100             /* for each chain cert, try to find its cert id */
101             for (i = 1; i < sk_X509_num(chain); ++i) {
102                 cert = sk_X509_value(chain, i);
103                 if (ess_find_cert_v2(cert_ids_v2, cert) < 0)
104                     goto err;
105             }
106         }
107     } else {
108         CMSerr(CMS_F_ESS_CHECK_SIGNING_CERTS,
109                CMS_R_ESS_NO_SIGNING_CERTID_ATTRIBUTE);
110         return 0;
111     }
112     ret = 1;
113  err:
114     if (!ret)
115         CMSerr(CMS_F_ESS_CHECK_SIGNING_CERTS,
116                CMS_R_ESS_SIGNING_CERTID_MISMATCH_ERROR);
117
118     ESS_SIGNING_CERT_free(ss);
119     ESS_SIGNING_CERT_V2_free(ssv2);
120     return ret;
121 }
122
123 CMS_ReceiptRequest *CMS_ReceiptRequest_create0_with_libctx(
124     unsigned char *id, int idlen, int allorfirst,
125     STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo,
126     OPENSSL_CTX *libctx, const char *propq)
127 {
128     CMS_ReceiptRequest *rr;
129
130     rr = CMS_ReceiptRequest_new();
131     if (rr == NULL)
132         goto merr;
133     if (id)
134         ASN1_STRING_set0(rr->signedContentIdentifier, id, idlen);
135     else {
136         if (!ASN1_STRING_set(rr->signedContentIdentifier, NULL, 32))
137             goto merr;
138         if (RAND_bytes_ex(libctx, rr->signedContentIdentifier->data, 32) <= 0)
139             goto err;
140     }
141
142     sk_GENERAL_NAMES_pop_free(rr->receiptsTo, GENERAL_NAMES_free);
143     rr->receiptsTo = receiptsTo;
144
145     if (receiptList != NULL) {
146         rr->receiptsFrom->type = 1;
147         rr->receiptsFrom->d.receiptList = receiptList;
148     } else {
149         rr->receiptsFrom->type = 0;
150         rr->receiptsFrom->d.allOrFirstTier = allorfirst;
151     }
152
153     return rr;
154
155  merr:
156     CMSerr(0, ERR_R_MALLOC_FAILURE);
157
158  err:
159     CMS_ReceiptRequest_free(rr);
160     return NULL;
161
162 }
163
164 CMS_ReceiptRequest *CMS_ReceiptRequest_create0(
165     unsigned char *id, int idlen, int allorfirst,
166     STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo)
167 {
168     return CMS_ReceiptRequest_create0_with_libctx(id, idlen, allorfirst,
169                                                   receiptList, receiptsTo,
170                                                   NULL, NULL);
171 }
172
173 int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr)
174 {
175     unsigned char *rrder = NULL;
176     int rrderlen, r = 0;
177
178     rrderlen = i2d_CMS_ReceiptRequest(rr, &rrder);
179     if (rrderlen < 0)
180         goto merr;
181
182     if (!CMS_signed_add1_attr_by_NID(si, NID_id_smime_aa_receiptRequest,
183                                      V_ASN1_SEQUENCE, rrder, rrderlen))
184         goto merr;
185
186     r = 1;
187
188  merr:
189     if (!r)
190         CMSerr(CMS_F_CMS_ADD1_RECEIPTREQUEST, ERR_R_MALLOC_FAILURE);
191
192     OPENSSL_free(rrder);
193
194     return r;
195
196 }
197
198 void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr,
199                                     ASN1_STRING **pcid,
200                                     int *pallorfirst,
201                                     STACK_OF(GENERAL_NAMES) **plist,
202                                     STACK_OF(GENERAL_NAMES) **prto)
203 {
204     if (pcid != NULL)
205         *pcid = rr->signedContentIdentifier;
206     if (rr->receiptsFrom->type == 0) {
207         if (pallorfirst != NULL)
208             *pallorfirst = (int)rr->receiptsFrom->d.allOrFirstTier;
209         if (plist != NULL)
210             *plist = NULL;
211     } else {
212         if (pallorfirst != NULL)
213             *pallorfirst = -1;
214         if (plist != NULL)
215             *plist = rr->receiptsFrom->d.receiptList;
216     }
217     if (prto != NULL)
218         *prto = rr->receiptsTo;
219 }
220
221 /* Digest a SignerInfo structure for msgSigDigest attribute processing */
222
223 static int cms_msgSigDigest(CMS_SignerInfo *si,
224                             unsigned char *dig, unsigned int *diglen)
225 {
226     const EVP_MD *md = EVP_get_digestbyobj(si->digestAlgorithm->algorithm);
227
228     if (md == NULL)
229         return 0;
230     if (!asn1_item_digest_with_libctx(ASN1_ITEM_rptr(CMS_Attributes_Verify), md,
231                                       si->signedAttrs, dig, diglen,
232                                       si->cms_ctx->libctx, si->cms_ctx->propq))
233         return 0;
234     return 1;
235 }
236
237 /* Add a msgSigDigest attribute to a SignerInfo */
238
239 int cms_msgSigDigest_add1(CMS_SignerInfo *dest, CMS_SignerInfo *src)
240 {
241     unsigned char dig[EVP_MAX_MD_SIZE];
242     unsigned int diglen;
243
244     if (!cms_msgSigDigest(src, dig, &diglen)) {
245         CMSerr(CMS_F_CMS_MSGSIGDIGEST_ADD1, CMS_R_MSGSIGDIGEST_ERROR);
246         return 0;
247     }
248     if (!CMS_signed_add1_attr_by_NID(dest, NID_id_smime_aa_msgSigDigest,
249                                      V_ASN1_OCTET_STRING, dig, diglen)) {
250         CMSerr(CMS_F_CMS_MSGSIGDIGEST_ADD1, ERR_R_MALLOC_FAILURE);
251         return 0;
252     }
253     return 1;
254 }
255
256 /* Verify signed receipt after it has already passed normal CMS verify */
257
258 int cms_Receipt_verify(CMS_ContentInfo *cms, CMS_ContentInfo *req_cms)
259 {
260     int r = 0, i;
261     CMS_ReceiptRequest *rr = NULL;
262     CMS_Receipt *rct = NULL;
263     STACK_OF(CMS_SignerInfo) *sis, *osis;
264     CMS_SignerInfo *si, *osi = NULL;
265     ASN1_OCTET_STRING *msig, **pcont;
266     ASN1_OBJECT *octype;
267     unsigned char dig[EVP_MAX_MD_SIZE];
268     unsigned int diglen;
269
270     /* Get SignerInfos, also checks SignedData content type */
271     osis = CMS_get0_SignerInfos(req_cms);
272     sis = CMS_get0_SignerInfos(cms);
273     if (!osis || !sis)
274         goto err;
275
276     if (sk_CMS_SignerInfo_num(sis) != 1) {
277         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NEED_ONE_SIGNER);
278         goto err;
279     }
280
281     /* Check receipt content type */
282     if (OBJ_obj2nid(CMS_get0_eContentType(cms)) != NID_id_smime_ct_receipt) {
283         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NOT_A_SIGNED_RECEIPT);
284         goto err;
285     }
286
287     /* Extract and decode receipt content */
288     pcont = CMS_get0_content(cms);
289     if (pcont == NULL || *pcont == NULL) {
290         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_CONTENT);
291         goto err;
292     }
293
294     rct = ASN1_item_unpack(*pcont, ASN1_ITEM_rptr(CMS_Receipt));
295
296     if (!rct) {
297         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_RECEIPT_DECODE_ERROR);
298         goto err;
299     }
300
301     /* Locate original request */
302
303     for (i = 0; i < sk_CMS_SignerInfo_num(osis); i++) {
304         osi = sk_CMS_SignerInfo_value(osis, i);
305         if (!ASN1_STRING_cmp(osi->signature, rct->originatorSignatureValue))
306             break;
307     }
308
309     if (i == sk_CMS_SignerInfo_num(osis)) {
310         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_MATCHING_SIGNATURE);
311         goto err;
312     }
313
314     si = sk_CMS_SignerInfo_value(sis, 0);
315
316     /* Get msgSigDigest value and compare */
317
318     msig = CMS_signed_get0_data_by_OBJ(si,
319                                        OBJ_nid2obj
320                                        (NID_id_smime_aa_msgSigDigest), -3,
321                                        V_ASN1_OCTET_STRING);
322
323     if (!msig) {
324         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_MSGSIGDIGEST);
325         goto err;
326     }
327
328     if (!cms_msgSigDigest(osi, dig, &diglen)) {
329         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_MSGSIGDIGEST_ERROR);
330         goto err;
331     }
332
333     if (diglen != (unsigned int)msig->length) {
334         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_MSGSIGDIGEST_WRONG_LENGTH);
335         goto err;
336     }
337
338     if (memcmp(dig, msig->data, diglen)) {
339         CMSerr(CMS_F_CMS_RECEIPT_VERIFY,
340                CMS_R_MSGSIGDIGEST_VERIFICATION_FAILURE);
341         goto err;
342     }
343
344     /* Compare content types */
345
346     octype = CMS_signed_get0_data_by_OBJ(osi,
347                                          OBJ_nid2obj(NID_pkcs9_contentType),
348                                          -3, V_ASN1_OBJECT);
349     if (!octype) {
350         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_CONTENT_TYPE);
351         goto err;
352     }
353
354     /* Compare details in receipt request */
355
356     if (OBJ_cmp(octype, rct->contentType)) {
357         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_CONTENT_TYPE_MISMATCH);
358         goto err;
359     }
360
361     /* Get original receipt request details */
362
363     if (CMS_get1_ReceiptRequest(osi, &rr) <= 0) {
364         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_NO_RECEIPT_REQUEST);
365         goto err;
366     }
367
368     if (ASN1_STRING_cmp(rr->signedContentIdentifier,
369                         rct->signedContentIdentifier)) {
370         CMSerr(CMS_F_CMS_RECEIPT_VERIFY, CMS_R_CONTENTIDENTIFIER_MISMATCH);
371         goto err;
372     }
373
374     r = 1;
375
376  err:
377     CMS_ReceiptRequest_free(rr);
378     M_ASN1_free_of(rct, CMS_Receipt);
379     return r;
380
381 }
382
383 /*
384  * Encode a Receipt into an OCTET STRING read for including into content of a
385  * SignedData ContentInfo.
386  */
387
388 ASN1_OCTET_STRING *cms_encode_Receipt(CMS_SignerInfo *si)
389 {
390     CMS_Receipt rct;
391     CMS_ReceiptRequest *rr = NULL;
392     ASN1_OBJECT *ctype;
393     ASN1_OCTET_STRING *os = NULL;
394
395     /* Get original receipt request */
396
397     /* Get original receipt request details */
398
399     if (CMS_get1_ReceiptRequest(si, &rr) <= 0) {
400         CMSerr(CMS_F_CMS_ENCODE_RECEIPT, CMS_R_NO_RECEIPT_REQUEST);
401         goto err;
402     }
403
404     /* Get original content type */
405
406     ctype = CMS_signed_get0_data_by_OBJ(si,
407                                         OBJ_nid2obj(NID_pkcs9_contentType),
408                                         -3, V_ASN1_OBJECT);
409     if (!ctype) {
410         CMSerr(CMS_F_CMS_ENCODE_RECEIPT, CMS_R_NO_CONTENT_TYPE);
411         goto err;
412     }
413
414     rct.version = 1;
415     rct.contentType = ctype;
416     rct.signedContentIdentifier = rr->signedContentIdentifier;
417     rct.originatorSignatureValue = si->signature;
418
419     os = ASN1_item_pack(&rct, ASN1_ITEM_rptr(CMS_Receipt), NULL);
420
421  err:
422     CMS_ReceiptRequest_free(rr);
423     return os;
424 }
425
426 /*
427  * Add signer certificate's V2 digest |sc| to a SignerInfo structure |si|
428  */
429
430 int cms_add1_signing_cert_v2(CMS_SignerInfo *si, ESS_SIGNING_CERT_V2 *sc)
431 {
432     ASN1_STRING *seq = NULL;
433     unsigned char *p, *pp;
434     int len;
435
436     /* Add SigningCertificateV2 signed attribute to the signer info. */
437     len = i2d_ESS_SIGNING_CERT_V2(sc, NULL);
438     if ((pp = OPENSSL_malloc(len)) == NULL)
439         goto err;
440     p = pp;
441     i2d_ESS_SIGNING_CERT_V2(sc, &p);
442     if (!(seq = ASN1_STRING_new()) || !ASN1_STRING_set(seq, pp, len))
443         goto err;
444     OPENSSL_free(pp);
445     pp = NULL;
446     if (!CMS_signed_add1_attr_by_NID(si, NID_id_smime_aa_signingCertificateV2,
447                                      V_ASN1_SEQUENCE, seq, -1))
448         goto err;
449     ASN1_STRING_free(seq);
450     return 1;
451  err:
452     CMSerr(CMS_F_CMS_ADD1_SIGNING_CERT_V2, ERR_R_MALLOC_FAILURE);
453     ASN1_STRING_free(seq);
454     OPENSSL_free(pp);
455     return 0;
456 }
457
458 /*
459  * Add signer certificate's digest |sc| to a SignerInfo structure |si|
460  */
461
462 int cms_add1_signing_cert(CMS_SignerInfo *si, ESS_SIGNING_CERT *sc)
463 {
464     ASN1_STRING *seq = NULL;
465     unsigned char *p, *pp;
466     int len;
467
468     /* Add SigningCertificate signed attribute to the signer info. */
469     len = i2d_ESS_SIGNING_CERT(sc, NULL);
470     if ((pp = OPENSSL_malloc(len)) == NULL)
471         goto err;
472     p = pp;
473     i2d_ESS_SIGNING_CERT(sc, &p);
474     if (!(seq = ASN1_STRING_new()) || !ASN1_STRING_set(seq, pp, len))
475         goto err;
476     OPENSSL_free(pp);
477     pp = NULL;
478     if (!CMS_signed_add1_attr_by_NID(si, NID_id_smime_aa_signingCertificate,
479                                      V_ASN1_SEQUENCE, seq, -1))
480         goto err;
481     ASN1_STRING_free(seq);
482     return 1;
483  err:
484     CMSerr(CMS_F_CMS_ADD1_SIGNING_CERT, ERR_R_MALLOC_FAILURE);
485     ASN1_STRING_free(seq);
486     OPENSSL_free(pp);
487     return 0;
488 }