65c5135a1ecff716caffd1dca991e86cd99feec2
[openssl.git] / util / perl / 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 and SERVER_NAME_CLI
35     DEFAULT_EXTENSIONS => 0x00000007,
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     SUPPORTED_GROUPS_SRV_EXTENSION => 0x00100000
57 };
58
59 our @handmessages = ();
60 our @extensions = ();
61
62 sub checkhandshake($$$$)
63 {
64     my ($proxy, $handtype, $exttype, $testname) = @_;
65
66     subtest $testname => sub {
67         my $loop = 0;
68         my $numtests;
69         my $extcount;
70         my $clienthelloseen = 0;
71
72         #First count the number of tests
73         my $nextmess = 0;
74         my $message = undef;
75         my $chnum = 0;
76         for ($numtests = 0; $handmessages[$loop][1] != 0; $loop++) {
77             next if (($handmessages[$loop][1] & $handtype) == 0);
78             if (scalar @{$proxy->message_list} > $nextmess) {
79                 $message = ${$proxy->message_list}[$nextmess];
80                 $nextmess++;
81             } else {
82                 $message = undef;
83             }
84             $numtests++;
85
86             next if (!defined $message);
87             $chnum = 1 if $message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
88                           && TLSProxy::Proxy::is_tls13();
89             next if ($message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
90                     && $message->mt() != TLSProxy::Message::MT_HELLO_RETRY_REQUEST
91                     && $message->mt() != TLSProxy::Message::MT_SERVER_HELLO
92                     && $message->mt() !=
93                        TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS
94                     && $message->mt() != TLSProxy::Message::MT_CERTIFICATE);
95
96             next if $message->mt() == TLSProxy::Message::MT_CERTIFICATE
97                     && !TLSProxy::Proxy::is_tls13();
98
99             my $extchnum = 0;
100             for (my $extloop = 0;
101                     $extensions[$extloop][2] != 0;
102                     $extloop++) {
103                 $extchnum = 1 if $extensions[$extloop][0] != TLSProxy::Message::MT_CLIENT_HELLO
104                                  && TLSProxy::Proxy::is_tls13();
105                 next if $extensions[$extloop][0] == TLSProxy::Message::MT_CLIENT_HELLO
106                                  && $extchnum != $chnum;
107                 next if ($message->mt() != $extensions[$extloop][0]);
108                 $numtests++;
109             }
110             $numtests++;
111         }
112
113         plan tests => $numtests;
114
115         $nextmess = 0;
116         $message = undef;
117         $chnum = 0;
118         for ($loop = 0; $handmessages[$loop][1] != 0; $loop++) {
119             next if (($handmessages[$loop][1] & $handtype) == 0);
120             if (scalar @{$proxy->message_list} > $nextmess) {
121                 $message = ${$proxy->message_list}[$nextmess];
122                 $nextmess++;
123             } else {
124                 $message = undef;
125             }
126             if (!defined $message) {
127                 fail("Message type check. Got nothing, expected "
128                      .$handmessages[$loop][0]);
129                 next;
130             } else {
131                 ok($message->mt == $handmessages[$loop][0],
132                    "Message type check. Got ".$message->mt
133                    .", expected ".$handmessages[$loop][0]);
134             }
135             $chnum = 1 if $message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
136                           && TLSProxy::Proxy::is_tls13();
137
138             next if ($message->mt() != TLSProxy::Message::MT_CLIENT_HELLO
139                     && $message->mt() != TLSProxy::Message::MT_HELLO_RETRY_REQUEST
140                     && $message->mt() != TLSProxy::Message::MT_SERVER_HELLO
141                     && $message->mt() !=
142                        TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS
143                     && $message->mt() != TLSProxy::Message::MT_CERTIFICATE);
144
145             next if $message->mt() == TLSProxy::Message::MT_CERTIFICATE
146                     && !TLSProxy::Proxy::is_tls13();
147
148             if ($message->mt() == TLSProxy::Message::MT_CLIENT_HELLO) {
149                 #Add renegotiate extension we will expect if renegotiating
150                 $exttype |= RENEGOTIATE_CLI_EXTENSION
151                     if ($clienthelloseen && !TLSProxy::Proxy::is_tls13());
152                 $clienthelloseen = 1;
153             }
154             #Now check that we saw the extensions we expected
155             my $msgexts = $message->extension_data();
156             my $extchnum = 0;
157             for (my $extloop = 0, $extcount = 0; $extensions[$extloop][2] != 0;
158                                 $extloop++) {
159                 #In TLSv1.3 we can have two ClientHellos if there has been a
160                 #HelloRetryRequest, and they may have different extensions. Skip
161                 #if these are extensions for a different ClientHello
162                 $extchnum = 1 if $extensions[$extloop][0] != TLSProxy::Message::MT_CLIENT_HELLO
163                                  && TLSProxy::Proxy::is_tls13();
164                 next if $extensions[$extloop][0] == TLSProxy::Message::MT_CLIENT_HELLO
165                                  && $extchnum != $chnum;
166                 next if ($message->mt() != $extensions[$extloop][0]);
167                 ok (($extensions[$extloop][2] & $exttype) == 0
168                       || defined ($msgexts->{$extensions[$extloop][1]}),
169                     "Extension presence check (Message: ".$message->mt()
170                     ." Extension: ".($extensions[$extloop][2] & $exttype).", "
171                     .$extloop.")");
172                 $extcount++ if (($extensions[$extloop][2] & $exttype) != 0);
173             }
174             ok($extcount == keys %$msgexts, "Extensions count mismatch ("
175                                             .$extcount.", ".(keys %$msgexts)
176                                             .")");
177         }
178     }
179 }
180
181 1;