X-Git-Url: https://git.exim.org/users/jgh/exim.git/blobdiff_plain/66581d1e830f4e68f2b074b8d79a80645c6a72ea..23c7e742a962511464cfb3ea4952311dc102f660:/doc/doc-docbook/spec.xfpt diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index b2c40e48a..131dffad4 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -1,5 +1,3 @@ -. $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.88 2010/06/14 18:51:09 pdp Exp $ -. . ///////////////////////////////////////////////////////////////////////////// . This is the primary source of the Exim Manual. It is an xfpt document that is . converted into DocBook XML for subsequent conversion into printing and online @@ -47,8 +45,8 @@ . the element must also be updated for each new edition. . ///////////////////////////////////////////////////////////////////////////// -.set previousversion "4.71" -.set version "4.72" +.set previousversion "4.75" +.set version "4.77" .set ACL "access control lists (ACLs)" .set I "    " @@ -172,15 +170,15 @@ Specification of the Exim Mail Transfer Agent The Exim MTA -29 May 2010 +06 May 2011 EximMaintainers EM - 4.72 - 29 May 2010 + 4.77 + 10 Oct 2011 EM -2009University of Cambridge +2011University of Cambridge .literal off @@ -366,6 +364,7 @@ contributors. .section "Exim documentation" "SECID1" . Keep this example change bar when updating the documentation! + .new .cindex "documentation" This edition of the Exim specification applies to version &version; of Exim. @@ -469,10 +468,10 @@ first to check that you are not duplicating a previous entry. The following Exim mailing lists exist: .table2 140pt +.row &'exim-announce@exim.org'& "Moderated, low volume announcements list" .row &'exim-users@exim.org'& "General discussion list" .row &'exim-dev@exim.org'& "Discussion of bugs, enhancements, etc." -.row &'exim-announce@exim.org'& "Moderated, low volume announcements list" -.row &'exim-future@exim.org'& "Discussion of long-term development" +.row &'exim-cvs@exim.org'& "Automated commit messages from the VCS" .endtable You can subscribe to these lists, change your existing subscriptions, and view @@ -1544,7 +1543,6 @@ If a host is unreachable for a period of time, a number of messages may be waiting for it by the time it recovers, and sending them in a single SMTP connection is clearly beneficial. Whenever a delivery to a remote host is deferred, - .cindex "hints database" Exim makes a note in its hints database, and whenever a successful SMTP delivery has happened, it looks to see if any other messages are waiting @@ -1554,7 +1552,6 @@ one connection. - .section "Permanent delivery failure" "SECID21" .cindex "delivery" "permanent failure" .cindex "bounce message" "when generated" @@ -1894,6 +1891,7 @@ given in chapter &<>&. .section "Use of tcpwrappers" "SECID27" + .cindex "tcpwrappers, building Exim to support" .cindex "USE_TCP_WRAPPERS" .cindex "TCP_WRAPPERS_DAEMON_NAME" @@ -1926,7 +1924,6 @@ configure file. Consult the &'tcpwrappers'& documentation for further details. - .section "Including support for IPv6" "SECID28" .cindex "IPv6" "including support for" Exim contains code for use on systems that have IPv6 support. Setting @@ -1946,6 +1943,36 @@ support has not been tested for some time. +.section "Dynamically loaded lookup module support" "SECTdynamicmodules" +.cindex "lookup modules" +.cindex "dynamic modules" +.cindex ".so building" +On some platforms, Exim supports not compiling all lookup types directly into +the main binary, instead putting some into external modules which can be loaded +on demand. +This permits packagers to build Exim with support for lookups with extensive +library dependencies without requiring all users to install all of those +dependencies. +Most, but not all, lookup types can be built this way. + +Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be +installed; Exim will only load modules from that directory, as a security +measure. You will need to set &`CFLAGS_DYNAMIC`& if not already defined +for your OS; see &_OS/Makefile-Linux_& for an example. +Some other requirements for adjusting &`EXTRALIBS`& may also be necessary, +see &_src/EDITME_& for details. + +Then, for each module to be loaded dynamically, define the relevant +&`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes". +For example, this will build in lsearch but load sqlite and mysql support +on demand: +.code +LOOKUP_LSEARCH=yes +LOOKUP_SQLITE=2 +LOOKUP_MYSQL=2 +.endd + + .section "The building process" "SECID29" .cindex "build directory" Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been @@ -3250,7 +3277,7 @@ doing such tests. .cindex "version number of Exim" This option causes Exim to write the current version number, compilation number, and compilation date of the &'exim'& binary to the standard output. -It also lists the DBM library this is being used, the optional modules (such as +It also lists the DBM library that is being used, the optional modules (such as specific lookup types), the drivers that are included in the binary, and the name of the run time configuration file that is in use. @@ -3334,12 +3361,15 @@ proceeding any further along the list, and an error is generated. When this option is used by a caller other than root, and the list is different from the compiled-in list, Exim gives up its root privilege immediately, and runs with the real and effective uid and gid set to those of the caller. -However, if a TRUSTED_CONFIG_PREFIX_LIST file is defined in &_Local/Makefile_&, -root privilege is retained for any configuration file which matches a prefix -listed in that file. - -Leaving TRUSTED_CONFIG_PREFIX_LIST unset precludes the possibility of testing -a configuration using &%-C%& right through message reception and delivery, +However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that +file contains a list of full pathnames, one per line, for configuration files +which are trusted. Root privilege is retained for any configuration file so +listed, as long as the caller is the Exim user (or the user specified in the +CONFIGURE_OWNER option, if any), and as long as the configuration file is +not writeable by inappropriate users or groups. + +Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a +configuration using &%-C%& right through message reception and delivery, even if the caller is root. The reception works, but by that time, Exim is running as the Exim user, so when it re-executes to regain privilege for the delivery, the use of &%-C%& causes privilege to be lost. However, root can @@ -3365,6 +3395,7 @@ caller is privileged, or unless it is an exotic configuration that does not require privilege. No check is made on the owner or group of the files specified by this option. + .vitem &%-D%&<&'macro'&>=<&'value'&> .oindex "&%-D%&" .cindex "macro" "setting on command line" @@ -3398,6 +3429,7 @@ exim '-D ABC = something' ... .endd &%-D%& may be repeated up to 10 times on a command line. + .vitem &%-d%&<&'debug&~options'&> .oindex "&%-d%&" .cindex "debugging" "list of selectors" @@ -4536,15 +4568,16 @@ A one-off alternate configuration can be specified by the &%-C%& command line option, which may specify a single file or a list of files. However, when &%-C%& is used, Exim gives up its root privilege, unless called by root (or unless the argument for &%-C%& is identical to the built-in value from -CONFIGURE_FILE) or matches a prefix listed in the TRUSTED_CONFIG_PREFIX_LIST -file. &%-C%& is useful mainly for checking the syntax of configuration files -before installing them. No owner or group checks are done on a configuration -file specified by &%-C%&, if root privilege has been dropped. +CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller +is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%& +is useful mainly for checking the syntax of configuration files before +installing them. No owner or group checks are done on a configuration file +specified by &%-C%&, if root privilege has been dropped. Even the Exim user is not trusted to specify an arbitrary configuration file with the &%-C%& option to be used with root privileges, unless that file is -listed in the TRUSTED_CONFIG_PREFIX_LIST file. This locks out the possibility -of testing a configuration using &%-C%& right through message reception and +listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of +testing a configuration using &%-C%& right through message reception and delivery, even if the caller is root. The reception works, but by that time, Exim is running as the Exim user, so when it re-execs to regain privilege for the delivery, the use of &%-C%& causes privilege to be lost. However, root @@ -6677,7 +6710,6 @@ ${lookup dnsdb{>: a=host1.example}} It is permitted to specify a space as the separator character. Further white space is ignored. -.new .cindex "TXT record" "in &(dnsdb)& lookup" For TXT records with multiple items of data, only the first item is returned, unless a separator for them is specified using a comma after the separator @@ -6689,7 +6721,6 @@ ${lookup dnsdb{>\n; txt=a.b.example}} .endd It is permitted to specify a space as the separator character. Further white space is ignored. -.wen .section "Pseudo dnsdb record types" "SECID66" .cindex "MX record" "in &(dnsdb)& lookup" @@ -6835,6 +6866,10 @@ The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports secure (encrypted) LDAP connections. The second of these ensures that an encrypted TLS connection is used. +With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular +LDAP connections, rather than the SSL-on-connect &`ldaps`&. +See the &%ldap_start_tls%& option. + .section "LDAP quoting" "SECID68" .cindex "LDAP" "quoting" @@ -7744,7 +7779,7 @@ pattern must be an appropriate query for the lookup type, as described in chapter &<>&. For example: .code hold_domains = mysql;select domain from holdlist \ - where domain = '$domain'; + where domain = '${quote_mysql:$domain}'; .endd In most cases, the data that is looked up is not used (so for an SQL query, for example, it doesn't matter what field you select). Exim is interested only in @@ -9829,6 +9864,7 @@ lower case), signifying multiplication by 1024 or 1024*1024, respectively. As a special case, the numerical value of an empty string is taken as zero. + .vitem &*bool&~{*&<&'string'&>&*}*& .cindex "expansion" "boolean parsing" .cindex "&%bool%& expansion condition" @@ -9845,6 +9881,7 @@ For example: ${if bool{$acl_m_privileged_sender} ... .endd + .vitem &*bool_lax&~{*&<&'string'&>&*}*& .cindex "expansion" "boolean parsing" .cindex "&%bool_lax%& expansion condition" @@ -10042,6 +10079,25 @@ string is lexically greater than the second string. For &%gt%& the comparison includes the case of letters, whereas for &%gti%& the comparison is case-independent. +.new +.vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&& + &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& +.cindex "string" "comparison" +.cindex "list" "iterative conditions" +Both strings are expanded; the second string is treated as a list of simple +strings; if the first string is a member of the second, then the condition +is true. + +These are simpler to use versions of the more powerful &*forany*& condition. +Examples, and the &*forany*& equivalents: +.code +${if inlist{needle}{foo:needle:bar}} + ${if forany{foo:needle:bar}{eq{$item}{needle}}} +${if inlisti{Needle}{fOo:NeeDLE:bAr}} + ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}} +.endd +.wen + .vitem &*isip&~{*&<&'string'&>&*}*& &&& &*isip4&~{*&<&'string'&>&*}*& &&& &*isip6&~{*&<&'string'&>&*}*& @@ -10152,10 +10208,12 @@ See &*match_local_part*&. .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& .cindex "&%match_ip%& expansion condition" +.new This condition matches an IP address to a list of IP address patterns. 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 +address or an empty string. The second (not expanded) is a restricted host list that can match only an IP address, not a host name. For example: +.wen .code ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}} .endd @@ -10201,6 +10259,11 @@ just as easy to use the fact that a lookup is itself a condition, and write: .endd .endlist ilist +.new +Note that <&'string2'&> is not itself subject to string expansion, unless +Exim was built with the EXPAND_LISTMATCH_RHS option. +.wen + Consult section &<>& for further details of these patterns. .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& @@ -10228,6 +10291,11 @@ item can be used, as in all address lists, to cause subsequent items to have their local parts matched casefully. Domains are always matched caselessly. +.new +Note that <&'string2'&> is not itself subject to string expansion, unless +Exim was built with the EXPAND_LISTMATCH_RHS option. +.wen + &*Note*&: Host lists are &'not'& supported in this way. This is because hosts have two identities: a name and an IP address, and it is not clear how to specify cleanly how such a test would work. However, IP addresses can be @@ -10573,6 +10641,15 @@ is empty and &$authentication_failed$& is set to &"1"&). Failure includes any negative response to an AUTH command, including (for example) an attempt to use an undefined mechanism. +.new +.vitem &$av_failed$& +.cindex "content scanning" "AV scanner failure" +This variable is available when Exim is compiled with the content-scanning +extension. It is set to &"0"& by default, but will be set to &"1"& if any +problem occurs with the virus scanner (specified by &%av_scanner%&) during +the ACL malware condition. +.wen + .vitem &$body_linecount$& .cindex "message body" "line count" .cindex "body of message" "line count" @@ -10586,7 +10663,7 @@ number of lines in the message's body. See also &$message_linecount$&. .cindex "binary zero" "in message body" .vindex "&$body_zerocount$&" When a message is being received or delivered, this variable contains the -number of binary zero bytes in the message's body. +number of binary zero bytes (ASCII NULs) in the message's body. .vitem &$bounce_recipient$& .vindex "&$bounce_recipient$&" @@ -11074,8 +11151,15 @@ 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: +from the body is not counted. + +As with the special case of &$message_size$&, during the expansion of the +appendfile transport's maildir_tag option in maildir format, the value of +&$message_linecount$& is the precise size of the number of newlines in the +file that has been written (minus one for the blank line between the +header and the body). + +Here is an example of the use of this variable in a DATA ACL: .code deny message = Too many lines in message header condition = \ @@ -12336,7 +12420,14 @@ listed in more than one group. .section "Data lookups" "SECID101" .table2 .row &%ibase_servers%& "InterBase servers" +.row &%ldap_ca_cert_dir%& "dir of CA certs to verify LDAP server's" +.row &%ldap_ca_cert_file%& "file of CA certs to verify LDAP server's" +.row &%ldap_cert_file%& "client cert file for LDAP" +.row &%ldap_cert_key%& "client key file for LDAP" +.row &%ldap_cipher_suite%& "TLS negotiation preference control" .row &%ldap_default_servers%& "used if no server in query" +.row &%ldap_require_cert%& "action to take without LDAP server cert" +.row &%ldap_start_tls%& "require TLS within LDAP" .row &%ldap_version%& "set protocol version" .row &%lookup_open_max%& "lookup files held open" .row &%mysql_servers%& "default MySQL servers" @@ -12616,6 +12707,7 @@ See also the &'Policy controls'& section above. .row &%dns_ipv4_lookup%& "only v4 lookup for these domains" .row &%dns_retrans%& "parameter for resolver" .row &%dns_retry%& "parameter for resolver" +.row &%dns_use_edns0%& "parameter for resolver" .row &%hold_domains%& "hold delivery for these domains" .row &%local_interfaces%& "for routing checks" .row &%queue_domains%& "no immediate delivery for these" @@ -12868,6 +12960,7 @@ saying &"keep on trying, even though there are big problems"&. &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not thought to be very useful any more, and its use should probably be avoided. + .option av_scanner main string "see below" This option is available if Exim is built with the content-scanning extension. It specifies which anti-virus scanner to use. The default value is: @@ -12878,7 +12971,6 @@ If the value of &%av_scanner%& starts with a dollar character, it is expanded before use. See section &<>& for further details. - .option bi_command main string unset .oindex "&%-bi%&" This option supplies the name of a command that is run when Exim is called with @@ -13248,6 +13340,19 @@ to set in them. See &%dns_retrans%& above. +.new +.option dns_use_edns0 main integer -1 +.cindex "DNS" "resolver options" +.cindex "DNS" "EDNS0" +If this option is set to a non-negative number then Exim will initialise the +DNS resolver library to either use or not use EDNS0 extensions, overriding +the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0 +on. + +If the resolver library does not support EDNS0 then this option has no effect. +.wen + + .option drop_cr main boolean false This is an obsolete option that is now a no-op. It used to affect the way Exim handled CR and LF characters in incoming messages. What happens now is @@ -13747,6 +13852,46 @@ next attempt to deliver such a message, it gets removed. The incident is logged. +.option ldap_ca_cert_dir main string unset +.cindex "LDAP", "TLS CA certificate directory" +This option indicates which directory contains CA certificates for verifying +a TLS certificate presented by an LDAP server. +While Exim does not provide a default value, your SSL library may. +Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP +and constrained to be a directory. + + +.option ldap_ca_cert_file main string unset +.cindex "LDAP", "TLS CA certificate file" +This option indicates which file contains CA certificates for verifying +a TLS certificate presented by an LDAP server. +While Exim does not provide a default value, your SSL library may. +Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP +and constrained to be a file. + + +.option ldap_cert_file main string unset +.cindex "LDAP" "TLS client certificate file" +This option indicates which file contains an TLS client certificate which +Exim should present to the LDAP server during TLS negotiation. +Should be used together with &%ldap_cert_key%&. + + +.option ldap_cert_key main string unset +.cindex "LDAP" "TLS client key file" +This option indicates which file contains the secret/private key to use +to prove identity to the LDAP server during TLS negotiation. +Should be used together with &%ldap_cert_file%&, which contains the +identity to be proven. + + +.option ldap_cipher_suite main string unset +.cindex "LDAP" "TLS cipher suite" +This controls the TLS cipher-suite negotiation during TLS negotiation with +the LDAP server. See &<>& for more details of the format of +cipher-suite options with OpenSSL (as used by LDAP client libraries). + + .option ldap_default_servers main "string list" unset .cindex "LDAP" "default servers" This option provides a list of LDAP servers which are tried in turn when an @@ -13755,6 +13900,25 @@ details of LDAP queries. This option is available only when Exim has been built with LDAP support. +.option ldap_require_cert main string unset. +.cindex "LDAP" "policy for LDAP server TLS cert presentation" +This should be one of the values "hard", "demand", "allow", "try" or "never". +A value other than one of these is interpreted as "never". +See the entry "TLS_REQCERT" in your system man page for ldap.conf(5). +Although Exim does not set a default, the LDAP library probably defaults +to hard/demand. + + +.option ldap_start_tls main boolean false +.cindex "LDAP" "whether or not to negotiate TLS" +If set, Exim will attempt to negotiate TLS with the LDAP server when +connecting on a regular LDAP port. This is the LDAP equivalent of SMTP's +"STARTTLS". This is distinct from using "ldaps", which is the LDAP form +of SSL-on-connect. +In the event of failure to negotiate TLS, the action taken is controlled +by &%ldap_require_cert%&. + + .option ldap_version main integer unset .cindex "LDAP" "protocol version, forcing" This option can be used to force Exim to set a specific protocol version for @@ -14036,6 +14200,10 @@ probably safest to just set it to a little larger than this value. Eg, with a default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M, some problems may result. +A value of 0 will disable size limit checking; Exim will still advertise the +SIZE extension in an EHLO response, but without a limit, so as to permit +SMTP clients to still indicate the message size along with the MAIL verb. + .option move_frozen_messages main boolean false .cindex "frozen messages" "moving" @@ -15218,6 +15386,7 @@ contains the pipe command. This specifies the transport driver that is to be used when a &%mail%& command is used in a system filter. + .option system_filter_user main string unset .cindex "uid (user id)" "system filter" If this option is set to root, the system filter is run in the main Exim @@ -15376,6 +15545,13 @@ are using OpenSSL, you can set &%tls_verify_certificates%& to the name of a directory containing certificate files. This does not work with GnuTLS; the option must be set to the name of a single file if you are using GnuTLS. +These certificates should be for the certificate authorities trusted, rather +than the public cert of individual clients. With both OpenSSL and GnuTLS, if +the value is a file then the certificates are sent by Exim as a server to +connecting clients, defining the list of accepted certificate authorities. +Thus the values defined should be considered public data. To avoid this, +use OpenSSL with a directory. + .option tls_verify_hosts main "host list&!!" unset .cindex "TLS" "client certificate verification" @@ -15726,18 +15902,19 @@ Because of the default behaviour of the string expansion, this is equivalent to .code condition = ${if >{$message_age}{600}{true}{}} .endd + A multiple condition example, which succeeds: .code condition = ${if >{$message_age}{600}} condition = ${if !eq{${lc:$local_part}}{postmaster}} condition = foobar .endd + If the expansion fails (other than forced failure) delivery is deferred. Some of the other precondition options are common special cases that could in fact be specified using &%condition%&. - .option debug_print routers string&!! unset .cindex "testing" "variables in drivers" If this option is set and debugging is enabled (see the &%-d%& command line @@ -19813,13 +19990,16 @@ This option applies only to deliveries in maildir format, and is described in section &<>& below. -.option maildir_use_size_file appendfile boolean false +.new +.option maildir_use_size_file appendfile&!! boolean false .cindex "maildir format" "&_maildirsize_& file" -Setting this option true enables support for &_maildirsize_& files. Exim +The result of string expansion for this option must be a valid boolean value. +If it is true, it enables support for &_maildirsize_& files. Exim creates a &_maildirsize_& file in a maildir if one does not exist, taking the quota from the &%quota%& option of the transport. If &%quota%& is unset, the value is zero. See &%maildir_quota_directory_regex%& above and section &<>& below for further details. +.wen .option maildirfolder_create_regex appendfile string unset .cindex "maildir format" "&_maildirfolder_& file" @@ -20020,6 +20200,7 @@ The regular expression should not assume that the length is at the end of the file name (even though &%maildir_tag%& puts it there) because maildir MUAs sometimes add other information onto the ends of message file names. +Section &<>& contains further information. .option quota_warn_message appendfile string&!! "see below" @@ -20434,6 +20615,7 @@ tag is added to its name. However, if adding the tag takes the length of the name to the point where the test &[stat()]& call fails with ENAMETOOLONG, the tag is dropped and the maildir file is created with no tag. + .vindex "&$message_size$&" Tags can be used to encode the size of files in their names; see &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%& @@ -20443,8 +20625,19 @@ forced to fail, the tag is ignored, but a non-forced failure causes delivery to be deferred. The expanded tag may contain any printing characters except &"/"&. Non-printing characters in the string are ignored; if the resulting string is empty, it is ignored. If it starts with an alphanumeric character, a leading -colon is inserted. +colon is inserted; this default has not proven to be the path that popular +maildir implementations have chosen (but changing it in Exim would break +backwards compatibility). + +For one common implementation, you might set: +.code +maildir_tag = ,S=${message_size} +.endd +but you should check the documentation of the other software to be sure. +It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%& +as this allows Exim to extract the size from your tag, instead of having to +&[stat()]& each message file. .section "Using a maildirsize file" "SECID136" @@ -20870,9 +21063,14 @@ later"&. In this case, delivery is deferred. Details of a permanent failure are logged, but are not included in the bounce message, which merely contains &"local delivery failed"&. +If the command exits on a signal and the &%freeze_signal%& option is set then +the message will be frozen in the queue. If that option is not set, a bounce +will be sent as normal. + If the return code is greater than 128 and the command being run is a shell script, it normally means that the script was terminated by a signal whose -value is the return code minus 128. +value is the return code minus 128. The &%freeze_signal%& option does not +apply in this case. If Exim is unable to run the command (that is, if &[execve()]& fails), the return code is set to 127. This is the value that a shell returns if it is @@ -21081,6 +21279,14 @@ is set, failure to exec is treated specially, and causes the message to be frozen, whatever the setting of &%ignore_status%&. +.option freeze_signal pipe boolean false +.cindex "signal exit" +.cindex "&(pipe)& transport", "signal exit" +Normally if the process run by a command in a pipe transport exits on a signal, +a bounce message is sent. If &%freeze_signal%& is set, the message will be +frozen in Exim's queue instead. + + .option ignore_status pipe boolean false If this option is true, the status returned by the subprocess that is set up to run the command is ignored, and Exim behaves as if zero had been returned. @@ -21885,12 +22091,22 @@ is deferred. .option protocol smtp string smtp .cindex "LMTP" "over TCP/IP" +.cindex "ssmtp protocol" "outbound" +.cindex "TLS" "SSL-on-connect outbound" +.vindex "&$port$&" If this option is set to &"lmtp"& instead of &"smtp"&, the default value for the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local deliveries into closed message stores. Exim also has support for running LMTP over a pipe to a local process &-- see chapter &<>&. +.new +If this option is set to &"smtps"&, the default vaule for the &%port%& option +changes to &"smtps"&, and the transport initiates TLS immediately after +connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade. +The Internet standards bodies strongly discourage use of this mode. +.wen + .option retry_include_ip_address smtp boolean true Exim normally includes both the host name and the IP address in the key it @@ -23721,7 +23937,7 @@ login: driver = plaintext public_name = LOGIN server_prompts = Username:: : Password:: - server_condition = ${if and{{ + server_condition = ${if and{{ \ !eq{}{$auth1} }{ \ ldapauth{user="cn=${quote_ldap_dn:$auth1},ou=people,o=example.org" \ pass=${quote:$auth2} \ @@ -24410,8 +24626,14 @@ 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. +.new +For &%gnutls_require_protocols%&, the recognized names are TLS1.2, TLS1.1, +TLS1.0, (TLS1) and SSL3. +The default list contains TLS1.2, TLS1.1, TLS1.0, SSL3. +TLS1 is an alias for TLS1.0, for backwards compatibility. +For sufficiently old versions of the GnuTLS library, TLS1.2 or TLS1.1 might +not be supported and will not be recognised by Exim. +.wen In a server, the order of items in these lists is unimportant. The server advertises the availability of all the relevant cipher suites. However, in a @@ -24935,6 +25157,17 @@ and try again later, but that is their problem, though it does waste some of your resources. +.section "The SMTP DKIM ACL" "SECTDKIMACL" +The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support +enabled (which is the default). + +The ACL test specified by &%acl_smtp_dkim%& happens after a message has been +received, and is executed for each DKIM signature found in a message. If not +otherwise specified, the default action is to accept. + +For details on the operation of DKIM, see chapter &<>&. + + .section "The SMTP MIME ACL" "SECID194" The &%acl_smtp_mime%& option is available only when Exim is compiled with the content-scanning extension. For details, see chapter &<>&. @@ -25831,6 +26064,7 @@ warn control = caseful_local_part Notice that we put back the lower cased version afterwards, assuming that is what is wanted for subsequent tests. + .vitem &*control&~=&~debug/*&<&'options'&> .cindex "&ACL;" "enabling debug logging" .cindex "debugging" "enabling from an ACL" @@ -25848,6 +26082,7 @@ contexts): control = debug/tag=.$message_exim_id/opts=+expand .endd + .vitem &*control&~=&~enforce_sync*& &&& &*control&~=&~no_enforce_sync*& .cindex "SMTP" "synchronization checking" @@ -27052,69 +27287,118 @@ rate at which a recipient receives messages, you can use the key &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT ACL. -Internally, Exim appends the smoothing constant &'p'& and the options onto 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 forgets past behaviour. +Each &%ratelimit%& condition can have up to four options. A &%per_*%& option +specifies what Exim measures the rate of, for example messages or recipients +or bytes. You can adjust the measurement using the &%unique=%& and/or +&%count=%& options. You can also control when Exim updates the recorded rate +using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are +separated by a slash, like the other parameters. They may appear in any order. + +Internally, Exim appends the smoothing constant &'p'& onto the lookup key with +any options that alter the meaning of the stored data. The limit &'m'& is not +stored, so you can alter the configured maximum rate and Exim will still +remember clients' past behaviour. If you change the &%per_*%& mode or add or +remove the &%unique=%& option, the lookup key changes so Exim will forget past +behaviour. The lookup key is not affected by changes to the update mode and +the &%count=%& option. -Each &%ratelimit%& condition can have up to three options. One option -specifies what Exim measures the rate of, and the second specifies how Exim -handles excessively fast clients. The third option can be &`noupdate`&, to -disable updating of the ratelimiting database (see section &<>&). -The options are separated by a slash, like the other parameters. They may -appear in any order. .section "Ratelimit options for what is being measured" "ratoptmea" -The &%per_conn%& option limits the client's connection rate. +.cindex "rate limiting" "per_* options" +The &%per_conn%& option limits the client's connection rate. It is not +normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or +&%acl_not_smtp_start%& ACLs. The &%per_mail%& option limits the client's rate of sending messages. This is -the default if none of the &%per_*%& options is specified. - -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 specified by the client in its 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_rcpt%& option causes Exim to limit the rate at which -recipients are accepted. To be effective, it would need to be used in -either the &%acl_smtp_rcpt%& or the &%acl_not_smtp%& ACL. In the -&%acl_smtp_rcpt%& ACL, the number of recipients is incremented by one. -In the case of a locally submitted message in the &%acl_not_smtp%& ACL, -the number of recipients is incremented by the &%$recipients_count%& -for the entire message. Note that in either case the rate limiting -engine will see a message with many recipients as a large high-speed -burst. +the default if none of the &%per_*%& options is specified. It can be used in +&%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&, +&%acl_smtp_data%&, or &%acl_not_smtp%&. + +The &%per_byte%& option limits the sender's email bandwidth. It can be used in +the same ACLs as the &%per_mail%& option, though it is best to use this option +in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is +used in an earlier ACL, Exim relies on the SIZE parameter given by the client +in its 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_rcpt%& option causes Exim to limit the rate at which recipients are +accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, +&%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In +&%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other +ACLs the rate is updated with the total recipient count in one go. Note that +in either case the rate limiting engine will see a message with many +recipients as a large high-speed burst. + +The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the +number of different recipients that the client has sent messages to in the +last time period. That is, if the client repeatedly sends messages to the same +recipient, its measured rate is not increased. This option can only be used in +&%acl_smtp_rcpt%&. The &%per_cmd%& option causes Exim to recompute the rate every time the -condition is processed. This can be used to limit the SMTP command rate. -This command is essentially an alias of &%per_rcpt%& to make it clear -that the effect is to limit the rate at which individual commands, -rather than recipients, are accepted. +condition is processed. This can be used to limit the rate of any SMTP +command. If it is used in multiple ACLs it can limit the aggregate rate of +multiple different commands. + +The &%count=%& option can be used to alter how much Exim adds to the client's +measured rate. For example, the &%per_byte%& option is equivalent to +&`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim +increases the measured rate by one (except for the &%per_rcpt%& option in ACLs +other than &%acl_smtp_rcpt%&). The count does not have to be an integer. + +The &%unique=%& option is described in section &<>& below. + + +.section "Ratelimit update modes" "ratoptupd" +.cindex "rate limiting" "reading data without updating" +You can specify one of three options with the &%ratelimit%& condition to +control when its database is updated. This section describes the &%readonly%& +mode, and the next section describes the &%strict%& and &%leaky%& modes. + +If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a +previously-computed rate to check against the limit. + +For example, you can test the client's sending rate and deny it access (when +it is too fast) in the connect ACL. If the client passes this check then it +can go on to send a message, in which case its recorded rate will be updated +in the MAIL ACL. Subsequent connections from the same client will check this +new rate. +.code +acl_check_connect: + deny ratelimit = 100 / 5m / readonly + log_message = RATE CHECK: $sender_rate/$sender_rate_period \ + (max $sender_rate_limit) +# ... +acl_check_mail: + warn ratelimit = 100 / 5m / strict + log_message = RATE UPDATE: $sender_rate/$sender_rate_period \ + (max $sender_rate_limit) +.endd + +If Exim encounters multiple &%ratelimit%& conditions with the same key when +processing a message then it may increase the client's measured rate more than +it should. For example, this will happen if you check the &%per_rcpt%& option +in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the +same &%ratelimit%& condition multiple times in the same ACL. You can avoid any +multiple update problems by using the &%readonly%& option on later ratelimit +checks. + +The &%per_*%& options described above do not make sense in some ACLs. If you +use a &%per_*%& option in an ACL where it is not normally permitted then the +update mode defaults to &%readonly%& and you cannot specify the &%strict%& or +&%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the +next section) so you must specify the &%readonly%& option explicitly. -.section "Ratelimit options for handling fast clients" "ratophanfas" + +.section "Ratelimit options for handling fast clients" "ratoptfast" +.cindex "rate limiting" "strict and leaky modes" 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 +&%strict%& or &%leaky%& update modes. This is independent of the other counter-measures (such as 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. +rest of the ACL. -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 it is -actually allowed. If the client is over the limit it may be subjected to -counter-measures by the ACL until it slows down below the maximum rate. If -the client stops attempting to send email for the time specified in the &'p'& -parameter then its computed rate will decay exponentially to 37% of its peak -value. You can work out the time (the number of smoothing periods) that a -client is subjected to counter-measures after an over-limit burst with this -formula: -.code - ln(peakrate/maxrate) -.endd The &%leaky%& (default) 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 @@ -27122,6 +27406,59 @@ the maximum allowed. If the client is over the limit it may suffer some counter-measures (as specified in the ACL), but it will still be able to send email at the configured maximum rate, whatever the rate of its attempts. This is generally the better choice if you have clients that retry automatically. +For example, it does not prevent a sender with an over-aggressive retry rate +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 it is +actually allowed. If the client is over the limit it may be subjected to +counter-measures by the ACL. It must slow down and allow sufficient time to +pass that its computed rate falls below the maximum before it can send email +again. The time (the number of smoothing periods) it must wait and not +attempt to send mail can be calculated with this formula: +.code + ln(peakrate/maxrate) +.endd + + +.section "Limiting the rate of different events" "ratoptuniq" +.cindex "rate limiting" "counting unique events" +The &%ratelimit%& &%unique=%& option controls a mechanism for counting the +rate of different events. For example, the &%per_addr%& option uses this +mechanism to count the number of different recipients that the client has +sent messages to in the last time period; it is equivalent to +&`per_rcpt/unique=$local_part@$domain`&. You could use this feature to +measure the rate that a client uses different sender addresses with the +options &`per_mail/unique=$sender_address`&. + +For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it +has seen for that key. The whole set is thrown away when it is older than the +rate smoothing period &'p'&, so each different event is counted at most once +per period. In the &%leaky%& update mode, an event that causes the client to +go over the limit is not added to the set, in the same way that the client's +recorded rate is not updated in the same situation. + +When you combine the &%unique=%& and &%readonly%& options, the specific +&%unique=%& value is ignored, and Exim just retrieves the client's stored +rate. + +The &%unique=%& mechanism needs more space in the ratelimit database than the +other &%ratelimit%& options in order to store the event set. The number of +unique values is potentially as large as the rate limit, so the extra space +required increases with larger limits. + +The uniqueification is not perfect: there is a small probability that Exim +will think a new event has happened before. If the sender's rate is less than +the limit, Exim should be more than 99.9% correct. However in &%strict%& mode +the measured rate can go above the limit, in which case Exim may under-count +events by a significant margin. Fortunately, if the rate is high enough (2.7 +times the limit) that the false positive rate goes above 9%, then Exim will +throw away the over-full event set before the measured rate falls below the +limit. Therefore the only harm should be that exceptionally high sending rates +are logged incorrectly; any countermeasures you configure will be as effective +as intended. + .section "Using rate limiting" "useratlim" Exim's other ACL facilities are used to define what counter-measures are taken @@ -27165,36 +27502,6 @@ this means that Exim will lose its hints data after a reboot (including retry hints, the callout cache, and ratelimit data). -.section "Reading ratelimit data without updating" "rearatdat" -.cindex "rate limitint" "reading data without updating" -If the &%noupdate%& option is present on a &%ratelimit%& ACL condition, Exim -computes the rate and checks the limit as normal, but it does not update the -saved data. This means that, in relevant ACLs, it is possible to lookup the -existence of a specified (or auto-generated) ratelimit key without incrementing -the ratelimit counter for that key. In order for this to be useful, another ACL -entry must set the rate for the same key (otherwise it will always be zero). -For example: -.code -acl_check_connect: - deny ratelimit = 100 / 5m / strict / per_cmd / noupdate - log_message = RATE: $sender_rate/$sender_rate_period \ - (max $sender_rate_limit) -.endd -.display -&'... some other logic and tests...'& -.endd -.code -acl_check_mail: - warn ratelimit = 100 / 5m / strict / per_cmd - condition = ${if le{$sender_rate}{$sender_rate_limit}} - logwrite = RATE UPDATE: $sender_rate/$sender_rate_period \ - (max $sender_rate_limit) -.endd -In this example, the rate is tested and used to deny access (when it is too -high) in the connect ACL, but the actual computation of the remembered rate -happens later, on a per-command basis, in another ACL. - - .section "Address verification" "SECTaddressverification" .cindex "verifying address" "options for" @@ -27959,6 +28266,7 @@ It supports a &"generic"& interface to scanners called via the shell, and specialized interfaces for &"daemon"& type virus scanners, which are resident in memory and thus are much faster. + .oindex "&%av_scanner%&" You can set the &%av_scanner%& option in first part of the Exim configuration file to specify which scanner to use, together with any additional options that @@ -27984,6 +28292,7 @@ example: av_scanner = aveserver:/var/run/aveserver .endd + .vitem &%clamd%& .cindex "virus scanners" "clamd" This daemon-type scanner is GPL and free. You can get it at @@ -28282,7 +28591,6 @@ example &"34"& or &"305"&. It may appear to disagree with &$spam_score$& because &$spam_score$& is rounded and &$spam_score_int$& is truncated. The integer value is useful for numeric comparisons in conditions. - .vitem &$spam_bar$& A string consisting of a number of &"+"& or &"-"& characters, representing the integer part of the spam score value. A spam score of 4.4 would have a @@ -30968,8 +31276,8 @@ rejected (there seems little point) but instead just get qualified. HELO and EHLO act as RSET; VRFY, EXPN, ETRN and HELP, act as NOOP; QUIT quits. -No policy checking is done for BSMTP input. That is, no ACL is run at anytime. -In this respect it is like non-SMTP local input. +Minimal policy checking is done for BSMTP input. Only the non-SMTP +ACL is run in the same way as for non-SMTP local input. If an error is detected while reading a message, including a missing &"."& at the end, Exim gives up immediately. It writes details of the error to the @@ -31906,8 +32214,8 @@ log_file_path = $spool_directory/log/%slog If you do not specify anything at build time or run time, that is where the logs are written. -A log file path may also contain &`%D`& if datestamped log file names are in -use &-- see section &<>& below. +A log file path may also contain &`%D`& or &`%M`& if datestamped log file names +are in use &-- see section &<>& below. Here are some examples of possible settings: .display @@ -31951,14 +32259,15 @@ renamed. .cindex "log" "datestamped files" Instead of cycling the main and reject log files by renaming them periodically, some sites like to use files whose names contain a datestamp, -for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_&. -Exim has support for this way of working. It is enabled by setting the -&%log_file_path%& option to a path that includes &`%D`& at the point where the -datestamp is required. For example: +for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or +&_yyyymm_&. Exim has support for this way of working. It is enabled by setting +the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the +point where the datestamp is required. For example: .code log_file_path = /var/spool/exim/log/%slog-%D log_file_path = /var/log/exim-%s-%D.log log_file_path = /var/spool/exim/log/%D-%slog +log_file_path = /var/log/exim/%s.%M .endd As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are examples of names generated by the above examples: @@ -31966,6 +32275,7 @@ examples of names generated by the above examples: /var/spool/exim/log/mainlog-20021225 /var/log/exim-reject-20021225.log /var/spool/exim/log/20021225-mainlog +/var/log/exim/main.200212 .endd When this form of log file is specified, Exim automatically switches to new files at midnight. It does not make any attempt to compress old logs; you @@ -31974,14 +32284,16 @@ run &'exicyclog'& with this form of logging. The location of the panic log is also determined by &%log_file_path%&, but it is not datestamped, because rotation of the panic log does not make sense. -When generating the name of the panic log, &`%D`& is removed from the string. -In addition, if it immediately follows a slash, a following non-alphanumeric -character is removed; otherwise a preceding non-alphanumeric character is -removed. Thus, the three examples above would give these panic log names: +When generating the name of the panic log, &`%D`& or &`%M`& are removed from +the string. In addition, if it immediately follows a slash, a following +non-alphanumeric character is removed; otherwise a preceding non-alphanumeric +character is removed. Thus, the four examples above would give these panic +log names: .code /var/spool/exim/log/paniclog /var/log/exim-panic.log /var/spool/exim/log/paniclog +/var/log/exim/panic .endd @@ -33820,17 +34132,18 @@ which only root has access, this guards against someone who has broken into the Exim account from running a privileged Exim with an arbitrary configuration file, and using it to break into other accounts. .next -If a non-trusted configuration file (i.e. the default configuration file or -one which is trusted by virtue of matching a prefix listed in the -TRUSTED_CONFIG_PREFIX_LIST file) is specified with &%-C%&, or if macros are -given with &%-D%& (but see the next item), -then root privilege is retained only if the caller of Exim -is root. This locks out the possibility of testing a configuration using &%-C%& + +If a non-trusted configuration file (i.e. not the default configuration file +or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST +file) is specified with &%-C%&, or if macros are given with &%-D%& (but see +the next item), then root privilege is retained only if the caller of Exim is +root. This locks out the possibility of testing a configuration using &%-C%& right through message reception and delivery, even if the caller is root. The reception works, but by that time, Exim is running as the Exim user, so when it re-execs to regain privilege for the delivery, the use of &%-C%& causes privilege to be lost. However, root can test reception and delivery using two separate commands. + .next The WHITELIST_D_MACROS build option declares some macros to be safe to override with &%-D%& if the real uid is one of root, the Exim run-time user or the @@ -33852,7 +34165,6 @@ is permitted to modify the runtime file from using Exim as a way to get root. - .section "Root privilege" "SECID270" .cindex "setuid" .cindex "root privilege" @@ -34157,6 +34469,12 @@ arbitrary program's being run as exim, not as root. +.section "Dynamic module directory" "SECTdynmoddir" +Any dynamically loadable modules must be installed into the directory +defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit +loading it. + + .section "Use of sprintf()" "SECID279" .cindex "&[sprintf()]&" A large number of occurrences of &"sprintf"& in the code are actually calls to @@ -34644,6 +34962,7 @@ If a domain or identity is listed several times in the (expanded) value of Inside the &%acl_smtp_dkim%&, the following expansion variables are available (from most to least important): + .vlist .vitem &%$dkim_cur_signer%& The signer that is being evaluated in this ACL run. This can be a domain or @@ -34717,7 +35036,7 @@ integer size comparisons against this value. A colon-separated list of names of headers included in the signature. .vitem &%$dkim_key_testing%& "1" if the key record has the "testing" flag set, "0" if not. -.vitem &%$dkim_key_nosubdomaining%& +.vitem &%$nosubdomains%& "1" if the key record forbids subdomaining, "0" otherwise. .vitem &%$dkim_key_srvtype%& Service type (tag s=) from the key record. Defaults to "*" if not specified