X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/b3317cfaabe29c73478125e14f58236b2229da4b..870ce70e11912e8858ef4c071f2778b93a4b2ac9:/doc/doc-docbook/spec.xfpt diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 483aa9656..1d6fa536b 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -45,14 +45,14 @@ . Update the Copyright year (only) when changing content. . ///////////////////////////////////////////////////////////////////////////// -.set previousversion "4.92" +.set previousversion "4.93" .include ./local_params .set ACL "access control lists (ACLs)" .set I "    " .macro copyyear -2018, 2019 +2019 .endmacro . ///////////////////////////////////////////////////////////////////////////// @@ -1900,15 +1900,12 @@ If you want to build Exim with TLS support, you must first install either the OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for implementing SSL. -.new If you do not want TLS support you should set .code DISABLE_TLS=yes .endd in &_Local/Makefile_&. -.wen -.new If OpenSSL is installed, you should set .code USE_OPENSL=yes @@ -1927,7 +1924,6 @@ If you have &'pkg-config'& available, then instead you can just use: USE_OPENSSL=yes USE_OPENSSL_PC=openssl .endd -.wen .cindex "USE_GNUTLS" If GnuTLS is installed, you should set .code @@ -3967,7 +3963,6 @@ is sent to the sender, containing the text &"cancelled by administrator"&. Bounce messages are just discarded. This option can be used only by an admin user. -.new .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~... .oindex "&%-MG%&" .cindex queue named @@ -3979,7 +3974,6 @@ The destination queue name argument is required, but can be an empty string to define the default queue. If the messages are not currently located in the default queue, a &%-qG%& option will be required to define the source queue. -.wen .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~... .oindex "&%-Mmad%&" @@ -4389,6 +4383,17 @@ written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used without &%-bd%&, this is the only way of causing Exim to write a pid file, because in those cases, the normal pid file is not used. +.new +.vitem &%-oPX%& +.oindex "&%-oPX%&" +.cindex "pid (process id)" "of daemon" +.cindex "daemon" "process id (pid)" +This option is not intended for general use. +The daemon uses it when terminating due to a SIGTEM, possibly in +combination with &%-oP%&&~<&'path'&>. +It causes the pid file to be removed. +.wen + .vitem &%-or%&&~<&'time'&> .oindex "&%-or%&" .cindex "timeout" "for non-SMTP input" @@ -6357,7 +6362,7 @@ All other options are defaulted. .code local_delivery: driver = appendfile - file = /var/mail/$local_part + file = /var/mail/$local_part_verified delivery_date_add envelope_to_add return_path_add @@ -6365,7 +6370,17 @@ local_delivery: # mode = 0660 .endd This &(appendfile)& transport is used for local delivery to user mailboxes in -traditional BSD mailbox format. By default it runs under the uid and gid of the +traditional BSD mailbox format. + +.new +We prefer to avoid using &$local_part$& directly to define the mailbox filename, +as it is provided by a potential bad actor. +Instead we use &$local_part_verified$&, +the result of looking up &$local_part$& in the user database +(done by using &%check_local_user%& in the the router). +.wen + +By default &(appendfile)& runs under the uid and gid of the local user, which requires the sticky bit to be set on the &_/var/mail_& directory. Some systems use the alternative approach of running mail deliveries under a particular group instead of using the sticky bit. The commented options @@ -6767,13 +6782,10 @@ lookup types support only literal keys. the implicit key is the host's IP address rather than its name (see section &<>&). -.new &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this notation before executing the lookup.) -.wen .next -.new .cindex lookup json .cindex json "lookup type" .cindex JSON expansions @@ -6790,7 +6802,6 @@ The final resulting element can be a simple JSON type or a JSON object or array; for the latter two a string-representation os the JSON is returned. For elements of type string, the returned value is de-quoted. -.wen .next .cindex "linear search" .cindex "lookup" "lsearch" @@ -7344,9 +7355,7 @@ with the lookup. With &"strict"& a response from the DNS resolver that is not labelled as authenticated data is treated as equivalent to a temporary DNS error. -.new The default is &"lax"&. -.wen See also the &$lookup_dnssec_authenticated$& variable. @@ -8712,11 +8721,9 @@ recently implemented &(iplsearch)& files do require colons in IPv6 keys (notated using the quoting facility) so as to distinguish them from IPv4 keys. For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are converted using colons and not dots. -.new In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6 addresses are always used. The latter are converted to IPv4 addresses, in dotted-quad form. -.wen Ideally, it would be nice to tidy up this anomalous situation by changing to colons in all cases, given that quoting is now available for &(lsearch)&. @@ -9237,12 +9244,10 @@ options for which string expansion is performed are marked with † after the data type. ACL rules always expand strings. A couple of expansion conditions do not expand some of the brace-delimited branches, for security reasons, -.new .cindex "tainted data" expansion .cindex expansion "tainted data" and expansion of data deriving from the sender (&"tainted data"&) is not permitted. -.wen @@ -9491,12 +9496,10 @@ object so that it doesn't reload the same object file in the same Exim process There may be from zero to eight arguments to the function. -.new When compiling a local function that is to be called in this way, first &_DLFUNC_IMPL_& should be defined, and second &_local_scan.h_& should be included. -.wen The Exim variables and functions that are defined by that API are also available for dynamically loaded functions. The function itself must have the following type: @@ -9606,10 +9609,8 @@ Matching of the key against the member names is done case-sensitively. For the &"json"& variant, if a returned value is a JSON string, it retains its leading and trailing quotes. -.new For the &"jsons"& variant, which is intended for use with JSON strings, the leading and trailing quotes are removed from the returned value. -.wen . XXX should be a UTF-8 compare The results of matching are handled as above. @@ -9660,10 +9661,8 @@ there is no choice of field separator. For the &"json"& variant, if a returned value is a JSON string, it retains its leading and trailing quotes. -.new For the &"jsons"& variant, which is intended for use with JSON strings, the leading and trailing quotes are removed from the returned value. -.wen .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*& @@ -9826,6 +9825,12 @@ newline at the very end. For the &%header%& and &%bheader%& expansion, for those headers that contain lists of addresses, a comma is also inserted at the junctions between headers. This does not happen for the &%rheader%& expansion. +.new +.cindex "tainted data" +When the headers are from an incoming message, +the result of expanding any of these variables is tainted. +.wen + .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*& .cindex "expansion" "hmac hashing" @@ -11010,14 +11015,12 @@ it as a 64-digit hexadecimal number, in which any letters are in upper case. If the string is a single variable of type certificate, returns the SHA-256 hash fingerprint of the certificate. -.new The operator can also be spelled &%sha2%& and does the same as &%sha256%& (except for certificates, which are not supported). Finally, if an underbar and a number is appended it specifies the output length, selecting a member of the SHA-2 family of hash functions. Values of 256, 384 and 512 are accepted, with 256 being the default. -.wen .vitem &*${sha3:*&<&'string'&>&*}*& &&& @@ -11404,7 +11407,6 @@ being processed, to enable these expansion items to be nested. To scan a named list, expand it with the &*listnamed*& operator. -.new .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&& "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&& "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&& @@ -11420,7 +11422,6 @@ be a JSON array. The array separator is not changeable. For the &"jsons"& variants the elements are expected to be JSON strings and have their quotes removed before the evaluation of the condition. -.wen @@ -12100,14 +12101,12 @@ contain the trailing slash. If &$config_file$& does not contain a slash, .vindex "&$config_file$&" The name of the main configuration file Exim is using. -.new .vitem &$dmarc_domain_policy$& &&& &$dmarc_status$& &&& &$dmarc_status_text$& &&& &$dmarc_used_domains$& Results of DMARC verification. For details see section &<>&. -.wen .vitem &$dkim_verify_status$& Results of DKIM verification. @@ -12209,6 +12208,13 @@ When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains the complete argument of the ETRN command (see section &<>&). .endlist +.new +.cindex "tainted data" +If the origin of the data is an incoming message, +the result of expanding this variable is tainted. +See also &$domain_verified$&. +.wen + .vitem &$domain_data$& .vindex "&$domain_data$&" @@ -12402,6 +12408,25 @@ Global address rewriting happens when a message is received, so the value of because a message may have many recipients and the system filter is called just once. +.new +.cindex "tainted data" +If the origin of the data is an incoming message, +the result of expanding this variable is tainted. + +&*Warning*&: the content of this variable is usually provided by a potential +attacker. +Consider carefully the implications of using it unvalidated as a name +for file access. +This presents issues for users' &_.forward_& and filter files. +For traditional full user accounts, use &%check_local_users%& and the +&$local_part_verified$& variable rather than this one. +For virtual users, store a suitable pathname component in the database +which is used for account name validation, and use that retrieved value +rather than this variable. +If needed, use a router &%address_data%& or &%set%& option for +the retrieved data. +.wen + .vindex "&$local_part_prefix$&" .vindex "&$local_part_suffix$&" .cindex affix variables @@ -12468,6 +12493,14 @@ When an address is being routed or delivered, and a specific suffix for the local part was recognized, it is available in this variable, having been removed from &$local_part$&. +.new +.vitem &$local_part_verified$& +.vindex "&$local_part_verified$&" +If the router generic option &%check_local_part%& has run successfully, +this variable has the user database version of &$local_part$&. +Such values are not tainted and hence usable for building file names. +.wen + .vitem &$local_scan_data$& .vindex "&$local_scan_data$&" This variable contains the text returned by the &[local_scan()]& function when @@ -12802,7 +12835,6 @@ or if not set, the value of &$qualify_domain$&. .cindex queues named The name of the spool queue in use; empty for the default queue. -.new .vitem &$r_...$& .vindex &$r_...$& .cindex router variables @@ -12810,7 +12842,6 @@ Values can be placed in these variables by the &%set%& option of a router. They can be given any name that starts with &$r_$&. The values persist for the address being handled through subsequent routers and the eventual transport. -.wen .vitem &$rcpt_count$& .vindex "&$rcpt_count$&" @@ -13374,9 +13405,7 @@ or a &%def%& condition. &*Note*&: Under versions of OpenSSL preceding 1.1.1, when a list of more than one file is used for &%tls_certificate%&, this variable is not reliable. -.new The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions. -.wen .vitem &$tls_in_peercert$& .vindex "&$tls_in_peercert$&" @@ -13433,11 +13462,9 @@ The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during m but in the context of an outward SMTP delivery taking place via the &(smtp)& transport becomes the same as &$tls_out_cipher$&. -.new .vitem &$tls_in_cipher_std$& .vindex "&$tls_in_cipher_std$&" As above, but returning the RFC standard name for the cipher suite. -.wen .vitem &$tls_out_cipher$& .vindex "&$tls_out_cipher$&" @@ -13447,11 +13474,9 @@ and then set to the outgoing cipher suite if one is negotiated. See chapter &<>& for details of TLS support and chapter &<>& for details of the &(smtp)& transport. -.new .vitem &$tls_out_cipher_std$& .vindex "&$tls_out_cipher_std$&" As above, but returning the RFC standard name for the cipher suite. -.wen .vitem &$tls_out_dane$& .vindex &$tls_out_dane$& @@ -13526,7 +13551,6 @@ the transport. .vindex &$tls_out_tlsa_usage$& Bitfield of TLSA record types found. See section &<>&. -.new .vitem &$tls_in_ver$& .vindex "&$tls_in_ver$&" When a message is received from a remote host over an encrypted SMTP connection @@ -13536,7 +13560,6 @@ this variable is set to the protocol version, eg &'TLS1.2'&. .vindex "&$tls_out_ver$&" When a message is being delivered to a remote host over an encrypted SMTP connection this variable is set to the protocol version. -.wen .vitem &$tod_bsdinbox$& @@ -14737,11 +14760,9 @@ If it is set true, Exim's domain parsing function allows valid UTF-8 multicharacters to appear in domain name components, in addition to letters, digits, and hyphens. -.new If Exim is built with internationalization support and the SMTPUTF8 ESMTP option is in use (see chapter &<>&) this option can be left as default. -.wen Without that, if you want to look up such domain names in the DNS, you must also adjust the value of &%dns_check_names_pattern%& to match the extended form. A @@ -15152,15 +15173,21 @@ to handle IPv6 literal addresses. .new -.option dkim_verify_hashes main "string list" "sha256 : sha512 : sha1" +.option dkim_verify_hashes main "string list" "sha256 : sha512" .cindex DKIM "selecting signature algorithms" This option gives a list of hash types which are acceptable in signatures, +.wen and an order of processing. Signatures with algorithms not in the list will be ignored. -Note that the presence of sha1 violates RFC 8301. -Signatures using the rsa-sha1 are however (as of writing) still common. -The default inclusion of sha1 may be dropped in a future release. +Acceptable values include: +.code +sha1 +sha256 +sha512 +.endd + +Note that the acceptance of sha1 violates RFC 8301. .option dkim_verify_keytypes main "string list" "ed25519 : rsa" This option gives a list of key types which are acceptable in signatures, @@ -15170,7 +15197,6 @@ Signatures with algorithms not in the list will be ignored. .option dkim_verify_minimal main boolean false If set to true, verification of signatures will terminate after the first success. -.wen .option dkim_verify_signers main "domain list&!!" $dkim_signers .cindex DKIM "controlling calls to the ACL" @@ -15263,11 +15289,9 @@ domain matches this list. This is a fudge to help with name servers that give big delays or otherwise do not work for the AAAA record type. In due course, when the world's name servers have all been upgraded, there should be no need for this option. -.new Note that all lookups, including those done for verification, are affected; this will result in verify failure for IPv6 connections or ones using names only valid for IPv6 addresses. -.wen .option dns_retrans main time 0s @@ -15470,14 +15494,12 @@ not also supplied, the gid is taken from the result of &[getpwnam()]& if it is used. See chapter &<>& for a discussion of security issues. -.new .option exim_version main string "current version" .cindex "Exim version" .cindex customizing "version number" .cindex "version number of Exim" override This option overrides the &$version_number$&/&$exim_version$& that Exim reports in various places. Use with care; this may fool stupid security scanners. -.wen .option extra_local_interfaces main "string list" unset @@ -16100,10 +16122,8 @@ when Exim is entered, so it can, for example, contain a reference to the host name. If no specific path is set for the log files at compile or runtime, or if the option is unset at runtime (i.e. &`log_file_path = `&) they are written in a sub-directory called &_log_& in Exim's spool directory. -.new A path must start with a slash. To send to syslog, use the word &"syslog"&. -.wen Chapter &<>& contains further details about Exim's logging, and section &<>& describes how the contents of &%log_file_path%& are used. If this string is fixed at your installation (contains no expansion @@ -16451,9 +16471,9 @@ interpreter. See chapter &<>& for details of its use. This option is available only when Exim is built with an embedded Perl interpreter. See chapter &<>& for details of its use. -.option perl_startup main boolean false +.option perl_taintmode main boolean false .cindex "Perl" -This Option enables the taint mode of the embedded Perl interpreter. +This option enables the taint mode of the embedded Perl interpreter. .option pgsql_servers main "string list" unset @@ -16490,7 +16510,6 @@ for each SMTP command and response. When PIPELINING is advertised, Exim assumes that clients will use it; &"out of order"& commands that are &"expected"& do not count as protocol errors (see &%smtp_max_synprot_errors%&). -.new .option pipelining_connect_advertise_hosts main "host list&!!" * .cindex "pipelining" "early connection" .cindex "pipelining" PIPE_CONNECT @@ -16503,7 +16522,6 @@ When used, the pipelining saves on roundtrip times. See also the &%hosts_pipe_connect%& smtp transport option. Currently the option name &"X_PIPE_CONNECT"& is used. -.wen .option prdr_enable main boolean false @@ -16766,7 +16784,6 @@ used. If the expansion yields an empty string, no &'Received:'& header line is added to the message. Otherwise, the string should start with the text &"Received:"& and conform to the RFC 2822 specification for &'Received:'& header lines. -.new The default setting is: .code @@ -16785,7 +16802,6 @@ received_header_text = Received: \ id $message_exim_id\ ${if def:received_for {\n\tfor $received_for}} .endd -.wen The reference to the TLS cipher is omitted when Exim is built without TLS support. The use of conditional expansions ensures that this works for both @@ -17721,9 +17737,7 @@ separator in the usual way (&<>&) to avoid confusion under IP &*Note*&: Under versions of OpenSSL preceding 1.1.1, when a list of more than one file is used, the &$tls_in_ourcert$& variable is unreliable. -.new The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions. -.wen If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then if the OpenSSL build supports TLS extensions and the TLS client sends the @@ -17774,10 +17788,8 @@ larger prime than requested. The value of this option is expanded and indicates the source of DH parameters to be used by Exim. -.new This option is ignored for GnuTLS version 3.6.0 and later. The library manages parameter negotiation internally. -.wen &*Note: The Exim Maintainers strongly recommend, for other TLS library versions, @@ -17876,21 +17888,14 @@ status proof for the server's certificate, as obtained from the Certificate Authority. Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later). -.new The macro "_HAVE_TLS_OCSP" will be defined for those versions. -.wen -.new For OpenSSL 1.1.0 or later, and -.wen for GnuTLS 3.5.6 or later the expanded value of this option can be a list of files, to match a list given for the &%tls_certificate%& option. The ordering of the two lists must match. -.new The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions. -.wen -.new The file(s) should be in DER format, except for GnuTLS 3.6.3 or later or for OpenSSL, @@ -17906,7 +17911,6 @@ Although GnuTLS will accept PEM files with multiple separate PEM blobs (ie. separate OCSP responses), it sends them in the TLS Certificate record interleaved with the certificates of the chain; although a GnuTLS client is happy with that, an OpenSSL client is not. -.wen .option tls_on_connect_ports main "string list" unset .cindex SSMTP @@ -18215,9 +18219,7 @@ file = ${extract{mailbox}{$address_data}} This makes the configuration file less messy, and also reduces the number of lookups (though Exim does cache lookups). -.new See also the &%set%& option below. -.wen .vindex "&$sender_address_data$&" .vindex "&$address_data$&" @@ -19000,7 +19002,6 @@ latter kind. This option controls whether the local part is used to form the key for retry hints for addresses that suffer temporary errors while being handled by this -.new router. The default value is true for any router that has any of &%check_local_user%&, &%local_parts%&, @@ -19009,7 +19010,6 @@ router. The default value is true for any router that has any of &%local_part_suffix%&, &%senders%& or &%require_files%& -.wen set, and false otherwise. Note that this option does not apply to hints keys for transport delays; they are controlled by a generic transport option of the same name. @@ -19146,7 +19146,6 @@ SMTP VRFY command is enabled, it must be used after MAIL if the sender address matters. -.new .option set routers "string list" unset .cindex router variables This option may be used multiple times on a router; @@ -19169,7 +19168,6 @@ Variable use is via the usual &$r_...$& syntax. This is similar to the &%address_data%& option, except that many independent variables can be used, with choice of naming. -.wen .option translate_ip_address routers string&!! unset @@ -20580,6 +20578,19 @@ is not the case when the file contains syntactically valid items that happen to yield empty addresses, for example, items containing only RFC 2822 address comments. +.new +.cindex "tainted data" "in filenames" +.cindex redirect "tainted data" +Tainted data may not be used for a filename. + +&*Warning*&: It is unwise to use &$local_part$& or &$domain$& +directly for redirection, +as they are provided by a potential attacker. +In the examples above, &$local_part$& is used for looking up data held locally +on the system, and not used directly (the second example derives &$home$& via +the passsword file or database, using &$local_part$&). +.wen + .section "Forward files and address verification" "SECID125" @@ -20805,6 +20816,11 @@ It must be given as .code list1: :include:/opt/lists/list1 .endd +.new +.cindex "tainted data" "in filenames" +.cindex redirect "tainted data" +Tainted data may not be used for a filename. +.wen .next .cindex "address redirection" "to black hole" .cindex "delivery" "discard" @@ -22364,6 +22380,14 @@ If &%file%& or &%directory%& is set for a delivery from a redirection, it is used to determine the file or directory name for the delivery. Normally, the contents of &$address_file$& are used in some way in the string expansion. .endlist +.new +.cindex "tainted data" "in filenames" +.cindex appendfile "tainted data" +Tainted data may not be used for a file or directory name. +This means that, for instance, &$local_part$& cannot be used directly +as a component of a path. It can however be used as the key for a lookup +which returns a path (or component). +.wen .cindex "Sieve filter" "configuring &(appendfile)&" @@ -22952,14 +22976,12 @@ sometimes add other information onto the ends of message filenames. Section &<>& contains further information. -.new This option should not be used when other message-handling software may duplicate messages by making hardlinks to the files. When that is done Exim will count the message size once for each filename, in contrast with the actual disk usage. When the option is not set, calculating total usage requires a system-call per file to get the size; the number of links is then available also as is used to adjust the effective size. -.wen .option quota_warn_message appendfile string&!! "see below" @@ -23803,6 +23825,12 @@ directories are also controllable. See chapter &<>& for details of the local delivery environment and chapter &<>& for a discussion of local delivery batching. +.new +.cindex "tainted data" "in pipe command" +.cindex pipe "tainted data" +Tainted data may not be used for the command name. +.wen + .section "Concurrent delivery" "SECID140" If two messages arrive at almost the same time, and both are routed to a pipe @@ -24778,7 +24806,6 @@ facilities such as AUTH, PIPELINING, SIZE, and STARTTLS. Exim will not use the SMTP PIPELINING extension when delivering to any host that matches this list, even if the server host advertises PIPELINING support. -.new .option hosts_pipe_connect smtp "host list&!!" unset .cindex "pipelining" "early connection" .cindex "pipelining" PIPE_CONNECT @@ -24802,7 +24829,6 @@ A check is made for the use of that variable, without the presence of a &"def:"& test on it, but suitably complex coding can avoid the check and produce unexpected results. You have been warned. -.wen .option hosts_avoid_tls smtp "host list&!!" unset @@ -24843,7 +24869,6 @@ been started will not be passed to a new delivery process for sending another message on the same connection. See section &<>& for an explanation of when this might be needed. -.new .option hosts_noproxy_tls smtp "host list&!!" unset .cindex "TLS" "passing connection" .cindex "multiple SMTP deliveries" @@ -24851,7 +24876,6 @@ explanation of when this might be needed. For any host that matches this list, a TLS session which has been started will not be passed to a new delivery process for sending another message on the same session. -.wen The traditional implementation closes down TLS and re-starts it in the new process, on the same open TCP connection, for each successive message @@ -24946,6 +24970,9 @@ unauthenticated. See also &%hosts_require_auth%&, and chapter .cindex "RFC 3030" "CHUNKING" This option provides a list of servers to which, provided they announce CHUNKING support, Exim will attempt to use BDAT commands rather than DATA. +.new +Unless DKIM signing is being done, +.wen BDAT will not be used in conjunction with a transport filter. .option hosts_try_dane smtp "host list&!!" * @@ -26502,10 +26529,8 @@ authentication mechanism (RFC 2195), and the second provides an interface to the Cyrus SASL authentication library. The third is an interface to Dovecot's authentication system, delegating the work via a socket interface. -.new The fourth provides for negotiation of authentication done via non-SMTP means, as defined by RFC 4422 Appendix A. -.wen The fifth provides an interface to the GNU SASL authentication library, which provides mechanisms but typically not data sources. The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but @@ -26930,7 +26955,6 @@ security risk; you are strongly advised to insist on the use of SMTP encryption use unencrypted plain text, you should not use the same passwords for SMTP connections as you do for login accounts. -.new .section "Avoiding cleartext use" "SECTplain_TLS" The following generic option settings will disable &(plaintext)& authenticators when TLS is not being used: @@ -26942,7 +26966,6 @@ TLS is not being used: &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping, but is still vulnerable to a Man In The Middle attack unless certificates (including their names) have been properly verified. -.wen .section "Plaintext server options" "SECID171" .cindex "options" "&(plaintext)& authenticator (server)" @@ -27422,7 +27445,7 @@ but it is present in many binary distributions. .scindex IIDdcotauth1 "&(dovecot)& authenticator" .scindex IIDdcotauth2 "authenticators" "&(dovecot)&" This authenticator is an interface to the authentication facility of the -Dovecot POP/IMAP server, which can support a number of authentication methods. +Dovecot 2 POP/IMAP server, which can support a number of authentication methods. Note that Dovecot must be configured to use auth-client not auth-userdb. If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful to use the same mechanisms for SMTP authentication. This is a server @@ -27453,6 +27476,29 @@ option is passed in the Dovecot authentication command. If, for a TLS connection, a client certificate has been verified, the &"valid-client-cert"& option is passed. When authentication succeeds, the identity of the user who authenticated is placed in &$auth1$&. + +.new +The Dovecot configuration to match the above wil look +something like: +.code +conf.d/10-master.conf :- + +service auth { +... +#SASL + unix_listener auth-client { + mode = 0660 + user = mail + } +... +} + +conf.d/10-auth.conf :- + +auth_mechanisms = plain login ntlm +.endd +.wen + .ecindex IIDdcotauth1 .ecindex IIDdcotauth2 @@ -27471,19 +27517,45 @@ who authenticated is placed in &$auth1$&. .cindex "authentication" "DIGEST-MD5" .cindex "authentication" "CRAM-MD5" .cindex "authentication" "SCRAM-SHA-1" -The &(gsasl)& authenticator provides server integration for the GNU SASL +.cindex "authentication" "SCRAM-SHA-1-PLUS" +.cindex "authentication" "SCRAM-SHA-256" +.cindex "authentication" "SCRAM-SHA-256-PLUS" +The &(gsasl)& authenticator provides integration for the GNU SASL library and the mechanisms it provides. This is new as of the 4.80 release and there are a few areas where the library does not let Exim smoothly scale to handle future authentication mechanisms, so no guarantee can be made that any particular new authentication mechanism will be supported without code changes in Exim. -Exim's &(gsasl)& authenticator does not have client-side support at this -time; only the server-side support is implemented. Patches welcome. +.new +The library is expected to add support in an upcoming +realease for the SCRAM-SHA-256 method. +The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined +when this happens. + + +.option client_authz gsasl string&!! unset +This option can be used to supply an &'authorization id'& +which is different to the &'authentication_id'& provided +by &%client_username%& option. +If unset or (after expansion) empty it is not used, +which is the common case. + +.option client_channelbinding gsasl boolean false +See &%server_channelbinding%& below. + +.option client_password gsasl string&!! unset +This option is exapanded before use, and should result in +the password to be used, in clear. +.option client_username gsasl string&!! unset +This option is exapanded before use, and should result in +the account name to be used. +.wen .option server_channelbinding gsasl boolean false -Do not set this true without consulting a cryptographic engineer. +Do not set this true and rely on the properties +without consulting a cryptographic engineer. Some authentication mechanisms are able to use external context at both ends of the session to bind the authentication to that context, and fail the @@ -27495,15 +27567,18 @@ This should have meant that certificate identity and verification becomes a non-issue, as a man-in-the-middle attack will cause the correct client and server to see different identifiers and authentication will fail. -This is currently only supported when using the GnuTLS library. This is +.new +This is only usable by mechanisms which support "channel binding"; at time of writing, that's the SCRAM family. +When using this feature the "-PLUS" variants of the method names need to be used. +.wen This defaults off to ensure smooth upgrade across Exim releases, in case this option causes some clients to start failing. Some future release of Exim might have switched the default to be true. -However, Channel Binding in TLS has proven to be broken in current versions. +However, Channel Binding in TLS has proven to be vulnerable in current versions. Do not plan to rely upon this feature for security, ever, without consulting with a subject matter expert (a cryptographic engineer). @@ -27551,16 +27626,28 @@ This specifies the SASL realm that the server claims to be in. Some mechanisms will use this data. -.option server_scram_iter gsasl string&!! unset +.option server_scram_iter gsasl string&!! 4096 This option provides data for the SCRAM family of mechanisms. -&$auth1$& is not available at evaluation time. -(This may change, as we receive feedback on use) +.new +The &$auth1$&, &$auth2$& and &$auth3$& variables are available for expansion. + +The result of expansion should be a decimal number, +and represents both a lower-bound on the security, and +a compute cost factor imposed on the client +(if it does not cache results, or the server changes +either the iteration count or the salt). +A minimum value of 4096 is required by the standards +for all current CRAM mechanism variants. +.wen .option server_scram_salt gsasl string&!! unset This option provides data for the SCRAM family of mechanisms. -&$auth1$& is not available at evaluation time. -(This may change, as we receive feedback on use) +.new +The &$auth1$&, &$auth2$& and &$auth3$& variables are available for expansion. +If unset or empty after expansion the library will provides a value for the +protocol conversation. +.wen .option server_service gsasl string &`smtp`& @@ -27767,7 +27854,6 @@ msn: . //////////////////////////////////////////////////////////////////////////// . //////////////////////////////////////////////////////////////////////////// -.new .chapter "The external authenticator" "CHAPexternauth" .scindex IIDexternauth1 "&(external)& authenticator" .scindex IIDexternauth2 "authenticators" "&(external)&" @@ -27896,7 +27982,6 @@ ext_ccert: .ecindex IIDexternauth1 .ecindex IIDexternauth2 -.wen @@ -28087,13 +28172,11 @@ There is also a &%-tls-on-connect%& command line option. This overrides .section "OpenSSL vs GnuTLS" "SECTopenvsgnu" .cindex "TLS" "OpenSSL &'vs'& GnuTLS" TLS is supported in Exim using either the OpenSSL or GnuTLS library. -.new To build Exim to use OpenSSL you need to set .code USE_OPENSSL=yes .endd in Local/Makefile. -.wen To build Exim to use GnuTLS, you need to set .code @@ -28658,12 +28741,10 @@ transport provide the client with a certificate, which is passed to the server if it requests it. If the server is Exim, it will request a certificate only if &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client. -.new &*Note*&: Do not use a certificate which has the OCSP-must-staple extension, for client use (they are usable for server use). As the TLS protocol has no means for the client to staple before TLS 1.3 it will result in failed connections. -.wen If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it specifies a collection of expected server certificates. @@ -30437,6 +30518,13 @@ This control turns off DKIM verification processing entirely. For details on the operation and configuration of DKIM, see section &<>&. +.vitem &*control&~=&~dmarc_disable_verify*& +.cindex "disable DMARC verify" +.cindex "DMARC" "disable verify" +This control turns off DMARC verification processing entirely. For details on +the operation and configuration of DMARC, see section &<>&. + + .vitem &*control&~=&~dscp/*&<&'value'&> .cindex "&ACL;" "setting DSCP value" .cindex "DSCP" "inbound" @@ -31180,10 +31268,8 @@ case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or &'Resent-Cc:'& header lines exist, they are also checked. This condition can be used only in a DATA or non-SMTP ACL. -.new There is one possible option, &`case_insensitive`&. If this is present then local parts are checked case-insensitively. -.wen There are, of course, many legitimate messages that make use of blind (bcc) recipients. This check should not be used on its own for blocking messages. @@ -32791,14 +32877,12 @@ 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. -.new Since message data needs to have arrived, the condition may be only called in ACL defined by &%acl_smtp_data%&, &%acl_smtp_data_prdr%&, &%acl_smtp_mime%& or &%acl_smtp_dkim%& -.wen A timeout of 2 minutes is applied to a scanner call (by default); if it expires then a defer action is taken. @@ -33708,7 +33792,12 @@ directory, so you might set HAVE_LOCAL_SCAN=yes LOCAL_SCAN_SOURCE=Local/local_scan.c .endd -for example. The function must be called &[local_scan()]&. It is called by +for example. The function must be called &[local_scan()]&; +.new +the source file(s) for it should first #define LOCAL_SCAN +and then #include "local_scan.h". +.wen +It is called by Exim after it has received a message, when the success return code is about to be sent. This is after all the ACLs have been run. The return code from your function controls whether the message is actually accepted or not. There is a @@ -34338,10 +34427,8 @@ with translation. This function is used in conjunction with &'smtp_printf()'&, as described below. -.new .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*& The arguments of this function are almost like &[printf()]&; it writes to the SMTP -.wen output stream. You should use this function only when there is an SMTP output stream, that is, when the incoming message is being received via interactive SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%& @@ -34353,7 +34440,6 @@ is involved. If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS output function, so it can be used for all forms of SMTP connection. -.new The second argument is used to request that the data be buffered (when TRUE) or flushed (along with any previously buffered, when FALSE). This is advisory only, but likely to save on system-calls and packets @@ -34362,7 +34448,6 @@ sent when a sequence of calls to the function are made. The argument was added in Exim version 4.90 - changing the API/ABI. Nobody noticed until 4.93 was imminent, at which point the ABI version number was incremented. -.wen Strings that are written by &'smtp_printf()'& from within &[local_scan()]& must start with an appropriate response code: 550 if you are going to return @@ -34382,9 +34467,7 @@ multiple output lines. The &'smtp_printf()'& function does not return any error indication, because it does not -.new guarantee a flush of -.wen pending output, and therefore does not test the state of the stream. (In the main code of Exim, flushing and error detection is done when Exim is ready for the next SMTP input command.) If @@ -34393,12 +34476,18 @@ dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no arguments. It flushes the output stream, and returns a non-zero value if there is an error. -.vitem &*void&~*store_get(int)*& +.new +.vitem &*void&~*store_get(int,BOOL)*& This function accesses Exim's internal store (memory) manager. It gets a new -chunk of memory whose size is given by the argument. Exim bombs out if it ever +chunk of memory whose size is given by the first argument. +The second argument should be given as TRUE if the memory will be used for +data possibly coming from an attacker (eg. the message content), +FALSE if it is locally-sourced. +Exim bombs out if it ever runs out of memory. See the next section for a discussion of memory handling. +.wen -.vitem &*void&~*store_get_perm(int)*& +.vitem &*void&~*store_get_perm(int,BOOL)*& This function is like &'store_get()'&, but it always gets memory from the permanent pool. See the next section for a discussion of memory handling. @@ -37369,7 +37458,7 @@ the following table: &`DKIM`& domain verified in incoming message &`DN `& distinguished name from peer certificate &`DS `& DNSSEC secured lookups -&`DT `& on &`=>`& lines: time taken for a delivery +&`DT `& on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery &`F `& sender address (on delivery lines) &`H `& host name and IP address &`I `& local interface used @@ -37467,7 +37556,7 @@ selection marked by asterisks: &` arguments `& command line arguments &`*connection_reject `& connection rejections &`*delay_delivery `& immediate delivery delayed -&` deliver_time `& time taken to perform delivery +&` deliver_time `& time taken to attempt delivery &` delivery_size `& add &`S=`&&'nnn'& to => lines &`*dkim `& DKIM verified domain on <= lines &` dkim_verbose `& separate full DKIM verification result line, per signature @@ -37665,7 +37754,6 @@ connection is unexpectedly dropped. &%millisec%&: Timestamps have a period and three decimal places of finer granularity appended to the seconds value. .next -.new .cindex "log" "message id" &%msg_id%&: The value of the Message-ID: header. .next @@ -37673,7 +37761,6 @@ appended to the seconds value. This will be either because the message is a bounce, or was submitted locally (submission mode) without one. The field identifier will have an asterix appended: &"id*="&. -.wen .next .cindex "log" "outgoing interface" .cindex "log" "local interface" @@ -37710,13 +37797,11 @@ The field is a single "L". On accept lines, where PIPELINING was offered but not used by the client, the field has a minus appended. -.new .cindex "pipelining" "early connection" If Exim is built with the SUPPORT_PIPE_CONNECT build option accept "L" fields have a period appended if the feature was offered but not used, or an asterisk appended if used. Delivery "L" fields have an asterisk appended if used. -.wen .next .cindex "log" "queue run" @@ -38074,10 +38159,8 @@ Match only frozen messages. .vitem &*-x*& Match only non-frozen messages. -.new .vitem &*-G*&&~<&'queuename'&> Match only messages in the given queue. Without this, the default queue is searched. -.wen .endlist The following options control the format of the output: @@ -39765,10 +39848,8 @@ was received from the client, this records the Distinguished Name from that certificate. .endlist -.new Any of the above may have an extra hyphen prepended, to indicate the the corresponding data is untrusted. -.wen Following the options there is a list of those addresses to which the message is not to be delivered. This set of addresses is initialized from the command @@ -39958,9 +40039,7 @@ These options take (expandable) strings as arguments. The domain(s) you want to sign with. After expansion, this can be a list. Each element in turn, -.new lowercased, -.wen is put into the &%$dkim_domain%& expansion variable while expanding the remaining signing options. If it is empty after expansion, DKIM signing is not done, @@ -40015,9 +40094,7 @@ Signers MUST use RSA keys of at least 1024 bits for all keys. Signers SHOULD use RSA keys of at least 2048 bits. .endd -.new EC keys for DKIM are defined by RFC 8463. -.wen They are considerably smaller than RSA keys for equivalent protection. As they are a recent development, users should consider dual-signing (by setting a list of selectors, and an expansion for this option) @@ -40037,12 +40114,10 @@ openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base6 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64 .endd -.new Exim also supports an alternate format of Ed25519 keys in DNS which was a candidate during development of the standard, but not adopted. A future release will probably drop that support. -.wen .option dkim_hash smtp string&!! sha256 Can be set to any one of the supported hash methods, which are: @@ -40116,22 +40191,18 @@ RFC 6376 lists these tags as RECOMMENDED. Verification of DKIM signatures in SMTP incoming email is done for all messages for which an ACL control &%dkim_disable_verify%& has not been set. -.new .cindex DKIM "selecting signature algorithms" Individual classes of signature algorithm can be ignored by changing the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&. The &%dkim_verify_minimal%& option can be set to cease verification processing for a message once the first passing signature is found. -.wen .cindex authentication "expansion item" Performing verification sets up information used by the &%authresults%& expansion item. -.new For most purposes the default option settings suffice and the remainder of this section can be ignored. -.wen The results of verification are made available to the &%acl_smtp_dkim%& ACL, which can examine and modify them. @@ -40178,13 +40249,11 @@ dkim_verify_signers = $sender_address_domain:$dkim_signers If a domain or identity is listed several times in the (expanded) value of &%dkim_verify_signers%&, the ACL is only called once for that domain or identity. -.new Note that if the option is set using untrustworthy data (such as the From: header) care should be taken to force lowercase for domains and for the domain part if identities. The default setting can be regarded as trustworthy in this respect. -.wen If multiple signatures match a domain (or identity), the ACL is called once for each matching signature. @@ -40286,10 +40355,8 @@ algorithms (currently, rsa-sha1) have permanently failed evaluation To enforce this you must either have a DKIM ACL which checks this variable and overwrites the &$dkim_verify_status$& variable as discussed above, -.new or have set the main option &%dkim_verify_hashes%& to exclude processing of such signatures. -.wen .vitem &%$dkim_canon_body%& The body canonicalization method. One of 'relaxed' or 'simple'. @@ -40561,9 +40628,7 @@ would relax host matching rules to a broader network range. .cindex lookup spf A lookup expansion is also available. It takes an email address as the key and an IP address -.new (v4 or v6) -.wen as the database: .code @@ -40577,7 +40642,6 @@ The lookup will return the same result strings as can appear in -.new .section DMARC SECDMARC .cindex DMARC verification @@ -40610,10 +40674,12 @@ defines the location of a text file of valid top level domains the opendmarc library uses during domain parsing. Maintained by Mozilla, the most current version can be downloaded -from a link at &url(https://publicsuffix.org/list/, currently pointing -at https://publicsuffix.org/list/public_suffix_list.dat) -See also util/renew-opendmarc-tlds.sh script. -The default for the option is /etc/exim/opendmarc.tlds. +from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat). +See also the util/renew-opendmarc-tlds.sh script. +.new +The default for the option is unset. +If not set, DMARC processing is disabled. +.wen The &%dmarc_history_file%& option, if set @@ -40808,7 +40874,6 @@ Example usage: warn add_header = :at_start:${authresults {$primary_hostname}} .endd -.wen @@ -41143,10 +41208,11 @@ The current list of events is: .display &`dane:fail after transport `& per connection &`msg:complete after main `& per message +&`msg:defer after transport `& per message per delivery try &`msg:delivery after transport `& per recipient &`msg:rcpt:host:defer after transport `& per recipient per host &`msg:rcpt:defer after transport `& per recipient -&`msg:host:defer after transport `& per attempt +&`msg:host:defer after transport `& per host per delivery try; host errors &`msg:fail:delivery after transport `& per recipient &`msg:fail:internal after main `& per recipient &`tcp:connect before transport `& per connection @@ -41172,12 +41238,13 @@ An additional variable, &$event_data$&, is filled with information varying with the event type: .display &`dane:fail `& failure reason +&`msg:defer `& error string &`msg:delivery `& smtp confirmation message &`msg:fail:internal `& failure reason &`msg:fail:delivery `& smtp error message +&`msg:host:defer `& error string &`msg:rcpt:host:defer `& error string &`msg:rcpt:defer `& error string -&`msg:host:defer `& error string &`tls:cert `& verification chain depth &`smtp:connect `& smtp banner &`smtp:ehlo `& smtp ehlo response