1 $Cambridge: exim/src/README.UPDATING,v 1.17 2009/10/16 07:35:42 tom Exp $
3 This document contains detailed information about incompatibilities that might
4 be encountered when upgrading from one release of Exim to another. The
5 information is in reverse order of release numbers. Mostly these are relatively
6 small points, and the configuration file is normally upwards compatible, but
7 there have been two big upheavals...
10 **************************************************************************
11 * There was a big reworking of the way mail routing works for release *
12 * 4.00. Previously used "directors" were abolished, and all routing is *
13 * now done by routers. Policy controls for incoming mail are now done by *
14 * Access Control Lists instead of separate options. All this means that *
15 * pre-4.00 configuration files have to be massively converted. If you *
16 * are coming from a 3.xx release, please read the document in the file *
17 * doc/Exim4.upgrade, and allow some time to complete the upgrade. *
19 * There was a big reworking of the way domain/host/net/address lists are *
20 * handled at release 3.00. If you are coming from a pre-3.00 release, it *
21 * might be easier to start again from a default configuration. Otherwise *
22 * you need to read doc/Exim3.upgrade and do a double conversion of your *
23 * configuration file. *
24 **************************************************************************
27 The rest of this document contains information about changes in 4.xx releases
28 that might affect a running system.
34 * No incompatible changes within Exim itself, but the integrated support for
35 dynamically loadable lookup modules has an ABI change from the modules
36 supported by some OS vendors through an unofficial patch. Don't try to
43 * The Exim run-time user can no longer be root; this was always
44 strongly discouraged, but is now prohibited both at build and
45 run-time. If you need Exim to run routinely as root, you'll need to
46 patch the source and accept the risk. Here be dragons.
48 * Exim will no longer accept a configuration file owned by the Exim
49 run-time user, unless that account is explicitly the value in
50 CONFIGURE_OWNER, which we discourage. Exim now checks to ensure that
51 files are not writable by other accounts.
53 * The ALT_CONFIG_ROOT_ONLY build option is no longer optional and is forced
54 on; the Exim user can, by default, no longer use -C/-D and retain privilege.
55 Two new build options mitigate this.
57 * TRUSTED_CONFIG_LIST defines a file containing a whitelist of config
58 files that are trusted to be selected by the Exim user; one per line.
59 This is the recommended approach going forward.
61 * WHITELIST_D_MACROS defines a colon-separated list of macro names which
62 the Exim run-time user may safely pass without dropping privileges.
63 Because changes to this involve a recompile, this is not the recommended
64 approach but may ease transition. The values of the macros, when
65 overriden, are constrained to match this regex: ^[A-Za-z0-9_/.-]*$
67 * The system_filter_user option now defaults to the Exim run-time user,
68 rather than root. You can still set it explicitly to root and this
69 can be done with prior versions too, letting you roll versions
70 without needing to change this configuration option.
72 * ClamAV must be at least version 0.95 unless WITH_OLD_CLAMAV_STREAM is
73 defined at build time.
79 1. Experimental Yahoo! Domainkeys support has been dropped in this release.
80 It has been superceded by a native implementation of its successor DKIM.
82 2. Up to version 4.69, Exim came with an embedded version of the PCRE library.
83 As of 4.70, this is no longer the case. To compile Exim, you will need PCRE
84 installed. Most OS distributions have ready-made library and develoment
91 1. The internal implementation of the database keys that are used for ACL
92 ratelimiting has been tidied up. This means that an update to 4.68 might cause
93 Exim to "forget" previous rates that it had calculated, and reset them to zero.
99 1. Callouts were setting the name used for EHLO/HELO from $smtp_active_
100 hostname. This is wrong, because it relates to the incoming message (and
101 probably the interface on which it is arriving) and not to the outgoing
102 callout (which could be using a different interface). This has been
103 changed to use the value of the helo_data option from the smtp transport
104 instead - this is what is used when a message is actually being sent. If
105 there is no remote transport (possible with a router that sets up host
106 addresses), $smtp_active_hostname is used. This change is mentioned here in
107 case somebody is relying on the use of $smtp_active_hostname.
109 2. A bug has been fixed that might just possibly be something that is relied on
110 in some configurations. In expansion items such as ${if >{xxx}{yyy}...} an
111 empty string (that is {}) was being interpreted as if it was {0} and therefore
112 treated as the number zero. From release 4.64, such strings cause an error
113 because a decimal number, possibly followed by K or M, is required (as has
114 always been documented).
116 3. There has been a change to the GnuTLS support (ChangeLog/PH/20) to improve
117 Exim's performance. Unfortunately, this has the side effect of being slightly
118 non-upwards compatible for versions 4.50 and earlier. If you are upgrading from
119 one of these earlier versions and you use GnuTLS, you must remove the file
120 called gnutls-params in Exim's spool directory. If you don't do this, you will
123 TLS error on connection from ... (DH params import): Base64 decoding error.
125 Removing the file causes Exim to recompute the relevant encryption parameters
126 and cache them in the new format that was introduced for release 4.51 (May
127 2005). If you are upgrading from release 4.51 or later, there should be no
134 When an SMTP error message is specified in a "message" modifier in an ACL, or
135 in a :fail: or :defer: message in a redirect router, Exim now checks the start
136 of the message for an SMTP error code. This consists of three digits followed
137 by a space, optionally followed by an extended code of the form n.n.n, also
138 followed by a space. If this is the case and the very first digit is the same
139 as the default error code, the code from the message is used instead. If the
140 very first digit is incorrect, a panic error is logged, and the default code is
141 used. This is an incompatible change, but it is not expected to affect many (if
142 any) configurations. It is possible to suppress the use of the supplied code in
143 a redirect router by setting the smtp_error_code option false. In this case,
144 any SMTP code is quietly ignored.
150 1. The default number of ACL variables of each type has been increased to 20,
151 and it's possible to compile Exim with more. You can safely upgrade to this
152 release if you already have messages on the queue with saved ACL variable
153 values. However, if you downgrade from this release with messages on the queue,
154 any saved ACL values they may have will be lost.
156 2. The default value for rfc1413_query_timeout has been changed from 30s to 5s.
162 There was a problem with 4.52/TF/02 in that a "name=" option on control=
163 submission terminated at the next slash, thereby not allowing for slashes in
164 the name. This has been changed so that "name=" takes the rest of the string as
165 its data. It must therefore be the last option.
171 If you are using the experimental Domain Keys support, you must upgrade to
172 at least libdomainkeys 0.67 in order to run this release of Exim.
178 1. The format in which GnuTLS parameters are cached (in the file gnutls-params
179 in the spool directory) has been changed. The new format can also be generated
180 externally, so it is now possible to update the values from outside Exim. This
181 has been implemented in an upwards, BUT NOT downwards, compatible manner.
182 Upgrading should be seamless: when Exim finds that it cannot understand an
183 existing cache file, it generates new parameters and writes them to the cache
184 in the new format. If, however, you downgrade from 4.51 to a previous release,
185 you MUST delete the gnutls-params file in the spool directory, because the
186 older Exim will not recognize the new format.
188 2. When doing a callout as part of verifying an address, Exim was not paying
189 attention to any local part prefix or suffix that was matched by the router
190 that accepted the address. It now behaves in the same way as it does for
191 delivery: the affixes are removed from the local part unless
192 rcpt_include_affixes is set on the transport. If you have a configuration that
193 uses prefixes or suffixes on addresses that could be used for callouts, and you
194 want the affixes to be retained, you must make sure that rcpt_include_affixes
195 is set on the transport.
197 3. Bounce and delay warning messages no longer contain details of delivery
198 errors, except for explicit messages (e.g. generated by :fail:) and SMTP
199 responses from remote hosts.
205 The exicyclog script has been updated to use three-digit numbers in rotated log
206 files if the maximum number to keep is greater than 99. If you are already
207 keeping more than 99, there will be an incompatible change when you upgrade.
208 You will probably want to rename your old log files to the new form before
209 running the new exicyclog.
215 RFC 3848 specifies standard names for the "with" phrase in Received: header
216 lines when AUTH and/or TLS are in use. This is the "received protocol"
217 field. Exim used to use "asmtp" for authenticated SMTP, without any
218 indication (in the protocol name) for TLS use. Now it follows the RFC and
219 uses "esmtpa" if the connection is authenticated, "esmtps" if it is
220 encrypted, and "esmtpsa" if it is both encrypted and authenticated. These names
221 appear in log lines as well as in Received: header lines.
227 Change 4.31/2 gave problems to data ACLs and local_scan() functions that
228 expected to see a Received: header. I have changed to yet another scheme. The
229 Received: header is now generated after the body is received, but before the
230 ACL or local_scan() is called. After they have run, the timestamp in the
231 Received: header is updated.
233 Thus, change (a) of 4.31/2 has been reversed, but change (b) is still true,
234 which is lucky, since I decided it was a bug fix.
240 If an expansion in a condition on a "warn" statement fails because a lookup
241 defers, the "warn" statement is abandoned, and the next ACL statement is
242 processed. Previously this caused the whole ACL to be aborted.
248 Change 4.31/2 has been reversed, as it proved contentious. Recipient callout
249 verification now uses <> in the MAIL command by default, as it did before. A
250 new callout option, "use_sender", has been added to request the other
257 1. If you compile Exim to use GnuTLS, it now requires the use of release 1.0.0
258 or greater. The interface to the obsolete 0.8.x releases is no longer
259 supported. There is one externally visible change: the format for the
260 display of Distinguished Names now uses commas as a separator rather than a
261 slash. This is to comply with RFC 2253.
263 2. When a message is received, the Received: header line is now generated when
264 reception is complete, instead of at the start of reception. For messages
265 that take a long time to come in, this changes the meaning of the timestamp.
266 There are several side-effects of this change:
268 (a) If a message is rejected by a DATA or non-SMTP ACL, or by local_scan(),
269 the logged header lines no longer include the local Received: line,
270 because it has not yet been created. If the message is a non-SMTP one,
271 and the error is processed by sending a message to the sender, the copy
272 of the original message that is returned does not have an added
275 (b) When a filter file is tested using -bf, no additional Received: header
276 is added to the test message. After some thought, I decided that this
279 The contents of $received_for are not affected by this change. This
280 variable still contains the single recipient of a message, copied after
281 addresses have been rewritten, but before local_scan() is run.
283 2. Recipient callout verification, like sender verification, was using <> in
284 the MAIL FROM command. This isn't really the right thing, since the actual
285 sender may affect whether the remote host accepts the recipient or not. I
286 have changed it to use the actual sender in the callout; this means that
287 the cache record is now keyed on a recipient/sender pair, not just the
288 recipient address. There doesn't seem to be a real danger of callout loops,
289 since a callout by the remote host to check the sender would use <>.
295 1. I have abolished timeout_DNS as an error that can be detected in retry
296 rules, because it has never worked. Despite the fact that it has been
297 documented since at least release 1.62, there was no code to support it.
298 If you have used it in your retry rules, you will now get a warning message
299 to the log and panic log. It is now treated as plain "timeout".
301 2. After discussion on the mailing list, Exim no longer adds From:, Date:, or
302 Message-Id: header lines to messages that do not originate locally, that is,
303 messages that have an associated sending host address.
305 3. When looking up a host name from an IP address, Exim now tries the DNS
306 first, and only if that fails does it use gethostbyaddr() (or equivalent).
307 This change was made because on some OS, not all the names are given for
308 addresses with multiple PTR records via the gethostbyaddr() interface. The
309 order of lookup can be changed by setting host_lookup_order.
315 1. The new FIXED_NEVER_USERS build-time option creates a list of "never users"
316 that cannot be overridden. The default in the distributed EDITME is "root".
317 If for some reason you were (against advice) running deliveries as root, you
318 will have to ensure that FIXED_NEVER_USERS is not set in your
321 2. The ${quote: operator now quotes an empty string, which it did not before.
323 3. Version 4.23 saves the contents of the ACL variables with the message, so
324 that they can be used later. If one of these variables contains a newline,
325 there will be a newline character in the spool that will not be interpreted
326 correctely by a previous version of Exim. (Exim ignores keyed spool file
327 items that it doesn't understand - precisely for this kind of problem - but
328 it expects them all to be on one line.)
330 So the bottom line is: if you have newlines in your ACL variables, you
331 cannot retreat from 4.23.
337 1. The idea of the "warn" ACL verb is that it adds a header or writes to the
338 log only when "message" or "log_message" are set. However, if one of the
339 conditions was an address verification, or a call to a nested ACL, the
340 messages generated by the underlying test were being passed through. This
341 no longer happens. The underlying message is available in $acl_verify_
342 message for both "message" and "log_message" expansions, so it can be
343 passed through if needed.
345 2. The way that the $h_ (and $header_) expansions work has been changed by the
346 addition of RFC 2047 decoding. See the main documentation (the NewStuff file
347 until release 4.30, then the manual) for full details. Briefly, there are
350 $rh_xxx: and $rheader_xxx: give the original content of the header
351 line(s), with no processing at all.
353 $bh_xxx: and $bheader_xxx: remove leading and trailing white space, and
354 then decode base64 or quoted-printable "words" within the header text,
355 but do not do charset translation.
357 $h_xxx: and $header_xxx: attempt to translate the $bh_ string to a
358 standard character set.
360 If you have previously been using $h_ expansions to access the raw
361 characters, you should change to $rh_ instead.
363 3. When Exim creates an RFC 2047 encoded word in a header line, it labels it
364 with the default character set from the headers_charset option instead of
365 always using iso-8859-1.
367 4. If TMPDIR is defined in Local/Makefile (default in src/EDITME is
368 TMPDIR="/tmp"), Exim checks for the presence of an environment variable
369 called TMPDIR, and if it finds it is different, it changes its value.
371 5. Following a discussion on the list, the rules by which Exim recognises line
372 endings on incoming messages have been changed. The -dropcr and drop_cr
373 options are now no-ops, retained only for backwards compatibility. The
374 following line terminators are recognized: LF CRLF CR. However, special
375 processing applies to CR:
377 (i) The sequence CR . CR does *not* terminate an incoming SMTP message,
378 nor a local message in the state where . is a terminator.
380 (ii) If a bare CR is encountered in a header line, an extra space is added
381 after the line terminator so as not to end the header. The reasoning
382 behind this is that bare CRs in header lines are most likely either
383 to be mistakes, or people trying to play silly games.
385 6. The code for using daemon_smtp_port, local_interfaces, and the -oX options
386 has been reorganized. It is supposed to be backwards compatible, but it is
387 mentioned here just in case I've screwed up.
394 1. I have tidied and re-organized the code that uses alarm() for imposing time
395 limits on various things. It shouldn't affect anything, but if you notice
396 processes getting stuck, it may be that I've broken something.
398 2. The "arguments" log selector now also logs the current working directory
401 3. An incompatible change has been made to the appendfile transport. This
402 affects the case when it is used for file deliveries that are set up by
403 .forward and filter files. Previously, any settings of the "file" or
404 "directory" options were ignored. It is hoped that, like the address_file
405 transport in the default configuration, these options were never in fact set
406 on such transports, because they were of no use.
408 Now, if either of these options is set, it is used. The path that is passed
409 by the router is in $address_file (this is not new), so it can be used as
410 part of a longer path, or modified in any other way that expansion permits.
412 If neither "file" nor "directory" is set, the behaviour is unchanged.
414 4. Related to the above: in a filter, if a "save" command specifies a non-
415 absolute path, the value of $home/ is pre-pended. This no longer happens if
416 $home is unset or is set to an empty string.
418 5. Multiple file deliveries from a filter or .forward file can never be
419 batched; the value of batch_max on the transport is ignored for file
420 deliveries. I'm assuming that nobody ever actually set batch_max on the
421 address_file transport - it would have had odd effects previously.
423 6. DESTDIR is the more common variable that ROOT for use when installing
424 software under a different root filing system. The Exim install script now
425 recognizes DESTDIR first; if it is not set, ROOT is used.
427 7. If DESTDIR is set when installing Exim, it no longer prepends its value to
428 the path of the system aliases file that appears in the default
429 configuration (when a default configuration is installed). If an aliases
430 file is actually created, its name *does* use the prefix.
436 1. The default for the maximum number of unknown SMTP commands that Exim will
437 accept before dropping a connection has been reduced from 5 to 3. However, you
438 can now change the value by setting smtp_max_unknown_commands.
440 2. The ${quote: operator has been changed so that it turns newline and carriage
441 return characters into \n and \r, respectively.
443 3. The file names used for maildir messages now include the microsecond time
444 fraction as well as the time in seconds, to cope with systems where the process
445 id can be re-used within the same second. The format is now
447 <time>.H<microsec>P<pid>.<host>
449 This should be a compatible change, but is noted here just in case.
451 4. The rules for creating message ids have changed, to cope with systems where
452 the process id can be re-used within the same second. The format, however, is
453 unchanged, so this should not cause any problems, except as noted in the next
456 5. The maximum value for localhost_number has been reduced from 255 to 16, in
457 order to implement the new message id rules. For operating systems that have
458 case-insensitive file systems (Cygwin and Darwin), the limit is 10.
460 6. verify = header_syntax was allowing unqualified addresses in all cases. Now
461 it allows them only for locally generated messages and from hosts that match
462 sender_unqualified_hosts or recipient_unqualified_hosts, respectively.
464 7. For reasons lost in the mists of time, when a pipe transport was run, the
465 environment variable MESSAGE_ID was set to the message ID preceded by 'E' (the
466 form used in Message-ID: header lines). The 'E' has been removed.
472 1. The handling of lines in the configuration file has changed. Previously,
473 macro expansion was applied to logical lines, after continuations had been
474 joined on. This meant that it could not be used in .include lines, which are
475 handled as physical rather than logical lines. Macro expansion is now done on
476 physical lines rather than logical lines. This means there are two
479 (a) A macro that expands to # to turn a line into a comment now applies only
480 to the physical line where it appears. Previously, it would have caused
481 any following continuations also to be ignored.
483 (b) A macro name can no longer be split over the boundary between a line and
484 its continuation. Actually, this is more of a bug fix. :-)
486 2. The -D command line option must now all be within one command line item.
487 This makes it possible to use -D to set a macro to the empty string by commands
493 Previously, these items would have moved on to the next item on the command
494 line. To include spaces in a macro definition item, quotes must be used, in
495 which case you can also have spaces after -D and surrounding the equals. For
498 exim '-D ABC = something' ...
500 3. The way that addresses that redirect to themselves are handled has been
501 changed, in order to fix an obscure bug. This should not cause any problems
502 except in the case of wanting to go back from a 4.11 (or later) release to an
503 earlier release. If there are undelivered messages on the spool that contain
504 addresses which redirect to themselves, and the redirected addresses have
505 already been delivered, you might get a duplicate delivery if you revert to an
508 4. The default way of looking up IP addresses for hosts in the manualroute and
509 queryprogram routers has been changed. If "byname" or "bydns" is explicitly
510 specified, there is no change, but if no method is specified, Exim now behaves
513 First, a DNS lookup is done. If this yields anything other than
514 HOST_NOT_FOUND, that result is used. Otherwise, Exim goes on to try a call to
515 getipnodebyname() (or gethostbyname() on older systems) and the result of the
516 lookup is the result of that call.
518 This change has been made because it has been discovered that on some systems,
519 if a DNS lookup called via getipnodebyname() times out, HOST_NOT_FOUND is
520 returned instead of TRY_AGAIN. Thus, it is safest to try a DNS lookup directly
521 first, and only if that gives a definite "no such host" to try the local
524 5. In fixing the minor security problem with pid_file_path, I have removed some
525 backwards-compatible (undocumented) code which was present to ease conversion
526 from Exim 3. In Exim 4, pid_file_path is a literal; in Exim 3 it was allowed to
527 contain "%s", which was replaced by the port number for daemons listening on
528 non-standard ports. In Exim 4, such daemons do not write a pid file. The
529 backwards compatibility feature was to replace "%s" by nothing if it occurred
530 in an Exim 4 setting of pid_file_path. The bug was in this code. I have solved
531 the problem by removing the backwards compatibility feature. Thus, if you still
532 have "%s" somewhere in a setting of pid_file_path, you should remove it.
534 6. There has been an extension to lsearch files. The keys in these files may
535 now be quoted in order to allow for whitespace and colons in them. This means
536 that if you were previously using keys that began with a doublequote, you will
537 now have to wrap them with extra quotes and escape the internal quotes. The
538 possibility that anybody is actually doing this seems extremely remote, but it
539 is documented just in case.
545 The build-time parameter EXIWHAT_KILL_ARG has been renamed EXIWHAT_KILL_SIGNAL
546 to better reflect its function. The OS-specific files have been updated. Only
547 if you have explicitly set this in your Makefile (highly unlikely) do you need
git://git.exim.org / exim.git / blob