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