Handle \n in tls_peerdn for spool files.
[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.77
32 * GnuTLS will now attempt to use TLS 1.2 and TLS 1.1 before TLS 1.0 and SSL3,
33 if supported by your GnuTLS library. Use the existing
34 "gnutls_require_protocols" option to downgrade this if that will be a
35 problem. Prior to this release, supported values were "TLS1" and "SSL3",
36 so you should be able to update configuration prior to update.
38 * The match_<type>{string1}{string2} expansion conditions no longer subject
39 string2 to string expansion, unless Exim was built with the new
40 "EXPAND_LISTMATCH_RHS" option. Too many people have inadvertently created
41 insecure configurations that way. If you need the functionality and turn on
42 that build option, please let the developers know, and know why, so we can
43 try to provide a safer mechanism for you.
45 The match{}{} expansion condition (for regular expressions) is NOT affected.
46 For match_<type>{s1}{s2}, all list functionality is unchanged. The only
47 change is that a '$' appearing in s2 will not trigger expansion, but instead
48 will be treated as a literal $ sign; the effect is very similar to having
49 wrapped s2 with \N...\N. If s2 contains a named list and the list definition
50 uses $expansions then those _will_ be processed as normal. It is only the
51 point at which s2 is read where expansion is inhibited.
53 If you are trying to test if two email addresses are equal, use eqi{s1}{s2}.
54 If you are testing if the address in s1 occurs in the list of items given
55 in s2, either use the new inlisti{s1}{s2} condition (added in 4.77) or use
56 the pre-existing forany{s2}{eqi{$item}{s1}} condition.
c566dd90 58
59Exim version 4.74
62 * The integrated support for dynamically loadable lookup modules has an ABI
63 change from the modules supported by some OS vendors through an unofficial
64 patch. Don't try to mix & match.
66 * Some parts of the build system are now beginning to assume that the host
67 environment is POSIX. If you're building on a system where POSIX tools are
68 not the default, you might have an easier time if you switch to the POSIX
69 tools. Feel free to report non-POSIX issues as a request for a feature
70 enhancement, but if the POSIX variants are available then the fix will
71 probably just involve some coercion. See the README instructions for
72 building on such hosts.
75Exim version 4.73
78 * The Exim run-time user can no longer be root; this was always
79 strongly discouraged, but is now prohibited both at build and
80 run-time. If you need Exim to run routinely as root, you'll need to
81 patch the source and accept the risk. Here be dragons.
83 * Exim will no longer accept a configuration file owned by the Exim
84 run-time user, unless that account is explicitly the value in
85 CONFIGURE_OWNER, which we discourage. Exim now checks to ensure that
a7ee5955 86 files are not writeable by other accounts.
88 * The ALT_CONFIG_ROOT_ONLY build option is no longer optional and is forced
89 on; the Exim user can, by default, no longer use -C/-D and retain privilege.
90 Two new build options mitigate this.
92 * TRUSTED_CONFIG_LIST defines a file containing a whitelist of config
93 files that are trusted to be selected by the Exim user; one per line.
94 This is the recommended approach going forward.
96 * WHITELIST_D_MACROS defines a colon-separated list of macro names which
97 the Exim run-time user may safely pass without dropping privileges.
98 Because changes to this involve a recompile, this is not the recommended
99 approach but may ease transition. The values of the macros, when
43236f35 100 overridden, are constrained to match this regex: ^[A-Za-z0-9_/.-]*$
102 * The system_filter_user option now defaults to the Exim run-time user,
103 rather than root. You can still set it explicitly to root and this
104 can be done with prior versions too, letting you roll versions
105 without needing to change this configuration option.
107 * ClamAV must be at least version 0.95 unless WITH_OLD_CLAMAV_STREAM is
108 defined at build time.
111Exim version 4.70
1141. Experimental Yahoo! Domainkeys support has been dropped in this release.
115It has been superceded by a native implementation of its successor DKIM.
1172. Up to version 4.69, Exim came with an embedded version of the PCRE library.
118As of 4.70, this is no longer the case. To compile Exim, you will need PCRE
a7ee5955 119installed. Most OS distributions have ready-made library and development
2eda48c6 120packages.
123Exim version 4.68
1261. The internal implementation of the database keys that are used for ACL
127ratelimiting has been tidied up. This means that an update to 4.68 might cause
128Exim to "forget" previous rates that it had calculated, and reset them to zero.
131Exim version 4.64
1341. Callouts were setting the name used for EHLO/HELO from $smtp_active_
135hostname. This is wrong, because it relates to the incoming message (and
136probably the interface on which it is arriving) and not to the outgoing
137callout (which could be using a different interface). This has been
138changed to use the value of the helo_data option from the smtp transport
139instead - this is what is used when a message is actually being sent. If
140there is no remote transport (possible with a router that sets up host
141addresses), $smtp_active_hostname is used. This change is mentioned here in
142case somebody is relying on the use of $smtp_active_hostname.
1442. A bug has been fixed that might just possibly be something that is relied on
145in some configurations. In expansion items such as ${if >{xxx}{yyy}...} an
146empty string (that is {}) was being interpreted as if it was {0} and therefore
147treated as the number zero. From release 4.64, such strings cause an error
148because a decimal number, possibly followed by K or M, is required (as has
149always been documented).
1513. There has been a change to the GnuTLS support (ChangeLog/PH/20) to improve
152Exim's performance. Unfortunately, this has the side effect of being slightly
153non-upwards compatible for versions 4.50 and earlier. If you are upgrading from
154one of these earlier versions and you use GnuTLS, you must remove the file
155called gnutls-params in Exim's spool directory. If you don't do this, you will
156see this error:
158 TLS error on connection from ... (DH params import): Base64 decoding error.
160Removing the file causes Exim to recompute the relevant encryption parameters
161and cache them in the new format that was introduced for release 4.51 (May
1622005). If you are upgrading from release 4.51 or later, there should be no
26da7e20 165
166Exim version 4.63
169When an SMTP error message is specified in a "message" modifier in an ACL, or
170in a :fail: or :defer: message in a redirect router, Exim now checks the start
171of the message for an SMTP error code. This consists of three digits followed
172by a space, optionally followed by an extended code of the form n.n.n, also
173followed by a space. If this is the case and the very first digit is the same
174as the default error code, the code from the message is used instead. If the
175very first digit is incorrect, a panic error is logged, and the default code is
176used. This is an incompatible change, but it is not expected to affect many (if
177any) configurations. It is possible to suppress the use of the supplied code in
178a redirect router by setting the smtp_error_code option false. In this case,
179any SMTP code is quietly ignored.
182Exim version 4.61
1851. The default number of ACL variables of each type has been increased to 20,
186and it's possible to compile Exim with more. You can safely upgrade to this
187release if you already have messages on the queue with saved ACL variable
188values. However, if you downgrade from this release with messages on the queue,
189any saved ACL values they may have will be lost.
1912. The default value for rfc1413_query_timeout has been changed from 30s to 5s.
194Exim version 4.54
197There was a problem with 4.52/TF/02 in that a "name=" option on control=
198submission terminated at the next slash, thereby not allowing for slashes in
199the name. This has been changed so that "name=" takes the rest of the string as
200its data. It must therefore be the last option.
203Version 4.53
206If you are using the experimental Domain Keys support, you must upgrade to
207at least libdomainkeys 0.67 in order to run this release of Exim.
210Version 4.51
2131. The format in which GnuTLS parameters are cached (in the file gnutls-params
214in the spool directory) has been changed. The new format can also be generated
215externally, so it is now possible to update the values from outside Exim. This
216has been implemented in an upwards, BUT NOT downwards, compatible manner.
217Upgrading should be seamless: when Exim finds that it cannot understand an
218existing cache file, it generates new parameters and writes them to the cache
219in the new format. If, however, you downgrade from 4.51 to a previous release,
220you MUST delete the gnutls-params file in the spool directory, because the
221older Exim will not recognize the new format.
2232. When doing a callout as part of verifying an address, Exim was not paying
224attention to any local part prefix or suffix that was matched by the router
225that accepted the address. It now behaves in the same way as it does for
226delivery: the affixes are removed from the local part unless
227rcpt_include_affixes is set on the transport. If you have a configuration that
228uses prefixes or suffixes on addresses that could be used for callouts, and you
229want the affixes to be retained, you must make sure that rcpt_include_affixes
230is set on the transport.
2323. Bounce and delay warning messages no longer contain details of delivery
233errors, except for explicit messages (e.g. generated by :fail:) and SMTP
234responses from remote hosts.
b5aea5e1 236
237Version 4.50
240The exicyclog script has been updated to use three-digit numbers in rotated log
241files if the maximum number to keep is greater than 99. If you are already
242keeping more than 99, there will be an incompatible change when you upgrade.
243You will probably want to rename your old log files to the new form before
c3af992c 244running the new exicyclog.
247Version 4.42
250RFC 3848 specifies standard names for the "with" phrase in Received: header
251lines when AUTH and/or TLS are in use. This is the "received protocol"
252field. Exim used to use "asmtp" for authenticated SMTP, without any
253indication (in the protocol name) for TLS use. Now it follows the RFC and
254uses "esmtpa" if the connection is authenticated, "esmtps" if it is
255encrypted, and "esmtpsa" if it is both encrypted and authenticated. These names
256appear in log lines as well as in Received: header lines.
259Version 4.34
262Change 4.31/2 gave problems to data ACLs and local_scan() functions that
263expected to see a Received: header. I have changed to yet another scheme. The
264Received: header is now generated after the body is received, but before the
265ACL or local_scan() is called. After they have run, the timestamp in the
266Received: header is updated.
268Thus, change (a) of 4.31/2 has been reversed, but change (b) is still true,
269which is lucky, since I decided it was a bug fix.
272Version 4.33
275If an expansion in a condition on a "warn" statement fails because a lookup
276defers, the "warn" statement is abandoned, and the next ACL statement is
277processed. Previously this caused the whole ACL to be aborted.
280Version 4.32
283Change 4.31/2 has been reversed, as it proved contentious. Recipient callout
284verification now uses <> in the MAIL command by default, as it did before. A
285new callout option, "use_sender", has been added to request the other
289Version 4.31
2921. If you compile Exim to use GnuTLS, it now requires the use of release 1.0.0
293 or greater. The interface to the obsolete 0.8.x releases is no longer
294 supported. There is one externally visible change: the format for the
295 display of Distinguished Names now uses commas as a separator rather than a
296 slash. This is to comply with RFC 2253.
2982. When a message is received, the Received: header line is now generated when
299 reception is complete, instead of at the start of reception. For messages
300 that take a long time to come in, this changes the meaning of the timestamp.
301 There are several side-effects of this change:
303 (a) If a message is rejected by a DATA or non-SMTP ACL, or by local_scan(),
304 the logged header lines no longer include the local Received: line,
305 because it has not yet been created. If the message is a non-SMTP one,
306 and the error is processed by sending a message to the sender, the copy
307 of the original message that is returned does not have an added
308 Received: line.
310 (b) When a filter file is tested using -bf, no additional Received: header
311 is added to the test message. After some thought, I decided that this
312 is a bug fix.
314 The contents of $received_for are not affected by this change. This
315 variable still contains the single recipient of a message, copied after
316 addresses have been rewritten, but before local_scan() is run.
3182. Recipient callout verification, like sender verification, was using <> in
319 the MAIL FROM command. This isn't really the right thing, since the actual
320 sender may affect whether the remote host accepts the recipient or not. I
321 have changed it to use the actual sender in the callout; this means that
322 the cache record is now keyed on a recipient/sender pair, not just the
323 recipient address. There doesn't seem to be a real danger of callout loops,
324 since a callout by the remote host to check the sender would use <>.
327Version 4.30
3301. I have abolished timeout_DNS as an error that can be detected in retry
331 rules, because it has never worked. Despite the fact that it has been
332 documented since at least release 1.62, there was no code to support it.
333 If you have used it in your retry rules, you will now get a warning message
334 to the log and panic log. It is now treated as plain "timeout".
3362. After discussion on the mailing list, Exim no longer adds From:, Date:, or
337 Message-Id: header lines to messages that do not originate locally, that is,
338 messages that have an associated sending host address.
3403. When looking up a host name from an IP address, Exim now tries the DNS
341 first, and only if that fails does it use gethostbyaddr() (or equivalent).
342 This change was made because on some OS, not all the names are given for
343 addresses with multiple PTR records via the gethostbyaddr() interface. The
344 order of lookup can be changed by setting host_lookup_order.
347Version 4.23
3501. The new FIXED_NEVER_USERS build-time option creates a list of "never users"
351 that cannot be overridden. The default in the distributed EDITME is "root".
352 If for some reason you were (against advice) running deliveries as root, you
353 will have to ensure that FIXED_NEVER_USERS is not set in your
354 Local/Makefile.
3562. The ${quote: operator now quotes an empty string, which it did not before.
3583. Version 4.23 saves the contents of the ACL variables with the message, so
359 that they can be used later. If one of these variables contains a newline,
360 there will be a newline character in the spool that will not be interpreted
361 correctely by a previous version of Exim. (Exim ignores keyed spool file
362 items that it doesn't understand - precisely for this kind of problem - but
363 it expects them all to be on one line.)
365 So the bottom line is: if you have newlines in your ACL variables, you
366 cannot retreat from 4.23.
369Version 4.21
3721. The idea of the "warn" ACL verb is that it adds a header or writes to the
373 log only when "message" or "log_message" are set. However, if one of the
374 conditions was an address verification, or a call to a nested ACL, the
375 messages generated by the underlying test were being passed through. This
376 no longer happens. The underlying message is available in $acl_verify_
377 message for both "message" and "log_message" expansions, so it can be
378 passed through if needed.
3802. The way that the $h_ (and $header_) expansions work has been changed by the
381 addition of RFC 2047 decoding. See the main documentation (the NewStuff file
382 until release 4.30, then the manual) for full details. Briefly, there are
383 now three forms:
385 $rh_xxx: and $rheader_xxx: give the original content of the header
386 line(s), with no processing at all.
388 $bh_xxx: and $bheader_xxx: remove leading and trailing white space, and
389 then decode base64 or quoted-printable "words" within the header text,
390 but do not do charset translation.
392 $h_xxx: and $header_xxx: attempt to translate the $bh_ string to a
393 standard character set.
395 If you have previously been using $h_ expansions to access the raw
396 characters, you should change to $rh_ instead.
3983. When Exim creates an RFC 2047 encoded word in a header line, it labels it
399 with the default character set from the headers_charset option instead of
400 always using iso-8859-1.
4024. If TMPDIR is defined in Local/Makefile (default in src/EDITME is
403 TMPDIR="/tmp"), Exim checks for the presence of an environment variable
404 called TMPDIR, and if it finds it is different, it changes its value.
4065. Following a discussion on the list, the rules by which Exim recognises line
407 endings on incoming messages have been changed. The -dropcr and drop_cr
408 options are now no-ops, retained only for backwards compatibility. The
409 following line terminators are recognized: LF CRLF CR. However, special
410 processing applies to CR:
412 (i) The sequence CR . CR does *not* terminate an incoming SMTP message,
413 nor a local message in the state where . is a terminator.
415 (ii) If a bare CR is encountered in a header line, an extra space is added
416 after the line terminator so as not to end the header. The reasoning
417 behind this is that bare CRs in header lines are most likely either
418 to be mistakes, or people trying to play silly games.
4206. The code for using daemon_smtp_port, local_interfaces, and the -oX options
421 has been reorganized. It is supposed to be backwards compatible, but it is
422 mentioned here just in case I've screwed up.
426Version 4.20
4291. I have tidied and re-organized the code that uses alarm() for imposing time
430 limits on various things. It shouldn't affect anything, but if you notice
431 processes getting stuck, it may be that I've broken something.
4332. The "arguments" log selector now also logs the current working directory
434 when Exim is called.
4363. An incompatible change has been made to the appendfile transport. This
437 affects the case when it is used for file deliveries that are set up by
438 .forward and filter files. Previously, any settings of the "file" or
439 "directory" options were ignored. It is hoped that, like the address_file
440 transport in the default configuration, these options were never in fact set
441 on such transports, because they were of no use.
443 Now, if either of these options is set, it is used. The path that is passed
444 by the router is in $address_file (this is not new), so it can be used as
445 part of a longer path, or modified in any other way that expansion permits.
447 If neither "file" nor "directory" is set, the behaviour is unchanged.
4494. Related to the above: in a filter, if a "save" command specifies a non-
450 absolute path, the value of $home/ is pre-pended. This no longer happens if
451 $home is unset or is set to an empty string.
4535. Multiple file deliveries from a filter or .forward file can never be
454 batched; the value of batch_max on the transport is ignored for file
455 deliveries. I'm assuming that nobody ever actually set batch_max on the
456 address_file transport - it would have had odd effects previously.
4586. DESTDIR is the more common variable that ROOT for use when installing
459 software under a different root filing system. The Exim install script now
460 recognizes DESTDIR first; if it is not set, ROOT is used.
4627. If DESTDIR is set when installing Exim, it no longer prepends its value to
463 the path of the system aliases file that appears in the default
464 configuration (when a default configuration is installed). If an aliases
465 file is actually created, its name *does* use the prefix.
468Version 4.14
4711. The default for the maximum number of unknown SMTP commands that Exim will
472accept before dropping a connection has been reduced from 5 to 3. However, you
473can now change the value by setting smtp_max_unknown_commands.
4752. The ${quote: operator has been changed so that it turns newline and carriage
476return characters into \n and \r, respectively.
4783. The file names used for maildir messages now include the microsecond time
479fraction as well as the time in seconds, to cope with systems where the process
480id can be re-used within the same second. The format is now
482 <time>.H<microsec>P<pid>.<host>
484This should be a compatible change, but is noted here just in case.
4864. The rules for creating message ids have changed, to cope with systems where
487the process id can be re-used within the same second. The format, however, is
488unchanged, so this should not cause any problems, except as noted in the next
4915. The maximum value for localhost_number has been reduced from 255 to 16, in
492order to implement the new message id rules. For operating systems that have
493case-insensitive file systems (Cygwin and Darwin), the limit is 10.
4956. verify = header_syntax was allowing unqualified addresses in all cases. Now
496it allows them only for locally generated messages and from hosts that match
497sender_unqualified_hosts or recipient_unqualified_hosts, respectively.
4997. For reasons lost in the mists of time, when a pipe transport was run, the
500environment variable MESSAGE_ID was set to the message ID preceded by 'E' (the
501form used in Message-ID: header lines). The 'E' has been removed.
504Version 4.11
5071. The handling of lines in the configuration file has changed. Previously,
508macro expansion was applied to logical lines, after continuations had been
509joined on. This meant that it could not be used in .include lines, which are
510handled as physical rather than logical lines. Macro expansion is now done on
511physical lines rather than logical lines. This means there are two
514 (a) A macro that expands to # to turn a line into a comment now applies only
515 to the physical line where it appears. Previously, it would have caused
516 any following continuations also to be ignored.
518 (b) A macro name can no longer be split over the boundary between a line and
519 its continuation. Actually, this is more of a bug fix. :-)
5212. The -D command line option must now all be within one command line item.
522This makes it possible to use -D to set a macro to the empty string by commands
523such as
525 exim -DABC ...
526 exim -DABC= ...
528Previously, these items would have moved on to the next item on the command
529line. To include spaces in a macro definition item, quotes must be used, in
530which case you can also have spaces after -D and surrounding the equals. For
533 exim '-D ABC = something' ...
5353. The way that addresses that redirect to themselves are handled has been
536changed, in order to fix an obscure bug. This should not cause any problems
537except in the case of wanting to go back from a 4.11 (or later) release to an
538earlier release. If there are undelivered messages on the spool that contain
539addresses which redirect to themselves, and the redirected addresses have
540already been delivered, you might get a duplicate delivery if you revert to an
541earlier Exim.
5434. The default way of looking up IP addresses for hosts in the manualroute and
544queryprogram routers has been changed. If "byname" or "bydns" is explicitly
545specified, there is no change, but if no method is specified, Exim now behaves
546as follows:
548 First, a DNS lookup is done. If this yields anything other than
549 HOST_NOT_FOUND, that result is used. Otherwise, Exim goes on to try a call to
550 getipnodebyname() (or gethostbyname() on older systems) and the result of the
551 lookup is the result of that call.
553This change has been made because it has been discovered that on some systems,
554if a DNS lookup called via getipnodebyname() times out, HOST_NOT_FOUND is
555returned instead of TRY_AGAIN. Thus, it is safest to try a DNS lookup directly
556first, and only if that gives a definite "no such host" to try the local
5595. In fixing the minor security problem with pid_file_path, I have removed some
560backwards-compatible (undocumented) code which was present to ease conversion
561from Exim 3. In Exim 4, pid_file_path is a literal; in Exim 3 it was allowed to
562contain "%s", which was replaced by the port number for daemons listening on
563non-standard ports. In Exim 4, such daemons do not write a pid file. The
564backwards compatibility feature was to replace "%s" by nothing if it occurred
565in an Exim 4 setting of pid_file_path. The bug was in this code. I have solved
566the problem by removing the backwards compatibility feature. Thus, if you still
567have "%s" somewhere in a setting of pid_file_path, you should remove it.
5696. There has been an extension to lsearch files. The keys in these files may
570now be quoted in order to allow for whitespace and colons in them. This means
571that if you were previously using keys that began with a doublequote, you will
572now have to wrap them with extra quotes and escape the internal quotes. The
573possibility that anybody is actually doing this seems extremely remote, but it
574is documented just in case.
577Version 4.10
580The build-time parameter EXIWHAT_KILL_ARG has been renamed EXIWHAT_KILL_SIGNAL
581to better reflect its function. The OS-specific files have been updated. Only
582if you have explicitly set this in your Makefile (highly unlikely) do you need
583to change anything.