crypto/cms/cms_ess.c

   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 {
  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  */
  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  */
  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
 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
 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         goto merr;
 126     if (id)
 127         ASN1_STRING_set0(rr->signedContentIdentifier, id, idlen);
 128     else {
 129         if (!ASN1_STRING_set(rr->signedContentIdentifier, NULL, 32))
 130             goto merr;
 131         if (RAND_bytes_ex(libctx, rr->signedContentIdentifier->data, 32,
 132                           0) <= 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     ERR_raise(ERR_LIB_CMS, 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);
 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         ERR_raise(ERR_LIB_CMS, 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 (!ossl_asn1_item_digest_ex(ASN1_ITEM_rptr(CMS_Attributes_Verify), md,
 224                                   si->signedAttrs, dig, diglen,
 225                                   ossl_cms_ctx_get0_libctx(si->cms_ctx),
 226                                   ossl_cms_ctx_get0_propq(si->cms_ctx)))
 227         return 0;
 228     return 1;
 229 }
 230
 231 /* Add a msgSigDigest attribute to a SignerInfo */
 232
 233 int ossl_cms_msgSigDigest_add1(CMS_SignerInfo *dest, CMS_SignerInfo *src)
 234 {
 235     unsigned char dig[EVP_MAX_MD_SIZE];
 236     unsigned int diglen;
 237
 238     if (!cms_msgSigDigest(src, dig, &diglen)) {
 239         ERR_raise(ERR_LIB_CMS, CMS_R_MSGSIGDIGEST_ERROR);
 240         return 0;
 241     }
 242     if (!CMS_signed_add1_attr_by_NID(dest, NID_id_smime_aa_msgSigDigest,
 243                                      V_ASN1_OCTET_STRING, dig, diglen)) {
 244         ERR_raise(ERR_LIB_CMS, ERR_R_MALLOC_FAILURE);
 245         return 0;
 246     }
 247     return 1;
 248 }
 249
 250 /* Verify signed receipt after it has already passed normal CMS verify */
 251
 252 int ossl_cms_Receipt_verify(CMS_ContentInfo *cms, CMS_ContentInfo *req_cms)
 253 {
 254     int r = 0, i;
 255     CMS_ReceiptRequest *rr = NULL;
 256     CMS_Receipt *rct = NULL;
 257     STACK_OF(CMS_SignerInfo) *sis, *osis;
 258     CMS_SignerInfo *si, *osi = NULL;
 259     ASN1_OCTET_STRING *msig, **pcont;
 260     ASN1_OBJECT *octype;
 261     unsigned char dig[EVP_MAX_MD_SIZE];
 262     unsigned int diglen;
 263
 264     /* Get SignerInfos, also checks SignedData content type */
 265     osis = CMS_get0_SignerInfos(req_cms);
 266     sis = CMS_get0_SignerInfos(cms);
 267     if (!osis || !sis)
 268         goto err;
 269
 270     if (sk_CMS_SignerInfo_num(sis) != 1) {
 271         ERR_raise(ERR_LIB_CMS, CMS_R_NEED_ONE_SIGNER);
 272         goto err;
 273     }
 274
 275     /* Check receipt content type */
 276     if (OBJ_obj2nid(CMS_get0_eContentType(cms)) != NID_id_smime_ct_receipt) {
 277         ERR_raise(ERR_LIB_CMS, CMS_R_NOT_A_SIGNED_RECEIPT);
 278         goto err;
 279     }
 280
 281     /* Extract and decode receipt content */
 282     pcont = CMS_get0_content(cms);
 283     if (pcont == NULL || *pcont == NULL) {
 284         ERR_raise(ERR_LIB_CMS, CMS_R_NO_CONTENT);
 285         goto err;
 286     }
 287
 288     rct = ASN1_item_unpack(*pcont, ASN1_ITEM_rptr(CMS_Receipt));
 289
 290     if (!rct) {
 291         ERR_raise(ERR_LIB_CMS, CMS_R_RECEIPT_DECODE_ERROR);
 292         goto err;
 293     }
 294
 295     /* Locate original request */
 296
 297     for (i = 0; i < sk_CMS_SignerInfo_num(osis); i++) {
 298         osi = sk_CMS_SignerInfo_value(osis, i);
 299         if (!ASN1_STRING_cmp(osi->signature, rct->originatorSignatureValue))
 300             break;
 301     }
 302
 303     if (i == sk_CMS_SignerInfo_num(osis)) {
 304         ERR_raise(ERR_LIB_CMS, CMS_R_NO_MATCHING_SIGNATURE);
 305         goto err;
 306     }
 307
 308     si = sk_CMS_SignerInfo_value(sis, 0);
 309
 310     /* Get msgSigDigest value and compare */
 311
 312     msig = CMS_signed_get0_data_by_OBJ(si,
 313                                        OBJ_nid2obj
 314                                        (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 /*
 377  * Encode a Receipt into an OCTET STRING read for including into content of a
 378  * SignedData ContentInfo.
 379  */
 380
 381 ASN1_OCTET_STRING *ossl_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         ERR_raise(ERR_LIB_CMS, 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         ERR_raise(ERR_LIB_CMS, 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 }