9c46bb4778d543375db16d317f992b71c0a546bf
[openssl.git] / test / ct_test.c
1 /*
2  * Copyright 2016-2017 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #include <ctype.h>
11 #include <math.h>
12 #include <stdio.h>
13 #include <stdlib.h>
14 #include <string.h>
15
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>
21 #include "testutil.h"
22
23 #ifndef OPENSSL_NO_CT
24 /* Used when declaring buffers to read text files into */
25 # define CT_TEST_MAX_FILE_SIZE 8096
26
27 static char *certs_dir = NULL;
28 static char *ct_dir = NULL;
29
30 typedef struct ct_test_fixture {
31     const char *test_case_name;
32     /* The current time in milliseconds */
33     uint64_t epoch_time_in_ms;
34     /* The CT log store to use during tests */
35     CTLOG_STORE* ctlog_store;
36     /* Set the following to test handling of SCTs in X509 certificates */
37     const char *certs_dir;
38     char *certificate_file;
39     char *issuer_file;
40     /* Expected number of SCTs */
41     int expected_sct_count;
42     /* Expected number of valid SCTS */
43     int expected_valid_sct_count;
44     /* Set the following to test handling of SCTs in TLS format */
45     const unsigned char *tls_sct_list;
46     size_t tls_sct_list_len;
47     STACK_OF(SCT) *sct_list;
48     /*
49      * A file to load the expected SCT text from.
50      * This text will be compared to the actual text output during the test.
51      * A maximum of |CT_TEST_MAX_FILE_SIZE| bytes will be read of this file.
52      */
53     const char *sct_dir;
54     const char *sct_text_file;
55     /* Whether to test the validity of the SCT(s) */
56     int test_validity;
57 } CT_TEST_FIXTURE;
58
59 static CT_TEST_FIXTURE set_up(const char *const test_case_name)
60 {
61     CT_TEST_FIXTURE fixture;
62     int ok = 0;
63
64     memset(&fixture, 0, sizeof(fixture));
65     fixture.test_case_name = test_case_name;
66     fixture.epoch_time_in_ms = 1473269626000; /* Sep 7 17:33:46 2016 GMT */
67     if (!TEST_ptr(fixture.ctlog_store = CTLOG_STORE_new())
68             || !TEST_int_eq(
69                     CTLOG_STORE_load_default_file(fixture.ctlog_store), 1))
70         goto end;
71     ok = 1;
72
73 end:
74     if (!ok) {
75         CTLOG_STORE_free(fixture.ctlog_store);
76         TEST_error("Failed to setup");
77         exit(EXIT_FAILURE);
78     }
79     return fixture;
80 }
81
82 static void tear_down(CT_TEST_FIXTURE fixture)
83 {
84     CTLOG_STORE_free(fixture.ctlog_store);
85     SCT_LIST_free(fixture.sct_list);
86 }
87
88 static char *mk_file_path(const char *dir, const char *file)
89 {
90 # ifndef OPENSSL_SYS_VMS
91     const char *sep = "/";
92 # else
93     const char *sep = "";
94 # endif
95     size_t len = strlen(dir) + strlen(sep) + strlen(file) + 1;
96     char *full_file = OPENSSL_zalloc(len);
97
98     if (full_file != NULL) {
99         OPENSSL_strlcpy(full_file, dir, len);
100         OPENSSL_strlcat(full_file, sep, len);
101         OPENSSL_strlcat(full_file, file, len);
102     }
103
104     return full_file;
105 }
106
107 static X509 *load_pem_cert(const char *dir, const char *file)
108 {
109     X509 *cert = NULL;
110     char *file_path = mk_file_path(dir, file);
111
112     if (file_path != NULL) {
113         BIO *cert_io = BIO_new_file(file_path, "r");
114
115         if (cert_io != NULL)
116             cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
117         BIO_free(cert_io);
118     }
119
120     OPENSSL_free(file_path);
121     return cert;
122 }
123
124 static int read_text_file(const char *dir, const char *file,
125                           char *buffer, int buffer_length)
126 {
127     int len = -1;
128     char *file_path = mk_file_path(dir, file);
129
130     if (file_path != NULL) {
131         BIO *file_io = BIO_new_file(file_path, "r");
132
133         if (file_io != NULL)
134             len = BIO_read(file_io, buffer, buffer_length);
135         BIO_free(file_io);
136     }
137
138     OPENSSL_free(file_path);
139     return len;
140 }
141
142 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
143                                      const char *expected_output)
144 {
145     BIO *text_buffer = NULL;
146     char *actual_output = NULL;
147     int result = 0;
148
149     if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem())))
150         goto end;
151
152     SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
153
154     /* Append \0 because we're about to use the buffer contents as a string. */
155     if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
156         goto end;
157
158     BIO_get_mem_data(text_buffer, &actual_output);
159     if (!TEST_str_eq(actual_output, expected_output))
160         goto end;
161     result = 1;
162
163 end:
164     BIO_free(text_buffer);
165     return result;
166 }
167
168 static int compare_extension_printout(X509_EXTENSION *extension,
169                                       const char *expected_output)
170 {
171     BIO *text_buffer = NULL;
172     char *actual_output = NULL;
173     int result = 0;
174
175     if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem()))
176             || !TEST_true(X509V3_EXT_print(text_buffer, extension,
177                                            X509V3_EXT_DEFAULT, 0)))
178         goto end;
179
180     /* Append \0 because we're about to use the buffer contents as a string. */
181     if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
182         goto end;
183
184     BIO_get_mem_data(text_buffer, &actual_output);
185     if (!TEST_str_eq(actual_output, expected_output))
186         goto end;
187
188     result = 1;
189
190 end:
191     BIO_free(text_buffer);
192     return result;
193 }
194
195 static int assert_validity(CT_TEST_FIXTURE fixture, STACK_OF(SCT) *scts,
196                            CT_POLICY_EVAL_CTX *policy_ctx)
197 {
198     int invalid_sct_count = 0;
199     int valid_sct_count = 0;
200     int i;
201
202     if (!TEST_int_ge(SCT_LIST_validate(scts, policy_ctx), 0))
203         return 0;
204
205     for (i = 0; i < sk_SCT_num(scts); ++i) {
206         SCT *sct_i = sk_SCT_value(scts, i);
207
208         switch (SCT_get_validation_status(sct_i)) {
209         case SCT_VALIDATION_STATUS_VALID:
210             ++valid_sct_count;
211             break;
212         case SCT_VALIDATION_STATUS_INVALID:
213             ++invalid_sct_count;
214             break;
215         case SCT_VALIDATION_STATUS_NOT_SET:
216         case SCT_VALIDATION_STATUS_UNKNOWN_LOG:
217         case SCT_VALIDATION_STATUS_UNVERIFIED:
218         case SCT_VALIDATION_STATUS_UNKNOWN_VERSION:
219             /* Ignore other validation statuses. */
220             break;
221         }
222     }
223
224     if (!TEST_int_eq(valid_sct_count, fixture.expected_valid_sct_count)) {
225         int unverified_sct_count = sk_SCT_num(scts) -
226                                         invalid_sct_count - valid_sct_count;
227
228         TEST_info("%d SCTs failed, %d SCTs unverified",
229                   invalid_sct_count, unverified_sct_count);
230         return 0;
231     }
232
233     return 1;
234 }
235
236 static int execute_cert_test(CT_TEST_FIXTURE fixture)
237 {
238     int success = 0;
239     X509 *cert = NULL, *issuer = NULL;
240     STACK_OF(SCT) *scts = NULL;
241     SCT *sct = NULL;
242     char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
243     int sct_text_len = 0;
244     unsigned char *tls_sct_list = NULL;
245     size_t tls_sct_list_len = 0;
246     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
247
248     if (fixture.sct_text_file != NULL) {
249         sct_text_len = read_text_file(fixture.sct_dir, fixture.sct_text_file,
250                                       expected_sct_text,
251                                       CT_TEST_MAX_FILE_SIZE - 1);
252
253         if (!TEST_int_ge(sct_text_len, 0))
254             goto end;
255         expected_sct_text[sct_text_len] = '\0';
256     }
257
258     CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
259             ct_policy_ctx, fixture.ctlog_store);
260
261     CT_POLICY_EVAL_CTX_set_time(ct_policy_ctx, fixture.epoch_time_in_ms);
262
263     if (fixture.certificate_file != NULL) {
264         int sct_extension_index;
265         int i;
266         X509_EXTENSION *sct_extension = NULL;
267
268         if (!TEST_ptr(cert = load_pem_cert(fixture.certs_dir,
269                                            fixture.certificate_file)))
270             goto end;
271
272         CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
273
274         if (fixture.issuer_file != NULL) {
275             if (!TEST_ptr(issuer = load_pem_cert(fixture.certs_dir,
276                                                  fixture.issuer_file)))
277                 goto end;
278             CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
279         }
280
281         sct_extension_index =
282                 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
283         sct_extension = X509_get_ext(cert, sct_extension_index);
284         if (fixture.expected_sct_count > 0) {
285             if (!TEST_ptr(sct_extension))
286                 goto end;
287
288             if (fixture.sct_text_file
289                 && !compare_extension_printout(sct_extension,
290                                                expected_sct_text))
291                     goto end;
292
293             scts = X509V3_EXT_d2i(sct_extension);
294             for (i = 0; i < sk_SCT_num(scts); ++i) {
295                 SCT *sct_i = sk_SCT_value(scts, i);
296
297                 if (!TEST_int_eq(SCT_get_source(sct_i), SCT_SOURCE_X509V3_EXTENSION)) {
298                     goto end;
299                 }
300             }
301
302             if (fixture.test_validity) {
303                 if (!assert_validity(fixture, scts, ct_policy_ctx))
304                     goto end;
305             }
306         } else if (!TEST_ptr_null(sct_extension)) {
307             goto end;
308         }
309     }
310
311     if (fixture.tls_sct_list != NULL) {
312         const unsigned char *p = fixture.tls_sct_list;
313
314         if (!TEST_ptr(o2i_SCT_LIST(&scts, &p, fixture.tls_sct_list_len)))
315             goto end;
316
317         if (fixture.test_validity && cert != NULL) {
318             if (!assert_validity(fixture, scts, ct_policy_ctx))
319                 goto end;
320         }
321
322         if (fixture.sct_text_file
323             && !compare_sct_list_printout(scts, expected_sct_text)) {
324                 goto end;
325         }
326
327         tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
328         if (!TEST_mem_eq(fixture.tls_sct_list, fixture.tls_sct_list_len,
329                          tls_sct_list, tls_sct_list_len))
330             goto end;
331     }
332     success = 1;
333
334 end:
335     X509_free(cert);
336     X509_free(issuer);
337     SCT_LIST_free(scts);
338     SCT_free(sct);
339     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
340     OPENSSL_free(tls_sct_list);
341     return success;
342 }
343
344 # define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
345 # define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
346
347 static int test_no_scts_in_certificate(void)
348 {
349     SETUP_CT_TEST_FIXTURE();
350     fixture.certs_dir = certs_dir;
351     fixture.certificate_file = "leaf.pem";
352     fixture.issuer_file = "subinterCA.pem";
353     fixture.expected_sct_count = 0;
354     EXECUTE_CT_TEST();
355 }
356
357 static int test_one_sct_in_certificate(void)
358 {
359     SETUP_CT_TEST_FIXTURE();
360     fixture.certs_dir = certs_dir;
361     fixture.certificate_file = "embeddedSCTs1.pem";
362     fixture.issuer_file = "embeddedSCTs1_issuer.pem";
363     fixture.expected_sct_count = 1;
364     fixture.sct_dir = certs_dir;
365     fixture.sct_text_file = "embeddedSCTs1.sct";
366     EXECUTE_CT_TEST();
367 }
368
369 static int test_multiple_scts_in_certificate(void)
370 {
371     SETUP_CT_TEST_FIXTURE();
372     fixture.certs_dir = certs_dir;
373     fixture.certificate_file = "embeddedSCTs3.pem";
374     fixture.issuer_file = "embeddedSCTs3_issuer.pem";
375     fixture.expected_sct_count = 3;
376     fixture.sct_dir = certs_dir;
377     fixture.sct_text_file = "embeddedSCTs3.sct";
378     EXECUTE_CT_TEST();
379 }
380
381 static int test_verify_one_sct(void)
382 {
383     SETUP_CT_TEST_FIXTURE();
384     fixture.certs_dir = certs_dir;
385     fixture.certificate_file = "embeddedSCTs1.pem";
386     fixture.issuer_file = "embeddedSCTs1_issuer.pem";
387     fixture.expected_sct_count = fixture.expected_valid_sct_count = 1;
388     fixture.test_validity = 1;
389     EXECUTE_CT_TEST();
390 }
391
392 static int test_verify_multiple_scts(void)
393 {
394     SETUP_CT_TEST_FIXTURE();
395     fixture.certs_dir = certs_dir;
396     fixture.certificate_file = "embeddedSCTs3.pem";
397     fixture.issuer_file = "embeddedSCTs3_issuer.pem";
398     fixture.expected_sct_count = fixture.expected_valid_sct_count = 3;
399     fixture.test_validity = 1;
400     EXECUTE_CT_TEST();
401 }
402
403 static int test_verify_fails_for_future_sct(void)
404 {
405     SETUP_CT_TEST_FIXTURE();
406     fixture.epoch_time_in_ms = 1365094800000; /* Apr 4 17:00:00 2013 GMT */
407     fixture.certs_dir = certs_dir;
408     fixture.certificate_file = "embeddedSCTs1.pem";
409     fixture.issuer_file = "embeddedSCTs1_issuer.pem";
410     fixture.expected_sct_count = 1;
411     fixture.expected_valid_sct_count = 0;
412     fixture.test_validity = 1;
413     EXECUTE_CT_TEST();
414 }
415
416 static int test_decode_tls_sct(void)
417 {
418     const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
419         "\x00\x76"
420         "\x00" /* version */
421         /* log ID */
422         "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
423         "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
424         "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
425         "\x00\x00" /* extensions length */
426         "" /* extensions */
427         "\x04\x03" /* hash and signature algorithms */
428         "\x00\x47" /* signature length */
429         /* signature */
430         "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
431         "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
432         "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
433         "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
434         "\xED\xBF\x08";
435
436     SETUP_CT_TEST_FIXTURE();
437     fixture.tls_sct_list = tls_sct_list;
438     fixture.tls_sct_list_len = 0x7a;
439     fixture.sct_dir = ct_dir;
440     fixture.sct_text_file = "tls1.sct";
441     EXECUTE_CT_TEST();
442 }
443
444 static int test_encode_tls_sct(void)
445 {
446     const char log_id[] = "3xwuwRUAlFJHqWFoMl3cXHlZ6PfG04j8AC4LvT9012Q=";
447     const uint64_t timestamp = 1;
448     const char extensions[] = "";
449     const char signature[] = "BAMARzBAMiBIL2dRrzXbplQ2vh/WZA89v5pBQpSVkkUwKI+j5"
450             "eI+BgIhAOTtwNs6xXKx4vXoq2poBlOYfc9BAn3+/6EFUZ2J7b8I";
451     SCT *sct = NULL;
452
453     SETUP_CT_TEST_FIXTURE();
454
455     fixture.sct_list = sk_SCT_new_null();
456     if (!TEST_ptr(sct = SCT_new_from_base64(SCT_VERSION_V1, log_id,
457                                             CT_LOG_ENTRY_TYPE_X509, timestamp,
458                                             extensions, signature)))
459
460         return 0;
461
462     sk_SCT_push(fixture.sct_list, sct);
463     fixture.sct_dir = ct_dir;
464     fixture.sct_text_file = "tls1.sct";
465     EXECUTE_CT_TEST();
466 }
467
468 /*
469  * Tests that the CT_POLICY_EVAL_CTX default time is approximately now.
470  * Allow +-10 minutes, as it may compensate for clock skew.
471  */
472 static int test_default_ct_policy_eval_ctx_time_is_now(void)
473 {
474     int success = 0;
475     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
476     const time_t default_time = CT_POLICY_EVAL_CTX_get_time(ct_policy_ctx) /
477             1000;
478     const time_t time_tolerance = 600;  /* 10 minutes */
479
480     if (!TEST_uint_le(fabs(difftime(time(NULL), default_time)), time_tolerance))
481         goto end;
482
483     success = 1;
484 end:
485     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
486     return success;
487 }
488
489 static int test_ctlog_from_base64(void)
490 {
491     CTLOG *ctlogp = NULL;
492     const char notb64[] = "\01\02\03\04";
493     const char pad[] = "====";
494     const char name[] = "name";
495
496     /* We expect these to both fail! */
497     if (!TEST_true(!CTLOG_new_from_base64(&ctlogp, notb64, name))
498         || !TEST_true(!CTLOG_new_from_base64(&ctlogp, pad, name)))
499         return 0;
500     return 1;
501 }
502 #endif
503
504 int setup_tests(void)
505 {
506 #ifndef OPENSSL_NO_CT
507     if ((ct_dir = getenv("CT_DIR")) == NULL)
508         ct_dir = "ct";
509     if ((certs_dir = getenv("CERTS_DIR")) == NULL)
510         certs_dir = "certs";
511
512     ADD_TEST(test_no_scts_in_certificate);
513     ADD_TEST(test_one_sct_in_certificate);
514     ADD_TEST(test_multiple_scts_in_certificate);
515     ADD_TEST(test_verify_one_sct);
516     ADD_TEST(test_verify_multiple_scts);
517     ADD_TEST(test_verify_fails_for_future_sct);
518     ADD_TEST(test_decode_tls_sct);
519     ADD_TEST(test_encode_tls_sct);
520     ADD_TEST(test_default_ct_policy_eval_ctx_time_is_now);
521     ADD_TEST(test_ctlog_from_base64);
522 #else
523     printf("No CT support\n");
524 #endif
525     return 1;
526 }