openssl/test
Dr. Stephen Henson 198d805900 Add SRP test vectors from RFC5054
Reviewed-by: Rich Salz <rsalz@openssl.org>
2016-10-01 13:46:54 +01:00
..
certs
ct
d2i-tests
ocsp-tests
recipes Add DTLS renegotiation tests 2016-09-28 09:15:07 +01:00
smime-certs spelling fixes, just comments and readme. 2016-08-05 19:07:30 -04:00
ssl-tests Add DTLS renegotiation tests 2016-09-28 09:15:07 +01:00
testlib/OpenSSL
aborttest.c
afalgtest.c
asynciotest.c Split create_ssl_connection() 2016-08-19 13:52:40 +01:00
asynctest.c
bad_dtls_test.c Kill PACKET_starts() from bad_dtls_test 2016-08-10 12:50:51 +01:00
bftest.c
bio_enc_test.c Fix bio_enc_test 2016-08-23 09:24:29 +01:00
bioprinttest.c
bntest.c Add a basic test for BN_bn2dec. 2016-09-26 11:03:37 -04:00
build.info Add tests for the WPACKET implementation 2016-09-13 09:41:21 +01:00
CAss.cnf
CAssdh.cnf
CAssdsa.cnf
CAssrsa.cnf
casttest.c
CAtsa.cnf
cipherlist_test.c To avoid SWEET32 attack, move 3DES to weak 2016-08-24 14:05:52 +01:00
clienthellotest.c Fix clienthellotest to use PACKET functions 2016-08-10 12:50:51 +01:00
cms-examples.pl
constant_time_test.c
ct_test.c Add -Wswitch-enum 2016-09-22 08:36:26 -04:00
d2i_test.c add item list support to d2i_test 2016-09-29 16:21:46 +01:00
danetest.c
danetest.in
danetest.pem
destest.c spelling fixes, just comments and readme. 2016-08-05 19:07:30 -04:00
dhtest.c
dsatest.c
dtlstest.c Choose a ciphersuite for testing that won't be affected by "no-*" options 2016-08-22 13:52:02 +01:00
dtlsv1listentest.c Simplify and rename SSL_set_rbio() and SSL_set_wbio() 2016-07-29 14:09:57 +01:00
ecdhtest_cavs.h
ecdhtest.c
ecdsatest.c spelling fixes, just comments and readme. 2016-08-05 19:07:30 -04:00
ectest.c Fix a memory leak in EC_GROUP_get_ecparameters() 2016-08-22 15:10:03 +01:00
enginetest.c
evp_extra_test.c
evp_test.c Check for bad filename in evp_test 2016-08-12 14:04:53 -04:00
evptests.txt Update X25519 key format in evptests.txt 2016-08-13 14:11:05 +01:00
exdatatest.c
exptest.c Change callers to use the new constants. 2016-08-10 10:07:37 -04:00
generate_buildtest.pl Move the building of test/buildtest_*. to be done unconditionally 2016-08-05 21:17:05 +02:00
generate_ssl_tests.pl Reorganize SSL test structures 2016-08-08 12:06:26 +02:00
gmdifftest.c
handshake_helper.c Extend the renegotiation tests 2016-09-28 09:15:07 +01:00
handshake_helper.h Test that the peers send at most one fatal alert 2016-08-18 12:49:32 +02:00
heartbeat_test.c
hmactest.c
ideatest.c
igetest.c
md2test.c
md4test.c
md5test.c
mdc2test.c
memleaktest.c
methtest.c
p5_crpt2_test.c
P1ss.cnf
P2ss.cnf
packettest.c
pbelutest.c
pkcs7-1.pem
pkcs7.pem
pkits-test.pl
r160test.c
randtest.c
rc2test.c
rc4test.c
rc5test.c
README Add a test for 'openssl passwd' 2016-09-14 00:30:50 +02:00
README.ssltest.md Extend the renegotiation tests 2016-09-28 09:15:07 +01:00
rmdtest.c
rsa_test.c
run_tests.pl Add a more versatile test chooser 2016-09-01 20:58:40 +02:00
sanitytest.c
secmemtest.c
serverinfo.pem
sha1test.c
sha256t.c
sha512t.c
shibboleth.pfx Add PKCS#12 UTF-8 interoperability test. 2016-08-22 13:52:51 +02:00
smcont.txt test/smcont.txt: trigger assertion in bio_enc.c. 2016-07-31 17:03:17 +02:00
srptest.c Add SRP test vectors from RFC5054 2016-10-01 13:46:54 +01:00
ssl_test_ctx_test.c Add some CertStatus tests 2016-08-30 14:49:10 +01:00
ssl_test_ctx_test.conf Port multi-buffer tests 2016-08-18 12:46:00 +02:00
ssl_test_ctx.c Extend the renegotiation tests 2016-09-28 09:15:07 +01:00
ssl_test_ctx.h Extend the renegotiation tests 2016-09-28 09:15:07 +01:00
ssl_test.c Test that the peers send at most one fatal alert 2016-08-18 12:49:32 +02:00
ssl_test.tmpl test/ssl_test.tmpl: make it work with elderly perl. 2016-08-16 12:43:44 +02:00
sslapitest.c Fix no-dtls 2016-09-29 09:52:31 +01:00
ssltest_old.c Constify char* input parameters in apps code 2016-08-17 17:09:19 +01:00
ssltestlib.c Fix some mem leaks in sslapitest 2016-09-26 17:26:50 +01:00
ssltestlib.h Fix some clang warnings 2016-08-19 13:52:40 +01:00
Sssdsa.cnf
Sssrsa.cnf
test.cnf
testcrl.pem
testdsa.pem
testdsapub.pem
testec-p256.pem
testecpub-p256.pem
testp7.pem
testreq2.pem
testrsa.pem
testrsapub.pem
testsid.pem
testutil.c
testutil.h Add TEST_check 2016-08-10 14:41:21 +02:00
testx509.pem
threadstest.c
Uss.cnf
v3-cert1.pem
v3-cert2.pem
v3ext.c
v3nametest.c
verify_extra_test.c
wp_test.c
wpackettest.c Convert WPACKET_put_bytes to use convenience macros 2016-09-20 14:47:44 +01:00
x509aux.c test/x509aux.c: Fix argv loop 2016-09-21 16:19:22 +02:00

