X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/2b965a652edced91a1af8bb36a33d493f721db7d..e85a7ad5e4b86e82cf7150532bfe8c261bd1cca9:/doc/doc-docbook/spec.xfpt?ds=sidebyside diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt index 6bf8bc75c..e778e5181 100644 --- a/doc/doc-docbook/spec.xfpt +++ b/doc/doc-docbook/spec.xfpt @@ -1,4 +1,4 @@ -. $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.4 2006/05/22 17:43:09 fanf2 Exp $ +. $Cambridge: exim/doc/doc-docbook/spec.xfpt,v 1.10 2006/07/24 11:55:15 fanf2 Exp $ . . ///////////////////////////////////////////////////////////////////////////// . This is the primary source of the Exim Manual. It is an xfpt document that is @@ -4958,7 +4958,7 @@ mentioned at all in the default configuration. -.section "Main configuration settings" +.section "Main configuration settings" "SECTdefconfmain" The main (global) configuration option settings must always come first in the file. The first thing you'll see in the file, after some initial comments, is the line @@ -5034,6 +5034,36 @@ content-scanning extension. The first specifies the interface to the virus scanner, and the second specifies the interface to SpamAssassin. Further details are given in chapter &<>&. +Three more commented-out option settings follow: +.code +# tls_advertise_hosts = * +# tls_certificate = /etc/ssl/exim.crt +# tls_privatekey = /etc/ssl/exim.pem +.endd +These are example settings that can be used when Exim is compiled with +support for TLS (aka SSL) as described in &<>&. The +first one specifies the list of clients that are allowed to use TLS +when connecting to this server; in this case the wildcard means all +clients. The other options specify where Exim should find its TLS +certificate and private key, which together prove the server's +identity to any clients that connect. More details are given in +&<>&. + +Another two commented-out option settings follow: +.code +# daemon_smtp_ports = 25 : 465 : 587 +# tls_on_connect_ports = 465 +.endd +These options provide better support for roaming users who wish to use +this server for message submission. They are not much use unless you +have turned on TLS (as described in the previous paragraph) and +authentication (about which more in &<>&). The usual +SMTP port 25 is often blocked on end-user networks, so RFC 4409 +specifies that message submission should use port 587 instead. However +some software (notably Microsoft Outlook) cannot be configured to use +port 587 correctly, so these settings also enable the non-standard +&"smtps"& port 465. + Two more commented-out options settings follow: .code # qualify_domain = @@ -5275,9 +5305,9 @@ accept authenticated = * This statement accepts the address if the client host has authenticated itself. Submission mode is again specified, on the grounds that such messages are most likely to come from MUAs. The default configuration does not define any -authenticators, which means that no client can in fact authenticate. You will -need to add authenticator definitions if you want to make use of this ACL -statement. +authenticators, though it does include some nearly complete commented-out +examples described in &<>&. This means that no client can in +fact authenticate until you complete the authenticator definitions. .code # deny message = rejected because $sender_host_address \ # is in a black list at $dnslist_domain\n\ @@ -5624,14 +5654,52 @@ rewriting rules in the default configuration file. -.section "Authenticators configuration" +.section "Authenticators configuration" "SECTdefconfauth" .cindex "AUTH" "configuration" The authenticators section of the configuration, introduced by .code begin authenticators .endd -defines mechanisms for the use of the SMTP AUTH command. No authenticators -are specified in the default configuration file. +defines mechanisms for the use of the SMTP AUTH command. The default +configuration file contains two commented-out example authenticators +which support plaintext username/password authentication using the +standard PLAIN mechanism and the traditional but non-standard LOGIN +mechanism, with Exim acting as the server. PLAIN and LOGIN are enough +to support most MUA software. + +The example PLAIN authenticator looks like this: +.code +#PLAIN: +# driver = plaintext +# server_set_id = $auth2 +# server_prompts = : +# server_condition = Authentication is not yet configured +# server_advertise_condition = ${if def:tls_cipher } +.endd +And the example LOGIN authenticator looks like this: +.code +#LOGIN: +# driver = plaintext +# server_set_id = $auth1 +# server_prompts = <| Username: | Password: +# server_condition = Authentication is not yet configured +# server_advertise_condition = ${if def:tls_cipher } +.endd + +The &%server_set_id%& option makes Exim remember the authenticated username +in &$authenticated_id$&, which can be used later in ACLs or routers. The +&%server_prompts%& option configures the &(plaintext)& authenticator so +that it implements the details of the specific authentication mechanism, +i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls +when Exim offers authentication to clients; in the examples, this is only +when TLS or SSL has been started, so to enable the authenticators you also +need to add support for TLS as described in &<>&. + +The &%server_condition%& setting defines how to verify that the username and +password are correct. In the examples it just produces an error message. +To make the authenticators work, you can use a string expansion +expression like one of the examples in &<>&. + .ecindex IIDconfiwal @@ -9901,8 +9969,8 @@ preserve some of the authentication information in the variable user/password authenticator configuration might preserve the user name for use in the routers. Note that this is not the same information that is saved in &$sender_host_authenticated$&. When a message is submitted locally (that is, -not over a TCP connection), the value of &$authenticated_id$& is the login name -of the calling process. +not over a TCP connection) and if the submitter is not a trusted user, +the value of &$authenticated_id$& is the login name of the calling process. .vitem &$authenticated_sender$& .cindex "sender" "authenticated" @@ -10783,7 +10851,7 @@ the argument of a HELO or EHLO command. This is omitted if it is identical to the verified host name or to the host's IP address in square brackets. .vitem &$sender_helo_name$& -.cindex "&$sender_hslo_name$&" +.cindex "&$sender_helo_name$&" When a message is received from a remote host that has issued a HELO or EHLO command, the argument of that command is placed in this variable. It is also set if HELO or EHLO is used when a message is received using SMTP locally via @@ -11670,6 +11738,7 @@ listed in more than one group. .table2 .row &%acl_not_smtp%& "ACL for non-SMTP messages" .row &%acl_not_smtp_mime%& "ACL for non-SMTP MIME parts" +.row &%acl_not_smtp_start%& "ACL for start of non-SMTP message" .row &%acl_smtp_auth%& "ACL for AUTH" .row &%acl_smtp_connect%& "ACL for connection" .row &%acl_smtp_data%& "ACL for DATA" @@ -11923,14 +11992,21 @@ Consequently, this option is turned off by default. .option acl_not_smtp main string&!! unset .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 is on the point -of being accepted. See chapter &<>& for further details. +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 +further details. .option acl_not_smtp_mime main string&!! unset This option defines the ACL that is run for individual MIME parts of non-SMTP messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for SMTP messages. +.option acl_not_smtp_start main string&!! unset +.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. + .option acl_smtp_auth main string&!! unset .cindex "&ACL;" "setting up for SMTP commands" .cindex "AUTH" "ACL for" @@ -13365,6 +13441,13 @@ sequences, primarily to avoid messing up the layout. If &%print_topbitchars%& is set, code values of 128 and above are also considered to be printing characters. +This option also affects the header syntax checks performed by the +&(autoreply)& transport, and whether Exim uses RFC 2047 encoding of +the user's full name when constructing From: and Sender: addresses (as +described in section &<>&). Setting this option can cause +Exim to generate eight bit message headers that do not conform to the +standards. + .option process_log_path main string unset .cindex "process log path" @@ -23570,9 +23653,12 @@ options in the main part of the configuration. These options are: .cindex "VRFY" "ACL for" .cindex "SMTP connection" "ACL for" .cindex "non-smtp message" "ACL for" +.cindex "MIME parts" "ACL for" .table2 140pt .row &~&%acl_not_smtp%& "ACL for non-SMTP messages" +.row &~&%acl_not_smtp_mime%& "ACL for non-SMTP MIME parts" +.row &~&%acl_not_smtp_start%& "ACL at start of non-SMTP message" .row &~&%acl_smtp_auth%& "ACL for AUTH" .row &~&%acl_smtp_connect%& "ACL for start of SMTP connection" .row &~&%acl_smtp_data%& "ACL after DATA is complete" @@ -23680,10 +23766,21 @@ connection is closed. In these special cases, the QUIT ACL does not run. .section "Finding an ACL to use" .cindex "&ACL;" "finding which to use" -The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so you can -use different ACLs in different circumstances. The resulting string does not -have to be the name of an ACL in the configuration file; there are other -possibilities. Having expanded the string, Exim searches for an ACL as follows: +The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so +you can use different ACLs in different circumstances. For example, +.code +acl_smtp_rcpt = ${if ={25}{$interface_port} \ + {acl_check_rcpt} {acl_check_rcpt_submit} } +.endd +In the default configuration file there are some example settings for +providing an RFC 4409 message submission service on port 587 and a +non-standard &"smtps"& service on port 465. You can use a string +expansion like this to choose an ACL for MUAs on these ports which is +more appropriate for this purpose than the default ACL on port 25. + +The expanded string does not have to be the name of an ACL in the +configuration file; there are other possibilities. Having expanded the +string, Exim searches for an ACL as follows: .ilist If the string begins with a slash, Exim uses it as a file name, and reads its @@ -26582,6 +26679,7 @@ deny message = This message scored $spam_score spam points. .cindex "content scanning" "MIME parts" .cindex "MIME content scanning" .cindex "&%acl_smtp_mime%&" +.cindex "&%acl_not_smtp_mime%&" The &%acl_smtp_mime%& global option specifies an ACL that is called once for each MIME part of an SMTP message, including multipart types, in the sequence of their position in the message. Similarly, the &%acl_not_smtp_mime%& option @@ -31139,7 +31237,7 @@ whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it. .cindex "&'exipick'&" John Jetmore's &'exipick'& utility is included in the Exim distribution. It lists messages from the queue according to a variety of criteria. For details, -run: +visit &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run: .code exipick --help .endd