80-test_ssl_new.t: Make 19-mac-then-encrypt.conf work without TLSv1.2
[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 ## Configuring the client and server
91
92 The client and server configurations can be any valid `SSL_CTX`
93 configurations. For details, see the manpages for `SSL_CONF_cmd`.
94
95 Give your configurations as a dictionary of CONF commands, e.g.
96
97 ```
98 server => {
99     "CipherString" => "DEFAULT",
100     "MinProtocol" => "TLSv1",
101 }
102 ```
103
104 The following sections may optionally be defined:
105
106 * server2 - this section configures a secondary context that is selected via the
107   ServerName test option. This context is used whenever a ServerNameCallback is
108   specified. If the server2 section is not present, then the configuration
109   matches server.
110 * resume_server - this section configures the client to resume its session
111   against a different server. This context is used whenever HandshakeMode is
112   Resume. If the resume_server section is not present, then the configuration
113   matches server.
114 * resume_client - this section configures the client to resume its session with
115   a different configuration. In practice this may occur when, for example,
116   upgraded clients reuse sessions persisted on disk.  This context is used
117   whenever HandshakeMode is Resume. If the resume_client section is not present,
118   then the configuration matches client.
119
120 ### Configuring callbacks and additional options
121
122 Additional handshake settings can be configured in the `extra` section of each
123 client and server:
124
125 ```
126 client => {
127     "CipherString" => "DEFAULT",
128     extra => {
129         "ServerName" => "server2",
130     }
131 }
132 ```
133
134 #### Supported client-side options
135
136 * ClientVerifyCallback - the client's custom certificate verify callback.
137   Used to test callback behaviour. One of
138   - None - no custom callback (default)
139   - AcceptAll - accepts all certificates.
140   - RejectAll - rejects all certificates.
141
142 * ServerName - the server the client should attempt to connect to. One of
143   - None - do not use SNI (default)
144   - server1 - the initial context
145   - server2 - the secondary context
146   - invalid - an unknown context
147
148 * CTValidation - Certificate Transparency validation strategy. One of
149   - None - no validation (default)
150   - Permissive - SSL_CT_VALIDATION_PERMISSIVE
151   - Strict - SSL_CT_VALIDATION_STRICT
152
153 #### Supported server-side options
154
155 * ServerNameCallback - the SNI switching callback to use
156   - None - no callback (default)
157   - IgnoreMismatch - continue the handshake on SNI mismatch
158   - RejectMismatch - abort the handshake on SNI mismatch
159
160 * BrokenSessionTicket - a special test case where the session ticket callback
161   does not initialize crypto.
162   - No (default)
163   - Yes
164
165 #### Mutually supported options
166
167 * NPNProtocols, ALPNProtocols - NPN and ALPN settings. Server and client
168   protocols can be specified as a comma-separated list, and a callback with the
169   recommended behaviour will be installed automatically.
170
171 ### Default server and client configurations
172
173 The default server certificate and CA files are added to the configurations
174 automatically. Server certificate verification is requested by default.
175
176 You can override these options by redefining them:
177
178 ```
179 client => {
180     "VerifyCAFile" => "/path/to/custom/file"
181 }
182 ```
183
184 or by deleting them
185
186 ```
187 client => {
188     "VerifyCAFile" => undef
189 }
190 ```
191
192 ## Adding a test to the test harness
193
194 1. Add a new test configuration to `test/ssl-tests`, following the examples of
195    existing `*.conf.in` files (for example, `01-simple.conf.in`).
196
197 2. Generate the generated `*.conf` test input file. You can do so by running
198    `generate_ssl_tests.pl`:
199
200 ```
201 $ ./config
202 $ cd test
203 $ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/my.conf.in \
204   > ssl-tests/my.conf
205 ```
206
207 where `my.conf.in` is your test input file.
208
209 For example, to generate the test cases in `ssl-tests/01-simple.conf.in`, do
210
211 ```
212 $ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf
213 ```
214
215 Alternatively (hackish but simple), you can comment out
216
217 ```
218 unlink glob $tmp_file;
219 ```
220
221 in `test/recipes/80-test_ssl_new.t` and run
222
223 ```
224 $ make TESTS=test_ssl_new test
225 ```
226
227 This will save the generated output in a `*.tmp` file in the build directory.
228
229 3. Update the number of tests planned in `test/recipes/80-test_ssl_new.t`. If
230    the test suite has any skip conditions, update those too (see
231    `test/recipes/80-test_ssl_new.t` for details).
232
233 ## Running the tests with the test harness
234
235 ```
236 HARNESS_VERBOSE=yes make TESTS=test_ssl_new test
237 ```
238
239 ## Running a test manually
240
241 These steps are only needed during development. End users should run `make test`
242 or follow the instructions above to run the SSL test suite.
243
244 To run an SSL test manually from the command line, the `TEST_CERTS_DIR`
245 environment variable to point to the location of the certs. E.g., from the root
246 OpenSSL directory, do
247
248 ```
249 $ CTLOG_FILE=test/ct/log_list.conf TEST_CERTS_DIR=test/certs test/ssl_test \
250   test/ssl-tests/01-simple.conf
251 ```
252
253 or for shared builds
254
255 ```
256 $ CTLOG_FILE=test/ct/log_list.conf  TEST_CERTS_DIR=test/certs \
257   util/shlib_wrap.sh test/ssl_test test/ssl-tests/01-simple.conf
258 ```
259
260 Note that the test expectations sometimes depend on the Configure settings. For
261 example, the negotiated protocol depends on the set of available (enabled)
262 protocols: a build with `enable-ssl3` has different test expectations than a
263 build with `no-ssl3`.
264
265 The Perl test harness automatically generates expected outputs, so users who
266 just run `make test` do not need any extra steps.
267
268 However, when running a test manually, keep in mind that the repository version
269 of the generated `test/ssl-tests/*.conf` correspond to expected outputs in with
270 the default Configure options. To run `ssl_test` manually from the command line
271 in a build with a different configuration, you may need to generate the right
272 `*.conf` file from the `*.conf.in` input first.