Add macro support to -be expansion test mode. Bug 1623
[users/jgh/exim.git] / doc / doc-txt / NewStuff
1 New Features in Exim
2 --------------------
3
4 This file contains descriptions of new features that have been added to Exim.
5 Before a formal release, there may be quite a lot of detail so that people can
6 test from the snapshots or the Git before the documentation is updated. Once
7 the documentation is updated, this file is reduced to a short list.
8
9 Version 4.90
10 ------------
11
12  1. PKG_CONFIG_PATH can now be set in Local/Makefile;
13     wildcards will be expanded, values are collapsed.
14
15  2. The ${readsocket } expansion now takes an option to not shutdown the
16     connection after sending the query string.  The default remains to do so.
17
18  3. An smtp transport option "hosts_noproxy_tls" to control whether multiple
19     deliveries on a single TCP connection can maintain a TLS connection
20     open.  By default disabled for all hosts, doing so saves the cost of
21     making new TLS sessions, at the cost of having to proxy the data via
22     another process.  Logging is also affected.
23
24  4. A malware connection type for the FPSCAND protocol.
25
26  5. An option for recipient verify callouts to hold the connection open for
27     further recipients and for delivery.
28
29  6. The reproducible build $SOURCE_DATE_EPOCH environment variable is now
30     supported.
31
32  7. Optionally, an alternate format for spool data-files which matches the
33     wire format - meaning more efficient reception and transmission (at the
34     cost of difficulty with standard Unix tools).  Only used for messages
35     received using the ESMTP CHUNKING option, and when a new main-section
36     option "spool_wireformat" (false by default) is set.
37
38  8. New main configuration option "commandline_checks_require_admin" to
39     restrict who can use various introspection options.
40
41  9. New option modifier "no_check" for quota and quota_filecount
42     appendfile transport.
43
44 10. Variable $smtp_command_history returning a comma-sep list of recent
45     SMTP commands.
46
47 11. Millisecond timetamps in logs, on log_selector "millisec".  Also affects
48     log elements QT, DT and D, and timstamps in debug output.
49
50 12. TCP Fast Open logging.  As a server, logs when the SMTP banner was sent
51     while still in SYN_RECV state; as a client logs when the connection
52     is opened with a TFO cookie.
53
54 13. DKIM support for multiple signing, by domain and/or key-selector.
55     DKIM support for multiple hashes, and for alternate-identity tags.
56     Builtin macro with default list of signed headers.
57
58 14. Exipick understands -C|--config for an alternative Exim
59     configuration file.
60
61 15. TCP Fast Open used, with data-on-SYN, for client SMTP via SOCKS5 proxy,
62     for ${readsocket } expansions, and for ClamAV.
63
64 16. The "-be" expansion test mode now supports macros.  Macros are expanded
65     in test lines, and new macros can be defined.
66
67
68 Version 4.89
69 ------------
70
71  1. Allow relative config file names for ".include"
72
73  2. A main-section config option "debug_store" to control the checks on
74     variable locations during store-reset.  Normally false but can be enabled
75     when a memory corrution issue is suspected on a production system.
76
77
78 Version 4.88
79 ------------
80
81  1. The new perl_taintmode option allows to run the embedded perl
82     interpreter in taint mode.
83
84  2. New log_selector: dnssec, adds a "DS" tag to acceptance and delivery lines.
85
86  3. Speculative debugging, via a "kill" option to the "control=debug" ACL
87     modifier.
88
89  4. New expansion item ${sha3:<string>} / ${sha3_<N>:<string>}.
90     N can be 224, 256 (default), 384, 512.
91     With GnuTLS 3.5.0 or later, only.
92
93  5. Facility for named queues:  A command-line argument can specify
94     the queue name for a queue operation, and an ACL modifier can set
95     the queue to be used for a message.  A $queue_name variable gives
96     visibility.
97
98  6. New expansion operators base32/base32d.
99
100  7. The CHUNKING ESMTP extension from RFC 3030.  May give some slight
101     performance increase and network load decrease.  Main config option
102     chunking_advertise_hosts, and smtp transport option hosts_try_chunking
103     for control.
104
105  8. LMDB lookup support, as Experimental. Patch supplied by Andrew Colin Kissa.
106
107  9. Expansion operator escape8bit, like escape but not touching newline etc..
108
109 10. Feature macros, generated from compile options.  All start with "_HAVE_"
110     and go on with some roughly recognisable name.  Driver macros, for
111     router, transport and authentication drivers; names starting with "_DRIVER_".
112     Option macros, for each configuration-file option; all start with "_OPT_".
113     Use the "-bP macros" command-line option to see what is present.
114
115 11. Integer values for options can take a "G" multiplier.
116
117 12. defer=pass option for the ACL control cutthrough_delivery, to reflect 4xx
118     returns from the target back to the initiator, rather than spooling the
119     message.
120
121 13. New built-in constants available for tls_dhparam and default changed.
122
123 14. If built with EXPERIMENTAL_QUEUEFILE, a queuefile transport, for writing
124     out copies of the message spool files for use by 3rd-party scanners.
125
126 15. A new option on the smtp transport, hosts_try_fastopen.  If the system
127     supports it (on Linux it must be enabled in the kernel by the sysadmin)
128     try to use RFC 7413 "TCP Fast Open".  No data is sent on the SYN segment
129     but it permits a peer that also supports the facility to send its SMTP
130     banner immediately after the SYN,ACK segment rather then waiting for
131     another ACK - so saving up to one roundtrip time.  Because it requires
132     previous communication with the peer (we save a cookie from it) this
133     will only become active on frequently-contacted destinations.
134
135 16. A new syslog_pid option to suppress PID duplication in syslog lines.
136
137
138 Version 4.87
139 ------------
140
141  1. The ACL conditions regex and mime_regex now capture substrings
142     into numeric variables $regex1 to 9, like the "match" expansion condition.
143
144  2. New $callout_address variable records the address used for a spam=,
145     malware= or verify= callout.
146
147  3. Transports now take a "max_parallel" option, to limit concurrency.
148
149  4. Expansion operators ${ipv6norm:<string>} and ${ipv6denorm:<string>}.
150     The latter expands to a 8-element colon-sep set of hex digits including
151     leading zeroes. A trailing ipv4-style dotted-decimal set is converted
152     to hex.  Pure ipv4 addresses are converted to IPv4-mapped IPv6.
153     The former operator strips leading zeroes and collapses the longest
154     set of 0-groups to a double-colon.
155
156  5. New "-bP config" support, to dump the effective configuration.
157
158  6. New $dkim_key_length variable.
159
160  7. New base64d and base64 expansion items (the existing str2b64 being a
161     synonym of the latter).  Add support in base64 for certificates.
162
163  8. New main configuration option "bounce_return_linesize_limit" to
164     avoid oversize bodies in bounces. The default value matches RFC
165     limits.
166
167  9. New $initial_cwd expansion variable.
168
169
170 Version 4.86
171 ------------
172
173  1. Support for using the system standard CA bundle.
174
175  2. New expansion items $config_file, $config_dir, containing the file
176     and directory name of the main configuration file. Also $exim_version.
177
178  3. New "malware=" support for Avast.
179
180  4. New "spam=" variant option for Rspamd.
181
182  5. Assorted options on malware= and spam= scanners.
183
184  6. A command-line option to write a comment into the logfile.
185
186  7. If built with EXPERIMENTAL_SOCKS feature enabled, the smtp transport can
187     be configured to make connections via socks5 proxies.
188
189  8. If built with EXPERIMENTAL_INTERNATIONAL, support is included for
190     the transmission of UTF-8 envelope addresses.
191
192  9. If built with EXPERIMENTAL_INTERNATIONAL, an expansion item for a commonly
193     used encoding of Maildir folder names.
194
195 10. A logging option for slow DNS lookups.
196
197 11. New ${env {<variable>}} expansion.
198
199 12. A non-SMTP authenticator using information from TLS client certificates.
200
201 13. Main option "tls_eccurve" for selecting an Elliptic Curve for TLS.
202     Patch originally by Wolfgang Breyha.
203
204 14. Main option "dns_trust_aa" for trusting your local nameserver at the
205     same level as DNSSEC.
206
207
208 Version 4.85
209 ------------
210
211  1. If built with EXPERIMENTAL_DANE feature enabled, Exim will follow the
212     DANE SMTP draft to assess a secure chain of trust of the certificate
213     used to establish the TLS connection based on a TLSA record in the
214     domain of the sender.
215
216  2. The EXPERIMENTAL_TPDA feature has been renamed to EXPERIMENTAL_EVENT
217     and several new events have been created. The reason is because it has
218     been expanded beyond just firing events during the transport phase. Any
219     existing TPDA transport options will have to be rewritten to use a new
220     $event_name expansion variable in a condition. Refer to the
221     experimental-spec.txt for details and examples.
222
223  3. The EXPERIMENTAL_CERTNAMES features is an enhancement to verify that
224     server certs used for TLS match the result of the MX lookup. It does
225     not use the same mechanism as DANE.
226
227
228 Version 4.84
229 ------------
230
231
232 Version 4.83
233 ------------
234
235  1. If built with the EXPERIMENTAL_PROXY feature enabled, Exim can be
236     configured to expect an initial header from a proxy that will make the
237     actual external source IP:host be used in exim instead of the IP of the
238     proxy that is connecting to it.
239
240  2. New verify option header_names_ascii, which will check to make sure
241     there are no non-ASCII characters in header names.  Exim itself handles
242     those non-ASCII characters, but downstream apps may not, so Exim can
243     detect and reject if those characters are present.
244
245  3. New expansion operator ${utf8clean:string} to replace malformed UTF8
246     codepoints with valid ones.
247
248  4. New malware type "sock".  Talks over a Unix or TCP socket, sending one
249     command line and matching a regex against the return data for trigger
250     and a second regex to extract malware_name.  The mail spoolfile name can
251     be included in the command line.
252
253  5. The smtp transport now supports options "tls_verify_hosts" and
254     "tls_try_verify_hosts".  If either is set the certificate verification
255     is split from the encryption operation. The default remains that a failed
256     verification cancels the encryption.
257
258  6. New SERVERS override of default ldap server list.  In the ACLs, an ldap
259     lookup can now set a list of servers to use that is different from the
260     default list.
261
262  7. New command-line option -C for exiqgrep to specify alternate exim.conf
263     file when searching the queue.
264
265  8. OCSP now supports GnuTLS also, if you have version 3.1.3 or later of that.
266
267  9. Support for DNSSEC on outbound connections.
268
269 10. New variables "tls_(in,out)_(our,peer)cert" and expansion item
270     "certextract" to extract fields from them. Hash operators md5 and sha1
271     work over them for generating fingerprints, and a new sha256 operator
272     for them added.
273
274 11. PRDR is now supported dy default.
275
276 12. OCSP stapling is now supported by default.
277
278 13. If built with the EXPERIMENTAL_DSN feature enabled, Exim will output
279     Delivery Status Notification messages in MIME format, and negotiate
280     DSN features per RFC 3461.
281
282
283 Version 4.82
284 ------------
285
286  1. New command-line option -bI:sieve will list all supported sieve extensions
287     of this Exim build on standard output, one per line.
288     ManageSieve (RFC 5804) providers managing scripts for use by Exim should
289     query this to establish the correct list to include in the protocol's
290     SIEVE capability line.
291
292  2. If the -n option is combined with the -bP option, then the name of an
293     emitted option is not output, only the value (if visible to you).
294     For instance, "exim -n -bP pid_file_path" should just emit a pathname
295     followed by a newline, and no other text.
296
297  3. When built with SUPPORT_TLS and USE_GNUTLS, the SMTP transport driver now
298     has a "tls_dh_min_bits" option, to set the minimum acceptable number of
299     bits in the Diffie-Hellman prime offered by a server (in DH ciphersuites)
300     acceptable for security.  (Option accepted but ignored if using OpenSSL).
301     Defaults to 1024, the old value.  May be lowered only to 512, or raised as
302     far as you like.  Raising this may hinder TLS interoperability with other
303     sites and is not currently recommended.  Lowering this will permit you to
304     establish a TLS session which is not as secure as you might like.
305
306     Unless you really know what you are doing, leave it alone.
307
308  4. If not built with DISABLE_DNSSEC, Exim now has the main option
309     dns_dnssec_ok; if set to 1 then Exim will initialise the resolver library
310     to send the DO flag to your recursive resolver.  If you have a recursive
311     resolver, which can set the Authenticated Data (AD) flag in results, Exim
312     can now detect this.  Exim does not perform validation itself, instead
313     relying upon a trusted path to the resolver.
314
315     Current status: work-in-progress; $sender_host_dnssec variable added.
316
317  5. DSCP support for outbound connections: on a transport using the smtp driver,
318     set "dscp = ef", for instance, to cause the connections to have the relevant
319     DSCP (IPv4 TOS or IPv6 TCLASS) value in the header.
320
321     Similarly for inbound connections, there is a new control modifier, dscp,
322     so "warn control = dscp/ef" in the connect ACL, or after authentication.
323
324     Supported values depend upon system libraries.  "exim -bI:dscp" to list the
325     ones Exim knows of.  You can also set a raw number 0..0x3F.
326
327  6. The -G command-line flag is no longer ignored; it is now equivalent to an
328     ACL setting "control = suppress_local_fixups".  The -L command-line flag
329     is now accepted and forces use of syslog, with the provided tag as the
330     process name.  A few other flags used by Sendmail are now accepted and
331     ignored.
332
333  7. New cutthrough routing feature.  Requested by a "control = cutthrough_delivery"
334     ACL modifier; works for single-recipient mails which are received on and
335     deliverable via SMTP.  Using the connection made for a recipient verify,
336     if requested before the verify, or a new one made for the purpose while
337     the inbound connection is still active.  The bulk of the mail item is copied
338     direct from the inbound socket to the outbound (as well as the spool file).
339     When the source notifies the end of data, the data acceptance by the destination
340     is negotiated before the acceptance is sent to the source.  If the destination
341     does not accept the mail item, for example due to content-scanning, the item
342     is not accepted from the source and therefore there is no need to generate
343     a bounce mail.  This is of benefit when providing a secondary-MX service.
344     The downside is that delays are under the control of the ultimate destination
345     system not your own.
346
347     The Received-by: header on items delivered by cutthrough is generated
348     early in reception rather than at the end; this will affect any timestamp
349     included.  The log line showing delivery is recorded before that showing
350     reception; it uses a new ">>" tag instead of "=>".
351
352     To support the feature, verify-callout connections can now use ESMTP and TLS.
353     The usual smtp transport options are honoured, plus a (new, default everything)
354     hosts_verify_avoid_tls.
355
356     New variable families named tls_in_cipher, tls_out_cipher etc. are introduced
357     for specific access to the information for each connection.  The old names
358     are present for now but deprecated.
359
360     Not yet supported: IGNOREQUOTA, SIZE, PIPELINING.
361
362  8. New expansion operators ${listnamed:name} to get the content of a named list
363     and ${listcount:string} to count the items in a list.
364
365  9. New global option "gnutls_allow_auto_pkcs11", defaults false.  The GnuTLS
366     rewrite in 4.80 combines with GnuTLS 2.12.0 or later, to autoload PKCS11
367     modules.  For some situations this is desirable, but we expect admin in
368     those situations to know they want the feature.  More commonly, it means
369     that GUI user modules get loaded and are broken by the setuid Exim being
370     unable to access files specified in environment variables and passed
371     through, thus breakage.  So we explicitly inhibit the PKCS11 initialisation
372     unless this new option is set.
373
374     Some older OS's with earlier versions of GnuTLS might not have pkcs11 ability,
375     so have also added a build option which can be used to build Exim with GnuTLS
376     but without trying to use any kind of PKCS11 support.  Uncomment this in the
377     Local/Makefile:
378
379     AVOID_GNUTLS_PKCS11=yes
380
381 10. The "acl = name" condition on an ACL now supports optional arguments.
382     New expansion item "${acl {name}{arg}...}" and expansion condition
383     "acl {{name}{arg}...}" are added.  In all cases up to nine arguments
384     can be used, appearing in $acl_arg1 to $acl_arg9 for the called ACL.
385     Variable $acl_narg contains the number of arguments.  If the ACL sets
386     a "message =" value this becomes the result of the expansion item,
387     or the value of $value for the expansion condition.  If the ACL returns
388     accept the expansion condition is true; if reject, false.  A defer
389     return results in a forced fail.
390
391 11. Routers and transports can now have multiple headers_add and headers_remove
392     option lines.  The concatenated list is used.
393
394 12. New ACL modifier "remove_header" can remove headers before message gets
395     handled by routers/transports.
396
397 13. New dnsdb lookup pseudo-type "a+".  A sequence of "a6" (if configured),
398     "aaaa" and "a" lookups is done and the full set of results returned.
399
400 14. New expansion variable $headers_added with content from ACL add_header
401     modifier (but not yet added to message).
402
403 15. New 8bitmime status logging option for received messages.  Log field "M8S".
404
405 16. New authenticated_sender logging option, adding to log field "A".
406
407 17. New expansion variables $router_name and $transport_name.  Useful
408     particularly for debug_print as -bt command-line option does not
409     require privilege whereas -d does.
410
411 18. If built with EXPERIMENTAL_PRDR, per-recipient data responses per a
412     proposed extension to SMTP from Eric Hall.
413
414 19. The pipe transport has gained the force_command option, to allow
415     decorating commands from user .forward pipe aliases with prefix
416     wrappers, for instance.
417
418 20. Callout connections can now AUTH; the same controls as normal delivery
419     connections apply.
420
421 21. Support for DMARC, using opendmarc libs, can be enabled. It adds new
422     options: dmarc_forensic_sender, dmarc_history_file, and dmarc_tld_file.
423     It adds new expansion variables $dmarc_ar_header, $dmarc_status,
424     $dmarc_status_text, and $dmarc_used_domain.  It adds a new acl modifier
425     dmarc_status.  It adds new control flags dmarc_disable_verify and
426     dmarc_enable_forensic. The default for the dmarc_tld_file option is
427     "/etc/exim/opendmarc.tlds" and can be changed via EDITME.
428
429 22. Add expansion variable $authenticated_fail_id, which is the username
430     provided to the authentication method which failed.  It is available
431     for use in subsequent ACL processing (typically quit or notquit ACLs).
432
433 23. New ACL modifier "udpsend" can construct a UDP packet to send to a given
434     UDP host and port.
435
436 24. New ${hexquote:..string..} expansion operator converts non-printable
437     characters in the string to \xNN form.
438
439 25. Experimental TPDA (Transport Post Delivery Action) function added.
440     Patch provided by Axel Rau.
441
442 26. Experimental Redis lookup added. Patch provided by Warren Baker.
443
444
445 Version 4.80
446 ------------
447
448  1. New authenticator driver, "gsasl".  Server-only (at present).
449     This is a SASL interface, licensed under GPL, which can be found at
450     http://www.gnu.org/software/gsasl/.
451     This system does not provide sources of data for authentication, so
452     careful use needs to be made of the conditions in Exim.
453
454  2. New authenticator driver, "heimdal_gssapi".  Server-only.
455     A replacement for using cyrus_sasl with Heimdal, now that $KRB5_KTNAME
456     is no longer honoured for setuid programs by Heimdal.  Use the
457     "server_keytab" option to point to the keytab.
458
459  3. The "pkg-config" system can now be used when building Exim to reference
460     cflags and library information for lookups and authenticators, rather
461     than having to update "CFLAGS", "AUTH_LIBS", "LOOKUP_INCLUDE" and
462     "LOOKUP_LIBS" directly.  Similarly for handling the TLS library support
463     without adjusting "TLS_INCLUDE" and "TLS_LIBS".
464
465     In addition, setting PCRE_CONFIG=yes will query the pcre-config tool to
466     find the headers and libraries for PCRE.
467
468  4. New expansion variable $tls_bits.
469
470  5. New lookup type, "dbmjz".  Key is an Exim list, the elements of which will
471     be joined together with ASCII NUL characters to construct the key to pass
472     into the DBM library.  Can be used with gsasl to access sasldb2 files as
473     used by Cyrus SASL.
474
475  6. OpenSSL now supports TLS1.1 and TLS1.2 with OpenSSL 1.0.1.
476
477     Avoid release 1.0.1a if you can.  Note that the default value of
478     "openssl_options" is no longer "+dont_insert_empty_fragments", as that
479     increased susceptibility to attack.  This may still have interoperability
480     implications for very old clients (see version 4.31 change 37) but
481     administrators can choose to make the trade-off themselves and restore
482     compatibility at the cost of session security.
483
484  7. Use of the new expansion variable $tls_sni in the main configuration option
485     tls_certificate will cause Exim to re-expand the option, if the client
486     sends the TLS Server Name Indication extension, to permit choosing a
487     different certificate; tls_privatekey will also be re-expanded.  You must
488     still set these options to expand to valid files when $tls_sni is not set.
489
490     The SMTP Transport has gained the option tls_sni, which will set a hostname
491     for outbound TLS sessions, and set $tls_sni too.
492
493     A new log_selector, +tls_sni, has been added, to log received SNI values
494     for Exim as a server.
495
496  8. The existing "accept_8bitmime" option now defaults to true.  This means
497     that Exim is deliberately not strictly RFC compliant.  We're following
498     Dan Bernstein's advice in http://cr.yp.to/smtp/8bitmime.html by default.
499     Those who disagree, or know that they are talking to mail servers that,
500     even today, are not 8-bit clean, need to turn off this option.
501
502  9. Exim can now be started with -bw (with an optional timeout, given as
503     -bw<timespec>).  With this, stdin at startup is a socket that is
504     already listening for connections.  This has a more modern name of
505     "socket activation", but forcing the activated socket to fd 0.  We're
506     interested in adding more support for modern variants.
507
508 10. ${eval } now uses 64-bit values on supporting platforms.  A new "G" suffix
509     for numbers indicates multiplication by 1024^3.
510
511 11. The GnuTLS support has been revamped; the three options gnutls_require_kx,
512     gnutls_require_mac & gnutls_require_protocols are no longer supported.
513     tls_require_ciphers is now parsed by gnutls_priority_init(3) as a priority
514     string, documentation for which is at:
515     http://www.gnutls.org/manual/html_node/Priority-Strings.html
516
517     SNI support has been added to Exim's GnuTLS integration too.
518
519     For sufficiently recent GnuTLS libraries, ${randint:..} will now use
520     gnutls_rnd(), asking for GNUTLS_RND_NONCE level randomness.
521
522 12. With OpenSSL, if built with EXPERIMENTAL_OCSP, a new option tls_ocsp_file
523     is now available.  If the contents of the file are valid, then Exim will
524     send that back in response to a TLS status request; this is OCSP Stapling.
525     Exim will not maintain the contents of the file in any way: administrators
526     are responsible for ensuring that it is up-to-date.
527
528     See "experimental-spec.txt" for more details.
529
530 13. ${lookup dnsdb{ }} supports now SPF record types. They are handled
531     identically to TXT record lookups.
532
533 14. New expansion variable $tod_epoch_l for higher-precision time.
534
535 15. New global option tls_dh_max_bits, defaulting to current value of NSS
536     hard-coded limit of DH ephemeral bits, to fix interop problems caused by
537     GnuTLS 2.12 library recommending a bit count higher than NSS supports.
538
539 16. tls_dhparam now used by both OpenSSL and GnuTLS, can be path or identifier.
540     Option can now be a path or an identifier for a standard prime.
541     If unset, we use the DH prime from section 2.2 of RFC 5114, "ike23".
542     Set to "historic" to get the old GnuTLS behaviour of auto-generated DH
543     primes.
544
545 17. SSLv2 now disabled by default in OpenSSL.  (Never supported by GnuTLS).
546     Use "openssl_options -no_sslv2" to re-enable support, if your OpenSSL
547     install was not built with OPENSSL_NO_SSL2 ("no-ssl2").
548
549
550 Version 4.77
551 ------------
552
553  1. New options for the ratelimit ACL condition: /count= and /unique=.
554     The /noupdate option has been replaced by a /readonly option.
555
556  2. The SMTP transport's protocol option may now be set to "smtps", to
557     use SSL-on-connect outbound.
558
559  3. New variable $av_failed, set true if the AV scanner deferred; ie, when
560     there is a problem talking to the AV scanner, or the AV scanner running.
561
562  4. New expansion conditions, "inlist" and "inlisti", which take simple lists
563     and check if the search item is a member of the list.  This does not
564     support named lists, but does subject the list part to string expansion.
565
566  5. Unless the new EXPAND_LISTMATCH_RHS build option is set when Exim was
567     built, Exim no longer performs string expansion on the second string of
568     the match_* expansion conditions: "match_address", "match_domain",
569     "match_ip" & "match_local_part".  Named lists can still be used.
570
571
572 Version 4.76
573 ------------
574
575  1. The global option "dns_use_edns0" may be set to coerce EDNS0 usage on
576     or off in the resolver library.
577
578
579 Version 4.75
580 ------------
581
582  1. In addition to the existing LDAP and LDAP/SSL ("ldaps") support, there
583     is now LDAP/TLS support, given sufficiently modern OpenLDAP client
584     libraries.  The following global options have been added in support of
585     this: ldap_ca_cert_dir, ldap_ca_cert_file, ldap_cert_file, ldap_cert_key,
586     ldap_cipher_suite, ldap_require_cert, ldap_start_tls.
587
588  2. The pipe transport now takes a boolean option, "freeze_signal", default
589     false.  When true, if the external delivery command exits on a signal then
590     Exim will freeze the message in the queue, instead of generating a bounce.
591
592  3. Log filenames may now use %M as an escape, instead of %D (still available).
593     The %M pattern expands to yyyymm, providing month-level resolution.
594
595  4. The $message_linecount variable is now updated for the maildir_tag option,
596     in the same way as $message_size, to reflect the real number of lines,
597     including any header additions or removals from transport.
598
599  5. When contacting a pool of SpamAssassin servers configured in spamd_address,
600     Exim now selects entries randomly, to better scale in a cluster setup.
601
602
603 Version 4.74
604 ------------
605
606  1. SECURITY FIX: privilege escalation flaw fixed. On Linux (and only Linux)
607     the flaw permitted the Exim run-time user to cause root to append to
608     arbitrary files of the attacker's choosing, with the content based
609     on content supplied by the attacker.
610
611  2. Exim now supports loading some lookup types at run-time, using your
612     platform's dlopen() functionality.  This has limited platform support
613     and the intention is not to support every variant, it's limited to
614     dlopen().  This permits the main Exim binary to not be linked against
615     all the libraries needed for all the lookup types.
616
617
618 Version 4.73
619 ------------
620
621  NOTE: this version is not guaranteed backwards-compatible, please read the
622        items below carefully
623
624  1. A new main configuration option, "openssl_options", is available if Exim
625     is built with SSL support provided by OpenSSL.  The option allows
626     administrators to specify OpenSSL options to be used on connections;
627     typically this is to set bug compatibility features which the OpenSSL
628     developers have not enabled by default.  There may be security
629     consequences for certain options, so these should not be changed
630     frivolously.
631
632  2. A new pipe transport option, "permit_coredumps", may help with problem
633     diagnosis in some scenarios.  Note that Exim is typically installed as
634     a setuid binary, which on most OSes will inhibit coredumps by default,
635     so that safety mechanism would have to be overridden for this option to
636     be able to take effect.
637
638  3. ClamAV 0.95 is now required for ClamAV support in Exim, unless
639     Local/Makefile sets: WITH_OLD_CLAMAV_STREAM=yes
640     Note that this switches Exim to use a new API ("INSTREAM") and a future
641     release of ClamAV will remove support for the old API ("STREAM").
642
643     The av_scanner option, when set to "clamd", now takes an optional third
644     part, "local", which causes Exim to pass a filename to ClamAV instead of
645     the file content.  This is the same behaviour as when clamd is pointed at
646     a Unix-domain socket.  For example:
647
648       av_scanner = clamd:192.0.2.3 1234:local
649
650     ClamAV's ExtendedDetectionInfo response format is now handled.
651
652  4. There is now a -bmalware option, restricted to admin users.  This option
653     takes one parameter, a filename, and scans that file with Exim's
654     malware-scanning framework.  This is intended purely as a debugging aid
655     to ensure that Exim's scanning is working, not to replace other tools.
656     Note that the ACL framework is not invoked, so if av_scanner references
657     ACL variables without a fallback then this will fail.
658
659  5. There is a new expansion operator, "reverse_ip", which will reverse IP
660     addresses; IPv4 into dotted quad, IPv6 into dotted nibble.  Examples:
661
662       ${reverse_ip:192.0.2.4}
663        -> 4.2.0.192
664       ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
665        -> 3.0.2.0.0.0.0.c.d.c.b.a.1.0.0.0.9.0.0.0.2.4.c.0.8.b.d.0.1.0.0.2
666
667  6. There is a new ACL control called "debug", to enable debug logging.
668     This allows selective logging of certain incoming transactions within
669     production environments, with some care.  It takes two options, "tag"
670     and "opts"; "tag" is included in the filename of the log and "opts"
671     is used as per the -d<options> command-line option.  Examples, which
672     don't all make sense in all contexts:
673
674       control = debug
675       control = debug/tag=.$sender_host_address
676       control = debug/opts=+expand+acl
677       control = debug/tag=.$message_exim_id/opts=+expand
678
679  7. It has always been implicit in the design and the documentation that
680     "the Exim user" is not root.  src/EDITME said that using root was
681     "very strongly discouraged".  This is not enough to keep people from
682     shooting themselves in the foot in days when many don't configure Exim
683     themselves but via package build managers.  The security consequences of
684     running various bits of network code are severe if there should be bugs in
685     them.  As such, the Exim user may no longer be root.  If configured
686     statically, Exim will refuse to build.  If configured as ref:user then Exim
687     will exit shortly after start-up.  If you must shoot yourself in the foot,
688     then henceforth you will have to maintain your own local patches to strip
689     the safeties off.
690
691  8. There is a new expansion condition, bool_lax{}.  Where bool{} uses the ACL
692     condition logic to determine truth/failure and will fail to expand many
693     strings, bool_lax{} uses the router condition logic, where most strings
694     do evaluate true.
695     Note: bool{00} is false, bool_lax{00} is true.
696
697  9. Routers now support multiple "condition" tests.
698
699 10. There is now a runtime configuration option "tcp_wrappers_daemon_name".
700     Setting this allows an admin to define which entry in the tcpwrappers
701     config file will be used to control access to the daemon.  This option
702     is only available when Exim is built with USE_TCP_WRAPPERS.  The
703     default value is set at build time using the TCP_WRAPPERS_DAEMON_NAME
704     build option.
705
706 11. [POSSIBLE CONFIG BREAKAGE] The default value for system_filter_user is now
707     the Exim run-time user, instead of root.
708
709 12. [POSSIBLE CONFIG BREAKAGE] ALT_CONFIG_ROOT_ONLY is no longer optional and
710     is forced on.  This is mitigated by the new build option
711     TRUSTED_CONFIG_LIST which defines a list of configuration files which
712     are trusted; one per line. If a config file is owned by root and matches
713     a pathname in the list, then it may be invoked by the Exim build-time
714     user without Exim relinquishing root privileges.
715
716 13. [POSSIBLE CONFIG BREAKAGE] The Exim user is no longer automatically
717     trusted to supply -D<Macro[=Value]> overrides on the command-line.  Going
718     forward, we recommend using TRUSTED_CONFIG_LIST with shim configs that
719     include the main config.  As a transition mechanism, we are temporarily
720     providing a work-around: the new build option WHITELIST_D_MACROS provides
721     a colon-separated list of macro names which may be overridden by the Exim
722     run-time user.  The values of these macros are constrained to the regex
723     ^[A-Za-z0-9_/.-]*$ (which explicitly does allow for empty values).
724
725
726 Version 4.72
727 ------------
728
729  1. TWO SECURITY FIXES: one relating to mail-spools which are globally
730     writable, the other to locking of MBX folders (not mbox).
731
732  2. MySQL stored procedures are now supported.
733
734  3. The dkim_domain transport option is now a list, not a single string, and
735     messages will be signed for each element in the list (discarding
736     duplicates).
737
738  4. The 4.70 release unexpectedly changed the behaviour of dnsdb TXT lookups
739     in the presence of multiple character strings within the RR. Prior to 4.70,
740     only the first string would be returned.  The dnsdb lookup now, by default,
741     preserves the pre-4.70 semantics, but also now takes an extended output
742     separator specification.  The separator can be followed by a semicolon, to
743     concatenate the individual text strings together with no join character,
744     or by a comma and a second separator character, in which case the text
745     strings within a TXT record are joined on that second character.
746     Administrators are reminded that DNS provides no ordering guarantees
747     between multiple records in an RRset.  For example:
748
749       foo.example.  IN TXT "a" "b" "c"
750       foo.example.  IN TXT "d" "e" "f"
751
752       ${lookup dnsdb{>/ txt=foo.example}}   -> "a/d"
753       ${lookup dnsdb{>/; txt=foo.example}}  -> "def/abc"
754       ${lookup dnsdb{>/,+ txt=foo.example}} -> "a+b+c/d+e+f"
755
756
757 Version 4.70 / 4.71
758 -------------------
759
760  1. Native DKIM support without an external library.
761     (Note that if no action to prevent it is taken, a straight upgrade will
762     result in DKIM verification of all signed incoming emails.  See spec
763     for details on conditionally disabling)
764
765  2. Experimental DCC support via dccifd (contributed by Wolfgang Breyha).
766
767  3. There is now a bool{} expansion condition which maps certain strings to
768     true/false condition values (most likely of use in conjunction with the
769     and{} expansion operator).
770
771  4. The $spam_score, $spam_bar and $spam_report variables are now available
772     at delivery time.
773
774  5. exim -bP now supports "macros", "macro_list" or "macro MACRO_NAME" as
775     options, provided that Exim is invoked by an admin_user.
776
777  6. There is a new option gnutls_compat_mode, when linked against GnuTLS,
778     which increases compatibility with older clients at the cost of decreased
779     security.  Don't set this unless you need to support such clients.
780
781  7. There is a new expansion operator, ${randint:...} which will produce a
782     "random" number less than the supplied integer.  This randomness is
783     not guaranteed to be cryptographically strong, but depending upon how
784     Exim was built may be better than the most naive schemes.
785
786  8. Exim now explicitly ensures that SHA256 is available when linked against
787     OpenSSL.
788
789  9. The transport_filter_timeout option now applies to SMTP transports too.
790
791
792 Version 4.69
793 ------------
794
795  1. Preliminary DKIM support in Experimental.
796
797
798 Version 4.68
799 ------------
800
801  1. The body_linecount and body_zerocount C variables are now exported in the
802     local_scan API.
803
804  2. When a dnslists lookup succeeds, the key that was looked up is now placed
805     in $dnslist_matched. When the key is an IP address, it is not reversed in
806     this variable (though it is, of course, in the actual lookup). In simple
807     cases, for example:
808
809       deny dnslists = spamhaus.example
810
811     the key is also available in another variable (in this case,
812     $sender_host_address). In more complicated cases, however, this is not
813     true. For example, using a data lookup might generate a dnslists lookup
814     like this:
815
816       deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
817
818     If this condition succeeds, the value in $dnslist_matched might be
819     192.168.6.7 (for example).
820
821  3. Authenticators now have a client_condition option. When Exim is running as
822     a client, it skips an authenticator whose client_condition expansion yields
823     "0", "no", or "false". This can be used, for example, to skip plain text
824     authenticators when the connection is not encrypted by a setting such as:
825
826       client_condition = ${if !eq{$tls_cipher}{}}
827
828     Note that the 4.67 documentation states that $tls_cipher contains the
829     cipher used for incoming messages. In fact, during SMTP delivery, it
830     contains the cipher used for the delivery. The same is true for
831     $tls_peerdn.
832
833  4. There is now a -Mvc <message-id> option, which outputs a copy of the
834     message to the standard output, in RFC 2822 format. The option can be used
835     only by an admin user.
836
837  5. There is now a /noupdate option for the ratelimit ACL condition. It
838     computes the rate and checks the limit as normal, but it does not update
839     the saved data. This means that, in relevant ACLs, it is possible to lookup
840     the existence of a specified (or auto-generated) ratelimit key without
841     incrementing the ratelimit counter for that key.
842
843     In order for this to be useful, another ACL entry must set the rate
844     for the same key somewhere (otherwise it will always be zero).
845
846     Example:
847
848     acl_check_connect:
849       # Read the rate; if it doesn't exist or is below the maximum
850       # we update it below
851       deny ratelimit = 100 / 5m / strict / noupdate
852            log_message = RATE: $sender_rate / $sender_rate_period \
853                          (max $sender_rate_limit)
854
855       [... some other logic and tests...]
856
857       warn ratelimit = 100 / 5m / strict / per_cmd
858            log_message = RATE UPDATE: $sender_rate / $sender_rate_period \
859                          (max $sender_rate_limit)
860            condition = ${if le{$sender_rate}{$sender_rate_limit}}
861
862       accept
863
864  6. The variable $max_received_linelength contains the number of bytes in the
865     longest line that was received as part of the message, not counting the
866     line termination character(s).
867
868  7. Host lists can now include +ignore_defer and +include_defer, analagous to
869     +ignore_unknown and +include_unknown. These options should be used with
870     care, probably only in non-critical host lists such as whitelists.
871
872  8. There's a new option called queue_only_load_latch, which defaults true.
873     If set false when queue_only_load is greater than zero, Exim re-evaluates
874     the load for each incoming message in an SMTP session. Otherwise, once one
875     message is queued, the remainder are also.
876
877  9. There is a new ACL, specified by acl_smtp_notquit, which is run in most
878     cases when an SMTP session ends without sending QUIT. However, when Exim
879     itself is is bad trouble, such as being unable to write to its log files,
880     this ACL is not run, because it might try to do things (such as write to
881     log files) that make the situation even worse.
882
883     Like the QUIT ACL, this new ACL is provided to make it possible to gather
884     statistics. Whatever it returns (accept or deny) is immaterial. The "delay"
885     modifier is forbidden in this ACL.
886
887     When the NOTQUIT ACL is running, the variable $smtp_notquit_reason is set
888     to a string that indicates the reason for the termination of the SMTP
889     connection. The possible values are:
890
891       acl-drop                 Another ACL issued a "drop" command
892       bad-commands             Too many unknown or non-mail commands
893       command-timeout          Timeout while reading SMTP commands
894       connection-lost          The SMTP connection has been lost
895       data-timeout             Timeout while reading message data
896       local-scan-error         The local_scan() function crashed
897       local-scan-timeout       The local_scan() function timed out
898       signal-exit              SIGTERM or SIGINT
899       synchronization-error    SMTP synchronization error
900       tls-failed               TLS failed to start
901
902     In most cases when an SMTP connection is closed without having received
903     QUIT, Exim sends an SMTP response message before actually closing the
904     connection. With the exception of acl-drop, the default message can be
905     overridden by the "message" modifier in the NOTQUIT ACL. In the case of a
906     "drop" verb in another ACL, it is the message from the other ACL that is
907     used.
908
909 10. For MySQL and PostgreSQL lookups, it is now possible to specify a list of
910     servers with individual queries. This is done by starting the query with
911     "servers=x:y:z;", where each item in the list may take one of two forms:
912
913     (1) If it is just a host name, the appropriate global option (mysql_servers
914         or pgsql_servers) is searched for a host of the same name, and the
915         remaining parameters (database, user, password) are taken from there.
916
917     (2) If it contains any slashes, it is taken as a complete parameter set.
918
919     The list of servers is used in exactly the same was as the global list.
920     Once a connection to a server has happened and a query has been
921     successfully executed, processing of the lookup ceases.
922
923     This feature is intended for use in master/slave situations where updates
924     are occurring, and one wants to update a master rather than a slave. If the
925     masters are in the list for reading, you might have:
926
927       mysql_servers = slave1/db/name/pw:slave2/db/name/pw:master/db/name/pw
928
929     In an updating lookup, you could then write
930
931       ${lookup mysql{servers=master; UPDATE ...}
932
933     If, on the other hand, the master is not to be used for reading lookups:
934
935       pgsql_servers = slave1/db/name/pw:slave2/db/name/pw
936
937     you can still update the master by
938
939       ${lookup pgsql{servers=master/db/name/pw; UPDATE ...}
940
941 11. The message_body_newlines option (default FALSE, for backwards
942     compatibility) can be used to control whether newlines are present in
943     $message_body and $message_body_end. If it is FALSE, they are replaced by
944     spaces.
945
946
947 Version 4.67
948 ------------
949
950  1. There is a new log selector called smtp_no_mail, which is not included in
951     the default setting. When it is set, a line is written to the main log
952     whenever an accepted SMTP connection terminates without having issued a
953     MAIL command.
954
955  2. When an item in a dnslists list is followed by = and & and a list of IP
956     addresses, the behaviour was not clear when the lookup returned more than
957     one IP address. This has been solved by the addition of == and =& for "all"
958     rather than the default "any" matching.
959
960  3. Up till now, the only control over which cipher suites GnuTLS uses has been
961     for the cipher algorithms. New options have been added to allow some of the
962     other parameters to be varied.
963
964  4. There is a new compile-time option called ENABLE_DISABLE_FSYNC. When it is
965     set, Exim compiles a runtime option called disable_fsync.
966
967  5. There is a new variable called $smtp_count_at_connection_start.
968
969  6. There's a new control called no_pipelining.
970
971  7. There are two new variables called $sending_ip_address and $sending_port.
972     These are set whenever an SMTP connection to another host has been set up.
973
974  8. The expansion of the helo_data option in the smtp transport now happens
975     after the connection to the server has been made.
976
977  9. There is a new expansion operator ${rfc2047d: that decodes strings that
978     are encoded as per RFC 2047.
979
980 10. There is a new log selector called "pid", which causes the current process
981     id to be added to every log line, in square brackets, immediately after the
982     time and date.
983
984 11. Exim has been modified so that it flushes SMTP output before implementing
985     a delay in an ACL. It also flushes the output before performing a callout,
986     as this can take a substantial time. These behaviours can be disabled by
987     obeying control = no_delay_flush or control = no_callout_flush,
988     respectively, at some earlier stage of the connection.
989
990 12. There are two new expansion conditions that iterate over a list. They are
991     called forany and forall.
992
993 13. There's a new global option called dsn_from that can be used to vary the
994     contents of From: lines in bounces and other automatically generated
995     messages ("delivery status notifications" - hence the name of the option).
996
997 14. The smtp transport has a new option called hosts_avoid_pipelining.
998
999 15. By default, exigrep does case-insensitive matches. There is now a -I option
1000     that makes it case-sensitive.
1001
1002 16. A number of new features ("addresses", "map", "filter", and "reduce") have
1003     been added to string expansions to make it easier to process lists of
1004     items, typically addresses.
1005
1006 17. There's a new ACL modifier called "continue". It does nothing of itself,
1007     and processing of the ACL always continues with the next condition or
1008     modifier. It is provided so that the side effects of expanding its argument
1009     can be used.
1010
1011 18. It is now possible to use newline and other control characters (those with
1012     values less than 32, plus DEL) as separators in lists.
1013
1014 19. The exigrep utility now has a -v option, which inverts the matching
1015     condition.
1016
1017 20. The host_find_failed option in the manualroute router can now be set to
1018     "ignore".
1019
1020
1021 Version 4.66
1022 ------------
1023
1024 No new features were added to 4.66.
1025
1026
1027 Version 4.65
1028 ------------
1029
1030 No new features were added to 4.65.
1031
1032
1033 Version 4.64
1034 ------------
1035
1036  1. ACL variables can now be given arbitrary names, as long as they start with
1037     "acl_c" or "acl_m" (for connection variables and message variables), are at
1038     least six characters long, with the sixth character being either a digit or
1039     an underscore.
1040
1041  2. There is a new ACL modifier called log_reject_target. It makes it possible
1042     to specify which logs are used for messages about ACL rejections.
1043
1044  3. There is a new authenticator called "dovecot". This is an interface to the
1045     authentication facility of the Dovecot POP/IMAP server, which can support a
1046     number of authentication methods.
1047
1048  4. The variable $message_headers_raw provides a concatenation of all the
1049     messages's headers without any decoding. This is in contrast to
1050     $message_headers, which does RFC2047 decoding on the header contents.
1051
1052  5. In a DNS black list, if two domain names, comma-separated, are given, the
1053     second is used first to do an initial check, making use of any IP value
1054     restrictions that are set. If there is a match, the first domain is used,
1055     without any IP value restrictions, to get the TXT record.
1056
1057  6. All authenticators now have a server_condition option.
1058
1059  7. There is a new command-line option called -Mset. It is useful only in
1060     conjunction with -be (that is, when testing string expansions). It must be
1061     followed by a message id; Exim loads the given message from its spool
1062     before doing the expansions.
1063
1064  8. Another similar new command-line option is called -bem. It operates like
1065     -be except that it must be followed by the name of a file that contains a
1066     message.
1067
1068  9. When an address is delayed because of a 4xx response to a RCPT command, it
1069     is now the combination of sender and recipient that is delayed in
1070     subsequent queue runs until its retry time is reached.
1071
1072 10. Unary negation and the bitwise logical operators and, or, xor, not, and
1073     shift, have been added to the eval: and eval10: expansion items.
1074
1075 11. The variables $interface_address and $interface_port have been renamed
1076     as $received_ip_address and $received_port, to make it clear that they
1077     relate to message reception rather than delivery. (The old names remain
1078     available for compatibility.)
1079
1080 12. The "message" modifier can now be used on "accept" and "discard" acl verbs
1081     to vary the message that is sent when an SMTP command is accepted.
1082
1083
1084 Version 4.63
1085 ------------
1086
1087 1. There is a new Boolean option called filter_prepend_home for the redirect
1088    router.
1089
1090 2. There is a new acl, set by acl_not_smtp_start, which is run right at the
1091    start of receiving a non-SMTP message, before any of the message has been
1092    read.
1093
1094 3. When an SMTP error message is specified in a "message" modifier in an ACL,
1095    or in a :fail: or :defer: message in a redirect router, Exim now checks the
1096    start of the message for an SMTP error code.
1097
1098 4. There is a new parameter for LDAP lookups called "referrals", which takes
1099    one of the settings "follow" (the default) or "nofollow".
1100
1101 5. Version 20070721.2 of exipick now included, offering these new options:
1102     --reverse
1103         After all other sorting options have bee processed, reverse order
1104         before displaying messages (-R is synonym).
1105     --random
1106         Randomize order of matching messages before displaying.
1107     --size
1108         Instead of displaying the matching messages, display the sum
1109         of their sizes.
1110     --sort <variable>[,<variable>...]
1111         Before displaying matching messages, sort the messages according to
1112         each messages value for each variable.
1113     --not
1114         Negate the value for every test (returns inverse output from the
1115         same criteria without --not).
1116
1117
1118 Version 4.62
1119 ------------
1120
1121 1. The ${readsocket expansion item now supports Internet domain sockets as well
1122    as Unix domain sockets. If the first argument begins "inet:", it must be of
1123    the form "inet:host:port". The port is mandatory; it may be a number or the
1124    name of a TCP port in /etc/services. The host may be a name, or it may be an
1125    IP address. An ip address may optionally be enclosed in square brackets.
1126    This is best for IPv6 addresses. For example:
1127
1128      ${readsocket{inet:[::1]:1234}{<request data>}...
1129
1130    Only a single host name may be given, but if looking it up yield more than
1131    one IP address, they are each tried in turn until a connection is made. Once
1132    a connection has been made, the behaviour is as for ${readsocket with a Unix
1133    domain socket.
1134
1135 2. If a redirect router sets up file or pipe deliveries for more than one
1136    incoming address, and the relevant transport has batch_max set greater than
1137    one, a batch delivery now occurs.
1138
1139 3. The appendfile transport has a new option called maildirfolder_create_regex.
1140    Its value is a regular expression. For a maildir delivery, this is matched
1141    against the maildir directory; if it matches, Exim ensures that a
1142    maildirfolder file is created alongside the new, cur, and tmp directories.
1143
1144
1145 Version 4.61
1146 ------------
1147
1148 The documentation is up-to-date for the 4.61 release. Major new features since
1149 the 4.60 release are:
1150
1151 . An option called disable_ipv6, to disable the use of IPv6 completely.
1152
1153 . An increase in the number of ACL variables to 20 of each type.
1154
1155 . A change to use $auth1, $auth2, and $auth3 in authenticators instead of $1,
1156   $2, $3, (though those are still set) because the numeric variables get used
1157   for other things in complicated expansions.
1158
1159 . The default for rfc1413_query_timeout has been changed from 30s to 5s.
1160
1161 . It is possible to use setclassresources() on some BSD OS to control the
1162   resources used in pipe deliveries.
1163
1164 . A new ACL modifier called add_header, which can be used with any verb.
1165
1166 . More errors are detectable in retry rules.
1167
1168 There are a number of other additions too.
1169
1170
1171 Version 4.60
1172 ------------
1173
1174 The documentation is up-to-date for the 4.60 release. Major new features since
1175 the 4.50 release are:
1176
1177 . Support for SQLite.
1178
1179 . Support for IGNOREQUOTA in LMTP.
1180
1181 . Extensions to the "submission mode" features.
1182
1183 . Support for Client SMTP Authorization (CSA).
1184
1185 . Support for ratelimiting hosts and users.
1186
1187 . New expansion items to help with the BATV "prvs" scheme.
1188
1189 . A "match_ip" condition, that matches an IP address against a list.
1190
1191 There are many more minor changes.
1192
1193 ****