Add a test for the PSK kex modes extension
[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::ALL_HANDSHAKES],
40     [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS,
41         checkhandshake::ALL_HANDSHAKES],
42     [TLSProxy::Message::MT_CERTIFICATE_REQUEST,
43         checkhandshake::CLIENT_AUTH_HANDSHAKE],
44     [TLSProxy::Message::MT_CERTIFICATE,
45         checkhandshake::ALL_HANDSHAKES & ~checkhandshake::RESUME_HANDSHAKE],
46     [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
47         checkhandshake::ALL_HANDSHAKES & ~checkhandshake::RESUME_HANDSHAKE],
48     [TLSProxy::Message::MT_FINISHED,
49         checkhandshake::ALL_HANDSHAKES],
50     [TLSProxy::Message::MT_CERTIFICATE,
51         checkhandshake::CLIENT_AUTH_HANDSHAKE],
52     [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
53         checkhandshake::CLIENT_AUTH_HANDSHAKE],
54     [TLSProxy::Message::MT_FINISHED,
55         checkhandshake::ALL_HANDSHAKES],
56     [0, 0]
57 );
58
59 @extensions = (
60     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
61         checkhandshake::SERVER_NAME_CLI_EXTENSION],
62     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
63         checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
64     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
65         checkhandshake::DEFAULT_EXTENSIONS],
66     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
67         checkhandshake::DEFAULT_EXTENSIONS],
68     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
69         checkhandshake::DEFAULT_EXTENSIONS],
70     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
71         checkhandshake::ALPN_CLI_EXTENSION],
72     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
73         checkhandshake::SCT_CLI_EXTENSION],
74     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
75         checkhandshake::DEFAULT_EXTENSIONS],
76     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
77         checkhandshake::DEFAULT_EXTENSIONS],
78     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
79         checkhandshake::DEFAULT_EXTENSIONS],
80     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
81         checkhandshake::DEFAULT_EXTENSIONS],
82     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
83         checkhandshake::DEFAULT_EXTENSIONS],
84     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK_KEX_MODES,
85         checkhandshake::PSK_KEX_MODES_EXTENSION],
86     [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_PSK,
87         checkhandshake::PSK_CLI_EXTENSION],
88
89     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
90         checkhandshake::KEY_SHARE_SRV_EXTENSION],
91     [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_PSK,
92         checkhandshake::PSK_SRV_EXTENSION],
93
94     [TLSProxy::Message::MT_CERTIFICATE, TLSProxy::Message::EXT_STATUS_REQUEST,
95         checkhandshake::STATUS_REQUEST_SRV_EXTENSION],
96     [0,0,0]
97 );
98
99 use constant {
100     DELETE_EXTENSION => 0,
101     EMPTY_EXTENSION => 1,
102     NON_DHE_KEX_MODE_ONLY => 2,
103     DHE_KEX_MODE_ONLY => 3,
104     UNKNONW_KEX_MODES => 4,
105     BOTH_KEX_MODES => 5
106 };
107
108 my $proxy = TLSProxy::Proxy->new(
109     undef,
110     cmdstr(app(["openssl"]), display => 1),
111     srctop_file("apps", "server.pem"),
112     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
113 );
114
115 #Test 1: First get a session
116 (undef, my $session) = tempfile();
117 $proxy->clientflags("-sess_out ".$session);
118 $proxy->sessionfile($session);
119 $proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
120 plan tests => 7;
121 ok(TLSProxy::Message->success(), "Initial connection");
122
123 #Test 2: Attempt a resume with no kex modes extension. Should not resume
124 $proxy->clear();
125 $proxy->clientflags("-sess_in ".$session);
126 my $testtype = DELETE_EXTENSION;
127 $proxy->filter(\&modify_kex_modes_filter);
128 $proxy->start();
129 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
130                checkhandshake::DEFAULT_EXTENSIONS
131                | checkhandshake::KEY_SHARE_SRV_EXTENSION
132                | checkhandshake::PSK_CLI_EXTENSION,
133                "Resume with no kex modes");
134
135 #Test 3: Attempt a resume with empty kex modes extension. Should fail (empty
136 #        extension is invalid)
137 $proxy->clear();
138 $proxy->clientflags("-sess_in ".$session);
139 $testtype = EMPTY_EXTENSION;
140 $proxy->start();
141 ok(TLSProxy::Message->fail(), "Resume with empty kex modes");
142
143 #Test 4: Attempt a resume with non-dhe kex mode only. Should resume without a
144 #        key_share
145 $proxy->clear();
146 $proxy->clientflags("-sess_in ".$session);
147 $testtype = NON_DHE_KEX_MODE_ONLY;
148 $proxy->start();
149 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
150                checkhandshake::DEFAULT_EXTENSIONS
151                | checkhandshake::PSK_KEX_MODES_EXTENSION
152                | checkhandshake::PSK_CLI_EXTENSION
153                | checkhandshake::PSK_SRV_EXTENSION,
154                "Resume with non-dhe kex mode");
155
156 #Test 5: Attempt a resume with dhe kex mode only. Should resume with a key_share
157 $proxy->clear();
158 $proxy->clientflags("-sess_in ".$session);
159 $testtype = DHE_KEX_MODE_ONLY;
160 $proxy->start();
161 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
162                checkhandshake::DEFAULT_EXTENSIONS
163                | checkhandshake::PSK_KEX_MODES_EXTENSION
164                | checkhandshake::KEY_SHARE_SRV_EXTENSION
165                | checkhandshake::PSK_CLI_EXTENSION
166                | checkhandshake::PSK_SRV_EXTENSION,
167                "Resume with non-dhe kex mode");
168
169 #Test 6: Attempt a resume with only unrecognised kex modes. Should not resume
170 $proxy->clear();
171 $proxy->clientflags("-sess_in ".$session);
172 $testtype = UNKNONW_KEX_MODES;
173 $proxy->start();
174 checkhandshake($proxy, checkhandshake::DEFAULT_HANDSHAKE,
175                checkhandshake::DEFAULT_EXTENSIONS
176                | checkhandshake::PSK_KEX_MODES_EXTENSION
177                | checkhandshake::KEY_SHARE_SRV_EXTENSION
178                | checkhandshake::PSK_CLI_EXTENSION,
179                "Resume with empty kex modes");
180
181 #Test 7: Attempt a resume with both non-dhe and dhe kex mode. Should resume with
182 #        a key_share
183 $proxy->clear();
184 $proxy->clientflags("-sess_in ".$session);
185 $testtype = BOTH_KEX_MODES;
186 $proxy->start();
187 checkhandshake($proxy, checkhandshake::RESUME_HANDSHAKE,
188                checkhandshake::DEFAULT_EXTENSIONS
189                | checkhandshake::PSK_KEX_MODES_EXTENSION
190                | checkhandshake::KEY_SHARE_SRV_EXTENSION
191                | checkhandshake::PSK_CLI_EXTENSION
192                | checkhandshake::PSK_SRV_EXTENSION,
193                "Resume with non-dhe kex mode");
194
195 unlink $session;
196
197 sub modify_kex_modes_filter
198 {
199     my $proxy = shift;
200
201     # We're only interested in the initial ClientHello
202     return if ($proxy->flight != 0);
203
204     foreach my $message (@{$proxy->message_list}) {
205         if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
206             my $ext;
207
208             if ($testtype == EMPTY_EXTENSION) {
209                 $ext = pack "C",
210                     0x00;       #List length
211             } elsif ($testtype == NON_DHE_KEX_MODE_ONLY) {
212                 $ext = pack "C2",
213                     0x01,       #List length
214                     0x00;       #psk_ke
215             } elsif ($testtype == DHE_KEX_MODE_ONLY) {
216                 $ext = pack "C2",
217                     0x01,       #List length
218                     0x01;       #psk_dhe_ke
219             } elsif ($testtype == UNKNONW_KEX_MODES) {
220                 $ext = pack "C3",
221                     0x02,       #List length
222                     0xfe,       #unknown
223                     0xff;       #unknown
224             } elsif ($testtype == BOTH_KEX_MODES) {
225                 #We deliberately list psk_ke first...should still use psk_dhe_ke
226                 $ext = pack "C3",
227                     0x02,       #List length
228                     0x00,       #psk_ke
229                     0x01;       #psk_dhe_ke
230             }
231
232             if ($testtype == DELETE_EXTENSION) {
233                 $message->delete_extension(
234                     TLSProxy::Message::EXT_PSK_KEX_MODES);
235             } else {
236                 $message->set_extension(
237                     TLSProxy::Message::EXT_PSK_KEX_MODES, $ext);
238             }
239
240             $message->repack();
241         }
242     }
243 }