test/ssl_test_ctx_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 /*
  11  * Ideally, CONF should offer standard parsing methods and cover them
  12  * in tests. But since we have no CONF tests, we use a custom test for now.
  13  */
  14
  15 #include <stdio.h>
  16 #include <string.h>
  17
  18 #include "e_os.h"
  19 #include "ssl_test_ctx.h"
  20 #include "testutil.h"
  21 #include <openssl/e_os2.h>
  22 #include <openssl/err.h>
  23 #include <openssl/conf.h>
  24 #include <openssl/ssl.h>
  25
  26 static CONF *conf = NULL;
  27
  28 typedef struct ssl_test_ctx_test_fixture {
  29     const char *test_case_name;
  30     const char *test_section;
  31     /* Expected parsed configuration. */
  32     SSL_TEST_CTX *expected_ctx;
  33 } SSL_TEST_CTX_TEST_FIXTURE;
  34
  35
  36 static int SSL_TEST_CLIENT_CONF_equal(SSL_TEST_CLIENT_CONF *client,
  37                                       SSL_TEST_CLIENT_CONF *client2)
  38 {
  39     if (client->verify_callback != client2->verify_callback) {
  40         fprintf(stderr, "ClientVerifyCallback mismatch: %s vs %s.\n",
  41                 ssl_verify_callback_name(client->verify_callback),
  42                 ssl_verify_callback_name(client2->verify_callback));
  43         return 0;
  44     }
  45     if (client->servername != client2->servername) {
  46         fprintf(stderr, "ServerName mismatch: %s vs %s.\n",
  47                 ssl_servername_name(client->servername),
  48                 ssl_servername_name(client2->servername));
  49         return 0;
  50     }
  51     if (!strings_equal("Client NPNProtocols", client->npn_protocols,
  52                        client2->npn_protocols))
  53         return 0;
  54     if (!strings_equal("Client ALPNProtocols", client->alpn_protocols,
  55                        client2->alpn_protocols))
  56         return 0;
  57     if (client->ct_validation != client2->ct_validation) {
  58         fprintf(stderr, "CTValidation mismatch: %s vs %s.\n",
  59                 ssl_ct_validation_name(client->ct_validation),
  60                 ssl_ct_validation_name(client2->ct_validation));
  61         return 0;
  62     }
  63     return 1;
  64 }
  65
  66 static int SSL_TEST_SERVER_CONF_equal(SSL_TEST_SERVER_CONF *server,
  67                                       SSL_TEST_SERVER_CONF *server2)
  68 {
  69     if (server->servername_callback != server2->servername_callback) {
  70         fprintf(stderr, "ServerNameCallback mismatch: %s vs %s.\n",
  71                 ssl_servername_callback_name(server->servername_callback),
  72                 ssl_servername_callback_name(server2->servername_callback));
  73         return 0;
  74     }
  75     if (!strings_equal("Server NPNProtocols", server->npn_protocols,
  76                        server2->npn_protocols))
  77         return 0;
  78     if (!strings_equal("Server ALPNProtocols", server->alpn_protocols,
  79                        server2->alpn_protocols))
  80         return 0;
  81     if (server->broken_session_ticket != server2->broken_session_ticket) {
  82         fprintf(stderr, "Broken session ticket mismatch: %d vs %d.\n",
  83                 server->broken_session_ticket, server2->broken_session_ticket);
  84         return 0;
  85     }
  86     return 1;
  87 }
  88
  89 static int SSL_TEST_EXTRA_CONF_equal(SSL_TEST_EXTRA_CONF *extra,
  90                                      SSL_TEST_EXTRA_CONF *extra2)
  91 {
  92     return SSL_TEST_CLIENT_CONF_equal(&extra->client, &extra2->client)
  93         && SSL_TEST_SERVER_CONF_equal(&extra->server, &extra2->server)
  94         && SSL_TEST_SERVER_CONF_equal(&extra->server2, &extra2->server2);
  95 }
  96
  97 /* Returns 1 if the contexts are equal, 0 otherwise. */
  98 static int SSL_TEST_CTX_equal(SSL_TEST_CTX *ctx, SSL_TEST_CTX *ctx2)
  99 {
 100     if (ctx->method != ctx2->method) {
 101         fprintf(stderr, "Method mismatch: %s vs %s.\n",
 102                 ssl_test_method_name(ctx->method),
 103                 ssl_test_method_name(ctx2->method));
 104         return 0;
 105     }
 106     if (ctx->handshake_mode != ctx2->handshake_mode) {
 107         fprintf(stderr, "HandshakeMode mismatch: %s vs %s.\n",
 108                 ssl_handshake_mode_name(ctx->handshake_mode),
 109                 ssl_handshake_mode_name(ctx2->handshake_mode));
 110         return 0;
 111     }
 112     if (ctx->app_data_size != ctx2->app_data_size) {
 113         fprintf(stderr, "ApplicationData mismatch: %d vs %d.\n",
 114                 ctx->app_data_size, ctx2->app_data_size);
 115         return 0;
 116     }
 117
 118     if (ctx->max_fragment_size != ctx2->max_fragment_size) {
 119         fprintf(stderr, "MaxFragmentSize mismatch: %d vs %d.\n",
 120                 ctx->max_fragment_size, ctx2->max_fragment_size);
 121         return 0;
 122     }
 123
 124     if (!SSL_TEST_EXTRA_CONF_equal(&ctx->extra, &ctx2->extra)) {
 125         fprintf(stderr, "Extra conf mismatch.\n");
 126         return 0;
 127     }
 128     if (!SSL_TEST_EXTRA_CONF_equal(&ctx->resume_extra, &ctx2->resume_extra)) {
 129         fprintf(stderr, "Resume extra conf mismatch.\n");
 130         return 0;
 131     }
 132
 133     if (ctx->expected_result != ctx2->expected_result) {
 134         fprintf(stderr, "ExpectedResult mismatch: %s vs %s.\n",
 135                 ssl_test_result_name(ctx->expected_result),
 136                 ssl_test_result_name(ctx2->expected_result));
 137         return 0;
 138     }
 139     if (ctx->expected_client_alert != ctx2->expected_client_alert) {
 140         fprintf(stderr, "ClientAlert mismatch: %s vs %s.\n",
 141                 ssl_alert_name(ctx->expected_client_alert),
 142                 ssl_alert_name(ctx2->expected_client_alert));
 143         return 0;
 144     }
 145     if (ctx->expected_server_alert != ctx2->expected_server_alert) {
 146         fprintf(stderr, "ServerAlert mismatch: %s vs %s.\n",
 147                 ssl_alert_name(ctx->expected_server_alert),
 148                 ssl_alert_name(ctx2->expected_server_alert));
 149         return 0;
 150     }
 151     if (ctx->expected_protocol != ctx2->expected_protocol) {
 152         fprintf(stderr, "ClientAlert mismatch: %s vs %s.\n",
 153                 ssl_protocol_name(ctx->expected_protocol),
 154                 ssl_protocol_name(ctx2->expected_protocol));
 155         return 0;
 156     }
 157     if (ctx->expected_servername != ctx2->expected_servername) {
 158         fprintf(stderr, "ExpectedServerName mismatch: %s vs %s.\n",
 159                 ssl_servername_name(ctx->expected_servername),
 160                 ssl_servername_name(ctx2->expected_servername));
 161         return 0;
 162     }
 163     if (ctx->session_ticket_expected != ctx2->session_ticket_expected) {
 164         fprintf(stderr, "SessionTicketExpected mismatch: %s vs %s.\n",
 165                 ssl_session_ticket_name(ctx->session_ticket_expected),
 166                 ssl_session_ticket_name(ctx2->session_ticket_expected));
 167         return 0;
 168     }
 169     if (!strings_equal("ExpectedNPNProtocol", ctx->expected_npn_protocol,
 170                        ctx2->expected_npn_protocol))
 171         return 0;
 172     if (!strings_equal("ExpectedALPNProtocol", ctx->expected_alpn_protocol,
 173                        ctx2->expected_alpn_protocol))
 174         return 0;
 175     if (ctx->resumption_expected != ctx2->resumption_expected) {
 176         fprintf(stderr, "ResumptionExpected mismatch: %d vs %d.\n",
 177                 ctx->resumption_expected, ctx2->resumption_expected);
 178         return 0;
 179     }
 180     return 1;
 181 }
 182
 183 static SSL_TEST_CTX_TEST_FIXTURE set_up(const char *const test_case_name)
 184 {
 185     SSL_TEST_CTX_TEST_FIXTURE fixture;
 186     fixture.test_case_name = test_case_name;
 187     fixture.expected_ctx = SSL_TEST_CTX_new();
 188     TEST_check(fixture.expected_ctx != NULL);
 189     return fixture;
 190 }
 191
 192 static int execute_test(SSL_TEST_CTX_TEST_FIXTURE fixture)
 193 {
 194     int success = 0;
 195
 196     SSL_TEST_CTX *ctx = SSL_TEST_CTX_create(conf, fixture.test_section);
 197
 198     if (ctx == NULL) {
 199         fprintf(stderr, "Failed to parse good configuration %s.\n",
 200                 fixture.test_section);
 201         goto err;
 202     }
 203
 204     if (!SSL_TEST_CTX_equal(ctx, fixture.expected_ctx))
 205         goto err;
 206
 207     success = 1;
 208  err:
 209     SSL_TEST_CTX_free(ctx);
 210     return success;
 211 }
 212
 213 static int execute_failure_test(SSL_TEST_CTX_TEST_FIXTURE fixture)
 214 {
 215     SSL_TEST_CTX *ctx = SSL_TEST_CTX_create(conf, fixture.test_section);
 216
 217     if (ctx != NULL) {
 218         fprintf(stderr, "Parsing bad configuration %s succeeded.\n",
 219                 fixture.test_section);
 220         SSL_TEST_CTX_free(ctx);
 221         return 0;
 222     }
 223
 224     return 1;
 225 }
 226
 227 static void tear_down(SSL_TEST_CTX_TEST_FIXTURE fixture)
 228 {
 229     SSL_TEST_CTX_free(fixture.expected_ctx);
 230     ERR_print_errors_fp(stderr);
 231 }
 232
 233 #define SETUP_SSL_TEST_CTX_TEST_FIXTURE()                       \
 234     SETUP_TEST_FIXTURE(SSL_TEST_CTX_TEST_FIXTURE, set_up)
 235 #define EXECUTE_SSL_TEST_CTX_TEST()             \
 236     EXECUTE_TEST(execute_test, tear_down)
 237 #define EXECUTE_SSL_TEST_CTX_FAILURE_TEST()             \
 238     EXECUTE_TEST(execute_failure_test, tear_down)
 239
 240 static int test_empty_configuration()
 241 {
 242     SETUP_SSL_TEST_CTX_TEST_FIXTURE();
 243     fixture.test_section = "ssltest_default";
 244     fixture.expected_ctx->expected_result = SSL_TEST_SUCCESS;
 245     EXECUTE_SSL_TEST_CTX_TEST();
 246 }
 247
 248 static int test_good_configuration()
 249 {
 250     SETUP_SSL_TEST_CTX_TEST_FIXTURE();
 251     fixture.test_section = "ssltest_good";
 252     fixture.expected_ctx->method = SSL_TEST_METHOD_DTLS;
 253     fixture.expected_ctx->handshake_mode = SSL_TEST_HANDSHAKE_RESUME;
 254     fixture.expected_ctx->app_data_size = 1024;
 255     fixture.expected_ctx->max_fragment_size = 2048;
 256
 257     fixture.expected_ctx->expected_result = SSL_TEST_SERVER_FAIL;
 258     fixture.expected_ctx->expected_client_alert = SSL_AD_UNKNOWN_CA;
 259     fixture.expected_ctx->expected_server_alert = 0;  /* No alert. */
 260     fixture.expected_ctx->expected_protocol = TLS1_1_VERSION;
 261     fixture.expected_ctx->expected_servername = SSL_TEST_SERVERNAME_SERVER2;
 262     fixture.expected_ctx->session_ticket_expected = SSL_TEST_SESSION_TICKET_YES;
 263     fixture.expected_ctx->resumption_expected = 1;
 264
 265     fixture.expected_ctx->extra.client.verify_callback =
 266         SSL_TEST_VERIFY_REJECT_ALL;
 267     fixture.expected_ctx->extra.client.servername = SSL_TEST_SERVERNAME_SERVER2;
 268     fixture.expected_ctx->extra.client.npn_protocols =
 269         OPENSSL_strdup("foo,bar");
 270     TEST_check(fixture.expected_ctx->extra.client.npn_protocols != NULL);
 271
 272     fixture.expected_ctx->extra.server.servername_callback =
 273         SSL_TEST_SERVERNAME_IGNORE_MISMATCH;
 274     fixture.expected_ctx->extra.server.broken_session_ticket = 1;
 275
 276     fixture.expected_ctx->resume_extra.server2.alpn_protocols =
 277         OPENSSL_strdup("baz");
 278     TEST_check(
 279         fixture.expected_ctx->resume_extra.server2.alpn_protocols != NULL);
 280
 281     fixture.expected_ctx->resume_extra.client.ct_validation =
 282         SSL_TEST_CT_VALIDATION_STRICT;
 283
 284     EXECUTE_SSL_TEST_CTX_TEST();
 285 }
 286
 287 static const char *bad_configurations[] = {
 288     "ssltest_unknown_option",
 289     "ssltest_wrong_section",
 290     "ssltest_unknown_expected_result",
 291     "ssltest_unknown_alert",
 292     "ssltest_unknown_protocol",
 293     "ssltest_unknown_verify_callback",
 294     "ssltest_unknown_servername",
 295     "ssltest_unknown_servername_callback",
 296     "ssltest_unknown_session_ticket_expected",
 297     "ssltest_unknown_method",
 298     "ssltest_unknown_handshake_mode",
 299     "ssltest_unknown_resumption_expected",
 300     "ssltest_unknown_ct_validation",
 301 };
 302
 303 static int test_bad_configuration(int idx)
 304 {
 305         SETUP_SSL_TEST_CTX_TEST_FIXTURE();
 306         fixture.test_section = bad_configurations[idx];
 307         EXECUTE_SSL_TEST_CTX_FAILURE_TEST();
 308 }
 309
 310 int main(int argc, char **argv)
 311 {
 312     int result = 0;
 313
 314     if (argc != 2)
 315         return 1;
 316
 317     conf = NCONF_new(NULL);
 318     TEST_check(conf != NULL);
 319
 320     /* argv[1] should point to test/ssl_test_ctx_test.conf */
 321     TEST_check(NCONF_load(conf, argv[1], NULL) > 0);
 322
 323     ADD_TEST(test_empty_configuration);
 324     ADD_TEST(test_good_configuration);
 325     ADD_ALL_TESTS(test_bad_configuration, OSSL_NELEM(bad_configurations));
 326
 327     result = run_tests(argv[0]);
 328
 329     NCONF_free(conf);
 330
 331     return result;
 332 }