openssl/test
Neil Horman d0e1a0ae70 RCU lock implementation
Introduce an RCU lock implementation as an alternative locking mechanism
to openssl.  The api is documented in the ossl_rcu.pod
file

Read side implementaiton is comparable to that of RWLOCKS:
ossl_rcu_read_lock(lock);
<
critical section in which data can be accessed via
ossl_derefrence
>
ossl_rcu_read_unlock(lock);

Write side implementation is:
ossl_rcu_write_lock(lock);
<
critical section in which data can be updated via
ossl_assign_pointer
and stale data can optionally be scheduled for removal
via ossl_rcu_call
>
ossl_rcu_write_unlock(lock);
...
ossl_synchronize_rcu(lock);

ossl_rcu_call fixup

Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22729)
2024-02-01 08:33:25 -05:00
..
certs
ct
d2i-tests
helpers
ocsp-tests
recipes Add some tests for various PKCS12 files with NULL ContentInfo 2024-01-25 15:27:43 +00:00
smime-certs
smime-eml
ssl-tests Set max protocol version for dtls renegotiation tests to dtls1.2 2024-01-03 12:25:00 +01:00
testutil
aborttest.c
acvp_test.c
acvp_test.inc
aesgcmtest.c
afalgtest.c
algorithmid_test.c
asn1_decode_test.c
asn1_dsa_internal_test.c
asn1_encode_test.c
asn1_internal_test.c
asn1_stable_parse_test.c Fix NULL pointer deref when parsing the stable section 2024-01-12 10:37:22 +01:00
asn1_string_table_test.c
asn1_time_test.c add test for provoking integer overflow in ossl_asn1_time_from_tm 2024-01-18 17:00:57 +01:00
asynciotest.c
asynctest.c
bad_dtls_test.c
bftest.c
bio_addr_test.c
bio_callback_test.c
bio_comp_test.c
bio_core_test.c
bio_dgram_test.c
bio_enc_test.c
bio_memleak_test.c
bio_prefix_text.c
bio_readbuffer_test.c
bio_tfo_test.c
bioprinttest.c
bn_internal_test.c
bn_rand_range.h
bntest.c
bntests.pl
build_wincrypt_test.c
build.info Fix NULL pointer deref when parsing the stable section 2024-01-12 10:37:22 +01:00
ca_internals_test.c
ca-and-certs.cnf
casttest.c
CAtsa.cnf
cc_dummy.c
cert_comp_test.c
chacha_internal_test.c
cipher_overhead_test.c
cipherbytes_test.c
cipherlist_test.c
ciphername_test.c
clienthellotest.c
cmactest.c
cmp_asn_test.c
cmp_client_test.c crypto/cmp/,apps/lib/cmp_mock_srv.c: various improvements on delayed delivery 2023-12-21 23:06:42 +01:00
cmp_ctx_test.c
cmp_hdr_test.c
cmp_msg_test.c
cmp_protect_test.c
cmp_server_test.c crypto/cmp/,apps/lib/cmp_mock_srv.c: various improvements on delayed delivery 2023-12-21 23:06:42 +01:00
cmp_status_test.c
cmp_vfy_test.c
cms-examples.pl
cmsapitest.c
conf_include_test.c
confdump.c
constant_time_test.c
context_internal_test.c
crltest.c
ct_test.c
ctype_internal_test.c
curve448_internal_test.c
d2i_test.c
dane-cross.in
danetest.c
danetest.in
danetest.pem
data2.bin
data.bin
decoder_propq_test.c
default-and-fips.cnf Make the activate setting more intuitive 2023-12-21 09:22:40 -05:00
default-and-legacy.cnf
default.cnf Make the activate setting more intuitive 2023-12-21 09:22:40 -05:00
defltfips_test.c
destest.c
dhkem_test.inc
dhtest.c
drbgtest.c
dsa_no_digest_size_test.c
dsatest.c
dtls_mtu_test.c
dtlstest.c
dtlsv1listentest.c
ec_internal_test.c
ecdsatest.c
ecdsatest.h
ecstresstest.c
ectest.c
endecode_test.c
endecoder_legacy_test.c
enginetest.c
errtest.c
event_queue_test.c
evp_extra_test2.c gate calling of evp_method_id on having a non-zero name id 2024-01-01 12:57:59 -05:00
evp_extra_test.c Add appropriate NULL checks in EVP_CIPHER api 2024-01-25 08:27:53 -05:00
evp_fetch_prov_test.c Make the activate setting more intuitive 2023-12-21 09:22:40 -05:00
evp_kdf_test.c validate requested key length in kdf_pbkdf1_do_derive 2024-01-03 10:05:49 -05:00
evp_libctx_test.c Add appropriate NULL checks in EVP_CIPHER api 2024-01-25 08:27:53 -05:00
evp_pkey_ctx_new_from_name.c
evp_pkey_dhkem_test.c
evp_pkey_dparams_test.c
evp_pkey_provided_test.c Check whether the pubkey exists in ossl_ecx_key_dup 2024-01-16 11:29:02 +01:00
evp_test.c fix missing null check in kdf_test_ctrl 2024-01-30 09:53:14 -05:00
evp_xof_test.c
exdatatest.c
exptest.c
ext_internal_test.c
fake_rsaprov.c
fake_rsaprov.h
fatalerrtest.c
ffc_internal_test.c
filterprov.c
filterprov.h
fips_version_test.c
fips-alt.cnf
fips-and-base.cnf
fips.cnf
generate_buildtest.pl
generate_ssl_tests.pl
gmdifftest.c
hexstr_test.c
hmactest.c
hpke_test.c
http_test.c
ideatest.c
igetest.c
insta_ca.cert.pem
insta.priv.pem
invalid-x509.cnf Validate config options during x509 extension creation 2024-01-05 13:20:34 -05:00
keymgmt_internal_test.c
legacy.cnf
lhash_test.c
list_test.c
localetest.c
mdc2_internal_test.c
mdc2test.c
membio_test.c
memleaktest.c
modes_internal_test.c
moduleloadtest.c
namemap_internal_test.c
nodefltctxtest.c
null.cnf
ocspapitest.c
ossl_store_test.c
p_minimal.c
p_test.c
packettest.c
pairwise_fail_test.c
param_build_test.c
params_api_test.c Check appropriate OSSL_PARAM_get_* functions for NULL 2024-01-09 16:56:55 +01:00
params_conversion_test.c
params_test.c Have OSSL_PARAM_allocate_from_text() fail on odd number of hex digits 2024-01-25 16:36:55 +01:00
pbelutest.c
pbetest.c
pem_read_depr_test.c
pemtest.c
pkcs7_test.c
pkcs7-1.pem
pkcs7.pem
pkcs12_api_test.c
pkcs12_format_test.c
pkey_meth_kdf_test.c
pkey_meth_test.c
pkits-test.pl
poly1305_internal_test.c
priority_queue_test.c
property_test.c
prov_config_test.c Detect and prevent recursive config parsing 2023-12-21 13:38:31 -05:00
provfetchtest.c
provider_default_search_path_test.c
provider_fallback_test.c
provider_internal_test.c
provider_internal_test.cnf.in
provider_pkey_test.c
provider_status_test.c
provider_test.c
proxy.cnf
punycode_test.c
quic_ackm_test.c
quic_cc_test.c
quic_cfq_test.c
quic_client_test.c
quic_fc_test.c
quic_fifd_test.c
quic_lcidm_test.c
quic_multistream_test.c Add QUIC stateless reset test 2024-01-31 08:45:56 -05:00
quic_newcid_test.c
quic_rcidm_test.c QUIC RCIDM: Minor updates 2024-01-11 11:16:27 +01:00
quic_record_test_util.h
quic_record_test.c QUIC QRL TEST: Remove dependency on legacy DEMUX-QRX routing 2023-12-21 08:12:00 +00:00
quic_srt_gen_test.c
quic_srtm_test.c
quic_stream_test.c
quic_tserver_test.c
quic_txp_test.c QUIC TXP TEST: Remove dependency on legacy DEMUX-QRX routing 2023-12-21 08:12:00 +00:00
quic_txpim_test.c
quic_wire_test.c
quicapitest.c
quicfaultstest.c
rand_status_test.c
rand_test.c
rc2test.c
rc4test.c
rc5test.c
rdcpu_sanitytest.c
README-dev.md
README-external.md
README.md
README.ssltest.md
recordlentest.c
recursive.cnf Detect and prevent recursive config parsing 2023-12-21 13:38:31 -05:00
rpktest.c
rsa_complex.c
rsa_mp_test.c
rsa_sp800_56b_test.c
rsa_test.c
rsa_x931_test.c
run_tests.pl Use GH action commands to group/collapse filtered output 2023-12-21 09:05:42 -05:00
safe_math_test.c
sanitytest.c
secmemtest.c
serverinfo2.pem
serverinfo.pem
servername_test.c
session.pem
sha_test.c
shibboleth.pfx
shlibloadtest.c
simpledynamic.c
simpledynamic.h
siphash_internal_test.c Uninitialized array variable 2024-01-19 14:04:11 +01:00
sm2_internal_test.c
sm3_internal_test.c
sm4_internal_test.c
smcont_zero.txt
smcont.bin
smcont.txt
sparse_array_test.c
srptest.c
ssl_cert_table_internal_test.c
ssl_ctx_test.c
ssl_handshake_rtt_test.c
ssl_old_test.c Correct ssl_old_test stream handling 2024-01-05 12:13:19 +01:00
ssl_test_ctx_test.c
ssl_test_ctx_test.cnf
ssl_test.c
ssl_test.tmpl
sslapitest.c Extend the testing of resetting/clearing an SSL connection 2024-01-31 10:10:55 +00:00
sslbuffertest.c
sslcorrupttest.c
stack_test.c
sysdefault.cnf
sysdefaulttest.c
test_asn1_parse.cnf
test_test.c
test.cnf
testcrl.pem
testdsa.pem
testdsapub.pem
testec-p112r1.pem
testec-p256.pem
testecpub-p256.pem
tested448.pem
tested448pub.pem
tested25519.pem
tested25519pub.pem
testp7.pem
testreq2.pem
testrsa2048.pem
testrsa2048pub.pem
testrsa_withattrs.der
testrsa_withattrs.pem
testrsa.pem
testrsapss.pem
testrsapssmandatory.pem
testrsapub.pem
testsid.pem
testutil.h
testx509.pem
threadpool_test.c
threadstest_fips.c
threadstest.c RCU lock implementation 2024-02-01 08:33:25 -05:00
threadstest.h
time_offset_test.c
time_test.c
timing_load_creds.c
tls13ccstest.c
tls13encryptiontest.c Add tests for return codes for EVP_CIPHER_CTX_get[block_size|iv_length] 2024-01-25 08:36:17 -05:00
tls13secretstest.c
tls-provider.c
trace_api_test.c
uitest.c
upcallstest.c
user_property_test.c
v3_ca_exts.cnf
v3-cert1.pem
v3-cert2.pem
v3ext.c
v3nametest.c
verify_extra_test.c
versions.c
wpackettest.c
x509_check_cert_pkey_test.c
x509_dup_cert_test.c
x509_internal_test.c
x509_load_cert_file_test.c Add X509_STORE_get1_objects 2024-01-15 16:29:54 +01:00
x509_test.c
x509_time_test.c
x509aux.c

