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