Reference implementations of PQC
Go to file
2021-03-25 09:17:59 +00:00
.cmake KEM and Sign C-API 2021-03-24 21:06:56 +00:00
.github/workflows fix rust bindings 2021-03-25 00:08:14 +00:00
3rd adds benchmark tool 2021-03-24 23:50:01 +00:00
public/pqc pqapi.h -> pqc.h 2021-03-24 23:34:34 +00:00
src update rust binding creation 2021-03-25 00:46:02 +00:00
test fix some deteails in tests 2021-03-25 01:11:53 +00:00
.astylerc Disable AStyle line endings formatter 2019-03-06 17:15:24 +01:00
.gitattributes Fix tidy for signing 2019-01-16 13:02:35 +01:00
.gitignore Parallel tests (#206) 2019-07-29 10:38:25 +02:00
.gitmodules fix path to gbench 2021-03-24 23:58:58 +00:00
CMakeLists.txt change name of the librarry 2021-03-25 00:59:41 +00:00
LICENSE Create LICENSE 2021-03-25 09:17:59 +00:00
README.md Update README.md 2021-03-25 07:34:06 +00:00

PQ Crypto Catalog

This is a repository of post-quantum schemes coppied from the submission to the NIST Post-Quantum Standarization. The sources were cloned from the PQClean project to form new library. The goal of the library is mainly experimentation.

Users shouldn't expect any level of security provided by this code.

Schemes

Key Encapsulation Mechanisms

Finalists:

  • Kyber
  • NTRU
  • SABER

Alternate candidates:

  • FrodoKEM

Signature schemes

Finalists:

  • Dilithium
  • Falcon
  • Rainbow

Alternate candidates:

  • SPHINCS+

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>

    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));

    const params_t *p = pqc_kem_alg_by_id(KYBER512);
    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());
    
    const params_t *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 this directory.

Testing

Algorithms are tested against KATs, by the runner implemented in the teste/katrunner (wip). The runner uses katwalk crate.