#hashing #hash #message-authentication #sha-3 #algorithm #cryptography #sha-3-256

rs_sha3_256

rs_sha3_256 is a Rust implementation of the SHA3-256 cryptographic hash algorithm, part of the larger rs_shield project. This package provides SHA3-256 hashing functionality in a standalone manner, ideal for when only SHA3-256 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_sha3_256 and the larger project is on performance, safety, and openness, with a commitment to ongoing maintenance and enhancement.

3 releases

0.1.2 Jun 12, 2023
0.1.1 Jun 4, 2023
0.1.0 May 30, 2023

#1222 in Algorithms

Download history 5/week @ 2024-02-19 99/week @ 2024-02-26 423/week @ 2024-03-04 272/week @ 2024-03-11 23/week @ 2024-03-18 27/week @ 2024-03-25 63/week @ 2024-04-01 137/week @ 2024-04-08 157/week @ 2024-04-15 223/week @ 2024-04-22 279/week @ 2024-04-29 257/week @ 2024-05-06 64/week @ 2024-05-13

840 downloads per month
Used in 3 crates

GPL-2.0-only

135KB
2.5K SLoC

rs_sha3_256

rs_sha3_256 is a Rust crate implementing the SHA-3_256 cryptographic hash algorithm. This permutation-based hash algorithm is designed for compatibility with Rust's libcore in a #![no_std] context, allowing it to operate as a standalone crate for specialized use cases and also function within a #![no_std], #![no_alloc] environment, rendering it suitable for systems where dynamic memory allocation is not feasible.

This implementation of SHA-3_256 is compliant with the Federal Information Processing Standards (FIPS) Publication 202[^1]. As per the National Institute of Standards and Technology (NIST) guidelines, SHA-3_256 is recommended for several use cases:

"SHA-3 provides security strengths against preimage, second preimage and collision attacks [...] at the 128-bit security level."

Given this advice, NIST recommendations imply that SHA-3_256 is suitable for the following contexts:

  • Digital signatures that require 128 bits of security.
  • Cryptographic hash functions in systems and protocols requiring 128 bits of security.
  • Authentication methods that necessitate 128 bits of security.

Beyond these specific recommendations, SHA-3_256 could also find application in:

  • Data integrity checks in Merkle Trees[^4].
  • Version control systems for the generation of commit identifiers[^2].
  • Hash-based message authentication codes (HMACs), when collision resistance is necessary[^3].
  • As a randomized hash function in Bloom filters[^5].
  • Key derivation functions or in generation of random numbers[^6].

These points should be carefully considered, given your overall security objectives and risk tolerance.

For access to a comprehensive range of cryptographic functions, rs_sha3_256 can be utilized as part of the rs_shield library bundle.

How To Use

Below are steps to use the rs_sha3_256 crate in your Rust projects:

  1. Add the following line to your Cargo.toml under the [dependencies] section:

    rs_sha3_256 = "0.1.*"
    
  2. Use the functions provided by the rs_sha3_256 module in your code. Here's an example of how to create a SHA-3_256 hash from a string:

    use rs_sha3_256::{HasherContext, Sha3_256Hasher};
    
    let mut sha3_256hasher = Sha3_256Hasher::default();
    sha3_256hasher.write(b"your string here");
    
    let u64result = sha3_256hasher.finish();
    let bytes_result = HasherContext::finish(&mut sha3_256hasher);
    assert_eq!(u64result, 0x4722CA201B0E3369);
    assert_eq!(format!("{bytes_result:02x}"), "4722ca201b0e33697597ff6abd97e83b73c4ebd2f680b3ac23616e96dc351648");
    assert_eq!(format!("{bytes_result:02X}"), "4722CA201B0E33697597FF6ABD97E83B73C4EBD2F680B3AC23616E96DC351648");
    assert_eq!(
        bytes_result,
        [
            0x47, 0x22, 0xCA, 0x20, 0x1B, 0x0E, 0x33, 0x69, 0x75, 0x97, 0xFF, 0x6A, 0xBD, 0x97, 0xE8, 0x3B, 0x73, 0xC4,
            0xEB, 0xD2, 0xF6, 0x80, 0xB3, 0xAC, 0x23, 0x61, 0x6E, 0x96, 0xDC, 0x35, 0x16, 0x48
        ]
    )
    

More Information

For a more detailed exploration of rs_sha3_256, an overview of other available cryptographic functions, and an introduction to the broader rs_shield project, please consult the RustyShield project page on crates.io.

Contributions

Potential contributors are encouraged to consult the contribution guidelines on our GitHub page.

License

This project is licensed under GPL-2.0-only.

References

[^1]: National Institute of Standards and Technology. (2015). SHA-3 Standard: Permutation-Based Hash and Extendable-Output Functions. FIPS PUB 202 [^2]: Linus Torvalds. (2005). Git: A distributed version control system. Software: Practice and Experience, 41(1), 79-88. DOI:10.1002/spe.1006 [^3]: Krawczyk, H., Bellare, M., & Canetti, R. (1997). HMAC: Keyed-Hashing for Message Authentication. RFC 2104 [^4]: Merkle, R. C. (1988). A Digital Signature Based on a Conventional Encryption Function. Link [^5]: Bloom, B. H. (1970). Space/time trade-offs in hash coding with allowable errors. Communications of the ACM, 13(7), 422-426. DOI:10.1145/362686.362692 [^6]: National Institute of Standards and Technology. (2012). Recommendation for Key Derivation Using Pseudorandom Functions. NIST Special Publication 800-108


Note: The references have been provided as per the best knowledge as of May 17, 2023.

Dependencies