2 * Copyright 2016-2017 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 static const char *print_alert(int alert)
28 return alert ? SSL_alert_desc_string_long(alert) : "no alert";
31 static int check_result(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
33 if (!TEST_int_eq(result->result, test_ctx->expected_result)) {
34 TEST_info("ExpectedResult mismatch: expected %s, got %s.",
35 ssl_test_result_name(test_ctx->expected_result),
36 ssl_test_result_name(result->result));
42 static int check_alerts(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
44 if (!TEST_int_eq(result->client_alert_sent,
45 result->client_alert_received)) {
46 TEST_info("Client sent alert %s but server received %s.",
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 (!TEST_int_eq(result->server_alert_sent,
64 result->server_alert_received)) {
65 TEST_info("Server sent alert %s but client received %s.",
66 print_alert(result->server_alert_sent),
67 print_alert(result->server_alert_received));
71 /* Tolerate an alert if one wasn't explicitly specified in the test. */
72 if (test_ctx->expected_client_alert
74 * The info callback alert value is computed as
75 * (s->s3->send_alert[0] << 8) | s->s3->send_alert[1]
76 * where the low byte is the alert code and the high byte is other stuff.
78 && (result->client_alert_sent & 0xff) != test_ctx->expected_client_alert) {
79 TEST_error("ClientAlert mismatch: expected %s, got %s.",
80 print_alert(test_ctx->expected_client_alert),
81 print_alert(result->client_alert_sent));
85 if (test_ctx->expected_server_alert
86 && (result->server_alert_sent & 0xff) != test_ctx->expected_server_alert) {
87 TEST_error("ServerAlert mismatch: expected %s, got %s.",
88 print_alert(test_ctx->expected_server_alert),
89 print_alert(result->server_alert_sent));
93 if (!TEST_int_le(result->client_num_fatal_alerts_sent, 1))
95 if (!TEST_int_le(result->server_num_fatal_alerts_sent, 1))
100 static int check_protocol(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
102 if (!TEST_int_eq(result->client_protocol, result->server_protocol)) {
103 TEST_info("Client has protocol %s but server has %s.",
104 ssl_protocol_name(result->client_protocol),
105 ssl_protocol_name(result->server_protocol));
109 if (test_ctx->expected_protocol) {
110 if (!TEST_int_eq(result->client_protocol,
111 test_ctx->expected_protocol)) {
112 TEST_info("Protocol mismatch: expected %s, got %s.\n",
113 ssl_protocol_name(test_ctx->expected_protocol),
114 ssl_protocol_name(result->client_protocol));
121 static int check_servername(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
123 if (!TEST_int_eq(result->servername, test_ctx->expected_servername)) {
124 TEST_info("Client ServerName mismatch, expected %s, got %s.",
125 ssl_servername_name(test_ctx->expected_servername),
126 ssl_servername_name(result->servername));
132 static int check_session_ticket(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
134 if (test_ctx->session_ticket_expected == SSL_TEST_SESSION_TICKET_IGNORE)
136 if (!TEST_int_eq(result->session_ticket,
137 test_ctx->session_ticket_expected)) {
138 TEST_info("Client SessionTicketExpected mismatch, expected %s, got %s.",
139 ssl_session_ticket_name(test_ctx->session_ticket_expected),
140 ssl_session_ticket_name(result->session_ticket));
146 static int check_session_id(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
148 if (test_ctx->session_id_expected == SSL_TEST_SESSION_ID_IGNORE)
150 if (!TEST_int_eq(result->session_id, test_ctx->session_id_expected)) {
151 TEST_info("Client SessionIdExpected mismatch, expected %s, got %s\n.",
152 ssl_session_id_name(test_ctx->session_id_expected),
153 ssl_session_id_name(result->session_id));
159 static int check_compression(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
161 if (!TEST_int_eq(result->compression, test_ctx->compression_expected))
165 #ifndef OPENSSL_NO_NEXTPROTONEG
166 static int check_npn(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
169 if (!TEST_str_eq(result->client_npn_negotiated,
170 result->server_npn_negotiated))
172 if (!TEST_str_eq(test_ctx->expected_npn_protocol,
173 result->client_npn_negotiated))
179 static int check_alpn(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
182 if (!TEST_str_eq(result->client_alpn_negotiated,
183 result->server_alpn_negotiated))
185 if (!TEST_str_eq(test_ctx->expected_alpn_protocol,
186 result->client_alpn_negotiated))
191 static int check_resumption(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
193 if (!TEST_int_eq(result->client_resumed, result->server_resumed))
195 if (!TEST_int_eq(result->client_resumed, test_ctx->resumption_expected))
200 static int check_nid(const char *name, int expected_nid, int nid)
202 if (expected_nid == 0 || expected_nid == nid)
204 TEST_error("%s type mismatch, %s vs %s\n",
205 name, OBJ_nid2ln(expected_nid),
206 nid == NID_undef ? "absent" : OBJ_nid2ln(nid));
210 static void print_ca_names(STACK_OF(X509_NAME) *names)
214 if (names == NULL || sk_X509_NAME_num(names) == 0) {
215 TEST_note(" <empty>");
218 for (i = 0; i < sk_X509_NAME_num(names); i++) {
219 X509_NAME_print_ex(bio_err, sk_X509_NAME_value(names, i), 4,
221 BIO_puts(bio_err, "\n");
225 static int check_ca_names(const char *name,
226 STACK_OF(X509_NAME) *expected_names,
227 STACK_OF(X509_NAME) *names)
231 if (expected_names == NULL)
233 if (names == NULL || sk_X509_NAME_num(names) == 0) {
234 if (TEST_int_eq(sk_X509_NAME_num(expected_names), 0))
238 if (sk_X509_NAME_num(names) != sk_X509_NAME_num(expected_names))
240 for (i = 0; i < sk_X509_NAME_num(names); i++) {
241 if (!TEST_int_eq(X509_NAME_cmp(sk_X509_NAME_value(names, i),
242 sk_X509_NAME_value(expected_names, i)),
249 TEST_info("%s: list mismatch", name);
250 TEST_note("Expected Names:");
251 print_ca_names(expected_names);
252 TEST_note("Received Names:");
253 print_ca_names(names);
257 static int check_tmp_key(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
259 return check_nid("Tmp key", test_ctx->expected_tmp_key_type,
260 result->tmp_key_type);
263 static int check_server_cert_type(HANDSHAKE_RESULT *result,
264 SSL_TEST_CTX *test_ctx)
266 return check_nid("Server certificate", test_ctx->expected_server_cert_type,
267 result->server_cert_type);
270 static int check_server_sign_hash(HANDSHAKE_RESULT *result,
271 SSL_TEST_CTX *test_ctx)
273 return check_nid("Server signing hash", test_ctx->expected_server_sign_hash,
274 result->server_sign_hash);
277 static int check_server_sign_type(HANDSHAKE_RESULT *result,
278 SSL_TEST_CTX *test_ctx)
280 return check_nid("Server signing", test_ctx->expected_server_sign_type,
281 result->server_sign_type);
284 static int check_server_ca_names(HANDSHAKE_RESULT *result,
285 SSL_TEST_CTX *test_ctx)
287 return check_ca_names("Server CA names",
288 test_ctx->expected_server_ca_names,
289 result->server_ca_names);
292 static int check_client_cert_type(HANDSHAKE_RESULT *result,
293 SSL_TEST_CTX *test_ctx)
295 return check_nid("Client certificate", test_ctx->expected_client_cert_type,
296 result->client_cert_type);
299 static int check_client_sign_hash(HANDSHAKE_RESULT *result,
300 SSL_TEST_CTX *test_ctx)
302 return check_nid("Client signing hash", test_ctx->expected_client_sign_hash,
303 result->client_sign_hash);
306 static int check_client_sign_type(HANDSHAKE_RESULT *result,
307 SSL_TEST_CTX *test_ctx)
309 return check_nid("Client signing", test_ctx->expected_client_sign_type,
310 result->client_sign_type);
313 static int check_client_ca_names(HANDSHAKE_RESULT *result,
314 SSL_TEST_CTX *test_ctx)
316 return check_ca_names("Client CA names",
317 test_ctx->expected_client_ca_names,
318 result->client_ca_names);
321 static int check_cipher(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
323 if (test_ctx->expected_cipher == NULL)
325 if (!TEST_ptr(result->cipher))
327 if (!TEST_str_eq(test_ctx->expected_cipher,
334 * This could be further simplified by constructing an expected
335 * HANDSHAKE_RESULT, and implementing comparison methods for
338 static int check_test(HANDSHAKE_RESULT *result, SSL_TEST_CTX *test_ctx)
341 ret &= check_result(result, test_ctx);
342 ret &= check_alerts(result, test_ctx);
343 if (result->result == SSL_TEST_SUCCESS) {
344 ret &= check_protocol(result, test_ctx);
345 ret &= check_servername(result, test_ctx);
346 ret &= check_session_ticket(result, test_ctx);
347 ret &= check_compression(result, test_ctx);
348 ret &= check_session_id(result, test_ctx);
349 ret &= (result->session_ticket_do_not_call == 0);
350 #ifndef OPENSSL_NO_NEXTPROTONEG
351 ret &= check_npn(result, test_ctx);
353 ret &= check_cipher(result, test_ctx);
354 ret &= check_alpn(result, test_ctx);
355 ret &= check_resumption(result, test_ctx);
356 ret &= check_tmp_key(result, test_ctx);
357 ret &= check_server_cert_type(result, test_ctx);
358 ret &= check_server_sign_hash(result, test_ctx);
359 ret &= check_server_sign_type(result, test_ctx);
360 ret &= check_server_ca_names(result, test_ctx);
361 ret &= check_client_cert_type(result, test_ctx);
362 ret &= check_client_sign_hash(result, test_ctx);
363 ret &= check_client_sign_type(result, test_ctx);
364 ret &= check_client_ca_names(result, test_ctx);
369 static int test_handshake(int idx)
372 SSL_CTX *server_ctx = NULL, *server2_ctx = NULL, *client_ctx = NULL,
373 *resume_server_ctx = NULL, *resume_client_ctx = NULL;
374 SSL_TEST_CTX *test_ctx = NULL;
375 HANDSHAKE_RESULT *result = NULL;
376 char test_app[MAX_TESTCASE_NAME_LENGTH];
378 BIO_snprintf(test_app, sizeof(test_app), "test-%d", idx);
380 test_ctx = SSL_TEST_CTX_create(conf, test_app);
381 if (!TEST_ptr(test_ctx))
384 #ifndef OPENSSL_NO_DTLS
385 if (test_ctx->method == SSL_TEST_METHOD_DTLS) {
386 server_ctx = SSL_CTX_new(DTLS_server_method());
387 if (test_ctx->extra.server.servername_callback !=
388 SSL_TEST_SERVERNAME_CB_NONE) {
389 if (!TEST_ptr(server2_ctx = SSL_CTX_new(DTLS_server_method())))
392 client_ctx = SSL_CTX_new(DTLS_client_method());
393 if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RESUME) {
394 resume_server_ctx = SSL_CTX_new(DTLS_server_method());
395 resume_client_ctx = SSL_CTX_new(DTLS_client_method());
396 if (!TEST_ptr(resume_server_ctx)
397 || !TEST_ptr(resume_client_ctx))
402 if (test_ctx->method == SSL_TEST_METHOD_TLS) {
403 server_ctx = SSL_CTX_new(TLS_server_method());
404 /* SNI on resumption isn't supported/tested yet. */
405 if (test_ctx->extra.server.servername_callback !=
406 SSL_TEST_SERVERNAME_CB_NONE) {
407 if (!TEST_ptr(server2_ctx = SSL_CTX_new(TLS_server_method())))
410 client_ctx = SSL_CTX_new(TLS_client_method());
412 if (test_ctx->handshake_mode == SSL_TEST_HANDSHAKE_RESUME) {
413 resume_server_ctx = SSL_CTX_new(TLS_server_method());
414 resume_client_ctx = SSL_CTX_new(TLS_client_method());
415 if (!TEST_ptr(resume_server_ctx)
416 || !TEST_ptr(resume_client_ctx))
421 if (!TEST_ptr(server_ctx)
422 || !TEST_ptr(client_ctx)
423 || !TEST_int_gt(CONF_modules_load(conf, test_app, 0), 0))
426 if (!SSL_CTX_config(server_ctx, "server")
427 || !SSL_CTX_config(client_ctx, "client")) {
431 if (server2_ctx != NULL && !SSL_CTX_config(server2_ctx, "server2"))
433 if (resume_server_ctx != NULL
434 && !SSL_CTX_config(resume_server_ctx, "resume-server"))
436 if (resume_client_ctx != NULL
437 && !SSL_CTX_config(resume_client_ctx, "resume-client"))
440 result = do_handshake(server_ctx, server2_ctx, client_ctx,
441 resume_server_ctx, resume_client_ctx, test_ctx);
444 ret = check_test(result, test_ctx);
447 CONF_modules_unload(0);
448 SSL_CTX_free(server_ctx);
449 SSL_CTX_free(server2_ctx);
450 SSL_CTX_free(client_ctx);
451 SSL_CTX_free(resume_server_ctx);
452 SSL_CTX_free(resume_client_ctx);
453 SSL_TEST_CTX_free(test_ctx);
454 HANDSHAKE_RESULT_free(result);
458 int setup_tests(void)
462 if (!TEST_ptr(conf = NCONF_new(NULL))
463 /* argv[1] should point to the test conf file */
464 || !TEST_int_gt(NCONF_load(conf, test_get_argument(0), NULL), 0)
465 || !TEST_int_ne(NCONF_get_number_e(conf, NULL, "num_tests",
469 ADD_ALL_TESTS(test_handshake, (int)num_tests);
473 void cleanup_tests(void)