test/ct_test.c

   1 /*
   2  * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (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
  22 #ifndef OPENSSL_NO_CT
  23
  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 CT log store to use during tests */
  33     CTLOG_STORE* ctlog_store;
  34     /* Set the following to test handling of SCTs in X509 certificates */
  35     const char *certs_dir;
  36     char *certificate_file;
  37     char *issuer_file;
  38     int expected_sct_count;
  39     /* Set the following to test handling of SCTs in TLS format */
  40     const unsigned char *tls_sct_list;
  41     size_t tls_sct_list_len;
  42     STACK_OF(SCT) *sct_list;
  43     /*
  44      * A file to load the expected SCT text from.
  45      * This text will be compared to the actual text output during the test.
  46      * A maximum of |CT_TEST_MAX_FILE_SIZE| bytes will be read of this file.
  47      */
  48     const char *sct_dir;
  49     const char *sct_text_file;
  50     /* Whether to test the validity of the SCT(s) */
  51     int test_validity;
  52
  53 } CT_TEST_FIXTURE;
  54
  55 static CT_TEST_FIXTURE set_up(const char *const test_case_name)
  56 {
  57     CT_TEST_FIXTURE fixture;
  58     int setup_ok = 1;
  59     CTLOG_STORE *ctlog_store;
  60
  61     memset(&fixture, 0, sizeof(fixture));
  62
  63     ctlog_store = CTLOG_STORE_new();
  64
  65     if (ctlog_store == NULL) {
  66         setup_ok = 0;
  67         fprintf(stderr, "Failed to create a new CT log store\n");
  68         goto end;
  69     }
  70
  71     if (CTLOG_STORE_load_default_file(ctlog_store) != 1) {
  72         setup_ok = 0;
  73         fprintf(stderr, "Failed to load CT log list\n");
  74         goto end;
  75     }
  76
  77     fixture.test_case_name = test_case_name;
  78     fixture.ctlog_store = ctlog_store;
  79
  80 end:
  81     if (!setup_ok) {
  82         exit(EXIT_FAILURE);
  83     }
  84     return fixture;
  85 }
  86
  87 static void tear_down(CT_TEST_FIXTURE fixture)
  88 {
  89     CTLOG_STORE_free(fixture.ctlog_store);
  90     SCT_LIST_free(fixture.sct_list);
  91     ERR_print_errors_fp(stderr);
  92 }
  93
  94 static char *mk_file_path(const char *dir, const char *file)
  95 {
  96     char *full_file = NULL;
  97     size_t full_file_l = 0;
  98     const char *sep = "";
  99 #ifndef OPENSSL_SYS_VMS
 100     sep = "/";
 101 #endif
 102
 103     full_file_l = strlen(dir) + strlen(sep) + strlen(file) + 1;
 104     full_file = OPENSSL_zalloc(full_file_l);
 105     if (full_file != NULL) {
 106         OPENSSL_strlcpy(full_file, dir, full_file_l);
 107         OPENSSL_strlcat(full_file, sep, full_file_l);
 108         OPENSSL_strlcat(full_file, file, full_file_l);
 109     }
 110
 111     return full_file;
 112 }
 113
 114 static X509 *load_pem_cert(const char *dir, const char *file)
 115 {
 116     X509 *cert = NULL;
 117     char *file_path = mk_file_path(dir, file);
 118
 119     if (file_path != NULL) {
 120         BIO *cert_io = BIO_new_file(file_path, "r");
 121         OPENSSL_free(file_path);
 122
 123         if (cert_io != NULL)
 124             cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
 125
 126         BIO_free(cert_io);
 127     }
 128     return cert;
 129 }
 130
 131 static int read_text_file(const char *dir, const char *file,
 132                           char *buffer, int buffer_length)
 133 {
 134     int result = -1;
 135     char *file_path = mk_file_path(dir, file);
 136
 137     if (file_path != NULL) {
 138         BIO *file_io = BIO_new_file(file_path, "r");
 139         OPENSSL_free(file_path);
 140
 141         if (file_io != NULL) {
 142             result = BIO_read(file_io, buffer, buffer_length);
 143             BIO_free(file_io);
 144         }
 145     }
 146
 147     return result;
 148 }
 149
 150 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
 151     const char *expected_output)
 152 {
 153     BIO *text_buffer = NULL;
 154     char *actual_output = NULL;
 155     int result = 1;
 156
 157     text_buffer = BIO_new(BIO_s_mem());
 158     if (text_buffer == NULL) {
 159         fprintf(stderr, "Unable to allocate buffer\n");
 160         goto end;
 161     }
 162
 163     SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
 164
 165     /* Append null terminator because we're about to use the buffer contents
 166     * as a string. */
 167     if (BIO_write(text_buffer, "\0", 1) != 1) {
 168         fprintf(stderr, "Failed to append null terminator to SCT text\n");
 169         goto end;
 170     }
 171
 172     BIO_get_mem_data(text_buffer, &actual_output);
 173     result = strcmp(actual_output, expected_output);
 174
 175     if (result != 0) {
 176         fprintf(stderr,
 177             "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
 178             expected_output, actual_output);
 179     }
 180
 181 end:
 182     BIO_free(text_buffer);
 183     return result;
 184 }
 185
 186 static int compare_extension_printout(X509_EXTENSION *extension,
 187                                       const char *expected_output)
 188 {
 189     BIO *text_buffer = NULL;
 190     char *actual_output = NULL;
 191     int result = 1;
 192
 193     text_buffer = BIO_new(BIO_s_mem());
 194     if (text_buffer == NULL) {
 195         fprintf(stderr, "Unable to allocate buffer\n");
 196         goto end;
 197     }
 198
 199     if (!X509V3_EXT_print(text_buffer, extension, X509V3_EXT_DEFAULT, 0)) {
 200         fprintf(stderr, "Failed to print extension\n");
 201         goto end;
 202     }
 203
 204     /* Append null terminator because we're about to use the buffer contents
 205      * as a string. */
 206     if (BIO_write(text_buffer, "\0", 1) != 1) {
 207         fprintf(stderr,
 208                 "Failed to append null terminator to extension text\n");
 209         goto end;
 210     }
 211
 212     BIO_get_mem_data(text_buffer, &actual_output);
 213     result = strcmp(actual_output, expected_output);
 214
 215     if (result != 0) {
 216         fprintf(stderr,
 217                 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
 218                 expected_output, actual_output);
 219     }
 220
 221 end:
 222     BIO_free(text_buffer);
 223     return result;
 224 }
 225
 226 static int assert_validity(CT_TEST_FIXTURE fixture,
 227                            STACK_OF(SCT) *scts,
 228                            CT_POLICY_EVAL_CTX *policy_ctx) {
 229     int invalid_sct_count = 0;
 230     int valid_sct_count = 0;
 231     int i;
 232
 233     if (SCT_LIST_validate(scts, policy_ctx) < 0) {
 234         fprintf(stderr, "Error verifying SCTs\n");
 235         return 0;
 236     }
 237
 238     for (i = 0; i < sk_SCT_num(scts); ++i) {
 239         SCT *sct_i = sk_SCT_value(scts, i);
 240         switch (SCT_get_validation_status(sct_i)) {
 241         case SCT_VALIDATION_STATUS_VALID:
 242             ++valid_sct_count;
 243             break;
 244         case SCT_VALIDATION_STATUS_INVALID:
 245             ++invalid_sct_count;
 246             break;
 247         case SCT_VALIDATION_STATUS_NOT_SET:
 248         case SCT_VALIDATION_STATUS_UNKNOWN_LOG:
 249         case SCT_VALIDATION_STATUS_UNVERIFIED:
 250         case SCT_VALIDATION_STATUS_UNKNOWN_VERSION:
 251             /* Ignore other validation statuses. */
 252             break;
 253         }
 254     }
 255
 256     if (valid_sct_count != fixture.expected_sct_count) {
 257         int unverified_sct_count = sk_SCT_num(scts) -
 258                 invalid_sct_count - valid_sct_count;
 259
 260         fprintf(stderr,
 261                 "%d SCTs failed verification\n"
 262                 "%d SCTs passed verification (%d expected)\n"
 263                 "%d SCTs were unverified\n",
 264                 invalid_sct_count,
 265                 valid_sct_count,
 266                 fixture.expected_sct_count,
 267                 unverified_sct_count);
 268         return 0;
 269     }
 270
 271     return 1;
 272 }
 273
 274 static int execute_cert_test(CT_TEST_FIXTURE fixture)
 275 {
 276     int success = 0;
 277     X509 *cert = NULL, *issuer = NULL;
 278     STACK_OF(SCT) *scts = NULL;
 279     SCT *sct = NULL;
 280     char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
 281     int sct_text_len = 0;
 282     unsigned char *tls_sct_list = NULL;
 283     size_t tls_sct_list_len = 0;
 284     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
 285
 286     if (fixture.sct_text_file != NULL) {
 287         sct_text_len = read_text_file(fixture.sct_dir, fixture.sct_text_file,
 288                                       expected_sct_text,
 289                                       CT_TEST_MAX_FILE_SIZE - 1);
 290
 291         if (sct_text_len < 0) {
 292             fprintf(stderr, "Test data file not found: %s\n",
 293                 fixture.sct_text_file);
 294             goto end;
 295         }
 296
 297         expected_sct_text[sct_text_len] = '\0';
 298     }
 299
 300     CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
 301             ct_policy_ctx, fixture.ctlog_store);
 302
 303     if (fixture.certificate_file != NULL) {
 304         int sct_extension_index;
 305         X509_EXTENSION *sct_extension = NULL;
 306         cert = load_pem_cert(fixture.certs_dir, fixture.certificate_file);
 307
 308         if (cert == NULL) {
 309             fprintf(stderr, "Unable to load certificate: %s\n",
 310                 fixture.certificate_file);
 311             goto end;
 312         }
 313
 314         CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
 315
 316         if (fixture.issuer_file != NULL) {
 317             issuer = load_pem_cert(fixture.certs_dir, fixture.issuer_file);
 318
 319             if (issuer == NULL) {
 320                 fprintf(stderr, "Unable to load issuer certificate: %s\n",
 321                         fixture.issuer_file);
 322                 goto end;
 323             }
 324
 325             CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
 326         }
 327
 328         sct_extension_index =
 329                 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
 330         sct_extension = X509_get_ext(cert, sct_extension_index);
 331         if (fixture.expected_sct_count > 0) {
 332             if (sct_extension == NULL) {
 333                 fprintf(stderr, "SCT extension not found in: %s\n",
 334                     fixture.certificate_file);
 335                 goto end;
 336             }
 337
 338             if (fixture.sct_text_file
 339                 && compare_extension_printout(sct_extension,
 340                                               expected_sct_text)) {
 341                     goto end;
 342             }
 343
 344             if (fixture.test_validity) {
 345                 int i;
 346
 347                 scts = X509V3_EXT_d2i(sct_extension);
 348                 for (i = 0; i < sk_SCT_num(scts); ++i) {
 349                     SCT *sct_i = sk_SCT_value(scts, i);
 350
 351                     if (!SCT_set_source(sct_i, SCT_SOURCE_X509V3_EXTENSION)) {
 352                         fprintf(stderr,
 353                                 "Error setting SCT source to X509v3 extension\n");
 354                         goto end;
 355                     }
 356                 }
 357
 358                 if (!assert_validity(fixture, scts, ct_policy_ctx))
 359                     goto end;
 360             }
 361         } else if (sct_extension != NULL) {
 362             fprintf(stderr,
 363                     "Expected no SCTs, but found SCT extension in: %s\n",
 364                     fixture.certificate_file);
 365             goto end;
 366         }
 367     }
 368
 369     if (fixture.tls_sct_list != NULL) {
 370         const unsigned char *p = fixture.tls_sct_list;
 371         if (o2i_SCT_LIST(&scts, &p, fixture.tls_sct_list_len) == NULL) {
 372             fprintf(stderr, "Failed to decode SCTs from TLS format\n");
 373             goto end;
 374         }
 375
 376         if (fixture.test_validity && cert != NULL) {
 377             if (!assert_validity(fixture, scts, ct_policy_ctx))
 378                 goto end;
 379         }
 380
 381         if (fixture.sct_text_file
 382             && compare_sct_list_printout(scts, expected_sct_text)) {
 383                 goto end;
 384         }
 385
 386         tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
 387         if (tls_sct_list_len != fixture.tls_sct_list_len ||
 388             memcmp(fixture.tls_sct_list, tls_sct_list, tls_sct_list_len) != 0) {
 389             fprintf(stderr,
 390                     "Failed to encode SCTs into TLS format correctly\n");
 391             goto end;
 392         }
 393     }
 394     success = 1;
 395
 396 end:
 397     X509_free(cert);
 398     X509_free(issuer);
 399     SCT_LIST_free(scts);
 400     SCT_free(sct);
 401     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
 402     OPENSSL_free(tls_sct_list);
 403     return success;
 404 }
 405
 406 #define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
 407 #define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
 408
 409 static int test_no_scts_in_certificate()
 410 {
 411     SETUP_CT_TEST_FIXTURE();
 412     fixture.certs_dir = certs_dir;
 413     fixture.certificate_file = "leaf.pem";
 414     fixture.issuer_file = "subinterCA.pem";
 415     fixture.expected_sct_count = 0;
 416     EXECUTE_CT_TEST();
 417 }
 418
 419 static int test_one_sct_in_certificate()
 420 {
 421     SETUP_CT_TEST_FIXTURE();
 422     fixture.certs_dir = certs_dir;
 423     fixture.certificate_file = "embeddedSCTs1.pem";
 424     fixture.issuer_file = "embeddedSCTs1_issuer.pem";
 425     fixture.expected_sct_count = 1;
 426     fixture.sct_dir = certs_dir;
 427     fixture.sct_text_file = "embeddedSCTs1.sct";
 428     EXECUTE_CT_TEST();
 429 }
 430
 431 static int test_multiple_scts_in_certificate()
 432 {
 433     SETUP_CT_TEST_FIXTURE();
 434     fixture.certs_dir = certs_dir;
 435     fixture.certificate_file = "embeddedSCTs3.pem";
 436     fixture.issuer_file = "embeddedSCTs3_issuer.pem";
 437     fixture.expected_sct_count = 3;
 438     fixture.sct_dir = certs_dir;
 439     fixture.sct_text_file = "embeddedSCTs3.sct";
 440     EXECUTE_CT_TEST();
 441 }
 442
 443 static int test_verify_one_sct()
 444 {
 445     SETUP_CT_TEST_FIXTURE();
 446     fixture.certs_dir = certs_dir;
 447     fixture.certificate_file = "embeddedSCTs1.pem";
 448     fixture.issuer_file = "embeddedSCTs1_issuer.pem";
 449     fixture.expected_sct_count = 1;
 450     fixture.test_validity = 1;
 451     EXECUTE_CT_TEST();
 452 }
 453
 454 static int test_verify_multiple_scts()
 455 {
 456     SETUP_CT_TEST_FIXTURE();
 457     fixture.certs_dir = certs_dir;
 458     fixture.certificate_file = "embeddedSCTs3.pem";
 459     fixture.issuer_file = "embeddedSCTs3_issuer.pem";
 460     fixture.expected_sct_count = 3;
 461     fixture.test_validity = 1;
 462     EXECUTE_CT_TEST();
 463 }
 464
 465 static int test_decode_tls_sct()
 466 {
 467     const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
 468         "\x00\x76"
 469         "\x00" /* version */
 470         /* log ID */
 471         "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
 472         "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
 473         "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
 474         "\x00\x00" /* extensions length */
 475         "" /* extensions */
 476         "\x04\x03" /* hash and signature algorithms */
 477         "\x00\x47" /* signature length */
 478         /* signature */
 479         "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
 480         "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
 481         "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
 482         "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
 483         "\xED\xBF\x08";
 484
 485     SETUP_CT_TEST_FIXTURE();
 486     fixture.tls_sct_list = tls_sct_list;
 487     fixture.tls_sct_list_len = 0x7a;
 488     fixture.sct_dir = ct_dir;
 489     fixture.sct_text_file = "tls1.sct";
 490     EXECUTE_CT_TEST();
 491 }
 492
 493 static int test_encode_tls_sct()
 494 {
 495     const unsigned char log_id[] = "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9"
 496             "\x61\x68\x32\x5D\xDC\x5C\x79\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E"
 497             "\x0B\xBD\x3F\x74\xD7\x64";
 498
 499     const unsigned char signature[] = "\x45\x02\x20\x48\x2F\x67\x51\xAF\x35"
 500             "\xDB\xA6\x54\x36\xBE\x1F\xD6\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95"
 501             "\x92\x45\x30\x28\x8F\xA3\xE5\xE2\x3E\x06\x02\x21\x00\xE4\xED\xC0"
 502             "\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB\x6A\x68\x06\x53\x98\x7D\xCF"
 503             "\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89\xED\xBF\x08";
 504
 505     SETUP_CT_TEST_FIXTURE();
 506
 507     STACK_OF(SCT) *sct_list = sk_SCT_new_null();
 508     SCT *sct = SCT_new();
 509     if (!SCT_set_version(sct, SCT_VERSION_V1)) {
 510         fprintf(stderr, "Failed to set SCT version\n");
 511         return 1;
 512     }
 513     if (!SCT_set1_log_id(sct, log_id, 32)) {
 514         fprintf(stderr, "Failed to set SCT log ID\n");
 515         return 1;
 516     }
 517     SCT_set_timestamp(sct, 1);
 518     if (!SCT_set_signature_nid(sct, NID_ecdsa_with_SHA256)) {
 519         fprintf(stderr, "Failed to set SCT signature NID\n");
 520         return 1;
 521     }
 522     if (!SCT_set1_signature(sct, signature, 71)) {
 523         fprintf(stderr, "Failed to set SCT signature\n");
 524         return 1;
 525     }
 526     sk_SCT_push(sct_list, sct);
 527
 528     fixture.sct_list = sct_list;
 529     fixture.sct_dir = ct_dir;
 530     fixture.sct_text_file = "tls1.sct";
 531     EXECUTE_CT_TEST();
 532 }
 533
 534 int main(int argc, char *argv[])
 535 {
 536     int result = 0;
 537     char *tmp_env = NULL;
 538
 539     tmp_env = getenv("OPENSSL_DEBUG_MEMORY");
 540     if (tmp_env != NULL && strcmp(tmp_env, "on") == 0)
 541         CRYPTO_set_mem_debug(1);
 542     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
 543
 544     tmp_env = getenv("CT_DIR");
 545     ct_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "ct");
 546     tmp_env = getenv("CERTS_DIR");
 547     certs_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "certs");
 548
 549     ADD_TEST(test_no_scts_in_certificate);
 550     ADD_TEST(test_one_sct_in_certificate);
 551     ADD_TEST(test_multiple_scts_in_certificate);
 552     ADD_TEST(test_verify_one_sct);
 553     ADD_TEST(test_verify_multiple_scts);
 554     ADD_TEST(test_decode_tls_sct);
 555     ADD_TEST(test_encode_tls_sct);
 556
 557     result = run_tests(argv[0]);
 558     ERR_print_errors_fp(stderr);
 559
 560     OPENSSL_free(ct_dir);
 561     OPENSSL_free(certs_dir);
 562
 563 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
 564     if (CRYPTO_mem_leaks_fp(stderr) <= 0)
 565         result = 1;
 566 #endif
 567
 568     return result;
 569 }
 570
 571 #else /* OPENSSL_NO_CT */
 572
 573 int main(int argc, char* argv[])
 574 {
 575     return EXIT_SUCCESS;
 576 }
 577
 578 #endif /* OPENSSL_NO_CT */