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