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.2", TLS1_2_VERSION},
150 {"TLSv1.1", TLS1_1_VERSION},
151 {"TLSv1", TLS1_VERSION},
152 {"SSLv3", SSL3_VERSION},
153 {"DTLSv1", DTLS1_VERSION},
154 {"DTLSv1.2", DTLS1_2_VERSION},
157 __owur static int parse_protocol(SSL_TEST_CTX *test_ctx, const char *value)
159 return parse_enum(ssl_protocols, OSSL_NELEM(ssl_protocols),
160 &test_ctx->expected_protocol, value);
163 const char *ssl_protocol_name(int protocol)
165 return enum_name(ssl_protocols, OSSL_NELEM(ssl_protocols), protocol);
170 static const test_enum ssl_verify_callbacks[] = {
171 {"None", SSL_TEST_VERIFY_NONE},
172 {"AcceptAll", SSL_TEST_VERIFY_ACCEPT_ALL},
173 {"RejectAll", SSL_TEST_VERIFY_REJECT_ALL},
176 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
180 if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
181 &ret_value, value)) {
184 client_conf->verify_callback = ret_value;
188 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
190 return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
196 static const test_enum ssl_servername[] = {
197 {"None", SSL_TEST_SERVERNAME_NONE},
198 {"server1", SSL_TEST_SERVERNAME_SERVER1},
199 {"server2", SSL_TEST_SERVERNAME_SERVER2},
200 {"invalid", SSL_TEST_SERVERNAME_INVALID},
203 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
207 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
208 &ret_value, value)) {
211 client_conf->servername = ret_value;
215 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
219 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
220 &ret_value, value)) {
223 test_ctx->expected_servername = ret_value;
227 const char *ssl_servername_name(ssl_servername_t server)
229 return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
233 /* ServerNameCallback */
235 static const test_enum ssl_servername_callbacks[] = {
236 {"None", SSL_TEST_SERVERNAME_CB_NONE},
237 {"IgnoreMismatch", SSL_TEST_SERVERNAME_IGNORE_MISMATCH},
238 {"RejectMismatch", SSL_TEST_SERVERNAME_REJECT_MISMATCH},
241 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
245 if (!parse_enum(ssl_servername_callbacks,
246 OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
249 server_conf->servername_callback = ret_value;
253 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
255 return enum_name(ssl_servername_callbacks,
256 OSSL_NELEM(ssl_servername_callbacks), callback);
259 /* SessionTicketExpected */
261 static const test_enum ssl_session_ticket[] = {
262 {"Ignore", SSL_TEST_SESSION_TICKET_IGNORE},
263 {"Yes", SSL_TEST_SESSION_TICKET_YES},
264 {"No", SSL_TEST_SESSION_TICKET_NO},
267 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
270 if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
271 &ret_value, value)) {
274 test_ctx->session_ticket_expected = ret_value;
278 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
280 return enum_name(ssl_session_ticket,
281 OSSL_NELEM(ssl_session_ticket),
287 static const test_enum ssl_test_methods[] = {
288 {"TLS", SSL_TEST_METHOD_TLS},
289 {"DTLS", SSL_TEST_METHOD_DTLS},
292 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
295 if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
296 &ret_value, value)) {
299 test_ctx->method = ret_value;
303 const char *ssl_test_method_name(ssl_test_method_t method)
305 return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
308 /* NPN and ALPN options */
310 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
311 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
312 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
313 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
314 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
315 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
319 static const test_enum ssl_handshake_modes[] = {
320 {"Simple", SSL_TEST_HANDSHAKE_SIMPLE},
321 {"Resume", SSL_TEST_HANDSHAKE_RESUME},
322 {"RenegotiateServer", SSL_TEST_HANDSHAKE_RENEG_SERVER},
323 {"RenegotiateClient", SSL_TEST_HANDSHAKE_RENEG_CLIENT},
326 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
329 if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
330 &ret_value, value)) {
333 test_ctx->handshake_mode = ret_value;
337 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
339 return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
343 /* Renegotiation Ciphersuites */
345 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, reneg_ciphers)
349 static const test_enum ssl_ct_validation_modes[] = {
350 {"None", SSL_TEST_CT_VALIDATION_NONE},
351 {"Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE},
352 {"Strict", SSL_TEST_CT_VALIDATION_STRICT},
355 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
359 if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
360 &ret_value, value)) {
363 client_conf->ct_validation = ret_value;
367 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
369 return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
373 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
374 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, broken_session_ticket)
378 static const test_enum ssl_certstatus[] = {
379 {"None", SSL_TEST_CERT_STATUS_NONE},
380 {"GoodResponse", SSL_TEST_CERT_STATUS_GOOD_RESPONSE},
381 {"BadResponse", SSL_TEST_CERT_STATUS_BAD_RESPONSE}
384 __owur static int parse_certstatus(SSL_TEST_SERVER_CONF *server_conf,
388 if (!parse_enum(ssl_certstatus, OSSL_NELEM(ssl_certstatus), &ret_value,
392 server_conf->cert_status = ret_value;
396 const char *ssl_certstatus_name(ssl_cert_status_t cert_status)
398 return enum_name(ssl_certstatus,
399 OSSL_NELEM(ssl_certstatus), cert_status);
402 /* ApplicationData */
404 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
407 /* MaxFragmentSize */
409 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
412 /* ExpectedTmpKeyType */
414 __owur static int parse_expected_tmp_key_type(SSL_TEST_CTX *test_ctx,
421 nid = OBJ_sn2nid(value);
422 if (nid == NID_undef)
423 nid = OBJ_ln2nid(value);
424 #ifndef OPENSSL_NO_EC
425 if (nid == NID_undef)
426 nid = EC_curve_nist2nid(value);
428 if (nid == NID_undef)
430 test_ctx->expected_tmp_key_type = nid;
434 /* Known test options and their corresponding parse methods. */
436 /* Top-level options. */
439 int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
440 } ssl_test_ctx_option;
442 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
443 { "ExpectedResult", &parse_expected_result },
444 { "ExpectedClientAlert", &parse_client_alert },
445 { "ExpectedServerAlert", &parse_server_alert },
446 { "ExpectedProtocol", &parse_protocol },
447 { "ExpectedServerName", &parse_expected_servername },
448 { "SessionTicketExpected", &parse_session_ticket },
449 { "Method", &parse_test_method },
450 { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
451 { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
452 { "HandshakeMode", &parse_handshake_mode },
453 { "ResumptionExpected", &parse_test_resumption_expected },
454 { "ApplicationData", &parse_test_app_data_size },
455 { "MaxFragmentSize", &parse_test_max_fragment_size },
456 { "ExpectedTmpKeyType", &parse_expected_tmp_key_type },
459 /* Nested client options. */
462 int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
463 } ssl_test_client_option;
465 static const ssl_test_client_option ssl_test_client_options[] = {
466 { "VerifyCallback", &parse_client_verify_callback },
467 { "ServerName", &parse_servername },
468 { "NPNProtocols", &parse_client_npn_protocols },
469 { "ALPNProtocols", &parse_client_alpn_protocols },
470 { "CTValidation", &parse_ct_validation },
471 { "RenegotiateCiphers", &parse_client_reneg_ciphers},
474 /* Nested server options. */
477 int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
478 } ssl_test_server_option;
480 static const ssl_test_server_option ssl_test_server_options[] = {
481 { "ServerNameCallback", &parse_servername_callback },
482 { "NPNProtocols", &parse_server_npn_protocols },
483 { "ALPNProtocols", &parse_server_alpn_protocols },
484 { "BrokenSessionTicket", &parse_server_broken_session_ticket },
485 { "CertStatus", &parse_certstatus },
489 * Since these methods are used to create tests, we use TEST_check liberally
490 * for malloc failures and other internal errors.
492 SSL_TEST_CTX *SSL_TEST_CTX_new()
495 ret = OPENSSL_zalloc(sizeof(*ret));
496 TEST_check(ret != NULL);
497 ret->app_data_size = default_app_data_size;
498 ret->max_fragment_size = default_max_fragment_size;
502 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
504 OPENSSL_free(conf->client.npn_protocols);
505 OPENSSL_free(conf->server.npn_protocols);
506 OPENSSL_free(conf->server2.npn_protocols);
507 OPENSSL_free(conf->client.alpn_protocols);
508 OPENSSL_free(conf->server.alpn_protocols);
509 OPENSSL_free(conf->server2.alpn_protocols);
510 OPENSSL_free(conf->client.reneg_ciphers);
513 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
515 ssl_test_extra_conf_free_data(&ctx->extra);
516 ssl_test_extra_conf_free_data(&ctx->resume_extra);
519 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
521 ssl_test_ctx_free_extra_data(ctx);
522 OPENSSL_free(ctx->expected_npn_protocol);
523 OPENSSL_free(ctx->expected_alpn_protocol);
527 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
528 const char *client_section)
530 STACK_OF(CONF_VALUE) *sk_conf;
534 sk_conf = NCONF_get_section(conf, client_section);
535 TEST_check(sk_conf != NULL);
537 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
539 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
540 for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
541 if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
542 if (!ssl_test_client_options[j].parse(client, option->value)) {
543 fprintf(stderr, "Bad value %s for option %s\n",
544 option->value, option->name);
552 fprintf(stderr, "Unknown test option: %s\n", option->name);
560 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
561 const char *server_section)
563 STACK_OF(CONF_VALUE) *sk_conf;
567 sk_conf = NCONF_get_section(conf, server_section);
568 TEST_check(sk_conf != NULL);
570 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
572 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
573 for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
574 if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
575 if (!ssl_test_server_options[j].parse(server, option->value)) {
576 fprintf(stderr, "Bad value %s for option %s\n",
577 option->value, option->name);
585 fprintf(stderr, "Unknown test option: %s\n", option->name);
593 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
595 STACK_OF(CONF_VALUE) *sk_conf;
600 sk_conf = NCONF_get_section(conf, test_section);
601 TEST_check(sk_conf != NULL);
603 ctx = SSL_TEST_CTX_new();
604 TEST_check(ctx != NULL);
606 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
608 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
611 if (strcmp(option->name, "client") == 0) {
612 if (!parse_client_options(&ctx->extra.client, conf,
615 } else if (strcmp(option->name, "server") == 0) {
616 if (!parse_server_options(&ctx->extra.server, conf,
619 } else if (strcmp(option->name, "server2") == 0) {
620 if (!parse_server_options(&ctx->extra.server2, conf,
623 } else if (strcmp(option->name, "resume-client") == 0) {
624 if (!parse_client_options(&ctx->resume_extra.client, conf,
627 } else if (strcmp(option->name, "resume-server") == 0) {
628 if (!parse_server_options(&ctx->resume_extra.server, conf,
631 } else if (strcmp(option->name, "resume-server2") == 0) {
632 if (!parse_server_options(&ctx->resume_extra.server2, conf,
637 for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
638 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
639 if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
640 fprintf(stderr, "Bad value %s for option %s\n",
641 option->value, option->name);
649 fprintf(stderr, "Unknown test option: %s\n", option->name);
658 SSL_TEST_CTX_free(ctx);