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.3", TLS1_3_VERSION},
156 {"TLSv1.2", TLS1_2_VERSION},
157 {"TLSv1.1", TLS1_1_VERSION},
158 {"TLSv1", TLS1_VERSION},
159 {"SSLv3", SSL3_VERSION},
160 {"DTLSv1", DTLS1_VERSION},
161 {"DTLSv1.2", DTLS1_2_VERSION},
164 __owur static int parse_protocol(SSL_TEST_CTX *test_ctx, const char *value)
166 return parse_enum(ssl_protocols, OSSL_NELEM(ssl_protocols),
167 &test_ctx->expected_protocol, value);
170 const char *ssl_protocol_name(int protocol)
172 return enum_name(ssl_protocols, OSSL_NELEM(ssl_protocols), protocol);
175 /***********************/
176 /* VerifyCallback. */
177 /***********************/
179 static const test_enum ssl_verify_callbacks[] = {
180 {"None", SSL_TEST_VERIFY_NONE},
181 {"AcceptAll", SSL_TEST_VERIFY_ACCEPT_ALL},
182 {"RejectAll", SSL_TEST_VERIFY_REJECT_ALL},
185 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
189 if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
190 &ret_value, value)) {
193 client_conf->verify_callback = ret_value;
197 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
199 return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
207 static const test_enum ssl_servername[] = {
208 {"None", SSL_TEST_SERVERNAME_NONE},
209 {"server1", SSL_TEST_SERVERNAME_SERVER1},
210 {"server2", SSL_TEST_SERVERNAME_SERVER2},
211 {"invalid", SSL_TEST_SERVERNAME_INVALID},
214 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
218 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
219 &ret_value, value)) {
222 client_conf->servername = ret_value;
226 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
230 if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
231 &ret_value, value)) {
234 test_ctx->expected_servername = ret_value;
238 const char *ssl_servername_name(ssl_servername_t server)
240 return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
244 /**********************/
245 /* ServerNameCallback */
246 /**********************/
248 static const test_enum ssl_servername_callbacks[] = {
249 {"None", SSL_TEST_SERVERNAME_CB_NONE},
250 {"IgnoreMismatch", SSL_TEST_SERVERNAME_IGNORE_MISMATCH},
251 {"RejectMismatch", SSL_TEST_SERVERNAME_REJECT_MISMATCH},
254 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
258 if (!parse_enum(ssl_servername_callbacks,
259 OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
262 server_conf->servername_callback = ret_value;
266 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
268 return enum_name(ssl_servername_callbacks,
269 OSSL_NELEM(ssl_servername_callbacks), callback);
272 /*************************/
273 /* SessionTicketExpected */
274 /*************************/
276 static const test_enum ssl_session_ticket[] = {
277 {"Ignore", SSL_TEST_SESSION_TICKET_IGNORE},
278 {"Yes", SSL_TEST_SESSION_TICKET_YES},
279 {"No", SSL_TEST_SESSION_TICKET_NO},
282 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
285 if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
286 &ret_value, value)) {
289 test_ctx->session_ticket_expected = ret_value;
293 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
295 return enum_name(ssl_session_ticket,
296 OSSL_NELEM(ssl_session_ticket),
300 /***********************/
302 /***********************/
304 static const test_enum ssl_test_methods[] = {
305 {"TLS", SSL_TEST_METHOD_TLS},
306 {"DTLS", SSL_TEST_METHOD_DTLS},
309 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
312 if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
313 &ret_value, value)) {
316 test_ctx->method = ret_value;
320 const char *ssl_test_method_name(ssl_test_method_t method)
322 return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
325 /************************************/
326 /* NPN and ALPN options */
327 /************************************/
329 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
330 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
331 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
332 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
333 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
334 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
336 /***********************/
338 /***********************/
340 static const test_enum ssl_handshake_modes[] = {
341 {"Simple", SSL_TEST_HANDSHAKE_SIMPLE},
342 {"Resume", SSL_TEST_HANDSHAKE_RESUME},
343 {"RenegotiateServer", SSL_TEST_HANDSHAKE_RENEG_SERVER},
344 {"RenegotiateClient", SSL_TEST_HANDSHAKE_RENEG_CLIENT},
347 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
350 if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
351 &ret_value, value)) {
354 test_ctx->handshake_mode = ret_value;
358 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
360 return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
364 /***********************/
366 /***********************/
368 static const test_enum ssl_ct_validation_modes[] = {
369 {"None", SSL_TEST_CT_VALIDATION_NONE},
370 {"Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE},
371 {"Strict", SSL_TEST_CT_VALIDATION_STRICT},
374 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
378 if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
379 &ret_value, value)) {
382 client_conf->ct_validation = ret_value;
386 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
388 return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
392 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
393 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 /***********************/
424 /* ApplicationData */
425 /***********************/
427 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
429 /***********************/
430 /* MaxFragmentSize */
431 /***********************/
433 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
435 /***********************/
436 /* ExpectedTmpKeyType */
437 /***********************/
439 __owur static int parse_expected_tmp_key_type(SSL_TEST_CTX *test_ctx,
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)
455 test_ctx->expected_tmp_key_type = nid;
459 /*************************************************************/
460 /* Known test options and their corresponding parse methods. */
461 /*************************************************************/
463 /* Top-level options. */
466 int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
467 } ssl_test_ctx_option;
469 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
470 { "ExpectedResult", &parse_expected_result },
471 { "ExpectedClientAlert", &parse_client_alert },
472 { "ExpectedServerAlert", &parse_server_alert },
473 { "ExpectedProtocol", &parse_protocol },
474 { "ExpectedServerName", &parse_expected_servername },
475 { "SessionTicketExpected", &parse_session_ticket },
476 { "Method", &parse_test_method },
477 { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
478 { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
479 { "HandshakeMode", &parse_handshake_mode },
480 { "ResumptionExpected", &parse_test_resumption_expected },
481 { "ApplicationData", &parse_test_app_data_size },
482 { "MaxFragmentSize", &parse_test_max_fragment_size },
483 { "ExpectedTmpKeyType", &parse_expected_tmp_key_type },
486 /* Nested client options. */
489 int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
490 } ssl_test_client_option;
492 static const ssl_test_client_option ssl_test_client_options[] = {
493 { "VerifyCallback", &parse_client_verify_callback },
494 { "ServerName", &parse_servername },
495 { "NPNProtocols", &parse_client_npn_protocols },
496 { "ALPNProtocols", &parse_client_alpn_protocols },
497 { "CTValidation", &parse_ct_validation },
500 /* Nested server options. */
503 int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
504 } ssl_test_server_option;
506 static const ssl_test_server_option ssl_test_server_options[] = {
507 { "ServerNameCallback", &parse_servername_callback },
508 { "NPNProtocols", &parse_server_npn_protocols },
509 { "ALPNProtocols", &parse_server_alpn_protocols },
510 { "BrokenSessionTicket", &parse_server_broken_session_ticket },
511 { "CertStatus", &parse_certstatus },
515 * Since these methods are used to create tests, we use TEST_check liberally
516 * for malloc failures and other internal errors.
518 SSL_TEST_CTX *SSL_TEST_CTX_new()
521 ret = OPENSSL_zalloc(sizeof(*ret));
522 TEST_check(ret != NULL);
523 ret->app_data_size = default_app_data_size;
524 ret->max_fragment_size = default_max_fragment_size;
528 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
530 OPENSSL_free(conf->client.npn_protocols);
531 OPENSSL_free(conf->server.npn_protocols);
532 OPENSSL_free(conf->server2.npn_protocols);
533 OPENSSL_free(conf->client.alpn_protocols);
534 OPENSSL_free(conf->server.alpn_protocols);
535 OPENSSL_free(conf->server2.alpn_protocols);
538 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
540 ssl_test_extra_conf_free_data(&ctx->extra);
541 ssl_test_extra_conf_free_data(&ctx->resume_extra);
544 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
546 ssl_test_ctx_free_extra_data(ctx);
547 OPENSSL_free(ctx->expected_npn_protocol);
548 OPENSSL_free(ctx->expected_alpn_protocol);
552 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
553 const char *client_section)
555 STACK_OF(CONF_VALUE) *sk_conf;
559 sk_conf = NCONF_get_section(conf, client_section);
560 TEST_check(sk_conf != NULL);
562 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
564 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
565 for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
566 if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
567 if (!ssl_test_client_options[j].parse(client, option->value)) {
568 fprintf(stderr, "Bad value %s for option %s\n",
569 option->value, option->name);
577 fprintf(stderr, "Unknown test option: %s\n", option->name);
585 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
586 const char *server_section)
588 STACK_OF(CONF_VALUE) *sk_conf;
592 sk_conf = NCONF_get_section(conf, server_section);
593 TEST_check(sk_conf != NULL);
595 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
597 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
598 for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
599 if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
600 if (!ssl_test_server_options[j].parse(server, option->value)) {
601 fprintf(stderr, "Bad value %s for option %s\n",
602 option->value, option->name);
610 fprintf(stderr, "Unknown test option: %s\n", option->name);
618 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
620 STACK_OF(CONF_VALUE) *sk_conf;
625 sk_conf = NCONF_get_section(conf, test_section);
626 TEST_check(sk_conf != NULL);
628 ctx = SSL_TEST_CTX_new();
629 TEST_check(ctx != NULL);
631 for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
633 const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
636 if (strcmp(option->name, "client") == 0) {
637 if (!parse_client_options(&ctx->extra.client, conf,
640 } else if (strcmp(option->name, "server") == 0) {
641 if (!parse_server_options(&ctx->extra.server, conf,
644 } else if (strcmp(option->name, "server2") == 0) {
645 if (!parse_server_options(&ctx->extra.server2, conf,
648 } else if (strcmp(option->name, "resume-client") == 0) {
649 if (!parse_client_options(&ctx->resume_extra.client, conf,
652 } else if (strcmp(option->name, "resume-server") == 0) {
653 if (!parse_server_options(&ctx->resume_extra.server, conf,
656 } else if (strcmp(option->name, "resume-server2") == 0) {
657 if (!parse_server_options(&ctx->resume_extra.server2, conf,
662 for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
663 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
664 if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
665 fprintf(stderr, "Bad value %s for option %s\n",
666 option->value, option->name);
674 fprintf(stderr, "Unknown test option: %s\n", option->name);
683 SSL_TEST_CTX_free(ctx);