Lookups: log warning for deprecated syntax. Bug 3068
[exim.git] / doc / doc-docbook / spec.xfpt
index dc8f5cc4d0347419fdfed60b57d6d235d24ee8a8..79bdb24e501d6c87071264438d4bdd38433f84c6 100644 (file)
@@ -6742,11 +6742,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
@@ -8156,13 +8156,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.
 
 
@@ -8339,6 +8346,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.'&
@@ -9534,6 +9544,9 @@ start of a portion of the string that is interpreted and replaced as described
 below in section &<<SECTexpansionitems>>& 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 &dagger; after
@@ -15706,9 +15719,9 @@ the ACL once for each signature in the message.
 See section &<<SECDKIMVFY>>&.
 
 
-.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 &<<SECDMARC>>& for details.
@@ -16640,15 +16653,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 &<<SECTmessiden>>&.
@@ -25918,6 +25937,7 @@ permits this.
 .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.
@@ -36454,8 +36474,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 +36488,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 +39074,7 @@ selection marked by asterisks:
 .irow &`deliver_time`&                 &nbsp; "time taken to attempt delivery"
 .irow &`delivery_size`&                        &nbsp; "add &`S=`&&'nnn'& to => lines"
 .irow &`dkim`&                         *       "DKIM verified domain on <= lines"
-.irow &`dkim_verbose`&                 &nbsp; "separate full DKIM verification result line, per signature"
+.irow &`dkim_verbose`&                 &nbsp; "separate full DKIM verification result line, per signature; DKIM signing"
 .irow &`dnslist_defer`&                        *       "defers of DNS list (aka RBL) lookups"
 .irow &`dnssec`&                       &nbsp; "DNSSEC secured lookups"
 .irow &`etrn`&                         *       "ETRN commands"
@@ -39179,6 +39200,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"
@@ -41734,10 +41759,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.
 
@@ -42235,10 +42261,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