test/testlib/checkhandshake.pm

   1 #! /usr/bin/env perl
   2 # Copyright 2015-2016 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 package checkhandshake;
  10
  11 use OpenSSL::Test qw/:DEFAULT cmdstr srctop_file srctop_dir bldtop_dir/;
  12 use OpenSSL::Test::Utils;
  13 use TLSProxy::Proxy;
  14
  15 use Exporter;
  16 our @ISA = 'Exporter';
  17 our @EXPORT = qw(@handmessages @extensions checkhandshake);
  18
  19 use constant {
  20     DEFAULT_HANDSHAKE => 1,
  21     OCSP_HANDSHAKE => 2,
  22     RESUME_HANDSHAKE => 4,
  23     CLIENT_AUTH_HANDSHAKE => 8,
  24     RENEG_HANDSHAKE => 16,
  25     NPN_HANDSHAKE => 32,
  26     EC_HANDSHAKE => 64,
  27     HRR_HANDSHAKE => 128,
  28     HRR_RESUME_HANDSHAKE => 256,
  29
  30     ALL_HANDSHAKES => 511
  31 };
  32
  33 use constant {
  34     #DEFAULT ALSO INCLUDES SESSION_TICKET_SRV_EXTENSION
  35     DEFAULT_EXTENSIONS => 0x00000003,
  36     SESSION_TICKET_SRV_EXTENSION => 0x00000002,
  37     SERVER_NAME_CLI_EXTENSION => 0x00000004,
  38     SERVER_NAME_SRV_EXTENSION => 0x00000008,
  39     STATUS_REQUEST_CLI_EXTENSION => 0x00000010,
  40     STATUS_REQUEST_SRV_EXTENSION => 0x00000020,
  41     ALPN_CLI_EXTENSION => 0x00000040,
  42     ALPN_SRV_EXTENSION => 0x00000080,
  43     SCT_CLI_EXTENSION => 0x00000100,
  44     SCT_SRV_EXTENSION => 0x00000200,
  45     RENEGOTIATE_CLI_EXTENSION => 0x00000400,
  46     NPN_CLI_EXTENSION => 0x00000800,
  47     NPN_SRV_EXTENSION => 0x00001000,
  48     SRP_CLI_EXTENSION => 0x00002000,
  49     #Client side for ec point formats is a default extension
  50     EC_POINT_FORMAT_SRV_EXTENSION => 0x00004000,
  51     PSK_CLI_EXTENSION => 0x00008000,
  52     PSK_SRV_EXTENSION => 0x00010000,
  53     KEY_SHARE_SRV_EXTENSION => 0x00020000,
  54     PSK_KEX_MODES_EXTENSION => 0x00040000,
  55     KEY_SHARE_HRR_EXTENSION => 0x00080000
  56 };
  57
  58 our @handmessages = ();
  59 our @extensions = ();
  60
  61 sub checkhandshake($$$$)
  62 {
  63     my ($proxy, $handtype, $exttype, $testname) = @_;
  64
  65     subtest $testname => sub {
  66         my $loop = 0;
  67         my $numtests;
  68         my $extcount;
  69         my $clienthelloseen = 0;
  70
  71         #First count the number of tests
  72         my $nextmess = 0;
  73         my $message = undef;
  74         my $chnum = 0;
  75         for ($numtests = 0; $handmessages[$loop][1] != 0; $loop++) {
  76             next if (($handmessages[$loop][1] & $handtype) == 0);
  77             if (scalar @{$proxy->message_list} > $nextmess) {
  78                 $message = ${$proxy->message_list}[$nextmess];
  79                 $nextmess++;
  80             } else {
  81                 $message = undef;
  82             }
  83             $numtests++;
  84
  85             next if (!defined $message);
  86             $chnum = 1 if $message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
  87                           && TLSProxy::Proxy::is_tls13();
  88             next if ($message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
  89                     && $message->mt() != TLSProxy::Message::MT_HELLO_RETRY_REQUEST
  90                     && $message->mt() != TLSProxy::Message::MT_SERVER_HELLO
  91                     && $message->mt() !=
  92                        TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS
  93                     && $message->mt() != TLSProxy::Message::MT_CERTIFICATE);
  94
  95             next if $message->mt() == TLSProxy::Message::MT_CERTIFICATE
  96                     && !TLSProxy::Proxy::is_tls13();
  97
  98             my $extchnum = 0;
  99             for (my $extloop = 0;
 100                     $extensions[$extloop][2] != 0;
 101                     $extloop++) {
 102                 $extchnum = 1 if $extensions[$extloop][0] != TLSProxy::Message::MT_CLIENT_HELLO
 103                                  && TLSProxy::Proxy::is_tls13();
 104                 next if $extensions[$extloop][0] == TLSProxy::Message::MT_CLIENT_HELLO
 105                                  && $extchnum != $chnum;
 106                 next if ($message->mt() != $extensions[$extloop][0]);
 107                 $numtests++;
 108             }
 109             $numtests++;
 110         }
 111
 112         plan tests => $numtests;
 113
 114         $nextmess = 0;
 115         $message = undef;
 116         $chnum = 0;
 117         for ($loop = 0; $handmessages[$loop][1] != 0; $loop++) {
 118             next if (($handmessages[$loop][1] & $handtype) == 0);
 119             if (scalar @{$proxy->message_list} > $nextmess) {
 120                 $message = ${$proxy->message_list}[$nextmess];
 121                 $nextmess++;
 122             } else {
 123                 $message = undef;
 124             }
 125             if (!defined $message) {
 126                 fail("Message type check. Got nothing, expected "
 127                      .$handmessages[$loop][0]);
 128                 next;
 129             } else {
 130                 ok($message->mt == $handmessages[$loop][0],
 131                    "Message type check. Got ".$message->mt
 132                    .", expected ".$handmessages[$loop][0]);
 133             }
 134             $chnum = 1 if $message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
 135                           && TLSProxy::Proxy::is_tls13();
 136
 137             next if ($message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
 138                     && $message->mt() != TLSProxy::Message::MT_HELLO_RETRY_REQUEST
 139                     && $message->mt() != TLSProxy::Message::MT_SERVER_HELLO
 140                     && $message->mt() !=
 141                        TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS
 142                     && $message->mt() != TLSProxy::Message::MT_CERTIFICATE);
 143
 144             next if $message->mt() == TLSProxy::Message::MT_CERTIFICATE
 145                     && !TLSProxy::Proxy::is_tls13();
 146
 147             if ($message->mt() == TLSProxy::Message::MT_CLIENT_HELLO) {
 148                 #Add renegotiate extension we will expect if renegotiating
 149                 $exttype |= RENEGOTIATE_CLI_EXTENSION
 150                     if ($clienthelloseen && !TLSProxy::Proxy::is_tls13());
 151                 $clienthelloseen = 1;
 152             }
 153             #Now check that we saw the extensions we expected
 154             my $msgexts = $message->extension_data();
 155             my $extchnum = 0;
 156             for (my $extloop = 0, $extcount = 0; $extensions[$extloop][2] != 0;
 157                                 $extloop++) {
 158                 #In TLSv1.3 we can have two ClientHellos if there has been a
 159                 #HelloRetryRequest, and they may have different extensions. Skip
 160                 #if these are extensions for a different ClientHello
 161                 $extchnum = 1 if $extensions[$extloop][0] != TLSProxy::Message::MT_CLIENT_HELLO
 162                                  && TLSProxy::Proxy::is_tls13();
 163                 next if $extensions[$extloop][0] == TLSProxy::Message::MT_CLIENT_HELLO
 164                                  && $extchnum != $chnum;
 165                 next if ($message->mt() != $extensions[$extloop][0]);
 166                 ok (($extensions[$extloop][2] & $exttype) == 0
 167                       || defined ($msgexts->{$extensions[$extloop][1]}),
 168                     "Extension presence check (Message: ".$message->mt()
 169                     ." Extension: ".($extensions[$extloop][2] & $exttype).", "
 170                     .$extloop.")");
 171                 $extcount++ if (($extensions[$extloop][2] & $exttype) != 0);
 172             }
 173             ok($extcount == keys %$msgexts, "Extensions count mismatch ("
 174                                             .$extcount.", ".(keys %$msgexts)
 175                                             .")");
 176         }
 177     }
 178 }
 179
 180 1;