2 * Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the OpenSSL licenses, (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 * https://www.openssl.org/source/license.html
8 * or in the file LICENSE in the source distribution.
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_t_name(test_ctx->expected_result),
48 ssl_test_result_t_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));
127 * This could be further simplified by constructing an expected
128 * HANDSHAKE_RESULT, and implementing comparison methods for
131 static int check_test(HANDSHAKE_RESULT result, SSL_TEST_CTX *test_ctx)
134 ret &= check_result(result, test_ctx);
135 ret &= check_alerts(result, test_ctx);
136 if (result.result == SSL_TEST_SUCCESS)
137 ret &= check_protocol(result, test_ctx);
141 static int execute_test(SSL_TEST_FIXTURE fixture)
143 /* TODO(emilia): this is confusing. Flip to return 1 on success. */
145 SSL_CTX *server_ctx = NULL, *client_ctx = NULL;
146 SSL_TEST_CTX *test_ctx = NULL;
147 HANDSHAKE_RESULT result;
149 server_ctx = SSL_CTX_new(TLS_server_method());
150 client_ctx = SSL_CTX_new(TLS_client_method());
151 OPENSSL_assert(server_ctx != NULL && client_ctx != NULL);
153 OPENSSL_assert(CONF_modules_load(conf, fixture.test_app, 0) > 0);
155 if (!SSL_CTX_config(server_ctx, "server")
156 || !SSL_CTX_config(client_ctx, "client")) {
160 test_ctx = SSL_TEST_CTX_create(conf, fixture.test_app);
161 if (test_ctx == NULL)
164 result = do_handshake(server_ctx, client_ctx);
166 if (check_test(result, test_ctx))
170 CONF_modules_unload(0);
171 SSL_CTX_free(server_ctx);
172 SSL_CTX_free(client_ctx);
173 SSL_TEST_CTX_free(test_ctx);
175 ERR_print_errors_fp(stderr);
179 static void tear_down(SSL_TEST_FIXTURE fixture)
183 #define SETUP_SSL_TEST_FIXTURE() \
184 SETUP_TEST_FIXTURE(SSL_TEST_FIXTURE, set_up)
185 #define EXECUTE_SSL_TEST() \
186 EXECUTE_TEST(execute_test, tear_down)
188 static int test_handshake(int idx)
190 SETUP_SSL_TEST_FIXTURE();
191 snprintf(fixture.test_app, sizeof(fixture.test_app),
196 int main(int argc, char **argv)
204 conf = NCONF_new(NULL);
205 OPENSSL_assert(conf != NULL);
207 /* argv[1] should point to the test conf file */
208 OPENSSL_assert(NCONF_load(conf, argv[1], NULL) > 0);
210 OPENSSL_assert(NCONF_get_number_e(conf, NULL, "num_tests", &num_tests));
212 ADD_ALL_TESTS(test_handshake, (int)(num_tests));
213 result = run_tests(argv[0]);