Adding `rand_hash` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add rand_hash

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

rand_hash = "0.1.1"

The rand_hash library will be automatically available globally. Read the rand_hash library documentation.

Back to the crate overview.

Readme

Cryptographically-secure pseudo-random generator based on cryptographic hash function

HashRng is CSPRNG that takes any hashable data as seed and produces a stream of randomness that has the same entropy as the seed. It uses udigest crate to unambiguously hash the seed.

Motivation

Usually, CSPRNGs have a fixed-size seed. For instance, ChaCha20Rng has seed of 32 bytes. That means that when you want to derive randomness from data which has entropy exceeding 32 bytes, you'll have to truncate the seed to 32 bytes (e.g. by hashing it), so you won't be able to take advantage of exceeding entropy. This may influence security parameter and make it less secure than desired.

HashRng, on other hand, takes advantage of full entropy of the seed. It does so by hashing a counter and then the seed for each block, i.e. the output randomness is:

HashRng(seed) = H(0, seed) || H(1, seed) || ...

Security and performance considerations

HashRng internally uses u64 counter, which means that the period of the sequence is 2⁶⁴ times Digest::OutputSize (size of hash output).

Although we did not perform benchmarks, intuitively, HashRng is expected to be noticeably slower than other CSPRNG based on permutations (such as ChaCha20Rng)

Example

use rand::RngCore;

#[derive(udigest::Digestable)]
pub struct Seed<'a> {
    nonce: &'a [u8],
    param_a: &'a str,
    param_b: &'a str,
    // ...
}

let seed = Seed {
    nonce: b"very unpredictable string",
    param_a: "some other data containing entropy",
    param_b: "something else",
    // ...
};
let mut rng = rand_hash::HashRng::<sha2::Sha256, _>::from_seed(&seed);

let mut randomness = [0u8; 256];
rng.fill_bytes(&mut randomness);

Join us in Discord!

Feel free to reach out to us in Discord!

Adding rand_hash library as a dependency

Adding `rand_hash` library as a dependency