Added bool_lax{} expansion operator, which uses Router condition logic to
[exim.git] / doc / doc-txt / NewStuff
CommitLineData
6a8de854 1$Cambridge: exim/doc/doc-txt/NewStuff,v 1.174 2010/06/07 08:23:20 pdp Exp $
495ae4b0
PH
2
3New Features in Exim
4--------------------
5
38a0a95f
PH
6This file contains descriptions of new features that have been added to Exim.
7Before a formal release, there may be quite a lot of detail so that people can
8test from the snapshots or the CVS before the documentation is updated. Once
9the documentation is updated, this file is reduced to a short list.
10
7c6d71af 11
77bb000f
PP
12Version 4.73
13------------
14
15 1. A new main configuration option, "openssl_options", is available if Exim
16 is built with SSL support provided by OpenSSL. The option allows
17 administrators to specify OpenSSL options to be used on connections;
18 typically this is to set bug compatibility features which the OpenSSL
19 developers have not enabled by default. There may be security
20 consequences for certain options, so these should not be changed
21 frivolously.
22
a29e5231
PP
23 2. A new pipe transport option, "permit_coredumps", may help with problem
24 diagnosis in some scenarios. Note that Exim is typically installed as
25 a setuid binary, which on most OSes will inhibit coredumps by default,
26 so that safety mechanism would have to be overriden for this option to
27 be able to take effect.
28
8544e77a
PP
29 3. ClamAV 0.95 is now required for ClamAV support in Exim, unless
30 Local/Makefile sets: WITH_OLD_CLAMAV_STREAM=yes
31 Note that this switches Exim to use a new API ("INSTREAM") and a future
32 release of ClamAV will remove support for the old API ("STREAM").
33
34 The av_scanner option, when set to "clamd", now takes an optional third
35 part, "local", which causes Exim to pass a filename to ClamAV instead of
36 the file content. This is the same behaviour as when clamd is pointed at
37 a Unix-domain socket. For example:
38
39 av_scanner = clamd:192.0.2.3 1234:local
40
41 4. There is now a -bmalware option, restricted to admin users. This option
42 takes one parameter, a filename, and scans that file with Exim's
43 malware-scanning framework. This is intended purely as a debugging aid
44 to ensure that Exim's scanning is working, not to replace other tools.
45
83e029d5
PP
46 5. There is a new expansion operator, "reverse_ip", which will reverse IP
47 addresses; IPv4 into dotted quad, IPv6 into dotted nibble. Examples:
48
49 ${reverse_ip:192.0.2.4}
50 -> 4.2.0.192
51 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.3}
52 -> 3.0.2.0.0.0.0.c.d.c.b.a.1.0.0.0.9.0.0.0.2.4.c.0.8.b.d.0.1.0.0.2
53
ed7f7860
PP
54 6. There is a new ACL control called "debug", to enable debug logging.
55 This allows selective logging of certain incoming transactions within
56 production environments, with some care. It takes two options, "tag"
57 and "opts"; "tag" is included in the filename of the log and "opts"
58 is used as per the -d<options> command-line option. Examples, which
59 don't all make sense in all contexts:
60
61 control = debug
62 control = debug/tag=.$sender_host_address
63 control = debug/opts=+expand+acl
64 control = debug/tag=.$message_exim_id/opts=+expand
65
10385c15
PP
66 7. It has always been implicit in the design and the documentation that
67 "the Exim user" is not root. src/EDITME said that using root was
68 "very strongly discouraged". This is not enough to keep people from
69 shooting themselves in the foot in days when many don't configure Exim
70 themselves but via package build managers. The security consequences of
71 running various bits of network code are severe if there should be bugs in
72 them. As such, the Exim user may no longer be root. If configured
73 statically, Exim will refuse to build. If configured as ref:user then Exim
74 will exit shortly after start-up. If you must shoot yourself in the foot,
75 then henceforth you will have to maintain your own local patches to strip
76 the safeties off.
77
6a8de854
PP
78 8. There is a new expansion operator, bool_lax{}. Where bool{} uses the ACL
79 condition logic to determine truth/failure and will fail to expand many
80 strings, bool_lax{} uses the router condition logic, where most strings
81 do evaluate true.
82 Note: bool{00} is false, bool_lax{00} is true.
83
84 9. Routers now support multiple "condition" tests,
532be449 85
77bb000f 86
3fc596e4
NM
87Version 4.72
88------------
89
b26eacf1
PP
90 1. TWO SECURITY FIXES: one relating to mail-spools which are globally
91 writable, the other to locking of MBX folders (not mbox).
92
93 2. MySQL stored procedures are now supported.
94
95 3. The dkim_domain transport option is now a list, not a single string, and
96 messages will be signed for each element in the list (discarding
97 duplicates).
98
99 4. The 4.70 release unexpectedly changed the behaviour of dnsdb TXT lookups
100 in the presence of multiple character strings within the RR. Prior to 4.70,
101 only the first string would be returned. The dnsdb lookup now, by default,
102 preserves the pre-4.70 semantics, but also now takes an extended output
8f425947
PP
103 separator specification. The separator can be followed by a semicolon, to
104 concatenate the individual text strings together with no join character,
105 or by a comma and a second separator character, in which case the text
106 strings within a TXT record are joined on that second character.
107 Administrators are reminded that DNS provides no ordering guarantees
108 between multiple records in an RRset. For example:
b26eacf1
PP
109
110 foo.example. IN TXT "a" "b" "c"
111 foo.example. IN TXT "d" "e" "f"
112
113 ${lookup dnsdb{>/ txt=foo.example}} -> "a/d"
114 ${lookup dnsdb{>/; txt=foo.example}} -> "def/abc"
8f425947 115 ${lookup dnsdb{>/,+ txt=foo.example}} -> "a+b+c/d+e+f"
b26eacf1 116
3fc596e4 117
f33253cc
NM
118Version 4.70 / 4.71
119-------------------
65a7d8c3 120
7c6d71af 121 1. Native DKIM support without an external library.
a8c8d6b5
JJ
122 (Note that if no action to prevent it is taken, a straight upgrade will
123 result in DKIM verification of all signed incoming emails. See spec
124 for details on conditionally disabling)
7c6d71af
NM
125
126 2. Experimental DCC support via dccifd (contributed by Wolfgang Breyha).
65a7d8c3 127
f33253cc 128 3. There is now a bool{} expansion condition which maps certain strings to
7d9f747b 129 true/false condition values (most likely of use in conjunction with the
f33253cc
NM
130 and{} expansion operator).
131
132 4. The $spam_score, $spam_bar and $spam_report variables are now available
133 at delivery time.
134
135 5. exim -bP now supports "macros", "macro_list" or "macro MACRO_NAME" as
136 options, provided that Exim is invoked by an admin_user.
137
138 6. There is a new option gnutls_compat_mode, when linked against GnuTLS,
139 which increases compatibility with older clients at the cost of decreased
140 security. Don't set this unless you need to support such clients.
141
142 7. There is a new expansion operator, ${randint:...} which will produce a
143 "random" number less than the supplied integer. This randomness is
144 not guaranteed to be cryptographically strong, but depending upon how
145 Exim was built may be better than the most naive schemes.
146
147 8. Exim now explicitly ensures that SHA256 is available when linked against
148 OpenSSL.
149
150 9. The transport_filter_timeout option now applies to SMTP transports too.
151
65a7d8c3 152
7d9f747b
PP
153Version 4.69
154------------
155
156 1. Preliminary DKIM support in Experimental.
157
158
2b85bce7
PH
159Version 4.68
160------------
161
162 1. The body_linecount and body_zerocount C variables are now exported in the
163 local_scan API.
164
93655c46
PH
165 2. When a dnslists lookup succeeds, the key that was looked up is now placed
166 in $dnslist_matched. When the key is an IP address, it is not reversed in
167 this variable (though it is, of course, in the actual lookup). In simple
168 cases, for example:
169
170 deny dnslists = spamhaus.example
171
172 the key is also available in another variable (in this case,
173 $sender_host_address). In more complicated cases, however, this is not
174 true. For example, using a data lookup might generate a dnslists lookup
175 like this:
176
177 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
178
179 If this condition succeeds, the value in $dnslist_matched might be
180 192.168.6.7 (for example).
181
6c512171
PH
182 3. Authenticators now have a client_condition option. When Exim is running as
183 a client, it skips an authenticator whose client_condition expansion yields
184 "0", "no", or "false". This can be used, for example, to skip plain text
185 authenticators when the connection is not encrypted by a setting such as:
186
187 client_condition = ${if !eq{$tls_cipher}{}}
188
189 Note that the 4.67 documentation states that $tls_cipher contains the
190 cipher used for incoming messages. In fact, during SMTP delivery, it
191 contains the cipher used for the delivery. The same is true for
192 $tls_peerdn.
193
a96603a0
PH
194 4. There is now a -Mvc <message-id> option, which outputs a copy of the
195 message to the standard output, in RFC 2822 format. The option can be used
196 only by an admin user.
197
8f240103
PH
198 5. There is now a /noupdate option for the ratelimit ACL condition. It
199 computes the rate and checks the limit as normal, but it does not update
200 the saved data. This means that, in relevant ACLs, it is possible to lookup
201 the existence of a specified (or auto-generated) ratelimit key without
202 incrementing the ratelimit counter for that key.
203
204 In order for this to be useful, another ACL entry must set the rate
205 for the same key somewhere (otherwise it will always be zero).
206
207 Example:
208
209 acl_check_connect:
210 # Read the rate; if it doesn't exist or is below the maximum
211 # we update it below
212 deny ratelimit = 100 / 5m / strict / noupdate
213 log_message = RATE: $sender_rate / $sender_rate_period \
214 (max $sender_rate_limit)
215
216 [... some other logic and tests...]
217
218 warn ratelimit = 100 / 5m / strict / per_cmd
219 log_message = RATE UPDATE: $sender_rate / $sender_rate_period \
220 (max $sender_rate_limit)
221 condition = ${if le{$sender_rate}{$sender_rate_limit}}
222
223 accept
224
d677b2f2
PH
225 6. The variable $max_received_linelength contains the number of bytes in the
226 longest line that was received as part of the message, not counting the
227 line termination character(s).
228
d52120f2
PH
229 7. Host lists can now include +ignore_defer and +include_defer, analagous to
230 +ignore_unknown and +include_unknown. These options should be used with
231 care, probably only in non-critical host lists such as whitelists.
232
8669f003
PH
233 8. There's a new option called queue_only_load_latch, which defaults true.
234 If set false when queue_only_load is greater than zero, Exim re-evaluates
235 the load for each incoming message in an SMTP session. Otherwise, once one
236 message is queued, the remainder are also.
237
4f054c63 238 9. There is a new ACL, specified by acl_smtp_notquit, which is run in most
8f128379
PH
239 cases when an SMTP session ends without sending QUIT. However, when Exim
240 itself is is bad trouble, such as being unable to write to its log files,
241 this ACL is not run, because it might try to do things (such as write to
242 log files) that make the situation even worse.
243
244 Like the QUIT ACL, this new ACL is provided to make it possible to gather
245 statistics. Whatever it returns (accept or deny) is immaterial. The "delay"
246 modifier is forbidden in this ACL.
247
248 When the NOTQUIT ACL is running, the variable $smtp_notquit_reason is set
249 to a string that indicates the reason for the termination of the SMTP
250 connection. The possible values are:
251
252 acl-drop Another ACL issued a "drop" command
253 bad-commands Too many unknown or non-mail commands
254 command-timeout Timeout while reading SMTP commands
255 connection-lost The SMTP connection has been lost
256 data-timeout Timeout while reading message data
257 local-scan-error The local_scan() function crashed
258 local-scan-timeout The local_scan() function timed out
259 signal-exit SIGTERM or SIGINT
260 synchronization-error SMTP synchronization error
261 tls-failed TLS failed to start
262
263 In most cases when an SMTP connection is closed without having received
264 QUIT, Exim sends an SMTP response message before actually closing the
265 connection. With the exception of acl-drop, the default message can be
266 overridden by the "message" modifier in the NOTQUIT ACL. In the case of a
267 "drop" verb in another ACL, it is the message from the other ACL that is
268 used.
269
b7670459
PH
27010. For MySQL and PostgreSQL lookups, it is now possible to specify a list of
271 servers with individual queries. This is done by starting the query with
272 "servers=x:y:z;", where each item in the list may take one of two forms:
273
274 (1) If it is just a host name, the appropriate global option (mysql_servers
275 or pgsql_servers) is searched for a host of the same name, and the
276 remaining parameters (database, user, password) are taken from there.
277
278 (2) If it contains any slashes, it is taken as a complete parameter set.
279
280 The list of servers is used in exactly the same was as the global list.
281 Once a connection to a server has happened and a query has been
282 successfully executed, processing of the lookup ceases.
283
284 This feature is intended for use in master/slave situations where updates
285 are occurring, and one wants to update a master rather than a slave. If the
286 masters are in the list for reading, you might have:
287
288 mysql_servers = slave1/db/name/pw:slave2/db/name/pw:master/db/name/pw
289
290 In an updating lookup, you could then write
291
292 ${lookup mysql{servers=master; UPDATE ...}
293
294 If, on the other hand, the master is not to be used for reading lookups:
295
296 pgsql_servers = slave1/db/name/pw:slave2/db/name/pw
297
298 you can still update the master by
299
300 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...}
301
ddea74fa
PH
30211. The message_body_newlines option (default FALSE, for backwards
303 compatibility) can be used to control whether newlines are present in
304 $message_body and $message_body_end. If it is FALSE, they are replaced by
305 spaces.
306
2b85bce7 307
b4ed4da0
PH
308Version 4.67
309------------
310
311 1. There is a new log selector called smtp_no_mail, which is not included in
312 the default setting. When it is set, a line is written to the main log
313 whenever an accepted SMTP connection terminates without having issued a
4aa45c31 314 MAIL command.
b4ed4da0 315
431b7361 316 2. When an item in a dnslists list is followed by = and & and a list of IP
4aa45c31
PH
317 addresses, the behaviour was not clear when the lookup returned more than
318 one IP address. This has been solved by the addition of == and =& for "all"
93655c46 319 rather than the default "any" matching.
431b7361 320
4aa45c31
PH
321 3. Up till now, the only control over which cipher suites GnuTLS uses has been
322 for the cipher algorithms. New options have been added to allow some of the
323 other parameters to be varied.
431b7361 324
4aa45c31
PH
325 4. There is a new compile-time option called ENABLE_DISABLE_FSYNC. When it is
326 set, Exim compiles a runtime option called disable_fsync.
431b7361 327
4aa45c31 328 5. There is a new variable called $smtp_count_at_connection_start.
431b7361 329
4aa45c31 330 6. There's a new control called no_pipelining.
cf8b11a5 331
41c7c167 332 7. There are two new variables called $sending_ip_address and $sending_port.
4aa45c31 333 These are set whenever an SMTP connection to another host has been set up.
41c7c167
PH
334
335 8. The expansion of the helo_data option in the smtp transport now happens
4aa45c31 336 after the connection to the server has been made.
41c7c167 337
9c57cbc0 338 9. There is a new expansion operator ${rfc2047d: that decodes strings that
4aa45c31 339 are encoded as per RFC 2047.
9c57cbc0 340
f3f065bb
PH
34110. There is a new log selector called "pid", which causes the current process
342 id to be added to every log line, in square brackets, immediately after the
343 time and date.
344
047bdd8c 34511. Exim has been modified so that it flushes SMTP output before implementing
4c590bd1
PH
346 a delay in an ACL. It also flushes the output before performing a callout,
347 as this can take a substantial time. These behaviours can be disabled by
348 obeying control = no_delay_flush or control = no_callout_flush,
4aa45c31 349 respectively, at some earlier stage of the connection.
047bdd8c 350
0ce9abe6 35112. There are two new expansion conditions that iterate over a list. They are
4aa45c31 352 called forany and forall.
0ce9abe6 353
0e22dfd1
PH
35413. There's a new global option called dsn_from that can be used to vary the
355 contents of From: lines in bounces and other automatically generated
356 messages ("delivery status notifications" - hence the name of the option).
0e22dfd1 357
4aa45c31 35814. The smtp transport has a new option called hosts_avoid_pipelining.
c51b8e75 359
75b1493f 36015. By default, exigrep does case-insensitive matches. There is now a -I option
4aa45c31 361 that makes it case-sensitive.
29f89cad 362
4aa45c31
PH
36316. A number of new features ("addresses", "map", "filter", and "reduce") have
364 been added to string expansions to make it easier to process lists of
365 items, typically addresses.
29f89cad 366
c3611384
PH
36717. There's a new ACL modifier called "continue". It does nothing of itself,
368 and processing of the ACL always continues with the next condition or
369 modifier. It is provided so that the side effects of expanding its argument
4aa45c31 370 can be used.
c3611384 371
ec95d1a6 37218. It is now possible to use newline and other control characters (those with
4aa45c31 373 values less than 32, plus DEL) as separators in lists.
ec95d1a6 374
b2d5182b
PH
37519. The exigrep utility now has a -v option, which inverts the matching
376 condition.
377
c456d9bb 37820. The host_find_failed option in the manualroute router can now be set to
4aa45c31 379 "ignore".
c456d9bb 380
b4ed4da0
PH
381
382Version 4.66
383------------
384
385No new features were added to 4.66.
386
387
388Version 4.65
389------------
390
391No new features were added to 4.65.
392
38a0a95f
PH
393
394Version 4.64
395------------
396
af561417
PH
397 1. ACL variables can now be given arbitrary names, as long as they start with
398 "acl_c" or "acl_m" (for connection variables and message variables), are at
399 least six characters long, with the sixth character being either a digit or
883335dc 400 an underscore.
af561417
PH
401
402 2. There is a new ACL modifier called log_reject_target. It makes it possible
883335dc 403 to specify which logs are used for messages about ACL rejections.
af561417
PH
404
405 3. There is a new authenticator called "dovecot". This is an interface to the
406 authentication facility of the Dovecot POP/IMAP server, which can support a
883335dc 407 number of authentication methods.
af561417
PH
408
409 4. The variable $message_headers_raw provides a concatenation of all the
410 messages's headers without any decoding. This is in contrast to
411 $message_headers, which does RFC2047 decoding on the header contents.
412
883335dc
PH
413 5. In a DNS black list, if two domain names, comma-separated, are given, the
414 second is used first to do an initial check, making use of any IP value
415 restrictions that are set. If there is a match, the first domain is used,
416 without any IP value restrictions, to get the TXT record.
af561417 417
883335dc 418 6. All authenticators now have a server_condition option.
af561417
PH
419
420 7. There is a new command-line option called -Mset. It is useful only in
421 conjunction with -be (that is, when testing string expansions). It must be
422 followed by a message id; Exim loads the given message from its spool
883335dc 423 before doing the expansions.
af561417
PH
424
425 8. Another similar new command-line option is called -bem. It operates like
883335dc
PH
426 -be except that it must be followed by the name of a file that contains a
427 message.
af561417
PH
428
429 9. When an address is delayed because of a 4xx response to a RCPT command, it
430 is now the combination of sender and recipient that is delayed in
883335dc 431 subsequent queue runs until its retry time is reached.
af561417
PH
432
43310. Unary negation and the bitwise logical operators and, or, xor, not, and
883335dc 434 shift, have been added to the eval: and eval10: expansion items.
48c7f9e2 435
194cc0e4
PH
43611. The variables $interface_address and $interface_port have been renamed
437 as $received_ip_address and $received_port, to make it clear that they
438 relate to message reception rather than delivery. (The old names remain
439 available for compatibility.)
440
883335dc
PH
44112. The "message" modifier can now be used on "accept" and "discard" acl verbs
442 to vary the message that is sent when an SMTP command is accepted.
4e88a19f 443
495ae4b0 444
4608d683
PH
445Version 4.63
446------------
447
4481. There is a new Boolean option called filter_prepend_home for the redirect
38a0a95f 449 router.
4608d683 450
45b91596
PH
4512. There is a new acl, set by acl_not_smtp_start, which is run right at the
452 start of receiving a non-SMTP message, before any of the message has been
38a0a95f 453 read.
45b91596 454
a5bd321b
PH
4553. When an SMTP error message is specified in a "message" modifier in an ACL,
456 or in a :fail: or :defer: message in a redirect router, Exim now checks the
38a0a95f 457 start of the message for an SMTP error code.
a5bd321b 458
6ec97b1b 4594. There is a new parameter for LDAP lookups called "referrals", which takes
38a0a95f 460 one of the settings "follow" (the default) or "nofollow".
6ec97b1b 461
e22ca4ac
JJ
4625. Version 20070721.2 of exipick now included, offering these new options:
463 --reverse
464 After all other sorting options have bee processed, reverse order
465 before displaying messages (-R is synonym).
466 --random
467 Randomize order of matching messages before displaying.
468 --size
469 Instead of displaying the matching messages, display the sum
470 of their sizes.
471 --sort <variable>[,<variable>...]
472 Before displaying matching messages, sort the messages according to
473 each messages value for each variable.
474 --not
475 Negate the value for every test (returns inverse output from the
476 same criteria without --not).
477
4608d683 478
1cce3af8
PH
479Version 4.62
480------------
481
4821. The ${readsocket expansion item now supports Internet domain sockets as well
483 as Unix domain sockets. If the first argument begins "inet:", it must be of
484 the form "inet:host:port". The port is mandatory; it may be a number or the
485 name of a TCP port in /etc/services. The host may be a name, or it may be an
486 IP address. An ip address may optionally be enclosed in square brackets.
487 This is best for IPv6 addresses. For example:
488
489 ${readsocket{inet:[::1]:1234}{<request data>}...
490
491 Only a single host name may be given, but if looking it up yield more than
492 one IP address, they are each tried in turn until a connection is made. Once
493 a connection has been made, the behaviour is as for ${readsocket with a Unix
494 domain socket.
495
f7fd3850
PH
4962. If a redirect router sets up file or pipe deliveries for more than one
497 incoming address, and the relevant transport has batch_max set greater than
498 one, a batch delivery now occurs.
499
d6629cdc
PH
5003. The appendfile transport has a new option called maildirfolder_create_regex.
501 Its value is a regular expression. For a maildir delivery, this is matched
502 against the maildir directory; if it matches, Exim ensures that a
503 maildirfolder file is created alongside the new, cur, and tmp directories.
504
1cce3af8 505
7e66e54d
PH
506Version 4.61
507------------
508
4f578862
PH
509The documentation is up-to-date for the 4.61 release. Major new features since
510the 4.60 release are:
511
512. An option called disable_ipv6, to disable the use of IPv6 completely.
513
514. An increase in the number of ACL variables to 20 of each type.
515
516. A change to use $auth1, $auth2, and $auth3 in authenticators instead of $1,
517 $2, $3, (though those are still set) because the numeric variables get used
518 for other things in complicated expansions.
519
843a41e8 520. The default for rfc1413_query_timeout has been changed from 30s to 5s.
4f578862
PH
521
522. It is possible to use setclassresources() on some BSD OS to control the
523 resources used in pipe deliveries.
524
525. A new ACL modifier called add_header, which can be used with any verb.
526
527. More errors are detectable in retry rules.
528
529There are a number of other additions too.
71fafd95 530
7e66e54d 531
425ae40f 532Version 4.60
b5aea5e1
PH
533------------
534
425ae40f
PH
535The documentation is up-to-date for the 4.60 release. Major new features since
536the 4.50 release are:
1a46a8c5 537
425ae40f 538. Support for SQLite.
1a46a8c5 539
425ae40f 540. Support for IGNOREQUOTA in LMTP.
1a46a8c5 541
425ae40f 542. Extensions to the "submission mode" features.
1a46a8c5 543
425ae40f 544. Support for Client SMTP Authorization (CSA).
1a46a8c5 545
425ae40f 546. Support for ratelimiting hosts and users.
b5aea5e1 547
425ae40f 548. New expansion items to help with the BATV "prvs" scheme.
b5aea5e1 549
425ae40f 550. A "match_ip" condition, that matches an IP address against a list.
35edf2ff 551
425ae40f 552There are many more minor changes.
495ae4b0
PH
553
554****