Commit 453dfd8d authored by Emilia Kasper's avatar Emilia Kasper
Browse files

New SSL test framework 



Currently, SSL tests are configured via command-line switches to
ssltest.c. This results in a lot of duplication between ssltest.c and
apps, and a complex setup. ssltest.c is also simply old and needs
maintenance.

Instead, we already have a way to configure SSL servers and clients, so
we leverage that. SSL tests can now be configured from a configuration
file. Test servers and clients are configured using the standard
ssl_conf module. Additional test settings are configured via a test
configuration.

Moreover, since the CONF language involves unnecessary boilerplate, the
test conf itself is generated from a shorter Perl syntax.

The generated testcase files are checked in to the repo to make
it easier to verify that the intended test cases are in fact run; and to
simplify debugging failures.

To demonstrate the approach, min/max protocol tests are converted to the
new format. This change also fixes MinProtocol and MaxProtocol
handling. It was previously requested that an SSL_CTX have both the
server and client flags set for these commands; this clearly can never work.

Guide to this PR:
 - test/ssl_test.c - test framework
 - test/ssl_test_ctx.* - test configuration structure
 - test/handshake_helper.* - new SSL test handshaking code
 - test/ssl-tests/ - test configurations
 - test/generate_ssl_tests.pl - script for generating CONF-style test
   configurations from perl inputs

Reviewed-by: default avatarRichard Levitte <levitte@openssl.org>
parent 173f613b

Configurations/unix-Makefile.tmpl

+7 −2
Original line number Diff line number Diff line
@@ -711,7 +711,8 @@ dist: 


# Helper targets #####################################################



link-utils: $(BLDDIR)/util/opensslwrap.sh $(BLDDIR)/util/shlib_wrap.sh

link-utils: $(BLDDIR)/util/opensslwrap.sh $(BLDDIR)/util/shlib_wrap.sh \

	    $(BLDDIR)/test/generate_ssl_tests.pl



$(BLDDIR)/util/opensslwrap.sh: configdata.pm

	@if [ "$(SRCDIR)" != "$(BLDDIR)" ]; then \
@@ -723,7 +724,11 @@ $(BLDDIR)/util/shlib_wrap.sh: configdata.pm 
	    mkdir -p "$(BLDDIR)/util"; \

	    ln -sf "../$(SRCDIR)/util/shlib_wrap.sh" "$(BLDDIR)/util"; \

	fi



$(BLDDIR)/test/generate_ssl_tests.pl: configdata.pm

	@if [ "$(SRCDIR)" != "$(BLDDIR)" ]; then \

	    mkdir -p "$(BLDDIR)/test"; \

	    ln -sf "../$(SRCDIR)/test/generate_ssl_tests.pl" "$(BLDDIR)/test"; \

	fi

FORCE:



# Building targets ###################################################

ssl/ssl_conf.c

