X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/1e4519cc46416c1c81b9f468ce0ca5b88146037b..33a1a1bf0dc7d8202f09fda79e5a496645bbeb3b:/doc/doc-docbook/spec.xfpt?ds=inline diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 7b5e3ccd5..5cbc126a4 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -52,7 +52,7 @@ .set I "    " .macro copyyear -2016 +2017 .endmacro . ///////////////////////////////////////////////////////////////////////////// @@ -436,6 +436,7 @@ directory are: .row &_filter.txt_& "specification of the filter language" .row &_Exim3.upgrade_& "upgrade notes from release 2 to release 3" .row &_Exim4.upgrade_& "upgrade notes from release 3 to release 4" +.row &_openssl.txt_& "installing a current OpenSSL release" .endtable The main specification and the specification of the filtering language are also @@ -4481,12 +4482,12 @@ The name should not contain a &'/'& character. For a periodic queue run (see below) append to the name a slash and a time value. -If other commandline options speicify an action, a &'-qG'& option +If other commandline options specify an action, a &'-qG'& option will specify a queue to operate on. For example: .code exim -bp -qGquarantine -mailq -qGquarantime +mailq -qGquarantine exim -qGoffpeak -Rf @special.domain.example .endd .wen @@ -4926,8 +4927,12 @@ using this syntax: .endd on a line by itself. Double quotes round the file name are optional. If you use the first form, a configuration error occurs if the file does not exist; the -second form does nothing for non-existent files. In all cases, an absolute file +second form does nothing for non-existent files. +.new +The first form allows a relative name. It is resolved relative to +the directory of the including file. For the second form an absolute file name is required. +.wen Includes may be nested to any depth, but remember that Exim reads its configuration file often, so it is a good idea to keep them to a minimum. @@ -5033,6 +5038,33 @@ address lists. In Exim 4 these are handled better by named lists &-- see section &<>&. +.new +.section "Builtin macros" "SECTbuiltinmacros" +Exim defines some macros depending on facilities available, which may +differ due to build-time definitions and from one release to another. +All of these macros start with an underscore. +They can be used to conditionally include parts of a configuration +(see below). + +The following classes of macros are defined: +.display +&` _HAVE_* `& build-time defines +&` _DRIVER_ROUTER_* `& router drivers +&` _DRIVER_TRANSPORT_* `& transport drivers +&` _DRIVER_AUTHENTICATOR_* `& authenticator drivers +&` _OPT_MAIN_* `& main config options +&` _OPT_ROUTERS_* `& generic router options +&` _OPT_TRANSPORTS_* `& generic transport options +&` _OPT_AUTHENTICATORS_* `& generic authenticator options +&` _OPT_ROUTER_*_* `& private router options +&` _OPT_TRANSPORT_*_* `& private transport options +&` _OPT_AUTHENTICATOR_*_* `& private authenticator options +.endd + +Use an &"exim -bP macros"& command to get the list of macros. +.wen + + .section "Conditional skips in the configuration file" "SECID46" .cindex "configuration file" "conditional skips" .cindex "&`.ifdef`&" @@ -5136,7 +5168,11 @@ with the characters &"0x"&, in which case the remainder is interpreted as a hexadecimal number. If an integer value is followed by the letter K, it is multiplied by 1024; if -it is followed by the letter M, it is multiplied by 1024x1024. When the values +it is followed by the letter M, it is multiplied by 1024x1024; +.new +if by the letter G, 1024x1024x1024. +.wen +When the values of integer option settings are output, values which are an exact multiple of 1024 or 1024x1024 are sometimes, but not always, printed using the letters K and M. The printing style is independent of the actual input format that was @@ -6264,7 +6300,11 @@ Chapter &<>& covers both. Exim supports the use of regular expressions in many of its options. It uses the PCRE regular expression library; this provides regular expression matching that is compatible with Perl 5. The syntax and semantics of -regular expressions is discussed in many Perl reference books, and also in +regular expressions is discussed in +.new +online Perl manpages, in +.wen +many Perl reference books, and also in Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)). @@ -7084,7 +7124,7 @@ Retries for the dnsdb lookup can be controlled by a retry modifier. The form if &"retry_VAL"& where VAL is an integer. The default count is set by the main configuration option &%dns_retry%&. -.cindex cacheing "of dns lookup" +.cindex caching "of dns lookup" .cindex TTL "of dns lookup" .cindex DNS TTL Dnsdb lookup results are cached within a single process (and its children). @@ -9081,7 +9121,7 @@ If the ACL returns defer the result is a forced-fail. Otherwise the expansion f .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&& {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" -.cindex "expansion" "extracting cerificate fields" +.cindex "expansion" "extracting certificate fields" .cindex "&%certextract%&" "certificate fields" .cindex "certificate" "extracting fields" The <&'certificate'&> must be a variable of type certificate. @@ -9398,12 +9438,19 @@ message, and any that are added by an ACL statement or by a system filter. Header lines that are added to a particular copy of a message by a router or transport are not accessible. -For incoming SMTP messages, no header lines are visible in ACLs that are obeyed -before the DATA ACL, because the header structure is not set up until the -message is received. Header lines that are added in a RCPT ACL (for example) +For incoming SMTP messages, no header lines are visible in +.new +ACLs that are obeyed before the data phase completes, +.wen +because the header structure is not set up until the message is received. +They are visible in DKIM, PRDR and DATA ACLs. +Header lines that are added in a RCPT ACL (for example) are saved until the message's incoming header lines are available, at which -point they are added. When a DATA ACL is running, however, header lines added -by earlier ACLs are visible. +point they are added. +.new +When any of the above ACLs ar +.wen +running, however, header lines added by earlier ACLs are visible. Upper case and lower case letters are synonymous in header names. If the following character is white space, the terminating colon may be omitted, but @@ -10158,6 +10205,15 @@ escape sequences starting with a backslash. Whether characters with the most significant bit set (so-called &"8-bit characters"&) count as printing or not is controlled by the &%print_topbitchars%& option. +.new +.vitem &*${escape8bit:*&<&'string'&>&*}*& +.cindex "expansion" "escaping 8-bit characters" +.cindex "&%escape8bit%& expansion item" +If the string contains and characters with the most significant bit set, +they are converted to escape sequences starting with a backslash. +Backslashes and DEL characters are also converted. +.wen + .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*& .cindex "expansion" "expression evaluation" @@ -12178,7 +12234,7 @@ normally the gid of the Exim user. .cindex "uid (user id)" "of originating user" .cindex "sender" "uid" .vindex "&$caller_uid$&" -.vindex "&$originaltor_uid$&" +.vindex "&$originator_uid$&" The value of &$caller_uid$& that was set when the message was received. For messages received via the command line, this is the uid of the sending user. For messages received by SMTP over TCP/IP, this is normally the uid of the Exim @@ -12579,6 +12635,13 @@ validating resolver (e.g. unbound, or bind with suitable configuration). If you have changed &%host_lookup_order%& so that &`bydns`& is not the first mechanism in the list, then this variable will be false. +.new +This requires that your system resolver library support EDNS0 (and that +DNSSEC flags exist in the system headers). If the resolver silently drops +all EDNS0 options, then this will have no effect. OpenBSD's asr resolver +is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3). +.wen + .vitem &$sender_host_name$& .vindex "&$sender_host_name$&" @@ -12800,7 +12863,7 @@ If TLS has not been negotiated, the value will be 0. .vitem &$tls_in_ourcert$& .vindex "&$tls_in_ourcert$&" -.cindex certificate veriables +.cindex certificate variables This variable refers to the certificate presented to the peer of an inbound connection when the message was received. It is only useful as the argument of a @@ -12990,8 +13053,7 @@ or external command, as described above. It is also used during a .vitem &$verify_mode$& .vindex "&$verify_mode$&" -While a router or transport is being run in verify mode -or for cutthrough delivery, +While a router or transport is being run in verify mode or for cutthrough delivery, contains "S" for sender-verification or "R" for recipient-verification. Otherwise, empty. @@ -13072,7 +13134,7 @@ initial startup, even if &%perl_at_start%& is set. .oindex "&%perl_taintmode%&" .cindex "Perl" "taintmode" To provide more security executing Perl code via the embedded Perl -interpeter, the &%perl_taintmode%& option can be set. This enables the +interpreter, the &%perl_taintmode%& option can be set. This enables the taint mode of the Perl interpreter. You are encouraged to set this option to a true value. To avoid breaking existing installations, it defaults to false. @@ -13556,6 +13618,7 @@ listed in more than one group. .row &%slow_lookup_log%& "control logging of slow DNS lookups" .row &%syslog_duplication%& "controls duplicate log lines on syslog" .row &%syslog_facility%& "set syslog &""facility""& field" +.row &%syslog_pid%& "pid in syslog lines" .row &%syslog_processname%& "set syslog &""ident""& field" .row &%syslog_timestamp%& "timestamp syslog lines" .row &%write_rejectlog%& "control use of message log" @@ -13992,6 +14055,7 @@ acknowledgment is sent. See chapter &<>& for further details. .option acl_smtp_dkim main string&!! unset .cindex DKIM "ACL for" This option defines the ACL that is run for each DKIM signature +(by default, or as specified in the dkim_verify_signers option) of a received message. See chapter &<>& for further details. @@ -14308,11 +14372,15 @@ $primary_hostname-$tod_epoch-testing See section &<>& for details of how this value is used. -.option check_log_inodes main integer 0 +.new +.option check_log_inodes main integer 100 +.wen See &%check_spool_space%& below. -.option check_log_space main integer 0 +.new +.option check_log_space main integer 10M +.wen See &%check_spool_space%& below. .oindex "&%check_rfc2047_length%&" @@ -14327,11 +14395,15 @@ of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is set false, Exim recognizes encoded words of any length. -.option check_spool_inodes main integer 0 +.new +.option check_spool_inodes main integer 100 +.wen See &%check_spool_space%& below. -.option check_spool_space main integer 0 +.new +.option check_spool_space main integer 10M +.wen .cindex "checking disk space" .cindex "disk space, checking" .cindex "spool directory" "checking space" @@ -14342,7 +14414,7 @@ message is accepted. .vindex "&$log_space$&" .vindex "&$spool_inodes$&" .vindex "&$spool_space$&" -When any of these options are set, they apply to all incoming messages. If you +When any of these options are nonzero, they apply to all incoming messages. If you want to apply different checks to different kinds of message, you can do so by testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and &$spool_space$& in an ACL with appropriate additional conditions. @@ -14351,7 +14423,7 @@ testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if either value is greater than zero, for example: .code -check_spool_space = 10M +check_spool_space = 100M check_spool_inodes = 100 .endd The spool partition is the one that contains the directory defined by @@ -14370,12 +14442,20 @@ SIZE parameter on the MAIL command, its value is added to the &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set. The values for &%check_spool_space%& and &%check_log_space%& are held as a -number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up. +number of kilobytes (though specified in bytes). +If a non-multiple of 1024 is specified, it is rounded up. For non-SMTP input and for batched SMTP input, the test is done at start-up; on failure a message is written to stderr and Exim exits with a non-zero code, as it obviously cannot send an error message of any kind. +.new +There is a slight performance penalty for these checks. +Versions of Exim preceding 4.88 had these disabled by default; +high-rate installations confident they will never run out of resources +may wish to deliberately disable them. +.wen + .new .option chunking_advertise_hosts main "host list&!!" * .cindex CHUNKING advertisement @@ -14406,6 +14486,7 @@ See &%daemon_startup_retries%&. .option delay_warning main "time list" 24h .cindex "warning of delay" .cindex "delay warning, specifying" +.cindex "queue" "delay warning" When a message is delayed, Exim sends a warning message to the sender at intervals specified by this option. The data is a colon-separated list of times after which to send warning messages. If the value of the option is an empty @@ -14633,6 +14714,7 @@ record in the authoritative section is used instead. .option dns_use_edns0 main integer -1 .cindex "DNS" "resolver options" .cindex "DNS" "EDNS0" +.cindex "DNS" "OpenBSD 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 @@ -14640,6 +14722,12 @@ on. If the resolver library does not support EDNS0 then this option has no effect. +.new +OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this +means that DNSSEC will not work with Exim on that platform either, unless Exim +is linked against an alternative DNS client library. +.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 @@ -14738,7 +14826,7 @@ not used. .option event_action main string&!! unset .cindex events This option declares a string to be expanded for Exim's events mechanism. -For details see &<>&. +For details see chapter &<>&. .option exim_group main string "compile-time configured" @@ -15089,7 +15177,7 @@ If the &%smtp_connection%& log selector is not set, this option has no effect. .option hosts_proxy main "host list&!!" unset .cindex proxy "proxy protocol" This option enables use of Proxy Protocol proxies for incoming -connections. For details see &<>&. +connections. For details see section &<>&. .option hosts_treat_as_local main "domain list&!!" unset @@ -15263,6 +15351,9 @@ connecting on a regular LDAP port. This is the LDAP equivalent of SMTP's of SSL-on-connect. In the event of failure to negotiate TLS, the action taken is controlled by &%ldap_require_cert%&. +.new +This option is ignored for &`ldapi`& connections. +.wen .option ldap_version main integer unset @@ -16681,7 +16772,7 @@ example, instead of &"Administrative prohibition"&, it might give: .option smtputf8_advertise_hosts main "host list&!!" * .cindex "SMTPUTF8" "advertising" When Exim is built with support for internationalised mail names, -the availability therof is advertised in +the availability thereof is advertised in response to EHLO only to those client hosts that match this option. See chapter &<>& for details of Exim's support for internationalisation. @@ -16802,6 +16893,15 @@ If this option is unset, &"mail"& is used. See chapter &<>& for details of Exim's logging. +.option syslog_pid main boolean true +.cindex "syslog" "pid" +If &%syslog_pid%& is set false, the PID on Exim's log lines are +omitted when these lines are sent to syslog. (Syslog normally prefixes +the log lines with the PID of the logging process automatically.) You need +to enable the &`+pid`& log selector item, if you want Exim to write it's PID +into the logs.) See chapter &<>& for details of Exim's logging. + + .option syslog_processname main string &`exim`& .cindex "syslog" "process name; setting" @@ -16829,6 +16929,9 @@ generates any deliveries to files or pipes, or any new mail messages, the appropriate &%system_filter_..._transport%& option(s) must be set, to define which transports are to be used. Details of this facility are given in chapter &<>&. +.new +A forced expansion failure results in no filter operation. +.wen .option system_filter_directory_transport main string&!! unset @@ -17001,7 +17104,15 @@ larger prime than requested. The value of this option is expanded and indicates the source of DH parameters to be used by Exim. -If it is a filename starting with a &`/`&, then it names a file from which DH +.new +&*Note: The Exim Maintainers strongly recommend using a filename with site-generated +local DH parameters*&, which has been supported across all versions of Exim. The +other specific constants available are a fallback so that even when +"unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS. +.wen + +If &%tls_dhparam%& is a filename starting with a &`/`&, +then it names a file from which DH parameters should be loaded. If the file exists, it should hold a PEM-encoded PKCS#3 representation of the DH prime. If the file does not exist, for OpenSSL it is an error. For GnuTLS, Exim will attempt to create the file and @@ -17017,23 +17128,39 @@ Exim will attempt to load a file from inside the spool directory. If the file does not exist, Exim will attempt to create it. See section &<>& for further details. +.new If Exim is using OpenSSL and this option is empty or unset, then Exim will load -a default DH prime; the default is the 2048 bit prime described in section +a default DH prime; the default is Exim-specific but lacks verifiable provenance. + +In older versions of Exim the default was the 2048 bit prime described in section 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which in IKE is assigned number 23. Otherwise, the option must expand to the name used by Exim for any of a number -of DH primes specified in RFC 2409, RFC 3526 and RFC 5114. As names, Exim uses -"ike" followed by the number used by IKE, or "default" which corresponds to -"ike23". +of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other +sources. As names, Exim uses a standard specified name, else "ike" followed by +the number used by IKE, or "default" which corresponds to +&`exim.dev.20160529.3`&. -The available primes are: +The available standard primes are: +&`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&, &`ike1`&, &`ike2`&, &`ike5`&, &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&, -&`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&. +&`ike22`&, &`ike23`& and &`ike24`&. + +The available additional primes are: +&`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&. Some of these will be too small to be accepted by clients. Some may be too large to be accepted by clients. +The open cryptographic community has suspicions about the integrity of some +of the later IKE values, which led into RFC7919 providing new fixed constants +(the "ffdhe" identifiers). + +At this point, all of the "ike" values should be considered obsolete; +they're still in Exim to avoid breaking unusual configurations, but are +candidates for removal the next time we have backwards-incompatible changes. +.wen The TLS protocol does not negotiate an acceptable size for this; clients tend to hard-drop connections if what is offered by the server is unacceptable, @@ -17051,17 +17178,19 @@ prior to the 4.80 release, as Debian used to patch Exim to raise the minimum acceptable bound from 1024 to 2048. -.option tls_eccurve main string&!! prime256v1 +.option tls_eccurve main string&!! &`auto`& .cindex TLS "EC cryptography" -If built with a recent-enough version of OpenSSL, -this option selects a EC curve for use by Exim. +This option selects a EC curve for use by Exim. + +After expansion it must contain a valid EC curve parameter, such as +&`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual +for valid selections. -Curve names of the form &'prime256v1'& are accepted. -For even more-recent library versions, names of the form &'P-512'& -are also accepted, plus the special value &'auto'& -which tells the library to choose. +For OpenSSL versions before (and not including) 1.0.2, the string +&`auto`& selects &`prime256v1`&. For more recent OpenSSL versions +&`auto`& tells the library to choose. -If the option is set to an empty string, no EC curves will be enabled. +If the option expands to an empty string, no EC curves will be enabled. .option tls_ocsp_file main string&!! unset @@ -20830,7 +20959,7 @@ resent to other recipients. .option event_action transports string&!! unset .cindex events This option declares a string to be expanded for Exim's events mechanism. -For details see &<>&. +For details see chapter &<>&. .option group transports string&!! "Exim group" @@ -20945,7 +21074,7 @@ The control does not apply to shadow transports. .cindex "hints database" "transport concurrency control" Exim implements this control by means of a hints database in which a record is -incremented whenever a transport process is beaing created. The record +incremented whenever a transport process is being created. The record is decremented and possibly removed when the process terminates. Obviously there is scope for records to get left lying around if there is a system or program crash. To @@ -23202,12 +23331,12 @@ message_suffix = &`\n`& to &`\r\n`& in &%message_suffix%&. -.option path pipe string "see below" -This option specifies the string that is set up in the PATH environment -variable of the subprocess. The default is: -.code -/bin:/usr/bin -.endd +.option path pipe string&!! "/bin:/usr/bin" +.new +This option is expanded and +.wen +specifies the string that is set up in the PATH environment +variable of the subprocess. If the &%command%& option does not yield an absolute path name, the command is sought in the PATH directories, in the usual way. &*Warning*&: This does not apply to a command specified as a transport filter. @@ -23592,7 +23721,7 @@ of the message. Its value must not be zero. See also &%final_timeout%&. .option dkim_canon smtp string&!! unset .option dkim_strict smtp string&!! unset .option dkim_sign_headers smtp string&!! unset -DKIM signing options. For details see &<>&. +DKIM signing options. For details see section &<>&. .option delay_after_cutoff smtp boolean true @@ -23908,9 +24037,28 @@ unauthenticated. See also &%hosts_require_auth%&, and chapter .cindex CHUNKING "enabling, in client" .cindex BDAT "SMTP command" .cindex "RFC 3030" "CHUNKING" -This option provides a list of server to which, provided they announce +This option provides a list of servers to which, provided they announce CHUNKING support, Exim will attempt to use BDAT commands rather than DATA. -BDAT will not be used in conjuction with a transport filter. +BDAT will not be used in conjunction with a transport filter. +.wen + +.new +.option hosts_try_fastopen smtp "host list!!" unset +.cindex "fast open, TCP" "enabling, in client" +.cindex "TCP Fast Open" "enabling, in client" +.cindex "RFC 7413" "TCP Fast Open" +This option provides a list of servers to which, provided +the facility is supported by this system, Exim will attempt to +perform a TCP Fast Open. +No data is sent on the SYN segment but, if the remote server also +supports the facility, it can send its SMTP banner immediately after +the SYN,ACK segment. This can save up to one round-trip time. + +The facility is only active for previously-contacted servers, +as the initiator must present a cookie in the SYN segment. + +On (at least some) current Linux distributions the facility must be enabled +in the kernel by the sysadmin before the support is usable. .wen .option hosts_try_prdr smtp "host list&!!" * @@ -24083,7 +24231,7 @@ the use of the SIZE option altogether. .option socks_proxy smtp string&!! unset .cindex proxy SOCKS This option enables use of SOCKS proxies for connections made by the -transport. For details see &<>&. +transport. For details see section &<>&. .option tls_certificate smtp string&!! unset @@ -25788,6 +25936,19 @@ turned into a permanent error if you wish. In the second case, Exim tries to deliver the message unauthenticated. .endlist +.new +Note that the hostlist test for whether to do authentication can be +confused if name-IP lookups change between the time the peer is decided +on and the transport running. For example, with a manualroute +router given a host name, and DNS "round-robin" use by that name: if +the local resolver cache times out between the router and the transport +running, the transport may get an IP for the name for its authentication +check which does not match the connection peer IP. +No authentication will then be done, despite the names being identical. + +For such cases use a separate transport which always authenticates. +.wen + .cindex "AUTH" "on MAIL command" When Exim has authenticated itself to a remote server, it adds the AUTH parameter to the MAIL commands it sends, if it has an authenticated sender for @@ -26697,7 +26858,7 @@ tls: .endd This accepts a client certificate that is verifiable against any of your configured trust-anchors -which usually means the full set of public CAs) +(which usually means the full set of public CAs) and which has a SAN with a good account name. Note that the client cert is on the wire in-clear, including the SAN, whereas a plaintext SMTP AUTH done inside TLS is not. @@ -27459,8 +27620,13 @@ during TLS session handshake, to permit alternative values to be chosen: Great care should be taken to deal with matters of case, various injection attacks in the string (&`../`& or SQL), and ensuring that a valid filename -can always be referenced; it is important to remember that &$tls_sni$& is +can always be referenced; it is important to remember that &$tls_in_sni$& is arbitrary unverified data provided prior to authentication. +.new +Further, the initial certificate is loaded before SNI is arrived, so +an expansion for &%tls_certificate%& must have a default which is used +when &$tls_in_sni$& is empty. +.wen The Exim developers are proceeding cautiously and so far no other TLS options are re-expanded. @@ -28004,6 +28170,11 @@ run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the remaining recipients. The &"discard"& return is not permitted for the &%acl_smtp_predata%& ACL. +.new +If the ACL for VRFY returns &"accept"&, a recipient verify (without callout) +is done on the address and the result determines the SMTP response. +.wen + .cindex "&[local_scan()]& function" "when all recipients discarded" The &[local_scan()]& function is always run, even if there are no remaining @@ -28115,7 +28286,7 @@ provides a means of specifying an &"and"& conjunction between conditions. For example: .code deny dnslists = list1.example -dnslists = list2.example + dnslists = list2.example .endd If there are no conditions, the verb is always obeyed. Exim stops evaluating the conditions and modifiers when it reaches a condition that fails. What @@ -28137,8 +28308,8 @@ after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to check a RCPT command: .code accept domains = +local_domains -endpass -verify = recipient + endpass + verify = recipient .endd If the recipient domain does not match the &%domains%& condition, control passes to the next statement. If it does match, the recipient is verified, and @@ -28789,7 +28960,7 @@ Notice that we put back the lower cased version afterwards, assuming that is what is wanted for subsequent tests. -.vitem &*control&~=&~cutthrough_delivery*& +.vitem &*control&~=&~cutthrough_delivery/*&<&'options'&> .cindex "&ACL;" "cutthrough routing" .cindex "cutthrough" "requesting" This option requests delivery be attempted while the item is being received. @@ -28825,15 +28996,28 @@ message body. Cutthrough delivery is not supported via transport-filters or when DKIM signing of outgoing messages is done, because it sends data to the ultimate destination before the entire message has been received from the source. -It is not supported for messages received with the SMTP PRDR option in use. +It is not supported for messages received with the SMTP PRDR +.new +or CHUNKING +.wen +options in use. Should the ultimate destination system positively accept or reject the mail, a corresponding indication is given to the source system and nothing is queued. -If there is a temporary error the item is queued for later delivery in the -usual fashion. If the item is successfully delivered in cutthrough mode +If the item is successfully delivered in cutthrough mode the delivery log lines are tagged with ">>" rather than "=>" and appear before the acceptance "<=" line. +.new +If there is a temporary error the item is queued for later delivery in the +usual fashion. +This behaviour can be adjusted by appending the option &*defer=*&<&'value'&> +to the control; the default value is &"spool"& and the alternate value +&"pass"& copies an SMTP defer response from the target back to the initiator +and does not queue the message. +Note that this is independent of any recipient verify conditions in the ACL. +.wen + Delivery in this mode avoids the generation of a bounce mail to a (possibly faked) sender when the destination system is doing content-scan based rejection. @@ -29058,7 +29242,7 @@ that are being submitted at the same time using &%-bs%& or &%-bS%&. .vitem &*control&~=&~utf8_downconvert*& This control enables conversion of UTF-8 in message addresses to a-label form. -For details see &<>&. +For details see section &<>&. .endlist vlist @@ -29671,6 +29855,15 @@ to avoid doing it more than once per message. .cindex "&%verify%& ACL condition" This is a variation of the previous option, in which a modified address is verified as a sender. + +.new +Note that '/' is legal in local-parts; if the address may have such +(eg. is generated from the received message) +they must be protected from the options parsing by doubling: +.code +verify = sender=${sg{${address:$h_sender:}}{/}{//}} +.endd +.wen .endlist @@ -29730,7 +29923,7 @@ deny dnslists = blackholes.mail-abuse.org warn message = X-Warn: sending host is on dialups list dnslists = dialups.mail-abuse.org .endd -.cindex cacheing "of dns lookup" +.cindex caching "of dns lookup" .cindex DNS TTL DNS list lookups are cached by Exim for the duration of the SMTP session (but limited by the DNS return TTL value), @@ -29843,7 +30036,7 @@ multiple DNS records. The inner dnsdb lookup produces a list of MX hosts and the outer dnsdb lookup finds the IP addresses for these hosts. The result of expanding the condition might be something like this: .code -dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|... +dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|... .endd Thus, this example checks whether or not the IP addresses of the sender domain's mail servers are on the Spamhaus black list. @@ -31547,6 +31740,15 @@ configuration as follows (example): .code spamd_address = 192.168.99.45 387 .endd +The SpamAssassin protocol relies on a TCP half-close from the client. +If your SpamAssassin client side is running a Linux system with an +iptables firewall, consider setting +&%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the +timeout, Exim uses when waiting for a response from the SpamAssassin +server (currently defaulting to 120s). With a lower value the Linux +connection tracking may consider your half-closed connection as dead too +soon. + To use Rspamd (which by default listens on all local addresses on TCP port 11333) @@ -35693,7 +35895,7 @@ the following table: &`P `& on &`<=`& lines: protocol used &` `& on &`=>`& and &`**`& lines: return path &`PRDR`& PRDR extension used -&`PRX `& on &'<='& and &`=>`& lines: proxy address +&`PRX `& on &`<=`& and &`=>`& lines: proxy address &`Q `& alternate queue name &`QT `& on &`=>`& lines: time spent on queue so far &` `& on &"Completed"& lines: time spent on queue @@ -35960,7 +36162,7 @@ off the &%outgoing_interface%& option. .next .cindex "log" "outgoing remote port" .cindex "port" "logging outgoint remote" -.cindex "TCP/IP" "logging ougtoing remote port" +.cindex "TCP/IP" "logging outgoing remote port" &%outgoing_port%&: The remote port number is added to delivery log lines (those containing => tags) following the IP address. The local port is also added if &%incoming_interface%& and @@ -37789,9 +37991,8 @@ lock will be lost at the instant of rename. .next .vindex "&$body_linecount$&" If you change the number of lines in the file, the value of -&$body_linecount$&, which is stored in the -H file, will be incorrect. At -present, this value is not used by Exim, but there is no guarantee that this -will always be the case. +&$body_linecount$&, which is stored in the -H file, will be incorrect and can +cause incomplete transmission of messages or undeliverable messages. .next If the message is in MIME format, you must take care not to break it. .next @@ -38092,14 +38293,14 @@ DKIM is documented in RFC 4871. DKIM support is compiled into Exim by default if TLS support is present. It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&. -Exim's DKIM implementation allows to +Exim's DKIM implementation allows for .olist -Sign outgoing messages: This function is implemented in the SMTP transport. +Signing outgoing messages: This function is implemented in the SMTP transport. It can co-exist with all other Exim features (including transport filters) except cutthrough delivery. .next -Verify signatures in incoming messages: This is implemented by an additional +Verifying signatures in incoming messages: This is implemented by an additional ACL (acl_smtp_dkim), which can be called several times per message, with different signature contexts. .endlist @@ -38135,6 +38336,7 @@ These options take (expandable) strings as arguments. MANDATORY: The domain you want to sign with. The result of this expanded option is put into the &%$dkim_domain%& expansion variable. +If it is empty after expansion, DKIM signing is not done. .option dkim_selector smtp string&!! unset MANDATORY: @@ -38238,6 +38440,7 @@ available (from most to least important): The signer that is being evaluated in this ACL run. This can be a domain or an identity. This is one of the list items from the expanded main option &%dkim_verify_signers%& (see above). + .vitem &%$dkim_verify_status%& A string describing the general status of the signature. One of .ilist @@ -38252,6 +38455,7 @@ available in &%$dkim_verify_reason%&. .next &%pass%&: The signature passed verification. It is valid. .endlist + .vitem &%$dkim_verify_reason%& A string giving a little bit more detail when &%$dkim_verify_status%& is either "fail" or "invalid". One of @@ -38271,51 +38475,73 @@ could not be verified. This may mean that headers were modified, re-written or otherwise changed in a way which is incompatible with DKIM verification. It may of course also mean that the signature is forged. .endlist + .vitem &%$dkim_domain%& The signing domain. IMPORTANT: This variable is only populated if there is an actual signature in the message for the current domain or identity (as reflected by &%$dkim_cur_signer%&). + .vitem &%$dkim_identity%& The signing identity, if present. IMPORTANT: This variable is only populated if there is an actual signature in the message for the current domain or identity (as reflected by &%$dkim_cur_signer%&). + .vitem &%$dkim_selector%& The key record selector string. + .vitem &%$dkim_algo%& The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'. + .vitem &%$dkim_canon_body%& The body canonicalization method. One of 'relaxed' or 'simple'. + .vitem &%dkim_canon_headers%& The header canonicalization method. One of 'relaxed' or 'simple'. + .vitem &%$dkim_copiedheaders%& A transcript of headers and their values which are included in the signature (copied from the 'z=' tag of the signature). +.new +Note that RFC6376 requires that verification fail if the From: header is +not included in the signature. Exim does not enforce this; sites wishing +strict enforcement should code the check explicitly. +.wen + .vitem &%$dkim_bodylength%& The number of signed body bytes. If zero ("0"), the body is unsigned. If no limit was set by the signer, "9999999999999" is returned. This makes sure that this variable always expands to an integer value. + .vitem &%$dkim_created%& UNIX timestamp reflecting the date and time when the signature was created. When this was not specified by the signer, "0" is returned. + .vitem &%$dkim_expires%& UNIX timestamp reflecting the date and time when the signer wants the signature to be treated as "expired". When this was not specified by the signer, "9999999999999" is returned. This makes it possible to do useful integer size comparisons against this value. + .vitem &%$dkim_headernames%& 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_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 in the key record. + .vitem &%$dkim_key_granularity%& Key granularity (tag g=) from the key record. Defaults to "*" if not specified in the key record. + .vitem &%$dkim_key_notes%& Notes from the key record (tag n=). + .vitem &%$dkim_key_length%& Number of bits in the key. .endlist @@ -38330,13 +38556,18 @@ for a match against the domain or identity that the ACL is currently verifying verb to a group of domains or identities. For example: .code -# Warn when Mail purportedly from GMail has no signature at all -warn log_message = GMail sender without DKIM signature +# Warn when Mail purportedly from GMail has no gmail signature +warn log_message = GMail sender without gmail.com DKIM signature sender_domains = gmail.com dkim_signers = gmail.com dkim_status = none .endd +.new +Note that the above does not check for a total lack of DKIM signing; +for that check for empty &$h_DKIM-Signature:$& in the data ACL. +.wen + .vitem &%dkim_status%& ACL condition that checks a colon-separated list of possible DKIM verification results against the actual result of verification. This is typically used @@ -38378,9 +38609,9 @@ To include this support, include &"SUPPORT_PROXY=yes"& in Local/Makefile. It was built on specifications from: -http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt +(&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)). That URL was revised in May 2014 to version 2 spec: -http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e +(&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)). The purpose of this facility is so that an application load balancer, such as HAProxy, can sit in front of several Exim servers @@ -38516,6 +38747,12 @@ Exim has support for Internationalised mail names. To include this it must be built with SUPPORT_I18N and the libidn library. Standards supported are RFCs 2060, 5890, 6530 and 6533. +.new +If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not +instead of it) then IDNA2008 is supported; this adds an extra library +requirement, upon libidn2. +.wen + .section "MTA operations" SECTi18nMTA .cindex SMTPUTF8 "ESMTP option" The main configuration option &%smtputf8_advertise_hosts%& specifies @@ -38629,7 +38866,7 @@ must be representable in UTF-16. .cindex events The events mechanism in Exim can be used to intercept processing at a number -of points. It was originally invented to giave a way to do customised logging +of points. It was originally invented to give a way to do customised logging actions (for example, to a database) but can also be used to modify some processing actions. @@ -38688,7 +38925,7 @@ can be used to affect that action (more on this below). An additional variable, &$event_data$&, is filled with information varying with the event type: .display -&`msg:delivery `& smtp confirmation mssage +&`msg:delivery `& smtp confirmation message &`msg:rcpt:host:defer `& error string &`msg:rcpt:defer `& error string &`msg:host:defer `& error string @@ -38699,7 +38936,7 @@ with the event type: The :defer events populate one extra variable: &$event_defer_errno$&. For complex operations an ACL expansion can be used in &%event_action%& -however due to the multiple contextx that Exim operates in during +however due to the multiple contexts that Exim operates in during the course of its processing: .ilist variables set in transport events will not be visible outside that