Coverage Report

Created: 2025-12-31 06:58

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