test/recipes/70-test_sslmessages.t

   1 #! /usr/bin/env perl
   2 # Copyright 2015-2020 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 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_sslmessages";
  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 TLS enabled"
  29     if alldisabled(available_protocols("tls"))
  30        || (!disabled("tls1_3") && disabled("tls1_2"));
  31
  32 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
  33
  34 my $proxy = TLSProxy::Proxy->new(
  35     undef,
  36     cmdstr(app(["openssl"]), display => 1),
  37     srctop_file("apps", "server.pem"),
  38     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
  39 );
  40
  41 @handmessages = (
  42     [TLSProxy::Message::MT_CLIENT_HELLO,
  43         checkhandshake::ALL_HANDSHAKES],
  44     [TLSProxy::Message::MT_SERVER_HELLO,
  45         checkhandshake::ALL_HANDSHAKES],
  46     [TLSProxy::Message::MT_CERTIFICATE,
  47         checkhandshake::ALL_HANDSHAKES
  48         & ~checkhandshake::RESUME_HANDSHAKE],
  49     (disabled("ec") ? () :
  50                       [TLSProxy::Message::MT_SERVER_KEY_EXCHANGE,
  51                           checkhandshake::EC_HANDSHAKE]),
  52     [TLSProxy::Message::MT_CERTIFICATE_STATUS,
  53         checkhandshake::OCSP_HANDSHAKE],
  54     #ServerKeyExchange handshakes not currently supported by TLSProxy
  55     [TLSProxy::Message::MT_CERTIFICATE_REQUEST,
  56         checkhandshake::CLIENT_AUTH_HANDSHAKE],
  57     [TLSProxy::Message::MT_SERVER_HELLO_DONE,
  58         checkhandshake::ALL_HANDSHAKES
  59         & ~checkhandshake::RESUME_HANDSHAKE],
  60     [TLSProxy::Message::MT_CERTIFICATE,
  61         checkhandshake::CLIENT_AUTH_HANDSHAKE],
  62     [TLSProxy::Message::MT_CLIENT_KEY_EXCHANGE,
  63         checkhandshake::ALL_HANDSHAKES
  64         & ~checkhandshake::RESUME_HANDSHAKE],
  65     [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
  66         checkhandshake::CLIENT_AUTH_HANDSHAKE],
  67     [TLSProxy::Message::MT_NEXT_PROTO,
  68         checkhandshake::NPN_HANDSHAKE],
  69     [TLSProxy::Message::MT_FINISHED,
  70         checkhandshake::ALL_HANDSHAKES],
  71     [TLSProxy::Message::MT_NEW_SESSION_TICKET,
  72         checkhandshake::ALL_HANDSHAKES
  73         & ~checkhandshake::RESUME_HANDSHAKE],
  74     [TLSProxy::Message::MT_FINISHED,
  75         checkhandshake::ALL_HANDSHAKES],
  76     [TLSProxy::Message::MT_CLIENT_HELLO,
  77         checkhandshake::RENEG_HANDSHAKE],
  78     [TLSProxy::Message::MT_SERVER_HELLO,
  79         checkhandshake::RENEG_HANDSHAKE],
  80     [TLSProxy::Message::MT_CERTIFICATE,
  81         checkhandshake::RENEG_HANDSHAKE],
  82     [TLSProxy::Message::MT_SERVER_HELLO_DONE,
  83         checkhandshake::RENEG_HANDSHAKE],
  84     [TLSProxy::Message::MT_CLIENT_KEY_EXCHANGE,
  85         checkhandshake::RENEG_HANDSHAKE],
  86     [TLSProxy::Message::MT_FINISHED,
  87         checkhandshake::RENEG_HANDSHAKE],
  88     [TLSProxy::Message::MT_NEW_SESSION_TICKET,
  89         checkhandshake::RENEG_HANDSHAKE],
  90     [TLSProxy::Message::MT_FINISHED,
  91         checkhandshake::RENEG_HANDSHAKE],
  92     [0, 0]
  93 );
  94
  95 @extensions = (
  96     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
  97         TLSProxy::Message::CLIENT,
  98         checkhandshake::SERVER_NAME_CLI_EXTENSION],
  99     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
 100         TLSProxy::Message::CLIENT,
 101         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
 102     (disabled("ec") ? () :
 103                       [TLSProxy::Message::MT_CLIENT_HELLO,
 104                        TLSProxy::Message::EXT_SUPPORTED_GROUPS,
 105                        TLSProxy::Message::CLIENT,
 106                        checkhandshake::DEFAULT_EXTENSIONS]),
 107     (disabled("ec") ? () :
 108                       [TLSProxy::Message::MT_CLIENT_HELLO,
 109                        TLSProxy::Message::EXT_EC_POINT_FORMATS,
 110                        TLSProxy::Message::CLIENT,
 111                        checkhandshake::DEFAULT_EXTENSIONS]),
 112     (disabled("tls1_2") ? () :
 113      [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
 114         TLSProxy::Message::CLIENT,
 115          checkhandshake::DEFAULT_EXTENSIONS]),
 116     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
 117         TLSProxy::Message::CLIENT,
 118         checkhandshake::ALPN_CLI_EXTENSION],
 119     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
 120         TLSProxy::Message::CLIENT,
 121         checkhandshake::SCT_CLI_EXTENSION],
 122     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
 123         TLSProxy::Message::CLIENT,
 124         checkhandshake::DEFAULT_EXTENSIONS],
 125     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
 126         TLSProxy::Message::CLIENT,
 127         checkhandshake::DEFAULT_EXTENSIONS],
 128     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
 129         TLSProxy::Message::CLIENT,
 130         checkhandshake::DEFAULT_EXTENSIONS],
 131     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_RENEGOTIATE,
 132         TLSProxy::Message::CLIENT,
 133         checkhandshake::RENEGOTIATE_CLI_EXTENSION],
 134     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_NPN,
 135         TLSProxy::Message::CLIENT,
 136         checkhandshake::NPN_CLI_EXTENSION],
 137     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SRP,
 138         TLSProxy::Message::CLIENT,
 139         checkhandshake::SRP_CLI_EXTENSION],
 140
 141     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_RENEGOTIATE,
 142         TLSProxy::Message::SERVER,
 143         checkhandshake::DEFAULT_EXTENSIONS],
 144     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
 145         TLSProxy::Message::SERVER,
 146         checkhandshake::DEFAULT_EXTENSIONS],
 147     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
 148         TLSProxy::Message::SERVER,
 149         checkhandshake::DEFAULT_EXTENSIONS],
 150     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
 151         TLSProxy::Message::SERVER,
 152         checkhandshake::SESSION_TICKET_SRV_EXTENSION],
 153     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
 154         TLSProxy::Message::SERVER,
 155         checkhandshake::SERVER_NAME_SRV_EXTENSION],
 156     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
 157         TLSProxy::Message::SERVER,
 158         checkhandshake::STATUS_REQUEST_SRV_EXTENSION],
 159     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_ALPN,
 160         TLSProxy::Message::SERVER,
 161         checkhandshake::ALPN_SRV_EXTENSION],
 162     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_SCT,
 163         TLSProxy::Message::SERVER,
 164         checkhandshake::SCT_SRV_EXTENSION],
 165     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_NPN,
 166         TLSProxy::Message::SERVER,
 167         checkhandshake::NPN_SRV_EXTENSION],
 168     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
 169         TLSProxy::Message::SERVER,
 170         checkhandshake::EC_POINT_FORMAT_SRV_EXTENSION],
 171     [0,0,0,0]
 172 );
 173
 174 #Test 1: Check we get all the right messages for a default handshake
 175 (undef, my $session) = tempfile();
 176 $proxy->serverconnects(2);
 177 $proxy->clientflags("-no_tls1_3 -sess_out ".$session);
 178 $proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
 179 plan tests => 21;
 180 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 181                checkhandshake::DEFAULT_EXTENSIONS,
 182                "Default handshake test");
 183
 184 #Test 2: Resumption handshake
 185 $proxy->clearClient();
 186 $proxy->clientflags("-no_tls1_3 -sess_in ".$session);
 187 $proxy->clientstart();
 188 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
 189                checkhandshake::DEFAULT_EXTENSIONS
 190                & ~checkhandshake::SESSION_TICKET_SRV_EXTENSION,
 191                "Resumption handshake test");
 192 unlink $session;
 193
 194 SKIP: {
 195     skip "No OCSP support in this OpenSSL build", 3
 196         if disabled("ocsp");
 197
 198     #Test 3: A status_request handshake (client request only)
 199     $proxy->clear();
 200     $proxy->clientflags("-no_tls1_3 -status");
 201     $proxy->start();
 202     checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 203                    checkhandshake::DEFAULT_EXTENSIONS
 204                    | checkhandshake::STATUS_REQUEST_CLI_EXTENSION,
 205                    "status_request handshake test (client)");
 206
 207     #Test 4: A status_request handshake (server support only)
 208     $proxy->clear();
 209     $proxy->clientflags("-no_tls1_3");
 210     $proxy->serverflags("-status_file "
 211                         .srctop_file("test", "recipes", "ocsp-response.der"));
 212     $proxy->start();
 213     checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 214                    checkhandshake::DEFAULT_EXTENSIONS,
 215                    "status_request handshake test (server)");
 216
 217     #Test 5: A status_request handshake (client and server)
 218     $proxy->clear();
 219     $proxy->clientflags("-no_tls1_3 -status");
 220     $proxy->serverflags("-status_file "
 221                         .srctop_file("test", "recipes", "ocsp-response.der"));
 222     $proxy->start();
 223     checkhandshake($proxy, checkhandshake::OCSP_HANDSHAKE,
 224                    checkhandshake::DEFAULT_EXTENSIONS
 225                    | checkhandshake::STATUS_REQUEST_CLI_EXTENSION
 226                    | checkhandshake::STATUS_REQUEST_SRV_EXTENSION,
 227                    "status_request handshake test");
 228 }
 229
 230 #Test 6: A client auth handshake
 231 $proxy->clear();
 232 $proxy->clientflags("-no_tls1_3 -cert ".srctop_file("apps", "server.pem"));
 233 $proxy->serverflags("-Verify 5");
 234 $proxy->start();
 235 checkhandshake($proxy, checkhandshake::CLIENT_AUTH_HANDSHAKE,
 236                checkhandshake::DEFAULT_EXTENSIONS,
 237                "Client auth handshake test");
 238
 239 #Test 7: A handshake with a renegotiation
 240 $proxy->clear();
 241 $proxy->clientflags("-no_tls1_3");
 242 $proxy->reneg(1);
 243 $proxy->start();
 244 checkhandshake($proxy, checkhandshake::RENEG_HANDSHAKE,
 245                checkhandshake::DEFAULT_EXTENSIONS,
 246                "Renegotiation handshake test");
 247
 248 #Test 8: Server name handshake (no client request)
 249 $proxy->clear();
 250 $proxy->clientflags("-no_tls1_3 -noservername");
 251 $proxy->start();
 252 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 253                checkhandshake::DEFAULT_EXTENSIONS
 254                & ~checkhandshake::SERVER_NAME_CLI_EXTENSION,
 255                "Server name handshake test (client)");
 256
 257 #Test 9: Server name handshake (server support only)
 258 $proxy->clear();
 259 $proxy->clientflags("-no_tls1_3 -noservername");
 260 $proxy->serverflags("-servername testhost");
 261 $proxy->start();
 262 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 263                checkhandshake::DEFAULT_EXTENSIONS
 264                & ~checkhandshake::SERVER_NAME_CLI_EXTENSION,
 265                "Server name handshake test (server)");
 266
 267 #Test 10: Server name handshake (client and server)
 268 $proxy->clear();
 269 $proxy->clientflags("-no_tls1_3 -servername testhost");
 270 $proxy->serverflags("-servername testhost");
 271 $proxy->start();
 272 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 273                checkhandshake::DEFAULT_EXTENSIONS
 274                | checkhandshake::SERVER_NAME_SRV_EXTENSION,
 275                "Server name handshake test");
 276
 277 #Test 11: ALPN handshake (client request only)
 278 $proxy->clear();
 279 $proxy->clientflags("-no_tls1_3 -alpn test");
 280 $proxy->start();
 281 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 282                checkhandshake::DEFAULT_EXTENSIONS
 283                | checkhandshake::ALPN_CLI_EXTENSION,
 284                "ALPN handshake test (client)");
 285
 286 #Test 12: ALPN handshake (server support only)
 287 $proxy->clear();
 288 $proxy->clientflags("-no_tls1_3");
 289 $proxy->serverflags("-alpn test");
 290 $proxy->start();
 291 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 292                checkhandshake::DEFAULT_EXTENSIONS,
 293                "ALPN handshake test (server)");
 294
 295 #Test 13: ALPN handshake (client and server)
 296 $proxy->clear();
 297 $proxy->clientflags("-no_tls1_3 -alpn test");
 298 $proxy->serverflags("-alpn test");
 299 $proxy->start();
 300 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 301                checkhandshake::DEFAULT_EXTENSIONS
 302                | checkhandshake::ALPN_CLI_EXTENSION
 303                | checkhandshake::ALPN_SRV_EXTENSION,
 304                "ALPN handshake test");
 305
 306 SKIP: {
 307     skip "No CT, EC or OCSP support in this OpenSSL build", 1
 308         if disabled("ct") || disabled("ec") || disabled("ocsp");
 309
 310     #Test 14: SCT handshake (client request only)
 311     $proxy->clear();
 312     #Note: -ct also sends status_request
 313     $proxy->clientflags("-no_tls1_3 -ct");
 314     $proxy->serverflags("-status_file "
 315                         .srctop_file("test", "recipes", "ocsp-response.der"));
 316     $proxy->start();
 317     checkhandshake($proxy, checkhandshake::OCSP_HANDSHAKE,
 318                    checkhandshake::DEFAULT_EXTENSIONS
 319                    | checkhandshake::SCT_CLI_EXTENSION
 320                    | checkhandshake::STATUS_REQUEST_CLI_EXTENSION
 321                    | checkhandshake::STATUS_REQUEST_SRV_EXTENSION,
 322                    "SCT handshake test (client)");
 323 }
 324
 325 SKIP: {
 326     skip "No OCSP support in this OpenSSL build", 1
 327         if disabled("ocsp");
 328
 329     #Test 15: SCT handshake (server support only)
 330     $proxy->clear();
 331     #Note: -ct also sends status_request
 332     $proxy->clientflags("-no_tls1_3");
 333     $proxy->serverflags("-status_file "
 334                         .srctop_file("test", "recipes", "ocsp-response.der"));
 335     $proxy->start();
 336     checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 337                    checkhandshake::DEFAULT_EXTENSIONS,
 338                    "SCT handshake test (server)");
 339 }
 340
 341 SKIP: {
 342     skip "No CT, EC or OCSP support in this OpenSSL build", 1
 343         if disabled("ct") || disabled("ec") || disabled("ocsp");
 344
 345     #Test 16: SCT handshake (client and server)
 346     #There is no built-in server side support for this so we are actually also
 347     #testing custom extensions here
 348     $proxy->clear();
 349     #Note: -ct also sends status_request
 350     $proxy->clientflags("-no_tls1_3 -ct");
 351     $proxy->serverflags("-status_file "
 352                         .srctop_file("test", "recipes", "ocsp-response.der")
 353                         ." -serverinfo ".srctop_file("test", "serverinfo.pem"));
 354     $proxy->start();
 355     checkhandshake($proxy, checkhandshake::OCSP_HANDSHAKE,
 356                    checkhandshake::DEFAULT_EXTENSIONS
 357                    | checkhandshake::SCT_CLI_EXTENSION
 358                    | checkhandshake::SCT_SRV_EXTENSION
 359                    | checkhandshake::STATUS_REQUEST_CLI_EXTENSION
 360                    | checkhandshake::STATUS_REQUEST_SRV_EXTENSION,
 361                    "SCT handshake test");
 362 }
 363
 364
 365 SKIP: {
 366     skip "No NPN support in this OpenSSL build", 3
 367         if disabled("nextprotoneg");
 368
 369     #Test 17: NPN handshake (client request only)
 370     $proxy->clear();
 371     $proxy->clientflags("-no_tls1_3 -nextprotoneg test");
 372     $proxy->start();
 373     checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 374                    checkhandshake::DEFAULT_EXTENSIONS
 375                    | checkhandshake::NPN_CLI_EXTENSION,
 376                    "NPN handshake test (client)");
 377
 378     #Test 18: NPN handshake (server support only)
 379     $proxy->clear();
 380     $proxy->clientflags("-no_tls1_3");
 381     $proxy->serverflags("-nextprotoneg test");
 382     $proxy->start();
 383     checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 384                    checkhandshake::DEFAULT_EXTENSIONS,
 385                    "NPN handshake test (server)");
 386
 387     #Test 19: NPN handshake (client and server)
 388     $proxy->clear();
 389     $proxy->clientflags("-no_tls1_3 -nextprotoneg test");
 390     $proxy->serverflags("-nextprotoneg test");
 391     $proxy->start();
 392     checkhandshake($proxy, checkhandshake::NPN_HANDSHAKE,
 393                    checkhandshake::DEFAULT_EXTENSIONS
 394                    | checkhandshake::NPN_CLI_EXTENSION
 395                    | checkhandshake::NPN_SRV_EXTENSION,
 396                    "NPN handshake test");
 397 }
 398
 399 SKIP: {
 400     skip "No SRP support in this OpenSSL build", 1
 401         if disabled("srp");
 402
 403     #Test 20: SRP extension
 404     #Note: We are not actually going to perform an SRP handshake (TLSProxy
 405     #does not support it). However it is sufficient for us to check that the
 406     #SRP extension gets added on the client side. There is no SRP extension
 407     #generated on the server side anyway.
 408     $proxy->clear();
 409     $proxy->clientflags("-no_tls1_3 -srpuser user -srppass pass:pass");
 410     $proxy->start();
 411     checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
 412                    checkhandshake::DEFAULT_EXTENSIONS
 413                    | checkhandshake::SRP_CLI_EXTENSION,
 414                    "SRP extension test");
 415 }
 416
 417 #Test 21: EC handshake
 418 SKIP: {
 419     skip "No EC support in this OpenSSL build", 1 if disabled("ec");
 420     $proxy->clear();
 421     $proxy->clientflags("-no_tls1_3");
 422     $proxy->serverflags("-no_tls1_3");
 423     $proxy->ciphers("ECDHE-RSA-AES128-SHA");
 424     $proxy->start();
 425     checkhandshake($proxy, checkhandshake::EC_HANDSHAKE,
 426                    checkhandshake::DEFAULT_EXTENSIONS
 427                    | checkhandshake::EC_POINT_FORMAT_SRV_EXTENSION,
 428                    "EC handshake test");
 429 }