Skip to content

# DKIM

DKIM is a security measure targeting email spoofing. It is greatly recommended one activates it.

Note

See the Wikipedia page for more details on DKIM.

## Enabling DKIM Signature

To enable DKIM signature, you must have created at least one email account. Once its done, just run the following command to generate the signature:

    ./setup.sh config dkim

After generating DKIM keys, you should restart `docker-mailserver`. DNS edits may take a few minutes to hours to propagate.

The script should ideally be run with a volume for config attached (eg: `./docker-data/dms/config/:/tmp/docker-mailserver/`), otherwise by default it will mount `./config/:/tmp/docker-mailserver/`.

The default keysize when generating the signature is 4096 bits for now. If you need to change it (e.g. your DNS provider limits the size), then provide the size as the first parameter of the command:

    ./setup.sh config dkim keysize <keysize>

For LDAP systems that do not have any directly created user account you can run the following command (since `8.0.0`) to generate the signature by additionally providing the desired domain name (if you have multiple domains use the command multiple times or provide a comma-separated list of domains):

    ./setup.sh config dkim keysize <key-size> domain <example.com>[,<not-example.com>]

Now the keys are generated, you can configure your DNS server with DKIM signature, simply by adding a TXT record. If you have direct access to your DNS zone file, then it's only a matter of pasting the content of `docker-data/dms/config/opendkim/keys/example.com/mail.txt` in your `example.com.hosts` zone.

    $ dig mail._domainkey.example.com TXT
    ---
    ;; ANSWER SECTION
    mail._domainkey.<DOMAIN> 300 IN TXT    "v=DKIM1; k=rsa; p=AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN/AZERTYUIOPQSDFGHJKLMWXCVBN"

## Configuration using a Web Interface

1. Generate a new record of the type `TXT`.
2. Paste `mail._domainkey` the `Name` txt field.
3. In the `Target` or `Value` field fill in `v=DKIM1; k=rsa; p=AZERTYUGHJKLMWX...`.
4. In `TTL` (time to live): Time span in seconds. How long the DNS server should cache the `TXT` record.
5. Save.

Note

Sometimes the key in `docker-data/dms/config/opendkim/keys/example.com/mail.txt` can be on multiple lines. If so then you need to concatenate the values in the TXT record:

    $ dig mail._domainkey.example.com TXT
    ---
    ;; ANSWER SECTION
    mail._domainkey.<DOMAIN> 300 IN TXT "v=DKIM1; k=rsa; "
        "p=AZERTYUIOPQSDF..."
        "asdfQWERTYUIOPQSDF..."

The target (or value) field must then have all the parts together: `v=DKIM1; k=rsa; p=AZERTYUIOPQSDF...asdfQWERTYUIOPQSDF...`

## Verify-Only

If you want DKIM to only verify incoming emails, the following version of `/etc/opendkim.conf` may be useful (right now there is no easy mechanism for installing it other than forking the repo):

    # This is a simple config file verifying messages only

    #LogWhy                 yes
    Syslog                  yes
    SyslogSuccess           yes

    Socket                  inet:12301@localhost
    PidFile                 /var/run/opendkim/opendkim.pid

    ReportAddress           postmaster@example.com
    SendReports             yes

    Mode                    v

## Switch Off DKIM

Simply remove the DKIM key by recreating (not just relaunching) the `docker-mailserver` container.

## Debugging

- DKIM-verifer: A add-on for the mail client Thunderbird.
- You can debug your TXT records with the `dig` tool.

    $ dig TXT mail._domainkey.example.com
    ---
    ; <<>> DiG 9.10.3-P4-Debian <<>> TXT mail._domainkey.example.com
    ;; global options: +cmd
    ;; Got answer:
    ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 39669
    ;; flags: qr rd ra; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 1

    ;; OPT PSEUDOSECTION:
    ; EDNS: version: 0, flags:; udp: 512
    ;; QUESTION SECTION:
    ;mail._domainkey.example.com. IN TXT

    ;; ANSWER SECTION:
    mail._domainkey.example.com. 3600 IN TXT "v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCxBSjG6RnWAdU3oOlqsdf2WC0FOUmU8uHVrzxPLW2R3yRBPGLrGO1++yy3tv6kMieWZwEBHVOdefM6uQOQsZ4brahu9lhG8sFLPX4MaKYN/NR6RK4gdjrZu+MYSdfk3THgSbNwIDAQAB"

    ;; Query time: 50 msec
    ;; SERVER: 127.0.1.1#53(127.0.1.1)
    ;; WHEN: Wed Sep 07 18:22:57 CEST 2016
    ;; MSG SIZE  rcvd: 310

Key sizes >=4096-bit

Keys of 4096 bits could de denied by some mail-servers. According to https://tools.ietf.org/html/rfc6376 keys are preferably between 512 and 2048 bits. See issue #1854.

Back to top