1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
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 const 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 const 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(const 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(const uschar * one, const 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 (testflag(addr, af_cont_conn))
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(const uschar * action, const uschar * event, const uschar * ev_data,
869 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
871 action, deliver_host_address);
874 event_data = ev_data;
876 if (!(s = expand_cstring(action)) && *expand_string_message)
877 log_write(0, LOG_MAIN|LOG_PANIC,
878 "failed to expand event_action %s in %s: %s\n",
879 event, transport_name ? transport_name : US"main", expand_string_message);
881 event_name = event_data = NULL;
883 /* If the expansion returns anything but an empty string, flag for
884 the caller to modify his normal processing. Copy the string to
890 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
892 *errnop = ERRNO_EVENT;
893 return string_copy(s);
900 msg_event_raise(const uschar * event, const address_item * addr)
902 const uschar * save_domain = deliver_domain;
903 const uschar * save_local = deliver_localpart;
904 const uschar * save_host = deliver_host;
905 const uschar * save_address = deliver_host_address;
906 uschar * save_rn = router_name, * save_tn = transport_name;
907 const int save_port = deliver_host_port;
909 router_name = addr->router ? addr->router->name : NULL;
910 deliver_domain = addr->domain;
911 deliver_localpart = addr->local_part;
912 deliver_host = addr->host_used ? addr->host_used->name : NULL;
914 if (!addr->transport)
916 if (Ustrcmp(event, "msg:fail:delivery") == 0)
918 /* An address failed with no transport involved. This happens when
919 a filter was used which triggered a fail command (in such a case
920 a transport isn't needed). Convert it to an internal fail event. */
922 (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
927 transport_name = addr->transport->name;
929 (void) event_raise(addr->transport->event_action, event,
931 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
932 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
933 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
934 ? addr->message : NULL,
938 deliver_host_port = save_port;
939 deliver_host_address = save_address;
940 deliver_host = save_host;
941 deliver_localpart = save_local;
942 deliver_domain = save_domain;
943 router_name = save_rn;
944 transport_name = save_tn;
946 #endif /*DISABLE_EVENT*/
950 /******************************************************************************/
953 /*************************************************
954 * Generate local part for logging *
955 *************************************************/
957 static const uschar *
958 string_get_lpart_sub(const address_item * addr, const uschar * s)
961 if (testflag(addr, af_utf8_downcvt))
963 const uschar * t = string_localpart_utf8_to_alabel(s, NULL);
964 return t ? t : s; /* t is NULL on a failed conversion */
970 /* This function is a subroutine for use in string_log_address() below.
973 addr the address being logged
974 yield the current dynamic buffer pointer
976 Returns: the new value of the buffer pointer
980 string_get_localpart(address_item * addr, gstring * yield)
984 if (testflag(addr, af_include_affixes) && (s = addr->prefix))
985 yield = string_cat(yield, string_get_lpart_sub(addr, s));
987 yield = string_cat(yield, string_get_lpart_sub(addr, addr->local_part));
989 if (testflag(addr, af_include_affixes) && (s = addr->suffix))
990 yield = string_cat(yield, string_get_lpart_sub(addr, s));
996 /*************************************************
997 * Generate log address list *
998 *************************************************/
1000 /* This function generates a list consisting of an address and its parents, for
1001 use in logging lines. For saved onetime aliased addresses, the onetime parent
1002 field is used. If the address was delivered by a transport with rcpt_include_
1003 affixes set, the af_include_affixes bit will be set in the address. In that
1004 case, we include the affixes here too.
1007 g points to growing-string struct
1008 addr bottom (ultimate) address
1009 all_parents if TRUE, include all parents
1010 success TRUE for successful delivery
1012 Returns: a growable string in dynamic store
1016 string_log_address(gstring * g,
1017 address_item *addr, BOOL all_parents, BOOL success)
1019 BOOL add_topaddr = TRUE;
1020 address_item *topaddr;
1022 /* Find the ultimate parent */
1024 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1026 /* We start with just the local part for pipe, file, and reply deliveries, and
1027 for successful local deliveries from routers that have the log_as_local flag
1028 set. File deliveries from filters can be specified as non-absolute paths in
1029 cases where the transport is going to complete the path. If there is an error
1030 before this happens (expansion failure) the local part will not be updated, and
1031 so won't necessarily look like a path. Add extra text for this case. */
1033 if ( testflag(addr, af_pfr)
1035 && addr->router && addr->router->log_as_local
1036 && addr->transport && addr->transport->info->local
1039 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1040 g = string_catn(g, CUS"save ", 5);
1041 g = string_get_localpart(addr, g);
1044 /* Other deliveries start with the full address. It we have split it into local
1045 part and domain, use those fields. Some early failures can happen before the
1046 splitting is done; in those cases use the original field. */
1051 int off = gstring_length(g); /* start of the "full address" */
1053 if (addr->local_part)
1056 g = string_get_localpart(addr, g);
1057 g = string_catn(g, US"@", 1);
1060 if (testflag(addr, af_utf8_downcvt))
1061 s = string_localpart_utf8_to_alabel(s, NULL);
1063 g = string_cat(g, s);
1066 g = string_cat(g, addr->address);
1068 /* If the address we are going to print is the same as the top address,
1069 and all parents are not being included, don't add on the top address. First
1070 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1071 on the local parts. */
1073 cmp = g->s + off; /* only now, as rebuffer likely done */
1074 string_from_gstring(g); /* ensure nul-terminated */
1075 if ( strcmpic(cmp, topaddr->address) == 0
1076 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1077 && !addr->onetime_parent
1078 && (!all_parents || !addr->parent || addr->parent == topaddr)
1080 add_topaddr = FALSE;
1083 /* If all parents are requested, or this is a local pipe/file/reply, and
1084 there is at least one intermediate parent, show it in brackets, and continue
1085 with all of them if all are wanted. */
1087 if ( (all_parents || testflag(addr, af_pfr))
1089 && addr->parent != topaddr)
1092 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1094 g = string_catn(g, s, 2);
1095 g = string_cat (g, addr2->address);
1096 if (!all_parents) break;
1099 g = string_catn(g, US")", 1);
1102 /* Add the top address if it is required */
1105 g = string_append(g, 3,
1107 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1115 /******************************************************************************/
1119 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1120 this is a nonstandard call; no two-character delivery flag is written
1121 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1124 flags passed to log_write()
1127 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1129 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1132 /* Log the delivery on the main log. We use an extensible string to build up
1133 the log line, and reset the store afterwards. Remote deliveries should always
1134 have a pointer to the host item that succeeded; local deliveries can have a
1135 pointer to a single host item in their host list, for use by the transport. */
1137 #ifndef DISABLE_EVENT
1138 /* presume no successful remote delivery */
1139 lookup_dnssec_authenticated = NULL;
1142 reset_point = store_mark();
1143 g = string_get_tainted(256, GET_TAINTED); /* addrs will be tainted, so avoid copy */
1146 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1149 g->s[0] = logchar; g->ptr = 1;
1150 g = string_catn(g, US"> ", 2);
1152 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1154 if (LOGGING(sender_on_delivery) || msg)
1155 g = string_append(g, 3, US" F=<",
1157 testflag(addr, af_utf8_downcvt)
1158 ? string_address_utf8_to_alabel(sender_address, NULL)
1165 g = string_append(g, 2, US" Q=", queue_name);
1167 /* You might think that the return path must always be set for a successful
1168 delivery; indeed, I did for some time, until this statement crashed. The case
1169 when it is not set is for a delivery to /dev/null which is optimised by not
1170 being run at all. */
1172 if (used_return_path && LOGGING(return_path_on_delivery))
1173 g = string_append(g, 3, US" P=<", used_return_path, US">");
1176 g = string_append(g, 2, US" ", msg);
1178 /* For a delivery from a system filter, there may not be a router */
1180 g = string_append(g, 2, US" R=", addr->router->name);
1182 g = string_append(g, 2, US" T=", addr->transport->name);
1184 if (LOGGING(delivery_size))
1185 g = string_fmt_append(g, " S=%d", transport_count);
1187 /* Local delivery */
1189 if (addr->transport->info->local)
1191 if (addr->host_list)
1192 g = string_append(g, 2, US" H=", addr->host_list->name);
1193 g = d_log_interface(g);
1194 if (addr->shadow_message)
1195 g = string_cat(g, addr->shadow_message);
1198 /* Remote delivery */
1202 if (addr->host_used)
1204 g = d_hostlog(g, addr);
1206 #ifndef DISABLE_EVENT
1207 deliver_host_address = addr->host_used->address;
1208 deliver_host_port = addr->host_used->port;
1209 deliver_host = addr->host_used->name;
1211 /* DNS lookup status */
1212 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1213 : addr->host_used->dnssec==DS_NO ? US"no"
1219 g = d_tlslog(g, addr);
1222 if (addr->authenticator)
1224 g = string_append(g, 2, US" A=", addr->authenticator);
1227 g = string_append(g, 2, US":", addr->auth_id);
1228 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1229 g = string_append(g, 2, US":", addr->auth_sndr);
1233 if (LOGGING(pipelining))
1235 if (testflag(addr, af_pipelining))
1236 g = string_catn(g, US" L", 2);
1237 #ifndef DISABLE_PIPE_CONNECT
1238 if (testflag(addr, af_early_pipe))
1239 g = string_catn(g, US"*", 1);
1243 #ifndef DISABLE_PRDR
1244 if (testflag(addr, af_prdr_used))
1245 g = string_catn(g, US" PRDR", 5);
1248 if (testflag(addr, af_chunking_used))
1249 g = string_catn(g, US" K", 2);
1252 #ifndef DISABLE_DKIM
1253 if (addr->dkim_used && LOGGING(dkim_verbose))
1255 g = string_catn(g, US" DKIM=", 6);
1256 g = string_cat(g, addr->dkim_used);
1260 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1262 if ( LOGGING(smtp_confirmation)
1264 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1267 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1268 uschar *p = big_buffer;
1269 uschar *ss = addr->message;
1271 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1273 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1278 g = string_append(g, 2, US" C=", big_buffer);
1281 /* Time on queue and actual time taken to deliver */
1283 if (LOGGING(queue_time))
1284 g = string_append(g, 2, US" QT=", string_timesince(
1285 LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1287 if (LOGGING(deliver_time))
1288 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1290 /* string_cat() always leaves room for the terminator. Release the
1291 store we used to build the line after writing it. */
1293 log_write(0, flags, "%Y", g);
1295 #ifndef DISABLE_EVENT
1296 if (!msg) msg_event_raise(US"msg:delivery", addr);
1299 store_reset(reset_point);
1306 deferral_log(address_item * addr, uschar * now,
1307 int logflags, uschar * driver_name, uschar * driver_kind)
1309 rmark reset_point = store_mark();
1310 gstring * g = string_get(256);
1312 /* Build up the line that is used for both the message log and the main
1315 /* Create the address string for logging. Must not do this earlier, because
1316 an OK result may be changed to FAIL when a pipe returns text. */
1318 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1321 g = string_append(g, 2, US" Q=", queue_name);
1323 /* Either driver_name contains something and driver_kind contains
1324 " router" or " transport" (note the leading space), or driver_name is
1325 a null string and driver_kind contains "routing" without the leading
1326 space, if all routing has been deferred. When a domain has been held,
1327 so nothing has been done at all, both variables contain null strings. */
1331 if (driver_kind[1] == 't' && addr->router)
1332 g = string_append(g, 2, US" R=", addr->router->name);
1333 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1335 else if (driver_kind)
1336 g = string_append(g, 2, US" ", driver_kind);
1338 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1340 if (addr->basic_errno > 0)
1341 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1343 if (addr->host_used)
1344 g = d_hostlog(g, addr);
1346 if (LOGGING(deliver_time))
1347 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1350 g = string_append(g, 2, US": ", addr->message);
1352 /* Log the deferment in the message log, but don't clutter it
1353 up with retry-time defers after the first delivery attempt. */
1355 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1356 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1358 /* Write the main log and reset the store.
1359 For errors of the type "retry time not reached" (also remotes skipped
1360 on queue run), logging is controlled by L_retry_defer. Note that this kind
1361 of error number is negative, and all the retry ones are less than any
1365 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1368 store_reset(reset_point);
1375 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1377 rmark reset_point = store_mark();
1378 gstring * g = string_get(256);
1380 #ifndef DISABLE_EVENT
1381 /* Message failures for which we will send a DSN get their event raised
1382 later so avoid doing it here. */
1384 if ( !addr->prop.ignore_error
1385 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1387 msg_event_raise(US"msg:fail:delivery", addr);
1390 /* Build up the log line for the message and main logs */
1392 /* Create the address string for logging. Must not do this earlier, because
1393 an OK result may be changed to FAIL when a pipe returns text. */
1395 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1397 if (LOGGING(sender_on_delivery))
1398 g = string_append(g, 3, US" F=<", sender_address, US">");
1401 g = string_append(g, 2, US" Q=", queue_name);
1403 /* Return path may not be set if no delivery actually happened */
1405 if (used_return_path && LOGGING(return_path_on_delivery))
1406 g = string_append(g, 3, US" P=<", used_return_path, US">");
1409 g = string_append(g, 2, US" R=", addr->router->name);
1410 if (addr->transport)
1411 g = string_append(g, 2, US" T=", addr->transport->name);
1413 if (addr->host_used)
1414 g = d_hostlog(g, addr);
1417 g = d_tlslog(g, addr);
1420 if (addr->basic_errno > 0)
1421 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1424 g = string_append(g, 2, US": ", addr->message);
1426 if (LOGGING(deliver_time))
1427 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1429 /* Do the logging. For the message log, "routing failed" for those cases,
1430 just to make it clearer. */
1433 deliver_msglog("%s %s failed for %.*s\n", now, driver_kind, g->ptr, g->s);
1435 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1437 log_write(0, LOG_MAIN, "** %Y", g);
1439 store_reset(reset_point);
1445 /*************************************************
1446 * Actions at the end of handling an address *
1447 *************************************************/
1449 /* This is a function for processing a single address when all that can be done
1450 with it has been done.
1453 addr points to the address block
1454 result the result of the delivery attempt
1455 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1456 driver_type indicates which type of driver (transport, or router) was last
1457 to process the address
1458 logchar '=' or '-' for use when logging deliveries with => or ->
1464 post_process_one(address_item * addr, int result, int logflags, int driver_type,
1467 uschar * now = tod_stamp(tod_log);
1468 uschar * driver_kind = NULL;
1469 uschar * driver_name = NULL;
1471 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1473 /* Set up driver kind and name for logging. Disable logging if the router or
1474 transport has disabled it. */
1476 if (driver_type == EXIM_DTYPE_TRANSPORT)
1478 if (addr->transport)
1480 driver_name = addr->transport->name;
1481 driver_kind = US" transport";
1482 f.disable_logging = addr->transport->disable_logging;
1484 else driver_kind = US"transporting";
1486 else if (driver_type == EXIM_DTYPE_ROUTER)
1490 driver_name = addr->router->name;
1491 driver_kind = US" router";
1492 f.disable_logging = addr->router->disable_logging;
1494 else driver_kind = US"routing";
1497 /* If there's an error message set, ensure that it contains only printing
1498 characters - it should, but occasionally things slip in and this at least
1499 stops the log format from getting wrecked. We also scan the message for an LDAP
1500 expansion item that has a password setting, and flatten the password. This is a
1501 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1502 malformed, it won't ever have gone near LDAP.) */
1506 const uschar * s = string_printing(addr->message);
1508 /* deconst cast ok as string_printing known to have alloc'n'copied */
1509 addr->message = expand_hide_passwords(US s);
1512 /* If we used a transport that has one of the "return_output" options set, and
1513 if it did in fact generate some output, then for return_output we treat the
1514 message as failed if it was not already set that way, so that the output gets
1515 returned to the sender, provided there is a sender to send it to. For
1516 return_fail_output, do this only if the delivery failed. Otherwise we just
1517 unlink the file, and remove the name so that if the delivery failed, we don't
1518 try to send back an empty or unwanted file. The log_output options operate only
1519 on a non-empty file.
1521 In any case, we close the message file, because we cannot afford to leave a
1522 file-descriptor for one address while processing (maybe very many) others. */
1524 if (addr->return_file >= 0 && addr->return_filename)
1526 BOOL return_output = FALSE;
1527 struct stat statbuf;
1528 (void)EXIMfsync(addr->return_file);
1530 /* If there is no output, do nothing. */
1532 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1534 transport_instance *tb = addr->transport;
1536 /* Handle logging options */
1539 || result == FAIL && tb->log_fail_output
1540 || result == DEFER && tb->log_defer_output
1544 FILE *f = Ufopen(addr->return_filename, "rb");
1546 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1547 "from %s transport: %s", addr->return_filename, tb->name,
1550 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1552 uschar *p = big_buffer + Ustrlen(big_buffer);
1554 while (p > big_buffer && isspace(p[-1])) p--;
1556 sp = string_printing(big_buffer);
1557 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1558 addr->address, tb->name, sp);
1563 /* Handle returning options, but only if there is an address to return
1566 if (sender_address[0] != 0 || addr->prop.errors_address)
1567 if (tb->return_output)
1569 addr->transport_return = result = FAIL;
1570 if (addr->basic_errno == 0 && !addr->message)
1571 addr->message = US"return message generated";
1572 return_output = TRUE;
1575 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1578 /* Get rid of the file unless it might be returned, but close it in
1583 Uunlink(addr->return_filename);
1584 addr->return_filename = NULL;
1585 addr->return_file = -1;
1588 (void)close(addr->return_file);
1591 /* The success case happens only after delivery by a transport. */
1595 addr->next = addr_succeed;
1596 addr_succeed = addr;
1598 /* Call address_done() to ensure that we don't deliver to this address again,
1599 and write appropriate things to the message log. If it is a child address, we
1600 call child_done() to scan the ancestors and mark them complete if this is the
1601 last child to complete. */
1603 address_done(addr, now);
1604 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1607 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1608 driver_name, driver_kind);
1611 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1612 addr->parent->address, driver_name, driver_kind);
1613 child_done(addr, now);
1616 /* Certificates for logging (via events) */
1618 tls_out.ourcert = addr->ourcert;
1619 addr->ourcert = NULL;
1620 tls_out.peercert = addr->peercert;
1621 addr->peercert = NULL;
1623 tls_out.ver = addr->tlsver;
1624 tls_out.cipher = addr->cipher;
1625 tls_out.peerdn = addr->peerdn;
1626 tls_out.ocsp = addr->ocsp;
1627 # ifdef SUPPORT_DANE
1628 tls_out.dane_verified = testflag(addr, af_dane_verified);
1632 delivery_log(LOG_MAIN, addr, logchar, NULL);
1635 tls_free_cert(&tls_out.ourcert);
1636 tls_free_cert(&tls_out.peercert);
1638 tls_out.cipher = NULL;
1639 tls_out.peerdn = NULL;
1640 tls_out.ocsp = OCSP_NOT_REQ;
1641 # ifdef SUPPORT_DANE
1642 tls_out.dane_verified = FALSE;
1648 /* Soft failure, or local delivery process failed; freezing may be
1651 else if (result == DEFER || result == PANIC)
1653 if (result == PANIC) logflags |= LOG_PANIC;
1655 /* This puts them on the chain in reverse order. Do not change this, because
1656 the code for handling retries assumes that the one with the retry
1657 information is last. */
1659 addr->next = addr_defer;
1662 /* The only currently implemented special action is to freeze the
1663 message. Logging of this is done later, just before the -H file is
1666 if (addr->special_action == SPECIAL_FREEZE)
1668 f.deliver_freeze = TRUE;
1669 deliver_frozen_at = time(NULL);
1670 update_spool = TRUE;
1673 /* If doing a 2-stage queue run, we skip writing to either the message
1674 log or the main log for SMTP defers. */
1676 if (!f.queue_2stage || addr->basic_errno != 0)
1677 deferral_log(addr, now, logflags, driver_name, driver_kind);
1681 /* Hard failure. If there is an address to which an error message can be sent,
1682 put this address on the failed list. If not, put it on the deferred list and
1683 freeze the mail message for human attention. The latter action can also be
1684 explicitly requested by a router or transport. */
1688 /* If this is a delivery error, or a message for which no replies are
1689 wanted, and the message's age is greater than ignore_bounce_errors_after,
1690 force the af_ignore_error flag. This will cause the address to be discarded
1691 later (with a log entry). */
1693 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1694 addr->prop.ignore_error = TRUE;
1696 /* Freeze the message if requested, or if this is a bounce message (or other
1697 message with null sender) and this address does not have its own errors
1698 address. However, don't freeze if errors are being ignored. The actual code
1699 to ignore occurs later, instead of sending a message. Logging of freezing
1700 occurs later, just before writing the -H file. */
1702 if ( !addr->prop.ignore_error
1703 && ( addr->special_action == SPECIAL_FREEZE
1704 || (sender_address[0] == 0 && !addr->prop.errors_address)
1707 frozen_info = addr->special_action == SPECIAL_FREEZE
1709 : f.sender_local && !f.local_error_message
1710 ? US" (message created with -f <>)"
1711 : US" (delivery error message)";
1712 f.deliver_freeze = TRUE;
1713 deliver_frozen_at = time(NULL);
1714 update_spool = TRUE;
1716 /* The address is put on the defer rather than the failed queue, because
1717 the message is being retained. */
1719 addr->next = addr_defer;
1723 /* Don't put the address on the nonrecipients tree yet; wait until an
1724 error message has been successfully sent. */
1728 addr->next = addr_failed;
1732 failure_log(addr, driver_name ? NULL : driver_kind, now);
1735 /* Ensure logging is turned on again in all cases */
1737 f.disable_logging = FALSE;
1743 /*************************************************
1744 * Address-independent error *
1745 *************************************************/
1747 /* This function is called when there's an error that is not dependent on a
1748 particular address, such as an expansion string failure. It puts the error into
1749 all the addresses in a batch, logs the incident on the main and panic logs, and
1750 clears the expansions. It is mostly called from local_deliver(), but can be
1751 called for a remote delivery via findugid().
1754 logit TRUE if (MAIN+PANIC) logging required
1755 addr the first of the chain of addresses
1757 format format string for error message, or NULL if already set in addr
1758 ... arguments for the format
1764 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1766 addr->basic_errno = code;
1773 va_start(ap, format);
1774 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1776 addr->message = string_from_gstring(g);
1779 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1781 addr2->basic_errno = code;
1782 addr2->message = addr->message;
1785 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1786 deliver_set_expansions(NULL);
1792 /*************************************************
1793 * Check a "never users" list *
1794 *************************************************/
1796 /* This function is called to check whether a uid is on one of the two "never
1800 uid the uid to be checked
1801 nusers the list to be scanned; the first item in the list is the count
1803 Returns: TRUE if the uid is on the list
1807 check_never_users(uid_t uid, uid_t *nusers)
1809 if (!nusers) return FALSE;
1810 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1816 /*************************************************
1817 * Find uid and gid for a transport *
1818 *************************************************/
1820 /* This function is called for both local and remote deliveries, to find the
1821 uid/gid under which to run the delivery. The values are taken preferentially
1822 from the transport (either explicit or deliver_as_creator), then from the
1823 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1824 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1825 panic error is logged, and the function fails (which normally leads to delivery
1829 addr the address (possibly a chain)
1831 uidp pointer to uid field
1832 gidp pointer to gid field
1833 igfp pointer to the use_initgroups field
1835 Returns: FALSE if failed - error has been set in address(es)
1839 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1843 BOOL gid_set = FALSE;
1845 /* Default initgroups flag comes from the transport */
1847 *igfp = tp->initgroups;
1849 /* First see if there's a gid on the transport, either fixed or expandable.
1850 The expanding function always logs failure itself. */
1857 else if (tp->expand_gid)
1859 GET_OPTION("group");
1860 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1863 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1869 /* If the transport did not set a group, see if the router did. */
1871 if (!gid_set && testflag(addr, af_gid_set))
1877 /* Pick up a uid from the transport if one is set. */
1879 if (tp->uid_set) *uidp = tp->uid;
1881 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1882 it does not provide a passwd value from which a gid can be taken. */
1884 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 GET_OPTION("message_size_limit");
1992 deliver_set_expansions(addr);
1993 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1994 deliver_set_expansions(NULL);
1996 if (expand_string_message)
1999 addr->message = size_limit == -1
2000 ? string_sprintf("failed to expand message_size_limit "
2001 "in %s transport: %s", tp->name, expand_string_message)
2002 : string_sprintf("invalid message_size_limit "
2003 "in %s transport: %s", tp->name, expand_string_message);
2005 else if (size_limit > 0 && message_size > size_limit)
2009 string_sprintf("message is too big (transport limit = %d)",
2018 /*************************************************
2019 * Transport-time check for a previous delivery *
2020 *************************************************/
2022 /* Check that this base address hasn't previously been delivered to its routed
2023 transport. If it has been delivered, mark it done. The check is necessary at
2024 delivery time in order to handle homonymic addresses correctly in cases where
2025 the pattern of redirection changes between delivery attempts (so the unique
2026 fields change). Non-homonymic previous delivery is detected earlier, at routing
2027 time (which saves unnecessary routing).
2030 addr the address item
2031 testing TRUE if testing wanted only, without side effects
2033 Returns: TRUE if previously delivered by the transport
2037 previously_transported(address_item *addr, BOOL testing)
2039 uschar * s = string_sprintf("%s/%s",
2040 addr->unique + (testflag(addr, af_homonym) ? 3:0), addr->transport->name);
2042 if (tree_search(tree_nonrecipients, s) != 0)
2044 DEBUG(D_deliver|D_route|D_transport)
2045 debug_printf("%s was previously delivered (%s transport): discarded\n",
2046 addr->address, addr->transport->name);
2047 if (!testing) child_done(addr, tod_stamp(tod_log));
2056 /******************************************************
2057 * Check for a given header in a header string *
2058 ******************************************************/
2060 /* This function is used when generating quota warnings. The configuration may
2061 specify any header lines it likes in quota_warn_message. If certain of them are
2062 missing, defaults are inserted, so we need to be able to test for the presence
2066 hdr the required header name
2067 hstring the header string
2069 Returns: TRUE the header is in the string
2070 FALSE the header is not in the string
2074 contains_header(uschar *hdr, uschar *hstring)
2076 int len = Ustrlen(hdr);
2077 uschar *p = hstring;
2080 if (strncmpic(p, hdr, len) == 0)
2083 while (*p == ' ' || *p == '\t') p++;
2084 if (*p == ':') return TRUE;
2086 while (*p != 0 && *p != '\n') p++;
2087 if (*p == '\n') p++;
2095 /*************************************************
2096 * Perform a local delivery *
2097 *************************************************/
2099 /* Each local delivery is performed in a separate process which sets its
2100 uid and gid as specified. This is a safer way than simply changing and
2101 restoring using seteuid(); there is a body of opinion that seteuid()
2102 cannot be used safely. From release 4, Exim no longer makes any use of
2103 it for delivery. Besides, not all systems have seteuid().
2105 If the uid/gid are specified in the transport_instance, they are used; the
2106 transport initialization must ensure that either both or neither are set.
2107 Otherwise, the values associated with the address are used. If neither are set,
2108 it is a configuration error.
2110 The transport or the address may specify a home directory (transport over-
2111 rides), and if they do, this is set as $home. If neither have set a working
2112 directory, this value is used for that as well. Otherwise $home is left unset
2113 and the cwd is set to "/" - a directory that should be accessible to all users.
2115 Using a separate process makes it more complicated to get error information
2116 back. We use a pipe to pass the return code and also an error code and error
2117 text string back to the parent process.
2120 addr points to an address block for this delivery; for "normal" local
2121 deliveries this is the only address to be delivered, but for
2122 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2123 a number of addresses can be handled simultaneously, and in this
2124 case addr will point to a chain of addresses with the same
2127 shadowing TRUE if running a shadow transport; this causes output from pipes
2134 deliver_local(address_item *addr, BOOL shadowing)
2136 BOOL use_initgroups;
2139 int status, len, rc;
2142 uschar *working_directory;
2143 address_item *addr2;
2144 transport_instance *tp = addr->transport;
2146 /* Set up the return path from the errors or sender address. If the transport
2147 has its own return path setting, expand it and replace the existing value. */
2149 if(addr->prop.errors_address)
2150 return_path = addr->prop.errors_address;
2152 return_path = sender_address;
2154 GET_OPTION("return_path");
2155 if (tp->return_path)
2157 uschar * new_return_path = expand_string(tp->return_path);
2158 if (new_return_path)
2159 return_path = new_return_path;
2160 else if (!f.expand_string_forcedfail)
2162 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2163 US"Failed to expand return path \"%s\" in %s transport: %s",
2164 tp->return_path, tp->name, expand_string_message);
2169 /* For local deliveries, one at a time, the value used for logging can just be
2170 set directly, once and for all. */
2172 used_return_path = return_path;
2174 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2175 gets put into the address(es), and the expansions are unset, so we can just
2178 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2180 /* See if either the transport or the address specifies a home directory. A
2181 home directory set in the address may already be expanded; a flag is set to
2182 indicate that. In other cases we must expand it. */
2184 GET_OPTION("home_directory");
2185 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2186 || ( (deliver_home = addr->home_dir) /* Set in address and */
2187 && !testflag(addr, af_home_expanded) /* not expanded */
2190 uschar *rawhome = deliver_home;
2191 deliver_home = NULL; /* in case it contains $home */
2192 if (!(deliver_home = expand_string(rawhome)))
2194 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2195 "to expand for %s transport: %s", rawhome, tp->name,
2196 expand_string_message);
2199 if (*deliver_home != '/')
2201 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2202 "is not absolute for %s transport", deliver_home, tp->name);
2207 /* See if either the transport or the address specifies a current directory,
2208 and if so, expand it. If nothing is set, use the home directory, unless it is
2209 also unset in which case use "/", which is assumed to be a directory to which
2210 all users have access. It is necessary to be in a visible directory for some
2211 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2212 2.5) require this. */
2214 GET_OPTION("current_directory");
2215 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2216 if (working_directory)
2218 uschar *raw = working_directory;
2219 if (!(working_directory = expand_string(raw)))
2221 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2222 "failed to expand for %s transport: %s", raw, tp->name,
2223 expand_string_message);
2226 if (*working_directory != '/')
2228 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2229 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2233 else working_directory = deliver_home ? deliver_home : US"/";
2235 /* If one of the return_output flags is set on the transport, create and open a
2236 file in the message log directory for the transport to write its output onto.
2237 This is mainly used by pipe transports. The file needs to be unique to the
2238 address. This feature is not available for shadow transports. */
2241 && ( tp->return_output || tp->return_fail_output
2242 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2247 addr->return_filename =
2248 spool_fname(US"msglog", message_subdir, message_id,
2249 string_sprintf("-%d-%d", getpid(), return_count++));
2251 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2253 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2254 "to return message: %s", error, tp->name, strerror(errno));
2259 /* Create the pipe for inter-process communication. */
2263 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2268 /* Now fork the process to do the real work in the subprocess, but first
2269 ensure that all cached resources are freed so that the subprocess starts with
2270 a clean slate and doesn't interfere with the parent process. */
2274 if ((pid = exim_fork(US"delivery-local")) == 0)
2276 BOOL replicate = TRUE;
2278 /* Prevent core dumps, as we don't want them in users' home directories.
2279 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2280 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2281 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2282 complain if the error is "not supported".
2284 There are two scenarios where changing the max limit has an effect. In one,
2285 the user is using a .forward and invoking a command of their choice via pipe;
2286 for these, we do need the max limit to be 0 unless the admin chooses to
2287 permit an increased limit. In the other, the command is invoked directly by
2288 the transport and is under administrator control, thus being able to raise
2289 the limit aids in debugging. So there's no general always-right answer.
2291 Thus we inhibit core-dumps completely but let individual transports, while
2292 still root, re-raise the limits back up to aid debugging. We make the
2293 default be no core-dumps -- few enough people can use core dumps in
2294 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2301 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2303 # ifdef SETRLIMIT_NOT_SUPPORTED
2304 if (errno != ENOSYS && errno != ENOTSUP)
2306 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2311 /* Reset the random number generator, so different processes don't all
2312 have the same sequence. */
2316 /* If the transport has a setup entry, call this first, while still
2317 privileged. (Appendfile uses this to expand quota, for example, while
2318 able to read private files.) */
2320 if (addr->transport->setup)
2321 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2325 addr->transport_return = DEFER;
2329 addr->transport_return = PANIC;
2333 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2334 when the process becomes unprivileged, it won't be able to write to the
2335 process log. SIGHUP is ignored throughout exim, except when it is being
2338 signal(SIGINT, SIG_IGN);
2339 signal(SIGTERM, SIG_IGN);
2340 signal(SIGUSR1, SIG_IGN);
2342 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2343 half - for transports that exec things (e.g. pipe). Then set the required
2346 (void)close(pfd[pipe_read]);
2347 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2349 exim_setugid(uid, gid, use_initgroups,
2350 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2351 addr->address, addr->transport->name));
2355 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2356 for (address_item * batched = addr->next; batched; batched = batched->next)
2357 debug_printf("additional batched address: %s\n", batched->address);
2360 /* Set an appropriate working directory. */
2362 if (Uchdir(working_directory) < 0)
2364 addr->transport_return = DEFER;
2365 addr->basic_errno = errno;
2366 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2369 /* If successful, call the transport */
2374 set_process_info("delivering %s to %s using %s", message_id,
2375 addr->local_part, tp->name);
2377 /* Setting these globals in the subprocess means we need never clear them */
2379 transport_name = tp->name;
2380 if (addr->router) router_name = addr->router->name;
2381 driver_srcfile = tp->srcfile;
2382 driver_srcline = tp->srcline;
2384 /* If a transport filter has been specified, set up its argument list.
2385 Any errors will get put into the address, and FALSE yielded. */
2387 if (tp->filter_command)
2389 ok = transport_set_up_command(&transport_filter_argv,
2391 TSUC_EXPAND_ARGS, PANIC, addr, US"transport filter", NULL);
2392 transport_filter_timeout = tp->filter_timeout;
2394 else transport_filter_argv = NULL;
2398 debug_print_string(tp->debug_string);
2399 replicate = !(tp->info->code)(addr->transport, addr);
2403 /* Pass the results back down the pipe. If necessary, first replicate the
2404 status in the top address to the others in the batch. The label is the
2405 subject of a goto when a call to the transport's setup function fails. We
2406 pass the pointer to the transport back in case it got changed as a result of
2407 file_format in appendfile. */
2411 if (replicate) replicate_status(addr);
2412 for (addr2 = addr; addr2; addr2 = addr2->next)
2415 int local_part_length = Ustrlen(addr2->local_part);
2419 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2420 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2421 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2422 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2423 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2424 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2425 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2426 || (ret = write(pfd[pipe_write], &addr2->transport,
2427 sizeof(transport_instance *))) != sizeof(transport_instance *)
2429 /* For a file delivery, pass back the local part, in case the original
2430 was only part of the final delivery path. This gives more complete
2433 || (testflag(addr2, af_file)
2434 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2435 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2439 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2440 ret == -1 ? strerror(errno) : "short write");
2442 /* Now any messages */
2444 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2446 int message_length = s ? Ustrlen(s) + 1 : 0;
2447 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2448 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2450 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2451 ret == -1 ? strerror(errno) : "short write");
2455 /* OK, this process is now done. Free any cached resources that it opened,
2456 and close the pipe we were writing down before exiting. */
2458 (void)close(pfd[pipe_write]);
2459 exim_exit(EXIT_SUCCESS);
2462 /* Back in the main process: panic if the fork did not succeed. This seems
2463 better than returning an error - if forking is failing it is probably best
2464 not to try other deliveries for this message. */
2467 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2470 /* Read the pipe to get the delivery status codes and error messages. Our copy
2471 of the writing end must be closed first, as otherwise read() won't return zero
2472 on an empty pipe. We check that a status exists for each address before
2473 overwriting the address structure. If data is missing, the default DEFER status
2474 will remain. Afterwards, close the reading end. */
2476 (void)close(pfd[pipe_write]);
2478 for (addr2 = addr; addr2; addr2 = addr2->next)
2480 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2485 addr2->transport_return = status;
2486 len = read(pfd[pipe_read], &transport_count,
2487 sizeof(transport_count));
2488 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2489 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2490 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2491 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2492 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2493 len = read(pfd[pipe_read], &addr2->transport,
2494 sizeof(transport_instance *));
2496 if (testflag(addr2, af_file))
2499 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2500 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2503 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2504 " from delivery subprocess");
2507 /* sanity-checked llen so disable the Coverity error */
2508 /* coverity[tainted_data] */
2509 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2511 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2512 " from delivery subprocess");
2515 big_buffer[llen] = 0;
2516 addr2->local_part = string_copy(big_buffer);
2519 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2522 len = read(pfd[pipe_read], &message_length, sizeof(int));
2523 if (message_length > 0)
2525 len = read(pfd[pipe_read], big_buffer, message_length);
2526 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2527 if (len > 0) *sptr = string_copy(big_buffer);
2534 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2535 "from delivery subprocess", addr2->unique);
2540 (void)close(pfd[pipe_read]);
2542 /* Unless shadowing, write all successful addresses immediately to the journal
2543 file, to ensure they are recorded asap. For homonymic addresses, use the base
2544 address plus the transport name. Failure to write the journal is panic-worthy,
2545 but don't stop, as it may prove possible subsequently to update the spool file
2546 in order to record the delivery. */
2550 for (addr2 = addr; addr2; addr2 = addr2->next)
2551 if (addr2->transport_return == OK)
2553 if (testflag(addr2, af_homonym))
2554 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2556 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2558 /* In the test harness, wait just a bit to let the subprocess finish off
2559 any debug output etc first. */
2561 testharness_pause_ms(300);
2563 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2564 len = Ustrlen(big_buffer);
2565 if (write(journal_fd, big_buffer, len) != len)
2566 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2567 big_buffer, strerror(errno));
2570 /* Ensure the journal file is pushed out to disk. */
2572 if (EXIMfsync(journal_fd) < 0)
2573 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2577 /* Wait for the process to finish. If it terminates with a non-zero code,
2578 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2579 status values of all the addresses as they are. Take care to handle the case
2580 when the subprocess doesn't seem to exist. This has been seen on one system
2581 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2582 happens, wait() doesn't recognize the termination of child processes. Exim now
2583 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2585 while ((rc = wait(&status)) != pid)
2586 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2588 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2589 addr->transport->driver_name);
2594 if ((status & 0xffff) != 0)
2596 int msb = (status >> 8) & 255;
2597 int lsb = status & 255;
2598 int code = (msb == 0)? (lsb & 0x7f) : msb;
2599 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2600 addr->special_action = SPECIAL_FREEZE;
2601 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2602 "status 0x%04x: %s %d",
2603 addr->transport->driver_name,
2605 msb == 0 ? "terminated by signal" : "exit code",
2609 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2611 if (addr->special_action == SPECIAL_WARN)
2613 uschar * warn_message = addr->transport->warn_message;
2614 GET_OPTION("quota_warn_message");
2620 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2622 if (!(warn_message = expand_string(warn_message)))
2623 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2624 "message for %s transport): %s", addr->transport->warn_message,
2625 addr->transport->name, expand_string_message);
2627 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2629 FILE * f = fdopen(fd, "wb");
2630 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2631 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2632 fprintf(f, "Auto-Submitted: auto-replied\n");
2633 if (!contains_header(US"From", warn_message))
2635 fprintf(f, "%s", CS warn_message);
2637 /* Close and wait for child process to complete, without a timeout. */
2640 (void)child_close(pid, 0);
2643 addr->special_action = SPECIAL_NONE;
2651 /* Check transport for the given concurrency limit. Return TRUE if over
2652 the limit (or an expansion failure), else FALSE and if there was a limit,
2653 the key for the hints database used for the concurrency count. */
2656 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2658 unsigned max_parallel;
2660 GET_OPTION("max_parallel");
2661 if (!tp->max_parallel) return FALSE;
2663 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2664 if (expand_string_message)
2666 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2667 "in %s transport (%s): %s", tp->name, addr->address,
2668 expand_string_message);
2672 if (max_parallel > 0)
2674 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2675 if (!enq_start(serialize_key, max_parallel))
2677 address_item * next;
2679 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2680 tp->name, max_parallel);
2684 addr->message = US"concurrency limit reached for transport";
2685 addr->basic_errno = ERRNO_TRETRY;
2686 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2687 } while ((addr = next));
2690 *key = serialize_key;
2697 /*************************************************
2698 * Do local deliveries *
2699 *************************************************/
2701 /* This function processes the list of addresses in addr_local. True local
2702 deliveries are always done one address at a time. However, local deliveries can
2703 be batched up in some cases. Typically this is when writing batched SMTP output
2704 files for use by some external transport mechanism, or when running local
2705 deliveries over LMTP.
2712 do_local_deliveries(void)
2714 open_db dbblock, * dbm_file = NULL;
2715 time_t now = time(NULL);
2717 /* Loop until we have exhausted the supply of local deliveries */
2721 struct timeval delivery_start;
2722 struct timeval deliver_time;
2723 address_item *addr2, *addr3, *nextaddr;
2724 int logflags = LOG_MAIN;
2725 int logchar = f.dont_deliver? '*' : '=';
2726 transport_instance *tp;
2727 uschar * serialize_key = NULL;
2729 /* Pick the first undelivered address off the chain */
2731 address_item *addr = addr_local;
2732 addr_local = addr->next;
2735 DEBUG(D_deliver|D_transport)
2736 debug_printf("--------> %s <--------\n", addr->address);
2738 /* An internal disaster if there is no transport. Should not occur! */
2740 if (!(tp = addr->transport))
2742 logflags |= LOG_PANIC;
2743 f.disable_logging = FALSE; /* Jic */
2744 addr->message = addr->router
2745 ? string_sprintf("No transport set by %s router", addr->router->name)
2746 : US"No transport set by system filter";
2747 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2751 /* Check that this base address hasn't previously been delivered to this
2752 transport. The check is necessary at this point to handle homonymic addresses
2753 correctly in cases where the pattern of redirection changes between delivery
2754 attempts. Non-homonymic previous delivery is detected earlier, at routing
2757 if (previously_transported(addr, FALSE)) continue;
2759 /* There are weird cases where logging is disabled */
2761 f.disable_logging = tp->disable_logging;
2763 /* Check for batched addresses and possible amalgamation. Skip all the work
2764 if either batch_max <= 1 or there aren't any other addresses for local
2767 if (tp->batch_max > 1 && addr_local)
2769 int batch_count = 1;
2770 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2771 BOOL uses_lp = ( testflag(addr, af_pfr)
2772 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2774 || readconf_depends((driver_instance *)tp, US"local_part");
2775 uschar *batch_id = NULL;
2776 address_item **anchor = &addr_local;
2777 address_item *last = addr;
2780 /* Expand the batch_id string for comparison with other addresses.
2781 Expansion failure suppresses batching. */
2783 GET_OPTION("batch_id");
2786 deliver_set_expansions(addr);
2787 batch_id = expand_string(tp->batch_id);
2788 deliver_set_expansions(NULL);
2791 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2792 "in %s transport (%s): %s", tp->name, addr->address,
2793 expand_string_message);
2794 batch_count = tp->batch_max;
2798 /* Until we reach the batch_max limit, pick off addresses which have the
2799 same characteristics. These are:
2802 not previously delivered (see comment about 50 lines above)
2803 same local part if the transport's configuration contains $local_part
2804 or if this is a file or pipe delivery from a redirection
2805 same domain if the transport's configuration contains $domain
2807 same additional headers
2808 same headers to be removed
2809 same uid/gid for running the transport
2810 same first host if a host list is set
2813 while ((next = *anchor) && batch_count < tp->batch_max)
2816 tp == next->transport
2817 && !previously_transported(next, TRUE)
2818 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2819 && testflag(addr, af_file) == testflag(next, af_file)
2820 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2821 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2822 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2823 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2824 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2825 && same_ugid(tp, addr, next)
2826 && ( !addr->host_list && !next->host_list
2829 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2832 /* If the transport has a batch_id setting, batch_id will be non-NULL
2833 from the expansion outside the loop. Expand for this address and compare.
2834 Expansion failure makes this address ineligible for batching. */
2839 address_item * save_nextnext = next->next;
2840 next->next = NULL; /* Expansion for a single address */
2841 deliver_set_expansions(next);
2842 next->next = save_nextnext;
2843 GET_OPTION("batch_id");
2844 bid = expand_string(tp->batch_id);
2845 deliver_set_expansions(NULL);
2848 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2849 "in %s transport (%s): %s", tp->name, next->address,
2850 expand_string_message);
2853 else ok = (Ustrcmp(batch_id, bid) == 0);
2856 /* Take address into batch if OK. */
2860 *anchor = next->next; /* Include the address */
2866 else anchor = &next->next; /* Skip the address */
2870 /* We now have one or more addresses that can be delivered in a batch. Check
2871 whether the transport is prepared to accept a message of this size. If not,
2872 fail them all forthwith. If the expansion fails, or does not yield an
2873 integer, defer delivery. */
2875 if (tp->message_size_limit)
2877 int rc = check_message_size(tp, addr);
2880 replicate_status(addr);
2884 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2887 continue; /* With next batch of addresses */
2891 /* If we are not running the queue, or if forcing, all deliveries will be
2892 attempted. Otherwise, we must respect the retry times for each address. Even
2893 when not doing this, we need to set up the retry key string, and determine
2894 whether a retry record exists, because after a successful delivery, a delete
2895 retry item must be set up. Keep the retry database open only for the duration
2896 of these checks, rather than for all local deliveries, because some local
2897 deliveries (e.g. to pipes) can take a substantial time. */
2899 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2900 DEBUG(D_deliver|D_retry|D_hints_lookup)
2901 debug_printf("no retry data available\n");
2907 BOOL ok = TRUE; /* to deliver this address */
2910 /* Set up the retry key to include the domain or not, and change its
2911 leading character from "R" to "T". Must make a copy before doing this,
2912 because the old key may be pointed to from a "delete" retry item after
2915 retry_key = string_copy(
2916 tp->retry_use_local_part ? addr2->address_retry_key :
2917 addr2->domain_retry_key);
2920 /* Inspect the retry data. If there is no hints file, delivery happens. */
2924 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2926 /* If there is no retry record, delivery happens. If there is,
2927 remember it exists so it can be deleted after a successful delivery. */
2931 setflag(addr2, af_lt_retry_exists);
2933 /* A retry record exists for this address. If queue running and not
2934 forcing, inspect its contents. If the record is too old, or if its
2935 retry time has come, or if it has passed its cutoff time, delivery
2940 debug_printf("retry record exists: age=%s ",
2941 readconf_printtime(now - retry_record->time_stamp));
2942 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2943 debug_printf(" time to retry = %s expired = %d\n",
2944 readconf_printtime(retry_record->next_try - now),
2945 retry_record->expired);
2948 if (f.queue_running && !f.deliver_force)
2950 ok = (now - retry_record->time_stamp > retry_data_expire)
2951 || (now >= retry_record->next_try)
2952 || retry_record->expired;
2954 /* If we haven't reached the retry time, there is one more check
2955 to do, which is for the ultimate address timeout. */
2958 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2962 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2965 /* This address is to be delivered. Leave it on the chain. */
2970 addr2 = addr2->next;
2973 /* This address is to be deferred. Take it out of the chain, and
2974 post-process it as complete. Must take it out of the chain first,
2975 because post processing puts it on another chain. */
2979 address_item *this = addr2;
2980 this->message = US"Retry time not yet reached";
2981 this->basic_errno = ERRNO_LRETRY;
2982 addr2 = addr3 ? (addr3->next = addr2->next)
2983 : (addr = addr2->next);
2984 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2988 if (dbm_file) dbfn_close(dbm_file);
2990 /* If there are no addresses left on the chain, they all deferred. Loop
2991 for the next set of addresses. */
2993 if (!addr) continue;
2995 /* If the transport is limited for parallellism, enforce that here.
2996 We use a hints DB entry, incremented here and decremented after
2997 the transport (and any shadow transport) completes. */
2999 if (tpt_parallel_check(tp, addr, &serialize_key))
3001 if (expand_string_message)
3003 logflags |= LOG_PANIC;
3007 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3008 } while ((addr = addr2));
3010 continue; /* Loop for the next set of addresses. */
3014 /* So, finally, we do have some addresses that can be passed to the
3015 transport. Before doing so, set up variables that are relevant to a
3018 deliver_set_expansions(addr);
3020 gettimeofday(&delivery_start, NULL);
3021 deliver_local(addr, FALSE);
3022 timesince(&deliver_time, &delivery_start);
3024 /* If a shadow transport (which must perforce be another local transport), is
3025 defined, and its condition is met, we must pass the message to the shadow
3026 too, but only those addresses that succeeded. We do this by making a new
3027 chain of addresses - also to keep the original chain uncontaminated. We must
3028 use a chain rather than doing it one by one, because the shadow transport may
3031 NOTE: if the condition fails because of a lookup defer, there is nothing we
3035 && ( !tp->shadow_condition
3036 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3039 transport_instance *stp;
3040 address_item *shadow_addr = NULL;
3041 address_item **last = &shadow_addr;
3043 for (stp = transports; stp; stp = stp->next)
3044 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3047 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3050 /* Pick off the addresses that have succeeded, and make clones. Put into
3051 the shadow_message field a pointer to the shadow_message field of the real
3054 else for (addr2 = addr; addr2; addr2 = addr2->next)
3055 if (addr2->transport_return == OK)
3057 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3060 addr3->shadow_message = US &addr2->shadow_message;
3061 addr3->transport = stp;
3062 addr3->transport_return = DEFER;
3063 addr3->return_filename = NULL;
3064 addr3->return_file = -1;
3066 last = &addr3->next;
3069 /* If we found any addresses to shadow, run the delivery, and stick any
3070 message back into the shadow_message field in the original. */
3074 int save_count = transport_count;
3076 DEBUG(D_deliver|D_transport)
3077 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3078 deliver_local(shadow_addr, TRUE);
3080 for(; shadow_addr; shadow_addr = shadow_addr->next)
3082 int sresult = shadow_addr->transport_return;
3083 *(uschar **)shadow_addr->shadow_message =
3085 ? string_sprintf(" ST=%s", stp->name)
3086 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3087 shadow_addr->basic_errno <= 0
3089 : US strerror(shadow_addr->basic_errno),
3090 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3093 shadow_addr->message
3094 ? shadow_addr->message
3095 : shadow_addr->basic_errno <= 0
3099 DEBUG(D_deliver|D_transport)
3100 debug_printf("%s shadow transport returned %s for %s\n",
3101 stp->name, rc_to_string(sresult), shadow_addr->address);
3104 DEBUG(D_deliver|D_transport)
3105 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3107 transport_count = save_count; /* Restore original transport count */
3111 /* Cancel the expansions that were set up for the delivery. */
3113 deliver_set_expansions(NULL);
3115 /* If the transport was parallelism-limited, decrement the hints DB record. */
3117 if (serialize_key) enq_end(serialize_key);
3119 /* Now we can process the results of the real transport. We must take each
3120 address off the chain first, because post_process_one() puts it on another
3123 for (addr2 = addr; addr2; addr2 = nextaddr)
3125 int result = addr2->transport_return;
3126 nextaddr = addr2->next;
3128 DEBUG(D_deliver|D_transport)
3129 debug_printf("%s transport returned %s for %s\n",
3130 tp->name, rc_to_string(result), addr2->address);
3132 /* If there is a retry_record, or if delivery is deferred, build a retry
3133 item for setting a new retry time or deleting the old retry record from
3134 the database. These items are handled all together after all addresses
3135 have been handled (so the database is open just for a short time for
3138 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3140 int flags = result == DEFER ? 0 : rf_delete;
3141 uschar * retry_key = string_copy(tp->retry_use_local_part
3142 ? addr2->address_retry_key : addr2->domain_retry_key);
3144 retry_add_item(addr2, retry_key, flags);
3147 /* Done with this address */
3149 addr2->delivery_time = deliver_time;
3150 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3152 /* If a pipe delivery generated text to be sent back, the result may be
3153 changed to FAIL, and we must copy this for subsequent addresses in the
3156 if (addr2->transport_return != result)
3158 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3160 addr3->transport_return = addr2->transport_return;
3161 addr3->basic_errno = addr2->basic_errno;
3162 addr3->message = addr2->message;
3164 result = addr2->transport_return;
3167 /* Whether or not the result was changed to FAIL, we need to copy the
3168 return_file value from the first address into all the addresses of the
3169 batch, so they are all listed in the error message. */
3171 addr2->return_file = addr->return_file;
3173 /* Change log character for recording successful deliveries. */
3175 if (result == OK) logchar = '-';
3177 } /* Loop back for next batch of addresses */
3183 /*************************************************
3184 * Sort remote deliveries *
3185 *************************************************/
3187 /* This function is called if remote_sort_domains is set. It arranges that the
3188 chain of addresses for remote deliveries is ordered according to the strings
3189 specified. Try to make this shuffling reasonably efficient by handling
3190 sequences of addresses rather than just single ones.
3197 sort_remote_deliveries(void)
3200 address_item **aptr = &addr_remote;
3201 const uschar *listptr = remote_sort_domains;
3205 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3207 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3210 address_item *moved = NULL;
3211 address_item **bptr = &moved;
3215 address_item **next;
3216 deliver_domain = (*aptr)->domain; /* set $domain */
3217 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3218 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3220 aptr = &(*aptr)->next;
3224 next = &(*aptr)->next;
3226 && (deliver_domain = (*next)->domain, /* Set $domain */
3227 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3228 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3230 next = &(*next)->next;
3232 /* If the batch of non-matchers is at the end, add on any that were
3233 extracted further up the chain, and end this iteration. Otherwise,
3234 extract them from the chain and hang on the moved chain. */
3246 aptr = &(*aptr)->next;
3249 /* If the loop ended because the final address matched, *aptr will
3250 be NULL. Add on to the end any extracted non-matching addresses. If
3251 *aptr is not NULL, the loop ended via "break" when *next is null, that
3252 is, there was a string of non-matching addresses at the end. In this
3253 case the extracted addresses have already been added on the end. */
3255 if (!*aptr) *aptr = moved;
3260 debug_printf("remote addresses after sorting:\n");
3261 for (address_item * addr = addr_remote; addr; addr = addr->next)
3262 debug_printf(" %s\n", addr->address);
3268 /*************************************************
3269 * Read from pipe for remote delivery subprocess *
3270 *************************************************/
3272 /* This function is called when the subprocess is complete, but can also be
3273 called before it is complete, in order to empty a pipe that is full (to prevent
3274 deadlock). It must therefore keep track of its progress in the parlist data
3277 We read the pipe to get the delivery status codes and a possible error message
3278 for each address, optionally preceded by unusability data for the hosts and
3279 also by optional retry data.
3281 Read in large chunks into the big buffer and then scan through, interpreting
3282 the data therein. In most cases, only a single read will be necessary. No
3283 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3284 that we read the next chunk when there is less than 2500 bytes left in the
3285 non-final chunk, we can assume each item is complete in the buffer before
3286 handling it. Each item is written using a single write(), which is atomic for
3287 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3288 often bigger) so even if we are reading while the subprocess is still going, we
3289 should never have only a partial item in the buffer.
3291 hs12: This assumption is not true anymore, since we get quite large items (certificate
3292 information and such).
3295 poffset the offset of the parlist item
3296 eop TRUE if the process has completed
3298 Returns: TRUE if the terminating 'Z' item has been read,
3299 or there has been a disaster (i.e. no more data needed);
3304 par_read_pipe(int poffset, BOOL eop)
3307 pardata *p = parlist + poffset;
3308 address_item *addrlist = p->addrlist;
3309 address_item *addr = p->addr;
3313 uschar *msg = p->msg;
3314 BOOL done = p->done;
3316 continue_hostname = NULL;
3317 continue_transport = NULL;
3319 /* Loop through all items, reading from the pipe when necessary. The pipe
3320 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3321 here, as the preceding poll() tells us, if data is available for reading.
3323 A read() on a "selected" handle should never block, but(!) it may return
3324 less data then we expected. (The buffer size we pass to read() shouldn't be
3325 understood as a "request", but as a "limit".)
3327 Each separate item is written to the pipe in a timely manner. But, especially for
3328 larger items, the read(2) may already return partial data from the write(2).
3330 The write is atomic mostly (depending on the amount written), but atomic does
3331 not imply "all or noting", it just is "not intermixed" with other writes on the
3332 same channel (pipe).
3336 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3337 (int)p->pid, eop? "ended" : "not ended yet");
3341 retry_item *r, **rp;
3342 uschar pipeheader[PIPE_HEADER_SIZE+1];
3343 uschar *id = &pipeheader[0];
3344 uschar *subid = &pipeheader[1];
3345 uschar *ptr = big_buffer;
3346 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3349 DEBUG(D_deliver) debug_printf(
3350 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3352 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3353 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3354 If we get less, we can assume the subprocess do be done and do not expect any further
3355 information from it. */
3357 if ((got = readn(fd, pipeheader, required)) != required)
3359 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3360 "from transport process %d for transport %s",
3361 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3366 pipeheader[PIPE_HEADER_SIZE] = '\0';
3368 debug_printf("got %ld bytes (pipeheader) '%c' from transport process %d\n",
3369 (long) got, *id, pid);
3372 /* If we can't decode the pipeheader, the subprocess seems to have a
3373 problem, we do not expect any furher information from it. */
3375 required = Ustrtol(pipeheader+2, &endc, 10);
3378 msg = string_sprintf("failed to read pipe "
3379 "from transport process %d for transport %s: error decoding size from header",
3380 pid, addr->transport->driver_name);
3387 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3388 (u_long)required, pid);
3390 /* Same as above, the transport process will write the bytes announced
3391 in a timely manner, so we can just wait for the bytes, getting less than expected
3392 is considered a problem of the subprocess, we do not expect anything else from it. */
3393 if ((got = readn(fd, big_buffer, required)) != required)
3395 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3396 " bytes (pipedata) from transport process %d for transport %s",
3397 got, required, pid, addr->transport->driver_name);
3402 /* Handle each possible type of item, assuming the complete item is
3403 available in store. */
3407 /* Host items exist only if any hosts were marked unusable. Match
3408 up by checking the IP address. */
3411 for (h = addrlist->host_list; h; h = h->next)
3413 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3421 /* Retry items are sent in a preceding R item for each address. This is
3422 kept separate to keep each message short enough to guarantee it won't
3423 be split in the pipe. Hopefully, in the majority of cases, there won't in
3424 fact be any retry items at all.
3426 The complete set of retry items might include an item to delete a
3427 routing retry if there was a previous routing delay. However, routing
3428 retries are also used when a remote transport identifies an address error.
3429 In that case, there may also be an "add" item for the same key. Arrange
3430 that a "delete" item is dropped in favour of an "add" item. */
3433 if (!addr) goto ADDR_MISMATCH;
3435 DEBUG(D_deliver|D_retry)
3436 debug_printf("reading retry information for %s from subprocess\n",
3439 /* Cut out any "delete" items on the list. */
3441 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3442 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3444 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3445 *rp = r->next; /* Excise a delete item */
3446 DEBUG(D_deliver|D_retry)
3447 debug_printf(" existing delete item dropped\n");
3450 /* We want to add a delete item only if there is no non-delete item;
3451 however we still have to step ptr through the data. */
3453 if (!r || !(*ptr & rf_delete))
3455 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3456 r->next = addr->retries;
3459 r->key = string_copy(ptr);
3461 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3462 ptr += sizeof(r->basic_errno);
3463 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3464 ptr += sizeof(r->more_errno);
3465 r->message = *ptr ? string_copy(ptr) : NULL;
3466 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3467 r->flags & rf_delete ? "delete" : "retry");
3472 DEBUG(D_deliver|D_retry)
3473 debug_printf(" delete item not added: non-delete item exists\n");
3476 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3482 /* Put the amount of data written into the parlist block */
3484 case 'S': /* Size */
3485 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3486 ptr += sizeof(transport_count);
3489 /* Address items are in the order of items on the address chain. We
3490 remember the current address value in case this function is called
3491 several times to empty the pipe in stages. Information about delivery
3492 over TLS is sent in a preceding X item for each address. We don't put
3493 it in with the other info, in order to keep each message short enough to
3494 guarantee it won't be split in the pipe. */
3497 case 'X': /* TLS details */
3498 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3502 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3506 addr->cipher = string_copy(ptr);
3507 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3511 addr->peerdn = string_copy(ptr);
3516 (void) tls_import_cert(ptr, &addr->peercert);
3518 addr->peercert = NULL;
3523 (void) tls_import_cert(ptr, &addr->ourcert);
3525 addr->ourcert = NULL;
3528 # ifndef DISABLE_OCSP
3530 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3536 #endif /*DISABLE_TLS*/
3538 case 'C': /* client authenticator information */
3541 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3542 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3543 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3548 #ifndef DISABLE_PRDR
3550 setflag(addr, af_prdr_used);
3557 #ifndef DISABLE_PIPE_CONNECT
3558 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3560 case 1: setflag(addr, af_pipelining); break;
3565 setflag(addr, af_chunking_used);
3569 setflag(addr, af_tcp_fastopen_conn);
3570 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3571 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3575 if (!addr) goto ADDR_MISMATCH;
3576 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3577 ptr += sizeof(addr->dsn_aware);
3578 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3581 case 'A': /* Per-address info */
3585 msg = string_sprintf("address count mismatch for data read from pipe "
3586 "for transport process %d for transport %s", pid,
3587 addrlist->transport->driver_name);
3594 #ifndef DISABLE_DKIM
3595 case '4': /* DKIM information */
3596 addr->dkim_used = string_copy(ptr);
3601 case '3': /* explicit notification of continued-connection (non)use;
3602 overrides caller's knowlege. */
3603 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3604 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3607 #ifdef SUPPORT_SOCKS
3608 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3609 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3614 proxy_local_address = string_copy(ptr);
3616 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3617 ptr += sizeof(proxy_local_port);
3622 #ifdef EXPERIMENTAL_DSN_INFO
3623 case '1': /* must arrive before A0, and applies to that addr */
3624 /* Two strings: smtp_greeting and helo_response */
3625 addr->smtp_greeting = string_copy(ptr);
3627 addr->helo_response = string_copy(ptr);
3632 case '0': /* results of trying to send to this address */
3633 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3634 addr->transport_return = *ptr++;
3635 addr->special_action = *ptr++;
3636 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3637 ptr += sizeof(addr->basic_errno);
3638 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3639 ptr += sizeof(addr->more_errno);
3640 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3641 ptr += sizeof(addr->delivery_time);
3642 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3643 ptr += sizeof(addr->flags);
3644 addr->message = *ptr ? string_copy(ptr) : NULL;
3646 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3649 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3653 h = store_get(sizeof(host_item), GET_UNTAINTED);
3654 h->name = string_copy(ptr);
3656 h->address = string_copy(ptr);
3658 memcpy(&h->port, ptr, sizeof(h->port));
3659 ptr += sizeof(h->port);
3660 h->dnssec = *ptr == '2' ? DS_YES
3661 : *ptr == '1' ? DS_NO
3664 addr->host_used = h;
3669 if (testflag(addr, af_cert_verified)) continue_flags |= CTF_CV;
3670 if (testflag(addr, af_dane_verified)) continue_flags |= CTF_DV;
3671 if (testflag(addr, af_tls_resume)) continue_flags |= CTF_TR;
3673 /* Finished with this address */
3680 /* Local interface address/port */
3682 if (*ptr) sending_ip_address = string_copy(ptr);
3684 if (*ptr) sending_port = atoi(CS ptr);
3688 /* Z0 marks the logical end of the data. It is followed by '0' if
3689 continue_transport was NULL at the end of transporting, otherwise '1'.
3690 Those are now for historical reasons only; we always clear the continued
3691 channel info, and then set it explicitly if the transport indicates it
3692 is still open, because it could differ for each transport we are running in
3695 Z1 is a suggested message_id to handle next, used during a
3696 continued-transport sequence. */
3701 case '0': /* End marker */
3703 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3705 case '1': /* Suggested continuation message */
3706 Ustrncpy(continue_next_id, ptr, MESSAGE_ID_LENGTH);
3707 continue_sequence = atoi(CS ptr + MESSAGE_ID_LENGTH + 1);
3708 DEBUG(D_deliver) debug_printf("continue_next_id: %s seq %d\n",
3709 continue_next_id, continue_sequence);
3711 case '2': /* Continued transport, host & addr */
3715 DEBUG(D_any) if (Ustrcmp(process_purpose, "continued-delivery") != 0)
3716 debug_printf("%s becomes continued-delivery\n", process_purpose);
3717 process_purpose = US"continued-delivery";
3718 continue_transport = string_copy(ptr); while (*ptr++) ;
3719 continue_hostname = string_copy(ptr); while (*ptr++) ;
3720 continue_host_address = string_copy(ptr); while (*ptr++) ;
3721 continue_sequence = atoi(CS ptr);
3723 dup2((recvd_fd = recv_fd_from_sock(fd)), 0);
3727 debug_printf("continue: tpt '%s' host '%s' addr '%s' seq %d\n",
3728 continue_transport, continue_hostname,
3729 continue_host_address, continue_sequence);
3732 case '3': /* Continued conn info */
3733 smtp_peer_options = ptr[0];
3734 f.smtp_authenticated = ptr[1] & 1;
3737 case '4': /* Continued TLS info */
3738 continue_proxy_cipher = string_copy(ptr);
3740 case '5': /* Continued DANE info */
3741 case '6': /* Continued TLS info */
3742 # ifdef SUPPORT_DANE
3743 continue_proxy_dane = *subid == '5';
3745 continue_proxy_sni = *ptr ? string_copy(ptr) : NULL;
3748 #ifndef DISABLE_ESMTP_LIMITS
3749 case '7': /* Continued peer limits */
3750 sscanf(CS ptr, "%u %u %u",
3751 &continue_limit_mail, &continue_limit_rcpt,
3752 &continue_limit_rcptdom);
3755 #ifdef SUPPORT_SOCKS
3756 case '8': /* Continued proxy info */
3757 proxy_local_address = string_copy(ptr); while (*ptr++) ;
3758 proxy_local_port = atoi(CS ptr); while (*ptr++) ;
3759 proxy_external_address = string_copy(ptr); while (*ptr++) ;
3760 proxy_external_port = atoi(CS ptr);
3766 /* Anything else is a disaster. */
3769 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3770 "process %d for transport %s", ptr[-1], pid,
3771 addr->transport->driver_name);
3777 /* The done flag is inspected externally, to determine whether or not to
3778 call the function again when the process finishes. */
3782 /* If the process hadn't finished, and we haven't seen the end of the data
3783 or if we suffered a disaster, update the rest of the state, and return FALSE to
3784 indicate "not finished". */
3793 /* Close our end of the pipe, to prevent deadlock if the far end is still
3794 pushing stuff into it. */
3799 /* If we have finished without error, but haven't had data for every address,
3800 something is wrong. */
3803 msg = string_sprintf("insufficient address data read from pipe "
3804 "for transport process %d for transport %s", pid,
3805 addr->transport->driver_name);
3807 /* If an error message is set, something has gone wrong in getting back
3808 the delivery data. Put the message into each address and freeze it. */
3811 for (addr = addrlist; addr; addr = addr->next)
3813 addr->transport_return = DEFER;
3814 addr->special_action = SPECIAL_FREEZE;
3815 addr->message = msg;
3816 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3819 /* Return TRUE to indicate we have got all we need from this process, even
3820 if it hasn't actually finished yet. */
3827 /*************************************************
3828 * Post-process a set of remote addresses *
3829 *************************************************/
3831 /* Do what has to be done immediately after a remote delivery for each set of
3832 addresses, then re-write the spool if necessary. Note that post_process_one
3833 puts the address on an appropriate queue; hence we must fish off the next
3834 one first. This function is also called if there is a problem with setting
3835 up a subprocess to do a remote delivery in parallel. In this case, the final
3836 argument contains a message, and the action must be forced to DEFER.
3839 addr pointer to chain of address items
3840 logflags flags for logging
3841 msg NULL for normal cases; -> error message for unexpected problems
3842 fallback TRUE if processing fallback hosts
3848 remote_post_process(address_item * addr, int logflags, uschar * msg,
3851 /* If any host addresses were found to be unusable, add them to the unusable
3852 tree so that subsequent deliveries don't try them. */
3854 for (host_item * h = addr->host_list; h; h = h->next)
3856 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3858 /* Now handle each address on the chain. The transport has placed '=' or '-'
3859 into the special_action field for each successful delivery. */
3863 address_item * next = addr->next;
3865 /* If msg == NULL (normal processing) and the result is DEFER and we are
3866 processing the main hosts and there are fallback hosts available, put the
3867 address on the list for fallback delivery. */
3869 if ( addr->transport_return == DEFER
3870 && addr->fallback_hosts
3875 addr->host_list = addr->fallback_hosts;
3876 addr->next = addr_fallback;
3877 addr_fallback = addr;
3878 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3881 /* If msg is set (=> unexpected problem), set it in the address before
3882 doing the ordinary post processing. */
3888 addr->message = msg;
3889 addr->transport_return = DEFER;
3891 (void)post_process_one(addr, addr->transport_return, logflags,
3892 EXIM_DTYPE_TRANSPORT, addr->special_action);
3900 /* If we have just delivered down a passed SMTP channel, and that was
3901 the last address, the channel will have been closed down. Now that
3902 we have logged that delivery, set continue_sequence to 1 so that
3903 any subsequent deliveries don't get "*" incorrectly logged. */
3905 if (!continue_transport) continue_sequence = 1;
3910 /*************************************************
3911 * Wait for one remote delivery subprocess *
3912 *************************************************/
3914 /* This function is called while doing remote deliveries when either the
3915 maximum number of processes exist and we need one to complete so that another
3916 can be created, or when waiting for the last ones to complete. It must wait for
3917 the completion of one subprocess, empty the control block slot, and return a
3918 pointer to the address chain.
3921 Returns: pointer to the chain of addresses handled by the process;
3922 NULL if no subprocess found - this is an unexpected error
3925 static address_item *
3928 int poffset, status;
3929 address_item * addr, * addrlist;
3932 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3933 "to finish", message_id);
3935 /* Loop until either a subprocess completes, or there are no subprocesses in
3936 existence - in which case give an error return. We cannot proceed just by
3937 waiting for a completion, because a subprocess may have filled up its pipe, and
3938 be waiting for it to be emptied. Therefore, if no processes have finished, we
3939 wait for one of the pipes to acquire some data by calling poll(), with a
3940 timeout just in case.
3942 The simple approach is just to iterate after reading data from a ready pipe.
3943 This leads to non-ideal behaviour when the subprocess has written its final Z
3944 item, closed the pipe, and is in the process of exiting (the common case). A
3945 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3946 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3949 To avoid this, if all the data that is needed has been read from a subprocess
3950 after poll(), an explicit wait() for it is done. We know that all it is doing
3951 is writing to the pipe and then exiting, so the wait should not be long.
3953 The non-blocking waitpid() is to some extent just insurance; if we could
3954 reliably detect end-of-file on the pipe, we could always know when to do a
3955 blocking wait() for a completed process. However, because some systems use
3956 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3957 use code that functions without the need to recognize EOF.
3959 There's a double loop here just in case we end up with a process that is not in
3960 the list of remote delivery processes. Something has obviously gone wrong if
3961 this is the case. (For example, a process that is incorrectly left over from
3962 routing or local deliveries might be found.) The damage can be minimized by
3963 looping back and looking for another process. If there aren't any, the error
3964 return will happen. */
3966 for (;;) /* Normally we do not repeat this loop */
3968 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3972 /* A return value of -1 can mean several things. If errno != ECHILD, it
3973 either means invalid options (which we discount), or that this process was
3974 interrupted by a signal. Just loop to try the waitpid() again.
3976 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3977 in existence. This should never happen, and is an unexpected error.
3978 However, there is a nasty complication when running under Linux. If "strace
3979 -f" is being used under Linux to trace this process and its children,
3980 subprocesses are "stolen" from their parents and become the children of the
3981 tracing process. A general wait such as the one we've just obeyed returns
3982 as if there are no children while subprocesses are running. Once a
3983 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3984 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3987 This does not happen using "truss" on Solaris, nor (I think) with other
3988 tracing facilities on other OS. It seems to be specific to Linux.
3990 What we do to get round this is to use kill() to see if any of our
3991 subprocesses are still in existence. If kill() gives an OK return, we know
3992 it must be for one of our processes - it can't be for a re-use of the pid,
3993 because if our process had finished, waitpid() would have found it. If any
3994 of our subprocesses are in existence, we proceed to use poll() as if
3995 waitpid() had returned zero. I think this is safe. */
3999 if (errno != ECHILD) continue; /* Repeats the waitpid() */
4002 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
4003 "for process existence\n");
4005 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4007 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
4009 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
4010 "stolen by strace\n", (int)pid);
4011 break; /* With poffset set */
4015 if (poffset >= remote_max_parallel)
4017 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
4018 return NULL; /* This is the error return */
4022 /* A pid value greater than 0 breaks the "while" loop. A negative value has
4023 been handled above. A return value of zero means that there is at least one
4024 subprocess, but there are no completed subprocesses. See if any pipes are
4025 ready with any data for reading. */
4027 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
4029 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4030 if (parlist[poffset].pid != 0)
4032 parpoll[poffset].fd = parlist[poffset].fd;
4033 parpoll[poffset].events = POLLIN;
4036 parpoll[poffset].fd = -1;
4038 /* Stick in a 60-second timeout, just in case. */
4040 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
4042 /* Scan through the pipes and read any that are ready; use the count
4043 returned by poll() to stop when there are no more. Select() can return
4044 with no processes (e.g. if interrupted). This shouldn't matter.
4046 If par_read_pipe() returns TRUE, it means that either the terminating Z was
4047 read, or there was a disaster. In either case, we are finished with this
4048 process. Do an explicit wait() for the process and break the main loop if
4051 It turns out that we have to deal with the case of an interrupted system
4052 call, which can happen on some operating systems if the signal handling is
4053 set up to do that by default. */
4056 readycount > 0 && poffset < remote_max_parallel;
4059 if ( (pid = parlist[poffset].pid) != 0
4060 && parpoll[poffset].revents
4064 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4065 for (;;) /* Loop for signals */
4067 pid_t endedpid = waitpid(pid, &status, 0);
4068 if (endedpid == pid) goto PROCESS_DONE;
4069 if (endedpid != (pid_t)(-1) || errno != EINTR)
4070 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4071 "%d (errno = %d) from waitpid() for process %d",
4072 (int)endedpid, errno, (int)pid);
4077 /* Now go back and look for a completed subprocess again. */
4080 /* A completed process was detected by the non-blocking waitpid(). Find the
4081 data block that corresponds to this subprocess. */
4083 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4084 if (pid == parlist[poffset].pid) break;
4086 /* Found the data block; this is a known remote delivery process. We don't
4087 need to repeat the outer loop. This should be what normally happens. */
4089 if (poffset < remote_max_parallel) break;
4091 /* This situation is an error, but it's probably better to carry on looking
4092 for another process than to give up (as we used to do). */
4094 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4095 "transport process list", pid);
4096 } /* End of the "for" loop */
4098 /* Come here when all the data was completely read after a poll(), and
4099 the process in pid has been wait()ed for. */
4106 debug_printf("remote delivery process %d ended\n", (int)pid);
4108 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4112 set_process_info("delivering %s", message_id);
4114 /* Get the chain of processed addresses */
4116 addrlist = parlist[poffset].addrlist;
4118 /* If the process did not finish cleanly, record an error and freeze (except
4119 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4120 in case the delivery did actually happen. */
4122 if ((status & 0xffff) != 0)
4125 int msb = (status >> 8) & 255;
4126 int lsb = status & 255;
4127 int code = (msb == 0)? (lsb & 0x7f) : msb;
4129 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4131 addrlist->transport->driver_name,
4133 msb == 0 ? "terminated by signal" : "exit code",
4136 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4137 addrlist->special_action = SPECIAL_FREEZE;
4139 for (addr = addrlist; addr; addr = addr->next)
4141 addr->transport_return = DEFER;
4142 addr->message = msg;
4145 remove_journal = FALSE;
4148 /* Else complete reading the pipe to get the result of the delivery, if all
4149 the data has not yet been obtained. */
4151 else if (!parlist[poffset].done)
4152 (void) par_read_pipe(poffset, TRUE);
4154 /* Put the data count and return path into globals, mark the data slot unused,
4155 decrement the count of subprocesses, and return the address chain. */
4157 transport_count = parlist[poffset].transport_count;
4158 used_return_path = parlist[poffset].return_path;
4159 parlist[poffset].pid = 0;
4166 /*************************************************
4167 * Wait for subprocesses and post-process *
4168 *************************************************/
4170 /* This function waits for subprocesses until the number that are still running
4171 is below a given threshold. For each complete subprocess, the addresses are
4172 post-processed. If we can't find a running process, there is some shambles.
4173 Better not bomb out, as that might lead to multiple copies of the message. Just
4174 log and proceed as if all done.
4177 max maximum number of subprocesses to leave running
4178 fallback TRUE if processing fallback hosts
4184 par_reduce(int max, BOOL fallback)
4186 while (parcount > max)
4188 address_item * doneaddr = par_wait();
4191 log_write(0, LOG_MAIN|LOG_PANIC,
4192 "remote delivery process count got out of step");
4197 transport_instance * tp = doneaddr->transport;
4198 if (tp->max_parallel)
4199 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4201 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4207 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4209 uschar pipe_header[PIPE_HEADER_SIZE+1];
4210 size_t total_len = PIPE_HEADER_SIZE + size;
4212 struct iovec iov[2] = {
4213 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4214 { buf, size } /* *the* data */
4219 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4220 /* complain to log if someone tries with buffer sizes we can't handle*/
4222 if (size > BIG_BUFFER_SIZE-1)
4224 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4225 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4227 size = BIG_BUFFER_SIZE;
4230 /* Should we check that we do not write more than PIPE_BUF? What would
4233 /* convert size to human readable string prepended by id and subid */
4234 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4235 id, subid, (long)size))
4236 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4238 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4239 id, subid, (long)size, pipe_header);
4241 if ((ret = writev(fd, iov, 2)) != total_len)
4242 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4243 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4244 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4247 /*************************************************
4248 * Do remote deliveries *
4249 *************************************************/
4251 /* This function is called to process the addresses in addr_remote. We must
4252 pick off the queue all addresses that have the same transport, remote
4253 destination, and errors address, and hand them to the transport in one go,
4254 subject to some configured limitations. If this is a run to continue delivering
4255 to an existing delivery channel, skip all but those addresses that can go to
4256 that channel. The skipped addresses just get deferred.
4258 If mua_wrapper is set, all addresses must be able to be sent in a single
4259 transaction. If not, this function yields FALSE.
4261 In Exim 4, remote deliveries are always done in separate processes, even
4262 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4263 is so that the base process can retain privilege. This makes the
4264 implementation of fallback transports feasible (though not initially done.)
4266 We create up to the configured number of subprocesses, each of which passes
4267 back the delivery state via a pipe. (However, when sending down an existing
4268 connection, remote_max_parallel is forced to 1.)
4271 fallback TRUE if processing fallback hosts
4273 Returns: TRUE normally
4274 FALSE if mua_wrapper is set and the addresses cannot all be sent
4279 do_remote_deliveries(BOOL fallback)
4284 parcount = 0; /* Number of executing subprocesses */
4286 /* When sending down an existing channel, only do one delivery at a time.
4287 We use a local variable (parmax) to hold the maximum number of processes;
4288 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4290 if (continue_transport) remote_max_parallel = 1;
4291 parmax = remote_max_parallel;
4293 /* If the data for keeping a list of processes hasn't yet been
4298 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4299 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4300 parlist[poffset].pid = 0;
4301 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4304 /* Now loop for each remote delivery */
4306 for (int delivery_count = 0; addr_remote; delivery_count++)
4312 int address_count = 1;
4313 int address_count_max;
4315 BOOL use_initgroups;
4316 BOOL pipe_done = FALSE;
4317 transport_instance *tp;
4318 address_item **anchor = &addr_remote;
4319 address_item *addr = addr_remote;
4320 address_item *last = addr;
4323 uschar * serialize_key = NULL;
4325 /* Pull the first address right off the list. */
4327 addr_remote = addr->next;
4330 DEBUG(D_deliver|D_transport)
4331 debug_printf("--------> %s <--------\n", addr->address);
4333 /* If no transport has been set, there has been a big screw-up somewhere. */
4335 if (!(tp = addr->transport))
4337 f.disable_logging = FALSE; /* Jic */
4338 panicmsg = US"No transport set by router";
4339 goto panic_continue;
4342 /* Check that this base address hasn't previously been delivered to this
4343 transport. The check is necessary at this point to handle homonymic addresses
4344 correctly in cases where the pattern of redirection changes between delivery
4345 attempts. Non-homonymic previous delivery is detected earlier, at routing
4348 if (previously_transported(addr, FALSE)) continue;
4350 /* Force failure if the message is too big. */
4352 if (tp->message_size_limit)
4354 int rc = check_message_size(tp, addr);
4357 addr->transport_return = rc;
4358 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4363 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4364 So look out for the place it gets used.
4367 /* Get the flag which specifies whether the transport can handle different
4368 domains that nevertheless resolve to the same set of hosts. If it needs
4369 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4370 $host, $host_address, $host_port. */
4371 if (tp->expand_multi_domain)
4372 deliver_set_expansions(addr);
4374 if (exp_bool(addr, US"transport", tp->name, D_transport,
4375 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4376 &multi_domain) != OK)
4378 deliver_set_expansions(NULL);
4379 panicmsg = addr->message;
4380 goto panic_continue;
4383 /* Get the maximum it can handle in one envelope, with zero meaning
4384 unlimited, which is forced for the MUA wrapper case and if the
4385 value could vary depending on the messages.
4386 For those, we only split (below) by (tpt,dest,erraddr,hdrs) and rely on the
4387 transport splitting further by max_rcp. So we potentially lose some
4390 GET_OPTION("max_rcpt");
4391 address_count_max = mua_wrapper || Ustrchr(tp->max_addresses, '$')
4392 ? UNLIMITED_ADDRS : expand_max_rcpt(tp->max_addresses);
4395 /************************************************************************/
4396 /***** This is slightly experimental code, but should be safe. *****/
4398 /* The address_count_max value is the maximum number of addresses that the
4399 transport can send in one envelope. However, the transport must be capable of
4400 dealing with any number of addresses. If the number it gets exceeds its
4401 envelope limitation, it must send multiple copies of the message. This can be
4402 done over a single connection for SMTP, so uses less resources than making
4403 multiple connections. On the other hand, if remote_max_parallel is greater
4404 than one, it is perhaps a good idea to use parallel processing to move the
4405 message faster, even if that results in multiple simultaneous connections to
4408 How can we come to some compromise between these two ideals? What we do is to
4409 limit the number of addresses passed to a single instance of a transport to
4410 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4411 number of addresses routed to remote transports divided by
4412 remote_max_parallel. For example, if the message has 100 remote recipients,
4413 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4414 once. But if rcpt_max is 100, we could send up to 100.
4416 Of course, not all the remotely addresses in a message are going to go to the
4417 same set of hosts (except in smarthost configurations), so this is just a
4418 heuristic way of dividing up the work.
4420 Furthermore (1), because this may not be wanted in some cases, and also to
4421 cope with really pathological cases, there is also a limit to the number of
4422 messages that are sent over one connection. This is the same limit that is
4423 used when sending several different messages over the same connection.
4424 Continue_sequence is set when in this situation, to the number sent so
4425 far, including this message.
4427 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4428 is probably because they are using VERP, in which case they want to pass only
4429 one address at a time to the transport, in order to be able to use
4430 $local_part and $domain in constructing a new return path. We could test for
4431 the use of these variables, but as it is so likely they will be used when the
4432 maximum is 1, we don't bother. Just leave the value alone. */
4434 if ( address_count_max != 1
4435 && address_count_max < remote_delivery_count/remote_max_parallel
4438 int new_max = remote_delivery_count/remote_max_parallel, message_max;
4439 GET_OPTION("connection_max_messages");
4440 message_max = tp->connection_max_messages;
4441 if (connection_max_messages >= 0) message_max = connection_max_messages;
4442 message_max -= continue_sequence - 1;
4443 if (message_max > 0 && new_max > address_count_max * message_max)
4444 new_max = address_count_max * message_max;
4445 address_count_max = new_max;
4448 /************************************************************************/
4451 /*XXX don't know yet if DANE will be used. So tpt will have to
4452 check at the point if gets next addr from list, and skip/defer any
4456 /* Pick off all addresses which have the same transport, errors address,
4457 destination, and extra headers. In some cases they point to the same host
4458 list, but we also need to check for identical host lists generated from
4459 entirely different domains. The host list pointers can be NULL in the case
4460 where the hosts are defined in the transport. There is also a configured
4461 maximum limit of addresses that can be handled at once (see comments above
4462 for how it is computed).
4463 If the transport does not handle multiple domains, enforce that also,
4464 and if it might need a per-address check for this, re-evaluate it.
4467 while ((next = *anchor) && address_count < address_count_max)
4470 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4471 && tp == next->transport
4472 && same_hosts(next->host_list, addr->host_list)
4473 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4474 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4475 && same_ugid(tp, next, addr)
4476 && ( next->prop.remove_headers == addr->prop.remove_headers
4477 || ( next->prop.remove_headers
4478 && addr->prop.remove_headers
4479 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4483 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4485 US"transport", next->transport->name, D_transport,
4486 US"multi_domain", next->transport->multi_domain,
4487 next->transport->expand_multi_domain, &md) == OK
4492 *anchor = next->next;
4494 next->first = addr; /* remember top one (for retry processing) */
4499 else anchor = &(next->next);
4500 deliver_set_expansions(NULL);
4503 /* If we are acting as an MUA wrapper, all addresses must go in a single
4504 transaction. If not, put them back on the chain and yield FALSE. */
4506 if (mua_wrapper && addr_remote)
4508 last->next = addr_remote;
4513 /* If the transport is limited for parallellism, enforce that here.
4514 The hints DB entry is decremented in par_reduce(), when we reap the
4515 transport process. */
4517 if (tpt_parallel_check(tp, addr, &serialize_key))
4518 if ((panicmsg = expand_string_message))
4519 goto panic_continue;
4521 continue; /* Loop for the next set of addresses. */
4523 /* Set up the expansion variables for this set of addresses */
4525 deliver_set_expansions(addr);
4527 /* Ensure any transport-set auth info is fresh */
4528 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4530 /* Compute the return path, expanding a new one if required. The old one
4531 must be set first, as it might be referred to in the expansion. */
4533 return_path = addr->prop.errors_address
4534 ? addr->prop.errors_address : sender_address;
4536 GET_OPTION("return_path");
4537 if (tp->return_path)
4539 uschar * new_return_path = expand_string(tp->return_path);
4540 if (new_return_path)
4541 return_path = new_return_path;
4542 else if (!f.expand_string_forcedfail)
4544 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4545 tp->return_path, expand_string_message);
4550 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4551 logs and sets up error messages, so we just post-process and continue with
4552 the next address. */
4554 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4560 /* If this transport has a setup function, call it now so that it gets
4561 run in this process and not in any subprocess. That way, the results of
4562 any setup that are retained by the transport can be reusable. One of the
4563 things the setup does is to set the fallback host lists in the addresses.
4564 That is why it is called at this point, before the continue delivery
4565 processing, because that might use the fallback hosts. */
4568 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4570 /* If we have a connection still open from a verify stage (lazy-close)
4571 treat it as if it is a continued connection (apart from the counter used
4572 for the log line mark). */
4574 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4577 debug_printf("lazy-callout-close: have conn still open from verification\n");
4578 continue_transport = cutthrough.transport;
4579 continue_hostname = string_copy(cutthrough.host.name);
4580 continue_host_address = string_copy(cutthrough.host.address);
4581 continue_sequence = 1;
4582 sending_ip_address = cutthrough.snd_ip;
4583 sending_port = cutthrough.snd_port;
4584 smtp_peer_options = cutthrough.peer_options;
4587 /* If this is a run to continue delivery down an already-established
4588 channel, check that this set of addresses matches the transport and
4589 the channel. If it does not, defer the addresses. If a host list exists,
4590 we must check that the continue host is on the list. Otherwise, the
4591 host is set in the transport. */
4593 f.continue_more = FALSE; /* In case got set for the last lot */
4594 if (continue_transport)
4596 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4597 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4599 /* If the transport is about to override the host list do not check
4600 it here but take the cost of running the transport process to discover
4601 if the continued_hostname connection is suitable. This is a layering
4602 violation which is unfortunate as it requires we haul in the smtp
4607 smtp_transport_options_block * ob;
4609 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4610 && (ob = (smtp_transport_options_block *)tp->options_block)
4611 && ob->hosts_override && ob->hosts
4617 for (host_item * h = addr->host_list; h; h = h->next)
4618 if (Ustrcmp(h->name, continue_hostname) == 0)
4619 /*XXX should also check port here */
4620 { ok = TRUE; break; }
4624 /* Addresses not suitable; defer or queue for fallback hosts (which
4625 might be the continue host) and skip to next address. */
4629 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4630 Ustrcmp(continue_transport, tp->name) != 0
4631 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4632 : string_sprintf("no host matching %s", continue_hostname));
4633 if (serialize_key) enq_end(serialize_key);
4635 if (addr->fallback_hosts && !fallback)
4637 for (next = addr; ; next = next->next)
4639 next->host_list = next->fallback_hosts;
4640 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4641 if (!next->next) break;
4643 next->next = addr_fallback;
4644 addr_fallback = addr;
4649 for (next = addr; ; next = next->next)
4651 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4652 if (!next->next) break;
4654 next->next = addr_defer;
4662 /* Once we hit the max number of parallel transports set a flag indicating
4663 whether there are further addresses that list the same host. This tells the
4664 transport to leave the channel open for us. */
4665 /*XXX maybe we should *count* possible further's, and set continue_more if
4666 parmax * tpt-max is exceeded? */
4668 if (parcount+1 >= remote_max_parallel)
4670 host_item * h1 = addr->host_list;
4673 const uschar * name = continue_hostname ? continue_hostname : h1->name;
4674 for (next = addr_remote; next && !f.continue_more; next = next->next)
4675 for (host_item * h = next->host_list; h; h = h->next)
4676 if (Ustrcmp(h->name, name) == 0)
4677 { f.continue_more = TRUE; break; }
4680 else DEBUG(D_deliver)
4682 "not reached parallelism limit (%d/%d) so not setting continue_more\n",
4683 parcount+1, remote_max_parallel);
4685 /* The transports set up the process info themselves as they may connect
4686 to more than one remote machine. They also have to set up the filter
4687 arguments, if required, so that the host name and address are available
4690 transport_filter_argv = NULL;
4692 /* Create the pipe for inter-process communication. If pipe creation
4693 fails, it is probably because the value of remote_max_parallel is so
4694 large that too many file descriptors for pipes have been created. Arrange
4695 to wait for a process to finish, and then try again. If we still can't
4696 create a pipe when all processes have finished, break the retry loop.
4697 Use socketpair() rather than pipe() so we can pass an fd back from the
4703 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) == 0) pipe_done = TRUE;
4704 else if (parcount > 0) parmax = parcount;
4707 /* We need to make the reading end of the pipe non-blocking. There are
4708 two different options for this. Exim is cunningly (I hope!) coded so
4709 that it can use either of them, though it prefers O_NONBLOCK, which
4710 distinguishes between EOF and no-more-data. */
4712 /* The data appears in a timely manner and we already did a poll on
4713 all pipes, so I do not see a reason to use non-blocking IO here
4716 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4718 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4722 /* If the maximum number of subprocesses already exist, wait for a process
4723 to finish. If we ran out of file descriptors, parmax will have been reduced
4724 from its initial value of remote_max_parallel. */
4726 par_reduce(parmax - 1, fallback);
4729 /* If we failed to create a pipe and there were no processes to wait
4730 for, we have to give up on this one. Do this outside the above loop
4731 so that we can continue the main loop. */
4735 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4739 /* Find a free slot in the pardata list. Must do this after the possible
4740 waiting for processes to finish, because a terminating process will free
4743 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4744 if (parlist[poffset].pid == 0)
4747 /* If there isn't one, there has been a horrible disaster. */
4749 if (poffset >= remote_max_parallel)
4751 (void)close(pfd[pipe_write]);
4752 (void)close(pfd[pipe_read]);
4753 panicmsg = US"Unexpectedly no free subprocess slot";
4757 /* Now fork a subprocess to do the remote delivery, but before doing so,
4758 ensure that any cached resources are released so as not to interfere with
4759 what happens in the subprocess. */
4764 A continued-tpt will, in the tpt parent here, call par_reduce for
4765 the one child. But we are hoping to never do continued-transport...
4766 SO.... we may have called par_reduce for a single child, above when we'd
4767 hit the limit on child-count. Possibly multiple times with different
4768 transports and target hosts. Does it matter if several return a suggested
4769 next-id, and we lose all but the last? Hmm. Less parallel working would
4770 happen. Perhaps still do continued-tpt once one has been set? No, that won't
4773 Could take the initial continued-tpt hit, and then do the next-id thing?
4775 do_remote_deliveries par_reduce par_wait par_read_pipe
4778 /*XXX what about firsttime? */
4779 if (continue_transport && !exim_lockfile_needed())
4780 if (!continue_wait_db)
4782 continue_wait_db = dbfn_open_multi(
4783 string_sprintf("wait-%.200s", continue_transport),
4785 (open_db *) store_get(sizeof(open_db), GET_UNTAINTED));
4786 continue_next_id[0] = '\0';
4789 if ((pid = exim_fork(US"transport")) == 0)
4791 int fd = pfd[pipe_write];
4794 /* Setting these globals in the subprocess means we need never clear them */
4796 transport_name = tp->name;
4797 if (addr->router) router_name = addr->router->name;
4798 driver_srcfile = tp->srcfile;
4799 driver_srcline = tp->srcline;
4801 /* There are weird circumstances in which logging is disabled */
4802 f.disable_logging = tp->disable_logging;
4804 /* Show pids on debug output if parallelism possible */
4806 if (parmax > 1 && (parcount > 0 || addr_remote))
4807 DEBUG(D_any|D_v) debug_selector |= D_pid;
4809 /* Reset the random number generator, so different processes don't all
4810 have the same sequence. In the test harness we want different, but
4811 predictable settings for each delivery process, so do something explicit
4812 here rather they rely on the fixed reset in the random number function. */
4814 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4816 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4817 a new process that may be forked to do another delivery down the same
4820 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4822 /* Close open file descriptors for the pipes of other processes
4823 that are running in parallel. */
4825 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4826 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4828 /* This process has inherited a copy of the file descriptor
4829 for the data file, but its file pointer is shared with all the
4830 other processes running in parallel. Therefore, we have to re-open
4831 the file in order to get a new file descriptor with its own
4832 file pointer. We don't need to lock it, as the lock is held by
4833 the parent process. There doesn't seem to be any way of doing
4834 a dup-with-new-file-pointer. */
4836 (void)close(deliver_datafile);
4838 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4840 if ( (deliver_datafile = Uopen(fname, EXIM_CLOEXEC | O_RDWR | O_APPEND, 0))
4842 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4843 "parallel delivery: %s", fname, strerror(errno));
4846 #ifndef O_CLOEXEC /* Set the close-on-exec flag */
4847 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4851 /* Set the uid/gid of this process; bombs out on failure. */
4853 exim_setugid(uid, gid, use_initgroups,
4854 string_sprintf("remote delivery to %s with transport=%s",
4855 addr->address, tp->name));
4857 /* Close the unwanted half of this process' pipe, set the process state,
4858 and run the transport. Afterwards, transport_count will contain the number
4859 of bytes written. */
4861 (void)close(pfd[pipe_read]);
4862 set_process_info("delivering %s using %s", message_id, tp->name);
4863 debug_print_string(tp->debug_string);
4864 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4866 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4867 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4869 /* Ensure any cached resources that we used are now released */
4873 /* Pass the result back down the pipe. This is a lot more information
4874 than is needed for a local delivery. We have to send back the error
4875 status for each address, the usability status for each host that is
4876 flagged as unusable, and all the retry items. When TLS is in use, we
4877 send also the cipher and peerdn information. Each type of information
4878 is flagged by an identifying byte, and is then in a fixed format (with
4879 strings terminated by zeros), and there is a final terminator at the
4880 end. The host information and retry information is all attached to
4881 the first address, so that gets sent at the start.
4884 A C D H I K L P R S T X Z
4887 /* Host unusability information: for most success cases this will
4890 for (h = addr->host_list; h; h = h->next)
4892 if (!h->address || h->status < hstatus_unusable) continue;
4893 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4894 rmt_dlv_checked_write(fd, 'H','0', big_buffer, Ustrlen(big_buffer+2) + 3);
4897 /* The number of bytes written. This is the same for each address. Even
4898 if we sent several copies of the message down the same connection, the
4899 size of each one is the same, and it's that value we have got because
4900 transport_count gets reset before calling transport_write_message(). */
4902 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4903 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4905 /* Information about what happened to each address. Four item types are
4906 used: an optional 'X' item first, for TLS information, then an optional "C"
4907 item for any client-auth info followed by 'R' items for any retry settings,
4908 and finally an 'A' item for the remaining data. The actual recipient address
4909 is not sent but is implicit in the address-chain being handled. */
4911 for(; addr; addr = addr->next)
4915 /* The certificate verification status goes into the flags, in A0 */
4916 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4918 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4920 #ifndef DISABLE_TLS_RESUME
4921 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4924 /* Use an X item only if there's something to send */
4928 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4932 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4934 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4936 else if (continue_proxy_cipher)
4938 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4940 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4946 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4950 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4955 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4959 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4961 # ifndef DISABLE_OCSP
4962 if (addr->ocsp > OCSP_NOT_REQ)
4964 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4965 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4968 #endif /*DISABLE_TLS*/
4970 if (client_authenticator)
4972 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4973 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4975 if (client_authenticated_id)
4977 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4978 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4980 if (client_authenticated_sender)
4982 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4983 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4986 #ifndef DISABLE_PRDR
4987 if (testflag(addr, af_prdr_used))
4988 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4991 if (testflag(addr, af_pipelining))
4992 #ifndef DISABLE_PIPE_CONNECT
4993 if (testflag(addr, af_early_pipe))
4994 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4997 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4999 if (testflag(addr, af_chunking_used))
5000 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
5002 if (testflag(addr, af_tcp_fastopen_conn))
5003 rmt_dlv_checked_write(fd, 'T',
5004 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
5008 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
5009 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
5011 /* Retry information: for most success cases this will be null. */
5013 for (retry_item * r = addr->retries; r; r = r->next)
5015 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
5016 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
5017 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
5018 ptr += sizeof(r->basic_errno);
5019 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
5020 ptr += sizeof(r->more_errno);
5021 if (!r->message) *ptr++ = 0; else
5023 sprintf(CS ptr, "%.512s", r->message);
5026 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
5029 #ifndef DISABLE_DKIM
5030 if (addr->dkim_used && LOGGING(dkim_verbose))
5032 DEBUG(D_deliver) debug_printf("dkim used: %s\n", addr->dkim_used);
5033 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->dkim_used) + 1;
5034 rmt_dlv_checked_write(fd, 'A', '4', big_buffer, ptr - big_buffer);
5038 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
5040 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
5041 testflag(addr, af_new_conn) ? "non-" : "");
5042 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
5043 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
5046 #ifdef SUPPORT_SOCKS
5047 if (LOGGING(proxy) && proxy_session)
5050 if (proxy_local_address)
5052 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
5053 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
5054 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
5055 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
5056 ptr += sizeof(proxy_local_port);
5060 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
5064 #ifdef EXPERIMENTAL_DSN_INFO
5065 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
5066 if (addr->smtp_greeting)
5068 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
5069 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
5070 if (addr->helo_response)
5072 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
5073 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
5077 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
5081 /* The rest of the information goes in an 'A0' item. */
5084 debug_printf("%s %s for MAIL\n",
5085 addr->special_action == '=' ? "initial RCPT"
5086 : addr->special_action == '-' ? "additional RCPT" : "?",
5089 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
5090 ptr = big_buffer + 2;
5091 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
5092 ptr += sizeof(addr->basic_errno);
5093 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
5094 ptr += sizeof(addr->more_errno);
5095 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
5096 ptr += sizeof(addr->delivery_time);
5097 memcpy(ptr, &addr->flags, sizeof(addr->flags));
5098 ptr += sizeof(addr->flags);
5100 if (!addr->message) *ptr++ = 0; else
5101 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
5103 if (!addr->user_message) *ptr++ = 0; else
5104 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
5106 if (!addr->host_used) *ptr++ = 0; else
5108 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
5109 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
5110 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
5111 ptr += sizeof(addr->host_used->port);
5113 /* DNS lookup status */
5114 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
5115 : addr->host_used->dnssec==DS_NO ? '1' : '0';
5118 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
5121 /* Local interface address/port */
5122 #ifdef EXPERIMENTAL_DSN_INFO
5123 if (sending_ip_address)
5125 if (LOGGING(incoming_interface) && sending_ip_address)
5128 uschar * ptr = big_buffer
5129 + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
5130 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
5131 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
5134 /* Continuation message-id, if a continuation is for that reason,
5135 and the next sequence number (MAIL FROM count) for the connection. */
5137 if (*continue_next_id)
5138 rmt_dlv_checked_write(fd, 'Z', '1', big_buffer,
5139 sprintf(CS big_buffer, "%.*s %u",
5140 MESSAGE_ID_LENGTH, continue_next_id, continue_sequence+1) + 1);
5142 /* Connection details, only on the first suggested continuation for
5143 wait-db ones, but for all continue-more ones (though any after the
5144 delivery proc has the info are pointless). */
5146 if (continue_hostname)
5149 uschar * ptr = big_buffer;
5150 ptr += sprintf(CS ptr, "%.128s", continue_transport) + 1;
5151 ptr += sprintf(CS ptr, "%.128s", continue_hostname) + 1;
5152 ptr += sprintf(CS ptr, "%.128s", continue_host_address) + 1;
5153 ptr += sprintf(CS ptr, "%u", continue_sequence+1) + 1;
5154 rmt_dlv_checked_write(fd, 'Z', '2', big_buffer, ptr - big_buffer);
5155 send_fd_over_socket(fd, continue_fd);
5158 big_buffer[0] = smtp_peer_options;
5159 big_buffer[1] = f.smtp_authenticated ? 1 : 0;
5160 rmt_dlv_checked_write(fd, 'Z', '3', big_buffer, 2);
5162 if (tls_out.active.sock >= 0 || continue_proxy_cipher)
5163 rmt_dlv_checked_write(fd, 'Z', '4', big_buffer,
5164 sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1);
5167 rmt_dlv_checked_write(fd, 'Z',
5169 tls_out.dane_verified ? '5' : '6',
5173 tls_out.sni, Ustrlen(tls_out.sni)+1);
5175 #ifndef DISABLE_ESMTP_LIMITS
5176 if (continue_limit_mail || continue_limit_rcpt || continue_limit_rcptdom)
5177 rmt_dlv_checked_write(fd, 'Z', '7', big_buffer,
5178 sprintf(CS big_buffer, "%u %u %u",
5179 continue_limit_mail, continue_limit_rcpt,
5180 continue_limit_rcptdom) + 1);
5183 #ifdef SUPPORT_SOCKS
5186 uschar * ptr = big_buffer;
5187 ptr += sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
5188 ptr += sprintf(CS ptr, "%u", proxy_local_port) + 1;
5189 ptr += sprintf(CS ptr, "%.128s", proxy_external_address) + 1;
5190 ptr += sprintf(CS ptr, "%u", proxy_external_port) + 1;
5191 rmt_dlv_checked_write(fd, 'Z', '8', big_buffer, ptr - big_buffer);
5196 /* Add termination flag, close the pipe, and that's it. The character
5197 after "Z0" indicates whether continue_transport is now NULL or not.
5198 A change from non-NULL to NULL indicates a problem with a continuing
5201 big_buffer[0] = continue_transport ? '1' : '0';
5202 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5204 exim_exit(EXIT_SUCCESS);
5207 /* Back in the mainline: close the unwanted half of the pipe. */
5209 (void)close(pfd[pipe_write]);
5211 /* If we have a connection still open from a verify stage (lazy-close)
5212 release its TLS library context (if any) as responsibility was passed to
5213 the delivery child process. */
5215 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5218 if (cutthrough.is_tls)
5219 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5221 (void) close(cutthrough.cctx.sock);
5222 release_cutthrough_connection(US"passed to transport proc");
5225 /* Fork failed; defer with error message */
5229 (void)close(pfd[pipe_read]);
5230 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5231 addr->domain, strerror(errno));
5235 /* Fork succeeded; increment the count, and remember relevant data for
5236 when the process finishes. */
5239 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5240 parlist[poffset].pid = pid;
5241 parlist[poffset].fd = pfd[pipe_read];
5242 parlist[poffset].done = FALSE;
5243 parlist[poffset].msg = NULL;
5244 parlist[poffset].return_path = return_path;
5246 /* If the process we've just started is sending a message down an existing
5247 channel, wait for it now. This ensures that only one such process runs at
5248 once, whatever the value of remote_max parallel. Otherwise, we might try to
5249 send two or more messages simultaneously down the same channel. This could
5250 happen if there are different domains that include the same host in otherwise
5251 different host lists.
5253 Also, if the transport closes down the channel, this information gets back
5254 (continue_transport gets set to NULL) before we consider any other addresses
5257 if (continue_transport)
5259 par_reduce(0, fallback);
5260 if (!continue_next_id && continue_wait_db)
5261 { dbfn_close_multi(continue_wait_db); continue_wait_db = NULL; }
5264 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5265 newly created process get going before we create another process. This should
5266 ensure repeatability in the tests. Wait long enough for most cases to complete
5270 testharness_pause_ms(600);
5275 if (serialize_key) enq_end(serialize_key);
5277 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5281 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5282 are still running and post-process their addresses. */
5284 par_reduce(0, fallback);
5291 /*************************************************
5292 * Split an address into local part and domain *
5293 *************************************************/
5295 /* This function initializes an address for routing by splitting it up into a
5296 local part and a domain. The local part is set up twice - once in its original
5297 casing, and once in lower case, and it is dequoted. We also do the "percent
5298 hack" for configured domains. This may lead to a DEFER result if a lookup
5299 defers. When a percent-hacking takes place, we insert a copy of the original
5300 address as a new parent of this address, as if we have had a redirection.
5303 addr points to an addr_item block containing the address
5306 DEFER - could not determine if domain is %-hackable
5310 deliver_split_address(address_item * addr)
5312 const uschar * address = addr->address;
5317 if (!(domain = Ustrrchr(address, '@')))
5318 return DEFER; /* should always have a domain, but just in case... */
5320 len = domain - address;
5321 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5323 /* The implication in the RFCs (though I can't say I've seen it spelled out
5324 explicitly) is that quoting should be removed from local parts at the point
5325 where they are locally interpreted. [The new draft "821" is more explicit on
5326 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5327 removing quoting backslashes and any unquoted doublequotes. */
5329 addr->cc_local_part = t = store_get(len+1, address);
5333 if (c == '\"') continue;
5343 /* We do the percent hack only for those domains that are listed in
5344 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5346 if (percent_hack_domains)
5349 uschar * new_address = NULL;
5350 const uschar * local_part = addr->cc_local_part;
5352 deliver_domain = addr->domain; /* set $domain */
5354 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5355 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5357 && (t = Ustrrchr(local_part, '%')) != NULL
5360 new_address = string_copy(local_part);
5361 new_address[t - local_part] = '@';
5362 deliver_domain = string_copylc(t+1);
5363 local_part = string_copyn(local_part, t - local_part);
5366 if (rc == DEFER) return DEFER; /* lookup deferred */
5368 /* If hackery happened, set up new parent and alter the current address. */
5372 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5373 *new_parent = *addr;
5374 addr->parent = new_parent;
5375 new_parent->child_count = 1;
5376 addr->address = new_address;
5377 addr->unique = string_copy(new_address);
5378 addr->domain = deliver_domain;
5379 addr->cc_local_part = local_part;
5380 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5385 /* Create the lowercased version of the final local part, and make that the
5386 default one to be used. */
5388 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5395 /*************************************************
5396 * Get next error message text *
5397 *************************************************/
5399 /* If f is not NULL, read the next "paragraph", from a customized error message
5400 text file, terminated by a line containing ****, and expand it.
5403 f NULL or a file to read from
5404 which string indicating which string (for errors)
5406 Returns: NULL or an expanded string
5410 next_emf(FILE *f, uschar *which)
5416 if (!f) return NULL;
5418 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5421 para = string_get(256);
5424 para = string_cat(para, buffer);
5425 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5428 if ((yield = expand_string(string_from_gstring(para))))
5431 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5432 "bounce_message_file or warn_message_file (%s): %s", which,
5433 expand_string_message);
5440 /*************************************************
5441 * Close down a passed transport channel *
5442 *************************************************/
5444 /* This function is called when a passed transport channel cannot be used.
5445 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5446 so that the function call can be the argument of a "return" statement.
5449 Returns: DELIVER_NOT_ATTEMPTED
5453 continue_closedown(void)
5455 if (continue_transport)
5456 for (transport_instance * t = transports; t; t = t->next)
5457 if (Ustrcmp(t->name, continue_transport) == 0)
5459 if (t->info->closedown) (t->info->closedown)(t);
5460 continue_transport = NULL;
5463 return DELIVER_NOT_ATTEMPTED;
5469 /*************************************************
5470 * Print address information *
5471 *************************************************/
5473 /* This function is called to output an address, or information about an
5474 address, for bounce or defer messages. If the hide_child flag is set, all we
5475 output is the original ancestor address.
5478 addr points to the address
5479 f the FILE to print to
5480 si an initial string
5481 sc a continuation string for before "generated"
5484 Returns: TRUE if the address is not hidden
5488 print_address_information(address_item * addr, FILE * f, uschar * si,
5489 uschar * sc, uschar * se)
5492 const uschar * printed = US"";
5493 address_item * ancestor = addr;
5494 while (ancestor->parent) ancestor = ancestor->parent;
5496 fprintf(f, "%s", CS si);
5498 if (addr->parent && testflag(addr, af_hide_child))
5500 printed = US"an undisclosed address";
5503 else if (!testflag(addr, af_pfr) || !addr->parent)
5504 printed = addr->address;
5508 const uschar * s = addr->address;
5511 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5512 else if (addr->address[0] == '|') ss = US"pipe";
5515 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5516 printed = addr->parent->address;
5519 fprintf(f, "%s", CS string_printing(printed));
5521 if (ancestor != addr)
5523 const uschar * original = ancestor->onetime_parent;
5524 if (!original) original= ancestor->address;
5525 if (strcmpic(original, printed) != 0)
5526 fprintf(f, "%s(%sgenerated from %s)", sc,
5527 ancestor != addr->parent ? "ultimately " : "",
5528 string_printing(original));
5531 if (addr->host_used)
5532 fprintf(f, "\n host %s [%s]",
5533 addr->host_used->name, addr->host_used->address);
5535 fprintf(f, "%s", CS se);
5543 /*************************************************
5544 * Print error for an address *
5545 *************************************************/
5547 /* This function is called to print the error information out of an address for
5548 a bounce or a warning message. It tries to format the message reasonably by
5549 introducing newlines. All lines are indented by 4; the initial printing
5550 position must be set before calling.
5552 This function used always to print the error. Nowadays we want to restrict it
5553 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5554 and filter "fail". We no longer pass other information willy-nilly in bounce
5555 and warning messages. Text in user_message is always output; text in message
5556 only if the af_pass_message flag is set.
5560 f the FILE to print on
5567 print_address_error(address_item * addr, FILE * f, const uschar * t)
5569 int count = Ustrlen(t);
5570 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5572 if (!s && !(s = addr->user_message))
5575 fprintf(f, "\n %s", t);
5578 if (*s == '\\' && s[1] == 'n')
5588 if (*s++ == ':' && isspace(*s) && count > 45)
5590 fprintf(f, "\n "); /* sic (because space follows) */
5593 else if (count > 254) /* arbitrary limit */
5595 fprintf(f, "[truncated]");
5596 do s++; while (*s && !(*s == '\\' && s[1] == '\n'));
5602 /***********************************************************
5603 * Print Diagnostic-Code for an address *
5604 ************************************************************/
5606 /* This function is called to print the error information out of an address for
5607 a bounce or a warning message. It tries to format the message reasonably as
5608 required by RFC 3461 by adding a space after each newline
5610 it uses the same logic as print_address_error() above. if af_pass_message is true
5611 and addr->message is set it uses the remote host answer. if not addr->user_message
5612 is used instead if available.
5616 f the FILE to print on
5622 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5624 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5627 /* af_pass_message and addr->message set ? print remote host answer */
5632 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5634 /* search first ": ". we assume to find the remote-MTA answer there */
5635 if (!(s = Ustrstr(addr->message, ": ")))
5636 return; /* not found, bail out */
5638 s += 2; /* skip ": " */
5639 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5643 if (cnt > 950) /* RFC line length limit: 998 */
5645 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5646 fputs("[truncated]", f);
5650 if (*s == '\\' && s[1] == 'n')
5652 fputs("\n ", f); /* as defined in RFC 3461 */
5667 /*************************************************
5668 * Check list of addresses for duplication *
5669 *************************************************/
5671 /* This function was introduced when the test for duplicate addresses that are
5672 not pipes, files, or autoreplies was moved from the middle of routing to when
5673 routing was complete. That was to fix obscure cases when the routing history
5674 affects the subsequent routing of identical addresses. This function is called
5675 after routing, to check that the final routed addresses are not duplicates.
5677 If we detect a duplicate, we remember what it is a duplicate of. Note that
5678 pipe, file, and autoreply de-duplication is handled during routing, so we must
5679 leave such "addresses" alone here, as otherwise they will incorrectly be
5682 Argument: address of list anchor
5687 do_duplicate_check(address_item ** anchor)
5689 address_item * addr;
5690 while ((addr = *anchor))
5693 if (testflag(addr, af_pfr))
5694 anchor = &addr->next;
5695 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5697 DEBUG(D_deliver|D_route)
5698 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5699 *anchor = addr->next;
5700 addr->dupof = tnode->data.ptr;
5701 addr->next = addr_duplicate;
5702 addr_duplicate = addr;
5706 tree_add_duplicate(addr->unique, addr);
5707 anchor = &addr->next;
5715 /************************************************/
5718 print_dsn_addr_action(FILE * f, address_item * addr,
5719 uschar * action, uschar * status)
5723 if (addr->dsn_orcpt)
5724 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5726 for (pa = addr; pa->parent; ) pa = pa->parent;
5727 fprintf(f, "Action: %s\n"
5728 "Final-Recipient: rfc822;%s\n"
5730 action, pa->address, status);
5735 /* When running in the test harness, there's an option that allows us to
5736 fudge this time so as to get repeatability of the tests. Take the first
5737 time off the list. In queue runs, the list pointer gets updated in the
5741 test_harness_fudged_queue_time(int actual_time)
5744 if ( f.running_in_test_harness && *fudged_queue_times
5745 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5747 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5748 fudged_queue_times);
5754 /************************************************/
5757 expand_open(const uschar * filename,
5758 const uschar * optname, const uschar * reason)
5760 const uschar * s = expand_cstring(filename);
5764 log_write(0, LOG_MAIN|LOG_PANIC,
5765 "Failed to expand %s: '%s'\n", optname, filename);
5766 else if (*s != '/' || is_tainted(s))
5767 log_write(0, LOG_MAIN|LOG_PANIC,
5768 "%s is not %s after expansion: '%s'\n",
5769 optname, *s == '/' ? "untainted" : "absolute", s);
5770 else if (!(fp = Ufopen(s, "rb")))
5771 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5772 "message texts: %s", s, reason, strerror(errno));
5777 /* Output the given header and string, converting either
5778 the sequence "\n" or a real newline into newline plus space.
5779 If that still takes us past column 78, look for the last space
5780 and split there too.
5781 Append a newline if string did not have one.
5782 Limit to about 1024 chars total. */
5785 dsn_put_wrapped(FILE * fp, const uschar * header, const uschar * s)
5787 gstring * g = string_cat(NULL, header);
5789 g = string_cat(g, s);
5790 gstring_release_unused(g);
5791 fprintf(fp, "%s\n", wrap_header(string_from_gstring(g), 79, 1023, US" ", 1));
5797 /*************************************************
5798 * Send a bounce message *
5799 *************************************************/
5801 /* Find the error address for the first address, then send a message that
5802 includes all failed addresses that have the same error address. Note the
5803 bounce_recipient is a global so that it can be accessed by $bounce_recipient
5804 while creating a customized error message. */
5807 send_bounce_message(time_t now, const uschar * logtod)
5812 if (!(bounce_recipient = addr_failed->prop.errors_address))
5813 bounce_recipient = sender_address;
5815 /* Make a subprocess to send a message, using its stdin */
5817 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
5818 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5819 "create child process to send failure message: %s", getpid(),
5820 getppid(), strerror(errno));
5822 /* Creation of child succeeded */
5826 int ch, rc, filecount = 0, rcount = 0;
5827 uschar * bcc, * emf_text;
5828 FILE * fp = fdopen(fd, "wb"), * emf = NULL;
5829 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5830 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5831 DELIVER_IN_BUFFER_SIZE;
5832 uschar * bound, * dsnlimitmsg, * dsnnotifyhdr;
5834 address_item ** paddr;
5835 address_item * msgchain = NULL, ** pmsgchain = &msgchain;
5836 address_item * handled_addr = NULL;
5839 debug_printf("sending error message to: %s\n", bounce_recipient);
5841 /* Scan the addresses for all that have the same errors address, removing
5842 them from the addr_failed chain, and putting them on msgchain. */
5844 paddr = &addr_failed;
5845 for (address_item * addr = addr_failed; addr; addr = *paddr)
5846 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
5847 ? addr->prop.errors_address : sender_address) == 0)
5848 { /* The same - dechain */
5849 *paddr = addr->next;
5852 pmsgchain = &addr->next;
5855 paddr = &addr->next; /* Not the same; skip */
5857 /* Include X-Failed-Recipients: for automatic interpretation, but do
5858 not let any one header line get too long. We do this by starting a
5859 new header every 50 recipients. Omit any addresses for which the
5860 "hide_child" flag is set. */
5862 for (address_item * addr = msgchain; addr; addr = addr->next)
5864 if (testflag(addr, af_hide_child)) continue;
5872 ? "X-Failed-Recipients: "
5874 testflag(addr, af_pfr) && addr->parent
5875 ? string_printing(addr->parent->address)
5876 : string_printing(addr->address));
5878 if (rcount > 0) fprintf(fp, "\n");
5880 /* Output the standard headers */
5882 if (errors_reply_to)
5883 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
5884 fprintf(fp, "Auto-Submitted: auto-replied\n");
5885 moan_write_from(fp);
5886 fprintf(fp, "To: %s\n", bounce_recipient);
5887 moan_write_references(fp, NULL);
5889 /* generate boundary string and output MIME-Headers */
5890 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
5892 fprintf(fp, "Content-Type: multipart/report;"
5893 " report-type=delivery-status; boundary=%s\n"
5894 "MIME-Version: 1.0\n",
5897 /* Open a template file if one is provided. Log failure to open, but
5898 carry on - default texts will be used. */
5900 GET_OPTION("bounce_message_file");
5901 if (bounce_message_file)
5902 emf = expand_open(bounce_message_file,
5903 US"bounce_message_file", US"error");
5905 /* Quietly copy to configured additional addresses if required. */
5907 if ((bcc = moan_check_errorcopy(bounce_recipient)))
5908 fprintf(fp, "Bcc: %s\n", bcc);
5910 /* The texts for the message can be read from a template file; if there
5911 isn't one, or if it is too short, built-in texts are used. The first
5912 emf text is a Subject: and any other headers. */
5914 if ((emf_text = next_emf(emf, US"header")))
5915 fprintf(fp, "%s\n", emf_text);
5917 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
5918 to_sender? ": returning message to sender" : "");
5920 /* output human readable part as text/plain section */
5921 fprintf(fp, "--%s\n"
5922 "Content-type: text/plain; charset=us-ascii\n\n",
5925 if ((emf_text = next_emf(emf, US"intro")))
5926 fprintf(fp, "%s", CS emf_text);
5930 /* This message has been reworded several times. It seems to be confusing to
5931 somebody, however it is worded. I have retreated to the original, simple
5933 "This message was created automatically by mail delivery software.\n");
5935 if (bounce_message_text)
5936 fprintf(fp, "%s", CS bounce_message_text);
5939 "\nA message that you sent could not be delivered to one or more of its\n"
5940 "recipients. This is a permanent error. The following address(es) failed:\n");
5943 "\nA message sent by\n\n <%s>\n\n"
5944 "could not be delivered to one or more of its recipients. The following\n"
5945 "address(es) failed:\n", sender_address);
5949 /* Process the addresses, leaving them on the msgchain if they have a
5950 file name for a return message. (There has already been a check in
5951 post_process_one() for the existence of data in the message file.) A TRUE
5952 return from print_address_information() means that the address is not
5956 for (address_item * addr = msgchain; addr; addr = *paddr)
5958 if (print_address_information(addr, fp, US" ", US"\n ", US""))
5959 print_address_error(addr, fp, US"");
5961 /* End the final line for the address */
5965 /* Leave on msgchain if there's a return file. */
5967 if (addr->return_file >= 0)
5969 paddr = &addr->next;
5973 /* Else save so that we can tick off the recipient when the
5978 *paddr = addr->next;
5979 addr->next = handled_addr;
5980 handled_addr = addr;
5986 /* Get the next text, whether we need it or not, so as to be
5987 positioned for the one after. */
5989 emf_text = next_emf(emf, US"generated text");
5991 /* If there were any file messages passed by the local transports,
5992 include them in the message. Then put the address on the handled chain.
5993 In the case of a batch of addresses that were all sent to the same
5994 transport, the return_file field in all of them will contain the same
5995 fd, and the return_filename field in the *last* one will be set (to the
5996 name of the file). */
6000 address_item * nextaddr;
6003 fprintf(fp, "%s", CS emf_text);
6006 "The following text was generated during the delivery "
6007 "attempt%s:\n", (filecount > 1)? "s" : "");
6009 for (address_item * addr = msgchain; addr; addr = nextaddr)
6012 address_item *topaddr = addr;
6014 /* List all the addresses that relate to this file */
6017 while(addr) /* Insurance */
6019 print_address_information(addr, fp, US"------ ", US"\n ",
6021 if (addr->return_filename) break;
6026 /* Now copy the file */
6028 if (!(fm = Ufopen(addr->return_filename, "rb")))
6029 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
6033 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
6036 Uunlink(addr->return_filename);
6038 /* Can now add to handled chain, first fishing off the next
6039 address on the msgchain. */
6041 nextaddr = addr->next;
6042 addr->next = handled_addr;
6043 handled_addr = topaddr;
6048 /* output machine readable part */
6050 if (message_smtputf8)
6051 fprintf(fp, "--%s\n"
6052 "Content-type: message/global-delivery-status\n\n"
6053 "Reporting-MTA: dns; %s\n",
6054 bound, smtp_active_hostname);
6057 fprintf(fp, "--%s\n"
6058 "Content-type: message/delivery-status\n\n"
6059 "Reporting-MTA: dns; %s\n",
6060 bound, smtp_active_hostname);
6064 /* must be decoded from xtext: see RFC 3461:6.3a */
6065 uschar * xdec_envid;
6066 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6067 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
6069 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6073 for (address_item * addr = handled_addr; addr; addr = addr->next)
6076 #ifdef EXPERIMENTAL_DSN_INFO
6080 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
6082 if ((hu = addr->host_used) && hu->name)
6084 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
6085 #ifdef EXPERIMENTAL_DSN_INFO
6088 uschar * p = hu->port == 25
6089 ? US"" : string_sprintf(":%d", hu->port);
6090 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
6092 if ((s = addr->smtp_greeting) && *s)
6093 dsn_put_wrapped(fp, US"X-Remote-MTA-smtp-greeting: X-str; ", s);
6094 if ((s = addr->helo_response) && *s)
6095 dsn_put_wrapped(fp, US"X-Remote-MTA-helo-response: X-str; ", s);
6096 if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
6097 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
6099 print_dsn_diagnostic_code(addr, fp);
6101 #ifdef EXPERIMENTAL_DSN_INFO
6102 else if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
6103 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
6108 /* Now copy the message, trying to give an intelligible comment if
6109 it is too long for it all to be copied. The limit isn't strictly
6110 applied because of the buffering. There is, however, an option
6111 to suppress copying altogether. */
6113 emf_text = next_emf(emf, US"copy");
6116 we ignore the intro text from template and add
6117 the text for bounce_return_size_limit at the end.
6119 bounce_return_message is ignored
6120 in case RET= is defined we honor these values
6121 otherwise bounce_return_body is honored.
6123 bounce_return_size_limit is always honored.
6126 fprintf(fp, "--%s\n", bound);
6128 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
6129 dsnnotifyhdr = NULL;
6130 topt = topt_add_return_path;
6132 /* RET=HDRS? top priority */
6133 if (dsn_ret == dsn_ret_hdrs)
6134 topt |= topt_no_body;
6137 struct stat statbuf;
6139 /* no full body return at all? */
6140 if (!bounce_return_body)
6142 topt |= topt_no_body;
6143 /* add header if we overrule RET=FULL */
6144 if (dsn_ret == dsn_ret_full)
6145 dsnnotifyhdr = dsnlimitmsg;
6147 /* line length limited... return headers only if oversize */
6148 /* size limited ... return headers only if limit reached */
6149 else if ( max_received_linelength > bounce_return_linesize_limit
6150 || ( bounce_return_size_limit > 0
6151 && fstat(deliver_datafile, &statbuf) == 0
6152 && statbuf.st_size > max
6155 topt |= topt_no_body;
6156 dsnnotifyhdr = dsnlimitmsg;
6161 if (message_smtputf8)
6162 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
6163 : "Content-type: message/global\n\n",
6167 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
6168 : "Content-type: message/rfc822\n\n",
6172 transport_filter_argv = NULL; /* Just in case */
6173 return_path = sender_address; /* In case not previously set */
6174 { /* Dummy transport for headers add */
6175 transport_ctx tctx = {{0}};
6176 transport_instance tb = {0};
6178 tctx.u.fd = fileno(fp);
6180 tctx.options = topt | topt_truncate_headers;
6181 tb.add_headers = dsnnotifyhdr;
6183 /*XXX no checking for failure! buggy! */
6184 transport_write_message(&tctx, 0);
6188 /* we never add the final text. close the file */
6192 fprintf(fp, "\n--%s--\n", bound);
6194 /* Close the file, which should send an EOF to the child process
6195 that is receiving the message. Wait for it to finish. */
6198 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6200 /* If the process failed, there was some disaster in setting up the
6201 error message. Unless the message is very old, ensure that addr_defer
6202 is non-null, which will have the effect of leaving the message on the
6203 spool. The failed addresses will get tried again next time. However, we
6204 don't really want this to happen too often, so freeze the message unless
6205 there are some genuine deferred addresses to try. To do this we have
6206 to call spool_write_header() here, because with no genuine deferred
6207 addresses the normal code below doesn't get run. */
6212 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
6214 addr_defer = (address_item *)(+1);
6215 f.deliver_freeze = TRUE;
6216 deliver_frozen_at = time(NULL);
6217 /* Panic-dies on error */
6218 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6221 deliver_msglog("Process failed (%d) when writing error message "
6222 "to %s%s", rc, bounce_recipient, s);
6223 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6224 "to %s%s", rc, bounce_recipient, s);
6227 /* The message succeeded. Ensure that the recipients that failed are
6228 now marked finished with on the spool and their parents updated. */
6232 for (address_item * addr = handled_addr; addr; addr = addr->next)
6234 address_done(addr, logtod);
6235 child_done(addr, logtod);
6237 /* Panic-dies on error */
6238 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6243 /*************************************************
6244 * Send a warning message *
6245 *************************************************/
6246 /* Return: boolean success */
6249 send_warning_message(const uschar * recipients, int queue_time, int show_time)
6252 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
6253 FILE * wmf = NULL, * f = fdopen(fd, "wb");
6254 uschar * wmf_text, * bound;
6255 transport_ctx tctx = {{0}};
6258 if (pid <= 0) return FALSE;
6260 GET_OPTION("warn_message_file");
6261 if (warn_message_file)
6262 wmf = expand_open(warn_message_file,
6263 US"warn_message_file", US"warning");
6265 warnmsg_recipients = recipients;
6266 warnmsg_delay = queue_time < 120*60
6267 ? string_sprintf("%d minutes", show_time/60)
6268 : string_sprintf("%d hours", show_time/3600);
6270 if (errors_reply_to)
6271 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6272 fprintf(f, "Auto-Submitted: auto-replied\n");
6274 fprintf(f, "To: %s\n", recipients);
6275 moan_write_references(f, NULL);
6277 /* generated boundary string and output MIME-Headers */
6278 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6280 fprintf(f, "Content-Type: multipart/report;"
6281 " report-type=delivery-status; boundary=%s\n"
6282 "MIME-Version: 1.0\n",
6285 if ((wmf_text = next_emf(wmf, US"header")))
6286 fprintf(f, "%s\n", wmf_text);
6288 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6289 message_id, warnmsg_delay);
6291 /* output human readable part as text/plain section */
6293 "Content-type: text/plain; charset=us-ascii\n\n",
6296 if ((wmf_text = next_emf(wmf, US"intro")))
6297 fprintf(f, "%s", CS wmf_text);
6301 "This message was created automatically by mail delivery software.\n");
6303 if (Ustrcmp(recipients, sender_address) == 0)
6305 "A message that you sent has not yet been delivered to one or more of its\n"
6306 "recipients after more than ");
6310 "A message sent by\n\n <%s>\n\n"
6311 "has not yet been delivered to one or more of its recipients after more than \n",
6314 fprintf(f, "%s on the queue on %s.\n\n"
6315 "The message identifier is: %s\n",
6316 warnmsg_delay, primary_hostname, message_id);
6318 for (header_line * h = header_list; h; h = h->next)
6319 if (strncmpic(h->text, US"Subject:", 8) == 0)
6320 fprintf(f, "The subject of the message is: %s", h->text + 9);
6321 else if (strncmpic(h->text, US"Date:", 5) == 0)
6322 fprintf(f, "The date of the message is: %s", h->text + 6);
6325 fprintf(f, "The address%s to which the message has not yet been "
6327 !addr_defer->next ? "" : "es",
6328 !addr_defer->next ? "is": "are");
6331 /* List the addresses, with error information if allowed */
6334 for (address_item * addr = addr_defer; addr; addr = addr->next)
6336 if (print_address_information(addr, f, US" ", US"\n ", US""))
6337 print_address_error(addr, f, US"Delay reason: ");
6346 if ((wmf_text = next_emf(wmf, US"final")))
6347 fprintf(f, "%s", CS wmf_text);
6353 "No action is required on your part. Delivery attempts will continue for\n"
6354 "some time, and this warning may be repeated at intervals if the message\n"
6355 "remains undelivered. Eventually the mail delivery software will give up,\n"
6356 "and when that happens, the message will be returned to you.\n");
6359 /* output machine readable part */
6360 fprintf(f, "\n--%s\n"
6361 "Content-type: message/delivery-status\n\n"
6362 "Reporting-MTA: dns; %s\n",
6364 smtp_active_hostname);
6369 /* must be decoded from xtext: see RFC 3461:6.3a */
6371 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6372 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6374 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6378 for (address_item * addr = addr_defer; addr; addr = addr->next)
6382 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
6384 if ((hu = addr->host_used) && hu->name)
6386 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
6387 print_dsn_diagnostic_code(addr, f);
6393 "Content-type: text/rfc822-headers\n\n",
6397 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6398 tctx.u.fd = fileno(f);
6399 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6400 transport_filter_argv = NULL; /* Just in case */
6401 return_path = sender_address; /* In case not previously set */
6403 /* Write the original email out */
6404 /*XXX no checking for failure! buggy! */
6405 transport_write_message(&tctx, 0);
6408 fprintf(f,"\n--%s--\n", bound);
6412 /* Close and wait for child process to complete, without a timeout.
6413 If there's an error, don't update the count. */
6416 return child_close(pid, 0) == 0;
6419 /*************************************************
6420 * Send a success-DSN *
6421 *************************************************/
6424 maybe_send_dsn(const address_item * const addr_succeed)
6426 address_item * addr_senddsn = NULL;
6428 for (const address_item * a = addr_succeed; a; a = a->next)
6430 /* af_ignore_error not honored here. it's not an error */
6431 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
6432 "DSN: processing successful delivery address: %s\n"
6433 "DSN: Sender_address: %s\n"
6434 "DSN: orcpt: %s flags: 0x%x\n"
6435 "DSN: envid: %s ret: %d\n"
6436 "DSN: Final recipient: %s\n"
6437 "DSN: Remote SMTP server supports DSN: %d\n",
6438 a->router ? a->router->name : US"(unknown)",
6441 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
6443 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
6448 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6449 and a report was requested */
6451 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
6452 && a->dsn_flags & rf_notify_success
6455 /* copy and relink address_item and send report with all of them at once later */
6456 address_item * addr_next = addr_senddsn;
6457 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
6459 addr_senddsn->next = addr_next;
6462 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6466 { /* create exim process to send message */
6468 pid_t pid = child_open_exim(&fd, US"DSN");
6470 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6472 if (pid < 0) /* Creation of child failed */
6474 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6475 "create child process to send success-dsn message: %s", getpid(),
6476 getppid(), strerror(errno));
6478 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6480 else /* Creation of child succeeded */
6482 FILE * f = fdopen(fd, "wb");
6483 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6485 transport_ctx tctx = {{0}};
6488 debug_printf("sending success-dsn to: %s\n", sender_address);
6490 /* build unique id for MIME boundary */
6491 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6492 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6494 if (errors_reply_to)
6495 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6498 fprintf(f, "Auto-Submitted: auto-generated\n"
6500 "Subject: Delivery Status Notification\n",
6502 moan_write_references(f, NULL);
6503 fprintf(f, "Content-Type: multipart/report;"
6504 " report-type=delivery-status; boundary=%s\n"
6505 "MIME-Version: 1.0\n\n"
6508 "Content-type: text/plain; charset=us-ascii\n\n"
6510 "This message was created automatically by mail delivery software.\n"
6511 " ----- The following addresses had successful delivery notifications -----\n",
6514 for (address_item * a = addr_senddsn; a; a = a->next)
6515 fprintf(f, "<%s> (relayed %s)\n\n",
6517 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
6518 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
6519 : "via non \"Remote SMTP\" router"
6523 "Content-type: message/delivery-status\n\n"
6524 "Reporting-MTA: dns; %s\n",
6525 bound, smtp_active_hostname);
6528 { /* must be decoded from xtext: see RFC 3461:6.3a */
6529 uschar * xdec_envid;
6530 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6531 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6533 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6537 for (address_item * a = addr_senddsn; a; a = a->next)
6541 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
6543 if ((hu = a->host_used) && hu->name)
6544 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6547 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6548 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
6551 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6554 transport_filter_argv = NULL; /* Just in case */
6555 return_path = sender_address; /* In case not previously set */
6557 /* Write the original email out */
6560 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6561 /*XXX hmm, FALSE(fail) retval ignored.
6562 Could error for any number of reasons, and they are not handled. */
6563 transport_write_message(&tctx, 0);
6566 fprintf(f,"\n--%s--\n", bound);
6570 (void) child_close(pid, 0); /* Waits for child to close, no timeout */
6575 /*************************************************
6576 * Deliver one message *
6577 *************************************************/
6579 /* This is the function which is called when a message is to be delivered. It
6580 is passed the id of the message. It is possible that the message no longer
6581 exists, if some other process has delivered it, and it is also possible that
6582 the message is being worked on by another process, in which case the data file
6585 If no delivery is attempted for any of the above reasons, the function returns
6586 DELIVER_NOT_ATTEMPTED.
6588 If the give_up flag is set true, do not attempt any deliveries, but instead
6589 fail all outstanding addresses and return the message to the sender (or
6592 A delivery operation has a process all to itself; we never deliver more than
6593 one message in the same process. Therefore we needn't worry too much about
6596 Liable to be called as root.
6599 id the id of the message to be delivered
6600 forced TRUE if delivery was forced by an administrator; this overrides
6601 retry delays and causes a delivery to be tried regardless
6602 give_up TRUE if an administrator has requested that delivery attempts
6605 Returns: When the global variable mua_wrapper is FALSE:
6606 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
6607 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
6608 When the global variable mua_wrapper is TRUE:
6609 DELIVER_MUA_SUCCEEDED if delivery succeeded
6610 DELIVER_MUA_FAILED if delivery failed
6611 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
6615 deliver_message(const uschar * id, BOOL forced, BOOL give_up)
6617 int i, rc, final_yield, process_recipients;
6619 address_item * addr_last;
6620 uschar * filter_message, * info;
6621 open_db dbblock, * dbm_file;
6622 extern int acl_where;
6625 final_yield = DELIVER_ATTEMPTED_NORMAL;
6628 filter_message = NULL;
6629 process_recipients = RECIP_ACCEPT;
6631 #ifdef MEASURE_TIMING
6632 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
6635 info = queue_run_pid == (pid_t)0
6636 ? string_sprintf("delivering %s", id)
6637 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
6639 /* If the D_process_info bit is on, set_process_info() will output debugging
6640 information. If not, we want to show this initial information if D_deliver or
6641 D_queue_run is set or in verbose mode. */
6643 set_process_info("%s", info);
6645 if ( !(debug_selector & D_process_info)
6646 && (debug_selector & (D_deliver|D_queue_run|D_v))
6648 debug_printf("%s\n", info);
6650 /* Ensure that we catch any subprocesses that are created. Although Exim
6651 sets SIG_DFL as its initial default, some routes through the code end up
6652 here with it set to SIG_IGN - cases where a non-synchronous delivery process
6653 has been forked, but no re-exec has been done. We use sigaction rather than
6654 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
6655 sure it is turned off. (There was a problem on AIX with this.) */
6659 struct sigaction act;
6660 act.sa_handler = SIG_DFL;
6661 sigemptyset(&(act.sa_mask));
6663 sigaction(SIGCHLD, &act, NULL);
6666 signal(SIGCHLD, SIG_DFL);
6669 /* Make the forcing flag available for routers and transports, set up the
6670 global message id field, and initialize the count for returned files and the
6671 message size. This use of strcpy() is OK because the length id is checked when
6672 it is obtained from a command line (the -M or -q options), and otherwise it is
6673 known to be a valid message id. */
6675 if (id != message_id)
6676 Ustrcpy(message_id, id);
6677 f.deliver_force = forced;
6681 /* Initialize some flags */
6683 update_spool = FALSE;
6684 remove_journal = TRUE;
6686 /* Set a known context for any ACLs we call via expansions */
6687 acl_where = ACL_WHERE_DELIVERY;
6689 /* Reset the random number generator, so that if several delivery processes are
6690 started from a queue runner that has already used random numbers (for sorting),
6691 they don't all get the same sequence. */
6695 /* Open and lock the message's data file. Exim locks on this one because the
6696 header file may get replaced as it is re-written during the delivery process.
6697 Any failures cause messages to be written to the log, except for missing files
6698 while queue running - another process probably completed delivery. As part of
6699 opening the data file, message_subdir gets set. */
6701 if ((deliver_datafile = spool_open_datafile(id)) < 0)
6702 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6704 /* The value of message_size at this point has been set to the data length,
6705 plus one for the blank line that notionally precedes the data. */
6707 /* Now read the contents of the header file, which will set up the headers in
6708 store, and also the list of recipients and the tree of non-recipients and
6709 assorted flags. It updates message_size. If there is a reading or format error,
6710 give up; if the message has been around for sufficiently long, remove it. */
6713 uschar * spoolname = string_sprintf("%s-H", id);
6714 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
6716 if (errno == ERRNO_SPOOLFORMAT)
6718 struct stat statbuf;
6719 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
6721 log_write(0, LOG_MAIN, "Format error in spool file %s: "
6722 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
6724 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
6727 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
6730 /* If we managed to read the envelope data, received_time contains the
6731 time the message was received. Otherwise, we can calculate it from the
6734 if (rc != spool_read_hdrerror)
6736 received_time.tv_sec = received_time.tv_usec = 0;
6737 /*III subsec precision?*/
6738 for (i = 0; i < MESSAGE_ID_TIME_LEN; i++)
6739 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
6742 /* If we've had this malformed message too long, sling it. */
6744 if (now - received_time.tv_sec > keep_malformed)
6746 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
6747 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
6748 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
6749 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
6750 log_write(0, LOG_MAIN, "Message removed because older than %s",
6751 readconf_printtime(keep_malformed));
6754 (void)close(deliver_datafile);
6755 deliver_datafile = -1;
6756 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6760 /* The spool header file has been read. Look to see if there is an existing
6761 journal file for this message. If there is, it means that a previous delivery
6762 attempt crashed (program or host) before it could update the spool header file.
6763 Read the list of delivered addresses from the journal and add them to the
6764 nonrecipients tree. Then update the spool file. We can leave the journal in
6765 existence, as it will get further successful deliveries added to it in this
6766 run, and it will be deleted if this function gets to its end successfully.
6767 Otherwise it might be needed again. */
6770 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6773 if ( (journal_fd = Uopen(fname,
6774 O_RDWR|O_APPEND | EXIM_CLOEXEC | EXIM_NOFOLLOW, SPOOL_MODE)) >= 0
6775 && lseek(journal_fd, 0, SEEK_SET) == 0
6776 && (jread = fdopen(journal_fd, "rb"))
6779 while (Ufgets(big_buffer, big_buffer_size, jread))
6781 int n = Ustrlen(big_buffer);
6782 big_buffer[n-1] = 0;
6783 tree_add_nonrecipient(big_buffer);
6784 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
6785 "journal file\n", big_buffer);
6788 if ((journal_fd = dup(fileno(jread))) < 0)
6789 journal_fd = fileno(jread);
6791 (void) fclose(jread); /* Try to not leak the FILE resource */
6793 /* Panic-dies on error */
6794 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6796 else if (errno != ENOENT)
6798 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
6799 "%s", strerror(errno));
6800 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6803 /* A null recipients list indicates some kind of disaster. */
6805 if (!recipients_list)
6807 (void)close(deliver_datafile);
6808 deliver_datafile = -1;
6809 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
6810 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6815 /* Handle a message that is frozen. There are a number of different things that
6816 can happen, but in the default situation, unless forced, no delivery is
6819 if (f.deliver_freeze)
6821 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6822 /* Moving to another directory removes the message from Exim's view. Other
6823 tools must be used to deal with it. Logging of this action happens in
6824 spool_move_message() and its subfunctions. */
6826 if ( move_frozen_messages
6827 && spool_move_message(id, message_subdir, US"", US"F")
6829 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6832 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
6833 maximum time to keep messages that are frozen. Thaw if we reach it, with a
6834 flag causing all recipients to be failed. The time is the age of the
6835 message, not the time since freezing. */
6837 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
6839 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
6840 process_recipients = RECIP_FAIL_TIMEOUT;
6843 /* For bounce messages (and others with no sender), thaw if the error message
6844 ignore timer is exceeded. The message will be discarded if this delivery
6847 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
6848 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
6850 /* If this is a bounce message, or there's no auto thaw, or we haven't
6851 reached the auto thaw time yet, and this delivery is not forced by an admin
6852 user, do not attempt delivery of this message. Note that forced is set for
6853 continuing messages down the same channel, in order to skip load checking and
6854 ignore hold domains, but we don't want unfreezing in that case. */
6858 if ( ( sender_address[0] == 0
6860 || now <= deliver_frozen_at + auto_thaw
6862 && ( !forced || !f.deliver_force_thaw
6863 || !f.admin_user || continue_hostname
6866 (void)close(deliver_datafile);
6867 deliver_datafile = -1;
6868 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
6869 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6872 /* If delivery was forced (by an admin user), assume a manual thaw.
6873 Otherwise it's an auto thaw. */
6877 f.deliver_manual_thaw = TRUE;
6878 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
6880 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
6883 /* We get here if any of the rules for unfreezing have triggered. */
6885 f.deliver_freeze = FALSE;
6886 update_spool = TRUE;
6890 /* Open the message log file if we are using them. This records details of
6891 deliveries, deferments, and failures for the benefit of the mail administrator.
6892 The log is not used by exim itself to track the progress of a message; that is
6893 done by rewriting the header spool file. */
6897 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
6901 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
6903 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
6904 fname, strerror(errno));
6905 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6908 /* Make a stdio stream out of it. */
6910 if (!(message_log = fdopen(fd, "a")))
6912 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
6913 fname, strerror(errno));
6914 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6919 /* If asked to give up on a message, log who did it, and set the action for all
6924 struct passwd *pw = getpwuid(real_uid);
6925 log_write(0, LOG_MAIN, "cancelled by %s",
6926 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
6927 process_recipients = RECIP_FAIL;
6930 /* Otherwise, if there are too many Received: headers, fail all recipients. */
6932 else if (received_count > received_headers_max)
6933 process_recipients = RECIP_FAIL_LOOP;
6935 /* Otherwise, if a system-wide, address-independent message filter is
6936 specified, run it now, except in the case when we are failing all recipients as
6937 a result of timeout_frozen_after. If the system filter yields "delivered", then
6938 ignore the true recipients of the message. Failure of the filter file is
6939 logged, and the delivery attempt fails. */
6941 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
6946 redirect_block redirect;
6948 if (system_filter_uid_set)
6950 ugid.uid = system_filter_uid;
6951 ugid.gid = system_filter_gid;
6952 ugid.uid_set = ugid.gid_set = TRUE;
6955 ugid.uid_set = ugid.gid_set = FALSE;
6957 return_path = sender_address;
6958 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
6959 f.system_filtering = TRUE;
6961 /* Any error in the filter file causes a delivery to be abandoned. */
6963 GET_OPTION("system_filter");
6964 redirect.string = system_filter;
6965 redirect.isfile = TRUE;
6966 redirect.check_owner = redirect.check_group = FALSE;
6967 redirect.owners = NULL;
6968 redirect.owngroups = NULL;
6970 redirect.modemask = 0;
6972 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
6975 &redirect, /* Where the data is */
6976 RDO_DEFER | /* Turn on all the enabling options */
6977 RDO_FAIL | /* Leave off all the disabling options */
6982 NULL, /* No :include: restriction (not used in filter) */
6983 NULL, /* No sieve vacation directory (not sieve!) */
6984 NULL, /* No sieve enotify mailto owner (not sieve!) */
6985 NULL, /* No sieve user address (not sieve!) */
6986 NULL, /* No sieve subaddress (not sieve!) */
6987 &ugid, /* uid/gid data */
6988 &addr_new, /* Where to hang generated addresses */
6989 &filter_message, /* Where to put error message */
6990 NULL, /* Don't skip syntax errors */
6991 &filtertype, /* Will always be set to FILTER_EXIM for this call */
6992 US"system filter"); /* For error messages */
6994 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
6996 if (rc == FF_ERROR || rc == FF_NONEXIST)
6998 (void)close(deliver_datafile);
6999 deliver_datafile = -1;
7000 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
7001 string_printing(filter_message));
7002 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
7005 /* Reset things. If the filter message is an empty string, which can happen
7006 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
7008 f.system_filtering = FALSE;
7009 f.enable_dollar_recipients = FALSE;
7010 if (filter_message && filter_message[0] == 0) filter_message = NULL;
7012 /* Save the values of the system filter variables so that user filters
7015 memcpy(filter_sn, filter_n, sizeof(filter_sn));
7017 /* The filter can request that delivery of the original addresses be
7022 process_recipients = RECIP_DEFER;
7023 deliver_msglog("Delivery deferred by system filter\n");
7024 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
7027 /* The filter can request that a message be frozen, but this does not
7028 take place if the message has been manually thawed. In that case, we must
7029 unset "delivered", which is forced by the "freeze" command to make -bF
7032 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
7034 f.deliver_freeze = TRUE;
7035 deliver_frozen_at = time(NULL);
7036 process_recipients = RECIP_DEFER;
7037 frozen_info = string_sprintf(" by the system filter%s%s",
7038 filter_message ? US": " : US"",
7039 filter_message ? filter_message : US"");
7042 /* The filter can request that a message be failed. The error message may be
7043 quite long - it is sent back to the sender in the bounce - but we don't want
7044 to fill up the log with repetitions of it. If it starts with << then the text
7045 between << and >> is written to the log, with the rest left for the bounce
7048 else if (rc == FF_FAIL)
7050 uschar *colon = US"";
7051 uschar *logmsg = US"";
7054 process_recipients = RECIP_FAIL_FILTER;
7060 if ( filter_message[0] == '<'
7061 && filter_message[1] == '<'
7062 && (logend = Ustrstr(filter_message, ">>"))
7065 logmsg = filter_message + 2;
7066 loglen = logend - logmsg;
7067 filter_message = logend + 2;
7068 if (filter_message[0] == 0) filter_message = NULL;
7072 logmsg = filter_message;
7073 loglen = Ustrlen(filter_message);
7077 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
7081 /* Delivery can be restricted only to those recipients (if any) that the
7082 filter specified. */
7084 else if (rc == FF_DELIVERED)
7086 process_recipients = RECIP_IGNORE;
7088 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
7090 log_write(0, LOG_MAIN, "=> discarded (system filter)");
7093 /* If any new addresses were created by the filter, fake up a "parent"
7094 for them. This is necessary for pipes, etc., which are expected to have
7095 parents, and it also gives some sensible logging for others. Allow
7096 pipes, files, and autoreplies, and run them as the filter uid if set,
7097 otherwise as the current uid. */
7101 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
7102 int gid = system_filter_gid_set ? system_filter_gid : getegid();
7104 /* The text "system-filter" is tested in transport_set_up_command() and in
7105 set_up_shell_command() in the pipe transport, to enable them to permit
7106 $recipients, so don't change it here without also changing it there. */
7108 address_item *p = addr_new;
7109 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
7111 parent->domain = string_copylc(qualify_domain_recipient);
7112 parent->local_part = US"system-filter";
7114 /* As part of this loop, we arrange for addr_last to end up pointing
7115 at the final address. This is used if we go on to add addresses for the
7116 original recipients. */
7120 if (parent->child_count == USHRT_MAX)
7121 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
7122 "than %d delivery addresses", USHRT_MAX);
7123 parent->child_count++;
7126 if (testflag(p, af_pfr))
7132 setflag(p, af_uid_set);
7133 setflag(p, af_gid_set);
7134 setflag(p, af_allow_file);
7135 setflag(p, af_allow_pipe);
7136 setflag(p, af_allow_reply);
7138 /* Find the name of the system filter's appropriate pfr transport */
7140 if (p->address[0] == '|')
7143 GET_OPTION("system_filter_pipe_transport");
7144 tpname = system_filter_pipe_transport;
7145 address_pipe = p->address;
7147 else if (p->address[0] == '>')
7150 GET_OPTION("system_filter_reply_transport");
7151 tpname = system_filter_reply_transport;
7155 if (p->address[Ustrlen(p->address)-1] == '/')
7157 type = US"directory";
7158 GET_OPTION("system_filter_directory_transport");
7159 tpname = system_filter_directory_transport;
7164 GET_OPTION("system_filter_file_transport");
7165 tpname = system_filter_file_transport;
7167 address_file = p->address;
7170 /* Now find the actual transport, first expanding the name. We have
7171 set address_file or address_pipe above. */
7175 uschar *tmp = expand_string(tpname);
7176 address_file = address_pipe = NULL;
7178 p->message = string_sprintf("failed to expand \"%s\" as a "
7179 "system filter transport name", tpname);
7180 if (is_tainted(tmp))
7181 p->message = string_sprintf("attempt to used tainted value '%s' for"
7182 "transport '%s' as a system filter", tmp, tpname);
7186 p->message = string_sprintf("system_filter_%s_transport is unset",
7191 transport_instance *tp;
7192 for (tp = transports; tp; tp = tp->next)
7193 if (Ustrcmp(tp->name, tpname) == 0)
7194 { p->transport = tp; break; }
7196 p->message = string_sprintf("failed to find \"%s\" transport "
7197 "for system filter delivery", tpname);
7200 /* If we couldn't set up a transport, defer the delivery, putting the
7201 error on the panic log as well as the main log. */
7205 address_item * badp = p;
7207 if (!addr_last) addr_new = p; else addr_last->next = p;
7208 badp->local_part = badp->address; /* Needed for log line */
7209 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
7212 } /* End of pfr handling */
7214 /* Either a non-pfr delivery, or we found a transport */
7216 DEBUG(D_deliver|D_filter)
7217 debug_printf("system filter added %s\n", p->address);
7221 } /* Loop through all addr_new addresses */
7226 /* Scan the recipients list, and for every one that is not in the non-
7227 recipients tree, add an addr item to the chain of new addresses. If the pno
7228 value is non-negative, we must set the onetime parent from it. This which
7229 points to the relevant entry in the recipients list.
7231 This processing can be altered by the setting of the process_recipients
7232 variable, which is changed if recipients are to be ignored, failed, or
7233 deferred. This can happen as a result of system filter activity, or if the -Mg
7234 option is used to fail all of them.
7236 Duplicate addresses are handled later by a different tree structure; we can't
7237 just extend the non-recipients tree, because that will be re-written to the
7238 spool if the message is deferred, and in any case there are casing
7239 complications for local addresses. */
7241 if (process_recipients != RECIP_IGNORE)
7242 for (i = 0; i < recipients_count; i++)
7243 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
7245 recipient_item * r = recipients_list + i;
7246 address_item * new = deliver_make_addr(r->address, FALSE);
7248 new->prop.errors_address = r->errors_to;
7250 if ((new->prop.utf8_msg = message_smtputf8))
7252 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
7253 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
7254 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
7255 new->prop.utf8_downcvt ? "yes"
7256 : new->prop.utf8_downcvt_maybe ? "ifneeded"
7262 new->onetime_parent = recipients_list[r->pno].address;
7264 /* If DSN support is enabled, set the dsn flags and the original receipt
7265 to be passed on to other DSN enabled MTAs */
7267 new->dsn_flags = r->dsn_flags & rf_dsnflags;
7268 new->dsn_orcpt = r->orcpt;
7269 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
7270 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
7272 switch (process_recipients)
7274 /* RECIP_DEFER is set when a system filter freezes a message. */
7277 new->next = addr_defer;
7282 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
7285 case RECIP_FAIL_FILTER:
7287 filter_message ? filter_message : US"delivery cancelled";
7288 setflag(new, af_pass_message);
7289 goto RECIP_QUEUE_FAILED; /* below */
7292 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
7293 than the value in timeout_frozen_after. Treat non-bounce messages
7294 similarly to -Mg; for bounce messages we just want to discard, so
7295 don't put the address on the failed list. The timeout has already
7298 case RECIP_FAIL_TIMEOUT:
7299 new->message = US"delivery cancelled; message timed out";
7300 goto RECIP_QUEUE_FAILED; /* below */
7303 /* RECIP_FAIL is set when -Mg has been used. */
7306 new->message = US"delivery cancelled by administrator";
7307 /* not setting af_pass_message here means that will not
7308 appear in the bounce message */
7311 /* Common code for the failure cases above. If this is not a bounce
7312 message, put the address on the failed list so that it is used to
7313 create a bounce. Otherwise do nothing - this just discards the address.
7314 The incident has already been logged. */
7317 if (*sender_address)
7319 new->next = addr_failed;
7325 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
7326 in the message. Process each address as a routing failure; if this
7327 is a bounce message, it will get frozen. */
7329 case RECIP_FAIL_LOOP:
7330 new->message = US"Too many \"Received\" headers - suspected mail loop";
7331 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7335 /* Value should be RECIP_ACCEPT; take this as the safe default. */
7338 if (!addr_new) addr_new = new; else addr_last->next = new;
7343 #ifndef DISABLE_EVENT
7344 if (process_recipients != RECIP_ACCEPT && event_action)
7346 const uschar * save_local = deliver_localpart;
7347 const uschar * save_domain = deliver_domain;
7348 const uschar * addr = new->address;
7349 uschar * errmsg = NULL;
7350 int start, end, dom;
7352 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
7353 log_write(0, LOG_MAIN|LOG_PANIC,
7354 "failed to parse address '%.100s': %s\n", addr, errmsg);
7358 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
7359 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
7361 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
7363 deliver_localpart = save_local;
7364 deliver_domain = save_domain;
7372 debug_printf("Delivery address list:\n");
7373 for (address_item * p = addr_new; p; p = p->next)
7374 debug_printf(" %s %s\n", p->address,
7375 p->onetime_parent ? p->onetime_parent : US"");
7378 /* Set up the buffers used for copying over the file when delivering. */
7380 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
7381 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
7385 /* Until there are no more new addresses, handle each one as follows:
7387 . If this is a generated address (indicated by the presence of a parent
7388 pointer) then check to see whether it is a pipe, file, or autoreply, and
7389 if so, handle it directly here. The router that produced the address will
7390 have set the allow flags into the address, and also set the uid/gid required.
7391 Having the routers generate new addresses and then checking them here at
7392 the outer level is tidier than making each router do the checking, and
7393 means that routers don't need access to the failed address queue.
7395 . Break up the address into local part and domain, and make lowercased
7396 versions of these strings. We also make unquoted versions of the local part.
7398 . Handle the percent hack for those domains for which it is valid.
7400 . For child addresses, determine if any of the parents have the same address.
7401 If so, generate a different string for previous delivery checking. Without
7402 this code, if the address spqr generates spqr via a forward or alias file,
7403 delivery of the generated spqr stops further attempts at the top level spqr,
7404 which is not what is wanted - it may have generated other addresses.
7406 . Check on the retry database to see if routing was previously deferred, but
7407 only if in a queue run. Addresses that are to be routed are put on the
7408 addr_route chain. Addresses that are to be deferred are put on the
7409 addr_defer chain. We do all the checking first, so as not to keep the
7410 retry database open any longer than necessary.
7412 . Now we run the addresses through the routers. A router may put the address
7413 on either the addr_local or the addr_remote chain for local or remote
7414 delivery, respectively, or put it on the addr_failed chain if it is
7415 undeliveable, or it may generate child addresses and put them on the
7416 addr_new chain, or it may defer an address. All the chain anchors are
7417 passed as arguments so that the routers can be called for verification
7420 . If new addresses have been generated by the routers, da capo.
7423 f.header_rewritten = FALSE; /* No headers rewritten yet */
7424 while (addr_new) /* Loop until all addresses dealt with */
7426 address_item * addr, * parent;
7428 /* Failure to open the retry database is treated the same as if it does
7429 not exist. In both cases, dbm_file is NULL. For the first stage of a 2-phase
7430 queue run don't bother checking domain- or address-retry info; they will take
7431 effect on the second stage. */
7437 /* If we have transaction-capable hintsdbs, open the retry db without
7438 locking, and leave open for the transport process and for subsequent
7439 deliveries. If the open fails, tag that explicitly for the transport but
7440 retry the open next time around, in case it was created in the interim. */
7442 if (continue_retry_db == (open_db *)-1)
7443 continue_retry_db = NULL;
7445 if (continue_retry_db)
7446 dbm_file = continue_retry_db;
7447 else if (!exim_lockfile_needed() && continue_transport)
7449 dbm_file = dbfn_open_multi(US"retry", O_RDONLY, &dbblock);
7450 continue_retry_db = dbm_file ? dbm_file : (open_db *)-1;
7453 dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE);
7456 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
7457 debug_printf("no retry data available\n");
7460 /* Scan the current batch of new addresses, to handle pipes, files and
7461 autoreplies, and determine which others are ready for routing. */
7467 dbdata_retry * domain_retry_record, * address_retry_record;
7470 addr_new = addr->next;
7472 DEBUG(D_deliver|D_retry|D_route)
7474 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7475 debug_printf("Considering: %s\n", addr->address);
7478 /* Handle generated address that is a pipe or a file or an autoreply. */
7480 if (testflag(addr, af_pfr))
7482 /* If an autoreply in a filter could not generate a syntactically valid
7483 address, give up forthwith. Set af_ignore_error so that we don't try to
7484 generate a bounce. */
7486 if (testflag(addr, af_bad_reply))
7488 addr->basic_errno = ERRNO_BADADDRESS2;
7489 addr->local_part = addr->address;
7491 US"filter autoreply generated syntactically invalid recipient";
7492 addr->prop.ignore_error = TRUE;
7493 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7494 continue; /* with the next new address */
7497 /* If two different users specify delivery to the same pipe or file or
7498 autoreply, there should be two different deliveries, so build a unique
7499 string that incorporates the original address, and use this for
7500 duplicate testing and recording delivery, and also for retrying. */
7503 string_sprintf("%s:%s", addr->address, addr->parent->unique +
7504 (testflag(addr->parent, af_homonym) ? 3:0));
7506 addr->address_retry_key = addr->domain_retry_key =
7507 string_sprintf("T:%s", addr->unique);
7509 /* If a filter file specifies two deliveries to the same pipe or file,
7510 we want to de-duplicate, but this is probably not wanted for two mail
7511 commands to the same address, where probably both should be delivered.
7512 So, we have to invent a different unique string in that case. Just
7513 keep piling '>' characters on the front. */
7515 if (addr->address[0] == '>')
7516 while (tree_search(tree_duplicates, addr->unique))
7517 addr->unique = string_sprintf(">%s", addr->unique);
7519 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
7521 DEBUG(D_deliver|D_route)
7522 debug_printf("%s is a duplicate address: discarded\n", addr->address);
7523 addr->dupof = tnode->data.ptr;
7524 addr->next = addr_duplicate;
7525 addr_duplicate = addr;
7529 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7531 /* Check for previous delivery */
7533 if (tree_search(tree_nonrecipients, addr->unique))
7535 DEBUG(D_deliver|D_route)
7536 debug_printf("%s was previously delivered: discarded\n", addr->address);
7537 child_done(addr, tod_stamp(tod_log));
7541 /* Save for checking future duplicates */
7543 tree_add_duplicate(addr->unique, addr);
7545 /* Set local part and domain */
7547 addr->local_part = addr->address;
7548 addr->domain = addr->parent->domain;
7550 /* Ensure that the delivery is permitted. */
7552 if (testflag(addr, af_file))
7554 if (!testflag(addr, af_allow_file))
7556 addr->basic_errno = ERRNO_FORBIDFILE;
7557 addr->message = US"delivery to file forbidden";
7558 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7559 continue; /* with the next new address */
7562 else if (addr->address[0] == '|')
7564 if (!testflag(addr, af_allow_pipe))
7566 addr->basic_errno = ERRNO_FORBIDPIPE;
7567 addr->message = US"delivery to pipe forbidden";
7568 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7569 continue; /* with the next new address */
7572 else if (!testflag(addr, af_allow_reply))
7574 addr->basic_errno = ERRNO_FORBIDREPLY;
7575 addr->message = US"autoreply forbidden";
7576 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7577 continue; /* with the next new address */
7580 /* If the errno field is already set to BADTRANSPORT, it indicates
7581 failure to expand a transport string, or find the associated transport,
7582 or an unset transport when one is required. Leave this test till now so
7583 that the forbid errors are given in preference. */
7585 if (addr->basic_errno == ERRNO_BADTRANSPORT)
7587 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7591 /* Treat /dev/null as a special case and abandon the delivery. This
7592 avoids having to specify a uid on the transport just for this case.
7593 Arrange for the transport name to be logged as "**bypassed**".
7594 Copy the transport for this fairly unusual case rather than having
7595 to make all transports mutable. */
7597 if (Ustrcmp(addr->address, "/dev/null") == 0)
7599 transport_instance * save_t = addr->transport;
7600 transport_instance * t = store_get(sizeof(*t), save_t);
7602 t->name = US"**bypassed**";
7603 addr->transport = t;
7604 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
7605 addr->transport= save_t;
7606 continue; /* with the next new address */
7609 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
7612 DEBUG(D_deliver|D_route)
7613 debug_printf("queued for %s transport\n", addr->transport->name);
7614 addr->next = addr_local;
7616 continue; /* with the next new address */
7619 /* Handle normal addresses. First, split up into local part and domain,
7620 handling the %-hack if necessary. There is the possibility of a defer from
7621 a lookup in percent_hack_domains. */
7623 if ((rc = deliver_split_address(addr)) == DEFER)
7625 addr->message = US"cannot check percent_hack_domains";
7626 addr->basic_errno = ERRNO_LISTDEFER;
7627 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7631 /* Check to see if the domain is held. If so, proceed only if the
7632 delivery was forced by hand. */
7634 deliver_domain = addr->domain; /* set $domain */
7635 if ( !forced && hold_domains
7636 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
7637 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
7643 addr->message = US"hold_domains lookup deferred";
7644 addr->basic_errno = ERRNO_LISTDEFER;
7648 addr->message = US"domain is held";
7649 addr->basic_errno = ERRNO_HELD;
7651 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7655 /* Now we can check for duplicates and previously delivered addresses. In
7656 order to do this, we have to generate a "unique" value for each address,
7657 because there may be identical actual addresses in a line of descendents.
7658 The "unique" field is initialized to the same value as the "address" field,
7659 but gets changed here to cope with identically-named descendents. */
7661 for (parent = addr->parent; parent; parent = parent->parent)
7662 if (strcmpic(addr->address, parent->address) == 0) break;
7664 /* If there's an ancestor with the same name, set the homonym flag. This
7665 influences how deliveries are recorded. Then add a prefix on the front of
7666 the unique address. We use \n\ where n starts at 0 and increases each time.
7667 It is unlikely to pass 9, but if it does, it may look odd but will still
7668 work. This means that siblings or cousins with the same names are treated
7669 as duplicates, which is what we want. */
7673 setflag(addr, af_homonym);
7674 if (parent->unique[0] != '\\')
7675 addr->unique = string_sprintf("\\0\\%s", addr->address);
7677 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
7681 /* Ensure that the domain in the unique field is lower cased, because
7682 domains are always handled caselessly. */
7684 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
7686 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7688 if (tree_search(tree_nonrecipients, addr->unique))
7690 DEBUG(D_deliver|D_route)
7691 debug_printf("%s was previously delivered: discarded\n", addr->unique);
7692 child_done(addr, tod_stamp(tod_log));
7696 /* Get the routing retry status, saving the two retry keys (with and
7697 without the local part) for subsequent use. If there is no retry record for
7698 the standard address routing retry key, we look for the same key with the
7699 sender attached, because this form is used by the smtp transport after a
7700 4xx response to RCPT when address_retry_include_sender is true. */
7702 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
7703 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
7708 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
7709 if ( domain_retry_record
7710 && now - domain_retry_record->time_stamp > retry_data_expire
7713 DEBUG(D_deliver|D_retry)
7714 debug_printf("domain retry record present but expired\n");
7715 domain_retry_record = NULL; /* Ignore if too old */
7718 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
7719 if ( address_retry_record
7720 && now - address_retry_record->time_stamp > retry_data_expire
7723 DEBUG(D_deliver|D_retry)
7724 debug_printf("address retry record present but expired\n");
7725 address_retry_record = NULL; /* Ignore if too old */
7728 if (!address_retry_record)
7730 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7732 address_retry_record = dbfn_read(dbm_file, altkey);
7733 if ( address_retry_record
7734 && now - address_retry_record->time_stamp > retry_data_expire)
7736 DEBUG(D_deliver|D_retry)
7737 debug_printf("address<sender> retry record present but expired\n");
7738 address_retry_record = NULL; /* Ignore if too old */
7743 domain_retry_record = address_retry_record = NULL;
7745 DEBUG(D_deliver|D_retry)
7747 if (!domain_retry_record)
7748 debug_printf("no domain retry record\n");
7750 debug_printf("have domain retry record; next_try = now%+d\n",
7751 f.running_in_test_harness ? 0 :
7752 (int)(domain_retry_record->next_try - now));
7754 if (!address_retry_record)
7755 debug_printf("no address retry record\n");
7757 debug_printf("have address retry record; next_try = now%+d\n",
7758 f.running_in_test_harness ? 0 :
7759 (int)(address_retry_record->next_try - now));
7762 /* If we are sending a message down an existing SMTP connection, we must
7763 assume that the message which created the connection managed to route
7764 an address to that connection. We do not want to run the risk of taking
7765 a long time over routing here, because if we do, the server at the other
7766 end of the connection may time it out. This is especially true for messages
7767 with lots of addresses. For this kind of delivery, queue_running is not
7768 set, so we would normally route all addresses. We take a pragmatic approach
7769 and defer routing any addresses that have any kind of domain retry record.
7770 That is, we don't even look at their retry times. It doesn't matter if this
7771 doesn't work occasionally. This is all just an optimization, after all.
7773 The reason for not doing the same for address retries is that they normally
7774 arise from 4xx responses, not DNS timeouts. */
7776 if (continue_hostname && domain_retry_record)
7778 addr->message = US"reusing SMTP connection skips previous routing defer";
7779 addr->basic_errno = ERRNO_RRETRY;
7780 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7782 addr->message = domain_retry_record->text;
7783 setflag(addr, af_pass_message);
7786 /* If we are in a queue run, defer routing unless there is no retry data or
7787 we've passed the next retry time, or this message is forced. In other
7788 words, ignore retry data when not in a queue run.
7790 However, if the domain retry time has expired, always allow the routing
7791 attempt. If it fails again, the address will be failed. This ensures that
7792 each address is routed at least once, even after long-term routing
7795 If there is an address retry, check that too; just wait for the next
7796 retry time. This helps with the case when the temporary error on the
7797 address was really message-specific rather than address specific, since
7798 it allows other messages through.
7800 We also wait for the next retry time if this is a message sent down an
7801 existing SMTP connection (even though that will be forced). Otherwise there
7802 will be far too many attempts for an address that gets a 4xx error. In
7803 fact, after such an error, we should not get here because, the host should
7804 not be remembered as one this message needs. However, there was a bug that
7805 used to cause this to happen, so it is best to be on the safe side.
7807 Even if we haven't reached the retry time in the hints, there is one more
7808 check to do, which is for the ultimate address timeout. We only do this
7809 check if there is an address retry record and there is not a domain retry
7810 record; this implies that previous attempts to handle the address had the
7811 retry_use_local_parts option turned on. We use this as an approximation
7812 for the destination being like a local delivery, for example delivery over
7813 LMTP to an IMAP message store. In this situation users are liable to bump
7814 into their quota and thereby have intermittently successful deliveries,
7815 which keep the retry record fresh, which can lead to us perpetually
7816 deferring messages. */
7818 else if ( ( f.queue_running && !f.deliver_force
7819 || continue_hostname
7821 && ( ( domain_retry_record
7822 && now < domain_retry_record->next_try
7823 && !domain_retry_record->expired
7825 || ( address_retry_record
7826 && now < address_retry_record->next_try
7828 && ( domain_retry_record
7829 || !address_retry_record
7830 || !retry_ultimate_address_timeout(addr->address_retry_key,
7831 addr->domain, address_retry_record, now)
7834 addr->message = US"retry time not reached";
7835 addr->basic_errno = ERRNO_RRETRY;
7836 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7838 /* For remote-retry errors (here and just above) that we've not yet
7839 hit the retry time, use the error recorded in the retry database
7840 as info in the warning message. This lets us send a message even
7841 when we're not failing on a fresh attempt. We assume that this
7842 info is not sensitive. */
7844 addr->message = domain_retry_record
7845 ? domain_retry_record->text : address_retry_record->text;
7846 setflag(addr, af_pass_message);
7849 /* The domain is OK for routing. Remember if retry data exists so it
7850 can be cleaned up after a successful delivery. */
7854 if (domain_retry_record || address_retry_record)
7855 setflag(addr, af_dr_retry_exists);
7856 addr->next = addr_route;
7858 DEBUG(D_deliver|D_route)
7859 debug_printf("%s: queued for routing\n", addr->address);
7863 /* The database is closed while routing is actually happening. Requests to
7864 update it are put on a chain and all processed together at the end. */
7866 if (dbm_file && !continue_retry_db)
7867 { dbfn_close(dbm_file); dbm_file = NULL; }
7869 /* If queue_domains is set, we don't even want to try routing addresses in
7870 those domains. During queue runs, queue_domains is forced to be unset.
7871 Optimize by skipping this pass through the addresses if nothing is set. */
7873 if (!f.deliver_force && queue_domains)
7875 address_item *okaddr = NULL;
7878 address_item *addr = addr_route;
7879 addr_route = addr->next;
7881 deliver_domain = addr->domain; /* set $domain */
7882 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
7883 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
7887 addr->basic_errno = ERRNO_LISTDEFER;
7888 addr->message = US"queue_domains lookup deferred";
7889 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7893 addr->next = okaddr;
7898 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
7899 addr->message = US"domain is in queue_domains";
7900 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7904 addr_route = okaddr;
7907 /* Now route those addresses that are not deferred. */
7912 address_item *addr = addr_route;
7913 const uschar *old_domain = addr->domain;
7914 uschar *old_unique = addr->unique;
7915 addr_route = addr->next;
7918 /* Just in case some router parameter refers to it. */
7920 if (!(return_path = addr->prop.errors_address))
7921 return_path = sender_address;
7923 /* If a router defers an address, add a retry item. Whether or not to
7924 use the local part in the key is a property of the router. */
7926 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
7927 &addr_succeed, v_none)) == DEFER)
7928 retry_add_item(addr,
7929 addr->router->retry_use_local_part
7930 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
7931 : string_sprintf("R:%s", addr->domain),
7934 /* Otherwise, if there is an existing retry record in the database, add
7935 retry items to delete both forms. We must also allow for the possibility
7936 of a routing retry that includes the sender address. Since the domain might
7937 have been rewritten (expanded to fully qualified) as a result of routing,
7938 ensure that the rewritten form is also deleted. */
7940 else if (testflag(addr, af_dr_retry_exists))
7942 uschar * altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7944 retry_add_item(addr, altkey, rf_delete);
7945 retry_add_item(addr, addr->address_retry_key, rf_delete);
7946 retry_add_item(addr, addr->domain_retry_key, rf_delete);
7947 if (Ustrcmp(addr->domain, old_domain) != 0)
7948 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
7951 /* DISCARD is given for :blackhole: and "seen finish". The event has been
7952 logged, but we need to ensure the address (and maybe parents) is marked
7957 address_done(addr, tod_stamp(tod_log));
7958 continue; /* route next address */
7961 /* The address is finished with (failed or deferred). */
7965 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7966 continue; /* route next address */
7969 /* The address has been routed. If the router changed the domain, it will
7970 also have changed the unique address. We have to test whether this address
7971 has already been delivered, because it's the unique address that finally
7974 if ( addr->unique != old_unique
7975 && tree_search(tree_nonrecipients, addr->unique) != 0
7978 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
7979 "discarded\n", addr->address);
7980 if (addr_remote == addr) addr_remote = addr->next;
7981 else if (addr_local == addr) addr_local = addr->next;
7984 /* If the router has same_domain_copy_routing set, we are permitted to copy
7985 the routing for any other addresses with the same domain. This is an
7986 optimisation to save repeated DNS lookups for "standard" remote domain
7987 routing. The option is settable only on routers that generate host lists.
7988 We play it very safe, and do the optimization only if the address is routed
7989 to a remote transport, there are no header changes, and the domain was not
7990 modified by the router. */
7992 if ( addr_remote == addr
7993 && addr->router->same_domain_copy_routing
7994 && !addr->prop.extra_headers
7995 && !addr->prop.remove_headers
7996 && old_domain == addr->domain
7999 address_item **chain = &addr_route;
8002 address_item *addr2 = *chain;
8003 if (Ustrcmp(addr2->domain, addr->domain) != 0)
8005 chain = &(addr2->next);
8009 /* Found a suitable address; take it off the routing list and add it to
8010 the remote delivery list. */
8012 *chain = addr2->next;
8013 addr2->next = addr_remote;
8014 addr_remote = addr2;
8016 /* Copy the routing data */
8018 addr2->domain = addr->domain;
8019 addr2->router = addr->router;
8020 addr2->transport = addr->transport;
8021 addr2->host_list = addr->host_list;
8022 addr2->fallback_hosts = addr->fallback_hosts;
8023 addr2->prop.errors_address = addr->prop.errors_address;
8024 copyflag(addr2, addr, af_hide_child);
8025 copyflag(addr2, addr, af_local_host_removed);
8027 DEBUG(D_deliver|D_route)
8028 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
8030 "Routing for %s copied from %s\n",
8031 addr2->address, addr2->address, addr->address);
8034 } /* Continue with routing the next address. */
8035 } /* Loop to process any child addresses that the routers created, and
8036 any rerouted addresses that got put back on the new chain. */
8038 if (dbm_file) /* Can only be continue_retry_db */
8039 { dbfn_close_multi(continue_retry_db); continue_retry_db = dbm_file = NULL; }
8041 /* Debugging: show the results of the routing */
8043 DEBUG(D_deliver|D_retry|D_route)
8045 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
8046 debug_printf("After routing:\n Local deliveries:\n");
8047 for (address_item * p = addr_local; p; p = p->next)
8048 debug_printf(" %s\n", p->address);
8050 debug_printf(" Remote deliveries:\n");
8051 for (address_item * p = addr_remote; p; p = p->next)
8052 debug_printf(" %s\n", p->address);
8054 debug_printf(" Failed addresses:\n");
8055 for (address_item * p = addr_failed; p; p = p->next)
8056 debug_printf(" %s\n", p->address);
8058 debug_printf(" Deferred addresses:\n");
8059 for (address_item * p = addr_defer; p; p = p->next)
8060 debug_printf(" %s\n", p->address);
8063 /* Free any resources that were cached during routing. */
8068 /* These two variables are set only during routing, after check_local_user.
8069 Ensure they are not set in transports. */
8071 local_user_gid = (gid_t)(-1);
8072 local_user_uid = (uid_t)(-1);
8074 /* Check for any duplicate addresses. This check is delayed until after
8075 routing, because the flexibility of the routing configuration means that
8076 identical addresses with different parentage may end up being redirected to
8077 different addresses. Checking for duplicates too early (as we previously used
8078 to) makes this kind of thing not work. */
8080 do_duplicate_check(&addr_local);
8081 do_duplicate_check(&addr_remote);
8083 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
8084 remote transport. The check that they all end up in one transaction happens in
8085 the do_remote_deliveries() function. */
8088 && (addr_local || addr_failed || addr_defer)
8092 uschar *which, *colon, *msg;
8099 else if (addr_defer)
8102 which = US"deferred";
8110 while (addr->parent) addr = addr->parent;
8115 msg = addr->message;
8117 else colon = msg = US"";
8119 /* We don't need to log here for a forced failure as it will already
8120 have been logged. Defer will also have been logged, but as a defer, so we do
8121 need to do the failure logging. */
8123 if (addr != addr_failed)
8124 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
8125 addr->address, which);
8127 /* Always write an error to the caller */
8129 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
8132 final_yield = DELIVER_MUA_FAILED;
8133 addr_failed = addr_defer = NULL; /* So that we remove the message */
8134 goto DELIVERY_TIDYUP;
8138 /* If this is a run to continue deliveries to an external channel that is
8139 already set up, defer any local deliveries.
8141 jgh 2020/12/20: I don't see why; locals should be quick.
8142 The defer goes back to version 1.62 in 1997. A local being still deliverable
8143 during a continued run might result from something like a defer during the
8144 original delivery, eg. in a DB lookup. Unlikely but possible.
8146 To avoid delaying a local when combined with a callout-hold for a remote
8147 delivery, test continue_sequence rather than continue_transport. */
8149 if (continue_sequence > 1 && addr_local)
8151 DEBUG(D_deliver|D_retry|D_route)
8152 debug_printf("deferring local deliveries due to continued-transport\n");
8155 address_item * addr = addr_defer;
8156 while (addr->next) addr = addr->next;
8157 addr->next = addr_local;
8160 addr_defer = addr_local;
8165 /* Because address rewriting can happen in the routers, we should not really do
8166 ANY deliveries until all addresses have been routed, so that all recipients of
8167 the message get the same headers. However, this is in practice not always
8168 possible, since sometimes remote addresses give DNS timeouts for days on end.
8169 The pragmatic approach is to deliver what we can now, saving any rewritten
8170 headers so that at least the next lot of recipients benefit from the rewriting
8171 that has already been done.
8173 If any headers have been rewritten during routing, update the spool file to
8174 remember them for all subsequent deliveries. This can be delayed till later if
8175 there is only address to be delivered - if it succeeds the spool write need not
8178 if ( f.header_rewritten
8179 && ( addr_local && (addr_local->next || addr_remote)
8180 || addr_remote && addr_remote->next
8183 /* Panic-dies on error */
8184 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8185 f.header_rewritten = FALSE;
8189 /* If there are any deliveries to do and we do not already have the journal
8190 file, create it. This is used to record successful deliveries as soon as
8191 possible after each delivery is known to be complete. A file opened with
8192 O_APPEND is used so that several processes can run simultaneously.
8194 The journal is just insurance against crashes. When the spool file is
8195 ultimately updated at the end of processing, the journal is deleted. If a
8196 journal is found to exist at the start of delivery, the addresses listed
8197 therein are added to the non-recipients. */
8199 if (addr_local || addr_remote)
8203 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8205 if ((journal_fd = Uopen(fname,
8206 EXIM_CLOEXEC | O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
8208 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
8209 fname, strerror(errno));
8210 return DELIVER_NOT_ATTEMPTED;
8213 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
8214 that the mode is correct - the group setting doesn't always seem to get
8215 set automatically. */
8217 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
8218 || fchmod(journal_fd, SPOOL_MODE)
8220 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
8224 int ret = Uunlink(fname);
8225 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
8226 fname, strerror(errno));
8227 if(ret && errno != ENOENT)
8228 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8229 fname, strerror(errno));
8230 return DELIVER_NOT_ATTEMPTED;
8234 else if (journal_fd >= 0)
8242 /* Now we can get down to the business of actually doing deliveries. Local
8243 deliveries are done first, then remote ones. If ever the problems of how to
8244 handle fallback transports are figured out, this section can be put into a loop
8245 for handling fallbacks, though the uid switching will have to be revised. */
8247 /* Precompile a regex that is used to recognize a parameter in response
8248 to an LHLO command, if is isn't already compiled. This may be used on both
8249 local and remote LMTP deliveries. */
8251 if (!regex_IGNOREQUOTA)
8253 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", MCS_NOFLAGS, TRUE);
8255 /* Handle local deliveries */
8259 DEBUG(D_deliver|D_transport)
8260 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
8261 do_local_deliveries();
8262 f.disable_logging = FALSE;
8265 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
8266 so just queue them all. */
8268 if (f.queue_run_local)
8271 address_item *addr = addr_remote;
8272 addr_remote = addr->next;
8274 addr->basic_errno = ERRNO_LOCAL_ONLY;
8275 addr->message = US"remote deliveries suppressed";
8276 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
8279 /* Handle remote deliveries */
8283 DEBUG(D_deliver|D_transport)
8284 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
8286 /* Precompile some regex that are used to recognize parameters in response
8287 to an EHLO command, if they aren't already compiled. */
8289 smtp_deliver_init();
8291 /* Now sort the addresses if required, and do the deliveries. The yield of
8292 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
8293 cannot be delivered in one transaction. */
8295 if (remote_sort_domains) sort_remote_deliveries();
8296 if (!do_remote_deliveries(FALSE))
8298 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
8299 "be delivered in one transaction");
8300 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
8302 final_yield = DELIVER_MUA_FAILED;
8303 addr_failed = addr_defer = NULL; /* So that we remove the message */
8304 goto DELIVERY_TIDYUP;
8307 /* See if any of the addresses that failed got put on the queue for delivery
8308 to their fallback hosts. We do it this way because often the same fallback
8309 host is used for many domains, so all can be sent in a single transaction
8310 (if appropriately configured). */
8312 if (addr_fallback && !mua_wrapper)
8314 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
8315 addr_remote = addr_fallback;
8316 addr_fallback = NULL;
8317 if (remote_sort_domains) sort_remote_deliveries();
8318 do_remote_deliveries(TRUE);
8320 f.disable_logging = FALSE;
8324 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
8325 phase, to minimize cases of half-done things. */
8328 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
8329 cancel_cutthrough_connection(TRUE, US"deliveries are done");
8331 /* Root privilege is no longer needed */
8333 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
8335 set_process_info("tidying up after delivering %s", message_id);
8336 signal(SIGTERM, SIG_IGN);
8338 /* When we are acting as an MUA wrapper, the smtp transport will either have
8339 succeeded for all addresses, or failed them all in normal cases. However, there
8340 are some setup situations (e.g. when a named port does not exist) that cause an
8341 immediate exit with deferral of all addresses. Convert those into failures. We
8342 do not ever want to retry, nor do we want to send a bounce message. */
8348 address_item * nextaddr;
8349 for (address_item * addr = addr_defer; addr; addr = nextaddr)
8351 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
8352 "delivery", addr->address);
8353 nextaddr = addr->next;
8354 addr->next = addr_failed;
8360 /* Now all should either have succeeded or failed. */
8363 final_yield = DELIVER_MUA_SUCCEEDED;
8367 uschar *s = addr_failed->user_message;
8369 if (!s) s = addr_failed->message;
8371 fprintf(stderr, "Delivery failed: ");
8372 if (addr_failed->basic_errno > 0)
8374 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
8375 if (s) fprintf(stderr, ": ");
8377 if ((host = addr_failed->host_used))
8378 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
8380 fprintf(stderr, "%s", CS s);
8381 else if (addr_failed->basic_errno <= 0)
8382 fprintf(stderr, "unknown error");
8383 fprintf(stderr, "\n");
8385 final_yield = DELIVER_MUA_FAILED;
8390 /* In a normal configuration, we now update the retry database. This is done in
8391 one fell swoop at the end in order not to keep opening and closing (and
8392 locking) the database. The code for handling retries is hived off into a
8393 separate module for convenience. We pass it the addresses of the various
8394 chains, because deferred addresses can get moved onto the failed chain if the
8395 retry cutoff time has expired for all alternative destinations. Bypass the
8396 updating of the database if the -N flag is set, which is a debugging thing that
8397 prevents actual delivery. */
8399 else if (!f.dont_deliver)
8400 retry_update(&addr_defer, &addr_failed, &addr_succeed);
8402 /* Send DSN for successful messages if requested */
8404 maybe_send_dsn(addr_succeed);
8406 /* If any addresses failed, we must send a message to somebody, unless
8407 af_ignore_error is set, in which case no action is taken. It is possible for
8408 several messages to get sent if there are addresses with different
8413 const uschar * logtod = tod_stamp(tod_log);
8414 address_item * addr;
8416 /* There are weird cases when logging is disabled in the transport. However,
8417 there may not be a transport (address failed by a router). */
8419 f.disable_logging = FALSE;
8420 if (addr_failed->transport)
8421 f.disable_logging = addr_failed->transport->disable_logging;
8424 debug_printf("processing failed address %s\n", addr_failed->address);
8426 /* There are only two ways an address in a bounce message can get here:
8428 (1) When delivery was initially deferred, but has now timed out (in the call
8429 to retry_update() above). We can detect this by testing for
8430 af_retry_timedout. If the address does not have its own errors address,
8431 we arrange to ignore the error.
8433 (2) If delivery failures for bounce messages are being ignored. We can detect
8434 this by testing for af_ignore_error. This will also be set if a bounce
8435 message has been autothawed and the ignore_bounce_errors_after time has
8436 passed. It might also be set if a router was explicitly configured to
8437 ignore errors (errors_to = "").
8439 If neither of these cases obtains, something has gone wrong. Log the
8440 incident, but then ignore the error. */
8442 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
8444 if ( !testflag(addr_failed, af_retry_timedout)
8445 && !addr_failed->prop.ignore_error)
8446 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
8447 "failure is neither frozen nor ignored (it's been ignored)");
8449 addr_failed->prop.ignore_error = TRUE;
8452 /* If the first address on the list has af_ignore_error set, just remove
8453 it from the list, throw away any saved message file, log it, and
8454 mark the recipient done. */
8456 if ( addr_failed->prop.ignore_error
8457 || addr_failed->dsn_flags & rf_dsnflags
8458 && !(addr_failed->dsn_flags & rf_notify_failure)
8462 addr_failed = addr->next;
8463 if (addr->return_filename) Uunlink(addr->return_filename);
8465 #ifndef DISABLE_EVENT
8466 msg_event_raise(US"msg:fail:delivery", addr);
8468 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
8470 !addr->parent ? US"" : US" <",
8471 !addr->parent ? US"" : addr->parent->address,
8472 !addr->parent ? US"" : US">",
8473 addr->prop.ignore_error
8474 ? US"" : US": RFC 3461 DSN, failure notify not requested");
8476 address_done(addr, logtod);
8477 child_done(addr, logtod);
8478 /* Panic-dies on error */
8479 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8482 /* Otherwise, handle the sending of a message. Find the error address for
8483 the first address, then send a message that includes all failed addresses
8484 that have the same error address. */
8487 send_bounce_message(now, logtod);
8490 f.disable_logging = FALSE; /* In case left set */
8492 /* Come here from the mua_wrapper case if routing goes wrong */
8496 /* If there are now no deferred addresses, we are done. Preserve the
8497 message log if so configured, and we are using them. Otherwise, sling it.
8498 Then delete the message itself. */
8506 fname = spool_fname(US"msglog", message_subdir, id, US"");
8507 if (preserve_message_logs)
8510 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8512 if ((rc = Urename(fname, moname)) < 0)
8514 (void)directory_make(spool_directory,
8515 spool_sname(US"msglog.OLD", US""),
8516 MSGLOG_DIRECTORY_MODE, TRUE);
8517 rc = Urename(fname, moname);
8520 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8521 "msglog.OLD directory", fname);
8524 if (Uunlink(fname) < 0)
8525 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8526 fname, strerror(errno));
8529 /* Remove the two message files. */
8531 fname = spool_fname(US"input", message_subdir, id, US"-D");
8532 if (Uunlink(fname) < 0)
8533 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8534 fname, strerror(errno));
8535 fname = spool_fname(US"input", message_subdir, id, US"-H");
8536 if (Uunlink(fname) < 0)
8537 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8538 fname, strerror(errno));
8540 /* Log the end of this message, with queue time if requested. */
8542 if (LOGGING(queue_time_overall))
8543 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8545 log_write(0, LOG_MAIN, "Completed");
8547 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8548 f.deliver_freeze = FALSE;
8550 #ifndef DISABLE_EVENT
8551 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8555 /* If there are deferred addresses, we are keeping this message because it is
8556 not yet completed. Lose any temporary files that were catching output from
8557 pipes for any of the deferred addresses, handle one-time aliases, and see if
8558 the message has been on the queue for so long that it is time to send a warning
8559 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8560 have the same domain, we can set deliver_domain for the expansion of
8561 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8562 the parent's domain.
8564 If all the deferred addresses have an error number that indicates "retry time
8565 not reached", skip sending the warning message, because it won't contain the
8566 reason for the delay. It will get sent at the next real delivery attempt.
8567 Exception: for retries caused by a remote peer we use the error message
8568 store in the retry DB as the reason.
8569 However, if at least one address has tried, we'd better include all of them in
8572 If we can't make a process to send the message, don't worry.
8574 For mailing list expansions we want to send the warning message to the
8575 mailing list manager. We can't do a perfect job here, as some addresses may
8576 have different errors addresses, but if we take the errors address from
8577 each deferred address it will probably be right in most cases.
8579 If addr_defer == +1, it means there was a problem sending an error message
8580 for failed addresses, and there were no "real" deferred addresses. The value
8581 was set just to keep the message on the spool, so there is nothing to do here.
8584 else if (addr_defer != (address_item *)(+1))
8586 uschar * recipients = US"";
8587 BOOL want_warning_msg = FALSE;
8589 deliver_domain = testflag(addr_defer, af_pfr)
8590 ? addr_defer->parent->domain : addr_defer->domain;
8592 for (address_item * addr = addr_defer; addr; addr = addr->next)
8594 address_item * otaddr;
8596 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8600 const uschar *d = testflag(addr, af_pfr)
8601 ? addr->parent->domain : addr->domain;
8603 /* The domain may be unset for an address that has never been routed
8604 because the system filter froze the message. */
8606 if (!d || Ustrcmp(d, deliver_domain) != 0)
8607 deliver_domain = NULL;
8610 if (addr->return_filename) Uunlink(addr->return_filename);
8612 /* Handle the case of one-time aliases. If any address in the ancestry
8613 of this one is flagged, ensure it is in the recipients list, suitably
8614 flagged, and that its parent is marked delivered. */
8616 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8617 if (otaddr->onetime_parent) break;
8622 int t = recipients_count;
8624 for (i = 0; i < recipients_count; i++)
8626 const uschar * r = recipients_list[i].address;
8627 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8628 if (Ustrcmp(otaddr->address, r) == 0) break;
8631 /* Didn't find the address already in the list, and did find the
8632 ultimate parent's address in the list, and they really are different
8633 (i.e. not from an identity-redirect). After adding the recipient,
8634 update the errors address in the recipients list. */
8636 if ( i >= recipients_count && t < recipients_count
8637 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8639 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8640 otaddr->address, otaddr->parent->address);
8641 receive_add_recipient(otaddr->address, t);
8642 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8643 tree_add_nonrecipient(otaddr->parent->address);
8644 update_spool = TRUE;
8648 /* Except for error messages, ensure that either the errors address for
8649 this deferred address or, if there is none, the sender address, is on the
8650 list of recipients for a warning message. */
8652 if (sender_address[0])
8654 const uschar * s = addr->prop.errors_address;
8655 if (!s) s = sender_address;
8656 if (Ustrstr(recipients, s) == NULL)
8657 recipients = string_sprintf("%s%s%s", recipients,
8658 recipients[0] ? "," : "", s);
8662 /* Send a warning message if the conditions are right. If the condition check
8663 fails because of a lookup defer, there is nothing we can do. The warning
8664 is not sent. Another attempt will be made at the next delivery attempt (if
8667 if ( !f.queue_2stage
8669 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8670 || addr_defer->dsn_flags & rf_notify_delay
8672 && delay_warning[1] > 0
8673 && sender_address[0] != 0)
8675 GET_OPTION("delay_warning_condition");
8676 if ( ( !delay_warning_condition
8677 || expand_check_condition(delay_warning_condition,
8678 US"delay_warning", US"option")
8684 int queue_time = time(NULL) - received_time.tv_sec;
8686 queue_time = test_harness_fudged_queue_time(queue_time);
8688 /* See how many warnings we should have sent by now */
8690 for (count = 0; count < delay_warning[1]; count++)
8691 if (queue_time < delay_warning[count+2]) break;
8693 show_time = delay_warning[count+1];
8695 if (count >= delay_warning[1])
8698 int last_gap = show_time;
8699 if (count > 1) last_gap -= delay_warning[count];
8700 extra = (queue_time - delay_warning[count+1])/last_gap;
8701 show_time += last_gap * extra;
8707 debug_printf("time on queue = %s id %s addr %s\n",
8708 readconf_printtime(queue_time), message_id, addr_defer->address);
8709 debug_printf("warning counts: required %d done %d\n", count,
8713 /* We have computed the number of warnings there should have been by now.
8714 If there haven't been enough, send one, and up the count to what it should
8717 if (warning_count < count)
8718 if (send_warning_message(recipients, queue_time, show_time))
8720 warning_count = count;
8721 update_spool = TRUE; /* Ensure spool rewritten */
8726 /* Clear deliver_domain */
8728 deliver_domain = NULL;
8730 /* If this was a first delivery attempt, unset the first time flag, and
8731 ensure that the spool gets updated. */
8733 if (f.deliver_firsttime && !f.queue_2stage)
8735 f.deliver_firsttime = FALSE;
8736 update_spool = TRUE;
8739 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8740 message, unless the message is a local error message (to avoid loops). Then
8741 log the freezing. If the text in "frozen_info" came from a system filter,
8742 it has been escaped into printing characters so as not to mess up log lines.
8743 For the "tell" message, we turn \n back into newline. Also, insert a newline
8744 near the start instead of the ": " string. */
8746 if (f.deliver_freeze)
8748 if (freeze_tell && *freeze_tell && !f.local_error_message)
8750 uschar * s = string_copy(frozen_info);
8751 uschar * ss = Ustrstr(s, " by the system filter: ");
8760 if (*ss == '\\' && ss[1] == 'n')
8761 { *ss++ = ' '; *ss++ = '\n'; }
8765 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8766 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8770 /* Log freezing just before we update the -H file, to minimize the chance
8771 of a race problem. */
8773 deliver_msglog("*** Frozen%s\n", frozen_info);
8774 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8777 /* If there have been any updates to the non-recipients list, or other things
8778 that get written to the spool, we must now update the spool header file so
8779 that it has the right information for the next delivery attempt. If there
8780 was more than one address being delivered, the header_change update is done
8781 earlier, in case one succeeds and then something crashes. */
8784 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8785 update_spool, f.header_rewritten);
8787 if (update_spool || f.header_rewritten)
8788 /* Panic-dies on error */
8789 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8792 /* Finished with the message log. If the message is complete, it will have
8793 been unlinked or renamed above. */
8795 if (message_logs) (void)fclose(message_log);
8797 /* Now we can close and remove the journal file. Its only purpose is to record
8798 successfully completed deliveries asap so that this information doesn't get
8799 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8800 not serious, as trying it again is not harmful. The journal might not be open
8801 if all addresses were deferred at routing or directing. Nevertheless, we must
8802 remove it if it exists (may have been lying around from a crash during the
8803 previous delivery attempt). We don't remove the journal if a delivery
8804 subprocess failed to pass back delivery information; this is controlled by
8805 the remove_journal flag. When the journal is left, we also don't move the
8806 message off the main spool if frozen and the option is set. It should get moved
8807 at the next attempt, after the journal has been inspected. */
8809 if (journal_fd >= 0) (void)close(journal_fd);
8813 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8815 if (Uunlink(fname) < 0 && errno != ENOENT)
8816 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8819 /* Move the message off the spool if requested */
8821 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8822 if (f.deliver_freeze && move_frozen_messages)
8823 (void)spool_move_message(id, message_subdir, US"", US"F");
8827 /* Closing the data file frees the lock; if the file has been unlinked it
8828 will go away. Otherwise the message becomes available for another process
8831 (void)close(deliver_datafile);
8832 deliver_datafile = -1;
8833 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8834 #ifdef MEASURE_TIMING
8835 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8838 /* If the transport suggested another message to deliver, go round again. */
8840 if (final_yield == DELIVER_ATTEMPTED_NORMAL && *continue_next_id)
8842 addr_defer = addr_failed = addr_succeed = NULL;
8843 tree_duplicates = NULL; /* discard dups info from old message */
8844 id = string_copyn(continue_next_id, MESSAGE_ID_LENGTH);
8845 continue_next_id[0] = '\0';
8849 /* It is unlikely that there will be any cached resources, since they are
8850 released after routing, and in the delivery subprocesses. However, it's
8851 possible for an expansion for something afterwards (for example,
8852 expand_check_condition) to do a lookup. We must therefore be sure everything is
8856 acl_where = ACL_WHERE_UNKNOWN;
8865 #ifdef EXIM_TFO_PROBE
8868 f.tcp_fastopen_ok = TRUE;
8874 /* Called from a commandline, or from the daemon, to do a delivery.
8875 We need to regain privs; do this by exec of the exim binary. */
8878 delivery_re_exec(int exec_type)
8882 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8884 int channel_fd = cutthrough.cctx.sock;
8886 smtp_peer_options = cutthrough.peer_options;
8887 continue_sequence = 0;
8890 if (cutthrough.is_tls)
8894 smtp_peer_options |= OPTION_TLS;
8895 sending_ip_address = cutthrough.snd_ip;
8896 sending_port = cutthrough.snd_port;
8898 where = US"socketpair";
8899 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8903 testharness_pause_ms(150);
8904 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8907 if (pid == 0) /* child: will fork again to totally disconnect */
8909 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8910 pfd, 5*60, cutthrough.host.name);
8911 /* does not return */
8915 waitpid(pid, NULL, 0);
8916 (void) close(channel_fd); /* release the client socket */
8917 channel_fd = pfd[1];
8921 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8922 cutthrough.host.address, message_id, channel_fd);
8926 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8927 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8929 return; /* compiler quietening; control does not reach here. */
8934 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8935 "delivery re-exec %s failed: %s", where, strerror(errno));
8937 /* Get here if exec_type == CEE_EXEC_EXIT.
8938 Note: this must be _exit(), not exit(). */
8940 _exit(EX_EXECFAILED);
8946 /* End of deliver.c */