package mirage-crypto-rng

  1. Overview
  2. Docs
A cryptographically secure PRNG

Install 

dune-project
 Dependency

github.com Readme Changelog BSD-2-Clause License Edit opam file Versions (12)

Authors

  1. D
    David Kaloper <dk505@cam.ac.uk>
  2. H
    Hannes Mehnert <hannes@mehnert.org>

Maintainers

  1. H
    Hannes Mehnert <hannes@mehnert.org>

Sources

mirage-crypto-2.4.0.tbz
sha256=cd215ea3267a22ae7d910590f4f7ed82d2dc575206191f5bba9b49bb9240b5db
sha512=378b9ae826212471c4820636fa0be27a33013ecf801ba7202fbf0bbf8ac20b1072f782d34b868e5491616ef93bd7c0ec81f9705f7afd287b2ac595a913d32401

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

Module Mirage_crypto_rng_unixSource

RNG seeding on Unix.

This module initializes a Fortuna RNG with getrandom(), and CPU RNG. On BSD systems (FreeBSD, OpenBSD, macOS) getentropy () is used instead of getrandom (). On Windows 10 or higher, BCryptGenRandom() is used with the default RNG. Windows 8 or lower are not supported by this library.

Sourceval initialize : ?g:'a -> 'a Mirage_crypto_rng.generator -> unit

initialize ~g rng will bring the RNG into a working state.

  • deprecated Use 'Mirage_crypto_rng_unix.use_default ()' instead.
Sourceval getrandom : int -> string

getrandom size returns a buffer of size filled with random bytes.

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.

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

Sourceval use_default : unit -> unit

use_default () initializes the RNG Mirage_crypto_rng.default_generator with a sensible default, at the moment using Getentropy.

Sourceval use_dev_urandom : unit -> unit

use_dev_random () initializes the RNG Mirage_crypto_rng.default_generator with the Urandom generator. This raises an exception if "/dev/urandom" cannot be opened.

Sourceval use_getentropy : unit -> unit

use_getentropy () initializes the RNG Mirage_crypto_rng.default_generator with the Getentropy generator.