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>
22 #include "test_main_custom.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);
99 static char *mk_file_path(const char *dir, const char *file)
101 char *full_file = NULL;
102 size_t full_file_l = 0;
103 const char *sep = "";
104 #ifndef OPENSSL_SYS_VMS
108 full_file_l = strlen(dir) + strlen(sep) + strlen(file) + 1;
109 full_file = OPENSSL_zalloc(full_file_l);
110 if (full_file != NULL) {
111 OPENSSL_strlcpy(full_file, dir, full_file_l);
112 OPENSSL_strlcat(full_file, sep, full_file_l);
113 OPENSSL_strlcat(full_file, file, full_file_l);
119 static X509 *load_pem_cert(const char *dir, const char *file)
122 char *file_path = mk_file_path(dir, file);
124 if (file_path != NULL) {
125 BIO *cert_io = BIO_new_file(file_path, "r");
126 OPENSSL_free(file_path);
129 cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
136 static int read_text_file(const char *dir, const char *file,
137 char *buffer, int buffer_length)
140 char *file_path = mk_file_path(dir, file);
142 if (file_path != NULL) {
143 BIO *file_io = BIO_new_file(file_path, "r");
144 OPENSSL_free(file_path);
146 if (file_io != NULL) {
147 result = BIO_read(file_io, buffer, buffer_length);
155 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
156 const char *expected_output)
158 BIO *text_buffer = NULL;
159 char *actual_output = NULL;
162 text_buffer = BIO_new(BIO_s_mem());
163 if (text_buffer == NULL) {
164 fprintf(stderr, "Unable to allocate buffer\n");
168 SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
170 /* Append null terminator because we're about to use the buffer contents
172 if (BIO_write(text_buffer, "\0", 1) != 1) {
173 fprintf(stderr, "Failed to append null terminator to SCT text\n");
177 BIO_get_mem_data(text_buffer, &actual_output);
178 result = strcmp(actual_output, expected_output);
182 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
183 expected_output, actual_output);
187 BIO_free(text_buffer);
191 static int compare_extension_printout(X509_EXTENSION *extension,
192 const char *expected_output)
194 BIO *text_buffer = NULL;
195 char *actual_output = NULL;
198 text_buffer = BIO_new(BIO_s_mem());
199 if (text_buffer == NULL) {
200 fprintf(stderr, "Unable to allocate buffer\n");
204 if (!X509V3_EXT_print(text_buffer, extension, X509V3_EXT_DEFAULT, 0)) {
205 fprintf(stderr, "Failed to print extension\n");
209 /* Append null terminator because we're about to use the buffer contents
211 if (BIO_write(text_buffer, "\0", 1) != 1) {
213 "Failed to append null terminator to extension text\n");
217 BIO_get_mem_data(text_buffer, &actual_output);
218 result = strcmp(actual_output, expected_output);
222 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
223 expected_output, actual_output);
227 BIO_free(text_buffer);
231 static int assert_validity(CT_TEST_FIXTURE fixture,
233 CT_POLICY_EVAL_CTX *policy_ctx) {
234 int invalid_sct_count = 0;
235 int valid_sct_count = 0;
238 if (SCT_LIST_validate(scts, policy_ctx) < 0) {
239 fprintf(stderr, "Error verifying SCTs\n");
243 for (i = 0; i < sk_SCT_num(scts); ++i) {
244 SCT *sct_i = sk_SCT_value(scts, i);
245 switch (SCT_get_validation_status(sct_i)) {
246 case SCT_VALIDATION_STATUS_VALID:
249 case SCT_VALIDATION_STATUS_INVALID:
252 case SCT_VALIDATION_STATUS_NOT_SET:
253 case SCT_VALIDATION_STATUS_UNKNOWN_LOG:
254 case SCT_VALIDATION_STATUS_UNVERIFIED:
255 case SCT_VALIDATION_STATUS_UNKNOWN_VERSION:
256 /* Ignore other validation statuses. */
261 if (valid_sct_count != fixture.expected_valid_sct_count) {
262 int unverified_sct_count = sk_SCT_num(scts) -
263 invalid_sct_count - valid_sct_count;
266 "%d SCTs failed verification\n"
267 "%d SCTs passed verification (%d expected)\n"
268 "%d SCTs were unverified\n",
271 fixture.expected_valid_sct_count,
272 unverified_sct_count);
279 static int execute_cert_test(CT_TEST_FIXTURE fixture)
282 X509 *cert = NULL, *issuer = NULL;
283 STACK_OF(SCT) *scts = NULL;
285 char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
286 int sct_text_len = 0;
287 unsigned char *tls_sct_list = NULL;
288 size_t tls_sct_list_len = 0;
289 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
291 if (fixture.sct_text_file != NULL) {
292 sct_text_len = read_text_file(fixture.sct_dir, fixture.sct_text_file,
294 CT_TEST_MAX_FILE_SIZE - 1);
296 if (sct_text_len < 0) {
297 fprintf(stderr, "Test data file not found: %s\n",
298 fixture.sct_text_file);
302 expected_sct_text[sct_text_len] = '\0';
305 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
306 ct_policy_ctx, fixture.ctlog_store);
308 CT_POLICY_EVAL_CTX_set_time(ct_policy_ctx, fixture.epoch_time_in_ms);
310 if (fixture.certificate_file != NULL) {
311 int sct_extension_index;
312 X509_EXTENSION *sct_extension = NULL;
313 cert = load_pem_cert(fixture.certs_dir, fixture.certificate_file);
316 fprintf(stderr, "Unable to load certificate: %s\n",
317 fixture.certificate_file);
321 CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
323 if (fixture.issuer_file != NULL) {
324 issuer = load_pem_cert(fixture.certs_dir, fixture.issuer_file);
326 if (issuer == NULL) {
327 fprintf(stderr, "Unable to load issuer certificate: %s\n",
328 fixture.issuer_file);
332 CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
335 sct_extension_index =
336 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
337 sct_extension = X509_get_ext(cert, sct_extension_index);
338 if (fixture.expected_sct_count > 0) {
339 if (sct_extension == NULL) {
340 fprintf(stderr, "SCT extension not found in: %s\n",
341 fixture.certificate_file);
345 if (fixture.sct_text_file
346 && compare_extension_printout(sct_extension,
347 expected_sct_text)) {
351 if (fixture.test_validity) {
354 scts = X509V3_EXT_d2i(sct_extension);
355 for (i = 0; i < sk_SCT_num(scts); ++i) {
356 SCT *sct_i = sk_SCT_value(scts, i);
358 if (!SCT_set_source(sct_i, SCT_SOURCE_X509V3_EXTENSION)) {
360 "Error setting SCT source to X509v3 extension\n");
365 if (!assert_validity(fixture, scts, ct_policy_ctx))
368 } else if (sct_extension != NULL) {
370 "Expected no SCTs, but found SCT extension in: %s\n",
371 fixture.certificate_file);
376 if (fixture.tls_sct_list != NULL) {
377 const unsigned char *p = fixture.tls_sct_list;
378 if (o2i_SCT_LIST(&scts, &p, fixture.tls_sct_list_len) == NULL) {
379 fprintf(stderr, "Failed to decode SCTs from TLS format\n");
383 if (fixture.test_validity && cert != NULL) {
384 if (!assert_validity(fixture, scts, ct_policy_ctx))
388 if (fixture.sct_text_file
389 && compare_sct_list_printout(scts, expected_sct_text)) {
393 tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
394 if (tls_sct_list_len != fixture.tls_sct_list_len ||
395 memcmp(fixture.tls_sct_list, tls_sct_list, tls_sct_list_len) != 0) {
397 "Failed to encode SCTs into TLS format correctly\n");
408 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
409 OPENSSL_free(tls_sct_list);
413 #define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
414 #define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
416 static int test_no_scts_in_certificate()
418 SETUP_CT_TEST_FIXTURE();
419 fixture.certs_dir = certs_dir;
420 fixture.certificate_file = "leaf.pem";
421 fixture.issuer_file = "subinterCA.pem";
422 fixture.expected_sct_count = 0;
426 static int test_one_sct_in_certificate()
428 SETUP_CT_TEST_FIXTURE();
429 fixture.certs_dir = certs_dir;
430 fixture.certificate_file = "embeddedSCTs1.pem";
431 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
432 fixture.expected_sct_count = 1;
433 fixture.sct_dir = certs_dir;
434 fixture.sct_text_file = "embeddedSCTs1.sct";
438 static int test_multiple_scts_in_certificate()
440 SETUP_CT_TEST_FIXTURE();
441 fixture.certs_dir = certs_dir;
442 fixture.certificate_file = "embeddedSCTs3.pem";
443 fixture.issuer_file = "embeddedSCTs3_issuer.pem";
444 fixture.expected_sct_count = 3;
445 fixture.sct_dir = certs_dir;
446 fixture.sct_text_file = "embeddedSCTs3.sct";
450 static int test_verify_one_sct()
452 SETUP_CT_TEST_FIXTURE();
453 fixture.certs_dir = certs_dir;
454 fixture.certificate_file = "embeddedSCTs1.pem";
455 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
456 fixture.expected_sct_count = fixture.expected_valid_sct_count = 1;
457 fixture.test_validity = 1;
461 static int test_verify_multiple_scts()
463 SETUP_CT_TEST_FIXTURE();
464 fixture.certs_dir = certs_dir;
465 fixture.certificate_file = "embeddedSCTs3.pem";
466 fixture.issuer_file = "embeddedSCTs3_issuer.pem";
467 fixture.expected_sct_count = fixture.expected_valid_sct_count = 3;
468 fixture.test_validity = 1;
472 static int test_verify_fails_for_future_sct()
474 SETUP_CT_TEST_FIXTURE();
475 fixture.epoch_time_in_ms = 1365094800000; /* Apr 4 17:00:00 2013 GMT */
476 fixture.certs_dir = certs_dir;
477 fixture.certificate_file = "embeddedSCTs1.pem";
478 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
479 fixture.expected_sct_count = 1;
480 fixture.expected_valid_sct_count = 0;
481 fixture.test_validity = 1;
485 static int test_decode_tls_sct()
487 const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
491 "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
492 "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
493 "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
494 "\x00\x00" /* extensions length */
496 "\x04\x03" /* hash and signature algorithms */
497 "\x00\x47" /* signature length */
499 "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
500 "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
501 "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
502 "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
505 SETUP_CT_TEST_FIXTURE();
506 fixture.tls_sct_list = tls_sct_list;
507 fixture.tls_sct_list_len = 0x7a;
508 fixture.sct_dir = ct_dir;
509 fixture.sct_text_file = "tls1.sct";
513 static int test_encode_tls_sct()
515 const unsigned char log_id[] = "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9"
516 "\x61\x68\x32\x5D\xDC\x5C\x79\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E"
517 "\x0B\xBD\x3F\x74\xD7\x64";
519 const unsigned char signature[] = "\x45\x02\x20\x48\x2F\x67\x51\xAF\x35"
520 "\xDB\xA6\x54\x36\xBE\x1F\xD6\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95"
521 "\x92\x45\x30\x28\x8F\xA3\xE5\xE2\x3E\x06\x02\x21\x00\xE4\xED\xC0"
522 "\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB\x6A\x68\x06\x53\x98\x7D\xCF"
523 "\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89\xED\xBF\x08";
525 SETUP_CT_TEST_FIXTURE();
527 STACK_OF(SCT) *sct_list = sk_SCT_new_null();
528 SCT *sct = SCT_new();
529 if (!SCT_set_version(sct, SCT_VERSION_V1)) {
530 fprintf(stderr, "Failed to set SCT version\n");
533 if (!SCT_set1_log_id(sct, log_id, 32)) {
534 fprintf(stderr, "Failed to set SCT log ID\n");
537 SCT_set_timestamp(sct, 1);
538 if (!SCT_set_signature_nid(sct, NID_ecdsa_with_SHA256)) {
539 fprintf(stderr, "Failed to set SCT signature NID\n");
542 if (!SCT_set1_signature(sct, signature, 71)) {
543 fprintf(stderr, "Failed to set SCT signature\n");
546 sk_SCT_push(sct_list, sct);
548 fixture.sct_list = sct_list;
549 fixture.sct_dir = ct_dir;
550 fixture.sct_text_file = "tls1.sct";
555 * Tests that the CT_POLICY_EVAL_CTX default time is approximately now.
556 * Allow +-10 minutes, as it may compensate for clock skew.
558 static int test_default_ct_policy_eval_ctx_time_is_now()
561 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
562 const time_t default_time = CT_POLICY_EVAL_CTX_get_time(ct_policy_ctx) /
564 const time_t time_tolerance = 600; /* 10 minutes */
566 if (fabs(difftime(time(NULL), default_time)) > time_tolerance) {
568 "Default CT_POLICY_EVAL_CTX time is not approximately now.\n");
574 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
578 int test_main(int argc, char *argv[])
583 tmp_env = getenv("CT_DIR");
584 ct_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "ct");
585 tmp_env = getenv("CERTS_DIR");
586 certs_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "certs");
588 ADD_TEST(test_no_scts_in_certificate);
589 ADD_TEST(test_one_sct_in_certificate);
590 ADD_TEST(test_multiple_scts_in_certificate);
591 ADD_TEST(test_verify_one_sct);
592 ADD_TEST(test_verify_multiple_scts);
593 ADD_TEST(test_verify_fails_for_future_sct);
594 ADD_TEST(test_decode_tls_sct);
595 ADD_TEST(test_encode_tls_sct);
596 ADD_TEST(test_default_ct_policy_eval_ctx_time_is_now);
598 result = run_tests(argv[0]);
600 OPENSSL_free(ct_dir);
601 OPENSSL_free(certs_dir);
606 int test_main(int argc, char *argv[])
608 printf("No CT support\n");