test/ssl_test_ctx.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 <string.h>
  11
  12 #include <openssl/e_os2.h>
  13 #include <openssl/crypto.h>
  14
  15 #include "e_os.h"
  16 #include "ssl_test_ctx.h"
  17 #include "testutil.h"
  18
  19 static const int default_app_data_size = 256;
  20
  21 static int parse_boolean(const char *value, int *result)
  22 {
  23     if (strcasecmp(value, "Yes") == 0) {
  24         *result = 1;
  25         return 1;
  26     }
  27     else if (strcasecmp(value, "No") == 0) {
  28         *result = 0;
  29         return 1;
  30     }
  31     return 0;
  32 }
  33
  34 #define IMPLEMENT_SSL_TEST_BOOL_OPTION(struct_type, name, field)        \
  35     static int parse_##name##_##field(struct_type *ctx, const char *value) \
  36     {                                                                   \
  37         return parse_boolean(value, &ctx->field);                       \
  38     }
  39
  40 #define IMPLEMENT_SSL_TEST_STRING_OPTION(struct_type, name, field)      \
  41     static int parse_##name##_##field(struct_type *ctx, const char *value) \
  42     {                                                                   \
  43         OPENSSL_free(ctx->field);                                       \
  44         ctx->field = OPENSSL_strdup(value);                             \
  45         TEST_check(ctx->field != NULL);                                 \
  46         return 1;                                                       \
  47     }
  48
  49 #define IMPLEMENT_SSL_TEST_INT_OPTION(struct_type, name, field)        \
  50     static int parse_##name##_##field(struct_type *ctx, const char *value) \
  51     {                                                                   \
  52         ctx->field = atoi(value);                                       \
  53         return 1;                                                       \
  54     }
  55
  56 /* True enums and other test configuration values that map to an int. */
  57 typedef struct {
  58     const char *name;
  59     int value;
  60 } test_enum;
  61
  62
  63 __owur static int parse_enum(const test_enum *enums, size_t num_enums,
  64                              int *value, const char *name)
  65 {
  66     size_t i;
  67     for (i = 0; i < num_enums; i++) {
  68         if (strcmp(enums[i].name, name) == 0) {
  69             *value = enums[i].value;
  70             return 1;
  71         }
  72     }
  73     return 0;
  74 }
  75
  76 static const char *enum_name(const test_enum *enums, size_t num_enums,
  77                              int value)
  78 {
  79     size_t i;
  80     for (i = 0; i < num_enums; i++) {
  81         if (enums[i].value == value) {
  82             return enums[i].name;
  83         }
  84     }
  85     return "InvalidValue";
  86 }
  87
  88
  89 /*******************/
  90 /* ExpectedResult. */
  91 /*******************/
  92
  93 static const test_enum ssl_test_results[] = {
  94     {"Success", SSL_TEST_SUCCESS},
  95     {"ServerFail", SSL_TEST_SERVER_FAIL},
  96     {"ClientFail", SSL_TEST_CLIENT_FAIL},
  97     {"InternalError", SSL_TEST_INTERNAL_ERROR},
  98 };
  99
 100 __owur static int parse_expected_result(SSL_TEST_CTX *test_ctx, const char *value)
 101 {
 102     int ret_value;
 103     if (!parse_enum(ssl_test_results, OSSL_NELEM(ssl_test_results),
 104                     &ret_value, value)) {
 105         return 0;
 106     }
 107     test_ctx->expected_result = ret_value;
 108     return 1;
 109 }
 110
 111 const char *ssl_test_result_name(ssl_test_result_t result)
 112 {
 113     return enum_name(ssl_test_results, OSSL_NELEM(ssl_test_results), result);
 114 }
 115
 116 /**********************************************/
 117 /* ExpectedClientAlert / ExpectedServerAlert. */
 118 /**********************************************/
 119
 120 static const test_enum ssl_alerts[] = {
 121     {"UnknownCA", SSL_AD_UNKNOWN_CA},
 122     {"HandshakeFailure", SSL_AD_HANDSHAKE_FAILURE},
 123     {"UnrecognizedName", SSL_AD_UNRECOGNIZED_NAME},
 124     {"BadCertificate", SSL_AD_BAD_CERTIFICATE},
 125     {"NoApplicationProtocol", SSL_AD_NO_APPLICATION_PROTOCOL},
 126 };
 127
 128 __owur static int parse_alert(int *alert, const char *value)
 129 {
 130     return parse_enum(ssl_alerts, OSSL_NELEM(ssl_alerts), alert, value);
 131 }
 132
 133 __owur static int parse_client_alert(SSL_TEST_CTX *test_ctx, const char *value)
 134 {
 135     return parse_alert(&test_ctx->expected_client_alert, value);
 136 }
 137
 138 __owur static int parse_server_alert(SSL_TEST_CTX *test_ctx, const char *value)
 139 {
 140     return parse_alert(&test_ctx->expected_server_alert, value);
 141 }
 142
 143 const char *ssl_alert_name(int alert)
 144 {
 145     return enum_name(ssl_alerts, OSSL_NELEM(ssl_alerts), alert);
 146 }
 147
 148 /********************/
 149 /* ExpectedProtocol */
 150 /********************/
 151
 152 static const test_enum ssl_protocols[] = {
 153      {"TLSv1.2", TLS1_2_VERSION},
 154      {"TLSv1.1", TLS1_1_VERSION},
 155      {"TLSv1", TLS1_VERSION},
 156      {"SSLv3", SSL3_VERSION},
 157      {"DTLSv1", DTLS1_VERSION},
 158      {"DTLSv1.2", DTLS1_2_VERSION},
 159 };
 160
 161 __owur static int parse_protocol(SSL_TEST_CTX *test_ctx, const char *value)
 162 {
 163     return parse_enum(ssl_protocols, OSSL_NELEM(ssl_protocols),
 164                       &test_ctx->expected_protocol, value);
 165 }
 166
 167 const char *ssl_protocol_name(int protocol)
 168 {
 169     return enum_name(ssl_protocols, OSSL_NELEM(ssl_protocols), protocol);
 170 }
 171
 172 /***********************/
 173 /* VerifyCallback.     */
 174 /***********************/
 175
 176 static const test_enum ssl_verify_callbacks[] = {
 177     {"None", SSL_TEST_VERIFY_NONE},
 178     {"AcceptAll", SSL_TEST_VERIFY_ACCEPT_ALL},
 179     {"RejectAll", SSL_TEST_VERIFY_REJECT_ALL},
 180 };
 181
 182 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
 183                                                const char *value)
 184 {
 185     int ret_value;
 186     if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
 187                     &ret_value, value)) {
 188         return 0;
 189     }
 190     client_conf->verify_callback = ret_value;
 191     return 1;
 192 }
 193
 194 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
 195 {
 196     return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
 197                      callback);
 198 }
 199
 200 /**************/
 201 /* ServerName */
 202 /**************/
 203
 204 static const test_enum ssl_servername[] = {
 205     {"None", SSL_TEST_SERVERNAME_NONE},
 206     {"server1", SSL_TEST_SERVERNAME_SERVER1},
 207     {"server2", SSL_TEST_SERVERNAME_SERVER2},
 208     {"invalid", SSL_TEST_SERVERNAME_INVALID},
 209 };
 210
 211 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
 212                                    const char *value)
 213 {
 214     int ret_value;
 215     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
 216                     &ret_value, value)) {
 217         return 0;
 218     }
 219     client_conf->servername = ret_value;
 220     return 1;
 221 }
 222
 223 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
 224                                             const char *value)
 225 {
 226     int ret_value;
 227     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
 228                     &ret_value, value)) {
 229         return 0;
 230     }
 231     test_ctx->expected_servername = ret_value;
 232     return 1;
 233 }
 234
 235 const char *ssl_servername_name(ssl_servername_t server)
 236 {
 237     return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
 238                      server);
 239 }
 240
 241 /**********************/
 242 /* ServerNameCallback */
 243 /**********************/
 244
 245 static const test_enum ssl_servername_callbacks[] = {
 246     {"None", SSL_TEST_SERVERNAME_CB_NONE},
 247     {"IgnoreMismatch", SSL_TEST_SERVERNAME_IGNORE_MISMATCH},
 248     {"RejectMismatch", SSL_TEST_SERVERNAME_REJECT_MISMATCH},
 249 };
 250
 251 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
 252                                             const char *value)
 253 {
 254     int ret_value;
 255     if (!parse_enum(ssl_servername_callbacks,
 256                     OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
 257         return 0;
 258     }
 259     server_conf->servername_callback = ret_value;
 260     return 1;
 261 }
 262
 263 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
 264 {
 265     return enum_name(ssl_servername_callbacks,
 266                      OSSL_NELEM(ssl_servername_callbacks), callback);
 267 }
 268
 269 /*************************/
 270 /* SessionTicketExpected */
 271 /*************************/
 272
 273 static const test_enum ssl_session_ticket[] = {
 274     {"Ignore", SSL_TEST_SESSION_TICKET_IGNORE},
 275     {"Yes", SSL_TEST_SESSION_TICKET_YES},
 276     {"No", SSL_TEST_SESSION_TICKET_NO},
 277 };
 278
 279 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
 280 {
 281     int ret_value;
 282     if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
 283                     &ret_value, value)) {
 284         return 0;
 285     }
 286     test_ctx->session_ticket_expected = ret_value;
 287     return 1;
 288 }
 289
 290 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
 291 {
 292     return enum_name(ssl_session_ticket,
 293                      OSSL_NELEM(ssl_session_ticket),
 294                      server);
 295 }
 296
 297 /***********************/
 298 /* Method              */
 299 /***********************/
 300
 301 static const test_enum ssl_test_methods[] = {
 302     {"TLS", SSL_TEST_METHOD_TLS},
 303     {"DTLS", SSL_TEST_METHOD_DTLS},
 304 };
 305
 306 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
 307 {
 308     int ret_value;
 309     if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
 310                     &ret_value, value)) {
 311         return 0;
 312     }
 313     test_ctx->method = ret_value;
 314     return 1;
 315 }
 316
 317 const char *ssl_test_method_name(ssl_test_method_t method)
 318 {
 319     return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
 320 }
 321
 322 /************************************/
 323 /* NPN and ALPN options             */
 324 /************************************/
 325
 326 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
 327 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
 328 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
 329 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
 330 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
 331 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
 332
 333 /***********************/
 334 /* Handshake mode      */
 335 /***********************/
 336
 337 static const test_enum ssl_handshake_modes[] = {
 338     {"Simple", SSL_TEST_HANDSHAKE_SIMPLE},
 339     {"Resume", SSL_TEST_HANDSHAKE_RESUME},
 340     {"Renegotiate", SSL_TEST_HANDSHAKE_RENEGOTIATE},
 341 };
 342
 343 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
 344 {
 345     int ret_value;
 346     if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
 347                     &ret_value, value)) {
 348         return 0;
 349     }
 350     test_ctx->handshake_mode = ret_value;
 351     return 1;
 352 }
 353
 354 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
 355 {
 356     return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
 357                      mode);
 358 }
 359
 360 /***********************/
 361 /* CT Validation       */
 362 /***********************/
 363
 364 static const test_enum ssl_ct_validation_modes[] = {
 365     {"None", SSL_TEST_CT_VALIDATION_NONE},
 366     {"Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE},
 367     {"Strict", SSL_TEST_CT_VALIDATION_STRICT},
 368 };
 369
 370 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
 371                                       const char *value)
 372 {
 373     int ret_value;
 374     if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
 375                     &ret_value, value)) {
 376         return 0;
 377     }
 378     client_conf->ct_validation = ret_value;
 379     return 1;
 380 }
 381
 382 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
 383 {
 384     return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
 385                      mode);
 386 }
 387
 388 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
 389 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, broken_session_ticket)
 390
 391 /***********************/
 392 /* Applicationdata     */
 393 /***********************/
 394
 395 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
 396
 397 /*************************************************************/
 398 /* Known test options and their corresponding parse methods. */
 399 /*************************************************************/
 400
 401 /* Top-level options. */
 402 typedef struct {
 403     const char *name;
 404     int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
 405 } ssl_test_ctx_option;
 406
 407 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
 408     { "ExpectedResult", &parse_expected_result },
 409     { "ExpectedClientAlert", &parse_client_alert },
 410     { "ExpectedServerAlert", &parse_server_alert },
 411     { "ExpectedProtocol", &parse_protocol },
 412     { "ExpectedServerName", &parse_expected_servername },
 413     { "SessionTicketExpected", &parse_session_ticket },
 414     { "Method", &parse_test_method },
 415     { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
 416     { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
 417     { "HandshakeMode", &parse_handshake_mode },
 418     { "ResumptionExpected", &parse_test_resumption_expected },
 419     { "ApplicationData", &parse_test_app_data_size },
 420 };
 421
 422 /* Nested client options. */
 423 typedef struct {
 424     const char *name;
 425     int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
 426 } ssl_test_client_option;
 427
 428 static const ssl_test_client_option ssl_test_client_options[] = {
 429     { "VerifyCallback", &parse_client_verify_callback },
 430     { "ServerName", &parse_servername },
 431     { "NPNProtocols", &parse_client_npn_protocols },
 432     { "ALPNProtocols", &parse_client_alpn_protocols },
 433     { "CTValidation", &parse_ct_validation },
 434 };
 435
 436 /* Nested server options. */
 437 typedef struct {
 438     const char *name;
 439     int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
 440 } ssl_test_server_option;
 441
 442 static const ssl_test_server_option ssl_test_server_options[] = {
 443     { "ServerNameCallback", &parse_servername_callback },
 444     { "NPNProtocols", &parse_server_npn_protocols },
 445     { "ALPNProtocols", &parse_server_alpn_protocols },
 446     { "BrokenSessionTicket", &parse_server_broken_session_ticket },
 447 };
 448
 449 /*
 450  * Since these methods are used to create tests, we use TEST_check liberally
 451  * for malloc failures and other internal errors.
 452  */
 453 SSL_TEST_CTX *SSL_TEST_CTX_new()
 454 {
 455     SSL_TEST_CTX *ret;
 456     ret = OPENSSL_zalloc(sizeof(*ret));
 457     TEST_check(ret != NULL);
 458     ret->app_data_size = default_app_data_size;
 459     return ret;
 460 }
 461
 462 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
 463 {
 464     OPENSSL_free(conf->client.npn_protocols);
 465     OPENSSL_free(conf->server.npn_protocols);
 466     OPENSSL_free(conf->server2.npn_protocols);
 467     OPENSSL_free(conf->client.alpn_protocols);
 468     OPENSSL_free(conf->server.alpn_protocols);
 469     OPENSSL_free(conf->server2.alpn_protocols);
 470 }
 471
 472 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
 473 {
 474     ssl_test_extra_conf_free_data(&ctx->extra);
 475     ssl_test_extra_conf_free_data(&ctx->resume_extra);
 476 }
 477
 478 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
 479 {
 480     ssl_test_ctx_free_extra_data(ctx);
 481     OPENSSL_free(ctx->expected_npn_protocol);
 482     OPENSSL_free(ctx->expected_alpn_protocol);
 483     OPENSSL_free(ctx);
 484 }
 485
 486 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
 487                                 const char *client_section)
 488 {
 489     STACK_OF(CONF_VALUE) *sk_conf;
 490     int i;
 491     size_t j;
 492
 493     sk_conf = NCONF_get_section(conf, client_section);
 494     TEST_check(sk_conf != NULL);
 495
 496     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
 497         int found = 0;
 498         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
 499         for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
 500             if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
 501                 if (!ssl_test_client_options[j].parse(client, option->value)) {
 502                     fprintf(stderr, "Bad value %s for option %s\n",
 503                             option->value, option->name);
 504                     return 0;
 505                 }
 506                 found = 1;
 507                 break;
 508             }
 509         }
 510         if (!found) {
 511             fprintf(stderr, "Unknown test option: %s\n", option->name);
 512             return 0;
 513         }
 514     }
 515
 516     return 1;
 517 }
 518
 519 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
 520                                 const char *server_section)
 521 {
 522     STACK_OF(CONF_VALUE) *sk_conf;
 523     int i;
 524     size_t j;
 525
 526     sk_conf = NCONF_get_section(conf, server_section);
 527     TEST_check(sk_conf != NULL);
 528
 529     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
 530         int found = 0;
 531         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
 532         for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
 533             if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
 534                 if (!ssl_test_server_options[j].parse(server, option->value)) {
 535                     fprintf(stderr, "Bad value %s for option %s\n",
 536                             option->value, option->name);
 537                     return 0;
 538                 }
 539                 found = 1;
 540                 break;
 541             }
 542         }
 543         if (!found) {
 544             fprintf(stderr, "Unknown test option: %s\n", option->name);
 545             return 0;
 546         }
 547     }
 548
 549     return 1;
 550 }
 551
 552 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
 553 {
 554     STACK_OF(CONF_VALUE) *sk_conf;
 555     SSL_TEST_CTX *ctx;
 556     int i;
 557     size_t j;
 558
 559     sk_conf = NCONF_get_section(conf, test_section);
 560     TEST_check(sk_conf != NULL);
 561
 562     ctx = SSL_TEST_CTX_new();
 563     TEST_check(ctx != NULL);
 564
 565     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
 566         int found = 0;
 567         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
 568
 569         /* Subsections */
 570         if (strcmp(option->name, "client") == 0) {
 571             if (!parse_client_options(&ctx->extra.client, conf,
 572                                       option->value))
 573                 goto err;
 574         } else if (strcmp(option->name, "server") == 0) {
 575             if (!parse_server_options(&ctx->extra.server, conf,
 576                                       option->value))
 577                 goto err;
 578         } else if (strcmp(option->name, "server2") == 0) {
 579             if (!parse_server_options(&ctx->extra.server2, conf,
 580                                       option->value))
 581                 goto err;
 582         } else if (strcmp(option->name, "resume-client") == 0) {
 583             if (!parse_client_options(&ctx->resume_extra.client, conf,
 584                                       option->value))
 585                 goto err;
 586         } else if (strcmp(option->name, "resume-server") == 0) {
 587             if (!parse_server_options(&ctx->resume_extra.server, conf,
 588                                       option->value))
 589                 goto err;
 590         } else if (strcmp(option->name, "resume-server2") == 0) {
 591             if (!parse_server_options(&ctx->resume_extra.server2, conf,
 592                                       option->value))
 593                 goto err;
 594
 595         } else {
 596             for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
 597                 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
 598                     if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
 599                         fprintf(stderr, "Bad value %s for option %s\n",
 600                                 option->value, option->name);
 601                         goto err;
 602                     }
 603                     found = 1;
 604                     break;
 605                 }
 606             }
 607             if (!found) {
 608                 fprintf(stderr, "Unknown test option: %s\n", option->name);
 609                 goto err;
 610             }
 611         }
 612     }
 613
 614     goto done;
 615
 616  err:
 617     SSL_TEST_CTX_free(ctx);
 618     ctx = NULL;
 619  done:
 620     return ctx;
 621 }