summaryrefslogtreecommitdiffstats
path: root/test/README-external.md
diff options
context:
space:
mode:
authorMichael Baentsch <info@baentsch.ch>2022-03-08 07:46:05 +0100
committerTomas Mraz <tomas@openssl.org>2022-03-09 17:57:37 +0100
commitfa66f62ebbb878bef5c34591efc82b24b9b88dff (patch)
tree502e869b3c48d4b5d567b67cfa64bc0261a23435 /test/README-external.md
parenta35c3a9f5be07c4c1bcabdd98ea56ff3ff20b645 (diff)
Add external testing with oqsprovider
Including running the oqsprovider external test in the CI external test build. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17832)
Diffstat (limited to 'test/README-external.md')
-rw-r--r--test/README-external.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/test/README-external.md b/test/README-external.md
index 3e10526b85..e1f4819fae 100644
--- a/test/README-external.md
+++ b/test/README-external.md
@@ -87,6 +87,39 @@ explicitly run (with more debugging):
$ make test VERBOSE=1 TESTS=test_external_gost_engine
+OQSprovider test suite
+======================
+
+Much like the PYCA/Cryptography test suite, this builds and runs the OQS
+(OpenQuantumSafe -- www.openquantumsafe.org) provider tests against the
+local OpenSSL build.
+
+You will need a git checkout of oqsprovider at the top level:
+
+ $ git submodule update --init
+
+Then configure/build OpenSSL enabling external tests:
+
+ $ ./config shared enable-external-tests
+ $ make
+
+oqsprovider requires CMake for the build process.
+
+OQSprovider tests will then be run as part of the rest of the suite, or can be
+explicitly run (with more debugging):
+
+ $ make test VERBOSE=1 TESTS=test_external_oqsprovider
+
+The environment variable `OQS_SKIP_TESTS` can be set to select tests and
+algorithms to be skipped. If not set, the "rainbow" algorithm set as well as
+the (OQS-)OpenSSL1.1.1 compatibility tests will not be executed. So, for
+example to exclude the "mceliece" and "kyber" algorithms execute
+
+ OQS_SKIP_TESTS=mceliece,kyber make test TESTS=test_external_oqsprovider
+
+The names of all supported quantum-safe algorithms are available at
+<https://github.com/open-quantum-safe/openssl#supported-algorithms>
+
Updating test suites
====================