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