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"
20 #include "test_main_custom.h"
22 static CONF
*conf
= NULL
;
24 /* Currently the section names are of the form test-<number>, e.g. test-15. */
25 #define MAX_TESTCASE_NAME_LENGTH 100
27 static const char *print_alert(int alert
)
29 return alert
? SSL_alert_desc_string_long(alert
) : "no alert";
32 static int check_result(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
34 if (result
->result
!= test_ctx
->expected_result
) {
35 fprintf(stderr
, "ExpectedResult mismatch: expected %s, got %s.\n",
36 ssl_test_result_name(test_ctx
->expected_result
),
37 ssl_test_result_name(result
->result
));
43 static int check_alerts(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
45 if (result
->client_alert_sent
!= result
->client_alert_received
) {
46 fprintf(stderr
, "Client sent alert %s but server received %s\n.",
47 print_alert(result
->client_alert_sent
),
48 print_alert(result
->client_alert_received
));
50 * We can't bail here because the peer doesn't always get far enough
51 * to process a received alert. Specifically, in protocol version
52 * negotiation tests, we have the following scenario.
53 * Client supports TLS v1.2 only; Server supports TLS v1.1.
54 * Client proposes TLS v1.2; server responds with 1.1;
55 * Client now sends a protocol alert, using TLS v1.2 in the header.
56 * The server, however, rejects the alert because of version mismatch
57 * in the record layer; therefore, the server appears to never
63 if (result
->server_alert_sent
!= result
->server_alert_received
) {
64 fprintf(stderr
, "Server sent alert %s but client received %s\n.",
65 print_alert(result
->server_alert_sent
),
66 print_alert(result
->server_alert_received
));
70 /* Tolerate an alert if one wasn't explicitly specified in the test. */
71 if (test_ctx
->expected_client_alert
73 * The info callback alert value is computed as
74 * (s->s3->send_alert[0] << 8) | s->s3->send_alert[1]
75 * where the low byte is the alert code and the high byte is other stuff.
77 && (result
->client_alert_sent
& 0xff) != test_ctx
->expected_client_alert
) {
78 fprintf(stderr
, "ClientAlert mismatch: expected %s, got %s.\n",
79 print_alert(test_ctx
->expected_client_alert
),
80 print_alert(result
->client_alert_sent
));
84 if (test_ctx
->expected_server_alert
85 && (result
->server_alert_sent
& 0xff) != test_ctx
->expected_server_alert
) {
86 fprintf(stderr
, "ServerAlert mismatch: expected %s, got %s.\n",
87 print_alert(test_ctx
->expected_server_alert
),
88 print_alert(result
->server_alert_sent
));
92 if (result
->client_num_fatal_alerts_sent
> 1) {
93 fprintf(stderr
, "Client sent %d fatal alerts.\n",
94 result
->client_num_fatal_alerts_sent
);
97 if (result
->server_num_fatal_alerts_sent
> 1) {
98 fprintf(stderr
, "Server sent %d alerts.\n",
99 result
->server_num_fatal_alerts_sent
);
105 static int check_protocol(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
107 if (result
->client_protocol
!= result
->server_protocol
) {
108 fprintf(stderr
, "Client has protocol %s but server has %s\n.",
109 ssl_protocol_name(result
->client_protocol
),
110 ssl_protocol_name(result
->server_protocol
));
114 if (test_ctx
->expected_protocol
) {
115 if (result
->client_protocol
!= test_ctx
->expected_protocol
) {
116 fprintf(stderr
, "Protocol mismatch: expected %s, got %s.\n",
117 ssl_protocol_name(test_ctx
->expected_protocol
),
118 ssl_protocol_name(result
->client_protocol
));
125 static int check_servername(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
127 if (result
->servername
!= test_ctx
->expected_servername
) {
128 fprintf(stderr
, "Client ServerName mismatch, expected %s, got %s\n.",
129 ssl_servername_name(test_ctx
->expected_servername
),
130 ssl_servername_name(result
->servername
));
136 static int check_session_ticket(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
138 if (test_ctx
->session_ticket_expected
== SSL_TEST_SESSION_TICKET_IGNORE
)
140 if (result
->session_ticket
!= test_ctx
->session_ticket_expected
) {
141 fprintf(stderr
, "Client SessionTicketExpected mismatch, expected %s, got %s\n.",
142 ssl_session_ticket_name(test_ctx
->session_ticket_expected
),
143 ssl_session_ticket_name(result
->session_ticket
));
149 #ifndef OPENSSL_NO_NEXTPROTONEG
150 static int check_npn(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
153 ret
&= strings_equal("NPN Negotiated (client vs server)",
154 result
->client_npn_negotiated
,
155 result
->server_npn_negotiated
);
156 ret
&= strings_equal("ExpectedNPNProtocol",
157 test_ctx
->expected_npn_protocol
,
158 result
->client_npn_negotiated
);
163 static int check_alpn(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
166 ret
&= strings_equal("ALPN Negotiated (client vs server)",
167 result
->client_alpn_negotiated
,
168 result
->server_alpn_negotiated
);
169 ret
&= strings_equal("ExpectedALPNProtocol",
170 test_ctx
->expected_alpn_protocol
,
171 result
->client_alpn_negotiated
);
175 static int check_resumption(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
177 if (result
->client_resumed
!= result
->server_resumed
) {
178 fprintf(stderr
, "Resumption mismatch (client vs server): %d vs %d\n",
179 result
->client_resumed
, result
->server_resumed
);
182 if (result
->client_resumed
!= test_ctx
->resumption_expected
) {
183 fprintf(stderr
, "ResumptionExpected mismatch: %d vs %d\n",
184 test_ctx
->resumption_expected
, result
->client_resumed
);
190 static int check_nid(const char *name
, int expected_nid
, int nid
)
192 if (expected_nid
== 0 || expected_nid
== nid
)
194 fprintf(stderr
, "%s type mismatch, %s vs %s\n",
195 name
, OBJ_nid2ln(expected_nid
),
196 nid
== NID_undef
? "absent" : OBJ_nid2ln(nid
));
200 static int check_tmp_key(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
202 return check_nid("Tmp key", test_ctx
->expected_tmp_key_type
,
203 result
->tmp_key_type
);
206 static int check_server_cert_type(HANDSHAKE_RESULT
*result
,
207 SSL_TEST_CTX
*test_ctx
)
209 return check_nid("Server certificate", test_ctx
->expected_server_cert_type
,
210 result
->server_cert_type
);
213 static int check_server_sign_hash(HANDSHAKE_RESULT
*result
,
214 SSL_TEST_CTX
*test_ctx
)
216 return check_nid("Server signing hash", test_ctx
->expected_server_sign_hash
,
217 result
->server_sign_hash
);
220 static int check_client_cert_type(HANDSHAKE_RESULT
*result
,
221 SSL_TEST_CTX
*test_ctx
)
223 return check_nid("Client certificate", test_ctx
->expected_client_cert_type
,
224 result
->client_cert_type
);
227 static int check_client_sign_hash(HANDSHAKE_RESULT
*result
,
228 SSL_TEST_CTX
*test_ctx
)
230 return check_nid("Client signing hash", test_ctx
->expected_client_sign_hash
,
231 result
->client_sign_hash
);
235 * This could be further simplified by constructing an expected
236 * HANDSHAKE_RESULT, and implementing comparison methods for
239 static int check_test(HANDSHAKE_RESULT
*result
, SSL_TEST_CTX
*test_ctx
)
242 ret
&= check_result(result
, test_ctx
);
243 ret
&= check_alerts(result
, test_ctx
);
244 if (result
->result
== SSL_TEST_SUCCESS
) {
245 ret
&= check_protocol(result
, test_ctx
);
246 ret
&= check_servername(result
, test_ctx
);
247 ret
&= check_session_ticket(result
, test_ctx
);
248 ret
&= (result
->session_ticket_do_not_call
== 0);
249 #ifndef OPENSSL_NO_NEXTPROTONEG
250 ret
&= check_npn(result
, test_ctx
);
252 ret
&= check_alpn(result
, test_ctx
);
253 ret
&= check_resumption(result
, test_ctx
);
254 ret
&= check_tmp_key(result
, test_ctx
);
255 ret
&= check_server_cert_type(result
, test_ctx
);
256 ret
&= check_server_sign_hash(result
, test_ctx
);
257 ret
&= check_client_cert_type(result
, test_ctx
);
258 ret
&= check_client_sign_hash(result
, test_ctx
);
263 static int test_handshake(int idx
)
266 SSL_CTX
*server_ctx
= NULL
, *server2_ctx
= NULL
, *client_ctx
= NULL
,
267 *resume_server_ctx
= NULL
, *resume_client_ctx
= NULL
;
268 SSL_TEST_CTX
*test_ctx
= NULL
;
269 HANDSHAKE_RESULT
*result
= NULL
;
270 char test_app
[MAX_TESTCASE_NAME_LENGTH
];
272 BIO_snprintf(test_app
, sizeof(test_app
), "test-%d", idx
);
274 test_ctx
= SSL_TEST_CTX_create(conf
, test_app
);
275 if (test_ctx
== NULL
)
278 #ifndef OPENSSL_NO_DTLS
279 if (test_ctx
->method
== SSL_TEST_METHOD_DTLS
) {
280 server_ctx
= SSL_CTX_new(DTLS_server_method());
281 if (test_ctx
->extra
.server
.servername_callback
!=
282 SSL_TEST_SERVERNAME_CB_NONE
) {
283 server2_ctx
= SSL_CTX_new(DTLS_server_method());
284 TEST_check(server2_ctx
!= NULL
);
286 client_ctx
= SSL_CTX_new(DTLS_client_method());
287 if (test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_RESUME
) {
288 resume_server_ctx
= SSL_CTX_new(DTLS_server_method());
289 resume_client_ctx
= SSL_CTX_new(DTLS_client_method());
290 TEST_check(resume_server_ctx
!= NULL
);
291 TEST_check(resume_client_ctx
!= NULL
);
295 if (test_ctx
->method
== SSL_TEST_METHOD_TLS
) {
296 server_ctx
= SSL_CTX_new(TLS_server_method());
297 /* SNI on resumption isn't supported/tested yet. */
298 if (test_ctx
->extra
.server
.servername_callback
!=
299 SSL_TEST_SERVERNAME_CB_NONE
) {
300 server2_ctx
= SSL_CTX_new(TLS_server_method());
301 TEST_check(server2_ctx
!= NULL
);
303 client_ctx
= SSL_CTX_new(TLS_client_method());
305 if (test_ctx
->handshake_mode
== SSL_TEST_HANDSHAKE_RESUME
) {
306 resume_server_ctx
= SSL_CTX_new(TLS_server_method());
307 resume_client_ctx
= SSL_CTX_new(TLS_client_method());
308 TEST_check(resume_server_ctx
!= NULL
);
309 TEST_check(resume_client_ctx
!= NULL
);
313 TEST_check(server_ctx
!= NULL
);
314 TEST_check(client_ctx
!= NULL
);
316 TEST_check(CONF_modules_load(conf
, test_app
, 0) > 0);
318 if (!SSL_CTX_config(server_ctx
, "server")
319 || !SSL_CTX_config(client_ctx
, "client")) {
323 if (server2_ctx
!= NULL
&& !SSL_CTX_config(server2_ctx
, "server2"))
325 if (resume_server_ctx
!= NULL
326 && !SSL_CTX_config(resume_server_ctx
, "resume-server"))
328 if (resume_client_ctx
!= NULL
329 && !SSL_CTX_config(resume_client_ctx
, "resume-client"))
332 result
= do_handshake(server_ctx
, server2_ctx
, client_ctx
,
333 resume_server_ctx
, resume_client_ctx
, test_ctx
);
335 ret
= check_test(result
, test_ctx
);
338 CONF_modules_unload(0);
339 SSL_CTX_free(server_ctx
);
340 SSL_CTX_free(server2_ctx
);
341 SSL_CTX_free(client_ctx
);
342 SSL_CTX_free(resume_server_ctx
);
343 SSL_CTX_free(resume_client_ctx
);
344 SSL_TEST_CTX_free(test_ctx
);
345 HANDSHAKE_RESULT_free(result
);
349 int test_main(int argc
, char **argv
)
357 conf
= NCONF_new(NULL
);
358 TEST_check(conf
!= NULL
);
360 /* argv[1] should point to the test conf file */
361 TEST_check(NCONF_load(conf
, argv
[1], NULL
) > 0);
363 TEST_check(NCONF_get_number_e(conf
, NULL
, "num_tests", &num_tests
));
365 ADD_ALL_TESTS(test_handshake
, (int)(num_tests
));
366 result
= run_tests(argv
[0]);