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->servername) {
 129         fprintf(stderr, "Client ServerName mismatch, expected %s, got %s\n.",
 130                 ssl_servername_name(test_ctx->servername),
 131                 ssl_servername_name(result.servername));
 132         return 0;
 133     }
 134     return 1;
 135 }
 136
 137 static int check_session_ticket_expected(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_expected_name(test_ctx->session_ticket_expected),
 147                 ssl_session_ticket_expected_name(result.session_ticket));
 148         return 0;
 149     }
 150     return 1;
 151 }
 152
 153 /*
 154  * This could be further simplified by constructing an expected
 155  * HANDSHAKE_RESULT, and implementing comparison methods for
 156  * its fields.
 157  */
 158 static int check_test(HANDSHAKE_RESULT result, SSL_TEST_CTX *test_ctx)
 159 {
 160     int ret = 1;
 161     ret &= check_result(result, test_ctx);
 162     ret &= check_alerts(result, test_ctx);
 163     if (result.result == SSL_TEST_SUCCESS) {
 164         ret &= check_protocol(result, test_ctx);
 165         ret &= check_servername(result, test_ctx);
 166         ret &= check_session_ticket_expected(result, test_ctx);
 167         ret &= (result.session_ticket_do_not_call == 0);
 168     }
 169     return ret;
 170 }
 171
 172 static int servername_callback(SSL *s, int *ad, void *arg)
 173 {
 174     const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
 175     if (servername != NULL && !strcmp(servername, "server2")) {
 176         SSL_CTX *new_ctx = (SSL_CTX*)arg;
 177         SSL_set_SSL_CTX(s, new_ctx);
 178         /*
 179          * Copy over all the SSL_CTX options - reasonable behavior
 180          * allows testing of cases where the options between two
 181          * contexts differ/conflict
 182          */
 183         SSL_clear_options(s, 0xFFFFFFFFL);
 184         SSL_set_options(s, SSL_CTX_get_options(new_ctx));
 185     }
 186     return SSL_TLSEXT_ERR_OK;
 187 }
 188
 189 static int execute_test(SSL_TEST_FIXTURE fixture)
 190 {
 191     int ret = 0;
 192     SSL_CTX *server_ctx = NULL, *server2_ctx = NULL, *client_ctx = NULL;
 193     SSL_TEST_CTX *test_ctx = NULL;
 194     HANDSHAKE_RESULT result;
 195
 196     server_ctx = SSL_CTX_new(TLS_server_method());
 197     server2_ctx = SSL_CTX_new(TLS_server_method());
 198     client_ctx = SSL_CTX_new(TLS_client_method());
 199     OPENSSL_assert(server_ctx != NULL && server2_ctx != NULL && client_ctx != NULL);
 200
 201     OPENSSL_assert(CONF_modules_load(conf, fixture.test_app, 0) > 0);
 202
 203     if (!SSL_CTX_config(server_ctx, "server")
 204         || !SSL_CTX_config(server2_ctx, "server2")
 205         || !SSL_CTX_config(client_ctx, "client")) {
 206         goto err;
 207     }
 208
 209     /* link the two contexts for SNI purposes */
 210     SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_callback);
 211     SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
 212     /*
 213      * The initial_ctx/session_ctx always handles the encrypt/decrypt of the
 214      * session ticket. This ticket_key callback is assigned to the second
 215      * session (assigned via SNI), and should never be invoked
 216      */
 217     SSL_CTX_set_tlsext_ticket_key_cb(server2_ctx, do_not_call_session_ticket_callback);
 218
 219     test_ctx = SSL_TEST_CTX_create(conf, fixture.test_app);
 220     if (test_ctx == NULL)
 221         goto err;
 222
 223     result = do_handshake(server_ctx, client_ctx, test_ctx);
 224
 225     ret = check_test(result, test_ctx);
 226
 227 err:
 228     CONF_modules_unload(0);
 229     SSL_CTX_free(server_ctx);
 230     SSL_CTX_free(server2_ctx);
 231     SSL_CTX_free(client_ctx);
 232     SSL_TEST_CTX_free(test_ctx);
 233     if (ret != 1)
 234         ERR_print_errors_fp(stderr);
 235     return ret;
 236 }
 237
 238 static void tear_down(SSL_TEST_FIXTURE fixture)
 239 {
 240 }
 241
 242 #define SETUP_SSL_TEST_FIXTURE()                        \
 243     SETUP_TEST_FIXTURE(SSL_TEST_FIXTURE, set_up)
 244 #define EXECUTE_SSL_TEST()             \
 245     EXECUTE_TEST(execute_test, tear_down)
 246
 247 static int test_handshake(int idx)
 248 {
 249     SETUP_SSL_TEST_FIXTURE();
 250     BIO_snprintf(fixture.test_app, sizeof(fixture.test_app),
 251                  "test-%d", idx);
 252     EXECUTE_SSL_TEST();
 253 }
 254
 255 int main(int argc, char **argv)
 256 {
 257     int result = 0;
 258     long num_tests;
 259
 260     if (argc != 2)
 261         return 1;
 262
 263     conf = NCONF_new(NULL);
 264     OPENSSL_assert(conf != NULL);
 265
 266     /* argv[1] should point to the test conf file */
 267     OPENSSL_assert(NCONF_load(conf, argv[1], NULL) > 0);
 268
 269     OPENSSL_assert(NCONF_get_number_e(conf, NULL, "num_tests", &num_tests));
 270
 271     ADD_ALL_TESTS(test_handshake, (int)(num_tests));
 272     result = run_tests(argv[0]);
 273
 274     return result;
 275 }