diff --git a/README.md b/README.md index cfb4402817ff..21f76c76dc2d 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,8 @@ The following quantum-safe algorithms from liboqs are supported (assuming they h - `oqsdefault` (see [here](https://github.com/open-quantum-safe/openssh-portable/wiki/Using-liboqs-supported-algorithms-in-the-fork) for what this denotes) - **BIKE**:`bike1-l1-cpa`, `bike1-l3-cpa`, `bike1-l1-fo`, `bike2-l3-fo` - **Classic McEliece**: `classic-mceliece-348864`, `classic-mceliece-348864f`, `classic-mceliece-460896`, `classic-mceliece-460896f`, `classic-mceliece-6688128`, `classic-mceliece-6688128f`, `classic-mceliece-6960119`, `classic-mceliece-6960119f`, `classic-mceliece-8192128`, `classic-mceliece-8192128f` -- **FrodoKEM**:`frodo-640-aes`, `frodo-976-aes` +- **FrodoKEM**:`frodo-640-aes`, `frodo-976-aes`, `frodo-1344-aes` +- **HQC**: HQC-128-1-CCA2, HQC-192-1-CCA2, HQC-192-2-CCA2, HQC-256-1-CCA2†, HQC-256-2-CCA2†, HQC-256-3-CCA2† - **Kyber**:`kyber-512`, `kyber-768`, `kyber-1024`, `kyber-512-90s`, `kyber-768-90s`, `kyber-1024-90s` - **NewHope**:`newhope-512`, `newhope-1024` - **NTRU**:`ntru-hps-2048-509`, `ntru-hps-2048-677` @@ -71,6 +72,8 @@ The following hybrid algorithms are supported; they combine a quantum-safe algor - `ecdh-nistp384-`, where ```` is any one of the algorithms listed above. +Note that algorithms marked with a dagger (†) have large stack usage and may cause failures when run on threads or in constrained environments. + #### Digital Signature The following digital signature algorithms from liboqs are supported (assuming they have been enabled in liboqs). Note that only L1 signature and all **Rainbow** variants are enabled by default, and should you wish to enable additional variants, consult [the "Code Generation" section of the documentation in the wiki](https://github.com/open-quantum-safe/openssh/wiki/Using-liboqs-supported-algorithms-in-the-for://github.com/open-quantum-safe/openssh/wiki/Using-liboqs-supported-algorithms-in-the-fork#code-generation). @@ -91,6 +94,7 @@ The following hybrid algorithms are supported; they combine a quantum-safe algor - if `` has L3 security, the fork provides the method `p384-`, which combines `` with ECDSA using NIST's P384 curve. - if `` has L5 security, the fork provides the method `p521-`, which combines `` with ECDSA using NIST's P521 curve. + ## Quickstart The steps below have been confirmed to work on macOS 10.14 (clang 10.0.0) and Ubuntu 18.04.1 Bionic (gcc-7).