Mirrors/go-chasquid-smtp
1
0
Fork 0
mirror of https://blitiri.com.ar/repos/chasquid synced 2025-12-16 14:27:01 +00:00
Code Releases Activity
Files
a3c06b6ee43705e96f97e43181ce4dbf87a088e5
go-chasquid-smtp/docs/dkim.md
Alberto Bertogli d53c1d2b88 docs: Add DKIM setup instructions 
This patch adds some basic instructions to the documentation on how to
set up DKIM, using the tools supported by the example hook.

It's not meant to be a full DKIM how-to, but to help someone who already
knows enough, or who is complementing it with a more general purpose
DKIM guide.
2021-07-25 14:59:37 +01:00

2.5 KiB
Raw Blame History

DKIM integration

chasquid supports generating DKIM signatures via the hooks mechanism.

Signing

The example hook includes integration with driusan/dkim and dkimpy, and assumes the following:

  • The selector for a domain can be found in the file domains/$DOMAIN/dkim_selector.
  • The private key to use for signing can be found in the file certs/$DOMAIN/dkim_privkey.pem.

Only authenticated email will be signed.

Setup with driusan/dkim

  1. Install the driusan/dkim tools with something like the following (adjust to your local environment):

    for i in dkimsign dkimverify dkimkeygen; do
	go get github.com/driusan/dkim/cmd/$i
	go install github.com/driusan/dkim/cmd/$i
done
sudo cp ~/go/bin/{dkimsign,dkimverify,dkimkeygen} /usr/local/bin

  2. Generate the domain key for your domain using dkimkeygen.

  3. Publish the DNS record from dns.txt (guide).

  4. Write the selector you chose to domains/$DOMAIN/dkim_selector.

  5. Copy private.pem to /etc/chasquid/certs/$DOMAIN/dkim_privkey.pem.

  6. Verify the setup using one of the publicly available tools, like mail-tester.

Setup with dkimpy

  1. Install dkimpy with apt install python3-dkim or the equivalent for your environment.
  2. Generate the domain key for your domain using dknewkey dkim.
  3. Publish the DNS record from dkim.dns (guide).
  4. Write the selector you chose to domains/$DOMAIN/dkim_selector.
  5. Copy dkim.key to /etc/chasquid/certs/$DOMAIN/dkim_privkey.pem.
  6. Verify the setup using one of the publicly available tools, like mail-tester.

Verification

Verifying signatures is technically supported as well, and can be done in the same hook. However, it's not recommended for SMTP servers to reject mail on verification failures (source 1, source 2), so it is not included in the example.