X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/e2fbf4a211bdcff441c50f58f3c1f1fb17f56d61..a4ca1b01d4376f9b9ca7e06acf4eb7d164a38d2b:/doc/doc-docbook/spec.xfpt diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 29214e3e1..5f1c25f41 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -52,7 +52,7 @@ .set I "    " .macro copyyear -2012 +2013 .endmacro . ///////////////////////////////////////////////////////////////////////////// @@ -179,12 +179,7 @@ EximMaintainers EM - -.version - - -.fulldate - +.versiondatexml EM @@ -544,7 +539,6 @@ The &_.bz2_& file is usually a lot smaller than the &_.gz_& file. .cindex "distribution" "signing details" .cindex "distribution" "public key" .cindex "public key for signed distribution" -.new The distributions will be PGP signed by an individual key of the Release Coordinator. This key will have a uid containing an email address in the &'exim.org'& domain and will have signatures from other people, including @@ -558,7 +552,10 @@ At time of last update, releases were being made by Phil Pennock and signed with key &'0x403043153903637F'&, although that key is expected to be replaced in 2013. A trust path from Nigel's key to Phil's can be observed at &url(https://www.security.spodhuis.org/exim-trustpath). -.wen + +Releases have also been authorized to be performed by Todd Lyons who signs with +key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil +Pennock and Todd Lyons through a common associate. The signatures for the tar bundles are in: .display @@ -1381,8 +1378,7 @@ Setting the &%verify%& option actually sets two options, &%verify_sender%& and &%verify_recipient%&, which independently control the use of the router for sender and recipient verification. You can set these options directly if you want a router to be used for only one type of verification. -Note that cutthrough delivery is classed as a recipient verification -for this purpose. +Note that cutthrough delivery is classed as a recipient verification for this purpose. .next If the &%address_test%& option is set false, the router is skipped when Exim is run with the &%-bt%& option to test an address routing. This can be helpful @@ -1392,7 +1388,7 @@ having to simulate the effect of the scanner. .next Routers can be designated for use only when verifying an address, as opposed to routing it for delivery. The &%verify_only%& option controls this. -Again, cutthrough delibery counts as a verification. +Again, cutthrough delivery counts as a verification. .next Individual routers can be explicitly skipped when running the routers to check an address given in the SMTP EXPN command (see the &%expn%& option). @@ -2714,14 +2710,12 @@ no arguments. This option is an alias for &%-bV%& and causes version information to be displayed. -.new .vitem &%-Ac%& &&& &%-Am%& .oindex "&%-Ac%&" .oindex "&%-Am%&" These options are used by Sendmail for selecting configuration files and are ignored by Exim. -.wen .vitem &%-B%&<&'type'&> .oindex "&%-B%&" @@ -2982,7 +2976,6 @@ use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files if this is required. If the &%bi_command%& option is not set, calling Exim with &%-bi%& is a no-op. -.new . // Keep :help first, then the rest in alphabetical order .vitem &%-bI:help%& .oindex "&%-bI:help%&" @@ -3008,7 +3001,6 @@ useful for ManageSieve (RFC 5804) implementations, in providing that protocol's &`SIEVE`& capability response line. As the precise list may depend upon compile-time build options, which this option will adapt to, this is the only way to guarantee a correct response. -.wen .vitem &%-bm%& .oindex "&%-bm%&" @@ -3123,11 +3115,9 @@ configuration file is output. If a list of configuration files was supplied, the value that is output here is the name of the file that was actually used. -.new .cindex "options" "hiding name of" If the &%-n%& flag is given, then for most modes of &%-bP%& operation the name will not be output. -.wen .cindex "daemon" "process id (pid)" .cindex "pid (process id)" "of daemon" @@ -3732,7 +3722,6 @@ if &%-f%& is also present, it overrides &"From&~"&. .vitem &%-G%& .oindex "&%-G%&" .cindex "submission fixups, suppressing (command-line)" -.new This option is equivalent to an ACL applying: .code control = suppress_local_fixups @@ -3743,7 +3732,6 @@ in future. As this affects audit information, the caller must be a trusted user to use this option. -.wen .vitem &%-h%&&~<&'number'&> .oindex "&%-h%&" @@ -3761,7 +3749,6 @@ line by itself should not terminate an incoming, non-SMTP message. I can find no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'& command in Solaris 2.4 uses it. See also &%-ti%&. -.new .vitem &%-L%&&~<&'tag'&> .oindex "&%-L%&" .cindex "syslog" "process name; set with flag" @@ -3772,7 +3759,6 @@ read and parsed, to determine access rights, before this is set and takes effect, so early configuration file errors will not honour this flag. The tag should not be longer than 32 characters. -.wen .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~... .oindex "&%-M%&" @@ -4636,12 +4622,10 @@ National Language Support extended characters in the body of the mail item"&). It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores this option. -.new .vitem &%-X%&&~<&'logfile'&> .oindex "&%-X%&" This option is interpreted by Sendmail to cause debug information to be sent to the named file. It is ignored by Exim. -.wen .endlist .ecindex IIDclo1 @@ -7056,6 +7040,18 @@ With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular LDAP connections, rather than the SSL-on-connect &`ldaps`&. See the &%ldap_start_tls%& option. +.new +Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly +controlled. Every part of the TLS configuration can be configured by settings in +&_exim.conf_&. Depending on the version of the client libraries installed on +your system, some of the initialization may have required setting options in +&_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed +certificates. This revealed a nuance where the current UID that exim was +running as could affect which config files it read. With Exim 4.83, these +methods become optional, only taking effect if not specifically set in +&_exim.conf_&. +.wen + .section "LDAP quoting" "SECID68" .cindex "LDAP" "quoting" @@ -8268,10 +8264,13 @@ apply to temporary DNS errors, whose handling is described in the next section. .cindex "&`+include_unknown`&" .cindex "&`+ignore_unknown`&" -By default, Exim behaves as if the host does not match the list. This may not -always be what you want to happen. To change Exim's behaviour, the special -items &`+include_unknown`& or &`+ignore_unknown`& may appear in the list (at -top level &-- they are not recognized in an indirected file). +Exim parses a host list from left to right. If it encounters a permanent +lookup failure in any item in the host list before it has found a match, +Exim treats it as a failure and the default behavior is as if the host +does not match the list. This may not always be what you want to happen. +To change Exim's behaviour, the special items &`+include_unknown`& or +&`+ignore_unknown`& may appear in the list (at top level &-- they are +not recognized in an indirected file). .ilist If any item that follows &`+include_unknown`& requires information that @@ -8299,6 +8298,37 @@ Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same list. The effect of each one lasts until the next, or until the end of the list. +To explain the host/ip processing logic a different way for the same ACL: + +.ilist +If you have name lookups or wildcarded host names and +IP addresses in the same host list, you should normally put the IP +addresses first. For example, in an ACL you could have: +.code +accept hosts = 10.9.8.7 : *.friend.example +.endd +The reason you normally would order it this way lies in the +left-to-right way that Exim processes lists. It can test IP addresses +without doing any DNS lookups, but when it reaches an item that requires +a host name, it fails if it cannot find a host name to compare with the +pattern. If the above list is given in the opposite order, the +&%accept%& statement fails for a host whose name cannot be found, even +if its IP address is 10.9.8.7. + +.next +If you really do want to do the name check first, and still recognize the IP +address, you can rewrite the ACL like this: +.code +accept hosts = *.friend.example +accept hosts = 10.9.8.7 +.endd +If the first &%accept%& fails, Exim goes on to try the second one. See chapter +&<>& for details of ACLs. Alternatively, you can use +&`+ignore_unknown`&, which was discussed in depth in the first example in +this section. +.endlist + + .section "Temporary DNS errors when looking up host information" &&& "SECTtemdnserr" @@ -9623,6 +9653,29 @@ expansion item, which extracts the working address from a single RFC2822 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of processing lists. +To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows +a strict interpretation of header line formatting. Exim parses the bare, +unquoted portion of an email address and if it finds a comma, treats it as an +email address seperator. For the example header line: +.code +From: =?iso-8859-2?Q?Last=2C_First?= +.endd +The first example below demonstrates that Q-encoded email addresses are parsed +properly if it is given the raw header (in this example, &`$rheader_from:`&). +It does not see the comma because it's still encoded as "=2C". The second +example below is passed the contents of &`$header_from:`&, meaning it gets +de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses. +The third example shows that the presence of a comma is skipped when it is +quoted. +.code +# exim -be '${addresses:From: \ +=?iso-8859-2?Q?Last=2C_First?= }' +user@example.com +# exim -be '${addresses:From: Last, First }' +Last:user@example.com +# exim -be '${addresses:From: "Last, First" }' +user@example.com +.endd .vitem &*${base62:*&<&'digits'&>&*}*& .cindex "&%base62%& expansion item" @@ -9784,7 +9837,7 @@ be useful for processing the output of the MD5 and SHA-1 hashing functions. This operator converts non-printable characters in a string into a hex escape form. Byte values between 33 (!) and 126 (~) inclusive are left as is, and other byte values are converted to &`\xNN`&, for example a -byt value 127 is converted to &`\x7f`&. +byte value 127 is converted to &`\x7f`&. .vitem &*${lc:*&<&'string'&>&*}*& @@ -9820,12 +9873,12 @@ when &%length%& is used as an operator. The string is interpreted as a list and the number of items is returned. -.vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${list_*&<&'type'&>&*name*&>&*}*& +.vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*& .cindex "expansion" "named list" .cindex "&%listnamed%& expansion item" The name is interpreted as a named list and the content of the list is returned, expanding any referenced lists, re-quoting as needed for colon-separation. -If the optional type if given it must be one of "a", "d", "h" or "l" +If the optional type is given it must be one of "a", "d", "h" or "l" and selects address-, domain-, host- or localpart- lists to search among respectively. Otherwise all types are searched in an undefined order and the first matching list is returned. @@ -10882,7 +10935,16 @@ the value of &$authenticated_id$& is normally the login name of the calling process. However, a trusted user can override this by means of the &%-oMai%& command line option. - +.vitem &$authenticated_fail_id$& +.cindex "authentication" "fail" "id" +.vindex "&$authenticated_fail_id$&" +When an authentication attempt fails, the variable &$authenticated_fail_id$& +will contain the failed authentication id. If more than one authentication +id is attempted, it will contain only the last one. The variable is +available for processing in the ACL's, generally the quit or notquit ACL. +A message to a local recipient could still be accepted without requiring +authentication, which means this variable could also be visible in all of +the ACL's as well. .vitem &$authenticated_sender$& @@ -11868,7 +11930,6 @@ driver that successfully authenticated the client from which the message was received. It is empty if there was no successful authentication. See also &$authenticated_id$&. -.new .vitem &$sender_host_dnssec$& .vindex "&$sender_host_dnssec$&" If &$sender_host_name$& has been populated (by reference, &%hosts_lookup%& or @@ -11890,7 +11951,6 @@ with DNSSEC, only the reverse DNS. If you have changed &%host_lookup_order%& so that &`bydns`& is not the first mechanism in the list, then this variable will be false. -.wen .vitem &$sender_host_name$& @@ -12945,7 +13005,7 @@ listed in more than one group. .section "TLS" "SECID108" .table2 .row &%gnutls_compat_mode%& "use GnuTLS compatibility mode" -.row &%gnutls_enable_pkcs11%& "allow GnuTLS to autoload PKCS11 modules" +.row &%gnutls_allow_auto_pkcs11%& "allow GnuTLS to autoload PKCS11 modules" .row &%openssl_options%& "adjust OpenSSL compatibility options" .row &%tls_advertise_hosts%& "advertise TLS to these hosts" .row &%tls_certificate%& "location of server certificate" @@ -13743,7 +13803,6 @@ to set in them. See &%dns_retrans%& above. -.new .option dns_use_dnssec main integer -1 .cindex "DNS" "resolver options" .cindex "DNS" "DNSSEC" @@ -13752,7 +13811,6 @@ DNS resolver library to either use or not use DNSSEC, overriding the system default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on. If the resolver library does not support DNSSEC then this option has no effect. -.wen .option dns_use_edns0 main integer -1 @@ -13980,15 +14038,13 @@ server. This reduces security slightly, but improves interworking with older implementations of TLS. -.new -option gnutls_enable_pkcs11 main boolean unset +option gnutls_allow_auto_pkcs11 main boolean unset This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with the p11-kit configuration files in &_/etc/pkcs11/modules/_&. See -&url(http://www.gnu.org/software/gnutls/manual/gnutls.html#Smart-cards-and-HSMs) +&url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs) for documentation. -.wen @@ -14759,14 +14815,12 @@ Possible options may include: &`tls_rollback_bug`& .endlist -.new As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects all clients connecting using the MacOS SecureTransport TLS facility prior to MacOS 10.8.4, including email clients. If you see old MacOS clients failing to negotiate TLS then this option value might help, provided that your OpenSSL release is new enough to contain this work-around. This may be a situation where you have to upgrade OpenSSL to get buggy clients working. -.wen .option oracle_servers main "string list" unset @@ -15337,6 +15391,13 @@ live with. . Allow this long option name to split; give it unsplit as a fifth argument . for the automatic .oindex that is generated by .option. +. We insert " &~&~" which is both pretty nasty visually and results in +. non-searchable text. HowItWorks.txt mentions an option for inserting +. zero-width-space, which would be nicer visually and results in (at least) +. html that Firefox will split on when it's forced to reflow (rather than +. inserting a horizontal scrollbar). However, the text is still not +. searchable. NM changed this occurrence for bug 1197 to no longer allow +. the option name to split. .option "smtp_accept_max_per_connection" main integer 1000 &&& smtp_accept_max_per_connection @@ -15388,10 +15449,9 @@ also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the various &%-od%&&'x'& command line options. -. Allow this long option name to split; give it unsplit as a fifth argument -. for the automatic .oindex that is generated by .option. +. See the comment on smtp_accept_max_per_connection -.option "smtp_accept_queue_per_ &~&~connection" main integer 10 &&& +.option "smtp_accept_queue_per_connection" main integer 10 &&& smtp_accept_queue_per_connection .cindex "queueing incoming messages" .cindex "message" "queueing by message count" @@ -16031,6 +16091,21 @@ The available primes are: Some of these will be too small to be accepted by clients. Some may be too large to be accepted by clients. +The TLS protocol does not negotiate an acceptable size for this; clients tend +to hard-drop connections if what is offered by the server is unacceptable, +whether too large or too small, and there's no provision for the client to +tell the server what these constraints are. Thus, as a server operator, you +need to make an educated guess as to what is most likely to work for your +userbase. + +Some known size constraints suggest that a bit-size in the range 2048 to 2236 +is most likely to maximise interoperability. The upper bound comes from +applications using the Mozilla Network Security Services (NSS) library, which +used to set its &`DH_MAX_P_BITS`& upper-bound to 2236. This affects many +mail user agents (MUAs). The lower bound comes from Debian installs of Exim4 +prior to the 4.80 release, as Debian used to patch Exim to raise the minimum +acceptable bound from 1024 to 2048. + .option tls_on_connect_ports main "string list" unset This option specifies a list of incoming SSMTP (aka SMTPS) ports that should @@ -18686,7 +18761,6 @@ quote just the command. An item such as .endd is interpreted as a pipe with a rather strange command name, and no arguments. -.new Note that the above example assumes that the text comes from a lookup source of some sort, so that the quotes are part of the data. If composing a redirect router with a &%data%& option directly specifying this command, the @@ -18696,7 +18770,6 @@ are two main approaches to get around this: escape quotes to be part of the data itself, or avoid using this mechanism and instead create a custom transport with the &%command%& option set and reference that transport from an &%accept%& router. -.wen .next .cindex "file" "in redirection list" @@ -19641,7 +19714,6 @@ one. The variables &$transport_name$& and &$router_name$& contain the name of the transport and the router that called it. - .option delivery_date_add transports boolean false .cindex "&'Delivery-date:'& header line" If this option is true, a &'Delivery-date:'& header is added to the message. @@ -19689,7 +19761,6 @@ Unlike most options, &%headers_add%& can be specified multiple times for a transport; all listed headers are added. - .option headers_only transports boolean false .cindex "transport" "header lines only" .cindex "message" "transporting headers only" @@ -22419,7 +22490,6 @@ See the &%search_parents%& option in chapter &<>& for more details. -.new .option dscp smtp string&!! unset .cindex "DCSP" "outbound" This option causes the DSCP value associated with a socket to be set to one @@ -22433,7 +22503,6 @@ The outbound packets from Exim will be marked with this value in the header that these values will have any effect, not be stripped by networking equipment, or do much of anything without cooperation with your Network Engineer and those of all network operators between the source and destination. -.wen .option fallback_hosts smtp "string list" unset @@ -22839,7 +22908,6 @@ This option specifies a certificate revocation list. The expanded value must be the name of a file that contains a CRL in PEM format. -.new .option tls_dh_min_bits smtp integer 1024 .cindex "TLS" "Diffie-Hellman minimum acceptable size" When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman @@ -22849,7 +22917,6 @@ If the parameter offered by the server is too small, then the TLS handshake will fail. Only supported when using GnuTLS. -.wen .option tls_privatekey smtp string&!! unset @@ -23550,7 +23617,7 @@ In practice, almost all rules start with a domain name pattern without a local part. .cindex "regular expressions" "in retry rules" -&*Warning*&: If you use a regular expression in a routing rule pattern, it +&*Warning*&: If you use a regular expression in a retry rule pattern, it must match a complete address, not just a domain, because that is how regular expressions work in address lists. .display @@ -24533,7 +24600,7 @@ to be returned. If the result of a successful expansion is an empty string, expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&. For any other result, a temporary error code is returned, with the expanded -string as the error text. +string as the error text &*Warning*&: If you use a lookup in the expansion to find the user's password, be sure to make the authentication fail if the user is unknown. @@ -25409,12 +25476,10 @@ option). The &%tls_require_ciphers%& options operate differently, as described in the sections &<>& and &<>&. .next -.new The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS. When using OpenSSL, this option is ignored. (If an API is found to let OpenSSL be configured in this way, let the Exim Maintainers know and we'll likely use it). -.wen .next Some other recently added features may only be available in one or the other. This should be documented with the feature. If the documentation does not @@ -25597,10 +25662,10 @@ aware of future feature enhancements of GnuTLS. Documentation of the strings accepted may be found in the GnuTLS manual, under "Priority strings". This is online as -&url(http://www.gnu.org/software/gnutls/manual/html_node/Priority-Strings.html), +&url(http://www.gnutls.org/manual/html_node/Priority-Strings.html), but beware that this relates to GnuTLS 3, which may be newer than the version installed on your system. If you are using GnuTLS 3, -&url(http://www.gnu.org/software/gnutls/manual/html_node/Listing-the-ciphersuites-in-a-priority-string.html, then the example code) +&url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code) on that site can be used to test a given string. Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three @@ -25686,7 +25751,7 @@ tls_dhparam = none This may also be set to a string identifying a standard prime to be used for DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime used is &`ike23`&. There are a few standard primes available, see the -documetnation for &%tls_dhparam%& for the complete list. +documentation for &%tls_dhparam%& for the complete list. See the command .code @@ -26004,6 +26069,12 @@ validation to succeed, of course, but if it's not preinstalled, sending the root certificate along with the rest makes it available for the user to install if the receiving end is a client MUA that can interact with a user. +Note that certificates using MD5 are unlikely to work on today's Internet; +even if your libraries allow loading them for use in Exim when acting as a +server, increasingly clients will not accept such certificates. The error +diagnostics in such a case can be frustratingly vague. + + .section "Self-signed certificates" "SECID187" .cindex "certificate" "self-signed" @@ -26240,7 +26311,6 @@ your resources. The &%acl_smtp_data%& ACL is run after both the &%acl_smtp_dkim%& and the &%acl_smtp_mime%& ACLs. - .section "The SMTP DKIM ACL" "SECTDKIMACL" The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support enabled (which is the default). @@ -27117,7 +27187,6 @@ udpsend = <; 2001:dB8::dead:beef ; 1234 ;\ - .section "Use of the control modifier" "SECTcontrols" .cindex "&%control%& ACL modifier" The &%control%& modifier supports the following settings: @@ -27174,7 +27243,6 @@ Notice that we put back the lower cased version afterwards, assuming that is what is wanted for subsequent tests. -.new .vitem &*control&~=&~cutthrough_delivery*& .cindex "&ACL;" "cutthrough routing" .cindex "cutthrough" "requesting" @@ -27182,7 +27250,8 @@ This option requests delivery be attempted while the item is being received. It is usable in the RCPT ACL and valid only for single-recipient mails forwarded from one SMTP connection to another. If a recipient-verify callout connection is requested in the same ACL it is held open and used for the data, otherwise one is made -after the ACL completes. Note that routers are used in verify mode. +after the ACL completes. +Note that routers are used in verify mode. Should the ultimate destination system positively accept or reject the mail, a corresponding indication is given to the source system and nothing is queued. @@ -27193,10 +27262,8 @@ line. Delivery in this mode avoids the generation of a bounce mail to a (possibly faked) sender when the destination system is doing content-scan based rejection. -.wen -.new .vitem &*control&~=&~debug/*&<&'options'&> .cindex "&ACL;" "enabling debug logging" .cindex "debugging" "enabling from an ACL" @@ -27213,19 +27280,15 @@ contexts): control = debug/opts=+expand+acl control = debug/tag=.$message_exim_id/opts=+expand .endd -.wen -.new .vitem &*control&~=&~dkim_disable_verify*& .cindex "disable DKIM verify" .cindex "DKIM" "disable verify" This control turns off DKIM verification processing entirely. For details on the operation and configuration of DKIM, see chapter &<>&. -.wen -.new .vitem &*control&~=&~dscp/*&<&'value'&> .cindex "&ACL;" "setting DSCP value" .cindex "DSCP" "inbound" @@ -27241,7 +27304,6 @@ The outbound packets from Exim will be marked with this value in the header that these values will have any effect, not be stripped by networking equipment, or do much of anything without cooperation with your Network Engineer and those of all network operators between the source and destination. -.wen .vitem &*control&~=&~enforce_sync*& &&& @@ -27602,7 +27664,6 @@ in a system filter or in a router or transport. - .section "ACL conditions" "SECTaclconditions" .cindex "&ACL;" "conditions; list of" Some of the conditions listed in this section are available only when Exim is @@ -29527,7 +29588,9 @@ If you do not set &%av_scanner%&, it defaults to av_scanner = sophie:/var/run/sophie .endd If the value of &%av_scanner%& starts with a dollar character, it is expanded -before use. The following scanner types are supported in this release: +before use. +The usual list-parsing of the content (see &<>&) applies. +The following scanner types are supported in this release: .vlist .vitem &%aveserver%& @@ -29553,6 +29616,7 @@ number, and a port, separated by space, as in the second of these examples: av_scanner = clamd:/opt/clamd/socket av_scanner = clamd:192.0.2.3 1234 av_scanner = clamd:192.0.2.3 1234:local +av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234 .endd If the value of av_scanner points to a UNIX socket file or contains the local keyword, then the ClamAV interface will pass a filename containing the data @@ -29561,6 +29625,22 @@ more efficient. Normally in the TCP case, the data is streamed to ClamAV as Exim does not assume that there is a common filesystem with the remote host. There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should you be running a version of ClamAV prior to 0.95. + +The final example shows that multiple TCP targets can be specified. Exim will +randomly use one for each incoming email (i.e. it load balances them). Note +that only TCP targets may be used if specifying a list of scanners; a UNIX +socket cannot be mixed in with TCP targets. If one of the servers becomes +unavailable, Exim will try the remaining one(s) until it finds one that works. +When a clamd server becomes unreachable, Exim will log a message. Exim does +not keep track of scanner state between multiple messages, and the scanner +selection is random, so the message will get logged in the mainlog for each +email that the down scanner gets chosen first (message wrapped to be readable): +.code +2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition: + clamd: connection to localhost, port 3310 failed + (Connection refused) +.endd + If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for contributing the code for this scanner. @@ -34435,14 +34515,14 @@ options are available: .vlist .vitem &*-f*&&~<&'regex'&> -Match the sender address. The field that is tested is enclosed in angle -brackets, so you can test for bounce messages with +Match the sender address using a case-insensitive search. The field that is +tested is enclosed in angle brackets, so you can test for bounce messages with .code exiqgrep -f '^<>$' .endd .vitem &*-r*&&~<&'regex'&> -Match a recipient address. The field that is tested is not enclosed in angle -brackets. +Match a recipient address using a case-insensitve search. The field that is +tested is not enclosed in angle brackets. .vitem &*-s*&&~<&'regex'&> Match against the size field. @@ -35667,6 +35747,8 @@ are given in chapter &<>&. .section "Running local commands" "SECTsecconslocalcmds" +.cindex "security" "local commands" +.cindex "security" "command injection attacks" There are a number of ways in which an administrator can configure Exim to run commands based upon received, untrustworthy, data. Further, in some configurations a user who can control a &_.forward_& file can also arrange to @@ -35710,6 +35792,39 @@ Consider the use of the &%inlisti%& expansion condition instead. + +.section "Trust in configuration data" "SECTsecconfdata" +.cindex "security" "data sources" +.cindex "security" "regular expressions" +.cindex "regular expressions" "security" +.cindex "PCRE" "security" +If configuration data for Exim can come from untrustworthy sources, there +are some issues to be aware of: + +.ilist +Use of &%${expand...}%& may provide a path for shell injection attacks. +.next +Letting untrusted data provide a regular expression is unwise. +.next +Using &%${match...}%& to apply a fixed regular expression against untrusted +data may result in pathological behaviour within PCRE. Be aware of what +"backtracking" means and consider options for being more strict with a regular +expression. Avenues to explore include limiting what can match (avoiding &`.`& +when &`[a-z0-9]`& or other character class will do), use of atomic grouping and +possessive quantifiers or just not using regular expressions against untrusted +data. +.next +It can be important to correctly use &%${quote:...}%&, +&%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion +items to ensure that data is correctly constructed. +.next +Some lookups might return multiple results, even though normal usage is only +expected to yield one result. +.endlist + + + + .section "IPv4 source routing" "SECID272" .cindex "source routing" "in IP packets" .cindex "IP source routing" @@ -36387,7 +36502,7 @@ integer size comparisons against this value. A colon-separated list of names of headers included in the signature. .vitem &%$dkim_key_testing%& "1" if the key record has the "testing" flag set, "0" if not. -.vitem &%$nosubdomains%& +.vitem &%$dkim_key_nosubdomains%& "1" if the key record forbids subdomaining, "0" otherwise. .vitem &%$dkim_key_srvtype%& Service type (tag s=) from the key record. Defaults to "*" if not specified