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. Therefore, whenever you're adding or updating a
14 generated test, you should run
19 $ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/my.conf.in \
23 where `my.conf.in` is your test input file.
25 For example, to generate the test cases in `ssl-tests/01-simple.conf.in`, do
28 $ TOP=.. perl generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf
31 For more details, see `ssl-tests/01-simple.conf.in` for an example.
33 ## Configuring the test
35 First, give your test a name. The names do not have to be unique.
37 An example test input looks like this:
41 name => "test-default",
42 server => { "CipherString" => "DEFAULT" },
43 client => { "CipherString" => "DEFAULT" },
44 test => { "ExpectedResult" => "Success" },
48 The test section supports the following options
52 * Method - the method to test. One of DTLS or TLS.
54 * HandshakeMode - which handshake flavour to test:
55 - Simple - plain handshake (default)
56 - Resume - test resumption
57 - (Renegotiate - test renegotiation, not yet implemented)
59 When HandshakeMode is Resume or Renegotiate, the original handshake is expected
60 to succeed. All configured test expectations are verified against the second
65 * ExpectedResult - expected handshake outcome. One of
66 - Success - handshake success
67 - ServerFail - serverside handshake failure
68 - ClientFail - clientside handshake failure
69 - InternalError - some other error
71 * ExpectedClientAlert, ExpectedServerAlert - expected alert. See
72 `ssl_test_ctx.c` for known values.
74 * ExpectedProtocol - expected negotiated protocol. One of
75 SSLv3, TLSv1, TLSv1.1, TLSv1.2.
77 * SessionTicketExpected - whether or not a session ticket is expected
78 - Ignore - do not check for a session ticket (default)
79 - Yes - a session ticket is expected
80 - No - a session ticket is not expected
82 * ResumptionExpected - whether or not resumption is expected (Resume mode only)
83 - Yes - resumed handshake
84 - No - full handshake (default)
86 * ExpectedNPNProtocol, ExpectedALPNProtocol - NPN and ALPN expectations.
88 ## Configuring the client and server
90 The client and server configurations can be any valid `SSL_CTX`
91 configurations. For details, see the manpages for `SSL_CONF_cmd`.
93 Give your configurations as a dictionary of CONF commands, e.g.
97 "CipherString" => "DEFAULT",
98 "MinProtocol" => "TLSv1",
102 The following sections may optionally be defined:
104 * server2 - this section configures a secondary context that is selected via the
105 ServerName test option. This context is used whenever a ServerNameCallback is
106 specified. If the server2 section is not present, then the configuration
108 * resume_server - this section configures the client to resume its session
109 against a different server. This context is used whenever HandshakeMode is
110 Resume. If the resume_server section is not present, then the configuration
112 * resume_client - this section configures the client to resume its session with
113 a different configuration. In practice this may occur when, for example,
114 upgraded clients reuse sessions persisted on disk. This context is used
115 whenever HandshakeMode is Resume. If the resume_client section is not present,
116 then the configuration matches client.
118 ### Configuring callbacks and additional options
120 Additional handshake settings can be configured in the `extra` section of each
125 "CipherString" => "DEFAULT",
127 "ServerName" => "server2",
132 #### Supported client-side options
134 * ClientVerifyCallback - the client's custom certificate verify callback.
135 Used to test callback behaviour. One of
136 - None - no custom callback (default)
137 - AcceptAll - accepts all certificates.
138 - RejectAll - rejects all certificates.
140 * ServerName - the server the client should attempt to connect to. One of
141 - None - do not use SNI (default)
142 - server1 - the initial context
143 - server2 - the secondary context
144 - invalid - an unknown context
146 #### Supported server-side options
148 * ServerNameCallback - the SNI switching callback to use
149 - None - no callback (default)
150 - IgnoreMismatch - continue the handshake on SNI mismatch
151 - RejectMismatch - abort the handshake on SNI mismatch
153 * BrokenSessionTicket - a special test case where the session ticket callback
154 does not initialize crypto.
158 #### Mutually supported options
160 * NPNProtocols, ALPNProtocols - NPN and ALPN settings. Server and client
161 protocols can be specified as a comma-separated list, and a callback with the
162 recommended behaviour will be installed automatically.
164 ### Default server and client configurations
166 The default server certificate and CA files are added to the configurations
167 automatically. Server certificate verification is requested by default.
169 You can override these options by redefining them:
173 "VerifyCAFile" => "/path/to/custom/file"
181 "VerifyCAFile" => undef
185 ## Adding a test to the test harness
187 Add your configuration file to `test/recipes/80-test_ssl_new.t`.
189 ## Running the tests with the test harness
192 HARNESS_VERBOSE=yes make TESTS=test_ssl_new test
195 ## Running a test manually
197 These steps are only needed during development. End users should run `make test`
198 or follow the instructions above to run the SSL test suite.
200 To run an SSL test manually from the command line, the `TEST_CERTS_DIR`
201 environment variable to point to the location of the certs. E.g., from the root
202 OpenSSL directory, do
205 $ TEST_CERTS_DIR=test/certs test/ssl_test test/ssl-tests/01-simple.conf
211 $ TEST_CERTS_DIR=test/certs util/shlib_wrap.sh test/ssl_test \
212 test/ssl-tests/01-simple.conf
215 Note that the test expectations sometimes depend on the Configure settings. For
216 example, the negotiated protocol depends on the set of available (enabled)
217 protocols: a build with `enable-ssl3` has different test expectations than a
218 build with `no-ssl3`.
220 The Perl test harness automatically generates expected outputs, so users who
221 just run `make test` do not need any extra steps.
223 However, when running a test manually, keep in mind that the repository version
224 of the generated `test/ssl-tests/*.conf` correspond to expected outputs in with
225 the default Configure options. To run `ssl_test` manually from the command line
226 in a build with a different configuration, you may need to generate the right
227 `*.conf` file from the `*.conf.in` input first.