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