+2 −2
Original line number Diff line number Diff line
@@ -594,8 +594,8 @@ static const ssl_conf_cmd_tbl ssl_conf_cmds[] = { 
#endif

    SSL_CONF_CMD_STRING(CipherString, "cipher", 0),

    SSL_CONF_CMD_STRING(Protocol, NULL, 0),

    SSL_CONF_CMD_STRING(MinProtocol, "min_protocol", SSL_CONF_FLAG_SERVER | SSL_CONF_FLAG_CLIENT),

    SSL_CONF_CMD_STRING(MaxProtocol, "max_protocol", SSL_CONF_FLAG_SERVER | SSL_CONF_FLAG_CLIENT),

    SSL_CONF_CMD_STRING(MinProtocol, "min_protocol", 0),

    SSL_CONF_CMD_STRING(MaxProtocol, "max_protocol", 0),

    SSL_CONF_CMD_STRING(Options, NULL, 0),

    SSL_CONF_CMD_STRING(VerifyMode, NULL, 0),

    SSL_CONF_CMD(Certificate, "cert", SSL_CONF_FLAG_CERTIFICATE,

test/Makefile.in

+22 −4
Original line number Diff line number Diff line
@@ -85,6 +85,8 @@ CTTEST= ct_test 
THREADSTEST=	threadstest

AFALGTEST= afalgtest

D2ITEST = d2i_test

SSLTESTCTXTEST = ssl_test_ctx_test

NEWSSLTEST = ssl_test



TESTS=		alltests
@@ -107,7 +109,8 @@ EXE= $(NPTEST)$(EXE_EXT) $(MEMLEAKTEST)$(EXE_EXT) \ 
	$(CONSTTIMETEST)$(EXE_EXT) $(VERIFYEXTRATEST)$(EXE_EXT) \

	$(CLIENTHELLOTEST)$(EXE_EXT) $(PACKETTEST)$(EXE_EXT) $(ASYNCTEST)$(EXE_EXT) \

	$(DTLSV1LISTENTEST)$(EXE_EXT) $(CTTEST)$(EXE_EXT) $(THREADSTEST)$(EXE_EXT) \

	$(AFALGTEST)$(EXE_EXT) $(D2ITEST)$(EXE_EXT)

	$(AFALGTEST)$(EXE_EXT) $(D2ITEST)$(EXE_EXT) $(SSLTESTCTXTEST)$(EXE_EXT) \

	$(NEWSSLTEST)$(EXE_EXT)



# $(METHTEST)$(EXE_EXT)
@@ -125,7 +128,8 @@ OBJ= $(NPTEST).o $(MEMLEAKTEST).o \ 
	$(HEARTBEATTEST).o $(P5_CRPT2_TEST).o \

	$(CONSTTIMETEST).o $(VERIFYEXTRATEST).o $(CLIENTHELLOTEST).o \

	$(PACKETTEST).o $(ASYNCTEST).o $(DTLSV1LISTENTEST).o $(CTTEST).o \

	$(THREADSTEST).o testutil.o $(AFALGTEST).o $(D2ITEST).o

	$(THREADSTEST).o testutil.o $(AFALGTEST).o $(D2ITEST).o ssl_test_ctx.o \

	$(SSLTESTCTXTEST).o $(NEWSSLTEST).o handshake_helper.o



SRC=	$(NPTEST).c $(MEMLEAKTEST).c \

	$(BNTEST).c $(ECTEST).c \
@@ -140,9 +144,10 @@ SRC= $(NPTEST).c $(MEMLEAKTEST).c \ 
	$(HEARTBEATTEST).c $(P5_CRPT2_TEST).c \

	$(CONSTTIMETEST).c $(VERIFYEXTRATEST).c $(CLIENTHELLOTEST).c \

	$(PACKETTEST).c $(ASYNCTEST).c $(DTLSV1LISTENTEST).c $(CTTEST).c \

	$(THREADSTEST).c testutil.c $(AFALGTEST).c $(D2ITEST).c

	$(THREADSTEST).c testutil.c $(AFALGTEST).c $(D2ITEST).c ssl_test_ctx.c \

	$(SSLTESTCTXTEST).c $(NEWSSLTEST).c handshake_helper.c



HEADER=	testutil.h

HEADER=	testutil.h ssl_test_ctx.h handshake_helper.h



ALL=	$(GENERAL) $(SRC) $(HEADER)
@@ -389,4 +394,17 @@ $(AFALGTEST)$(EXE_EXT): $(AFALGTEST).o $(DLIBCRYPTO) 
$(D2ITEST)$(EXE_EXT): $(D2ITEST).o $(DLIBCRYPTO) testutil.o

	@target=$(D2ITEST) testutil=testutil.o; $(BUILD_CMD)



$(SSLTESTCTXTEST)$(EXE_EXT): $(SSLTESTCTXTEST).o testutil.o $(DLIBCRYPTO)

	@target=$(SSLTESTCTXTEST); $(BUILD_CMD)



$(SSLTESTCTXTEST)$(EXE_EXT): $(SSLTESTCTXTEST).o testutil.o ssl_test_ctx.o \

	$(DLIBCRYPTO)

	@target=$(SSLTESTCTXTEST) testutil="testutil.o ssl_test_ctx.o"; \

	$(BUILD_CMD)



$(NEWSSLTEST)$(EXE_EXT): $(NEWSSLTEST).o testutil.o ssl_test_ctx.o \

	handshake_helper.o $(DLIBSSL) $(DLIBCRYPTO)

	@target=$(NEWSSLTEST) testutil="testutil.o ssl_test_ctx.o \

	handshake_helper.o"; $(BUILD_CMD)



# DO NOT DELETE THIS LINE -- make depend depends on it.

test/README.ssltest.md

0 → 100644
+139 −0
Original line number Diff line number Diff line 
# 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.



## 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",

}

```



### 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.

test/build.info

+12 −1
Original line number Diff line number Diff line
@@ -14,7 +14,8 @@ PROGRAMS=\ 
        danetest heartbeat_test p5_crpt2_test \

        constant_time_test verify_extra_test clienthellotest \

        packettest asynctest secmemtest srptest memleaktest \

        dtlsv1listentest ct_test threadstest afalgtest d2i_test

        dtlsv1listentest ct_test threadstest afalgtest d2i_test \

        ssl_test_ctx_test ssl_test



SOURCE[aborttest]=aborttest.c

INCLUDE[aborttest]={- rel2abs(catdir($builddir,"../include")) -} ../include
@@ -224,4 +225,14 @@ SOURCE[d2i_test]=d2i_test.c testutil.c 
INCLUDE[d2i_test]={- rel2abs(catdir($builddir,"../include")) -} .. ../include

DEPEND[d2i_test]=../libcrypto



SOURCE[ssl_test_ctx_test]=ssl_test_ctx_test.c ssl_test_ctx.c testutil.c

INCLUDE[ssl_test_ctx_test]={- rel2abs(catdir($builddir,"../include")) -} .. ../include

DEPEND[ssl_test_ctx_test]=../libcrypto



SOURCE[ssl_test]=ssl_test.c ssl_test_ctx.c testutil.c handshake_helper.c

INCLUDE[ssl_test]={- rel2abs(catdir($builddir,"../include")) -} .. ../include

DEPEND[ssl_test]=../libcrypto ../libssl



INCLUDE[testutil.o]=..

INCLUDE[ssl_test_ctx.o]={- rel2abs(catdir($builddir,"../include")) -} ../include

INCLUDE[handshake_helper.o]={- rel2abs(catdir($builddir,"../include")) -} ../include