package mirage-crypto-rng

  1. Overview
  2. Docs
A cryptographically secure PRNG

Install

Dune Dependency

Authors

Maintainers

Sources

mirage-crypto-1.1.0.tbz
sha256=c7189767a7ead54923cab020f39cd0c34af7d4b048776939d94f028abf536353
sha512=312f0ea8433bb35224f4ae6e00ff2d5e6ca72f8e5b6d9e24cf609f004629ac55708fe6987edcc6bdd58e67f0044e053d08ccd783abc7f791fe27e77f6eb1ec62

Description

Mirage-crypto-rng provides a random number generator interface, and implementations: Fortuna, HMAC-DRBG, getrandom/getentropy based (in the unix sublibrary)

Published: 21 Aug 2024

README

mirage-crypto - Cryptographic primitives for MirageOS

v1.1.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 (7)

  1. digestif >= "1.1.4"
  2. mirage-crypto = version
  3. logs
  4. duration
  5. dune-configurator >= "2.0.0"
  6. dune >= "2.7"
  7. ocaml >= "4.13.0"

Dev Dependencies (3)

  1. ohex with-test & >= "0.2.0"
  2. randomconv with-test & >= "0.2.0"
  3. ounit2 with-test

Used by (35)

  1. albatross = "2.1.0"
  2. awa >= "0.4.0"
  3. builder-web >= "0.2.0"
  4. caldav >= "0.2.3"
  5. capnp-rpc-net >= "1.2.4"
  6. caqti-eio >= "2.1.2"
  7. dkim >= "0.7.0"
  8. dkim-mirage >= "0.7.0"
  9. dns-cli >= "9.0.0"
  10. dns-client >= "9.0.0"
  11. dns-server >= "9.0.0"
  12. dream >= "1.0.0~alpha7"
  13. git >= "3.17.0"
  14. git-unix >= "3.17.0"
  15. http-mirage-client >= "0.0.6"
  16. letsencrypt >= "1.0.0"
  17. letsencrypt-app >= "1.0.0"
  18. miou >= "0.3.0"
  19. mirage-crypto-ec >= "1.1.0"
  20. mirage-crypto-pk >= "1.1.0"
  21. mirage-crypto-rng-async >= "1.1.0"
  22. mirage-crypto-rng-eio >= "1.1.0"
  23. mirage-crypto-rng-lwt >= "1.1.0"
  24. mirage-crypto-rng-miou-unix >= "1.1.0"
  25. mirage-crypto-rng-mirage >= "1.1.0"
  26. otr >= "1.0.0"
  27. paf >= "0.7.0"
  28. paf-cohttp >= "0.7.0"
  29. tcpip >= "8.2.0"
  30. tls >= "1.0.0"
  31. tls-eio >= "1.0.0"
  32. tls-liquidsoap
  33. webauthn >= "0.2.0"
  34. websocket >= "2.17"
  35. x509 >= "1.0.0"

Conflicts (1)

  1. mirage-runtime < "3.8.0"
OCaml

Innovation. Community. Security.