src/src/transports/smtp.c

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