A Rust library for retrieving random data from (operating) system sources. It is
assumed that the system always provides high-quality cryptographically secure random
data, ideally backed by hardware entropy sources. This crate derives its name
from Linux's getrandom
function, but is cross-platform, roughly supporting
the same set of platforms as Rust's std
lib.
This is a low-level API. Most users should prefer using high-level random-number
library like rand
.
Add this to your Cargo.toml
:
[dependencies]
getrandom = "0.2"
Then invoke the getrandom
function:
fn get_random_buf() -> Result<[u8; 32], getrandom::Error> {
let mut buf = [0u8; 32];
getrandom::getrandom(&mut buf)?;
Ok(buf)
}
For more information about supported targets, entropy sources, no_std
targets,
crate features, WASM support and Custom RNGs see the
getrandom
documentation and
getrandom::Error
documentation.
This crate requires Rust 1.60.0 or later.
This crate generally supports the same operating system and platform versions that the Rust standard library does. Additional targets may be supported using pluggable custom implementations.
This means that as Rust drops support for old versions of operating systems (such as old Linux kernel versions, Android API levels, etc)
in stable releases, getrandom
may create new patch releases (0.N.x
) that remove support for outdated platform versions.
The getrandom
library is distributed under either of
at your option.
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.