package mirage-crypto

  1. Overview
  2. Docs
Simple symmetric cryptography for the modern age

Install

Dune Dependency

Authors

Maintainers

Sources

mirage-crypto-0.11.3.tbz
sha256=bfb530fa169cd905ebc7e2449f3407cfbd67023ac0b291b8b6f4a1437a5d95b1
sha512=7b6f4e8128622b53eb2176881b5d6160f224e8606c7dd21aaf47974f15db7aa475cffaff3214aaaabba0f8986398f159c1fbb1bff29228c9b0a3fae67ef8d731

Description

Mirage-crypto provides symmetric ciphers (DES, AES, RC4, ChaCha20/Poly1305), and hashes (MD5, SHA-1, SHA-2).

Published: 27 Feb 2024

README

mirage-crypto - Cryptographic primitives for MirageOS

v0.11.3

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), hashes (MD5, SHA1, SHA2 family), AEAD primitives (AES-GCM, AES-CCM), public-key primitives (RSA, DSA, DH) 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 (5)

  1. eqaf >= "0.8" & < "0.10"
  2. cstruct >= "6.0.0"
  3. dune-configurator >= "2.0.0"
  4. dune >= "2.7"
  5. ocaml >= "4.08.0"

Dev Dependencies (1)

  1. ounit2 with-test

Used by (45)

  1. albatross >= "1.1.0"
  2. awa
  3. builder-web
  4. ca-certs
  5. ca-certs-nss
  6. caldav
  7. capnp-rpc-net >= "0.9.0"
  8. chacha
  9. cohttp-async >= "3.0.0"
  10. conex-mirage-crypto
  11. current_git >= "0.5"
  12. current_github >= "0.2"
  13. current_web >= "0.4"
  14. dkim
  15. dns-cli >= "4.4.0"
  16. dns-tsig >= "4.4.0"
  17. dnssec
  18. dream
  19. git-mirage >= "3.7.0"
  20. hkdf = "1.0.4"
  21. jose >= "0.5.0"
  22. letsencrypt >= "0.2.1"
  23. mirage-block-ccm >= "2.0.0"
  24. mirage-crypto-ec = "0.11.3"
  25. mirage-crypto-pk = "0.11.3"
  26. mirage-crypto-rng = "0.11.3"
  27. mirage-crypto-rng-async = "0.11.3"
  28. mirage-crypto-rng-lwt = "0.11.3"
  29. ocluster
  30. oidc
  31. opium >= "0.19.0"
  32. otr >= "0.3.7"
  33. pbkdf >= "1.1.0" & < "2.0.0"
  34. random
  35. rfc6287 >= "1.0.4"
  36. riot >= "0.0.8"
  37. salsa20 >= "1.1.0"
  38. scrypt-kdf >= "1.1.0"
  39. session >= "0.5.0"
  40. spoke >= "0.0.2"
  41. ssh-agent >= "0.2.1"
  42. tls >= "0.12.3"
  43. tls-mirage
  44. twostep
  45. x509 >= "0.10.0"

Conflicts (2)

  1. result < "1.5"
  2. ocaml-freestanding
OCaml

Innovation. Community. Security.