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   - AcceptAll - accepts all certificates.
  65   - RejectAll - rejects all certificates.
  66
  67 * Method - the method to test. One of DTLS or TLS.
  68
  69 * ServerName - the server the client should attempt to connect to. One of
  70   - None - do not use SNI (default)
  71   - server1 - the initial context
  72   - server2 - the secondary context
  73
  74 * SessionTicketExpected - whether or not a session ticket is expected
  75   - Ignore - do not check for a session ticket (default)
  76   - Yes - a session ticket is expected
  77   - No - a session ticket is not expected
  78   - Broken - a special test case where the session ticket callback does not initialize crypto
  79
  80 ## Configuring the client and server
  81
  82 The client and server configurations can be any valid `SSL_CTX`
  83 configurations. For details, see the manpages for `SSL_CONF_cmd`.
  84
  85 Give your configurations as a dictionary of CONF commands, e.g.
  86
  87 ```
  88 server => {
  89     "CipherString" => "DEFAULT",
  90     "MinProtocol" => "TLSv1",
  91 }
  92 ```
  93
  94 A server2 section may optionally be defined to configure a secondary
  95 context that is selected via the ServerName test option. If the server2
  96 section is not configured, then the configuration matches server.
  97
  98 ### Default server and client configurations
  99
 100 The default server certificate and CA files are added to the configurations
 101 automatically. Server certificate verification is requested by default.
 102
 103 You can override these options by redefining them:
 104
 105 ```
 106 client => {
 107     "VerifyCAFile" => "/path/to/custom/file"
 108 }
 109 ```
 110
 111 or by deleting them
 112
 113 ```
 114 client => {
 115     "VerifyCAFile" => undef
 116 }
 117 ```
 118
 119 ## Adding a test to the test harness
 120
 121 Add your configuration file to `test/recipes/80-test_ssl_new.t`.
 122
 123 ## Running the tests with the test harness
 124
 125 ```
 126 HARNESS_VERBOSE=yes make TESTS=test_ssl_new test
 127 ```
 128
 129 ## Running a test manually
 130
 131 These steps are only needed during development. End users should run `make test`
 132 or follow the instructions above to run the SSL test suite.
 133
 134 To run an SSL test manually from the command line, the `TEST_CERTS_DIR`
 135 environment variable to point to the location of the certs. E.g., from the root
 136 OpenSSL directory, do
 137
 138 ```
 139 $ TEST_CERTS_DIR=test/certs test/ssl_test test/ssl-tests/01-simple.conf
 140 ```
 141
 142 or for shared builds
 143
 144 ```
 145 $ TEST_CERTS_DIR=test/certs util/shlib_wrap.sh test/ssl_test \
 146   test/ssl-tests/01-simple.conf
 147 ```
 148
 149 Note that the test expectations sometimes depend on the Configure settings. For
 150 example, the negotiated protocol depends on the set of available (enabled)
 151 protocols: a build with `enable-ssl3` has different test expectations than a
 152 build with `no-ssl3`.
 153
 154 The Perl test harness automatically generates expected outputs, so users who
 155 just run `make test` do not need any extra steps.
 156
 157 However, when running a test manually, keep in mind that the repository version
 158 of the generated `test/ssl-tests/*.conf` correspond to expected outputs in with
 159 the default Configure options. To run `ssl_test` manually from the command line
 160 in a build with a different configuration, you may need to generate the right
 161 `*.conf` file from the `*.conf.in` input first.