2 * Tests the Certificate Transparency public and internal APIs.
4 * Author: Rob Percival (robpercival@google.com)
6 * ====================================================================
7 * Copyright (c) 2016 The OpenSSL Project. All rights reserved.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
21 * 3. All advertising materials mentioning features or use of this
22 * software must display the following acknowledgment:
23 * "This product includes software developed by the OpenSSL Project
24 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
26 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27 * endorse or promote products derived from this software without
28 * prior written permission. For written permission, please contact
29 * licensing@OpenSSL.org.
31 * 5. Products derived from this software may not be called "OpenSSL"
32 * nor may "OpenSSL" appear in their names without prior written
33 * permission of the OpenSSL Project.
35 * 6. Redistributions of any form whatsoever must retain the following
37 * "This product includes software developed by the OpenSSL Project
38 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
40 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT AS IS'' AND ANY
41 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
44 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51 * OF THE POSSIBILITY OF SUCH DAMAGE.
52 * ====================================================================
60 #include <openssl/ct.h>
61 #include <openssl/err.h>
62 #include <openssl/ssl.h>
63 #include <openssl/x509.h>
64 #include <openssl/x509v3.h>
67 #if !defined(OPENSSL_NO_CT) && !defined(OPENSSL_NO_UNIT_TEST)
69 /* Used when declaring buffers to read text files into */
70 #define CT_TEST_MAX_FILE_SIZE 8096
72 typedef struct ct_test_fixture {
73 const char *test_case_name;
74 /* The CT log store to use during tests */
75 CTLOG_STORE* ctlog_store;
76 /* Set the following to test handling of SCTs in X509 certificates */
77 const char *certificate_file_path;
78 const char *issuer_file_path;
79 int expected_sct_count;
80 /* Set the following to test handling of SCTs in TLS format */
81 const uint8_t *tls_sct;
85 * A file to load the expected SCT text from.
86 * This text will be compared to the actual text output during the test.
87 * A maximum of |CT_TEST_MAX_FILE_SIZE| bytes will be read of this file.
89 const char *sct_text_file_path;
90 /* Whether to test the validity of the SCT(s) */
95 static CT_TEST_FIXTURE set_up(const char *const test_case_name)
97 CT_TEST_FIXTURE fixture;
99 CTLOG_STORE *ctlog_store = CTLOG_STORE_new();
101 if (ctlog_store == NULL) {
103 fprintf(stderr, "Failed to create a new CT log store\n");
107 if (CTLOG_STORE_load_default_file(ctlog_store) != 1) {
109 fprintf(stderr, "Failed to load CT log list\n");
113 memset(&fixture, 0, sizeof(fixture));
114 fixture.test_case_name = test_case_name;
115 fixture.ctlog_store = ctlog_store;
124 static void tear_down(CT_TEST_FIXTURE fixture)
126 CTLOG_STORE_free(fixture.ctlog_store);
127 ERR_print_errors_fp(stderr);
130 static X509 *load_pem_cert(const char *file)
132 BIO *cert_io = BIO_new_file(file, "r");
135 if (cert_io == NULL) goto end;
137 cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
144 static int read_text_file(const char *path, char *buffer, int buffer_length)
146 BIO *file = BIO_new_file(path, "r");
150 result = BIO_read(file, buffer, buffer_length);
157 static int compare_sct_printout(SCT *sct,
158 const char *expected_output)
160 BIO *text_buffer = NULL;
161 char *actual_output = NULL;
164 text_buffer = BIO_new(BIO_s_mem());
165 if (text_buffer == NULL) {
166 fprintf(stderr, "Unable to allocate buffer\n");
170 SCT_print(sct, text_buffer, 0);
172 /* Append null terminator because we're about to use the buffer contents
174 if (BIO_write(text_buffer, "\0", 1) != 1) {
175 fprintf(stderr, "Failed to append null terminator to SCT text\n");
179 BIO_get_mem_data(text_buffer, &actual_output);
180 result = strcmp(actual_output, expected_output);
184 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
185 expected_output, actual_output);
189 BIO_free(text_buffer);
193 static int compare_extension_printout(X509_EXTENSION *extension,
194 const char *expected_output)
196 BIO *text_buffer = NULL;
197 char *actual_output = NULL;
200 text_buffer = BIO_new(BIO_s_mem());
201 if (text_buffer == NULL) {
202 fprintf(stderr, "Unable to allocate buffer\n");
206 if (!X509V3_EXT_print(text_buffer, extension, X509V3_EXT_DEFAULT, 0)) {
207 fprintf(stderr, "Failed to print extension\n");
211 /* Append null terminator because we're about to use the buffer contents
213 if (BIO_write(text_buffer, "\0", 1) != 1) {
214 fprintf(stderr, "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 execute_cert_test(CT_TEST_FIXTURE fixture)
235 X509 *cert = NULL, *issuer = NULL;
236 STACK_OF(SCT) *scts = NULL;
238 char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
239 int sct_text_len = 0;
240 CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
242 if (fixture.sct_text_file_path != NULL) {
243 sct_text_len = read_text_file(
244 fixture.sct_text_file_path,
246 CT_TEST_MAX_FILE_SIZE - 1);
248 if (sct_text_len < 0) {
250 fprintf(stderr, "Test data file not found: %s\n",
251 fixture.sct_text_file_path);
255 expected_sct_text[sct_text_len] = '\0';
258 CT_POLICY_EVAL_CTX_set0_log_store(ct_policy_ctx, fixture.ctlog_store);
260 if (fixture.certificate_file_path != NULL) {
261 int sct_extension_index;
262 X509_EXTENSION *sct_extension = NULL;
263 cert = load_pem_cert(fixture.certificate_file_path);
267 fprintf(stderr, "Unable to load certificate: %s\n",
268 fixture.certificate_file_path);
272 CT_POLICY_EVAL_CTX_set0_cert(ct_policy_ctx, cert);
274 if (fixture.issuer_file_path != NULL) {
275 issuer = load_pem_cert(fixture.issuer_file_path);
277 if (issuer == NULL) {
279 fprintf(stderr, "Unable to load issuer certificate: %s\n",
280 fixture.issuer_file_path);
284 CT_POLICY_EVAL_CTX_set0_issuer(ct_policy_ctx, issuer);
287 sct_extension_index =
288 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
289 sct_extension = X509_get_ext(cert, sct_extension_index);
290 if (fixture.expected_sct_count > 0) {
291 if (sct_extension == NULL) {
293 fprintf(stderr, "SCT extension not found in: %s\n",
294 fixture.certificate_file_path);
298 if (fixture.sct_text_file_path) {
299 test_failed = compare_extension_printout(sct_extension,
301 if (test_failed != 0)
305 if (fixture.test_validity) {
306 int are_scts_validated = 0;
307 scts = X509V3_EXT_d2i(sct_extension);
308 SCT_LIST_set_source(scts, SCT_SOURCE_X509V3_EXTENSION);
310 are_scts_validated = SCT_LIST_validate(scts, ct_policy_ctx);
311 if (are_scts_validated < 0) {
312 fprintf(stderr, "Error verifying SCTs\n");
314 } else if (!are_scts_validated) {
315 int invalid_sct_count = 0;
316 int valid_sct_count = 0;
319 for (i = 0; i < sk_SCT_num(scts); ++i) {
320 SCT *sct_i = sk_SCT_value(scts, i);
321 switch (SCT_get_validation_status(sct_i)) {
322 case SCT_VALIDATION_STATUS_VALID:
325 case SCT_VALIDATION_STATUS_INVALID:
329 /* Ignore other validation statuses. */
334 if (valid_sct_count != fixture.expected_sct_count) {
335 int unverified_sct_count = sk_SCT_num(scts) -
336 invalid_sct_count - valid_sct_count;
339 "%d SCTs failed verification\n"
340 "%d SCTs passed verification (%d expected)\n"
341 "%d SCTs were unverified\n",
344 fixture.expected_sct_count,
345 unverified_sct_count);
350 if (test_failed != 0)
353 } else if (sct_extension != NULL) {
356 "Expected no SCTs, but found SCT extension in: %s\n",
357 fixture.certificate_file_path);
362 if (fixture.tls_sct != NULL) {
363 const unsigned char *p = fixture.tls_sct;
364 unsigned char *tls_sct;
366 if (o2i_SCT(&sct, &p, fixture.tls_sct_len) == NULL) {
368 fprintf(stderr, "Failed to decode SCT from TLS format\n");
372 if (fixture.sct_text_file_path) {
373 test_failed = compare_sct_printout(sct, expected_sct_text);
374 if (test_failed != 0)
378 tls_sct_len = i2o_SCT(sct, &tls_sct);
379 if (tls_sct_len != fixture.tls_sct_len ||
380 memcmp(fixture.tls_sct, tls_sct, tls_sct_len) != 0) {
382 fprintf(stderr, "Failed to encode SCT into TLS format correctly\n");
386 if (fixture.test_validity && cert != NULL) {
387 int is_sct_validated = SCT_validate(sct, ct_policy_ctx);
388 if (is_sct_validated < 0) {
390 fprintf(stderr, "Error validating SCT\n");
392 } else if (!is_sct_validated) {
394 fprintf(stderr, "SCT failed verification\n");
405 CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
409 #define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
410 #define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
412 static int test_no_scts_in_certificate()
414 SETUP_CT_TEST_FIXTURE();
415 fixture.certificate_file_path = "certs/leaf.pem";
416 fixture.issuer_file_path = "certs/subinterCA.pem";
417 fixture.expected_sct_count = 0;
421 static int test_one_sct_in_certificate()
423 SETUP_CT_TEST_FIXTURE();
424 fixture.certificate_file_path = "certs/embeddedSCTs1.pem";
425 fixture.issuer_file_path = "certs/embeddedSCTs1_issuer.pem";
426 fixture.expected_sct_count = 1;
427 fixture.sct_text_file_path = "certs/embeddedSCTs1.sct";
431 static int test_multiple_scts_in_certificate()
433 SETUP_CT_TEST_FIXTURE();
434 fixture.certificate_file_path = "certs/embeddedSCTs3.pem";
435 fixture.issuer_file_path = "certs/embeddedSCTs3_issuer.pem";
436 fixture.expected_sct_count = 3;
437 fixture.sct_text_file_path = "certs/embeddedSCTs3.sct";
441 static int test_verify_one_sct()
443 SETUP_CT_TEST_FIXTURE();
444 fixture.certificate_file_path = "certs/embeddedSCTs1.pem";
445 fixture.issuer_file_path = "certs/embeddedSCTs1_issuer.pem";
446 fixture.expected_sct_count = 1;
447 fixture.test_validity = 1;
451 static int test_verify_multiple_scts()
453 SETUP_CT_TEST_FIXTURE();
454 fixture.certificate_file_path = "certs/embeddedSCTs3.pem";
455 fixture.issuer_file_path = "certs/embeddedSCTs3_issuer.pem";
456 fixture.expected_sct_count = 3;
457 fixture.test_validity = 1;
461 static int test_decode_tls_sct()
463 SETUP_CT_TEST_FIXTURE();
464 fixture.tls_sct = (unsigned char *)
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 */
474 "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
475 "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
476 "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
477 "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
478 "\xED\xBF\x08"; /* signature */
479 fixture.tls_sct_len = 118;
480 fixture.sct_text_file_path = "ct/tls1.sct";
484 static int test_encode_tls_sct()
486 SETUP_CT_TEST_FIXTURE();
488 SCT *sct = SCT_new();
489 SCT_set_version(sct, 0);
490 SCT_set1_log_id(sct, (unsigned char *)
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", 32);
493 SCT_set_timestamp(sct, 1);
494 SCT_set1_extensions(sct, (unsigned char *)"", 0);
495 SCT_set_signature_nid(sct, NID_ecdsa_with_SHA256);
496 SCT_set1_signature(sct, (unsigned char *)
497 "\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE"
498 "\x1F\xD6\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3"
499 "\xE5\xE2\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5"
500 "\xE8\xAB\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51"
501 "\x9D\x89\xED\xBF\x08", 71);
503 fixture.sct_text_file_path = "ct/tls1.sct";
509 int main(int argc, char *argv[])
513 ADD_TEST(test_no_scts_in_certificate);
514 ADD_TEST(test_one_sct_in_certificate);
515 ADD_TEST(test_multiple_scts_in_certificate);
516 ADD_TEST(test_verify_one_sct);
517 ADD_TEST(test_verify_multiple_scts);
518 ADD_TEST(test_decode_tls_sct);
519 ADD_TEST(test_encode_tls_sct);
521 result = run_tests(argv[0]);
522 ERR_print_errors_fp(stderr);
527 #else /* OPENSSL_NO_CT */
529 int main(int argc, char* argv[])
534 #endif /* OPENSSL_NO_CT */