Fix rpath-related Linux "test_shlibload" failure.
[openssl.git] / test / ct_test.c
1 /*
2  * Copyright 2016-2018 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 <stdio.h>
12 #include <stdlib.h>
13 #include <string.h>
14
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>
20 #include "testutil.h"
21 #include <openssl/crypto.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 = NULL;
62
63     if (!TEST_ptr(fixture = OPENSSL_zalloc(sizeof(*fixture))))
64         goto end;
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     return fixture;
72
73 end:
74     if (fixture != NULL)
75         CTLOG_STORE_free(fixture->ctlog_store);
76     OPENSSL_free(fixture);
77     TEST_error("Failed to setup");
78     return NULL;
79 }
80
81 static void tear_down(CT_TEST_FIXTURE *fixture)
82 {
83     if (fixture != NULL) {
84         CTLOG_STORE_free(fixture->ctlog_store);
85         SCT_LIST_free(fixture->sct_list);
86     }
87     OPENSSL_free(fixture);
88 }
89
90 static char *mk_file_path(const char *dir, const char *file)
91 {
92 # ifndef OPENSSL_SYS_VMS
93     const char *sep = "/";
94 # else
95     const char *sep = "";
96 # endif
97     size_t len = strlen(dir) + strlen(sep) + strlen(file) + 1;
98     char *full_file = OPENSSL_zalloc(len);
99
100     if (full_file != NULL) {
101         OPENSSL_strlcpy(full_file, dir, len);
102         OPENSSL_strlcat(full_file, sep, len);
103         OPENSSL_strlcat(full_file, file, len);
104     }
105
106     return full_file;
107 }
108
109 static X509 *load_pem_cert(const char *dir, const char *file)
110 {
111     X509 *cert = NULL;
112     char *file_path = mk_file_path(dir, file);
113
114     if (file_path != NULL) {
115         BIO *cert_io = BIO_new_file(file_path, "r");
116
117         if (cert_io != NULL)
118             cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
119         BIO_free(cert_io);
120     }
121
122     OPENSSL_free(file_path);
123     return cert;
124 }
125
126 static int read_text_file(const char *dir, const char *file,
127                           char *buffer, int buffer_length)
128 {
129     int len = -1;
130     char *file_path = mk_file_path(dir, file);
131
132     if (file_path != NULL) {
133         BIO *file_io = BIO_new_file(file_path, "r");
134
135         if (file_io != NULL)
136             len = BIO_read(file_io, buffer, buffer_length);
137         BIO_free(file_io);
138     }
139
140     OPENSSL_free(file_path);
141     return len;
142 }
143
144 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
145                                      const char *expected_output)
146 {
147     BIO *text_buffer = NULL;
148     char *actual_output = NULL;
149     int result = 0;
150
151     if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem())))
152         goto end;
153
154     SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
155
156     /* Append \0 because we're about to use the buffer contents as a string. */
157     if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
158         goto end;
159
160     BIO_get_mem_data(text_buffer, &actual_output);
161     if (!TEST_str_eq(actual_output, expected_output))
162         goto end;
163     result = 1;
164
165 end:
166     BIO_free(text_buffer);
167     return result;
168 }
169
170 static int compare_extension_printout(X509_EXTENSION *extension,
171                                       const char *expected_output)
172 {
173     BIO *text_buffer = NULL;
174     char *actual_output = NULL;
175     int result = 0;
176
177     if (!TEST_ptr(text_buffer = BIO_new(BIO_s_mem()))
178             || !TEST_true(X509V3_EXT_print(text_buffer, extension,
179                                            X509V3_EXT_DEFAULT, 0)))
180         goto end;
181
182     /* Append \0 because we're about to use the buffer contents as a string. */
183     if (!TEST_true(BIO_write(text_buffer, "\0", 1)))
184         goto end;
185
186     BIO_get_mem_data(text_buffer, &actual_output);
187     if (!TEST_str_eq(actual_output, expected_output))
188         goto end;
189
190     result = 1;
191
192 end:
193     BIO_free(text_buffer);
194     return result;
195 }
196
197 static int assert_validity(CT_TEST_FIXTURE *fixture, STACK_OF(SCT) *scts,
198                            CT_POLICY_EVAL_CTX *policy_ctx)
199 {
200     int invalid_sct_count = 0;
201     int valid_sct_count = 0;
202     int i;
203
204     if (!TEST_int_ge(SCT_LIST_validate(scts, policy_ctx), 0))
205         return 0;
206
207     for (i = 0; i < sk_SCT_num(scts); ++i) {
208         SCT *sct_i = sk_SCT_value(scts, i);
209
210         switch (SCT_get_validation_status(sct_i)) {
211         case SCT_VALIDATION_STATUS_VALID:
212             ++valid_sct_count;
213             break;
214         case SCT_VALIDATION_STATUS_INVALID:
215             ++invalid_sct_count;
216             break;
217         case SCT_VALIDATION_STATUS_NOT_SET:
218         case SCT_VALIDATION_STATUS_UNKNOWN_LOG:
219         case SCT_VALIDATION_STATUS_UNVERIFIED:
220         case SCT_VALIDATION_STATUS_UNKNOWN_VERSION:
221             /* Ignore other validation statuses. */
222             break;
223         }
224     }
225
226     if (!TEST_int_eq(valid_sct_count, fixture->expected_valid_sct_count)) {
227         int unverified_sct_count = sk_SCT_num(scts) -
228                                         invalid_sct_count - valid_sct_count;
229
230         TEST_info("%d SCTs failed, %d SCTs unverified",
231                   invalid_sct_count, unverified_sct_count);
232         return 0;
233     }
234
235     return 1;
236 }
237
238 static int execute_cert_test(CT_TEST_FIXTURE *fixture)
239 {
240     int success = 0;
241     X509 *cert = NULL, *issuer = NULL;
242     STACK_OF(SCT) *scts = NULL;
243     SCT *sct = NULL;
244     char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
245     int sct_text_len = 0;
246     unsigned char *tls_sct_list = NULL;
247     size_t tls_sct_list_len = 0;
248     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
249
250     if (fixture->sct_text_file != NULL) {
251         sct_text_len = read_text_file(fixture->sct_dir, fixture->sct_text_file,
252                                       expected_sct_text,
253                                       CT_TEST_MAX_FILE_SIZE - 1);
254
255         if (!TEST_int_ge(sct_text_len, 0))
256             goto end;
257         expected_sct_text[sct_text_len] = '\0';
258     }
259
260     CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
261             ct_policy_ctx, fixture->ctlog_store);
262
263     CT_POLICY_EVAL_CTX_set_time(ct_policy_ctx, fixture->epoch_time_in_ms);
264
265     if (fixture->certificate_file != NULL) {
266         int sct_extension_index;
267         int i;
268         X509_EXTENSION *sct_extension = NULL;
269
270         if (!TEST_ptr(cert = load_pem_cert(fixture->certs_dir,
271                                            fixture->certificate_file)))
272             goto end;
273
274         CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
275
276         if (fixture->issuer_file != NULL) {
277             if (!TEST_ptr(issuer = load_pem_cert(fixture->certs_dir,
278                                                  fixture->issuer_file)))
279                 goto end;
280             CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
281         }
282
283         sct_extension_index =
284                 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
285         sct_extension = X509_get_ext(cert, sct_extension_index);
286         if (fixture->expected_sct_count > 0) {
287             if (!TEST_ptr(sct_extension))
288                 goto end;
289
290             if (fixture->sct_text_file
291                 && !compare_extension_printout(sct_extension,
292                                                expected_sct_text))
293                     goto end;
294
295             scts = X509V3_EXT_d2i(sct_extension);
296             for (i = 0; i < sk_SCT_num(scts); ++i) {
297                 SCT *sct_i = sk_SCT_value(scts, i);
298
299                 if (!TEST_int_eq(SCT_get_source(sct_i),
300                                  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     if (fixture == NULL)
354         return 0;
355     fixture->certs_dir = certs_dir;
356     fixture->certificate_file = "leaf.pem";
357     fixture->issuer_file = "subinterCA.pem";
358     fixture->expected_sct_count = 0;
359     EXECUTE_CT_TEST();
360     return result;
361 }
362
363 static int test_one_sct_in_certificate(void)
364 {
365     SETUP_CT_TEST_FIXTURE();
366     if (fixture == NULL)
367         return 0;
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";
374     EXECUTE_CT_TEST();
375     return result;
376 }
377
378 static int test_multiple_scts_in_certificate(void)
379 {
380     SETUP_CT_TEST_FIXTURE();
381     if (fixture == NULL)
382         return 0;
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";
389     EXECUTE_CT_TEST();
390     return result;
391 }
392
393 static int test_verify_one_sct(void)
394 {
395     SETUP_CT_TEST_FIXTURE();
396     if (fixture == NULL)
397         return 0;
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;
403     EXECUTE_CT_TEST();
404     return result;
405 }
406
407 static int test_verify_multiple_scts(void)
408 {
409     SETUP_CT_TEST_FIXTURE();
410     if (fixture == NULL)
411         return 0;
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;
417     EXECUTE_CT_TEST();
418     return result;
419 }
420
421 static int test_verify_fails_for_future_sct(void)
422 {
423     SETUP_CT_TEST_FIXTURE();
424     if (fixture == NULL)
425         return 0;
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;
433     EXECUTE_CT_TEST();
434     return result;
435 }
436
437 static int test_decode_tls_sct(void)
438 {
439     const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
440         "\x00\x76"
441         "\x00" /* version */
442         /* log ID */
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 */
447         "" /* extensions */
448         "\x04\x03" /* hash and signature algorithms */
449         "\x00\x47" /* signature length */
450         /* signature */
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"
455         "\xED\xBF\x08";
456
457     SETUP_CT_TEST_FIXTURE();
458     if (fixture == NULL)
459         return 0;
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";
464     EXECUTE_CT_TEST();
465     return result;
466 }
467
468 static int test_encode_tls_sct(void)
469 {
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";
475     SCT *sct = NULL;
476
477     SETUP_CT_TEST_FIXTURE();
478     if (fixture == NULL)
479         return 0;
480
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)))
485
486         return 0;
487
488     sk_SCT_push(fixture->sct_list, sct);
489     fixture->sct_dir = ct_dir;
490     fixture->sct_text_file = "tls1.sct";
491     EXECUTE_CT_TEST();
492     return result;
493 }
494
495 /*
496  * Tests that the CT_POLICY_EVAL_CTX default time is approximately now.
497  * Allow +-10 minutes, as it may compensate for clock skew.
498  */
499 static int test_default_ct_policy_eval_ctx_time_is_now(void)
500 {
501     int success = 0;
502     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
503     const time_t default_time =
504         (time_t)(CT_POLICY_EVAL_CTX_get_time(ct_policy_ctx) / 1000);
505     const time_t time_tolerance = 600;  /* 10 minutes */
506
507     if (!TEST_time_t_le(abs((int)difftime(time(NULL), default_time)),
508                         time_tolerance))
509         goto end;
510
511     success = 1;
512 end:
513     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
514     return success;
515 }
516
517 static int test_ctlog_from_base64(void)
518 {
519     CTLOG *ctlogp = NULL;
520     const char notb64[] = "\01\02\03\04";
521     const char pad[] = "====";
522     const char name[] = "name";
523
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)))
527         return 0;
528     return 1;
529 }
530 #endif
531
532 int setup_tests(void)
533 {
534 #ifndef OPENSSL_NO_CT
535     if ((ct_dir = getenv("CT_DIR")) == NULL)
536         ct_dir = "ct";
537     if ((certs_dir = getenv("CERTS_DIR")) == NULL)
538         certs_dir = "certs";
539
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);
550 #else
551     printf("No CT support\n");
552 #endif
553     return 1;
554 }