test/ct_test.c

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