saymrwulf/fips205-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/fips205-source.git synced 2026-09-04 20:03:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

starting update

Browse source
This commit is contained in:
eschorn1 2024-09-29 18:05:16 -05:00
parent bf62d98c42
commit 7542bb2d80
3 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
Cargo.toml
View file

@ -2,10 +2,10 @@ workspace = { members = ['ffi'], exclude = ["dudect", "ct_cm4"] }
[package] [package]
name = "fips205" name = "fips205"
version = "0.1.2" version = "0.4.0"
edition = "2021" edition = "2021"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
description = "FIPS 205 (draft): Stateless Hash-Based Digital Signature Standard" description = "FIPS 205: Stateless Hash-Based Digital Signature Standard"
authors = ["Eric Schorn <eschorn@integritychain.com>"] authors = ["Eric Schorn <eschorn@integritychain.com>"]
documentation = "https://docs.rs/fips205" documentation = "https://docs.rs/fips205"
categories = ["cryptography", "no-std"] categories = ["cryptography", "no-std"]

12
README.md
View file

@ -6,17 +6,17 @@
![Apache2/MIT licensed][license-image] ![Apache2/MIT licensed][license-image]
![Rust Version][rustc-image] ![Rust Version][rustc-image]
[FIPS 205] (Initial Public Draft) Stateless Hash-Based Digital Signature Standard written in pure Rust for server, [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. desktop, browser and embedded applications. The code repository includes C FFI and Python bindings.
This crate implements the FIPS 205 **draft** standard in pure Rust with minimal and mainstream dependencies. All 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, 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 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 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. 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. This crate will quickly follow any changes to FIPS 205 as they become available.
See <https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.205.ipd.pdf> for a full description of the target functionality. 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. The functionality is extremely simple to use, as demonstrated by the following example.
@ -50,7 +50,7 @@ desired [security parameter](#modules) below.
## Notes ## Notes
* This crate is fully functional and corresponds to the first initial public draft of FIPS 205. * 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. * 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`. * 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, * Requires Rust **1.70** or higher. The minimum supported Rust version may be changed in the future,
@ -70,7 +70,7 @@ defined in the Apache-2.0 license, shall be dual licensed as above, without any
[//]: # (badges) [//]: # (badges)
[crate-image]: https://buildstats.info/crate/fips205 [crate-image]: https://img.shields.io/crates/v/fips205
[crate-link]: https://crates.io/crates/fips205 [crate-link]: https://crates.io/crates/fips205
[docs-image]: https://docs.rs/fips205/badge.svg [docs-image]: https://docs.rs/fips205/badge.svg
[docs-link]: https://docs.rs/fips205/ [docs-link]: https://docs.rs/fips205/
@ -82,4 +82,4 @@ defined in the Apache-2.0 license, shall be dual licensed as above, without any
[//]: # (general links) [//]: # (general links)
[IntegrityChain]: https://github.com/integritychain/ [IntegrityChain]: https://github.com/integritychain/
[FIPS 205]: https://csrc.nist.gov/pubs/fips/205/ipd [FIPS 205]: https://csrc.nist.gov/pubs/fips/205/final

2
ffi/Cargo.toml
View file

@ -18,4 +18,4 @@ name = "fips205"
[dependencies.fips205] [dependencies.fips205]
path = ".." path = ".."
version = "0.1.2" #version = "0.1.2"