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