Add testing of TLSv1.3 resumption in test_tls13messages
[openssl.git] / 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     PSK_CLI_EXTENSION => 0x00008000,
50     PSK_SRV_EXTENSION => 0x00010000
51 };
52
53 our @handmessages = ();
54 our @extensions = ();
55
56 sub checkhandshake($$$$)
57 {
58     my ($proxy, $handtype, $exttype, $testname) = @_;
59
60     subtest $testname => sub {
61         my $loop = 0;
62         my $numtests;
63         my $extcount;
64         my $clienthelloseen = 0;
65
66         #First count the number of tests
67         for ($numtests = 0; $handmessages[$loop][1] != 0; $loop++) {
68             $numtests++ if (($handmessages[$loop][1] & $handtype) != 0);
69         }
70
71         #Add number of extensions we check plus 2 for the number of messages
72         #that contain extensions
73         $numtests += $#extensions + 2;
74         #In a renegotiation we will have double the number of extension tests
75         if (($handtype & RENEG_HANDSHAKE) != 0) {
76             $numtests += $#extensions + 2;
77         }
78         #In TLS1.3 there are 4 messages with extensions (i.e. 2 extra) and no
79         #renegotiations: 1 ClientHello, 1 ServerHello, 1 EncryptedExtensions,
80         #1 Certificate
81         $numtests += 2 if ($proxy->is_tls13());
82         #Except in Client auth where we have an extra Certificate message, and
83         #one extension gets checked twice (once in each Certificate message)
84         $numtests += 2 if ($proxy->is_tls13()
85                           && ($handtype & CLIENT_AUTH_HANDSHAKE) != 0);
86         #And in a resumption handshake we don't get Certificate at all and the
87         #Certificate extension doesn't get checked at all
88         $numtests -= 2 if ($proxy->is_tls13()
89                           && ($handtype & RESUME_HANDSHAKE) != 0);
90
91         plan tests => $numtests;
92
93         my $nextmess = 0;
94         my $message = undef;
95         for ($loop = 0; $handmessages[$loop][1] != 0; $loop++) {
96             next if (($handmessages[$loop][1] & $handtype) == 0);
97             if (scalar @{$proxy->message_list} > $nextmess) {
98                 $message = ${$proxy->message_list}[$nextmess];
99                 $nextmess++;
100             } else {
101                 $message = undef;
102             }
103             if (!defined $message) {
104                 fail("Message type check. Got nothing, expected "
105                      .$handmessages[$loop][0]);
106                 next;
107             } else {
108                 ok($message->mt == $handmessages[$loop][0],
109                    "Message type check. Got ".$message->mt
110                    .", expected ".$handmessages[$loop][0]);
111             }
112
113             next if ($message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
114                     && $message->mt() != TLSProxy::Message::MT_SERVER_HELLO
115                     && $message->mt() !=
116                        TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS
117                     && $message->mt() != TLSProxy::Message::MT_CERTIFICATE);
118
119             next if $message->mt() == TLSProxy::Message::MT_CERTIFICATE
120                     && !TLSProxy::Proxy::is_tls13();
121
122             if ($message->mt() == TLSProxy::Message::MT_CLIENT_HELLO) {
123                 #Add renegotiate extension we will expect if renegotiating
124                 $exttype |= RENEGOTIATE_CLI_EXTENSION if ($clienthelloseen);
125                 $clienthelloseen = 1;
126             }
127             #Now check that we saw the extensions we expected
128             my $msgexts = $message->extension_data();
129
130             for (my $extloop = 0, $extcount = 0; $extensions[$extloop][2] != 0;
131                                 $extloop++) {
132                 next if ($message->mt() != $extensions[$extloop][0]);
133                 ok (($extensions[$extloop][2] & $exttype) == 0
134                       || defined ($msgexts->{$extensions[$extloop][1]}),
135                     "Extension presence check (Message: ".$message->mt()
136                     ." Extension: ".($extensions[$extloop][2] & $exttype).", "
137                     .$extloop.")");
138                 $extcount++ if (($extensions[$extloop][2] & $exttype) != 0);
139              }
140             ok($extcount == keys %$msgexts, "Extensions count mismatch ("
141                                             .$extcount.", ".(keys %$msgexts)
142                                             .")");
143         }
144     }
145 }
146
147 1;