X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/3c69ab86058dd2d97472ab709189052601b3cd36..HEAD:/doc/doc-docbook/spec.xfpt diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 91649788e..202c27659 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -1805,6 +1805,11 @@ suited to Exim's usage model. Yet another DBM library, called &'tdb'&, is available from &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also operates on a single file. +.next +.new +It is possible to use sqlite3 (&url(https://www.sqlite.org/index.html)) +for the DBM library. +.wen .endlist .cindex "USE_DB" @@ -1816,8 +1821,9 @@ USE_DB in an appropriate configuration file (typically .code USE_DB=yes .endd -Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An -error is diagnosed if you set more than one of these. +Similarly, for gdbm you set USE_GDBM, for tdb you set USE_TDB, +and for sqlite3 you set USE_SQLITE. +An error is diagnosed if you set more than one of these. You can set USE_NDBM if needed to override an operating system default. At the lowest level, the build-time configuration sets none of these options, @@ -1833,6 +1839,7 @@ in one of these lines: .code DBMLIB = -ldb DBMLIB = -ltdb +DBMLIB = -lsqlite3 DBMLIB = -lgdbm -lgdbm_compat .endd The last of those was for a Linux having GDBM provide emulated NDBM facilities. @@ -2886,6 +2893,11 @@ available to admin users. The word &"set"& at the start of a line, followed by a single space, is recognised specially as defining a value for a variable. +.new +.cindex "tainted data" "expansion testing" +If the sequence &",t"& is inserted before the space, +the value is marked as tainted. +.wen The syntax is otherwise the same as the ACL modifier &"set ="&. .cmdopt -bem <&'filename'&> @@ -3096,7 +3108,7 @@ options, as appropriate. The &%-bnq%& option (see below) provides a way of suppressing this for special cases. Policy checks on the contents of local messages can be enforced by means of -the non-SMTP ACL. See chapter &<>& for details. +the non-SMTP ACL. See section &<>& for details. .cindex "return code" "for &%-bm%&" The return code is zero if the message is successfully accepted. Otherwise, the @@ -3372,7 +3384,7 @@ dots doubled), terminated by a line containing just a single dot. An error is provoked if the terminating dot is missing. A further message may then follow. As for other local message submissions, the contents of incoming batch SMTP -messages can be checked using the non-SMTP ACL (see chapter &<>&). +messages can be checked using the non-SMTP ACL (see section &<>&). Unqualified addresses are automatically qualified using &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used. @@ -4710,7 +4722,7 @@ all selected messages, not just the first; frozen messages are included when The &%-R%& option makes it straightforward to initiate delivery of all messages to a given domain after a host has been down for some time. When the SMTP -command ETRN is accepted by its ACL (see chapter &<>&), its default +command ETRN is accepted by its ACL (see section &<>&), its default effect is to run Exim with the &%-R%& option, but it can be configured to run an arbitrary command instead. @@ -6742,11 +6754,11 @@ Exim variables you need to construct the database query. For the string-expansion kind of lookups, the query is given in the first bracketed argument of the &${lookup ...}$& expansion. -For the list-argument kind of lookup the quury is given by the remainder of the +For the list-argument kind of lookup the query is given by the remainder of the list item after the first semicolon. .cindex "tainted data" "quoting for lookups" -If tainted data is used in the query then it should be quuted by +If tainted data is used in the query then it should be quoted by using the &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*& expansion operator appropriate for the lookup. .endlist @@ -6841,7 +6853,10 @@ by default, but has an option to omit them (see section &<>&). .cindex "dsearch lookup type" The given file must be an absolute directory path; this is searched for an entry whose name is the key by calling the &[lstat()]& function. -The key may not contain any forward slash characters. +.new +Unless the options (below) permit a path, +.wen +the key may not contain any forward slash characters. If &[lstat()]& succeeds then so does the lookup. .cindex "tainted data" "dsearch result" The result is regarded as untainted. @@ -6850,7 +6865,7 @@ Options for the lookup can be given by appending them after the word "dsearch", separated by a comma. Options, if present, are a comma-separated list having each element starting with a tag name and an equals. -Two options are supported, for the return value and for filtering match +Three options are supported, for the return value and for filtering match candidates. The "ret" option requests an alternate result value of the entire path for the entry. Example: @@ -6858,6 +6873,7 @@ the entire path for the entry. Example: ${lookup {passwd} dsearch,ret=full {/etc}} .endd The default result is just the requested entry. + The "filter" option requests that only directory entries of a given type are matched. The match value is one of "file", "dir" or "subdir" (the latter not matching "." or ".."). Example: @@ -6867,6 +6883,14 @@ ${lookup {passwd} dsearch,filter=file {/etc}} The default matching is for any entry type, including directories and symlinks. +The "key" option relaxes the restriction that only a simple path component can +be searched for, to permit a sequence of path components. Example: +.code +${lookup {foo/bar} dsearch,key=path {/etc}} +.endd +If this option is used, a ".." component in the key is specifically disallowed. +The default operation is that the key may only be a single path component. + An example of how this lookup can be used to support virtual domains is given in section &<>&. @@ -6896,8 +6920,8 @@ key is found. The first key that matches is used; there is no attempt to find a lookup types support only literal keys. &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that -the implicit key is the host's IP address rather than its name (see section -&<>&). +the implicit key is the host's IP address rather than its name +(see section &<>&). &*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 @@ -8156,13 +8180,20 @@ option, you can still update it by a query of this form: ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} } .endd -An older syntax places the servers specification before the query, +.new +A now-deprecated syntax places the servers specification before the query, semicolon separated: .code ${lookup mysql{servers=master; UPDATE ...} } .endd -The new version avoids potential issues with tainted -arguments in the query, for explicit expansion. +The new version avoids issues with tainted +arguments explicitly expanded as part of the query. +The entire string within the braces becomes tainted, +including the server sepcification - which is not permissible. +If the older sytax is used, a warning message will be logged. +This syntax will be removed in a future release. +.wen + &*Note*&: server specifications in list-style lookups are still problematic. @@ -8190,6 +8221,11 @@ or delete command), the result of the lookup is the number of rows affected. anything (for example, setting a field to the value it already has), the result is zero because no rows are affected. +.new +To get an encryted connection, use a Mysql option file with the required +parameters for the connection. +.wen + .subsection "Special PostgreSQL features" SECID74 PostgreSQL lookups can also use Unix domain socket connections to the database. @@ -8339,6 +8375,9 @@ type of match and is given below as the &*value*& information. .section "Expansion of lists" "SECTlistexpand" .cindex "expansion" "of lists" Each list is expanded as a single string before it is used. +.cindex "tainted data" tracking +&*Note*&: As a result, if any componend was tainted then the +entire result string becomes tainted. &'Exception: the router headers_remove option, where list-item splitting is done before string-expansion.'& @@ -9220,8 +9259,9 @@ is not used. &*Reminder*&: With this kind of pattern, you must have host &'names'& as keys in the file, not IP addresses. If you want to do lookups based on IP -addresses, you must precede the search type with &"net-"& (see section -&<>&). There is, however, no reason why you could not use +addresses, you must precede the search type with &"net-"& +(see section &<>&). +There is, however, no reason why you could not use two items in the same list, one doing an address lookup and one doing a name lookup, both using the same file. @@ -9534,6 +9574,9 @@ start of a portion of the string that is interpreted and replaced as described below in section &<>& onwards. Backslash is used as an escape character, as described in the following section. +.cindex "tainted data" tracking +If any porttion of the result string is tainted, the entire result is. + Whether a string is expanded depends upon the context. Usually this is solely dependent upon the option for which a value is sought; in this documentation, options for which string expansion is performed are marked with † after @@ -11549,6 +11592,19 @@ literal question mark). .cindex "&%utf8_localpart_from_alabel%& expansion item" These convert EAI mail name components between UTF-8 and a-label forms. For information on internationalisation support see &<>&. + + +.new +.vitem &*${xtextd:*&<&'string'&>&*}*& +.cindex "text forcing in strings" +.cindex "string" "xtext decoding" +.cindex "xtext" +.cindex "&%xtextd%& expansion item" +This performs xtext decoding of the string (per RFC 3461 section 4). +.wen + + + .endlist @@ -12038,7 +12094,8 @@ where the first item in the list is the empty string. .next The item @[] matches any of the local host's interface addresses. .next -Single-key lookups are assumed to be like &"net-"& style lookups in host lists, +Single-key lookups are assumed to be like &"net-"& style lookups in host lists +(see section &<>&), even if &`net-`& is not specified. There is never any attempt to turn the IP address into a host name. The most common type of linear search for &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR @@ -14799,6 +14856,7 @@ listed in more than one group. .row &%acl_smtp_rcpt%& "ACL for RCPT" .row &%acl_smtp_starttls%& "ACL for STARTTLS" .row &%acl_smtp_vrfy%& "ACL for VRFY" +.row &%acl_smtp_wellknown%& "ACL for WELLKNOWN" .row &%av_scanner%& "specify virus scanner" .row &%check_rfc2047_length%& "check length of RFC 2047 &""encoded &&& words""&" @@ -14959,11 +15017,13 @@ See also the &'Policy controls'& section above. .row &%dsn_advertise_hosts%& "advertise DSN extensions to these hosts" .row &%ignore_fromline_hosts%& "allow &""From ""& from these hosts" .row &%ignore_fromline_local%& "allow &""From ""& from local SMTP" +.row &%limits_advertise_hosts%& "advertise LIMITS to these hosts" .row &%pipelining_advertise_hosts%& "advertise pipelining to these hosts" .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts" .row &%prdr_enable%& "advertise PRDR to all hosts" .row &%smtputf8_advertise_hosts%& "advertise SMTPUTF8 to these hosts" .row &%tls_advertise_hosts%& "advertise TLS to these hosts" +.row &%wellknown_advertise_hosts%& "advertise WELLKNOWN to these hosts" .endtable @@ -15087,7 +15147,7 @@ log_selector = +8bitmime .cindex "&ACL;" "for non-SMTP messages" .cindex "non-SMTP messages" "ACLs for" This option defines the ACL that is run when a non-SMTP message has been -read and is on the point of being accepted. See chapter &<>& for +read and is on the point of being accepted. See section &<>& for further details. .option acl_not_smtp_mime main string&!! unset @@ -15099,24 +15159,26 @@ SMTP messages. .cindex "&ACL;" "at start of non-SMTP message" .cindex "non-SMTP messages" "ACLs for" This option defines the ACL that is run before Exim starts reading a -non-SMTP message. See chapter &<>& for further details. +non-SMTP message. See section &<>& for further details. .option acl_smtp_auth main string&!! unset .cindex "&ACL;" "setting up for SMTP commands" .cindex "AUTH" "ACL for" This option defines the ACL that is run when an SMTP AUTH command is -received. See chapter &<>& for further details. +received. +See chapter &<>& for general information on ACLs, and chapter +&<>& for details of authentication. .option acl_smtp_connect main string&!! unset .cindex "&ACL;" "on SMTP connection" This option defines the ACL that is run when an SMTP connection is received. -See chapter &<>& for further details. +See section &<>& for further details. .option acl_smtp_data main string&!! unset .cindex "DATA" "ACL for" This option defines the ACL that is run after an SMTP DATA command has been processed and the message itself has been received, but before the final -acknowledgment is sent. See chapter &<>& for further details. +acknowledgment is sent. See section &<>& for further details. .option acl_smtp_data_prdr main string&!! accept .cindex "PRDR" "ACL for" @@ -15127,7 +15189,7 @@ This option defines the ACL that, if the PRDR feature has been negotiated, is run for each recipient after an SMTP DATA command has been processed and the message itself has been received, but before the -acknowledgment is sent. See chapter &<>& for further details. +acknowledgment is sent. See section &<>& for further details. .option acl_smtp_dkim main string&!! unset .cindex DKIM "ACL for" @@ -15150,7 +15212,7 @@ received. See chapter &<>& for further details. .cindex "EHLO" "ACL for" .cindex "HELO" "ACL for" This option defines the ACL that is run when an SMTP EHLO or HELO -command is received. See chapter &<>& for further details. +command is received. See section &<>& for further details. .option acl_smtp_mail main string&!! unset @@ -15161,7 +15223,8 @@ received. See chapter &<>& for further details. .option acl_smtp_mailauth main string&!! unset .cindex "AUTH" "on MAIL command" This option defines the ACL that is run when there is an AUTH parameter on -a MAIL command. See chapter &<>& for details of ACLs, and chapter +a MAIL command. +See chapter &<>& for general information on ACLs, and chapter &<>& for details of authentication. .option acl_smtp_mime main string&!! unset @@ -15174,7 +15237,7 @@ section &<>& for details. .cindex "not-QUIT, ACL for" This option defines the ACL that is run when an SMTP session ends without a QUIT command being received. -See chapter &<>& for further details. +See section &<>& for further details. .option acl_smtp_predata main string&!! unset This option defines the ACL that is run when an SMTP DATA command is @@ -15189,7 +15252,7 @@ received. See chapter &<>& for further details. .option acl_smtp_rcpt main string&!! unset .cindex "RCPT" "ACL for" This option defines the ACL that is run when an SMTP RCPT command is -received. See chapter &<>& for further details. +received. See section &<>& for further details. .option acl_smtp_starttls main string&!! unset .cindex "STARTTLS, ACL for" @@ -15201,6 +15264,13 @@ received. See chapter &<>& for further details. This option defines the ACL that is run when an SMTP VRFY command is received. See chapter &<>& for further details. +.new +.option acl_smtp_wellknown main string&!! unset +.cindex "WELLKNOWN, ACL for" +This option defines the ACL that is run when an SMTP WELLKNOWN command is +received. See section &<>& for further details. +.wen + .option add_environment main "string list" empty .cindex "environment" "set values" This option adds individual environment variables that the @@ -15706,9 +15776,9 @@ the ACL once for each signature in the message. See section &<>&. -.option dmarc_forensic_sender main string&!! unset -.option dmarc_history_file main string unset -.option dmarc_tld_file main string unset +.option dmarc_forensic_sender main string&!! unset &&& + dmarc_history_file main string unset &&& + dmarc_tld_file main string unset .cindex DMARC "main section options" These options control DMARC processing. See section &<>& for details. @@ -16175,11 +16245,13 @@ set. .cindex "EHLO" "underscores in" .cindex "underscore in EHLO/HELO" This option can be set to a string of rogue characters that are permitted in -all EHLO and HELO names in addition to the standard letters, digits, -hyphens, and dots. If you really must allow underscores, you can set +non-ip-literal EHLO and HELO names in addition to the standard letters, digits, +hyphens, and dots. For examplem if you really must allow underscores, +you can set .code helo_allow_chars = _ .endd +This option does not apply to names that look like ip-literals. Note that the value is one string, not a list. @@ -16543,6 +16615,18 @@ has been built with LDAP support. +.new +.option limits_advertise_hosts main "host list&!!" * +.cindex LIMITS "suppressing advertising" +.cindex "ESMTP extensions" LIMITS +This option can be used to suppress the advertisement of the SMTP +LIMITS extension (RFC 9422) to specific hosts. +If permitted, Exim as a servier will advertise in the EHLO response +the limit for RCPT commands set by the &%recipients_max%& option (if it is set) +and the limit for MAIL commands set by the &%smtp_accept_max_per_connection%& +option. +.wen + .option local_from_check main boolean true .cindex "&'Sender:'& header line" "disabling addition of" .cindex "&'From:'& header line" "disabling checking of" @@ -16640,15 +16724,21 @@ See also the ACL modifier &`control = suppress_local_fixups`&. Section .option localhost_number main string&!! unset .cindex "host" "locally unique number for" .cindex "message ids" "with multiple hosts" +.cindex multiple "systems sharing a spool" +.cindex "multiple hosts" "sharing a spool" +.cindex "shared spool directory" +.cindex "spool directory" sharing .vindex "&$localhost_number$&" Exim's message ids are normally unique only within the local host. If -uniqueness among a set of hosts is required, each host must set a different +uniqueness among a set of hosts is required +(eg. because they share a spool directory), +each host must set a different value for the &%localhost_number%& option. The string is expanded immediately after reading the configuration file (so that a number can be computed from the host name, for example) and the result of the expansion must be a number in the range 0&--16 (or 0&--10 on operating systems with case-insensitive file systems). This is available in subsequent string expansions via the variable -&$localhost_number$&. When &%localhost_number is set%&, the final two +&$localhost_number$&. When &%localhost_number%& is set, the final four characters of the message id, instead of just being a fractional part of the time, are computed from the time and the local host number as described in section &<>&. @@ -17440,16 +17530,26 @@ or if the message was submitted locally (not using TCP/IP), and the &%-bnq%& option was not set. -.option recipients_max main integer 50000 +.option recipients_max main integer&!! 50000 .cindex "limit" "number of recipients" .cindex "recipient" "maximum number" -If this option is set greater than zero, it specifies the maximum number of +If the value resulting from expanding this option +is set greater than zero, it specifies the maximum number of original recipients for any message. Additional recipients that are generated by aliasing or forwarding do not count. SMTP messages get a 452 response for all recipients over the limit; earlier recipients are delivered as normal. Non-SMTP messages with too many recipients are failed, and no deliveries are done. +.new +For SMTP message the expansion is done after the connection is +accepted (but before any SMTP conversation) and may depend on +the IP addresses and port numbers of the connection. +&*Note*&: If an expansion is used for the option, +care should be taken that a resonable value results for +non-SMTP messages. +.wen + .cindex "RCPT" "maximum number of incoming" &*Note*&: The RFCs specify that an SMTP server should accept at least 100 RCPT commands in a single message. @@ -18842,6 +18942,14 @@ absolute and untainted. See also &%bounce_message_file%&. +.new +.option wellknown_advertise_hosts main boolean unset +.cindex WELLKNOWN advertisement +.cindex "ESMTP extensions" WELLKNOWN +This option enables the advertising of the SMTP WELLKNOWN extension. +See also the &%acl_smtp_wellknown%& ACL (&<>&). +.wen + .option write_rejectlog main boolean true .cindex "reject log" "disabling" If this option is set false, Exim no longer writes anything to the reject log. @@ -25337,6 +25445,13 @@ over a single TCP/IP connection. If the value is zero, there is no limit. For testing purposes, this value can be overridden by the &%-oB%& command line option. +.new +.cindex "ESMTP extensions" LIMITS +If the peer advertises a LIMITS extension with a MAILMAX value, +and either TLSS is in use or was not advertised, +that value also constrains the result of this option. +.wen + .option dane_require_tls_ciphers smtp string&!! unset .cindex "TLS" "requiring specific ciphers for DANE" @@ -25913,11 +26028,20 @@ each set of addresses is treated independently, and so can cause parallel connections to the same host if &%remote_max_parallel%& permits this. +.new +.cindex "ESMTP extensions" LIMITS +If the peer advertises a LIMITS extension with a RCPTMAX value, +and either TLSS is in use or was not advertised, +that value also constrains the result of this option +and no parallel connections will be caused on meeting the RCPTMAX limit. +.wen + .option message_linelength_limit smtp integer 998 .cindex "line length" limit This option sets the maximum line length, in bytes, that the transport will send. Any messages with lines exceeding the given value +(before a transport filter, if any) will fail and a failure-DSN ("bounce") message will if possible be returned to the sender. The default value is that defined by the SMTP standards. @@ -25943,6 +26067,14 @@ If the connection is DANE-enabled then this option is ignored; only messages having the domain used for the DANE TLSA lookup are sent on the connection. +.new +.cindex "ESMTP extensions" LIMITS +If the peer advertises a LIMITS extension with a RCPTDOMAINMAX value, +and either TLSS is in use or was not advertised, +this option is regarded as being false. +.wen + + .option port smtp string&!! "see below" .cindex "port" "sending TCP/IP" .cindex "TCP/IP" "setting outgoing port" @@ -30469,12 +30601,17 @@ Section 4.3 of that document. .subsection General Under GnuTLS, DANE is only supported from version 3.0.0 onwards. -DANE is specified in published RFCs and decouples certificate authority trust +DANE is specified in RFC 6698. It decouples certificate authority trust selection from a "race to the bottom" of "you must trust everything for mail to get through". -There is an alternative technology called MTA-STS, which -instead publishes MX trust anchor information on an HTTPS website. At the -time this text was last updated, MTA-STS was still a draft, not yet an RFC. +It does retain the need to trust the assurances provided by the DNSSEC tree. + +There is an alternative technology called MTA-STS (RFC 8461), which +instead publishes MX trust anchor information on an HTTPS website. +The discovery of the address for that website does not (per standard) +require DNSSEC, and could be regarded as being less secure than DANE +as a result. + Exim has no support for MTA-STS as a client, but Exim mail server operators can choose to publish information describing their TLS configuration using MTA-STS to let those clients who do use that protocol derive trust @@ -30545,6 +30682,7 @@ options in the main part of the configuration. These options are: .cindex "RCPT" "ACL for" .cindex "STARTTLS, ACL for" .cindex "VRFY" "ACL for" +.cindex "WELLKNOWN" "ACL for" .cindex "SMTP" "connection, ACL for" .cindex "non-SMTP messages" "ACLs for" .cindex "MIME content scanning" "ACL for" @@ -30571,6 +30709,7 @@ options in the main part of the configuration. These options are: .irow &%acl_smtp_rcpt%& "ACL for RCPT" .irow &%acl_smtp_starttls%& "ACL for STARTTLS" .irow &%acl_smtp_vrfy%& "ACL for VRFY" +.irow &%acl_smtp_wellknown%& "ACL for WELLKNOWN" .endtable For example, if you set @@ -30586,7 +30725,7 @@ trying to deliver the message. It is therefore recommended that you do as much testing as possible at RCPT time. -.subsection "The non-SMTP ACLs" SECID190 +.subsection "The non-SMTP ACLs" SECnonSMTP .cindex "non-SMTP messages" "ACLs for" The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not @@ -30620,7 +30759,7 @@ kind of rejection is treated as permanent, because there is no way of sending a temporary error for these kinds of message. -.subsection "The SMTP connect ACL" SECID191 +.subsection "The SMTP connect ACL" SECconnectACL .cindex "SMTP" "connection, ACL for" .oindex &%smtp_banner%& The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP @@ -30635,7 +30774,7 @@ is accepted; if the ACL does not accept then the TCP connection is dropped witho any TLS startup attempt and without any SMTP response being transmitted. -.subsection "The EHLO/HELO ACL" SECID192 +.subsection "The EHLO/HELO ACL" SECheloACL .cindex "EHLO" "ACL for" .cindex "HELO" "ACL for" The ACL test specified by &%acl_smtp_helo%& happens when the client issues an @@ -30656,7 +30795,7 @@ affect the EHLO options that are listed on the second and subsequent lines of an EHLO response. -.subsection "The DATA ACLs" SECID193 +.subsection "The DATA ACLs" SECdataACLS .cindex "DATA" "ACLs for" Two ACLs are associated with the DATA command, because it is two-stage command, with two responses being sent to the client. @@ -30699,6 +30838,10 @@ and the &%acl_smtp_mime%& ACLs. The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support enabled (which is the default). +If, for a specific message, an ACL control +&*dkim_disable_verify*& +has been set, this &%acl_smtp_dkim%& ACL is not called. + The ACL test specified by &%acl_smtp_dkim%& happens after a message has been received, and is executed for each DKIM signature found in a message. If not otherwise specified, the default action is to accept. @@ -30749,6 +30892,62 @@ This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&. If the ACL is not defined, processing completes as if the feature was not requested by the client. +.new +.subsection "The SMTP WELLKNOWN ACL" SECTWELLKNOWNACL +.cindex "WELLKNOWN" "ACL for" +.oindex "&%acl_smtp_wellknown%&" +The &%acl_smtp_wellknown%& ACL is available only when Exim is compiled +with WELLKNOWN support enabled. + +The ACL determines the response to an SMTP WELLKNOWN command, using the normal +accept/defer/deny verbs for the response code, +and a new &"control=wellknown"& modifier. +This modifier takes a single option, separated by a '/' +character, which must be the name of a file containing the response +cleartext. The modifier is expanded before use in the usual way before +it is used. The configuration is responsible for picking a suitable file +to return and, most importantly, not returning any unexpected file. +The argument for the SMTP verb will be available in the &$smtp_command_argument$& +variable and can be used for building the file path. +If the file path given in the modifier is empty or inacessible, the control will +fail. + +For example: +.code + check_wellknown: + accept control = wellknown/\ + ${lookup {${xtextd:$smtp_command_argument}} \ + dsearch,key=path,filter=file,ret=full \ + {$spooldir/wellknown.d}} +.endd +File content will be encoded in &"xtext"& form, and line-wrapping +for line-length limitation will be done before transmission. +A response summary line will be prepended, with the (pre-encoding) file size. + +The above example uses the expansion operator ${xtextd:} +which is needed to decode the xtext-encoded key from the SMTP verb. + +Under the util directory there is a "mailtest" utility which can be used +to test/retrieve WELLKNOWN items. Syntax is +.code + mailtest -h host.example.com -w security.txt +.endd + +WELLKNOWN is a ESMTP extension providing access to extended +information about the server. It is modelled on the webserver +facilities documented in RFC 8615 and can be used for a security.txt +file and could be used for ACME handshaking (RFC 8555). + +Exim will advertise WELLKNOWN support in the EHLO response +.oindex &%wellknown_advertise_hosts%& +(conditional on a new option &%wellknown_advertise_hosts%&) +and service WELLKNOWN smtp verbs having a single parameter +giving a key for an item of "site-wide metadata". +The verb and key are separated by whitespace, +and the key is xtext-encoded (per RFC 3461 section 4). +.wen + + .subsection "The QUIT ACL" SECTQUITACL .cindex "QUIT, ACL for" The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL @@ -30919,12 +31118,15 @@ For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&, &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action when the ACL is not defined is &"accept"&. -For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and -&%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&. -This means that &%acl_smtp_rcpt%& must be defined in order to receive any -messages over an SMTP connection. For an example, see the ACL in the default -configuration file. - +For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, +&%acl_smtp_vrfy%& +.new +and &%acl_smtp_wellknown%&), +.wen +the action when the ACL +is not defined is &"deny"&. This means that &%acl_smtp_rcpt%& must be +defined in order to receive any messages over an SMTP connection. +For an example, see the ACL in the default configuration file. @@ -30996,7 +31198,8 @@ option to do this.) .section "Format of an ACL" "SECID199" .cindex "&ACL;" "format of" .cindex "&ACL;" "verbs, definition of" -An individual ACL consists of a number of statements. Each statement starts +An individual ACL definition consists of a number of statements. +Each statement starts with a verb, optionally followed by a number of conditions and &"modifiers"&. Modifiers can change the way the verb operates, define error and log messages, set variables, insert delays, and vary the processing of accepted messages. @@ -31015,6 +31218,9 @@ happens then depends on the verb (and in one case, on a special modifier). Not all the conditions make sense at every testing point. For example, you cannot test a sender address in the ACL that is run for a VRFY command. +The definition of an ACL ends where another starts, +or a different configuration section starts. + .section "ACL verbs" "SECID200" The ACL verbs are as follows: @@ -32025,6 +32231,13 @@ that are being submitted at the same time using &%-bs%& or &%-bS%&. This control enables conversion of UTF-8 in message envelope addresses to a-label form. For details see section &<>&. + +.new +.vitem &*control&~=&~wellknown*& +This control sets up a response data file for a WELLKNOWN SMTP command. +It may only be used in an ACL servicing that command. +For details see section &<>&. +.wen .endlist vlist @@ -36454,8 +36667,6 @@ other MTAs, the way Exim handles line endings for all messages is now as follows: .ilist -LF not preceded by CR is treated as a line ending. -.next CR is treated as a line ending; if it is immediately followed by LF, the LF is ignored. .next @@ -36470,7 +36681,10 @@ people trying to play silly games. .next If the first header line received in a message ends with CRLF, a subsequent bare LF in a header line is treated in the same way as a bare CR in a header -line. +line and a bare LF in a body line is replaced with a space. +.next +If the first header line received in a message does not end with CRLF, a subsequent +LF not preceded by CR is treated as a line ending. .endlist @@ -39053,7 +39267,7 @@ selection marked by asterisks: .irow &`deliver_time`&   "time taken to attempt delivery" .irow &`delivery_size`&   "add &`S=`&&'nnn'& to => lines" .irow &`dkim`& * "DKIM verified domain on <= lines" -.irow &`dkim_verbose`&   "separate full DKIM verification result line, per signature" +.irow &`dkim_verbose`&   "separate full DKIM verification result line, per signature; DKIM signing" .irow &`dnslist_defer`& * "defers of DNS list (aka RBL) lookups" .irow &`dnssec`&   "DNSSEC secured lookups" .irow &`etrn`& * "ETRN commands" @@ -39097,7 +39311,7 @@ selection marked by asterisks: .irow &`tls_peerdn`&   "TLS peer DN on <= and => lines" .irow &`tls_resumption`&   "append * to cipher field" .irow &`tls_sni`&   "TLS SNI on <= lines" -.irow &`unknown_in_list`&   "DNS lookup failed in list match" +.irow &`unknown_in_list`&   "lookup failed in list match" .irow &`all`&   "&*all of the above*&" .endtable See also the &%slow_lookup_log%& main configuration option, @@ -39179,6 +39393,10 @@ verifies successfully a tag of DKIM is added, with one of the verified domains. .cindex log "DKIM verification" .cindex DKIM "verification logging" &%dkim_verbose%&: A log entry is written for each attempted DKIM verification. +.new +Also, on message delivery lines signing information (domain and selector) +is added, tagged with DKIM=. +.wen .next .cindex "log" "dnslist defer" .cindex "DNS list" "logging defer" @@ -39516,7 +39734,8 @@ added to the log line, preceded by SNI=. .next .cindex "log" "DNS failure in list" &%unknown_in_list%&: This setting causes a log entry to be written when the -result of a list match is failure because a DNS lookup failed. +result of a list match is failure because a DNS lookup failed, or because +a bad IP address was in the list. .endlist @@ -41524,8 +41743,11 @@ Exim's DKIM implementation allows for .olist 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. +(including transport filters) except cutthrough delivery. +.new +However, signing options may not depend on headers modified by +routers, the transport or a transport filter. +.wen .next Verifying signatures in incoming messages: This is implemented by an additional ACL (acl_smtp_dkim), which can be called several times per message, with @@ -41711,7 +41933,7 @@ variables here. .option dkim_sign_headers smtp string&!! "see below" If set, this option must expand to a colon-separated list of header names. -Headers with these names, or the absence or such a header, will be included +Headers with these names, or the absence of such a header, will be included in the message signature. When unspecified, the header names listed in RFC4871 will be used, whether or not each header is present in the message. @@ -41733,10 +41955,11 @@ name will be appended. .option dkim_timestamps smtp integer&!! unset This option controls the inclusion of timestamp information in the signature. If not set, no such information will be included. -Otherwise, must be an unsigned number giving an offset in seconds from the current time -for the expiry tag -(eg. 1209600 for two weeks); -both creation (t=) and expiry (x=) tags will be included. +.new +Otherwise, must be an unsigned number giving an offset in seconds from the +current time for the expiry tag (e.g. 1209600 for two weeks); both creation +(t=) and expiry (x=) tags will be included unless the offset is 0 (no expiry). +.wen RFC 6376 lists these tags as RECOMMENDED. @@ -42234,10 +42457,16 @@ The lookup will return the same result strings as can appear in .subsection "SRS (Sender Rewriting Scheme)" SECTSRS .cindex SRS "sender rewriting scheme" +.cindex VERP "variable envelope return path" SRS can be used to modify sender addresses when forwarding so that SPF verification does not object to them. -It operates by encoding the original envelope sender in a new +It can also be used to identify a received bounce message as +likely (or not) having been trigged by a message from the +local system, and for identifying dead addresses in mailing lists. +It is one implementation of a VERP (Variable Envelope Return Path) method. + +SRS operates by encoding the original envelope sender in a new sender local part and using a domain run by the forwarding site as the new domain for the sender. Any DSN message should be returned to this new sender at the forwarding site, which can extract the @@ -42327,7 +42556,8 @@ Example usage: allow_fail data = :fail: Invalid SRS recipient address - #... further routers here + #... further routers here get inbound_srs-redirected recipients + # and any that were not SRS'd # transport; should look like the non-forward outbound @@ -42913,10 +43143,13 @@ Events have names which correspond to the point in process at which they fire. The name is placed in the variable &$event_name$& and the event action expansion must check this, as it will be called for every possible event type. +.new The current list of events is: +.wen .itable all 0 0 4 25* left 10* center 15* center 50* left .row auth:fail after both "per driver per authentication attempt" .row dane:fail after transport "per connection" +.row dns:fail after both "per lookup" .row msg:complete after main "per message" .row msg:defer after transport "per message per delivery try" .row msg:delivery after transport "per recipient" @@ -42950,6 +43183,7 @@ with the event type: .itable all 0 0 2 20* left 80* left .row auth:fail "smtp response" .row dane:fail "failure reason" +.row dns:fail "failure reason, key and lookup-type" .row msg:defer "error string" .row msg:delivery "smtp confirmation message" .row msg:fail:internal "failure reason" @@ -42999,6 +43233,11 @@ chain element received on the connection. For OpenSSL it will trigger for every chain element including those loaded locally. +.new +For dns:fail events from dnsdb lookups, a &"defer_never"& option does not +affect the reporting of DNS_AGAIN. +.wen + . //////////////////////////////////////////////////////////////////////////// . ////////////////////////////////////////////////////////////////////////////