2 * Copyright 2016 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"
18 HANDSHAKE_RESULT *HANDSHAKE_RESULT_new()
20 HANDSHAKE_RESULT *ret;
21 ret = OPENSSL_zalloc(sizeof(*ret));
22 OPENSSL_assert(ret != NULL);
26 void HANDSHAKE_RESULT_free(HANDSHAKE_RESULT *result)
28 OPENSSL_free(result->client_npn_negotiated);
29 OPENSSL_free(result->server_npn_negotiated);
30 OPENSSL_free(result->client_alpn_negotiated);
31 OPENSSL_free(result->server_alpn_negotiated);
36 * Since there appears to be no way to extract the sent/received alert
37 * from the SSL object directly, we use the info callback and stash
38 * the result in ex_data.
40 typedef struct handshake_ex_data {
43 int session_ticket_do_not_call;
44 ssl_servername_t servername;
47 typedef struct ctx_data {
48 unsigned char *npn_protocols;
49 size_t npn_protocols_len;
50 unsigned char *alpn_protocols;
51 size_t alpn_protocols_len;
54 /* |ctx_data| itself is stack-allocated. */
55 static void ctx_data_free_data(CTX_DATA *ctx_data)
57 OPENSSL_free(ctx_data->npn_protocols);
58 ctx_data->npn_protocols = NULL;
59 OPENSSL_free(ctx_data->alpn_protocols);
60 ctx_data->alpn_protocols = NULL;
63 static int ex_data_idx;
65 static void info_cb(const SSL *s, int where, int ret)
67 if (where & SSL_CB_ALERT) {
68 HANDSHAKE_EX_DATA *ex_data =
69 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
70 if (where & SSL_CB_WRITE) {
71 ex_data->alert_sent = ret;
73 ex_data->alert_received = ret;
78 /* Select the appropriate server CTX.
79 * Returns SSL_TLSEXT_ERR_OK if a match was found.
80 * If |ignore| is 1, returns SSL_TLSEXT_ERR_NOACK on mismatch.
81 * Otherwise, returns SSL_TLSEXT_ERR_ALERT_FATAL on mismatch.
82 * An empty SNI extension also returns SSL_TSLEXT_ERR_NOACK.
84 static int select_server_ctx(SSL *s, void *arg, int ignore)
86 const char *servername = SSL_get_servername(s, TLSEXT_NAMETYPE_host_name);
87 HANDSHAKE_EX_DATA *ex_data =
88 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
90 if (servername == NULL) {
91 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
92 return SSL_TLSEXT_ERR_NOACK;
95 if (strcmp(servername, "server2") == 0) {
96 SSL_CTX *new_ctx = (SSL_CTX*)arg;
97 SSL_set_SSL_CTX(s, new_ctx);
99 * Copy over all the SSL_CTX options - reasonable behavior
100 * allows testing of cases where the options between two
101 * contexts differ/conflict
103 SSL_clear_options(s, 0xFFFFFFFFL);
104 SSL_set_options(s, SSL_CTX_get_options(new_ctx));
106 ex_data->servername = SSL_TEST_SERVERNAME_SERVER2;
107 return SSL_TLSEXT_ERR_OK;
108 } else if (strcmp(servername, "server1") == 0) {
109 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
110 return SSL_TLSEXT_ERR_OK;
112 ex_data->servername = SSL_TEST_SERVERNAME_SERVER1;
113 return SSL_TLSEXT_ERR_NOACK;
115 /* Don't set an explicit alert, to test library defaults. */
116 return SSL_TLSEXT_ERR_ALERT_FATAL;
122 * If the server understood the ClientHello extension but
123 * does not recognize the server name, the server SHOULD take one of two
124 * actions: either abort the handshake by sending a fatal-level
125 * unrecognized_name(112) alert or continue the handshake.
127 * This behaviour is up to the application to configure; we test both
128 * configurations to ensure the state machine propagates the result
131 static int servername_ignore_cb(SSL *s, int *ad, void *arg)
133 return select_server_ctx(s, arg, 1);
136 static int servername_reject_cb(SSL *s, int *ad, void *arg)
138 return select_server_ctx(s, arg, 0);
141 static int verify_reject_cb(X509_STORE_CTX *ctx, void *arg) {
142 X509_STORE_CTX_set_error(ctx, X509_V_ERR_APPLICATION_VERIFICATION);
146 static int verify_accept_cb(X509_STORE_CTX *ctx, void *arg) {
150 static int broken_session_ticket_cb(SSL *s, unsigned char *key_name, unsigned char *iv,
151 EVP_CIPHER_CTX *ctx, HMAC_CTX *hctx, int enc)
156 static int do_not_call_session_ticket_cb(SSL *s, unsigned char *key_name,
159 HMAC_CTX *hctx, int enc)
161 HANDSHAKE_EX_DATA *ex_data =
162 (HANDSHAKE_EX_DATA*)(SSL_get_ex_data(s, ex_data_idx));
163 ex_data->session_ticket_do_not_call = 1;
167 /* Parse the comma-separated list into TLS format. */
168 static void parse_protos(const char *protos, unsigned char **out, size_t *outlen)
170 size_t len, i, prefix;
172 len = strlen(protos);
174 /* Should never have reuse. */
175 OPENSSL_assert(*out == NULL);
177 /* Test values are small, so we omit length limit checks. */
178 *out = OPENSSL_malloc(len + 1);
179 OPENSSL_assert(*out != NULL);
183 * foo => '3', 'f', 'o', 'o'
184 * foo,bar => '3', 'f', 'o', 'o', '3', 'b', 'a', 'r'
186 memcpy(*out + 1, protos, len);
191 if ((*out)[i] == ',') {
192 OPENSSL_assert(i - 1 - prefix > 0);
193 (*out)[prefix] = i - 1 - prefix;
198 OPENSSL_assert(len - prefix > 0);
199 (*out)[prefix] = len - prefix;
203 * The client SHOULD select the first protocol advertised by the server that it
204 * also supports. In the event that the client doesn't support any of server's
205 * protocols, or the server doesn't advertise any, it SHOULD select the first
206 * protocol that it supports.
208 static int client_npn_cb(SSL *s, unsigned char **out, unsigned char *outlen,
209 const unsigned char *in, unsigned int inlen,
212 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
215 ret = SSL_select_next_proto(out, outlen, in, inlen,
216 ctx_data->npn_protocols,
217 ctx_data->npn_protocols_len);
218 /* Accept both OPENSSL_NPN_NEGOTIATED and OPENSSL_NPN_NO_OVERLAP. */
219 OPENSSL_assert(ret == OPENSSL_NPN_NEGOTIATED
220 || ret == OPENSSL_NPN_NO_OVERLAP);
221 return SSL_TLSEXT_ERR_OK;
224 static int server_npn_cb(SSL *s, const unsigned char **data,
225 unsigned int *len, void *arg)
227 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
228 *data = ctx_data->npn_protocols;
229 *len = ctx_data->npn_protocols_len;
230 return SSL_TLSEXT_ERR_OK;
234 * The server SHOULD select the most highly preferred protocol that it supports
235 * and that is also advertised by the client. In the event that the server
236 * supports no protocols that the client advertises, then the server SHALL
237 * respond with a fatal "no_application_protocol" alert.
239 static int server_alpn_cb(SSL *s, const unsigned char **out,
240 unsigned char *outlen, const unsigned char *in,
241 unsigned int inlen, void *arg)
243 CTX_DATA *ctx_data = (CTX_DATA*)(arg);
246 /* SSL_select_next_proto isn't const-correct... */
247 unsigned char *tmp_out;
250 * The result points either to |in| or to |ctx_data->alpn_protocols|.
251 * The callback is allowed to point to |in| or to a long-lived buffer,
252 * so we can return directly without storing a copy.
254 ret = SSL_select_next_proto(&tmp_out, outlen,
255 ctx_data->alpn_protocols,
256 ctx_data->alpn_protocols_len, in, inlen);
259 /* Unlike NPN, we don't tolerate a mismatch. */
260 return ret == OPENSSL_NPN_NEGOTIATED ? SSL_TLSEXT_ERR_OK
261 : SSL_TLSEXT_ERR_NOACK;
266 * Configure callbacks and other properties that can't be set directly
267 * in the server/client CONF.
269 static void configure_handshake_ctx(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
271 const SSL_TEST_CTX *test_ctx,
272 CTX_DATA *server_ctx_data,
273 CTX_DATA *server2_ctx_data,
274 CTX_DATA *client_ctx_data)
276 switch (test_ctx->client_verify_callback) {
277 case SSL_TEST_VERIFY_ACCEPT_ALL:
278 SSL_CTX_set_cert_verify_callback(client_ctx, &verify_accept_cb,
281 case SSL_TEST_VERIFY_REJECT_ALL:
282 SSL_CTX_set_cert_verify_callback(client_ctx, &verify_reject_cb,
289 /* link the two contexts for SNI purposes */
290 switch (test_ctx->servername_callback) {
291 case SSL_TEST_SERVERNAME_IGNORE_MISMATCH:
292 SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_ignore_cb);
293 SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
295 case SSL_TEST_SERVERNAME_REJECT_MISMATCH:
296 SSL_CTX_set_tlsext_servername_callback(server_ctx, servername_reject_cb);
297 SSL_CTX_set_tlsext_servername_arg(server_ctx, server2_ctx);
304 * The initial_ctx/session_ctx always handles the encrypt/decrypt of the
305 * session ticket. This ticket_key callback is assigned to the second
306 * session (assigned via SNI), and should never be invoked
308 if (server2_ctx != NULL)
309 SSL_CTX_set_tlsext_ticket_key_cb(server2_ctx,
310 do_not_call_session_ticket_cb);
312 if (test_ctx->session_ticket_expected == SSL_TEST_SESSION_TICKET_BROKEN) {
313 SSL_CTX_set_tlsext_ticket_key_cb(server_ctx, broken_session_ticket_cb);
316 if (test_ctx->server_npn_protocols != NULL) {
317 parse_protos(test_ctx->server_npn_protocols,
318 &server_ctx_data->npn_protocols,
319 &server_ctx_data->npn_protocols_len);
320 SSL_CTX_set_next_protos_advertised_cb(server_ctx, server_npn_cb,
323 if (test_ctx->server2_npn_protocols != NULL) {
324 parse_protos(test_ctx->server2_npn_protocols,
325 &server2_ctx_data->npn_protocols,
326 &server2_ctx_data->npn_protocols_len);
327 OPENSSL_assert(server2_ctx != NULL);
328 SSL_CTX_set_next_protos_advertised_cb(server2_ctx, server_npn_cb,
331 if (test_ctx->client_npn_protocols != NULL) {
332 parse_protos(test_ctx->client_npn_protocols,
333 &client_ctx_data->npn_protocols,
334 &client_ctx_data->npn_protocols_len);
335 SSL_CTX_set_next_proto_select_cb(client_ctx, client_npn_cb,
338 if (test_ctx->server_alpn_protocols != NULL) {
339 parse_protos(test_ctx->server_alpn_protocols,
340 &server_ctx_data->alpn_protocols,
341 &server_ctx_data->alpn_protocols_len);
342 SSL_CTX_set_alpn_select_cb(server_ctx, server_alpn_cb, server_ctx_data);
344 if (test_ctx->server2_alpn_protocols != NULL) {
345 OPENSSL_assert(server2_ctx != NULL);
346 parse_protos(test_ctx->server2_alpn_protocols,
347 &server2_ctx_data->alpn_protocols,
348 &server2_ctx_data->alpn_protocols_len);
349 SSL_CTX_set_alpn_select_cb(server2_ctx, server_alpn_cb, server2_ctx_data);
351 if (test_ctx->client_alpn_protocols != NULL) {
352 unsigned char *alpn_protos = NULL;
353 size_t alpn_protos_len;
354 parse_protos(test_ctx->client_alpn_protocols,
355 &alpn_protos, &alpn_protos_len);
356 /* Reversed return value convention... */
357 OPENSSL_assert(SSL_CTX_set_alpn_protos(client_ctx, alpn_protos,
358 alpn_protos_len) == 0);
359 OPENSSL_free(alpn_protos);
363 /* Configure per-SSL callbacks and other properties. */
364 static void configure_handshake_ssl(SSL *server, SSL *client,
365 const SSL_TEST_CTX *test_ctx)
367 if (test_ctx->servername != SSL_TEST_SERVERNAME_NONE)
368 SSL_set_tlsext_host_name(client,
369 ssl_servername_name(test_ctx->servername));
379 static peer_status_t do_handshake_step(SSL *ssl)
383 ret = SSL_do_handshake(ssl);
387 } else if (ret == 0) {
390 int error = SSL_get_error(ssl, ret);
391 /* Memory bios should never block with SSL_ERROR_WANT_WRITE. */
392 if (error == SSL_ERROR_WANT_READ)
400 /* Both parties succeeded. */
402 /* Client errored. */
404 /* Server errored. */
406 /* Peers are in inconsistent state. */
408 /* One or both peers not done. */
410 } handshake_status_t;
413 * Determine the handshake outcome.
414 * last_status: the status of the peer to have acted last.
415 * previous_status: the status of the peer that didn't act last.
416 * client_spoke_last: 1 if the client went last.
418 static handshake_status_t handshake_status(peer_status_t last_status,
419 peer_status_t previous_status,
420 int client_spoke_last)
422 switch (last_status) {
424 switch (previous_status) {
426 /* Both succeeded. */
427 return HANDSHAKE_SUCCESS;
429 /* Let the first peer finish. */
430 return HANDSHAKE_RETRY;
433 * Second peer succeeded despite the fact that the first peer
434 * already errored. This shouldn't happen.
436 return INTERNAL_ERROR;
440 if (previous_status == PEER_RETRY) {
441 /* Neither peer is done. */
442 return HANDSHAKE_RETRY;
445 * Deadlock: second peer is waiting for more input while first
446 * peer thinks they're done (no more input is coming).
448 return INTERNAL_ERROR;
451 switch (previous_status) {
454 * First peer succeeded but second peer errored.
455 * TODO(emilia): we should be able to continue here (with some
456 * application data?) to ensure the first peer receives the
457 * alert / close_notify.
459 return client_spoke_last ? CLIENT_ERROR : SERVER_ERROR;
461 /* We errored; let the peer finish. */
462 return HANDSHAKE_RETRY;
464 /* Both peers errored. Return the one that errored first. */
465 return client_spoke_last ? SERVER_ERROR : CLIENT_ERROR;
468 /* Control should never reach here. */
469 return INTERNAL_ERROR;
472 /* Convert unsigned char buf's that shouldn't contain any NUL-bytes to char. */
473 static char *dup_str(const unsigned char *in, size_t len)
480 /* Assert that the string does not contain NUL-bytes. */
481 OPENSSL_assert(OPENSSL_strnlen((const char*)(in), len) == len);
482 ret = OPENSSL_strndup((const char*)(in), len);
483 OPENSSL_assert(ret != NULL);
487 HANDSHAKE_RESULT *do_handshake(SSL_CTX *server_ctx, SSL_CTX *server2_ctx,
488 SSL_CTX *client_ctx, const SSL_TEST_CTX *test_ctx)
490 SSL *server, *client;
491 BIO *client_to_server, *server_to_client;
492 HANDSHAKE_EX_DATA server_ex_data, client_ex_data;
493 CTX_DATA client_ctx_data, server_ctx_data, server2_ctx_data;
494 HANDSHAKE_RESULT *ret = HANDSHAKE_RESULT_new();
496 peer_status_t client_status = PEER_RETRY, server_status = PEER_RETRY;
497 handshake_status_t status = HANDSHAKE_RETRY;
498 unsigned char* tick = NULL;
500 SSL_SESSION* sess = NULL;
501 const unsigned char *proto = NULL;
502 /* API dictates unsigned int rather than size_t. */
503 unsigned int proto_len = 0;
505 memset(&server_ctx_data, 0, sizeof(server_ctx_data));
506 memset(&server2_ctx_data, 0, sizeof(server2_ctx_data));
507 memset(&client_ctx_data, 0, sizeof(client_ctx_data));
509 configure_handshake_ctx(server_ctx, server2_ctx, client_ctx, test_ctx,
510 &server_ctx_data, &server2_ctx_data, &client_ctx_data);
512 server = SSL_new(server_ctx);
513 client = SSL_new(client_ctx);
514 OPENSSL_assert(server != NULL && client != NULL);
516 configure_handshake_ssl(server, client, test_ctx);
518 memset(&server_ex_data, 0, sizeof(server_ex_data));
519 memset(&client_ex_data, 0, sizeof(client_ex_data));
521 ret->result = SSL_TEST_INTERNAL_ERROR;
523 client_to_server = BIO_new(BIO_s_mem());
524 server_to_client = BIO_new(BIO_s_mem());
526 OPENSSL_assert(client_to_server != NULL && server_to_client != NULL);
528 /* Non-blocking bio. */
529 BIO_set_nbio(client_to_server, 1);
530 BIO_set_nbio(server_to_client, 1);
532 SSL_set_connect_state(client);
533 SSL_set_accept_state(server);
535 /* The bios are now owned by the SSL object. */
536 SSL_set_bio(client, server_to_client, client_to_server);
537 OPENSSL_assert(BIO_up_ref(server_to_client) > 0);
538 OPENSSL_assert(BIO_up_ref(client_to_server) > 0);
539 SSL_set_bio(server, client_to_server, server_to_client);
541 ex_data_idx = SSL_get_ex_new_index(0, "ex data", NULL, NULL, NULL);
542 OPENSSL_assert(ex_data_idx >= 0);
544 OPENSSL_assert(SSL_set_ex_data(server, ex_data_idx,
545 &server_ex_data) == 1);
546 OPENSSL_assert(SSL_set_ex_data(client, ex_data_idx,
547 &client_ex_data) == 1);
549 SSL_set_info_callback(server, &info_cb);
550 SSL_set_info_callback(client, &info_cb);
553 * Half-duplex handshake loop.
554 * Client and server speak to each other synchronously in the same process.
555 * We use non-blocking BIOs, so whenever one peer blocks for read, it
556 * returns PEER_RETRY to indicate that it's the other peer's turn to write.
557 * The handshake succeeds once both peers have succeeded. If one peer
558 * errors out, we also let the other peer retry (and presumably fail).
562 client_status = do_handshake_step(client);
563 status = handshake_status(client_status, server_status,
564 1 /* client went last */);
566 server_status = do_handshake_step(server);
567 status = handshake_status(server_status, client_status,
568 0 /* server went last */);
572 case HANDSHAKE_SUCCESS:
573 ret->result = SSL_TEST_SUCCESS;
576 ret->result = SSL_TEST_CLIENT_FAIL;
579 ret->result = SSL_TEST_SERVER_FAIL;
582 ret->result = SSL_TEST_INTERNAL_ERROR;
584 case HANDSHAKE_RETRY:
591 ret->server_alert_sent = server_ex_data.alert_sent;
592 ret->server_alert_received = client_ex_data.alert_received;
593 ret->client_alert_sent = client_ex_data.alert_sent;
594 ret->client_alert_received = server_ex_data.alert_received;
595 ret->server_protocol = SSL_version(server);
596 ret->client_protocol = SSL_version(client);
597 ret->servername = server_ex_data.servername;
598 if ((sess = SSL_get0_session(client)) != NULL)
599 SSL_SESSION_get0_ticket(sess, &tick, &tick_len);
600 if (tick == NULL || tick_len == 0)
601 ret->session_ticket = SSL_TEST_SESSION_TICKET_NO;
603 ret->session_ticket = SSL_TEST_SESSION_TICKET_YES;
604 ret->session_ticket_do_not_call = server_ex_data.session_ticket_do_not_call;
606 SSL_get0_next_proto_negotiated(client, &proto, &proto_len);
607 ret->client_npn_negotiated = dup_str(proto, proto_len);
609 SSL_get0_next_proto_negotiated(server, &proto, &proto_len);
610 ret->server_npn_negotiated = dup_str(proto, proto_len);
612 SSL_get0_alpn_selected(client, &proto, &proto_len);
613 ret->client_alpn_negotiated = dup_str(proto, proto_len);
615 SSL_get0_alpn_selected(server, &proto, &proto_len);
616 ret->server_alpn_negotiated = dup_str(proto, proto_len);
618 ctx_data_free_data(&server_ctx_data);
619 ctx_data_free_data(&server2_ctx_data);
620 ctx_data_free_data(&client_ctx_data);