Refactor ClientHello extension parsing
[openssl.git] / test / recipes / 70-test_sslextension.t
1 #!/usr/bin/perl
2 # Written by Matt Caswell 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 srctop_file bldtop_dir/;
57 use OpenSSL::Test::Utils;
58 use TLSProxy::Proxy;
59
60 my $test_name = "test_sslextension";
61 setup($test_name);
62
63 plan skip_all => "TLSProxy isn't usable on $^O"
64     if $^O =~ /^VMS$/;
65
66 plan skip_all => "$test_name needs the dynamic engine feature enabled"
67     if disabled("engine") || disabled("dynamic-engine");
68
69 $ENV{OPENSSL_ENGINES} = bldtop_dir("engines");
70 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
71 my $proxy = TLSProxy::Proxy->new(
72     \&extension_filter,
73     cmdstr(app(["openssl"])),
74     srctop_file("apps", "server.pem"),
75     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
76 );
77
78 plan tests => 3;
79
80 # Test 1: Sending a zero length extension block should pass
81 $proxy->start();
82 ok(TLSProxy::Message->success, "Zero extension length test");
83
84 sub extension_filter
85 {
86     my $proxy = shift;
87
88     # We're only interested in the initial ClientHello
89     if ($proxy->flight != 0) {
90         return;
91     }
92
93     foreach my $message (@{$proxy->message_list}) {
94         if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
95             # Remove all extensions and set the extension len to zero
96             $message->extension_data({});
97             $message->extensions_len(0);
98             # Extensions have been removed so make sure we don't try to use them
99             $message->process_extensions();
100
101             $message->repack();
102         }
103     }
104 }
105
106 # Test 2-3: Sending a duplicate extension should fail.
107 sub inject_duplicate_extension
108 {
109   my ($proxy, $message_type) = @_;
110
111     foreach my $message (@{$proxy->message_list}) {
112         if ($message->mt == $message_type) {
113           my %extensions = %{$message->extension_data};
114             # Add a duplicate (unknown) extension.
115             $message->set_extension(TLSProxy::Message::EXT_DUPLICATE_EXTENSION, "");
116             $message->set_extension(TLSProxy::Message::EXT_DUPLICATE_EXTENSION, "");
117             $message->repack();
118         }
119     }
120 }
121
122 sub inject_duplicate_extension_clienthello
123 {
124     my $proxy = shift;
125
126     # We're only interested in the initial ClientHello
127     if ($proxy->flight != 0) {
128         return;
129     }
130
131     inject_duplicate_extension($proxy, TLSProxy::Message::MT_CLIENT_HELLO);
132 }
133
134 sub inject_duplicate_extension_serverhello
135 {
136     my $proxy = shift;
137
138     # We're only interested in the initial ServerHello
139     if ($proxy->flight != 1) {
140         return;
141     }
142
143     inject_duplicate_extension($proxy, TLSProxy::Message::MT_SERVER_HELLO);
144 }
145
146 $proxy->clear();
147 $proxy->filter(\&inject_duplicate_extension_clienthello);
148 $proxy->start();
149 ok(TLSProxy::Message->fail(), "Duplicate ClientHello extension");
150
151 $proxy->clear();
152 $proxy->filter(\&inject_duplicate_extension_serverhello);
153 $proxy->start();
154 ok(TLSProxy::Message->fail(), "Duplicate ServerHello extension");
155