home old db
documentation:zdkimfilter zdkimsign redact zaggregate zfilter_db zdkimfilter.conf zdkimgenkey

ZDKIMFILTER
"z" DKIM filter for Courier-MTA

Download

current--> v3.13 Wed 11 Jan 2023 11:01:47 [gpg signature] [announce] [rel.notes]
v3.12 Wed 04 Jan 2023 13:01:47 [gpg signature] [announce] [rel.notes]
v3.11 Wed 29 Jun 2022 09:06:27 [gpg signature] [announce] [rel.notes]
v3.10 Tue 17 May 2022 16:05:18 [gpg signature] [announce] [rel.notes]
v3.9 Sat 26 Feb 2022 11:02:36 [gpg signature] [announce] [rel.notes]
v3.8 Sat 20 Nov 2021 17:11:45 [gpg signature] [announce] [rel.notes]

zdkimfilter source repository can also be accessed using Subversion or a web browser. In that case, check READMEsvn before building.
For example, to get the latest sources:

Packages and installation

Gentoo: Daniel Black and Hanno Böck added this to gentoo linux.

RPM: Zenon Panoussis contributed an RPM .spec, available here. It is included in recent tarballs. See his message for details

Debian: Viktor Szépe created the setup, and the debian subdirectory is included in the tarball since version 1.6. That way, tarball users can build a Debian package instead of a local installation obtained by ./configure. An experimental Debian binary package built on AMD (Ryzen) by dpkg-buildpackage -us -uc can be found here.

Basic installation: Even if you're not using Debian, the postinst script can be read as a guide for post-installation instructions. Some useful Courier settings are as follows:
BOFHSPFHELO, BOFHSPFMAILFROM, and BOFHSPFFROM (suit your taste, but enable SPF evaluation),
ALLOW_EXCLUSIVE in esmtpd, and then trust_a_r in zdkimfilter.conf,
MIME=none in esmtpd (this hasn't its prepared stanza),
MIME=some in esmtpd-msa (this hasn't its prepared stanza),
NOADDRREWRITE=2 in esmtpd (not needed in newer Courier versions).
A couple of tweaks to handle DMARC quarantine and From: demunging are documented in the man page.

Complete installation requires a database. The examples included in the distribution are based on MySQL and explained in the DB page. This work can be customized at will, which is why they're called examples. An utility to browse the database is still missing; maybe next version will feature something to tweak per-domain options. Other "obvious" settings, such as managing bounces of sent-out reports, are not even mentioned. Finally, in order to complete DMARC installation, you need to parse aggregate reports received from your targets and possibly feed the database. You may want to consider transforming aggregate reports to more readable HTML using dmarc-xls.

Requirements

(*) Versions older than 3.0 require libopendkim

(†) With OpenDBX it is possible to deploy several DBMS by editing the queries in the coniguration files. The reference configuration, however, works with MariaDB. MySQL is not compatible as it misses the INET6 data type.

DMARC

The complete installation automates sending DMARC aggregate reports.

As is well known, forwarding modified messages may require to rewrite From:. That is one of the means for mitigating DMARC damage to third party mail. This filter attempts to recognize transformations typical of mailing lists, and adds auxiliary header fields to ease such recognition. This feature seems to work if authors avoid signing list specific fields, such as MIME-Version:, Content-Type: and Content-Transfer-Encoding:.

For sending, there is a Python script to forward mail safely, shielding from strict DMARC policies. Designed for .courier files, the script does a Mailman style mitigation —possibly munge From: and save the original value in the Reply-To:. dmarc_shield3.py is published by Lindsay Haisley.

For receiving, zdkimfilter tries to revert that munging and verify the original author domain's signature. If it succeeds, it sets the header so that a Maildrop instruction can restore the original value of From: after any external forwarding (see zdkimfilter(8) man page).

ARC

Since version 3.12, zdkimfilter verifies ARC set chains. zarcseal is a new alias for the zdkimsign wrapper, to be used on forwarding.

There is more to be done to unleash ARC's potential to dismiss From: munging in mailing list. We need a mailing list willing to experiment new settings in order to put ideas into practice.

License

GPLv3

Keep in mind that DKIM relies on patented technology (US6986049) that may require a separate licence.

As far as software copyright is concerned, zdkimfilter is free software: you can redistribute it and/or modify it under the terms of the GNU General Public Licence as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

zdkimfilter is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public Licence for more details.

As an additional permission under GNU GPLv3 section 7,

If you modify zdkimfilter, or any covered part of it, by linking or combining it with OpenSSL, OpenDKIM, Sendmail, or any software developed by The Trusted Domain Project or Sendmail Inc., containing parts covered by the applicable licence, the licensor of zdkimfilter grants you additional permission to convey the resulting work.

Copyright (C) 2012-2023 Alessandro Vesely