1#! /usr/bin/env perl
2# Copyright 2015-2019 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
10use strict;
11use warnings;
12
13use File::Basename;
14use File::Compare qw/compare_text/;
15use OpenSSL::Glob;
16use OpenSSL::Test qw/:DEFAULT srctop_dir srctop_file/;
17use OpenSSL::Test::Utils qw/disabled alldisabled available_protocols/;
18
19setup("test_ssl_new");
20
21$ENV{TEST_CERTS_DIR} = srctop_dir("test", "certs");
22$ENV{CTLOG_FILE} = srctop_file("test", "ct", "log_list.conf");
23
24my @conf_srcs =  glob(srctop_file("test", "ssl-tests", "*.conf.in"));
25map { s/;.*// } @conf_srcs if $^O eq "VMS";
26my @conf_files = map { basename($_, ".in") } @conf_srcs;
27map { s/\^// } @conf_files if $^O eq "VMS";
28
29# We hard-code the number of tests to double-check that the globbing above
30# finds all files as expected.
31plan tests => 29;  # = scalar @conf_srcs
32
33# Some test results depend on the configuration of enabled protocols. We only
34# verify generated sources in the default configuration.
35my $is_default_tls = (disabled("ssl3") && !disabled("tls1") &&
36                      !disabled("tls1_1") && !disabled("tls1_2") &&
37                      !disabled("tls1_3"));
38
39my $is_default_dtls = (!disabled("dtls1") && !disabled("dtls1_2"));
40
41my @all_pre_tls1_3 = ("ssl3", "tls1", "tls1_1", "tls1_2");
42my $no_tls = alldisabled(available_protocols("tls"));
43my $no_tls_below1_3 = $no_tls || (disabled("tls1_2") && !disabled("tls1_3"));
44my $no_pre_tls1_3 = alldisabled(@all_pre_tls1_3);
45my $no_dtls = alldisabled(available_protocols("dtls"));
46my $no_npn = disabled("nextprotoneg");
47my $no_ct = disabled("ct");
48my $no_ec = disabled("ec");
49my $no_dh = disabled("dh");
50my $no_dsa = disabled("dsa");
51my $no_ec2m = disabled("ec2m");
52my $no_ocsp = disabled("ocsp");
53
54# Add your test here if the test conf.in generates test cases and/or
55# expectations dynamically based on the OpenSSL compile-time config.
56my %conf_dependent_tests = (
57  "02-protocol-version.conf" => !$is_default_tls,
58  "04-client_auth.conf" => !$is_default_tls || !$is_default_dtls
59                           || !disabled("sctp"),
60  "05-sni.conf" => disabled("tls1_1"),
61  "07-dtls-protocol-version.conf" => !$is_default_dtls || !disabled("sctp"),
62  "10-resumption.conf" => !$is_default_tls,
63  "11-dtls_resumption.conf" => !$is_default_dtls || !disabled("sctp"),
64  "16-dtls-certstatus.conf" => !$is_default_dtls || !disabled("sctp"),
65  "17-renegotiate.conf" => disabled("tls1_2"),
66  "18-dtls-renegotiate.conf" => disabled("dtls1_2") || !disabled("sctp"),
67  "19-mac-then-encrypt.conf" => !$is_default_tls,
68  "20-cert-select.conf" => !$is_default_tls || $no_dh || $no_dsa,
69  "22-compression.conf" => !$is_default_tls,
70  "25-cipher.conf" => disabled("poly1305") || disabled("chacha"),
71  "27-ticket-appdata.conf" => !$is_default_tls,
72  "28-seclevel.conf" => disabled("tls1_2") || $no_ec,
73);
74
75# Add your test here if it should be skipped for some compile-time
76# configurations. Default is $no_tls but some tests have different skip
77# conditions.
78my %skip = (
79  "06-sni-ticket.conf" => $no_tls_below1_3,
80  "07-dtls-protocol-version.conf" => $no_dtls,
81  "08-npn.conf" => (disabled("tls1") && disabled("tls1_1")
82                    && disabled("tls1_2")) || $no_npn,
83  "10-resumption.conf" => disabled("tls1_1") || disabled("tls1_2"),
84  "11-dtls_resumption.conf" => disabled("dtls1") || disabled("dtls1_2"),
85  "12-ct.conf" => $no_tls || $no_ct || $no_ec,
86  # We could run some of these tests without TLS 1.2 if we had a per-test
87  # disable instruction but that's a bizarre configuration not worth
88  # special-casing for.
89  # TODO(TLS 1.3): We should review this once we have TLS 1.3.
90  "13-fragmentation.conf" => disabled("tls1_2"),
91  "14-curves.conf" => disabled("tls1_2") || $no_ec || $no_ec2m,
92  "15-certstatus.conf" => $no_tls || $no_ocsp,
93  "16-dtls-certstatus.conf" => $no_dtls || $no_ocsp,
94  "17-renegotiate.conf" => $no_tls_below1_3,
95  "18-dtls-renegotiate.conf" => $no_dtls,
96  "19-mac-then-encrypt.conf" => $no_pre_tls1_3,
97  "20-cert-select.conf" => disabled("tls1_2") || $no_ec,
98  "21-key-update.conf" => disabled("tls1_3"),
99  "22-compression.conf" => disabled("zlib") || $no_tls,
100  "23-srp.conf" => (disabled("tls1") && disabled ("tls1_1")
101                    && disabled("tls1_2")) || disabled("srp"),
102  "24-padding.conf" => disabled("tls1_3"),
103  "25-cipher.conf" => disabled("ec") || disabled("tls1_2"),
104  "26-tls13_client_auth.conf" => disabled("tls1_3"),
105  "29-dtls-sctp-label-bug.conf" => disabled("sctp") || disabled("sock"),
106);
107
108foreach my $conf (@conf_files) {
109    subtest "Test configuration $conf" => sub {
110        test_conf($conf,
111                  $conf_dependent_tests{$conf} || $^O eq "VMS" ?  0 : 1,
112                  defined($skip{$conf}) ? $skip{$conf} : $no_tls);
113    }
114}
115
116sub test_conf {
117    plan tests => 3;
118
119    my ($conf, $check_source, $skip) = @_;
120
121    my $conf_file = srctop_file("test", "ssl-tests", $conf);
122    my $tmp_file = "${conf}.$$.tmp";
123    my $run_test = 1;
124
125  SKIP: {
126      # "Test" 1. Generate the source.
127      my $input_file = $conf_file . ".in";
128
129      skip 'failure', 2 unless
130        ok(run(perltest(["generate_ssl_tests.pl", $input_file],
131                        interpreter_args => [ "-I", srctop_dir("util", "perl")],
132                        stdout => $tmp_file)),
133           "Getting output from generate_ssl_tests.pl.");
134
135    SKIP: {
136        # Test 2. Compare against existing output in test/ssl_tests.conf.
137        skip "Skipping generated source test for $conf", 1
138          if !$check_source;
139
140        $run_test = is(cmp_text($tmp_file, $conf_file), 0,
141                       "Comparing generated sources.");
142      }
143
144      # Test 3. Run the test.
145      skip "No tests available; skipping tests", 1 if $skip;
146      skip "Stale sources; skipping tests", 1 if !$run_test;
147
148      ok(run(test(["ssl_test", $tmp_file])), "running ssl_test $conf");
149    }
150
151    unlink glob $tmp_file;
152}
153
154sub cmp_text {
155    return compare_text(@_, sub {
156        $_[0] =~ s/\R//g;
157        $_[1] =~ s/\R//g;
158        return $_[0] ne $_[1];
159    });
160}
161