Open Quantum Safe interop test server for quantum-safe cryptography

Purpose

This server is an NGINX instance enhanced with support for quantum-safe cryptography (QSC) using software packages provided by the Open Quantum Safe project (OQS).

In order to provide a means for clients to test interoperability with this QSC-enhanced software and the QSC algorithms contained it features separate ports for all QSC signature/key exchange algorithm combinations supported by the current OQS distribution.

Specification details

This nginx server supports

• the TLS1.3 specification with QSC enhancement as specified in https://tools.ietf.org/html/draft-ietf-tls-hybrid-design-06.
• Code points/curve IDs of KEM algorithms are implemented with the highest numbers available for each algorithm listed here.
• Code points/OIDs of SIG algorithms are implemented with the highest numbers available for each algorithm as listed here.

This corresponds to the OQS release version 0.16.0 and oqs-provider version 0.12.0-rc2-branch.

These specifications should not be taken as a standard, de facto and otherwise, and are subject to change at any time.

More details are available at Github.

Caveats

1. This test server by no means should be taken as containing production-ready software. See disclaimer. Its purpose is simply to provide a best-effort facility to allow anyone to "test-drive" QSC software packages including testing protocol level interoperability.
2. When using the OQS-enabled Chromium build to access this web site, please heed its usage instructions.
3. When using the OQS-enabled GNOME Web/epiphany browser to access this web site, all ports can be accessed, provided the browser is suitably started enabling the algorithms of interest. Please read the documentation how to do this.

Certificates

Each test port provides TLS server authentication using a server certificate generated using the listed QSC-signature algorithm. All server certificates are signed by a common CA certificate using conventional (RSA) cryptography. This certificate is available for download here.

Testing procedure

While we cannot prescribe how this test infrastructure is used we can show how it can be utilized using the OQS software made available ready-build at Docker Hub adding suggestions how other QSC-TLS implementations could check interoperability.

1. If not already done, download the test CA certificate from here to the directory you want to execute your tests from.
2. Select the algorithm combination to be tested from the list below. Assume this is sig/kex (port).
3. Connect to the corresponding port with a QSC-enabled client side software, e.g., curl. Using a ready-made docker image this could be facilitated by running
   

   docker run -v `pwd`:/ca -it openquantumsafe/curl:0.16.0 curl --cacert /ca/CA.crt https://test.openquantumsafe.org:port --curves kex

   Be sure to insert the port and kex values chosen above.
   The test will be successful if a web page indicating successful connection establishment (and display of the OQS algorithm combination configured as well as the client-supported key exchange mechanism) is received.

Notes:

1. The instructions above assume a local installation of Docker.

2. Another equally valid approach would be to build all required software from source and then execute it locally. Examples for this can be found in the OQS Github repository.

   In this way, you could for example verify correct operation of all components using openssl's s_client function by running

   echo "GET /" | openssl s_client -CAfile CA.crt --connect test.openquantumsafe.org:port --curves kex

   Again, values for port and kex must be suitably set.

3. Using "openssl s_client" has the additional benefit that it also displays the actual algorithms utilized: Server Temp Key describes the key exchange algorithm and Peer signature type the signature algorithm actually used.
4. The OQS docker hub containers also provide a ready-made QSC-openssl distribution facilitating this test: You can do this for example with this command:

   docker run -v `pwd`:/ca -it openquantumsafe/curl:0.16.0 openssl s_client --connect test.openquantumsafe.org:6000 -CAfile /ca/CA.crt 

   Then issue the GET / command on the command line to retrieve an information page.
5. The OQS docker images are pre-loaded with the test CA certificate which allow simplified testing bypassing the need to first obtain the test CA certificate and mounting this into the docker image. Therefore, testing a specific algorithm can be done simply without any preparation by running
   

   docker run -it openquantumsafe/curl:0.16.0 curl --cacert /opt/oqssa/oqs-testca.pem https://test.openquantumsafe.org:port --curves kex

List of all supported QSC Signature / Key Exchange algorithms

The list below provides links to the entry points of all OQS signature / key exchange algorithm combinations supported.

For automated testing, a JSON file encoding all available SIG/KEM combinations and the respective ports where they can be found is available for download here. We explicitly want to warn that algorithm/port combinations are subject to change. Be sure to download the most current JSON file before testing.

Note: The designator "*" below for key exchange algorithms should not be understood that the port referenced supports any possible KEM, but only all those KEMs configured into the underlying nginx server as default groups. This can be set when building the server via the DEFAULT_GROUPS configuration option. The default algorithm list is:

x25519:x448:prime256v1:secp384r1:secp521r1:kyber512:x25519_kyber768:p256_kyber512:kyber768:p384_kyber768:kyber1024:p521_kyber1024.