Using OpenSSL Tests

After a successful build, and before installing, the libraries should be tested. Run:

$ make test                                      # Unix
$ mms test                                       ! OpenVMS
$ nmake test                                     # Windows

Warning: you MUST run the tests from an unprivileged account (or disable your privileges temporarily if your platform allows it).

If some tests fail, take a look at the section Test Failures below.

Test Failures

If some tests fail, look at the output. There may be reasons for the failure that isn't a problem in OpenSSL itself (like an OS malfunction or a Perl issue). You may want increased verbosity, that can be accomplished like this:

Full verbosity, showing full output of all successful and failed test cases (make macro VERBOSE or V):

$ make V=1 test                                  # Unix
$ mms /macro=(V=1) test                          ! OpenVMS
$ nmake V=1 test                                 # Windows

Verbosity on failed (sub-)tests only (VERBOSE_FAILURE or VF or REPORT_FAILURES):

$ make test VF=1

Verbosity on failed (sub-)tests, in addition progress on succeeded (sub-)tests (VERBOSE_FAILURE_PROGRESS or VFP or REPORT_FAILURES_PROGRESS):

$ make test VFP=1

If you want to run just one or a few specific tests, you can use the make variable TESTS to specify them, like this:

$ make TESTS='test_rsa test_dsa' test            # Unix
$ mms/macro="TESTS=test_rsa test_dsa" test       ! OpenVMS
$ nmake TESTS="test_rsa test_dsa" test           # Windows

