testutil: always print errors on failure
[openssl.git] / test / ct_test.c
1 /*
2  * Copyright 2016 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
22 #ifndef OPENSSL_NO_CT
23
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 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;
37     char *issuer_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;
43     /*
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.
47      */
48     const char *sct_dir;
49     const char *sct_text_file;
50     /* Whether to test the validity of the SCT(s) */
51     int test_validity;
52
53 } CT_TEST_FIXTURE;
54
55 static CT_TEST_FIXTURE set_up(const char *const test_case_name)
56 {
57     CT_TEST_FIXTURE fixture;
58     int setup_ok = 1;
59     CTLOG_STORE *ctlog_store;
60
61     memset(&fixture, 0, sizeof(fixture));
62
63     ctlog_store = CTLOG_STORE_new();
64
65     if (ctlog_store == NULL) {
66         setup_ok = 0;
67         fprintf(stderr, "Failed to create a new CT log store\n");
68         goto end;
69     }
70
71     if (CTLOG_STORE_load_default_file(ctlog_store) != 1) {
72         setup_ok = 0;
73         fprintf(stderr, "Failed to load CT log list\n");
74         goto end;
75     }
76
77     fixture.test_case_name = test_case_name;
78     fixture.ctlog_store = ctlog_store;
79
80 end:
81     if (!setup_ok) {
82         exit(EXIT_FAILURE);
83     }
84     return fixture;
85 }
86
87 static void tear_down(CT_TEST_FIXTURE fixture)
88 {
89     CTLOG_STORE_free(fixture.ctlog_store);
90     SCT_LIST_free(fixture.sct_list);
91 }
92
93 static char *mk_file_path(const char *dir, const char *file)
94 {
95     char *full_file = NULL;
96     size_t full_file_l = 0;
97     const char *sep = "";
98 #ifndef OPENSSL_SYS_VMS
99     sep = "/";
100 #endif
101
102     full_file_l = strlen(dir) + strlen(sep) + strlen(file) + 1;
103     full_file = OPENSSL_zalloc(full_file_l);
104     if (full_file != NULL) {
105         OPENSSL_strlcpy(full_file, dir, full_file_l);
106         OPENSSL_strlcat(full_file, sep, full_file_l);
107         OPENSSL_strlcat(full_file, file, full_file_l);
108     }
109
110     return full_file;
111 }
112
113 static X509 *load_pem_cert(const char *dir, const char *file)
114 {
115     X509 *cert = NULL;
116     char *file_path = mk_file_path(dir, file);
117
118     if (file_path != NULL) {
119         BIO *cert_io = BIO_new_file(file_path, "r");
120         OPENSSL_free(file_path);
121
122         if (cert_io != NULL)
123             cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
124
125         BIO_free(cert_io);
126     }
127     return cert;
128 }
129
130 static int read_text_file(const char *dir, const char *file,
131                           char *buffer, int buffer_length)
132 {
133     int result = -1;
134     char *file_path = mk_file_path(dir, file);
135
136     if (file_path != NULL) {
137         BIO *file_io = BIO_new_file(file_path, "r");
138         OPENSSL_free(file_path);
139
140         if (file_io != NULL) {
141             result = BIO_read(file_io, buffer, buffer_length);
142             BIO_free(file_io);
143         }
144     }
145
146     return result;
147 }
148
149 static int compare_sct_list_printout(STACK_OF(SCT) *sct,
150     const char *expected_output)
151 {
152     BIO *text_buffer = NULL;
153     char *actual_output = NULL;
154     int result = 1;
155
156     text_buffer = BIO_new(BIO_s_mem());
157     if (text_buffer == NULL) {
158         fprintf(stderr, "Unable to allocate buffer\n");
159         goto end;
160     }
161
162     SCT_LIST_print(sct, text_buffer, 0, "\n", NULL);
163
164     /* Append null terminator because we're about to use the buffer contents
165     * as a string. */
166     if (BIO_write(text_buffer, "\0", 1) != 1) {
167         fprintf(stderr, "Failed to append null terminator to SCT text\n");
168         goto end;
169     }
170
171     BIO_get_mem_data(text_buffer, &actual_output);
172     result = strcmp(actual_output, expected_output);
173
174     if (result != 0) {
175         fprintf(stderr,
176             "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
177             expected_output, actual_output);
178     }
179
180 end:
181     BIO_free(text_buffer);
182     return result;
183 }
184
185 static int compare_extension_printout(X509_EXTENSION *extension,
186                                       const char *expected_output)
187 {
188     BIO *text_buffer = NULL;
189     char *actual_output = NULL;
190     int result = 1;
191
192     text_buffer = BIO_new(BIO_s_mem());
193     if (text_buffer == NULL) {
194         fprintf(stderr, "Unable to allocate buffer\n");
195         goto end;
196     }
197
198     if (!X509V3_EXT_print(text_buffer, extension, X509V3_EXT_DEFAULT, 0)) {
199         fprintf(stderr, "Failed to print extension\n");
200         goto end;
201     }
202
203     /* Append null terminator because we're about to use the buffer contents
204      * as a string. */
205     if (BIO_write(text_buffer, "\0", 1) != 1) {
206         fprintf(stderr,
207                 "Failed to append null terminator to extension text\n");
208         goto end;
209     }
210
211     BIO_get_mem_data(text_buffer, &actual_output);
212     result = strcmp(actual_output, expected_output);
213
214     if (result != 0) {
215         fprintf(stderr,
216                 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
217                 expected_output, actual_output);
218     }
219
220 end:
221     BIO_free(text_buffer);
222     return result;
223 }
224
225 static int assert_validity(CT_TEST_FIXTURE fixture,
226                            STACK_OF(SCT) *scts,
227                            CT_POLICY_EVAL_CTX *policy_ctx) {
228     int invalid_sct_count = 0;
229     int valid_sct_count = 0;
230     int i;
231
232     if (SCT_LIST_validate(scts, policy_ctx) < 0) {
233         fprintf(stderr, "Error verifying SCTs\n");
234         return 0;
235     }
236
237     for (i = 0; i < sk_SCT_num(scts); ++i) {
238         SCT *sct_i = sk_SCT_value(scts, i);
239         switch (SCT_get_validation_status(sct_i)) {
240         case SCT_VALIDATION_STATUS_VALID:
241             ++valid_sct_count;
242             break;
243         case SCT_VALIDATION_STATUS_INVALID:
244             ++invalid_sct_count;
245             break;
246         case SCT_VALIDATION_STATUS_NOT_SET:
247         case SCT_VALIDATION_STATUS_UNKNOWN_LOG:
248         case SCT_VALIDATION_STATUS_UNVERIFIED:
249         case SCT_VALIDATION_STATUS_UNKNOWN_VERSION:
250             /* Ignore other validation statuses. */
251             break;
252         }
253     }
254
255     if (valid_sct_count != fixture.expected_sct_count) {
256         int unverified_sct_count = sk_SCT_num(scts) -
257                 invalid_sct_count - valid_sct_count;
258
259         fprintf(stderr,
260                 "%d SCTs failed verification\n"
261                 "%d SCTs passed verification (%d expected)\n"
262                 "%d SCTs were unverified\n",
263                 invalid_sct_count,
264                 valid_sct_count,
265                 fixture.expected_sct_count,
266                 unverified_sct_count);
267         return 0;
268     }
269
270     return 1;
271 }
272
273 static int execute_cert_test(CT_TEST_FIXTURE fixture)
274 {
275     int success = 0;
276     X509 *cert = NULL, *issuer = NULL;
277     STACK_OF(SCT) *scts = NULL;
278     SCT *sct = NULL;
279     char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
280     int sct_text_len = 0;
281     unsigned char *tls_sct_list = NULL;
282     size_t tls_sct_list_len = 0;
283     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
284
285     if (fixture.sct_text_file != NULL) {
286         sct_text_len = read_text_file(fixture.sct_dir, fixture.sct_text_file,
287                                       expected_sct_text,
288                                       CT_TEST_MAX_FILE_SIZE - 1);
289
290         if (sct_text_len < 0) {
291             fprintf(stderr, "Test data file not found: %s\n",
292                 fixture.sct_text_file);
293             goto end;
294         }
295
296         expected_sct_text[sct_text_len] = '\0';
297     }
298
299     CT_POLICY_EVAL_CTX_set_shared_CTLOG_STORE(
300             ct_policy_ctx, fixture.ctlog_store);
301
302     if (fixture.certificate_file != NULL) {
303         int sct_extension_index;
304         X509_EXTENSION *sct_extension = NULL;
305         cert = load_pem_cert(fixture.certs_dir, fixture.certificate_file);
306
307         if (cert == NULL) {
308             fprintf(stderr, "Unable to load certificate: %s\n",
309                 fixture.certificate_file);
310             goto end;
311         }
312
313         CT_POLICY_EVAL_CTX_set1_cert(ct_policy_ctx, cert);
314
315         if (fixture.issuer_file != NULL) {
316             issuer = load_pem_cert(fixture.certs_dir, fixture.issuer_file);
317
318             if (issuer == NULL) {
319                 fprintf(stderr, "Unable to load issuer certificate: %s\n",
320                         fixture.issuer_file);
321                 goto end;
322             }
323
324             CT_POLICY_EVAL_CTX_set1_issuer(ct_policy_ctx, issuer);
325         }
326
327         sct_extension_index =
328                 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
329         sct_extension = X509_get_ext(cert, sct_extension_index);
330         if (fixture.expected_sct_count > 0) {
331             if (sct_extension == NULL) {
332                 fprintf(stderr, "SCT extension not found in: %s\n",
333                     fixture.certificate_file);
334                 goto end;
335             }
336
337             if (fixture.sct_text_file
338                 && compare_extension_printout(sct_extension,
339                                               expected_sct_text)) {
340                     goto end;
341             }
342
343             if (fixture.test_validity) {
344                 int i;
345
346                 scts = X509V3_EXT_d2i(sct_extension);
347                 for (i = 0; i < sk_SCT_num(scts); ++i) {
348                     SCT *sct_i = sk_SCT_value(scts, i);
349
350                     if (!SCT_set_source(sct_i, SCT_SOURCE_X509V3_EXTENSION)) {
351                         fprintf(stderr,
352                                 "Error setting SCT source to X509v3 extension\n");
353                         goto end;
354                     }
355                 }
356
357                 if (!assert_validity(fixture, scts, ct_policy_ctx))
358                     goto end;
359             }
360         } else if (sct_extension != NULL) {
361             fprintf(stderr,
362                     "Expected no SCTs, but found SCT extension in: %s\n",
363                     fixture.certificate_file);
364             goto end;
365         }
366     }
367
368     if (fixture.tls_sct_list != NULL) {
369         const unsigned char *p = fixture.tls_sct_list;
370         if (o2i_SCT_LIST(&scts, &p, fixture.tls_sct_list_len) == NULL) {
371             fprintf(stderr, "Failed to decode SCTs from TLS format\n");
372             goto end;
373         }
374
375         if (fixture.test_validity && cert != NULL) {
376             if (!assert_validity(fixture, scts, ct_policy_ctx))
377                 goto end;
378         }
379
380         if (fixture.sct_text_file
381             && compare_sct_list_printout(scts, expected_sct_text)) {
382                 goto end;
383         }
384
385         tls_sct_list_len = i2o_SCT_LIST(scts, &tls_sct_list);
386         if (tls_sct_list_len != fixture.tls_sct_list_len ||
387             memcmp(fixture.tls_sct_list, tls_sct_list, tls_sct_list_len) != 0) {
388             fprintf(stderr,
389                     "Failed to encode SCTs into TLS format correctly\n");
390             goto end;
391         }
392     }
393     success = 1;
394
395 end:
396     X509_free(cert);
397     X509_free(issuer);
398     SCT_LIST_free(scts);
399     SCT_free(sct);
400     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
401     OPENSSL_free(tls_sct_list);
402     return success;
403 }
404
405 #define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
406 #define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
407
408 static int test_no_scts_in_certificate()
409 {
410     SETUP_CT_TEST_FIXTURE();
411     fixture.certs_dir = certs_dir;
412     fixture.certificate_file = "leaf.pem";
413     fixture.issuer_file = "subinterCA.pem";
414     fixture.expected_sct_count = 0;
415     EXECUTE_CT_TEST();
416 }
417
418 static int test_one_sct_in_certificate()
419 {
420     SETUP_CT_TEST_FIXTURE();
421     fixture.certs_dir = certs_dir;
422     fixture.certificate_file = "embeddedSCTs1.pem";
423     fixture.issuer_file = "embeddedSCTs1_issuer.pem";
424     fixture.expected_sct_count = 1;
425     fixture.sct_dir = certs_dir;
426     fixture.sct_text_file = "embeddedSCTs1.sct";
427     EXECUTE_CT_TEST();
428 }
429
430 static int test_multiple_scts_in_certificate()
431 {
432     SETUP_CT_TEST_FIXTURE();
433     fixture.certs_dir = certs_dir;
434     fixture.certificate_file = "embeddedSCTs3.pem";
435     fixture.issuer_file = "embeddedSCTs3_issuer.pem";
436     fixture.expected_sct_count = 3;
437     fixture.sct_dir = certs_dir;
438     fixture.sct_text_file = "embeddedSCTs3.sct";
439     EXECUTE_CT_TEST();
440 }
441
442 static int test_verify_one_sct()
443 {
444     SETUP_CT_TEST_FIXTURE();
445     fixture.certs_dir = certs_dir;
446     fixture.certificate_file = "embeddedSCTs1.pem";
447     fixture.issuer_file = "embeddedSCTs1_issuer.pem";
448     fixture.expected_sct_count = 1;
449     fixture.test_validity = 1;
450     EXECUTE_CT_TEST();
451 }
452
453 static int test_verify_multiple_scts()
454 {
455     SETUP_CT_TEST_FIXTURE();
456     fixture.certs_dir = certs_dir;
457     fixture.certificate_file = "embeddedSCTs3.pem";
458     fixture.issuer_file = "embeddedSCTs3_issuer.pem";
459     fixture.expected_sct_count = 3;
460     fixture.test_validity = 1;
461     EXECUTE_CT_TEST();
462 }
463
464 static int test_decode_tls_sct()
465 {
466     const unsigned char tls_sct_list[] = "\x00\x78" /* length of list */
467         "\x00\x76"
468         "\x00" /* version */
469         /* log ID */
470         "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
471         "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
472         "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
473         "\x00\x00" /* extensions length */
474         "" /* extensions */
475         "\x04\x03" /* hash and signature algorithms */
476         "\x00\x47" /* signature length */
477         /* signature */
478         "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
479         "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
480         "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
481         "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
482         "\xED\xBF\x08";
483
484     SETUP_CT_TEST_FIXTURE();
485     fixture.tls_sct_list = tls_sct_list;
486     fixture.tls_sct_list_len = 0x7a;
487     fixture.sct_dir = ct_dir;
488     fixture.sct_text_file = "tls1.sct";
489     EXECUTE_CT_TEST();
490 }
491
492 static int test_encode_tls_sct()
493 {
494     const unsigned char log_id[] = "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9"
495             "\x61\x68\x32\x5D\xDC\x5C\x79\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E"
496             "\x0B\xBD\x3F\x74\xD7\x64";
497
498     const unsigned char signature[] = "\x45\x02\x20\x48\x2F\x67\x51\xAF\x35"
499             "\xDB\xA6\x54\x36\xBE\x1F\xD6\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95"
500             "\x92\x45\x30\x28\x8F\xA3\xE5\xE2\x3E\x06\x02\x21\x00\xE4\xED\xC0"
501             "\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB\x6A\x68\x06\x53\x98\x7D\xCF"
502             "\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89\xED\xBF\x08";
503
504     SETUP_CT_TEST_FIXTURE();
505
506     STACK_OF(SCT) *sct_list = sk_SCT_new_null();
507     SCT *sct = SCT_new();
508     if (!SCT_set_version(sct, SCT_VERSION_V1)) {
509         fprintf(stderr, "Failed to set SCT version\n");
510         return 1;
511     }
512     if (!SCT_set1_log_id(sct, log_id, 32)) {
513         fprintf(stderr, "Failed to set SCT log ID\n");
514         return 1;
515     }
516     SCT_set_timestamp(sct, 1);
517     if (!SCT_set_signature_nid(sct, NID_ecdsa_with_SHA256)) {
518         fprintf(stderr, "Failed to set SCT signature NID\n");
519         return 1;
520     }
521     if (!SCT_set1_signature(sct, signature, 71)) {
522         fprintf(stderr, "Failed to set SCT signature\n");
523         return 1;
524     }
525     sk_SCT_push(sct_list, sct);
526
527     fixture.sct_list = sct_list;
528     fixture.sct_dir = ct_dir;
529     fixture.sct_text_file = "tls1.sct";
530     EXECUTE_CT_TEST();
531 }
532
533 int main(int argc, char *argv[])
534 {
535     int result = 0;
536     char *tmp_env = NULL;
537
538     tmp_env = getenv("OPENSSL_DEBUG_MEMORY");
539     if (tmp_env != NULL && strcmp(tmp_env, "on") == 0)
540         CRYPTO_set_mem_debug(1);
541     CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
542
543     tmp_env = getenv("CT_DIR");
544     ct_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "ct");
545     tmp_env = getenv("CERTS_DIR");
546     certs_dir = OPENSSL_strdup(tmp_env != NULL ? tmp_env : "certs");
547
548     ADD_TEST(test_no_scts_in_certificate);
549     ADD_TEST(test_one_sct_in_certificate);
550     ADD_TEST(test_multiple_scts_in_certificate);
551     ADD_TEST(test_verify_one_sct);
552     ADD_TEST(test_verify_multiple_scts);
553     ADD_TEST(test_decode_tls_sct);
554     ADD_TEST(test_encode_tls_sct);
555
556     result = run_tests(argv[0]);
557     ERR_print_errors_fp(stderr);
558
559     OPENSSL_free(ct_dir);
560     OPENSSL_free(certs_dir);
561
562 #ifndef OPENSSL_NO_CRYPTO_MDEBUG
563     if (CRYPTO_mem_leaks_fp(stderr) <= 0)
564         result = 1;
565 #endif
566
567     return result;
568 }
569
570 #else /* OPENSSL_NO_CT */
571
572 int main(int argc, char* argv[])
573 {
574     return EXIT_SUCCESS;
575 }
576
577 #endif /* OPENSSL_NO_CT */