2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
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
12 #include <openssl/e_os2.h>
13 #include <openssl/crypto.h>
16 #include "ssl_test_ctx.h"
19 static const int default_app_data_size = 256;
20 /* Default set to be as small as possible to exercise fragmentation. */
21 static const int default_max_fragment_size = 512;
23 static int parse_boolean(const char *value, int *result)
25 if (strcasecmp(value, "Yes") == 0) {
29 else if (strcasecmp(value, "No") == 0) {
36 #define IMPLEMENT_SSL_TEST_BOOL_OPTION(struct_type, name, field) \
37 static int parse_##name##_##field(struct_type *ctx, const char *value) \
39 return parse_boolean(value, &ctx->field); \
42 #define IMPLEMENT_SSL_TEST_STRING_OPTION(struct_type, name, field) \
43 static int parse_##name##_##field(struct_type *ctx, const char *value) \
45 OPENSSL_free(ctx->field); \
46 ctx->field = OPENSSL_strdup(value); \
47 TEST_check(ctx->field != NULL); \
51 #define IMPLEMENT_SSL_TEST_INT_OPTION(struct_type, name, field) \
52 static int parse_##name##_##field(struct_type *ctx, const char *value) \
54 ctx->field = atoi(value); \
58 /* True enums and other test configuration values that map to an int. */
65 __owur static int parse_enum(const test_enum *enums, size_t num_enums,
66 int *value, const char *name)
69 for (i = 0; i < num_enums; i++) {
70 if (strcmp(enums[i].name, name) == 0) {
71 *value = enums[i].value;
78 static const char *enum_name(const test_enum *enums, size_t num_enums,
82 for (i = 0; i < num_enums; i++) {
83 if (enums[i].value == value) {
87 return "InvalidValue";
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},
100 __owur static int parse_expected_result(SSL_TEST_CTX *test_ctx, const char *value)
103 if (!parse_enum(ssl_test_results, OSSL_NELEM(ssl_test_results),
104 &ret_value, value)) {
107 test_ctx->expected_result = ret_value;
111 const char *ssl_test_result_name(ssl_test_result_t result)
113 return enum_name(ssl_test_results, OSSL_NELEM(ssl_test_results), result);
116 /* ExpectedClientAlert / ExpectedServerAlert */
118 static const test_enum ssl_alerts[] = {
119 {"UnknownCA", SSL_AD_UNKNOWN_CA},
120 {"HandshakeFailure", SSL_AD_HANDSHAKE_FAILURE},
121 {"UnrecognizedName", SSL_AD_UNRECOGNIZED_NAME},
122 {"BadCertificate", SSL_AD_BAD_CERTIFICATE},
123 {"NoApplicationProtocol", SSL_AD_NO_APPLICATION_PROTOCOL},
126 __owur static int parse_alert(int *alert, const char *value)
128 return parse_enum(ssl_alerts, OSSL_NELEM(ssl_alerts), alert, value);
131 __owur static int parse_client_alert(SSL_TEST_CTX *test_ctx, const char *value)
133 return parse_alert(&test_ctx->expected_client_alert, value);
136 __owur static int parse_server_alert(SSL_TEST_CTX *test_ctx, const char *value)
138 return parse_alert(&test_ctx->expected_server_alert, value);
141 const char *ssl_alert_name(int alert)
143 return enum_name(ssl_alerts, OSSL_NELEM(ssl_alerts), alert);
146 /* ExpectedProtocol */
148 static const test_enum ssl_protocols[] = {
149 {"TLSv1.3", TLS1_3_VERSION},
150 {"TLSv1.2", TLS1_2_VERSION},
151 {"TLSv1.1", TLS1_1_VERSION},
152 {"TLSv1", TLS1_VERSION},
153 {"SSLv3", SSL3_VERSION},
154 {"DTLSv1", DTLS1_VERSION},
155 {"DTLSv1.2", DTLS1_2_VERSION},
158 __owur static int parse_protocol(SSL_TEST_CTX *test_ctx, const char *value)
160 return parse_enum(ssl_protocols, OSSL_NELEM(ssl_protocols),
161 &test_ctx->expected_protocol, value);
164 const char *ssl_protocol_name(int protocol)
166 return enum_name(ssl_protocols, OSSL_NELEM(ssl_protocols), protocol);
171 static const test_enum ssl_verify_callbacks[] = {
172 {"None", SSL_TEST_VERIFY_NONE},
173 {"AcceptAll", SSL_TEST_VERIFY_ACCEPT_ALL},
174 {"RejectAll", SSL_TEST_VERIFY_REJECT_ALL},
177 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
181 if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
182 &ret_value, value)) {
185 client_conf->verify_callback = ret_value;
189 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
191 return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
197 static const test_enum ssl_servername[] = {
198 {"None", SSL_TEST_SERVERNAME_NONE},
199 {"server1", SSL_TEST_SERVERNAME_SERVER1},
200 {"server2", SSL_TEST_SERVERNAME_SERVER2},
201 {"invalid", SSL_TEST_SERVERNAME_INVALID},
204 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
208 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
209 &ret_value, value)) {
212 client_conf->servername = ret_value;
216 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
220 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
221 &ret_value, value)) {
224 test_ctx->expected_servername = ret_value;
228 const char *ssl_servername_name(ssl_servername_t server)
230 return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
234 /* ServerNameCallback */
236 static const test_enum ssl_servername_callbacks[] = {
237 {"None", SSL_TEST_SERVERNAME_CB_NONE},
238 {"IgnoreMismatch", SSL_TEST_SERVERNAME_IGNORE_MISMATCH},
239 {"RejectMismatch", SSL_TEST_SERVERNAME_REJECT_MISMATCH},
240 {"EarlyIgnoreMismatch", SSL_TEST_SERVERNAME_EARLY_IGNORE_MISMATCH},
241 {"EarlyRejectMismatch", SSL_TEST_SERVERNAME_EARLY_REJECT_MISMATCH},
242 {"EarlyNoV12", SSL_TEST_SERVERNAME_EARLY_NO_V12},
245 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
249 if (!parse_enum(ssl_servername_callbacks,
250 OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
253 server_conf->servername_callback = ret_value;
257 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
259 return enum_name(ssl_servername_callbacks,
260 OSSL_NELEM(ssl_servername_callbacks), callback);
263 /* SessionTicketExpected */
265 static const test_enum ssl_session_ticket[] = {
266 {"Ignore", SSL_TEST_SESSION_TICKET_IGNORE},
267 {"Yes", SSL_TEST_SESSION_TICKET_YES},
268 {"No", SSL_TEST_SESSION_TICKET_NO},
271 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
274 if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
275 &ret_value, value)) {
278 test_ctx->session_ticket_expected = ret_value;
282 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
284 return enum_name(ssl_session_ticket,
285 OSSL_NELEM(ssl_session_ticket),
291 static const test_enum ssl_test_methods[] = {
292 {"TLS", SSL_TEST_METHOD_TLS},
293 {"DTLS", SSL_TEST_METHOD_DTLS},
296 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
299 if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
300 &ret_value, value)) {
303 test_ctx->method = ret_value;
307 const char *ssl_test_method_name(ssl_test_method_t method)
309 return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
312 /* NPN and ALPN options */
314 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
315 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
316 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
317 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
318 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
319 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
323 static const test_enum ssl_handshake_modes[] = {
324 {"Simple", SSL_TEST_HANDSHAKE_SIMPLE},
325 {"Resume", SSL_TEST_HANDSHAKE_RESUME},
326 {"RenegotiateServer", SSL_TEST_HANDSHAKE_RENEG_SERVER},
327 {"RenegotiateClient", SSL_TEST_HANDSHAKE_RENEG_CLIENT},
328 {"KeyUpdateServer", SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER},
329 {"KeyUpdateClient", SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT},
332 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
335 if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
336 &ret_value, value)) {
339 test_ctx->handshake_mode = ret_value;
343 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
345 return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
349 /* Renegotiation Ciphersuites */
351 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, reneg_ciphers)
355 static const test_enum ssl_key_update_types[] = {
356 {"KeyUpdateRequested", SSL_KEY_UPDATE_REQUESTED},
357 {"KeyUpdateNotRequested", SSL_KEY_UPDATE_NOT_REQUESTED},
360 __owur static int parse_key_update_type(SSL_TEST_CTX *test_ctx, const char *value)
363 if (!parse_enum(ssl_key_update_types, OSSL_NELEM(ssl_key_update_types),
364 &ret_value, value)) {
367 test_ctx->key_update_type = ret_value;
373 static const test_enum ssl_ct_validation_modes[] = {
374 {"None", SSL_TEST_CT_VALIDATION_NONE},
375 {"Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE},
376 {"Strict", SSL_TEST_CT_VALIDATION_STRICT},
379 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
383 if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
384 &ret_value, value)) {
387 client_conf->ct_validation = ret_value;
391 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
393 return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
397 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
398 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, broken_session_ticket)
402 static const test_enum ssl_certstatus[] = {
403 {"None", SSL_TEST_CERT_STATUS_NONE},
404 {"GoodResponse", SSL_TEST_CERT_STATUS_GOOD_RESPONSE},
405 {"BadResponse", SSL_TEST_CERT_STATUS_BAD_RESPONSE}
408 __owur static int parse_certstatus(SSL_TEST_SERVER_CONF *server_conf,
412 if (!parse_enum(ssl_certstatus, OSSL_NELEM(ssl_certstatus), &ret_value,
416 server_conf->cert_status = ret_value;
420 const char *ssl_certstatus_name(ssl_cert_status_t cert_status)
422 return enum_name(ssl_certstatus,
423 OSSL_NELEM(ssl_certstatus), cert_status);
426 /* ApplicationData */
428 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
431 /* MaxFragmentSize */
433 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
436 /* Expected key and signature types */
438 __owur static int parse_expected_key_type(int *ptype, const char *value)
441 const EVP_PKEY_ASN1_METHOD *ameth;
445 ameth = EVP_PKEY_asn1_find_str(NULL, value, -1);
447 EVP_PKEY_asn1_get0_info(&nid, NULL, NULL, NULL, NULL, ameth);
449 nid = OBJ_sn2nid(value);
450 if (nid == NID_undef)
451 nid = OBJ_ln2nid(value);
452 #ifndef OPENSSL_NO_EC
453 if (nid == NID_undef)
454 nid = EC_curve_nist2nid(value);
456 if (nid == NID_undef)
462 __owur static int parse_expected_tmp_key_type(SSL_TEST_CTX *test_ctx,
465 return parse_expected_key_type(&test_ctx->expected_tmp_key_type, value);
468 __owur static int parse_expected_server_cert_type(SSL_TEST_CTX *test_ctx,
471 return parse_expected_key_type(&test_ctx->expected_server_cert_type,
475 __owur static int parse_expected_server_sign_type(SSL_TEST_CTX *test_ctx,
478 return parse_expected_key_type(&test_ctx->expected_server_sign_type,
482 __owur static int parse_expected_client_cert_type(SSL_TEST_CTX *test_ctx,
485 return parse_expected_key_type(&test_ctx->expected_client_cert_type,
489 __owur static int parse_expected_client_sign_type(SSL_TEST_CTX *test_ctx,
492 return parse_expected_key_type(&test_ctx->expected_client_sign_type,
497 /* Expected signing hash */
499 __owur static int parse_expected_sign_hash(int *ptype, const char *value)
505 nid = OBJ_sn2nid(value);
506 if (nid == NID_undef)
507 nid = OBJ_ln2nid(value);
508 if (nid == NID_undef)
514 __owur static int parse_expected_server_sign_hash(SSL_TEST_CTX *test_ctx,
517 return parse_expected_sign_hash(&test_ctx->expected_server_sign_hash,
521 __owur static int parse_expected_client_sign_hash(SSL_TEST_CTX *test_ctx,
524 return parse_expected_sign_hash(&test_ctx->expected_client_sign_hash,
529 /* Known test options and their corresponding parse methods. */
531 /* Top-level options. */
534 int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
535 } ssl_test_ctx_option;
537 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
538 { "ExpectedResult", &parse_expected_result },
539 { "ExpectedClientAlert", &parse_client_alert },
540 { "ExpectedServerAlert", &parse_server_alert },
541 { "ExpectedProtocol", &parse_protocol },
542 { "ExpectedServerName", &parse_expected_servername },
543 { "SessionTicketExpected", &parse_session_ticket },
544 { "Method", &parse_test_method },
545 { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
546 { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
547 { "HandshakeMode", &parse_handshake_mode },
548 { "KeyUpdateType", &parse_key_update_type },
549 { "ResumptionExpected", &parse_test_resumption_expected },
550 { "ApplicationData", &parse_test_app_data_size },
551 { "MaxFragmentSize", &parse_test_max_fragment_size },
552 { "ExpectedTmpKeyType", &parse_expected_tmp_key_type },
553 { "ExpectedServerCertType", &parse_expected_server_cert_type },
554 { "ExpectedServerSignHash", &parse_expected_server_sign_hash },
555 { "ExpectedServerSignType", &parse_expected_server_sign_type },
556 { "ExpectedClientCertType", &parse_expected_client_cert_type },
557 { "ExpectedClientSignHash", &parse_expected_client_sign_hash },
558 { "ExpectedClientSignType", &parse_expected_client_sign_type },
561 /* Nested client options. */
564 int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
565 } ssl_test_client_option;
567 static const ssl_test_client_option ssl_test_client_options[] = {
568 { "VerifyCallback", &parse_client_verify_callback },
569 { "ServerName", &parse_servername },
570 { "NPNProtocols", &parse_client_npn_protocols },
571 { "ALPNProtocols", &parse_client_alpn_protocols },
572 { "CTValidation", &parse_ct_validation },
573 { "RenegotiateCiphers", &parse_client_reneg_ciphers},
576 /* Nested server options. */
579 int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
580 } ssl_test_server_option;
582 static const ssl_test_server_option ssl_test_server_options[] = {
583 { "ServerNameCallback", &parse_servername_callback },
584 { "NPNProtocols", &parse_server_npn_protocols },
585 { "ALPNProtocols", &parse_server_alpn_protocols },
586 { "BrokenSessionTicket", &parse_server_broken_session_ticket },
587 { "CertStatus", &parse_certstatus },
591 * Since these methods are used to create tests, we use TEST_check liberally
592 * for malloc failures and other internal errors.
594 SSL_TEST_CTX *SSL_TEST_CTX_new()
597 ret = OPENSSL_zalloc(sizeof(*ret));
598 TEST_check(ret != NULL);
599 ret->app_data_size = default_app_data_size;
600 ret->max_fragment_size = default_max_fragment_size;
604 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
606 OPENSSL_free(conf->client.npn_protocols);
607 OPENSSL_free(conf->server.npn_protocols);
608 OPENSSL_free(conf->server2.npn_protocols);
609 OPENSSL_free(conf->client.alpn_protocols);
610 OPENSSL_free(conf->server.alpn_protocols);
611 OPENSSL_free(conf->server2.alpn_protocols);
612 OPENSSL_free(conf->client.reneg_ciphers);
615 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
617 ssl_test_extra_conf_free_data(&ctx->extra);
618 ssl_test_extra_conf_free_data(&ctx->resume_extra);
621 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
623 ssl_test_ctx_free_extra_data(ctx);
624 OPENSSL_free(ctx->expected_npn_protocol);
625 OPENSSL_free(ctx->expected_alpn_protocol);
629 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
630 const char *client_section)
632 STACK_OF(CONF_VALUE) *sk_conf;
636 sk_conf = NCONF_get_section(conf, client_section);
637 TEST_check(sk_conf != NULL);
639 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
641 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
642 for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
643 if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
644 if (!ssl_test_client_options[j].parse(client, option->value)) {
645 fprintf(stderr, "Bad value %s for option %s\n",
646 option->value, option->name);
654 fprintf(stderr, "Unknown test option: %s\n", option->name);
662 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
663 const char *server_section)
665 STACK_OF(CONF_VALUE) *sk_conf;
669 sk_conf = NCONF_get_section(conf, server_section);
670 TEST_check(sk_conf != NULL);
672 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
674 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
675 for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
676 if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
677 if (!ssl_test_server_options[j].parse(server, option->value)) {
678 fprintf(stderr, "Bad value %s for option %s\n",
679 option->value, option->name);
687 fprintf(stderr, "Unknown test option: %s\n", option->name);
695 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
697 STACK_OF(CONF_VALUE) *sk_conf;
702 sk_conf = NCONF_get_section(conf, test_section);
703 TEST_check(sk_conf != NULL);
705 ctx = SSL_TEST_CTX_new();
706 TEST_check(ctx != NULL);
708 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
710 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
713 if (strcmp(option->name, "client") == 0) {
714 if (!parse_client_options(&ctx->extra.client, conf,
717 } else if (strcmp(option->name, "server") == 0) {
718 if (!parse_server_options(&ctx->extra.server, conf,
721 } else if (strcmp(option->name, "server2") == 0) {
722 if (!parse_server_options(&ctx->extra.server2, conf,
725 } else if (strcmp(option->name, "resume-client") == 0) {
726 if (!parse_client_options(&ctx->resume_extra.client, conf,
729 } else if (strcmp(option->name, "resume-server") == 0) {
730 if (!parse_server_options(&ctx->resume_extra.server, conf,
733 } else if (strcmp(option->name, "resume-server2") == 0) {
734 if (!parse_server_options(&ctx->resume_extra.server2, conf,
739 for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
740 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
741 if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
742 fprintf(stderr, "Bad value %s for option %s\n",
743 option->value, option->name);
751 fprintf(stderr, "Unknown test option: %s\n", option->name);
760 SSL_TEST_CTX_free(ctx);