Struct RandomNumberGenerator

pub struct RandomNumberGenerator { /* private fields */ }

A cryptographic random number generator

Implementations

impl RandomNumberGenerator

pub fn new_of_type(typ: &str) -> Result<RandomNumberGenerator>

Create a new RNG object with a specific type, e.g. “esdm-full”

Examples

// This is just for demonstration, use RandomNumberGenerator::new_userspace() instead.
let specific_rng = botan::RandomNumberGenerator::new_of_type("user").unwrap();

pub fn new_userspace() -> Result<RandomNumberGenerator>

Create a new userspace RNG object

Examples

let userspace_rng = botan::RandomNumberGenerator::new_userspace().unwrap();

pub fn new_system() -> Result<RandomNumberGenerator>

Create a new reference to the system PRNG

Examples

let system_rng = botan::RandomNumberGenerator::new_system().unwrap();

pub fn new_esdm() -> Result<RandomNumberGenerator>

Create a new reference to the ESDM PRNG (fully seeded)

Availability of this RNG depends on botan being compiled with ESDM support.

Examples

let esdm_rng = botan::RandomNumberGenerator::new_esdm().unwrap();

pub fn new_esdm_pr() -> Result<RandomNumberGenerator>

Create a new reference to the ESDM PRNG (with prediction resistance)

Availability of this RNG depends on botan being compiled with ESDM support.

Examples

let esdm_rng = botan::RandomNumberGenerator::new_esdm_pr().unwrap();

pub fn new_jitter() -> Result<RandomNumberGenerator>

Create a new reference to the Jitter RNG

Availability of this RNG depends on botan being compiled with Jitter RNG support.

Examples

let jitter_rng = botan::RandomNumberGenerator::new_jitter().unwrap();

pub fn new() -> Result<RandomNumberGenerator>

Create a new reference to an RNG of some arbitrary type

Examples

let a_rng = botan::RandomNumberGenerator::new().unwrap();

pub fn read(&mut self, len: usize) -> Result<Vec<u8>>

Read bytes from an RNG

Examples

let mut rng = botan::RandomNumberGenerator::new().unwrap();
let output = rng.read(32).unwrap();
assert_eq!(output.len(), 32);

pub fn fill(&mut self, out: &mut [u8]) -> Result<()>

Store bytes from the RNG into the passed slice

Examples

let mut rng = botan::RandomNumberGenerator::new().unwrap();
let mut output = vec![0; 32];
rng.fill(&mut output).unwrap();

pub fn reseed(&mut self, bits: usize) -> Result<()>

Attempt to reseed the RNG by unspecified means

Examples

let mut rng = botan::RandomNumberGenerator::new().unwrap();
rng.reseed(256).unwrap();

pub fn reseed_from_rng( &mut self, source: &mut RandomNumberGenerator, bits: usize, ) -> Result<()>

Attempt to reseed the RNG by getting data from source RNG

Examples

let mut system_rng = botan::RandomNumberGenerator::new_system().unwrap();
let mut rng = botan::RandomNumberGenerator::new_userspace().unwrap();
rng.reseed_from_rng(&mut system_rng, 256).unwrap();

pub fn add_entropy(&mut self, seed: &[u8]) -> Result<()>

Add some seed material to the RNG

Examples

let mut rng = botan::RandomNumberGenerator::new_userspace().unwrap();
let my_seed = vec![0x42, 0x6F, 0x62];
rng.add_entropy(&my_seed);

Trait Implementations

impl Debug for RandomNumberGenerator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for RandomNumberGenerator

fn drop(&mut self)

Executes the destructor for this type.

impl Send for RandomNumberGenerator

impl Sync for RandomNumberGenerator