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