]> git.ipfire.org Git - thirdparty/openssl.git/blob - test/handshake_helper.c
c0265ab3c0ddc70739fb53b21680a75d577d1f7a
[thirdparty/openssl.git] / test / handshake_helper.c
1 /*
2 * Copyright 2016-2018 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/bio.h>
13 #include <openssl/x509_vfy.h>
14 #include <openssl/ssl.h>
15 #ifndef OPENSSL_NO_SRP
16 #include <openssl/srp.h>
17 #endif
18
19 #include "../ssl/ssl_locl.h"
20 #include "internal/sockets.h"
21 #include "internal/nelem.h"
22 #include "handshake_helper.h"
23 #include "testutil.h"
24
25 HANDSHAKE_RESULT *HANDSHAKE_RESULT_new()
26 {
27 HANDSHAKE_RESULT *ret;
28
29 TEST_ptr(ret = OPENSSL_zalloc(sizeof(*ret)));
30 return ret;
31 }
32
33 void HANDSHAKE_RESULT_free(HANDSHAKE_RESULT *result)
34 {
35 if (result == NULL)
36 return;
37 OPENSSL_free(result->client_npn_negotiated);
38 OPENSSL_free(result->server_npn_negotiated);
39 OPENSSL_free(result->client_alpn_negotiated);
40 OPENSSL_free(result->server_alpn_negotiated);
41 sk_X509_NAME_pop_free(result->server_ca_names, X509_NAME_free);
42 sk_X509_NAME_pop_free(result->client_ca_names, X509_NAME_free);
43 OPENSSL_free(result->cipher);
44 OPENSSL_free(result);
45 }
46
47 /*
48 * Since there appears to be no way to extract the sent/received alert
49 * from the SSL object directly, we use the info callback and stash
50 * the result in ex_data.
51 */
52 typedef struct handshake_ex_data_st {
53 int alert_sent;
54 int num_fatal_alerts_sent;
55 int alert_received;
56 int session_ticket_do_not_call;
57 ssl_servername_t servername;
58 } HANDSHAKE_EX_DATA;
59
60 typedef struct ctx_data_st {
61 unsigned char *npn_protocols;
62 size_t npn_protocols_len;
63 unsigned char *alpn_protocols;
64 size_t alpn_protocols_len;
65 char *srp_user;
66 char *srp_password;
67 } CTX_DATA;
68
69 /* |ctx_data| itself is stack-allocated. */
70 static void ctx_data_free_data(CTX_DATA *ctx_data)
71 {
72 OPENSSL_free(ctx_data->npn_protocols);
73 ctx_data->npn_protocols = NULL;
74 OPENSSL_free(ctx_data->alpn_protocols);
75 ctx_data->alpn_protocols = NULL;
76 OPENSSL_free(ctx_data->srp_user);
77 ctx_data->srp_user = NULL;
78 OPENSSL_free(ctx_data->srp_password);
79 ctx_data->srp_password = NULL;
80 }
81
82 static int ex_data_idx;
83
84 static void info_cb(const SSL *s, int where, int ret)
85 {
86 if (where & SSL_CB_ALERT) {
87 HANDSHAKE_EX_DATA *ex_data =
88 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
89 if (where & SSL_CB_WRITE) {
90 ex_data->alert_sent = ret;
91 if (strcmp(SSL_alert_type_string(ret), "F") == 0
92 || strcmp(SSL_alert_desc_string(ret), "CN") == 0)
93 ex_data->num_fatal_alerts_sent++;
94 } else {
95 ex_data->alert_received = ret;
96 }
97 }
98 }
99
100 /* Select the appropriate server CTX.
101 * Returns SSL_TLSEXT_ERR_OK if a match was found.
102 * If |ignore| is 1, returns SSL_TLSEXT_ERR_NOACK on mismatch.
103 * Otherwise, returns SSL_TLSEXT_ERR_ALERT_FATAL on mismatch.
104 * An empty SNI extension also returns SSL_TSLEXT_ERR_NOACK.
105 */
106 static int select_server_ctx(SSL *s, void *arg, int ignore)
107 {
108 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
109 HANDSHAKE_EX_DATA *ex_data =
110 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
111
112 if (servername == NULL) {
113 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
114 return SSL_TLSEXT_ERR_NOACK;
115 }
116
117 if (strcmp(servername, "server2") == 0) {
118 SSL_CTX *new_ctx = (SSL_CTX*)arg;
119 SSL_set_SSL_CTX(s, new_ctx);
120 /*
121 * Copy over all the SSL_CTX options - reasonable behavior
122 * allows testing of cases where the options between two
123 * contexts differ/conflict
124 */
125 SSL_clear_options(s, 0xFFFFFFFFL);
126 SSL_set_options(s, SSL_CTX_get_options(new_ctx));
127
128 ex_data->servername = SSL_TEST_SERVERNAME_SERVER2;
129 return SSL_TLSEXT_ERR_OK;
130 } else if (strcmp(servername, "server1") == 0) {
131 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
132 return SSL_TLSEXT_ERR_OK;
133 } else if (ignore) {
134 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
135 return SSL_TLSEXT_ERR_NOACK;
136 } else {
137 /* Don't set an explicit alert, to test library defaults. */
138 return SSL_TLSEXT_ERR_ALERT_FATAL;
139 }
140 }
141
142 static int client_hello_select_server_ctx(SSL *s, void *arg, int ignore)
143 {
144 const char *servername;
145 const unsigned char *p;
146 size_t len, remaining;
147 HANDSHAKE_EX_DATA *ex_data =
148 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
149
150 /*
151 * The server_name extension was given too much extensibility when it
152 * was written, so parsing the normal case is a bit complex.
153 */
154 if (!SSL_client_hello_get0_ext(s, TLSEXT_TYPE_server_name, &p,
155 &remaining) ||
156 remaining <= 2)
157 return 0;
158 /* Extract the length of the supplied list of names. */
159 len = (*(p++) << 8);
160 len += *(p++);
161 if (len + 2 != remaining)
162 return 0;
163 remaining = len;
164 /*
165 * The list in practice only has a single element, so we only consider
166 * the first one.
167 */
168 if (remaining == 0 || *p++ != TLSEXT_NAMETYPE_host_name)
169 return 0;
170 remaining--;
171 /* Now we can finally pull out the byte array with the actual hostname. */
172 if (remaining <= 2)
173 return 0;
174 len = (*(p++) << 8);
175 len += *(p++);
176 if (len + 2 > remaining)
177 return 0;
178 remaining = len;
179 servername = (const char *)p;
180
181 if (len == strlen("server2") && strncmp(servername, "server2", len) == 0) {
182 SSL_CTX *new_ctx = arg;
183 SSL_set_SSL_CTX(s, new_ctx);
184 /*
185 * Copy over all the SSL_CTX options - reasonable behavior
186 * allows testing of cases where the options between two
187 * contexts differ/conflict
188 */
189 SSL_clear_options(s, 0xFFFFFFFFL);
190 SSL_set_options(s, SSL_CTX_get_options(new_ctx));
191
192 ex_data->servername = SSL_TEST_SERVERNAME_SERVER2;
193 return 1;
194 } else if (len == strlen("server1") &&
195 strncmp(servername, "server1", len) == 0) {
196 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
197 return 1;
198 } else if (ignore) {
199 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
200 return 1;
201 }
202 return 0;
203 }
204 /*
205 * (RFC 6066):
206 * If the server understood the ClientHello extension but
207 * does not recognize the server name, the server SHOULD take one of two
208 * actions: either abort the handshake by sending a fatal-level
209 * unrecognized_name(112) alert or continue the handshake.
210 *
211 * This behaviour is up to the application to configure; we test both
212 * configurations to ensure the state machine propagates the result
213 * correctly.
214 */
215 static int servername_ignore_cb(SSL *s, int *ad, void *arg)
216 {
217 return select_server_ctx(s, arg, 1);
218 }
219
220 static int servername_reject_cb(SSL *s, int *ad, void *arg)
221 {
222 return select_server_ctx(s, arg, 0);
223 }
224
225 static int client_hello_ignore_cb(SSL *s, int *al, void *arg)
226 {
227 if (!client_hello_select_server_ctx(s, arg, 1)) {
228 *al = SSL_AD_UNRECOGNIZED_NAME;
229 return SSL_CLIENT_HELLO_ERROR;
230 }
231 return SSL_CLIENT_HELLO_SUCCESS;
232 }
233
234 static int client_hello_reject_cb(SSL *s, int *al, void *arg)
235 {
236 if (!client_hello_select_server_ctx(s, arg, 0)) {
237 *al = SSL_AD_UNRECOGNIZED_NAME;
238 return SSL_CLIENT_HELLO_ERROR;
239 }
240 return SSL_CLIENT_HELLO_SUCCESS;
241 }
242
243 static int client_hello_nov12_cb(SSL *s, int *al, void *arg)
244 {
245 int ret;
246 unsigned int v;
247 const unsigned char *p;
248
249 v = SSL_client_hello_get0_legacy_version(s);
250 if (v > TLS1_2_VERSION || v < SSL3_VERSION) {
251 *al = SSL_AD_PROTOCOL_VERSION;
252 return SSL_CLIENT_HELLO_ERROR;
253 }
254 (void)SSL_client_hello_get0_session_id(s, &p);
255 if (p == NULL ||
256 SSL_client_hello_get0_random(s, &p) == 0 ||
257 SSL_client_hello_get0_ciphers(s, &p) == 0 ||
258 SSL_client_hello_get0_compression_methods(s, &p) == 0) {
259 *al = SSL_AD_INTERNAL_ERROR;
260 return SSL_CLIENT_HELLO_ERROR;
261 }
262 ret = client_hello_select_server_ctx(s, arg, 0);
263 SSL_set_max_proto_version(s, TLS1_1_VERSION);
264 if (!ret) {
265 *al = SSL_AD_UNRECOGNIZED_NAME;
266 return SSL_CLIENT_HELLO_ERROR;
267 }
268 return SSL_CLIENT_HELLO_SUCCESS;
269 }
270
271 static unsigned char dummy_ocsp_resp_good_val = 0xff;
272 static unsigned char dummy_ocsp_resp_bad_val = 0xfe;
273
274 static int server_ocsp_cb(SSL *s, void *arg)
275 {
276 unsigned char *resp;
277
278 resp = OPENSSL_malloc(1);
279 if (resp == NULL)
280 return SSL_TLSEXT_ERR_ALERT_FATAL;
281 /*
282 * For the purposes of testing we just send back a dummy OCSP response
283 */
284 *resp = *(unsigned char *)arg;
285 if (!SSL_set_tlsext_status_ocsp_resp(s, resp, 1))
286 return SSL_TLSEXT_ERR_ALERT_FATAL;
287
288 return SSL_TLSEXT_ERR_OK;
289 }
290
291 static int client_ocsp_cb(SSL *s, void *arg)
292 {
293 const unsigned char *resp;
294 int len;
295
296 len = SSL_get_tlsext_status_ocsp_resp(s, &resp);
297 if (len != 1 || *resp != dummy_ocsp_resp_good_val)
298 return 0;
299
300 return 1;
301 }
302
303 static int verify_reject_cb(X509_STORE_CTX *ctx, void *arg) {
304 X509_STORE_CTX_set_error(ctx, X509_V_ERR_APPLICATION_VERIFICATION);
305 return 0;
306 }
307
308 static int verify_accept_cb(X509_STORE_CTX *ctx, void *arg) {
309 return 1;
310 }
311
312 static int broken_session_ticket_cb(SSL *s, unsigned char *key_name, unsigned char *iv,
313 EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc)
314 {
315 return 0;
316 }
317
318 static int do_not_call_session_ticket_cb(SSL *s, unsigned char *key_name,
319 unsigned char *iv,
320 EVP_CIPHER_CTX *ctx,
321 HMAC_CTX *hctx, int enc)
322 {
323 HANDSHAKE_EX_DATA *ex_data =
324 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
325 ex_data->session_ticket_do_not_call = 1;
326 return 0;
327 }
328
329 /* Parse the comma-separated list into TLS format. */
330 static int parse_protos(const char *protos, unsigned char **out, size_t *outlen)
331 {
332 size_t len, i, prefix;
333
334 len = strlen(protos);
335
336 /* Should never have reuse. */
337 if (!TEST_ptr_null(*out)
338 /* Test values are small, so we omit length limit checks. */
339 || !TEST_ptr(*out = OPENSSL_malloc(len + 1)))
340 return 0;
341 *outlen = len + 1;
342
343 /*
344 * foo => '3', 'f', 'o', 'o'
345 * foo,bar => '3', 'f', 'o', 'o', '3', 'b', 'a', 'r'
346 */
347 memcpy(*out + 1, protos, len);
348
349 prefix = 0;
350 i = prefix + 1;
351 while (i <= len) {
352 if ((*out)[i] == ',') {
353 if (!TEST_int_gt(i - 1, prefix))
354 goto err;
355 (*out)[prefix] = (unsigned char)(i - 1 - prefix);
356 prefix = i;
357 }
358 i++;
359 }
360 if (!TEST_int_gt(len, prefix))
361 goto err;
362 (*out)[prefix] = (unsigned char)(len - prefix);
363 return 1;
364
365 err:
366 OPENSSL_free(*out);
367 *out = NULL;
368 return 0;
369 }
370
371 #ifndef OPENSSL_NO_NEXTPROTONEG
372 /*
373 * The client SHOULD select the first protocol advertised by the server that it
374 * also supports. In the event that the client doesn't support any of server's
375 * protocols, or the server doesn't advertise any, it SHOULD select the first
376 * protocol that it supports.
377 */
378 static int client_npn_cb(SSL *s, unsigned char **out, unsigned char *outlen,
379 const unsigned char *in, unsigned int inlen,
380 void *arg)
381 {
382 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
383 int ret;
384
385 ret = SSL_select_next_proto(out, outlen, in, inlen,
386 ctx_data->npn_protocols,
387 ctx_data->npn_protocols_len);
388 /* Accept both OPENSSL_NPN_NEGOTIATED and OPENSSL_NPN_NO_OVERLAP. */
389 return TEST_true(ret == OPENSSL_NPN_NEGOTIATED || ret == OPENSSL_NPN_NO_OVERLAP)
390 ? SSL_TLSEXT_ERR_OK : SSL_TLSEXT_ERR_ALERT_FATAL;
391 }
392
393 static int server_npn_cb(SSL *s, const unsigned char **data,
394 unsigned int *len, void *arg)
395 {
396 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
397 *data = ctx_data->npn_protocols;
398 *len = ctx_data->npn_protocols_len;
399 return SSL_TLSEXT_ERR_OK;
400 }
401 #endif
402
403 /*
404 * The server SHOULD select the most highly preferred protocol that it supports
405 * and that is also advertised by the client. In the event that the server
406 * supports no protocols that the client advertises, then the server SHALL
407 * respond with a fatal "no_application_protocol" alert.
408 */
409 static int server_alpn_cb(SSL *s, const unsigned char **out,
410 unsigned char *outlen, const unsigned char *in,
411 unsigned int inlen, void *arg)
412 {
413 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
414 int ret;
415
416 /* SSL_select_next_proto isn't const-correct... */
417 unsigned char *tmp_out;
418
419 /*
420 * The result points either to |in| or to |ctx_data->alpn_protocols|.
421 * The callback is allowed to point to |in| or to a long-lived buffer,
422 * so we can return directly without storing a copy.
423 */
424 ret = SSL_select_next_proto(&tmp_out, outlen,
425 ctx_data->alpn_protocols,
426 ctx_data->alpn_protocols_len, in, inlen);
427
428 *out = tmp_out;
429 /* Unlike NPN, we don't tolerate a mismatch. */
430 return ret == OPENSSL_NPN_NEGOTIATED ? SSL_TLSEXT_ERR_OK
431 : SSL_TLSEXT_ERR_ALERT_FATAL;
432 }
433
434 #ifndef OPENSSL_NO_SRP
435 static char *client_srp_cb(SSL *s, void *arg)
436 {
437 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
438 return OPENSSL_strdup(ctx_data->srp_password);
439 }
440
441 static int server_srp_cb(SSL *s, int *ad, void *arg)
442 {
443 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
444 if (strcmp(ctx_data->srp_user, SSL_get_srp_username(s)) != 0)
445 return SSL3_AL_FATAL;
446 if (SSL_set_srp_server_param_pw(s, ctx_data->srp_user,
447 ctx_data->srp_password,
448 "2048" /* known group */) < 0) {
449 *ad = SSL_AD_INTERNAL_ERROR;
450 return SSL3_AL_FATAL;
451 }
452 return SSL_ERROR_NONE;
453 }
454 #endif /* !OPENSSL_NO_SRP */
455
456 /*
457 * Configure callbacks and other properties that can't be set directly
458 * in the server/client CONF.
459 */
460 static int configure_handshake_ctx(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
461 SSL_CTX *client_ctx,
462 const SSL_TEST_CTX *test,
463 const SSL_TEST_EXTRA_CONF *extra,
464 CTX_DATA *server_ctx_data,
465 CTX_DATA *server2_ctx_data,
466 CTX_DATA *client_ctx_data)
467 {
468 unsigned char *ticket_keys;
469 size_t ticket_key_len;
470
471 if (!TEST_int_eq(SSL_CTX_set_max_send_fragment(server_ctx,
472 test->max_fragment_size), 1))
473 goto err;
474 if (server2_ctx != NULL) {
475 if (!TEST_int_eq(SSL_CTX_set_max_send_fragment(server2_ctx,
476 test->max_fragment_size),
477 1))
478 goto err;
479 }
480 if (!TEST_int_eq(SSL_CTX_set_max_send_fragment(client_ctx,
481 test->max_fragment_size), 1))
482 goto err;
483
484 switch (extra->client.verify_callback) {
485 case SSL_TEST_VERIFY_ACCEPT_ALL:
486 SSL_CTX_set_cert_verify_callback(client_ctx, &verify_accept_cb, NULL);
487 break;
488 case SSL_TEST_VERIFY_REJECT_ALL:
489 SSL_CTX_set_cert_verify_callback(client_ctx, &verify_reject_cb, NULL);
490 break;
491 case SSL_TEST_VERIFY_NONE:
492 break;
493 }
494
495 switch (extra->client.max_fragment_len_mode) {
496 case TLSEXT_max_fragment_length_512:
497 case TLSEXT_max_fragment_length_1024:
498 case TLSEXT_max_fragment_length_2048:
499 case TLSEXT_max_fragment_length_4096:
500 case TLSEXT_max_fragment_length_DISABLED:
501 SSL_CTX_set_tlsext_max_fragment_length(
502 client_ctx, extra->client.max_fragment_len_mode);
503 break;
504 }
505
506 /*
507 * Link the two contexts for SNI purposes.
508 * Also do ClientHello callbacks here, as setting both ClientHello and SNI
509 * is bad.
510 */
511 switch (extra->server.servername_callback) {
512 case SSL_TEST_SERVERNAME_IGNORE_MISMATCH:
513 SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_ignore_cb);
514 SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
515 break;
516 case SSL_TEST_SERVERNAME_REJECT_MISMATCH:
517 SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_reject_cb);
518 SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
519 break;
520 case SSL_TEST_SERVERNAME_CB_NONE:
521 break;
522 case SSL_TEST_SERVERNAME_CLIENT_HELLO_IGNORE_MISMATCH:
523 SSL_CTX_set_client_hello_cb(server_ctx, client_hello_ignore_cb, server2_ctx);
524 break;
525 case SSL_TEST_SERVERNAME_CLIENT_HELLO_REJECT_MISMATCH:
526 SSL_CTX_set_client_hello_cb(server_ctx, client_hello_reject_cb, server2_ctx);
527 break;
528 case SSL_TEST_SERVERNAME_CLIENT_HELLO_NO_V12:
529 SSL_CTX_set_client_hello_cb(server_ctx, client_hello_nov12_cb, server2_ctx);
530 }
531
532 if (extra->server.cert_status != SSL_TEST_CERT_STATUS_NONE) {
533 SSL_CTX_set_tlsext_status_type(client_ctx, TLSEXT_STATUSTYPE_ocsp);
534 SSL_CTX_set_tlsext_status_cb(client_ctx, client_ocsp_cb);
535 SSL_CTX_set_tlsext_status_arg(client_ctx, NULL);
536 SSL_CTX_set_tlsext_status_cb(server_ctx, server_ocsp_cb);
537 SSL_CTX_set_tlsext_status_arg(server_ctx,
538 ((extra->server.cert_status == SSL_TEST_CERT_STATUS_GOOD_RESPONSE)
539 ? &dummy_ocsp_resp_good_val : &dummy_ocsp_resp_bad_val));
540 }
541
542 /*
543 * The initial_ctx/session_ctx always handles the encrypt/decrypt of the
544 * session ticket. This ticket_key callback is assigned to the second
545 * session (assigned via SNI), and should never be invoked
546 */
547 if (server2_ctx != NULL)
548 SSL_CTX_set_tlsext_ticket_key_cb(server2_ctx,
549 do_not_call_session_ticket_cb);
550
551 if (extra->server.broken_session_ticket) {
552 SSL_CTX_set_tlsext_ticket_key_cb(server_ctx, broken_session_ticket_cb);
553 }
554 #ifndef OPENSSL_NO_NEXTPROTONEG
555 if (extra->server.npn_protocols != NULL) {
556 if (!TEST_true(parse_protos(extra->server.npn_protocols,
557 &server_ctx_data->npn_protocols,
558 &server_ctx_data->npn_protocols_len)))
559 goto err;
560 SSL_CTX_set_npn_advertised_cb(server_ctx, server_npn_cb,
561 server_ctx_data);
562 }
563 if (extra->server2.npn_protocols != NULL) {
564 if (!TEST_true(parse_protos(extra->server2.npn_protocols,
565 &server2_ctx_data->npn_protocols,
566 &server2_ctx_data->npn_protocols_len))
567 || !TEST_ptr(server2_ctx))
568 goto err;
569 SSL_CTX_set_npn_advertised_cb(server2_ctx, server_npn_cb,
570 server2_ctx_data);
571 }
572 if (extra->client.npn_protocols != NULL) {
573 if (!TEST_true(parse_protos(extra->client.npn_protocols,
574 &client_ctx_data->npn_protocols,
575 &client_ctx_data->npn_protocols_len)))
576 goto err;
577 SSL_CTX_set_next_proto_select_cb(client_ctx, client_npn_cb,
578 client_ctx_data);
579 }
580 #endif
581 if (extra->server.alpn_protocols != NULL) {
582 if (!TEST_true(parse_protos(extra->server.alpn_protocols,
583 &server_ctx_data->alpn_protocols,
584 &server_ctx_data->alpn_protocols_len)))
585 goto err;
586 SSL_CTX_set_alpn_select_cb(server_ctx, server_alpn_cb, server_ctx_data);
587 }
588 if (extra->server2.alpn_protocols != NULL) {
589 if (!TEST_ptr(server2_ctx)
590 || !TEST_true(parse_protos(extra->server2.alpn_protocols,
591 &server2_ctx_data->alpn_protocols,
592 &server2_ctx_data->alpn_protocols_len
593 )))
594 goto err;
595 SSL_CTX_set_alpn_select_cb(server2_ctx, server_alpn_cb,
596 server2_ctx_data);
597 }
598 if (extra->client.alpn_protocols != NULL) {
599 unsigned char *alpn_protos = NULL;
600 size_t alpn_protos_len;
601 if (!TEST_true(parse_protos(extra->client.alpn_protocols,
602 &alpn_protos, &alpn_protos_len))
603 /* Reversed return value convention... */
604 || !TEST_int_eq(SSL_CTX_set_alpn_protos(client_ctx, alpn_protos,
605 alpn_protos_len), 0))
606 goto err;
607 OPENSSL_free(alpn_protos);
608 }
609
610 /*
611 * Use fixed session ticket keys so that we can decrypt a ticket created with
612 * one CTX in another CTX. Don't address server2 for the moment.
613 */
614 ticket_key_len = SSL_CTX_set_tlsext_ticket_keys(server_ctx, NULL, 0);
615 if (!TEST_ptr(ticket_keys = OPENSSL_zalloc(ticket_key_len))
616 || !TEST_int_eq(SSL_CTX_set_tlsext_ticket_keys(server_ctx,
617 ticket_keys,
618 ticket_key_len), 1)) {
619 OPENSSL_free(ticket_keys);
620 goto err;
621 }
622 OPENSSL_free(ticket_keys);
623
624 /* The default log list includes EC keys, so CT can't work without EC. */
625 #if !defined(OPENSSL_NO_CT) && !defined(OPENSSL_NO_EC)
626 if (!TEST_true(SSL_CTX_set_default_ctlog_list_file(client_ctx)))
627 goto err;
628 switch (extra->client.ct_validation) {
629 case SSL_TEST_CT_VALIDATION_PERMISSIVE:
630 if (!TEST_true(SSL_CTX_enable_ct(client_ctx,
631 SSL_CT_VALIDATION_PERMISSIVE)))
632 goto err;
633 break;
634 case SSL_TEST_CT_VALIDATION_STRICT:
635 if (!TEST_true(SSL_CTX_enable_ct(client_ctx, SSL_CT_VALIDATION_STRICT)))
636 goto err;
637 break;
638 case SSL_TEST_CT_VALIDATION_NONE:
639 break;
640 }
641 #endif
642 #ifndef OPENSSL_NO_SRP
643 if (extra->server.srp_user != NULL) {
644 SSL_CTX_set_srp_username_callback(server_ctx, server_srp_cb);
645 server_ctx_data->srp_user = OPENSSL_strdup(extra->server.srp_user);
646 server_ctx_data->srp_password = OPENSSL_strdup(extra->server.srp_password);
647 SSL_CTX_set_srp_cb_arg(server_ctx, server_ctx_data);
648 }
649 if (extra->server2.srp_user != NULL) {
650 if (!TEST_ptr(server2_ctx))
651 goto err;
652 SSL_CTX_set_srp_username_callback(server2_ctx, server_srp_cb);
653 server2_ctx_data->srp_user = OPENSSL_strdup(extra->server2.srp_user);
654 server2_ctx_data->srp_password = OPENSSL_strdup(extra->server2.srp_password);
655 SSL_CTX_set_srp_cb_arg(server2_ctx, server2_ctx_data);
656 }
657 if (extra->client.srp_user != NULL) {
658 if (!TEST_true(SSL_CTX_set_srp_username(client_ctx,
659 extra->client.srp_user)))
660 goto err;
661 SSL_CTX_set_srp_client_pwd_callback(client_ctx, client_srp_cb);
662 client_ctx_data->srp_password = OPENSSL_strdup(extra->client.srp_password);
663 SSL_CTX_set_srp_cb_arg(client_ctx, client_ctx_data);
664 }
665 #endif /* !OPENSSL_NO_SRP */
666 return 1;
667 err:
668 return 0;
669 }
670
671 /* Configure per-SSL callbacks and other properties. */
672 static void configure_handshake_ssl(SSL *server, SSL *client,
673 const SSL_TEST_EXTRA_CONF *extra)
674 {
675 if (extra->client.servername != SSL_TEST_SERVERNAME_NONE)
676 SSL_set_tlsext_host_name(client,
677 ssl_servername_name(extra->client.servername));
678 if (extra->client.force_pha)
679 SSL_force_post_handshake_auth(client);
680 }
681
682 /* The status for each connection phase. */
683 typedef enum {
684 PEER_SUCCESS,
685 PEER_RETRY,
686 PEER_ERROR,
687 PEER_WAITING,
688 PEER_TEST_FAILURE
689 } peer_status_t;
690
691 /* An SSL object and associated read-write buffers. */
692 typedef struct peer_st {
693 SSL *ssl;
694 /* Buffer lengths are int to match the SSL read/write API. */
695 unsigned char *write_buf;
696 int write_buf_len;
697 unsigned char *read_buf;
698 int read_buf_len;
699 int bytes_to_write;
700 int bytes_to_read;
701 peer_status_t status;
702 } PEER;
703
704 static int create_peer(PEER *peer, SSL_CTX *ctx)
705 {
706 static const int peer_buffer_size = 64 * 1024;
707 SSL *ssl = NULL;
708 unsigned char *read_buf = NULL, *write_buf = NULL;
709
710 if (!TEST_ptr(ssl = SSL_new(ctx))
711 || !TEST_ptr(write_buf = OPENSSL_zalloc(peer_buffer_size))
712 || !TEST_ptr(read_buf = OPENSSL_zalloc(peer_buffer_size)))
713 goto err;
714
715 peer->ssl = ssl;
716 peer->write_buf = write_buf;
717 peer->read_buf = read_buf;
718 peer->write_buf_len = peer->read_buf_len = peer_buffer_size;
719 return 1;
720 err:
721 SSL_free(ssl);
722 OPENSSL_free(write_buf);
723 OPENSSL_free(read_buf);
724 return 0;
725 }
726
727 static void peer_free_data(PEER *peer)
728 {
729 SSL_free(peer->ssl);
730 OPENSSL_free(peer->write_buf);
731 OPENSSL_free(peer->read_buf);
732 }
733
734 /*
735 * Note that we could do the handshake transparently under an SSL_write,
736 * but separating the steps is more helpful for debugging test failures.
737 */
738 static void do_handshake_step(PEER *peer)
739 {
740 if (!TEST_int_eq(peer->status, PEER_RETRY)) {
741 peer->status = PEER_TEST_FAILURE;
742 } else {
743 int ret = SSL_do_handshake(peer->ssl);
744
745 if (ret == 1) {
746 peer->status = PEER_SUCCESS;
747 } else if (ret == 0) {
748 peer->status = PEER_ERROR;
749 } else {
750 int error = SSL_get_error(peer->ssl, ret);
751 /* Memory bios should never block with SSL_ERROR_WANT_WRITE. */
752 if (error != SSL_ERROR_WANT_READ)
753 peer->status = PEER_ERROR;
754 }
755 }
756 }
757
758 /*-
759 * Send/receive some application data. The read-write sequence is
760 * Peer A: (R) W - first read will yield no data
761 * Peer B: R W
762 * ...
763 * Peer A: R W
764 * Peer B: R W
765 * Peer A: R
766 */
767 static void do_app_data_step(PEER *peer)
768 {
769 int ret = 1, write_bytes;
770
771 if (!TEST_int_eq(peer->status, PEER_RETRY)) {
772 peer->status = PEER_TEST_FAILURE;
773 return;
774 }
775
776 /* We read everything available... */
777 while (ret > 0 && peer->bytes_to_read) {
778 ret = SSL_read(peer->ssl, peer->read_buf, peer->read_buf_len);
779 if (ret > 0) {
780 if (!TEST_int_le(ret, peer->bytes_to_read)) {
781 peer->status = PEER_TEST_FAILURE;
782 return;
783 }
784 peer->bytes_to_read -= ret;
785 } else if (ret == 0) {
786 peer->status = PEER_ERROR;
787 return;
788 } else {
789 int error = SSL_get_error(peer->ssl, ret);
790 if (error != SSL_ERROR_WANT_READ) {
791 peer->status = PEER_ERROR;
792 return;
793 } /* Else continue with write. */
794 }
795 }
796
797 /* ... but we only write one write-buffer-full of data. */
798 write_bytes = peer->bytes_to_write < peer->write_buf_len ? peer->bytes_to_write :
799 peer->write_buf_len;
800 if (write_bytes) {
801 ret = SSL_write(peer->ssl, peer->write_buf, write_bytes);
802 if (ret > 0) {
803 /* SSL_write will only succeed with a complete write. */
804 if (!TEST_int_eq(ret, write_bytes)) {
805 peer->status = PEER_TEST_FAILURE;
806 return;
807 }
808 peer->bytes_to_write -= ret;
809 } else {
810 /*
811 * We should perhaps check for SSL_ERROR_WANT_READ/WRITE here
812 * but this doesn't yet occur with current app data sizes.
813 */
814 peer->status = PEER_ERROR;
815 return;
816 }
817 }
818
819 /*
820 * We could simply finish when there was nothing to read, and we have
821 * nothing left to write. But keeping track of the expected number of bytes
822 * to read gives us somewhat better guarantees that all data sent is in fact
823 * received.
824 */
825 if (!peer->bytes_to_write && !peer->bytes_to_read) {
826 peer->status = PEER_SUCCESS;
827 }
828 }
829
830 static void do_reneg_setup_step(const SSL_TEST_CTX *test_ctx, PEER *peer)
831 {
832 int ret;
833 char buf;
834
835 if (peer->status == PEER_SUCCESS) {
836 /*
837 * We are a client that succeeded this step previously, but the server
838 * wanted to retry. Probably there is a no_renegotiation warning alert
839 * waiting for us. Attempt to continue the handshake.
840 */
841 peer->status = PEER_RETRY;
842 do_handshake_step(peer);
843 return;
844 }
845
846 if (!TEST_int_eq(peer->status, PEER_RETRY)
847 || !TEST_true(test_ctx->handshake_mode
848 == SSL_TEST_HANDSHAKE_RENEG_SERVER
849 || test_ctx->handshake_mode
850 == SSL_TEST_HANDSHAKE_RENEG_CLIENT
851 || test_ctx->handshake_mode
852 == SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER
853 || test_ctx->handshake_mode
854 == SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT
855 || test_ctx->handshake_mode
856 == SSL_TEST_HANDSHAKE_POST_HANDSHAKE_AUTH)) {
857 peer->status = PEER_TEST_FAILURE;
858 return;
859 }
860
861 /* Reset the count of the amount of app data we need to read/write */
862 peer->bytes_to_write = peer->bytes_to_read = test_ctx->app_data_size;
863
864 /* Check if we are the peer that is going to initiate */
865 if ((test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_SERVER
866 && SSL_is_server(peer->ssl))
867 || (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_CLIENT
868 && !SSL_is_server(peer->ssl))) {
869 /*
870 * If we already asked for a renegotiation then fall through to the
871 * SSL_read() below.
872 */
873 if (!SSL_renegotiate_pending(peer->ssl)) {
874 /*
875 * If we are the client we will always attempt to resume the
876 * session. The server may or may not resume dependent on the
877 * setting of SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
878 */
879 if (SSL_is_server(peer->ssl)) {
880 ret = SSL_renegotiate(peer->ssl);
881 } else {
882 if (test_ctx->extra.client.reneg_ciphers != NULL) {
883 if (!SSL_set_cipher_list(peer->ssl,
884 test_ctx->extra.client.reneg_ciphers)) {
885 peer->status = PEER_ERROR;
886 return;
887 }
888 ret = SSL_renegotiate(peer->ssl);
889 } else {
890 ret = SSL_renegotiate_abbreviated(peer->ssl);
891 }
892 }
893 if (!ret) {
894 peer->status = PEER_ERROR;
895 return;
896 }
897 do_handshake_step(peer);
898 /*
899 * If status is PEER_RETRY it means we're waiting on the peer to
900 * continue the handshake. As far as setting up the renegotiation is
901 * concerned that is a success. The next step will continue the
902 * handshake to its conclusion.
903 *
904 * If status is PEER_SUCCESS then we are the server and we have
905 * successfully sent the HelloRequest. We need to continue to wait
906 * until the handshake arrives from the client.
907 */
908 if (peer->status == PEER_RETRY)
909 peer->status = PEER_SUCCESS;
910 else if (peer->status == PEER_SUCCESS)
911 peer->status = PEER_RETRY;
912 return;
913 }
914 } else if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER
915 || test_ctx->handshake_mode
916 == SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT) {
917 if (SSL_is_server(peer->ssl)
918 != (test_ctx->handshake_mode
919 == SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER)) {
920 peer->status = PEER_SUCCESS;
921 return;
922 }
923
924 ret = SSL_key_update(peer->ssl, test_ctx->key_update_type);
925 if (!ret) {
926 peer->status = PEER_ERROR;
927 return;
928 }
929 do_handshake_step(peer);
930 /*
931 * This is a one step handshake. We shouldn't get anything other than
932 * PEER_SUCCESS
933 */
934 if (peer->status != PEER_SUCCESS)
935 peer->status = PEER_ERROR;
936 return;
937 } else if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_POST_HANDSHAKE_AUTH) {
938 if (SSL_is_server(peer->ssl)) {
939 /* Make the server believe it's received the extension */
940 if (test_ctx->extra.server.force_pha)
941 peer->ssl->post_handshake_auth = SSL_PHA_EXT_RECEIVED;
942 ret = SSL_verify_client_post_handshake(peer->ssl);
943 if (!ret) {
944 peer->status = PEER_ERROR;
945 return;
946 }
947 }
948 do_handshake_step(peer);
949 /*
950 * This is a one step handshake. We shouldn't get anything other than
951 * PEER_SUCCESS
952 */
953 if (peer->status != PEER_SUCCESS)
954 peer->status = PEER_ERROR;
955 return;
956 }
957
958 /*
959 * The SSL object is still expecting app data, even though it's going to
960 * get a handshake message. We try to read, and it should fail - after which
961 * we should be in a handshake
962 */
963 ret = SSL_read(peer->ssl, &buf, sizeof(buf));
964 if (ret >= 0) {
965 /*
966 * We're not actually expecting data - we're expecting a reneg to
967 * start
968 */
969 peer->status = PEER_ERROR;
970 return;
971 } else {
972 int error = SSL_get_error(peer->ssl, ret);
973 if (error != SSL_ERROR_WANT_READ) {
974 peer->status = PEER_ERROR;
975 return;
976 }
977 /* If we're not in init yet then we're not done with setup yet */
978 if (!SSL_in_init(peer->ssl))
979 return;
980 }
981
982 peer->status = PEER_SUCCESS;
983 }
984
985
986 /*
987 * RFC 5246 says:
988 *
989 * Note that as of TLS 1.1,
990 * failure to properly close a connection no longer requires that a
991 * session not be resumed. This is a change from TLS 1.0 to conform
992 * with widespread implementation practice.
993 *
994 * However,
995 * (a) OpenSSL requires that a connection be shutdown for all protocol versions.
996 * (b) We test lower versions, too.
997 * So we just implement shutdown. We do a full bidirectional shutdown so that we
998 * can compare sent and received close_notify alerts and get some test coverage
999 * for SSL_shutdown as a bonus.
1000 */
1001 static void do_shutdown_step(PEER *peer)
1002 {
1003 int ret;
1004
1005 if (!TEST_int_eq(peer->status, PEER_RETRY)) {
1006 peer->status = PEER_TEST_FAILURE;
1007 return;
1008 }
1009 ret = SSL_shutdown(peer->ssl);
1010
1011 if (ret == 1) {
1012 peer->status = PEER_SUCCESS;
1013 } else if (ret < 0) { /* On 0, we retry. */
1014 int error = SSL_get_error(peer->ssl, ret);
1015
1016 if (error != SSL_ERROR_WANT_READ && error != SSL_ERROR_WANT_WRITE)
1017 peer->status = PEER_ERROR;
1018 }
1019 }
1020
1021 typedef enum {
1022 HANDSHAKE,
1023 RENEG_APPLICATION_DATA,
1024 RENEG_SETUP,
1025 RENEG_HANDSHAKE,
1026 APPLICATION_DATA,
1027 SHUTDOWN,
1028 CONNECTION_DONE
1029 } connect_phase_t;
1030
1031
1032 static int renegotiate_op(const SSL_TEST_CTX *test_ctx)
1033 {
1034 switch (test_ctx->handshake_mode) {
1035 case SSL_TEST_HANDSHAKE_RENEG_SERVER:
1036 case SSL_TEST_HANDSHAKE_RENEG_CLIENT:
1037 return 1;
1038 default:
1039 return 0;
1040 }
1041 }
1042 static int post_handshake_op(const SSL_TEST_CTX *test_ctx)
1043 {
1044 switch (test_ctx->handshake_mode) {
1045 case SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT:
1046 case SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER:
1047 case SSL_TEST_HANDSHAKE_POST_HANDSHAKE_AUTH:
1048 return 1;
1049 default:
1050 return 0;
1051 }
1052 }
1053
1054 static connect_phase_t next_phase(const SSL_TEST_CTX *test_ctx,
1055 connect_phase_t phase)
1056 {
1057 switch (phase) {
1058 case HANDSHAKE:
1059 if (renegotiate_op(test_ctx) || post_handshake_op(test_ctx))
1060 return RENEG_APPLICATION_DATA;
1061 return APPLICATION_DATA;
1062 case RENEG_APPLICATION_DATA:
1063 return RENEG_SETUP;
1064 case RENEG_SETUP:
1065 if (post_handshake_op(test_ctx))
1066 return APPLICATION_DATA;
1067 return RENEG_HANDSHAKE;
1068 case RENEG_HANDSHAKE:
1069 return APPLICATION_DATA;
1070 case APPLICATION_DATA:
1071 return SHUTDOWN;
1072 case SHUTDOWN:
1073 return CONNECTION_DONE;
1074 case CONNECTION_DONE:
1075 TEST_error("Trying to progress after connection done");
1076 break;
1077 }
1078 return -1;
1079 }
1080
1081 static void do_connect_step(const SSL_TEST_CTX *test_ctx, PEER *peer,
1082 connect_phase_t phase)
1083 {
1084 switch (phase) {
1085 case HANDSHAKE:
1086 do_handshake_step(peer);
1087 break;
1088 case RENEG_APPLICATION_DATA:
1089 do_app_data_step(peer);
1090 break;
1091 case RENEG_SETUP:
1092 do_reneg_setup_step(test_ctx, peer);
1093 break;
1094 case RENEG_HANDSHAKE:
1095 do_handshake_step(peer);
1096 break;
1097 case APPLICATION_DATA:
1098 do_app_data_step(peer);
1099 break;
1100 case SHUTDOWN:
1101 do_shutdown_step(peer);
1102 break;
1103 case CONNECTION_DONE:
1104 TEST_error("Action after connection done");
1105 break;
1106 }
1107 }
1108
1109 typedef enum {
1110 /* Both parties succeeded. */
1111 HANDSHAKE_SUCCESS,
1112 /* Client errored. */
1113 CLIENT_ERROR,
1114 /* Server errored. */
1115 SERVER_ERROR,
1116 /* Peers are in inconsistent state. */
1117 INTERNAL_ERROR,
1118 /* One or both peers not done. */
1119 HANDSHAKE_RETRY
1120 } handshake_status_t;
1121
1122 /*
1123 * Determine the handshake outcome.
1124 * last_status: the status of the peer to have acted last.
1125 * previous_status: the status of the peer that didn't act last.
1126 * client_spoke_last: 1 if the client went last.
1127 */
1128 static handshake_status_t handshake_status(peer_status_t last_status,
1129 peer_status_t previous_status,
1130 int client_spoke_last)
1131 {
1132 switch (last_status) {
1133 case PEER_TEST_FAILURE:
1134 return INTERNAL_ERROR;
1135
1136 case PEER_WAITING:
1137 /* Shouldn't ever happen */
1138 return INTERNAL_ERROR;
1139
1140 case PEER_SUCCESS:
1141 switch (previous_status) {
1142 case PEER_TEST_FAILURE:
1143 return INTERNAL_ERROR;
1144 case PEER_SUCCESS:
1145 /* Both succeeded. */
1146 return HANDSHAKE_SUCCESS;
1147 case PEER_WAITING:
1148 case PEER_RETRY:
1149 /* Let the first peer finish. */
1150 return HANDSHAKE_RETRY;
1151 case PEER_ERROR:
1152 /*
1153 * Second peer succeeded despite the fact that the first peer
1154 * already errored. This shouldn't happen.
1155 */
1156 return INTERNAL_ERROR;
1157 }
1158 break;
1159
1160 case PEER_RETRY:
1161 return HANDSHAKE_RETRY;
1162
1163 case PEER_ERROR:
1164 switch (previous_status) {
1165 case PEER_TEST_FAILURE:
1166 return INTERNAL_ERROR;
1167 case PEER_WAITING:
1168 /* The client failed immediately before sending the ClientHello */
1169 return client_spoke_last ? CLIENT_ERROR : INTERNAL_ERROR;
1170 case PEER_SUCCESS:
1171 /*
1172 * First peer succeeded but second peer errored.
1173 * TODO(emilia): we should be able to continue here (with some
1174 * application data?) to ensure the first peer receives the
1175 * alert / close_notify.
1176 * (No tests currently exercise this branch.)
1177 */
1178 return client_spoke_last ? CLIENT_ERROR : SERVER_ERROR;
1179 case PEER_RETRY:
1180 /* We errored; let the peer finish. */
1181 return HANDSHAKE_RETRY;
1182 case PEER_ERROR:
1183 /* Both peers errored. Return the one that errored first. */
1184 return client_spoke_last ? SERVER_ERROR : CLIENT_ERROR;
1185 }
1186 }
1187 /* Control should never reach here. */
1188 return INTERNAL_ERROR;
1189 }
1190
1191 /* Convert unsigned char buf's that shouldn't contain any NUL-bytes to char. */
1192 static char *dup_str(const unsigned char *in, size_t len)
1193 {
1194 char *ret = NULL;
1195
1196 if (len == 0)
1197 return NULL;
1198
1199 /* Assert that the string does not contain NUL-bytes. */
1200 if (TEST_size_t_eq(OPENSSL_strnlen((const char*)(in), len), len))
1201 TEST_ptr(ret = OPENSSL_strndup((const char*)(in), len));
1202 return ret;
1203 }
1204
1205 static int pkey_type(EVP_PKEY *pkey)
1206 {
1207 int nid = EVP_PKEY_id(pkey);
1208
1209 #ifndef OPENSSL_NO_EC
1210 if (nid == EVP_PKEY_EC) {
1211 const EC_KEY *ec = EVP_PKEY_get0_EC_KEY(pkey);
1212 return EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1213 }
1214 #endif
1215 return nid;
1216 }
1217
1218 static int peer_pkey_type(SSL *s)
1219 {
1220 X509 *x = SSL_get_peer_certificate(s);
1221
1222 if (x != NULL) {
1223 int nid = pkey_type(X509_get0_pubkey(x));
1224
1225 X509_free(x);
1226 return nid;
1227 }
1228 return NID_undef;
1229 }
1230
1231 #if !defined(OPENSSL_NO_SCTP) && !defined(OPENSSL_NO_SOCK)
1232 static int set_sock_as_sctp(int sock)
1233 {
1234 /*
1235 * For SCTP we have to set various options on the socket prior to
1236 * connecting. This is done automatically by BIO_new_dgram_sctp().
1237 * We don't actually need the created BIO though so we free it again
1238 * immediately.
1239 */
1240 BIO *tmpbio = BIO_new_dgram_sctp(sock, BIO_NOCLOSE);
1241
1242 if (tmpbio == NULL)
1243 return 0;
1244 BIO_free(tmpbio);
1245
1246 return 1;
1247 }
1248
1249 static int create_sctp_socks(int *ssock, int *csock)
1250 {
1251 BIO_ADDRINFO *res = NULL;
1252 const BIO_ADDRINFO *ai = NULL;
1253 int lsock = INVALID_SOCKET, asock = INVALID_SOCKET;
1254 int consock = INVALID_SOCKET;
1255 int ret = 0;
1256 int family = 0;
1257
1258 if (BIO_sock_init() != 1)
1259 return 0;
1260
1261 /*
1262 * Port is 4463. It could be anything. It will fail if it's already being
1263 * used for some other SCTP service. It seems unlikely though so we don't
1264 * worry about it here.
1265 */
1266 if (!BIO_lookup_ex(NULL, "4463", BIO_LOOKUP_SERVER, family, SOCK_STREAM,
1267 IPPROTO_SCTP, &res))
1268 return 0;
1269
1270 for (ai = res; ai != NULL; ai = BIO_ADDRINFO_next(ai)) {
1271 family = BIO_ADDRINFO_family(ai);
1272 lsock = BIO_socket(family, SOCK_STREAM, IPPROTO_SCTP, 0);
1273 if (lsock == INVALID_SOCKET) {
1274 /* Maybe the kernel doesn't support the socket family, even if
1275 * BIO_lookup() added it in the returned result...
1276 */
1277 continue;
1278 }
1279
1280 if (!set_sock_as_sctp(lsock)
1281 || !BIO_listen(lsock, BIO_ADDRINFO_address(ai),
1282 BIO_SOCK_REUSEADDR)) {
1283 BIO_closesocket(lsock);
1284 lsock = INVALID_SOCKET;
1285 continue;
1286 }
1287
1288 /* Success, don't try any more addresses */
1289 break;
1290 }
1291
1292 if (lsock == INVALID_SOCKET)
1293 goto err;
1294
1295 BIO_ADDRINFO_free(res);
1296 res = NULL;
1297
1298 if (!BIO_lookup_ex(NULL, "4463", BIO_LOOKUP_CLIENT, family, SOCK_STREAM,
1299 IPPROTO_SCTP, &res))
1300 goto err;
1301
1302 consock = BIO_socket(family, SOCK_STREAM, IPPROTO_SCTP, 0);
1303 if (consock == INVALID_SOCKET)
1304 goto err;
1305
1306 if (!set_sock_as_sctp(consock)
1307 || !BIO_connect(consock, BIO_ADDRINFO_address(res), 0)
1308 || !BIO_socket_nbio(consock, 1))
1309 goto err;
1310
1311 asock = BIO_accept_ex(lsock, NULL, BIO_SOCK_NONBLOCK);
1312 if (asock == INVALID_SOCKET)
1313 goto err;
1314
1315 *csock = consock;
1316 *ssock = asock;
1317 consock = asock = INVALID_SOCKET;
1318 ret = 1;
1319
1320 err:
1321 BIO_ADDRINFO_free(res);
1322 if (consock != INVALID_SOCKET)
1323 BIO_closesocket(consock);
1324 if (lsock != INVALID_SOCKET)
1325 BIO_closesocket(lsock);
1326 if (asock != INVALID_SOCKET)
1327 BIO_closesocket(asock);
1328 return ret;
1329 }
1330 #endif
1331
1332 /*
1333 * Note that |extra| points to the correct client/server configuration
1334 * within |test_ctx|. When configuring the handshake, general mode settings
1335 * are taken from |test_ctx|, and client/server-specific settings should be
1336 * taken from |extra|.
1337 *
1338 * The configuration code should never reach into |test_ctx->extra| or
1339 * |test_ctx->resume_extra| directly.
1340 *
1341 * (We could refactor test mode settings into a substructure. This would result
1342 * in cleaner argument passing but would complicate the test configuration
1343 * parsing.)
1344 */
1345 static HANDSHAKE_RESULT *do_handshake_internal(
1346 SSL_CTX *server_ctx, SSL_CTX *server2_ctx, SSL_CTX *client_ctx,
1347 const SSL_TEST_CTX *test_ctx, const SSL_TEST_EXTRA_CONF *extra,
1348 SSL_SESSION *session_in, SSL_SESSION **session_out)
1349 {
1350 PEER server, client;
1351 BIO *client_to_server = NULL, *server_to_client = NULL;
1352 HANDSHAKE_EX_DATA server_ex_data, client_ex_data;
1353 CTX_DATA client_ctx_data, server_ctx_data, server2_ctx_data;
1354 HANDSHAKE_RESULT *ret = HANDSHAKE_RESULT_new();
1355 int client_turn = 1, client_turn_count = 0;
1356 connect_phase_t phase = HANDSHAKE;
1357 handshake_status_t status = HANDSHAKE_RETRY;
1358 const unsigned char* tick = NULL;
1359 size_t tick_len = 0;
1360 const unsigned char* sess_id = NULL;
1361 unsigned int sess_id_len = 0;
1362 SSL_SESSION* sess = NULL;
1363 const unsigned char *proto = NULL;
1364 /* API dictates unsigned int rather than size_t. */
1365 unsigned int proto_len = 0;
1366 EVP_PKEY *tmp_key;
1367 const STACK_OF(X509_NAME) *names;
1368 time_t start;
1369 const char* cipher;
1370
1371 if (ret == NULL)
1372 return NULL;
1373
1374 memset(&server_ctx_data, 0, sizeof(server_ctx_data));
1375 memset(&server2_ctx_data, 0, sizeof(server2_ctx_data));
1376 memset(&client_ctx_data, 0, sizeof(client_ctx_data));
1377 memset(&server, 0, sizeof(server));
1378 memset(&client, 0, sizeof(client));
1379 memset(&server_ex_data, 0, sizeof(server_ex_data));
1380 memset(&client_ex_data, 0, sizeof(client_ex_data));
1381
1382 if (!configure_handshake_ctx(server_ctx, server2_ctx, client_ctx,
1383 test_ctx, extra, &server_ctx_data,
1384 &server2_ctx_data, &client_ctx_data)) {
1385 TEST_note("configure_handshake_ctx");
1386 return NULL;
1387 }
1388
1389 /* Setup SSL and buffers; additional configuration happens below. */
1390 if (!create_peer(&server, server_ctx)) {
1391 TEST_note("creating server context");
1392 goto err;
1393 }
1394 if (!create_peer(&client, client_ctx)) {
1395 TEST_note("creating client context");
1396 goto err;
1397 }
1398
1399 server.bytes_to_write = client.bytes_to_read = test_ctx->app_data_size;
1400 client.bytes_to_write = server.bytes_to_read = test_ctx->app_data_size;
1401
1402 configure_handshake_ssl(server.ssl, client.ssl, extra);
1403 if (session_in != NULL) {
1404 /* In case we're testing resumption without tickets. */
1405 if (!TEST_true(SSL_CTX_add_session(server_ctx, session_in))
1406 || !TEST_true(SSL_set_session(client.ssl, session_in)))
1407 goto err;
1408 }
1409
1410 ret->result = SSL_TEST_INTERNAL_ERROR;
1411
1412 if (test_ctx->use_sctp) {
1413 #if !defined(OPENSSL_NO_SCTP) && !defined(OPENSSL_NO_SOCK)
1414 int csock, ssock;
1415
1416 if (create_sctp_socks(&ssock, &csock)) {
1417 client_to_server = BIO_new_dgram_sctp(csock, BIO_CLOSE);
1418 server_to_client = BIO_new_dgram_sctp(ssock, BIO_CLOSE);
1419 }
1420 #endif
1421 } else {
1422 client_to_server = BIO_new(BIO_s_mem());
1423 server_to_client = BIO_new(BIO_s_mem());
1424 }
1425
1426 if (!TEST_ptr(client_to_server)
1427 || !TEST_ptr(server_to_client))
1428 goto err;
1429
1430 /* Non-blocking bio. */
1431 BIO_set_nbio(client_to_server, 1);
1432 BIO_set_nbio(server_to_client, 1);
1433
1434 SSL_set_connect_state(client.ssl);
1435 SSL_set_accept_state(server.ssl);
1436
1437 /* The bios are now owned by the SSL object. */
1438 if (test_ctx->use_sctp) {
1439 SSL_set_bio(client.ssl, client_to_server, client_to_server);
1440 SSL_set_bio(server.ssl, server_to_client, server_to_client);
1441 } else {
1442 SSL_set_bio(client.ssl, server_to_client, client_to_server);
1443 if (!TEST_int_gt(BIO_up_ref(server_to_client), 0)
1444 || !TEST_int_gt(BIO_up_ref(client_to_server), 0))
1445 goto err;
1446 SSL_set_bio(server.ssl, client_to_server, server_to_client);
1447 }
1448
1449 ex_data_idx = SSL_get_ex_new_index(0, "ex data", NULL, NULL, NULL);
1450 if (!TEST_int_ge(ex_data_idx, 0)
1451 || !TEST_int_eq(SSL_set_ex_data(server.ssl, ex_data_idx, &server_ex_data), 1)
1452 || !TEST_int_eq(SSL_set_ex_data(client.ssl, ex_data_idx, &client_ex_data), 1))
1453 goto err;
1454
1455 SSL_set_info_callback(server.ssl, &info_cb);
1456 SSL_set_info_callback(client.ssl, &info_cb);
1457
1458 client.status = PEER_RETRY;
1459 server.status = PEER_WAITING;
1460
1461 start = time(NULL);
1462
1463 /*
1464 * Half-duplex handshake loop.
1465 * Client and server speak to each other synchronously in the same process.
1466 * We use non-blocking BIOs, so whenever one peer blocks for read, it
1467 * returns PEER_RETRY to indicate that it's the other peer's turn to write.
1468 * The handshake succeeds once both peers have succeeded. If one peer
1469 * errors out, we also let the other peer retry (and presumably fail).
1470 */
1471 for(;;) {
1472 if (client_turn) {
1473 do_connect_step(test_ctx, &client, phase);
1474 status = handshake_status(client.status, server.status,
1475 1 /* client went last */);
1476 if (server.status == PEER_WAITING)
1477 server.status = PEER_RETRY;
1478 } else {
1479 do_connect_step(test_ctx, &server, phase);
1480 status = handshake_status(server.status, client.status,
1481 0 /* server went last */);
1482 }
1483
1484 switch (status) {
1485 case HANDSHAKE_SUCCESS:
1486 client_turn_count = 0;
1487 phase = next_phase(test_ctx, phase);
1488 if (phase == CONNECTION_DONE) {
1489 ret->result = SSL_TEST_SUCCESS;
1490 goto err;
1491 } else {
1492 client.status = server.status = PEER_RETRY;
1493 /*
1494 * For now, client starts each phase. Since each phase is
1495 * started separately, we can later control this more
1496 * precisely, for example, to test client-initiated and
1497 * server-initiated shutdown.
1498 */
1499 client_turn = 1;
1500 break;
1501 }
1502 case CLIENT_ERROR:
1503 ret->result = SSL_TEST_CLIENT_FAIL;
1504 goto err;
1505 case SERVER_ERROR:
1506 ret->result = SSL_TEST_SERVER_FAIL;
1507 goto err;
1508 case INTERNAL_ERROR:
1509 ret->result = SSL_TEST_INTERNAL_ERROR;
1510 goto err;
1511 case HANDSHAKE_RETRY:
1512 if (test_ctx->use_sctp) {
1513 if (time(NULL) - start > 3) {
1514 /*
1515 * We've waited for too long. Give up.
1516 */
1517 ret->result = SSL_TEST_INTERNAL_ERROR;
1518 goto err;
1519 }
1520 /*
1521 * With "real" sockets we only swap to processing the peer
1522 * if they are expecting to retry. Otherwise we just retry the
1523 * same endpoint again.
1524 */
1525 if ((client_turn && server.status == PEER_RETRY)
1526 || (!client_turn && client.status == PEER_RETRY))
1527 client_turn ^= 1;
1528 } else {
1529 if (client_turn_count++ >= 2000) {
1530 /*
1531 * At this point, there's been so many PEER_RETRY in a row
1532 * that it's likely both sides are stuck waiting for a read.
1533 * It's time to give up.
1534 */
1535 ret->result = SSL_TEST_INTERNAL_ERROR;
1536 goto err;
1537 }
1538
1539 /* Continue. */
1540 client_turn ^= 1;
1541 }
1542 break;
1543 }
1544 }
1545 err:
1546 ret->server_alert_sent = server_ex_data.alert_sent;
1547 ret->server_num_fatal_alerts_sent = server_ex_data.num_fatal_alerts_sent;
1548 ret->server_alert_received = client_ex_data.alert_received;
1549 ret->client_alert_sent = client_ex_data.alert_sent;
1550 ret->client_num_fatal_alerts_sent = client_ex_data.num_fatal_alerts_sent;
1551 ret->client_alert_received = server_ex_data.alert_received;
1552 ret->server_protocol = SSL_version(server.ssl);
1553 ret->client_protocol = SSL_version(client.ssl);
1554 ret->servername = server_ex_data.servername;
1555 if ((sess = SSL_get0_session(client.ssl)) != NULL) {
1556 SSL_SESSION_get0_ticket(sess, &tick, &tick_len);
1557 sess_id = SSL_SESSION_get_id(sess, &sess_id_len);
1558 }
1559 if (tick == NULL || tick_len == 0)
1560 ret->session_ticket = SSL_TEST_SESSION_TICKET_NO;
1561 else
1562 ret->session_ticket = SSL_TEST_SESSION_TICKET_YES;
1563 ret->compression = (SSL_get_current_compression(client.ssl) == NULL)
1564 ? SSL_TEST_COMPRESSION_NO
1565 : SSL_TEST_COMPRESSION_YES;
1566 if (sess_id == NULL || sess_id_len == 0)
1567 ret->session_id = SSL_TEST_SESSION_ID_NO;
1568 else
1569 ret->session_id = SSL_TEST_SESSION_ID_YES;
1570 ret->session_ticket_do_not_call = server_ex_data.session_ticket_do_not_call;
1571
1572 #ifndef OPENSSL_NO_NEXTPROTONEG
1573 SSL_get0_next_proto_negotiated(client.ssl, &proto, &proto_len);
1574 ret->client_npn_negotiated = dup_str(proto, proto_len);
1575
1576 SSL_get0_next_proto_negotiated(server.ssl, &proto, &proto_len);
1577 ret->server_npn_negotiated = dup_str(proto, proto_len);
1578 #endif
1579
1580 SSL_get0_alpn_selected(client.ssl, &proto, &proto_len);
1581 ret->client_alpn_negotiated = dup_str(proto, proto_len);
1582
1583 SSL_get0_alpn_selected(server.ssl, &proto, &proto_len);
1584 ret->server_alpn_negotiated = dup_str(proto, proto_len);
1585
1586 ret->client_resumed = SSL_session_reused(client.ssl);
1587 ret->server_resumed = SSL_session_reused(server.ssl);
1588
1589 cipher = SSL_CIPHER_get_name(SSL_get_current_cipher(client.ssl));
1590 ret->cipher = dup_str((const unsigned char*)cipher, strlen(cipher));
1591
1592 if (session_out != NULL)
1593 *session_out = SSL_get1_session(client.ssl);
1594
1595 if (SSL_get_server_tmp_key(client.ssl, &tmp_key)) {
1596 ret->tmp_key_type = pkey_type(tmp_key);
1597 EVP_PKEY_free(tmp_key);
1598 }
1599
1600 SSL_get_peer_signature_nid(client.ssl, &ret->server_sign_hash);
1601 SSL_get_peer_signature_nid(server.ssl, &ret->client_sign_hash);
1602
1603 SSL_get_peer_signature_type_nid(client.ssl, &ret->server_sign_type);
1604 SSL_get_peer_signature_type_nid(server.ssl, &ret->client_sign_type);
1605
1606 names = SSL_get0_peer_CA_list(client.ssl);
1607 if (names == NULL)
1608 ret->client_ca_names = NULL;
1609 else
1610 ret->client_ca_names = SSL_dup_CA_list(names);
1611
1612 names = SSL_get0_peer_CA_list(server.ssl);
1613 if (names == NULL)
1614 ret->server_ca_names = NULL;
1615 else
1616 ret->server_ca_names = SSL_dup_CA_list(names);
1617
1618 ret->server_cert_type = peer_pkey_type(client.ssl);
1619 ret->client_cert_type = peer_pkey_type(server.ssl);
1620
1621 ctx_data_free_data(&server_ctx_data);
1622 ctx_data_free_data(&server2_ctx_data);
1623 ctx_data_free_data(&client_ctx_data);
1624
1625 peer_free_data(&server);
1626 peer_free_data(&client);
1627 return ret;
1628 }
1629
1630 HANDSHAKE_RESULT *do_handshake(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
1631 SSL_CTX *client_ctx, SSL_CTX *resume_server_ctx,
1632 SSL_CTX *resume_client_ctx,
1633 const SSL_TEST_CTX *test_ctx)
1634 {
1635 HANDSHAKE_RESULT *result;
1636 SSL_SESSION *session = NULL;
1637
1638 result = do_handshake_internal(server_ctx, server2_ctx, client_ctx,
1639 test_ctx, &test_ctx->extra,
1640 NULL, &session);
1641 if (result == NULL
1642 || test_ctx->handshake_mode != SSL_TEST_HANDSHAKE_RESUME
1643 || result->result == SSL_TEST_INTERNAL_ERROR)
1644 goto end;
1645
1646 if (result->result != SSL_TEST_SUCCESS) {
1647 result->result = SSL_TEST_FIRST_HANDSHAKE_FAILED;
1648 goto end;
1649 }
1650
1651 HANDSHAKE_RESULT_free(result);
1652 /* We don't support SNI on second handshake yet, so server2_ctx is NULL. */
1653 result = do_handshake_internal(resume_server_ctx, NULL, resume_client_ctx,
1654 test_ctx, &test_ctx->resume_extra,
1655 session, NULL);
1656 end:
1657 SSL_SESSION_free(session);
1658 return result;
1659 }