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