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