Port multi-buffer tests
[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.2", TLS1_2_VERSION},
156      {"TLSv1.1", TLS1_1_VERSION},
157      {"TLSv1", TLS1_VERSION},
158      {"SSLv3", SSL3_VERSION},
159      {"DTLSv1", DTLS1_VERSION},
160      {"DTLSv1.2", DTLS1_2_VERSION},
161 };
162
163 __owur static int parse_protocol(SSL_TEST_CTX *test_ctx, const char *value)
164 {
165     return parse_enum(ssl_protocols, OSSL_NELEM(ssl_protocols),
166                       &test_ctx->expected_protocol, value);
167 }
168
169 const char *ssl_protocol_name(int protocol)
170 {
171     return enum_name(ssl_protocols, OSSL_NELEM(ssl_protocols), protocol);
172 }
173
174 /***********************/
175 /* VerifyCallback.     */
176 /***********************/
177
178 static const test_enum ssl_verify_callbacks[] = {
179     {"None", SSL_TEST_VERIFY_NONE},
180     {"AcceptAll", SSL_TEST_VERIFY_ACCEPT_ALL},
181     {"RejectAll", SSL_TEST_VERIFY_REJECT_ALL},
182 };
183
184 __owur static int parse_client_verify_callback(SSL_TEST_CLIENT_CONF *client_conf,
185                                                const char *value)
186 {
187     int ret_value;
188     if (!parse_enum(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
189                     &ret_value, value)) {
190         return 0;
191     }
192     client_conf->verify_callback = ret_value;
193     return 1;
194 }
195
196 const char *ssl_verify_callback_name(ssl_verify_callback_t callback)
197 {
198     return enum_name(ssl_verify_callbacks, OSSL_NELEM(ssl_verify_callbacks),
199                      callback);
200 }
201
202 /**************/
203 /* ServerName */
204 /**************/
205
206 static const test_enum ssl_servername[] = {
207     {"None", SSL_TEST_SERVERNAME_NONE},
208     {"server1", SSL_TEST_SERVERNAME_SERVER1},
209     {"server2", SSL_TEST_SERVERNAME_SERVER2},
210     {"invalid", SSL_TEST_SERVERNAME_INVALID},
211 };
212
213 __owur static int parse_servername(SSL_TEST_CLIENT_CONF *client_conf,
214                                    const char *value)
215 {
216     int ret_value;
217     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
218                     &ret_value, value)) {
219         return 0;
220     }
221     client_conf->servername = ret_value;
222     return 1;
223 }
224
225 __owur static int parse_expected_servername(SSL_TEST_CTX *test_ctx,
226                                             const char *value)
227 {
228     int ret_value;
229     if (!parse_enum(ssl_servername, OSSL_NELEM(ssl_servername),
230                     &ret_value, value)) {
231         return 0;
232     }
233     test_ctx->expected_servername = ret_value;
234     return 1;
235 }
236
237 const char *ssl_servername_name(ssl_servername_t server)
238 {
239     return enum_name(ssl_servername, OSSL_NELEM(ssl_servername),
240                      server);
241 }
242
243 /**********************/
244 /* ServerNameCallback */
245 /**********************/
246
247 static const test_enum ssl_servername_callbacks[] = {
248     {"None", SSL_TEST_SERVERNAME_CB_NONE},
249     {"IgnoreMismatch", SSL_TEST_SERVERNAME_IGNORE_MISMATCH},
250     {"RejectMismatch", SSL_TEST_SERVERNAME_REJECT_MISMATCH},
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 /*************************/
272 /* SessionTicketExpected */
273 /*************************/
274
275 static const test_enum ssl_session_ticket[] = {
276     {"Ignore", SSL_TEST_SESSION_TICKET_IGNORE},
277     {"Yes", SSL_TEST_SESSION_TICKET_YES},
278     {"No", SSL_TEST_SESSION_TICKET_NO},
279 };
280
281 __owur static int parse_session_ticket(SSL_TEST_CTX *test_ctx, const char *value)
282 {
283     int ret_value;
284     if (!parse_enum(ssl_session_ticket, OSSL_NELEM(ssl_session_ticket),
285                     &ret_value, value)) {
286         return 0;
287     }
288     test_ctx->session_ticket_expected = ret_value;
289     return 1;
290 }
291
292 const char *ssl_session_ticket_name(ssl_session_ticket_t server)
293 {
294     return enum_name(ssl_session_ticket,
295                      OSSL_NELEM(ssl_session_ticket),
296                      server);
297 }
298
299 /***********************/
300 /* Method              */
301 /***********************/
302
303 static const test_enum ssl_test_methods[] = {
304     {"TLS", SSL_TEST_METHOD_TLS},
305     {"DTLS", SSL_TEST_METHOD_DTLS},
306 };
307
308 __owur static int parse_test_method(SSL_TEST_CTX *test_ctx, const char *value)
309 {
310     int ret_value;
311     if (!parse_enum(ssl_test_methods, OSSL_NELEM(ssl_test_methods),
312                     &ret_value, value)) {
313         return 0;
314     }
315     test_ctx->method = ret_value;
316     return 1;
317 }
318
319 const char *ssl_test_method_name(ssl_test_method_t method)
320 {
321     return enum_name(ssl_test_methods, OSSL_NELEM(ssl_test_methods), method);
322 }
323
324 /************************************/
325 /* NPN and ALPN options             */
326 /************************************/
327
328 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, npn_protocols)
329 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, npn_protocols)
330 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_npn_protocol)
331 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CLIENT_CONF, client, alpn_protocols)
332 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_SERVER_CONF, server, alpn_protocols)
333 IMPLEMENT_SSL_TEST_STRING_OPTION(SSL_TEST_CTX, test, expected_alpn_protocol)
334
335 /***********************/
336 /* Handshake mode      */
337 /***********************/
338
339 static const test_enum ssl_handshake_modes[] = {
340     {"Simple", SSL_TEST_HANDSHAKE_SIMPLE},
341     {"Resume", SSL_TEST_HANDSHAKE_RESUME},
342     {"Renegotiate", SSL_TEST_HANDSHAKE_RENEGOTIATE},
343 };
344
345 __owur static int parse_handshake_mode(SSL_TEST_CTX *test_ctx, const char *value)
346 {
347     int ret_value;
348     if (!parse_enum(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
349                     &ret_value, value)) {
350         return 0;
351     }
352     test_ctx->handshake_mode = ret_value;
353     return 1;
354 }
355
356 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode)
357 {
358     return enum_name(ssl_handshake_modes, OSSL_NELEM(ssl_handshake_modes),
359                      mode);
360 }
361
362 /***********************/
363 /* CT Validation       */
364 /***********************/
365
366 static const test_enum ssl_ct_validation_modes[] = {
367     {"None", SSL_TEST_CT_VALIDATION_NONE},
368     {"Permissive", SSL_TEST_CT_VALIDATION_PERMISSIVE},
369     {"Strict", SSL_TEST_CT_VALIDATION_STRICT},
370 };
371
372 __owur static int parse_ct_validation(SSL_TEST_CLIENT_CONF *client_conf,
373                                       const char *value)
374 {
375     int ret_value;
376     if (!parse_enum(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
377                     &ret_value, value)) {
378         return 0;
379     }
380     client_conf->ct_validation = ret_value;
381     return 1;
382 }
383
384 const char *ssl_ct_validation_name(ssl_ct_validation_t mode)
385 {
386     return enum_name(ssl_ct_validation_modes, OSSL_NELEM(ssl_ct_validation_modes),
387                      mode);
388 }
389
390 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_CTX, test, resumption_expected)
391 IMPLEMENT_SSL_TEST_BOOL_OPTION(SSL_TEST_SERVER_CONF, server, broken_session_ticket)
392
393 /***********************/
394 /* ApplicationData     */
395 /***********************/
396
397 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, app_data_size)
398
399 /***********************/
400 /* MaxFragmentSize     */
401 /***********************/
402
403 IMPLEMENT_SSL_TEST_INT_OPTION(SSL_TEST_CTX, test, max_fragment_size)
404
405 /*************************************************************/
406 /* Known test options and their corresponding parse methods. */
407 /*************************************************************/
408
409 /* Top-level options. */
410 typedef struct {
411     const char *name;
412     int (*parse)(SSL_TEST_CTX *test_ctx, const char *value);
413 } ssl_test_ctx_option;
414
415 static const ssl_test_ctx_option ssl_test_ctx_options[] = {
416     { "ExpectedResult", &parse_expected_result },
417     { "ExpectedClientAlert", &parse_client_alert },
418     { "ExpectedServerAlert", &parse_server_alert },
419     { "ExpectedProtocol", &parse_protocol },
420     { "ExpectedServerName", &parse_expected_servername },
421     { "SessionTicketExpected", &parse_session_ticket },
422     { "Method", &parse_test_method },
423     { "ExpectedNPNProtocol", &parse_test_expected_npn_protocol },
424     { "ExpectedALPNProtocol", &parse_test_expected_alpn_protocol },
425     { "HandshakeMode", &parse_handshake_mode },
426     { "ResumptionExpected", &parse_test_resumption_expected },
427     { "ApplicationData", &parse_test_app_data_size },
428     { "MaxFragmentSize", &parse_test_max_fragment_size },
429 };
430
431 /* Nested client options. */
432 typedef struct {
433     const char *name;
434     int (*parse)(SSL_TEST_CLIENT_CONF *conf, const char *value);
435 } ssl_test_client_option;
436
437 static const ssl_test_client_option ssl_test_client_options[] = {
438     { "VerifyCallback", &parse_client_verify_callback },
439     { "ServerName", &parse_servername },
440     { "NPNProtocols", &parse_client_npn_protocols },
441     { "ALPNProtocols", &parse_client_alpn_protocols },
442     { "CTValidation", &parse_ct_validation },
443 };
444
445 /* Nested server options. */
446 typedef struct {
447     const char *name;
448     int (*parse)(SSL_TEST_SERVER_CONF *conf, const char *value);
449 } ssl_test_server_option;
450
451 static const ssl_test_server_option ssl_test_server_options[] = {
452     { "ServerNameCallback", &parse_servername_callback },
453     { "NPNProtocols", &parse_server_npn_protocols },
454     { "ALPNProtocols", &parse_server_alpn_protocols },
455     { "BrokenSessionTicket", &parse_server_broken_session_ticket },
456 };
457
458 /*
459  * Since these methods are used to create tests, we use TEST_check liberally
460  * for malloc failures and other internal errors.
461  */
462 SSL_TEST_CTX *SSL_TEST_CTX_new()
463 {
464     SSL_TEST_CTX *ret;
465     ret = OPENSSL_zalloc(sizeof(*ret));
466     TEST_check(ret != NULL);
467     ret->app_data_size = default_app_data_size;
468     ret->max_fragment_size = default_max_fragment_size;
469     return ret;
470 }
471
472 static void ssl_test_extra_conf_free_data(SSL_TEST_EXTRA_CONF *conf)
473 {
474     OPENSSL_free(conf->client.npn_protocols);
475     OPENSSL_free(conf->server.npn_protocols);
476     OPENSSL_free(conf->server2.npn_protocols);
477     OPENSSL_free(conf->client.alpn_protocols);
478     OPENSSL_free(conf->server.alpn_protocols);
479     OPENSSL_free(conf->server2.alpn_protocols);
480 }
481
482 static void ssl_test_ctx_free_extra_data(SSL_TEST_CTX *ctx)
483 {
484     ssl_test_extra_conf_free_data(&ctx->extra);
485     ssl_test_extra_conf_free_data(&ctx->resume_extra);
486 }
487
488 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx)
489 {
490     ssl_test_ctx_free_extra_data(ctx);
491     OPENSSL_free(ctx->expected_npn_protocol);
492     OPENSSL_free(ctx->expected_alpn_protocol);
493     OPENSSL_free(ctx);
494 }
495
496 static int parse_client_options(SSL_TEST_CLIENT_CONF *client, const CONF *conf,
497                                 const char *client_section)
498 {
499     STACK_OF(CONF_VALUE) *sk_conf;
500     int i;
501     size_t j;
502
503     sk_conf = NCONF_get_section(conf, client_section);
504     TEST_check(sk_conf != NULL);
505
506     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
507         int found = 0;
508         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
509         for (j = 0; j < OSSL_NELEM(ssl_test_client_options); j++) {
510             if (strcmp(option->name, ssl_test_client_options[j].name) == 0) {
511                 if (!ssl_test_client_options[j].parse(client, option->value)) {
512                     fprintf(stderr, "Bad value %s for option %s\n",
513                             option->value, option->name);
514                     return 0;
515                 }
516                 found = 1;
517                 break;
518             }
519         }
520         if (!found) {
521             fprintf(stderr, "Unknown test option: %s\n", option->name);
522             return 0;
523         }
524     }
525
526     return 1;
527 }
528
529 static int parse_server_options(SSL_TEST_SERVER_CONF *server, const CONF *conf,
530                                 const char *server_section)
531 {
532     STACK_OF(CONF_VALUE) *sk_conf;
533     int i;
534     size_t j;
535
536     sk_conf = NCONF_get_section(conf, server_section);
537     TEST_check(sk_conf != NULL);
538
539     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
540         int found = 0;
541         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
542         for (j = 0; j < OSSL_NELEM(ssl_test_server_options); j++) {
543             if (strcmp(option->name, ssl_test_server_options[j].name) == 0) {
544                 if (!ssl_test_server_options[j].parse(server, option->value)) {
545                     fprintf(stderr, "Bad value %s for option %s\n",
546                             option->value, option->name);
547                     return 0;
548                 }
549                 found = 1;
550                 break;
551             }
552         }
553         if (!found) {
554             fprintf(stderr, "Unknown test option: %s\n", option->name);
555             return 0;
556         }
557     }
558
559     return 1;
560 }
561
562 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section)
563 {
564     STACK_OF(CONF_VALUE) *sk_conf;
565     SSL_TEST_CTX *ctx;
566     int i;
567     size_t j;
568
569     sk_conf = NCONF_get_section(conf, test_section);
570     TEST_check(sk_conf != NULL);
571
572     ctx = SSL_TEST_CTX_new();
573     TEST_check(ctx != NULL);
574
575     for (i = 0; i < sk_CONF_VALUE_num(sk_conf); i++) {
576         int found = 0;
577         const CONF_VALUE *option = sk_CONF_VALUE_value(sk_conf, i);
578
579         /* Subsections */
580         if (strcmp(option->name, "client") == 0) {
581             if (!parse_client_options(&ctx->extra.client, conf,
582                                       option->value))
583                 goto err;
584         } else if (strcmp(option->name, "server") == 0) {
585             if (!parse_server_options(&ctx->extra.server, conf,
586                                       option->value))
587                 goto err;
588         } else if (strcmp(option->name, "server2") == 0) {
589             if (!parse_server_options(&ctx->extra.server2, conf,
590                                       option->value))
591                 goto err;
592         } else if (strcmp(option->name, "resume-client") == 0) {
593             if (!parse_client_options(&ctx->resume_extra.client, conf,
594                                       option->value))
595                 goto err;
596         } else if (strcmp(option->name, "resume-server") == 0) {
597             if (!parse_server_options(&ctx->resume_extra.server, conf,
598                                       option->value))
599                 goto err;
600         } else if (strcmp(option->name, "resume-server2") == 0) {
601             if (!parse_server_options(&ctx->resume_extra.server2, conf,
602                                       option->value))
603                 goto err;
604
605         } else {
606             for (j = 0; j < OSSL_NELEM(ssl_test_ctx_options); j++) {
607                 if (strcmp(option->name, ssl_test_ctx_options[j].name) == 0) {
608                     if (!ssl_test_ctx_options[j].parse(ctx, option->value)) {
609                         fprintf(stderr, "Bad value %s for option %s\n",
610                                 option->value, option->name);
611                         goto err;
612                     }
613                     found = 1;
614                     break;
615                 }
616             }
617             if (!found) {
618                 fprintf(stderr, "Unknown test option: %s\n", option->name);
619                 goto err;
620             }
621         }
622     }
623
624     goto done;
625
626  err:
627     SSL_TEST_CTX_free(ctx);
628     ctx = NULL;
629  done:
630     return ctx;
631 }