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 * ExpectedResult - expected handshake outcome. One of
  51   - Success - handshake success
  52   - ServerFail - serverside handshake failure
  53   - ClientFail - clientside handshake failure
  54   - InternalError - some other error
  55
  56 * ClientAlert, ServerAlert - expected alert. See `ssl_test_ctx.c` for known
  57   values.
  58
  59 * Protocol - expected negotiated protocol. One of
  60   SSLv3, TLSv1, TLSv1.1, TLSv1.2.
  61
  62 * ClientVerifyCallback - the client's custom certificate verify callback.
  63   Used to test callback behaviour. One of
  64   - None - no custom callback (default)
  65   - AcceptAll - accepts all certificates.
  66   - RejectAll - rejects all certificates.
  67
  68 * Method - the method to test. One of DTLS or TLS.
  69
  70 * ServerName - the server the client should attempt to connect to. One of
  71   - None - do not use SNI (default)
  72   - server1 - the initial context
  73   - server2 - the secondary context
  74   - invalid - an unknown context
  75
  76 * ServerNameCallback - the SNI switching callback to use
  77   - None - no callback (default)
  78   - IgnoreMismatch - continue the handshake on SNI mismatch
  79   - RejectMismatch - abort the handshake on SNI mismatch
  80
  81 * SessionTicketExpected - whether or not a session ticket is expected
  82   - Ignore - do not check for a session ticket (default)
  83   - Yes - a session ticket is expected
  84   - No - a session ticket is not expected
  85   - Broken - a special test case where the session ticket callback does not initialize crypto
  86
  87 * ServerNPNProtocols, Server2NPNProtocols, ClientNPNProtocols, ExpectedNPNProtocol,
  88   ServerALPNProtocols, Server2ALPNProtocols, ClientALPNProtocols, ExpectedALPNProtocol -
  89   NPN and ALPN settings. Server and client protocols can be specified as a comma-separated list,
  90   and a callback with the recommended behaviour will be installed automatically.
  91
  92 ## Configuring the client and server
  93
  94 The client and server configurations can be any valid `SSL_CTX`
  95 configurations. For details, see the manpages for `SSL_CONF_cmd`.
  96
  97 Give your configurations as a dictionary of CONF commands, e.g.
  98
  99 ```
 100 server => {
 101     "CipherString" => "DEFAULT",
 102     "MinProtocol" => "TLSv1",
 103 }
 104 ```
 105
 106 A server2 section may optionally be defined to configure a secondary
 107 context that is selected via the ServerName test option. If the server2
 108 section is not configured, then the configuration matches server.
 109
 110 ### Default server and client configurations
 111
 112 The default server certificate and CA files are added to the configurations
 113 automatically. Server certificate verification is requested by default.
 114
 115 You can override these options by redefining them:
 116
 117 ```
 118 client => {
 119     "VerifyCAFile" => "/path/to/custom/file"
 120 }
 121 ```
 122
 123 or by deleting them
 124
 125 ```
 126 client => {
 127     "VerifyCAFile" => undef
 128 }
 129 ```
 130
 131 ## Adding a test to the test harness
 132
 133 Add your configuration file to `test/recipes/80-test_ssl_new.t`.
 134
 135 ## Running the tests with the test harness
 136
 137 ```
 138 HARNESS_VERBOSE=yes make TESTS=test_ssl_new test
 139 ```
 140
 141 ## Running a test manually
 142
 143 These steps are only needed during development. End users should run `make test`
 144 or follow the instructions above to run the SSL test suite.
 145
 146 To run an SSL test manually from the command line, the `TEST_CERTS_DIR`
 147 environment variable to point to the location of the certs. E.g., from the root
 148 OpenSSL directory, do
 149
 150 ```
 151 $ TEST_CERTS_DIR=test/certs test/ssl_test test/ssl-tests/01-simple.conf
 152 ```
 153
 154 or for shared builds
 155
 156 ```
 157 $ TEST_CERTS_DIR=test/certs util/shlib_wrap.sh test/ssl_test \
 158   test/ssl-tests/01-simple.conf
 159 ```
 160
 161 Note that the test expectations sometimes depend on the Configure settings. For
 162 example, the negotiated protocol depends on the set of available (enabled)
 163 protocols: a build with `enable-ssl3` has different test expectations than a
 164 build with `no-ssl3`.
 165
 166 The Perl test harness automatically generates expected outputs, so users who
 167 just run `make test` do not need any extra steps.
 168
 169 However, when running a test manually, keep in mind that the repository version
 170 of the generated `test/ssl-tests/*.conf` correspond to expected outputs in with
 171 the default Configure options. To run `ssl_test` manually from the command line
 172 in a build with a different configuration, you may need to generate the right
 173 `*.conf` file from the `*.conf.in` input first.