handshake.c@ 100111

Last change on this file since 100111 was 99366, checked in by vboxsync, 21 months ago
openssl-3.1.0: Applied and adjusted our OpenSSL changes to 3.0.7. bugref:10418
File size: 58.8 KB

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

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

source: vbox/trunk/src/libs/openssl-3.1.0/test/helpers/handshake.c@ 100111

Download in other formats: