Fixes memory leaks in CT code
[openssl.git] / test / ct_test.c
1 /*
2  * Tests the Certificate Transparency public and internal APIs.
3  *
4  * Author:      Rob Percival (robpercival@google.com)
5  *
6  * ====================================================================
7  * Copyright (c) 2016 The OpenSSL Project.    All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  *        notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *        notice, this list of conditions and the following disclaimer in
18  *        the documentation and/or other materials provided with the
19  *        distribution.
20  *
21  * 3. All advertising materials mentioning features or use of this
22  *        software must display the following acknowledgment:
23  *        "This product includes software developed by the OpenSSL Project
24  *        for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
25  *
26  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
27  *        endorse or promote products derived from this software without
28  *        prior written permission. For written permission, please contact
29  *        licensing@OpenSSL.org.
30  *
31  * 5. Products derived from this software may not be called "OpenSSL"
32  *        nor may "OpenSSL" appear in their names without prior written
33  *        permission of the OpenSSL Project.
34  *
35  * 6. Redistributions of any form whatsoever must retain the following
36  *        acknowledgment:
37  *        "This product includes software developed by the OpenSSL Project
38  *        for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT AS IS'' AND ANY
41  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
43  * PURPOSE ARE DISCLAIMED.    IN NO EVENT SHALL THE OpenSSL PROJECT OR
44  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
46  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
47  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
49  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
50  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
51  * OF THE POSSIBILITY OF SUCH DAMAGE.
52  * ====================================================================
53  */
54
55 #include <ctype.h>
56 #include <stdio.h>
57 #include <stdlib.h>
58 #include <string.h>
59
60 #include <openssl/ct.h>
61 #include <openssl/err.h>
62 #include <openssl/ssl.h>
63 #include <openssl/x509.h>
64 #include <openssl/x509v3.h>
65 #include "testutil.h"
66
67 #if !defined(OPENSSL_NO_CT) && !defined(OPENSSL_NO_UNIT_TEST)
68
69 /* Used when declaring buffers to read text files into */
70 #define CT_TEST_MAX_FILE_SIZE 8096
71
72 typedef struct ct_test_fixture {
73     const char *test_case_name;
74     /* The CT log store to use during tests */
75     CTLOG_STORE* ctlog_store;
76     /* Set the following to test handling of SCTs in X509 certificates */
77     const char *certificate_file_path;
78     const char *issuer_file_path;
79     int expected_sct_count;
80     /* Set the following to test handling of SCTs in TLS format */
81     const uint8_t *tls_sct;
82     size_t tls_sct_len;
83     SCT *sct;
84     /*
85      * A file to load the expected SCT text from.
86      * This text will be compared to the actual text output during the test.
87      * A maximum of |CT_TEST_MAX_FILE_SIZE| bytes will be read of this file.
88      */
89     const char *sct_text_file_path;
90     /* Whether to test the validity of the SCT(s) */
91     int test_validity;
92
93 } CT_TEST_FIXTURE;
94
95 static CT_TEST_FIXTURE set_up(const char *const test_case_name)
96 {
97     CT_TEST_FIXTURE fixture;
98     int setup_ok = 1;
99     CTLOG_STORE *ctlog_store = CTLOG_STORE_new();
100
101     if (ctlog_store == NULL) {
102         setup_ok = 0;
103         fprintf(stderr, "Failed to create a new CT log store\n");
104         goto end;
105     }
106
107     if (CTLOG_STORE_load_default_file(ctlog_store) != 1) {
108         setup_ok = 0;
109         fprintf(stderr, "Failed to load CT log list\n");
110         goto end;
111     }
112
113     memset(&fixture, 0, sizeof(fixture));
114     fixture.test_case_name = test_case_name;
115     fixture.ctlog_store = ctlog_store;
116
117 end:
118     if (!setup_ok) {
119         exit(EXIT_FAILURE);
120     }
121     return fixture;
122 }
123
124 static void tear_down(CT_TEST_FIXTURE fixture)
125 {
126     CTLOG_STORE_free(fixture.ctlog_store);
127     SCT_free(fixture.sct);
128     ERR_print_errors_fp(stderr);
129 }
130
131 static X509 *load_pem_cert(const char *file)
132 {
133     BIO *cert_io = BIO_new_file(file, "r");
134     X509 *cert = NULL;
135
136     if (cert_io == NULL) goto end;
137
138     cert = PEM_read_bio_X509(cert_io, NULL, NULL, NULL);
139
140 end:
141     BIO_free(cert_io);
142     return cert;
143 }
144
145 static int read_text_file(const char *path, char *buffer, int buffer_length)
146 {
147     BIO *file = BIO_new_file(path, "r");
148     int result = -1;
149
150     if (file != NULL) {
151         result = BIO_read(file, buffer, buffer_length);
152         BIO_free(file);
153     }
154
155     return result;
156 }
157
158 static int compare_sct_printout(SCT *sct,
159     const char *expected_output)
160 {
161     BIO *text_buffer = NULL;
162     char *actual_output = NULL;
163     int result = 1;
164
165     text_buffer = BIO_new(BIO_s_mem());
166     if (text_buffer == NULL) {
167         fprintf(stderr, "Unable to allocate buffer\n");
168         goto end;
169     }
170
171     SCT_print(sct, text_buffer, 0);
172
173     /* Append null terminator because we're about to use the buffer contents
174     * as a string. */
175     if (BIO_write(text_buffer, "\0", 1) != 1) {
176         fprintf(stderr, "Failed to append null terminator to SCT text\n");
177         goto end;
178     }
179
180     BIO_get_mem_data(text_buffer, &actual_output);
181     result = strcmp(actual_output, expected_output);
182
183     if (result != 0) {
184         fprintf(stderr,
185             "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
186             expected_output, actual_output);
187     }
188
189 end:
190     BIO_free(text_buffer);
191     return result;
192 }
193
194 static int compare_extension_printout(X509_EXTENSION *extension,
195                                       const char *expected_output)
196 {
197     BIO *text_buffer = NULL;
198     char *actual_output = NULL;
199     int result = 1;
200
201     text_buffer = BIO_new(BIO_s_mem());
202     if (text_buffer == NULL) {
203         fprintf(stderr, "Unable to allocate buffer\n");
204         goto end;
205     }
206
207     if (!X509V3_EXT_print(text_buffer, extension, X509V3_EXT_DEFAULT, 0)) {
208         fprintf(stderr, "Failed to print extension\n");
209         goto end;
210     }
211
212     /* Append null terminator because we're about to use the buffer contents
213      * as a string. */
214     if (BIO_write(text_buffer, "\0", 1) != 1) {
215         fprintf(stderr, "Failed to append null terminator to extension text\n");
216         goto end;
217     }
218
219     BIO_get_mem_data(text_buffer, &actual_output);
220     result = strcmp(actual_output, expected_output);
221
222     if (result != 0) {
223         fprintf(stderr,
224                 "Expected SCT printout:\n%s\nActual SCT printout:\n%s\n",
225                 expected_output, actual_output);
226     }
227
228 end:
229     BIO_free(text_buffer);
230     return result;
231 }
232
233 static int execute_cert_test(CT_TEST_FIXTURE fixture)
234 {
235     int test_failed = 0;
236     X509 *cert = NULL, *issuer = NULL;
237     STACK_OF(SCT) *scts = NULL;
238     SCT *sct = NULL;
239     char expected_sct_text[CT_TEST_MAX_FILE_SIZE];
240     int sct_text_len = 0;
241     unsigned char *tls_sct = NULL;
242     size_t tls_sct_len = 0;
243     CT_POLICY_EVAL_CTX *ct_policy_ctx = CT_POLICY_EVAL_CTX_new();
244
245     if (fixture.sct_text_file_path != NULL) {
246         sct_text_len = read_text_file(
247             fixture.sct_text_file_path,
248             expected_sct_text,
249             CT_TEST_MAX_FILE_SIZE - 1);
250
251         if (sct_text_len < 0) {
252             test_failed = 1;
253             fprintf(stderr, "Test data file not found: %s\n",
254                 fixture.sct_text_file_path);
255             goto end;
256         }
257
258         expected_sct_text[sct_text_len] = '\0';
259     }
260
261     CT_POLICY_EVAL_CTX_set0_log_store(ct_policy_ctx, fixture.ctlog_store);
262
263     if (fixture.certificate_file_path != NULL) {
264         int sct_extension_index;
265         X509_EXTENSION *sct_extension = NULL;
266         cert = load_pem_cert(fixture.certificate_file_path);
267
268         if (cert == NULL) {
269             test_failed = 1;
270             fprintf(stderr, "Unable to load certificate: %s\n",
271                 fixture.certificate_file_path);
272             goto end;
273         }
274
275         CT_POLICY_EVAL_CTX_set0_cert(ct_policy_ctx, cert);
276
277         if (fixture.issuer_file_path != NULL) {
278             issuer = load_pem_cert(fixture.issuer_file_path);
279
280             if (issuer == NULL) {
281                 test_failed = 1;
282                 fprintf(stderr, "Unable to load issuer certificate: %s\n",
283                         fixture.issuer_file_path);
284                 goto end;
285             }
286
287             CT_POLICY_EVAL_CTX_set0_issuer(ct_policy_ctx, issuer);
288         }
289
290         sct_extension_index =
291                 X509_get_ext_by_NID(cert, NID_ct_precert_scts, -1);
292         sct_extension = X509_get_ext(cert, sct_extension_index);
293         if (fixture.expected_sct_count > 0) {
294             if (sct_extension == NULL) {
295                 test_failed = 1;
296                 fprintf(stderr, "SCT extension not found in: %s\n",
297                     fixture.certificate_file_path);
298                 goto end;
299             }
300
301             if (fixture.sct_text_file_path) {
302                 test_failed = compare_extension_printout(sct_extension,
303                                                     expected_sct_text);
304                 if (test_failed != 0)
305                     goto end;
306             }
307
308             if (fixture.test_validity) {
309                 int are_scts_validated = 0;
310                 scts = X509V3_EXT_d2i(sct_extension);
311                 SCT_LIST_set_source(scts, SCT_SOURCE_X509V3_EXTENSION);
312
313                 are_scts_validated = SCT_LIST_validate(scts, ct_policy_ctx);
314                 if (are_scts_validated < 0) {
315                     fprintf(stderr, "Error verifying SCTs\n");
316                     test_failed = 1;
317                 } else if (!are_scts_validated) {
318                     int invalid_sct_count = 0;
319                     int valid_sct_count = 0;
320                     int i;
321
322                     for (i = 0; i < sk_SCT_num(scts); ++i) {
323                         SCT *sct_i = sk_SCT_value(scts, i);
324                         switch (SCT_get_validation_status(sct_i)) {
325                         case SCT_VALIDATION_STATUS_VALID:
326                             ++valid_sct_count;
327                             break;
328                         case SCT_VALIDATION_STATUS_INVALID:
329                             ++invalid_sct_count;
330                             break;
331                         default:
332                             /* Ignore other validation statuses. */
333                             break;
334                         }
335                     }
336
337                     if (valid_sct_count != fixture.expected_sct_count) {
338                         int unverified_sct_count = sk_SCT_num(scts) -
339                                 invalid_sct_count - valid_sct_count;
340
341                         fprintf(stderr,
342                                 "%d SCTs failed verification\n"
343                                 "%d SCTs passed verification (%d expected)\n"
344                                 "%d SCTs were unverified\n",
345                                 invalid_sct_count,
346                                 valid_sct_count,
347                                 fixture.expected_sct_count,
348                                 unverified_sct_count);
349                     }
350                     test_failed = 1;
351                 }
352
353                 if (test_failed != 0)
354                     goto end;
355             }
356         } else if (sct_extension != NULL) {
357             test_failed = 1;
358             fprintf(stderr,
359                     "Expected no SCTs, but found SCT extension in: %s\n",
360                     fixture.certificate_file_path);
361             goto end;
362         }
363     }
364
365     if (fixture.tls_sct != NULL) {
366         const unsigned char *p = fixture.tls_sct;
367         if (o2i_SCT(&sct, &p, fixture.tls_sct_len) == NULL) {
368             test_failed = 1;
369             fprintf(stderr, "Failed to decode SCT from TLS format\n");
370             goto end;
371         }
372
373         if (fixture.sct_text_file_path) {
374             test_failed = compare_sct_printout(sct, expected_sct_text);
375             if (test_failed != 0)
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             test_failed = 1;
383             fprintf(stderr, "Failed to encode SCT into TLS format correctly\n");
384             goto end;
385         }
386
387         if (fixture.test_validity && cert != NULL) {
388             int is_sct_validated = SCT_validate(sct, ct_policy_ctx);
389             if (is_sct_validated < 0) {
390                 test_failed = 1;
391                 fprintf(stderr, "Error validating SCT\n");
392                 goto end;
393             } else if (!is_sct_validated) {
394                 test_failed = 1;
395                 fprintf(stderr, "SCT failed verification\n");
396                 goto end;
397             }
398         }
399     }
400
401 end:
402     X509_free(cert);
403     X509_free(issuer);
404     SCT_LIST_free(scts);
405     SCT_free(sct);
406     CT_POLICY_EVAL_CTX_free(ct_policy_ctx);
407     OPENSSL_free(tls_sct);
408     return test_failed;
409 }
410
411 #define SETUP_CT_TEST_FIXTURE() SETUP_TEST_FIXTURE(CT_TEST_FIXTURE, set_up)
412 #define EXECUTE_CT_TEST() EXECUTE_TEST(execute_cert_test, tear_down)
413
414 static int test_no_scts_in_certificate()
415 {
416     SETUP_CT_TEST_FIXTURE();
417     fixture.certificate_file_path = "certs/leaf.pem";
418     fixture.issuer_file_path = "certs/subinterCA.pem";
419     fixture.expected_sct_count = 0;
420     EXECUTE_CT_TEST();
421 }
422
423 static int test_one_sct_in_certificate()
424 {
425     SETUP_CT_TEST_FIXTURE();
426     fixture.certificate_file_path = "certs/embeddedSCTs1.pem";
427     fixture.issuer_file_path = "certs/embeddedSCTs1_issuer.pem";
428     fixture.expected_sct_count = 1;
429     fixture.sct_text_file_path = "certs/embeddedSCTs1.sct";
430     EXECUTE_CT_TEST();
431 }
432
433 static int test_multiple_scts_in_certificate()
434 {
435     SETUP_CT_TEST_FIXTURE();
436     fixture.certificate_file_path = "certs/embeddedSCTs3.pem";
437     fixture.issuer_file_path = "certs/embeddedSCTs3_issuer.pem";
438     fixture.expected_sct_count = 3;
439     fixture.sct_text_file_path = "certs/embeddedSCTs3.sct";
440     EXECUTE_CT_TEST();
441 }
442
443 static int test_verify_one_sct()
444 {
445     SETUP_CT_TEST_FIXTURE();
446     fixture.certificate_file_path = "certs/embeddedSCTs1.pem";
447     fixture.issuer_file_path = "certs/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.certificate_file_path = "certs/embeddedSCTs3.pem";
457     fixture.issuer_file_path = "certs/embeddedSCTs3_issuer.pem";
458     fixture.expected_sct_count = 3;
459     fixture.test_validity = 1;
460     EXECUTE_CT_TEST();
461 }
462
463 static int test_decode_tls_sct()
464 {
465     SETUP_CT_TEST_FIXTURE();
466     fixture.tls_sct = (unsigned char *)
467         "\x00" /* version */
468         /* log ID */
469         "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
470         "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64"
471         "\x00\x00\x01\x3D\xDB\x27\xDF\x93" /* timestamp */
472         "\x00\x00" /* extensions length */
473         "" /* extensions */
474         "\x04\x03" /* hash and signature algorithms */
475         "\x00\x47" /* signature length */
476         "\x30\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE\x1F\xD6"
477         "\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3\xE5\xE2"
478         "\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5\xE8\xAB"
479         "\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51\x9D\x89"
480         "\xED\xBF\x08"; /* signature */
481     fixture.tls_sct_len = 118;
482     fixture.sct_text_file_path = "ct/tls1.sct";
483     EXECUTE_CT_TEST();
484 }
485
486 static int test_encode_tls_sct()
487 {
488     SETUP_CT_TEST_FIXTURE();
489
490     SCT *sct = SCT_new();
491     SCT_set_version(sct, 0);
492     SCT_set1_log_id(sct, (unsigned char *)
493         "\xDF\x1C\x2E\xC1\x15\x00\x94\x52\x47\xA9\x61\x68\x32\x5D\xDC\x5C\x79"
494         "\x59\xE8\xF7\xC6\xD3\x88\xFC\x00\x2E\x0B\xBD\x3F\x74\xD7\x64", 32);
495     SCT_set_timestamp(sct, 1);
496     SCT_set1_extensions(sct, (unsigned char *)"", 0);
497     SCT_set_signature_nid(sct, NID_ecdsa_with_SHA256);
498     SCT_set1_signature(sct, (unsigned char *)
499         "\x45\x02\x20\x48\x2F\x67\x51\xAF\x35\xDB\xA6\x54\x36\xBE"
500         "\x1F\xD6\x64\x0F\x3D\xBF\x9A\x41\x42\x94\x95\x92\x45\x30\x28\x8F\xA3"
501         "\xE5\xE2\x3E\x06\x02\x21\x00\xE4\xED\xC0\xDB\x3A\xC5\x72\xB1\xE2\xF5"
502         "\xE8\xAB\x6A\x68\x06\x53\x98\x7D\xCF\x41\x02\x7D\xFE\xFF\xA1\x05\x51"
503         "\x9D\x89\xED\xBF\x08", 71);
504     fixture.sct = sct;
505     fixture.sct_text_file_path = "ct/tls1.sct";
506     EXECUTE_CT_TEST();
507 }
508
509 int main(int argc, char *argv[])
510 {
511     int result = 0;
512
513     ADD_TEST(test_no_scts_in_certificate);
514     ADD_TEST(test_one_sct_in_certificate);
515     ADD_TEST(test_multiple_scts_in_certificate);
516     ADD_TEST(test_verify_one_sct);
517     ADD_TEST(test_verify_multiple_scts);
518     ADD_TEST(test_decode_tls_sct);
519     ADD_TEST(test_encode_tls_sct);
520
521     result = run_tests(argv[0]);
522     ERR_print_errors_fp(stderr);
523
524     return result;
525 }
526
527 #else /* OPENSSL_NO_CT */
528
529 int main(int argc, char* argv[])
530 {
531     return EXIT_SUCCESS;
532 }
533
534 #endif /* OPENSSL_NO_CT */