0d6f4660cbc8b85bbbaeb0193b9b7bd7d9e9f40c
[openssl.git] / test / README.ssltest.md
1 # SSL tests
2
3 SSL testcases are configured in the `ssl-tests` directory.
4
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.
7
8 The precise test output can be dependent on the library configuration. The test
9 harness generates the output files on the fly.
10
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.
14
15 For more details, see `ssl-tests/01-simple.conf.in` for an example.
16
17 ## Configuring the test
18
19 First, give your test a name. The names do not have to be unique.
20
21 An example test input looks like this:
22
23 ```
24     {
25         name => "test-default",
26         server => { "CipherString" => "DEFAULT" },
27         client => { "CipherString" => "DEFAULT" },
28         test   => { "ExpectedResult" => "Success" },
29     }
30 ```
31
32 The test section supports the following options
33
34 ### Test mode
35
36 * Method - the method to test. One of DTLS or TLS.
37
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
43
44 When HandshakeMode is Resume or Renegotiate, the original handshake is expected
45 to succeed. All configured test expectations are verified against the second
46 handshake.
47
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
51   below).
52
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.
60
61 ### Test expectations
62
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
68
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
74   another alert.)
75
76 * ExpectedProtocol - expected negotiated protocol. One of
77   SSLv3, TLSv1, TLSv1.1, TLSv1.2.
78
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
83
84 * ResumptionExpected - whether or not resumption is expected (Resume mode only)
85   - Yes - resumed handshake
86   - No - full handshake (default)
87
88 * ExpectedNPNProtocol, ExpectedALPNProtocol - NPN and ALPN expectations.
89
90 * ExpectedTmpKeyType - the expected algorithm or curve of server temp key
91
92 * ExpectedServerCertType, ExpectedClientCertType - the expected algorithm or
93   curve of server or client certificate
94
95 * ExpectedServerSignHash, ExpectedClientSignHash - the expected
96   signing hash used by server or client certificate
97
98 * ExpectedServerSignType, ExpectedClientSignType - the expected
99   signature type used by server or client when signing messages
100
101 * ExpectedClientCANames - for client auth list of CA names the server must
102   send. If this is "empty" the list is expected to be empty otherwise it
103   is a file of certificates whose subject names form the list.
104
105 ## Configuring the client and server
106
107 The client and server configurations can be any valid `SSL_CTX`
108 configurations. For details, see the manpages for `SSL_CONF_cmd`.
109
110 Give your configurations as a dictionary of CONF commands, e.g.
111
112 ```
113 server => {
114     "CipherString" => "DEFAULT",
115     "MinProtocol" => "TLSv1",
116 }
117 ```
118
119 The following sections may optionally be defined:
120
121 * server2 - this section configures a secondary context that is selected via the
122   ServerName test option. This context is used whenever a ServerNameCallback is
123   specified. If the server2 section is not present, then the configuration
124   matches server.
125 * resume_server - this section configures the client to resume its session
126   against a different server. This context is used whenever HandshakeMode is
127   Resume. If the resume_server section is not present, then the configuration
128   matches server.
129 * resume_client - this section configures the client to resume its session with
130   a different configuration. In practice this may occur when, for example,
131   upgraded clients reuse sessions persisted on disk.  This context is used
132   whenever HandshakeMode is Resume. If the resume_client section is not present,
133   then the configuration matches client.
134
135 ### Configuring callbacks and additional options
136
137 Additional handshake settings can be configured in the `extra` section of each
138 client and server:
139
140 ```
141 client => {
142     "CipherString" => "DEFAULT",
143     extra => {
144         "ServerName" => "server2",
145     }
146 }
147 ```
148
149 #### Supported client-side options
150
151 * ClientVerifyCallback - the client's custom certificate verify callback.
152   Used to test callback behaviour. One of
153   - None - no custom callback (default)
154   - AcceptAll - accepts all certificates.
155   - RejectAll - rejects all certificates.
156
157 * ServerName - the server the client should attempt to connect to. One of
158   - None - do not use SNI (default)
159   - server1 - the initial context
160   - server2 - the secondary context
161   - invalid - an unknown context
162
163 * CTValidation - Certificate Transparency validation strategy. One of
164   - None - no validation (default)
165   - Permissive - SSL_CT_VALIDATION_PERMISSIVE
166   - Strict - SSL_CT_VALIDATION_STRICT
167
168 #### Supported server-side options
169
170 * ServerNameCallback - the SNI switching callback to use
171   - None - no callback (default)
172   - IgnoreMismatch - continue the handshake on SNI mismatch
173   - RejectMismatch - abort the handshake on SNI mismatch
174
175 * BrokenSessionTicket - a special test case where the session ticket callback
176   does not initialize crypto.
177   - No (default)
178   - Yes
179
180 #### Mutually supported options
181
182 * NPNProtocols, ALPNProtocols - NPN and ALPN settings. Server and client
183   protocols can be specified as a comma-separated list, and a callback with the
184   recommended behaviour will be installed automatically.
185
186 * SRPUser, SRPPassword - SRP settings. For client, this is the SRP user to
187   connect as; for server, this is a known SRP user.
188
189 ### Default server and client configurations
190
191 The default server certificate and CA files are added to the configurations
192 automatically. Server certificate verification is requested by default.
193
194 You can override these options by redefining them:
195
196 ```
197 client => {
198     "VerifyCAFile" => "/path/to/custom/file"
199 }
200 ```
201
202 or by deleting them
203
204 ```
205 client => {
206     "VerifyCAFile" => undef
207 }
208 ```
209
210 ## Adding a test to the test harness
211
212 1. Add a new test configuration to `test/ssl-tests`, following the examples of
213    existing `*.conf.in` files (for example, `01-simple.conf.in`).
214
215 2. Generate the generated `*.conf` test input file. You can do so by running
216    `generate_ssl_tests.pl`:
217
218 ```
219 $ ./config
220 $ cd test
221 $ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/my.conf.in \
222   > ssl-tests/my.conf
223 ```
224
225 where `my.conf.in` is your test input file.
226
227 For example, to generate the test cases in `ssl-tests/01-simple.conf.in`, do
228
229 ```
230 $ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf
231 ```
232
233 Alternatively (hackish but simple), you can comment out
234
235 ```
236 unlink glob $tmp_file;
237 ```
238
239 in `test/recipes/80-test_ssl_new.t` and run
240
241 ```
242 $ make TESTS=test_ssl_new test
243 ```
244
245 This will save the generated output in a `*.tmp` file in the build directory.
246
247 3. Update the number of tests planned in `test/recipes/80-test_ssl_new.t`. If
248    the test suite has any skip conditions, update those too (see
249    `test/recipes/80-test_ssl_new.t` for details).
250
251 ## Running the tests with the test harness
252
253 ```
254 HARNESS_VERBOSE=yes make TESTS=test_ssl_new test
255 ```
256
257 ## Running a test manually
258
259 These steps are only needed during development. End users should run `make test`
260 or follow the instructions above to run the SSL test suite.
261
262 To run an SSL test manually from the command line, the `TEST_CERTS_DIR`
263 environment variable to point to the location of the certs. E.g., from the root
264 OpenSSL directory, do
265
266 ```
267 $ CTLOG_FILE=test/ct/log_list.conf TEST_CERTS_DIR=test/certs test/ssl_test \
268   test/ssl-tests/01-simple.conf
269 ```
270
271 or for shared builds
272
273 ```
274 $ CTLOG_FILE=test/ct/log_list.conf  TEST_CERTS_DIR=test/certs \
275   util/shlib_wrap.sh test/ssl_test test/ssl-tests/01-simple.conf
276 ```
277
278 Note that the test expectations sometimes depend on the Configure settings. For
279 example, the negotiated protocol depends on the set of available (enabled)
280 protocols: a build with `enable-ssl3` has different test expectations than a
281 build with `no-ssl3`.
282
283 The Perl test harness automatically generates expected outputs, so users who
284 just run `make test` do not need any extra steps.
285
286 However, when running a test manually, keep in mind that the repository version
287 of the generated `test/ssl-tests/*.conf` correspond to expected outputs in with
288 the default Configure options. To run `ssl_test` manually from the command line
289 in a build with a different configuration, you may need to generate the right
290 `*.conf` file from the `*.conf.in` input first.