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