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
10 #ifndef HEADER_SSL_TEST_CTX_H
11 #define HEADER_SSL_TEST_CTX_H
13 #include <openssl/conf.h>
14 #include <openssl/ssl.h>
17 SSL_TEST_SUCCESS = 0, /* Default */
20 SSL_TEST_INTERNAL_ERROR,
21 /* Couldn't test resumption/renegotiation: original handshake failed. */
22 SSL_TEST_FIRST_HANDSHAKE_FAILED
26 SSL_TEST_VERIFY_NONE = 0, /* Default */
27 SSL_TEST_VERIFY_ACCEPT_ALL,
28 SSL_TEST_VERIFY_REJECT_ALL
29 } ssl_verify_callback_t;
32 SSL_TEST_SERVERNAME_NONE = 0, /* Default */
33 SSL_TEST_SERVERNAME_SERVER1,
34 SSL_TEST_SERVERNAME_SERVER2,
35 SSL_TEST_SERVERNAME_INVALID
39 SSL_TEST_SERVERNAME_CB_NONE = 0, /* Default */
40 SSL_TEST_SERVERNAME_IGNORE_MISMATCH,
41 SSL_TEST_SERVERNAME_REJECT_MISMATCH
42 } ssl_servername_callback_t;
45 SSL_TEST_SESSION_TICKET_IGNORE = 0, /* Default */
46 SSL_TEST_SESSION_TICKET_YES,
47 SSL_TEST_SESSION_TICKET_NO,
48 SSL_TEST_SESSION_TICKET_BROKEN /* Special test */
49 } ssl_session_ticket_t;
52 SSL_TEST_METHOD_TLS = 0, /* Default */
57 SSL_TEST_HANDSHAKE_SIMPLE = 0, /* Default */
58 SSL_TEST_HANDSHAKE_RESUME,
59 SSL_TEST_HANDSHAKE_RENEGOTIATE
60 } ssl_handshake_mode_t;
63 SSL_TEST_CT_VALIDATION_NONE = 0, /* Default */
64 SSL_TEST_CT_VALIDATION_PERMISSIVE,
65 SSL_TEST_CT_VALIDATION_STRICT
66 } ssl_ct_validation_t;
69 SSL_TEST_CERT_STATUS_NONE = 0, /* Default */
70 SSL_TEST_CERT_STATUS_GOOD_RESPONSE,
71 SSL_TEST_CERT_STATUS_BAD_RESPONSE
74 * Server/client settings that aren't supported by the SSL CONF library,
78 /* One of a number of predefined custom callbacks. */
79 ssl_verify_callback_t verify_callback;
80 /* One of a number of predefined server names use by the client */
81 ssl_servername_t servername;
82 /* Supported NPN and ALPN protocols. A comma-separated list. */
85 ssl_ct_validation_t ct_validation;
86 } SSL_TEST_CLIENT_CONF;
89 /* SNI callback (server-side). */
90 ssl_servername_callback_t servername_callback;
91 /* Supported NPN and ALPN protocols. A comma-separated list. */
94 /* Whether to set a broken session ticket callback. */
95 int broken_session_ticket;
96 /* Should we send a CertStatus message? */
97 ssl_cert_status_t cert_status;
98 } SSL_TEST_SERVER_CONF;
101 SSL_TEST_CLIENT_CONF client;
102 SSL_TEST_SERVER_CONF server;
103 SSL_TEST_SERVER_CONF server2;
104 } SSL_TEST_EXTRA_CONF;
108 * Global test configuration. Does not change between handshakes.
110 /* Whether the server/client CTX should use DTLS or TLS. */
111 ssl_test_method_t method;
112 /* Whether to test a resumed/renegotiated handshake. */
113 ssl_handshake_mode_t handshake_mode;
115 * How much application data to exchange (default is 256 bytes).
116 * Both peers will send |app_data_size| bytes interleaved.
119 /* Maximum send fragment size. */
120 int max_fragment_size;
123 * Extra server/client configurations. Per-handshake.
125 /* First handshake. */
126 SSL_TEST_EXTRA_CONF extra;
127 /* Resumed handshake. */
128 SSL_TEST_EXTRA_CONF resume_extra;
131 * Test expectations. These apply to the LAST handshake.
133 /* Defaults to SUCCESS. */
134 ssl_test_result_t expected_result;
135 /* Alerts. 0 if no expectation. */
136 /* See ssl.h for alert codes. */
137 /* Alert sent by the client / received by the server. */
138 int expected_client_alert;
139 /* Alert sent by the server / received by the client. */
140 int expected_server_alert;
141 /* Negotiated protocol version. 0 if no expectation. */
142 /* See ssl.h for protocol versions. */
143 int expected_protocol;
145 * The expected SNI context to use.
146 * We test server-side that the server switched to the expected context.
147 * Set by the callback upon success, so if the callback wasn't called or
148 * terminated with an alert, the servername will match with
149 * SSL_TEST_SERVERNAME_NONE.
150 * Note: in the event that the servername was accepted, the client should
151 * also receive an empty SNI extension back but we have no way of probing
152 * client-side via the API that this was the case.
154 ssl_servername_t expected_servername;
155 ssl_session_ticket_t session_ticket_expected;
156 /* The expected NPN/ALPN protocol to negotiate. */
157 char *expected_npn_protocol;
158 char *expected_alpn_protocol;
159 /* Whether the second handshake is resumed or a full handshake (boolean). */
160 int resumption_expected;
163 const char *ssl_test_result_name(ssl_test_result_t result);
164 const char *ssl_alert_name(int alert);
165 const char *ssl_protocol_name(int protocol);
166 const char *ssl_verify_callback_name(ssl_verify_callback_t verify_callback);
167 const char *ssl_servername_name(ssl_servername_t server);
168 const char *ssl_servername_callback_name(ssl_servername_callback_t
169 servername_callback);
170 const char *ssl_session_ticket_name(ssl_session_ticket_t server);
171 const char *ssl_test_method_name(ssl_test_method_t method);
172 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode);
173 const char *ssl_ct_validation_name(ssl_ct_validation_t mode);
174 const char *ssl_certstatus_name(ssl_cert_status_t cert_status);
177 * Load the test case context from |conf|.
178 * See test/README.ssltest.md for details on the conf file format.
180 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section);
182 SSL_TEST_CTX *SSL_TEST_CTX_new(void);
184 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx);
186 #endif /* HEADER_SSL_TEST_CTX_H */