[thirdparty/openssl.git] / test / recipes / 70-test_sslsessiontick.t

#! /usr/bin/env perl
# Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
#
# Licensed under the OpenSSL license (the "License").  You may not use
# this file except in compliance with the License.  You can obtain a copy
# in the file LICENSE in the source distribution or at
# https://www.openssl.org/source/license.html

use strict;
use OpenSSL::Test qw/:DEFAULT cmdstr srctop_file bldtop_dir/;
use OpenSSL::Test::Utils;
use TLSProxy::Proxy;
use File::Temp qw(tempfile);

my $test_name = "test_sslsessiontick";
setup($test_name);

plan skip_all => "TLSProxy isn't usable on $^O"
    if $^O =~ /^(VMS)$/;

plan skip_all => "$test_name needs the dynamic engine feature enabled"
    if disabled("engine") || disabled("dynamic-engine");

plan skip_all => "$test_name needs the sock feature enabled"
    if disabled("sock");

plan skip_all => "$test_name needs SSLv3, TLSv1, TLSv1.1 or TLSv1.2 enabled"
    if alldisabled(("ssl3", "tls1", "tls1_1", "tls1_2"));

$ENV{OPENSSL_ia32cap} = '~0x200000200000000';

sub checkmessages($$$$$$);
sub clearclient();
sub clearall();

my $chellotickext = 0;
my $shellotickext = 0;
my $fullhand = 0;
my $ticketseen = 0;

my $proxy = TLSProxy::Proxy->new(
    undef,
    cmdstr(app(["openssl"]), display => 1),
    srctop_file("apps", "server.pem"),
    (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
);

#Test 1: By default with no existing session we should get a session ticket
#Expected result: ClientHello extension seen; ServerHello extension seen
#                 NewSessionTicket message seen; Full handshake
$proxy->clientflags("-no_tls1_3");
$proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
plan tests => 10;
checkmessages(1, "Default session ticket test", 1, 1, 1, 1);

#Test 2: If the server does not accept tickets we should get a normal handshake
#with no session tickets
#Expected result: ClientHello extension seen; ServerHello extension not seen
#                 NewSessionTicket message not seen; Full handshake
clearall();
$proxy->clientflags("-no_tls1_3");
$proxy->serverflags("-no_ticket");
$proxy->start();
checkmessages(2, "No server support session ticket test", 1, 0, 0, 1);

#Test 3: If the client does not accept tickets we should get a normal handshake
#with no session tickets
#Expected result: ClientHello extension not seen; ServerHello extension not seen
#                 NewSessionTicket message not seen; Full handshake
clearall();
$proxy->clientflags("-no_tls1_3 -no_ticket");
$proxy->start();
checkmessages(3, "No client support session ticket test", 0, 0, 0, 1);

#Test 4: Test session resumption with session ticket
#Expected result: ClientHello extension seen; ServerHello extension not seen
#                 NewSessionTicket message not seen; Abbreviated handshake
clearall();
(undef, my $session) = tempfile();
$proxy->serverconnects(2);
$proxy->clientflags("-no_tls1_3 -sess_out ".$session);
$proxy->start();
$proxy->clearClient();
$proxy->clientflags("-no_tls1_3 -sess_in ".$session);
$proxy->clientstart();
checkmessages(4, "Session resumption session ticket test", 1, 0, 0, 0);
unlink $session;

#Test 5: Test session resumption with ticket capable client without a ticket
#Expected result: ClientHello extension seen; ServerHello extension seen
#                 NewSessionTicket message seen; Abbreviated handshake
clearall();
(undef, $session) = tempfile();
$proxy->serverconnects(2);
$proxy->clientflags("-no_tls1_3 -sess_out ".$session." -no_ticket");
$proxy->start();
$proxy->clearClient();
$proxy->clientflags("-no_tls1_3 -sess_in ".$session);
$proxy->clientstart();
checkmessages(5, "Session resumption with ticket capable client without a "
                 ."ticket", 1, 1, 1, 0);
unlink $session;

#Test 6: Client accepts empty ticket.
#Expected result: ClientHello extension seen; ServerHello extension seen;
#                 NewSessionTicket message seen; Full handshake.
clearall();
$proxy->filter(\&ticket_filter);
$proxy->clientflags("-no_tls1_3");
$proxy->start();
checkmessages(6, "Empty ticket test",  1, 1, 1, 1);

#Test 7-8: Client keeps existing ticket on empty ticket.
clearall();
(undef, $session) = tempfile();
$proxy->serverconnects(3);
$proxy->filter(undef);
$proxy->clientflags("-no_tls1_3 -sess_out ".$session);
$proxy->start();
$proxy->clearClient();
$proxy->clientflags("-no_tls1_3 -sess_in ".$session." -sess_out ".$session);
$proxy->filter(\&inject_empty_ticket_filter);
$proxy->clientstart();
#Expected result: ClientHello extension seen; ServerHello extension seen;
#                 NewSessionTicket message seen; Abbreviated handshake.
checkmessages(7, "Empty ticket resumption test",  1, 1, 1, 0);
clearclient();
$proxy->clientflags("-no_tls1_3 -sess_in ".$session);
$proxy->filter(undef);
$proxy->clientstart();
#Expected result: ClientHello extension seen; ServerHello extension not seen;
#                 NewSessionTicket message not seen; Abbreviated handshake.
checkmessages(8, "Empty ticket resumption test",  1, 0, 0, 0);
unlink $session;

#Test 9: Bad server sends the ServerHello extension but does not send a
#NewSessionTicket
#Expected result: Connection failure
clearall();
$proxy->clientflags("-no_tls1_3");
$proxy->serverflags("-no_ticket");
$proxy->filter(\&inject_ticket_extension_filter);
$proxy->start();
ok(TLSProxy::Message->fail, "Server sends ticket extension but no ticket test");

#Test10: Bad server does not send the ServerHello extension but does send a
#NewSessionTicket
#Expected result: Connection failure
clearall();
$proxy->clientflags("-no_tls1_3");
$proxy->serverflags("-no_ticket");
$proxy->filter(\&inject_empty_ticket_filter);
$proxy->start();
ok(TLSProxy::Message->fail, "No server ticket extension but ticket sent test");

sub ticket_filter
{
    my $proxy = shift;

    foreach my $message (@{$proxy->message_list}) {
        if ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
            $message->ticket("");
            $message->repack();
        }
    }
}

