package mirage-crypto-rng-eio

All checked builds pass
  1. Overview
  2. Docs
Feed the entropy source in an eio-friendly way

Install

dune-project
 Dependency

Authors

Maintainers

Sources

mirage-crypto-1.2.0.tbz
sha256=09542bcd96c1d368ff9ba8853105f4c1781d8c94c2400df9f3ac0610ee07e67e
sha512=1b31c9df0ce774c87a36f714db4ea1f295bc1e2e317d30497523ec03564cace0f64ac4c535aa83c82792aa3331a92efe774e4c3300a6ffe09110ce0efc2ce24b

Description

Mirage-crypto-rng-eio feeds the entropy source for Mirage_crypto_rng-based random number generator implementations, in an eio-friendly way.

Added to opam-repository:

README

mirage-crypto - Cryptographic primitives for MirageOS

v1.2.0

mirage-crypto is a small cryptographic library that puts emphasis on the applicative style and ease of use. It includes basic ciphers (AES, 3DES, RC4, ChaCha20/Poly1305), AEAD primitives (AES-GCM, AES-CCM, ChaCha20/Poly1305), public-key primitives (RSA, DSA, DH), elliptic curves (NIST P-256, P-384, P-521, and curve 25519), and a strong RNG (Fortuna).

RSA timing attacks are countered by blinding. AES timing attacks are avoided by delegating to AES-NI.

Mirage-crypto is a fork of the ocaml-nocrypto written by David Kaloper. It was forked with the permission of the original author in order to facilitate changes (e.g. build system) required by Mirage that the upstream didn't have time to keep up with.

Mirage-crypto-rng embeds the former mirage-entropy opam package, which implements various entropy sources:

  • non-deterministic execution time (used at initial seeding, see the whirlwind RNG paper)
  • a hook into the Lwt event loop that collects a timestamp of each event
  • rdseed and rdrand (x86/x86-64 only)

API documentation online

Build

dune build
dune runtest

FAQ

RNG seeding

If RNG fails with Fatal error: exception Unseeded_generator, you need to seed it.

Lwt:

let () = Mirage_crypto_rng_lwt.initialize (module Mirage_crypto_rng.Fortuna)

Unix:

let () = Mirage_crypto_rng_unix.initialize (module Mirage_crypto_rng.Fortuna)

Dependencies (8)

  1. cstruct >= "6.1.0"
  2. mtime
  3. duration
  4. mirage-crypto-rng = version
  5. logs
  6. eio >= "0.12"
  7. dune >= "2.7"
  8. ocaml >= "5.0.0"

Dev Dependencies (2)

  1. ohex with-test & >= "0.2.0"
  2. eio_main with-test

Optional Dependencies

None

Used by (5)

  1. caqti-eio = "2.1.2"
  2. carbon >= "0.2.0"
  3. cohttp-eio = "6.0.0"
  4. opentelemetry-client-cohttp-eio < "0.90"
  5. starred_ml >= "0.0.6" & < "0.0.8"

Conflicts

None

Build status

Results of building mirage-crypto-rng-eio with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
1.2.0 (this version) n/a n/a good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure