4e9c0e1fb309412ee02ba83c52e389795f56d22a
[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. Therefore, whenever you're adding or updating a
14 generated test, you should run
15
16 ```
17 $ ./config
18 $ cd test
19 $ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/my.conf.in \
20   > ssl-tests/my.conf
21 ```
22
23 where `my.conf.in` is your test input file.
24
25 For example, to generate the test cases in `ssl-tests/01-simple.conf.in`, do
26
27 ```
28 $ TOP=.. perl generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf
29 ```
30
31 For more details, see `ssl-tests/01-simple.conf.in` for an example.
32
33 ## Configuring the test
34
35 First, give your test a name. The names do not have to be unique.
36
37 An example test input looks like this:
38
39 ```
40     {
41         name => "test-default",
42         server => { "CipherString" => "DEFAULT" },
43         client => { "CipherString" => "DEFAULT" },
44         test   => { "ExpectedResult" => "Success" },
45     }
46 ```
47
48 The test section supports the following options
49
50 ### Test mode
51
52 * Method - the method to test. One of DTLS or TLS.
53
54 * HandshakeMode - which handshake flavour to test:
55   - Simple - plain handshake (default)
56   - Resume - test resumption
57   - (Renegotiate - test renegotiation, not yet implemented)
58
59 When HandshakeMode is Resume or Renegotiate, the original handshake is expected
60 to succeed. All configured test expectations are verified against the second
61 handshake.
62
63 * ApplicationData - amount of application data bytes to send (integer, defaults
64   to 256 bytes). Applies to both client and server. Application data is sent in
65   64kB chunks (but limited by MaxFragmentSize and available parallelization, see
66   below).
67
68 * MaxFragmentSize - maximum send fragment size (integer, defaults to 512 in
69   tests - see `SSL_CTX_set_max_send_fragment` for documentation). Applies to
70   both client and server. Lowering the fragment size will split handshake and
71   application data up between more `SSL_write` calls, thus allowing to exercise
72   different code paths. In particular, if the buffer size (64kB) is at least
73   four times as large as the maximum fragment, interleaved multi-buffer crypto
74   implementations may be used on some platforms.
75
76 ### Test expectations
77
78 * ExpectedResult - expected handshake outcome. One of
79   - Success - handshake success
80   - ServerFail - serverside handshake failure
81   - ClientFail - clientside handshake failure
82   - InternalError - some other error
83
84 * ExpectedClientAlert, ExpectedServerAlert - expected alert. See
85   `ssl_test_ctx.c` for known values. Note: the expected alert is currently
86   matched against the _last_ received alert (i.e., a fatal alert or a
87   `close_notify`). Warning alert expectations are not yet supported. (A warning
88   alert will not be correctly matched, if followed by a `close_notify` or
89   another alert.)
90
91 * ExpectedProtocol - expected negotiated protocol. One of
92   SSLv3, TLSv1, TLSv1.1, TLSv1.2.
93
94 * SessionTicketExpected - whether or not a session ticket is expected
95   - Ignore - do not check for a session ticket (default)
96   - Yes - a session ticket is expected
97   - No - a session ticket is not expected
98
99 * ResumptionExpected - whether or not resumption is expected (Resume mode only)
100   - Yes - resumed handshake
101   - No - full handshake (default)
102
103 * ExpectedNPNProtocol, ExpectedALPNProtocol - NPN and ALPN expectations.
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 ### Default server and client configurations
187
188 The default server certificate and CA files are added to the configurations
189 automatically. Server certificate verification is requested by default.
190
191 You can override these options by redefining them:
192
193 ```
194 client => {
195     "VerifyCAFile" => "/path/to/custom/file"
196 }
197 ```
198
199 or by deleting them
200
201 ```
202 client => {
203     "VerifyCAFile" => undef
204 }
205 ```
206
207 ## Adding a test to the test harness
208
209 Add your configuration file to `test/recipes/80-test_ssl_new.t`.
210
211 ## Running the tests with the test harness
212
213 ```
214 HARNESS_VERBOSE=yes make TESTS=test_ssl_new test
215 ```
216
217 ## Running a test manually
218
219 These steps are only needed during development. End users should run `make test`
220 or follow the instructions above to run the SSL test suite.
221
222 To run an SSL test manually from the command line, the `TEST_CERTS_DIR`
223 environment variable to point to the location of the certs. E.g., from the root
224 OpenSSL directory, do
225
226 ```
227 $ TEST_CERTS_DIR=test/certs test/ssl_test test/ssl-tests/01-simple.conf
228 ```
229
230 or for shared builds
231
232 ```
233 $ TEST_CERTS_DIR=test/certs util/shlib_wrap.sh test/ssl_test \
234   test/ssl-tests/01-simple.conf
235 ```
236
237 Some tests also need additional environment variables; for example, Certificate
238 Transparency tests need a `CTLOG_FILE`. See `test/recipes/80-test_ssl_new.t` for
239 details.
240
241 Note that the test expectations sometimes depend on the Configure settings. For
242 example, the negotiated protocol depends on the set of available (enabled)
243 protocols: a build with `enable-ssl3` has different test expectations than a
244 build with `no-ssl3`.
245
246 The Perl test harness automatically generates expected outputs, so users who
247 just run `make test` do not need any extra steps.
248
249 However, when running a test manually, keep in mind that the repository version
250 of the generated `test/ssl-tests/*.conf` correspond to expected outputs in with
251 the default Configure options. To run `ssl_test` manually from the command line
252 in a build with a different configuration, you may need to generate the right
253 `*.conf` file from the `*.conf.in` input first.