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