This repository contains code to enable quantum-safe cryptography (QSC) in a standard OpenSSL (3.x) distribution by way of implementing a single shared library, the OQS provider.
Currently this provider fully enables quantum-safe cryptography for KEM key establishment in TLS1.3 including management of such keys via the OpenSSL (3.0) provider interface and hybrid KEM schemes. Also, QSC signatures including CMS and CMP functionality are available via the OpenSSL EVP interface. Key persistence is provided via the encode/decode mechanism, X.509 data structures, and PKCS#12 for bundling a private key with its corresponding X.509 certificate. Starting with OpenSSL 3.2 support for TLS1.3 signature functionality is available and final glitches for CMS have been resolved.
The standards implemented are documented in the separate file STANDARDS.md.
This implementation makes available the following quantum safe algorithms:
- BIKE:
bikel1,p256_bikel1,x25519_bikel1,bikel3,p384_bikel3,x448_bikel3,bikel5,p521_bikel5 - CRYSTALS-Kyber:
kyber512,p256_kyber512,x25519_kyber512,kyber768,p384_kyber768,x448_kyber768,x25519_kyber768,p256_kyber768,kyber1024,p521_kyber1024 - FrodoKEM:
frodo640aes,p256_frodo640aes,x25519_frodo640aes,frodo640shake,p256_frodo640shake,x25519_frodo640shake,frodo976aes,p384_frodo976aes,x448_frodo976aes,frodo976shake,p384_frodo976shake,x448_frodo976shake,frodo1344aes,p521_frodo1344aes,frodo1344shake,p521_frodo1344shake - HQC:
hqc128,p256_hqc128,x25519_hqc128,hqc192,p384_hqc192,x448_hqc192,hqc256,p521_hqc256† - ML-KEM:
mlkem512,p256_mlkem512,x25519_mlkem512,mlkem768,p384_mlkem768,x448_mlkem768,X25519MLKEM768,SecP256r1MLKEM768,mlkem1024,p521_mlkem1024,p384_mlkem1024
-
CRYSTALS-Dilithium:
dilithium2*,p256_dilithium2*,rsa3072_dilithium2*,dilithium3*,p384_dilithium3*,dilithium5*,p521_dilithium5* -
ML-DSA:
mldsa44*,p256_mldsa44*,rsa3072_mldsa44*,mldsa44_pss2048*,mldsa44_rsa2048*,mldsa44_ed25519*,mldsa44_p256*,mldsa44_bp256*,mldsa65*,p384_mldsa65*,mldsa65_pss3072*,mldsa65_rsa3072*,mldsa65_p256*,mldsa65_bp256*,mldsa65_ed25519*,mldsa87*,p521_mldsa87*,mldsa87_p384*,mldsa87_bp384*,mldsa87_ed448* -
Falcon:
falcon512*,p256_falcon512*,rsa3072_falcon512*,falconpadded512*,p256_falconpadded512*,rsa3072_falconpadded512*,falcon1024*,p521_falcon1024*,falconpadded1024*,p521_falconpadded1024* -
SPHINCS-SHA2:
sphincssha2128fsimple*,p256_sphincssha2128fsimple*,rsa3072_sphincssha2128fsimple*,sphincssha2128ssimple*,p256_sphincssha2128ssimple*,rsa3072_sphincssha2128ssimple*,sphincssha2192fsimple*,p384_sphincssha2192fsimple*,sphincssha2192ssimple,p384_sphincssha2192ssimple,sphincssha2256fsimple,p521_sphincssha2256fsimple,sphincssha2256ssimple,p521_sphincssha2256ssimple -
SPHINCS-SHAKE:
sphincsshake128fsimple*,p256_sphincsshake128fsimple*,rsa3072_sphincsshake128fsimple*,sphincsshake128ssimple,p256_sphincsshake128ssimple,rsa3072_sphincsshake128ssimple,sphincsshake192fsimple,p384_sphincsshake192fsimple,sphincsshake192ssimple,p384_sphincsshake192ssimple,sphincsshake256fsimple,p521_sphincsshake256fsimple,sphincsshake256ssimple,p521_sphincsshake256ssimple -
MAYO:
mayo1*,p256_mayo1*,mayo2*,p256_mayo2*,mayo3*,p384_mayo3*,mayo5*,p521_mayo5* -
CROSS:
CROSSrsdp128balanced*,CROSSrsdp128fast,CROSSrsdp128small,CROSSrsdp192balanced,CROSSrsdp192fast,CROSSrsdp192small,CROSSrsdp256small,CROSSrsdpg128balanced,CROSSrsdpg128fast,CROSSrsdpg128small,CROSSrsdpg192balanced,CROSSrsdpg192fast,CROSSrsdpg192small,CROSSrsdpg256balanced,CROSSrsdpg256fast,CROSSrsdpg256small
As the underlying liboqs
at build time may be configured to not enable all algorithms, it is
advisable to check the possible subset of algorithms actually enabled
via the standard commands, i.e.,
openssl list -signature-algorithms -provider oqsprovider and
openssl list -kem-algorithms -provider oqsprovider.
In addition, algorithms not denoted with "*" above are not enabled for TLS operations. This designation can be changed by modifying the "enabled" flags in the main algorithm configuration file.
In order to support parallel use of classic and quantum-safe cryptography this provider also provides different hybrid algorithms, combining classic and quantum-safe methods. There are two types of combinations: The Hybrids are listed above with a prefix denoting a classic algorithm, e.g., for elliptic curve: "p256_". The Composite are listed above with a suffix denoting a classic algorithm, e.g., for elliptic curve: "_p256".
A full list of algorithms, their interoperability code points and OIDs as well as a method to dynamically adapt them, e.g., for interoperability testing are documented in ALGORITHMS.md.
All component builds and testing described in detail below can be executed by
running the scripts scripts/fullbuild.sh and scripts/runtests.sh
respectively (tested on Linux Ubuntu and Mint as well as MacOS).
By default, these scripts always build and test against the current OpenSSL master branch.
These scripts can be configured by setting various variables. Please note that these scripts do not install oqsprovider. This can be facilitated by running cmake --install _build (and following the activation instructions.
The below describes the basic build-test-install cycle using the standard
cmake tooling. Platform-specific notes are available for UNIX
(incl. MacOS and cygwin) and Windows.
All options to configure oqs-provider at build- or run-time are documented
in CONFIGURE.md.
To be able to build oqsprovider, OpenSSL 3.0 and liboqs need to be installed.
It's not important where they are installed, just that they are. If installed
in non-standard locations, these must be provided when running cmake via
the variables "OPENSSL_ROOT_DIR" and "liboqs_DIR". See CONFIGURE.md
for details.
cmake -S . -B _build && cmake --build _build && ctest --test-dir _build && cmake --install _build
Usage of oqsprovider is documented in the separate USAGE.md file.
oqsprovider is written to ensure building on all versions of OpenSSL
supporting the provider concept. However, OpenSSL still is in active
development regarding features supported via the provider interface.
Therefore some functionalities documented above are only supported
with specific OpenSSL versions:
In these versions, CMS functionality implemented in providers is not supported: The resolution of openssl/openssl#17717 has not been not getting back-ported to OpenSSL3.0.
Also not supported in this version are provider-based signature algorithms used during TLS1.3 operations as documented in openssl/openssl#10512.
Also not fully supported in 3.0.2 is performance testing as per the openssl
speed command as documented in #385.
These versions have full support for all TLS1.3 operations using PQ algorithms
when deploying oqsprovider, particularly with regard to the use of signature
algorithms.
These versions are expected to support the openssl pkeyutl -encap/-decap
syntax for testing key encapsulation and decapsulation for test purposes. To
use this option, OQS provider should be built with
KEM encoding/decoding support.
Also new in this version is the possibility to retrieve all currently
active TLS signature algorithms via a new openssl list option:
openssl list -tls-signature-algorithms.
A limitation present in older OpenSSL versions is the number of default groups
supported: At most 44 default groups may be specified
, e.g., passing to SSL_CTX_set1_groups.
Therefore caution is advised activating all KEMs supported by oqsprovider
via the pre-build configuration facility:
This may lead to openssl crashing, depending on the OpenSSL version used:
The problem is gone in OpenSSL "master" branch and in the respective branches
since the releases 3.3.0, 3.2.2., 3.1.6 and 3.0.14.
A problem basically related to any TLS server installation is the observed limitation to 64 TLS signature algorithms by some TLS server implementations. Therefore, again caution is advised activating more than 64 PQ signature algorithms via the pre-build configuration facility.
Project governance is documented in GOVERNANCE.md and contribution policy is documented in CONTRIBUTING.md.
The policy of this project is that all discussions pertaining to changes in the
functional and non-functional aspects of oqsprovider shall take place in
github. References to external discussion fora are discouraged to retain the
free and open flow of thoughts unencumbered by potentially differing or changing
access or data retention policies by github-external chat forums.
Contributors to the oqsprovider include:
- Michael Baentsch (initial author and maintainer; responsible for all code except as listed per specific contributions below)
- Christian Paquin (original OpenSSL111 OQS integrator)
- Richard Levitte (OpenSSL provider wizard and initial
cmakesetup) - Basil Hess (hybrid KEM integration & pqcrystals/mayo OID management)
- Julian Segeth (some memory management improvements)
- Alex Zaslavsky (improvements on OpenSSL integration)
- Will Childs-Klein (improvements on Kyber hybrid OIDs)
- Thomas Bailleux (many build, CI and usage improvements for different platforms)
- Felipe Ventura (composite sig integration and OID management)
- Iyán Méndez Veiga (PKCS#12 testing)
- Alessandro Barenghi (CROSS OIDs)
Documentation on current and past releases ("code history") is documented in the separate file RELEASE.md.
oqsprovider came into existence as a branch of oqs-openssl
as part of the OQS project initially led by Douglas Stebila and Michele
Mosca at the University of Waterloo but split off to become a separate
project catering to the OpenSSL provider
concept. With OQS joining PQCA oqsprovider also
was folded into that organization.
The oqsprovider project had been supported through the NGI Assure Fund,
a fund established by NLnet with financial
support from the European Commission's Next Generation Internet programme,
under the aegis of DG Communications Networks, Content and Technology
under grant agreement No 957073.
Financial support for the development of Open Quantum Safe had been provided by Amazon Web Services and the Tutte Institute for Mathematics and Computing.
The OQS project would like to make a special acknowledgement to the companies who had dedicated programmer time to contribute source code to OQS, including Amazon Web Services, evolutionQ, Microsoft Research, Cisco Systems, and IBM Research.
Research projects which developed specific components of OQS have been supported by various research grants, including funding from the Natural Sciences and Engineering Research Council of Canada (NSERC); see here and here for funding acknowledgments.
THIS SOFTWARE IS PROVIDED WITH NO WARRANTIES, EXPRESS OR IMPLIED, AND ALL IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING ANY WARRANTY OF MERCHANTABILITY AND WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE.
This project follows the NIST PQC standardization process
and aims to support experimentation with the various PQC algorithms
under evaluation and in different stages of standardization by NIST.
oqsprovider at this time cannot claim or prove adherence to any
standards documents published. For more details, review the file
STANDARDS.md carefully. Most notably, hybrid and
composite implementations exclusively implemented in oqsprovider
are at a pre-standard/draft stage only. Over time the project aims
to provide standards compliance and solicits input by way of
contributions to achieve this state.
oqsprovider for the implementation of all pure PQC functionality
is completely dependent on liboqs and accordingly
cannot recommend any use beyond experimentation purposes:
WE DO NOT CURRENTLY RECOMMEND RELYING ON THIS SOFTWARE IN A PRODUCTION ENVIRONMENT OR TO PROTECT ANY SENSITIVE DATA. This software is meant to help with research and prototyping. While we make a best-effort approach to avoid security bugs, this library has not received the level of auditing and analysis that would be necessary to rely on it for high security use.
Further details and background available at: