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
  28     ALL_HANDSHAKES => 127
  29 };
  30
  31 use constant {
  32     #DEFAULT ALSO INCLUDES SESSION_TICKET_SRV_EXTENSION
  33     DEFAULT_EXTENSIONS => 0x00000003,
  34     SESSION_TICKET_SRV_EXTENSION => 0x00000002,
  35     SERVER_NAME_CLI_EXTENSION => 0x00000004,
  36     SERVER_NAME_SRV_EXTENSION => 0x00000008,
  37     STATUS_REQUEST_CLI_EXTENSION => 0x00000010,
  38     STATUS_REQUEST_SRV_EXTENSION => 0x00000020,
  39     ALPN_CLI_EXTENSION => 0x00000040,
  40     ALPN_SRV_EXTENSION => 0x00000080,
  41     SCT_CLI_EXTENSION => 0x00000100,
  42     SCT_SRV_EXTENSION => 0x00000200,
  43     RENEGOTIATE_CLI_EXTENSION => 0x00000400,
  44     NPN_CLI_EXTENSION => 0x00000800,
  45     NPN_SRV_EXTENSION => 0x00001000,
  46     SRP_CLI_EXTENSION => 0x00002000,
  47     #Client side for ec point formats is a default extension
  48     EC_POINT_FORMAT_SRV_EXTENSION => 0x00004000,
  49 };
  50
  51 our @handmessages = ();
  52 our @extensions = ();
  53
  54 sub checkhandshake($$$$)
  55 {
  56     my ($proxy, $handtype, $exttype, $testname) = @_;
  57
  58     subtest $testname => sub {
  59         my $loop = 0;
  60         my $numtests;
  61         my $extcount;
  62         my $clienthelloseen = 0;
  63
  64         #First count the number of tests
  65         for ($numtests = 0; $handmessages[$loop][1] != 0; $loop++) {
  66             $numtests++ if (($handmessages[$loop][1] & $handtype) != 0);
  67         }
  68
  69         #Add number of extensions we check plus 2 for the number of messages
  70         #that contain extensions
  71         $numtests += $#extensions + 2;
  72         #In a renegotiation we will have double the number of extension tests
  73         if (($handtype & RENEG_HANDSHAKE) != 0) {
  74             $numtests += $#extensions + 2;
  75         }
  76         #In TLS1.3 there are 3 messages with extensions (and no renegotiations)
  77         $numtests += 1 if ($proxy->is_tls13());
  78
  79         plan tests => $numtests;
  80
  81         my $nextmess = 0;
  82         my $message = undef;
  83         for ($loop = 0; $handmessages[$loop][1] != 0; $loop++) {
  84             next if (($handmessages[$loop][1] & $handtype) == 0);
  85             if (scalar @{$proxy->message_list} > $nextmess) {
  86                 $message = ${$proxy->message_list}[$nextmess];
  87                 $nextmess++;
  88             } else {
  89                 $message = undef;
  90             }
  91             if (!defined $message) {
  92                 fail("Message type check. Got nothing, expected "
  93                      .$handmessages[$loop][0]);
  94                 next;
  95             } else {
  96                 ok($message->mt == $handmessages[$loop][0],
  97                    "Message type check. Got ".$message->mt
  98                    .", expected ".$handmessages[$loop][0]);
  99             }
 100
 101             next if ($message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
 102                     && $message->mt() != TLSProxy::Message::MT_SERVER_HELLO
 103                     && $message->mt() !=
 104                        TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS);
 105
 106             if ($message->mt() == TLSProxy::Message::MT_CLIENT_HELLO) {
 107                 #Add renegotiate extension we will expect if renegotiating
 108                 $exttype |= RENEGOTIATE_CLI_EXTENSION if ($clienthelloseen);
 109                 $clienthelloseen = 1;
 110             }
 111             #Now check that we saw the extensions we expected
 112             my $msgexts = $message->extension_data();
 113
 114             for (my $extloop = 0, $extcount = 0; $extensions[$extloop][2] != 0;
 115                                 $extloop++) {
 116                 next if ($message->mt() != $extensions[$extloop][0]);
 117                 ok (($extensions[$extloop][2] & $exttype) == 0
 118                       || defined ($msgexts->{$extensions[$extloop][1]}),
 119                     "Extension presence check (Message: ".$message->mt()
 120                     ." Extension: ".($extensions[$extloop][2] & $exttype).", "
 121                     .$extloop.")");
 122                 $extcount++ if (($extensions[$extloop][2] & $exttype) != 0);
 123              }
 124             ok($extcount == keys %$msgexts, "Extensions count mismatch ("
 125                                             .$extcount.", ".(keys %$msgexts)
 126                                             .")");
 127         }
 128     }
 129 }
 130
 131 1;