streamlined-ntru-prime

Crates.iostreamlined-ntru-prime
lib.rsstreamlined-ntru-prime
version0.1.2
sourcesrc
created_at2018-11-22 04:23:32.395048
updated_at2018-11-22 04:30:12.189746
descriptionRust implementation of the Streamline NTRU Prime algorithm
homepage
repositoryhttps://github.com/MitchellBerry/streamlined-ntru-prime
max_upload_size
id98098
size832,165
Mitchell Berry (mberry)

documentation

https://docs.rs/crate/streamlined-ntru-prime/0.1.2

README

Streamlined NTRU Prime


Crates.io Build Status Crates.io dependency status

A rust implementation of Streamlined NTRU Prime 4591761

NTRU Prime is a lattice based cryptosystem aiming to improve the security of lattice schemes at minimal cost. It is thought to be resistant to quantum computing advances, in particular Shor's algorithm and is an entrant in NIST's Post Quantum Cryptography competition[1].

Please read the warnings before use.

The algorithm was authored by Daniel J. Bernstein, Chitchanok Chuengsatiansup, Tanja Lange & Christine van Vredendaal.

Contributions welcome. SIMD or WASM development especially.

Parameter set:

  • p = 761

  • q = 4591

  • w = 286

Outputs:

Type Bytes
Public Key 1218
Private Key 1600
Ciphertext 1047
Shared Key 32

Installation


Add as a dependency to cargo.toml

[dependencies]
streamlined_ntru_prime = "0.1.0"

Usage


use streamlined_ntru_prime::*;

// Key Generation
let (public_key, private_key) = generate_key();

// Encapsulation
let (cipher_text, shared_secret) = encapsulate(public_key);

// Decapsulation
let shared_secret = decapsulate(cipher_text, private_key).expect("Decapsulation failure")

Testing


To reduce compile time and size, testing is an optional feature.

# Testing
cargo test --features testing

# Benchmarking
cargo bench --features testing

Full output of generated and expected values can be shown optionally.

cargo test --features testing -- --nocapture

A json file of 100 KATs was generated from the sage implementation found here.

####Current Benchmarks

Tested on an Intel i7-7500U @ 2.7GHz

running 3 tests
test decapsulate_bench ... bench:   8,785,535 ns/iter (+/- 27,291)
test encapsulate_bench ... bench:   3,215,100 ns/iter (+/- 30,317)
test key_gen_bench     ... bench:  16,914,970 ns/iter (+/- 278,949)

Warnings


Implementation

This implementation has not undergone any security auditing and while care has been taken no guarantees can be made for either correctness or the constant time running of the underlying functions at compile time. Please use at your own risk.

Algorithm

Streamlined NTRU Prime was first published in 2016, the C implementation upon which this is based was published in August 2017. The algorithm still requires careful security review. Please see here for further warnings from the authors regarding NTRU Prime and lattice based encryption schemes.

Commit count: 114

cargo fmt