Docs: Remove trailing whitespace
[exim.git] / doc / doc-txt / experimental-spec.txt
CommitLineData
7bafa7d9
TK
1From time to time, experimental features may be added to Exim.
2While a feature is experimental, there will be a build-time
3option whose name starts "EXPERIMENTAL_" that must be set in
4order to include the feature. This file contains information
d36a0501
PP
5about experimental features, all of which are unstable and
6liable to incompatible change.
ee161e8f
PH
7
8
0b23848a 9Brightmail AntiSpam (BMI) suppport
ee161e8f
PH
10--------------------------------------------------------------
11
12Brightmail AntiSpam is a commercial package. Please see
13http://www.brightmail.com for more information on
14the product. For the sake of clarity, we'll refer to it as
15"BMI" from now on.
16
17
180) BMI concept and implementation overview
19
20In contrast to how spam-scanning with SpamAssassin is
21implemented in exiscan-acl, BMI is more suited for per
22-recipient scanning of messages. However, each messages is
23scanned only once, but multiple "verdicts" for multiple
24recipients can be returned from the BMI server. The exiscan
25implementation passes the message to the BMI server just
26before accepting it. It then adds the retrieved verdicts to
27the messages header file in the spool. These verdicts can then
28be queried in routers, where operation is per-recipient
29instead of per-message. To use BMI, you need to take the
30following steps:
31
32 1) Compile Exim with BMI support
3ec3e3bb 33 2) Set up main BMI options (top section of Exim config file)
ee161e8f
PH
34 3) Set up ACL control statement (ACL section of the config
35 file)
36 4) Set up your routers to use BMI verdicts (routers section
37 of the config file).
38 5) (Optional) Set up per-recipient opt-in information.
39
8ff3788c 40These four steps are explained in more details below.
ee161e8f
PH
41
421) Adding support for BMI at compile time
43
44 To compile with BMI support, you need to link Exim against
45 the Brighmail client SDK, consisting of a library
46 (libbmiclient_single.so) and a header file (bmi_api.h).
47 You'll also need to explicitly set a flag in the Makefile to
48 include BMI support in the Exim binary. Both can be achieved
49 with these lines in Local/Makefile:
50
51 EXPERIMENTAL_BRIGHTMAIL=yes
47bbda99 52 CFLAGS=-I/path/to/the/dir/with/the/includefile
ee161e8f 53 EXTRALIBS_EXIM=-L/path/to/the/dir/with/the/library -lbmiclient_single
8ff3788c 54
ee161e8f
PH
55 If you use other CFLAGS or EXTRALIBS_EXIM settings then
56 merge the content of these lines with them.
57
7c0c8547 58 Note for BMI6.x users: You'll also have to add -lxml2_single
ee161e8f
PH
59 to the EXTRALIBS_EXIM line. Users of 5.5x do not need to do
60 this.
8ff3788c 61
ee161e8f
PH
62 You should also include the location of
63 libbmiclient_single.so in your dynamic linker configuration
64 file (usually /etc/ld.so.conf) and run "ldconfig"
65 afterwards, or else the produced Exim binary will not be
66 able to find the library file.
67
68
3ec3e3bb 692) Setting up BMI support in the Exim main configuration
ee161e8f 70
3ec3e3bb 71 To enable BMI support in the main Exim configuration, you
ee161e8f
PH
72 should set the path to the main BMI configuration file with
73 the "bmi_config_file" option, like this:
8ff3788c 74
ee161e8f 75 bmi_config_file = /opt/brightmail/etc/brightmail.cfg
8ff3788c 76
3ec3e3bb 77 This must go into section 1 of Exim's configuration file (You
ee161e8f
PH
78 can put it right on top). If you omit this option, it
79 defaults to /opt/brightmail/etc/brightmail.cfg.
80
81 Note for BMI6.x users: This file is in XML format in V6.xx
82 and its name is /opt/brightmail/etc/bmiconfig.xml. So BMI
83 6.x users MUST set the bmi_config_file option.
8ff3788c 84
ee161e8f
PH
85
863) Set up ACL control statement
87
88 To optimize performance, it makes sense only to process
89 messages coming from remote, untrusted sources with the BMI
90 server. To set up a messages for processing by the BMI
91 server, you MUST set the "bmi_run" control statement in any
92 ACL for an incoming message. You will typically do this in
93 an "accept" block in the "acl_check_rcpt" ACL. You should
94 use the "accept" block(s) that accept messages from remote
95 servers for your own domain(s). Here is an example that uses
3ec3e3bb 96 the "accept" blocks from Exim's default configuration file:
8ff3788c 97
ee161e8f
PH
98
99 accept domains = +local_domains
100 endpass
101 verify = recipient
102 control = bmi_run
103
104 accept domains = +relay_to_domains
105 endpass
106 verify = recipient
107 control = bmi_run
8ff3788c 108
ee161e8f
PH
109 If bmi_run is not set in any ACL during reception of the
110 message, it will NOT be passed to the BMI server.
111
112
1134) Setting up routers to use BMI verdicts
114
115 When a message has been run through the BMI server, one or
116 more "verdicts" are present. Different recipients can have
117 different verdicts. Each recipient is treated individually
118 during routing, so you can query the verdicts by recipient
3ec3e3bb 119 at that stage. From Exim's view, a verdict can have the
ee161e8f 120 following outcomes:
8ff3788c 121
ee161e8f
PH
122 o deliver the message normally
123 o deliver the message to an alternate location
124 o do not deliver the message
8ff3788c 125
ee161e8f
PH
126 To query the verdict for a recipient, the implementation
127 offers the following tools:
8ff3788c
TK
128
129
ee161e8f
PH
130 - Boolean router preconditions. These can be used in any
131 router. For a simple implementation of BMI, these may be
132 all that you need. The following preconditions are
133 available:
8ff3788c 134
ee161e8f 135 o bmi_deliver_default
8ff3788c 136
ee161e8f
PH
137 This precondition is TRUE if the verdict for the
138 recipient is to deliver the message normally. If the
139 message has not been processed by the BMI server, this
140 variable defaults to TRUE.
8ff3788c 141
ee161e8f 142 o bmi_deliver_alternate
8ff3788c 143
ee161e8f
PH
144 This precondition is TRUE if the verdict for the
145 recipient is to deliver the message to an alternate
146 location. You can get the location string from the
147 $bmi_alt_location expansion variable if you need it. See
148 further below. If the message has not been processed by
149 the BMI server, this variable defaults to FALSE.
8ff3788c 150
ee161e8f 151 o bmi_dont_deliver
8ff3788c 152
ee161e8f
PH
153 This precondition is TRUE if the verdict for the
154 recipient is NOT to deliver the message to the
155 recipient. You will typically use this precondition in a
156 top-level blackhole router, like this:
8ff3788c 157
ee161e8f
PH
158 # don't deliver messages handled by the BMI server
159 bmi_blackhole:
160 driver = redirect
161 bmi_dont_deliver
162 data = :blackhole:
8ff3788c 163
ee161e8f
PH
164 This router should be on top of all others, so messages
165 that should not be delivered do not reach other routers
166 at all. If the message has not been processed by
167 the BMI server, this variable defaults to FALSE.
8ff3788c
TK
168
169
ee161e8f
PH
170 - A list router precondition to query if rules "fired" on
171 the message for the recipient. Its name is "bmi_rule". You
172 use it by passing it a colon-separated list of rule
173 numbers. You can use this condition to route messages that
174 matched specific rules. Here is an example:
8ff3788c 175
ee161e8f
PH
176 # special router for BMI rule #5, #8 and #11
177 bmi_rule_redirect:
178 driver = redirect
179 bmi_rule = 5:8:11
180 data = postmaster@mydomain.com
8ff3788c
TK
181
182
ee161e8f
PH
183 - Expansion variables. Several expansion variables are set
184 during routing. You can use them in custom router
185 conditions, for example. The following variables are
186 available:
8ff3788c 187
ee161e8f 188 o $bmi_base64_verdict
8ff3788c 189
ee161e8f
PH
190 This variable will contain the BASE64 encoded verdict
191 for the recipient being routed. You can use it to add a
192 header to messages for tracking purposes, for example:
8ff3788c 193
ee161e8f
PH
194 localuser:
195 driver = accept
196 check_local_user
197 headers_add = X-Brightmail-Verdict: $bmi_base64_verdict
198 transport = local_delivery
8ff3788c 199
ee161e8f
PH
200 If there is no verdict available for the recipient being
201 routed, this variable contains the empty string.
8ff3788c 202
ee161e8f 203 o $bmi_base64_tracker_verdict
8ff3788c 204
ee161e8f
PH
205 This variable will contain a BASE64 encoded subset of
206 the verdict information concerning the "rules" that
207 fired on the message. You can add this string to a
208 header, commonly named "X-Brightmail-Tracker". Example:
8ff3788c 209
ee161e8f
PH
210 localuser:
211 driver = accept
212 check_local_user
213 headers_add = X-Brightmail-Tracker: $bmi_base64_tracker_verdict
214 transport = local_delivery
8ff3788c 215
ee161e8f
PH
216 If there is no verdict available for the recipient being
217 routed, this variable contains the empty string.
8ff3788c 218
ee161e8f 219 o $bmi_alt_location
8ff3788c 220
ee161e8f
PH
221 If the verdict is to redirect the message to an
222 alternate location, this variable will contain the
223 alternate location string returned by the BMI server. In
224 its default configuration, this is a header-like string
225 that can be added to the message with "headers_add". If
226 there is no verdict available for the recipient being
227 routed, or if the message is to be delivered normally,
228 this variable contains the empty string.
8ff3788c 229
ee161e8f 230 o $bmi_deliver
8ff3788c 231
ee161e8f
PH
232 This is an additional integer variable that can be used
233 to query if the message should be delivered at all. You
234 should use router preconditions instead if possible.
8ff3788c 235
ee161e8f
PH
236 $bmi_deliver is '0': the message should NOT be delivered.
237 $bmi_deliver is '1': the message should be delivered.
8ff3788c
TK
238
239
ee161e8f
PH
240 IMPORTANT NOTE: Verdict inheritance.
241 The message is passed to the BMI server during message
242 reception, using the target addresses from the RCPT TO:
243 commands in the SMTP transaction. If recipients get expanded
244 or re-written (for example by aliasing), the new address(es)
245 inherit the verdict from the original address. This means
246 that verdicts also apply to all "child" addresses generated
247 from top-level addresses that were sent to the BMI server.
8ff3788c
TK
248
249
ee161e8f
PH
2505) Using per-recipient opt-in information (Optional)
251
252 The BMI server features multiple scanning "profiles" for
253 individual recipients. These are usually stored in a LDAP
254 server and are queried by the BMI server itself. However,
255 you can also pass opt-in data for each recipient from the
256 MTA to the BMI server. This is particularly useful if you
3ec3e3bb 257 already look up recipient data in Exim anyway (which can
ee161e8f
PH
258 also be stored in a SQL database or other source). This
259 implementation enables you to pass opt-in data to the BMI
260 server in the RCPT ACL. This works by setting the
261 'bmi_optin' modifier in a block of that ACL. If should be
262 set to a list of comma-separated strings that identify the
263 features which the BMI server should use for that particular
264 recipient. Ideally, you would use the 'bmi_optin' modifier
265 in the same ACL block where you set the 'bmi_run' control
266 flag. Here is an example that will pull opt-in data for each
267 recipient from a flat file called
268 '/etc/exim/bmi_optin_data'.
8ff3788c 269
ee161e8f 270 The file format:
8ff3788c 271
ee161e8f
PH
272 user1@mydomain.com: <OPTIN STRING1>:<OPTIN STRING2>
273 user2@thatdomain.com: <OPTIN STRING3>
8ff3788c
TK
274
275
ee161e8f 276 The example:
8ff3788c 277
ee161e8f
PH
278 accept domains = +relay_to_domains
279 endpass
280 verify = recipient
281 bmi_optin = ${lookup{$local_part@$domain}lsearch{/etc/exim/bmi_optin_data}}
8ff3788c
TK
282 control = bmi_run
283
ee161e8f 284 Of course, you can also use any other lookup method that
3ec3e3bb 285 Exim supports, including LDAP, Postgres, MySQL, Oracle etc.,
ee161e8f
PH
286 as long as the result is a list of colon-separated opt-in
287 strings.
8ff3788c 288
ee161e8f
PH
289 For a list of available opt-in strings, please contact your
290 Brightmail representative.
ee161e8f 291
8ff3788c
TK
292
293
294
0b23848a 295Sender Policy Framework (SPF) support
ee161e8f
PH
296--------------------------------------------------------------
297
f413481d 298To learn more about SPF, visit http://www.openspf.org. This
ee161e8f
PH
299document does not explain the SPF fundamentals, you should
300read and understand the implications of deploying SPF on your
301system before doing so.
302
8ff3788c 303SPF support is added via the libspf2 library. Visit
ee161e8f
PH
304
305 http://www.libspf2.org/
8ff3788c 306
ee161e8f
PH
307to obtain a copy, then compile and install it. By default,
308this will put headers in /usr/local/include and the static
309library in /usr/local/lib.
310
3ec3e3bb 311To compile Exim with SPF support, set these additional flags in
ee161e8f
PH
312Local/Makefile:
313
314EXPERIMENTAL_SPF=yes
315CFLAGS=-DSPF -I/usr/local/include
316EXTRALIBS_EXIM=-L/usr/local/lib -lspf2
317
318This assumes that the libspf2 files are installed in
319their default locations.
320
321You can now run SPF checks in incoming SMTP by using the "spf"
322ACL condition in either the MAIL, RCPT or DATA ACLs. When
d36a0501 323using it in the RCPT ACL, you can make the checks dependent on
ee161e8f
PH
324the RCPT address (or domain), so you can check SPF records
325only for certain target domains. This gives you the
326possibility to opt-out certain customers that do not want
327their mail to be subject to SPF checking.
328
329The spf condition takes a list of strings on its right-hand
330side. These strings describe the outcome of the SPF check for
331which the spf condition should succeed. Valid strings are:
332
333 o pass The SPF check passed, the sending host
334 is positively verified by SPF.
335 o fail The SPF check failed, the sending host
336 is NOT allowed to send mail for the domain
337 in the envelope-from address.
338 o softfail The SPF check failed, but the queried
339 domain can't absolutely confirm that this
340 is a forgery.
341 o none The queried domain does not publish SPF
342 records.
343 o neutral The SPF check returned a "neutral" state.
344 This means the queried domain has published
345 a SPF record, but wants to allow outside
346 servers to send mail under its domain as well.
8ddef691
TL
347 This should be treated like "none".
348 o permerror This indicates a syntax error in the SPF
349 record of the queried domain. You may deny
350 messages when this occurs. (Changed in 4.83)
351 o temperror This indicates a temporary error during all
3ec3e3bb 352 processing, including Exim's SPF processing.
ee161e8f 353 You may defer messages when this occurs.
8ddef691 354 (Changed in 4.83)
982650ec
TL
355 o err_temp Same as permerror, deprecated in 4.83, will be
356 removed in a future release.
357 o err_perm Same as temperror, deprecated in 4.83, will be
358 removed in a future release.
8ff3788c 359
ee161e8f 360You can prefix each string with an exclamation mark to invert
982650ec 361its meaning, for example "!fail" will match all results but
ee161e8f
PH
362"fail". The string list is evaluated left-to-right, in a
363short-circuit fashion. When a string matches the outcome of
364the SPF check, the condition succeeds. If none of the listed
365strings matches the outcome of the SPF check, the condition
366fails.
367
f413481d
TK
368Here is an example to fail forgery attempts from domains that
369publish SPF records:
ee161e8f
PH
370
371/* -----------------
f413481d
TK
372deny message = $sender_host_address is not allowed to send mail from ${if def:sender_address_domain {$sender_address_domain}{$sender_helo_name}}. \
373 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
ee161e8f
PH
374 spf = fail
375--------------------- */
376
377You can also give special treatment to specific domains:
378
379/* -----------------
380deny message = AOL sender, but not from AOL-approved relay.
381 sender_domains = aol.com
382 spf = fail:neutral
383--------------------- */
384
385Explanation: AOL publishes SPF records, but is liberal and
386still allows non-approved relays to send mail from aol.com.
387This will result in a "neutral" state, while mail from genuine
388AOL servers will result in "pass". The example above takes
389this into account and treats "neutral" like "fail", but only
390for aol.com. Please note that this violates the SPF draft.
391
392When the spf condition has run, it sets up several expansion
393variables.
394
395 $spf_header_comment
396 This contains a human-readable string describing the outcome
397 of the SPF check. You can add it to a custom header or use
398 it for logging purposes.
8ff3788c 399
ee161e8f 400 $spf_received
8fe685ad 401 This contains a complete Received-SPF: header that can be
ee161e8f
PH
402 added to the message. Please note that according to the SPF
403 draft, this header must be added at the top of the header
404 list. Please see section 10 on how you can do this.
8ff3788c 405
65a7d8c3
NM
406 Note: in case of "Best-guess" (see below), the convention is
407 to put this string in a header called X-SPF-Guess: instead.
408
ee161e8f
PH
409 $spf_result
410 This contains the outcome of the SPF check in string form,
8ddef691
TL
411 one of pass, fail, softfail, none, neutral, permerror or
412 temperror.
8ff3788c 413
ee161e8f
PH
414 $spf_smtp_comment
415 This contains a string that can be used in a SMTP response
416 to the calling party. Useful for "fail".
8ff3788c 417
65a7d8c3
NM
418In addition to SPF, you can also perform checks for so-called
419"Best-guess". Strictly speaking, "Best-guess" is not standard
420SPF, but it is supported by the same framework that enables SPF
421capability. Refer to http://www.openspf.org/FAQ/Best_guess_record
422for a description of what it means.
423
424To access this feature, simply use the spf_guess condition in place
425of the spf one. For example:
426
427/* -----------------
428deny message = $sender_host_address doesn't look trustworthy to me
429 spf_guess = fail
430--------------------- */
431
432In case you decide to reject messages based on this check, you
433should note that although it uses the same framework, "Best-guess"
434is NOT SPF, and therefore you should not mention SPF at all in your
435reject message.
436
437When the spf_guess condition has run, it sets up the same expansion
438variables as when spf condition is run, described above.
439
d36a0501 440Additionally, since Best-guess is not standardized, you may redefine
65a7d8c3
NM
441what "Best-guess" means to you by redefining spf_guess variable in
442global config. For example, the following:
443
444/* -----------------
445spf_guess = v=spf1 a/16 mx/16 ptr ?all
446--------------------- */
447
448would relax host matching rules to a broader network range.
8ff3788c 449
ee161e8f 450
0b23848a 451SRS (Sender Rewriting Scheme) Support
ee161e8f
PH
452--------------------------------------------------------------
453
454Exiscan currently includes SRS support via Miles Wilton's
8ff3788c 455libsrs_alt library. The current version of the supported
ee161e8f
PH
456library is 0.5.
457
458In order to use SRS, you must get a copy of libsrs_alt from
459
460http://srs.mirtol.com/
461
462Unpack the tarball, then refer to MTAs/README.EXIM
463to proceed. You need to set
464
465EXPERIMENTAL_SRS=yes
466
467in your Local/Makefile.
468
469
0e1ccf44
PP
470DCC Support
471--------------------------------------------------------------
472
473*) Building exim
474
475In order to build exim with DCC support add
476
477EXPERIMENTAL_DCC=yes
478
479to your Makefile. (Re-)build/install exim. exim -d should show
480EXPERIMENTAL_DCC under "Support for".
481
482
483*) Configuration
484
485In the main section of exim.cf add at least
486 dccifd_address = /usr/local/dcc/var/dccifd
487or
488 dccifd_address = <ip> <port>
489
490In the DATA ACL you can use the new condition
491 dcc = *
492
493After that "$dcc_header" contains the X-DCC-Header.
494
d36a0501 495Return values are:
0e1ccf44
PP
496 fail for overall "R", "G" from dccifd
497 defer for overall "T" from dccifd
498 accept for overall "A", "S" from dccifd
499
500dcc = */defer_ok works as for spamd.
501
502The "$dcc_result" variable contains the overall result from DCC
503answer. There will an X-DCC: header added to the mail.
504
505Usually you'll use
506 defer !dcc = *
507to greylist with DCC.
508
509If you set, in the main section,
510 dcc_direct_add_header = true
511then the dcc header will be added "in deep" and if the spool
512file was already written it gets removed. This forces Exim to
513write it again if needed. This helps to get the DCC Header
514through to eg. SpamAssassin.
515
516If you want to pass even more headers in the middle of the
517DATA stage you can set
518 $acl_m_dcc_add_header
05c39afa 519to tell the DCC routines to add more information; eg, you might set
0e1ccf44
PP
520this to some results from ClamAV. Be careful. Header syntax is
521not checked and is added "as is".
522
05c39afa
JH
523In case you've troubles with sites sending the same queue items from several
524hosts and fail to get through greylisting you can use
525$acl_m_dcc_override_client_ip
526
527Setting $acl_m_dcc_override_client_ip to an IP address overrides the default
528of $sender_host_address. eg. use the following ACL in DATA stage:
529
530 warn set acl_m_dcc_override_client_ip = \
531 ${lookup{$sender_helo_name}nwildlsearch{/etc/mail/multipleip_sites}{$value}{}}
532 condition = ${if def:acl_m_dcc_override_client_ip}
533 log_message = dbg: acl_m_dcc_override_client_ip set to \
534 $acl_m_dcc_override_client_ip
535
536Then set something like
537# cat /etc/mail/multipleip_sites
538mout-xforward.gmx.net 82.165.159.12
539mout.gmx.net 212.227.15.16
540
541Use a reasonable IP. eg. one the sending cluster acutally uses.
0e1ccf44 542
1899bab2
TL
543DMARC Support
544--------------------------------------------------------------
545
546DMARC combines feedback from SPF, DKIM, and header From: in order
547to attempt to provide better indicators of the authenticity of an
548email. This document does not explain the fundamentals, you
549should read and understand how it works by visiting the website at
550http://www.dmarc.org/.
551
552DMARC support is added via the libopendmarc library. Visit:
553
554 http://sourceforge.net/projects/opendmarc/
555
556to obtain a copy, or find it in your favorite rpm package
557repository. If building from source, this description assumes
558that headers will be in /usr/local/include, and that the libraries
559are in /usr/local/lib.
560
5611. To compile Exim with DMARC support, you must first enable SPF.
562Please read the above section on enabling the EXPERIMENTAL_SPF
563feature. You must also have DKIM support, so you cannot set the
564DISABLE_DKIM feature. Once both of those conditions have been met
565you can enable DMARC in Local/Makefile:
566
567EXPERIMENTAL_DMARC=yes
568LDFLAGS += -lopendmarc
569# CFLAGS += -I/usr/local/include
570# LDFLAGS += -L/usr/local/lib
571
572The first line sets the feature to include the correct code, and
573the second line says to link the libopendmarc libraries into the
574exim binary. The commented out lines should be uncommented if you
575built opendmarc from source and installed in the default location.
576Adjust the paths if you installed them elsewhere, but you do not
577need to uncomment them if an rpm (or you) installed them in the
578package controlled locations (/usr/include and /usr/lib).
579
580
5812. Use the following global settings to configure DMARC:
582
583Required:
584dmarc_tld_file Defines the location of a text file of valid
585 top level domains the opendmarc library uses
586 during domain parsing. Maintained by Mozilla,
587 the most current version can be downloaded
588 from a link at http://publicsuffix.org/list/.
589
590Optional:
591dmarc_history_file Defines the location of a file to log results
592 of dmarc verification on inbound emails. The
593 contents are importable by the opendmarc tools
594 which will manage the data, send out DMARC
595 reports, and expire the data. Make sure the
596 directory of this file is writable by the user
597 exim runs as.
598
599dmarc_forensic_sender The email address to use when sending a
600 forensic report detailing alignment failures
601 if a sender domain's dmarc record specifies it
602 and you have configured Exim to send them.
603 Default: do-not-reply@$default_hostname
604
605
6063. By default, the DMARC processing will run for any remote,
607non-authenticated user. It makes sense to only verify DMARC
608status of messages coming from remote, untrusted sources. You can
609use standard conditions such as hosts, senders, etc, to decide that
610DMARC verification should *not* be performed for them and disable
611DMARC with a control setting:
612
12d0043d 613 control = dmarc_disable_verify
1899bab2
TL
614
615A DMARC record can also specify a "forensic address", which gives
616exim an email address to submit reports about failed alignment.
617Exim does not do this by default because in certain conditions it
618results in unintended information leakage (what lists a user might
619be subscribed to, etc). You must configure exim to submit forensic
620reports to the owner of the domain. If the DMARC record contains a
621forensic address and you specify the control statement below, then
622exim will send these forensic emails. It's also advised that you
623configure a dmarc_forensic_sender because the default sender address
624construction might be inadequate.
625
7b2f71c1 626 control = dmarc_enable_forensic
1899bab2
TL
627
628(AGAIN: You can choose not to send these forensic reports by simply
7b2f71c1 629not putting the dmarc_enable_forensic control line at any point in
1899bab2
TL
630your exim config. If you don't tell it to send them, it will not
631send them.)
632
633There are no options to either control. Both must appear before
634the DATA acl.
635
636
6374. You can now run DMARC checks in incoming SMTP by using the
638"dmarc_status" ACL condition in the DATA ACL. You are required to
639call the spf condition first in the ACLs, then the "dmarc_status"
640condition. Putting this condition in the ACLs is required in order
641for a DMARC check to actually occur. All of the variables are set
642up before the DATA ACL, but there is no actual DMARC check that
643occurs until a "dmarc_status" condition is encountered in the ACLs.
644
645The dmarc_status condition takes a list of strings on its
646right-hand side. These strings describe recommended action based
647on the DMARC check. To understand what the policy recommendations
648mean, refer to the DMARC website above. Valid strings are:
649
650 o accept The DMARC check passed and the library recommends
651 accepting the email.
652 o reject The DMARC check failed and the library recommends
653 rejecting the email.
654 o quarantine The DMARC check failed and the library recommends
655 keeping it for further inspection.
7a8678e6 656 o none The DMARC check passed and the library recommends
657 no specific action, neutral.
1899bab2
TL
658 o norecord No policy section in the DMARC record for this
659 sender domain.
660 o nofrom Unable to determine the domain of the sender.
7a8678e6 661 o temperror Library error or dns error.
05070e30 662 o off The DMARC check was disabled for this email.
1899bab2
TL
663
664You can prefix each string with an exclamation mark to invert its
665meaning, for example "!accept" will match all results but
666"accept". The string list is evaluated left-to-right in a
667short-circuit fashion. When a string matches the outcome of the
668DMARC check, the condition succeeds. If none of the listed
669strings matches the outcome of the DMARC check, the condition
670fails.
671
672Of course, you can also use any other lookup method that Exim
673supports, including LDAP, Postgres, MySQL, etc, as long as the
8c8b8274 674result is a list of colon-separated strings.
1899bab2
TL
675
676Several expansion variables are set before the DATA ACL is
677processed, and you can use them in this ACL. The following
678expansion variables are available:
679
680 o $dmarc_status
681 This is a one word status indicating what the DMARC library
8c8b8274
TL
682 thinks of the email. It is a combination of the results of
683 DMARC record lookup and the SPF/DKIM/DMARC processing results
684 (if a DMARC record was found). The actual policy declared
685 in the DMARC record is in a separate expansion variable.
1899bab2
TL
686
687 o $dmarc_status_text
688 This is a slightly longer, human readable status.
689
690 o $dmarc_used_domain
691 This is the domain which DMARC used to look up the DMARC
692 policy record.
693
8c8b8274
TL
694 o $dmarc_domain_policy
695 This is the policy declared in the DMARC record. Valid values
696 are "none", "reject" and "quarantine". It is blank when there
697 is any error, including no DMARC record.
698
1899bab2
TL
699 o $dmarc_ar_header
700 This is the entire Authentication-Results header which you can
701 add using an add_header modifier.
702
703
7045. How to enable DMARC advanced operation:
705By default, Exim's DMARC configuration is intended to be
706non-intrusive and conservative. To facilitate this, Exim will not
707create any type of logging files without explicit configuration by
708you, the admin. Nor will Exim send out any emails/reports about
709DMARC issues without explicit configuration by you, the admin (other
710than typical bounce messages that may come about due to ACL
711processing or failure delivery issues).
712
713In order to log statistics suitable to be imported by the opendmarc
714tools, you need to:
715a. Configure the global setting dmarc_history_file.
716b. Configure cron jobs to call the appropriate opendmarc history
717 import scripts and truncating the dmarc_history_file.
718
719In order to send forensic reports, you need to:
720a. Configure the global setting dmarc_forensic_sender.
721b. Configure, somewhere before the DATA ACL, the control option to
722 enable sending DMARC forensic reports.
723
724
7256. Example usage:
726(RCPT ACL)
727 warn domains = +local_domains
728 hosts = +local_hosts
12d0043d 729 control = dmarc_disable_verify
1899bab2
TL
730
731 warn !domains = +screwed_up_dmarc_records
732 control = dmarc_enable_forensic
733
8c8b8274
TL
734 warn condition = (lookup if destined to mailing list)
735 set acl_m_mailing_list = 1
736
1899bab2
TL
737(DATA ACL)
738 warn dmarc_status = accept : none : off
739 !authenticated = *
740 log_message = DMARC DEBUG: $dmarc_status $dmarc_used_domain
741 add_header = $dmarc_ar_header
742
743 warn dmarc_status = !accept
744 !authenticated = *
745 log_message = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
746
747 warn dmarc_status = quarantine
748 !authenticated = *
749 set $acl_m_quarantine = 1
750 # Do something in a transport with this flag variable
751
8c8b8274
TL
752 deny condition = ${if eq{$dmarc_domain_policy}{reject}}
753 condition = ${if eq{$acl_m_mailing_list}{1}}
754 message = Messages from $dmarc_used_domain break mailing lists
755
1899bab2
TL
756 deny dmarc_status = reject
757 !authenticated = *
7b2f71c1 758 message = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
1899bab2
TL
759
760
761
774ef2d7 762Event Actions
d68218c7
JH
763--------------------------------------------------------------
764
774ef2d7
JH
765(Renamed from TPDA, Transport post-delivery actions)
766
767An arbitrary per-transport string can be expanded upon various transport events.
14a465c3
JH
768Additionally a main-section configuration option can be expanded on some
769per-message events.
d68218c7
JH
770This feature may be used, for example, to write exim internal log information
771(not available otherwise) into a database.
772
a7538db1 773In order to use the feature, you must compile with
d68218c7 774
774ef2d7 775EXPERIMENTAL_EVENT=yes
d68218c7
JH
776
777in your Local/Makefile
778
14a465c3 779and define one or both of
774ef2d7
JH
780- the event_action option in the transport
781- the event_action main option
14a465c3 782to be expanded when the event fires.
d68218c7 783
774ef2d7 784A new variable, $event_name, is set to the event type when the
a7538db1 785expansion is done. The current list of events is:
d68218c7 786
774ef2d7
JH
787 msg:complete after main per message
788 msg:delivery after transport per recipient
789 msg:host:defer after transport per attempt
790 msg:fail:delivery after main per recipient
791 msg:fail:internal after main per recipient
792 tcp:connect before transport per connection
793 tcp:close after transport per connection
723fe533 794 tls:cert before both per certificate in verification chain
774ef2d7
JH
795 smtp:connect after transport per connection
796
797The expansion is called for all event types, and should use the $event_name
186c98a1
JH
798variable to decide when to act. The value of the variable is a colon-separated
799list, defining a position in the tree of possible events; it may be used as
800a list or just matched on as a whole. There will be no whitespace.
801
d68218c7 802
774ef2d7 803There is an auxilary variable, $event_data, for which the
a7538db1 804content is event_dependent:
d68218c7 805
a7538db1
JH
806 msg:delivery smtp confirmation mssage
807 msg:host:defer error string
808 tls:cert verification chain depth
809 smtp:connect smtp banner
d68218c7 810
774ef2d7 811The msg:host:defer event populates one extra variable, $event_defer_errno.
a7538db1 812
14a465c3 813The following variables are likely to be useful depending on the event type:
a7538db1
JH
814
815 router_name, transport_name
816 local_part, domain
817 host, host_address, host_port
818 tls_out_peercert
819 lookup_dnssec_authenticated, tls_out_dane
820 sending_ip_address, sending_port
aec45841 821 message_exim_id, verify_mode
d68218c7 822
d68218c7
JH
823
824An example might look like:
825
3c71915d 826event_action = ${if eq {msg:delivery}{$event_name} \
a7538db1 827{${lookup pgsql {SELECT * FROM record_Delivery( \
d68218c7
JH
828 '${quote_pgsql:$sender_address_domain}',\
829 '${quote_pgsql:${lc:$sender_address_local_part}}', \
a7538db1
JH
830 '${quote_pgsql:$domain}', \
831 '${quote_pgsql:${lc:$local_part}}', \
832 '${quote_pgsql:$host_address}', \
833 '${quote_pgsql:${lc:$host}}', \
834 '${quote_pgsql:$message_exim_id}')}} \
835} {}}
d68218c7 836
774ef2d7
JH
837The string is expanded when each of the supported events occur
838and any side-effects of the expansion will happen.
d68218c7
JH
839Note that for complex operations an ACL expansion can be used.
840
a7538db1 841
774ef2d7 842The expansion of the event_action option should normally
a7538db1
JH
843return an empty string. Should it return anything else the
844following will be forced:
845
846 msg:delivery (ignored)
847 msg:host:defer (ignored)
14a465c3 848 msg:fail:delivery (ignored)
a7538db1
JH
849 tcp:connect do not connect
850 tcp:close (ignored)
851 tls:cert refuse verification
852 smtp:connect close connection
853
774ef2d7 854No other use is made of the result string.
a7538db1 855
d68218c7 856
723fe533
JH
857Known issues:
858- the tls:cert event is only called for the cert chain elements
859 received over the wire, with GnuTLS. OpenSSL gives the entire
186c98a1 860 chain including those loaded locally.
1899bab2 861
9bdd29ad
TL
862
863Redis Lookup
864--------------------------------------------------------------
865
866Redis is open source advanced key-value data store. This document
867does not explain the fundamentals, you should read and understand how
868it works by visiting the website at http://www.redis.io/.
869
870Redis lookup support is added via the hiredis library. Visit:
871
872 https://github.com/redis/hiredis
873
874to obtain a copy, or find it in your operating systems package repository.
875If building from source, this description assumes that headers will be in
876/usr/local/include, and that the libraries are in /usr/local/lib.
877
8781. In order to build exim with Redis lookup support add
879
880EXPERIMENTAL_REDIS=yes
881
882to your Local/Makefile. (Re-)build/install exim. exim -d should show
883Experimental_Redis in the line "Support for:".
884
885EXPERIMENTAL_REDIS=yes
886LDFLAGS += -lhiredis
887# CFLAGS += -I/usr/local/include
888# LDFLAGS += -L/usr/local/lib
889
890The first line sets the feature to include the correct code, and
891the second line says to link the hiredis libraries into the
892exim binary. The commented out lines should be uncommented if you
893built hiredis from source and installed in the default location.
894Adjust the paths if you installed them elsewhere, but you do not
895need to uncomment them if an rpm (or you) installed them in the
896package controlled locations (/usr/include and /usr/lib).
897
898
8992. Use the following global settings to configure Redis lookup support:
900
901Required:
902redis_servers This option provides a list of Redis servers
903 and associated connection data, to be used in
904 conjunction with redis lookups. The option is
905 only available if Exim is configured with Redis
906 support.
907
908For example:
909
910redis_servers = 127.0.0.1/10/ - using database 10 with no password
911redis_servers = 127.0.0.1//password - to make use of the default database of 0 with a password
912redis_servers = 127.0.0.1// - for default database of 0 with no password
913
9143. Once you have the Redis servers defined you can then make use of the
915experimental Redis lookup by specifying ${lookup redis{}} in a lookup query.
916
9174. Example usage:
918
919(Host List)
920hostlist relay_from_ips = <\n ${lookup redis{SMEMBERS relay_from_ips}}
921
922Where relay_from_ips is a Redis set which contains entries such as "192.168.0.0/24" "10.0.0.0/8" and so on.
923The result set is returned as
924192.168.0.0/24
92510.0.0.0/8
926..
927.
928
929(Domain list)
930domainlist virtual_domains = ${lookup redis {HGET $domain domain}}
931
932Where $domain is a hash which includes the key 'domain' and the value '$domain'.
933
934(Adding or updating an existing key)
935set acl_c_spammer = ${if eq{${lookup redis{SPAMMER_SET}}}{OK}}
936
937Where SPAMMER_SET is a macro and it is defined as
938
939"SET SPAMMER <some_value>"
940
941(Getting a value from Redis)
942
943set acl_c_spam_host = ${lookup redis{GET...}}
944
945
a3c86431
TL
946Proxy Protocol Support
947--------------------------------------------------------------
948
949Exim now has Experimental "Proxy Protocol" support. It was built on
950specifications from:
951http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
36719342
TL
952Above URL revised May 2014 to change version 2 spec:
953http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
a3c86431
TL
954
955The purpose of this function is so that an application load balancer,
956such as HAProxy, can sit in front of several Exim servers and Exim
957will log the IP that is connecting to the proxy server instead of
958the IP of the proxy server when it connects to Exim. It resets the
959$sender_address_host and $sender_address_port to the IP:port of the
960connection to the proxy. It also re-queries the DNS information for
961this new IP address so that the original sender's hostname and IP
962get logged in the Exim logfile. There is no logging if a host passes or
963fails Proxy Protocol negotiation, but it can easily be determined and
964recorded in an ACL (example is below).
965
9661. To compile Exim with Proxy Protocol support, put this in
967Local/Makefile:
968
969EXPERIMENTAL_PROXY=yes
970
9712. Global configuration settings:
972
973proxy_required_hosts = HOSTLIST
974
975The proxy_required_hosts option will require any IP in that hostlist
976to use Proxy Protocol. The specification of Proxy Protocol is very
977strict, and if proxy negotiation fails, Exim will not allow any SMTP
978command other than QUIT. (See end of this section for an example.)
979The option is expanded when used, so it can be a hostlist as well as
980string of IP addresses. Since it is expanded, specifying an alternate
981separator is supported for ease of use with IPv6 addresses.
982
983To log the IP of the proxy in the incoming logline, add:
984 log_selector = +proxy
985
986A default incoming logline (wrapped for appearance) will look like this:
987
988 2013-11-04 09:25:06 1VdNti-0001OY-1V <= me@example.net
989 H=mail.example.net [1.2.3.4] P=esmtp S=433
990
991With the log selector enabled, an email that was proxied through a
992Proxy Protocol server at 192.168.1.2 will look like this:
993
994 2013-11-04 09:25:06 1VdNti-0001OY-1V <= me@example.net
995 H=mail.example.net [1.2.3.4] P=esmtp PRX=192.168.1.2 S=433
996
9973. In the ACL's the following expansion variables are available.
998
eb57651e
TL
999proxy_host_address The (internal) src IP of the proxy server
1000 making the connection to the Exim server.
1001proxy_host_port The (internal) src port the proxy server is
1002 using to connect to the Exim server.
1003proxy_target_address The dest (public) IP of the remote host to
1004 the proxy server.
1005proxy_target_port The dest port the remote host is using to
1006 connect to the proxy server.
1007proxy_session Boolean, yes/no, the connected host is required
1008 to use Proxy Protocol.
a3c86431
TL
1009
1010There is no expansion for a failed proxy session, however you can detect
1011it by checking if $proxy_session is true but $proxy_host is empty. As
1012an example, in my connect ACL, I have:
1013
1014 warn condition = ${if and{ {bool{$proxy_session}} \
a3bddaa8 1015 {eq{$proxy_host_address}{}} } }
a3c86431
TL
1016 log_message = Failed required proxy protocol negotiation \
1017 from $sender_host_name [$sender_host_address]
1018
1019 warn condition = ${if and{ {bool{$proxy_session}} \
a3bddaa8 1020 {!eq{$proxy_host_address}{}} } }
a3c86431 1021 # But don't log health probes from the proxy itself
a3bddaa8 1022 condition = ${if eq{$proxy_host_address}{$sender_host_address} \
a3c86431
TL
1023 {false}{true}}
1024 log_message = Successfully proxied from $sender_host_name \
1025 [$sender_host_address] through proxy protocol \
a3bddaa8 1026 host $proxy_host_address
a3c86431 1027
eb57651e
TL
1028 # Possibly more clear
1029 warn logwrite = Remote Source Address: $sender_host_address:$sender_host_port
1030 logwrite = Proxy Target Address: $proxy_target_address:$proxy_target_port
1031 logwrite = Proxy Internal Address: $proxy_host_address:$proxy_host_port
1032 logwrite = Internal Server Address: $received_ip_address:$received_port
1033
1034
2365d793 10354. Recommended ACL additions:
a3c86431
TL
1036 - Since the real connections are all coming from your proxy, and the
1037 per host connection tracking is done before Proxy Protocol is
1038 evaluated, smtp_accept_max_per_host must be set high enough to
1039 handle all of the parallel volume you expect per inbound proxy.
2365d793
TL
1040 - With the smtp_accept_max_per_host set so high, you lose the ability
1041 to protect your server from massive numbers of inbound connections
1042 from one IP. In order to prevent your server from being DOS'd, you
1043 need to add a per connection ratelimit to your connect ACL. I
1044 suggest something like this:
1045
1046 # Set max number of connections per host
1047 LIMIT = 5
1048 # Or do some kind of IP lookup in a flat file or database
1049 # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
1050
1051 defer message = Too many connections from this IP right now
1052 ratelimit = LIMIT / 5s / per_conn / strict
1053
1054
10555. Runtime issues to be aware of:
a3c86431
TL
1056 - The proxy has 3 seconds (hard-coded in the source code) to send the
1057 required Proxy Protocol header after it connects. If it does not,
1058 the response to any commands will be:
1059 "503 Command refused, required Proxy negotiation failed"
1060 - If the incoming connection is configured in Exim to be a Proxy
1061 Protocol host, but the proxy is not sending the header, the banner
1062 does not get sent until the timeout occurs. If the sending host
1063 sent any input (before the banner), this causes a standard Exim
1064 synchronization error (i.e. trying to pipeline before PIPELINING
1065 was advertised).
1066 - This is not advised, but is mentioned for completeness if you have
1067 a specific internal configuration that you want this: If the Exim
1068 server only has an internal IP address and no other machines in your
1069 organization will connect to it to try to send email, you may
1070 simply set the hostlist to "*", however, this will prevent local
1071 mail programs from working because that would require mail from
1072 localhost to use Proxy Protocol. Again, not advised!
1073
2365d793 10746. Example of a refused connection because the Proxy Protocol header was
a3c86431
TL
1075not sent from a host configured to use Proxy Protocol. In the example,
1076the 3 second timeout occurred (when a Proxy Protocol banner should have
1077been sent), the banner was displayed to the user, but all commands are
1078rejected except for QUIT:
1079
1080# nc mail.example.net 25
1081220-mail.example.net, ESMTP Exim 4.82+proxy, Mon, 04 Nov 2013 10:45:59
1082220 -0800 RFC's enforced
1083EHLO localhost
1084503 Command refused, required Proxy negotiation failed
1085QUIT
1086221 mail.example.net closing connection
1087
1088
8d692470
JH
1089
1090
7eb6c37c
JH
1091SOCKS
1092------------------------------------------------------------
1093Support for proxying outbound SMTP via a Socks 5 proxy
1094(RFC 1928) is included if Exim is compiled with
1095EXPERIMENTAL_SOCKS defined.
1096
1097If an smtp transport has a nonempty socks_proxy option
1098defined, this is active. The option is expanded and
1099should be a list (colon-separated by default) of
1100proxy specifiers. Each proxy specifier is a list
1101(space-separated by default) where the initial element
1102is an IP address and any subsequent elements are options.
1103
1104Options are a string <name>=<value>.
1105These options are currently defined:
1106- "auth", with possible values "none" and "name".
1107 Using "name" selects username/password authentication
1108 per RFC 1929. Default is "none".
1109- "name" sets the authentication username. Default is empty.
1110- "pass" sets the authentication password. Default is empty.
1111- "port" sets the tcp port number for the proxy. Default is 1080.
1112- "tmo" sets a connection timeout in seconds for this proxy. Default is 5.
1113
1114Proxies from the list are tried in order until
1115one responds. The timeout for the overall connection
1116applies to the set of proxied attempts.
1117
1118If events are used, the remote IP/port during a
1119tcp:connect event will be that of the proxy.
1120
1121
1122
1123
043b1248
JH
1124DANE
1125------------------------------------------------------------
7cac846b
JH
1126DNS-based Authentication of Named Entities, as applied
1127to SMTP over TLS, provides assurance to a client that
1128it is actually talking to the server it wants to rather
1129than some attacker operating a Man In The Middle (MITM)
1130operation. The latter can terminate the TLS connection
1131you make, and make another one to the server (so both
1132you and the server still think you have an encrypted
1133connection) and, if one of the "well known" set of
1134Certificate Authorities has been suborned - something
1135which *has* been seen already (2014), a verifiable
1136certificate (if you're using normal root CAs, eg. the
1137Mozilla set, as your trust anchors).
1138
1139What DANE does is replace the CAs with the DNS as the
1140trust anchor. The assurance is limited to a) the possibility
1141that the DNS has been suborned, b) mistakes made by the
1142admins of the target server. The attack surface presented
1143by (a) is thought to be smaller than that of the set
1144of root CAs.
1145
0e66b3b6
JH
1146It also allows the server to declare (implicitly) that
1147connections to it should use TLS. An MITM could simply
1148fail to pass on a server's STARTTLS.
1149
7cac846b
JH
1150DANE scales better than having to maintain (and
1151side-channel communicate) copies of server certificates
1152for every possible target server. It also scales
1153(slightly) better than having to maintain on an SMTP
1154client a copy of the standard CAs bundle. It also
1155means not having to pay a CA for certificates.
1156
1157DANE requires a server operator to do three things:
11581) run DNSSEC. This provides assurance to clients
1159that DNS lookups they do for the server have not
401a8935
JH
1160been tampered with. The domain MX record applying
1161to this server, its A record, its TLSA record and
1162any associated CNAME records must all be covered by
1163DNSSEC.
7cac846b
JH
11642) add TLSA DNS records. These say what the server
1165certificate for a TLS connection should be.
11663) offer a server certificate, or certificate chain,
1167in TLS connections which is traceable to the one
1168defined by (one of?) the TSLA records
1169
1170There are no changes to Exim specific to server-side
1171operation of DANE.
1172
1173The TLSA record for the server may have "certificate
0e66b3b6 1174usage" of DANE-TA(2) or DANE-EE(3). The latter specifies
7cac846b
JH
1175the End Entity directly, i.e. the certificate involved
1176is that of the server (and should be the sole one transmitted
1177during the TLS handshake); this is appropriate for a
1178single system, using a self-signed certificate.
0e66b3b6 1179 DANE-TA usage is effectively declaring a specific CA
7cac846b
JH
1180to be used; this might be a private CA or a public,
1181well-known one. A private CA at simplest is just
1182a self-signed certificate which is used to sign
1183cerver certificates, but running one securely does
1184require careful arrangement. If a private CA is used
1185then either all clients must be primed with it, or
1186(probably simpler) the server TLS handshake must transmit
1187the entire certificate chain from CA to server-certificate.
1188If a public CA is used then all clients must be primed with it
1189(losing one advantage of DANE) - but the attack surface is
1190reduced from all public CAs to that single CA.
0e66b3b6 1191DANE-TA is commonly used for several services and/or
7cac846b
JH
1192servers, each having a TLSA query-domain CNAME record,
1193all of which point to a single TLSA record.
1194
1195The TLSA record should have a Selector field of SPKI(1)
401a8935
JH
1196and a Matching Type field of SHA2-512(2).
1197
1198At the time of writing, https://www.huque.com/bin/gen_tlsa
1199is useful for quickly generating TLSA records; and commands like
1200
1201 openssl x509 -in -pubkey -noout <certificate.pem \
1202 | openssl rsa -outform der -pubin 2>/dev/null \
1203 | openssl sha512 \
1204 | awk '{print $2}'
1205
1206are workable for 4th-field hashes.
7cac846b 1207
0e66b3b6 1208For use with the DANE-TA model, server certificates
7cac846b
JH
1209must have a correct name (SubjectName or SubjectAltName).
1210
1211The use of OCSP-stapling should be considered, allowing
1212for fast revocation of certificates (which would otherwise
eeb9276b 1213be limited by the DNS TTL on the TLSA records). However,
0e66b3b6 1214this is likely to only be usable with DANE-TA. NOTE: the
fca41d5a
JH
1215default of requesting OCSP for all hosts is modified iff
1216DANE is in use, to:
1217
1218 hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
1219 {= {4}{$tls_out_tlsa_usage}} } \
594706ea 1220 {*}{}}
fca41d5a
JH
1221
1222The (new) variable $tls_out_tlsa_usage is a bitfield with
1223numbered bits set for TLSA record usage codes.
1224The zero above means DANE was not in use,
0e66b3b6
JH
1225the four means that only DANE-TA usage TLSA records were
1226found. If the definition of hosts_request_ocsp includes the
1227string "tls_out_tlsa_usage", they are re-expanded in time to
1228control the OCSP request.
594706ea 1229
fca41d5a 1230This modification of hosts_request_ocsp is only done if
036ed0db
JH
1231it has the default value of "*". Admins who change it, and
1232those who use hosts_require_ocsp, should consider the interaction
1233with DANE in their OCSP settings.
7cac846b
JH
1234
1235
7a31d643
JH
1236For client-side DANE there are two new smtp transport options,
1237hosts_try_dane and hosts_require_dane. They do the obvious thing.
1238[ should they be domain-based rather than host-based? ]
7cac846b
JH
1239
1240DANE will only be usable if the target host has DNSSEC-secured
1241MX, A and TLSA records.
1242
0e66b3b6
JH
1243A TLSA lookup will be done if either of the above options match
1244and the host-lookup succeded using dnssec.
3750d68d
JH
1245If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
1246will be required for the host.
0e66b3b6 1247
7cac846b
JH
1248(TODO: specify when fallback happens vs. when the host is not used)
1249
3750d68d
JH
1250If DANE is requested and useable (see above) the following transport
1251options are ignored:
0e66b3b6 1252 hosts_require_tls
043b1248
JH
1253 tls_verify_hosts
1254 tls_try_verify_hosts
1255 tls_verify_certificates
1256 tls_crl
1257 tls_verify_cert_hostnames
043b1248 1258
3750d68d
JH
1259If DANE is not usable, whether requested or not, and CA-anchored
1260verification evaluation is wanted, the above variables should be set
1261appropriately.
1262
7cac846b
JH
1263Currently dnssec_request_domains must be active (need to think about that)
1264and dnssec_require_domains is ignored.
043b1248 1265
eeb9276b
JH
1266If verification was successful using DANE then the "CV" item
1267in the delivery log line will show as "CV=dane".
1268
594706ea
JH
1269There is a new variable $tls_out_dane which will have "yes" if
1270verification succeeded using DANE and "no" otherwise (only useful
8d692470 1271in combination with EXPERIMENTAL_EVENT), and a new variable
594706ea
JH
1272$tls_out_tlsa_usage (detailed above).
1273
e51c7be2 1274
c65be124 1275
ed0512a1 1276INTERNATIONAL
c65be124 1277------------------------------------------------------------
ed0512a1 1278SMTPUTF8
c65be124
JH
1279Internationalised mail name handling.
1280RFCs 6530, 6533, 5890
1281
4e08fd50
JH
1282Compile with EXPERIMENTAL_INTERNATIONAL and libidn.
1283
810d16ad 1284New main config option smtputf8_advertise_hosts, default '*',
9d4319df
JH
1285a host list. If this matches the sending host and
1286accept_8bitmime is true (the default) then the ESMTP option
1287SMTPUTF8 will be advertised.
1288
1289If the sender specifies the SMTPUTF8 option on a MAIL command
1290international handling for the message is enabled and
1291the expansion variable $message_smtputf8 will have value TRUE.
1292
1293The option allow_utf8_domains is set to true for this
7019e10b
JH
1294message. All DNS lookups are converted to a-label form
1295whatever the setting of allow_utf8_domains.
9d4319df 1296
810d16ad
JH
1297Both localparts and domain are maintained as the original
1298utf8 form internally; any matching or regex use will
1299require appropriate care. Filenames created, eg. by
1300the appendfile transport, will have utf8 name.
1301
1302Helo names sent by the smtp transport will have any utf8
1303components expanded to a-label form.
1304
4af0d74a
JH
1305Any certificate name checks will be done using the a-label
1306form of the name.
1307
9d4319df 1308Log lines and Received-by: header lines will aquire a "utf8"
5a886ce7 1309prefix on the protocol element, eg. utf8esmtp.
9d4319df 1310
810d16ad 1311New expansion operators:
4e08fd50
JH
1312 ${utf8_domain_to_alabel:str}
1313 ${utf8_domain_from_alabel:str}
1314 ${utf8_localpart_to_alabel:str}
1315 ${utf8_localpart_from_alabel:str}
c65be124 1316
3c8b3577
JH
1317New "control = utf8_downconvert" ACL modifier,
1318sets a flag requiring that addresses are converted to
1319a-label form before smtp delivery, for use in a
1320Message Submission Agent context. Can also be
1321phrased as "control = utf8_downconvert/1" and is
1322mandatory. The flag defaults to zero and can be cleared
1323by "control = utf8_downconvert/0". The value "-1"
1324may also be used, to use a-label for only if the
1325destination host does not support SMTPUTF8.
1326
9479146e
JH
1327If mua_wrapper is set, the utf8_downconvert control
1328defaults to -1 (convert if needed).
1329
1330
1331There is no explicit support for VRFY and EXPN.
1332Configurations supporting these should inspect
1333$smtp_command_argument for an SMTPUTF8 argument.
1334
1335There is no support for LMTP on Unix sockets.
1336Using the "lmtp" protocol option on an smtp transport,
1337for LMTP over TCP, should work as expected.
1338
810d16ad 1339Known issues:
810d16ad 1340 - DSN unitext handling is not present
9479146e 1341 - no provision for converting logging from or to UTF-8
c65be124 1342
ed0512a1
JH
1343----
1344IMAP folder names
1345
1346New expansion operator:
1347
1348${imapfolder {<string>} {<sep>} {<specials>}}
1349
1350The string is converted from the charset specified by the headers charset
1351command (in a filter file) or headers_charset global option, to the
1352modified UTF-7 encoding specified by RFC 2060, with the following
1353exception: All occurences of <sep> (which has to be a single character)
1354are replaced with periods ("."), and all periods and slashes that aren't
1355<sep> and are not in the <specials> string are BASE64 encoded.
1356
1357The third argument can be omitted, defaulting to an empty string.
1358The second argument can be omitted, defaulting to "/".
1359
1360This is the encoding used by Courier for Maildir names on disk, and followed
1361by many other IMAP servers.
1362
1363 Example 1: ${imapfolder {Foo/Bar}} yields "Foo.Bar".
1364 Example 2: ${imapfolder {Foo/Bar}{.}{/}} yields "Foo&AC8-Bar".
1365 Example 3: ${imapfolder {Räksmörgås}} yields "R&AOQ-ksm&APY-rg&AOU-s".
1366
1367Note that the source charset setting is vital, and also that characters
1368must be representable in UTF-16.
1369
1370
1371
1372
ee161e8f
PH
1373--------------------------------------------------------------
1374End of file
1375--------------------------------------------------------------