2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL license (the "License"). You may not use
5 * this file except in compliance with the License. You can obtain a copy
6 * in the file LICENSE in the source distribution or at
7 * https://www.openssl.org/source/license.html
13 #include <openssl/conf.h>
14 #include <openssl/err.h>
15 #include <openssl/ssl.h>
17 #include "handshake_helper.h"
18 #include "ssl_test_ctx.h"
21 static CONF
*conf
= NULL
;
23 /* Currently the section names are of the form test-<number>, e.g. test-15. */
24 #define MAX_TESTCASE_NAME_LENGTH 100
26 typedef struct ssl_test_ctx_test_fixture
{
27 const char *test_case_name
;
28 char test_app
[MAX_TESTCASE_NAME_LENGTH
];
31 static SSL_TEST_FIXTURE
set_up(const char *const test_case_name
)
33 SSL_TEST_FIXTURE fixture
;
34 fixture
.test_case_name
= test_case_name
;
38 static const char *print_alert(int alert
)
40 return alert
? SSL_alert_desc_string_long(alert
) : "no alert";
43 static int check_result(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
45 if (result
->result
!= test_ctx
->expected_result
) {
46 fprintf(stderr
, "ExpectedResult mismatch: expected %s, got %s.\n",
47 ssl_test_result_name(test_ctx
->expected_result
),
48 ssl_test_result_name(result
->result
));
54 static int check_alerts(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
56 if (result
->client_alert_sent
!= result
->client_alert_received
) {
57 fprintf(stderr
, "Client sent alert %s but server received %s\n.",
58 print_alert(result
->client_alert_sent
),
59 print_alert(result
->client_alert_received
));
61 * We can't bail here because the peer doesn't always get far enough
62 * to process a received alert. Specifically, in protocol version
63 * negotiation tests, we have the following scenario.
64 * Client supports TLS v1.2 only; Server supports TLS v1.1.
65 * Client proposes TLS v1.2; server responds with 1.1;
66 * Client now sends a protocol alert, using TLS v1.2 in the header.
67 * The server, however, rejects the alert because of version mismatch
68 * in the record layer; therefore, the server appears to never
74 if (result
->server_alert_sent
!= result
->server_alert_received
) {
75 fprintf(stderr
, "Server sent alert %s but client received %s\n.",
76 print_alert(result
->server_alert_sent
),
77 print_alert(result
->server_alert_received
));
81 /* Tolerate an alert if one wasn't explicitly specified in the test. */
82 if (test_ctx
->expected_client_alert
84 * The info callback alert value is computed as
85 * (s->s3->send_alert[0] << 8) | s->s3->send_alert[1]
86 * where the low byte is the alert code and the high byte is other stuff.
88 && (result
->client_alert_sent
& 0xff) != test_ctx
->expected_client_alert
) {
89 fprintf(stderr
, "ClientAlert mismatch: expected %s, got %s.\n",
90 print_alert(test_ctx
->expected_client_alert
),
91 print_alert(result
->client_alert_sent
));
95 if (test_ctx
->expected_server_alert
96 && (result
->server_alert_sent
& 0xff) != test_ctx
->expected_server_alert
) {
97 fprintf(stderr
, "ServerAlert mismatch: expected %s, got %s.\n",
98 print_alert(test_ctx
->expected_server_alert
),
99 print_alert(result
->server_alert_sent
));
103 if (result
->client_num_fatal_alerts_sent
> 1) {
104 fprintf(stderr
, "Client sent %d fatal alerts.\n",
105 result
->client_num_fatal_alerts_sent
);
108 if (result
->server_num_fatal_alerts_sent
> 1) {
109 fprintf(stderr
, "Server sent %d alerts.\n",
110 result
->server_num_fatal_alerts_sent
);
116 static int check_protocol(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
118 if (result
->client_protocol
!= result
->server_protocol
) {
119 fprintf(stderr
, "Client has protocol %s but server has %s\n.",
120 ssl_protocol_name(result
->client_protocol
),
121 ssl_protocol_name(result
->server_protocol
));
125 if (test_ctx
->expected_protocol
) {
126 if (result
->client_protocol
!= test_ctx
->expected_protocol
) {
127 fprintf(stderr
, "Protocol mismatch: expected %s, got %s.\n",
128 ssl_protocol_name(test_ctx
->expected_protocol
),
129 ssl_protocol_name(result
->client_protocol
));
136 static int check_servername(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
138 if (result
->servername
!= test_ctx
->expected_servername
) {
139 fprintf(stderr
, "Client ServerName mismatch, expected %s, got %s\n.",
140 ssl_servername_name(test_ctx
->expected_servername
),
141 ssl_servername_name(result
->servername
));
147 static int check_session_ticket(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
149 if (test_ctx
->session_ticket_expected
== SSL_TEST_SESSION_TICKET_IGNORE
)
151 if (result
->session_ticket
!= test_ctx
->session_ticket_expected
) {
152 fprintf(stderr
, "Client SessionTicketExpected mismatch, expected %s, got %s\n.",
153 ssl_session_ticket_name(test_ctx
->session_ticket_expected
),
154 ssl_session_ticket_name(result
->session_ticket
));
160 #ifndef OPENSSL_NO_NEXTPROTONEG
161 static int check_npn(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
164 ret
&= strings_equal("NPN Negotiated (client vs server)",
165 result
->client_npn_negotiated
,
166 result
->server_npn_negotiated
);
167 ret
&= strings_equal("ExpectedNPNProtocol",
168 test_ctx
->expected_npn_protocol
,
169 result
->client_npn_negotiated
);
174 static int check_alpn(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
177 ret
&= strings_equal("ALPN Negotiated (client vs server)",
178 result
->client_alpn_negotiated
,
179 result
->server_alpn_negotiated
);
180 ret
&= strings_equal("ExpectedALPNProtocol",
181 test_ctx
->expected_alpn_protocol
,
182 result
->client_alpn_negotiated
);
186 static int check_resumption(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
188 if (result
->client_resumed
!= result
->server_resumed
) {
189 fprintf(stderr
, "Resumption mismatch (client vs server): %d vs %d\n",
190 result
->client_resumed
, result
->server_resumed
);
193 if (result
->client_resumed
!= test_ctx
->resumption_expected
) {
194 fprintf(stderr
, "ResumptionExpected mismatch: %d vs %d\n",
195 test_ctx
->resumption_expected
, result
->client_resumed
);
202 * This could be further simplified by constructing an expected
203 * HANDSHAKE_RESULT, and implementing comparison methods for
206 static int check_test(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
209 ret
&= check_result(result
, test_ctx
);
210 ret
&= check_alerts(result
, test_ctx
);
211 if (result
->result
== SSL_TEST_SUCCESS
) {
212 ret
&= check_protocol(result
, test_ctx
);
213 ret
&= check_servername(result
, test_ctx
);
214 ret
&= check_session_ticket(result
, test_ctx
);
215 ret
&= (result
->session_ticket_do_not_call
== 0);
216 #ifndef OPENSSL_NO_NEXTPROTONEG
217 ret
&= check_npn(result
, test_ctx
);
219 ret
&= check_alpn(result
, test_ctx
);
220 ret
&= check_resumption(result
, test_ctx
);
225 static int execute_test(SSL_TEST_FIXTURE fixture
)
228 SSL_CTX
*server_ctx
= NULL
, *server2_ctx
= NULL
, *client_ctx
= NULL
,
229 *resume_server_ctx
= NULL
, *resume_client_ctx
= NULL
;
230 SSL_TEST_CTX
*test_ctx
= NULL
;
231 HANDSHAKE_RESULT
*result
= NULL
;
233 test_ctx
= SSL_TEST_CTX_create(conf
, fixture
.test_app
);
234 if (test_ctx
== NULL
)
237 #ifndef OPENSSL_NO_DTLS
238 if (test_ctx
->method
== SSL_TEST_METHOD_DTLS
) {
239 server_ctx
= SSL_CTX_new(DTLS_server_method());
240 if (test_ctx
->extra
.server
.servername_callback
!=
241 SSL_TEST_SERVERNAME_CB_NONE
) {
242 server2_ctx
= SSL_CTX_new(DTLS_server_method());
243 TEST_check(server2_ctx
!= NULL
);
245 client_ctx
= SSL_CTX_new(DTLS_client_method());
246 if (test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_RESUME
) {
247 resume_server_ctx
= SSL_CTX_new(DTLS_server_method());
248 resume_client_ctx
= SSL_CTX_new(DTLS_client_method());
249 TEST_check(resume_server_ctx
!= NULL
);
250 TEST_check(resume_client_ctx
!= NULL
);
254 if (test_ctx
->method
== SSL_TEST_METHOD_TLS
) {
255 server_ctx
= SSL_CTX_new(TLS_server_method());
256 /* SNI on resumption isn't supported/tested yet. */
257 if (test_ctx
->extra
.server
.servername_callback
!=
258 SSL_TEST_SERVERNAME_CB_NONE
) {
259 server2_ctx
= SSL_CTX_new(TLS_server_method());
260 TEST_check(server2_ctx
!= NULL
);
262 client_ctx
= SSL_CTX_new(TLS_client_method());
264 if (test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_RESUME
) {
265 resume_server_ctx
= SSL_CTX_new(TLS_server_method());
266 resume_client_ctx
= SSL_CTX_new(TLS_client_method());
267 TEST_check(resume_server_ctx
!= NULL
);
268 TEST_check(resume_client_ctx
!= NULL
);
272 TEST_check(server_ctx
!= NULL
);
273 TEST_check(client_ctx
!= NULL
);
275 TEST_check(CONF_modules_load(conf
, fixture
.test_app
, 0) > 0);
277 if (!SSL_CTX_config(server_ctx
, "server")
278 || !SSL_CTX_config(client_ctx
, "client")) {
282 if (server2_ctx
!= NULL
&& !SSL_CTX_config(server2_ctx
, "server2"))
284 if (resume_server_ctx
!= NULL
285 && !SSL_CTX_config(resume_server_ctx
, "resume-server"))
287 if (resume_client_ctx
!= NULL
288 && !SSL_CTX_config(resume_client_ctx
, "resume-client"))
291 result
= do_handshake(server_ctx
, server2_ctx
, client_ctx
,
292 resume_server_ctx
, resume_client_ctx
, test_ctx
);
294 ret
= check_test(result
, test_ctx
);
297 CONF_modules_unload(0);
298 SSL_CTX_free(server_ctx
);
299 SSL_CTX_free(server2_ctx
);
300 SSL_CTX_free(client_ctx
);
301 SSL_CTX_free(resume_server_ctx
);
302 SSL_CTX_free(resume_client_ctx
);
303 SSL_TEST_CTX_free(test_ctx
);
305 ERR_print_errors_fp(stderr
);
306 HANDSHAKE_RESULT_free(result
);
310 static void tear_down(SSL_TEST_FIXTURE fixture
)
314 #define SETUP_SSL_TEST_FIXTURE() \
315 SETUP_TEST_FIXTURE(SSL_TEST_FIXTURE, set_up)
316 #define EXECUTE_SSL_TEST() \
317 EXECUTE_TEST(execute_test, tear_down)
319 static int test_handshake(int idx
)
321 SETUP_SSL_TEST_FIXTURE();
322 BIO_snprintf(fixture
.test_app
, sizeof(fixture
.test_app
),
327 int main(int argc
, char **argv
)
335 conf
= NCONF_new(NULL
);
336 TEST_check(conf
!= NULL
);
338 /* argv[1] should point to the test conf file */
339 TEST_check(NCONF_load(conf
, argv
[1], NULL
) > 0);
341 TEST_check(NCONF_get_number_e(conf
, NULL
, "num_tests", &num_tests
));
343 ADD_ALL_TESTS(test_handshake
, (int)(num_tests
));
344 result
= run_tests(argv
[0]);