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