1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 - 2021 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* The main code for delivering a message. */
13 #include "transports/smtp.h"
18 /* Data block for keeping track of subprocesses for parallel remote
21 typedef struct pardata {
22 address_item *addrlist; /* chain of addresses */
23 address_item *addr; /* next address data expected for */
24 pid_t pid; /* subprocess pid */
25 int fd; /* pipe fd for getting result from subprocess */
26 int transport_count; /* returned transport count value */
27 BOOL done; /* no more data needed */
28 uschar *msg; /* error message */
29 uschar *return_path; /* return_path for these addresses */
32 /* Values for the process_recipients variable */
34 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
35 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
38 /* Mutually recursive functions for marking addresses done. */
40 static void child_done(address_item *, uschar *);
41 static void address_done(address_item *, uschar *);
43 /* Table for turning base-62 numbers into binary */
45 static uschar tab62[] =
46 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
47 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
48 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
49 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
50 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
51 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
55 /*************************************************
56 * Local static variables *
57 *************************************************/
59 /* addr_duplicate is global because it needs to be seen from the Envelope-To
62 static address_item *addr_defer = NULL;
63 static address_item *addr_failed = NULL;
64 static address_item *addr_fallback = NULL;
65 static address_item *addr_local = NULL;
66 static address_item *addr_new = NULL;
67 static address_item *addr_remote = NULL;
68 static address_item *addr_route = NULL;
69 static address_item *addr_succeed = NULL;
70 static address_item *addr_senddsn = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static struct pollfd *parpoll;
78 static int return_count;
79 static uschar *frozen_info = US"";
80 static uschar *used_return_path = NULL;
84 /*************************************************
85 * read as much as requested *
86 *************************************************/
88 /* The syscall read(2) doesn't always returns as much as we want. For
89 several reasons it might get less. (Not talking about signals, as syscalls
90 are restartable). When reading from a network or pipe connection the sender
91 might send in smaller chunks, with delays between these chunks. The read(2)
92 may return such a chunk.
94 The more the writer writes and the smaller the pipe between write and read is,
95 the more we get the chance of reading leass than requested. (See bug 2130)
97 This function read(2)s until we got all the data we *requested*.
99 Note: This function may block. Use it only if you're sure about the
100 amount of data you will get.
103 fd the file descriptor to read from
104 buffer pointer to a buffer of size len
105 len the requested(!) amount of bytes
107 Returns: the amount of bytes read
110 readn(int fd, void * buffer, size_t len)
112 uschar * next = buffer;
113 uschar * end = next + len;
117 ssize_t got = read(fd, next, end - next);
119 /* I'm not sure if there are signals that can interrupt us,
120 for now I assume the worst */
121 if (got == -1 && errno == EINTR) continue;
122 if (got <= 0) return next - US buffer;
130 /*************************************************
131 * Make a new address item *
132 *************************************************/
134 /* This function gets the store and initializes with default values. The
135 transport_return value defaults to DEFER, so that any unexpected failure to
136 deliver does not wipe out the message. The default unique string is set to a
137 copy of the address, so that its domain can be lowercased.
140 address the RFC822 address string
141 copy force a copy of the address
143 Returns: a pointer to an initialized address_item
147 deliver_make_addr(uschar *address, BOOL copy)
149 address_item * addr = store_get(sizeof(address_item), GET_UNTAINTED);
150 *addr = address_defaults;
151 if (copy) address = string_copy(address);
152 addr->address = address;
153 addr->unique = string_copy(address);
160 /*************************************************
161 * Set expansion values for an address *
162 *************************************************/
164 /* Certain expansion variables are valid only when handling an address or
165 address list. This function sets them up or clears the values, according to its
169 addr the address in question, or NULL to clear values
174 deliver_set_expansions(address_item *addr)
178 const uschar ***p = address_expansions;
179 while (*p) **p++ = NULL;
183 /* Exactly what gets set depends on whether there is one or more addresses, and
184 what they contain. These first ones are always set, taking their values from
185 the first address. */
187 if (!addr->host_list)
189 deliver_host = deliver_host_address = US"";
190 deliver_host_port = 0;
194 deliver_host = addr->host_list->name;
195 deliver_host_address = addr->host_list->address;
196 deliver_host_port = addr->host_list->port;
199 deliver_recipients = addr;
200 deliver_address_data = addr->prop.address_data;
201 deliver_domain_data = addr->prop.domain_data;
202 deliver_localpart_data = addr->prop.localpart_data;
203 router_var = addr->prop.variables;
205 /* These may be unset for multiple addresses */
207 deliver_domain = addr->domain;
208 self_hostname = addr->self_hostname;
210 #ifdef EXPERIMENTAL_BRIGHTMAIL
211 bmi_deliver = 1; /* deliver by default */
212 bmi_alt_location = NULL;
213 bmi_base64_verdict = NULL;
214 bmi_base64_tracker_verdict = NULL;
217 /* If there's only one address we can set everything. */
221 address_item *addr_orig;
223 deliver_localpart = addr->local_part;
224 deliver_localpart_prefix = addr->prefix;
225 deliver_localpart_prefix_v = addr->prefix_v;
226 deliver_localpart_suffix = addr->suffix;
227 deliver_localpart_suffix_v = addr->suffix_v;
229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230 deliver_domain_orig = addr_orig->domain;
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
251 deliver_domain_parent = addr->parent->domain;
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
261 if (testflag(addr, af_pfr))
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
267 deliver_localpart_prefix_v = addr->parent->prefix_v;
268 deliver_localpart_suffix = addr->parent->suffix;
269 deliver_localpart_suffix_v = addr->parent->suffix_v;
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
280 if (bmi_deliver == 1)
281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
293 if (testflag(addr, af_pfr))
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301 deliver_domain = NULL;
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
306 self_hostname = NULL;
307 if (!deliver_domain && !self_hostname) break;
315 /*************************************************
316 * Open a msglog file *
317 *************************************************/
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
324 Called from deliver_message(), can be operating as root.
327 filename the file name
328 mode the mode required
329 error used for saying what failed
331 Returns: a file descriptor, or -1 (with errno set)
335 open_msglog_file(uschar *filename, int mode, uschar **error)
337 if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
341 for (int i = 2; i > 0; i--)
343 int fd = Uopen(filename,
350 O_WRONLY|O_APPEND|O_CREAT, mode);
353 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
354 function is called as root). Double check the mode, because the group setting
355 doesn't always get set automatically. */
358 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
360 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
365 if (fchmod(fd, mode) < 0)
375 (void)directory_make(spool_directory,
376 spool_sname(US"msglog", message_subdir),
377 MSGLOG_DIRECTORY_MODE, TRUE);
380 *error = US"create or open";
387 /*************************************************
388 * Write to msglog if required *
389 *************************************************/
391 /* Write to the message log, if configured. This function may also be called
395 format a string format
401 deliver_msglog(const char *format, ...)
404 if (!message_logs) return;
405 va_start(ap, format);
406 vfprintf(message_log, format, ap);
414 /*************************************************
415 * Replicate status for batch *
416 *************************************************/
418 /* When a transport handles a batch of addresses, it may treat them
419 individually, or it may just put the status in the first one, and return FALSE,
420 requesting that the status be copied to all the others externally. This is the
421 replication function. As well as the status, it copies the transport pointer,
422 which may have changed if appendfile passed the addresses on to a different
425 Argument: pointer to the first address in a chain
430 replicate_status(address_item *addr)
432 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
434 addr2->transport = addr->transport;
435 addr2->transport_return = addr->transport_return;
436 addr2->basic_errno = addr->basic_errno;
437 addr2->more_errno = addr->more_errno;
438 addr2->delivery_time = addr->delivery_time;
439 addr2->special_action = addr->special_action;
440 addr2->message = addr->message;
441 addr2->user_message = addr->user_message;
447 /*************************************************
448 * Compare lists of hosts *
449 *************************************************/
451 /* This function is given two pointers to chains of host items, and it yields
452 TRUE if the lists refer to the same hosts in the same order, except that
454 (1) Multiple hosts with the same non-negative MX values are permitted to appear
455 in different orders. Round-robinning nameservers can cause this to happen.
457 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
458 permitted to appear in different orders. This is caused by randomizing
461 This enables Exim to use a single SMTP transaction for sending to two entirely
462 different domains that happen to end up pointing at the same hosts.
464 We do not try to batch up different A-record host names that refer to the
468 one points to the first host list
469 two points to the second host list
471 Returns: TRUE if the lists refer to the same host set
475 same_hosts(host_item *one, host_item *two)
479 if (Ustrcmp(one->name, two->name) != 0)
482 host_item *end_one = one;
483 host_item *end_two = two;
485 /* Batch up only if there was no MX and the list was not randomized */
487 if (mx == MX_NONE) return FALSE;
489 /* Find the ends of the shortest sequence of identical MX values */
491 while ( end_one->next && end_one->next->mx == mx
492 && end_two->next && end_two->next->mx == mx)
494 end_one = end_one->next;
495 end_two = end_two->next;
498 /* If there aren't any duplicates, there's no match. */
500 if (end_one == one) return FALSE;
502 /* For each host in the 'one' sequence, check that it appears in the 'two'
503 sequence, returning FALSE if not. */
508 for (hi = two; hi != end_two->next; hi = hi->next)
509 if (Ustrcmp(one->name, hi->name) == 0) break;
510 if (hi == end_two->next) return FALSE;
511 if (one == end_one) break;
515 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
516 Ensure both are pointing at the last host, and carry on as for equality. */
521 /* if the names matched but ports do not, mismatch */
522 else if (one->port != two->port)
526 /* DNSSEC equality */
527 if (one->dnssec != two->dnssec) return FALSE;
535 /* True if both are NULL */
542 /*************************************************
543 * Compare header lines *
544 *************************************************/
546 /* This function is given two pointers to chains of header items, and it yields
547 TRUE if they are the same header texts in the same order.
550 one points to the first header list
551 two points to the second header list
553 Returns: TRUE if the lists refer to the same header set
557 same_headers(header_line *one, header_line *two)
559 for (;; one = one->next, two = two->next)
561 if (one == two) return TRUE; /* Includes the case where both NULL */
562 if (!one || !two) return FALSE;
563 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
569 /*************************************************
570 * Compare string settings *
571 *************************************************/
573 /* This function is given two pointers to strings, and it returns
574 TRUE if they are the same pointer, or if the two strings are the same.
577 one points to the first string
578 two points to the second string
580 Returns: TRUE or FALSE
584 same_strings(uschar *one, uschar *two)
586 if (one == two) return TRUE; /* Includes the case where both NULL */
587 if (!one || !two) return FALSE;
588 return (Ustrcmp(one, two) == 0);
593 /*************************************************
594 * Compare uid/gid for addresses *
595 *************************************************/
597 /* This function is given a transport and two addresses. It yields TRUE if the
598 uid/gid/initgroups settings for the two addresses are going to be the same when
603 addr1 the first address
604 addr2 the second address
606 Returns: TRUE or FALSE
610 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
612 if ( !tp->uid_set && !tp->expand_uid
613 && !tp->deliver_as_creator
614 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
615 || ( testflag(addr1, af_uid_set)
616 && ( addr1->uid != addr2->uid
617 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
621 if ( !tp->gid_set && !tp->expand_gid
622 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
623 || ( testflag(addr1, af_gid_set)
624 && addr1->gid != addr2->gid
634 /*************************************************
635 * Record that an address is complete *
636 *************************************************/
638 /* This function records that an address is complete. This is straightforward
639 for most addresses, where the unique address is just the full address with the
640 domain lower cased. For homonyms (addresses that are the same as one of their
641 ancestors) their are complications. Their unique addresses have \x\ prepended
642 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
645 Exim used to record the unique addresses of homonyms as "complete". This,
646 however, fails when the pattern of redirection varies over time (e.g. if taking
647 unseen copies at only some times of day) because the prepended numbers may vary
648 from one delivery run to the next. This problem is solved by never recording
649 prepended unique addresses as complete. Instead, when a homonymic address has
650 actually been delivered via a transport, we record its basic unique address
651 followed by the name of the transport. This is checked in subsequent delivery
652 runs whenever an address is routed to a transport.
654 If the completed address is a top-level one (has no parent, which means it
655 cannot be homonymic) we also add the original address to the non-recipients
656 tree, so that it gets recorded in the spool file and therefore appears as
657 "done" in any spool listings. The original address may differ from the unique
658 address in the case of the domain.
660 Finally, this function scans the list of duplicates, marks as done any that
661 match this address, and calls child_done() for their ancestors.
664 addr address item that has been completed
665 now current time as a string
671 address_done(address_item *addr, uschar *now)
673 update_spool = TRUE; /* Ensure spool gets updated */
675 /* Top-level address */
679 tree_add_nonrecipient(addr->unique);
680 tree_add_nonrecipient(addr->address);
683 /* Homonymous child address */
685 else if (testflag(addr, af_homonym))
688 tree_add_nonrecipient(
689 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
692 /* Non-homonymous child address */
694 else tree_add_nonrecipient(addr->unique);
696 /* Check the list of duplicate addresses and ensure they are now marked
699 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
700 if (Ustrcmp(addr->unique, dup->unique) == 0)
702 tree_add_nonrecipient(dup->unique);
703 child_done(dup, now);
710 /*************************************************
711 * Decrease counts in parents and mark done *
712 *************************************************/
714 /* This function is called when an address is complete. If there is a parent
715 address, its count of children is decremented. If there are still other
716 children outstanding, the function exits. Otherwise, if the count has become
717 zero, address_done() is called to mark the parent and its duplicates complete.
718 Then loop for any earlier ancestors.
721 addr points to the completed address item
722 now the current time as a string, for writing to the message log
728 child_done(address_item *addr, uschar *now)
735 if (--addr->child_count > 0) return; /* Incomplete parent */
736 address_done(addr, now);
738 /* Log the completion of all descendents only when there is no ancestor with
739 the same original address. */
741 for (aa = addr->parent; aa; aa = aa->parent)
742 if (Ustrcmp(aa->address, addr->address) == 0) break;
745 deliver_msglog("%s %s: children all complete\n", now, addr->address);
746 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
752 /*************************************************
753 * Delivery logging support functions *
754 *************************************************/
756 /* The LOGGING() checks in d_log_interface() are complicated for backwards
757 compatibility. When outgoing interface logging was originally added, it was
758 conditional on just incoming_interface (which is off by default). The
759 outgoing_interface option is on by default to preserve this behaviour, but
760 you can enable incoming_interface and disable outgoing_interface to get I=
761 fields on incoming lines only.
765 addr The address to be logged
767 Returns: New value for s
771 d_log_interface(gstring * g)
773 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
774 && sending_ip_address)
776 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
777 if (LOGGING(outgoing_port))
778 g = string_fmt_append(g, ":%d", sending_port);
786 d_hostlog(gstring * g, address_item * addr)
788 host_item * h = addr->host_used;
790 g = string_append(g, 2, US" H=", h->name);
792 if (LOGGING(dnssec) && h->dnssec == DS_YES)
793 g = string_catn(g, US" DS", 3);
795 g = string_append(g, 3, US" [", h->address, US"]");
797 if (LOGGING(outgoing_port))
798 g = string_fmt_append(g, ":%d", h->port);
800 if (continue_sequence > 1) /*XXX this is wrong for a dropped proxyconn. Would have to pass back from transport */
801 g = string_catn(g, US"*", 1);
804 if (LOGGING(proxy) && proxy_local_address)
806 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
807 if (LOGGING(outgoing_port))
808 g = string_fmt_append(g, ":%d", proxy_local_port);
812 g = d_log_interface(g);
814 if (testflag(addr, af_tcp_fastopen))
815 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
826 d_tlslog(gstring * g, address_item * addr)
828 if (LOGGING(tls_cipher) && addr->cipher)
830 g = string_append(g, 2, US" X=", addr->cipher);
831 #ifndef DISABLE_TLS_RESUME
832 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
833 g = string_catn(g, US"*", 1);
836 if (LOGGING(tls_certificate_verified) && addr->cipher)
837 g = string_append(g, 2, US" CV=",
838 testflag(addr, af_cert_verified)
841 testflag(addr, af_dane_verified)
847 if (LOGGING(tls_peerdn) && addr->peerdn)
848 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
856 #ifndef DISABLE_EVENT
857 /* Distribute a named event to any listeners.
859 Args: action config option specifying listener
860 event name of the event
861 ev_data associated data for the event
862 errnop pointer to errno for modification, or null
864 Return: string expansion from listener, or NULL
868 event_raise(uschar * action, const uschar * event, uschar * ev_data, int * errnop)
874 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
876 action, deliver_host_address);
879 event_data = ev_data;
881 if (!(s = expand_string(action)) && *expand_string_message)
882 log_write(0, LOG_MAIN|LOG_PANIC,
883 "failed to expand event_action %s in %s: %s\n",
884 event, transport_name ? transport_name : US"main", expand_string_message);
886 event_name = event_data = NULL;
888 /* If the expansion returns anything but an empty string, flag for
889 the caller to modify his normal processing
894 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
896 *errnop = ERRNO_EVENT;
904 msg_event_raise(const uschar * event, const address_item * addr)
906 const uschar * save_domain = deliver_domain;
907 uschar * save_local = deliver_localpart;
908 const uschar * save_host = deliver_host;
909 const uschar * save_address = deliver_host_address;
910 const int save_port = deliver_host_port;
912 router_name = addr->router ? addr->router->name : NULL;
913 deliver_domain = addr->domain;
914 deliver_localpart = addr->local_part;
915 deliver_host = addr->host_used ? addr->host_used->name : NULL;
917 if (!addr->transport)
919 if (Ustrcmp(event, "msg:fail:delivery") == 0)
921 /* An address failed with no transport involved. This happens when
922 a filter was used which triggered a fail command (in such a case
923 a transport isn't needed). Convert it to an internal fail event. */
925 (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
930 transport_name = addr->transport->name;
932 (void) event_raise(addr->transport->event_action, event,
934 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
935 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
936 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
937 ? addr->message : NULL,
941 deliver_host_port = save_port;
942 deliver_host_address = save_address;
943 deliver_host = save_host;
944 deliver_localpart = save_local;
945 deliver_domain = save_domain;
946 router_name = transport_name = NULL;
948 #endif /*DISABLE_EVENT*/
952 /******************************************************************************/
955 /*************************************************
956 * Generate local prt for logging *
957 *************************************************/
959 /* This function is a subroutine for use in string_log_address() below.
962 addr the address being logged
963 yield the current dynamic buffer pointer
965 Returns: the new value of the buffer pointer
969 string_get_localpart(address_item * addr, gstring * yield)
974 if (testflag(addr, af_include_affixes) && s)
977 if (testflag(addr, af_utf8_downcvt))
978 s = string_localpart_utf8_to_alabel(s, NULL);
980 yield = string_cat(yield, s);
983 s = addr->local_part;
985 if (testflag(addr, af_utf8_downcvt))
986 s = string_localpart_utf8_to_alabel(s, NULL);
988 yield = string_cat(yield, s);
991 if (testflag(addr, af_include_affixes) && s)
994 if (testflag(addr, af_utf8_downcvt))
995 s = string_localpart_utf8_to_alabel(s, NULL);
997 yield = string_cat(yield, s);
1004 /*************************************************
1005 * Generate log address list *
1006 *************************************************/
1008 /* This function generates a list consisting of an address and its parents, for
1009 use in logging lines. For saved onetime aliased addresses, the onetime parent
1010 field is used. If the address was delivered by a transport with rcpt_include_
1011 affixes set, the af_include_affixes bit will be set in the address. In that
1012 case, we include the affixes here too.
1015 g points to growing-string struct
1016 addr bottom (ultimate) address
1017 all_parents if TRUE, include all parents
1018 success TRUE for successful delivery
1020 Returns: a growable string in dynamic store
1024 string_log_address(gstring * g,
1025 address_item *addr, BOOL all_parents, BOOL success)
1027 BOOL add_topaddr = TRUE;
1028 address_item *topaddr;
1030 /* Find the ultimate parent */
1032 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1034 /* We start with just the local part for pipe, file, and reply deliveries, and
1035 for successful local deliveries from routers that have the log_as_local flag
1036 set. File deliveries from filters can be specified as non-absolute paths in
1037 cases where the transport is going to complete the path. If there is an error
1038 before this happens (expansion failure) the local part will not be updated, and
1039 so won't necessarily look like a path. Add extra text for this case. */
1041 if ( testflag(addr, af_pfr)
1043 && addr->router && addr->router->log_as_local
1044 && addr->transport && addr->transport->info->local
1047 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1048 g = string_catn(g, CUS"save ", 5);
1049 g = string_get_localpart(addr, g);
1052 /* Other deliveries start with the full address. It we have split it into local
1053 part and domain, use those fields. Some early failures can happen before the
1054 splitting is done; in those cases use the original field. */
1059 int off = g->ptr; /* start of the "full address" */
1061 if (addr->local_part)
1064 g = string_get_localpart(addr, g);
1065 g = string_catn(g, US"@", 1);
1068 if (testflag(addr, af_utf8_downcvt))
1069 s = string_localpart_utf8_to_alabel(s, NULL);
1071 g = string_cat(g, s);
1074 g = string_cat(g, addr->address);
1076 /* If the address we are going to print is the same as the top address,
1077 and all parents are not being included, don't add on the top address. First
1078 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1079 on the local parts. */
1081 cmp = g->s + off; /* only now, as rebuffer likely done */
1082 string_from_gstring(g); /* ensure nul-terminated */
1083 if ( strcmpic(cmp, topaddr->address) == 0
1084 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1085 && !addr->onetime_parent
1086 && (!all_parents || !addr->parent || addr->parent == topaddr)
1088 add_topaddr = FALSE;
1091 /* If all parents are requested, or this is a local pipe/file/reply, and
1092 there is at least one intermediate parent, show it in brackets, and continue
1093 with all of them if all are wanted. */
1095 if ( (all_parents || testflag(addr, af_pfr))
1097 && addr->parent != topaddr)
1100 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1102 g = string_catn(g, s, 2);
1103 g = string_cat (g, addr2->address);
1104 if (!all_parents) break;
1107 g = string_catn(g, US")", 1);
1110 /* Add the top address if it is required */
1113 g = string_append(g, 3,
1115 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1123 /******************************************************************************/
1127 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1128 this is a nonstandard call; no two-character delivery flag is written
1129 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1132 flags passed to log_write()
1135 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1137 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1140 /* Log the delivery on the main log. We use an extensible string to build up
1141 the log line, and reset the store afterwards. Remote deliveries should always
1142 have a pointer to the host item that succeeded; local deliveries can have a
1143 pointer to a single host item in their host list, for use by the transport. */
1145 #ifndef DISABLE_EVENT
1146 /* presume no successful remote delivery */
1147 lookup_dnssec_authenticated = NULL;
1150 reset_point = store_mark();
1151 g = string_get_tainted(256, GET_TAINTED); /* addrs will be tainted, so avoid copy */
1154 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1157 g->s[0] = logchar; g->ptr = 1;
1158 g = string_catn(g, US"> ", 2);
1160 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1162 if (LOGGING(sender_on_delivery) || msg)
1163 g = string_append(g, 3, US" F=<",
1165 testflag(addr, af_utf8_downcvt)
1166 ? string_address_utf8_to_alabel(sender_address, NULL)
1173 g = string_append(g, 2, US" Q=", queue_name);
1175 /* You might think that the return path must always be set for a successful
1176 delivery; indeed, I did for some time, until this statement crashed. The case
1177 when it is not set is for a delivery to /dev/null which is optimised by not
1178 being run at all. */
1180 if (used_return_path && LOGGING(return_path_on_delivery))
1181 g = string_append(g, 3, US" P=<", used_return_path, US">");
1184 g = string_append(g, 2, US" ", msg);
1186 /* For a delivery from a system filter, there may not be a router */
1188 g = string_append(g, 2, US" R=", addr->router->name);
1190 g = string_append(g, 2, US" T=", addr->transport->name);
1192 if (LOGGING(delivery_size))
1193 g = string_fmt_append(g, " S=%d", transport_count);
1195 /* Local delivery */
1197 if (addr->transport->info->local)
1199 if (addr->host_list)
1200 g = string_append(g, 2, US" H=", addr->host_list->name);
1201 g = d_log_interface(g);
1202 if (addr->shadow_message)
1203 g = string_cat(g, addr->shadow_message);
1206 /* Remote delivery */
1210 if (addr->host_used)
1212 g = d_hostlog(g, addr);
1214 #ifndef DISABLE_EVENT
1215 deliver_host_address = addr->host_used->address;
1216 deliver_host_port = addr->host_used->port;
1217 deliver_host = addr->host_used->name;
1219 /* DNS lookup status */
1220 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1221 : addr->host_used->dnssec==DS_NO ? US"no"
1227 g = d_tlslog(g, addr);
1230 if (addr->authenticator)
1232 g = string_append(g, 2, US" A=", addr->authenticator);
1235 g = string_append(g, 2, US":", addr->auth_id);
1236 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1237 g = string_append(g, 2, US":", addr->auth_sndr);
1241 if (LOGGING(pipelining))
1243 if (testflag(addr, af_pipelining))
1244 g = string_catn(g, US" L", 2);
1245 #ifndef DISABLE_PIPE_CONNECT
1246 if (testflag(addr, af_early_pipe))
1247 g = string_catn(g, US"*", 1);
1251 #ifndef DISABLE_PRDR
1252 if (testflag(addr, af_prdr_used))
1253 g = string_catn(g, US" PRDR", 5);
1256 if (testflag(addr, af_chunking_used))
1257 g = string_catn(g, US" K", 2);
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, "%s", string_from_gstring(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 (void) string_from_gstring(g);
1354 /* Log the deferment in the message log, but don't clutter it
1355 up with retry-time defers after the first delivery attempt. */
1357 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1358 deliver_msglog("%s %s\n", now, g->s);
1360 /* Write the main log and reset the store.
1361 For errors of the type "retry time not reached" (also remotes skipped
1362 on queue run), logging is controlled by L_retry_defer. Note that this kind
1363 of error number is negative, and all the retry ones are less than any
1367 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1370 store_reset(reset_point);
1377 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1379 rmark reset_point = store_mark();
1380 gstring * g = string_get(256);
1382 #ifndef DISABLE_EVENT
1383 /* Message failures for which we will send a DSN get their event raised
1384 later so avoid doing it here. */
1386 if ( !addr->prop.ignore_error
1387 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1389 msg_event_raise(US"msg:fail:delivery", addr);
1392 /* Build up the log line for the message and main logs */
1394 /* Create the address string for logging. Must not do this earlier, because
1395 an OK result may be changed to FAIL when a pipe returns text. */
1397 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1399 if (LOGGING(sender_on_delivery))
1400 g = string_append(g, 3, US" F=<", sender_address, US">");
1403 g = string_append(g, 2, US" Q=", queue_name);
1405 /* Return path may not be set if no delivery actually happened */
1407 if (used_return_path && LOGGING(return_path_on_delivery))
1408 g = string_append(g, 3, US" P=<", used_return_path, US">");
1411 g = string_append(g, 2, US" R=", addr->router->name);
1412 if (addr->transport)
1413 g = string_append(g, 2, US" T=", addr->transport->name);
1415 if (addr->host_used)
1416 g = d_hostlog(g, addr);
1419 g = d_tlslog(g, addr);
1422 if (addr->basic_errno > 0)
1423 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1426 g = string_append(g, 2, US": ", addr->message);
1428 if (LOGGING(deliver_time))
1429 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1431 (void) string_from_gstring(g);
1433 /* Do the logging. For the message log, "routing failed" for those cases,
1434 just to make it clearer. */
1437 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1439 deliver_msglog("%s %s\n", now, g->s);
1441 log_write(0, LOG_MAIN, "** %s", g->s);
1443 store_reset(reset_point);
1449 /*************************************************
1450 * Actions at the end of handling an address *
1451 *************************************************/
1453 /* This is a function for processing a single address when all that can be done
1454 with it has been done.
1457 addr points to the address block
1458 result the result of the delivery attempt
1459 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1460 driver_type indicates which type of driver (transport, or router) was last
1461 to process the address
1462 logchar '=' or '-' for use when logging deliveries with => or ->
1468 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1471 uschar *now = tod_stamp(tod_log);
1472 uschar *driver_kind = NULL;
1473 uschar *driver_name = NULL;
1475 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1477 /* Set up driver kind and name for logging. Disable logging if the router or
1478 transport has disabled it. */
1480 if (driver_type == EXIM_DTYPE_TRANSPORT)
1482 if (addr->transport)
1484 driver_name = addr->transport->name;
1485 driver_kind = US" transport";
1486 f.disable_logging = addr->transport->disable_logging;
1488 else driver_kind = US"transporting";
1490 else if (driver_type == EXIM_DTYPE_ROUTER)
1494 driver_name = addr->router->name;
1495 driver_kind = US" router";
1496 f.disable_logging = addr->router->disable_logging;
1498 else driver_kind = US"routing";
1501 /* If there's an error message set, ensure that it contains only printing
1502 characters - it should, but occasionally things slip in and this at least
1503 stops the log format from getting wrecked. We also scan the message for an LDAP
1504 expansion item that has a password setting, and flatten the password. This is a
1505 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1506 malformed, it won't ever have gone near LDAP.) */
1510 const uschar * s = string_printing(addr->message);
1512 /* deconst cast ok as string_printing known to have alloc'n'copied */
1513 addr->message = expand_hide_passwords(US s);
1516 /* If we used a transport that has one of the "return_output" options set, and
1517 if it did in fact generate some output, then for return_output we treat the
1518 message as failed if it was not already set that way, so that the output gets
1519 returned to the sender, provided there is a sender to send it to. For
1520 return_fail_output, do this only if the delivery failed. Otherwise we just
1521 unlink the file, and remove the name so that if the delivery failed, we don't
1522 try to send back an empty or unwanted file. The log_output options operate only
1523 on a non-empty file.
1525 In any case, we close the message file, because we cannot afford to leave a
1526 file-descriptor for one address while processing (maybe very many) others. */
1528 if (addr->return_file >= 0 && addr->return_filename)
1530 BOOL return_output = FALSE;
1531 struct stat statbuf;
1532 (void)EXIMfsync(addr->return_file);
1534 /* If there is no output, do nothing. */
1536 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1538 transport_instance *tb = addr->transport;
1540 /* Handle logging options */
1543 || result == FAIL && tb->log_fail_output
1544 || result == DEFER && tb->log_defer_output
1548 FILE *f = Ufopen(addr->return_filename, "rb");
1550 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1551 "from %s transport: %s", addr->return_filename, tb->name,
1554 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1556 uschar *p = big_buffer + Ustrlen(big_buffer);
1558 while (p > big_buffer && isspace(p[-1])) p--;
1560 sp = string_printing(big_buffer);
1561 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1562 addr->address, tb->name, sp);
1567 /* Handle returning options, but only if there is an address to return
1570 if (sender_address[0] != 0 || addr->prop.errors_address)
1571 if (tb->return_output)
1573 addr->transport_return = result = FAIL;
1574 if (addr->basic_errno == 0 && !addr->message)
1575 addr->message = US"return message generated";
1576 return_output = TRUE;
1579 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1582 /* Get rid of the file unless it might be returned, but close it in
1587 Uunlink(addr->return_filename);
1588 addr->return_filename = NULL;
1589 addr->return_file = -1;
1592 (void)close(addr->return_file);
1595 /* Check if the transport notifed continue-conn status explicitly, and
1596 update our knowlege. */
1598 if (testflag(addr, af_new_conn)) continue_sequence = 1;
1599 else if (testflag(addr, af_cont_conn)) continue_sequence++;
1601 /* The success case happens only after delivery by a transport. */
1605 addr->next = addr_succeed;
1606 addr_succeed = addr;
1608 /* Call address_done() to ensure that we don't deliver to this address again,
1609 and write appropriate things to the message log. If it is a child address, we
1610 call child_done() to scan the ancestors and mark them complete if this is the
1611 last child to complete. */
1613 address_done(addr, now);
1614 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1617 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1618 driver_name, driver_kind);
1621 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1622 addr->parent->address, driver_name, driver_kind);
1623 child_done(addr, now);
1626 /* Certificates for logging (via events) */
1628 tls_out.ourcert = addr->ourcert;
1629 addr->ourcert = NULL;
1630 tls_out.peercert = addr->peercert;
1631 addr->peercert = NULL;
1633 tls_out.ver = addr->tlsver;
1634 tls_out.cipher = addr->cipher;
1635 tls_out.peerdn = addr->peerdn;
1636 tls_out.ocsp = addr->ocsp;
1637 # ifdef SUPPORT_DANE
1638 tls_out.dane_verified = testflag(addr, af_dane_verified);
1642 delivery_log(LOG_MAIN, addr, logchar, NULL);
1645 tls_free_cert(&tls_out.ourcert);
1646 tls_free_cert(&tls_out.peercert);
1648 tls_out.cipher = NULL;
1649 tls_out.peerdn = NULL;
1650 tls_out.ocsp = OCSP_NOT_REQ;
1651 # ifdef SUPPORT_DANE
1652 tls_out.dane_verified = FALSE;
1658 /* Soft failure, or local delivery process failed; freezing may be
1661 else if (result == DEFER || result == PANIC)
1663 if (result == PANIC) logflags |= LOG_PANIC;
1665 /* This puts them on the chain in reverse order. Do not change this, because
1666 the code for handling retries assumes that the one with the retry
1667 information is last. */
1669 addr->next = addr_defer;
1672 /* The only currently implemented special action is to freeze the
1673 message. Logging of this is done later, just before the -H file is
1676 if (addr->special_action == SPECIAL_FREEZE)
1678 f.deliver_freeze = TRUE;
1679 deliver_frozen_at = time(NULL);
1680 update_spool = TRUE;
1683 /* If doing a 2-stage queue run, we skip writing to either the message
1684 log or the main log for SMTP defers. */
1686 if (!f.queue_2stage || addr->basic_errno != 0)
1687 deferral_log(addr, now, logflags, driver_name, driver_kind);
1691 /* Hard failure. If there is an address to which an error message can be sent,
1692 put this address on the failed list. If not, put it on the deferred list and
1693 freeze the mail message for human attention. The latter action can also be
1694 explicitly requested by a router or transport. */
1698 /* If this is a delivery error, or a message for which no replies are
1699 wanted, and the message's age is greater than ignore_bounce_errors_after,
1700 force the af_ignore_error flag. This will cause the address to be discarded
1701 later (with a log entry). */
1703 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1704 addr->prop.ignore_error = TRUE;
1706 /* Freeze the message if requested, or if this is a bounce message (or other
1707 message with null sender) and this address does not have its own errors
1708 address. However, don't freeze if errors are being ignored. The actual code
1709 to ignore occurs later, instead of sending a message. Logging of freezing
1710 occurs later, just before writing the -H file. */
1712 if ( !addr->prop.ignore_error
1713 && ( addr->special_action == SPECIAL_FREEZE
1714 || (sender_address[0] == 0 && !addr->prop.errors_address)
1717 frozen_info = addr->special_action == SPECIAL_FREEZE
1719 : f.sender_local && !f.local_error_message
1720 ? US" (message created with -f <>)"
1721 : US" (delivery error message)";
1722 f.deliver_freeze = TRUE;
1723 deliver_frozen_at = time(NULL);
1724 update_spool = TRUE;
1726 /* The address is put on the defer rather than the failed queue, because
1727 the message is being retained. */
1729 addr->next = addr_defer;
1733 /* Don't put the address on the nonrecipients tree yet; wait until an
1734 error message has been successfully sent. */
1738 addr->next = addr_failed;
1742 failure_log(addr, driver_name ? NULL : driver_kind, now);
1745 /* Ensure logging is turned on again in all cases */
1747 f.disable_logging = FALSE;
1753 /*************************************************
1754 * Address-independent error *
1755 *************************************************/
1757 /* This function is called when there's an error that is not dependent on a
1758 particular address, such as an expansion string failure. It puts the error into
1759 all the addresses in a batch, logs the incident on the main and panic logs, and
1760 clears the expansions. It is mostly called from local_deliver(), but can be
1761 called for a remote delivery via findugid().
1764 logit TRUE if (MAIN+PANIC) logging required
1765 addr the first of the chain of addresses
1767 format format string for error message, or NULL if already set in addr
1768 ... arguments for the format
1774 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1776 addr->basic_errno = code;
1783 va_start(ap, format);
1784 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1786 addr->message = string_from_gstring(g);
1789 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1791 addr2->basic_errno = code;
1792 addr2->message = addr->message;
1795 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1796 deliver_set_expansions(NULL);
1802 /*************************************************
1803 * Check a "never users" list *
1804 *************************************************/
1806 /* This function is called to check whether a uid is on one of the two "never
1810 uid the uid to be checked
1811 nusers the list to be scanned; the first item in the list is the count
1813 Returns: TRUE if the uid is on the list
1817 check_never_users(uid_t uid, uid_t *nusers)
1819 if (!nusers) return FALSE;
1820 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1826 /*************************************************
1827 * Find uid and gid for a transport *
1828 *************************************************/
1830 /* This function is called for both local and remote deliveries, to find the
1831 uid/gid under which to run the delivery. The values are taken preferentially
1832 from the transport (either explicit or deliver_as_creator), then from the
1833 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1834 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1835 panic error is logged, and the function fails (which normally leads to delivery
1839 addr the address (possibly a chain)
1841 uidp pointer to uid field
1842 gidp pointer to gid field
1843 igfp pointer to the use_initgroups field
1845 Returns: FALSE if failed - error has been set in address(es)
1849 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1853 BOOL gid_set = FALSE;
1855 /* Default initgroups flag comes from the transport */
1857 *igfp = tp->initgroups;
1859 /* First see if there's a gid on the transport, either fixed or expandable.
1860 The expanding function always logs failure itself. */
1867 else if (tp->expand_gid)
1869 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1872 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1878 /* If the transport did not set a group, see if the router did. */
1880 if (!gid_set && testflag(addr, af_gid_set))
1886 /* Pick up a uid from the transport if one is set. */
1888 if (tp->uid_set) *uidp = tp->uid;
1890 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1891 it does not provide a passwd value from which a gid can be taken. */
1893 else if (tp->expand_uid)
1896 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1897 uidp, &(addr->message)))
1899 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1909 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1911 else if (tp->deliver_as_creator)
1913 *uidp = originator_uid;
1916 *gidp = originator_gid;
1921 /* Otherwise see if the address specifies the uid and if so, take it and its
1924 else if (testflag(addr, af_uid_set))
1927 *igfp = testflag(addr, af_initgroups);
1930 /* Nothing has specified the uid - default to the Exim user, and group if the
1943 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1944 defaulting to the Exim uid. In other words, if the configuration has specified
1945 a uid, it must also provide a gid. */
1949 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1950 "%s transport", tp->name);
1954 /* Check that the uid is not on the lists of banned uids that may not be used
1955 for delivery processes. */
1957 nuname = check_never_users(*uidp, never_users)
1959 : check_never_users(*uidp, fixed_never_users)
1960 ? US"fixed_never_users"
1964 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1965 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1977 /*************************************************
1978 * Check the size of a message for a transport *
1979 *************************************************/
1981 /* Checks that the message isn't too big for the selected transport.
1982 This is called only when it is known that the limit is set.
1986 addr the (first) address being delivered
1989 DEFER expansion failed or did not yield an integer
1990 FAIL message too big
1994 check_message_size(transport_instance *tp, address_item *addr)
1999 deliver_set_expansions(addr);
2000 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2001 deliver_set_expansions(NULL);
2003 if (expand_string_message)
2006 addr->message = size_limit == -1
2007 ? string_sprintf("failed to expand message_size_limit "
2008 "in %s transport: %s", tp->name, expand_string_message)
2009 : string_sprintf("invalid message_size_limit "
2010 "in %s transport: %s", tp->name, expand_string_message);
2012 else if (size_limit > 0 && message_size > size_limit)
2016 string_sprintf("message is too big (transport limit = %d)",
2025 /*************************************************
2026 * Transport-time check for a previous delivery *
2027 *************************************************/
2029 /* Check that this base address hasn't previously been delivered to its routed
2030 transport. If it has been delivered, mark it done. The check is necessary at
2031 delivery time in order to handle homonymic addresses correctly in cases where
2032 the pattern of redirection changes between delivery attempts (so the unique
2033 fields change). Non-homonymic previous delivery is detected earlier, at routing
2034 time (which saves unnecessary routing).
2037 addr the address item
2038 testing TRUE if testing wanted only, without side effects
2040 Returns: TRUE if previously delivered by the transport
2044 previously_transported(address_item *addr, BOOL testing)
2046 uschar * s = string_sprintf("%s/%s",
2047 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2049 if (tree_search(tree_nonrecipients, s) != 0)
2051 DEBUG(D_deliver|D_route|D_transport)
2052 debug_printf("%s was previously delivered (%s transport): discarded\n",
2053 addr->address, addr->transport->name);
2054 if (!testing) child_done(addr, tod_stamp(tod_log));
2063 /******************************************************
2064 * Check for a given header in a header string *
2065 ******************************************************/
2067 /* This function is used when generating quota warnings. The configuration may
2068 specify any header lines it likes in quota_warn_message. If certain of them are
2069 missing, defaults are inserted, so we need to be able to test for the presence
2073 hdr the required header name
2074 hstring the header string
2076 Returns: TRUE the header is in the string
2077 FALSE the header is not in the string
2081 contains_header(uschar *hdr, uschar *hstring)
2083 int len = Ustrlen(hdr);
2084 uschar *p = hstring;
2087 if (strncmpic(p, hdr, len) == 0)
2090 while (*p == ' ' || *p == '\t') p++;
2091 if (*p == ':') return TRUE;
2093 while (*p != 0 && *p != '\n') p++;
2094 if (*p == '\n') p++;
2102 /*************************************************
2103 * Perform a local delivery *
2104 *************************************************/
2106 /* Each local delivery is performed in a separate process which sets its
2107 uid and gid as specified. This is a safer way than simply changing and
2108 restoring using seteuid(); there is a body of opinion that seteuid()
2109 cannot be used safely. From release 4, Exim no longer makes any use of
2110 it for delivery. Besides, not all systems have seteuid().
2112 If the uid/gid are specified in the transport_instance, they are used; the
2113 transport initialization must ensure that either both or neither are set.
2114 Otherwise, the values associated with the address are used. If neither are set,
2115 it is a configuration error.
2117 The transport or the address may specify a home directory (transport over-
2118 rides), and if they do, this is set as $home. If neither have set a working
2119 directory, this value is used for that as well. Otherwise $home is left unset
2120 and the cwd is set to "/" - a directory that should be accessible to all users.
2122 Using a separate process makes it more complicated to get error information
2123 back. We use a pipe to pass the return code and also an error code and error
2124 text string back to the parent process.
2127 addr points to an address block for this delivery; for "normal" local
2128 deliveries this is the only address to be delivered, but for
2129 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2130 a number of addresses can be handled simultaneously, and in this
2131 case addr will point to a chain of addresses with the same
2134 shadowing TRUE if running a shadow transport; this causes output from pipes
2141 deliver_local(address_item *addr, BOOL shadowing)
2143 BOOL use_initgroups;
2146 int status, len, rc;
2149 uschar *working_directory;
2150 address_item *addr2;
2151 transport_instance *tp = addr->transport;
2153 /* Set up the return path from the errors or sender address. If the transport
2154 has its own return path setting, expand it and replace the existing value. */
2156 if(addr->prop.errors_address)
2157 return_path = addr->prop.errors_address;
2159 return_path = sender_address;
2161 if (tp->return_path)
2163 uschar * new_return_path = expand_string(tp->return_path);
2164 if (new_return_path)
2165 return_path = new_return_path;
2166 else if (!f.expand_string_forcedfail)
2168 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2169 US"Failed to expand return path \"%s\" in %s transport: %s",
2170 tp->return_path, tp->name, expand_string_message);
2175 /* For local deliveries, one at a time, the value used for logging can just be
2176 set directly, once and for all. */
2178 used_return_path = return_path;
2180 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2181 gets put into the address(es), and the expansions are unset, so we can just
2184 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2186 /* See if either the transport or the address specifies a home directory. A
2187 home directory set in the address may already be expanded; a flag is set to
2188 indicate that. In other cases we must expand it. */
2190 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2191 || ( (deliver_home = addr->home_dir) /* Set in address and */
2192 && !testflag(addr, af_home_expanded) /* not expanded */
2195 uschar *rawhome = deliver_home;
2196 deliver_home = NULL; /* in case it contains $home */
2197 if (!(deliver_home = expand_string(rawhome)))
2199 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2200 "to expand for %s transport: %s", rawhome, tp->name,
2201 expand_string_message);
2204 if (*deliver_home != '/')
2206 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2207 "is not absolute for %s transport", deliver_home, tp->name);
2212 /* See if either the transport or the address specifies a current directory,
2213 and if so, expand it. If nothing is set, use the home directory, unless it is
2214 also unset in which case use "/", which is assumed to be a directory to which
2215 all users have access. It is necessary to be in a visible directory for some
2216 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2217 2.5) require this. */
2219 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2220 if (working_directory)
2222 uschar *raw = working_directory;
2223 if (!(working_directory = expand_string(raw)))
2225 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2226 "failed to expand for %s transport: %s", raw, tp->name,
2227 expand_string_message);
2230 if (*working_directory != '/')
2232 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2233 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2237 else working_directory = deliver_home ? deliver_home : US"/";
2239 /* If one of the return_output flags is set on the transport, create and open a
2240 file in the message log directory for the transport to write its output onto.
2241 This is mainly used by pipe transports. The file needs to be unique to the
2242 address. This feature is not available for shadow transports. */
2245 && ( tp->return_output || tp->return_fail_output
2246 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2251 addr->return_filename =
2252 spool_fname(US"msglog", message_subdir, message_id,
2253 string_sprintf("-%d-%d", getpid(), return_count++));
2255 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2257 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2258 "to return message: %s", error, tp->name, strerror(errno));
2263 /* Create the pipe for inter-process communication. */
2267 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2272 /* Now fork the process to do the real work in the subprocess, but first
2273 ensure that all cached resources are freed so that the subprocess starts with
2274 a clean slate and doesn't interfere with the parent process. */
2278 if ((pid = exim_fork(US"delivery-local")) == 0)
2280 BOOL replicate = TRUE;
2282 /* Prevent core dumps, as we don't want them in users' home directories.
2283 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2284 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2285 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2286 complain if the error is "not supported".
2288 There are two scenarios where changing the max limit has an effect. In one,
2289 the user is using a .forward and invoking a command of their choice via pipe;
2290 for these, we do need the max limit to be 0 unless the admin chooses to
2291 permit an increased limit. In the other, the command is invoked directly by
2292 the transport and is under administrator control, thus being able to raise
2293 the limit aids in debugging. So there's no general always-right answer.
2295 Thus we inhibit core-dumps completely but let individual transports, while
2296 still root, re-raise the limits back up to aid debugging. We make the
2297 default be no core-dumps -- few enough people can use core dumps in
2298 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2305 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2307 # ifdef SETRLIMIT_NOT_SUPPORTED
2308 if (errno != ENOSYS && errno != ENOTSUP)
2310 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2315 /* Reset the random number generator, so different processes don't all
2316 have the same sequence. */
2320 /* If the transport has a setup entry, call this first, while still
2321 privileged. (Appendfile uses this to expand quota, for example, while
2322 able to read private files.) */
2324 if (addr->transport->setup)
2325 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2329 addr->transport_return = DEFER;
2333 addr->transport_return = PANIC;
2337 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2338 when the process becomes unprivileged, it won't be able to write to the
2339 process log. SIGHUP is ignored throughout exim, except when it is being
2342 signal(SIGINT, SIG_IGN);
2343 signal(SIGTERM, SIG_IGN);
2344 signal(SIGUSR1, SIG_IGN);
2346 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2347 half - for transports that exec things (e.g. pipe). Then set the required
2350 (void)close(pfd[pipe_read]);
2351 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2353 exim_setugid(uid, gid, use_initgroups,
2354 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2355 addr->address, addr->transport->name));
2359 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2360 for (address_item * batched = addr->next; batched; batched = batched->next)
2361 debug_printf("additional batched address: %s\n", batched->address);
2364 /* Set an appropriate working directory. */
2366 if (Uchdir(working_directory) < 0)
2368 addr->transport_return = DEFER;
2369 addr->basic_errno = errno;
2370 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2373 /* If successful, call the transport */
2378 set_process_info("delivering %s to %s using %s", message_id,
2379 addr->local_part, tp->name);
2381 /* Setting these globals in the subprocess means we need never clear them */
2382 transport_name = addr->transport->name;
2383 driver_srcfile = tp->srcfile;
2384 driver_srcline = tp->srcline;
2386 /* If a transport filter has been specified, set up its argument list.
2387 Any errors will get put into the address, and FALSE yielded. */
2389 if (tp->filter_command)
2391 ok = transport_set_up_command(&transport_filter_argv,
2393 TRUE, PANIC, addr, US"transport filter", NULL);
2394 transport_filter_timeout = tp->filter_timeout;
2396 else transport_filter_argv = NULL;
2400 debug_print_string(tp->debug_string);
2401 replicate = !(tp->info->code)(addr->transport, addr);
2405 /* Pass the results back down the pipe. If necessary, first replicate the
2406 status in the top address to the others in the batch. The label is the
2407 subject of a goto when a call to the transport's setup function fails. We
2408 pass the pointer to the transport back in case it got changed as a result of
2409 file_format in appendfile. */
2413 if (replicate) replicate_status(addr);
2414 for (addr2 = addr; addr2; addr2 = addr2->next)
2417 int local_part_length = Ustrlen(addr2->local_part);
2421 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2422 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2423 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2424 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2425 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2426 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2427 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2428 || (ret = write(pfd[pipe_write], &addr2->transport,
2429 sizeof(transport_instance *))) != sizeof(transport_instance *)
2431 /* For a file delivery, pass back the local part, in case the original
2432 was only part of the final delivery path. This gives more complete
2435 || (testflag(addr2, af_file)
2436 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2437 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2441 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2442 ret == -1 ? strerror(errno) : "short write");
2444 /* Now any messages */
2446 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2448 int message_length = s ? Ustrlen(s) + 1 : 0;
2449 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2450 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2452 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2453 ret == -1 ? strerror(errno) : "short write");
2457 /* OK, this process is now done. Free any cached resources that it opened,
2458 and close the pipe we were writing down before exiting. */
2460 (void)close(pfd[pipe_write]);
2465 /* Back in the main process: panic if the fork did not succeed. This seems
2466 better than returning an error - if forking is failing it is probably best
2467 not to try other deliveries for this message. */
2470 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2473 /* Read the pipe to get the delivery status codes and error messages. Our copy
2474 of the writing end must be closed first, as otherwise read() won't return zero
2475 on an empty pipe. We check that a status exists for each address before
2476 overwriting the address structure. If data is missing, the default DEFER status
2477 will remain. Afterwards, close the reading end. */
2479 (void)close(pfd[pipe_write]);
2481 for (addr2 = addr; addr2; addr2 = addr2->next)
2483 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2488 addr2->transport_return = status;
2489 len = read(pfd[pipe_read], &transport_count,
2490 sizeof(transport_count));
2491 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2492 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2493 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2494 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2495 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2496 len = read(pfd[pipe_read], &addr2->transport,
2497 sizeof(transport_instance *));
2499 if (testflag(addr2, af_file))
2502 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2503 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2506 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2507 " from delivery subprocess");
2510 /* sanity-checked llen so disable the Coverity error */
2511 /* coverity[tainted_data] */
2512 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2514 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2515 " from delivery subprocess");
2518 big_buffer[llen] = 0;
2519 addr2->local_part = string_copy(big_buffer);
2522 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2525 len = read(pfd[pipe_read], &message_length, sizeof(int));
2526 if (message_length > 0)
2528 len = read(pfd[pipe_read], big_buffer, message_length);
2529 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2530 if (len > 0) *sptr = string_copy(big_buffer);
2537 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2538 "from delivery subprocess", addr2->unique);
2543 (void)close(pfd[pipe_read]);
2545 /* Unless shadowing, write all successful addresses immediately to the journal
2546 file, to ensure they are recorded asap. For homonymic addresses, use the base
2547 address plus the transport name. Failure to write the journal is panic-worthy,
2548 but don't stop, as it may prove possible subsequently to update the spool file
2549 in order to record the delivery. */
2553 for (addr2 = addr; addr2; addr2 = addr2->next)
2554 if (addr2->transport_return == OK)
2556 if (testflag(addr2, af_homonym))
2557 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2559 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2561 /* In the test harness, wait just a bit to let the subprocess finish off
2562 any debug output etc first. */
2564 testharness_pause_ms(300);
2566 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2567 len = Ustrlen(big_buffer);
2568 if (write(journal_fd, big_buffer, len) != len)
2569 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2570 big_buffer, strerror(errno));
2573 /* Ensure the journal file is pushed out to disk. */
2575 if (EXIMfsync(journal_fd) < 0)
2576 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2580 /* Wait for the process to finish. If it terminates with a non-zero code,
2581 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2582 status values of all the addresses as they are. Take care to handle the case
2583 when the subprocess doesn't seem to exist. This has been seen on one system
2584 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2585 happens, wait() doesn't recognize the termination of child processes. Exim now
2586 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2588 while ((rc = wait(&status)) != pid)
2589 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2591 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2592 addr->transport->driver_name);
2597 if ((status & 0xffff) != 0)
2599 int msb = (status >> 8) & 255;
2600 int lsb = status & 255;
2601 int code = (msb == 0)? (lsb & 0x7f) : msb;
2602 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2603 addr->special_action = SPECIAL_FREEZE;
2604 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2605 "status 0x%04x: %s %d",
2606 addr->transport->driver_name,
2608 msb == 0 ? "terminated by signal" : "exit code",
2612 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2614 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2617 uschar *warn_message;
2620 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2622 if (!(warn_message = expand_string(addr->transport->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;
2650 /* Check transport for the given concurrency limit. Return TRUE if over
2651 the limit (or an expansion failure), else FALSE and if there was a limit,
2652 the key for the hints database used for the concurrency count. */
2655 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2657 unsigned max_parallel;
2659 if (!tp->max_parallel) return FALSE;
2661 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2662 if (expand_string_message)
2664 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2665 "in %s transport (%s): %s", tp->name, addr->address,
2666 expand_string_message);
2670 if (max_parallel > 0)
2672 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2673 if (!enq_start(serialize_key, max_parallel))
2675 address_item * next;
2677 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2678 tp->name, max_parallel);
2682 addr->message = US"concurrency limit reached for transport";
2683 addr->basic_errno = ERRNO_TRETRY;
2684 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2685 } while ((addr = next));
2688 *key = serialize_key;
2695 /*************************************************
2696 * Do local deliveries *
2697 *************************************************/
2699 /* This function processes the list of addresses in addr_local. True local
2700 deliveries are always done one address at a time. However, local deliveries can
2701 be batched up in some cases. Typically this is when writing batched SMTP output
2702 files for use by some external transport mechanism, or when running local
2703 deliveries over LMTP.
2710 do_local_deliveries(void)
2713 open_db *dbm_file = NULL;
2714 time_t now = time(NULL);
2716 /* Loop until we have exhausted the supply of local deliveries */
2720 struct timeval delivery_start;
2721 struct timeval deliver_time;
2722 address_item *addr2, *addr3, *nextaddr;
2723 int logflags = LOG_MAIN;
2724 int logchar = f.dont_deliver? '*' : '=';
2725 transport_instance *tp;
2726 uschar * serialize_key = NULL;
2728 /* Pick the first undelivered address off the chain */
2730 address_item *addr = addr_local;
2731 addr_local = addr->next;
2734 DEBUG(D_deliver|D_transport)
2735 debug_printf("--------> %s <--------\n", addr->address);
2737 /* An internal disaster if there is no transport. Should not occur! */
2739 if (!(tp = addr->transport))
2741 logflags |= LOG_PANIC;
2742 f.disable_logging = FALSE; /* Jic */
2743 addr->message = addr->router
2744 ? string_sprintf("No transport set by %s router", addr->router->name)
2745 : US"No transport set by system filter";
2746 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2750 /* Check that this base address hasn't previously been delivered to this
2751 transport. The check is necessary at this point to handle homonymic addresses
2752 correctly in cases where the pattern of redirection changes between delivery
2753 attempts. Non-homonymic previous delivery is detected earlier, at routing
2756 if (previously_transported(addr, FALSE)) continue;
2758 /* There are weird cases where logging is disabled */
2760 f.disable_logging = tp->disable_logging;
2762 /* Check for batched addresses and possible amalgamation. Skip all the work
2763 if either batch_max <= 1 or there aren't any other addresses for local
2766 if (tp->batch_max > 1 && addr_local)
2768 int batch_count = 1;
2769 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2770 BOOL uses_lp = ( testflag(addr, af_pfr)
2771 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2773 || readconf_depends((driver_instance *)tp, US"local_part");
2774 uschar *batch_id = NULL;
2775 address_item **anchor = &addr_local;
2776 address_item *last = addr;
2779 /* Expand the batch_id string for comparison with other addresses.
2780 Expansion failure suppresses batching. */
2784 deliver_set_expansions(addr);
2785 batch_id = expand_string(tp->batch_id);
2786 deliver_set_expansions(NULL);
2789 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2790 "in %s transport (%s): %s", tp->name, addr->address,
2791 expand_string_message);
2792 batch_count = tp->batch_max;
2796 /* Until we reach the batch_max limit, pick off addresses which have the
2797 same characteristics. These are:
2800 not previously delivered (see comment about 50 lines above)
2801 same local part if the transport's configuration contains $local_part
2802 or if this is a file or pipe delivery from a redirection
2803 same domain if the transport's configuration contains $domain
2805 same additional headers
2806 same headers to be removed
2807 same uid/gid for running the transport
2808 same first host if a host list is set
2811 while ((next = *anchor) && batch_count < tp->batch_max)
2814 tp == next->transport
2815 && !previously_transported(next, TRUE)
2816 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2817 && testflag(addr, af_file) == testflag(next, af_file)
2818 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2819 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2820 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2821 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2822 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2823 && same_ugid(tp, addr, next)
2824 && ( !addr->host_list && !next->host_list
2827 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2830 /* If the transport has a batch_id setting, batch_id will be non-NULL
2831 from the expansion outside the loop. Expand for this address and compare.
2832 Expansion failure makes this address ineligible for batching. */
2837 address_item *save_nextnext = next->next;
2838 next->next = NULL; /* Expansion for a single address */
2839 deliver_set_expansions(next);
2840 next->next = save_nextnext;
2841 bid = expand_string(tp->batch_id);
2842 deliver_set_expansions(NULL);
2845 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2846 "in %s transport (%s): %s", tp->name, next->address,
2847 expand_string_message);
2850 else ok = (Ustrcmp(batch_id, bid) == 0);
2853 /* Take address into batch if OK. */
2857 *anchor = next->next; /* Include the address */
2863 else anchor = &next->next; /* Skip the address */
2867 /* We now have one or more addresses that can be delivered in a batch. Check
2868 whether the transport is prepared to accept a message of this size. If not,
2869 fail them all forthwith. If the expansion fails, or does not yield an
2870 integer, defer delivery. */
2872 if (tp->message_size_limit)
2874 int rc = check_message_size(tp, addr);
2877 replicate_status(addr);
2881 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2884 continue; /* With next batch of addresses */
2888 /* If we are not running the queue, or if forcing, all deliveries will be
2889 attempted. Otherwise, we must respect the retry times for each address. Even
2890 when not doing this, we need to set up the retry key string, and determine
2891 whether a retry record exists, because after a successful delivery, a delete
2892 retry item must be set up. Keep the retry database open only for the duration
2893 of these checks, rather than for all local deliveries, because some local
2894 deliveries (e.g. to pipes) can take a substantial time. */
2896 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2897 DEBUG(D_deliver|D_retry|D_hints_lookup)
2898 debug_printf("no retry data available\n");
2904 BOOL ok = TRUE; /* to deliver this address */
2907 /* Set up the retry key to include the domain or not, and change its
2908 leading character from "R" to "T". Must make a copy before doing this,
2909 because the old key may be pointed to from a "delete" retry item after
2912 retry_key = string_copy(
2913 tp->retry_use_local_part ? addr2->address_retry_key :
2914 addr2->domain_retry_key);
2917 /* Inspect the retry data. If there is no hints file, delivery happens. */
2921 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2923 /* If there is no retry record, delivery happens. If there is,
2924 remember it exists so it can be deleted after a successful delivery. */
2928 setflag(addr2, af_lt_retry_exists);
2930 /* A retry record exists for this address. If queue running and not
2931 forcing, inspect its contents. If the record is too old, or if its
2932 retry time has come, or if it has passed its cutoff time, delivery
2937 debug_printf("retry record exists: age=%s ",
2938 readconf_printtime(now - retry_record->time_stamp));
2939 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2940 debug_printf(" time to retry = %s expired = %d\n",
2941 readconf_printtime(retry_record->next_try - now),
2942 retry_record->expired);
2945 if (f.queue_running && !f.deliver_force)
2947 ok = (now - retry_record->time_stamp > retry_data_expire)
2948 || (now >= retry_record->next_try)
2949 || retry_record->expired;
2951 /* If we haven't reached the retry time, there is one more check
2952 to do, which is for the ultimate address timeout. */
2955 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2959 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2962 /* This address is to be delivered. Leave it on the chain. */
2967 addr2 = addr2->next;
2970 /* This address is to be deferred. Take it out of the chain, and
2971 post-process it as complete. Must take it out of the chain first,
2972 because post processing puts it on another chain. */
2976 address_item *this = addr2;
2977 this->message = US"Retry time not yet reached";
2978 this->basic_errno = ERRNO_LRETRY;
2979 addr2 = addr3 ? (addr3->next = addr2->next)
2980 : (addr = addr2->next);
2981 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2985 if (dbm_file) dbfn_close(dbm_file);
2987 /* If there are no addresses left on the chain, they all deferred. Loop
2988 for the next set of addresses. */
2990 if (!addr) continue;
2992 /* If the transport is limited for parallellism, enforce that here.
2993 We use a hints DB entry, incremented here and decremented after
2994 the transport (and any shadow transport) completes. */
2996 if (tpt_parallel_check(tp, addr, &serialize_key))
2998 if (expand_string_message)
3000 logflags |= LOG_PANIC;
3004 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3005 } while ((addr = addr2));
3007 continue; /* Loop for the next set of addresses. */
3011 /* So, finally, we do have some addresses that can be passed to the
3012 transport. Before doing so, set up variables that are relevant to a
3015 deliver_set_expansions(addr);
3017 gettimeofday(&delivery_start, NULL);
3018 deliver_local(addr, FALSE);
3019 timesince(&deliver_time, &delivery_start);
3021 /* If a shadow transport (which must perforce be another local transport), is
3022 defined, and its condition is met, we must pass the message to the shadow
3023 too, but only those addresses that succeeded. We do this by making a new
3024 chain of addresses - also to keep the original chain uncontaminated. We must
3025 use a chain rather than doing it one by one, because the shadow transport may
3028 NOTE: if the condition fails because of a lookup defer, there is nothing we
3032 && ( !tp->shadow_condition
3033 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3036 transport_instance *stp;
3037 address_item *shadow_addr = NULL;
3038 address_item **last = &shadow_addr;
3040 for (stp = transports; stp; stp = stp->next)
3041 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3044 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3047 /* Pick off the addresses that have succeeded, and make clones. Put into
3048 the shadow_message field a pointer to the shadow_message field of the real
3051 else for (addr2 = addr; addr2; addr2 = addr2->next)
3052 if (addr2->transport_return == OK)
3054 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3057 addr3->shadow_message = US &addr2->shadow_message;
3058 addr3->transport = stp;
3059 addr3->transport_return = DEFER;
3060 addr3->return_filename = NULL;
3061 addr3->return_file = -1;
3063 last = &addr3->next;
3066 /* If we found any addresses to shadow, run the delivery, and stick any
3067 message back into the shadow_message field in the original. */
3071 int save_count = transport_count;
3073 DEBUG(D_deliver|D_transport)
3074 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3075 deliver_local(shadow_addr, TRUE);
3077 for(; shadow_addr; shadow_addr = shadow_addr->next)
3079 int sresult = shadow_addr->transport_return;
3080 *(uschar **)shadow_addr->shadow_message =
3082 ? string_sprintf(" ST=%s", stp->name)
3083 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3084 shadow_addr->basic_errno <= 0
3086 : US strerror(shadow_addr->basic_errno),
3087 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3090 shadow_addr->message
3091 ? shadow_addr->message
3092 : shadow_addr->basic_errno <= 0
3096 DEBUG(D_deliver|D_transport)
3097 debug_printf("%s shadow transport returned %s for %s\n",
3098 stp->name, rc_to_string(sresult), shadow_addr->address);
3101 DEBUG(D_deliver|D_transport)
3102 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3104 transport_count = save_count; /* Restore original transport count */
3108 /* Cancel the expansions that were set up for the delivery. */
3110 deliver_set_expansions(NULL);
3112 /* If the transport was parallelism-limited, decrement the hints DB record. */
3114 if (serialize_key) enq_end(serialize_key);
3116 /* Now we can process the results of the real transport. We must take each
3117 address off the chain first, because post_process_one() puts it on another
3120 for (addr2 = addr; addr2; addr2 = nextaddr)
3122 int result = addr2->transport_return;
3123 nextaddr = addr2->next;
3125 DEBUG(D_deliver|D_transport)
3126 debug_printf("%s transport returned %s for %s\n",
3127 tp->name, rc_to_string(result), addr2->address);
3129 /* If there is a retry_record, or if delivery is deferred, build a retry
3130 item for setting a new retry time or deleting the old retry record from
3131 the database. These items are handled all together after all addresses
3132 have been handled (so the database is open just for a short time for
3135 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3137 int flags = result == DEFER ? 0 : rf_delete;
3138 uschar *retry_key = string_copy(tp->retry_use_local_part
3139 ? addr2->address_retry_key : addr2->domain_retry_key);
3141 retry_add_item(addr2, retry_key, flags);
3144 /* Done with this address */
3146 addr2->delivery_time = deliver_time;
3147 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3149 /* If a pipe delivery generated text to be sent back, the result may be
3150 changed to FAIL, and we must copy this for subsequent addresses in the
3153 if (addr2->transport_return != result)
3155 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3157 addr3->transport_return = addr2->transport_return;
3158 addr3->basic_errno = addr2->basic_errno;
3159 addr3->message = addr2->message;
3161 result = addr2->transport_return;
3164 /* Whether or not the result was changed to FAIL, we need to copy the
3165 return_file value from the first address into all the addresses of the
3166 batch, so they are all listed in the error message. */
3168 addr2->return_file = addr->return_file;
3170 /* Change log character for recording successful deliveries. */
3172 if (result == OK) logchar = '-';
3174 } /* Loop back for next batch of addresses */
3180 /*************************************************
3181 * Sort remote deliveries *
3182 *************************************************/
3184 /* This function is called if remote_sort_domains is set. It arranges that the
3185 chain of addresses for remote deliveries is ordered according to the strings
3186 specified. Try to make this shuffling reasonably efficient by handling
3187 sequences of addresses rather than just single ones.
3194 sort_remote_deliveries(void)
3197 address_item **aptr = &addr_remote;
3198 const uschar *listptr = remote_sort_domains;
3202 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3204 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3207 address_item *moved = NULL;
3208 address_item **bptr = &moved;
3212 address_item **next;
3213 deliver_domain = (*aptr)->domain; /* set $domain */
3214 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3215 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3217 aptr = &(*aptr)->next;
3221 next = &(*aptr)->next;
3223 && (deliver_domain = (*next)->domain, /* Set $domain */
3224 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3225 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3227 next = &(*next)->next;
3229 /* If the batch of non-matchers is at the end, add on any that were
3230 extracted further up the chain, and end this iteration. Otherwise,
3231 extract them from the chain and hang on the moved chain. */
3243 aptr = &(*aptr)->next;
3246 /* If the loop ended because the final address matched, *aptr will
3247 be NULL. Add on to the end any extracted non-matching addresses. If
3248 *aptr is not NULL, the loop ended via "break" when *next is null, that
3249 is, there was a string of non-matching addresses at the end. In this
3250 case the extracted addresses have already been added on the end. */
3252 if (!*aptr) *aptr = moved;
3257 debug_printf("remote addresses after sorting:\n");
3258 for (address_item * addr = addr_remote; addr; addr = addr->next)
3259 debug_printf(" %s\n", addr->address);
3265 /*************************************************
3266 * Read from pipe for remote delivery subprocess *
3267 *************************************************/
3269 /* This function is called when the subprocess is complete, but can also be
3270 called before it is complete, in order to empty a pipe that is full (to prevent
3271 deadlock). It must therefore keep track of its progress in the parlist data
3274 We read the pipe to get the delivery status codes and a possible error message
3275 for each address, optionally preceded by unusability data for the hosts and
3276 also by optional retry data.
3278 Read in large chunks into the big buffer and then scan through, interpreting
3279 the data therein. In most cases, only a single read will be necessary. No
3280 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3281 that we read the next chunk when there is less than 2500 bytes left in the
3282 non-final chunk, we can assume each item is complete in the buffer before
3283 handling it. Each item is written using a single write(), which is atomic for
3284 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3285 often bigger) so even if we are reading while the subprocess is still going, we
3286 should never have only a partial item in the buffer.
3288 hs12: This assumption is not true anymore, since we get quite large items (certificate
3289 information and such).
3292 poffset the offset of the parlist item
3293 eop TRUE if the process has completed
3295 Returns: TRUE if the terminating 'Z' item has been read,
3296 or there has been a disaster (i.e. no more data needed);
3301 par_read_pipe(int poffset, BOOL eop)
3304 pardata *p = parlist + poffset;
3305 address_item *addrlist = p->addrlist;
3306 address_item *addr = p->addr;
3310 uschar *msg = p->msg;
3311 BOOL done = p->done;
3313 /* Loop through all items, reading from the pipe when necessary. The pipe
3314 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3315 here, as the preceding poll() tells us, if data is available for reading.
3317 A read() on a "selected" handle should never block, but(!) it may return
3318 less data then we expected. (The buffer size we pass to read() shouldn't be
3319 understood as a "request", but as a "limit".)
3321 Each separate item is written to the pipe in a timely manner. But, especially for
3322 larger items, the read(2) may already return partial data from the write(2).
3324 The write is atomic mostly (depending on the amount written), but atomic does
3325 not imply "all or noting", it just is "not intermixed" with other writes on the
3326 same channel (pipe).
3330 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3331 (int)p->pid, eop? "ended" : "not ended yet");
3335 retry_item *r, **rp;
3336 uschar pipeheader[PIPE_HEADER_SIZE+1];
3337 uschar *id = &pipeheader[0];
3338 uschar *subid = &pipeheader[1];
3339 uschar *ptr = big_buffer;
3340 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3343 DEBUG(D_deliver) debug_printf(
3344 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3346 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3347 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3348 If we get less, we can assume the subprocess do be done and do not expect any further
3349 information from it. */
3351 if ((got = readn(fd, pipeheader, required)) != required)
3353 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3354 "from transport process %d for transport %s",
3355 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3360 pipeheader[PIPE_HEADER_SIZE] = '\0';
3362 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3366 /* If we can't decode the pipeheader, the subprocess seems to have a
3367 problem, we do not expect any furher information from it. */
3369 required = Ustrtol(pipeheader+2, &endc, 10);
3372 msg = string_sprintf("failed to read pipe "
3373 "from transport process %d for transport %s: error decoding size from header",
3374 pid, addr->transport->driver_name);
3381 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3382 (u_long)required, pid);
3384 /* Same as above, the transport process will write the bytes announced
3385 in a timely manner, so we can just wait for the bytes, getting less than expected
3386 is considered a problem of the subprocess, we do not expect anything else from it. */
3387 if ((got = readn(fd, big_buffer, required)) != required)
3389 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3390 " bytes (pipedata) from transport process %d for transport %s",
3391 got, required, pid, addr->transport->driver_name);
3396 /* Handle each possible type of item, assuming the complete item is
3397 available in store. */
3401 /* Host items exist only if any hosts were marked unusable. Match
3402 up by checking the IP address. */
3405 for (h = addrlist->host_list; h; h = h->next)
3407 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3415 /* Retry items are sent in a preceding R item for each address. This is
3416 kept separate to keep each message short enough to guarantee it won't
3417 be split in the pipe. Hopefully, in the majority of cases, there won't in
3418 fact be any retry items at all.
3420 The complete set of retry items might include an item to delete a
3421 routing retry if there was a previous routing delay. However, routing
3422 retries are also used when a remote transport identifies an address error.
3423 In that case, there may also be an "add" item for the same key. Arrange
3424 that a "delete" item is dropped in favour of an "add" item. */
3427 if (!addr) goto ADDR_MISMATCH;
3429 DEBUG(D_deliver|D_retry)
3430 debug_printf("reading retry information for %s from subprocess\n",
3433 /* Cut out any "delete" items on the list. */
3435 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3436 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3438 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3439 *rp = r->next; /* Excise a delete item */
3440 DEBUG(D_deliver|D_retry)
3441 debug_printf(" existing delete item dropped\n");
3444 /* We want to add a delete item only if there is no non-delete item;
3445 however we still have to step ptr through the data. */
3447 if (!r || !(*ptr & rf_delete))
3449 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3450 r->next = addr->retries;
3453 r->key = string_copy(ptr);
3455 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3456 ptr += sizeof(r->basic_errno);
3457 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3458 ptr += sizeof(r->more_errno);
3459 r->message = *ptr ? string_copy(ptr) : NULL;
3460 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3461 r->flags & rf_delete ? "delete" : "retry");
3466 DEBUG(D_deliver|D_retry)
3467 debug_printf(" delete item not added: non-delete item exists\n");
3470 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3476 /* Put the amount of data written into the parlist block */
3479 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3480 ptr += sizeof(transport_count);
3483 /* Address items are in the order of items on the address chain. We
3484 remember the current address value in case this function is called
3485 several times to empty the pipe in stages. Information about delivery
3486 over TLS is sent in a preceding X item for each address. We don't put
3487 it in with the other info, in order to keep each message short enough to
3488 guarantee it won't be split in the pipe. */
3492 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3496 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3500 addr->cipher = string_copy(ptr);
3501 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3505 addr->peerdn = string_copy(ptr);
3510 (void) tls_import_cert(ptr, &addr->peercert);
3512 addr->peercert = NULL;
3517 (void) tls_import_cert(ptr, &addr->ourcert);
3519 addr->ourcert = NULL;
3522 # ifndef DISABLE_OCSP
3524 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3530 #endif /*DISABLE_TLS*/
3532 case 'C': /* client authenticator information */
3535 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3536 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3537 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3542 #ifndef DISABLE_PRDR
3544 setflag(addr, af_prdr_used);
3551 #ifndef DISABLE_PIPE_CONNECT
3552 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3554 case 1: setflag(addr, af_pipelining); break;
3559 setflag(addr, af_chunking_used);
3563 setflag(addr, af_tcp_fastopen_conn);
3564 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3565 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3569 if (!addr) goto ADDR_MISMATCH;
3570 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3571 ptr += sizeof(addr->dsn_aware);
3572 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3579 msg = string_sprintf("address count mismatch for data read from pipe "
3580 "for transport process %d for transport %s", pid,
3581 addrlist->transport->driver_name);
3588 case 3: /* explicit notification of continued-connection (non)use;
3589 overrides caller's knowlege. */
3590 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3591 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3594 #ifdef SUPPORT_SOCKS
3595 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3596 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3601 proxy_local_address = string_copy(ptr);
3603 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3604 ptr += sizeof(proxy_local_port);
3609 #ifdef EXPERIMENTAL_DSN_INFO
3610 case '1': /* must arrive before A0, and applies to that addr */
3611 /* Two strings: smtp_greeting and helo_response */
3612 addr->smtp_greeting = string_copy(ptr);
3614 addr->helo_response = string_copy(ptr);
3620 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3621 addr->transport_return = *ptr++;
3622 addr->special_action = *ptr++;
3623 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3624 ptr += sizeof(addr->basic_errno);
3625 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3626 ptr += sizeof(addr->more_errno);
3627 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3628 ptr += sizeof(addr->delivery_time);
3629 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3630 ptr += sizeof(addr->flags);
3631 addr->message = *ptr ? string_copy(ptr) : NULL;
3633 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3636 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3640 h = store_get(sizeof(host_item), GET_UNTAINTED);
3641 h->name = string_copy(ptr);
3643 h->address = string_copy(ptr);
3645 memcpy(&h->port, ptr, sizeof(h->port));
3646 ptr += sizeof(h->port);
3647 h->dnssec = *ptr == '2' ? DS_YES
3648 : *ptr == '1' ? DS_NO
3651 addr->host_used = h;
3655 /* Finished with this address */
3662 /* Local interface address/port */
3664 if (*ptr) sending_ip_address = string_copy(ptr);
3666 if (*ptr) sending_port = atoi(CS ptr);
3670 /* Z marks the logical end of the data. It is followed by '0' if
3671 continue_transport was NULL at the end of transporting, otherwise '1'.
3672 We need to know when it becomes NULL during a delivery down a passed SMTP
3673 channel so that we don't try to pass anything more down it. Of course, for
3674 most normal messages it will remain NULL all the time. */
3679 continue_transport = NULL;
3680 continue_hostname = NULL;
3683 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3686 /* Anything else is a disaster. */
3689 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3690 "process %d for transport %s", ptr[-1], pid,
3691 addr->transport->driver_name);
3697 /* The done flag is inspected externally, to determine whether or not to
3698 call the function again when the process finishes. */
3702 /* If the process hadn't finished, and we haven't seen the end of the data
3703 or if we suffered a disaster, update the rest of the state, and return FALSE to
3704 indicate "not finished". */
3713 /* Close our end of the pipe, to prevent deadlock if the far end is still
3714 pushing stuff into it. */
3719 /* If we have finished without error, but haven't had data for every address,
3720 something is wrong. */
3723 msg = string_sprintf("insufficient address data read from pipe "
3724 "for transport process %d for transport %s", pid,
3725 addr->transport->driver_name);
3727 /* If an error message is set, something has gone wrong in getting back
3728 the delivery data. Put the message into each address and freeze it. */
3731 for (addr = addrlist; addr; addr = addr->next)
3733 addr->transport_return = DEFER;
3734 addr->special_action = SPECIAL_FREEZE;
3735 addr->message = msg;
3736 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3739 /* Return TRUE to indicate we have got all we need from this process, even
3740 if it hasn't actually finished yet. */
3747 /*************************************************
3748 * Post-process a set of remote addresses *
3749 *************************************************/
3751 /* Do what has to be done immediately after a remote delivery for each set of
3752 addresses, then re-write the spool if necessary. Note that post_process_one
3753 puts the address on an appropriate queue; hence we must fish off the next
3754 one first. This function is also called if there is a problem with setting
3755 up a subprocess to do a remote delivery in parallel. In this case, the final
3756 argument contains a message, and the action must be forced to DEFER.
3759 addr pointer to chain of address items
3760 logflags flags for logging
3761 msg NULL for normal cases; -> error message for unexpected problems
3762 fallback TRUE if processing fallback hosts
3768 remote_post_process(address_item *addr, int logflags, uschar *msg,
3771 /* If any host addresses were found to be unusable, add them to the unusable
3772 tree so that subsequent deliveries don't try them. */
3774 for (host_item * h = addr->host_list; h; h = h->next)
3776 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3778 /* Now handle each address on the chain. The transport has placed '=' or '-'
3779 into the special_action field for each successful delivery. */
3783 address_item *next = addr->next;
3785 /* If msg == NULL (normal processing) and the result is DEFER and we are
3786 processing the main hosts and there are fallback hosts available, put the
3787 address on the list for fallback delivery. */
3789 if ( addr->transport_return == DEFER
3790 && addr->fallback_hosts
3795 addr->host_list = addr->fallback_hosts;
3796 addr->next = addr_fallback;
3797 addr_fallback = addr;
3798 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3801 /* If msg is set (=> unexpected problem), set it in the address before
3802 doing the ordinary post processing. */
3808 addr->message = msg;
3809 addr->transport_return = DEFER;
3811 (void)post_process_one(addr, addr->transport_return, logflags,
3812 EXIM_DTYPE_TRANSPORT, addr->special_action);
3820 /* If we have just delivered down a passed SMTP channel, and that was
3821 the last address, the channel will have been closed down. Now that
3822 we have logged that delivery, set continue_sequence to 1 so that
3823 any subsequent deliveries don't get "*" incorrectly logged. */
3825 if (!continue_transport) continue_sequence = 1;
3830 /*************************************************
3831 * Wait for one remote delivery subprocess *
3832 *************************************************/
3834 /* This function is called while doing remote deliveries when either the
3835 maximum number of processes exist and we need one to complete so that another
3836 can be created, or when waiting for the last ones to complete. It must wait for
3837 the completion of one subprocess, empty the control block slot, and return a
3838 pointer to the address chain.
3841 Returns: pointer to the chain of addresses handled by the process;
3842 NULL if no subprocess found - this is an unexpected error
3845 static address_item *
3848 int poffset, status;
3849 address_item * addr, * addrlist;
3852 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3853 "to finish", message_id);
3855 /* Loop until either a subprocess completes, or there are no subprocesses in
3856 existence - in which case give an error return. We cannot proceed just by
3857 waiting for a completion, because a subprocess may have filled up its pipe, and
3858 be waiting for it to be emptied. Therefore, if no processes have finished, we
3859 wait for one of the pipes to acquire some data by calling poll(), with a
3860 timeout just in case.
3862 The simple approach is just to iterate after reading data from a ready pipe.
3863 This leads to non-ideal behaviour when the subprocess has written its final Z
3864 item, closed the pipe, and is in the process of exiting (the common case). A
3865 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3866 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3869 To avoid this, if all the data that is needed has been read from a subprocess
3870 after poll(), an explicit wait() for it is done. We know that all it is doing
3871 is writing to the pipe and then exiting, so the wait should not be long.
3873 The non-blocking waitpid() is to some extent just insurance; if we could
3874 reliably detect end-of-file on the pipe, we could always know when to do a
3875 blocking wait() for a completed process. However, because some systems use
3876 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3877 use code that functions without the need to recognize EOF.
3879 There's a double loop here just in case we end up with a process that is not in
3880 the list of remote delivery processes. Something has obviously gone wrong if
3881 this is the case. (For example, a process that is incorrectly left over from
3882 routing or local deliveries might be found.) The damage can be minimized by
3883 looping back and looking for another process. If there aren't any, the error
3884 return will happen. */
3886 for (;;) /* Normally we do not repeat this loop */
3888 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3892 /* A return value of -1 can mean several things. If errno != ECHILD, it
3893 either means invalid options (which we discount), or that this process was
3894 interrupted by a signal. Just loop to try the waitpid() again.
3896 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3897 in existence. This should never happen, and is an unexpected error.
3898 However, there is a nasty complication when running under Linux. If "strace
3899 -f" is being used under Linux to trace this process and its children,
3900 subprocesses are "stolen" from their parents and become the children of the
3901 tracing process. A general wait such as the one we've just obeyed returns
3902 as if there are no children while subprocesses are running. Once a
3903 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3904 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3907 This does not happen using "truss" on Solaris, nor (I think) with other
3908 tracing facilities on other OS. It seems to be specific to Linux.
3910 What we do to get round this is to use kill() to see if any of our
3911 subprocesses are still in existence. If kill() gives an OK return, we know
3912 it must be for one of our processes - it can't be for a re-use of the pid,
3913 because if our process had finished, waitpid() would have found it. If any
3914 of our subprocesses are in existence, we proceed to use poll() as if
3915 waitpid() had returned zero. I think this is safe. */
3919 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3922 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3923 "for process existence\n");
3925 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3927 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3929 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3930 "stolen by strace\n", (int)pid);
3931 break; /* With poffset set */
3935 if (poffset >= remote_max_parallel)
3937 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3938 return NULL; /* This is the error return */
3942 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3943 been handled above. A return value of zero means that there is at least one
3944 subprocess, but there are no completed subprocesses. See if any pipes are
3945 ready with any data for reading. */
3947 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3949 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3950 if (parlist[poffset].pid != 0)
3952 parpoll[poffset].fd = parlist[poffset].fd;
3953 parpoll[poffset].events = POLLIN;
3956 parpoll[poffset].fd = -1;
3958 /* Stick in a 60-second timeout, just in case. */
3960 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3962 /* Scan through the pipes and read any that are ready; use the count
3963 returned by poll() to stop when there are no more. Select() can return
3964 with no processes (e.g. if interrupted). This shouldn't matter.
3966 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3967 read, or there was a disaster. In either case, we are finished with this
3968 process. Do an explicit wait() for the process and break the main loop if
3971 It turns out that we have to deal with the case of an interrupted system
3972 call, which can happen on some operating systems if the signal handling is
3973 set up to do that by default. */
3976 readycount > 0 && poffset < remote_max_parallel;
3979 if ( (pid = parlist[poffset].pid) != 0
3980 && parpoll[poffset].revents
3984 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3985 for (;;) /* Loop for signals */
3987 pid_t endedpid = waitpid(pid, &status, 0);
3988 if (endedpid == pid) goto PROCESS_DONE;
3989 if (endedpid != (pid_t)(-1) || errno != EINTR)
3990 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3991 "%d (errno = %d) from waitpid() for process %d",
3992 (int)endedpid, errno, (int)pid);
3997 /* Now go back and look for a completed subprocess again. */
4000 /* A completed process was detected by the non-blocking waitpid(). Find the
4001 data block that corresponds to this subprocess. */
4003 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4004 if (pid == parlist[poffset].pid) break;
4006 /* Found the data block; this is a known remote delivery process. We don't
4007 need to repeat the outer loop. This should be what normally happens. */
4009 if (poffset < remote_max_parallel) break;
4011 /* This situation is an error, but it's probably better to carry on looking
4012 for another process than to give up (as we used to do). */
4014 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4015 "transport process list", pid);
4016 } /* End of the "for" loop */
4018 /* Come here when all the data was completely read after a poll(), and
4019 the process in pid has been wait()ed for. */
4026 debug_printf("remote delivery process %d ended\n", (int)pid);
4028 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4032 set_process_info("delivering %s", message_id);
4034 /* Get the chain of processed addresses */
4036 addrlist = parlist[poffset].addrlist;
4038 /* If the process did not finish cleanly, record an error and freeze (except
4039 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4040 in case the delivery did actually happen. */
4042 if ((status & 0xffff) != 0)
4045 int msb = (status >> 8) & 255;
4046 int lsb = status & 255;
4047 int code = (msb == 0)? (lsb & 0x7f) : msb;
4049 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4051 addrlist->transport->driver_name,
4053 msb == 0 ? "terminated by signal" : "exit code",
4056 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4057 addrlist->special_action = SPECIAL_FREEZE;
4059 for (addr = addrlist; addr; addr = addr->next)
4061 addr->transport_return = DEFER;
4062 addr->message = msg;
4065 remove_journal = FALSE;
4068 /* Else complete reading the pipe to get the result of the delivery, if all
4069 the data has not yet been obtained. */
4071 else if (!parlist[poffset].done)
4072 (void) par_read_pipe(poffset, TRUE);
4074 /* Put the data count and return path into globals, mark the data slot unused,
4075 decrement the count of subprocesses, and return the address chain. */
4077 transport_count = parlist[poffset].transport_count;
4078 used_return_path = parlist[poffset].return_path;
4079 parlist[poffset].pid = 0;
4086 /*************************************************
4087 * Wait for subprocesses and post-process *
4088 *************************************************/
4090 /* This function waits for subprocesses until the number that are still running
4091 is below a given threshold. For each complete subprocess, the addresses are
4092 post-processed. If we can't find a running process, there is some shambles.
4093 Better not bomb out, as that might lead to multiple copies of the message. Just
4094 log and proceed as if all done.
4097 max maximum number of subprocesses to leave running
4098 fallback TRUE if processing fallback hosts
4104 par_reduce(int max, BOOL fallback)
4106 while (parcount > max)
4108 address_item *doneaddr = par_wait();
4111 log_write(0, LOG_MAIN|LOG_PANIC,
4112 "remote delivery process count got out of step");
4117 transport_instance * tp = doneaddr->transport;
4118 if (tp->max_parallel)
4119 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4121 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4127 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4129 uschar pipe_header[PIPE_HEADER_SIZE+1];
4130 size_t total_len = PIPE_HEADER_SIZE + size;
4132 struct iovec iov[2] = {
4133 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4134 { buf, size } /* *the* data */
4139 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4140 /* complain to log if someone tries with buffer sizes we can't handle*/
4142 if (size > BIG_BUFFER_SIZE-1)
4144 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4145 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4147 size = BIG_BUFFER_SIZE;
4150 /* Should we check that we do not write more than PIPE_BUF? What would
4153 /* convert size to human readable string prepended by id and subid */
4154 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4155 id, subid, (long)size))
4156 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4158 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4159 id, subid, (long)size, pipe_header);
4161 if ((ret = writev(fd, iov, 2)) != total_len)
4162 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4163 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4164 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4167 /*************************************************
4168 * Do remote deliveries *
4169 *************************************************/
4171 /* This function is called to process the addresses in addr_remote. We must
4172 pick off the queue all addresses that have the same transport, remote
4173 destination, and errors address, and hand them to the transport in one go,
4174 subject to some configured limitations. If this is a run to continue delivering
4175 to an existing delivery channel, skip all but those addresses that can go to
4176 that channel. The skipped addresses just get deferred.
4178 If mua_wrapper is set, all addresses must be able to be sent in a single
4179 transaction. If not, this function yields FALSE.
4181 In Exim 4, remote deliveries are always done in separate processes, even
4182 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4183 is so that the base process can retain privilege. This makes the
4184 implementation of fallback transports feasible (though not initially done.)
4186 We create up to the configured number of subprocesses, each of which passes
4187 back the delivery state via a pipe. (However, when sending down an existing
4188 connection, remote_max_parallel is forced to 1.)
4191 fallback TRUE if processing fallback hosts
4193 Returns: TRUE normally
4194 FALSE if mua_wrapper is set and the addresses cannot all be sent
4199 do_remote_deliveries(BOOL fallback)
4204 parcount = 0; /* Number of executing subprocesses */
4206 /* When sending down an existing channel, only do one delivery at a time.
4207 We use a local variable (parmax) to hold the maximum number of processes;
4208 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4210 if (continue_transport) remote_max_parallel = 1;
4211 parmax = remote_max_parallel;
4213 /* If the data for keeping a list of processes hasn't yet been
4218 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4219 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4220 parlist[poffset].pid = 0;
4221 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4224 /* Now loop for each remote delivery */
4226 for (int delivery_count = 0; addr_remote; delivery_count++)
4232 int address_count = 1;
4233 int address_count_max;
4235 BOOL use_initgroups;
4236 BOOL pipe_done = FALSE;
4237 transport_instance *tp;
4238 address_item **anchor = &addr_remote;
4239 address_item *addr = addr_remote;
4240 address_item *last = addr;
4243 uschar * serialize_key = NULL;
4245 /* Pull the first address right off the list. */
4247 addr_remote = addr->next;
4250 DEBUG(D_deliver|D_transport)
4251 debug_printf("--------> %s <--------\n", addr->address);
4253 /* If no transport has been set, there has been a big screw-up somewhere. */
4255 if (!(tp = addr->transport))
4257 f.disable_logging = FALSE; /* Jic */
4258 panicmsg = US"No transport set by router";
4259 goto panic_continue;
4262 /* Check that this base address hasn't previously been delivered to this
4263 transport. The check is necessary at this point to handle homonymic addresses
4264 correctly in cases where the pattern of redirection changes between delivery
4265 attempts. Non-homonymic previous delivery is detected earlier, at routing
4268 if (previously_transported(addr, FALSE)) continue;
4270 /* Force failure if the message is too big. */
4272 if (tp->message_size_limit)
4274 int rc = check_message_size(tp, addr);
4277 addr->transport_return = rc;
4278 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4283 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4284 So look out for the place it gets used.
4287 /* Get the flag which specifies whether the transport can handle different
4288 domains that nevertheless resolve to the same set of hosts. If it needs
4289 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4290 $host, $host_address, $host_port. */
4291 if (tp->expand_multi_domain)
4292 deliver_set_expansions(addr);
4294 if (exp_bool(addr, US"transport", tp->name, D_transport,
4295 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4296 &multi_domain) != OK)
4298 deliver_set_expansions(NULL);
4299 panicmsg = addr->message;
4300 goto panic_continue;
4303 /* Get the maximum it can handle in one envelope, with zero meaning
4304 unlimited, which is forced for the MUA wrapper case. */
4306 address_count_max = tp->max_addresses;
4307 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4310 /************************************************************************/
4311 /***** This is slightly experimental code, but should be safe. *****/
4313 /* The address_count_max value is the maximum number of addresses that the
4314 transport can send in one envelope. However, the transport must be capable of
4315 dealing with any number of addresses. If the number it gets exceeds its
4316 envelope limitation, it must send multiple copies of the message. This can be
4317 done over a single connection for SMTP, so uses less resources than making
4318 multiple connections. On the other hand, if remote_max_parallel is greater
4319 than one, it is perhaps a good idea to use parallel processing to move the
4320 message faster, even if that results in multiple simultaneous connections to
4323 How can we come to some compromise between these two ideals? What we do is to
4324 limit the number of addresses passed to a single instance of a transport to
4325 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4326 number of addresses routed to remote transports divided by
4327 remote_max_parallel. For example, if the message has 100 remote recipients,
4328 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4329 once. But if rcpt_max is 100, we could send up to 100.
4331 Of course, not all the remotely addresses in a message are going to go to the
4332 same set of hosts (except in smarthost configurations), so this is just a
4333 heuristic way of dividing up the work.
4335 Furthermore (1), because this may not be wanted in some cases, and also to
4336 cope with really pathological cases, there is also a limit to the number of
4337 messages that are sent over one connection. This is the same limit that is
4338 used when sending several different messages over the same connection.
4339 Continue_sequence is set when in this situation, to the number sent so
4340 far, including this message.
4342 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4343 is probably because they are using VERP, in which case they want to pass only
4344 one address at a time to the transport, in order to be able to use
4345 $local_part and $domain in constructing a new return path. We could test for
4346 the use of these variables, but as it is so likely they will be used when the
4347 maximum is 1, we don't bother. Just leave the value alone. */
4349 if ( address_count_max != 1
4350 && address_count_max < remote_delivery_count/remote_max_parallel
4353 int new_max = remote_delivery_count/remote_max_parallel;
4354 int message_max = tp->connection_max_messages;
4355 if (connection_max_messages >= 0) message_max = connection_max_messages;
4356 message_max -= continue_sequence - 1;
4357 if (message_max > 0 && new_max > address_count_max * message_max)
4358 new_max = address_count_max * message_max;
4359 address_count_max = new_max;
4362 /************************************************************************/
4365 /*XXX don't know yet if DANE will be used. So tpt will have to
4366 check at the point if gets next addr from list, and skip/defer any
4370 /* Pick off all addresses which have the same transport, errors address,
4371 destination, and extra headers. In some cases they point to the same host
4372 list, but we also need to check for identical host lists generated from
4373 entirely different domains. The host list pointers can be NULL in the case
4374 where the hosts are defined in the transport. There is also a configured
4375 maximum limit of addresses that can be handled at once (see comments above
4376 for how it is computed).
4377 If the transport does not handle multiple domains, enforce that also,
4378 and if it might need a per-address check for this, re-evaluate it.
4381 while ((next = *anchor) && address_count < address_count_max)
4384 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4385 && tp == next->transport
4386 && same_hosts(next->host_list, addr->host_list)
4387 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4388 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4389 && same_ugid(tp, next, addr)
4390 && ( next->prop.remove_headers == addr->prop.remove_headers
4391 || ( next->prop.remove_headers
4392 && addr->prop.remove_headers
4393 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4397 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4399 US"transport", next->transport->name, D_transport,
4400 US"multi_domain", next->transport->multi_domain,
4401 next->transport->expand_multi_domain, &md) == OK
4406 *anchor = next->next;
4408 next->first = addr; /* remember top one (for retry processing) */
4413 else anchor = &(next->next);
4414 deliver_set_expansions(NULL);
4417 /* If we are acting as an MUA wrapper, all addresses must go in a single
4418 transaction. If not, put them back on the chain and yield FALSE. */
4420 if (mua_wrapper && addr_remote)
4422 last->next = addr_remote;
4427 /* If the transport is limited for parallellism, enforce that here.
4428 The hints DB entry is decremented in par_reduce(), when we reap the
4429 transport process. */
4431 if (tpt_parallel_check(tp, addr, &serialize_key))
4432 if ((panicmsg = expand_string_message))
4433 goto panic_continue;
4435 continue; /* Loop for the next set of addresses. */
4437 /* Set up the expansion variables for this set of addresses */
4439 deliver_set_expansions(addr);
4441 /* Ensure any transport-set auth info is fresh */
4442 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4444 /* Compute the return path, expanding a new one if required. The old one
4445 must be set first, as it might be referred to in the expansion. */
4447 if(addr->prop.errors_address)
4448 return_path = addr->prop.errors_address;
4450 return_path = sender_address;
4452 if (tp->return_path)
4454 uschar *new_return_path = expand_string(tp->return_path);
4455 if (new_return_path)
4456 return_path = new_return_path;
4457 else if (!f.expand_string_forcedfail)
4459 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4460 tp->return_path, expand_string_message);
4465 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4466 logs and sets up error messages, so we just post-process and continue with
4467 the next address. */
4469 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4475 /* If this transport has a setup function, call it now so that it gets
4476 run in this process and not in any subprocess. That way, the results of
4477 any setup that are retained by the transport can be reusable. One of the
4478 things the setup does is to set the fallback host lists in the addresses.
4479 That is why it is called at this point, before the continue delivery
4480 processing, because that might use the fallback hosts. */
4483 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4485 /* If we have a connection still open from a verify stage (lazy-close)
4486 treat it as if it is a continued connection (apart from the counter used
4487 for the log line mark). */
4489 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4492 debug_printf("lazy-callout-close: have conn still open from verification\n");
4493 continue_transport = cutthrough.transport;
4494 continue_hostname = string_copy(cutthrough.host.name);
4495 continue_host_address = string_copy(cutthrough.host.address);
4496 continue_sequence = 1;
4497 sending_ip_address = cutthrough.snd_ip;
4498 sending_port = cutthrough.snd_port;
4499 smtp_peer_options = cutthrough.peer_options;
4502 /* If this is a run to continue delivery down an already-established
4503 channel, check that this set of addresses matches the transport and
4504 the channel. If it does not, defer the addresses. If a host list exists,
4505 we must check that the continue host is on the list. Otherwise, the
4506 host is set in the transport. */
4508 f.continue_more = FALSE; /* In case got set for the last lot */
4509 if (continue_transport)
4511 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4512 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4514 /* If the transport is about to override the host list do not check
4515 it here but take the cost of running the transport process to discover
4516 if the continued_hostname connection is suitable. This is a layering
4517 violation which is unfortunate as it requires we haul in the smtp
4522 smtp_transport_options_block * ob;
4524 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4525 && (ob = (smtp_transport_options_block *)tp->options_block)
4526 && ob->hosts_override && ob->hosts
4532 for (host_item * h = addr->host_list; h; h = h->next)
4533 if (Ustrcmp(h->name, continue_hostname) == 0)
4534 /*XXX should also check port here */
4535 { ok = TRUE; break; }
4539 /* Addresses not suitable; defer or queue for fallback hosts (which
4540 might be the continue host) and skip to next address. */
4544 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4545 Ustrcmp(continue_transport, tp->name) != 0
4546 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4547 : string_sprintf("no host matching %s", continue_hostname));
4548 if (serialize_key) enq_end(serialize_key);
4550 if (addr->fallback_hosts && !fallback)
4552 for (next = addr; ; next = next->next)
4554 next->host_list = next->fallback_hosts;
4555 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4556 if (!next->next) break;
4558 next->next = addr_fallback;
4559 addr_fallback = addr;
4564 for (next = addr; ; next = next->next)
4566 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4567 if (!next->next) break;
4569 next->next = addr_defer;
4576 /* Set a flag indicating whether there are further addresses that list
4577 the continued host. This tells the transport to leave the channel open,
4578 but not to pass it to another delivery process. We'd like to do that
4579 for non-continue_transport cases too but the knowlege of which host is
4580 connected to is too hard to manage. Perhaps we need a finer-grain
4581 interface to the transport. */
4583 for (next = addr_remote; next && !f.continue_more; next = next->next)
4584 for (host_item * h = next->host_list; h; h = h->next)
4585 if (Ustrcmp(h->name, continue_hostname) == 0)
4586 { f.continue_more = TRUE; break; }
4589 /* The transports set up the process info themselves as they may connect
4590 to more than one remote machine. They also have to set up the filter
4591 arguments, if required, so that the host name and address are available
4594 transport_filter_argv = NULL;
4596 /* Create the pipe for inter-process communication. If pipe creation
4597 fails, it is probably because the value of remote_max_parallel is so
4598 large that too many file descriptors for pipes have been created. Arrange
4599 to wait for a process to finish, and then try again. If we still can't
4600 create a pipe when all processes have finished, break the retry loop. */
4604 if (pipe(pfd) == 0) pipe_done = TRUE;
4605 else if (parcount > 0) parmax = parcount;
4608 /* We need to make the reading end of the pipe non-blocking. There are
4609 two different options for this. Exim is cunningly (I hope!) coded so
4610 that it can use either of them, though it prefers O_NONBLOCK, which
4611 distinguishes between EOF and no-more-data. */
4613 /* The data appears in a timely manner and we already did a poll on
4614 all pipes, so I do not see a reason to use non-blocking IO here
4617 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4619 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4623 /* If the maximum number of subprocesses already exist, wait for a process
4624 to finish. If we ran out of file descriptors, parmax will have been reduced
4625 from its initial value of remote_max_parallel. */
4627 par_reduce(parmax - 1, fallback);
4630 /* If we failed to create a pipe and there were no processes to wait
4631 for, we have to give up on this one. Do this outside the above loop
4632 so that we can continue the main loop. */
4636 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4640 /* Find a free slot in the pardata list. Must do this after the possible
4641 waiting for processes to finish, because a terminating process will free
4644 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4645 if (parlist[poffset].pid == 0)
4648 /* If there isn't one, there has been a horrible disaster. */
4650 if (poffset >= remote_max_parallel)
4652 (void)close(pfd[pipe_write]);
4653 (void)close(pfd[pipe_read]);
4654 panicmsg = US"Unexpectedly no free subprocess slot";
4658 /* Now fork a subprocess to do the remote delivery, but before doing so,
4659 ensure that any cached resources are released so as not to interfere with
4660 what happens in the subprocess. */
4664 if ((pid = exim_fork(US"transport")) == 0)
4666 int fd = pfd[pipe_write];
4669 /* Setting these globals in the subprocess means we need never clear them */
4670 transport_name = addr->transport->name;
4671 driver_srcfile = tp->srcfile;
4672 driver_srcline = tp->srcline;
4674 /* There are weird circumstances in which logging is disabled */
4675 f.disable_logging = tp->disable_logging;
4677 /* Show pids on debug output if parallelism possible */
4679 if (parmax > 1 && (parcount > 0 || addr_remote))
4680 DEBUG(D_any|D_v) debug_selector |= D_pid;
4682 /* Reset the random number generator, so different processes don't all
4683 have the same sequence. In the test harness we want different, but
4684 predictable settings for each delivery process, so do something explicit
4685 here rather they rely on the fixed reset in the random number function. */
4687 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4689 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4690 a new process that may be forked to do another delivery down the same
4693 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4695 /* Close open file descriptors for the pipes of other processes
4696 that are running in parallel. */
4698 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4699 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4701 /* This process has inherited a copy of the file descriptor
4702 for the data file, but its file pointer is shared with all the
4703 other processes running in parallel. Therefore, we have to re-open
4704 the file in order to get a new file descriptor with its own
4705 file pointer. We don't need to lock it, as the lock is held by
4706 the parent process. There doesn't seem to be any way of doing
4707 a dup-with-new-file-pointer. */
4709 (void)close(deliver_datafile);
4711 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4713 if ((deliver_datafile = Uopen(fname,
4717 O_RDWR | O_APPEND, 0)) < 0)
4718 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4719 "parallel delivery: %s", fname, strerror(errno));
4722 /* Set the close-on-exec flag */
4724 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4728 /* Set the uid/gid of this process; bombs out on failure. */
4730 exim_setugid(uid, gid, use_initgroups,
4731 string_sprintf("remote delivery to %s with transport=%s",
4732 addr->address, tp->name));
4734 /* Close the unwanted half of this process' pipe, set the process state,
4735 and run the transport. Afterwards, transport_count will contain the number
4736 of bytes written. */
4738 (void)close(pfd[pipe_read]);
4739 set_process_info("delivering %s using %s", message_id, tp->name);
4740 debug_print_string(tp->debug_string);
4741 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4743 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4744 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4746 /* Ensure any cached resources that we used are now released */
4750 /* Pass the result back down the pipe. This is a lot more information
4751 than is needed for a local delivery. We have to send back the error
4752 status for each address, the usability status for each host that is
4753 flagged as unusable, and all the retry items. When TLS is in use, we
4754 send also the cipher and peerdn information. Each type of information
4755 is flagged by an identifying byte, and is then in a fixed format (with
4756 strings terminated by zeros), and there is a final terminator at the
4757 end. The host information and retry information is all attached to
4758 the first address, so that gets sent at the start. */
4760 /* Host unusability information: for most success cases this will
4763 for (h = addr->host_list; h; h = h->next)
4765 if (!h->address || h->status < hstatus_unusable) continue;
4766 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4767 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4770 /* The number of bytes written. This is the same for each address. Even
4771 if we sent several copies of the message down the same connection, the
4772 size of each one is the same, and it's that value we have got because
4773 transport_count gets reset before calling transport_write_message(). */
4775 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4776 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4778 /* Information about what happened to each address. Four item types are
4779 used: an optional 'X' item first, for TLS information, then an optional "C"
4780 item for any client-auth info followed by 'R' items for any retry settings,
4781 and finally an 'A' item for the remaining data. */
4783 for(; addr; addr = addr->next)
4787 /* The certificate verification status goes into the flags */
4788 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4790 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4792 # ifndef DISABLE_TLS_RESUME
4793 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4796 /* Use an X item only if there's something to send */
4800 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4804 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4806 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4808 else if (continue_proxy_cipher)
4810 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4812 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4818 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4822 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4827 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4831 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4833 # ifndef DISABLE_OCSP
4834 if (addr->ocsp > OCSP_NOT_REQ)
4836 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4837 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4840 #endif /*DISABLE_TLS*/
4842 if (client_authenticator)
4844 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4845 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4847 if (client_authenticated_id)
4849 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4850 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4852 if (client_authenticated_sender)
4854 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4855 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4858 #ifndef DISABLE_PRDR
4859 if (testflag(addr, af_prdr_used))
4860 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4863 if (testflag(addr, af_pipelining))
4864 #ifndef DISABLE_PIPE_CONNECT
4865 if (testflag(addr, af_early_pipe))
4866 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4869 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4871 if (testflag(addr, af_chunking_used))
4872 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4874 if (testflag(addr, af_tcp_fastopen_conn))
4875 rmt_dlv_checked_write(fd, 'T',
4876 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4880 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4881 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4883 /* Retry information: for most success cases this will be null. */
4885 for (retry_item * r = addr->retries; r; r = r->next)
4887 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4888 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4889 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4890 ptr += sizeof(r->basic_errno);
4891 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4892 ptr += sizeof(r->more_errno);
4893 if (!r->message) *ptr++ = 0; else
4895 sprintf(CS ptr, "%.512s", r->message);
4898 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4901 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4903 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4904 testflag(addr, af_new_conn) ? "non-" : "");
4905 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4906 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4909 #ifdef SUPPORT_SOCKS
4910 if (LOGGING(proxy) && proxy_session)
4913 if (proxy_local_address)
4915 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4916 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4917 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4918 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4919 ptr += sizeof(proxy_local_port);
4923 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4927 #ifdef EXPERIMENTAL_DSN_INFO
4928 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4929 if (addr->smtp_greeting)
4931 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4932 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4933 if (addr->helo_response)
4935 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4936 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4940 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4944 /* The rest of the information goes in an 'A0' item. */
4946 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4947 ptr = big_buffer + 2;
4948 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4949 ptr += sizeof(addr->basic_errno);
4950 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4951 ptr += sizeof(addr->more_errno);
4952 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4953 ptr += sizeof(addr->delivery_time);
4954 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4955 ptr += sizeof(addr->flags);
4957 if (!addr->message) *ptr++ = 0; else
4958 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4960 if (!addr->user_message) *ptr++ = 0; else
4961 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4963 if (!addr->host_used) *ptr++ = 0; else
4965 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4966 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4967 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4968 ptr += sizeof(addr->host_used->port);
4970 /* DNS lookup status */
4971 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4972 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4975 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4978 /* Local interface address/port */
4979 #ifdef EXPERIMENTAL_DSN_INFO
4980 if (sending_ip_address)
4982 if (LOGGING(incoming_interface) && sending_ip_address)
4986 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4987 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4988 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4991 /* Add termination flag, close the pipe, and that's it. The character
4992 after 'Z' indicates whether continue_transport is now NULL or not.
4993 A change from non-NULL to NULL indicates a problem with a continuing
4996 big_buffer[0] = continue_transport ? '1' : '0';
4997 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5002 /* Back in the mainline: close the unwanted half of the pipe. */
5004 (void)close(pfd[pipe_write]);
5006 /* If we have a connection still open from a verify stage (lazy-close)
5007 release its TLS library context (if any) as responsibility was passed to
5008 the delivery child process. */
5010 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5013 if (cutthrough.is_tls)
5014 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5016 (void) close(cutthrough.cctx.sock);
5017 release_cutthrough_connection(US"passed to transport proc");
5020 /* Fork failed; defer with error message */
5024 (void)close(pfd[pipe_read]);
5025 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5026 addr->domain, strerror(errno));
5030 /* Fork succeeded; increment the count, and remember relevant data for
5031 when the process finishes. */
5034 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5035 parlist[poffset].pid = pid;
5036 parlist[poffset].fd = pfd[pipe_read];
5037 parlist[poffset].done = FALSE;
5038 parlist[poffset].msg = NULL;
5039 parlist[poffset].return_path = return_path;
5041 /* If the process we've just started is sending a message down an existing
5042 channel, wait for it now. This ensures that only one such process runs at
5043 once, whatever the value of remote_max parallel. Otherwise, we might try to
5044 send two or more messages simultaneously down the same channel. This could
5045 happen if there are different domains that include the same host in otherwise
5046 different host lists.
5048 Also, if the transport closes down the channel, this information gets back
5049 (continue_transport gets set to NULL) before we consider any other addresses
5052 if (continue_transport) par_reduce(0, fallback);
5054 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5055 newly created process get going before we create another process. This should
5056 ensure repeatability in the tests. Wait long enough for most cases to complete
5059 else testharness_pause_ms(600);
5064 if (serialize_key) enq_end(serialize_key);
5066 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5070 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5071 are still running and post-process their addresses. */
5073 par_reduce(0, fallback);
5080 /*************************************************
5081 * Split an address into local part and domain *
5082 *************************************************/
5084 /* This function initializes an address for routing by splitting it up into a
5085 local part and a domain. The local part is set up twice - once in its original
5086 casing, and once in lower case, and it is dequoted. We also do the "percent
5087 hack" for configured domains. This may lead to a DEFER result if a lookup
5088 defers. When a percent-hacking takes place, we insert a copy of the original
5089 address as a new parent of this address, as if we have had a redirection.
5092 addr points to an addr_item block containing the address
5095 DEFER - could not determine if domain is %-hackable
5099 deliver_split_address(address_item * addr)
5101 uschar * address = addr->address;
5106 if (!(domain = Ustrrchr(address, '@')))
5107 return DEFER; /* should always have a domain, but just in case... */
5109 len = domain - address;
5110 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5112 /* The implication in the RFCs (though I can't say I've seen it spelled out
5113 explicitly) is that quoting should be removed from local parts at the point
5114 where they are locally interpreted. [The new draft "821" is more explicit on
5115 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5116 removing quoting backslashes and any unquoted doublequotes. */
5118 t = addr->cc_local_part = store_get(len+1, address);
5122 if (c == '\"') continue;
5132 /* We do the percent hack only for those domains that are listed in
5133 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5135 if (percent_hack_domains)
5138 uschar *new_address = NULL;
5139 uschar *local_part = addr->cc_local_part;
5141 deliver_domain = addr->domain; /* set $domain */
5143 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5144 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5146 && (t = Ustrrchr(local_part, '%')) != NULL
5149 new_address = string_copy(local_part);
5150 new_address[t - local_part] = '@';
5151 deliver_domain = string_copylc(t+1);
5152 local_part = string_copyn(local_part, t - local_part);
5155 if (rc == DEFER) return DEFER; /* lookup deferred */
5157 /* If hackery happened, set up new parent and alter the current address. */
5161 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5162 *new_parent = *addr;
5163 addr->parent = new_parent;
5164 new_parent->child_count = 1;
5165 addr->address = new_address;
5166 addr->unique = string_copy(new_address);
5167 addr->domain = deliver_domain;
5168 addr->cc_local_part = local_part;
5169 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5174 /* Create the lowercased version of the final local part, and make that the
5175 default one to be used. */
5177 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5184 /*************************************************
5185 * Get next error message text *
5186 *************************************************/
5188 /* If f is not NULL, read the next "paragraph", from a customized error message
5189 text file, terminated by a line containing ****, and expand it.
5192 f NULL or a file to read from
5193 which string indicating which string (for errors)
5195 Returns: NULL or an expanded string
5199 next_emf(FILE *f, uschar *which)
5205 if (!f) return NULL;
5207 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5210 para = string_get(256);
5213 para = string_cat(para, buffer);
5214 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5217 if ((yield = expand_string(string_from_gstring(para))))
5220 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5221 "bounce_message_file or warn_message_file (%s): %s", which,
5222 expand_string_message);
5229 /*************************************************
5230 * Close down a passed transport channel *
5231 *************************************************/
5233 /* This function is called when a passed transport channel cannot be used.
5234 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5235 so that the function call can be the argument of a "return" statement.
5238 Returns: DELIVER_NOT_ATTEMPTED
5242 continue_closedown(void)
5244 if (continue_transport)
5245 for (transport_instance * t = transports; t; t = t->next)
5246 if (Ustrcmp(t->name, continue_transport) == 0)
5248 if (t->info->closedown) (t->info->closedown)(t);
5251 return DELIVER_NOT_ATTEMPTED;
5257 /*************************************************
5258 * Print address information *
5259 *************************************************/
5261 /* This function is called to output an address, or information about an
5262 address, for bounce or defer messages. If the hide_child flag is set, all we
5263 output is the original ancestor address.
5266 addr points to the address
5267 f the FILE to print to
5268 si an initial string
5269 sc a continuation string for before "generated"
5272 Returns: TRUE if the address is not hidden
5276 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5280 uschar *printed = US"";
5281 address_item *ancestor = addr;
5282 while (ancestor->parent) ancestor = ancestor->parent;
5284 fprintf(f, "%s", CS si);
5286 if (addr->parent && testflag(addr, af_hide_child))
5288 printed = US"an undisclosed address";
5291 else if (!testflag(addr, af_pfr) || !addr->parent)
5292 printed = addr->address;
5296 uschar *s = addr->address;
5299 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5300 else if (addr->address[0] == '|') ss = US"pipe";
5303 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5304 printed = addr->parent->address;
5307 fprintf(f, "%s", CS string_printing(printed));
5309 if (ancestor != addr)
5311 uschar *original = ancestor->onetime_parent;
5312 if (!original) original= ancestor->address;
5313 if (strcmpic(original, printed) != 0)
5314 fprintf(f, "%s(%sgenerated from %s)", sc,
5315 ancestor != addr->parent ? "ultimately " : "",
5316 string_printing(original));
5319 if (addr->host_used)
5320 fprintf(f, "\n host %s [%s]",
5321 addr->host_used->name, addr->host_used->address);
5323 fprintf(f, "%s", CS se);
5331 /*************************************************
5332 * Print error for an address *
5333 *************************************************/
5335 /* This function is called to print the error information out of an address for
5336 a bounce or a warning message. It tries to format the message reasonably by
5337 introducing newlines. All lines are indented by 4; the initial printing
5338 position must be set before calling.
5340 This function used always to print the error. Nowadays we want to restrict it
5341 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5342 and filter "fail". We no longer pass other information willy-nilly in bounce
5343 and warning messages. Text in user_message is always output; text in message
5344 only if the af_pass_message flag is set.
5348 f the FILE to print on
5355 print_address_error(address_item * addr, FILE * f, const uschar * t)
5357 int count = Ustrlen(t);
5358 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5360 if (!s && !(s = addr->user_message))
5363 fprintf(f, "\n %s", t);
5366 if (*s == '\\' && s[1] == 'n')
5376 if (*s++ == ':' && isspace(*s) && count > 45)
5378 fprintf(f, "\n "); /* sic (because space follows) */
5385 /***********************************************************
5386 * Print Diagnostic-Code for an address *
5387 ************************************************************/
5389 /* This function is called to print the error information out of an address for
5390 a bounce or a warning message. It tries to format the message reasonably as
5391 required by RFC 3461 by adding a space after each newline
5393 it uses the same logic as print_address_error() above. if af_pass_message is true
5394 and addr->message is set it uses the remote host answer. if not addr->user_message
5395 is used instead if available.
5399 f the FILE to print on
5405 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5407 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5410 /* af_pass_message and addr->message set ? print remote host answer */
5414 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5416 /* search first ": ". we assume to find the remote-MTA answer there */
5417 if (!(s = Ustrstr(addr->message, ": ")))
5418 return; /* not found, bail out */
5419 s += 2; /* skip ": " */
5420 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5422 /* no message available. do nothing */
5427 if (cnt > 950) /* RFC line length limit: 998 */
5429 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5430 fputs("[truncated]", f);
5434 if (*s == '\\' && s[1] == 'n')
5436 fputs("\n ", f); /* as defined in RFC 3461 */
5451 /*************************************************
5452 * Check list of addresses for duplication *
5453 *************************************************/
5455 /* This function was introduced when the test for duplicate addresses that are
5456 not pipes, files, or autoreplies was moved from the middle of routing to when
5457 routing was complete. That was to fix obscure cases when the routing history
5458 affects the subsequent routing of identical addresses. This function is called
5459 after routing, to check that the final routed addresses are not duplicates.
5461 If we detect a duplicate, we remember what it is a duplicate of. Note that
5462 pipe, file, and autoreply de-duplication is handled during routing, so we must
5463 leave such "addresses" alone here, as otherwise they will incorrectly be
5466 Argument: address of list anchor
5471 do_duplicate_check(address_item **anchor)
5474 while ((addr = *anchor))
5477 if (testflag(addr, af_pfr))
5479 anchor = &(addr->next);
5481 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5483 DEBUG(D_deliver|D_route)
5484 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5485 *anchor = addr->next;
5486 addr->dupof = tnode->data.ptr;
5487 addr->next = addr_duplicate;
5488 addr_duplicate = addr;
5492 tree_add_duplicate(addr->unique, addr);
5493 anchor = &(addr->next);
5501 /************************************************/
5504 print_dsn_addr_action(FILE * f, address_item * addr,
5505 uschar * action, uschar * status)
5509 if (addr->dsn_orcpt)
5510 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5512 for (pa = addr; pa->parent; ) pa = pa->parent;
5513 fprintf(f, "Action: %s\n"
5514 "Final-Recipient: rfc822;%s\n"
5516 action, pa->address, status);
5521 /* When running in the test harness, there's an option that allows us to
5522 fudge this time so as to get repeatability of the tests. Take the first
5523 time off the list. In queue runs, the list pointer gets updated in the
5527 test_harness_fudged_queue_time(int actual_time)
5530 if ( f.running_in_test_harness && *fudged_queue_times
5531 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5533 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5534 fudged_queue_times);
5540 /************************************************/
5543 expand_open(const uschar * filename,
5544 const uschar * varname, const uschar * reason)
5546 const uschar * s = expand_cstring(filename);
5550 log_write(0, LOG_MAIN|LOG_PANIC,
5551 "Failed to expand %s: '%s'\n", varname, filename);
5552 else if (*s != '/' || is_tainted(s))
5553 log_write(0, LOG_MAIN|LOG_PANIC,
5554 "%s is not %s after expansion: '%s'\n",
5555 varname, *s == '/' ? "untainted" : "absolute", s);
5556 else if (!(fp = Ufopen(s, "rb")))
5557 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5558 "message texts: %s", s, reason, strerror(errno));
5562 /*************************************************
5563 * Deliver one message *
5564 *************************************************/
5566 /* This is the function which is called when a message is to be delivered. It
5567 is passed the id of the message. It is possible that the message no longer
5568 exists, if some other process has delivered it, and it is also possible that
5569 the message is being worked on by another process, in which case the data file
5572 If no delivery is attempted for any of the above reasons, the function returns
5573 DELIVER_NOT_ATTEMPTED.
5575 If the give_up flag is set true, do not attempt any deliveries, but instead
5576 fail all outstanding addresses and return the message to the sender (or
5579 A delivery operation has a process all to itself; we never deliver more than
5580 one message in the same process. Therefore we needn't worry too much about
5583 Liable to be called as root.
5586 id the id of the message to be delivered
5587 forced TRUE if delivery was forced by an administrator; this overrides
5588 retry delays and causes a delivery to be tried regardless
5589 give_up TRUE if an administrator has requested that delivery attempts
5592 Returns: When the global variable mua_wrapper is FALSE:
5593 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5594 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5595 When the global variable mua_wrapper is TRUE:
5596 DELIVER_MUA_SUCCEEDED if delivery succeeded
5597 DELIVER_MUA_FAILED if delivery failed
5598 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5602 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5605 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5606 time_t now = time(NULL);
5607 address_item *addr_last = NULL;
5608 uschar *filter_message = NULL;
5609 int process_recipients = RECIP_ACCEPT;
5612 extern int acl_where;
5615 #ifdef MEASURE_TIMING
5616 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
5619 info = queue_run_pid == (pid_t)0
5620 ? string_sprintf("delivering %s", id)
5621 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5623 /* If the D_process_info bit is on, set_process_info() will output debugging
5624 information. If not, we want to show this initial information if D_deliver or
5625 D_queue_run is set or in verbose mode. */
5627 set_process_info("%s", info);
5629 if ( !(debug_selector & D_process_info)
5630 && (debug_selector & (D_deliver|D_queue_run|D_v))
5632 debug_printf("%s\n", info);
5634 /* Ensure that we catch any subprocesses that are created. Although Exim
5635 sets SIG_DFL as its initial default, some routes through the code end up
5636 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5637 has been forked, but no re-exec has been done. We use sigaction rather than
5638 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5639 sure it is turned off. (There was a problem on AIX with this.) */
5643 struct sigaction act;
5644 act.sa_handler = SIG_DFL;
5645 sigemptyset(&(act.sa_mask));
5647 sigaction(SIGCHLD, &act, NULL);
5650 signal(SIGCHLD, SIG_DFL);
5653 /* Make the forcing flag available for routers and transports, set up the
5654 global message id field, and initialize the count for returned files and the
5655 message size. This use of strcpy() is OK because the length id is checked when
5656 it is obtained from a command line (the -M or -q options), and otherwise it is
5657 known to be a valid message id. */
5659 if (id != message_id)
5660 Ustrcpy(message_id, id);
5661 f.deliver_force = forced;
5665 /* Initialize some flags */
5667 update_spool = FALSE;
5668 remove_journal = TRUE;
5670 /* Set a known context for any ACLs we call via expansions */
5671 acl_where = ACL_WHERE_DELIVERY;
5673 /* Reset the random number generator, so that if several delivery processes are
5674 started from a queue runner that has already used random numbers (for sorting),
5675 they don't all get the same sequence. */
5679 /* Open and lock the message's data file. Exim locks on this one because the
5680 header file may get replaced as it is re-written during the delivery process.
5681 Any failures cause messages to be written to the log, except for missing files
5682 while queue running - another process probably completed delivery. As part of
5683 opening the data file, message_subdir gets set. */
5685 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5686 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5688 /* The value of message_size at this point has been set to the data length,
5689 plus one for the blank line that notionally precedes the data. */
5691 /* Now read the contents of the header file, which will set up the headers in
5692 store, and also the list of recipients and the tree of non-recipients and
5693 assorted flags. It updates message_size. If there is a reading or format error,
5694 give up; if the message has been around for sufficiently long, remove it. */
5697 uschar * spoolname = string_sprintf("%s-H", id);
5698 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5700 if (errno == ERRNO_SPOOLFORMAT)
5702 struct stat statbuf;
5703 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5705 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5706 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5708 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5711 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5714 /* If we managed to read the envelope data, received_time contains the
5715 time the message was received. Otherwise, we can calculate it from the
5718 if (rc != spool_read_hdrerror)
5720 received_time.tv_sec = received_time.tv_usec = 0;
5721 /*XXX subsec precision?*/
5722 for (i = 0; i < 6; i++)
5723 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5726 /* If we've had this malformed message too long, sling it. */
5728 if (now - received_time.tv_sec > keep_malformed)
5730 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5731 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5732 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5733 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5734 log_write(0, LOG_MAIN, "Message removed because older than %s",
5735 readconf_printtime(keep_malformed));
5738 (void)close(deliver_datafile);
5739 deliver_datafile = -1;
5740 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5744 /* The spool header file has been read. Look to see if there is an existing
5745 journal file for this message. If there is, it means that a previous delivery
5746 attempt crashed (program or host) before it could update the spool header file.
5747 Read the list of delivered addresses from the journal and add them to the
5748 nonrecipients tree. Then update the spool file. We can leave the journal in
5749 existence, as it will get further successful deliveries added to it in this
5750 run, and it will be deleted if this function gets to its end successfully.
5751 Otherwise it might be needed again. */
5754 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5757 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5765 && lseek(journal_fd, 0, SEEK_SET) == 0
5766 && (jread = fdopen(journal_fd, "rb"))
5769 while (Ufgets(big_buffer, big_buffer_size, jread))
5771 int n = Ustrlen(big_buffer);
5772 big_buffer[n-1] = 0;
5773 tree_add_nonrecipient(big_buffer);
5774 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5775 "journal file\n", big_buffer);
5778 if ((journal_fd = dup(fileno(jread))) < 0)
5779 journal_fd = fileno(jread);
5781 (void) fclose(jread); /* Try to not leak the FILE resource */
5783 /* Panic-dies on error */
5784 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5786 else if (errno != ENOENT)
5788 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5789 "%s", strerror(errno));
5790 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5793 /* A null recipients list indicates some kind of disaster. */
5795 if (!recipients_list)
5797 (void)close(deliver_datafile);
5798 deliver_datafile = -1;
5799 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5800 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5805 /* Handle a message that is frozen. There are a number of different things that
5806 can happen, but in the default situation, unless forced, no delivery is
5809 if (f.deliver_freeze)
5811 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5812 /* Moving to another directory removes the message from Exim's view. Other
5813 tools must be used to deal with it. Logging of this action happens in
5814 spool_move_message() and its subfunctions. */
5816 if ( move_frozen_messages
5817 && spool_move_message(id, message_subdir, US"", US"F")
5819 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5822 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5823 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5824 flag causing all recipients to be failed. The time is the age of the
5825 message, not the time since freezing. */
5827 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5829 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5830 process_recipients = RECIP_FAIL_TIMEOUT;
5833 /* For bounce messages (and others with no sender), thaw if the error message
5834 ignore timer is exceeded. The message will be discarded if this delivery
5837 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5838 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5840 /* If this is a bounce message, or there's no auto thaw, or we haven't
5841 reached the auto thaw time yet, and this delivery is not forced by an admin
5842 user, do not attempt delivery of this message. Note that forced is set for
5843 continuing messages down the same channel, in order to skip load checking and
5844 ignore hold domains, but we don't want unfreezing in that case. */
5848 if ( ( sender_address[0] == 0
5850 || now <= deliver_frozen_at + auto_thaw
5852 && ( !forced || !f.deliver_force_thaw
5853 || !f.admin_user || continue_hostname
5856 (void)close(deliver_datafile);
5857 deliver_datafile = -1;
5858 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5859 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5862 /* If delivery was forced (by an admin user), assume a manual thaw.
5863 Otherwise it's an auto thaw. */
5867 f.deliver_manual_thaw = TRUE;
5868 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5870 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5873 /* We get here if any of the rules for unfreezing have triggered. */
5875 f.deliver_freeze = FALSE;
5876 update_spool = TRUE;
5880 /* Open the message log file if we are using them. This records details of
5881 deliveries, deferments, and failures for the benefit of the mail administrator.
5882 The log is not used by exim itself to track the progress of a message; that is
5883 done by rewriting the header spool file. */
5887 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5891 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5893 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5894 fname, strerror(errno));
5895 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5898 /* Make a stdio stream out of it. */
5900 if (!(message_log = fdopen(fd, "a")))
5902 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5903 fname, strerror(errno));
5904 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5909 /* If asked to give up on a message, log who did it, and set the action for all
5914 struct passwd *pw = getpwuid(real_uid);
5915 log_write(0, LOG_MAIN, "cancelled by %s",
5916 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5917 process_recipients = RECIP_FAIL;
5920 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5922 else if (received_count > received_headers_max)
5923 process_recipients = RECIP_FAIL_LOOP;
5925 /* Otherwise, if a system-wide, address-independent message filter is
5926 specified, run it now, except in the case when we are failing all recipients as
5927 a result of timeout_frozen_after. If the system filter yields "delivered", then
5928 ignore the true recipients of the message. Failure of the filter file is
5929 logged, and the delivery attempt fails. */
5931 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5936 redirect_block redirect;
5938 if (system_filter_uid_set)
5940 ugid.uid = system_filter_uid;
5941 ugid.gid = system_filter_gid;
5942 ugid.uid_set = ugid.gid_set = TRUE;
5945 ugid.uid_set = ugid.gid_set = FALSE;
5947 return_path = sender_address;
5948 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5949 f.system_filtering = TRUE;
5951 /* Any error in the filter file causes a delivery to be abandoned. */
5953 redirect.string = system_filter;
5954 redirect.isfile = TRUE;
5955 redirect.check_owner = redirect.check_group = FALSE;
5956 redirect.owners = NULL;
5957 redirect.owngroups = NULL;
5959 redirect.modemask = 0;
5961 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5964 &redirect, /* Where the data is */
5965 RDO_DEFER | /* Turn on all the enabling options */
5966 RDO_FAIL | /* Leave off all the disabling options */
5971 NULL, /* No :include: restriction (not used in filter) */
5972 NULL, /* No sieve vacation directory (not sieve!) */
5973 NULL, /* No sieve enotify mailto owner (not sieve!) */
5974 NULL, /* No sieve user address (not sieve!) */
5975 NULL, /* No sieve subaddress (not sieve!) */
5976 &ugid, /* uid/gid data */
5977 &addr_new, /* Where to hang generated addresses */
5978 &filter_message, /* Where to put error message */
5979 NULL, /* Don't skip syntax errors */
5980 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5981 US"system filter"); /* For error messages */
5983 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5985 if (rc == FF_ERROR || rc == FF_NONEXIST)
5987 (void)close(deliver_datafile);
5988 deliver_datafile = -1;
5989 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5990 string_printing(filter_message));
5991 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5994 /* Reset things. If the filter message is an empty string, which can happen
5995 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5997 f.system_filtering = FALSE;
5998 f.enable_dollar_recipients = FALSE;
5999 if (filter_message && filter_message[0] == 0) filter_message = NULL;
6001 /* Save the values of the system filter variables so that user filters
6004 memcpy(filter_sn, filter_n, sizeof(filter_sn));
6006 /* The filter can request that delivery of the original addresses be
6011 process_recipients = RECIP_DEFER;
6012 deliver_msglog("Delivery deferred by system filter\n");
6013 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6016 /* The filter can request that a message be frozen, but this does not
6017 take place if the message has been manually thawed. In that case, we must
6018 unset "delivered", which is forced by the "freeze" command to make -bF
6021 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6023 f.deliver_freeze = TRUE;
6024 deliver_frozen_at = time(NULL);
6025 process_recipients = RECIP_DEFER;
6026 frozen_info = string_sprintf(" by the system filter%s%s",
6027 filter_message ? US": " : US"",
6028 filter_message ? filter_message : US"");
6031 /* The filter can request that a message be failed. The error message may be
6032 quite long - it is sent back to the sender in the bounce - but we don't want
6033 to fill up the log with repetitions of it. If it starts with << then the text
6034 between << and >> is written to the log, with the rest left for the bounce
6037 else if (rc == FF_FAIL)
6039 uschar *colon = US"";
6040 uschar *logmsg = US"";
6043 process_recipients = RECIP_FAIL_FILTER;
6049 if ( filter_message[0] == '<'
6050 && filter_message[1] == '<'
6051 && (logend = Ustrstr(filter_message, ">>"))
6054 logmsg = filter_message + 2;
6055 loglen = logend - logmsg;
6056 filter_message = logend + 2;
6057 if (filter_message[0] == 0) filter_message = NULL;
6061 logmsg = filter_message;
6062 loglen = Ustrlen(filter_message);
6066 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6070 /* Delivery can be restricted only to those recipients (if any) that the
6071 filter specified. */
6073 else if (rc == FF_DELIVERED)
6075 process_recipients = RECIP_IGNORE;
6077 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6079 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6082 /* If any new addresses were created by the filter, fake up a "parent"
6083 for them. This is necessary for pipes, etc., which are expected to have
6084 parents, and it also gives some sensible logging for others. Allow
6085 pipes, files, and autoreplies, and run them as the filter uid if set,
6086 otherwise as the current uid. */
6090 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6091 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6093 /* The text "system-filter" is tested in transport_set_up_command() and in
6094 set_up_shell_command() in the pipe transport, to enable them to permit
6095 $recipients, so don't change it here without also changing it there. */
6097 address_item *p = addr_new;
6098 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6100 parent->domain = string_copylc(qualify_domain_recipient);
6101 parent->local_part = US"system-filter";
6103 /* As part of this loop, we arrange for addr_last to end up pointing
6104 at the final address. This is used if we go on to add addresses for the
6105 original recipients. */
6109 if (parent->child_count == USHRT_MAX)
6110 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6111 "than %d delivery addresses", USHRT_MAX);
6112 parent->child_count++;
6115 if (testflag(p, af_pfr))
6121 setflag(p, af_uid_set);
6122 setflag(p, af_gid_set);
6123 setflag(p, af_allow_file);
6124 setflag(p, af_allow_pipe);
6125 setflag(p, af_allow_reply);
6127 /* Find the name of the system filter's appropriate pfr transport */
6129 if (p->address[0] == '|')
6132 tpname = system_filter_pipe_transport;
6133 address_pipe = p->address;
6135 else if (p->address[0] == '>')
6138 tpname = system_filter_reply_transport;
6142 if (p->address[Ustrlen(p->address)-1] == '/')
6144 type = US"directory";
6145 tpname = system_filter_directory_transport;
6150 tpname = system_filter_file_transport;
6152 address_file = p->address;
6155 /* Now find the actual transport, first expanding the name. We have
6156 set address_file or address_pipe above. */
6160 uschar *tmp = expand_string(tpname);
6161 address_file = address_pipe = NULL;
6163 p->message = string_sprintf("failed to expand \"%s\" as a "
6164 "system filter transport name", tpname);
6165 if (is_tainted(tmp))
6166 p->message = string_sprintf("attempt to used tainted value '%s' for"
6167 "transport '%s' as a system filter", tmp, tpname);
6171 p->message = string_sprintf("system_filter_%s_transport is unset",
6176 transport_instance *tp;
6177 for (tp = transports; tp; tp = tp->next)
6178 if (Ustrcmp(tp->name, tpname) == 0)
6184 p->message = string_sprintf("failed to find \"%s\" transport "
6185 "for system filter delivery", tpname);
6188 /* If we couldn't set up a transport, defer the delivery, putting the
6189 error on the panic log as well as the main log. */
6193 address_item *badp = p;
6195 if (!addr_last) addr_new = p; else addr_last->next = p;
6196 badp->local_part = badp->address; /* Needed for log line */
6197 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6200 } /* End of pfr handling */
6202 /* Either a non-pfr delivery, or we found a transport */
6204 DEBUG(D_deliver|D_filter)
6205 debug_printf("system filter added %s\n", p->address);
6209 } /* Loop through all addr_new addresses */
6214 /* Scan the recipients list, and for every one that is not in the non-
6215 recipients tree, add an addr item to the chain of new addresses. If the pno
6216 value is non-negative, we must set the onetime parent from it. This which
6217 points to the relevant entry in the recipients list.
6219 This processing can be altered by the setting of the process_recipients
6220 variable, which is changed if recipients are to be ignored, failed, or
6221 deferred. This can happen as a result of system filter activity, or if the -Mg
6222 option is used to fail all of them.
6224 Duplicate addresses are handled later by a different tree structure; we can't
6225 just extend the non-recipients tree, because that will be re-written to the
6226 spool if the message is deferred, and in any case there are casing
6227 complications for local addresses. */
6229 if (process_recipients != RECIP_IGNORE)
6230 for (i = 0; i < recipients_count; i++)
6231 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6233 recipient_item *r = recipients_list + i;
6234 address_item *new = deliver_make_addr(r->address, FALSE);
6235 new->prop.errors_address = r->errors_to;
6237 if ((new->prop.utf8_msg = message_smtputf8))
6239 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6240 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6241 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6242 new->prop.utf8_downcvt ? "yes"
6243 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6249 new->onetime_parent = recipients_list[r->pno].address;
6251 /* If DSN support is enabled, set the dsn flags and the original receipt
6252 to be passed on to other DSN enabled MTAs */
6254 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6255 new->dsn_orcpt = r->orcpt;
6256 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6257 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6259 switch (process_recipients)
6261 /* RECIP_DEFER is set when a system filter freezes a message. */
6264 new->next = addr_defer;
6269 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6272 case RECIP_FAIL_FILTER:
6274 filter_message ? filter_message : US"delivery cancelled";
6275 setflag(new, af_pass_message);
6276 goto RECIP_QUEUE_FAILED; /* below */
6279 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6280 than the value in timeout_frozen_after. Treat non-bounce messages
6281 similarly to -Mg; for bounce messages we just want to discard, so
6282 don't put the address on the failed list. The timeout has already
6285 case RECIP_FAIL_TIMEOUT:
6286 new->message = US"delivery cancelled; message timed out";
6287 goto RECIP_QUEUE_FAILED; /* below */
6290 /* RECIP_FAIL is set when -Mg has been used. */
6293 new->message = US"delivery cancelled by administrator";
6296 /* Common code for the failure cases above. If this is not a bounce
6297 message, put the address on the failed list so that it is used to
6298 create a bounce. Otherwise do nothing - this just discards the address.
6299 The incident has already been logged. */
6302 if (sender_address[0])
6304 new->next = addr_failed;
6310 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6311 in the message. Process each address as a routing failure; if this
6312 is a bounce message, it will get frozen. */
6314 case RECIP_FAIL_LOOP:
6315 new->message = US"Too many \"Received\" headers - suspected mail loop";
6316 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6320 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6323 if (!addr_new) addr_new = new; else addr_last->next = new;
6328 #ifndef DISABLE_EVENT
6329 if (process_recipients != RECIP_ACCEPT && event_action)
6331 uschar * save_local = deliver_localpart;
6332 const uschar * save_domain = deliver_domain;
6333 uschar * addr = new->address, * errmsg = NULL;
6334 int start, end, dom;
6336 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6337 log_write(0, LOG_MAIN|LOG_PANIC,
6338 "failed to parse address '%.100s': %s\n", addr, errmsg);
6342 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6343 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6345 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
6347 deliver_localpart = save_local;
6348 deliver_domain = save_domain;
6356 debug_printf("Delivery address list:\n");
6357 for (address_item * p = addr_new; p; p = p->next)
6358 debug_printf(" %s %s\n", p->address,
6359 p->onetime_parent ? p->onetime_parent : US"");
6362 /* Set up the buffers used for copying over the file when delivering. */
6364 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6365 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6369 /* Until there are no more new addresses, handle each one as follows:
6371 . If this is a generated address (indicated by the presence of a parent
6372 pointer) then check to see whether it is a pipe, file, or autoreply, and
6373 if so, handle it directly here. The router that produced the address will
6374 have set the allow flags into the address, and also set the uid/gid required.
6375 Having the routers generate new addresses and then checking them here at
6376 the outer level is tidier than making each router do the checking, and
6377 means that routers don't need access to the failed address queue.
6379 . Break up the address into local part and domain, and make lowercased
6380 versions of these strings. We also make unquoted versions of the local part.
6382 . Handle the percent hack for those domains for which it is valid.
6384 . For child addresses, determine if any of the parents have the same address.
6385 If so, generate a different string for previous delivery checking. Without
6386 this code, if the address spqr generates spqr via a forward or alias file,
6387 delivery of the generated spqr stops further attempts at the top level spqr,
6388 which is not what is wanted - it may have generated other addresses.
6390 . Check on the retry database to see if routing was previously deferred, but
6391 only if in a queue run. Addresses that are to be routed are put on the
6392 addr_route chain. Addresses that are to be deferred are put on the
6393 addr_defer chain. We do all the checking first, so as not to keep the
6394 retry database open any longer than necessary.
6396 . Now we run the addresses through the routers. A router may put the address
6397 on either the addr_local or the addr_remote chain for local or remote
6398 delivery, respectively, or put it on the addr_failed chain if it is
6399 undeliveable, or it may generate child addresses and put them on the
6400 addr_new chain, or it may defer an address. All the chain anchors are
6401 passed as arguments so that the routers can be called for verification
6404 . If new addresses have been generated by the routers, da capo.
6407 f.header_rewritten = FALSE; /* No headers rewritten yet */
6408 while (addr_new) /* Loop until all addresses dealt with */
6410 address_item *addr, *parent;
6412 /* Failure to open the retry database is treated the same as if it does
6413 not exist. In both cases, dbm_file is NULL. */
6415 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6416 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6417 debug_printf("no retry data available\n");
6419 /* Scan the current batch of new addresses, to handle pipes, files and
6420 autoreplies, and determine which others are ready for routing. */
6426 dbdata_retry * domain_retry_record, * address_retry_record;
6429 addr_new = addr->next;
6431 DEBUG(D_deliver|D_retry|D_route)
6433 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6434 debug_printf("Considering: %s\n", addr->address);
6437 /* Handle generated address that is a pipe or a file or an autoreply. */
6439 if (testflag(addr, af_pfr))
6441 /* If an autoreply in a filter could not generate a syntactically valid
6442 address, give up forthwith. Set af_ignore_error so that we don't try to
6443 generate a bounce. */
6445 if (testflag(addr, af_bad_reply))
6447 addr->basic_errno = ERRNO_BADADDRESS2;
6448 addr->local_part = addr->address;
6450 US"filter autoreply generated syntactically invalid recipient";
6451 addr->prop.ignore_error = TRUE;
6452 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6453 continue; /* with the next new address */
6456 /* If two different users specify delivery to the same pipe or file or
6457 autoreply, there should be two different deliveries, so build a unique
6458 string that incorporates the original address, and use this for
6459 duplicate testing and recording delivery, and also for retrying. */
6462 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6463 (testflag(addr->parent, af_homonym)? 3:0));
6465 addr->address_retry_key = addr->domain_retry_key =
6466 string_sprintf("T:%s", addr->unique);
6468 /* If a filter file specifies two deliveries to the same pipe or file,
6469 we want to de-duplicate, but this is probably not wanted for two mail
6470 commands to the same address, where probably both should be delivered.
6471 So, we have to invent a different unique string in that case. Just
6472 keep piling '>' characters on the front. */
6474 if (addr->address[0] == '>')
6475 while (tree_search(tree_duplicates, addr->unique))
6476 addr->unique = string_sprintf(">%s", addr->unique);
6478 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6480 DEBUG(D_deliver|D_route)
6481 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6482 addr->dupof = tnode->data.ptr;
6483 addr->next = addr_duplicate;
6484 addr_duplicate = addr;
6488 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6490 /* Check for previous delivery */
6492 if (tree_search(tree_nonrecipients, addr->unique))
6494 DEBUG(D_deliver|D_route)
6495 debug_printf("%s was previously delivered: discarded\n", addr->address);
6496 child_done(addr, tod_stamp(tod_log));
6500 /* Save for checking future duplicates */
6502 tree_add_duplicate(addr->unique, addr);
6504 /* Set local part and domain */
6506 addr->local_part = addr->address;
6507 addr->domain = addr->parent->domain;
6509 /* Ensure that the delivery is permitted. */
6511 if (testflag(addr, af_file))
6513 if (!testflag(addr, af_allow_file))
6515 addr->basic_errno = ERRNO_FORBIDFILE;
6516 addr->message = US"delivery to file forbidden";
6517 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6518 continue; /* with the next new address */
6521 else if (addr->address[0] == '|')
6523 if (!testflag(addr, af_allow_pipe))
6525 addr->basic_errno = ERRNO_FORBIDPIPE;
6526 addr->message = US"delivery to pipe forbidden";
6527 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6528 continue; /* with the next new address */
6531 else if (!testflag(addr, af_allow_reply))
6533 addr->basic_errno = ERRNO_FORBIDREPLY;
6534 addr->message = US"autoreply forbidden";
6535 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6536 continue; /* with the next new address */
6539 /* If the errno field is already set to BADTRANSPORT, it indicates
6540 failure to expand a transport string, or find the associated transport,
6541 or an unset transport when one is required. Leave this test till now so
6542 that the forbid errors are given in preference. */
6544 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6546 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6550 /* Treat /dev/null as a special case and abandon the delivery. This
6551 avoids having to specify a uid on the transport just for this case.
6552 Arrange for the transport name to be logged as "**bypassed**".
6553 Copy the transport for this fairly unusual case rather than having
6554 to make all transports mutable. */
6556 if (Ustrcmp(addr->address, "/dev/null") == 0)
6558 transport_instance * save_t = addr->transport;
6559 transport_instance * t = store_get(sizeof(*t), save_t);
6561 t->name = US"**bypassed**";
6562 addr->transport = t;
6563 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6564 addr->transport= save_t;
6565 continue; /* with the next new address */
6568 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6571 DEBUG(D_deliver|D_route)
6572 debug_printf("queued for %s transport\n", addr->transport->name);
6573 addr->next = addr_local;
6575 continue; /* with the next new address */
6578 /* Handle normal addresses. First, split up into local part and domain,
6579 handling the %-hack if necessary. There is the possibility of a defer from
6580 a lookup in percent_hack_domains. */
6582 if ((rc = deliver_split_address(addr)) == DEFER)
6584 addr->message = US"cannot check percent_hack_domains";
6585 addr->basic_errno = ERRNO_LISTDEFER;
6586 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6590 /* Check to see if the domain is held. If so, proceed only if the
6591 delivery was forced by hand. */
6593 deliver_domain = addr->domain; /* set $domain */
6594 if ( !forced && hold_domains
6595 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6596 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6602 addr->message = US"hold_domains lookup deferred";
6603 addr->basic_errno = ERRNO_LISTDEFER;
6607 addr->message = US"domain is held";
6608 addr->basic_errno = ERRNO_HELD;
6610 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6614 /* Now we can check for duplicates and previously delivered addresses. In
6615 order to do this, we have to generate a "unique" value for each address,
6616 because there may be identical actual addresses in a line of descendents.
6617 The "unique" field is initialized to the same value as the "address" field,
6618 but gets changed here to cope with identically-named descendents. */
6620 for (parent = addr->parent; parent; parent = parent->parent)
6621 if (strcmpic(addr->address, parent->address) == 0) break;
6623 /* If there's an ancestor with the same name, set the homonym flag. This
6624 influences how deliveries are recorded. Then add a prefix on the front of
6625 the unique address. We use \n\ where n starts at 0 and increases each time.
6626 It is unlikely to pass 9, but if it does, it may look odd but will still
6627 work. This means that siblings or cousins with the same names are treated
6628 as duplicates, which is what we want. */
6632 setflag(addr, af_homonym);
6633 if (parent->unique[0] != '\\')
6634 addr->unique = string_sprintf("\\0\\%s", addr->address);
6636 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6640 /* Ensure that the domain in the unique field is lower cased, because
6641 domains are always handled caselessly. */
6643 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
6645 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6647 if (tree_search(tree_nonrecipients, addr->unique))
6649 DEBUG(D_deliver|D_route)
6650 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6651 child_done(addr, tod_stamp(tod_log));
6655 /* Get the routing retry status, saving the two retry keys (with and
6656 without the local part) for subsequent use. If there is no retry record for
6657 the standard address routing retry key, we look for the same key with the
6658 sender attached, because this form is used by the smtp transport after a
6659 4xx response to RCPT when address_retry_include_sender is true. */
6661 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6662 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6667 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6668 if ( domain_retry_record
6669 && now - domain_retry_record->time_stamp > retry_data_expire
6672 DEBUG(D_deliver|D_retry)
6673 debug_printf("domain retry record present but expired\n");
6674 domain_retry_record = NULL; /* Ignore if too old */
6677 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6678 if ( address_retry_record
6679 && now - address_retry_record->time_stamp > retry_data_expire
6682 DEBUG(D_deliver|D_retry)
6683 debug_printf("address retry record present but expired\n");
6684 address_retry_record = NULL; /* Ignore if too old */
6687 if (!address_retry_record)
6689 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6691 address_retry_record = dbfn_read(dbm_file, altkey);
6692 if ( address_retry_record
6693 && now - address_retry_record->time_stamp > retry_data_expire)
6695 DEBUG(D_deliver|D_retry)
6696 debug_printf("address<sender> retry record present but expired\n");
6697 address_retry_record = NULL; /* Ignore if too old */
6702 domain_retry_record = address_retry_record = NULL;
6704 DEBUG(D_deliver|D_retry)
6706 if (!domain_retry_record)
6707 debug_printf("no domain retry record\n");
6709 debug_printf("have domain retry record; next_try = now%+d\n",
6710 f.running_in_test_harness ? 0 :
6711 (int)(domain_retry_record->next_try - now));
6713 if (!address_retry_record)
6714 debug_printf("no address retry record\n");
6716 debug_printf("have address retry record; next_try = now%+d\n",
6717 f.running_in_test_harness ? 0 :
6718 (int)(address_retry_record->next_try - now));
6721 /* If we are sending a message down an existing SMTP connection, we must
6722 assume that the message which created the connection managed to route
6723 an address to that connection. We do not want to run the risk of taking
6724 a long time over routing here, because if we do, the server at the other
6725 end of the connection may time it out. This is especially true for messages
6726 with lots of addresses. For this kind of delivery, queue_running is not
6727 set, so we would normally route all addresses. We take a pragmatic approach
6728 and defer routing any addresses that have any kind of domain retry record.
6729 That is, we don't even look at their retry times. It doesn't matter if this
6730 doesn't work occasionally. This is all just an optimization, after all.
6732 The reason for not doing the same for address retries is that they normally
6733 arise from 4xx responses, not DNS timeouts. */
6735 if (continue_hostname && domain_retry_record)
6737 addr->message = US"reusing SMTP connection skips previous routing defer";
6738 addr->basic_errno = ERRNO_RRETRY;
6739 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6741 addr->message = domain_retry_record->text;
6742 setflag(addr, af_pass_message);
6745 /* If we are in a queue run, defer routing unless there is no retry data or
6746 we've passed the next retry time, or this message is forced. In other
6747 words, ignore retry data when not in a queue run.
6749 However, if the domain retry time has expired, always allow the routing
6750 attempt. If it fails again, the address will be failed. This ensures that
6751 each address is routed at least once, even after long-term routing
6754 If there is an address retry, check that too; just wait for the next
6755 retry time. This helps with the case when the temporary error on the
6756 address was really message-specific rather than address specific, since
6757 it allows other messages through.
6759 We also wait for the next retry time if this is a message sent down an
6760 existing SMTP connection (even though that will be forced). Otherwise there
6761 will be far too many attempts for an address that gets a 4xx error. In
6762 fact, after such an error, we should not get here because, the host should
6763 not be remembered as one this message needs. However, there was a bug that
6764 used to cause this to happen, so it is best to be on the safe side.
6766 Even if we haven't reached the retry time in the hints, there is one more
6767 check to do, which is for the ultimate address timeout. We only do this
6768 check if there is an address retry record and there is not a domain retry
6769 record; this implies that previous attempts to handle the address had the
6770 retry_use_local_parts option turned on. We use this as an approximation
6771 for the destination being like a local delivery, for example delivery over
6772 LMTP to an IMAP message store. In this situation users are liable to bump
6773 into their quota and thereby have intermittently successful deliveries,
6774 which keep the retry record fresh, which can lead to us perpetually
6775 deferring messages. */
6777 else if ( ( f.queue_running && !f.deliver_force
6778 || continue_hostname
6780 && ( ( domain_retry_record
6781 && now < domain_retry_record->next_try
6782 && !domain_retry_record->expired
6784 || ( address_retry_record
6785 && now < address_retry_record->next_try
6787 && ( domain_retry_record
6788 || !address_retry_record
6789 || !retry_ultimate_address_timeout(addr->address_retry_key,
6790 addr->domain, address_retry_record, now)
6793 addr->message = US"retry time not reached";
6794 addr->basic_errno = ERRNO_RRETRY;
6795 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6797 /* For remote-retry errors (here and just above) that we've not yet
6798 hit the retry time, use the error recorded in the retry database
6799 as info in the warning message. This lets us send a message even
6800 when we're not failing on a fresh attempt. We assume that this
6801 info is not sensitive. */
6803 addr->message = domain_retry_record
6804 ? domain_retry_record->text : address_retry_record->text;
6805 setflag(addr, af_pass_message);
6808 /* The domain is OK for routing. Remember if retry data exists so it
6809 can be cleaned up after a successful delivery. */
6813 if (domain_retry_record || address_retry_record)
6814 setflag(addr, af_dr_retry_exists);
6815 addr->next = addr_route;
6817 DEBUG(D_deliver|D_route)
6818 debug_printf("%s: queued for routing\n", addr->address);
6822 /* The database is closed while routing is actually happening. Requests to
6823 update it are put on a chain and all processed together at the end. */
6825 if (dbm_file) dbfn_close(dbm_file);
6827 /* If queue_domains is set, we don't even want to try routing addresses in
6828 those domains. During queue runs, queue_domains is forced to be unset.
6829 Optimize by skipping this pass through the addresses if nothing is set. */
6831 if (!f.deliver_force && queue_domains)
6833 address_item *okaddr = NULL;
6836 address_item *addr = addr_route;
6837 addr_route = addr->next;
6839 deliver_domain = addr->domain; /* set $domain */
6840 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
6841 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6845 addr->basic_errno = ERRNO_LISTDEFER;
6846 addr->message = US"queue_domains lookup deferred";
6847 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6851 addr->next = okaddr;
6856 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6857 addr->message = US"domain is in queue_domains";
6858 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6862 addr_route = okaddr;
6865 /* Now route those addresses that are not deferred. */
6870 address_item *addr = addr_route;
6871 const uschar *old_domain = addr->domain;
6872 uschar *old_unique = addr->unique;
6873 addr_route = addr->next;
6876 /* Just in case some router parameter refers to it. */
6878 if (!(return_path = addr->prop.errors_address))
6879 return_path = sender_address;
6881 /* If a router defers an address, add a retry item. Whether or not to
6882 use the local part in the key is a property of the router. */
6884 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6885 &addr_succeed, v_none)) == DEFER)
6886 retry_add_item(addr,
6887 addr->router->retry_use_local_part
6888 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6889 : string_sprintf("R:%s", addr->domain),
6892 /* Otherwise, if there is an existing retry record in the database, add
6893 retry items to delete both forms. We must also allow for the possibility
6894 of a routing retry that includes the sender address. Since the domain might
6895 have been rewritten (expanded to fully qualified) as a result of routing,
6896 ensure that the rewritten form is also deleted. */
6898 else if (testflag(addr, af_dr_retry_exists))
6900 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6902 retry_add_item(addr, altkey, rf_delete);
6903 retry_add_item(addr, addr->address_retry_key, rf_delete);
6904 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6905 if (Ustrcmp(addr->domain, old_domain) != 0)
6906 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6909 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6910 logged, but we need to ensure the address (and maybe parents) is marked
6915 address_done(addr, tod_stamp(tod_log));
6916 continue; /* route next address */
6919 /* The address is finished with (failed or deferred). */
6923 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6924 continue; /* route next address */
6927 /* The address has been routed. If the router changed the domain, it will
6928 also have changed the unique address. We have to test whether this address
6929 has already been delivered, because it's the unique address that finally
6932 if ( addr->unique != old_unique
6933 && tree_search(tree_nonrecipients, addr->unique) != 0
6936 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6937 "discarded\n", addr->address);
6938 if (addr_remote == addr) addr_remote = addr->next;
6939 else if (addr_local == addr) addr_local = addr->next;
6942 /* If the router has same_domain_copy_routing set, we are permitted to copy
6943 the routing for any other addresses with the same domain. This is an
6944 optimisation to save repeated DNS lookups for "standard" remote domain
6945 routing. The option is settable only on routers that generate host lists.
6946 We play it very safe, and do the optimization only if the address is routed
6947 to a remote transport, there are no header changes, and the domain was not
6948 modified by the router. */
6950 if ( addr_remote == addr
6951 && addr->router->same_domain_copy_routing
6952 && !addr->prop.extra_headers
6953 && !addr->prop.remove_headers
6954 && old_domain == addr->domain
6957 address_item **chain = &addr_route;
6960 address_item *addr2 = *chain;
6961 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6963 chain = &(addr2->next);
6967 /* Found a suitable address; take it off the routing list and add it to
6968 the remote delivery list. */
6970 *chain = addr2->next;
6971 addr2->next = addr_remote;
6972 addr_remote = addr2;
6974 /* Copy the routing data */
6976 addr2->domain = addr->domain;
6977 addr2->router = addr->router;
6978 addr2->transport = addr->transport;
6979 addr2->host_list = addr->host_list;
6980 addr2->fallback_hosts = addr->fallback_hosts;
6981 addr2->prop.errors_address = addr->prop.errors_address;
6982 copyflag(addr2, addr, af_hide_child);
6983 copyflag(addr2, addr, af_local_host_removed);
6985 DEBUG(D_deliver|D_route)
6986 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6988 "Routing for %s copied from %s\n",
6989 addr2->address, addr2->address, addr->address);
6992 } /* Continue with routing the next address. */
6993 } /* Loop to process any child addresses that the routers created, and
6994 any rerouted addresses that got put back on the new chain. */
6997 /* Debugging: show the results of the routing */
6999 DEBUG(D_deliver|D_retry|D_route)
7001 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7002 debug_printf("After routing:\n Local deliveries:\n");
7003 for (address_item * p = addr_local; p; p = p->next)
7004 debug_printf(" %s\n", p->address);
7006 debug_printf(" Remote deliveries:\n");
7007 for (address_item * p = addr_remote; p; p = p->next)
7008 debug_printf(" %s\n", p->address);
7010 debug_printf(" Failed addresses:\n");
7011 for (address_item * p = addr_failed; p; p = p->next)
7012 debug_printf(" %s\n", p->address);
7014 debug_printf(" Deferred addresses:\n");
7015 for (address_item * p = addr_defer; p; p = p->next)
7016 debug_printf(" %s\n", p->address);
7019 /* Free any resources that were cached during routing. */
7024 /* These two variables are set only during routing, after check_local_user.
7025 Ensure they are not set in transports. */
7027 local_user_gid = (gid_t)(-1);
7028 local_user_uid = (uid_t)(-1);
7030 /* Check for any duplicate addresses. This check is delayed until after
7031 routing, because the flexibility of the routing configuration means that
7032 identical addresses with different parentage may end up being redirected to
7033 different addresses. Checking for duplicates too early (as we previously used
7034 to) makes this kind of thing not work. */
7036 do_duplicate_check(&addr_local);
7037 do_duplicate_check(&addr_remote);
7039 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7040 remote transport. The check that they all end up in one transaction happens in
7041 the do_remote_deliveries() function. */
7044 && (addr_local || addr_failed || addr_defer)
7048 uschar *which, *colon, *msg;
7055 else if (addr_defer)
7058 which = US"deferred";
7066 while (addr->parent) addr = addr->parent;
7071 msg = addr->message;
7073 else colon = msg = US"";
7075 /* We don't need to log here for a forced failure as it will already
7076 have been logged. Defer will also have been logged, but as a defer, so we do
7077 need to do the failure logging. */
7079 if (addr != addr_failed)
7080 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7081 addr->address, which);
7083 /* Always write an error to the caller */
7085 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7088 final_yield = DELIVER_MUA_FAILED;
7089 addr_failed = addr_defer = NULL; /* So that we remove the message */
7090 goto DELIVERY_TIDYUP;
7094 /* If this is a run to continue deliveries to an external channel that is
7095 already set up, defer any local deliveries.
7097 jgh 2020/12/20: I don't see why; locals should be quick.
7098 The defer goes back to version 1.62 in 1997. A local being still deliverable
7099 during a continued run might result from something like a defer during the
7100 original delivery, eg. in a DB lookup. Unlikely but possible.
7102 To avoid delaying a local when combined with a callout-hold for a remote
7103 delivery, test continue_sequence rather than continue_transport. */
7105 if (continue_sequence > 1 && addr_local)
7107 DEBUG(D_deliver|D_retry|D_route)
7108 debug_printf("deferring local deliveries due to continued-transport\n");
7111 address_item * addr = addr_defer;
7112 while (addr->next) addr = addr->next;
7113 addr->next = addr_local;
7116 addr_defer = addr_local;
7121 /* Because address rewriting can happen in the routers, we should not really do
7122 ANY deliveries until all addresses have been routed, so that all recipients of
7123 the message get the same headers. However, this is in practice not always
7124 possible, since sometimes remote addresses give DNS timeouts for days on end.
7125 The pragmatic approach is to deliver what we can now, saving any rewritten
7126 headers so that at least the next lot of recipients benefit from the rewriting
7127 that has already been done.
7129 If any headers have been rewritten during routing, update the spool file to
7130 remember them for all subsequent deliveries. This can be delayed till later if
7131 there is only address to be delivered - if it succeeds the spool write need not
7134 if ( f.header_rewritten
7135 && ( addr_local && (addr_local->next || addr_remote)
7136 || addr_remote && addr_remote->next
7139 /* Panic-dies on error */
7140 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7141 f.header_rewritten = FALSE;
7145 /* If there are any deliveries to do and we do not already have the journal
7146 file, create it. This is used to record successful deliveries as soon as
7147 possible after each delivery is known to be complete. A file opened with
7148 O_APPEND is used so that several processes can run simultaneously.
7150 The journal is just insurance against crashes. When the spool file is
7151 ultimately updated at the end of processing, the journal is deleted. If a
7152 journal is found to exist at the start of delivery, the addresses listed
7153 therein are added to the non-recipients. */
7155 if (addr_local || addr_remote)
7159 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7161 if ((journal_fd = Uopen(fname,
7165 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7167 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7168 fname, strerror(errno));
7169 return DELIVER_NOT_ATTEMPTED;
7172 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7173 that the mode is correct - the group setting doesn't always seem to get
7174 set automatically. */
7176 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7177 || fchmod(journal_fd, SPOOL_MODE)
7179 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7183 int ret = Uunlink(fname);
7184 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7185 fname, strerror(errno));
7186 if(ret && errno != ENOENT)
7187 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7188 fname, strerror(errno));
7189 return DELIVER_NOT_ATTEMPTED;
7193 else if (journal_fd >= 0)
7201 /* Now we can get down to the business of actually doing deliveries. Local
7202 deliveries are done first, then remote ones. If ever the problems of how to
7203 handle fallback transports are figured out, this section can be put into a loop
7204 for handling fallbacks, though the uid switching will have to be revised. */
7206 /* Precompile a regex that is used to recognize a parameter in response
7207 to an LHLO command, if is isn't already compiled. This may be used on both
7208 local and remote LMTP deliveries. */
7210 if (!regex_IGNOREQUOTA)
7212 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7214 /* Handle local deliveries */
7218 DEBUG(D_deliver|D_transport)
7219 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7220 do_local_deliveries();
7221 f.disable_logging = FALSE;
7224 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7225 so just queue them all. */
7227 if (f.queue_run_local)
7230 address_item *addr = addr_remote;
7231 addr_remote = addr->next;
7233 addr->basic_errno = ERRNO_LOCAL_ONLY;
7234 addr->message = US"remote deliveries suppressed";
7235 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7238 /* Handle remote deliveries */
7242 DEBUG(D_deliver|D_transport)
7243 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7245 /* Precompile some regex that are used to recognize parameters in response
7246 to an EHLO command, if they aren't already compiled. */
7248 smtp_deliver_init();
7250 /* Now sort the addresses if required, and do the deliveries. The yield of
7251 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7252 cannot be delivered in one transaction. */
7254 if (remote_sort_domains) sort_remote_deliveries();
7255 if (!do_remote_deliveries(FALSE))
7257 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7258 "be delivered in one transaction");
7259 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7261 final_yield = DELIVER_MUA_FAILED;
7262 addr_failed = addr_defer = NULL; /* So that we remove the message */
7263 goto DELIVERY_TIDYUP;
7266 /* See if any of the addresses that failed got put on the queue for delivery
7267 to their fallback hosts. We do it this way because often the same fallback
7268 host is used for many domains, so all can be sent in a single transaction
7269 (if appropriately configured). */
7271 if (addr_fallback && !mua_wrapper)
7273 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7274 addr_remote = addr_fallback;
7275 addr_fallback = NULL;
7276 if (remote_sort_domains) sort_remote_deliveries();
7277 do_remote_deliveries(TRUE);
7279 f.disable_logging = FALSE;
7283 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7284 phase, to minimize cases of half-done things. */
7287 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7288 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7290 /* Root privilege is no longer needed */
7292 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7294 set_process_info("tidying up after delivering %s", message_id);
7295 signal(SIGTERM, SIG_IGN);
7297 /* When we are acting as an MUA wrapper, the smtp transport will either have
7298 succeeded for all addresses, or failed them all in normal cases. However, there
7299 are some setup situations (e.g. when a named port does not exist) that cause an
7300 immediate exit with deferral of all addresses. Convert those into failures. We
7301 do not ever want to retry, nor do we want to send a bounce message. */
7307 address_item * nextaddr;
7308 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7310 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7311 "delivery", addr->address);
7312 nextaddr = addr->next;
7313 addr->next = addr_failed;
7319 /* Now all should either have succeeded or failed. */
7322 final_yield = DELIVER_MUA_SUCCEEDED;
7326 uschar *s = addr_failed->user_message;
7328 if (!s) s = addr_failed->message;
7330 fprintf(stderr, "Delivery failed: ");
7331 if (addr_failed->basic_errno > 0)
7333 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7334 if (s) fprintf(stderr, ": ");
7336 if ((host = addr_failed->host_used))
7337 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7339 fprintf(stderr, "%s", CS s);
7340 else if (addr_failed->basic_errno <= 0)
7341 fprintf(stderr, "unknown error");
7342 fprintf(stderr, "\n");
7344 final_yield = DELIVER_MUA_FAILED;
7349 /* In a normal configuration, we now update the retry database. This is done in
7350 one fell swoop at the end in order not to keep opening and closing (and
7351 locking) the database. The code for handling retries is hived off into a
7352 separate module for convenience. We pass it the addresses of the various
7353 chains, because deferred addresses can get moved onto the failed chain if the
7354 retry cutoff time has expired for all alternative destinations. Bypass the
7355 updating of the database if the -N flag is set, which is a debugging thing that
7356 prevents actual delivery. */
7358 else if (!f.dont_deliver)
7359 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7361 /* Send DSN for successful messages if requested */
7362 addr_senddsn = NULL;
7364 for (address_item * a = addr_succeed; a; a = a->next)
7366 /* af_ignore_error not honored here. it's not an error */
7367 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7368 "DSN: processing successful delivery address: %s\n"
7369 "DSN: Sender_address: %s\n"
7370 "DSN: orcpt: %s flags: 0x%x\n"
7371 "DSN: envid: %s ret: %d\n"
7372 "DSN: Final recipient: %s\n"
7373 "DSN: Remote SMTP server supports DSN: %d\n",
7374 a->router ? a->router->name : US"(unknown)",
7377 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7379 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7384 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7385 and a report was requested */
7387 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7388 && a->dsn_flags & rf_notify_success
7391 /* copy and relink address_item and send report with all of them at once later */
7392 address_item * addr_next = addr_senddsn;
7393 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
7395 addr_senddsn->next = addr_next;
7398 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7406 /* create exim process to send message */
7407 pid = child_open_exim(&fd, US"DSN");
7409 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7411 if (pid < 0) /* Creation of child failed */
7413 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7414 "create child process to send success-dsn message: %s", getpid(),
7415 getppid(), strerror(errno));
7417 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7419 else /* Creation of child succeeded */
7421 FILE * f = fdopen(fd, "wb");
7422 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7424 transport_ctx tctx = {{0}};
7427 debug_printf("sending success-dsn to: %s\n", sender_address);
7429 /* build unique id for MIME boundary */
7430 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7431 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7433 if (errors_reply_to)
7434 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7437 fprintf(f, "Auto-Submitted: auto-generated\n"
7439 "Subject: Delivery Status Notification\n",
7441 moan_write_references(f, NULL);
7442 fprintf(f, "Content-Type: multipart/report;"
7443 " report-type=delivery-status; boundary=%s\n"
7444 "MIME-Version: 1.0\n\n"
7447 "Content-type: text/plain; charset=us-ascii\n\n"
7449 "This message was created automatically by mail delivery software.\n"
7450 " ----- The following addresses had successful delivery notifications -----\n",
7453 for (address_item * a = addr_senddsn; a; a = a->next)
7454 fprintf(f, "<%s> (relayed %s)\n\n",
7456 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7457 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7458 : "via non \"Remote SMTP\" router"
7462 "Content-type: message/delivery-status\n\n"
7463 "Reporting-MTA: dns; %s\n",
7464 bound, smtp_active_hostname);
7467 { /* must be decoded from xtext: see RFC 3461:6.3a */
7469 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7470 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7472 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7476 for (address_item * a = addr_senddsn; a; a = a->next)
7480 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7482 if ((hu = a->host_used) && hu->name)
7483 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7486 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7487 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7490 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7493 transport_filter_argv = NULL; /* Just in case */
7494 return_path = sender_address; /* In case not previously set */
7496 /* Write the original email out */
7499 tctx.options = topt_add_return_path | topt_no_body;
7500 /*XXX hmm, FALSE(fail) retval ignored.
7501 Could error for any number of reasons, and they are not handled. */
7502 transport_write_message(&tctx, 0);
7505 fprintf(f,"\n--%s--\n", bound);
7509 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7513 /* If any addresses failed, we must send a message to somebody, unless
7514 af_ignore_error is set, in which case no action is taken. It is possible for
7515 several messages to get sent if there are addresses with different
7522 uschar *logtod = tod_stamp(tod_log);
7524 address_item *handled_addr = NULL;
7525 address_item **paddr;
7526 address_item *msgchain = NULL;
7527 address_item **pmsgchain = &msgchain;
7529 /* There are weird cases when logging is disabled in the transport. However,
7530 there may not be a transport (address failed by a router). */
7532 f.disable_logging = FALSE;
7533 if (addr_failed->transport)
7534 f.disable_logging = addr_failed->transport->disable_logging;
7537 debug_printf("processing failed address %s\n", addr_failed->address);
7539 /* There are only two ways an address in a bounce message can get here:
7541 (1) When delivery was initially deferred, but has now timed out (in the call
7542 to retry_update() above). We can detect this by testing for
7543 af_retry_timedout. If the address does not have its own errors address,
7544 we arrange to ignore the error.
7546 (2) If delivery failures for bounce messages are being ignored. We can detect
7547 this by testing for af_ignore_error. This will also be set if a bounce
7548 message has been autothawed and the ignore_bounce_errors_after time has
7549 passed. It might also be set if a router was explicitly configured to
7550 ignore errors (errors_to = "").
7552 If neither of these cases obtains, something has gone wrong. Log the
7553 incident, but then ignore the error. */
7555 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7557 if ( !testflag(addr_failed, af_retry_timedout)
7558 && !addr_failed->prop.ignore_error)
7559 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7560 "failure is neither frozen nor ignored (it's been ignored)");
7562 addr_failed->prop.ignore_error = TRUE;
7565 /* If the first address on the list has af_ignore_error set, just remove
7566 it from the list, throw away any saved message file, log it, and
7567 mark the recipient done. */
7569 if ( addr_failed->prop.ignore_error
7570 || addr_failed->dsn_flags & rf_dsnflags
7571 && !(addr_failed->dsn_flags & rf_notify_failure)
7575 addr_failed = addr->next;
7576 if (addr->return_filename) Uunlink(addr->return_filename);
7578 #ifndef DISABLE_EVENT
7579 msg_event_raise(US"msg:fail:delivery", addr);
7581 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7583 !addr->parent ? US"" : US" <",
7584 !addr->parent ? US"" : addr->parent->address,
7585 !addr->parent ? US"" : US">",
7586 addr->prop.ignore_error
7587 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7589 address_done(addr, logtod);
7590 child_done(addr, logtod);
7591 /* Panic-dies on error */
7592 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7595 /* Otherwise, handle the sending of a message. Find the error address for
7596 the first address, then send a message that includes all failed addresses
7597 that have the same error address. Note the bounce_recipient is a global so
7598 that it can be accessed by $bounce_recipient while creating a customized
7603 if (!(bounce_recipient = addr_failed->prop.errors_address))
7604 bounce_recipient = sender_address;
7606 /* Make a subprocess to send a message */
7608 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7609 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7610 "create child process to send failure message: %s", getpid(),
7611 getppid(), strerror(errno));
7613 /* Creation of child succeeded */
7620 uschar *bcc, *emf_text;
7621 FILE * fp = fdopen(fd, "wb");
7623 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7624 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7625 DELIVER_IN_BUFFER_SIZE;
7627 uschar *dsnlimitmsg;
7628 uschar *dsnnotifyhdr;
7632 debug_printf("sending error message to: %s\n", bounce_recipient);
7634 /* Scan the addresses for all that have the same errors address, removing
7635 them from the addr_failed chain, and putting them on msgchain. */
7637 paddr = &addr_failed;
7638 for (addr = addr_failed; addr; addr = *paddr)
7639 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7640 ? addr->prop.errors_address : sender_address) == 0)
7641 { /* The same - dechain */
7642 *paddr = addr->next;
7645 pmsgchain = &(addr->next);
7648 paddr = &addr->next; /* Not the same; skip */
7650 /* Include X-Failed-Recipients: for automatic interpretation, but do
7651 not let any one header line get too long. We do this by starting a
7652 new header every 50 recipients. Omit any addresses for which the
7653 "hide_child" flag is set. */
7655 for (addr = msgchain; addr; addr = addr->next)
7657 if (testflag(addr, af_hide_child)) continue;
7665 ? "X-Failed-Recipients: "
7667 testflag(addr, af_pfr) && addr->parent
7668 ? string_printing(addr->parent->address)
7669 : string_printing(addr->address));
7671 if (rcount > 0) fprintf(fp, "\n");
7673 /* Output the standard headers */
7675 if (errors_reply_to)
7676 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7677 fprintf(fp, "Auto-Submitted: auto-replied\n");
7678 moan_write_from(fp);
7679 fprintf(fp, "To: %s\n", bounce_recipient);
7680 moan_write_references(fp, NULL);
7682 /* generate boundary string and output MIME-Headers */
7683 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7685 fprintf(fp, "Content-Type: multipart/report;"
7686 " report-type=delivery-status; boundary=%s\n"
7687 "MIME-Version: 1.0\n",
7690 /* Open a template file if one is provided. Log failure to open, but
7691 carry on - default texts will be used. */
7693 if (bounce_message_file)
7694 emf = expand_open(bounce_message_file,
7695 US"bounce_message_file", US"error");
7697 /* Quietly copy to configured additional addresses if required. */
7699 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7700 fprintf(fp, "Bcc: %s\n", bcc);
7702 /* The texts for the message can be read from a template file; if there
7703 isn't one, or if it is too short, built-in texts are used. The first
7704 emf text is a Subject: and any other headers. */
7706 if ((emf_text = next_emf(emf, US"header")))
7707 fprintf(fp, "%s\n", emf_text);
7709 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7710 to_sender? ": returning message to sender" : "");
7712 /* output human readable part as text/plain section */
7713 fprintf(fp, "--%s\n"
7714 "Content-type: text/plain; charset=us-ascii\n\n",
7717 if ((emf_text = next_emf(emf, US"intro")))
7718 fprintf(fp, "%s", CS emf_text);
7722 /* This message has been reworded several times. It seems to be confusing to
7723 somebody, however it is worded. I have retreated to the original, simple
7725 "This message was created automatically by mail delivery software.\n");
7727 if (bounce_message_text)
7728 fprintf(fp, "%s", CS bounce_message_text);
7731 "\nA message that you sent could not be delivered to one or more of its\n"
7732 "recipients. This is a permanent error. The following address(es) failed:\n");
7735 "\nA message sent by\n\n <%s>\n\n"
7736 "could not be delivered to one or more of its recipients. The following\n"
7737 "address(es) failed:\n", sender_address);
7741 /* Process the addresses, leaving them on the msgchain if they have a
7742 file name for a return message. (There has already been a check in
7743 post_process_one() for the existence of data in the message file.) A TRUE
7744 return from print_address_information() means that the address is not
7748 for (addr = msgchain; addr; addr = *paddr)
7750 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7751 print_address_error(addr, fp, US"");
7753 /* End the final line for the address */
7757 /* Leave on msgchain if there's a return file. */
7759 if (addr->return_file >= 0)
7761 paddr = &(addr->next);
7765 /* Else save so that we can tick off the recipient when the
7770 *paddr = addr->next;
7771 addr->next = handled_addr;
7772 handled_addr = addr;
7778 /* Get the next text, whether we need it or not, so as to be
7779 positioned for the one after. */
7781 emf_text = next_emf(emf, US"generated text");
7783 /* If there were any file messages passed by the local transports,
7784 include them in the message. Then put the address on the handled chain.
7785 In the case of a batch of addresses that were all sent to the same
7786 transport, the return_file field in all of them will contain the same
7787 fd, and the return_filename field in the *last* one will be set (to the
7788 name of the file). */
7792 address_item *nextaddr;
7795 fprintf(fp, "%s", CS emf_text);
7798 "The following text was generated during the delivery "
7799 "attempt%s:\n", (filecount > 1)? "s" : "");
7801 for (addr = msgchain; addr; addr = nextaddr)
7804 address_item *topaddr = addr;
7806 /* List all the addresses that relate to this file */
7809 while(addr) /* Insurance */
7811 print_address_information(addr, fp, US"------ ", US"\n ",
7813 if (addr->return_filename) break;
7818 /* Now copy the file */
7820 if (!(fm = Ufopen(addr->return_filename, "rb")))
7821 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7825 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7828 Uunlink(addr->return_filename);
7830 /* Can now add to handled chain, first fishing off the next
7831 address on the msgchain. */
7833 nextaddr = addr->next;
7834 addr->next = handled_addr;
7835 handled_addr = topaddr;
7840 /* output machine readable part */
7842 if (message_smtputf8)
7843 fprintf(fp, "--%s\n"
7844 "Content-type: message/global-delivery-status\n\n"
7845 "Reporting-MTA: dns; %s\n",
7846 bound, smtp_active_hostname);
7849 fprintf(fp, "--%s\n"
7850 "Content-type: message/delivery-status\n\n"
7851 "Reporting-MTA: dns; %s\n",
7852 bound, smtp_active_hostname);
7856 /* must be decoded from xtext: see RFC 3461:6.3a */
7858 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7859 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7861 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7865 for (addr = handled_addr; addr; addr = addr->next)
7869 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7871 if ((hu = addr->host_used) && hu->name)
7873 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7874 #ifdef EXPERIMENTAL_DSN_INFO
7879 uschar * p = hu->port == 25
7880 ? US"" : string_sprintf(":%d", hu->port);
7881 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7883 if ((s = addr->smtp_greeting) && *s)
7884 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %.900s\n", s);
7885 if ((s = addr->helo_response) && *s)
7886 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %.900s\n", s);
7887 if ((s = addr->message) && *s)
7888 fprintf(fp, "X-Exim-Diagnostic: X-str; %.900s\n", s);
7891 print_dsn_diagnostic_code(addr, fp);
7896 /* Now copy the message, trying to give an intelligible comment if
7897 it is too long for it all to be copied. The limit isn't strictly
7898 applied because of the buffering. There is, however, an option
7899 to suppress copying altogether. */
7901 emf_text = next_emf(emf, US"copy");
7904 we ignore the intro text from template and add
7905 the text for bounce_return_size_limit at the end.
7907 bounce_return_message is ignored
7908 in case RET= is defined we honor these values
7909 otherwise bounce_return_body is honored.
7911 bounce_return_size_limit is always honored.
7914 fprintf(fp, "--%s\n", bound);
7916 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7917 dsnnotifyhdr = NULL;
7918 topt = topt_add_return_path;
7920 /* RET=HDRS? top priority */
7921 if (dsn_ret == dsn_ret_hdrs)
7922 topt |= topt_no_body;
7925 struct stat statbuf;
7927 /* no full body return at all? */
7928 if (!bounce_return_body)
7930 topt |= topt_no_body;
7931 /* add header if we overrule RET=FULL */
7932 if (dsn_ret == dsn_ret_full)
7933 dsnnotifyhdr = dsnlimitmsg;
7935 /* line length limited... return headers only if oversize */
7936 /* size limited ... return headers only if limit reached */
7937 else if ( max_received_linelength > bounce_return_linesize_limit
7938 || ( bounce_return_size_limit > 0
7939 && fstat(deliver_datafile, &statbuf) == 0
7940 && statbuf.st_size > max
7943 topt |= topt_no_body;
7944 dsnnotifyhdr = dsnlimitmsg;
7949 if (message_smtputf8)
7950 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7951 : "Content-type: message/global\n\n",
7955 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7956 : "Content-type: message/rfc822\n\n",
7960 transport_filter_argv = NULL; /* Just in case */
7961 return_path = sender_address; /* In case not previously set */
7962 { /* Dummy transport for headers add */
7963 transport_ctx tctx = {{0}};
7964 transport_instance tb = {0};
7966 tctx.u.fd = fileno(fp);
7968 tctx.options = topt;
7969 tb.add_headers = dsnnotifyhdr;
7971 /*XXX no checking for failure! buggy! */
7972 transport_write_message(&tctx, 0);
7976 /* we never add the final text. close the file */
7980 fprintf(fp, "\n--%s--\n", bound);
7982 /* Close the file, which should send an EOF to the child process
7983 that is receiving the message. Wait for it to finish. */
7986 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7988 /* If the process failed, there was some disaster in setting up the
7989 error message. Unless the message is very old, ensure that addr_defer
7990 is non-null, which will have the effect of leaving the message on the
7991 spool. The failed addresses will get tried again next time. However, we
7992 don't really want this to happen too often, so freeze the message unless
7993 there are some genuine deferred addresses to try. To do this we have
7994 to call spool_write_header() here, because with no genuine deferred
7995 addresses the normal code below doesn't get run. */
8000 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
8002 addr_defer = (address_item *)(+1);
8003 f.deliver_freeze = TRUE;
8004 deliver_frozen_at = time(NULL);
8005 /* Panic-dies on error */
8006 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8009 deliver_msglog("Process failed (%d) when writing error message "
8010 "to %s%s", rc, bounce_recipient, s);
8011 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
8012 "to %s%s", rc, bounce_recipient, s);
8015 /* The message succeeded. Ensure that the recipients that failed are
8016 now marked finished with on the spool and their parents updated. */
8020 for (addr = handled_addr; addr; addr = addr->next)
8022 address_done(addr, logtod);
8023 child_done(addr, logtod);
8025 /* Panic-dies on error */
8026 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8032 f.disable_logging = FALSE; /* In case left set */
8034 /* Come here from the mua_wrapper case if routing goes wrong */
8038 /* If there are now no deferred addresses, we are done. Preserve the
8039 message log if so configured, and we are using them. Otherwise, sling it.
8040 Then delete the message itself. */
8048 fname = spool_fname(US"msglog", message_subdir, id, US"");
8049 if (preserve_message_logs)
8052 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8054 if ((rc = Urename(fname, moname)) < 0)
8056 (void)directory_make(spool_directory,
8057 spool_sname(US"msglog.OLD", US""),
8058 MSGLOG_DIRECTORY_MODE, TRUE);
8059 rc = Urename(fname, moname);
8062 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8063 "msglog.OLD directory", fname);
8066 if (Uunlink(fname) < 0)
8067 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8068 fname, strerror(errno));
8071 /* Remove the two message files. */
8073 fname = spool_fname(US"input", message_subdir, id, US"-D");
8074 if (Uunlink(fname) < 0)
8075 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8076 fname, strerror(errno));
8077 fname = spool_fname(US"input", message_subdir, id, US"-H");
8078 if (Uunlink(fname) < 0)
8079 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8080 fname, strerror(errno));
8082 /* Log the end of this message, with queue time if requested. */
8084 if (LOGGING(queue_time_overall))
8085 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8087 log_write(0, LOG_MAIN, "Completed");
8089 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8090 f.deliver_freeze = FALSE;
8092 #ifndef DISABLE_EVENT
8093 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8097 /* If there are deferred addresses, we are keeping this message because it is
8098 not yet completed. Lose any temporary files that were catching output from
8099 pipes for any of the deferred addresses, handle one-time aliases, and see if
8100 the message has been on the queue for so long that it is time to send a warning
8101 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8102 have the same domain, we can set deliver_domain for the expansion of
8103 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8104 the parent's domain.
8106 If all the deferred addresses have an error number that indicates "retry time
8107 not reached", skip sending the warning message, because it won't contain the
8108 reason for the delay. It will get sent at the next real delivery attempt.
8109 Exception: for retries caused by a remote peer we use the error message
8110 store in the retry DB as the reason.
8111 However, if at least one address has tried, we'd better include all of them in
8114 If we can't make a process to send the message, don't worry.
8116 For mailing list expansions we want to send the warning message to the
8117 mailing list manager. We can't do a perfect job here, as some addresses may
8118 have different errors addresses, but if we take the errors address from
8119 each deferred address it will probably be right in most cases.
8121 If addr_defer == +1, it means there was a problem sending an error message
8122 for failed addresses, and there were no "real" deferred addresses. The value
8123 was set just to keep the message on the spool, so there is nothing to do here.
8126 else if (addr_defer != (address_item *)(+1))
8128 uschar *recipients = US"";
8129 BOOL want_warning_msg = FALSE;
8131 deliver_domain = testflag(addr_defer, af_pfr)
8132 ? addr_defer->parent->domain : addr_defer->domain;
8134 for (address_item * addr = addr_defer; addr; addr = addr->next)
8136 address_item *otaddr;
8138 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8142 const uschar *d = testflag(addr, af_pfr)
8143 ? addr->parent->domain : addr->domain;
8145 /* The domain may be unset for an address that has never been routed
8146 because the system filter froze the message. */
8148 if (!d || Ustrcmp(d, deliver_domain) != 0)
8149 deliver_domain = NULL;
8152 if (addr->return_filename) Uunlink(addr->return_filename);
8154 /* Handle the case of one-time aliases. If any address in the ancestry
8155 of this one is flagged, ensure it is in the recipients list, suitably
8156 flagged, and that its parent is marked delivered. */
8158 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8159 if (otaddr->onetime_parent) break;
8164 int t = recipients_count;
8166 for (i = 0; i < recipients_count; i++)
8168 uschar *r = recipients_list[i].address;
8169 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8170 if (Ustrcmp(otaddr->address, r) == 0) break;
8173 /* Didn't find the address already in the list, and did find the
8174 ultimate parent's address in the list, and they really are different
8175 (i.e. not from an identity-redirect). After adding the recipient,
8176 update the errors address in the recipients list. */
8178 if ( i >= recipients_count && t < recipients_count
8179 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8181 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8182 otaddr->address, otaddr->parent->address);
8183 receive_add_recipient(otaddr->address, t);
8184 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8185 tree_add_nonrecipient(otaddr->parent->address);
8186 update_spool = TRUE;
8190 /* Except for error messages, ensure that either the errors address for
8191 this deferred address or, if there is none, the sender address, is on the
8192 list of recipients for a warning message. */
8194 if (sender_address[0])
8196 uschar * s = addr->prop.errors_address;
8197 if (!s) s = sender_address;
8198 if (Ustrstr(recipients, s) == NULL)
8199 recipients = string_sprintf("%s%s%s", recipients,
8200 recipients[0] ? "," : "", s);
8204 /* Send a warning message if the conditions are right. If the condition check
8205 fails because of a lookup defer, there is nothing we can do. The warning
8206 is not sent. Another attempt will be made at the next delivery attempt (if
8209 if ( !f.queue_2stage
8211 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8212 || addr_defer->dsn_flags & rf_notify_delay
8214 && delay_warning[1] > 0
8215 && sender_address[0] != 0
8216 && ( !delay_warning_condition
8217 || expand_check_condition(delay_warning_condition,
8218 US"delay_warning", US"option")
8224 int queue_time = time(NULL) - received_time.tv_sec;
8226 queue_time = test_harness_fudged_queue_time(queue_time);
8228 /* See how many warnings we should have sent by now */
8230 for (count = 0; count < delay_warning[1]; count++)
8231 if (queue_time < delay_warning[count+2]) break;
8233 show_time = delay_warning[count+1];
8235 if (count >= delay_warning[1])
8238 int last_gap = show_time;
8239 if (count > 1) last_gap -= delay_warning[count];
8240 extra = (queue_time - delay_warning[count+1])/last_gap;
8241 show_time += last_gap * extra;
8247 debug_printf("time on queue = %s id %s addr %s\n",
8248 readconf_printtime(queue_time), message_id, addr_defer->address);
8249 debug_printf("warning counts: required %d done %d\n", count,
8253 /* We have computed the number of warnings there should have been by now.
8254 If there haven't been enough, send one, and up the count to what it should
8257 if (warning_count < count)
8261 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8267 FILE * f = fdopen(fd, "wb");
8269 transport_ctx tctx = {{0}};
8271 if (warn_message_file)
8272 wmf = expand_open(warn_message_file,
8273 US"warn_message_file", US"warning");
8275 warnmsg_recipients = recipients;
8276 warnmsg_delay = queue_time < 120*60
8277 ? string_sprintf("%d minutes", show_time/60)
8278 : string_sprintf("%d hours", show_time/3600);
8280 if (errors_reply_to)
8281 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8282 fprintf(f, "Auto-Submitted: auto-replied\n");
8284 fprintf(f, "To: %s\n", recipients);
8285 moan_write_references(f, NULL);
8287 /* generated boundary string and output MIME-Headers */
8288 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8290 fprintf(f, "Content-Type: multipart/report;"
8291 " report-type=delivery-status; boundary=%s\n"
8292 "MIME-Version: 1.0\n",
8295 if ((wmf_text = next_emf(wmf, US"header")))
8296 fprintf(f, "%s\n", wmf_text);
8298 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8299 message_id, warnmsg_delay);
8301 /* output human readable part as text/plain section */
8303 "Content-type: text/plain; charset=us-ascii\n\n",
8306 if ((wmf_text = next_emf(wmf, US"intro")))
8307 fprintf(f, "%s", CS wmf_text);
8311 "This message was created automatically by mail delivery software.\n");
8313 if (Ustrcmp(recipients, sender_address) == 0)
8315 "A message that you sent has not yet been delivered to one or more of its\n"
8316 "recipients after more than ");
8320 "A message sent by\n\n <%s>\n\n"
8321 "has not yet been delivered to one or more of its recipients after more than \n",
8324 fprintf(f, "%s on the queue on %s.\n\n"
8325 "The message identifier is: %s\n",
8326 warnmsg_delay, primary_hostname, message_id);
8328 for (h = header_list; h; h = h->next)
8329 if (strncmpic(h->text, US"Subject:", 8) == 0)
8330 fprintf(f, "The subject of the message is: %s", h->text + 9);
8331 else if (strncmpic(h->text, US"Date:", 5) == 0)
8332 fprintf(f, "The date of the message is: %s", h->text + 6);
8335 fprintf(f, "The address%s to which the message has not yet been "
8337 !addr_defer->next ? "" : "es",
8338 !addr_defer->next ? "is": "are");
8341 /* List the addresses, with error information if allowed */
8344 for (address_item * addr = addr_defer; addr; addr = addr->next)
8346 if (print_address_information(addr, f, US" ", US"\n ", US""))
8347 print_address_error(addr, f, US"Delay reason: ");
8356 if ((wmf_text = next_emf(wmf, US"final")))
8357 fprintf(f, "%s", CS wmf_text);
8363 "No action is required on your part. Delivery attempts will continue for\n"
8364 "some time, and this warning may be repeated at intervals if the message\n"
8365 "remains undelivered. Eventually the mail delivery software will give up,\n"
8366 "and when that happens, the message will be returned to you.\n");
8369 /* output machine readable part */
8370 fprintf(f, "\n--%s\n"
8371 "Content-type: message/delivery-status\n\n"
8372 "Reporting-MTA: dns; %s\n",
8374 smtp_active_hostname);
8379 /* must be decoded from xtext: see RFC 3461:6.3a */
8381 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8382 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8384 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8388 for (address_item * addr = addr_defer; addr; addr = addr->next)
8392 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8394 if ((hu = addr->host_used) && hu->name)
8396 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8397 print_dsn_diagnostic_code(addr, f);
8403 "Content-type: text/rfc822-headers\n\n",
8407 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8408 tctx.u.fd = fileno(f);
8409 tctx.options = topt_add_return_path | topt_no_body;
8410 transport_filter_argv = NULL; /* Just in case */
8411 return_path = sender_address; /* In case not previously set */
8413 /* Write the original email out */
8414 /*XXX no checking for failure! buggy! */
8415 transport_write_message(&tctx, 0);
8418 fprintf(f,"\n--%s--\n", bound);
8422 /* Close and wait for child process to complete, without a timeout.
8423 If there's an error, don't update the count. */
8426 if (child_close(pid, 0) == 0)
8428 warning_count = count;
8429 update_spool = TRUE; /* Ensure spool rewritten */
8435 /* Clear deliver_domain */
8437 deliver_domain = NULL;
8439 /* If this was a first delivery attempt, unset the first time flag, and
8440 ensure that the spool gets updated. */
8442 if (f.deliver_firsttime && !f.queue_2stage)
8444 f.deliver_firsttime = FALSE;
8445 update_spool = TRUE;
8448 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8449 message, unless the message is a local error message (to avoid loops). Then
8450 log the freezing. If the text in "frozen_info" came from a system filter,
8451 it has been escaped into printing characters so as not to mess up log lines.
8452 For the "tell" message, we turn \n back into newline. Also, insert a newline
8453 near the start instead of the ": " string. */
8455 if (f.deliver_freeze)
8457 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8459 uschar *s = string_copy(frozen_info);
8460 uschar *ss = Ustrstr(s, " by the system filter: ");
8471 if (*ss == '\\' && ss[1] == 'n')
8478 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8479 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8483 /* Log freezing just before we update the -H file, to minimize the chance
8484 of a race problem. */
8486 deliver_msglog("*** Frozen%s\n", frozen_info);
8487 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8490 /* If there have been any updates to the non-recipients list, or other things
8491 that get written to the spool, we must now update the spool header file so
8492 that it has the right information for the next delivery attempt. If there
8493 was more than one address being delivered, the header_change update is done
8494 earlier, in case one succeeds and then something crashes. */
8497 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8498 update_spool, f.header_rewritten);
8500 if (update_spool || f.header_rewritten)
8501 /* Panic-dies on error */
8502 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8505 /* Finished with the message log. If the message is complete, it will have
8506 been unlinked or renamed above. */
8508 if (message_logs) (void)fclose(message_log);
8510 /* Now we can close and remove the journal file. Its only purpose is to record
8511 successfully completed deliveries asap so that this information doesn't get
8512 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8513 not serious, as trying it again is not harmful. The journal might not be open
8514 if all addresses were deferred at routing or directing. Nevertheless, we must
8515 remove it if it exists (may have been lying around from a crash during the
8516 previous delivery attempt). We don't remove the journal if a delivery
8517 subprocess failed to pass back delivery information; this is controlled by
8518 the remove_journal flag. When the journal is left, we also don't move the
8519 message off the main spool if frozen and the option is set. It should get moved
8520 at the next attempt, after the journal has been inspected. */
8522 if (journal_fd >= 0) (void)close(journal_fd);
8526 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8528 if (Uunlink(fname) < 0 && errno != ENOENT)
8529 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8532 /* Move the message off the spool if requested */
8534 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8535 if (f.deliver_freeze && move_frozen_messages)
8536 (void)spool_move_message(id, message_subdir, US"", US"F");
8540 /* Closing the data file frees the lock; if the file has been unlinked it
8541 will go away. Otherwise the message becomes available for another process
8544 (void)close(deliver_datafile);
8545 deliver_datafile = -1;
8546 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8547 #ifdef MEASURE_TIMING
8548 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8551 /* It is unlikely that there will be any cached resources, since they are
8552 released after routing, and in the delivery subprocesses. However, it's
8553 possible for an expansion for something afterwards (for example,
8554 expand_check_condition) to do a lookup. We must therefore be sure everything is
8558 acl_where = ACL_WHERE_UNKNOWN;
8567 #ifdef EXIM_TFO_PROBE
8570 f.tcp_fastopen_ok = TRUE;
8576 /* Called from a commandline, or from the daemon, to do a delivery.
8577 We need to regain privs; do this by exec of the exim binary. */
8580 delivery_re_exec(int exec_type)
8584 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8586 int channel_fd = cutthrough.cctx.sock;
8588 smtp_peer_options = cutthrough.peer_options;
8589 continue_sequence = 0;
8592 if (cutthrough.is_tls)
8596 smtp_peer_options |= OPTION_TLS;
8597 sending_ip_address = cutthrough.snd_ip;
8598 sending_port = cutthrough.snd_port;
8600 where = US"socketpair";
8601 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8605 testharness_pause_ms(150);
8606 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8609 if (pid == 0) /* child: will fork again to totally disconnect */
8611 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8613 /* does not return */
8617 waitpid(pid, NULL, 0);
8618 (void) close(channel_fd); /* release the client socket */
8619 channel_fd = pfd[1];
8623 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8624 cutthrough.host.address, message_id, channel_fd);
8628 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8629 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8631 return; /* compiler quietening; control does not reach here. */
8636 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8637 "delivery re-exec %s failed: %s", where, strerror(errno));
8639 /* Get here if exec_type == CEE_EXEC_EXIT.
8640 Note: this must be _exit(), not exit(). */
8642 _exit(EX_EXECFAILED);
8648 /* End of deliver.c */