2 * Copyright 2016-2018 The OpenSSL Project Authors. All Rights Reserved.
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
12 #include <openssl/bio.h>
13 #include <openssl/x509_vfy.h>
14 #include <openssl/ssl.h>
16 #include "handshake_helper.h"
19 HANDSHAKE_RESULT *HANDSHAKE_RESULT_new()
21 HANDSHAKE_RESULT *ret = OPENSSL_zalloc(sizeof(*ret));
22 TEST_check(ret != NULL);
26 void HANDSHAKE_RESULT_free(HANDSHAKE_RESULT *result)
30 OPENSSL_free(result->client_npn_negotiated);
31 OPENSSL_free(result->server_npn_negotiated);
32 OPENSSL_free(result->client_alpn_negotiated);
33 OPENSSL_free(result->server_alpn_negotiated);
38 * Since there appears to be no way to extract the sent/received alert
39 * from the SSL object directly, we use the info callback and stash
40 * the result in ex_data.
42 typedef struct handshake_ex_data_st {
44 int num_fatal_alerts_sent;
46 int session_ticket_do_not_call;
47 ssl_servername_t servername;
50 typedef struct ctx_data_st {
51 unsigned char *npn_protocols;
52 size_t npn_protocols_len;
53 unsigned char *alpn_protocols;
54 size_t alpn_protocols_len;
57 /* |ctx_data| itself is stack-allocated. */
58 static void ctx_data_free_data(CTX_DATA *ctx_data)
60 OPENSSL_free(ctx_data->npn_protocols);
61 ctx_data->npn_protocols = NULL;
62 OPENSSL_free(ctx_data->alpn_protocols);
63 ctx_data->alpn_protocols = NULL;
66 static int ex_data_idx;
68 static void info_cb(const SSL *s, int where, int ret)
70 if (where & SSL_CB_ALERT) {
71 HANDSHAKE_EX_DATA *ex_data =
72 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
73 if (where & SSL_CB_WRITE) {
74 ex_data->alert_sent = ret;
75 if (strcmp(SSL_alert_type_string(ret), "F") == 0
76 || strcmp(SSL_alert_desc_string(ret), "CN") == 0)
77 ex_data->num_fatal_alerts_sent++;
79 ex_data->alert_received = ret;
84 /* Select the appropriate server CTX.
85 * Returns SSL_TLSEXT_ERR_OK if a match was found.
86 * If |ignore| is 1, returns SSL_TLSEXT_ERR_NOACK on mismatch.
87 * Otherwise, returns SSL_TLSEXT_ERR_ALERT_FATAL on mismatch.
88 * An empty SNI extension also returns SSL_TSLEXT_ERR_NOACK.
90 static int select_server_ctx(SSL *s, void *arg, int ignore)
92 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
93 HANDSHAKE_EX_DATA *ex_data =
94 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
96 if (servername == NULL) {
97 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
98 return SSL_TLSEXT_ERR_NOACK;
101 if (strcmp(servername, "server2") == 0) {
102 SSL_CTX *new_ctx = (SSL_CTX*)arg;
103 SSL_set_SSL_CTX(s, new_ctx);
105 * Copy over all the SSL_CTX options - reasonable behavior
106 * allows testing of cases where the options between two
107 * contexts differ/conflict
109 SSL_clear_options(s, 0xFFFFFFFFL);
110 SSL_set_options(s, SSL_CTX_get_options(new_ctx));
112 ex_data->servername = SSL_TEST_SERVERNAME_SERVER2;
113 return SSL_TLSEXT_ERR_OK;
114 } else if (strcmp(servername, "server1") == 0) {
115 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
116 return SSL_TLSEXT_ERR_OK;
118 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
119 return SSL_TLSEXT_ERR_NOACK;
121 /* Don't set an explicit alert, to test library defaults. */
122 return SSL_TLSEXT_ERR_ALERT_FATAL;
128 * If the server understood the ClientHello extension but
129 * does not recognize the server name, the server SHOULD take one of two
130 * actions: either abort the handshake by sending a fatal-level
131 * unrecognized_name(112) alert or continue the handshake.
133 * This behaviour is up to the application to configure; we test both
134 * configurations to ensure the state machine propagates the result
137 static int servername_ignore_cb(SSL *s, int *ad, void *arg)
139 return select_server_ctx(s, arg, 1);
142 static int servername_reject_cb(SSL *s, int *ad, void *arg)
144 return select_server_ctx(s, arg, 0);
147 static unsigned char dummy_ocsp_resp_good_val = 0xff;
148 static unsigned char dummy_ocsp_resp_bad_val = 0xfe;
150 static int server_ocsp_cb(SSL *s, void *arg)
154 resp = OPENSSL_malloc(1);
156 return SSL_TLSEXT_ERR_ALERT_FATAL;
158 * For the purposes of testing we just send back a dummy OCSP response
160 *resp = *(unsigned char *)arg;
161 if (!SSL_set_tlsext_status_ocsp_resp(s, resp, 1))
162 return SSL_TLSEXT_ERR_ALERT_FATAL;
164 return SSL_TLSEXT_ERR_OK;
167 static int client_ocsp_cb(SSL *s, void *arg)
169 const unsigned char *resp;
172 len = SSL_get_tlsext_status_ocsp_resp(s, &resp);
173 if (len != 1 || *resp != dummy_ocsp_resp_good_val)
179 static int verify_reject_cb(X509_STORE_CTX *ctx, void *arg) {
180 X509_STORE_CTX_set_error(ctx, X509_V_ERR_APPLICATION_VERIFICATION);
184 static int verify_accept_cb(X509_STORE_CTX *ctx, void *arg) {
188 static int broken_session_ticket_cb(SSL *s, unsigned char *key_name, unsigned char *iv,
189 EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc)
194 static int do_not_call_session_ticket_cb(SSL *s, unsigned char *key_name,
197 HMAC_CTX *hctx, int enc)
199 HANDSHAKE_EX_DATA *ex_data =
200 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
201 ex_data->session_ticket_do_not_call = 1;
205 /* Parse the comma-separated list into TLS format. */
206 static void parse_protos(const char *protos, unsigned char **out, size_t *outlen)
208 size_t len, i, prefix;
210 len = strlen(protos);
212 /* Should never have reuse. */
213 TEST_check(*out == NULL);
215 /* Test values are small, so we omit length limit checks. */
216 *out = OPENSSL_malloc(len + 1);
217 TEST_check(*out != NULL);
221 * foo => '3', 'f', 'o', 'o'
222 * foo,bar => '3', 'f', 'o', 'o', '3', 'b', 'a', 'r'
224 memcpy(*out + 1, protos, len);
229 if ((*out)[i] == ',') {
230 TEST_check(i - 1 - prefix > 0);
231 (*out)[prefix] = i - 1 - prefix;
236 TEST_check(len - prefix > 0);
237 (*out)[prefix] = len - prefix;
240 #ifndef OPENSSL_NO_NEXTPROTONEG
242 * The client SHOULD select the first protocol advertised by the server that it
243 * also supports. In the event that the client doesn't support any of server's
244 * protocols, or the server doesn't advertise any, it SHOULD select the first
245 * protocol that it supports.
247 static int client_npn_cb(SSL *s, unsigned char **out, unsigned char *outlen,
248 const unsigned char *in, unsigned int inlen,
251 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
254 ret = SSL_select_next_proto(out, outlen, in, inlen,
255 ctx_data->npn_protocols,
256 ctx_data->npn_protocols_len);
257 /* Accept both OPENSSL_NPN_NEGOTIATED and OPENSSL_NPN_NO_OVERLAP. */
258 TEST_check(ret == OPENSSL_NPN_NEGOTIATED || ret == OPENSSL_NPN_NO_OVERLAP);
259 return SSL_TLSEXT_ERR_OK;
262 static int server_npn_cb(SSL *s, const unsigned char **data,
263 unsigned int *len, void *arg)
265 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
266 *data = ctx_data->npn_protocols;
267 *len = ctx_data->npn_protocols_len;
268 return SSL_TLSEXT_ERR_OK;
273 * The server SHOULD select the most highly preferred protocol that it supports
274 * and that is also advertised by the client. In the event that the server
275 * supports no protocols that the client advertises, then the server SHALL
276 * respond with a fatal "no_application_protocol" alert.
278 static int server_alpn_cb(SSL *s, const unsigned char **out,
279 unsigned char *outlen, const unsigned char *in,
280 unsigned int inlen, void *arg)
282 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
285 /* SSL_select_next_proto isn't const-correct... */
286 unsigned char *tmp_out;
289 * The result points either to |in| or to |ctx_data->alpn_protocols|.
290 * The callback is allowed to point to |in| or to a long-lived buffer,
291 * so we can return directly without storing a copy.
293 ret = SSL_select_next_proto(&tmp_out, outlen,
294 ctx_data->alpn_protocols,
295 ctx_data->alpn_protocols_len, in, inlen);
298 /* Unlike NPN, we don't tolerate a mismatch. */
299 return ret == OPENSSL_NPN_NEGOTIATED ? SSL_TLSEXT_ERR_OK
300 : SSL_TLSEXT_ERR_ALERT_FATAL;
304 * Configure callbacks and other properties that can't be set directly
305 * in the server/client CONF.
307 static void configure_handshake_ctx(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
309 const SSL_TEST_CTX *test,
310 const SSL_TEST_EXTRA_CONF *extra,
311 CTX_DATA *server_ctx_data,
312 CTX_DATA *server2_ctx_data,
313 CTX_DATA *client_ctx_data)
315 unsigned char *ticket_keys;
316 size_t ticket_key_len;
318 TEST_check(SSL_CTX_set_max_send_fragment(server_ctx,
319 test->max_fragment_size) == 1);
320 if (server2_ctx != NULL) {
321 TEST_check(SSL_CTX_set_max_send_fragment(server2_ctx,
322 test->max_fragment_size) == 1);
324 TEST_check(SSL_CTX_set_max_send_fragment(client_ctx,
325 test->max_fragment_size) == 1);
327 switch (extra->client.verify_callback) {
328 case SSL_TEST_VERIFY_ACCEPT_ALL:
329 SSL_CTX_set_cert_verify_callback(client_ctx, &verify_accept_cb,
332 case SSL_TEST_VERIFY_REJECT_ALL:
333 SSL_CTX_set_cert_verify_callback(client_ctx, &verify_reject_cb,
340 /* link the two contexts for SNI purposes */
341 switch (extra->server.servername_callback) {
342 case SSL_TEST_SERVERNAME_IGNORE_MISMATCH:
343 SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_ignore_cb);
344 SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
346 case SSL_TEST_SERVERNAME_REJECT_MISMATCH:
347 SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_reject_cb);
348 SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
354 if (extra->server.cert_status != SSL_TEST_CERT_STATUS_NONE) {
355 SSL_CTX_set_tlsext_status_type(client_ctx, TLSEXT_STATUSTYPE_ocsp);
356 SSL_CTX_set_tlsext_status_cb(client_ctx, client_ocsp_cb);
357 SSL_CTX_set_tlsext_status_arg(client_ctx, NULL);
358 SSL_CTX_set_tlsext_status_cb(server_ctx, server_ocsp_cb);
359 SSL_CTX_set_tlsext_status_arg(server_ctx,
360 ((extra->server.cert_status == SSL_TEST_CERT_STATUS_GOOD_RESPONSE)
361 ? &dummy_ocsp_resp_good_val : &dummy_ocsp_resp_bad_val));
365 * The initial_ctx/session_ctx always handles the encrypt/decrypt of the
366 * session ticket. This ticket_key callback is assigned to the second
367 * session (assigned via SNI), and should never be invoked
369 if (server2_ctx != NULL)
370 SSL_CTX_set_tlsext_ticket_key_cb(server2_ctx,
371 do_not_call_session_ticket_cb);
373 if (extra->server.broken_session_ticket) {
374 SSL_CTX_set_tlsext_ticket_key_cb(server_ctx, broken_session_ticket_cb);
376 #ifndef OPENSSL_NO_NEXTPROTONEG
377 if (extra->server.npn_protocols != NULL) {
378 parse_protos(extra->server.npn_protocols,
379 &server_ctx_data->npn_protocols,
380 &server_ctx_data->npn_protocols_len);
381 SSL_CTX_set_next_protos_advertised_cb(server_ctx, server_npn_cb,
384 if (extra->server2.npn_protocols != NULL) {
385 parse_protos(extra->server2.npn_protocols,
386 &server2_ctx_data->npn_protocols,
387 &server2_ctx_data->npn_protocols_len);
388 TEST_check(server2_ctx != NULL);
389 SSL_CTX_set_next_protos_advertised_cb(server2_ctx, server_npn_cb,
392 if (extra->client.npn_protocols != NULL) {
393 parse_protos(extra->client.npn_protocols,
394 &client_ctx_data->npn_protocols,
395 &client_ctx_data->npn_protocols_len);
396 SSL_CTX_set_next_proto_select_cb(client_ctx, client_npn_cb,
400 if (extra->server.alpn_protocols != NULL) {
401 parse_protos(extra->server.alpn_protocols,
402 &server_ctx_data->alpn_protocols,
403 &server_ctx_data->alpn_protocols_len);
404 SSL_CTX_set_alpn_select_cb(server_ctx, server_alpn_cb, server_ctx_data);
406 if (extra->server2.alpn_protocols != NULL) {
407 TEST_check(server2_ctx != NULL);
408 parse_protos(extra->server2.alpn_protocols,
409 &server2_ctx_data->alpn_protocols,
410 &server2_ctx_data->alpn_protocols_len);
411 SSL_CTX_set_alpn_select_cb(server2_ctx, server_alpn_cb, server2_ctx_data);
413 if (extra->client.alpn_protocols != NULL) {
414 unsigned char *alpn_protos = NULL;
415 size_t alpn_protos_len;
416 parse_protos(extra->client.alpn_protocols,
417 &alpn_protos, &alpn_protos_len);
418 /* Reversed return value convention... */
419 TEST_check(SSL_CTX_set_alpn_protos(client_ctx, alpn_protos,
420 alpn_protos_len) == 0);
421 OPENSSL_free(alpn_protos);
425 * Use fixed session ticket keys so that we can decrypt a ticket created with
426 * one CTX in another CTX. Don't address server2 for the moment.
428 ticket_key_len = SSL_CTX_set_tlsext_ticket_keys(server_ctx, NULL, 0);
429 ticket_keys = OPENSSL_zalloc(ticket_key_len);
430 TEST_check(ticket_keys != NULL);
431 TEST_check(SSL_CTX_set_tlsext_ticket_keys(server_ctx, ticket_keys,
432 ticket_key_len) == 1);
433 OPENSSL_free(ticket_keys);
435 /* The default log list includes EC keys, so CT can't work without EC. */
436 #if !defined(OPENSSL_NO_CT) && !defined(OPENSSL_NO_EC)
437 TEST_check(SSL_CTX_set_default_ctlog_list_file(client_ctx));
438 switch (extra->client.ct_validation) {
439 case SSL_TEST_CT_VALIDATION_PERMISSIVE:
440 TEST_check(SSL_CTX_enable_ct(client_ctx, SSL_CT_VALIDATION_PERMISSIVE));
442 case SSL_TEST_CT_VALIDATION_STRICT:
443 TEST_check(SSL_CTX_enable_ct(client_ctx, SSL_CT_VALIDATION_STRICT));
445 case SSL_TEST_CT_VALIDATION_NONE:
451 /* Configure per-SSL callbacks and other properties. */
452 static void configure_handshake_ssl(SSL *server, SSL *client,
453 const SSL_TEST_EXTRA_CONF *extra)
455 if (extra->client.servername != SSL_TEST_SERVERNAME_NONE)
456 SSL_set_tlsext_host_name(client,
457 ssl_servername_name(extra->client.servername));
460 /* The status for each connection phase. */
467 /* An SSL object and associated read-write buffers. */
468 typedef struct peer_st {
470 /* Buffer lengths are int to match the SSL read/write API. */
471 unsigned char *write_buf;
473 unsigned char *read_buf;
477 peer_status_t status;
480 static void create_peer(PEER *peer, SSL_CTX *ctx)
482 static const int peer_buffer_size = 64 * 1024;
484 peer->ssl = SSL_new(ctx);
485 TEST_check(peer->ssl != NULL);
486 peer->write_buf = OPENSSL_zalloc(peer_buffer_size);
487 TEST_check(peer->write_buf != NULL);
488 peer->read_buf = OPENSSL_zalloc(peer_buffer_size);
489 TEST_check(peer->read_buf != NULL);
490 peer->write_buf_len = peer->read_buf_len = peer_buffer_size;
493 static void peer_free_data(PEER *peer)
496 OPENSSL_free(peer->write_buf);
497 OPENSSL_free(peer->read_buf);
501 * Note that we could do the handshake transparently under an SSL_write,
502 * but separating the steps is more helpful for debugging test failures.
504 static void do_handshake_step(PEER *peer)
508 if (peer->status != PEER_RETRY) {
509 peer->status = PEER_ERROR;
513 ret = SSL_do_handshake(peer->ssl);
516 peer->status = PEER_SUCCESS;
517 } else if (ret == 0) {
518 peer->status = PEER_ERROR;
520 int error = SSL_get_error(peer->ssl, ret);
521 /* Memory bios should never block with SSL_ERROR_WANT_WRITE. */
522 if (error != SSL_ERROR_WANT_READ)
523 peer->status = PEER_ERROR;
528 * Send/receive some application data. The read-write sequence is
529 * Peer A: (R) W - first read will yield no data
536 static void do_app_data_step(PEER *peer)
538 int ret = 1, write_bytes;
540 TEST_check(peer->status == PEER_RETRY);
542 /* We read everything available... */
543 while (ret > 0 && peer->bytes_to_read) {
544 ret = SSL_read(peer->ssl, peer->read_buf, peer->read_buf_len);
546 TEST_check(ret <= peer->bytes_to_read);
547 peer->bytes_to_read -= ret;
548 } else if (ret == 0) {
549 peer->status = PEER_ERROR;
552 int error = SSL_get_error(peer->ssl, ret);
553 if (error != SSL_ERROR_WANT_READ) {
554 peer->status = PEER_ERROR;
556 } /* Else continue with write. */
560 /* ... but we only write one write-buffer-full of data. */
561 write_bytes = peer->bytes_to_write < peer->write_buf_len ? peer->bytes_to_write :
564 ret = SSL_write(peer->ssl, peer->write_buf, write_bytes);
566 /* SSL_write will only succeed with a complete write. */
567 TEST_check(ret == write_bytes);
568 peer->bytes_to_write -= ret;
571 * We should perhaps check for SSL_ERROR_WANT_READ/WRITE here
572 * but this doesn't yet occur with current app data sizes.
574 peer->status = PEER_ERROR;
580 * We could simply finish when there was nothing to read, and we have
581 * nothing left to write. But keeping track of the expected number of bytes
582 * to read gives us somewhat better guarantees that all data sent is in fact
585 if (!peer->bytes_to_write && !peer->bytes_to_read) {
586 peer->status = PEER_SUCCESS;
590 static void do_reneg_setup_step(const SSL_TEST_CTX *test_ctx, PEER *peer)
595 if (peer->status == PEER_SUCCESS) {
597 * We are a client that succeeded this step previously, but the server
598 * wanted to retry. Probably there is a no_renegotiation warning alert
599 * waiting for us. Attempt to continue the handshake.
601 peer->status = PEER_RETRY;
602 do_handshake_step(peer);
606 TEST_check(peer->status == PEER_RETRY);
607 TEST_check(test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_SERVER
608 || test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_CLIENT);
610 /* Check if we are the peer that is going to initiate */
611 if ((test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_SERVER
612 && SSL_is_server(peer->ssl))
613 || (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_CLIENT
614 && !SSL_is_server(peer->ssl))) {
616 * If we already asked for a renegotiation then fall through to the
619 if (!SSL_renegotiate_pending(peer->ssl)) {
621 * If we are the client we will always attempt to resume the
622 * session. The server may or may not resume dependant on the
623 * setting of SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
625 if (SSL_is_server(peer->ssl)) {
626 ret = SSL_renegotiate(peer->ssl);
628 if (test_ctx->extra.client.reneg_ciphers != NULL) {
629 if (!SSL_set_cipher_list(peer->ssl,
630 test_ctx->extra.client.reneg_ciphers)) {
631 peer->status = PEER_ERROR;
634 ret = SSL_renegotiate(peer->ssl);
636 ret = SSL_renegotiate_abbreviated(peer->ssl);
640 peer->status = PEER_ERROR;
643 do_handshake_step(peer);
645 * If status is PEER_RETRY it means we're waiting on the peer to
646 * continue the handshake. As far as setting up the renegotiation is
647 * concerned that is a success. The next step will continue the
648 * handshake to its conclusion.
650 * If status is PEER_SUCCESS then we are the server and we have
651 * successfully sent the HelloRequest. We need to continue to wait
652 * until the handshake arrives from the client.
654 if (peer->status == PEER_RETRY)
655 peer->status = PEER_SUCCESS;
656 else if (peer->status == PEER_SUCCESS)
657 peer->status = PEER_RETRY;
663 * The SSL object is still expecting app data, even though it's going to
664 * get a handshake message. We try to read, and it should fail - after which
665 * we should be in a handshake
667 ret = SSL_read(peer->ssl, &buf, sizeof(buf));
670 * We're not actually expecting data - we're expecting a reneg to
673 peer->status = PEER_ERROR;
676 int error = SSL_get_error(peer->ssl, ret);
677 if (error != SSL_ERROR_WANT_READ) {
678 peer->status = PEER_ERROR;
681 /* If we're no in init yet then we're not done with setup yet */
682 if (!SSL_in_init(peer->ssl))
686 peer->status = PEER_SUCCESS;
693 * Note that as of TLS 1.1,
694 * failure to properly close a connection no longer requires that a
695 * session not be resumed. This is a change from TLS 1.0 to conform
696 * with widespread implementation practice.
699 * (a) OpenSSL requires that a connection be shutdown for all protocol versions.
700 * (b) We test lower versions, too.
701 * So we just implement shutdown. We do a full bidirectional shutdown so that we
702 * can compare sent and received close_notify alerts and get some test coverage
703 * for SSL_shutdown as a bonus.
705 static void do_shutdown_step(PEER *peer)
709 TEST_check(peer->status == PEER_RETRY);
710 ret = SSL_shutdown(peer->ssl);
713 peer->status = PEER_SUCCESS;
714 } else if (ret < 0) { /* On 0, we retry. */
715 int error = SSL_get_error(peer->ssl, ret);
716 /* Memory bios should never block with SSL_ERROR_WANT_WRITE. */
717 if (error != SSL_ERROR_WANT_READ)
718 peer->status = PEER_ERROR;
724 RENEG_APPLICATION_DATA,
732 static connect_phase_t next_phase(const SSL_TEST_CTX *test_ctx,
733 connect_phase_t phase)
737 if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_SERVER
738 || test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RENEG_CLIENT)
739 return RENEG_APPLICATION_DATA;
740 return APPLICATION_DATA;
741 case RENEG_APPLICATION_DATA:
744 return RENEG_HANDSHAKE;
745 case RENEG_HANDSHAKE:
746 return APPLICATION_DATA;
747 case APPLICATION_DATA:
750 return CONNECTION_DONE;
752 TEST_check(0); /* Should never call next_phase when done. */
756 static void do_connect_step(const SSL_TEST_CTX *test_ctx, PEER *peer,
757 connect_phase_t phase)
761 do_handshake_step(peer);
763 case RENEG_APPLICATION_DATA:
764 do_app_data_step(peer);
767 do_reneg_setup_step(test_ctx, peer);
769 case RENEG_HANDSHAKE:
770 do_handshake_step(peer);
772 case APPLICATION_DATA:
773 do_app_data_step(peer);
776 do_shutdown_step(peer);
784 /* Both parties succeeded. */
786 /* Client errored. */
788 /* Server errored. */
790 /* Peers are in inconsistent state. */
792 /* One or both peers not done. */
794 } handshake_status_t;
797 * Determine the handshake outcome.
798 * last_status: the status of the peer to have acted last.
799 * previous_status: the status of the peer that didn't act last.
800 * client_spoke_last: 1 if the client went last.
802 static handshake_status_t handshake_status(peer_status_t last_status,
803 peer_status_t previous_status,
804 int client_spoke_last)
806 switch (last_status) {
808 switch (previous_status) {
810 /* Both succeeded. */
811 return HANDSHAKE_SUCCESS;
813 /* Let the first peer finish. */
814 return HANDSHAKE_RETRY;
817 * Second peer succeeded despite the fact that the first peer
818 * already errored. This shouldn't happen.
820 return INTERNAL_ERROR;
825 return HANDSHAKE_RETRY;
828 switch (previous_status) {
831 * First peer succeeded but second peer errored.
832 * TODO(emilia): we should be able to continue here (with some
833 * application data?) to ensure the first peer receives the
834 * alert / close_notify.
835 * (No tests currently exercise this branch.)
837 return client_spoke_last ? CLIENT_ERROR : SERVER_ERROR;
839 /* We errored; let the peer finish. */
840 return HANDSHAKE_RETRY;
842 /* Both peers errored. Return the one that errored first. */
843 return client_spoke_last ? SERVER_ERROR : CLIENT_ERROR;
846 /* Control should never reach here. */
847 return INTERNAL_ERROR;
850 /* Convert unsigned char buf's that shouldn't contain any NUL-bytes to char. */
851 static char *dup_str(const unsigned char *in, size_t len)
858 /* Assert that the string does not contain NUL-bytes. */
859 TEST_check(OPENSSL_strnlen((const char*)(in), len) == len);
860 ret = OPENSSL_strndup((const char*)(in), len);
861 TEST_check(ret != NULL);
866 * Note that |extra| points to the correct client/server configuration
867 * within |test_ctx|. When configuring the handshake, general mode settings
868 * are taken from |test_ctx|, and client/server-specific settings should be
869 * taken from |extra|.
871 * The configuration code should never reach into |test_ctx->extra| or
872 * |test_ctx->resume_extra| directly.
874 * (We could refactor test mode settings into a substructure. This would result
875 * in cleaner argument passing but would complicate the test configuration
878 static HANDSHAKE_RESULT *do_handshake_internal(
879 SSL_CTX *server_ctx, SSL_CTX *server2_ctx, SSL_CTX *client_ctx,
880 const SSL_TEST_CTX *test_ctx, const SSL_TEST_EXTRA_CONF *extra,
881 SSL_SESSION *session_in, SSL_SESSION **session_out)
884 BIO *client_to_server, *server_to_client;
885 HANDSHAKE_EX_DATA server_ex_data, client_ex_data;
886 CTX_DATA client_ctx_data, server_ctx_data, server2_ctx_data;
887 HANDSHAKE_RESULT *ret = HANDSHAKE_RESULT_new();
888 int client_turn = 1, client_turn_count = 0;
889 connect_phase_t phase = HANDSHAKE;
890 handshake_status_t status = HANDSHAKE_RETRY;
891 const unsigned char* tick = NULL;
893 SSL_SESSION* sess = NULL;
894 const unsigned char *proto = NULL;
895 /* API dictates unsigned int rather than size_t. */
896 unsigned int proto_len = 0;
899 memset(&server_ctx_data, 0, sizeof(server_ctx_data));
900 memset(&server2_ctx_data, 0, sizeof(server2_ctx_data));
901 memset(&client_ctx_data, 0, sizeof(client_ctx_data));
902 memset(&server, 0, sizeof(server));
903 memset(&client, 0, sizeof(client));
905 configure_handshake_ctx(server_ctx, server2_ctx, client_ctx, test_ctx, extra,
906 &server_ctx_data, &server2_ctx_data, &client_ctx_data);
908 /* Setup SSL and buffers; additional configuration happens below. */
909 create_peer(&server, server_ctx);
910 create_peer(&client, client_ctx);
912 server.bytes_to_write = client.bytes_to_read = test_ctx->app_data_size;
913 client.bytes_to_write = server.bytes_to_read = test_ctx->app_data_size;
915 configure_handshake_ssl(server.ssl, client.ssl, extra);
916 if (session_in != NULL) {
917 /* In case we're testing resumption without tickets. */
918 TEST_check(SSL_CTX_add_session(server_ctx, session_in));
919 TEST_check(SSL_set_session(client.ssl, session_in));
922 memset(&server_ex_data, 0, sizeof(server_ex_data));
923 memset(&client_ex_data, 0, sizeof(client_ex_data));
925 ret->result = SSL_TEST_INTERNAL_ERROR;
927 client_to_server = BIO_new(BIO_s_mem());
928 server_to_client = BIO_new(BIO_s_mem());
930 TEST_check(client_to_server != NULL);
931 TEST_check(server_to_client != NULL);
933 /* Non-blocking bio. */
934 BIO_set_nbio(client_to_server, 1);
935 BIO_set_nbio(server_to_client, 1);
937 SSL_set_connect_state(client.ssl);
938 SSL_set_accept_state(server.ssl);
940 /* The bios are now owned by the SSL object. */
941 SSL_set_bio(client.ssl, server_to_client, client_to_server);
942 TEST_check(BIO_up_ref(server_to_client) > 0);
943 TEST_check(BIO_up_ref(client_to_server) > 0);
944 SSL_set_bio(server.ssl, client_to_server, server_to_client);
946 ex_data_idx = SSL_get_ex_new_index(0, "ex data", NULL, NULL, NULL);
947 TEST_check(ex_data_idx >= 0);
949 TEST_check(SSL_set_ex_data(server.ssl, ex_data_idx, &server_ex_data) == 1);
950 TEST_check(SSL_set_ex_data(client.ssl, ex_data_idx, &client_ex_data) == 1);
952 SSL_set_info_callback(server.ssl, &info_cb);
953 SSL_set_info_callback(client.ssl, &info_cb);
955 client.status = server.status = PEER_RETRY;
958 * Half-duplex handshake loop.
959 * Client and server speak to each other synchronously in the same process.
960 * We use non-blocking BIOs, so whenever one peer blocks for read, it
961 * returns PEER_RETRY to indicate that it's the other peer's turn to write.
962 * The handshake succeeds once both peers have succeeded. If one peer
963 * errors out, we also let the other peer retry (and presumably fail).
967 do_connect_step(test_ctx, &client, phase);
968 status = handshake_status(client.status, server.status,
969 1 /* client went last */);
971 do_connect_step(test_ctx, &server, phase);
972 status = handshake_status(server.status, client.status,
973 0 /* server went last */);
977 case HANDSHAKE_SUCCESS:
978 client_turn_count = 0;
979 phase = next_phase(test_ctx, phase);
980 if (phase == CONNECTION_DONE) {
981 ret->result = SSL_TEST_SUCCESS;
984 client.status = server.status = PEER_RETRY;
986 * For now, client starts each phase. Since each phase is
987 * started separately, we can later control this more
988 * precisely, for example, to test client-initiated and
989 * server-initiated shutdown.
995 ret->result = SSL_TEST_CLIENT_FAIL;
998 ret->result = SSL_TEST_SERVER_FAIL;
1000 case INTERNAL_ERROR:
1001 ret->result = SSL_TEST_INTERNAL_ERROR;
1003 case HANDSHAKE_RETRY:
1004 if (client_turn_count++ >= 2000) {
1006 * At this point, there's been so many PEER_RETRY in a row
1007 * that it's likely both sides are stuck waiting for a read.
1008 * It's time to give up.
1010 ret->result = SSL_TEST_INTERNAL_ERROR;
1020 ret->server_alert_sent = server_ex_data.alert_sent;
1021 ret->server_num_fatal_alerts_sent = server_ex_data.num_fatal_alerts_sent;
1022 ret->server_alert_received = client_ex_data.alert_received;
1023 ret->client_alert_sent = client_ex_data.alert_sent;
1024 ret->client_num_fatal_alerts_sent = client_ex_data.num_fatal_alerts_sent;
1025 ret->client_alert_received = server_ex_data.alert_received;
1026 ret->server_protocol = SSL_version(server.ssl);
1027 ret->client_protocol = SSL_version(client.ssl);
1028 ret->servername = server_ex_data.servername;
1029 if ((sess = SSL_get0_session(client.ssl)) != NULL)
1030 SSL_SESSION_get0_ticket(sess, &tick, &tick_len);
1031 if (tick == NULL || tick_len == 0)
1032 ret->session_ticket = SSL_TEST_SESSION_TICKET_NO;
1034 ret->session_ticket = SSL_TEST_SESSION_TICKET_YES;
1035 ret->session_ticket_do_not_call = server_ex_data.session_ticket_do_not_call;
1037 #ifndef OPENSSL_NO_NEXTPROTONEG
1038 SSL_get0_next_proto_negotiated(client.ssl, &proto, &proto_len);
1039 ret->client_npn_negotiated = dup_str(proto, proto_len);
1041 SSL_get0_next_proto_negotiated(server.ssl, &proto, &proto_len);
1042 ret->server_npn_negotiated = dup_str(proto, proto_len);
1045 SSL_get0_alpn_selected(client.ssl, &proto, &proto_len);
1046 ret->client_alpn_negotiated = dup_str(proto, proto_len);
1048 SSL_get0_alpn_selected(server.ssl, &proto, &proto_len);
1049 ret->server_alpn_negotiated = dup_str(proto, proto_len);
1051 ret->client_resumed = SSL_session_reused(client.ssl);
1052 ret->server_resumed = SSL_session_reused(server.ssl);
1054 if (session_out != NULL)
1055 *session_out = SSL_get1_session(client.ssl);
1057 if (SSL_get_server_tmp_key(client.ssl, &tmp_key)) {
1058 int nid = EVP_PKEY_id(tmp_key);
1060 #ifndef OPENSSL_NO_EC
1061 if (nid == EVP_PKEY_EC) {
1062 EC_KEY *ec = EVP_PKEY_get0_EC_KEY(tmp_key);
1063 nid = EC_GROUP_get_curve_name(EC_KEY_get0_group(ec));
1066 EVP_PKEY_free(tmp_key);
1067 ret->tmp_key_type = nid;
1070 ctx_data_free_data(&server_ctx_data);
1071 ctx_data_free_data(&server2_ctx_data);
1072 ctx_data_free_data(&client_ctx_data);
1074 peer_free_data(&server);
1075 peer_free_data(&client);
1079 HANDSHAKE_RESULT *do_handshake(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
1080 SSL_CTX *client_ctx, SSL_CTX *resume_server_ctx,
1081 SSL_CTX *resume_client_ctx,
1082 const SSL_TEST_CTX *test_ctx)
1084 HANDSHAKE_RESULT *result;
1085 SSL_SESSION *session = NULL;
1087 result = do_handshake_internal(server_ctx, server2_ctx, client_ctx,
1088 test_ctx, &test_ctx->extra,
1090 if (test_ctx->handshake_mode != SSL_TEST_HANDSHAKE_RESUME)
1093 if (result->result != SSL_TEST_SUCCESS) {
1094 result->result = SSL_TEST_FIRST_HANDSHAKE_FAILED;
1098 HANDSHAKE_RESULT_free(result);
1099 /* We don't support SNI on second handshake yet, so server2_ctx is NULL. */
1100 result = do_handshake_internal(resume_server_ctx, NULL, resume_client_ctx,
1101 test_ctx, &test_ctx->resume_extra,
1104 SSL_SESSION_free(session);