2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
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
16 #include <openssl/ct.h>
17 #include <openssl/err.h>
18 #include <openssl/pem.h>
19 #include <openssl/x509.h>
20 #include <openssl/x509v3.h>
25 /* Used when declaring buffers to read text files into */
26 #define CT_TEST_MAX_FILE_SIZE 8096
28 static char *certs_dir = NULL;
29 static char *ct_dir = NULL;
31 typedef struct ct_test_fixture {
32 const char *test_case_name;
33 /* The current time in milliseconds */
34 uint64_t epoch_time_in_ms;
35 /* The CT log store to use during tests */
36 CTLOG_STORE* ctlog_store;
37 /* Set the following to test handling of SCTs in X509 certificates */
38 const char *certs_dir;
39 char *certificate_file;
41 /* Expected number of SCTs */
42 int expected_sct_count;
43 /* Expected number of valid SCTS */
44 int expected_valid_sct_count;
45 /* Set the following to test handling of SCTs in TLS format */
46 const unsigned char *tls_sct_list;
47 size_t tls_sct_list_len;
48 STACK_OF(SCT) *sct_list;
50 * A file to load the expected SCT text from.
51 * This text will be compared to the actual text output during the test.
52 * A maximum of |CT_TEST_MAX_FILE_SIZE| bytes will be read of this file.
55 const char *sct_text_file;
56 /* Whether to test the validity of the SCT(s) */
60 static CT_TEST_FIXTURE set_up(const char *const test_case_name)
62 CT_TEST_FIXTURE fixture;
64 CTLOG_STORE *ctlog_store;
66 memset(&fixture, 0, sizeof(fixture));
68 ctlog_store = CTLOG_STORE_new();
70 if (ctlog_store == NULL) {
72 fprintf(stderr, "Failed to create a new CT log store\n");
76 if (CTLOG_STORE_load_default_file(ctlog_store) != 1) {
78 fprintf(stderr, "Failed to load CT log list\n");
82 fixture.test_case_name = test_case_name;
83 fixture.epoch_time_in_ms = 1473269626000; /* Sep 7 17:33:46 2016 GMT */
84 fixture.ctlog_store = ctlog_store;
93 static void tear_down(CT_TEST_FIXTURE fixture)
95 CTLOG_STORE_free(fixture.ctlog_store);
96 SCT_LIST_free(fixture.sct_list);
97 ERR_print_errors_fp(stderr);
100 static char *mk_file_path(const char *dir, const char *file)
102 char *full_file = NULL;
103 size_t full_file_l = 0;
104 const char *sep = "";
105 #ifndef OPENSSL_SYS_VMS
109 full_file_l = strlen(dir) + strlen(sep) + strlen(file) + 1;
110 full_file = OPENSSL_zalloc(full_file_l);
111 if (full_file != NULL) {
112 OPENSSL_strlcpy(full_file, dir, full_file_l);
113 OPENSSL_strlcat(full_file, sep, full_file_l);
114 OPENSSL_strlcat(full_file, file, full_file_l);
120 static X509 *load_pem_cert(const char *dir, const char *file)
123 char *file_path = mk_file_path(dir, file);
125 if (file_path != NULL) {
126 BIO *cert_io = BIO_new_file(file_path, "r");
127 OPENSSL_free(file_path);
130 cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
137 static int read_text_file(const char *dir, const char *file,
138 char *buffer, int buffer_length)
141 char *file_path = mk_file_path(dir, file);
143 if (file_path != NULL) {
144 BIO *file_io = BIO_new_file(file_path, "r");
145 OPENSSL_free(file_path);
147 if (file_io != NULL) {
148 result = BIO_read(file_io, buffer, buffer_length);
156 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
157 const char *expected_output)
159 BIO *text_buffer = NULL;
160 char *actual_output = NULL;
163 text_buffer = BIO_new(BIO_s_mem());
164 if (text_buffer == NULL) {
165 fprintf(stderr, "Unable to allocate buffer\n");
169 SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
171 /* Append null terminator because we're about to use the buffer contents
173 if (BIO_write(text_buffer, "\0", 1) != 1) {
174 fprintf(stderr, "Failed to append null terminator to SCT text\n");
178 BIO_get_mem_data(text_buffer, &actual_output);
179 result = strcmp(actual_output, expected_output);
183 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
184 expected_output, actual_output);
188 BIO_free(text_buffer);
192 static int compare_extension_printout(X509_EXTENSION *extension,
193 const char *expected_output)
195 BIO *text_buffer = NULL;
196 char *actual_output = NULL;
199 text_buffer = BIO_new(BIO_s_mem());
200 if (text_buffer == NULL) {
201 fprintf(stderr, "Unable to allocate buffer\n");
205 if (!X509V3_EXT_print(text_buffer, extension, X509V3_EXT_DEFAULT, 0)) {
206 fprintf(stderr, "Failed to print extension\n");
210 /* Append null terminator because we're about to use the buffer contents
212 if (BIO_write(text_buffer, "\0", 1) != 1) {
214 "Failed to append null terminator to extension text\n");
218 BIO_get_mem_data(text_buffer, &actual_output);
219 result = strcmp(actual_output, expected_output);
223 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
224 expected_output, actual_output);
228 BIO_free(text_buffer);
232 static int assert_validity(CT_TEST_FIXTURE fixture,
234 CT_POLICY_EVAL_CTX *policy_ctx) {
235 int invalid_sct_count = 0;
236 int valid_sct_count = 0;
239 if (SCT_LIST_validate(scts, policy_ctx) < 0) {
240 fprintf(stderr, "Error verifying SCTs\n");
244 for (i = 0; i < sk_SCT_num(scts); ++i) {
245 SCT *sct_i = sk_SCT_value(scts, i);
246 switch (SCT_get_validation_status(sct_i)) {
247 case SCT_VALIDATION_STATUS_VALID:
250 case SCT_VALIDATION_STATUS_INVALID:
254 /* Ignore other validation statuses. */
259 if (valid_sct_count != fixture.expected_valid_sct_count) {
260 int unverified_sct_count = sk_SCT_num(scts) -
261 invalid_sct_count - valid_sct_count;
264 "%d SCTs failed verification\n"
265 "%d SCTs passed verification (%d expected)\n"
266 "%d SCTs were unverified\n",
269 fixture.expected_valid_sct_count,
270 unverified_sct_count);
277 static int execute_cert_test(CT_TEST_FIXTURE fixture)
280 X509 *cert = NULL, *issuer = NULL;
281 STACK_OF(SCT) *scts = NULL;
283 char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
284 int sct_text_len = 0;
285 unsigned char *tls_sct_list = NULL;
286 size_t tls_sct_list_len = 0;
287 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
289 if (fixture.sct_text_file != NULL) {
290 sct_text_len = read_text_file(fixture.sct_dir, fixture.sct_text_file,
292 CT_TEST_MAX_FILE_SIZE - 1);
294 if (sct_text_len < 0) {
295 fprintf(stderr, "Test data file not found: %s\n",
296 fixture.sct_text_file);
300 expected_sct_text[sct_text_len] = '\0';
303 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
304 ct_policy_ctx, fixture.ctlog_store);
306 CT_POLICY_EVAL_CTX_set_time(ct_policy_ctx, fixture.epoch_time_in_ms);
308 if (fixture.certificate_file != NULL) {
309 int sct_extension_index;
310 X509_EXTENSION *sct_extension = NULL;
311 cert = load_pem_cert(fixture.certs_dir, fixture.certificate_file);
314 fprintf(stderr, "Unable to load certificate: %s\n",
315 fixture.certificate_file);
319 CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
321 if (fixture.issuer_file != NULL) {
322 issuer = load_pem_cert(fixture.certs_dir, fixture.issuer_file);
324 if (issuer == NULL) {
325 fprintf(stderr, "Unable to load issuer certificate: %s\n",
326 fixture.issuer_file);
330 CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
333 sct_extension_index =
334 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
335 sct_extension = X509_get_ext(cert, sct_extension_index);
336 if (fixture.expected_sct_count > 0) {
337 if (sct_extension == NULL) {
338 fprintf(stderr, "SCT extension not found in: %s\n",
339 fixture.certificate_file);
343 if (fixture.sct_text_file
344 && compare_extension_printout(sct_extension,
345 expected_sct_text)) {
349 if (fixture.test_validity) {
352 scts = X509V3_EXT_d2i(sct_extension);
353 for (i = 0; i < sk_SCT_num(scts); ++i) {
354 SCT *sct_i = sk_SCT_value(scts, i);
356 if (!SCT_set_source(sct_i, SCT_SOURCE_X509V3_EXTENSION)) {
358 "Error setting SCT source to X509v3 extension\n");
363 if (!assert_validity(fixture, scts, ct_policy_ctx))
366 } else if (sct_extension != NULL) {
368 "Expected no SCTs, but found SCT extension in: %s\n",
369 fixture.certificate_file);
374 if (fixture.tls_sct_list != NULL) {
375 const unsigned char *p = fixture.tls_sct_list;
376 if (o2i_SCT_LIST(&scts, &p, fixture.tls_sct_list_len) == NULL) {
377 fprintf(stderr, "Failed to decode SCTs from TLS format\n");
381 if (fixture.test_validity && cert != NULL) {
382 if (!assert_validity(fixture, scts, ct_policy_ctx))
386 if (fixture.sct_text_file
387 && compare_sct_list_printout(scts, expected_sct_text)) {
391 tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
392 if (tls_sct_list_len != fixture.tls_sct_list_len ||
393 memcmp(fixture.tls_sct_list, tls_sct_list, tls_sct_list_len) != 0) {
395 "Failed to encode SCTs into TLS format correctly\n");
406 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
407 OPENSSL_free(tls_sct_list);
411 #define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
412 #define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
414 static int test_no_scts_in_certificate()
416 SETUP_CT_TEST_FIXTURE();
417 fixture.certs_dir = certs_dir;
418 fixture.certificate_file = "leaf.pem";
419 fixture.issuer_file = "subinterCA.pem";
420 fixture.expected_sct_count = 0;
424 static int test_one_sct_in_certificate()
426 SETUP_CT_TEST_FIXTURE();
427 fixture.certs_dir = certs_dir;
428 fixture.certificate_file = "embeddedSCTs1.pem";
429 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
430 fixture.expected_sct_count = 1;
431 fixture.sct_dir = certs_dir;
432 fixture.sct_text_file = "embeddedSCTs1.sct";
436 static int test_multiple_scts_in_certificate()
438 SETUP_CT_TEST_FIXTURE();
439 fixture.certs_dir = certs_dir;
440 fixture.certificate_file = "embeddedSCTs3.pem";
441 fixture.issuer_file = "embeddedSCTs3_issuer.pem";
442 fixture.expected_sct_count = 3;
443 fixture.sct_dir = certs_dir;
444 fixture.sct_text_file = "embeddedSCTs3.sct";
448 static int test_verify_one_sct()
450 SETUP_CT_TEST_FIXTURE();
451 fixture.certs_dir = certs_dir;
452 fixture.certificate_file = "embeddedSCTs1.pem";
453 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
454 fixture.expected_sct_count = fixture.expected_valid_sct_count = 1;
455 fixture.test_validity = 1;
459 static int test_verify_multiple_scts()
461 SETUP_CT_TEST_FIXTURE();
462 fixture.certs_dir = certs_dir;
463 fixture.certificate_file = "embeddedSCTs3.pem";
464 fixture.issuer_file = "embeddedSCTs3_issuer.pem";
465 fixture.expected_sct_count = fixture.expected_valid_sct_count = 3;
466 fixture.test_validity = 1;
470 static int test_verify_fails_for_future_sct()
472 SETUP_CT_TEST_FIXTURE();
473 fixture.epoch_time_in_ms = 1365094800000; /* Apr 4 17:00:00 2013 GMT */
474 fixture.certs_dir = certs_dir;
475 fixture.certificate_file = "embeddedSCTs1.pem";
476 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
477 fixture.expected_sct_count = 1;
478 fixture.expected_valid_sct_count = 0;
479 fixture.test_validity = 1;
483 static int test_decode_tls_sct()
485 const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
489 "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
490 "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
491 "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
492 "\x00\x00" /* extensions length */
494 "\x04\x03" /* hash and signature algorithms */
495 "\x00\x47" /* signature length */
497 "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
498 "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
499 "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
500 "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
503 SETUP_CT_TEST_FIXTURE();
504 fixture.tls_sct_list = tls_sct_list;
505 fixture.tls_sct_list_len = 0x7a;
506 fixture.sct_dir = ct_dir;
507 fixture.sct_text_file = "tls1.sct";
511 static int test_encode_tls_sct()
513 const char log_id[] = "3xwuwRUAlFJHqWFoMl3cXHlZ6PfG04j8AC4LvT9012Q=";
514 const uint64_t timestamp = 1;
515 const char extensions[] = "";
516 const char signature[] = "BAMARzBAMiBIL2dRrzXbplQ2vh/WZA89v5pBQpSVkkUwKI+j5"
517 "eI+BgIhAOTtwNs6xXKx4vXoq2poBlOYfc9BAn3+/6EFUZ2J7b8I";
519 SETUP_CT_TEST_FIXTURE();
521 STACK_OF(SCT) *sct_list = sk_SCT_new_null();
522 SCT *sct = SCT_new_from_base64(SCT_VERSION_V1, log_id,
523 CT_LOG_ENTRY_TYPE_X509, timestamp,
524 extensions, signature);
527 fprintf(stderr, "Failed to create SCT from base64-encoded test data\n");
531 sk_SCT_push(sct_list, sct);
532 fixture.sct_list = sct_list;
533 fixture.sct_dir = ct_dir;
534 fixture.sct_text_file = "tls1.sct";
539 * Tests that the CT_POLICY_EVAL_CTX default time is approximately now.
540 * Allow +-10 minutes, as it may compensate for clock skew.
542 static int test_default_ct_policy_eval_ctx_time_is_now()
545 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
546 const time_t default_time = CT_POLICY_EVAL_CTX_get_time(ct_policy_ctx) /
548 const time_t time_tolerance = 600; /* 10 minutes */
550 if (fabs(difftime(time(NULL), default_time)) > time_tolerance) {
552 "Default CT_POLICY_EVAL_CTX time is not approximately now.\n");
558 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
562 int main(int argc, char *argv[])
565 char *tmp_env = NULL;
567 tmp_env = getenv("OPENSSL_DEBUG_MEMORY");
568 if (tmp_env != NULL && strcmp(tmp_env, "on") == 0)
569 CRYPTO_set_mem_debug(1);
570 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
572 tmp_env = getenv("CT_DIR");
573 ct_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "ct");
574 tmp_env = getenv("CERTS_DIR");
575 certs_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "certs");
577 ADD_TEST(test_no_scts_in_certificate);
578 ADD_TEST(test_one_sct_in_certificate);
579 ADD_TEST(test_multiple_scts_in_certificate);
580 ADD_TEST(test_verify_one_sct);
581 ADD_TEST(test_verify_multiple_scts);
582 ADD_TEST(test_verify_fails_for_future_sct);
583 ADD_TEST(test_decode_tls_sct);
584 ADD_TEST(test_encode_tls_sct);
585 ADD_TEST(test_default_ct_policy_eval_ctx_time_is_now);
587 result = run_tests(argv[0]);
588 ERR_print_errors_fp(stderr);
590 OPENSSL_free(ct_dir);
591 OPENSSL_free(certs_dir);
593 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
594 if (CRYPTO_mem_leaks_fp(stderr) <= 0)
601 #else /* OPENSSL_NO_CT */
603 int main(int argc, char* argv[])
608 #endif /* OPENSSL_NO_CT */