1 /* 2 * Copyright 2016-2019 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 #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 = 1473269626000ULL; /* Sep 7 17:33:46 2016 GMT */ 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 \0 because we're about to use the buffer contents as a string. */ 164 if (!TEST_true(BIO_write(text_buffer, "\0", 1))) 165 goto end; 166 167 BIO_get_mem_data(text_buffer, &actual_output); 168 if (!TEST_str_eq(actual_output, expected_output)) 169 goto end; 170 171 result = 1; 172 173 end: 174 BIO_free(text_buffer); 175 return result; 176 } 177 178 static int assert_validity(CT_TEST_FIXTURE *fixture, STACK_OF(SCT) *scts, 179 CT_POLICY_EVAL_CTX *policy_ctx) 180 { 181 int invalid_sct_count = 0; 182 int valid_sct_count = 0; 183 int i; 184 185 if (!TEST_int_ge(SCT_LIST_validate(scts, policy_ctx), 0)) 186 return 0; 187 188 for (i = 0; i < sk_SCT_num(scts); ++i) { 189 SCT *sct_i = sk_SCT_value(scts, i); 190 191 switch (SCT_get_validation_status(sct_i)) { 192 case SCT_VALIDATION_STATUS_VALID: 193 ++valid_sct_count; 194 break; 195 case SCT_VALIDATION_STATUS_INVALID: 196 ++invalid_sct_count; 197 break; 198 case SCT_VALIDATION_STATUS_NOT_SET: 199 case SCT_VALIDATION_STATUS_UNKNOWN_LOG: 200 case SCT_VALIDATION_STATUS_UNVERIFIED: 201 case SCT_VALIDATION_STATUS_UNKNOWN_VERSION: 202 /* Ignore other validation statuses. */ 203 break; 204 } 205 } 206 207 if (!TEST_int_eq(valid_sct_count, fixture->expected_valid_sct_count)) { 208 int unverified_sct_count = sk_SCT_num(scts) - 209 invalid_sct_count - valid_sct_count; 210 211 TEST_info("%d SCTs failed, %d SCTs unverified", 212 invalid_sct_count, unverified_sct_count); 213 return 0; 214 } 215 216 return 1; 217 } 218 219 static int execute_cert_test(CT_TEST_FIXTURE *fixture) 220 { 221 int success = 0; 222 X509 *cert = NULL, *issuer = NULL; 223 STACK_OF(SCT) *scts = NULL; 224 SCT *sct = NULL; 225 char expected_sct_text[CT_TEST_MAX_FILE_SIZE]; 226 int sct_text_len = 0; 227 unsigned char *tls_sct_list = NULL; 228 size_t tls_sct_list_len = 0; 229 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new(); 230 231 if (fixture->sct_text_file != NULL) { 232 sct_text_len = read_text_file(fixture->sct_dir, fixture->sct_text_file, 233 expected_sct_text, 234 CT_TEST_MAX_FILE_SIZE - 1); 235 236 if (!TEST_int_ge(sct_text_len, 0)) 237 goto end; 238 expected_sct_text[sct_text_len] = '\0'; 239 } 240 241 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE( 242 ct_policy_ctx, fixture->ctlog_store); 243 244 CT_POLICY_EVAL_CTX_set_time(ct_policy_ctx, fixture->epoch_time_in_ms); 245 246 if (fixture->certificate_file != NULL) { 247 int sct_extension_index; 248 int i; 249 X509_EXTENSION *sct_extension = NULL; 250 251 if (!TEST_ptr(cert = load_pem_cert(fixture->certs_dir, 252 fixture->certificate_file))) 253 goto end; 254 255 CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert); 256 257 if (fixture->issuer_file != NULL) { 258 if (!TEST_ptr(issuer = load_pem_cert(fixture->certs_dir, 259 fixture->issuer_file))) 260 goto end; 261 CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer); 262 } 263 264 sct_extension_index = 265 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1); 266 sct_extension = X509_get_ext(cert, sct_extension_index); 267 if (fixture->expected_sct_count > 0) { 268 if (!TEST_ptr(sct_extension)) 269 goto end; 270 271 if (fixture->sct_text_file 272 && !compare_extension_printout(sct_extension, 273 expected_sct_text)) 274 goto end; 275 276 scts = X509V3_EXT_d2i(sct_extension); 277 for (i = 0; i < sk_SCT_num(scts); ++i) { 278 SCT *sct_i = sk_SCT_value(scts, i); 279 280 if (!TEST_int_eq(SCT_get_source(sct_i), 281 SCT_SOURCE_X509V3_EXTENSION)) { 282 goto end; 283 } 284 } 285 286 if (fixture->test_validity) { 287 if (!assert_validity(fixture, scts, ct_policy_ctx)) 288 goto end; 289 } 290 } else if (!TEST_ptr_null(sct_extension)) { 291 goto end; 292 } 293 } 294 295 if (fixture->tls_sct_list != NULL) { 296 const unsigned char *p = fixture->tls_sct_list; 297 298 if (!TEST_ptr(o2i_SCT_LIST(&scts, &p, fixture->tls_sct_list_len))) 299 goto end; 300 301 if (fixture->test_validity && cert != NULL) { 302 if (!assert_validity(fixture, scts, ct_policy_ctx)) 303 goto end; 304 } 305 306 if (fixture->sct_text_file 307 && !compare_sct_list_printout(scts, expected_sct_text)) { 308 goto end; 309 } 310 311 tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list); 312 if (!TEST_mem_eq(fixture->tls_sct_list, fixture->tls_sct_list_len, 313 tls_sct_list, tls_sct_list_len)) 314 goto end; 315 } 316 success = 1; 317 318 end: 319 X509_free(cert); 320 X509_free(issuer); 321 SCT_LIST_free(scts); 322 SCT_free(sct); 323 CT_POLICY_EVAL_CTX_free(ct_policy_ctx); 324 OPENSSL_free(tls_sct_list); 325 return success; 326 } 327 328 # define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up) 329 # define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down) 330 331 static int test_no_scts_in_certificate(void) 332 { 333 SETUP_CT_TEST_FIXTURE(); 334 if (fixture == NULL) 335 return 0; 336 fixture->certs_dir = certs_dir; 337 fixture->certificate_file = "leaf.pem"; 338 fixture->issuer_file = "subinterCA.pem"; 339 fixture->expected_sct_count = 0; 340 EXECUTE_CT_TEST(); 341 return result; 342 } 343 344 static int test_one_sct_in_certificate(void) 345 { 346 SETUP_CT_TEST_FIXTURE(); 347 if (fixture == NULL) 348 return 0; 349 fixture->certs_dir = certs_dir; 350 fixture->certificate_file = "embeddedSCTs1.pem"; 351 fixture->issuer_file = "embeddedSCTs1_issuer.pem"; 352 fixture->expected_sct_count = 1; 353 fixture->sct_dir = certs_dir; 354 fixture->sct_text_file = "embeddedSCTs1.sct"; 355 EXECUTE_CT_TEST(); 356 return result; 357 } 358 359 static int test_multiple_scts_in_certificate(void) 360 { 361 SETUP_CT_TEST_FIXTURE(); 362 if (fixture == NULL) 363 return 0; 364 fixture->certs_dir = certs_dir; 365 fixture->certificate_file = "embeddedSCTs3.pem"; 366 fixture->issuer_file = "embeddedSCTs3_issuer.pem"; 367 fixture->expected_sct_count = 3; 368 fixture->sct_dir = certs_dir; 369 fixture->sct_text_file = "embeddedSCTs3.sct"; 370 EXECUTE_CT_TEST(); 371 return result; 372 } 373 374 static int test_verify_one_sct(void) 375 { 376 SETUP_CT_TEST_FIXTURE(); 377 if (fixture == NULL) 378 return 0; 379 fixture->certs_dir = certs_dir; 380 fixture->certificate_file = "embeddedSCTs1.pem"; 381 fixture->issuer_file = "embeddedSCTs1_issuer.pem"; 382 fixture->expected_sct_count = fixture->expected_valid_sct_count = 1; 383 fixture->test_validity = 1; 384 EXECUTE_CT_TEST(); 385 return result; 386 } 387 388 static int test_verify_multiple_scts(void) 389 { 390 SETUP_CT_TEST_FIXTURE(); 391 if (fixture == NULL) 392 return 0; 393 fixture->certs_dir = certs_dir; 394 fixture->certificate_file = "embeddedSCTs3.pem"; 395 fixture->issuer_file = "embeddedSCTs3_issuer.pem"; 396 fixture->expected_sct_count = fixture->expected_valid_sct_count = 3; 397 fixture->test_validity = 1; 398 EXECUTE_CT_TEST(); 399 return result; 400 } 401 402 static int test_verify_fails_for_future_sct(void) 403 { 404 SETUP_CT_TEST_FIXTURE(); 405 if (fixture == NULL) 406 return 0; 407 fixture->epoch_time_in_ms = 1365094800000ULL; /* Apr 4 17:00:00 2013 GMT */ 408 fixture->certs_dir = certs_dir; 409 fixture->certificate_file = "embeddedSCTs1.pem"; 410 fixture->issuer_file = "embeddedSCTs1_issuer.pem"; 411 fixture->expected_sct_count = 1; 412 fixture->expected_valid_sct_count = 0; 413 fixture->test_validity = 1; 414 EXECUTE_CT_TEST(); 415 return result; 416 } 417 418 static int test_decode_tls_sct(void) 419 { 420 const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */ 421 "\x00\x76" 422 "\x00" /* version */ 423 /* log ID */ 424 "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79" 425 "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64" 426 "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */ 427 "\x00\x00" /* extensions length */ 428 "" /* extensions */ 429 "\x04\x03" /* hash and signature algorithms */ 430 "\x00\x47" /* signature length */ 431 /* signature */ 432 "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6" 433 "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2" 434 "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB" 435 "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89" 436 "\xED\xBF\x08"; 437 438 SETUP_CT_TEST_FIXTURE(); 439 if (fixture == NULL) 440 return 0; 441 fixture->tls_sct_list = tls_sct_list; 442 fixture->tls_sct_list_len = 0x7a; 443 fixture->sct_dir = ct_dir; 444 fixture->sct_text_file = "tls1.sct"; 445 EXECUTE_CT_TEST(); 446 return result; 447 } 448 449 static int test_encode_tls_sct(void) 450 { 451 const char log_id[] = "3xwuwRUAlFJHqWFoMl3cXHlZ6PfG04j8AC4LvT9012Q="; 452 const uint64_t timestamp = 1; 453 const char extensions[] = ""; 454 const char signature[] = "BAMARzBAMiBIL2dRrzXbplQ2vh/WZA89v5pBQpSVkkUwKI+j5" 455 "eI+BgIhAOTtwNs6xXKx4vXoq2poBlOYfc9BAn3+/6EFUZ2J7b8I"; 456 SCT *sct = NULL; 457 458 SETUP_CT_TEST_FIXTURE(); 459 if (fixture == NULL) 460 return 0; 461 462 fixture->sct_list = sk_SCT_new_null(); 463 if (!TEST_ptr(sct = SCT_new_from_base64(SCT_VERSION_V1, log_id, 464 CT_LOG_ENTRY_TYPE_X509, timestamp, 465 extensions, signature))) 466 467 return 0; 468 469 sk_SCT_push(fixture->sct_list, sct); 470 fixture->sct_dir = ct_dir; 471 fixture->sct_text_file = "tls1.sct"; 472 EXECUTE_CT_TEST(); 473 return result; 474 } 475 476 /* 477 * Tests that the CT_POLICY_EVAL_CTX default time is approximately now. 478 * Allow +-10 minutes, as it may compensate for clock skew. 479 */ 480 static int test_default_ct_policy_eval_ctx_time_is_now(void) 481 { 482 int success = 0; 483 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new(); 484 const time_t default_time = 485 (time_t)(CT_POLICY_EVAL_CTX_get_time(ct_policy_ctx) / 1000); 486 const time_t time_tolerance = 600; /* 10 minutes */ 487 488 if (!TEST_time_t_le(abs((int)difftime(time(NULL), default_time)), 489 time_tolerance)) 490 goto end; 491 492 success = 1; 493 end: 494 CT_POLICY_EVAL_CTX_free(ct_policy_ctx); 495 return success; 496 } 497 498 static int test_ctlog_from_base64(void) 499 { 500 CTLOG *ctlogp = NULL; 501 const char notb64[] = "\01\02\03\04"; 502 const char pad[] = "===="; 503 const char name[] = "name"; 504 505 /* We expect these to both fail! */ 506 if (!TEST_true(!CTLOG_new_from_base64(&ctlogp, notb64, name)) 507 || !TEST_true(!CTLOG_new_from_base64(&ctlogp, pad, name))) 508 return 0; 509 return 1; 510 } 511 #endif 512 513 int setup_tests(void) 514 { 515 #ifndef OPENSSL_NO_CT 516 if ((ct_dir = getenv("CT_DIR")) == NULL) 517 ct_dir = "ct"; 518 if ((certs_dir = getenv("CERTS_DIR")) == NULL) 519 certs_dir = "certs"; 520 521 ADD_TEST(test_no_scts_in_certificate); 522 ADD_TEST(test_one_sct_in_certificate); 523 ADD_TEST(test_multiple_scts_in_certificate); 524 ADD_TEST(test_verify_one_sct); 525 ADD_TEST(test_verify_multiple_scts); 526 ADD_TEST(test_verify_fails_for_future_sct); 527 ADD_TEST(test_decode_tls_sct); 528 ADD_TEST(test_encode_tls_sct); 529 ADD_TEST(test_default_ct_policy_eval_ctx_time_is_now); 530 ADD_TEST(test_ctlog_from_base64); 531 #else 532 printf("No CT support\n"); 533 #endif 534 return 1; 535 } 536