test/recipes/80-test_ssl_new.t

   1 #! /usr/bin/env perl
   2 # Copyright 2015-2021 The OpenSSL Project Authors. All Rights Reserved.
   3 #
   4 # Licensed under the Apache License 2.0 (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 # For manually running these tests, set specific environment variables like this:
  10 # CTLOG_FILE=test/ct/log_list.cnf
  11 # TEST_CERTS_DIR=test/certs
  12 # For details on the environment variables needed, see test/README.ssltest.md
  13
  14 use strict;
  15 use warnings;
  16
  17 use File::Basename;
  18 use File::Compare qw/compare_text/;
  19 use OpenSSL::Glob;
  20 use OpenSSL::Test qw/:DEFAULT srctop_dir srctop_file bldtop_file bldtop_dir/;
  21 use OpenSSL::Test::Utils qw/disabled alldisabled available_protocols/;
  22
  23 BEGIN {
  24 setup("test_ssl_new");
  25 }
  26
  27 use lib srctop_dir('Configurations');
  28 use lib bldtop_dir('.');
  29
  30 my $no_fips = disabled('fips') || ($ENV{NO_FIPS} // 0);
  31
  32 $ENV{TEST_CERTS_DIR} = srctop_dir("test", "certs");
  33
  34 my @conf_srcs = ();
  35 if (defined $ENV{SSL_TESTS}) {
  36     my @conf_list = split(' ', $ENV{SSL_TESTS});
  37     foreach my $conf_file (@conf_list) {
  38         push (@conf_srcs, glob(srctop_file("test", "ssl-tests", $conf_file)));
  39     }
  40     plan tests => scalar @conf_srcs;
  41 } else {
  42     @conf_srcs = glob(srctop_file("test", "ssl-tests", "*.cnf.in"));
  43     # We hard-code the number of tests to double-check that the globbing above
  44     # finds all files as expected.
  45     plan tests => 32;
  46 }
  47 map { s/;.*// } @conf_srcs if $^O eq "VMS";
  48 my @conf_files = map { basename($_, ".in") } @conf_srcs;
  49 map { s/\^// } @conf_files if $^O eq "VMS";
  50
  51 # Some test results depend on the configuration of enabled protocols. We only
  52 # verify generated sources in the default configuration.
  53 my $is_default_tls = (disabled("ssl3") && !disabled("tls1") &&
  54                       !disabled("tls1_1") && !disabled("tls1_2") &&
  55                       !disabled("tls1_3") && (!disabled("ec") || !disabled("dh")));
  56
  57 my $is_default_dtls = (!disabled("dtls1") && !disabled("dtls1_2"));
  58
  59 my @all_pre_tls1_3 = ("ssl3", "tls1", "tls1_1", "tls1_2");
  60 my $no_tls = alldisabled(available_protocols("tls"));
  61 my $no_tls_below1_3 = $no_tls || (disabled("tls1_2") && !disabled("tls1_3"));
  62 if (!$no_tls && $no_tls_below1_3 && disabled("ec") && disabled("dh")) {
  63   $no_tls = 1;
  64 }
  65 my $no_pre_tls1_3 = alldisabled(@all_pre_tls1_3);
  66 my $no_dtls = alldisabled(available_protocols("dtls"));
  67 my $no_quic = disabled("quic");
  68 my $no_npn = disabled("nextprotoneg");
  69 my $no_ct = disabled("ct");
  70 my $no_ec = disabled("ec");
  71 my $no_dh = disabled("dh");
  72 my $no_dsa = disabled("dsa");
  73 my $no_ec2m = disabled("ec2m");
  74 my $no_ocsp = disabled("ocsp");
  75
  76 # Add your test here if the test conf.in generates test cases and/or
  77 # expectations dynamically based on the OpenSSL compile-time config.
  78 my %conf_dependent_tests = (
  79   "02-protocol-version.cnf" => !$is_default_tls,
  80   "04-client_auth.cnf" => !$is_default_tls || !$is_default_dtls
  81                            || !disabled("sctp"),
  82   "05-sni.cnf" => disabled("tls1_1"),
  83   "07-dtls-protocol-version.cnf" => !$is_default_dtls || !disabled("sctp"),
  84   "10-resumption.cnf" => !$is_default_tls || $no_ec,
  85   "11-dtls_resumption.cnf" => !$is_default_dtls || !disabled("sctp"),
  86   "16-dtls-certstatus.cnf" => !$is_default_dtls || !disabled("sctp"),
  87   "17-renegotiate.cnf" => disabled("tls1_2"),
  88   "18-dtls-renegotiate.cnf" => disabled("dtls1_2") || !disabled("sctp"),
  89   "19-mac-then-encrypt.cnf" => !$is_default_tls,
  90   "20-cert-select.cnf" => !$is_default_tls || $no_dh || $no_dsa,
  91   "22-compression.cnf" => !$is_default_tls,
  92   "25-cipher.cnf" => disabled("poly1305") || disabled("chacha"),
  93   "27-ticket-appdata.cnf" => !$is_default_tls,
  94   "28-seclevel.cnf" => disabled("tls1_2") || $no_ec,
  95   "30-extended-master-secret.cnf" => disabled("tls1_2"),
  96   "32-compressed-certificate.cnf" => disabled("comp") || disabled("tls1_3"),
  97 );
  98
  99 # Add your test here if it should be skipped for some compile-time
 100 # configurations. Default is $no_tls but some tests have different skip
 101 # conditions.
 102 my %skip = (
 103   "06-sni-ticket.cnf" => $no_tls_below1_3,
 104   "07-dtls-protocol-version.cnf" => $no_dtls,
 105   "08-npn.cnf" => (disabled("tls1") && disabled("tls1_1")
 106                     && disabled("tls1_2")) || $no_npn,
 107   "10-resumption.cnf" => disabled("tls1_1") || disabled("tls1_2"),
 108   "11-dtls_resumption.cnf" => disabled("dtls1") || disabled("dtls1_2"),
 109   "12-ct.cnf" => $no_tls || $no_ct || $no_ec,
 110   # We could run some of these tests without TLS 1.2 if we had a per-test
 111   # disable instruction but that's a bizarre configuration not worth
 112   # special-casing for.
 113   # TODO(TLS 1.3): We should review this once we have TLS 1.3.
 114   "13-fragmentation.cnf" => disabled("tls1_2"),
 115   "14-curves.cnf" => disabled("tls1_2") || disabled("tls1_3")
 116                      || $no_ec || $no_ec2m,
 117   "15-certstatus.cnf" => $no_tls || $no_ocsp,
 118   "16-dtls-certstatus.cnf" => $no_dtls || $no_ocsp,
 119   "17-renegotiate.cnf" => $no_tls_below1_3,
 120   "18-dtls-renegotiate.cnf" => $no_dtls,
 121   "19-mac-then-encrypt.cnf" => $no_pre_tls1_3,
 122   "20-cert-select.cnf" => disabled("tls1_2") || $no_ec,
 123   "21-key-update.cnf" => disabled("tls1_3") || ($no_ec && $no_dh),
 124   "22-compression.cnf" => disabled("zlib") || $no_tls,
 125   "23-srp.cnf" => (disabled("tls1") && disabled ("tls1_1")
 126                     && disabled("tls1_2")) || disabled("srp"),
 127   "24-padding.cnf" => disabled("tls1_3") || ($no_ec && $no_dh),
 128   "25-cipher.cnf" => disabled("ec") || disabled("tls1_2"),
 129   "26-tls13_client_auth.cnf" => disabled("tls1_3") || ($no_ec && $no_dh),
 130   "29-dtls-sctp-label-bug.cnf" => disabled("sctp") || disabled("sock"),
 131   # TODO(QUIC): Temporarily disabled during finalization of front-end API.
 132   "31-quic.cnf" => 1 || $no_quic || $no_ec,
 133   "32-compressed-certificate.cnf" => disabled("comp") || disabled("tls1_3"),
 134 );
 135
 136 foreach my $conf (@conf_files) {
 137     subtest "Test configuration $conf" => sub {
 138         plan tests => 6 + ($no_fips ? 0 : 3);
 139         test_conf($conf,
 140                   $conf_dependent_tests{$conf} || $^O eq "VMS" ?  0 : 1,
 141                   defined($skip{$conf}) ? $skip{$conf} : $no_tls,
 142                   "none");
 143         test_conf($conf,
 144                   0,
 145                   defined($skip{$conf}) ? $skip{$conf} : $no_tls,
 146                   "default");
 147         test_conf($conf,
 148                   0,
 149                   defined($skip{$conf}) ? $skip{$conf} : $no_tls,
 150                   "fips") unless $no_fips;
 151     }
 152 }
 153
 154 sub test_conf {
 155     my ($conf, $check_source, $skip, $provider) = @_;
 156
 157     my $conf_file = srctop_file("test", "ssl-tests", $conf);
 158     my $input_file = $conf_file . ".in";
 159     my $output_file = $conf . "." . $provider;
 160     my $run_test = 1;
 161
 162   SKIP: {
 163       # "Test" 1. Generate the source.
 164       skip 'failure', 2 unless
 165         ok(run(perltest(["generate_ssl_tests.pl", $input_file, $provider],
 166                         interpreter_args => [ "-I", srctop_dir("util", "perl")],
 167                         stdout => $output_file)),
 168            "Getting output from generate_ssl_tests.pl.");
 169
 170     SKIP: {
 171         # Test 2. Compare against existing output in test/ssl-tests/
 172         skip "Skipping generated source test for $conf", 1
 173           if !$check_source;
 174
 175         $run_test = is(cmp_text($output_file, $conf_file), 0,
 176                        "Comparing generated $output_file with $conf_file.");
 177       }
 178
 179       # Test 3. Run the test.
 180       skip "No tests available; skipping tests", 1 if $skip;
 181       skip "Stale sources; skipping tests", 1 if !$run_test;
 182
 183       my $msg = "running CTLOG_FILE=test/ct/log_list.cnf". # $ENV{CTLOG_FILE}.
 184           " TEST_CERTS_DIR=test/certs". # $ENV{TEST_CERTS_DIR}.
 185           " test/ssl_test test/ssl-tests/$conf $provider";
 186       if ($provider eq "fips") {
 187           ok(run(test(["ssl_test", $output_file, $provider,
 188                        srctop_file("test", "fips-and-base.cnf")])), $msg);
 189       } else {
 190           ok(run(test(["ssl_test", $output_file, $provider])), $msg);
 191       }
 192     }
 193 }
 194
 195 sub cmp_text {
 196     return compare_text(@_, sub {
 197         $_[0] =~ s/\R//g;
 198         $_[1] =~ s/\R//g;
 199         return $_[0] ne $_[1];
 200     });
 201 }