e8f29433da5a86e78c2d5f25d3d3a7d300c15d6b
[openssl.git] / test / ssl_test_ctx.c
1 /*
2  * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
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
8  */
9
10 #include <string.h>
11
12 #include <openssl/e_os2.h>
13 #include <openssl/crypto.h>
14
15 #include "e_os.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 (strcasecmp(value, "Yes") == 0) {
26         *result = 1;
27         return 1;
28     }
29     else if (strcasecmp(value, "No") == 0) {
30         *result = 0;
31         return 1;
32     }
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         TEST_check(ctx->field != NULL);                                 \
48         return 1;                                                       \
49     }
50
51 #define IMPLEMENT_SSL_TEST_INT_OPTION(struct_type, name, field)        \
52     static int parse_##name##_##field(struct_type *ctx, const char *value) \
53     {                                                                   \
54         ctx->field = atoi(value);                                       \
55         return 1;                                                       \
56     }
57
58 /* True enums and other test configuration values that map to an int. */
59 typedef struct {
60     const char *name;
61     int value;
62 } test_enum;
63
64
65 __owur static int parse_enum(const test_enum *enums, size_t num_enums,
66                              int *value, const char *name)
67 {
68     size_t i;
69     for (i = 0; i < num_enums; i++) {
70         if (strcmp(enums[i].name, name) == 0) {
71             *value = enums[i].value;
72             return 1;
73         }
74     }
75     return 0;
76 }
77
78 static const char *enum_name(const test_enum *enums, size_t num_enums,
79                              int value)
80 {
81     size_t i;
82     for (i = 0; i < num_enums; i++) {
83         if (enums[i].value == value) {
84             return enums[i].name;
85         }
86     }
87     return "InvalidValue";
88 }
89
90
91 /*******************/
92 /* ExpectedResult. */
93 /*******************/
94
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},
100 };
101
102 __owur static int parse_expected_result(SSL_TEST_CTX *test_ctx, const char *value)
103 {
104     int ret_value;
105     if (!parse_enum(ssl_test_results, OSSL_NELEM(ssl_test_results),
106                     &ret_value, value)) {
107         return 0;
108     }
109     test_ctx->expected_result = ret_value;
110     return 1;
111 }
112
113 const char *ssl_test_result_name(ssl_test_result_t result)
114 {
115     return enum_name(ssl_test_results, OSSL_NELEM(ssl_test_results), result);
116 }
117
118 /**********************************************/
119 /* ExpectedClientAlert / ExpectedServerAlert. */
120 /**********************************************/
121
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},
128 };
129
130 __owur static int parse_alert(int *alert, const char *value)
131 {
132     return parse_enum(ssl_alerts, OSSL_NELEM(ssl_alerts), alert, value);
133 }
134
135 __owur static int parse_client_alert(SSL_TEST_CTX *test_ctx, const char *value)
136 {
137     return parse_alert(&test_ctx->expected_client_alert, value);
138 }
139
140 __owur static int parse_server_alert(SSL_TEST_CTX *test_ctx, const char *value)
141 {
142     return parse_alert(&test_ctx->expected_server_alert, value);
143 }
144
145 const char *ssl_alert_name(int alert)
146 {
147     return enum_name(ssl_alerts, OSSL_NELEM(ssl_alerts), alert);
148 }
149
150 /********************/
151 /* ExpectedProtocol */
152 /********************/
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 /***********************/
176 /* VerifyCallback.     */
177 /***********************/
178
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},
183 };
184
185 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
186                                                const char *value)
187 {
188     int ret_value;
189     if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
190                     &ret_value, value)) {
191         return 0;
192     }
193     client_conf->verify_callback = ret_value;
194     return 1;
195 }
196
197 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
198 {
199     return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
200                      callback);
201 }
202
203 /**************/
204 /* ServerName */
205 /**************/
206
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},
212 };
213
214 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
215                                    const char *value)
216 {
217     int ret_value;
218     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
219                     &ret_value, value)) {
220         return 0;
221     }
222     client_conf->servername = ret_value;
223     return 1;
224 }
225
226 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
227                                             const char *value)
228 {
229     int ret_value;
230     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
231                     &ret_value, value)) {
232         return 0;
233     }
234     test_ctx->expected_servername = ret_value;
235     return 1;
236 }
237
238 const char *ssl_servername_name(ssl_servername_t server)
239 {
240     return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
241                      server);
242 }
243
244 /**********************/
245 /* ServerNameCallback */
246 /**********************/
247
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},
252 };
253
254 __owur static int parse_servername_callback(SSL_TEST_SERVER_CONF *server_conf,
255                                             const char *value)
256 {
257     int ret_value;
258     if (!parse_enum(ssl_servername_callbacks,
259                     OSSL_NELEM(ssl_servername_callbacks), &ret_value, value)) {
260         return 0;
261     }
262     server_conf->servername_callback = ret_value;
263     return 1;
264 }
265
266 const char *ssl_servername_callback_name(ssl_servername_callback_t callback)
267 {
268     return enum_name(ssl_servername_callbacks,
269                      OSSL_NELEM(ssl_servername_callbacks), callback);
270 }
271
272 /*************************/
273 /* SessionTicketExpected */
274 /*************************/
275
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},
280 };
281
282 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
283 {
284     int ret_value;
285     if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
286                     &ret_value, value)) {
287         return 0;
288     }
289     test_ctx->session_ticket_expected = ret_value;
290     return 1;
291 }
292
293 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
294 {
295     return enum_name(ssl_session_ticket,
296                      OSSL_NELEM(ssl_session_ticket),
297                      server);
298 }
299
300 /***********************/
301 /* Method              */
302 /***********************/
303
304 static const test_enum ssl_test_methods[] = {
305     {"TLS", SSL_TEST_METHOD_TLS},
306     {"DTLS", SSL_TEST_METHOD_DTLS},
307 };
308
309 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
310 {
311     int ret_value;
312     if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
313                     &ret_value, value)) {
314         return 0;
315     }
316     test_ctx->method = ret_value;
317     return 1;
318 }
319
320 const char *ssl_test_method_name(ssl_test_method_t method)
321 {
322     return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
323 }
324
325 /************************************/
326 /* NPN and ALPN options             */
327 /************************************/
328
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)
335
336 /***********************/
337 /* Handshake mode      */
338 /***********************/
339
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},
345 };
346
347 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
348 {
349     int ret_value;
350     if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
351                     &ret_value, value)) {
352         return 0;
353     }
354     test_ctx->handshake_mode = ret_value;
355     return 1;
356 }
357
358 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
359 {
360     return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
361                      mode);
362 }
363
364 /***********************/
365 /* CT Validation       */
366 /***********************/
367
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},
372 };
373
374 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
375                                       const char *value)
376 {
377     int ret_value;
378     if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
379                     &ret_value, value)) {
380         return 0;
381     }
382     client_conf->ct_validation = ret_value;
383     return 1;
384 }
385
386 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
387 {
388     return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
389                      mode);
390 }
391
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)
394
395 /**************/
396 /* CertStatus */
397 /**************/
398
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}
403 };
404
405 __owur static int parse_certstatus(SSL_TEST_SERVER_CONF *server_conf,
406                                             const char *value)
407 {
408     int ret_value;
409     if (!parse_enum(ssl_certstatus, OSSL_NELEM(ssl_certstatus), &ret_value,
410                     value)) {
411         return 0;
412     }
413     server_conf->cert_status = ret_value;
414     return 1;
415 }
416
417 const char *ssl_certstatus_name(ssl_cert_status_t cert_status)
418 {
419     return enum_name(ssl_certstatus,
420                      OSSL_NELEM(ssl_certstatus), cert_status);
421 }
422
423 /***********************/
424 /* ApplicationData     */
425 /***********************/
426
427 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
428
429 /***********************/
430 /* MaxFragmentSize     */
431 /***********************/
432
433 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
434
435 /*************************************************************/
436 /* Known test options and their corresponding parse methods. */
437 /*************************************************************/
438
439 /* Top-level options. */
440 typedef struct {
441     const char *name;
442     int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
443 } ssl_test_ctx_option;
444
445 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
446     { "ExpectedResult", &parse_expected_result },
447     { "ExpectedClientAlert", &parse_client_alert },
448     { "ExpectedServerAlert", &parse_server_alert },
449     { "ExpectedProtocol", &parse_protocol },
450     { "ExpectedServerName", &parse_expected_servername },
451     { "SessionTicketExpected", &parse_session_ticket },
452     { "Method", &parse_test_method },
453     { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
454     { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
455     { "HandshakeMode", &parse_handshake_mode },
456     { "ResumptionExpected", &parse_test_resumption_expected },
457     { "ApplicationData", &parse_test_app_data_size },
458     { "MaxFragmentSize", &parse_test_max_fragment_size },
459 };
460
461 /* Nested client options. */
462 typedef struct {
463     const char *name;
464     int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
465 } ssl_test_client_option;
466
467 static const ssl_test_client_option ssl_test_client_options[] = {
468     { "VerifyCallback", &parse_client_verify_callback },
469     { "ServerName", &parse_servername },
470     { "NPNProtocols", &parse_client_npn_protocols },
471     { "ALPNProtocols", &parse_client_alpn_protocols },
472     { "CTValidation", &parse_ct_validation },
473 };
474
475 /* Nested server options. */
476 typedef struct {
477     const char *name;
478     int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
479 } ssl_test_server_option;
480
481 static const ssl_test_server_option ssl_test_server_options[] = {
482     { "ServerNameCallback", &parse_servername_callback },
483     { "NPNProtocols", &parse_server_npn_protocols },
484     { "ALPNProtocols", &parse_server_alpn_protocols },
485     { "BrokenSessionTicket", &parse_server_broken_session_ticket },
486     { "CertStatus", &parse_certstatus },
487 };
488
489 /*
490  * Since these methods are used to create tests, we use TEST_check liberally
491  * for malloc failures and other internal errors.
492  */
493 SSL_TEST_CTX *SSL_TEST_CTX_new()
494 {
495     SSL_TEST_CTX *ret;
496     ret = OPENSSL_zalloc(sizeof(*ret));
497     TEST_check(ret != NULL);
498     ret->app_data_size = default_app_data_size;
499     ret->max_fragment_size = default_max_fragment_size;
500     return ret;
501 }
502
503 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
504 {
505     OPENSSL_free(conf->client.npn_protocols);
506     OPENSSL_free(conf->server.npn_protocols);
507     OPENSSL_free(conf->server2.npn_protocols);
508     OPENSSL_free(conf->client.alpn_protocols);
509     OPENSSL_free(conf->server.alpn_protocols);
510     OPENSSL_free(conf->server2.alpn_protocols);
511 }
512
513 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
514 {
515     ssl_test_extra_conf_free_data(&ctx->extra);
516     ssl_test_extra_conf_free_data(&ctx->resume_extra);
517 }
518
519 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
520 {
521     ssl_test_ctx_free_extra_data(ctx);
522     OPENSSL_free(ctx->expected_npn_protocol);
523     OPENSSL_free(ctx->expected_alpn_protocol);
524     OPENSSL_free(ctx);
525 }
526
527 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
528                                 const char *client_section)
529 {
530     STACK_OF(CONF_VALUE) *sk_conf;
531     int i;
532     size_t j;
533
534     sk_conf = NCONF_get_section(conf, client_section);
535     TEST_check(sk_conf != NULL);
536
537     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
538         int found = 0;
539         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
540         for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
541             if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
542                 if (!ssl_test_client_options[j].parse(client, option->value)) {
543                     fprintf(stderr, "Bad value %s for option %s\n",
544                             option->value, option->name);
545                     return 0;
546                 }
547                 found = 1;
548                 break;
549             }
550         }
551         if (!found) {
552             fprintf(stderr, "Unknown test option: %s\n", option->name);
553             return 0;
554         }
555     }
556
557     return 1;
558 }
559
560 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
561                                 const char *server_section)
562 {
563     STACK_OF(CONF_VALUE) *sk_conf;
564     int i;
565     size_t j;
566
567     sk_conf = NCONF_get_section(conf, server_section);
568     TEST_check(sk_conf != NULL);
569
570     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
571         int found = 0;
572         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
573         for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
574             if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
575                 if (!ssl_test_server_options[j].parse(server, option->value)) {
576                     fprintf(stderr, "Bad value %s for option %s\n",
577                             option->value, option->name);
578                     return 0;
579                 }
580                 found = 1;
581                 break;
582             }
583         }
584         if (!found) {
585             fprintf(stderr, "Unknown test option: %s\n", option->name);
586             return 0;
587         }
588     }
589
590     return 1;
591 }
592
593 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
594 {
595     STACK_OF(CONF_VALUE) *sk_conf;
596     SSL_TEST_CTX *ctx;
597     int i;
598     size_t j;
599
600     sk_conf = NCONF_get_section(conf, test_section);
601     TEST_check(sk_conf != NULL);
602
603     ctx = SSL_TEST_CTX_new();
604     TEST_check(ctx != NULL);
605
606     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
607         int found = 0;
608         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
609
610         /* Subsections */
611         if (strcmp(option->name, "client") == 0) {
612             if (!parse_client_options(&ctx->extra.client, conf,
613                                       option->value))
614                 goto err;
615         } else if (strcmp(option->name, "server") == 0) {
616             if (!parse_server_options(&ctx->extra.server, conf,
617                                       option->value))
618                 goto err;
619         } else if (strcmp(option->name, "server2") == 0) {
620             if (!parse_server_options(&ctx->extra.server2, conf,
621                                       option->value))
622                 goto err;
623         } else if (strcmp(option->name, "resume-client") == 0) {
624             if (!parse_client_options(&ctx->resume_extra.client, conf,
625                                       option->value))
626                 goto err;
627         } else if (strcmp(option->name, "resume-server") == 0) {
628             if (!parse_server_options(&ctx->resume_extra.server, conf,
629                                       option->value))
630                 goto err;
631         } else if (strcmp(option->name, "resume-server2") == 0) {
632             if (!parse_server_options(&ctx->resume_extra.server2, conf,
633                                       option->value))
634                 goto err;
635
636         } else {
637             for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
638                 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
639                     if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
640                         fprintf(stderr, "Bad value %s for option %s\n",
641                                 option->value, option->name);
642                         goto err;
643                     }
644                     found = 1;
645                     break;
646                 }
647             }
648             if (!found) {
649                 fprintf(stderr, "Unknown test option: %s\n", option->name);
650                 goto err;
651             }
652         }
653     }
654
655     goto done;
656
657  err:
658     SSL_TEST_CTX_free(ctx);
659     ctx = NULL;
660  done:
661     return ctx;
662 }