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