package dkim-mirage
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=e3cf23b941ba243719bbe05e352a59d34a42e77437ba629b0e5daad59f033346
sha512=e713ccd485bfb2c021b292710cf344492a80bb7c68d832642285e37bddd966541696077ed4237bea4184611d0100492d52c1fcb58a82eaf784cc642b74e26542
Description
A light layer of the dkim library for MirageOS
Published: 30 Nov 2022
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)
- lwt
-
tcpip
>= "7.0.0"
- mirage-clock
-
mirage-random
< "4.0.0"
- mirage-time
-
dns-client
>= "6.0.0" & < "7.0.0"
-
dkim
= version
-
dune
>= "2.0.0"
-
ocaml
>= "4.08.0"
Dev Dependencies (5)
-
mirage-crypto-rng
with-test & < "1.0.0"
-
logs
with-test
-
fmt
with-test
-
digestif
with-test
-
alcotest
with-test
Used by
None
Conflicts
None