2 * Copyright 2016-2017 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 <openssl/crypto.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 = NULL;
64 if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
66 fixture->test_case_name = test_case_name;
67 fixture->epoch_time_in_ms = 1473269626000; /* Sep 7 17:33:46 2016 GMT */
68 if (!TEST_ptr(fixture->ctlog_store = CTLOG_STORE_new())
70 CTLOG_STORE_load_default_file(fixture->ctlog_store), 1))
76 CTLOG_STORE_free(fixture->ctlog_store);
77 OPENSSL_free(fixture);
78 TEST_error("Failed to setup");
82 static void tear_down(CT_TEST_FIXTURE *fixture)
84 if (fixture != NULL) {
85 CTLOG_STORE_free(fixture->ctlog_store);
86 SCT_LIST_free(fixture->sct_list);
88 OPENSSL_free(fixture);
91 static char *mk_file_path(const char *dir, const char *file)
93 # ifndef OPENSSL_SYS_VMS
94 const char *sep = "/";
98 size_t len = strlen(dir) + strlen(sep) + strlen(file) + 1;
99 char *full_file = OPENSSL_zalloc(len);
101 if (full_file != NULL) {
102 OPENSSL_strlcpy(full_file, dir, len);
103 OPENSSL_strlcat(full_file, sep, len);
104 OPENSSL_strlcat(full_file, file, len);
110 static X509 *load_pem_cert(const char *dir, const char *file)
113 char *file_path = mk_file_path(dir, file);
115 if (file_path != NULL) {
116 BIO *cert_io = BIO_new_file(file_path, "r");
119 cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
123 OPENSSL_free(file_path);
127 static int read_text_file(const char *dir, const char *file,
128 char *buffer, int buffer_length)
131 char *file_path = mk_file_path(dir, file);
133 if (file_path != NULL) {
134 BIO *file_io = BIO_new_file(file_path, "r");
137 len = BIO_read(file_io, buffer, buffer_length);
141 OPENSSL_free(file_path);
145 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
146 const char *expected_output)
148 BIO *text_buffer = NULL;
149 char *actual_output = NULL;
152 if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem())))
155 SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
157 /* Append \0 because we're about to use the buffer contents as a string. */
158 if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
161 BIO_get_mem_data(text_buffer, &actual_output);
162 if (!TEST_str_eq(actual_output, expected_output))
167 BIO_free(text_buffer);
171 static int compare_extension_printout(X509_EXTENSION *extension,
172 const char *expected_output)
174 BIO *text_buffer = NULL;
175 char *actual_output = NULL;
178 if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem()))
179 || !TEST_true(X509V3_EXT_print(text_buffer, extension,
180 X509V3_EXT_DEFAULT, 0)))
183 /* Append \0 because we're about to use the buffer contents as a string. */
184 if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
187 BIO_get_mem_data(text_buffer, &actual_output);
188 if (!TEST_str_eq(actual_output, expected_output))
194 BIO_free(text_buffer);
198 static int assert_validity(CT_TEST_FIXTURE *fixture, STACK_OF(SCT) *scts,
199 CT_POLICY_EVAL_CTX *policy_ctx)
201 int invalid_sct_count = 0;
202 int valid_sct_count = 0;
205 if (!TEST_int_ge(SCT_LIST_validate(scts, policy_ctx), 0))
208 for (i = 0; i < sk_SCT_num(scts); ++i) {
209 SCT *sct_i = sk_SCT_value(scts, i);
211 switch (SCT_get_validation_status(sct_i)) {
212 case SCT_VALIDATION_STATUS_VALID:
215 case SCT_VALIDATION_STATUS_INVALID:
218 case SCT_VALIDATION_STATUS_NOT_SET:
219 case SCT_VALIDATION_STATUS_UNKNOWN_LOG:
220 case SCT_VALIDATION_STATUS_UNVERIFIED:
221 case SCT_VALIDATION_STATUS_UNKNOWN_VERSION:
222 /* Ignore other validation statuses. */
227 if (!TEST_int_eq(valid_sct_count, fixture->expected_valid_sct_count)) {
228 int unverified_sct_count = sk_SCT_num(scts) -
229 invalid_sct_count - valid_sct_count;
231 TEST_info("%d SCTs failed, %d SCTs unverified",
232 invalid_sct_count, unverified_sct_count);
239 static int execute_cert_test(CT_TEST_FIXTURE *fixture)
242 X509 *cert = NULL, *issuer = NULL;
243 STACK_OF(SCT) *scts = NULL;
245 char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
246 int sct_text_len = 0;
247 unsigned char *tls_sct_list = NULL;
248 size_t tls_sct_list_len = 0;
249 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
251 if (fixture->sct_text_file != NULL) {
252 sct_text_len = read_text_file(fixture->sct_dir, fixture->sct_text_file,
254 CT_TEST_MAX_FILE_SIZE - 1);
256 if (!TEST_int_ge(sct_text_len, 0))
258 expected_sct_text[sct_text_len] = '\0';
261 CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
262 ct_policy_ctx, fixture->ctlog_store);
264 CT_POLICY_EVAL_CTX_set_time(ct_policy_ctx, fixture->epoch_time_in_ms);
266 if (fixture->certificate_file != NULL) {
267 int sct_extension_index;
269 X509_EXTENSION *sct_extension = NULL;
271 if (!TEST_ptr(cert = load_pem_cert(fixture->certs_dir,
272 fixture->certificate_file)))
275 CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
277 if (fixture->issuer_file != NULL) {
278 if (!TEST_ptr(issuer = load_pem_cert(fixture->certs_dir,
279 fixture->issuer_file)))
281 CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
284 sct_extension_index =
285 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
286 sct_extension = X509_get_ext(cert, sct_extension_index);
287 if (fixture->expected_sct_count > 0) {
288 if (!TEST_ptr(sct_extension))
291 if (fixture->sct_text_file
292 && !compare_extension_printout(sct_extension,
296 scts = X509V3_EXT_d2i(sct_extension);
297 for (i = 0; i < sk_SCT_num(scts); ++i) {
298 SCT *sct_i = sk_SCT_value(scts, i);
300 if (!TEST_int_eq(SCT_get_source(sct_i), SCT_SOURCE_X509V3_EXTENSION)) {
305 if (fixture->test_validity) {
306 if (!assert_validity(fixture, scts, ct_policy_ctx))
309 } else if (!TEST_ptr_null(sct_extension)) {
314 if (fixture->tls_sct_list != NULL) {
315 const unsigned char *p = fixture->tls_sct_list;
317 if (!TEST_ptr(o2i_SCT_LIST(&scts, &p, fixture->tls_sct_list_len)))
320 if (fixture->test_validity && cert != NULL) {
321 if (!assert_validity(fixture, scts, ct_policy_ctx))
325 if (fixture->sct_text_file
326 && !compare_sct_list_printout(scts, expected_sct_text)) {
330 tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
331 if (!TEST_mem_eq(fixture->tls_sct_list, fixture->tls_sct_list_len,
332 tls_sct_list, tls_sct_list_len))
342 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
343 OPENSSL_free(tls_sct_list);
347 # define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
348 # define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
350 static int test_no_scts_in_certificate(void)
352 SETUP_CT_TEST_FIXTURE();
355 fixture->certs_dir = certs_dir;
356 fixture->certificate_file = "leaf.pem";
357 fixture->issuer_file = "subinterCA.pem";
358 fixture->expected_sct_count = 0;
363 static int test_one_sct_in_certificate(void)
365 SETUP_CT_TEST_FIXTURE();
368 fixture->certs_dir = certs_dir;
369 fixture->certificate_file = "embeddedSCTs1.pem";
370 fixture->issuer_file = "embeddedSCTs1_issuer.pem";
371 fixture->expected_sct_count = 1;
372 fixture->sct_dir = certs_dir;
373 fixture->sct_text_file = "embeddedSCTs1.sct";
378 static int test_multiple_scts_in_certificate(void)
380 SETUP_CT_TEST_FIXTURE();
383 fixture->certs_dir = certs_dir;
384 fixture->certificate_file = "embeddedSCTs3.pem";
385 fixture->issuer_file = "embeddedSCTs3_issuer.pem";
386 fixture->expected_sct_count = 3;
387 fixture->sct_dir = certs_dir;
388 fixture->sct_text_file = "embeddedSCTs3.sct";
393 static int test_verify_one_sct(void)
395 SETUP_CT_TEST_FIXTURE();
398 fixture->certs_dir = certs_dir;
399 fixture->certificate_file = "embeddedSCTs1.pem";
400 fixture->issuer_file = "embeddedSCTs1_issuer.pem";
401 fixture->expected_sct_count = fixture->expected_valid_sct_count = 1;
402 fixture->test_validity = 1;
407 static int test_verify_multiple_scts(void)
409 SETUP_CT_TEST_FIXTURE();
412 fixture->certs_dir = certs_dir;
413 fixture->certificate_file = "embeddedSCTs3.pem";
414 fixture->issuer_file = "embeddedSCTs3_issuer.pem";
415 fixture->expected_sct_count = fixture->expected_valid_sct_count = 3;
416 fixture->test_validity = 1;
421 static int test_verify_fails_for_future_sct(void)
423 SETUP_CT_TEST_FIXTURE();
426 fixture->epoch_time_in_ms = 1365094800000; /* Apr 4 17:00:00 2013 GMT */
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->expected_valid_sct_count = 0;
432 fixture->test_validity = 1;
437 static int test_decode_tls_sct(void)
439 const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
443 "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
444 "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
445 "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
446 "\x00\x00" /* extensions length */
448 "\x04\x03" /* hash and signature algorithms */
449 "\x00\x47" /* signature length */
451 "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
452 "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
453 "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
454 "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
457 SETUP_CT_TEST_FIXTURE();
460 fixture->tls_sct_list = tls_sct_list;
461 fixture->tls_sct_list_len = 0x7a;
462 fixture->sct_dir = ct_dir;
463 fixture->sct_text_file = "tls1.sct";
468 static int test_encode_tls_sct(void)
470 const char log_id[] = "3xwuwRUAlFJHqWFoMl3cXHlZ6PfG04j8AC4LvT9012Q=";
471 const uint64_t timestamp = 1;
472 const char extensions[] = "";
473 const char signature[] = "BAMARzBAMiBIL2dRrzXbplQ2vh/WZA89v5pBQpSVkkUwKI+j5"
474 "eI+BgIhAOTtwNs6xXKx4vXoq2poBlOYfc9BAn3+/6EFUZ2J7b8I";
477 SETUP_CT_TEST_FIXTURE();
481 fixture->sct_list = sk_SCT_new_null();
482 if (!TEST_ptr(sct = SCT_new_from_base64(SCT_VERSION_V1, log_id,
483 CT_LOG_ENTRY_TYPE_X509, timestamp,
484 extensions, signature)))
488 sk_SCT_push(fixture->sct_list, sct);
489 fixture->sct_dir = ct_dir;
490 fixture->sct_text_file = "tls1.sct";
496 * Tests that the CT_POLICY_EVAL_CTX default time is approximately now.
497 * Allow +-10 minutes, as it may compensate for clock skew.
499 static int test_default_ct_policy_eval_ctx_time_is_now(void)
502 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
503 const time_t default_time = CT_POLICY_EVAL_CTX_get_time(ct_policy_ctx) /
505 const time_t time_tolerance = 600; /* 10 minutes */
507 if (!TEST_uint_le((unsigned int)fabs(difftime(time(NULL), default_time)),
508 (unsigned int)time_tolerance))
513 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
517 static int test_ctlog_from_base64(void)
519 CTLOG *ctlogp = NULL;
520 const char notb64[] = "\01\02\03\04";
521 const char pad[] = "====";
522 const char name[] = "name";
524 /* We expect these to both fail! */
525 if (!TEST_true(!CTLOG_new_from_base64(&ctlogp, notb64, name))
526 || !TEST_true(!CTLOG_new_from_base64(&ctlogp, pad, name)))
532 int setup_tests(void)
534 #ifndef OPENSSL_NO_CT
535 if ((ct_dir = getenv("CT_DIR")) == NULL)
537 if ((certs_dir = getenv("CERTS_DIR")) == NULL)
540 ADD_TEST(test_no_scts_in_certificate);
541 ADD_TEST(test_one_sct_in_certificate);
542 ADD_TEST(test_multiple_scts_in_certificate);
543 ADD_TEST(test_verify_one_sct);
544 ADD_TEST(test_verify_multiple_scts);
545 ADD_TEST(test_verify_fails_for_future_sct);
546 ADD_TEST(test_decode_tls_sct);
547 ADD_TEST(test_encode_tls_sct);
548 ADD_TEST(test_default_ct_policy_eval_ctx_time_is_now);
549 ADD_TEST(test_ctlog_from_base64);
551 printf("No CT support\n");