Verbatim clone of integritychain/fips205 (pure-Rust FIPS 205 / SLH-DSA), pinned at 30bac08 for the SLH-DSA formal-verification campaign. Aeneas-compat patches land here as transparent commits. Independent snapshot: no affiliation with, and no changes prop
Find a file
2024-10-01 14:29:06 -05:00
.github/workflows msrv 1.70 2024-03-08 17:22:43 -06:00
benches shaky, shaky 2024-10-01 14:29:06 -05:00
dudect shaky, shaky 2024-10-01 14:29:06 -05:00
ffi shaky, shaky 2024-10-01 14:29:06 -05:00
src shaky, shaky 2024-10-01 14:29:06 -05:00
tests shaky, shaky 2024-10-01 14:29:06 -05:00
wasm shaky, shaky 2024-10-01 14:29:06 -05:00
.gitignore rust ffi 2024-03-14 13:35:26 -05:00
Cargo.toml Merge pull request #3 from jonmon6691/add-acvp-tests 2024-09-29 19:01:56 -05:00
CHANGELOG.md python binding 2024-03-15 11:36:47 -05:00
deny.toml cargo deny2 2024-02-10 09:26:34 -06:00
LICENSE-APACHE init 1 2023-11-26 14:18:22 -06:00
LICENSE-MIT init 1 2023-11-26 14:18:22 -06:00
README.md shaky, shaky 2024-10-01 14:29:06 -05:00
rustfmt.toml init 1 2023-11-26 14:18:22 -06:00
SECURITY.md fips205 prep 2024-02-09 17:43:59 -06:00

IntegrityChain: FIPS 205 Stateless Hash-Based Digital Signature Standard

crate Docs Build Status Apache2/MIT licensed Rust Version

FIPS 205 Stateless Hash-Based Digital Signature Standard written in pure Rust for server, desktop, browser and embedded applications. The code repository includes C FFI and Python bindings.

This crate implements the FIPS 205 final/released standard in pure Rust with minimal and mainstream dependencies. All twelve (!!) security parameter sets are fully functional. The implementation does not require the standard library, e.g. #[no_std], has no heap allocations, e.g. no alloc needed, and exposes the RNG so it is suitable for the full range of applications from server down to the bare-metal. The API is stabilized and the code is heavily biased towards safety and correctness; further performance optimizations will be implemented as the standard matures. This crate will quickly follow any changes to FIPS 205 as they become available.

See https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.205.pdf for a full description of the target functionality.

The functionality is extremely simple to use, as demonstrated by the following example.

use fips205::slh_dsa_shake_128s; // Could use any of the twelve security parameter sets. 
use fips205::traits::{SerDes, Signer, Verifier};
# use std::error::Error;
#
# fn main() -> Result<(), Box<dyn Error>> {

let msg_bytes = [0u8, 1, 2, 3, 4, 5, 6, 7];

// Generate key pair and signature
let (pk1, sk) = slh_dsa_shake_128s::try_keygen()?;  // Generate both public and secret keys
let sig_bytes = sk.try_sign(&msg_bytes, b"context", true)?;  // Use the secret key to generate signature

// Serialize the public key, and send with message and signature bytes
let (pk_send, msg_send, sig_send) = (pk1.into_bytes(), msg_bytes, sig_bytes);
let (pk_recv, msg_recv, sig_recv) = (pk_send, msg_send, sig_send);

// Deserialize the public key, then use it to verify the msg signature
let pk2 = slh_dsa_shake_128s::PublicKey::try_from_bytes(&pk_recv)?;
let v = pk2.try_verify(&msg_recv, &sig_recv, b"context")?;
assert!(v); 
# Ok(())
# }

The detailed Rust Documentation lives under each Module corresponding to the desired security parameter below.

Notes

  • This crate is fully functional and corresponds to the final/released FIPS 205.
  • Constant-time assurances target the source-code level only, and are a work in progress.
  • Note that FIPS 205 places specific requirements on randomness per section 3.1, hence the exposed RNG.
  • Requires Rust 1.70 or higher. The minimum supported Rust version may be changed in the future, but it will be done with a minor version bump.
  • All on-by-default features of this library are covered by SemVer.
  • This software is experimental and still under active development -- USE AT YOUR OWN RISK!

License

Contents are licensed under either the Apache License, Version 2.0 or MIT license 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.