3 SSL testcases are configured in the `ssl-tests` directory.
5 Each `ssl_*.conf.in` file contains a number of test configurations. These files
6 are used to generate testcases in the OpenSSL CONF format.
8 The precise test output can be dependent on the library configuration. The test
9 harness generates the output files on the fly.
11 However, for verification, we also include checked-in configuration outputs
12 corresponding to the default configuration. These testcases live in
13 `test/ssl-tests/*.conf` files.
15 For more details, see `ssl-tests/01-simple.conf.in` for an example.
17 ## Configuring the test
19 First, give your test a name. The names do not have to be unique.
21 An example test input looks like this:
25 name => "test-default",
26 server => { "CipherString" => "DEFAULT" },
27 client => { "CipherString" => "DEFAULT" },
28 test => { "ExpectedResult" => "Success" },
32 The test section supports the following options
36 * Method - the method to test. One of DTLS or TLS.
38 * HandshakeMode - which handshake flavour to test:
39 - Simple - plain handshake (default)
40 - Resume - test resumption
41 - RenegotiateServer - test server initiated renegotiation
42 - RenegotiateClient - test client initiated renegotiation
44 When HandshakeMode is Resume or Renegotiate, the original handshake is expected
45 to succeed. All configured test expectations are verified against the second
48 * ApplicationData - amount of application data bytes to send (integer, defaults
49 to 256 bytes). Applies to both client and server. Application data is sent in
50 64kB chunks (but limited by MaxFragmentSize and available parallelization, see
53 * MaxFragmentSize - maximum send fragment size (integer, defaults to 512 in
54 tests - see `SSL_CTX_set_max_send_fragment` for documentation). Applies to
55 both client and server. Lowering the fragment size will split handshake and
56 application data up between more `SSL_write` calls, thus allowing to exercise
57 different code paths. In particular, if the buffer size (64kB) is at least
58 four times as large as the maximum fragment, interleaved multi-buffer crypto
59 implementations may be used on some platforms.
63 * ExpectedResult - expected handshake outcome. One of
64 - Success - handshake success
65 - ServerFail - serverside handshake failure
66 - ClientFail - clientside handshake failure
67 - InternalError - some other error
69 * ExpectedClientAlert, ExpectedServerAlert - expected alert. See
70 `ssl_test_ctx.c` for known values. Note: the expected alert is currently
71 matched against the _last_ received alert (i.e., a fatal alert or a
72 `close_notify`). Warning alert expectations are not yet supported. (A warning
73 alert will not be correctly matched, if followed by a `close_notify` or
76 * ExpectedProtocol - expected negotiated protocol. One of
77 SSLv3, TLSv1, TLSv1.1, TLSv1.2.
79 * SessionTicketExpected - whether or not a session ticket is expected
80 - Ignore - do not check for a session ticket (default)
81 - Yes - a session ticket is expected
82 - No - a session ticket is not expected
84 * SessionIdExpected - whether or not a session id is expected
85 - Ignore - do not check for a session id (default)
86 - Yes - a session id is expected
87 - No - a session id is not expected
89 * ResumptionExpected - whether or not resumption is expected (Resume mode only)
90 - Yes - resumed handshake
91 - No - full handshake (default)
93 * ExpectedNPNProtocol, ExpectedALPNProtocol - NPN and ALPN expectations.
95 * ExpectedTmpKeyType - the expected algorithm or curve of server temp key
97 * ExpectedServerCertType, ExpectedClientCertType - the expected algorithm or
98 curve of server or client certificate
100 * ExpectedServerSignHash, ExpectedClientSignHash - the expected
101 signing hash used by server or client certificate
103 * ExpectedServerSignType, ExpectedClientSignType - the expected
104 signature type used by server or client when signing messages
106 * ExpectedClientCANames - for client auth list of CA names the server must
107 send. If this is "empty" the list is expected to be empty otherwise it
108 is a file of certificates whose subject names form the list.
110 * ExpectedServerCANames - list of CA names the client must send, TLS 1.3 only.
111 If this is "empty" the list is expected to be empty otherwise it is a file
112 of certificates whose subject names form the list.
114 ## Configuring the client and server
116 The client and server configurations can be any valid `SSL_CTX`
117 configurations. For details, see the manpages for `SSL_CONF_cmd`.
119 Give your configurations as a dictionary of CONF commands, e.g.
123 "CipherString" => "DEFAULT",
124 "MinProtocol" => "TLSv1",
128 The following sections may optionally be defined:
130 * server2 - this section configures a secondary context that is selected via the
131 ServerName test option. This context is used whenever a ServerNameCallback is
132 specified. If the server2 section is not present, then the configuration
134 * resume_server - this section configures the client to resume its session
135 against a different server. This context is used whenever HandshakeMode is
136 Resume. If the resume_server section is not present, then the configuration
138 * resume_client - this section configures the client to resume its session with
139 a different configuration. In practice this may occur when, for example,
140 upgraded clients reuse sessions persisted on disk. This context is used
141 whenever HandshakeMode is Resume. If the resume_client section is not present,
142 then the configuration matches client.
144 ### Configuring callbacks and additional options
146 Additional handshake settings can be configured in the `extra` section of each
151 "CipherString" => "DEFAULT",
153 "ServerName" => "server2",
158 #### Supported client-side options
160 * ClientVerifyCallback - the client's custom certificate verify callback.
161 Used to test callback behaviour. One of
162 - None - no custom callback (default)
163 - AcceptAll - accepts all certificates.
164 - RejectAll - rejects all certificates.
166 * ServerName - the server the client should attempt to connect to. One of
167 - None - do not use SNI (default)
168 - server1 - the initial context
169 - server2 - the secondary context
170 - invalid - an unknown context
172 * CTValidation - Certificate Transparency validation strategy. One of
173 - None - no validation (default)
174 - Permissive - SSL_CT_VALIDATION_PERMISSIVE
175 - Strict - SSL_CT_VALIDATION_STRICT
177 #### Supported server-side options
179 * ServerNameCallback - the SNI switching callback to use
180 - None - no callback (default)
181 - IgnoreMismatch - continue the handshake on SNI mismatch
182 - RejectMismatch - abort the handshake on SNI mismatch
184 * BrokenSessionTicket - a special test case where the session ticket callback
185 does not initialize crypto.
189 #### Mutually supported options
191 * NPNProtocols, ALPNProtocols - NPN and ALPN settings. Server and client
192 protocols can be specified as a comma-separated list, and a callback with the
193 recommended behaviour will be installed automatically.
195 * SRPUser, SRPPassword - SRP settings. For client, this is the SRP user to
196 connect as; for server, this is a known SRP user.
198 ### Default server and client configurations
200 The default server certificate and CA files are added to the configurations
201 automatically. Server certificate verification is requested by default.
203 You can override these options by redefining them:
207 "VerifyCAFile" => "/path/to/custom/file"
215 "VerifyCAFile" => undef
219 ## Adding a test to the test harness
221 1. Add a new test configuration to `test/ssl-tests`, following the examples of
222 existing `*.conf.in` files (for example, `01-simple.conf.in`).
224 2. Generate the generated `*.conf` test input file. You can do so by running
225 `generate_ssl_tests.pl`:
230 $ TOP=.. perl -I ../util/perl/ generate_ssl_tests.pl ssl-tests/my.conf.in \
234 where `my.conf.in` is your test input file.
236 For example, to generate the test cases in `ssl-tests/01-simple.conf.in`, do
239 $ TOP=.. perl -I ../util/perl/ generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf
242 Alternatively (hackish but simple), you can comment out
245 unlink glob $tmp_file;
248 in `test/recipes/80-test_ssl_new.t` and run
251 $ make TESTS=test_ssl_new test
254 This will save the generated output in a `*.tmp` file in the build directory.
256 3. Update the number of tests planned in `test/recipes/80-test_ssl_new.t`. If
257 the test suite has any skip conditions, update those too (see
258 `test/recipes/80-test_ssl_new.t` for details).
260 ## Running the tests with the test harness
263 HARNESS_VERBOSE=yes make TESTS=test_ssl_new test
266 ## Running a test manually
268 These steps are only needed during development. End users should run `make test`
269 or follow the instructions above to run the SSL test suite.
271 To run an SSL test manually from the command line, the `TEST_CERTS_DIR`
272 environment variable to point to the location of the certs. E.g., from the root
273 OpenSSL directory, do
276 $ CTLOG_FILE=test/ct/log_list.conf TEST_CERTS_DIR=test/certs test/ssl_test \
277 test/ssl-tests/01-simple.conf
283 $ CTLOG_FILE=test/ct/log_list.conf TEST_CERTS_DIR=test/certs \
284 util/shlib_wrap.sh test/ssl_test test/ssl-tests/01-simple.conf
287 Note that the test expectations sometimes depend on the Configure settings. For
288 example, the negotiated protocol depends on the set of available (enabled)
289 protocols: a build with `enable-ssl3` has different test expectations than a
290 build with `no-ssl3`.
292 The Perl test harness automatically generates expected outputs, so users who
293 just run `make test` do not need any extra steps.
295 However, when running a test manually, keep in mind that the repository version
296 of the generated `test/ssl-tests/*.conf` correspond to expected outputs in with
297 the default Configure options. To run `ssl_test` manually from the command line
298 in a build with a different configuration, you may need to generate the right
299 `*.conf` file from the `*.conf.in` input first.