1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* The main code for delivering a message. */
14 #include "transports/smtp.h"
19 /* Data block for keeping track of subprocesses for parallel remote
22 typedef struct pardata {
23 address_item *addrlist; /* chain of addresses */
24 address_item *addr; /* next address data expected for */
25 pid_t pid; /* subprocess pid */
26 int fd; /* pipe fd for getting result from subprocess */
27 int transport_count; /* returned transport count value */
28 BOOL done; /* no more data needed */
29 uschar *msg; /* error message */
30 uschar *return_path; /* return_path for these addresses */
33 /* Values for the process_recipients variable */
35 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
36 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
39 /* Mutually recursive functions for marking addresses done. */
41 static void child_done(address_item *, const uschar *);
42 static void address_done(address_item *, const uschar *);
44 /* Table for turning base-62 numbers into binary */
46 static uschar tab62[] =
47 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
48 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
49 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
50 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
51 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
52 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
56 /*************************************************
57 * Local static variables *
58 *************************************************/
60 /* addr_duplicate is global because it needs to be seen from the Envelope-To
63 static address_item *addr_defer = NULL;
64 static address_item *addr_failed = NULL;
65 static address_item *addr_fallback = NULL;
66 static address_item *addr_local = NULL;
67 static address_item *addr_new = NULL;
68 static address_item *addr_remote = NULL;
69 static address_item *addr_route = NULL;
70 static address_item *addr_succeed = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static struct pollfd *parpoll;
78 static int return_count;
79 static uschar *frozen_info = US"";
80 static uschar *used_return_path = NULL;
84 /*************************************************
85 * read as much as requested *
86 *************************************************/
88 /* The syscall read(2) doesn't always returns as much as we want. For
89 several reasons it might get less. (Not talking about signals, as syscalls
90 are restartable). When reading from a network or pipe connection the sender
91 might send in smaller chunks, with delays between these chunks. The read(2)
92 may return such a chunk.
94 The more the writer writes and the smaller the pipe between write and read is,
95 the more we get the chance of reading leass than requested. (See bug 2130)
97 This function read(2)s until we got all the data we *requested*.
99 Note: This function may block. Use it only if you're sure about the
100 amount of data you will get.
103 fd the file descriptor to read from
104 buffer pointer to a buffer of size len
105 len the requested(!) amount of bytes
107 Returns: the amount of bytes read
110 readn(int fd, void * buffer, size_t len)
112 uschar * next = buffer;
113 uschar * end = next + len;
117 ssize_t got = read(fd, next, end - next);
119 /* I'm not sure if there are signals that can interrupt us,
120 for now I assume the worst */
121 if (got == -1 && errno == EINTR) continue;
122 if (got <= 0) return next - US buffer;
130 /*************************************************
131 * Make a new address item *
132 *************************************************/
134 /* This function gets the store and initializes with default values. The
135 transport_return value defaults to DEFER, so that any unexpected failure to
136 deliver does not wipe out the message. The default unique string is set to a
137 copy of the address, so that its domain can be lowercased.
140 address the RFC822 address string
141 copy force a copy of the address
143 Returns: a pointer to an initialized address_item
147 deliver_make_addr(uschar *address, BOOL copy)
149 address_item * addr = store_get(sizeof(address_item), GET_UNTAINTED);
150 *addr = address_defaults;
151 if (copy) address = string_copy(address);
152 addr->address = address;
153 addr->unique = string_copy(address);
160 /*************************************************
161 * Set expansion values for an address *
162 *************************************************/
164 /* Certain expansion variables are valid only when handling an address or
165 address list. This function sets them up or clears the values, according to its
169 addr the address in question, or NULL to clear values
174 deliver_set_expansions(address_item *addr)
178 const uschar ***p = address_expansions;
179 while (*p) **p++ = NULL;
183 /* Exactly what gets set depends on whether there is one or more addresses, and
184 what they contain. These first ones are always set, taking their values from
185 the first address. */
187 if (!addr->host_list)
189 deliver_host = deliver_host_address = US"";
190 deliver_host_port = 0;
194 deliver_host = addr->host_list->name;
195 deliver_host_address = addr->host_list->address;
196 deliver_host_port = addr->host_list->port;
199 deliver_recipients = addr;
200 deliver_address_data = addr->prop.address_data;
201 deliver_domain_data = addr->prop.domain_data;
202 deliver_localpart_data = addr->prop.localpart_data;
203 router_var = addr->prop.variables;
205 /* These may be unset for multiple addresses */
207 deliver_domain = addr->domain;
208 self_hostname = addr->self_hostname;
210 #ifdef EXPERIMENTAL_BRIGHTMAIL
211 bmi_deliver = 1; /* deliver by default */
212 bmi_alt_location = NULL;
213 bmi_base64_verdict = NULL;
214 bmi_base64_tracker_verdict = NULL;
217 /* If there's only one address we can set everything. */
221 address_item *addr_orig;
223 deliver_localpart = addr->local_part;
224 deliver_localpart_prefix = addr->prefix;
225 deliver_localpart_prefix_v = addr->prefix_v;
226 deliver_localpart_suffix = addr->suffix;
227 deliver_localpart_suffix_v = addr->suffix_v;
229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230 deliver_domain_orig = addr_orig->domain;
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
251 deliver_domain_parent = addr->parent->domain;
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
261 if (testflag(addr, af_pfr))
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
267 deliver_localpart_prefix_v = addr->parent->prefix_v;
268 deliver_localpart_suffix = addr->parent->suffix;
269 deliver_localpart_suffix_v = addr->parent->suffix_v;
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
280 if (bmi_deliver == 1)
281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
293 if (testflag(addr, af_pfr))
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301 deliver_domain = NULL;
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
306 self_hostname = NULL;
307 if (!deliver_domain && !self_hostname) break;
315 /*************************************************
316 * Open a msglog file *
317 *************************************************/
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
324 Called from deliver_message(), can be operating as root.
327 filename the file name
328 mode the mode required
329 error used for saying what failed
331 Returns: a file descriptor, or -1 (with errno set)
335 open_msglog_file(uschar *filename, int mode, uschar **error)
337 if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
341 for (int i = 2; i > 0; i--)
343 int fd = Uopen(filename,
344 EXIM_CLOEXEC | EXIM_NOFOLLOW | O_WRONLY|O_APPEND|O_CREAT, mode);
347 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
348 function is called as root). Double check the mode, because the group setting
349 doesn't always get set automatically. */
352 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
354 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
359 if (fchmod(fd, mode) < 0)
369 (void)directory_make(spool_directory,
370 spool_sname(US"msglog", message_subdir),
371 MSGLOG_DIRECTORY_MODE, TRUE);
374 *error = US"create or open";
381 /*************************************************
382 * Write to msglog if required *
383 *************************************************/
385 /* Write to the message log, if configured. This function may also be called
389 format a string format
395 deliver_msglog(const char *format, ...)
398 if (!message_logs) return;
399 va_start(ap, format);
400 vfprintf(message_log, format, ap);
408 /*************************************************
409 * Replicate status for batch *
410 *************************************************/
412 /* When a transport handles a batch of addresses, it may treat them
413 individually, or it may just put the status in the first one, and return FALSE,
414 requesting that the status be copied to all the others externally. This is the
415 replication function. As well as the status, it copies the transport pointer,
416 which may have changed if appendfile passed the addresses on to a different
419 Argument: pointer to the first address in a chain
424 replicate_status(address_item *addr)
426 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
428 addr2->transport = addr->transport;
429 addr2->transport_return = addr->transport_return;
430 addr2->basic_errno = addr->basic_errno;
431 addr2->more_errno = addr->more_errno;
432 addr2->delivery_time = addr->delivery_time;
433 addr2->special_action = addr->special_action;
434 addr2->message = addr->message;
435 addr2->user_message = addr->user_message;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
458 We do not try to batch up different A-record host names that refer to the
462 one points to the first host list
463 two points to the second host list
465 Returns: TRUE if the lists refer to the same host set
469 same_hosts(host_item *one, host_item *two)
473 if (Ustrcmp(one->name, two->name) != 0)
476 host_item *end_one = one;
477 host_item *end_two = two;
479 /* Batch up only if there was no MX and the list was not randomized */
481 if (mx == MX_NONE) return FALSE;
483 /* Find the ends of the shortest sequence of identical MX values */
485 while ( end_one->next && end_one->next->mx == mx
486 && end_two->next && end_two->next->mx == mx)
488 end_one = end_one->next;
489 end_two = end_two->next;
492 /* If there aren't any duplicates, there's no match. */
494 if (end_one == one) return FALSE;
496 /* For each host in the 'one' sequence, check that it appears in the 'two'
497 sequence, returning FALSE if not. */
502 for (hi = two; hi != end_two->next; hi = hi->next)
503 if (Ustrcmp(one->name, hi->name) == 0) break;
504 if (hi == end_two->next) return FALSE;
505 if (one == end_one) break;
509 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
510 Ensure both are pointing at the last host, and carry on as for equality. */
515 /* if the names matched but ports do not, mismatch */
516 else if (one->port != two->port)
520 /* DNSSEC equality */
521 if (one->dnssec != two->dnssec) return FALSE;
529 /* True if both are NULL */
536 /*************************************************
537 * Compare header lines *
538 *************************************************/
540 /* This function is given two pointers to chains of header items, and it yields
541 TRUE if they are the same header texts in the same order.
544 one points to the first header list
545 two points to the second header list
547 Returns: TRUE if the lists refer to the same header set
551 same_headers(header_line *one, header_line *two)
553 for (;; one = one->next, two = two->next)
555 if (one == two) return TRUE; /* Includes the case where both NULL */
556 if (!one || !two) return FALSE;
557 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
563 /*************************************************
564 * Compare string settings *
565 *************************************************/
567 /* This function is given two pointers to strings, and it returns
568 TRUE if they are the same pointer, or if the two strings are the same.
571 one points to the first string
572 two points to the second string
574 Returns: TRUE or FALSE
578 same_strings(uschar *one, uschar *two)
580 if (one == two) return TRUE; /* Includes the case where both NULL */
581 if (!one || !two) return FALSE;
582 return (Ustrcmp(one, two) == 0);
587 /*************************************************
588 * Compare uid/gid for addresses *
589 *************************************************/
591 /* This function is given a transport and two addresses. It yields TRUE if the
592 uid/gid/initgroups settings for the two addresses are going to be the same when
597 addr1 the first address
598 addr2 the second address
600 Returns: TRUE or FALSE
604 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
606 if ( !tp->uid_set && !tp->expand_uid
607 && !tp->deliver_as_creator
608 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
609 || ( testflag(addr1, af_uid_set)
610 && ( addr1->uid != addr2->uid
611 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
615 if ( !tp->gid_set && !tp->expand_gid
616 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
617 || ( testflag(addr1, af_gid_set)
618 && addr1->gid != addr2->gid
628 /*************************************************
629 * Record that an address is complete *
630 *************************************************/
632 /* This function records that an address is complete. This is straightforward
633 for most addresses, where the unique address is just the full address with the
634 domain lower cased. For homonyms (addresses that are the same as one of their
635 ancestors) their are complications. Their unique addresses have \x\ prepended
636 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
639 Exim used to record the unique addresses of homonyms as "complete". This,
640 however, fails when the pattern of redirection varies over time (e.g. if taking
641 unseen copies at only some times of day) because the prepended numbers may vary
642 from one delivery run to the next. This problem is solved by never recording
643 prepended unique addresses as complete. Instead, when a homonymic address has
644 actually been delivered via a transport, we record its basic unique address
645 followed by the name of the transport. This is checked in subsequent delivery
646 runs whenever an address is routed to a transport.
648 If the completed address is a top-level one (has no parent, which means it
649 cannot be homonymic) we also add the original address to the non-recipients
650 tree, so that it gets recorded in the spool file and therefore appears as
651 "done" in any spool listings. The original address may differ from the unique
652 address in the case of the domain.
654 Finally, this function scans the list of duplicates, marks as done any that
655 match this address, and calls child_done() for their ancestors.
658 addr address item that has been completed
659 now current time as a string
665 address_done(address_item * addr, const uschar * now)
667 update_spool = TRUE; /* Ensure spool gets updated */
669 /* Top-level address */
673 tree_add_nonrecipient(addr->unique);
674 tree_add_nonrecipient(addr->address);
677 /* Homonymous child address */
679 else if (testflag(addr, af_homonym))
682 tree_add_nonrecipient(
683 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
686 /* Non-homonymous child address */
688 else tree_add_nonrecipient(addr->unique);
690 /* Check the list of duplicate addresses and ensure they are now marked
693 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
694 if (Ustrcmp(addr->unique, dup->unique) == 0)
696 tree_add_nonrecipient(dup->unique);
697 child_done(dup, now);
704 /*************************************************
705 * Decrease counts in parents and mark done *
706 *************************************************/
708 /* This function is called when an address is complete. If there is a parent
709 address, its count of children is decremented. If there are still other
710 children outstanding, the function exits. Otherwise, if the count has become
711 zero, address_done() is called to mark the parent and its duplicates complete.
712 Then loop for any earlier ancestors.
715 addr points to the completed address item
716 now the current time as a string, for writing to the message log
722 child_done(address_item * addr, const uschar * now)
729 if (--addr->child_count > 0) return; /* Incomplete parent */
730 address_done(addr, now);
732 /* Log the completion of all descendents only when there is no ancestor with
733 the same original address. */
735 for (aa = addr->parent; aa; aa = aa->parent)
736 if (Ustrcmp(aa->address, addr->address) == 0) break;
739 deliver_msglog("%s %s: children all complete\n", now, addr->address);
740 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
746 /*************************************************
747 * Delivery logging support functions *
748 *************************************************/
750 /* The LOGGING() checks in d_log_interface() are complicated for backwards
751 compatibility. When outgoing interface logging was originally added, it was
752 conditional on just incoming_interface (which is off by default). The
753 outgoing_interface option is on by default to preserve this behaviour, but
754 you can enable incoming_interface and disable outgoing_interface to get I=
755 fields on incoming lines only.
759 addr The address to be logged
761 Returns: New value for s
765 d_log_interface(gstring * g)
767 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
768 && sending_ip_address)
770 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
771 if (LOGGING(outgoing_port))
772 g = string_fmt_append(g, ":%d", sending_port);
780 d_hostlog(gstring * g, address_item * addr)
782 host_item * h = addr->host_used;
784 g = string_append(g, 2, US" H=", h->name);
786 if (LOGGING(dnssec) && h->dnssec == DS_YES)
787 g = string_catn(g, US" DS", 3);
789 g = string_append(g, 3, US" [", h->address, US"]");
791 if (LOGGING(outgoing_port))
792 g = string_fmt_append(g, ":%d", h->port);
794 if (continue_sequence > 1) /*XXX this is wrong for a dropped proxyconn. Would have to pass back from transport */
795 g = string_catn(g, US"*", 1);
798 if (LOGGING(proxy) && proxy_local_address)
800 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
801 if (LOGGING(outgoing_port))
802 g = string_fmt_append(g, ":%d", proxy_local_port);
806 g = d_log_interface(g);
808 if (testflag(addr, af_tcp_fastopen))
809 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
820 d_tlslog(gstring * g, address_item * addr)
822 if (LOGGING(tls_cipher) && addr->cipher)
824 g = string_append(g, 2, US" X=", addr->cipher);
825 #ifndef DISABLE_TLS_RESUME
826 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
827 g = string_catn(g, US"*", 1);
830 if (LOGGING(tls_certificate_verified) && addr->cipher)
831 g = string_append(g, 2, US" CV=",
832 testflag(addr, af_cert_verified)
835 testflag(addr, af_dane_verified)
841 if (LOGGING(tls_peerdn) && addr->peerdn)
842 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
850 #ifndef DISABLE_EVENT
851 /* Distribute a named event to any listeners.
853 Args: action config option specifying listener
854 event name of the event
855 ev_data associated data for the event
856 errnop pointer to errno for modification, or null
858 Return: string expansion from listener, or NULL
862 event_raise(uschar * action, const uschar * event, uschar * ev_data, int * errnop)
868 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
870 action, deliver_host_address);
873 event_data = ev_data;
875 if (!(s = expand_string(action)) && *expand_string_message)
876 log_write(0, LOG_MAIN|LOG_PANIC,
877 "failed to expand event_action %s in %s: %s\n",
878 event, transport_name ? transport_name : US"main", expand_string_message);
880 event_name = event_data = NULL;
882 /* If the expansion returns anything but an empty string, flag for
883 the caller to modify his normal processing
888 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
890 *errnop = ERRNO_EVENT;
898 msg_event_raise(const uschar * event, const address_item * addr)
900 const uschar * save_domain = deliver_domain;
901 uschar * save_local = deliver_localpart;
902 const uschar * save_host = deliver_host;
903 const uschar * save_address = deliver_host_address;
904 const int save_port = deliver_host_port;
906 router_name = addr->router ? addr->router->name : NULL;
907 deliver_domain = addr->domain;
908 deliver_localpart = addr->local_part;
909 deliver_host = addr->host_used ? addr->host_used->name : NULL;
911 if (!addr->transport)
913 if (Ustrcmp(event, "msg:fail:delivery") == 0)
915 /* An address failed with no transport involved. This happens when
916 a filter was used which triggered a fail command (in such a case
917 a transport isn't needed). Convert it to an internal fail event. */
919 (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
924 transport_name = addr->transport->name;
926 (void) event_raise(addr->transport->event_action, event,
928 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
929 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
930 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
931 ? addr->message : NULL,
935 deliver_host_port = save_port;
936 deliver_host_address = save_address;
937 deliver_host = save_host;
938 deliver_localpart = save_local;
939 deliver_domain = save_domain;
940 router_name = transport_name = NULL;
942 #endif /*DISABLE_EVENT*/
946 /******************************************************************************/
949 /*************************************************
950 * Generate local part for logging *
951 *************************************************/
954 string_get_lpart_sub(const address_item * addr, uschar * s)
957 if (testflag(addr, af_utf8_downcvt))
959 uschar * t = string_localpart_utf8_to_alabel(s, NULL);
960 return t ? t : s; /* t is NULL on a failed conversion */
966 /* This function is a subroutine for use in string_log_address() below.
969 addr the address being logged
970 yield the current dynamic buffer pointer
972 Returns: the new value of the buffer pointer
976 string_get_localpart(address_item * addr, gstring * yield)
980 if (testflag(addr, af_include_affixes) && (s = addr->prefix))
981 yield = string_cat(yield, string_get_lpart_sub(addr, s));
983 yield = string_cat(yield, string_get_lpart_sub(addr, addr->local_part));
985 if (testflag(addr, af_include_affixes) && (s = addr->suffix))
986 yield = string_cat(yield, string_get_lpart_sub(addr, s));
992 /*************************************************
993 * Generate log address list *
994 *************************************************/
996 /* This function generates a list consisting of an address and its parents, for
997 use in logging lines. For saved onetime aliased addresses, the onetime parent
998 field is used. If the address was delivered by a transport with rcpt_include_
999 affixes set, the af_include_affixes bit will be set in the address. In that
1000 case, we include the affixes here too.
1003 g points to growing-string struct
1004 addr bottom (ultimate) address
1005 all_parents if TRUE, include all parents
1006 success TRUE for successful delivery
1008 Returns: a growable string in dynamic store
1012 string_log_address(gstring * g,
1013 address_item *addr, BOOL all_parents, BOOL success)
1015 BOOL add_topaddr = TRUE;
1016 address_item *topaddr;
1018 /* Find the ultimate parent */
1020 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1022 /* We start with just the local part for pipe, file, and reply deliveries, and
1023 for successful local deliveries from routers that have the log_as_local flag
1024 set. File deliveries from filters can be specified as non-absolute paths in
1025 cases where the transport is going to complete the path. If there is an error
1026 before this happens (expansion failure) the local part will not be updated, and
1027 so won't necessarily look like a path. Add extra text for this case. */
1029 if ( testflag(addr, af_pfr)
1031 && addr->router && addr->router->log_as_local
1032 && addr->transport && addr->transport->info->local
1035 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1036 g = string_catn(g, CUS"save ", 5);
1037 g = string_get_localpart(addr, g);
1040 /* Other deliveries start with the full address. It we have split it into local
1041 part and domain, use those fields. Some early failures can happen before the
1042 splitting is done; in those cases use the original field. */
1047 int off = gstring_length(g); /* start of the "full address" */
1049 if (addr->local_part)
1052 g = string_get_localpart(addr, g);
1053 g = string_catn(g, US"@", 1);
1056 if (testflag(addr, af_utf8_downcvt))
1057 s = string_localpart_utf8_to_alabel(s, NULL);
1059 g = string_cat(g, s);
1062 g = string_cat(g, addr->address);
1064 /* If the address we are going to print is the same as the top address,
1065 and all parents are not being included, don't add on the top address. First
1066 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1067 on the local parts. */
1069 cmp = g->s + off; /* only now, as rebuffer likely done */
1070 string_from_gstring(g); /* ensure nul-terminated */
1071 if ( strcmpic(cmp, topaddr->address) == 0
1072 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1073 && !addr->onetime_parent
1074 && (!all_parents || !addr->parent || addr->parent == topaddr)
1076 add_topaddr = FALSE;
1079 /* If all parents are requested, or this is a local pipe/file/reply, and
1080 there is at least one intermediate parent, show it in brackets, and continue
1081 with all of them if all are wanted. */
1083 if ( (all_parents || testflag(addr, af_pfr))
1085 && addr->parent != topaddr)
1088 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1090 g = string_catn(g, s, 2);
1091 g = string_cat (g, addr2->address);
1092 if (!all_parents) break;
1095 g = string_catn(g, US")", 1);
1098 /* Add the top address if it is required */
1101 g = string_append(g, 3,
1103 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1111 /******************************************************************************/
1115 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1116 this is a nonstandard call; no two-character delivery flag is written
1117 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1120 flags passed to log_write()
1123 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1125 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1128 /* Log the delivery on the main log. We use an extensible string to build up
1129 the log line, and reset the store afterwards. Remote deliveries should always
1130 have a pointer to the host item that succeeded; local deliveries can have a
1131 pointer to a single host item in their host list, for use by the transport. */
1133 #ifndef DISABLE_EVENT
1134 /* presume no successful remote delivery */
1135 lookup_dnssec_authenticated = NULL;
1138 reset_point = store_mark();
1139 g = string_get_tainted(256, GET_TAINTED); /* addrs will be tainted, so avoid copy */
1142 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1145 g->s[0] = logchar; g->ptr = 1;
1146 g = string_catn(g, US"> ", 2);
1148 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1150 if (LOGGING(sender_on_delivery) || msg)
1151 g = string_append(g, 3, US" F=<",
1153 testflag(addr, af_utf8_downcvt)
1154 ? string_address_utf8_to_alabel(sender_address, NULL)
1161 g = string_append(g, 2, US" Q=", queue_name);
1163 /* You might think that the return path must always be set for a successful
1164 delivery; indeed, I did for some time, until this statement crashed. The case
1165 when it is not set is for a delivery to /dev/null which is optimised by not
1166 being run at all. */
1168 if (used_return_path && LOGGING(return_path_on_delivery))
1169 g = string_append(g, 3, US" P=<", used_return_path, US">");
1172 g = string_append(g, 2, US" ", msg);
1174 /* For a delivery from a system filter, there may not be a router */
1176 g = string_append(g, 2, US" R=", addr->router->name);
1178 g = string_append(g, 2, US" T=", addr->transport->name);
1180 if (LOGGING(delivery_size))
1181 g = string_fmt_append(g, " S=%d", transport_count);
1183 /* Local delivery */
1185 if (addr->transport->info->local)
1187 if (addr->host_list)
1188 g = string_append(g, 2, US" H=", addr->host_list->name);
1189 g = d_log_interface(g);
1190 if (addr->shadow_message)
1191 g = string_cat(g, addr->shadow_message);
1194 /* Remote delivery */
1198 if (addr->host_used)
1200 g = d_hostlog(g, addr);
1202 #ifndef DISABLE_EVENT
1203 deliver_host_address = addr->host_used->address;
1204 deliver_host_port = addr->host_used->port;
1205 deliver_host = addr->host_used->name;
1207 /* DNS lookup status */
1208 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1209 : addr->host_used->dnssec==DS_NO ? US"no"
1215 g = d_tlslog(g, addr);
1218 if (addr->authenticator)
1220 g = string_append(g, 2, US" A=", addr->authenticator);
1223 g = string_append(g, 2, US":", addr->auth_id);
1224 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1225 g = string_append(g, 2, US":", addr->auth_sndr);
1229 if (LOGGING(pipelining))
1231 if (testflag(addr, af_pipelining))
1232 g = string_catn(g, US" L", 2);
1233 #ifndef DISABLE_PIPE_CONNECT
1234 if (testflag(addr, af_early_pipe))
1235 g = string_catn(g, US"*", 1);
1239 #ifndef DISABLE_PRDR
1240 if (testflag(addr, af_prdr_used))
1241 g = string_catn(g, US" PRDR", 5);
1244 if (testflag(addr, af_chunking_used))
1245 g = string_catn(g, US" K", 2);
1248 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1250 if ( LOGGING(smtp_confirmation)
1252 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1255 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1256 uschar *p = big_buffer;
1257 uschar *ss = addr->message;
1259 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1261 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1266 g = string_append(g, 2, US" C=", big_buffer);
1269 /* Time on queue and actual time taken to deliver */
1271 if (LOGGING(queue_time))
1272 g = string_append(g, 2, US" QT=", string_timesince(
1273 LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1275 if (LOGGING(deliver_time))
1276 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1278 /* string_cat() always leaves room for the terminator. Release the
1279 store we used to build the line after writing it. */
1281 log_write(0, flags, "%s", string_from_gstring(g));
1283 #ifndef DISABLE_EVENT
1284 if (!msg) msg_event_raise(US"msg:delivery", addr);
1287 store_reset(reset_point);
1294 deferral_log(address_item * addr, uschar * now,
1295 int logflags, uschar * driver_name, uschar * driver_kind)
1297 rmark reset_point = store_mark();
1298 gstring * g = string_get(256);
1300 /* Build up the line that is used for both the message log and the main
1303 /* Create the address string for logging. Must not do this earlier, because
1304 an OK result may be changed to FAIL when a pipe returns text. */
1306 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1309 g = string_append(g, 2, US" Q=", queue_name);
1311 /* Either driver_name contains something and driver_kind contains
1312 " router" or " transport" (note the leading space), or driver_name is
1313 a null string and driver_kind contains "routing" without the leading
1314 space, if all routing has been deferred. When a domain has been held,
1315 so nothing has been done at all, both variables contain null strings. */
1319 if (driver_kind[1] == 't' && addr->router)
1320 g = string_append(g, 2, US" R=", addr->router->name);
1321 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1323 else if (driver_kind)
1324 g = string_append(g, 2, US" ", driver_kind);
1326 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1328 if (addr->basic_errno > 0)
1329 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1331 if (addr->host_used)
1332 g = d_hostlog(g, addr);
1334 if (LOGGING(deliver_time))
1335 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1338 g = string_append(g, 2, US": ", addr->message);
1341 const uschar * s = string_from_gstring(g);
1343 /* Log the deferment in the message log, but don't clutter it
1344 up with retry-time defers after the first delivery attempt. */
1346 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1347 deliver_msglog("%s %s\n", now, s);
1349 /* Write the main log and reset the store.
1350 For errors of the type "retry time not reached" (also remotes skipped
1351 on queue run), logging is controlled by L_retry_defer. Note that this kind
1352 of error number is negative, and all the retry ones are less than any
1356 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1360 store_reset(reset_point);
1367 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1369 rmark reset_point = store_mark();
1370 gstring * g = string_get(256);
1372 #ifndef DISABLE_EVENT
1373 /* Message failures for which we will send a DSN get their event raised
1374 later so avoid doing it here. */
1376 if ( !addr->prop.ignore_error
1377 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1379 msg_event_raise(US"msg:fail:delivery", addr);
1382 /* Build up the log line for the message and main logs */
1384 /* Create the address string for logging. Must not do this earlier, because
1385 an OK result may be changed to FAIL when a pipe returns text. */
1387 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1389 if (LOGGING(sender_on_delivery))
1390 g = string_append(g, 3, US" F=<", sender_address, US">");
1393 g = string_append(g, 2, US" Q=", queue_name);
1395 /* Return path may not be set if no delivery actually happened */
1397 if (used_return_path && LOGGING(return_path_on_delivery))
1398 g = string_append(g, 3, US" P=<", used_return_path, US">");
1401 g = string_append(g, 2, US" R=", addr->router->name);
1402 if (addr->transport)
1403 g = string_append(g, 2, US" T=", addr->transport->name);
1405 if (addr->host_used)
1406 g = d_hostlog(g, addr);
1409 g = d_tlslog(g, addr);
1412 if (addr->basic_errno > 0)
1413 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1416 g = string_append(g, 2, US": ", addr->message);
1418 if (LOGGING(deliver_time))
1419 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1421 /* Do the logging. For the message log, "routing failed" for those cases,
1422 just to make it clearer. */
1425 const uschar * s = string_from_gstring(g);
1428 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1430 deliver_msglog("%s %s\n", now, s);
1432 log_write(0, LOG_MAIN, "** %s", s);
1435 store_reset(reset_point);
1441 /*************************************************
1442 * Actions at the end of handling an address *
1443 *************************************************/
1445 /* This is a function for processing a single address when all that can be done
1446 with it has been done.
1449 addr points to the address block
1450 result the result of the delivery attempt
1451 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1452 driver_type indicates which type of driver (transport, or router) was last
1453 to process the address
1454 logchar '=' or '-' for use when logging deliveries with => or ->
1460 post_process_one(address_item * addr, int result, int logflags, int driver_type,
1463 uschar * now = tod_stamp(tod_log);
1464 uschar * driver_kind = NULL;
1465 uschar * driver_name = NULL;
1467 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1469 /* Set up driver kind and name for logging. Disable logging if the router or
1470 transport has disabled it. */
1472 if (driver_type == EXIM_DTYPE_TRANSPORT)
1474 if (addr->transport)
1476 driver_name = addr->transport->name;
1477 driver_kind = US" transport";
1478 f.disable_logging = addr->transport->disable_logging;
1480 else driver_kind = US"transporting";
1482 else if (driver_type == EXIM_DTYPE_ROUTER)
1486 driver_name = addr->router->name;
1487 driver_kind = US" router";
1488 f.disable_logging = addr->router->disable_logging;
1490 else driver_kind = US"routing";
1493 /* If there's an error message set, ensure that it contains only printing
1494 characters - it should, but occasionally things slip in and this at least
1495 stops the log format from getting wrecked. We also scan the message for an LDAP
1496 expansion item that has a password setting, and flatten the password. This is a
1497 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1498 malformed, it won't ever have gone near LDAP.) */
1502 const uschar * s = string_printing(addr->message);
1504 /* deconst cast ok as string_printing known to have alloc'n'copied */
1505 addr->message = expand_hide_passwords(US s);
1508 /* If we used a transport that has one of the "return_output" options set, and
1509 if it did in fact generate some output, then for return_output we treat the
1510 message as failed if it was not already set that way, so that the output gets
1511 returned to the sender, provided there is a sender to send it to. For
1512 return_fail_output, do this only if the delivery failed. Otherwise we just
1513 unlink the file, and remove the name so that if the delivery failed, we don't
1514 try to send back an empty or unwanted file. The log_output options operate only
1515 on a non-empty file.
1517 In any case, we close the message file, because we cannot afford to leave a
1518 file-descriptor for one address while processing (maybe very many) others. */
1520 if (addr->return_file >= 0 && addr->return_filename)
1522 BOOL return_output = FALSE;
1523 struct stat statbuf;
1524 (void)EXIMfsync(addr->return_file);
1526 /* If there is no output, do nothing. */
1528 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1530 transport_instance *tb = addr->transport;
1532 /* Handle logging options */
1535 || result == FAIL && tb->log_fail_output
1536 || result == DEFER && tb->log_defer_output
1540 FILE *f = Ufopen(addr->return_filename, "rb");
1542 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1543 "from %s transport: %s", addr->return_filename, tb->name,
1546 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1548 uschar *p = big_buffer + Ustrlen(big_buffer);
1550 while (p > big_buffer && isspace(p[-1])) p--;
1552 sp = string_printing(big_buffer);
1553 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1554 addr->address, tb->name, sp);
1559 /* Handle returning options, but only if there is an address to return
1562 if (sender_address[0] != 0 || addr->prop.errors_address)
1563 if (tb->return_output)
1565 addr->transport_return = result = FAIL;
1566 if (addr->basic_errno == 0 && !addr->message)
1567 addr->message = US"return message generated";
1568 return_output = TRUE;
1571 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1574 /* Get rid of the file unless it might be returned, but close it in
1579 Uunlink(addr->return_filename);
1580 addr->return_filename = NULL;
1581 addr->return_file = -1;
1584 (void)close(addr->return_file);
1587 /* Check if the transport notifed continue-conn status explicitly, and
1588 update our knowlege. */
1590 if (testflag(addr, af_new_conn)) continue_sequence = 1;
1591 else if (testflag(addr, af_cont_conn)) continue_sequence++;
1593 /* The success case happens only after delivery by a transport. */
1597 addr->next = addr_succeed;
1598 addr_succeed = addr;
1600 /* Call address_done() to ensure that we don't deliver to this address again,
1601 and write appropriate things to the message log. If it is a child address, we
1602 call child_done() to scan the ancestors and mark them complete if this is the
1603 last child to complete. */
1605 address_done(addr, now);
1606 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1609 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1610 driver_name, driver_kind);
1613 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1614 addr->parent->address, driver_name, driver_kind);
1615 child_done(addr, now);
1618 /* Certificates for logging (via events) */
1620 tls_out.ourcert = addr->ourcert;
1621 addr->ourcert = NULL;
1622 tls_out.peercert = addr->peercert;
1623 addr->peercert = NULL;
1625 tls_out.ver = addr->tlsver;
1626 tls_out.cipher = addr->cipher;
1627 tls_out.peerdn = addr->peerdn;
1628 tls_out.ocsp = addr->ocsp;
1629 # ifdef SUPPORT_DANE
1630 tls_out.dane_verified = testflag(addr, af_dane_verified);
1634 delivery_log(LOG_MAIN, addr, logchar, NULL);
1637 tls_free_cert(&tls_out.ourcert);
1638 tls_free_cert(&tls_out.peercert);
1640 tls_out.cipher = NULL;
1641 tls_out.peerdn = NULL;
1642 tls_out.ocsp = OCSP_NOT_REQ;
1643 # ifdef SUPPORT_DANE
1644 tls_out.dane_verified = FALSE;
1650 /* Soft failure, or local delivery process failed; freezing may be
1653 else if (result == DEFER || result == PANIC)
1655 if (result == PANIC) logflags |= LOG_PANIC;
1657 /* This puts them on the chain in reverse order. Do not change this, because
1658 the code for handling retries assumes that the one with the retry
1659 information is last. */
1661 addr->next = addr_defer;
1664 /* The only currently implemented special action is to freeze the
1665 message. Logging of this is done later, just before the -H file is
1668 if (addr->special_action == SPECIAL_FREEZE)
1670 f.deliver_freeze = TRUE;
1671 deliver_frozen_at = time(NULL);
1672 update_spool = TRUE;
1675 /* If doing a 2-stage queue run, we skip writing to either the message
1676 log or the main log for SMTP defers. */
1678 if (!f.queue_2stage || addr->basic_errno != 0)
1679 deferral_log(addr, now, logflags, driver_name, driver_kind);
1683 /* Hard failure. If there is an address to which an error message can be sent,
1684 put this address on the failed list. If not, put it on the deferred list and
1685 freeze the mail message for human attention. The latter action can also be
1686 explicitly requested by a router or transport. */
1690 /* If this is a delivery error, or a message for which no replies are
1691 wanted, and the message's age is greater than ignore_bounce_errors_after,
1692 force the af_ignore_error flag. This will cause the address to be discarded
1693 later (with a log entry). */
1695 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1696 addr->prop.ignore_error = TRUE;
1698 /* Freeze the message if requested, or if this is a bounce message (or other
1699 message with null sender) and this address does not have its own errors
1700 address. However, don't freeze if errors are being ignored. The actual code
1701 to ignore occurs later, instead of sending a message. Logging of freezing
1702 occurs later, just before writing the -H file. */
1704 if ( !addr->prop.ignore_error
1705 && ( addr->special_action == SPECIAL_FREEZE
1706 || (sender_address[0] == 0 && !addr->prop.errors_address)
1709 frozen_info = addr->special_action == SPECIAL_FREEZE
1711 : f.sender_local && !f.local_error_message
1712 ? US" (message created with -f <>)"
1713 : US" (delivery error message)";
1714 f.deliver_freeze = TRUE;
1715 deliver_frozen_at = time(NULL);
1716 update_spool = TRUE;
1718 /* The address is put on the defer rather than the failed queue, because
1719 the message is being retained. */
1721 addr->next = addr_defer;
1725 /* Don't put the address on the nonrecipients tree yet; wait until an
1726 error message has been successfully sent. */
1730 addr->next = addr_failed;
1734 failure_log(addr, driver_name ? NULL : driver_kind, now);
1737 /* Ensure logging is turned on again in all cases */
1739 f.disable_logging = FALSE;
1745 /*************************************************
1746 * Address-independent error *
1747 *************************************************/
1749 /* This function is called when there's an error that is not dependent on a
1750 particular address, such as an expansion string failure. It puts the error into
1751 all the addresses in a batch, logs the incident on the main and panic logs, and
1752 clears the expansions. It is mostly called from local_deliver(), but can be
1753 called for a remote delivery via findugid().
1756 logit TRUE if (MAIN+PANIC) logging required
1757 addr the first of the chain of addresses
1759 format format string for error message, or NULL if already set in addr
1760 ... arguments for the format
1766 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1768 addr->basic_errno = code;
1775 va_start(ap, format);
1776 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1778 addr->message = string_from_gstring(g);
1781 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1783 addr2->basic_errno = code;
1784 addr2->message = addr->message;
1787 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1788 deliver_set_expansions(NULL);
1794 /*************************************************
1795 * Check a "never users" list *
1796 *************************************************/
1798 /* This function is called to check whether a uid is on one of the two "never
1802 uid the uid to be checked
1803 nusers the list to be scanned; the first item in the list is the count
1805 Returns: TRUE if the uid is on the list
1809 check_never_users(uid_t uid, uid_t *nusers)
1811 if (!nusers) return FALSE;
1812 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1818 /*************************************************
1819 * Find uid and gid for a transport *
1820 *************************************************/
1822 /* This function is called for both local and remote deliveries, to find the
1823 uid/gid under which to run the delivery. The values are taken preferentially
1824 from the transport (either explicit or deliver_as_creator), then from the
1825 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1826 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1827 panic error is logged, and the function fails (which normally leads to delivery
1831 addr the address (possibly a chain)
1833 uidp pointer to uid field
1834 gidp pointer to gid field
1835 igfp pointer to the use_initgroups field
1837 Returns: FALSE if failed - error has been set in address(es)
1841 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1845 BOOL gid_set = FALSE;
1847 /* Default initgroups flag comes from the transport */
1849 *igfp = tp->initgroups;
1851 /* First see if there's a gid on the transport, either fixed or expandable.
1852 The expanding function always logs failure itself. */
1859 else if (tp->expand_gid)
1861 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1864 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1870 /* If the transport did not set a group, see if the router did. */
1872 if (!gid_set && testflag(addr, af_gid_set))
1878 /* Pick up a uid from the transport if one is set. */
1880 if (tp->uid_set) *uidp = tp->uid;
1882 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1883 it does not provide a passwd value from which a gid can be taken. */
1885 else if (tp->expand_uid)
1888 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1889 uidp, &(addr->message)))
1891 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1901 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1903 else if (tp->deliver_as_creator)
1905 *uidp = originator_uid;
1908 *gidp = originator_gid;
1913 /* Otherwise see if the address specifies the uid and if so, take it and its
1916 else if (testflag(addr, af_uid_set))
1919 *igfp = testflag(addr, af_initgroups);
1922 /* Nothing has specified the uid - default to the Exim user, and group if the
1935 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1936 defaulting to the Exim uid. In other words, if the configuration has specified
1937 a uid, it must also provide a gid. */
1941 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1942 "%s transport", tp->name);
1946 /* Check that the uid is not on the lists of banned uids that may not be used
1947 for delivery processes. */
1949 nuname = check_never_users(*uidp, never_users)
1951 : check_never_users(*uidp, fixed_never_users)
1952 ? US"fixed_never_users"
1956 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1957 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1969 /*************************************************
1970 * Check the size of a message for a transport *
1971 *************************************************/
1973 /* Checks that the message isn't too big for the selected transport.
1974 This is called only when it is known that the limit is set.
1978 addr the (first) address being delivered
1981 DEFER expansion failed or did not yield an integer
1982 FAIL message too big
1986 check_message_size(transport_instance *tp, address_item *addr)
1991 deliver_set_expansions(addr);
1992 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1993 deliver_set_expansions(NULL);
1995 if (expand_string_message)
1998 addr->message = size_limit == -1
1999 ? string_sprintf("failed to expand message_size_limit "
2000 "in %s transport: %s", tp->name, expand_string_message)
2001 : string_sprintf("invalid message_size_limit "
2002 "in %s transport: %s", tp->name, expand_string_message);
2004 else if (size_limit > 0 && message_size > size_limit)
2008 string_sprintf("message is too big (transport limit = %d)",
2017 /*************************************************
2018 * Transport-time check for a previous delivery *
2019 *************************************************/
2021 /* Check that this base address hasn't previously been delivered to its routed
2022 transport. If it has been delivered, mark it done. The check is necessary at
2023 delivery time in order to handle homonymic addresses correctly in cases where
2024 the pattern of redirection changes between delivery attempts (so the unique
2025 fields change). Non-homonymic previous delivery is detected earlier, at routing
2026 time (which saves unnecessary routing).
2029 addr the address item
2030 testing TRUE if testing wanted only, without side effects
2032 Returns: TRUE if previously delivered by the transport
2036 previously_transported(address_item *addr, BOOL testing)
2038 uschar * s = string_sprintf("%s/%s",
2039 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2041 if (tree_search(tree_nonrecipients, s) != 0)
2043 DEBUG(D_deliver|D_route|D_transport)
2044 debug_printf("%s was previously delivered (%s transport): discarded\n",
2045 addr->address, addr->transport->name);
2046 if (!testing) child_done(addr, tod_stamp(tod_log));
2055 /******************************************************
2056 * Check for a given header in a header string *
2057 ******************************************************/
2059 /* This function is used when generating quota warnings. The configuration may
2060 specify any header lines it likes in quota_warn_message. If certain of them are
2061 missing, defaults are inserted, so we need to be able to test for the presence
2065 hdr the required header name
2066 hstring the header string
2068 Returns: TRUE the header is in the string
2069 FALSE the header is not in the string
2073 contains_header(uschar *hdr, uschar *hstring)
2075 int len = Ustrlen(hdr);
2076 uschar *p = hstring;
2079 if (strncmpic(p, hdr, len) == 0)
2082 while (*p == ' ' || *p == '\t') p++;
2083 if (*p == ':') return TRUE;
2085 while (*p != 0 && *p != '\n') p++;
2086 if (*p == '\n') p++;
2094 /*************************************************
2095 * Perform a local delivery *
2096 *************************************************/
2098 /* Each local delivery is performed in a separate process which sets its
2099 uid and gid as specified. This is a safer way than simply changing and
2100 restoring using seteuid(); there is a body of opinion that seteuid()
2101 cannot be used safely. From release 4, Exim no longer makes any use of
2102 it for delivery. Besides, not all systems have seteuid().
2104 If the uid/gid are specified in the transport_instance, they are used; the
2105 transport initialization must ensure that either both or neither are set.
2106 Otherwise, the values associated with the address are used. If neither are set,
2107 it is a configuration error.
2109 The transport or the address may specify a home directory (transport over-
2110 rides), and if they do, this is set as $home. If neither have set a working
2111 directory, this value is used for that as well. Otherwise $home is left unset
2112 and the cwd is set to "/" - a directory that should be accessible to all users.
2114 Using a separate process makes it more complicated to get error information
2115 back. We use a pipe to pass the return code and also an error code and error
2116 text string back to the parent process.
2119 addr points to an address block for this delivery; for "normal" local
2120 deliveries this is the only address to be delivered, but for
2121 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2122 a number of addresses can be handled simultaneously, and in this
2123 case addr will point to a chain of addresses with the same
2126 shadowing TRUE if running a shadow transport; this causes output from pipes
2133 deliver_local(address_item *addr, BOOL shadowing)
2135 BOOL use_initgroups;
2138 int status, len, rc;
2141 uschar *working_directory;
2142 address_item *addr2;
2143 transport_instance *tp = addr->transport;
2145 /* Set up the return path from the errors or sender address. If the transport
2146 has its own return path setting, expand it and replace the existing value. */
2148 if(addr->prop.errors_address)
2149 return_path = addr->prop.errors_address;
2151 return_path = sender_address;
2153 if (tp->return_path)
2155 uschar * new_return_path = expand_string(tp->return_path);
2156 if (new_return_path)
2157 return_path = new_return_path;
2158 else if (!f.expand_string_forcedfail)
2160 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2161 US"Failed to expand return path \"%s\" in %s transport: %s",
2162 tp->return_path, tp->name, expand_string_message);
2167 /* For local deliveries, one at a time, the value used for logging can just be
2168 set directly, once and for all. */
2170 used_return_path = return_path;
2172 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2173 gets put into the address(es), and the expansions are unset, so we can just
2176 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2178 /* See if either the transport or the address specifies a home directory. A
2179 home directory set in the address may already be expanded; a flag is set to
2180 indicate that. In other cases we must expand it. */
2182 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2183 || ( (deliver_home = addr->home_dir) /* Set in address and */
2184 && !testflag(addr, af_home_expanded) /* not expanded */
2187 uschar *rawhome = deliver_home;
2188 deliver_home = NULL; /* in case it contains $home */
2189 if (!(deliver_home = expand_string(rawhome)))
2191 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2192 "to expand for %s transport: %s", rawhome, tp->name,
2193 expand_string_message);
2196 if (*deliver_home != '/')
2198 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2199 "is not absolute for %s transport", deliver_home, tp->name);
2204 /* See if either the transport or the address specifies a current directory,
2205 and if so, expand it. If nothing is set, use the home directory, unless it is
2206 also unset in which case use "/", which is assumed to be a directory to which
2207 all users have access. It is necessary to be in a visible directory for some
2208 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2209 2.5) require this. */
2211 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2212 if (working_directory)
2214 uschar *raw = working_directory;
2215 if (!(working_directory = expand_string(raw)))
2217 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2218 "failed to expand for %s transport: %s", raw, tp->name,
2219 expand_string_message);
2222 if (*working_directory != '/')
2224 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2225 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2229 else working_directory = deliver_home ? deliver_home : US"/";
2231 /* If one of the return_output flags is set on the transport, create and open a
2232 file in the message log directory for the transport to write its output onto.
2233 This is mainly used by pipe transports. The file needs to be unique to the
2234 address. This feature is not available for shadow transports. */
2237 && ( tp->return_output || tp->return_fail_output
2238 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2243 addr->return_filename =
2244 spool_fname(US"msglog", message_subdir, message_id,
2245 string_sprintf("-%d-%d", getpid(), return_count++));
2247 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2249 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2250 "to return message: %s", error, tp->name, strerror(errno));
2255 /* Create the pipe for inter-process communication. */
2259 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2264 /* Now fork the process to do the real work in the subprocess, but first
2265 ensure that all cached resources are freed so that the subprocess starts with
2266 a clean slate and doesn't interfere with the parent process. */
2270 if ((pid = exim_fork(US"delivery-local")) == 0)
2272 BOOL replicate = TRUE;
2274 /* Prevent core dumps, as we don't want them in users' home directories.
2275 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2276 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2277 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2278 complain if the error is "not supported".
2280 There are two scenarios where changing the max limit has an effect. In one,
2281 the user is using a .forward and invoking a command of their choice via pipe;
2282 for these, we do need the max limit to be 0 unless the admin chooses to
2283 permit an increased limit. In the other, the command is invoked directly by
2284 the transport and is under administrator control, thus being able to raise
2285 the limit aids in debugging. So there's no general always-right answer.
2287 Thus we inhibit core-dumps completely but let individual transports, while
2288 still root, re-raise the limits back up to aid debugging. We make the
2289 default be no core-dumps -- few enough people can use core dumps in
2290 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2297 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2299 # ifdef SETRLIMIT_NOT_SUPPORTED
2300 if (errno != ENOSYS && errno != ENOTSUP)
2302 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2307 /* Reset the random number generator, so different processes don't all
2308 have the same sequence. */
2312 /* If the transport has a setup entry, call this first, while still
2313 privileged. (Appendfile uses this to expand quota, for example, while
2314 able to read private files.) */
2316 if (addr->transport->setup)
2317 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2321 addr->transport_return = DEFER;
2325 addr->transport_return = PANIC;
2329 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2330 when the process becomes unprivileged, it won't be able to write to the
2331 process log. SIGHUP is ignored throughout exim, except when it is being
2334 signal(SIGINT, SIG_IGN);
2335 signal(SIGTERM, SIG_IGN);
2336 signal(SIGUSR1, SIG_IGN);
2338 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2339 half - for transports that exec things (e.g. pipe). Then set the required
2342 (void)close(pfd[pipe_read]);
2343 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2345 exim_setugid(uid, gid, use_initgroups,
2346 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2347 addr->address, addr->transport->name));
2351 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2352 for (address_item * batched = addr->next; batched; batched = batched->next)
2353 debug_printf("additional batched address: %s\n", batched->address);
2356 /* Set an appropriate working directory. */
2358 if (Uchdir(working_directory) < 0)
2360 addr->transport_return = DEFER;
2361 addr->basic_errno = errno;
2362 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2365 /* If successful, call the transport */
2370 set_process_info("delivering %s to %s using %s", message_id,
2371 addr->local_part, tp->name);
2373 /* Setting these globals in the subprocess means we need never clear them */
2375 transport_name = tp->name;
2376 if (addr->router) router_name = addr->router->name;
2377 driver_srcfile = tp->srcfile;
2378 driver_srcline = tp->srcline;
2380 /* If a transport filter has been specified, set up its argument list.
2381 Any errors will get put into the address, and FALSE yielded. */
2383 if (tp->filter_command)
2385 ok = transport_set_up_command(&transport_filter_argv,
2387 TRUE, PANIC, addr, FALSE, US"transport filter", NULL);
2388 transport_filter_timeout = tp->filter_timeout;
2390 else transport_filter_argv = NULL;
2394 debug_print_string(tp->debug_string);
2395 replicate = !(tp->info->code)(addr->transport, addr);
2399 /* Pass the results back down the pipe. If necessary, first replicate the
2400 status in the top address to the others in the batch. The label is the
2401 subject of a goto when a call to the transport's setup function fails. We
2402 pass the pointer to the transport back in case it got changed as a result of
2403 file_format in appendfile. */
2407 if (replicate) replicate_status(addr);
2408 for (addr2 = addr; addr2; addr2 = addr2->next)
2411 int local_part_length = Ustrlen(addr2->local_part);
2415 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2416 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2417 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2418 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2419 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2420 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2421 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2422 || (ret = write(pfd[pipe_write], &addr2->transport,
2423 sizeof(transport_instance *))) != sizeof(transport_instance *)
2425 /* For a file delivery, pass back the local part, in case the original
2426 was only part of the final delivery path. This gives more complete
2429 || (testflag(addr2, af_file)
2430 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2431 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2435 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2436 ret == -1 ? strerror(errno) : "short write");
2438 /* Now any messages */
2440 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2442 int message_length = s ? Ustrlen(s) + 1 : 0;
2443 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2444 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2446 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2447 ret == -1 ? strerror(errno) : "short write");
2451 /* OK, this process is now done. Free any cached resources that it opened,
2452 and close the pipe we were writing down before exiting. */
2454 (void)close(pfd[pipe_write]);
2459 /* Back in the main process: panic if the fork did not succeed. This seems
2460 better than returning an error - if forking is failing it is probably best
2461 not to try other deliveries for this message. */
2464 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2467 /* Read the pipe to get the delivery status codes and error messages. Our copy
2468 of the writing end must be closed first, as otherwise read() won't return zero
2469 on an empty pipe. We check that a status exists for each address before
2470 overwriting the address structure. If data is missing, the default DEFER status
2471 will remain. Afterwards, close the reading end. */
2473 (void)close(pfd[pipe_write]);
2475 for (addr2 = addr; addr2; addr2 = addr2->next)
2477 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2482 addr2->transport_return = status;
2483 len = read(pfd[pipe_read], &transport_count,
2484 sizeof(transport_count));
2485 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2486 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2487 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2488 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2489 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2490 len = read(pfd[pipe_read], &addr2->transport,
2491 sizeof(transport_instance *));
2493 if (testflag(addr2, af_file))
2496 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2497 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2500 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2501 " from delivery subprocess");
2504 /* sanity-checked llen so disable the Coverity error */
2505 /* coverity[tainted_data] */
2506 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2508 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2509 " from delivery subprocess");
2512 big_buffer[llen] = 0;
2513 addr2->local_part = string_copy(big_buffer);
2516 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2519 len = read(pfd[pipe_read], &message_length, sizeof(int));
2520 if (message_length > 0)
2522 len = read(pfd[pipe_read], big_buffer, message_length);
2523 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2524 if (len > 0) *sptr = string_copy(big_buffer);
2531 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2532 "from delivery subprocess", addr2->unique);
2537 (void)close(pfd[pipe_read]);
2539 /* Unless shadowing, write all successful addresses immediately to the journal
2540 file, to ensure they are recorded asap. For homonymic addresses, use the base
2541 address plus the transport name. Failure to write the journal is panic-worthy,
2542 but don't stop, as it may prove possible subsequently to update the spool file
2543 in order to record the delivery. */
2547 for (addr2 = addr; addr2; addr2 = addr2->next)
2548 if (addr2->transport_return == OK)
2550 if (testflag(addr2, af_homonym))
2551 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2553 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2555 /* In the test harness, wait just a bit to let the subprocess finish off
2556 any debug output etc first. */
2558 testharness_pause_ms(300);
2560 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2561 len = Ustrlen(big_buffer);
2562 if (write(journal_fd, big_buffer, len) != len)
2563 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2564 big_buffer, strerror(errno));
2567 /* Ensure the journal file is pushed out to disk. */
2569 if (EXIMfsync(journal_fd) < 0)
2570 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2574 /* Wait for the process to finish. If it terminates with a non-zero code,
2575 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2576 status values of all the addresses as they are. Take care to handle the case
2577 when the subprocess doesn't seem to exist. This has been seen on one system
2578 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2579 happens, wait() doesn't recognize the termination of child processes. Exim now
2580 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2582 while ((rc = wait(&status)) != pid)
2583 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2585 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2586 addr->transport->driver_name);
2591 if ((status & 0xffff) != 0)
2593 int msb = (status >> 8) & 255;
2594 int lsb = status & 255;
2595 int code = (msb == 0)? (lsb & 0x7f) : msb;
2596 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2597 addr->special_action = SPECIAL_FREEZE;
2598 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2599 "status 0x%04x: %s %d",
2600 addr->transport->driver_name,
2602 msb == 0 ? "terminated by signal" : "exit code",
2606 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2608 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2611 uschar *warn_message;
2614 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2616 if (!(warn_message = expand_string(addr->transport->warn_message)))
2617 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2618 "message for %s transport): %s", addr->transport->warn_message,
2619 addr->transport->name, expand_string_message);
2621 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2623 FILE *f = fdopen(fd, "wb");
2624 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2625 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2626 fprintf(f, "Auto-Submitted: auto-replied\n");
2627 if (!contains_header(US"From", warn_message))
2629 fprintf(f, "%s", CS warn_message);
2631 /* Close and wait for child process to complete, without a timeout. */
2634 (void)child_close(pid, 0);
2637 addr->special_action = SPECIAL_NONE;
2644 /* Check transport for the given concurrency limit. Return TRUE if over
2645 the limit (or an expansion failure), else FALSE and if there was a limit,
2646 the key for the hints database used for the concurrency count. */
2649 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2651 unsigned max_parallel;
2653 if (!tp->max_parallel) return FALSE;
2655 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2656 if (expand_string_message)
2658 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2659 "in %s transport (%s): %s", tp->name, addr->address,
2660 expand_string_message);
2664 if (max_parallel > 0)
2666 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2667 if (!enq_start(serialize_key, max_parallel))
2669 address_item * next;
2671 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2672 tp->name, max_parallel);
2676 addr->message = US"concurrency limit reached for transport";
2677 addr->basic_errno = ERRNO_TRETRY;
2678 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2679 } while ((addr = next));
2682 *key = serialize_key;
2689 /*************************************************
2690 * Do local deliveries *
2691 *************************************************/
2693 /* This function processes the list of addresses in addr_local. True local
2694 deliveries are always done one address at a time. However, local deliveries can
2695 be batched up in some cases. Typically this is when writing batched SMTP output
2696 files for use by some external transport mechanism, or when running local
2697 deliveries over LMTP.
2704 do_local_deliveries(void)
2707 open_db *dbm_file = NULL;
2708 time_t now = time(NULL);
2710 /* Loop until we have exhausted the supply of local deliveries */
2714 struct timeval delivery_start;
2715 struct timeval deliver_time;
2716 address_item *addr2, *addr3, *nextaddr;
2717 int logflags = LOG_MAIN;
2718 int logchar = f.dont_deliver? '*' : '=';
2719 transport_instance *tp;
2720 uschar * serialize_key = NULL;
2722 /* Pick the first undelivered address off the chain */
2724 address_item *addr = addr_local;
2725 addr_local = addr->next;
2728 DEBUG(D_deliver|D_transport)
2729 debug_printf("--------> %s <--------\n", addr->address);
2731 /* An internal disaster if there is no transport. Should not occur! */
2733 if (!(tp = addr->transport))
2735 logflags |= LOG_PANIC;
2736 f.disable_logging = FALSE; /* Jic */
2737 addr->message = addr->router
2738 ? string_sprintf("No transport set by %s router", addr->router->name)
2739 : US"No transport set by system filter";
2740 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2744 /* Check that this base address hasn't previously been delivered to this
2745 transport. The check is necessary at this point to handle homonymic addresses
2746 correctly in cases where the pattern of redirection changes between delivery
2747 attempts. Non-homonymic previous delivery is detected earlier, at routing
2750 if (previously_transported(addr, FALSE)) continue;
2752 /* There are weird cases where logging is disabled */
2754 f.disable_logging = tp->disable_logging;
2756 /* Check for batched addresses and possible amalgamation. Skip all the work
2757 if either batch_max <= 1 or there aren't any other addresses for local
2760 if (tp->batch_max > 1 && addr_local)
2762 int batch_count = 1;
2763 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2764 BOOL uses_lp = ( testflag(addr, af_pfr)
2765 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2767 || readconf_depends((driver_instance *)tp, US"local_part");
2768 uschar *batch_id = NULL;
2769 address_item **anchor = &addr_local;
2770 address_item *last = addr;
2773 /* Expand the batch_id string for comparison with other addresses.
2774 Expansion failure suppresses batching. */
2778 deliver_set_expansions(addr);
2779 batch_id = expand_string(tp->batch_id);
2780 deliver_set_expansions(NULL);
2783 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2784 "in %s transport (%s): %s", tp->name, addr->address,
2785 expand_string_message);
2786 batch_count = tp->batch_max;
2790 /* Until we reach the batch_max limit, pick off addresses which have the
2791 same characteristics. These are:
2794 not previously delivered (see comment about 50 lines above)
2795 same local part if the transport's configuration contains $local_part
2796 or if this is a file or pipe delivery from a redirection
2797 same domain if the transport's configuration contains $domain
2799 same additional headers
2800 same headers to be removed
2801 same uid/gid for running the transport
2802 same first host if a host list is set
2805 while ((next = *anchor) && batch_count < tp->batch_max)
2808 tp == next->transport
2809 && !previously_transported(next, TRUE)
2810 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2811 && testflag(addr, af_file) == testflag(next, af_file)
2812 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2813 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2814 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2815 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2816 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2817 && same_ugid(tp, addr, next)
2818 && ( !addr->host_list && !next->host_list
2821 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2824 /* If the transport has a batch_id setting, batch_id will be non-NULL
2825 from the expansion outside the loop. Expand for this address and compare.
2826 Expansion failure makes this address ineligible for batching. */
2831 address_item *save_nextnext = next->next;
2832 next->next = NULL; /* Expansion for a single address */
2833 deliver_set_expansions(next);
2834 next->next = save_nextnext;
2835 bid = expand_string(tp->batch_id);
2836 deliver_set_expansions(NULL);
2839 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2840 "in %s transport (%s): %s", tp->name, next->address,
2841 expand_string_message);
2844 else ok = (Ustrcmp(batch_id, bid) == 0);
2847 /* Take address into batch if OK. */
2851 *anchor = next->next; /* Include the address */
2857 else anchor = &next->next; /* Skip the address */
2861 /* We now have one or more addresses that can be delivered in a batch. Check
2862 whether the transport is prepared to accept a message of this size. If not,
2863 fail them all forthwith. If the expansion fails, or does not yield an
2864 integer, defer delivery. */
2866 if (tp->message_size_limit)
2868 int rc = check_message_size(tp, addr);
2871 replicate_status(addr);
2875 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2878 continue; /* With next batch of addresses */
2882 /* If we are not running the queue, or if forcing, all deliveries will be
2883 attempted. Otherwise, we must respect the retry times for each address. Even
2884 when not doing this, we need to set up the retry key string, and determine
2885 whether a retry record exists, because after a successful delivery, a delete
2886 retry item must be set up. Keep the retry database open only for the duration
2887 of these checks, rather than for all local deliveries, because some local
2888 deliveries (e.g. to pipes) can take a substantial time. */
2890 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2891 DEBUG(D_deliver|D_retry|D_hints_lookup)
2892 debug_printf("no retry data available\n");
2898 BOOL ok = TRUE; /* to deliver this address */
2901 /* Set up the retry key to include the domain or not, and change its
2902 leading character from "R" to "T". Must make a copy before doing this,
2903 because the old key may be pointed to from a "delete" retry item after
2906 retry_key = string_copy(
2907 tp->retry_use_local_part ? addr2->address_retry_key :
2908 addr2->domain_retry_key);
2911 /* Inspect the retry data. If there is no hints file, delivery happens. */
2915 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2917 /* If there is no retry record, delivery happens. If there is,
2918 remember it exists so it can be deleted after a successful delivery. */
2922 setflag(addr2, af_lt_retry_exists);
2924 /* A retry record exists for this address. If queue running and not
2925 forcing, inspect its contents. If the record is too old, or if its
2926 retry time has come, or if it has passed its cutoff time, delivery
2931 debug_printf("retry record exists: age=%s ",
2932 readconf_printtime(now - retry_record->time_stamp));
2933 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2934 debug_printf(" time to retry = %s expired = %d\n",
2935 readconf_printtime(retry_record->next_try - now),
2936 retry_record->expired);
2939 if (f.queue_running && !f.deliver_force)
2941 ok = (now - retry_record->time_stamp > retry_data_expire)
2942 || (now >= retry_record->next_try)
2943 || retry_record->expired;
2945 /* If we haven't reached the retry time, there is one more check
2946 to do, which is for the ultimate address timeout. */
2949 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2953 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2956 /* This address is to be delivered. Leave it on the chain. */
2961 addr2 = addr2->next;
2964 /* This address is to be deferred. Take it out of the chain, and
2965 post-process it as complete. Must take it out of the chain first,
2966 because post processing puts it on another chain. */
2970 address_item *this = addr2;
2971 this->message = US"Retry time not yet reached";
2972 this->basic_errno = ERRNO_LRETRY;
2973 addr2 = addr3 ? (addr3->next = addr2->next)
2974 : (addr = addr2->next);
2975 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2979 if (dbm_file) dbfn_close(dbm_file);
2981 /* If there are no addresses left on the chain, they all deferred. Loop
2982 for the next set of addresses. */
2984 if (!addr) continue;
2986 /* If the transport is limited for parallellism, enforce that here.
2987 We use a hints DB entry, incremented here and decremented after
2988 the transport (and any shadow transport) completes. */
2990 if (tpt_parallel_check(tp, addr, &serialize_key))
2992 if (expand_string_message)
2994 logflags |= LOG_PANIC;
2998 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2999 } while ((addr = addr2));
3001 continue; /* Loop for the next set of addresses. */
3005 /* So, finally, we do have some addresses that can be passed to the
3006 transport. Before doing so, set up variables that are relevant to a
3009 deliver_set_expansions(addr);
3011 gettimeofday(&delivery_start, NULL);
3012 deliver_local(addr, FALSE);
3013 timesince(&deliver_time, &delivery_start);
3015 /* If a shadow transport (which must perforce be another local transport), is
3016 defined, and its condition is met, we must pass the message to the shadow
3017 too, but only those addresses that succeeded. We do this by making a new
3018 chain of addresses - also to keep the original chain uncontaminated. We must
3019 use a chain rather than doing it one by one, because the shadow transport may
3022 NOTE: if the condition fails because of a lookup defer, there is nothing we
3026 && ( !tp->shadow_condition
3027 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3030 transport_instance *stp;
3031 address_item *shadow_addr = NULL;
3032 address_item **last = &shadow_addr;
3034 for (stp = transports; stp; stp = stp->next)
3035 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3038 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3041 /* Pick off the addresses that have succeeded, and make clones. Put into
3042 the shadow_message field a pointer to the shadow_message field of the real
3045 else for (addr2 = addr; addr2; addr2 = addr2->next)
3046 if (addr2->transport_return == OK)
3048 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3051 addr3->shadow_message = US &addr2->shadow_message;
3052 addr3->transport = stp;
3053 addr3->transport_return = DEFER;
3054 addr3->return_filename = NULL;
3055 addr3->return_file = -1;
3057 last = &addr3->next;
3060 /* If we found any addresses to shadow, run the delivery, and stick any
3061 message back into the shadow_message field in the original. */
3065 int save_count = transport_count;
3067 DEBUG(D_deliver|D_transport)
3068 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3069 deliver_local(shadow_addr, TRUE);
3071 for(; shadow_addr; shadow_addr = shadow_addr->next)
3073 int sresult = shadow_addr->transport_return;
3074 *(uschar **)shadow_addr->shadow_message =
3076 ? string_sprintf(" ST=%s", stp->name)
3077 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3078 shadow_addr->basic_errno <= 0
3080 : US strerror(shadow_addr->basic_errno),
3081 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3084 shadow_addr->message
3085 ? shadow_addr->message
3086 : shadow_addr->basic_errno <= 0
3090 DEBUG(D_deliver|D_transport)
3091 debug_printf("%s shadow transport returned %s for %s\n",
3092 stp->name, rc_to_string(sresult), shadow_addr->address);
3095 DEBUG(D_deliver|D_transport)
3096 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3098 transport_count = save_count; /* Restore original transport count */
3102 /* Cancel the expansions that were set up for the delivery. */
3104 deliver_set_expansions(NULL);
3106 /* If the transport was parallelism-limited, decrement the hints DB record. */
3108 if (serialize_key) enq_end(serialize_key);
3110 /* Now we can process the results of the real transport. We must take each
3111 address off the chain first, because post_process_one() puts it on another
3114 for (addr2 = addr; addr2; addr2 = nextaddr)
3116 int result = addr2->transport_return;
3117 nextaddr = addr2->next;
3119 DEBUG(D_deliver|D_transport)
3120 debug_printf("%s transport returned %s for %s\n",
3121 tp->name, rc_to_string(result), addr2->address);
3123 /* If there is a retry_record, or if delivery is deferred, build a retry
3124 item for setting a new retry time or deleting the old retry record from
3125 the database. These items are handled all together after all addresses
3126 have been handled (so the database is open just for a short time for
3129 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3131 int flags = result == DEFER ? 0 : rf_delete;
3132 uschar *retry_key = string_copy(tp->retry_use_local_part
3133 ? addr2->address_retry_key : addr2->domain_retry_key);
3135 retry_add_item(addr2, retry_key, flags);
3138 /* Done with this address */
3140 addr2->delivery_time = deliver_time;
3141 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3143 /* If a pipe delivery generated text to be sent back, the result may be
3144 changed to FAIL, and we must copy this for subsequent addresses in the
3147 if (addr2->transport_return != result)
3149 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3151 addr3->transport_return = addr2->transport_return;
3152 addr3->basic_errno = addr2->basic_errno;
3153 addr3->message = addr2->message;
3155 result = addr2->transport_return;
3158 /* Whether or not the result was changed to FAIL, we need to copy the
3159 return_file value from the first address into all the addresses of the
3160 batch, so they are all listed in the error message. */
3162 addr2->return_file = addr->return_file;
3164 /* Change log character for recording successful deliveries. */
3166 if (result == OK) logchar = '-';
3168 } /* Loop back for next batch of addresses */
3174 /*************************************************
3175 * Sort remote deliveries *
3176 *************************************************/
3178 /* This function is called if remote_sort_domains is set. It arranges that the
3179 chain of addresses for remote deliveries is ordered according to the strings
3180 specified. Try to make this shuffling reasonably efficient by handling
3181 sequences of addresses rather than just single ones.
3188 sort_remote_deliveries(void)
3191 address_item **aptr = &addr_remote;
3192 const uschar *listptr = remote_sort_domains;
3196 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3198 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3201 address_item *moved = NULL;
3202 address_item **bptr = &moved;
3206 address_item **next;
3207 deliver_domain = (*aptr)->domain; /* set $domain */
3208 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3209 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3211 aptr = &(*aptr)->next;
3215 next = &(*aptr)->next;
3217 && (deliver_domain = (*next)->domain, /* Set $domain */
3218 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3219 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3221 next = &(*next)->next;
3223 /* If the batch of non-matchers is at the end, add on any that were
3224 extracted further up the chain, and end this iteration. Otherwise,
3225 extract them from the chain and hang on the moved chain. */
3237 aptr = &(*aptr)->next;
3240 /* If the loop ended because the final address matched, *aptr will
3241 be NULL. Add on to the end any extracted non-matching addresses. If
3242 *aptr is not NULL, the loop ended via "break" when *next is null, that
3243 is, there was a string of non-matching addresses at the end. In this
3244 case the extracted addresses have already been added on the end. */
3246 if (!*aptr) *aptr = moved;
3251 debug_printf("remote addresses after sorting:\n");
3252 for (address_item * addr = addr_remote; addr; addr = addr->next)
3253 debug_printf(" %s\n", addr->address);
3259 /*************************************************
3260 * Read from pipe for remote delivery subprocess *
3261 *************************************************/
3263 /* This function is called when the subprocess is complete, but can also be
3264 called before it is complete, in order to empty a pipe that is full (to prevent
3265 deadlock). It must therefore keep track of its progress in the parlist data
3268 We read the pipe to get the delivery status codes and a possible error message
3269 for each address, optionally preceded by unusability data for the hosts and
3270 also by optional retry data.
3272 Read in large chunks into the big buffer and then scan through, interpreting
3273 the data therein. In most cases, only a single read will be necessary. No
3274 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3275 that we read the next chunk when there is less than 2500 bytes left in the
3276 non-final chunk, we can assume each item is complete in the buffer before
3277 handling it. Each item is written using a single write(), which is atomic for
3278 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3279 often bigger) so even if we are reading while the subprocess is still going, we
3280 should never have only a partial item in the buffer.
3282 hs12: This assumption is not true anymore, since we get quite large items (certificate
3283 information and such).
3286 poffset the offset of the parlist item
3287 eop TRUE if the process has completed
3289 Returns: TRUE if the terminating 'Z' item has been read,
3290 or there has been a disaster (i.e. no more data needed);
3295 par_read_pipe(int poffset, BOOL eop)
3298 pardata *p = parlist + poffset;
3299 address_item *addrlist = p->addrlist;
3300 address_item *addr = p->addr;
3304 uschar *msg = p->msg;
3305 BOOL done = p->done;
3307 /* Loop through all items, reading from the pipe when necessary. The pipe
3308 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3309 here, as the preceding poll() tells us, if data is available for reading.
3311 A read() on a "selected" handle should never block, but(!) it may return
3312 less data then we expected. (The buffer size we pass to read() shouldn't be
3313 understood as a "request", but as a "limit".)
3315 Each separate item is written to the pipe in a timely manner. But, especially for
3316 larger items, the read(2) may already return partial data from the write(2).
3318 The write is atomic mostly (depending on the amount written), but atomic does
3319 not imply "all or noting", it just is "not intermixed" with other writes on the
3320 same channel (pipe).
3324 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3325 (int)p->pid, eop? "ended" : "not ended yet");
3329 retry_item *r, **rp;
3330 uschar pipeheader[PIPE_HEADER_SIZE+1];
3331 uschar *id = &pipeheader[0];
3332 uschar *subid = &pipeheader[1];
3333 uschar *ptr = big_buffer;
3334 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3337 DEBUG(D_deliver) debug_printf(
3338 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3340 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3341 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3342 If we get less, we can assume the subprocess do be done and do not expect any further
3343 information from it. */
3345 if ((got = readn(fd, pipeheader, required)) != required)
3347 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3348 "from transport process %d for transport %s",
3349 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3354 pipeheader[PIPE_HEADER_SIZE] = '\0';
3356 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3360 /* If we can't decode the pipeheader, the subprocess seems to have a
3361 problem, we do not expect any furher information from it. */
3363 required = Ustrtol(pipeheader+2, &endc, 10);
3366 msg = string_sprintf("failed to read pipe "
3367 "from transport process %d for transport %s: error decoding size from header",
3368 pid, addr->transport->driver_name);
3375 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3376 (u_long)required, pid);
3378 /* Same as above, the transport process will write the bytes announced
3379 in a timely manner, so we can just wait for the bytes, getting less than expected
3380 is considered a problem of the subprocess, we do not expect anything else from it. */
3381 if ((got = readn(fd, big_buffer, required)) != required)
3383 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3384 " bytes (pipedata) from transport process %d for transport %s",
3385 got, required, pid, addr->transport->driver_name);
3390 /* Handle each possible type of item, assuming the complete item is
3391 available in store. */
3395 /* Host items exist only if any hosts were marked unusable. Match
3396 up by checking the IP address. */
3399 for (h = addrlist->host_list; h; h = h->next)
3401 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3409 /* Retry items are sent in a preceding R item for each address. This is
3410 kept separate to keep each message short enough to guarantee it won't
3411 be split in the pipe. Hopefully, in the majority of cases, there won't in
3412 fact be any retry items at all.
3414 The complete set of retry items might include an item to delete a
3415 routing retry if there was a previous routing delay. However, routing
3416 retries are also used when a remote transport identifies an address error.
3417 In that case, there may also be an "add" item for the same key. Arrange
3418 that a "delete" item is dropped in favour of an "add" item. */
3421 if (!addr) goto ADDR_MISMATCH;
3423 DEBUG(D_deliver|D_retry)
3424 debug_printf("reading retry information for %s from subprocess\n",
3427 /* Cut out any "delete" items on the list. */
3429 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3430 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3432 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3433 *rp = r->next; /* Excise a delete item */
3434 DEBUG(D_deliver|D_retry)
3435 debug_printf(" existing delete item dropped\n");
3438 /* We want to add a delete item only if there is no non-delete item;
3439 however we still have to step ptr through the data. */
3441 if (!r || !(*ptr & rf_delete))
3443 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3444 r->next = addr->retries;
3447 r->key = string_copy(ptr);
3449 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3450 ptr += sizeof(r->basic_errno);
3451 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3452 ptr += sizeof(r->more_errno);
3453 r->message = *ptr ? string_copy(ptr) : NULL;
3454 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3455 r->flags & rf_delete ? "delete" : "retry");
3460 DEBUG(D_deliver|D_retry)
3461 debug_printf(" delete item not added: non-delete item exists\n");
3464 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3470 /* Put the amount of data written into the parlist block */
3473 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3474 ptr += sizeof(transport_count);
3477 /* Address items are in the order of items on the address chain. We
3478 remember the current address value in case this function is called
3479 several times to empty the pipe in stages. Information about delivery
3480 over TLS is sent in a preceding X item for each address. We don't put
3481 it in with the other info, in order to keep each message short enough to
3482 guarantee it won't be split in the pipe. */
3485 case 'X': /* TLS details */
3486 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3490 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3494 addr->cipher = string_copy(ptr);
3495 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3499 addr->peerdn = string_copy(ptr);
3504 (void) tls_import_cert(ptr, &addr->peercert);
3506 addr->peercert = NULL;
3511 (void) tls_import_cert(ptr, &addr->ourcert);
3513 addr->ourcert = NULL;
3516 # ifndef DISABLE_OCSP
3518 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3524 #endif /*DISABLE_TLS*/
3526 case 'C': /* client authenticator information */
3529 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3530 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3531 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3536 #ifndef DISABLE_PRDR
3538 setflag(addr, af_prdr_used);
3545 #ifndef DISABLE_PIPE_CONNECT
3546 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3548 case 1: setflag(addr, af_pipelining); break;
3553 setflag(addr, af_chunking_used);
3557 setflag(addr, af_tcp_fastopen_conn);
3558 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3559 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3563 if (!addr) goto ADDR_MISMATCH;
3564 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3565 ptr += sizeof(addr->dsn_aware);
3566 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3569 case 'A': /* Per-address info */
3573 msg = string_sprintf("address count mismatch for data read from pipe "
3574 "for transport process %d for transport %s", pid,
3575 addrlist->transport->driver_name);
3582 case 3: /* explicit notification of continued-connection (non)use;
3583 overrides caller's knowlege. */
3584 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3585 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3588 #ifdef SUPPORT_SOCKS
3589 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3590 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3595 proxy_local_address = string_copy(ptr);
3597 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3598 ptr += sizeof(proxy_local_port);
3603 #ifdef EXPERIMENTAL_DSN_INFO
3604 case '1': /* must arrive before A0, and applies to that addr */
3605 /* Two strings: smtp_greeting and helo_response */
3606 addr->smtp_greeting = string_copy(ptr);
3608 addr->helo_response = string_copy(ptr);
3613 case '0': /* results of trying to send to this address */
3614 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3615 addr->transport_return = *ptr++;
3616 addr->special_action = *ptr++;
3617 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3618 ptr += sizeof(addr->basic_errno);
3619 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3620 ptr += sizeof(addr->more_errno);
3621 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3622 ptr += sizeof(addr->delivery_time);
3623 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3624 ptr += sizeof(addr->flags);
3625 addr->message = *ptr ? string_copy(ptr) : NULL;
3627 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3630 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3634 h = store_get(sizeof(host_item), GET_UNTAINTED);
3635 h->name = string_copy(ptr);
3637 h->address = string_copy(ptr);
3639 memcpy(&h->port, ptr, sizeof(h->port));
3640 ptr += sizeof(h->port);
3641 h->dnssec = *ptr == '2' ? DS_YES
3642 : *ptr == '1' ? DS_NO
3645 addr->host_used = h;
3649 /* Finished with this address */
3656 /* Local interface address/port */
3658 if (*ptr) sending_ip_address = string_copy(ptr);
3660 if (*ptr) sending_port = atoi(CS ptr);
3664 /* Z marks the logical end of the data. It is followed by '0' if
3665 continue_transport was NULL at the end of transporting, otherwise '1'.
3666 We need to know when it becomes NULL during a delivery down a passed SMTP
3667 channel so that we don't try to pass anything more down it. Of course, for
3668 most normal messages it will remain NULL all the time. */
3673 continue_transport = NULL;
3674 continue_hostname = NULL;
3677 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3680 /* Anything else is a disaster. */
3683 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3684 "process %d for transport %s", ptr[-1], pid,
3685 addr->transport->driver_name);
3691 /* The done flag is inspected externally, to determine whether or not to
3692 call the function again when the process finishes. */
3696 /* If the process hadn't finished, and we haven't seen the end of the data
3697 or if we suffered a disaster, update the rest of the state, and return FALSE to
3698 indicate "not finished". */
3707 /* Close our end of the pipe, to prevent deadlock if the far end is still
3708 pushing stuff into it. */
3713 /* If we have finished without error, but haven't had data for every address,
3714 something is wrong. */
3717 msg = string_sprintf("insufficient address data read from pipe "
3718 "for transport process %d for transport %s", pid,
3719 addr->transport->driver_name);
3721 /* If an error message is set, something has gone wrong in getting back
3722 the delivery data. Put the message into each address and freeze it. */
3725 for (addr = addrlist; addr; addr = addr->next)
3727 addr->transport_return = DEFER;
3728 addr->special_action = SPECIAL_FREEZE;
3729 addr->message = msg;
3730 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3733 /* Return TRUE to indicate we have got all we need from this process, even
3734 if it hasn't actually finished yet. */
3741 /*************************************************
3742 * Post-process a set of remote addresses *
3743 *************************************************/
3745 /* Do what has to be done immediately after a remote delivery for each set of
3746 addresses, then re-write the spool if necessary. Note that post_process_one
3747 puts the address on an appropriate queue; hence we must fish off the next
3748 one first. This function is also called if there is a problem with setting
3749 up a subprocess to do a remote delivery in parallel. In this case, the final
3750 argument contains a message, and the action must be forced to DEFER.
3753 addr pointer to chain of address items
3754 logflags flags for logging
3755 msg NULL for normal cases; -> error message for unexpected problems
3756 fallback TRUE if processing fallback hosts
3762 remote_post_process(address_item * addr, int logflags, uschar * msg,
3765 /* If any host addresses were found to be unusable, add them to the unusable
3766 tree so that subsequent deliveries don't try them. */
3768 for (host_item * h = addr->host_list; h; h = h->next)
3770 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3772 /* Now handle each address on the chain. The transport has placed '=' or '-'
3773 into the special_action field for each successful delivery. */
3777 address_item * next = addr->next;
3779 /* If msg == NULL (normal processing) and the result is DEFER and we are
3780 processing the main hosts and there are fallback hosts available, put the
3781 address on the list for fallback delivery. */
3783 if ( addr->transport_return == DEFER
3784 && addr->fallback_hosts
3789 addr->host_list = addr->fallback_hosts;
3790 addr->next = addr_fallback;
3791 addr_fallback = addr;
3792 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3795 /* If msg is set (=> unexpected problem), set it in the address before
3796 doing the ordinary post processing. */
3802 addr->message = msg;
3803 addr->transport_return = DEFER;
3805 (void)post_process_one(addr, addr->transport_return, logflags,
3806 EXIM_DTYPE_TRANSPORT, addr->special_action);
3814 /* If we have just delivered down a passed SMTP channel, and that was
3815 the last address, the channel will have been closed down. Now that
3816 we have logged that delivery, set continue_sequence to 1 so that
3817 any subsequent deliveries don't get "*" incorrectly logged. */
3819 if (!continue_transport) continue_sequence = 1;
3824 /*************************************************
3825 * Wait for one remote delivery subprocess *
3826 *************************************************/
3828 /* This function is called while doing remote deliveries when either the
3829 maximum number of processes exist and we need one to complete so that another
3830 can be created, or when waiting for the last ones to complete. It must wait for
3831 the completion of one subprocess, empty the control block slot, and return a
3832 pointer to the address chain.
3835 Returns: pointer to the chain of addresses handled by the process;
3836 NULL if no subprocess found - this is an unexpected error
3839 static address_item *
3842 int poffset, status;
3843 address_item * addr, * addrlist;
3846 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3847 "to finish", message_id);
3849 /* Loop until either a subprocess completes, or there are no subprocesses in
3850 existence - in which case give an error return. We cannot proceed just by
3851 waiting for a completion, because a subprocess may have filled up its pipe, and
3852 be waiting for it to be emptied. Therefore, if no processes have finished, we
3853 wait for one of the pipes to acquire some data by calling poll(), with a
3854 timeout just in case.
3856 The simple approach is just to iterate after reading data from a ready pipe.
3857 This leads to non-ideal behaviour when the subprocess has written its final Z
3858 item, closed the pipe, and is in the process of exiting (the common case). A
3859 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3860 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3863 To avoid this, if all the data that is needed has been read from a subprocess
3864 after poll(), an explicit wait() for it is done. We know that all it is doing
3865 is writing to the pipe and then exiting, so the wait should not be long.
3867 The non-blocking waitpid() is to some extent just insurance; if we could
3868 reliably detect end-of-file on the pipe, we could always know when to do a
3869 blocking wait() for a completed process. However, because some systems use
3870 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3871 use code that functions without the need to recognize EOF.
3873 There's a double loop here just in case we end up with a process that is not in
3874 the list of remote delivery processes. Something has obviously gone wrong if
3875 this is the case. (For example, a process that is incorrectly left over from
3876 routing or local deliveries might be found.) The damage can be minimized by
3877 looping back and looking for another process. If there aren't any, the error
3878 return will happen. */
3880 for (;;) /* Normally we do not repeat this loop */
3882 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3886 /* A return value of -1 can mean several things. If errno != ECHILD, it
3887 either means invalid options (which we discount), or that this process was
3888 interrupted by a signal. Just loop to try the waitpid() again.
3890 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3891 in existence. This should never happen, and is an unexpected error.
3892 However, there is a nasty complication when running under Linux. If "strace
3893 -f" is being used under Linux to trace this process and its children,
3894 subprocesses are "stolen" from their parents and become the children of the
3895 tracing process. A general wait such as the one we've just obeyed returns
3896 as if there are no children while subprocesses are running. Once a
3897 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3898 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3901 This does not happen using "truss" on Solaris, nor (I think) with other
3902 tracing facilities on other OS. It seems to be specific to Linux.
3904 What we do to get round this is to use kill() to see if any of our
3905 subprocesses are still in existence. If kill() gives an OK return, we know
3906 it must be for one of our processes - it can't be for a re-use of the pid,
3907 because if our process had finished, waitpid() would have found it. If any
3908 of our subprocesses are in existence, we proceed to use poll() as if
3909 waitpid() had returned zero. I think this is safe. */
3913 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3916 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3917 "for process existence\n");
3919 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3921 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3923 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3924 "stolen by strace\n", (int)pid);
3925 break; /* With poffset set */
3929 if (poffset >= remote_max_parallel)
3931 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3932 return NULL; /* This is the error return */
3936 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3937 been handled above. A return value of zero means that there is at least one
3938 subprocess, but there are no completed subprocesses. See if any pipes are
3939 ready with any data for reading. */
3941 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3943 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3944 if (parlist[poffset].pid != 0)
3946 parpoll[poffset].fd = parlist[poffset].fd;
3947 parpoll[poffset].events = POLLIN;
3950 parpoll[poffset].fd = -1;
3952 /* Stick in a 60-second timeout, just in case. */
3954 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3956 /* Scan through the pipes and read any that are ready; use the count
3957 returned by poll() to stop when there are no more. Select() can return
3958 with no processes (e.g. if interrupted). This shouldn't matter.
3960 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3961 read, or there was a disaster. In either case, we are finished with this
3962 process. Do an explicit wait() for the process and break the main loop if
3965 It turns out that we have to deal with the case of an interrupted system
3966 call, which can happen on some operating systems if the signal handling is
3967 set up to do that by default. */
3970 readycount > 0 && poffset < remote_max_parallel;
3973 if ( (pid = parlist[poffset].pid) != 0
3974 && parpoll[poffset].revents
3978 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3979 for (;;) /* Loop for signals */
3981 pid_t endedpid = waitpid(pid, &status, 0);
3982 if (endedpid == pid) goto PROCESS_DONE;
3983 if (endedpid != (pid_t)(-1) || errno != EINTR)
3984 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3985 "%d (errno = %d) from waitpid() for process %d",
3986 (int)endedpid, errno, (int)pid);
3991 /* Now go back and look for a completed subprocess again. */
3994 /* A completed process was detected by the non-blocking waitpid(). Find the
3995 data block that corresponds to this subprocess. */
3997 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3998 if (pid == parlist[poffset].pid) break;
4000 /* Found the data block; this is a known remote delivery process. We don't
4001 need to repeat the outer loop. This should be what normally happens. */
4003 if (poffset < remote_max_parallel) break;
4005 /* This situation is an error, but it's probably better to carry on looking
4006 for another process than to give up (as we used to do). */
4008 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4009 "transport process list", pid);
4010 } /* End of the "for" loop */
4012 /* Come here when all the data was completely read after a poll(), and
4013 the process in pid has been wait()ed for. */
4020 debug_printf("remote delivery process %d ended\n", (int)pid);
4022 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4026 set_process_info("delivering %s", message_id);
4028 /* Get the chain of processed addresses */
4030 addrlist = parlist[poffset].addrlist;
4032 /* If the process did not finish cleanly, record an error and freeze (except
4033 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4034 in case the delivery did actually happen. */
4036 if ((status & 0xffff) != 0)
4039 int msb = (status >> 8) & 255;
4040 int lsb = status & 255;
4041 int code = (msb == 0)? (lsb & 0x7f) : msb;
4043 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4045 addrlist->transport->driver_name,
4047 msb == 0 ? "terminated by signal" : "exit code",
4050 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4051 addrlist->special_action = SPECIAL_FREEZE;
4053 for (addr = addrlist; addr; addr = addr->next)
4055 addr->transport_return = DEFER;
4056 addr->message = msg;
4059 remove_journal = FALSE;
4062 /* Else complete reading the pipe to get the result of the delivery, if all
4063 the data has not yet been obtained. */
4065 else if (!parlist[poffset].done)
4066 (void) par_read_pipe(poffset, TRUE);
4068 /* Put the data count and return path into globals, mark the data slot unused,
4069 decrement the count of subprocesses, and return the address chain. */
4071 transport_count = parlist[poffset].transport_count;
4072 used_return_path = parlist[poffset].return_path;
4073 parlist[poffset].pid = 0;
4080 /*************************************************
4081 * Wait for subprocesses and post-process *
4082 *************************************************/
4084 /* This function waits for subprocesses until the number that are still running
4085 is below a given threshold. For each complete subprocess, the addresses are
4086 post-processed. If we can't find a running process, there is some shambles.
4087 Better not bomb out, as that might lead to multiple copies of the message. Just
4088 log and proceed as if all done.
4091 max maximum number of subprocesses to leave running
4092 fallback TRUE if processing fallback hosts
4098 par_reduce(int max, BOOL fallback)
4100 while (parcount > max)
4102 address_item * doneaddr = par_wait();
4105 log_write(0, LOG_MAIN|LOG_PANIC,
4106 "remote delivery process count got out of step");
4111 transport_instance * tp = doneaddr->transport;
4112 if (tp->max_parallel)
4113 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4115 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4121 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4123 uschar pipe_header[PIPE_HEADER_SIZE+1];
4124 size_t total_len = PIPE_HEADER_SIZE + size;
4126 struct iovec iov[2] = {
4127 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4128 { buf, size } /* *the* data */
4133 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4134 /* complain to log if someone tries with buffer sizes we can't handle*/
4136 if (size > BIG_BUFFER_SIZE-1)
4138 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4139 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4141 size = BIG_BUFFER_SIZE;
4144 /* Should we check that we do not write more than PIPE_BUF? What would
4147 /* convert size to human readable string prepended by id and subid */
4148 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4149 id, subid, (long)size))
4150 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4152 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4153 id, subid, (long)size, pipe_header);
4155 if ((ret = writev(fd, iov, 2)) != total_len)
4156 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4157 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4158 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4161 /*************************************************
4162 * Do remote deliveries *
4163 *************************************************/
4165 /* This function is called to process the addresses in addr_remote. We must
4166 pick off the queue all addresses that have the same transport, remote
4167 destination, and errors address, and hand them to the transport in one go,
4168 subject to some configured limitations. If this is a run to continue delivering
4169 to an existing delivery channel, skip all but those addresses that can go to
4170 that channel. The skipped addresses just get deferred.
4172 If mua_wrapper is set, all addresses must be able to be sent in a single
4173 transaction. If not, this function yields FALSE.
4175 In Exim 4, remote deliveries are always done in separate processes, even
4176 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4177 is so that the base process can retain privilege. This makes the
4178 implementation of fallback transports feasible (though not initially done.)
4180 We create up to the configured number of subprocesses, each of which passes
4181 back the delivery state via a pipe. (However, when sending down an existing
4182 connection, remote_max_parallel is forced to 1.)
4185 fallback TRUE if processing fallback hosts
4187 Returns: TRUE normally
4188 FALSE if mua_wrapper is set and the addresses cannot all be sent
4193 do_remote_deliveries(BOOL fallback)
4198 parcount = 0; /* Number of executing subprocesses */
4200 /* When sending down an existing channel, only do one delivery at a time.
4201 We use a local variable (parmax) to hold the maximum number of processes;
4202 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4204 if (continue_transport) remote_max_parallel = 1;
4205 parmax = remote_max_parallel;
4207 /* If the data for keeping a list of processes hasn't yet been
4212 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4213 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4214 parlist[poffset].pid = 0;
4215 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4218 /* Now loop for each remote delivery */
4220 for (int delivery_count = 0; addr_remote; delivery_count++)
4226 int address_count = 1;
4227 int address_count_max;
4229 BOOL use_initgroups;
4230 BOOL pipe_done = FALSE;
4231 transport_instance *tp;
4232 address_item **anchor = &addr_remote;
4233 address_item *addr = addr_remote;
4234 address_item *last = addr;
4237 uschar * serialize_key = NULL;
4239 /* Pull the first address right off the list. */
4241 addr_remote = addr->next;
4244 DEBUG(D_deliver|D_transport)
4245 debug_printf("--------> %s <--------\n", addr->address);
4247 /* If no transport has been set, there has been a big screw-up somewhere. */
4249 if (!(tp = addr->transport))
4251 f.disable_logging = FALSE; /* Jic */
4252 panicmsg = US"No transport set by router";
4253 goto panic_continue;
4256 /* Check that this base address hasn't previously been delivered to this
4257 transport. The check is necessary at this point to handle homonymic addresses
4258 correctly in cases where the pattern of redirection changes between delivery
4259 attempts. Non-homonymic previous delivery is detected earlier, at routing
4262 if (previously_transported(addr, FALSE)) continue;
4264 /* Force failure if the message is too big. */
4266 if (tp->message_size_limit)
4268 int rc = check_message_size(tp, addr);
4271 addr->transport_return = rc;
4272 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4277 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4278 So look out for the place it gets used.
4281 /* Get the flag which specifies whether the transport can handle different
4282 domains that nevertheless resolve to the same set of hosts. If it needs
4283 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4284 $host, $host_address, $host_port. */
4285 if (tp->expand_multi_domain)
4286 deliver_set_expansions(addr);
4288 if (exp_bool(addr, US"transport", tp->name, D_transport,
4289 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4290 &multi_domain) != OK)
4292 deliver_set_expansions(NULL);
4293 panicmsg = addr->message;
4294 goto panic_continue;
4297 /* Get the maximum it can handle in one envelope, with zero meaning
4298 unlimited, which is forced for the MUA wrapper case and if the
4299 value could vary depending on the messages.
4300 For those, we only split (below) by (tpt,dest,erraddr,hdrs) and rely on the
4301 transport splitting further by max_rcp. So we potentially lose some
4304 address_count_max = mua_wrapper || Ustrchr(tp->max_addresses, '$')
4305 ? UNLIMITED_ADDRS : expand_max_rcpt(tp->max_addresses);
4308 /************************************************************************/
4309 /***** This is slightly experimental code, but should be safe. *****/
4311 /* The address_count_max value is the maximum number of addresses that the
4312 transport can send in one envelope. However, the transport must be capable of
4313 dealing with any number of addresses. If the number it gets exceeds its
4314 envelope limitation, it must send multiple copies of the message. This can be
4315 done over a single connection for SMTP, so uses less resources than making
4316 multiple connections. On the other hand, if remote_max_parallel is greater
4317 than one, it is perhaps a good idea to use parallel processing to move the
4318 message faster, even if that results in multiple simultaneous connections to
4321 How can we come to some compromise between these two ideals? What we do is to
4322 limit the number of addresses passed to a single instance of a transport to
4323 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4324 number of addresses routed to remote transports divided by
4325 remote_max_parallel. For example, if the message has 100 remote recipients,
4326 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4327 once. But if rcpt_max is 100, we could send up to 100.
4329 Of course, not all the remotely addresses in a message are going to go to the
4330 same set of hosts (except in smarthost configurations), so this is just a
4331 heuristic way of dividing up the work.
4333 Furthermore (1), because this may not be wanted in some cases, and also to
4334 cope with really pathological cases, there is also a limit to the number of
4335 messages that are sent over one connection. This is the same limit that is
4336 used when sending several different messages over the same connection.
4337 Continue_sequence is set when in this situation, to the number sent so
4338 far, including this message.
4340 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4341 is probably because they are using VERP, in which case they want to pass only
4342 one address at a time to the transport, in order to be able to use
4343 $local_part and $domain in constructing a new return path. We could test for
4344 the use of these variables, but as it is so likely they will be used when the
4345 maximum is 1, we don't bother. Just leave the value alone. */
4347 if ( address_count_max != 1
4348 && address_count_max < remote_delivery_count/remote_max_parallel
4351 int new_max = remote_delivery_count/remote_max_parallel;
4352 int message_max = tp->connection_max_messages;
4353 if (connection_max_messages >= 0) message_max = connection_max_messages;
4354 message_max -= continue_sequence - 1;
4355 if (message_max > 0 && new_max > address_count_max * message_max)
4356 new_max = address_count_max * message_max;
4357 address_count_max = new_max;
4360 /************************************************************************/
4363 /*XXX don't know yet if DANE will be used. So tpt will have to
4364 check at the point if gets next addr from list, and skip/defer any
4368 /* Pick off all addresses which have the same transport, errors address,
4369 destination, and extra headers. In some cases they point to the same host
4370 list, but we also need to check for identical host lists generated from
4371 entirely different domains. The host list pointers can be NULL in the case
4372 where the hosts are defined in the transport. There is also a configured
4373 maximum limit of addresses that can be handled at once (see comments above
4374 for how it is computed).
4375 If the transport does not handle multiple domains, enforce that also,
4376 and if it might need a per-address check for this, re-evaluate it.
4379 while ((next = *anchor) && address_count < address_count_max)
4382 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4383 && tp == next->transport
4384 && same_hosts(next->host_list, addr->host_list)
4385 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4386 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4387 && same_ugid(tp, next, addr)
4388 && ( next->prop.remove_headers == addr->prop.remove_headers
4389 || ( next->prop.remove_headers
4390 && addr->prop.remove_headers
4391 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4395 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4397 US"transport", next->transport->name, D_transport,
4398 US"multi_domain", next->transport->multi_domain,
4399 next->transport->expand_multi_domain, &md) == OK
4404 *anchor = next->next;
4406 next->first = addr; /* remember top one (for retry processing) */
4411 else anchor = &(next->next);
4412 deliver_set_expansions(NULL);
4415 /* If we are acting as an MUA wrapper, all addresses must go in a single
4416 transaction. If not, put them back on the chain and yield FALSE. */
4418 if (mua_wrapper && addr_remote)
4420 last->next = addr_remote;
4425 /* If the transport is limited for parallellism, enforce that here.
4426 The hints DB entry is decremented in par_reduce(), when we reap the
4427 transport process. */
4429 if (tpt_parallel_check(tp, addr, &serialize_key))
4430 if ((panicmsg = expand_string_message))
4431 goto panic_continue;
4433 continue; /* Loop for the next set of addresses. */
4435 /* Set up the expansion variables for this set of addresses */
4437 deliver_set_expansions(addr);
4439 /* Ensure any transport-set auth info is fresh */
4440 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4442 /* Compute the return path, expanding a new one if required. The old one
4443 must be set first, as it might be referred to in the expansion. */
4445 if(addr->prop.errors_address)
4446 return_path = addr->prop.errors_address;
4448 return_path = sender_address;
4450 if (tp->return_path)
4452 uschar *new_return_path = expand_string(tp->return_path);
4453 if (new_return_path)
4454 return_path = new_return_path;
4455 else if (!f.expand_string_forcedfail)
4457 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4458 tp->return_path, expand_string_message);
4463 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4464 logs and sets up error messages, so we just post-process and continue with
4465 the next address. */
4467 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4473 /* If this transport has a setup function, call it now so that it gets
4474 run in this process and not in any subprocess. That way, the results of
4475 any setup that are retained by the transport can be reusable. One of the
4476 things the setup does is to set the fallback host lists in the addresses.
4477 That is why it is called at this point, before the continue delivery
4478 processing, because that might use the fallback hosts. */
4481 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4483 /* If we have a connection still open from a verify stage (lazy-close)
4484 treat it as if it is a continued connection (apart from the counter used
4485 for the log line mark). */
4487 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4490 debug_printf("lazy-callout-close: have conn still open from verification\n");
4491 continue_transport = cutthrough.transport;
4492 continue_hostname = string_copy(cutthrough.host.name);
4493 continue_host_address = string_copy(cutthrough.host.address);
4494 continue_sequence = 1;
4495 sending_ip_address = cutthrough.snd_ip;
4496 sending_port = cutthrough.snd_port;
4497 smtp_peer_options = cutthrough.peer_options;
4500 /* If this is a run to continue delivery down an already-established
4501 channel, check that this set of addresses matches the transport and
4502 the channel. If it does not, defer the addresses. If a host list exists,
4503 we must check that the continue host is on the list. Otherwise, the
4504 host is set in the transport. */
4506 f.continue_more = FALSE; /* In case got set for the last lot */
4507 if (continue_transport)
4509 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4510 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4512 /* If the transport is about to override the host list do not check
4513 it here but take the cost of running the transport process to discover
4514 if the continued_hostname connection is suitable. This is a layering
4515 violation which is unfortunate as it requires we haul in the smtp
4520 smtp_transport_options_block * ob;
4522 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4523 && (ob = (smtp_transport_options_block *)tp->options_block)
4524 && ob->hosts_override && ob->hosts
4530 for (host_item * h = addr->host_list; h; h = h->next)
4531 if (Ustrcmp(h->name, continue_hostname) == 0)
4532 /*XXX should also check port here */
4533 { ok = TRUE; break; }
4537 /* Addresses not suitable; defer or queue for fallback hosts (which
4538 might be the continue host) and skip to next address. */
4542 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4543 Ustrcmp(continue_transport, tp->name) != 0
4544 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4545 : string_sprintf("no host matching %s", continue_hostname));
4546 if (serialize_key) enq_end(serialize_key);
4548 if (addr->fallback_hosts && !fallback)
4550 for (next = addr; ; next = next->next)
4552 next->host_list = next->fallback_hosts;
4553 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4554 if (!next->next) break;
4556 next->next = addr_fallback;
4557 addr_fallback = addr;
4562 for (next = addr; ; next = next->next)
4564 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4565 if (!next->next) break;
4567 next->next = addr_defer;
4574 /* Set a flag indicating whether there are further addresses that list
4575 the continued host. This tells the transport to leave the channel open,
4576 but not to pass it to another delivery process. We'd like to do that
4577 for non-continue_transport cases too but the knowlege of which host is
4578 connected to is too hard to manage. Perhaps we need a finer-grain
4579 interface to the transport. */
4581 for (next = addr_remote; next && !f.continue_more; next = next->next)
4582 for (host_item * h = next->host_list; h; h = h->next)
4583 if (Ustrcmp(h->name, continue_hostname) == 0)
4584 { f.continue_more = TRUE; break; }
4587 /* The transports set up the process info themselves as they may connect
4588 to more than one remote machine. They also have to set up the filter
4589 arguments, if required, so that the host name and address are available
4592 transport_filter_argv = NULL;
4594 /* Create the pipe for inter-process communication. If pipe creation
4595 fails, it is probably because the value of remote_max_parallel is so
4596 large that too many file descriptors for pipes have been created. Arrange
4597 to wait for a process to finish, and then try again. If we still can't
4598 create a pipe when all processes have finished, break the retry loop. */
4602 if (pipe(pfd) == 0) pipe_done = TRUE;
4603 else if (parcount > 0) parmax = parcount;
4606 /* We need to make the reading end of the pipe non-blocking. There are
4607 two different options for this. Exim is cunningly (I hope!) coded so
4608 that it can use either of them, though it prefers O_NONBLOCK, which
4609 distinguishes between EOF and no-more-data. */
4611 /* The data appears in a timely manner and we already did a poll on
4612 all pipes, so I do not see a reason to use non-blocking IO here
4615 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4617 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4621 /* If the maximum number of subprocesses already exist, wait for a process
4622 to finish. If we ran out of file descriptors, parmax will have been reduced
4623 from its initial value of remote_max_parallel. */
4625 par_reduce(parmax - 1, fallback);
4628 /* If we failed to create a pipe and there were no processes to wait
4629 for, we have to give up on this one. Do this outside the above loop
4630 so that we can continue the main loop. */
4634 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4638 /* Find a free slot in the pardata list. Must do this after the possible
4639 waiting for processes to finish, because a terminating process will free
4642 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4643 if (parlist[poffset].pid == 0)
4646 /* If there isn't one, there has been a horrible disaster. */
4648 if (poffset >= remote_max_parallel)
4650 (void)close(pfd[pipe_write]);
4651 (void)close(pfd[pipe_read]);
4652 panicmsg = US"Unexpectedly no free subprocess slot";
4656 /* Now fork a subprocess to do the remote delivery, but before doing so,
4657 ensure that any cached resources are released so as not to interfere with
4658 what happens in the subprocess. */
4662 if ((pid = exim_fork(US"transport")) == 0)
4664 int fd = pfd[pipe_write];
4667 /* Setting these globals in the subprocess means we need never clear them */
4669 transport_name = tp->name;
4670 if (addr->router) router_name = addr->router->name;
4671 driver_srcfile = tp->srcfile;
4672 driver_srcline = tp->srcline;
4674 /* There are weird circumstances in which logging is disabled */
4675 f.disable_logging = tp->disable_logging;
4677 /* Show pids on debug output if parallelism possible */
4679 if (parmax > 1 && (parcount > 0 || addr_remote))
4680 DEBUG(D_any|D_v) debug_selector |= D_pid;
4682 /* Reset the random number generator, so different processes don't all
4683 have the same sequence. In the test harness we want different, but
4684 predictable settings for each delivery process, so do something explicit
4685 here rather they rely on the fixed reset in the random number function. */
4687 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4689 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4690 a new process that may be forked to do another delivery down the same
4693 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4695 /* Close open file descriptors for the pipes of other processes
4696 that are running in parallel. */
4698 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4699 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4701 /* This process has inherited a copy of the file descriptor
4702 for the data file, but its file pointer is shared with all the
4703 other processes running in parallel. Therefore, we have to re-open
4704 the file in order to get a new file descriptor with its own
4705 file pointer. We don't need to lock it, as the lock is held by
4706 the parent process. There doesn't seem to be any way of doing
4707 a dup-with-new-file-pointer. */
4709 (void)close(deliver_datafile);
4711 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4713 if ( (deliver_datafile = Uopen(fname, EXIM_CLOEXEC | O_RDWR | O_APPEND, 0))
4715 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4716 "parallel delivery: %s", fname, strerror(errno));
4719 #ifndef O_CLOEXEC /* Set the close-on-exec flag */
4720 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4724 /* Set the uid/gid of this process; bombs out on failure. */
4726 exim_setugid(uid, gid, use_initgroups,
4727 string_sprintf("remote delivery to %s with transport=%s",
4728 addr->address, tp->name));
4730 /* Close the unwanted half of this process' pipe, set the process state,
4731 and run the transport. Afterwards, transport_count will contain the number
4732 of bytes written. */
4734 (void)close(pfd[pipe_read]);
4735 set_process_info("delivering %s using %s", message_id, tp->name);
4736 debug_print_string(tp->debug_string);
4737 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4739 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4740 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4742 /* Ensure any cached resources that we used are now released */
4746 /* Pass the result back down the pipe. This is a lot more information
4747 than is needed for a local delivery. We have to send back the error
4748 status for each address, the usability status for each host that is
4749 flagged as unusable, and all the retry items. When TLS is in use, we
4750 send also the cipher and peerdn information. Each type of information
4751 is flagged by an identifying byte, and is then in a fixed format (with
4752 strings terminated by zeros), and there is a final terminator at the
4753 end. The host information and retry information is all attached to
4754 the first address, so that gets sent at the start. */
4756 /* Host unusability information: for most success cases this will
4759 for (h = addr->host_list; h; h = h->next)
4761 if (!h->address || h->status < hstatus_unusable) continue;
4762 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4763 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4766 /* The number of bytes written. This is the same for each address. Even
4767 if we sent several copies of the message down the same connection, the
4768 size of each one is the same, and it's that value we have got because
4769 transport_count gets reset before calling transport_write_message(). */
4771 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4772 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4774 /* Information about what happened to each address. Four item types are
4775 used: an optional 'X' item first, for TLS information, then an optional "C"
4776 item for any client-auth info followed by 'R' items for any retry settings,
4777 and finally an 'A' item for the remaining data. */
4779 for(; addr; addr = addr->next)
4783 /* The certificate verification status goes into the flags */
4784 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4786 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4788 # ifndef DISABLE_TLS_RESUME
4789 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4792 /* Use an X item only if there's something to send */
4796 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4800 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4802 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4804 else if (continue_proxy_cipher)
4806 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4808 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4814 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4818 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4823 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4827 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4829 # ifndef DISABLE_OCSP
4830 if (addr->ocsp > OCSP_NOT_REQ)
4832 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4833 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4836 #endif /*DISABLE_TLS*/
4838 if (client_authenticator)
4840 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4841 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4843 if (client_authenticated_id)
4845 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4846 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4848 if (client_authenticated_sender)
4850 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4851 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4854 #ifndef DISABLE_PRDR
4855 if (testflag(addr, af_prdr_used))
4856 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4859 if (testflag(addr, af_pipelining))
4860 #ifndef DISABLE_PIPE_CONNECT
4861 if (testflag(addr, af_early_pipe))
4862 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4865 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4867 if (testflag(addr, af_chunking_used))
4868 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4870 if (testflag(addr, af_tcp_fastopen_conn))
4871 rmt_dlv_checked_write(fd, 'T',
4872 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4876 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4877 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4879 /* Retry information: for most success cases this will be null. */
4881 for (retry_item * r = addr->retries; r; r = r->next)
4883 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4884 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4885 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4886 ptr += sizeof(r->basic_errno);
4887 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4888 ptr += sizeof(r->more_errno);
4889 if (!r->message) *ptr++ = 0; else
4891 sprintf(CS ptr, "%.512s", r->message);
4894 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4897 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4899 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4900 testflag(addr, af_new_conn) ? "non-" : "");
4901 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4902 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4905 #ifdef SUPPORT_SOCKS
4906 if (LOGGING(proxy) && proxy_session)
4909 if (proxy_local_address)
4911 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4912 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4913 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4914 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4915 ptr += sizeof(proxy_local_port);
4919 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4923 #ifdef EXPERIMENTAL_DSN_INFO
4924 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4925 if (addr->smtp_greeting)
4927 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4928 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4929 if (addr->helo_response)
4931 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4932 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4936 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4940 /* The rest of the information goes in an 'A0' item. */
4942 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4943 ptr = big_buffer + 2;
4944 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4945 ptr += sizeof(addr->basic_errno);
4946 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4947 ptr += sizeof(addr->more_errno);
4948 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4949 ptr += sizeof(addr->delivery_time);
4950 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4951 ptr += sizeof(addr->flags);
4953 if (!addr->message) *ptr++ = 0; else
4954 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4956 if (!addr->user_message) *ptr++ = 0; else
4957 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4959 if (!addr->host_used) *ptr++ = 0; else
4961 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4962 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4963 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4964 ptr += sizeof(addr->host_used->port);
4966 /* DNS lookup status */
4967 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4968 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4971 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4974 /* Local interface address/port */
4975 #ifdef EXPERIMENTAL_DSN_INFO
4976 if (sending_ip_address)
4978 if (LOGGING(incoming_interface) && sending_ip_address)
4982 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4983 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4984 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4987 /* Add termination flag, close the pipe, and that's it. The character
4988 after 'Z' indicates whether continue_transport is now NULL or not.
4989 A change from non-NULL to NULL indicates a problem with a continuing
4992 big_buffer[0] = continue_transport ? '1' : '0';
4993 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4998 /* Back in the mainline: close the unwanted half of the pipe. */
5000 (void)close(pfd[pipe_write]);
5002 /* If we have a connection still open from a verify stage (lazy-close)
5003 release its TLS library context (if any) as responsibility was passed to
5004 the delivery child process. */
5006 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5009 if (cutthrough.is_tls)
5010 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5012 (void) close(cutthrough.cctx.sock);
5013 release_cutthrough_connection(US"passed to transport proc");
5016 /* Fork failed; defer with error message */
5020 (void)close(pfd[pipe_read]);
5021 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5022 addr->domain, strerror(errno));
5026 /* Fork succeeded; increment the count, and remember relevant data for
5027 when the process finishes. */
5030 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5031 parlist[poffset].pid = pid;
5032 parlist[poffset].fd = pfd[pipe_read];
5033 parlist[poffset].done = FALSE;
5034 parlist[poffset].msg = NULL;
5035 parlist[poffset].return_path = return_path;
5037 /* If the process we've just started is sending a message down an existing
5038 channel, wait for it now. This ensures that only one such process runs at
5039 once, whatever the value of remote_max parallel. Otherwise, we might try to
5040 send two or more messages simultaneously down the same channel. This could
5041 happen if there are different domains that include the same host in otherwise
5042 different host lists.
5044 Also, if the transport closes down the channel, this information gets back
5045 (continue_transport gets set to NULL) before we consider any other addresses
5048 if (continue_transport) par_reduce(0, fallback);
5050 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5051 newly created process get going before we create another process. This should
5052 ensure repeatability in the tests. Wait long enough for most cases to complete
5055 else testharness_pause_ms(600);
5060 if (serialize_key) enq_end(serialize_key);
5062 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5066 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5067 are still running and post-process their addresses. */
5069 par_reduce(0, fallback);
5076 /*************************************************
5077 * Split an address into local part and domain *
5078 *************************************************/
5080 /* This function initializes an address for routing by splitting it up into a
5081 local part and a domain. The local part is set up twice - once in its original
5082 casing, and once in lower case, and it is dequoted. We also do the "percent
5083 hack" for configured domains. This may lead to a DEFER result if a lookup
5084 defers. When a percent-hacking takes place, we insert a copy of the original
5085 address as a new parent of this address, as if we have had a redirection.
5088 addr points to an addr_item block containing the address
5091 DEFER - could not determine if domain is %-hackable
5095 deliver_split_address(address_item * addr)
5097 uschar * address = addr->address;
5102 if (!(domain = Ustrrchr(address, '@')))
5103 return DEFER; /* should always have a domain, but just in case... */
5105 len = domain - address;
5106 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5108 /* The implication in the RFCs (though I can't say I've seen it spelled out
5109 explicitly) is that quoting should be removed from local parts at the point
5110 where they are locally interpreted. [The new draft "821" is more explicit on
5111 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5112 removing quoting backslashes and any unquoted doublequotes. */
5114 t = addr->cc_local_part = store_get(len+1, address);
5118 if (c == '\"') continue;
5128 /* We do the percent hack only for those domains that are listed in
5129 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5131 if (percent_hack_domains)
5134 uschar *new_address = NULL;
5135 uschar *local_part = addr->cc_local_part;
5137 deliver_domain = addr->domain; /* set $domain */
5139 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5140 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5142 && (t = Ustrrchr(local_part, '%')) != NULL
5145 new_address = string_copy(local_part);
5146 new_address[t - local_part] = '@';
5147 deliver_domain = string_copylc(t+1);
5148 local_part = string_copyn(local_part, t - local_part);
5151 if (rc == DEFER) return DEFER; /* lookup deferred */
5153 /* If hackery happened, set up new parent and alter the current address. */
5157 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5158 *new_parent = *addr;
5159 addr->parent = new_parent;
5160 new_parent->child_count = 1;
5161 addr->address = new_address;
5162 addr->unique = string_copy(new_address);
5163 addr->domain = deliver_domain;
5164 addr->cc_local_part = local_part;
5165 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5170 /* Create the lowercased version of the final local part, and make that the
5171 default one to be used. */
5173 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5180 /*************************************************
5181 * Get next error message text *
5182 *************************************************/
5184 /* If f is not NULL, read the next "paragraph", from a customized error message
5185 text file, terminated by a line containing ****, and expand it.
5188 f NULL or a file to read from
5189 which string indicating which string (for errors)
5191 Returns: NULL or an expanded string
5195 next_emf(FILE *f, uschar *which)
5201 if (!f) return NULL;
5203 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5206 para = string_get(256);
5209 para = string_cat(para, buffer);
5210 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5213 if ((yield = expand_string(string_from_gstring(para))))
5216 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5217 "bounce_message_file or warn_message_file (%s): %s", which,
5218 expand_string_message);
5225 /*************************************************
5226 * Close down a passed transport channel *
5227 *************************************************/
5229 /* This function is called when a passed transport channel cannot be used.
5230 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5231 so that the function call can be the argument of a "return" statement.
5234 Returns: DELIVER_NOT_ATTEMPTED
5238 continue_closedown(void)
5240 if (continue_transport)
5241 for (transport_instance * t = transports; t; t = t->next)
5242 if (Ustrcmp(t->name, continue_transport) == 0)
5244 if (t->info->closedown) (t->info->closedown)(t);
5247 return DELIVER_NOT_ATTEMPTED;
5253 /*************************************************
5254 * Print address information *
5255 *************************************************/
5257 /* This function is called to output an address, or information about an
5258 address, for bounce or defer messages. If the hide_child flag is set, all we
5259 output is the original ancestor address.
5262 addr points to the address
5263 f the FILE to print to
5264 si an initial string
5265 sc a continuation string for before "generated"
5268 Returns: TRUE if the address is not hidden
5272 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5276 uschar *printed = US"";
5277 address_item *ancestor = addr;
5278 while (ancestor->parent) ancestor = ancestor->parent;
5280 fprintf(f, "%s", CS si);
5282 if (addr->parent && testflag(addr, af_hide_child))
5284 printed = US"an undisclosed address";
5287 else if (!testflag(addr, af_pfr) || !addr->parent)
5288 printed = addr->address;
5292 uschar *s = addr->address;
5295 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5296 else if (addr->address[0] == '|') ss = US"pipe";
5299 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5300 printed = addr->parent->address;
5303 fprintf(f, "%s", CS string_printing(printed));
5305 if (ancestor != addr)
5307 uschar *original = ancestor->onetime_parent;
5308 if (!original) original= ancestor->address;
5309 if (strcmpic(original, printed) != 0)
5310 fprintf(f, "%s(%sgenerated from %s)", sc,
5311 ancestor != addr->parent ? "ultimately " : "",
5312 string_printing(original));
5315 if (addr->host_used)
5316 fprintf(f, "\n host %s [%s]",
5317 addr->host_used->name, addr->host_used->address);
5319 fprintf(f, "%s", CS se);
5327 /*************************************************
5328 * Print error for an address *
5329 *************************************************/
5331 /* This function is called to print the error information out of an address for
5332 a bounce or a warning message. It tries to format the message reasonably by
5333 introducing newlines. All lines are indented by 4; the initial printing
5334 position must be set before calling.
5336 This function used always to print the error. Nowadays we want to restrict it
5337 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5338 and filter "fail". We no longer pass other information willy-nilly in bounce
5339 and warning messages. Text in user_message is always output; text in message
5340 only if the af_pass_message flag is set.
5344 f the FILE to print on
5351 print_address_error(address_item * addr, FILE * f, const uschar * t)
5353 int count = Ustrlen(t);
5354 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5356 if (!s && !(s = addr->user_message))
5359 fprintf(f, "\n %s", t);
5362 if (*s == '\\' && s[1] == 'n')
5372 if (*s++ == ':' && isspace(*s) && count > 45)
5374 fprintf(f, "\n "); /* sic (because space follows) */
5377 else if (count > 254) /* arbitrary limit */
5379 fprintf(f, "[truncated]");
5380 do s++; while (*s && !(*s == '\\' && s[1] == '\n'));
5386 /***********************************************************
5387 * Print Diagnostic-Code for an address *
5388 ************************************************************/
5390 /* This function is called to print the error information out of an address for
5391 a bounce or a warning message. It tries to format the message reasonably as
5392 required by RFC 3461 by adding a space after each newline
5394 it uses the same logic as print_address_error() above. if af_pass_message is true
5395 and addr->message is set it uses the remote host answer. if not addr->user_message
5396 is used instead if available.
5400 f the FILE to print on
5406 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5408 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5411 /* af_pass_message and addr->message set ? print remote host answer */
5416 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5418 /* search first ": ". we assume to find the remote-MTA answer there */
5419 if (!(s = Ustrstr(addr->message, ": ")))
5420 return; /* not found, bail out */
5422 s += 2; /* skip ": " */
5423 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5427 if (cnt > 950) /* RFC line length limit: 998 */
5429 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5430 fputs("[truncated]", f);
5434 if (*s == '\\' && s[1] == 'n')
5436 fputs("\n ", f); /* as defined in RFC 3461 */
5451 /*************************************************
5452 * Check list of addresses for duplication *
5453 *************************************************/
5455 /* This function was introduced when the test for duplicate addresses that are
5456 not pipes, files, or autoreplies was moved from the middle of routing to when
5457 routing was complete. That was to fix obscure cases when the routing history
5458 affects the subsequent routing of identical addresses. This function is called
5459 after routing, to check that the final routed addresses are not duplicates.
5461 If we detect a duplicate, we remember what it is a duplicate of. Note that
5462 pipe, file, and autoreply de-duplication is handled during routing, so we must
5463 leave such "addresses" alone here, as otherwise they will incorrectly be
5466 Argument: address of list anchor
5471 do_duplicate_check(address_item **anchor)
5474 while ((addr = *anchor))
5477 if (testflag(addr, af_pfr))
5479 anchor = &(addr->next);
5481 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5483 DEBUG(D_deliver|D_route)
5484 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5485 *anchor = addr->next;
5486 addr->dupof = tnode->data.ptr;
5487 addr->next = addr_duplicate;
5488 addr_duplicate = addr;
5492 tree_add_duplicate(addr->unique, addr);
5493 anchor = &(addr->next);
5501 /************************************************/
5504 print_dsn_addr_action(FILE * f, address_item * addr,
5505 uschar * action, uschar * status)
5509 if (addr->dsn_orcpt)
5510 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5512 for (pa = addr; pa->parent; ) pa = pa->parent;
5513 fprintf(f, "Action: %s\n"
5514 "Final-Recipient: rfc822;%s\n"
5516 action, pa->address, status);
5521 /* When running in the test harness, there's an option that allows us to
5522 fudge this time so as to get repeatability of the tests. Take the first
5523 time off the list. In queue runs, the list pointer gets updated in the
5527 test_harness_fudged_queue_time(int actual_time)
5530 if ( f.running_in_test_harness && *fudged_queue_times
5531 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5533 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5534 fudged_queue_times);
5540 /************************************************/
5543 expand_open(const uschar * filename,
5544 const uschar * varname, const uschar * reason)
5546 const uschar * s = expand_cstring(filename);
5550 log_write(0, LOG_MAIN|LOG_PANIC,
5551 "Failed to expand %s: '%s'\n", varname, filename);
5552 else if (*s != '/' || is_tainted(s))
5553 log_write(0, LOG_MAIN|LOG_PANIC,
5554 "%s is not %s after expansion: '%s'\n",
5555 varname, *s == '/' ? "untainted" : "absolute", s);
5556 else if (!(fp = Ufopen(s, "rb")))
5557 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5558 "message texts: %s", s, reason, strerror(errno));
5563 /* Output the given header and string, converting either
5564 the sequence "\n" or a real newline into newline plus space.
5565 If that still takes us past column 78, look for the last space
5566 and split there too.
5567 Append a newline if string did not have one.
5568 Limit to about 1024 chars total. */
5571 dsn_put_wrapped(FILE * fp, const uschar * header, const uschar * s)
5573 gstring * g = string_cat(NULL, header);
5575 g = string_cat(g, s);
5576 gstring_release_unused(g);
5577 fprintf(fp, "%s\n", wrap_header(string_from_gstring(g), 79, 1023, US" ", 1));
5583 /*************************************************
5584 * Send a bounce message *
5585 *************************************************/
5587 /* Find the error address for the first address, then send a message that
5588 includes all failed addresses that have the same error address. Note the
5589 bounce_recipient is a global so that it can be accessed by $bounce_recipient
5590 while creating a customized error message. */
5593 send_bounce_message(time_t now, const uschar * logtod)
5598 if (!(bounce_recipient = addr_failed->prop.errors_address))
5599 bounce_recipient = sender_address;
5601 /* Make a subprocess to send a message, using its stdin */
5603 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
5604 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5605 "create child process to send failure message: %s", getpid(),
5606 getppid(), strerror(errno));
5608 /* Creation of child succeeded */
5612 int ch, rc, filecount = 0, rcount = 0;
5613 uschar * bcc, * emf_text;
5614 FILE * fp = fdopen(fd, "wb"), * emf = NULL;
5615 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5616 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5617 DELIVER_IN_BUFFER_SIZE;
5618 uschar * bound, * dsnlimitmsg, * dsnnotifyhdr;
5620 address_item ** paddr;
5621 address_item * msgchain = NULL, ** pmsgchain = &msgchain;
5622 address_item * handled_addr = NULL;
5625 debug_printf("sending error message to: %s\n", bounce_recipient);
5627 /* Scan the addresses for all that have the same errors address, removing
5628 them from the addr_failed chain, and putting them on msgchain. */
5630 paddr = &addr_failed;
5631 for (address_item * addr = addr_failed; addr; addr = *paddr)
5632 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
5633 ? addr->prop.errors_address : sender_address) == 0)
5634 { /* The same - dechain */
5635 *paddr = addr->next;
5638 pmsgchain = &addr->next;
5641 paddr = &addr->next; /* Not the same; skip */
5643 /* Include X-Failed-Recipients: for automatic interpretation, but do
5644 not let any one header line get too long. We do this by starting a
5645 new header every 50 recipients. Omit any addresses for which the
5646 "hide_child" flag is set. */
5648 for (address_item * addr = msgchain; addr; addr = addr->next)
5650 if (testflag(addr, af_hide_child)) continue;
5658 ? "X-Failed-Recipients: "
5660 testflag(addr, af_pfr) && addr->parent
5661 ? string_printing(addr->parent->address)
5662 : string_printing(addr->address));
5664 if (rcount > 0) fprintf(fp, "\n");
5666 /* Output the standard headers */
5668 if (errors_reply_to)
5669 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
5670 fprintf(fp, "Auto-Submitted: auto-replied\n");
5671 moan_write_from(fp);
5672 fprintf(fp, "To: %s\n", bounce_recipient);
5673 moan_write_references(fp, NULL);
5675 /* generate boundary string and output MIME-Headers */
5676 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
5678 fprintf(fp, "Content-Type: multipart/report;"
5679 " report-type=delivery-status; boundary=%s\n"
5680 "MIME-Version: 1.0\n",
5683 /* Open a template file if one is provided. Log failure to open, but
5684 carry on - default texts will be used. */
5686 if (bounce_message_file)
5687 emf = expand_open(bounce_message_file,
5688 US"bounce_message_file", US"error");
5690 /* Quietly copy to configured additional addresses if required. */
5692 if ((bcc = moan_check_errorcopy(bounce_recipient)))
5693 fprintf(fp, "Bcc: %s\n", bcc);
5695 /* The texts for the message can be read from a template file; if there
5696 isn't one, or if it is too short, built-in texts are used. The first
5697 emf text is a Subject: and any other headers. */
5699 if ((emf_text = next_emf(emf, US"header")))
5700 fprintf(fp, "%s\n", emf_text);
5702 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
5703 to_sender? ": returning message to sender" : "");
5705 /* output human readable part as text/plain section */
5706 fprintf(fp, "--%s\n"
5707 "Content-type: text/plain; charset=us-ascii\n\n",
5710 if ((emf_text = next_emf(emf, US"intro")))
5711 fprintf(fp, "%s", CS emf_text);
5715 /* This message has been reworded several times. It seems to be confusing to
5716 somebody, however it is worded. I have retreated to the original, simple
5718 "This message was created automatically by mail delivery software.\n");
5720 if (bounce_message_text)
5721 fprintf(fp, "%s", CS bounce_message_text);
5724 "\nA message that you sent could not be delivered to one or more of its\n"
5725 "recipients. This is a permanent error. The following address(es) failed:\n");
5728 "\nA message sent by\n\n <%s>\n\n"
5729 "could not be delivered to one or more of its recipients. The following\n"
5730 "address(es) failed:\n", sender_address);
5734 /* Process the addresses, leaving them on the msgchain if they have a
5735 file name for a return message. (There has already been a check in
5736 post_process_one() for the existence of data in the message file.) A TRUE
5737 return from print_address_information() means that the address is not
5741 for (address_item * addr = msgchain; addr; addr = *paddr)
5743 if (print_address_information(addr, fp, US" ", US"\n ", US""))
5744 print_address_error(addr, fp, US"");
5746 /* End the final line for the address */
5750 /* Leave on msgchain if there's a return file. */
5752 if (addr->return_file >= 0)
5754 paddr = &(addr->next);
5758 /* Else save so that we can tick off the recipient when the
5763 *paddr = addr->next;
5764 addr->next = handled_addr;
5765 handled_addr = addr;
5771 /* Get the next text, whether we need it or not, so as to be
5772 positioned for the one after. */
5774 emf_text = next_emf(emf, US"generated text");
5776 /* If there were any file messages passed by the local transports,
5777 include them in the message. Then put the address on the handled chain.
5778 In the case of a batch of addresses that were all sent to the same
5779 transport, the return_file field in all of them will contain the same
5780 fd, and the return_filename field in the *last* one will be set (to the
5781 name of the file). */
5785 address_item * nextaddr;
5788 fprintf(fp, "%s", CS emf_text);
5791 "The following text was generated during the delivery "
5792 "attempt%s:\n", (filecount > 1)? "s" : "");
5794 for (address_item * addr = msgchain; addr; addr = nextaddr)
5797 address_item *topaddr = addr;
5799 /* List all the addresses that relate to this file */
5802 while(addr) /* Insurance */
5804 print_address_information(addr, fp, US"------ ", US"\n ",
5806 if (addr->return_filename) break;
5811 /* Now copy the file */
5813 if (!(fm = Ufopen(addr->return_filename, "rb")))
5814 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
5818 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
5821 Uunlink(addr->return_filename);
5823 /* Can now add to handled chain, first fishing off the next
5824 address on the msgchain. */
5826 nextaddr = addr->next;
5827 addr->next = handled_addr;
5828 handled_addr = topaddr;
5833 /* output machine readable part */
5835 if (message_smtputf8)
5836 fprintf(fp, "--%s\n"
5837 "Content-type: message/global-delivery-status\n\n"
5838 "Reporting-MTA: dns; %s\n",
5839 bound, smtp_active_hostname);
5842 fprintf(fp, "--%s\n"
5843 "Content-type: message/delivery-status\n\n"
5844 "Reporting-MTA: dns; %s\n",
5845 bound, smtp_active_hostname);
5849 /* must be decoded from xtext: see RFC 3461:6.3a */
5850 uschar * xdec_envid;
5851 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
5852 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
5854 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
5858 for (address_item * addr = handled_addr; addr; addr = addr->next)
5862 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
5864 if ((hu = addr->host_used) && hu->name)
5866 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
5867 #ifdef EXPERIMENTAL_DSN_INFO
5872 uschar * p = hu->port == 25
5873 ? US"" : string_sprintf(":%d", hu->port);
5874 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
5876 if ((s = addr->smtp_greeting) && *s)
5877 dsn_put_wrapped(fp, US"X-Remote-MTA-smtp-greeting: X-str; ", s);
5878 if ((s = addr->helo_response) && *s)
5879 dsn_put_wrapped(fp, US"X-Remote-MTA-helo-response: X-str; ", s);
5880 if ((s = addr->message) && *s)
5881 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5884 print_dsn_diagnostic_code(addr, fp);
5889 /* Now copy the message, trying to give an intelligible comment if
5890 it is too long for it all to be copied. The limit isn't strictly
5891 applied because of the buffering. There is, however, an option
5892 to suppress copying altogether. */
5894 emf_text = next_emf(emf, US"copy");
5897 we ignore the intro text from template and add
5898 the text for bounce_return_size_limit at the end.
5900 bounce_return_message is ignored
5901 in case RET= is defined we honor these values
5902 otherwise bounce_return_body is honored.
5904 bounce_return_size_limit is always honored.
5907 fprintf(fp, "--%s\n", bound);
5909 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
5910 dsnnotifyhdr = NULL;
5911 topt = topt_add_return_path;
5913 /* RET=HDRS? top priority */
5914 if (dsn_ret == dsn_ret_hdrs)
5915 topt |= topt_no_body;
5918 struct stat statbuf;
5920 /* no full body return at all? */
5921 if (!bounce_return_body)
5923 topt |= topt_no_body;
5924 /* add header if we overrule RET=FULL */
5925 if (dsn_ret == dsn_ret_full)
5926 dsnnotifyhdr = dsnlimitmsg;
5928 /* line length limited... return headers only if oversize */
5929 /* size limited ... return headers only if limit reached */
5930 else if ( max_received_linelength > bounce_return_linesize_limit
5931 || ( bounce_return_size_limit > 0
5932 && fstat(deliver_datafile, &statbuf) == 0
5933 && statbuf.st_size > max
5936 topt |= topt_no_body;
5937 dsnnotifyhdr = dsnlimitmsg;
5942 if (message_smtputf8)
5943 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
5944 : "Content-type: message/global\n\n",
5948 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
5949 : "Content-type: message/rfc822\n\n",
5953 transport_filter_argv = NULL; /* Just in case */
5954 return_path = sender_address; /* In case not previously set */
5955 { /* Dummy transport for headers add */
5956 transport_ctx tctx = {{0}};
5957 transport_instance tb = {0};
5959 tctx.u.fd = fileno(fp);
5961 tctx.options = topt | topt_truncate_headers;
5962 tb.add_headers = dsnnotifyhdr;
5964 /*XXX no checking for failure! buggy! */
5965 transport_write_message(&tctx, 0);
5969 /* we never add the final text. close the file */
5973 fprintf(fp, "\n--%s--\n", bound);
5975 /* Close the file, which should send an EOF to the child process
5976 that is receiving the message. Wait for it to finish. */
5979 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
5981 /* If the process failed, there was some disaster in setting up the
5982 error message. Unless the message is very old, ensure that addr_defer
5983 is non-null, which will have the effect of leaving the message on the
5984 spool. The failed addresses will get tried again next time. However, we
5985 don't really want this to happen too often, so freeze the message unless
5986 there are some genuine deferred addresses to try. To do this we have
5987 to call spool_write_header() here, because with no genuine deferred
5988 addresses the normal code below doesn't get run. */
5993 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
5995 addr_defer = (address_item *)(+1);
5996 f.deliver_freeze = TRUE;
5997 deliver_frozen_at = time(NULL);
5998 /* Panic-dies on error */
5999 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6002 deliver_msglog("Process failed (%d) when writing error message "
6003 "to %s%s", rc, bounce_recipient, s);
6004 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6005 "to %s%s", rc, bounce_recipient, s);
6008 /* The message succeeded. Ensure that the recipients that failed are
6009 now marked finished with on the spool and their parents updated. */
6013 for (address_item * addr = handled_addr; addr; addr = addr->next)
6015 address_done(addr, logtod);
6016 child_done(addr, logtod);
6018 /* Panic-dies on error */
6019 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6024 /*************************************************
6025 * Send a warning message *
6026 *************************************************/
6027 /* Return: boolean success */
6030 send_warning_message(const uschar * recipients, int queue_time, int show_time)
6033 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
6034 FILE * wmf = NULL, * f = fdopen(fd, "wb");
6035 uschar * wmf_text, * bound;
6036 transport_ctx tctx = {{0}};
6039 if (pid <= 0) return FALSE;
6041 if (warn_message_file)
6042 wmf = expand_open(warn_message_file,
6043 US"warn_message_file", US"warning");
6045 warnmsg_recipients = recipients;
6046 warnmsg_delay = queue_time < 120*60
6047 ? string_sprintf("%d minutes", show_time/60)
6048 : string_sprintf("%d hours", show_time/3600);
6050 if (errors_reply_to)
6051 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6052 fprintf(f, "Auto-Submitted: auto-replied\n");
6054 fprintf(f, "To: %s\n", recipients);
6055 moan_write_references(f, NULL);
6057 /* generated boundary string and output MIME-Headers */
6058 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6060 fprintf(f, "Content-Type: multipart/report;"
6061 " report-type=delivery-status; boundary=%s\n"
6062 "MIME-Version: 1.0\n",
6065 if ((wmf_text = next_emf(wmf, US"header")))
6066 fprintf(f, "%s\n", wmf_text);
6068 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6069 message_id, warnmsg_delay);
6071 /* output human readable part as text/plain section */
6073 "Content-type: text/plain; charset=us-ascii\n\n",
6076 if ((wmf_text = next_emf(wmf, US"intro")))
6077 fprintf(f, "%s", CS wmf_text);
6081 "This message was created automatically by mail delivery software.\n");
6083 if (Ustrcmp(recipients, sender_address) == 0)
6085 "A message that you sent has not yet been delivered to one or more of its\n"
6086 "recipients after more than ");
6090 "A message sent by\n\n <%s>\n\n"
6091 "has not yet been delivered to one or more of its recipients after more than \n",
6094 fprintf(f, "%s on the queue on %s.\n\n"
6095 "The message identifier is: %s\n",
6096 warnmsg_delay, primary_hostname, message_id);
6098 for (header_line * h = header_list; h; h = h->next)
6099 if (strncmpic(h->text, US"Subject:", 8) == 0)
6100 fprintf(f, "The subject of the message is: %s", h->text + 9);
6101 else if (strncmpic(h->text, US"Date:", 5) == 0)
6102 fprintf(f, "The date of the message is: %s", h->text + 6);
6105 fprintf(f, "The address%s to which the message has not yet been "
6107 !addr_defer->next ? "" : "es",
6108 !addr_defer->next ? "is": "are");
6111 /* List the addresses, with error information if allowed */
6114 for (address_item * addr = addr_defer; addr; addr = addr->next)
6116 if (print_address_information(addr, f, US" ", US"\n ", US""))
6117 print_address_error(addr, f, US"Delay reason: ");
6126 if ((wmf_text = next_emf(wmf, US"final")))
6127 fprintf(f, "%s", CS wmf_text);
6133 "No action is required on your part. Delivery attempts will continue for\n"
6134 "some time, and this warning may be repeated at intervals if the message\n"
6135 "remains undelivered. Eventually the mail delivery software will give up,\n"
6136 "and when that happens, the message will be returned to you.\n");
6139 /* output machine readable part */
6140 fprintf(f, "\n--%s\n"
6141 "Content-type: message/delivery-status\n\n"
6142 "Reporting-MTA: dns; %s\n",
6144 smtp_active_hostname);
6149 /* must be decoded from xtext: see RFC 3461:6.3a */
6151 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6152 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6154 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6158 for (address_item * addr = addr_defer; addr; addr = addr->next)
6162 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
6164 if ((hu = addr->host_used) && hu->name)
6166 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
6167 print_dsn_diagnostic_code(addr, f);
6173 "Content-type: text/rfc822-headers\n\n",
6177 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6178 tctx.u.fd = fileno(f);
6179 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6180 transport_filter_argv = NULL; /* Just in case */
6181 return_path = sender_address; /* In case not previously set */
6183 /* Write the original email out */
6184 /*XXX no checking for failure! buggy! */
6185 transport_write_message(&tctx, 0);
6188 fprintf(f,"\n--%s--\n", bound);
6192 /* Close and wait for child process to complete, without a timeout.
6193 If there's an error, don't update the count. */
6196 return child_close(pid, 0) == 0;
6199 /*************************************************
6200 * Send a success-DSN *
6201 *************************************************/
6204 maybe_send_dsn(void)
6206 address_item * addr_senddsn = NULL;
6208 for (address_item * a = addr_succeed; a; a = a->next)
6210 /* af_ignore_error not honored here. it's not an error */
6211 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
6212 "DSN: processing successful delivery address: %s\n"
6213 "DSN: Sender_address: %s\n"
6214 "DSN: orcpt: %s flags: 0x%x\n"
6215 "DSN: envid: %s ret: %d\n"
6216 "DSN: Final recipient: %s\n"
6217 "DSN: Remote SMTP server supports DSN: %d\n",
6218 a->router ? a->router->name : US"(unknown)",
6221 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
6223 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
6228 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6229 and a report was requested */
6231 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
6232 && a->dsn_flags & rf_notify_success
6235 /* copy and relink address_item and send report with all of them at once later */
6236 address_item * addr_next = addr_senddsn;
6237 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
6239 addr_senddsn->next = addr_next;
6242 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6246 { /* create exim process to send message */
6248 pid_t pid = child_open_exim(&fd, US"DSN");
6250 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6252 if (pid < 0) /* Creation of child failed */
6254 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6255 "create child process to send success-dsn message: %s", getpid(),
6256 getppid(), strerror(errno));
6258 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6260 else /* Creation of child succeeded */
6262 FILE * f = fdopen(fd, "wb");
6263 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6265 transport_ctx tctx = {{0}};
6268 debug_printf("sending success-dsn to: %s\n", sender_address);
6270 /* build unique id for MIME boundary */
6271 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6272 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6274 if (errors_reply_to)
6275 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6278 fprintf(f, "Auto-Submitted: auto-generated\n"
6280 "Subject: Delivery Status Notification\n",
6282 moan_write_references(f, NULL);
6283 fprintf(f, "Content-Type: multipart/report;"
6284 " report-type=delivery-status; boundary=%s\n"
6285 "MIME-Version: 1.0\n\n"
6288 "Content-type: text/plain; charset=us-ascii\n\n"
6290 "This message was created automatically by mail delivery software.\n"
6291 " ----- The following addresses had successful delivery notifications -----\n",
6294 for (address_item * a = addr_senddsn; a; a = a->next)
6295 fprintf(f, "<%s> (relayed %s)\n\n",
6297 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
6298 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
6299 : "via non \"Remote SMTP\" router"
6303 "Content-type: message/delivery-status\n\n"
6304 "Reporting-MTA: dns; %s\n",
6305 bound, smtp_active_hostname);
6308 { /* must be decoded from xtext: see RFC 3461:6.3a */
6309 uschar * xdec_envid;
6310 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6311 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6313 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6317 for (address_item * a = addr_senddsn; a; a = a->next)
6321 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
6323 if ((hu = a->host_used) && hu->name)
6324 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6327 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6328 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
6331 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6334 transport_filter_argv = NULL; /* Just in case */
6335 return_path = sender_address; /* In case not previously set */
6337 /* Write the original email out */
6340 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6341 /*XXX hmm, FALSE(fail) retval ignored.
6342 Could error for any number of reasons, and they are not handled. */
6343 transport_write_message(&tctx, 0);
6346 fprintf(f,"\n--%s--\n", bound);
6350 (void) child_close(pid, 0); /* Waits for child to close, no timeout */
6355 /*************************************************
6356 * Deliver one message *
6357 *************************************************/
6359 /* This is the function which is called when a message is to be delivered. It
6360 is passed the id of the message. It is possible that the message no longer
6361 exists, if some other process has delivered it, and it is also possible that
6362 the message is being worked on by another process, in which case the data file
6365 If no delivery is attempted for any of the above reasons, the function returns
6366 DELIVER_NOT_ATTEMPTED.
6368 If the give_up flag is set true, do not attempt any deliveries, but instead
6369 fail all outstanding addresses and return the message to the sender (or
6372 A delivery operation has a process all to itself; we never deliver more than
6373 one message in the same process. Therefore we needn't worry too much about
6376 Liable to be called as root.
6379 id the id of the message to be delivered
6380 forced TRUE if delivery was forced by an administrator; this overrides
6381 retry delays and causes a delivery to be tried regardless
6382 give_up TRUE if an administrator has requested that delivery attempts
6385 Returns: When the global variable mua_wrapper is FALSE:
6386 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
6387 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
6388 When the global variable mua_wrapper is TRUE:
6389 DELIVER_MUA_SUCCEEDED if delivery succeeded
6390 DELIVER_MUA_FAILED if delivery failed
6391 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
6395 deliver_message(uschar *id, BOOL forced, BOOL give_up)
6398 int final_yield = DELIVER_ATTEMPTED_NORMAL;
6399 time_t now = time(NULL);
6400 address_item *addr_last = NULL;
6401 uschar *filter_message = NULL;
6402 int process_recipients = RECIP_ACCEPT;
6405 extern int acl_where;
6408 #ifdef MEASURE_TIMING
6409 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
6412 info = queue_run_pid == (pid_t)0
6413 ? string_sprintf("delivering %s", id)
6414 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
6416 /* If the D_process_info bit is on, set_process_info() will output debugging
6417 information. If not, we want to show this initial information if D_deliver or
6418 D_queue_run is set or in verbose mode. */
6420 set_process_info("%s", info);
6422 if ( !(debug_selector & D_process_info)
6423 && (debug_selector & (D_deliver|D_queue_run|D_v))
6425 debug_printf("%s\n", info);
6427 /* Ensure that we catch any subprocesses that are created. Although Exim
6428 sets SIG_DFL as its initial default, some routes through the code end up
6429 here with it set to SIG_IGN - cases where a non-synchronous delivery process
6430 has been forked, but no re-exec has been done. We use sigaction rather than
6431 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
6432 sure it is turned off. (There was a problem on AIX with this.) */
6436 struct sigaction act;
6437 act.sa_handler = SIG_DFL;
6438 sigemptyset(&(act.sa_mask));
6440 sigaction(SIGCHLD, &act, NULL);
6443 signal(SIGCHLD, SIG_DFL);
6446 /* Make the forcing flag available for routers and transports, set up the
6447 global message id field, and initialize the count for returned files and the
6448 message size. This use of strcpy() is OK because the length id is checked when
6449 it is obtained from a command line (the -M or -q options), and otherwise it is
6450 known to be a valid message id. */
6452 if (id != message_id)
6453 Ustrcpy(message_id, id);
6454 f.deliver_force = forced;
6458 /* Initialize some flags */
6460 update_spool = FALSE;
6461 remove_journal = TRUE;
6463 /* Set a known context for any ACLs we call via expansions */
6464 acl_where = ACL_WHERE_DELIVERY;
6466 /* Reset the random number generator, so that if several delivery processes are
6467 started from a queue runner that has already used random numbers (for sorting),
6468 they don't all get the same sequence. */
6472 /* Open and lock the message's data file. Exim locks on this one because the
6473 header file may get replaced as it is re-written during the delivery process.
6474 Any failures cause messages to be written to the log, except for missing files
6475 while queue running - another process probably completed delivery. As part of
6476 opening the data file, message_subdir gets set. */
6478 if ((deliver_datafile = spool_open_datafile(id)) < 0)
6479 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6481 /* The value of message_size at this point has been set to the data length,
6482 plus one for the blank line that notionally precedes the data. */
6484 /* Now read the contents of the header file, which will set up the headers in
6485 store, and also the list of recipients and the tree of non-recipients and
6486 assorted flags. It updates message_size. If there is a reading or format error,
6487 give up; if the message has been around for sufficiently long, remove it. */
6490 uschar * spoolname = string_sprintf("%s-H", id);
6491 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
6493 if (errno == ERRNO_SPOOLFORMAT)
6495 struct stat statbuf;
6496 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
6498 log_write(0, LOG_MAIN, "Format error in spool file %s: "
6499 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
6501 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
6504 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
6507 /* If we managed to read the envelope data, received_time contains the
6508 time the message was received. Otherwise, we can calculate it from the
6511 if (rc != spool_read_hdrerror)
6513 received_time.tv_sec = received_time.tv_usec = 0;
6514 /*XXX subsec precision?*/
6515 for (i = 0; i < 6; i++)
6516 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
6519 /* If we've had this malformed message too long, sling it. */
6521 if (now - received_time.tv_sec > keep_malformed)
6523 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
6524 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
6525 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
6526 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
6527 log_write(0, LOG_MAIN, "Message removed because older than %s",
6528 readconf_printtime(keep_malformed));
6531 (void)close(deliver_datafile);
6532 deliver_datafile = -1;
6533 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6537 /* The spool header file has been read. Look to see if there is an existing
6538 journal file for this message. If there is, it means that a previous delivery
6539 attempt crashed (program or host) before it could update the spool header file.
6540 Read the list of delivered addresses from the journal and add them to the
6541 nonrecipients tree. Then update the spool file. We can leave the journal in
6542 existence, as it will get further successful deliveries added to it in this
6543 run, and it will be deleted if this function gets to its end successfully.
6544 Otherwise it might be needed again. */
6547 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6550 if ( (journal_fd = Uopen(fname,
6551 O_RDWR|O_APPEND | EXIM_CLOEXEC | EXIM_NOFOLLOW, SPOOL_MODE)) >= 0
6552 && lseek(journal_fd, 0, SEEK_SET) == 0
6553 && (jread = fdopen(journal_fd, "rb"))
6556 while (Ufgets(big_buffer, big_buffer_size, jread))
6558 int n = Ustrlen(big_buffer);
6559 big_buffer[n-1] = 0;
6560 tree_add_nonrecipient(big_buffer);
6561 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
6562 "journal file\n", big_buffer);
6565 if ((journal_fd = dup(fileno(jread))) < 0)
6566 journal_fd = fileno(jread);
6568 (void) fclose(jread); /* Try to not leak the FILE resource */
6570 /* Panic-dies on error */
6571 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6573 else if (errno != ENOENT)
6575 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
6576 "%s", strerror(errno));
6577 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6580 /* A null recipients list indicates some kind of disaster. */
6582 if (!recipients_list)
6584 (void)close(deliver_datafile);
6585 deliver_datafile = -1;
6586 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
6587 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6592 /* Handle a message that is frozen. There are a number of different things that
6593 can happen, but in the default situation, unless forced, no delivery is
6596 if (f.deliver_freeze)
6598 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6599 /* Moving to another directory removes the message from Exim's view. Other
6600 tools must be used to deal with it. Logging of this action happens in
6601 spool_move_message() and its subfunctions. */
6603 if ( move_frozen_messages
6604 && spool_move_message(id, message_subdir, US"", US"F")
6606 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6609 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
6610 maximum time to keep messages that are frozen. Thaw if we reach it, with a
6611 flag causing all recipients to be failed. The time is the age of the
6612 message, not the time since freezing. */
6614 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
6616 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
6617 process_recipients = RECIP_FAIL_TIMEOUT;
6620 /* For bounce messages (and others with no sender), thaw if the error message
6621 ignore timer is exceeded. The message will be discarded if this delivery
6624 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
6625 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
6627 /* If this is a bounce message, or there's no auto thaw, or we haven't
6628 reached the auto thaw time yet, and this delivery is not forced by an admin
6629 user, do not attempt delivery of this message. Note that forced is set for
6630 continuing messages down the same channel, in order to skip load checking and
6631 ignore hold domains, but we don't want unfreezing in that case. */
6635 if ( ( sender_address[0] == 0
6637 || now <= deliver_frozen_at + auto_thaw
6639 && ( !forced || !f.deliver_force_thaw
6640 || !f.admin_user || continue_hostname
6643 (void)close(deliver_datafile);
6644 deliver_datafile = -1;
6645 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
6646 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6649 /* If delivery was forced (by an admin user), assume a manual thaw.
6650 Otherwise it's an auto thaw. */
6654 f.deliver_manual_thaw = TRUE;
6655 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
6657 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
6660 /* We get here if any of the rules for unfreezing have triggered. */
6662 f.deliver_freeze = FALSE;
6663 update_spool = TRUE;
6667 /* Open the message log file if we are using them. This records details of
6668 deliveries, deferments, and failures for the benefit of the mail administrator.
6669 The log is not used by exim itself to track the progress of a message; that is
6670 done by rewriting the header spool file. */
6674 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
6678 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
6680 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
6681 fname, strerror(errno));
6682 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6685 /* Make a stdio stream out of it. */
6687 if (!(message_log = fdopen(fd, "a")))
6689 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
6690 fname, strerror(errno));
6691 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6696 /* If asked to give up on a message, log who did it, and set the action for all
6701 struct passwd *pw = getpwuid(real_uid);
6702 log_write(0, LOG_MAIN, "cancelled by %s",
6703 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
6704 process_recipients = RECIP_FAIL;
6707 /* Otherwise, if there are too many Received: headers, fail all recipients. */
6709 else if (received_count > received_headers_max)
6710 process_recipients = RECIP_FAIL_LOOP;
6712 /* Otherwise, if a system-wide, address-independent message filter is
6713 specified, run it now, except in the case when we are failing all recipients as
6714 a result of timeout_frozen_after. If the system filter yields "delivered", then
6715 ignore the true recipients of the message. Failure of the filter file is
6716 logged, and the delivery attempt fails. */
6718 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
6723 redirect_block redirect;
6725 if (system_filter_uid_set)
6727 ugid.uid = system_filter_uid;
6728 ugid.gid = system_filter_gid;
6729 ugid.uid_set = ugid.gid_set = TRUE;
6732 ugid.uid_set = ugid.gid_set = FALSE;
6734 return_path = sender_address;
6735 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
6736 f.system_filtering = TRUE;
6738 /* Any error in the filter file causes a delivery to be abandoned. */
6740 redirect.string = system_filter;
6741 redirect.isfile = TRUE;
6742 redirect.check_owner = redirect.check_group = FALSE;
6743 redirect.owners = NULL;
6744 redirect.owngroups = NULL;
6746 redirect.modemask = 0;
6748 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
6751 &redirect, /* Where the data is */
6752 RDO_DEFER | /* Turn on all the enabling options */
6753 RDO_FAIL | /* Leave off all the disabling options */
6758 NULL, /* No :include: restriction (not used in filter) */
6759 NULL, /* No sieve vacation directory (not sieve!) */
6760 NULL, /* No sieve enotify mailto owner (not sieve!) */
6761 NULL, /* No sieve user address (not sieve!) */
6762 NULL, /* No sieve subaddress (not sieve!) */
6763 &ugid, /* uid/gid data */
6764 &addr_new, /* Where to hang generated addresses */
6765 &filter_message, /* Where to put error message */
6766 NULL, /* Don't skip syntax errors */
6767 &filtertype, /* Will always be set to FILTER_EXIM for this call */
6768 US"system filter"); /* For error messages */
6770 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
6772 if (rc == FF_ERROR || rc == FF_NONEXIST)
6774 (void)close(deliver_datafile);
6775 deliver_datafile = -1;
6776 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
6777 string_printing(filter_message));
6778 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6781 /* Reset things. If the filter message is an empty string, which can happen
6782 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
6784 f.system_filtering = FALSE;
6785 f.enable_dollar_recipients = FALSE;
6786 if (filter_message && filter_message[0] == 0) filter_message = NULL;
6788 /* Save the values of the system filter variables so that user filters
6791 memcpy(filter_sn, filter_n, sizeof(filter_sn));
6793 /* The filter can request that delivery of the original addresses be
6798 process_recipients = RECIP_DEFER;
6799 deliver_msglog("Delivery deferred by system filter\n");
6800 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6803 /* The filter can request that a message be frozen, but this does not
6804 take place if the message has been manually thawed. In that case, we must
6805 unset "delivered", which is forced by the "freeze" command to make -bF
6808 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6810 f.deliver_freeze = TRUE;
6811 deliver_frozen_at = time(NULL);
6812 process_recipients = RECIP_DEFER;
6813 frozen_info = string_sprintf(" by the system filter%s%s",
6814 filter_message ? US": " : US"",
6815 filter_message ? filter_message : US"");
6818 /* The filter can request that a message be failed. The error message may be
6819 quite long - it is sent back to the sender in the bounce - but we don't want
6820 to fill up the log with repetitions of it. If it starts with << then the text
6821 between << and >> is written to the log, with the rest left for the bounce
6824 else if (rc == FF_FAIL)
6826 uschar *colon = US"";
6827 uschar *logmsg = US"";
6830 process_recipients = RECIP_FAIL_FILTER;
6836 if ( filter_message[0] == '<'
6837 && filter_message[1] == '<'
6838 && (logend = Ustrstr(filter_message, ">>"))
6841 logmsg = filter_message + 2;
6842 loglen = logend - logmsg;
6843 filter_message = logend + 2;
6844 if (filter_message[0] == 0) filter_message = NULL;
6848 logmsg = filter_message;
6849 loglen = Ustrlen(filter_message);
6853 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6857 /* Delivery can be restricted only to those recipients (if any) that the
6858 filter specified. */
6860 else if (rc == FF_DELIVERED)
6862 process_recipients = RECIP_IGNORE;
6864 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6866 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6869 /* If any new addresses were created by the filter, fake up a "parent"
6870 for them. This is necessary for pipes, etc., which are expected to have
6871 parents, and it also gives some sensible logging for others. Allow
6872 pipes, files, and autoreplies, and run them as the filter uid if set,
6873 otherwise as the current uid. */
6877 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6878 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6880 /* The text "system-filter" is tested in transport_set_up_command() and in
6881 set_up_shell_command() in the pipe transport, to enable them to permit
6882 $recipients, so don't change it here without also changing it there. */
6884 address_item *p = addr_new;
6885 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6887 parent->domain = string_copylc(qualify_domain_recipient);
6888 parent->local_part = US"system-filter";
6890 /* As part of this loop, we arrange for addr_last to end up pointing
6891 at the final address. This is used if we go on to add addresses for the
6892 original recipients. */
6896 if (parent->child_count == USHRT_MAX)
6897 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6898 "than %d delivery addresses", USHRT_MAX);
6899 parent->child_count++;
6902 if (testflag(p, af_pfr))
6908 setflag(p, af_uid_set);
6909 setflag(p, af_gid_set);
6910 setflag(p, af_allow_file);
6911 setflag(p, af_allow_pipe);
6912 setflag(p, af_allow_reply);
6914 /* Find the name of the system filter's appropriate pfr transport */
6916 if (p->address[0] == '|')
6919 tpname = system_filter_pipe_transport;
6920 address_pipe = p->address;
6922 else if (p->address[0] == '>')
6925 tpname = system_filter_reply_transport;
6929 if (p->address[Ustrlen(p->address)-1] == '/')
6931 type = US"directory";
6932 tpname = system_filter_directory_transport;
6937 tpname = system_filter_file_transport;
6939 address_file = p->address;
6942 /* Now find the actual transport, first expanding the name. We have
6943 set address_file or address_pipe above. */
6947 uschar *tmp = expand_string(tpname);
6948 address_file = address_pipe = NULL;
6950 p->message = string_sprintf("failed to expand \"%s\" as a "
6951 "system filter transport name", tpname);
6952 if (is_tainted(tmp))
6953 p->message = string_sprintf("attempt to used tainted value '%s' for"
6954 "transport '%s' as a system filter", tmp, tpname);
6958 p->message = string_sprintf("system_filter_%s_transport is unset",
6963 transport_instance *tp;
6964 for (tp = transports; tp; tp = tp->next)
6965 if (Ustrcmp(tp->name, tpname) == 0)
6971 p->message = string_sprintf("failed to find \"%s\" transport "
6972 "for system filter delivery", tpname);
6975 /* If we couldn't set up a transport, defer the delivery, putting the
6976 error on the panic log as well as the main log. */
6980 address_item *badp = p;
6982 if (!addr_last) addr_new = p; else addr_last->next = p;
6983 badp->local_part = badp->address; /* Needed for log line */
6984 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6987 } /* End of pfr handling */
6989 /* Either a non-pfr delivery, or we found a transport */
6991 DEBUG(D_deliver|D_filter)
6992 debug_printf("system filter added %s\n", p->address);
6996 } /* Loop through all addr_new addresses */
7001 /* Scan the recipients list, and for every one that is not in the non-
7002 recipients tree, add an addr item to the chain of new addresses. If the pno
7003 value is non-negative, we must set the onetime parent from it. This which
7004 points to the relevant entry in the recipients list.
7006 This processing can be altered by the setting of the process_recipients
7007 variable, which is changed if recipients are to be ignored, failed, or
7008 deferred. This can happen as a result of system filter activity, or if the -Mg
7009 option is used to fail all of them.
7011 Duplicate addresses are handled later by a different tree structure; we can't
7012 just extend the non-recipients tree, because that will be re-written to the
7013 spool if the message is deferred, and in any case there are casing
7014 complications for local addresses. */
7016 if (process_recipients != RECIP_IGNORE)
7017 for (i = 0; i < recipients_count; i++)
7018 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
7020 recipient_item *r = recipients_list + i;
7021 address_item *new = deliver_make_addr(r->address, FALSE);
7022 new->prop.errors_address = r->errors_to;
7024 if ((new->prop.utf8_msg = message_smtputf8))
7026 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
7027 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
7028 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
7029 new->prop.utf8_downcvt ? "yes"
7030 : new->prop.utf8_downcvt_maybe ? "ifneeded"
7036 new->onetime_parent = recipients_list[r->pno].address;
7038 /* If DSN support is enabled, set the dsn flags and the original receipt
7039 to be passed on to other DSN enabled MTAs */
7041 new->dsn_flags = r->dsn_flags & rf_dsnflags;
7042 new->dsn_orcpt = r->orcpt;
7043 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
7044 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
7046 switch (process_recipients)
7048 /* RECIP_DEFER is set when a system filter freezes a message. */
7051 new->next = addr_defer;
7056 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
7059 case RECIP_FAIL_FILTER:
7061 filter_message ? filter_message : US"delivery cancelled";
7062 setflag(new, af_pass_message);
7063 goto RECIP_QUEUE_FAILED; /* below */
7066 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
7067 than the value in timeout_frozen_after. Treat non-bounce messages
7068 similarly to -Mg; for bounce messages we just want to discard, so
7069 don't put the address on the failed list. The timeout has already
7072 case RECIP_FAIL_TIMEOUT:
7073 new->message = US"delivery cancelled; message timed out";
7074 goto RECIP_QUEUE_FAILED; /* below */
7077 /* RECIP_FAIL is set when -Mg has been used. */
7080 new->message = US"delivery cancelled by administrator";
7083 /* Common code for the failure cases above. If this is not a bounce
7084 message, put the address on the failed list so that it is used to
7085 create a bounce. Otherwise do nothing - this just discards the address.
7086 The incident has already been logged. */
7089 if (sender_address[0])
7091 new->next = addr_failed;
7097 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
7098 in the message. Process each address as a routing failure; if this
7099 is a bounce message, it will get frozen. */
7101 case RECIP_FAIL_LOOP:
7102 new->message = US"Too many \"Received\" headers - suspected mail loop";
7103 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7107 /* Value should be RECIP_ACCEPT; take this as the safe default. */
7110 if (!addr_new) addr_new = new; else addr_last->next = new;
7115 #ifndef DISABLE_EVENT
7116 if (process_recipients != RECIP_ACCEPT && event_action)
7118 uschar * save_local = deliver_localpart;
7119 const uschar * save_domain = deliver_domain;
7120 uschar * addr = new->address, * errmsg = NULL;
7121 int start, end, dom;
7123 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
7124 log_write(0, LOG_MAIN|LOG_PANIC,
7125 "failed to parse address '%.100s': %s\n", addr, errmsg);
7129 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
7130 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
7132 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
7134 deliver_localpart = save_local;
7135 deliver_domain = save_domain;
7143 debug_printf("Delivery address list:\n");
7144 for (address_item * p = addr_new; p; p = p->next)
7145 debug_printf(" %s %s\n", p->address,
7146 p->onetime_parent ? p->onetime_parent : US"");
7149 /* Set up the buffers used for copying over the file when delivering. */
7151 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
7152 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
7156 /* Until there are no more new addresses, handle each one as follows:
7158 . If this is a generated address (indicated by the presence of a parent
7159 pointer) then check to see whether it is a pipe, file, or autoreply, and
7160 if so, handle it directly here. The router that produced the address will
7161 have set the allow flags into the address, and also set the uid/gid required.
7162 Having the routers generate new addresses and then checking them here at
7163 the outer level is tidier than making each router do the checking, and
7164 means that routers don't need access to the failed address queue.
7166 . Break up the address into local part and domain, and make lowercased
7167 versions of these strings. We also make unquoted versions of the local part.
7169 . Handle the percent hack for those domains for which it is valid.
7171 . For child addresses, determine if any of the parents have the same address.
7172 If so, generate a different string for previous delivery checking. Without
7173 this code, if the address spqr generates spqr via a forward or alias file,
7174 delivery of the generated spqr stops further attempts at the top level spqr,
7175 which is not what is wanted - it may have generated other addresses.
7177 . Check on the retry database to see if routing was previously deferred, but
7178 only if in a queue run. Addresses that are to be routed are put on the
7179 addr_route chain. Addresses that are to be deferred are put on the
7180 addr_defer chain. We do all the checking first, so as not to keep the
7181 retry database open any longer than necessary.
7183 . Now we run the addresses through the routers. A router may put the address
7184 on either the addr_local or the addr_remote chain for local or remote
7185 delivery, respectively, or put it on the addr_failed chain if it is
7186 undeliveable, or it may generate child addresses and put them on the
7187 addr_new chain, or it may defer an address. All the chain anchors are
7188 passed as arguments so that the routers can be called for verification
7191 . If new addresses have been generated by the routers, da capo.
7194 f.header_rewritten = FALSE; /* No headers rewritten yet */
7195 while (addr_new) /* Loop until all addresses dealt with */
7197 address_item * addr, * parent;
7199 /* Failure to open the retry database is treated the same as if it does
7200 not exist. In both cases, dbm_file is NULL. */
7202 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
7203 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
7204 debug_printf("no retry data available\n");
7206 /* Scan the current batch of new addresses, to handle pipes, files and
7207 autoreplies, and determine which others are ready for routing. */
7213 dbdata_retry * domain_retry_record, * address_retry_record;
7216 addr_new = addr->next;
7218 DEBUG(D_deliver|D_retry|D_route)
7220 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7221 debug_printf("Considering: %s\n", addr->address);
7224 /* Handle generated address that is a pipe or a file or an autoreply. */
7226 if (testflag(addr, af_pfr))
7228 /* If an autoreply in a filter could not generate a syntactically valid
7229 address, give up forthwith. Set af_ignore_error so that we don't try to
7230 generate a bounce. */
7232 if (testflag(addr, af_bad_reply))
7234 addr->basic_errno = ERRNO_BADADDRESS2;
7235 addr->local_part = addr->address;
7237 US"filter autoreply generated syntactically invalid recipient";
7238 addr->prop.ignore_error = TRUE;
7239 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7240 continue; /* with the next new address */
7243 /* If two different users specify delivery to the same pipe or file or
7244 autoreply, there should be two different deliveries, so build a unique
7245 string that incorporates the original address, and use this for
7246 duplicate testing and recording delivery, and also for retrying. */
7249 string_sprintf("%s:%s", addr->address, addr->parent->unique +
7250 (testflag(addr->parent, af_homonym)? 3:0));
7252 addr->address_retry_key = addr->domain_retry_key =
7253 string_sprintf("T:%s", addr->unique);
7255 /* If a filter file specifies two deliveries to the same pipe or file,
7256 we want to de-duplicate, but this is probably not wanted for two mail
7257 commands to the same address, where probably both should be delivered.
7258 So, we have to invent a different unique string in that case. Just
7259 keep piling '>' characters on the front. */
7261 if (addr->address[0] == '>')
7262 while (tree_search(tree_duplicates, addr->unique))
7263 addr->unique = string_sprintf(">%s", addr->unique);
7265 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
7267 DEBUG(D_deliver|D_route)
7268 debug_printf("%s is a duplicate address: discarded\n", addr->address);
7269 addr->dupof = tnode->data.ptr;
7270 addr->next = addr_duplicate;
7271 addr_duplicate = addr;
7275 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7277 /* Check for previous delivery */
7279 if (tree_search(tree_nonrecipients, addr->unique))
7281 DEBUG(D_deliver|D_route)
7282 debug_printf("%s was previously delivered: discarded\n", addr->address);
7283 child_done(addr, tod_stamp(tod_log));
7287 /* Save for checking future duplicates */
7289 tree_add_duplicate(addr->unique, addr);
7291 /* Set local part and domain */
7293 addr->local_part = addr->address;
7294 addr->domain = addr->parent->domain;
7296 /* Ensure that the delivery is permitted. */
7298 if (testflag(addr, af_file))
7300 if (!testflag(addr, af_allow_file))
7302 addr->basic_errno = ERRNO_FORBIDFILE;
7303 addr->message = US"delivery to file forbidden";
7304 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7305 continue; /* with the next new address */
7308 else if (addr->address[0] == '|')
7310 if (!testflag(addr, af_allow_pipe))
7312 addr->basic_errno = ERRNO_FORBIDPIPE;
7313 addr->message = US"delivery to pipe forbidden";
7314 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7315 continue; /* with the next new address */
7318 else if (!testflag(addr, af_allow_reply))
7320 addr->basic_errno = ERRNO_FORBIDREPLY;
7321 addr->message = US"autoreply forbidden";
7322 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7323 continue; /* with the next new address */
7326 /* If the errno field is already set to BADTRANSPORT, it indicates
7327 failure to expand a transport string, or find the associated transport,
7328 or an unset transport when one is required. Leave this test till now so
7329 that the forbid errors are given in preference. */
7331 if (addr->basic_errno == ERRNO_BADTRANSPORT)
7333 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7337 /* Treat /dev/null as a special case and abandon the delivery. This
7338 avoids having to specify a uid on the transport just for this case.
7339 Arrange for the transport name to be logged as "**bypassed**".
7340 Copy the transport for this fairly unusual case rather than having
7341 to make all transports mutable. */
7343 if (Ustrcmp(addr->address, "/dev/null") == 0)
7345 transport_instance * save_t = addr->transport;
7346 transport_instance * t = store_get(sizeof(*t), save_t);
7348 t->name = US"**bypassed**";
7349 addr->transport = t;
7350 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
7351 addr->transport= save_t;
7352 continue; /* with the next new address */
7355 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
7358 DEBUG(D_deliver|D_route)
7359 debug_printf("queued for %s transport\n", addr->transport->name);
7360 addr->next = addr_local;
7362 continue; /* with the next new address */
7365 /* Handle normal addresses. First, split up into local part and domain,
7366 handling the %-hack if necessary. There is the possibility of a defer from
7367 a lookup in percent_hack_domains. */
7369 if ((rc = deliver_split_address(addr)) == DEFER)
7371 addr->message = US"cannot check percent_hack_domains";
7372 addr->basic_errno = ERRNO_LISTDEFER;
7373 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7377 /* Check to see if the domain is held. If so, proceed only if the
7378 delivery was forced by hand. */
7380 deliver_domain = addr->domain; /* set $domain */
7381 if ( !forced && hold_domains
7382 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
7383 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
7389 addr->message = US"hold_domains lookup deferred";
7390 addr->basic_errno = ERRNO_LISTDEFER;
7394 addr->message = US"domain is held";
7395 addr->basic_errno = ERRNO_HELD;
7397 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7401 /* Now we can check for duplicates and previously delivered addresses. In
7402 order to do this, we have to generate a "unique" value for each address,
7403 because there may be identical actual addresses in a line of descendents.
7404 The "unique" field is initialized to the same value as the "address" field,
7405 but gets changed here to cope with identically-named descendents. */
7407 for (parent = addr->parent; parent; parent = parent->parent)
7408 if (strcmpic(addr->address, parent->address) == 0) break;
7410 /* If there's an ancestor with the same name, set the homonym flag. This
7411 influences how deliveries are recorded. Then add a prefix on the front of
7412 the unique address. We use \n\ where n starts at 0 and increases each time.
7413 It is unlikely to pass 9, but if it does, it may look odd but will still
7414 work. This means that siblings or cousins with the same names are treated
7415 as duplicates, which is what we want. */
7419 setflag(addr, af_homonym);
7420 if (parent->unique[0] != '\\')
7421 addr->unique = string_sprintf("\\0\\%s", addr->address);
7423 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
7427 /* Ensure that the domain in the unique field is lower cased, because
7428 domains are always handled caselessly. */
7430 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
7432 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7434 if (tree_search(tree_nonrecipients, addr->unique))
7436 DEBUG(D_deliver|D_route)
7437 debug_printf("%s was previously delivered: discarded\n", addr->unique);
7438 child_done(addr, tod_stamp(tod_log));
7442 /* Get the routing retry status, saving the two retry keys (with and
7443 without the local part) for subsequent use. If there is no retry record for
7444 the standard address routing retry key, we look for the same key with the
7445 sender attached, because this form is used by the smtp transport after a
7446 4xx response to RCPT when address_retry_include_sender is true. */
7448 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
7449 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
7454 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
7455 if ( domain_retry_record
7456 && now - domain_retry_record->time_stamp > retry_data_expire
7459 DEBUG(D_deliver|D_retry)
7460 debug_printf("domain retry record present but expired\n");
7461 domain_retry_record = NULL; /* Ignore if too old */
7464 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
7465 if ( address_retry_record
7466 && now - address_retry_record->time_stamp > retry_data_expire
7469 DEBUG(D_deliver|D_retry)
7470 debug_printf("address retry record present but expired\n");
7471 address_retry_record = NULL; /* Ignore if too old */
7474 if (!address_retry_record)
7476 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7478 address_retry_record = dbfn_read(dbm_file, altkey);
7479 if ( address_retry_record
7480 && now - address_retry_record->time_stamp > retry_data_expire)
7482 DEBUG(D_deliver|D_retry)
7483 debug_printf("address<sender> retry record present but expired\n");
7484 address_retry_record = NULL; /* Ignore if too old */
7489 domain_retry_record = address_retry_record = NULL;
7491 DEBUG(D_deliver|D_retry)
7493 if (!domain_retry_record)
7494 debug_printf("no domain retry record\n");
7496 debug_printf("have domain retry record; next_try = now%+d\n",
7497 f.running_in_test_harness ? 0 :
7498 (int)(domain_retry_record->next_try - now));
7500 if (!address_retry_record)
7501 debug_printf("no address retry record\n");
7503 debug_printf("have address retry record; next_try = now%+d\n",
7504 f.running_in_test_harness ? 0 :
7505 (int)(address_retry_record->next_try - now));
7508 /* If we are sending a message down an existing SMTP connection, we must
7509 assume that the message which created the connection managed to route
7510 an address to that connection. We do not want to run the risk of taking
7511 a long time over routing here, because if we do, the server at the other
7512 end of the connection may time it out. This is especially true for messages
7513 with lots of addresses. For this kind of delivery, queue_running is not
7514 set, so we would normally route all addresses. We take a pragmatic approach
7515 and defer routing any addresses that have any kind of domain retry record.
7516 That is, we don't even look at their retry times. It doesn't matter if this
7517 doesn't work occasionally. This is all just an optimization, after all.
7519 The reason for not doing the same for address retries is that they normally
7520 arise from 4xx responses, not DNS timeouts. */
7522 if (continue_hostname && domain_retry_record)
7524 addr->message = US"reusing SMTP connection skips previous routing defer";
7525 addr->basic_errno = ERRNO_RRETRY;
7526 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7528 addr->message = domain_retry_record->text;
7529 setflag(addr, af_pass_message);
7532 /* If we are in a queue run, defer routing unless there is no retry data or
7533 we've passed the next retry time, or this message is forced. In other
7534 words, ignore retry data when not in a queue run.
7536 However, if the domain retry time has expired, always allow the routing
7537 attempt. If it fails again, the address will be failed. This ensures that
7538 each address is routed at least once, even after long-term routing
7541 If there is an address retry, check that too; just wait for the next
7542 retry time. This helps with the case when the temporary error on the
7543 address was really message-specific rather than address specific, since
7544 it allows other messages through.
7546 We also wait for the next retry time if this is a message sent down an
7547 existing SMTP connection (even though that will be forced). Otherwise there
7548 will be far too many attempts for an address that gets a 4xx error. In
7549 fact, after such an error, we should not get here because, the host should
7550 not be remembered as one this message needs. However, there was a bug that
7551 used to cause this to happen, so it is best to be on the safe side.
7553 Even if we haven't reached the retry time in the hints, there is one more
7554 check to do, which is for the ultimate address timeout. We only do this
7555 check if there is an address retry record and there is not a domain retry
7556 record; this implies that previous attempts to handle the address had the
7557 retry_use_local_parts option turned on. We use this as an approximation
7558 for the destination being like a local delivery, for example delivery over
7559 LMTP to an IMAP message store. In this situation users are liable to bump
7560 into their quota and thereby have intermittently successful deliveries,
7561 which keep the retry record fresh, which can lead to us perpetually
7562 deferring messages. */
7564 else if ( ( f.queue_running && !f.deliver_force
7565 || continue_hostname
7567 && ( ( domain_retry_record
7568 && now < domain_retry_record->next_try
7569 && !domain_retry_record->expired
7571 || ( address_retry_record
7572 && now < address_retry_record->next_try
7574 && ( domain_retry_record
7575 || !address_retry_record
7576 || !retry_ultimate_address_timeout(addr->address_retry_key,
7577 addr->domain, address_retry_record, now)
7580 addr->message = US"retry time not reached";
7581 addr->basic_errno = ERRNO_RRETRY;
7582 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7584 /* For remote-retry errors (here and just above) that we've not yet
7585 hit the retry time, use the error recorded in the retry database
7586 as info in the warning message. This lets us send a message even
7587 when we're not failing on a fresh attempt. We assume that this
7588 info is not sensitive. */
7590 addr->message = domain_retry_record
7591 ? domain_retry_record->text : address_retry_record->text;
7592 setflag(addr, af_pass_message);
7595 /* The domain is OK for routing. Remember if retry data exists so it
7596 can be cleaned up after a successful delivery. */
7600 if (domain_retry_record || address_retry_record)
7601 setflag(addr, af_dr_retry_exists);
7602 addr->next = addr_route;
7604 DEBUG(D_deliver|D_route)
7605 debug_printf("%s: queued for routing\n", addr->address);
7609 /* The database is closed while routing is actually happening. Requests to
7610 update it are put on a chain and all processed together at the end. */
7612 if (dbm_file) dbfn_close(dbm_file);
7614 /* If queue_domains is set, we don't even want to try routing addresses in
7615 those domains. During queue runs, queue_domains is forced to be unset.
7616 Optimize by skipping this pass through the addresses if nothing is set. */
7618 if (!f.deliver_force && queue_domains)
7620 address_item *okaddr = NULL;
7623 address_item *addr = addr_route;
7624 addr_route = addr->next;
7626 deliver_domain = addr->domain; /* set $domain */
7627 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
7628 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
7632 addr->basic_errno = ERRNO_LISTDEFER;
7633 addr->message = US"queue_domains lookup deferred";
7634 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7638 addr->next = okaddr;
7643 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
7644 addr->message = US"domain is in queue_domains";
7645 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7649 addr_route = okaddr;
7652 /* Now route those addresses that are not deferred. */
7657 address_item *addr = addr_route;
7658 const uschar *old_domain = addr->domain;
7659 uschar *old_unique = addr->unique;
7660 addr_route = addr->next;
7663 /* Just in case some router parameter refers to it. */
7665 if (!(return_path = addr->prop.errors_address))
7666 return_path = sender_address;
7668 /* If a router defers an address, add a retry item. Whether or not to
7669 use the local part in the key is a property of the router. */
7671 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
7672 &addr_succeed, v_none)) == DEFER)
7673 retry_add_item(addr,
7674 addr->router->retry_use_local_part
7675 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
7676 : string_sprintf("R:%s", addr->domain),
7679 /* Otherwise, if there is an existing retry record in the database, add
7680 retry items to delete both forms. We must also allow for the possibility
7681 of a routing retry that includes the sender address. Since the domain might
7682 have been rewritten (expanded to fully qualified) as a result of routing,
7683 ensure that the rewritten form is also deleted. */
7685 else if (testflag(addr, af_dr_retry_exists))
7687 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7689 retry_add_item(addr, altkey, rf_delete);
7690 retry_add_item(addr, addr->address_retry_key, rf_delete);
7691 retry_add_item(addr, addr->domain_retry_key, rf_delete);
7692 if (Ustrcmp(addr->domain, old_domain) != 0)
7693 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
7696 /* DISCARD is given for :blackhole: and "seen finish". The event has been
7697 logged, but we need to ensure the address (and maybe parents) is marked
7702 address_done(addr, tod_stamp(tod_log));
7703 continue; /* route next address */
7706 /* The address is finished with (failed or deferred). */
7710 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7711 continue; /* route next address */
7714 /* The address has been routed. If the router changed the domain, it will
7715 also have changed the unique address. We have to test whether this address
7716 has already been delivered, because it's the unique address that finally
7719 if ( addr->unique != old_unique
7720 && tree_search(tree_nonrecipients, addr->unique) != 0
7723 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
7724 "discarded\n", addr->address);
7725 if (addr_remote == addr) addr_remote = addr->next;
7726 else if (addr_local == addr) addr_local = addr->next;
7729 /* If the router has same_domain_copy_routing set, we are permitted to copy
7730 the routing for any other addresses with the same domain. This is an
7731 optimisation to save repeated DNS lookups for "standard" remote domain
7732 routing. The option is settable only on routers that generate host lists.
7733 We play it very safe, and do the optimization only if the address is routed
7734 to a remote transport, there are no header changes, and the domain was not
7735 modified by the router. */
7737 if ( addr_remote == addr
7738 && addr->router->same_domain_copy_routing
7739 && !addr->prop.extra_headers
7740 && !addr->prop.remove_headers
7741 && old_domain == addr->domain
7744 address_item **chain = &addr_route;
7747 address_item *addr2 = *chain;
7748 if (Ustrcmp(addr2->domain, addr->domain) != 0)
7750 chain = &(addr2->next);
7754 /* Found a suitable address; take it off the routing list and add it to
7755 the remote delivery list. */
7757 *chain = addr2->next;
7758 addr2->next = addr_remote;
7759 addr_remote = addr2;
7761 /* Copy the routing data */
7763 addr2->domain = addr->domain;
7764 addr2->router = addr->router;
7765 addr2->transport = addr->transport;
7766 addr2->host_list = addr->host_list;
7767 addr2->fallback_hosts = addr->fallback_hosts;
7768 addr2->prop.errors_address = addr->prop.errors_address;
7769 copyflag(addr2, addr, af_hide_child);
7770 copyflag(addr2, addr, af_local_host_removed);
7772 DEBUG(D_deliver|D_route)
7773 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
7775 "Routing for %s copied from %s\n",
7776 addr2->address, addr2->address, addr->address);
7779 } /* Continue with routing the next address. */
7780 } /* Loop to process any child addresses that the routers created, and
7781 any rerouted addresses that got put back on the new chain. */
7784 /* Debugging: show the results of the routing */
7786 DEBUG(D_deliver|D_retry|D_route)
7788 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7789 debug_printf("After routing:\n Local deliveries:\n");
7790 for (address_item * p = addr_local; p; p = p->next)
7791 debug_printf(" %s\n", p->address);
7793 debug_printf(" Remote deliveries:\n");
7794 for (address_item * p = addr_remote; p; p = p->next)
7795 debug_printf(" %s\n", p->address);
7797 debug_printf(" Failed addresses:\n");
7798 for (address_item * p = addr_failed; p; p = p->next)
7799 debug_printf(" %s\n", p->address);
7801 debug_printf(" Deferred addresses:\n");
7802 for (address_item * p = addr_defer; p; p = p->next)
7803 debug_printf(" %s\n", p->address);
7806 /* Free any resources that were cached during routing. */
7811 /* These two variables are set only during routing, after check_local_user.
7812 Ensure they are not set in transports. */
7814 local_user_gid = (gid_t)(-1);
7815 local_user_uid = (uid_t)(-1);
7817 /* Check for any duplicate addresses. This check is delayed until after
7818 routing, because the flexibility of the routing configuration means that
7819 identical addresses with different parentage may end up being redirected to
7820 different addresses. Checking for duplicates too early (as we previously used
7821 to) makes this kind of thing not work. */
7823 do_duplicate_check(&addr_local);
7824 do_duplicate_check(&addr_remote);
7826 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7827 remote transport. The check that they all end up in one transaction happens in
7828 the do_remote_deliveries() function. */
7831 && (addr_local || addr_failed || addr_defer)
7835 uschar *which, *colon, *msg;
7842 else if (addr_defer)
7845 which = US"deferred";
7853 while (addr->parent) addr = addr->parent;
7858 msg = addr->message;
7860 else colon = msg = US"";
7862 /* We don't need to log here for a forced failure as it will already
7863 have been logged. Defer will also have been logged, but as a defer, so we do
7864 need to do the failure logging. */
7866 if (addr != addr_failed)
7867 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7868 addr->address, which);
7870 /* Always write an error to the caller */
7872 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7875 final_yield = DELIVER_MUA_FAILED;
7876 addr_failed = addr_defer = NULL; /* So that we remove the message */
7877 goto DELIVERY_TIDYUP;
7881 /* If this is a run to continue deliveries to an external channel that is
7882 already set up, defer any local deliveries.
7884 jgh 2020/12/20: I don't see why; locals should be quick.
7885 The defer goes back to version 1.62 in 1997. A local being still deliverable
7886 during a continued run might result from something like a defer during the
7887 original delivery, eg. in a DB lookup. Unlikely but possible.
7889 To avoid delaying a local when combined with a callout-hold for a remote
7890 delivery, test continue_sequence rather than continue_transport. */
7892 if (continue_sequence > 1 && addr_local)
7894 DEBUG(D_deliver|D_retry|D_route)
7895 debug_printf("deferring local deliveries due to continued-transport\n");
7898 address_item * addr = addr_defer;
7899 while (addr->next) addr = addr->next;
7900 addr->next = addr_local;
7903 addr_defer = addr_local;
7908 /* Because address rewriting can happen in the routers, we should not really do
7909 ANY deliveries until all addresses have been routed, so that all recipients of
7910 the message get the same headers. However, this is in practice not always
7911 possible, since sometimes remote addresses give DNS timeouts for days on end.
7912 The pragmatic approach is to deliver what we can now, saving any rewritten
7913 headers so that at least the next lot of recipients benefit from the rewriting
7914 that has already been done.
7916 If any headers have been rewritten during routing, update the spool file to
7917 remember them for all subsequent deliveries. This can be delayed till later if
7918 there is only address to be delivered - if it succeeds the spool write need not
7921 if ( f.header_rewritten
7922 && ( addr_local && (addr_local->next || addr_remote)
7923 || addr_remote && addr_remote->next
7926 /* Panic-dies on error */
7927 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7928 f.header_rewritten = FALSE;
7932 /* If there are any deliveries to do and we do not already have the journal
7933 file, create it. This is used to record successful deliveries as soon as
7934 possible after each delivery is known to be complete. A file opened with
7935 O_APPEND is used so that several processes can run simultaneously.
7937 The journal is just insurance against crashes. When the spool file is
7938 ultimately updated at the end of processing, the journal is deleted. If a
7939 journal is found to exist at the start of delivery, the addresses listed
7940 therein are added to the non-recipients. */
7942 if (addr_local || addr_remote)
7946 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7948 if ((journal_fd = Uopen(fname,
7949 EXIM_CLOEXEC | O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7951 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7952 fname, strerror(errno));
7953 return DELIVER_NOT_ATTEMPTED;
7956 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7957 that the mode is correct - the group setting doesn't always seem to get
7958 set automatically. */
7960 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7961 || fchmod(journal_fd, SPOOL_MODE)
7963 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7967 int ret = Uunlink(fname);
7968 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7969 fname, strerror(errno));
7970 if(ret && errno != ENOENT)
7971 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7972 fname, strerror(errno));
7973 return DELIVER_NOT_ATTEMPTED;
7977 else if (journal_fd >= 0)
7985 /* Now we can get down to the business of actually doing deliveries. Local
7986 deliveries are done first, then remote ones. If ever the problems of how to
7987 handle fallback transports are figured out, this section can be put into a loop
7988 for handling fallbacks, though the uid switching will have to be revised. */
7990 /* Precompile a regex that is used to recognize a parameter in response
7991 to an LHLO command, if is isn't already compiled. This may be used on both
7992 local and remote LMTP deliveries. */
7994 if (!regex_IGNOREQUOTA)
7996 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", MCS_NOFLAGS, TRUE);
7998 /* Handle local deliveries */
8002 DEBUG(D_deliver|D_transport)
8003 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
8004 do_local_deliveries();
8005 f.disable_logging = FALSE;
8008 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
8009 so just queue them all. */
8011 if (f.queue_run_local)
8014 address_item *addr = addr_remote;
8015 addr_remote = addr->next;
8017 addr->basic_errno = ERRNO_LOCAL_ONLY;
8018 addr->message = US"remote deliveries suppressed";
8019 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
8022 /* Handle remote deliveries */
8026 DEBUG(D_deliver|D_transport)
8027 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
8029 /* Precompile some regex that are used to recognize parameters in response
8030 to an EHLO command, if they aren't already compiled. */
8032 smtp_deliver_init();
8034 /* Now sort the addresses if required, and do the deliveries. The yield of
8035 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
8036 cannot be delivered in one transaction. */
8038 if (remote_sort_domains) sort_remote_deliveries();
8039 if (!do_remote_deliveries(FALSE))
8041 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
8042 "be delivered in one transaction");
8043 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
8045 final_yield = DELIVER_MUA_FAILED;
8046 addr_failed = addr_defer = NULL; /* So that we remove the message */
8047 goto DELIVERY_TIDYUP;
8050 /* See if any of the addresses that failed got put on the queue for delivery
8051 to their fallback hosts. We do it this way because often the same fallback
8052 host is used for many domains, so all can be sent in a single transaction
8053 (if appropriately configured). */
8055 if (addr_fallback && !mua_wrapper)
8057 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
8058 addr_remote = addr_fallback;
8059 addr_fallback = NULL;
8060 if (remote_sort_domains) sort_remote_deliveries();
8061 do_remote_deliveries(TRUE);
8063 f.disable_logging = FALSE;
8067 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
8068 phase, to minimize cases of half-done things. */
8071 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
8072 cancel_cutthrough_connection(TRUE, US"deliveries are done");
8074 /* Root privilege is no longer needed */
8076 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
8078 set_process_info("tidying up after delivering %s", message_id);
8079 signal(SIGTERM, SIG_IGN);
8081 /* When we are acting as an MUA wrapper, the smtp transport will either have
8082 succeeded for all addresses, or failed them all in normal cases. However, there
8083 are some setup situations (e.g. when a named port does not exist) that cause an
8084 immediate exit with deferral of all addresses. Convert those into failures. We
8085 do not ever want to retry, nor do we want to send a bounce message. */
8091 address_item * nextaddr;
8092 for (address_item * addr = addr_defer; addr; addr = nextaddr)
8094 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
8095 "delivery", addr->address);
8096 nextaddr = addr->next;
8097 addr->next = addr_failed;
8103 /* Now all should either have succeeded or failed. */
8106 final_yield = DELIVER_MUA_SUCCEEDED;
8110 uschar *s = addr_failed->user_message;
8112 if (!s) s = addr_failed->message;
8114 fprintf(stderr, "Delivery failed: ");
8115 if (addr_failed->basic_errno > 0)
8117 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
8118 if (s) fprintf(stderr, ": ");
8120 if ((host = addr_failed->host_used))
8121 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
8123 fprintf(stderr, "%s", CS s);
8124 else if (addr_failed->basic_errno <= 0)
8125 fprintf(stderr, "unknown error");
8126 fprintf(stderr, "\n");
8128 final_yield = DELIVER_MUA_FAILED;
8133 /* In a normal configuration, we now update the retry database. This is done in
8134 one fell swoop at the end in order not to keep opening and closing (and
8135 locking) the database. The code for handling retries is hived off into a
8136 separate module for convenience. We pass it the addresses of the various
8137 chains, because deferred addresses can get moved onto the failed chain if the
8138 retry cutoff time has expired for all alternative destinations. Bypass the
8139 updating of the database if the -N flag is set, which is a debugging thing that
8140 prevents actual delivery. */
8142 else if (!f.dont_deliver)
8143 retry_update(&addr_defer, &addr_failed, &addr_succeed);
8145 /* Send DSN for successful messages if requested */
8149 /* If any addresses failed, we must send a message to somebody, unless
8150 af_ignore_error is set, in which case no action is taken. It is possible for
8151 several messages to get sent if there are addresses with different
8156 const uschar * logtod = tod_stamp(tod_log);
8157 address_item * addr;
8159 /* There are weird cases when logging is disabled in the transport. However,
8160 there may not be a transport (address failed by a router). */
8162 f.disable_logging = FALSE;
8163 if (addr_failed->transport)
8164 f.disable_logging = addr_failed->transport->disable_logging;
8167 debug_printf("processing failed address %s\n", addr_failed->address);
8169 /* There are only two ways an address in a bounce message can get here:
8171 (1) When delivery was initially deferred, but has now timed out (in the call
8172 to retry_update() above). We can detect this by testing for
8173 af_retry_timedout. If the address does not have its own errors address,
8174 we arrange to ignore the error.
8176 (2) If delivery failures for bounce messages are being ignored. We can detect
8177 this by testing for af_ignore_error. This will also be set if a bounce
8178 message has been autothawed and the ignore_bounce_errors_after time has
8179 passed. It might also be set if a router was explicitly configured to
8180 ignore errors (errors_to = "").
8182 If neither of these cases obtains, something has gone wrong. Log the
8183 incident, but then ignore the error. */
8185 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
8187 if ( !testflag(addr_failed, af_retry_timedout)
8188 && !addr_failed->prop.ignore_error)
8189 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
8190 "failure is neither frozen nor ignored (it's been ignored)");
8192 addr_failed->prop.ignore_error = TRUE;
8195 /* If the first address on the list has af_ignore_error set, just remove
8196 it from the list, throw away any saved message file, log it, and
8197 mark the recipient done. */
8199 if ( addr_failed->prop.ignore_error
8200 || addr_failed->dsn_flags & rf_dsnflags
8201 && !(addr_failed->dsn_flags & rf_notify_failure)
8205 addr_failed = addr->next;
8206 if (addr->return_filename) Uunlink(addr->return_filename);
8208 #ifndef DISABLE_EVENT
8209 msg_event_raise(US"msg:fail:delivery", addr);
8211 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
8213 !addr->parent ? US"" : US" <",
8214 !addr->parent ? US"" : addr->parent->address,
8215 !addr->parent ? US"" : US">",
8216 addr->prop.ignore_error
8217 ? US"" : US": RFC 3461 DSN, failure notify not requested");
8219 address_done(addr, logtod);
8220 child_done(addr, logtod);
8221 /* Panic-dies on error */
8222 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8225 /* Otherwise, handle the sending of a message. Find the error address for
8226 the first address, then send a message that includes all failed addresses
8227 that have the same error address. */
8230 send_bounce_message(now, logtod);
8233 f.disable_logging = FALSE; /* In case left set */
8235 /* Come here from the mua_wrapper case if routing goes wrong */
8239 /* If there are now no deferred addresses, we are done. Preserve the
8240 message log if so configured, and we are using them. Otherwise, sling it.
8241 Then delete the message itself. */
8249 fname = spool_fname(US"msglog", message_subdir, id, US"");
8250 if (preserve_message_logs)
8253 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8255 if ((rc = Urename(fname, moname)) < 0)
8257 (void)directory_make(spool_directory,
8258 spool_sname(US"msglog.OLD", US""),
8259 MSGLOG_DIRECTORY_MODE, TRUE);
8260 rc = Urename(fname, moname);
8263 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8264 "msglog.OLD directory", fname);
8267 if (Uunlink(fname) < 0)
8268 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8269 fname, strerror(errno));
8272 /* Remove the two message files. */
8274 fname = spool_fname(US"input", message_subdir, id, US"-D");
8275 if (Uunlink(fname) < 0)
8276 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8277 fname, strerror(errno));
8278 fname = spool_fname(US"input", message_subdir, id, US"-H");
8279 if (Uunlink(fname) < 0)
8280 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8281 fname, strerror(errno));
8283 /* Log the end of this message, with queue time if requested. */
8285 if (LOGGING(queue_time_overall))
8286 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8288 log_write(0, LOG_MAIN, "Completed");
8290 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8291 f.deliver_freeze = FALSE;
8293 #ifndef DISABLE_EVENT
8294 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8298 /* If there are deferred addresses, we are keeping this message because it is
8299 not yet completed. Lose any temporary files that were catching output from
8300 pipes for any of the deferred addresses, handle one-time aliases, and see if
8301 the message has been on the queue for so long that it is time to send a warning
8302 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8303 have the same domain, we can set deliver_domain for the expansion of
8304 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8305 the parent's domain.
8307 If all the deferred addresses have an error number that indicates "retry time
8308 not reached", skip sending the warning message, because it won't contain the
8309 reason for the delay. It will get sent at the next real delivery attempt.
8310 Exception: for retries caused by a remote peer we use the error message
8311 store in the retry DB as the reason.
8312 However, if at least one address has tried, we'd better include all of them in
8315 If we can't make a process to send the message, don't worry.
8317 For mailing list expansions we want to send the warning message to the
8318 mailing list manager. We can't do a perfect job here, as some addresses may
8319 have different errors addresses, but if we take the errors address from
8320 each deferred address it will probably be right in most cases.
8322 If addr_defer == +1, it means there was a problem sending an error message
8323 for failed addresses, and there were no "real" deferred addresses. The value
8324 was set just to keep the message on the spool, so there is nothing to do here.
8327 else if (addr_defer != (address_item *)(+1))
8329 uschar * recipients = US"";
8330 BOOL want_warning_msg = FALSE;
8332 deliver_domain = testflag(addr_defer, af_pfr)
8333 ? addr_defer->parent->domain : addr_defer->domain;
8335 for (address_item * addr = addr_defer; addr; addr = addr->next)
8337 address_item * otaddr;
8339 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8343 const uschar *d = testflag(addr, af_pfr)
8344 ? addr->parent->domain : addr->domain;
8346 /* The domain may be unset for an address that has never been routed
8347 because the system filter froze the message. */
8349 if (!d || Ustrcmp(d, deliver_domain) != 0)
8350 deliver_domain = NULL;
8353 if (addr->return_filename) Uunlink(addr->return_filename);
8355 /* Handle the case of one-time aliases. If any address in the ancestry
8356 of this one is flagged, ensure it is in the recipients list, suitably
8357 flagged, and that its parent is marked delivered. */
8359 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8360 if (otaddr->onetime_parent) break;
8365 int t = recipients_count;
8367 for (i = 0; i < recipients_count; i++)
8369 uschar *r = recipients_list[i].address;
8370 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8371 if (Ustrcmp(otaddr->address, r) == 0) break;
8374 /* Didn't find the address already in the list, and did find the
8375 ultimate parent's address in the list, and they really are different
8376 (i.e. not from an identity-redirect). After adding the recipient,
8377 update the errors address in the recipients list. */
8379 if ( i >= recipients_count && t < recipients_count
8380 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8382 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8383 otaddr->address, otaddr->parent->address);
8384 receive_add_recipient(otaddr->address, t);
8385 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8386 tree_add_nonrecipient(otaddr->parent->address);
8387 update_spool = TRUE;
8391 /* Except for error messages, ensure that either the errors address for
8392 this deferred address or, if there is none, the sender address, is on the
8393 list of recipients for a warning message. */
8395 if (sender_address[0])
8397 uschar * s = addr->prop.errors_address;
8398 if (!s) s = sender_address;
8399 if (Ustrstr(recipients, s) == NULL)
8400 recipients = string_sprintf("%s%s%s", recipients,
8401 recipients[0] ? "," : "", s);
8405 /* Send a warning message if the conditions are right. If the condition check
8406 fails because of a lookup defer, there is nothing we can do. The warning
8407 is not sent. Another attempt will be made at the next delivery attempt (if
8410 if ( !f.queue_2stage
8412 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8413 || addr_defer->dsn_flags & rf_notify_delay
8415 && delay_warning[1] > 0
8416 && sender_address[0] != 0
8417 && ( !delay_warning_condition
8418 || expand_check_condition(delay_warning_condition,
8419 US"delay_warning", US"option")
8425 int queue_time = time(NULL) - received_time.tv_sec;
8427 queue_time = test_harness_fudged_queue_time(queue_time);
8429 /* See how many warnings we should have sent by now */
8431 for (count = 0; count < delay_warning[1]; count++)
8432 if (queue_time < delay_warning[count+2]) break;
8434 show_time = delay_warning[count+1];
8436 if (count >= delay_warning[1])
8439 int last_gap = show_time;
8440 if (count > 1) last_gap -= delay_warning[count];
8441 extra = (queue_time - delay_warning[count+1])/last_gap;
8442 show_time += last_gap * extra;
8448 debug_printf("time on queue = %s id %s addr %s\n",
8449 readconf_printtime(queue_time), message_id, addr_defer->address);
8450 debug_printf("warning counts: required %d done %d\n", count,
8454 /* We have computed the number of warnings there should have been by now.
8455 If there haven't been enough, send one, and up the count to what it should
8458 if (warning_count < count)
8459 if (send_warning_message(recipients, queue_time, show_time))
8461 warning_count = count;
8462 update_spool = TRUE; /* Ensure spool rewritten */
8466 /* Clear deliver_domain */
8468 deliver_domain = NULL;
8470 /* If this was a first delivery attempt, unset the first time flag, and
8471 ensure that the spool gets updated. */
8473 if (f.deliver_firsttime && !f.queue_2stage)
8475 f.deliver_firsttime = FALSE;
8476 update_spool = TRUE;
8479 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8480 message, unless the message is a local error message (to avoid loops). Then
8481 log the freezing. If the text in "frozen_info" came from a system filter,
8482 it has been escaped into printing characters so as not to mess up log lines.
8483 For the "tell" message, we turn \n back into newline. Also, insert a newline
8484 near the start instead of the ": " string. */
8486 if (f.deliver_freeze)
8488 if (freeze_tell && *freeze_tell && !f.local_error_message)
8490 uschar * s = string_copy(frozen_info);
8491 uschar * ss = Ustrstr(s, " by the system filter: ");
8500 if (*ss == '\\' && ss[1] == 'n')
8501 { *ss++ = ' '; *ss++ = '\n'; }
8505 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8506 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8510 /* Log freezing just before we update the -H file, to minimize the chance
8511 of a race problem. */
8513 deliver_msglog("*** Frozen%s\n", frozen_info);
8514 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8517 /* If there have been any updates to the non-recipients list, or other things
8518 that get written to the spool, we must now update the spool header file so
8519 that it has the right information for the next delivery attempt. If there
8520 was more than one address being delivered, the header_change update is done
8521 earlier, in case one succeeds and then something crashes. */
8524 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8525 update_spool, f.header_rewritten);
8527 if (update_spool || f.header_rewritten)
8528 /* Panic-dies on error */
8529 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8532 /* Finished with the message log. If the message is complete, it will have
8533 been unlinked or renamed above. */
8535 if (message_logs) (void)fclose(message_log);
8537 /* Now we can close and remove the journal file. Its only purpose is to record
8538 successfully completed deliveries asap so that this information doesn't get
8539 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8540 not serious, as trying it again is not harmful. The journal might not be open
8541 if all addresses were deferred at routing or directing. Nevertheless, we must
8542 remove it if it exists (may have been lying around from a crash during the
8543 previous delivery attempt). We don't remove the journal if a delivery
8544 subprocess failed to pass back delivery information; this is controlled by
8545 the remove_journal flag. When the journal is left, we also don't move the
8546 message off the main spool if frozen and the option is set. It should get moved
8547 at the next attempt, after the journal has been inspected. */
8549 if (journal_fd >= 0) (void)close(journal_fd);
8553 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8555 if (Uunlink(fname) < 0 && errno != ENOENT)
8556 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8559 /* Move the message off the spool if requested */
8561 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8562 if (f.deliver_freeze && move_frozen_messages)
8563 (void)spool_move_message(id, message_subdir, US"", US"F");
8567 /* Closing the data file frees the lock; if the file has been unlinked it
8568 will go away. Otherwise the message becomes available for another process
8571 (void)close(deliver_datafile);
8572 deliver_datafile = -1;
8573 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8574 #ifdef MEASURE_TIMING
8575 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8578 /* It is unlikely that there will be any cached resources, since they are
8579 released after routing, and in the delivery subprocesses. However, it's
8580 possible for an expansion for something afterwards (for example,
8581 expand_check_condition) to do a lookup. We must therefore be sure everything is
8585 acl_where = ACL_WHERE_UNKNOWN;
8594 #ifdef EXIM_TFO_PROBE
8597 f.tcp_fastopen_ok = TRUE;
8603 /* Called from a commandline, or from the daemon, to do a delivery.
8604 We need to regain privs; do this by exec of the exim binary. */
8607 delivery_re_exec(int exec_type)
8611 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8613 int channel_fd = cutthrough.cctx.sock;
8615 smtp_peer_options = cutthrough.peer_options;
8616 continue_sequence = 0;
8619 if (cutthrough.is_tls)
8623 smtp_peer_options |= OPTION_TLS;
8624 sending_ip_address = cutthrough.snd_ip;
8625 sending_port = cutthrough.snd_port;
8627 where = US"socketpair";
8628 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8632 testharness_pause_ms(150);
8633 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8636 if (pid == 0) /* child: will fork again to totally disconnect */
8638 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8639 pfd, 5*60, cutthrough.host.name);
8640 /* does not return */
8644 waitpid(pid, NULL, 0);
8645 (void) close(channel_fd); /* release the client socket */
8646 channel_fd = pfd[1];
8650 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8651 cutthrough.host.address, message_id, channel_fd);
8655 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8656 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8658 return; /* compiler quietening; control does not reach here. */
8663 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8664 "delivery re-exec %s failed: %s", where, strerror(errno));
8666 /* Get here if exec_type == CEE_EXEC_EXIT.
8667 Note: this must be _exit(), not exit(). */
8669 _exit(EX_EXECFAILED);
8675 /* End of deliver.c */