openssl/test
Benjamin Kaduk 62b0a0dea6 Fix memory leaks in CTLOG_new_from_base64
Move the call to ct_base64_decode(), which allocates, until after
the check for NULL output parameter.

Also place a cap on the number of padding characters used to decrement
the output length -- any more than two '='s is not permitted in a
well-formed base64 text.  Prior to this change, ct_base64_decode() would
return a length of -1 along with allocated storage for an input of
"====".

Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3379)
2017-06-09 13:32:29 -04:00
..
certs Add test cases for X509_check_private_key 2017-06-06 17:50:06 +01:00
ct
d2i-tests
ocsp-tests
ossl_shim Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
recipes Add test cases for X509_check_private_key 2017-06-06 17:50:06 +01:00
smime-certs
ssl-tests Fix #2400 Add NO_RENEGOTIATE option 2017-06-06 22:39:41 +01:00
testlib Add a test for supported_groups in the EE message 2017-05-08 11:09:02 +01:00
testutil Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
aborttest.c
afalgtest.c
asn1_encode_test.c test/asn1_encode_test.c: test "next negative minimum" corner case. 2017-04-30 15:18:47 +02:00
asn1_internal_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
asynciotest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
asynctest.c
bad_dtls_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
bftest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
bio_enc_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
bioprinttest.c Randomise the ordering of the C unit tests. 2017-05-15 14:47:51 +02:00
bnexp.txt Use BIO not FILE for test file 2017-05-15 20:39:15 -04:00
bnmod.txt Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
bnmul.txt Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
bnshift.txt Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
bnsum.txt Use BIO not FILE for test file 2017-05-15 20:39:15 -04:00
bntest.c Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
bntests.pl
build.info Add test cases for X509_check_private_key 2017-06-06 17:50:06 +01:00
CAss.cnf
CAssdh.cnf
CAssdsa.cnf
CAssrsa.cnf
casttest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
CAtsa.cnf Added support for ESSCertIDv2 2017-05-03 09:04:23 +02:00
chacha_internal_test.c Address some -Wold-style-declaration warnings 2017-05-01 14:23:28 -04:00
cipher_overhead_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
cipherbytes_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
cipherlist_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
clienthellotest.c Fix a pedantic gcc-7 warning. 2017-04-28 15:04:08 +02:00
cms-examples.pl
constant_time_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
crltest.c Refactor crltest.c to separate the test cases into individual functions. 2017-04-28 16:03:35 +02:00
ct_test.c Fix memory leaks in CTLOG_new_from_base64 2017-06-09 13:32:29 -04:00
d2i_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
danetest.c Convert danetest, ssl_test_ctx_test 2017-05-02 08:32:26 -04:00
danetest.in
danetest.pem
destest.c Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
dhtest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
dsatest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
dtls_mtu_test.c Convert dtls_mtu_test, dtlsv1listentest 2017-04-26 12:20:44 -04:00
dtlstest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
dtlsv1listentest.c Convert dtls_mtu_test, dtlsv1listentest 2017-04-26 12:20:44 -04:00
ecdsatest.c Add BN support to the test infrastructure. 2017-05-09 21:30:29 +02:00
ectest.c Add BN support to the test infrastructure. 2017-05-09 21:30:29 +02:00
enginetest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
evp_extra_test.c Fix no-ec 2017-04-26 17:12:23 +01:00
evp_test.c Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
evp_test.h Add support for multiple update calls in evp_test 2017-05-19 21:02:24 +01:00
evpciph.txt Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
evpdigest.txt Add titles to groups of EVP tests 2017-05-23 11:21:25 -04:00
evpencod.txt Add titles to groups of EVP tests 2017-05-23 11:21:25 -04:00
evpkdf.txt Add titles to groups of EVP tests 2017-05-23 11:21:25 -04:00
evpmac.txt Add titles to groups of EVP tests 2017-05-23 11:21:25 -04:00
evppbe.txt Add titles to groups of EVP tests 2017-05-23 11:21:25 -04:00
evppkey.txt Use common STANZA for bn and exp tests 2017-06-05 13:41:30 -04:00
exdatatest.c Fix ex_data and session_dup issues 2017-06-02 12:11:38 -04:00
exptest.c Add BN support to the test infrastructure. 2017-05-09 21:30:29 +02:00
generate_buildtest.pl
generate_ssl_tests.pl
gmdifftest.c TAPify testutil 2017-04-25 15:43:04 +02:00
handshake_helper.c Handle the server refusing to reneg in a reneg_setup 2017-06-06 22:39:41 +01:00
handshake_helper.h
hmactest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
ideatest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
igetest.c Fix an uninit read in igetest 2017-05-04 15:43:25 +01:00
lhash_test.c Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
md2test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
mdc2_internal_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
mdc2test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
memleaktest.c
modes_internal_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
P1ss.cnf
P2ss.cnf
packettest.c Fix compile error/warning in packettest.c 2017-05-17 12:43:56 -04:00
pbelutest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
pemtest.c Add unit test for PEM_FLAG_ONLY_B64 2017-05-08 21:20:32 +02:00
pkcs7-1.pem
pkcs7.pem
pkey_meth_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
pkits-test.pl
poly1305_internal_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
randtest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
rc2test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
rc4test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
rc5test.c Fix tests of TEST tests, as it were 2017-05-04 12:08:48 -04:00
README Refactor the test framework testutil 2017-04-24 18:09:01 +02:00
README.external
README.ssltest.md
recordlentest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
rsa_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
run_tests.pl Fix use of "can_load()" in run_tests.pl. 2017-05-26 11:25:07 +02:00
sanitytest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
secmemtest.c Fix the mem_sec "small arena" 2017-05-22 11:06:35 +02:00
serverinfo2.pem Add a SERVERINFOV2 format test file 2017-05-03 14:37:42 +01:00
serverinfo.pem
session.pem
shibboleth.pfx
shlibloadtest.c Review feedback; use single main, #ifdef ADD_TEST 2017-05-12 14:30:08 -04:00
siphash_internal_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
smcont.txt
srptest.c Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
ssl_test_ctx_test.c Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
ssl_test_ctx_test.conf
ssl_test_ctx.c Add support to test_ssl_new for testing with DTLS over SCTP 2017-04-25 11:13:39 +01:00
ssl_test_ctx.h Add support to test_ssl_new for testing with DTLS over SCTP 2017-04-25 11:13:39 +01:00
ssl_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
ssl_test.tmpl
sslapitest.c Fix gcc-7 warnings. 2017-05-11 19:39:38 +02:00
sslcorrupttest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
ssltest_old.c
ssltestlib.c Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
ssltestlib.h
Sssdsa.cnf
Sssrsa.cnf
stack_test.c Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
test_test.c Reformat the string output to be more in line with the decisions made in #3465 2017-05-22 08:41:05 -04:00
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.h Fix a bundle of trailing spaces in several files 2017-06-09 12:04:10 -04:00
testx509.pem
threadstest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
time_offset_test.c Fix time offset calculation. 2017-05-02 10:38:54 +02:00
tls13encryptiontest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
tls13secretstest.c Update tls13secretstest test vectors for TLSv1.3 draft-20 2017-05-03 17:23:02 +01:00
uitest.c Adapt all test programs 2017-04-24 18:09:01 +02:00
Uss.cnf
v3-cert1.pem
v3-cert2.pem
v3ext.c Adapt all test programs 2017-04-24 18:09:01 +02:00
v3nametest.c Fix certificate version number in test 2017-05-29 16:35:43 +02:00
verify_extra_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
wpackettest.c Address some -Wold-style-declaration warnings 2017-05-01 14:23:28 -04:00
x509_check_cert_pkey_test.c Fix coding style 2017-06-06 17:51:54 +01:00
x509_dup_cert_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
x509_internal_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
x509_time_test.c Adapt all test programs 2017-04-24 18:09:01 +02:00
x509aux.c Adapt all test programs 2017-04-24 18:09:01 +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:

