ee87512f66d5222bc96410905cf8b904e4a5ebbe
[openssl.git] / test / handshake_helper.c
1 /*
2  * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #include <string.h>
11
12 #include <openssl/bio.h>
13 #include <openssl/x509_vfy.h>
14 #include <openssl/ssl.h>
15
16 #include "handshake_helper.h"
17 #include "testutil.h"
18
19 HANDSHAKE_RESULT *HANDSHAKE_RESULT_new()
20 {
21     HANDSHAKE_RESULT *ret = OPENSSL_zalloc(sizeof(*ret));
22     TEST_check(ret != NULL);
23     return ret;
24 }
25
26 void HANDSHAKE_RESULT_free(HANDSHAKE_RESULT *result)
27 {
28     if (result == NULL)
29         return;
30     OPENSSL_free(result->client_npn_negotiated);
31     OPENSSL_free(result->server_npn_negotiated);
32     OPENSSL_free(result->client_alpn_negotiated);
33     OPENSSL_free(result->server_alpn_negotiated);
34     OPENSSL_free(result);
35 }
36
37 /*
38  * Since there appears to be no way to extract the sent/received alert
39  * from the SSL object directly, we use the info callback and stash
40  * the result in ex_data.
41  */
42 typedef struct handshake_ex_data {
43     int alert_sent;
44     int alert_received;
45     int session_ticket_do_not_call;
46     ssl_servername_t servername;
47 } HANDSHAKE_EX_DATA;
48
49 typedef struct ctx_data {
50     unsigned char *npn_protocols;
51     size_t npn_protocols_len;
52     unsigned char *alpn_protocols;
53     size_t alpn_protocols_len;
54 } CTX_DATA;
55
56 /* |ctx_data| itself is stack-allocated. */
57 static void ctx_data_free_data(CTX_DATA *ctx_data)
58 {
59     OPENSSL_free(ctx_data->npn_protocols);
60     ctx_data->npn_protocols = NULL;
61     OPENSSL_free(ctx_data->alpn_protocols);
62     ctx_data->alpn_protocols = NULL;
63 }
64
65 static int ex_data_idx;
66
67 static void info_cb(const SSL *s, int where, int ret)
68 {
69     if (where & SSL_CB_ALERT) {
70         HANDSHAKE_EX_DATA *ex_data =
71             (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
72         if (where & SSL_CB_WRITE) {
73             ex_data->alert_sent = ret;
74         } else {
75             ex_data->alert_received = ret;
76         }
77     }
78 }
79
80 /* Select the appropriate server CTX.
81  * Returns SSL_TLSEXT_ERR_OK if a match was found.
82  * If |ignore| is 1, returns SSL_TLSEXT_ERR_NOACK on mismatch.
83  * Otherwise, returns SSL_TLSEXT_ERR_ALERT_FATAL on mismatch.
84  * An empty SNI extension also returns SSL_TSLEXT_ERR_NOACK.
85  */
86 static int select_server_ctx(SSL *s, void *arg, int ignore)
87 {
88     const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
89     HANDSHAKE_EX_DATA *ex_data =
90         (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
91
92     if (servername == NULL) {
93         ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
94         return SSL_TLSEXT_ERR_NOACK;
95     }
96
97     if (strcmp(servername, "server2") == 0) {
98         SSL_CTX *new_ctx = (SSL_CTX*)arg;
99         SSL_set_SSL_CTX(s, new_ctx);
100         /*
101          * Copy over all the SSL_CTX options - reasonable behavior
102          * allows testing of cases where the options between two
103          * contexts differ/conflict
104          */
105         SSL_clear_options(s, 0xFFFFFFFFL);
106         SSL_set_options(s, SSL_CTX_get_options(new_ctx));
107
108         ex_data->servername = SSL_TEST_SERVERNAME_SERVER2;
109         return SSL_TLSEXT_ERR_OK;
110     } else if (strcmp(servername, "server1") == 0) {
111         ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
112         return SSL_TLSEXT_ERR_OK;
113     } else if (ignore) {
114         ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
115         return SSL_TLSEXT_ERR_NOACK;
116     } else {
117         /* Don't set an explicit alert, to test library defaults. */
118         return SSL_TLSEXT_ERR_ALERT_FATAL;
119     }
120 }
121
122 /*
123  * (RFC 6066):
124  *  If the server understood the ClientHello extension but
125  *  does not recognize the server name, the server SHOULD take one of two
126  *  actions: either abort the handshake by sending a fatal-level
127  *  unrecognized_name(112) alert or continue the handshake.
128  *
129  * This behaviour is up to the application to configure; we test both
130  * configurations to ensure the state machine propagates the result
131  * correctly.
132  */
133 static int servername_ignore_cb(SSL *s, int *ad, void *arg)
134 {
135     return select_server_ctx(s, arg, 1);
136 }
137
138 static int servername_reject_cb(SSL *s, int *ad, void *arg)
139 {
140     return select_server_ctx(s, arg, 0);
141 }
142
143 static int verify_reject_cb(X509_STORE_CTX *ctx, void *arg) {
144     X509_STORE_CTX_set_error(ctx, X509_V_ERR_APPLICATION_VERIFICATION);
145     return 0;
146 }
147
148 static int verify_accept_cb(X509_STORE_CTX *ctx, void *arg) {
149     return 1;
150 }
151
152 static int broken_session_ticket_cb(SSL *s, unsigned char *key_name, unsigned char *iv,
153                                     EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc)
154 {
155     return 0;
156 }
157
158 static int do_not_call_session_ticket_cb(SSL *s, unsigned char *key_name,
159                                          unsigned char *iv,
160                                          EVP_CIPHER_CTX *ctx,
161                                          HMAC_CTX *hctx, int enc)
162 {
163     HANDSHAKE_EX_DATA *ex_data =
164         (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
165     ex_data->session_ticket_do_not_call = 1;
166     return 0;
167 }
168
169 /* Parse the comma-separated list into TLS format. */
170 static void parse_protos(const char *protos, unsigned char **out, size_t *outlen)
171 {
172     size_t len, i, prefix;
173
174     len = strlen(protos);
175
176     /* Should never have reuse. */
177     TEST_check(*out == NULL);
178
179     /* Test values are small, so we omit length limit checks. */
180     *out = OPENSSL_malloc(len + 1);
181     TEST_check(*out != NULL);
182     *outlen = len + 1;
183
184     /*
185      * foo => '3', 'f', 'o', 'o'
186      * foo,bar => '3', 'f', 'o', 'o', '3', 'b', 'a', 'r'
187      */
188     memcpy(*out + 1, protos, len);
189
190     prefix = 0;
191     i = prefix + 1;
192     while (i <= len) {
193         if ((*out)[i] == ',') {
194             TEST_check(i - 1 - prefix > 0);
195             (*out)[prefix] = i - 1 - prefix;
196             prefix = i;
197         }
198         i++;
199     }
200     TEST_check(len - prefix > 0);
201     (*out)[prefix] = len - prefix;
202 }
203
204 #ifndef OPENSSL_NO_NEXTPROTONEG
205 /*
206  * The client SHOULD select the first protocol advertised by the server that it
207  * also supports.  In the event that the client doesn't support any of server's
208  * protocols, or the server doesn't advertise any, it SHOULD select the first
209  * protocol that it supports.
210  */
211 static int client_npn_cb(SSL *s, unsigned char **out, unsigned char *outlen,
212                          const unsigned char *in, unsigned int inlen,
213                          void *arg)
214 {
215     CTX_DATA *ctx_data = (CTX_DATA*)(arg);
216     int ret;
217
218     ret = SSL_select_next_proto(out, outlen, in, inlen,
219                                 ctx_data->npn_protocols,
220                                 ctx_data->npn_protocols_len);
221     /* Accept both OPENSSL_NPN_NEGOTIATED and OPENSSL_NPN_NO_OVERLAP. */
222     TEST_check(ret == OPENSSL_NPN_NEGOTIATED || ret == OPENSSL_NPN_NO_OVERLAP);
223     return SSL_TLSEXT_ERR_OK;
224 }
225
226 static int server_npn_cb(SSL *s, const unsigned char **data,
227                          unsigned int *len, void *arg)
228 {
229     CTX_DATA *ctx_data = (CTX_DATA*)(arg);
230     *data = ctx_data->npn_protocols;
231     *len = ctx_data->npn_protocols_len;
232     return SSL_TLSEXT_ERR_OK;
233 }
234 #endif
235
236 /*
237  * The server SHOULD select the most highly preferred protocol that it supports
238  * and that is also advertised by the client.  In the event that the server
239  * supports no protocols that the client advertises, then the server SHALL
240  * respond with a fatal "no_application_protocol" alert.
241  */
242 static int server_alpn_cb(SSL *s, const unsigned char **out,
243                           unsigned char *outlen, const unsigned char *in,
244                           unsigned int inlen, void *arg)
245 {
246     CTX_DATA *ctx_data = (CTX_DATA*)(arg);
247     int ret;
248
249     /* SSL_select_next_proto isn't const-correct... */
250     unsigned char *tmp_out;
251
252     /*
253      * The result points either to |in| or to |ctx_data->alpn_protocols|.
254      * The callback is allowed to point to |in| or to a long-lived buffer,
255      * so we can return directly without storing a copy.
256      */
257     ret = SSL_select_next_proto(&tmp_out, outlen,
258                                 ctx_data->alpn_protocols,
259                                 ctx_data->alpn_protocols_len, in, inlen);
260
261     *out = tmp_out;
262     /* Unlike NPN, we don't tolerate a mismatch. */
263     return ret == OPENSSL_NPN_NEGOTIATED ? SSL_TLSEXT_ERR_OK
264         : SSL_TLSEXT_ERR_NOACK;
265 }
266
267 /*
268  * Configure callbacks and other properties that can't be set directly
269  * in the server/client CONF.
270  */
271 static void configure_handshake_ctx(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
272                                     SSL_CTX *client_ctx,
273                                     const SSL_TEST_EXTRA_CONF *extra,
274                                     CTX_DATA *server_ctx_data,
275                                     CTX_DATA *server2_ctx_data,
276                                     CTX_DATA *client_ctx_data)
277 {
278     unsigned char *ticket_keys;
279     size_t ticket_key_len;
280
281     switch (extra->client.verify_callback) {
282     case SSL_TEST_VERIFY_ACCEPT_ALL:
283         SSL_CTX_set_cert_verify_callback(client_ctx, &verify_accept_cb,
284                                          NULL);
285         break;
286     case SSL_TEST_VERIFY_REJECT_ALL:
287         SSL_CTX_set_cert_verify_callback(client_ctx, &verify_reject_cb,
288                                          NULL);
289         break;
290     default:
291         break;
292     }
293
294     /* link the two contexts for SNI purposes */
295     switch (extra->server.servername_callback) {
296     case SSL_TEST_SERVERNAME_IGNORE_MISMATCH:
297         SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_ignore_cb);
298         SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
299         break;
300     case SSL_TEST_SERVERNAME_REJECT_MISMATCH:
301         SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_reject_cb);
302         SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
303         break;
304     default:
305         break;
306     }
307
308     /*
309      * The initial_ctx/session_ctx always handles the encrypt/decrypt of the
310      * session ticket. This ticket_key callback is assigned to the second
311      * session (assigned via SNI), and should never be invoked
312      */
313     if (server2_ctx != NULL)
314         SSL_CTX_set_tlsext_ticket_key_cb(server2_ctx,
315                                          do_not_call_session_ticket_cb);
316
317     if (extra->server.broken_session_ticket) {
318         SSL_CTX_set_tlsext_ticket_key_cb(server_ctx, broken_session_ticket_cb);
319     }
320 #ifndef OPENSSL_NO_NEXTPROTONEG
321     if (extra->server.npn_protocols != NULL) {
322         parse_protos(extra->server.npn_protocols,
323                      &server_ctx_data->npn_protocols,
324                      &server_ctx_data->npn_protocols_len);
325         SSL_CTX_set_next_protos_advertised_cb(server_ctx, server_npn_cb,
326                                               server_ctx_data);
327     }
328     if (extra->server2.npn_protocols != NULL) {
329         parse_protos(extra->server2.npn_protocols,
330                      &server2_ctx_data->npn_protocols,
331                      &server2_ctx_data->npn_protocols_len);
332         TEST_check(server2_ctx != NULL);
333         SSL_CTX_set_next_protos_advertised_cb(server2_ctx, server_npn_cb,
334                                               server2_ctx_data);
335     }
336     if (extra->client.npn_protocols != NULL) {
337         parse_protos(extra->client.npn_protocols,
338                      &client_ctx_data->npn_protocols,
339                      &client_ctx_data->npn_protocols_len);
340         SSL_CTX_set_next_proto_select_cb(client_ctx, client_npn_cb,
341                                          client_ctx_data);
342     }
343 #endif
344     if (extra->server.alpn_protocols != NULL) {
345         parse_protos(extra->server.alpn_protocols,
346                      &server_ctx_data->alpn_protocols,
347                      &server_ctx_data->alpn_protocols_len);
348         SSL_CTX_set_alpn_select_cb(server_ctx, server_alpn_cb, server_ctx_data);
349     }
350     if (extra->server2.alpn_protocols != NULL) {
351         TEST_check(server2_ctx != NULL);
352         parse_protos(extra->server2.alpn_protocols,
353                      &server2_ctx_data->alpn_protocols,
354                      &server2_ctx_data->alpn_protocols_len);
355         SSL_CTX_set_alpn_select_cb(server2_ctx, server_alpn_cb, server2_ctx_data);
356     }
357     if (extra->client.alpn_protocols != NULL) {
358         unsigned char *alpn_protos = NULL;
359         size_t alpn_protos_len;
360         parse_protos(extra->client.alpn_protocols,
361                      &alpn_protos, &alpn_protos_len);
362         /* Reversed return value convention... */
363         TEST_check(SSL_CTX_set_alpn_protos(client_ctx, alpn_protos,
364                                            alpn_protos_len) == 0);
365         OPENSSL_free(alpn_protos);
366     }
367
368     /*
369      * Use fixed session ticket keys so that we can decrypt a ticket created with
370      * one CTX in another CTX. Don't address server2 for the moment.
371      */
372     ticket_key_len = SSL_CTX_set_tlsext_ticket_keys(server_ctx, NULL, 0);
373     ticket_keys = OPENSSL_zalloc(ticket_key_len);
374     TEST_check(ticket_keys != NULL);
375     TEST_check(SSL_CTX_set_tlsext_ticket_keys(server_ctx, ticket_keys,
376                                               ticket_key_len) == 1);
377     OPENSSL_free(ticket_keys);
378
379     /* The default log list includes EC keys, so CT can't work without EC. */
380 #if !defined(OPENSSL_NO_CT) && !defined(OPENSSL_NO_EC)
381     TEST_check(SSL_CTX_set_default_ctlog_list_file(client_ctx));
382     switch (extra->client.ct_validation) {
383     case SSL_TEST_CT_VALIDATION_PERMISSIVE:
384         TEST_check(SSL_CTX_enable_ct(client_ctx, SSL_CT_VALIDATION_PERMISSIVE));
385         break;
386     case SSL_TEST_CT_VALIDATION_STRICT:
387         TEST_check(SSL_CTX_enable_ct(client_ctx, SSL_CT_VALIDATION_STRICT));
388         break;
389     case SSL_TEST_CT_VALIDATION_NONE:
390         break;
391     }
392 #endif
393 }
394
395 /* Configure per-SSL callbacks and other properties. */
396 static void configure_handshake_ssl(SSL *server, SSL *client,
397                                     const SSL_TEST_EXTRA_CONF *extra)
398 {
399     if (extra->client.servername != SSL_TEST_SERVERNAME_NONE)
400         SSL_set_tlsext_host_name(client,
401                                  ssl_servername_name(extra->client.servername));
402 }
403
404
405 typedef enum {
406     PEER_SUCCESS,
407     PEER_RETRY,
408     PEER_ERROR
409 } peer_status_t;
410
411 /*
412  * RFC 5246 says:
413  *
414  * Note that as of TLS 1.1,
415  *     failure to properly close a connection no longer requires that a
416  *     session not be resumed.  This is a change from TLS 1.0 to conform
417  *     with widespread implementation practice.
418  *
419  * However,
420  * (a) OpenSSL requires that a connection be shutdown for all protocol versions.
421  * (b) We test lower versions, too.
422  * So we just implement shutdown. We do a full bidirectional shutdown so that we
423  * can compare sent and received close_notify alerts and get some test coverage
424  * for SSL_shutdown as a bonus.
425  */
426 static peer_status_t do_handshake_step(SSL *ssl, int shutdown)
427 {
428     int ret;
429
430     ret = shutdown ? SSL_shutdown(ssl) : SSL_do_handshake(ssl);
431
432     if (ret == 1) {
433         return PEER_SUCCESS;
434     } else if (ret == 0) {
435         return shutdown ? PEER_RETRY : PEER_ERROR;
436     } else {
437         int error = SSL_get_error(ssl, ret);
438         /* Memory bios should never block with SSL_ERROR_WANT_WRITE. */
439         if (error == SSL_ERROR_WANT_READ)
440             return PEER_RETRY;
441         else
442             return PEER_ERROR;
443     }
444 }
445
446 typedef enum {
447     /* Both parties succeeded. */
448     HANDSHAKE_SUCCESS,
449     /* Client errored. */
450     CLIENT_ERROR,
451     /* Server errored. */
452     SERVER_ERROR,
453     /* Peers are in inconsistent state. */
454     INTERNAL_ERROR,
455     /* One or both peers not done. */
456     HANDSHAKE_RETRY
457 } handshake_status_t;
458
459 /*
460  * Determine the handshake outcome.
461  * last_status: the status of the peer to have acted last.
462  * previous_status: the status of the peer that didn't act last.
463  * client_spoke_last: 1 if the client went last.
464  */
465 static handshake_status_t handshake_status(peer_status_t last_status,
466                                            peer_status_t previous_status,
467                                            int client_spoke_last)
468 {
469     switch (last_status) {
470     case PEER_SUCCESS:
471         switch (previous_status) {
472         case PEER_SUCCESS:
473             /* Both succeeded. */
474             return HANDSHAKE_SUCCESS;
475         case PEER_RETRY:
476             /* Let the first peer finish. */
477             return HANDSHAKE_RETRY;
478         case PEER_ERROR:
479             /*
480              * Second peer succeeded despite the fact that the first peer
481              * already errored. This shouldn't happen.
482              */
483             return INTERNAL_ERROR;
484         }
485
486     case PEER_RETRY:
487         if (previous_status == PEER_RETRY) {
488             /* Neither peer is done. */
489             return HANDSHAKE_RETRY;
490         } else {
491             /*
492              * Deadlock: second peer is waiting for more input while first
493              * peer thinks they're done (no more input is coming).
494              */
495             return INTERNAL_ERROR;
496         }
497     case PEER_ERROR:
498         switch (previous_status) {
499         case PEER_SUCCESS:
500             /*
501              * First peer succeeded but second peer errored.
502              * TODO(emilia): we should be able to continue here (with some
503              * application data?) to ensure the first peer receives the
504              * alert / close_notify.
505              */
506             return client_spoke_last ? CLIENT_ERROR : SERVER_ERROR;
507         case PEER_RETRY:
508             /* We errored; let the peer finish. */
509             return HANDSHAKE_RETRY;
510         case PEER_ERROR:
511             /* Both peers errored. Return the one that errored first. */
512             return client_spoke_last ? SERVER_ERROR : CLIENT_ERROR;
513         }
514     }
515     /* Control should never reach here. */
516     return INTERNAL_ERROR;
517 }
518
519 /* Convert unsigned char buf's that shouldn't contain any NUL-bytes to char. */
520 static char *dup_str(const unsigned char *in, size_t len)
521 {
522     char *ret;
523
524     if(len == 0)
525         return NULL;
526
527     /* Assert that the string does not contain NUL-bytes. */
528     TEST_check(OPENSSL_strnlen((const char*)(in), len) == len);
529     ret = OPENSSL_strndup((const char*)(in), len);
530     TEST_check(ret != NULL);
531     return ret;
532 }
533
534 static HANDSHAKE_RESULT *do_handshake_internal(
535     SSL_CTX *server_ctx, SSL_CTX *server2_ctx, SSL_CTX *client_ctx,
536     const SSL_TEST_EXTRA_CONF *extra, SSL_SESSION *session_in,
537     SSL_SESSION **session_out)
538 {
539     SSL *server, *client;
540     BIO *client_to_server, *server_to_client;
541     HANDSHAKE_EX_DATA server_ex_data, client_ex_data;
542     CTX_DATA client_ctx_data, server_ctx_data, server2_ctx_data;
543     HANDSHAKE_RESULT *ret = HANDSHAKE_RESULT_new();
544     int client_turn = 1, shutdown = 0;
545     peer_status_t client_status = PEER_RETRY, server_status = PEER_RETRY;
546     handshake_status_t status = HANDSHAKE_RETRY;
547     unsigned char* tick = NULL;
548     size_t tick_len = 0;
549     SSL_SESSION* sess = NULL;
550     const unsigned char *proto = NULL;
551     /* API dictates unsigned int rather than size_t. */
552     unsigned int proto_len = 0;
553
554     memset(&server_ctx_data, 0, sizeof(server_ctx_data));
555     memset(&server2_ctx_data, 0, sizeof(server2_ctx_data));
556     memset(&client_ctx_data, 0, sizeof(client_ctx_data));
557
558     configure_handshake_ctx(server_ctx, server2_ctx, client_ctx, extra,
559                             &server_ctx_data, &server2_ctx_data, &client_ctx_data);
560
561     server = SSL_new(server_ctx);
562     client = SSL_new(client_ctx);
563     TEST_check(server != NULL);
564     TEST_check(client != NULL);
565
566     configure_handshake_ssl(server, client, extra);
567     if (session_in != NULL) {
568         /* In case we're testing resumption without tickets. */
569         TEST_check(SSL_CTX_add_session(server_ctx, session_in));
570         TEST_check(SSL_set_session(client, session_in));
571     }
572
573     memset(&server_ex_data, 0, sizeof(server_ex_data));
574     memset(&client_ex_data, 0, sizeof(client_ex_data));
575
576     ret->result = SSL_TEST_INTERNAL_ERROR;
577
578     client_to_server = BIO_new(BIO_s_mem());
579     server_to_client = BIO_new(BIO_s_mem());
580
581     TEST_check(client_to_server != NULL && server_to_client != NULL);
582
583     /* Non-blocking bio. */
584     BIO_set_nbio(client_to_server, 1);
585     BIO_set_nbio(server_to_client, 1);
586
587     SSL_set_connect_state(client);
588     SSL_set_accept_state(server);
589
590     /* The bios are now owned by the SSL object. */
591     SSL_set_bio(client, server_to_client, client_to_server);
592     TEST_check(BIO_up_ref(server_to_client) > 0);
593     TEST_check(BIO_up_ref(client_to_server) > 0);
594     SSL_set_bio(server, client_to_server, server_to_client);
595
596     ex_data_idx = SSL_get_ex_new_index(0, "ex data", NULL, NULL, NULL);
597     TEST_check(ex_data_idx >= 0);
598
599     TEST_check(SSL_set_ex_data(server, ex_data_idx,
600                                    &server_ex_data) == 1);
601     TEST_check(SSL_set_ex_data(client, ex_data_idx,
602                                    &client_ex_data) == 1);
603
604     SSL_set_info_callback(server, &info_cb);
605     SSL_set_info_callback(client, &info_cb);
606
607     /*
608      * Half-duplex handshake loop.
609      * Client and server speak to each other synchronously in the same process.
610      * We use non-blocking BIOs, so whenever one peer blocks for read, it
611      * returns PEER_RETRY to indicate that it's the other peer's turn to write.
612      * The handshake succeeds once both peers have succeeded. If one peer
613      * errors out, we also let the other peer retry (and presumably fail).
614      */
615     for(;;) {
616         if (client_turn) {
617             client_status = do_handshake_step(client, shutdown);
618             status = handshake_status(client_status, server_status,
619                                       1 /* client went last */);
620         } else {
621             server_status = do_handshake_step(server, shutdown);
622             status = handshake_status(server_status, client_status,
623                                       0 /* server went last */);
624         }
625
626         switch (status) {
627         case HANDSHAKE_SUCCESS:
628             if (shutdown) {
629                 ret->result = SSL_TEST_SUCCESS;
630                 goto err;
631             } else {
632                 client_status = server_status = PEER_RETRY;
633                 shutdown = 1;
634                 client_turn = 1;
635                 break;
636             }
637         case CLIENT_ERROR:
638             ret->result = SSL_TEST_CLIENT_FAIL;
639             goto err;
640         case SERVER_ERROR:
641             ret->result = SSL_TEST_SERVER_FAIL;
642             goto err;
643         case INTERNAL_ERROR:
644             ret->result = SSL_TEST_INTERNAL_ERROR;
645             goto err;
646         case HANDSHAKE_RETRY:
647             /* Continue. */
648             client_turn ^= 1;
649             break;
650         }
651     }
652  err:
653     ret->server_alert_sent = server_ex_data.alert_sent;
654     ret->server_alert_received = client_ex_data.alert_received;
655     ret->client_alert_sent = client_ex_data.alert_sent;
656     ret->client_alert_received = server_ex_data.alert_received;
657     ret->server_protocol = SSL_version(server);
658     ret->client_protocol = SSL_version(client);
659     ret->servername = server_ex_data.servername;
660     if ((sess = SSL_get0_session(client)) != NULL)
661         SSL_SESSION_get0_ticket(sess, &tick, &tick_len);
662     if (tick == NULL || tick_len == 0)
663         ret->session_ticket = SSL_TEST_SESSION_TICKET_NO;
664     else
665         ret->session_ticket = SSL_TEST_SESSION_TICKET_YES;
666     ret->session_ticket_do_not_call = server_ex_data.session_ticket_do_not_call;
667
668 #ifndef OPENSSL_NO_NEXTPROTONEG
669     SSL_get0_next_proto_negotiated(client, &proto, &proto_len);
670     ret->client_npn_negotiated = dup_str(proto, proto_len);
671
672     SSL_get0_next_proto_negotiated(server, &proto, &proto_len);
673     ret->server_npn_negotiated = dup_str(proto, proto_len);
674 #endif
675
676     SSL_get0_alpn_selected(client, &proto, &proto_len);
677     ret->client_alpn_negotiated = dup_str(proto, proto_len);
678
679     SSL_get0_alpn_selected(server, &proto, &proto_len);
680     ret->server_alpn_negotiated = dup_str(proto, proto_len);
681
682     ret->client_resumed = SSL_session_reused(client);
683     ret->server_resumed = SSL_session_reused(server);
684
685     if (session_out != NULL)
686         *session_out = SSL_get1_session(client);
687
688     ctx_data_free_data(&server_ctx_data);
689     ctx_data_free_data(&server2_ctx_data);
690     ctx_data_free_data(&client_ctx_data);
691
692     SSL_free(server);
693     SSL_free(client);
694     return ret;
695 }
696
697 HANDSHAKE_RESULT *do_handshake(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
698                                SSL_CTX *client_ctx, SSL_CTX *resume_server_ctx,
699                                SSL_CTX *resume_client_ctx,
700                                const SSL_TEST_CTX *test_ctx)
701 {
702     HANDSHAKE_RESULT *result;
703     SSL_SESSION *session = NULL;
704
705     result = do_handshake_internal(server_ctx, server2_ctx, client_ctx,
706                                    &test_ctx->extra, NULL, &session);
707     if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_SIMPLE)
708         goto end;
709
710     TEST_check(test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RESUME);
711
712     if (result->result != SSL_TEST_SUCCESS) {
713         result->result = SSL_TEST_FIRST_HANDSHAKE_FAILED;
714         return result;
715     }
716
717     HANDSHAKE_RESULT_free(result);
718     /* We don't support SNI on second handshake yet, so server2_ctx is NULL. */
719     result = do_handshake_internal(resume_server_ctx, NULL, resume_client_ctx,
720                                    &test_ctx->resume_extra, session, NULL);
721  end:
722     SSL_SESSION_free(session);
723     return result;
724 }