The authentication methods are a great tool for fighting against spammers and every server admin should have it implemented on their systems. But since it is not that simple to configure them, they often prove to be a headache with not enough documentation available. I had to pay myself the tribute (in hours spent) for making the system work in the configuration I wanted and for the others having the same problems here is my story.My configuration is : CentOS 5, Postfix 2.3.3
The server is running some websites and I wanted to be capable of sending signed emails within PHP and also using some email client through SMTP. Since there are more than one website I wanted also a simple way to add/modify domains in the filters' configuration.
Whenever I write "domain.tld" you should use your own domain name (mysite.com, wikitiki.org, etc)
The tools I installed are listed here under the Authentication section. They are:
dkfilter- a SMTP-proxy signing filter. Quite easy to install but, as the author says, it is good for sending authenticated email served by the port 587 not 25 which is why I give up on it. My server must be able to send emails from PHP and act as a SMTP mail server for another server.
- dkim-milter – DKIM signer/verifier (http://sourceforge.net/projects/dkim-milter/)
- dk-milter – Domainkeys sender/verifier. (http://sourceforge.net/projects/dk-milter/) Pay attention to these names because it is a lot of confusion because not only DK and DKIM sounds alike but their executable are called "filters": dkim-filter and dk-filter. Couldn't be much more complicated for newbies.
- sid-milter – Sender ID verifier. Note that it's a verifier only ! (http://sourceforge.net/projects/sid-milter/)
Installing dkim. For this follow one of these links:
I won't go through the installation steps you can read about in tutorials as above. Instead I will focus on what should be checked, customized, verified so that will help in custom installations or troubleshooting.
So, for the installation I will focus on:
|username/usergroup||domainkeys.domainkeys||This is the owner of the signer/verifier processes. Doesn't matter the names but once created will be used for all filters|
|folders for configuration||/etc/mail/dkim/
|These must be owned by the user above. When adding new domains I have to modify some files here|
|Essentially is the same start-up script configured for each filter. Good to know where they are when testing the configuration|
|folders for private keys||/var/db/domainkeys/domain.tld/||These must be owned by the user above. Here I'll place the private keys|
|folders & files for processes' PIDs||/var/run/dkim-milter/pid
|These also have to be owned by the user above. The filters will create/remove the "pid" files as they need|
OK, so here there are some background information. DKIM and Domainkeys uses two DNS records and a private key to sign the emails. The DNS records are
- policy record. It is defined as a TXT record :
_domainkey.domain.tld IN TXT "t=y;o=~"
t=y means the domain is in test mode. When everything works it can be changed to "n"
o=~ means that some emails will be signed. "o=-" means that all domains are signed
- selector record. Also a TXT record storing the key and other parameters:
default._domainkey.domain.tld IN TXT "g=*; k=rsa; p=MIGfMA0...ABC"
"default" is the selector name and will be the same as the one used for generating the keys – see below
"_domainkey" is a keyword preceding the domain name
"k=" key type. Optional. Default is rsa
"p=" public key data.
"g=" granularity of the key. Optional, default is "*"
"v=DKIM1" version. It is recommended but I got some errors when I tried to use the same record for Domainkeys because it is defined for DKIM only so I did not use it. Here is the yahoo tool I tested with
Note: in the two dns records above I used "domain.tld" only because my external nameserver service required it in its web interface. If you own the namesever you will probably not use it as will be appended automatically by named/bind
Important : the server may sign ALL emails with its own domain name or may sign it with other domains but in this case all other domains must have the two DNS records maintained. I went for the first option.
Generating the keys
there are three ways to generate them:
- online Domain Key / DKIM Key Generation Wizard
openssl genrsa -out private.key 1024 openssl rsa -in private.key -out public.key -pubout -outform PEM
- script included with the dkim:
dkim-genkey -r -d domain.tld
The result will always be two files, one private key to copy into /var/db/domainkeys/domain.tld/default and one to use it in the DNS record as value for "p=" parameter. Pay attention that I used "default" as filename for the private key in order to use that file for a selector named "default" and defined as such in the DNS record. It is possible to have different selectors which would handle different emails or domains and so I can have:
/var/db/domainkeys/domain.tld/m1.pem – this is created for the selectod m1 and I added an extension just to remember it is a private key file. the extension, if exists, must be "pem" or "private".
/var/db/domainkeys/otherdomain.tld/default – this one will serve emails for another domain with another selector named "default"
The init script
The init script will start|stop the filter and there is where I put the command to do that. It may have two forms, either with the configuration given as parameters to the executable app or with it uses a single parameter which points to a configuration file containing all settings. I used the 2nd option:
COMMAND="dkim-filter -x /etc/dkim.conf"
Then I put in the dkim.conf file all the configuration parameters I needed. Don't forget to make it readable by the user defined above (domainkeys). Some of the most important parameters I put there are:
KeyList /etc/mail/dkim/keylist MTA MSA Selector default UserID domainkeys:domainkeys Socket inet:8891@localhost
Don't forget that the port numbers will be used in your /etc/postfix/main.cf file:
smtpd_milters = inet:localhost:9967,inet:localhost:8891,inet:localhost:8892 non_smtpd_milters = inet:localhost:9967,inet:localhost:8891,inet:localhost:8892 milter_protocol = 2 [[code]]czozMDpcIm1pbHRlcl9kZWZhdWx0X2FjdGlvbiA9IGFjY2VwdFwiO3tbJiomXX0=[[/code]]
I have here 3 filters, dkim, domainkeys and sender-id, each on its own port. You will find below the entire configuration file I created.
The keylist file
the keylist file contains the relation between the sender-pattern, the signing domain and the path to the private key. I use this keylist file in order to manage easier the domains on my webhost server. For a singe domain one would only use the dkim's configuration file. My keylist file's location is defined in the configuration :
And contains :
..meaning: all emails (*) will be signed with the domain "domain.tld" using the private key from the file "/var/…/default".
The selector used in the signature will be the filename portion of keypath. If the file referenced by keypath cannot be opened, the filter will try again by appending ".pem" and then ".private" before giving up. (man dkim-filter.conf)
Useful commands, part I
postsuper -d ALL
Delete all mail queue. Sometimes due to too many unsent emails the logs are filled in continuously by the emails in queue. For a clean start it's good to have an empty mail queue. Be careful on a production server (you may just ignore it)
Send emails from command line. good for a quick test. Verify the results on a yahoo account for both DKIM and Domainkeys
telnet localhost 25 EHLO domain.tld MAIL FROM: email@example.com RCPT TO: firstname.lastname@example.org data bla bla . quit
This is a suite of commands to test sending email through SMTP. Or you can use an email client set for sending through SMTP protocol
php -r "mail('email@example.com','test mail','bla bla','From: firstname.lastname@example.org');"
Let the email be sent within PHP. This will test PHP mail() configuration
A note here: At a certain point my mail sent from PHP was not signed with Domainkeys, only with DKIM. After several tests I found that the $headers in my php script were using Windows separator for new like (\r\n) instead of Linux (\n). I never thought it matters in headers !
- Online tools: DomainKey Implementor's Tools and Library for email servers & clients especially "DomainKey Policy Record Tester." and "DomainKey Selector Record Tester."
tail -f /var/log/maillog
this is where I look for errors
As above, start with the download & installation from the given links from sourceforge or with the ones below:
man dk-filter – DomainKeys filter for sendmail online version of the man page for dk-filter
The DNS records follows the same rules as the DKIM above. In fact both DKIM and Domainkeys will use the same DNS records
The init script
The dk-filter does not support all parameters supported by DKIM and especially the one which would allow me to put all configuration in one file therefore the command from this initialization script has all parameters in one line:
COMMAND="dk-filter -u $USER -p inet:$PORT@localhost -l -P $PIDFILE -d $DOMAIN -S $SELECTOR -c simple -k -s $KEYFILE -i $IFILE -m $SUBMISSION_DAEMON -D"
- -u userid it runs under
- -p socket to be used by the filter for allowing connections from postfix. It must use a different port number than dkim (of course)
- -l log calls to syslog
- -P pidfile – the file used to write the process ID into
- -d domain list or path to a file containing the domain list one per line (wildcard * allowed in the domain name )
- -S selector, the name of the selector to be used
- -k Causes -s to be interpreted as the location of a key list
- -s keyfile or keyfilepath. Since -k is used this one will be a path to my keyfile (/etc/mail/domainkeys/keylist)
- -i a file of internal hosts whose mail should be signed rather than verified (/etc/mail/domainkeys/ilist)
- -D Sign subdomains too
The content of the keylist (differs from DKIM's !):
The ilist contains some IPs (local network's):
Note that I am using "/etc/mail/dkim/trusted-hosts" as value for the -d (domain) parameter. This is a path pointing to a dkim folder because I want to make as little changes as possible when adding or removing a domain so I use it for both filters.
The keylist file
This is another small difference than the DKIM's keylist file content. It looks like this (/etc/mail/domainkeys/keylist) :
Each line is in the form "sender-pattern:keypath" where sender-pattern is compared against the sender and keypath is the path to the private key file. The filename portion of this keypath is also the selector name
Some problems I run into
At some moment I got in maillog : "can't read SMFIC_EOH reply packet header: Success" which was solved after setting the SUBMISSION_DAEMON above as MSA (instead of smtp as I saw somewhere)
Playing with milter_protocol=4 in /etc/postfix/main.cf I got "can't read SMFIC_DATA reply packet header: Success" which was because I've given a value which was not supported. Also milter_protocol=6 thrown error so I let it set on : milter_protocol = 2
Useful commands, part II
Display the default postfix configuration
Display the non-default parameters of the postfix configuration
/usr/sbin/sendmail -t -f email@example.com firstname.lastname@example.org From: email@example.com Subject: test it bla bla .
Test sending email using the sendmail command as defined in the php.ini . Note that php.ini has an additional parameter for sendmail, "-i" which suppress the use of a dot as "end of input" data.
ps aux |grep dk
This should confirm that the filters are running (dk-filter and dkim-filter). It was useful to check this because when I got errors from filters they had just ended silently.
This would be the 3rd filter installed and is aimed for hotmail accounts. There is a confusion between Sender-ID and SPF because they both use the same DNS registration record but the implementation of the Sender-ID protocol is similar with DKIM above. Read more about SPF vs Sender ID
Note that in order to sign the emails correctly one would only need the SPF record – see next section. At least this should work for 80% of the emails sent to hotmail/MSN according to the link above.
The init script
I named the init script "/etc/init.d/sender-id" and the command used to start the filter is:
COMMAND="sid-filter -u $USER -t -p inet:$PORT@localhost -l -P $PIDFILE -d $DOMAIN -D -h"
The parameters means:
- -u username to run under
- -t test mode (never reject messages)
- -p socketspecs the socket for postfix to communicate with
- -l log via syslog (/var/log/maillog)
- -P the filename which will store the PID of the current process
- -d a list of domains whose emails should be ignored by this filter.
Warning : this is a list of the domains to be ignored so if you want to see this filter's signature in the header of your emails then use an empty value for DOMAIN. Somehow strange in my opinion.
- -D the way to handle the DNS errors (soft failures)
- -h adds a header indicating the presence of this filter
The SPF authentication is used by google and is quite simple requiring no software installation on the server. In order to generate a SPF record for your domain you will probably have to go to the most-used tool :
The record it will create should be placed as a TXT record at your domain and looks like this:
v=spf1 a a:external.domain.tld ~all
- "v=spf1" is the SPF protocol version
- "a" mechanism matching current domain (e.g. my own domain.tld)
- "a:external.domain.tld" mechanism matching an external domain which may use my own domain.tld to send emails
- "mx" mechanism matches the current domain's MX records. Useful if I want to have a secondary server act only as mail server
- "all" mechanism matches everything else. It usually stay at the end. The character which prefixes this mechanism means "SoftFail" and it only indicates that all other domains than the one defined won't be recognizable by this SPF record
Definition: Mechanisms can be used to describe the set of hosts which are designated outbound mailers for the domain.
Observation: the SPF standard specify that there should be used the new DNS registration record type SPF instead of TXT but because of compatibility with the current DNS implementations it is recommended to put both TXT and SPF records with the same content.
Useful commands, part III
Here are some of the tools and commands I used to verify that the record is in place and the configurations above are working:
dig domain.tld TXT
This would query the nameserver for the TXT record and should return something like:
;; ANSWER SECTION: domain.tld. 300 IN TXT "v=spf1 a a:external.domain.tld ~all"
- Send an email with an empty subject to firstname.lastname@example.org . I strongly recommend using an email client because sending from comand prompt resulted sometime in failed Domainkey verification due to probably some extra characters added into the headers. The result will arrive in email and should look like this:
The Port25 Solutions, Inc. team
Summary of Results
SPF check: pass
DomainKeys check: pass
DKIM check: pass
Sender-ID check: pass
SpamAssassin check: ham
cd /etc/init.d/; chkconfig --add sender-id
this adds the script to the list of programs which should run after restart. Do this for each init script
I invite any reader to help improving this newbie-guide based on their experience and knowledge. There is plenty room for suggestions and additions to this article but this is an area where with all documentation available it seems that it is not enough or not covers all configuration or problems which may occur when setting up such a system. I spent myself several (many) good hours reading and learning, trying and failing or succeeding and finally writing this article hoping that will help others to save some of their time and neurons while trying to follow the latest recommendation of the war against spammers.
Although not required, a donation is always welcome end encouraging
DKIM configuration file /etc/dkim.conf
DKIM startup script /etc/init.d/dkim
Domainkeys startup script /etc/init.d/domainkeys
Sender-id startup script /etc/init.d/sender-id
Email authentication guide made by BITS
Last update: May 5th, 2010