test/recipes/70-test_tls13kexmodes.t

   1 #! /usr/bin/env perl
   2 # Copyright 2017 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 use strict;
  10 use OpenSSL::Test qw/:DEFAULT cmdstr srctop_file srctop_dir bldtop_dir/;
  11 use OpenSSL::Test::Utils;
  12 use File::Temp qw(tempfile);
  13 use TLSProxy::Proxy;
  14 use checkhandshake qw(checkhandshake @handmessages @extensions);
  15
  16 my $test_name = "test_tls13kexmodes";
  17 setup($test_name);
  18
  19 plan skip_all => "TLSProxy isn't usable on $^O"
  20     if $^O =~ /^(VMS|MSWin32)$/;
  21
  22 plan skip_all => "$test_name needs the dynamic engine feature enabled"
  23     if disabled("engine") || disabled("dynamic-engine");
  24
  25 plan skip_all => "$test_name needs the sock feature enabled"
  26     if disabled("sock");
  27
  28 plan skip_all => "$test_name needs TLSv1.3 enabled"
  29     if disabled("tls1_3");
  30
  31 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
  32 $ENV{CTLOG_FILE} = srctop_file("test", "ct", "log_list.conf");
  33
  34
  35 @handmessages = (
  36     [TLSProxy::Message::MT_CLIENT_HELLO,
  37         checkhandshake::ALL_HANDSHAKES],
  38     [TLSProxy::Message::MT_HELLO_RETRY_REQUEST,
  39         checkhandshake::HRR_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE],
  40     [TLSProxy::Message::MT_CLIENT_HELLO,
  41         checkhandshake::HRR_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE],
  42     [TLSProxy::Message::MT_SERVER_HELLO,
  43         checkhandshake::ALL_HANDSHAKES],
  44     [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS,
  45         checkhandshake::ALL_HANDSHAKES],
  46     [TLSProxy::Message::MT_CERTIFICATE_REQUEST,
  47         checkhandshake::CLIENT_AUTH_HANDSHAKE],
  48     [TLSProxy::Message::MT_CERTIFICATE,
  49         checkhandshake::ALL_HANDSHAKES & ~(checkhandshake::RESUME_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE)],
  50     [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
  51         checkhandshake::ALL_HANDSHAKES & ~(checkhandshake::RESUME_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE)],
  52     [TLSProxy::Message::MT_FINISHED,
  53         checkhandshake::ALL_HANDSHAKES],
  54     [TLSProxy::Message::MT_CERTIFICATE,
  55         checkhandshake::CLIENT_AUTH_HANDSHAKE],
  56     [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
  57         checkhandshake::CLIENT_AUTH_HANDSHAKE],
  58     [TLSProxy::Message::MT_FINISHED,
  59         checkhandshake::ALL_HANDSHAKES],
  60     [0, 0]
  61 );
  62
  63 @extensions = (
  64     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
  65         checkhandshake::SERVER_NAME_CLI_EXTENSION],
  66     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
  67         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
  68     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
  69         checkhandshake::DEFAULT_EXTENSIONS],
  70     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
  71         checkhandshake::DEFAULT_EXTENSIONS],
  72     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
  73         checkhandshake::DEFAULT_EXTENSIONS],
  74     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
  75         checkhandshake::ALPN_CLI_EXTENSION],
  76     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
  77         checkhandshake::SCT_CLI_EXTENSION],
  78     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
  79         checkhandshake::DEFAULT_EXTENSIONS],
  80     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
  81         checkhandshake::DEFAULT_EXTENSIONS],
  82     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
  83         checkhandshake::DEFAULT_EXTENSIONS],
  84     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
  85         checkhandshake::DEFAULT_EXTENSIONS],
  86     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
  87         checkhandshake::DEFAULT_EXTENSIONS],
  88     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK_KEX_MODES,
  89         checkhandshake::PSK_KEX_MODES_EXTENSION],
  90     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK,
  91         checkhandshake::PSK_CLI_EXTENSION],
  92
  93     [TLSProxy::Message::MT_HELLO_RETRY_REQUEST, TLSProxy::Message::EXT_KEY_SHARE,
  94         checkhandshake::KEY_SHARE_HRR_EXTENSION],
  95
  96     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
  97         checkhandshake::SERVER_NAME_CLI_EXTENSION],
  98     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
  99         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
 100     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
 101         checkhandshake::DEFAULT_EXTENSIONS],
 102     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
 103         checkhandshake::DEFAULT_EXTENSIONS],
 104     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
 105         checkhandshake::DEFAULT_EXTENSIONS],
 106     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
 107         checkhandshake::ALPN_CLI_EXTENSION],
 108     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
 109         checkhandshake::SCT_CLI_EXTENSION],
 110     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
 111         checkhandshake::DEFAULT_EXTENSIONS],
 112     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
 113         checkhandshake::DEFAULT_EXTENSIONS],
 114     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
 115         checkhandshake::DEFAULT_EXTENSIONS],
 116     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
 117         checkhandshake::DEFAULT_EXTENSIONS],
 118     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
 119         checkhandshake::DEFAULT_EXTENSIONS],
 120     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK_KEX_MODES,
 121         checkhandshake::PSK_KEX_MODES_EXTENSION],
 122     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK,
 123         checkhandshake::PSK_CLI_EXTENSION],
 124
 125     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
 126         checkhandshake::KEY_SHARE_SRV_EXTENSION],
 127     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_PSK,
 128         checkhandshake::PSK_SRV_EXTENSION],
 129
 130     [TLSProxy::Message::MT_CERTIFICATE, TLSProxy::Message::EXT_STATUS_REQUEST,
 131         checkhandshake::STATUS_REQUEST_SRV_EXTENSION],
 132     [0,0,0]
 133 );
 134
 135 use constant {
 136     DELETE_EXTENSION => 0,
 137     EMPTY_EXTENSION => 1,
 138     NON_DHE_KEX_MODE_ONLY => 2,
 139     DHE_KEX_MODE_ONLY => 3,
 140     UNKNOWN_KEX_MODES => 4,
 141     BOTH_KEX_MODES => 5
 142 };
 143
 144 my $proxy = TLSProxy::Proxy->new(
 145     undef,
 146     cmdstr(app(["openssl"]), display => 1),
 147     srctop_file("apps", "server.pem"),
 148     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
 149 );
 150
 151 #Test 1: First get a session
 152 (undef, my $session) = tempfile();
 153 $proxy->clientflags("-sess_out ".$session);
 154 $proxy->serverflags("-servername localhost");
 155 $proxy->sessionfile($session);
 156 $proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
 157 plan tests => 11;
 158 ok(TLSProxy::Message->success(), "Initial connection");
 159
 160 #Test 2: Attempt a resume with no kex modes extension. Should not resume
 161 $proxy->clear();
 162 $proxy->clientflags("-sess_in ".$session);
 163 my $testtype = DELETE_EXTENSION;
 164 $proxy->filter(\&modify_kex_modes_filter);
 165 $proxy->start();
 166 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 167                checkhandshake::DEFAULT_EXTENSIONS
 168                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 169                | checkhandshake::PSK_CLI_EXTENSION,
 170                "Resume with no kex modes");
 171
 172 #Test 3: Attempt a resume with empty kex modes extension. Should fail (empty
 173 #        extension is invalid)
 174 $proxy->clear();
 175 $proxy->clientflags("-sess_in ".$session);
 176 $testtype = EMPTY_EXTENSION;
 177 $proxy->start();
 178 ok(TLSProxy::Message->fail(), "Resume with empty kex modes");
 179
 180 #Test 4: Attempt a resume with non-dhe kex mode only. Should resume without a
 181 #        key_share
 182 $proxy->clear();
 183 $proxy->clientflags("-allow_no_dhe_kex -sess_in ".$session);
 184 $proxy->serverflags("-allow_no_dhe_kex");
 185 $testtype = NON_DHE_KEX_MODE_ONLY;
 186 $proxy->start();
 187 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 188                checkhandshake::DEFAULT_EXTENSIONS
 189                | checkhandshake::PSK_KEX_MODES_EXTENSION
 190                | checkhandshake::PSK_CLI_EXTENSION
 191                | checkhandshake::PSK_SRV_EXTENSION,
 192                "Resume with non-dhe kex mode");
 193
 194 #Test 5: Attempt a resume with dhe kex mode only. Should resume with a key_share
 195 $proxy->clear();
 196 $proxy->clientflags("-sess_in ".$session);
 197 $testtype = DHE_KEX_MODE_ONLY;
 198 $proxy->start();
 199 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 200                checkhandshake::DEFAULT_EXTENSIONS
 201                | checkhandshake::PSK_KEX_MODES_EXTENSION
 202                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 203                | checkhandshake::PSK_CLI_EXTENSION
 204                | checkhandshake::PSK_SRV_EXTENSION,
 205                "Resume with non-dhe kex mode");
 206
 207 #Test 6: Attempt a resume with only unrecognised kex modes. Should not resume
 208 $proxy->clear();
 209 $proxy->clientflags("-sess_in ".$session);
 210 $testtype = UNKNOWN_KEX_MODES;
 211 $proxy->start();
 212 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 213                checkhandshake::DEFAULT_EXTENSIONS
 214                | checkhandshake::PSK_KEX_MODES_EXTENSION
 215                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 216                | checkhandshake::PSK_CLI_EXTENSION,
 217                "Resume with empty kex modes");
 218
 219 #Test 7: Attempt a resume with both non-dhe and dhe kex mode. Should resume with
 220 #        a key_share
 221 $proxy->clear();
 222 $proxy->clientflags("-sess_in ".$session);
 223 $testtype = BOTH_KEX_MODES;
 224 $proxy->start();
 225 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 226                checkhandshake::DEFAULT_EXTENSIONS
 227                | checkhandshake::PSK_KEX_MODES_EXTENSION
 228                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 229                | checkhandshake::PSK_CLI_EXTENSION
 230                | checkhandshake::PSK_SRV_EXTENSION,
 231                "Resume with non-dhe kex mode");
 232
 233 #Test 8: Attempt a resume with both non-dhe and dhe kex mode, but unacceptable
 234 #        initial key_share. Should resume with a key_share following an HRR
 235 $proxy->clear();
 236 $proxy->clientflags("-sess_in ".$session);
 237 $proxy->serverflags("-curves P-256");
 238 $testtype = BOTH_KEX_MODES;
 239 $proxy->start();
 240 checkhandshake($proxy, checkhandshake::HRR_RESUME_HANDSHAKE,
 241                checkhandshake::DEFAULT_EXTENSIONS
 242                | checkhandshake::PSK_KEX_MODES_EXTENSION
 243                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 244                | checkhandshake::KEY_SHARE_HRR_EXTENSION
 245                | checkhandshake::PSK_CLI_EXTENSION
 246                | checkhandshake::PSK_SRV_EXTENSION,
 247                "Resume with both kex modes and HRR");
 248
 249 #Test 9: Attempt a resume with dhe kex mode only and an unacceptable initial
 250 #        key_share. Should resume with a key_share following an HRR
 251 $proxy->clear();
 252 $proxy->clientflags("-sess_in ".$session);
 253 $proxy->serverflags("-curves P-256");
 254 $testtype = DHE_KEX_MODE_ONLY;
 255 $proxy->start();
 256 checkhandshake($proxy, checkhandshake::HRR_RESUME_HANDSHAKE,
 257                checkhandshake::DEFAULT_EXTENSIONS
 258                | checkhandshake::PSK_KEX_MODES_EXTENSION
 259                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 260                | checkhandshake::KEY_SHARE_HRR_EXTENSION
 261                | checkhandshake::PSK_CLI_EXTENSION
 262                | checkhandshake::PSK_SRV_EXTENSION,
 263                "Resume with dhe kex mode and HRR");
 264
 265 #Test 10: Attempt a resume with both non-dhe and dhe kex mode, unacceptable
 266 #         initial key_share and no overlapping groups. Should resume without a
 267 #         key_share
 268 $proxy->clear();
 269 $proxy->clientflags("-allow_no_dhe_kex -curves P-384 -sess_in ".$session);
 270 $proxy->serverflags("-allow_no_dhe_kex -curves P-256");
 271 $testtype = BOTH_KEX_MODES;
 272 $proxy->start();
 273 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 274                checkhandshake::DEFAULT_EXTENSIONS
 275                | checkhandshake::PSK_KEX_MODES_EXTENSION
 276                | checkhandshake::PSK_CLI_EXTENSION
 277                | checkhandshake::PSK_SRV_EXTENSION,
 278                "Resume with both kex modes, no overlapping groups");
 279
 280 #Test 11: Attempt a resume with dhe kex mode only, unacceptable
 281 #         initial key_share and no overlapping groups. Should fail
 282 $proxy->clear();
 283 $proxy->clientflags("-curves P-384 -sess_in ".$session);
 284 $proxy->serverflags("-curves P-256");
 285 $testtype = DHE_KEX_MODE_ONLY;
 286 $proxy->start();
 287 ok(TLSProxy::Message->fail(), "Resume with dhe kex mode, no overlapping groups");
 288
 289 unlink $session;
 290
 291 sub modify_kex_modes_filter
 292 {
 293     my $proxy = shift;
 294
 295     # We're only interested in the initial ClientHello
 296     return if ($proxy->flight != 0);
 297
 298     foreach my $message (@{$proxy->message_list}) {
 299         if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
 300             my $ext;
 301
 302             if ($testtype == EMPTY_EXTENSION) {
 303                 $ext = pack "C",
 304                     0x00;       #List length
 305             } elsif ($testtype == NON_DHE_KEX_MODE_ONLY) {
 306                 $ext = pack "C2",
 307                     0x01,       #List length
 308                     0x00;       #psk_ke
 309             } elsif ($testtype == DHE_KEX_MODE_ONLY) {
 310                 $ext = pack "C2",
 311                     0x01,       #List length
 312                     0x01;       #psk_dhe_ke
 313             } elsif ($testtype == UNKNOWN_KEX_MODES) {
 314                 $ext = pack "C3",
 315                     0x02,       #List length
 316                     0xfe,       #unknown
 317                     0xff;       #unknown
 318             } elsif ($testtype == BOTH_KEX_MODES) {
 319                 #We deliberately list psk_ke first...should still use psk_dhe_ke
 320                 $ext = pack "C3",
 321                     0x02,       #List length
 322                     0x00,       #psk_ke
 323                     0x01;       #psk_dhe_ke
 324             }
 325
 326             if ($testtype == DELETE_EXTENSION) {
 327                 $message->delete_extension(
 328                     TLSProxy::Message::EXT_PSK_KEX_MODES);
 329             } else {
 330                 $message->set_extension(
 331                     TLSProxy::Message::EXT_PSK_KEX_MODES, $ext);
 332             }
 333
 334             $message->repack();
 335         }
 336     }
 337 }