On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package mirage-crypto-rng
Entropy sources and collection
val sources : unit -> source listsources () returns the list of available sources.
val pp_source : Format.formatter -> source -> unitpp_source ppf source pretty-prints the entropy source on ppf.
val register_source : string -> sourceregister_source name registers name as entropy source.
Bootstrap
val whirlwind_bootstrap : int -> Cstruct.twhirlwind_bootstrap id exploits CPU-level data races which lead to execution-time variability. It returns 200 bytes random data prefixed by id.
See http://www.ieee-security.org/TC/SP2014/papers/Not-So-RandomNumbersinVirtualizedLinuxandtheWhirlwindRNG.pdf for further details.
cpu_rng_bootstrap id returns 8 bytes of random data using the CPU RNG (rdseed or rdrand). On 32bit platforms, only 4 bytes are filled. The id is used as prefix.
val bootstrap : int -> Cstruct.tbootstrap id is either cpu_rng_bootstrap, if the CPU supports it, or whirlwind_bootstrap if not.
Timer source
val interrupt_hook : unit -> unit -> Cstruct.tinterrupt_hook () collects lower bytes from the cycle counter, to be used for entropy collection in the event loop.
val timer_accumulator : g option -> unit -> unittimer_accumulator g is the accumulator for the timer source, applying interrupt_hook on each call.
Periodic pulled sources
feed_pools g source f feeds all pools of g using source by executing f for each pool.
cpu_rng g uses the CPU RNG (rdrand or rdseed) to feed all pools of g. It uses feed_pools internally. If neither rdrand nor rdseed are available, fun () -> () is returned.
On This Page