-$Cambridge: exim/doc/doc-txt/NewStuff,v 1.57 2005/08/01 13:20:28 ph10 Exp $
+$Cambridge: exim/doc/doc-txt/NewStuff,v 1.145 2007/03/13 15:32:47 ph10 Exp $
New Features in Exim
--------------------
-This file contains descriptions of new features that have been added to Exim,
-but have not yet made it into the main manual (which is most conveniently
-updated when there is a relatively large batch of changes). The doc/ChangeLog
-file contains a listing of all changes, including bug fixes.
-
-Exim version 4.53
------------------
-
-TK/01 Added the "success_on_redirect" address verification option. When an
- address generates new addresses during routing, Exim will abort
- verification with "success" when more than one address has been
- generated, but continue to verify a single new address. The latter
- does not happen when the new "success_on_redirect" option is set, like
-
- require verify = recipient/success_on_redirect/callout=10s
-
- In that case, verification will succeed when a router generates a new
- address.
-
-PH/01 Support for SQLite database lookups has been added. This is another
- query-style lookup, but it is slightly different from the others because
- a file name is required in addition to the SQL query. This is because an
- SQLite database is a single file and there is no daemon as in other SQL
- databases. The interface to Exim requires the name of the file, as an
- absolute path, to be given at the start of the query. It is separated
- from the query by white space. This means that the path name cannot
- contain white space. Here is a lookup expansion example:
-
- ${lookup sqlite {/some/thing/sqlitedb \
- select name from aliases where id='ph10';}}
-
- In a list, the syntax is similar. For example:
-
- domainlist relay_domains = sqlite;/some/thing/sqlitedb \
- select * from relays where ip='$sender_host_address';
-
- The only character affected by the ${quote_sqlite: operator is a single
- quote, which it doubles.
-
- Note that you must set LOOKUP_SQLITE=yes in Local/Makefile in order to
- obtain SQLite support, and you will also need to add -lsqlite3 to the
- EXTRALIBS setting. And of course, you have to install SQLite on your
- host first.
-
-
-Exim version 4.52
------------------
-
-TF/01 Support for checking Client SMTP Authorization has been added. CSA is a
- system which allows a site to advertise which machines are and are not
- permitted to send email. This is done by placing special SRV records in
- the DNS, which are looked up using the client's HELO domain. At this
- time CSA is still an Internet-Draft.
-
- Client SMTP Authorization checks are performed by the ACL condition
- verify=csa. This will fail if the client is not authorized. If there is
- a DNS problem, or if no valid CSA SRV record is found, or if the client
- is authorized, the condition succeeds. These three cases can be
- distinguished using the expansion variable $csa_status, which can take
- one of the values "fail", "defer", "unknown", or "ok". The condition
- does not itself defer because that would be likely to cause problems
- for legitimate email.
-
- The error messages produced by the CSA code include slightly more
- detail. If $csa_status is "defer" this may be because of problems
- looking up the CSA SRV record, or problems looking up the CSA target
- address record. There are four reasons for $csa_status being "fail":
- the client's host name is explicitly not authorized; the client's IP
- address does not match any of the CSA target IP addresses; the client's
- host name is authorized but it has no valid target IP addresses (e.g.
- the target's addresses are IPv6 and the client is using IPv4); or the
- client's host name has no CSA SRV record but a parent domain has
- asserted that all subdomains must be explicitly authorized.
-
- The verify=csa condition can take an argument which is the domain to
- use for the DNS query. The default is verify=csa/$sender_helo_name.
-
- This implementation includes an extension to CSA. If the query domain
- is an address literal such as [192.0.2.95], or if it is a bare IP
- address, Exim will search for CSA SRV records in the reverse DNS as if
- the HELO domain was e.g. 95.2.0.192.in-addr.arpa. Therefore it is
- meaningful to say, for example, verify=csa/$sender_host_address - in
- fact, this is the check that Exim performs if the client does not say
- HELO. This extension can be turned off by setting the main
- configuration option dns_csa_use_reverse = false.
-
- If a CSA SRV record is not found for the domain itself, then a search
- is performed through its parent domains for a record which might be
- making assertions about subdomains. The maximum depth of this search is
- limited using the main configuration option dns_csa_search_limit, which
- takes the value 5 by default. Exim does not look for CSA SRV records in
- a top level domain, so the default settings handle HELO domains as long
- as seven (hostname.five.four.three.two.one.com) which encompasses the
- vast majority of legitimate HELO domains.
-
- The dnsdb lookup also has support for CSA. Although dnsdb already
- supports SRV lookups, this is not sufficient because of the extra
- parent domain search behaviour of CSA, and (as with PTR lookups)
- dnsdb also turns IP addresses into lookups in the reverse DNS space.
- The result of ${lookup dnsdb {csa=$sender_helo_name} } has two
- space-separated fields: an authorization code and a target host name.
- The authorization code can be "Y" for yes, "N" for no, "X" for explicit
- authorization required but absent, or "?" for unknown.
-
-PH/01 The amount of output produced by the "make" process has been reduced,
- because the compile lines are often rather long, making it all pretty
- unreadable. The new style is along the lines of the 2.6 Linux kernel:
- just a short line for each module that is being compiled or linked.
- However, it is still possible to get the full output, by calling "make"
- like this:
-
- FULLECHO='' make -e
-
- The value of FULLECHO defaults to "@", the flag character that suppresses
- command reflection in "make". When you ask for the full output, it is
- given in addition to the the short output.
-
-TF/02 There have been two changes concerned with submission mode:
-
- Until now submission mode always left the return path alone, whereas
- locally-submitted messages from untrusted users have the return path
- fixed to the user's email address. Submission mode now fixes the return
- path to the same address as is used to create the Sender: header. If
- /sender_retain is specified then both the Sender: header and the return
- path are left alone.
-
- Note that the changes caused by submission mode take effect after the
- predata ACL. This means that any sender checks performed before the
- fix-ups will use the untrusted sender address specified by the user, not
- the trusted sender address specified by submission mode. Although this
- might be slightly unexpected, it does mean that you can configure ACL
- checks to spot that a user is trying to spoof another's address, for
- example.
-
- There is also a new /name= option for submission mode which allows you
- to specify the user's full name to be included in the Sender: header.
- For example:
-
- accept authenticated = *
- control = submission/name=${lookup {$authenticated_id} \
- lsearch {/etc/exim/namelist} }
-
- The namelist file contains entries like
-
- fanf: Tony Finch
-
- And the resulting Sender: header looks like
-
- Sender: Tony Finch <fanf@exim.org>
-
-TF/03 The control = fakereject ACL modifier now has a fakedefer counterpart,
- which works in exactly the same way except it causes a fake SMTP 450
- response after the message data instead of a fake SMTP 550 response.
- You must take care when using fakedefer because it will cause messages
- to be duplicated when the sender retries. Therefore you should not use
- fakedefer if the message will be delivered normally.
-
-TF/04 There is a new ratelimit ACL condition which can be used to measure
- and control the rate at which clients can send email. This is more
- powerful than the existing smtp_ratelimit_* options, because those
- options only control the rate of commands in a single SMTP session,
- whereas the new ratelimit condition works across all connections
- (concurrent and sequential) to the same host.
-
- The syntax of the ratelimit condition is:
-
- ratelimit = <m> / <p> / <options> / <key>
-
- If the average client sending rate is less than m messages per time
- period p then the condition is false, otherwise it is true.
-
- The parameter p is the smoothing time constant, in the form of an Exim
- time interval e.g. 8h for eight hours. A larger time constant means it
- takes Exim longer to forget a client's past behaviour. The parameter m is
- the maximum number of messages that a client can send in a fast burst. By
- increasing both m and p but keeping m/p constant, you can allow a client
- to send more messages in a burst without changing its overall sending
- rate limit. Conversely, if m and p are both small then messages must be
- sent at an even rate.
-
- The key is used to look up the data used to calcluate the client's
- average sending rate. This data is stored in a database maintained by
- Exim in its spool directory alongside the retry database etc. For
- example, you can limit the sending rate of each authenticated user,
- independent of the computer they are sending from, by setting the key
- to $authenticated_id. The default key is $sender_host_address.
- Internally, Exim includes the smoothing constant p and the options in
- the lookup key because they alter the meaning of the stored data.
- This is not true for the limit m, so you can alter the configured
- maximum rate and Exim will still remember clients' past behaviour,
- but if you alter the other ratelimit parameters Exim will effectively
- forget their past behaviour.
-
- Each ratelimit condition can have up to two options. The first option
- specifies what Exim measures the rate of, and the second specifies how
- Exim handles excessively fast clients.
-
- The per_mail option means that it measures the client's rate of sending
- messages. This is the default if none of the per_* options is specified.
-
- The per_conn option means that it measures the client's connection rate.
-
- The per_byte option limits the sender's email bandwidth. Note that it
- is best to use this option in the DATA ACL; if it is used in an earlier
- ACL it relies on the SIZE parameter on the MAIL command, which may be
- inaccurate or completely missing. You can follow the limit m in the
- configuration with K, M, or G to specify limits in kilobytes,
- megabytes, or gigabytes respectively.
-
- The per_cmd option means that Exim recomputes the rate every time the
- condition is processed, which can be used to limit the SMTP command rate.
- The alias per_rcpt is provided for use in the RCPT ACL instead of per_cmd
- to make it clear that the effect is to limit the rate at which recipients
- are accepted. Note that in this case the rate limiting engine will see a
- message with many recipients as a large high-speed burst.
-
- If a client's average rate is greater than the maximum, the rate
- limiting engine can react in two possible ways, depending on the
- presence of the strict or leaky options. This is independent of the
- other counter-measures (e.g. rejecting the message) that may be
- specified by the rest of the ACL. The default mode is leaky, which
- avoids a sender's over-aggressive retry rate preventing it from getting
- any email through.
-
- The strict option means that the client's recorded rate is always
- updated. The effect of this is that Exim measures the client's average
- rate of attempts to send email, which can be much higher than the
- maximum. If the client is over the limit it will be subjected to
- counter-measures until it slows down below the maximum rate.
-
- The leaky option means that the client's recorded rate is not updated
- if it is above the limit. The effect of this is that Exim measures the
- client's average rate of successfully sent email, which cannot be
- greater than the maximum. If the client is over the limit it will
- suffer some counter-measures, but it will still be able to send email
- at the configured maximum rate, whatever the rate of its attempts.
-
- As a side-effect, the ratelimit condition will set the expansion
- variables $sender_rate containing the client's computed rate,
- $sender_rate_limit containing the configured value of m, and
- $sender_rate_period containing the configured value of p.
-
- Exim's other ACL facilities are used to define what counter-measures
- are taken when the rate limit is exceeded. This might be anything from
- logging a warning (e.g. while measuring existing sending rates in order
- to define our policy), through time delays to slow down fast senders,
- up to rejecting the message. For example,
-
- # Log all senders' rates
- warn
- ratelimit = 0 / 1h / strict
- log_message = \
- Sender rate $sender_rate > $sender_rate_limit / $sender_rate_period
-
- # Slow down fast senders
- warn
- ratelimit = 100 / 1h / per_rcpt / strict
- delay = ${eval: 10 * ($sender_rate - $sender_rate_limit) }
-
- # Keep authenticated users under control
- deny
- ratelimit = 100 / 1d / strict / $authenticated_id
-
- # System-wide rate limit
- defer
- message = Sorry, too busy. Try again later.
- ratelimit = 10 / 1s / $primary_hostname
-
- # Restrict incoming rate from each host, with a default rate limit
- # set using a macro and special cases looked up in a table.
- defer
- message = Sender rate $sender_rate exceeds \
- $sender_rate_limit messages per $sender_rate_period
- ratelimit = ${lookup {$sender_host_address} \
- cdb {DB/ratelimits.cdb} \
- {$value} {RATELIMIT} }
-
- Warning: if you have a busy server with a lot of ratelimit tests,
- especially with the per_rcpt option, you may suffer from a performance
- bottleneck caused by locking on the ratelimit hints database. Apart from
- making your ACLs less complicated, you can reduce the problem by using a
- RAM disk for Exim's hints directory, /var/spool/exim/db/. However this
- means that Exim will lose its hints data after a reboot (including retry
- hints, the callout cache, and ratelimit data).
-
-TK/01 Added an 'spf' lookup type that will return an SPF result for a given
- email address (the key) and an IP address (the database):
-
- ${lookup {tom@duncanthrax.net} spf{217.115.139.137}}
-
- The lookup will return the same result strings as they can appear in
- $spf_result (pass,fail,softfail,neutral,none,err_perm,err_temp). The
- lookup is armored in EXPERIMENTAL_SPF. Currently, only IPv4 addresses
- are supported.
-
- Patch submitted by Chris Webb <chris@arachsys.com>.
-
-PH/02 There's a new verify callout option, "fullpostmaster", which first acts
- as "postmaster" and checks the recipient <postmaster@domain>. If that
- fails, it tries just <postmaster>, without a domain, in accordance with
- the specification in RFC 2821.
-
-PH/03 The action of the auto_thaw option has been changed. It no longer applies
- to frozen bounce messages.
-
-TK/02 There are two new expansion items to help with the implementation of
- the BATV "prvs" scheme in an Exim configuration:
-
-
- ${prvs {<ADDRESS>}{<KEY>}{[KEYNUM]}}
-
- The "prvs" expansion item takes three arguments: A qualified RFC2821
- email address, a key and an (optional) key number. All arguments are
- expanded before being used, so it is easily possible to lookup a key
- and key number using the address as the lookup key. The key number is
- optional and defaults to "0". The item will expand to a "prvs"-signed
- email address, to be typically used with the "return_path" option on
- a smtp transport. The decision if BATV should be used with a given
- sender/recipient pair should be done on router level, to avoid having
- to set "max_rcpt = 1" on the transport.
-
-
- ${prvscheck {<ADDRESS>}{<SECRET>}{<RETURN_STRING>}}
-
- The "prvscheck" expansion item takes three arguments. Argument 1 is
- expanded first. When the expansion does not yield a SYNTACTICALLY
- valid "prvs"-scheme address, the whole "prvscheck" item expands to
- the empty string. If <ADDRESS> is a "prvs"-encoded address after
- expansion, two expansion variables are set up:
+This file contains descriptions of new features that have been added to Exim.
+Before a formal release, there may be quite a lot of detail so that people can
+test from the snapshots or the CVS before the documentation is updated. Once
+the documentation is updated, this file is reduced to a short list.
- $prvscheck_address Contains the "prvs"-decoded version of
- the address from argument 1.
+Version 4.67
+------------
+
+ 1. There is a new log selector called smtp_no_mail, which is not included in
+ the default setting. When it is set, a line is written to the main log
+ whenever an accepted SMTP connection terminates without having issued a
+ MAIL command. This includes both the case when the connection is dropped,
+ and the case when QUIT is used. Note that it does not include cases where
+ the connection is rejected right at the start (by an ACL, or because there
+ are too many connections, or whatever). These cases already have their own
+ log lines.
+
+ The log line that is written contains the identity of the client in the
+ usual way, followed by D= and a time, which records the duration of the
+ connection. If the connection was authenticated, this fact is logged
+ exactly as it is for an incoming message, with an A= item. If the
+ connection was encrypted, CV=, DN=, and X= items may appear as they do for
+ an incoming message, controlled by the same logging options.
+
+ Finally, if any SMTP commands were issued during the connection, a C= item
+ is added to the line, listing the commands that were used. For example,
+
+ C=EHLO,QUIT
+
+ shows that the client issued QUIT straight after EHLO. If there were fewer
+ than 20 commands, they are all listed. If there were more than 20 commands,
+ the last 20 are listed, preceded by "...". However, with the default
+ setting of 10 for smtp_accep_max_nonmail, the connection will in any case
+ be aborted before 20 non-mail commands are processed.
+
+ 2. When an item in a dnslists list is followed by = and & and a list of IP
+ addresses, in order to restrict the match to specific results from the DNS
+ lookup, the behaviour was not clear when the lookup returned more than one
+ IP address. For example, consider the condition
+
+ dnslists = a.b.c=127.0.0.1
+
+ What happens if the DNS lookup for the incoming IP address yields both
+ 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
+ condition true because at least one given value was found, or is it false
+ because at least one of the found values was not listed? And how does this
+ affect negated conditions?
+
+ The behaviour of = and & has not been changed; however, the text below
+ documents it more clearly. In addition, two new additional conditions (==
+ and =&) have been added, to permit the "other" behaviour to be configured.
+
+ A DNS lookup may yield more than one record. Thus, the result of the lookup
+ for a dnslists check may yield more than one IP address. The question then
+ arises as to whether all the looked up addresses must be listed, or whether
+ just one is good enough. Both possibilities are provided for:
+
+ . If = or & is used, the condition is true if any one of the looked up
+ IP addresses matches one of the listed addresses. Consider:
+
+ dnslists = a.b.c=127.0.0.1
+
+ If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
+ true because 127.0.0.1 matches.
+
+ . If == or =& is used, the condition is true only if every one of the
+ looked up IP addresses matches one of the listed addresses. Consider:
+
+ dnslists = a.b.c==127.0.0.1
+
+ If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
+ false because 127.0.0.2 is not listed. You would need to have
+
+ dnslists = a.b.c==127.0.0.1,127.0.0.2
+
+ for the condition to be true.
+
+ When ! is used to negate IP address matching, it inverts the result, giving
+ the precise opposite of the behaviour above. Thus:
+
+ . If != or !& is used, the condition is true if none of the looked up IP
+ addresses matches one of the listed addresses. Consider:
+
+ dnslists = a.b.c!&0.0.0.1
+
+ If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
+ false because 127.0.0.1 matches.
+
+ . If !== or !=& is used, the condition is true there is at least one looked
+ up IP address that does not match. Consider:
+
+ dnslists = a.b.c!=&0.0.0.1
+
+ If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
+ true, because 127.0.0.2 does not match. You would need to have
+
+ dnslists = a.b.c!=&0.0.0.1,0.0.0.2
+
+ for the condition to be false.
+
+ When the DNS lookup yields only a single IP address, there is no difference
+ between = and == and between & and =&.
+
+ 3. Up till now, the only control over which cipher suites GnuTLS uses has been
+ for the cipher algorithms. New options have been added to allow some of the
+ other parameters to be varied. Here is complete documentation for the
+ available features:
+
+ GnuTLS allows the caller to specify separate lists of permitted key
+ exchange methods, main cipher algorithms, and MAC algorithms. These may be
+ used in any combination to form a specific cipher suite. This is unlike
+ OpenSSL, where complete cipher names can be passed to its control function.
+ GnuTLS also allows a list of acceptable protocols to be supplied.
+
+ For compatibility with OpenSSL, the tls_require_ciphers option can be set
+ to complete cipher suite names such as RSA_ARCFOUR_SHA, but for GnuTLS this
+ option controls only the cipher algorithms. Exim searches each item in the
+ list for the name of an available algorithm. For example, if the list
+ contains RSA_AES_SHA, then AES is recognized, and the behaviour is exactly
+ the same as if just AES were given.
+
+ There are additional options called gnutls_require_kx, gnutls_require_mac,
+ and gnutls_require_protocols that can be used to restrict the key exchange
+ methods, MAC algorithms, and protocols, respectively. These options are
+ ignored if OpenSSL is in use.
+
+ All four options are available as global options, controlling how Exim
+ behaves as a server, and also as options of the smtp transport, controlling
+ how Exim behaves as a client. All the values are string expanded. After
+ expansion, the values must be colon-separated lists, though the separator
+ can be changed in the usual way.
+
+ Each of the four lists starts out with a default set of algorithms. If the
+ first item in one of the "require" options does _not_ start with an
+ exclamation mark, all the default items are deleted. In this case, only
+ those that are explicitly specified can be used. If the first item in one
+ of the "require" items _does_ start with an exclamation mark, the defaults
+ are left on the list.
+
+ Then, any item that starts with an exclamation mark causes the relevant
+ entry to be removed from the list, and any item that does not start with an
+ exclamation mark causes a new entry to be added to the list. Unrecognized
+ items in the list are ignored. Thus:
+
+ tls_require_ciphers = !ARCFOUR
+
+ allows all the defaults except ARCFOUR, whereas
+
+ tls_require_ciphers = AES : 3DES
+
+ allows only cipher suites that use AES or 3DES. For tls_require_ciphers
+ the recognized names are AES_256, AES_128, AES (both of the preceding),
+ 3DES, ARCFOUR_128, ARCFOUR_40, and ARCFOUR (both of the preceding). The
+ default list does not contain all of these; it just has AES_256, AES_128,
+ 3DES, and ARCFOUR_128.
+
+ For gnutls_require_kx, the recognized names are DHE_RSA, RSA (which
+ includes DHE_RSA), DHE_DSS, and DHE (which includes both DHE_RSA and
+ DHE_DSS). The default list contains RSA, DHE_DSS, DHE_RSA.
+
+ For gnutls_require_mac, the recognized names are SHA (synonym SHA1), and
+ MD5. The default list contains SHA, MD5.
+
+ For gnutls_require_protocols, the recognized names are TLS1 and SSL3.
+ The default list contains TLS1, SSL3.
+
+ In a server, the order of items in these lists is unimportant. The server
+ will advertise the availability of all the relevant cipher suites. However,
+ in a client, the order in the tls_require_ciphers list specifies a
+ preference order for the cipher algorithms. The first one in the client's
+ list that is also advertised by the server is tried first.
+
+ 4. There is a new compile-time option called ENABLE_DISABLE_FSYNC. You must
+ not set this option unless you really, really, really understand what you
+ are doing. No pre-compiled distributions of Exim should ever set this
+ option. When it is set, Exim compiles a runtime option called
+ disable_fsync. If this is set true, Exim no longer calls fsync() to force
+ updated files' data to be written to disc. Unexpected events such as
+ crashes and power outages may cause data to be lost or scrambled. Beware.
+
+ When ENABLE_DISABLE_FSYNC is not set, a reference to disable_fsync in a
+ runtime configuration generates an "unknown option" error.
+
+ 5. There is a new variable called $smtp_count_at_connection_start. The name
+ is deliberately long, in order to emphasize what the contents are. This
+ variable is set greater than zero only in processes spawned by the Exim
+ daemon for handling incoming SMTP connections. When the daemon accepts a
+ new connection, it increments this variable. A copy of the variable is
+ passed to the child process that handles the connection, but its value is
+ fixed, and never changes. It is only an approximation of how many incoming
+ connections there actually are, because many other connections may come and
+ go while a single connection is being processed. When a child process
+ terminates, the daemon decrements the variable.
+
+ 6. There's a new control called no_pipelining, which does what its name
+ suggests. It turns off the advertising of the PIPELINING extension to SMTP.
+ To be useful, this control must be obeyed before Exim sends its response to
+ an EHLO command. Therefore, it should normally appear in an ACL controlled
+ by acl_smtp_connect or acl_smtp_helo.
+
+ 7. There are two new variables called $sending_ip_address and $sending_port.
+ These are set whenever an SMTP connection to another host has been set up,
+ and they contain the IP address and port of the local interface that is
+ being used. They are of interest only on hosts that have more than on IP
+ address that want to take on different personalities depending on which one
+ is being used.
+
+ 8. The expansion of the helo_data option in the smtp transport now happens
+ after the connection to the server has been made. This means that it can
+ use the value of $sending_ip_address (see 7 above) to vary the text of the
+ message. For example, if you want the string that is used for helo_data to
+ be obtained by a DNS lookup of the interface address, you could use this:
+
+ helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
+ {$primary_hostname}}
+
+ The use of helo_data applies both to sending messages and when doing
+ callouts.
+
+ 9. There is a new expansion operator ${rfc2047d: that decodes strings that
+ are encoded as per RFC 2047. Binary zero bytes are replaced by question
+ marks. Characters are converted into the character set defined by
+ headers_charset. Overlong RFC 2047 "words" are not recognized unless
+ check_rfc2047_length is set false.
+
+10. There is a new log selector called "pid", which causes the current process
+ id to be added to every log line, in square brackets, immediately after the
+ time and date.
+
+11. Exim has been modified so that it flushes SMTP output before implementing
+ a delay in an ACL. It also flushes the output before performing a callout,
+ as this can take a substantial time. These behaviours can be disabled by
+ obeying control = no_delay_flush or control = no_callout_flush,
+ respectively, at some earlier stage of the connection. The effect of the
+ new default behaviour is to disable the PIPELINING optimization in these
+ situations, in order to avoid unexpected timeouts in clients.
+
+12. There are two new expansion conditions that iterate over a list. They are
+ called forany and forall, and they are used like this:
+
+ ${if forany{<a list>}{<a condition>}{<yes-string>}{<no-string>}}
+ ${if forall{<a list>}{<a condition>}{<yes-string>}{<no-string>}}
+
+ The first argument is expanded, and the result is treated as a list. By
+ default, the list separator is a colon, but it can be changed by the normal
+ method. The second argument is interpreted as a condition that is to be
+ applied to each item in the list in turn. During the interpretation of the
+ condition, the current list item is placed in a variable called $item.
+
+ - For forany, interpretation stops if the condition is true for any item,
+ and the yes-string is then expanded. If the condition is false for all
+ items in the list, the no-string is expanded.
+
+ - For forall, interpration stops if the condition is false for any item,
+ and the no-string is then expanded. If the condition is true for all
+ items in the list, the yes-string is expanded.
+
+ Note that negation of forany means that the condition must be false for all
+ items for the overall condition to succeed, and negation of forall means
+ that the condition must be false for at least one item.
+
+ In this example, the list separator is changed to a comma:
+
+ ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
+
+ Outside a forany/forall condition, the value of $item is an empty string.
+ Its value is saved and restored while forany/forall is being processed, to
+ enable these expansion items to be nested.
+
+13. There's a new global option called dsn_from that can be used to vary the
+ contents of From: lines in bounces and other automatically generated
+ messages ("delivery status notifications" - hence the name of the option).
+ The default setting is:
+
+ dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
+
+ The value is expanded every time it is needed. If the expansion fails, a
+ panic is logged, and the default setting is used.
+
+14. The smtp transport has a new option called hosts_avoid_pipelining. It can
+ be used to suppress the use of PIPELINING to certain hosts, while still
+ supporting the other SMTP extensions (cf hosts_avoid_tls).
+
+15. By default, exigrep does case-insensitive matches. There is now a -I option
+ that makes it case-sensitive. This may give a performance improvement when
+ searching large log files. Without -I, the Perl pattern matches use the /i
+ option; with -I they don't. In both cases it is possible to change the case
+ sensitivity within the pattern using (?i) or (?-i).
+
+16. A number of new features have been added to string expansions to make it
+ easier to process lists of items, typically addresses. These are as
+ follows:
+
+ * ${addresses:<string>}
+
+ The string (after expansion) is interpreted as a list of addresses in RFC
+ 2822 format, such as can be found in a To: or Cc: header line. The
+ operative address (local-part@domain) is extracted from each item, and the
+ result of the expansion is a colon-separated list, with appropriate
+ doubling of colons should any happen to be present in the email addresses.
+ Syntactically invalid RFC2822 address items are omitted from the output.
+
+ It is possible to specify a character other than colon for the output
+ separator by starting the string with > followed by the new separator
+ character. For example:
+
+ ${addresses:>& The Boss <ceo@up.stairs>, sec@base.ment (dogsbody)}
- $prvscheck_keynum Contains the key number extracted from
- the "prvs"-address in argument 1.
+ expands to "ceo@up.stairs&sec@base.ment". Compare ${address (singular),
+ which extracts the working address from a single RFC2822 address.
- These two variables can be used in the expansion code of argument 2
- to retrieve the <SECRET>. The VALIDITY of the "prvs"-signed address
- is then checked. The result is stored in yet another expansion
- variable:
+ * ${map{<string1>}{<string2>}}
- $prvscheck_result Contains the result of a "prvscheck"
- expansion: Unset (the empty string) for
- failure, "1" for success.
+ After expansion, <string1> is interpreted as a list, colon-separated by
+ default, but the separator can be changed in the usual way. For each item
+ in this list, its value is place in $item, and then <string2> is expanded
+ and added to the output as an item in a new list. The separator used for
+ the output list is the same as the one used for the input, but is not
+ included in the output. For example:
- The "prvscheck" expansion expands to the empty string if <ADDRESS>
- is not a SYNTACTICALLY valid "prvs"-scheme address. Otherwise,
- argument 3 defines what "prvscheck" expands to: If argument 3
- is the empty string, "prvscheck" expands to the decoded version
- of the address (no matter if it is CRYPTOGRAPHICALLY valid or not).
- If argument 3 expands to a non-empty string, "prvscheck" expands
- to that string.
+ ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
+ expands to "[a]:[b]:[c] (x)-(y)-(z)". At the end of the expansion, the
+ value of $item is restored to what it was before.
- Usage example
- -------------
+ * ${filter{<string1>}{<condition>}}
- Macro:
+ After expansion, <string1> is interpreted as a list, colon-separated by
+ default, but the separator can be changed in the usual way. For each item
+ in this list, its value is place in $item, and then the condition is
+ evaluated. If the condition is true, $item is added to the output as an
+ item in a new list; if the condition is false, the item is discarded. The
+ separator used for the output list is the same as the one used for the
+ input, but is not included in the output. For example:
- PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs WHERE \
- sender='${quote_mysql:$prvscheck_address}'}{$value}}
+ ${filter{a:b:c}{!eq{$item}{b}}
- RCPT ACL:
+ yields "a:c". At the end of the expansion, the value of $item is restored
+ to what it was before.
- # Bounces: drop unsigned addresses for BATV senders
- deny message = This address does not send an unsigned reverse path.
- senders = :
- recipients = +batv_recipients
+ * ${reduce{<string1>}{<string2>}{<string3>}}
- # Bounces: In case of prvs-signed address, check signature.
- deny message = Invalid reverse path signature.
- senders = :
- condition = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}{1}}
- !condition = $prvscheck_result
+ The ${reduce expansion operation reduces a list to a single, scalar string.
+ After expansion, <string1> is interpreted as a list, colon-separated by
+ default, but the separator can be changed in the usual way. Then <string2>
+ is expanded and assigned to the $value variable. After this, each item in
+ the <string1> list is assigned to $item in turn, and <string3> is expanded
+ for each of them. The result of that expansion is assigned to $value before
+ the next iteration. When the end of the list is reached, the final value of
+ $value is added to the expansion string. The ${reduce expansion item can be
+ used in a number of ways. For example, to add up a list of numbers:
- Top-Level Router:
+ ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
- batv_redirect:
- driver = redirect
- data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}{}}
+ The result of that expansion would be "6". The maximum of a list of numbers
+ can be found:
- Transport (referenced by router that makes decision if
- BATV is applicable):
+ ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
- external_smtp_batv:
- driver = smtp
- return_path = ${prvs {$return_path} \
- {${lookup mysql{SELECT \
- secret FROM batv_prvs WHERE \
- sender='${quote_mysql:$sender_address}'} \
- {$value}fail}}}
+ At the end of a ${reduce expansion, the values of $item and $value is
+ restored to what they were before.
-PH/04 There are two new options that control the retrying done by the daemon
- at startup when it cannot immediately bind a socket (typically because
- the socket is already in use). The default values reproduce what were
- built-in constants previously: daemon_startup_retries defines the number
- of retries after the first failure (default 9); daemon_startup_sleep
- defines the length of time to wait between retries (default 30s).
+17. There's a new ACL modifier called "continue". It does nothing of itself,
+ and processing of the ACL always continues with the next condition or
+ modifier. It is provided so that the side effects of expanding its argument
+ can be used. Typically this would be for updating a database. It is really
+ just a syntactic tidiness, because the following two lines have the same
+ effect:
-PH/05 There is now a new ${if condition called "match_ip". It is similar to
- match_domain, etc. It must be followed by two argument strings. The first
- (after expansion) must be an IP address or an empty string. The second
- (after expansion) is a restricted host list that can match only an IP
- address, not a host name. For example:
+ continue = <some expansion>
+ condition = ${if eq{0}{<some expansion>}{true}{true}}
- ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
+18. It is now possible to use newline and other control characters (those with
+ values less than 32, plus DEL) as separators in lists. Such separators must
+ be provided literally at the time the list is processed, but the string
+ expansion that happens first means that you can write them using normal
+ escape sequences. For example, if a new-line separated list of domains is
+ generated by a lookup, you can now process it directly by a line such as
+ this:
- The specific types of host list item that are permitted in the list are
- shown below. Consult the manual section on host lists for further
- details.
+ domains = <\n ${lookup mysql{.....}}
- . An IP address, optionally with a CIDR mask.
+ This avoids having to change the list separator in such data. Unlike
+ printing character separators, which can be included in list items by
+ doubling, it is not possible to include a control character as data when it
+ is set as the separator. Two such characters in succession are interpreted
+ as enclosing an empty list item.
- . A single asterisk matches any IP address.
+19. The exigrep utility now has a -v option, which inverts the matching
+ condition.
- . An empty item matches only if the IP address is empty. This could be
- useful for testing for a locally submitted message or one from specific
- hosts in a single test such as
+20. The host_find_failed option in the manualroute router can now be set to
+ "ignore". This causes it to completely ignore a host whose IP address
+ cannot be found. If all the hosts in the list are ignored, the behaviour is
+ controlled by the new host_all_ignored option, which takes the same values
+ as host_find_failed, except that it cannot be set to "ignore". Its default
+ is "defer".
- ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
- where the first item in the list is the empty string.
+Version 4.66
+------------
+
+No new features were added to 4.66.
+
+
+Version 4.65
+------------
+
+No new features were added to 4.65.
+
+
+Version 4.64
+------------
- . The item @[] matches any of the local host's interface addresses.
+ 1. ACL variables can now be given arbitrary names, as long as they start with
+ "acl_c" or "acl_m" (for connection variables and message variables), are at
+ least six characters long, with the sixth character being either a digit or
+ an underscore.
- . Lookups are assumed to be "net-" style lookups, even if "net-" is not
- specified. Thus, the following are equivalent:
+ 2. There is a new ACL modifier called log_reject_target. It makes it possible
+ to specify which logs are used for messages about ACL rejections.
- ${if match_ip{$sender_host_address}{lsearch;/some/file}...
- ${if match_ip{$sender_host_address}{net-lsearch;/some/file}...
+ 3. There is a new authenticator called "dovecot". This is an interface to the
+ authentication facility of the Dovecot POP/IMAP server, which can support a
+ number of authentication methods.
- You do need to specify the "net-" prefix if you want to specify a
- specific address mask, for example, by using "net24-".
+ 4. The variable $message_headers_raw provides a concatenation of all the
+ messages's headers without any decoding. This is in contrast to
+ $message_headers, which does RFC2047 decoding on the header contents.
-PH/06 The "+all" debug selector used to set the flags for all possible output;
- it is something that people tend to use semi-automatically when
- generating debug output for me or for the list. However, by including
- "+memory", an awful lot of output that is very rarely of interest was
- generated. I have changed this so that "+all" no longer includes
- "+memory". However, "-all" still turns everything off.
+ 5. In a DNS black list, if two domain names, comma-separated, are given, the
+ second is used first to do an initial check, making use of any IP value
+ restrictions that are set. If there is a match, the first domain is used,
+ without any IP value restrictions, to get the TXT record.
+ 6. All authenticators now have a server_condition option.
-Version 4.51
+ 7. There is a new command-line option called -Mset. It is useful only in
+ conjunction with -be (that is, when testing string expansions). It must be
+ followed by a message id; Exim loads the given message from its spool
+ before doing the expansions.
+
+ 8. Another similar new command-line option is called -bem. It operates like
+ -be except that it must be followed by the name of a file that contains a
+ message.
+
+ 9. When an address is delayed because of a 4xx response to a RCPT command, it
+ is now the combination of sender and recipient that is delayed in
+ subsequent queue runs until its retry time is reached.
+
+10. Unary negation and the bitwise logical operators and, or, xor, not, and
+ shift, have been added to the eval: and eval10: expansion items.
+
+11. The variables $interface_address and $interface_port have been renamed
+ as $received_ip_address and $received_port, to make it clear that they
+ relate to message reception rather than delivery. (The old names remain
+ available for compatibility.)
+
+12. The "message" modifier can now be used on "accept" and "discard" acl verbs
+ to vary the message that is sent when an SMTP command is accepted.
+
+
+Version 4.63
------------
-PH/01 The format in which GnuTLS parameters are written to the gnutls-param
- file in the spool directory has been changed. This change has been made
- to alleviate problems that some people had with the generation of the
- parameters by Exim when /dev/random was exhausted. In this situation,
- Exim would hang until /dev/random acquired some more entropy.
+1. There is a new Boolean option called filter_prepend_home for the redirect
+ router.
+
+2. There is a new acl, set by acl_not_smtp_start, which is run right at the
+ start of receiving a non-SMTP message, before any of the message has been
+ read.
+
+3. When an SMTP error message is specified in a "message" modifier in an ACL,
+ or in a :fail: or :defer: message in a redirect router, Exim now checks the
+ start of the message for an SMTP error code.
+
+4. There is a new parameter for LDAP lookups called "referrals", which takes
+ one of the settings "follow" (the default) or "nofollow".
+
+5. Version 20070721.2 of exipick now included, offering these new options:
+ --reverse
+ After all other sorting options have bee processed, reverse order
+ before displaying messages (-R is synonym).
+ --random
+ Randomize order of matching messages before displaying.
+ --size
+ Instead of displaying the matching messages, display the sum
+ of their sizes.
+ --sort <variable>[,<variable>...]
+ Before displaying matching messages, sort the messages according to
+ each messages value for each variable.
+ --not
+ Negate the value for every test (returns inverse output from the
+ same criteria without --not).
+
+
+Version 4.62
+------------
- The new code exports and imports the DH and RSA parameters in PEM
- format. This means that the parameters can be generated externally using
- the certtool command that is part of GnuTLS.
+1. The ${readsocket expansion item now supports Internet domain sockets as well
+ as Unix domain sockets. If the first argument begins "inet:", it must be of
+ the form "inet:host:port". The port is mandatory; it may be a number or the
+ name of a TCP port in /etc/services. The host may be a name, or it may be an
+ IP address. An ip address may optionally be enclosed in square brackets.
+ This is best for IPv6 addresses. For example:
- To replace the parameters with new ones, instead of deleting the file
- and letting Exim re-create it, you can generate new parameters using
- certtool and, when this has been done, replace Exim's cache file by
- renaming. The relevant commands are something like this:
+ ${readsocket{inet:[::1]:1234}{<request data>}...
- # rm -f new.params
- # touch new.params
- # chown exim:exim new.params
- # chmod 0400 new.params
- # certtool --generate-privkey --bits 512 >new.params
- # echo "" >>new.params
- # certtool --generate-dh-params --bits 1024 >> new.params
- # mv new.params params
+ Only a single host name may be given, but if looking it up yield more than
+ one IP address, they are each tried in turn until a connection is made. Once
+ a connection has been made, the behaviour is as for ${readsocket with a Unix
+ domain socket.
- If Exim never has to generate the parameters itself, the possibility of
- stalling is removed.
+2. If a redirect router sets up file or pipe deliveries for more than one
+ incoming address, and the relevant transport has batch_max set greater than
+ one, a batch delivery now occurs.
-PH/02 A new expansion item for dynamically loading and calling a locally-
- written C function is now provided, if Exim is compiled with
+3. The appendfile transport has a new option called maildirfolder_create_regex.
+ Its value is a regular expression. For a maildir delivery, this is matched
+ against the maildir directory; if it matches, Exim ensures that a
+ maildirfolder file is created alongside the new, cur, and tmp directories.
- EXPAND_DLFUNC=yes
- set in Local/Makefile. The facility is not included by default (a
- suitable error is given if you try to use it when it is not there.)
+Version 4.61
+------------
+
+The documentation is up-to-date for the 4.61 release. Major new features since
+the 4.60 release are:
+
+. An option called disable_ipv6, to disable the use of IPv6 completely.
+
+. An increase in the number of ACL variables to 20 of each type.
+
+. A change to use $auth1, $auth2, and $auth3 in authenticators instead of $1,
+ $2, $3, (though those are still set) because the numeric variables get used
+ for other things in complicated expansions.
+
+. The default for rfc1413_query_timeout has been changed from 30s to 5s.
+
+. It is possible to use setclassresources() on some BSD OS to control the
+ resources used in pipe deliveries.
+
+. A new ACL modifier called add_header, which can be used with any verb.
- If you enable EXPAND_DLFUNC, you should also be aware of the new redirect
- router option forbid_filter_dlfunc. If you have unprivileged users on
- your system who are permitted to create filter files, you might want to
- set forbid_filter_dlfunc=true in the appropriate router, to stop them
- using ${dlfunc to run code within Exim.
+. More errors are detectable in retry rules.
- You load and call an external function like this:
-
- ${dlfunc{/some/file}{function}{arg1}{arg2}...}
-
- Once loaded, Exim remembers the dynamically loaded object so that it
- doesn't reload the same object file in the same Exim process (but of
- course Exim does start new processes frequently).
-
- There may be from zero to eight arguments to the function. When compiling
- a local function that is to be called in this way, local_scan.h should be
- included. The Exim variables and functions that are defined by that API
- are also available for dynamically loaded functions. The function itself
- must have the following type:
-
- int dlfunction(uschar **yield, int argc, uschar *argv[])
-
- Where "uschar" is a typedef for "unsigned char" in local_scan.h. The
- function should return one of the following values:
-
- OK Success. The string that is placed in "yield" is put into
- the expanded string that is being built.
-
- FAIL A non-forced expansion failure occurs, with the error
- message taken from "yield", if it is set.
-
- FAIL_FORCED A forced expansion failure occurs, with the error message
- taken from "yield" if it is set.
-
- ERROR Same as FAIL, except that a panic log entry is written.
-
- When compiling a function that is to be used in this way with gcc,
- you need to add -shared to the gcc command. Also, in the Exim build-time
- configuration, you must add -export-dynamic to EXTRALIBS.
-
-TF/01 $received_time is a new expansion variable containing the time and date
- as a number of seconds since the start of the Unix epoch when the
- current message was received.
-
-PH/03 There is a new value for RADIUS_LIB_TYPE that can be set in
- Local/Makefile. It is RADIUSCLIENTNEW, and it requests that the new API,
- in use from radiusclient 0.4.0 onwards, be used. It does not appear to be
- possible to detect the different versions automatically.
-
-PH/04 There is a new option called acl_not_smtp_mime that allows you to scan
- MIME parts in non-SMTP messages. It operates in exactly the same way as
- acl_smtp_mime
-
-PH/05 It is now possible to redefine a macro within the configuration file.
- The macro must have been previously defined within the configuration (or
- an included file). A definition on the command line using the -D option
- causes all definitions and redefinitions within the file to be ignored.
- In other words, -D overrides any values that are set in the file.
- Redefinition is specified by using '==' instead of '='. For example:
-
- MAC1 = initial value
- ...
- MAC1 == updated value
-
- Redefinition does not alter the order in which the macros are applied to
- the subsequent lines of the configuration file. It is still the same
- order in which the macros were originally defined. All that changes is
- the macro's value. Redefinition makes it possible to accumulate values.
- For example:
-
- MAC1 = initial value
- ...
- MAC1 == MAC1 and something added
-
- This can be helpful in situations where the configuration file is built
- from a number of other files.
-
-PH/06 Macros may now be defined or redefined between router, transport,
- authenticator, or ACL definitions, as well as in the main part of the
- configuration. They may not, however, be changed within an individual
- driver or ACL, or in the local_scan, retry, or rewrite sections of the
- configuration.
-
-PH/07 $acl_verify_message is now set immediately after the failure of a
- verification in an ACL, and so is available in subsequent modifiers. In
- particular, the message can be preserved by coding like this:
+There are a number of other additions too.
- warn !verify = sender
- set acl_m0 = $acl_verify_message
- Previously, $acl_verify_message was set only while expanding "message"
- and "log_message" when a very denied access.
-
-PH/08 The redirect router has two new options, sieve_useraddress and
- sieve_subaddress. These are passed to a Sieve filter to specify the :user
- and :subaddress parts of an address. Both options are unset by default.
- However, when a Sieve filter is run, if sieve_useraddress is unset, the
- entire original local part (including any prefix or suffix) is used for
- :user. An unset subaddress is treated as an empty subaddress.
-
-PH/09 Quota values can be followed by G as well as K and M.
-
-PH/10 $message_linecount is a new variable that contains the total number of
- lines in the header and body of the message. Compare $body_linecount,
- which is the count for the body only. During the DATA and
- content-scanning ACLs, $message_linecount contains the number of lines
- received. Before delivery happens (that is, before filters, routers, and
- transports run) the count is increased to include the Received: header
- line that Exim standardly adds, and also any other header lines that are
- added by ACLs. The blank line that separates the message header from the
- body is not counted. Here is an example of the use of this variable in a
- DATA ACL:
-
- deny message = Too many lines in message header
- condition = \
- ${if <{250}{${eval: $message_linecount - $body_linecount}}}
-
- In the MAIL and RCPT ACLs, the value is zero because at that stage the
- message has not yet been received.
-
-PH/11 In a ${run expansion, the variable $value (which contains the standard
- output) is now also usable in the "else" string.
-
-PH/12 In a pipe transport, although a timeout while waiting for the pipe
- process to complete was treated as a delivery failure, a timeout while
- writing the message to the pipe was logged, but erroneously treated as a
- successful delivery. Such timeouts include transport filter timeouts. For
- consistency with the overall process timeout, these timeouts are now
- treated as errors, giving rise to delivery failures by default. However,
- there is now a new Boolean option for the pipe transport called
- timeout_defer, which, if set TRUE, converts the failures into defers for
- both kinds of timeout. A transport filter timeout is now identified in
- the log output.
-
-
-Version 4.50
+Version 4.60
------------
-The documentation is up-to-date for the 4.50 release.
+The documentation is up-to-date for the 4.60 release. Major new features since
+the 4.50 release are:
+
+. Support for SQLite.
+
+. Support for IGNOREQUOTA in LMTP.
+
+. Extensions to the "submission mode" features.
+
+. Support for Client SMTP Authorization (CSA).
+
+. Support for ratelimiting hosts and users.
+
+. New expansion items to help with the BATV "prvs" scheme.
+
+. A "match_ip" condition, that matches an IP address against a list.
+
+There are many more minor changes.
****
git://git.exim.org / users / jgh / exim.git / blobdiff