Use the new OpenSSL::Test::Utils routines.
[openssl.git] / test / recipes / 70-test_tlsextms.t
1 #!/usr/bin/perl
2 # Written by Stephen Henson for the OpenSSL project.
3 # ====================================================================
4 # Copyright (c) 1998-2015 The OpenSSL Project.  All rights reserved.
5 #
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
8 # are met:
9 #
10 # 1. Redistributions of source code must retain the above copyright
11 #    notice, this list of conditions and the following disclaimer.
12 #
13 # 2. Redistributions in binary form must reproduce the above copyright
14 #    notice, this list of conditions and the following disclaimer in
15 #    the documentation and/or other materials provided with the
16 #    distribution.
17 #
18 # 3. All advertising materials mentioning features or use of this
19 #    software must display the following acknowledgment:
20 #    "This product includes software developed by the OpenSSL Project
21 #    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
22 #
23 # 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
24 #    endorse or promote products derived from this software without
25 #    prior written permission. For written permission, please contact
26 #    openssl-core@openssl.org.
27 #
28 # 5. Products derived from this software may not be called "OpenSSL"
29 #    nor may "OpenSSL" appear in their names without prior written
30 #    permission of the OpenSSL Project.
31 #
32 # 6. Redistributions of any form whatsoever must retain the following
33 #    acknowledgment:
34 #    "This product includes software developed by the OpenSSL Project
35 #    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
36 #
37 # THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
38 # EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
39 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
40 # PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
41 # ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
43 # NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
44 # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
45 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
46 # STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
47 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
48 # OF THE POSSIBILITY OF SUCH DAMAGE.
49 # ====================================================================
50 #
51 # This product includes cryptographic software written by Eric Young
52 # (eay@cryptsoft.com).  This product includes software written by Tim
53 # Hudson (tjh@cryptsoft.com).
54
55 use strict;
56 use OpenSSL::Test qw/:DEFAULT cmdstr top_file top_dir/;
57 use OpenSSL::Test::Utils;
58 use TLSProxy::Proxy;
59 use File::Temp qw(tempfile);
60
61 my $test_name = "test_tlsextms";
62 setup($test_name);
63
64 plan skip_all => "TLSProxy isn't usable on $^O"
65     if $^O =~ /^VMS$/;
66
67 plan skip_all => "$test_name needs the engine feature enabled"
68     if disabled("engine");
69
70 plan skip_all => "$test_name can only be performed with OpenSSL configured shared"
71     if disabled("shared");
72
73 $ENV{OPENSSL_ENGINES} = top_dir("engines");
74 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
75
76 sub checkmessages($$$$$);
77 sub setrmextms($$);
78 sub clearall();
79
80 my $crmextms = 0;
81 my $srmextms = 0;
82 my $cextms = 0;
83 my $sextms = 0;
84 my $fullhand = 0;
85
86 my $proxy = TLSProxy::Proxy->new(
87     \&extms_filter,
88     cmdstr(app(["openssl"])),
89     top_file("apps", "server.pem"),
90     1
91 );
92
93 plan tests => 9;
94
95 #Test 1: By default server and client should send extended master secret
96 # extension.
97 #Expected result: ClientHello extension seen; ServerHello extension seen
98 #                 Full handshake
99
100 setrmextms(0, 0);
101 $proxy->start();
102 checkmessages(1, "Default extended master secret test", 1, 1, 1);
103
104 #Test 2: If client omits extended master secret extension, server should too.
105 #Expected result: ClientHello extension not seen; ServerHello extension not seen
106 #                 Full handshake
107
108 clearall();
109 setrmextms(1, 0);
110 $proxy->start();
111 checkmessages(2, "No client extension extended master secret test", 0, 0, 1);
112
113 # Test 3: same as 1 but with session tickets disabled.
114 # Expected result: same as test 1.
115
116 clearall();
117 $proxy->clientflags("-no_ticket");
118 setrmextms(0, 0);
119 $proxy->start();
120 checkmessages(3, "No ticket extended master secret test", 1, 1, 1);
121
122 # Test 4: same as 2 but with session tickets disabled.
123 # Expected result: same as test 2.
124
125 clearall();
126 $proxy->clientflags("-no_ticket");
127 setrmextms(1, 0);
128 $proxy->start();
129 checkmessages(2, "No ticket, no client extension extended master secret test", 0, 0, 1);
130
131 #Test 5: Session resumption extended master secret test
132 #
133 #Expected result: ClientHello extension seen; ServerHello extension seen
134 #                 Abbreviated handshake
135
136 clearall();
137 setrmextms(0, 0);
138 (my $fh, my $session) = tempfile();
139 $proxy->serverconnects(2);
140 $proxy->clientflags("-sess_out ".$session);
141 $proxy->start();
142 $proxy->clear();
143 $proxy->clientflags("-sess_in ".$session);
144 $proxy->clientstart();
145 checkmessages(5, "Session resumption extended master secret test", 1, 1, 0);
146
147 #Test 6: Session resumption extended master secret test orginial session
148 # omits extension. Server must not resume session.
149 #Expected result: ClientHello extension seen; ServerHello extension seen
150 #                 Full handshake
151
152 clearall();
153 setrmextms(1, 0);
154 ($fh, $session) = tempfile();
155 $proxy->serverconnects(2);
156 $proxy->clientflags("-sess_out ".$session);
157 $proxy->start();
158 $proxy->clear();
159 $proxy->clientflags("-sess_in ".$session);
160 setrmextms(0, 0);
161 $proxy->clientstart();
162 checkmessages(6, "Session resumption extended master secret test", 1, 1, 1);
163
164 #Test 7: Session resumption extended master secret test resumed session
165 # omits client extension. Server must abort connection.
166 #Expected result: aborted connection.
167
168 clearall();
169 setrmextms(0, 0);
170 ($fh, $session) = tempfile();
171 $proxy->serverconnects(2);
172 $proxy->clientflags("-sess_out ".$session);
173 $proxy->start();
174 $proxy->clear();
175 $proxy->clientflags("-sess_in ".$session);
176 setrmextms(1, 0);
177 $proxy->clientstart();
178 ok(TLSProxy::Message->fail(), "Client inconsistent session resupmption");
179
180 #Test 8: Session resumption extended master secret test resumed session
181 # omits server extension. Client must abort connection.
182 #Expected result: aborted connection.
183
184 clearall();
185 setrmextms(0, 0);
186 ($fh, $session) = tempfile();
187 $proxy->serverconnects(2);
188 $proxy->clientflags("-sess_out ".$session);
189 $proxy->start();
190 $proxy->clear();
191 $proxy->clientflags("-sess_in ".$session);
192 setrmextms(0, 1);
193 $proxy->clientstart();
194 ok(TLSProxy::Message->fail(), "Server inconsistent session resumption 1");
195
196 #Test 9: Session resumption extended master secret test initial session
197 # omits server extension. Client must abort connection.
198 #Expected result: aborted connection.
199
200 clearall();
201 setrmextms(0, 1);
202 ($fh, $session) = tempfile();
203 $proxy->serverconnects(2);
204 $proxy->clientflags("-sess_out ".$session);
205 $proxy->start();
206 $proxy->clear();
207 $proxy->clientflags("-sess_in ".$session);
208 setrmextms(0, 0);
209 $proxy->clientstart();
210 ok(TLSProxy::Message->fail(), "Server inconsistent session resumption 2");
211
212 sub extms_filter
213 {
214     my $proxy = shift;
215
216     foreach my $message (@{$proxy->message_list}) {
217         if ($crmextms && $message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
218             $message->delete_extension(TLSProxy::ClientHello::EXT_EXTENDED_MASTER_SECRET);
219             $message->repack();
220         }
221         if ($srmextms && $message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
222             $message->delete_extension(TLSProxy::ClientHello::EXT_EXTENDED_MASTER_SECRET);
223             $message->repack();
224         }
225     }
226 }
227
228 sub checkmessages($$$$$)
229 {
230     my ($testno, $testname, $testcextms, $testsextms, $testhand) = @_;
231
232     subtest $testname => sub {
233
234     foreach my $message (@{$proxy->message_list}) {
235         if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO
236             || $message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
237         #Get the extensions data
238         my %extensions = %{$message->extension_data};
239         if (defined
240             $extensions{TLSProxy::ClientHello::EXT_EXTENDED_MASTER_SECRET}) {
241             if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
242                 $cextms = 1;
243             } else {
244                 $sextms = 1;
245             }
246         }
247         } elsif ($message->mt == TLSProxy::Message::MT_CLIENT_KEY_EXCHANGE) {
248             #Must be doing a full handshake
249             $fullhand = 1;
250         }
251     }
252
253     plan tests => 4;
254
255     ok(TLSProxy::Message->success, "Handshake");
256
257     ok($testcextms == $cextms,
258        "ClientHello extension extended master secret check");
259     ok($testsextms == $sextms,
260        "ServerHello extension extended master secret check");
261     ok($testhand == $fullhand,
262        "Extended master secret full handshake check");
263
264     }
265 }
266
267 sub setrmextms($$)
268 {
269     ($crmextms, $srmextms) = @_;
270 }
271
272 sub clearall()
273 {
274     $cextms = 0;
275     $sextms = 0;
276     $fullhand = 0;
277     $proxy->clear();
278 }