test/recipes/70-test_sslsessiontick.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 use File::Temp qw(tempfile);
  60
  61 my $test_name = "test_sslsessiontick";
  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} = bldtop_dir("engines");
  74 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
  75
  76 sub checkmessages($$$$$$);
  77 sub clearall();
  78
  79 my $chellotickext = 0;
  80 my $shellotickext = 0;
  81 my $fullhand = 0;
  82 my $ticketseen = 0;
  83
  84 my $proxy = TLSProxy::Proxy->new(
  85     undef,
  86     cmdstr(app(["openssl"])),
  87     srctop_file("apps", "server.pem")
  88 );
  89
  90 plan tests => 8;
  91
  92 #Test 1: By default with no existing session we should get a session ticket
  93 #Expected result: ClientHello extension seen; ServerHello extension seen
  94 #                 NewSessionTicket message seen; Full handshake
  95 $proxy->start();
  96 checkmessages(1, "Default session ticket test", 1, 1, 1, 1);
  97
  98 #Test 2: If the server does not accept tickets we should get a normal handshake
  99 #with no session tickets
 100 #Expected result: ClientHello extension seen; ServerHello extension not seen
 101 #                 NewSessionTicket message not seen; Full handshake
 102 clearall();
 103 $proxy->serverflags("-no_ticket");
 104 $proxy->start();
 105 checkmessages(2, "No server support session ticket test", 1, 0, 0, 1);
 106
 107 #Test 3: If the client does not accept tickets we should get a normal handshake
 108 #with no session tickets
 109 #Expected result: ClientHello extension not seen; ServerHello extension not seen
 110 #                 NewSessionTicket message not seen; Full handshake
 111 clearall();
 112 $proxy->clientflags("-no_ticket");
 113 $proxy->start();
 114 checkmessages(3, "No client support session ticket test", 0, 0, 0, 1);
 115
 116 #Test 4: Test session resumption with session ticket
 117 #Expected result: ClientHello extension seen; ServerHello extension not seen
 118 #                 NewSessionTicket message not seen; Abbreviated handshake
 119 clearall();
 120 (my $fh, my $session) = tempfile();
 121 $proxy->serverconnects(2);
 122 $proxy->clientflags("-sess_out ".$session);
 123 $proxy->start();
 124 $proxy->clear();
 125 $proxy->clientflags("-sess_in ".$session);
 126 $proxy->clientstart();
 127 checkmessages(4, "Session resumption session ticket test", 1, 0, 0, 0);
 128
 129 #Test 5: Test session resumption with ticket capable client without a ticket
 130 #Expected result: ClientHello extension seen; ServerHello extension seen
 131 #                 NewSessionTicket message seen; Abbreviated handshake
 132 clearall();
 133 ($fh, $session) = tempfile();
 134 $proxy->serverconnects(2);
 135 $proxy->clientflags("-sess_out ".$session." -no_ticket");
 136 $proxy->start();
 137 $proxy->clear();
 138 $proxy->clientflags("-sess_in ".$session);
 139 $proxy->clientstart();
 140 checkmessages(5, "Session resumption with ticket capable client without a "
 141                  ."ticket", 1, 1, 1, 0);
 142
 143 #Test 6: Client accepts empty ticket.
 144 #Expected result: ClientHello extension seen; ServerHello extension seen;
 145 #                 NewSessionTicket message seen; Full handshake.
 146 clearall();
 147 $proxy->filter(\&ticket_filter);
 148 $proxy->start();
 149 checkmessages(6, "Empty ticket test",  1, 1, 1, 1);
 150
 151 #Test 7-8: Client keeps existing ticket on empty ticket.
 152 clearall();
 153 ($fh, $session) = tempfile();
 154 $proxy->serverconnects(3);
 155 $proxy->filter(undef);
 156 $proxy->clientflags("-sess_out ".$session);
 157 $proxy->start();
 158 $proxy->clear();
 159 $proxy->clientflags("-sess_in ".$session." -sess_out ".$session);
 160 $proxy->filter(\&inject_empty_ticket_filter);
 161 $proxy->clientstart();
 162 #Expected result: ClientHello extension seen; ServerHello extension seen;
 163 #                 NewSessionTicket message seen; Abbreviated handshake.
 164 checkmessages(7, "Empty ticket resumption test",  1, 1, 1, 0);
 165 clearall();
 166 $proxy->clientflags("-sess_in ".$session);
 167 $proxy->filter(undef);
 168 $proxy->clientstart();
 169 #Expected result: ClientHello extension seen; ServerHello extension not seen;
 170 #                 NewSessionTicket message not seen; Abbreviated handshake.
 171 checkmessages(8, "Empty ticket resumption test",  1, 0, 0, 0);
 172
 173
 174 sub ticket_filter
 175 {
 176     my $proxy = shift;
 177
 178     foreach my $message (@{$proxy->message_list}) {
 179         if ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
 180             $message->ticket("");
 181             $message->repack();
 182         }
 183     }
 184 }
 185
 186 sub inject_empty_ticket_filter {
 187     my $proxy = shift;
 188
 189     foreach my $message (@{$proxy->message_list}) {
 190         if ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
 191             # Only inject the message first time we're called.
 192             return;
 193         }
 194     }
 195
 196     my @new_message_list = ();
 197     foreach my $message (@{$proxy->message_list}) {
 198         push @new_message_list, $message;
 199         if ($message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
 200             $message->set_extension(TLSProxy::ClientHello::EXT_SESSION_TICKET, "");
 201             $message->repack();
 202             # Tack NewSessionTicket onto the ServerHello record.
 203             # This only works if the ServerHello is exactly one record.
 204             my $record = ${$message->records}[0];
 205
 206             my $offset = $message->startoffset + $message->encoded_length;
 207             my $newsessionticket = TLSProxy::NewSessionTicket->new(
 208                 1, "", [$record], $offset, []);
 209             $newsessionticket->repack();
 210             push @new_message_list, $newsessionticket;
 211         }
 212     }
 213     $proxy->message_list([@new_message_list]);
 214 }
 215
 216 sub checkmessages($$$$$$)
 217 {
 218     my ($testno, $testname, $testch, $testsh, $testtickseen, $testhand) = @_;
 219
 220     subtest $testname => sub {
 221
 222         foreach my $message (@{$proxy->message_list}) {
 223             if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO
 224                 || $message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
 225                 #Get the extensions data
 226                 my %extensions = %{$message->extension_data};
 227                 if (defined
 228                     $extensions{TLSProxy::ClientHello::EXT_SESSION_TICKET}) {
 229                     if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
 230                         $chellotickext = 1;
 231                     } else {
 232                         $shellotickext = 1;
 233                     }
 234                 }
 235             } elsif ($message->mt == TLSProxy::Message::MT_CLIENT_KEY_EXCHANGE) {
 236                 #Must be doing a full handshake
 237                 $fullhand = 1;
 238             } elsif ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
 239                 $ticketseen = 1;
 240             }
 241         }
 242
 243         plan tests => 5;
 244
 245         ok(TLSProxy::Message->success, "Handshake");
 246         ok(($testch && $chellotickext) || (!$testch && !$chellotickext),
 247            "ClientHello extension Session Ticket check");
 248         ok(($testsh && $shellotickext) || (!$testsh && !$shellotickext),
 249            "ServerHello extension Session Ticket check");
 250         ok(($testtickseen && $ticketseen) || (!$testtickseen && !$ticketseen),
 251            "Session Ticket message presence check");
 252         ok(($testhand && $fullhand) || (!$testhand && !$fullhand),
 253            "Session Ticket full handshake check");
 254     }
 255 }
 256
 257 sub clearall()
 258 {
 259     $chellotickext = 0;
 260     $shellotickext = 0;
 261     $fullhand = 0;
 262     $ticketseen = 0;
 263     $proxy->clear();
 264 }