Add more extension tests to test_sslmessages
[openssl.git] / test / recipes / 70-test_tls13messages.t
index c64e54e6f8b9313edf5a7968e4c61405983c028f..5bd5f7ad30c12c66117aa348120cafd8089fe62b 100755 (executable)
@@ -7,12 +7,22 @@
 # https://www.openssl.org/source/license.html
 
 use strict;
-use OpenSSL::Test qw/:DEFAULT cmdstr srctop_file bldtop_dir/;
+use OpenSSL::Test qw/:DEFAULT cmdstr srctop_file srctop_dir bldtop_dir/;
 use OpenSSL::Test::Utils;
 use File::Temp qw(tempfile);
 use TLSProxy::Proxy;
-my $test_name = "test_tls13messages";
-setup($test_name);
+
+my $test_name;
+
+# This block needs to run before 'use lib srctop_dir' directives.
+BEGIN {
+    $test_name = "test_tls13messages";
+    OpenSSL::Test::setup($test_name);
+}
+
+use lib srctop_dir("test", "recipes");
+
+use recipes::checkhandshake qw(checkhandshake @handmessages @extensions);
 
 plan skip_all => "TLSProxy isn't usable on $^O"
     if $^O =~ /^(VMS|MSWin32)$/;
@@ -27,29 +37,71 @@ plan skip_all => "$test_name needs TLSv1.3 enabled"
     if disabled("tls1_3");
 
 $ENV{OPENSSL_ia32cap} = '~0x200000200000000';
-
-use constant {
-    DEFAULT_HANDSHAKE => 1,
-    OCSP_HANDSHAKE => 2,
-    RESUME_HANDSHAKE => 4,
-    CLIENT_AUTH_HANDSHAKE => 8,
-    ALL_HANDSHAKES => 15
-};
-
-my @handmessages = (
-    [TLSProxy::Message::MT_CLIENT_HELLO, ALL_HANDSHAKES],
-    [TLSProxy::Message::MT_SERVER_HELLO, ALL_HANDSHAKES],
-    [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS, ALL_HANDSHAKES],
-    [TLSProxy::Message::MT_CERTIFICATE_REQUEST, CLIENT_AUTH_HANDSHAKE],
-    [TLSProxy::Message::MT_CERTIFICATE, ALL_HANDSHAKES & ~RESUME_HANDSHAKE],
-    [TLSProxy::Message::MT_CERTIFICATE_STATUS, OCSP_HANDSHAKE],
-    [TLSProxy::Message::MT_FINISHED, ALL_HANDSHAKES],
-    [TLSProxy::Message::MT_CERTIFICATE, CLIENT_AUTH_HANDSHAKE],
-    [TLSProxy::Message::MT_CERTIFICATE_VERIFY, CLIENT_AUTH_HANDSHAKE],
-    [TLSProxy::Message::MT_FINISHED, ALL_HANDSHAKES],
+$ENV{CTLOG_FILE} = srctop_file("test", "ct", "log_list.conf");
+
+
+@handmessages = (
+    [TLSProxy::Message::MT_CLIENT_HELLO,
+        recipes::checkhandshake::ALL_HANDSHAKES],
+    [TLSProxy::Message::MT_SERVER_HELLO,
+        recipes::checkhandshake::ALL_HANDSHAKES],
+    [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS,
+        recipes::checkhandshake::ALL_HANDSHAKES],
+    [TLSProxy::Message::MT_CERTIFICATE_REQUEST,
+        recipes::checkhandshake::CLIENT_AUTH_HANDSHAKE],
+    [TLSProxy::Message::MT_CERTIFICATE,
+        recipes::checkhandshake::ALL_HANDSHAKES & ~recipes::checkhandshake::RESUME_HANDSHAKE],
+    [TLSProxy::Message::MT_CERTIFICATE_STATUS,
+        recipes::checkhandshake::OCSP_HANDSHAKE],
+    [TLSProxy::Message::MT_FINISHED,
+        recipes::checkhandshake::ALL_HANDSHAKES],
+    [TLSProxy::Message::MT_CERTIFICATE,
+        recipes::checkhandshake::CLIENT_AUTH_HANDSHAKE],
+    [TLSProxy::Message::MT_CERTIFICATE_VERIFY,
+        recipes::checkhandshake::CLIENT_AUTH_HANDSHAKE],
+    [TLSProxy::Message::MT_FINISHED,
+        recipes::checkhandshake::ALL_HANDSHAKES],
     [0, 0]
 );
 
+@extensions = (
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SERVER_NAME,
+        recipes::checkhandshake::SERVER_NAME_CLI_EXTENSION],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_STATUS_REQUEST,
+        recipes::checkhandshake::STATUS_REQUEST_CLI_EXTENSION],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_GROUPS,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EC_POINT_FORMATS,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SIG_ALGS,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ALPN,
+        recipes::checkhandshake::ALPN_CLI_EXTENSION],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SCT,
+        recipes::checkhandshake::SCT_CLI_EXTENSION],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_ENCRYPT_THEN_MAC,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_EXTENDED_MASTER_SECRET,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SESSION_TICKET,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+    [TLSProxy::Message::MT_CLIENT_HELLO, TLSProxy::Message::EXT_SUPPORTED_VERSIONS,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+
+    [TLSProxy::Message::MT_SERVER_HELLO, TLSProxy::Message::EXT_KEY_SHARE,
+        recipes::checkhandshake::DEFAULT_EXTENSIONS],
+
+    [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS, TLSProxy::Message::EXT_SERVER_NAME,
+        recipes::checkhandshake::SERVER_NAME_SRV_EXTENSION],
+    [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS, TLSProxy::Message::EXT_STATUS_REQUEST,
+        recipes::checkhandshake::STATUS_REQUEST_SRV_EXTENSION],
+    [TLSProxy::Message::MT_ENCRYPTED_EXTENSIONS, TLSProxy::Message::EXT_ALPN,
+        recipes::checkhandshake::ALPN_SRV_EXTENSION],
+    [0,0,0]
+);
+
 my $proxy = TLSProxy::Proxy->new(
     undef,
     cmdstr(app(["openssl"]), display => 1),
@@ -57,15 +109,15 @@ my $proxy = TLSProxy::Proxy->new(
     (!$ENV{HARNESS_ACTIVE} || $ENV{HARNESS_VERBOSE})
 );
 
-sub checkmessages($$);
-
 #Test 1: Check we get all the right messages for a default handshake
 (undef, my $session) = tempfile();
 #$proxy->serverconnects(2);
 $proxy->clientflags("-sess_out ".$session);
 $proxy->start() or plan skip_all => "Unable to start up Proxy for tests";
-plan tests => 3;
-checkmessages(DEFAULT_HANDSHAKE, "Default handshake test");
+plan tests => 12;
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+               recipes::checkhandshake::DEFAULT_EXTENSIONS,
+               "Default handshake test");
 
 #TODO(TLS1.3): Test temporarily disabled until we implement TLS1.3 resumption
 #Test 2: Resumption handshake
