boringssl/ssl/test
David Benjamin 86e95b852e Move libssl's internals into the bssl namespace.
This is horrible, but everything else I tried was worse. The goal with
this CL is to take the extern "C" out of ssl/internal.h and move most
symbols to namespace bssl, so we can start using C++ helpers and
destructors without worry.

Complications:

- Public API functions must be extern "C" and match their declaration in
  ssl.h, which is unnamespaced. C++ really does not want you to
  interleave namespaced and unnamespaced things. One can actually write
  a namespaced extern "C" function, but this means, from C++'s
  perspective, the function is namespaced. Trying to namespace the
  public header would worked but ended up too deep a rabbithole.

- Our STACK_OF macros do not work right in namespaces.

- The typedefs for our exposed but opaque types are visible in the
  header files and copied into consuming projects as forward
  declarations. We ultimately want to give SSL a destructor, but
  clobbering an unnamespaced ssl_st::~ssl_st seems bad manners.

- MSVC complains about ambiguous names if one typedefs SSL to bssl::SSL.

This CL opts for:

- ssl/*.cc must begin with #define BORINGSSL_INTERNAL_CXX_TYPES. This
  informs the public headers to create forward declarations which are
  compatible with our namespaces.

- For now, C++-defined type FOO ends up at bssl::FOO with a typedef
  outside. Later I imagine we'll rename many of them.

- Internal functions get namespace bssl, so we stop worrying about
  stomping the tls1_prf symbol. Exported C functions are stuck as they
  are. Rather than try anything weird, bite the bullet and reorder files
  which have a mix of public and private functions. I expect that over
  time, the public functions will become fairly small as we move logic
  to more idiomatic C++.

  Files without any public C functions can just be written normally.

- To avoid MSVC troubles, some bssl types are renamed to CPlusPlusStyle
  in advance of them being made idiomatic C++.

Bug: 132
Change-Id: Ic931895e117c38b14ff8d6e5a273e868796c7581
Reviewed-on: https://boringssl-review.googlesource.com/18124
Reviewed-by: David Benjamin <davidben@google.com>
2017-07-19 19:10:59 +00:00
..
runner Add ClientHello no_session_id variant. 2017-07-18 19:58:10 +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 Replace Scoped* heap types with bssl::UniquePtr. 2016-09-01 22:22:54 +00:00
bssl_shim.cc Move libssl's internals into the bssl namespace. 2017-07-19 19:10:59 +00:00
CMakeLists.txt Add malloc test support to unit tests. 2015-05-21 17:59:48 +00:00
fuzzer.h Fix TLS 1.3 variant fuzzers. 2017-07-14 20:21:24 +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 Adding PORTING.md for instructions on how to port the test runner 2016-08-16 17:53:28 +00:00
test_config.cc Add async certificate verification callback. 2017-07-17 20:55:23 +00:00
test_config.h Add async certificate verification callback. 2017-07-17 20:55:23 +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.