test/ssl_test.c

   1 /*
   2  * Copyright 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
  10 #include <stdio.h>
  11 #include <string.h>
  12
  13 #include <openssl/conf.h>
  14 #include <openssl/err.h>
  15 #include <openssl/ssl.h>
  16
  17 #include "handshake_helper.h"
  18 #include "ssl_test_ctx.h"
  19 #include "testutil.h"
  20
  21 static CONF *conf = NULL;
  22
  23 /* Currently the section names are of the form test-<number>, e.g. test-15. */
  24 #define MAX_TESTCASE_NAME_LENGTH 100
  25
  26 typedef struct ssl_test_ctx_test_fixture {
  27     const char *test_case_name;
  28     char test_app[MAX_TESTCASE_NAME_LENGTH];
  29 } SSL_TEST_FIXTURE;
  30
  31 static SSL_TEST_FIXTURE set_up(const char *const test_case_name)
  32 {
  33     SSL_TEST_FIXTURE fixture;
  34     fixture.test_case_name = test_case_name;
  35     return fixture;
  36 }
  37
  38 static const char *print_alert(int alert)
  39 {
  40     return alert ? SSL_alert_desc_string_long(alert) : "no alert";
  41 }
  42
  43 static int check_result(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
  44 {
  45     if (result->result != test_ctx->expected_result) {
  46         fprintf(stderr, "ExpectedResult mismatch: expected %s, got %s.\n",
  47                 ssl_test_result_name(test_ctx->expected_result),
  48                 ssl_test_result_name(result->result));
  49         return 0;
  50     }
  51     return 1;
  52 }
  53
  54 static int check_alerts(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
  55 {
  56     if (result->client_alert_sent != result->client_alert_received) {
  57         fprintf(stderr, "Client sent alert %s but server received %s\n.",
  58                 print_alert(result->client_alert_sent),
  59                 print_alert(result->client_alert_received));
  60         /*
  61          * We can't bail here because the peer doesn't always get far enough
  62          * to process a received alert. Specifically, in protocol version
  63          * negotiation tests, we have the following scenario.
  64          * Client supports TLS v1.2 only; Server supports TLS v1.1.
  65          * Client proposes TLS v1.2; server responds with 1.1;
  66          * Client now sends a protocol alert, using TLS v1.2 in the header.
  67          * The server, however, rejects the alert because of version mismatch
  68          * in the record layer; therefore, the server appears to never
  69          * receive the alert.
  70          */
  71         /* return 0; */
  72     }
  73
  74     if (result->server_alert_sent != result->server_alert_received) {
  75         fprintf(stderr, "Server sent alert %s but client received %s\n.",
  76                 print_alert(result->server_alert_sent),
  77                 print_alert(result->server_alert_received));
  78         /* return 0; */
  79     }
  80
  81     /* Tolerate an alert if one wasn't explicitly specified in the test. */
  82     if (test_ctx->client_alert
  83         /*
  84          * The info callback alert value is computed as
  85          * (s->s3->send_alert[0] << 8) | s->s3->send_alert[1]
  86          * where the low byte is the alert code and the high byte is other stuff.
  87          */
  88         && (result->client_alert_sent & 0xff) != test_ctx->client_alert) {
  89         fprintf(stderr, "ClientAlert mismatch: expected %s, got %s.\n",
  90                 print_alert(test_ctx->client_alert),
  91                 print_alert(result->client_alert_sent));
  92         return 0;
  93     }
  94
  95     if (test_ctx->server_alert
  96         && (result->server_alert_sent & 0xff) != test_ctx->server_alert) {
  97         fprintf(stderr, "ServerAlert mismatch: expected %s, got %s.\n",
  98                 print_alert(test_ctx->server_alert),
  99                 print_alert(result->server_alert_sent));
 100         return 0;
 101     }
 102
 103     return 1;
 104 }
 105
 106 static int check_protocol(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
 107 {
 108     if (result->client_protocol != result->server_protocol) {
 109         fprintf(stderr, "Client has protocol %s but server has %s\n.",
 110                 ssl_protocol_name(result->client_protocol),
 111                 ssl_protocol_name(result->server_protocol));
 112         return 0;
 113     }
 114
 115     if (test_ctx->protocol) {
 116         if (result->client_protocol != test_ctx->protocol) {
 117             fprintf(stderr, "Protocol mismatch: expected %s, got %s.\n",
 118                     ssl_protocol_name(test_ctx->protocol),
 119                     ssl_protocol_name(result->client_protocol));
 120             return 0;
 121         }
 122     }
 123     return 1;
 124 }
 125
 126 static int check_servername(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
 127 {
 128     if (result->servername != test_ctx->expected_servername) {
 129       fprintf(stderr, "Client ServerName mismatch, expected %s, got %s\n.",
 130               ssl_servername_name(test_ctx->expected_servername),
 131               ssl_servername_name(result->servername));
 132       return 0;
 133     }
 134   return 1;
 135 }
 136
 137 static int check_session_ticket(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
 138 {
 139     if (test_ctx->session_ticket_expected == SSL_TEST_SESSION_TICKET_IGNORE)
 140         return 1;
 141     if (test_ctx->session_ticket_expected == SSL_TEST_SESSION_TICKET_BROKEN &&
 142         result->session_ticket == SSL_TEST_SESSION_TICKET_NO)
 143         return 1;
 144     if (result->session_ticket != test_ctx->session_ticket_expected) {
 145         fprintf(stderr, "Client SessionTicketExpected mismatch, expected %s, got %s\n.",
 146                 ssl_session_ticket_name(test_ctx->session_ticket_expected),
 147                 ssl_session_ticket_name(result->session_ticket));
 148         return 0;
 149     }
 150     return 1;
 151 }
 152
 153 static int check_npn(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
 154 {
 155     int ret = 1;
 156     ret &= strings_equal("NPN Negotiated (client vs server)",
 157                          result->client_npn_negotiated,
 158                          result->server_npn_negotiated);
 159     ret &= strings_equal("ExpectedNPNProtocol",
 160                          test_ctx->expected_npn_protocol,
 161                          result->client_npn_negotiated);
 162     return ret;
 163 }
 164
 165 static int check_alpn(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
 166 {
 167     int ret = 1;
 168     ret &= strings_equal("ALPN Negotiated (client vs server)",
 169                          result->client_alpn_negotiated,
 170                          result->server_alpn_negotiated);
 171     ret &= strings_equal("ExpectedALPNProtocol",
 172                          test_ctx->expected_alpn_protocol,
 173                          result->client_alpn_negotiated);
 174     return ret;
 175 }
 176
 177 static int check_resumption(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
 178 {
 179     if (result->client_resumed != result->server_resumed) {
 180         fprintf(stderr, "Resumption mismatch (client vs server): %d vs %d\n",
 181                 result->client_resumed, result->server_resumed);
 182         return 0;
 183     }
 184     if (result->client_resumed != test_ctx->resumption_expected) {
 185         fprintf(stderr, "ResumptionExpected mismatch: %d vs %d\n",
 186                 test_ctx->resumption_expected, result->client_resumed);
 187         return 0;
 188     }
 189     return 1;
 190 }
 191
 192 /*
 193  * This could be further simplified by constructing an expected
 194  * HANDSHAKE_RESULT, and implementing comparison methods for
 195  * its fields.
 196  */
 197 static int check_test(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
 198 {
 199     int ret = 1;
 200     ret &= check_result(result, test_ctx);
 201     ret &= check_alerts(result, test_ctx);
 202     if (result->result == SSL_TEST_SUCCESS) {
 203         ret &= check_protocol(result, test_ctx);
 204         ret &= check_servername(result, test_ctx);
 205         ret &= check_session_ticket(result, test_ctx);
 206         ret &= (result->session_ticket_do_not_call == 0);
 207         ret &= check_npn(result, test_ctx);
 208         ret &= check_alpn(result, test_ctx);
 209         ret &= check_resumption(result, test_ctx);
 210     }
 211     return ret;
 212 }
 213
 214 static int execute_test(SSL_TEST_FIXTURE fixture)
 215 {
 216     int ret = 0;
 217     SSL_CTX *server_ctx = NULL, *server2_ctx = NULL, *client_ctx = NULL,
 218         *resume_server_ctx = NULL, *resume_client_ctx = NULL;
 219     SSL_TEST_CTX *test_ctx = NULL;
 220     HANDSHAKE_RESULT *result = NULL;
 221
 222     test_ctx = SSL_TEST_CTX_create(conf, fixture.test_app);
 223     if (test_ctx == NULL)
 224         goto err;
 225
 226 #ifndef OPENSSL_NO_DTLS
 227     if (test_ctx->method == SSL_TEST_METHOD_DTLS) {
 228         server_ctx = SSL_CTX_new(DTLS_server_method());
 229         if (test_ctx->servername_callback != SSL_TEST_SERVERNAME_CB_NONE) {
 230             server2_ctx = SSL_CTX_new(DTLS_server_method());
 231             OPENSSL_assert(server2_ctx != NULL);
 232         }
 233         client_ctx = SSL_CTX_new(DTLS_client_method());
 234         if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RESUME) {
 235             resume_server_ctx = SSL_CTX_new(DTLS_server_method());
 236             resume_client_ctx = SSL_CTX_new(DTLS_client_method());
 237             OPENSSL_assert(resume_server_ctx != NULL);
 238             OPENSSL_assert(resume_client_ctx != NULL);
 239         }
 240     }
 241 #endif
 242     if (test_ctx->method == SSL_TEST_METHOD_TLS) {
 243         server_ctx = SSL_CTX_new(TLS_server_method());
 244         if (test_ctx->servername_callback != SSL_TEST_SERVERNAME_CB_NONE) {
 245             server2_ctx = SSL_CTX_new(TLS_server_method());
 246             OPENSSL_assert(server2_ctx != NULL);
 247         }
 248         client_ctx = SSL_CTX_new(TLS_client_method());
 249
 250         if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RESUME) {
 251             resume_server_ctx = SSL_CTX_new(TLS_server_method());
 252             resume_client_ctx = SSL_CTX_new(TLS_client_method());
 253             OPENSSL_assert(resume_server_ctx != NULL);
 254             OPENSSL_assert(resume_client_ctx != NULL);
 255         }
 256     }
 257
 258     OPENSSL_assert(server_ctx != NULL);
 259     OPENSSL_assert(client_ctx != NULL);
 260
 261     OPENSSL_assert(CONF_modules_load(conf, fixture.test_app, 0) > 0);
 262
 263     if (!SSL_CTX_config(server_ctx, "server")
 264         || !SSL_CTX_config(client_ctx, "client")) {
 265         goto err;
 266     }
 267
 268     if (server2_ctx != NULL && !SSL_CTX_config(server2_ctx, "server2"))
 269         goto err;
 270     if (resume_server_ctx != NULL
 271         && !SSL_CTX_config(resume_server_ctx, "resume-server"))
 272         goto err;
 273     if (resume_client_ctx != NULL
 274         && !SSL_CTX_config(resume_client_ctx, "resume-client"))
 275         goto err;
 276
 277     result = do_handshake(server_ctx, server2_ctx, client_ctx,
 278                           resume_server_ctx, resume_client_ctx, test_ctx);
 279
 280     ret = check_test(result, test_ctx);
 281
 282 err:
 283     CONF_modules_unload(0);
 284     SSL_CTX_free(server_ctx);
 285     SSL_CTX_free(server2_ctx);
 286     SSL_CTX_free(client_ctx);
 287     SSL_CTX_free(resume_server_ctx);
 288     SSL_CTX_free(resume_client_ctx);
 289     SSL_TEST_CTX_free(test_ctx);
 290     if (ret != 1)
 291         ERR_print_errors_fp(stderr);
 292     HANDSHAKE_RESULT_free(result);
 293     return ret;
 294 }
 295
 296 static void tear_down(SSL_TEST_FIXTURE fixture)
 297 {
 298 }
 299
 300 #define SETUP_SSL_TEST_FIXTURE()                        \
 301     SETUP_TEST_FIXTURE(SSL_TEST_FIXTURE, set_up)
 302 #define EXECUTE_SSL_TEST()             \
 303     EXECUTE_TEST(execute_test, tear_down)
 304
 305 static int test_handshake(int idx)
 306 {
 307     SETUP_SSL_TEST_FIXTURE();
 308     BIO_snprintf(fixture.test_app, sizeof(fixture.test_app),
 309                  "test-%d", idx);
 310     EXECUTE_SSL_TEST();
 311 }
 312
 313 int main(int argc, char **argv)
 314 {
 315     int result = 0;
 316     long num_tests;
 317
 318     if (argc != 2)
 319         return 1;
 320
 321     conf = NCONF_new(NULL);
 322     OPENSSL_assert(conf != NULL);
 323
 324     /* argv[1] should point to the test conf file */
 325     OPENSSL_assert(NCONF_load(conf, argv[1], NULL) > 0);
 326
 327     OPENSSL_assert(NCONF_get_number_e(conf, NULL, "num_tests", &num_tests));
 328
 329     ADD_ALL_TESTS(test_handshake, (int)(num_tests));
 330     result = run_tests(argv[0]);
 331
 332     return result;
 333 }