@@ -75,7 +127,25 @@ checkmessages(DEFAULT_HANDSHAKE, "Default handshake test");
 #checkmessages(RESUME_HANDSHAKE, "Resumption handshake test");
 unlink $session;
 
-#Test 3: A default handshake, but with a CertificateStatus message
+#Test 3: A status_request handshake (client request only)
+$proxy->clear();
+$proxy->clientflags("-status");
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+              recipes::checkhandshake::DEFAULT_EXTENSIONS
+              | recipes::checkhandshake::STATUS_REQUEST_CLI_EXTENSION,
+              "status_request handshake test (client)");
+
+#Test 4: A status_request handshake (server support only)
+$proxy->clear();
+$proxy->serverflags("-status_file "
+                    .srctop_file("test", "recipes", "ocsp-response.der"));
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+               recipes::checkhandshake::DEFAULT_EXTENSIONS,
+              "status_request handshake test (server)");
+
+#Test 5: A status_request handshake (client and server)
 #TODO(TLS1.3): TLS1.3 doesn't actually have CertificateStatus messages. This is
 #a temporary test until such time as we do proper TLS1.3 style certificate
 #status
@@ -84,42 +154,93 @@ $proxy->clientflags("-status");
 $proxy->serverflags("-status_file "
                     .srctop_file("test", "recipes", "ocsp-response.der"));
 $proxy->start();
-checkmessages(OCSP_HANDSHAKE, "OCSP handshake test");
+checkhandshake($proxy, recipes::checkhandshake::OCSP_HANDSHAKE,
+              recipes::checkhandshake::DEFAULT_EXTENSIONS
+              | recipes::checkhandshake::STATUS_REQUEST_CLI_EXTENSION
+              | recipes::checkhandshake::STATUS_REQUEST_SRV_EXTENSION,
+              "status_request handshake test");
 
-#Test 4: A client auth handshake
+#Test 6: A client auth handshake
 $proxy->clear();
 $proxy->clientflags("-cert ".srctop_file("apps", "server.pem"));
 $proxy->serverflags("-Verify 5");
 $proxy->start();
