handshake.c@ 105945

Last change on this file since 105945 was 105945, checked in by vboxsync, 8 months ago
openssl-3.1.7: Applied and adjusted our OpenSSL changes to 3.1.7. bugref:10757
File size: 58.9 KB

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

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/libs/openssl-3.1.7/test/helpers/handshake.c@ 105945

Download in other formats: