package dkim-mirage

  1. Overview
  2. Docs
Implementation of DKIM in OCaml for MirageOS

Install

Dune Dependency

Authors

Maintainers

Sources

dkim-0.3.1.tbz
sha256=bf428053e08e8c438686abe0fc3c59ceb74ab353a0dbae55d58e3bdcccc57db0
sha512=bca64370322d4820a7cbdaf41067730741e43498b9656938a44f901eced5e366a32243d0d3de218559f4462d856ede66f9b47509651d6d39516aad11f77227e7

Description

A light layer of the dkim library for MirageOS

Published: 30 Nov 2021

README

ocaml-dkim

ocaml-dkim is a pure implementation of DKIM in OCaml. It permits to verify and sign an incoming email. It can be use as a SMTP filter service (verify) or as a SMTP submission service (sign).

How to install it?

You must have an OPAM environment. Then, ocaml-dkim can be installed with:

$ opam pin add https://github.com/dinosaure/ocaml-dkim.git

How to use it?

ocaml-dkim provides 2 binaries, one to verify, the second to sign an email.

$ dkim.verify test/raw/001.mail
[ok]: sendgrid.info
[ok]: github.com

It shows all domains which signed the given email and whether the signature is correct or not (for the last case, it shows you the selector). ocaml-dkim is able to sign an email from a private RSA key and a specific domain such as:

$ dkim.sign -k private-key.pem --selector admin --hostname x25519.net test/raw/001.mail
DKIM-Signature: ...
Rest of the email

It prints the signed email then. The user is able to use a specific RSA private key or it can use a seed used to generate the RSA private key with the fortuna random number generator.

ocaml-dkim has received funding from the Next Generation Internet Initiative (NGI) within the framework of the DAPSI Project.

Dependencies (9)

  1. lwt
  2. mirage-stack
  3. mirage-clock
  4. mirage-random
  5. mirage-time
  6. dns-client >= "6.0.0" & < "6.4.0"
  7. dkim = version
  8. dune >= "2.0.0"
  9. ocaml >= "4.08.0"

Dev Dependencies (5)

  1. mirage-crypto-rng with-test
  2. logs with-test
  3. fmt with-test
  4. digestif with-test
  5. alcotest with-test

Used by

None

Conflicts

None