And of course, you can combine (Unix examples shown):

$ make test TESTS='test_rsa test_dsa' VF=1
$ make test TESTS="test_cmp_*" VFP=1

You can find the list of available tests like this:

$ make list-tests                                # Unix
$ mms list-tests                                 ! OpenVMS
$ nmake list-tests                               # Windows

Have a look at the manual for the perl module Test::Harness to see what other HARNESS_* variables there are.

To report a bug please open an issue on GitHub, at https://github.com/openssl/openssl/issues.

For more details on how the make variables TESTS can be used, see section Running Selected Tests below.

Running Selected Tests

The make variable TESTS supports a versatile set of space separated tokens with which you can specify a set of tests to be performed. With a "current set of tests" in mind, initially being empty, here are the possible tokens:

 alltests      The current set of tests becomes the whole set of available
               tests (as listed when you do 'make list-tests' or similar).

 xxx           Adds the test 'xxx' to the current set of tests.

-xxx           Removes 'xxx' from the current set of tests.  If this is the
               first token in the list, the current set of tests is first
               assigned the whole set of available tests, effectively making
               this token equivalent to TESTS="alltests -xxx".

 nn            Adds the test group 'nn' (which is a number) to the current
               set of tests.

-nn            Removes the test group 'nn' from the current set of tests.
               If this is the first token in the list, the current set of
               tests is first assigned the whole set of available tests,
               effectively making this token equivalent to
               TESTS="alltests -xxx".

