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