2 * Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
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
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>
19 #include "../ssl/ssl_local.h"
20 #include "internal/sockets.h"
21 #include "internal/nelem.h"
22 #include "handshake_helper.h"
25 #if !defined(OPENSSL_NO_SCTP) && !defined(OPENSSL_NO_SOCK)
26 #include <netinet/sctp.h>
29 DEFINE_STACK_OF(X509_NAME
)
31 HANDSHAKE_RESULT
*HANDSHAKE_RESULT_new(void)
33 HANDSHAKE_RESULT
*ret
;
35 TEST_ptr(ret
= OPENSSL_zalloc(sizeof(*ret
)));
39 void HANDSHAKE_RESULT_free(HANDSHAKE_RESULT
*result
)
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
);
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.
59 typedef struct handshake_ex_data_st
{
61 int num_fatal_alerts_sent
;
63 int session_ticket_do_not_call
;
64 ssl_servername_t servername
;
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
;
74 char *session_ticket_app_data
;
77 /* |ctx_data| itself is stack-allocated. */
78 static void ctx_data_free_data(CTX_DATA
*ctx_data
)
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
;
92 static int ex_data_idx
;
94 static void info_cb(const SSL
*s
, int where
, int ret
)
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
++;
105 ex_data
->alert_received
= ret
;
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.
116 static int select_server_ctx(SSL
*s
, void *arg
, int ignore
)
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
));
122 if (servername
== NULL
) {
123 ex_data
->servername
= SSL_TEST_SERVERNAME_SERVER1
;
124 return SSL_TLSEXT_ERR_NOACK
;
127 if (strcmp(servername
, "server2") == 0) {
128 SSL_CTX
*new_ctx
= (SSL_CTX
*)arg
;
129 SSL_set_SSL_CTX(s
, new_ctx
);
131 * Copy over all the SSL_CTX options - reasonable behavior
132 * allows testing of cases where the options between two
133 * contexts differ/conflict
135 SSL_clear_options(s
, 0xFFFFFFFFL
);
136 SSL_set_options(s
, SSL_CTX_get_options(new_ctx
));
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
;
144 ex_data
->servername
= SSL_TEST_SERVERNAME_SERVER1
;
145 return SSL_TLSEXT_ERR_NOACK
;
147 /* Don't set an explicit alert, to test library defaults. */
148 return SSL_TLSEXT_ERR_ALERT_FATAL
;
152 static int client_hello_select_server_ctx(SSL
*s
, void *arg
, int ignore
)
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
));
161 * The server_name extension was given too much extensibility when it
162 * was written, so parsing the normal case is a bit complex.
164 if (!SSL_client_hello_get0_ext(s
, TLSEXT_TYPE_server_name
, &p
,
168 /* Extract the length of the supplied list of names. */
171 if (len
+ 2 != remaining
)
175 * The list in practice only has a single element, so we only consider
178 if (remaining
== 0 || *p
++ != TLSEXT_NAMETYPE_host_name
)
181 /* Now we can finally pull out the byte array with the actual hostname. */
186 if (len
+ 2 > remaining
)
189 servername
= (const char *)p
;
191 if (len
== strlen("server2") && strncmp(servername
, "server2", len
) == 0) {
192 SSL_CTX
*new_ctx
= arg
;
193 SSL_set_SSL_CTX(s
, new_ctx
);
195 * Copy over all the SSL_CTX options - reasonable behavior
196 * allows testing of cases where the options between two
197 * contexts differ/conflict
199 SSL_clear_options(s
, 0xFFFFFFFFL
);
200 SSL_set_options(s
, SSL_CTX_get_options(new_ctx
));
202 ex_data
->servername
= SSL_TEST_SERVERNAME_SERVER2
;
204 } else if (len
== strlen("server1") &&
205 strncmp(servername
, "server1", len
) == 0) {
206 ex_data
->servername
= SSL_TEST_SERVERNAME_SERVER1
;
209 ex_data
->servername
= SSL_TEST_SERVERNAME_SERVER1
;
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.
221 * This behaviour is up to the application to configure; we test both
222 * configurations to ensure the state machine propagates the result
225 static int servername_ignore_cb(SSL
*s
, int *ad
, void *arg
)
227 return select_server_ctx(s
, arg
, 1);
230 static int servername_reject_cb(SSL
*s
, int *ad
, void *arg
)
232 return select_server_ctx(s
, arg
, 0);
235 static int client_hello_ignore_cb(SSL
*s
, int *al
, void *arg
)
237 if (!client_hello_select_server_ctx(s
, arg
, 1)) {
238 *al
= SSL_AD_UNRECOGNIZED_NAME
;
239 return SSL_CLIENT_HELLO_ERROR
;
241 return SSL_CLIENT_HELLO_SUCCESS
;
244 static int client_hello_reject_cb(SSL
*s
, int *al
, void *arg
)
246 if (!client_hello_select_server_ctx(s
, arg
, 0)) {
247 *al
= SSL_AD_UNRECOGNIZED_NAME
;
248 return SSL_CLIENT_HELLO_ERROR
;
250 return SSL_CLIENT_HELLO_SUCCESS
;
253 static int client_hello_nov12_cb(SSL
*s
, int *al
, void *arg
)
257 const unsigned char *p
;
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
;
264 (void)SSL_client_hello_get0_session_id(s
, &p
);
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
;
272 ret
= client_hello_select_server_ctx(s
, arg
, 0);
273 SSL_set_max_proto_version(s
, TLS1_1_VERSION
);
275 *al
= SSL_AD_UNRECOGNIZED_NAME
;
276 return SSL_CLIENT_HELLO_ERROR
;
278 return SSL_CLIENT_HELLO_SUCCESS
;
281 static unsigned char dummy_ocsp_resp_good_val
= 0xff;
282 static unsigned char dummy_ocsp_resp_bad_val
= 0xfe;
284 static int server_ocsp_cb(SSL
*s
, void *arg
)
288 resp
= OPENSSL_malloc(1);
290 return SSL_TLSEXT_ERR_ALERT_FATAL
;
292 * For the purposes of testing we just send back a dummy OCSP response
294 *resp
= *(unsigned char *)arg
;
295 if (!SSL_set_tlsext_status_ocsp_resp(s
, resp
, 1))
296 return SSL_TLSEXT_ERR_ALERT_FATAL
;
298 return SSL_TLSEXT_ERR_OK
;
301 static int client_ocsp_cb(SSL
*s
, void *arg
)
303 const unsigned char *resp
;
306 len
= SSL_get_tlsext_status_ocsp_resp(s
, &resp
);
307 if (len
!= 1 || *resp
!= dummy_ocsp_resp_good_val
)
313 static int verify_reject_cb(X509_STORE_CTX
*ctx
, void *arg
) {
314 X509_STORE_CTX_set_error(ctx
, X509_V_ERR_APPLICATION_VERIFICATION
);
318 static int verify_accept_cb(X509_STORE_CTX
*ctx
, void *arg
) {
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
)
329 static int do_not_call_session_ticket_cb(SSL
*s
, unsigned char *key_name
,
332 EVP_MAC_CTX
*hctx
, int enc
)
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;
340 /* Parse the comma-separated list into TLS format. */
341 static int parse_protos(const char *protos
, unsigned char **out
, size_t *outlen
)
343 size_t len
, i
, prefix
;
345 len
= strlen(protos
);
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)))
355 * foo => '3', 'f', 'o', 'o'
356 * foo,bar => '3', 'f', 'o', 'o', '3', 'b', 'a', 'r'
358 memcpy(*out
+ 1, protos
, len
);
363 if ((*out
)[i
] == ',') {
364 if (!TEST_int_gt(i
- 1, prefix
))
366 (*out
)[prefix
] = (unsigned char)(i
- 1 - prefix
);
371 if (!TEST_int_gt(len
, prefix
))
373 (*out
)[prefix
] = (unsigned char)(len
- prefix
);
382 #ifndef OPENSSL_NO_NEXTPROTONEG
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.
389 static int client_npn_cb(SSL
*s
, unsigned char **out
, unsigned char *outlen
,
390 const unsigned char *in
, unsigned int inlen
,
393 CTX_DATA
*ctx_data
= (CTX_DATA
*)(arg
);
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
;
404 static int server_npn_cb(SSL
*s
, const unsigned char **data
,
405 unsigned int *len
, void *arg
)
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
;
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.
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
)
424 CTX_DATA
*ctx_data
= (CTX_DATA
*)(arg
);
427 /* SSL_select_next_proto isn't const-correct... */
428 unsigned char *tmp_out
;
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.
435 ret
= SSL_select_next_proto(&tmp_out
, outlen
,
436 ctx_data
->alpn_protocols
,
437 ctx_data
->alpn_protocols_len
, in
, inlen
);
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
;
445 #ifndef OPENSSL_NO_SRP
446 static char *client_srp_cb(SSL
*s
, void *arg
)
448 CTX_DATA
*ctx_data
= (CTX_DATA
*)(arg
);
449 return OPENSSL_strdup(ctx_data
->srp_password
);
452 static int server_srp_cb(SSL
*s
, int *ad
, void *arg
)
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
;
463 return SSL_ERROR_NONE
;
465 #endif /* !OPENSSL_NO_SRP */
467 static int generate_session_ticket_cb(SSL
*s
, void *arg
)
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
;
473 if (ss
== NULL
|| app_data
== NULL
)
476 return SSL_SESSION_set1_ticket_appdata(ss
, app_data
, strlen(app_data
));
479 static int decrypt_session_ticket_cb(SSL
*s
, SSL_SESSION
*ss
,
480 const unsigned char *keyname
,
482 SSL_TICKET_STATUS 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
;
496 return SSL_TICKET_RETURN_ABORT
;
500 * Configure callbacks and other properties that can't be set directly
501 * in the server/client CONF.
503 static int configure_handshake_ctx(SSL_CTX
*server_ctx
, SSL_CTX
*server2_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
)
511 unsigned char *ticket_keys
;
512 size_t ticket_key_len
;
514 if (!TEST_int_eq(SSL_CTX_set_max_send_fragment(server_ctx
,
515 test
->max_fragment_size
), 1))
517 if (server2_ctx
!= NULL
) {
518 if (!TEST_int_eq(SSL_CTX_set_max_send_fragment(server2_ctx
,
519 test
->max_fragment_size
),
523 if (!TEST_int_eq(SSL_CTX_set_max_send_fragment(client_ctx
,
524 test
->max_fragment_size
), 1))
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
);
531 case SSL_TEST_VERIFY_REJECT_ALL
:
532 SSL_CTX_set_cert_verify_callback(client_ctx
, &verify_reject_cb
, NULL
);
534 case SSL_TEST_VERIFY_NONE
:
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
);
550 * Link the two contexts for SNI purposes.
551 * Also do ClientHello callbacks here, as setting both ClientHello and SNI
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
);
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
);
563 case SSL_TEST_SERVERNAME_CB_NONE
:
565 case SSL_TEST_SERVERNAME_CLIENT_HELLO_IGNORE_MISMATCH
:
566 SSL_CTX_set_client_hello_cb(server_ctx
, client_hello_ignore_cb
, server2_ctx
);
568 case SSL_TEST_SERVERNAME_CLIENT_HELLO_REJECT_MISMATCH
:
569 SSL_CTX_set_client_hello_cb(server_ctx
, client_hello_reject_cb
, server2_ctx
);
571 case SSL_TEST_SERVERNAME_CLIENT_HELLO_NO_V12
:
572 SSL_CTX_set_client_hello_cb(server_ctx
, client_hello_nov12_cb
, server2_ctx
);
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
));
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
590 if (server2_ctx
!= NULL
)
591 SSL_CTX_set_tlsext_ticket_key_evp_cb(server2_ctx
,
592 do_not_call_session_ticket_cb
);
594 if (extra
->server
.broken_session_ticket
) {
595 SSL_CTX_set_tlsext_ticket_key_evp_cb(server_ctx
,
596 broken_session_ticket_cb
);
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
)))
604 SSL_CTX_set_npn_advertised_cb(server_ctx
, server_npn_cb
,
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
))
613 SSL_CTX_set_npn_advertised_cb(server2_ctx
, server_npn_cb
,
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
)))
621 SSL_CTX_set_next_proto_select_cb(client_ctx
, client_npn_cb
,
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
)))
630 SSL_CTX_set_alpn_select_cb(server_ctx
, server_alpn_cb
, server_ctx_data
);
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
639 SSL_CTX_set_alpn_select_cb(server2_ctx
, server_alpn_cb
,
642 if (extra
->client
.alpn_protocols
!= NULL
) {
643 unsigned char *alpn_protos
= NULL
;
644 size_t alpn_protos_len
;
645 if (!TEST_true(parse_protos(extra
->client
.alpn_protocols
,
646 &alpn_protos
, &alpn_protos_len
))
647 /* Reversed return value convention... */
648 || !TEST_int_eq(SSL_CTX_set_alpn_protos(client_ctx
, alpn_protos
,
649 alpn_protos_len
), 0))
651 OPENSSL_free(alpn_protos
);
654 if (extra
->server
.session_ticket_app_data
!= NULL
) {
655 server_ctx_data
->session_ticket_app_data
=
656 OPENSSL_strdup(extra
->server
.session_ticket_app_data
);
657 SSL_CTX_set_session_ticket_cb(server_ctx
, generate_session_ticket_cb
,
658 decrypt_session_ticket_cb
, server_ctx_data
);
660 if (extra
->server2
.session_ticket_app_data
!= NULL
) {
661 if (!TEST_ptr(server2_ctx
))
663 server2_ctx_data
->session_ticket_app_data
=
664 OPENSSL_strdup(extra
->server2
.session_ticket_app_data
);
665 SSL_CTX_set_session_ticket_cb(server2_ctx
, NULL
,
666 decrypt_session_ticket_cb
, server2_ctx_data
);
670 * Use fixed session ticket keys so that we can decrypt a ticket created with
671 * one CTX in another CTX. Don't address server2 for the moment.
673 ticket_key_len
= SSL_CTX_set_tlsext_ticket_keys(server_ctx
, NULL
, 0);
674 if (!TEST_ptr(ticket_keys
= OPENSSL_zalloc(ticket_key_len
))
675 || !TEST_int_eq(SSL_CTX_set_tlsext_ticket_keys(server_ctx
,
677 ticket_key_len
), 1)) {
678 OPENSSL_free(ticket_keys
);
681 OPENSSL_free(ticket_keys
);
683 /* The default log list includes EC keys, so CT can't work without EC. */
684 #if !defined(OPENSSL_NO_CT) && !defined(OPENSSL_NO_EC)
685 if (!TEST_true(SSL_CTX_set_default_ctlog_list_file(client_ctx
)))
687 switch (extra
->client
.ct_validation
) {
688 case SSL_TEST_CT_VALIDATION_PERMISSIVE
:
689 if (!TEST_true(SSL_CTX_enable_ct(client_ctx
,
690 SSL_CT_VALIDATION_PERMISSIVE
)))
693 case SSL_TEST_CT_VALIDATION_STRICT
:
694 if (!TEST_true(SSL_CTX_enable_ct(client_ctx
, SSL_CT_VALIDATION_STRICT
)))
697 case SSL_TEST_CT_VALIDATION_NONE
:
701 #ifndef OPENSSL_NO_SRP
702 if (extra
->server
.srp_user
!= NULL
) {
703 SSL_CTX_set_srp_username_callback(server_ctx
, server_srp_cb
);
704 server_ctx_data
->srp_user
= OPENSSL_strdup(extra
->server
.srp_user
);
705 server_ctx_data
->srp_password
= OPENSSL_strdup(extra
->server
.srp_password
);
706 SSL_CTX_set_srp_cb_arg(server_ctx
, server_ctx_data
);
708 if (extra
->server2
.srp_user
!= NULL
) {
709 if (!TEST_ptr(server2_ctx
))
711 SSL_CTX_set_srp_username_callback(server2_ctx
, server_srp_cb
);
712 server2_ctx_data
->srp_user
= OPENSSL_strdup(extra
->server2
.srp_user
);
713 server2_ctx_data
->srp_password
= OPENSSL_strdup(extra
->server2
.srp_password
);
714 SSL_CTX_set_srp_cb_arg(server2_ctx
, server2_ctx_data
);
716 if (extra
->client
.srp_user
!= NULL
) {
717 if (!TEST_true(SSL_CTX_set_srp_username(client_ctx
,
718 extra
->client
.srp_user
)))
720 SSL_CTX_set_srp_client_pwd_callback(client_ctx
, client_srp_cb
);
721 client_ctx_data
->srp_password
= OPENSSL_strdup(extra
->client
.srp_password
);
722 SSL_CTX_set_srp_cb_arg(client_ctx
, client_ctx_data
);
724 #endif /* !OPENSSL_NO_SRP */
730 /* Configure per-SSL callbacks and other properties. */
731 static void configure_handshake_ssl(SSL
*server
, SSL
*client
,
732 const SSL_TEST_EXTRA_CONF
*extra
)
734 if (extra
->client
.servername
!= SSL_TEST_SERVERNAME_NONE
)
735 SSL_set_tlsext_host_name(client
,
736 ssl_servername_name(extra
->client
.servername
));
737 if (extra
->client
.enable_pha
)
738 SSL_set_post_handshake_auth(client
, 1);
741 /* The status for each connection phase. */
750 /* An SSL object and associated read-write buffers. */
751 typedef struct peer_st
{
753 /* Buffer lengths are int to match the SSL read/write API. */
754 unsigned char *write_buf
;
756 unsigned char *read_buf
;
760 peer_status_t status
;
763 static int create_peer(PEER
*peer
, SSL_CTX
*ctx
)
765 static const int peer_buffer_size
= 64 * 1024;
767 unsigned char *read_buf
= NULL
, *write_buf
= NULL
;
769 if (!TEST_ptr(ssl
= SSL_new(ctx
))
770 || !TEST_ptr(write_buf
= OPENSSL_zalloc(peer_buffer_size
))
771 || !TEST_ptr(read_buf
= OPENSSL_zalloc(peer_buffer_size
)))
775 peer
->write_buf
= write_buf
;
776 peer
->read_buf
= read_buf
;
777 peer
->write_buf_len
= peer
->read_buf_len
= peer_buffer_size
;
781 OPENSSL_free(write_buf
);
782 OPENSSL_free(read_buf
);
786 static void peer_free_data(PEER
*peer
)
789 OPENSSL_free(peer
->write_buf
);
790 OPENSSL_free(peer
->read_buf
);
794 * Note that we could do the handshake transparently under an SSL_write,
795 * but separating the steps is more helpful for debugging test failures.
797 static void do_handshake_step(PEER
*peer
)
799 if (!TEST_int_eq(peer
->status
, PEER_RETRY
)) {
800 peer
->status
= PEER_TEST_FAILURE
;
802 int ret
= SSL_do_handshake(peer
->ssl
);
805 peer
->status
= PEER_SUCCESS
;
806 } else if (ret
== 0) {
807 peer
->status
= PEER_ERROR
;
809 int error
= SSL_get_error(peer
->ssl
, ret
);
810 /* Memory bios should never block with SSL_ERROR_WANT_WRITE. */
811 if (error
!= SSL_ERROR_WANT_READ
)
812 peer
->status
= PEER_ERROR
;
818 * Send/receive some application data. The read-write sequence is
819 * Peer A: (R) W - first read will yield no data
826 static void do_app_data_step(PEER
*peer
)
828 int ret
= 1, write_bytes
;
830 if (!TEST_int_eq(peer
->status
, PEER_RETRY
)) {
831 peer
->status
= PEER_TEST_FAILURE
;
835 /* We read everything available... */
836 while (ret
> 0 && peer
->bytes_to_read
) {
837 ret
= SSL_read(peer
->ssl
, peer
->read_buf
, peer
->read_buf_len
);
839 if (!TEST_int_le(ret
, peer
->bytes_to_read
)) {
840 peer
->status
= PEER_TEST_FAILURE
;
843 peer
->bytes_to_read
-= ret
;
844 } else if (ret
== 0) {
845 peer
->status
= PEER_ERROR
;
848 int error
= SSL_get_error(peer
->ssl
, ret
);
849 if (error
!= SSL_ERROR_WANT_READ
) {
850 peer
->status
= PEER_ERROR
;
852 } /* Else continue with write. */
856 /* ... but we only write one write-buffer-full of data. */
857 write_bytes
= peer
->bytes_to_write
< peer
->write_buf_len
? peer
->bytes_to_write
:
860 ret
= SSL_write(peer
->ssl
, peer
->write_buf
, write_bytes
);
862 /* SSL_write will only succeed with a complete write. */
863 if (!TEST_int_eq(ret
, write_bytes
)) {
864 peer
->status
= PEER_TEST_FAILURE
;
867 peer
->bytes_to_write
-= ret
;
870 * We should perhaps check for SSL_ERROR_WANT_READ/WRITE here
871 * but this doesn't yet occur with current app data sizes.
873 peer
->status
= PEER_ERROR
;
879 * We could simply finish when there was nothing to read, and we have
880 * nothing left to write. But keeping track of the expected number of bytes
881 * to read gives us somewhat better guarantees that all data sent is in fact
884 if (peer
->bytes_to_write
== 0 && peer
->bytes_to_read
== 0) {
885 peer
->status
= PEER_SUCCESS
;
889 static void do_reneg_setup_step(const SSL_TEST_CTX
*test_ctx
, PEER
*peer
)
894 if (peer
->status
== PEER_SUCCESS
) {
896 * We are a client that succeeded this step previously, but the server
897 * wanted to retry. Probably there is a no_renegotiation warning alert
898 * waiting for us. Attempt to continue the handshake.
900 peer
->status
= PEER_RETRY
;
901 do_handshake_step(peer
);
905 if (!TEST_int_eq(peer
->status
, PEER_RETRY
)
906 || !TEST_true(test_ctx
->handshake_mode
907 == SSL_TEST_HANDSHAKE_RENEG_SERVER
908 || test_ctx
->handshake_mode
909 == SSL_TEST_HANDSHAKE_RENEG_CLIENT
910 || test_ctx
->handshake_mode
911 == SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER
912 || test_ctx
->handshake_mode
913 == SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT
914 || test_ctx
->handshake_mode
915 == SSL_TEST_HANDSHAKE_POST_HANDSHAKE_AUTH
)) {
916 peer
->status
= PEER_TEST_FAILURE
;
920 /* Reset the count of the amount of app data we need to read/write */
921 peer
->bytes_to_write
= peer
->bytes_to_read
= test_ctx
->app_data_size
;
923 /* Check if we are the peer that is going to initiate */
924 if ((test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_RENEG_SERVER
925 && SSL_is_server(peer
->ssl
))
926 || (test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_RENEG_CLIENT
927 && !SSL_is_server(peer
->ssl
))) {
929 * If we already asked for a renegotiation then fall through to the
932 if (!SSL_renegotiate_pending(peer
->ssl
)) {
934 * If we are the client we will always attempt to resume the
935 * session. The server may or may not resume dependent on the
936 * setting of SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION
938 if (SSL_is_server(peer
->ssl
)) {
939 ret
= SSL_renegotiate(peer
->ssl
);
941 if (test_ctx
->extra
.client
.reneg_ciphers
!= NULL
) {
942 if (!SSL_set_cipher_list(peer
->ssl
,
943 test_ctx
->extra
.client
.reneg_ciphers
)) {
944 peer
->status
= PEER_ERROR
;
947 ret
= SSL_renegotiate(peer
->ssl
);
949 ret
= SSL_renegotiate_abbreviated(peer
->ssl
);
953 peer
->status
= PEER_ERROR
;
956 do_handshake_step(peer
);
958 * If status is PEER_RETRY it means we're waiting on the peer to
959 * continue the handshake. As far as setting up the renegotiation is
960 * concerned that is a success. The next step will continue the
961 * handshake to its conclusion.
963 * If status is PEER_SUCCESS then we are the server and we have
964 * successfully sent the HelloRequest. We need to continue to wait
965 * until the handshake arrives from the client.
967 if (peer
->status
== PEER_RETRY
)
968 peer
->status
= PEER_SUCCESS
;
969 else if (peer
->status
== PEER_SUCCESS
)
970 peer
->status
= PEER_RETRY
;
973 } else if (test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER
974 || test_ctx
->handshake_mode
975 == SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT
) {
976 if (SSL_is_server(peer
->ssl
)
977 != (test_ctx
->handshake_mode
978 == SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER
)) {
979 peer
->status
= PEER_SUCCESS
;
983 ret
= SSL_key_update(peer
->ssl
, test_ctx
->key_update_type
);
985 peer
->status
= PEER_ERROR
;
988 do_handshake_step(peer
);
990 * This is a one step handshake. We shouldn't get anything other than
993 if (peer
->status
!= PEER_SUCCESS
)
994 peer
->status
= PEER_ERROR
;
996 } else if (test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_POST_HANDSHAKE_AUTH
) {
997 if (SSL_is_server(peer
->ssl
)) {
998 /* Make the server believe it's received the extension */
999 if (test_ctx
->extra
.server
.force_pha
)
1000 peer
->ssl
->post_handshake_auth
= SSL_PHA_EXT_RECEIVED
;
1001 ret
= SSL_verify_client_post_handshake(peer
->ssl
);
1003 peer
->status
= PEER_ERROR
;
1007 do_handshake_step(peer
);
1009 * This is a one step handshake. We shouldn't get anything other than
1012 if (peer
->status
!= PEER_SUCCESS
)
1013 peer
->status
= PEER_ERROR
;
1018 * The SSL object is still expecting app data, even though it's going to
1019 * get a handshake message. We try to read, and it should fail - after which
1020 * we should be in a handshake
1022 ret
= SSL_read(peer
->ssl
, &buf
, sizeof(buf
));
1025 * We're not actually expecting data - we're expecting a reneg to
1028 peer
->status
= PEER_ERROR
;
1031 int error
= SSL_get_error(peer
->ssl
, ret
);
1032 if (error
!= SSL_ERROR_WANT_READ
) {
1033 peer
->status
= PEER_ERROR
;
1036 /* If we're not in init yet then we're not done with setup yet */
1037 if (!SSL_in_init(peer
->ssl
))
1041 peer
->status
= PEER_SUCCESS
;
1048 * Note that as of TLS 1.1,
1049 * failure to properly close a connection no longer requires that a
1050 * session not be resumed. This is a change from TLS 1.0 to conform
1051 * with widespread implementation practice.
1054 * (a) OpenSSL requires that a connection be shutdown for all protocol versions.
1055 * (b) We test lower versions, too.
1056 * So we just implement shutdown. We do a full bidirectional shutdown so that we
1057 * can compare sent and received close_notify alerts and get some test coverage
1058 * for SSL_shutdown as a bonus.
1060 static void do_shutdown_step(PEER
*peer
)
1064 if (!TEST_int_eq(peer
->status
, PEER_RETRY
)) {
1065 peer
->status
= PEER_TEST_FAILURE
;
1068 ret
= SSL_shutdown(peer
->ssl
);
1071 peer
->status
= PEER_SUCCESS
;
1072 } else if (ret
< 0) { /* On 0, we retry. */
1073 int error
= SSL_get_error(peer
->ssl
, ret
);
1075 if (error
!= SSL_ERROR_WANT_READ
&& error
!= SSL_ERROR_WANT_WRITE
)
1076 peer
->status
= PEER_ERROR
;
1082 RENEG_APPLICATION_DATA
,
1091 static int renegotiate_op(const SSL_TEST_CTX
*test_ctx
)
1093 switch (test_ctx
->handshake_mode
) {
1094 case SSL_TEST_HANDSHAKE_RENEG_SERVER
:
1095 case SSL_TEST_HANDSHAKE_RENEG_CLIENT
:
1101 static int post_handshake_op(const SSL_TEST_CTX
*test_ctx
)
1103 switch (test_ctx
->handshake_mode
) {
1104 case SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT
:
1105 case SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER
:
1106 case SSL_TEST_HANDSHAKE_POST_HANDSHAKE_AUTH
:
1113 static connect_phase_t
next_phase(const SSL_TEST_CTX
*test_ctx
,
1114 connect_phase_t phase
)
1118 if (renegotiate_op(test_ctx
) || post_handshake_op(test_ctx
))
1119 return RENEG_APPLICATION_DATA
;
1120 return APPLICATION_DATA
;
1121 case RENEG_APPLICATION_DATA
:
1124 if (post_handshake_op(test_ctx
))
1125 return APPLICATION_DATA
;
1126 return RENEG_HANDSHAKE
;
1127 case RENEG_HANDSHAKE
:
1128 return APPLICATION_DATA
;
1129 case APPLICATION_DATA
:
1132 return CONNECTION_DONE
;
1133 case CONNECTION_DONE
:
1134 TEST_error("Trying to progress after connection done");
1140 static void do_connect_step(const SSL_TEST_CTX
*test_ctx
, PEER
*peer
,
1141 connect_phase_t phase
)
1145 do_handshake_step(peer
);
1147 case RENEG_APPLICATION_DATA
:
1148 do_app_data_step(peer
);
1151 do_reneg_setup_step(test_ctx
, peer
);
1153 case RENEG_HANDSHAKE
:
1154 do_handshake_step(peer
);
1156 case APPLICATION_DATA
:
1157 do_app_data_step(peer
);
1160 do_shutdown_step(peer
);
1162 case CONNECTION_DONE
:
1163 TEST_error("Action after connection done");
1169 /* Both parties succeeded. */
1171 /* Client errored. */
1173 /* Server errored. */
1175 /* Peers are in inconsistent state. */
1177 /* One or both peers not done. */
1179 } handshake_status_t
;
1182 * Determine the handshake outcome.
1183 * last_status: the status of the peer to have acted last.
1184 * previous_status: the status of the peer that didn't act last.
1185 * client_spoke_last: 1 if the client went last.
1187 static handshake_status_t
handshake_status(peer_status_t last_status
,
1188 peer_status_t previous_status
,
1189 int client_spoke_last
)
1191 switch (last_status
) {
1192 case PEER_TEST_FAILURE
:
1193 return INTERNAL_ERROR
;
1196 /* Shouldn't ever happen */
1197 return INTERNAL_ERROR
;
1200 switch (previous_status
) {
1201 case PEER_TEST_FAILURE
:
1202 return INTERNAL_ERROR
;
1204 /* Both succeeded. */
1205 return HANDSHAKE_SUCCESS
;
1208 /* Let the first peer finish. */
1209 return HANDSHAKE_RETRY
;
1212 * Second peer succeeded despite the fact that the first peer
1213 * already errored. This shouldn't happen.
1215 return INTERNAL_ERROR
;
1220 return HANDSHAKE_RETRY
;
1223 switch (previous_status
) {
1224 case PEER_TEST_FAILURE
:
1225 return INTERNAL_ERROR
;
1227 /* The client failed immediately before sending the ClientHello */
1228 return client_spoke_last
? CLIENT_ERROR
: INTERNAL_ERROR
;
1231 * First peer succeeded but second peer errored.
1232 * TODO(emilia): we should be able to continue here (with some
1233 * application data?) to ensure the first peer receives the
1234 * alert / close_notify.
1235 * (No tests currently exercise this branch.)
1237 return client_spoke_last
? CLIENT_ERROR
: SERVER_ERROR
;
1239 /* We errored; let the peer finish. */
1240 return HANDSHAKE_RETRY
;
1242 /* Both peers errored. Return the one that errored first. */
1243 return client_spoke_last
? SERVER_ERROR
: CLIENT_ERROR
;
1246 /* Control should never reach here. */
1247 return INTERNAL_ERROR
;
1250 /* Convert unsigned char buf's that shouldn't contain any NUL-bytes to char. */
1251 static char *dup_str(const unsigned char *in
, size_t len
)
1258 /* Assert that the string does not contain NUL-bytes. */
1259 if (TEST_size_t_eq(OPENSSL_strnlen((const char*)(in
), len
), len
))
1260 TEST_ptr(ret
= OPENSSL_strndup((const char*)(in
), len
));
1264 static int pkey_type(EVP_PKEY
*pkey
)
1266 int nid
= EVP_PKEY_id(pkey
);
1268 #ifndef OPENSSL_NO_EC
1269 if (nid
== EVP_PKEY_EC
) {
1270 const EC_KEY
*ec
= EVP_PKEY_get0_EC_KEY(pkey
);
1271 return EC_GROUP_get_curve_name(EC_KEY_get0_group(ec
));
1277 static int peer_pkey_type(SSL
*s
)
1279 X509
*x
= SSL_get_peer_certificate(s
);
1282 int nid
= pkey_type(X509_get0_pubkey(x
));
1290 #if !defined(OPENSSL_NO_SCTP) && !defined(OPENSSL_NO_SOCK)
1291 static int set_sock_as_sctp(int sock
)
1293 struct sctp_assocparams assocparams
;
1294 struct sctp_rtoinfo rto_info
;
1298 * To allow tests to fail fast (within a second or so), reduce the
1299 * retransmission timeouts and the number of retransmissions.
1301 memset(&rto_info
, 0, sizeof(struct sctp_rtoinfo
));
1302 rto_info
.srto_initial
= 100;
1303 rto_info
.srto_max
= 200;
1304 rto_info
.srto_min
= 50;
1305 (void)setsockopt(sock
, IPPROTO_SCTP
, SCTP_RTOINFO
,
1306 (const void *)&rto_info
, sizeof(struct sctp_rtoinfo
));
1307 memset(&assocparams
, 0, sizeof(struct sctp_assocparams
));
1308 assocparams
.sasoc_asocmaxrxt
= 2;
1309 (void)setsockopt(sock
, IPPROTO_SCTP
, SCTP_ASSOCINFO
,
1310 (const void *)&assocparams
,
1311 sizeof(struct sctp_assocparams
));
1314 * For SCTP we have to set various options on the socket prior to
1315 * connecting. This is done automatically by BIO_new_dgram_sctp().
1316 * We don't actually need the created BIO though so we free it again
1319 tmpbio
= BIO_new_dgram_sctp(sock
, BIO_NOCLOSE
);
1328 static int create_sctp_socks(int *ssock
, int *csock
)
1330 BIO_ADDRINFO
*res
= NULL
;
1331 const BIO_ADDRINFO
*ai
= NULL
;
1332 int lsock
= INVALID_SOCKET
, asock
= INVALID_SOCKET
;
1333 int consock
= INVALID_SOCKET
;
1337 if (BIO_sock_init() != 1)
1341 * Port is 4463. It could be anything. It will fail if it's already being
1342 * used for some other SCTP service. It seems unlikely though so we don't
1343 * worry about it here.
1345 if (!BIO_lookup_ex(NULL
, "4463", BIO_LOOKUP_SERVER
, family
, SOCK_STREAM
,
1346 IPPROTO_SCTP
, &res
))
1349 for (ai
= res
; ai
!= NULL
; ai
= BIO_ADDRINFO_next(ai
)) {
1350 family
= BIO_ADDRINFO_family(ai
);
1351 lsock
= BIO_socket(family
, SOCK_STREAM
, IPPROTO_SCTP
, 0);
1352 if (lsock
== INVALID_SOCKET
) {
1353 /* Maybe the kernel doesn't support the socket family, even if
1354 * BIO_lookup() added it in the returned result...
1359 if (!set_sock_as_sctp(lsock
)
1360 || !BIO_listen(lsock
, BIO_ADDRINFO_address(ai
),
1361 BIO_SOCK_REUSEADDR
)) {
1362 BIO_closesocket(lsock
);
1363 lsock
= INVALID_SOCKET
;
1367 /* Success, don't try any more addresses */
1371 if (lsock
== INVALID_SOCKET
)
1374 BIO_ADDRINFO_free(res
);
1377 if (!BIO_lookup_ex(NULL
, "4463", BIO_LOOKUP_CLIENT
, family
, SOCK_STREAM
,
1378 IPPROTO_SCTP
, &res
))
1381 consock
= BIO_socket(family
, SOCK_STREAM
, IPPROTO_SCTP
, 0);
1382 if (consock
== INVALID_SOCKET
)
1385 if (!set_sock_as_sctp(consock
)
1386 || !BIO_connect(consock
, BIO_ADDRINFO_address(res
), 0)
1387 || !BIO_socket_nbio(consock
, 1))
1390 asock
= BIO_accept_ex(lsock
, NULL
, BIO_SOCK_NONBLOCK
);
1391 if (asock
== INVALID_SOCKET
)
1396 consock
= asock
= INVALID_SOCKET
;
1400 BIO_ADDRINFO_free(res
);
1401 if (consock
!= INVALID_SOCKET
)
1402 BIO_closesocket(consock
);
1403 if (lsock
!= INVALID_SOCKET
)
1404 BIO_closesocket(lsock
);
1405 if (asock
!= INVALID_SOCKET
)
1406 BIO_closesocket(asock
);
1412 * Note that |extra| points to the correct client/server configuration
1413 * within |test_ctx|. When configuring the handshake, general mode settings
1414 * are taken from |test_ctx|, and client/server-specific settings should be
1415 * taken from |extra|.
1417 * The configuration code should never reach into |test_ctx->extra| or
1418 * |test_ctx->resume_extra| directly.
1420 * (We could refactor test mode settings into a substructure. This would result
1421 * in cleaner argument passing but would complicate the test configuration
1424 static HANDSHAKE_RESULT
*do_handshake_internal(
1425 SSL_CTX
*server_ctx
, SSL_CTX
*server2_ctx
, SSL_CTX
*client_ctx
,
1426 const SSL_TEST_CTX
*test_ctx
, const SSL_TEST_EXTRA_CONF
*extra
,
1427 SSL_SESSION
*session_in
, SSL_SESSION
*serv_sess_in
,
1428 SSL_SESSION
**session_out
, SSL_SESSION
**serv_sess_out
)
1430 PEER server
, client
;
1431 BIO
*client_to_server
= NULL
, *server_to_client
= NULL
;
1432 HANDSHAKE_EX_DATA server_ex_data
, client_ex_data
;
1433 CTX_DATA client_ctx_data
, server_ctx_data
, server2_ctx_data
;
1434 HANDSHAKE_RESULT
*ret
= HANDSHAKE_RESULT_new();
1435 int client_turn
= 1, client_turn_count
= 0, client_wait_count
= 0;
1436 connect_phase_t phase
= HANDSHAKE
;
1437 handshake_status_t status
= HANDSHAKE_RETRY
;
1438 const unsigned char* tick
= NULL
;
1439 size_t tick_len
= 0;
1440 const unsigned char* sess_id
= NULL
;
1441 unsigned int sess_id_len
= 0;
1442 SSL_SESSION
* sess
= NULL
;
1443 const unsigned char *proto
= NULL
;
1444 /* API dictates unsigned int rather than size_t. */
1445 unsigned int proto_len
= 0;
1447 const STACK_OF(X509_NAME
) *names
;
1454 memset(&server_ctx_data
, 0, sizeof(server_ctx_data
));
1455 memset(&server2_ctx_data
, 0, sizeof(server2_ctx_data
));
1456 memset(&client_ctx_data
, 0, sizeof(client_ctx_data
));
1457 memset(&server
, 0, sizeof(server
));
1458 memset(&client
, 0, sizeof(client
));
1459 memset(&server_ex_data
, 0, sizeof(server_ex_data
));
1460 memset(&client_ex_data
, 0, sizeof(client_ex_data
));
1462 if (!configure_handshake_ctx(server_ctx
, server2_ctx
, client_ctx
,
1463 test_ctx
, extra
, &server_ctx_data
,
1464 &server2_ctx_data
, &client_ctx_data
)) {
1465 TEST_note("configure_handshake_ctx");
1469 #if !defined(OPENSSL_NO_SCTP) && !defined(OPENSSL_NO_SOCK)
1470 if (test_ctx
->enable_client_sctp_label_bug
)
1471 SSL_CTX_set_mode(client_ctx
, SSL_MODE_DTLS_SCTP_LABEL_LENGTH_BUG
);
1472 if (test_ctx
->enable_server_sctp_label_bug
)
1473 SSL_CTX_set_mode(server_ctx
, SSL_MODE_DTLS_SCTP_LABEL_LENGTH_BUG
);
1476 /* Setup SSL and buffers; additional configuration happens below. */
1477 if (!create_peer(&server
, server_ctx
)) {
1478 TEST_note("creating server context");
1481 if (!create_peer(&client
, client_ctx
)) {
1482 TEST_note("creating client context");
1486 server
.bytes_to_write
= client
.bytes_to_read
= test_ctx
->app_data_size
;
1487 client
.bytes_to_write
= server
.bytes_to_read
= test_ctx
->app_data_size
;
1489 configure_handshake_ssl(server
.ssl
, client
.ssl
, extra
);
1490 if (session_in
!= NULL
) {
1491 SSL_SESSION_get_id(serv_sess_in
, &sess_id_len
);
1492 /* In case we're testing resumption without tickets. */
1493 if ((sess_id_len
> 0
1494 && !TEST_true(SSL_CTX_add_session(server_ctx
,
1496 || !TEST_true(SSL_set_session(client
.ssl
, session_in
)))
1501 ret
->result
= SSL_TEST_INTERNAL_ERROR
;
1503 if (test_ctx
->use_sctp
) {
1504 #if !defined(OPENSSL_NO_SCTP) && !defined(OPENSSL_NO_SOCK)
1507 if (create_sctp_socks(&ssock
, &csock
)) {
1508 client_to_server
= BIO_new_dgram_sctp(csock
, BIO_CLOSE
);
1509 server_to_client
= BIO_new_dgram_sctp(ssock
, BIO_CLOSE
);
1513 client_to_server
= BIO_new(BIO_s_mem());
1514 server_to_client
= BIO_new(BIO_s_mem());
1517 if (!TEST_ptr(client_to_server
)
1518 || !TEST_ptr(server_to_client
))
1521 /* Non-blocking bio. */
1522 BIO_set_nbio(client_to_server
, 1);
1523 BIO_set_nbio(server_to_client
, 1);
1525 SSL_set_connect_state(client
.ssl
);
1526 SSL_set_accept_state(server
.ssl
);
1528 /* The bios are now owned by the SSL object. */
1529 if (test_ctx
->use_sctp
) {
1530 SSL_set_bio(client
.ssl
, client_to_server
, client_to_server
);
1531 SSL_set_bio(server
.ssl
, server_to_client
, server_to_client
);
1533 SSL_set_bio(client
.ssl
, server_to_client
, client_to_server
);
1534 if (!TEST_int_gt(BIO_up_ref(server_to_client
), 0)
1535 || !TEST_int_gt(BIO_up_ref(client_to_server
), 0))
1537 SSL_set_bio(server
.ssl
, client_to_server
, server_to_client
);
1540 ex_data_idx
= SSL_get_ex_new_index(0, "ex data", NULL
, NULL
, NULL
);
1541 if (!TEST_int_ge(ex_data_idx
, 0)
1542 || !TEST_int_eq(SSL_set_ex_data(server
.ssl
, ex_data_idx
, &server_ex_data
), 1)
1543 || !TEST_int_eq(SSL_set_ex_data(client
.ssl
, ex_data_idx
, &client_ex_data
), 1))
1546 SSL_set_info_callback(server
.ssl
, &info_cb
);
1547 SSL_set_info_callback(client
.ssl
, &info_cb
);
1549 client
.status
= PEER_RETRY
;
1550 server
.status
= PEER_WAITING
;
1555 * Half-duplex handshake loop.
1556 * Client and server speak to each other synchronously in the same process.
1557 * We use non-blocking BIOs, so whenever one peer blocks for read, it
1558 * returns PEER_RETRY to indicate that it's the other peer's turn to write.
1559 * The handshake succeeds once both peers have succeeded. If one peer
1560 * errors out, we also let the other peer retry (and presumably fail).
1564 do_connect_step(test_ctx
, &client
, phase
);
1565 status
= handshake_status(client
.status
, server
.status
,
1566 1 /* client went last */);
1567 if (server
.status
== PEER_WAITING
)
1568 server
.status
= PEER_RETRY
;
1570 do_connect_step(test_ctx
, &server
, phase
);
1571 status
= handshake_status(server
.status
, client
.status
,
1572 0 /* server went last */);
1576 case HANDSHAKE_SUCCESS
:
1577 client_turn_count
= 0;
1578 phase
= next_phase(test_ctx
, phase
);
1579 if (phase
== CONNECTION_DONE
) {
1580 ret
->result
= SSL_TEST_SUCCESS
;
1583 client
.status
= server
.status
= PEER_RETRY
;
1585 * For now, client starts each phase. Since each phase is
1586 * started separately, we can later control this more
1587 * precisely, for example, to test client-initiated and
1588 * server-initiated shutdown.
1594 ret
->result
= SSL_TEST_CLIENT_FAIL
;
1597 ret
->result
= SSL_TEST_SERVER_FAIL
;
1599 case INTERNAL_ERROR
:
1600 ret
->result
= SSL_TEST_INTERNAL_ERROR
;
1602 case HANDSHAKE_RETRY
:
1603 if (test_ctx
->use_sctp
) {
1604 if (time(NULL
) - start
> 3) {
1606 * We've waited for too long. Give up.
1608 ret
->result
= SSL_TEST_INTERNAL_ERROR
;
1612 * With "real" sockets we only swap to processing the peer
1613 * if they are expecting to retry. Otherwise we just retry the
1614 * same endpoint again.
1616 if ((client_turn
&& server
.status
== PEER_RETRY
)
1617 || (!client_turn
&& client
.status
== PEER_RETRY
))
1620 if (client_turn_count
++ >= 2000) {
1622 * At this point, there's been so many PEER_RETRY in a row
1623 * that it's likely both sides are stuck waiting for a read.
1624 * It's time to give up.
1626 ret
->result
= SSL_TEST_INTERNAL_ERROR
;
1629 if (client_turn
&& server
.status
== PEER_SUCCESS
) {
1631 * The server may finish before the client because the
1632 * client spends some turns processing NewSessionTickets.
1634 if (client_wait_count
++ >= 2) {
1635 ret
->result
= SSL_TEST_INTERNAL_ERROR
;
1647 ret
->server_alert_sent
= server_ex_data
.alert_sent
;
1648 ret
->server_num_fatal_alerts_sent
= server_ex_data
.num_fatal_alerts_sent
;
1649 ret
->server_alert_received
= client_ex_data
.alert_received
;
1650 ret
->client_alert_sent
= client_ex_data
.alert_sent
;
1651 ret
->client_num_fatal_alerts_sent
= client_ex_data
.num_fatal_alerts_sent
;
1652 ret
->client_alert_received
= server_ex_data
.alert_received
;
1653 ret
->server_protocol
= SSL_version(server
.ssl
);
1654 ret
->client_protocol
= SSL_version(client
.ssl
);
1655 ret
->servername
= server_ex_data
.servername
;
1656 if ((sess
= SSL_get0_session(client
.ssl
)) != NULL
) {
1657 SSL_SESSION_get0_ticket(sess
, &tick
, &tick_len
);
1658 sess_id
= SSL_SESSION_get_id(sess
, &sess_id_len
);
1660 if (tick
== NULL
|| tick_len
== 0)
1661 ret
->session_ticket
= SSL_TEST_SESSION_TICKET_NO
;
1663 ret
->session_ticket
= SSL_TEST_SESSION_TICKET_YES
;
1664 ret
->compression
= (SSL_get_current_compression(client
.ssl
) == NULL
)
1665 ? SSL_TEST_COMPRESSION_NO
1666 : SSL_TEST_COMPRESSION_YES
;
1667 if (sess_id
== NULL
|| sess_id_len
== 0)
1668 ret
->session_id
= SSL_TEST_SESSION_ID_NO
;
1670 ret
->session_id
= SSL_TEST_SESSION_ID_YES
;
1671 ret
->session_ticket_do_not_call
= server_ex_data
.session_ticket_do_not_call
;
1673 #ifndef OPENSSL_NO_NEXTPROTONEG
1674 SSL_get0_next_proto_negotiated(client
.ssl
, &proto
, &proto_len
);
1675 ret
->client_npn_negotiated
= dup_str(proto
, proto_len
);
1677 SSL_get0_next_proto_negotiated(server
.ssl
, &proto
, &proto_len
);
1678 ret
->server_npn_negotiated
= dup_str(proto
, proto_len
);
1681 SSL_get0_alpn_selected(client
.ssl
, &proto
, &proto_len
);
1682 ret
->client_alpn_negotiated
= dup_str(proto
, proto_len
);
1684 SSL_get0_alpn_selected(server
.ssl
, &proto
, &proto_len
);
1685 ret
->server_alpn_negotiated
= dup_str(proto
, proto_len
);
1687 if ((sess
= SSL_get0_session(server
.ssl
)) != NULL
) {
1688 SSL_SESSION_get0_ticket_appdata(sess
, (void**)&tick
, &tick_len
);
1689 ret
->result_session_ticket_app_data
= OPENSSL_strndup((const char*)tick
, tick_len
);
1692 ret
->client_resumed
= SSL_session_reused(client
.ssl
);
1693 ret
->server_resumed
= SSL_session_reused(server
.ssl
);
1695 cipher
= SSL_CIPHER_get_name(SSL_get_current_cipher(client
.ssl
));
1696 ret
->cipher
= dup_str((const unsigned char*)cipher
, strlen(cipher
));
1698 if (session_out
!= NULL
)
1699 *session_out
= SSL_get1_session(client
.ssl
);
1700 if (serv_sess_out
!= NULL
) {
1701 SSL_SESSION
*tmp
= SSL_get_session(server
.ssl
);
1704 * We create a fresh copy that is not in the server session ctx linked
1708 *serv_sess_out
= SSL_SESSION_dup(tmp
);
1711 if (SSL_get_peer_tmp_key(client
.ssl
, &tmp_key
)) {
1712 ret
->tmp_key_type
= pkey_type(tmp_key
);
1713 EVP_PKEY_free(tmp_key
);
1716 SSL_get_peer_signature_nid(client
.ssl
, &ret
->server_sign_hash
);
1717 SSL_get_peer_signature_nid(server
.ssl
, &ret
->client_sign_hash
);
1719 SSL_get_peer_signature_type_nid(client
.ssl
, &ret
->server_sign_type
);
1720 SSL_get_peer_signature_type_nid(server
.ssl
, &ret
->client_sign_type
);
1722 names
= SSL_get0_peer_CA_list(client
.ssl
);
1724 ret
->client_ca_names
= NULL
;
1726 ret
->client_ca_names
= SSL_dup_CA_list(names
);
1728 names
= SSL_get0_peer_CA_list(server
.ssl
);
1730 ret
->server_ca_names
= NULL
;
1732 ret
->server_ca_names
= SSL_dup_CA_list(names
);
1734 ret
->server_cert_type
= peer_pkey_type(client
.ssl
);
1735 ret
->client_cert_type
= peer_pkey_type(server
.ssl
);
1737 ctx_data_free_data(&server_ctx_data
);
1738 ctx_data_free_data(&server2_ctx_data
);
1739 ctx_data_free_data(&client_ctx_data
);
1741 peer_free_data(&server
);
1742 peer_free_data(&client
);
1746 HANDSHAKE_RESULT
*do_handshake(SSL_CTX
*server_ctx
, SSL_CTX
*server2_ctx
,
1747 SSL_CTX
*client_ctx
, SSL_CTX
*resume_server_ctx
,
1748 SSL_CTX
*resume_client_ctx
,
1749 const SSL_TEST_CTX
*test_ctx
)
1751 HANDSHAKE_RESULT
*result
;
1752 SSL_SESSION
*session
= NULL
, *serv_sess
= NULL
;
1754 result
= do_handshake_internal(server_ctx
, server2_ctx
, client_ctx
,
1755 test_ctx
, &test_ctx
->extra
,
1756 NULL
, NULL
, &session
, &serv_sess
);
1758 || test_ctx
->handshake_mode
!= SSL_TEST_HANDSHAKE_RESUME
1759 || result
->result
== SSL_TEST_INTERNAL_ERROR
)
1762 if (result
->result
!= SSL_TEST_SUCCESS
) {
1763 result
->result
= SSL_TEST_FIRST_HANDSHAKE_FAILED
;
1767 HANDSHAKE_RESULT_free(result
);
1768 /* We don't support SNI on second handshake yet, so server2_ctx is NULL. */
1769 result
= do_handshake_internal(resume_server_ctx
, NULL
, resume_client_ctx
,
1770 test_ctx
, &test_ctx
->resume_extra
,
1771 session
, serv_sess
, NULL
, NULL
);
1773 SSL_SESSION_free(session
);
1774 SSL_SESSION_free(serv_sess
);