xref: /src/crypto/openssl/crypto/cms/cms_ess.c (revision f25b8c9fb4f58cf61adb47d7570abe7caa6d385d)
1 /*
2  * Copyright 2008-2021 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/x509.h"
20 #include "cms_local.h"
21 
IMPLEMENT_ASN1_FUNCTIONS(CMS_ReceiptRequest)22 IMPLEMENT_ASN1_FUNCTIONS(CMS_ReceiptRequest)
23 
24 /* ESS services */
25 
26 int CMS_get1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest **prr)
27 {
28     ASN1_STRING *str;
29     CMS_ReceiptRequest *rr;
30     ASN1_OBJECT *obj = OBJ_nid2obj(NID_id_smime_aa_receiptRequest);
31 
32     if (prr != NULL)
33         *prr = NULL;
34     str = CMS_signed_get0_data_by_OBJ(si, obj, -3, V_ASN1_SEQUENCE);
35     if (str == NULL)
36         return 0;
37 
38     rr = ASN1_item_unpack(str, ASN1_ITEM_rptr(CMS_ReceiptRequest));
39     if (rr == NULL)
40         return -1;
41     if (prr != NULL)
42         *prr = rr;
43     else
44         CMS_ReceiptRequest_free(rr);
45     return 1;
46 }
47 
48 /*
49  * Returns 0 if attribute is not found, 1 if found,
50  * or -1 on attribute parsing failure.
51  */
ossl_cms_signerinfo_get_signing_cert(const CMS_SignerInfo * si,ESS_SIGNING_CERT ** psc)52 static int ossl_cms_signerinfo_get_signing_cert(const CMS_SignerInfo *si,
53     ESS_SIGNING_CERT **psc)
54 {
55     ASN1_STRING *str;
56     ESS_SIGNING_CERT *sc;
57     ASN1_OBJECT *obj = OBJ_nid2obj(NID_id_smime_aa_signingCertificate);
58 
59     if (psc != NULL)
60         *psc = NULL;
61     str = CMS_signed_get0_data_by_OBJ(si, obj, -3, V_ASN1_SEQUENCE);
62     if (str == NULL)
63         return 0;
64 
65     sc = ASN1_item_unpack(str, ASN1_ITEM_rptr(ESS_SIGNING_CERT));
66     if (sc == NULL)
67         return -1;
68     if (psc != NULL)
69         *psc = sc;
70     else
71         ESS_SIGNING_CERT_free(sc);
72     return 1;
73 }
74 
75 /*
76  * Returns 0 if attribute is not found, 1 if found,
77  * or -1 on attribute parsing failure.
78  */
ossl_cms_signerinfo_get_signing_cert_v2(const CMS_SignerInfo * si,ESS_SIGNING_CERT_V2 ** psc)79 static int ossl_cms_signerinfo_get_signing_cert_v2(const CMS_SignerInfo *si,
80     ESS_SIGNING_CERT_V2 **psc)
81 {
82     ASN1_STRING *str;
83     ESS_SIGNING_CERT_V2 *sc;
84     ASN1_OBJECT *obj = OBJ_nid2obj(NID_id_smime_aa_signingCertificateV2);
85 
86     if (psc != NULL)
87         *psc = NULL;
88     str = CMS_signed_get0_data_by_OBJ(si, obj, -3, V_ASN1_SEQUENCE);
89     if (str == NULL)
90         return 0;
91 
92     sc = ASN1_item_unpack(str, ASN1_ITEM_rptr(ESS_SIGNING_CERT_V2));
93     if (sc == NULL)
94         return -1;
95     if (psc != NULL)
96         *psc = sc;
97     else
98         ESS_SIGNING_CERT_V2_free(sc);
99     return 1;
100 }
101 
ossl_cms_check_signing_certs(const CMS_SignerInfo * si,const STACK_OF (X509)* chain)102 int ossl_cms_check_signing_certs(const CMS_SignerInfo *si,
103     const STACK_OF(X509) *chain)
104 {
105     ESS_SIGNING_CERT *ss = NULL;
106     ESS_SIGNING_CERT_V2 *ssv2 = NULL;
107     int ret = ossl_cms_signerinfo_get_signing_cert(si, &ss) >= 0
108         && ossl_cms_signerinfo_get_signing_cert_v2(si, &ssv2) >= 0
109         && OSSL_ESS_check_signing_certs(ss, ssv2, chain, 1) > 0;
110 
111     ESS_SIGNING_CERT_free(ss);
112     ESS_SIGNING_CERT_V2_free(ssv2);
113     return ret;
114 }
115 
CMS_ReceiptRequest_create0_ex(unsigned char * id,int idlen,int allorfirst,STACK_OF (GENERAL_NAMES)* receiptList,STACK_OF (GENERAL_NAMES)* receiptsTo,OSSL_LIB_CTX * libctx)116 CMS_ReceiptRequest *CMS_ReceiptRequest_create0_ex(
117     unsigned char *id, int idlen, int allorfirst,
118     STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo,
119     OSSL_LIB_CTX *libctx)
120 {
121     CMS_ReceiptRequest *rr;
122 
123     rr = CMS_ReceiptRequest_new();
124     if (rr == NULL) {
125         ERR_raise(ERR_LIB_CMS, ERR_R_CMS_LIB);
126         goto err;
127     }
128     if (id)
129         ASN1_STRING_set0(rr->signedContentIdentifier, id, idlen);
130     else {
131         if (!ASN1_STRING_set(rr->signedContentIdentifier, NULL, 32)) {
132             ERR_raise(ERR_LIB_CMS, ERR_R_ASN1_LIB);
133             goto err;
134         }
135         if (RAND_bytes_ex(libctx, rr->signedContentIdentifier->data, 32,
136                 0)
137             <= 0)
138             goto err;
139     }
140 
141     sk_GENERAL_NAMES_pop_free(rr->receiptsTo, GENERAL_NAMES_free);
142     rr->receiptsTo = receiptsTo;
143 
144     if (receiptList != NULL) {
145         rr->receiptsFrom->type = 1;
146         rr->receiptsFrom->d.receiptList = receiptList;
147     } else {
148         rr->receiptsFrom->type = 0;
149         rr->receiptsFrom->d.allOrFirstTier = allorfirst;
150     }
151 
152     return rr;
153 
154 err:
155     CMS_ReceiptRequest_free(rr);
156     return NULL;
157 }
158 
CMS_ReceiptRequest_create0(unsigned char * id,int idlen,int allorfirst,STACK_OF (GENERAL_NAMES)* receiptList,STACK_OF (GENERAL_NAMES)* receiptsTo)159 CMS_ReceiptRequest *CMS_ReceiptRequest_create0(
160     unsigned char *id, int idlen, int allorfirst,
161     STACK_OF(GENERAL_NAMES) *receiptList, STACK_OF(GENERAL_NAMES) *receiptsTo)
162 {
163     return CMS_ReceiptRequest_create0_ex(id, idlen, allorfirst, receiptList,
164         receiptsTo, NULL);
165 }
166 
CMS_add1_ReceiptRequest(CMS_SignerInfo * si,CMS_ReceiptRequest * rr)167 int CMS_add1_ReceiptRequest(CMS_SignerInfo *si, CMS_ReceiptRequest *rr)
168 {
169     unsigned char *rrder = NULL;
170     int rrderlen, r = 0;
171 
172     rrderlen = i2d_CMS_ReceiptRequest(rr, &rrder);
173     if (rrderlen < 0) {
174         ERR_raise(ERR_LIB_CMS, ERR_R_CMS_LIB);
175         goto err;
176     }
177 
178     if (!CMS_signed_add1_attr_by_NID(si, NID_id_smime_aa_receiptRequest,
179             V_ASN1_SEQUENCE, rrder, rrderlen)) {
180         ERR_raise(ERR_LIB_CMS, ERR_R_CMS_LIB);
181         goto err;
182     }
183 
184     r = 1;
185 
186 err:
187     OPENSSL_free(rrder);
188 
189     return r;
190 }
191 
CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest * rr,ASN1_STRING ** pcid,int * pallorfirst,STACK_OF (GENERAL_NAMES)** plist,STACK_OF (GENERAL_NAMES)** prto)192 void CMS_ReceiptRequest_get0_values(CMS_ReceiptRequest *rr,
193     ASN1_STRING **pcid,
194     int *pallorfirst,
195     STACK_OF(GENERAL_NAMES) **plist,
196     STACK_OF(GENERAL_NAMES) **prto)
197 {
198     if (pcid != NULL)
199         *pcid = rr->signedContentIdentifier;
200     if (rr->receiptsFrom->type == 0) {
201         if (pallorfirst != NULL)
202             *pallorfirst = (int)rr->receiptsFrom->d.allOrFirstTier;
203         if (plist != NULL)
204             *plist = NULL;
205     } else {
206         if (pallorfirst != NULL)
207             *pallorfirst = -1;
208         if (plist != NULL)
209             *plist = rr->receiptsFrom->d.receiptList;
210     }
211     if (prto != NULL)
212         *prto = rr->receiptsTo;
213 }
214 
215 /* Digest a SignerInfo structure for msgSigDigest attribute processing */
216 
cms_msgSigDigest(CMS_SignerInfo * si,unsigned char * dig,unsigned int * diglen)217 static int cms_msgSigDigest(CMS_SignerInfo *si,
218     unsigned char *dig, unsigned int *diglen)
219 {
220     const EVP_MD *md = EVP_get_digestbyobj(si->digestAlgorithm->algorithm);
221 
222     if (md == NULL)
223         return 0;
224     if (!ossl_asn1_item_digest_ex(ASN1_ITEM_rptr(CMS_Attributes_Verify), md,
225             si->signedAttrs, dig, diglen,
226             ossl_cms_ctx_get0_libctx(si->cms_ctx),
227             ossl_cms_ctx_get0_propq(si->cms_ctx)))
228         return 0;
229     return 1;
230 }
231 
232 /* Add a msgSigDigest attribute to a SignerInfo */
233 
ossl_cms_msgSigDigest_add1(CMS_SignerInfo * dest,CMS_SignerInfo * src)234 int ossl_cms_msgSigDigest_add1(CMS_SignerInfo *dest, CMS_SignerInfo *src)
235 {
236     unsigned char dig[EVP_MAX_MD_SIZE];
237     unsigned int diglen;
238 
239     if (!cms_msgSigDigest(src, dig, &diglen)) {
240         ERR_raise(ERR_LIB_CMS, CMS_R_MSGSIGDIGEST_ERROR);
241         return 0;
242     }
243     if (!CMS_signed_add1_attr_by_NID(dest, NID_id_smime_aa_msgSigDigest,
244             V_ASN1_OCTET_STRING, dig, diglen)) {
245         ERR_raise(ERR_LIB_CMS, ERR_R_CMS_LIB);
246         return 0;
247     }
248     return 1;
249 }
250 
251 /* Verify signed receipt after it has already passed normal CMS verify */
252 
ossl_cms_Receipt_verify(CMS_ContentInfo * cms,CMS_ContentInfo * req_cms)253 int ossl_cms_Receipt_verify(CMS_ContentInfo *cms, CMS_ContentInfo *req_cms)
254 {
255     int r = 0, i;
256     CMS_ReceiptRequest *rr = NULL;
257     CMS_Receipt *rct = NULL;
258     STACK_OF(CMS_SignerInfo) *sis, *osis;
259     CMS_SignerInfo *si, *osi = NULL;
260     ASN1_OCTET_STRING *msig, **pcont;
261     ASN1_OBJECT *octype;
262     unsigned char dig[EVP_MAX_MD_SIZE];
263     unsigned int diglen;
264 
265     /* Get SignerInfos, also checks SignedData content type */
266     osis = CMS_get0_SignerInfos(req_cms);
267     sis = CMS_get0_SignerInfos(cms);
268     if (!osis || !sis)
269         goto err;
270 
271     if (sk_CMS_SignerInfo_num(sis) != 1) {
272         ERR_raise(ERR_LIB_CMS, CMS_R_NEED_ONE_SIGNER);
273         goto err;
274     }
275 
276     /* Check receipt content type */
277     if (OBJ_obj2nid(CMS_get0_eContentType(cms)) != NID_id_smime_ct_receipt) {
278         ERR_raise(ERR_LIB_CMS, CMS_R_NOT_A_SIGNED_RECEIPT);
279         goto err;
280     }
281 
282     /* Extract and decode receipt content */
283     pcont = CMS_get0_content(cms);
284     if (pcont == NULL || *pcont == NULL) {
285         ERR_raise(ERR_LIB_CMS, CMS_R_NO_CONTENT);
286         goto err;
287     }
288 
289     rct = ASN1_item_unpack(*pcont, ASN1_ITEM_rptr(CMS_Receipt));
290 
291     if (!rct) {
292         ERR_raise(ERR_LIB_CMS, CMS_R_RECEIPT_DECODE_ERROR);
293         goto err;
294     }
295 
296     /* Locate original request */
297 
298     for (i = 0; i < sk_CMS_SignerInfo_num(osis); i++) {
299         osi = sk_CMS_SignerInfo_value(osis, i);
300         if (!ASN1_STRING_cmp(osi->signature, rct->originatorSignatureValue))
301             break;
302     }
303 
304     if (i == sk_CMS_SignerInfo_num(osis)) {
305         ERR_raise(ERR_LIB_CMS, CMS_R_NO_MATCHING_SIGNATURE);
306         goto err;
307     }
308 
309     si = sk_CMS_SignerInfo_value(sis, 0);
310 
311     /* Get msgSigDigest value and compare */
312 
313     msig = CMS_signed_get0_data_by_OBJ(si,
314         OBJ_nid2obj(NID_id_smime_aa_msgSigDigest), -3,
315         V_ASN1_OCTET_STRING);
316 
317     if (!msig) {
318         ERR_raise(ERR_LIB_CMS, CMS_R_NO_MSGSIGDIGEST);
319         goto err;
320     }
321 
322     if (!cms_msgSigDigest(osi, dig, &diglen)) {
323         ERR_raise(ERR_LIB_CMS, CMS_R_MSGSIGDIGEST_ERROR);
324         goto err;
325     }
326 
327     if (diglen != (unsigned int)msig->length) {
328         ERR_raise(ERR_LIB_CMS, CMS_R_MSGSIGDIGEST_WRONG_LENGTH);
329         goto err;
330     }
331 
332     if (memcmp(dig, msig->data, diglen)) {
333         ERR_raise(ERR_LIB_CMS, 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         ERR_raise(ERR_LIB_CMS, 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         ERR_raise(ERR_LIB_CMS, 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         ERR_raise(ERR_LIB_CMS, CMS_R_NO_RECEIPT_REQUEST);
358         goto err;
359     }
360 
361     if (ASN1_STRING_cmp(rr->signedContentIdentifier,
362             rct->signedContentIdentifier)) {
363         ERR_raise(ERR_LIB_CMS, 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  * Encode a Receipt into an OCTET STRING read for including into content of a
377  * SignedData ContentInfo.
378  */
379 
ossl_cms_encode_Receipt(CMS_SignerInfo * si)380 ASN1_OCTET_STRING *ossl_cms_encode_Receipt(CMS_SignerInfo *si)
381 {
382     CMS_Receipt rct;
383     CMS_ReceiptRequest *rr = NULL;
384     ASN1_OBJECT *ctype;
385     ASN1_OCTET_STRING *os = NULL;
386 
387     /* Get original receipt request */
388 
389     /* Get original receipt request details */
390 
391     if (CMS_get1_ReceiptRequest(si, &rr) <= 0) {
392         ERR_raise(ERR_LIB_CMS, CMS_R_NO_RECEIPT_REQUEST);
393         goto err;
394     }
395 
396     /* Get original content type */
397 
398     ctype = CMS_signed_get0_data_by_OBJ(si,
399         OBJ_nid2obj(NID_pkcs9_contentType),
400         -3, V_ASN1_OBJECT);
401     if (!ctype) {
402         ERR_raise(ERR_LIB_CMS, CMS_R_NO_CONTENT_TYPE);
403         goto err;
404     }
405 
406     rct.version = 1;
407     rct.contentType = ctype;
408     rct.signedContentIdentifier = rr->signedContentIdentifier;
409     rct.originatorSignatureValue = si->signature;
410 
411     os = ASN1_item_pack(&rct, ASN1_ITEM_rptr(CMS_Receipt), NULL);
412 
413 err:
414     CMS_ReceiptRequest_free(rr);
415     return os;
416 }
417