package mirage-crypto-rng

You can search for identifiers within the package.

in-package search v0.2.0

A cryptographically secure PRNG

Install

dune-project

Dependency

github.com Readme Changelog ISC License Edit opam file Versions (7)

Authors

Maintainers

H

Hannes Mehnert <hannes@mehnert.org>

Sources

mirage-crypto-2.0.1.tbz

sha256=5430ce3c3e40627d2d67a8decf565a1f612d39bdb33f9b767c3bdb601ff5a196

sha512=de029e01cbb8d49f9b8fbcd02ef4777435927118c9ce7a859a8193fdbec30d1a7b3a2964ee8ec722f5fa74fec1bfdc054dcdc97ad1db6e2ced359d6c010c043a

doc/mirage-crypto-rng.unix/Mirage_crypto_rng_unix/Getentropy/index.html

Module `Mirage_crypto_rng_unix.Getentropy`Source

A generator using getrandom(3) on Linux, getentropy(3) on BSD and macOS, and BCryptGenRandom() on Windows.

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.

Source

val 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.