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