rs_shake256 0.1.2

`rs_shake256` is a Rust implementation of the SHAKE256 cryptographic hash algorithm, part of the larger `rs_shield` project. This package provides SHAKE256 hashing functionality in a standalone manner, ideal for when only SHAKE256 is required. Alternatively, for those seeking a comprehensive set of cryptographic functions, this same algorithm is included within the broader `rs_shield` library bundle. The focus of `rs_shake256` and the larger project is on performance, safety, and openness, with a commitment to ongoing maintenance and enhancement.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! # SHAKE256 `rs_shake256` - Secure Hash Algorithm KECCAK-based variant
//!
//! The SHAKE256 hash function is part of the SHA-3 family, which was developed by the National Institute of Standards and
//! Technology (NIST). It's an Extendable Output Function (XOF), meaning it can generate a hash value of any length.
//!
//! SHAKE256 is suitable for a range of cryptographic purposes, including generating unique identifiers and ensuring data integrity. It has not been deprecated for any uses and remains one of the most versatile hash functions available.
//!
//! ## Usage
//!
//! The crate provides a simple and intuitive API. Users can create a new SHAKE256 hasher instance, update it with input
//! data, and finalize to get the resultant hash.
//!
//! ### Example
//!
//! Here is an example of how to use the SHAKE256 hash function in Rust:
//!
//! ```rust
//! # use std::hash::{BuildHasher, Hasher};
//! # use rs_shake256::Shake256State;
//! let mut shake256hasher = Shake256State::<20>::default().build_hasher();
//! shake256hasher.write(b"hello world");
//! let result = shake256hasher.finish();
//! assert_eq!(result, 0x369771BB2CB9D2B0);
//! ```
//!
//! Or, as a `HashSet`:
//!
//! ```
//! # use std::{
//! #     collections::HashSet,
//! #     hash::{BuildHasher, Hash, Hasher}
//! # };
//! # use rs_shake256::Shake256State;
//! let hello = "hello";
//! let shake256state = Shake256State::<20>::default();
//! let mut shake256hasher1 = shake256state.build_hasher();
//! let mut shake256hasher2 = shake256state.build_hasher();
//! let mut shake256hasher3 = shake256state.build_hasher();
//!
//! shake256hasher1.write(hello.as_bytes());
//! hello.hash(&mut shake256hasher2);
//! shake256hasher3.write(hello.as_bytes());
//! shake256hasher3.write(&[0xFF]);
//!
//! let u64result1 = shake256hasher1.finish();
//! let u64result2 = shake256hasher2.finish();
//! let u64result3 = shake256hasher3.finish();
//!
//! assert_eq!(u64result1, 0x1234075AE4A1E773);
//! assert_eq!(u64result2, 0xC420BC53338A657A);
//! assert_eq!(u64result2, u64result3);
//! assert_ne!(u64result1, u64result2);
//! ```
//!
//! ## Use Cases
//!
//! SHAKE256 is recommended for a wide variety of tasks, including:
//!
//! - Cryptographic security, due to its resistance to collision attacks.
//! - Creating unique identifiers for data.
//! - Ensuring data integrity in situations where a variable-length hash is beneficial.
//!
//! [NIST](https://www.nist.gov/) recommends SHAKE256 for cryptographic functions due to its security and versatility. Its extendable output makes it particularly suitable when a variable-length hash is required.
//!

#![no_std]

pub use rs_hasher_ctx::HasherContext;
pub use shake256hasher::Shake256Hasher;
pub use shake256state::Shake256State;

mod shake256hasher;
mod shake256state;

#[cfg(test)]
mod unit_tests;