Also, all tokens except for "alltests" may have wildcards, such as *. (on Unix and Windows, BSD style wildcards are supported, while on VMS, it's VMS style wildcards)

Examples

Run all tests except for the fuzz tests:

$ make TESTS='-test_fuzz*' test

or, if you want to be explicit:

$ make TESTS='alltests -test_fuzz*' test

Run all tests that have a name starting with "test_ssl" but not those starting with "test_ssl_":

$ make TESTS='test_ssl* -test_ssl_*' test

Run only test group 10:

$ make TESTS='10' test

Run all tests except the slow group (group 99):

$ make TESTS='-99' test

Run all tests in test groups 80 to 99 except for tests in group 90:

$ make TESTS='[89]? -90' test

To run specific fuzz tests you can use for instance:

$ make test TESTS='test_fuzz_cmp test_fuzz_cms'

To stochastically verify that the algorithm that produces uniformly distributed random numbers is operating correctly (with a false positive rate of 0.01%):

$ ./util/wrap.sh test/bntest -stochastic

Running Tests in Parallel

By default the test harness will execute the selected tests sequentially. Depending on the platform characteristics, running more than one test job in parallel may speed up test execution. This can be requested by setting the HARNESS_JOBS environment variable to a positive integer value. This specifies the maximum number of test jobs to run in parallel.

Depending on the Perl version different strategies could be adopted to select which test recipes can be run in parallel. In recent versions of Perl, unless specified otherwise, any task can be run in parallel. Consult the documentation for TAP::Harness to know more.

To run up to four tests in parallel at any given time:

$ make HARNESS_JOBS=4 test

Random numbers in tests

Some tests use random numbers as part of the test. In some cases a test failure may occur for some random numbers, but not for others. The seed used for the rand number generator can be set via the OPENSSL_TEST_RAND_SEED environment variable. It can also be set via the OPENSSL_TEST_RAND_ORDER environment variable which additionally randomises the order tests are run in (see below).

When a test fails the test harness will display the seed used during the test (displaying either the OPENSSL_TEST_RAND_SEED or OPENSSL_TEST_RAND_ORDER environment variable value that must be used to recreate the results), e.g.

$ make OPENSSL_TEST_RAND_SEED=42 test

Randomisation of Test Ordering

By default, the test harness will execute tests in the order they were added. By setting the OPENSSL_TEST_RAND_ORDER environment variable to zero, the test ordering will be randomised. This additionally seeds the random number generator used within the tests as described in the section above. If a randomly ordered test fails, the seed value used will be reported. Setting the OPENSSL_TEST_RAND_ORDER environment variable to this value will rerun the tests in the same order and will also seed the test random number generator. This assures repeatability of randomly ordered test runs. This repeatability is independent of the operating system, processor or platform used.

To randomise the test ordering:

$ make OPENSSL_TEST_RAND_ORDER=0 test

To run the tests using the order defined by the random seed 42:

$ make OPENSSL_TEST_RAND_ORDER=42 test