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_TEST_SERVERNAME_CLIENT_HELLO_IGNORE_MISMATCH,
43 SSL_TEST_SERVERNAME_CLIENT_HELLO_REJECT_MISMATCH,
44 SSL_TEST_SERVERNAME_CLIENT_HELLO_NO_V12
45 } ssl_servername_callback_t;
48 SSL_TEST_SESSION_TICKET_IGNORE = 0, /* Default */
49 SSL_TEST_SESSION_TICKET_YES,
50 SSL_TEST_SESSION_TICKET_NO,
51 SSL_TEST_SESSION_TICKET_BROKEN /* Special test */
52 } ssl_session_ticket_t;
55 SSL_TEST_COMPRESSION_NO = 0, /* Default */
56 SSL_TEST_COMPRESSION_YES
60 SSL_TEST_SESSION_ID_IGNORE = 0, /* Default */
61 SSL_TEST_SESSION_ID_YES,
62 SSL_TEST_SESSION_ID_NO
66 SSL_TEST_METHOD_TLS = 0, /* Default */
71 SSL_TEST_HANDSHAKE_SIMPLE = 0, /* Default */
72 SSL_TEST_HANDSHAKE_RESUME,
73 SSL_TEST_HANDSHAKE_RENEG_SERVER,
74 SSL_TEST_HANDSHAKE_RENEG_CLIENT,
75 SSL_TEST_HANDSHAKE_KEY_UPDATE_SERVER,
76 SSL_TEST_HANDSHAKE_KEY_UPDATE_CLIENT
77 } ssl_handshake_mode_t;
80 SSL_TEST_CT_VALIDATION_NONE = 0, /* Default */
81 SSL_TEST_CT_VALIDATION_PERMISSIVE,
82 SSL_TEST_CT_VALIDATION_STRICT
83 } ssl_ct_validation_t;
86 SSL_TEST_CERT_STATUS_NONE = 0, /* Default */
87 SSL_TEST_CERT_STATUS_GOOD_RESPONSE,
88 SSL_TEST_CERT_STATUS_BAD_RESPONSE
92 * Server/client settings that aren't supported by the SSL CONF library,
96 /* One of a number of predefined custom callbacks. */
97 ssl_verify_callback_t verify_callback;
98 /* One of a number of predefined server names use by the client */
99 ssl_servername_t servername;
100 /* Maximum Fragment Length extension mode */
101 int max_fragment_len_mode;
102 /* Supported NPN and ALPN protocols. A comma-separated list. */
104 char *alpn_protocols;
105 ssl_ct_validation_t ct_validation;
106 /* Ciphersuites to set on a renegotiation */
110 } SSL_TEST_CLIENT_CONF;
113 /* SNI callback (server-side). */
114 ssl_servername_callback_t servername_callback;
115 /* Supported NPN and ALPN protocols. A comma-separated list. */
117 char *alpn_protocols;
118 /* Whether to set a broken session ticket callback. */
119 int broken_session_ticket;
120 /* Should we send a CertStatus message? */
121 ssl_cert_status_t cert_status;
122 /* An SRP user known to the server. */
125 } SSL_TEST_SERVER_CONF;
128 SSL_TEST_CLIENT_CONF client;
129 SSL_TEST_SERVER_CONF server;
130 SSL_TEST_SERVER_CONF server2;
131 } SSL_TEST_EXTRA_CONF;
135 * Global test configuration. Does not change between handshakes.
137 /* Whether the server/client CTX should use DTLS or TLS. */
138 ssl_test_method_t method;
139 /* Whether to test a resumed/renegotiated handshake. */
140 ssl_handshake_mode_t handshake_mode;
142 * How much application data to exchange (default is 256 bytes).
143 * Both peers will send |app_data_size| bytes interleaved.
146 /* Maximum send fragment size. */
147 int max_fragment_size;
152 * Extra server/client configurations. Per-handshake.
154 /* First handshake. */
155 SSL_TEST_EXTRA_CONF extra;
156 /* Resumed handshake. */
157 SSL_TEST_EXTRA_CONF resume_extra;
160 * Test expectations. These apply to the LAST handshake.
162 /* Defaults to SUCCESS. */
163 ssl_test_result_t expected_result;
164 /* Alerts. 0 if no expectation. */
165 /* See ssl.h for alert codes. */
166 /* Alert sent by the client / received by the server. */
167 int expected_client_alert;
168 /* Alert sent by the server / received by the client. */
169 int expected_server_alert;
170 /* Negotiated protocol version. 0 if no expectation. */
171 /* See ssl.h for protocol versions. */
172 int expected_protocol;
174 * The expected SNI context to use.
175 * We test server-side that the server switched to the expected context.
176 * Set by the callback upon success, so if the callback wasn't called or
177 * terminated with an alert, the servername will match with
178 * SSL_TEST_SERVERNAME_NONE.
179 * Note: in the event that the servername was accepted, the client should
180 * also receive an empty SNI extension back but we have no way of probing
181 * client-side via the API that this was the case.
183 ssl_servername_t expected_servername;
184 ssl_session_ticket_t session_ticket_expected;
185 int compression_expected;
186 /* The expected NPN/ALPN protocol to negotiate. */
187 char *expected_npn_protocol;
188 char *expected_alpn_protocol;
189 /* Whether the second handshake is resumed or a full handshake (boolean). */
190 int resumption_expected;
191 /* Expected temporary key type */
192 int expected_tmp_key_type;
193 /* Expected server certificate key type */
194 int expected_server_cert_type;
195 /* Expected server signing hash */
196 int expected_server_sign_hash;
197 /* Expected server signature type */
198 int expected_server_sign_type;
199 /* Expected server CA names */
200 STACK_OF(X509_NAME) *expected_server_ca_names;
201 /* Expected client certificate key type */
202 int expected_client_cert_type;
203 /* Expected client signing hash */
204 int expected_client_sign_hash;
205 /* Expected client signature type */
206 int expected_client_sign_type;
207 /* Expected CA names for client auth */
208 STACK_OF(X509_NAME) *expected_client_ca_names;
209 /* Whether to use SCTP for the transport */
211 /* Whether to expect a session id from the server */
212 ssl_session_id_t session_id_expected;
213 char *expected_cipher;
216 const char *ssl_test_result_name(ssl_test_result_t result);
217 const char *ssl_alert_name(int alert);
218 const char *ssl_protocol_name(int protocol);
219 const char *ssl_verify_callback_name(ssl_verify_callback_t verify_callback);
220 const char *ssl_servername_name(ssl_servername_t server);
221 const char *ssl_servername_callback_name(ssl_servername_callback_t
222 servername_callback);
223 const char *ssl_session_ticket_name(ssl_session_ticket_t server);
224 const char *ssl_session_id_name(ssl_session_id_t server);
225 const char *ssl_test_method_name(ssl_test_method_t method);
226 const char *ssl_handshake_mode_name(ssl_handshake_mode_t mode);
227 const char *ssl_ct_validation_name(ssl_ct_validation_t mode);
228 const char *ssl_certstatus_name(ssl_cert_status_t cert_status);
229 const char *ssl_max_fragment_len_name(int MFL_mode);
232 * Load the test case context from |conf|.
233 * See test/README.ssltest.md for details on the conf file format.
235 SSL_TEST_CTX *SSL_TEST_CTX_create(const CONF *conf, const char *test_section);
237 SSL_TEST_CTX *SSL_TEST_CTX_new(void);
239 void SSL_TEST_CTX_free(SSL_TEST_CTX *ctx);
241 #endif /* HEADER_SSL_TEST_CTX_H */