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->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->client_alert) {
89 fprintf(stderr, "ClientAlert mismatch: expected %s, got %s.\n",
90 print_alert(test_ctx->client_alert),
91 print_alert(result.client_alert_sent));
95 if (test_ctx->server_alert
96 && (result.server_alert_sent & 0xff) != test_ctx->server_alert) {
97 fprintf(stderr, "ServerAlert mismatch: expected %s, got %s.\n",
98 print_alert(test_ctx->server_alert),
99 print_alert(result.server_alert_sent));
106 static int check_protocol(HANDSHAKE_RESULT result, SSL_TEST_CTX *test_ctx)
108 if (result.client_protocol != result.server_protocol) {
109 fprintf(stderr, "Client has protocol %s but server has %s\n.",
110 ssl_protocol_name(result.client_protocol),
111 ssl_protocol_name(result.server_protocol));
115 if (test_ctx->protocol) {
116 if (result.client_protocol != test_ctx->protocol) {
117 fprintf(stderr, "Protocol mismatch: expected %s, got %s.\n",
118 ssl_protocol_name(test_ctx->protocol),
119 ssl_protocol_name(result.client_protocol));
126 static int check_servername(HANDSHAKE_RESULT result, SSL_TEST_CTX *test_ctx)
128 if (test_ctx->servername != SSL_TEST_SERVERNAME_NONE
129 && result.servername != test_ctx->servername) {
130 fprintf(stderr, "Client ServerName mismatch, expected %s, got %s\n.",
131 ssl_servername_name(test_ctx->servername),
132 ssl_servername_name(result.servername));
138 static int check_session_ticket(HANDSHAKE_RESULT result, SSL_TEST_CTX *test_ctx)
140 if (test_ctx->session_ticket_expected == SSL_TEST_SESSION_TICKET_IGNORE)
142 if (test_ctx->session_ticket_expected == SSL_TEST_SESSION_TICKET_BROKEN &&
143 result.session_ticket == SSL_TEST_SESSION_TICKET_NO)
145 if (result.session_ticket != test_ctx->session_ticket_expected) {
146 fprintf(stderr, "Client SessionTicketExpected mismatch, expected %s, got %s\n.",
147 ssl_session_ticket_name(test_ctx->session_ticket_expected),
148 ssl_session_ticket_name(result.session_ticket));
155 * This could be further simplified by constructing an expected
156 * HANDSHAKE_RESULT, and implementing comparison methods for
159 static int check_test(HANDSHAKE_RESULT result, SSL_TEST_CTX *test_ctx)
162 ret &= check_result(result, test_ctx);
163 ret &= check_alerts(result, test_ctx);
164 if (result.result == SSL_TEST_SUCCESS) {
165 ret &= check_protocol(result, test_ctx);
166 ret &= check_servername(result, test_ctx);
167 ret &= check_session_ticket(result, test_ctx);
168 ret &= (result.session_ticket_do_not_call == 0);
173 static int execute_test(SSL_TEST_FIXTURE fixture)
176 SSL_CTX *server_ctx = NULL, *server2_ctx = NULL, *client_ctx = NULL;
177 SSL_TEST_CTX *test_ctx = NULL;
178 HANDSHAKE_RESULT result;
181 test_ctx = SSL_TEST_CTX_create(conf, fixture.test_app);
182 if (test_ctx == NULL)
185 /* Use ServerName to detect if we're testing SNI. */
186 server2 = (test_ctx->servername != SSL_TEST_SERVERNAME_NONE) ? "server2"
189 #ifndef OPENSSL_NO_DTLS
190 if (test_ctx->method == SSL_TEST_METHOD_DTLS) {
191 server_ctx = SSL_CTX_new(DTLS_server_method());
192 server2_ctx = SSL_CTX_new(DTLS_server_method());
193 client_ctx = SSL_CTX_new(DTLS_client_method());
196 if (test_ctx->method == SSL_TEST_METHOD_TLS) {
197 server_ctx = SSL_CTX_new(TLS_server_method());
198 server2_ctx = SSL_CTX_new(TLS_server_method());
199 client_ctx = SSL_CTX_new(TLS_client_method());
202 OPENSSL_assert(server_ctx != NULL && server2_ctx != NULL &&
205 OPENSSL_assert(CONF_modules_load(conf, fixture.test_app, 0) > 0);
207 if (!SSL_CTX_config(server_ctx, "server")
208 || !SSL_CTX_config(server2_ctx, server2)
209 || !SSL_CTX_config(client_ctx, "client")) {
213 result = do_handshake(server_ctx, server2_ctx, client_ctx, test_ctx);
215 ret = check_test(result, test_ctx);
218 CONF_modules_unload(0);
219 SSL_CTX_free(server_ctx);
220 SSL_CTX_free(server2_ctx);
221 SSL_CTX_free(client_ctx);
222 SSL_TEST_CTX_free(test_ctx);
224 ERR_print_errors_fp(stderr);
228 static void tear_down(SSL_TEST_FIXTURE fixture)
232 #define SETUP_SSL_TEST_FIXTURE() \
233 SETUP_TEST_FIXTURE(SSL_TEST_FIXTURE, set_up)
234 #define EXECUTE_SSL_TEST() \
235 EXECUTE_TEST(execute_test, tear_down)
237 static int test_handshake(int idx)
239 SETUP_SSL_TEST_FIXTURE();
240 BIO_snprintf(fixture.test_app, sizeof(fixture.test_app),
245 int main(int argc, char **argv)
253 conf = NCONF_new(NULL);
254 OPENSSL_assert(conf != NULL);
256 /* argv[1] should point to the test conf file */
257 OPENSSL_assert(NCONF_load(conf, argv[1], NULL) > 0);
259 OPENSSL_assert(NCONF_get_number_e(conf, NULL, "num_tests", &num_tests));
261 ADD_ALL_TESTS(test_handshake, (int)(num_tests));
262 result = run_tests(argv[0]);