crypto/ts/ts_rsp_verify.c

   1 /*
   2  * Copyright 2006-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 <stdio.h>
  11 #include "internal/cryptlib.h"
  12 #include <openssl/objects.h>
  13 #include <openssl/ts.h>
  14 #include <openssl/pkcs7.h>
  15 #include "ts_local.h"
  16 #include "crypto/ess.h"
  17
  18 static int ts_verify_cert(X509_STORE *store, STACK_OF(X509) *untrusted,
  19                           X509 *signer, STACK_OF(X509) **chain);
  20 static int ts_check_signing_certs(PKCS7_SIGNER_INFO *si,
  21                                   STACK_OF(X509) *chain);
  22
  23 static int int_ts_RESP_verify_token(TS_VERIFY_CTX *ctx,
  24                                     PKCS7 *token, TS_TST_INFO *tst_info);
  25 static int ts_check_status_info(TS_RESP *response);
  26 static char *ts_get_status_text(STACK_OF(ASN1_UTF8STRING) *text);
  27 static int ts_check_policy(const ASN1_OBJECT *req_oid,
  28                            const TS_TST_INFO *tst_info);
  29 static int ts_compute_imprint(BIO *data, TS_TST_INFO *tst_info,
  30                               X509_ALGOR **md_alg,
  31                               unsigned char **imprint, unsigned *imprint_len);
  32 static int ts_check_imprints(X509_ALGOR *algor_a,
  33                              const unsigned char *imprint_a, unsigned len_a,
  34                              TS_TST_INFO *tst_info);
  35 static int ts_check_nonces(const ASN1_INTEGER *a, TS_TST_INFO *tst_info);
  36 static int ts_check_signer_name(GENERAL_NAME *tsa_name, X509 *signer);
  37 static int ts_find_name(STACK_OF(GENERAL_NAME) *gen_names,
  38                         GENERAL_NAME *name);
  39
  40 /*
  41  * This must be large enough to hold all values in ts_status_text (with
  42  * comma separator) or all text fields in ts_failure_info (also with comma).
  43  */
  44 #define TS_STATUS_BUF_SIZE      256
  45
  46 /*
  47  * Local mapping between response codes and descriptions.
  48  */
  49 static const char *ts_status_text[] = {
  50     "granted",
  51     "grantedWithMods",
  52     "rejection",
  53     "waiting",
  54     "revocationWarning",
  55     "revocationNotification"
  56 };
  57
  58 #define TS_STATUS_TEXT_SIZE     OSSL_NELEM(ts_status_text)
  59
  60 static struct {
  61     int code;
  62     const char *text;
  63 } ts_failure_info[] = {
  64     {TS_INFO_BAD_ALG, "badAlg"},
  65     {TS_INFO_BAD_REQUEST, "badRequest"},
  66     {TS_INFO_BAD_DATA_FORMAT, "badDataFormat"},
  67     {TS_INFO_TIME_NOT_AVAILABLE, "timeNotAvailable"},
  68     {TS_INFO_UNACCEPTED_POLICY, "unacceptedPolicy"},
  69     {TS_INFO_UNACCEPTED_EXTENSION, "unacceptedExtension"},
  70     {TS_INFO_ADD_INFO_NOT_AVAILABLE, "addInfoNotAvailable"},
  71     {TS_INFO_SYSTEM_FAILURE, "systemFailure"}
  72 };
  73
  74
  75 /*-
  76  * This function carries out the following tasks:
  77  *      - Checks if there is one and only one signer.
  78  *      - Search for the signing certificate in 'certs' and in the response.
  79  *      - Check the extended key usage and key usage fields of the signer
  80  *      certificate (done by the path validation).
  81  *      - Build and validate the certificate path.
  82  *      - Check if the certificate path meets the requirements of the
  83  *      SigningCertificate ESS signed attribute.
  84  *      - Verify the signature value.
  85  *      - Returns the signer certificate in 'signer', if 'signer' is not NULL.
  86  */
  87 int TS_RESP_verify_signature(PKCS7 *token, STACK_OF(X509) *certs,
  88                              X509_STORE *store, X509 **signer_out)
  89 {
  90     STACK_OF(PKCS7_SIGNER_INFO) *sinfos = NULL;
  91     PKCS7_SIGNER_INFO *si;
  92     STACK_OF(X509) *signers = NULL;
  93     X509 *signer;
  94     STACK_OF(X509) *chain = NULL;
  95     char buf[4096];
  96     int i, j = 0, ret = 0;
  97     BIO *p7bio = NULL;
  98
  99     /* Some sanity checks first. */
 100     if (!token) {
 101         ERR_raise(ERR_LIB_TS, TS_R_INVALID_NULL_POINTER);
 102         goto err;
 103     }
 104     if (!PKCS7_type_is_signed(token)) {
 105         ERR_raise(ERR_LIB_TS, TS_R_WRONG_CONTENT_TYPE);
 106         goto err;
 107     }
 108     sinfos = PKCS7_get_signer_info(token);
 109     if (!sinfos || sk_PKCS7_SIGNER_INFO_num(sinfos) != 1) {
 110         ERR_raise(ERR_LIB_TS, TS_R_THERE_MUST_BE_ONE_SIGNER);
 111         goto err;
 112     }
 113     si = sk_PKCS7_SIGNER_INFO_value(sinfos, 0);
 114     if (PKCS7_get_detached(token)) {
 115         ERR_raise(ERR_LIB_TS, TS_R_NO_CONTENT);
 116         goto err;
 117     }
 118
 119     /*
 120      * Get hold of the signer certificate, search only internal certificates
 121      * if it was requested.
 122      */
 123     signers = PKCS7_get0_signers(token, certs, 0);
 124     if (!signers || sk_X509_num(signers) != 1)
 125         goto err;
 126     signer = sk_X509_value(signers, 0);
 127
 128     if (!ts_verify_cert(store, certs, signer, &chain))
 129         goto err;
 130     if (!ts_check_signing_certs(si, chain))
 131         goto err;
 132     p7bio = PKCS7_dataInit(token, NULL);
 133
 134     /* We now have to 'read' from p7bio to calculate digests etc. */
 135     while ((i = BIO_read(p7bio, buf, sizeof(buf))) > 0)
 136         continue;
 137
 138     j = PKCS7_signatureVerify(p7bio, token, si, signer);
 139     if (j <= 0) {
 140         ERR_raise(ERR_LIB_TS, TS_R_SIGNATURE_FAILURE);
 141         goto err;
 142     }
 143
 144     if (signer_out) {
 145         *signer_out = signer;
 146         X509_up_ref(signer);
 147     }
 148     ret = 1;
 149
 150  err:
 151     BIO_free_all(p7bio);
 152     sk_X509_pop_free(chain, X509_free);
 153     sk_X509_free(signers);
 154
 155     return ret;
 156 }
 157
 158 /*
 159  * The certificate chain is returned in chain. Caller is responsible for
 160  * freeing the vector.
 161  */
 162 static int ts_verify_cert(X509_STORE *store, STACK_OF(X509) *untrusted,
 163                           X509 *signer, STACK_OF(X509) **chain)
 164 {
 165     X509_STORE_CTX *cert_ctx = NULL;
 166     int i;
 167     int ret = 0;
 168
 169     *chain = NULL;
 170     cert_ctx = X509_STORE_CTX_new();
 171     if (cert_ctx == NULL) {
 172         ERR_raise(ERR_LIB_TS, ERR_R_MALLOC_FAILURE);
 173         goto err;
 174     }
 175     if (!X509_STORE_CTX_init(cert_ctx, store, signer, untrusted))
 176         goto end;
 177     X509_STORE_CTX_set_purpose(cert_ctx, X509_PURPOSE_TIMESTAMP_SIGN);
 178     i = X509_verify_cert(cert_ctx);
 179     if (i <= 0) {
 180         int j = X509_STORE_CTX_get_error(cert_ctx);
 181         ERR_raise_data(ERR_LIB_TS, TS_R_CERTIFICATE_VERIFY_ERROR,
 182                        "Verify error:%s", X509_verify_cert_error_string(j));
 183         goto err;
 184     }
 185     *chain = X509_STORE_CTX_get1_chain(cert_ctx);
 186     ret = 1;
 187     goto end;
 188
 189 err:
 190     ret = 0;
 191
 192 end:
 193     X509_STORE_CTX_free(cert_ctx);
 194     return ret;
 195 }
 196
 197 static int ts_check_signing_certs(PKCS7_SIGNER_INFO *si,
 198                                   STACK_OF(X509) *chain)
 199 {
 200     ESS_SIGNING_CERT *ss = ESS_SIGNING_CERT_get(si);
 201     STACK_OF(ESS_CERT_ID) *cert_ids = NULL;
 202     ESS_SIGNING_CERT_V2 *ssv2 = ESS_SIGNING_CERT_V2_get(si);
 203     STACK_OF(ESS_CERT_ID_V2) *cert_ids_v2 = NULL;
 204     X509 *cert;
 205     int i = 0;
 206     int ret = 0;
 207
 208     if (ss != NULL) {
 209         cert_ids = ss->cert_ids;
 210         cert = sk_X509_value(chain, 0);
 211         if (ess_find_cert(cert_ids, cert) != 0)
 212             goto err;
 213
 214         /*
 215          * Check the other certificates of the chain if there are more than one
 216          * certificate ids in cert_ids.
 217          */
 218         if (sk_ESS_CERT_ID_num(cert_ids) > 1) {
 219             for (i = 1; i < sk_X509_num(chain); ++i) {
 220                 cert = sk_X509_value(chain, i);
 221                 if (ess_find_cert(cert_ids, cert) < 0)
 222                     goto err;
 223             }
 224         }
 225     } else if (ssv2 != NULL) {
 226         cert_ids_v2 = ssv2->cert_ids;
 227         cert = sk_X509_value(chain, 0);
 228         if (ess_find_cert_v2(cert_ids_v2, cert) != 0)
 229             goto err;
 230
 231         /*
 232          * Check the other certificates of the chain if there are more than one
 233          * certificate ids in cert_ids.
 234          */
 235         if (sk_ESS_CERT_ID_V2_num(cert_ids_v2) > 1) {
 236             for (i = 1; i < sk_X509_num(chain); ++i) {
 237                 cert = sk_X509_value(chain, i);
 238                 if (ess_find_cert_v2(cert_ids_v2, cert) < 0)
 239                     goto err;
 240             }
 241         }
 242     } else {
 243         goto err;
 244     }
 245
 246     ret = 1;
 247  err:
 248     if (!ret)
 249         ERR_raise(ERR_LIB_TS, TS_R_ESS_SIGNING_CERTIFICATE_ERROR);
 250     ESS_SIGNING_CERT_free(ss);
 251     ESS_SIGNING_CERT_V2_free(ssv2);
 252     return ret;
 253 }
 254
 255 /*-
 256  * Verifies whether 'response' contains a valid response with regards
 257  * to the settings of the context:
 258  *      - Gives an error message if the TS_TST_INFO is not present.
 259  *      - Calls _TS_RESP_verify_token to verify the token content.
 260  */
 261 int TS_RESP_verify_response(TS_VERIFY_CTX *ctx, TS_RESP *response)
 262 {
 263     PKCS7 *token = response->token;
 264     TS_TST_INFO *tst_info = response->tst_info;
 265     int ret = 0;
 266
 267     if (!ts_check_status_info(response))
 268         goto err;
 269     if (!int_ts_RESP_verify_token(ctx, token, tst_info))
 270         goto err;
 271     ret = 1;
 272
 273  err:
 274     return ret;
 275 }
 276
 277 /*
 278  * Tries to extract a TS_TST_INFO structure from the PKCS7 token and
 279  * calls the internal int_TS_RESP_verify_token function for verifying it.
 280  */
 281 int TS_RESP_verify_token(TS_VERIFY_CTX *ctx, PKCS7 *token)
 282 {
 283     TS_TST_INFO *tst_info = PKCS7_to_TS_TST_INFO(token);
 284     int ret = 0;
 285     if (tst_info) {
 286         ret = int_ts_RESP_verify_token(ctx, token, tst_info);
 287         TS_TST_INFO_free(tst_info);
 288     }
 289     return ret;
 290 }
 291
 292 /*-
 293  * Verifies whether the 'token' contains a valid time stamp token
 294  * with regards to the settings of the context. Only those checks are
 295  * carried out that are specified in the context:
 296  *      - Verifies the signature of the TS_TST_INFO.
 297  *      - Checks the version number of the response.
 298  *      - Check if the requested and returned policies math.
 299  *      - Check if the message imprints are the same.
 300  *      - Check if the nonces are the same.
 301  *      - Check if the TSA name matches the signer.
 302  *      - Check if the TSA name is the expected TSA.
 303  */
 304 static int int_ts_RESP_verify_token(TS_VERIFY_CTX *ctx,
 305                                     PKCS7 *token, TS_TST_INFO *tst_info)
 306 {
 307     X509 *signer = NULL;
 308     GENERAL_NAME *tsa_name = tst_info->tsa;
 309     X509_ALGOR *md_alg = NULL;
 310     unsigned char *imprint = NULL;
 311     unsigned imprint_len = 0;
 312     int ret = 0;
 313     int flags = ctx->flags;
 314
 315     /* Some options require us to also check the signature */
 316     if (((flags & TS_VFY_SIGNER) && tsa_name != NULL)
 317             || (flags & TS_VFY_TSA_NAME)) {
 318         flags |= TS_VFY_SIGNATURE;
 319     }
 320
 321     if ((flags & TS_VFY_SIGNATURE)
 322         && !TS_RESP_verify_signature(token, ctx->certs, ctx->store, &signer))
 323         goto err;
 324     if ((flags & TS_VFY_VERSION)
 325         && TS_TST_INFO_get_version(tst_info) != 1) {
 326         ERR_raise(ERR_LIB_TS, TS_R_UNSUPPORTED_VERSION);
 327         goto err;
 328     }
 329     if ((flags & TS_VFY_POLICY)
 330         && !ts_check_policy(ctx->policy, tst_info))
 331         goto err;
 332     if ((flags & TS_VFY_IMPRINT)
 333         && !ts_check_imprints(ctx->md_alg, ctx->imprint, ctx->imprint_len,
 334                               tst_info))
 335         goto err;
 336     if ((flags & TS_VFY_DATA)
 337         && (!ts_compute_imprint(ctx->data, tst_info,
 338                                 &md_alg, &imprint, &imprint_len)
 339             || !ts_check_imprints(md_alg, imprint, imprint_len, tst_info)))
 340         goto err;
 341     if ((flags & TS_VFY_NONCE)
 342         && !ts_check_nonces(ctx->nonce, tst_info))
 343         goto err;
 344     if ((flags & TS_VFY_SIGNER)
 345         && tsa_name && !ts_check_signer_name(tsa_name, signer)) {
 346         ERR_raise(ERR_LIB_TS, TS_R_TSA_NAME_MISMATCH);
 347         goto err;
 348     }
 349     if ((flags & TS_VFY_TSA_NAME)
 350         && !ts_check_signer_name(ctx->tsa_name, signer)) {
 351         ERR_raise(ERR_LIB_TS, TS_R_TSA_UNTRUSTED);
 352         goto err;
 353     }
 354     ret = 1;
 355
 356  err:
 357     X509_free(signer);
 358     X509_ALGOR_free(md_alg);
 359     OPENSSL_free(imprint);
 360     return ret;
 361 }
 362
 363 static int ts_check_status_info(TS_RESP *response)
 364 {
 365     TS_STATUS_INFO *info = response->status_info;
 366     long status = ASN1_INTEGER_get(info->status);
 367     const char *status_text = NULL;
 368     char *embedded_status_text = NULL;
 369     char failure_text[TS_STATUS_BUF_SIZE] = "";
 370
 371     if (status == 0 || status == 1)
 372         return 1;
 373
 374     /* There was an error, get the description in status_text. */
 375     if (0 <= status && status < (long) OSSL_NELEM(ts_status_text))
 376         status_text = ts_status_text[status];
 377     else
 378         status_text = "unknown code";
 379
 380     if (sk_ASN1_UTF8STRING_num(info->text) > 0
 381         && (embedded_status_text = ts_get_status_text(info->text)) == NULL)
 382         return 0;
 383
 384     /* Fill in failure_text with the failure information. */
 385     if (info->failure_info) {
 386         int i;
 387         int first = 1;
 388         for (i = 0; i < (int)OSSL_NELEM(ts_failure_info); ++i) {
 389             if (ASN1_BIT_STRING_get_bit(info->failure_info,
 390                                         ts_failure_info[i].code)) {
 391                 if (!first)
 392                     strcat(failure_text, ",");
 393                 else
 394                     first = 0;
 395                 strcat(failure_text, ts_failure_info[i].text);
 396             }
 397         }
 398     }
 399     if (failure_text[0] == '\0')
 400         strcpy(failure_text, "unspecified");
 401
 402     ERR_raise_data(ERR_LIB_TS, TS_R_NO_TIME_STAMP_TOKEN,
 403                    "status code: %s, status text: %s, failure codes: %s",
 404                    status_text,
 405                    embedded_status_text ? embedded_status_text : "unspecified",
 406                    failure_text);
 407     OPENSSL_free(embedded_status_text);
 408
 409     return 0;
 410 }
 411
 412 static char *ts_get_status_text(STACK_OF(ASN1_UTF8STRING) *text)
 413 {
 414     return sk_ASN1_UTF8STRING2text(text, "/", TS_MAX_STATUS_LENGTH);
 415 }
 416
 417 static int ts_check_policy(const ASN1_OBJECT *req_oid,
 418                            const TS_TST_INFO *tst_info)
 419 {
 420     const ASN1_OBJECT *resp_oid = tst_info->policy_id;
 421
 422     if (OBJ_cmp(req_oid, resp_oid) != 0) {
 423         ERR_raise(ERR_LIB_TS, TS_R_POLICY_MISMATCH);
 424         return 0;
 425     }
 426
 427     return 1;
 428 }
 429
 430 static int ts_compute_imprint(BIO *data, TS_TST_INFO *tst_info,
 431                               X509_ALGOR **md_alg,
 432                               unsigned char **imprint, unsigned *imprint_len)
 433 {
 434     TS_MSG_IMPRINT *msg_imprint = tst_info->msg_imprint;
 435     X509_ALGOR *md_alg_resp = msg_imprint->hash_algo;
 436     const EVP_MD *md;
 437     EVP_MD_CTX *md_ctx = NULL;
 438     unsigned char buffer[4096];
 439     int length;
 440
 441     *md_alg = NULL;
 442     *imprint = NULL;
 443
 444     if ((*md_alg = X509_ALGOR_dup(md_alg_resp)) == NULL)
 445         goto err;
 446     if ((md = EVP_get_digestbyobj((*md_alg)->algorithm)) == NULL) {
 447         ERR_raise(ERR_LIB_TS, TS_R_UNSUPPORTED_MD_ALGORITHM);
 448         goto err;
 449     }
 450     length = EVP_MD_size(md);
 451     if (length < 0)
 452         goto err;
 453     *imprint_len = length;
 454     if ((*imprint = OPENSSL_malloc(*imprint_len)) == NULL) {
 455         ERR_raise(ERR_LIB_TS, ERR_R_MALLOC_FAILURE);
 456         goto err;
 457     }
 458
 459     md_ctx = EVP_MD_CTX_new();
 460     if (md_ctx == NULL) {
 461         ERR_raise(ERR_LIB_TS, ERR_R_MALLOC_FAILURE);
 462         goto err;
 463     }
 464     if (!EVP_DigestInit(md_ctx, md))
 465         goto err;
 466     while ((length = BIO_read(data, buffer, sizeof(buffer))) > 0) {
 467         if (!EVP_DigestUpdate(md_ctx, buffer, length))
 468             goto err;
 469     }
 470     if (!EVP_DigestFinal(md_ctx, *imprint, NULL))
 471         goto err;
 472     EVP_MD_CTX_free(md_ctx);
 473
 474     return 1;
 475  err:
 476     EVP_MD_CTX_free(md_ctx);
 477     X509_ALGOR_free(*md_alg);
 478     OPENSSL_free(*imprint);
 479     *imprint_len = 0;
 480     *imprint = 0;
 481     return 0;
 482 }
 483
 484 static int ts_check_imprints(X509_ALGOR *algor_a,
 485                              const unsigned char *imprint_a, unsigned len_a,
 486                              TS_TST_INFO *tst_info)
 487 {
 488     TS_MSG_IMPRINT *b = tst_info->msg_imprint;
 489     X509_ALGOR *algor_b = b->hash_algo;
 490     int ret = 0;
 491
 492     if (algor_a) {
 493         if (OBJ_cmp(algor_a->algorithm, algor_b->algorithm))
 494             goto err;
 495
 496         /* The parameter must be NULL in both. */
 497         if ((algor_a->parameter
 498              && ASN1_TYPE_get(algor_a->parameter) != V_ASN1_NULL)
 499             || (algor_b->parameter
 500                 && ASN1_TYPE_get(algor_b->parameter) != V_ASN1_NULL))
 501             goto err;
 502     }
 503
 504     ret = len_a == (unsigned)ASN1_STRING_length(b->hashed_msg) &&
 505         memcmp(imprint_a, ASN1_STRING_get0_data(b->hashed_msg), len_a) == 0;
 506  err:
 507     if (!ret)
 508         ERR_raise(ERR_LIB_TS, TS_R_MESSAGE_IMPRINT_MISMATCH);
 509     return ret;
 510 }
 511
 512 static int ts_check_nonces(const ASN1_INTEGER *a, TS_TST_INFO *tst_info)
 513 {
 514     const ASN1_INTEGER *b = tst_info->nonce;
 515
 516     if (!b) {
 517         ERR_raise(ERR_LIB_TS, TS_R_NONCE_NOT_RETURNED);
 518         return 0;
 519     }
 520
 521     /* No error if a nonce is returned without being requested. */
 522     if (ASN1_INTEGER_cmp(a, b) != 0) {
 523         ERR_raise(ERR_LIB_TS, TS_R_NONCE_MISMATCH);
 524         return 0;
 525     }
 526
 527     return 1;
 528 }
 529
 530 /*
 531  * Check if the specified TSA name matches either the subject or one of the
 532  * subject alternative names of the TSA certificate.
 533  */
 534 static int ts_check_signer_name(GENERAL_NAME *tsa_name, X509 *signer)
 535 {
 536     STACK_OF(GENERAL_NAME) *gen_names = NULL;
 537     int idx = -1;
 538     int found = 0;
 539
 540     if (tsa_name->type == GEN_DIRNAME
 541         && X509_name_cmp(tsa_name->d.dirn, X509_get_subject_name(signer)) == 0)
 542         return 1;
 543     gen_names = X509_get_ext_d2i(signer, NID_subject_alt_name, NULL, &idx);
 544     while (gen_names != NULL) {
 545         found = ts_find_name(gen_names, tsa_name) >= 0;
 546         if (found)
 547             break;
 548         /*
 549          * Get the next subject alternative name, although there should be no
 550          * more than one.
 551          */
 552         GENERAL_NAMES_free(gen_names);
 553         gen_names = X509_get_ext_d2i(signer, NID_subject_alt_name, NULL, &idx);
 554     }
 555     GENERAL_NAMES_free(gen_names);
 556
 557     return found;
 558 }
 559
 560 /* Returns 1 if name is in gen_names, 0 otherwise. */
 561 static int ts_find_name(STACK_OF(GENERAL_NAME) *gen_names, GENERAL_NAME *name)
 562 {
 563     int i, found;
 564     for (i = 0, found = 0; !found && i < sk_GENERAL_NAME_num(gen_names); ++i) {
 565         GENERAL_NAME *current = sk_GENERAL_NAME_value(gen_names, i);
 566         found = GENERAL_NAME_cmp(current, name) == 0;
 567     }
 568     return found ? i - 1 : -1;
 569 }