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