Merge HRR into ServerHello
[openssl.git] / test / recipes / 70-test_tls13kexmodes.t
1 #! /usr/bin/env perl
2 # Copyright 2017 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 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_tls13kexmodes";
17 setup($test_name);
18
19 plan skip_all => "TLSProxy isn't usable on $^O"
20     if $^O =~ /^(VMS|MSWin32)$/;
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 TLSv1.3 enabled"
29     if disabled("tls1_3");
30
31 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
32 $ENV{CTLOG_FILE} = srctop_file("test", "ct", "log_list.conf");
33
34
35 @handmessages = (
36     [TLSProxy::Message::MT_CLIENT_HELLO,
37         checkhandshake::ALL_HANDSHAKES],
38     [TLSProxy::Message::MT_SERVER_HELLO,
39         checkhandshake::HRR_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE],
40     [TLSProxy::Message::MT_CLIENT_HELLO,
41         checkhandshake::HRR_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE],
42     [TLSProxy::Message::MT_SERVER_HELLO,
43         checkhandshake::ALL_HANDSHAKES],
44     [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS,
45         checkhandshake::ALL_HANDSHAKES],
46     [TLSProxy::Message::MT_CERTIFICATE_REQUEST,
47         checkhandshake::CLIENT_AUTH_HANDSHAKE],
48     [TLSProxy::Message::MT_CERTIFICATE,
49         checkhandshake::ALL_HANDSHAKES & ~(checkhandshake::RESUME_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE)],
50     [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
51         checkhandshake::ALL_HANDSHAKES & ~(checkhandshake::RESUME_HANDSHAKE | checkhandshake::HRR_RESUME_HANDSHAKE)],
52     [TLSProxy::Message::MT_FINISHED,
53         checkhandshake::ALL_HANDSHAKES],
54     [TLSProxy::Message::MT_CERTIFICATE,
55         checkhandshake::CLIENT_AUTH_HANDSHAKE],
56     [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
57         checkhandshake::CLIENT_AUTH_HANDSHAKE],
58     [TLSProxy::Message::MT_FINISHED,
59         checkhandshake::ALL_HANDSHAKES],
60     [0, 0]
61 );
62
63 @extensions = (
64     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
65         checkhandshake::SERVER_NAME_CLI_EXTENSION],
66     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
67         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
68     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
69         checkhandshake::DEFAULT_EXTENSIONS],
70     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
71         checkhandshake::DEFAULT_EXTENSIONS],
72     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
73         checkhandshake::DEFAULT_EXTENSIONS],
74     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
75         checkhandshake::ALPN_CLI_EXTENSION],
76     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
77         checkhandshake::SCT_CLI_EXTENSION],
78     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
79         checkhandshake::DEFAULT_EXTENSIONS],
80     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
81         checkhandshake::DEFAULT_EXTENSIONS],
82     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
83         checkhandshake::DEFAULT_EXTENSIONS],
84     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
85         checkhandshake::DEFAULT_EXTENSIONS],
86     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
87         checkhandshake::DEFAULT_EXTENSIONS],
88     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK_KEX_MODES,
89         checkhandshake::PSK_KEX_MODES_EXTENSION],
90     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK,
91         checkhandshake::PSK_CLI_EXTENSION],
92
93     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
94         checkhandshake::KEY_SHARE_HRR_EXTENSION],
95
96     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
97         checkhandshake::SERVER_NAME_CLI_EXTENSION],
98     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
99         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
100     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
101         checkhandshake::DEFAULT_EXTENSIONS],
102     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
103         checkhandshake::DEFAULT_EXTENSIONS],
104     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
105         checkhandshake::DEFAULT_EXTENSIONS],
106     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
107         checkhandshake::ALPN_CLI_EXTENSION],
108     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
109         checkhandshake::SCT_CLI_EXTENSION],
110     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
111         checkhandshake::DEFAULT_EXTENSIONS],
112     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
113         checkhandshake::DEFAULT_EXTENSIONS],
114     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
115         checkhandshake::DEFAULT_EXTENSIONS],
116     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
117         checkhandshake::DEFAULT_EXTENSIONS],
118     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
119         checkhandshake::DEFAULT_EXTENSIONS],
120     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK_KEX_MODES,
121         checkhandshake::PSK_KEX_MODES_EXTENSION],
122     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK,
123         checkhandshake::PSK_CLI_EXTENSION],
124
125     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
126         checkhandshake::DEFAULT_EXTENSIONS],
127     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
128         checkhandshake::KEY_SHARE_SRV_EXTENSION],
129     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_PSK,
130         checkhandshake::PSK_SRV_EXTENSION],
131
132     [TLSProxy::Message::MT_CERTIFICATE, TLSProxy::Message::EXT_STATUS_REQUEST,
133         checkhandshake::STATUS_REQUEST_SRV_EXTENSION],
134     [0,0,0]
135 );
136
137 use constant {
138     DELETE_EXTENSION => 0,
139     EMPTY_EXTENSION => 1,
140     NON_DHE_KEX_MODE_ONLY => 2,
141     DHE_KEX_MODE_ONLY => 3,
142     UNKNOWN_KEX_MODES => 4,
143     BOTH_KEX_MODES => 5
144 };
145
146 my $proxy = TLSProxy::Proxy->new(
147     undef,
148     cmdstr(app(["openssl"]), display => 1),
149     srctop_file("apps", "server.pem"),
150     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
151 );
152
153 #Test 1: First get a session
154 (undef, my $session) = tempfile();
155 $proxy->clientflags("-sess_out ".$session);
156 $proxy->serverflags("-servername localhost");
157 $proxy->sessionfile($session);
158 $proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
159 plan tests => 11;
160 ok(TLSProxy::Message->success(), "Initial connection");
161
162 #Test 2: Attempt a resume with no kex modes extension. Should not resume
163 $proxy->clear();
164 $proxy->clientflags("-sess_in ".$session);
165 my $testtype = DELETE_EXTENSION;
166 $proxy->filter(\&modify_kex_modes_filter);
167 $proxy->start();
168 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
169                checkhandshake::DEFAULT_EXTENSIONS
170                | checkhandshake::KEY_SHARE_SRV_EXTENSION
171                | checkhandshake::PSK_CLI_EXTENSION,
172                "Resume with no kex modes");
173
174 #Test 3: Attempt a resume with empty kex modes extension. Should fail (empty
175 #        extension is invalid)
176 $proxy->clear();
177 $proxy->clientflags("-sess_in ".$session);
178 $testtype = EMPTY_EXTENSION;
179 $proxy->start();
180 ok(TLSProxy::Message->fail(), "Resume with empty kex modes");
181
182 #Test 4: Attempt a resume with non-dhe kex mode only. Should resume without a
183 #        key_share
184 $proxy->clear();
185 $proxy->clientflags("-allow_no_dhe_kex -sess_in ".$session);
186 $proxy->serverflags("-allow_no_dhe_kex");
187 $testtype = NON_DHE_KEX_MODE_ONLY;
188 $proxy->start();
189 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
190                checkhandshake::DEFAULT_EXTENSIONS
191                | checkhandshake::PSK_KEX_MODES_EXTENSION
192                | checkhandshake::PSK_CLI_EXTENSION
193                | checkhandshake::PSK_SRV_EXTENSION,
194                "Resume with non-dhe kex mode");
195
196 #Test 5: Attempt a resume with dhe kex mode only. Should resume with a key_share
197 $proxy->clear();
198 $proxy->clientflags("-sess_in ".$session);
199 $testtype = DHE_KEX_MODE_ONLY;
200 $proxy->start();
201 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
202                checkhandshake::DEFAULT_EXTENSIONS
203                | checkhandshake::PSK_KEX_MODES_EXTENSION
204                | checkhandshake::KEY_SHARE_SRV_EXTENSION
205                | checkhandshake::PSK_CLI_EXTENSION
206                | checkhandshake::PSK_SRV_EXTENSION,
207                "Resume with non-dhe kex mode");
208
209 #Test 6: Attempt a resume with only unrecognised kex modes. Should not resume
210 $proxy->clear();
211 $proxy->clientflags("-sess_in ".$session);
212 $testtype = UNKNOWN_KEX_MODES;
213 $proxy->start();
214 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
215                checkhandshake::DEFAULT_EXTENSIONS
216                | checkhandshake::PSK_KEX_MODES_EXTENSION
217                | checkhandshake::KEY_SHARE_SRV_EXTENSION
218                | checkhandshake::PSK_CLI_EXTENSION,
219                "Resume with empty kex modes");
220
221 #Test 7: Attempt a resume with both non-dhe and dhe kex mode. Should resume with
222 #        a key_share
223 $proxy->clear();
224 $proxy->clientflags("-sess_in ".$session);
225 $testtype = BOTH_KEX_MODES;
226 $proxy->start();
227 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
228                checkhandshake::DEFAULT_EXTENSIONS
229                | checkhandshake::PSK_KEX_MODES_EXTENSION
230                | checkhandshake::KEY_SHARE_SRV_EXTENSION
231                | checkhandshake::PSK_CLI_EXTENSION
232                | checkhandshake::PSK_SRV_EXTENSION,
233                "Resume with non-dhe kex mode");
234
235 #Test 8: Attempt a resume with both non-dhe and dhe kex mode, but unacceptable
236 #        initial key_share. Should resume with a key_share following an HRR
237 $proxy->clear();
238 $proxy->clientflags("-sess_in ".$session);
239 $proxy->serverflags("-curves P-256");
240 $testtype = BOTH_KEX_MODES;
241 $proxy->start();
242 checkhandshake($proxy, checkhandshake::HRR_RESUME_HANDSHAKE,
243                checkhandshake::DEFAULT_EXTENSIONS
244                | checkhandshake::PSK_KEX_MODES_EXTENSION
245                | checkhandshake::KEY_SHARE_SRV_EXTENSION
246                | checkhandshake::KEY_SHARE_HRR_EXTENSION
247                | checkhandshake::PSK_CLI_EXTENSION
248                | checkhandshake::PSK_SRV_EXTENSION,
249                "Resume with both kex modes and HRR");
250
251 #Test 9: Attempt a resume with dhe kex mode only and an unacceptable initial
252 #        key_share. Should resume with a key_share following an HRR
253 $proxy->clear();
254 $proxy->clientflags("-sess_in ".$session);
255 $proxy->serverflags("-curves P-256");
256 $testtype = DHE_KEX_MODE_ONLY;
257 $proxy->start();
258 checkhandshake($proxy, checkhandshake::HRR_RESUME_HANDSHAKE,
259                checkhandshake::DEFAULT_EXTENSIONS
260                | checkhandshake::PSK_KEX_MODES_EXTENSION
261                | checkhandshake::KEY_SHARE_SRV_EXTENSION
262                | checkhandshake::KEY_SHARE_HRR_EXTENSION
263                | checkhandshake::PSK_CLI_EXTENSION
264                | checkhandshake::PSK_SRV_EXTENSION,
265                "Resume with dhe kex mode and HRR");
266
267 #Test 10: Attempt a resume with both non-dhe and dhe kex mode, unacceptable
268 #         initial key_share and no overlapping groups. Should resume without a
269 #         key_share
270 $proxy->clear();
271 $proxy->clientflags("-allow_no_dhe_kex -curves P-384 -sess_in ".$session);
272 $proxy->serverflags("-allow_no_dhe_kex -curves P-256");
273 $testtype = BOTH_KEX_MODES;
274 $proxy->start();
275 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
276                checkhandshake::DEFAULT_EXTENSIONS
277                | checkhandshake::PSK_KEX_MODES_EXTENSION
278                | checkhandshake::PSK_CLI_EXTENSION
279                | checkhandshake::PSK_SRV_EXTENSION,
280                "Resume with both kex modes, no overlapping groups");
281
282 #Test 11: Attempt a resume with dhe kex mode only, unacceptable
283 #         initial key_share and no overlapping groups. Should fail
284 $proxy->clear();
285 $proxy->clientflags("-curves P-384 -sess_in ".$session);
286 $proxy->serverflags("-curves P-256");
287 $testtype = DHE_KEX_MODE_ONLY;
288 $proxy->start();
289 ok(TLSProxy::Message->fail(), "Resume with dhe kex mode, no overlapping groups");
290
291 unlink $session;
292
293 sub modify_kex_modes_filter
294 {
295     my $proxy = shift;
296
297     # We're only interested in the initial ClientHello
298     return if ($proxy->flight != 0);
299
300     foreach my $message (@{$proxy->message_list}) {
301         if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
302             my $ext;
303
304             if ($testtype == EMPTY_EXTENSION) {
305                 $ext = pack "C",
306                     0x00;       #List length
307             } elsif ($testtype == NON_DHE_KEX_MODE_ONLY) {
308                 $ext = pack "C2",
309                     0x01,       #List length
310                     0x00;       #psk_ke
311             } elsif ($testtype == DHE_KEX_MODE_ONLY) {
312                 $ext = pack "C2",
313                     0x01,       #List length
314                     0x01;       #psk_dhe_ke
315             } elsif ($testtype == UNKNOWN_KEX_MODES) {
316                 $ext = pack "C3",
317                     0x02,       #List length
318                     0xfe,       #unknown
319                     0xff;       #unknown
320             } elsif ($testtype == BOTH_KEX_MODES) {
321                 #We deliberately list psk_ke first...should still use psk_dhe_ke
322                 $ext = pack "C3",
323                     0x02,       #List length
324                     0x00,       #psk_ke
325                     0x01;       #psk_dhe_ke
326             }
327
328             if ($testtype == DELETE_EXTENSION) {
329                 $message->delete_extension(
330                     TLSProxy::Message::EXT_PSK_KEX_MODES);
331             } else {
332                 $message->set_extension(
333                     TLSProxy::Message::EXT_PSK_KEX_MODES, $ext);
334             }
335
336             $message->repack();
337         }
338     }
339 }