1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
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 int return_count;
78 static uschar *frozen_info = US"";
79 static uschar *used_return_path = NULL;
83 /*************************************************
84 * read as much as requested *
85 *************************************************/
87 /* The syscall read(2) doesn't always returns as much as we want. For
88 several reasons it might get less. (Not talking about signals, as syscalls
89 are restartable). When reading from a network or pipe connection the sender
90 might send in smaller chunks, with delays between these chunks. The read(2)
91 may return such a chunk.
93 The more the writer writes and the smaller the pipe between write and read is,
94 the more we get the chance of reading leass than requested. (See bug 2130)
96 This function read(2)s until we got all the data we *requested*.
98 Note: This function may block. Use it only if you're sure about the
99 amount of data you will get.
102 fd the file descriptor to read from
103 buffer pointer to a buffer of size len
104 len the requested(!) amount of bytes
106 Returns: the amount of bytes read
109 readn(int fd, void * buffer, size_t len)
111 uschar * next = buffer;
112 uschar * end = next + len;
116 ssize_t got = read(fd, next, end - next);
118 /* I'm not sure if there are signals that can interrupt us,
119 for now I assume the worst */
120 if (got == -1 && errno == EINTR) continue;
121 if (got <= 0) return next - US buffer;
129 /*************************************************
130 * Make a new address item *
131 *************************************************/
133 /* This function gets the store and initializes with default values. The
134 transport_return value defaults to DEFER, so that any unexpected failure to
135 deliver does not wipe out the message. The default unique string is set to a
136 copy of the address, so that its domain can be lowercased.
139 address the RFC822 address string
140 copy force a copy of the address
142 Returns: a pointer to an initialized address_item
146 deliver_make_addr(uschar *address, BOOL copy)
148 address_item *addr = store_get(sizeof(address_item), FALSE);
149 *addr = address_defaults;
150 if (copy) address = string_copy(address);
151 addr->address = address;
152 addr->unique = string_copy(address);
159 /*************************************************
160 * Set expansion values for an address *
161 *************************************************/
163 /* Certain expansion variables are valid only when handling an address or
164 address list. This function sets them up or clears the values, according to its
168 addr the address in question, or NULL to clear values
173 deliver_set_expansions(address_item *addr)
177 const uschar ***p = address_expansions;
178 while (*p) **p++ = NULL;
182 /* Exactly what gets set depends on whether there is one or more addresses, and
183 what they contain. These first ones are always set, taking their values from
184 the first address. */
186 if (!addr->host_list)
188 deliver_host = deliver_host_address = US"";
189 deliver_host_port = 0;
193 deliver_host = addr->host_list->name;
194 deliver_host_address = addr->host_list->address;
195 deliver_host_port = addr->host_list->port;
198 deliver_recipients = addr;
199 deliver_address_data = addr->prop.address_data;
200 deliver_domain_data = addr->prop.domain_data;
201 deliver_localpart_data = addr->prop.localpart_data;
202 router_var = addr->prop.variables;
204 /* These may be unset for multiple addresses */
206 deliver_domain = addr->domain;
207 self_hostname = addr->self_hostname;
209 #ifdef EXPERIMENTAL_BRIGHTMAIL
210 bmi_deliver = 1; /* deliver by default */
211 bmi_alt_location = NULL;
212 bmi_base64_verdict = NULL;
213 bmi_base64_tracker_verdict = NULL;
216 /* If there's only one address we can set everything. */
220 address_item *addr_orig;
222 deliver_localpart = addr->local_part;
223 deliver_localpart_verified = addr->local_part_verified;
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,
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.
465 one points to the first host list
466 two points to the second host list
468 Returns: TRUE if the lists refer to the same host set
472 same_hosts(host_item *one, host_item *two)
476 if (Ustrcmp(one->name, two->name) != 0)
479 host_item *end_one = one;
480 host_item *end_two = two;
482 /* Batch up only if there was no MX and the list was not randomized */
484 if (mx == MX_NONE) return FALSE;
486 /* Find the ends of the shortest sequence of identical MX values */
488 while ( end_one->next && end_one->next->mx == mx
489 && end_two->next && end_two->next->mx == mx)
491 end_one = end_one->next;
492 end_two = end_two->next;
495 /* If there aren't any duplicates, there's no match. */
497 if (end_one == one) return FALSE;
499 /* For each host in the 'one' sequence, check that it appears in the 'two'
500 sequence, returning FALSE if not. */
505 for (hi = two; hi != end_two->next; hi = hi->next)
506 if (Ustrcmp(one->name, hi->name) == 0) break;
507 if (hi == end_two->next) return FALSE;
508 if (one == end_one) break;
512 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
513 Ensure both are pointing at the last host, and carry on as for equality. */
518 /* if the names matched but ports do not, mismatch */
519 else if (one->port != two->port)
528 /* True if both are NULL */
535 /*************************************************
536 * Compare header lines *
537 *************************************************/
539 /* This function is given two pointers to chains of header items, and it yields
540 TRUE if they are the same header texts in the same order.
543 one points to the first header list
544 two points to the second header list
546 Returns: TRUE if the lists refer to the same header set
550 same_headers(header_line *one, header_line *two)
552 for (;; one = one->next, two = two->next)
554 if (one == two) return TRUE; /* Includes the case where both NULL */
555 if (!one || !two) return FALSE;
556 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
562 /*************************************************
563 * Compare string settings *
564 *************************************************/
566 /* This function is given two pointers to strings, and it returns
567 TRUE if they are the same pointer, or if the two strings are the same.
570 one points to the first string
571 two points to the second string
573 Returns: TRUE or FALSE
577 same_strings(uschar *one, uschar *two)
579 if (one == two) return TRUE; /* Includes the case where both NULL */
580 if (!one || !two) return FALSE;
581 return (Ustrcmp(one, two) == 0);
586 /*************************************************
587 * Compare uid/gid for addresses *
588 *************************************************/
590 /* This function is given a transport and two addresses. It yields TRUE if the
591 uid/gid/initgroups settings for the two addresses are going to be the same when
596 addr1 the first address
597 addr2 the second address
599 Returns: TRUE or FALSE
603 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
605 if ( !tp->uid_set && !tp->expand_uid
606 && !tp->deliver_as_creator
607 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
608 || ( testflag(addr1, af_uid_set)
609 && ( addr1->uid != addr2->uid
610 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
614 if ( !tp->gid_set && !tp->expand_gid
615 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
616 || ( testflag(addr1, af_gid_set)
617 && addr1->gid != addr2->gid
627 /*************************************************
628 * Record that an address is complete *
629 *************************************************/
631 /* This function records that an address is complete. This is straightforward
632 for most addresses, where the unique address is just the full address with the
633 domain lower cased. For homonyms (addresses that are the same as one of their
634 ancestors) their are complications. Their unique addresses have \x\ prepended
635 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
638 Exim used to record the unique addresses of homonyms as "complete". This,
639 however, fails when the pattern of redirection varies over time (e.g. if taking
640 unseen copies at only some times of day) because the prepended numbers may vary
641 from one delivery run to the next. This problem is solved by never recording
642 prepended unique addresses as complete. Instead, when a homonymic address has
643 actually been delivered via a transport, we record its basic unique address
644 followed by the name of the transport. This is checked in subsequent delivery
645 runs whenever an address is routed to a transport.
647 If the completed address is a top-level one (has no parent, which means it
648 cannot be homonymic) we also add the original address to the non-recipients
649 tree, so that it gets recorded in the spool file and therefore appears as
650 "done" in any spool listings. The original address may differ from the unique
651 address in the case of the domain.
653 Finally, this function scans the list of duplicates, marks as done any that
654 match this address, and calls child_done() for their ancestors.
657 addr address item that has been completed
658 now current time as a string
664 address_done(address_item *addr, uschar *now)
666 update_spool = TRUE; /* Ensure spool gets updated */
668 /* Top-level address */
672 tree_add_nonrecipient(addr->unique);
673 tree_add_nonrecipient(addr->address);
676 /* Homonymous child address */
678 else if (testflag(addr, af_homonym))
681 tree_add_nonrecipient(
682 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
685 /* Non-homonymous child address */
687 else tree_add_nonrecipient(addr->unique);
689 /* Check the list of duplicate addresses and ensure they are now marked
692 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
693 if (Ustrcmp(addr->unique, dup->unique) == 0)
695 tree_add_nonrecipient(dup->unique);
696 child_done(dup, now);
703 /*************************************************
704 * Decrease counts in parents and mark done *
705 *************************************************/
707 /* This function is called when an address is complete. If there is a parent
708 address, its count of children is decremented. If there are still other
709 children outstanding, the function exits. Otherwise, if the count has become
710 zero, address_done() is called to mark the parent and its duplicates complete.
711 Then loop for any earlier ancestors.
714 addr points to the completed address item
715 now the current time as a string, for writing to the message log
721 child_done(address_item *addr, uschar *now)
728 if (--addr->child_count > 0) return; /* Incomplete parent */
729 address_done(addr, now);
731 /* Log the completion of all descendents only when there is no ancestor with
732 the same original address. */
734 for (aa = addr->parent; aa; aa = aa->parent)
735 if (Ustrcmp(aa->address, addr->address) == 0) break;
738 deliver_msglog("%s %s: children all complete\n", now, addr->address);
739 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
745 /*************************************************
746 * Delivery logging support functions *
747 *************************************************/
749 /* The LOGGING() checks in d_log_interface() are complicated for backwards
750 compatibility. When outgoing interface logging was originally added, it was
751 conditional on just incoming_interface (which is off by default). The
752 outgoing_interface option is on by default to preserve this behaviour, but
753 you can enable incoming_interface and disable outgoing_interface to get I=
754 fields on incoming lines only.
758 addr The address to be logged
760 Returns: New value for s
764 d_log_interface(gstring * g)
766 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
767 && sending_ip_address)
769 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
770 if (LOGGING(outgoing_port))
771 g = string_fmt_append(g, ":%d", sending_port);
779 d_hostlog(gstring * g, address_item * addr)
781 host_item * h = addr->host_used;
783 g = string_append(g, 2, US" H=", h->name);
785 if (LOGGING(dnssec) && h->dnssec == DS_YES)
786 g = string_catn(g, US" DS", 3);
788 g = string_append(g, 3, US" [", h->address, US"]");
790 if (LOGGING(outgoing_port))
791 g = string_fmt_append(g, ":%d", h->port);
794 if (LOGGING(proxy) && proxy_local_address)
796 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
797 if (LOGGING(outgoing_port))
798 g = string_fmt_append(g, ":%d", proxy_local_port);
802 g = d_log_interface(g);
804 if (testflag(addr, af_tcp_fastopen))
805 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
816 d_tlslog(gstring * g, address_item * addr)
818 if (LOGGING(tls_cipher) && addr->cipher)
820 g = string_append(g, 2, US" X=", addr->cipher);
821 #ifdef EXPERIMENTAL_TLS_RESUME
822 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
823 g = string_catn(g, US"*", 1);
826 if (LOGGING(tls_certificate_verified) && addr->cipher)
827 g = string_append(g, 2, US" CV=",
828 testflag(addr, af_cert_verified)
831 testflag(addr, af_dane_verified)
837 if (LOGGING(tls_peerdn) && addr->peerdn)
838 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
846 #ifndef DISABLE_EVENT
848 event_raise(uschar * action, const uschar * event, uschar * ev_data)
854 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
856 action, deliver_host_address);
859 event_data = ev_data;
861 if (!(s = expand_string(action)) && *expand_string_message)
862 log_write(0, LOG_MAIN|LOG_PANIC,
863 "failed to expand event_action %s in %s: %s\n",
864 event, transport_name ? transport_name : US"main", expand_string_message);
866 event_name = event_data = NULL;
868 /* If the expansion returns anything but an empty string, flag for
869 the caller to modify his normal processing
874 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
883 msg_event_raise(const uschar * event, const address_item * addr)
885 const uschar * save_domain = deliver_domain;
886 uschar * save_local = deliver_localpart;
887 const uschar * save_host = deliver_host;
888 const uschar * save_address = deliver_host_address;
889 const int save_port = deliver_host_port;
891 router_name = addr->router ? addr->router->name : NULL;
892 deliver_domain = addr->domain;
893 deliver_localpart = addr->local_part;
894 deliver_host = addr->host_used ? addr->host_used->name : NULL;
896 if (!addr->transport)
898 if (Ustrcmp(event, "msg:fail:delivery") == 0)
900 /* An address failed with no transport involved. This happens when
901 a filter was used which triggered a fail command (in such a case
902 a transport isn't needed). Convert it to an internal fail event. */
904 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
909 transport_name = addr->transport->name;
911 (void) event_raise(addr->transport->event_action, event,
913 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
914 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
915 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
916 ? addr->message : NULL);
919 deliver_host_port = save_port;
920 deliver_host_address = save_address;
921 deliver_host = save_host;
922 deliver_localpart = save_local;
923 deliver_domain = save_domain;
924 router_name = transport_name = NULL;
926 #endif /*DISABLE_EVENT*/
930 /******************************************************************************/
933 /*************************************************
934 * Generate local prt for logging *
935 *************************************************/
937 /* This function is a subroutine for use in string_log_address() below.
940 addr the address being logged
941 yield the current dynamic buffer pointer
943 Returns: the new value of the buffer pointer
947 string_get_localpart(address_item * addr, gstring * yield)
952 if (testflag(addr, af_include_affixes) && s)
955 if (testflag(addr, af_utf8_downcvt))
956 s = string_localpart_utf8_to_alabel(s, NULL);
958 yield = string_cat(yield, s);
961 s = addr->local_part;
963 if (testflag(addr, af_utf8_downcvt))
964 s = string_localpart_utf8_to_alabel(s, NULL);
966 yield = string_cat(yield, s);
969 if (testflag(addr, af_include_affixes) && s)
972 if (testflag(addr, af_utf8_downcvt))
973 s = string_localpart_utf8_to_alabel(s, NULL);
975 yield = string_cat(yield, s);
982 /*************************************************
983 * Generate log address list *
984 *************************************************/
986 /* This function generates a list consisting of an address and its parents, for
987 use in logging lines. For saved onetime aliased addresses, the onetime parent
988 field is used. If the address was delivered by a transport with rcpt_include_
989 affixes set, the af_include_affixes bit will be set in the address. In that
990 case, we include the affixes here too.
993 g points to growing-string struct
994 addr bottom (ultimate) address
995 all_parents if TRUE, include all parents
996 success TRUE for successful delivery
998 Returns: a growable string in dynamic store
1002 string_log_address(gstring * g,
1003 address_item *addr, BOOL all_parents, BOOL success)
1005 BOOL add_topaddr = TRUE;
1006 address_item *topaddr;
1008 /* Find the ultimate parent */
1010 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1012 /* We start with just the local part for pipe, file, and reply deliveries, and
1013 for successful local deliveries from routers that have the log_as_local flag
1014 set. File deliveries from filters can be specified as non-absolute paths in
1015 cases where the transport is going to complete the path. If there is an error
1016 before this happens (expansion failure) the local part will not be updated, and
1017 so won't necessarily look like a path. Add extra text for this case. */
1019 if ( testflag(addr, af_pfr)
1021 && addr->router && addr->router->log_as_local
1022 && addr->transport && addr->transport->info->local
1025 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1026 g = string_catn(g, CUS"save ", 5);
1027 g = string_get_localpart(addr, g);
1030 /* Other deliveries start with the full address. It we have split it into local
1031 part and domain, use those fields. Some early failures can happen before the
1032 splitting is done; in those cases use the original field. */
1037 int off = g->ptr; /* start of the "full address" */
1039 if (addr->local_part)
1042 g = string_get_localpart(addr, g);
1043 g = string_catn(g, US"@", 1);
1046 if (testflag(addr, af_utf8_downcvt))
1047 s = string_localpart_utf8_to_alabel(s, NULL);
1049 g = string_cat(g, s);
1052 g = string_cat(g, addr->address);
1054 /* If the address we are going to print is the same as the top address,
1055 and all parents are not being included, don't add on the top address. First
1056 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1057 on the local parts. */
1059 cmp = g->s + off; /* only now, as rebuffer likely done */
1060 string_from_gstring(g); /* ensure nul-terminated */
1061 if ( strcmpic(cmp, topaddr->address) == 0
1062 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1063 && !addr->onetime_parent
1064 && (!all_parents || !addr->parent || addr->parent == topaddr)
1066 add_topaddr = FALSE;
1069 /* If all parents are requested, or this is a local pipe/file/reply, and
1070 there is at least one intermediate parent, show it in brackets, and continue
1071 with all of them if all are wanted. */
1073 if ( (all_parents || testflag(addr, af_pfr))
1075 && addr->parent != topaddr)
1078 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1080 g = string_catn(g, s, 2);
1081 g = string_cat (g, addr2->address);
1082 if (!all_parents) break;
1085 g = string_catn(g, US")", 1);
1088 /* Add the top address if it is required */
1091 g = string_append(g, 3,
1093 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1101 /******************************************************************************/
1105 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1106 this is a nonstandard call; no two-character delivery flag is written
1107 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1110 flags passed to log_write()
1113 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1115 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1118 /* Log the delivery on the main log. We use an extensible string to build up
1119 the log line, and reset the store afterwards. Remote deliveries should always
1120 have a pointer to the host item that succeeded; local deliveries can have a
1121 pointer to a single host item in their host list, for use by the transport. */
1123 #ifndef DISABLE_EVENT
1124 /* presume no successful remote delivery */
1125 lookup_dnssec_authenticated = NULL;
1128 reset_point = store_mark();
1129 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1132 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1135 g->s[0] = logchar; g->ptr = 1;
1136 g = string_catn(g, US"> ", 2);
1138 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1140 if (LOGGING(sender_on_delivery) || msg)
1141 g = string_append(g, 3, US" F=<",
1143 testflag(addr, af_utf8_downcvt)
1144 ? string_address_utf8_to_alabel(sender_address, NULL)
1151 g = string_append(g, 2, US" Q=", queue_name);
1153 #ifdef EXPERIMENTAL_SRS
1154 if(addr->prop.srs_sender)
1155 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1158 /* You might think that the return path must always be set for a successful
1159 delivery; indeed, I did for some time, until this statement crashed. The case
1160 when it is not set is for a delivery to /dev/null which is optimised by not
1161 being run at all. */
1163 if (used_return_path && LOGGING(return_path_on_delivery))
1164 g = string_append(g, 3, US" P=<", used_return_path, US">");
1167 g = string_append(g, 2, US" ", msg);
1169 /* For a delivery from a system filter, there may not be a router */
1171 g = string_append(g, 2, US" R=", addr->router->name);
1173 g = string_append(g, 2, US" T=", addr->transport->name);
1175 if (LOGGING(delivery_size))
1176 g = string_fmt_append(g, " S=%d", transport_count);
1178 /* Local delivery */
1180 if (addr->transport->info->local)
1182 if (addr->host_list)
1183 g = string_append(g, 2, US" H=", addr->host_list->name);
1184 g = d_log_interface(g);
1185 if (addr->shadow_message)
1186 g = string_cat(g, addr->shadow_message);
1189 /* Remote delivery */
1193 if (addr->host_used)
1195 g = d_hostlog(g, addr);
1196 if (continue_sequence > 1)
1197 g = string_catn(g, US"*", 1);
1199 #ifndef DISABLE_EVENT
1200 deliver_host_address = addr->host_used->address;
1201 deliver_host_port = addr->host_used->port;
1202 deliver_host = addr->host_used->name;
1204 /* DNS lookup status */
1205 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1206 : addr->host_used->dnssec==DS_NO ? US"no"
1212 g = d_tlslog(g, addr);
1215 if (addr->authenticator)
1217 g = string_append(g, 2, US" A=", addr->authenticator);
1220 g = string_append(g, 2, US":", addr->auth_id);
1221 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1222 g = string_append(g, 2, US":", addr->auth_sndr);
1226 if (LOGGING(pipelining))
1228 if (testflag(addr, af_pipelining))
1229 g = string_catn(g, US" L", 2);
1230 #ifndef DISABLE_PIPE_CONNECT
1231 if (testflag(addr, af_early_pipe))
1232 g = string_catn(g, US"*", 1);
1236 #ifndef DISABLE_PRDR
1237 if (testflag(addr, af_prdr_used))
1238 g = string_catn(g, US" PRDR", 5);
1241 if (testflag(addr, af_chunking_used))
1242 g = string_catn(g, US" K", 2);
1245 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1247 if ( LOGGING(smtp_confirmation)
1249 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1252 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1253 uschar *p = big_buffer;
1254 uschar *ss = addr->message;
1256 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1258 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1263 g = string_append(g, 2, US" C=", big_buffer);
1266 /* Time on queue and actual time taken to deliver */
1268 if (LOGGING(queue_time))
1269 g = string_append(g, 2, US" QT=",
1270 string_timesince(&received_time));
1272 if (LOGGING(deliver_time))
1273 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1275 /* string_cat() always leaves room for the terminator. Release the
1276 store we used to build the line after writing it. */
1278 log_write(0, flags, "%s", string_from_gstring(g));
1280 #ifndef DISABLE_EVENT
1281 if (!msg) msg_event_raise(US"msg:delivery", addr);
1284 store_reset(reset_point);
1291 deferral_log(address_item * addr, uschar * now,
1292 int logflags, uschar * driver_name, uschar * driver_kind)
1294 rmark reset_point = store_mark();
1295 gstring * g = string_get(256);
1297 /* Build up the line that is used for both the message log and the main
1300 /* Create the address string for logging. Must not do this earlier, because
1301 an OK result may be changed to FAIL when a pipe returns text. */
1303 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1306 g = string_append(g, 2, US" Q=", queue_name);
1308 /* Either driver_name contains something and driver_kind contains
1309 " router" or " transport" (note the leading space), or driver_name is
1310 a null string and driver_kind contains "routing" without the leading
1311 space, if all routing has been deferred. When a domain has been held,
1312 so nothing has been done at all, both variables contain null strings. */
1316 if (driver_kind[1] == 't' && addr->router)
1317 g = string_append(g, 2, US" R=", addr->router->name);
1318 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1320 else if (driver_kind)
1321 g = string_append(g, 2, US" ", driver_kind);
1323 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1325 if (addr->basic_errno > 0)
1326 g = string_append(g, 2, US": ",
1327 US strerror(addr->basic_errno));
1329 if (addr->host_used)
1331 g = string_append(g, 5,
1332 US" H=", addr->host_used->name,
1333 US" [", addr->host_used->address, US"]");
1334 if (LOGGING(outgoing_port))
1336 int port = addr->host_used->port;
1337 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1341 if (LOGGING(deliver_time))
1342 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1345 g = string_append(g, 2, US": ", addr->message);
1347 (void) string_from_gstring(g);
1349 /* Log the deferment in the message log, but don't clutter it
1350 up with retry-time defers after the first delivery attempt. */
1352 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1353 deliver_msglog("%s %s\n", now, g->s);
1355 /* Write the main log and reset the store.
1356 For errors of the type "retry time not reached" (also remotes skipped
1357 on queue run), logging is controlled by L_retry_defer. Note that this kind
1358 of error number is negative, and all the retry ones are less than any
1362 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1365 store_reset(reset_point);
1372 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1374 rmark reset_point = store_mark();
1375 gstring * g = string_get(256);
1377 #ifndef DISABLE_EVENT
1378 /* Message failures for which we will send a DSN get their event raised
1379 later so avoid doing it here. */
1381 if ( !addr->prop.ignore_error
1382 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1384 msg_event_raise(US"msg:fail:delivery", addr);
1387 /* Build up the log line for the message and main logs */
1389 /* Create the address string for logging. Must not do this earlier, because
1390 an OK result may be changed to FAIL when a pipe returns text. */
1392 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1394 if (LOGGING(sender_on_delivery))
1395 g = string_append(g, 3, US" F=<", sender_address, US">");
1398 g = string_append(g, 2, US" Q=", queue_name);
1400 /* Return path may not be set if no delivery actually happened */
1402 if (used_return_path && LOGGING(return_path_on_delivery))
1403 g = string_append(g, 3, US" P=<", used_return_path, US">");
1406 g = string_append(g, 2, US" R=", addr->router->name);
1407 if (addr->transport)
1408 g = string_append(g, 2, US" T=", addr->transport->name);
1410 if (addr->host_used)
1411 g = d_hostlog(g, addr);
1414 g = d_tlslog(g, addr);
1417 if (addr->basic_errno > 0)
1418 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1421 g = string_append(g, 2, US": ", addr->message);
1423 if (LOGGING(deliver_time))
1424 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1426 (void) string_from_gstring(g);
1428 /* Do the logging. For the message log, "routing failed" for those cases,
1429 just to make it clearer. */
1432 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1434 deliver_msglog("%s %s\n", now, g->s);
1436 log_write(0, LOG_MAIN, "** %s", g->s);
1438 store_reset(reset_point);
1444 /*************************************************
1445 * Actions at the end of handling an address *
1446 *************************************************/
1448 /* This is a function for processing a single address when all that can be done
1449 with it has been done.
1452 addr points to the address block
1453 result the result of the delivery attempt
1454 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1455 driver_type indicates which type of driver (transport, or router) was last
1456 to process the address
1457 logchar '=' or '-' for use when logging deliveries with => or ->
1463 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1466 uschar *now = tod_stamp(tod_log);
1467 uschar *driver_kind = NULL;
1468 uschar *driver_name = NULL;
1470 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1472 /* Set up driver kind and name for logging. Disable logging if the router or
1473 transport has disabled it. */
1475 if (driver_type == EXIM_DTYPE_TRANSPORT)
1477 if (addr->transport)
1479 driver_name = addr->transport->name;
1480 driver_kind = US" transport";
1481 f.disable_logging = addr->transport->disable_logging;
1483 else driver_kind = US"transporting";
1485 else if (driver_type == EXIM_DTYPE_ROUTER)
1489 driver_name = addr->router->name;
1490 driver_kind = US" router";
1491 f.disable_logging = addr->router->disable_logging;
1493 else driver_kind = US"routing";
1496 /* If there's an error message set, ensure that it contains only printing
1497 characters - it should, but occasionally things slip in and this at least
1498 stops the log format from getting wrecked. We also scan the message for an LDAP
1499 expansion item that has a password setting, and flatten the password. This is a
1500 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1501 malformed, it won't ever have gone near LDAP.) */
1505 const uschar * s = string_printing(addr->message);
1507 /* deconst cast ok as string_printing known to have alloc'n'copied */
1508 addr->message = expand_hide_passwords(US s);
1511 /* If we used a transport that has one of the "return_output" options set, and
1512 if it did in fact generate some output, then for return_output we treat the
1513 message as failed if it was not already set that way, so that the output gets
1514 returned to the sender, provided there is a sender to send it to. For
1515 return_fail_output, do this only if the delivery failed. Otherwise we just
1516 unlink the file, and remove the name so that if the delivery failed, we don't
1517 try to send back an empty or unwanted file. The log_output options operate only
1518 on a non-empty file.
1520 In any case, we close the message file, because we cannot afford to leave a
1521 file-descriptor for one address while processing (maybe very many) others. */
1523 if (addr->return_file >= 0 && addr->return_filename)
1525 BOOL return_output = FALSE;
1526 struct stat statbuf;
1527 (void)EXIMfsync(addr->return_file);
1529 /* If there is no output, do nothing. */
1531 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1533 transport_instance *tb = addr->transport;
1535 /* Handle logging options */
1538 || result == FAIL && tb->log_fail_output
1539 || result == DEFER && tb->log_defer_output
1543 FILE *f = Ufopen(addr->return_filename, "rb");
1545 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1546 "from %s transport: %s", addr->return_filename, tb->name,
1549 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1551 uschar *p = big_buffer + Ustrlen(big_buffer);
1553 while (p > big_buffer && isspace(p[-1])) p--;
1555 sp = string_printing(big_buffer);
1556 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1557 addr->address, tb->name, sp);
1562 /* Handle returning options, but only if there is an address to return
1565 if (sender_address[0] != 0 || addr->prop.errors_address)
1566 if (tb->return_output)
1568 addr->transport_return = result = FAIL;
1569 if (addr->basic_errno == 0 && !addr->message)
1570 addr->message = US"return message generated";
1571 return_output = TRUE;
1574 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1577 /* Get rid of the file unless it might be returned, but close it in
1582 Uunlink(addr->return_filename);
1583 addr->return_filename = NULL;
1584 addr->return_file = -1;
1587 (void)close(addr->return_file);
1590 /* The success case happens only after delivery by a transport. */
1594 addr->next = addr_succeed;
1595 addr_succeed = addr;
1597 /* Call address_done() to ensure that we don't deliver to this address again,
1598 and write appropriate things to the message log. If it is a child address, we
1599 call child_done() to scan the ancestors and mark them complete if this is the
1600 last child to complete. */
1602 address_done(addr, now);
1603 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1606 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1607 driver_name, driver_kind);
1610 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1611 addr->parent->address, driver_name, driver_kind);
1612 child_done(addr, now);
1615 /* Certificates for logging (via events) */
1617 tls_out.ourcert = addr->ourcert;
1618 addr->ourcert = NULL;
1619 tls_out.peercert = addr->peercert;
1620 addr->peercert = NULL;
1622 tls_out.ver = addr->tlsver;
1623 tls_out.cipher = addr->cipher;
1624 tls_out.peerdn = addr->peerdn;
1625 tls_out.ocsp = addr->ocsp;
1626 # ifdef SUPPORT_DANE
1627 tls_out.dane_verified = testflag(addr, af_dane_verified);
1631 delivery_log(LOG_MAIN, addr, logchar, NULL);
1634 tls_free_cert(&tls_out.ourcert);
1635 tls_free_cert(&tls_out.peercert);
1637 tls_out.cipher = NULL;
1638 tls_out.peerdn = NULL;
1639 tls_out.ocsp = OCSP_NOT_REQ;
1640 # ifdef SUPPORT_DANE
1641 tls_out.dane_verified = FALSE;
1647 /* Soft failure, or local delivery process failed; freezing may be
1650 else if (result == DEFER || result == PANIC)
1652 if (result == PANIC) logflags |= LOG_PANIC;
1654 /* This puts them on the chain in reverse order. Do not change this, because
1655 the code for handling retries assumes that the one with the retry
1656 information is last. */
1658 addr->next = addr_defer;
1661 /* The only currently implemented special action is to freeze the
1662 message. Logging of this is done later, just before the -H file is
1665 if (addr->special_action == SPECIAL_FREEZE)
1667 f.deliver_freeze = TRUE;
1668 deliver_frozen_at = time(NULL);
1669 update_spool = TRUE;
1672 /* If doing a 2-stage queue run, we skip writing to either the message
1673 log or the main log for SMTP defers. */
1675 if (!f.queue_2stage || addr->basic_errno != 0)
1676 deferral_log(addr, now, logflags, driver_name, driver_kind);
1680 /* Hard failure. If there is an address to which an error message can be sent,
1681 put this address on the failed list. If not, put it on the deferred list and
1682 freeze the mail message for human attention. The latter action can also be
1683 explicitly requested by a router or transport. */
1687 /* If this is a delivery error, or a message for which no replies are
1688 wanted, and the message's age is greater than ignore_bounce_errors_after,
1689 force the af_ignore_error flag. This will cause the address to be discarded
1690 later (with a log entry). */
1692 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1693 addr->prop.ignore_error = TRUE;
1695 /* Freeze the message if requested, or if this is a bounce message (or other
1696 message with null sender) and this address does not have its own errors
1697 address. However, don't freeze if errors are being ignored. The actual code
1698 to ignore occurs later, instead of sending a message. Logging of freezing
1699 occurs later, just before writing the -H file. */
1701 if ( !addr->prop.ignore_error
1702 && ( addr->special_action == SPECIAL_FREEZE
1703 || (sender_address[0] == 0 && !addr->prop.errors_address)
1706 frozen_info = addr->special_action == SPECIAL_FREEZE
1708 : f.sender_local && !f.local_error_message
1709 ? US" (message created with -f <>)"
1710 : US" (delivery error message)";
1711 f.deliver_freeze = TRUE;
1712 deliver_frozen_at = time(NULL);
1713 update_spool = TRUE;
1715 /* The address is put on the defer rather than the failed queue, because
1716 the message is being retained. */
1718 addr->next = addr_defer;
1722 /* Don't put the address on the nonrecipients tree yet; wait until an
1723 error message has been successfully sent. */
1727 addr->next = addr_failed;
1731 failure_log(addr, driver_name ? NULL : driver_kind, now);
1734 /* Ensure logging is turned on again in all cases */
1736 f.disable_logging = FALSE;
1742 /*************************************************
1743 * Address-independent error *
1744 *************************************************/
1746 /* This function is called when there's an error that is not dependent on a
1747 particular address, such as an expansion string failure. It puts the error into
1748 all the addresses in a batch, logs the incident on the main and panic logs, and
1749 clears the expansions. It is mostly called from local_deliver(), but can be
1750 called for a remote delivery via findugid().
1753 logit TRUE if (MAIN+PANIC) logging required
1754 addr the first of the chain of addresses
1756 format format string for error message, or NULL if already set in addr
1757 ... arguments for the format
1763 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1765 addr->basic_errno = code;
1772 va_start(ap, format);
1773 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1775 addr->message = string_from_gstring(g);
1778 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1780 addr2->basic_errno = code;
1781 addr2->message = addr->message;
1784 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1785 deliver_set_expansions(NULL);
1791 /*************************************************
1792 * Check a "never users" list *
1793 *************************************************/
1795 /* This function is called to check whether a uid is on one of the two "never
1799 uid the uid to be checked
1800 nusers the list to be scanned; the first item in the list is the count
1802 Returns: TRUE if the uid is on the list
1806 check_never_users(uid_t uid, uid_t *nusers)
1808 if (!nusers) return FALSE;
1809 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1815 /*************************************************
1816 * Find uid and gid for a transport *
1817 *************************************************/
1819 /* This function is called for both local and remote deliveries, to find the
1820 uid/gid under which to run the delivery. The values are taken preferentially
1821 from the transport (either explicit or deliver_as_creator), then from the
1822 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1823 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1824 panic error is logged, and the function fails (which normally leads to delivery
1828 addr the address (possibly a chain)
1830 uidp pointer to uid field
1831 gidp pointer to gid field
1832 igfp pointer to the use_initgroups field
1834 Returns: FALSE if failed - error has been set in address(es)
1838 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1842 BOOL gid_set = FALSE;
1844 /* Default initgroups flag comes from the transport */
1846 *igfp = tp->initgroups;
1848 /* First see if there's a gid on the transport, either fixed or expandable.
1849 The expanding function always logs failure itself. */
1856 else if (tp->expand_gid)
1858 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1861 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1867 /* If the transport did not set a group, see if the router did. */
1869 if (!gid_set && testflag(addr, af_gid_set))
1875 /* Pick up a uid from the transport if one is set. */
1877 if (tp->uid_set) *uidp = tp->uid;
1879 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1880 it does not provide a passwd value from which a gid can be taken. */
1882 else if (tp->expand_uid)
1885 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1886 uidp, &(addr->message)))
1888 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1898 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1900 else if (tp->deliver_as_creator)
1902 *uidp = originator_uid;
1905 *gidp = originator_gid;
1910 /* Otherwise see if the address specifies the uid and if so, take it and its
1913 else if (testflag(addr, af_uid_set))
1916 *igfp = testflag(addr, af_initgroups);
1919 /* Nothing has specified the uid - default to the Exim user, and group if the
1932 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1933 defaulting to the Exim uid. In other words, if the configuration has specified
1934 a uid, it must also provide a gid. */
1938 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1939 "%s transport", tp->name);
1943 /* Check that the uid is not on the lists of banned uids that may not be used
1944 for delivery processes. */
1946 nuname = check_never_users(*uidp, never_users)
1948 : check_never_users(*uidp, fixed_never_users)
1949 ? US"fixed_never_users"
1953 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1954 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1966 /*************************************************
1967 * Check the size of a message for a transport *
1968 *************************************************/
1970 /* Checks that the message isn't too big for the selected transport.
1971 This is called only when it is known that the limit is set.
1975 addr the (first) address being delivered
1978 DEFER expansion failed or did not yield an integer
1979 FAIL message too big
1983 check_message_size(transport_instance *tp, address_item *addr)
1988 deliver_set_expansions(addr);
1989 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1990 deliver_set_expansions(NULL);
1992 if (expand_string_message)
1995 addr->message = size_limit == -1
1996 ? string_sprintf("failed to expand message_size_limit "
1997 "in %s transport: %s", tp->name, expand_string_message)
1998 : string_sprintf("invalid message_size_limit "
1999 "in %s transport: %s", tp->name, expand_string_message);
2001 else if (size_limit > 0 && message_size > size_limit)
2005 string_sprintf("message is too big (transport limit = %d)",
2014 /*************************************************
2015 * Transport-time check for a previous delivery *
2016 *************************************************/
2018 /* Check that this base address hasn't previously been delivered to its routed
2019 transport. If it has been delivered, mark it done. The check is necessary at
2020 delivery time in order to handle homonymic addresses correctly in cases where
2021 the pattern of redirection changes between delivery attempts (so the unique
2022 fields change). Non-homonymic previous delivery is detected earlier, at routing
2023 time (which saves unnecessary routing).
2026 addr the address item
2027 testing TRUE if testing wanted only, without side effects
2029 Returns: TRUE if previously delivered by the transport
2033 previously_transported(address_item *addr, BOOL testing)
2035 uschar * s = string_sprintf("%s/%s",
2036 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2038 if (tree_search(tree_nonrecipients, s) != 0)
2040 DEBUG(D_deliver|D_route|D_transport)
2041 debug_printf("%s was previously delivered (%s transport): discarded\n",
2042 addr->address, addr->transport->name);
2043 if (!testing) child_done(addr, tod_stamp(tod_log));
2052 /******************************************************
2053 * Check for a given header in a header string *
2054 ******************************************************/
2056 /* This function is used when generating quota warnings. The configuration may
2057 specify any header lines it likes in quota_warn_message. If certain of them are
2058 missing, defaults are inserted, so we need to be able to test for the presence
2062 hdr the required header name
2063 hstring the header string
2065 Returns: TRUE the header is in the string
2066 FALSE the header is not in the string
2070 contains_header(uschar *hdr, uschar *hstring)
2072 int len = Ustrlen(hdr);
2073 uschar *p = hstring;
2076 if (strncmpic(p, hdr, len) == 0)
2079 while (*p == ' ' || *p == '\t') p++;
2080 if (*p == ':') return TRUE;
2082 while (*p != 0 && *p != '\n') p++;
2083 if (*p == '\n') p++;
2091 /*************************************************
2092 * Perform a local delivery *
2093 *************************************************/
2095 /* Each local delivery is performed in a separate process which sets its
2096 uid and gid as specified. This is a safer way than simply changing and
2097 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2098 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2099 all systems have seteuid().
2101 If the uid/gid are specified in the transport_instance, they are used; the
2102 transport initialization must ensure that either both or neither are set.
2103 Otherwise, the values associated with the address are used. If neither are set,
2104 it is a configuration error.
2106 The transport or the address may specify a home directory (transport over-
2107 rides), and if they do, this is set as $home. If neither have set a working
2108 directory, this value is used for that as well. Otherwise $home is left unset
2109 and the cwd is set to "/" - a directory that should be accessible to all users.
2111 Using a separate process makes it more complicated to get error information
2112 back. We use a pipe to pass the return code and also an error code and error
2113 text string back to the parent process.
2116 addr points to an address block for this delivery; for "normal" local
2117 deliveries this is the only address to be delivered, but for
2118 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2119 a number of addresses can be handled simultaneously, and in this
2120 case addr will point to a chain of addresses with the same
2123 shadowing TRUE if running a shadow transport; this causes output from pipes
2130 deliver_local(address_item *addr, BOOL shadowing)
2132 BOOL use_initgroups;
2135 int status, len, rc;
2138 uschar *working_directory;
2139 address_item *addr2;
2140 transport_instance *tp = addr->transport;
2142 /* Set up the return path from the errors or sender address. If the transport
2143 has its own return path setting, expand it and replace the existing value. */
2145 if(addr->prop.errors_address)
2146 return_path = addr->prop.errors_address;
2147 #ifdef EXPERIMENTAL_SRS
2148 else if (addr->prop.srs_sender)
2149 return_path = addr->prop.srs_sender;
2152 return_path = sender_address;
2154 if (tp->return_path)
2156 uschar *new_return_path = expand_string(tp->return_path);
2157 if (!new_return_path)
2159 if (!f.expand_string_forcedfail)
2161 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2162 US"Failed to expand return path \"%s\" in %s transport: %s",
2163 tp->return_path, tp->name, expand_string_message);
2167 else return_path = new_return_path;
2170 /* For local deliveries, one at a time, the value used for logging can just be
2171 set directly, once and for all. */
2173 used_return_path = return_path;
2175 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2176 gets put into the address(es), and the expansions are unset, so we can just
2179 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2181 /* See if either the transport or the address specifies a home directory. A
2182 home directory set in the address may already be expanded; a flag is set to
2183 indicate that. In other cases we must expand it. */
2185 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2186 || ( (deliver_home = addr->home_dir) /* Set in address and */
2187 && !testflag(addr, af_home_expanded) /* not expanded */
2190 uschar *rawhome = deliver_home;
2191 deliver_home = NULL; /* in case it contains $home */
2192 if (!(deliver_home = expand_string(rawhome)))
2194 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2195 "to expand for %s transport: %s", rawhome, tp->name,
2196 expand_string_message);
2199 if (*deliver_home != '/')
2201 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2202 "is not absolute for %s transport", deliver_home, tp->name);
2207 /* See if either the transport or the address specifies a current directory,
2208 and if so, expand it. If nothing is set, use the home directory, unless it is
2209 also unset in which case use "/", which is assumed to be a directory to which
2210 all users have access. It is necessary to be in a visible directory for some
2211 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2212 2.5) require this. */
2214 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2215 if (working_directory)
2217 uschar *raw = working_directory;
2218 if (!(working_directory = expand_string(raw)))
2220 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2221 "failed to expand for %s transport: %s", raw, tp->name,
2222 expand_string_message);
2225 if (*working_directory != '/')
2227 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2228 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2232 else working_directory = deliver_home ? deliver_home : US"/";
2234 /* If one of the return_output flags is set on the transport, create and open a
2235 file in the message log directory for the transport to write its output onto.
2236 This is mainly used by pipe transports. The file needs to be unique to the
2237 address. This feature is not available for shadow transports. */
2240 && ( tp->return_output || tp->return_fail_output
2241 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2246 addr->return_filename =
2247 spool_fname(US"msglog", message_subdir, message_id,
2248 string_sprintf("-%d-%d", getpid(), return_count++));
2250 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2252 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2253 "to return message: %s", error, tp->name, strerror(errno));
2258 /* Create the pipe for inter-process communication. */
2262 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2267 /* Now fork the process to do the real work in the subprocess, but first
2268 ensure that all cached resources are freed so that the subprocess starts with
2269 a clean slate and doesn't interfere with the parent process. */
2273 if ((pid = exim_fork(US"delivery-local")) == 0)
2275 BOOL replicate = TRUE;
2277 /* Prevent core dumps, as we don't want them in users' home directories.
2278 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2279 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2280 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2281 complain if the error is "not supported".
2283 There are two scenarios where changing the max limit has an effect. In one,
2284 the user is using a .forward and invoking a command of their choice via pipe;
2285 for these, we do need the max limit to be 0 unless the admin chooses to
2286 permit an increased limit. In the other, the command is invoked directly by
2287 the transport and is under administrator control, thus being able to raise
2288 the limit aids in debugging. So there's no general always-right answer.
2290 Thus we inhibit core-dumps completely but let individual transports, while
2291 still root, re-raise the limits back up to aid debugging. We make the
2292 default be no core-dumps -- few enough people can use core dumps in
2293 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2300 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2302 # ifdef SETRLIMIT_NOT_SUPPORTED
2303 if (errno != ENOSYS && errno != ENOTSUP)
2305 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2310 /* Reset the random number generator, so different processes don't all
2311 have the same sequence. */
2315 /* If the transport has a setup entry, call this first, while still
2316 privileged. (Appendfile uses this to expand quota, for example, while
2317 able to read private files.) */
2319 if (addr->transport->setup)
2320 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2324 addr->transport_return = DEFER;
2328 addr->transport_return = PANIC;
2332 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2333 when the process becomes unprivileged, it won't be able to write to the
2334 process log. SIGHUP is ignored throughout exim, except when it is being
2337 signal(SIGINT, SIG_IGN);
2338 signal(SIGTERM, SIG_IGN);
2339 signal(SIGUSR1, SIG_IGN);
2341 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2342 half - for transports that exec things (e.g. pipe). Then set the required
2345 (void)close(pfd[pipe_read]);
2346 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2348 exim_setugid(uid, gid, use_initgroups,
2349 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2350 addr->address, addr->transport->name));
2354 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2355 for (address_item * batched = addr->next; batched; batched = batched->next)
2356 debug_printf("additional batched address: %s\n", batched->address);
2359 /* Set an appropriate working directory. */
2361 if (Uchdir(working_directory) < 0)
2363 addr->transport_return = DEFER;
2364 addr->basic_errno = errno;
2365 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2368 /* If successful, call the transport */
2373 set_process_info("delivering %s to %s using %s", message_id,
2374 addr->local_part, addr->transport->name);
2376 /* Setting this global in the subprocess means we need never clear it */
2377 transport_name = addr->transport->name;
2379 /* If a transport filter has been specified, set up its argument list.
2380 Any errors will get put into the address, and FALSE yielded. */
2382 if (addr->transport->filter_command)
2384 ok = transport_set_up_command(&transport_filter_argv,
2385 addr->transport->filter_command,
2386 TRUE, PANIC, addr, US"transport filter", NULL);
2387 transport_filter_timeout = addr->transport->filter_timeout;
2389 else transport_filter_argv = NULL;
2393 debug_print_string(addr->transport->debug_string);
2394 replicate = !(addr->transport->info->code)(addr->transport, addr);
2398 /* Pass the results back down the pipe. If necessary, first replicate the
2399 status in the top address to the others in the batch. The label is the
2400 subject of a goto when a call to the transport's setup function fails. We
2401 pass the pointer to the transport back in case it got changed as a result of
2402 file_format in appendfile. */
2406 if (replicate) replicate_status(addr);
2407 for (addr2 = addr; addr2; addr2 = addr2->next)
2410 int local_part_length = Ustrlen(addr2->local_part);
2414 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2415 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2416 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2417 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2418 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2419 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2420 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2421 || (ret = write(pfd[pipe_write], &addr2->transport,
2422 sizeof(transport_instance *))) != sizeof(transport_instance *)
2424 /* For a file delivery, pass back the local part, in case the original
2425 was only part of the final delivery path. This gives more complete
2428 || (testflag(addr2, af_file)
2429 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2430 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2434 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2435 ret == -1 ? strerror(errno) : "short write");
2437 /* Now any messages */
2439 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2441 int message_length = s ? Ustrlen(s) + 1 : 0;
2442 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2443 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2445 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2446 ret == -1 ? strerror(errno) : "short write");
2450 /* OK, this process is now done. Free any cached resources that it opened,
2451 and close the pipe we were writing down before exiting. */
2453 (void)close(pfd[pipe_write]);
2458 /* Back in the main process: panic if the fork did not succeed. This seems
2459 better than returning an error - if forking is failing it is probably best
2460 not to try other deliveries for this message. */
2463 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2466 /* Read the pipe to get the delivery status codes and error messages. Our copy
2467 of the writing end must be closed first, as otherwise read() won't return zero
2468 on an empty pipe. We check that a status exists for each address before
2469 overwriting the address structure. If data is missing, the default DEFER status
2470 will remain. Afterwards, close the reading end. */
2472 (void)close(pfd[pipe_write]);
2474 for (addr2 = addr; addr2; addr2 = addr2->next)
2476 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2481 addr2->transport_return = status;
2482 len = read(pfd[pipe_read], &transport_count,
2483 sizeof(transport_count));
2484 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2485 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2486 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2487 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2488 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2489 len = read(pfd[pipe_read], &addr2->transport,
2490 sizeof(transport_instance *));
2492 if (testflag(addr2, af_file))
2495 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2496 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2499 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2500 " from delivery subprocess");
2503 /* sanity-checked llen so disable the Coverity error */
2504 /* coverity[tainted_data] */
2505 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2507 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2508 " from delivery subprocess");
2511 big_buffer[llen] = 0;
2512 addr2->local_part = string_copy(big_buffer);
2515 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2518 len = read(pfd[pipe_read], &message_length, sizeof(int));
2519 if (message_length > 0)
2521 len = read(pfd[pipe_read], big_buffer, message_length);
2522 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2523 if (len > 0) *sptr = string_copy(big_buffer);
2530 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2531 "from delivery subprocess", addr2->unique);
2536 (void)close(pfd[pipe_read]);
2538 /* Unless shadowing, write all successful addresses immediately to the journal
2539 file, to ensure they are recorded asap. For homonymic addresses, use the base
2540 address plus the transport name. Failure to write the journal is panic-worthy,
2541 but don't stop, as it may prove possible subsequently to update the spool file
2542 in order to record the delivery. */
2546 for (addr2 = addr; addr2; addr2 = addr2->next)
2547 if (addr2->transport_return == OK)
2549 if (testflag(addr2, af_homonym))
2550 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2552 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2554 /* In the test harness, wait just a bit to let the subprocess finish off
2555 any debug output etc first. */
2557 testharness_pause_ms(300);
2559 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2560 len = Ustrlen(big_buffer);
2561 if (write(journal_fd, big_buffer, len) != len)
2562 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2563 big_buffer, strerror(errno));
2566 /* Ensure the journal file is pushed out to disk. */
2568 if (EXIMfsync(journal_fd) < 0)
2569 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2573 /* Wait for the process to finish. If it terminates with a non-zero code,
2574 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2575 status values of all the addresses as they are. Take care to handle the case
2576 when the subprocess doesn't seem to exist. This has been seen on one system
2577 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2578 happens, wait() doesn't recognize the termination of child processes. Exim now
2579 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2581 while ((rc = wait(&status)) != pid)
2582 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2584 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2585 addr->transport->driver_name);
2590 if ((status & 0xffff) != 0)
2592 int msb = (status >> 8) & 255;
2593 int lsb = status & 255;
2594 int code = (msb == 0)? (lsb & 0x7f) : msb;
2595 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2596 addr->special_action = SPECIAL_FREEZE;
2597 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2598 "status 0x%04x: %s %d",
2599 addr->transport->driver_name,
2601 msb == 0 ? "terminated by signal" : "exit code",
2605 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2607 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2610 uschar *warn_message;
2613 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2615 if (!(warn_message = expand_string(addr->transport->warn_message)))
2616 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2617 "message for %s transport): %s", addr->transport->warn_message,
2618 addr->transport->name, expand_string_message);
2620 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2622 FILE *f = fdopen(fd, "wb");
2623 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2624 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2625 fprintf(f, "Auto-Submitted: auto-replied\n");
2626 if (!contains_header(US"From", warn_message))
2628 fprintf(f, "%s", CS warn_message);
2630 /* Close and wait for child process to complete, without a timeout. */
2633 (void)child_close(pid, 0);
2636 addr->special_action = SPECIAL_NONE;
2643 /* Check transport for the given concurrency limit. Return TRUE if over
2644 the limit (or an expansion failure), else FALSE and if there was a limit,
2645 the key for the hints database used for the concurrency count. */
2648 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2650 unsigned max_parallel;
2652 if (!tp->max_parallel) return FALSE;
2654 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2655 if (expand_string_message)
2657 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2658 "in %s transport (%s): %s", tp->name, addr->address,
2659 expand_string_message);
2663 if (max_parallel > 0)
2665 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2666 if (!enq_start(serialize_key, max_parallel))
2668 address_item * next;
2670 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2671 tp->name, max_parallel);
2675 addr->message = US"concurrency limit reached for transport";
2676 addr->basic_errno = ERRNO_TRETRY;
2677 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2678 } while ((addr = next));
2681 *key = serialize_key;
2688 /*************************************************
2689 * Do local deliveries *
2690 *************************************************/
2692 /* This function processes the list of addresses in addr_local. True local
2693 deliveries are always done one address at a time. However, local deliveries can
2694 be batched up in some cases. Typically this is when writing batched SMTP output
2695 files for use by some external transport mechanism, or when running local
2696 deliveries over LMTP.
2703 do_local_deliveries(void)
2706 open_db *dbm_file = NULL;
2707 time_t now = time(NULL);
2709 /* Loop until we have exhausted the supply of local deliveries */
2713 struct timeval delivery_start;
2714 struct timeval deliver_time;
2715 address_item *addr2, *addr3, *nextaddr;
2716 int logflags = LOG_MAIN;
2717 int logchar = f.dont_deliver? '*' : '=';
2718 transport_instance *tp;
2719 uschar * serialize_key = NULL;
2721 /* Pick the first undelivered address off the chain */
2723 address_item *addr = addr_local;
2724 addr_local = addr->next;
2727 DEBUG(D_deliver|D_transport)
2728 debug_printf("--------> %s <--------\n", addr->address);
2730 /* An internal disaster if there is no transport. Should not occur! */
2732 if (!(tp = addr->transport))
2734 logflags |= LOG_PANIC;
2735 f.disable_logging = FALSE; /* Jic */
2736 addr->message = addr->router
2737 ? string_sprintf("No transport set by %s router", addr->router->name)
2738 : US"No transport set by system filter";
2739 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2743 /* Check that this base address hasn't previously been delivered to this
2744 transport. The check is necessary at this point to handle homonymic addresses
2745 correctly in cases where the pattern of redirection changes between delivery
2746 attempts. Non-homonymic previous delivery is detected earlier, at routing
2749 if (previously_transported(addr, FALSE)) continue;
2751 /* There are weird cases where logging is disabled */
2753 f.disable_logging = tp->disable_logging;
2755 /* Check for batched addresses and possible amalgamation. Skip all the work
2756 if either batch_max <= 1 or there aren't any other addresses for local
2759 if (tp->batch_max > 1 && addr_local)
2761 int batch_count = 1;
2762 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2763 BOOL uses_lp = ( testflag(addr, af_pfr)
2764 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2766 || readconf_depends((driver_instance *)tp, US"local_part");
2767 uschar *batch_id = NULL;
2768 address_item **anchor = &addr_local;
2769 address_item *last = addr;
2772 /* Expand the batch_id string for comparison with other addresses.
2773 Expansion failure suppresses batching. */
2777 deliver_set_expansions(addr);
2778 batch_id = expand_string(tp->batch_id);
2779 deliver_set_expansions(NULL);
2782 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2783 "in %s transport (%s): %s", tp->name, addr->address,
2784 expand_string_message);
2785 batch_count = tp->batch_max;
2789 /* Until we reach the batch_max limit, pick off addresses which have the
2790 same characteristics. These are:
2793 not previously delivered (see comment about 50 lines above)
2794 same local part if the transport's configuration contains $local_part
2795 or if this is a file or pipe delivery from a redirection
2796 same domain if the transport's configuration contains $domain
2798 same additional headers
2799 same headers to be removed
2800 same uid/gid for running the transport
2801 same first host if a host list is set
2804 while ((next = *anchor) && batch_count < tp->batch_max)
2807 tp == next->transport
2808 && !previously_transported(next, TRUE)
2809 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2810 && testflag(addr, af_file) == testflag(next, af_file)
2811 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2812 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2813 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2814 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2815 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2816 && same_ugid(tp, addr, next)
2817 && ( !addr->host_list && !next->host_list
2820 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2823 /* If the transport has a batch_id setting, batch_id will be non-NULL
2824 from the expansion outside the loop. Expand for this address and compare.
2825 Expansion failure makes this address ineligible for batching. */
2830 address_item *save_nextnext = next->next;
2831 next->next = NULL; /* Expansion for a single address */
2832 deliver_set_expansions(next);
2833 next->next = save_nextnext;
2834 bid = expand_string(tp->batch_id);
2835 deliver_set_expansions(NULL);
2838 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2839 "in %s transport (%s): %s", tp->name, next->address,
2840 expand_string_message);
2843 else ok = (Ustrcmp(batch_id, bid) == 0);
2846 /* Take address into batch if OK. */
2850 *anchor = next->next; /* Include the address */
2856 else anchor = &next->next; /* Skip the address */
2860 /* We now have one or more addresses that can be delivered in a batch. Check
2861 whether the transport is prepared to accept a message of this size. If not,
2862 fail them all forthwith. If the expansion fails, or does not yield an
2863 integer, defer delivery. */
2865 if (tp->message_size_limit)
2867 int rc = check_message_size(tp, addr);
2870 replicate_status(addr);
2874 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2877 continue; /* With next batch of addresses */
2881 /* If we are not running the queue, or if forcing, all deliveries will be
2882 attempted. Otherwise, we must respect the retry times for each address. Even
2883 when not doing this, we need to set up the retry key string, and determine
2884 whether a retry record exists, because after a successful delivery, a delete
2885 retry item must be set up. Keep the retry database open only for the duration
2886 of these checks, rather than for all local deliveries, because some local
2887 deliveries (e.g. to pipes) can take a substantial time. */
2889 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2891 DEBUG(D_deliver|D_retry|D_hints_lookup)
2892 debug_printf("no retry data available\n");
2899 BOOL ok = TRUE; /* to deliver this address */
2902 /* Set up the retry key to include the domain or not, and change its
2903 leading character from "R" to "T". Must make a copy before doing this,
2904 because the old key may be pointed to from a "delete" retry item after
2907 retry_key = string_copy(
2908 tp->retry_use_local_part ? addr2->address_retry_key :
2909 addr2->domain_retry_key);
2912 /* Inspect the retry data. If there is no hints file, delivery happens. */
2916 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2918 /* If there is no retry record, delivery happens. If there is,
2919 remember it exists so it can be deleted after a successful delivery. */
2923 setflag(addr2, af_lt_retry_exists);
2925 /* A retry record exists for this address. If queue running and not
2926 forcing, inspect its contents. If the record is too old, or if its
2927 retry time has come, or if it has passed its cutoff time, delivery
2932 debug_printf("retry record exists: age=%s ",
2933 readconf_printtime(now - retry_record->time_stamp));
2934 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2935 debug_printf(" time to retry = %s expired = %d\n",
2936 readconf_printtime(retry_record->next_try - now),
2937 retry_record->expired);
2940 if (f.queue_running && !f.deliver_force)
2942 ok = (now - retry_record->time_stamp > retry_data_expire)
2943 || (now >= retry_record->next_try)
2944 || retry_record->expired;
2946 /* If we haven't reached the retry time, there is one more check
2947 to do, which is for the ultimate address timeout. */
2950 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2954 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2957 /* This address is to be delivered. Leave it on the chain. */
2962 addr2 = addr2->next;
2965 /* This address is to be deferred. Take it out of the chain, and
2966 post-process it as complete. Must take it out of the chain first,
2967 because post processing puts it on another chain. */
2971 address_item *this = addr2;
2972 this->message = US"Retry time not yet reached";
2973 this->basic_errno = ERRNO_LRETRY;
2974 addr2 = addr3 ? (addr3->next = addr2->next)
2975 : (addr = addr2->next);
2976 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2980 if (dbm_file) dbfn_close(dbm_file);
2982 /* If there are no addresses left on the chain, they all deferred. Loop
2983 for the next set of addresses. */
2985 if (!addr) continue;
2987 /* If the transport is limited for parallellism, enforce that here.
2988 We use a hints DB entry, incremented here and decremented after
2989 the transport (and any shadow transport) completes. */
2991 if (tpt_parallel_check(tp, addr, &serialize_key))
2993 if (expand_string_message)
2995 logflags |= LOG_PANIC;
2999 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3000 } while ((addr = addr2));
3002 continue; /* Loop for the next set of addresses. */
3006 /* So, finally, we do have some addresses that can be passed to the
3007 transport. Before doing so, set up variables that are relevant to a
3010 deliver_set_expansions(addr);
3012 gettimeofday(&delivery_start, NULL);
3013 deliver_local(addr, FALSE);
3014 timesince(&deliver_time, &delivery_start);
3016 /* If a shadow transport (which must perforce be another local transport), is
3017 defined, and its condition is met, we must pass the message to the shadow
3018 too, but only those addresses that succeeded. We do this by making a new
3019 chain of addresses - also to keep the original chain uncontaminated. We must
3020 use a chain rather than doing it one by one, because the shadow transport may
3023 NOTE: if the condition fails because of a lookup defer, there is nothing we
3027 && ( !tp->shadow_condition
3028 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3031 transport_instance *stp;
3032 address_item *shadow_addr = NULL;
3033 address_item **last = &shadow_addr;
3035 for (stp = transports; stp; stp = stp->next)
3036 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3039 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3042 /* Pick off the addresses that have succeeded, and make clones. Put into
3043 the shadow_message field a pointer to the shadow_message field of the real
3046 else for (addr2 = addr; addr2; addr2 = addr2->next)
3047 if (addr2->transport_return == OK)
3049 addr3 = store_get(sizeof(address_item), FALSE);
3052 addr3->shadow_message = US &addr2->shadow_message;
3053 addr3->transport = stp;
3054 addr3->transport_return = DEFER;
3055 addr3->return_filename = NULL;
3056 addr3->return_file = -1;
3058 last = &addr3->next;
3061 /* If we found any addresses to shadow, run the delivery, and stick any
3062 message back into the shadow_message field in the original. */
3066 int save_count = transport_count;
3068 DEBUG(D_deliver|D_transport)
3069 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3070 deliver_local(shadow_addr, TRUE);
3072 for(; shadow_addr; shadow_addr = shadow_addr->next)
3074 int sresult = shadow_addr->transport_return;
3075 *(uschar **)shadow_addr->shadow_message =
3077 ? string_sprintf(" ST=%s", stp->name)
3078 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3079 shadow_addr->basic_errno <= 0
3081 : US strerror(shadow_addr->basic_errno),
3082 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3085 shadow_addr->message
3086 ? shadow_addr->message
3087 : shadow_addr->basic_errno <= 0
3091 DEBUG(D_deliver|D_transport)
3092 debug_printf("%s shadow transport returned %s for %s\n",
3093 stp->name, rc_to_string(sresult), shadow_addr->address);
3096 DEBUG(D_deliver|D_transport)
3097 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3099 transport_count = save_count; /* Restore original transport count */
3103 /* Cancel the expansions that were set up for the delivery. */
3105 deliver_set_expansions(NULL);
3107 /* If the transport was parallelism-limited, decrement the hints DB record. */
3109 if (serialize_key) enq_end(serialize_key);
3111 /* Now we can process the results of the real transport. We must take each
3112 address off the chain first, because post_process_one() puts it on another
3115 for (addr2 = addr; addr2; addr2 = nextaddr)
3117 int result = addr2->transport_return;
3118 nextaddr = addr2->next;
3120 DEBUG(D_deliver|D_transport)
3121 debug_printf("%s transport returned %s for %s\n",
3122 tp->name, rc_to_string(result), addr2->address);
3124 /* If there is a retry_record, or if delivery is deferred, build a retry
3125 item for setting a new retry time or deleting the old retry record from
3126 the database. These items are handled all together after all addresses
3127 have been handled (so the database is open just for a short time for
3130 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3132 int flags = result == DEFER ? 0 : rf_delete;
3133 uschar *retry_key = string_copy(tp->retry_use_local_part
3134 ? addr2->address_retry_key : addr2->domain_retry_key);
3136 retry_add_item(addr2, retry_key, flags);
3139 /* Done with this address */
3141 addr2->delivery_time = deliver_time;
3142 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3144 /* If a pipe delivery generated text to be sent back, the result may be
3145 changed to FAIL, and we must copy this for subsequent addresses in the
3148 if (addr2->transport_return != result)
3150 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3152 addr3->transport_return = addr2->transport_return;
3153 addr3->basic_errno = addr2->basic_errno;
3154 addr3->message = addr2->message;
3156 result = addr2->transport_return;
3159 /* Whether or not the result was changed to FAIL, we need to copy the
3160 return_file value from the first address into all the addresses of the
3161 batch, so they are all listed in the error message. */
3163 addr2->return_file = addr->return_file;
3165 /* Change log character for recording successful deliveries. */
3167 if (result == OK) logchar = '-';
3169 } /* Loop back for next batch of addresses */
3175 /*************************************************
3176 * Sort remote deliveries *
3177 *************************************************/
3179 /* This function is called if remote_sort_domains is set. It arranges that the
3180 chain of addresses for remote deliveries is ordered according to the strings
3181 specified. Try to make this shuffling reasonably efficient by handling
3182 sequences of addresses rather than just single ones.
3189 sort_remote_deliveries(void)
3192 address_item **aptr = &addr_remote;
3193 const uschar *listptr = remote_sort_domains;
3198 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3201 address_item *moved = NULL;
3202 address_item **bptr = &moved;
3206 address_item **next;
3207 deliver_domain = (*aptr)->domain; /* set $domain */
3208 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3209 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3211 aptr = &(*aptr)->next;
3215 next = &(*aptr)->next;
3217 && (deliver_domain = (*next)->domain, /* Set $domain */
3218 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3219 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3221 next = &(*next)->next;
3223 /* If the batch of non-matchers is at the end, add on any that were
3224 extracted further up the chain, and end this iteration. Otherwise,
3225 extract them from the chain and hang on the moved chain. */
3237 aptr = &(*aptr)->next;
3240 /* If the loop ended because the final address matched, *aptr will
3241 be NULL. Add on to the end any extracted non-matching addresses. If
3242 *aptr is not NULL, the loop ended via "break" when *next is null, that
3243 is, there was a string of non-matching addresses at the end. In this
3244 case the extracted addresses have already been added on the end. */
3246 if (!*aptr) *aptr = moved;
3251 debug_printf("remote addresses after sorting:\n");
3252 for (address_item * addr = addr_remote; addr; addr = addr->next)
3253 debug_printf(" %s\n", addr->address);
3259 /*************************************************
3260 * Read from pipe for remote delivery subprocess *
3261 *************************************************/
3263 /* This function is called when the subprocess is complete, but can also be
3264 called before it is complete, in order to empty a pipe that is full (to prevent
3265 deadlock). It must therefore keep track of its progress in the parlist data
3268 We read the pipe to get the delivery status codes and a possible error message
3269 for each address, optionally preceded by unusability data for the hosts and
3270 also by optional retry data.
3272 Read in large chunks into the big buffer and then scan through, interpreting
3273 the data therein. In most cases, only a single read will be necessary. No
3274 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3275 that we read the next chunk when there is less than 2500 bytes left in the
3276 non-final chunk, we can assume each item is complete in the buffer before
3277 handling it. Each item is written using a single write(), which is atomic for
3278 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3279 often bigger) so even if we are reading while the subprocess is still going, we
3280 should never have only a partial item in the buffer.
3282 hs12: This assumption is not true anymore, since we get quite large items (certificate
3283 information and such).
3286 poffset the offset of the parlist item
3287 eop TRUE if the process has completed
3289 Returns: TRUE if the terminating 'Z' item has been read,
3290 or there has been a disaster (i.e. no more data needed);
3295 par_read_pipe(int poffset, BOOL eop)
3298 pardata *p = parlist + poffset;
3299 address_item *addrlist = p->addrlist;
3300 address_item *addr = p->addr;
3304 uschar *msg = p->msg;
3305 BOOL done = p->done;
3307 /* Loop through all items, reading from the pipe when necessary. The pipe
3308 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3309 here, as the preceding select() tells us, if data is available for reading.
3311 A read() on a "selected" handle should never block, but(!) it may return
3312 less data then we expected. (The buffer size we pass to read() shouldn't be
3313 understood as a "request", but as a "limit".)
3315 Each separate item is written to the pipe in a timely manner. But, especially for
3316 larger items, the read(2) may already return partial data from the write(2).
3318 The write is atomic mostly (depending on the amount written), but atomic does
3319 not imply "all or noting", it just is "not intermixed" with other writes on the
3320 same channel (pipe).
3324 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3325 (int)p->pid, eop? "ended" : "not ended yet");
3329 retry_item *r, **rp;
3330 uschar pipeheader[PIPE_HEADER_SIZE+1];
3331 uschar *id = &pipeheader[0];
3332 uschar *subid = &pipeheader[1];
3333 uschar *ptr = big_buffer;
3334 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3337 DEBUG(D_deliver) debug_printf(
3338 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3340 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3341 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3342 If we get less, we can assume the subprocess do be done and do not expect any further
3343 information from it. */
3345 if ((got = readn(fd, pipeheader, required)) != required)
3347 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3348 "from transport process %d for transport %s",
3349 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3354 pipeheader[PIPE_HEADER_SIZE] = '\0';
3356 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3360 /* If we can't decode the pipeheader, the subprocess seems to have a
3361 problem, we do not expect any furher information from it. */
3363 required = Ustrtol(pipeheader+2, &endc, 10);
3366 msg = string_sprintf("failed to read pipe "
3367 "from transport process %d for transport %s: error decoding size from header",
3368 pid, addr->transport->driver_name);
3375 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3376 (u_long)required, pid);
3378 /* Same as above, the transport process will write the bytes announced
3379 in a timely manner, so we can just wait for the bytes, getting less than expected
3380 is considered a problem of the subprocess, we do not expect anything else from it. */
3381 if ((got = readn(fd, big_buffer, required)) != required)
3383 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3384 " bytes (pipedata) from transport process %d for transport %s",
3385 got, required, pid, addr->transport->driver_name);
3390 /* Handle each possible type of item, assuming the complete item is
3391 available in store. */
3395 /* Host items exist only if any hosts were marked unusable. Match
3396 up by checking the IP address. */
3399 for (h = addrlist->host_list; h; h = h->next)
3401 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3409 /* Retry items are sent in a preceding R item for each address. This is
3410 kept separate to keep each message short enough to guarantee it won't
3411 be split in the pipe. Hopefully, in the majority of cases, there won't in
3412 fact be any retry items at all.
3414 The complete set of retry items might include an item to delete a
3415 routing retry if there was a previous routing delay. However, routing
3416 retries are also used when a remote transport identifies an address error.
3417 In that case, there may also be an "add" item for the same key. Arrange
3418 that a "delete" item is dropped in favour of an "add" item. */
3421 if (!addr) goto ADDR_MISMATCH;
3423 DEBUG(D_deliver|D_retry)
3424 debug_printf("reading retry information for %s from subprocess\n",
3427 /* Cut out any "delete" items on the list. */
3429 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3430 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3432 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3433 *rp = r->next; /* Excise a delete item */
3434 DEBUG(D_deliver|D_retry)
3435 debug_printf(" existing delete item dropped\n");
3438 /* We want to add a delete item only if there is no non-delete item;
3439 however we still have to step ptr through the data. */
3441 if (!r || !(*ptr & rf_delete))
3443 r = store_get(sizeof(retry_item), FALSE);
3444 r->next = addr->retries;
3447 r->key = string_copy(ptr);
3449 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3450 ptr += sizeof(r->basic_errno);
3451 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3452 ptr += sizeof(r->more_errno);
3453 r->message = *ptr ? string_copy(ptr) : NULL;
3454 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3455 r->flags & rf_delete ? "delete" : "retry");
3460 DEBUG(D_deliver|D_retry)
3461 debug_printf(" delete item not added: non-delete item exists\n");
3464 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3470 /* Put the amount of data written into the parlist block */
3473 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3474 ptr += sizeof(transport_count);
3477 /* Address items are in the order of items on the address chain. We
3478 remember the current address value in case this function is called
3479 several times to empty the pipe in stages. Information about delivery
3480 over TLS is sent in a preceding X item for each address. We don't put
3481 it in with the other info, in order to keep each message short enough to
3482 guarantee it won't be split in the pipe. */
3486 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3490 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3494 addr->cipher = string_copy(ptr);
3495 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3499 addr->peerdn = string_copy(ptr);
3504 (void) tls_import_cert(ptr, &addr->peercert);
3506 addr->peercert = NULL;
3511 (void) tls_import_cert(ptr, &addr->ourcert);
3513 addr->ourcert = NULL;
3516 # ifndef DISABLE_OCSP
3518 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3524 #endif /*DISABLE_TLS*/
3526 case 'C': /* client authenticator information */
3529 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3530 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3531 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3536 #ifndef DISABLE_PRDR
3538 setflag(addr, af_prdr_used);
3545 #ifndef DISABLE_PIPE_CONNECT
3546 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3548 case 1: setflag(addr, af_pipelining); break;
3553 setflag(addr, af_chunking_used);
3557 setflag(addr, af_tcp_fastopen_conn);
3558 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3559 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3563 if (!addr) goto ADDR_MISMATCH;
3564 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3565 ptr += sizeof(addr->dsn_aware);
3566 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3573 msg = string_sprintf("address count mismatch for data read from pipe "
3574 "for transport process %d for transport %s", pid,
3575 addrlist->transport->driver_name);
3582 #ifdef SUPPORT_SOCKS
3583 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3584 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3589 proxy_local_address = string_copy(ptr);
3591 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3592 ptr += sizeof(proxy_local_port);
3597 #ifdef EXPERIMENTAL_DSN_INFO
3598 case '1': /* must arrive before A0, and applies to that addr */
3599 /* Two strings: smtp_greeting and helo_response */
3600 addr->smtp_greeting = string_copy(ptr);
3602 addr->helo_response = string_copy(ptr);
3608 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3609 addr->transport_return = *ptr++;
3610 addr->special_action = *ptr++;
3611 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3612 ptr += sizeof(addr->basic_errno);
3613 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3614 ptr += sizeof(addr->more_errno);
3615 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3616 ptr += sizeof(addr->delivery_time);
3617 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3618 ptr += sizeof(addr->flags);
3619 addr->message = *ptr ? string_copy(ptr) : NULL;
3621 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3624 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3628 h = store_get(sizeof(host_item), FALSE);
3629 h->name = string_copy(ptr);
3631 h->address = string_copy(ptr);
3633 memcpy(&h->port, ptr, sizeof(h->port));
3634 ptr += sizeof(h->port);
3635 h->dnssec = *ptr == '2' ? DS_YES
3636 : *ptr == '1' ? DS_NO
3639 addr->host_used = h;
3643 /* Finished with this address */
3650 /* Local interface address/port */
3652 if (*ptr) sending_ip_address = string_copy(ptr);
3654 if (*ptr) sending_port = atoi(CS ptr);
3658 /* Z marks the logical end of the data. It is followed by '0' if
3659 continue_transport was NULL at the end of transporting, otherwise '1'.
3660 We need to know when it becomes NULL during a delivery down a passed SMTP
3661 channel so that we don't try to pass anything more down it. Of course, for
3662 most normal messages it will remain NULL all the time. */
3667 continue_transport = NULL;
3668 continue_hostname = NULL;
3671 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3674 /* Anything else is a disaster. */
3677 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3678 "process %d for transport %s", ptr[-1], pid,
3679 addr->transport->driver_name);
3685 /* The done flag is inspected externally, to determine whether or not to
3686 call the function again when the process finishes. */
3690 /* If the process hadn't finished, and we haven't seen the end of the data
3691 or if we suffered a disaster, update the rest of the state, and return FALSE to
3692 indicate "not finished". */
3701 /* Close our end of the pipe, to prevent deadlock if the far end is still
3702 pushing stuff into it. */
3707 /* If we have finished without error, but haven't had data for every address,
3708 something is wrong. */
3711 msg = string_sprintf("insufficient address data read from pipe "
3712 "for transport process %d for transport %s", pid,
3713 addr->transport->driver_name);
3715 /* If an error message is set, something has gone wrong in getting back
3716 the delivery data. Put the message into each address and freeze it. */
3719 for (addr = addrlist; addr; addr = addr->next)
3721 addr->transport_return = DEFER;
3722 addr->special_action = SPECIAL_FREEZE;
3723 addr->message = msg;
3724 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3727 /* Return TRUE to indicate we have got all we need from this process, even
3728 if it hasn't actually finished yet. */
3735 /*************************************************
3736 * Post-process a set of remote addresses *
3737 *************************************************/
3739 /* Do what has to be done immediately after a remote delivery for each set of
3740 addresses, then re-write the spool if necessary. Note that post_process_one
3741 puts the address on an appropriate queue; hence we must fish off the next
3742 one first. This function is also called if there is a problem with setting
3743 up a subprocess to do a remote delivery in parallel. In this case, the final
3744 argument contains a message, and the action must be forced to DEFER.
3747 addr pointer to chain of address items
3748 logflags flags for logging
3749 msg NULL for normal cases; -> error message for unexpected problems
3750 fallback TRUE if processing fallback hosts
3756 remote_post_process(address_item *addr, int logflags, uschar *msg,
3759 /* If any host addresses were found to be unusable, add them to the unusable
3760 tree so that subsequent deliveries don't try them. */
3762 for (host_item * h = addr->host_list; h; h = h->next)
3764 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3766 /* Now handle each address on the chain. The transport has placed '=' or '-'
3767 into the special_action field for each successful delivery. */
3771 address_item *next = addr->next;
3773 /* If msg == NULL (normal processing) and the result is DEFER and we are
3774 processing the main hosts and there are fallback hosts available, put the
3775 address on the list for fallback delivery. */
3777 if ( addr->transport_return == DEFER
3778 && addr->fallback_hosts
3783 addr->host_list = addr->fallback_hosts;
3784 addr->next = addr_fallback;
3785 addr_fallback = addr;
3786 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3789 /* If msg is set (=> unexpected problem), set it in the address before
3790 doing the ordinary post processing. */
3796 addr->message = msg;
3797 addr->transport_return = DEFER;
3799 (void)post_process_one(addr, addr->transport_return, logflags,
3800 EXIM_DTYPE_TRANSPORT, addr->special_action);
3808 /* If we have just delivered down a passed SMTP channel, and that was
3809 the last address, the channel will have been closed down. Now that
3810 we have logged that delivery, set continue_sequence to 1 so that
3811 any subsequent deliveries don't get "*" incorrectly logged. */
3813 if (!continue_transport) continue_sequence = 1;
3818 /*************************************************
3819 * Wait for one remote delivery subprocess *
3820 *************************************************/
3822 /* This function is called while doing remote deliveries when either the
3823 maximum number of processes exist and we need one to complete so that another
3824 can be created, or when waiting for the last ones to complete. It must wait for
3825 the completion of one subprocess, empty the control block slot, and return a
3826 pointer to the address chain.
3829 Returns: pointer to the chain of addresses handled by the process;
3830 NULL if no subprocess found - this is an unexpected error
3833 static address_item *
3836 int poffset, status;
3837 address_item *addr, *addrlist;
3840 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3841 "to finish", message_id);
3843 /* Loop until either a subprocess completes, or there are no subprocesses in
3844 existence - in which case give an error return. We cannot proceed just by
3845 waiting for a completion, because a subprocess may have filled up its pipe, and
3846 be waiting for it to be emptied. Therefore, if no processes have finished, we
3847 wait for one of the pipes to acquire some data by calling select(), with a
3848 timeout just in case.
3850 The simple approach is just to iterate after reading data from a ready pipe.
3851 This leads to non-ideal behaviour when the subprocess has written its final Z
3852 item, closed the pipe, and is in the process of exiting (the common case). A
3853 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3854 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3857 To avoid this, if all the data that is needed has been read from a subprocess
3858 after select(), an explicit wait() for it is done. We know that all it is doing
3859 is writing to the pipe and then exiting, so the wait should not be long.
3861 The non-blocking waitpid() is to some extent just insurance; if we could
3862 reliably detect end-of-file on the pipe, we could always know when to do a
3863 blocking wait() for a completed process. However, because some systems use
3864 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3865 use code that functions without the need to recognize EOF.
3867 There's a double loop here just in case we end up with a process that is not in
3868 the list of remote delivery processes. Something has obviously gone wrong if
3869 this is the case. (For example, a process that is incorrectly left over from
3870 routing or local deliveries might be found.) The damage can be minimized by
3871 looping back and looking for another process. If there aren't any, the error
3872 return will happen. */
3874 for (;;) /* Normally we do not repeat this loop */
3876 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3879 fd_set select_pipes;
3880 int maxpipe, readycount;
3882 /* A return value of -1 can mean several things. If errno != ECHILD, it
3883 either means invalid options (which we discount), or that this process was
3884 interrupted by a signal. Just loop to try the waitpid() again.
3886 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3887 in existence. This should never happen, and is an unexpected error.
3888 However, there is a nasty complication when running under Linux. If "strace
3889 -f" is being used under Linux to trace this process and its children,
3890 subprocesses are "stolen" from their parents and become the children of the
3891 tracing process. A general wait such as the one we've just obeyed returns
3892 as if there are no children while subprocesses are running. Once a
3893 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3894 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3897 This does not happen using "truss" on Solaris, nor (I think) with other
3898 tracing facilities on other OS. It seems to be specific to Linux.
3900 What we do to get round this is to use kill() to see if any of our
3901 subprocesses are still in existence. If kill() gives an OK return, we know
3902 it must be for one of our processes - it can't be for a re-use of the pid,
3903 because if our process had finished, waitpid() would have found it. If any
3904 of our subprocesses are in existence, we proceed to use select() as if
3905 waitpid() had returned zero. I think this is safe. */
3909 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3912 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3913 "for process existence\n");
3915 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3917 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3919 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3920 "stolen by strace\n", (int)pid);
3921 break; /* With poffset set */
3925 if (poffset >= remote_max_parallel)
3927 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3928 return NULL; /* This is the error return */
3932 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3933 been handled above. A return value of zero means that there is at least one
3934 subprocess, but there are no completed subprocesses. See if any pipes are
3935 ready with any data for reading. */
3937 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3940 FD_ZERO(&select_pipes);
3941 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3942 if (parlist[poffset].pid != 0)
3944 int fd = parlist[poffset].fd;
3945 FD_SET(fd, &select_pipes);
3946 if (fd > maxpipe) maxpipe = fd;
3949 /* Stick in a 60-second timeout, just in case. */
3954 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3957 /* Scan through the pipes and read any that are ready; use the count
3958 returned by select() to stop when there are no more. Select() can return
3959 with no processes (e.g. if interrupted). This shouldn't matter.
3961 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3962 read, or there was a disaster. In either case, we are finished with this
3963 process. Do an explicit wait() for the process and break the main loop if
3966 It turns out that we have to deal with the case of an interrupted system
3967 call, which can happen on some operating systems if the signal handling is
3968 set up to do that by default. */
3971 readycount > 0 && poffset < remote_max_parallel;
3974 if ( (pid = parlist[poffset].pid) != 0
3975 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3979 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3980 for (;;) /* Loop for signals */
3982 pid_t endedpid = waitpid(pid, &status, 0);
3983 if (endedpid == pid) goto PROCESS_DONE;
3984 if (endedpid != (pid_t)(-1) || errno != EINTR)
3985 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3986 "%d (errno = %d) from waitpid() for process %d",
3987 (int)endedpid, errno, (int)pid);
3992 /* Now go back and look for a completed subprocess again. */
3995 /* A completed process was detected by the non-blocking waitpid(). Find the
3996 data block that corresponds to this subprocess. */
3998 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3999 if (pid == parlist[poffset].pid) break;
4001 /* Found the data block; this is a known remote delivery process. We don't
4002 need to repeat the outer loop. This should be what normally happens. */
4004 if (poffset < remote_max_parallel) break;
4006 /* This situation is an error, but it's probably better to carry on looking
4007 for another process than to give up (as we used to do). */
4009 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4010 "transport process list", pid);
4011 } /* End of the "for" loop */
4013 /* Come here when all the data was completely read after a select(), and
4014 the process in pid has been wait()ed for. */
4021 debug_printf("remote delivery process %d ended\n", (int)pid);
4023 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4027 set_process_info("delivering %s", message_id);
4029 /* Get the chain of processed addresses */
4031 addrlist = parlist[poffset].addrlist;
4033 /* If the process did not finish cleanly, record an error and freeze (except
4034 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4035 in case the delivery did actually happen. */
4037 if ((status & 0xffff) != 0)
4040 int msb = (status >> 8) & 255;
4041 int lsb = status & 255;
4042 int code = (msb == 0)? (lsb & 0x7f) : msb;
4044 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4046 addrlist->transport->driver_name,
4048 (msb == 0)? "terminated by signal" : "exit code",
4051 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4052 addrlist->special_action = SPECIAL_FREEZE;
4054 for (addr = addrlist; addr; addr = addr->next)
4056 addr->transport_return = DEFER;
4057 addr->message = msg;
4060 remove_journal = FALSE;
4063 /* Else complete reading the pipe to get the result of the delivery, if all
4064 the data has not yet been obtained. */
4066 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4068 /* Put the data count and return path into globals, mark the data slot unused,
4069 decrement the count of subprocesses, and return the address chain. */
4071 transport_count = parlist[poffset].transport_count;
4072 used_return_path = parlist[poffset].return_path;
4073 parlist[poffset].pid = 0;
4080 /*************************************************
4081 * Wait for subprocesses and post-process *
4082 *************************************************/
4084 /* This function waits for subprocesses until the number that are still running
4085 is below a given threshold. For each complete subprocess, the addresses are
4086 post-processed. If we can't find a running process, there is some shambles.
4087 Better not bomb out, as that might lead to multiple copies of the message. Just
4088 log and proceed as if all done.
4091 max maximum number of subprocesses to leave running
4092 fallback TRUE if processing fallback hosts
4098 par_reduce(int max, BOOL fallback)
4100 while (parcount > max)
4102 address_item *doneaddr = par_wait();
4105 log_write(0, LOG_MAIN|LOG_PANIC,
4106 "remote delivery process count got out of step");
4111 transport_instance * tp = doneaddr->transport;
4112 if (tp->max_parallel)
4113 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4115 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4121 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4123 uschar pipe_header[PIPE_HEADER_SIZE+1];
4124 size_t total_len = PIPE_HEADER_SIZE + size;
4126 struct iovec iov[2] = {
4127 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4128 { buf, size } /* *the* data */
4133 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4134 /* complain to log if someone tries with buffer sizes we can't handle*/
4136 if (size > BIG_BUFFER_SIZE-1)
4138 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4139 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4141 size = BIG_BUFFER_SIZE;
4144 /* Should we check that we do not write more than PIPE_BUF? What would
4147 /* convert size to human readable string prepended by id and subid */
4148 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4149 id, subid, (long)size))
4150 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4152 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4153 id, subid, (long)size, pipe_header);
4155 if ((ret = writev(fd, iov, 2)) != total_len)
4156 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4157 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4158 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4161 /*************************************************
4162 * Do remote deliveries *
4163 *************************************************/
4165 /* This function is called to process the addresses in addr_remote. We must
4166 pick off the queue all addresses that have the same transport, remote
4167 destination, and errors address, and hand them to the transport in one go,
4168 subject to some configured limitations. If this is a run to continue delivering
4169 to an existing delivery channel, skip all but those addresses that can go to
4170 that channel. The skipped addresses just get deferred.
4172 If mua_wrapper is set, all addresses must be able to be sent in a single
4173 transaction. If not, this function yields FALSE.
4175 In Exim 4, remote deliveries are always done in separate processes, even
4176 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4177 is so that the base process can retain privilege. This makes the
4178 implementation of fallback transports feasible (though not initially done.)
4180 We create up to the configured number of subprocesses, each of which passes
4181 back the delivery state via a pipe. (However, when sending down an existing
4182 connection, remote_max_parallel is forced to 1.)
4185 fallback TRUE if processing fallback hosts
4187 Returns: TRUE normally
4188 FALSE if mua_wrapper is set and the addresses cannot all be sent
4193 do_remote_deliveries(BOOL fallback)
4198 parcount = 0; /* Number of executing subprocesses */
4200 /* When sending down an existing channel, only do one delivery at a time.
4201 We use a local variable (parmax) to hold the maximum number of processes;
4202 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4204 if (continue_transport) remote_max_parallel = 1;
4205 parmax = remote_max_parallel;
4207 /* If the data for keeping a list of processes hasn't yet been
4212 parlist = store_get(remote_max_parallel * sizeof(pardata), FALSE);
4213 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4214 parlist[poffset].pid = 0;
4217 /* Now loop for each remote delivery */
4219 for (int delivery_count = 0; addr_remote; delivery_count++)
4225 int address_count = 1;
4226 int address_count_max;
4228 BOOL use_initgroups;
4229 BOOL pipe_done = FALSE;
4230 transport_instance *tp;
4231 address_item **anchor = &addr_remote;
4232 address_item *addr = addr_remote;
4233 address_item *last = addr;
4236 uschar * serialize_key = NULL;
4238 /* Pull the first address right off the list. */
4240 addr_remote = addr->next;
4243 DEBUG(D_deliver|D_transport)
4244 debug_printf("--------> %s <--------\n", addr->address);
4246 /* If no transport has been set, there has been a big screw-up somewhere. */
4248 if (!(tp = addr->transport))
4250 f.disable_logging = FALSE; /* Jic */
4251 panicmsg = US"No transport set by router";
4252 goto panic_continue;
4255 /* Check that this base address hasn't previously been delivered to this
4256 transport. The check is necessary at this point to handle homonymic addresses
4257 correctly in cases where the pattern of redirection changes between delivery
4258 attempts. Non-homonymic previous delivery is detected earlier, at routing
4261 if (previously_transported(addr, FALSE)) continue;
4263 /* Force failure if the message is too big. */
4265 if (tp->message_size_limit)
4267 int rc = check_message_size(tp, addr);
4270 addr->transport_return = rc;
4271 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4276 /* Get the flag which specifies whether the transport can handle different
4277 domains that nevertheless resolve to the same set of hosts. If it needs
4278 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4279 $host, $host_address, $host_port. */
4280 if (tp->expand_multi_domain)
4281 deliver_set_expansions(addr);
4283 if (exp_bool(addr, US"transport", tp->name, D_transport,
4284 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4285 &multi_domain) != OK)
4287 deliver_set_expansions(NULL);
4288 panicmsg = addr->message;
4289 goto panic_continue;
4292 /* Get the maximum it can handle in one envelope, with zero meaning
4293 unlimited, which is forced for the MUA wrapper case. */
4295 address_count_max = tp->max_addresses;
4296 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4299 /************************************************************************/
4300 /***** This is slightly experimental code, but should be safe. *****/
4302 /* The address_count_max value is the maximum number of addresses that the
4303 transport can send in one envelope. However, the transport must be capable of
4304 dealing with any number of addresses. If the number it gets exceeds its
4305 envelope limitation, it must send multiple copies of the message. This can be
4306 done over a single connection for SMTP, so uses less resources than making
4307 multiple connections. On the other hand, if remote_max_parallel is greater
4308 than one, it is perhaps a good idea to use parallel processing to move the
4309 message faster, even if that results in multiple simultaneous connections to
4312 How can we come to some compromise between these two ideals? What we do is to
4313 limit the number of addresses passed to a single instance of a transport to
4314 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4315 number of addresses routed to remote transports divided by
4316 remote_max_parallel. For example, if the message has 100 remote recipients,
4317 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4318 once. But if rcpt_max is 100, we could send up to 100.
4320 Of course, not all the remotely addresses in a message are going to go to the
4321 same set of hosts (except in smarthost configurations), so this is just a
4322 heuristic way of dividing up the work.
4324 Furthermore (1), because this may not be wanted in some cases, and also to
4325 cope with really pathological cases, there is also a limit to the number of
4326 messages that are sent over one connection. This is the same limit that is
4327 used when sending several different messages over the same connection.
4328 Continue_sequence is set when in this situation, to the number sent so
4329 far, including this message.
4331 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4332 is probably because they are using VERP, in which case they want to pass only
4333 one address at a time to the transport, in order to be able to use
4334 $local_part and $domain in constructing a new return path. We could test for
4335 the use of these variables, but as it is so likely they will be used when the
4336 maximum is 1, we don't bother. Just leave the value alone. */
4338 if ( address_count_max != 1
4339 && address_count_max < remote_delivery_count/remote_max_parallel
4342 int new_max = remote_delivery_count/remote_max_parallel;
4343 int message_max = tp->connection_max_messages;
4344 if (connection_max_messages >= 0) message_max = connection_max_messages;
4345 message_max -= continue_sequence - 1;
4346 if (message_max > 0 && new_max > address_count_max * message_max)
4347 new_max = address_count_max * message_max;
4348 address_count_max = new_max;
4351 /************************************************************************/
4354 /* Pick off all addresses which have the same transport, errors address,
4355 destination, and extra headers. In some cases they point to the same host
4356 list, but we also need to check for identical host lists generated from
4357 entirely different domains. The host list pointers can be NULL in the case
4358 where the hosts are defined in the transport. There is also a configured
4359 maximum limit of addresses that can be handled at once (see comments above
4360 for how it is computed).
4361 If the transport does not handle multiple domains, enforce that also,
4362 and if it might need a per-address check for this, re-evaluate it.
4365 while ((next = *anchor) && address_count < address_count_max)
4368 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4369 && tp == next->transport
4370 && same_hosts(next->host_list, addr->host_list)
4371 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4372 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4373 && same_ugid(tp, next, addr)
4374 && ( next->prop.remove_headers == addr->prop.remove_headers
4375 || ( next->prop.remove_headers
4376 && addr->prop.remove_headers
4377 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4381 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4383 US"transport", next->transport->name, D_transport,
4384 US"multi_domain", next->transport->multi_domain,
4385 next->transport->expand_multi_domain, &md) == OK
4390 *anchor = next->next;
4392 next->first = addr; /* remember top one (for retry processing) */
4397 else anchor = &(next->next);
4398 deliver_set_expansions(NULL);
4401 /* If we are acting as an MUA wrapper, all addresses must go in a single
4402 transaction. If not, put them back on the chain and yield FALSE. */
4404 if (mua_wrapper && addr_remote)
4406 last->next = addr_remote;
4411 /* If the transport is limited for parallellism, enforce that here.
4412 The hints DB entry is decremented in par_reduce(), when we reap the
4413 transport process. */
4415 if (tpt_parallel_check(tp, addr, &serialize_key))
4416 if ((panicmsg = expand_string_message))
4417 goto panic_continue;
4419 continue; /* Loop for the next set of addresses. */
4421 /* Set up the expansion variables for this set of addresses */
4423 deliver_set_expansions(addr);
4425 /* Ensure any transport-set auth info is fresh */
4426 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4428 /* Compute the return path, expanding a new one if required. The old one
4429 must be set first, as it might be referred to in the expansion. */
4431 if(addr->prop.errors_address)
4432 return_path = addr->prop.errors_address;
4433 #ifdef EXPERIMENTAL_SRS
4434 else if(addr->prop.srs_sender)
4435 return_path = addr->prop.srs_sender;
4438 return_path = sender_address;
4440 if (tp->return_path)
4442 uschar *new_return_path = expand_string(tp->return_path);
4443 if (new_return_path)
4444 return_path = new_return_path;
4445 else if (!f.expand_string_forcedfail)
4447 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4448 tp->return_path, expand_string_message);
4453 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4454 logs and sets up error messages, so we just post-process and continue with
4455 the next address. */
4457 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4463 /* If this transport has a setup function, call it now so that it gets
4464 run in this process and not in any subprocess. That way, the results of
4465 any setup that are retained by the transport can be reusable. One of the
4466 things the setup does is to set the fallback host lists in the addresses.
4467 That is why it is called at this point, before the continue delivery
4468 processing, because that might use the fallback hosts. */
4471 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4473 /* If we have a connection still open from a verify stage (lazy-close)
4474 treat it as if it is a continued connection (apart from the counter used
4475 for the log line mark). */
4477 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4480 debug_printf("lazy-callout-close: have conn still open from verification\n");
4481 continue_transport = cutthrough.transport;
4482 continue_hostname = string_copy(cutthrough.host.name);
4483 continue_host_address = string_copy(cutthrough.host.address);
4484 continue_sequence = 1;
4485 sending_ip_address = cutthrough.snd_ip;
4486 sending_port = cutthrough.snd_port;
4487 smtp_peer_options = cutthrough.peer_options;
4490 /* If this is a run to continue delivery down an already-established
4491 channel, check that this set of addresses matches the transport and
4492 the channel. If it does not, defer the addresses. If a host list exists,
4493 we must check that the continue host is on the list. Otherwise, the
4494 host is set in the transport. */
4496 f.continue_more = FALSE; /* In case got set for the last lot */
4497 if (continue_transport)
4499 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4501 /* If the transport is about to override the host list do not check
4502 it here but take the cost of running the transport process to discover
4503 if the continued_hostname connection is suitable. This is a layering
4504 violation which is unfortunate as it requires we haul in the smtp
4509 smtp_transport_options_block * ob;
4511 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4512 && (ob = (smtp_transport_options_block *)tp->options_block)
4513 && ob->hosts_override && ob->hosts
4519 for (host_item * h = addr->host_list; h; h = h->next)
4520 if (Ustrcmp(h->name, continue_hostname) == 0)
4521 /*XXX should also check port here */
4522 { ok = TRUE; break; }
4526 /* Addresses not suitable; defer or queue for fallback hosts (which
4527 might be the continue host) and skip to next address. */
4531 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4532 Ustrcmp(continue_transport, tp->name) != 0
4533 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4534 : string_sprintf("no host matching %s", continue_hostname));
4535 if (serialize_key) enq_end(serialize_key);
4537 if (addr->fallback_hosts && !fallback)
4539 for (next = addr; ; next = next->next)
4541 next->host_list = next->fallback_hosts;
4542 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4543 if (!next->next) break;
4545 next->next = addr_fallback;
4546 addr_fallback = addr;
4551 for (next = addr; ; next = next->next)
4553 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4554 if (!next->next) break;
4556 next->next = addr_defer;
4563 /* Set a flag indicating whether there are further addresses that list
4564 the continued host. This tells the transport to leave the channel open,
4565 but not to pass it to another delivery process. We'd like to do that
4566 for non-continue_transport cases too but the knowlege of which host is
4567 connected to is too hard to manage. Perhaps we need a finer-grain
4568 interface to the transport. */
4570 for (next = addr_remote; next && !f.continue_more; next = next->next)
4571 for (host_item * h = next->host_list; h; h = h->next)
4572 if (Ustrcmp(h->name, continue_hostname) == 0)
4573 { f.continue_more = TRUE; break; }
4576 /* The transports set up the process info themselves as they may connect
4577 to more than one remote machine. They also have to set up the filter
4578 arguments, if required, so that the host name and address are available
4581 transport_filter_argv = NULL;
4583 /* Create the pipe for inter-process communication. If pipe creation
4584 fails, it is probably because the value of remote_max_parallel is so
4585 large that too many file descriptors for pipes have been created. Arrange
4586 to wait for a process to finish, and then try again. If we still can't
4587 create a pipe when all processes have finished, break the retry loop. */
4591 if (pipe(pfd) == 0) pipe_done = TRUE;
4592 else if (parcount > 0) parmax = parcount;
4595 /* We need to make the reading end of the pipe non-blocking. There are
4596 two different options for this. Exim is cunningly (I hope!) coded so
4597 that it can use either of them, though it prefers O_NONBLOCK, which
4598 distinguishes between EOF and no-more-data. */
4600 /* The data appears in a timely manner and we already did a select on
4601 all pipes, so I do not see a reason to use non-blocking IO here
4604 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4606 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4610 /* If the maximum number of subprocesses already exist, wait for a process
4611 to finish. If we ran out of file descriptors, parmax will have been reduced
4612 from its initial value of remote_max_parallel. */
4614 par_reduce(parmax - 1, fallback);
4617 /* If we failed to create a pipe and there were no processes to wait
4618 for, we have to give up on this one. Do this outside the above loop
4619 so that we can continue the main loop. */
4623 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4627 /* Find a free slot in the pardata list. Must do this after the possible
4628 waiting for processes to finish, because a terminating process will free
4631 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4632 if (parlist[poffset].pid == 0)
4635 /* If there isn't one, there has been a horrible disaster. */
4637 if (poffset >= remote_max_parallel)
4639 (void)close(pfd[pipe_write]);
4640 (void)close(pfd[pipe_read]);
4641 panicmsg = US"Unexpectedly no free subprocess slot";
4645 /* Now fork a subprocess to do the remote delivery, but before doing so,
4646 ensure that any cached resources are released so as not to interfere with
4647 what happens in the subprocess. */
4651 if ((pid = exim_fork(US"transport")) == 0)
4653 int fd = pfd[pipe_write];
4656 /* Setting this global in the subprocess means we need never clear it */
4657 transport_name = tp->name;
4659 /* There are weird circumstances in which logging is disabled */
4660 f.disable_logging = tp->disable_logging;
4662 /* Show pids on debug output if parallelism possible */
4664 if (parmax > 1 && (parcount > 0 || addr_remote))
4665 DEBUG(D_any|D_v) debug_selector |= D_pid;
4667 /* Reset the random number generator, so different processes don't all
4668 have the same sequence. In the test harness we want different, but
4669 predictable settings for each delivery process, so do something explicit
4670 here rather they rely on the fixed reset in the random number function. */
4672 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4674 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4675 a new process that may be forked to do another delivery down the same
4678 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4680 /* Close open file descriptors for the pipes of other processes
4681 that are running in parallel. */
4683 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4684 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4686 /* This process has inherited a copy of the file descriptor
4687 for the data file, but its file pointer is shared with all the
4688 other processes running in parallel. Therefore, we have to re-open
4689 the file in order to get a new file descriptor with its own
4690 file pointer. We don't need to lock it, as the lock is held by
4691 the parent process. There doesn't seem to be any way of doing
4692 a dup-with-new-file-pointer. */
4694 (void)close(deliver_datafile);
4696 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4698 if ((deliver_datafile = Uopen(fname,
4702 O_RDWR | O_APPEND, 0)) < 0)
4703 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4704 "parallel delivery: %s", fname, strerror(errno));
4707 /* Set the close-on-exec flag */
4709 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4713 /* Set the uid/gid of this process; bombs out on failure. */
4715 exim_setugid(uid, gid, use_initgroups,
4716 string_sprintf("remote delivery to %s with transport=%s",
4717 addr->address, tp->name));
4719 /* Close the unwanted half of this process' pipe, set the process state,
4720 and run the transport. Afterwards, transport_count will contain the number
4721 of bytes written. */
4723 (void)close(pfd[pipe_read]);
4724 set_process_info("delivering %s using %s", message_id, tp->name);
4725 debug_print_string(tp->debug_string);
4726 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4728 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4729 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4731 /* Ensure any cached resources that we used are now released */
4735 /* Pass the result back down the pipe. This is a lot more information
4736 than is needed for a local delivery. We have to send back the error
4737 status for each address, the usability status for each host that is
4738 flagged as unusable, and all the retry items. When TLS is in use, we
4739 send also the cipher and peerdn information. Each type of information
4740 is flagged by an identifying byte, and is then in a fixed format (with
4741 strings terminated by zeros), and there is a final terminator at the
4742 end. The host information and retry information is all attached to
4743 the first address, so that gets sent at the start. */
4745 /* Host unusability information: for most success cases this will
4748 for (h = addr->host_list; h; h = h->next)
4750 if (!h->address || h->status < hstatus_unusable) continue;
4751 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4752 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4755 /* The number of bytes written. This is the same for each address. Even
4756 if we sent several copies of the message down the same connection, the
4757 size of each one is the same, and it's that value we have got because
4758 transport_count gets reset before calling transport_write_message(). */
4760 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4761 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4763 /* Information about what happened to each address. Four item types are
4764 used: an optional 'X' item first, for TLS information, then an optional "C"
4765 item for any client-auth info followed by 'R' items for any retry settings,
4766 and finally an 'A' item for the remaining data. */
4768 for(; addr; addr = addr->next)
4772 /* The certificate verification status goes into the flags */
4773 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4775 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4777 # ifdef EXPERIMENTAL_TLS_RESUME
4778 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4781 /* Use an X item only if there's something to send */
4785 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4789 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4791 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4793 else if (continue_proxy_cipher)
4795 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4797 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4803 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4807 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4812 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4816 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4818 # ifndef DISABLE_OCSP
4819 if (addr->ocsp > OCSP_NOT_REQ)
4821 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4822 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4825 #endif /*DISABLE_TLS*/
4827 if (client_authenticator)
4829 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4830 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4832 if (client_authenticated_id)
4834 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4835 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4837 if (client_authenticated_sender)
4839 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4840 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4843 #ifndef DISABLE_PRDR
4844 if (testflag(addr, af_prdr_used))
4845 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4848 if (testflag(addr, af_pipelining))
4849 #ifndef DISABLE_PIPE_CONNECT
4850 if (testflag(addr, af_early_pipe))
4851 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4854 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4856 if (testflag(addr, af_chunking_used))
4857 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4859 if (testflag(addr, af_tcp_fastopen_conn))
4860 rmt_dlv_checked_write(fd, 'T',
4861 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4865 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4866 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4868 /* Retry information: for most success cases this will be null. */
4870 for (retry_item * r = addr->retries; r; r = r->next)
4872 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4873 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4874 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4875 ptr += sizeof(r->basic_errno);
4876 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4877 ptr += sizeof(r->more_errno);
4878 if (!r->message) *ptr++ = 0; else
4880 sprintf(CS ptr, "%.512s", r->message);
4883 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4886 #ifdef SUPPORT_SOCKS
4887 if (LOGGING(proxy) && proxy_session)
4890 if (proxy_local_address)
4892 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4893 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4894 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4895 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4896 ptr += sizeof(proxy_local_port);
4900 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4904 #ifdef EXPERIMENTAL_DSN_INFO
4905 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4906 if (addr->smtp_greeting)
4908 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4909 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4910 if (addr->helo_response)
4912 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4913 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4917 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4921 /* The rest of the information goes in an 'A0' item. */
4923 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4924 ptr = big_buffer + 2;
4925 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4926 ptr += sizeof(addr->basic_errno);
4927 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4928 ptr += sizeof(addr->more_errno);
4929 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4930 ptr += sizeof(addr->delivery_time);
4931 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4932 ptr += sizeof(addr->flags);
4934 if (!addr->message) *ptr++ = 0; else
4935 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4937 if (!addr->user_message) *ptr++ = 0; else
4938 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4940 if (!addr->host_used) *ptr++ = 0; else
4942 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4943 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4944 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4945 ptr += sizeof(addr->host_used->port);
4947 /* DNS lookup status */
4948 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4949 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4952 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4955 /* Local interface address/port */
4956 #ifdef EXPERIMENTAL_DSN_INFO
4957 if (sending_ip_address)
4959 if (LOGGING(incoming_interface) && sending_ip_address)
4963 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4964 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4965 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4968 /* Add termination flag, close the pipe, and that's it. The character
4969 after 'Z' indicates whether continue_transport is now NULL or not.
4970 A change from non-NULL to NULL indicates a problem with a continuing
4973 big_buffer[0] = continue_transport ? '1' : '0';
4974 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4979 /* Back in the mainline: close the unwanted half of the pipe. */
4981 (void)close(pfd[pipe_write]);
4983 /* If we have a connection still open from a verify stage (lazy-close)
4984 release its TLS library context (if any) as responsibility was passed to
4985 the delivery child process. */
4987 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4990 if (cutthrough.is_tls)
4991 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
4993 (void) close(cutthrough.cctx.sock);
4994 release_cutthrough_connection(US"passed to transport proc");
4997 /* Fork failed; defer with error message */
5001 (void)close(pfd[pipe_read]);
5002 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5003 addr->domain, strerror(errno));
5007 /* Fork succeeded; increment the count, and remember relevant data for
5008 when the process finishes. */
5011 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5012 parlist[poffset].pid = pid;
5013 parlist[poffset].fd = pfd[pipe_read];
5014 parlist[poffset].done = FALSE;
5015 parlist[poffset].msg = NULL;
5016 parlist[poffset].return_path = return_path;
5018 /* If the process we've just started is sending a message down an existing
5019 channel, wait for it now. This ensures that only one such process runs at
5020 once, whatever the value of remote_max parallel. Otherwise, we might try to
5021 send two or more messages simultaneously down the same channel. This could
5022 happen if there are different domains that include the same host in otherwise
5023 different host lists.
5025 Also, if the transport closes down the channel, this information gets back
5026 (continue_transport gets set to NULL) before we consider any other addresses
5029 if (continue_transport) par_reduce(0, fallback);
5031 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5032 newly created process get going before we create another process. This should
5033 ensure repeatability in the tests. Wait long enough for most cases to complete
5036 else testharness_pause_ms(600);
5041 if (serialize_key) enq_end(serialize_key);
5043 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5047 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5048 are still running and post-process their addresses. */
5050 par_reduce(0, fallback);
5057 /*************************************************
5058 * Split an address into local part and domain *
5059 *************************************************/
5061 /* This function initializes an address for routing by splitting it up into a
5062 local part and a domain. The local part is set up twice - once in its original
5063 casing, and once in lower case, and it is dequoted. We also do the "percent
5064 hack" for configured domains. This may lead to a DEFER result if a lookup
5065 defers. When a percent-hacking takes place, we insert a copy of the original
5066 address as a new parent of this address, as if we have had a redirection.
5069 addr points to an addr_item block containing the address
5072 DEFER - could not determine if domain is %-hackable
5076 deliver_split_address(address_item * addr)
5078 uschar * address = addr->address;
5083 if (!(domain = Ustrrchr(address, '@')))
5084 return DEFER; /* should always have a domain, but just in case... */
5086 len = domain - address;
5087 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5089 /* The implication in the RFCs (though I can't say I've seen it spelled out
5090 explicitly) is that quoting should be removed from local parts at the point
5091 where they are locally interpreted. [The new draft "821" is more explicit on
5092 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5093 removing quoting backslashes and any unquoted doublequotes. */
5095 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5099 if (c == '\"') continue;
5109 /* We do the percent hack only for those domains that are listed in
5110 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5112 if (percent_hack_domains)
5115 uschar *new_address = NULL;
5116 uschar *local_part = addr->cc_local_part;
5118 deliver_domain = addr->domain; /* set $domain */
5120 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5121 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5123 && (t = Ustrrchr(local_part, '%')) != NULL
5126 new_address = string_copy(local_part);
5127 new_address[t - local_part] = '@';
5128 deliver_domain = string_copylc(t+1);
5129 local_part = string_copyn(local_part, t - local_part);
5132 if (rc == DEFER) return DEFER; /* lookup deferred */
5134 /* If hackery happened, set up new parent and alter the current address. */
5138 address_item *new_parent = store_get(sizeof(address_item), FALSE);
5139 *new_parent = *addr;
5140 addr->parent = new_parent;
5141 new_parent->child_count = 1;
5142 addr->address = new_address;
5143 addr->unique = string_copy(new_address);
5144 addr->domain = deliver_domain;
5145 addr->cc_local_part = local_part;
5146 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5151 /* Create the lowercased version of the final local part, and make that the
5152 default one to be used. */
5154 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5161 /*************************************************
5162 * Get next error message text *
5163 *************************************************/
5165 /* If f is not NULL, read the next "paragraph", from a customized error message
5166 text file, terminated by a line containing ****, and expand it.
5169 f NULL or a file to read from
5170 which string indicating which string (for errors)
5172 Returns: NULL or an expanded string
5176 next_emf(FILE *f, uschar *which)
5182 if (!f) return NULL;
5184 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5187 para = string_get(256);
5190 para = string_cat(para, buffer);
5191 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5194 if ((yield = expand_string(string_from_gstring(para))))
5197 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5198 "bounce_message_file or warn_message_file (%s): %s", which,
5199 expand_string_message);
5206 /*************************************************
5207 * Close down a passed transport channel *
5208 *************************************************/
5210 /* This function is called when a passed transport channel cannot be used.
5211 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5212 so that the function call can be the argument of a "return" statement.
5215 Returns: DELIVER_NOT_ATTEMPTED
5219 continue_closedown(void)
5221 if (continue_transport)
5222 for (transport_instance * t = transports; t; t = t->next)
5223 if (Ustrcmp(t->name, continue_transport) == 0)
5225 if (t->info->closedown) (t->info->closedown)(t);
5228 return DELIVER_NOT_ATTEMPTED;
5234 /*************************************************
5235 * Print address information *
5236 *************************************************/
5238 /* This function is called to output an address, or information about an
5239 address, for bounce or defer messages. If the hide_child flag is set, all we
5240 output is the original ancestor address.
5243 addr points to the address
5244 f the FILE to print to
5245 si an initial string
5246 sc a continuation string for before "generated"
5249 Returns: TRUE if the address is not hidden
5253 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5257 uschar *printed = US"";
5258 address_item *ancestor = addr;
5259 while (ancestor->parent) ancestor = ancestor->parent;
5261 fprintf(f, "%s", CS si);
5263 if (addr->parent && testflag(addr, af_hide_child))
5265 printed = US"an undisclosed address";
5268 else if (!testflag(addr, af_pfr) || !addr->parent)
5269 printed = addr->address;
5273 uschar *s = addr->address;
5276 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5277 else if (addr->address[0] == '|') ss = US"pipe";
5280 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5281 printed = addr->parent->address;
5284 fprintf(f, "%s", CS string_printing(printed));
5286 if (ancestor != addr)
5288 uschar *original = ancestor->onetime_parent;
5289 if (!original) original= ancestor->address;
5290 if (strcmpic(original, printed) != 0)
5291 fprintf(f, "%s(%sgenerated from %s)", sc,
5292 ancestor != addr->parent ? "ultimately " : "",
5293 string_printing(original));
5296 if (addr->host_used)
5297 fprintf(f, "\n host %s [%s]",
5298 addr->host_used->name, addr->host_used->address);
5300 fprintf(f, "%s", CS se);
5308 /*************************************************
5309 * Print error for an address *
5310 *************************************************/
5312 /* This function is called to print the error information out of an address for
5313 a bounce or a warning message. It tries to format the message reasonably by
5314 introducing newlines. All lines are indented by 4; the initial printing
5315 position must be set before calling.
5317 This function used always to print the error. Nowadays we want to restrict it
5318 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5319 and filter "fail". We no longer pass other information willy-nilly in bounce
5320 and warning messages. Text in user_message is always output; text in message
5321 only if the af_pass_message flag is set.
5325 f the FILE to print on
5332 print_address_error(address_item *addr, FILE *f, uschar *t)
5334 int count = Ustrlen(t);
5335 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5337 if (!s && !(s = addr->user_message))
5340 fprintf(f, "\n %s", t);
5343 if (*s == '\\' && s[1] == 'n')
5353 if (*s++ == ':' && isspace(*s) && count > 45)
5355 fprintf(f, "\n "); /* sic (because space follows) */
5362 /***********************************************************
5363 * Print Diagnostic-Code for an address *
5364 ************************************************************/
5366 /* This function is called to print the error information out of an address for
5367 a bounce or a warning message. It tries to format the message reasonably as
5368 required by RFC 3461 by adding a space after each newline
5370 it uses the same logic as print_address_error() above. if af_pass_message is true
5371 and addr->message is set it uses the remote host answer. if not addr->user_message
5372 is used instead if available.
5376 f the FILE to print on
5382 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5384 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5386 /* af_pass_message and addr->message set ? print remote host answer */
5390 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5392 /* search first ": ". we assume to find the remote-MTA answer there */
5393 if (!(s = Ustrstr(addr->message, ": ")))
5394 return; /* not found, bail out */
5395 s += 2; /* skip ": " */
5396 fprintf(f, "Diagnostic-Code: smtp; ");
5398 /* no message available. do nothing */
5402 if (*s == '\\' && s[1] == 'n')
5404 fputs("\n ", f); /* as defined in RFC 3461 */
5414 /*************************************************
5415 * Check list of addresses for duplication *
5416 *************************************************/
5418 /* This function was introduced when the test for duplicate addresses that are
5419 not pipes, files, or autoreplies was moved from the middle of routing to when
5420 routing was complete. That was to fix obscure cases when the routing history
5421 affects the subsequent routing of identical addresses. This function is called
5422 after routing, to check that the final routed addresses are not duplicates.
5424 If we detect a duplicate, we remember what it is a duplicate of. Note that
5425 pipe, file, and autoreply de-duplication is handled during routing, so we must
5426 leave such "addresses" alone here, as otherwise they will incorrectly be
5429 Argument: address of list anchor
5434 do_duplicate_check(address_item **anchor)
5437 while ((addr = *anchor))
5440 if (testflag(addr, af_pfr))
5442 anchor = &(addr->next);
5444 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5446 DEBUG(D_deliver|D_route)
5447 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5448 *anchor = addr->next;
5449 addr->dupof = tnode->data.ptr;
5450 addr->next = addr_duplicate;
5451 addr_duplicate = addr;
5455 tree_add_duplicate(addr->unique, addr);
5456 anchor = &(addr->next);
5464 /************************************************/
5467 print_dsn_addr_action(FILE * f, address_item * addr,
5468 uschar * action, uschar * status)
5472 if (addr->dsn_orcpt)
5473 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5475 for (pa = addr; pa->parent; ) pa = pa->parent;
5476 fprintf(f, "Action: %s\n"
5477 "Final-Recipient: rfc822;%s\n"
5479 action, pa->address, status);
5484 /* When running in the test harness, there's an option that allows us to
5485 fudge this time so as to get repeatability of the tests. Take the first
5486 time off the list. In queue runs, the list pointer gets updated in the
5490 test_harness_fudged_queue_time(int actual_time)
5493 if ( f.running_in_test_harness && *fudged_queue_times
5494 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5496 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5497 fudged_queue_times);
5503 /************************************************/
5506 expand_open(const uschar * filename,
5507 const uschar * varname, const uschar * reason)
5509 const uschar * s = expand_cstring(filename);
5513 log_write(0, LOG_MAIN|LOG_PANIC,
5514 "Failed to expand %s: '%s'\n", varname, filename);
5515 else if (*s != '/' || is_tainted(s))
5516 log_write(0, LOG_MAIN|LOG_PANIC,
5517 "%s is not %s after expansion: '%s'\n",
5518 varname, *s == '/' ? "untainted" : "absolute", s);
5519 else if (!(fp = Ufopen(s, "rb")))
5520 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5521 "message texts: %s", s, reason, strerror(errno));
5525 /*************************************************
5526 * Deliver one message *
5527 *************************************************/
5529 /* This is the function which is called when a message is to be delivered. It
5530 is passed the id of the message. It is possible that the message no longer
5531 exists, if some other process has delivered it, and it is also possible that
5532 the message is being worked on by another process, in which case the data file
5535 If no delivery is attempted for any of the above reasons, the function returns
5536 DELIVER_NOT_ATTEMPTED.
5538 If the give_up flag is set true, do not attempt any deliveries, but instead
5539 fail all outstanding addresses and return the message to the sender (or
5542 A delivery operation has a process all to itself; we never deliver more than
5543 one message in the same process. Therefore we needn't worry too much about
5546 Liable to be called as root.
5549 id the id of the message to be delivered
5550 forced TRUE if delivery was forced by an administrator; this overrides
5551 retry delays and causes a delivery to be tried regardless
5552 give_up TRUE if an administrator has requested that delivery attempts
5555 Returns: When the global variable mua_wrapper is FALSE:
5556 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5557 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5558 When the global variable mua_wrapper is TRUE:
5559 DELIVER_MUA_SUCCEEDED if delivery succeeded
5560 DELIVER_MUA_FAILED if delivery failed
5561 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5565 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5568 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5569 time_t now = time(NULL);
5570 address_item *addr_last = NULL;
5571 uschar *filter_message = NULL;
5572 int process_recipients = RECIP_ACCEPT;
5575 extern int acl_where;
5578 #ifdef MEASURE_TIMING
5579 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
5582 info = queue_run_pid == (pid_t)0
5583 ? string_sprintf("delivering %s", id)
5584 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5586 /* If the D_process_info bit is on, set_process_info() will output debugging
5587 information. If not, we want to show this initial information if D_deliver or
5588 D_queue_run is set or in verbose mode. */
5590 set_process_info("%s", info);
5592 if ( !(debug_selector & D_process_info)
5593 && (debug_selector & (D_deliver|D_queue_run|D_v))
5595 debug_printf("%s\n", info);
5597 /* Ensure that we catch any subprocesses that are created. Although Exim
5598 sets SIG_DFL as its initial default, some routes through the code end up
5599 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5600 has been forked, but no re-exec has been done. We use sigaction rather than
5601 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5602 sure it is turned off. (There was a problem on AIX with this.) */
5606 struct sigaction act;
5607 act.sa_handler = SIG_DFL;
5608 sigemptyset(&(act.sa_mask));
5610 sigaction(SIGCHLD, &act, NULL);
5613 signal(SIGCHLD, SIG_DFL);
5616 /* Make the forcing flag available for routers and transports, set up the
5617 global message id field, and initialize the count for returned files and the
5618 message size. This use of strcpy() is OK because the length id is checked when
5619 it is obtained from a command line (the -M or -q options), and otherwise it is
5620 known to be a valid message id. */
5622 if (id != message_id)
5623 Ustrcpy(message_id, id);
5624 f.deliver_force = forced;
5628 /* Initialize some flags */
5630 update_spool = FALSE;
5631 remove_journal = TRUE;
5633 /* Set a known context for any ACLs we call via expansions */
5634 acl_where = ACL_WHERE_DELIVERY;
5636 /* Reset the random number generator, so that if several delivery processes are
5637 started from a queue runner that has already used random numbers (for sorting),
5638 they don't all get the same sequence. */
5642 /* Open and lock the message's data file. Exim locks on this one because the
5643 header file may get replaced as it is re-written during the delivery process.
5644 Any failures cause messages to be written to the log, except for missing files
5645 while queue running - another process probably completed delivery. As part of
5646 opening the data file, message_subdir gets set. */
5648 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5649 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5651 /* The value of message_size at this point has been set to the data length,
5652 plus one for the blank line that notionally precedes the data. */
5654 /* Now read the contents of the header file, which will set up the headers in
5655 store, and also the list of recipients and the tree of non-recipients and
5656 assorted flags. It updates message_size. If there is a reading or format error,
5657 give up; if the message has been around for sufficiently long, remove it. */
5660 uschar * spoolname = string_sprintf("%s-H", id);
5661 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5663 if (errno == ERRNO_SPOOLFORMAT)
5665 struct stat statbuf;
5666 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5668 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5669 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5671 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5674 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5677 /* If we managed to read the envelope data, received_time contains the
5678 time the message was received. Otherwise, we can calculate it from the
5681 if (rc != spool_read_hdrerror)
5683 received_time.tv_sec = received_time.tv_usec = 0;
5684 /*XXX subsec precision?*/
5685 for (i = 0; i < 6; i++)
5686 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5689 /* If we've had this malformed message too long, sling it. */
5691 if (now - received_time.tv_sec > keep_malformed)
5693 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5694 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5695 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5696 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5697 log_write(0, LOG_MAIN, "Message removed because older than %s",
5698 readconf_printtime(keep_malformed));
5701 (void)close(deliver_datafile);
5702 deliver_datafile = -1;
5703 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5707 /* The spool header file has been read. Look to see if there is an existing
5708 journal file for this message. If there is, it means that a previous delivery
5709 attempt crashed (program or host) before it could update the spool header file.
5710 Read the list of delivered addresses from the journal and add them to the
5711 nonrecipients tree. Then update the spool file. We can leave the journal in
5712 existence, as it will get further successful deliveries added to it in this
5713 run, and it will be deleted if this function gets to its end successfully.
5714 Otherwise it might be needed again. */
5717 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5720 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5728 && lseek(journal_fd, 0, SEEK_SET) == 0
5729 && (jread = fdopen(journal_fd, "rb"))
5732 while (Ufgets(big_buffer, big_buffer_size, jread))
5734 int n = Ustrlen(big_buffer);
5735 big_buffer[n-1] = 0;
5736 tree_add_nonrecipient(big_buffer);
5737 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5738 "journal file\n", big_buffer);
5741 if ((journal_fd = dup(fileno(jread))) < 0)
5742 journal_fd = fileno(jread);
5744 (void) fclose(jread); /* Try to not leak the FILE resource */
5746 /* Panic-dies on error */
5747 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5749 else if (errno != ENOENT)
5751 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5752 "%s", strerror(errno));
5753 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5756 /* A null recipients list indicates some kind of disaster. */
5758 if (!recipients_list)
5760 (void)close(deliver_datafile);
5761 deliver_datafile = -1;
5762 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5763 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5768 /* Handle a message that is frozen. There are a number of different things that
5769 can happen, but in the default situation, unless forced, no delivery is
5772 if (f.deliver_freeze)
5774 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5775 /* Moving to another directory removes the message from Exim's view. Other
5776 tools must be used to deal with it. Logging of this action happens in
5777 spool_move_message() and its subfunctions. */
5779 if ( move_frozen_messages
5780 && spool_move_message(id, message_subdir, US"", US"F")
5782 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5785 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5786 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5787 flag causing all recipients to be failed. The time is the age of the
5788 message, not the time since freezing. */
5790 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5792 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5793 process_recipients = RECIP_FAIL_TIMEOUT;
5796 /* For bounce messages (and others with no sender), thaw if the error message
5797 ignore timer is exceeded. The message will be discarded if this delivery
5800 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5801 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5803 /* If this is a bounce message, or there's no auto thaw, or we haven't
5804 reached the auto thaw time yet, and this delivery is not forced by an admin
5805 user, do not attempt delivery of this message. Note that forced is set for
5806 continuing messages down the same channel, in order to skip load checking and
5807 ignore hold domains, but we don't want unfreezing in that case. */
5811 if ( ( sender_address[0] == 0
5813 || now <= deliver_frozen_at + auto_thaw
5815 && ( !forced || !f.deliver_force_thaw
5816 || !f.admin_user || continue_hostname
5819 (void)close(deliver_datafile);
5820 deliver_datafile = -1;
5821 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5822 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5825 /* If delivery was forced (by an admin user), assume a manual thaw.
5826 Otherwise it's an auto thaw. */
5830 f.deliver_manual_thaw = TRUE;
5831 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5833 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5836 /* We get here if any of the rules for unfreezing have triggered. */
5838 f.deliver_freeze = FALSE;
5839 update_spool = TRUE;
5843 /* Open the message log file if we are using them. This records details of
5844 deliveries, deferments, and failures for the benefit of the mail administrator.
5845 The log is not used by exim itself to track the progress of a message; that is
5846 done by rewriting the header spool file. */
5850 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5854 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5856 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5857 fname, strerror(errno));
5858 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5861 /* Make a C stream out of it. */
5863 if (!(message_log = fdopen(fd, "a")))
5865 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5866 fname, strerror(errno));
5867 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5872 /* If asked to give up on a message, log who did it, and set the action for all
5877 struct passwd *pw = getpwuid(real_uid);
5878 log_write(0, LOG_MAIN, "cancelled by %s",
5879 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5880 process_recipients = RECIP_FAIL;
5883 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5885 else if (received_count > received_headers_max)
5886 process_recipients = RECIP_FAIL_LOOP;
5888 /* Otherwise, if a system-wide, address-independent message filter is
5889 specified, run it now, except in the case when we are failing all recipients as
5890 a result of timeout_frozen_after. If the system filter yields "delivered", then
5891 ignore the true recipients of the message. Failure of the filter file is
5892 logged, and the delivery attempt fails. */
5894 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5899 redirect_block redirect;
5901 if (system_filter_uid_set)
5903 ugid.uid = system_filter_uid;
5904 ugid.gid = system_filter_gid;
5905 ugid.uid_set = ugid.gid_set = TRUE;
5908 ugid.uid_set = ugid.gid_set = FALSE;
5910 return_path = sender_address;
5911 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5912 f.system_filtering = TRUE;
5914 /* Any error in the filter file causes a delivery to be abandoned. */
5916 redirect.string = system_filter;
5917 redirect.isfile = TRUE;
5918 redirect.check_owner = redirect.check_group = FALSE;
5919 redirect.owners = NULL;
5920 redirect.owngroups = NULL;
5922 redirect.modemask = 0;
5924 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5927 &redirect, /* Where the data is */
5928 RDO_DEFER | /* Turn on all the enabling options */
5929 RDO_FAIL | /* Leave off all the disabling options */
5934 NULL, /* No :include: restriction (not used in filter) */
5935 NULL, /* No sieve vacation directory (not sieve!) */
5936 NULL, /* No sieve enotify mailto owner (not sieve!) */
5937 NULL, /* No sieve user address (not sieve!) */
5938 NULL, /* No sieve subaddress (not sieve!) */
5939 &ugid, /* uid/gid data */
5940 &addr_new, /* Where to hang generated addresses */
5941 &filter_message, /* Where to put error message */
5942 NULL, /* Don't skip syntax errors */
5943 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5944 US"system filter"); /* For error messages */
5946 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5948 if (rc == FF_ERROR || rc == FF_NONEXIST)
5950 (void)close(deliver_datafile);
5951 deliver_datafile = -1;
5952 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5953 string_printing(filter_message));
5954 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5957 /* Reset things. If the filter message is an empty string, which can happen
5958 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5960 f.system_filtering = FALSE;
5961 f.enable_dollar_recipients = FALSE;
5962 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5964 /* Save the values of the system filter variables so that user filters
5967 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5969 /* The filter can request that delivery of the original addresses be
5974 process_recipients = RECIP_DEFER;
5975 deliver_msglog("Delivery deferred by system filter\n");
5976 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5979 /* The filter can request that a message be frozen, but this does not
5980 take place if the message has been manually thawed. In that case, we must
5981 unset "delivered", which is forced by the "freeze" command to make -bF
5984 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5986 f.deliver_freeze = TRUE;
5987 deliver_frozen_at = time(NULL);
5988 process_recipients = RECIP_DEFER;
5989 frozen_info = string_sprintf(" by the system filter%s%s",
5990 filter_message ? US": " : US"",
5991 filter_message ? filter_message : US"");
5994 /* The filter can request that a message be failed. The error message may be
5995 quite long - it is sent back to the sender in the bounce - but we don't want
5996 to fill up the log with repetitions of it. If it starts with << then the text
5997 between << and >> is written to the log, with the rest left for the bounce
6000 else if (rc == FF_FAIL)
6002 uschar *colon = US"";
6003 uschar *logmsg = US"";
6006 process_recipients = RECIP_FAIL_FILTER;
6012 if ( filter_message[0] == '<'
6013 && filter_message[1] == '<'
6014 && (logend = Ustrstr(filter_message, ">>"))
6017 logmsg = filter_message + 2;
6018 loglen = logend - logmsg;
6019 filter_message = logend + 2;
6020 if (filter_message[0] == 0) filter_message = NULL;
6024 logmsg = filter_message;
6025 loglen = Ustrlen(filter_message);
6029 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6033 /* Delivery can be restricted only to those recipients (if any) that the
6034 filter specified. */
6036 else if (rc == FF_DELIVERED)
6038 process_recipients = RECIP_IGNORE;
6040 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6042 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6045 /* If any new addresses were created by the filter, fake up a "parent"
6046 for them. This is necessary for pipes, etc., which are expected to have
6047 parents, and it also gives some sensible logging for others. Allow
6048 pipes, files, and autoreplies, and run them as the filter uid if set,
6049 otherwise as the current uid. */
6053 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6054 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6056 /* The text "system-filter" is tested in transport_set_up_command() and in
6057 set_up_shell_command() in the pipe transport, to enable them to permit
6058 $recipients, so don't change it here without also changing it there. */
6060 address_item *p = addr_new;
6061 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6063 parent->domain = string_copylc(qualify_domain_recipient);
6064 parent->local_part = US"system-filter";
6066 /* As part of this loop, we arrange for addr_last to end up pointing
6067 at the final address. This is used if we go on to add addresses for the
6068 original recipients. */
6072 if (parent->child_count == USHRT_MAX)
6073 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6074 "than %d delivery addresses", USHRT_MAX);
6075 parent->child_count++;
6078 if (testflag(p, af_pfr))
6084 setflag(p, af_uid_set);
6085 setflag(p, af_gid_set);
6086 setflag(p, af_allow_file);
6087 setflag(p, af_allow_pipe);
6088 setflag(p, af_allow_reply);
6090 /* Find the name of the system filter's appropriate pfr transport */
6092 if (p->address[0] == '|')
6095 tpname = system_filter_pipe_transport;
6096 address_pipe = p->address;
6098 else if (p->address[0] == '>')
6101 tpname = system_filter_reply_transport;
6105 if (p->address[Ustrlen(p->address)-1] == '/')
6107 type = US"directory";
6108 tpname = system_filter_directory_transport;
6113 tpname = system_filter_file_transport;
6115 address_file = p->address;
6118 /* Now find the actual transport, first expanding the name. We have
6119 set address_file or address_pipe above. */
6123 uschar *tmp = expand_string(tpname);
6124 address_file = address_pipe = NULL;
6126 p->message = string_sprintf("failed to expand \"%s\" as a "
6127 "system filter transport name", tpname);
6128 if (is_tainted(tmp))
6129 p->message = string_sprintf("attempt to used tainted value '%s' for"
6130 "transport '%s' as a system filter", tmp, tpname);
6134 p->message = string_sprintf("system_filter_%s_transport is unset",
6139 transport_instance *tp;
6140 for (tp = transports; tp; tp = tp->next)
6141 if (Ustrcmp(tp->name, tpname) == 0)
6147 p->message = string_sprintf("failed to find \"%s\" transport "
6148 "for system filter delivery", tpname);
6151 /* If we couldn't set up a transport, defer the delivery, putting the
6152 error on the panic log as well as the main log. */
6156 address_item *badp = p;
6158 if (!addr_last) addr_new = p; else addr_last->next = p;
6159 badp->local_part = badp->address; /* Needed for log line */
6160 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6163 } /* End of pfr handling */
6165 /* Either a non-pfr delivery, or we found a transport */
6167 DEBUG(D_deliver|D_filter)
6168 debug_printf("system filter added %s\n", p->address);
6172 } /* Loop through all addr_new addresses */
6177 /* Scan the recipients list, and for every one that is not in the non-
6178 recipients tree, add an addr item to the chain of new addresses. If the pno
6179 value is non-negative, we must set the onetime parent from it. This which
6180 points to the relevant entry in the recipients list.
6182 This processing can be altered by the setting of the process_recipients
6183 variable, which is changed if recipients are to be ignored, failed, or
6184 deferred. This can happen as a result of system filter activity, or if the -Mg
6185 option is used to fail all of them.
6187 Duplicate addresses are handled later by a different tree structure; we can't
6188 just extend the non-recipients tree, because that will be re-written to the
6189 spool if the message is deferred, and in any case there are casing
6190 complications for local addresses. */
6192 if (process_recipients != RECIP_IGNORE)
6193 for (i = 0; i < recipients_count; i++)
6194 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6196 recipient_item *r = recipients_list + i;
6197 address_item *new = deliver_make_addr(r->address, FALSE);
6198 new->prop.errors_address = r->errors_to;
6200 if ((new->prop.utf8_msg = message_smtputf8))
6202 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6203 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6204 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6205 new->prop.utf8_downcvt ? "yes"
6206 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6212 new->onetime_parent = recipients_list[r->pno].address;
6214 /* If DSN support is enabled, set the dsn flags and the original receipt
6215 to be passed on to other DSN enabled MTAs */
6217 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6218 new->dsn_orcpt = r->orcpt;
6219 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6220 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6222 switch (process_recipients)
6224 /* RECIP_DEFER is set when a system filter freezes a message. */
6227 new->next = addr_defer;
6232 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6235 case RECIP_FAIL_FILTER:
6237 filter_message ? filter_message : US"delivery cancelled";
6238 setflag(new, af_pass_message);
6239 goto RECIP_QUEUE_FAILED; /* below */
6242 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6243 than the value in timeout_frozen_after. Treat non-bounce messages
6244 similarly to -Mg; for bounce messages we just want to discard, so
6245 don't put the address on the failed list. The timeout has already
6248 case RECIP_FAIL_TIMEOUT:
6249 new->message = US"delivery cancelled; message timed out";
6250 goto RECIP_QUEUE_FAILED; /* below */
6253 /* RECIP_FAIL is set when -Mg has been used. */
6256 new->message = US"delivery cancelled by administrator";
6259 /* Common code for the failure cases above. If this is not a bounce
6260 message, put the address on the failed list so that it is used to
6261 create a bounce. Otherwise do nothing - this just discards the address.
6262 The incident has already been logged. */
6265 if (sender_address[0])
6267 new->next = addr_failed;
6273 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6274 in the message. Process each address as a routing failure; if this
6275 is a bounce message, it will get frozen. */
6277 case RECIP_FAIL_LOOP:
6278 new->message = US"Too many \"Received\" headers - suspected mail loop";
6279 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6283 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6286 if (!addr_new) addr_new = new; else addr_last->next = new;
6291 #ifndef DISABLE_EVENT
6292 if (process_recipients != RECIP_ACCEPT && event_action)
6294 uschar * save_local = deliver_localpart;
6295 const uschar * save_domain = deliver_domain;
6296 uschar * addr = new->address, * errmsg = NULL;
6297 int start, end, dom;
6299 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6300 log_write(0, LOG_MAIN|LOG_PANIC,
6301 "failed to parse address '%.100s': %s\n", addr, errmsg);
6305 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6306 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6308 event_raise(event_action, US"msg:fail:internal", new->message);
6310 deliver_localpart = save_local;
6311 deliver_domain = save_domain;
6319 debug_printf("Delivery address list:\n");
6320 for (address_item * p = addr_new; p; p = p->next)
6321 debug_printf(" %s %s\n", p->address,
6322 p->onetime_parent ? p->onetime_parent : US"");
6325 /* Set up the buffers used for copying over the file when delivering. */
6327 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6328 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6332 /* Until there are no more new addresses, handle each one as follows:
6334 . If this is a generated address (indicated by the presence of a parent
6335 pointer) then check to see whether it is a pipe, file, or autoreply, and
6336 if so, handle it directly here. The router that produced the address will
6337 have set the allow flags into the address, and also set the uid/gid required.
6338 Having the routers generate new addresses and then checking them here at
6339 the outer level is tidier than making each router do the checking, and
6340 means that routers don't need access to the failed address queue.
6342 . Break up the address into local part and domain, and make lowercased
6343 versions of these strings. We also make unquoted versions of the local part.
6345 . Handle the percent hack for those domains for which it is valid.
6347 . For child addresses, determine if any of the parents have the same address.
6348 If so, generate a different string for previous delivery checking. Without
6349 this code, if the address spqr generates spqr via a forward or alias file,
6350 delivery of the generated spqr stops further attempts at the top level spqr,
6351 which is not what is wanted - it may have generated other addresses.
6353 . Check on the retry database to see if routing was previously deferred, but
6354 only if in a queue run. Addresses that are to be routed are put on the
6355 addr_route chain. Addresses that are to be deferred are put on the
6356 addr_defer chain. We do all the checking first, so as not to keep the
6357 retry database open any longer than necessary.
6359 . Now we run the addresses through the routers. A router may put the address
6360 on either the addr_local or the addr_remote chain for local or remote
6361 delivery, respectively, or put it on the addr_failed chain if it is
6362 undeliveable, or it may generate child addresses and put them on the
6363 addr_new chain, or it may defer an address. All the chain anchors are
6364 passed as arguments so that the routers can be called for verification
6367 . If new addresses have been generated by the routers, da capo.
6370 f.header_rewritten = FALSE; /* No headers rewritten yet */
6371 while (addr_new) /* Loop until all addresses dealt with */
6373 address_item *addr, *parent;
6375 /* Failure to open the retry database is treated the same as if it does
6376 not exist. In both cases, dbm_file is NULL. */
6378 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6379 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6380 debug_printf("no retry data available\n");
6382 /* Scan the current batch of new addresses, to handle pipes, files and
6383 autoreplies, and determine which others are ready for routing. */
6390 dbdata_retry *domain_retry_record;
6391 dbdata_retry *address_retry_record;
6394 addr_new = addr->next;
6396 DEBUG(D_deliver|D_retry|D_route)
6398 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6399 debug_printf("Considering: %s\n", addr->address);
6402 /* Handle generated address that is a pipe or a file or an autoreply. */
6404 if (testflag(addr, af_pfr))
6406 /* If an autoreply in a filter could not generate a syntactically valid
6407 address, give up forthwith. Set af_ignore_error so that we don't try to
6408 generate a bounce. */
6410 if (testflag(addr, af_bad_reply))
6412 addr->basic_errno = ERRNO_BADADDRESS2;
6413 addr->local_part = addr->address;
6415 US"filter autoreply generated syntactically invalid recipient";
6416 addr->prop.ignore_error = TRUE;
6417 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6418 continue; /* with the next new address */
6421 /* If two different users specify delivery to the same pipe or file or
6422 autoreply, there should be two different deliveries, so build a unique
6423 string that incorporates the original address, and use this for
6424 duplicate testing and recording delivery, and also for retrying. */
6427 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6428 (testflag(addr->parent, af_homonym)? 3:0));
6430 addr->address_retry_key = addr->domain_retry_key =
6431 string_sprintf("T:%s", addr->unique);
6433 /* If a filter file specifies two deliveries to the same pipe or file,
6434 we want to de-duplicate, but this is probably not wanted for two mail
6435 commands to the same address, where probably both should be delivered.
6436 So, we have to invent a different unique string in that case. Just
6437 keep piling '>' characters on the front. */
6439 if (addr->address[0] == '>')
6440 while (tree_search(tree_duplicates, addr->unique))
6441 addr->unique = string_sprintf(">%s", addr->unique);
6443 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6445 DEBUG(D_deliver|D_route)
6446 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6447 addr->dupof = tnode->data.ptr;
6448 addr->next = addr_duplicate;
6449 addr_duplicate = addr;
6453 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6455 /* Check for previous delivery */
6457 if (tree_search(tree_nonrecipients, addr->unique))
6459 DEBUG(D_deliver|D_route)
6460 debug_printf("%s was previously delivered: discarded\n", addr->address);
6461 child_done(addr, tod_stamp(tod_log));
6465 /* Save for checking future duplicates */
6467 tree_add_duplicate(addr->unique, addr);
6469 /* Set local part and domain */
6471 addr->local_part = addr->address;
6472 addr->domain = addr->parent->domain;
6474 /* Ensure that the delivery is permitted. */
6476 if (testflag(addr, af_file))
6478 if (!testflag(addr, af_allow_file))
6480 addr->basic_errno = ERRNO_FORBIDFILE;
6481 addr->message = US"delivery to file forbidden";
6482 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6483 continue; /* with the next new address */
6486 else if (addr->address[0] == '|')
6488 if (!testflag(addr, af_allow_pipe))
6490 addr->basic_errno = ERRNO_FORBIDPIPE;
6491 addr->message = US"delivery to pipe forbidden";
6492 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6493 continue; /* with the next new address */
6496 else if (!testflag(addr, af_allow_reply))
6498 addr->basic_errno = ERRNO_FORBIDREPLY;
6499 addr->message = US"autoreply forbidden";
6500 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6501 continue; /* with the next new address */
6504 /* If the errno field is already set to BADTRANSPORT, it indicates
6505 failure to expand a transport string, or find the associated transport,
6506 or an unset transport when one is required. Leave this test till now so
6507 that the forbid errors are given in preference. */
6509 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6511 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6515 /* Treat /dev/null as a special case and abandon the delivery. This
6516 avoids having to specify a uid on the transport just for this case.
6517 Arrange for the transport name to be logged as "**bypassed**". */
6519 if (Ustrcmp(addr->address, "/dev/null") == 0)
6521 uschar *save = addr->transport->name;
6522 addr->transport->name = US"**bypassed**";
6523 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6524 addr->transport->name = save;
6525 continue; /* with the next new address */
6528 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6531 DEBUG(D_deliver|D_route)
6532 debug_printf("queued for %s transport\n", addr->transport->name);
6533 addr->next = addr_local;
6535 continue; /* with the next new address */
6538 /* Handle normal addresses. First, split up into local part and domain,
6539 handling the %-hack if necessary. There is the possibility of a defer from
6540 a lookup in percent_hack_domains. */
6542 if ((rc = deliver_split_address(addr)) == DEFER)
6544 addr->message = US"cannot check percent_hack_domains";
6545 addr->basic_errno = ERRNO_LISTDEFER;
6546 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6550 /* Check to see if the domain is held. If so, proceed only if the
6551 delivery was forced by hand. */
6553 deliver_domain = addr->domain; /* set $domain */
6554 if ( !forced && hold_domains
6555 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6556 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6562 addr->message = US"hold_domains lookup deferred";
6563 addr->basic_errno = ERRNO_LISTDEFER;
6567 addr->message = US"domain is held";
6568 addr->basic_errno = ERRNO_HELD;
6570 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6574 /* Now we can check for duplicates and previously delivered addresses. In
6575 order to do this, we have to generate a "unique" value for each address,
6576 because there may be identical actual addresses in a line of descendents.
6577 The "unique" field is initialized to the same value as the "address" field,
6578 but gets changed here to cope with identically-named descendents. */
6580 for (parent = addr->parent; parent; parent = parent->parent)
6581 if (strcmpic(addr->address, parent->address) == 0) break;
6583 /* If there's an ancestor with the same name, set the homonym flag. This
6584 influences how deliveries are recorded. Then add a prefix on the front of
6585 the unique address. We use \n\ where n starts at 0 and increases each time.
6586 It is unlikely to pass 9, but if it does, it may look odd but will still
6587 work. This means that siblings or cousins with the same names are treated
6588 as duplicates, which is what we want. */
6592 setflag(addr, af_homonym);
6593 if (parent->unique[0] != '\\')
6594 addr->unique = string_sprintf("\\0\\%s", addr->address);
6596 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6600 /* Ensure that the domain in the unique field is lower cased, because
6601 domains are always handled caselessly. */
6603 p = Ustrrchr(addr->unique, '@');
6604 while (*p != 0) { *p = tolower(*p); p++; }
6606 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6608 if (tree_search(tree_nonrecipients, addr->unique))
6610 DEBUG(D_deliver|D_route)
6611 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6612 child_done(addr, tod_stamp(tod_log));
6616 /* Get the routing retry status, saving the two retry keys (with and
6617 without the local part) for subsequent use. If there is no retry record for
6618 the standard address routing retry key, we look for the same key with the
6619 sender attached, because this form is used by the smtp transport after a
6620 4xx response to RCPT when address_retry_include_sender is true. */
6622 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6623 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6628 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6629 if ( domain_retry_record
6630 && now - domain_retry_record->time_stamp > retry_data_expire
6633 DEBUG(D_deliver|D_retry)
6634 debug_printf("domain retry record present but expired\n");
6635 domain_retry_record = NULL; /* Ignore if too old */
6638 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6639 if ( address_retry_record
6640 && now - address_retry_record->time_stamp > retry_data_expire
6643 DEBUG(D_deliver|D_retry)
6644 debug_printf("address retry record present but expired\n");
6645 address_retry_record = NULL; /* Ignore if too old */
6648 if (!address_retry_record)
6650 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6652 address_retry_record = dbfn_read(dbm_file, altkey);
6653 if ( address_retry_record
6654 && now - address_retry_record->time_stamp > retry_data_expire)
6656 DEBUG(D_deliver|D_retry)
6657 debug_printf("address<sender> retry record present but expired\n");
6658 address_retry_record = NULL; /* Ignore if too old */
6663 domain_retry_record = address_retry_record = NULL;
6665 DEBUG(D_deliver|D_retry)
6667 if (!domain_retry_record)
6668 debug_printf("no domain retry record\n");
6670 debug_printf("have domain retry record; next_try = now%+d\n",
6671 f.running_in_test_harness ? 0 :
6672 (int)(domain_retry_record->next_try - now));
6674 if (!address_retry_record)
6675 debug_printf("no address retry record\n");
6677 debug_printf("have address retry record; next_try = now%+d\n",
6678 f.running_in_test_harness ? 0 :
6679 (int)(address_retry_record->next_try - now));
6682 /* If we are sending a message down an existing SMTP connection, we must
6683 assume that the message which created the connection managed to route
6684 an address to that connection. We do not want to run the risk of taking
6685 a long time over routing here, because if we do, the server at the other
6686 end of the connection may time it out. This is especially true for messages
6687 with lots of addresses. For this kind of delivery, queue_running is not
6688 set, so we would normally route all addresses. We take a pragmatic approach
6689 and defer routing any addresses that have any kind of domain retry record.
6690 That is, we don't even look at their retry times. It doesn't matter if this
6691 doesn't work occasionally. This is all just an optimization, after all.
6693 The reason for not doing the same for address retries is that they normally
6694 arise from 4xx responses, not DNS timeouts. */
6696 if (continue_hostname && domain_retry_record)
6698 addr->message = US"reusing SMTP connection skips previous routing defer";
6699 addr->basic_errno = ERRNO_RRETRY;
6700 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6702 addr->message = domain_retry_record->text;
6703 setflag(addr, af_pass_message);
6706 /* If we are in a queue run, defer routing unless there is no retry data or
6707 we've passed the next retry time, or this message is forced. In other
6708 words, ignore retry data when not in a queue run.
6710 However, if the domain retry time has expired, always allow the routing
6711 attempt. If it fails again, the address will be failed. This ensures that
6712 each address is routed at least once, even after long-term routing
6715 If there is an address retry, check that too; just wait for the next
6716 retry time. This helps with the case when the temporary error on the
6717 address was really message-specific rather than address specific, since
6718 it allows other messages through.
6720 We also wait for the next retry time if this is a message sent down an
6721 existing SMTP connection (even though that will be forced). Otherwise there
6722 will be far too many attempts for an address that gets a 4xx error. In
6723 fact, after such an error, we should not get here because, the host should
6724 not be remembered as one this message needs. However, there was a bug that
6725 used to cause this to happen, so it is best to be on the safe side.
6727 Even if we haven't reached the retry time in the hints, there is one more
6728 check to do, which is for the ultimate address timeout. We only do this
6729 check if there is an address retry record and there is not a domain retry
6730 record; this implies that previous attempts to handle the address had the
6731 retry_use_local_parts option turned on. We use this as an approximation
6732 for the destination being like a local delivery, for example delivery over
6733 LMTP to an IMAP message store. In this situation users are liable to bump
6734 into their quota and thereby have intermittently successful deliveries,
6735 which keep the retry record fresh, which can lead to us perpetually
6736 deferring messages. */
6738 else if ( ( f.queue_running && !f.deliver_force
6739 || continue_hostname
6741 && ( ( domain_retry_record
6742 && now < domain_retry_record->next_try
6743 && !domain_retry_record->expired
6745 || ( address_retry_record
6746 && now < address_retry_record->next_try
6748 && ( domain_retry_record
6749 || !address_retry_record
6750 || !retry_ultimate_address_timeout(addr->address_retry_key,
6751 addr->domain, address_retry_record, now)
6754 addr->message = US"retry time not reached";
6755 addr->basic_errno = ERRNO_RRETRY;
6756 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6758 /* For remote-retry errors (here and just above) that we've not yet
6759 hit the retry time, use the error recorded in the retry database
6760 as info in the warning message. This lets us send a message even
6761 when we're not failing on a fresh attempt. We assume that this
6762 info is not sensitive. */
6764 addr->message = domain_retry_record
6765 ? domain_retry_record->text : address_retry_record->text;
6766 setflag(addr, af_pass_message);
6769 /* The domain is OK for routing. Remember if retry data exists so it
6770 can be cleaned up after a successful delivery. */
6774 if (domain_retry_record || address_retry_record)
6775 setflag(addr, af_dr_retry_exists);
6776 addr->next = addr_route;
6778 DEBUG(D_deliver|D_route)
6779 debug_printf("%s: queued for routing\n", addr->address);
6783 /* The database is closed while routing is actually happening. Requests to
6784 update it are put on a chain and all processed together at the end. */
6786 if (dbm_file) dbfn_close(dbm_file);
6788 /* If queue_domains is set, we don't even want to try routing addresses in
6789 those domains. During queue runs, queue_domains is forced to be unset.
6790 Optimize by skipping this pass through the addresses if nothing is set. */
6792 if (!f.deliver_force && queue_domains)
6794 address_item *okaddr = NULL;
6797 address_item *addr = addr_route;
6798 addr_route = addr->next;
6800 deliver_domain = addr->domain; /* set $domain */
6801 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6802 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6806 addr->basic_errno = ERRNO_LISTDEFER;
6807 addr->message = US"queue_domains lookup deferred";
6808 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6812 addr->next = okaddr;
6817 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6818 addr->message = US"domain is in queue_domains";
6819 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6823 addr_route = okaddr;
6826 /* Now route those addresses that are not deferred. */
6831 address_item *addr = addr_route;
6832 const uschar *old_domain = addr->domain;
6833 uschar *old_unique = addr->unique;
6834 addr_route = addr->next;
6837 /* Just in case some router parameter refers to it. */
6839 if (!(return_path = addr->prop.errors_address))
6840 return_path = sender_address;
6842 /* If a router defers an address, add a retry item. Whether or not to
6843 use the local part in the key is a property of the router. */
6845 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6846 &addr_succeed, v_none)) == DEFER)
6847 retry_add_item(addr,
6848 addr->router->retry_use_local_part
6849 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6850 : string_sprintf("R:%s", addr->domain),
6853 /* Otherwise, if there is an existing retry record in the database, add
6854 retry items to delete both forms. We must also allow for the possibility
6855 of a routing retry that includes the sender address. Since the domain might
6856 have been rewritten (expanded to fully qualified) as a result of routing,
6857 ensure that the rewritten form is also deleted. */
6859 else if (testflag(addr, af_dr_retry_exists))
6861 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6863 retry_add_item(addr, altkey, rf_delete);
6864 retry_add_item(addr, addr->address_retry_key, rf_delete);
6865 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6866 if (Ustrcmp(addr->domain, old_domain) != 0)
6867 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6870 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6871 logged, but we need to ensure the address (and maybe parents) is marked
6876 address_done(addr, tod_stamp(tod_log));
6877 continue; /* route next address */
6880 /* The address is finished with (failed or deferred). */
6884 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6885 continue; /* route next address */
6888 /* The address has been routed. If the router changed the domain, it will
6889 also have changed the unique address. We have to test whether this address
6890 has already been delivered, because it's the unique address that finally
6893 if ( addr->unique != old_unique
6894 && tree_search(tree_nonrecipients, addr->unique) != 0
6897 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6898 "discarded\n", addr->address);
6899 if (addr_remote == addr) addr_remote = addr->next;
6900 else if (addr_local == addr) addr_local = addr->next;
6903 /* If the router has same_domain_copy_routing set, we are permitted to copy
6904 the routing for any other addresses with the same domain. This is an
6905 optimisation to save repeated DNS lookups for "standard" remote domain
6906 routing. The option is settable only on routers that generate host lists.
6907 We play it very safe, and do the optimization only if the address is routed
6908 to a remote transport, there are no header changes, and the domain was not
6909 modified by the router. */
6911 if ( addr_remote == addr
6912 && addr->router->same_domain_copy_routing
6913 && !addr->prop.extra_headers
6914 && !addr->prop.remove_headers
6915 && old_domain == addr->domain
6918 address_item **chain = &addr_route;
6921 address_item *addr2 = *chain;
6922 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6924 chain = &(addr2->next);
6928 /* Found a suitable address; take it off the routing list and add it to
6929 the remote delivery list. */
6931 *chain = addr2->next;
6932 addr2->next = addr_remote;
6933 addr_remote = addr2;
6935 /* Copy the routing data */
6937 addr2->domain = addr->domain;
6938 addr2->router = addr->router;
6939 addr2->transport = addr->transport;
6940 addr2->host_list = addr->host_list;
6941 addr2->fallback_hosts = addr->fallback_hosts;
6942 addr2->prop.errors_address = addr->prop.errors_address;
6943 copyflag(addr2, addr, af_hide_child);
6944 copyflag(addr2, addr, af_local_host_removed);
6946 DEBUG(D_deliver|D_route)
6947 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6949 "Routing for %s copied from %s\n",
6950 addr2->address, addr2->address, addr->address);
6953 } /* Continue with routing the next address. */
6954 } /* Loop to process any child addresses that the routers created, and
6955 any rerouted addresses that got put back on the new chain. */
6958 /* Debugging: show the results of the routing */
6960 DEBUG(D_deliver|D_retry|D_route)
6962 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6963 debug_printf("After routing:\n Local deliveries:\n");
6964 for (address_item * p = addr_local; p; p = p->next)
6965 debug_printf(" %s\n", p->address);
6967 debug_printf(" Remote deliveries:\n");
6968 for (address_item * p = addr_remote; p; p = p->next)
6969 debug_printf(" %s\n", p->address);
6971 debug_printf(" Failed addresses:\n");
6972 for (address_item * p = addr_failed; p; p = p->next)
6973 debug_printf(" %s\n", p->address);
6975 debug_printf(" Deferred addresses:\n");
6976 for (address_item * p = addr_defer; p; p = p->next)
6977 debug_printf(" %s\n", p->address);
6980 /* Free any resources that were cached during routing. */
6985 /* These two variables are set only during routing, after check_local_user.
6986 Ensure they are not set in transports. */
6988 local_user_gid = (gid_t)(-1);
6989 local_user_uid = (uid_t)(-1);
6991 /* Check for any duplicate addresses. This check is delayed until after
6992 routing, because the flexibility of the routing configuration means that
6993 identical addresses with different parentage may end up being redirected to
6994 different addresses. Checking for duplicates too early (as we previously used
6995 to) makes this kind of thing not work. */
6997 do_duplicate_check(&addr_local);
6998 do_duplicate_check(&addr_remote);
7000 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7001 remote transport. The check that they all end up in one transaction happens in
7002 the do_remote_deliveries() function. */
7005 && (addr_local || addr_failed || addr_defer)
7009 uschar *which, *colon, *msg;
7016 else if (addr_defer)
7019 which = US"deferred";
7027 while (addr->parent) addr = addr->parent;
7032 msg = addr->message;
7034 else colon = msg = US"";
7036 /* We don't need to log here for a forced failure as it will already
7037 have been logged. Defer will also have been logged, but as a defer, so we do
7038 need to do the failure logging. */
7040 if (addr != addr_failed)
7041 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7042 addr->address, which);
7044 /* Always write an error to the caller */
7046 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7049 final_yield = DELIVER_MUA_FAILED;
7050 addr_failed = addr_defer = NULL; /* So that we remove the message */
7051 goto DELIVERY_TIDYUP;
7055 /* If this is a run to continue deliveries to an external channel that is
7056 already set up, defer any local deliveries. */
7058 if (continue_transport)
7062 address_item *addr = addr_defer;
7063 while (addr->next) addr = addr->next;
7064 addr->next = addr_local;
7067 addr_defer = addr_local;
7072 /* Because address rewriting can happen in the routers, we should not really do
7073 ANY deliveries until all addresses have been routed, so that all recipients of
7074 the message get the same headers. However, this is in practice not always
7075 possible, since sometimes remote addresses give DNS timeouts for days on end.
7076 The pragmatic approach is to deliver what we can now, saving any rewritten
7077 headers so that at least the next lot of recipients benefit from the rewriting
7078 that has already been done.
7080 If any headers have been rewritten during routing, update the spool file to
7081 remember them for all subsequent deliveries. This can be delayed till later if
7082 there is only address to be delivered - if it succeeds the spool write need not
7085 if ( f.header_rewritten
7086 && ( addr_local && (addr_local->next || addr_remote)
7087 || addr_remote && addr_remote->next
7090 /* Panic-dies on error */
7091 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7092 f.header_rewritten = FALSE;
7096 /* If there are any deliveries to do and we do not already have the journal
7097 file, create it. This is used to record successful deliveries as soon as
7098 possible after each delivery is known to be complete. A file opened with
7099 O_APPEND is used so that several processes can run simultaneously.
7101 The journal is just insurance against crashes. When the spool file is
7102 ultimately updated at the end of processing, the journal is deleted. If a
7103 journal is found to exist at the start of delivery, the addresses listed
7104 therein are added to the non-recipients. */
7106 if (addr_local || addr_remote)
7110 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7112 if ((journal_fd = Uopen(fname,
7116 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7118 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7119 fname, strerror(errno));
7120 return DELIVER_NOT_ATTEMPTED;
7123 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7124 that the mode is correct - the group setting doesn't always seem to get
7125 set automatically. */
7127 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7128 || fchmod(journal_fd, SPOOL_MODE)
7130 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7134 int ret = Uunlink(fname);
7135 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7136 fname, strerror(errno));
7137 if(ret && errno != ENOENT)
7138 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7139 fname, strerror(errno));
7140 return DELIVER_NOT_ATTEMPTED;
7144 else if (journal_fd >= 0)
7152 /* Now we can get down to the business of actually doing deliveries. Local
7153 deliveries are done first, then remote ones. If ever the problems of how to
7154 handle fallback transports are figured out, this section can be put into a loop
7155 for handling fallbacks, though the uid switching will have to be revised. */
7157 /* Precompile a regex that is used to recognize a parameter in response
7158 to an LHLO command, if is isn't already compiled. This may be used on both
7159 local and remote LMTP deliveries. */
7161 if (!regex_IGNOREQUOTA)
7163 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7165 /* Handle local deliveries */
7169 DEBUG(D_deliver|D_transport)
7170 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7171 do_local_deliveries();
7172 f.disable_logging = FALSE;
7175 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7176 so just queue them all. */
7178 if (f.queue_run_local)
7181 address_item *addr = addr_remote;
7182 addr_remote = addr->next;
7184 addr->basic_errno = ERRNO_LOCAL_ONLY;
7185 addr->message = US"remote deliveries suppressed";
7186 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7189 /* Handle remote deliveries */
7193 DEBUG(D_deliver|D_transport)
7194 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7196 /* Precompile some regex that are used to recognize parameters in response
7197 to an EHLO command, if they aren't already compiled. */
7199 smtp_deliver_init();
7201 /* Now sort the addresses if required, and do the deliveries. The yield of
7202 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7203 cannot be delivered in one transaction. */
7205 if (remote_sort_domains) sort_remote_deliveries();
7206 if (!do_remote_deliveries(FALSE))
7208 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7209 "be delivered in one transaction");
7210 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7212 final_yield = DELIVER_MUA_FAILED;
7213 addr_failed = addr_defer = NULL; /* So that we remove the message */
7214 goto DELIVERY_TIDYUP;
7217 /* See if any of the addresses that failed got put on the queue for delivery
7218 to their fallback hosts. We do it this way because often the same fallback
7219 host is used for many domains, so all can be sent in a single transaction
7220 (if appropriately configured). */
7222 if (addr_fallback && !mua_wrapper)
7224 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7225 addr_remote = addr_fallback;
7226 addr_fallback = NULL;
7227 if (remote_sort_domains) sort_remote_deliveries();
7228 do_remote_deliveries(TRUE);
7230 f.disable_logging = FALSE;
7234 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7235 phase, to minimize cases of half-done things. */
7238 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7239 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7241 /* Root privilege is no longer needed */
7243 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7245 set_process_info("tidying up after delivering %s", message_id);
7246 signal(SIGTERM, SIG_IGN);
7248 /* When we are acting as an MUA wrapper, the smtp transport will either have
7249 succeeded for all addresses, or failed them all in normal cases. However, there
7250 are some setup situations (e.g. when a named port does not exist) that cause an
7251 immediate exit with deferral of all addresses. Convert those into failures. We
7252 do not ever want to retry, nor do we want to send a bounce message. */
7258 address_item * nextaddr;
7259 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7261 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7262 "delivery", addr->address);
7263 nextaddr = addr->next;
7264 addr->next = addr_failed;
7270 /* Now all should either have succeeded or failed. */
7273 final_yield = DELIVER_MUA_SUCCEEDED;
7277 uschar *s = addr_failed->user_message;
7279 if (!s) s = addr_failed->message;
7281 fprintf(stderr, "Delivery failed: ");
7282 if (addr_failed->basic_errno > 0)
7284 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7285 if (s) fprintf(stderr, ": ");
7287 if ((host = addr_failed->host_used))
7288 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7290 fprintf(stderr, "%s", CS s);
7291 else if (addr_failed->basic_errno <= 0)
7292 fprintf(stderr, "unknown error");
7293 fprintf(stderr, "\n");
7295 final_yield = DELIVER_MUA_FAILED;
7300 /* In a normal configuration, we now update the retry database. This is done in
7301 one fell swoop at the end in order not to keep opening and closing (and
7302 locking) the database. The code for handling retries is hived off into a
7303 separate module for convenience. We pass it the addresses of the various
7304 chains, because deferred addresses can get moved onto the failed chain if the
7305 retry cutoff time has expired for all alternative destinations. Bypass the
7306 updating of the database if the -N flag is set, which is a debugging thing that
7307 prevents actual delivery. */
7309 else if (!f.dont_deliver)
7310 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7312 /* Send DSN for successful messages if requested */
7313 addr_senddsn = NULL;
7315 for (address_item * a = addr_succeed; a; a = a->next)
7317 /* af_ignore_error not honored here. it's not an error */
7318 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7319 "DSN: processing successful delivery address: %s\n"
7320 "DSN: Sender_address: %s\n"
7321 "DSN: orcpt: %s flags: 0x%x\n"
7322 "DSN: envid: %s ret: %d\n"
7323 "DSN: Final recipient: %s\n"
7324 "DSN: Remote SMTP server supports DSN: %d\n",
7325 a->router ? a->router->name : US"(unknown)",
7328 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7330 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7335 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7336 and a report was requested */
7338 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7339 && a->dsn_flags & rf_notify_success
7342 /* copy and relink address_item and send report with all of them at once later */
7343 address_item * addr_next = addr_senddsn;
7344 addr_senddsn = store_get(sizeof(address_item), FALSE);
7346 addr_senddsn->next = addr_next;
7349 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7357 /* create exim process to send message */
7358 pid = child_open_exim(&fd, US"DSN");
7360 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7362 if (pid < 0) /* Creation of child failed */
7364 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7365 "create child process to send success-dsn message: %s", getpid(),
7366 getppid(), strerror(errno));
7368 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7370 else /* Creation of child succeeded */
7372 FILE * f = fdopen(fd, "wb");
7373 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7375 transport_ctx tctx = {{0}};
7378 debug_printf("sending success-dsn to: %s\n", sender_address);
7380 /* build unique id for MIME boundary */
7381 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7382 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7384 if (errors_reply_to)
7385 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7388 fprintf(f, "Auto-Submitted: auto-generated\n"
7390 "Subject: Delivery Status Notification\n",
7392 moan_write_references(f, NULL);
7393 fprintf(f, "Content-Type: multipart/report;"
7394 " report-type=delivery-status; boundary=%s\n"
7395 "MIME-Version: 1.0\n\n"
7398 "Content-type: text/plain; charset=us-ascii\n\n"
7400 "This message was created automatically by mail delivery software.\n"
7401 " ----- The following addresses had successful delivery notifications -----\n",
7404 for (address_item * a = addr_senddsn; a; a = a->next)
7405 fprintf(f, "<%s> (relayed %s)\n\n",
7407 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7408 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7409 : "via non \"Remote SMTP\" router"
7413 "Content-type: message/delivery-status\n\n"
7414 "Reporting-MTA: dns; %s\n",
7415 bound, smtp_active_hostname);
7418 { /* must be decoded from xtext: see RFC 3461:6.3a */
7420 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7421 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7423 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7427 for (address_item * a = addr_senddsn; a; a = a->next)
7431 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7433 if ((hu = a->host_used) && hu->name)
7434 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7437 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7438 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7441 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7444 transport_filter_argv = NULL; /* Just in case */
7445 return_path = sender_address; /* In case not previously set */
7447 /* Write the original email out */
7450 tctx.options = topt_add_return_path | topt_no_body;
7451 /*XXX hmm, FALSE(fail) retval ignored.
7452 Could error for any number of reasons, and they are not handled. */
7453 transport_write_message(&tctx, 0);
7456 fprintf(f,"\n--%s--\n", bound);
7460 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7464 /* If any addresses failed, we must send a message to somebody, unless
7465 af_ignore_error is set, in which case no action is taken. It is possible for
7466 several messages to get sent if there are addresses with different
7473 uschar *logtod = tod_stamp(tod_log);
7475 address_item *handled_addr = NULL;
7476 address_item **paddr;
7477 address_item *msgchain = NULL;
7478 address_item **pmsgchain = &msgchain;
7480 /* There are weird cases when logging is disabled in the transport. However,
7481 there may not be a transport (address failed by a router). */
7483 f.disable_logging = FALSE;
7484 if (addr_failed->transport)
7485 f.disable_logging = addr_failed->transport->disable_logging;
7488 debug_printf("processing failed address %s\n", addr_failed->address);
7490 /* There are only two ways an address in a bounce message can get here:
7492 (1) When delivery was initially deferred, but has now timed out (in the call
7493 to retry_update() above). We can detect this by testing for
7494 af_retry_timedout. If the address does not have its own errors address,
7495 we arrange to ignore the error.
7497 (2) If delivery failures for bounce messages are being ignored. We can detect
7498 this by testing for af_ignore_error. This will also be set if a bounce
7499 message has been autothawed and the ignore_bounce_errors_after time has
7500 passed. It might also be set if a router was explicitly configured to
7501 ignore errors (errors_to = "").
7503 If neither of these cases obtains, something has gone wrong. Log the
7504 incident, but then ignore the error. */
7506 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7508 if ( !testflag(addr_failed, af_retry_timedout)
7509 && !addr_failed->prop.ignore_error)
7510 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7511 "failure is neither frozen nor ignored (it's been ignored)");
7513 addr_failed->prop.ignore_error = TRUE;
7516 /* If the first address on the list has af_ignore_error set, just remove
7517 it from the list, throw away any saved message file, log it, and
7518 mark the recipient done. */
7520 if ( addr_failed->prop.ignore_error
7521 || addr_failed->dsn_flags & rf_dsnflags
7522 && !(addr_failed->dsn_flags & rf_notify_failure)
7526 addr_failed = addr->next;
7527 if (addr->return_filename) Uunlink(addr->return_filename);
7529 #ifndef DISABLE_EVENT
7530 msg_event_raise(US"msg:fail:delivery", addr);
7532 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7534 !addr->parent ? US"" : US" <",
7535 !addr->parent ? US"" : addr->parent->address,
7536 !addr->parent ? US"" : US">",
7537 addr->prop.ignore_error
7538 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7540 address_done(addr, logtod);
7541 child_done(addr, logtod);
7542 /* Panic-dies on error */
7543 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7546 /* Otherwise, handle the sending of a message. Find the error address for
7547 the first address, then send a message that includes all failed addresses
7548 that have the same error address. Note the bounce_recipient is a global so
7549 that it can be accessed by $bounce_recipient while creating a customized
7554 if (!(bounce_recipient = addr_failed->prop.errors_address))
7555 bounce_recipient = sender_address;
7557 /* Make a subprocess to send a message */
7559 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7560 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7561 "create child process to send failure message: %s", getpid(),
7562 getppid(), strerror(errno));
7564 /* Creation of child succeeded */
7571 uschar *bcc, *emf_text;
7572 FILE * fp = fdopen(fd, "wb");
7574 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7575 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7576 DELIVER_IN_BUFFER_SIZE;
7578 uschar *dsnlimitmsg;
7579 uschar *dsnnotifyhdr;
7583 debug_printf("sending error message to: %s\n", bounce_recipient);
7585 /* Scan the addresses for all that have the same errors address, removing
7586 them from the addr_failed chain, and putting them on msgchain. */
7588 paddr = &addr_failed;
7589 for (addr = addr_failed; addr; addr = *paddr)
7590 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7591 ? addr->prop.errors_address : sender_address) == 0)
7592 { /* The same - dechain */
7593 *paddr = addr->next;
7596 pmsgchain = &(addr->next);
7599 paddr = &addr->next; /* Not the same; skip */
7601 /* Include X-Failed-Recipients: for automatic interpretation, but do
7602 not let any one header line get too long. We do this by starting a
7603 new header every 50 recipients. Omit any addresses for which the
7604 "hide_child" flag is set. */
7606 for (addr = msgchain; addr; addr = addr->next)
7608 if (testflag(addr, af_hide_child)) continue;
7616 ? "X-Failed-Recipients: "
7618 testflag(addr, af_pfr) && addr->parent
7619 ? string_printing(addr->parent->address)
7620 : string_printing(addr->address));
7622 if (rcount > 0) fprintf(fp, "\n");
7624 /* Output the standard headers */
7626 if (errors_reply_to)
7627 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7628 fprintf(fp, "Auto-Submitted: auto-replied\n");
7629 moan_write_from(fp);
7630 fprintf(fp, "To: %s\n", bounce_recipient);
7631 moan_write_references(fp, NULL);
7633 /* generate boundary string and output MIME-Headers */
7634 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7636 fprintf(fp, "Content-Type: multipart/report;"
7637 " report-type=delivery-status; boundary=%s\n"
7638 "MIME-Version: 1.0\n",
7641 /* Open a template file if one is provided. Log failure to open, but
7642 carry on - default texts will be used. */
7644 if (bounce_message_file)
7645 emf = expand_open(bounce_message_file,
7646 US"bounce_message_file", US"error");
7648 /* Quietly copy to configured additional addresses if required. */
7650 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7651 fprintf(fp, "Bcc: %s\n", bcc);
7653 /* The texts for the message can be read from a template file; if there
7654 isn't one, or if it is too short, built-in texts are used. The first
7655 emf text is a Subject: and any other headers. */
7657 if ((emf_text = next_emf(emf, US"header")))
7658 fprintf(fp, "%s\n", emf_text);
7660 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7661 to_sender? ": returning message to sender" : "");
7663 /* output human readable part as text/plain section */
7664 fprintf(fp, "--%s\n"
7665 "Content-type: text/plain; charset=us-ascii\n\n",
7668 if ((emf_text = next_emf(emf, US"intro")))
7669 fprintf(fp, "%s", CS emf_text);
7673 /* This message has been reworded several times. It seems to be confusing to
7674 somebody, however it is worded. I have retreated to the original, simple
7676 "This message was created automatically by mail delivery software.\n");
7678 if (bounce_message_text)
7679 fprintf(fp, "%s", CS bounce_message_text);
7682 "\nA message that you sent could not be delivered to one or more of its\n"
7683 "recipients. This is a permanent error. The following address(es) failed:\n");
7686 "\nA message sent by\n\n <%s>\n\n"
7687 "could not be delivered to one or more of its recipients. The following\n"
7688 "address(es) failed:\n", sender_address);
7692 /* Process the addresses, leaving them on the msgchain if they have a
7693 file name for a return message. (There has already been a check in
7694 post_process_one() for the existence of data in the message file.) A TRUE
7695 return from print_address_information() means that the address is not
7699 for (addr = msgchain; addr; addr = *paddr)
7701 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7702 print_address_error(addr, fp, US"");
7704 /* End the final line for the address */
7708 /* Leave on msgchain if there's a return file. */
7710 if (addr->return_file >= 0)
7712 paddr = &(addr->next);
7716 /* Else save so that we can tick off the recipient when the
7721 *paddr = addr->next;
7722 addr->next = handled_addr;
7723 handled_addr = addr;
7729 /* Get the next text, whether we need it or not, so as to be
7730 positioned for the one after. */
7732 emf_text = next_emf(emf, US"generated text");
7734 /* If there were any file messages passed by the local transports,
7735 include them in the message. Then put the address on the handled chain.
7736 In the case of a batch of addresses that were all sent to the same
7737 transport, the return_file field in all of them will contain the same
7738 fd, and the return_filename field in the *last* one will be set (to the
7739 name of the file). */
7743 address_item *nextaddr;
7746 fprintf(fp, "%s", CS emf_text);
7749 "The following text was generated during the delivery "
7750 "attempt%s:\n", (filecount > 1)? "s" : "");
7752 for (addr = msgchain; addr; addr = nextaddr)
7755 address_item *topaddr = addr;
7757 /* List all the addresses that relate to this file */
7760 while(addr) /* Insurance */
7762 print_address_information(addr, fp, US"------ ", US"\n ",
7764 if (addr->return_filename) break;
7769 /* Now copy the file */
7771 if (!(fm = Ufopen(addr->return_filename, "rb")))
7772 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7776 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7779 Uunlink(addr->return_filename);
7781 /* Can now add to handled chain, first fishing off the next
7782 address on the msgchain. */
7784 nextaddr = addr->next;
7785 addr->next = handled_addr;
7786 handled_addr = topaddr;
7791 /* output machine readable part */
7793 if (message_smtputf8)
7794 fprintf(fp, "--%s\n"
7795 "Content-type: message/global-delivery-status\n\n"
7796 "Reporting-MTA: dns; %s\n",
7797 bound, smtp_active_hostname);
7800 fprintf(fp, "--%s\n"
7801 "Content-type: message/delivery-status\n\n"
7802 "Reporting-MTA: dns; %s\n",
7803 bound, smtp_active_hostname);
7807 /* must be decoded from xtext: see RFC 3461:6.3a */
7809 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7810 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7812 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7816 for (addr = handled_addr; addr; addr = addr->next)
7820 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7822 if ((hu = addr->host_used) && hu->name)
7824 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7825 #ifdef EXPERIMENTAL_DSN_INFO
7830 uschar * p = hu->port == 25
7831 ? US"" : string_sprintf(":%d", hu->port);
7832 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7834 if ((s = addr->smtp_greeting) && *s)
7835 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7836 if ((s = addr->helo_response) && *s)
7837 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7838 if ((s = addr->message) && *s)
7839 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7842 print_dsn_diagnostic_code(addr, fp);
7847 /* Now copy the message, trying to give an intelligible comment if
7848 it is too long for it all to be copied. The limit isn't strictly
7849 applied because of the buffering. There is, however, an option
7850 to suppress copying altogether. */
7852 emf_text = next_emf(emf, US"copy");
7855 we ignore the intro text from template and add
7856 the text for bounce_return_size_limit at the end.
7858 bounce_return_message is ignored
7859 in case RET= is defined we honor these values
7860 otherwise bounce_return_body is honored.
7862 bounce_return_size_limit is always honored.
7865 fprintf(fp, "--%s\n", bound);
7867 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7868 dsnnotifyhdr = NULL;
7869 topt = topt_add_return_path;
7871 /* RET=HDRS? top priority */
7872 if (dsn_ret == dsn_ret_hdrs)
7873 topt |= topt_no_body;
7876 struct stat statbuf;
7878 /* no full body return at all? */
7879 if (!bounce_return_body)
7881 topt |= topt_no_body;
7882 /* add header if we overrule RET=FULL */
7883 if (dsn_ret == dsn_ret_full)
7884 dsnnotifyhdr = dsnlimitmsg;
7886 /* line length limited... return headers only if oversize */
7887 /* size limited ... return headers only if limit reached */
7888 else if ( max_received_linelength > bounce_return_linesize_limit
7889 || ( bounce_return_size_limit > 0
7890 && fstat(deliver_datafile, &statbuf) == 0
7891 && statbuf.st_size > max
7894 topt |= topt_no_body;
7895 dsnnotifyhdr = dsnlimitmsg;
7900 if (message_smtputf8)
7901 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7902 : "Content-type: message/global\n\n",
7906 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7907 : "Content-type: message/rfc822\n\n",
7911 transport_filter_argv = NULL; /* Just in case */
7912 return_path = sender_address; /* In case not previously set */
7913 { /* Dummy transport for headers add */
7914 transport_ctx tctx = {{0}};
7915 transport_instance tb = {0};
7917 tctx.u.fd = fileno(fp);
7919 tctx.options = topt;
7920 tb.add_headers = dsnnotifyhdr;
7922 /*XXX no checking for failure! buggy! */
7923 transport_write_message(&tctx, 0);
7927 /* we never add the final text. close the file */
7931 fprintf(fp, "\n--%s--\n", bound);
7933 /* Close the file, which should send an EOF to the child process
7934 that is receiving the message. Wait for it to finish. */
7937 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7939 /* If the process failed, there was some disaster in setting up the
7940 error message. Unless the message is very old, ensure that addr_defer
7941 is non-null, which will have the effect of leaving the message on the
7942 spool. The failed addresses will get tried again next time. However, we
7943 don't really want this to happen too often, so freeze the message unless
7944 there are some genuine deferred addresses to try. To do this we have
7945 to call spool_write_header() here, because with no genuine deferred
7946 addresses the normal code below doesn't get run. */
7951 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7953 addr_defer = (address_item *)(+1);
7954 f.deliver_freeze = TRUE;
7955 deliver_frozen_at = time(NULL);
7956 /* Panic-dies on error */
7957 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7960 deliver_msglog("Process failed (%d) when writing error message "
7961 "to %s%s", rc, bounce_recipient, s);
7962 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7963 "to %s%s", rc, bounce_recipient, s);
7966 /* The message succeeded. Ensure that the recipients that failed are
7967 now marked finished with on the spool and their parents updated. */
7971 for (addr = handled_addr; addr; addr = addr->next)
7973 address_done(addr, logtod);
7974 child_done(addr, logtod);
7976 /* Panic-dies on error */
7977 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7983 f.disable_logging = FALSE; /* In case left set */
7985 /* Come here from the mua_wrapper case if routing goes wrong */
7989 /* If there are now no deferred addresses, we are done. Preserve the
7990 message log if so configured, and we are using them. Otherwise, sling it.
7991 Then delete the message itself. */
7999 fname = spool_fname(US"msglog", message_subdir, id, US"");
8000 if (preserve_message_logs)
8003 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8005 if ((rc = Urename(fname, moname)) < 0)
8007 (void)directory_make(spool_directory,
8008 spool_sname(US"msglog.OLD", US""),
8009 MSGLOG_DIRECTORY_MODE, TRUE);
8010 rc = Urename(fname, moname);
8013 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8014 "msglog.OLD directory", fname);
8017 if (Uunlink(fname) < 0)
8018 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8019 fname, strerror(errno));
8022 /* Remove the two message files. */
8024 fname = spool_fname(US"input", message_subdir, id, US"-D");
8025 if (Uunlink(fname) < 0)
8026 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8027 fname, strerror(errno));
8028 fname = spool_fname(US"input", message_subdir, id, US"-H");
8029 if (Uunlink(fname) < 0)
8030 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8031 fname, strerror(errno));
8033 /* Log the end of this message, with queue time if requested. */
8035 if (LOGGING(queue_time_overall))
8036 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8038 log_write(0, LOG_MAIN, "Completed");
8040 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8041 f.deliver_freeze = FALSE;
8043 #ifndef DISABLE_EVENT
8044 (void) event_raise(event_action, US"msg:complete", NULL);
8048 /* If there are deferred addresses, we are keeping this message because it is
8049 not yet completed. Lose any temporary files that were catching output from
8050 pipes for any of the deferred addresses, handle one-time aliases, and see if
8051 the message has been on the queue for so long that it is time to send a warning
8052 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8053 have the same domain, we can set deliver_domain for the expansion of
8054 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8055 the parent's domain.
8057 If all the deferred addresses have an error number that indicates "retry time
8058 not reached", skip sending the warning message, because it won't contain the
8059 reason for the delay. It will get sent at the next real delivery attempt.
8060 Exception: for retries caused by a remote peer we use the error message
8061 store in the retry DB as the reason.
8062 However, if at least one address has tried, we'd better include all of them in
8065 If we can't make a process to send the message, don't worry.
8067 For mailing list expansions we want to send the warning message to the
8068 mailing list manager. We can't do a perfect job here, as some addresses may
8069 have different errors addresses, but if we take the errors address from
8070 each deferred address it will probably be right in most cases.
8072 If addr_defer == +1, it means there was a problem sending an error message
8073 for failed addresses, and there were no "real" deferred addresses. The value
8074 was set just to keep the message on the spool, so there is nothing to do here.
8077 else if (addr_defer != (address_item *)(+1))
8079 uschar *recipients = US"";
8080 BOOL want_warning_msg = FALSE;
8082 deliver_domain = testflag(addr_defer, af_pfr)
8083 ? addr_defer->parent->domain : addr_defer->domain;
8085 for (address_item * addr = addr_defer; addr; addr = addr->next)
8087 address_item *otaddr;
8089 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8093 const uschar *d = testflag(addr, af_pfr)
8094 ? addr->parent->domain : addr->domain;
8096 /* The domain may be unset for an address that has never been routed
8097 because the system filter froze the message. */
8099 if (!d || Ustrcmp(d, deliver_domain) != 0)
8100 deliver_domain = NULL;
8103 if (addr->return_filename) Uunlink(addr->return_filename);
8105 /* Handle the case of one-time aliases. If any address in the ancestry
8106 of this one is flagged, ensure it is in the recipients list, suitably
8107 flagged, and that its parent is marked delivered. */
8109 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8110 if (otaddr->onetime_parent) break;
8115 int t = recipients_count;
8117 for (i = 0; i < recipients_count; i++)
8119 uschar *r = recipients_list[i].address;
8120 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8121 if (Ustrcmp(otaddr->address, r) == 0) break;
8124 /* Didn't find the address already in the list, and did find the
8125 ultimate parent's address in the list, and they really are different
8126 (i.e. not from an identity-redirect). After adding the recipient,
8127 update the errors address in the recipients list. */
8129 if ( i >= recipients_count && t < recipients_count
8130 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8132 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8133 otaddr->address, otaddr->parent->address);
8134 receive_add_recipient(otaddr->address, t);
8135 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8136 tree_add_nonrecipient(otaddr->parent->address);
8137 update_spool = TRUE;
8141 /* Except for error messages, ensure that either the errors address for
8142 this deferred address or, if there is none, the sender address, is on the
8143 list of recipients for a warning message. */
8145 if (sender_address[0])
8147 uschar * s = addr->prop.errors_address;
8148 if (!s) s = sender_address;
8149 if (Ustrstr(recipients, s) == NULL)
8150 recipients = string_sprintf("%s%s%s", recipients,
8151 recipients[0] ? "," : "", s);
8155 /* Send a warning message if the conditions are right. If the condition check
8156 fails because of a lookup defer, there is nothing we can do. The warning
8157 is not sent. Another attempt will be made at the next delivery attempt (if
8160 if ( !f.queue_2stage
8162 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8163 || addr_defer->dsn_flags & rf_notify_delay
8165 && delay_warning[1] > 0
8166 && sender_address[0] != 0
8167 && ( !delay_warning_condition
8168 || expand_check_condition(delay_warning_condition,
8169 US"delay_warning", US"option")
8175 int queue_time = time(NULL) - received_time.tv_sec;
8177 queue_time = test_harness_fudged_queue_time(queue_time);
8179 /* See how many warnings we should have sent by now */
8181 for (count = 0; count < delay_warning[1]; count++)
8182 if (queue_time < delay_warning[count+2]) break;
8184 show_time = delay_warning[count+1];
8186 if (count >= delay_warning[1])
8189 int last_gap = show_time;
8190 if (count > 1) last_gap -= delay_warning[count];
8191 extra = (queue_time - delay_warning[count+1])/last_gap;
8192 show_time += last_gap * extra;
8198 debug_printf("time on queue = %s id %s addr %s\n",
8199 readconf_printtime(queue_time), message_id, addr_defer->address);
8200 debug_printf("warning counts: required %d done %d\n", count,
8204 /* We have computed the number of warnings there should have been by now.
8205 If there haven't been enough, send one, and up the count to what it should
8208 if (warning_count < count)
8212 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8218 FILE * f = fdopen(fd, "wb");
8220 transport_ctx tctx = {{0}};
8222 if (warn_message_file)
8223 wmf = expand_open(warn_message_file,
8224 US"warn_message_file", US"warning");
8226 warnmsg_recipients = recipients;
8227 warnmsg_delay = queue_time < 120*60
8228 ? string_sprintf("%d minutes", show_time/60)
8229 : string_sprintf("%d hours", show_time/3600);
8231 if (errors_reply_to)
8232 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8233 fprintf(f, "Auto-Submitted: auto-replied\n");
8235 fprintf(f, "To: %s\n", recipients);
8236 moan_write_references(f, NULL);
8238 /* generated boundary string and output MIME-Headers */
8239 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8241 fprintf(f, "Content-Type: multipart/report;"
8242 " report-type=delivery-status; boundary=%s\n"
8243 "MIME-Version: 1.0\n",
8246 if ((wmf_text = next_emf(wmf, US"header")))
8247 fprintf(f, "%s\n", wmf_text);
8249 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8250 message_id, warnmsg_delay);
8252 /* output human readable part as text/plain section */
8254 "Content-type: text/plain; charset=us-ascii\n\n",
8257 if ((wmf_text = next_emf(wmf, US"intro")))
8258 fprintf(f, "%s", CS wmf_text);
8262 "This message was created automatically by mail delivery software.\n");
8264 if (Ustrcmp(recipients, sender_address) == 0)
8266 "A message that you sent has not yet been delivered to one or more of its\n"
8267 "recipients after more than ");
8271 "A message sent by\n\n <%s>\n\n"
8272 "has not yet been delivered to one or more of its recipients after more than \n",
8275 fprintf(f, "%s on the queue on %s.\n\n"
8276 "The message identifier is: %s\n",
8277 warnmsg_delay, primary_hostname, message_id);
8279 for (h = header_list; h; h = h->next)
8280 if (strncmpic(h->text, US"Subject:", 8) == 0)
8281 fprintf(f, "The subject of the message is: %s", h->text + 9);
8282 else if (strncmpic(h->text, US"Date:", 5) == 0)
8283 fprintf(f, "The date of the message is: %s", h->text + 6);
8286 fprintf(f, "The address%s to which the message has not yet been "
8288 !addr_defer->next ? "" : "es",
8289 !addr_defer->next ? "is": "are");
8292 /* List the addresses, with error information if allowed */
8295 for (address_item * addr = addr_defer; addr; addr = addr->next)
8297 if (print_address_information(addr, f, US" ", US"\n ", US""))
8298 print_address_error(addr, f, US"Delay reason: ");
8307 if ((wmf_text = next_emf(wmf, US"final")))
8308 fprintf(f, "%s", CS wmf_text);
8314 "No action is required on your part. Delivery attempts will continue for\n"
8315 "some time, and this warning may be repeated at intervals if the message\n"
8316 "remains undelivered. Eventually the mail delivery software will give up,\n"
8317 "and when that happens, the message will be returned to you.\n");
8320 /* output machine readable part */
8321 fprintf(f, "\n--%s\n"
8322 "Content-type: message/delivery-status\n\n"
8323 "Reporting-MTA: dns; %s\n",
8325 smtp_active_hostname);
8330 /* must be decoded from xtext: see RFC 3461:6.3a */
8332 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8333 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8335 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8339 for (address_item * addr = addr_defer; addr; addr = addr->next)
8343 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8345 if ((hu = addr->host_used) && hu->name)
8347 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8348 print_dsn_diagnostic_code(addr, f);
8354 "Content-type: text/rfc822-headers\n\n",
8358 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8359 tctx.u.fd = fileno(f);
8360 tctx.options = topt_add_return_path | topt_no_body;
8361 transport_filter_argv = NULL; /* Just in case */
8362 return_path = sender_address; /* In case not previously set */
8364 /* Write the original email out */
8365 /*XXX no checking for failure! buggy! */
8366 transport_write_message(&tctx, 0);
8369 fprintf(f,"\n--%s--\n", bound);
8373 /* Close and wait for child process to complete, without a timeout.
8374 If there's an error, don't update the count. */
8377 if (child_close(pid, 0) == 0)
8379 warning_count = count;
8380 update_spool = TRUE; /* Ensure spool rewritten */
8386 /* Clear deliver_domain */
8388 deliver_domain = NULL;
8390 /* If this was a first delivery attempt, unset the first time flag, and
8391 ensure that the spool gets updated. */
8393 if (f.deliver_firsttime)
8395 f.deliver_firsttime = FALSE;
8396 update_spool = TRUE;
8399 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8400 message, unless the message is a local error message (to avoid loops). Then
8401 log the freezing. If the text in "frozen_info" came from a system filter,
8402 it has been escaped into printing characters so as not to mess up log lines.
8403 For the "tell" message, we turn \n back into newline. Also, insert a newline
8404 near the start instead of the ": " string. */
8406 if (f.deliver_freeze)
8408 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8410 uschar *s = string_copy(frozen_info);
8411 uschar *ss = Ustrstr(s, " by the system filter: ");
8422 if (*ss == '\\' && ss[1] == 'n')
8429 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8430 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8434 /* Log freezing just before we update the -H file, to minimize the chance
8435 of a race problem. */
8437 deliver_msglog("*** Frozen%s\n", frozen_info);
8438 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8441 /* If there have been any updates to the non-recipients list, or other things
8442 that get written to the spool, we must now update the spool header file so
8443 that it has the right information for the next delivery attempt. If there
8444 was more than one address being delivered, the header_change update is done
8445 earlier, in case one succeeds and then something crashes. */
8448 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8449 update_spool, f.header_rewritten);
8451 if (update_spool || f.header_rewritten)
8452 /* Panic-dies on error */
8453 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8456 /* Finished with the message log. If the message is complete, it will have
8457 been unlinked or renamed above. */
8459 if (message_logs) (void)fclose(message_log);
8461 /* Now we can close and remove the journal file. Its only purpose is to record
8462 successfully completed deliveries asap so that this information doesn't get
8463 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8464 not serious, as trying it again is not harmful. The journal might not be open
8465 if all addresses were deferred at routing or directing. Nevertheless, we must
8466 remove it if it exists (may have been lying around from a crash during the
8467 previous delivery attempt). We don't remove the journal if a delivery
8468 subprocess failed to pass back delivery information; this is controlled by
8469 the remove_journal flag. When the journal is left, we also don't move the
8470 message off the main spool if frozen and the option is set. It should get moved
8471 at the next attempt, after the journal has been inspected. */
8473 if (journal_fd >= 0) (void)close(journal_fd);
8477 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8479 if (Uunlink(fname) < 0 && errno != ENOENT)
8480 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8483 /* Move the message off the spool if requested */
8485 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8486 if (f.deliver_freeze && move_frozen_messages)
8487 (void)spool_move_message(id, message_subdir, US"", US"F");
8491 /* Closing the data file frees the lock; if the file has been unlinked it
8492 will go away. Otherwise the message becomes available for another process
8495 (void)close(deliver_datafile);
8496 deliver_datafile = -1;
8497 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8498 #ifdef MEASURE_TIMING
8499 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8502 /* It is unlikely that there will be any cached resources, since they are
8503 released after routing, and in the delivery subprocesses. However, it's
8504 possible for an expansion for something afterwards (for example,
8505 expand_check_condition) to do a lookup. We must therefore be sure everything is
8509 acl_where = ACL_WHERE_UNKNOWN;
8518 #ifdef EXIM_TFO_PROBE
8521 f.tcp_fastopen_ok = TRUE;
8527 deliver_get_sender_address (uschar * id)
8530 uschar * new_sender_address,
8531 * save_sender_address;
8532 BOOL save_qr = f.queue_running;
8535 /* make spool_open_datafile non-noisy on fail */
8537 f.queue_running = TRUE;
8539 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8541 deliver_datafile = spool_open_datafile(id);
8542 f.queue_running = save_qr;
8543 if (deliver_datafile < 0)
8546 /* Save and restore the global sender_address. I'm not sure if we should
8547 not save/restore all the other global variables too, because
8548 spool_read_header() may change all of them. But OTOH, when this
8549 deliver_get_sender_address() gets called, the current message is done
8550 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8552 spoolname = string_sprintf("%s-H", id);
8553 save_sender_address = sender_address;
8555 rc = spool_read_header(spoolname, TRUE, TRUE);
8557 new_sender_address = sender_address;
8558 sender_address = save_sender_address;
8560 if (rc != spool_read_OK)
8563 assert(new_sender_address);
8565 (void)close(deliver_datafile);
8566 deliver_datafile = -1;
8568 return new_sender_address;
8574 delivery_re_exec(int exec_type)
8578 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8580 int channel_fd = cutthrough.cctx.sock;
8582 smtp_peer_options = cutthrough.peer_options;
8583 continue_sequence = 0;
8586 if (cutthrough.is_tls)
8590 smtp_peer_options |= OPTION_TLS;
8591 sending_ip_address = cutthrough.snd_ip;
8592 sending_port = cutthrough.snd_port;
8594 where = US"socketpair";
8595 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8599 testharness_pause_ms(150);
8600 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8603 if (pid == 0) /* child: will fork again to totally disconnect */
8605 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8607 /* does not return */
8611 waitpid(pid, NULL, 0);
8612 (void) close(channel_fd); /* release the client socket */
8613 channel_fd = pfd[1];
8617 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8618 cutthrough.host.address, message_id, channel_fd);
8622 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8623 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8625 return; /* compiler quietening; control does not reach here. */
8630 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8631 "delivery re-exec %s failed: %s", where, strerror(errno));
8633 /* Get here if exec_type == CEE_EXEC_EXIT.
8634 Note: this must be _exit(), not exit(). */
8636 _exit(EX_EXECFAILED);
8642 /* End of deliver.c */