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
  18 HANDSHAKE_RESULT *HANDSHAKE_RESULT_new()
  19 {
  20     HANDSHAKE_RESULT *ret;
  21     ret = OPENSSL_zalloc(sizeof(*ret));
  22     OPENSSL_assert(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     OPENSSL_assert(*out == NULL);
 176
 177     /* Test values are small, so we omit length limit checks. */
 178     *out = OPENSSL_malloc(len + 1);
 179     OPENSSL_assert(*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             OPENSSL_assert(i - 1 - prefix > 0);
 193             (*out)[prefix] = i - 1 - prefix;
 194             prefix = i;
 195         }
 196         i++;
 197     }
 198     OPENSSL_assert(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     OPENSSL_assert(ret == OPENSSL_NPN_NEGOTIATED
 221                    || ret == OPENSSL_NPN_NO_OVERLAP);
 222     return SSL_TLSEXT_ERR_OK;
 223 }
 224
 225 static int server_npn_cb(SSL *s, const unsigned char **data,
 226                          unsigned int *len, void *arg)
 227 {
 228     CTX_DATA *ctx_data = (CTX_DATA*)(arg);
 229     *data = ctx_data->npn_protocols;
 230     *len = ctx_data->npn_protocols_len;
 231     return SSL_TLSEXT_ERR_OK;
 232 }
 233 #endif
 234
 235 /*
 236  * The server SHOULD select the most highly preferred protocol that it supports
 237  * and that is also advertised by the client.  In the event that the server
 238  * supports no protocols that the client advertises, then the server SHALL
 239  * respond with a fatal "no_application_protocol" alert.
 240  */
 241 static int server_alpn_cb(SSL *s, const unsigned char **out,
 242                           unsigned char *outlen, const unsigned char *in,
 243                           unsigned int inlen, void *arg)
 244 {
 245     CTX_DATA *ctx_data = (CTX_DATA*)(arg);
 246     int ret;
 247
 248     /* SSL_select_next_proto isn't const-correct... */
 249     unsigned char *tmp_out;
 250
 251     /*
 252      * The result points either to |in| or to |ctx_data->alpn_protocols|.
 253      * The callback is allowed to point to |in| or to a long-lived buffer,
 254      * so we can return directly without storing a copy.
 255      */
 256     ret = SSL_select_next_proto(&tmp_out, outlen,
 257                                 ctx_data->alpn_protocols,
 258                                 ctx_data->alpn_protocols_len, in, inlen);
 259
 260     *out = tmp_out;
 261     /* Unlike NPN, we don't tolerate a mismatch. */
 262     return ret == OPENSSL_NPN_NEGOTIATED ? SSL_TLSEXT_ERR_OK
 263         : SSL_TLSEXT_ERR_NOACK;
 264 }
 265
 266 /*
 267  * Configure callbacks and other properties that can't be set directly
 268  * in the server/client CONF.
 269  */
 270 static void configure_handshake_ctx(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
 271                                     SSL_CTX *client_ctx,
 272                                     const SSL_TEST_EXTRA_CONF *extra,
 273                                     CTX_DATA *server_ctx_data,
 274                                     CTX_DATA *server2_ctx_data,
 275                                     CTX_DATA *client_ctx_data)
 276 {
 277     unsigned char *ticket_keys;
 278     size_t ticket_key_len;
 279
 280     switch (extra->client.verify_callback) {
 281     case SSL_TEST_VERIFY_ACCEPT_ALL:
 282         SSL_CTX_set_cert_verify_callback(client_ctx, &verify_accept_cb,
 283                                          NULL);
 284         break;
 285     case SSL_TEST_VERIFY_REJECT_ALL:
 286         SSL_CTX_set_cert_verify_callback(client_ctx, &verify_reject_cb,
 287                                          NULL);
 288         break;
 289     default:
 290         break;
 291     }
 292
 293     /* link the two contexts for SNI purposes */
 294     switch (extra->server.servername_callback) {
 295     case SSL_TEST_SERVERNAME_IGNORE_MISMATCH:
 296         SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_ignore_cb);
 297         SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
 298         break;
 299     case SSL_TEST_SERVERNAME_REJECT_MISMATCH:
 300         SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_reject_cb);
 301         SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
 302         break;
 303     default:
 304         break;
 305     }
 306
 307     /*
 308      * The initial_ctx/session_ctx always handles the encrypt/decrypt of the
 309      * session ticket. This ticket_key callback is assigned to the second
 310      * session (assigned via SNI), and should never be invoked
 311      */
 312     if (server2_ctx != NULL)
 313         SSL_CTX_set_tlsext_ticket_key_cb(server2_ctx,
 314                                          do_not_call_session_ticket_cb);
 315
 316     if (extra->server.broken_session_ticket) {
 317         SSL_CTX_set_tlsext_ticket_key_cb(server_ctx, broken_session_ticket_cb);
 318     }
 319 #ifndef OPENSSL_NO_NEXTPROTONEG
 320     if (extra->server.npn_protocols != NULL) {
 321         parse_protos(extra->server.npn_protocols,
 322                      &server_ctx_data->npn_protocols,
 323                      &server_ctx_data->npn_protocols_len);
 324         SSL_CTX_set_next_protos_advertised_cb(server_ctx, server_npn_cb,
 325                                               server_ctx_data);
 326     }
 327     if (extra->server2.npn_protocols != NULL) {
 328         parse_protos(extra->server2.npn_protocols,
 329                      &server2_ctx_data->npn_protocols,
 330                      &server2_ctx_data->npn_protocols_len);
 331         OPENSSL_assert(server2_ctx != NULL);
 332         SSL_CTX_set_next_protos_advertised_cb(server2_ctx, server_npn_cb,
 333                                               server2_ctx_data);
 334     }
 335     if (extra->client.npn_protocols != NULL) {
 336         parse_protos(extra->client.npn_protocols,
 337                      &client_ctx_data->npn_protocols,
 338                      &client_ctx_data->npn_protocols_len);
 339         SSL_CTX_set_next_proto_select_cb(client_ctx, client_npn_cb,
 340                                          client_ctx_data);
 341     }
 342 #endif
 343     if (extra->server.alpn_protocols != NULL) {
 344         parse_protos(extra->server.alpn_protocols,
 345                      &server_ctx_data->alpn_protocols,
 346                      &server_ctx_data->alpn_protocols_len);
 347         SSL_CTX_set_alpn_select_cb(server_ctx, server_alpn_cb, server_ctx_data);
 348     }
 349     if (extra->server2.alpn_protocols != NULL) {
 350         OPENSSL_assert(server2_ctx != NULL);
 351         parse_protos(extra->server2.alpn_protocols,
 352                      &server2_ctx_data->alpn_protocols,
 353                      &server2_ctx_data->alpn_protocols_len);
 354         SSL_CTX_set_alpn_select_cb(server2_ctx, server_alpn_cb, server2_ctx_data);
 355     }
 356     if (extra->client.alpn_protocols != NULL) {
 357         unsigned char *alpn_protos = NULL;
 358         size_t alpn_protos_len;
 359         parse_protos(extra->client.alpn_protocols,
 360                      &alpn_protos, &alpn_protos_len);
 361         /* Reversed return value convention... */
 362         OPENSSL_assert(SSL_CTX_set_alpn_protos(client_ctx, alpn_protos,
 363                                                alpn_protos_len) == 0);
 364         OPENSSL_free(alpn_protos);
 365     }
 366
 367     /*
 368      * Use fixed session ticket keys so that we can decrypt a ticket created with
 369      * one CTX in another CTX. Don't address server2 for the moment.
 370      */
 371     ticket_key_len = SSL_CTX_set_tlsext_ticket_keys(server_ctx, NULL, 0);
 372     ticket_keys = OPENSSL_zalloc(ticket_key_len);
 373     OPENSSL_assert(ticket_keys != NULL);
 374     OPENSSL_assert(SSL_CTX_set_tlsext_ticket_keys(server_ctx, ticket_keys,
 375                                                   ticket_key_len) == 1);
 376     OPENSSL_free(ticket_keys);
 377 }
 378
 379 /* Configure per-SSL callbacks and other properties. */
 380 static void configure_handshake_ssl(SSL *server, SSL *client,
 381                                     const SSL_TEST_EXTRA_CONF *extra)
 382 {
 383     if (extra->client.servername != SSL_TEST_SERVERNAME_NONE)
 384         SSL_set_tlsext_host_name(client,
 385                                  ssl_servername_name(extra->client.servername));
 386 }
 387
 388
 389 typedef enum {
 390     PEER_SUCCESS,
 391     PEER_RETRY,
 392     PEER_ERROR
 393 } peer_status_t;
 394
 395 /*
 396  * RFC 5246 says:
 397  *
 398  * Note that as of TLS 1.1,
 399  *     failure to properly close a connection no longer requires that a
 400  *     session not be resumed.  This is a change from TLS 1.0 to conform
 401  *     with widespread implementation practice.
 402  *
 403  * However,
 404  * (a) OpenSSL requires that a connection be shutdown for all protocol versions.
 405  * (b) We test lower versions, too.
 406  * So we just implement shutdown. We do a full bidirectional shutdown so that we
 407  * can compare sent and received close_notify alerts and get some test coverage
 408  * for SSL_shutdown as a bonus.
 409  */
 410 static peer_status_t do_handshake_step(SSL *ssl, int shutdown)
 411 {
 412     int ret;
 413
 414     ret = shutdown ? SSL_shutdown(ssl) : SSL_do_handshake(ssl);
 415
 416     if (ret == 1) {
 417         return PEER_SUCCESS;
 418     } else if (ret == 0) {
 419         return shutdown ? PEER_RETRY : PEER_ERROR;
 420     } else {
 421         int error = SSL_get_error(ssl, ret);
 422         /* Memory bios should never block with SSL_ERROR_WANT_WRITE. */
 423         if (error == SSL_ERROR_WANT_READ)
 424             return PEER_RETRY;
 425         else
 426             return PEER_ERROR;
 427     }
 428 }
 429
 430 typedef enum {
 431     /* Both parties succeeded. */
 432     HANDSHAKE_SUCCESS,
 433     /* Client errored. */
 434     CLIENT_ERROR,
 435     /* Server errored. */
 436     SERVER_ERROR,
 437     /* Peers are in inconsistent state. */
 438     INTERNAL_ERROR,
 439     /* One or both peers not done. */
 440     HANDSHAKE_RETRY
 441 } handshake_status_t;
 442
 443 /*
 444  * Determine the handshake outcome.
 445  * last_status: the status of the peer to have acted last.
 446  * previous_status: the status of the peer that didn't act last.
 447  * client_spoke_last: 1 if the client went last.
 448  */
 449 static handshake_status_t handshake_status(peer_status_t last_status,
 450                                            peer_status_t previous_status,
 451                                            int client_spoke_last)
 452 {
 453     switch (last_status) {
 454     case PEER_SUCCESS:
 455         switch (previous_status) {
 456         case PEER_SUCCESS:
 457             /* Both succeeded. */
 458             return HANDSHAKE_SUCCESS;
 459         case PEER_RETRY:
 460             /* Let the first peer finish. */
 461             return HANDSHAKE_RETRY;
 462         case PEER_ERROR:
 463             /*
 464              * Second peer succeeded despite the fact that the first peer
 465              * already errored. This shouldn't happen.
 466              */
 467             return INTERNAL_ERROR;
 468         }
 469
 470     case PEER_RETRY:
 471         if (previous_status == PEER_RETRY) {
 472             /* Neither peer is done. */
 473             return HANDSHAKE_RETRY;
 474         } else {
 475             /*
 476              * Deadlock: second peer is waiting for more input while first
 477              * peer thinks they're done (no more input is coming).
 478              */
 479             return INTERNAL_ERROR;
 480         }
 481     case PEER_ERROR:
 482         switch (previous_status) {
 483         case PEER_SUCCESS:
 484             /*
 485              * First peer succeeded but second peer errored.
 486              * TODO(emilia): we should be able to continue here (with some
 487              * application data?) to ensure the first peer receives the
 488              * alert / close_notify.
 489              */
 490             return client_spoke_last ? CLIENT_ERROR : SERVER_ERROR;
 491         case PEER_RETRY:
 492             /* We errored; let the peer finish. */
 493             return HANDSHAKE_RETRY;
 494         case PEER_ERROR:
 495             /* Both peers errored. Return the one that errored first. */
 496             return client_spoke_last ? SERVER_ERROR : CLIENT_ERROR;
 497         }
 498     }
 499     /* Control should never reach here. */
 500     return INTERNAL_ERROR;
 501 }
 502
 503 /* Convert unsigned char buf's that shouldn't contain any NUL-bytes to char. */
 504 static char *dup_str(const unsigned char *in, size_t len)
 505 {
 506     char *ret;
 507
 508     if(len == 0)
 509         return NULL;
 510
 511     /* Assert that the string does not contain NUL-bytes. */
 512     OPENSSL_assert(OPENSSL_strnlen((const char*)(in), len) == len);
 513     ret = OPENSSL_strndup((const char*)(in), len);
 514     OPENSSL_assert(ret != NULL);
 515     return ret;
 516 }
 517
 518 static HANDSHAKE_RESULT *do_handshake_internal(
 519     SSL_CTX *server_ctx, SSL_CTX *server2_ctx, SSL_CTX *client_ctx,
 520     const SSL_TEST_EXTRA_CONF *extra, SSL_SESSION *session_in,
 521     SSL_SESSION **session_out)
 522 {
 523     SSL *server, *client;
 524     BIO *client_to_server, *server_to_client;
 525     HANDSHAKE_EX_DATA server_ex_data, client_ex_data;
 526     CTX_DATA client_ctx_data, server_ctx_data, server2_ctx_data;
 527     HANDSHAKE_RESULT *ret = HANDSHAKE_RESULT_new();
 528     int client_turn = 1, shutdown = 0;
 529     peer_status_t client_status = PEER_RETRY, server_status = PEER_RETRY;
 530     handshake_status_t status = HANDSHAKE_RETRY;
 531     unsigned char* tick = NULL;
 532     size_t tick_len = 0;
 533     SSL_SESSION* sess = NULL;
 534     const unsigned char *proto = NULL;
 535     /* API dictates unsigned int rather than size_t. */
 536     unsigned int proto_len = 0;
 537
 538     memset(&server_ctx_data, 0, sizeof(server_ctx_data));
 539     memset(&server2_ctx_data, 0, sizeof(server2_ctx_data));
 540     memset(&client_ctx_data, 0, sizeof(client_ctx_data));
 541
 542     configure_handshake_ctx(server_ctx, server2_ctx, client_ctx, extra,
 543                             &server_ctx_data, &server2_ctx_data, &client_ctx_data);
 544
 545     server = SSL_new(server_ctx);
 546     client = SSL_new(client_ctx);
 547     OPENSSL_assert(server != NULL && client != NULL);
 548
 549     configure_handshake_ssl(server, client, extra);
 550     if (session_in != NULL) {
 551         /* In case we're testing resumption without tickets. */
 552         OPENSSL_assert(SSL_CTX_add_session(server_ctx, session_in));
 553         OPENSSL_assert(SSL_set_session(client, session_in));
 554     }
 555
 556     memset(&server_ex_data, 0, sizeof(server_ex_data));
 557     memset(&client_ex_data, 0, sizeof(client_ex_data));
 558
 559     ret->result = SSL_TEST_INTERNAL_ERROR;
 560
 561     client_to_server = BIO_new(BIO_s_mem());
 562     server_to_client = BIO_new(BIO_s_mem());
 563
 564     OPENSSL_assert(client_to_server != NULL && server_to_client != NULL);
 565
 566     /* Non-blocking bio. */
 567     BIO_set_nbio(client_to_server, 1);
 568     BIO_set_nbio(server_to_client, 1);
 569
 570     SSL_set_connect_state(client);
 571     SSL_set_accept_state(server);
 572
 573     /* The bios are now owned by the SSL object. */
 574     SSL_set_bio(client, server_to_client, client_to_server);
 575     OPENSSL_assert(BIO_up_ref(server_to_client) > 0);
 576     OPENSSL_assert(BIO_up_ref(client_to_server) > 0);
 577     SSL_set_bio(server, client_to_server, server_to_client);
 578
 579     ex_data_idx = SSL_get_ex_new_index(0, "ex data", NULL, NULL, NULL);
 580     OPENSSL_assert(ex_data_idx >= 0);
 581
 582     OPENSSL_assert(SSL_set_ex_data(server, ex_data_idx,
 583                                    &server_ex_data) == 1);
 584     OPENSSL_assert(SSL_set_ex_data(client, ex_data_idx,
 585                                    &client_ex_data) == 1);
 586
 587     SSL_set_info_callback(server, &info_cb);
 588     SSL_set_info_callback(client, &info_cb);
 589
 590     /*
 591      * Half-duplex handshake loop.
 592      * Client and server speak to each other synchronously in the same process.
 593      * We use non-blocking BIOs, so whenever one peer blocks for read, it
 594      * returns PEER_RETRY to indicate that it's the other peer's turn to write.
 595      * The handshake succeeds once both peers have succeeded. If one peer
 596      * errors out, we also let the other peer retry (and presumably fail).
 597      */
 598     for(;;) {
 599         if (client_turn) {
 600             client_status = do_handshake_step(client, shutdown);
 601             status = handshake_status(client_status, server_status,
 602                                       1 /* client went last */);
 603         } else {
 604             server_status = do_handshake_step(server, shutdown);
 605             status = handshake_status(server_status, client_status,
 606                                       0 /* server went last */);
 607         }
 608
 609         switch (status) {
 610         case HANDSHAKE_SUCCESS:
 611             if (shutdown) {
 612                 ret->result = SSL_TEST_SUCCESS;
 613                 goto err;
 614             } else {
 615                 client_status = server_status = PEER_RETRY;
 616                 shutdown = 1;
 617                 client_turn = 1;
 618                 break;
 619             }
 620         case CLIENT_ERROR:
 621             ret->result = SSL_TEST_CLIENT_FAIL;
 622             goto err;
 623         case SERVER_ERROR:
 624             ret->result = SSL_TEST_SERVER_FAIL;
 625             goto err;
 626         case INTERNAL_ERROR:
 627             ret->result = SSL_TEST_INTERNAL_ERROR;
 628             goto err;
 629         case HANDSHAKE_RETRY:
 630             /* Continue. */
 631             client_turn ^= 1;
 632             break;
 633         }
 634     }
 635  err:
 636     ret->server_alert_sent = server_ex_data.alert_sent;
 637     ret->server_alert_received = client_ex_data.alert_received;
 638     ret->client_alert_sent = client_ex_data.alert_sent;
 639     ret->client_alert_received = server_ex_data.alert_received;
 640     ret->server_protocol = SSL_version(server);
 641     ret->client_protocol = SSL_version(client);
 642     ret->servername = server_ex_data.servername;
 643     if ((sess = SSL_get0_session(client)) != NULL)
 644         SSL_SESSION_get0_ticket(sess, &tick, &tick_len);
 645     if (tick == NULL || tick_len == 0)
 646         ret->session_ticket = SSL_TEST_SESSION_TICKET_NO;
 647     else
 648         ret->session_ticket = SSL_TEST_SESSION_TICKET_YES;
 649     ret->session_ticket_do_not_call = server_ex_data.session_ticket_do_not_call;
 650
 651 #ifndef OPENSSL_NO_NEXTPROTONEG
 652     SSL_get0_next_proto_negotiated(client, &proto, &proto_len);
 653     ret->client_npn_negotiated = dup_str(proto, proto_len);
 654
 655     SSL_get0_next_proto_negotiated(server, &proto, &proto_len);
 656     ret->server_npn_negotiated = dup_str(proto, proto_len);
 657 #endif
 658
 659     SSL_get0_alpn_selected(client, &proto, &proto_len);
 660     ret->client_alpn_negotiated = dup_str(proto, proto_len);
 661
 662     SSL_get0_alpn_selected(server, &proto, &proto_len);
 663     ret->server_alpn_negotiated = dup_str(proto, proto_len);
 664
 665     ret->client_resumed = SSL_session_reused(client);
 666     ret->server_resumed = SSL_session_reused(server);
 667
 668     if (session_out != NULL)
 669         *session_out = SSL_get1_session(client);
 670
 671     ctx_data_free_data(&server_ctx_data);
 672     ctx_data_free_data(&server2_ctx_data);
 673     ctx_data_free_data(&client_ctx_data);
 674
 675     SSL_free(server);
 676     SSL_free(client);
 677     return ret;
 678 }
 679
 680 HANDSHAKE_RESULT *do_handshake(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
 681                                SSL_CTX *client_ctx, SSL_CTX *resume_server_ctx,
 682                                SSL_CTX *resume_client_ctx,
 683                                const SSL_TEST_CTX *test_ctx)
 684 {
 685     HANDSHAKE_RESULT *result;
 686     SSL_SESSION *session = NULL;
 687
 688     result = do_handshake_internal(server_ctx, server2_ctx, client_ctx,
 689                                    &test_ctx->extra, NULL, &session);
 690     if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_SIMPLE)
 691         goto end;
 692
 693     OPENSSL_assert(test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RESUME);
 694
 695     if (result->result != SSL_TEST_SUCCESS) {
 696         result->result = SSL_TEST_FIRST_HANDSHAKE_FAILED;
 697         return result;
 698     }
 699
 700     HANDSHAKE_RESULT_free(result);
 701     /* We don't support SNI on second handshake yet, so server2_ctx is NULL. */
 702     result = do_handshake_internal(resume_server_ctx, NULL, resume_client_ctx,
 703                                    &test_ctx->resume_extra, session, NULL);
 704  end:
 705     SSL_SESSION_free(session);
 706     return result;
 707 }