Merge branch 'master' of git://git.exim.org/exim
[users/heiko/exim.git] / src / README.UPDATING
1 This document contains detailed information about incompatibilities that might
2 be encountered when upgrading from one release of Exim to another. The
3 information is in reverse order of release numbers. Mostly these are relatively
4 small points, and the configuration file is normally upwards compatible, but
5 there have been two big upheavals...
6
7
8 **************************************************************************
9 * There was a big reworking of the way mail routing works for release    *
10 * 4.00. Previously used "directors" were abolished, and all routing is   *
11 * now done by routers. Policy controls for incoming mail are now done by *
12 * Access Control Lists instead of separate options. All this means that  *
13 * pre-4.00 configuration files have to be massively converted. If you    *
14 * are coming from a 3.xx release, please read the document in the file   *
15 * doc/Exim4.upgrade, and allow some time to complete the upgrade.        *
16 *                                                                        *
17 * There was a big reworking of the way domain/host/net/address lists are *
18 * handled at release 3.00. If you are coming from a pre-3.00 release, it *
19 * might be easier to start again from a default configuration. Otherwise *
20 * you need to read doc/Exim3.upgrade and do a double conversion of your  *
21 * configuration file.                                                    *
22 **************************************************************************
23
24
25 The rest of this document contains information about changes in 4.xx releases
26 that might affect a running system.
27
28
29 Exim version 4.81
30 -----------------
31
32  * New option gnutls_enable_pkcs11 defaults false; if you have GnuTLS 2.12.0
33    or later and do want PKCS11 modules to be autoloaded, then set this option.
34
35
36 Exim version 4.80
37 -----------------
38
39  * BEWARE backwards-incompatible changes in SSL libraries, thus the version
40    bump.  See points below for details.
41    Also an LDAP data returned format change.
42
43  * The value of $tls_peerdn is now print-escaped when written to the spool file
44    in a -tls_peerdn line, and unescaped when read back in.  We received reports
45    of values with embedded newlines, which caused spool file corruption.
46
47    If you have a corrupt spool file and you wish to recover the contents after
48    upgrading, then lock the message, replace the new-lines that should be part
49    of the -tls_peerdn line with the two-character sequence \n and then unlock
50    the message.  No tool has been provided as we believe this is a rare
51    occurence.
52
53  * For OpenSSL, SSLv2 is now disabled by default.  (GnuTLS does not support
54    SSLv2).  RFC 6176 prohibits SSLv2 and some informal surveys suggest no
55    actual usage.  You can re-enable with the "openssl_options" Exim option,
56    in the main configuration section.  Note that supporting SSLv2 exposes
57    you to ciphersuite downgrade attacks.
58
59  * With OpenSSL 1.0.1+, Exim now supports TLS 1.1 and TLS 1.2.  If built
60    against 1.0.1a then you will get a warning message and the
61    "openssl_options" value will not parse "no_tlsv1_1": the value changes
62    incompatibly between 1.0.1a and 1.0.1b, because the value chosen for 1.0.1a
63    is infelicitous.  We advise avoiding 1.0.1a.
64
65    "openssl_options" gains "no_tlsv1_1", "no_tlsv1_2" and "no_compression".
66
67    COMPATIBILITY WARNING: The default value of "openssl_options" is no longer
68    "+dont_insert_empty_fragments".  We default to "+no_sslv2".
69    That old default was grandfathered in from before openssl_options became a
70    configuration option.
71    Empty fragments are inserted by default through TLS1.0, to partially defend
72    against certain attacks; TLS1.1+ change the protocol so that this is not
73    needed.  The DIEF SSL option was required for some old releases of mail
74    clients which did not gracefully handle the empty fragments, and was
75    initially set in Exim release 4.31 (see ChangeLog, item 37).
76
77    If you still have affected mail-clients, and you see SSL protocol failures
78    with this release of Exim, set:
79      openssl_options = +dont_insert_empty_fragments
80    in the main section of your Exim configuration file.  You're trading off
81    security for compatibility.  Exim is now defaulting to higher security and
82    rewarding more modern clients.
83
84    If the option tls_dhparams is set and the parameters loaded from the file
85    have a bit-count greater than the new option tls_dh_max_bits, then the file
86    will now be ignored.  If this affects you, raise the tls_dh_max_bits limit.
87    We suspect that most folks are using dated defaults and will not be affected.
88
89  * Ldap lookups returning multi-valued attributes now separate the attributes
90    with only a comma, not a comma-space sequence.  Also, an actual comma within
91    a returned attribute is doubled.  This makes it possible to parse the
92    attribute as a comma-separated list.  Note the distinction from multiple
93    attributes being returned, where each one is a name=value pair.
94
95    If you are currently splitting the results from LDAP upon a comma, then you
96    should check carefully to see if adjustments are needed.
97
98    This change lets cautious folks distinguish "comma used as separator for
99    joining values" from "comma inside the data".
100
101  * accept_8bitmime now defaults on, which is not RFC compliant but is better
102    suited to today's Internet.  See http://cr.yp.to/smtp/8bitmime.html for a
103    sane rationale.  Those who wish to be strictly RFC compliant, or know that
104    they need to talk to servers that are not 8-bit-clean, now need to take
105    explicit configuration action to default this option off.  This is not a
106    new option, you can safely force it off before upgrading, to decouple
107    configuration changes from the binary upgrade while remaining RFC compliant.
108
109  * The GnuTLS support has been mostly rewritten, to use APIs which don't cause
110    deprecation warnings in GnuTLS 2.12.x.  As part of this, these three options
111    are no longer supported:
112
113      gnutls_require_kx
114      gnutls_require_mac
115      gnutls_require_protocols
116
117    Their functionality is entirely subsumed into tls_require_ciphers.  In turn,
118    tls_require_ciphers is no longer an Exim list and is not parsed by Exim, but
119    is instead given to gnutls_priority_init(3), which expects a priority string;
120    this behaviour is much closer to the OpenSSL behaviour.  See:
121
122      http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html
123
124    for fuller documentation of the strings parsed.  The three gnutls_require_*
125    options are still parsed by Exim and, for this release, silently ignored.
126    A future release will add warnings, before a later still release removes
127    parsing entirely and the presence of the options will be a configuration
128    error.
129
130    Note that by default, GnuTLS will not accept RSA-MD5 signatures in chains.
131    A tls_require_ciphers value of NORMAL:%VERIFY_ALLOW_SIGN_RSA_MD5 may
132    re-enable support, but this is not supported by the Exim maintainers.
133    Our test suite no longer includes MD5-based certificates.
134
135    This rewrite means that Exim will continue to build against GnuTLS in the
136    future, brings Exim closer to other GnuTLS applications and lets us add
137    support for SNI and other features more readily.  We regret that it wasn't
138    feasible to retain the three dropped options.
139
140  * If built with TLS support, then Exim will now validate the value of
141    the main section tls_require_ciphers option at start-up.  Before, this
142    would cause a STARTTLS 4xx failure, now it causes a failure to start.
143    Running with a broken configuration which causes failures that may only
144    be left in the logs has been traded off for something more visible.  This
145    change makes an existing problem more prominent, but we do not believe
146    anyone would deliberately be running with an invalid tls_require_ciphers
147    option.
148
149    This also means that library linkage issues caused by conflicts of some
150    kind might take out the main daemon, not just the delivery or receiving
151    process.  Conceivably some folks might prefer to continue delivering
152    mail plaintext when their binary is broken in this way, if there is a
153    server that is a candidate to receive such mails that does not advertise
154    STARTTLS.  Note that Exim is typically a setuid root binary and given
155    broken linkage problems that cause segfaults, we feel it is safer to
156    fail completely.  (The check is not done as root, to ensure that problems
157    here are not made worse by the check).
158
159  * The "tls_dhparam" option has been updated, so that it can now specify a
160    path or an identifier for a standard DH prime from one of a few RFCs.
161    The default for OpenSSL is no longer to not use DH but instead to use
162    one of these standard primes.  The default for GnuTLS is no longer to use
163    a file in the spool directory, but to use that same standard prime.
164    The option is now used by GnuTLS too.  If it points to a path, then
165    GnuTLS will use that path, instead of a file in the spool directory;
166    GnuTLS will attempt to create it if it does not exist.
167
168    To preserve the previous behaviour of generating files in the spool
169    directory, set "tls_dhparam = historic".  Since prior releases of Exim
170    ignored tls_dhparam when using GnuTLS, this can safely be done before
171    the upgrade.
172
173
174
175 Exim version 4.77
176 -----------------
177
178  * GnuTLS will now attempt to use TLS 1.2 and TLS 1.1 before TLS 1.0 and SSL3,
179    if supported by your GnuTLS library.  Use the existing
180    "gnutls_require_protocols" option to downgrade this if that will be a
181    problem.  Prior to this release, supported values were "TLS1" and "SSL3",
182    so you should be able to update configuration prior to update.
183
184     [nb: gnutls_require_protocols removed in Exim 4.80, instead use
185          tls_require_ciphers to provide a priority string; see notes above]
186
187  * The match_<type>{string1}{string2} expansion conditions no longer subject
188    string2 to string expansion, unless Exim was built with the new
189    "EXPAND_LISTMATCH_RHS" option.  Too many people have inadvertently created
190    insecure configurations that way.  If you need the functionality and turn on
191    that build option, please let the developers know, and know why, so we can
192    try to provide a safer mechanism for you.
193
194    The match{}{} expansion condition (for regular expressions) is NOT affected.
195    For match_<type>{s1}{s2}, all list functionality is unchanged.  The only
196    change is that a '$' appearing in s2 will not trigger expansion, but instead
197    will be treated as a literal $ sign; the effect is very similar to having
198    wrapped s2 with \N...\N.  If s2 contains a named list and the list definition
199    uses $expansions then those _will_ be processed as normal.  It is only the
200    point at which s2 is read where expansion is inhibited.
201
202    If you are trying to test if two email addresses are equal, use eqi{s1}{s2}.
203    If you are testing if the address in s1 occurs in the list of items given
204    in s2, either use the new inlisti{s1}{s2} condition (added in 4.77) or use
205    the pre-existing forany{s2}{eqi{$item}{s1}} condition.
206
207
208 Exim version 4.74
209 -----------------
210
211  * The integrated support for dynamically loadable lookup modules has an ABI
212    change from the modules supported by some OS vendors through an unofficial
213    patch. Don't try to mix & match.
214
215  * Some parts of the build system are now beginning to assume that the host
216    environment is POSIX. If you're building on a system where POSIX tools are
217    not the default, you might have an easier time if you switch to the POSIX
218    tools.  Feel free to report non-POSIX issues as a request for a feature
219    enhancement, but if the POSIX variants are available then the fix will
220    probably just involve some coercion.  See the README instructions for
221    building on such hosts.
222
223
224 Exim version 4.73
225 -----------------
226
227  * The Exim run-time user can no longer be root; this was always
228    strongly discouraged, but is now prohibited both at build and
229    run-time.  If you need Exim to run routinely as root, you'll need to
230    patch the source and accept the risk.  Here be dragons.
231
232  * Exim will no longer accept a configuration file owned by the Exim
233    run-time user, unless that account is explicitly the value in
234    CONFIGURE_OWNER, which we discourage.  Exim now checks to ensure that
235    files are not writeable by other accounts.
236
237  * The ALT_CONFIG_ROOT_ONLY build option is no longer optional and is forced
238    on; the Exim user can, by default, no longer use -C/-D and retain privilege.
239    Two new build options mitigate this.
240
241     * TRUSTED_CONFIG_LIST defines a file containing a whitelist of config
242       files that are trusted to be selected by the Exim user; one per line.
243       This is the recommended approach going forward.
244
245     * WHITELIST_D_MACROS defines a colon-separated list of macro names which
246       the Exim run-time user may safely pass without dropping privileges.
247       Because changes to this involve a recompile, this is not the recommended
248       approach but may ease transition.  The values of the macros, when
249       overridden, are constrained to match this regex: ^[A-Za-z0-9_/.-]*$
250
251  * The system_filter_user option now defaults to the Exim run-time user,
252    rather than root.  You can still set it explicitly to root and this
253    can be done with prior versions too, letting you roll versions
254    without needing to change this configuration option.
255
256  * ClamAV must be at least version 0.95 unless WITH_OLD_CLAMAV_STREAM is
257    defined at build time.
258
259
260 Exim version 4.70
261 -----------------
262
263 1. Experimental Yahoo! Domainkeys support has been dropped in this release.
264 It has been superceded by a native implementation of its successor DKIM.
265
266 2. Up to version 4.69, Exim came with an embedded version of the PCRE library.
267 As of 4.70, this is no longer the case. To compile Exim, you will need PCRE
268 installed. Most OS distributions have ready-made library and development
269 packages.
270
271
272 Exim version 4.68
273 -----------------
274
275 1. The internal implementation of the database keys that are used for ACL
276 ratelimiting has been tidied up. This means that an update to 4.68 might cause
277 Exim to "forget" previous rates that it had calculated, and reset them to zero.
278
279
280 Exim version 4.64
281 -----------------
282
283 1. Callouts were setting the name used for EHLO/HELO from $smtp_active_
284 hostname. This is wrong, because it relates to the incoming message (and
285 probably the interface on which it is arriving) and not to the outgoing
286 callout (which could be using a different interface). This has been
287 changed to use the value of the helo_data option from the smtp transport
288 instead - this is what is used when a message is actually being sent. If
289 there is no remote transport (possible with a router that sets up host
290 addresses), $smtp_active_hostname is used. This change is mentioned here in
291 case somebody is relying on the use of $smtp_active_hostname.
292
293 2. A bug has been fixed that might just possibly be something that is relied on
294 in some configurations. In expansion items such as ${if >{xxx}{yyy}...} an
295 empty string (that is {}) was being interpreted as if it was {0} and therefore
296 treated as the number zero. From release 4.64, such strings cause an error
297 because a decimal number, possibly followed by K or M, is required (as has
298 always been documented).
299
300 3. There has been a change to the GnuTLS support (ChangeLog/PH/20) to improve
301 Exim's performance. Unfortunately, this has the side effect of being slightly
302 non-upwards compatible for versions 4.50 and earlier. If you are upgrading from
303 one of these earlier versions and you use GnuTLS, you must remove the file
304 called gnutls-params in Exim's spool directory. If you don't do this, you will
305 see this error:
306
307   TLS error on connection from ... (DH params import): Base64 decoding error.
308
309 Removing the file causes Exim to recompute the relevant encryption parameters
310 and cache them in the new format that was introduced for release 4.51 (May
311 2005). If you are upgrading from release 4.51 or later, there should be no
312 problem.
313
314
315 Exim version 4.63
316 -----------------
317
318 When an SMTP error message is specified in a "message" modifier in an ACL, or
319 in a :fail: or :defer: message in a redirect router, Exim now checks the start
320 of the message for an SMTP error code. This consists of three digits followed
321 by a space, optionally followed by an extended code of the form n.n.n, also
322 followed by a space. If this is the case and the very first digit is the same
323 as the default error code, the code from the message is used instead. If the
324 very first digit is incorrect, a panic error is logged, and the default code is
325 used. This is an incompatible change, but it is not expected to affect many (if
326 any) configurations. It is possible to suppress the use of the supplied code in
327 a redirect router by setting the smtp_error_code option false. In this case,
328 any SMTP code is quietly ignored.
329
330
331 Exim version 4.61
332 -----------------
333
334 1. The default number of ACL variables of each type has been increased to 20,
335 and it's possible to compile Exim with more. You can safely upgrade to this
336 release if you already have messages on the queue with saved ACL variable
337 values. However, if you downgrade from this release with messages on the queue,
338 any saved ACL values they may have will be lost.
339
340 2. The default value for rfc1413_query_timeout has been changed from 30s to 5s.
341
342
343 Exim version 4.54
344 -----------------
345
346 There was a problem with 4.52/TF/02 in that a "name=" option on control=
347 submission terminated at the next slash, thereby not allowing for slashes in
348 the name. This has been changed so that "name=" takes the rest of the string as
349 its data. It must therefore be the last option.
350
351
352 Version 4.53
353 ------------
354
355 If you are using the experimental Domain Keys support, you must upgrade to
356 at least libdomainkeys 0.67 in order to run this release of Exim.
357
358
359 Version 4.51
360 ------------
361
362 1. The format in which GnuTLS parameters are cached (in the file gnutls-params
363 in the spool directory) has been changed. The new format can also be generated
364 externally, so it is now possible to update the values from outside Exim. This
365 has been implemented in an upwards, BUT NOT downwards, compatible manner.
366 Upgrading should be seamless: when Exim finds that it cannot understand an
367 existing cache file, it generates new parameters and writes them to the cache
368 in the new format. If, however, you downgrade from 4.51 to a previous release,
369 you MUST delete the gnutls-params file in the spool directory, because the
370 older Exim will not recognize the new format.
371
372 2. When doing a callout as part of verifying an address, Exim was not paying
373 attention to any local part prefix or suffix that was matched by the router
374 that accepted the address. It now behaves in the same way as it does for
375 delivery: the affixes are removed from the local part unless
376 rcpt_include_affixes is set on the transport. If you have a configuration that
377 uses prefixes or suffixes on addresses that could be used for callouts, and you
378 want the affixes to be retained, you must make sure that rcpt_include_affixes
379 is set on the transport.
380
381 3. Bounce and delay warning messages no longer contain details of delivery
382 errors, except for explicit messages (e.g. generated by :fail:) and SMTP
383 responses from remote hosts.
384
385
386 Version 4.50
387 ------------
388
389 The exicyclog script has been updated to use three-digit numbers in rotated log
390 files if the maximum number to keep is greater than 99. If you are already
391 keeping more than 99, there will be an incompatible change when you upgrade.
392 You will probably want to rename your old log files to the new form before
393 running the new exicyclog.
394
395
396 Version 4.42
397 ------------
398
399 RFC 3848 specifies standard names for the "with" phrase in Received: header
400 lines when AUTH and/or TLS are in use. This is the "received protocol"
401 field. Exim used to use "asmtp" for authenticated SMTP, without any
402 indication (in the protocol name) for TLS use. Now it follows the RFC and
403 uses "esmtpa" if the connection is authenticated, "esmtps" if it is
404 encrypted, and "esmtpsa" if it is both encrypted and authenticated. These names
405 appear in log lines as well as in Received: header lines.
406
407
408 Version 4.34
409 ------------
410
411 Change 4.31/2 gave problems to data ACLs and local_scan() functions that
412 expected to see a Received: header. I have changed to yet another scheme. The
413 Received: header is now generated after the body is received, but before the
414 ACL or local_scan() is called. After they have run, the timestamp in the
415 Received: header is updated.
416
417 Thus, change (a) of 4.31/2 has been reversed, but change (b) is still true,
418 which is lucky, since I decided it was a bug fix.
419
420
421 Version 4.33
422 ------------
423
424 If an expansion in a condition on a "warn" statement fails because a lookup
425 defers, the "warn" statement is abandoned, and the next ACL statement is
426 processed. Previously this caused the whole ACL to be aborted.
427
428
429 Version 4.32
430 ------------
431
432 Change 4.31/2 has been reversed, as it proved contentious. Recipient callout
433 verification now uses <> in the MAIL command by default, as it did before. A
434 new callout option, "use_sender", has been added to request the other
435 behaviour.
436
437
438 Version 4.31
439 ------------
440
441 1. If you compile Exim to use GnuTLS, it now requires the use of release 1.0.0
442    or greater. The interface to the obsolete 0.8.x releases is no longer
443    supported. There is one externally visible change: the format for the
444    display of Distinguished Names now uses commas as a separator rather than a
445    slash. This is to comply with RFC 2253.
446
447 2. When a message is received, the Received: header line is now generated when
448    reception is complete, instead of at the start of reception. For messages
449    that take a long time to come in, this changes the meaning of the timestamp.
450    There are several side-effects of this change:
451
452     (a) If a message is rejected by a DATA or non-SMTP ACL, or by local_scan(),
453         the logged header lines no longer include the local Received: line,
454         because it has not yet been created. If the message is a non-SMTP one,
455         and the error is processed by sending a message to the sender, the copy
456         of the original message that is returned does not have an added
457         Received: line.
458
459     (b) When a filter file is tested using -bf, no additional Received: header
460         is added to the test message. After some thought, I decided that this
461         is a bug fix.
462
463     The contents of $received_for are not affected by this change. This
464     variable still contains the single recipient of a message, copied after
465     addresses have been rewritten, but before local_scan() is run.
466
467 2. Recipient callout verification, like sender verification, was using <> in
468    the MAIL FROM command. This isn't really the right thing, since the actual
469    sender may affect whether the remote host accepts the recipient or not. I
470    have changed it to use the actual sender in the callout; this means that
471    the cache record is now keyed on a recipient/sender pair, not just the
472    recipient address. There doesn't seem to be a real danger of callout loops,
473    since a callout by the remote host to check the sender would use <>.
474
475
476 Version 4.30
477 ------------
478
479 1. I have abolished timeout_DNS as an error that can be detected in retry
480    rules, because it has never worked. Despite the fact that it has been
481    documented since at least release 1.62, there was no code to support it.
482    If you have used it in your retry rules, you will now get a warning message
483    to the log and panic log. It is now treated as plain "timeout".
484
485 2. After discussion on the mailing list, Exim no longer adds From:, Date:, or
486    Message-Id: header lines to messages that do not originate locally, that is,
487    messages that have an associated sending host address.
488
489 3. When looking up a host name from an IP address, Exim now tries the DNS
490    first, and only if that fails does it use gethostbyaddr() (or equivalent).
491    This change was made because on some OS, not all the names are given for
492    addresses with multiple PTR records via the gethostbyaddr() interface. The
493    order of lookup can be changed by setting host_lookup_order.
494
495
496 Version 4.23
497 ------------
498
499 1. The new FIXED_NEVER_USERS build-time option creates a list of "never users"
500    that cannot be overridden. The default in the distributed EDITME is "root".
501    If for some reason you were (against advice) running deliveries as root, you
502    will have to ensure that FIXED_NEVER_USERS is not set in your
503    Local/Makefile.
504
505 2. The ${quote: operator now quotes an empty string, which it did not before.
506
507 3. Version 4.23 saves the contents of the ACL variables with the message, so
508    that they can be used later. If one of these variables contains a newline,
509    there will be a newline character in the spool that will not be interpreted
510    correctely by a previous version of Exim. (Exim ignores keyed spool file
511    items that it doesn't understand - precisely for this kind of problem - but
512    it expects them all to be on one line.)
513
514    So the bottom line is: if you have newlines in your ACL variables, you
515    cannot retreat from 4.23.
516
517
518 Version 4.21
519 ------------
520
521 1. The idea of the "warn" ACL verb is that it adds a header or writes to the
522    log only when "message" or "log_message" are set. However, if one of the
523    conditions was an address verification, or a call to a nested ACL, the
524    messages generated by the underlying test were being passed through. This
525    no longer happens. The underlying message is available in $acl_verify_
526    message for both "message" and "log_message" expansions, so it can be
527    passed through if needed.
528
529 2. The way that the $h_ (and $header_) expansions work has been changed by the
530    addition of RFC 2047 decoding. See the main documentation (the NewStuff file
531    until release 4.30, then the manual) for full details. Briefly, there are
532    now three forms:
533
534      $rh_xxx: and $rheader_xxx: give the original content of the header
535        line(s), with no processing at all.
536
537      $bh_xxx: and $bheader_xxx: remove leading and trailing white space, and
538        then decode base64 or quoted-printable "words" within the header text,
539        but do not do charset translation.
540
541      $h_xxx: and $header_xxx: attempt to translate the $bh_ string to a
542        standard character set.
543
544    If you have previously been using $h_ expansions to access the raw
545    characters, you should change to $rh_ instead.
546
547 3. When Exim creates an RFC 2047 encoded word in a header line, it labels it
548    with the default character set from the headers_charset option instead of
549    always using iso-8859-1.
550
551 4. If TMPDIR is defined in Local/Makefile (default in src/EDITME is
552    TMPDIR="/tmp"), Exim checks for the presence of an environment variable
553    called TMPDIR, and if it finds it is different, it changes its value.
554
555 5. Following a discussion on the list, the rules by which Exim recognises line
556    endings on incoming messages have been changed. The -dropcr and drop_cr
557    options are now no-ops, retained only for backwards compatibility. The
558    following line terminators are recognized: LF CRLF CR. However, special
559    processing applies to CR:
560
561    (i)  The sequence CR . CR does *not* terminate an incoming SMTP message,
562         nor a local message in the state where . is a terminator.
563
564    (ii) If a bare CR is encountered in a header line, an extra space is added
565         after the line terminator so as not to end the header. The reasoning
566         behind this is that bare CRs in header lines are most likely either
567         to be mistakes, or people trying to play silly games.
568
569 6. The code for using daemon_smtp_port, local_interfaces, and the -oX options
570    has been reorganized. It is supposed to be backwards compatible, but it is
571    mentioned here just in case I've screwed up.
572
573
574
575 Version 4.20
576 ------------
577
578 1. I have tidied and re-organized the code that uses alarm() for imposing time
579    limits on various things. It shouldn't affect anything, but if you notice
580    processes getting stuck, it may be that I've broken something.
581
582 2. The "arguments" log selector now also logs the current working directory
583    when Exim is called.
584
585 3. An incompatible change has been made to the appendfile transport. This
586    affects the case when it is used for file deliveries that are set up by
587    .forward and filter files. Previously, any settings of the "file" or
588    "directory" options were ignored. It is hoped that, like the address_file
589    transport in the default configuration, these options were never in fact set
590    on such transports, because they were of no use.
591
592    Now, if either of these options is set, it is used. The path that is passed
593    by the router is in $address_file (this is not new), so it can be used as
594    part of a longer path, or modified in any other way that expansion permits.
595
596    If neither "file" nor "directory" is set, the behaviour is unchanged.
597
598 4. Related to the above: in a filter, if a "save" command specifies a non-
599    absolute path, the value of $home/ is pre-pended. This no longer happens if
600    $home is unset or is set to an empty string.
601
602 5. Multiple file deliveries from a filter or .forward file can never be
603    batched; the value of batch_max on the transport is ignored for file
604    deliveries. I'm assuming that nobody ever actually set batch_max on the
605    address_file transport - it would have had odd effects previously.
606
607 6. DESTDIR is the more common variable that ROOT for use when installing
608    software under a different root filing system. The Exim install script now
609    recognizes DESTDIR first; if it is not set, ROOT is used.
610
611 7. If DESTDIR is set when installing Exim, it no longer prepends its value to
612    the path of the system aliases file that appears in the default
613    configuration (when a default configuration is installed). If an aliases
614    file is actually created, its name *does* use the prefix.
615
616
617 Version 4.14
618 ------------
619
620 1. The default for the maximum number of unknown SMTP commands that Exim will
621 accept before dropping a connection has been reduced from 5 to 3. However, you
622 can now change the value by setting smtp_max_unknown_commands.
623
624 2. The ${quote: operator has been changed so that it turns newline and carriage
625 return characters into \n and \r, respectively.
626
627 3. The file names used for maildir messages now include the microsecond time
628 fraction as well as the time in seconds, to cope with systems where the process
629 id can be re-used within the same second. The format is now
630
631   <time>.H<microsec>P<pid>.<host>
632
633 This should be a compatible change, but is noted here just in case.
634
635 4. The rules for creating message ids have changed, to cope with systems where
636 the process id can be re-used within the same second. The format, however, is
637 unchanged, so this should not cause any problems, except as noted in the next
638 item.
639
640 5. The maximum value for localhost_number has been reduced from 255 to 16, in
641 order to implement the new message id rules. For operating systems that have
642 case-insensitive file systems (Cygwin and Darwin), the limit is 10.
643
644 6. verify = header_syntax was allowing unqualified addresses in all cases. Now
645 it allows them only for locally generated messages and from hosts that match
646 sender_unqualified_hosts or recipient_unqualified_hosts, respectively.
647
648 7. For reasons lost in the mists of time, when a pipe transport was run, the
649 environment variable MESSAGE_ID was set to the message ID preceded by 'E' (the
650 form used in Message-ID: header lines). The 'E' has been removed.
651
652
653 Version 4.11
654 ------------
655
656 1. The handling of lines in the configuration file has changed. Previously,
657 macro expansion was applied to logical lines, after continuations had been
658 joined on. This meant that it could not be used in .include lines, which are
659 handled as physical rather than logical lines. Macro expansion is now done on
660 physical lines rather than logical lines. This means there are two
661 incompatibilities:
662
663   (a) A macro that expands to # to turn a line into a comment now applies only
664       to the physical line where it appears. Previously, it would have caused
665       any following continuations also to be ignored.
666
667   (b) A macro name can no longer be split over the boundary between a line and
668       its continuation. Actually, this is more of a bug fix. :-)
669
670 2. The -D command line option must now all be within one command line item.
671 This makes it possible to use -D to set a macro to the empty string by commands
672 such as
673
674   exim -DABC  ...
675   exim -DABC= ...
676
677 Previously, these items would have moved on to the next item on the command
678 line. To include spaces in a macro definition item, quotes must be used, in
679 which case you can also have spaces after -D and surrounding the equals. For
680 example:
681
682   exim '-D ABC = something' ...
683
684 3. The way that addresses that redirect to themselves are handled has been
685 changed, in order to fix an obscure bug. This should not cause any problems
686 except in the case of wanting to go back from a 4.11 (or later) release to an
687 earlier release. If there are undelivered messages on the spool that contain
688 addresses which redirect to themselves, and the redirected addresses have
689 already been delivered, you might get a duplicate delivery if you revert to an
690 earlier Exim.
691
692 4. The default way of looking up IP addresses for hosts in the manualroute and
693 queryprogram routers has been changed. If "byname" or "bydns" is explicitly
694 specified, there is no change, but if no method is specified, Exim now behaves
695 as follows:
696
697   First, a DNS lookup is done. If this yields anything other than
698   HOST_NOT_FOUND, that result is used. Otherwise, Exim goes on to try a call to
699   getipnodebyname() (or gethostbyname() on older systems) and the result of the
700   lookup is the result of that call.
701
702 This change has been made because it has been discovered that on some systems,
703 if a DNS lookup called via getipnodebyname() times out, HOST_NOT_FOUND is
704 returned instead of TRY_AGAIN. Thus, it is safest to try a DNS lookup directly
705 first, and only if that gives a definite "no such host" to try the local
706 function.
707
708 5. In fixing the minor security problem with pid_file_path, I have removed some
709 backwards-compatible (undocumented) code which was present to ease conversion
710 from Exim 3. In Exim 4, pid_file_path is a literal; in Exim 3 it was allowed to
711 contain "%s", which was replaced by the port number for daemons listening on
712 non-standard ports. In Exim 4, such daemons do not write a pid file. The
713 backwards compatibility feature was to replace "%s" by nothing if it occurred
714 in an Exim 4 setting of pid_file_path. The bug was in this code. I have solved
715 the problem by removing the backwards compatibility feature. Thus, if you still
716 have "%s" somewhere in a setting of pid_file_path, you should remove it.
717
718 6. There has been an extension to lsearch files. The keys in these files may
719 now be quoted in order to allow for whitespace and colons in them. This means
720 that if you were previously using keys that began with a doublequote, you will
721 now have to wrap them with extra quotes and escape the internal quotes. The
722 possibility that anybody is actually doing this seems extremely remote, but it
723 is documented just in case.
724
725
726 Version 4.10
727 ------------
728
729 The build-time parameter EXIWHAT_KILL_ARG has been renamed EXIWHAT_KILL_SIGNAL
730 to better reflect its function. The OS-specific files have been updated. Only
731 if you have explicitly set this in your Makefile (highly unlikely) do you need
732 to change anything.
733
734 ****