sub inject_empty_ticket_filter {
    my $proxy = shift;

    foreach my $message (@{$proxy->message_list}) {
        if ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
            # Only inject the message first time we're called.
            return;
        }
    }

    my @new_message_list = ();
    foreach my $message (@{$proxy->message_list}) {
        push @new_message_list, $message;
        if ($message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
            $message->set_extension(TLSProxy::Message::EXT_SESSION_TICKET, "");
            $message->repack();
            # Tack NewSessionTicket onto the ServerHello record.
            # This only works if the ServerHello is exactly one record.
            my $record = ${$message->records}[0];

            my $offset = $message->startoffset + $message->encoded_length;
            my $newsessionticket = TLSProxy::NewSessionTicket->new(
                1, "", [$record], $offset, []);
            $newsessionticket->repack();
            push @new_message_list, $newsessionticket;
        }
    }
    $proxy->message_list([@new_message_list]);
}

sub inject_ticket_extension_filter
{
    my $proxy = shift;

    # We're only interested in the initial ServerHello
    if ($proxy->flight != 1) {
        return;
    }

    foreach my $message (@{$proxy->message_list}) {
        if ($message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
            #Add the session ticket extension to the ServerHello even though
            #we are not going to send a NewSessionTicket message
            $message->set_extension(TLSProxy::Message::EXT_SESSION_TICKET, "");

            $message->repack();
        }
    }
}

sub checkmessages($$$$$$)
{
    my ($testno, $testname, $testch, $testsh, $testtickseen, $testhand) = @_;

    subtest $testname => sub {

	foreach my $message (@{$proxy->message_list}) {
	    if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO
                || $message->mt == TLSProxy::Message::MT_SERVER_HELLO) {
		#Get the extensions data
		my %extensions = %{$message->extension_data};
		if (defined
                    $extensions{TLSProxy::Message::EXT_SESSION_TICKET}) {
		    if ($message->mt == TLSProxy::Message::MT_CLIENT_HELLO) {
			$chellotickext = 1;
		    } else {
			$shellotickext = 1;
		    }
		}
	    } elsif ($message->mt == TLSProxy::Message::MT_CERTIFICATE) {
		#Must be doing a full handshake
		$fullhand = 1;
	    } elsif ($message->mt == TLSProxy::Message::MT_NEW_SESSION_TICKET) {
		$ticketseen = 1;
	    }
	}

	plan tests => 5;

	ok(TLSProxy::Message->success, "Handshake");
	ok(($testch && $chellotickext) || (!$testch && !$chellotickext),
	   "ClientHello extension Session Ticket check");
	ok(($testsh && $shellotickext) || (!$testsh && !$shellotickext),
	   "ServerHello extension Session Ticket check");
	ok(($testtickseen && $ticketseen) || (!$testtickseen && !$ticketseen),
	   "Session Ticket message presence check");
	ok(($testhand && $fullhand) || (!$testhand && !$fullhand),
	   "Session Ticket full handshake check");
    }
}


sub clearclient()
{
    $chellotickext = 0;
    $shellotickext = 0;
    $fullhand = 0;
    $ticketseen = 0;
    $proxy->clearClient();
}

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