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