openssl/test/README.ssltest.md
Todd Short 5c753de668 Fix session ticket and SNI
When session tickets are used, it's possible that SNI might swtich the
SSL_CTX on an SSL. Normally, this is not a problem, because the
initial_ctx/session_ctx are used for all session ticket/id processes.

However, when the SNI callback occurs, it's possible that the callback
may update the options in the SSL from the SSL_CTX, and this could
cause SSL_OP_NO_TICKET to be set. If this occurs, then two bad things
can happen:

1. The session ticket TLSEXT may not be written when the ticket expected
flag is set. The state machine transistions to writing the ticket, and
the client responds with an error as its not expecting a ticket.
2. When creating the session ticket, if the ticket key cb returns 0
the crypto/hmac contexts are not initialized, and the code crashes when
trying to encrypt the session ticket.

To fix 1, if the ticket TLSEXT is not written out, clear the expected
ticket flag.
To fix 2, consider a return of 0 from the ticket key cb a recoverable
error, and write a 0 length ticket and continue. The client-side code
can explicitly handle this case.

Fix these two cases, and add unit test code to validate ticket behavior.

Reviewed-by: Emilia Käsper <emilia@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/1098)
2016-06-09 13:07:51 -04:00

4.8 KiB

SSL tests

SSL testcases are configured in the ssl-tests directory.

Each ssl_*.conf.in file contains a number of test configurations. These files are used to generate testcases in the OpenSSL CONF format.

The precise test output can be dependent on the library configuration. The test harness generates the output files on the fly.

However, for verification, we also include checked-in configuration outputs corresponding to the default configuration. These testcases live in test/ssl-tests/*.conf files. Therefore, whenever you're adding or updating a generated test, you should run

$ ./config
$ cd test
$ TOP=.. perl -I testlib/ generate_ssl_tests.pl ssl-tests/my.conf.in \
  > ssl-tests/my.conf

where my.conf.in is your test input file.

For example, to generate the test cases in ssl-tests/01-simple.conf.in, do

$ TOP=.. perl generate_ssl_tests.pl ssl-tests/01-simple.conf.in > ssl-tests/01-simple.conf

For more details, see ssl-tests/01-simple.conf.in for an example.

Configuring the test

First, give your test a name. The names do not have to be unique.

An example test input looks like this:

    {
        name => "test-default",
        server => { "CipherString" => "DEFAULT" },
        client => { "CipherString" => "DEFAULT" },
        test   => { "ExpectedResult" => "Success" },
    }

The test section supports the following options:

  • ExpectedResult - expected handshake outcome. One of

    • Success - handshake success
    • ServerFail - serverside handshake failure
    • ClientFail - clientside handshake failure
    • InternalError - some other error
  • ClientAlert, ServerAlert - expected alert. See ssl_test_ctx.c for known values.

  • Protocol - expected negotiated protocol. One of SSLv3, TLSv1, TLSv1.1, TLSv1.2.

  • ClientVerifyCallback - the client's custom certificate verify callback. Used to test callback behaviour. One of

    • AcceptAll - accepts all certificates.
    • RejectAll - rejects all certificates.
  • ServerName - the server the client is expected to successfully connect to

    • server1 - the initial context (default)
    • server2 - the secondary context
  • SessionTicketExpected - whether or not a session ticket is expected

    • Ignore - do not check for a session ticket (default)
    • Yes - a session ticket is expected
    • No - a session ticket is not expected
    • Broken - a special test case where the session ticket callback does not initialize crypto

Configuring the client and server

The client and server configurations can be any valid SSL_CTX configurations. For details, see the manpages for SSL_CONF_cmd.

Give your configurations as a dictionary of CONF commands, e.g.

server => {
    "CipherString" => "DEFAULT",
    "MinProtocol" => "TLSv1",
}

A server2 section may optionally be defined to configure a secondary context that is selected via the ServerName test option. If the server2 section is not configured, then the configuration matches server.

Default server and client configurations

The default server certificate and CA files are added to the configurations automatically. Server certificate verification is requested by default.

You can override these options by redefining them:

client => {
    "VerifyCAFile" => "/path/to/custom/file"
}

or by deleting them

client => {
    "VerifyCAFile" => undef
}

Adding a test to the test harness

Add your configuration file to test/recipes/80-test_ssl_new.t.

Running the tests with the test harness

HARNESS_VERBOSE=yes make TESTS=test_ssl_new test

Running a test manually

These steps are only needed during development. End users should run make test or follow the instructions above to run the SSL test suite.

To run an SSL test manually from the command line, the TEST_CERTS_DIR environment variable to point to the location of the certs. E.g., from the root OpenSSL directory, do

$ TEST_CERTS_DIR=test/certs test/ssl_test test/ssl-tests/01-simple.conf

or for shared builds

$ TEST_CERTS_DIR=test/certs util/shlib_wrap.sh test/ssl_test \
  test/ssl-tests/01-simple.conf

Note that the test expectations sometimes depend on the Configure settings. For example, the negotiated protocol depends on the set of available (enabled) protocols: a build with enable-ssl3 has different test expectations than a build with no-ssl3.

The Perl test harness automatically generates expected outputs, so users who just run make test do not need any extra steps.

However, when running a test manually, keep in mind that the repository version of the generated test/ssl-tests/*.conf correspond to expected outputs in with the default Configure options. To run ssl_test manually from the command line in a build with a different configuration, you may need to generate the right *.conf file from the *.conf.in input first.