8abad1b62e2a84346ae0070334a96bf756248318
[exim.git] / src / README.UPDATING
1 $Cambridge: exim/src/README.UPDATING,v 1.4 2005/01/17 09:35:16 ph10 Exp $
2
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...
8
9
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.        *
18 *                                                                        *
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 **************************************************************************
25
26
27 The rest of this document contains information about changes in 4.xx releases
28 that might affect a running system.
29
30
31 Version 4.50
32 ------------
33
34 The exicyclog script has been updated to use three-digit numbers in rotated log
35 files if the maximum number to keep is greater than 99. If you are already
36 keeping more than 99, there will be an incompatible change when you upgrade.
37 You will probably want to rename your old log files to the new form before
38 running the new exicyclog.
39
40
41 Version 4.42
42 ------------
43
44 RFC 3848 specifies standard names for the "with" phrase in Received: header
45 lines when AUTH and/or TLS are in use. This is the "received protocol"
46 field. Exim used to use "asmtp" for authenticated SMTP, without any
47 indication (in the protocol name) for TLS use. Now it follows the RFC and
48 uses "esmtpa" if the connection is authenticated, "esmtps" if it is
49 encrypted, and "esmtpsa" if it is both encrypted and authenticated. These names
50 appear in log lines as well as in Received: header lines.
51
52
53 Version 4.34
54 ------------
55
56 Change 4.31/2 gave problems to data ACLs and local_scan() functions that
57 expected to see a Received: header. I have changed to yet another scheme. The
58 Received: header is now generated after the body is received, but before the
59 ACL or local_scan() is called. After they have run, the timestamp in the
60 Received: header is updated.
61
62 Thus, change (a) of 4.31/2 has been reversed, but change (b) is still true,
63 which is lucky, since I decided it was a bug fix.
64
65
66 Version 4.33
67 ------------
68
69 If an expansion in a condition on a "warn" statement fails because a lookup
70 defers, the "warn" statement is abandoned, and the next ACL statement is
71 processed. Previously this caused the whole ACL to be aborted.
72
73
74 Version 4.32
75 ------------
76
77 Change 4.31/2 has been reversed, as it proved contentious. Recipient callout
78 verification now uses <> in the MAIL command by default, as it did before. A
79 new callout option, "use_sender", has been added to request the other
80 behaviour.
81
82
83 Version 4.31
84 ------------
85
86 1. If you compile Exim to use GnuTLS, it now requires the use of release 1.0.0
87    or greater. The interface to the obsolete 0.8.x releases is no longer
88    supported. There is one externally visible change: the format for the
89    display of Distinguished Names now uses commas as a separator rather than a
90    slash. This is to comply with RFC 2253.
91
92 2. When a message is received, the Received: header line is now generated when
93    reception is complete, instead of at the start of reception. For messages
94    that take a long time to come in, this changes the meaning of the timestamp.
95    There are several side-effects of this change:
96
97     (a) If a message is rejected by a DATA or non-SMTP ACL, or by local_scan(),
98         the logged header lines no longer include the local Received: line,
99         because it has not yet been created. If the message is a non-SMTP one,
100         and the error is processed by sending a message to the sender, the copy
101         of the original message that is returned does not have an added
102         Received: line.
103
104     (b) When a filter file is tested using -bf, no additional Received: header
105         is added to the test message. After some thought, I decided that this
106         is a bug fix.
107
108     The contents of $received_for are not affected by this change. This
109     variable still contains the single recipient of a message, copied after
110     addresses have been rewritten, but before local_scan() is run.
111
112 2. Recipient callout verification, like sender verification, was using <> in
113    the MAIL FROM command. This isn't really the right thing, since the actual
114    sender may affect whether the remote host accepts the recipient or not. I
115    have changed it to use the actual sender in the callout; this means that
116    the cache record is now keyed on a recipient/sender pair, not just the
117    recipient address. There doesn't seem to be a real danger of callout loops,
118    since a callout by the remote host to check the sender would use <>.
119
120
121 Version 4.30
122 ------------
123
124 1. I have abolished timeout_DNS as an error that can be detected in retry
125    rules, because it has never worked. Despite the fact that it has been
126    documented since at least release 1.62, there was no code to support it.
127    If you have used it in your retry rules, you will now get a warning message
128    to the log and panic log. It is now treated as plain "timeout".
129
130 2. After discussion on the mailing list, Exim no longer adds From:, Date:, or
131    Message-Id: header lines to messages that do not originate locally, that is,
132    messages that have an associated sending host address.
133
134 3. When looking up a host name from an IP address, Exim now tries the DNS
135    first, and only if that fails does it use gethostbyaddr() (or equivalent).
136    This change was made because on some OS, not all the names are given for
137    addresses with multiple PTR records via the gethostbyaddr() interface. The
138    order of lookup can be changed by setting host_lookup_order.
139
140
141 Version 4.23
142 ------------
143
144 1. The new FIXED_NEVER_USERS build-time option creates a list of "never users"
145    that cannot be overridden. The default in the distributed EDITME is "root".
146    If for some reason you were (against advice) running deliveries as root, you
147    will have to ensure that FIXED_NEVER_USERS is not set in your
148    Local/Makefile.
149
150 2. The ${quote: operator now quotes an empty string, which it did not before.
151
152 3. Version 4.23 saves the contents of the ACL variables with the message, so
153    that they can be used later. If one of these variables contains a newline,
154    there will be a newline character in the spool that will not be interpreted
155    correctely by a previous version of Exim. (Exim ignores keyed spool file
156    items that it doesn't understand - precisely for this kind of problem - but
157    it expects them all to be on one line.)
158
159    So the bottom line is: if you have newlines in your ACL variables, you
160    cannot retreat from 4.23.
161
162
163 Version 4.21
164 ------------
165
166 1. The idea of the "warn" ACL verb is that it adds a header or writes to the
167    log only when "message" or "log_message" are set. However, if one of the
168    conditions was an address verification, or a call to a nested ACL, the
169    messages generated by the underlying test were being passed through. This
170    no longer happens. The underlying message is available in $acl_verify_
171    message for both "message" and "log_message" expansions, so it can be
172    passed through if needed.
173
174 2. The way that the $h_ (and $header_) expansions work has been changed by the
175    addition of RFC 2047 decoding. See the main documentation (the NewStuff file
176    until release 4.30, then the manual) for full details. Briefly, there are
177    now three forms:
178
179      $rh_xxx: and $rheader_xxx: give the original content of the header
180        line(s), with no processing at all.
181
182      $bh_xxx: and $bheader_xxx: remove leading and trailing white space, and
183        then decode base64 or quoted-printable "words" within the header text,
184        but do not do charset translation.
185
186      $h_xxx: and $header_xxx: attempt to translate the $bh_ string to a
187        standard character set.
188
189    If you have previously been using $h_ expansions to access the raw
190    characters, you should change to $rh_ instead.
191
192 3. When Exim creates an RFC 2047 encoded word in a header line, it labels it
193    with the default character set from the headers_charset option instead of
194    always using iso-8859-1.
195
196 4. If TMPDIR is defined in Local/Makefile (default in src/EDITME is
197    TMPDIR="/tmp"), Exim checks for the presence of an environment variable
198    called TMPDIR, and if it finds it is different, it changes its value.
199
200 5. Following a discussion on the list, the rules by which Exim recognises line
201    endings on incoming messages have been changed. The -dropcr and drop_cr
202    options are now no-ops, retained only for backwards compatibility. The
203    following line terminators are recognized: LF CRLF CR. However, special
204    processing applies to CR:
205
206    (i)  The sequence CR . CR does *not* terminate an incoming SMTP message,
207         nor a local message in the state where . is a terminator.
208
209    (ii) If a bare CR is encountered in a header line, an extra space is added
210         after the line terminator so as not to end the header. The reasoning
211         behind this is that bare CRs in header lines are most likely either
212         to be mistakes, or people trying to play silly games.
213
214 6. The code for using daemon_smtp_port, local_interfaces, and the -oX options
215    has been reorganized. It is supposed to be backwards compatible, but it is
216    mentioned here just in case I've screwed up.
217
218
219
220 Version 4.20
221 ------------
222
223 1. I have tidied and re-organized the code that uses alarm() for imposing time
224    limits on various things. It shouldn't affect anything, but if you notice
225    processes getting stuck, it may be that I've broken something.
226
227 2. The "arguments" log selector now also logs the current working directory
228    when Exim is called.
229
230 3. An incompatible change has been made to the appendfile transport. This
231    affects the case when it is used for file deliveries that are set up by
232    .forward and filter files. Previously, any settings of the "file" or
233    "directory" options were ignored. It is hoped that, like the address_file
234    transport in the default configuration, these options were never in fact set
235    on such transports, because they were of no use.
236
237    Now, if either of these options is set, it is used. The path that is passed
238    by the router is in $address_file (this is not new), so it can be used as
239    part of a longer path, or modified in any other way that expansion permits.
240
241    If neither "file" nor "directory" is set, the behaviour is unchanged.
242
243 4. Related to the above: in a filter, if a "save" command specifies a non-
244    absolute path, the value of $home/ is pre-pended. This no longer happens if
245    $home is unset or is set to an empty string.
246
247 5. Multiple file deliveries from a filter or .forward file can never be
248    batched; the value of batch_max on the transport is ignored for file
249    deliveries. I'm assuming that nobody ever actually set batch_max on the
250    address_file transport - it would have had odd effects previously.
251
252 6. DESTDIR is the more common variable that ROOT for use when installing
253    software under a different root filing system. The Exim install script now
254    recognizes DESTDIR first; if it is not set, ROOT is used.
255
256 7. If DESTDIR is set when installing Exim, it no longer prepends its value to
257    the path of the system aliases file that appears in the default
258    configuration (when a default configuration is installed). If an aliases
259    file is actually created, its name *does* use the prefix.
260
261
262 Version 4.14
263 ------------
264
265 1. The default for the maximum number of unknown SMTP commands that Exim will
266 accept before dropping a connection has been reduced from 5 to 3. However, you
267 can now change the value by setting smtp_max_unknown_commands.
268
269 2. The ${quote: operator has been changed so that it turns newline and carriage
270 return characters into \n and \r, respectively.
271
272 3. The file names used for maildir messages now include the microsecond time
273 fraction as well as the time in seconds, to cope with systems where the process
274 id can be re-used within the same second. The format is now
275
276   <time>.H<microsec>P<pid>.<host>
277
278 This should be a compatible change, but is noted here just in case.
279
280 4. The rules for creating message ids have changed, to cope with systems where
281 the process id can be re-used within the same second. The format, however, is
282 unchanged, so this should not cause any problems, except as noted in the next
283 item.
284
285 5. The maximum value for localhost_number has been reduced from 255 to 16, in
286 order to implement the new message id rules. For operating systems that have
287 case-insensitive file systems (Cygwin and Darwin), the limit is 10.
288
289 6. verify = header_syntax was allowing unqualified addresses in all cases. Now
290 it allows them only for locally generated messages and from hosts that match
291 sender_unqualified_hosts or recipient_unqualified_hosts, respectively.
292
293 7. For reasons lost in the mists of time, when a pipe transport was run, the
294 environment variable MESSAGE_ID was set to the message ID preceded by 'E' (the
295 form used in Message-ID: header lines). The 'E' has been removed.
296
297
298 Version 4.11
299 ------------
300
301 1. The handling of lines in the configuration file has changed. Previously,
302 macro expansion was applied to logical lines, after continuations had been
303 joined on. This meant that it could not be used in .include lines, which are
304 handled as physical rather than logical lines. Macro expansion is now done on
305 physical lines rather than logical lines. This means there are two
306 incompatibilities:
307
308   (a) A macro that expands to # to turn a line into a comment now applies only
309       to the physical line where it appears. Previously, it would have caused
310       any following continuations also to be ignored.
311
312   (b) A macro name can no longer be split over the boundary between a line and
313       its continuation. Actually, this is more of a bug fix. :-)
314
315 2. The -D command line option must now all be within one command line item.
316 This makes it possible to use -D to set a macro to the empty string by commands
317 such as
318
319   exim -DABC  ...
320   exim -DABC= ...
321
322 Previously, these items would have moved on to the next item on the command
323 line. To include spaces in a macro definition item, quotes must be used, in
324 which case you can also have spaces after -D and surrounding the equals. For
325 example:
326
327   exim '-D ABC = something' ...
328
329 3. The way that addresses that redirect to themselves are handled has been
330 changed, in order to fix an obscure bug. This should not cause any problems
331 except in the case of wanting to go back from a 4.11 (or later) release to an
332 earlier release. If there are undelivered messages on the spool that contain
333 addresses which redirect to themselves, and the redirected addresses have
334 already been delivered, you might get a duplicate delivery if you revert to an
335 earlier Exim.
336
337 4. The default way of looking up IP addresses for hosts in the manualroute and
338 queryprogram routers has been changed. If "byname" or "bydns" is explicitly
339 specified, there is no change, but if no method is specified, Exim now behaves
340 as follows:
341
342   First, a DNS lookup is done. If this yields anything other than
343   HOST_NOT_FOUND, that result is used. Otherwise, Exim goes on to try a call to
344   getipnodebyname() (or gethostbyname() on older systems) and the result of the
345   lookup is the result of that call.
346
347 This change has been made because it has been discovered that on some systems,
348 if a DNS lookup called via getipnodebyname() times out, HOST_NOT_FOUND is
349 returned instead of TRY_AGAIN. Thus, it is safest to try a DNS lookup directly
350 first, and only if that gives a definite "no such host" to try the local
351 function.
352
353 5. In fixing the minor security problem with pid_file_path, I have removed some
354 backwards-compatible (undocumented) code which was present to ease conversion
355 from Exim 3. In Exim 4, pid_file_path is a literal; in Exim 3 it was allowed to
356 contain "%s", which was replaced by the port number for daemons listening on
357 non-standard ports. In Exim 4, such daemons do not write a pid file. The
358 backwards compatibility feature was to replace "%s" by nothing if it occurred
359 in an Exim 4 setting of pid_file_path. The bug was in this code. I have solved
360 the problem by removing the backwards compatibility feature. Thus, if you still
361 have "%s" somewhere in a setting of pid_file_path, you should remove it.
362
363 6. There has been an extension to lsearch files. The keys in these files may
364 now be quoted in order to allow for whitespace and colons in them. This means
365 that if you were previously using keys that began with a doublequote, you will
366 now have to wrap them with extra quotes and escape the internal quotes. The
367 possibility that anybody is actually doing this seems extremely remote, but it
368 is documented just in case.
369
370
371 Version 4.10
372 ------------
373
374 The build-time parameter EXIWHAT_KILL_ARG has been renamed EXIWHAT_KILL_SIGNAL
375 to better reflect its function. The OS-specific files have been updated. Only
376 if you have explicitly set this in your Makefile (highly unlikely) do you need
377 to change anything.
378
379 ****