Home | History | Annotate | Line # | Download | only in helpers
      1 /*
      2  * Copyright 2016-2023 The OpenSSL Project Authors. All Rights Reserved.
      3  *
      4  * Licensed under the Apache License 2.0 (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
      8  */
      9 
     10 #include <string.h>
     11 
     12 #include <openssl/e_os2.h>
     13 #include <openssl/crypto.h>
     14 
     15 #include "internal/nelem.h"
     16 #include "ssl_test_ctx.h"
     17 #include "../testutil.h"
     18 
     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;
     22 
     23 static int parse_boolean(const char *value, int *result)
     24 {
     25     if (OPENSSL_strcasecmp(value, "Yes") == 0) {
     26         *result = 1;
     27         return 1;
     28     } else if (OPENSSL_strcasecmp(value, "No") == 0) {
     29         *result = 0;
     30         return 1;
     31     }
     32     TEST_error("parse_boolean given: '%s'", value);
     33     return 0;
     34 }
     35 
     36 #define IMPLEMENT_SSL_TEST_BOOL_OPTION(struct_type, name, field)           \
     37     static int parse_##name##_##field(struct_type *ctx, const char *value) \
     38     {                                                                      \
     39         return parse_boolean(value, &ctx->field);                          \
     40     }
     41 
     42 #define IMPLEMENT_SSL_TEST_STRING_OPTION(struct_type, name, field)         \
     43     static int parse_##name##_##field(struct_type *ctx, const char *value) \
     44     {                                                                      \
     45         OPENSSL_free(ctx->field);                                          \
     46         ctx->field = OPENSSL_strdup(value);                                \
     47         return TEST_ptr(ctx->field);                                       \
     48     }
     49 
     50 #define IMPLEMENT_SSL_TEST_INT_OPTION(struct_type, name, field)            \
     51     static int parse_##name##_##field(struct_type *ctx, const char *value) \
     52     {                                                                      \
     53         ctx->field = atoi(value);                                          \
     54         return 1;                                                          \
     55     }
     56 
     57 /* True enums and other test configuration values that map to an int. */
     58 typedef struct {
     59     const char *name;
     60     int value;
     61 } test_enum;
     62 
     63 __owur static int parse_enum(const test_enum *enums, size_t num_enums,
     64     int *value, const char *name)
     65 {
     66     size_t i;
     67     for (i = 0; i < num_enums; i++) {
     68         if (strcmp(enums[i].name, name) == 0) {
     69             *value = enums[i].value;
     70             return 1;
     71         }
     72     }
     73     return 0;
     74 }
     75 
     76 static const char *enum_name(const test_enum *enums, size_t num_enums,
     77     int value)
     78 {
     79     size_t i;
     80     for (i = 0; i < num_enums; i++) {
     81         if (enums[i].value == value) {
     82             return enums[i].name;
     83         }
     84     }
     85     return "InvalidValue";
     86 }
     87 
     88 /* ExpectedResult */
     89 
     90 static const test_enum ssl_test_results[] = {
     91     { "Success", SSL_TEST_SUCCESS },
     92     { "ServerFail", SSL_TEST_SERVER_FAIL },
     93     { "ClientFail", SSL_TEST_CLIENT_FAIL },
     94     { "InternalError", SSL_TEST_INTERNAL_ERROR },
     95     { "FirstHandshakeFailed", SSL_TEST_FIRST_HANDSHAKE_FAILED },
     96 };
     97 
     98 __owur static int parse_expected_result(SSL_TEST_CTX *test_ctx, const char *value)
     99 {
    100     int ret_value;
    101     if (!parse_enum(ssl_test_results, OSSL_NELEM(ssl_test_results),
    102             &ret_value, value)) {
    103         return 0;
    104     }
    105     test_ctx->expected_result = ret_value;
    106     return 1;
    107 }
    108 
    109 const char *ssl_test_result_name(ssl_test_result_t result)
    110 {
    111     return enum_name(ssl_test_results, OSSL_NELEM(ssl_test_results), result);
    112 }
    113 
    114 /* ExpectedClientAlert / ExpectedServerAlert */
    115 
    116 static const test_enum ssl_alerts[] = {
    117     { "UnknownCA", SSL_AD_UNKNOWN_CA },
    118     { "HandshakeFailure", SSL_AD_HANDSHAKE_FAILURE },
    119     { "UnrecognizedName", SSL_AD_UNRECOGNIZED_NAME },
    120     { "NoRenegotiation", SSL_AD_NO_RENEGOTIATION },
    121     { "BadCertificate", SSL_AD_BAD_CERTIFICATE },
    122     { "NoApplicationProtocol", SSL_AD_NO_APPLICATION_PROTOCOL },
    123     { "CertificateRequired", SSL_AD_CERTIFICATE_REQUIRED },
    124 };
    125 
    126 __owur static int parse_alert(int *alert, const char *value)
    127 {
    128     return parse_enum(ssl_alerts, OSSL_NELEM(ssl_alerts), alert, value);
    129 }
    130 
    131 __owur static int parse_client_alert(SSL_TEST_CTX *test_ctx, const char *value)
    132 {
    133     return parse_alert(&test_ctx->expected_client_alert, value);
    134 }
    135 
    136 __owur static int parse_server_alert(SSL_TEST_CTX *test_ctx, const char *value)
    137 {
    138     return parse_alert(&test_ctx->expected_server_alert, value);
    139 }
    140 
    141 const char *ssl_alert_name(int alert)
    142 {
    143     return enum_name(ssl_alerts, OSSL_NELEM(ssl_alerts), alert);
    144 }
    145 
    146 /* ExpectedProtocol */
    147 
    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 },
    156 };
    157 
    158 __owur static int parse_protocol(SSL_TEST_CTX *test_ctx, const char *value)
    159 {
    160     return parse_enum(ssl_protocols, OSSL_NELEM(ssl_protocols),
    161         &test_ctx->expected_protocol, value);
    162 }
    163 
    164 const char *ssl_protocol_name(int protocol)
    165 {
    166     return enum_name(ssl_protocols, OSSL_NELEM(ssl_protocols), protocol);
    167 }
    168 
    169 /* VerifyCallback */
    170 
    171 static const test_enum ssl_verify_callbacks[] = {
    172     { "None", SSL_TEST_VERIFY_NONE },
    173     { "AcceptAll", SSL_TEST_VERIFY_ACCEPT_ALL },
    174     { "RetryOnce", SSL_TEST_VERIFY_RETRY_ONCE },
    175     { "RejectAll", SSL_TEST_VERIFY_REJECT_ALL },
    176 };
    177 
    178 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
    179     const char *value)
    180 {
    181     int ret_value;
    182 
    183     if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
    184             &ret_value, value)) {
    185         return 0;
    186     }
    187     client_conf->verify_callback = ret_value;
    188     return 1;
    189 }
    190 
    191 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
    192 {
    193     return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
    194         callback);
    195 }
    196 
    197 /* ServerName */
    198 
    199 static const test_enum ssl_servername[] = {
    200     { "None", SSL_TEST_SERVERNAME_NONE },
    201     { "server1", SSL_TEST_SERVERNAME_SERVER1 },
    202     { "server2", SSL_TEST_SERVERNAME_SERVER2 },
    203     { "invalid", SSL_TEST_SERVERNAME_INVALID },
    204 };
    205 
    206 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
    207     const char *value)
    208 {
    209     int ret_value;
    210     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
    211             &ret_value, value)) {
    212         return 0;
    213     }
    214     client_conf->servername = ret_value;
    215     return 1;
    216 }
    217 
    218 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
    219     const char *value)
    220 {
    221     int ret_value;
    222     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
    223             &ret_value, value)) {
    224         return 0;
    225     }
    226     test_ctx->expected_servername = ret_value;
    227     return 1;
    228 }
    229 
    230 const char *ssl_servername_name(ssl_servername_t server)
    231 {
    232     return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
    233         server);
    234 }
    235 
    236 /* ServerNameCallback */
    237 
    238 static const test_enum ssl_servername_callbacks[] = {
    239     { "None", SSL_TEST_SERVERNAME_CB_NONE },
    240     { "IgnoreMismatch", SSL_TEST_SERVERNAME_IGNORE_MISMATCH },
    241     { "RejectMismatch", SSL_TEST_SERVERNAME_REJECT_MISMATCH },
    242     { "ClientHelloIgnoreMismatch",
    243         SSL_TEST_SERVERNAME_CLIENT_HELLO_IGNORE_MISMATCH },
    244     { "ClientHelloRejectMismatch",
    245         SSL_TEST_SERVERNAME_CLIENT_HELLO_REJECT_MISMATCH },
    246     { "ClientHelloNoV12", SSL_TEST_SERVERNAME_CLIENT_HELLO_NO_V12 },
    247 };
    248 
    249 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
    250     const char *value)
    251 {
    252     int ret_value;
    253     if (!parse_enum(ssl_servername_callbacks,
    254             OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
    255         return 0;
    256     }
    257     server_conf->servername_callback = ret_value;
    258     return 1;
    259 }
    260 
    261 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
    262 {
    263     return enum_name(ssl_servername_callbacks,
    264         OSSL_NELEM(ssl_servername_callbacks), callback);
    265 }
    266 
    267 /* SessionTicketExpected */
    268 
    269 static const test_enum ssl_session_ticket[] = {
    270     { "Ignore", SSL_TEST_SESSION_TICKET_IGNORE },
    271     { "Yes", SSL_TEST_SESSION_TICKET_YES },
    272     { "No", SSL_TEST_SESSION_TICKET_NO },
    273 };
    274 
    275 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
    276 {
    277     int ret_value;
    278     if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
    279             &ret_value, value)) {
    280         return 0;
    281     }
    282     test_ctx->session_ticket_expected = ret_value;
    283     return 1;
    284 }
    285 
    286 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
    287 {
    288     return enum_name(ssl_session_ticket,
    289         OSSL_NELEM(ssl_session_ticket),
    290         server);
    291 }
    292 
    293 /* CompressionExpected */
    294 
    295 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, compression_expected)
    296 
    297 /* SessionIdExpected */
    298 
    299 static const test_enum ssl_session_id[] = {
    300     { "Ignore", SSL_TEST_SESSION_ID_IGNORE },
    301     { "Yes", SSL_TEST_SESSION_ID_YES },
    302     { "No", SSL_TEST_SESSION_ID_NO },
    303 };
    304 
    305 __owur static int parse_session_id(SSL_TEST_CTX *test_ctx, const char *value)
    306 {
    307     int ret_value;
    308     if (!parse_enum(ssl_session_id, OSSL_NELEM(ssl_session_id),
    309             &ret_value, value)) {
    310         return 0;
    311     }
    312     test_ctx->session_id_expected = ret_value;
    313     return 1;
    314 }
    315 
    316 const char *ssl_session_id_name(ssl_session_id_t server)
    317 {
    318     return enum_name(ssl_session_id,
    319         OSSL_NELEM(ssl_session_id),
    320         server);
    321 }
    322 
    323 /* Method */
    324 
    325 static const test_enum ssl_test_methods[] = {
    326     { "TLS", SSL_TEST_METHOD_TLS },
    327     { "DTLS", SSL_TEST_METHOD_DTLS },
    328     { "QUIC", SSL_TEST_METHOD_QUIC }
    329 };
    330 
    331 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
    332 {
    333     int ret_value;
    334     if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
    335             &ret_value, value)) {
    336         return 0;
    337     }
    338     test_ctx->method = ret_value;
    339     return 1;
    340 }
    341 
    342 const char *ssl_test_method_name(ssl_test_method_t method)
    343 {
    344     return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
    345 }
    346 
    347 /* NPN and ALPN options */
    348 
    349 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
    350 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
    351 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
    352 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
    353 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
    354 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
    355 
    356 /* SRP options */
    357 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, srp_user)
    358 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, srp_user)
    359 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, srp_password)
    360 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, srp_password)
    361 
    362 /* Session Ticket App Data options */
    363 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_session_ticket_app_data)
    364 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, session_ticket_app_data)
    365 
    366 /* Handshake mode */
    367 
    368 static const test_enum ssl_handshake_modes[] = {
    369     { "Simple", SSL_TEST_HANDSHAKE_SIMPLE },
    370     { "Resume", SSL_TEST_HANDSHAKE_RESUME },
    371     { "RenegotiateServer", SSL_TEST_HANDSHAKE_RENEG_SERVER },
    372     { "RenegotiateClient", SSL_TEST_HANDSHAKE_RENEG_CLIENT },
    373     { "KeyUpdateServer", SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER },
    374     { "KeyUpdateClient", SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT },
    375     { "PostHandshakeAuth", SSL_TEST_HANDSHAKE_POST_HANDSHAKE_AUTH },
    376 };
    377 
    378 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
    379 {
    380     int ret_value;
    381     if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
    382             &ret_value, value)) {
    383         return 0;
    384     }
    385     test_ctx->handshake_mode = ret_value;
    386     return 1;
    387 }
    388 
    389 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
    390 {
    391     return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
    392         mode);
    393 }
    394 
    395 /* Renegotiation Ciphersuites */
    396 
    397 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, reneg_ciphers)
    398 
    399 /* KeyUpdateType */
    400 
    401 static const test_enum ssl_key_update_types[] = {
    402     { "KeyUpdateRequested", SSL_KEY_UPDATE_REQUESTED },
    403     { "KeyUpdateNotRequested", SSL_KEY_UPDATE_NOT_REQUESTED },
    404 };
    405 
    406 __owur static int parse_key_update_type(SSL_TEST_CTX *test_ctx, const char *value)
    407 {
    408     int ret_value;
    409     if (!parse_enum(ssl_key_update_types, OSSL_NELEM(ssl_key_update_types),
    410             &ret_value, value)) {
    411         return 0;
    412     }
    413     test_ctx->key_update_type = ret_value;
    414     return 1;
    415 }
    416 
    417 /* CT Validation */
    418 
    419 static const test_enum ssl_ct_validation_modes[] = {
    420     { "None", SSL_TEST_CT_VALIDATION_NONE },
    421     { "Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE },
    422     { "Strict", SSL_TEST_CT_VALIDATION_STRICT },
    423 };
    424 
    425 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
    426     const char *value)
    427 {
    428     int ret_value;
    429     if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
    430             &ret_value, value)) {
    431         return 0;
    432     }
    433     client_conf->ct_validation = ret_value;
    434     return 1;
    435 }
    436 
    437 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
    438 {
    439     return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
    440         mode);
    441 }
    442 
    443 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
    444 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, broken_session_ticket)
    445 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, use_sctp)
    446 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, compress_certificates)
    447 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, enable_client_sctp_label_bug)
    448 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, enable_server_sctp_label_bug)
    449 
    450 /* CertStatus */
    451 
    452 static const test_enum ssl_certstatus[] = {
    453     { "None", SSL_TEST_CERT_STATUS_NONE },
    454     { "GoodResponse", SSL_TEST_CERT_STATUS_GOOD_RESPONSE },
    455     { "BadResponse", SSL_TEST_CERT_STATUS_BAD_RESPONSE }
    456 };
    457 
    458 __owur static int parse_certstatus(SSL_TEST_SERVER_CONF *server_conf,
    459     const char *value)
    460 {
    461     int ret_value;
    462     if (!parse_enum(ssl_certstatus, OSSL_NELEM(ssl_certstatus), &ret_value,
    463             value)) {
    464         return 0;
    465     }
    466     server_conf->cert_status = ret_value;
    467     return 1;
    468 }
    469 
    470 const char *ssl_certstatus_name(ssl_cert_status_t cert_status)
    471 {
    472     return enum_name(ssl_certstatus,
    473         OSSL_NELEM(ssl_certstatus), cert_status);
    474 }
    475 
    476 /* ApplicationData */
    477 
    478 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
    479 
    480 /* MaxFragmentSize */
    481 
    482 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
    483 
    484 /* Maximum-Fragment-Length TLS extension mode */
    485 static const test_enum ssl_max_fragment_len_mode[] = {
    486     { "None", TLSEXT_max_fragment_length_DISABLED },
    487     { "512", TLSEXT_max_fragment_length_512 },
    488     { "1024", TLSEXT_max_fragment_length_1024 },
    489     { "2048", TLSEXT_max_fragment_length_2048 },
    490     { "4096", TLSEXT_max_fragment_length_4096 }
    491 };
    492 
    493 __owur static int parse_max_fragment_len_mode(SSL_TEST_CLIENT_CONF *client_conf,
    494     const char *value)
    495 {
    496     int ret_value;
    497 
    498     if (!parse_enum(ssl_max_fragment_len_mode,
    499             OSSL_NELEM(ssl_max_fragment_len_mode), &ret_value, value)) {
    500         return 0;
    501     }
    502     client_conf->max_fragment_len_mode = ret_value;
    503     return 1;
    504 }
    505 
    506 const char *ssl_max_fragment_len_name(int MFL_mode)
    507 {
    508     return enum_name(ssl_max_fragment_len_mode,
    509         OSSL_NELEM(ssl_max_fragment_len_mode), MFL_mode);
    510 }
    511 
    512 /* Expected key and signature types */
    513 
    514 __owur static int parse_expected_key_type(int *ptype, const char *value)
    515 {
    516     int nid;
    517     const EVP_PKEY_ASN1_METHOD *ameth;
    518 
    519     if (value == NULL)
    520         return 0;
    521     ameth = EVP_PKEY_asn1_find_str(NULL, value, -1);
    522     if (ameth != NULL)
    523         EVP_PKEY_asn1_get0_info(&nid, NULL, NULL, NULL, NULL, ameth);
    524     else
    525         nid = OBJ_sn2nid(value);
    526     if (nid == NID_undef)
    527         nid = OBJ_ln2nid(value);
    528 #ifndef OPENSSL_NO_EC
    529     if (nid == NID_undef)
    530         nid = EC_curve_nist2nid(value);
    531 #endif
    532     switch (nid) {
    533     case NID_brainpoolP256r1tls13:
    534         nid = NID_brainpoolP256r1;
    535         break;
    536     case NID_brainpoolP384r1tls13:
    537         nid = NID_brainpoolP384r1;
    538         break;
    539     case NID_brainpoolP512r1tls13:
    540         nid = NID_brainpoolP512r1;
    541         break;
    542     }
    543     if (nid == NID_undef)
    544         return 0;
    545     *ptype = nid;
    546     return 1;
    547 }
    548 
    549 __owur static int parse_expected_tmp_key_type(SSL_TEST_CTX *test_ctx,
    550     const char *value)
    551 {
    552     return parse_expected_key_type(&test_ctx->expected_tmp_key_type, value);
    553 }
    554 
    555 __owur static int parse_expected_server_cert_type(SSL_TEST_CTX *test_ctx,
    556     const char *value)
    557 {
    558     return parse_expected_key_type(&test_ctx->expected_server_cert_type,
    559         value);
    560 }
    561 
    562 __owur static int parse_expected_server_sign_type(SSL_TEST_CTX *test_ctx,
    563     const char *value)
    564 {
    565     return parse_expected_key_type(&test_ctx->expected_server_sign_type,
    566         value);
    567 }
    568 
    569 __owur static int parse_expected_client_cert_type(SSL_TEST_CTX *test_ctx,
    570     const char *value)
    571 {
    572     return parse_expected_key_type(&test_ctx->expected_client_cert_type,
    573         value);
    574 }
    575 
    576 __owur static int parse_expected_client_sign_type(SSL_TEST_CTX *test_ctx,
    577     const char *value)
    578 {
    579     return parse_expected_key_type(&test_ctx->expected_client_sign_type,
    580         value);
    581 }
    582 
    583 /* Expected signing hash */
    584 
    585 __owur static int parse_expected_sign_hash(int *ptype, const char *value)
    586 {
    587     int nid;
    588 
    589     if (value == NULL)
    590         return 0;
    591     nid = OBJ_sn2nid(value);
    592     if (nid == NID_undef)
    593         nid = OBJ_ln2nid(value);
    594     if (nid == NID_undef)
    595         return 0;
    596     *ptype = nid;
    597     return 1;
    598 }
    599 
    600 __owur static int parse_expected_server_sign_hash(SSL_TEST_CTX *test_ctx,
    601     const char *value)
    602 {
    603     return parse_expected_sign_hash(&test_ctx->expected_server_sign_hash,
    604         value);
    605 }
    606 
    607 __owur static int parse_expected_client_sign_hash(SSL_TEST_CTX *test_ctx,
    608     const char *value)
    609 {
    610     return parse_expected_sign_hash(&test_ctx->expected_client_sign_hash,
    611         value);
    612 }
    613 
    614 __owur static int parse_expected_ca_names(STACK_OF(X509_NAME) **pnames,
    615     const char *value,
    616     OSSL_LIB_CTX *libctx)
    617 {
    618     if (value == NULL)
    619         return 0;
    620     if (!strcmp(value, "empty"))
    621         *pnames = sk_X509_NAME_new_null();
    622     else
    623         *pnames = SSL_load_client_CA_file_ex(value, libctx, NULL);
    624     return *pnames != NULL;
    625 }
    626 __owur static int parse_expected_server_ca_names(SSL_TEST_CTX *test_ctx,
    627     const char *value)
    628 {
    629     return parse_expected_ca_names(&test_ctx->expected_server_ca_names, value,
    630         test_ctx->libctx);
    631 }
    632 __owur static int parse_expected_client_ca_names(SSL_TEST_CTX *test_ctx,
    633     const char *value)
    634 {
    635     return parse_expected_ca_names(&test_ctx->expected_client_ca_names, value,
    636         test_ctx->libctx);
    637 }
    638 
    639 /* ExpectedCipher */
    640 
    641 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_cipher)
    642 
    643 /* Client and Server PHA */
    644 
    645 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CLIENT_CONF, client, enable_pha)
    646 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, force_pha)
    647 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CLIENT_CONF, client, no_extms_on_reneg)
    648 
    649 /* FIPS provider version limiting */
    650 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, fips_version)
    651 
    652 /* Known test options and their corresponding parse methods. */
    653 
    654 /* Top-level options. */
    655 typedef struct {
    656     const char *name;
    657     int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
    658 } ssl_test_ctx_option;
    659 
    660 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
    661     { "ExpectedResult", &parse_expected_result },
    662     { "ExpectedClientAlert", &parse_client_alert },
    663     { "ExpectedServerAlert", &parse_server_alert },
    664     { "ExpectedProtocol", &parse_protocol },
    665     { "ExpectedServerName", &parse_expected_servername },
    666     { "SessionTicketExpected", &parse_session_ticket },
    667     { "CompressionExpected", &parse_test_compression_expected },
    668     { "SessionIdExpected", &parse_session_id },
    669     { "Method", &parse_test_method },
    670     { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
    671     { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
    672     { "HandshakeMode", &parse_handshake_mode },
    673     { "KeyUpdateType", &parse_key_update_type },
    674     { "ResumptionExpected", &parse_test_resumption_expected },
    675     { "ApplicationData", &parse_test_app_data_size },
    676     { "MaxFragmentSize", &parse_test_max_fragment_size },
    677     { "ExpectedTmpKeyType", &parse_expected_tmp_key_type },
    678     { "ExpectedServerCertType", &parse_expected_server_cert_type },
    679     { "ExpectedServerSignHash", &parse_expected_server_sign_hash },
    680     { "ExpectedServerSignType", &parse_expected_server_sign_type },
    681     { "ExpectedServerCANames", &parse_expected_server_ca_names },
    682     { "ExpectedClientCertType", &parse_expected_client_cert_type },
    683     { "ExpectedClientSignHash", &parse_expected_client_sign_hash },
    684     { "ExpectedClientSignType", &parse_expected_client_sign_type },
    685     { "ExpectedClientCANames", &parse_expected_client_ca_names },
    686     { "UseSCTP", &parse_test_use_sctp },
    687     { "CompressCertificates", &parse_test_compress_certificates },
    688     { "EnableClientSCTPLabelBug", &parse_test_enable_client_sctp_label_bug },
    689     { "EnableServerSCTPLabelBug", &parse_test_enable_server_sctp_label_bug },
    690     { "ExpectedCipher", &parse_test_expected_cipher },
    691     { "ExpectedSessionTicketAppData", &parse_test_expected_session_ticket_app_data },
    692     { "FIPSversion", &parse_test_fips_version },
    693 };
    694 
    695 /* Nested client options. */
    696 typedef struct {
    697     const char *name;
    698     int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
    699 } ssl_test_client_option;
    700 
    701 static const ssl_test_client_option ssl_test_client_options[] = {
    702     { "VerifyCallback", &parse_client_verify_callback },
    703     { "ServerName", &parse_servername },
    704     { "NPNProtocols", &parse_client_npn_protocols },
    705     { "ALPNProtocols", &parse_client_alpn_protocols },
    706     { "CTValidation", &parse_ct_validation },
    707     { "RenegotiateCiphers", &parse_client_reneg_ciphers },
    708     { "SRPUser", &parse_client_srp_user },
    709     { "SRPPassword", &parse_client_srp_password },
    710     { "MaxFragmentLenExt", &parse_max_fragment_len_mode },
    711     { "EnablePHA", &parse_client_enable_pha },
    712     { "RenegotiateNoExtms", &parse_client_no_extms_on_reneg },
    713 };
    714 
    715 /* Nested server options. */
    716 typedef struct {
    717     const char *name;
    718     int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
    719 } ssl_test_server_option;
    720 
    721 static const ssl_test_server_option ssl_test_server_options[] = {
    722     { "ServerNameCallback", &parse_servername_callback },
    723     { "NPNProtocols", &parse_server_npn_protocols },
    724     { "ALPNProtocols", &parse_server_alpn_protocols },
    725     { "BrokenSessionTicket", &parse_server_broken_session_ticket },
    726     { "CertStatus", &parse_certstatus },
    727     { "SRPUser", &parse_server_srp_user },
    728     { "SRPPassword", &parse_server_srp_password },
    729     { "ForcePHA", &parse_server_force_pha },
    730     { "SessionTicketAppData", &parse_server_session_ticket_app_data },
    731 };
    732 
    733 SSL_TEST_CTX *SSL_TEST_CTX_new(OSSL_LIB_CTX *libctx)
    734 {
    735     SSL_TEST_CTX *ret;
    736 
    737     /* The return code is checked by caller */
    738     if ((ret = OPENSSL_zalloc(sizeof(*ret))) != NULL) {
    739         ret->libctx = libctx;
    740         ret->app_data_size = default_app_data_size;
    741         ret->max_fragment_size = default_max_fragment_size;
    742     }
    743     return ret;
    744 }
    745 
    746 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
    747 {
    748     OPENSSL_free(conf->client.npn_protocols);
    749     OPENSSL_free(conf->server.npn_protocols);
    750     OPENSSL_free(conf->server2.npn_protocols);
    751     OPENSSL_free(conf->client.alpn_protocols);
    752     OPENSSL_free(conf->server.alpn_protocols);
    753     OPENSSL_free(conf->server2.alpn_protocols);
    754     OPENSSL_free(conf->client.reneg_ciphers);
    755     OPENSSL_free(conf->server.srp_user);
    756     OPENSSL_free(conf->server.srp_password);
    757     OPENSSL_free(conf->server2.srp_user);
    758     OPENSSL_free(conf->server2.srp_password);
    759     OPENSSL_free(conf->client.srp_user);
    760     OPENSSL_free(conf->client.srp_password);
    761     OPENSSL_free(conf->server.session_ticket_app_data);
    762     OPENSSL_free(conf->server2.session_ticket_app_data);
    763 }
    764 
    765 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
    766 {
    767     ssl_test_extra_conf_free_data(&ctx->extra);
    768     ssl_test_extra_conf_free_data(&ctx->resume_extra);
    769 }
    770 
    771 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
    772 {
    773     if (ctx == NULL)
    774         return;
    775     ssl_test_ctx_free_extra_data(ctx);
    776     OPENSSL_free(ctx->expected_npn_protocol);
    777     OPENSSL_free(ctx->expected_alpn_protocol);
    778     OPENSSL_free(ctx->expected_session_ticket_app_data);
    779     sk_X509_NAME_pop_free(ctx->expected_server_ca_names, X509_NAME_free);
    780     sk_X509_NAME_pop_free(ctx->expected_client_ca_names, X509_NAME_free);
    781     OPENSSL_free(ctx->expected_cipher);
    782     OPENSSL_free(ctx->fips_version);
    783     OPENSSL_free(ctx);
    784 }
    785 
    786 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
    787     const char *client_section)
    788 {
    789     STACK_OF(CONF_VALUE) *sk_conf;
    790     int i;
    791     size_t j;
    792 
    793     if (!TEST_ptr(sk_conf = NCONF_get_section(conf, client_section)))
    794         return 0;
    795 
    796     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
    797         int found = 0;
    798         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
    799         for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
    800             if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
    801                 if (!ssl_test_client_options[j].parse(client, option->value)) {
    802                     TEST_info("Bad value %s for option %s",
    803                         option->value, option->name);
    804                     return 0;
    805                 }
    806                 found = 1;
    807                 break;
    808             }
    809         }
    810         if (!found) {
    811             TEST_info("Unknown test option: %s", option->name);
    812             return 0;
    813         }
    814     }
    815 
    816     return 1;
    817 }
    818 
    819 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
    820     const char *server_section)
    821 {
    822     STACK_OF(CONF_VALUE) *sk_conf;
    823     int i;
    824     size_t j;
    825 
    826     if (!TEST_ptr(sk_conf = NCONF_get_section(conf, server_section)))
    827         return 0;
    828 
    829     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
    830         int found = 0;
    831         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
    832         for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
    833             if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
    834                 if (!ssl_test_server_options[j].parse(server, option->value)) {
    835                     TEST_info("Bad value %s for option %s",
    836                         option->value, option->name);
    837                     return 0;
    838                 }
    839                 found = 1;
    840                 break;
    841             }
    842         }
    843         if (!found) {
    844             TEST_info("Unknown test option: %s", option->name);
    845             return 0;
    846         }
    847     }
    848 
    849     return 1;
    850 }
    851 
    852 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section,
    853     OSSL_LIB_CTX *libctx)
    854 {
    855     STACK_OF(CONF_VALUE) *sk_conf = NULL;
    856     SSL_TEST_CTX *ctx = NULL;
    857     int i;
    858     size_t j;
    859 
    860     if (!TEST_ptr(sk_conf = NCONF_get_section(conf, test_section))
    861         || !TEST_ptr(ctx = SSL_TEST_CTX_new(libctx)))
    862         goto err;
    863 
    864     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
    865         int found = 0;
    866         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
    867 
    868         /* Subsections */
    869         if (strcmp(option->name, "client") == 0) {
    870             if (!parse_client_options(&ctx->extra.client, conf, option->value))
    871                 goto err;
    872         } else if (strcmp(option->name, "server") == 0) {
    873             if (!parse_server_options(&ctx->extra.server, conf, option->value))
    874                 goto err;
    875         } else if (strcmp(option->name, "server2") == 0) {
    876             if (!parse_server_options(&ctx->extra.server2, conf, option->value))
    877                 goto err;
    878         } else if (strcmp(option->name, "resume-client") == 0) {
    879             if (!parse_client_options(&ctx->resume_extra.client, conf,
    880                     option->value))
    881                 goto err;
    882         } else if (strcmp(option->name, "resume-server") == 0) {
    883             if (!parse_server_options(&ctx->resume_extra.server, conf,
    884                     option->value))
    885                 goto err;
    886         } else if (strcmp(option->name, "resume-server2") == 0) {
    887             if (!parse_server_options(&ctx->resume_extra.server2, conf,
    888                     option->value))
    889                 goto err;
    890         } else {
    891             for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
    892                 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
    893                     if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
    894                         TEST_info("Bad value %s for option %s",
    895                             option->value, option->name);
    896                         goto err;
    897                     }
    898                     found = 1;
    899                     break;
    900                 }
    901             }
    902             if (!found) {
    903                 TEST_info("Unknown test option: %s", option->name);
    904                 goto err;
    905             }
    906         }
    907     }
    908 
    909     goto done;
    910 
    911 err:
    912     SSL_TEST_CTX_free(ctx);
    913     ctx = NULL;
    914 done:
    915     return ctx;
    916 }
    917