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
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>
24 /* Used when declaring buffers to read text files into */
25 #define CT_TEST_MAX_FILE_SIZE 8096
27 static char *certs_dir = NULL;
28 static char *ct_dir = NULL;
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;
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;
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.
49 const char *sct_text_file;
50 /* Whether to test the validity of the SCT(s) */
55 static CT_TEST_FIXTURE set_up(const char *const test_case_name)
57 CT_TEST_FIXTURE fixture;
59 CTLOG_STORE *ctlog_store;
61 memset(&fixture, 0, sizeof(fixture));
63 ctlog_store = CTLOG_STORE_new();
65 if (ctlog_store == NULL) {
67 fprintf(stderr, "Failed to create a new CT log store\n");
71 if (CTLOG_STORE_load_default_file(ctlog_store) != 1) {
73 fprintf(stderr, "Failed to load CT log list\n");
77 fixture.test_case_name = test_case_name;
78 fixture.ctlog_store = ctlog_store;
87 static void tear_down(CT_TEST_FIXTURE fixture)
89 CTLOG_STORE_free(fixture.ctlog_store);
90 SCT_LIST_free(fixture.sct_list);
91 ERR_print_errors_fp(stderr);
94 static char *mk_file_path(const char *dir, const char *file)
96 char *full_file = NULL;
97 size_t full_file_l = 0;
99 #ifndef OPENSSL_SYS_VMS
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);
114 static X509 *load_pem_cert(const char *dir, const char *file)
117 char *file_path = mk_file_path(dir, file);
119 if (file_path != NULL) {
120 BIO *cert_io = BIO_new_file(file_path, "r");
121 OPENSSL_free(file_path);
124 cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
131 static int read_text_file(const char *dir, const char *file,
132 char *buffer, int buffer_length)
135 char *file_path = mk_file_path(dir, file);
137 if (file_path != NULL) {
138 BIO *file_io = BIO_new_file(file_path, "r");
139 OPENSSL_free(file_path);
141 if (file_io != NULL) {
142 result = BIO_read(file_io, buffer, buffer_length);
150 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
151 const char *expected_output)
153 BIO *text_buffer = NULL;
154 char *actual_output = NULL;
157 text_buffer = BIO_new(BIO_s_mem());
158 if (text_buffer == NULL) {
159 fprintf(stderr, "Unable to allocate buffer\n");
163 SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
165 /* Append null terminator because we're about to use the buffer contents
167 if (BIO_write(text_buffer, "\0", 1) != 1) {
168 fprintf(stderr, "Failed to append null terminator to SCT text\n");
172 BIO_get_mem_data(text_buffer, &actual_output);
173 result = strcmp(actual_output, expected_output);
177 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
178 expected_output, actual_output);
182 BIO_free(text_buffer);
186 static int compare_extension_printout(X509_EXTENSION *extension,
187 const char *expected_output)
189 BIO *text_buffer = NULL;
190 char *actual_output = NULL;
193 text_buffer = BIO_new(BIO_s_mem());
194 if (text_buffer == NULL) {
195 fprintf(stderr, "Unable to allocate buffer\n");
199 if (!X509V3_EXT_print(text_buffer, extension, X509V3_EXT_DEFAULT, 0)) {
200 fprintf(stderr, "Failed to print extension\n");
204 /* Append null terminator because we're about to use the buffer contents
206 if (BIO_write(text_buffer, "\0", 1) != 1) {
208 "Failed to append null terminator to extension text\n");
212 BIO_get_mem_data(text_buffer, &actual_output);
213 result = strcmp(actual_output, expected_output);
217 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
218 expected_output, actual_output);
222 BIO_free(text_buffer);
226 static int assert_validity(CT_TEST_FIXTURE fixture,
228 CT_POLICY_EVAL_CTX *policy_ctx) {
229 int invalid_sct_count = 0;
230 int valid_sct_count = 0;
233 if (SCT_LIST_validate(scts, policy_ctx) < 0) {
234 fprintf(stderr, "Error verifying SCTs\n");
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:
244 case SCT_VALIDATION_STATUS_INVALID:
248 /* Ignore other validation statuses. */
253 if (valid_sct_count != fixture.expected_sct_count) {
254 int unverified_sct_count = sk_SCT_num(scts) -
255 invalid_sct_count - valid_sct_count;
258 "%d SCTs failed verification\n"
259 "%d SCTs passed verification (%d expected)\n"
260 "%d SCTs were unverified\n",
263 fixture.expected_sct_count,
264 unverified_sct_count);
271 static int execute_cert_test(CT_TEST_FIXTURE fixture)
274 X509 *cert = NULL, *issuer = NULL;
275 STACK_OF(SCT) *scts = NULL;
277 char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
278 int sct_text_len = 0;
279 unsigned char *tls_sct_list = NULL;
280 size_t tls_sct_list_len = 0;
281 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
283 if (fixture.sct_text_file != NULL) {
284 sct_text_len = read_text_file(fixture.sct_dir, fixture.sct_text_file,
286 CT_TEST_MAX_FILE_SIZE - 1);
288 if (sct_text_len < 0) {
289 fprintf(stderr, "Test data file not found: %s\n",
290 fixture.sct_text_file);
294 expected_sct_text[sct_text_len] = '\0';
297 CT_POLICY_EVAL_CTX_set0_log_store(ct_policy_ctx, fixture.ctlog_store);
299 if (fixture.certificate_file != NULL) {
300 int sct_extension_index;
301 X509_EXTENSION *sct_extension = NULL;
302 cert = load_pem_cert(fixture.certs_dir, fixture.certificate_file);
305 fprintf(stderr, "Unable to load certificate: %s\n",
306 fixture.certificate_file);
310 CT_POLICY_EVAL_CTX_set0_cert(ct_policy_ctx, cert);
312 if (fixture.issuer_file != NULL) {
313 issuer = load_pem_cert(fixture.certs_dir, fixture.issuer_file);
315 if (issuer == NULL) {
316 fprintf(stderr, "Unable to load issuer certificate: %s\n",
317 fixture.issuer_file);
321 CT_POLICY_EVAL_CTX_set0_issuer(ct_policy_ctx, issuer);
324 sct_extension_index =
325 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
326 sct_extension = X509_get_ext(cert, sct_extension_index);
327 if (fixture.expected_sct_count > 0) {
328 if (sct_extension == NULL) {
329 fprintf(stderr, "SCT extension not found in: %s\n",
330 fixture.certificate_file);
334 if (fixture.sct_text_file
335 && compare_extension_printout(sct_extension,
336 expected_sct_text)) {
340 if (fixture.test_validity) {
343 scts = X509V3_EXT_d2i(sct_extension);
344 for (i = 0; i < sk_SCT_num(scts); ++i) {
345 SCT *sct_i = sk_SCT_value(scts, i);
347 if (!SCT_set_source(sct_i, SCT_SOURCE_X509V3_EXTENSION)) {
349 "Error setting SCT source to X509v3 extension\n");
354 if (!assert_validity(fixture, scts, ct_policy_ctx))
357 } else if (sct_extension != NULL) {
359 "Expected no SCTs, but found SCT extension in: %s\n",
360 fixture.certificate_file);
365 if (fixture.tls_sct_list != NULL) {
366 const unsigned char *p = fixture.tls_sct_list;
367 if (o2i_SCT_LIST(&scts, &p, fixture.tls_sct_list_len) == NULL) {
368 fprintf(stderr, "Failed to decode SCTs from TLS format\n");
372 if (fixture.test_validity && cert != NULL) {
373 if (!assert_validity(fixture, scts, ct_policy_ctx))
377 if (fixture.sct_text_file
378 && compare_sct_list_printout(scts, expected_sct_text)) {
382 tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
383 if (tls_sct_list_len != fixture.tls_sct_list_len ||
384 memcmp(fixture.tls_sct_list, tls_sct_list, tls_sct_list_len) != 0) {
386 "Failed to encode SCTs into TLS format correctly\n");
397 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
398 OPENSSL_free(tls_sct_list);
402 #define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
403 #define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
405 static int test_no_scts_in_certificate()
407 SETUP_CT_TEST_FIXTURE();
408 fixture.certs_dir = certs_dir;
409 fixture.certificate_file = "leaf.pem";
410 fixture.issuer_file = "subinterCA.pem";
411 fixture.expected_sct_count = 0;
415 static int test_one_sct_in_certificate()
417 SETUP_CT_TEST_FIXTURE();
418 fixture.certs_dir = certs_dir;
419 fixture.certificate_file = "embeddedSCTs1.pem";
420 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
421 fixture.expected_sct_count = 1;
422 fixture.sct_dir = certs_dir;
423 fixture.sct_text_file = "embeddedSCTs1.sct";
427 static int test_multiple_scts_in_certificate()
429 SETUP_CT_TEST_FIXTURE();
430 fixture.certs_dir = certs_dir;
431 fixture.certificate_file = "embeddedSCTs3.pem";
432 fixture.issuer_file = "embeddedSCTs3_issuer.pem";
433 fixture.expected_sct_count = 3;
434 fixture.sct_dir = certs_dir;
435 fixture.sct_text_file = "embeddedSCTs3.sct";
439 static int test_verify_one_sct()
441 SETUP_CT_TEST_FIXTURE();
442 fixture.certs_dir = certs_dir;
443 fixture.certificate_file = "embeddedSCTs1.pem";
444 fixture.issuer_file = "embeddedSCTs1_issuer.pem";
445 fixture.expected_sct_count = 1;
446 fixture.test_validity = 1;
450 static int test_verify_multiple_scts()
452 SETUP_CT_TEST_FIXTURE();
453 fixture.certs_dir = certs_dir;
454 fixture.certificate_file = "embeddedSCTs3.pem";
455 fixture.issuer_file = "embeddedSCTs3_issuer.pem";
456 fixture.expected_sct_count = 3;
457 fixture.test_validity = 1;
461 static int test_decode_tls_sct()
463 const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
467 "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
468 "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
469 "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
470 "\x00\x00" /* extensions length */
472 "\x04\x03" /* hash and signature algorithms */
473 "\x00\x47" /* signature length */
475 "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
476 "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
477 "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
478 "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
481 SETUP_CT_TEST_FIXTURE();
482 fixture.tls_sct_list = tls_sct_list;
483 fixture.tls_sct_list_len = 0x7a;
484 fixture.sct_dir = ct_dir;
485 fixture.sct_text_file = "tls1.sct";
489 static int test_encode_tls_sct()
491 const unsigned char log_id[] = "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9"
492 "\x61\x68\x32\x5D\xDC\x5C\x79\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E"
493 "\x0B\xBD\x3F\x74\xD7\x64";
495 const unsigned char signature[] = "\x45\x02\x20\x48\x2F\x67\x51\xAF\x35"
496 "\xDB\xA6\x54\x36\xBE\x1F\xD6\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95"
497 "\x92\x45\x30\x28\x8F\xA3\xE5\xE2\x3E\x06\x02\x21\x00\xE4\xED\xC0"
498 "\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB\x6A\x68\x06\x53\x98\x7D\xCF"
499 "\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89\xED\xBF\x08";
501 SETUP_CT_TEST_FIXTURE();
503 STACK_OF(SCT) *sct_list = sk_SCT_new_null();
504 SCT *sct = SCT_new();
505 if (!SCT_set_version(sct, SCT_VERSION_V1)) {
506 fprintf(stderr, "Failed to set SCT version\n");
509 if (!SCT_set1_log_id(sct, log_id, 32)) {
510 fprintf(stderr, "Failed to set SCT log ID\n");
513 SCT_set_timestamp(sct, 1);
514 if (!SCT_set_signature_nid(sct, NID_ecdsa_with_SHA256)) {
515 fprintf(stderr, "Failed to set SCT signature NID\n");
518 if (!SCT_set1_signature(sct, signature, 71)) {
519 fprintf(stderr, "Failed to set SCT signature\n");
522 sk_SCT_push(sct_list, sct);
524 fixture.sct_list = sct_list;
525 fixture.sct_dir = ct_dir;
526 fixture.sct_text_file = "tls1.sct";
530 int main(int argc, char *argv[])
533 char *tmp_env = NULL;
535 tmp_env = getenv("OPENSSL_DEBUG_MEMORY");
536 if (tmp_env != NULL && strcmp(tmp_env, "on") == 0)
537 CRYPTO_set_mem_debug(1);
538 CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
540 tmp_env = getenv("CT_DIR");
541 ct_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "ct");
542 tmp_env = getenv("CERTS_DIR");
543 certs_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "certs");
545 ADD_TEST(test_no_scts_in_certificate);
546 ADD_TEST(test_one_sct_in_certificate);
547 ADD_TEST(test_multiple_scts_in_certificate);
548 ADD_TEST(test_verify_one_sct);
549 ADD_TEST(test_verify_multiple_scts);
550 ADD_TEST(test_decode_tls_sct);
551 ADD_TEST(test_encode_tls_sct);
553 result = run_tests(argv[0]);
554 ERR_print_errors_fp(stderr);
556 OPENSSL_free(ct_dir);
557 OPENSSL_free(certs_dir);
559 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
560 if (CRYPTO_mem_leaks_fp(stderr) <= 0)
567 #else /* OPENSSL_NO_CT */
569 int main(int argc, char* argv[])
574 #endif /* OPENSSL_NO_CT */