-checkmessages(CLIENT_AUTH_HANDSHAKE, "Client auth handshake test");
-
-sub checkmessages($$)
-{
-    my ($handtype, $testname) = @_;
-
-    subtest $testname => sub {
-        my $loop = 0;
-        my $numtests;
-
-        #First count the number of tests
-        for ($numtests = 1; $handmessages[$loop][1] != 0; $loop++) {
-            $numtests++ if (($handmessages[$loop][1] & $handtype) != 0);
-        }
-
-        plan tests => $numtests;
-
-        $loop = 0;
-        foreach my $message (@{$proxy->message_list}) {
-            for (; $handmessages[$loop][1] != 0
-                   && ($handmessages[$loop][1] & $handtype) == 0; $loop++) {
-                next;
-            }
-            ok($handmessages[$loop][1] != 0
-               && $message->mt == $handmessages[$loop][0],
-               "Message type check. Got ".$message->mt
-               .", expected ".$handmessages[$loop][0]);
-            $loop++;
-        }
-        ok($handmessages[$loop][1] == 0, "All expected messages processed");
-    }
-}
+checkhandshake($proxy, recipes::checkhandshake::CLIENT_AUTH_HANDSHAKE,
+               recipes::checkhandshake::DEFAULT_EXTENSIONS,
+              "Client auth handshake test");
+
+#Test 7: Server name handshake (client request only)
+$proxy->clear();
+$proxy->clientflags("-servername testhost");
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+               recipes::checkhandshake::DEFAULT_EXTENSIONS
+               | recipes::checkhandshake::SERVER_NAME_CLI_EXTENSION,
+              "Server name handshake test (client)");
+
+#Test 8: Server name handshake (server support only)
+$proxy->clear();
+$proxy->serverflags("-servername testhost");
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+               recipes::checkhandshake::DEFAULT_EXTENSIONS,
+              "Server name handshake test (server)");
+
+#Test 9: Server name handshake (client and server)
+$proxy->clear();
+$proxy->clientflags("-servername testhost");
+$proxy->serverflags("-servername testhost");
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+              recipes::checkhandshake::DEFAULT_EXTENSIONS
+              | recipes::checkhandshake::SERVER_NAME_CLI_EXTENSION
+              | recipes::checkhandshake::SERVER_NAME_SRV_EXTENSION,
+              "Server name handshake test");
+
+#Test 10: ALPN handshake (client request only)
+$proxy->clear();
+$proxy->clientflags("-alpn test");
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+               recipes::checkhandshake::DEFAULT_EXTENSIONS
+               | recipes::checkhandshake::ALPN_CLI_EXTENSION,
+              "ALPN handshake test (client)");
+
+#Test 11: ALPN handshake (server support only)
+$proxy->clear();
+$proxy->serverflags("-alpn test");
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+               recipes::checkhandshake::DEFAULT_EXTENSIONS,
+              "ALPN handshake test (server)");
+              
+#Test 12: ALPN handshake (client and server)
+$proxy->clear();
+$proxy->clientflags("-alpn test");
+$proxy->serverflags("-alpn test");
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::DEFAULT_HANDSHAKE,
+              recipes::checkhandshake::DEFAULT_EXTENSIONS
+              | recipes::checkhandshake::ALPN_CLI_EXTENSION
+              | recipes::checkhandshake::ALPN_SRV_EXTENSION,
+              "ALPN handshake test");
+
+#Test 13: SCT handshake (client request only)
+#TODO(TLS1.3): This only checks that the client side extension appears. The
+#SCT extension is unusual in that we have no built-in server side implementation
+#The server side implementation can nomrally be added using the custom
+#extensions framework (e.g. by using the "-serverinfo" s_server option). However
+#currently we only support <= TLS1.2 for custom extensions because the existing
+#framework and API has no knowledge of the TLS1.3 messages
+$proxy->clear();
+#Note: -ct also sends status_request
+$proxy->clientflags("-ct");
+$proxy->serverflags("-status_file "
+                    .srctop_file("test", "recipes", "ocsp-response.der"));
+$proxy->start();
+checkhandshake($proxy, recipes::checkhandshake::OCSP_HANDSHAKE,
+              recipes::checkhandshake::DEFAULT_EXTENSIONS
+              | recipes::checkhandshake::SCT_CLI_EXTENSION
+              | recipes::checkhandshake::STATUS_REQUEST_CLI_EXTENSION
+              | recipes::checkhandshake::STATUS_REQUEST_SRV_EXTENSION,
+              "SCT handshake test");