Skip to content

Latest commit

 

History

History
101 lines (79 loc) · 3.29 KB

README.md

File metadata and controls

101 lines (79 loc) · 3.29 KB
Raw

Rabin-Williams signatures

A portable Rabin-Williams signature scheme implementation in pure Rust.

⚠️ WARNING: This crate has NOT been audited by a 3rd party and is a work-in-progress. Use at your own risk.

Example

use rabin_williams::generate_private_key;
use rand::rngs::OsRng;

let mut rng = OsRng;
let bits = 1024;
let private_key = generate_private_key(&mut rng, bits).expect("failed to generate a key");
let public_key = private_key.to_public_key();

// Signature
let message = String::from("fast verification scheme");
let signature = private_key.sign(message.as_bytes());

// Verification
assert!(public_key.verify(
    message.as_bytes(),
    signature.unwrap()
));

Status

Currently at Phase 1 (v) 🚧

There will be three phases before 1.0 🚢 can be released.

  1. 🚧 Make it work
    • Prime generation: Rabin-Williams scheme ✅
    • Key generation ✅
    • Rabin-Williams: Sign & Verify
    • Key import & export
  2. 🚀 Make it fast
    • Benchmarks ✅
    • compare to other implementations 🚧
    • optimize 🚧
  3. 🔐 Make it secure
    • Fuzz testing
    • Security Audits

Minimum Supported Rust Version (MSRV)

All crates in this repository support Rust 1.56 or higher. In future minimally supported version of Rust can be changed, but it will be done with a minor version bump.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.