ac24f5f09ab3a4a0e4b82ec49855f3551cd455b4
[users/jgh/exim.git] / src / src / transports / smtp.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2012 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8 #include "../exim.h"
9 #include "smtp.h"
10
11 #define PENDING          256
12 #define PENDING_DEFER   (PENDING + DEFER)
13 #define PENDING_OK      (PENDING + OK)
14
15
16 /* Options specific to the smtp transport. This transport also supports LMTP
17 over TCP/IP. The options must be in alphabetic order (note that "_" comes
18 before the lower case letters). Some live in the transport_instance block so as
19 to be publicly visible; these are flagged with opt_public. */
20
21 optionlist smtp_transport_options[] = {
22   { "address_retry_include_sender", opt_bool,
23       (void *)offsetof(smtp_transport_options_block, address_retry_include_sender) },
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   { "authenticated_sender_force", opt_bool,
29       (void *)offsetof(smtp_transport_options_block, authenticated_sender_force) },
30   { "command_timeout",      opt_time,
31       (void *)offsetof(smtp_transport_options_block, command_timeout) },
32   { "connect_timeout",      opt_time,
33       (void *)offsetof(smtp_transport_options_block, connect_timeout) },
34   { "connection_max_messages", opt_int | opt_public,
35       (void *)offsetof(transport_instance, connection_max_messages) },
36   { "data_timeout",         opt_time,
37       (void *)offsetof(smtp_transport_options_block, data_timeout) },
38 #ifdef EXPERIMENTAL_DBL
39   { "dbl_host_defer_query",      opt_stringptr,
40           (void *)offsetof(smtp_transport_options_block, dbl_host_defer_query) },
41 #endif
42   { "delay_after_cutoff", opt_bool,
43       (void *)offsetof(smtp_transport_options_block, delay_after_cutoff) },
44 #ifndef DISABLE_DKIM
45   { "dkim_canon", opt_stringptr,
46       (void *)offsetof(smtp_transport_options_block, dkim_canon) },
47   { "dkim_domain", opt_stringptr,
48       (void *)offsetof(smtp_transport_options_block, dkim_domain) },
49   { "dkim_private_key", opt_stringptr,
50       (void *)offsetof(smtp_transport_options_block, dkim_private_key) },
51   { "dkim_selector", opt_stringptr,
52       (void *)offsetof(smtp_transport_options_block, dkim_selector) },
53   { "dkim_sign_headers", opt_stringptr,
54       (void *)offsetof(smtp_transport_options_block, dkim_sign_headers) },
55   { "dkim_strict", opt_stringptr,
56       (void *)offsetof(smtp_transport_options_block, dkim_strict) },
57 #endif
58   { "dns_qualify_single",   opt_bool,
59       (void *)offsetof(smtp_transport_options_block, dns_qualify_single) },
60   { "dns_search_parents",   opt_bool,
61       (void *)offsetof(smtp_transport_options_block, dns_search_parents) },
62   { "dscp",                 opt_stringptr,
63       (void *)offsetof(smtp_transport_options_block, dscp) },
64   { "fallback_hosts",       opt_stringptr,
65       (void *)offsetof(smtp_transport_options_block, fallback_hosts) },
66   { "final_timeout",        opt_time,
67       (void *)offsetof(smtp_transport_options_block, final_timeout) },
68   { "gethostbyname",        opt_bool,
69       (void *)offsetof(smtp_transport_options_block, gethostbyname) },
70 #ifdef SUPPORT_TLS
71   /* These are no longer honoured, as of Exim 4.80; for now, we silently
72   ignore; a later release will warn, and a later-still release will remove
73   these options, so that using them becomes an error. */
74   { "gnutls_require_kx",    opt_stringptr,
75       (void *)offsetof(smtp_transport_options_block, gnutls_require_kx) },
76   { "gnutls_require_mac",   opt_stringptr,
77       (void *)offsetof(smtp_transport_options_block, gnutls_require_mac) },
78   { "gnutls_require_protocols", opt_stringptr,
79       (void *)offsetof(smtp_transport_options_block, gnutls_require_proto) },
80 #endif
81   { "helo_data",            opt_stringptr,
82       (void *)offsetof(smtp_transport_options_block, helo_data) },
83   { "hosts",                opt_stringptr,
84       (void *)offsetof(smtp_transport_options_block, hosts) },
85   { "hosts_avoid_esmtp",    opt_stringptr,
86       (void *)offsetof(smtp_transport_options_block, hosts_avoid_esmtp) },
87   { "hosts_avoid_pipelining", opt_stringptr,
88       (void *)offsetof(smtp_transport_options_block, hosts_avoid_pipelining) },
89 #ifdef SUPPORT_TLS
90   { "hosts_avoid_tls",      opt_stringptr,
91       (void *)offsetof(smtp_transport_options_block, hosts_avoid_tls) },
92 #endif
93   { "hosts_max_try",        opt_int,
94       (void *)offsetof(smtp_transport_options_block, hosts_max_try) },
95   { "hosts_max_try_hardlimit", opt_int,
96       (void *)offsetof(smtp_transport_options_block, hosts_max_try_hardlimit) },
97 #ifdef SUPPORT_TLS
98   { "hosts_nopass_tls",     opt_stringptr,
99       (void *)offsetof(smtp_transport_options_block, hosts_nopass_tls) },
100 #endif
101   { "hosts_override",       opt_bool,
102       (void *)offsetof(smtp_transport_options_block, hosts_override) },
103   { "hosts_randomize",      opt_bool,
104       (void *)offsetof(smtp_transport_options_block, hosts_randomize) },
105   { "hosts_require_auth",   opt_stringptr,
106       (void *)offsetof(smtp_transport_options_block, hosts_require_auth) },
107 #ifdef SUPPORT_TLS
108 # if defined EXPERIMENTAL_OCSP
109   { "hosts_require_ocsp",   opt_stringptr,
110       (void *)offsetof(smtp_transport_options_block, hosts_require_ocsp) },
111 # endif
112   { "hosts_require_tls",    opt_stringptr,
113       (void *)offsetof(smtp_transport_options_block, hosts_require_tls) },
114 #endif
115   { "hosts_try_auth",       opt_stringptr,
116       (void *)offsetof(smtp_transport_options_block, hosts_try_auth) },
117 #ifdef EXPERIMENTAL_PRDR
118   { "hosts_try_prdr",       opt_stringptr,
119       (void *)offsetof(smtp_transport_options_block, hosts_try_prdr) },
120 #endif
121 #ifdef SUPPORT_TLS
122   { "hosts_verify_avoid_tls", opt_stringptr,
123       (void *)offsetof(smtp_transport_options_block, hosts_verify_avoid_tls) },
124 #endif
125   { "interface",            opt_stringptr,
126       (void *)offsetof(smtp_transport_options_block, interface) },
127   { "keepalive",            opt_bool,
128       (void *)offsetof(smtp_transport_options_block, keepalive) },
129   { "lmtp_ignore_quota",    opt_bool,
130       (void *)offsetof(smtp_transport_options_block, lmtp_ignore_quota) },
131   { "max_rcpt",             opt_int | opt_public,
132       (void *)offsetof(transport_instance, max_addresses) },
133   { "multi_domain",         opt_bool | opt_public,
134       (void *)offsetof(transport_instance, multi_domain) },
135   { "port",                 opt_stringptr,
136       (void *)offsetof(smtp_transport_options_block, port) },
137   { "protocol",             opt_stringptr,
138       (void *)offsetof(smtp_transport_options_block, protocol) },
139   { "retry_include_ip_address", opt_bool,
140       (void *)offsetof(smtp_transport_options_block, retry_include_ip_address) },
141   { "serialize_hosts",      opt_stringptr,
142       (void *)offsetof(smtp_transport_options_block, serialize_hosts) },
143   { "size_addition",        opt_int,
144       (void *)offsetof(smtp_transport_options_block, size_addition) }
145 #ifdef SUPPORT_TLS
146  ,{ "tls_certificate",      opt_stringptr,
147       (void *)offsetof(smtp_transport_options_block, tls_certificate) },
148   { "tls_crl",              opt_stringptr,
149       (void *)offsetof(smtp_transport_options_block, tls_crl) },
150   { "tls_dh_min_bits",      opt_int,
151       (void *)offsetof(smtp_transport_options_block, tls_dh_min_bits) },
152   { "tls_privatekey",       opt_stringptr,
153       (void *)offsetof(smtp_transport_options_block, tls_privatekey) },
154   { "tls_require_ciphers",  opt_stringptr,
155       (void *)offsetof(smtp_transport_options_block, tls_require_ciphers) },
156   { "tls_sni",              opt_stringptr,
157       (void *)offsetof(smtp_transport_options_block, tls_sni) },
158   { "tls_tempfail_tryclear", opt_bool,
159       (void *)offsetof(smtp_transport_options_block, tls_tempfail_tryclear) },
160   { "tls_verify_certificates", opt_stringptr,
161       (void *)offsetof(smtp_transport_options_block, tls_verify_certificates) }
162 #endif
163 };
164
165 /* Size of the options list. An extern variable has to be used so that its
166 address can appear in the tables drtables.c. */
167
168 int smtp_transport_options_count =
169   sizeof(smtp_transport_options)/sizeof(optionlist);
170
171 /* Default private options block for the smtp transport. */
172
173 smtp_transport_options_block smtp_transport_option_defaults = {
174   NULL,                /* hosts */
175   NULL,                /* fallback_hosts */
176   NULL,                /* hostlist */
177   NULL,                /* fallback_hostlist */
178   NULL,                /* authenticated_sender */
179   US"$primary_hostname", /* helo_data */
180   NULL,                /* interface */
181   NULL,                /* port */
182   US"smtp",            /* protocol */
183   NULL,                /* DSCP */
184   NULL,                /* serialize_hosts */
185   NULL,                /* hosts_try_auth */
186   NULL,                /* hosts_require_auth */
187 #ifdef EXPERIMENTAL_PRDR
188   NULL,                /* hosts_try_prdr */
189 #endif
190 #ifdef EXPERIMENTAL_OCSP
191   NULL,                /* hosts_require_ocsp */
192 #endif
193   NULL,                /* hosts_require_tls */
194   NULL,                /* hosts_avoid_tls */
195   US"*",               /* hosts_verify_avoid_tls */
196   NULL,                /* hosts_avoid_pipelining */
197   NULL,                /* hosts_avoid_esmtp */
198   NULL,                /* hosts_nopass_tls */
199   5*60,                /* command_timeout */
200   5*60,                /* connect_timeout; shorter system default overrides */
201   5*60,                /* data timeout */
202   10*60,               /* final timeout */
203   1024,                /* size_addition */
204   5,                   /* hosts_max_try */
205   50,                  /* hosts_max_try_hardlimit */
206   TRUE,                /* address_retry_include_sender */
207   FALSE,               /* allow_localhost */
208   FALSE,               /* authenticated_sender_force */
209   FALSE,               /* gethostbyname */
210   TRUE,                /* dns_qualify_single */
211   FALSE,               /* dns_search_parents */
212   TRUE,                /* delay_after_cutoff */
213   FALSE,               /* hosts_override */
214   FALSE,               /* hosts_randomize */
215   TRUE,                /* keepalive */
216   FALSE,               /* lmtp_ignore_quota */
217   TRUE                 /* retry_include_ip_address */
218 #ifdef SUPPORT_TLS
219  ,NULL,                /* tls_certificate */
220   NULL,                /* tls_crl */
221   NULL,                /* tls_privatekey */
222   NULL,                /* tls_require_ciphers */
223   NULL,                /* gnutls_require_kx */
224   NULL,                /* gnutls_require_mac */
225   NULL,                /* gnutls_require_proto */
226   NULL,                /* tls_sni */
227   NULL,                /* tls_verify_certificates */
228   EXIM_CLIENT_DH_DEFAULT_MIN_BITS,
229                        /* tls_dh_min_bits */
230   TRUE                 /* tls_tempfail_tryclear */
231 #endif
232 #ifndef DISABLE_DKIM
233  ,NULL,                /* dkim_canon */
234   NULL,                /* dkim_domain */
235   NULL,                /* dkim_private_key */
236   NULL,                /* dkim_selector */
237   NULL,                /* dkim_sign_headers */
238   NULL                 /* dkim_strict */
239 #endif
240 #ifdef EXPERIMENTAL_DBL
241  ,NULL                 /* dbl_host_defer_query */
242 #endif
243 };
244
245
246 /* Local statics */
247
248 static uschar *smtp_command;   /* Points to last cmd for error messages */
249 static uschar *mail_command;   /* Points to MAIL cmd for error messages */
250 static BOOL    update_waiting; /* TRUE to update the "wait" database */
251
252
253 /*************************************************
254 *             Setup entry point                  *
255 *************************************************/
256
257 /* This function is called when the transport is about to be used,
258 but before running it in a sub-process. It is used for two things:
259
260   (1) To set the fallback host list in addresses, when delivering.
261   (2) To pass back the interface, port, protocol, and other options, for use
262       during callout verification.
263
264 Arguments:
265   tblock    pointer to the transport instance block
266   addrlist  list of addresses about to be transported
267   tf        if not NULL, pointer to block in which to return options
268   uid       the uid that will be set (not used)
269   gid       the gid that will be set (not used)
270   errmsg    place for error message (not used)
271
272 Returns:  OK always (FAIL, DEFER not used)
273 */
274
275 static int
276 smtp_transport_setup(transport_instance *tblock, address_item *addrlist,
277   transport_feedback *tf, uid_t uid, gid_t gid, uschar **errmsg)
278 {
279 smtp_transport_options_block *ob =
280   (smtp_transport_options_block *)(tblock->options_block);
281
282 errmsg = errmsg;    /* Keep picky compilers happy */
283 uid = uid;
284 gid = gid;
285
286 /* Pass back options if required. This interface is getting very messy. */
287
288 if (tf != NULL)
289   {
290   tf->interface = ob->interface;
291   tf->port = ob->port;
292   tf->protocol = ob->protocol;
293   tf->hosts = ob->hosts;
294   tf->hosts_override = ob->hosts_override;
295   tf->hosts_randomize = ob->hosts_randomize;
296   tf->gethostbyname = ob->gethostbyname;
297   tf->qualify_single = ob->dns_qualify_single;
298   tf->search_parents = ob->dns_search_parents;
299   tf->helo_data = ob->helo_data;
300   }
301
302 /* Set the fallback host list for all the addresses that don't have fallback
303 host lists, provided that the local host wasn't present in the original host
304 list. */
305
306 if (!testflag(addrlist, af_local_host_removed))
307   {
308   for (; addrlist != NULL; addrlist = addrlist->next)
309     if (addrlist->fallback_hosts == NULL)
310       addrlist->fallback_hosts = ob->fallback_hostlist;
311   }
312
313 return OK;
314 }
315
316
317
318 /*************************************************
319 *          Initialization entry point            *
320 *************************************************/
321
322 /* Called for each instance, after its options have been read, to
323 enable consistency checks to be done, or anything else that needs
324 to be set up.
325
326 Argument:   pointer to the transport instance block
327 Returns:    nothing
328 */
329
330 void
331 smtp_transport_init(transport_instance *tblock)
332 {
333 smtp_transport_options_block *ob =
334   (smtp_transport_options_block *)(tblock->options_block);
335
336 /* Retry_use_local_part defaults FALSE if unset */
337
338 if (tblock->retry_use_local_part == TRUE_UNSET)
339   tblock->retry_use_local_part = FALSE;
340
341 /* Set the default port according to the protocol */
342
343 if (ob->port == NULL)
344   ob->port = (strcmpic(ob->protocol, US"lmtp") == 0)? US"lmtp" :
345     (strcmpic(ob->protocol, US"smtps") == 0)? US"smtps" : US"smtp";
346
347 /* Set up the setup entry point, to be called before subprocesses for this
348 transport. */
349
350 tblock->setup = smtp_transport_setup;
351
352 /* Complain if any of the timeouts are zero. */
353
354 if (ob->command_timeout <= 0 || ob->data_timeout <= 0 ||
355     ob->final_timeout <= 0)
356   log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
357     "command, data, or final timeout value is zero for %s transport",
358       tblock->name);
359
360 /* If hosts_override is set and there are local hosts, set the global
361 flag that stops verify from showing router hosts. */
362
363 if (ob->hosts_override && ob->hosts != NULL) tblock->overrides_hosts = TRUE;
364
365 /* If there are any fallback hosts listed, build a chain of host items
366 for them, but do not do any lookups at this time. */
367
368 host_build_hostlist(&(ob->fallback_hostlist), ob->fallback_hosts, FALSE);
369 }
370
371
372
373
374
375 /*************************************************
376 *   Set delivery info into all active addresses  *
377 *************************************************/
378
379 /* Only addresses whose status is >= PENDING are relevant. A lesser
380 status means that an address is not currently being processed.
381
382 Arguments:
383   addrlist       points to a chain of addresses
384   errno_value    to put in each address's errno field
385   msg            to put in each address's message field
386   rc             to put in each address's transport_return field
387   pass_message   if TRUE, set the "pass message" flag in the address
388
389 If errno_value has the special value ERRNO_CONNECTTIMEOUT, ETIMEDOUT is put in
390 the errno field, and RTEF_CTOUT is ORed into the more_errno field, to indicate
391 this particular type of timeout.
392
393 Returns:       nothing
394 */
395
396 static void
397 set_errno(address_item *addrlist, int errno_value, uschar *msg, int rc,
398   BOOL pass_message)
399 {
400 address_item *addr;
401 int orvalue = 0;
402 if (errno_value == ERRNO_CONNECTTIMEOUT)
403   {
404   errno_value = ETIMEDOUT;
405   orvalue = RTEF_CTOUT;
406   }
407 for (addr = addrlist; addr != NULL; addr = addr->next)
408   {
409   if (addr->transport_return < PENDING) continue;
410   addr->basic_errno = errno_value;
411   addr->more_errno |= orvalue;
412   if (msg != NULL)
413     {
414     addr->message = msg;
415     if (pass_message) setflag(addr, af_pass_message);
416     }
417   addr->transport_return = rc;
418   }
419 }
420
421
422
423 /*************************************************
424 *          Check an SMTP response                *
425 *************************************************/
426
427 /* This function is given an errno code and the SMTP response buffer
428 to analyse, together with the host identification for generating messages. It
429 sets an appropriate message and puts the first digit of the response code into
430 the yield variable. If no response was actually read, a suitable digit is
431 chosen.
432
433 Arguments:
434   host           the current host, to get its name for messages
435   errno_value    pointer to the errno value
436   more_errno     from the top address for use with ERRNO_FILTER_FAIL
437   buffer         the SMTP response buffer
438   yield          where to put a one-digit SMTP response code
439   message        where to put an errror message
440   pass_message   set TRUE if message is an SMTP response
441
442 Returns:         TRUE if an SMTP "QUIT" command should be sent, else FALSE
443 */
444
445 static BOOL check_response(host_item *host, int *errno_value, int more_errno,
446   uschar *buffer, int *yield, uschar **message, BOOL *pass_message)
447 {
448 uschar *pl = US"";
449
450 if (smtp_use_pipelining &&
451     (Ustrcmp(smtp_command, "MAIL") == 0 ||
452      Ustrcmp(smtp_command, "RCPT") == 0 ||
453      Ustrcmp(smtp_command, "DATA") == 0))
454   pl = US"pipelined ";
455
456 *yield = '4';    /* Default setting is to give a temporary error */
457
458 /* Handle response timeout */
459
460 if (*errno_value == ETIMEDOUT)
461   {
462   *message = US string_sprintf("SMTP timeout while connected to %s [%s] "
463     "after %s%s", host->name, host->address, pl, smtp_command);
464   if (transport_count > 0)
465     *message = US string_sprintf("%s (%d bytes written)", *message,
466       transport_count);
467   return FALSE;
468   }
469
470 /* Handle malformed SMTP response */
471
472 if (*errno_value == ERRNO_SMTPFORMAT)
473   {
474   uschar *malfresp = string_printing(buffer);
475   while (isspace(*malfresp)) malfresp++;
476   if (*malfresp == 0)
477     *message = string_sprintf("Malformed SMTP reply (an empty line) from "
478       "%s [%s] in response to %s%s", host->name, host->address, pl,
479       smtp_command);
480   else
481     *message = string_sprintf("Malformed SMTP reply from %s [%s] in response "
482       "to %s%s: %s", host->name, host->address, pl, smtp_command, malfresp);
483   return FALSE;
484   }
485
486 /* Handle a failed filter process error; can't send QUIT as we mustn't
487 end the DATA. */
488
489 if (*errno_value == ERRNO_FILTER_FAIL)
490   {
491   *message = US string_sprintf("transport filter process failed (%d)%s",
492     more_errno,
493     (more_errno == EX_EXECFAILED)? ": unable to execute command" : "");
494   return FALSE;
495   }
496
497 /* Handle a failed add_headers expansion; can't send QUIT as we mustn't
498 end the DATA. */
499
500 if (*errno_value == ERRNO_CHHEADER_FAIL)
501   {
502   *message =
503     US string_sprintf("failed to expand headers_add or headers_remove: %s",
504       expand_string_message);
505   return FALSE;
506   }
507
508 /* Handle failure to write a complete data block */
509
510 if (*errno_value == ERRNO_WRITEINCOMPLETE)
511   {
512   *message = US string_sprintf("failed to write a data block");
513   return FALSE;
514   }
515
516 /* Handle error responses from the remote mailer. */
517
518 if (buffer[0] != 0)
519   {
520   uschar *s = string_printing(buffer);
521   *message = US string_sprintf("SMTP error from remote mail server after %s%s: "
522     "host %s [%s]: %s", pl, smtp_command, host->name, host->address, s);
523   *pass_message = TRUE;
524   *yield = buffer[0];
525   return TRUE;
526   }
527
528 /* No data was read. If there is no errno, this must be the EOF (i.e.
529 connection closed) case, which causes deferral. An explicit connection reset
530 error has the same effect. Otherwise, put the host's identity in the message,
531 leaving the errno value to be interpreted as well. In all cases, we have to
532 assume the connection is now dead. */
533
534 if (*errno_value == 0 || *errno_value == ECONNRESET)
535   {
536   *errno_value = ERRNO_SMTPCLOSED;
537   *message = US string_sprintf("Remote host %s [%s] closed connection "
538     "in response to %s%s", host->name, host->address, pl, smtp_command);
539   }
540 else *message = US string_sprintf("%s [%s]", host->name, host->address);
541
542 return FALSE;
543 }
544
545
546
547 /*************************************************
548 *          Write error message to logs           *
549 *************************************************/
550
551 /* This writes to the main log and to the message log.
552
553 Arguments:
554   addr     the address item containing error information
555   host     the current host
556
557 Returns:   nothing
558 */
559
560 static void
561 write_logs(address_item *addr, host_item *host)
562 {
563 if (addr->message != NULL)
564   {
565   uschar *message = addr->message;
566   if (addr->basic_errno > 0)
567     message = string_sprintf("%s: %s", message, strerror(addr->basic_errno));
568   log_write(0, LOG_MAIN, "%s", message);
569   deliver_msglog("%s %s\n", tod_stamp(tod_log), message);
570   }
571 else
572   {
573   uschar *msg =
574     ((log_extra_selector & LX_outgoing_port) != 0)?
575     string_sprintf("%s [%s]:%d", host->name, host->address,
576       (host->port == PORT_NONE)? 25 : host->port)
577     :
578     string_sprintf("%s [%s]", host->name, host->address);
579   log_write(0, LOG_MAIN, "%s %s", msg, strerror(addr->basic_errno));
580   deliver_msglog("%s %s %s\n", tod_stamp(tod_log), msg,
581     strerror(addr->basic_errno));
582   }
583 }
584
585
586
587 #ifdef EXPERIMENTAL_DBL
588 /*************************************************
589 *          Write error message to database log   *
590 *************************************************/
591
592 /* This expands an arbitrary per-transport string.
593    It might, for example, be used to write to the database log.
594
595 Arguments:
596   dbl_host_defer_query  dbl_host_defer_query from the transport options block
597   addr                  the address item containing error information
598   host                  the current host
599
600 Returns:   nothing
601 */
602
603 static void
604 dbl_write_defer_log(uschar *dbl_host_defer_query, address_item *addr, host_item *host)
605 {
606 if (dbl_host_defer_query == NULL)
607         return;
608
609 dbl_delivery_ip = string_copy(host->address);
610 dbl_delivery_port = (host->port == PORT_NONE)? 25 : host->port;
611 dbl_delivery_fqdn = string_copy(host->name);
612 dbl_delivery_local_part = string_copy(addr->local_part);
613 dbl_delivery_domain = string_copy(addr->domain);
614 dbl_defer_errno = addr->basic_errno;
615
616 dbl_defer_errstr = (addr->message != NULL)
617   ? (addr->basic_errno > 0)
618   ? string_sprintf("%s: %s", addr->message, strerror(addr->basic_errno))
619   : string_copy(addr->message)
620   : (addr->basic_errno > 0)
621   ? string_copy(strerror(addr->basic_errno))
622   : NULL;
623
624 DEBUG(D_transport) {
625         debug_printf("  DBL(host defer): dbl_host_defer_query=|%s| dbl_delivery_IP=%s\n", dbl_host_defer_query, dbl_delivery_ip);
626 }
627
628 router_name =    addr->router->name;
629 transport_name = addr->transport->name;
630 expand_string(dbl_host_defer_query);
631 router_name = transport_name = NULL;
632 }
633 #endif
634
635
636
637 /*************************************************
638 *           Synchronize SMTP responses           *
639 *************************************************/
640
641 /* This function is called from smtp_deliver() to receive SMTP responses from
642 the server, and match them up with the commands to which they relate. When
643 PIPELINING is not in use, this function is called after every command, and is
644 therefore somewhat over-engineered, but it is simpler to use a single scheme
645 that works both with and without PIPELINING instead of having two separate sets
646 of code.
647
648 The set of commands that are buffered up with pipelining may start with MAIL
649 and may end with DATA; in between are RCPT commands that correspond to the
650 addresses whose status is PENDING_DEFER. All other commands (STARTTLS, AUTH,
651 etc.) are never buffered.
652
653 Errors after MAIL or DATA abort the whole process leaving the response in the
654 buffer. After MAIL, pending responses are flushed, and the original command is
655 re-instated in big_buffer for error messages. For RCPT commands, the remote is
656 permitted to reject some recipient addresses while accepting others. However
657 certain errors clearly abort the whole process. Set the value in
658 transport_return to PENDING_OK if the address is accepted. If there is a
659 subsequent general error, it will get reset accordingly. If not, it will get
660 converted to OK at the end.
661
662 Arguments:
663   addrlist          the complete address list
664   include_affixes   TRUE if affixes include in RCPT
665   sync_addr         ptr to the ptr of the one to start scanning at (updated)
666   host              the host we are connected to
667   count             the number of responses to read
668   address_retry_
669     include_sender  true if 4xx retry is to include the sender it its key
670   pending_MAIL      true if the first response is for MAIL
671   pending_DATA      0 if last command sent was not DATA
672                    +1 if previously had a good recipient
673                    -1 if not previously had a good recipient
674   inblock           incoming SMTP block
675   timeout           timeout value
676   buffer            buffer for reading response
677   buffsize          size of buffer
678
679 Returns:      3 if at least one address had 2xx and one had 5xx
680               2 if at least one address had 5xx but none had 2xx
681               1 if at least one host had a 2xx response, but none had 5xx
682               0 no address had 2xx or 5xx but no errors (all 4xx, or just DATA)
683              -1 timeout while reading RCPT response
684              -2 I/O or other non-response error for RCPT
685              -3 DATA or MAIL failed - errno and buffer set
686 */
687
688 static int
689 sync_responses(address_item *addrlist, BOOL include_affixes,
690   address_item **sync_addr, host_item *host, int count,
691   BOOL address_retry_include_sender, BOOL pending_MAIL,
692   int pending_DATA, smtp_inblock *inblock, int timeout, uschar *buffer,
693   int buffsize)
694 {
695 address_item *addr = *sync_addr;
696 int yield = 0;
697
698 /* Handle the response for a MAIL command. On error, reinstate the original
699 command in big_buffer for error message use, and flush any further pending
700 responses before returning, except after I/O errors and timeouts. */
701
702 if (pending_MAIL)
703   {
704   count--;
705   if (!smtp_read_response(inblock, buffer, buffsize, '2', timeout))
706     {
707     Ustrcpy(big_buffer, mail_command);  /* Fits, because it came from there! */
708     if (errno == 0 && buffer[0] != 0)
709       {
710       uschar flushbuffer[4096];
711       int save_errno = 0;
712       if (buffer[0] == '4')
713         {
714         save_errno = ERRNO_MAIL4XX;
715         addr->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
716         }
717       while (count-- > 0)
718         {
719         if (!smtp_read_response(inblock, flushbuffer, sizeof(flushbuffer),
720                    '2', timeout)
721             && (errno != 0 || flushbuffer[0] == 0))
722           break;
723         }
724       errno = save_errno;
725       }
726     return -3;
727     }
728   }
729
730 if (pending_DATA) count--;  /* Number of RCPT responses to come */
731
732 /* Read and handle the required number of RCPT responses, matching each one up
733 with an address by scanning for the next address whose status is PENDING_DEFER.
734 */
735
736 while (count-- > 0)
737   {
738   while (addr->transport_return != PENDING_DEFER) addr = addr->next;
739
740   /* The address was accepted */
741
742   if (smtp_read_response(inblock, buffer, buffsize, '2', timeout))
743     {
744     yield |= 1;
745     addr->transport_return = PENDING_OK;
746
747     /* If af_dr_retry_exists is set, there was a routing delay on this address;
748     ensure that any address-specific retry record is expunged. We do this both
749     for the basic key and for the version that also includes the sender. */
750
751     if (testflag(addr, af_dr_retry_exists))
752       {
753       uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
754         sender_address);
755       retry_add_item(addr, altkey, rf_delete);
756       retry_add_item(addr, addr->address_retry_key, rf_delete);
757       }
758     }
759
760   /* Timeout while reading the response */
761
762   else if (errno == ETIMEDOUT)
763     {
764     int save_errno = errno;
765     uschar *message = string_sprintf("SMTP timeout while connected to %s [%s] "
766       "after RCPT TO:<%s>", host->name, host->address,
767       transport_rcpt_address(addr, include_affixes));
768     set_errno(addrlist, save_errno, message, DEFER, FALSE);
769     retry_add_item(addr, addr->address_retry_key, 0);
770     update_waiting = FALSE;
771     return -1;
772     }
773
774   /* Handle other errors in obtaining an SMTP response by returning -1. This
775   will cause all the addresses to be deferred. Restore the SMTP command in
776   big_buffer for which we are checking the response, so the error message
777   makes sense. */
778
779   else if (errno != 0 || buffer[0] == 0)
780     {
781     string_format(big_buffer, big_buffer_size, "RCPT TO:<%s>",
782       transport_rcpt_address(addr, include_affixes));
783     return -2;
784     }
785
786   /* Handle SMTP permanent and temporary response codes. */
787
788   else
789     {
790     addr->message =
791       string_sprintf("SMTP error from remote mail server after RCPT TO:<%s>: "
792         "host %s [%s]: %s", transport_rcpt_address(addr, include_affixes),
793         host->name, host->address, string_printing(buffer));
794     setflag(addr, af_pass_message);
795     deliver_msglog("%s %s\n", tod_stamp(tod_log), addr->message);
796
797     /* The response was 5xx */
798
799     if (buffer[0] == '5')
800       {
801       addr->transport_return = FAIL;
802       yield |= 2;
803       }
804
805     /* The response was 4xx */
806
807     else
808       {
809       addr->transport_return = DEFER;
810       addr->basic_errno = ERRNO_RCPT4XX;
811       addr->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
812
813       /* Log temporary errors if there are more hosts to be tried. */
814
815       if (host->next != NULL) log_write(0, LOG_MAIN, "%s", addr->message);
816
817       /* Do not put this message on the list of those waiting for specific
818       hosts, as otherwise it is likely to be tried too often. */
819
820       update_waiting = FALSE;
821
822       /* Add a retry item for the address so that it doesn't get tried again
823       too soon. If address_retry_include_sender is true, add the sender address
824       to the retry key. */
825
826       if (address_retry_include_sender)
827         {
828         uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
829           sender_address);
830         retry_add_item(addr, altkey, 0);
831         }
832       else retry_add_item(addr, addr->address_retry_key, 0);
833       }
834     }
835   }       /* Loop for next RCPT response */
836
837 /* Update where to start at for the next block of responses, unless we
838 have already handled all the addresses. */
839
840 if (addr != NULL) *sync_addr = addr->next;
841
842 /* Handle a response to DATA. If we have not had any good recipients, either
843 previously or in this block, the response is ignored. */
844
845 if (pending_DATA != 0 &&
846     !smtp_read_response(inblock, buffer, buffsize, '3', timeout))
847   {
848   int code;
849   uschar *msg;
850   BOOL pass_message;
851   if (pending_DATA > 0 || (yield & 1) != 0)
852     {
853     if (errno == 0 && buffer[0] == '4')
854       {
855       errno = ERRNO_DATA4XX;
856       addrlist->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
857       }
858     return -3;
859     }
860   (void)check_response(host, &errno, 0, buffer, &code, &msg, &pass_message);
861   DEBUG(D_transport) debug_printf("%s\nerror for DATA ignored: pipelining "
862     "is in use and there were no good recipients\n", msg);
863   }
864
865 /* All responses read and handled; MAIL (if present) received 2xx and DATA (if
866 present) received 3xx. If any RCPTs were handled and yielded anything other
867 than 4xx, yield will be set non-zero. */
868
869 return yield;
870 }
871
872
873
874 /* Do the client side of smtp-level authentication */
875 /*
876 Arguments:
877   buffer        EHLO response from server (gets overwritten)
878   addrlist      chain of potential addresses to deliver
879   host          host to deliver to
880   ob            transport options
881   ibp, obp      comms channel control blocks
882
883 Returns:
884   OK                    Success, or failed (but not required): global "smtp_authenticated" set
885   DEFER                 Failed authentication (and was required)
886   ERROR                 Internal problem
887
888   FAIL_SEND             Failed communications - transmit
889   FAIL                  - response
890 */
891
892 int
893 smtp_auth(uschar *buffer, unsigned bufsize, address_item *addrlist, host_item *host,
894     smtp_transport_options_block *ob, BOOL is_esmtp,
895     smtp_inblock *ibp, smtp_outblock *obp)
896 {
897   int require_auth;
898   uschar *fail_reason = US"server did not advertise AUTH support";
899
900   smtp_authenticated = FALSE;
901   client_authenticator = client_authenticated_id = client_authenticated_sender = NULL;
902   require_auth = verify_check_this_host(&(ob->hosts_require_auth), NULL,
903     host->name, host->address, NULL);
904
905   if (is_esmtp && !regex_AUTH) regex_AUTH =
906       regex_must_compile(US"\\n250[\\s\\-]AUTH\\s+([\\-\\w\\s]+)(?:\\n|$)",
907             FALSE, TRUE);
908
909   if (is_esmtp && regex_match_and_setup(regex_AUTH, buffer, 0, -1))
910     {
911     uschar *names = string_copyn(expand_nstring[1], expand_nlength[1]);
912     expand_nmax = -1;                          /* reset */
913
914     /* Must not do this check until after we have saved the result of the
915     regex match above. */
916
917     if (require_auth == OK ||
918         verify_check_this_host(&(ob->hosts_try_auth), NULL, host->name,
919           host->address, NULL) == OK)
920       {
921       auth_instance *au;
922       fail_reason = US"no common mechanisms were found";
923
924       DEBUG(D_transport) debug_printf("scanning authentication mechanisms\n");
925
926       /* Scan the configured authenticators looking for one which is configured
927       for use as a client, which is not suppressed by client_condition, and
928       whose name matches an authentication mechanism supported by the server.
929       If one is found, attempt to authenticate by calling its client function.
930       */
931
932       for (au = auths; !smtp_authenticated && au != NULL; au = au->next)
933         {
934         uschar *p = names;
935         if (!au->client ||
936             (au->client_condition != NULL &&
937              !expand_check_condition(au->client_condition, au->name,
938                US"client authenticator")))
939           {
940           DEBUG(D_transport) debug_printf("skipping %s authenticator: %s\n",
941             au->name,
942             (au->client)? "client_condition is false" :
943                           "not configured as a client");
944           continue;
945           }
946
947         /* Loop to scan supported server mechanisms */
948
949         while (*p != 0)
950           {
951           int rc;
952           int len = Ustrlen(au->public_name);
953           while (isspace(*p)) p++;
954
955           if (strncmpic(au->public_name, p, len) != 0 ||
956               (p[len] != 0 && !isspace(p[len])))
957             {
958             while (*p != 0 && !isspace(*p)) p++;
959             continue;
960             }
961
962           /* Found data for a listed mechanism. Call its client entry. Set
963           a flag in the outblock so that data is overwritten after sending so
964           that reflections don't show it. */
965
966           fail_reason = US"authentication attempt(s) failed";
967           obp->authenticating = TRUE;
968           rc = (au->info->clientcode)(au, ibp, obp,
969             ob->command_timeout, buffer, bufsize);
970           obp->authenticating = FALSE;
971           DEBUG(D_transport) debug_printf("%s authenticator yielded %d\n",
972             au->name, rc);
973
974           /* A temporary authentication failure must hold up delivery to
975           this host. After a permanent authentication failure, we carry on
976           to try other authentication methods. If all fail hard, try to
977           deliver the message unauthenticated unless require_auth was set. */
978
979           switch(rc)
980             {
981             case OK:
982             smtp_authenticated = TRUE;   /* stops the outer loop */
983             client_authenticator = au->name;
984             if (au->set_client_id != NULL)
985               client_authenticated_id = expand_string(au->set_client_id);
986             break;
987
988             /* Failure after writing a command */
989
990             case FAIL_SEND:
991             return FAIL_SEND;
992
993             /* Failure after reading a response */
994
995             case FAIL:
996             if (errno != 0 || buffer[0] != '5') return FAIL;
997             log_write(0, LOG_MAIN, "%s authenticator failed H=%s [%s] %s",
998               au->name, host->name, host->address, buffer);
999             break;
1000
1001             /* Failure by some other means. In effect, the authenticator
1002             decided it wasn't prepared to handle this case. Typically this
1003             is the result of "fail" in an expansion string. Do we need to
1004             log anything here? Feb 2006: a message is now put in the buffer
1005             if logging is required. */
1006
1007             case CANCELLED:
1008             if (*buffer != 0)
1009               log_write(0, LOG_MAIN, "%s authenticator cancelled "
1010                 "authentication H=%s [%s] %s", au->name, host->name,
1011                 host->address, buffer);
1012             break;
1013
1014             /* Internal problem, message in buffer. */
1015
1016             case ERROR:
1017             set_errno(addrlist, 0, string_copy(buffer), DEFER, FALSE);
1018             return ERROR;
1019             }
1020
1021           break;  /* If not authenticated, try next authenticator */
1022           }       /* Loop for scanning supported server mechanisms */
1023         }         /* Loop for further authenticators */
1024       }
1025     }
1026
1027   /* If we haven't authenticated, but are required to, give up. */
1028
1029   if (require_auth == OK && !smtp_authenticated)
1030     {
1031     set_errno(addrlist, ERRNO_AUTHFAIL,
1032       string_sprintf("authentication required but %s", fail_reason), DEFER,
1033       FALSE);
1034     return DEFER;
1035     }
1036   
1037   return OK;
1038 }
1039
1040
1041 /* Construct AUTH appendix string for MAIL TO */
1042 /*
1043 Arguments
1044   buffer        to build string
1045   addrlist      chain of potential addresses to deliver
1046   ob            transport options
1047
1048 Globals         smtp_authenticated
1049                 client_authenticated_sender
1050 Return  True on error, otherwise buffer has (possibly empty) terminated string
1051 */
1052
1053 BOOL
1054 smtp_mail_auth_str(uschar *buffer, unsigned bufsize, address_item *addrlist,
1055                     smtp_transport_options_block *ob)
1056 {
1057 uschar *local_authenticated_sender = authenticated_sender;
1058
1059 #ifdef notdef
1060   debug_printf("smtp_mail_auth_str: as<%s> os<%s> SA<%s>\n", authenticated_sender, ob->authenticated_sender, smtp_authenticated?"Y":"N");
1061 #endif
1062
1063 if (ob->authenticated_sender != NULL)
1064   {
1065   uschar *new = expand_string(ob->authenticated_sender);
1066   if (new == NULL)
1067     {
1068     if (!expand_string_forcedfail)
1069       {
1070       uschar *message = string_sprintf("failed to expand "
1071         "authenticated_sender: %s", expand_string_message);
1072       set_errno(addrlist, 0, message, DEFER, FALSE);
1073       return TRUE;
1074       }
1075     }
1076   else if (new[0] != 0) local_authenticated_sender = new;
1077   }
1078
1079 /* Add the authenticated sender address if present */
1080
1081 if ((smtp_authenticated || ob->authenticated_sender_force) &&
1082     local_authenticated_sender != NULL)
1083   {
1084   string_format(buffer, bufsize, " AUTH=%s",
1085     auth_xtextencode(local_authenticated_sender,
1086     Ustrlen(local_authenticated_sender)));
1087   client_authenticated_sender = string_copy(local_authenticated_sender);
1088   }
1089 else
1090   *buffer= 0;
1091
1092 return FALSE;
1093 }
1094
1095
1096
1097 /*************************************************
1098 *       Deliver address list to given host       *
1099 *************************************************/
1100
1101 /* If continue_hostname is not null, we get here only when continuing to
1102 deliver down an existing channel. The channel was passed as the standard
1103 input. TLS is never active on a passed channel; the previous process always
1104 closes it down before passing the connection on.
1105
1106 Otherwise, we have to make a connection to the remote host, and do the
1107 initial protocol exchange.
1108
1109 When running as an MUA wrapper, if the sender or any recipient is rejected,
1110 temporarily or permanently, we force failure for all recipients.
1111
1112 Arguments:
1113   addrlist        chain of potential addresses to deliver; only those whose
1114                   transport_return field is set to PENDING_DEFER are currently
1115                   being processed; others should be skipped - they have either
1116                   been delivered to an earlier host or IP address, or been
1117                   failed by one of them.
1118   host            host to deliver to
1119   host_af         AF_INET or AF_INET6
1120   port            default TCP/IP port to use, in host byte order
1121   interface       interface to bind to, or NULL
1122   tblock          transport instance block
1123   copy_host       TRUE if host set in addr->host_used must be copied, because
1124                     it is specific to this call of the transport
1125   message_defer   set TRUE if yield is OK, but all addresses were deferred
1126                     because of a non-recipient, non-host failure, that is, a
1127                     4xx response to MAIL FROM, DATA, or ".". This is a defer
1128                     that is specific to the message.
1129   suppress_tls    if TRUE, don't attempt a TLS connection - this is set for
1130                     a second attempt after TLS initialization fails
1131
1132 Returns:          OK    - the connection was made and the delivery attempted;
1133                           the result for each address is in its data block.
1134                   DEFER - the connection could not be made, or something failed
1135                           while setting up the SMTP session, or there was a
1136                           non-message-specific error, such as a timeout.
1137                   ERROR - a filter command is specified for this transport,
1138                           and there was a problem setting it up; OR helo_data
1139                           or add_headers or authenticated_sender is specified
1140                           for this transport, and the string failed to expand
1141 */
1142
1143 static int
1144 smtp_deliver(address_item *addrlist, host_item *host, int host_af, int port,
1145   uschar *interface, transport_instance *tblock, BOOL copy_host,
1146   BOOL *message_defer, BOOL suppress_tls)
1147 {
1148 address_item *addr;
1149 address_item *sync_addr;
1150 address_item *first_addr = addrlist;
1151 int yield = OK;
1152 int address_count;
1153 int save_errno;
1154 int rc;
1155 time_t start_delivery_time = time(NULL);
1156 smtp_transport_options_block *ob =
1157   (smtp_transport_options_block *)(tblock->options_block);
1158 BOOL lmtp = strcmpic(ob->protocol, US"lmtp") == 0;
1159 BOOL smtps = strcmpic(ob->protocol, US"smtps") == 0;
1160 BOOL ok = FALSE;
1161 BOOL send_rset = TRUE;
1162 BOOL send_quit = TRUE;
1163 BOOL setting_up = TRUE;
1164 BOOL completed_address = FALSE;
1165 BOOL esmtp = TRUE;
1166 BOOL pending_MAIL;
1167 BOOL pass_message = FALSE;
1168 #ifdef EXPERIMENTAL_PRDR
1169 BOOL prdr_offered = FALSE;
1170 BOOL prdr_active;
1171 #endif
1172 smtp_inblock inblock;
1173 smtp_outblock outblock;
1174 int max_rcpt = tblock->max_addresses;
1175 uschar *igquotstr = US"";
1176 uschar *helo_data = NULL;
1177 uschar *message = NULL;
1178 uschar new_message_id[MESSAGE_ID_LENGTH + 1];
1179 uschar *p;
1180 uschar buffer[4096];
1181 uschar inbuffer[4096];
1182 uschar outbuffer[1024];
1183
1184 suppress_tls = suppress_tls;  /* stop compiler warning when no TLS support */
1185
1186 *message_defer = FALSE;
1187 smtp_command = US"initial connection";
1188 if (max_rcpt == 0) max_rcpt = 999999;
1189
1190 /* Set up the buffer for reading SMTP response packets. */
1191
1192 inblock.buffer = inbuffer;
1193 inblock.buffersize = sizeof(inbuffer);
1194 inblock.ptr = inbuffer;
1195 inblock.ptrend = inbuffer;
1196
1197 /* Set up the buffer for holding SMTP commands while pipelining */
1198
1199 outblock.buffer = outbuffer;
1200 outblock.buffersize = sizeof(outbuffer);
1201 outblock.ptr = outbuffer;
1202 outblock.cmd_count = 0;
1203 outblock.authenticating = FALSE;
1204
1205 /* Reset the parameters of a TLS session. */
1206
1207 tls_in.bits = 0;
1208 tls_in.cipher = NULL;   /* for back-compatible behaviour */
1209 tls_in.peerdn = NULL;
1210 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
1211 tls_in.sni = NULL;
1212 #endif
1213
1214 tls_out.bits = 0;
1215 tls_out.cipher = NULL;  /* the one we may use for this transport */
1216 tls_out.peerdn = NULL;
1217 #if defined(SUPPORT_TLS) && !defined(USE_GNUTLS)
1218 tls_out.sni = NULL;
1219 #endif
1220
1221 #ifndef SUPPORT_TLS
1222 if (smtps)
1223   {
1224     set_errno(addrlist, 0, US"TLS support not available", DEFER, FALSE);
1225     return ERROR;
1226   }
1227 #endif
1228
1229 /* Make a connection to the host if this isn't a continued delivery, and handle
1230 the initial interaction and HELO/EHLO/LHLO. Connect timeout errors are handled
1231 specially so they can be identified for retries. */
1232
1233 if (continue_hostname == NULL)
1234   {
1235   inblock.sock = outblock.sock =
1236     smtp_connect(host, host_af, port, interface, ob->connect_timeout,
1237       ob->keepalive, ob->dscp);   /* This puts port into host->port */
1238
1239   if (inblock.sock < 0)
1240     {
1241     set_errno(addrlist, (errno == ETIMEDOUT)? ERRNO_CONNECTTIMEOUT : errno,
1242       NULL, DEFER, FALSE);
1243     return DEFER;
1244     }
1245
1246   /* Expand the greeting message while waiting for the initial response. (Makes
1247   sense if helo_data contains ${lookup dnsdb ...} stuff). The expansion is
1248   delayed till here so that $sending_interface and $sending_port are set. */
1249
1250   helo_data = expand_string(ob->helo_data);
1251
1252   /* The first thing is to wait for an initial OK response. The dreaded "goto"
1253   is nevertheless a reasonably clean way of programming this kind of logic,
1254   where you want to escape on any error. */
1255
1256   if (!smtps)
1257     {
1258     if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1259       ob->command_timeout)) goto RESPONSE_FAILED;
1260
1261     /* Now check if the helo_data expansion went well, and sign off cleanly if
1262     it didn't. */
1263
1264     if (helo_data == NULL)
1265       {
1266       uschar *message = string_sprintf("failed to expand helo_data: %s",
1267         expand_string_message);
1268       set_errno(addrlist, 0, message, DEFER, FALSE);
1269       yield = DEFER;
1270       goto SEND_QUIT;
1271       }
1272     }
1273
1274 /** Debugging without sending a message
1275 addrlist->transport_return = DEFER;
1276 goto SEND_QUIT;
1277 **/
1278
1279   /* Errors that occur after this point follow an SMTP command, which is
1280   left in big_buffer by smtp_write_command() for use in error messages. */
1281
1282   smtp_command = big_buffer;
1283
1284   /* Tell the remote who we are...
1285
1286   February 1998: A convention has evolved that ESMTP-speaking MTAs include the
1287   string "ESMTP" in their greeting lines, so make Exim send EHLO if the
1288   greeting is of this form. The assumption was that the far end supports it
1289   properly... but experience shows that there are some that give 5xx responses,
1290   even though the banner includes "ESMTP" (there's a bloody-minded one that
1291   says "ESMTP not spoken here"). Cope with that case.
1292
1293   September 2000: Time has passed, and it seems reasonable now to always send
1294   EHLO at the start. It is also convenient to make the change while installing
1295   the TLS stuff.
1296
1297   July 2003: Joachim Wieland met a broken server that advertises "PIPELINING"
1298   but times out after sending MAIL FROM, RCPT TO and DATA all together. There
1299   would be no way to send out the mails, so there is now a host list
1300   "hosts_avoid_esmtp" that disables ESMTP for special hosts and solves the
1301   PIPELINING problem as well. Maybe it can also be useful to cure other
1302   problems with broken servers.
1303
1304   Exim originally sent "Helo" at this point and ran for nearly a year that way.
1305   Then somebody tried it with a Microsoft mailer... It seems that all other
1306   mailers use upper case for some reason (the RFC is quite clear about case
1307   independence) so, for peace of mind, I gave in. */
1308
1309   esmtp = verify_check_this_host(&(ob->hosts_avoid_esmtp), NULL,
1310      host->name, host->address, NULL) != OK;
1311
1312   /* Alas; be careful, since this goto is not an error-out, so conceivably
1313   we might set data between here and the target which we assume to exist
1314   and be usable.  I can see this coming back to bite us. */
1315   #ifdef SUPPORT_TLS
1316   if (smtps)
1317     {
1318     tls_offered = TRUE;
1319     suppress_tls = FALSE;
1320     ob->tls_tempfail_tryclear = FALSE;
1321     smtp_command = US"SSL-on-connect";
1322     goto TLS_NEGOTIATE;
1323     }
1324   #endif
1325
1326   if (esmtp)
1327     {
1328     if (smtp_write_command(&outblock, FALSE, "%s %s\r\n",
1329          lmtp? "LHLO" : "EHLO", helo_data) < 0)
1330       goto SEND_FAILED;
1331     if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1332            ob->command_timeout))
1333       {
1334       if (errno != 0 || buffer[0] == 0 || lmtp) goto RESPONSE_FAILED;
1335       esmtp = FALSE;
1336       }
1337     }
1338   else
1339     {
1340     DEBUG(D_transport)
1341       debug_printf("not sending EHLO (host matches hosts_avoid_esmtp)\n");
1342     }
1343
1344   if (!esmtp)
1345     {
1346     if (smtp_write_command(&outblock, FALSE, "HELO %s\r\n", helo_data) < 0)
1347       goto SEND_FAILED;
1348     if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1349       ob->command_timeout)) goto RESPONSE_FAILED;
1350     }
1351
1352   /* Set IGNOREQUOTA if the response to LHLO specifies support and the
1353   lmtp_ignore_quota option was set. */
1354
1355   igquotstr = (lmtp && ob->lmtp_ignore_quota &&
1356     pcre_exec(regex_IGNOREQUOTA, NULL, CS buffer, Ustrlen(CS buffer), 0,
1357       PCRE_EOPT, NULL, 0) >= 0)? US" IGNOREQUOTA" : US"";
1358
1359   /* Set tls_offered if the response to EHLO specifies support for STARTTLS. */
1360
1361   #ifdef SUPPORT_TLS
1362   tls_offered = esmtp &&
1363     pcre_exec(regex_STARTTLS, NULL, CS buffer, Ustrlen(buffer), 0,
1364       PCRE_EOPT, NULL, 0) >= 0;
1365   #endif
1366
1367   #ifdef EXPERIMENTAL_PRDR
1368   prdr_offered = esmtp &&
1369     (pcre_exec(regex_PRDR, NULL, CS buffer, Ustrlen(buffer), 0,
1370       PCRE_EOPT, NULL, 0) >= 0) &&
1371     (verify_check_this_host(&(ob->hosts_try_prdr), NULL, host->name,
1372       host->address, NULL) == OK);
1373
1374   if (prdr_offered)
1375     {DEBUG(D_transport) debug_printf("PRDR usable\n");}
1376   #endif
1377   }
1378
1379 /* For continuing deliveries down the same channel, the socket is the standard
1380 input, and we don't need to redo EHLO here (but may need to do so for TLS - see
1381 below). Set up the pointer to where subsequent commands will be left, for
1382 error messages. Note that smtp_use_size and smtp_use_pipelining will have been
1383 set from the command line if they were set in the process that passed the
1384 connection on. */
1385
1386 else
1387   {
1388   inblock.sock = outblock.sock = fileno(stdin);
1389   smtp_command = big_buffer;
1390   host->port = port;    /* Record the port that was used */
1391   }
1392
1393 /* If TLS is available on this connection, whether continued or not, attempt to
1394 start up a TLS session, unless the host is in hosts_avoid_tls. If successful,
1395 send another EHLO - the server may give a different answer in secure mode. We
1396 use a separate buffer for reading the response to STARTTLS so that if it is
1397 negative, the original EHLO data is available for subsequent analysis, should
1398 the client not be required to use TLS. If the response is bad, copy the buffer
1399 for error analysis. */
1400
1401 #ifdef SUPPORT_TLS
1402 if (tls_offered && !suppress_tls &&
1403       verify_check_this_host(&(ob->hosts_avoid_tls), NULL, host->name,
1404         host->address, NULL) != OK)
1405   {
1406   uschar buffer2[4096];
1407   if (smtp_write_command(&outblock, FALSE, "STARTTLS\r\n") < 0)
1408     goto SEND_FAILED;
1409
1410   /* If there is an I/O error, transmission of this message is deferred. If
1411   there is a temporary rejection of STARRTLS and tls_tempfail_tryclear is
1412   false, we also defer. However, if there is a temporary rejection of STARTTLS
1413   and tls_tempfail_tryclear is true, or if there is an outright rejection of
1414   STARTTLS, we carry on. This means we will try to send the message in clear,
1415   unless the host is in hosts_require_tls (tested below). */
1416
1417   if (!smtp_read_response(&inblock, buffer2, sizeof(buffer2), '2',
1418       ob->command_timeout))
1419     {
1420     if (errno != 0 || buffer2[0] == 0 ||
1421          (buffer2[0] == '4' && !ob->tls_tempfail_tryclear))
1422       {
1423       Ustrncpy(buffer, buffer2, sizeof(buffer));
1424       goto RESPONSE_FAILED;
1425       }
1426     }
1427
1428   /* STARTTLS accepted: try to negotiate a TLS session. */
1429
1430   else
1431   TLS_NEGOTIATE:
1432     {
1433     int rc = tls_client_start(inblock.sock,
1434       host,
1435       addrlist,
1436       ob->tls_certificate,
1437       ob->tls_privatekey,
1438       ob->tls_sni,
1439       ob->tls_verify_certificates,
1440       ob->tls_crl,
1441       ob->tls_require_ciphers,
1442 #ifdef EXPERIMENTAL_OCSP
1443       ob->hosts_require_ocsp,
1444 #endif
1445       ob->tls_dh_min_bits,
1446       ob->command_timeout);
1447
1448     /* TLS negotiation failed; give an error. From outside, this function may
1449     be called again to try in clear on a new connection, if the options permit
1450     it for this host. */
1451
1452     if (rc != OK)
1453       {
1454       save_errno = ERRNO_TLSFAILURE;
1455       message = US"failure while setting up TLS session";
1456       send_quit = FALSE;
1457       goto TLS_FAILED;
1458       }
1459
1460     /* TLS session is set up */
1461
1462     for (addr = addrlist; addr != NULL; addr = addr->next)
1463       {
1464       if (addr->transport_return == PENDING_DEFER)
1465         {
1466         addr->cipher = tls_out.cipher;
1467         addr->peerdn = tls_out.peerdn;
1468         }
1469       }
1470     }
1471   }
1472
1473 /* if smtps, we'll have smtp_command set to something else; always safe to
1474 reset it here. */
1475 smtp_command = big_buffer;
1476
1477 /* If we started TLS, redo the EHLO/LHLO exchange over the secure channel. If
1478 helo_data is null, we are dealing with a connection that was passed from
1479 another process, and so we won't have expanded helo_data above. We have to
1480 expand it here. $sending_ip_address and $sending_port are set up right at the
1481 start of the Exim process (in exim.c). */
1482
1483 if (tls_out.active >= 0)
1484   {
1485   char *greeting_cmd;
1486   if (helo_data == NULL)
1487     {
1488     helo_data = expand_string(ob->helo_data);
1489     if (helo_data == NULL)
1490       {
1491       uschar *message = string_sprintf("failed to expand helo_data: %s",
1492         expand_string_message);
1493       set_errno(addrlist, 0, message, DEFER, FALSE);
1494       yield = DEFER;
1495       goto SEND_QUIT;
1496       }
1497     }
1498
1499   /* For SMTPS we need to wait for the initial OK response. */
1500   if (smtps)
1501     {
1502     if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1503       ob->command_timeout)) goto RESPONSE_FAILED;
1504     }
1505
1506   if (esmtp)
1507     greeting_cmd = "EHLO";
1508   else
1509     {
1510     greeting_cmd = "HELO";
1511     DEBUG(D_transport)
1512       debug_printf("not sending EHLO (host matches hosts_avoid_esmtp)\n");
1513     }
1514
1515   if (smtp_write_command(&outblock, FALSE, "%s %s\r\n",
1516         lmtp? "LHLO" : greeting_cmd, helo_data) < 0)
1517     goto SEND_FAILED;
1518   if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1519        ob->command_timeout))
1520     goto RESPONSE_FAILED;
1521   }
1522
1523 /* If the host is required to use a secure channel, ensure that we
1524 have one. */
1525
1526 else if (verify_check_this_host(&(ob->hosts_require_tls), NULL, host->name,
1527           host->address, NULL) == OK)
1528   {
1529   save_errno = ERRNO_TLSREQUIRED;
1530   message = string_sprintf("a TLS session is required for %s [%s], but %s",
1531     host->name, host->address,
1532     tls_offered? "an attempt to start TLS failed" :
1533                  "the server did not offer TLS support");
1534   goto TLS_FAILED;
1535   }
1536 #endif
1537
1538 /* If TLS is active, we have just started it up and re-done the EHLO command,
1539 so its response needs to be analyzed. If TLS is not active and this is a
1540 continued session down a previously-used socket, we haven't just done EHLO, so
1541 we skip this. */
1542
1543 if (continue_hostname == NULL
1544     #ifdef SUPPORT_TLS
1545     || tls_out.active >= 0
1546     #endif
1547     )
1548   {
1549   /* Set for IGNOREQUOTA if the response to LHLO specifies support and the
1550   lmtp_ignore_quota option was set. */
1551
1552   igquotstr = (lmtp && ob->lmtp_ignore_quota &&
1553     pcre_exec(regex_IGNOREQUOTA, NULL, CS buffer, Ustrlen(CS buffer), 0,
1554       PCRE_EOPT, NULL, 0) >= 0)? US" IGNOREQUOTA" : US"";
1555
1556   /* If the response to EHLO specified support for the SIZE parameter, note
1557   this, provided size_addition is non-negative. */
1558
1559   smtp_use_size = esmtp && ob->size_addition >= 0 &&
1560     pcre_exec(regex_SIZE, NULL, CS buffer, Ustrlen(CS buffer), 0,
1561       PCRE_EOPT, NULL, 0) >= 0;
1562
1563   /* Note whether the server supports PIPELINING. If hosts_avoid_esmtp matched
1564   the current host, esmtp will be false, so PIPELINING can never be used. If
1565   the current host matches hosts_avoid_pipelining, don't do it. */
1566
1567   smtp_use_pipelining = esmtp &&
1568     verify_check_this_host(&(ob->hosts_avoid_pipelining), NULL, host->name,
1569       host->address, NULL) != OK &&
1570     pcre_exec(regex_PIPELINING, NULL, CS buffer, Ustrlen(CS buffer), 0,
1571       PCRE_EOPT, NULL, 0) >= 0;
1572
1573   DEBUG(D_transport) debug_printf("%susing PIPELINING\n",
1574     smtp_use_pipelining? "" : "not ");
1575
1576 #ifdef EXPERIMENTAL_PRDR
1577   prdr_offered = esmtp &&
1578     pcre_exec(regex_PRDR, NULL, CS buffer, Ustrlen(CS buffer), 0,
1579       PCRE_EOPT, NULL, 0) >= 0 &&
1580     verify_check_this_host(&(ob->hosts_try_prdr), NULL, host->name,
1581       host->address, NULL) == OK;
1582
1583   if (prdr_offered)
1584     {DEBUG(D_transport) debug_printf("PRDR usable\n");}
1585 #endif
1586
1587   /* Note if the response to EHLO specifies support for the AUTH extension.
1588   If it has, check that this host is one we want to authenticate to, and do
1589   the business. The host name and address must be available when the
1590   authenticator's client driver is running. */
1591
1592   switch (yield = smtp_auth(buffer, sizeof(buffer), addrlist, host,
1593                             ob, esmtp, &inblock, &outblock))
1594     {
1595     default:            goto SEND_QUIT;
1596     case OK:            break;
1597     case FAIL_SEND:     goto SEND_FAILED;
1598     case FAIL:          goto RESPONSE_FAILED;
1599     }
1600   }
1601
1602 /* The setting up of the SMTP call is now complete. Any subsequent errors are
1603 message-specific. */
1604
1605 setting_up = FALSE;
1606
1607 /* If there is a filter command specified for this transport, we can now
1608 set it up. This cannot be done until the identify of the host is known. */
1609
1610 if (tblock->filter_command != NULL)
1611   {
1612   BOOL rc;
1613   uschar buffer[64];
1614   sprintf(CS buffer, "%.50s transport", tblock->name);
1615   rc = transport_set_up_command(&transport_filter_argv, tblock->filter_command,
1616     TRUE, DEFER, addrlist, buffer, NULL);
1617   transport_filter_timeout = tblock->filter_timeout;
1618
1619   /* On failure, copy the error to all addresses, abandon the SMTP call, and
1620   yield ERROR. */
1621
1622   if (!rc)
1623     {
1624     set_errno(addrlist->next, addrlist->basic_errno, addrlist->message, DEFER,
1625       FALSE);
1626     yield = ERROR;
1627     goto SEND_QUIT;
1628     }
1629   }
1630
1631
1632 /* For messages that have more than the maximum number of envelope recipients,
1633 we want to send several transactions down the same SMTP connection. (See
1634 comments in deliver.c as to how this reconciles, heuristically, with
1635 remote_max_parallel.) This optimization was added to Exim after the following
1636 code was already working. The simplest way to put it in without disturbing the
1637 code was to use a goto to jump back to this point when there is another
1638 transaction to handle. */
1639
1640 SEND_MESSAGE:
1641 sync_addr = first_addr;
1642 address_count = 0;
1643 ok = FALSE;
1644 send_rset = TRUE;
1645 completed_address = FALSE;
1646
1647
1648 /* Initiate a message transfer. If we know the receiving MTA supports the SIZE
1649 qualification, send it, adding something to the message size to allow for
1650 imprecision and things that get added en route. Exim keeps the number of lines
1651 in a message, so we can give an accurate value for the original message, but we
1652 need some additional to handle added headers. (Double "." characters don't get
1653 included in the count.) */
1654
1655 p = buffer;
1656 *p = 0;
1657
1658 if (smtp_use_size)
1659   {
1660   sprintf(CS p, " SIZE=%d", message_size+message_linecount+ob->size_addition);
1661   while (*p) p++;
1662   }
1663
1664 #ifdef EXPERIMENTAL_PRDR
1665 prdr_active = FALSE;
1666 if (prdr_offered)
1667   {
1668   for (addr = first_addr; addr; addr = addr->next)
1669     if (addr->transport_return == PENDING_DEFER)
1670       {
1671       for (addr = addr->next; addr; addr = addr->next)
1672         if (addr->transport_return == PENDING_DEFER)
1673           {                     /* at least two recipients to send */
1674           prdr_active = TRUE;
1675           sprintf(CS p, " PRDR"); p += 5;
1676           goto prdr_is_active;
1677           }
1678       break;
1679       }
1680   }
1681 prdr_is_active:
1682 #endif
1683
1684 /* If an authenticated_sender override has been specified for this transport
1685 instance, expand it. If the expansion is forced to fail, and there was already
1686 an authenticated_sender for this message, the original value will be used.
1687 Other expansion failures are serious. An empty result is ignored, but there is
1688 otherwise no check - this feature is expected to be used with LMTP and other
1689 cases where non-standard addresses (e.g. without domains) might be required. */
1690
1691 if (smtp_mail_auth_str(p, sizeof(buffer) - (p-buffer), addrlist, ob))
1692     return ERROR;
1693
1694 /* From here until we send the DATA command, we can make use of PIPELINING
1695 if the server host supports it. The code has to be able to check the responses
1696 at any point, for when the buffer fills up, so we write it totally generally.
1697 When PIPELINING is off, each command written reports that it has flushed the
1698 buffer. */
1699
1700 pending_MAIL = TRUE;     /* The block starts with MAIL */
1701
1702 rc = smtp_write_command(&outblock, smtp_use_pipelining,
1703        "MAIL FROM:<%s>%s\r\n", return_path, buffer);
1704 mail_command = string_copy(big_buffer);  /* Save for later error message */
1705
1706 switch(rc)
1707   {
1708   case -1:                /* Transmission error */
1709   goto SEND_FAILED;
1710
1711   case +1:                /* Block was sent */
1712   if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1713        ob->command_timeout))
1714     {
1715     if (errno == 0 && buffer[0] == '4')
1716       {
1717       errno = ERRNO_MAIL4XX;
1718       addrlist->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
1719       }
1720     goto RESPONSE_FAILED;
1721     }
1722   pending_MAIL = FALSE;
1723   break;
1724   }
1725
1726 /* Pass over all the relevant recipient addresses for this host, which are the
1727 ones that have status PENDING_DEFER. If we are using PIPELINING, we can send
1728 several before we have to read the responses for those seen so far. This
1729 checking is done by a subroutine because it also needs to be done at the end.
1730 Send only up to max_rcpt addresses at a time, leaving first_addr pointing to
1731 the next one if not all are sent.
1732
1733 In the MUA wrapper situation, we want to flush the PIPELINING buffer for the
1734 last address because we want to abort if any recipients have any kind of
1735 problem, temporary or permanent. We know that all recipient addresses will have
1736 the PENDING_DEFER status, because only one attempt is ever made, and we know
1737 that max_rcpt will be large, so all addresses will be done at once. */
1738
1739 for (addr = first_addr;
1740      address_count < max_rcpt && addr != NULL;
1741      addr = addr->next)
1742   {
1743   int count;
1744   BOOL no_flush;
1745
1746   if (addr->transport_return != PENDING_DEFER) continue;
1747
1748   address_count++;
1749   no_flush = smtp_use_pipelining && (!mua_wrapper || addr->next != NULL);
1750
1751   /* Now send the RCPT command, and process outstanding responses when
1752   necessary. After a timeout on RCPT, we just end the function, leaving the
1753   yield as OK, because this error can often mean that there is a problem with
1754   just one address, so we don't want to delay the host. */
1755
1756   count = smtp_write_command(&outblock, no_flush, "RCPT TO:<%s>%s\r\n",
1757     transport_rcpt_address(addr, tblock->rcpt_include_affixes), igquotstr);
1758   if (count < 0) goto SEND_FAILED;
1759   if (count > 0)
1760     {
1761     switch(sync_responses(first_addr, tblock->rcpt_include_affixes,
1762              &sync_addr, host, count, ob->address_retry_include_sender,
1763              pending_MAIL, 0, &inblock, ob->command_timeout, buffer,
1764              sizeof(buffer)))
1765       {
1766       case 3: ok = TRUE;                   /* 2xx & 5xx => OK & progress made */
1767       case 2: completed_address = TRUE;    /* 5xx (only) => progress made */
1768       break;
1769
1770       case 1: ok = TRUE;                   /* 2xx (only) => OK, but if LMTP, */
1771       if (!lmtp) completed_address = TRUE; /* can't tell about progress yet */
1772       case 0:                              /* No 2xx or 5xx, but no probs */
1773       break;
1774
1775       case -1: goto END_OFF;               /* Timeout on RCPT */
1776       default: goto RESPONSE_FAILED;       /* I/O error, or any MAIL error */
1777       }
1778     pending_MAIL = FALSE;                  /* Dealt with MAIL */
1779     }
1780   }      /* Loop for next address */
1781
1782 /* If we are an MUA wrapper, abort if any RCPTs were rejected, either
1783 permanently or temporarily. We should have flushed and synced after the last
1784 RCPT. */
1785
1786 if (mua_wrapper)
1787   {
1788   address_item *badaddr;
1789   for (badaddr = first_addr; badaddr != NULL; badaddr = badaddr->next)
1790     {
1791     if (badaddr->transport_return != PENDING_OK) break;
1792     }
1793   if (badaddr != NULL)
1794     {
1795     set_errno(addrlist, 0, badaddr->message, FAIL,
1796       testflag(badaddr, af_pass_message));
1797     ok = FALSE;
1798     }
1799   }
1800
1801 /* If ok is TRUE, we know we have got at least one good recipient, and must now
1802 send DATA, but if it is FALSE (in the normal, non-wrapper case), we may still
1803 have a good recipient buffered up if we are pipelining. We don't want to waste
1804 time sending DATA needlessly, so we only send it if either ok is TRUE or if we
1805 are pipelining. The responses are all handled by sync_responses(). */
1806
1807 if (ok || (smtp_use_pipelining && !mua_wrapper))
1808   {
1809   int count = smtp_write_command(&outblock, FALSE, "DATA\r\n");
1810   if (count < 0) goto SEND_FAILED;
1811   switch(sync_responses(first_addr, tblock->rcpt_include_affixes, &sync_addr,
1812            host, count, ob->address_retry_include_sender, pending_MAIL,
1813            ok? +1 : -1, &inblock, ob->command_timeout, buffer, sizeof(buffer)))
1814     {
1815     case 3: ok = TRUE;                   /* 2xx & 5xx => OK & progress made */
1816     case 2: completed_address = TRUE;    /* 5xx (only) => progress made */
1817     break;
1818
1819     case 1: ok = TRUE;                   /* 2xx (only) => OK, but if LMTP, */
1820     if (!lmtp) completed_address = TRUE; /* can't tell about progress yet */
1821     case 0: break;                       /* No 2xx or 5xx, but no probs */
1822
1823     case -1: goto END_OFF;               /* Timeout on RCPT */
1824     default: goto RESPONSE_FAILED;       /* I/O error, or any MAIL/DATA error */
1825     }
1826   }
1827
1828 /* Save the first address of the next batch. */
1829
1830 first_addr = addr;
1831
1832 /* If there were no good recipients (but otherwise there have been no
1833 problems), just set ok TRUE, since we have handled address-specific errors
1834 already. Otherwise, it's OK to send the message. Use the check/escape mechanism
1835 for handling the SMTP dot-handling protocol, flagging to apply to headers as
1836 well as body. Set the appropriate timeout value to be used for each chunk.
1837 (Haven't been able to make it work using select() for writing yet.) */
1838
1839 if (!ok) ok = TRUE; else
1840   {
1841   sigalrm_seen = FALSE;
1842   transport_write_timeout = ob->data_timeout;
1843   smtp_command = US"sending data block";   /* For error messages */
1844   DEBUG(D_transport|D_v)
1845     debug_printf("  SMTP>> writing message and terminating \".\"\n");
1846   transport_count = 0;
1847 #ifndef DISABLE_DKIM
1848   ok = dkim_transport_write_message(addrlist, inblock.sock,
1849     topt_use_crlf | topt_end_dot | topt_escape_headers |
1850       (tblock->body_only? topt_no_headers : 0) |
1851       (tblock->headers_only? topt_no_body : 0) |
1852       (tblock->return_path_add? topt_add_return_path : 0) |
1853       (tblock->delivery_date_add? topt_add_delivery_date : 0) |
1854       (tblock->envelope_to_add? topt_add_envelope_to : 0),
1855     0,            /* No size limit */
1856     tblock->add_headers, tblock->remove_headers,
1857     US".", US"..",    /* Escaping strings */
1858     tblock->rewrite_rules, tblock->rewrite_existflags,
1859     ob->dkim_private_key, ob->dkim_domain, ob->dkim_selector,
1860     ob->dkim_canon, ob->dkim_strict, ob->dkim_sign_headers
1861     );
1862 #else
1863   ok = transport_write_message(addrlist, inblock.sock,
1864     topt_use_crlf | topt_end_dot | topt_escape_headers |
1865       (tblock->body_only? topt_no_headers : 0) |
1866       (tblock->headers_only? topt_no_body : 0) |
1867       (tblock->return_path_add? topt_add_return_path : 0) |
1868       (tblock->delivery_date_add? topt_add_delivery_date : 0) |
1869       (tblock->envelope_to_add? topt_add_envelope_to : 0),
1870     0,            /* No size limit */
1871     tblock->add_headers, tblock->remove_headers,
1872     US".", US"..",    /* Escaping strings */
1873     tblock->rewrite_rules, tblock->rewrite_existflags);
1874 #endif
1875
1876   /* transport_write_message() uses write() because it is called from other
1877   places to write to non-sockets. This means that under some OS (e.g. Solaris)
1878   it can exit with "Broken pipe" as its error. This really means that the
1879   socket got closed at the far end. */
1880
1881   transport_write_timeout = 0;   /* for subsequent transports */
1882
1883   /* Failure can either be some kind of I/O disaster (including timeout),
1884   or the failure of a transport filter or the expansion of added headers. */
1885
1886   if (!ok)
1887     {
1888     buffer[0] = 0;              /* There hasn't been a response */
1889     goto RESPONSE_FAILED;
1890     }
1891
1892   /* We used to send the terminating "." explicitly here, but because of
1893   buffering effects at both ends of TCP/IP connections, you don't gain
1894   anything by keeping it separate, so it might as well go in the final
1895   data buffer for efficiency. This is now done by setting the topt_end_dot
1896   flag above. */
1897
1898   smtp_command = US"end of data";
1899
1900 #ifdef EXPERIMENTAL_PRDR
1901   /* For PRDR we optionally get a partial-responses warning
1902    * followed by the individual responses, before going on with
1903    * the overall response.  If we don't get the warning then deal
1904    * with per non-PRDR. */
1905   if(prdr_active)
1906     {
1907     ok = smtp_read_response(&inblock, buffer, sizeof(buffer), '3',
1908       ob->final_timeout);
1909     if (!ok && errno == 0)
1910       switch(buffer[0])
1911         {
1912         case '2': prdr_active = FALSE;
1913                   ok = TRUE;
1914                   break;
1915         case '4': errno = ERRNO_DATA4XX;
1916                   addrlist->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
1917                   break;
1918         }
1919     }
1920   else
1921 #endif
1922
1923   /* For non-PRDR SMTP, we now read a single response that applies to the
1924   whole message.  If it is OK, then all the addresses have been delivered. */
1925
1926   if (!lmtp)
1927     {
1928     ok = smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
1929       ob->final_timeout);
1930     if (!ok && errno == 0 && buffer[0] == '4')
1931       {
1932       errno = ERRNO_DATA4XX;
1933       addrlist->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
1934       }
1935     }
1936
1937   /* For LMTP, we get back a response for every RCPT command that we sent;
1938   some may be accepted and some rejected. For those that get a response, their
1939   status is fixed; any that are accepted have been handed over, even if later
1940   responses crash - at least, that's how I read RFC 2033.
1941
1942   If all went well, mark the recipient addresses as completed, record which
1943   host/IPaddress they were delivered to, and cut out RSET when sending another
1944   message down the same channel. Write the completed addresses to the journal
1945   now so that they are recorded in case there is a crash of hardware or
1946   software before the spool gets updated. Also record the final SMTP
1947   confirmation if needed (for SMTP only). */
1948
1949   if (ok)
1950     {
1951     int flag = '=';
1952     int delivery_time = (int)(time(NULL) - start_delivery_time);
1953     int len;
1954     host_item *thost;
1955     uschar *conf = NULL;
1956     send_rset = FALSE;
1957
1958     /* Make a copy of the host if it is local to this invocation
1959     of the transport. */
1960
1961     if (copy_host)
1962       {
1963       thost = store_get(sizeof(host_item));
1964       *thost = *host;
1965       thost->name = string_copy(host->name);
1966       thost->address = string_copy(host->address);
1967       }
1968     else thost = host;
1969
1970     /* Set up confirmation if needed - applies only to SMTP */
1971
1972     if (
1973                 #ifndef EXPERIMENTAL_DBL
1974                         (log_extra_selector & LX_smtp_confirmation) != 0 &&
1975                 #endif
1976                         !lmtp
1977          )
1978       {
1979       uschar *s = string_printing(buffer);
1980       conf = (s == buffer)? (uschar *)string_copy(s) : s;
1981       }
1982
1983     /* Process all transported addresses - for LMTP or PRDR, read a status for
1984     each one. */
1985
1986     for (addr = addrlist; addr != first_addr; addr = addr->next)
1987       {
1988       if (addr->transport_return != PENDING_OK) continue;
1989
1990       /* LMTP - if the response fails badly (e.g. timeout), use it for all the
1991       remaining addresses. Otherwise, it's a return code for just the one
1992       address. For temporary errors, add a retry item for the address so that
1993       it doesn't get tried again too soon. */
1994
1995 #ifdef EXPERIMENTAL_PRDR
1996       if (lmtp || prdr_active)
1997 #else
1998       if (lmtp)
1999 #endif
2000         {
2001         if (!smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
2002             ob->final_timeout))
2003           {
2004           if (errno != 0 || buffer[0] == 0) goto RESPONSE_FAILED;
2005           addr->message = string_sprintf(
2006 #ifdef EXPERIMENTAL_PRDR
2007             "%s error after %s: %s", prdr_active ? "PRDR":"LMTP",
2008 #else
2009             "LMTP error after %s: %s",
2010 #endif
2011             big_buffer, string_printing(buffer));
2012           setflag(addr, af_pass_message);   /* Allow message to go to user */
2013           if (buffer[0] == '5')
2014             addr->transport_return = FAIL;
2015           else
2016             {
2017             errno = ERRNO_DATA4XX;
2018             addr->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
2019             addr->transport_return = DEFER;
2020 #ifdef EXPERIMENTAL_PRDR
2021             if (!prdr_active)
2022 #endif
2023               retry_add_item(addr, addr->address_retry_key, 0);
2024             }
2025           continue;
2026           }
2027         completed_address = TRUE;   /* NOW we can set this flag */
2028         if ((log_extra_selector & LX_smtp_confirmation) != 0)
2029           {
2030           uschar *s = string_printing(buffer);
2031           conf = (s == buffer)? (uschar *)string_copy(s) : s;
2032           }
2033         }
2034
2035       /* SMTP, or success return from LMTP for this address. Pass back the
2036       actual host that was used. */
2037
2038       addr->transport_return = OK;
2039       addr->more_errno = delivery_time;
2040       addr->host_used = thost;
2041       addr->special_action = flag;
2042       addr->message = conf;
2043 #ifdef EXPERIMENTAL_PRDR
2044       if (prdr_active) addr->flags |= af_prdr_used;
2045 #endif
2046       flag = '-';
2047
2048 #ifdef EXPERIMENTAL_PRDR
2049       if (!prdr_active)
2050 #endif
2051         {
2052         /* Update the journal. For homonymic addresses, use the base address plus
2053         the transport name. See lots of comments in deliver.c about the reasons
2054         for the complications when homonyms are involved. Just carry on after
2055         write error, as it may prove possible to update the spool file later. */
2056   
2057         if (testflag(addr, af_homonym))
2058           sprintf(CS buffer, "%.500s/%s\n", addr->unique + 3, tblock->name);
2059         else
2060           sprintf(CS buffer, "%.500s\n", addr->unique);
2061   
2062         DEBUG(D_deliver) debug_printf("journalling %s", buffer);
2063         len = Ustrlen(CS buffer);
2064         if (write(journal_fd, buffer, len) != len)
2065           log_write(0, LOG_MAIN|LOG_PANIC, "failed to write journal for "
2066             "%s: %s", buffer, strerror(errno));
2067         }
2068       }
2069
2070 #ifdef EXPERIMENTAL_PRDR
2071       if (prdr_active)
2072         {
2073         /* PRDR - get the final, overall response.  For any non-success
2074         upgrade all the address statuses. */
2075         ok = smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
2076           ob->final_timeout);
2077         if (!ok)
2078           {
2079           if(errno == 0 && buffer[0] == '4')
2080             {
2081             errno = ERRNO_DATA4XX;
2082             addrlist->more_errno |= ((buffer[1] - '0')*10 + buffer[2] - '0') << 8;
2083             }
2084           for (addr = addrlist; addr != first_addr; addr = addr->next)
2085             if (buffer[0] == '5' || addr->transport_return == OK)
2086               addr->transport_return = PENDING_OK; /* allow set_errno action */
2087           goto RESPONSE_FAILED;
2088           }
2089
2090         /* Update the journal, or setup retry. */
2091         for (addr = addrlist; addr != first_addr; addr = addr->next)
2092           if (addr->transport_return == OK)
2093           {
2094           if (testflag(addr, af_homonym))
2095             sprintf(CS buffer, "%.500s/%s\n", addr->unique + 3, tblock->name);
2096           else
2097             sprintf(CS buffer, "%.500s\n", addr->unique);
2098   
2099           DEBUG(D_deliver) debug_printf("journalling(PRDR) %s", buffer);
2100           len = Ustrlen(CS buffer);
2101           if (write(journal_fd, buffer, len) != len)
2102             log_write(0, LOG_MAIN|LOG_PANIC, "failed to write journal for "
2103               "%s: %s", buffer, strerror(errno));
2104           }
2105         else if (addr->transport_return == DEFER)
2106           retry_add_item(addr, addr->address_retry_key, -2);
2107         }
2108 #endif
2109
2110     /* Ensure the journal file is pushed out to disk. */
2111
2112     if (EXIMfsync(journal_fd) < 0)
2113       log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2114         strerror(errno));
2115     }
2116   }
2117
2118
2119 /* Handle general (not specific to one address) failures here. The value of ok
2120 is used to skip over this code on the falling through case. A timeout causes a
2121 deferral. Other errors may defer or fail according to the response code, and
2122 may set up a special errno value, e.g. after connection chopped, which is
2123 assumed if errno == 0 and there is no text in the buffer. If control reaches
2124 here during the setting up phase (i.e. before MAIL FROM) then always defer, as
2125 the problem is not related to this specific message. */
2126
2127 if (!ok)
2128   {
2129   int code;
2130
2131   RESPONSE_FAILED:
2132   save_errno = errno;
2133   message = NULL;
2134   send_quit = check_response(host, &save_errno, addrlist->more_errno,
2135     buffer, &code, &message, &pass_message);
2136   goto FAILED;
2137
2138   SEND_FAILED:
2139   save_errno = errno;
2140   code = '4';
2141   message = US string_sprintf("send() to %s [%s] failed: %s",
2142     host->name, host->address, strerror(save_errno));
2143   send_quit = FALSE;
2144   goto FAILED;
2145
2146   /* This label is jumped to directly when a TLS negotiation has failed,
2147   or was not done for a host for which it is required. Values will be set
2148   in message and save_errno, and setting_up will always be true. Treat as
2149   a temporary error. */
2150
2151   #ifdef SUPPORT_TLS
2152   TLS_FAILED:
2153   code = '4';
2154   #endif
2155
2156   /* If the failure happened while setting up the call, see if the failure was
2157   a 5xx response (this will either be on connection, or following HELO - a 5xx
2158   after EHLO causes it to try HELO). If so, fail all addresses, as this host is
2159   never going to accept them. For other errors during setting up (timeouts or
2160   whatever), defer all addresses, and yield DEFER, so that the host is not
2161   tried again for a while. */
2162
2163   FAILED:
2164   ok = FALSE;                /* For when reached by GOTO */
2165
2166   if (setting_up)
2167     {
2168     if (code == '5')
2169       {
2170       set_errno(addrlist, save_errno, message, FAIL, pass_message);
2171       }
2172     else
2173       {
2174       set_errno(addrlist, save_errno, message, DEFER, pass_message);
2175       yield = DEFER;
2176       }
2177     }
2178
2179   /* We want to handle timeouts after MAIL or "." and loss of connection after
2180   "." specially. They can indicate a problem with the sender address or with
2181   the contents of the message rather than a real error on the connection. These
2182   cases are treated in the same way as a 4xx response. This next bit of code
2183   does the classification. */
2184
2185   else
2186     {
2187     BOOL message_error;
2188
2189     switch(save_errno)
2190       {
2191       case 0:
2192       case ERRNO_MAIL4XX:
2193       case ERRNO_DATA4XX:
2194       message_error = TRUE;
2195       break;
2196
2197       case ETIMEDOUT:
2198       message_error = Ustrncmp(smtp_command,"MAIL",4) == 0 ||
2199                       Ustrncmp(smtp_command,"end ",4) == 0;
2200       break;
2201
2202       case ERRNO_SMTPCLOSED:
2203       message_error = Ustrncmp(smtp_command,"end ",4) == 0;
2204       break;
2205
2206       default:
2207       message_error = FALSE;
2208       break;
2209       }
2210
2211     /* Handle the cases that are treated as message errors. These are:
2212
2213       (a) negative response or timeout after MAIL
2214       (b) negative response after DATA
2215       (c) negative response or timeout or dropped connection after "."
2216
2217     It won't be a negative response or timeout after RCPT, as that is dealt
2218     with separately above. The action in all cases is to set an appropriate
2219     error code for all the addresses, but to leave yield set to OK because the
2220     host itself has not failed. Of course, it might in practice have failed
2221     when we've had a timeout, but if so, we'll discover that at the next
2222     delivery attempt. For a temporary error, set the message_defer flag, and
2223     write to the logs for information if this is not the last host. The error
2224     for the last host will be logged as part of the address's log line. */
2225
2226     if (message_error)
2227       {
2228       if (mua_wrapper) code = '5';  /* Force hard failure in wrapper mode */
2229       set_errno(addrlist, save_errno, message, (code == '5')? FAIL : DEFER,
2230         pass_message);
2231
2232       /* If there's an errno, the message contains just the identity of
2233       the host. */
2234
2235       if (code != '5')     /* Anything other than 5 is treated as temporary */
2236         {
2237         if (save_errno > 0)
2238           message = US string_sprintf("%s: %s", message, strerror(save_errno));
2239         if (host->next != NULL) log_write(0, LOG_MAIN, "%s", message);
2240         deliver_msglog("%s %s\n", tod_stamp(tod_log), message);
2241         *message_defer = TRUE;
2242         }
2243       }
2244
2245     /* Otherwise, we have an I/O error or a timeout other than after MAIL or
2246     ".", or some other transportation error. We defer all addresses and yield
2247     DEFER, except for the case of failed add_headers expansion, or a transport
2248     filter failure, when the yield should be ERROR, to stop it trying other
2249     hosts. */
2250
2251     else
2252       {
2253       yield = (save_errno == ERRNO_CHHEADER_FAIL ||
2254                save_errno == ERRNO_FILTER_FAIL)? ERROR : DEFER;
2255       set_errno(addrlist, save_errno, message, DEFER, pass_message);
2256       }
2257     }
2258   }
2259
2260
2261 /* If all has gone well, send_quit will be set TRUE, implying we can end the
2262 SMTP session tidily. However, if there were too many addresses to send in one
2263 message (indicated by first_addr being non-NULL) we want to carry on with the
2264 rest of them. Also, it is desirable to send more than one message down the SMTP
2265 connection if there are several waiting, provided we haven't already sent so
2266 many as to hit the configured limit. The function transport_check_waiting looks
2267 for a waiting message and returns its id. Then transport_pass_socket tries to
2268 set up a continued delivery by passing the socket on to another process. The
2269 variable send_rset is FALSE if a message has just been successfully transfered.
2270
2271 If we are already sending down a continued channel, there may be further
2272 addresses not yet delivered that are aimed at the same host, but which have not
2273 been passed in this run of the transport. In this case, continue_more will be
2274 true, and all we should do is send RSET if necessary, and return, leaving the
2275 channel open.
2276
2277 However, if no address was disposed of, i.e. all addresses got 4xx errors, we
2278 do not want to continue with other messages down the same channel, because that
2279 can lead to looping between two or more messages, all with the same,
2280 temporarily failing address(es). [The retry information isn't updated yet, so
2281 new processes keep on trying.] We probably also don't want to try more of this
2282 message's addresses either.
2283
2284 If we have started a TLS session, we have to end it before passing the
2285 connection to a new process. However, not all servers can handle this (Exim
2286 can), so we do not pass such a connection on if the host matches
2287 hosts_nopass_tls. */
2288
2289 DEBUG(D_transport)
2290   debug_printf("ok=%d send_quit=%d send_rset=%d continue_more=%d "
2291     "yield=%d first_address is %sNULL\n", ok, send_quit, send_rset,
2292     continue_more, yield, (first_addr == NULL)? "":"not ");
2293
2294 if (completed_address && ok && send_quit)
2295   {
2296   BOOL more;
2297   if (first_addr != NULL || continue_more ||
2298         (
2299            (tls_out.active < 0 ||
2300            verify_check_this_host(&(ob->hosts_nopass_tls), NULL, host->name,
2301              host->address, NULL) != OK)
2302         &&
2303            transport_check_waiting(tblock->name, host->name,
2304              tblock->connection_max_messages, new_message_id, &more)
2305         ))
2306     {
2307     uschar *msg;
2308     BOOL pass_message;
2309
2310     if (send_rset)
2311       {
2312       if (! (ok = smtp_write_command(&outblock, FALSE, "RSET\r\n") >= 0))
2313         {
2314         msg = US string_sprintf("send() to %s [%s] failed: %s", host->name,
2315           host->address, strerror(save_errno));
2316         send_quit = FALSE;
2317         }
2318       else if (! (ok = smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
2319                   ob->command_timeout)))
2320         {
2321         int code;
2322         send_quit = check_response(host, &errno, 0, buffer, &code, &msg,
2323           &pass_message);
2324         if (!send_quit)
2325           {
2326           DEBUG(D_transport) debug_printf("%s\n", msg);
2327           }
2328         }
2329       }
2330
2331     /* Either RSET was not needed, or it succeeded */
2332
2333     if (ok)
2334       {
2335       if (first_addr != NULL)            /* More addresses still to be sent */
2336         {                                /*   in this run of the transport */
2337         continue_sequence++;             /* Causes * in logging */
2338         goto SEND_MESSAGE;
2339         }
2340       if (continue_more) return yield;   /* More addresses for another run */
2341
2342       /* Pass the socket to a new Exim process. Before doing so, we must shut
2343       down TLS. Not all MTAs allow for the continuation of the SMTP session
2344       when TLS is shut down. We test for this by sending a new EHLO. If we
2345       don't get a good response, we don't attempt to pass the socket on. */
2346
2347       #ifdef SUPPORT_TLS
2348       if (tls_out.active >= 0)
2349         {
2350         tls_close(FALSE, TRUE);
2351         if (smtps)
2352           ok = FALSE;
2353         else
2354           ok = smtp_write_command(&outblock,FALSE,"EHLO %s\r\n",helo_data) >= 0 &&
2355                smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
2356                  ob->command_timeout);
2357         }
2358       #endif
2359
2360       /* If the socket is successfully passed, we musn't send QUIT (or
2361       indeed anything!) from here. */
2362
2363       if (ok && transport_pass_socket(tblock->name, host->name, host->address,
2364             new_message_id, inblock.sock))
2365         {
2366         send_quit = FALSE;
2367         }
2368       }
2369
2370     /* If RSET failed and there are addresses left, they get deferred. */
2371
2372     else set_errno(first_addr, errno, msg, DEFER, FALSE);
2373     }
2374   }
2375
2376 /* End off tidily with QUIT unless the connection has died or the socket has
2377 been passed to another process. There has been discussion on the net about what
2378 to do after sending QUIT. The wording of the RFC suggests that it is necessary
2379 to wait for a response, but on the other hand, there isn't anything one can do
2380 with an error response, other than log it. Exim used to do that. However,
2381 further discussion suggested that it is positively advantageous not to wait for
2382 the response, but to close the session immediately. This is supposed to move
2383 the TCP/IP TIME_WAIT state from the server to the client, thereby removing some
2384 load from the server. (Hosts that are both servers and clients may not see much
2385 difference, of course.) Further discussion indicated that this was safe to do
2386 on Unix systems which have decent implementations of TCP/IP that leave the
2387 connection around for a while (TIME_WAIT) after the application has gone away.
2388 This enables the response sent by the server to be properly ACKed rather than
2389 timed out, as can happen on broken TCP/IP implementations on other OS.
2390
2391 This change is being made on 31-Jul-98. After over a year of trouble-free
2392 operation, the old commented-out code was removed on 17-Sep-99. */
2393
2394 SEND_QUIT:
2395 if (send_quit) (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
2396
2397 END_OFF:
2398
2399 #ifdef SUPPORT_TLS
2400 tls_close(FALSE, TRUE);
2401 #endif
2402
2403 /* Close the socket, and return the appropriate value, first setting
2404 continue_transport and continue_hostname NULL to prevent any other addresses
2405 that may include the host from trying to re-use a continuation socket. This
2406 works because the NULL setting is passed back to the calling process, and
2407 remote_max_parallel is forced to 1 when delivering over an existing connection,
2408
2409 If all went well and continue_more is set, we shouldn't actually get here if
2410 there are further addresses, as the return above will be taken. However,
2411 writing RSET might have failed, or there may be other addresses whose hosts are
2412 specified in the transports, and therefore not visible at top level, in which
2413 case continue_more won't get set. */
2414
2415 (void)close(inblock.sock);
2416 continue_transport = NULL;
2417 continue_hostname = NULL;
2418 return yield;
2419 }
2420
2421
2422
2423
2424 /*************************************************
2425 *              Closedown entry point             *
2426 *************************************************/
2427
2428 /* This function is called when exim is passed an open smtp channel
2429 from another incarnation, but the message which it has been asked
2430 to deliver no longer exists. The channel is on stdin.
2431
2432 We might do fancy things like looking for another message to send down
2433 the channel, but if the one we sought has gone, it has probably been
2434 delivered by some other process that itself will seek further messages,
2435 so just close down our connection.
2436
2437 Argument:   pointer to the transport instance block
2438 Returns:    nothing
2439 */
2440
2441 void
2442 smtp_transport_closedown(transport_instance *tblock)
2443 {
2444 smtp_transport_options_block *ob =
2445   (smtp_transport_options_block *)(tblock->options_block);
2446 smtp_inblock inblock;
2447 smtp_outblock outblock;
2448 uschar buffer[256];
2449 uschar inbuffer[4096];
2450 uschar outbuffer[16];
2451
2452 inblock.sock = fileno(stdin);
2453 inblock.buffer = inbuffer;
2454 inblock.buffersize = sizeof(inbuffer);
2455 inblock.ptr = inbuffer;
2456 inblock.ptrend = inbuffer;
2457
2458 outblock.sock = inblock.sock;
2459 outblock.buffersize = sizeof(outbuffer);
2460 outblock.buffer = outbuffer;
2461 outblock.ptr = outbuffer;
2462 outblock.cmd_count = 0;
2463 outblock.authenticating = FALSE;
2464
2465 (void)smtp_write_command(&outblock, FALSE, "QUIT\r\n");
2466 (void)smtp_read_response(&inblock, buffer, sizeof(buffer), '2',
2467   ob->command_timeout);
2468 (void)close(inblock.sock);
2469 }
2470
2471
2472
2473 /*************************************************
2474 *            Prepare addresses for delivery      *
2475 *************************************************/
2476
2477 /* This function is called to flush out error settings from previous delivery
2478 attempts to other hosts. It also records whether we got here via an MX record
2479 or not in the more_errno field of the address. We are interested only in
2480 addresses that are still marked DEFER - others may have got delivered to a
2481 previously considered IP address. Set their status to PENDING_DEFER to indicate
2482 which ones are relevant this time.
2483
2484 Arguments:
2485   addrlist     the list of addresses
2486   host         the host we are delivering to
2487
2488 Returns:       the first address for this delivery
2489 */
2490
2491 static address_item *
2492 prepare_addresses(address_item *addrlist, host_item *host)
2493 {
2494 address_item *first_addr = NULL;
2495 address_item *addr;
2496 for (addr = addrlist; addr != NULL; addr = addr->next)
2497   {
2498   if (addr->transport_return != DEFER) continue;
2499   if (first_addr == NULL) first_addr = addr;
2500   addr->transport_return = PENDING_DEFER;
2501   addr->basic_errno = 0;
2502   addr->more_errno = (host->mx >= 0)? 'M' : 'A';
2503   addr->message = NULL;
2504   #ifdef SUPPORT_TLS
2505   addr->cipher = NULL;
2506   addr->peerdn = NULL;
2507   #endif
2508   }
2509 return first_addr;
2510 }
2511
2512
2513
2514 /*************************************************
2515 *              Main entry point                  *
2516 *************************************************/
2517
2518 /* See local README for interface details. As this is a remote transport, it is
2519 given a chain of addresses to be delivered in one connection, if possible. It
2520 always returns TRUE, indicating that each address has its own independent
2521 status set, except if there is a setting up problem, in which case it returns
2522 FALSE. */
2523
2524 BOOL
2525 smtp_transport_entry(
2526   transport_instance *tblock,      /* data for this instantiation */
2527   address_item *addrlist)          /* addresses we are working on */
2528 {
2529 int cutoff_retry;
2530 int port;
2531 int hosts_defer = 0;
2532 int hosts_fail  = 0;
2533 int hosts_looked_up = 0;
2534 int hosts_retry = 0;
2535 int hosts_serial = 0;
2536 int hosts_total = 0;
2537 int total_hosts_tried = 0;
2538 address_item *addr;
2539 BOOL expired = TRUE;
2540 BOOL continuing = continue_hostname != NULL;
2541 uschar *expanded_hosts = NULL;
2542 uschar *pistring;
2543 uschar *tid = string_sprintf("%s transport", tblock->name);
2544 smtp_transport_options_block *ob =
2545   (smtp_transport_options_block *)(tblock->options_block);
2546 host_item *hostlist = addrlist->host_list;
2547 host_item *host = NULL;
2548
2549 DEBUG(D_transport)
2550   {
2551   debug_printf("%s transport entered\n", tblock->name);
2552   for (addr = addrlist; addr != NULL; addr = addr->next)
2553     debug_printf("  %s\n", addr->address);
2554   if (continuing) debug_printf("already connected to %s [%s]\n",
2555       continue_hostname, continue_host_address);
2556   }
2557
2558 /* Set the flag requesting that these hosts be added to the waiting
2559 database if the delivery fails temporarily or if we are running with
2560 queue_smtp or a 2-stage queue run. This gets unset for certain
2561 kinds of error, typically those that are specific to the message. */
2562
2563 update_waiting =  TRUE;
2564
2565 /* If a host list is not defined for the addresses - they must all have the
2566 same one in order to be passed to a single transport - or if the transport has
2567 a host list with hosts_override set, use the host list supplied with the
2568 transport. It is an error for this not to exist. */
2569
2570 if (hostlist == NULL || (ob->hosts_override && ob->hosts != NULL))
2571   {
2572   if (ob->hosts == NULL)
2573     {
2574     addrlist->message = string_sprintf("%s transport called with no hosts set",
2575       tblock->name);
2576     addrlist->transport_return = PANIC;
2577     return FALSE;   /* Only top address has status */
2578     }
2579
2580   DEBUG(D_transport) debug_printf("using the transport's hosts: %s\n",
2581     ob->hosts);
2582
2583   /* If the transport's host list contains no '$' characters, and we are not
2584   randomizing, it is fixed and therefore a chain of hosts can be built once
2585   and for all, and remembered for subsequent use by other calls to this
2586   transport. If, on the other hand, the host list does contain '$', or we are
2587   randomizing its order, we have to rebuild it each time. In the fixed case,
2588   as the hosts string will never be used again, it doesn't matter that we
2589   replace all the : characters with zeros. */
2590
2591   if (ob->hostlist == NULL)
2592     {
2593     uschar *s = ob->hosts;
2594
2595     if (Ustrchr(s, '$') != NULL)
2596       {
2597       expanded_hosts = expand_string(s);
2598       if (expanded_hosts == NULL)
2599         {
2600         addrlist->message = string_sprintf("failed to expand list of hosts "
2601           "\"%s\" in %s transport: %s", s, tblock->name, expand_string_message);
2602         addrlist->transport_return = search_find_defer? DEFER : PANIC;
2603         return FALSE;     /* Only top address has status */
2604         }
2605       DEBUG(D_transport) debug_printf("expanded list of hosts \"%s\" to "
2606         "\"%s\"\n", s, expanded_hosts);
2607       s = expanded_hosts;
2608       }
2609     else
2610       if (ob->hosts_randomize) s = expanded_hosts = string_copy(s);
2611
2612     host_build_hostlist(&hostlist, s, ob->hosts_randomize);
2613
2614     /* Check that the expansion yielded something useful. */
2615     if (hostlist == NULL)
2616       {
2617       addrlist->message =
2618         string_sprintf("%s transport has empty hosts setting", tblock->name);
2619       addrlist->transport_return = PANIC;
2620       return FALSE;   /* Only top address has status */
2621       }
2622
2623     /* If there was no expansion of hosts, save the host list for
2624     next time. */
2625
2626     if (expanded_hosts == NULL) ob->hostlist = hostlist;
2627     }
2628
2629   /* This is not the first time this transport has been run in this delivery;
2630   the host list was built previously. */
2631
2632   else hostlist = ob->hostlist;
2633   }
2634
2635 /* The host list was supplied with the address. If hosts_randomize is set, we
2636 must sort it into a random order if it did not come from MX records and has not
2637 already been randomized (but don't bother if continuing down an existing
2638 connection). */
2639
2640 else if (ob->hosts_randomize && hostlist->mx == MX_NONE && !continuing)
2641   {
2642   host_item *newlist = NULL;
2643   while (hostlist != NULL)
2644     {
2645     host_item *h = hostlist;
2646     hostlist = hostlist->next;
2647
2648     h->sort_key = random_number(100);
2649
2650     if (newlist == NULL)
2651       {
2652       h->next = NULL;
2653       newlist = h;
2654       }
2655     else if (h->sort_key < newlist->sort_key)
2656       {
2657       h->next = newlist;
2658       newlist = h;
2659       }
2660     else
2661       {
2662       host_item *hh = newlist;
2663       while (hh->next != NULL)
2664         {
2665         if (h->sort_key < hh->next->sort_key) break;
2666         hh = hh->next;
2667         }
2668       h->next = hh->next;
2669       hh->next = h;
2670       }
2671     }
2672
2673   hostlist = addrlist->host_list = newlist;
2674   }
2675
2676
2677 /* Sort out the default port.  */
2678
2679 if (!smtp_get_port(ob->port, addrlist, &port, tid)) return FALSE;
2680
2681
2682 /* For each host-plus-IP-address on the list:
2683
2684 .  If this is a continued delivery and the host isn't the one with the
2685    current connection, skip.
2686
2687 .  If the status is unusable (i.e. previously failed or retry checked), skip.
2688
2689 .  If no IP address set, get the address, either by turning the name into
2690    an address, calling gethostbyname if gethostbyname is on, or by calling
2691    the DNS. The DNS may yield multiple addresses, in which case insert the
2692    extra ones into the list.
2693
2694 .  Get the retry data if not previously obtained for this address and set the
2695    field which remembers the state of this address. Skip if the retry time is
2696    not reached. If not, remember whether retry data was found. The retry string
2697    contains both the name and the IP address.
2698
2699 .  Scan the list of addresses and mark those whose status is DEFER as
2700    PENDING_DEFER. These are the only ones that will be processed in this cycle
2701    of the hosts loop.
2702
2703 .  Make a delivery attempt - addresses marked PENDING_DEFER will be tried.
2704    Some addresses may be successfully delivered, others may fail, and yet
2705    others may get temporary errors and so get marked DEFER.
2706
2707 .  The return from the delivery attempt is OK if a connection was made and a
2708    valid SMTP dialogue was completed. Otherwise it is DEFER.
2709
2710 .  If OK, add a "remove" retry item for this host/IPaddress, if any.
2711
2712 .  If fail to connect, or other defer state, add a retry item.
2713
2714 .  If there are any addresses whose status is still DEFER, carry on to the
2715    next host/IPaddress, unless we have tried the number of hosts given
2716    by hosts_max_try or hosts_max_try_hardlimit; otherwise return. Note that
2717    there is some fancy logic for hosts_max_try that means its limit can be
2718    overstepped in some circumstances.
2719
2720 If we get to the end of the list, all hosts have deferred at least one address,
2721 or not reached their retry times. If delay_after_cutoff is unset, it requests a
2722 delivery attempt to those hosts whose last try was before the arrival time of
2723 the current message. To cope with this, we have to go round the loop a second
2724 time. After that, set the status and error data for any addresses that haven't
2725 had it set already. */
2726
2727 for (cutoff_retry = 0; expired &&
2728      cutoff_retry < ((ob->delay_after_cutoff)? 1 : 2);
2729      cutoff_retry++)
2730   {
2731   host_item *nexthost = NULL;
2732   int unexpired_hosts_tried = 0;
2733
2734   for (host = hostlist;
2735        host != NULL &&
2736          unexpired_hosts_tried < ob->hosts_max_try &&
2737          total_hosts_tried < ob->hosts_max_try_hardlimit;
2738        host = nexthost)
2739     {
2740     int rc;
2741     int host_af;
2742     uschar *rs;
2743     BOOL serialized = FALSE;
2744     BOOL host_is_expired = FALSE;
2745     BOOL message_defer = FALSE;
2746     BOOL ifchanges = FALSE;
2747     BOOL some_deferred = FALSE;
2748     address_item *first_addr = NULL;
2749     uschar *interface = NULL;
2750     uschar *retry_host_key = NULL;
2751     uschar *retry_message_key = NULL;
2752     uschar *serialize_key = NULL;
2753
2754     /* Default next host is next host. :-) But this can vary if the
2755     hosts_max_try limit is hit (see below). It may also be reset if a host
2756     address is looked up here (in case the host was multihomed). */
2757
2758     nexthost = host->next;
2759
2760     /* If the address hasn't yet been obtained from the host name, look it up
2761     now, unless the host is already marked as unusable. If it is marked as
2762     unusable, it means that the router was unable to find its IP address (in
2763     the DNS or wherever) OR we are in the 2nd time round the cutoff loop, and
2764     the lookup failed last time. We don't get this far if *all* MX records
2765     point to non-existent hosts; that is treated as a hard error.
2766
2767     We can just skip this host entirely. When the hosts came from the router,
2768     the address will timeout based on the other host(s); when the address is
2769     looked up below, there is an explicit retry record added.
2770
2771     Note that we mustn't skip unusable hosts if the address is not unset; they
2772     may be needed as expired hosts on the 2nd time round the cutoff loop. */
2773
2774     if (host->address == NULL)
2775       {
2776       int new_port, flags;
2777       host_item *hh;
2778       uschar *canonical_name;
2779
2780       if (host->status >= hstatus_unusable)
2781         {
2782         DEBUG(D_transport) debug_printf("%s has no address and is unusable - skipping\n",
2783           host->name);
2784         continue;
2785         }
2786
2787       DEBUG(D_transport) debug_printf("getting address for %s\n", host->name);
2788
2789       /* The host name is permitted to have an attached port. Find it, and
2790       strip it from the name. Just remember it for now. */
2791
2792       new_port = host_item_get_port(host);
2793
2794       /* Count hosts looked up */
2795
2796       hosts_looked_up++;
2797
2798       /* Find by name if so configured, or if it's an IP address. We don't
2799       just copy the IP address, because we need the test-for-local to happen. */
2800
2801       flags = HOST_FIND_BY_A;
2802       if (ob->dns_qualify_single) flags |= HOST_FIND_QUALIFY_SINGLE;
2803       if (ob->dns_search_parents) flags |= HOST_FIND_SEARCH_PARENTS;
2804
2805       if (ob->gethostbyname || string_is_ip_address(host->name, NULL) != 0)
2806         rc = host_find_byname(host, NULL, flags, &canonical_name, TRUE);
2807       else
2808         rc = host_find_bydns(host, NULL, flags, NULL, NULL, NULL,
2809           &canonical_name, NULL);
2810
2811       /* Update the host (and any additional blocks, resulting from
2812       multihoming) with a host-specific port, if any. */
2813
2814       for (hh = host; hh != nexthost; hh = hh->next) hh->port = new_port;
2815
2816       /* Failure to find the host at this time (usually DNS temporary failure)
2817       is really a kind of routing failure rather than a transport failure.
2818       Therefore we add a retry item of the routing kind, not to stop us trying
2819       to look this name up here again, but to ensure the address gets timed
2820       out if the failures go on long enough. A complete failure at this point
2821       commonly points to a configuration error, but the best action is still
2822       to carry on for the next host. */
2823
2824       if (rc == HOST_FIND_AGAIN || rc == HOST_FIND_FAILED)
2825         {
2826         retry_add_item(addrlist, string_sprintf("R:%s", host->name), 0);
2827         expired = FALSE;
2828         if (rc == HOST_FIND_AGAIN) hosts_defer++; else hosts_fail++;
2829         DEBUG(D_transport) debug_printf("rc = %s for %s\n", (rc == HOST_FIND_AGAIN)?
2830           "HOST_FIND_AGAIN" : "HOST_FIND_FAILED", host->name);
2831         host->status = hstatus_unusable;
2832
2833         for (addr = addrlist; addr != NULL; addr = addr->next)
2834           {
2835           if (addr->transport_return != DEFER) continue;
2836           addr->basic_errno = ERRNO_UNKNOWNHOST;
2837           addr->message =
2838             string_sprintf("failed to lookup IP address for %s", host->name);
2839           }
2840         continue;
2841         }
2842
2843       /* If the host is actually the local host, we may have a problem, or
2844       there may be some cunning configuration going on. In the problem case,
2845       log things and give up. The default transport status is already DEFER. */
2846
2847       if (rc == HOST_FOUND_LOCAL && !ob->allow_localhost)
2848         {
2849         for (addr = addrlist; addr != NULL; addr = addr->next)
2850           {
2851           addr->basic_errno = 0;
2852           addr->message = string_sprintf("%s transport found host %s to be "
2853             "local", tblock->name, host->name);
2854           }
2855         goto END_TRANSPORT;
2856         }
2857       }   /* End of block for IP address lookup */
2858
2859     /* If this is a continued delivery, we are interested only in the host
2860     which matches the name of the existing open channel. The check is put
2861     here after the local host lookup, in case the name gets expanded as a
2862     result of the lookup. Set expired FALSE, to save the outer loop executing
2863     twice. */
2864
2865     if (continuing && (Ustrcmp(continue_hostname, host->name) != 0 ||
2866                        Ustrcmp(continue_host_address, host->address) != 0))
2867       {
2868       expired = FALSE;
2869       continue;      /* With next host */
2870       }
2871
2872     /* Reset the default next host in case a multihomed host whose addresses
2873     are not looked up till just above added to the host list. */
2874
2875     nexthost = host->next;
2876
2877     /* If queue_smtp is set (-odqs or the first part of a 2-stage run), or the
2878     domain is in queue_smtp_domains, we don't actually want to attempt any
2879     deliveries. When doing a queue run, queue_smtp_domains is always unset. If
2880     there is a lookup defer in queue_smtp_domains, proceed as if the domain
2881     were not in it. We don't want to hold up all SMTP deliveries! Except when
2882     doing a two-stage queue run, don't do this if forcing. */
2883
2884     if ((!deliver_force || queue_2stage) && (queue_smtp ||
2885         match_isinlist(addrlist->domain, &queue_smtp_domains, 0,
2886           &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK))
2887       {
2888       expired = FALSE;
2889       for (addr = addrlist; addr != NULL; addr = addr->next)
2890         {
2891         if (addr->transport_return != DEFER) continue;
2892         addr->message = US"domain matches queue_smtp_domains, or -odqs set";
2893         }
2894       continue;      /* With next host */
2895       }
2896
2897     /* Count hosts being considered - purely for an intelligent comment
2898     if none are usable. */
2899
2900     hosts_total++;
2901
2902     /* Set $host and $host address now in case they are needed for the
2903     interface expansion or the serialize_hosts check; they remain set if an
2904     actual delivery happens. */
2905
2906     deliver_host = host->name;
2907     deliver_host_address = host->address;
2908
2909     /* Set up a string for adding to the retry key if the port number is not
2910     the standard SMTP port. A host may have its own port setting that overrides
2911     the default. */
2912
2913     pistring = string_sprintf(":%d", (host->port == PORT_NONE)?
2914       port : host->port);
2915     if (Ustrcmp(pistring, ":25") == 0) pistring = US"";
2916
2917     /* Select IPv4 or IPv6, and choose an outgoing interface. If the interface
2918     string changes upon expansion, we must add it to the key that is used for
2919     retries, because connections to the same host from a different interface
2920     should be treated separately. */
2921
2922     host_af = (Ustrchr(host->address, ':') == NULL)? AF_INET : AF_INET6;
2923     if (!smtp_get_interface(ob->interface, host_af, addrlist, &ifchanges,
2924          &interface, tid))
2925       return FALSE;
2926     if (ifchanges) pistring = string_sprintf("%s/%s", pistring, interface);
2927
2928     /* The first time round the outer loop, check the status of the host by
2929     inspecting the retry data. The second time round, we are interested only
2930     in expired hosts that haven't been tried since this message arrived. */
2931
2932     if (cutoff_retry == 0)
2933       {
2934       /* Ensure the status of the address is set by checking retry data if
2935       necessary. There maybe host-specific retry data (applicable to all
2936       messages) and also data for retries of a specific message at this host.
2937       If either of these retry records are actually read, the keys used are
2938       returned to save recomputing them later. */
2939
2940       host_is_expired = retry_check_address(addrlist->domain, host, pistring,
2941         ob->retry_include_ip_address, &retry_host_key, &retry_message_key);
2942
2943       DEBUG(D_transport) debug_printf("%s [%s]%s status = %s\n", host->name,
2944         (host->address == NULL)? US"" : host->address, pistring,
2945         (host->status == hstatus_usable)? "usable" :
2946         (host->status == hstatus_unusable)? "unusable" :
2947         (host->status == hstatus_unusable_expired)? "unusable (expired)" : "?");
2948
2949       /* Skip this address if not usable at this time, noting if it wasn't
2950       actually expired, both locally and in the address. */
2951
2952       switch (host->status)
2953         {
2954         case hstatus_unusable:
2955         expired = FALSE;
2956         setflag(addrlist, af_retry_skipped);
2957         /* Fall through */
2958
2959         case hstatus_unusable_expired:
2960         switch (host->why)
2961           {
2962           case hwhy_retry: hosts_retry++; break;
2963           case hwhy_failed:  hosts_fail++; break;
2964           case hwhy_deferred: hosts_defer++; break;
2965           }
2966
2967         /* If there was a retry message key, implying that previously there
2968         was a message-specific defer, we don't want to update the list of
2969         messages waiting for these hosts. */
2970
2971         if (retry_message_key != NULL) update_waiting = FALSE;
2972         continue;   /* With the next host or IP address */
2973         }
2974       }
2975
2976     /* Second time round the loop: if the address is set but expired, and
2977     the message is newer than the last try, let it through. */
2978
2979     else
2980       {
2981       if (host->address == NULL ||
2982           host->status != hstatus_unusable_expired ||
2983           host->last_try > received_time)
2984         continue;
2985       DEBUG(D_transport)
2986         debug_printf("trying expired host %s [%s]%s\n",
2987           host->name, host->address, pistring);
2988       host_is_expired = TRUE;
2989       }
2990
2991     /* Setting "expired=FALSE" doesn't actually mean not all hosts are expired;
2992     it remains TRUE only if all hosts are expired and none are actually tried.
2993     */
2994
2995     expired = FALSE;
2996
2997     /* If this host is listed as one to which access must be serialized,
2998     see if another Exim process has a connection to it, and if so, skip
2999     this host. If not, update the database to record our connection to it
3000     and remember this for later deletion. Do not do any of this if we are
3001     sending the message down a pre-existing connection. */
3002
3003     if (!continuing &&
3004         verify_check_this_host(&(ob->serialize_hosts), NULL, host->name,
3005           host->address, NULL) == OK)
3006       {
3007       serialize_key = string_sprintf("host-serialize-%s", host->name);
3008       if (!enq_start(serialize_key))
3009         {
3010         DEBUG(D_transport)
3011           debug_printf("skipping host %s because another Exim process "
3012             "is connected to it\n", host->name);
3013         hosts_serial++;
3014         continue;
3015         }
3016       serialized = TRUE;
3017       }
3018
3019     /* OK, we have an IP address that is not waiting for its retry time to
3020     arrive (it might be expired) OR (second time round the loop) we have an
3021     expired host that hasn't been tried since the message arrived. Have a go
3022     at delivering the message to it. First prepare the addresses by flushing
3023     out the result of previous attempts, and finding the first address that
3024     is still to be delivered. */
3025
3026     first_addr = prepare_addresses(addrlist, host);
3027
3028     DEBUG(D_transport) debug_printf("delivering %s to %s [%s] (%s%s)\n",
3029       message_id, host->name, host->address, addrlist->address,
3030       (addrlist->next == NULL)? "" : ", ...");
3031
3032     set_process_info("delivering %s to %s [%s] (%s%s)",
3033       message_id, host->name, host->address, addrlist->address,
3034       (addrlist->next == NULL)? "" : ", ...");
3035
3036     /* This is not for real; don't do the delivery. If there are
3037     any remaining hosts, list them. */
3038
3039     if (dont_deliver)
3040       {
3041       host_item *host2;
3042       set_errno(addrlist, 0, NULL, OK, FALSE);
3043       for (addr = addrlist; addr != NULL; addr = addr->next)
3044         {
3045         addr->host_used = host;
3046         addr->special_action = '*';
3047         addr->message = US"delivery bypassed by -N option";
3048         }
3049       DEBUG(D_transport)
3050         {
3051         debug_printf("*** delivery by %s transport bypassed by -N option\n"
3052                      "*** host and remaining hosts:\n", tblock->name);
3053         for (host2 = host; host2 != NULL; host2 = host2->next)
3054           debug_printf("    %s [%s]\n", host2->name,
3055             (host2->address == NULL)? US"unset" : host2->address);
3056         }
3057       rc = OK;
3058       }
3059
3060     /* This is for real. If the host is expired, we don't count it for
3061     hosts_max_retry. This ensures that all hosts must expire before an address
3062     is timed out, unless hosts_max_try_hardlimit (which protects against
3063     lunatic DNS configurations) is reached.
3064
3065     If the host is not expired and we are about to hit the hosts_max_retry
3066     limit, check to see if there is a subsequent hosts with a different MX
3067     value. If so, make that the next host, and don't count this one. This is a
3068     heuristic to make sure that different MXs do get tried. With a normal kind
3069     of retry rule, they would get tried anyway when the earlier hosts were
3070     delayed, but if the domain has a "retry every time" type of rule - as is
3071     often used for the the very large ISPs, that won't happen. */
3072
3073     else
3074       {
3075       if (!host_is_expired && ++unexpired_hosts_tried >= ob->hosts_max_try)
3076         {
3077         host_item *h;
3078         DEBUG(D_transport)
3079           debug_printf("hosts_max_try limit reached with this host\n");
3080         for (h = host; h != NULL; h = h->next)
3081           if (h->mx != host->mx) break;
3082         if (h != NULL)
3083           {
3084           nexthost = h;
3085           unexpired_hosts_tried--;
3086           DEBUG(D_transport) debug_printf("however, a higher MX host exists "
3087             "and will be tried\n");
3088           }
3089         }
3090
3091       /* Attempt the delivery. */
3092
3093       total_hosts_tried++;
3094       rc = smtp_deliver(addrlist, host, host_af, port, interface, tblock,
3095         expanded_hosts != NULL, &message_defer, FALSE);
3096
3097       /* Yield is one of:
3098          OK     => connection made, each address contains its result;
3099                      message_defer is set for message-specific defers (when all
3100                      recipients are marked defer)
3101          DEFER  => there was a non-message-specific delivery problem;
3102          ERROR  => there was a problem setting up the arguments for a filter,
3103                    or there was a problem with expanding added headers
3104       */
3105
3106       /* If the result is not OK, there was a non-message-specific problem.
3107       If the result is DEFER, we need to write to the logs saying what happened
3108       for this particular host, except in the case of authentication and TLS
3109       failures, where the log has already been written. If all hosts defer a
3110       general message is written at the end. */
3111
3112       if (rc == DEFER && first_addr->basic_errno != ERRNO_AUTHFAIL &&
3113                          first_addr->basic_errno != ERRNO_TLSFAILURE)
3114         write_logs(first_addr, host);
3115
3116       #ifdef EXPERIMENTAL_DBL
3117       if (rc == DEFER)
3118         dbl_write_defer_log(ob->dbl_host_defer_query, first_addr, host);
3119       #endif
3120
3121       /* If STARTTLS was accepted, but there was a failure in setting up the
3122       TLS session (usually a certificate screwup), and the host is not in
3123       hosts_require_tls, and tls_tempfail_tryclear is true, try again, with
3124       TLS forcibly turned off. We have to start from scratch with a new SMTP
3125       connection. That's why the retry is done from here, not from within
3126       smtp_deliver(). [Rejections of STARTTLS itself don't screw up the
3127       session, so the in-clear transmission after those errors, if permitted,
3128       happens inside smtp_deliver().] */
3129
3130       #ifdef SUPPORT_TLS
3131       if (rc == DEFER && first_addr->basic_errno == ERRNO_TLSFAILURE &&
3132            ob->tls_tempfail_tryclear &&
3133            verify_check_this_host(&(ob->hosts_require_tls), NULL, host->name,
3134              host->address, NULL) != OK)
3135         {
3136         log_write(0, LOG_MAIN, "TLS session failure: delivering unencrypted "
3137           "to %s [%s] (not in hosts_require_tls)", host->name, host->address);
3138         first_addr = prepare_addresses(addrlist, host);
3139         rc = smtp_deliver(addrlist, host, host_af, port, interface, tblock,
3140           expanded_hosts != NULL, &message_defer, TRUE);
3141         if (rc == DEFER && first_addr->basic_errno != ERRNO_AUTHFAIL)
3142           write_logs(first_addr, host);
3143         #ifdef EXPERIMENTAL_DBL
3144         if (rc == DEFER)
3145           dbl_write_defer_log(ob->dbl_host_defer_query, first_addr, host);
3146         #endif
3147         }
3148       #endif
3149       }
3150
3151     /* Delivery attempt finished */
3152
3153     rs = (rc == OK)? US"OK" : (rc == DEFER)? US"DEFER" : (rc == ERROR)?
3154       US"ERROR" : US"?";
3155
3156     set_process_info("delivering %s: just tried %s [%s] for %s%s: result %s",
3157       message_id, host->name, host->address, addrlist->address,
3158       (addrlist->next == NULL)? "" : " (& others)", rs);
3159
3160     /* Release serialization if set up */
3161
3162     if (serialized) enq_end(serialize_key);
3163
3164     /* If the result is DEFER, or if a host retry record is known to exist, we
3165     need to add an item to the retry chain for updating the retry database
3166     at the end of delivery. We only need to add the item to the top address,
3167     of course. Also, if DEFER, we mark the IP address unusable so as to skip it
3168     for any other delivery attempts using the same address. (It is copied into
3169     the unusable tree at the outer level, so even if different address blocks
3170     contain the same address, it still won't get tried again.) */
3171
3172     if (rc == DEFER || retry_host_key != NULL)
3173       {
3174       int delete_flag = (rc != DEFER)? rf_delete : 0;
3175       if (retry_host_key == NULL)
3176         {
3177         retry_host_key = ob->retry_include_ip_address?
3178           string_sprintf("T:%S:%s%s", host->name, host->address, pistring) :
3179           string_sprintf("T:%S%s", host->name, pistring);
3180         }
3181
3182       /* If a delivery of another message over an existing SMTP connection
3183       yields DEFER, we do NOT set up retry data for the host. This covers the
3184       case when there are delays in routing the addresses in the second message
3185       that are so long that the server times out. This is alleviated by not
3186       routing addresses that previously had routing defers when handling an
3187       existing connection, but even so, this case may occur (e.g. if a
3188       previously happily routed address starts giving routing defers). If the
3189       host is genuinely down, another non-continued message delivery will
3190       notice it soon enough. */
3191
3192       if (delete_flag != 0 || !continuing)
3193         retry_add_item(first_addr, retry_host_key, rf_host | delete_flag);
3194
3195       /* We may have tried an expired host, if its retry time has come; ensure
3196       the status reflects the expiry for the benefit of any other addresses. */
3197
3198       if (rc == DEFER)
3199         {
3200         host->status = (host_is_expired)?
3201           hstatus_unusable_expired : hstatus_unusable;
3202         host->why = hwhy_deferred;
3203         }
3204       }
3205
3206     /* If message_defer is set (host was OK, but every recipient got deferred
3207     because of some message-specific problem), or if that had happened
3208     previously so that a message retry key exists, add an appropriate item
3209     to the retry chain. Note that if there was a message defer but now there is
3210     a host defer, the message defer record gets deleted. That seems perfectly
3211     reasonable. Also, stop the message from being remembered as waiting
3212     for specific hosts. */
3213
3214     if (message_defer || retry_message_key != NULL)
3215       {
3216       int delete_flag = message_defer? 0 : rf_delete;
3217       if (retry_message_key == NULL)
3218         {
3219         retry_message_key = ob->retry_include_ip_address?
3220           string_sprintf("T:%S:%s%s:%s", host->name, host->address, pistring,
3221             message_id) :
3222           string_sprintf("T:%S%s:%s", host->name, pistring, message_id);
3223         }
3224       retry_add_item(addrlist, retry_message_key,
3225         rf_message | rf_host | delete_flag);
3226       update_waiting = FALSE;
3227       }
3228
3229     /* Any return other than DEFER (that is, OK or ERROR) means that the
3230     addresses have got their final statuses filled in for this host. In the OK
3231     case, see if any of them are deferred. */
3232
3233     if (rc == OK)
3234       {
3235       for (addr = addrlist; addr != NULL; addr = addr->next)
3236         {
3237         if (addr->transport_return == DEFER)
3238           {
3239           some_deferred = TRUE;
3240           break;
3241           }
3242         }
3243       }
3244
3245     /* If no addresses deferred or the result was ERROR, return. We do this for
3246     ERROR because a failing filter set-up or add_headers expansion is likely to
3247     fail for any host we try. */
3248
3249     if (rc == ERROR || (rc == OK && !some_deferred))
3250       {
3251       DEBUG(D_transport) debug_printf("Leaving %s transport\n", tblock->name);
3252       return TRUE;    /* Each address has its status */
3253       }
3254
3255     /* If the result was DEFER or some individual addresses deferred, let
3256     the loop run to try other hosts with the deferred addresses, except for the
3257     case when we were trying to deliver down an existing channel and failed.
3258     Don't try any other hosts in this case. */
3259
3260     if (continuing) break;
3261
3262     /* If the whole delivery, or some individual addresses, were deferred and
3263     there are more hosts that could be tried, do not count this host towards
3264     the hosts_max_try limit if the age of the message is greater than the
3265     maximum retry time for this host. This means we may try try all hosts,
3266     ignoring the limit, when messages have been around for some time. This is
3267     important because if we don't try all hosts, the address will never time
3268     out. NOTE: this does not apply to hosts_max_try_hardlimit. */
3269
3270     if ((rc == DEFER || some_deferred) && nexthost != NULL)
3271       {
3272       BOOL timedout;
3273       retry_config *retry = retry_find_config(host->name, NULL, 0, 0);
3274
3275       if (retry != NULL && retry->rules != NULL)
3276         {
3277         retry_rule *last_rule;
3278         for (last_rule = retry->rules;
3279              last_rule->next != NULL;
3280              last_rule = last_rule->next);
3281         timedout = time(NULL) - received_time > last_rule->timeout;
3282         }
3283       else timedout = TRUE;    /* No rule => timed out */
3284
3285       if (timedout)
3286         {
3287         unexpired_hosts_tried--;
3288         DEBUG(D_transport) debug_printf("temporary delivery error(s) override "
3289           "hosts_max_try (message older than host's retry time)\n");
3290         }
3291       }
3292     }   /* End of loop for trying multiple hosts. */
3293
3294   /* This is the end of the loop that repeats iff expired is TRUE and
3295   ob->delay_after_cutoff is FALSE. The second time round we will
3296   try those hosts that haven't been tried since the message arrived. */
3297
3298   DEBUG(D_transport)
3299     {
3300     debug_printf("all IP addresses skipped or deferred at least one address\n");
3301     if (expired && !ob->delay_after_cutoff && cutoff_retry == 0)
3302       debug_printf("retrying IP addresses not tried since message arrived\n");
3303     }
3304   }
3305
3306
3307 /* Get here if all IP addresses are skipped or defer at least one address. In
3308 MUA wrapper mode, this will happen only for connection or other non-message-
3309 specific failures. Force the delivery status for all addresses to FAIL. */
3310
3311 if (mua_wrapper)
3312   {
3313   for (addr = addrlist; addr != NULL; addr = addr->next)
3314     addr->transport_return = FAIL;
3315   goto END_TRANSPORT;
3316   }
3317
3318 /* In the normal, non-wrapper case, add a standard message to each deferred
3319 address if there hasn't been an error, that is, if it hasn't actually been
3320 tried this time. The variable "expired" will be FALSE if any deliveries were
3321 actually tried, or if there was at least one host that was not expired. That
3322 is, it is TRUE only if no deliveries were tried and all hosts were expired. If
3323 a delivery has been tried, an error code will be set, and the failing of the
3324 message is handled by the retry code later.
3325
3326 If queue_smtp is set, or this transport was called to send a subsequent message
3327 down an existing TCP/IP connection, and something caused the host not to be
3328 found, we end up here, but can detect these cases and handle them specially. */
3329
3330 for (addr = addrlist; addr != NULL; addr = addr->next)
3331   {
3332   /* If host is not NULL, it means that we stopped processing the host list
3333   because of hosts_max_try or hosts_max_try_hardlimit. In the former case, this
3334   means we need to behave as if some hosts were skipped because their retry
3335   time had not come. Specifically, this prevents the address from timing out.
3336   However, if we have hit hosts_max_try_hardlimit, we want to behave as if all
3337   hosts were tried. */
3338
3339   if (host != NULL)
3340     {
3341     if (total_hosts_tried >= ob->hosts_max_try_hardlimit)
3342       {
3343       DEBUG(D_transport)
3344         debug_printf("hosts_max_try_hardlimit reached: behave as if all "
3345           "hosts were tried\n");
3346       }
3347     else
3348       {
3349       DEBUG(D_transport)
3350         debug_printf("hosts_max_try limit caused some hosts to be skipped\n");
3351       setflag(addr, af_retry_skipped);
3352       }
3353     }
3354
3355   if (queue_smtp)    /* no deliveries attempted */
3356     {
3357     addr->transport_return = DEFER;
3358     addr->basic_errno = 0;
3359     addr->message = US"SMTP delivery explicitly queued";
3360     }
3361
3362   else if (addr->transport_return == DEFER &&
3363        (addr->basic_errno == ERRNO_UNKNOWNERROR || addr->basic_errno == 0) &&
3364        addr->message == NULL)
3365     {
3366     addr->basic_errno = ERRNO_HRETRY;
3367     if (continue_hostname != NULL)
3368       {
3369       addr->message = US"no host found for existing SMTP connection";
3370       }
3371     else if (expired)
3372       {
3373       setflag(addr, af_pass_message);   /* This is not a security risk */
3374       addr->message = (ob->delay_after_cutoff)?
3375         US"retry time not reached for any host after a long failure period" :
3376         US"all hosts have been failing for a long time and were last tried "
3377           "after this message arrived";
3378
3379       /* If we are already using fallback hosts, or there are no fallback hosts
3380       defined, convert the result to FAIL to cause a bounce. */
3381
3382       if (addr->host_list == addr->fallback_hosts ||
3383           addr->fallback_hosts == NULL)
3384         addr->transport_return = FAIL;
3385       }
3386     else
3387       {
3388       if (hosts_retry == hosts_total)
3389         addr->message = US"retry time not reached for any host";
3390       else if (hosts_fail == hosts_total)
3391         addr->message = US"all host address lookups failed permanently";
3392       else if (hosts_defer == hosts_total)
3393         addr->message = US"all host address lookups failed temporarily";
3394       else if (hosts_serial == hosts_total)
3395         addr->message = US"connection limit reached for all hosts";
3396       else if (hosts_fail+hosts_defer == hosts_total)
3397         addr->message = US"all host address lookups failed";
3398       else addr->message = US"some host address lookups failed and retry time "
3399         "not reached for other hosts or connection limit reached";
3400       }
3401     }
3402   }
3403
3404 /* Update the database which keeps information about which messages are waiting
3405 for which hosts to become available. For some message-specific errors, the
3406 update_waiting flag is turned off because we don't want follow-on deliveries in
3407 those cases.  If this transport instance is explicitly limited to one message
3408 per connection then follow-on deliveries are not possible and there's no need
3409 to create/update the per-transport wait-<transport_name> database. */
3410
3411 if (update_waiting && tblock->connection_max_messages != 1)
3412   transport_update_waiting(hostlist, tblock->name);
3413
3414 END_TRANSPORT:
3415
3416 DEBUG(D_transport) debug_printf("Leaving %s transport\n", tblock->name);
3417
3418 return TRUE;   /* Each address has its status */
3419 }
3420
3421 /* End of transport/smtp.c */