X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/aeaf5db33f20a06399b8b15630cd2f5e9755e38a..dc7b3d368017727e9438fc7463b0841df1e4aa41:/doc/doc-docbook/spec.xfpt?ds=inline diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index d78797fb7..411eb988e 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -12451,6 +12451,8 @@ inbound connection when the message was received. It is only useful as the argument of a &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator, or a &%def%& condition. +If certificate verification fails it may refer to a failing chain element +which is not the leaf. .vitem &$tls_out_ourcert$& .vindex "&$tls_out_ourcert$&" @@ -12465,6 +12467,8 @@ This variable refers to the certificate presented by the peer of an outbound connection. It is only useful as the argument of a &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator, or a &%def%& condition. +If certificate verification fails it may refer to a failing chain element +which is not the leaf. .vitem &$tls_in_certificate_verified$& .vindex "&$tls_in_certificate_verified$&" @@ -12528,6 +12532,8 @@ When a message is received from a remote host over an encrypted SMTP connection, and Exim is configured to request a certificate from the client, the value of the Distinguished Name of the certificate is made available in the &$tls_in_peerdn$& during subsequent processing. +If certificate verification fails it may refer to a failing chain element +which is not the leaf. The deprecated &$tls_peerdn$& variable refers to the inbound side except when used in the context of an outbound SMTP delivery, when it refers to @@ -12539,6 +12545,8 @@ When a message is being delivered to a remote host over an encrypted SMTP connection, and Exim is configured to request a certificate from the server, the value of the Distinguished Name of the certificate is made available in the &$tls_out_peerdn$& during subsequent processing. +If certificate verification fails it may refer to a failing chain element +which is not the leaf. .vitem &$tls_in_sni$& .vindex "&$tls_in_sni$&" @@ -17154,7 +17162,10 @@ and the discussion in chapter &<>&. .option headers_add routers list&!! unset .cindex "header lines" "adding" .cindex "router" "adding header lines" -This option specifies a list of text headers, newline-separated, +This option specifies a list of text headers, +.new +newline-separated (by default, changeable in the usual way), +.wen that is associated with any addresses that are accepted by the router. Each item is separately expanded, at routing time. However, this option has no effect when an address is just being verified. The way in which @@ -17191,7 +17202,10 @@ avoided. The &%repeat_use%& option of the &%redirect%& router may be of help. .option headers_remove routers list&!! unset .cindex "header lines" "removing" .cindex "router" "removing header lines" -This option specifies a list of text headers, colon-separated, +This option specifies a list of text headers, +.new +colon-separated (by default, changeable in the usual way), +.wen that is associated with any addresses that are accepted by the router. Each item is separately expanded, at routing time. However, this option has no effect when an address is just being verified. The way in which @@ -20238,7 +20252,10 @@ value that the router supplies, and also overriding any value associated with .option headers_add transports list&!! unset .cindex "header lines" "adding in transport" .cindex "transport" "header lines; adding" -This option specifies a list of text headers, newline-separated, +This option specifies a list of text headers, +.new +newline-separated (by default, changeable in the usual way), +.wen which are (separately) expanded and added to the header portion of a message as it is transported, as described in section &<>&. Additional header lines can also be specified by @@ -20263,7 +20280,10 @@ checked, since this option does not automatically suppress them. .option headers_remove transports list&!! unset .cindex "header lines" "removing" .cindex "transport" "header lines; removing" -This option specifies a list of header names, colon-separated; +This option specifies a list of header names, +.new +colon-separated (by default, changeable in the usual way); +.wen these headers are omitted from the message as it is transported, as described in section &<>&. Header removal can also be specified by routers. @@ -28003,14 +28023,18 @@ is what is wanted for subsequent tests. .cindex "cutthrough" "requesting" This option requests delivery be attempted while the item is being received. -The option usable in the RCPT ACL. +The option is usable in the RCPT ACL. If enabled for a message recieved via smtp and routed to an smtp transport, -and the message has only one recipient, +and only one transport, interface, destination host and port combination +is used for all recipients of the message, then the delivery connection is made while the receiving connection is open and data is copied from one to the other. +An attempt to set this option for any recipient but the first +for a mail will be quietly ignored. If a recipient-verify callout connection is subsequently -requested in the same ACL it is held open and used for the data, +requested in the same ACL it is held open and used for +any subsequent receipients and the data, otherwise one is made after the initial RCPT ACL completes. Note that routers are used in verify mode, @@ -28022,12 +28046,13 @@ Headers may be modified by routers (subject to the above) and transports. 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 recieved with the SMTP PRDR option 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 -the log line is tagged with ">>" rather than "=>" and appears +the delivery log lines are tagged with ">>" rather than "=>" and appear before the acceptance "<=" line. Delivery in this mode avoids the generation of a bounce mail to a @@ -28819,7 +28844,7 @@ verified is redirected to a single address, verification continues with the new address, and in that case, the subsequent value of &$address_data$& is the value for the child address. -.vitem &*verify&~=&~reverse_host_lookup*& +.vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&> .cindex "&%verify%& ACL condition" .cindex "&ACL;" "verifying host reverse lookup" .cindex "host" "verifying reverse lookup" @@ -28830,6 +28855,9 @@ Verification ensures that the host name obtained from a reverse DNS lookup, or one of its aliases, does, when it is itself looked up in the DNS, yield the original IP address. +There is one possible option, &`defer_ok`&. If this is present and a +DNS operation returns a temporary error, the verify condition succeeds. + If this condition is used for a locally generated message (that is, when there is no client host involved), it always succeeds. @@ -30450,17 +30478,39 @@ av_scanner = aveserver:/var/run/aveserver This daemon-type scanner is GPL and free. You can get it at &url(http://www.clamav.net/). Some older versions of clamd do not seem to unpack MIME containers, so it used to be recommended to unpack MIME attachments -in the MIME ACL. This no longer believed to be necessary. One option is -required: either the path and name of a UNIX socket file, or a hostname or IP -number, and a port, separated by space, as in the second of these examples: +in the MIME ACL. This is no longer believed to be necessary. + +The options are a list of server specifiers, which may be +a UNIX socket specification, +a TCP socket specification, +or a (global) option. + +A socket specification consists of a space-separated list. +For a Unix socket the first element is a full path for the socket, +for a TCP socket the first element is the IP address +and the second a port number, +Any further elements are per-server (non-global) options. +These per-server options are supported: +.code +retry= Retry on connect fail +.endd + +The &`retry`& option specifies a time after which a single retry for +a failed connect is made. The default is to not retry. + +If a Unix socket file is specified, only one server is supported. + +Examples: .code av_scanner = clamd:/opt/clamd/socket av_scanner = clamd:192.0.2.3 1234 av_scanner = clamd:192.0.2.3 1234:local +av_scanner = clamd:192.0.2.3 1234 retry=10s av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234 .endd -If the value of av_scanner points to a UNIX socket file or contains the local -keyword, then the ClamAV interface will pass a filename containing the data +If the value of av_scanner points to a UNIX socket file or contains the +&`local`& +option, then the ClamAV interface will pass a filename containing the data to be scanned, which will should normally result in less I/O happening and be more efficient. Normally in the TCP case, the data is streamed to ClamAV as Exim does not assume that there is a common filesystem with the remote host. @@ -30703,14 +30753,22 @@ deny message = This message contains malware ($malware_name) .endd -.section "Scanning with SpamAssassin" "SECTscanspamass" +.section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass" .cindex "content scanning" "for spam" .cindex "spam scanning" .cindex "SpamAssassin" +.cindex "Rspamd" The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam -score and a report for the message. You can get SpamAssassin at -&url(http://www.spamassassin.org), or, if you have a working Perl -installation, you can use CPAN by running: +score and a report for the message. +.new +Support is also provided for Rspamd. + +For more information about installation and configuration of SpamAssassin or +Rspamd refer to their respective websites at +&url(http://spamassassin.apache.org) and &url(http://www.rspamd.com) +.wen + +SpamAssassin can be installed with CPAN by running: .code perl -MCPAN -e 'install Mail::SpamAssassin' .endd @@ -30719,36 +30777,90 @@ documentation to see how you can tweak it. The default installation should work nicely, however. .oindex "&%spamd_address%&" -After having installed and configured SpamAssassin, start the &%spamd%& daemon. -By default, it listens on 127.0.0.1, TCP port 783. If you use another host or -port for &%spamd%&, you must set the &%spamd_address%& option in the global -part of the Exim configuration as follows (example): +By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you +intend to use an instance running on the local host you do not need to set +&%spamd_address%&. If you intend to use another host or port for SpamAssassin, +you must set the &%spamd_address%& option in the global part of the Exim +configuration as follows (example): .code spamd_address = 192.168.99.45 387 .endd -You do not need to set this option if you use the default. As of version 2.60, -&%spamd%& also supports communication over UNIX sockets. If you want to use -these, supply &%spamd_address%& with an absolute file name instead of a -address/port pair: + +.new +To use Rspamd (which by default listens on all local addresses +on TCP port 11333) +you should add &%variant=rspamd%& after the address/port pair, for example: +.code +spamd_address = 127.0.0.1 11333 variant=rspamd +.endd +.wen + +As of version 2.60, &%SpamAssassin%& also supports communication over UNIX +sockets. If you want to us these, supply &%spamd_address%& with an absolute +file name instead of an address/port pair: .code spamd_address = /var/run/spamd_socket .endd You can have multiple &%spamd%& servers to improve scalability. These can reside on other hardware reachable over the network. To specify multiple &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%& -option, separated with colons: +option, separated with colons (the separator can be changed in the usual way): .code spamd_address = 192.168.2.10 783 : \ 192.168.2.11 783 : \ 192.168.2.12 783 .endd -Up to 32 &%spamd%& servers are supported. The servers are queried in a random -fashion. When a server fails to respond to the connection attempt, all other +Up to 32 &%spamd%& servers are supported. +When a server fails to respond to the connection attempt, all other servers are tried until one succeeds. If no server responds, the &%spam%& condition defers. -&*Warning*&: It is not possible to use the UNIX socket connection method with -multiple &%spamd%& servers. +.new +Unix and TCP socket specifications may be mixed in any order. +Each element of the list is a list itself, space-separated by default +and changeable in the usual way. + +For TCP socket specifications a host name or IP (v4 or v6, but +subject to list-separator quoting rules) address can be used, +and the port can be one or a dash-separated pair. +In the latter case, the range is tried in strict order. + +Elements after the first for Unix sockets, or second for TCP socket, +are options. +The supported option are: +.code +pri= Selection priority +weight= Selection bias +time=- Use only between these times of day +retry= Retry on connect fail +tmo= Connection time limit +variant=rspamd Use Rspamd rather than SpamAssassin protocol +.endd + +The &`pri`& option specifies a priority for the server within the list, +higher values being tried first. +The deafult priority is 1. + +The &`weight`& option specifies a selection bias. +Within a priority set +servers are queried in a random fashion, weighted by this value. +The default value for selection bias is 1. + +Time specifications for the &`time`& option are .. +in the local time zone; each element being one or more digits. +Either the seconds or both minutes and seconds, plus the leading &`.`& +characters, may be omitted and will be taken as zero. + +Timeout specifications for the &`retry`& and &`tmo`& options +are the usual Exim time interval standard, eg. &`20s`& or &`1m`&. + +The &`tmo`& option specifies an overall timeout for communication. +The default value is two minutes. + +The &`retry`& option specifies a time after which a single retry for +a failed connect is made. +The default is to not retry. +.wen The &%spamd_address%& variable is expanded before use if it starts with a dollar sign. In this case, the expansion may return a string that is @@ -30765,7 +30877,10 @@ The right-hand side of the &%spam%& condition specifies a name. This is relevant if you have set up multiple SpamAssassin profiles. If you do not want to scan using a specific profile, but rather use the SpamAssassin system-wide default profile, you can scan for an unknown name, or simply use &"nobody"&. -However, you must put something on the right-hand side. +.new +Rspamd does not use this setting. However, you must put something on the +right-hand side. +.wen The name allows you to use per-domain or per-user antispam profiles in principle, but this is not straightforward in practice, because a message may @@ -30773,6 +30888,12 @@ have multiple recipients, not necessarily all in the same domain. Because the &%spam%& condition has to be called from a DATA ACL in order to be able to read the contents of the message, the variables &$local_part$& and &$domain$& are not set. +Careful enforcement of single-recipient messages +(eg. by responding with defer in the recipient ACL for all recipients +after the first), +or the use of PRDR, +.cindex "PRDR" "use for per-user SpamAssassin profiles" +are needed to use this feature. The right-hand side of the &%spam%& condition is expanded before being used, so you can put lookups or conditions there. When the right-hand side evaluates to @@ -30819,6 +30940,14 @@ headers, since MUAs can match on such strings. .vitem &$spam_report$& A multiline text table, containing the full SpamAssassin report for the message. Useful for inclusion in headers or reject messages. + +.new +.vitem &$spam_action$& +For SpamAssassin either 'reject' or 'no action' depending on the +spam score versus threshold. +For Rspamd, the recommended action. +.wen + .endlist The &%spam%& condition caches its results unless expansion in