describe spool file changes for -tls_peerdn
[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.
43Exim version 4.77
46 * GnuTLS will now attempt to use TLS 1.2 and TLS 1.1 before TLS 1.0 and SSL3,
47 if supported by your GnuTLS library. Use the existing
48 "gnutls_require_protocols" option to downgrade this if that will be a
49 problem. Prior to this release, supported values were "TLS1" and "SSL3",
50 so you should be able to update configuration prior to update.
52 * The match_<type>{string1}{string2} expansion conditions no longer subject
53 string2 to string expansion, unless Exim was built with the new
54 "EXPAND_LISTMATCH_RHS" option. Too many people have inadvertently created
55 insecure configurations that way. If you need the functionality and turn on
56 that build option, please let the developers know, and know why, so we can
57 try to provide a safer mechanism for you.
59 The match{}{} expansion condition (for regular expressions) is NOT affected.
60 For match_<type>{s1}{s2}, all list functionality is unchanged. The only
61 change is that a '$' appearing in s2 will not trigger expansion, but instead
62 will be treated as a literal $ sign; the effect is very similar to having
63 wrapped s2 with \N...\N. If s2 contains a named list and the list definition
64 uses $expansions then those _will_ be processed as normal. It is only the
65 point at which s2 is read where expansion is inhibited.
67 If you are trying to test if two email addresses are equal, use eqi{s1}{s2}.
68 If you are testing if the address in s1 occurs in the list of items given
69 in s2, either use the new inlisti{s1}{s2} condition (added in 4.77) or use
70 the pre-existing forany{s2}{eqi{$item}{s1}} condition.
c566dd90 72
73Exim version 4.74
76 * The integrated support for dynamically loadable lookup modules has an ABI
77 change from the modules supported by some OS vendors through an unofficial
78 patch. Don't try to mix & match.
80 * Some parts of the build system are now beginning to assume that the host
81 environment is POSIX. If you're building on a system where POSIX tools are
82 not the default, you might have an easier time if you switch to the POSIX
83 tools. Feel free to report non-POSIX issues as a request for a feature
84 enhancement, but if the POSIX variants are available then the fix will
85 probably just involve some coercion. See the README instructions for
86 building on such hosts.
89Exim version 4.73
92 * The Exim run-time user can no longer be root; this was always
93 strongly discouraged, but is now prohibited both at build and
94 run-time. If you need Exim to run routinely as root, you'll need to
95 patch the source and accept the risk. Here be dragons.
97 * Exim will no longer accept a configuration file owned by the Exim
98 run-time user, unless that account is explicitly the value in
99 CONFIGURE_OWNER, which we discourage. Exim now checks to ensure that
a7ee5955 100 files are not writeable by other accounts.
102 * The ALT_CONFIG_ROOT_ONLY build option is no longer optional and is forced
103 on; the Exim user can, by default, no longer use -C/-D and retain privilege.
104 Two new build options mitigate this.
106 * TRUSTED_CONFIG_LIST defines a file containing a whitelist of config
107 files that are trusted to be selected by the Exim user; one per line.
108 This is the recommended approach going forward.
110 * WHITELIST_D_MACROS defines a colon-separated list of macro names which
111 the Exim run-time user may safely pass without dropping privileges.
112 Because changes to this involve a recompile, this is not the recommended
113 approach but may ease transition. The values of the macros, when
43236f35 114 overridden, are constrained to match this regex: ^[A-Za-z0-9_/.-]*$
116 * The system_filter_user option now defaults to the Exim run-time user,
117 rather than root. You can still set it explicitly to root and this
118 can be done with prior versions too, letting you roll versions
119 without needing to change this configuration option.
121 * ClamAV must be at least version 0.95 unless WITH_OLD_CLAMAV_STREAM is
122 defined at build time.
125Exim version 4.70
1281. Experimental Yahoo! Domainkeys support has been dropped in this release.
129It has been superceded by a native implementation of its successor DKIM.
1312. Up to version 4.69, Exim came with an embedded version of the PCRE library.
132As of 4.70, this is no longer the case. To compile Exim, you will need PCRE
a7ee5955 133installed. Most OS distributions have ready-made library and development
2eda48c6 134packages.
137Exim version 4.68
1401. The internal implementation of the database keys that are used for ACL
141ratelimiting has been tidied up. This means that an update to 4.68 might cause
142Exim to "forget" previous rates that it had calculated, and reset them to zero.
145Exim version 4.64
1481. Callouts were setting the name used for EHLO/HELO from $smtp_active_
149hostname. This is wrong, because it relates to the incoming message (and
150probably the interface on which it is arriving) and not to the outgoing
151callout (which could be using a different interface). This has been
152changed to use the value of the helo_data option from the smtp transport
153instead - this is what is used when a message is actually being sent. If
154there is no remote transport (possible with a router that sets up host
155addresses), $smtp_active_hostname is used. This change is mentioned here in
156case somebody is relying on the use of $smtp_active_hostname.
1582. A bug has been fixed that might just possibly be something that is relied on
159in some configurations. In expansion items such as ${if >{xxx}{yyy}...} an
160empty string (that is {}) was being interpreted as if it was {0} and therefore
161treated as the number zero. From release 4.64, such strings cause an error
162because a decimal number, possibly followed by K or M, is required (as has
163always been documented).
1653. There has been a change to the GnuTLS support (ChangeLog/PH/20) to improve
166Exim's performance. Unfortunately, this has the side effect of being slightly
167non-upwards compatible for versions 4.50 and earlier. If you are upgrading from
168one of these earlier versions and you use GnuTLS, you must remove the file
169called gnutls-params in Exim's spool directory. If you don't do this, you will
170see this error:
172 TLS error on connection from ... (DH params import): Base64 decoding error.
174Removing the file causes Exim to recompute the relevant encryption parameters
175and cache them in the new format that was introduced for release 4.51 (May
1762005). If you are upgrading from release 4.51 or later, there should be no
26da7e20 179
180Exim version 4.63
183When an SMTP error message is specified in a "message" modifier in an ACL, or
184in a :fail: or :defer: message in a redirect router, Exim now checks the start
185of the message for an SMTP error code. This consists of three digits followed
186by a space, optionally followed by an extended code of the form n.n.n, also
187followed by a space. If this is the case and the very first digit is the same
188as the default error code, the code from the message is used instead. If the
189very first digit is incorrect, a panic error is logged, and the default code is
190used. This is an incompatible change, but it is not expected to affect many (if
191any) configurations. It is possible to suppress the use of the supplied code in
192a redirect router by setting the smtp_error_code option false. In this case,
193any SMTP code is quietly ignored.
196Exim version 4.61
1991. The default number of ACL variables of each type has been increased to 20,
200and it's possible to compile Exim with more. You can safely upgrade to this
201release if you already have messages on the queue with saved ACL variable
202values. However, if you downgrade from this release with messages on the queue,
203any saved ACL values they may have will be lost.
2052. The default value for rfc1413_query_timeout has been changed from 30s to 5s.
208Exim version 4.54
211There was a problem with 4.52/TF/02 in that a "name=" option on control=
212submission terminated at the next slash, thereby not allowing for slashes in
213the name. This has been changed so that "name=" takes the rest of the string as
214its data. It must therefore be the last option.
217Version 4.53
220If you are using the experimental Domain Keys support, you must upgrade to
221at least libdomainkeys 0.67 in order to run this release of Exim.
224Version 4.51
2271. The format in which GnuTLS parameters are cached (in the file gnutls-params
228in the spool directory) has been changed. The new format can also be generated
229externally, so it is now possible to update the values from outside Exim. This
230has been implemented in an upwards, BUT NOT downwards, compatible manner.
231Upgrading should be seamless: when Exim finds that it cannot understand an
232existing cache file, it generates new parameters and writes them to the cache
233in the new format. If, however, you downgrade from 4.51 to a previous release,
234you MUST delete the gnutls-params file in the spool directory, because the
235older Exim will not recognize the new format.
2372. When doing a callout as part of verifying an address, Exim was not paying
238attention to any local part prefix or suffix that was matched by the router
239that accepted the address. It now behaves in the same way as it does for
240delivery: the affixes are removed from the local part unless
241rcpt_include_affixes is set on the transport. If you have a configuration that
242uses prefixes or suffixes on addresses that could be used for callouts, and you
243want the affixes to be retained, you must make sure that rcpt_include_affixes
244is set on the transport.
2463. Bounce and delay warning messages no longer contain details of delivery
247errors, except for explicit messages (e.g. generated by :fail:) and SMTP
248responses from remote hosts.
b5aea5e1 250
251Version 4.50
254The exicyclog script has been updated to use three-digit numbers in rotated log
255files if the maximum number to keep is greater than 99. If you are already
256keeping more than 99, there will be an incompatible change when you upgrade.
257You will probably want to rename your old log files to the new form before
c3af992c 258running the new exicyclog.
261Version 4.42
264RFC 3848 specifies standard names for the "with" phrase in Received: header
265lines when AUTH and/or TLS are in use. This is the "received protocol"
266field. Exim used to use "asmtp" for authenticated SMTP, without any
267indication (in the protocol name) for TLS use. Now it follows the RFC and
268uses "esmtpa" if the connection is authenticated, "esmtps" if it is
269encrypted, and "esmtpsa" if it is both encrypted and authenticated. These names
270appear in log lines as well as in Received: header lines.
273Version 4.34
276Change 4.31/2 gave problems to data ACLs and local_scan() functions that
277expected to see a Received: header. I have changed to yet another scheme. The
278Received: header is now generated after the body is received, but before the
279ACL or local_scan() is called. After they have run, the timestamp in the
280Received: header is updated.
282Thus, change (a) of 4.31/2 has been reversed, but change (b) is still true,
283which is lucky, since I decided it was a bug fix.
286Version 4.33
289If an expansion in a condition on a "warn" statement fails because a lookup
290defers, the "warn" statement is abandoned, and the next ACL statement is
291processed. Previously this caused the whole ACL to be aborted.
294Version 4.32
297Change 4.31/2 has been reversed, as it proved contentious. Recipient callout
298verification now uses <> in the MAIL command by default, as it did before. A
299new callout option, "use_sender", has been added to request the other
303Version 4.31
3061. If you compile Exim to use GnuTLS, it now requires the use of release 1.0.0
307 or greater. The interface to the obsolete 0.8.x releases is no longer
308 supported. There is one externally visible change: the format for the
309 display of Distinguished Names now uses commas as a separator rather than a
310 slash. This is to comply with RFC 2253.
3122. When a message is received, the Received: header line is now generated when
313 reception is complete, instead of at the start of reception. For messages
314 that take a long time to come in, this changes the meaning of the timestamp.
315 There are several side-effects of this change:
317 (a) If a message is rejected by a DATA or non-SMTP ACL, or by local_scan(),
318 the logged header lines no longer include the local Received: line,
319 because it has not yet been created. If the message is a non-SMTP one,
320 and the error is processed by sending a message to the sender, the copy
321 of the original message that is returned does not have an added
322 Received: line.
324 (b) When a filter file is tested using -bf, no additional Received: header
325 is added to the test message. After some thought, I decided that this
326 is a bug fix.
328 The contents of $received_for are not affected by this change. This
329 variable still contains the single recipient of a message, copied after
330 addresses have been rewritten, but before local_scan() is run.
3322. Recipient callout verification, like sender verification, was using <> in
333 the MAIL FROM command. This isn't really the right thing, since the actual
334 sender may affect whether the remote host accepts the recipient or not. I
335 have changed it to use the actual sender in the callout; this means that
336 the cache record is now keyed on a recipient/sender pair, not just the
337 recipient address. There doesn't seem to be a real danger of callout loops,
338 since a callout by the remote host to check the sender would use <>.
341Version 4.30
3441. I have abolished timeout_DNS as an error that can be detected in retry
345 rules, because it has never worked. Despite the fact that it has been
346 documented since at least release 1.62, there was no code to support it.
347 If you have used it in your retry rules, you will now get a warning message
348 to the log and panic log. It is now treated as plain "timeout".
3502. After discussion on the mailing list, Exim no longer adds From:, Date:, or
351 Message-Id: header lines to messages that do not originate locally, that is,
352 messages that have an associated sending host address.
3543. When looking up a host name from an IP address, Exim now tries the DNS
355 first, and only if that fails does it use gethostbyaddr() (or equivalent).
356 This change was made because on some OS, not all the names are given for
357 addresses with multiple PTR records via the gethostbyaddr() interface. The
358 order of lookup can be changed by setting host_lookup_order.
361Version 4.23
3641. The new FIXED_NEVER_USERS build-time option creates a list of "never users"
365 that cannot be overridden. The default in the distributed EDITME is "root".
366 If for some reason you were (against advice) running deliveries as root, you
367 will have to ensure that FIXED_NEVER_USERS is not set in your
368 Local/Makefile.
3702. The ${quote: operator now quotes an empty string, which it did not before.
3723. Version 4.23 saves the contents of the ACL variables with the message, so
373 that they can be used later. If one of these variables contains a newline,
374 there will be a newline character in the spool that will not be interpreted
375 correctely by a previous version of Exim. (Exim ignores keyed spool file
376 items that it doesn't understand - precisely for this kind of problem - but
377 it expects them all to be on one line.)
379 So the bottom line is: if you have newlines in your ACL variables, you
380 cannot retreat from 4.23.
383Version 4.21
3861. The idea of the "warn" ACL verb is that it adds a header or writes to the
387 log only when "message" or "log_message" are set. However, if one of the
388 conditions was an address verification, or a call to a nested ACL, the
389 messages generated by the underlying test were being passed through. This
390 no longer happens. The underlying message is available in $acl_verify_
391 message for both "message" and "log_message" expansions, so it can be
392 passed through if needed.
3942. The way that the $h_ (and $header_) expansions work has been changed by the
395 addition of RFC 2047 decoding. See the main documentation (the NewStuff file
396 until release 4.30, then the manual) for full details. Briefly, there are
397 now three forms:
399 $rh_xxx: and $rheader_xxx: give the original content of the header
400 line(s), with no processing at all.
402 $bh_xxx: and $bheader_xxx: remove leading and trailing white space, and
403 then decode base64 or quoted-printable "words" within the header text,
404 but do not do charset translation.
406 $h_xxx: and $header_xxx: attempt to translate the $bh_ string to a
407 standard character set.
409 If you have previously been using $h_ expansions to access the raw
410 characters, you should change to $rh_ instead.
4123. When Exim creates an RFC 2047 encoded word in a header line, it labels it
413 with the default character set from the headers_charset option instead of
414 always using iso-8859-1.
4164. If TMPDIR is defined in Local/Makefile (default in src/EDITME is
417 TMPDIR="/tmp"), Exim checks for the presence of an environment variable
418 called TMPDIR, and if it finds it is different, it changes its value.
4205. Following a discussion on the list, the rules by which Exim recognises line
421 endings on incoming messages have been changed. The -dropcr and drop_cr
422 options are now no-ops, retained only for backwards compatibility. The
423 following line terminators are recognized: LF CRLF CR. However, special
424 processing applies to CR:
426 (i) The sequence CR . CR does *not* terminate an incoming SMTP message,
427 nor a local message in the state where . is a terminator.
429 (ii) If a bare CR is encountered in a header line, an extra space is added
430 after the line terminator so as not to end the header. The reasoning
431 behind this is that bare CRs in header lines are most likely either
432 to be mistakes, or people trying to play silly games.
4346. The code for using daemon_smtp_port, local_interfaces, and the -oX options
435 has been reorganized. It is supposed to be backwards compatible, but it is
436 mentioned here just in case I've screwed up.
440Version 4.20
4431. I have tidied and re-organized the code that uses alarm() for imposing time
444 limits on various things. It shouldn't affect anything, but if you notice
445 processes getting stuck, it may be that I've broken something.
4472. The "arguments" log selector now also logs the current working directory
448 when Exim is called.
4503. An incompatible change has been made to the appendfile transport. This
451 affects the case when it is used for file deliveries that are set up by
452 .forward and filter files. Previously, any settings of the "file" or
453 "directory" options were ignored. It is hoped that, like the address_file
454 transport in the default configuration, these options were never in fact set
455 on such transports, because they were of no use.
457 Now, if either of these options is set, it is used. The path that is passed
458 by the router is in $address_file (this is not new), so it can be used as
459 part of a longer path, or modified in any other way that expansion permits.
461 If neither "file" nor "directory" is set, the behaviour is unchanged.
4634. Related to the above: in a filter, if a "save" command specifies a non-
464 absolute path, the value of $home/ is pre-pended. This no longer happens if
465 $home is unset or is set to an empty string.
4675. Multiple file deliveries from a filter or .forward file can never be
468 batched; the value of batch_max on the transport is ignored for file
469 deliveries. I'm assuming that nobody ever actually set batch_max on the
470 address_file transport - it would have had odd effects previously.
4726. DESTDIR is the more common variable that ROOT for use when installing
473 software under a different root filing system. The Exim install script now
474 recognizes DESTDIR first; if it is not set, ROOT is used.
4767. If DESTDIR is set when installing Exim, it no longer prepends its value to
477 the path of the system aliases file that appears in the default
478 configuration (when a default configuration is installed). If an aliases
479 file is actually created, its name *does* use the prefix.
482Version 4.14
4851. The default for the maximum number of unknown SMTP commands that Exim will
486accept before dropping a connection has been reduced from 5 to 3. However, you
487can now change the value by setting smtp_max_unknown_commands.
4892. The ${quote: operator has been changed so that it turns newline and carriage
490return characters into \n and \r, respectively.
4923. The file names used for maildir messages now include the microsecond time
493fraction as well as the time in seconds, to cope with systems where the process
494id can be re-used within the same second. The format is now
496 <time>.H<microsec>P<pid>.<host>
498This should be a compatible change, but is noted here just in case.
5004. The rules for creating message ids have changed, to cope with systems where
501the process id can be re-used within the same second. The format, however, is
502unchanged, so this should not cause any problems, except as noted in the next
5055. The maximum value for localhost_number has been reduced from 255 to 16, in
506order to implement the new message id rules. For operating systems that have
507case-insensitive file systems (Cygwin and Darwin), the limit is 10.
5096. verify = header_syntax was allowing unqualified addresses in all cases. Now
510it allows them only for locally generated messages and from hosts that match
511sender_unqualified_hosts or recipient_unqualified_hosts, respectively.
5137. For reasons lost in the mists of time, when a pipe transport was run, the
514environment variable MESSAGE_ID was set to the message ID preceded by 'E' (the
515form used in Message-ID: header lines). The 'E' has been removed.
518Version 4.11
5211. The handling of lines in the configuration file has changed. Previously,
522macro expansion was applied to logical lines, after continuations had been
523joined on. This meant that it could not be used in .include lines, which are
524handled as physical rather than logical lines. Macro expansion is now done on
525physical lines rather than logical lines. This means there are two
528 (a) A macro that expands to # to turn a line into a comment now applies only
529 to the physical line where it appears. Previously, it would have caused
530 any following continuations also to be ignored.
532 (b) A macro name can no longer be split over the boundary between a line and
533 its continuation. Actually, this is more of a bug fix. :-)
5352. The -D command line option must now all be within one command line item.
536This makes it possible to use -D to set a macro to the empty string by commands
537such as
539 exim -DABC ...
540 exim -DABC= ...
542Previously, these items would have moved on to the next item on the command
543line. To include spaces in a macro definition item, quotes must be used, in
544which case you can also have spaces after -D and surrounding the equals. For
547 exim '-D ABC = something' ...
5493. The way that addresses that redirect to themselves are handled has been
550changed, in order to fix an obscure bug. This should not cause any problems
551except in the case of wanting to go back from a 4.11 (or later) release to an
552earlier release. If there are undelivered messages on the spool that contain
553addresses which redirect to themselves, and the redirected addresses have
554already been delivered, you might get a duplicate delivery if you revert to an
555earlier Exim.
5574. The default way of looking up IP addresses for hosts in the manualroute and
558queryprogram routers has been changed. If "byname" or "bydns" is explicitly
559specified, there is no change, but if no method is specified, Exim now behaves
560as follows:
562 First, a DNS lookup is done. If this yields anything other than
563 HOST_NOT_FOUND, that result is used. Otherwise, Exim goes on to try a call to
564 getipnodebyname() (or gethostbyname() on older systems) and the result of the
565 lookup is the result of that call.
567This change has been made because it has been discovered that on some systems,
568if a DNS lookup called via getipnodebyname() times out, HOST_NOT_FOUND is
569returned instead of TRY_AGAIN. Thus, it is safest to try a DNS lookup directly
570first, and only if that gives a definite "no such host" to try the local
5735. In fixing the minor security problem with pid_file_path, I have removed some
574backwards-compatible (undocumented) code which was present to ease conversion
575from Exim 3. In Exim 4, pid_file_path is a literal; in Exim 3 it was allowed to
576contain "%s", which was replaced by the port number for daemons listening on
577non-standard ports. In Exim 4, such daemons do not write a pid file. The
578backwards compatibility feature was to replace "%s" by nothing if it occurred
579in an Exim 4 setting of pid_file_path. The bug was in this code. I have solved
580the problem by removing the backwards compatibility feature. Thus, if you still
581have "%s" somewhere in a setting of pid_file_path, you should remove it.
5836. There has been an extension to lsearch files. The keys in these files may
584now be quoted in order to allow for whitespace and colons in them. This means
585that if you were previously using keys that began with a doublequote, you will
586now have to wrap them with extra quotes and escape the internal quotes. The
587possibility that anybody is actually doing this seems extremely remote, but it
588is documented just in case.
591Version 4.10
594The build-time parameter EXIWHAT_KILL_ARG has been renamed EXIWHAT_KILL_SIGNAL
595to better reflect its function. The OS-specific files have been updated. Only
596if you have explicitly set this in your Makefile (highly unlikely) do you need
597to change anything.