1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* The main code for delivering a message. */
14 #include "transports/smtp.h"
19 /* Data block for keeping track of subprocesses for parallel remote
22 typedef struct pardata {
23 address_item *addrlist; /* chain of addresses */
24 address_item *addr; /* next address data expected for */
25 pid_t pid; /* subprocess pid */
26 int fd; /* pipe fd for getting result from subprocess */
27 int transport_count; /* returned transport count value */
28 BOOL done; /* no more data needed */
29 uschar *msg; /* error message */
30 const uschar *return_path; /* return_path for these addresses */
33 /* Values for the process_recipients variable */
35 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
36 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
39 /* Mutually recursive functions for marking addresses done. */
41 static void child_done(address_item *, const uschar *);
42 static void address_done(address_item *, const uschar *);
44 /* Table for turning base-62 numbers into binary */
46 static uschar tab62[] =
47 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
48 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
49 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
50 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
51 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
52 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
56 /*************************************************
57 * Local static variables *
58 *************************************************/
60 /* addr_duplicate is global because it needs to be seen from the Envelope-To
63 static address_item *addr_defer = NULL;
64 static address_item *addr_failed = NULL;
65 static address_item *addr_fallback = NULL;
66 static address_item *addr_local = NULL;
67 static address_item *addr_new = NULL;
68 static address_item *addr_remote = NULL;
69 static address_item *addr_route = NULL;
70 static address_item *addr_succeed = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static struct pollfd *parpoll;
78 static int return_count;
79 static uschar *frozen_info = US"";
80 static const uschar * used_return_path = NULL;
84 /*************************************************
85 * read as much as requested *
86 *************************************************/
88 /* The syscall read(2) doesn't always returns as much as we want. For
89 several reasons it might get less. (Not talking about signals, as syscalls
90 are restartable). When reading from a network or pipe connection the sender
91 might send in smaller chunks, with delays between these chunks. The read(2)
92 may return such a chunk.
94 The more the writer writes and the smaller the pipe between write and read is,
95 the more we get the chance of reading leass than requested. (See bug 2130)
97 This function read(2)s until we got all the data we *requested*.
99 Note: This function may block. Use it only if you're sure about the
100 amount of data you will get.
103 fd the file descriptor to read from
104 buffer pointer to a buffer of size len
105 len the requested(!) amount of bytes
107 Returns: the amount of bytes read
110 readn(int fd, void * buffer, size_t len)
112 uschar * next = buffer;
113 uschar * end = next + len;
117 ssize_t got = read(fd, next, end - next);
119 /* I'm not sure if there are signals that can interrupt us,
120 for now I assume the worst */
121 if (got == -1 && errno == EINTR) continue;
122 if (got <= 0) return next - US buffer;
130 /*************************************************
131 * Make a new address item *
132 *************************************************/
134 /* This function gets the store and initializes with default values. The
135 transport_return value defaults to DEFER, so that any unexpected failure to
136 deliver does not wipe out the message. The default unique string is set to a
137 copy of the address, so that its domain can be lowercased.
140 address the RFC822 address string
141 copy force a copy of the address
143 Returns: a pointer to an initialized address_item
147 deliver_make_addr(const uschar * address, BOOL copy)
149 address_item * addr = store_get(sizeof(address_item), GET_UNTAINTED);
150 *addr = address_defaults;
151 if (copy) address = string_copy(address);
152 addr->address = address;
153 addr->unique = string_copy(address);
160 /*************************************************
161 * Set expansion values for an address *
162 *************************************************/
164 /* Certain expansion variables are valid only when handling an address or
165 address list. This function sets them up or clears the values, according to its
169 addr the address in question, or NULL to clear values
174 deliver_set_expansions(address_item *addr)
178 const uschar ***p = address_expansions;
179 while (*p) **p++ = NULL;
183 /* Exactly what gets set depends on whether there is one or more addresses, and
184 what they contain. These first ones are always set, taking their values from
185 the first address. */
187 if (!addr->host_list)
189 deliver_host = deliver_host_address = US"";
190 deliver_host_port = 0;
194 deliver_host = addr->host_list->name;
195 deliver_host_address = addr->host_list->address;
196 deliver_host_port = addr->host_list->port;
199 deliver_recipients = addr;
200 deliver_address_data = addr->prop.address_data;
201 deliver_domain_data = addr->prop.domain_data;
202 deliver_localpart_data = addr->prop.localpart_data;
203 router_var = addr->prop.variables;
205 /* These may be unset for multiple addresses */
207 deliver_domain = addr->domain;
208 self_hostname = addr->self_hostname;
210 #ifdef EXPERIMENTAL_BRIGHTMAIL
211 bmi_deliver = 1; /* deliver by default */
212 bmi_alt_location = NULL;
213 bmi_base64_verdict = NULL;
214 bmi_base64_tracker_verdict = NULL;
217 /* If there's only one address we can set everything. */
221 address_item *addr_orig;
223 deliver_localpart = addr->local_part;
224 deliver_localpart_prefix = addr->prefix;
225 deliver_localpart_prefix_v = addr->prefix_v;
226 deliver_localpart_suffix = addr->suffix;
227 deliver_localpart_suffix_v = addr->suffix_v;
229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230 deliver_domain_orig = addr_orig->domain;
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
251 deliver_domain_parent = addr->parent->domain;
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
261 if (testflag(addr, af_pfr))
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
267 deliver_localpart_prefix_v = addr->parent->prefix_v;
268 deliver_localpart_suffix = addr->parent->suffix;
269 deliver_localpart_suffix_v = addr->parent->suffix_v;
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
280 if (bmi_deliver == 1)
281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
293 if (testflag(addr, af_pfr))
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301 deliver_domain = NULL;
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
306 self_hostname = NULL;
307 if (!deliver_domain && !self_hostname) break;
315 /*************************************************
316 * Open a msglog file *
317 *************************************************/
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
324 Called from deliver_message(), can be operating as root.
327 filename the file name
328 mode the mode required
329 error used for saying what failed
331 Returns: a file descriptor, or -1 (with errno set)
335 open_msglog_file(uschar *filename, int mode, uschar **error)
337 if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
341 for (int i = 2; i > 0; i--)
343 int fd = Uopen(filename,
344 EXIM_CLOEXEC | EXIM_NOFOLLOW | O_WRONLY|O_APPEND|O_CREAT, mode);
347 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
348 function is called as root). Double check the mode, because the group setting
349 doesn't always get set automatically. */
352 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
354 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
359 if (fchmod(fd, mode) < 0)
369 (void)directory_make(spool_directory,
370 spool_sname(US"msglog", message_subdir),
371 MSGLOG_DIRECTORY_MODE, TRUE);
374 *error = US"create or open";
381 /*************************************************
382 * Write to msglog if required *
383 *************************************************/
385 /* Write to the message log, if configured. This function may also be called
389 format a string format
395 deliver_msglog(const char *format, ...)
398 if (!message_logs) return;
399 va_start(ap, format);
400 vfprintf(message_log, format, ap);
408 /*************************************************
409 * Replicate status for batch *
410 *************************************************/
412 /* When a transport handles a batch of addresses, it may treat them
413 individually, or it may just put the status in the first one, and return FALSE,
414 requesting that the status be copied to all the others externally. This is the
415 replication function. As well as the status, it copies the transport pointer,
416 which may have changed if appendfile passed the addresses on to a different
419 Argument: pointer to the first address in a chain
424 replicate_status(address_item *addr)
426 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
428 addr2->transport = addr->transport;
429 addr2->transport_return = addr->transport_return;
430 addr2->basic_errno = addr->basic_errno;
431 addr2->more_errno = addr->more_errno;
432 addr2->delivery_time = addr->delivery_time;
433 addr2->special_action = addr->special_action;
434 addr2->message = addr->message;
435 addr2->user_message = addr->user_message;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
458 We do not try to batch up different A-record host names that refer to the
462 one points to the first host list
463 two points to the second host list
465 Returns: TRUE if the lists refer to the same host set
469 same_hosts(host_item *one, host_item *two)
473 if (Ustrcmp(one->name, two->name) != 0)
476 host_item *end_one = one;
477 host_item *end_two = two;
479 /* Batch up only if there was no MX and the list was not randomized */
481 if (mx == MX_NONE) return FALSE;
483 /* Find the ends of the shortest sequence of identical MX values */
485 while ( end_one->next && end_one->next->mx == mx
486 && end_two->next && end_two->next->mx == mx)
488 end_one = end_one->next;
489 end_two = end_two->next;
492 /* If there aren't any duplicates, there's no match. */
494 if (end_one == one) return FALSE;
496 /* For each host in the 'one' sequence, check that it appears in the 'two'
497 sequence, returning FALSE if not. */
502 for (hi = two; hi != end_two->next; hi = hi->next)
503 if (Ustrcmp(one->name, hi->name) == 0) break;
504 if (hi == end_two->next) return FALSE;
505 if (one == end_one) break;
509 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
510 Ensure both are pointing at the last host, and carry on as for equality. */
515 /* if the names matched but ports do not, mismatch */
516 else if (one->port != two->port)
520 /* DNSSEC equality */
521 if (one->dnssec != two->dnssec) return FALSE;
529 /* True if both are NULL */
536 /*************************************************
537 * Compare header lines *
538 *************************************************/
540 /* This function is given two pointers to chains of header items, and it yields
541 TRUE if they are the same header texts in the same order.
544 one points to the first header list
545 two points to the second header list
547 Returns: TRUE if the lists refer to the same header set
551 same_headers(header_line *one, header_line *two)
553 for (;; one = one->next, two = two->next)
555 if (one == two) return TRUE; /* Includes the case where both NULL */
556 if (!one || !two) return FALSE;
557 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
563 /*************************************************
564 * Compare string settings *
565 *************************************************/
567 /* This function is given two pointers to strings, and it returns
568 TRUE if they are the same pointer, or if the two strings are the same.
571 one points to the first string
572 two points to the second string
574 Returns: TRUE or FALSE
578 same_strings(const uschar * one, const uschar * two)
580 if (one == two) return TRUE; /* Includes the case where both NULL */
581 if (!one || !two) return FALSE;
582 return (Ustrcmp(one, two) == 0);
587 /*************************************************
588 * Compare uid/gid for addresses *
589 *************************************************/
591 /* This function is given a transport and two addresses. It yields TRUE if the
592 uid/gid/initgroups settings for the two addresses are going to be the same when
597 addr1 the first address
598 addr2 the second address
600 Returns: TRUE or FALSE
604 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
606 if ( !tp->uid_set && !tp->expand_uid
607 && !tp->deliver_as_creator
608 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
609 || ( testflag(addr1, af_uid_set)
610 && ( addr1->uid != addr2->uid
611 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
615 if ( !tp->gid_set && !tp->expand_gid
616 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
617 || ( testflag(addr1, af_gid_set)
618 && addr1->gid != addr2->gid
628 /*************************************************
629 * Record that an address is complete *
630 *************************************************/
632 /* This function records that an address is complete. This is straightforward
633 for most addresses, where the unique address is just the full address with the
634 domain lower cased. For homonyms (addresses that are the same as one of their
635 ancestors) their are complications. Their unique addresses have \x\ prepended
636 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
639 Exim used to record the unique addresses of homonyms as "complete". This,
640 however, fails when the pattern of redirection varies over time (e.g. if taking
641 unseen copies at only some times of day) because the prepended numbers may vary
642 from one delivery run to the next. This problem is solved by never recording
643 prepended unique addresses as complete. Instead, when a homonymic address has
644 actually been delivered via a transport, we record its basic unique address
645 followed by the name of the transport. This is checked in subsequent delivery
646 runs whenever an address is routed to a transport.
648 If the completed address is a top-level one (has no parent, which means it
649 cannot be homonymic) we also add the original address to the non-recipients
650 tree, so that it gets recorded in the spool file and therefore appears as
651 "done" in any spool listings. The original address may differ from the unique
652 address in the case of the domain.
654 Finally, this function scans the list of duplicates, marks as done any that
655 match this address, and calls child_done() for their ancestors.
658 addr address item that has been completed
659 now current time as a string
665 address_done(address_item * addr, const uschar * now)
667 update_spool = TRUE; /* Ensure spool gets updated */
669 /* Top-level address */
673 tree_add_nonrecipient(addr->unique);
674 tree_add_nonrecipient(addr->address);
677 /* Homonymous child address */
679 else if (testflag(addr, af_homonym))
682 tree_add_nonrecipient(
683 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
686 /* Non-homonymous child address */
688 else tree_add_nonrecipient(addr->unique);
690 /* Check the list of duplicate addresses and ensure they are now marked
693 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
694 if (Ustrcmp(addr->unique, dup->unique) == 0)
696 tree_add_nonrecipient(dup->unique);
697 child_done(dup, now);
704 /*************************************************
705 * Decrease counts in parents and mark done *
706 *************************************************/
708 /* This function is called when an address is complete. If there is a parent
709 address, its count of children is decremented. If there are still other
710 children outstanding, the function exits. Otherwise, if the count has become
711 zero, address_done() is called to mark the parent and its duplicates complete.
712 Then loop for any earlier ancestors.
715 addr points to the completed address item
716 now the current time as a string, for writing to the message log
722 child_done(address_item * addr, const uschar * now)
729 if (--addr->child_count > 0) return; /* Incomplete parent */
730 address_done(addr, now);
732 /* Log the completion of all descendents only when there is no ancestor with
733 the same original address. */
735 for (aa = addr->parent; aa; aa = aa->parent)
736 if (Ustrcmp(aa->address, addr->address) == 0) break;
739 deliver_msglog("%s %s: children all complete\n", now, addr->address);
740 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
746 /*************************************************
747 * Delivery logging support functions *
748 *************************************************/
750 /* The LOGGING() checks in d_log_interface() are complicated for backwards
751 compatibility. When outgoing interface logging was originally added, it was
752 conditional on just incoming_interface (which is off by default). The
753 outgoing_interface option is on by default to preserve this behaviour, but
754 you can enable incoming_interface and disable outgoing_interface to get I=
755 fields on incoming lines only.
759 addr The address to be logged
761 Returns: New value for s
765 d_log_interface(gstring * g)
767 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
768 && sending_ip_address)
770 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
771 if (LOGGING(outgoing_port))
772 g = string_fmt_append(g, ":%d", sending_port);
780 d_hostlog(gstring * g, address_item * addr)
782 host_item * h = addr->host_used;
784 g = string_append(g, 2, US" H=", h->name);
786 if (LOGGING(dnssec) && h->dnssec == DS_YES)
787 g = string_catn(g, US" DS", 3);
789 g = string_append(g, 3, US" [", h->address, US"]");
791 if (LOGGING(outgoing_port))
792 g = string_fmt_append(g, ":%d", h->port);
794 if (continue_sequence > 1) /*XXX this is wrong for a dropped proxyconn. Would have to pass back from transport */
795 g = string_catn(g, US"*", 1);
798 if (LOGGING(proxy) && proxy_local_address)
800 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
801 if (LOGGING(outgoing_port))
802 g = string_fmt_append(g, ":%d", proxy_local_port);
806 g = d_log_interface(g);
808 if (testflag(addr, af_tcp_fastopen))
809 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
820 d_tlslog(gstring * g, address_item * addr)
822 if (LOGGING(tls_cipher) && addr->cipher)
824 g = string_append(g, 2, US" X=", addr->cipher);
825 #ifndef DISABLE_TLS_RESUME
826 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
827 g = string_catn(g, US"*", 1);
830 if (LOGGING(tls_certificate_verified) && addr->cipher)
831 g = string_append(g, 2, US" CV=",
832 testflag(addr, af_cert_verified)
835 testflag(addr, af_dane_verified)
841 if (LOGGING(tls_peerdn) && addr->peerdn)
842 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
850 #ifndef DISABLE_EVENT
851 /* Distribute a named event to any listeners.
853 Args: action config option specifying listener
854 event name of the event
855 ev_data associated data for the event
856 errnop pointer to errno for modification, or null
858 Return: string expansion from listener, or NULL
862 event_raise(const uschar * action, const uschar * event, const uschar * ev_data,
869 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
871 action, deliver_host_address);
874 event_data = ev_data;
876 if (!(s = expand_cstring(action)) && *expand_string_message)
877 log_write(0, LOG_MAIN|LOG_PANIC,
878 "failed to expand event_action %s in %s: %s\n",
879 event, transport_name ? transport_name : US"main", expand_string_message);
881 event_name = event_data = NULL;
883 /* If the expansion returns anything but an empty string, flag for
884 the caller to modify his normal processing. Copy the string to
890 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
892 *errnop = ERRNO_EVENT;
893 return string_copy(s);
900 msg_event_raise(const uschar * event, const address_item * addr)
902 const uschar * save_domain = deliver_domain;
903 const uschar * save_local = deliver_localpart;
904 const uschar * save_host = deliver_host;
905 const uschar * save_address = deliver_host_address;
906 const int save_port = deliver_host_port;
908 router_name = addr->router ? addr->router->name : NULL;
909 deliver_domain = addr->domain;
910 deliver_localpart = addr->local_part;
911 deliver_host = addr->host_used ? addr->host_used->name : NULL;
913 if (!addr->transport)
915 if (Ustrcmp(event, "msg:fail:delivery") == 0)
917 /* An address failed with no transport involved. This happens when
918 a filter was used which triggered a fail command (in such a case
919 a transport isn't needed). Convert it to an internal fail event. */
921 (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
926 transport_name = addr->transport->name;
928 (void) event_raise(addr->transport->event_action, event,
930 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
931 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
932 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
933 ? addr->message : NULL,
937 deliver_host_port = save_port;
938 deliver_host_address = save_address;
939 deliver_host = save_host;
940 deliver_localpart = save_local;
941 deliver_domain = save_domain;
942 router_name = transport_name = NULL;
944 #endif /*DISABLE_EVENT*/
948 /******************************************************************************/
951 /*************************************************
952 * Generate local part for logging *
953 *************************************************/
955 static const uschar *
956 string_get_lpart_sub(const address_item * addr, const uschar * s)
959 if (testflag(addr, af_utf8_downcvt))
961 const uschar * t = string_localpart_utf8_to_alabel(s, NULL);
962 return t ? t : s; /* t is NULL on a failed conversion */
968 /* This function is a subroutine for use in string_log_address() below.
971 addr the address being logged
972 yield the current dynamic buffer pointer
974 Returns: the new value of the buffer pointer
978 string_get_localpart(address_item * addr, gstring * yield)
982 if (testflag(addr, af_include_affixes) && (s = addr->prefix))
983 yield = string_cat(yield, string_get_lpart_sub(addr, s));
985 yield = string_cat(yield, string_get_lpart_sub(addr, addr->local_part));
987 if (testflag(addr, af_include_affixes) && (s = addr->suffix))
988 yield = string_cat(yield, string_get_lpart_sub(addr, s));
994 /*************************************************
995 * Generate log address list *
996 *************************************************/
998 /* This function generates a list consisting of an address and its parents, for
999 use in logging lines. For saved onetime aliased addresses, the onetime parent
1000 field is used. If the address was delivered by a transport with rcpt_include_
1001 affixes set, the af_include_affixes bit will be set in the address. In that
1002 case, we include the affixes here too.
1005 g points to growing-string struct
1006 addr bottom (ultimate) address
1007 all_parents if TRUE, include all parents
1008 success TRUE for successful delivery
1010 Returns: a growable string in dynamic store
1014 string_log_address(gstring * g,
1015 address_item *addr, BOOL all_parents, BOOL success)
1017 BOOL add_topaddr = TRUE;
1018 address_item *topaddr;
1020 /* Find the ultimate parent */
1022 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1024 /* We start with just the local part for pipe, file, and reply deliveries, and
1025 for successful local deliveries from routers that have the log_as_local flag
1026 set. File deliveries from filters can be specified as non-absolute paths in
1027 cases where the transport is going to complete the path. If there is an error
1028 before this happens (expansion failure) the local part will not be updated, and
1029 so won't necessarily look like a path. Add extra text for this case. */
1031 if ( testflag(addr, af_pfr)
1033 && addr->router && addr->router->log_as_local
1034 && addr->transport && addr->transport->info->local
1037 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1038 g = string_catn(g, CUS"save ", 5);
1039 g = string_get_localpart(addr, g);
1042 /* Other deliveries start with the full address. It we have split it into local
1043 part and domain, use those fields. Some early failures can happen before the
1044 splitting is done; in those cases use the original field. */
1049 int off = gstring_length(g); /* start of the "full address" */
1051 if (addr->local_part)
1054 g = string_get_localpart(addr, g);
1055 g = string_catn(g, US"@", 1);
1058 if (testflag(addr, af_utf8_downcvt))
1059 s = string_localpart_utf8_to_alabel(s, NULL);
1061 g = string_cat(g, s);
1064 g = string_cat(g, addr->address);
1066 /* If the address we are going to print is the same as the top address,
1067 and all parents are not being included, don't add on the top address. First
1068 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1069 on the local parts. */
1071 cmp = g->s + off; /* only now, as rebuffer likely done */
1072 string_from_gstring(g); /* ensure nul-terminated */
1073 if ( strcmpic(cmp, topaddr->address) == 0
1074 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1075 && !addr->onetime_parent
1076 && (!all_parents || !addr->parent || addr->parent == topaddr)
1078 add_topaddr = FALSE;
1081 /* If all parents are requested, or this is a local pipe/file/reply, and
1082 there is at least one intermediate parent, show it in brackets, and continue
1083 with all of them if all are wanted. */
1085 if ( (all_parents || testflag(addr, af_pfr))
1087 && addr->parent != topaddr)
1090 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1092 g = string_catn(g, s, 2);
1093 g = string_cat (g, addr2->address);
1094 if (!all_parents) break;
1097 g = string_catn(g, US")", 1);
1100 /* Add the top address if it is required */
1103 g = string_append(g, 3,
1105 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1113 /******************************************************************************/
1117 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1118 this is a nonstandard call; no two-character delivery flag is written
1119 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1122 flags passed to log_write()
1125 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1127 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1130 /* Log the delivery on the main log. We use an extensible string to build up
1131 the log line, and reset the store afterwards. Remote deliveries should always
1132 have a pointer to the host item that succeeded; local deliveries can have a
1133 pointer to a single host item in their host list, for use by the transport. */
1135 #ifndef DISABLE_EVENT
1136 /* presume no successful remote delivery */
1137 lookup_dnssec_authenticated = NULL;
1140 reset_point = store_mark();
1141 g = string_get_tainted(256, GET_TAINTED); /* addrs will be tainted, so avoid copy */
1144 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1147 g->s[0] = logchar; g->ptr = 1;
1148 g = string_catn(g, US"> ", 2);
1150 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1152 if (LOGGING(sender_on_delivery) || msg)
1153 g = string_append(g, 3, US" F=<",
1155 testflag(addr, af_utf8_downcvt)
1156 ? string_address_utf8_to_alabel(sender_address, NULL)
1163 g = string_append(g, 2, US" Q=", queue_name);
1165 /* You might think that the return path must always be set for a successful
1166 delivery; indeed, I did for some time, until this statement crashed. The case
1167 when it is not set is for a delivery to /dev/null which is optimised by not
1168 being run at all. */
1170 if (used_return_path && LOGGING(return_path_on_delivery))
1171 g = string_append(g, 3, US" P=<", used_return_path, US">");
1174 g = string_append(g, 2, US" ", msg);
1176 /* For a delivery from a system filter, there may not be a router */
1178 g = string_append(g, 2, US" R=", addr->router->name);
1180 g = string_append(g, 2, US" T=", addr->transport->name);
1182 if (LOGGING(delivery_size))
1183 g = string_fmt_append(g, " S=%d", transport_count);
1185 /* Local delivery */
1187 if (addr->transport->info->local)
1189 if (addr->host_list)
1190 g = string_append(g, 2, US" H=", addr->host_list->name);
1191 g = d_log_interface(g);
1192 if (addr->shadow_message)
1193 g = string_cat(g, addr->shadow_message);
1196 /* Remote delivery */
1200 if (addr->host_used)
1202 g = d_hostlog(g, addr);
1204 #ifndef DISABLE_EVENT
1205 deliver_host_address = addr->host_used->address;
1206 deliver_host_port = addr->host_used->port;
1207 deliver_host = addr->host_used->name;
1209 /* DNS lookup status */
1210 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1211 : addr->host_used->dnssec==DS_NO ? US"no"
1217 g = d_tlslog(g, addr);
1220 if (addr->authenticator)
1222 g = string_append(g, 2, US" A=", addr->authenticator);
1225 g = string_append(g, 2, US":", addr->auth_id);
1226 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1227 g = string_append(g, 2, US":", addr->auth_sndr);
1231 if (LOGGING(pipelining))
1233 if (testflag(addr, af_pipelining))
1234 g = string_catn(g, US" L", 2);
1235 #ifndef DISABLE_PIPE_CONNECT
1236 if (testflag(addr, af_early_pipe))
1237 g = string_catn(g, US"*", 1);
1241 #ifndef DISABLE_PRDR
1242 if (testflag(addr, af_prdr_used))
1243 g = string_catn(g, US" PRDR", 5);
1246 if (testflag(addr, af_chunking_used))
1247 g = string_catn(g, US" K", 2);
1250 #ifndef DISABLE_DKIM
1251 if (addr->dkim_used && LOGGING(dkim_verbose))
1253 g = string_catn(g, US" DKIM=", 6);
1254 g = string_cat(g, addr->dkim_used);
1258 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1260 if ( LOGGING(smtp_confirmation)
1262 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1265 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1266 uschar *p = big_buffer;
1267 uschar *ss = addr->message;
1269 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1271 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1276 g = string_append(g, 2, US" C=", big_buffer);
1279 /* Time on queue and actual time taken to deliver */
1281 if (LOGGING(queue_time))
1282 g = string_append(g, 2, US" QT=", string_timesince(
1283 LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1285 if (LOGGING(deliver_time))
1286 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1288 /* string_cat() always leaves room for the terminator. Release the
1289 store we used to build the line after writing it. */
1291 log_write(0, flags, "%Y", g);
1293 #ifndef DISABLE_EVENT
1294 if (!msg) msg_event_raise(US"msg:delivery", addr);
1297 store_reset(reset_point);
1304 deferral_log(address_item * addr, uschar * now,
1305 int logflags, uschar * driver_name, uschar * driver_kind)
1307 rmark reset_point = store_mark();
1308 gstring * g = string_get(256);
1310 /* Build up the line that is used for both the message log and the main
1313 /* Create the address string for logging. Must not do this earlier, because
1314 an OK result may be changed to FAIL when a pipe returns text. */
1316 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1319 g = string_append(g, 2, US" Q=", queue_name);
1321 /* Either driver_name contains something and driver_kind contains
1322 " router" or " transport" (note the leading space), or driver_name is
1323 a null string and driver_kind contains "routing" without the leading
1324 space, if all routing has been deferred. When a domain has been held,
1325 so nothing has been done at all, both variables contain null strings. */
1329 if (driver_kind[1] == 't' && addr->router)
1330 g = string_append(g, 2, US" R=", addr->router->name);
1331 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1333 else if (driver_kind)
1334 g = string_append(g, 2, US" ", driver_kind);
1336 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1338 if (addr->basic_errno > 0)
1339 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1341 if (addr->host_used)
1342 g = d_hostlog(g, addr);
1344 if (LOGGING(deliver_time))
1345 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1348 g = string_append(g, 2, US": ", addr->message);
1350 /* Log the deferment in the message log, but don't clutter it
1351 up with retry-time defers after the first delivery attempt. */
1353 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1354 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1356 /* Write the main log and reset the store.
1357 For errors of the type "retry time not reached" (also remotes skipped
1358 on queue run), logging is controlled by L_retry_defer. Note that this kind
1359 of error number is negative, and all the retry ones are less than any
1363 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1366 store_reset(reset_point);
1373 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1375 rmark reset_point = store_mark();
1376 gstring * g = string_get(256);
1378 #ifndef DISABLE_EVENT
1379 /* Message failures for which we will send a DSN get their event raised
1380 later so avoid doing it here. */
1382 if ( !addr->prop.ignore_error
1383 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1385 msg_event_raise(US"msg:fail:delivery", addr);
1388 /* Build up the log line for the message and main logs */
1390 /* Create the address string for logging. Must not do this earlier, because
1391 an OK result may be changed to FAIL when a pipe returns text. */
1393 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1395 if (LOGGING(sender_on_delivery))
1396 g = string_append(g, 3, US" F=<", sender_address, US">");
1399 g = string_append(g, 2, US" Q=", queue_name);
1401 /* Return path may not be set if no delivery actually happened */
1403 if (used_return_path && LOGGING(return_path_on_delivery))
1404 g = string_append(g, 3, US" P=<", used_return_path, US">");
1407 g = string_append(g, 2, US" R=", addr->router->name);
1408 if (addr->transport)
1409 g = string_append(g, 2, US" T=", addr->transport->name);
1411 if (addr->host_used)
1412 g = d_hostlog(g, addr);
1415 g = d_tlslog(g, addr);
1418 if (addr->basic_errno > 0)
1419 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1422 g = string_append(g, 2, US": ", addr->message);
1424 if (LOGGING(deliver_time))
1425 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1427 /* Do the logging. For the message log, "routing failed" for those cases,
1428 just to make it clearer. */
1431 deliver_msglog("%s %s failed for %.*s\n", now, driver_kind, g->ptr, g->s);
1433 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1435 log_write(0, LOG_MAIN, "** %Y", g);
1437 store_reset(reset_point);
1443 /*************************************************
1444 * Actions at the end of handling an address *
1445 *************************************************/
1447 /* This is a function for processing a single address when all that can be done
1448 with it has been done.
1451 addr points to the address block
1452 result the result of the delivery attempt
1453 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1454 driver_type indicates which type of driver (transport, or router) was last
1455 to process the address
1456 logchar '=' or '-' for use when logging deliveries with => or ->
1462 post_process_one(address_item * addr, int result, int logflags, int driver_type,
1465 uschar * now = tod_stamp(tod_log);
1466 uschar * driver_kind = NULL;
1467 uschar * driver_name = NULL;
1469 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1471 /* Set up driver kind and name for logging. Disable logging if the router or
1472 transport has disabled it. */
1474 if (driver_type == EXIM_DTYPE_TRANSPORT)
1476 if (addr->transport)
1478 driver_name = addr->transport->name;
1479 driver_kind = US" transport";
1480 f.disable_logging = addr->transport->disable_logging;
1482 else driver_kind = US"transporting";
1484 else if (driver_type == EXIM_DTYPE_ROUTER)
1488 driver_name = addr->router->name;
1489 driver_kind = US" router";
1490 f.disable_logging = addr->router->disable_logging;
1492 else driver_kind = US"routing";
1495 /* If there's an error message set, ensure that it contains only printing
1496 characters - it should, but occasionally things slip in and this at least
1497 stops the log format from getting wrecked. We also scan the message for an LDAP
1498 expansion item that has a password setting, and flatten the password. This is a
1499 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1500 malformed, it won't ever have gone near LDAP.) */
1504 const uschar * s = string_printing(addr->message);
1506 /* deconst cast ok as string_printing known to have alloc'n'copied */
1507 addr->message = expand_hide_passwords(US s);
1510 /* If we used a transport that has one of the "return_output" options set, and
1511 if it did in fact generate some output, then for return_output we treat the
1512 message as failed if it was not already set that way, so that the output gets
1513 returned to the sender, provided there is a sender to send it to. For
1514 return_fail_output, do this only if the delivery failed. Otherwise we just
1515 unlink the file, and remove the name so that if the delivery failed, we don't
1516 try to send back an empty or unwanted file. The log_output options operate only
1517 on a non-empty file.
1519 In any case, we close the message file, because we cannot afford to leave a
1520 file-descriptor for one address while processing (maybe very many) others. */
1522 if (addr->return_file >= 0 && addr->return_filename)
1524 BOOL return_output = FALSE;
1525 struct stat statbuf;
1526 (void)EXIMfsync(addr->return_file);
1528 /* If there is no output, do nothing. */
1530 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1532 transport_instance *tb = addr->transport;
1534 /* Handle logging options */
1537 || result == FAIL && tb->log_fail_output
1538 || result == DEFER && tb->log_defer_output
1542 FILE *f = Ufopen(addr->return_filename, "rb");
1544 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1545 "from %s transport: %s", addr->return_filename, tb->name,
1548 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1550 uschar *p = big_buffer + Ustrlen(big_buffer);
1552 while (p > big_buffer && isspace(p[-1])) p--;
1554 sp = string_printing(big_buffer);
1555 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1556 addr->address, tb->name, sp);
1561 /* Handle returning options, but only if there is an address to return
1564 if (sender_address[0] != 0 || addr->prop.errors_address)
1565 if (tb->return_output)
1567 addr->transport_return = result = FAIL;
1568 if (addr->basic_errno == 0 && !addr->message)
1569 addr->message = US"return message generated";
1570 return_output = TRUE;
1573 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1576 /* Get rid of the file unless it might be returned, but close it in
1581 Uunlink(addr->return_filename);
1582 addr->return_filename = NULL;
1583 addr->return_file = -1;
1586 (void)close(addr->return_file);
1589 /* Check if the transport notifed continue-conn status explicitly, and
1590 update our knowlege. */
1592 if (testflag(addr, af_new_conn)) continue_sequence = 1;
1593 else if (testflag(addr, af_cont_conn)) continue_sequence++;
1595 /* The success case happens only after delivery by a transport. */
1599 addr->next = addr_succeed;
1600 addr_succeed = addr;
1602 /* Call address_done() to ensure that we don't deliver to this address again,
1603 and write appropriate things to the message log. If it is a child address, we
1604 call child_done() to scan the ancestors and mark them complete if this is the
1605 last child to complete. */
1607 address_done(addr, now);
1608 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1611 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1612 driver_name, driver_kind);
1615 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1616 addr->parent->address, driver_name, driver_kind);
1617 child_done(addr, now);
1620 /* Certificates for logging (via events) */
1622 tls_out.ourcert = addr->ourcert;
1623 addr->ourcert = NULL;
1624 tls_out.peercert = addr->peercert;
1625 addr->peercert = NULL;
1627 tls_out.ver = addr->tlsver;
1628 tls_out.cipher = addr->cipher;
1629 tls_out.peerdn = addr->peerdn;
1630 tls_out.ocsp = addr->ocsp;
1631 # ifdef SUPPORT_DANE
1632 tls_out.dane_verified = testflag(addr, af_dane_verified);
1636 delivery_log(LOG_MAIN, addr, logchar, NULL);
1639 tls_free_cert(&tls_out.ourcert);
1640 tls_free_cert(&tls_out.peercert);
1642 tls_out.cipher = NULL;
1643 tls_out.peerdn = NULL;
1644 tls_out.ocsp = OCSP_NOT_REQ;
1645 # ifdef SUPPORT_DANE
1646 tls_out.dane_verified = FALSE;
1652 /* Soft failure, or local delivery process failed; freezing may be
1655 else if (result == DEFER || result == PANIC)
1657 if (result == PANIC) logflags |= LOG_PANIC;
1659 /* This puts them on the chain in reverse order. Do not change this, because
1660 the code for handling retries assumes that the one with the retry
1661 information is last. */
1663 addr->next = addr_defer;
1666 /* The only currently implemented special action is to freeze the
1667 message. Logging of this is done later, just before the -H file is
1670 if (addr->special_action == SPECIAL_FREEZE)
1672 f.deliver_freeze = TRUE;
1673 deliver_frozen_at = time(NULL);
1674 update_spool = TRUE;
1677 /* If doing a 2-stage queue run, we skip writing to either the message
1678 log or the main log for SMTP defers. */
1680 if (!f.queue_2stage || addr->basic_errno != 0)
1681 deferral_log(addr, now, logflags, driver_name, driver_kind);
1685 /* Hard failure. If there is an address to which an error message can be sent,
1686 put this address on the failed list. If not, put it on the deferred list and
1687 freeze the mail message for human attention. The latter action can also be
1688 explicitly requested by a router or transport. */
1692 /* If this is a delivery error, or a message for which no replies are
1693 wanted, and the message's age is greater than ignore_bounce_errors_after,
1694 force the af_ignore_error flag. This will cause the address to be discarded
1695 later (with a log entry). */
1697 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1698 addr->prop.ignore_error = TRUE;
1700 /* Freeze the message if requested, or if this is a bounce message (or other
1701 message with null sender) and this address does not have its own errors
1702 address. However, don't freeze if errors are being ignored. The actual code
1703 to ignore occurs later, instead of sending a message. Logging of freezing
1704 occurs later, just before writing the -H file. */
1706 if ( !addr->prop.ignore_error
1707 && ( addr->special_action == SPECIAL_FREEZE
1708 || (sender_address[0] == 0 && !addr->prop.errors_address)
1711 frozen_info = addr->special_action == SPECIAL_FREEZE
1713 : f.sender_local && !f.local_error_message
1714 ? US" (message created with -f <>)"
1715 : US" (delivery error message)";
1716 f.deliver_freeze = TRUE;
1717 deliver_frozen_at = time(NULL);
1718 update_spool = TRUE;
1720 /* The address is put on the defer rather than the failed queue, because
1721 the message is being retained. */
1723 addr->next = addr_defer;
1727 /* Don't put the address on the nonrecipients tree yet; wait until an
1728 error message has been successfully sent. */
1732 addr->next = addr_failed;
1736 failure_log(addr, driver_name ? NULL : driver_kind, now);
1739 /* Ensure logging is turned on again in all cases */
1741 f.disable_logging = FALSE;
1747 /*************************************************
1748 * Address-independent error *
1749 *************************************************/
1751 /* This function is called when there's an error that is not dependent on a
1752 particular address, such as an expansion string failure. It puts the error into
1753 all the addresses in a batch, logs the incident on the main and panic logs, and
1754 clears the expansions. It is mostly called from local_deliver(), but can be
1755 called for a remote delivery via findugid().
1758 logit TRUE if (MAIN+PANIC) logging required
1759 addr the first of the chain of addresses
1761 format format string for error message, or NULL if already set in addr
1762 ... arguments for the format
1768 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1770 addr->basic_errno = code;
1777 va_start(ap, format);
1778 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1780 addr->message = string_from_gstring(g);
1783 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1785 addr2->basic_errno = code;
1786 addr2->message = addr->message;
1789 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1790 deliver_set_expansions(NULL);
1796 /*************************************************
1797 * Check a "never users" list *
1798 *************************************************/
1800 /* This function is called to check whether a uid is on one of the two "never
1804 uid the uid to be checked
1805 nusers the list to be scanned; the first item in the list is the count
1807 Returns: TRUE if the uid is on the list
1811 check_never_users(uid_t uid, uid_t *nusers)
1813 if (!nusers) return FALSE;
1814 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1820 /*************************************************
1821 * Find uid and gid for a transport *
1822 *************************************************/
1824 /* This function is called for both local and remote deliveries, to find the
1825 uid/gid under which to run the delivery. The values are taken preferentially
1826 from the transport (either explicit or deliver_as_creator), then from the
1827 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1828 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1829 panic error is logged, and the function fails (which normally leads to delivery
1833 addr the address (possibly a chain)
1835 uidp pointer to uid field
1836 gidp pointer to gid field
1837 igfp pointer to the use_initgroups field
1839 Returns: FALSE if failed - error has been set in address(es)
1843 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1847 BOOL gid_set = FALSE;
1849 /* Default initgroups flag comes from the transport */
1851 *igfp = tp->initgroups;
1853 /* First see if there's a gid on the transport, either fixed or expandable.
1854 The expanding function always logs failure itself. */
1861 else if (tp->expand_gid)
1863 GET_OPTION("group");
1864 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1867 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1873 /* If the transport did not set a group, see if the router did. */
1875 if (!gid_set && testflag(addr, af_gid_set))
1881 /* Pick up a uid from the transport if one is set. */
1883 if (tp->uid_set) *uidp = tp->uid;
1885 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1886 it does not provide a passwd value from which a gid can be taken. */
1888 else if (tp->expand_uid)
1892 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1893 uidp, &(addr->message)))
1895 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1905 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1907 else if (tp->deliver_as_creator)
1909 *uidp = originator_uid;
1912 *gidp = originator_gid;
1917 /* Otherwise see if the address specifies the uid and if so, take it and its
1920 else if (testflag(addr, af_uid_set))
1923 *igfp = testflag(addr, af_initgroups);
1926 /* Nothing has specified the uid - default to the Exim user, and group if the
1939 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1940 defaulting to the Exim uid. In other words, if the configuration has specified
1941 a uid, it must also provide a gid. */
1945 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1946 "%s transport", tp->name);
1950 /* Check that the uid is not on the lists of banned uids that may not be used
1951 for delivery processes. */
1953 nuname = check_never_users(*uidp, never_users)
1955 : check_never_users(*uidp, fixed_never_users)
1956 ? US"fixed_never_users"
1960 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1961 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1973 /*************************************************
1974 * Check the size of a message for a transport *
1975 *************************************************/
1977 /* Checks that the message isn't too big for the selected transport.
1978 This is called only when it is known that the limit is set.
1982 addr the (first) address being delivered
1985 DEFER expansion failed or did not yield an integer
1986 FAIL message too big
1990 check_message_size(transport_instance *tp, address_item *addr)
1995 GET_OPTION("message_size_limit");
1996 deliver_set_expansions(addr);
1997 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1998 deliver_set_expansions(NULL);
2000 if (expand_string_message)
2003 addr->message = size_limit == -1
2004 ? string_sprintf("failed to expand message_size_limit "
2005 "in %s transport: %s", tp->name, expand_string_message)
2006 : string_sprintf("invalid message_size_limit "
2007 "in %s transport: %s", tp->name, expand_string_message);
2009 else if (size_limit > 0 && message_size > size_limit)
2013 string_sprintf("message is too big (transport limit = %d)",
2022 /*************************************************
2023 * Transport-time check for a previous delivery *
2024 *************************************************/
2026 /* Check that this base address hasn't previously been delivered to its routed
2027 transport. If it has been delivered, mark it done. The check is necessary at
2028 delivery time in order to handle homonymic addresses correctly in cases where
2029 the pattern of redirection changes between delivery attempts (so the unique
2030 fields change). Non-homonymic previous delivery is detected earlier, at routing
2031 time (which saves unnecessary routing).
2034 addr the address item
2035 testing TRUE if testing wanted only, without side effects
2037 Returns: TRUE if previously delivered by the transport
2041 previously_transported(address_item *addr, BOOL testing)
2043 uschar * s = string_sprintf("%s/%s",
2044 addr->unique + (testflag(addr, af_homonym) ? 3:0), addr->transport->name);
2046 if (tree_search(tree_nonrecipients, s) != 0)
2048 DEBUG(D_deliver|D_route|D_transport)
2049 debug_printf("%s was previously delivered (%s transport): discarded\n",
2050 addr->address, addr->transport->name);
2051 if (!testing) child_done(addr, tod_stamp(tod_log));
2060 /******************************************************
2061 * Check for a given header in a header string *
2062 ******************************************************/
2064 /* This function is used when generating quota warnings. The configuration may
2065 specify any header lines it likes in quota_warn_message. If certain of them are
2066 missing, defaults are inserted, so we need to be able to test for the presence
2070 hdr the required header name
2071 hstring the header string
2073 Returns: TRUE the header is in the string
2074 FALSE the header is not in the string
2078 contains_header(uschar *hdr, uschar *hstring)
2080 int len = Ustrlen(hdr);
2081 uschar *p = hstring;
2084 if (strncmpic(p, hdr, len) == 0)
2087 while (*p == ' ' || *p == '\t') p++;
2088 if (*p == ':') return TRUE;
2090 while (*p != 0 && *p != '\n') p++;
2091 if (*p == '\n') p++;
2099 /*************************************************
2100 * Perform a local delivery *
2101 *************************************************/
2103 /* Each local delivery is performed in a separate process which sets its
2104 uid and gid as specified. This is a safer way than simply changing and
2105 restoring using seteuid(); there is a body of opinion that seteuid()
2106 cannot be used safely. From release 4, Exim no longer makes any use of
2107 it for delivery. Besides, not all systems have seteuid().
2109 If the uid/gid are specified in the transport_instance, they are used; the
2110 transport initialization must ensure that either both or neither are set.
2111 Otherwise, the values associated with the address are used. If neither are set,
2112 it is a configuration error.
2114 The transport or the address may specify a home directory (transport over-
2115 rides), and if they do, this is set as $home. If neither have set a working
2116 directory, this value is used for that as well. Otherwise $home is left unset
2117 and the cwd is set to "/" - a directory that should be accessible to all users.
2119 Using a separate process makes it more complicated to get error information
2120 back. We use a pipe to pass the return code and also an error code and error
2121 text string back to the parent process.
2124 addr points to an address block for this delivery; for "normal" local
2125 deliveries this is the only address to be delivered, but for
2126 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2127 a number of addresses can be handled simultaneously, and in this
2128 case addr will point to a chain of addresses with the same
2131 shadowing TRUE if running a shadow transport; this causes output from pipes
2138 deliver_local(address_item *addr, BOOL shadowing)
2140 BOOL use_initgroups;
2143 int status, len, rc;
2146 uschar *working_directory;
2147 address_item *addr2;
2148 transport_instance *tp = addr->transport;
2150 /* Set up the return path from the errors or sender address. If the transport
2151 has its own return path setting, expand it and replace the existing value. */
2153 if(addr->prop.errors_address)
2154 return_path = addr->prop.errors_address;
2156 return_path = sender_address;
2158 GET_OPTION("return_path");
2159 if (tp->return_path)
2161 uschar * new_return_path = expand_string(tp->return_path);
2162 if (new_return_path)
2163 return_path = new_return_path;
2164 else if (!f.expand_string_forcedfail)
2166 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2167 US"Failed to expand return path \"%s\" in %s transport: %s",
2168 tp->return_path, tp->name, expand_string_message);
2173 /* For local deliveries, one at a time, the value used for logging can just be
2174 set directly, once and for all. */
2176 used_return_path = return_path;
2178 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2179 gets put into the address(es), and the expansions are unset, so we can just
2182 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2184 /* See if either the transport or the address specifies a home directory. A
2185 home directory set in the address may already be expanded; a flag is set to
2186 indicate that. In other cases we must expand it. */
2188 GET_OPTION("home_directory");
2189 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2190 || ( (deliver_home = addr->home_dir) /* Set in address and */
2191 && !testflag(addr, af_home_expanded) /* not expanded */
2194 uschar *rawhome = deliver_home;
2195 deliver_home = NULL; /* in case it contains $home */
2196 if (!(deliver_home = expand_string(rawhome)))
2198 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2199 "to expand for %s transport: %s", rawhome, tp->name,
2200 expand_string_message);
2203 if (*deliver_home != '/')
2205 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2206 "is not absolute for %s transport", deliver_home, tp->name);
2211 /* See if either the transport or the address specifies a current directory,
2212 and if so, expand it. If nothing is set, use the home directory, unless it is
2213 also unset in which case use "/", which is assumed to be a directory to which
2214 all users have access. It is necessary to be in a visible directory for some
2215 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2216 2.5) require this. */
2218 GET_OPTION("current_directory");
2219 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2220 if (working_directory)
2222 uschar *raw = working_directory;
2223 if (!(working_directory = expand_string(raw)))
2225 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2226 "failed to expand for %s transport: %s", raw, tp->name,
2227 expand_string_message);
2230 if (*working_directory != '/')
2232 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2233 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2237 else working_directory = deliver_home ? deliver_home : US"/";
2239 /* If one of the return_output flags is set on the transport, create and open a
2240 file in the message log directory for the transport to write its output onto.
2241 This is mainly used by pipe transports. The file needs to be unique to the
2242 address. This feature is not available for shadow transports. */
2245 && ( tp->return_output || tp->return_fail_output
2246 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2251 addr->return_filename =
2252 spool_fname(US"msglog", message_subdir, message_id,
2253 string_sprintf("-%d-%d", getpid(), return_count++));
2255 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2257 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2258 "to return message: %s", error, tp->name, strerror(errno));
2263 /* Create the pipe for inter-process communication. */
2267 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2272 /* Now fork the process to do the real work in the subprocess, but first
2273 ensure that all cached resources are freed so that the subprocess starts with
2274 a clean slate and doesn't interfere with the parent process. */
2278 if ((pid = exim_fork(US"delivery-local")) == 0)
2280 BOOL replicate = TRUE;
2282 /* Prevent core dumps, as we don't want them in users' home directories.
2283 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2284 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2285 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2286 complain if the error is "not supported".
2288 There are two scenarios where changing the max limit has an effect. In one,
2289 the user is using a .forward and invoking a command of their choice via pipe;
2290 for these, we do need the max limit to be 0 unless the admin chooses to
2291 permit an increased limit. In the other, the command is invoked directly by
2292 the transport and is under administrator control, thus being able to raise
2293 the limit aids in debugging. So there's no general always-right answer.
2295 Thus we inhibit core-dumps completely but let individual transports, while
2296 still root, re-raise the limits back up to aid debugging. We make the
2297 default be no core-dumps -- few enough people can use core dumps in
2298 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2305 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2307 # ifdef SETRLIMIT_NOT_SUPPORTED
2308 if (errno != ENOSYS && errno != ENOTSUP)
2310 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2315 /* Reset the random number generator, so different processes don't all
2316 have the same sequence. */
2320 /* If the transport has a setup entry, call this first, while still
2321 privileged. (Appendfile uses this to expand quota, for example, while
2322 able to read private files.) */
2324 if (addr->transport->setup)
2325 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2329 addr->transport_return = DEFER;
2333 addr->transport_return = PANIC;
2337 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2338 when the process becomes unprivileged, it won't be able to write to the
2339 process log. SIGHUP is ignored throughout exim, except when it is being
2342 signal(SIGINT, SIG_IGN);
2343 signal(SIGTERM, SIG_IGN);
2344 signal(SIGUSR1, SIG_IGN);
2346 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2347 half - for transports that exec things (e.g. pipe). Then set the required
2350 (void)close(pfd[pipe_read]);
2351 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2353 exim_setugid(uid, gid, use_initgroups,
2354 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2355 addr->address, addr->transport->name));
2359 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2360 for (address_item * batched = addr->next; batched; batched = batched->next)
2361 debug_printf("additional batched address: %s\n", batched->address);
2364 /* Set an appropriate working directory. */
2366 if (Uchdir(working_directory) < 0)
2368 addr->transport_return = DEFER;
2369 addr->basic_errno = errno;
2370 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2373 /* If successful, call the transport */
2378 set_process_info("delivering %s to %s using %s", message_id,
2379 addr->local_part, tp->name);
2381 /* Setting these globals in the subprocess means we need never clear them */
2383 transport_name = tp->name;
2384 if (addr->router) router_name = addr->router->name;
2385 driver_srcfile = tp->srcfile;
2386 driver_srcline = tp->srcline;
2388 /* If a transport filter has been specified, set up its argument list.
2389 Any errors will get put into the address, and FALSE yielded. */
2391 if (tp->filter_command)
2393 ok = transport_set_up_command(&transport_filter_argv,
2395 TSUC_EXPAND_ARGS, PANIC, addr, US"transport filter", NULL);
2396 transport_filter_timeout = tp->filter_timeout;
2398 else transport_filter_argv = NULL;
2402 debug_print_string(tp->debug_string);
2403 replicate = !(tp->info->code)(addr->transport, addr);
2407 /* Pass the results back down the pipe. If necessary, first replicate the
2408 status in the top address to the others in the batch. The label is the
2409 subject of a goto when a call to the transport's setup function fails. We
2410 pass the pointer to the transport back in case it got changed as a result of
2411 file_format in appendfile. */
2415 if (replicate) replicate_status(addr);
2416 for (addr2 = addr; addr2; addr2 = addr2->next)
2419 int local_part_length = Ustrlen(addr2->local_part);
2423 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2424 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2425 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2426 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2427 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2428 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2429 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2430 || (ret = write(pfd[pipe_write], &addr2->transport,
2431 sizeof(transport_instance *))) != sizeof(transport_instance *)
2433 /* For a file delivery, pass back the local part, in case the original
2434 was only part of the final delivery path. This gives more complete
2437 || (testflag(addr2, af_file)
2438 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2439 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2443 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2444 ret == -1 ? strerror(errno) : "short write");
2446 /* Now any messages */
2448 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2450 int message_length = s ? Ustrlen(s) + 1 : 0;
2451 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2452 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2454 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2455 ret == -1 ? strerror(errno) : "short write");
2459 /* OK, this process is now done. Free any cached resources that it opened,
2460 and close the pipe we were writing down before exiting. */
2462 (void)close(pfd[pipe_write]);
2467 /* Back in the main process: panic if the fork did not succeed. This seems
2468 better than returning an error - if forking is failing it is probably best
2469 not to try other deliveries for this message. */
2472 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2475 /* Read the pipe to get the delivery status codes and error messages. Our copy
2476 of the writing end must be closed first, as otherwise read() won't return zero
2477 on an empty pipe. We check that a status exists for each address before
2478 overwriting the address structure. If data is missing, the default DEFER status
2479 will remain. Afterwards, close the reading end. */
2481 (void)close(pfd[pipe_write]);
2483 for (addr2 = addr; addr2; addr2 = addr2->next)
2485 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2490 addr2->transport_return = status;
2491 len = read(pfd[pipe_read], &transport_count,
2492 sizeof(transport_count));
2493 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2494 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2495 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2496 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2497 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2498 len = read(pfd[pipe_read], &addr2->transport,
2499 sizeof(transport_instance *));
2501 if (testflag(addr2, af_file))
2504 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2505 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2508 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2509 " from delivery subprocess");
2512 /* sanity-checked llen so disable the Coverity error */
2513 /* coverity[tainted_data] */
2514 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2516 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2517 " from delivery subprocess");
2520 big_buffer[llen] = 0;
2521 addr2->local_part = string_copy(big_buffer);
2524 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2527 len = read(pfd[pipe_read], &message_length, sizeof(int));
2528 if (message_length > 0)
2530 len = read(pfd[pipe_read], big_buffer, message_length);
2531 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2532 if (len > 0) *sptr = string_copy(big_buffer);
2539 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2540 "from delivery subprocess", addr2->unique);
2545 (void)close(pfd[pipe_read]);
2547 /* Unless shadowing, write all successful addresses immediately to the journal
2548 file, to ensure they are recorded asap. For homonymic addresses, use the base
2549 address plus the transport name. Failure to write the journal is panic-worthy,
2550 but don't stop, as it may prove possible subsequently to update the spool file
2551 in order to record the delivery. */
2555 for (addr2 = addr; addr2; addr2 = addr2->next)
2556 if (addr2->transport_return == OK)
2558 if (testflag(addr2, af_homonym))
2559 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2561 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2563 /* In the test harness, wait just a bit to let the subprocess finish off
2564 any debug output etc first. */
2566 testharness_pause_ms(300);
2568 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2569 len = Ustrlen(big_buffer);
2570 if (write(journal_fd, big_buffer, len) != len)
2571 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2572 big_buffer, strerror(errno));
2575 /* Ensure the journal file is pushed out to disk. */
2577 if (EXIMfsync(journal_fd) < 0)
2578 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2582 /* Wait for the process to finish. If it terminates with a non-zero code,
2583 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2584 status values of all the addresses as they are. Take care to handle the case
2585 when the subprocess doesn't seem to exist. This has been seen on one system
2586 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2587 happens, wait() doesn't recognize the termination of child processes. Exim now
2588 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2590 while ((rc = wait(&status)) != pid)
2591 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2593 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2594 addr->transport->driver_name);
2599 if ((status & 0xffff) != 0)
2601 int msb = (status >> 8) & 255;
2602 int lsb = status & 255;
2603 int code = (msb == 0)? (lsb & 0x7f) : msb;
2604 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2605 addr->special_action = SPECIAL_FREEZE;
2606 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2607 "status 0x%04x: %s %d",
2608 addr->transport->driver_name,
2610 msb == 0 ? "terminated by signal" : "exit code",
2614 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2616 if (addr->special_action == SPECIAL_WARN)
2618 uschar * warn_message = addr->transport->warn_message;
2619 GET_OPTION("quota_warn_message");
2625 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2627 if (!(warn_message = expand_string(warn_message)))
2628 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2629 "message for %s transport): %s", addr->transport->warn_message,
2630 addr->transport->name, expand_string_message);
2632 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2634 FILE * f = fdopen(fd, "wb");
2635 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2636 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2637 fprintf(f, "Auto-Submitted: auto-replied\n");
2638 if (!contains_header(US"From", warn_message))
2640 fprintf(f, "%s", CS warn_message);
2642 /* Close and wait for child process to complete, without a timeout. */
2645 (void)child_close(pid, 0);
2648 addr->special_action = SPECIAL_NONE;
2656 /* Check transport for the given concurrency limit. Return TRUE if over
2657 the limit (or an expansion failure), else FALSE and if there was a limit,
2658 the key for the hints database used for the concurrency count. */
2661 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2663 unsigned max_parallel;
2665 GET_OPTION("max_parallel");
2666 if (!tp->max_parallel) return FALSE;
2668 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2669 if (expand_string_message)
2671 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2672 "in %s transport (%s): %s", tp->name, addr->address,
2673 expand_string_message);
2677 if (max_parallel > 0)
2679 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2680 if (!enq_start(serialize_key, max_parallel))
2682 address_item * next;
2684 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2685 tp->name, max_parallel);
2689 addr->message = US"concurrency limit reached for transport";
2690 addr->basic_errno = ERRNO_TRETRY;
2691 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2692 } while ((addr = next));
2695 *key = serialize_key;
2702 /*************************************************
2703 * Do local deliveries *
2704 *************************************************/
2706 /* This function processes the list of addresses in addr_local. True local
2707 deliveries are always done one address at a time. However, local deliveries can
2708 be batched up in some cases. Typically this is when writing batched SMTP output
2709 files for use by some external transport mechanism, or when running local
2710 deliveries over LMTP.
2717 do_local_deliveries(void)
2720 open_db *dbm_file = NULL;
2721 time_t now = time(NULL);
2723 /* Loop until we have exhausted the supply of local deliveries */
2727 struct timeval delivery_start;
2728 struct timeval deliver_time;
2729 address_item *addr2, *addr3, *nextaddr;
2730 int logflags = LOG_MAIN;
2731 int logchar = f.dont_deliver? '*' : '=';
2732 transport_instance *tp;
2733 uschar * serialize_key = NULL;
2735 /* Pick the first undelivered address off the chain */
2737 address_item *addr = addr_local;
2738 addr_local = addr->next;
2741 DEBUG(D_deliver|D_transport)
2742 debug_printf("--------> %s <--------\n", addr->address);
2744 /* An internal disaster if there is no transport. Should not occur! */
2746 if (!(tp = addr->transport))
2748 logflags |= LOG_PANIC;
2749 f.disable_logging = FALSE; /* Jic */
2750 addr->message = addr->router
2751 ? string_sprintf("No transport set by %s router", addr->router->name)
2752 : US"No transport set by system filter";
2753 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2757 /* Check that this base address hasn't previously been delivered to this
2758 transport. The check is necessary at this point to handle homonymic addresses
2759 correctly in cases where the pattern of redirection changes between delivery
2760 attempts. Non-homonymic previous delivery is detected earlier, at routing
2763 if (previously_transported(addr, FALSE)) continue;
2765 /* There are weird cases where logging is disabled */
2767 f.disable_logging = tp->disable_logging;
2769 /* Check for batched addresses and possible amalgamation. Skip all the work
2770 if either batch_max <= 1 or there aren't any other addresses for local
2773 if (tp->batch_max > 1 && addr_local)
2775 int batch_count = 1;
2776 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2777 BOOL uses_lp = ( testflag(addr, af_pfr)
2778 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2780 || readconf_depends((driver_instance *)tp, US"local_part");
2781 uschar *batch_id = NULL;
2782 address_item **anchor = &addr_local;
2783 address_item *last = addr;
2786 /* Expand the batch_id string for comparison with other addresses.
2787 Expansion failure suppresses batching. */
2789 GET_OPTION("batch_id");
2792 deliver_set_expansions(addr);
2793 batch_id = expand_string(tp->batch_id);
2794 deliver_set_expansions(NULL);
2797 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2798 "in %s transport (%s): %s", tp->name, addr->address,
2799 expand_string_message);
2800 batch_count = tp->batch_max;
2804 /* Until we reach the batch_max limit, pick off addresses which have the
2805 same characteristics. These are:
2808 not previously delivered (see comment about 50 lines above)
2809 same local part if the transport's configuration contains $local_part
2810 or if this is a file or pipe delivery from a redirection
2811 same domain if the transport's configuration contains $domain
2813 same additional headers
2814 same headers to be removed
2815 same uid/gid for running the transport
2816 same first host if a host list is set
2819 while ((next = *anchor) && batch_count < tp->batch_max)
2822 tp == next->transport
2823 && !previously_transported(next, TRUE)
2824 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2825 && testflag(addr, af_file) == testflag(next, af_file)
2826 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2827 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2828 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2829 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2830 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2831 && same_ugid(tp, addr, next)
2832 && ( !addr->host_list && !next->host_list
2835 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2838 /* If the transport has a batch_id setting, batch_id will be non-NULL
2839 from the expansion outside the loop. Expand for this address and compare.
2840 Expansion failure makes this address ineligible for batching. */
2845 address_item * save_nextnext = next->next;
2846 next->next = NULL; /* Expansion for a single address */
2847 deliver_set_expansions(next);
2848 next->next = save_nextnext;
2849 GET_OPTION("batch_id");
2850 bid = expand_string(tp->batch_id);
2851 deliver_set_expansions(NULL);
2854 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2855 "in %s transport (%s): %s", tp->name, next->address,
2856 expand_string_message);
2859 else ok = (Ustrcmp(batch_id, bid) == 0);
2862 /* Take address into batch if OK. */
2866 *anchor = next->next; /* Include the address */
2872 else anchor = &next->next; /* Skip the address */
2876 /* We now have one or more addresses that can be delivered in a batch. Check
2877 whether the transport is prepared to accept a message of this size. If not,
2878 fail them all forthwith. If the expansion fails, or does not yield an
2879 integer, defer delivery. */
2881 if (tp->message_size_limit)
2883 int rc = check_message_size(tp, addr);
2886 replicate_status(addr);
2890 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2893 continue; /* With next batch of addresses */
2897 /* If we are not running the queue, or if forcing, all deliveries will be
2898 attempted. Otherwise, we must respect the retry times for each address. Even
2899 when not doing this, we need to set up the retry key string, and determine
2900 whether a retry record exists, because after a successful delivery, a delete
2901 retry item must be set up. Keep the retry database open only for the duration
2902 of these checks, rather than for all local deliveries, because some local
2903 deliveries (e.g. to pipes) can take a substantial time. */
2905 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2906 DEBUG(D_deliver|D_retry|D_hints_lookup)
2907 debug_printf("no retry data available\n");
2913 BOOL ok = TRUE; /* to deliver this address */
2916 /* Set up the retry key to include the domain or not, and change its
2917 leading character from "R" to "T". Must make a copy before doing this,
2918 because the old key may be pointed to from a "delete" retry item after
2921 retry_key = string_copy(
2922 tp->retry_use_local_part ? addr2->address_retry_key :
2923 addr2->domain_retry_key);
2926 /* Inspect the retry data. If there is no hints file, delivery happens. */
2930 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2932 /* If there is no retry record, delivery happens. If there is,
2933 remember it exists so it can be deleted after a successful delivery. */
2937 setflag(addr2, af_lt_retry_exists);
2939 /* A retry record exists for this address. If queue running and not
2940 forcing, inspect its contents. If the record is too old, or if its
2941 retry time has come, or if it has passed its cutoff time, delivery
2946 debug_printf("retry record exists: age=%s ",
2947 readconf_printtime(now - retry_record->time_stamp));
2948 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2949 debug_printf(" time to retry = %s expired = %d\n",
2950 readconf_printtime(retry_record->next_try - now),
2951 retry_record->expired);
2954 if (f.queue_running && !f.deliver_force)
2956 ok = (now - retry_record->time_stamp > retry_data_expire)
2957 || (now >= retry_record->next_try)
2958 || retry_record->expired;
2960 /* If we haven't reached the retry time, there is one more check
2961 to do, which is for the ultimate address timeout. */
2964 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2968 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2971 /* This address is to be delivered. Leave it on the chain. */
2976 addr2 = addr2->next;
2979 /* This address is to be deferred. Take it out of the chain, and
2980 post-process it as complete. Must take it out of the chain first,
2981 because post processing puts it on another chain. */
2985 address_item *this = addr2;
2986 this->message = US"Retry time not yet reached";
2987 this->basic_errno = ERRNO_LRETRY;
2988 addr2 = addr3 ? (addr3->next = addr2->next)
2989 : (addr = addr2->next);
2990 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2994 if (dbm_file) dbfn_close(dbm_file);
2996 /* If there are no addresses left on the chain, they all deferred. Loop
2997 for the next set of addresses. */
2999 if (!addr) continue;
3001 /* If the transport is limited for parallellism, enforce that here.
3002 We use a hints DB entry, incremented here and decremented after
3003 the transport (and any shadow transport) completes. */
3005 if (tpt_parallel_check(tp, addr, &serialize_key))
3007 if (expand_string_message)
3009 logflags |= LOG_PANIC;
3013 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3014 } while ((addr = addr2));
3016 continue; /* Loop for the next set of addresses. */
3020 /* So, finally, we do have some addresses that can be passed to the
3021 transport. Before doing so, set up variables that are relevant to a
3024 deliver_set_expansions(addr);
3026 gettimeofday(&delivery_start, NULL);
3027 deliver_local(addr, FALSE);
3028 timesince(&deliver_time, &delivery_start);
3030 /* If a shadow transport (which must perforce be another local transport), is
3031 defined, and its condition is met, we must pass the message to the shadow
3032 too, but only those addresses that succeeded. We do this by making a new
3033 chain of addresses - also to keep the original chain uncontaminated. We must
3034 use a chain rather than doing it one by one, because the shadow transport may
3037 NOTE: if the condition fails because of a lookup defer, there is nothing we
3041 && ( !tp->shadow_condition
3042 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3045 transport_instance *stp;
3046 address_item *shadow_addr = NULL;
3047 address_item **last = &shadow_addr;
3049 for (stp = transports; stp; stp = stp->next)
3050 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3053 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3056 /* Pick off the addresses that have succeeded, and make clones. Put into
3057 the shadow_message field a pointer to the shadow_message field of the real
3060 else for (addr2 = addr; addr2; addr2 = addr2->next)
3061 if (addr2->transport_return == OK)
3063 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3066 addr3->shadow_message = US &addr2->shadow_message;
3067 addr3->transport = stp;
3068 addr3->transport_return = DEFER;
3069 addr3->return_filename = NULL;
3070 addr3->return_file = -1;
3072 last = &addr3->next;
3075 /* If we found any addresses to shadow, run the delivery, and stick any
3076 message back into the shadow_message field in the original. */
3080 int save_count = transport_count;
3082 DEBUG(D_deliver|D_transport)
3083 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3084 deliver_local(shadow_addr, TRUE);
3086 for(; shadow_addr; shadow_addr = shadow_addr->next)
3088 int sresult = shadow_addr->transport_return;
3089 *(uschar **)shadow_addr->shadow_message =
3091 ? string_sprintf(" ST=%s", stp->name)
3092 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3093 shadow_addr->basic_errno <= 0
3095 : US strerror(shadow_addr->basic_errno),
3096 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3099 shadow_addr->message
3100 ? shadow_addr->message
3101 : shadow_addr->basic_errno <= 0
3105 DEBUG(D_deliver|D_transport)
3106 debug_printf("%s shadow transport returned %s for %s\n",
3107 stp->name, rc_to_string(sresult), shadow_addr->address);
3110 DEBUG(D_deliver|D_transport)
3111 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3113 transport_count = save_count; /* Restore original transport count */
3117 /* Cancel the expansions that were set up for the delivery. */
3119 deliver_set_expansions(NULL);
3121 /* If the transport was parallelism-limited, decrement the hints DB record. */
3123 if (serialize_key) enq_end(serialize_key);
3125 /* Now we can process the results of the real transport. We must take each
3126 address off the chain first, because post_process_one() puts it on another
3129 for (addr2 = addr; addr2; addr2 = nextaddr)
3131 int result = addr2->transport_return;
3132 nextaddr = addr2->next;
3134 DEBUG(D_deliver|D_transport)
3135 debug_printf("%s transport returned %s for %s\n",
3136 tp->name, rc_to_string(result), addr2->address);
3138 /* If there is a retry_record, or if delivery is deferred, build a retry
3139 item for setting a new retry time or deleting the old retry record from
3140 the database. These items are handled all together after all addresses
3141 have been handled (so the database is open just for a short time for
3144 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3146 int flags = result == DEFER ? 0 : rf_delete;
3147 uschar * retry_key = string_copy(tp->retry_use_local_part
3148 ? addr2->address_retry_key : addr2->domain_retry_key);
3150 retry_add_item(addr2, retry_key, flags);
3153 /* Done with this address */
3155 addr2->delivery_time = deliver_time;
3156 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3158 /* If a pipe delivery generated text to be sent back, the result may be
3159 changed to FAIL, and we must copy this for subsequent addresses in the
3162 if (addr2->transport_return != result)
3164 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3166 addr3->transport_return = addr2->transport_return;
3167 addr3->basic_errno = addr2->basic_errno;
3168 addr3->message = addr2->message;
3170 result = addr2->transport_return;
3173 /* Whether or not the result was changed to FAIL, we need to copy the
3174 return_file value from the first address into all the addresses of the
3175 batch, so they are all listed in the error message. */
3177 addr2->return_file = addr->return_file;
3179 /* Change log character for recording successful deliveries. */
3181 if (result == OK) logchar = '-';
3183 } /* Loop back for next batch of addresses */
3189 /*************************************************
3190 * Sort remote deliveries *
3191 *************************************************/
3193 /* This function is called if remote_sort_domains is set. It arranges that the
3194 chain of addresses for remote deliveries is ordered according to the strings
3195 specified. Try to make this shuffling reasonably efficient by handling
3196 sequences of addresses rather than just single ones.
3203 sort_remote_deliveries(void)
3206 address_item **aptr = &addr_remote;
3207 const uschar *listptr = remote_sort_domains;
3211 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3213 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3216 address_item *moved = NULL;
3217 address_item **bptr = &moved;
3221 address_item **next;
3222 deliver_domain = (*aptr)->domain; /* set $domain */
3223 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3224 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3226 aptr = &(*aptr)->next;
3230 next = &(*aptr)->next;
3232 && (deliver_domain = (*next)->domain, /* Set $domain */
3233 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3234 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3236 next = &(*next)->next;
3238 /* If the batch of non-matchers is at the end, add on any that were
3239 extracted further up the chain, and end this iteration. Otherwise,
3240 extract them from the chain and hang on the moved chain. */
3252 aptr = &(*aptr)->next;
3255 /* If the loop ended because the final address matched, *aptr will
3256 be NULL. Add on to the end any extracted non-matching addresses. If
3257 *aptr is not NULL, the loop ended via "break" when *next is null, that
3258 is, there was a string of non-matching addresses at the end. In this
3259 case the extracted addresses have already been added on the end. */
3261 if (!*aptr) *aptr = moved;
3266 debug_printf("remote addresses after sorting:\n");
3267 for (address_item * addr = addr_remote; addr; addr = addr->next)
3268 debug_printf(" %s\n", addr->address);
3274 /*************************************************
3275 * Read from pipe for remote delivery subprocess *
3276 *************************************************/
3278 /* This function is called when the subprocess is complete, but can also be
3279 called before it is complete, in order to empty a pipe that is full (to prevent
3280 deadlock). It must therefore keep track of its progress in the parlist data
3283 We read the pipe to get the delivery status codes and a possible error message
3284 for each address, optionally preceded by unusability data for the hosts and
3285 also by optional retry data.
3287 Read in large chunks into the big buffer and then scan through, interpreting
3288 the data therein. In most cases, only a single read will be necessary. No
3289 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3290 that we read the next chunk when there is less than 2500 bytes left in the
3291 non-final chunk, we can assume each item is complete in the buffer before
3292 handling it. Each item is written using a single write(), which is atomic for
3293 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3294 often bigger) so even if we are reading while the subprocess is still going, we
3295 should never have only a partial item in the buffer.
3297 hs12: This assumption is not true anymore, since we get quite large items (certificate
3298 information and such).
3301 poffset the offset of the parlist item
3302 eop TRUE if the process has completed
3304 Returns: TRUE if the terminating 'Z' item has been read,
3305 or there has been a disaster (i.e. no more data needed);
3310 par_read_pipe(int poffset, BOOL eop)
3313 pardata *p = parlist + poffset;
3314 address_item *addrlist = p->addrlist;
3315 address_item *addr = p->addr;
3319 uschar *msg = p->msg;
3320 BOOL done = p->done;
3322 /* Loop through all items, reading from the pipe when necessary. The pipe
3323 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3324 here, as the preceding poll() tells us, if data is available for reading.
3326 A read() on a "selected" handle should never block, but(!) it may return
3327 less data then we expected. (The buffer size we pass to read() shouldn't be
3328 understood as a "request", but as a "limit".)
3330 Each separate item is written to the pipe in a timely manner. But, especially for
3331 larger items, the read(2) may already return partial data from the write(2).
3333 The write is atomic mostly (depending on the amount written), but atomic does
3334 not imply "all or noting", it just is "not intermixed" with other writes on the
3335 same channel (pipe).
3339 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3340 (int)p->pid, eop? "ended" : "not ended yet");
3344 retry_item *r, **rp;
3345 uschar pipeheader[PIPE_HEADER_SIZE+1];
3346 uschar *id = &pipeheader[0];
3347 uschar *subid = &pipeheader[1];
3348 uschar *ptr = big_buffer;
3349 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3352 DEBUG(D_deliver) debug_printf(
3353 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3355 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3356 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3357 If we get less, we can assume the subprocess do be done and do not expect any further
3358 information from it. */
3360 if ((got = readn(fd, pipeheader, required)) != required)
3362 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3363 "from transport process %d for transport %s",
3364 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3369 pipeheader[PIPE_HEADER_SIZE] = '\0';
3371 debug_printf("got %ld bytes (pipeheader) '%c' from transport process %d\n",
3372 (long) got, *id, pid);
3375 /* If we can't decode the pipeheader, the subprocess seems to have a
3376 problem, we do not expect any furher information from it. */
3378 required = Ustrtol(pipeheader+2, &endc, 10);
3381 msg = string_sprintf("failed to read pipe "
3382 "from transport process %d for transport %s: error decoding size from header",
3383 pid, addr->transport->driver_name);
3390 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3391 (u_long)required, pid);
3393 /* Same as above, the transport process will write the bytes announced
3394 in a timely manner, so we can just wait for the bytes, getting less than expected
3395 is considered a problem of the subprocess, we do not expect anything else from it. */
3396 if ((got = readn(fd, big_buffer, required)) != required)
3398 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3399 " bytes (pipedata) from transport process %d for transport %s",
3400 got, required, pid, addr->transport->driver_name);
3405 /* Handle each possible type of item, assuming the complete item is
3406 available in store. */
3410 /* Host items exist only if any hosts were marked unusable. Match
3411 up by checking the IP address. */
3414 for (h = addrlist->host_list; h; h = h->next)
3416 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3424 /* Retry items are sent in a preceding R item for each address. This is
3425 kept separate to keep each message short enough to guarantee it won't
3426 be split in the pipe. Hopefully, in the majority of cases, there won't in
3427 fact be any retry items at all.
3429 The complete set of retry items might include an item to delete a
3430 routing retry if there was a previous routing delay. However, routing
3431 retries are also used when a remote transport identifies an address error.
3432 In that case, there may also be an "add" item for the same key. Arrange
3433 that a "delete" item is dropped in favour of an "add" item. */
3436 if (!addr) goto ADDR_MISMATCH;
3438 DEBUG(D_deliver|D_retry)
3439 debug_printf("reading retry information for %s from subprocess\n",
3442 /* Cut out any "delete" items on the list. */
3444 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3445 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3447 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3448 *rp = r->next; /* Excise a delete item */
3449 DEBUG(D_deliver|D_retry)
3450 debug_printf(" existing delete item dropped\n");
3453 /* We want to add a delete item only if there is no non-delete item;
3454 however we still have to step ptr through the data. */
3456 if (!r || !(*ptr & rf_delete))
3458 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3459 r->next = addr->retries;
3462 r->key = string_copy(ptr);
3464 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3465 ptr += sizeof(r->basic_errno);
3466 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3467 ptr += sizeof(r->more_errno);
3468 r->message = *ptr ? string_copy(ptr) : NULL;
3469 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3470 r->flags & rf_delete ? "delete" : "retry");
3475 DEBUG(D_deliver|D_retry)
3476 debug_printf(" delete item not added: non-delete item exists\n");
3479 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3485 /* Put the amount of data written into the parlist block */
3487 case 'S': /* Size */
3488 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3489 ptr += sizeof(transport_count);
3492 /* Address items are in the order of items on the address chain. We
3493 remember the current address value in case this function is called
3494 several times to empty the pipe in stages. Information about delivery
3495 over TLS is sent in a preceding X item for each address. We don't put
3496 it in with the other info, in order to keep each message short enough to
3497 guarantee it won't be split in the pipe. */
3500 case 'X': /* TLS details */
3501 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3505 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3509 addr->cipher = string_copy(ptr);
3510 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3514 addr->peerdn = string_copy(ptr);
3519 (void) tls_import_cert(ptr, &addr->peercert);
3521 addr->peercert = NULL;
3526 (void) tls_import_cert(ptr, &addr->ourcert);
3528 addr->ourcert = NULL;
3531 # ifndef DISABLE_OCSP
3533 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3539 #endif /*DISABLE_TLS*/
3541 case 'C': /* client authenticator information */
3544 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3545 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3546 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3551 #ifndef DISABLE_PRDR
3553 setflag(addr, af_prdr_used);
3560 #ifndef DISABLE_PIPE_CONNECT
3561 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3563 case 1: setflag(addr, af_pipelining); break;
3568 setflag(addr, af_chunking_used);
3572 setflag(addr, af_tcp_fastopen_conn);
3573 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3574 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3578 if (!addr) goto ADDR_MISMATCH;
3579 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3580 ptr += sizeof(addr->dsn_aware);
3581 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3584 case 'A': /* Per-address info */
3588 msg = string_sprintf("address count mismatch for data read from pipe "
3589 "for transport process %d for transport %s", pid,
3590 addrlist->transport->driver_name);
3597 #ifndef DISABLE_DKIM
3598 case '4': /* DKIM information */
3599 addr->dkim_used = string_copy(ptr);
3604 case '3': /* explicit notification of continued-connection (non)use;
3605 overrides caller's knowlege. */
3606 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3607 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3610 #ifdef SUPPORT_SOCKS
3611 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3612 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3617 proxy_local_address = string_copy(ptr);
3619 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3620 ptr += sizeof(proxy_local_port);
3625 #ifdef EXPERIMENTAL_DSN_INFO
3626 case '1': /* must arrive before A0, and applies to that addr */
3627 /* Two strings: smtp_greeting and helo_response */
3628 addr->smtp_greeting = string_copy(ptr);
3630 addr->helo_response = string_copy(ptr);
3635 case '0': /* results of trying to send to this address */
3636 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3637 addr->transport_return = *ptr++;
3638 addr->special_action = *ptr++;
3639 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3640 ptr += sizeof(addr->basic_errno);
3641 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3642 ptr += sizeof(addr->more_errno);
3643 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3644 ptr += sizeof(addr->delivery_time);
3645 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3646 ptr += sizeof(addr->flags);
3647 addr->message = *ptr ? string_copy(ptr) : NULL;
3649 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3652 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3656 h = store_get(sizeof(host_item), GET_UNTAINTED);
3657 h->name = string_copy(ptr);
3659 h->address = string_copy(ptr);
3661 memcpy(&h->port, ptr, sizeof(h->port));
3662 ptr += sizeof(h->port);
3663 h->dnssec = *ptr == '2' ? DS_YES
3664 : *ptr == '1' ? DS_NO
3667 addr->host_used = h;
3671 /* Finished with this address */
3678 /* Local interface address/port */
3680 if (*ptr) sending_ip_address = string_copy(ptr);
3682 if (*ptr) sending_port = atoi(CS ptr);
3686 /* Z marks the logical end of the data. It is followed by '0' if
3687 continue_transport was NULL at the end of transporting, otherwise '1'.
3688 We need to know when it becomes NULL during a delivery down a passed SMTP
3689 channel so that we don't try to pass anything more down it. Of course, for
3690 most normal messages it will remain NULL all the time. */
3695 continue_transport = NULL;
3696 continue_hostname = NULL;
3699 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3702 /* Anything else is a disaster. */
3705 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3706 "process %d for transport %s", ptr[-1], pid,
3707 addr->transport->driver_name);
3713 /* The done flag is inspected externally, to determine whether or not to
3714 call the function again when the process finishes. */
3718 /* If the process hadn't finished, and we haven't seen the end of the data
3719 or if we suffered a disaster, update the rest of the state, and return FALSE to
3720 indicate "not finished". */
3729 /* Close our end of the pipe, to prevent deadlock if the far end is still
3730 pushing stuff into it. */
3735 /* If we have finished without error, but haven't had data for every address,
3736 something is wrong. */
3739 msg = string_sprintf("insufficient address data read from pipe "
3740 "for transport process %d for transport %s", pid,
3741 addr->transport->driver_name);
3743 /* If an error message is set, something has gone wrong in getting back
3744 the delivery data. Put the message into each address and freeze it. */
3747 for (addr = addrlist; addr; addr = addr->next)
3749 addr->transport_return = DEFER;
3750 addr->special_action = SPECIAL_FREEZE;
3751 addr->message = msg;
3752 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3755 /* Return TRUE to indicate we have got all we need from this process, even
3756 if it hasn't actually finished yet. */
3763 /*************************************************
3764 * Post-process a set of remote addresses *
3765 *************************************************/
3767 /* Do what has to be done immediately after a remote delivery for each set of
3768 addresses, then re-write the spool if necessary. Note that post_process_one
3769 puts the address on an appropriate queue; hence we must fish off the next
3770 one first. This function is also called if there is a problem with setting
3771 up a subprocess to do a remote delivery in parallel. In this case, the final
3772 argument contains a message, and the action must be forced to DEFER.
3775 addr pointer to chain of address items
3776 logflags flags for logging
3777 msg NULL for normal cases; -> error message for unexpected problems
3778 fallback TRUE if processing fallback hosts
3784 remote_post_process(address_item * addr, int logflags, uschar * msg,
3787 /* If any host addresses were found to be unusable, add them to the unusable
3788 tree so that subsequent deliveries don't try them. */
3790 for (host_item * h = addr->host_list; h; h = h->next)
3792 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3794 /* Now handle each address on the chain. The transport has placed '=' or '-'
3795 into the special_action field for each successful delivery. */
3799 address_item * next = addr->next;
3801 /* If msg == NULL (normal processing) and the result is DEFER and we are
3802 processing the main hosts and there are fallback hosts available, put the
3803 address on the list for fallback delivery. */
3805 if ( addr->transport_return == DEFER
3806 && addr->fallback_hosts
3811 addr->host_list = addr->fallback_hosts;
3812 addr->next = addr_fallback;
3813 addr_fallback = addr;
3814 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3817 /* If msg is set (=> unexpected problem), set it in the address before
3818 doing the ordinary post processing. */
3824 addr->message = msg;
3825 addr->transport_return = DEFER;
3827 (void)post_process_one(addr, addr->transport_return, logflags,
3828 EXIM_DTYPE_TRANSPORT, addr->special_action);
3836 /* If we have just delivered down a passed SMTP channel, and that was
3837 the last address, the channel will have been closed down. Now that
3838 we have logged that delivery, set continue_sequence to 1 so that
3839 any subsequent deliveries don't get "*" incorrectly logged. */
3841 if (!continue_transport) continue_sequence = 1;
3846 /*************************************************
3847 * Wait for one remote delivery subprocess *
3848 *************************************************/
3850 /* This function is called while doing remote deliveries when either the
3851 maximum number of processes exist and we need one to complete so that another
3852 can be created, or when waiting for the last ones to complete. It must wait for
3853 the completion of one subprocess, empty the control block slot, and return a
3854 pointer to the address chain.
3857 Returns: pointer to the chain of addresses handled by the process;
3858 NULL if no subprocess found - this is an unexpected error
3861 static address_item *
3864 int poffset, status;
3865 address_item * addr, * addrlist;
3868 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3869 "to finish", message_id);
3871 /* Loop until either a subprocess completes, or there are no subprocesses in
3872 existence - in which case give an error return. We cannot proceed just by
3873 waiting for a completion, because a subprocess may have filled up its pipe, and
3874 be waiting for it to be emptied. Therefore, if no processes have finished, we
3875 wait for one of the pipes to acquire some data by calling poll(), with a
3876 timeout just in case.
3878 The simple approach is just to iterate after reading data from a ready pipe.
3879 This leads to non-ideal behaviour when the subprocess has written its final Z
3880 item, closed the pipe, and is in the process of exiting (the common case). A
3881 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3882 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3885 To avoid this, if all the data that is needed has been read from a subprocess
3886 after poll(), an explicit wait() for it is done. We know that all it is doing
3887 is writing to the pipe and then exiting, so the wait should not be long.
3889 The non-blocking waitpid() is to some extent just insurance; if we could
3890 reliably detect end-of-file on the pipe, we could always know when to do a
3891 blocking wait() for a completed process. However, because some systems use
3892 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3893 use code that functions without the need to recognize EOF.
3895 There's a double loop here just in case we end up with a process that is not in
3896 the list of remote delivery processes. Something has obviously gone wrong if
3897 this is the case. (For example, a process that is incorrectly left over from
3898 routing or local deliveries might be found.) The damage can be minimized by
3899 looping back and looking for another process. If there aren't any, the error
3900 return will happen. */
3902 for (;;) /* Normally we do not repeat this loop */
3904 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3908 /* A return value of -1 can mean several things. If errno != ECHILD, it
3909 either means invalid options (which we discount), or that this process was
3910 interrupted by a signal. Just loop to try the waitpid() again.
3912 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3913 in existence. This should never happen, and is an unexpected error.
3914 However, there is a nasty complication when running under Linux. If "strace
3915 -f" is being used under Linux to trace this process and its children,
3916 subprocesses are "stolen" from their parents and become the children of the
3917 tracing process. A general wait such as the one we've just obeyed returns
3918 as if there are no children while subprocesses are running. Once a
3919 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3920 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3923 This does not happen using "truss" on Solaris, nor (I think) with other
3924 tracing facilities on other OS. It seems to be specific to Linux.
3926 What we do to get round this is to use kill() to see if any of our
3927 subprocesses are still in existence. If kill() gives an OK return, we know
3928 it must be for one of our processes - it can't be for a re-use of the pid,
3929 because if our process had finished, waitpid() would have found it. If any
3930 of our subprocesses are in existence, we proceed to use poll() as if
3931 waitpid() had returned zero. I think this is safe. */
3935 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3938 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3939 "for process existence\n");
3941 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3943 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3945 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3946 "stolen by strace\n", (int)pid);
3947 break; /* With poffset set */
3951 if (poffset >= remote_max_parallel)
3953 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3954 return NULL; /* This is the error return */
3958 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3959 been handled above. A return value of zero means that there is at least one
3960 subprocess, but there are no completed subprocesses. See if any pipes are
3961 ready with any data for reading. */
3963 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3965 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3966 if (parlist[poffset].pid != 0)
3968 parpoll[poffset].fd = parlist[poffset].fd;
3969 parpoll[poffset].events = POLLIN;
3972 parpoll[poffset].fd = -1;
3974 /* Stick in a 60-second timeout, just in case. */
3976 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3978 /* Scan through the pipes and read any that are ready; use the count
3979 returned by poll() to stop when there are no more. Select() can return
3980 with no processes (e.g. if interrupted). This shouldn't matter.
3982 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3983 read, or there was a disaster. In either case, we are finished with this
3984 process. Do an explicit wait() for the process and break the main loop if
3987 It turns out that we have to deal with the case of an interrupted system
3988 call, which can happen on some operating systems if the signal handling is
3989 set up to do that by default. */
3992 readycount > 0 && poffset < remote_max_parallel;
3995 if ( (pid = parlist[poffset].pid) != 0
3996 && parpoll[poffset].revents
4000 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4001 for (;;) /* Loop for signals */
4003 pid_t endedpid = waitpid(pid, &status, 0);
4004 if (endedpid == pid) goto PROCESS_DONE;
4005 if (endedpid != (pid_t)(-1) || errno != EINTR)
4006 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4007 "%d (errno = %d) from waitpid() for process %d",
4008 (int)endedpid, errno, (int)pid);
4013 /* Now go back and look for a completed subprocess again. */
4016 /* A completed process was detected by the non-blocking waitpid(). Find the
4017 data block that corresponds to this subprocess. */
4019 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4020 if (pid == parlist[poffset].pid) break;
4022 /* Found the data block; this is a known remote delivery process. We don't
4023 need to repeat the outer loop. This should be what normally happens. */
4025 if (poffset < remote_max_parallel) break;
4027 /* This situation is an error, but it's probably better to carry on looking
4028 for another process than to give up (as we used to do). */
4030 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4031 "transport process list", pid);
4032 } /* End of the "for" loop */
4034 /* Come here when all the data was completely read after a poll(), and
4035 the process in pid has been wait()ed for. */
4042 debug_printf("remote delivery process %d ended\n", (int)pid);
4044 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4048 set_process_info("delivering %s", message_id);
4050 /* Get the chain of processed addresses */
4052 addrlist = parlist[poffset].addrlist;
4054 /* If the process did not finish cleanly, record an error and freeze (except
4055 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4056 in case the delivery did actually happen. */
4058 if ((status & 0xffff) != 0)
4061 int msb = (status >> 8) & 255;
4062 int lsb = status & 255;
4063 int code = (msb == 0)? (lsb & 0x7f) : msb;
4065 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4067 addrlist->transport->driver_name,
4069 msb == 0 ? "terminated by signal" : "exit code",
4072 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4073 addrlist->special_action = SPECIAL_FREEZE;
4075 for (addr = addrlist; addr; addr = addr->next)
4077 addr->transport_return = DEFER;
4078 addr->message = msg;
4081 remove_journal = FALSE;
4084 /* Else complete reading the pipe to get the result of the delivery, if all
4085 the data has not yet been obtained. */
4087 else if (!parlist[poffset].done)
4088 (void) par_read_pipe(poffset, TRUE);
4090 /* Put the data count and return path into globals, mark the data slot unused,
4091 decrement the count of subprocesses, and return the address chain. */
4093 transport_count = parlist[poffset].transport_count;
4094 used_return_path = parlist[poffset].return_path;
4095 parlist[poffset].pid = 0;
4102 /*************************************************
4103 * Wait for subprocesses and post-process *
4104 *************************************************/
4106 /* This function waits for subprocesses until the number that are still running
4107 is below a given threshold. For each complete subprocess, the addresses are
4108 post-processed. If we can't find a running process, there is some shambles.
4109 Better not bomb out, as that might lead to multiple copies of the message. Just
4110 log and proceed as if all done.
4113 max maximum number of subprocesses to leave running
4114 fallback TRUE if processing fallback hosts
4120 par_reduce(int max, BOOL fallback)
4122 while (parcount > max)
4124 address_item * doneaddr = par_wait();
4127 log_write(0, LOG_MAIN|LOG_PANIC,
4128 "remote delivery process count got out of step");
4133 transport_instance * tp = doneaddr->transport;
4134 if (tp->max_parallel)
4135 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4137 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4143 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4145 uschar pipe_header[PIPE_HEADER_SIZE+1];
4146 size_t total_len = PIPE_HEADER_SIZE + size;
4148 struct iovec iov[2] = {
4149 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4150 { buf, size } /* *the* data */
4155 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4156 /* complain to log if someone tries with buffer sizes we can't handle*/
4158 if (size > BIG_BUFFER_SIZE-1)
4160 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4161 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4163 size = BIG_BUFFER_SIZE;
4166 /* Should we check that we do not write more than PIPE_BUF? What would
4169 /* convert size to human readable string prepended by id and subid */
4170 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4171 id, subid, (long)size))
4172 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4174 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4175 id, subid, (long)size, pipe_header);
4177 if ((ret = writev(fd, iov, 2)) != total_len)
4178 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4179 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4180 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4183 /*************************************************
4184 * Do remote deliveries *
4185 *************************************************/
4187 /* This function is called to process the addresses in addr_remote. We must
4188 pick off the queue all addresses that have the same transport, remote
4189 destination, and errors address, and hand them to the transport in one go,
4190 subject to some configured limitations. If this is a run to continue delivering
4191 to an existing delivery channel, skip all but those addresses that can go to
4192 that channel. The skipped addresses just get deferred.
4194 If mua_wrapper is set, all addresses must be able to be sent in a single
4195 transaction. If not, this function yields FALSE.
4197 In Exim 4, remote deliveries are always done in separate processes, even
4198 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4199 is so that the base process can retain privilege. This makes the
4200 implementation of fallback transports feasible (though not initially done.)
4202 We create up to the configured number of subprocesses, each of which passes
4203 back the delivery state via a pipe. (However, when sending down an existing
4204 connection, remote_max_parallel is forced to 1.)
4207 fallback TRUE if processing fallback hosts
4209 Returns: TRUE normally
4210 FALSE if mua_wrapper is set and the addresses cannot all be sent
4215 do_remote_deliveries(BOOL fallback)
4220 parcount = 0; /* Number of executing subprocesses */
4222 /* When sending down an existing channel, only do one delivery at a time.
4223 We use a local variable (parmax) to hold the maximum number of processes;
4224 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4226 if (continue_transport) remote_max_parallel = 1;
4227 parmax = remote_max_parallel;
4229 /* If the data for keeping a list of processes hasn't yet been
4234 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4235 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4236 parlist[poffset].pid = 0;
4237 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4240 /* Now loop for each remote delivery */
4242 for (int delivery_count = 0; addr_remote; delivery_count++)
4248 int address_count = 1;
4249 int address_count_max;
4251 BOOL use_initgroups;
4252 BOOL pipe_done = FALSE;
4253 transport_instance *tp;
4254 address_item **anchor = &addr_remote;
4255 address_item *addr = addr_remote;
4256 address_item *last = addr;
4259 uschar * serialize_key = NULL;
4261 /* Pull the first address right off the list. */
4263 addr_remote = addr->next;
4266 DEBUG(D_deliver|D_transport)
4267 debug_printf("--------> %s <--------\n", addr->address);
4269 /* If no transport has been set, there has been a big screw-up somewhere. */
4271 if (!(tp = addr->transport))
4273 f.disable_logging = FALSE; /* Jic */
4274 panicmsg = US"No transport set by router";
4275 goto panic_continue;
4278 /* Check that this base address hasn't previously been delivered to this
4279 transport. The check is necessary at this point to handle homonymic addresses
4280 correctly in cases where the pattern of redirection changes between delivery
4281 attempts. Non-homonymic previous delivery is detected earlier, at routing
4284 if (previously_transported(addr, FALSE)) continue;
4286 /* Force failure if the message is too big. */
4288 if (tp->message_size_limit)
4290 int rc = check_message_size(tp, addr);
4293 addr->transport_return = rc;
4294 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4299 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4300 So look out for the place it gets used.
4303 /* Get the flag which specifies whether the transport can handle different
4304 domains that nevertheless resolve to the same set of hosts. If it needs
4305 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4306 $host, $host_address, $host_port. */
4307 if (tp->expand_multi_domain)
4308 deliver_set_expansions(addr);
4310 if (exp_bool(addr, US"transport", tp->name, D_transport,
4311 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4312 &multi_domain) != OK)
4314 deliver_set_expansions(NULL);
4315 panicmsg = addr->message;
4316 goto panic_continue;
4319 /* Get the maximum it can handle in one envelope, with zero meaning
4320 unlimited, which is forced for the MUA wrapper case and if the
4321 value could vary depending on the messages.
4322 For those, we only split (below) by (tpt,dest,erraddr,hdrs) and rely on the
4323 transport splitting further by max_rcp. So we potentially lose some
4326 address_count_max = mua_wrapper || Ustrchr(tp->max_addresses, '$')
4327 ? UNLIMITED_ADDRS : expand_max_rcpt(tp->max_addresses);
4330 /************************************************************************/
4331 /***** This is slightly experimental code, but should be safe. *****/
4333 /* The address_count_max value is the maximum number of addresses that the
4334 transport can send in one envelope. However, the transport must be capable of
4335 dealing with any number of addresses. If the number it gets exceeds its
4336 envelope limitation, it must send multiple copies of the message. This can be
4337 done over a single connection for SMTP, so uses less resources than making
4338 multiple connections. On the other hand, if remote_max_parallel is greater
4339 than one, it is perhaps a good idea to use parallel processing to move the
4340 message faster, even if that results in multiple simultaneous connections to
4343 How can we come to some compromise between these two ideals? What we do is to
4344 limit the number of addresses passed to a single instance of a transport to
4345 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4346 number of addresses routed to remote transports divided by
4347 remote_max_parallel. For example, if the message has 100 remote recipients,
4348 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4349 once. But if rcpt_max is 100, we could send up to 100.
4351 Of course, not all the remotely addresses in a message are going to go to the
4352 same set of hosts (except in smarthost configurations), so this is just a
4353 heuristic way of dividing up the work.
4355 Furthermore (1), because this may not be wanted in some cases, and also to
4356 cope with really pathological cases, there is also a limit to the number of
4357 messages that are sent over one connection. This is the same limit that is
4358 used when sending several different messages over the same connection.
4359 Continue_sequence is set when in this situation, to the number sent so
4360 far, including this message.
4362 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4363 is probably because they are using VERP, in which case they want to pass only
4364 one address at a time to the transport, in order to be able to use
4365 $local_part and $domain in constructing a new return path. We could test for
4366 the use of these variables, but as it is so likely they will be used when the
4367 maximum is 1, we don't bother. Just leave the value alone. */
4369 if ( address_count_max != 1
4370 && address_count_max < remote_delivery_count/remote_max_parallel
4373 int new_max = remote_delivery_count/remote_max_parallel;
4374 int message_max = tp->connection_max_messages;
4375 if (connection_max_messages >= 0) message_max = connection_max_messages;
4376 message_max -= continue_sequence - 1;
4377 if (message_max > 0 && new_max > address_count_max * message_max)
4378 new_max = address_count_max * message_max;
4379 address_count_max = new_max;
4382 /************************************************************************/
4385 /*XXX don't know yet if DANE will be used. So tpt will have to
4386 check at the point if gets next addr from list, and skip/defer any
4390 /* Pick off all addresses which have the same transport, errors address,
4391 destination, and extra headers. In some cases they point to the same host
4392 list, but we also need to check for identical host lists generated from
4393 entirely different domains. The host list pointers can be NULL in the case
4394 where the hosts are defined in the transport. There is also a configured
4395 maximum limit of addresses that can be handled at once (see comments above
4396 for how it is computed).
4397 If the transport does not handle multiple domains, enforce that also,
4398 and if it might need a per-address check for this, re-evaluate it.
4401 while ((next = *anchor) && address_count < address_count_max)
4404 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4405 && tp == next->transport
4406 && same_hosts(next->host_list, addr->host_list)
4407 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4408 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4409 && same_ugid(tp, next, addr)
4410 && ( next->prop.remove_headers == addr->prop.remove_headers
4411 || ( next->prop.remove_headers
4412 && addr->prop.remove_headers
4413 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4417 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4419 US"transport", next->transport->name, D_transport,
4420 US"multi_domain", next->transport->multi_domain,
4421 next->transport->expand_multi_domain, &md) == OK
4426 *anchor = next->next;
4428 next->first = addr; /* remember top one (for retry processing) */
4433 else anchor = &(next->next);
4434 deliver_set_expansions(NULL);
4437 /* If we are acting as an MUA wrapper, all addresses must go in a single
4438 transaction. If not, put them back on the chain and yield FALSE. */
4440 if (mua_wrapper && addr_remote)
4442 last->next = addr_remote;
4447 /* If the transport is limited for parallellism, enforce that here.
4448 The hints DB entry is decremented in par_reduce(), when we reap the
4449 transport process. */
4451 if (tpt_parallel_check(tp, addr, &serialize_key))
4452 if ((panicmsg = expand_string_message))
4453 goto panic_continue;
4455 continue; /* Loop for the next set of addresses. */
4457 /* Set up the expansion variables for this set of addresses */
4459 deliver_set_expansions(addr);
4461 /* Ensure any transport-set auth info is fresh */
4462 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4464 /* Compute the return path, expanding a new one if required. The old one
4465 must be set first, as it might be referred to in the expansion. */
4467 if(addr->prop.errors_address)
4468 return_path = addr->prop.errors_address;
4470 return_path = sender_address;
4472 GET_OPTION("return_path");
4473 if (tp->return_path)
4475 uschar * new_return_path = expand_string(tp->return_path);
4476 if (new_return_path)
4477 return_path = new_return_path;
4478 else if (!f.expand_string_forcedfail)
4480 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4481 tp->return_path, expand_string_message);
4486 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4487 logs and sets up error messages, so we just post-process and continue with
4488 the next address. */
4490 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4496 /* If this transport has a setup function, call it now so that it gets
4497 run in this process and not in any subprocess. That way, the results of
4498 any setup that are retained by the transport can be reusable. One of the
4499 things the setup does is to set the fallback host lists in the addresses.
4500 That is why it is called at this point, before the continue delivery
4501 processing, because that might use the fallback hosts. */
4504 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4506 /* If we have a connection still open from a verify stage (lazy-close)
4507 treat it as if it is a continued connection (apart from the counter used
4508 for the log line mark). */
4510 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4513 debug_printf("lazy-callout-close: have conn still open from verification\n");
4514 continue_transport = cutthrough.transport;
4515 continue_hostname = string_copy(cutthrough.host.name);
4516 continue_host_address = string_copy(cutthrough.host.address);
4517 continue_sequence = 1;
4518 sending_ip_address = cutthrough.snd_ip;
4519 sending_port = cutthrough.snd_port;
4520 smtp_peer_options = cutthrough.peer_options;
4523 /* If this is a run to continue delivery down an already-established
4524 channel, check that this set of addresses matches the transport and
4525 the channel. If it does not, defer the addresses. If a host list exists,
4526 we must check that the continue host is on the list. Otherwise, the
4527 host is set in the transport. */
4529 f.continue_more = FALSE; /* In case got set for the last lot */
4530 if (continue_transport)
4532 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4533 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4535 /* If the transport is about to override the host list do not check
4536 it here but take the cost of running the transport process to discover
4537 if the continued_hostname connection is suitable. This is a layering
4538 violation which is unfortunate as it requires we haul in the smtp
4543 smtp_transport_options_block * ob;
4545 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4546 && (ob = (smtp_transport_options_block *)tp->options_block)
4547 && ob->hosts_override && ob->hosts
4553 for (host_item * h = addr->host_list; h; h = h->next)
4554 if (Ustrcmp(h->name, continue_hostname) == 0)
4555 /*XXX should also check port here */
4556 { ok = TRUE; break; }
4560 /* Addresses not suitable; defer or queue for fallback hosts (which
4561 might be the continue host) and skip to next address. */
4565 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4566 Ustrcmp(continue_transport, tp->name) != 0
4567 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4568 : string_sprintf("no host matching %s", continue_hostname));
4569 if (serialize_key) enq_end(serialize_key);
4571 if (addr->fallback_hosts && !fallback)
4573 for (next = addr; ; next = next->next)
4575 next->host_list = next->fallback_hosts;
4576 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4577 if (!next->next) break;
4579 next->next = addr_fallback;
4580 addr_fallback = addr;
4585 for (next = addr; ; next = next->next)
4587 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4588 if (!next->next) break;
4590 next->next = addr_defer;
4597 /* Set a flag indicating whether there are further addresses that list
4598 the continued host. This tells the transport to leave the channel open,
4599 but not to pass it to another delivery process. We'd like to do that
4600 for non-continue_transport cases too but the knowlege of which host is
4601 connected to is too hard to manage. Perhaps we need a finer-grain
4602 interface to the transport. */
4604 for (next = addr_remote; next && !f.continue_more; next = next->next)
4605 for (host_item * h = next->host_list; h; h = h->next)
4606 if (Ustrcmp(h->name, continue_hostname) == 0)
4607 { f.continue_more = TRUE; break; }
4610 /* The transports set up the process info themselves as they may connect
4611 to more than one remote machine. They also have to set up the filter
4612 arguments, if required, so that the host name and address are available
4615 transport_filter_argv = NULL;
4617 /* Create the pipe for inter-process communication. If pipe creation
4618 fails, it is probably because the value of remote_max_parallel is so
4619 large that too many file descriptors for pipes have been created. Arrange
4620 to wait for a process to finish, and then try again. If we still can't
4621 create a pipe when all processes have finished, break the retry loop. */
4625 if (pipe(pfd) == 0) pipe_done = TRUE;
4626 else if (parcount > 0) parmax = parcount;
4629 /* We need to make the reading end of the pipe non-blocking. There are
4630 two different options for this. Exim is cunningly (I hope!) coded so
4631 that it can use either of them, though it prefers O_NONBLOCK, which
4632 distinguishes between EOF and no-more-data. */
4634 /* The data appears in a timely manner and we already did a poll on
4635 all pipes, so I do not see a reason to use non-blocking IO here
4638 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4640 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4644 /* If the maximum number of subprocesses already exist, wait for a process
4645 to finish. If we ran out of file descriptors, parmax will have been reduced
4646 from its initial value of remote_max_parallel. */
4648 par_reduce(parmax - 1, fallback);
4651 /* If we failed to create a pipe and there were no processes to wait
4652 for, we have to give up on this one. Do this outside the above loop
4653 so that we can continue the main loop. */
4657 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4661 /* Find a free slot in the pardata list. Must do this after the possible
4662 waiting for processes to finish, because a terminating process will free
4665 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4666 if (parlist[poffset].pid == 0)
4669 /* If there isn't one, there has been a horrible disaster. */
4671 if (poffset >= remote_max_parallel)
4673 (void)close(pfd[pipe_write]);
4674 (void)close(pfd[pipe_read]);
4675 panicmsg = US"Unexpectedly no free subprocess slot";
4679 /* Now fork a subprocess to do the remote delivery, but before doing so,
4680 ensure that any cached resources are released so as not to interfere with
4681 what happens in the subprocess. */
4685 if ((pid = exim_fork(US"transport")) == 0)
4687 int fd = pfd[pipe_write];
4690 /* Setting these globals in the subprocess means we need never clear them */
4692 transport_name = tp->name;
4693 if (addr->router) router_name = addr->router->name;
4694 driver_srcfile = tp->srcfile;
4695 driver_srcline = tp->srcline;
4697 /* There are weird circumstances in which logging is disabled */
4698 f.disable_logging = tp->disable_logging;
4700 /* Show pids on debug output if parallelism possible */
4702 if (parmax > 1 && (parcount > 0 || addr_remote))
4703 DEBUG(D_any|D_v) debug_selector |= D_pid;
4705 /* Reset the random number generator, so different processes don't all
4706 have the same sequence. In the test harness we want different, but
4707 predictable settings for each delivery process, so do something explicit
4708 here rather they rely on the fixed reset in the random number function. */
4710 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4712 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4713 a new process that may be forked to do another delivery down the same
4716 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4718 /* Close open file descriptors for the pipes of other processes
4719 that are running in parallel. */
4721 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4722 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4724 /* This process has inherited a copy of the file descriptor
4725 for the data file, but its file pointer is shared with all the
4726 other processes running in parallel. Therefore, we have to re-open
4727 the file in order to get a new file descriptor with its own
4728 file pointer. We don't need to lock it, as the lock is held by
4729 the parent process. There doesn't seem to be any way of doing
4730 a dup-with-new-file-pointer. */
4732 (void)close(deliver_datafile);
4734 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4736 if ( (deliver_datafile = Uopen(fname, EXIM_CLOEXEC | O_RDWR | O_APPEND, 0))
4738 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4739 "parallel delivery: %s", fname, strerror(errno));
4742 #ifndef O_CLOEXEC /* Set the close-on-exec flag */
4743 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4747 /* Set the uid/gid of this process; bombs out on failure. */
4749 exim_setugid(uid, gid, use_initgroups,
4750 string_sprintf("remote delivery to %s with transport=%s",
4751 addr->address, tp->name));
4753 /* Close the unwanted half of this process' pipe, set the process state,
4754 and run the transport. Afterwards, transport_count will contain the number
4755 of bytes written. */
4757 (void)close(pfd[pipe_read]);
4758 set_process_info("delivering %s using %s", message_id, tp->name);
4759 debug_print_string(tp->debug_string);
4760 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4762 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4763 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4765 /* Ensure any cached resources that we used are now released */
4769 /* Pass the result back down the pipe. This is a lot more information
4770 than is needed for a local delivery. We have to send back the error
4771 status for each address, the usability status for each host that is
4772 flagged as unusable, and all the retry items. When TLS is in use, we
4773 send also the cipher and peerdn information. Each type of information
4774 is flagged by an identifying byte, and is then in a fixed format (with
4775 strings terminated by zeros), and there is a final terminator at the
4776 end. The host information and retry information is all attached to
4777 the first address, so that gets sent at the start. */
4779 /* Host unusability information: for most success cases this will
4782 for (h = addr->host_list; h; h = h->next)
4784 if (!h->address || h->status < hstatus_unusable) continue;
4785 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4786 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4789 /* The number of bytes written. This is the same for each address. Even
4790 if we sent several copies of the message down the same connection, the
4791 size of each one is the same, and it's that value we have got because
4792 transport_count gets reset before calling transport_write_message(). */
4794 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4795 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4797 /* Information about what happened to each address. Four item types are
4798 used: an optional 'X' item first, for TLS information, then an optional "C"
4799 item for any client-auth info followed by 'R' items for any retry settings,
4800 and finally an 'A' item for the remaining data. */
4802 for(; addr; addr = addr->next)
4806 /* The certificate verification status goes into the flags */
4807 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4809 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4811 # ifndef DISABLE_TLS_RESUME
4812 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4815 /* Use an X item only if there's something to send */
4819 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4823 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4825 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4827 else if (continue_proxy_cipher)
4829 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4831 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4837 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4841 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4846 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4850 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4852 # ifndef DISABLE_OCSP
4853 if (addr->ocsp > OCSP_NOT_REQ)
4855 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4856 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4859 #endif /*DISABLE_TLS*/
4861 if (client_authenticator)
4863 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4864 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4866 if (client_authenticated_id)
4868 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4869 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4871 if (client_authenticated_sender)
4873 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4874 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4877 #ifndef DISABLE_PRDR
4878 if (testflag(addr, af_prdr_used))
4879 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4882 if (testflag(addr, af_pipelining))
4883 #ifndef DISABLE_PIPE_CONNECT
4884 if (testflag(addr, af_early_pipe))
4885 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4888 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4890 if (testflag(addr, af_chunking_used))
4891 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4893 if (testflag(addr, af_tcp_fastopen_conn))
4894 rmt_dlv_checked_write(fd, 'T',
4895 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4899 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4900 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4902 /* Retry information: for most success cases this will be null. */
4904 for (retry_item * r = addr->retries; r; r = r->next)
4906 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4907 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4908 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4909 ptr += sizeof(r->basic_errno);
4910 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4911 ptr += sizeof(r->more_errno);
4912 if (!r->message) *ptr++ = 0; else
4914 sprintf(CS ptr, "%.512s", r->message);
4917 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4920 #ifndef DISABLE_DKIM
4921 if (addr->dkim_used && LOGGING(dkim_verbose))
4923 DEBUG(D_deliver) debug_printf("dkim used: %s\n", addr->dkim_used);
4924 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->dkim_used) + 1;
4925 rmt_dlv_checked_write(fd, 'A', '4', big_buffer, ptr - big_buffer);
4929 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4931 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4932 testflag(addr, af_new_conn) ? "non-" : "");
4933 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4934 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4937 #ifdef SUPPORT_SOCKS
4938 if (LOGGING(proxy) && proxy_session)
4941 if (proxy_local_address)
4943 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4944 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4945 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4946 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4947 ptr += sizeof(proxy_local_port);
4951 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4955 #ifdef EXPERIMENTAL_DSN_INFO
4956 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4957 if (addr->smtp_greeting)
4959 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4960 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4961 if (addr->helo_response)
4963 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4964 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4968 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4972 /* The rest of the information goes in an 'A0' item. */
4974 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4975 ptr = big_buffer + 2;
4976 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4977 ptr += sizeof(addr->basic_errno);
4978 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4979 ptr += sizeof(addr->more_errno);
4980 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4981 ptr += sizeof(addr->delivery_time);
4982 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4983 ptr += sizeof(addr->flags);
4985 if (!addr->message) *ptr++ = 0; else
4986 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4988 if (!addr->user_message) *ptr++ = 0; else
4989 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4991 if (!addr->host_used) *ptr++ = 0; else
4993 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4994 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4995 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4996 ptr += sizeof(addr->host_used->port);
4998 /* DNS lookup status */
4999 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
5000 : addr->host_used->dnssec==DS_NO ? '1' : '0';
5003 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
5006 /* Local interface address/port */
5007 #ifdef EXPERIMENTAL_DSN_INFO
5008 if (sending_ip_address)
5010 if (LOGGING(incoming_interface) && sending_ip_address)
5014 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
5015 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
5016 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
5019 /* Add termination flag, close the pipe, and that's it. The character
5020 after 'Z' indicates whether continue_transport is now NULL or not.
5021 A change from non-NULL to NULL indicates a problem with a continuing
5024 big_buffer[0] = continue_transport ? '1' : '0';
5025 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5030 /* Back in the mainline: close the unwanted half of the pipe. */
5032 (void)close(pfd[pipe_write]);
5034 /* If we have a connection still open from a verify stage (lazy-close)
5035 release its TLS library context (if any) as responsibility was passed to
5036 the delivery child process. */
5038 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5041 if (cutthrough.is_tls)
5042 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5044 (void) close(cutthrough.cctx.sock);
5045 release_cutthrough_connection(US"passed to transport proc");
5048 /* Fork failed; defer with error message */
5052 (void)close(pfd[pipe_read]);
5053 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5054 addr->domain, strerror(errno));
5058 /* Fork succeeded; increment the count, and remember relevant data for
5059 when the process finishes. */
5062 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5063 parlist[poffset].pid = pid;
5064 parlist[poffset].fd = pfd[pipe_read];
5065 parlist[poffset].done = FALSE;
5066 parlist[poffset].msg = NULL;
5067 parlist[poffset].return_path = return_path;
5069 /* If the process we've just started is sending a message down an existing
5070 channel, wait for it now. This ensures that only one such process runs at
5071 once, whatever the value of remote_max parallel. Otherwise, we might try to
5072 send two or more messages simultaneously down the same channel. This could
5073 happen if there are different domains that include the same host in otherwise
5074 different host lists.
5076 Also, if the transport closes down the channel, this information gets back
5077 (continue_transport gets set to NULL) before we consider any other addresses
5080 if (continue_transport) par_reduce(0, fallback);
5082 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5083 newly created process get going before we create another process. This should
5084 ensure repeatability in the tests. Wait long enough for most cases to complete
5087 else testharness_pause_ms(600);
5092 if (serialize_key) enq_end(serialize_key);
5094 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5098 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5099 are still running and post-process their addresses. */
5101 par_reduce(0, fallback);
5108 /*************************************************
5109 * Split an address into local part and domain *
5110 *************************************************/
5112 /* This function initializes an address for routing by splitting it up into a
5113 local part and a domain. The local part is set up twice - once in its original
5114 casing, and once in lower case, and it is dequoted. We also do the "percent
5115 hack" for configured domains. This may lead to a DEFER result if a lookup
5116 defers. When a percent-hacking takes place, we insert a copy of the original
5117 address as a new parent of this address, as if we have had a redirection.
5120 addr points to an addr_item block containing the address
5123 DEFER - could not determine if domain is %-hackable
5127 deliver_split_address(address_item * addr)
5129 const uschar * address = addr->address;
5134 if (!(domain = Ustrrchr(address, '@')))
5135 return DEFER; /* should always have a domain, but just in case... */
5137 len = domain - address;
5138 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5140 /* The implication in the RFCs (though I can't say I've seen it spelled out
5141 explicitly) is that quoting should be removed from local parts at the point
5142 where they are locally interpreted. [The new draft "821" is more explicit on
5143 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5144 removing quoting backslashes and any unquoted doublequotes. */
5146 addr->cc_local_part = t = store_get(len+1, address);
5150 if (c == '\"') continue;
5160 /* We do the percent hack only for those domains that are listed in
5161 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5163 if (percent_hack_domains)
5166 uschar * new_address = NULL;
5167 const uschar * local_part = addr->cc_local_part;
5169 deliver_domain = addr->domain; /* set $domain */
5171 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5172 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5174 && (t = Ustrrchr(local_part, '%')) != NULL
5177 new_address = string_copy(local_part);
5178 new_address[t - local_part] = '@';
5179 deliver_domain = string_copylc(t+1);
5180 local_part = string_copyn(local_part, t - local_part);
5183 if (rc == DEFER) return DEFER; /* lookup deferred */
5185 /* If hackery happened, set up new parent and alter the current address. */
5189 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5190 *new_parent = *addr;
5191 addr->parent = new_parent;
5192 new_parent->child_count = 1;
5193 addr->address = new_address;
5194 addr->unique = string_copy(new_address);
5195 addr->domain = deliver_domain;
5196 addr->cc_local_part = local_part;
5197 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5202 /* Create the lowercased version of the final local part, and make that the
5203 default one to be used. */
5205 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5212 /*************************************************
5213 * Get next error message text *
5214 *************************************************/
5216 /* If f is not NULL, read the next "paragraph", from a customized error message
5217 text file, terminated by a line containing ****, and expand it.
5220 f NULL or a file to read from
5221 which string indicating which string (for errors)
5223 Returns: NULL or an expanded string
5227 next_emf(FILE *f, uschar *which)
5233 if (!f) return NULL;
5235 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5238 para = string_get(256);
5241 para = string_cat(para, buffer);
5242 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5245 if ((yield = expand_string(string_from_gstring(para))))
5248 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5249 "bounce_message_file or warn_message_file (%s): %s", which,
5250 expand_string_message);
5257 /*************************************************
5258 * Close down a passed transport channel *
5259 *************************************************/
5261 /* This function is called when a passed transport channel cannot be used.
5262 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5263 so that the function call can be the argument of a "return" statement.
5266 Returns: DELIVER_NOT_ATTEMPTED
5270 continue_closedown(void)
5272 if (continue_transport)
5273 for (transport_instance * t = transports; t; t = t->next)
5274 if (Ustrcmp(t->name, continue_transport) == 0)
5276 if (t->info->closedown) (t->info->closedown)(t);
5279 return DELIVER_NOT_ATTEMPTED;
5285 /*************************************************
5286 * Print address information *
5287 *************************************************/
5289 /* This function is called to output an address, or information about an
5290 address, for bounce or defer messages. If the hide_child flag is set, all we
5291 output is the original ancestor address.
5294 addr points to the address
5295 f the FILE to print to
5296 si an initial string
5297 sc a continuation string for before "generated"
5300 Returns: TRUE if the address is not hidden
5304 print_address_information(address_item * addr, FILE * f, uschar * si,
5305 uschar * sc, uschar * se)
5308 const uschar * printed = US"";
5309 address_item * ancestor = addr;
5310 while (ancestor->parent) ancestor = ancestor->parent;
5312 fprintf(f, "%s", CS si);
5314 if (addr->parent && testflag(addr, af_hide_child))
5316 printed = US"an undisclosed address";
5319 else if (!testflag(addr, af_pfr) || !addr->parent)
5320 printed = addr->address;
5324 const uschar * s = addr->address;
5327 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5328 else if (addr->address[0] == '|') ss = US"pipe";
5331 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5332 printed = addr->parent->address;
5335 fprintf(f, "%s", CS string_printing(printed));
5337 if (ancestor != addr)
5339 const uschar * original = ancestor->onetime_parent;
5340 if (!original) original= ancestor->address;
5341 if (strcmpic(original, printed) != 0)
5342 fprintf(f, "%s(%sgenerated from %s)", sc,
5343 ancestor != addr->parent ? "ultimately " : "",
5344 string_printing(original));
5347 if (addr->host_used)
5348 fprintf(f, "\n host %s [%s]",
5349 addr->host_used->name, addr->host_used->address);
5351 fprintf(f, "%s", CS se);
5359 /*************************************************
5360 * Print error for an address *
5361 *************************************************/
5363 /* This function is called to print the error information out of an address for
5364 a bounce or a warning message. It tries to format the message reasonably by
5365 introducing newlines. All lines are indented by 4; the initial printing
5366 position must be set before calling.
5368 This function used always to print the error. Nowadays we want to restrict it
5369 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5370 and filter "fail". We no longer pass other information willy-nilly in bounce
5371 and warning messages. Text in user_message is always output; text in message
5372 only if the af_pass_message flag is set.
5376 f the FILE to print on
5383 print_address_error(address_item * addr, FILE * f, const uschar * t)
5385 int count = Ustrlen(t);
5386 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5388 if (!s && !(s = addr->user_message))
5391 fprintf(f, "\n %s", t);
5394 if (*s == '\\' && s[1] == 'n')
5404 if (*s++ == ':' && isspace(*s) && count > 45)
5406 fprintf(f, "\n "); /* sic (because space follows) */
5409 else if (count > 254) /* arbitrary limit */
5411 fprintf(f, "[truncated]");
5412 do s++; while (*s && !(*s == '\\' && s[1] == '\n'));
5418 /***********************************************************
5419 * Print Diagnostic-Code for an address *
5420 ************************************************************/
5422 /* This function is called to print the error information out of an address for
5423 a bounce or a warning message. It tries to format the message reasonably as
5424 required by RFC 3461 by adding a space after each newline
5426 it uses the same logic as print_address_error() above. if af_pass_message is true
5427 and addr->message is set it uses the remote host answer. if not addr->user_message
5428 is used instead if available.
5432 f the FILE to print on
5438 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5440 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5443 /* af_pass_message and addr->message set ? print remote host answer */
5448 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5450 /* search first ": ". we assume to find the remote-MTA answer there */
5451 if (!(s = Ustrstr(addr->message, ": ")))
5452 return; /* not found, bail out */
5454 s += 2; /* skip ": " */
5455 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5459 if (cnt > 950) /* RFC line length limit: 998 */
5461 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5462 fputs("[truncated]", f);
5466 if (*s == '\\' && s[1] == 'n')
5468 fputs("\n ", f); /* as defined in RFC 3461 */
5483 /*************************************************
5484 * Check list of addresses for duplication *
5485 *************************************************/
5487 /* This function was introduced when the test for duplicate addresses that are
5488 not pipes, files, or autoreplies was moved from the middle of routing to when
5489 routing was complete. That was to fix obscure cases when the routing history
5490 affects the subsequent routing of identical addresses. This function is called
5491 after routing, to check that the final routed addresses are not duplicates.
5493 If we detect a duplicate, we remember what it is a duplicate of. Note that
5494 pipe, file, and autoreply de-duplication is handled during routing, so we must
5495 leave such "addresses" alone here, as otherwise they will incorrectly be
5498 Argument: address of list anchor
5503 do_duplicate_check(address_item **anchor)
5506 while ((addr = *anchor))
5509 if (testflag(addr, af_pfr))
5511 anchor = &(addr->next);
5513 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5515 DEBUG(D_deliver|D_route)
5516 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5517 *anchor = addr->next;
5518 addr->dupof = tnode->data.ptr;
5519 addr->next = addr_duplicate;
5520 addr_duplicate = addr;
5524 tree_add_duplicate(addr->unique, addr);
5525 anchor = &(addr->next);
5533 /************************************************/
5536 print_dsn_addr_action(FILE * f, address_item * addr,
5537 uschar * action, uschar * status)
5541 if (addr->dsn_orcpt)
5542 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5544 for (pa = addr; pa->parent; ) pa = pa->parent;
5545 fprintf(f, "Action: %s\n"
5546 "Final-Recipient: rfc822;%s\n"
5548 action, pa->address, status);
5553 /* When running in the test harness, there's an option that allows us to
5554 fudge this time so as to get repeatability of the tests. Take the first
5555 time off the list. In queue runs, the list pointer gets updated in the
5559 test_harness_fudged_queue_time(int actual_time)
5562 if ( f.running_in_test_harness && *fudged_queue_times
5563 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5565 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5566 fudged_queue_times);
5572 /************************************************/
5575 expand_open(const uschar * filename,
5576 const uschar * optname, const uschar * reason)
5578 const uschar * s = expand_cstring(filename);
5582 log_write(0, LOG_MAIN|LOG_PANIC,
5583 "Failed to expand %s: '%s'\n", optname, filename);
5584 else if (*s != '/' || is_tainted(s))
5585 log_write(0, LOG_MAIN|LOG_PANIC,
5586 "%s is not %s after expansion: '%s'\n",
5587 optname, *s == '/' ? "untainted" : "absolute", s);
5588 else if (!(fp = Ufopen(s, "rb")))
5589 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5590 "message texts: %s", s, reason, strerror(errno));
5595 /* Output the given header and string, converting either
5596 the sequence "\n" or a real newline into newline plus space.
5597 If that still takes us past column 78, look for the last space
5598 and split there too.
5599 Append a newline if string did not have one.
5600 Limit to about 1024 chars total. */
5603 dsn_put_wrapped(FILE * fp, const uschar * header, const uschar * s)
5605 gstring * g = string_cat(NULL, header);
5607 g = string_cat(g, s);
5608 gstring_release_unused(g);
5609 fprintf(fp, "%s\n", wrap_header(string_from_gstring(g), 79, 1023, US" ", 1));
5615 /*************************************************
5616 * Send a bounce message *
5617 *************************************************/
5619 /* Find the error address for the first address, then send a message that
5620 includes all failed addresses that have the same error address. Note the
5621 bounce_recipient is a global so that it can be accessed by $bounce_recipient
5622 while creating a customized error message. */
5625 send_bounce_message(time_t now, const uschar * logtod)
5630 if (!(bounce_recipient = addr_failed->prop.errors_address))
5631 bounce_recipient = sender_address;
5633 /* Make a subprocess to send a message, using its stdin */
5635 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
5636 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5637 "create child process to send failure message: %s", getpid(),
5638 getppid(), strerror(errno));
5640 /* Creation of child succeeded */
5644 int ch, rc, filecount = 0, rcount = 0;
5645 uschar * bcc, * emf_text;
5646 FILE * fp = fdopen(fd, "wb"), * emf = NULL;
5647 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5648 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5649 DELIVER_IN_BUFFER_SIZE;
5650 uschar * bound, * dsnlimitmsg, * dsnnotifyhdr;
5652 address_item ** paddr;
5653 address_item * msgchain = NULL, ** pmsgchain = &msgchain;
5654 address_item * handled_addr = NULL;
5657 debug_printf("sending error message to: %s\n", bounce_recipient);
5659 /* Scan the addresses for all that have the same errors address, removing
5660 them from the addr_failed chain, and putting them on msgchain. */
5662 paddr = &addr_failed;
5663 for (address_item * addr = addr_failed; addr; addr = *paddr)
5664 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
5665 ? addr->prop.errors_address : sender_address) == 0)
5666 { /* The same - dechain */
5667 *paddr = addr->next;
5670 pmsgchain = &addr->next;
5673 paddr = &addr->next; /* Not the same; skip */
5675 /* Include X-Failed-Recipients: for automatic interpretation, but do
5676 not let any one header line get too long. We do this by starting a
5677 new header every 50 recipients. Omit any addresses for which the
5678 "hide_child" flag is set. */
5680 for (address_item * addr = msgchain; addr; addr = addr->next)
5682 if (testflag(addr, af_hide_child)) continue;
5690 ? "X-Failed-Recipients: "
5692 testflag(addr, af_pfr) && addr->parent
5693 ? string_printing(addr->parent->address)
5694 : string_printing(addr->address));
5696 if (rcount > 0) fprintf(fp, "\n");
5698 /* Output the standard headers */
5700 if (errors_reply_to)
5701 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
5702 fprintf(fp, "Auto-Submitted: auto-replied\n");
5703 moan_write_from(fp);
5704 fprintf(fp, "To: %s\n", bounce_recipient);
5705 moan_write_references(fp, NULL);
5707 /* generate boundary string and output MIME-Headers */
5708 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
5710 fprintf(fp, "Content-Type: multipart/report;"
5711 " report-type=delivery-status; boundary=%s\n"
5712 "MIME-Version: 1.0\n",
5715 /* Open a template file if one is provided. Log failure to open, but
5716 carry on - default texts will be used. */
5718 GET_OPTION("bounce_message_file");
5719 if (bounce_message_file)
5720 emf = expand_open(bounce_message_file,
5721 US"bounce_message_file", US"error");
5723 /* Quietly copy to configured additional addresses if required. */
5725 if ((bcc = moan_check_errorcopy(bounce_recipient)))
5726 fprintf(fp, "Bcc: %s\n", bcc);
5728 /* The texts for the message can be read from a template file; if there
5729 isn't one, or if it is too short, built-in texts are used. The first
5730 emf text is a Subject: and any other headers. */
5732 if ((emf_text = next_emf(emf, US"header")))
5733 fprintf(fp, "%s\n", emf_text);
5735 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
5736 to_sender? ": returning message to sender" : "");
5738 /* output human readable part as text/plain section */
5739 fprintf(fp, "--%s\n"
5740 "Content-type: text/plain; charset=us-ascii\n\n",
5743 if ((emf_text = next_emf(emf, US"intro")))
5744 fprintf(fp, "%s", CS emf_text);
5748 /* This message has been reworded several times. It seems to be confusing to
5749 somebody, however it is worded. I have retreated to the original, simple
5751 "This message was created automatically by mail delivery software.\n");
5753 if (bounce_message_text)
5754 fprintf(fp, "%s", CS bounce_message_text);
5757 "\nA message that you sent could not be delivered to one or more of its\n"
5758 "recipients. This is a permanent error. The following address(es) failed:\n");
5761 "\nA message sent by\n\n <%s>\n\n"
5762 "could not be delivered to one or more of its recipients. The following\n"
5763 "address(es) failed:\n", sender_address);
5767 /* Process the addresses, leaving them on the msgchain if they have a
5768 file name for a return message. (There has already been a check in
5769 post_process_one() for the existence of data in the message file.) A TRUE
5770 return from print_address_information() means that the address is not
5774 for (address_item * addr = msgchain; addr; addr = *paddr)
5776 if (print_address_information(addr, fp, US" ", US"\n ", US""))
5777 print_address_error(addr, fp, US"");
5779 /* End the final line for the address */
5783 /* Leave on msgchain if there's a return file. */
5785 if (addr->return_file >= 0)
5787 paddr = &addr->next;
5791 /* Else save so that we can tick off the recipient when the
5796 *paddr = addr->next;
5797 addr->next = handled_addr;
5798 handled_addr = addr;
5804 /* Get the next text, whether we need it or not, so as to be
5805 positioned for the one after. */
5807 emf_text = next_emf(emf, US"generated text");
5809 /* If there were any file messages passed by the local transports,
5810 include them in the message. Then put the address on the handled chain.
5811 In the case of a batch of addresses that were all sent to the same
5812 transport, the return_file field in all of them will contain the same
5813 fd, and the return_filename field in the *last* one will be set (to the
5814 name of the file). */
5818 address_item * nextaddr;
5821 fprintf(fp, "%s", CS emf_text);
5824 "The following text was generated during the delivery "
5825 "attempt%s:\n", (filecount > 1)? "s" : "");
5827 for (address_item * addr = msgchain; addr; addr = nextaddr)
5830 address_item *topaddr = addr;
5832 /* List all the addresses that relate to this file */
5835 while(addr) /* Insurance */
5837 print_address_information(addr, fp, US"------ ", US"\n ",
5839 if (addr->return_filename) break;
5844 /* Now copy the file */
5846 if (!(fm = Ufopen(addr->return_filename, "rb")))
5847 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
5851 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
5854 Uunlink(addr->return_filename);
5856 /* Can now add to handled chain, first fishing off the next
5857 address on the msgchain. */
5859 nextaddr = addr->next;
5860 addr->next = handled_addr;
5861 handled_addr = topaddr;
5866 /* output machine readable part */
5868 if (message_smtputf8)
5869 fprintf(fp, "--%s\n"
5870 "Content-type: message/global-delivery-status\n\n"
5871 "Reporting-MTA: dns; %s\n",
5872 bound, smtp_active_hostname);
5875 fprintf(fp, "--%s\n"
5876 "Content-type: message/delivery-status\n\n"
5877 "Reporting-MTA: dns; %s\n",
5878 bound, smtp_active_hostname);
5882 /* must be decoded from xtext: see RFC 3461:6.3a */
5883 uschar * xdec_envid;
5884 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
5885 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
5887 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
5891 for (address_item * addr = handled_addr; addr; addr = addr->next)
5894 #ifdef EXPERIMENTAL_DSN_INFO
5898 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
5900 if ((hu = addr->host_used) && hu->name)
5902 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
5903 #ifdef EXPERIMENTAL_DSN_INFO
5906 uschar * p = hu->port == 25
5907 ? US"" : string_sprintf(":%d", hu->port);
5908 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
5910 if ((s = addr->smtp_greeting) && *s)
5911 dsn_put_wrapped(fp, US"X-Remote-MTA-smtp-greeting: X-str; ", s);
5912 if ((s = addr->helo_response) && *s)
5913 dsn_put_wrapped(fp, US"X-Remote-MTA-helo-response: X-str; ", s);
5914 if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5915 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5917 print_dsn_diagnostic_code(addr, fp);
5919 #ifdef EXPERIMENTAL_DSN_INFO
5920 else if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5921 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5926 /* Now copy the message, trying to give an intelligible comment if
5927 it is too long for it all to be copied. The limit isn't strictly
5928 applied because of the buffering. There is, however, an option
5929 to suppress copying altogether. */
5931 emf_text = next_emf(emf, US"copy");
5934 we ignore the intro text from template and add
5935 the text for bounce_return_size_limit at the end.
5937 bounce_return_message is ignored
5938 in case RET= is defined we honor these values
5939 otherwise bounce_return_body is honored.
5941 bounce_return_size_limit is always honored.
5944 fprintf(fp, "--%s\n", bound);
5946 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
5947 dsnnotifyhdr = NULL;
5948 topt = topt_add_return_path;
5950 /* RET=HDRS? top priority */
5951 if (dsn_ret == dsn_ret_hdrs)
5952 topt |= topt_no_body;
5955 struct stat statbuf;
5957 /* no full body return at all? */
5958 if (!bounce_return_body)
5960 topt |= topt_no_body;
5961 /* add header if we overrule RET=FULL */
5962 if (dsn_ret == dsn_ret_full)
5963 dsnnotifyhdr = dsnlimitmsg;
5965 /* line length limited... return headers only if oversize */
5966 /* size limited ... return headers only if limit reached */
5967 else if ( max_received_linelength > bounce_return_linesize_limit
5968 || ( bounce_return_size_limit > 0
5969 && fstat(deliver_datafile, &statbuf) == 0
5970 && statbuf.st_size > max
5973 topt |= topt_no_body;
5974 dsnnotifyhdr = dsnlimitmsg;
5979 if (message_smtputf8)
5980 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
5981 : "Content-type: message/global\n\n",
5985 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
5986 : "Content-type: message/rfc822\n\n",
5990 transport_filter_argv = NULL; /* Just in case */
5991 return_path = sender_address; /* In case not previously set */
5992 { /* Dummy transport for headers add */
5993 transport_ctx tctx = {{0}};
5994 transport_instance tb = {0};
5996 tctx.u.fd = fileno(fp);
5998 tctx.options = topt | topt_truncate_headers;
5999 tb.add_headers = dsnnotifyhdr;
6001 /*XXX no checking for failure! buggy! */
6002 transport_write_message(&tctx, 0);
6006 /* we never add the final text. close the file */
6010 fprintf(fp, "\n--%s--\n", bound);
6012 /* Close the file, which should send an EOF to the child process
6013 that is receiving the message. Wait for it to finish. */
6016 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6018 /* If the process failed, there was some disaster in setting up the
6019 error message. Unless the message is very old, ensure that addr_defer
6020 is non-null, which will have the effect of leaving the message on the
6021 spool. The failed addresses will get tried again next time. However, we
6022 don't really want this to happen too often, so freeze the message unless
6023 there are some genuine deferred addresses to try. To do this we have
6024 to call spool_write_header() here, because with no genuine deferred
6025 addresses the normal code below doesn't get run. */
6030 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
6032 addr_defer = (address_item *)(+1);
6033 f.deliver_freeze = TRUE;
6034 deliver_frozen_at = time(NULL);
6035 /* Panic-dies on error */
6036 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6039 deliver_msglog("Process failed (%d) when writing error message "
6040 "to %s%s", rc, bounce_recipient, s);
6041 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6042 "to %s%s", rc, bounce_recipient, s);
6045 /* The message succeeded. Ensure that the recipients that failed are
6046 now marked finished with on the spool and their parents updated. */
6050 for (address_item * addr = handled_addr; addr; addr = addr->next)
6052 address_done(addr, logtod);
6053 child_done(addr, logtod);
6055 /* Panic-dies on error */
6056 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6061 /*************************************************
6062 * Send a warning message *
6063 *************************************************/
6064 /* Return: boolean success */
6067 send_warning_message(const uschar * recipients, int queue_time, int show_time)
6070 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
6071 FILE * wmf = NULL, * f = fdopen(fd, "wb");
6072 uschar * wmf_text, * bound;
6073 transport_ctx tctx = {{0}};
6076 if (pid <= 0) return FALSE;
6078 GET_OPTION("warn_message_file");
6079 if (warn_message_file)
6080 wmf = expand_open(warn_message_file,
6081 US"warn_message_file", US"warning");
6083 warnmsg_recipients = recipients;
6084 warnmsg_delay = queue_time < 120*60
6085 ? string_sprintf("%d minutes", show_time/60)
6086 : string_sprintf("%d hours", show_time/3600);
6088 if (errors_reply_to)
6089 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6090 fprintf(f, "Auto-Submitted: auto-replied\n");
6092 fprintf(f, "To: %s\n", recipients);
6093 moan_write_references(f, NULL);
6095 /* generated boundary string and output MIME-Headers */
6096 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6098 fprintf(f, "Content-Type: multipart/report;"
6099 " report-type=delivery-status; boundary=%s\n"
6100 "MIME-Version: 1.0\n",
6103 if ((wmf_text = next_emf(wmf, US"header")))
6104 fprintf(f, "%s\n", wmf_text);
6106 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6107 message_id, warnmsg_delay);
6109 /* output human readable part as text/plain section */
6111 "Content-type: text/plain; charset=us-ascii\n\n",
6114 if ((wmf_text = next_emf(wmf, US"intro")))
6115 fprintf(f, "%s", CS wmf_text);
6119 "This message was created automatically by mail delivery software.\n");
6121 if (Ustrcmp(recipients, sender_address) == 0)
6123 "A message that you sent has not yet been delivered to one or more of its\n"
6124 "recipients after more than ");
6128 "A message sent by\n\n <%s>\n\n"
6129 "has not yet been delivered to one or more of its recipients after more than \n",
6132 fprintf(f, "%s on the queue on %s.\n\n"
6133 "The message identifier is: %s\n",
6134 warnmsg_delay, primary_hostname, message_id);
6136 for (header_line * h = header_list; h; h = h->next)
6137 if (strncmpic(h->text, US"Subject:", 8) == 0)
6138 fprintf(f, "The subject of the message is: %s", h->text + 9);
6139 else if (strncmpic(h->text, US"Date:", 5) == 0)
6140 fprintf(f, "The date of the message is: %s", h->text + 6);
6143 fprintf(f, "The address%s to which the message has not yet been "
6145 !addr_defer->next ? "" : "es",
6146 !addr_defer->next ? "is": "are");
6149 /* List the addresses, with error information if allowed */
6152 for (address_item * addr = addr_defer; addr; addr = addr->next)
6154 if (print_address_information(addr, f, US" ", US"\n ", US""))
6155 print_address_error(addr, f, US"Delay reason: ");
6164 if ((wmf_text = next_emf(wmf, US"final")))
6165 fprintf(f, "%s", CS wmf_text);
6171 "No action is required on your part. Delivery attempts will continue for\n"
6172 "some time, and this warning may be repeated at intervals if the message\n"
6173 "remains undelivered. Eventually the mail delivery software will give up,\n"
6174 "and when that happens, the message will be returned to you.\n");
6177 /* output machine readable part */
6178 fprintf(f, "\n--%s\n"
6179 "Content-type: message/delivery-status\n\n"
6180 "Reporting-MTA: dns; %s\n",
6182 smtp_active_hostname);
6187 /* must be decoded from xtext: see RFC 3461:6.3a */
6189 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6190 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6192 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6196 for (address_item * addr = addr_defer; addr; addr = addr->next)
6200 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
6202 if ((hu = addr->host_used) && hu->name)
6204 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
6205 print_dsn_diagnostic_code(addr, f);
6211 "Content-type: text/rfc822-headers\n\n",
6215 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6216 tctx.u.fd = fileno(f);
6217 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6218 transport_filter_argv = NULL; /* Just in case */
6219 return_path = sender_address; /* In case not previously set */
6221 /* Write the original email out */
6222 /*XXX no checking for failure! buggy! */
6223 transport_write_message(&tctx, 0);
6226 fprintf(f,"\n--%s--\n", bound);
6230 /* Close and wait for child process to complete, without a timeout.
6231 If there's an error, don't update the count. */
6234 return child_close(pid, 0) == 0;
6237 /*************************************************
6238 * Send a success-DSN *
6239 *************************************************/
6242 maybe_send_dsn(const address_item * const addr_succeed)
6244 address_item * addr_senddsn = NULL;
6246 for (const address_item * a = addr_succeed; a; a = a->next)
6248 /* af_ignore_error not honored here. it's not an error */
6249 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
6250 "DSN: processing successful delivery address: %s\n"
6251 "DSN: Sender_address: %s\n"
6252 "DSN: orcpt: %s flags: 0x%x\n"
6253 "DSN: envid: %s ret: %d\n"
6254 "DSN: Final recipient: %s\n"
6255 "DSN: Remote SMTP server supports DSN: %d\n",
6256 a->router ? a->router->name : US"(unknown)",
6259 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
6261 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
6266 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6267 and a report was requested */
6269 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
6270 && a->dsn_flags & rf_notify_success
6273 /* copy and relink address_item and send report with all of them at once later */
6274 address_item * addr_next = addr_senddsn;
6275 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
6277 addr_senddsn->next = addr_next;
6280 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6284 { /* create exim process to send message */
6286 pid_t pid = child_open_exim(&fd, US"DSN");
6288 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6290 if (pid < 0) /* Creation of child failed */
6292 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6293 "create child process to send success-dsn message: %s", getpid(),
6294 getppid(), strerror(errno));
6296 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6298 else /* Creation of child succeeded */
6300 FILE * f = fdopen(fd, "wb");
6301 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6303 transport_ctx tctx = {{0}};
6306 debug_printf("sending success-dsn to: %s\n", sender_address);
6308 /* build unique id for MIME boundary */
6309 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6310 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6312 if (errors_reply_to)
6313 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6316 fprintf(f, "Auto-Submitted: auto-generated\n"
6318 "Subject: Delivery Status Notification\n",
6320 moan_write_references(f, NULL);
6321 fprintf(f, "Content-Type: multipart/report;"
6322 " report-type=delivery-status; boundary=%s\n"
6323 "MIME-Version: 1.0\n\n"
6326 "Content-type: text/plain; charset=us-ascii\n\n"
6328 "This message was created automatically by mail delivery software.\n"
6329 " ----- The following addresses had successful delivery notifications -----\n",
6332 for (address_item * a = addr_senddsn; a; a = a->next)
6333 fprintf(f, "<%s> (relayed %s)\n\n",
6335 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
6336 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
6337 : "via non \"Remote SMTP\" router"
6341 "Content-type: message/delivery-status\n\n"
6342 "Reporting-MTA: dns; %s\n",
6343 bound, smtp_active_hostname);
6346 { /* must be decoded from xtext: see RFC 3461:6.3a */
6347 uschar * xdec_envid;
6348 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6349 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6351 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6355 for (address_item * a = addr_senddsn; a; a = a->next)
6359 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
6361 if ((hu = a->host_used) && hu->name)
6362 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6365 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6366 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
6369 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6372 transport_filter_argv = NULL; /* Just in case */
6373 return_path = sender_address; /* In case not previously set */
6375 /* Write the original email out */
6378 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6379 /*XXX hmm, FALSE(fail) retval ignored.
6380 Could error for any number of reasons, and they are not handled. */
6381 transport_write_message(&tctx, 0);
6384 fprintf(f,"\n--%s--\n", bound);
6388 (void) child_close(pid, 0); /* Waits for child to close, no timeout */
6393 /*************************************************
6394 * Deliver one message *
6395 *************************************************/
6397 /* This is the function which is called when a message is to be delivered. It
6398 is passed the id of the message. It is possible that the message no longer
6399 exists, if some other process has delivered it, and it is also possible that
6400 the message is being worked on by another process, in which case the data file
6403 If no delivery is attempted for any of the above reasons, the function returns
6404 DELIVER_NOT_ATTEMPTED.
6406 If the give_up flag is set true, do not attempt any deliveries, but instead
6407 fail all outstanding addresses and return the message to the sender (or
6410 A delivery operation has a process all to itself; we never deliver more than
6411 one message in the same process. Therefore we needn't worry too much about
6414 Liable to be called as root.
6417 id the id of the message to be delivered
6418 forced TRUE if delivery was forced by an administrator; this overrides
6419 retry delays and causes a delivery to be tried regardless
6420 give_up TRUE if an administrator has requested that delivery attempts
6423 Returns: When the global variable mua_wrapper is FALSE:
6424 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
6425 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
6426 When the global variable mua_wrapper is TRUE:
6427 DELIVER_MUA_SUCCEEDED if delivery succeeded
6428 DELIVER_MUA_FAILED if delivery failed
6429 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
6433 deliver_message(const uschar * id, BOOL forced, BOOL give_up)
6436 int final_yield = DELIVER_ATTEMPTED_NORMAL;
6437 time_t now = time(NULL);
6438 address_item *addr_last = NULL;
6439 uschar *filter_message = NULL;
6440 int process_recipients = RECIP_ACCEPT;
6443 extern int acl_where;
6446 #ifdef MEASURE_TIMING
6447 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
6450 info = queue_run_pid == (pid_t)0
6451 ? string_sprintf("delivering %s", id)
6452 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
6454 /* If the D_process_info bit is on, set_process_info() will output debugging
6455 information. If not, we want to show this initial information if D_deliver or
6456 D_queue_run is set or in verbose mode. */
6458 set_process_info("%s", info);
6460 if ( !(debug_selector & D_process_info)
6461 && (debug_selector & (D_deliver|D_queue_run|D_v))
6463 debug_printf("%s\n", info);
6465 /* Ensure that we catch any subprocesses that are created. Although Exim
6466 sets SIG_DFL as its initial default, some routes through the code end up
6467 here with it set to SIG_IGN - cases where a non-synchronous delivery process
6468 has been forked, but no re-exec has been done. We use sigaction rather than
6469 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
6470 sure it is turned off. (There was a problem on AIX with this.) */
6474 struct sigaction act;
6475 act.sa_handler = SIG_DFL;
6476 sigemptyset(&(act.sa_mask));
6478 sigaction(SIGCHLD, &act, NULL);
6481 signal(SIGCHLD, SIG_DFL);
6484 /* Make the forcing flag available for routers and transports, set up the
6485 global message id field, and initialize the count for returned files and the
6486 message size. This use of strcpy() is OK because the length id is checked when
6487 it is obtained from a command line (the -M or -q options), and otherwise it is
6488 known to be a valid message id. */
6490 if (id != message_id)
6491 Ustrcpy(message_id, id);
6492 f.deliver_force = forced;
6496 /* Initialize some flags */
6498 update_spool = FALSE;
6499 remove_journal = TRUE;
6501 /* Set a known context for any ACLs we call via expansions */
6502 acl_where = ACL_WHERE_DELIVERY;
6504 /* Reset the random number generator, so that if several delivery processes are
6505 started from a queue runner that has already used random numbers (for sorting),
6506 they don't all get the same sequence. */
6510 /* Open and lock the message's data file. Exim locks on this one because the
6511 header file may get replaced as it is re-written during the delivery process.
6512 Any failures cause messages to be written to the log, except for missing files
6513 while queue running - another process probably completed delivery. As part of
6514 opening the data file, message_subdir gets set. */
6516 if ((deliver_datafile = spool_open_datafile(id)) < 0)
6517 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6519 /* tHe value of message_size at this point has been set to the data length,
6520 plus one for the blank line that notionally precedes the data. */
6522 /* Now read the contents of the header file, which will set up the headers in
6523 store, and also the list of recipients and the tree of non-recipients and
6524 assorted flags. It updates message_size. If there is a reading or format error,
6525 give up; if the message has been around for sufficiently long, remove it. */
6528 uschar * spoolname = string_sprintf("%s-H", id);
6529 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
6531 if (errno == ERRNO_SPOOLFORMAT)
6533 struct stat statbuf;
6534 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
6536 log_write(0, LOG_MAIN, "Format error in spool file %s: "
6537 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
6539 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
6542 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
6545 /* If we managed to read the envelope data, received_time contains the
6546 time the message was received. Otherwise, we can calculate it from the
6549 if (rc != spool_read_hdrerror)
6551 received_time.tv_sec = received_time.tv_usec = 0;
6552 /*III subsec precision?*/
6553 for (i = 0; i < MESSAGE_ID_TIME_LEN; i++)
6554 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
6557 /* If we've had this malformed message too long, sling it. */
6559 if (now - received_time.tv_sec > keep_malformed)
6561 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
6562 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
6563 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
6564 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
6565 log_write(0, LOG_MAIN, "Message removed because older than %s",
6566 readconf_printtime(keep_malformed));
6569 (void)close(deliver_datafile);
6570 deliver_datafile = -1;
6571 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6575 /* The spool header file has been read. Look to see if there is an existing
6576 journal file for this message. If there is, it means that a previous delivery
6577 attempt crashed (program or host) before it could update the spool header file.
6578 Read the list of delivered addresses from the journal and add them to the
6579 nonrecipients tree. Then update the spool file. We can leave the journal in
6580 existence, as it will get further successful deliveries added to it in this
6581 run, and it will be deleted if this function gets to its end successfully.
6582 Otherwise it might be needed again. */
6585 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6588 if ( (journal_fd = Uopen(fname,
6589 O_RDWR|O_APPEND | EXIM_CLOEXEC | EXIM_NOFOLLOW, SPOOL_MODE)) >= 0
6590 && lseek(journal_fd, 0, SEEK_SET) == 0
6591 && (jread = fdopen(journal_fd, "rb"))
6594 while (Ufgets(big_buffer, big_buffer_size, jread))
6596 int n = Ustrlen(big_buffer);
6597 big_buffer[n-1] = 0;
6598 tree_add_nonrecipient(big_buffer);
6599 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
6600 "journal file\n", big_buffer);
6603 if ((journal_fd = dup(fileno(jread))) < 0)
6604 journal_fd = fileno(jread);
6606 (void) fclose(jread); /* Try to not leak the FILE resource */
6608 /* Panic-dies on error */
6609 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6611 else if (errno != ENOENT)
6613 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
6614 "%s", strerror(errno));
6615 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6618 /* A null recipients list indicates some kind of disaster. */
6620 if (!recipients_list)
6622 (void)close(deliver_datafile);
6623 deliver_datafile = -1;
6624 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
6625 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6630 /* Handle a message that is frozen. There are a number of different things that
6631 can happen, but in the default situation, unless forced, no delivery is
6634 if (f.deliver_freeze)
6636 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6637 /* Moving to another directory removes the message from Exim's view. Other
6638 tools must be used to deal with it. Logging of this action happens in
6639 spool_move_message() and its subfunctions. */
6641 if ( move_frozen_messages
6642 && spool_move_message(id, message_subdir, US"", US"F")
6644 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6647 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
6648 maximum time to keep messages that are frozen. Thaw if we reach it, with a
6649 flag causing all recipients to be failed. The time is the age of the
6650 message, not the time since freezing. */
6652 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
6654 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
6655 process_recipients = RECIP_FAIL_TIMEOUT;
6658 /* For bounce messages (and others with no sender), thaw if the error message
6659 ignore timer is exceeded. The message will be discarded if this delivery
6662 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
6663 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
6665 /* If this is a bounce message, or there's no auto thaw, or we haven't
6666 reached the auto thaw time yet, and this delivery is not forced by an admin
6667 user, do not attempt delivery of this message. Note that forced is set for
6668 continuing messages down the same channel, in order to skip load checking and
6669 ignore hold domains, but we don't want unfreezing in that case. */
6673 if ( ( sender_address[0] == 0
6675 || now <= deliver_frozen_at + auto_thaw
6677 && ( !forced || !f.deliver_force_thaw
6678 || !f.admin_user || continue_hostname
6681 (void)close(deliver_datafile);
6682 deliver_datafile = -1;
6683 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
6684 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6687 /* If delivery was forced (by an admin user), assume a manual thaw.
6688 Otherwise it's an auto thaw. */
6692 f.deliver_manual_thaw = TRUE;
6693 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
6695 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
6698 /* We get here if any of the rules for unfreezing have triggered. */
6700 f.deliver_freeze = FALSE;
6701 update_spool = TRUE;
6705 /* Open the message log file if we are using them. This records details of
6706 deliveries, deferments, and failures for the benefit of the mail administrator.
6707 The log is not used by exim itself to track the progress of a message; that is
6708 done by rewriting the header spool file. */
6712 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
6716 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
6718 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
6719 fname, strerror(errno));
6720 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6723 /* Make a stdio stream out of it. */
6725 if (!(message_log = fdopen(fd, "a")))
6727 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
6728 fname, strerror(errno));
6729 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6734 /* If asked to give up on a message, log who did it, and set the action for all
6739 struct passwd *pw = getpwuid(real_uid);
6740 log_write(0, LOG_MAIN, "cancelled by %s",
6741 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
6742 process_recipients = RECIP_FAIL;
6745 /* Otherwise, if there are too many Received: headers, fail all recipients. */
6747 else if (received_count > received_headers_max)
6748 process_recipients = RECIP_FAIL_LOOP;
6750 /* Otherwise, if a system-wide, address-independent message filter is
6751 specified, run it now, except in the case when we are failing all recipients as
6752 a result of timeout_frozen_after. If the system filter yields "delivered", then
6753 ignore the true recipients of the message. Failure of the filter file is
6754 logged, and the delivery attempt fails. */
6756 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
6761 redirect_block redirect;
6763 if (system_filter_uid_set)
6765 ugid.uid = system_filter_uid;
6766 ugid.gid = system_filter_gid;
6767 ugid.uid_set = ugid.gid_set = TRUE;
6770 ugid.uid_set = ugid.gid_set = FALSE;
6772 return_path = sender_address;
6773 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
6774 f.system_filtering = TRUE;
6776 /* Any error in the filter file causes a delivery to be abandoned. */
6778 GET_OPTION("system_filter");
6779 redirect.string = system_filter;
6780 redirect.isfile = TRUE;
6781 redirect.check_owner = redirect.check_group = FALSE;
6782 redirect.owners = NULL;
6783 redirect.owngroups = NULL;
6785 redirect.modemask = 0;
6787 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
6790 &redirect, /* Where the data is */
6791 RDO_DEFER | /* Turn on all the enabling options */
6792 RDO_FAIL | /* Leave off all the disabling options */
6797 NULL, /* No :include: restriction (not used in filter) */
6798 NULL, /* No sieve vacation directory (not sieve!) */
6799 NULL, /* No sieve enotify mailto owner (not sieve!) */
6800 NULL, /* No sieve user address (not sieve!) */
6801 NULL, /* No sieve subaddress (not sieve!) */
6802 &ugid, /* uid/gid data */
6803 &addr_new, /* Where to hang generated addresses */
6804 &filter_message, /* Where to put error message */
6805 NULL, /* Don't skip syntax errors */
6806 &filtertype, /* Will always be set to FILTER_EXIM for this call */
6807 US"system filter"); /* For error messages */
6809 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
6811 if (rc == FF_ERROR || rc == FF_NONEXIST)
6813 (void)close(deliver_datafile);
6814 deliver_datafile = -1;
6815 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
6816 string_printing(filter_message));
6817 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6820 /* Reset things. If the filter message is an empty string, which can happen
6821 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
6823 f.system_filtering = FALSE;
6824 f.enable_dollar_recipients = FALSE;
6825 if (filter_message && filter_message[0] == 0) filter_message = NULL;
6827 /* Save the values of the system filter variables so that user filters
6830 memcpy(filter_sn, filter_n, sizeof(filter_sn));
6832 /* The filter can request that delivery of the original addresses be
6837 process_recipients = RECIP_DEFER;
6838 deliver_msglog("Delivery deferred by system filter\n");
6839 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6842 /* The filter can request that a message be frozen, but this does not
6843 take place if the message has been manually thawed. In that case, we must
6844 unset "delivered", which is forced by the "freeze" command to make -bF
6847 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6849 f.deliver_freeze = TRUE;
6850 deliver_frozen_at = time(NULL);
6851 process_recipients = RECIP_DEFER;
6852 frozen_info = string_sprintf(" by the system filter%s%s",
6853 filter_message ? US": " : US"",
6854 filter_message ? filter_message : US"");
6857 /* The filter can request that a message be failed. The error message may be
6858 quite long - it is sent back to the sender in the bounce - but we don't want
6859 to fill up the log with repetitions of it. If it starts with << then the text
6860 between << and >> is written to the log, with the rest left for the bounce
6863 else if (rc == FF_FAIL)
6865 uschar *colon = US"";
6866 uschar *logmsg = US"";
6869 process_recipients = RECIP_FAIL_FILTER;
6875 if ( filter_message[0] == '<'
6876 && filter_message[1] == '<'
6877 && (logend = Ustrstr(filter_message, ">>"))
6880 logmsg = filter_message + 2;
6881 loglen = logend - logmsg;
6882 filter_message = logend + 2;
6883 if (filter_message[0] == 0) filter_message = NULL;
6887 logmsg = filter_message;
6888 loglen = Ustrlen(filter_message);
6892 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6896 /* Delivery can be restricted only to those recipients (if any) that the
6897 filter specified. */
6899 else if (rc == FF_DELIVERED)
6901 process_recipients = RECIP_IGNORE;
6903 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6905 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6908 /* If any new addresses were created by the filter, fake up a "parent"
6909 for them. This is necessary for pipes, etc., which are expected to have
6910 parents, and it also gives some sensible logging for others. Allow
6911 pipes, files, and autoreplies, and run them as the filter uid if set,
6912 otherwise as the current uid. */
6916 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6917 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6919 /* The text "system-filter" is tested in transport_set_up_command() and in
6920 set_up_shell_command() in the pipe transport, to enable them to permit
6921 $recipients, so don't change it here without also changing it there. */
6923 address_item *p = addr_new;
6924 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6926 parent->domain = string_copylc(qualify_domain_recipient);
6927 parent->local_part = US"system-filter";
6929 /* As part of this loop, we arrange for addr_last to end up pointing
6930 at the final address. This is used if we go on to add addresses for the
6931 original recipients. */
6935 if (parent->child_count == USHRT_MAX)
6936 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6937 "than %d delivery addresses", USHRT_MAX);
6938 parent->child_count++;
6941 if (testflag(p, af_pfr))
6947 setflag(p, af_uid_set);
6948 setflag(p, af_gid_set);
6949 setflag(p, af_allow_file);
6950 setflag(p, af_allow_pipe);
6951 setflag(p, af_allow_reply);
6953 /* Find the name of the system filter's appropriate pfr transport */
6955 if (p->address[0] == '|')
6958 GET_OPTION("system_filter_pipe_transport");
6959 tpname = system_filter_pipe_transport;
6960 address_pipe = p->address;
6962 else if (p->address[0] == '>')
6965 GET_OPTION("system_filter_reply_transport");
6966 tpname = system_filter_reply_transport;
6970 if (p->address[Ustrlen(p->address)-1] == '/')
6972 type = US"directory";
6973 GET_OPTION("system_filter_directory_transport");
6974 tpname = system_filter_directory_transport;
6979 GET_OPTION("system_filter_file_transport");
6980 tpname = system_filter_file_transport;
6982 address_file = p->address;
6985 /* Now find the actual transport, first expanding the name. We have
6986 set address_file or address_pipe above. */
6990 uschar *tmp = expand_string(tpname);
6991 address_file = address_pipe = NULL;
6993 p->message = string_sprintf("failed to expand \"%s\" as a "
6994 "system filter transport name", tpname);
6995 if (is_tainted(tmp))
6996 p->message = string_sprintf("attempt to used tainted value '%s' for"
6997 "transport '%s' as a system filter", tmp, tpname);
7001 p->message = string_sprintf("system_filter_%s_transport is unset",
7006 transport_instance *tp;
7007 for (tp = transports; tp; tp = tp->next)
7008 if (Ustrcmp(tp->name, tpname) == 0)
7014 p->message = string_sprintf("failed to find \"%s\" transport "
7015 "for system filter delivery", tpname);
7018 /* If we couldn't set up a transport, defer the delivery, putting the
7019 error on the panic log as well as the main log. */
7023 address_item * badp = p;
7025 if (!addr_last) addr_new = p; else addr_last->next = p;
7026 badp->local_part = badp->address; /* Needed for log line */
7027 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
7030 } /* End of pfr handling */
7032 /* Either a non-pfr delivery, or we found a transport */
7034 DEBUG(D_deliver|D_filter)
7035 debug_printf("system filter added %s\n", p->address);
7039 } /* Loop through all addr_new addresses */
7044 /* Scan the recipients list, and for every one that is not in the non-
7045 recipients tree, add an addr item to the chain of new addresses. If the pno
7046 value is non-negative, we must set the onetime parent from it. This which
7047 points to the relevant entry in the recipients list.
7049 This processing can be altered by the setting of the process_recipients
7050 variable, which is changed if recipients are to be ignored, failed, or
7051 deferred. This can happen as a result of system filter activity, or if the -Mg
7052 option is used to fail all of them.
7054 Duplicate addresses are handled later by a different tree structure; we can't
7055 just extend the non-recipients tree, because that will be re-written to the
7056 spool if the message is deferred, and in any case there are casing
7057 complications for local addresses. */
7059 if (process_recipients != RECIP_IGNORE)
7060 for (i = 0; i < recipients_count; i++)
7061 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
7063 recipient_item * r = recipients_list + i;
7064 address_item * new = deliver_make_addr(r->address, FALSE);
7066 new->prop.errors_address = r->errors_to;
7068 if ((new->prop.utf8_msg = message_smtputf8))
7070 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
7071 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
7072 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
7073 new->prop.utf8_downcvt ? "yes"
7074 : new->prop.utf8_downcvt_maybe ? "ifneeded"
7080 new->onetime_parent = recipients_list[r->pno].address;
7082 /* If DSN support is enabled, set the dsn flags and the original receipt
7083 to be passed on to other DSN enabled MTAs */
7085 new->dsn_flags = r->dsn_flags & rf_dsnflags;
7086 new->dsn_orcpt = r->orcpt;
7087 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
7088 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
7090 switch (process_recipients)
7092 /* RECIP_DEFER is set when a system filter freezes a message. */
7095 new->next = addr_defer;
7100 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
7103 case RECIP_FAIL_FILTER:
7105 filter_message ? filter_message : US"delivery cancelled";
7106 setflag(new, af_pass_message);
7107 goto RECIP_QUEUE_FAILED; /* below */
7110 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
7111 than the value in timeout_frozen_after. Treat non-bounce messages
7112 similarly to -Mg; for bounce messages we just want to discard, so
7113 don't put the address on the failed list. The timeout has already
7116 case RECIP_FAIL_TIMEOUT:
7117 new->message = US"delivery cancelled; message timed out";
7118 goto RECIP_QUEUE_FAILED; /* below */
7121 /* RECIP_FAIL is set when -Mg has been used. */
7124 new->message = US"delivery cancelled by administrator";
7125 /* not setting af_pass_message here means that will not
7126 appear in the bounce message */
7129 /* Common code for the failure cases above. If this is not a bounce
7130 message, put the address on the failed list so that it is used to
7131 create a bounce. Otherwise do nothing - this just discards the address.
7132 The incident has already been logged. */
7135 if (*sender_address)
7137 new->next = addr_failed;
7143 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
7144 in the message. Process each address as a routing failure; if this
7145 is a bounce message, it will get frozen. */
7147 case RECIP_FAIL_LOOP:
7148 new->message = US"Too many \"Received\" headers - suspected mail loop";
7149 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7153 /* Value should be RECIP_ACCEPT; take this as the safe default. */
7156 if (!addr_new) addr_new = new; else addr_last->next = new;
7161 #ifndef DISABLE_EVENT
7162 if (process_recipients != RECIP_ACCEPT && event_action)
7164 const uschar * save_local = deliver_localpart;
7165 const uschar * save_domain = deliver_domain;
7166 const uschar * addr = new->address;
7167 uschar * errmsg = NULL;
7168 int start, end, dom;
7170 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
7171 log_write(0, LOG_MAIN|LOG_PANIC,
7172 "failed to parse address '%.100s': %s\n", addr, errmsg);
7176 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
7177 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
7179 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
7181 deliver_localpart = save_local;
7182 deliver_domain = save_domain;
7190 debug_printf("Delivery address list:\n");
7191 for (address_item * p = addr_new; p; p = p->next)
7192 debug_printf(" %s %s\n", p->address,
7193 p->onetime_parent ? p->onetime_parent : US"");
7196 /* Set up the buffers used for copying over the file when delivering. */
7198 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
7199 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
7203 /* Until there are no more new addresses, handle each one as follows:
7205 . If this is a generated address (indicated by the presence of a parent
7206 pointer) then check to see whether it is a pipe, file, or autoreply, and
7207 if so, handle it directly here. The router that produced the address will
7208 have set the allow flags into the address, and also set the uid/gid required.
7209 Having the routers generate new addresses and then checking them here at
7210 the outer level is tidier than making each router do the checking, and
7211 means that routers don't need access to the failed address queue.
7213 . Break up the address into local part and domain, and make lowercased
7214 versions of these strings. We also make unquoted versions of the local part.
7216 . Handle the percent hack for those domains for which it is valid.
7218 . For child addresses, determine if any of the parents have the same address.
7219 If so, generate a different string for previous delivery checking. Without
7220 this code, if the address spqr generates spqr via a forward or alias file,
7221 delivery of the generated spqr stops further attempts at the top level spqr,
7222 which is not what is wanted - it may have generated other addresses.
7224 . Check on the retry database to see if routing was previously deferred, but
7225 only if in a queue run. Addresses that are to be routed are put on the
7226 addr_route chain. Addresses that are to be deferred are put on the
7227 addr_defer chain. We do all the checking first, so as not to keep the
7228 retry database open any longer than necessary.
7230 . Now we run the addresses through the routers. A router may put the address
7231 on either the addr_local or the addr_remote chain for local or remote
7232 delivery, respectively, or put it on the addr_failed chain if it is
7233 undeliveable, or it may generate child addresses and put them on the
7234 addr_new chain, or it may defer an address. All the chain anchors are
7235 passed as arguments so that the routers can be called for verification
7238 . If new addresses have been generated by the routers, da capo.
7241 f.header_rewritten = FALSE; /* No headers rewritten yet */
7242 while (addr_new) /* Loop until all addresses dealt with */
7244 address_item * addr, * parent;
7246 /* Failure to open the retry database is treated the same as if it does
7247 not exist. In both cases, dbm_file is NULL. */
7249 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
7250 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
7251 debug_printf("no retry data available\n");
7253 /* Scan the current batch of new addresses, to handle pipes, files and
7254 autoreplies, and determine which others are ready for routing. */
7260 dbdata_retry * domain_retry_record, * address_retry_record;
7263 addr_new = addr->next;
7265 DEBUG(D_deliver|D_retry|D_route)
7267 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7268 debug_printf("Considering: %s\n", addr->address);
7271 /* Handle generated address that is a pipe or a file or an autoreply. */
7273 if (testflag(addr, af_pfr))
7275 /* If an autoreply in a filter could not generate a syntactically valid
7276 address, give up forthwith. Set af_ignore_error so that we don't try to
7277 generate a bounce. */
7279 if (testflag(addr, af_bad_reply))
7281 addr->basic_errno = ERRNO_BADADDRESS2;
7282 addr->local_part = addr->address;
7284 US"filter autoreply generated syntactically invalid recipient";
7285 addr->prop.ignore_error = TRUE;
7286 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7287 continue; /* with the next new address */
7290 /* If two different users specify delivery to the same pipe or file or
7291 autoreply, there should be two different deliveries, so build a unique
7292 string that incorporates the original address, and use this for
7293 duplicate testing and recording delivery, and also for retrying. */
7296 string_sprintf("%s:%s", addr->address, addr->parent->unique +
7297 (testflag(addr->parent, af_homonym) ? 3:0));
7299 addr->address_retry_key = addr->domain_retry_key =
7300 string_sprintf("T:%s", addr->unique);
7302 /* If a filter file specifies two deliveries to the same pipe or file,
7303 we want to de-duplicate, but this is probably not wanted for two mail
7304 commands to the same address, where probably both should be delivered.
7305 So, we have to invent a different unique string in that case. Just
7306 keep piling '>' characters on the front. */
7308 if (addr->address[0] == '>')
7309 while (tree_search(tree_duplicates, addr->unique))
7310 addr->unique = string_sprintf(">%s", addr->unique);
7312 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
7314 DEBUG(D_deliver|D_route)
7315 debug_printf("%s is a duplicate address: discarded\n", addr->address);
7316 addr->dupof = tnode->data.ptr;
7317 addr->next = addr_duplicate;
7318 addr_duplicate = addr;
7322 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7324 /* Check for previous delivery */
7326 if (tree_search(tree_nonrecipients, addr->unique))
7328 DEBUG(D_deliver|D_route)
7329 debug_printf("%s was previously delivered: discarded\n", addr->address);
7330 child_done(addr, tod_stamp(tod_log));
7334 /* Save for checking future duplicates */
7336 tree_add_duplicate(addr->unique, addr);
7338 /* Set local part and domain */
7340 addr->local_part = addr->address;
7341 addr->domain = addr->parent->domain;
7343 /* Ensure that the delivery is permitted. */
7345 if (testflag(addr, af_file))
7347 if (!testflag(addr, af_allow_file))
7349 addr->basic_errno = ERRNO_FORBIDFILE;
7350 addr->message = US"delivery to file forbidden";
7351 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7352 continue; /* with the next new address */
7355 else if (addr->address[0] == '|')
7357 if (!testflag(addr, af_allow_pipe))
7359 addr->basic_errno = ERRNO_FORBIDPIPE;
7360 addr->message = US"delivery to pipe forbidden";
7361 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7362 continue; /* with the next new address */
7365 else if (!testflag(addr, af_allow_reply))
7367 addr->basic_errno = ERRNO_FORBIDREPLY;
7368 addr->message = US"autoreply forbidden";
7369 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7370 continue; /* with the next new address */
7373 /* If the errno field is already set to BADTRANSPORT, it indicates
7374 failure to expand a transport string, or find the associated transport,
7375 or an unset transport when one is required. Leave this test till now so
7376 that the forbid errors are given in preference. */
7378 if (addr->basic_errno == ERRNO_BADTRANSPORT)
7380 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7384 /* Treat /dev/null as a special case and abandon the delivery. This
7385 avoids having to specify a uid on the transport just for this case.
7386 Arrange for the transport name to be logged as "**bypassed**".
7387 Copy the transport for this fairly unusual case rather than having
7388 to make all transports mutable. */
7390 if (Ustrcmp(addr->address, "/dev/null") == 0)
7392 transport_instance * save_t = addr->transport;
7393 transport_instance * t = store_get(sizeof(*t), save_t);
7395 t->name = US"**bypassed**";
7396 addr->transport = t;
7397 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
7398 addr->transport= save_t;
7399 continue; /* with the next new address */
7402 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
7405 DEBUG(D_deliver|D_route)
7406 debug_printf("queued for %s transport\n", addr->transport->name);
7407 addr->next = addr_local;
7409 continue; /* with the next new address */
7412 /* Handle normal addresses. First, split up into local part and domain,
7413 handling the %-hack if necessary. There is the possibility of a defer from
7414 a lookup in percent_hack_domains. */
7416 if ((rc = deliver_split_address(addr)) == DEFER)
7418 addr->message = US"cannot check percent_hack_domains";
7419 addr->basic_errno = ERRNO_LISTDEFER;
7420 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7424 /* Check to see if the domain is held. If so, proceed only if the
7425 delivery was forced by hand. */
7427 deliver_domain = addr->domain; /* set $domain */
7428 if ( !forced && hold_domains
7429 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
7430 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
7436 addr->message = US"hold_domains lookup deferred";
7437 addr->basic_errno = ERRNO_LISTDEFER;
7441 addr->message = US"domain is held";
7442 addr->basic_errno = ERRNO_HELD;
7444 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7448 /* Now we can check for duplicates and previously delivered addresses. In
7449 order to do this, we have to generate a "unique" value for each address,
7450 because there may be identical actual addresses in a line of descendents.
7451 The "unique" field is initialized to the same value as the "address" field,
7452 but gets changed here to cope with identically-named descendents. */
7454 for (parent = addr->parent; parent; parent = parent->parent)
7455 if (strcmpic(addr->address, parent->address) == 0) break;
7457 /* If there's an ancestor with the same name, set the homonym flag. This
7458 influences how deliveries are recorded. Then add a prefix on the front of
7459 the unique address. We use \n\ where n starts at 0 and increases each time.
7460 It is unlikely to pass 9, but if it does, it may look odd but will still
7461 work. This means that siblings or cousins with the same names are treated
7462 as duplicates, which is what we want. */
7466 setflag(addr, af_homonym);
7467 if (parent->unique[0] != '\\')
7468 addr->unique = string_sprintf("\\0\\%s", addr->address);
7470 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
7474 /* Ensure that the domain in the unique field is lower cased, because
7475 domains are always handled caselessly. */
7477 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
7479 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7481 if (tree_search(tree_nonrecipients, addr->unique))
7483 DEBUG(D_deliver|D_route)
7484 debug_printf("%s was previously delivered: discarded\n", addr->unique);
7485 child_done(addr, tod_stamp(tod_log));
7489 /* Get the routing retry status, saving the two retry keys (with and
7490 without the local part) for subsequent use. If there is no retry record for
7491 the standard address routing retry key, we look for the same key with the
7492 sender attached, because this form is used by the smtp transport after a
7493 4xx response to RCPT when address_retry_include_sender is true. */
7495 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
7496 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
7501 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
7502 if ( domain_retry_record
7503 && now - domain_retry_record->time_stamp > retry_data_expire
7506 DEBUG(D_deliver|D_retry)
7507 debug_printf("domain retry record present but expired\n");
7508 domain_retry_record = NULL; /* Ignore if too old */
7511 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
7512 if ( address_retry_record
7513 && now - address_retry_record->time_stamp > retry_data_expire
7516 DEBUG(D_deliver|D_retry)
7517 debug_printf("address retry record present but expired\n");
7518 address_retry_record = NULL; /* Ignore if too old */
7521 if (!address_retry_record)
7523 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7525 address_retry_record = dbfn_read(dbm_file, altkey);
7526 if ( address_retry_record
7527 && now - address_retry_record->time_stamp > retry_data_expire)
7529 DEBUG(D_deliver|D_retry)
7530 debug_printf("address<sender> retry record present but expired\n");
7531 address_retry_record = NULL; /* Ignore if too old */
7536 domain_retry_record = address_retry_record = NULL;
7538 DEBUG(D_deliver|D_retry)
7540 if (!domain_retry_record)
7541 debug_printf("no domain retry record\n");
7543 debug_printf("have domain retry record; next_try = now%+d\n",
7544 f.running_in_test_harness ? 0 :
7545 (int)(domain_retry_record->next_try - now));
7547 if (!address_retry_record)
7548 debug_printf("no address retry record\n");
7550 debug_printf("have address retry record; next_try = now%+d\n",
7551 f.running_in_test_harness ? 0 :
7552 (int)(address_retry_record->next_try - now));
7555 /* If we are sending a message down an existing SMTP connection, we must
7556 assume that the message which created the connection managed to route
7557 an address to that connection. We do not want to run the risk of taking
7558 a long time over routing here, because if we do, the server at the other
7559 end of the connection may time it out. This is especially true for messages
7560 with lots of addresses. For this kind of delivery, queue_running is not
7561 set, so we would normally route all addresses. We take a pragmatic approach
7562 and defer routing any addresses that have any kind of domain retry record.
7563 That is, we don't even look at their retry times. It doesn't matter if this
7564 doesn't work occasionally. This is all just an optimization, after all.
7566 The reason for not doing the same for address retries is that they normally
7567 arise from 4xx responses, not DNS timeouts. */
7569 if (continue_hostname && domain_retry_record)
7571 addr->message = US"reusing SMTP connection skips previous routing defer";
7572 addr->basic_errno = ERRNO_RRETRY;
7573 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7575 addr->message = domain_retry_record->text;
7576 setflag(addr, af_pass_message);
7579 /* If we are in a queue run, defer routing unless there is no retry data or
7580 we've passed the next retry time, or this message is forced. In other
7581 words, ignore retry data when not in a queue run.
7583 However, if the domain retry time has expired, always allow the routing
7584 attempt. If it fails again, the address will be failed. This ensures that
7585 each address is routed at least once, even after long-term routing
7588 If there is an address retry, check that too; just wait for the next
7589 retry time. This helps with the case when the temporary error on the
7590 address was really message-specific rather than address specific, since
7591 it allows other messages through.
7593 We also wait for the next retry time if this is a message sent down an
7594 existing SMTP connection (even though that will be forced). Otherwise there
7595 will be far too many attempts for an address that gets a 4xx error. In
7596 fact, after such an error, we should not get here because, the host should
7597 not be remembered as one this message needs. However, there was a bug that
7598 used to cause this to happen, so it is best to be on the safe side.
7600 Even if we haven't reached the retry time in the hints, there is one more
7601 check to do, which is for the ultimate address timeout. We only do this
7602 check if there is an address retry record and there is not a domain retry
7603 record; this implies that previous attempts to handle the address had the
7604 retry_use_local_parts option turned on. We use this as an approximation
7605 for the destination being like a local delivery, for example delivery over
7606 LMTP to an IMAP message store. In this situation users are liable to bump
7607 into their quota and thereby have intermittently successful deliveries,
7608 which keep the retry record fresh, which can lead to us perpetually
7609 deferring messages. */
7611 else if ( ( f.queue_running && !f.deliver_force
7612 || continue_hostname
7614 && ( ( domain_retry_record
7615 && now < domain_retry_record->next_try
7616 && !domain_retry_record->expired
7618 || ( address_retry_record
7619 && now < address_retry_record->next_try
7621 && ( domain_retry_record
7622 || !address_retry_record
7623 || !retry_ultimate_address_timeout(addr->address_retry_key,
7624 addr->domain, address_retry_record, now)
7627 addr->message = US"retry time not reached";
7628 addr->basic_errno = ERRNO_RRETRY;
7629 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7631 /* For remote-retry errors (here and just above) that we've not yet
7632 hit the retry time, use the error recorded in the retry database
7633 as info in the warning message. This lets us send a message even
7634 when we're not failing on a fresh attempt. We assume that this
7635 info is not sensitive. */
7637 addr->message = domain_retry_record
7638 ? domain_retry_record->text : address_retry_record->text;
7639 setflag(addr, af_pass_message);
7642 /* The domain is OK for routing. Remember if retry data exists so it
7643 can be cleaned up after a successful delivery. */
7647 if (domain_retry_record || address_retry_record)
7648 setflag(addr, af_dr_retry_exists);
7649 addr->next = addr_route;
7651 DEBUG(D_deliver|D_route)
7652 debug_printf("%s: queued for routing\n", addr->address);
7656 /* The database is closed while routing is actually happening. Requests to
7657 update it are put on a chain and all processed together at the end. */
7659 if (dbm_file) dbfn_close(dbm_file);
7661 /* If queue_domains is set, we don't even want to try routing addresses in
7662 those domains. During queue runs, queue_domains is forced to be unset.
7663 Optimize by skipping this pass through the addresses if nothing is set. */
7665 if (!f.deliver_force && queue_domains)
7667 address_item *okaddr = NULL;
7670 address_item *addr = addr_route;
7671 addr_route = addr->next;
7673 deliver_domain = addr->domain; /* set $domain */
7674 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
7675 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
7679 addr->basic_errno = ERRNO_LISTDEFER;
7680 addr->message = US"queue_domains lookup deferred";
7681 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7685 addr->next = okaddr;
7690 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
7691 addr->message = US"domain is in queue_domains";
7692 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7696 addr_route = okaddr;
7699 /* Now route those addresses that are not deferred. */
7704 address_item *addr = addr_route;
7705 const uschar *old_domain = addr->domain;
7706 uschar *old_unique = addr->unique;
7707 addr_route = addr->next;
7710 /* Just in case some router parameter refers to it. */
7712 if (!(return_path = addr->prop.errors_address))
7713 return_path = sender_address;
7715 /* If a router defers an address, add a retry item. Whether or not to
7716 use the local part in the key is a property of the router. */
7718 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
7719 &addr_succeed, v_none)) == DEFER)
7720 retry_add_item(addr,
7721 addr->router->retry_use_local_part
7722 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
7723 : string_sprintf("R:%s", addr->domain),
7726 /* Otherwise, if there is an existing retry record in the database, add
7727 retry items to delete both forms. We must also allow for the possibility
7728 of a routing retry that includes the sender address. Since the domain might
7729 have been rewritten (expanded to fully qualified) as a result of routing,
7730 ensure that the rewritten form is also deleted. */
7732 else if (testflag(addr, af_dr_retry_exists))
7734 uschar * altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7736 retry_add_item(addr, altkey, rf_delete);
7737 retry_add_item(addr, addr->address_retry_key, rf_delete);
7738 retry_add_item(addr, addr->domain_retry_key, rf_delete);
7739 if (Ustrcmp(addr->domain, old_domain) != 0)
7740 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
7743 /* DISCARD is given for :blackhole: and "seen finish". The event has been
7744 logged, but we need to ensure the address (and maybe parents) is marked
7749 address_done(addr, tod_stamp(tod_log));
7750 continue; /* route next address */
7753 /* The address is finished with (failed or deferred). */
7757 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7758 continue; /* route next address */
7761 /* The address has been routed. If the router changed the domain, it will
7762 also have changed the unique address. We have to test whether this address
7763 has already been delivered, because it's the unique address that finally
7766 if ( addr->unique != old_unique
7767 && tree_search(tree_nonrecipients, addr->unique) != 0
7770 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
7771 "discarded\n", addr->address);
7772 if (addr_remote == addr) addr_remote = addr->next;
7773 else if (addr_local == addr) addr_local = addr->next;
7776 /* If the router has same_domain_copy_routing set, we are permitted to copy
7777 the routing for any other addresses with the same domain. This is an
7778 optimisation to save repeated DNS lookups for "standard" remote domain
7779 routing. The option is settable only on routers that generate host lists.
7780 We play it very safe, and do the optimization only if the address is routed
7781 to a remote transport, there are no header changes, and the domain was not
7782 modified by the router. */
7784 if ( addr_remote == addr
7785 && addr->router->same_domain_copy_routing
7786 && !addr->prop.extra_headers
7787 && !addr->prop.remove_headers
7788 && old_domain == addr->domain
7791 address_item **chain = &addr_route;
7794 address_item *addr2 = *chain;
7795 if (Ustrcmp(addr2->domain, addr->domain) != 0)
7797 chain = &(addr2->next);
7801 /* Found a suitable address; take it off the routing list and add it to
7802 the remote delivery list. */
7804 *chain = addr2->next;
7805 addr2->next = addr_remote;
7806 addr_remote = addr2;
7808 /* Copy the routing data */
7810 addr2->domain = addr->domain;
7811 addr2->router = addr->router;
7812 addr2->transport = addr->transport;
7813 addr2->host_list = addr->host_list;
7814 addr2->fallback_hosts = addr->fallback_hosts;
7815 addr2->prop.errors_address = addr->prop.errors_address;
7816 copyflag(addr2, addr, af_hide_child);
7817 copyflag(addr2, addr, af_local_host_removed);
7819 DEBUG(D_deliver|D_route)
7820 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
7822 "Routing for %s copied from %s\n",
7823 addr2->address, addr2->address, addr->address);
7826 } /* Continue with routing the next address. */
7827 } /* Loop to process any child addresses that the routers created, and
7828 any rerouted addresses that got put back on the new chain. */
7831 /* Debugging: show the results of the routing */
7833 DEBUG(D_deliver|D_retry|D_route)
7835 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7836 debug_printf("After routing:\n Local deliveries:\n");
7837 for (address_item * p = addr_local; p; p = p->next)
7838 debug_printf(" %s\n", p->address);
7840 debug_printf(" Remote deliveries:\n");
7841 for (address_item * p = addr_remote; p; p = p->next)
7842 debug_printf(" %s\n", p->address);
7844 debug_printf(" Failed addresses:\n");
7845 for (address_item * p = addr_failed; p; p = p->next)
7846 debug_printf(" %s\n", p->address);
7848 debug_printf(" Deferred addresses:\n");
7849 for (address_item * p = addr_defer; p; p = p->next)
7850 debug_printf(" %s\n", p->address);
7853 /* Free any resources that were cached during routing. */
7858 /* These two variables are set only during routing, after check_local_user.
7859 Ensure they are not set in transports. */
7861 local_user_gid = (gid_t)(-1);
7862 local_user_uid = (uid_t)(-1);
7864 /* Check for any duplicate addresses. This check is delayed until after
7865 routing, because the flexibility of the routing configuration means that
7866 identical addresses with different parentage may end up being redirected to
7867 different addresses. Checking for duplicates too early (as we previously used
7868 to) makes this kind of thing not work. */
7870 do_duplicate_check(&addr_local);
7871 do_duplicate_check(&addr_remote);
7873 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7874 remote transport. The check that they all end up in one transaction happens in
7875 the do_remote_deliveries() function. */
7878 && (addr_local || addr_failed || addr_defer)
7882 uschar *which, *colon, *msg;
7889 else if (addr_defer)
7892 which = US"deferred";
7900 while (addr->parent) addr = addr->parent;
7905 msg = addr->message;
7907 else colon = msg = US"";
7909 /* We don't need to log here for a forced failure as it will already
7910 have been logged. Defer will also have been logged, but as a defer, so we do
7911 need to do the failure logging. */
7913 if (addr != addr_failed)
7914 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7915 addr->address, which);
7917 /* Always write an error to the caller */
7919 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7922 final_yield = DELIVER_MUA_FAILED;
7923 addr_failed = addr_defer = NULL; /* So that we remove the message */
7924 goto DELIVERY_TIDYUP;
7928 /* If this is a run to continue deliveries to an external channel that is
7929 already set up, defer any local deliveries.
7931 jgh 2020/12/20: I don't see why; locals should be quick.
7932 The defer goes back to version 1.62 in 1997. A local being still deliverable
7933 during a continued run might result from something like a defer during the
7934 original delivery, eg. in a DB lookup. Unlikely but possible.
7936 To avoid delaying a local when combined with a callout-hold for a remote
7937 delivery, test continue_sequence rather than continue_transport. */
7939 if (continue_sequence > 1 && addr_local)
7941 DEBUG(D_deliver|D_retry|D_route)
7942 debug_printf("deferring local deliveries due to continued-transport\n");
7945 address_item * addr = addr_defer;
7946 while (addr->next) addr = addr->next;
7947 addr->next = addr_local;
7950 addr_defer = addr_local;
7955 /* Because address rewriting can happen in the routers, we should not really do
7956 ANY deliveries until all addresses have been routed, so that all recipients of
7957 the message get the same headers. However, this is in practice not always
7958 possible, since sometimes remote addresses give DNS timeouts for days on end.
7959 The pragmatic approach is to deliver what we can now, saving any rewritten
7960 headers so that at least the next lot of recipients benefit from the rewriting
7961 that has already been done.
7963 If any headers have been rewritten during routing, update the spool file to
7964 remember them for all subsequent deliveries. This can be delayed till later if
7965 there is only address to be delivered - if it succeeds the spool write need not
7968 if ( f.header_rewritten
7969 && ( addr_local && (addr_local->next || addr_remote)
7970 || addr_remote && addr_remote->next
7973 /* Panic-dies on error */
7974 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7975 f.header_rewritten = FALSE;
7979 /* If there are any deliveries to do and we do not already have the journal
7980 file, create it. This is used to record successful deliveries as soon as
7981 possible after each delivery is known to be complete. A file opened with
7982 O_APPEND is used so that several processes can run simultaneously.
7984 The journal is just insurance against crashes. When the spool file is
7985 ultimately updated at the end of processing, the journal is deleted. If a
7986 journal is found to exist at the start of delivery, the addresses listed
7987 therein are added to the non-recipients. */
7989 if (addr_local || addr_remote)
7993 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7995 if ((journal_fd = Uopen(fname,
7996 EXIM_CLOEXEC | O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7998 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7999 fname, strerror(errno));
8000 return DELIVER_NOT_ATTEMPTED;
8003 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
8004 that the mode is correct - the group setting doesn't always seem to get
8005 set automatically. */
8007 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
8008 || fchmod(journal_fd, SPOOL_MODE)
8010 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
8014 int ret = Uunlink(fname);
8015 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
8016 fname, strerror(errno));
8017 if(ret && errno != ENOENT)
8018 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8019 fname, strerror(errno));
8020 return DELIVER_NOT_ATTEMPTED;
8024 else if (journal_fd >= 0)
8032 /* Now we can get down to the business of actually doing deliveries. Local
8033 deliveries are done first, then remote ones. If ever the problems of how to
8034 handle fallback transports are figured out, this section can be put into a loop
8035 for handling fallbacks, though the uid switching will have to be revised. */
8037 /* Precompile a regex that is used to recognize a parameter in response
8038 to an LHLO command, if is isn't already compiled. This may be used on both
8039 local and remote LMTP deliveries. */
8041 if (!regex_IGNOREQUOTA)
8043 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", MCS_NOFLAGS, TRUE);
8045 /* Handle local deliveries */
8049 DEBUG(D_deliver|D_transport)
8050 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
8051 do_local_deliveries();
8052 f.disable_logging = FALSE;
8055 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
8056 so just queue them all. */
8058 if (f.queue_run_local)
8061 address_item *addr = addr_remote;
8062 addr_remote = addr->next;
8064 addr->basic_errno = ERRNO_LOCAL_ONLY;
8065 addr->message = US"remote deliveries suppressed";
8066 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
8069 /* Handle remote deliveries */
8073 DEBUG(D_deliver|D_transport)
8074 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
8076 /* Precompile some regex that are used to recognize parameters in response
8077 to an EHLO command, if they aren't already compiled. */
8079 smtp_deliver_init();
8081 /* Now sort the addresses if required, and do the deliveries. The yield of
8082 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
8083 cannot be delivered in one transaction. */
8085 if (remote_sort_domains) sort_remote_deliveries();
8086 if (!do_remote_deliveries(FALSE))
8088 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
8089 "be delivered in one transaction");
8090 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
8092 final_yield = DELIVER_MUA_FAILED;
8093 addr_failed = addr_defer = NULL; /* So that we remove the message */
8094 goto DELIVERY_TIDYUP;
8097 /* See if any of the addresses that failed got put on the queue for delivery
8098 to their fallback hosts. We do it this way because often the same fallback
8099 host is used for many domains, so all can be sent in a single transaction
8100 (if appropriately configured). */
8102 if (addr_fallback && !mua_wrapper)
8104 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
8105 addr_remote = addr_fallback;
8106 addr_fallback = NULL;
8107 if (remote_sort_domains) sort_remote_deliveries();
8108 do_remote_deliveries(TRUE);
8110 f.disable_logging = FALSE;
8114 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
8115 phase, to minimize cases of half-done things. */
8118 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
8119 cancel_cutthrough_connection(TRUE, US"deliveries are done");
8121 /* Root privilege is no longer needed */
8123 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
8125 set_process_info("tidying up after delivering %s", message_id);
8126 signal(SIGTERM, SIG_IGN);
8128 /* When we are acting as an MUA wrapper, the smtp transport will either have
8129 succeeded for all addresses, or failed them all in normal cases. However, there
8130 are some setup situations (e.g. when a named port does not exist) that cause an
8131 immediate exit with deferral of all addresses. Convert those into failures. We
8132 do not ever want to retry, nor do we want to send a bounce message. */
8138 address_item * nextaddr;
8139 for (address_item * addr = addr_defer; addr; addr = nextaddr)
8141 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
8142 "delivery", addr->address);
8143 nextaddr = addr->next;
8144 addr->next = addr_failed;
8150 /* Now all should either have succeeded or failed. */
8153 final_yield = DELIVER_MUA_SUCCEEDED;
8157 uschar *s = addr_failed->user_message;
8159 if (!s) s = addr_failed->message;
8161 fprintf(stderr, "Delivery failed: ");
8162 if (addr_failed->basic_errno > 0)
8164 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
8165 if (s) fprintf(stderr, ": ");
8167 if ((host = addr_failed->host_used))
8168 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
8170 fprintf(stderr, "%s", CS s);
8171 else if (addr_failed->basic_errno <= 0)
8172 fprintf(stderr, "unknown error");
8173 fprintf(stderr, "\n");
8175 final_yield = DELIVER_MUA_FAILED;
8180 /* In a normal configuration, we now update the retry database. This is done in
8181 one fell swoop at the end in order not to keep opening and closing (and
8182 locking) the database. The code for handling retries is hived off into a
8183 separate module for convenience. We pass it the addresses of the various
8184 chains, because deferred addresses can get moved onto the failed chain if the
8185 retry cutoff time has expired for all alternative destinations. Bypass the
8186 updating of the database if the -N flag is set, which is a debugging thing that
8187 prevents actual delivery. */
8189 else if (!f.dont_deliver)
8190 retry_update(&addr_defer, &addr_failed, &addr_succeed);
8192 /* Send DSN for successful messages if requested */
8194 maybe_send_dsn(addr_succeed);
8196 /* If any addresses failed, we must send a message to somebody, unless
8197 af_ignore_error is set, in which case no action is taken. It is possible for
8198 several messages to get sent if there are addresses with different
8203 const uschar * logtod = tod_stamp(tod_log);
8204 address_item * addr;
8206 /* There are weird cases when logging is disabled in the transport. However,
8207 there may not be a transport (address failed by a router). */
8209 f.disable_logging = FALSE;
8210 if (addr_failed->transport)
8211 f.disable_logging = addr_failed->transport->disable_logging;
8214 debug_printf("processing failed address %s\n", addr_failed->address);
8216 /* There are only two ways an address in a bounce message can get here:
8218 (1) When delivery was initially deferred, but has now timed out (in the call
8219 to retry_update() above). We can detect this by testing for
8220 af_retry_timedout. If the address does not have its own errors address,
8221 we arrange to ignore the error.
8223 (2) If delivery failures for bounce messages are being ignored. We can detect
8224 this by testing for af_ignore_error. This will also be set if a bounce
8225 message has been autothawed and the ignore_bounce_errors_after time has
8226 passed. It might also be set if a router was explicitly configured to
8227 ignore errors (errors_to = "").
8229 If neither of these cases obtains, something has gone wrong. Log the
8230 incident, but then ignore the error. */
8232 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
8234 if ( !testflag(addr_failed, af_retry_timedout)
8235 && !addr_failed->prop.ignore_error)
8236 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
8237 "failure is neither frozen nor ignored (it's been ignored)");
8239 addr_failed->prop.ignore_error = TRUE;
8242 /* If the first address on the list has af_ignore_error set, just remove
8243 it from the list, throw away any saved message file, log it, and
8244 mark the recipient done. */
8246 if ( addr_failed->prop.ignore_error
8247 || addr_failed->dsn_flags & rf_dsnflags
8248 && !(addr_failed->dsn_flags & rf_notify_failure)
8252 addr_failed = addr->next;
8253 if (addr->return_filename) Uunlink(addr->return_filename);
8255 #ifndef DISABLE_EVENT
8256 msg_event_raise(US"msg:fail:delivery", addr);
8258 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
8260 !addr->parent ? US"" : US" <",
8261 !addr->parent ? US"" : addr->parent->address,
8262 !addr->parent ? US"" : US">",
8263 addr->prop.ignore_error
8264 ? US"" : US": RFC 3461 DSN, failure notify not requested");
8266 address_done(addr, logtod);
8267 child_done(addr, logtod);
8268 /* Panic-dies on error */
8269 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8272 /* Otherwise, handle the sending of a message. Find the error address for
8273 the first address, then send a message that includes all failed addresses
8274 that have the same error address. */
8277 send_bounce_message(now, logtod);
8280 f.disable_logging = FALSE; /* In case left set */
8282 /* Come here from the mua_wrapper case if routing goes wrong */
8286 /* If there are now no deferred addresses, we are done. Preserve the
8287 message log if so configured, and we are using them. Otherwise, sling it.
8288 Then delete the message itself. */
8296 fname = spool_fname(US"msglog", message_subdir, id, US"");
8297 if (preserve_message_logs)
8300 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8302 if ((rc = Urename(fname, moname)) < 0)
8304 (void)directory_make(spool_directory,
8305 spool_sname(US"msglog.OLD", US""),
8306 MSGLOG_DIRECTORY_MODE, TRUE);
8307 rc = Urename(fname, moname);
8310 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8311 "msglog.OLD directory", fname);
8314 if (Uunlink(fname) < 0)
8315 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8316 fname, strerror(errno));
8319 /* Remove the two message files. */
8321 fname = spool_fname(US"input", message_subdir, id, US"-D");
8322 if (Uunlink(fname) < 0)
8323 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8324 fname, strerror(errno));
8325 fname = spool_fname(US"input", message_subdir, id, US"-H");
8326 if (Uunlink(fname) < 0)
8327 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8328 fname, strerror(errno));
8330 /* Log the end of this message, with queue time if requested. */
8332 if (LOGGING(queue_time_overall))
8333 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8335 log_write(0, LOG_MAIN, "Completed");
8337 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8338 f.deliver_freeze = FALSE;
8340 #ifndef DISABLE_EVENT
8341 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8345 /* If there are deferred addresses, we are keeping this message because it is
8346 not yet completed. Lose any temporary files that were catching output from
8347 pipes for any of the deferred addresses, handle one-time aliases, and see if
8348 the message has been on the queue for so long that it is time to send a warning
8349 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8350 have the same domain, we can set deliver_domain for the expansion of
8351 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8352 the parent's domain.
8354 If all the deferred addresses have an error number that indicates "retry time
8355 not reached", skip sending the warning message, because it won't contain the
8356 reason for the delay. It will get sent at the next real delivery attempt.
8357 Exception: for retries caused by a remote peer we use the error message
8358 store in the retry DB as the reason.
8359 However, if at least one address has tried, we'd better include all of them in
8362 If we can't make a process to send the message, don't worry.
8364 For mailing list expansions we want to send the warning message to the
8365 mailing list manager. We can't do a perfect job here, as some addresses may
8366 have different errors addresses, but if we take the errors address from
8367 each deferred address it will probably be right in most cases.
8369 If addr_defer == +1, it means there was a problem sending an error message
8370 for failed addresses, and there were no "real" deferred addresses. The value
8371 was set just to keep the message on the spool, so there is nothing to do here.
8374 else if (addr_defer != (address_item *)(+1))
8376 uschar * recipients = US"";
8377 BOOL want_warning_msg = FALSE;
8379 deliver_domain = testflag(addr_defer, af_pfr)
8380 ? addr_defer->parent->domain : addr_defer->domain;
8382 for (address_item * addr = addr_defer; addr; addr = addr->next)
8384 address_item * otaddr;
8386 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8390 const uschar *d = testflag(addr, af_pfr)
8391 ? addr->parent->domain : addr->domain;
8393 /* The domain may be unset for an address that has never been routed
8394 because the system filter froze the message. */
8396 if (!d || Ustrcmp(d, deliver_domain) != 0)
8397 deliver_domain = NULL;
8400 if (addr->return_filename) Uunlink(addr->return_filename);
8402 /* Handle the case of one-time aliases. If any address in the ancestry
8403 of this one is flagged, ensure it is in the recipients list, suitably
8404 flagged, and that its parent is marked delivered. */
8406 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8407 if (otaddr->onetime_parent) break;
8412 int t = recipients_count;
8414 for (i = 0; i < recipients_count; i++)
8416 const uschar * r = recipients_list[i].address;
8417 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8418 if (Ustrcmp(otaddr->address, r) == 0) break;
8421 /* Didn't find the address already in the list, and did find the
8422 ultimate parent's address in the list, and they really are different
8423 (i.e. not from an identity-redirect). After adding the recipient,
8424 update the errors address in the recipients list. */
8426 if ( i >= recipients_count && t < recipients_count
8427 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8429 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8430 otaddr->address, otaddr->parent->address);
8431 receive_add_recipient(otaddr->address, t);
8432 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8433 tree_add_nonrecipient(otaddr->parent->address);
8434 update_spool = TRUE;
8438 /* Except for error messages, ensure that either the errors address for
8439 this deferred address or, if there is none, the sender address, is on the
8440 list of recipients for a warning message. */
8442 if (sender_address[0])
8444 const uschar * s = addr->prop.errors_address;
8445 if (!s) s = sender_address;
8446 if (Ustrstr(recipients, s) == NULL)
8447 recipients = string_sprintf("%s%s%s", recipients,
8448 recipients[0] ? "," : "", s);
8452 /* Send a warning message if the conditions are right. If the condition check
8453 fails because of a lookup defer, there is nothing we can do. The warning
8454 is not sent. Another attempt will be made at the next delivery attempt (if
8457 if ( !f.queue_2stage
8459 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8460 || addr_defer->dsn_flags & rf_notify_delay
8462 && delay_warning[1] > 0
8463 && sender_address[0] != 0)
8465 GET_OPTION("delay_warning_condition");
8466 if ( ( !delay_warning_condition
8467 || expand_check_condition(delay_warning_condition,
8468 US"delay_warning", US"option")
8474 int queue_time = time(NULL) - received_time.tv_sec;
8476 queue_time = test_harness_fudged_queue_time(queue_time);
8478 /* See how many warnings we should have sent by now */
8480 for (count = 0; count < delay_warning[1]; count++)
8481 if (queue_time < delay_warning[count+2]) break;
8483 show_time = delay_warning[count+1];
8485 if (count >= delay_warning[1])
8488 int last_gap = show_time;
8489 if (count > 1) last_gap -= delay_warning[count];
8490 extra = (queue_time - delay_warning[count+1])/last_gap;
8491 show_time += last_gap * extra;
8497 debug_printf("time on queue = %s id %s addr %s\n",
8498 readconf_printtime(queue_time), message_id, addr_defer->address);
8499 debug_printf("warning counts: required %d done %d\n", count,
8503 /* We have computed the number of warnings there should have been by now.
8504 If there haven't been enough, send one, and up the count to what it should
8507 if (warning_count < count)
8508 if (send_warning_message(recipients, queue_time, show_time))
8510 warning_count = count;
8511 update_spool = TRUE; /* Ensure spool rewritten */
8516 /* Clear deliver_domain */
8518 deliver_domain = NULL;
8520 /* If this was a first delivery attempt, unset the first time flag, and
8521 ensure that the spool gets updated. */
8523 if (f.deliver_firsttime && !f.queue_2stage)
8525 f.deliver_firsttime = FALSE;
8526 update_spool = TRUE;
8529 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8530 message, unless the message is a local error message (to avoid loops). Then
8531 log the freezing. If the text in "frozen_info" came from a system filter,
8532 it has been escaped into printing characters so as not to mess up log lines.
8533 For the "tell" message, we turn \n back into newline. Also, insert a newline
8534 near the start instead of the ": " string. */
8536 if (f.deliver_freeze)
8538 if (freeze_tell && *freeze_tell && !f.local_error_message)
8540 uschar * s = string_copy(frozen_info);
8541 uschar * ss = Ustrstr(s, " by the system filter: ");
8550 if (*ss == '\\' && ss[1] == 'n')
8551 { *ss++ = ' '; *ss++ = '\n'; }
8555 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8556 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8560 /* Log freezing just before we update the -H file, to minimize the chance
8561 of a race problem. */
8563 deliver_msglog("*** Frozen%s\n", frozen_info);
8564 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8567 /* If there have been any updates to the non-recipients list, or other things
8568 that get written to the spool, we must now update the spool header file so
8569 that it has the right information for the next delivery attempt. If there
8570 was more than one address being delivered, the header_change update is done
8571 earlier, in case one succeeds and then something crashes. */
8574 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8575 update_spool, f.header_rewritten);
8577 if (update_spool || f.header_rewritten)
8578 /* Panic-dies on error */
8579 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8582 /* Finished with the message log. If the message is complete, it will have
8583 been unlinked or renamed above. */
8585 if (message_logs) (void)fclose(message_log);
8587 /* Now we can close and remove the journal file. Its only purpose is to record
8588 successfully completed deliveries asap so that this information doesn't get
8589 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8590 not serious, as trying it again is not harmful. The journal might not be open
8591 if all addresses were deferred at routing or directing. Nevertheless, we must
8592 remove it if it exists (may have been lying around from a crash during the
8593 previous delivery attempt). We don't remove the journal if a delivery
8594 subprocess failed to pass back delivery information; this is controlled by
8595 the remove_journal flag. When the journal is left, we also don't move the
8596 message off the main spool if frozen and the option is set. It should get moved
8597 at the next attempt, after the journal has been inspected. */
8599 if (journal_fd >= 0) (void)close(journal_fd);
8603 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8605 if (Uunlink(fname) < 0 && errno != ENOENT)
8606 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8609 /* Move the message off the spool if requested */
8611 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8612 if (f.deliver_freeze && move_frozen_messages)
8613 (void)spool_move_message(id, message_subdir, US"", US"F");
8617 /* Closing the data file frees the lock; if the file has been unlinked it
8618 will go away. Otherwise the message becomes available for another process
8621 (void)close(deliver_datafile);
8622 deliver_datafile = -1;
8623 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8624 #ifdef MEASURE_TIMING
8625 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8628 /* It is unlikely that there will be any cached resources, since they are
8629 released after routing, and in the delivery subprocesses. However, it's
8630 possible for an expansion for something afterwards (for example,
8631 expand_check_condition) to do a lookup. We must therefore be sure everything is
8635 acl_where = ACL_WHERE_UNKNOWN;
8644 #ifdef EXIM_TFO_PROBE
8647 f.tcp_fastopen_ok = TRUE;
8653 /* Called from a commandline, or from the daemon, to do a delivery.
8654 We need to regain privs; do this by exec of the exim binary. */
8657 delivery_re_exec(int exec_type)
8661 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8663 int channel_fd = cutthrough.cctx.sock;
8665 smtp_peer_options = cutthrough.peer_options;
8666 continue_sequence = 0;
8669 if (cutthrough.is_tls)
8673 smtp_peer_options |= OPTION_TLS;
8674 sending_ip_address = cutthrough.snd_ip;
8675 sending_port = cutthrough.snd_port;
8677 where = US"socketpair";
8678 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8682 testharness_pause_ms(150);
8683 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8686 if (pid == 0) /* child: will fork again to totally disconnect */
8688 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8689 pfd, 5*60, cutthrough.host.name);
8690 /* does not return */
8694 waitpid(pid, NULL, 0);
8695 (void) close(channel_fd); /* release the client socket */
8696 channel_fd = pfd[1];
8700 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8701 cutthrough.host.address, message_id, channel_fd);
8705 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8706 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8708 return; /* compiler quietening; control does not reach here. */
8713 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8714 "delivery re-exec %s failed: %s", where, strerror(errno));
8716 /* Get here if exec_type == CEE_EXEC_EXIT.
8717 Note: this must be _exit(), not exit(). */
8719 _exit(EX_EXECFAILED);
8725 /* End of deliver.c */