boringssl/ssl/test
David Benjamin ce45588695 Speculatively remove __STDC_*_MACROS.
C99 added macros such as PRIu64 to inttypes.h, but it said to exclude them from
C++ unless __STDC_FORMAT_MACROS or __STDC_CONSTANT_MACROS was defined. This
text was never incorporated into any C++ standard and explicitly overruled in
C++11.

Some libc headers followed C99. Notably, glibc prior to 2.18
(https://sourceware.org/bugzilla/show_bug.cgi?id=15366) and old versions of the
Android NDK.

In the NDK, although it was fixed some time ago (API level 20), the NDK used to
use separate headers per API level. Only applications using minSdkVersion >= 20
would get the fix. Starting NDK r14, "unified" headers are available which,
among other things, make the fix available (opt-in) independent of
minSdkVersion. In r15, unified headers are opt-out, and in r16 they are
mandatory.

Try removing these and see if anyone notices. The former is past our five year
watermark. The latter is not and Android has hit
https://boringssl-review.googlesource.com/c/boringssl/+/32686 before, but
unless it is really widespread, it's probably simpler to ask consumers to
define __STDC_CONSTANT_MACROS and __STDC_FORMAT_MACROS globally.

Update-Note: If you see compile failures relating to PRIu64, UINT64_MAX, and
friends, update your glibc or NDK. As a short-term fix, add
__STDC_CONSTANT_MACROS and __STDC_FORMAT_MACROS to your build, but get in touch
so we have a sense of how widespread it is.

Bug: 198
Change-Id: I56cca5f9acdff803de1748254bc45096e4c959c2
Reviewed-on: https://boringssl-review.googlesource.com/c/33146
Reviewed-by: Adam Langley <agl@google.com>
Commit-Queue: Adam Langley <agl@google.com>
CQ-Verified: CQ bot account: commit-bot@chromium.org <commit-bot@chromium.org>
2018-11-14 16:14:37 +00:00
..
runner Add a per-SSL TLS 1.3 downgrade enforcement option and improve tests. 2018-10-10 19:50:19 +00:00
async_bio.cc
async_bio.h
bssl_shim.cc Speculatively remove __STDC_*_MACROS. 2018-11-14 16:14:37 +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
packeted_bio.h
PORTING.md
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 Make SSL_get_current_cipher valid during QUIC callbacks. 2018-11-06 19:04:48 +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.