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