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},
242 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
246 if (!parse_enum(ssl_servername_callbacks,
247 OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
250 server_conf->servername_callback = ret_value;
254 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
256 return enum_name(ssl_servername_callbacks,
257 OSSL_NELEM(ssl_servername_callbacks), callback);
260 /* SessionTicketExpected */
262 static const test_enum ssl_session_ticket[] = {
263 {"Ignore", SSL_TEST_SESSION_TICKET_IGNORE},
264 {"Yes", SSL_TEST_SESSION_TICKET_YES},
265 {"No", SSL_TEST_SESSION_TICKET_NO},
268 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
271 if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
272 &ret_value, value)) {
275 test_ctx->session_ticket_expected = ret_value;
279 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
281 return enum_name(ssl_session_ticket,
282 OSSL_NELEM(ssl_session_ticket),
288 static const test_enum ssl_test_methods[] = {
289 {"TLS", SSL_TEST_METHOD_TLS},
290 {"DTLS", SSL_TEST_METHOD_DTLS},
293 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
296 if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
297 &ret_value, value)) {
300 test_ctx->method = ret_value;
304 const char *ssl_test_method_name(ssl_test_method_t method)
306 return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
309 /* NPN and ALPN options */
311 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
312 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
313 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
314 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
315 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
316 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
320 static const test_enum ssl_handshake_modes[] = {
321 {"Simple", SSL_TEST_HANDSHAKE_SIMPLE},
322 {"Resume", SSL_TEST_HANDSHAKE_RESUME},
323 {"RenegotiateServer", SSL_TEST_HANDSHAKE_RENEG_SERVER},
324 {"RenegotiateClient", SSL_TEST_HANDSHAKE_RENEG_CLIENT},
325 {"KeyUpdateServer", SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER},
326 {"KeyUpdateClient", SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT},
329 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
332 if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
333 &ret_value, value)) {
336 test_ctx->handshake_mode = ret_value;
340 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
342 return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
346 /* Renegotiation Ciphersuites */
348 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, reneg_ciphers)
352 static const test_enum ssl_key_update_types[] = {
353 {"KeyUpdateRequested", SSL_KEY_UPDATE_REQUESTED},
354 {"KeyUpdateNotRequested", SSL_KEY_UPDATE_NOT_REQUESTED},
357 __owur static int parse_key_update_type(SSL_TEST_CTX *test_ctx, const char *value)
360 if (!parse_enum(ssl_key_update_types, OSSL_NELEM(ssl_key_update_types),
361 &ret_value, value)) {
364 test_ctx->key_update_type = ret_value;
370 static const test_enum ssl_ct_validation_modes[] = {
371 {"None", SSL_TEST_CT_VALIDATION_NONE},
372 {"Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE},
373 {"Strict", SSL_TEST_CT_VALIDATION_STRICT},
376 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
380 if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
381 &ret_value, value)) {
384 client_conf->ct_validation = ret_value;
388 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
390 return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
394 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
395 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, broken_session_ticket)
399 static const test_enum ssl_certstatus[] = {
400 {"None", SSL_TEST_CERT_STATUS_NONE},
401 {"GoodResponse", SSL_TEST_CERT_STATUS_GOOD_RESPONSE},
402 {"BadResponse", SSL_TEST_CERT_STATUS_BAD_RESPONSE}
405 __owur static int parse_certstatus(SSL_TEST_SERVER_CONF *server_conf,
409 if (!parse_enum(ssl_certstatus, OSSL_NELEM(ssl_certstatus), &ret_value,
413 server_conf->cert_status = ret_value;
417 const char *ssl_certstatus_name(ssl_cert_status_t cert_status)
419 return enum_name(ssl_certstatus,
420 OSSL_NELEM(ssl_certstatus), cert_status);
423 /* ApplicationData */
425 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
428 /* MaxFragmentSize */
430 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
433 /* Expected key and signature types */
435 __owur static int parse_expected_key_type(int *ptype, const char *value)
438 const EVP_PKEY_ASN1_METHOD *ameth;
442 ameth = EVP_PKEY_asn1_find_str(NULL, value, -1);
444 EVP_PKEY_asn1_get0_info(&nid, NULL, NULL, NULL, NULL, ameth);
446 nid = OBJ_sn2nid(value);
447 if (nid == NID_undef)
448 nid = OBJ_ln2nid(value);
449 #ifndef OPENSSL_NO_EC
450 if (nid == NID_undef)
451 nid = EC_curve_nist2nid(value);
453 if (nid == NID_undef)
459 __owur static int parse_expected_tmp_key_type(SSL_TEST_CTX *test_ctx,
462 return parse_expected_key_type(&test_ctx->expected_tmp_key_type, value);
465 __owur static int parse_expected_server_cert_type(SSL_TEST_CTX *test_ctx,
468 return parse_expected_key_type(&test_ctx->expected_server_cert_type,
472 __owur static int parse_expected_server_sign_type(SSL_TEST_CTX *test_ctx,
475 return parse_expected_key_type(&test_ctx->expected_server_sign_type,
479 __owur static int parse_expected_client_cert_type(SSL_TEST_CTX *test_ctx,
482 return parse_expected_key_type(&test_ctx->expected_client_cert_type,
486 __owur static int parse_expected_client_sign_type(SSL_TEST_CTX *test_ctx,
489 return parse_expected_key_type(&test_ctx->expected_client_sign_type,
494 /* Expected signing hash */
496 __owur static int parse_expected_sign_hash(int *ptype, const char *value)
502 nid = OBJ_sn2nid(value);
503 if (nid == NID_undef)
504 nid = OBJ_ln2nid(value);
505 if (nid == NID_undef)
511 __owur static int parse_expected_server_sign_hash(SSL_TEST_CTX *test_ctx,
514 return parse_expected_sign_hash(&test_ctx->expected_server_sign_hash,
518 __owur static int parse_expected_client_sign_hash(SSL_TEST_CTX *test_ctx,
521 return parse_expected_sign_hash(&test_ctx->expected_client_sign_hash,
526 /* Known test options and their corresponding parse methods. */
528 /* Top-level options. */
531 int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
532 } ssl_test_ctx_option;
534 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
535 { "ExpectedResult", &parse_expected_result },
536 { "ExpectedClientAlert", &parse_client_alert },
537 { "ExpectedServerAlert", &parse_server_alert },
538 { "ExpectedProtocol", &parse_protocol },
539 { "ExpectedServerName", &parse_expected_servername },
540 { "SessionTicketExpected", &parse_session_ticket },
541 { "Method", &parse_test_method },
542 { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
543 { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
544 { "HandshakeMode", &parse_handshake_mode },
545 { "KeyUpdateType", &parse_key_update_type },
546 { "ResumptionExpected", &parse_test_resumption_expected },
547 { "ApplicationData", &parse_test_app_data_size },
548 { "MaxFragmentSize", &parse_test_max_fragment_size },
549 { "ExpectedTmpKeyType", &parse_expected_tmp_key_type },
550 { "ExpectedServerCertType", &parse_expected_server_cert_type },
551 { "ExpectedServerSignHash", &parse_expected_server_sign_hash },
552 { "ExpectedServerSignType", &parse_expected_server_sign_type },
553 { "ExpectedClientCertType", &parse_expected_client_cert_type },
554 { "ExpectedClientSignHash", &parse_expected_client_sign_hash },
555 { "ExpectedClientSignType", &parse_expected_client_sign_type },
558 /* Nested client options. */
561 int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
562 } ssl_test_client_option;
564 static const ssl_test_client_option ssl_test_client_options[] = {
565 { "VerifyCallback", &parse_client_verify_callback },
566 { "ServerName", &parse_servername },
567 { "NPNProtocols", &parse_client_npn_protocols },
568 { "ALPNProtocols", &parse_client_alpn_protocols },
569 { "CTValidation", &parse_ct_validation },
570 { "RenegotiateCiphers", &parse_client_reneg_ciphers},
573 /* Nested server options. */
576 int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
577 } ssl_test_server_option;
579 static const ssl_test_server_option ssl_test_server_options[] = {
580 { "ServerNameCallback", &parse_servername_callback },
581 { "NPNProtocols", &parse_server_npn_protocols },
582 { "ALPNProtocols", &parse_server_alpn_protocols },
583 { "BrokenSessionTicket", &parse_server_broken_session_ticket },
584 { "CertStatus", &parse_certstatus },
588 * Since these methods are used to create tests, we use TEST_check liberally
589 * for malloc failures and other internal errors.
591 SSL_TEST_CTX *SSL_TEST_CTX_new()
594 ret = OPENSSL_zalloc(sizeof(*ret));
595 TEST_check(ret != NULL);
596 ret->app_data_size = default_app_data_size;
597 ret->max_fragment_size = default_max_fragment_size;
601 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
603 OPENSSL_free(conf->client.npn_protocols);
604 OPENSSL_free(conf->server.npn_protocols);
605 OPENSSL_free(conf->server2.npn_protocols);
606 OPENSSL_free(conf->client.alpn_protocols);
607 OPENSSL_free(conf->server.alpn_protocols);
608 OPENSSL_free(conf->server2.alpn_protocols);
609 OPENSSL_free(conf->client.reneg_ciphers);
612 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
614 ssl_test_extra_conf_free_data(&ctx->extra);
615 ssl_test_extra_conf_free_data(&ctx->resume_extra);
618 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
620 ssl_test_ctx_free_extra_data(ctx);
621 OPENSSL_free(ctx->expected_npn_protocol);
622 OPENSSL_free(ctx->expected_alpn_protocol);
626 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
627 const char *client_section)
629 STACK_OF(CONF_VALUE) *sk_conf;
633 sk_conf = NCONF_get_section(conf, client_section);
634 TEST_check(sk_conf != NULL);
636 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
638 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
639 for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
640 if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
641 if (!ssl_test_client_options[j].parse(client, option->value)) {
642 fprintf(stderr, "Bad value %s for option %s\n",
643 option->value, option->name);
651 fprintf(stderr, "Unknown test option: %s\n", option->name);
659 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
660 const char *server_section)
662 STACK_OF(CONF_VALUE) *sk_conf;
666 sk_conf = NCONF_get_section(conf, server_section);
667 TEST_check(sk_conf != NULL);
669 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
671 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
672 for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
673 if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
674 if (!ssl_test_server_options[j].parse(server, option->value)) {
675 fprintf(stderr, "Bad value %s for option %s\n",
676 option->value, option->name);
684 fprintf(stderr, "Unknown test option: %s\n", option->name);
692 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
694 STACK_OF(CONF_VALUE) *sk_conf;
699 sk_conf = NCONF_get_section(conf, test_section);
700 TEST_check(sk_conf != NULL);
702 ctx = SSL_TEST_CTX_new();
703 TEST_check(ctx != NULL);
705 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
707 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
710 if (strcmp(option->name, "client") == 0) {
711 if (!parse_client_options(&ctx->extra.client, conf,
714 } else if (strcmp(option->name, "server") == 0) {
715 if (!parse_server_options(&ctx->extra.server, conf,
718 } else if (strcmp(option->name, "server2") == 0) {
719 if (!parse_server_options(&ctx->extra.server2, conf,
722 } else if (strcmp(option->name, "resume-client") == 0) {
723 if (!parse_client_options(&ctx->resume_extra.client, conf,
726 } else if (strcmp(option->name, "resume-server") == 0) {
727 if (!parse_server_options(&ctx->resume_extra.server, conf,
730 } else if (strcmp(option->name, "resume-server2") == 0) {
731 if (!parse_server_options(&ctx->resume_extra.server2, conf,
736 for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
737 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
738 if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
739 fprintf(stderr, "Bad value %s for option %s\n",
740 option->value, option->name);
748 fprintf(stderr, "Unknown test option: %s\n", option->name);
757 SSL_TEST_CTX_free(ctx);