boringssl/ssl/test
David Benjamin 0990a552eb Set up Go modules.
This should make it easier for us to reuse Go code properly.
util/fipstools is kind of a mess. runner has been using relative
imports, but Go seems to prefer this mechanism these days.

Update-Note: The import spelling in ssl/test/runner changes. Also we now
    require Go 1.11. Or you could clone us into GOPATH, but no one does
    that.

Change-Id: I8bf91e1e0345b3d0b3d17f5c642fe78b415b7dde
Reviewed-on: https://boringssl-review.googlesource.com/31884
Reviewed-by: Adam Langley <agl@google.com>
2018-09-17 21:04:17 +00:00
..
runner Set up Go modules. 2018-09-17 21:04:17 +00:00
async_bio.cc Work around language and compiler bug in memcpy, etc. 2016-12-21 20:34:47 +00:00
async_bio.h
bssl_shim.cc Implement TLS 1.3 anti-downgrade signal. 2018-08-15 15:23:43 +00:00
CMakeLists.txt Support symbol prefixes 2018-09-06 20:07:52 +00:00
fuzzer_tags.h Fuzz SSL_serialize_handoff() and SSL_serialize_handback(). 2018-05-05 02:41:04 +00:00
fuzzer.h Remove SSL 3.0 implementation. 2018-06-28 16:54:58 +00:00
handshake_util.cc shim: don't clear environment when invoking handshaker. 2018-08-28 17:50:26 +00:00
handshake_util.h shim: perform split handshakes in a separate binary. 2018-08-01 01:44:53 +00:00
handshaker.cc handshaker: kick PRNG when resuming in UNSAFE_DETERMINISTIC_MODE. 2018-08-03 23:11:46 +00:00
packeted_bio.cc Remove support for blocking DTLS timeout handling. 2017-03-01 19:59:28 +00:00
packeted_bio.h Remove support for blocking DTLS timeout handling. 2017-03-01 19:59:28 +00:00
PORTING.md Document that malloc tests require a longer timeout. 2016-09-30 19:13:05 +00:00
README.md
settings_writer.cc shim: move |SettingsWriter| into its own file. 2018-07-02 22:26:28 +00:00
settings_writer.h shim: move |SettingsWriter| into its own file. 2018-07-02 22:26:28 +00:00
test_config.cc Implement TLS 1.3 anti-downgrade signal. 2018-08-15 15:23:43 +00:00
test_config.h Implement TLS 1.3 anti-downgrade signal. 2018-08-15 15:23:43 +00:00
test_state.cc shim: perform split handshakes in a separate binary. 2018-08-01 01:44:53 +00:00
test_state.h shim: perform split handshakes in a separate binary. 2018-08-01 01:44:53 +00:00

BoringSSL SSL Tests

This directory contains BoringSSL's protocol-level test suite.

Testing a TLS implementation can be difficult. We need to produce invalid but sufficiently correct handshakes to get our implementation close to its edge cases. TLS's cryptographic steps mean we cannot use a transcript and effectively need a TLS implementation on the other end. But we do not wish to litter BoringSSL with options for bugs to test against.

Instead, we use a fork of the Go crypto/tls package, heavily patched with configurable bugs. This code, along with a test suite and harness written in Go, lives in the runner directory. The harness runs BoringSSL via a C/C++ shim binary which lives in this directory. All communication with the shim binary occurs with command-line flags, sockets, and standard I/O.

This strategy also ensures we always test against a second implementation. All features should be implemented twice, once in C for BoringSSL and once in Go for testing. If possible, the Go code should be suitable for potentially upstreaming. However, sometimes test code has different needs. For example, our test DTLS code enforces strict ordering on sequence numbers and has controlled packet drop simulation.

To run the tests manually, run go test from the runner directory. It takes command-line flags found at the top of runner/runner.go. The -help option also works after using go test -c to make a runner.test binary first.

If adding a new test, these files may be a good starting point:

  • runner/runner.go: the test harness and all the individual tests.
  • runner/common.go: contains the Config and ProtocolBugs struct which control the Go TLS implementation's behavior.
  • test_config.h, test_config.cc: the command-line flags which control the shim's behavior.
  • bssl_shim.cc: the shim binary itself.

For porting the test suite to a different implementation see PORTING.md.