LDAP: Check for errors of TLS initialisation
[exim.git] / src / README.UPDATING
1This document contains detailed information about incompatibilities that might
2be encountered when upgrading from one release of Exim to another. The
3information is in reverse order of release numbers. Mostly these are relatively
4small points, and the configuration file is normally upwards compatible, but
5there have been two big upheavals...
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. *
25The rest of this document contains information about changes in 4.xx releases
26that might affect a running system.
2eda48c6 27
e6acf885 28
29Exim version 4.78
32 * The value of $tls_peerdn is now print-escaped when written to the spool file
33 in a -tls_peerdn line, and unescaped when read back in. We received reports
34 of values with embedded newlines, which caused spool file corruption.
36 If you have a corrupt spool file and you wish to recover the contents after
37 upgrading, then lock the message, replace the new-lines that should be part
38 of the -tls_peerdn line with the two-character sequence \n and then unlock
39 the message. No tool has been provided as we believe this is a rare
40 occurence.
42 * With OpenSSL 1.0.1+, Exim now supports TLS 1.1 and TLS 1.2. If built
43 against 1.0.1a then you will get a warning message and the
44 "openssl_options" value will not parse "no_tlsv1_1": the value changes
45 incompatibly between 1.0.1a and 1.0.1b, because the value chosen for 1.0.1a
46 is infelicitous. We advise avoiding 1.0.1a.
48 "openssl_options" gains "no_tlsv1_1", "no_tlsv1_2" and "no_compression".
50 * Ldap lookups returning multi-valued attributes now separate the attributes
51 with only a comma, not a comma-space sequence. Also, an actual comma within
52 a returned attribute is doubled. This makes it possible to parse the
53 attribute as a comma-separated list. Note the distinction from multiple
54 attributes being returned, where each one is a name=value pair.
c80c5570 55
dec5017e 56
57Exim version 4.77
60 * GnuTLS will now attempt to use TLS 1.2 and TLS 1.1 before TLS 1.0 and SSL3,
61 if supported by your GnuTLS library. Use the existing
62 "gnutls_require_protocols" option to downgrade this if that will be a
63 problem. Prior to this release, supported values were "TLS1" and "SSL3",
64 so you should be able to update configuration prior to update.
66 * The match_<type>{string1}{string2} expansion conditions no longer subject
67 string2 to string expansion, unless Exim was built with the new
68 "EXPAND_LISTMATCH_RHS" option. Too many people have inadvertently created
69 insecure configurations that way. If you need the functionality and turn on
70 that build option, please let the developers know, and know why, so we can
71 try to provide a safer mechanism for you.
73 The match{}{} expansion condition (for regular expressions) is NOT affected.
74 For match_<type>{s1}{s2}, all list functionality is unchanged. The only
75 change is that a '$' appearing in s2 will not trigger expansion, but instead
76 will be treated as a literal $ sign; the effect is very similar to having
77 wrapped s2 with \N...\N. If s2 contains a named list and the list definition
78 uses $expansions then those _will_ be processed as normal. It is only the
79 point at which s2 is read where expansion is inhibited.
81 If you are trying to test if two email addresses are equal, use eqi{s1}{s2}.
82 If you are testing if the address in s1 occurs in the list of items given
83 in s2, either use the new inlisti{s1}{s2} condition (added in 4.77) or use
84 the pre-existing forany{s2}{eqi{$item}{s1}} condition.
c566dd90 86
87Exim version 4.74
90 * The integrated support for dynamically loadable lookup modules has an ABI
91 change from the modules supported by some OS vendors through an unofficial
92 patch. Don't try to mix & match.
94 * Some parts of the build system are now beginning to assume that the host
95 environment is POSIX. If you're building on a system where POSIX tools are
96 not the default, you might have an easier time if you switch to the POSIX
97 tools. Feel free to report non-POSIX issues as a request for a feature
98 enhancement, but if the POSIX variants are available then the fix will
99 probably just involve some coercion. See the README instructions for
100 building on such hosts.
103Exim version 4.73
106 * The Exim run-time user can no longer be root; this was always
107 strongly discouraged, but is now prohibited both at build and
108 run-time. If you need Exim to run routinely as root, you'll need to
109 patch the source and accept the risk. Here be dragons.
111 * Exim will no longer accept a configuration file owned by the Exim
112 run-time user, unless that account is explicitly the value in
113 CONFIGURE_OWNER, which we discourage. Exim now checks to ensure that
a7ee5955 114 files are not writeable by other accounts.
116 * The ALT_CONFIG_ROOT_ONLY build option is no longer optional and is forced
117 on; the Exim user can, by default, no longer use -C/-D and retain privilege.
118 Two new build options mitigate this.
120 * TRUSTED_CONFIG_LIST defines a file containing a whitelist of config
121 files that are trusted to be selected by the Exim user; one per line.
122 This is the recommended approach going forward.
124 * WHITELIST_D_MACROS defines a colon-separated list of macro names which
125 the Exim run-time user may safely pass without dropping privileges.
126 Because changes to this involve a recompile, this is not the recommended
127 approach but may ease transition. The values of the macros, when
43236f35 128 overridden, are constrained to match this regex: ^[A-Za-z0-9_/.-]*$
130 * The system_filter_user option now defaults to the Exim run-time user,
131 rather than root. You can still set it explicitly to root and this
132 can be done with prior versions too, letting you roll versions
133 without needing to change this configuration option.
135 * ClamAV must be at least version 0.95 unless WITH_OLD_CLAMAV_STREAM is
136 defined at build time.
139Exim version 4.70
1421. Experimental Yahoo! Domainkeys support has been dropped in this release.
143It has been superceded by a native implementation of its successor DKIM.
1452. Up to version 4.69, Exim came with an embedded version of the PCRE library.
146As of 4.70, this is no longer the case. To compile Exim, you will need PCRE
a7ee5955 147installed. Most OS distributions have ready-made library and development
2eda48c6 148packages.
151Exim version 4.68
1541. The internal implementation of the database keys that are used for ACL
155ratelimiting has been tidied up. This means that an update to 4.68 might cause
156Exim to "forget" previous rates that it had calculated, and reset them to zero.
159Exim version 4.64
1621. Callouts were setting the name used for EHLO/HELO from $smtp_active_
163hostname. This is wrong, because it relates to the incoming message (and
164probably the interface on which it is arriving) and not to the outgoing
165callout (which could be using a different interface). This has been
166changed to use the value of the helo_data option from the smtp transport
167instead - this is what is used when a message is actually being sent. If
168there is no remote transport (possible with a router that sets up host
169addresses), $smtp_active_hostname is used. This change is mentioned here in
170case somebody is relying on the use of $smtp_active_hostname.
1722. A bug has been fixed that might just possibly be something that is relied on
173in some configurations. In expansion items such as ${if >{xxx}{yyy}...} an
174empty string (that is {}) was being interpreted as if it was {0} and therefore
175treated as the number zero. From release 4.64, such strings cause an error
176because a decimal number, possibly followed by K or M, is required (as has
177always been documented).
1793. There has been a change to the GnuTLS support (ChangeLog/PH/20) to improve
180Exim's performance. Unfortunately, this has the side effect of being slightly
181non-upwards compatible for versions 4.50 and earlier. If you are upgrading from
182one of these earlier versions and you use GnuTLS, you must remove the file
183called gnutls-params in Exim's spool directory. If you don't do this, you will
184see this error:
186 TLS error on connection from ... (DH params import): Base64 decoding error.
188Removing the file causes Exim to recompute the relevant encryption parameters
189and cache them in the new format that was introduced for release 4.51 (May
1902005). If you are upgrading from release 4.51 or later, there should be no
26da7e20 193
194Exim version 4.63
197When an SMTP error message is specified in a "message" modifier in an ACL, or
198in a :fail: or :defer: message in a redirect router, Exim now checks the start
199of the message for an SMTP error code. This consists of three digits followed
200by a space, optionally followed by an extended code of the form n.n.n, also
201followed by a space. If this is the case and the very first digit is the same
202as the default error code, the code from the message is used instead. If the
203very first digit is incorrect, a panic error is logged, and the default code is
204used. This is an incompatible change, but it is not expected to affect many (if
205any) configurations. It is possible to suppress the use of the supplied code in
206a redirect router by setting the smtp_error_code option false. In this case,
207any SMTP code is quietly ignored.
210Exim version 4.61
2131. The default number of ACL variables of each type has been increased to 20,
214and it's possible to compile Exim with more. You can safely upgrade to this
215release if you already have messages on the queue with saved ACL variable
216values. However, if you downgrade from this release with messages on the queue,
217any saved ACL values they may have will be lost.
2192. The default value for rfc1413_query_timeout has been changed from 30s to 5s.
222Exim version 4.54
225There was a problem with 4.52/TF/02 in that a "name=" option on control=
226submission terminated at the next slash, thereby not allowing for slashes in
227the name. This has been changed so that "name=" takes the rest of the string as
228its data. It must therefore be the last option.
231Version 4.53
234If you are using the experimental Domain Keys support, you must upgrade to
235at least libdomainkeys 0.67 in order to run this release of Exim.
238Version 4.51
2411. The format in which GnuTLS parameters are cached (in the file gnutls-params
242in the spool directory) has been changed. The new format can also be generated
243externally, so it is now possible to update the values from outside Exim. This
244has been implemented in an upwards, BUT NOT downwards, compatible manner.
245Upgrading should be seamless: when Exim finds that it cannot understand an
246existing cache file, it generates new parameters and writes them to the cache
247in the new format. If, however, you downgrade from 4.51 to a previous release,
248you MUST delete the gnutls-params file in the spool directory, because the
249older Exim will not recognize the new format.
2512. When doing a callout as part of verifying an address, Exim was not paying
252attention to any local part prefix or suffix that was matched by the router
253that accepted the address. It now behaves in the same way as it does for
254delivery: the affixes are removed from the local part unless
255rcpt_include_affixes is set on the transport. If you have a configuration that
256uses prefixes or suffixes on addresses that could be used for callouts, and you
257want the affixes to be retained, you must make sure that rcpt_include_affixes
258is set on the transport.
2603. Bounce and delay warning messages no longer contain details of delivery
261errors, except for explicit messages (e.g. generated by :fail:) and SMTP
262responses from remote hosts.
b5aea5e1 264
265Version 4.50
268The exicyclog script has been updated to use three-digit numbers in rotated log
269files if the maximum number to keep is greater than 99. If you are already
270keeping more than 99, there will be an incompatible change when you upgrade.
271You will probably want to rename your old log files to the new form before
c3af992c 272running the new exicyclog.
275Version 4.42
278RFC 3848 specifies standard names for the "with" phrase in Received: header
279lines when AUTH and/or TLS are in use. This is the "received protocol"
280field. Exim used to use "asmtp" for authenticated SMTP, without any
281indication (in the protocol name) for TLS use. Now it follows the RFC and
282uses "esmtpa" if the connection is authenticated, "esmtps" if it is
283encrypted, and "esmtpsa" if it is both encrypted and authenticated. These names
284appear in log lines as well as in Received: header lines.
287Version 4.34
290Change 4.31/2 gave problems to data ACLs and local_scan() functions that
291expected to see a Received: header. I have changed to yet another scheme. The
292Received: header is now generated after the body is received, but before the
293ACL or local_scan() is called. After they have run, the timestamp in the
294Received: header is updated.
296Thus, change (a) of 4.31/2 has been reversed, but change (b) is still true,
297which is lucky, since I decided it was a bug fix.
300Version 4.33
303If an expansion in a condition on a "warn" statement fails because a lookup
304defers, the "warn" statement is abandoned, and the next ACL statement is
305processed. Previously this caused the whole ACL to be aborted.
308Version 4.32
311Change 4.31/2 has been reversed, as it proved contentious. Recipient callout
312verification now uses <> in the MAIL command by default, as it did before. A
313new callout option, "use_sender", has been added to request the other
317Version 4.31
3201. If you compile Exim to use GnuTLS, it now requires the use of release 1.0.0
321 or greater. The interface to the obsolete 0.8.x releases is no longer
322 supported. There is one externally visible change: the format for the
323 display of Distinguished Names now uses commas as a separator rather than a
324 slash. This is to comply with RFC 2253.
3262. When a message is received, the Received: header line is now generated when
327 reception is complete, instead of at the start of reception. For messages
328 that take a long time to come in, this changes the meaning of the timestamp.
329 There are several side-effects of this change:
331 (a) If a message is rejected by a DATA or non-SMTP ACL, or by local_scan(),
332 the logged header lines no longer include the local Received: line,
333 because it has not yet been created. If the message is a non-SMTP one,
334 and the error is processed by sending a message to the sender, the copy
335 of the original message that is returned does not have an added
336 Received: line.
338 (b) When a filter file is tested using -bf, no additional Received: header
339 is added to the test message. After some thought, I decided that this
340 is a bug fix.
342 The contents of $received_for are not affected by this change. This
343 variable still contains the single recipient of a message, copied after
344 addresses have been rewritten, but before local_scan() is run.
3462. Recipient callout verification, like sender verification, was using <> in
347 the MAIL FROM command. This isn't really the right thing, since the actual
348 sender may affect whether the remote host accepts the recipient or not. I
349 have changed it to use the actual sender in the callout; this means that
350 the cache record is now keyed on a recipient/sender pair, not just the
351 recipient address. There doesn't seem to be a real danger of callout loops,
352 since a callout by the remote host to check the sender would use <>.
355Version 4.30
3581. I have abolished timeout_DNS as an error that can be detected in retry
359 rules, because it has never worked. Despite the fact that it has been
360 documented since at least release 1.62, there was no code to support it.
361 If you have used it in your retry rules, you will now get a warning message
362 to the log and panic log. It is now treated as plain "timeout".
3642. After discussion on the mailing list, Exim no longer adds From:, Date:, or
365 Message-Id: header lines to messages that do not originate locally, that is,
366 messages that have an associated sending host address.
3683. When looking up a host name from an IP address, Exim now tries the DNS
369 first, and only if that fails does it use gethostbyaddr() (or equivalent).
370 This change was made because on some OS, not all the names are given for
371 addresses with multiple PTR records via the gethostbyaddr() interface. The
372 order of lookup can be changed by setting host_lookup_order.
375Version 4.23
3781. The new FIXED_NEVER_USERS build-time option creates a list of "never users"
379 that cannot be overridden. The default in the distributed EDITME is "root".
380 If for some reason you were (against advice) running deliveries as root, you
381 will have to ensure that FIXED_NEVER_USERS is not set in your
382 Local/Makefile.
3842. The ${quote: operator now quotes an empty string, which it did not before.
3863. Version 4.23 saves the contents of the ACL variables with the message, so
387 that they can be used later. If one of these variables contains a newline,
388 there will be a newline character in the spool that will not be interpreted
389 correctely by a previous version of Exim. (Exim ignores keyed spool file
390 items that it doesn't understand - precisely for this kind of problem - but
391 it expects them all to be on one line.)
393 So the bottom line is: if you have newlines in your ACL variables, you
394 cannot retreat from 4.23.
397Version 4.21
4001. The idea of the "warn" ACL verb is that it adds a header or writes to the
401 log only when "message" or "log_message" are set. However, if one of the
402 conditions was an address verification, or a call to a nested ACL, the
403 messages generated by the underlying test were being passed through. This
404 no longer happens. The underlying message is available in $acl_verify_
405 message for both "message" and "log_message" expansions, so it can be
406 passed through if needed.
4082. The way that the $h_ (and $header_) expansions work has been changed by the
409 addition of RFC 2047 decoding. See the main documentation (the NewStuff file
410 until release 4.30, then the manual) for full details. Briefly, there are
411 now three forms:
413 $rh_xxx: and $rheader_xxx: give the original content of the header
414 line(s), with no processing at all.
416 $bh_xxx: and $bheader_xxx: remove leading and trailing white space, and
417 then decode base64 or quoted-printable "words" within the header text,
418 but do not do charset translation.
420 $h_xxx: and $header_xxx: attempt to translate the $bh_ string to a
421 standard character set.
423 If you have previously been using $h_ expansions to access the raw
424 characters, you should change to $rh_ instead.
4263. When Exim creates an RFC 2047 encoded word in a header line, it labels it
427 with the default character set from the headers_charset option instead of
428 always using iso-8859-1.
4304. If TMPDIR is defined in Local/Makefile (default in src/EDITME is
431 TMPDIR="/tmp"), Exim checks for the presence of an environment variable
432 called TMPDIR, and if it finds it is different, it changes its value.
4345. Following a discussion on the list, the rules by which Exim recognises line
435 endings on incoming messages have been changed. The -dropcr and drop_cr
436 options are now no-ops, retained only for backwards compatibility. The
437 following line terminators are recognized: LF CRLF CR. However, special
438 processing applies to CR:
440 (i) The sequence CR . CR does *not* terminate an incoming SMTP message,
441 nor a local message in the state where . is a terminator.
443 (ii) If a bare CR is encountered in a header line, an extra space is added
444 after the line terminator so as not to end the header. The reasoning
445 behind this is that bare CRs in header lines are most likely either
446 to be mistakes, or people trying to play silly games.
4486. The code for using daemon_smtp_port, local_interfaces, and the -oX options
449 has been reorganized. It is supposed to be backwards compatible, but it is
450 mentioned here just in case I've screwed up.
454Version 4.20
4571. I have tidied and re-organized the code that uses alarm() for imposing time
458 limits on various things. It shouldn't affect anything, but if you notice
459 processes getting stuck, it may be that I've broken something.
4612. The "arguments" log selector now also logs the current working directory
462 when Exim is called.
4643. An incompatible change has been made to the appendfile transport. This
465 affects the case when it is used for file deliveries that are set up by
466 .forward and filter files. Previously, any settings of the "file" or
467 "directory" options were ignored. It is hoped that, like the address_file
468 transport in the default configuration, these options were never in fact set
469 on such transports, because they were of no use.
471 Now, if either of these options is set, it is used. The path that is passed
472 by the router is in $address_file (this is not new), so it can be used as
473 part of a longer path, or modified in any other way that expansion permits.
475 If neither "file" nor "directory" is set, the behaviour is unchanged.
4774. Related to the above: in a filter, if a "save" command specifies a non-
478 absolute path, the value of $home/ is pre-pended. This no longer happens if
479 $home is unset or is set to an empty string.
4815. Multiple file deliveries from a filter or .forward file can never be
482 batched; the value of batch_max on the transport is ignored for file
483 deliveries. I'm assuming that nobody ever actually set batch_max on the
484 address_file transport - it would have had odd effects previously.
4866. DESTDIR is the more common variable that ROOT for use when installing
487 software under a different root filing system. The Exim install script now
488 recognizes DESTDIR first; if it is not set, ROOT is used.
4907. If DESTDIR is set when installing Exim, it no longer prepends its value to
491 the path of the system aliases file that appears in the default
492 configuration (when a default configuration is installed). If an aliases
493 file is actually created, its name *does* use the prefix.
496Version 4.14
4991. The default for the maximum number of unknown SMTP commands that Exim will
500accept before dropping a connection has been reduced from 5 to 3. However, you
501can now change the value by setting smtp_max_unknown_commands.
5032. The ${quote: operator has been changed so that it turns newline and carriage
504return characters into \n and \r, respectively.
5063. The file names used for maildir messages now include the microsecond time
507fraction as well as the time in seconds, to cope with systems where the process
508id can be re-used within the same second. The format is now
510 <time>.H<microsec>P<pid>.<host>
512This should be a compatible change, but is noted here just in case.
5144. The rules for creating message ids have changed, to cope with systems where
515the process id can be re-used within the same second. The format, however, is
516unchanged, so this should not cause any problems, except as noted in the next
5195. The maximum value for localhost_number has been reduced from 255 to 16, in
520order to implement the new message id rules. For operating systems that have
521case-insensitive file systems (Cygwin and Darwin), the limit is 10.
5236. verify = header_syntax was allowing unqualified addresses in all cases. Now
524it allows them only for locally generated messages and from hosts that match
525sender_unqualified_hosts or recipient_unqualified_hosts, respectively.
5277. For reasons lost in the mists of time, when a pipe transport was run, the
528environment variable MESSAGE_ID was set to the message ID preceded by 'E' (the
529form used in Message-ID: header lines). The 'E' has been removed.
532Version 4.11
5351. The handling of lines in the configuration file has changed. Previously,
536macro expansion was applied to logical lines, after continuations had been
537joined on. This meant that it could not be used in .include lines, which are
538handled as physical rather than logical lines. Macro expansion is now done on
539physical lines rather than logical lines. This means there are two
542 (a) A macro that expands to # to turn a line into a comment now applies only
543 to the physical line where it appears. Previously, it would have caused
544 any following continuations also to be ignored.
546 (b) A macro name can no longer be split over the boundary between a line and
547 its continuation. Actually, this is more of a bug fix. :-)
5492. The -D command line option must now all be within one command line item.
550This makes it possible to use -D to set a macro to the empty string by commands
551such as
553 exim -DABC ...
554 exim -DABC= ...
556Previously, these items would have moved on to the next item on the command
557line. To include spaces in a macro definition item, quotes must be used, in
558which case you can also have spaces after -D and surrounding the equals. For
561 exim '-D ABC = something' ...
5633. The way that addresses that redirect to themselves are handled has been
564changed, in order to fix an obscure bug. This should not cause any problems
565except in the case of wanting to go back from a 4.11 (or later) release to an
566earlier release. If there are undelivered messages on the spool that contain
567addresses which redirect to themselves, and the redirected addresses have
568already been delivered, you might get a duplicate delivery if you revert to an
569earlier Exim.
5714. The default way of looking up IP addresses for hosts in the manualroute and
572queryprogram routers has been changed. If "byname" or "bydns" is explicitly
573specified, there is no change, but if no method is specified, Exim now behaves
574as follows:
576 First, a DNS lookup is done. If this yields anything other than
577 HOST_NOT_FOUND, that result is used. Otherwise, Exim goes on to try a call to
578 getipnodebyname() (or gethostbyname() on older systems) and the result of the
579 lookup is the result of that call.
581This change has been made because it has been discovered that on some systems,
582if a DNS lookup called via getipnodebyname() times out, HOST_NOT_FOUND is
583returned instead of TRY_AGAIN. Thus, it is safest to try a DNS lookup directly
584first, and only if that gives a definite "no such host" to try the local
5875. In fixing the minor security problem with pid_file_path, I have removed some
588backwards-compatible (undocumented) code which was present to ease conversion
589from Exim 3. In Exim 4, pid_file_path is a literal; in Exim 3 it was allowed to
590contain "%s", which was replaced by the port number for daemons listening on
591non-standard ports. In Exim 4, such daemons do not write a pid file. The
592backwards compatibility feature was to replace "%s" by nothing if it occurred
593in an Exim 4 setting of pid_file_path. The bug was in this code. I have solved
594the problem by removing the backwards compatibility feature. Thus, if you still
595have "%s" somewhere in a setting of pid_file_path, you should remove it.
5976. There has been an extension to lsearch files. The keys in these files may
598now be quoted in order to allow for whitespace and colons in them. This means
599that if you were previously using keys that began with a doublequote, you will
600now have to wrap them with extra quotes and escape the internal quotes. The
601possibility that anybody is actually doing this seems extremely remote, but it
602is documented just in case.
605Version 4.10
608The build-time parameter EXIWHAT_KILL_ARG has been renamed EXIWHAT_KILL_SIGNAL
609to better reflect its function. The OS-specific files have been updated. Only
610if you have explicitly set this in your Makefile (highly unlikely) do you need
611to change anything.