Merge branch 'patch-3' of https://github.com/bes-internal/exim into master_dmarc_doc
[exim.git] / doc / doc-txt / experimental-spec.txt
1 From time to time, experimental features may be added to Exim.
2 While a feature  is experimental, there  will be a  build-time
3 option whose name starts  "EXPERIMENTAL_" that must be  set in
4 order to include the  feature. This file contains  information
5 about experimental  features, all  of which  are unstable and
6 liable to incompatible change.
7
8
9 PRDR support
10 --------------------------------------------------------------
11
12 Per-Recipient Data Reponse is an SMTP extension proposed by Eric Hall
13 in a (now-expired) IETF draft from 2007.  It's not hit mainstream
14 use, but has apparently been implemented in the META1 MTA.
15
16 There is mention at http://mail.aegee.org/intern/sendmail.html
17 of a patch to sendmail "to make it PRDR capable".
18
19  ref: http://www.eric-a-hall.com/specs/draft-hall-prdr-00.txt
20
21 If Exim is built with EXPERIMENTAL_PRDR there is a new config
22 boolean "prdr_enable" which controls whether PRDR is advertised
23 as part of an EHLO response, a new "acl_data_smtp_prdr" ACL
24 (called for each recipient, after data arrives but before the
25 data ACL), and a new smtp transport option "hosts_try_prdr".
26
27 PRDR may be used to support per-user content filtering.  Without it
28 one must defer any recipient after the first that has a different
29 content-filter configuration.  With PRDR, the RCPT-time check
30 for this can be disabled when the MAIL-time $smtp_command included
31 "PRDR".  Any required difference in behaviour of the main DATA-time
32 ACL should however depend on the PRDR-time ACL having run, as Exim
33 will avoid doing so in some situations (eg.  single-recipient mails).
34
35
36
37 OCSP Stapling support
38 --------------------------------------------------------------
39
40 X.509 PKI certificates expire and can be revoked; to handle this, the
41 clients need some way to determine if a particular certificate, from a
42 particular Certificate Authority (CA), is still valid.  There are three
43 main ways to do so.
44
45 The simplest way is to serve up a Certificate Revocation List (CRL) with
46 an ordinary web-server, regenerating the CRL before it expires.  The
47 downside is that clients have to periodically re-download a potentially
48 huge file from every certificate authority it knows of.
49
50 The way with most moving parts at query time is Online Certificate
51 Status Protocol (OCSP), where the client verifies the certificate
52 against an OCSP server run by the CA.  This lets the CA track all
53 usage of the certs.  This requires running software with access to the
54 private key of the CA, to sign the responses to the OCSP queries.  OCSP
55 is based on HTTP and can be proxied accordingly.
56
57 The only widespread OCSP server implementation (known to this writer)
58 comes as part of OpenSSL and aborts on an invalid request, such as
59 connecting to the port and then disconnecting.  This requires
60 re-entering the passphrase each time some random client does this.
61
62 The third way is OCSP Stapling; in this, the server using a certificate
63 issued by the CA periodically requests an OCSP proof of validity from
64 the OCSP server, then serves it up inline as part of the TLS
65 negotiation.   This approach adds no extra round trips, does not let the
66 CA track users, scales well with number of certs issued by the CA and is
67 resilient to temporary OCSP server failures, as long as the server
68 starts retrying to fetch an OCSP proof some time before its current
69 proof expires.  The downside is that it requires server support.
70
71 If Exim is built with EXPERIMENTAL_OCSP and it was built with OpenSSL,
72 then it gains a new global option: "tls_ocsp_file".
73
74 The file specified therein is expected to be in DER format, and contain
75 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
76 option will be re-expanded for SNI, if the tls_certificate option
77 contains $tls_sni, as per other TLS options.
78
79 Exim does not at this time implement any support for fetching a new OCSP
80 proof.  The burden is on the administrator to handle this, outside of
81 Exim.  The file specified should be replaced atomically, so that the
82 contents are always valid.  Exim will expand the "tls_ocsp_file" option
83 on each connection, so a new file will be handled transparently on the
84 next connection.
85
86 Exim will check for a valid next update timestamp in the OCSP proof;
87 if not present, or if the proof has expired, it will be ignored.
88
89 Also, given EXPERIMENTAL_OCSP and OpenSSL, the smtp transport gains
90 a "hosts_require_ocsp" option; a host-list for which an OCSP Stapling
91 is requested and required for the connection to proceed.  The host(s)
92 should also be in "hosts_require_tls", and "tls_verify_certificates"
93 configured for the transport.
94
95 For the client to be able to verify the stapled OCSP the server must
96 also supply, in its stapled information, any intermediate
97 certificates for the chain leading to the OCSP proof from the signer
98 of the server certificate.  There may be zero or one such. These
99 intermediate certificates should be added to the server OCSP stapling
100 file (named by tls_ocsp_file).
101
102 At this point in time, we're gathering feedback on use, to determine if
103 it's worth adding complexity to the Exim daemon to periodically re-fetch
104 OCSP files and somehow handling multiple files.
105
106   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
107   OCSP server is supplied.  The server URL may be included in the
108   server certificate, if the CA is helpful.
109
110   One fail mode seen was the OCSP Signer cert expiring before the end
111   of vailidity of the OCSP proof. The checking done by Exim/OpenSSL
112   noted this as invalid overall, but the re-fetch script did not.
113
114
115
116
117 Brightmail AntiSpam (BMI) suppport
118 --------------------------------------------------------------
119
120 Brightmail  AntiSpam  is  a  commercial  package.  Please  see
121 http://www.brightmail.com    for    more    information     on
122 the product. For  the sake of  clarity, we'll refer  to it  as
123 "BMI" from now on.
124
125
126 0) BMI concept and implementation overview
127
128 In  contrast  to   how  spam-scanning  with   SpamAssassin  is
129 implemented  in  exiscan-acl,  BMI  is  more  suited  for  per
130 -recipient  scanning of  messages. However,  each messages  is
131 scanned  only  once,  but  multiple  "verdicts"  for  multiple
132 recipients can be  returned from the  BMI server. The  exiscan
133 implementation  passes  the  message to  the  BMI  server just
134 before accepting it.  It then adds  the retrieved verdicts  to
135 the messages header file in the spool. These verdicts can then
136 be  queried  in  routers,  where  operation  is  per-recipient
137 instead  of per-message.  To use  BMI, you  need to  take the
138 following steps:
139
140   1) Compile Exim with BMI support
141   2) Set up main BMI options (top section of Exim config file)
142   3) Set up ACL control statement (ACL section of the config
143      file)
144   4) Set up your routers to use BMI verdicts (routers section
145      of the config file).
146   5) (Optional) Set up per-recipient opt-in information.
147
148 These four steps are explained in more details below.
149
150 1) Adding support for BMI at compile time
151
152   To compile with BMI support,  you need to link Exim  against
153   the   Brighmail  client   SDK,  consisting   of  a   library
154   (libbmiclient_single.so)  and  a  header  file  (bmi_api.h).
155   You'll also need to explicitly set a flag in the Makefile to
156   include BMI support in the Exim binary. Both can be achieved
157   with  these lines in Local/Makefile:
158
159   EXPERIMENTAL_BRIGHTMAIL=yes
160   CFLAGS=-I/path/to/the/dir/with/the/includefile
161   EXTRALIBS_EXIM=-L/path/to/the/dir/with/the/library -lbmiclient_single
162
163   If  you use  other CFLAGS  or EXTRALIBS_EXIM  settings then
164   merge the content of these lines with them.
165
166   Note for BMI6.x users: You'll also have to add -lxml2_single
167   to the EXTRALIBS_EXIM line. Users of 5.5x do not need to  do
168   this.
169
170   You    should     also    include     the    location     of
171   libbmiclient_single.so in your dynamic linker  configuration
172   file   (usually   /etc/ld.so.conf)   and   run    "ldconfig"
173   afterwards, or  else the  produced Exim  binary will  not be
174   able to find the library file.
175
176
177 2) Setting up BMI support in the Exim main configuration
178
179   To enable BMI  support in the  main Exim configuration,  you
180   should set the path to the main BMI configuration file  with
181   the "bmi_config_file" option, like this:
182
183   bmi_config_file = /opt/brightmail/etc/brightmail.cfg
184
185   This must go into section 1 of Exim's configuration file (You
186   can  put it  right on  top). If  you omit  this option,  it
187   defaults to /opt/brightmail/etc/brightmail.cfg.
188
189   Note for BMI6.x users: This  file is in XML format  in V6.xx
190   and its  name is  /opt/brightmail/etc/bmiconfig.xml. So  BMI
191   6.x users MUST set the bmi_config_file option.
192
193
194 3) Set up ACL control statement
195
196   To  optimize performance,  it makes  sense only  to process
197   messages coming from remote, untrusted sources with the  BMI
198   server.  To set  up a  messages for  processing by  the BMI
199   server, you MUST set the "bmi_run" control statement in  any
200   ACL for an incoming message.  You will typically do this  in
201   an "accept"  block in  the "acl_check_rcpt"  ACL. You should
202   use the "accept" block(s)  that accept messages from  remote
203   servers for your own domain(s). Here is an example that uses
204   the "accept" blocks from Exim's default configuration file:
205
206
207   accept  domains       = +local_domains
208           endpass
209           verify        = recipient
210           control       = bmi_run
211
212   accept  domains       = +relay_to_domains
213           endpass
214           verify        = recipient
215           control       = bmi_run
216
217   If bmi_run  is not  set in  any ACL  during reception of the
218   message, it will NOT be passed to the BMI server.
219
220
221 4) Setting up routers to use BMI verdicts
222
223   When a message has been  run through the BMI server,  one or
224   more "verdicts" are  present. Different recipients  can have
225   different verdicts. Each  recipient is treated  individually
226   during routing, so you  can query the verdicts  by recipient
227   at  that stage.  From Exim's  view, a  verdict can  have the
228   following outcomes:
229
230   o deliver the message normally
231   o deliver the message to an alternate location
232   o do not deliver the message
233
234   To query  the verdict  for a  recipient, the  implementation
235   offers the following tools:
236
237
238   - Boolean router  preconditions. These  can be  used in  any
239     router. For a simple  implementation of BMI, these  may be
240     all  that  you  need.  The  following  preconditions   are
241     available:
242
243     o bmi_deliver_default
244
245       This  precondition  is  TRUE  if  the  verdict  for  the
246       recipient is  to deliver  the message  normally. If  the
247       message has not been  processed by the BMI  server, this
248       variable defaults to TRUE.
249
250     o bmi_deliver_alternate
251
252       This  precondition  is  TRUE  if  the  verdict  for  the
253       recipient  is to  deliver the  message to  an alternate
254       location.  You  can  get the  location  string  from the
255       $bmi_alt_location expansion variable if you need it. See
256       further below. If the message has not been processed  by
257       the BMI server, this variable defaults to FALSE.
258
259     o bmi_dont_deliver
260
261       This  precondition  is  TRUE  if  the  verdict  for  the
262       recipient  is  NOT  to   deliver  the  message  to   the
263       recipient. You will typically use this precondition in a
264       top-level blackhole router, like this:
265
266         # don't deliver messages handled by the BMI server
267         bmi_blackhole:
268           driver = redirect
269           bmi_dont_deliver
270           data = :blackhole:
271
272       This router should be on top of all others, so  messages
273       that should not be delivered do not reach other  routers
274       at all. If   the  message  has  not  been  processed  by
275       the  BMI server, this variable defaults to FALSE.
276
277
278   - A list router  precondition to query  if rules "fired"  on
279     the message for the recipient. Its name is "bmi_rule". You
280     use  it  by  passing it  a  colon-separated  list of  rule
281     numbers. You can use this condition to route messages that
282     matched specific rules. Here is an example:
283
284       # special router for BMI rule #5, #8 and #11
285       bmi_rule_redirect:
286         driver = redirect
287         bmi_rule = 5:8:11
288         data = postmaster@mydomain.com
289
290
291   - Expansion variables. Several  expansion variables are  set
292     during  routing.  You  can  use  them  in  custom   router
293     conditions,  for  example.  The  following  variables  are
294     available:
295
296     o $bmi_base64_verdict
297
298       This variable  will contain  the BASE64  encoded verdict
299       for the recipient being routed. You can use it to add  a
300       header to messages for tracking purposes, for example:
301
302       localuser:
303         driver = accept
304         check_local_user
305         headers_add = X-Brightmail-Verdict: $bmi_base64_verdict
306         transport = local_delivery
307
308       If there is no verdict available for the recipient being
309       routed, this variable contains the empty string.
310
311     o $bmi_base64_tracker_verdict
312
313       This variable  will contain  a BASE64  encoded subset of
314       the  verdict  information  concerning  the  "rules" that
315       fired  on the  message. You  can add  this string  to a
316       header, commonly named "X-Brightmail-Tracker". Example:
317
318       localuser:
319         driver = accept
320         check_local_user
321         headers_add = X-Brightmail-Tracker: $bmi_base64_tracker_verdict
322         transport = local_delivery
323
324       If there is no verdict available for the recipient being
325       routed, this variable contains the empty string.
326
327     o $bmi_alt_location
328
329       If  the  verdict  is  to  redirect  the  message  to  an
330       alternate  location,  this  variable  will  contain  the
331       alternate location string returned by the BMI server. In
332       its default configuration, this is a header-like  string
333       that can be added to the message with "headers_add".  If
334       there is  no verdict  available for  the recipient being
335       routed, or if the  message is to be  delivered normally,
336       this variable contains the empty string.
337
338     o $bmi_deliver
339
340       This is an additional integer variable that can be  used
341       to query if the message should be delivered at all.  You
342       should use router preconditions instead if possible.
343
344       $bmi_deliver is '0': the message should NOT be delivered.
345       $bmi_deliver is '1': the message should be delivered.
346
347
348   IMPORTANT NOTE: Verdict inheritance.
349   The  message  is passed  to  the BMI  server  during message
350   reception,  using the  target addresses  from the  RCPT TO:
351   commands in the SMTP transaction. If recipients get expanded
352   or re-written (for example by aliasing), the new address(es)
353   inherit the  verdict from  the original  address. This means
354   that verdicts also apply to all "child" addresses  generated
355   from top-level addresses that were sent to the BMI server.
356
357
358 5) Using per-recipient opt-in information (Optional)
359
360   The  BMI server  features multiple  scanning "profiles"  for
361   individual recipients.  These are  usually stored  in a LDAP
362   server and are  queried by the  BMI server itself.  However,
363   you can also  pass opt-in data  for each recipient  from the
364   MTA to the  BMI server. This  is particularly useful  if you
365   already look  up recipient  data in  Exim anyway  (which can
366   also be  stored in  a SQL  database or  other source).  This
367   implementation enables you  to pass opt-in  data to the  BMI
368   server  in  the  RCPT   ACL.  This  works  by   setting  the
369   'bmi_optin' modifier in  a block of  that ACL. If  should be
370   set to a list  of comma-separated strings that  identify the
371   features which the BMI server should use for that particular
372   recipient. Ideally, you  would use the  'bmi_optin' modifier
373   in the same  ACL block where  you set the  'bmi_run' control
374   flag. Here is an example that will pull opt-in data for each
375   recipient      from       a      flat       file      called
376   '/etc/exim/bmi_optin_data'.
377
378   The file format:
379
380     user1@mydomain.com: <OPTIN STRING1>:<OPTIN STRING2>
381     user2@thatdomain.com: <OPTIN STRING3>
382
383
384   The example:
385
386     accept  domains       = +relay_to_domains
387             endpass
388             verify        = recipient
389             bmi_optin     = ${lookup{$local_part@$domain}lsearch{/etc/exim/bmi_optin_data}}
390             control       = bmi_run
391
392   Of course,  you can  also use  any other  lookup method that
393   Exim supports, including LDAP, Postgres, MySQL, Oracle etc.,
394   as long as  the result is  a list of  colon-separated opt-in
395   strings.
396
397   For a list of available opt-in strings, please contact  your
398   Brightmail representative.
399
400
401
402
403 Sender Policy Framework (SPF) support
404 --------------------------------------------------------------
405
406 To learn  more  about  SPF, visit   http://www.openspf.org. This
407 document does   not explain  the SPF  fundamentals, you should
408 read and understand the implications of deploying SPF on  your
409 system before doing so.
410
411 SPF support is added via the libspf2 library. Visit
412
413   http://www.libspf2.org/
414
415 to obtain  a copy,  then compile  and install  it. By default,
416 this will  put headers  in /usr/local/include  and the  static
417 library in /usr/local/lib.
418
419 To compile Exim with SPF support, set these additional flags in
420 Local/Makefile:
421
422 EXPERIMENTAL_SPF=yes
423 CFLAGS=-DSPF -I/usr/local/include
424 EXTRALIBS_EXIM=-L/usr/local/lib -lspf2
425
426 This assumes   that the   libspf2 files   are installed  in
427 their default locations.
428
429 You can now run SPF checks in incoming SMTP by using the "spf"
430 ACL condition  in either  the MAIL,  RCPT or  DATA ACLs.  When
431 using it in the RCPT ACL, you can make the checks dependent on
432 the RCPT  address (or  domain), so  you can  check SPF records
433 only  for   certain  target   domains.  This   gives  you  the
434 possibility  to opt-out  certain customers  that do  not want
435 their mail to be subject to SPF checking.
436
437 The spf condition  takes a list  of strings on  its right-hand
438 side. These strings describe the outcome of the SPF check  for
439 which the spf condition should succeed. Valid strings are:
440
441   o pass      The SPF check passed, the sending host
442               is positively verified by SPF.
443   o fail      The SPF check failed, the sending host
444               is NOT allowed to send mail for the domain
445               in the envelope-from address.
446   o softfail  The SPF check failed, but the queried
447               domain can't absolutely confirm that this
448               is a forgery.
449   o none      The queried domain does not publish SPF
450               records.
451   o neutral   The SPF check returned a "neutral" state.
452               This means the queried domain has published
453               a SPF record, but wants to allow outside
454               servers to send mail under its domain as well.
455   o err_perm  This indicates a syntax error in the SPF
456               record of the queried domain. This should be
457               treated like "none".
458   o err_temp  This indicates a temporary error during all
459               processing, including Exim's SPF processing.
460               You may defer messages when this occurs.
461
462 You can prefix each string with an exclamation mark to  invert
463 is meaning,  for example  "!fail" will  match all  results but
464 "fail".  The  string  list is  evaluated  left-to-right,  in a
465 short-circuit fashion.  When a  string matches  the outcome of
466 the SPF check, the condition  succeeds. If none of the  listed
467 strings matches the  outcome of the  SPF check, the  condition
468 fails.
469
470 Here is an example to fail forgery attempts from domains that
471 publish SPF records:
472
473 /* -----------------
474 deny message = $sender_host_address is not allowed to send mail from ${if def:sender_address_domain {$sender_address_domain}{$sender_helo_name}}.  \
475               Please see http://www.openspf.org/Why?scope=${if def:sender_address_domain {mfrom}{helo}};identity=${if def:sender_address_domain {$sender_address}{$sender_helo_name}};ip=$sender_host_address
476      spf = fail
477 --------------------- */
478
479 You can also give special treatment to specific domains:
480
481 /* -----------------
482 deny message = AOL sender, but not from AOL-approved relay.
483      sender_domains = aol.com
484      spf = fail:neutral
485 --------------------- */
486
487 Explanation: AOL  publishes SPF  records, but  is liberal  and
488 still allows  non-approved relays  to send  mail from aol.com.
489 This will result in a "neutral" state, while mail from genuine
490 AOL servers  will result  in "pass".  The example  above takes
491 this into account and  treats "neutral" like "fail",  but only
492 for aol.com. Please note that this violates the SPF draft.
493
494 When the spf condition has run, it sets up several expansion
495 variables.
496
497   $spf_header_comment
498   This contains a human-readable string describing the outcome
499   of the SPF check. You can add it to a custom header or use
500   it for logging purposes.
501
502   $spf_received
503   This contains a complete Received-SPF: header that can be
504   added to the message. Please note that according to the SPF
505   draft, this header must be added at the top of the header
506   list. Please see section 10 on how you can do this.
507
508   Note: in case of "Best-guess" (see below), the convention is
509   to put this string in a header called X-SPF-Guess: instead.
510
511   $spf_result
512   This contains the outcome of the SPF check in string form,
513   one of pass, fail, softfail, none, neutral, err_perm or
514   err_temp.
515
516   $spf_smtp_comment
517   This contains a string that can be used in a SMTP response
518   to the calling party. Useful for "fail".
519
520 In addition to SPF, you can also perform checks for so-called
521 "Best-guess".  Strictly speaking, "Best-guess" is not standard
522 SPF, but it is supported by the same framework that enables SPF
523 capability.  Refer to http://www.openspf.org/FAQ/Best_guess_record
524 for a description of what it means.
525
526 To access this feature, simply use the spf_guess condition in place
527 of the spf one.  For example:
528
529 /* -----------------
530 deny message = $sender_host_address doesn't look trustworthy to me
531      spf_guess = fail
532 --------------------- */
533
534 In case you decide to reject messages based on this check, you
535 should note that although it uses the same framework, "Best-guess"
536 is NOT SPF, and therefore you should not mention SPF at all in your
537 reject message.
538
539 When the spf_guess condition has run, it sets up the same expansion
540 variables as when spf condition is run, described above.
541
542 Additionally, since Best-guess is not standardized, you may redefine
543 what "Best-guess" means to you by redefining spf_guess variable in
544 global config.  For example, the following:
545
546 /* -----------------
547 spf_guess = v=spf1 a/16 mx/16 ptr ?all
548 --------------------- */
549
550 would relax host matching rules to a broader network range.
551
552
553 SRS (Sender Rewriting Scheme) Support
554 --------------------------------------------------------------
555
556 Exiscan  currently  includes SRS  support  via Miles  Wilton's
557 libsrs_alt library. The current version of the supported
558 library is 0.5.
559
560 In order to  use SRS, you  must get a  copy of libsrs_alt from
561
562 http://srs.mirtol.com/
563
564 Unpack the tarball, then refer to MTAs/README.EXIM
565 to proceed. You need to set
566
567 EXPERIMENTAL_SRS=yes
568
569 in your Local/Makefile.
570
571
572 DCC Support
573 --------------------------------------------------------------
574
575 *) Building exim
576
577 In order to build exim with DCC support add
578
579 EXPERIMENTAL_DCC=yes
580
581 to your Makefile. (Re-)build/install exim. exim -d should show
582 EXPERIMENTAL_DCC under "Support for".
583
584
585 *) Configuration
586
587 In the main section of exim.cf add at least
588   dccifd_address = /usr/local/dcc/var/dccifd
589 or
590   dccifd_address = <ip> <port>
591
592 In the DATA ACL you can use the new condition
593         dcc = *
594
595 After that "$dcc_header" contains the X-DCC-Header.
596
597 Return values are:
598   fail    for overall "R", "G" from dccifd
599   defer   for overall "T" from dccifd
600   accept  for overall "A", "S" from dccifd
601
602 dcc = */defer_ok works as for spamd.
603
604 The "$dcc_result" variable contains the overall result from DCC
605 answer.  There will an X-DCC: header added to the mail.
606
607 Usually you'll use
608   defer   !dcc = *
609 to greylist with DCC.
610
611 If you set, in the main section,
612   dcc_direct_add_header = true
613 then the dcc header will be added "in deep" and if the spool
614 file was already written it gets removed. This forces Exim to
615 write it again if needed.  This helps to get the DCC Header
616 through to eg. SpamAssassin.
617
618 If you want to pass even more headers in the middle of the
619 DATA stage you can set
620   $acl_m_dcc_add_header
621 to tell the DCC routines to add more information; eg, you might set
622 this to some results from ClamAV.  Be careful.  Header syntax is
623 not checked and is added "as is".
624
625 In case you've troubles with sites sending the same queue items from several
626 hosts and fail to get through greylisting you can use
627 $acl_m_dcc_override_client_ip
628
629 Setting $acl_m_dcc_override_client_ip to an IP address overrides the default
630 of $sender_host_address. eg. use the following ACL in DATA stage:
631
632   warn    set acl_m_dcc_override_client_ip = \
633     ${lookup{$sender_helo_name}nwildlsearch{/etc/mail/multipleip_sites}{$value}{}}
634           condition = ${if def:acl_m_dcc_override_client_ip}
635           log_message = dbg: acl_m_dcc_override_client_ip set to \
636                         $acl_m_dcc_override_client_ip
637
638 Then set something like
639 # cat /etc/mail/multipleip_sites
640 mout-xforward.gmx.net           82.165.159.12
641 mout.gmx.net                    212.227.15.16
642
643 Use a reasonable IP. eg. one the sending cluster acutally uses.
644
645 DMARC Support
646 --------------------------------------------------------------
647
648 DMARC combines feedback from SPF, DKIM, and header From: in order
649 to attempt to provide better indicators of the authenticity of an
650 email.  This document does not explain the fundamentals, you
651 should read and understand how it works by visiting the website at
652 http://www.dmarc.org/.
653
654 DMARC support is added via the libopendmarc library.  Visit:
655
656   http://sourceforge.net/projects/opendmarc/
657
658 to obtain a copy, or find it in your favorite rpm package
659 repository.  If building from source, this description assumes
660 that headers will be in /usr/local/include, and that the libraries
661 are in /usr/local/lib.
662
663 1. To compile Exim with DMARC support, you must first enable SPF.
664 Please read the above section on enabling the EXPERIMENTAL_SPF
665 feature.  You must also have DKIM support, so you cannot set the
666 DISABLE_DKIM feature.  Once both of those conditions have been met
667 you can enable DMARC in Local/Makefile:
668
669 EXPERIMENTAL_DMARC=yes
670 LDFLAGS += -lopendmarc
671 # CFLAGS += -I/usr/local/include
672 # LDFLAGS += -L/usr/local/lib
673
674 The first line sets the feature to include the correct code, and
675 the second line says to link the libopendmarc libraries into the
676 exim binary.  The commented out lines should be uncommented if you
677 built opendmarc from source and installed in the default location.
678 Adjust the paths if you installed them elsewhere, but you do not
679 need to uncomment them if an rpm (or you) installed them in the
680 package controlled locations (/usr/include and /usr/lib).
681
682
683 2. Use the following global settings to configure DMARC:
684
685 Required:
686 dmarc_tld_file      Defines the location of a text file of valid
687                     top level domains the opendmarc library uses
688                     during domain parsing. Maintained by Mozilla,
689                     the most current version can be downloaded
690                     from a link at http://publicsuffix.org/list/.
691
692 Optional:
693 dmarc_history_file  Defines the location of a file to log results
694                     of dmarc verification on inbound emails. The
695                     contents are importable by the opendmarc tools
696                     which will manage the data, send out DMARC
697                     reports, and expire the data. Make sure the
698                     directory of this file is writable by the user
699                     exim runs as.
700
701 dmarc_forensic_sender The email address to use when sending a
702                     forensic report detailing alignment failures
703                     if a sender domain's dmarc record specifies it
704                     and you have configured Exim to send them.
705                     Default: do-not-reply@$default_hostname
706
707
708 3. By default, the DMARC processing will run for any remote,
709 non-authenticated user.  It makes sense to only verify DMARC
710 status of messages coming from remote, untrusted sources.  You can
711 use standard conditions such as hosts, senders, etc, to decide that
712 DMARC verification should *not* be performed for them and disable
713 DMARC with a control setting:
714
715   control = dmarc_disable_verify
716
717 A DMARC record can also specify a "forensic address", which gives
718 exim an email address to submit reports about failed alignment.
719 Exim does not do this by default because in certain conditions it
720 results in unintended information leakage (what lists a user might
721 be subscribed to, etc).  You must configure exim to submit forensic
722 reports to the owner of the domain.  If the DMARC record contains a
723 forensic address and you specify the control statement below, then
724 exim will send these forensic emails.  It's also advised that you
725 configure a dmarc_forensic_sender because the default sender address
726 construction might be inadequate.
727
728   control = dmarc_forensic_enable
729
730 (AGAIN: You can choose not to send these forensic reports by simply
731 not putting the dmarc_forensic_enable control line at any point in
732 your exim config.  If you don't tell it to send them, it will not
733 send them.)
734
735 There are no options to either control.  Both must appear before
736 the DATA acl.
737
738
739 4. You can now run DMARC checks in incoming SMTP by using the
740 "dmarc_status" ACL condition in the DATA ACL.  You are required to
741 call the spf condition first in the ACLs, then the "dmarc_status"
742 condition.  Putting this condition in the ACLs is required in order
743 for a DMARC check to actually occur.  All of the variables are set
744 up before the DATA ACL, but there is no actual DMARC check that
745 occurs until a "dmarc_status" condition is encountered in the ACLs.
746
747 The dmarc_status condition takes a list of strings on its
748 right-hand side.  These strings describe recommended action based
749 on the DMARC check.  To understand what the policy recommendations
750 mean, refer to the DMARC website above.  Valid strings are:
751
752   o accept      The DMARC check passed and the library recommends
753                 accepting the email.
754   o reject      The DMARC check failed and the library recommends
755                 rejecting the email.
756   o quarantine  The DMARC check failed and the library recommends
757                 keeping it for further inspection.
758   o none        The DMARC check passed and the library recommends
759                 no specific action, neutral.
760   o norecord    No policy section in the DMARC record for this
761                 sender domain.
762   o nofrom      Unable to determine the domain of the sender.
763   o temperror   Library error or dns error.
764   o off         The DMARC check was disabled for this email.
765
766 You can prefix each string with an exclamation mark to invert its
767 meaning, for example "!accept" will match all results but
768 "accept".  The string list is evaluated left-to-right in a
769 short-circuit fashion.  When a string matches the outcome of the
770 DMARC check, the condition succeeds.  If none of the listed
771 strings matches the outcome of the DMARC check, the condition
772 fails.
773
774 Of course, you can also use any other lookup method that Exim
775 supports, including LDAP, Postgres, MySQL, etc, as long as the
776 result is a list of colon-separated strings;
777
778 Several expansion variables are set before the DATA ACL is
779 processed, and you can use them in this ACL.  The following
780 expansion variables are available:
781
782   o $dmarc_status
783     This is a one word status indicating what the DMARC library
784     thinks of the email.
785
786   o $dmarc_status_text
787     This is a slightly longer, human readable status.
788
789   o $dmarc_used_domain
790     This is the domain which DMARC used to look up the DMARC
791     policy record.
792
793   o $dmarc_ar_header
794     This is the entire Authentication-Results header which you can
795     add using an add_header modifier.
796
797
798 5. How to enable DMARC advanced operation:
799 By default, Exim's DMARC configuration is intended to be
800 non-intrusive and conservative.  To facilitate this, Exim will not
801 create any type of logging files without explicit configuration by
802 you, the admin.  Nor will Exim send out any emails/reports about
803 DMARC issues without explicit configuration by you, the admin (other
804 than typical bounce messages that may come about due to ACL
805 processing or failure delivery issues).
806
807 In order to log statistics suitable to be imported by the opendmarc
808 tools, you need to:
809 a. Configure the global setting dmarc_history_file.
810 b. Configure cron jobs to call the appropriate opendmarc history
811    import scripts and truncating the dmarc_history_file.
812
813 In order to send forensic reports, you need to:
814 a. Configure the global setting dmarc_forensic_sender.
815 b. Configure, somewhere before the DATA ACL, the control option to
816    enable sending DMARC forensic reports.
817
818
819 6. Example usage:
820 (RCPT ACL)
821   warn    domains        = +local_domains
822           hosts          = +local_hosts
823           control        = dmarc_disable_verify
824
825   warn    !domains       = +screwed_up_dmarc_records
826           control        = dmarc_enable_forensic
827
828 (DATA ACL)
829   warn    dmarc_status   = accept : none : off
830           !authenticated = *
831           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
832           add_header     = $dmarc_ar_header
833
834   warn    dmarc_status   = !accept
835           !authenticated = *
836           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
837
838   warn    dmarc_status   = quarantine
839           !authenticated = *
840           set $acl_m_quarantine = 1
841           # Do something in a transport with this flag variable
842
843   deny    dmarc_status   = reject
844           !authenticated = *
845           message        = Message from $domain_used_domain failed sender's DMARC policy, REJECT
846
847
848
849 Transport post-delivery actions
850 --------------------------------------------------------------
851
852 An arbitrary per-transport string can be expanded on successful delivery,
853 and (for SMTP transports) a second string on deferrals caused by a host error.
854 This feature may be used, for example, to write exim internal log information
855 (not available otherwise) into a database.
856
857 In order to use the feature, you must set
858
859 EXPERIMENTAL_TPDA=yes
860
861 in your Local/Makefile
862
863 and define the expandable strings in the runtime config file, to
864 be executed at end of delivery.
865
866 Additionally, there are 6 more variables, available at end of
867 delivery:
868
869 tpda_delivery_ip             IP of host, which has accepted delivery
870 tpda_delivery_port           Port of remote host which has accepted delivery
871 tpda_delivery_fqdn           FQDN of host, which has accepted delivery
872 tpda_delivery_local_part     local part of address being delivered
873 tpda_delivery_domain         domain part of address being delivered
874 tpda_delivery_confirmation   SMTP confirmation message
875
876 In case of a deferral caused by a host-error:
877 tpda_defer_errno             Error number
878 tpda_defer_errstr            Error string possibly containing more details
879
880 The $router_name and $transport_name variables are also usable.
881
882
883 To take action after successful deliveries, set the following option
884 on any transport of interest.
885
886 tpda_delivery_action
887
888 An example might look like:
889
890 tpda_delivery_action = \
891 ${lookup pgsql {SELECT * FROM record_Delivery( \
892     '${quote_pgsql:$sender_address_domain}',\
893     '${quote_pgsql:${lc:$sender_address_local_part}}', \
894     '${quote_pgsql:$tpda_delivery_domain}', \
895     '${quote_pgsql:${lc:$tpda_delivery_local_part}}', \
896     '${quote_pgsql:$tpda_delivery_ip}', \
897     '${quote_pgsql:${lc:$tpda_delivery_fqdn}}', \
898     '${quote_pgsql:$message_exim_id}')}}
899
900 The string is expanded after the delivery completes and any
901 side-effects will happen.  The result is then discarded.
902 Note that for complex operations an ACL expansion can be used.
903
904
905 In order to log host deferrals, add the following option to an SMTP
906 transport:
907
908 tpda_host_defer_action
909
910 This is a private option of the SMTP transport. It is intended to
911 log failures of remote hosts. It is executed only when exim has
912 attempted to deliver a message to a remote host and failed due to
913 an error which doesn't seem to be related to the individual
914 message, sender, or recipient address.
915 See section 45.2 of the exim documentation for more details on how
916 this is determined.
917
918 Example:
919
920 tpda_host_defer_action = \
921 ${lookup mysql {insert into delivlog set \
922     msgid = '${quote_mysql:$message_exim_id}', \
923     senderlp = '${quote_mysql:${lc:$sender_address_local_part}}', \
924     senderdom = '${quote_mysql:$sender_address_domain}', \
925     delivlp = '${quote_mysql:${lc:$tpda_delivery_local_part}}', \
926     delivdom = '${quote_mysql:$tpda_delivery_domain}', \
927     delivip = '${quote_mysql:$tpda_delivery_ip}', \
928     delivport = '${quote_mysql:$tpda_delivery_port}', \
929     delivfqdn = '${quote_mysql:$tpda_delivery_fqdn}', \
930     deliverrno = '${quote_mysql:$tpda_defer_errno}', \
931     deliverrstr = '${quote_mysql:$tpda_defer_errstr}' \
932     }}
933
934 --------------------------------------------------------------
935 End of file
936 --------------------------------------------------------------