test/ct_test.c

   1 /*
   2  * Copyright 2016-2018 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 <ctype.h>
  11 #include <stdio.h>
  12 #include <stdlib.h>
  13 #include <string.h>
  14
  15 #include <openssl/ct.h>
  16 #include <openssl/err.h>
  17 #include <openssl/pem.h>
  18 #include <openssl/x509.h>
  19 #include <openssl/x509v3.h>
  20 #include "testutil.h"
  21 #include <openssl/crypto.h>
  22
  23 #ifndef OPENSSL_NO_CT
  24 /* Used when declaring buffers to read text files into */
  25 # define CT_TEST_MAX_FILE_SIZE 8096
  26
  27 static char *certs_dir = NULL;
  28 static char *ct_dir = NULL;
  29
  30 typedef struct ct_test_fixture {
  31     const char *test_case_name;
  32     /* The current time in milliseconds */
  33     uint64_t epoch_time_in_ms;
  34     /* The CT log store to use during tests */
  35     CTLOG_STORE* ctlog_store;
  36     /* Set the following to test handling of SCTs in X509 certificates */
  37     const char *certs_dir;
  38     char *certificate_file;
  39     char *issuer_file;
  40     /* Expected number of SCTs */
  41     int expected_sct_count;
  42     /* Expected number of valid SCTS */
  43     int expected_valid_sct_count;
  44     /* Set the following to test handling of SCTs in TLS format */
  45     const unsigned char *tls_sct_list;
  46     size_t tls_sct_list_len;
  47     STACK_OF(SCT) *sct_list;
  48     /*
  49      * A file to load the expected SCT text from.
  50      * This text will be compared to the actual text output during the test.
  51      * A maximum of |CT_TEST_MAX_FILE_SIZE| bytes will be read of this file.
  52      */
  53     const char *sct_dir;
  54     const char *sct_text_file;
  55     /* Whether to test the validity of the SCT(s) */
  56     int test_validity;
  57 } CT_TEST_FIXTURE;
  58
  59 static CT_TEST_FIXTURE *set_up(const char *const test_case_name)
  60 {
  61     CT_TEST_FIXTURE *fixture = NULL;
  62
  63     if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
  64         goto end;
  65     fixture->test_case_name = test_case_name;
  66     fixture->epoch_time_in_ms = 1580335307000ULL; /* Wed 29 Jan 2020 10:01:47 PM UTC */
  67     if (!TEST_ptr(fixture->ctlog_store = CTLOG_STORE_new())
  68             || !TEST_int_eq(
  69                     CTLOG_STORE_load_default_file(fixture->ctlog_store), 1))
  70         goto end;
  71     return fixture;
  72
  73 end:
  74     if (fixture != NULL)
  75         CTLOG_STORE_free(fixture->ctlog_store);
  76     OPENSSL_free(fixture);
  77     TEST_error("Failed to setup");
  78     return NULL;
  79 }
  80
  81 static void tear_down(CT_TEST_FIXTURE *fixture)
  82 {
  83     if (fixture != NULL) {
  84         CTLOG_STORE_free(fixture->ctlog_store);
  85         SCT_LIST_free(fixture->sct_list);
  86     }
  87     OPENSSL_free(fixture);
  88 }
  89
  90 static X509 *load_pem_cert(const char *dir, const char *file)
  91 {
  92     X509 *cert = NULL;
  93     char *file_path = test_mk_file_path(dir, file);
  94
  95     if (file_path != NULL) {
  96         BIO *cert_io = BIO_new_file(file_path, "r");
  97
  98         if (cert_io != NULL)
  99             cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
 100         BIO_free(cert_io);
 101     }
 102
 103     OPENSSL_free(file_path);
 104     return cert;
 105 }
 106
 107 static int read_text_file(const char *dir, const char *file,
 108                           char *buffer, int buffer_length)
 109 {
 110     int len = -1;
 111     char *file_path = test_mk_file_path(dir, file);
 112
 113     if (file_path != NULL) {
 114         BIO *file_io = BIO_new_file(file_path, "r");
 115
 116         if (file_io != NULL)
 117             len = BIO_read(file_io, buffer, buffer_length);
 118         BIO_free(file_io);
 119     }
 120
 121     OPENSSL_free(file_path);
 122     return len;
 123 }
 124
 125 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
 126                                      const char *expected_output)
 127 {
 128     BIO *text_buffer = NULL;
 129     char *actual_output = NULL;
 130     int result = 0;
 131
 132     if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem())))
 133         goto end;
 134
 135     SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
 136
 137     /* Append \0 because we're about to use the buffer contents as a string. */
 138     if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
 139         goto end;
 140
 141     BIO_get_mem_data(text_buffer, &actual_output);
 142     if (!TEST_str_eq(actual_output, expected_output))
 143         goto end;
 144     result = 1;
 145
 146 end:
 147     BIO_free(text_buffer);
 148     return result;
 149 }
 150
 151 static int compare_extension_printout(X509_EXTENSION *extension,
 152                                       const char *expected_output)
 153 {
 154     BIO *text_buffer = NULL;
 155     char *actual_output = NULL;
 156     int result = 0;
 157
 158     if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem()))
 159             || !TEST_true(X509V3_EXT_print(text_buffer, extension,
 160                                            X509V3_EXT_DEFAULT, 0)))
 161         goto end;
 162
 163     /* Append \n because it's easier to create files that end with one. */
 164     if (!TEST_true(BIO_write(text_buffer, "\n", 1)))
 165         goto end;
 166
 167     /* Append \0 because we're about to use the buffer contents as a string. */
 168     if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
 169         goto end;
 170
 171     BIO_get_mem_data(text_buffer, &actual_output);
 172     if (!TEST_str_eq(actual_output, expected_output))
 173         goto end;
 174
 175     result = 1;
 176
 177 end:
 178     BIO_free(text_buffer);
 179     return result;
 180 }
 181
 182 static int assert_validity(CT_TEST_FIXTURE *fixture, STACK_OF(SCT) *scts,
 183                            CT_POLICY_EVAL_CTX *policy_ctx)
 184 {
 185     int invalid_sct_count = 0;
 186     int valid_sct_count = 0;
 187     int i;
 188
 189     if (!TEST_int_ge(SCT_LIST_validate(scts, policy_ctx), 0))
 190         return 0;
 191
 192     for (i = 0; i < sk_SCT_num(scts); ++i) {
 193         SCT *sct_i = sk_SCT_value(scts, i);
 194
 195         switch (SCT_get_validation_status(sct_i)) {
 196         case SCT_VALIDATION_STATUS_VALID:
 197             ++valid_sct_count;
 198             break;
 199         case SCT_VALIDATION_STATUS_INVALID:
 200             ++invalid_sct_count;
 201             break;
 202         case SCT_VALIDATION_STATUS_NOT_SET:
 203         case SCT_VALIDATION_STATUS_UNKNOWN_LOG:
 204         case SCT_VALIDATION_STATUS_UNVERIFIED:
 205         case SCT_VALIDATION_STATUS_UNKNOWN_VERSION:
 206             /* Ignore other validation statuses. */
 207             break;
 208         }
 209     }
 210
 211     if (!TEST_int_eq(valid_sct_count, fixture->expected_valid_sct_count)) {
 212         int unverified_sct_count = sk_SCT_num(scts) -
 213                                         invalid_sct_count - valid_sct_count;
 214
 215         TEST_info("%d SCTs failed, %d SCTs unverified",
 216                   invalid_sct_count, unverified_sct_count);
 217         return 0;
 218     }
 219
 220     return 1;
 221 }
 222
 223 static int execute_cert_test(CT_TEST_FIXTURE *fixture)
 224 {
 225     int success = 0;
 226     X509 *cert = NULL, *issuer = NULL;
 227     STACK_OF(SCT) *scts = NULL;
 228     SCT *sct = NULL;
 229     char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
 230     int sct_text_len = 0;
 231     unsigned char *tls_sct_list = NULL;
 232     size_t tls_sct_list_len = 0;
 233     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
 234
 235     if (fixture->sct_text_file != NULL) {
 236         sct_text_len = read_text_file(fixture->sct_dir, fixture->sct_text_file,
 237                                       expected_sct_text,
 238                                       CT_TEST_MAX_FILE_SIZE - 1);
 239
 240         if (!TEST_int_ge(sct_text_len, 0))
 241             goto end;
 242         expected_sct_text[sct_text_len] = '\0';
 243     }
 244
 245     CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
 246             ct_policy_ctx, fixture->ctlog_store);
 247
 248     CT_POLICY_EVAL_CTX_set_time(ct_policy_ctx, fixture->epoch_time_in_ms);
 249
 250     if (fixture->certificate_file != NULL) {
 251         int sct_extension_index;
 252         int i;
 253         X509_EXTENSION *sct_extension = NULL;
 254
 255         if (!TEST_ptr(cert = load_pem_cert(fixture->certs_dir,
 256                                            fixture->certificate_file)))
 257             goto end;
 258
 259         CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
 260
 261         if (fixture->issuer_file != NULL) {
 262             if (!TEST_ptr(issuer = load_pem_cert(fixture->certs_dir,
 263                                                  fixture->issuer_file)))
 264                 goto end;
 265             CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
 266         }
 267
 268         sct_extension_index =
 269                 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
 270         sct_extension = X509_get_ext(cert, sct_extension_index);
 271         if (fixture->expected_sct_count > 0) {
 272             if (!TEST_ptr(sct_extension))
 273                 goto end;
 274
 275             if (fixture->sct_text_file
 276                 && !compare_extension_printout(sct_extension,
 277                                                expected_sct_text))
 278                     goto end;
 279
 280             scts = X509V3_EXT_d2i(sct_extension);
 281             for (i = 0; i < sk_SCT_num(scts); ++i) {
 282                 SCT *sct_i = sk_SCT_value(scts, i);
 283
 284                 if (!TEST_int_eq(SCT_get_source(sct_i),
 285                                  SCT_SOURCE_X509V3_EXTENSION)) {
 286                     goto end;
 287                 }
 288             }
 289
 290             if (fixture->test_validity) {
 291                 if (!assert_validity(fixture, scts, ct_policy_ctx))
 292                     goto end;
 293             }
 294         } else if (!TEST_ptr_null(sct_extension)) {
 295             goto end;
 296         }
 297     }
 298
 299     if (fixture->tls_sct_list != NULL) {
 300         const unsigned char *p = fixture->tls_sct_list;
 301
 302         if (!TEST_ptr(o2i_SCT_LIST(&scts, &p, fixture->tls_sct_list_len)))
 303             goto end;
 304
 305         if (fixture->test_validity && cert != NULL) {
 306             if (!assert_validity(fixture, scts, ct_policy_ctx))
 307                 goto end;
 308         }
 309
 310         if (fixture->sct_text_file
 311             && !compare_sct_list_printout(scts, expected_sct_text)) {
 312                 goto end;
 313         }
 314
 315         tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
 316         if (!TEST_mem_eq(fixture->tls_sct_list, fixture->tls_sct_list_len,
 317                          tls_sct_list, tls_sct_list_len))
 318             goto end;
 319     }
 320     success = 1;
 321
 322 end:
 323     X509_free(cert);
 324     X509_free(issuer);
 325     SCT_LIST_free(scts);
 326     SCT_free(sct);
 327     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
 328     OPENSSL_free(tls_sct_list);
 329     return success;
 330 }
 331
 332 # define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
 333 # define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
 334
 335 static int test_no_scts_in_certificate(void)
 336 {
 337     SETUP_CT_TEST_FIXTURE();
 338     if (fixture == NULL)
 339         return 0;
 340     fixture->certs_dir = certs_dir;
 341     fixture->certificate_file = "leaf.pem";
 342     fixture->issuer_file = "subinterCA.pem";
 343     fixture->expected_sct_count = 0;
 344     EXECUTE_CT_TEST();
 345     return result;
 346 }
 347
 348 static int test_one_sct_in_certificate(void)
 349 {
 350     SETUP_CT_TEST_FIXTURE();
 351     if (fixture == NULL)
 352         return 0;
 353     fixture->certs_dir = certs_dir;
 354     fixture->certificate_file = "embeddedSCTs1.pem";
 355     fixture->issuer_file = "embeddedSCTs1_issuer.pem";
 356     fixture->expected_sct_count = 1;
 357     fixture->sct_dir = certs_dir;
 358     fixture->sct_text_file = "embeddedSCTs1.sct";
 359     EXECUTE_CT_TEST();
 360     return result;
 361 }
 362
 363 static int test_multiple_scts_in_certificate(void)
 364 {
 365     SETUP_CT_TEST_FIXTURE();
 366     if (fixture == NULL)
 367         return 0;
 368     fixture->certs_dir = certs_dir;
 369     fixture->certificate_file = "embeddedSCTs3.pem";
 370     fixture->issuer_file = "embeddedSCTs3_issuer.pem";
 371     fixture->expected_sct_count = 3;
 372     fixture->sct_dir = certs_dir;
 373     fixture->sct_text_file = "embeddedSCTs3.sct";
 374     EXECUTE_CT_TEST();
 375     return result;
 376 }
 377
 378 static int test_verify_one_sct(void)
 379 {
 380     SETUP_CT_TEST_FIXTURE();
 381     if (fixture == NULL)
 382         return 0;
 383     fixture->certs_dir = certs_dir;
 384     fixture->certificate_file = "embeddedSCTs1.pem";
 385     fixture->issuer_file = "embeddedSCTs1_issuer.pem";
 386     fixture->expected_sct_count = fixture->expected_valid_sct_count = 1;
 387     fixture->test_validity = 1;
 388     EXECUTE_CT_TEST();
 389     return result;
 390 }
 391
 392 static int test_verify_multiple_scts(void)
 393 {
 394     SETUP_CT_TEST_FIXTURE();
 395     if (fixture == NULL)
 396         return 0;
 397     fixture->certs_dir = certs_dir;
 398     fixture->certificate_file = "embeddedSCTs3.pem";
 399     fixture->issuer_file = "embeddedSCTs3_issuer.pem";
 400     fixture->expected_sct_count = fixture->expected_valid_sct_count = 3;
 401     fixture->test_validity = 1;
 402     EXECUTE_CT_TEST();
 403     return result;
 404 }
 405
 406 static int test_verify_fails_for_future_sct(void)
 407 {
 408     SETUP_CT_TEST_FIXTURE();
 409     if (fixture == NULL)
 410         return 0;
 411     fixture->epoch_time_in_ms = 1365094800000ULL; /* Apr 4 17:00:00 2013 GMT */
 412     fixture->certs_dir = certs_dir;
 413     fixture->certificate_file = "embeddedSCTs1.pem";
 414     fixture->issuer_file = "embeddedSCTs1_issuer.pem";
 415     fixture->expected_sct_count = 1;
 416     fixture->expected_valid_sct_count = 0;
 417     fixture->test_validity = 1;
 418     EXECUTE_CT_TEST();
 419     return result;
 420 }
 421
 422 static int test_decode_tls_sct(void)
 423 {
 424     const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
 425         "\x00\x76"
 426         "\x00" /* version */
 427         /* log ID */
 428         "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
 429         "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
 430         "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
 431         "\x00\x00" /* extensions length */
 432         "" /* extensions */
 433         "\x04\x03" /* hash and signature algorithms */
 434         "\x00\x47" /* signature length */
 435         /* signature */
 436         "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
 437         "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
 438         "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
 439         "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
 440         "\xED\xBF\x08";
 441
 442     SETUP_CT_TEST_FIXTURE();
 443     if (fixture == NULL)
 444         return 0;
 445     fixture->tls_sct_list = tls_sct_list;
 446     fixture->tls_sct_list_len = 0x7a;
 447     fixture->sct_dir = ct_dir;
 448     fixture->sct_text_file = "tls1.sct";
 449     EXECUTE_CT_TEST();
 450     return result;
 451 }
 452
 453 static int test_encode_tls_sct(void)
 454 {
 455     const char log_id[] = "3xwuwRUAlFJHqWFoMl3cXHlZ6PfG04j8AC4LvT9012Q=";
 456     const uint64_t timestamp = 1;
 457     const char extensions[] = "";
 458     const char signature[] = "BAMARzBAMiBIL2dRrzXbplQ2vh/WZA89v5pBQpSVkkUwKI+j5"
 459             "eI+BgIhAOTtwNs6xXKx4vXoq2poBlOYfc9BAn3+/6EFUZ2J7b8I";
 460     SCT *sct = NULL;
 461
 462     SETUP_CT_TEST_FIXTURE();
 463     if (fixture == NULL)
 464         return 0;
 465
 466     fixture->sct_list = sk_SCT_new_null();
 467     if (!TEST_ptr(sct = SCT_new_from_base64(SCT_VERSION_V1, log_id,
 468                                             CT_LOG_ENTRY_TYPE_X509, timestamp,
 469                                             extensions, signature)))
 470
 471         return 0;
 472
 473     sk_SCT_push(fixture->sct_list, sct);
 474     fixture->sct_dir = ct_dir;
 475     fixture->sct_text_file = "tls1.sct";
 476     EXECUTE_CT_TEST();
 477     return result;
 478 }
 479
 480 /*
 481  * Tests that the CT_POLICY_EVAL_CTX default time is approximately now.
 482  * Allow +-10 minutes, as it may compensate for clock skew.
 483  */
 484 static int test_default_ct_policy_eval_ctx_time_is_now(void)
 485 {
 486     int success = 0;
 487     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
 488     const time_t default_time =
 489         (time_t)(CT_POLICY_EVAL_CTX_get_time(ct_policy_ctx) / 1000);
 490     const time_t time_tolerance = 600;  /* 10 minutes */
 491
 492     if (!TEST_time_t_le(abs((int)difftime(time(NULL), default_time)),
 493                         time_tolerance))
 494         goto end;
 495
 496     success = 1;
 497 end:
 498     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
 499     return success;
 500 }
 501
 502 static int test_ctlog_from_base64(void)
 503 {
 504     CTLOG *ctlogp = NULL;
 505     const char notb64[] = "\01\02\03\04";
 506     const char pad[] = "====";
 507     const char name[] = "name";
 508
 509     /* We expect these to both fail! */
 510     if (!TEST_true(!CTLOG_new_from_base64(&ctlogp, notb64, name))
 511         || !TEST_true(!CTLOG_new_from_base64(&ctlogp, pad, name)))
 512         return 0;
 513     return 1;
 514 }
 515 #endif
 516
 517 int setup_tests(void)
 518 {
 519 #ifndef OPENSSL_NO_CT
 520     if ((ct_dir = getenv("CT_DIR")) == NULL)
 521         ct_dir = "ct";
 522     if ((certs_dir = getenv("CERTS_DIR")) == NULL)
 523         certs_dir = "certs";
 524
 525     ADD_TEST(test_no_scts_in_certificate);
 526     ADD_TEST(test_one_sct_in_certificate);
 527     ADD_TEST(test_multiple_scts_in_certificate);
 528     ADD_TEST(test_verify_one_sct);
 529     ADD_TEST(test_verify_multiple_scts);
 530     ADD_TEST(test_verify_fails_for_future_sct);
 531     ADD_TEST(test_decode_tls_sct);
 532     ADD_TEST(test_encode_tls_sct);
 533     ADD_TEST(test_default_ct_policy_eval_ctx_time_is_now);
 534     ADD_TEST(test_ctlog_from_base64);
 535 #else
 536     printf("No CT support\n");
 537 #endif
 538     return 1;
 539 }