test/recipes/70-test_tls13kexmodes.t

   1 #! /usr/bin/env perl
   2 # Copyright 2017-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 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)$/;
  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_SERVER_HELLO,
  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         TLSProxy::Message::CLIENT,
  66         checkhandshake::SERVER_NAME_CLI_EXTENSION],
  67     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
  68         TLSProxy::Message::CLIENT,
  69         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
  70     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
  71         TLSProxy::Message::CLIENT,
  72         checkhandshake::DEFAULT_EXTENSIONS],
  73     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
  74         TLSProxy::Message::CLIENT,
  75         checkhandshake::DEFAULT_EXTENSIONS],
  76     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
  77         TLSProxy::Message::CLIENT,
  78         checkhandshake::DEFAULT_EXTENSIONS],
  79     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
  80         TLSProxy::Message::CLIENT,
  81         checkhandshake::ALPN_CLI_EXTENSION],
  82     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
  83         TLSProxy::Message::CLIENT,
  84         checkhandshake::SCT_CLI_EXTENSION],
  85     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
  86         TLSProxy::Message::CLIENT,
  87         checkhandshake::DEFAULT_EXTENSIONS],
  88     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
  89         TLSProxy::Message::CLIENT,
  90         checkhandshake::DEFAULT_EXTENSIONS],
  91     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
  92         TLSProxy::Message::CLIENT,
  93         checkhandshake::DEFAULT_EXTENSIONS],
  94     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
  95         TLSProxy::Message::CLIENT,
  96         checkhandshake::DEFAULT_EXTENSIONS],
  97     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
  98         TLSProxy::Message::CLIENT,
  99         checkhandshake::DEFAULT_EXTENSIONS],
 100     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK_KEX_MODES,
 101         TLSProxy::Message::CLIENT,
 102         checkhandshake::PSK_KEX_MODES_EXTENSION],
 103     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK,
 104         TLSProxy::Message::CLIENT,
 105         checkhandshake::PSK_CLI_EXTENSION],
 106
 107     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
 108         TLSProxy::Message::SERVER,
 109         checkhandshake::DEFAULT_EXTENSIONS],
 110     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
 111         TLSProxy::Message::SERVER,
 112         checkhandshake::KEY_SHARE_HRR_EXTENSION],
 113
 114     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
 115         TLSProxy::Message::CLIENT,
 116         checkhandshake::SERVER_NAME_CLI_EXTENSION],
 117     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
 118         TLSProxy::Message::CLIENT,
 119         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
 120     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
 121         TLSProxy::Message::CLIENT,
 122         checkhandshake::DEFAULT_EXTENSIONS],
 123     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
 124         TLSProxy::Message::CLIENT,
 125         checkhandshake::DEFAULT_EXTENSIONS],
 126     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
 127         TLSProxy::Message::CLIENT,
 128         checkhandshake::DEFAULT_EXTENSIONS],
 129     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
 130         TLSProxy::Message::CLIENT,
 131         checkhandshake::ALPN_CLI_EXTENSION],
 132     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
 133         TLSProxy::Message::CLIENT,
 134         checkhandshake::SCT_CLI_EXTENSION],
 135     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
 136         TLSProxy::Message::CLIENT,
 137         checkhandshake::DEFAULT_EXTENSIONS],
 138     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
 139         TLSProxy::Message::CLIENT,
 140         checkhandshake::DEFAULT_EXTENSIONS],
 141     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
 142         TLSProxy::Message::CLIENT,
 143         checkhandshake::DEFAULT_EXTENSIONS],
 144     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
 145         TLSProxy::Message::CLIENT,
 146         checkhandshake::DEFAULT_EXTENSIONS],
 147     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
 148         TLSProxy::Message::CLIENT,
 149         checkhandshake::DEFAULT_EXTENSIONS],
 150     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK_KEX_MODES,
 151         TLSProxy::Message::CLIENT,
 152         checkhandshake::PSK_KEX_MODES_EXTENSION],
 153     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK,
 154         TLSProxy::Message::CLIENT,
 155         checkhandshake::PSK_CLI_EXTENSION],
 156
 157     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
 158         TLSProxy::Message::SERVER,
 159         checkhandshake::DEFAULT_EXTENSIONS],
 160     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
 161         TLSProxy::Message::SERVER,
 162         checkhandshake::KEY_SHARE_SRV_EXTENSION],
 163     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_PSK,
 164         TLSProxy::Message::SERVER,
 165         checkhandshake::PSK_SRV_EXTENSION],
 166
 167     [TLSProxy::Message::MT_CERTIFICATE, TLSProxy::Message::EXT_STATUS_REQUEST,
 168         TLSProxy::Message::SERVER,
 169         checkhandshake::STATUS_REQUEST_SRV_EXTENSION],
 170     [0,0,0,0]
 171 );
 172
 173 use constant {
 174     DELETE_EXTENSION => 0,
 175     EMPTY_EXTENSION => 1,
 176     NON_DHE_KEX_MODE_ONLY => 2,
 177     DHE_KEX_MODE_ONLY => 3,
 178     UNKNOWN_KEX_MODES => 4,
 179     BOTH_KEX_MODES => 5
 180 };
 181
 182 my $proxy = TLSProxy::Proxy->new(
 183     undef,
 184     cmdstr(app(["openssl"]), display => 1),
 185     srctop_file("apps", "server.pem"),
 186     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
 187 );
 188
 189 #Test 1: First get a session
 190 (undef, my $session) = tempfile();
 191 $proxy->clientflags("-sess_out ".$session);
 192 $proxy->serverflags("-servername localhost");
 193 $proxy->sessionfile($session);
 194 $proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
 195 plan tests => 11;
 196 ok(TLSProxy::Message->success(), "Initial connection");
 197
 198 #Test 2: Attempt a resume with no kex modes extension. Should not resume
 199 $proxy->clear();
 200 $proxy->clientflags("-sess_in ".$session);
 201 my $testtype = DELETE_EXTENSION;
 202 $proxy->filter(\&modify_kex_modes_filter);
 203 $proxy->start();
 204 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 205                checkhandshake::DEFAULT_EXTENSIONS
 206                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 207                | checkhandshake::PSK_CLI_EXTENSION,
 208                "Resume with no kex modes");
 209
 210 #Test 3: Attempt a resume with empty kex modes extension. Should fail (empty
 211 #        extension is invalid)
 212 $proxy->clear();
 213 $proxy->clientflags("-sess_in ".$session);
 214 $testtype = EMPTY_EXTENSION;
 215 $proxy->start();
 216 ok(TLSProxy::Message->fail(), "Resume with empty kex modes");
 217
 218 #Test 4: Attempt a resume with non-dhe kex mode only. Should resume without a
 219 #        key_share
 220 $proxy->clear();
 221 $proxy->clientflags("-allow_no_dhe_kex -sess_in ".$session);
 222 $proxy->serverflags("-allow_no_dhe_kex");
 223 $testtype = NON_DHE_KEX_MODE_ONLY;
 224 $proxy->start();
 225 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 226                checkhandshake::DEFAULT_EXTENSIONS
 227                | checkhandshake::PSK_KEX_MODES_EXTENSION
 228                | checkhandshake::PSK_CLI_EXTENSION
 229                | checkhandshake::PSK_SRV_EXTENSION,
 230                "Resume with non-dhe kex mode");
 231
 232 #Test 5: Attempt a resume with dhe kex mode only. Should resume with a key_share
 233 $proxy->clear();
 234 $proxy->clientflags("-sess_in ".$session);
 235 $testtype = DHE_KEX_MODE_ONLY;
 236 $proxy->start();
 237 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 238                checkhandshake::DEFAULT_EXTENSIONS
 239                | checkhandshake::PSK_KEX_MODES_EXTENSION
 240                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 241                | checkhandshake::PSK_CLI_EXTENSION
 242                | checkhandshake::PSK_SRV_EXTENSION,
 243                "Resume with non-dhe kex mode");
 244
 245 #Test 6: Attempt a resume with only unrecognised kex modes. Should not resume
 246 $proxy->clear();
 247 $proxy->clientflags("-sess_in ".$session);
 248 $testtype = UNKNOWN_KEX_MODES;
 249 $proxy->start();
 250 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 251                checkhandshake::DEFAULT_EXTENSIONS
 252                | checkhandshake::PSK_KEX_MODES_EXTENSION
 253                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 254                | checkhandshake::PSK_CLI_EXTENSION,
 255                "Resume with empty kex modes");
 256
 257 #Test 7: Attempt a resume with both non-dhe and dhe kex mode. Should resume with
 258 #        a key_share
 259 $proxy->clear();
 260 $proxy->clientflags("-sess_in ".$session);
 261 $testtype = BOTH_KEX_MODES;
 262 $proxy->start();
 263 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 264                checkhandshake::DEFAULT_EXTENSIONS
 265                | checkhandshake::PSK_KEX_MODES_EXTENSION
 266                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 267                | checkhandshake::PSK_CLI_EXTENSION
 268                | checkhandshake::PSK_SRV_EXTENSION,
 269                "Resume with non-dhe kex mode");
 270
 271 #Test 8: Attempt a resume with both non-dhe and dhe kex mode, but unacceptable
 272 #        initial key_share. Should resume with a key_share following an HRR
 273 $proxy->clear();
 274 $proxy->clientflags("-sess_in ".$session);
 275 $proxy->serverflags("-curves P-256");
 276 $testtype = BOTH_KEX_MODES;
 277 $proxy->start();
 278 checkhandshake($proxy, checkhandshake::HRR_RESUME_HANDSHAKE,
 279                checkhandshake::DEFAULT_EXTENSIONS
 280                | checkhandshake::PSK_KEX_MODES_EXTENSION
 281                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 282                | checkhandshake::KEY_SHARE_HRR_EXTENSION
 283                | checkhandshake::PSK_CLI_EXTENSION
 284                | checkhandshake::PSK_SRV_EXTENSION,
 285                "Resume with both kex modes and HRR");
 286
 287 #Test 9: Attempt a resume with dhe kex mode only and an unacceptable initial
 288 #        key_share. Should resume with a key_share following an HRR
 289 $proxy->clear();
 290 $proxy->clientflags("-sess_in ".$session);
 291 $proxy->serverflags("-curves P-256");
 292 $testtype = DHE_KEX_MODE_ONLY;
 293 $proxy->start();
 294 checkhandshake($proxy, checkhandshake::HRR_RESUME_HANDSHAKE,
 295                checkhandshake::DEFAULT_EXTENSIONS
 296                | checkhandshake::PSK_KEX_MODES_EXTENSION
 297                | checkhandshake::KEY_SHARE_SRV_EXTENSION
 298                | checkhandshake::KEY_SHARE_HRR_EXTENSION
 299                | checkhandshake::PSK_CLI_EXTENSION
 300                | checkhandshake::PSK_SRV_EXTENSION,
 301                "Resume with dhe kex mode and HRR");
 302
 303 #Test 10: Attempt a resume with both non-dhe and dhe kex mode, unacceptable
 304 #         initial key_share and no overlapping groups. Should resume without a
 305 #         key_share
 306 $proxy->clear();
 307 $proxy->clientflags("-allow_no_dhe_kex -curves P-384 -sess_in ".$session);
 308 $proxy->serverflags("-allow_no_dhe_kex -curves P-256");
 309 $testtype = BOTH_KEX_MODES;
 310 $proxy->start();
 311 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 312                checkhandshake::DEFAULT_EXTENSIONS
 313                | checkhandshake::PSK_KEX_MODES_EXTENSION
 314                | checkhandshake::PSK_CLI_EXTENSION
 315                | checkhandshake::PSK_SRV_EXTENSION,
 316                "Resume with both kex modes, no overlapping groups");
 317
 318 #Test 11: Attempt a resume with dhe kex mode only, unacceptable
 319 #         initial key_share and no overlapping groups. Should fail
 320 $proxy->clear();
 321 $proxy->clientflags("-curves P-384 -sess_in ".$session);
 322 $proxy->serverflags("-curves P-256");
 323 $testtype = DHE_KEX_MODE_ONLY;
 324 $proxy->start();
 325 ok(TLSProxy::Message->fail(), "Resume with dhe kex mode, no overlapping groups");
 326
 327 unlink $session;
 328
 329 sub modify_kex_modes_filter
 330 {
 331     my $proxy = shift;
 332
 333     # We're only interested in the initial ClientHello
 334     return if ($proxy->flight != 0);
 335
 336     foreach my $message (@{$proxy->message_list}) {
 337         if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
 338             my $ext;
 339
 340             if ($testtype == EMPTY_EXTENSION) {
 341                 $ext = pack "C",
 342                     0x00;       #List length
 343             } elsif ($testtype == NON_DHE_KEX_MODE_ONLY) {
 344                 $ext = pack "C2",
 345                     0x01,       #List length
 346                     0x00;       #psk_ke
 347             } elsif ($testtype == DHE_KEX_MODE_ONLY) {
 348                 $ext = pack "C2",
 349                     0x01,       #List length
 350                     0x01;       #psk_dhe_ke
 351             } elsif ($testtype == UNKNOWN_KEX_MODES) {
 352                 $ext = pack "C3",
 353                     0x02,       #List length
 354                     0xfe,       #unknown
 355                     0xff;       #unknown
 356             } elsif ($testtype == BOTH_KEX_MODES) {
 357                 #We deliberately list psk_ke first...should still use psk_dhe_ke
 358                 $ext = pack "C3",
 359                     0x02,       #List length
 360                     0x00,       #psk_ke
 361                     0x01;       #psk_dhe_ke
 362             }
 363
 364             if ($testtype == DELETE_EXTENSION) {
 365                 $message->delete_extension(
 366                     TLSProxy::Message::EXT_PSK_KEX_MODES);
 367             } else {
 368                 $message->set_extension(
 369                     TLSProxy::Message::EXT_PSK_KEX_MODES, $ext);
 370             }
 371
 372             $message->repack();
 373         }
 374     }
 375 }