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