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";
95 static const test_enum ssl_test_results[] = {
96 {"Success", SSL_TEST_SUCCESS},
97 {"ServerFail", SSL_TEST_SERVER_FAIL},
98 {"ClientFail", SSL_TEST_CLIENT_FAIL},
99 {"InternalError", SSL_TEST_INTERNAL_ERROR},
102 __owur static int parse_expected_result(SSL_TEST_CTX *test_ctx, const char *value)
105 if (!parse_enum(ssl_test_results, OSSL_NELEM(ssl_test_results),
106 &ret_value, value)) {
109 test_ctx->expected_result = ret_value;
113 const char *ssl_test_result_name(ssl_test_result_t result)
115 return enum_name(ssl_test_results, OSSL_NELEM(ssl_test_results), result);
118 /**********************************************/
119 /* ExpectedClientAlert / ExpectedServerAlert. */
120 /**********************************************/
122 static const test_enum ssl_alerts[] = {
123 {"UnknownCA", SSL_AD_UNKNOWN_CA},
124 {"HandshakeFailure", SSL_AD_HANDSHAKE_FAILURE},
125 {"UnrecognizedName", SSL_AD_UNRECOGNIZED_NAME},
126 {"BadCertificate", SSL_AD_BAD_CERTIFICATE},
127 {"NoApplicationProtocol", SSL_AD_NO_APPLICATION_PROTOCOL},
130 __owur static int parse_alert(int *alert, const char *value)
132 return parse_enum(ssl_alerts, OSSL_NELEM(ssl_alerts), alert, value);
135 __owur static int parse_client_alert(SSL_TEST_CTX *test_ctx, const char *value)
137 return parse_alert(&test_ctx->expected_client_alert, value);
140 __owur static int parse_server_alert(SSL_TEST_CTX *test_ctx, const char *value)
142 return parse_alert(&test_ctx->expected_server_alert, value);
145 const char *ssl_alert_name(int alert)
147 return enum_name(ssl_alerts, OSSL_NELEM(ssl_alerts), alert);
150 /********************/
151 /* ExpectedProtocol */
152 /********************/
154 static const test_enum ssl_protocols[] = {
155 {"TLSv1.2", TLS1_2_VERSION},
156 {"TLSv1.1", TLS1_1_VERSION},
157 {"TLSv1", TLS1_VERSION},
158 {"SSLv3", SSL3_VERSION},
159 {"DTLSv1", DTLS1_VERSION},
160 {"DTLSv1.2", DTLS1_2_VERSION},
163 __owur static int parse_protocol(SSL_TEST_CTX *test_ctx, const char *value)
165 return parse_enum(ssl_protocols, OSSL_NELEM(ssl_protocols),
166 &test_ctx->expected_protocol, value);
169 const char *ssl_protocol_name(int protocol)
171 return enum_name(ssl_protocols, OSSL_NELEM(ssl_protocols), protocol);
174 /***********************/
175 /* VerifyCallback. */
176 /***********************/
178 static const test_enum ssl_verify_callbacks[] = {
179 {"None", SSL_TEST_VERIFY_NONE},
180 {"AcceptAll", SSL_TEST_VERIFY_ACCEPT_ALL},
181 {"RejectAll", SSL_TEST_VERIFY_REJECT_ALL},
184 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
188 if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
189 &ret_value, value)) {
192 client_conf->verify_callback = ret_value;
196 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
198 return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
206 static const test_enum ssl_servername[] = {
207 {"None", SSL_TEST_SERVERNAME_NONE},
208 {"server1", SSL_TEST_SERVERNAME_SERVER1},
209 {"server2", SSL_TEST_SERVERNAME_SERVER2},
210 {"invalid", SSL_TEST_SERVERNAME_INVALID},
213 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
217 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
218 &ret_value, value)) {
221 client_conf->servername = ret_value;
225 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
229 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
230 &ret_value, value)) {
233 test_ctx->expected_servername = ret_value;
237 const char *ssl_servername_name(ssl_servername_t server)
239 return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
243 /**********************/
244 /* ServerNameCallback */
245 /**********************/
247 static const test_enum ssl_servername_callbacks[] = {
248 {"None", SSL_TEST_SERVERNAME_CB_NONE},
249 {"IgnoreMismatch", SSL_TEST_SERVERNAME_IGNORE_MISMATCH},
250 {"RejectMismatch", SSL_TEST_SERVERNAME_REJECT_MISMATCH},
253 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
257 if (!parse_enum(ssl_servername_callbacks,
258 OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
261 server_conf->servername_callback = ret_value;
265 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
267 return enum_name(ssl_servername_callbacks,
268 OSSL_NELEM(ssl_servername_callbacks), callback);
271 /*************************/
272 /* SessionTicketExpected */
273 /*************************/
275 static const test_enum ssl_session_ticket[] = {
276 {"Ignore", SSL_TEST_SESSION_TICKET_IGNORE},
277 {"Yes", SSL_TEST_SESSION_TICKET_YES},
278 {"No", SSL_TEST_SESSION_TICKET_NO},
281 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
284 if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
285 &ret_value, value)) {
288 test_ctx->session_ticket_expected = ret_value;
292 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
294 return enum_name(ssl_session_ticket,
295 OSSL_NELEM(ssl_session_ticket),
299 /***********************/
301 /***********************/
303 static const test_enum ssl_test_methods[] = {
304 {"TLS", SSL_TEST_METHOD_TLS},
305 {"DTLS", SSL_TEST_METHOD_DTLS},
308 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
311 if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
312 &ret_value, value)) {
315 test_ctx->method = ret_value;
319 const char *ssl_test_method_name(ssl_test_method_t method)
321 return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
324 /************************************/
325 /* NPN and ALPN options */
326 /************************************/
328 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
329 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
330 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
331 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
332 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
333 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
335 /***********************/
337 /***********************/
339 static const test_enum ssl_handshake_modes[] = {
340 {"Simple", SSL_TEST_HANDSHAKE_SIMPLE},
341 {"Resume", SSL_TEST_HANDSHAKE_RESUME},
342 {"RenegotiateServer", SSL_TEST_HANDSHAKE_RENEG_SERVER},
343 {"RenegotiateClient", SSL_TEST_HANDSHAKE_RENEG_CLIENT},
346 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
349 if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
350 &ret_value, value)) {
353 test_ctx->handshake_mode = ret_value;
357 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
359 return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
363 /***********************/
365 /***********************/
367 static const test_enum ssl_ct_validation_modes[] = {
368 {"None", SSL_TEST_CT_VALIDATION_NONE},
369 {"Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE},
370 {"Strict", SSL_TEST_CT_VALIDATION_STRICT},
373 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
377 if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
378 &ret_value, value)) {
381 client_conf->ct_validation = ret_value;
385 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
387 return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
391 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
392 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, broken_session_ticket)
398 static const test_enum ssl_certstatus[] = {
399 {"None", SSL_TEST_CERT_STATUS_NONE},
400 {"GoodResponse", SSL_TEST_CERT_STATUS_GOOD_RESPONSE},
401 {"BadResponse", SSL_TEST_CERT_STATUS_BAD_RESPONSE}
404 __owur static int parse_certstatus(SSL_TEST_SERVER_CONF *server_conf,
408 if (!parse_enum(ssl_certstatus, OSSL_NELEM(ssl_certstatus), &ret_value,
412 server_conf->cert_status = ret_value;
416 const char *ssl_certstatus_name(ssl_cert_status_t cert_status)
418 return enum_name(ssl_certstatus,
419 OSSL_NELEM(ssl_certstatus), cert_status);
422 /***********************/
423 /* ApplicationData */
424 /***********************/
426 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
428 /***********************/
429 /* MaxFragmentSize */
430 /***********************/
432 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
434 /*************************************************************/
435 /* Known test options and their corresponding parse methods. */
436 /*************************************************************/
438 /* Top-level options. */
441 int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
442 } ssl_test_ctx_option;
444 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
445 { "ExpectedResult", &parse_expected_result },
446 { "ExpectedClientAlert", &parse_client_alert },
447 { "ExpectedServerAlert", &parse_server_alert },
448 { "ExpectedProtocol", &parse_protocol },
449 { "ExpectedServerName", &parse_expected_servername },
450 { "SessionTicketExpected", &parse_session_ticket },
451 { "Method", &parse_test_method },
452 { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
453 { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
454 { "HandshakeMode", &parse_handshake_mode },
455 { "ResumptionExpected", &parse_test_resumption_expected },
456 { "ApplicationData", &parse_test_app_data_size },
457 { "MaxFragmentSize", &parse_test_max_fragment_size },
460 /* Nested client options. */
463 int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
464 } ssl_test_client_option;
466 static const ssl_test_client_option ssl_test_client_options[] = {
467 { "VerifyCallback", &parse_client_verify_callback },
468 { "ServerName", &parse_servername },
469 { "NPNProtocols", &parse_client_npn_protocols },
470 { "ALPNProtocols", &parse_client_alpn_protocols },
471 { "CTValidation", &parse_ct_validation },
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);
512 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
514 ssl_test_extra_conf_free_data(&ctx->extra);
515 ssl_test_extra_conf_free_data(&ctx->resume_extra);
518 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
520 ssl_test_ctx_free_extra_data(ctx);
521 OPENSSL_free(ctx->expected_npn_protocol);
522 OPENSSL_free(ctx->expected_alpn_protocol);
526 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
527 const char *client_section)
529 STACK_OF(CONF_VALUE) *sk_conf;
533 sk_conf = NCONF_get_section(conf, client_section);
534 TEST_check(sk_conf != NULL);
536 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
538 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
539 for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
540 if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
541 if (!ssl_test_client_options[j].parse(client, option->value)) {
542 fprintf(stderr, "Bad value %s for option %s\n",
543 option->value, option->name);
551 fprintf(stderr, "Unknown test option: %s\n", option->name);
559 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
560 const char *server_section)
562 STACK_OF(CONF_VALUE) *sk_conf;
566 sk_conf = NCONF_get_section(conf, server_section);
567 TEST_check(sk_conf != NULL);
569 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
571 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
572 for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
573 if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
574 if (!ssl_test_server_options[j].parse(server, option->value)) {
575 fprintf(stderr, "Bad value %s for option %s\n",
576 option->value, option->name);
584 fprintf(stderr, "Unknown test option: %s\n", option->name);
592 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
594 STACK_OF(CONF_VALUE) *sk_conf;
599 sk_conf = NCONF_get_section(conf, test_section);
600 TEST_check(sk_conf != NULL);
602 ctx = SSL_TEST_CTX_new();
603 TEST_check(ctx != NULL);
605 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
607 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
610 if (strcmp(option->name, "client") == 0) {
611 if (!parse_client_options(&ctx->extra.client, conf,
614 } else if (strcmp(option->name, "server") == 0) {
615 if (!parse_server_options(&ctx->extra.server, conf,
618 } else if (strcmp(option->name, "server2") == 0) {
619 if (!parse_server_options(&ctx->extra.server2, conf,
622 } else if (strcmp(option->name, "resume-client") == 0) {
623 if (!parse_client_options(&ctx->resume_extra.client, conf,
626 } else if (strcmp(option->name, "resume-server") == 0) {
627 if (!parse_server_options(&ctx->resume_extra.server, conf,
630 } else if (strcmp(option->name, "resume-server2") == 0) {
631 if (!parse_server_options(&ctx->resume_extra.server2, conf,
636 for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
637 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
638 if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
639 fprintf(stderr, "Bad value %s for option %s\n",
640 option->value, option->name);
648 fprintf(stderr, "Unknown test option: %s\n", option->name);
657 SSL_TEST_CTX_free(ctx);