test/recipes/70-test_sslsessiontick.t

   1 #! /usr/bin/env perl
   2 # Copyright 2015-2016 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 bldtop_dir/;
  11 use OpenSSL::Test::Utils;
  12 use TLSProxy::Proxy;
  13 use File::Temp qw(tempfile);
  14
  15 my $test_name = "test_sslsessiontick";
  16 setup($test_name);
  17
  18 plan skip_all => "TLSProxy isn't usable on $^O"
  19     if $^O =~ /^(VMS|MSWin32)$/;
  20
  21 plan skip_all => "$test_name needs the dynamic engine feature enabled"
  22     if disabled("engine") || disabled("dynamic-engine");
  23
  24 plan skip_all => "$test_name needs the sock feature enabled"
  25     if disabled("sock");
  26
  27 plan skip_all => "$test_name needs TLS enabled"
  28     if alldisabled(available_protocols("tls"));
  29
  30 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
  31
  32 sub checkmessages($$$$$$);
  33 sub clearclient();
  34 sub clearall();
  35
  36 my $chellotickext = 0;
  37 my $shellotickext = 0;
  38 my $fullhand = 0;
  39 my $ticketseen = 0;
  40
  41 my $proxy = TLSProxy::Proxy->new(
  42     undef,
  43     cmdstr(app(["openssl"]), display => 1),
  44     srctop_file("apps", "server.pem"),
  45     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
  46 );
  47
  48 #Test 1: By default with no existing session we should get a session ticket
  49 #Expected result: ClientHello extension seen; ServerHello extension seen
  50 #                 NewSessionTicket message seen; Full handshake
  51 $proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
  52 plan tests => 10;
  53 checkmessages(1, "Default session ticket test", 1, 1, 1, 1);
  54
  55 #Test 2: If the server does not accept tickets we should get a normal handshake
  56 #with no session tickets
  57 #Expected result: ClientHello extension seen; ServerHello extension not seen
  58 #                 NewSessionTicket message not seen; Full handshake
  59 clearall();
  60 $proxy->serverflags("-no_ticket");
  61 $proxy->start();
  62 checkmessages(2, "No server support session ticket test", 1, 0, 0, 1);
  63
  64 #Test 3: If the client does not accept tickets we should get a normal handshake
  65 #with no session tickets
  66 #Expected result: ClientHello extension not seen; ServerHello extension not seen
  67 #                 NewSessionTicket message not seen; Full handshake
  68 clearall();
  69 $proxy->clientflags("-no_ticket");
  70 $proxy->start();
  71 checkmessages(3, "No client support session ticket test", 0, 0, 0, 1);
  72
  73 #Test 4: Test session resumption with session ticket
  74 #Expected result: ClientHello extension seen; ServerHello extension not seen
  75 #                 NewSessionTicket message not seen; Abbreviated handshake
  76 clearall();
  77 (undef, my $session) = tempfile();
  78 $proxy->serverconnects(2);
  79 $proxy->clientflags("-sess_out ".$session);
  80 $proxy->start();
  81 $proxy->clearClient();
  82 $proxy->clientflags("-sess_in ".$session);
  83 $proxy->clientstart();
  84 checkmessages(4, "Session resumption session ticket test", 1, 0, 0, 0);
  85 unlink $session;
  86
  87 #Test 5: Test session resumption with ticket capable client without a ticket
  88 #Expected result: ClientHello extension seen; ServerHello extension seen
  89 #                 NewSessionTicket message seen; Abbreviated handshake
  90 clearall();
  91 (undef, $session) = tempfile();
  92 $proxy->serverconnects(2);
  93 $proxy->clientflags("-sess_out ".$session." -no_ticket");
  94 $proxy->start();
  95 $proxy->clearClient();
  96 $proxy->clientflags("-sess_in ".$session);
  97 $proxy->clientstart();
  98 checkmessages(5, "Session resumption with ticket capable client without a "
  99                  ."ticket", 1, 1, 1, 0);
 100 unlink $session;
 101
 102 #Test 6: Client accepts empty ticket.
 103 #Expected result: ClientHello extension seen; ServerHello extension seen;
 104 #                 NewSessionTicket message seen; Full handshake.
 105 clearall();
 106 $proxy->filter(\&ticket_filter);
 107 $proxy->start();
 108 checkmessages(6, "Empty ticket test",  1, 1, 1, 1);
 109
 110 #Test 7-8: Client keeps existing ticket on empty ticket.
 111 clearall();
 112 (undef, $session) = tempfile();
 113 $proxy->serverconnects(3);
 114 $proxy->filter(undef);
 115 $proxy->clientflags("-sess_out ".$session);
 116 $proxy->start();
 117 $proxy->clearClient();
 118 $proxy->clientflags("-sess_in ".$session." -sess_out ".$session);
 119 $proxy->filter(\&inject_empty_ticket_filter);
 120 $proxy->clientstart();
 121 #Expected result: ClientHello extension seen; ServerHello extension seen;
 122 #                 NewSessionTicket message seen; Abbreviated handshake.
 123 checkmessages(7, "Empty ticket resumption test",  1, 1, 1, 0);
 124 clearclient();
 125 $proxy->clientflags("-sess_in ".$session);
 126 $proxy->filter(undef);
 127 $proxy->clientstart();
 128 #Expected result: ClientHello extension seen; ServerHello extension not seen;
 129 #                 NewSessionTicket message not seen; Abbreviated handshake.
 130 checkmessages(8, "Empty ticket resumption test",  1, 0, 0, 0);
 131 unlink $session;
 132
 133 #Test 9: Bad server sends the ServerHello extension but does not send a
 134 #NewSessionTicket
 135 #Expected result: Connection failure
 136 clearall();
 137 $proxy->serverflags("-no_ticket");
 138 $proxy->filter(\&inject_ticket_extension_filter);
 139 $proxy->start();
 140 ok(TLSProxy::Message->fail, "Server sends ticket extension but no ticket test");
 141
 142 #Test10: Bad server does not send the ServerHello extension but does send a
 143 #NewSessionTicket
 144 #Expected result: Connection failure
 145 clearall();
 146 $proxy->serverflags("-no_ticket");
 147 $proxy->filter(\&inject_empty_ticket_filter);
 148 $proxy->start();
 149 ok(TLSProxy::Message->fail, "No server ticket extension but ticket sent test");
 150
 151 sub ticket_filter
 152 {
 153     my $proxy = shift;
 154
 155     foreach my $message (@{$proxy->message_list}) {
 156         if ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
 157             $message->ticket("");
 158             $message->repack();
 159         }
 160     }
 161 }
 162
 163 sub inject_empty_ticket_filter {
 164     my $proxy = shift;
 165
 166     foreach my $message (@{$proxy->message_list}) {
 167         if ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
 168             # Only inject the message first time we're called.
 169             return;
 170         }
 171     }
 172
 173     my @new_message_list = ();
 174     foreach my $message (@{$proxy->message_list}) {
 175         push @new_message_list, $message;
 176         if ($message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
 177             $message->set_extension(TLSProxy::Message::EXT_SESSION_TICKET, "");
 178             $message->repack();
 179             # Tack NewSessionTicket onto the ServerHello record.
 180             # This only works if the ServerHello is exactly one record.
 181             my $record = ${$message->records}[0];
 182
 183             my $offset = $message->startoffset + $message->encoded_length;
 184             my $newsessionticket = TLSProxy::NewSessionTicket->new(
 185                 1, "", [$record], $offset, []);
 186             $newsessionticket->repack();
 187             push @new_message_list, $newsessionticket;
 188         }
 189     }
 190     $proxy->message_list([@new_message_list]);
 191 }
 192
 193 sub inject_ticket_extension_filter
 194 {
 195     my $proxy = shift;
 196
 197     # We're only interested in the initial ServerHello
 198     if ($proxy->flight != 1) {
 199         return;
 200     }
 201
 202     foreach my $message (@{$proxy->message_list}) {
 203         if ($message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
 204             #Add the session ticket extension to the ServerHello even though
 205             #we are not going to send a NewSessionTicket message
 206             $message->set_extension(TLSProxy::Message::EXT_SESSION_TICKET, "");
 207
 208             $message->repack();
 209         }
 210     }
 211 }
 212
 213 sub checkmessages($$$$$$)
 214 {
 215     my ($testno, $testname, $testch, $testsh, $testtickseen, $testhand) = @_;
 216
 217     subtest $testname => sub {
 218
 219         foreach my $message (@{$proxy->message_list}) {
 220             if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO
 221                 || $message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
 222                 #Get the extensions data
 223                 my %extensions = %{$message->extension_data};
 224                 if (defined
 225                     $extensions{TLSProxy::Message::EXT_SESSION_TICKET}) {
 226                     if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
 227                         $chellotickext = 1;
 228                     } else {
 229                         $shellotickext = 1;
 230                     }
 231                 }
 232             } elsif ($message->mt == TLSProxy::Message::MT_CLIENT_KEY_EXCHANGE) {
 233                 #Must be doing a full handshake
 234                 $fullhand = 1;
 235             } elsif ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
 236                 $ticketseen = 1;
 237             }
 238         }
 239
 240         plan tests => 5;
 241
 242         ok(TLSProxy::Message->success, "Handshake");
 243         ok(($testch && $chellotickext) || (!$testch && !$chellotickext),
 244            "ClientHello extension Session Ticket check");
 245         ok(($testsh && $shellotickext) || (!$testsh && !$shellotickext),
 246            "ServerHello extension Session Ticket check");
 247         ok(($testtickseen && $ticketseen) || (!$testtickseen && !$ticketseen),
 248            "Session Ticket message presence check");
 249         ok(($testhand && $fullhand) || (!$testhand && !$fullhand),
 250            "Session Ticket full handshake check");
 251     }
 252 }
 253
 254
 255 sub clearclient()
 256 {
 257     $chellotickext = 0;
 258     $shellotickext = 0;
 259     $fullhand = 0;
 260     $ticketseen = 0;
 261     $proxy->clearClient();
 262 }
 263
 264 sub clearall()
 265 {
 266     clearclient();
 267     $proxy->clear();
 268 }