00-04  sanity, internal and essential API tests
05-09  individual symmetric cipher algorithms
10-14  math (bignum)
15-19  individual asymmetric cipher algorithms
20-24  openssl commands (some otherwise not tested)
25-29  certificate forms, generation and verification
30-35  engine and evp
60-79  APIs
   70  PACKET layer
80-89  "larger" protocols (CA, CMS, OCSP, SSL, TSA)
90-98  misc
99     most time consuming tests [such as test_fuzz]


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/build.info
==========================

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):

* add {name} to the list of programs under PROGRAMS_NO_INST

* create a three line description of how to build the test, you will have
to modify the include paths and source files if you don't want to use the
basic test framework:

    SOURCE[{name}]={name}.c
    INCLUDE[{name}]=.. ../include
    DEPEND[{name}]=../libcrypto libtestutil.a

Generic form of C test executables
==================================

    #include "testutil.h"

    static int my_test(void)
    {
        int testresult = 0;                 /* Assume the test will fail    */
        int observed;

        observed = function();              /* Call the code under test     */
        if (!TEST_int_equal(observed, 2))   /* Check the result is correct  */
            goto end;                       /* Exit on failure - optional   */

        testresult = 1;                     /* Mark the test case a success */
    end:
        cleanup();                          /* Any cleanup you require      */
        return testresult;
    }

    void register_tests(void)
    {
        ADD_TEST(my_test);                  /* Add each test separately     */
    }

You should use the TEST_xxx macros provided by testutil.h to test all failure
conditions.  These macros produce an error message in a standard format if the
condition is not met (and nothing if the condition is met).  Additional
information can be presented with the TEST_info macro that takes a printf
format string and arguments.  TEST_error is useful for complicated conditions,
it also takes a printf format string and argument.  In all cases the TEST_xxx
macros are guaranteed to evaluate their arguments exactly once.  This means
that expressions with side effects are allowed as parameters.  Thus,

    if (!TEST_ptr(ptr = OPENSSL_malloc(..)))

works fine and can be used in place of:

    ptr = OPENSSL_malloc(..);
    if (!TEST_ptr(ptr))

The former produces a more meaningful message on failure than the latter.