You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Henry Case e57a891583 frodo: move benchmarks to separated file 3 年之前
.cmake prevent updating llvm-project during 'make' 3 年之前
.github/workflows Test CT sanitizer and CTGRIND functionality 3 年之前
public/pqc adds McEliece 3 年之前
src CT checks for Frodo 3 年之前
test frodo: move benchmarks to separated file 3 年之前
.gitignore add benchmarking framework 3 年之前
CMakeLists.txt backport some changes from ct study 3 年之前
LICENSE Create LICENSE 3 年之前
README.md Update README.md 3 年之前
SECURITY.md Create SECURITY.md 3 年之前

README.md

PQ Crypto Catalog

Implementation of quantum-safe signature and KEM schemes submitted to NIST PQC Standardization Process.

The goal is to provide an easy-to-use API in C and Rust to enable experimentation. The code is derived from the submission to the NIST Post-Quantum Standardization, either directly or by leveraging PQClean project.

Users shouldn’t expect any level of security provided by this code. The library is not meant to be used on live production systems.

Supported schemes

Name NIST Round x86 optimized
Kyber 3 x
SABER 3 x
FrodoKEM 3
Dilithium 3 x
Falcon 3
SPHINCS+ SHA256/SHAKE256 3 x
NTRU 3 x
NTRU Prime 3 x
HQC-RMRS 3 x
Rainbow 3
SIKE/p434 3 x
McEliece 3

Building

CMake is used to build the library:

mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make

Build outputs two libraries, a static libpqc_s.a and dynamic libpqc.so, which can be linked with a project.

API

Library provides simple API, wrapping PQClean. For example to use KEM, one should call the library in following way:

    #include <pqc/pqc.h>

    const params_t *p = pqc_kem_alg_by_id(KYBER512);
    std::vector<uint8_t> ct(ciphertext_bsz(p));
    std::vector<uint8_t> ss1(shared_secret_bsz(p));
    std::vector<uint8_t> ss2(shared_secret_bsz(p));
    std::vector<uint8_t> sk(private_key_bsz(p));
    std::vector<uint8_t> pk(public_key_bsz(p));

    pqc_keygen(p, pk.data(), sk.data());
    pqc_kem_encapsulate(p, ct.data(), ss1.data(), pk.data());
    pqc_kem_decapsulate(p, ss2.data(), ct.data(), sk.data());

    p = pqc_sig_alg_by_id(DILITHIUM2);
    size_t sigsz = sig.capacity();
    pqc_keygen(p, pk.data(), sk.data());
    pqc_sig_create(p, sig.data(), &sigsz, msg.data(), msg.size(), sk.data());
    pqc_sig_verify(p, sig.data(), sig.size(), msg.data(), msg.size(), pk.data());

See test implemetnation in test/ut.cpp for more details.

Rust binding

Rust bindgings are provided in the src/rustapi/pqc-sys and can be regenerated automatically by running cargo build in that directory.

Testing against Known Answer Tests

Algorithms are tested against KATs, by the Rust-based runner implemented in the test/katrunner (only verification/decpaulation). The runner uses katwalk crate for parsing NIST format. To run it:

    cd test/katrunner
    curl http://amongbytes.com/~flowher/permalinks/kat.zip --output kat.zip
    unzip kat.zip
    cargo run -- --katdir KAT