package mirage-crypto-rng

  1. Overview
  2. Docs

Module Mirage_crypto_rng_unix.UrandomSource

A generator that opens /dev/urandom and reads from that file descriptor data whenever random data is needed. The file descriptor is closed in at_exit.

Sourcetype g

State type for this generator.

Sourceval block : int

Internally, this generator's generate always produces k * block bytes.

Sourceval create : ?time:(unit -> int64) -> unit -> g

Create a new, unseeded g.

Sourceval generate_into : g:g -> bytes -> off:int -> int -> unit

generate_into ~g buf ~off n produces n uniformly distributed random bytes into buf at offset off, updating the state of g.

Assumes that buf is at least off + n bytes long. Also assumes that off and n are positive integers. Caution: do not use in your application, use Mirage_crypto_rng.generate_into instead.

  • alert unsafe Does not do bounds checks. Use Mirage_crypto_rng.generate_into instead.
Sourceval reseed : g:g -> string -> unit

reseed ~g bytes directly updates g. Its new state depends both on bytes and the previous state.

A generator is seded after a single application of reseed.

Sourceval accumulate : g:g -> Mirage_crypto_rng.Entropy.source -> [ `Acc of string -> unit ]

accumulate ~g is a closure suitable for incrementally feeding small amounts of environmentally sourced entropy into g.

Its operation should be fast enough for repeated calling from e.g. event loops. Systems with several distinct, stable entropy sources should use stable source to distinguish their sources.

Sourceval seeded : g:g -> bool

seeded ~g is true iff operations won't throw Unseeded_generator.

Sourceval pools : int

pools is the amount of pools if any.