https://github.com/kriskwiatkowski/pqc
Reference implementations of post-quantum cryptographic primitives
https://github.com/kriskwiatkowski/pqc
c cryptography post-quantum rust
Last synced: 5 months ago
JSON representation
Reference implementations of post-quantum cryptographic primitives
- Host: GitHub
- URL: https://github.com/kriskwiatkowski/pqc
- Owner: kriskwiatkowski
- License: bsd-3-clause
- Created: 2021-03-24T12:48:09.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-08-27T19:59:07.000Z (10 months ago)
- Last Synced: 2025-09-05T04:38:50.533Z (10 months ago)
- Topics: c, cryptography, post-quantum, rust
- Language: C
- Homepage:
- Size: 5.41 MB
- Stars: 29
- Watchers: 0
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
# 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 and education. The code is derived from the submission to the NIST Post-Quantum Standardization, either directly or by leveraging [PQClean](https://github.com/PQClean/PQClean) project.
Users shouldn't expect any level of security provided by this code. Most of the code is unmaintained. The library is not meant to be used on production systems (or any other systems).
## Supported schemes
All schemes selected by NIST duing PQC standardization:
| Name | x86 optimized |
|--------------------------|------------|
| Kyber | x |
| Dilithium | x |
| Falcon | |
| SPHINCS+ SHA256/SHAKE256 | x |
KEM candidates for an additional round 4.
| Name | x86 optimized |
|--------------------------|------------|
| HQC-RMRS | x |
| McEliece | |
## Building
CMake is used to build the library:
```bash
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:
```c
#include
const params_t *p = pqc_kem_alg_by_id(KYBER512);
std::vector ct(ciphertext_bsz(p));
std::vector ss1(shared_secret_bsz(p));
std::vector ss2(shared_secret_bsz(p));
std::vector sk(private_key_bsz(p));
std::vector 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:
```bash
cd test/katrunner
curl http://amongbytes.com/~flowher/permalinks/kat.zip --output kat.zip
unzip kat.zip
cargo run -- --katdir KAT
```