From b18019c4b26c5cba87e1492fc40602d234c41749 Mon Sep 17 00:00:00 2001 From: Kris Kwiatkowski Date: Thu, 25 Mar 2021 00:46:19 +0000 Subject: [PATCH] update readme with building instructions --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index accb3b87..bbaaef37 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ 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 @@ -37,3 +39,30 @@ 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 + + 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)); + + 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()); +``` + +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. \ No newline at end of file