package dkim

  1. Overview
  2. Docs
Implementation of DKIM in OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

dkim-0.3.1.tbz
sha256=bf428053e08e8c438686abe0fc3c59ceb74ab353a0dbae55d58e3bdcccc57db0
sha512=bca64370322d4820a7cbdaf41067730741e43498b9656938a44f901eced5e366a32243d0d3de218559f4462d856ede66f9b47509651d6d39516aad11f77227e7

Description

A library and a binary to verify and sign an email with the DKIM mechanism described by the RFC 6376

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 (18)

  1. x509 >= "0.6.3"
  2. mirage-crypto-pk >= "0.9.2" & < "1.0.0"
  3. mirage-crypto >= "0.9.2" & < "1.0.0"
  4. base64 >= "3.0.0"
  5. fpath
  6. fmt >= "0.8.7"
  7. logs
  8. cmdliner
  9. dns-client >= "6.0.0"
  10. domain-name
  11. hmap
  12. base-unix
  13. astring >= "0.8.5"
  14. ipaddr
  15. digestif >= "0.9.0"
  16. mrmime >= "0.5.0" & < "0.6.0"
  17. dune >= "2.0.0"
  18. ocaml >= "4.08.0"

Dev Dependencies (2)

  1. alcotest with-test
  2. mirage-crypto-rng with-test & < "0.11.0"

Used by (1)

  1. dkim-mirage = "0.3.1"

Conflicts

None

OCaml

Innovation. Community. Security.