1 /* $Cambridge: exim/src/src/transports/smtp.c,v 1.22 2006/02/23 12:41:23 ph10 Exp $ */
3 /*************************************************
4 * Exim - an Internet mail transport agent *
5 *************************************************/
7 /* Copyright (c) University of Cambridge 1995 - 2006 */
8 /* See the file NOTICE for conditions of use and distribution. */
14 #define PENDING_DEFER (PENDING + DEFER)
15 #define PENDING_OK (PENDING + OK)
18 /* Options specific to the smtp transport. This transport also supports LMTP
19 over TCP/IP. The options must be in alphabetic order (note that "_" comes
20 before the lower case letters). Some live in the transport_instance block so as
21 to be publicly visible; these are flagged with opt_public. */
23 optionlist smtp_transport_options[] = {
24 { "allow_localhost", opt_bool,
25 (void *)offsetof(smtp_transport_options_block, allow_localhost) },
26 { "authenticated_sender", opt_stringptr,
27 (void *)offsetof(smtp_transport_options_block, authenticated_sender) },
28 { "command_timeout", opt_time,
29 (void *)offsetof(smtp_transport_options_block, command_timeout) },
30 { "connect_timeout", opt_time,
31 (void *)offsetof(smtp_transport_options_block, connect_timeout) },
32 { "connection_max_messages", opt_int | opt_public,
33 (void *)offsetof(transport_instance, connection_max_messages) },
34 { "data_timeout", opt_time,
35 (void *)offsetof(smtp_transport_options_block, data_timeout) },
36 { "delay_after_cutoff", opt_bool,
37 (void *)offsetof(smtp_transport_options_block, delay_after_cutoff) },
38 #ifdef EXPERIMENTAL_DOMAINKEYS
39 { "dk_canon", opt_stringptr,
40 (void *)offsetof(smtp_transport_options_block, dk_canon) },
41 { "dk_domain", opt_stringptr,
42 (void *)offsetof(smtp_transport_options_block, dk_domain) },
43 { "dk_headers", opt_stringptr,
44 (void *)offsetof(smtp_transport_options_block, dk_headers) },
45 { "dk_private_key", opt_stringptr,
46 (void *)offsetof(smtp_transport_options_block, dk_private_key) },
47 { "dk_selector", opt_stringptr,
48 (void *)offsetof(smtp_transport_options_block, dk_selector) },
49 { "dk_strict", opt_stringptr,
50 (void *)offsetof(smtp_transport_options_block, dk_strict) },
52 { "dns_qualify_single", opt_bool,
53 (void *)offsetof(smtp_transport_options_block, dns_qualify_single) },
54 { "dns_search_parents", opt_bool,
55 (void *)offsetof(smtp_transport_options_block, dns_search_parents) },
56 { "fallback_hosts", opt_stringptr,
57 (void *)offsetof(smtp_transport_options_block, fallback_hosts) },
58 { "final_timeout", opt_time,
59 (void *)offsetof(smtp_transport_options_block, final_timeout) },
60 { "gethostbyname", opt_bool,
61 (void *)offsetof(smtp_transport_options_block, gethostbyname) },
62 { "helo_data", opt_stringptr,
63 (void *)offsetof(smtp_transport_options_block, helo_data) },
64 { "hosts", opt_stringptr,
65 (void *)offsetof(smtp_transport_options_block, hosts) },
66 { "hosts_avoid_esmtp", opt_stringptr,
67 (void *)offsetof(smtp_transport_options_block, hosts_avoid_esmtp) },
69 { "hosts_avoid_tls", opt_stringptr,
70 (void *)offsetof(smtp_transport_options_block, hosts_avoid_tls) },
72 { "hosts_max_try", opt_int,
73 (void *)offsetof(smtp_transport_options_block, hosts_max_try) },
74 { "hosts_max_try_hardlimit", opt_int,
75 (void *)offsetof(smtp_transport_options_block, hosts_max_try_hardlimit) },
77 { "hosts_nopass_tls", opt_stringptr,
78 (void *)offsetof(smtp_transport_options_block, hosts_nopass_tls) },
80 { "hosts_override", opt_bool,
81 (void *)offsetof(smtp_transport_options_block, hosts_override) },
82 { "hosts_randomize", opt_bool,
83 (void *)offsetof(smtp_transport_options_block, hosts_randomize) },
84 { "hosts_require_auth", opt_stringptr,
85 (void *)offsetof(smtp_transport_options_block, hosts_require_auth) },
87 { "hosts_require_tls", opt_stringptr,
88 (void *)offsetof(smtp_transport_options_block, hosts_require_tls) },
90 { "hosts_try_auth", opt_stringptr,
91 (void *)offsetof(smtp_transport_options_block, hosts_try_auth) },
92 { "interface", opt_stringptr,
93 (void *)offsetof(smtp_transport_options_block, interface) },
94 { "keepalive", opt_bool,
95 (void *)offsetof(smtp_transport_options_block, keepalive) },
96 { "lmtp_ignore_quota", opt_bool,
97 (void *)offsetof(smtp_transport_options_block, lmtp_ignore_quota) },
98 { "max_rcpt", opt_int | opt_public,
99 (void *)offsetof(transport_instance, max_addresses) },
100 { "multi_domain", opt_bool | opt_public,
101 (void *)offsetof(transport_instance, multi_domain) },
102 { "port", opt_stringptr,
103 (void *)offsetof(smtp_transport_options_block, port) },
104 { "protocol", opt_stringptr,
105 (void *)offsetof(smtp_transport_options_block, protocol) },
106 { "retry_include_ip_address", opt_bool,
107 (void *)offsetof(smtp_transport_options_block, retry_include_ip_address) },
108 { "serialize_hosts", opt_stringptr,
109 (void *)offsetof(smtp_transport_options_block, serialize_hosts) },
110 { "size_addition", opt_int,
111 (void *)offsetof(smtp_transport_options_block, size_addition) }
113 ,{ "tls_certificate", opt_stringptr,
114 (void *)offsetof(smtp_transport_options_block, tls_certificate) },
115 { "tls_crl", opt_stringptr,
116 (void *)offsetof(smtp_transport_options_block, tls_crl) },
117 { "tls_privatekey", opt_stringptr,
118 (void *)offsetof(smtp_transport_options_block, tls_privatekey) },
119 { "tls_require_ciphers", opt_stringptr,
120 (void *)offsetof(smtp_transport_options_block, tls_require_ciphers) },
121 { "tls_tempfail_tryclear", opt_bool,
122 (void *)offsetof(smtp_transport_options_block, tls_tempfail_tryclear) },
123 { "tls_verify_certificates", opt_stringptr,
124 (void *)offsetof(smtp_transport_options_block, tls_verify_certificates) }
128 /* Size of the options list. An extern variable has to be used so that its
129 address can appear in the tables drtables.c. */
131 int smtp_transport_options_count =
132 sizeof(smtp_transport_options)/sizeof(optionlist);
134 /* Default private options block for the smtp transport. */
136 smtp_transport_options_block smtp_transport_option_defaults = {
138 NULL, /* fallback_hosts */
140 NULL, /* fallback_hostlist */
141 NULL, /* authenticated_sender */
142 US"$primary_hostname", /* helo_data */
143 NULL, /* interface */
145 US"smtp", /* protocol */
146 NULL, /* serialize_hosts */
147 NULL, /* hosts_try_auth */
148 NULL, /* hosts_require_auth */
149 NULL, /* hosts_require_tls */
150 NULL, /* hosts_avoid_tls */
151 NULL, /* hosts_avoid_esmtp */
152 NULL, /* hosts_nopass_tls */
153 5*60, /* command_timeout */
154 5*60, /* connect_timeout; shorter system default overrides */
155 5*60, /* data timeout */
156 10*60, /* final timeout */
157 1024, /* size_addition */
158 5, /* hosts_max_try */
159 50, /* hosts_max_try_hardlimit */
160 FALSE, /* allow_localhost */
161 FALSE, /* gethostbyname */
162 TRUE, /* dns_qualify_single */
163 FALSE, /* dns_search_parents */
164 TRUE, /* delay_after_cutoff */
165 FALSE, /* hosts_override */
166 FALSE, /* hosts_randomize */
167 TRUE, /* keepalive */
168 FALSE, /* lmtp_ignore_quota */
169 TRUE /* retry_include_ip_address */
171 ,NULL, /* tls_certificate */
173 NULL, /* tls_privatekey */
174 NULL, /* tls_require_ciphers */
175 NULL, /* tls_verify_certificates */
176 TRUE /* tls_tempfail_tryclear */
178 #ifdef EXPERIMENTAL_DOMAINKEYS
179 ,NULL, /* dk_canon */
180 NULL, /* dk_domain */
181 NULL, /* dk_headers */
182 NULL, /* dk_private_key */
183 NULL, /* dk_selector */
191 static uschar *smtp_command; /* Points to last cmd for error messages */
192 static uschar *mail_command; /* Points to MAIL cmd for error messages */
195 /*************************************************
196 * Setup entry point *
197 *************************************************/
199 /* This function is called when the transport is about to be used,
200 but before running it in a sub-process. It is used for two things:
202 (1) To set the fallback host list in addresses, when delivering.
203 (2) To pass back the interface, port, and protocol options, for use during
204 callout verification.
207 tblock pointer to the transport instance block
208 addrlist list of addresses about to be transported
209 tf if not NULL, pointer to block in which to return options
210 uid the uid that will be set (not used)
211 gid the gid that will be set (not used)
212 errmsg place for error message (not used)
214 Returns: OK always (FAIL, DEFER not used)
218 smtp_transport_setup(transport_instance *tblock, address_item *addrlist,
219 transport_feedback *tf, uid_t uid, gid_t gid, uschar **errmsg)
221 smtp_transport_options_block *ob =
222 (smtp_transport_options_block *)(tblock->options_block);
224 errmsg = errmsg; /* Keep picky compilers happy */
228 /* Pass back options if required. This interface is getting very messy. */
232 tf->interface = ob->interface;
234 tf->protocol = ob->protocol;
235 tf->hosts = ob->hosts;
236 tf->hosts_override = ob->hosts_override;
237 tf->hosts_randomize = ob->hosts_randomize;
238 tf->gethostbyname = ob->gethostbyname;
239 tf->qualify_single = ob->dns_qualify_single;
240 tf->search_parents = ob->dns_search_parents;
243 /* Set the fallback host list for all the addresses that don't have fallback
244 host lists, provided that the local host wasn't present in the original host
247 if (!testflag(addrlist, af_local_host_removed))
249 for (; addrlist != NULL; addrlist = addrlist->next)
250 if (addrlist->fallback_hosts == NULL)
251 addrlist->fallback_hosts = ob->fallback_hostlist;
259 /*************************************************
260 * Initialization entry point *
261 *************************************************/
263 /* Called for each instance, after its options have been read, to
264 enable consistency checks to be done, or anything else that needs
267 Argument: pointer to the transport instance block
272 smtp_transport_init(transport_instance *tblock)
274 smtp_transport_options_block *ob =
275 (smtp_transport_options_block *)(tblock->options_block);
277 /* Retry_use_local_part defaults FALSE if unset */
279 if (tblock->retry_use_local_part == TRUE_UNSET)
280 tblock->retry_use_local_part = FALSE;
282 /* Set the default port according to the protocol */
284 if (ob->port == NULL)
285 ob->port = (strcmpic(ob->protocol, US"lmtp") == 0)? US"lmtp" : US"smtp";
287 /* Set up the setup entry point, to be called before subprocesses for this
290 tblock->setup = smtp_transport_setup;
292 /* Complain if any of the timeouts are zero. */
294 if (ob->command_timeout <= 0 || ob->data_timeout <= 0 ||
295 ob->final_timeout <= 0)
296 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
297 "command, data, or final timeout value is zero for %s transport",
300 /* If hosts_override is set and there are local hosts, set the global
301 flag that stops verify from showing router hosts. */
303 if (ob->hosts_override && ob->hosts != NULL) tblock->overrides_hosts = TRUE;
305 /* If there are any fallback hosts listed, build a chain of host items
306 for them, but do not do any lookups at this time. */
308 host_build_hostlist(&(ob->fallback_hostlist), ob->fallback_hosts, FALSE);
315 /*************************************************
316 * Set delivery info into all active addresses *
317 *************************************************/
319 /* Only addresses whose status is >= PENDING are relevant. A lesser
320 status means that an address is not currently being processed.
323 addrlist points to a chain of addresses
324 errno_value to put in each address's errno field
325 msg to put in each address's message field
326 rc to put in each address's transport_return field
327 pass_message if TRUE, set the "pass message" flag in the address
329 If errno_value has the special value ERRNO_CONNECTTIMEOUT, ETIMEDOUT is put in
330 the errno field, and RTEF_CTOUT is ORed into the more_errno field, to indicate
331 this particular type of timeout.
337 set_errno(address_item *addrlist, int errno_value, uschar *msg, int rc,
342 if (errno_value == ERRNO_CONNECTTIMEOUT)
344 errno_value = ETIMEDOUT;
345 orvalue = RTEF_CTOUT;
347 for (addr = addrlist; addr != NULL; addr = addr->next)
349 if (addr->transport_return < PENDING) continue;
350 addr->basic_errno = errno_value;
351 addr->more_errno |= orvalue;
355 if (pass_message) setflag(addr, af_pass_message);
357 addr->transport_return = rc;
363 /*************************************************
364 * Check an SMTP response *
365 *************************************************/
367 /* This function is given an errno code and the SMTP response buffer
368 to analyse, together with the host identification for generating messages. It
369 sets an appropriate message and puts the first digit of the response code into
370 the yield variable. If no response was actually read, a suitable digit is
374 host the current host, to get its name for messages
375 errno_value pointer to the errno value
376 more_errno from the top address for use with ERRNO_FILTER_FAIL
377 buffer the SMTP response buffer
378 yield where to put a one-digit SMTP response code
379 message where to put an errror message
380 pass_message set TRUE if message is an SMTP response
382 Returns: TRUE if an SMTP "QUIT" command should be sent, else FALSE
385 static BOOL check_response(host_item *host, int *errno_value, int more_errno,
386 uschar *buffer, int *yield, uschar **message, BOOL *pass_message)
390 if (smtp_use_pipelining &&
391 (Ustrcmp(smtp_command, "MAIL") == 0 ||
392 Ustrcmp(smtp_command, "RCPT") == 0 ||
393 Ustrcmp(smtp_command, "DATA") == 0))
396 *yield = '4'; /* Default setting is to give a temporary error */
398 /* Handle response timeout */
400 if (*errno_value == ETIMEDOUT)
402 *message = US string_sprintf("SMTP timeout while connected to %s [%s] "
403 "after %s%s", host->name, host->address, pl, smtp_command);
404 if (transport_count > 0)
405 *message = US string_sprintf("%s (%d bytes written)", *message,
410 /* Handle malformed SMTP response */
412 if (*errno_value == ERRNO_SMTPFORMAT)
414 uschar *malfresp = string_printing(buffer);
415 while (isspace(*malfresp)) malfresp++;
417 *message = string_sprintf("Malformed SMTP reply (an empty line) from "
418 "%s [%s] in response to %s%s", host->name, host->address, pl,
421 *message = string_sprintf("Malformed SMTP reply from %s [%s] in response "
422 "to %s%s: %s", host->name, host->address, pl, smtp_command, malfresp);
426 /* Handle a failed filter process error; can't send QUIT as we mustn't
429 if (*errno_value == ERRNO_FILTER_FAIL)
431 *message = US string_sprintf("transport filter process failed (%d)%s",
433 (more_errno == EX_EXECFAILED)? ": unable to execute command" : "");
437 /* Handle a failed add_headers expansion; can't send QUIT as we mustn't
440 if (*errno_value == ERRNO_CHHEADER_FAIL)
443 US string_sprintf("failed to expand headers_add or headers_remove: %s",
444 expand_string_message);
448 /* Handle failure to write a complete data block */
450 if (*errno_value == ERRNO_WRITEINCOMPLETE)
452 *message = US string_sprintf("failed to write a data block");
456 /* Handle error responses from the remote mailer. */
460 uschar *s = string_printing(buffer);
461 *message = US string_sprintf("SMTP error from remote mail server after %s%s: "
462 "host %s [%s]: %s", pl, smtp_command, host->name, host->address, s);
463 *pass_message = TRUE;
468 /* No data was read. If there is no errno, this must be the EOF (i.e.
469 connection closed) case, which causes deferral. An explicit connection reset
470 error has the same effect. Otherwise, put the host's identity in the message,
471 leaving the errno value to be interpreted as well. In all cases, we have to
472 assume the connection is now dead. */
474 if (*errno_value == 0 || *errno_value == ECONNRESET)
476 *errno_value = ERRNO_SMTPCLOSED;
477 *message = US string_sprintf("Remote host %s [%s] closed connection "
478 "in response to %s%s", host->name, host->address, pl, smtp_command);
480 else *message = US string_sprintf("%s [%s]", host->name, host->address);
487 /*************************************************
488 * Write error message to logs *
489 *************************************************/
491 /* This writes to the main log and to the message log.
494 addr the address item containing error information
495 host the current host
501 write_logs(address_item *addr, host_item *host)
503 if (addr->message != NULL)
505 uschar *message = addr->message;
506 if (addr->basic_errno > 0)
507 message = string_sprintf("%s: %s", message, strerror(addr->basic_errno));
508 log_write(0, LOG_MAIN, "%s", message);
509 deliver_msglog("%s %s\n", tod_stamp(tod_log), message);
514 ((log_extra_selector & LX_outgoing_port) != 0)?
515 string_sprintf("%s [%s]:%d", host->name, host->address,
516 (host->port == PORT_NONE)? 25 : host->port)
518 string_sprintf("%s [%s]", host->name, host->address);
519 log_write(0, LOG_MAIN, "%s %s", msg, strerror(addr->basic_errno));
520 deliver_msglog("%s %s %s\n", tod_stamp(tod_log), msg,
521 strerror(addr->basic_errno));
527 /*************************************************
528 * Synchronize SMTP responses *
529 *************************************************/
531 /* This function is called from smtp_deliver() to receive SMTP responses from
532 the server, and match them up with the commands to which they relate. When
533 PIPELINING is not in use, this function is called after every command, and is
534 therefore somewhat over-engineered, but it is simpler to use a single scheme
535 that works both with and without PIPELINING instead of having two separate sets
538 The set of commands that are buffered up with pipelining may start with MAIL
539 and may end with DATA; in between are RCPT commands that correspond to the
540 addresses whose status is PENDING_DEFER. All other commands (STARTTLS, AUTH,
541 etc.) are never buffered.
543 Errors after MAIL or DATA abort the whole process leaving the response in the
544 buffer. After MAIL, pending responses are flushed, and the original command is
545 re-instated in big_buffer for error messages. For RCPT commands, the remote is
546 permitted to reject some recipient addresses while accepting others. However
547 certain errors clearly abort the whole process. Set the value in
548 transport_return to PENDING_OK if the address is accepted. If there is a
549 subsequent general error, it will get reset accordingly. If not, it will get
550 converted to OK at the end.
553 addrlist the complete address list
554 include_affixes TRUE if affixes include in RCPT
555 sync_addr ptr to the ptr of the one to start scanning at (updated)
556 host the host we are connected to
557 count the number of responses to read
558 pending_MAIL true if the first response is for MAIL
559 pending_DATA 0 if last command sent was not DATA
560 +1 if previously had a good recipient
561 -1 if not previously had a good recipient
562 inblock incoming SMTP block
563 timeout timeout value
564 buffer buffer for reading response
565 buffsize size of buffer
567 Returns: 3 if at least one address had 2xx and one had 5xx
568 2 if at least one address had 5xx but none had 2xx
569 1 if at least one host had a 2xx response, but none had 5xx
570 0 no address had 2xx or 5xx but no errors (all 4xx, or just DATA)
571 -1 timeout while reading RCPT response
572 -2 I/O or other non-response error for RCPT
573 -3 DATA or MAIL failed - errno and buffer set
577 sync_responses(address_item *addrlist, BOOL include_affixes,
578 address_item **sync_addr, host_item *host, int count, BOOL pending_MAIL,
579 int pending_DATA, smtp_inblock *inblock, int timeout, uschar *buffer,
582 address_item *addr = *sync_addr;
585 /* Handle the response for a MAIL command. On error, reinstate the original
586 command in big_buffer for error message use, and flush any further pending
587 responses before returning, except after I/O errors and timeouts. */
592 if (!smtp_read_response(inblock, buffer, buffsize, '2', timeout))
594 Ustrcpy(big_buffer, mail_command); /* Fits, because it came from there! */
595 if (errno == 0 && buffer[0] != 0)
597 uschar flushbuffer[4096];
600 if (!smtp_read_response(inblock, flushbuffer, sizeof(flushbuffer),
602 && (errno != 0 || flushbuffer[0] == 0))
610 if (pending_DATA) count--; /* Number of RCPT responses to come */
612 /* Read and handle the required number of RCPT responses, matching each one up
613 with an address by scanning for the next address whose status is PENDING_DEFER.
618 while (addr->transport_return != PENDING_DEFER) addr = addr->next;
620 /* The address was accepted */
622 if (smtp_read_response(inblock, buffer, buffsize, '2', timeout))
625 addr->transport_return = PENDING_OK;
627 /* If af_dr_retry_exists is set, there was a routing delay on this address;
628 ensure that any address-specific retry record is expunged. */
630 if (testflag(addr, af_dr_retry_exists))
631 retry_add_item(addr, addr->address_retry_key, rf_delete);
634 /* Timeout while reading the response */
636 else if (errno == ETIMEDOUT)
638 int save_errno = errno;
639 uschar *message = string_sprintf("SMTP timeout while connected to %s [%s] "
640 "after RCPT TO:<%s>", host->name, host->address,
641 transport_rcpt_address(addr, include_affixes));
642 set_errno(addrlist, save_errno, message, DEFER, FALSE);
643 retry_add_item(addr, addr->address_retry_key, 0);
644 host->update_waiting = FALSE;
648 /* Handle other errors in obtaining an SMTP response by returning -1. This
649 will cause all the addresses to be deferred. Restore the SMTP command in
650 big_buffer for which we are checking the response, so the error message
653 else if (errno != 0 || buffer[0] == 0)
655 string_format(big_buffer, big_buffer_size, "RCPT TO:<%s>",
656 transport_rcpt_address(addr, include_affixes));
660 /* Handle SMTP permanent and temporary response codes. */
665 string_sprintf("SMTP error from remote mail server after RCPT TO:<%s>: "
666 "host %s [%s]: %s", transport_rcpt_address(addr, include_affixes),
667 host->name, host->address, string_printing(buffer));
668 setflag(addr, af_pass_message);
669 deliver_msglog("%s %s\n", tod_stamp(tod_log), addr->message);
671 /* The response was 5xx */
673 if (buffer[0] == '5')
675 addr->transport_return = FAIL;
679 /* The response was 4xx */
683 int bincode = (buffer[1] - '0')*10 + buffer[2] - '0';
685 addr->transport_return = DEFER;
686 addr->basic_errno = ERRNO_RCPT4XX;
687 addr->more_errno |= bincode << 8;
689 /* Log temporary errors if there are more hosts to be tried. */
691 if (host->next != NULL) log_write(0, LOG_MAIN, "%s", addr->message);
693 /* Do not put this message on the list of those waiting for this host,
694 as otherwise it is likely to be tried too often. */
696 host->update_waiting = FALSE;
698 /* Add a retry item for the address so that it doesn't get tried
701 retry_add_item(addr, addr->address_retry_key, 0);
704 } /* Loop for next RCPT response */
706 /* Update where to start at for the next block of responses, unless we
707 have already handled all the addresses. */
709 if (addr != NULL) *sync_addr = addr->next;
711 /* Handle a response to DATA. If we have not had any good recipients, either
712 previously or in this block, the response is ignored. */
714 if (pending_DATA != 0 &&
715 !smtp_read_response(inblock, buffer, buffsize, '3', timeout))
720 if (pending_DATA > 0 || (yield & 1) != 0) return -3;
721 (void)check_response(host, &errno, 0, buffer, &code, &msg, &pass_message);
722 DEBUG(D_transport) debug_printf("%s\nerror for DATA ignored: pipelining "
723 "is in use and there were no good recipients\n", msg);
726 /* All responses read and handled; MAIL (if present) received 2xx and DATA (if
727 present) received 3xx. If any RCPTs were handled and yielded anything other
728 than 4xx, yield will be set non-zero. */
735 /*************************************************
736 * Deliver address list to given host *
737 *************************************************/
739 /* If continue_hostname is not null, we get here only when continuing to
740 deliver down an existing channel. The channel was passed as the standard
743 Otherwise, we have to make a connection to the remote host, and do the
744 initial protocol exchange.
746 When running as an MUA wrapper, if the sender or any recipient is rejected,
747 temporarily or permanently, we force failure for all recipients.
750 addrlist chain of potential addresses to deliver; only those whose
751 transport_return field is set to PENDING_DEFER are currently
752 being processed; others should be skipped - they have either
753 been delivered to an earlier host or IP address, or been
754 failed by one of them.
755 host host to deliver to
756 host_af AF_INET or AF_INET6
757 port default TCP/IP port to use, in host byte order
758 interface interface to bind to, or NULL
759 tblock transport instance block
760 copy_host TRUE if host set in addr->host_used must be copied, because
761 it is specific to this call of the transport
762 message_defer set TRUE if yield is OK, but all addresses were deferred
763 because of a non-recipient, non-host failure, that is, a
764 4xx response to MAIL FROM, DATA, or ".". This is a defer
765 that is specific to the message.
766 suppress_tls if TRUE, don't attempt a TLS connection - this is set for
767 a second attempt after TLS initialization fails
769 Returns: OK - the connection was made and the delivery attempted;
770 the result for each address is in its data block.
771 DEFER - the connection could not be made, or something failed
772 while setting up the SMTP session, or there was a
773 non-message-specific error, such as a timeout.
774 ERROR - a filter command is specified for this transport,
775 and there was a problem setting it up; OR helo_data
776 or add_headers or authenticated_sender is specified
777 for this transport, and the string failed to expand
781 smtp_deliver(address_item *addrlist, host_item *host, int host_af, int port,
782 uschar *interface, transport_instance *tblock, BOOL copy_host,
783 BOOL *message_defer, BOOL suppress_tls)
786 address_item *sync_addr;
787 address_item *first_addr = addrlist;
792 time_t start_delivery_time = time(NULL);
793 smtp_transport_options_block *ob =
794 (smtp_transport_options_block *)(tblock->options_block);
795 BOOL lmtp = strcmpic(ob->protocol, US"lmtp") == 0;
797 BOOL send_rset = TRUE;
798 BOOL send_quit = TRUE;
799 BOOL setting_up = TRUE;
800 BOOL completed_address = FALSE;
803 BOOL pass_message = FALSE;
804 smtp_inblock inblock;
805 smtp_outblock outblock;
806 int max_rcpt = tblock->max_addresses;
807 uschar *igquotstr = US"";
808 uschar *local_authenticated_sender = authenticated_sender;
810 uschar *message = NULL;
811 uschar new_message_id[MESSAGE_ID_LENGTH + 1];
814 uschar inbuffer[4096];
815 uschar outbuffer[1024];
817 suppress_tls = suppress_tls; /* stop compiler warning when no TLS support */
819 *message_defer = FALSE;
820 smtp_command = US"initial connection";
821 if (max_rcpt == 0) max_rcpt = 999999;
823 /* Set up the buffer for reading SMTP response packets. */
825 inblock.buffer = inbuffer;
826 inblock.buffersize = sizeof(inbuffer);
827 inblock.ptr = inbuffer;
828 inblock.ptrend = inbuffer;
830 /* Set up the buffer for holding SMTP commands while pipelining */
832 outblock.buffer = outbuffer;
833 outblock.buffersize = sizeof(outbuffer);
834 outblock.ptr = outbuffer;
835 outblock.cmd_count = 0;
836 outblock.authenticating = FALSE;
838 /* Expand the greeting message */
840 helo_data = expand_string(ob->helo_data);
841 if (helo_data == NULL)
843 uschar *message = string_sprintf("failed to expand helo_data: %s",
844 expand_string_message);
845 set_errno(addrlist, 0, message, DEFER, FALSE);
849 /* If an authenticated_sender override has been specified for this transport
850 instance, expand it. If the expansion is forced to fail, and there was already
851 an authenticated_sender for this message, the original value will be used.
852 Other expansion failures are serious. An empty result is ignored, but there is
853 otherwise no check - this feature is expected to be used with LMTP and other
854 cases where non-standard addresses (e.g. without domains) might be required. */
856 if (ob->authenticated_sender != NULL)
858 uschar *new = expand_string(ob->authenticated_sender);
861 if (!expand_string_forcedfail)
863 uschar *message = string_sprintf("failed to expand "
864 "authenticated_sender: %s", expand_string_message);
865 set_errno(addrlist, 0, message, DEFER, FALSE);
869 else if (new[0] != 0) local_authenticated_sender = new;
872 /* Make a connection to the host if this isn't a continued delivery, and handle
873 the initial interaction and HELO/EHLO/LHLO. Connect timeout errors are handled
874 specially so they can be identified for retries. */
876 if (continue_hostname == NULL)
878 inblock.sock = outblock.sock =
879 smtp_connect(host, host_af, port, interface, ob->connect_timeout,
881 if (inblock.sock < 0)
883 set_errno(addrlist, (errno == ETIMEDOUT)? ERRNO_CONNECTTIMEOUT : errno,
888 /* The first thing is to wait for an initial OK response. The dreaded "goto"
889 is nevertheless a reasonably clean way of programming this kind of logic,
890 where you want to escape on any error. */
892 if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
893 ob->command_timeout)) goto RESPONSE_FAILED;
895 /** Debugging without sending a message
896 addrlist->transport_return = DEFER;
900 /* Errors that occur after this point follow an SMTP command, which is
901 left in big_buffer by smtp_write_command() for use in error messages. */
903 smtp_command = big_buffer;
905 /* Tell the remote who we are...
907 February 1998: A convention has evolved that ESMTP-speaking MTAs include the
908 string "ESMTP" in their greeting lines, so make Exim send EHLO if the
909 greeting is of this form. The assumption was that the far end supports it
910 properly... but experience shows that there are some that give 5xx responses,
911 even though the banner includes "ESMTP" (there's a bloody-minded one that
912 says "ESMTP not spoken here"). Cope with that case.
914 September 2000: Time has passed, and it seems reasonable now to always send
915 EHLO at the start. It is also convenient to make the change while installing
918 July 2003: Joachim Wieland met a broken server that advertises "PIPELINING"
919 but times out after sending MAIL FROM, RCPT TO and DATA all together. There
920 would be no way to send out the mails, so there is now a host list
921 "hosts_avoid_esmtp" that disables ESMTP for special hosts and solves the
922 PIPELINING problem as well. Maybe it can also be useful to cure other
923 problems with broken servers.
925 Exim originally sent "Helo" at this point and ran for nearly a year that way.
926 Then somebody tried it with a Microsoft mailer... It seems that all other
927 mailers use upper case for some reason (the RFC is quite clear about case
928 independence) so, for peace of mind, I gave in. */
930 esmtp = verify_check_this_host(&(ob->hosts_avoid_esmtp), NULL,
931 host->name, host->address, NULL) != OK;
935 if (smtp_write_command(&outblock, FALSE, "%s %s\r\n",
936 lmtp? "LHLO" : "EHLO", helo_data) < 0)
938 if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
939 ob->command_timeout))
941 if (errno != 0 || buffer[0] == 0 || lmtp) goto RESPONSE_FAILED;
948 debug_printf("not sending EHLO (host matches hosts_avoid_esmtp)\n");
953 if (smtp_write_command(&outblock, FALSE, "HELO %s\r\n", helo_data) < 0)
955 if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
956 ob->command_timeout)) goto RESPONSE_FAILED;
959 /* Set IGNOREQUOTA if the response to LHLO specifies support and the
960 lmtp_ignore_quota option was set. */
962 igquotstr = (lmtp && ob->lmtp_ignore_quota &&
963 pcre_exec(regex_IGNOREQUOTA, NULL, CS buffer, Ustrlen(CS buffer), 0,
964 PCRE_EOPT, NULL, 0) >= 0)? US" IGNOREQUOTA" : US"";
966 /* Set tls_offered if the response to EHLO specifies support for STARTTLS. */
969 tls_offered = esmtp &&
970 pcre_exec(regex_STARTTLS, NULL, CS buffer, Ustrlen(buffer), 0,
971 PCRE_EOPT, NULL, 0) >= 0;
975 /* For continuing deliveries down the same channel, the socket is the standard
976 input, and we don't need to redo EHLO here (but may need to do so for TLS - see
977 below). Set up the pointer to where subsequent commands will be left, for
978 error messages. Note that smtp_use_size and smtp_use_pipelining will have been
979 set from the command line if they were set in the process that passed the
984 inblock.sock = outblock.sock = fileno(stdin);
985 smtp_command = big_buffer;
988 /* If TLS is available on this connection, whether continued or not, attempt to
989 start up a TLS session, unless the host is in hosts_avoid_tls. If successful,
990 send another EHLO - the server may give a different answer in secure mode. We
991 use a separate buffer for reading the response to STARTTLS so that if it is
992 negative, the original EHLO data is available for subsequent analysis, should
993 the client not be required to use TLS. If the response is bad, copy the buffer
994 for error analysis. */
997 if (tls_offered && !suppress_tls &&
998 verify_check_this_host(&(ob->hosts_avoid_tls), NULL, host->name,
999 host->address, NULL) != OK)
1001 uschar buffer2[4096];
1002 if (smtp_write_command(&outblock, FALSE, "STARTTLS\r\n") < 0)
1005 /* If there is an I/O error, transmission of this message is deferred. If
1006 there is a temporary rejection of STARRTLS and tls_tempfail_tryclear is
1007 false, we also defer. However, if there is a temporary rejection of STARTTLS
1008 and tls_tempfail_tryclear is true, or if there is an outright rejection of
1009 STARTTLS, we carry on. This means we will try to send the message in clear,
1010 unless the host is in hosts_require_tls (tested below). */
1012 if (!smtp_read_response(&inblock, buffer2, sizeof(buffer2), '2',
1013 ob->command_timeout))
1015 Ustrncpy(buffer, buffer2, sizeof(buffer));
1016 if (errno != 0 || buffer2[0] == 0 ||
1017 (buffer2[0] == '4' && !ob->tls_tempfail_tryclear))
1018 goto RESPONSE_FAILED;
1021 /* STARTTLS accepted: try to negotiate a TLS session. */
1025 int rc = tls_client_start(inblock.sock, host, addrlist,
1026 NULL, /* No DH param */
1027 ob->tls_certificate,
1029 ob->tls_verify_certificates,
1031 ob->tls_require_ciphers,
1032 ob->command_timeout);
1034 /* TLS negotiation failed; give an error. From outside, this function may
1035 be called again to try in clear on a new connection, if the options permit
1036 it for this host. */
1040 save_errno = ERRNO_TLSFAILURE;
1041 message = US"failure while setting up TLS session";
1046 /* TLS session is set up */
1048 for (addr = addrlist; addr != NULL; addr = addr->next)
1050 if (addr->transport_return == PENDING_DEFER)
1052 addr->cipher = tls_cipher;
1053 addr->peerdn = tls_peerdn;
1059 /* If we started TLS, redo the EHLO/LHLO exchange over the secure channel. */
1061 if (tls_active >= 0)
1063 if (smtp_write_command(&outblock, FALSE, "%s %s\r\n", lmtp? "LHLO" : "EHLO",
1066 if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1067 ob->command_timeout))
1068 goto RESPONSE_FAILED;
1071 /* If the host is required to use a secure channel, ensure that we
1074 else if (verify_check_this_host(&(ob->hosts_require_tls), NULL, host->name,
1075 host->address, NULL) == OK)
1077 save_errno = ERRNO_TLSREQUIRED;
1078 message = string_sprintf("a TLS session is required for %s [%s], but %s",
1079 host->name, host->address,
1080 tls_offered? "an attempt to start TLS failed" :
1081 "the server did not offer TLS support");
1086 /* If TLS is active, we have just started it up and re-done the EHLO command,
1087 so its response needs to be analyzed. If TLS is not active and this is a
1088 continued session down a previously-used socket, we haven't just done EHLO, so
1091 if (continue_hostname == NULL
1098 uschar *fail_reason = US"server did not advertise AUTH support";
1100 /* Set for IGNOREQUOTA if the response to LHLO specifies support and the
1101 lmtp_ignore_quota option was set. */
1103 igquotstr = (lmtp && ob->lmtp_ignore_quota &&
1104 pcre_exec(regex_IGNOREQUOTA, NULL, CS buffer, Ustrlen(CS buffer), 0,
1105 PCRE_EOPT, NULL, 0) >= 0)? US" IGNOREQUOTA" : US"";
1107 /* If the response to EHLO specified support for the SIZE parameter, note
1108 this, provided size_addition is non-negative. */
1110 smtp_use_size = esmtp && ob->size_addition >= 0 &&
1111 pcre_exec(regex_SIZE, NULL, CS buffer, Ustrlen(CS buffer), 0,
1112 PCRE_EOPT, NULL, 0) >= 0;
1114 /* Note whether the server supports PIPELINING. If hosts_avoid_esmtp matched
1115 the current host, esmtp will be false, so PIPELINING can never be used. */
1117 smtp_use_pipelining = esmtp &&
1118 pcre_exec(regex_PIPELINING, NULL, CS buffer, Ustrlen(CS buffer), 0,
1119 PCRE_EOPT, NULL, 0) >= 0;
1121 DEBUG(D_transport) debug_printf("%susing PIPELINING\n",
1122 smtp_use_pipelining? "" : "not ");
1124 /* Note if the response to EHLO specifies support for the AUTH extension.
1125 If it has, check that this host is one we want to authenticate to, and do
1126 the business. The host name and address must be available when the
1127 authenticator's client driver is running. */
1129 smtp_authenticated = FALSE;
1130 require_auth = verify_check_this_host(&(ob->hosts_require_auth), NULL,
1131 host->name, host->address, NULL);
1133 if (esmtp && regex_match_and_setup(regex_AUTH, buffer, 0, -1))
1135 uschar *names = string_copyn(expand_nstring[1], expand_nlength[1]);
1136 expand_nmax = -1; /* reset */
1138 /* Must not do this check until after we have saved the result of the
1139 regex match above. */
1141 if (require_auth == OK ||
1142 verify_check_this_host(&(ob->hosts_try_auth), NULL, host->name,
1143 host->address, NULL) == OK)
1146 fail_reason = US"no common mechanisms were found";
1148 DEBUG(D_transport) debug_printf("scanning authentication mechanisms\n");
1150 /* Scan the configured authenticators looking for one which is configured
1151 for use as a client and whose name matches an authentication mechanism
1152 supported by the server. If one is found, attempt to authenticate by
1153 calling its client function. */
1155 for (au = auths; !smtp_authenticated && au != NULL; au = au->next)
1158 if (!au->client) continue;
1160 /* Loop to scan supported server mechanisms */
1165 int len = Ustrlen(au->public_name);
1166 while (isspace(*p)) p++;
1168 if (strncmpic(au->public_name, p, len) != 0 ||
1169 (p[len] != 0 && !isspace(p[len])))
1171 while (*p != 0 && !isspace(*p)) p++;
1175 /* Found data for a listed mechanism. Call its client entry. Set
1176 a flag in the outblock so that data is overwritten after sending so
1177 that reflections don't show it. */
1179 fail_reason = US"authentication attempt(s) failed";
1180 outblock.authenticating = TRUE;
1181 rc = (au->info->clientcode)(au, &inblock, &outblock,
1182 ob->command_timeout, buffer, sizeof(buffer));
1183 outblock.authenticating = FALSE;
1184 DEBUG(D_transport) debug_printf("%s authenticator yielded %d\n",
1187 /* A temporary authentication failure must hold up delivery to
1188 this host. After a permanent authentication failure, we carry on
1189 to try other authentication methods. If all fail hard, try to
1190 deliver the message unauthenticated unless require_auth was set. */
1195 smtp_authenticated = TRUE; /* stops the outer loop */
1198 /* Failure after writing a command */
1203 /* Failure after reading a response */
1206 if (errno != 0 || buffer[0] != '5') goto RESPONSE_FAILED;
1207 log_write(0, LOG_MAIN, "%s authenticator failed H=%s [%s] %s",
1208 au->name, host->name, host->address, buffer);
1211 /* Failure by some other means. In effect, the authenticator
1212 decided it wasn't prepared to handle this case. Typically this
1213 is the result of "fail" in an expansion string. Do we need to
1214 log anything here? Feb 2006: a message is now put in the buffer
1215 if logging is required. */
1219 log_write(0, LOG_MAIN, "%s authenticator cancelled "
1220 "authentication H=%s [%s] %s", au->name, host->name,
1221 host->address, buffer);
1224 /* Internal problem, message in buffer. */
1228 set_errno(addrlist, 0, string_copy(buffer), DEFER, FALSE);
1232 break; /* If not authenticated, try next authenticator */
1233 } /* Loop for scanning supported server mechanisms */
1234 } /* Loop for further authenticators */
1238 /* If we haven't authenticated, but are required to, give up. */
1240 if (require_auth == OK && !smtp_authenticated)
1243 set_errno(addrlist, ERRNO_AUTHFAIL,
1244 string_sprintf("authentication required but %s", fail_reason), DEFER,
1250 /* The setting up of the SMTP call is now complete. Any subsequent errors are
1251 message-specific. */
1255 /* If there is a filter command specified for this transport, we can now
1256 set it up. This cannot be done until the identify of the host is known. */
1258 if (tblock->filter_command != NULL)
1262 sprintf(CS buffer, "%.50s transport", tblock->name);
1263 rc = transport_set_up_command(&transport_filter_argv, tblock->filter_command,
1264 TRUE, DEFER, addrlist, buffer, NULL);
1266 /* On failure, copy the error to all addresses, abandon the SMTP call, and
1271 set_errno(addrlist->next, addrlist->basic_errno, addrlist->message, DEFER,
1279 /* For messages that have more than the maximum number of envelope recipients,
1280 we want to send several transactions down the same SMTP connection. (See
1281 comments in deliver.c as to how this reconciles, heuristically, with
1282 remote_max_parallel.) This optimization was added to Exim after the following
1283 code was already working. The simplest way to put it in without disturbing the
1284 code was to use a goto to jump back to this point when there is another
1285 transaction to handle. */
1288 sync_addr = first_addr;
1292 completed_address = FALSE;
1295 /* Initiate a message transfer. If we know the receiving MTA supports the SIZE
1296 qualification, send it, adding something to the message size to allow for
1297 imprecision and things that get added en route. Exim keeps the number of lines
1298 in a message, so we can give an accurate value for the original message, but we
1299 need some additional to handle added headers. (Double "." characters don't get
1300 included in the count.) */
1307 sprintf(CS p, " SIZE=%d", message_size+message_linecount+ob->size_addition);
1311 /* Add the authenticated sender address if present */
1313 if (smtp_authenticated && local_authenticated_sender != NULL)
1315 string_format(p, sizeof(buffer) - (p-buffer), " AUTH=%s",
1316 auth_xtextencode(local_authenticated_sender,
1317 Ustrlen(local_authenticated_sender)));
1320 /* From here until we send the DATA command, we can make use of PIPELINING
1321 if the server host supports it. The code has to be able to check the responses
1322 at any point, for when the buffer fills up, so we write it totally generally.
1323 When PIPELINING is off, each command written reports that it has flushed the
1326 pending_MAIL = TRUE; /* The block starts with MAIL */
1328 rc = smtp_write_command(&outblock, smtp_use_pipelining,
1329 "MAIL FROM:<%s>%s\r\n", return_path, buffer);
1330 mail_command = string_copy(big_buffer); /* Save for later error message */
1334 case -1: /* Transmission error */
1337 case +1: /* Block was sent */
1338 if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1339 ob->command_timeout)) goto RESPONSE_FAILED;
1340 pending_MAIL = FALSE;
1344 /* Pass over all the relevant recipient addresses for this host, which are the
1345 ones that have status PENDING_DEFER. If we are using PIPELINING, we can send
1346 several before we have to read the responses for those seen so far. This
1347 checking is done by a subroutine because it also needs to be done at the end.
1348 Send only up to max_rcpt addresses at a time, leaving first_addr pointing to
1349 the next one if not all are sent.
1351 In the MUA wrapper situation, we want to flush the PIPELINING buffer for the
1352 last address because we want to abort if any recipients have any kind of
1353 problem, temporary or permanent. We know that all recipient addresses will have
1354 the PENDING_DEFER status, because only one attempt is ever made, and we know
1355 that max_rcpt will be large, so all addresses will be done at once. */
1357 for (addr = first_addr;
1358 address_count < max_rcpt && addr != NULL;
1364 if (addr->transport_return != PENDING_DEFER) continue;
1367 no_flush = smtp_use_pipelining && (!mua_wrapper || addr->next != NULL);
1369 /* Now send the RCPT command, and process outstanding responses when
1370 necessary. After a timeout on RCPT, we just end the function, leaving the
1371 yield as OK, because this error can often mean that there is a problem with
1372 just one address, so we don't want to delay the host. */
1374 count = smtp_write_command(&outblock, no_flush, "RCPT TO:<%s>%s\r\n",
1375 transport_rcpt_address(addr, tblock->rcpt_include_affixes), igquotstr);
1376 if (count < 0) goto SEND_FAILED;
1379 switch(sync_responses(first_addr, tblock->rcpt_include_affixes,
1380 &sync_addr, host, count, pending_MAIL, 0, &inblock,
1381 ob->command_timeout, buffer, sizeof(buffer)))
1383 case 3: ok = TRUE; /* 2xx & 5xx => OK & progress made */
1384 case 2: completed_address = TRUE; /* 5xx (only) => progress made */
1387 case 1: ok = TRUE; /* 2xx (only) => OK, but if LMTP, */
1388 if (!lmtp) completed_address = TRUE; /* can't tell about progress yet */
1389 case 0: /* No 2xx or 5xx, but no probs */
1392 case -1: goto END_OFF; /* Timeout on RCPT */
1393 default: goto RESPONSE_FAILED; /* I/O error, or any MAIL error */
1395 pending_MAIL = FALSE; /* Dealt with MAIL */
1397 } /* Loop for next address */
1399 /* If we are an MUA wrapper, abort if any RCPTs were rejected, either
1400 permanently or temporarily. We should have flushed and synced after the last
1405 address_item *badaddr;
1406 for (badaddr = first_addr; badaddr != NULL; badaddr = badaddr->next)
1408 if (badaddr->transport_return != PENDING_OK) break;
1410 if (badaddr != NULL)
1412 set_errno(addrlist, 0, badaddr->message, FAIL,
1413 testflag(badaddr, af_pass_message));
1418 /* If ok is TRUE, we know we have got at least one good recipient, and must now
1419 send DATA, but if it is FALSE (in the normal, non-wrapper case), we may still
1420 have a good recipient buffered up if we are pipelining. We don't want to waste
1421 time sending DATA needlessly, so we only send it if either ok is TRUE or if we
1422 are pipelining. The responses are all handled by sync_responses(). */
1424 if (ok || (smtp_use_pipelining && !mua_wrapper))
1426 int count = smtp_write_command(&outblock, FALSE, "DATA\r\n");
1427 if (count < 0) goto SEND_FAILED;
1428 switch(sync_responses(first_addr, tblock->rcpt_include_affixes, &sync_addr,
1429 host, count, pending_MAIL, ok? +1 : -1, &inblock,
1430 ob->command_timeout, buffer, sizeof(buffer)))
1432 case 3: ok = TRUE; /* 2xx & 5xx => OK & progress made */
1433 case 2: completed_address = TRUE; /* 5xx (only) => progress made */
1436 case 1: ok = TRUE; /* 2xx (only) => OK, but if LMTP, */
1437 if (!lmtp) completed_address = TRUE; /* can't tell about progress yet */
1438 case 0: break; /* No 2xx or 5xx, but no probs */
1440 case -1: goto END_OFF; /* Timeout on RCPT */
1441 default: goto RESPONSE_FAILED; /* I/O error, or any MAIL/DATA error */
1445 /* Save the first address of the next batch. */
1449 /* If there were no good recipients (but otherwise there have been no
1450 problems), just set ok TRUE, since we have handled address-specific errors
1451 already. Otherwise, it's OK to send the message. Use the check/escape mechanism
1452 for handling the SMTP dot-handling protocol, flagging to apply to headers as
1453 well as body. Set the appropriate timeout value to be used for each chunk.
1454 (Haven't been able to make it work using select() for writing yet.) */
1456 if (!ok) ok = TRUE; else
1458 sigalrm_seen = FALSE;
1459 transport_write_timeout = ob->data_timeout;
1460 smtp_command = US"sending data block"; /* For error messages */
1461 DEBUG(D_transport|D_v)
1462 debug_printf(" SMTP>> writing message and terminating \".\"\n");
1463 transport_count = 0;
1464 #ifdef EXPERIMENTAL_DOMAINKEYS
1465 if ( (ob->dk_private_key != NULL) && (ob->dk_selector != NULL) )
1466 ok = dk_transport_write_message(addrlist, inblock.sock,
1467 topt_use_crlf | topt_end_dot | topt_escape_headers |
1468 (tblock->body_only? topt_no_headers : 0) |
1469 (tblock->headers_only? topt_no_body : 0) |
1470 (tblock->return_path_add? topt_add_return_path : 0) |
1471 (tblock->delivery_date_add? topt_add_delivery_date : 0) |
1472 (tblock->envelope_to_add? topt_add_envelope_to : 0),
1473 0, /* No size limit */
1474 tblock->add_headers, tblock->remove_headers,
1475 US".", US"..", /* Escaping strings */
1476 tblock->rewrite_rules, tblock->rewrite_existflags,
1477 ob->dk_private_key, ob->dk_domain, ob->dk_selector,
1478 ob->dk_canon, ob->dk_headers, ob->dk_strict);
1481 ok = transport_write_message(addrlist, inblock.sock,
1482 topt_use_crlf | topt_end_dot | topt_escape_headers |
1483 (tblock->body_only? topt_no_headers : 0) |
1484 (tblock->headers_only? topt_no_body : 0) |
1485 (tblock->return_path_add? topt_add_return_path : 0) |
1486 (tblock->delivery_date_add? topt_add_delivery_date : 0) |
1487 (tblock->envelope_to_add? topt_add_envelope_to : 0),
1488 0, /* No size limit */
1489 tblock->add_headers, tblock->remove_headers,
1490 US".", US"..", /* Escaping strings */
1491 tblock->rewrite_rules, tblock->rewrite_existflags);
1493 /* transport_write_message() uses write() because it is called from other
1494 places to write to non-sockets. This means that under some OS (e.g. Solaris)
1495 it can exit with "Broken pipe" as its error. This really means that the
1496 socket got closed at the far end. */
1498 transport_write_timeout = 0; /* for subsequent transports */
1500 /* Failure can either be some kind of I/O disaster (including timeout),
1501 or the failure of a transport filter or the expansion of added headers. */
1505 buffer[0] = 0; /* There hasn't been a response */
1506 goto RESPONSE_FAILED;
1509 /* We used to send the terminating "." explicitly here, but because of
1510 buffering effects at both ends of TCP/IP connections, you don't gain
1511 anything by keeping it separate, so it might as well go in the final
1512 data buffer for efficiency. This is now done by setting the topt_end_dot
1515 smtp_command = US"end of data";
1517 /* For SMTP, we now read a single response that applies to the whole message.
1518 If it is OK, then all the addresses have been delivered. */
1520 if (!lmtp) ok = smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1523 /* For LMTP, we get back a response for every RCPT command that we sent;
1524 some may be accepted and some rejected. For those that get a response, their
1525 status is fixed; any that are accepted have been handed over, even if later
1526 responses crash - at least, that's how I read RFC 2033.
1528 If all went well, mark the recipient addresses as completed, record which
1529 host/IPaddress they were delivered to, and cut out RSET when sending another
1530 message down the same channel. Write the completed addresses to the journal
1531 now so that they are recorded in case there is a crash of hardware or
1532 software before the spool gets updated. Also record the final SMTP
1533 confirmation if needed (for SMTP only). */
1538 int delivery_time = (int)(time(NULL) - start_delivery_time);
1541 uschar *conf = NULL;
1544 /* Make a copy of the host if it is local to this invocation
1545 of the transport. */
1549 thost = store_get(sizeof(host_item));
1551 thost->name = string_copy(host->name);
1552 thost->address = string_copy(host->address);
1556 /* Set up confirmation if needed - applies only to SMTP */
1558 if ((log_extra_selector & LX_smtp_confirmation) != 0 && !lmtp)
1560 uschar *s = string_printing(buffer);
1561 conf = (s == buffer)? (uschar *)string_copy(s) : s;
1564 /* Process all transported addresses - for LMTP, read a status for
1567 for (addr = addrlist; addr != first_addr; addr = addr->next)
1569 if (addr->transport_return != PENDING_OK) continue;
1571 /* LMTP - if the response fails badly (e.g. timeout), use it for all the
1572 remaining addresses. Otherwise, it's a return code for just the one
1577 if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1580 if (errno != 0 || buffer[0] == 0) goto RESPONSE_FAILED;
1581 addr->message = string_sprintf("LMTP error after %s: %s",
1582 big_buffer, string_printing(buffer));
1583 addr->transport_return = (buffer[0] == '5')? FAIL : DEFER;
1586 completed_address = TRUE; /* NOW we can set this flag */
1589 /* SMTP, or success return from LMTP for this address. Pass back the
1590 actual host that was used. */
1592 addr->transport_return = OK;
1593 addr->more_errno = delivery_time;
1594 addr->host_used = thost;
1595 addr->special_action = flag;
1596 addr->message = conf;
1599 /* Update the journal. For homonymic addresses, use the base address plus
1600 the transport name. See lots of comments in deliver.c about the reasons
1601 for the complications when homonyms are involved. Just carry on after
1602 write error, as it may prove possible to update the spool file later. */
1604 if (testflag(addr, af_homonym))
1605 sprintf(CS buffer, "%.500s/%s\n", addr->unique + 3, tblock->name);
1607 sprintf(CS buffer, "%.500s\n", addr->unique);
1609 DEBUG(D_deliver) debug_printf("journalling %s", buffer);
1610 len = Ustrlen(CS buffer);
1611 if (write(journal_fd, buffer, len) != len)
1612 log_write(0, LOG_MAIN|LOG_PANIC, "failed to write journal for "
1613 "%s: %s", buffer, strerror(errno));
1616 /* Ensure the journal file is pushed out to disk. */
1618 if (fsync(journal_fd) < 0)
1619 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
1625 /* Handle general (not specific to one address) failures here. The value of ok
1626 is used to skip over this code on the falling through case. A timeout causes a
1627 deferral. Other errors may defer or fail according to the response code, and
1628 may set up a special errno value, e.g. after connection chopped, which is
1629 assumed if errno == 0 and there is no text in the buffer. If control reaches
1630 here during the setting up phase (i.e. before MAIL FROM) then always defer, as
1631 the problem is not related to this specific message. */
1640 send_quit = check_response(host, &save_errno, addrlist->more_errno,
1641 buffer, &code, &message, &pass_message);
1647 message = US string_sprintf("send() to %s [%s] failed: %s",
1648 host->name, host->address, strerror(save_errno));
1652 /* This label is jumped to directly when a TLS negotiation has failed,
1653 or was not done for a host for which it is required. Values will be set
1654 in message and save_errno, and setting_up will always be true. Treat as
1655 a temporary error. */
1662 /* If the failure happened while setting up the call, see if the failure was
1663 a 5xx response (this will either be on connection, or following HELO - a 5xx
1664 after EHLO causes it to try HELO). If so, fail all addresses, as this host is
1665 never going to accept them. For other errors during setting up (timeouts or
1666 whatever), defer all addresses, and yield DEFER, so that the host is not
1667 tried again for a while. */
1670 ok = FALSE; /* For when reached by GOTO */
1676 set_errno(addrlist, save_errno, message, FAIL, pass_message);
1680 set_errno(addrlist, save_errno, message, DEFER, pass_message);
1685 /* If there was an I/O error or timeout or other transportation error,
1686 indicated by errno being non-zero, defer all addresses and yield DEFER,
1687 except for the case of failed add_headers expansion, or a transport filter
1688 failure, when the yield should be ERROR, to stop it trying other hosts.
1690 However, handle timeouts after MAIL FROM or "." and loss of connection after
1691 "." specially. They can indicate a problem with the sender address or with
1692 the contents of the message rather than a real error on the connection.
1693 Therefore, treat these cases in the same way as a 4xx response.
1695 The following condition tests for NOT these special cases. */
1697 else if (save_errno != 0 &&
1698 (save_errno != ETIMEDOUT ||
1699 (Ustrncmp(smtp_command,"MAIL",4) != 0 &&
1700 Ustrncmp(smtp_command,"end ",4) != 0)) &&
1701 (save_errno != ERRNO_SMTPCLOSED ||
1702 Ustrncmp(smtp_command,"end ",4) != 0))
1704 yield = (save_errno == ERRNO_CHHEADER_FAIL ||
1705 save_errno == ERRNO_FILTER_FAIL)? ERROR : DEFER;
1706 set_errno(addrlist, save_errno, message, DEFER, pass_message);
1709 /* Otherwise we have a message-specific error response from the remote
1710 host. This is one of
1711 (a) negative response or timeout after "mail from"
1712 (b) negative response after "data"
1713 (c) negative response or timeout or dropped connection after "."
1714 It won't be a negative response or timeout after "rcpt to", as that is dealt
1715 with separately above. The action in all cases is to set an appropriate
1716 error code for all the addresses, but to leave yield set to OK because
1717 the host itself has not failed. [It might in practice have failed for a
1718 timeout after MAIL FROM, or "." but if so, we'll discover that at the next
1719 delivery attempt.] For a temporary error, set the message_defer flag, and
1720 write to the logs for information if this is not the last host. The error for
1721 the last host will be logged as part of the address's log line. */
1725 if (mua_wrapper) code = '5'; /* Force hard failure in wrapper mode */
1727 set_errno(addrlist, save_errno, message, (code == '5')? FAIL : DEFER,
1730 /* If there's an errno, the message contains just the identity of
1733 if (code != '5') /* Anything other than 5 is treated as temporary */
1736 message = US string_sprintf("%s: %s", message, strerror(save_errno));
1737 if (host->next != NULL) log_write(0, LOG_MAIN, "%s", message);
1738 deliver_msglog("%s %s\n", tod_stamp(tod_log), message);
1739 *message_defer = TRUE;
1745 /* If all has gone well, send_quit will be set TRUE, implying we can end the
1746 SMTP session tidily. However, if there were too many addresses to send in one
1747 message (indicated by first_addr being non-NULL) we want to carry on with the
1748 rest of them. Also, it is desirable to send more than one message down the SMTP
1749 connection if there are several waiting, provided we haven't already sent so
1750 many as to hit the configured limit. The function transport_check_waiting looks
1751 for a waiting message and returns its id. Then transport_pass_socket tries to
1752 set up a continued delivery by passing the socket on to another process. The
1753 variable send_rset is FALSE if a message has just been successfully transfered.
1755 If we are already sending down a continued channel, there may be further
1756 addresses not yet delivered that are aimed at the same host, but which have not
1757 been passed in this run of the transport. In this case, continue_more will be
1758 true, and all we should do is send RSET if necessary, and return, leaving the
1761 However, if no address was disposed of, i.e. all addresses got 4xx errors, we
1762 do not want to continue with other messages down the same channel, because that
1763 can lead to looping between two or more messages, all with the same,
1764 temporarily failing address(es). [The retry information isn't updated yet, so
1765 new processes keep on trying.] We probably also don't want to try more of this
1766 message's addresses either.
1768 If we have started a TLS session, we have to end it before passing the
1769 connection to a new process. However, not all servers can handle this (Exim
1770 can), so we do not pass such a connection on if the host matches
1771 hosts_nopass_tls. */
1774 debug_printf("ok=%d send_quit=%d send_rset=%d continue_more=%d "
1775 "yield=%d first_address is %sNULL\n", ok, send_quit, send_rset,
1776 continue_more, yield, (first_addr == NULL)? "":"not ");
1778 if (completed_address && ok && send_quit)
1781 if (first_addr != NULL || continue_more ||
1784 verify_check_this_host(&(ob->hosts_nopass_tls), NULL, host->name,
1785 host->address, NULL) != OK)
1787 transport_check_waiting(tblock->name, host->name,
1788 tblock->connection_max_messages, new_message_id, &more)
1796 if (! (ok = smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0))
1798 msg = US string_sprintf("send() to %s [%s] failed: %s", host->name,
1799 host->address, strerror(save_errno));
1802 else if (! (ok = smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1803 ob->command_timeout)))
1806 send_quit = check_response(host, &errno, 0, buffer, &code, &msg,
1810 DEBUG(D_transport) debug_printf("%s\n", msg);
1815 /* Either RSET was not needed, or it succeeded */
1819 if (first_addr != NULL) /* More addresses still to be sent */
1820 { /* in this run of the transport */
1821 continue_sequence++; /* Causes * in logging */
1824 if (continue_more) return yield; /* More addresses for another run */
1826 /* Pass the socket to a new Exim process. Before doing so, we must shut
1827 down TLS. Not all MTAs allow for the continuation of the SMTP session
1828 when TLS is shut down. We test for this by sending a new EHLO. If we
1829 don't get a good response, we don't attempt to pass the socket on. */
1832 if (tls_active >= 0)
1835 ok = smtp_write_command(&outblock,FALSE,"EHLO %s\r\n",helo_data) >= 0 &&
1836 smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1837 ob->command_timeout);
1841 /* If the socket is successfully passed, we musn't send QUIT (or
1842 indeed anything!) from here. */
1844 if (ok && transport_pass_socket(tblock->name, host->name, host->address,
1845 new_message_id, inblock.sock))
1851 /* If RSET failed and there are addresses left, they get deferred. */
1853 else set_errno(first_addr, errno, msg, DEFER, FALSE);
1857 /* End off tidily with QUIT unless the connection has died or the socket has
1858 been passed to another process. There has been discussion on the net about what
1859 to do after sending QUIT. The wording of the RFC suggests that it is necessary
1860 to wait for a response, but on the other hand, there isn't anything one can do
1861 with an error response, other than log it. Exim used to do that. However,
1862 further discussion suggested that it is positively advantageous not to wait for
1863 the response, but to close the session immediately. This is supposed to move
1864 the TCP/IP TIME_WAIT state from the server to the client, thereby removing some
1865 load from the server. (Hosts that are both servers and clients may not see much
1866 difference, of course.) Further discussion indicated that this was safe to do
1867 on Unix systems which have decent implementations of TCP/IP that leave the
1868 connection around for a while (TIME_WAIT) after the application has gone away.
1869 This enables the response sent by the server to be properly ACKed rather than
1870 timed out, as can happen on broken TCP/IP implementations on other OS.
1872 This change is being made on 31-Jul-98. After over a year of trouble-free
1873 operation, the old commented-out code was removed on 17-Sep-99. */
1876 if (send_quit) (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
1884 /* Close the socket, and return the appropriate value, first setting
1885 continue_transport and continue_hostname NULL to prevent any other addresses
1886 that may include the host from trying to re-use a continuation socket. This
1887 works because the NULL setting is passed back to the calling process, and
1888 remote_max_parallel is forced to 1 when delivering over an existing connection,
1890 If all went well and continue_more is set, we shouldn't actually get here if
1891 there are further addresses, as the return above will be taken. However,
1892 writing RSET might have failed, or there may be other addresses whose hosts are
1893 specified in the transports, and therefore not visible at top level, in which
1894 case continue_more won't get set. */
1896 (void)close(inblock.sock);
1897 continue_transport = NULL;
1898 continue_hostname = NULL;
1905 /*************************************************
1906 * Closedown entry point *
1907 *************************************************/
1909 /* This function is called when exim is passed an open smtp channel
1910 from another incarnation, but the message which it has been asked
1911 to deliver no longer exists. The channel is on stdin.
1913 We might do fancy things like looking for another message to send down
1914 the channel, but if the one we sought has gone, it has probably been
1915 delivered by some other process that itself will seek further messages,
1916 so just close down our connection.
1918 Argument: pointer to the transport instance block
1923 smtp_transport_closedown(transport_instance *tblock)
1925 smtp_transport_options_block *ob =
1926 (smtp_transport_options_block *)(tblock->options_block);
1927 smtp_inblock inblock;
1928 smtp_outblock outblock;
1930 uschar inbuffer[4096];
1931 uschar outbuffer[16];
1933 inblock.sock = fileno(stdin);
1934 inblock.buffer = inbuffer;
1935 inblock.buffersize = sizeof(inbuffer);
1936 inblock.ptr = inbuffer;
1937 inblock.ptrend = inbuffer;
1939 outblock.sock = inblock.sock;
1940 outblock.buffersize = sizeof(outbuffer);
1941 outblock.buffer = outbuffer;
1942 outblock.ptr = outbuffer;
1943 outblock.cmd_count = 0;
1944 outblock.authenticating = FALSE;
1946 (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
1947 (void)smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1948 ob->command_timeout);
1949 (void)close(inblock.sock);
1954 /*************************************************
1955 * Prepare addresses for delivery *
1956 *************************************************/
1958 /* This function is called to flush out error settings from previous delivery
1959 attempts to other hosts. It also records whether we got here via an MX record
1960 or not in the more_errno field of the address. We are interested only in
1961 addresses that are still marked DEFER - others may have got delivered to a
1962 previously considered IP address. Set their status to PENDING_DEFER to indicate
1963 which ones are relevant this time.
1966 addrlist the list of addresses
1967 host the host we are delivering to
1969 Returns: the first address for this delivery
1972 static address_item *
1973 prepare_addresses(address_item *addrlist, host_item *host)
1975 address_item *first_addr = NULL;
1977 for (addr = addrlist; addr != NULL; addr = addr->next)
1979 if (addr->transport_return != DEFER) continue;
1980 if (first_addr == NULL) first_addr = addr;
1981 addr->transport_return = PENDING_DEFER;
1982 addr->basic_errno = 0;
1983 addr->more_errno = (host->mx >= 0)? 'M' : 'A';
1984 addr->message = NULL;
1986 addr->cipher = NULL;
1987 addr->peerdn = NULL;
1995 /*************************************************
1996 * Main entry point *
1997 *************************************************/
1999 /* See local README for interface details. As this is a remote transport, it is
2000 given a chain of addresses to be delivered in one connection, if possible. It
2001 always returns TRUE, indicating that each address has its own independent
2002 status set, except if there is a setting up problem, in which case it returns
2006 smtp_transport_entry(
2007 transport_instance *tblock, /* data for this instantiation */
2008 address_item *addrlist) /* addresses we are working on */
2012 int hosts_defer = 0;
2014 int hosts_looked_up = 0;
2015 int hosts_retry = 0;
2016 int hosts_serial = 0;
2017 int hosts_total = 0;
2018 int total_hosts_tried = 0;
2020 BOOL expired = TRUE;
2021 BOOL continuing = continue_hostname != NULL;
2022 uschar *expanded_hosts = NULL;
2024 uschar *tid = string_sprintf("%s transport", tblock->name);
2025 smtp_transport_options_block *ob =
2026 (smtp_transport_options_block *)(tblock->options_block);
2027 host_item *hostlist = addrlist->host_list;
2028 host_item *host = NULL;
2032 debug_printf("%s transport entered\n", tblock->name);
2033 for (addr = addrlist; addr != NULL; addr = addr->next)
2034 debug_printf(" %s\n", addr->address);
2035 if (continuing) debug_printf("already connected to %s [%s]\n",
2036 continue_hostname, continue_host_address);
2039 /* If a host list is not defined for the addresses - they must all have the
2040 same one in order to be passed to a single transport - or if the transport has
2041 a host list with hosts_override set, use the host list supplied with the
2042 transport. It is an error for this not to exist. */
2044 if (hostlist == NULL || (ob->hosts_override && ob->hosts != NULL))
2046 if (ob->hosts == NULL)
2048 addrlist->message = string_sprintf("%s transport called with no hosts set",
2050 addrlist->transport_return = PANIC;
2051 return FALSE; /* Only top address has status */
2054 DEBUG(D_transport) debug_printf("using the transport's hosts: %s\n",
2057 /* If the transport's host list contains no '$' characters, and we are not
2058 randomizing, it is fixed and therefore a chain of hosts can be built once
2059 and for all, and remembered for subsequent use by other calls to this
2060 transport. If, on the other hand, the host list does contain '$', or we are
2061 randomizing its order, we have to rebuild it each time. In the fixed case,
2062 as the hosts string will never be used again, it doesn't matter that we
2063 replace all the : characters with zeros. */
2065 if (ob->hostlist == NULL)
2067 uschar *s = ob->hosts;
2069 if (Ustrchr(s, '$') != NULL)
2071 expanded_hosts = expand_string(s);
2072 if (expanded_hosts == NULL)
2074 addrlist->message = string_sprintf("failed to expand list of hosts "
2075 "\"%s\" in %s transport: %s", s, tblock->name, expand_string_message);
2076 addrlist->transport_return = search_find_defer? DEFER : PANIC;
2077 return FALSE; /* Only top address has status */
2079 DEBUG(D_transport) debug_printf("expanded list of hosts \"%s\" to "
2080 "\"%s\"\n", s, expanded_hosts);
2084 if (ob->hosts_randomize) s = expanded_hosts = string_copy(s);
2086 host_build_hostlist(&hostlist, s, ob->hosts_randomize);
2088 /* If there was no expansion of hosts, save the host list for
2091 if (expanded_hosts == NULL) ob->hostlist = hostlist;
2094 /* This is not the first time this transport has been run in this delivery;
2095 the host list was built previously. */
2097 else hostlist = ob->hostlist;
2100 /* The host list was supplied with the address. If hosts_randomize is set, we
2101 must sort it into a random order if it did not come from MX records and has not
2102 already been randomized (but don't bother if continuing down an existing
2105 else if (ob->hosts_randomize && hostlist->mx == MX_NONE && !continuing)
2107 host_item *newlist = NULL;
2108 while (hostlist != NULL)
2110 host_item *h = hostlist;
2111 hostlist = hostlist->next;
2113 h->sort_key = random_number(100);
2115 if (newlist == NULL)
2120 else if (h->sort_key < newlist->sort_key)
2127 host_item *hh = newlist;
2128 while (hh->next != NULL)
2130 if (h->sort_key < hh->next->sort_key) break;
2138 hostlist = addrlist->host_list = newlist;
2142 /* Sort out the default port. */
2144 if (!smtp_get_port(ob->port, addrlist, &port, tid)) return FALSE;
2147 /* For each host-plus-IP-address on the list:
2149 . If this is a continued delivery and the host isn't the one with the
2150 current connection, skip.
2152 . If the status is unusable (i.e. previously failed or retry checked), skip.
2154 . If no IP address set, get the address, either by turning the name into
2155 an address, calling gethostbyname if gethostbyname is on, or by calling
2156 the DNS. The DNS may yield multiple addresses, in which case insert the
2157 extra ones into the list.
2159 . Get the retry data if not previously obtained for this address and set the
2160 field which remembers the state of this address. Skip if the retry time is
2161 not reached. If not, remember whether retry data was found. The retry string
2162 contains both the name and the IP address.
2164 . Scan the list of addresses and mark those whose status is DEFER as
2165 PENDING_DEFER. These are the only ones that will be processed in this cycle
2168 . Make a delivery attempt - addresses marked PENDING_DEFER will be tried.
2169 Some addresses may be successfully delivered, others may fail, and yet
2170 others may get temporary errors and so get marked DEFER.
2172 . The return from the delivery attempt is OK if a connection was made and a
2173 valid SMTP dialogue was completed. Otherwise it is DEFER.
2175 . If OK, add a "remove" retry item for this host/IPaddress, if any.
2177 . If fail to connect, or other defer state, add a retry item.
2179 . If there are any addresses whose status is still DEFER, carry on to the
2180 next host/IPaddress, unless we have tried the number of hosts given
2181 by hosts_max_try or hosts_max_try_hardlimit; otherwise return. Note that
2182 there is some fancy logic for hosts_max_try that means its limit can be
2183 overstepped in some circumstances.
2185 If we get to the end of the list, all hosts have deferred at least one address,
2186 or not reached their retry times. If delay_after_cutoff is unset, it requests a
2187 delivery attempt to those hosts whose last try was before the arrival time of
2188 the current message. To cope with this, we have to go round the loop a second
2189 time. After that, set the status and error data for any addresses that haven't
2190 had it set already. */
2192 for (cutoff_retry = 0; expired &&
2193 cutoff_retry < ((ob->delay_after_cutoff)? 1 : 2);
2196 host_item *nexthost = NULL;
2197 int unexpired_hosts_tried = 0;
2199 for (host = hostlist;
2201 unexpired_hosts_tried < ob->hosts_max_try &&
2202 total_hosts_tried < ob->hosts_max_try_hardlimit;
2208 BOOL serialized = FALSE;
2209 BOOL host_is_expired = FALSE;
2210 BOOL message_defer = FALSE;
2211 BOOL ifchanges = FALSE;
2212 BOOL some_deferred = FALSE;
2213 address_item *first_addr = NULL;
2214 uschar *interface = NULL;
2215 uschar *retry_host_key = NULL;
2216 uschar *retry_message_key = NULL;
2217 uschar *serialize_key = NULL;
2219 /* Default next host is next host. :-) But this can vary if the
2220 hosts_max_try limit is hit (see below). It may also be reset if a host
2221 address is looked up here (in case the host was multihomed). */
2223 nexthost = host->next;
2225 /* Set the flag requesting that this host be added to the waiting
2226 database if the delivery fails temporarily or if we are running with
2227 queue_smtp or a 2-stage queue run. This gets unset for certain
2228 kinds of error, typically those that are specific to the message. */
2230 host->update_waiting = TRUE;
2232 /* If the address hasn't yet been obtained from the host name, look it up
2233 now, unless the host is already marked as unusable. If it is marked as
2234 unusable, it means that the router was unable to find its IP address (in
2235 the DNS or wherever) OR we are in the 2nd time round the cutoff loop, and
2236 the lookup failed last time. We don't get this far if *all* MX records
2237 point to non-existent hosts; that is treated as a hard error.
2239 We can just skip this host entirely. When the hosts came from the router,
2240 the address will timeout based on the other host(s); when the address is
2241 looked up below, there is an explicit retry record added.
2243 Note that we mustn't skip unusable hosts if the address is not unset; they
2244 may be needed as expired hosts on the 2nd time round the cutoff loop. */
2246 if (host->address == NULL)
2250 uschar *canonical_name;
2252 if (host->status >= hstatus_unusable)
2254 DEBUG(D_transport) debug_printf("%s has no address and is unusable - skipping\n",
2259 DEBUG(D_transport) debug_printf("getting address for %s\n", host->name);
2261 /* The host name is permitted to have an attached port. Find it, and
2262 strip it from the name. Just remember it for now. */
2264 new_port = host_item_get_port(host);
2266 /* Count hosts looked up */
2270 /* Find by name if so configured, or if it's an IP address. We don't
2271 just copy the IP address, because we need the test-for-local to happen. */
2273 if (ob->gethostbyname || string_is_ip_address(host->name, NULL) != 0)
2274 rc = host_find_byname(host, NULL, &canonical_name, TRUE);
2277 int flags = HOST_FIND_BY_A;
2278 if (ob->dns_qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
2279 if (ob->dns_search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
2280 rc = host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
2281 &canonical_name, NULL);
2284 /* Update the host (and any additional blocks, resulting from
2285 multihoming) with a host-specific port, if any. */
2287 for (hh = host; hh != nexthost; hh = hh->next) hh->port = new_port;
2289 /* Failure to find the host at this time (usually DNS temporary failure)
2290 is really a kind of routing failure rather than a transport failure.
2291 Therefore we add a retry item of the routing kind, not to stop us trying
2292 to look this name up here again, but to ensure the address gets timed
2293 out if the failures go on long enough. A complete failure at this point
2294 commonly points to a configuration error, but the best action is still
2295 to carry on for the next host. */
2297 if (rc == HOST_FIND_AGAIN || rc == HOST_FIND_FAILED)
2299 retry_add_item(addrlist, string_sprintf("R:%s", host->name), 0);
2301 if (rc == HOST_FIND_AGAIN) hosts_defer++; else hosts_fail++;
2302 DEBUG(D_transport) debug_printf("rc = %s for %s\n", (rc == HOST_FIND_AGAIN)?
2303 "HOST_FIND_AGAIN" : "HOST_FIND_FAILED", host->name);
2304 host->status = hstatus_unusable;
2306 for (addr = addrlist; addr != NULL; addr = addr->next)
2308 if (addr->transport_return != DEFER) continue;
2309 addr->basic_errno = ERRNO_UNKNOWNHOST;
2311 string_sprintf("failed to lookup IP address for %s", host->name);
2316 /* If the host is actually the local host, we may have a problem, or
2317 there may be some cunning configuration going on. In the problem case,
2318 log things and give up. The default transport status is already DEFER. */
2320 if (rc == HOST_FOUND_LOCAL && !ob->allow_localhost)
2322 for (addr = addrlist; addr != NULL; addr = addr->next)
2324 addr->basic_errno = 0;
2325 addr->message = string_sprintf("%s transport found host %s to be "
2326 "local", tblock->name, host->name);
2330 } /* End of block for IP address lookup */
2332 /* If this is a continued delivery, we are interested only in the host
2333 which matches the name of the existing open channel. The check is put
2334 here after the local host lookup, in case the name gets expanded as a
2335 result of the lookup. Set expired FALSE, to save the outer loop executing
2338 if (continuing && (Ustrcmp(continue_hostname, host->name) != 0 ||
2339 Ustrcmp(continue_host_address, host->address) != 0))
2342 continue; /* With next host */
2345 /* Reset the default next host in case a multihomed host whose addresses
2346 are not looked up till just above added to the host list. */
2348 nexthost = host->next;
2350 /* If queue_smtp is set (-odqs or the first part of a 2-stage run), or the
2351 domain is in queue_smtp_domains, we don't actually want to attempt any
2352 deliveries. When doing a queue run, queue_smtp_domains is always unset. If
2353 there is a lookup defer in queue_smtp_domains, proceed as if the domain
2354 were not in it. We don't want to hold up all SMTP deliveries! Except when
2355 doing a two-stage queue run, don't do this if forcing. */
2357 if ((!deliver_force || queue_2stage) && (queue_smtp ||
2358 match_isinlist(addrlist->domain, &queue_smtp_domains, 0,
2359 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK))
2362 for (addr = addrlist; addr != NULL; addr = addr->next)
2364 if (addr->transport_return != DEFER) continue;
2365 addr->message = US"domain matches queue_smtp_domains, or -odqs set";
2367 continue; /* With next host */
2370 /* Count hosts being considered - purely for an intelligent comment
2371 if none are usable. */
2375 /* Set $host and $host address now in case they are needed for the
2376 interface expansion or the serialize_hosts check; they remain set if an
2377 actual delivery happens. */
2379 deliver_host = host->name;
2380 deliver_host_address = host->address;
2382 /* Set up a string for adding to the retry key if the port number is not
2383 the standard SMTP port. A host may have its own port setting that overrides
2386 pistring = string_sprintf(":%d", (host->port == PORT_NONE)?
2388 if (Ustrcmp(pistring, ":25") == 0) pistring = US"";
2390 /* Select IPv4 or IPv6, and choose an outgoing interface. If the interface
2391 string changes upon expansion, we must add it to the key that is used for
2392 retries, because connections to the same host from a different interface
2393 should be treated separately. */
2395 host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET : AF_INET6;
2396 if (!smtp_get_interface(ob->interface, host_af, addrlist, &ifchanges,
2399 if (ifchanges) pistring = string_sprintf("%s/%s", pistring, interface);
2401 /* The first time round the outer loop, check the status of the host by
2402 inspecting the retry data. The second time round, we are interested only
2403 in expired hosts that haven't been tried since this message arrived. */
2405 if (cutoff_retry == 0)
2407 /* Ensure the status of the address is set by checking retry data if
2408 necessary. There maybe host-specific retry data (applicable to all
2409 messages) and also data for retries of a specific message at this host.
2410 If either of these retry records are actually read, the keys used are
2411 returned to save recomputing them later. */
2413 host_is_expired = retry_check_address(addrlist->domain, host, pistring,
2414 ob->retry_include_ip_address, &retry_host_key, &retry_message_key);
2416 DEBUG(D_transport) debug_printf("%s [%s]%s status = %s\n", host->name,
2417 (host->address == NULL)? US"" : host->address, pistring,
2418 (host->status == hstatus_usable)? "usable" :
2419 (host->status == hstatus_unusable)? "unusable" :
2420 (host->status == hstatus_unusable_expired)? "unusable (expired)" : "?");
2422 /* Skip this address if not usable at this time, noting if it wasn't
2423 actually expired, both locally and in the address. */
2425 switch (host->status)
2427 case hstatus_unusable:
2429 setflag(addrlist, af_retry_skipped);
2432 case hstatus_unusable_expired:
2435 case hwhy_retry: hosts_retry++; break;
2436 case hwhy_failed: hosts_fail++; break;
2437 case hwhy_deferred: hosts_defer++; break;
2440 /* If there was a retry message key, implying that previously there
2441 was a message-specific defer, we don't want to update the list of
2442 messages waiting for this host. */
2444 if (retry_message_key != NULL) host->update_waiting = FALSE;
2445 continue; /* With the next host or IP address */
2449 /* Second time round the loop: if the address is set but expired, and
2450 the message is newer than the last try, let it through. */
2454 if (host->address == NULL ||
2455 host->status != hstatus_unusable_expired ||
2456 host->last_try > received_time)
2459 debug_printf("trying expired host %s [%s]%s\n",
2460 host->name, host->address, pistring);
2461 host_is_expired = TRUE;
2464 /* Setting "expired=FALSE" doesn't actually mean not all hosts are expired;
2465 it remains TRUE only if all hosts are expired and none are actually tried.
2470 /* If this host is listed as one to which access must be serialized,
2471 see if another Exim process has a connection to it, and if so, skip
2472 this host. If not, update the database to record our connection to it
2473 and remember this for later deletion. Do not do any of this if we are
2474 sending the message down a pre-existing connection. */
2477 verify_check_this_host(&(ob->serialize_hosts), NULL, host->name,
2478 host->address, NULL) == OK)
2480 serialize_key = string_sprintf("host-serialize-%s", host->name);
2481 if (!enq_start(serialize_key))
2484 debug_printf("skipping host %s because another Exim process "
2485 "is connected to it\n", host->name);
2492 /* OK, we have an IP address that is not waiting for its retry time to
2493 arrive (it might be expired) OR (second time round the loop) we have an
2494 expired host that hasn't been tried since the message arrived. Have a go
2495 at delivering the message to it. First prepare the addresses by flushing
2496 out the result of previous attempts, and finding the first address that
2497 is still to be delivered. */
2499 first_addr = prepare_addresses(addrlist, host);
2501 DEBUG(D_transport) debug_printf("delivering %s to %s [%s] (%s%s)\n",
2502 message_id, host->name, host->address, addrlist->address,
2503 (addrlist->next == NULL)? "" : ", ...");
2505 set_process_info("delivering %s to %s [%s] (%s%s)",
2506 message_id, host->name, host->address, addrlist->address,
2507 (addrlist->next == NULL)? "" : ", ...");
2509 /* This is not for real; don't do the delivery. If there are
2510 any remaining hosts, list them. */
2515 set_errno(addrlist, 0, NULL, OK, FALSE);
2516 for (addr = addrlist; addr != NULL; addr = addr->next)
2518 addr->host_used = host;
2519 addr->special_action = '*';
2520 addr->message = US"delivery bypassed by -N option";
2524 debug_printf("*** delivery by %s transport bypassed by -N option\n"
2525 "*** host and remaining hosts:\n", tblock->name);
2526 for (host2 = host; host2 != NULL; host2 = host2->next)
2527 debug_printf(" %s [%s]\n", host2->name,
2528 (host2->address == NULL)? US"unset" : host2->address);
2533 /* This is for real. If the host is expired, we don't count it for
2534 hosts_max_retry. This ensures that all hosts must expire before an address
2535 is timed out, unless hosts_max_try_hardlimit (which protects against
2536 lunatic DNS configurations) is reached.
2538 If the host is not expired and we are about to hit the hosts_max_retry
2539 limit, check to see if there is a subsequent hosts with a different MX
2540 value. If so, make that the next host, and don't count this one. This is a
2541 heuristic to make sure that different MXs do get tried. With a normal kind
2542 of retry rule, they would get tried anyway when the earlier hosts were
2543 delayed, but if the domain has a "retry every time" type of rule - as is
2544 often used for the the very large ISPs, that won't happen. */
2548 if (!host_is_expired && ++unexpired_hosts_tried >= ob->hosts_max_try)
2552 debug_printf("hosts_max_try limit reached with this host\n");
2553 for (h = host; h != NULL; h = h->next)
2554 if (h->mx != host->mx) break;
2558 unexpired_hosts_tried--;
2559 DEBUG(D_transport) debug_printf("however, a higher MX host exists "
2560 "and will be tried\n");
2564 /* Attempt the delivery. */
2566 total_hosts_tried++;
2567 rc = smtp_deliver(addrlist, host, host_af, port, interface, tblock,
2568 expanded_hosts != NULL, &message_defer, FALSE);
2571 OK => connection made, each address contains its result;
2572 message_defer is set for message-specific defers (when all
2573 recipients are marked defer)
2574 DEFER => there was a non-message-specific delivery problem;
2575 ERROR => there was a problem setting up the arguments for a filter,
2576 or there was a problem with expanding added headers
2579 /* If the result is not OK, there was a non-message-specific problem.
2580 If the result is DEFER, we need to write to the logs saying what happened
2581 for this particular host, except in the case of authentication and TLS
2582 failures, where the log has already been written. If all hosts defer a
2583 general message is written at the end. */
2585 if (rc == DEFER && first_addr->basic_errno != ERRNO_AUTHFAIL &&
2586 first_addr->basic_errno != ERRNO_TLSFAILURE)
2587 write_logs(first_addr, host);
2589 /* If STARTTLS was accepted, but there was a failure in setting up the
2590 TLS session (usually a certificate screwup), and the host is not in
2591 hosts_require_tls, and tls_tempfail_tryclear is true, try again, with
2592 TLS forcibly turned off. We have to start from scratch with a new SMTP
2593 connection. That's why the retry is done from here, not from within
2594 smtp_deliver(). [Rejections of STARTTLS itself don't screw up the
2595 session, so the in-clear transmission after those errors, if permitted,
2596 happens inside smtp_deliver().] */
2599 if (rc == DEFER && first_addr->basic_errno == ERRNO_TLSFAILURE &&
2600 ob->tls_tempfail_tryclear &&
2601 verify_check_this_host(&(ob->hosts_require_tls), NULL, host->name,
2602 host->address, NULL) != OK)
2604 log_write(0, LOG_MAIN, "TLS session failure: delivering unencrypted "
2605 "to %s [%s] (not in hosts_require_tls)", host->name, host->address);
2606 first_addr = prepare_addresses(addrlist, host);
2607 rc = smtp_deliver(addrlist, host, host_af, port, interface, tblock,
2608 expanded_hosts != NULL, &message_defer, TRUE);
2609 if (rc == DEFER && first_addr->basic_errno != ERRNO_AUTHFAIL)
2610 write_logs(first_addr, host);
2615 /* Delivery attempt finished */
2617 rs = (rc == OK)? US"OK" : (rc == DEFER)? US"DEFER" : (rc == ERROR)?
2620 set_process_info("delivering %s: just tried %s [%s] for %s%s: result %s",
2621 message_id, host->name, host->address, addrlist->address,
2622 (addrlist->next == NULL)? "" : " (& others)", rs);
2624 /* Release serialization if set up */
2626 if (serialized) enq_end(serialize_key);
2628 /* If the result is DEFER, or if a host retry record is known to exist, we
2629 need to add an item to the retry chain for updating the retry database
2630 at the end of delivery. We only need to add the item to the top address,
2631 of course. Also, if DEFER, we mark the IP address unusable so as to skip it
2632 for any other delivery attempts using the same address. (It is copied into
2633 the unusable tree at the outer level, so even if different address blocks
2634 contain the same address, it still won't get tried again.) */
2636 if (rc == DEFER || retry_host_key != NULL)
2638 int delete_flag = (rc != DEFER)? rf_delete : 0;
2639 if (retry_host_key == NULL)
2641 retry_host_key = ob->retry_include_ip_address?
2642 string_sprintf("T:%S:%s%s", host->name, host->address, pistring) :
2643 string_sprintf("T:%S%s", host->name, pistring);
2646 /* If a delivery of another message over an existing SMTP connection
2647 yields DEFER, we do NOT set up retry data for the host. This covers the
2648 case when there are delays in routing the addresses in the second message
2649 that are so long that the server times out. This is alleviated by not
2650 routing addresses that previously had routing defers when handling an
2651 existing connection, but even so, this case may occur (e.g. if a
2652 previously happily routed address starts giving routing defers). If the
2653 host is genuinely down, another non-continued message delivery will
2654 notice it soon enough. */
2656 if (delete_flag != 0 || !continuing)
2657 retry_add_item(first_addr, retry_host_key, rf_host | delete_flag);
2659 /* We may have tried an expired host, if its retry time has come; ensure
2660 the status reflects the expiry for the benefit of any other addresses. */
2664 host->status = (host_is_expired)?
2665 hstatus_unusable_expired : hstatus_unusable;
2666 host->why = hwhy_deferred;
2670 /* If message_defer is set (host was OK, but every recipient got deferred
2671 because of some message-specific problem), or if that had happened
2672 previously so that a message retry key exists, add an appropriate item
2673 to the retry chain. Note that if there was a message defer but now there is
2674 a host defer, the message defer record gets deleted. That seems perfectly
2675 reasonable. Also, stop the message from being remembered as waiting
2678 if (message_defer || retry_message_key != NULL)
2680 int delete_flag = message_defer? 0 : rf_delete;
2681 if (retry_message_key == NULL)
2683 retry_message_key = ob->retry_include_ip_address?
2684 string_sprintf("T:%S:%s%s:%s", host->name, host->address, pistring,
2686 string_sprintf("T:%S%s:%s", host->name, pistring, message_id);
2688 retry_add_item(addrlist, retry_message_key,
2689 rf_message | rf_host | delete_flag);
2690 host->update_waiting = FALSE;
2693 /* Any return other than DEFER (that is, OK or ERROR) means that the
2694 addresses have got their final statuses filled in for this host. In the OK
2695 case, see if any of them are deferred. */
2699 for (addr = addrlist; addr != NULL; addr = addr->next)
2701 if (addr->transport_return == DEFER)
2703 some_deferred = TRUE;
2709 /* If no addresses deferred or the result was ERROR, return. We do this for
2710 ERROR because a failing filter set-up or add_headers expansion is likely to
2711 fail for any host we try. */
2713 if (rc == ERROR || (rc == OK && !some_deferred))
2715 DEBUG(D_transport) debug_printf("Leaving %s transport\n", tblock->name);
2716 return TRUE; /* Each address has its status */
2719 /* If the result was DEFER or some individual addresses deferred, let
2720 the loop run to try other hosts with the deferred addresses, except for the
2721 case when we were trying to deliver down an existing channel and failed.
2722 Don't try any other hosts in this case. */
2724 if (continuing) break;
2726 /* If the whole delivery, or some individual addresses, were deferred and
2727 there are more hosts that could be tried, do not count this host towards
2728 the hosts_max_try limit if the age of the message is greater than the
2729 maximum retry time for this host. This means we may try try all hosts,
2730 ignoring the limit, when messages have been around for some time. This is
2731 important because if we don't try all hosts, the address will never time
2732 out. NOTE: this does not apply to hosts_max_try_hardlimit. */
2734 if ((rc == DEFER || some_deferred) && nexthost != NULL)
2737 retry_config *retry = retry_find_config(host->name, NULL, 0, 0);
2739 if (retry != NULL && retry->rules != NULL)
2741 retry_rule *last_rule;
2742 for (last_rule = retry->rules;
2743 last_rule->next != NULL;
2744 last_rule = last_rule->next);
2745 timedout = time(NULL) - received_time > last_rule->timeout;
2747 else timedout = TRUE; /* No rule => timed out */
2751 unexpired_hosts_tried--;
2752 DEBUG(D_transport) debug_printf("temporary delivery error(s) override "
2753 "hosts_max_try (message older than host's retry time)\n");
2756 } /* End of loop for trying multiple hosts. */
2758 /* This is the end of the loop that repeats iff expired is TRUE and
2759 ob->delay_after_cutoff is FALSE. The second time round we will
2760 try those hosts that haven't been tried since the message arrived. */
2764 debug_printf("all IP addresses skipped or deferred at least one address\n");
2765 if (expired && !ob->delay_after_cutoff && cutoff_retry == 0)
2766 debug_printf("retrying IP addresses not tried since message arrived\n");
2771 /* Get here if all IP addresses are skipped or defer at least one address. In
2772 MUA wrapper mode, this will happen only for connection or other non-message-
2773 specific failures. Force the delivery status for all addresses to FAIL. */
2777 for (addr = addrlist; addr != NULL; addr = addr->next)
2778 addr->transport_return = FAIL;
2782 /* In the normal, non-wrapper case, add a standard message to each deferred
2783 address if there hasn't been an error, that is, if it hasn't actually been
2784 tried this time. The variable "expired" will be FALSE if any deliveries were
2785 actually tried, or if there was at least one host that was not expired. That
2786 is, it is TRUE only if no deliveries were tried and all hosts were expired. If
2787 a delivery has been tried, an error code will be set, and the failing of the
2788 message is handled by the retry code later.
2790 If queue_smtp is set, or this transport was called to send a subsequent message
2791 down an existing TCP/IP connection, and something caused the host not to be
2792 found, we end up here, but can detect these cases and handle them specially. */
2794 for (addr = addrlist; addr != NULL; addr = addr->next)
2796 /* If host is not NULL, it means that we stopped processing the host list
2797 because of hosts_max_try or hosts_max_try_hardlimit. In the former case, this
2798 means we need to behave as if some hosts were skipped because their retry
2799 time had not come. Specifically, this prevents the address from timing out.
2800 However, if we have hit hosts_max_try_hardlimit, we want to behave as if all
2801 hosts were tried. */
2805 if (total_hosts_tried >= ob->hosts_max_try_hardlimit)
2808 debug_printf("hosts_max_try_hardlimit reached: behave as if all "
2809 "hosts were tried\n");
2814 debug_printf("hosts_max_try limit caused some hosts to be skipped\n");
2815 setflag(addr, af_retry_skipped);
2819 if (queue_smtp) /* no deliveries attempted */
2821 addr->transport_return = DEFER;
2822 addr->basic_errno = 0;
2823 addr->message = US"SMTP delivery explicitly queued";
2826 else if (addr->transport_return == DEFER &&
2827 (addr->basic_errno == ERRNO_UNKNOWNERROR || addr->basic_errno == 0) &&
2828 addr->message == NULL)
2830 addr->basic_errno = ERRNO_HRETRY;
2831 if (continue_hostname != NULL)
2833 addr->message = US"no host found for existing SMTP connection";
2837 setflag(addr, af_pass_message); /* This is not a security risk */
2838 addr->message = (ob->delay_after_cutoff)?
2839 US"retry time not reached for any host after a long failure period" :
2840 US"all hosts have been failing for a long time and were last tried "
2841 "after this message arrived";
2843 /* If we are already using fallback hosts, or there are no fallback hosts
2844 defined, convert the result to FAIL to cause a bounce. */
2846 if (addr->host_list == addr->fallback_hosts ||
2847 addr->fallback_hosts == NULL)
2848 addr->transport_return = FAIL;
2852 if (hosts_retry == hosts_total)
2853 addr->message = US"retry time not reached for any host";
2854 else if (hosts_fail == hosts_total)
2855 addr->message = US"all host address lookups failed permanently";
2856 else if (hosts_defer == hosts_total)
2857 addr->message = US"all host address lookups failed temporarily";
2858 else if (hosts_serial == hosts_total)
2859 addr->message = US"connection limit reached for all hosts";
2860 else if (hosts_fail+hosts_defer == hosts_total)
2861 addr->message = US"all host address lookups failed";
2862 else addr->message = US"some host address lookups failed and retry time "
2863 "not reached for other hosts or connection limit reached";
2868 /* Update the database which keeps information about which messages are waiting
2869 for which hosts to become available. Each host in the list has a flag which is
2870 set if the data is to be updated. For some message-specific errors, the flag is
2871 turned off because we don't want follow-on deliveries in those cases. */
2873 transport_update_waiting(hostlist, tblock->name);
2877 DEBUG(D_transport) debug_printf("Leaving %s transport\n", tblock->name);
2879 return TRUE; /* Each address has its status */
2882 /* End of transport/smtp.c */