How to add recipes
==================

For any test that you want to perform, you write a script located in
test/recipes/, named {nn}-test_{name}.t, where {nn} is a two digit number and
{name} is a unique name of your choice.

Please note that if a test involves a new testing executable, you will need to
do some additions in test/Makefile.  More on this later.


Naming conventions
=================

A test executable is named test/{name}test.c

A test recipe is named test/recipes/{nn}-test_{name}.t, where {nn} is a two
digit number and {name} is a unique name of your choice.

The number {nn} is (somewhat loosely) grouped as follows:

05  individual symmetric cipher algorithms
10  math (bignum)
15  individual asymmetric cipher algorithms
20  openssl commands (some otherwise not tested)
25  certificate forms, generation and verification
30  engine and evp
70  PACKET layer
80  "larger" protocols (CA, CMS, OCSP, SSL, TSA)
90  misc


A recipe that just runs a test executable
=========================================

A script that just runs a program looks like this:

    #! /usr/bin/perl
    
    use OpenSSL::Test::Simple;
    
    simple_test("test_{name}", "{name}test", "{name}");

{name} is the unique name you have chosen for your test.

The second argument to `simple_test' is the test executable, and `simple_test'
expects it to be located in test/

For documentation on OpenSSL::Test::Simple, do
`perldoc test/testlib/OpenSSL/Test/Simple.pm'.


A recipe that runs a more complex test
======================================

For more complex tests, you will need to read up on Test::More and
OpenSSL::Test.  Test::More is normally preinstalled, do `man Test::More' for
documentation.  For OpenSSL::Test, do `perldoc test/testlib/OpenSSL/Test.pm'.

A script to start from could be this:

    #! /usr/bin/perl
    
    use strict;
    use warnings;
    use OpenSSL::Test;
    
    setup("test_{name}");
    
    plan tests => 2;                # The number of tests being performed
    
    ok(test1, "test1");
    ok(test2, "test1");
    
    sub test1
    {
        # test feature 1
    }
    
    sub test2
    {
        # test feature 2
    }
    

Changes to test/Makefile
========================

Whenever a new test involves a new test executable you need to do the
following (at all times, replace {NAME} and {name} with the name of your
test):

* among the variables for test executables at the beginning, add a line like
  this:

    {NAME}TEST= {name}test

* add `$({NAME}TEST)$(EXE_EXT)' to the assignment of EXE:

* add `$({NAME}TEST).o' to the assignment of OBJ:

* add `$({NAME}TEST).c' to the assignment of SRC:

* add the following lines for building the executable:

    $({NAME}TEST)$(EXE_EXT): $({NAME}TEST).o $(DLIBCRYPTO)
           @target=$({NAME}TEST); $(BUILD_CMD)