pqc

Reference implementations of post-quantum cryptographic primitives

https://github.com/kriskwiatkowski/pqc

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.7%) to scientific vocabulary

Keywords

c cryptography post-quantum rust
Last synced: 6 months ago · JSON representation ·

Repository

Reference implementations of post-quantum cryptographic primitives

Basic Info
  • Host: GitHub
  • Owner: kriskwiatkowski
  • License: bsd-3-clause
  • Language: C
  • Default Branch: main
  • Homepage:
  • Size: 5.18 MB
Statistics
  • Stars: 29
  • Watchers: 0
  • Forks: 4
  • Open Issues: 3
  • Releases: 1
Topics
c cryptography post-quantum rust
Created almost 5 years ago · Last pushed about 2 years ago
Metadata Files
Readme License Citation Security

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 and education. 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. 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<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:

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

```

Owner

  • Name: Kris Kwiatkowski
  • Login: kriskwiatkowski
  • Kind: user
  • Location: London, UK

Citation (CITATION.cff)

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Kwiatkowski
    given-names: Kris
    orcid: https://orcid.org/0000-0003-2363-317X
title: "PQ Crypto Catalog"
version: v0.0.1
date-released: 2020-12-18
url: "https://github.com/kriskwiatkowski/pqc"

GitHub Events

Total
  • Watch event: 2
Last Year
  • Watch event: 2

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v1 composite
src/rustapi/pqc-sys/Cargo.toml cargo
test/katrunner/Cargo.toml cargo