test/handshake_helper.c

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