1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2024 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* The main code for delivering a message. */
14 #include "transports/smtp.h"
19 /* Data block for keeping track of subprocesses for parallel remote
22 typedef struct pardata {
23 address_item *addrlist; /* chain of addresses */
24 address_item *addr; /* next address data expected for */
25 pid_t pid; /* subprocess pid */
26 int fd; /* pipe fd for getting result from subprocess */
27 int transport_count; /* returned transport count value */
28 BOOL done; /* no more data needed */
29 uschar *msg; /* error message */
30 const uschar *return_path; /* return_path for these addresses */
33 /* Values for the process_recipients variable */
35 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
36 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
39 /* Mutually recursive functions for marking addresses done. */
41 static void child_done(address_item *, const uschar *);
42 static void address_done(address_item *, const uschar *);
44 /* Table for turning base-62 numbers into binary */
46 static uschar tab62[] =
47 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
48 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
49 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
50 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
51 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
52 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
56 /*************************************************
57 * Local static variables *
58 *************************************************/
60 /* addr_duplicate is global because it needs to be seen from the Envelope-To
63 static address_item *addr_defer = NULL;
64 static address_item *addr_failed = NULL;
65 static address_item *addr_fallback = NULL;
66 static address_item *addr_local = NULL;
67 static address_item *addr_new = NULL;
68 static address_item *addr_remote = NULL;
69 static address_item *addr_route = NULL;
70 static address_item *addr_succeed = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static struct pollfd *parpoll;
78 static int return_count;
79 static uschar *frozen_info = US"";
80 static const uschar * used_return_path = NULL;
84 /*************************************************
85 * read as much as requested *
86 *************************************************/
88 /* The syscall read(2) doesn't always returns as much as we want. For
89 several reasons it might get less. (Not talking about signals, as syscalls
90 are restartable). When reading from a network or pipe connection the sender
91 might send in smaller chunks, with delays between these chunks. The read(2)
92 may return such a chunk.
94 The more the writer writes and the smaller the pipe between write and read is,
95 the more we get the chance of reading leass than requested. (See bug 2130)
97 This function read(2)s until we got all the data we *requested*.
99 Note: This function may block. Use it only if you're sure about the
100 amount of data you will get.
103 fd the file descriptor to read from
104 buffer pointer to a buffer of size len
105 len the requested(!) amount of bytes
107 Returns: the amount of bytes read
110 readn(int fd, void * buffer, size_t len)
112 uschar * next = buffer;
113 uschar * end = next + len;
117 ssize_t got = read(fd, next, end - next);
119 /* I'm not sure if there are signals that can interrupt us,
120 for now I assume the worst */
121 if (got == -1 && errno == EINTR) continue;
122 if (got <= 0) return next - US buffer;
130 /*************************************************
131 * Make a new address item *
132 *************************************************/
134 /* This function gets the store and initializes with default values. The
135 transport_return value defaults to DEFER, so that any unexpected failure to
136 deliver does not wipe out the message. The default unique string is set to a
137 copy of the address, so that its domain can be lowercased.
140 address the RFC822 address string
141 copy force a copy of the address
143 Returns: a pointer to an initialized address_item
147 deliver_make_addr(const uschar * address, BOOL copy)
149 address_item * addr = store_get(sizeof(address_item), GET_UNTAINTED);
150 *addr = address_defaults;
151 if (copy) address = string_copy(address);
152 addr->address = address;
153 addr->unique = string_copy(address);
160 /*************************************************
161 * Set expansion values for an address *
162 *************************************************/
164 /* Certain expansion variables are valid only when handling an address or
165 address list. This function sets them up or clears the values, according to its
169 addr the address in question, or NULL to clear values
174 deliver_set_expansions(address_item *addr)
178 const uschar ***p = address_expansions;
179 while (*p) **p++ = NULL;
183 /* Exactly what gets set depends on whether there is one or more addresses, and
184 what they contain. These first ones are always set, taking their values from
185 the first address. */
187 if (!addr->host_list)
189 deliver_host = deliver_host_address = US"";
190 deliver_host_port = 0;
194 deliver_host = addr->host_list->name;
195 deliver_host_address = addr->host_list->address;
196 deliver_host_port = addr->host_list->port;
199 deliver_recipients = addr;
200 deliver_address_data = addr->prop.address_data;
201 deliver_domain_data = addr->prop.domain_data;
202 deliver_localpart_data = addr->prop.localpart_data;
203 router_var = addr->prop.variables;
205 /* These may be unset for multiple addresses */
207 deliver_domain = addr->domain;
208 self_hostname = addr->self_hostname;
210 #ifdef EXPERIMENTAL_BRIGHTMAIL
211 bmi_deliver = 1; /* deliver by default */
212 bmi_alt_location = NULL;
213 bmi_base64_verdict = NULL;
214 bmi_base64_tracker_verdict = NULL;
217 /* If there's only one address we can set everything. */
221 address_item *addr_orig;
223 deliver_localpart = addr->local_part;
224 deliver_localpart_prefix = addr->prefix;
225 deliver_localpart_prefix_v = addr->prefix_v;
226 deliver_localpart_suffix = addr->suffix;
227 deliver_localpart_suffix_v = addr->suffix_v;
229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230 deliver_domain_orig = addr_orig->domain;
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
251 deliver_domain_parent = addr->parent->domain;
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
261 if (testflag(addr, af_pfr))
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
267 deliver_localpart_prefix_v = addr->parent->prefix_v;
268 deliver_localpart_suffix = addr->parent->suffix;
269 deliver_localpart_suffix_v = addr->parent->suffix_v;
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
280 if (bmi_deliver == 1)
281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
293 if (testflag(addr, af_pfr))
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301 deliver_domain = NULL;
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
306 self_hostname = NULL;
307 if (!deliver_domain && !self_hostname) break;
315 /*************************************************
316 * Open a msglog file *
317 *************************************************/
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
324 Called from deliver_message(), can be operating as root.
327 filename the file name
328 mode the mode required
329 error used for saying what failed
331 Returns: a file descriptor, or -1 (with errno set)
335 open_msglog_file(uschar *filename, int mode, uschar **error)
337 if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
341 for (int i = 2; i > 0; i--)
343 int fd = Uopen(filename,
344 EXIM_CLOEXEC | EXIM_NOFOLLOW | O_WRONLY|O_APPEND|O_CREAT, mode);
347 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
348 function is called as root). Double check the mode, because the group setting
349 doesn't always get set automatically. */
352 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
354 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
359 if (fchmod(fd, mode) < 0)
369 (void)directory_make(spool_directory,
370 spool_sname(US"msglog", message_subdir),
371 MSGLOG_DIRECTORY_MODE, TRUE);
374 *error = US"create or open";
381 /*************************************************
382 * Write to msglog if required *
383 *************************************************/
385 /* Write to the message log, if configured. This function may also be called
389 format a string format
395 deliver_msglog(const char *format, ...)
398 if (!message_logs) return;
399 va_start(ap, format);
400 vfprintf(message_log, format, ap);
408 /*************************************************
409 * Replicate status for batch *
410 *************************************************/
412 /* When a transport handles a batch of addresses, it may treat them
413 individually, or it may just put the status in the first one, and return FALSE,
414 requesting that the status be copied to all the others externally. This is the
415 replication function. As well as the status, it copies the transport pointer,
416 which may have changed if appendfile passed the addresses on to a different
419 Argument: pointer to the first address in a chain
424 replicate_status(address_item *addr)
426 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
428 addr2->transport = addr->transport;
429 addr2->transport_return = addr->transport_return;
430 addr2->basic_errno = addr->basic_errno;
431 addr2->more_errno = addr->more_errno;
432 addr2->delivery_time = addr->delivery_time;
433 addr2->special_action = addr->special_action;
434 addr2->message = addr->message;
435 addr2->user_message = addr->user_message;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
458 We do not try to batch up different A-record host names that refer to the
462 one points to the first host list
463 two points to the second host list
465 Returns: TRUE if the lists refer to the same host set
469 same_hosts(host_item *one, host_item *two)
473 if (Ustrcmp(one->name, two->name) != 0)
476 host_item *end_one = one;
477 host_item *end_two = two;
479 /* Batch up only if there was no MX and the list was not randomized */
481 if (mx == MX_NONE) return FALSE;
483 /* Find the ends of the shortest sequence of identical MX values */
485 while ( end_one->next && end_one->next->mx == mx
486 && end_two->next && end_two->next->mx == mx)
488 end_one = end_one->next;
489 end_two = end_two->next;
492 /* If there aren't any duplicates, there's no match. */
494 if (end_one == one) return FALSE;
496 /* For each host in the 'one' sequence, check that it appears in the 'two'
497 sequence, returning FALSE if not. */
502 for (hi = two; hi != end_two->next; hi = hi->next)
503 if (Ustrcmp(one->name, hi->name) == 0) break;
504 if (hi == end_two->next) return FALSE;
505 if (one == end_one) break;
509 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
510 Ensure both are pointing at the last host, and carry on as for equality. */
515 /* if the names matched but ports do not, mismatch */
516 else if (one->port != two->port)
520 /* DNSSEC equality */
521 if (one->dnssec != two->dnssec) return FALSE;
529 /* True if both are NULL */
536 /*************************************************
537 * Compare header lines *
538 *************************************************/
540 /* This function is given two pointers to chains of header items, and it yields
541 TRUE if they are the same header texts in the same order.
544 one points to the first header list
545 two points to the second header list
547 Returns: TRUE if the lists refer to the same header set
551 same_headers(header_line *one, header_line *two)
553 for (;; one = one->next, two = two->next)
555 if (one == two) return TRUE; /* Includes the case where both NULL */
556 if (!one || !two) return FALSE;
557 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
563 /*************************************************
564 * Compare string settings *
565 *************************************************/
567 /* This function is given two pointers to strings, and it returns
568 TRUE if they are the same pointer, or if the two strings are the same.
571 one points to the first string
572 two points to the second string
574 Returns: TRUE or FALSE
578 same_strings(const uschar * one, const uschar * two)
580 if (one == two) return TRUE; /* Includes the case where both NULL */
581 if (!one || !two) return FALSE;
582 return (Ustrcmp(one, two) == 0);
587 /*************************************************
588 * Compare uid/gid for addresses *
589 *************************************************/
591 /* This function is given a transport and two addresses. It yields TRUE if the
592 uid/gid/initgroups settings for the two addresses are going to be the same when
597 addr1 the first address
598 addr2 the second address
600 Returns: TRUE or FALSE
604 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
606 if ( !tp->uid_set && !tp->expand_uid
607 && !tp->deliver_as_creator
608 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
609 || ( testflag(addr1, af_uid_set)
610 && ( addr1->uid != addr2->uid
611 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
615 if ( !tp->gid_set && !tp->expand_gid
616 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
617 || ( testflag(addr1, af_gid_set)
618 && addr1->gid != addr2->gid
628 /*************************************************
629 * Record that an address is complete *
630 *************************************************/
632 /* This function records that an address is complete. This is straightforward
633 for most addresses, where the unique address is just the full address with the
634 domain lower cased. For homonyms (addresses that are the same as one of their
635 ancestors) their are complications. Their unique addresses have \x\ prepended
636 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
639 Exim used to record the unique addresses of homonyms as "complete". This,
640 however, fails when the pattern of redirection varies over time (e.g. if taking
641 unseen copies at only some times of day) because the prepended numbers may vary
642 from one delivery run to the next. This problem is solved by never recording
643 prepended unique addresses as complete. Instead, when a homonymic address has
644 actually been delivered via a transport, we record its basic unique address
645 followed by the name of the transport. This is checked in subsequent delivery
646 runs whenever an address is routed to a transport.
648 If the completed address is a top-level one (has no parent, which means it
649 cannot be homonymic) we also add the original address to the non-recipients
650 tree, so that it gets recorded in the spool file and therefore appears as
651 "done" in any spool listings. The original address may differ from the unique
652 address in the case of the domain.
654 Finally, this function scans the list of duplicates, marks as done any that
655 match this address, and calls child_done() for their ancestors.
658 addr address item that has been completed
659 now current time as a string
665 address_done(address_item * addr, const uschar * now)
667 update_spool = TRUE; /* Ensure spool gets updated */
669 /* Top-level address */
673 tree_add_nonrecipient(addr->unique);
674 tree_add_nonrecipient(addr->address);
677 /* Homonymous child address */
679 else if (testflag(addr, af_homonym))
682 tree_add_nonrecipient(
683 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
686 /* Non-homonymous child address */
688 else tree_add_nonrecipient(addr->unique);
690 /* Check the list of duplicate addresses and ensure they are now marked
693 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
694 if (Ustrcmp(addr->unique, dup->unique) == 0)
696 tree_add_nonrecipient(dup->unique);
697 child_done(dup, now);
704 /*************************************************
705 * Decrease counts in parents and mark done *
706 *************************************************/
708 /* This function is called when an address is complete. If there is a parent
709 address, its count of children is decremented. If there are still other
710 children outstanding, the function exits. Otherwise, if the count has become
711 zero, address_done() is called to mark the parent and its duplicates complete.
712 Then loop for any earlier ancestors.
715 addr points to the completed address item
716 now the current time as a string, for writing to the message log
722 child_done(address_item * addr, const uschar * now)
729 if (--addr->child_count > 0) return; /* Incomplete parent */
730 address_done(addr, now);
732 /* Log the completion of all descendents only when there is no ancestor with
733 the same original address. */
735 for (aa = addr->parent; aa; aa = aa->parent)
736 if (Ustrcmp(aa->address, addr->address) == 0) break;
739 deliver_msglog("%s %s: children all complete\n", now, addr->address);
740 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
746 /*************************************************
747 * Delivery logging support functions *
748 *************************************************/
750 /* The LOGGING() checks in d_log_interface() are complicated for backwards
751 compatibility. When outgoing interface logging was originally added, it was
752 conditional on just incoming_interface (which is off by default). The
753 outgoing_interface option is on by default to preserve this behaviour, but
754 you can enable incoming_interface and disable outgoing_interface to get I=
755 fields on incoming lines only.
759 addr The address to be logged
761 Returns: New value for s
765 d_log_interface(gstring * g)
767 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
768 && sending_ip_address)
770 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
771 if (LOGGING(outgoing_port))
772 g = string_fmt_append(g, ":%d", sending_port);
780 d_hostlog(gstring * g, address_item * addr)
782 host_item * h = addr->host_used;
784 g = string_append(g, 2, US" H=", h->name);
786 if (LOGGING(dnssec) && h->dnssec == DS_YES)
787 g = string_catn(g, US" DS", 3);
789 g = string_append(g, 3, US" [", h->address, US"]");
791 if (LOGGING(outgoing_port))
792 g = string_fmt_append(g, ":%d", h->port);
794 if (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 uschar * save_rn = router_name, * save_tn = transport_name;
907 const int save_port = deliver_host_port;
909 router_name = addr->router ? addr->router->name : NULL;
910 deliver_domain = addr->domain;
911 deliver_localpart = addr->local_part;
912 deliver_host = addr->host_used ? addr->host_used->name : NULL;
914 if (!addr->transport)
916 if (Ustrcmp(event, "msg:fail:delivery") == 0)
918 /* An address failed with no transport involved. This happens when
919 a filter was used which triggered a fail command (in such a case
920 a transport isn't needed). Convert it to an internal fail event. */
922 (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
927 transport_name = addr->transport->name;
929 (void) event_raise(addr->transport->event_action, event,
931 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
932 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
933 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
934 ? addr->message : NULL,
938 deliver_host_port = save_port;
939 deliver_host_address = save_address;
940 deliver_host = save_host;
941 deliver_localpart = save_local;
942 deliver_domain = save_domain;
943 router_name = save_rn;
944 transport_name = save_tn;
946 #endif /*DISABLE_EVENT*/
950 /******************************************************************************/
953 /*************************************************
954 * Generate local part for logging *
955 *************************************************/
957 static const uschar *
958 string_get_lpart_sub(const address_item * addr, const uschar * s)
961 if (testflag(addr, af_utf8_downcvt))
963 const uschar * t = string_localpart_utf8_to_alabel(s, NULL);
964 return t ? t : s; /* t is NULL on a failed conversion */
970 /* This function is a subroutine for use in string_log_address() below.
973 addr the address being logged
974 yield the current dynamic buffer pointer
976 Returns: the new value of the buffer pointer
980 string_get_localpart(address_item * addr, gstring * yield)
984 if (testflag(addr, af_include_affixes) && (s = addr->prefix))
985 yield = string_cat(yield, string_get_lpart_sub(addr, s));
987 yield = string_cat(yield, string_get_lpart_sub(addr, addr->local_part));
989 if (testflag(addr, af_include_affixes) && (s = addr->suffix))
990 yield = string_cat(yield, string_get_lpart_sub(addr, s));
996 /*************************************************
997 * Generate log address list *
998 *************************************************/
1000 /* This function generates a list consisting of an address and its parents, for
1001 use in logging lines. For saved onetime aliased addresses, the onetime parent
1002 field is used. If the address was delivered by a transport with rcpt_include_
1003 affixes set, the af_include_affixes bit will be set in the address. In that
1004 case, we include the affixes here too.
1007 g points to growing-string struct
1008 addr bottom (ultimate) address
1009 all_parents if TRUE, include all parents
1010 success TRUE for successful delivery
1012 Returns: a growable string in dynamic store
1016 string_log_address(gstring * g,
1017 address_item *addr, BOOL all_parents, BOOL success)
1019 BOOL add_topaddr = TRUE;
1020 address_item *topaddr;
1022 /* Find the ultimate parent */
1024 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1026 /* We start with just the local part for pipe, file, and reply deliveries, and
1027 for successful local deliveries from routers that have the log_as_local flag
1028 set. File deliveries from filters can be specified as non-absolute paths in
1029 cases where the transport is going to complete the path. If there is an error
1030 before this happens (expansion failure) the local part will not be updated, and
1031 so won't necessarily look like a path. Add extra text for this case. */
1033 if ( testflag(addr, af_pfr)
1035 && addr->router && addr->router->log_as_local
1036 && addr->transport && addr->transport->info->local
1039 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1040 g = string_catn(g, CUS"save ", 5);
1041 g = string_get_localpart(addr, g);
1044 /* Other deliveries start with the full address. It we have split it into local
1045 part and domain, use those fields. Some early failures can happen before the
1046 splitting is done; in those cases use the original field. */
1051 int off = gstring_length(g); /* start of the "full address" */
1053 if (addr->local_part)
1056 g = string_get_localpart(addr, g);
1057 g = string_catn(g, US"@", 1);
1060 if (testflag(addr, af_utf8_downcvt))
1061 s = string_localpart_utf8_to_alabel(s, NULL);
1063 g = string_cat(g, s);
1066 g = string_cat(g, addr->address);
1068 /* If the address we are going to print is the same as the top address,
1069 and all parents are not being included, don't add on the top address. First
1070 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1071 on the local parts. */
1073 cmp = g->s + off; /* only now, as rebuffer likely done */
1074 string_from_gstring(g); /* ensure nul-terminated */
1075 if ( strcmpic(cmp, topaddr->address) == 0
1076 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1077 && !addr->onetime_parent
1078 && (!all_parents || !addr->parent || addr->parent == topaddr)
1080 add_topaddr = FALSE;
1083 /* If all parents are requested, or this is a local pipe/file/reply, and
1084 there is at least one intermediate parent, show it in brackets, and continue
1085 with all of them if all are wanted. */
1087 if ( (all_parents || testflag(addr, af_pfr))
1089 && addr->parent != topaddr)
1092 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1094 g = string_catn(g, s, 2);
1095 g = string_cat (g, addr2->address);
1096 if (!all_parents) break;
1099 g = string_catn(g, US")", 1);
1102 /* Add the top address if it is required */
1105 g = string_append(g, 3,
1107 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1115 /******************************************************************************/
1119 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1120 this is a nonstandard call; no two-character delivery flag is written
1121 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1124 flags passed to log_write()
1127 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1129 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1132 /* Log the delivery on the main log. We use an extensible string to build up
1133 the log line, and reset the store afterwards. Remote deliveries should always
1134 have a pointer to the host item that succeeded; local deliveries can have a
1135 pointer to a single host item in their host list, for use by the transport. */
1137 #ifndef DISABLE_EVENT
1138 /* presume no successful remote delivery */
1139 lookup_dnssec_authenticated = NULL;
1142 reset_point = store_mark();
1143 g = string_get_tainted(256, GET_TAINTED); /* addrs will be tainted, so avoid copy */
1146 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1149 g->s[0] = logchar; g->ptr = 1;
1150 g = string_catn(g, US"> ", 2);
1152 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1154 if (LOGGING(sender_on_delivery) || msg)
1155 g = string_append(g, 3, US" F=<",
1157 testflag(addr, af_utf8_downcvt)
1158 ? string_address_utf8_to_alabel(sender_address, NULL)
1165 g = string_append(g, 2, US" Q=", queue_name);
1167 /* You might think that the return path must always be set for a successful
1168 delivery; indeed, I did for some time, until this statement crashed. The case
1169 when it is not set is for a delivery to /dev/null which is optimised by not
1170 being run at all. */
1172 if (used_return_path && LOGGING(return_path_on_delivery))
1173 g = string_append(g, 3, US" P=<", used_return_path, US">");
1176 g = string_append(g, 2, US" ", msg);
1178 /* For a delivery from a system filter, there may not be a router */
1180 g = string_append(g, 2, US" R=", addr->router->name);
1182 g = string_append(g, 2, US" T=", addr->transport->name);
1184 if (LOGGING(delivery_size))
1185 g = string_fmt_append(g, " S=%d", transport_count);
1187 /* Local delivery */
1189 if (addr->transport->info->local)
1191 if (addr->host_list)
1192 g = string_append(g, 2, US" H=", addr->host_list->name);
1193 g = d_log_interface(g);
1194 if (addr->shadow_message)
1195 g = string_cat(g, addr->shadow_message);
1198 /* Remote delivery */
1202 if (addr->host_used)
1204 g = d_hostlog(g, addr);
1206 #ifndef DISABLE_EVENT
1207 deliver_host_address = addr->host_used->address;
1208 deliver_host_port = addr->host_used->port;
1209 deliver_host = addr->host_used->name;
1211 /* DNS lookup status */
1212 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1213 : addr->host_used->dnssec==DS_NO ? US"no"
1219 g = d_tlslog(g, addr);
1222 if (addr->authenticator)
1224 g = string_append(g, 2, US" A=", addr->authenticator);
1227 g = string_append(g, 2, US":", addr->auth_id);
1228 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1229 g = string_append(g, 2, US":", addr->auth_sndr);
1233 if (LOGGING(pipelining))
1235 if (testflag(addr, af_pipelining))
1236 g = string_catn(g, US" L", 2);
1237 #ifndef DISABLE_PIPE_CONNECT
1238 if (testflag(addr, af_early_pipe))
1239 g = string_catn(g, US"*", 1);
1243 #ifndef DISABLE_PRDR
1244 if (testflag(addr, af_prdr_used))
1245 g = string_catn(g, US" PRDR", 5);
1248 if (testflag(addr, af_chunking_used))
1249 g = string_catn(g, US" K", 2);
1252 #ifndef DISABLE_DKIM
1253 if (addr->dkim_used && LOGGING(dkim_verbose))
1255 g = string_catn(g, US" DKIM=", 6);
1256 g = string_cat(g, addr->dkim_used);
1260 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1262 if ( LOGGING(smtp_confirmation)
1264 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1267 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1268 uschar *p = big_buffer;
1269 uschar *ss = addr->message;
1271 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1273 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1278 g = string_append(g, 2, US" C=", big_buffer);
1281 /* Time on queue and actual time taken to deliver */
1283 if (LOGGING(queue_time))
1284 g = string_append(g, 2, US" QT=", string_timesince(
1285 LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1287 if (LOGGING(deliver_time))
1288 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1290 /* string_cat() always leaves room for the terminator. Release the
1291 store we used to build the line after writing it. */
1293 log_write(0, flags, "%Y", g);
1295 #ifndef DISABLE_EVENT
1296 if (!msg) msg_event_raise(US"msg:delivery", addr);
1299 store_reset(reset_point);
1306 deferral_log(address_item * addr, uschar * now,
1307 int logflags, uschar * driver_name, uschar * driver_kind)
1309 rmark reset_point = store_mark();
1310 gstring * g = string_get(256);
1312 /* Build up the line that is used for both the message log and the main
1315 /* Create the address string for logging. Must not do this earlier, because
1316 an OK result may be changed to FAIL when a pipe returns text. */
1318 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1321 g = string_append(g, 2, US" Q=", queue_name);
1323 /* Either driver_name contains something and driver_kind contains
1324 " router" or " transport" (note the leading space), or driver_name is
1325 a null string and driver_kind contains "routing" without the leading
1326 space, if all routing has been deferred. When a domain has been held,
1327 so nothing has been done at all, both variables contain null strings. */
1331 if (driver_kind[1] == 't' && addr->router)
1332 g = string_append(g, 2, US" R=", addr->router->name);
1333 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1335 else if (driver_kind)
1336 g = string_append(g, 2, US" ", driver_kind);
1338 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1340 if (addr->basic_errno > 0)
1341 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1343 if (addr->host_used)
1344 g = d_hostlog(g, addr);
1346 if (LOGGING(deliver_time))
1347 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1350 g = string_append(g, 2, US": ", addr->message);
1352 /* Log the deferment in the message log, but don't clutter it
1353 up with retry-time defers after the first delivery attempt. */
1355 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1356 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1358 /* Write the main log and reset the store.
1359 For errors of the type "retry time not reached" (also remotes skipped
1360 on queue run), logging is controlled by L_retry_defer. Note that this kind
1361 of error number is negative, and all the retry ones are less than any
1365 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1368 store_reset(reset_point);
1375 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1377 rmark reset_point = store_mark();
1378 gstring * g = string_get(256);
1380 #ifndef DISABLE_EVENT
1381 /* Message failures for which we will send a DSN get their event raised
1382 later so avoid doing it here. */
1384 if ( !addr->prop.ignore_error
1385 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1387 msg_event_raise(US"msg:fail:delivery", addr);
1390 /* Build up the log line for the message and main logs */
1392 /* Create the address string for logging. Must not do this earlier, because
1393 an OK result may be changed to FAIL when a pipe returns text. */
1395 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1397 if (LOGGING(sender_on_delivery))
1398 g = string_append(g, 3, US" F=<", sender_address, US">");
1401 g = string_append(g, 2, US" Q=", queue_name);
1403 /* Return path may not be set if no delivery actually happened */
1405 if (used_return_path && LOGGING(return_path_on_delivery))
1406 g = string_append(g, 3, US" P=<", used_return_path, US">");
1409 g = string_append(g, 2, US" R=", addr->router->name);
1410 if (addr->transport)
1411 g = string_append(g, 2, US" T=", addr->transport->name);
1413 if (addr->host_used)
1414 g = d_hostlog(g, addr);
1417 g = d_tlslog(g, addr);
1420 if (addr->basic_errno > 0)
1421 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1424 g = string_append(g, 2, US": ", addr->message);
1426 if (LOGGING(deliver_time))
1427 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1429 /* Do the logging. For the message log, "routing failed" for those cases,
1430 just to make it clearer. */
1433 deliver_msglog("%s %s failed for %.*s\n", now, driver_kind, g->ptr, g->s);
1435 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1437 log_write(0, LOG_MAIN, "** %Y", g);
1439 store_reset(reset_point);
1445 /*************************************************
1446 * Actions at the end of handling an address *
1447 *************************************************/
1449 /* This is a function for processing a single address when all that can be done
1450 with it has been done.
1453 addr points to the address block
1454 result the result of the delivery attempt
1455 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1456 driver_type indicates which type of driver (transport, or router) was last
1457 to process the address
1458 logchar '=' or '-' for use when logging deliveries with => or ->
1464 post_process_one(address_item * addr, int result, int logflags, int driver_type,
1467 uschar * now = tod_stamp(tod_log);
1468 uschar * driver_kind = NULL;
1469 uschar * driver_name = NULL;
1471 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1473 /* Set up driver kind and name for logging. Disable logging if the router or
1474 transport has disabled it. */
1476 if (driver_type == EXIM_DTYPE_TRANSPORT)
1478 if (addr->transport)
1480 driver_name = addr->transport->name;
1481 driver_kind = US" transport";
1482 f.disable_logging = addr->transport->disable_logging;
1484 else driver_kind = US"transporting";
1486 else if (driver_type == EXIM_DTYPE_ROUTER)
1490 driver_name = addr->router->name;
1491 driver_kind = US" router";
1492 f.disable_logging = addr->router->disable_logging;
1494 else driver_kind = US"routing";
1497 /* If there's an error message set, ensure that it contains only printing
1498 characters - it should, but occasionally things slip in and this at least
1499 stops the log format from getting wrecked. We also scan the message for an LDAP
1500 expansion item that has a password setting, and flatten the password. This is a
1501 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1502 malformed, it won't ever have gone near LDAP.) */
1506 const uschar * s = string_printing(addr->message);
1508 /* deconst cast ok as string_printing known to have alloc'n'copied */
1509 addr->message = expand_hide_passwords(US s);
1512 /* If we used a transport that has one of the "return_output" options set, and
1513 if it did in fact generate some output, then for return_output we treat the
1514 message as failed if it was not already set that way, so that the output gets
1515 returned to the sender, provided there is a sender to send it to. For
1516 return_fail_output, do this only if the delivery failed. Otherwise we just
1517 unlink the file, and remove the name so that if the delivery failed, we don't
1518 try to send back an empty or unwanted file. The log_output options operate only
1519 on a non-empty file.
1521 In any case, we close the message file, because we cannot afford to leave a
1522 file-descriptor for one address while processing (maybe very many) others. */
1524 if (addr->return_file >= 0 && addr->return_filename)
1526 BOOL return_output = FALSE;
1527 struct stat statbuf;
1528 (void)EXIMfsync(addr->return_file);
1530 /* If there is no output, do nothing. */
1532 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1534 transport_instance *tb = addr->transport;
1536 /* Handle logging options */
1539 || result == FAIL && tb->log_fail_output
1540 || result == DEFER && tb->log_defer_output
1544 FILE *f = Ufopen(addr->return_filename, "rb");
1546 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1547 "from %s transport: %s", addr->return_filename, tb->name,
1550 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1552 uschar *p = big_buffer + Ustrlen(big_buffer);
1554 while (p > big_buffer && isspace(p[-1])) p--;
1556 sp = string_printing(big_buffer);
1557 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1558 addr->address, tb->name, sp);
1563 /* Handle returning options, but only if there is an address to return
1566 if (sender_address[0] != 0 || addr->prop.errors_address)
1567 if (tb->return_output)
1569 addr->transport_return = result = FAIL;
1570 if (addr->basic_errno == 0 && !addr->message)
1571 addr->message = US"return message generated";
1572 return_output = TRUE;
1575 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1578 /* Get rid of the file unless it might be returned, but close it in
1583 Uunlink(addr->return_filename);
1584 addr->return_filename = NULL;
1585 addr->return_file = -1;
1588 (void)close(addr->return_file);
1591 /* Check if the transport notifed continue-conn status explicitly, and
1592 update our knowlege. */
1594 if (testflag(addr, af_new_conn)) continue_sequence = 1;
1595 else if (testflag(addr, af_cont_conn)) continue_sequence++;
1597 /* The success case happens only after delivery by a transport. */
1601 addr->next = addr_succeed;
1602 addr_succeed = addr;
1604 /* Call address_done() to ensure that we don't deliver to this address again,
1605 and write appropriate things to the message log. If it is a child address, we
1606 call child_done() to scan the ancestors and mark them complete if this is the
1607 last child to complete. */
1609 address_done(addr, now);
1610 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1613 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1614 driver_name, driver_kind);
1617 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1618 addr->parent->address, driver_name, driver_kind);
1619 child_done(addr, now);
1622 /* Certificates for logging (via events) */
1624 tls_out.ourcert = addr->ourcert;
1625 addr->ourcert = NULL;
1626 tls_out.peercert = addr->peercert;
1627 addr->peercert = NULL;
1629 tls_out.ver = addr->tlsver;
1630 tls_out.cipher = addr->cipher;
1631 tls_out.peerdn = addr->peerdn;
1632 tls_out.ocsp = addr->ocsp;
1633 # ifdef SUPPORT_DANE
1634 tls_out.dane_verified = testflag(addr, af_dane_verified);
1638 delivery_log(LOG_MAIN, addr, logchar, NULL);
1641 tls_free_cert(&tls_out.ourcert);
1642 tls_free_cert(&tls_out.peercert);
1644 tls_out.cipher = NULL;
1645 tls_out.peerdn = NULL;
1646 tls_out.ocsp = OCSP_NOT_REQ;
1647 # ifdef SUPPORT_DANE
1648 tls_out.dane_verified = FALSE;
1654 /* Soft failure, or local delivery process failed; freezing may be
1657 else if (result == DEFER || result == PANIC)
1659 if (result == PANIC) logflags |= LOG_PANIC;
1661 /* This puts them on the chain in reverse order. Do not change this, because
1662 the code for handling retries assumes that the one with the retry
1663 information is last. */
1665 addr->next = addr_defer;
1668 /* The only currently implemented special action is to freeze the
1669 message. Logging of this is done later, just before the -H file is
1672 if (addr->special_action == SPECIAL_FREEZE)
1674 f.deliver_freeze = TRUE;
1675 deliver_frozen_at = time(NULL);
1676 update_spool = TRUE;
1679 /* If doing a 2-stage queue run, we skip writing to either the message
1680 log or the main log for SMTP defers. */
1682 if (!f.queue_2stage || addr->basic_errno != 0)
1683 deferral_log(addr, now, logflags, driver_name, driver_kind);
1687 /* Hard failure. If there is an address to which an error message can be sent,
1688 put this address on the failed list. If not, put it on the deferred list and
1689 freeze the mail message for human attention. The latter action can also be
1690 explicitly requested by a router or transport. */
1694 /* If this is a delivery error, or a message for which no replies are
1695 wanted, and the message's age is greater than ignore_bounce_errors_after,
1696 force the af_ignore_error flag. This will cause the address to be discarded
1697 later (with a log entry). */
1699 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1700 addr->prop.ignore_error = TRUE;
1702 /* Freeze the message if requested, or if this is a bounce message (or other
1703 message with null sender) and this address does not have its own errors
1704 address. However, don't freeze if errors are being ignored. The actual code
1705 to ignore occurs later, instead of sending a message. Logging of freezing
1706 occurs later, just before writing the -H file. */
1708 if ( !addr->prop.ignore_error
1709 && ( addr->special_action == SPECIAL_FREEZE
1710 || (sender_address[0] == 0 && !addr->prop.errors_address)
1713 frozen_info = addr->special_action == SPECIAL_FREEZE
1715 : f.sender_local && !f.local_error_message
1716 ? US" (message created with -f <>)"
1717 : US" (delivery error message)";
1718 f.deliver_freeze = TRUE;
1719 deliver_frozen_at = time(NULL);
1720 update_spool = TRUE;
1722 /* The address is put on the defer rather than the failed queue, because
1723 the message is being retained. */
1725 addr->next = addr_defer;
1729 /* Don't put the address on the nonrecipients tree yet; wait until an
1730 error message has been successfully sent. */
1734 addr->next = addr_failed;
1738 failure_log(addr, driver_name ? NULL : driver_kind, now);
1741 /* Ensure logging is turned on again in all cases */
1743 f.disable_logging = FALSE;
1749 /*************************************************
1750 * Address-independent error *
1751 *************************************************/
1753 /* This function is called when there's an error that is not dependent on a
1754 particular address, such as an expansion string failure. It puts the error into
1755 all the addresses in a batch, logs the incident on the main and panic logs, and
1756 clears the expansions. It is mostly called from local_deliver(), but can be
1757 called for a remote delivery via findugid().
1760 logit TRUE if (MAIN+PANIC) logging required
1761 addr the first of the chain of addresses
1763 format format string for error message, or NULL if already set in addr
1764 ... arguments for the format
1770 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1772 addr->basic_errno = code;
1779 va_start(ap, format);
1780 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1782 addr->message = string_from_gstring(g);
1785 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1787 addr2->basic_errno = code;
1788 addr2->message = addr->message;
1791 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1792 deliver_set_expansions(NULL);
1798 /*************************************************
1799 * Check a "never users" list *
1800 *************************************************/
1802 /* This function is called to check whether a uid is on one of the two "never
1806 uid the uid to be checked
1807 nusers the list to be scanned; the first item in the list is the count
1809 Returns: TRUE if the uid is on the list
1813 check_never_users(uid_t uid, uid_t *nusers)
1815 if (!nusers) return FALSE;
1816 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1822 /*************************************************
1823 * Find uid and gid for a transport *
1824 *************************************************/
1826 /* This function is called for both local and remote deliveries, to find the
1827 uid/gid under which to run the delivery. The values are taken preferentially
1828 from the transport (either explicit or deliver_as_creator), then from the
1829 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1830 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1831 panic error is logged, and the function fails (which normally leads to delivery
1835 addr the address (possibly a chain)
1837 uidp pointer to uid field
1838 gidp pointer to gid field
1839 igfp pointer to the use_initgroups field
1841 Returns: FALSE if failed - error has been set in address(es)
1845 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1849 BOOL gid_set = FALSE;
1851 /* Default initgroups flag comes from the transport */
1853 *igfp = tp->initgroups;
1855 /* First see if there's a gid on the transport, either fixed or expandable.
1856 The expanding function always logs failure itself. */
1863 else if (tp->expand_gid)
1865 GET_OPTION("group");
1866 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1869 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1875 /* If the transport did not set a group, see if the router did. */
1877 if (!gid_set && testflag(addr, af_gid_set))
1883 /* Pick up a uid from the transport if one is set. */
1885 if (tp->uid_set) *uidp = tp->uid;
1887 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1888 it does not provide a passwd value from which a gid can be taken. */
1890 else if (tp->expand_uid)
1894 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1895 uidp, &(addr->message)))
1897 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1907 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1909 else if (tp->deliver_as_creator)
1911 *uidp = originator_uid;
1914 *gidp = originator_gid;
1919 /* Otherwise see if the address specifies the uid and if so, take it and its
1922 else if (testflag(addr, af_uid_set))
1925 *igfp = testflag(addr, af_initgroups);
1928 /* Nothing has specified the uid - default to the Exim user, and group if the
1941 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1942 defaulting to the Exim uid. In other words, if the configuration has specified
1943 a uid, it must also provide a gid. */
1947 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1948 "%s transport", tp->name);
1952 /* Check that the uid is not on the lists of banned uids that may not be used
1953 for delivery processes. */
1955 nuname = check_never_users(*uidp, never_users)
1957 : check_never_users(*uidp, fixed_never_users)
1958 ? US"fixed_never_users"
1962 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1963 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1975 /*************************************************
1976 * Check the size of a message for a transport *
1977 *************************************************/
1979 /* Checks that the message isn't too big for the selected transport.
1980 This is called only when it is known that the limit is set.
1984 addr the (first) address being delivered
1987 DEFER expansion failed or did not yield an integer
1988 FAIL message too big
1992 check_message_size(transport_instance *tp, address_item *addr)
1997 GET_OPTION("message_size_limit");
1998 deliver_set_expansions(addr);
1999 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2000 deliver_set_expansions(NULL);
2002 if (expand_string_message)
2005 addr->message = size_limit == -1
2006 ? string_sprintf("failed to expand message_size_limit "
2007 "in %s transport: %s", tp->name, expand_string_message)
2008 : string_sprintf("invalid message_size_limit "
2009 "in %s transport: %s", tp->name, expand_string_message);
2011 else if (size_limit > 0 && message_size > size_limit)
2015 string_sprintf("message is too big (transport limit = %d)",
2024 /*************************************************
2025 * Transport-time check for a previous delivery *
2026 *************************************************/
2028 /* Check that this base address hasn't previously been delivered to its routed
2029 transport. If it has been delivered, mark it done. The check is necessary at
2030 delivery time in order to handle homonymic addresses correctly in cases where
2031 the pattern of redirection changes between delivery attempts (so the unique
2032 fields change). Non-homonymic previous delivery is detected earlier, at routing
2033 time (which saves unnecessary routing).
2036 addr the address item
2037 testing TRUE if testing wanted only, without side effects
2039 Returns: TRUE if previously delivered by the transport
2043 previously_transported(address_item *addr, BOOL testing)
2045 uschar * s = string_sprintf("%s/%s",
2046 addr->unique + (testflag(addr, af_homonym) ? 3:0), addr->transport->name);
2048 if (tree_search(tree_nonrecipients, s) != 0)
2050 DEBUG(D_deliver|D_route|D_transport)
2051 debug_printf("%s was previously delivered (%s transport): discarded\n",
2052 addr->address, addr->transport->name);
2053 if (!testing) child_done(addr, tod_stamp(tod_log));
2062 /******************************************************
2063 * Check for a given header in a header string *
2064 ******************************************************/
2066 /* This function is used when generating quota warnings. The configuration may
2067 specify any header lines it likes in quota_warn_message. If certain of them are
2068 missing, defaults are inserted, so we need to be able to test for the presence
2072 hdr the required header name
2073 hstring the header string
2075 Returns: TRUE the header is in the string
2076 FALSE the header is not in the string
2080 contains_header(uschar *hdr, uschar *hstring)
2082 int len = Ustrlen(hdr);
2083 uschar *p = hstring;
2086 if (strncmpic(p, hdr, len) == 0)
2089 while (*p == ' ' || *p == '\t') p++;
2090 if (*p == ':') return TRUE;
2092 while (*p != 0 && *p != '\n') p++;
2093 if (*p == '\n') p++;
2101 /*************************************************
2102 * Perform a local delivery *
2103 *************************************************/
2105 /* Each local delivery is performed in a separate process which sets its
2106 uid and gid as specified. This is a safer way than simply changing and
2107 restoring using seteuid(); there is a body of opinion that seteuid()
2108 cannot be used safely. From release 4, Exim no longer makes any use of
2109 it for delivery. Besides, not all systems have seteuid().
2111 If the uid/gid are specified in the transport_instance, they are used; the
2112 transport initialization must ensure that either both or neither are set.
2113 Otherwise, the values associated with the address are used. If neither are set,
2114 it is a configuration error.
2116 The transport or the address may specify a home directory (transport over-
2117 rides), and if they do, this is set as $home. If neither have set a working
2118 directory, this value is used for that as well. Otherwise $home is left unset
2119 and the cwd is set to "/" - a directory that should be accessible to all users.
2121 Using a separate process makes it more complicated to get error information
2122 back. We use a pipe to pass the return code and also an error code and error
2123 text string back to the parent process.
2126 addr points to an address block for this delivery; for "normal" local
2127 deliveries this is the only address to be delivered, but for
2128 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2129 a number of addresses can be handled simultaneously, and in this
2130 case addr will point to a chain of addresses with the same
2133 shadowing TRUE if running a shadow transport; this causes output from pipes
2140 deliver_local(address_item *addr, BOOL shadowing)
2142 BOOL use_initgroups;
2145 int status, len, rc;
2148 uschar *working_directory;
2149 address_item *addr2;
2150 transport_instance *tp = addr->transport;
2152 /* Set up the return path from the errors or sender address. If the transport
2153 has its own return path setting, expand it and replace the existing value. */
2155 if(addr->prop.errors_address)
2156 return_path = addr->prop.errors_address;
2158 return_path = sender_address;
2160 GET_OPTION("return_path");
2161 if (tp->return_path)
2163 uschar * new_return_path = expand_string(tp->return_path);
2164 if (new_return_path)
2165 return_path = new_return_path;
2166 else if (!f.expand_string_forcedfail)
2168 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2169 US"Failed to expand return path \"%s\" in %s transport: %s",
2170 tp->return_path, tp->name, expand_string_message);
2175 /* For local deliveries, one at a time, the value used for logging can just be
2176 set directly, once and for all. */
2178 used_return_path = return_path;
2180 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2181 gets put into the address(es), and the expansions are unset, so we can just
2184 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2186 /* See if either the transport or the address specifies a home directory. A
2187 home directory set in the address may already be expanded; a flag is set to
2188 indicate that. In other cases we must expand it. */
2190 GET_OPTION("home_directory");
2191 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2192 || ( (deliver_home = addr->home_dir) /* Set in address and */
2193 && !testflag(addr, af_home_expanded) /* not expanded */
2196 uschar *rawhome = deliver_home;
2197 deliver_home = NULL; /* in case it contains $home */
2198 if (!(deliver_home = expand_string(rawhome)))
2200 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2201 "to expand for %s transport: %s", rawhome, tp->name,
2202 expand_string_message);
2205 if (*deliver_home != '/')
2207 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2208 "is not absolute for %s transport", deliver_home, tp->name);
2213 /* See if either the transport or the address specifies a current directory,
2214 and if so, expand it. If nothing is set, use the home directory, unless it is
2215 also unset in which case use "/", which is assumed to be a directory to which
2216 all users have access. It is necessary to be in a visible directory for some
2217 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2218 2.5) require this. */
2220 GET_OPTION("current_directory");
2221 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2222 if (working_directory)
2224 uschar *raw = working_directory;
2225 if (!(working_directory = expand_string(raw)))
2227 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2228 "failed to expand for %s transport: %s", raw, tp->name,
2229 expand_string_message);
2232 if (*working_directory != '/')
2234 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2235 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2239 else working_directory = deliver_home ? deliver_home : US"/";
2241 /* If one of the return_output flags is set on the transport, create and open a
2242 file in the message log directory for the transport to write its output onto.
2243 This is mainly used by pipe transports. The file needs to be unique to the
2244 address. This feature is not available for shadow transports. */
2247 && ( tp->return_output || tp->return_fail_output
2248 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2253 addr->return_filename =
2254 spool_fname(US"msglog", message_subdir, message_id,
2255 string_sprintf("-%d-%d", getpid(), return_count++));
2257 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2259 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2260 "to return message: %s", error, tp->name, strerror(errno));
2265 /* Create the pipe for inter-process communication. */
2269 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2274 /* Now fork the process to do the real work in the subprocess, but first
2275 ensure that all cached resources are freed so that the subprocess starts with
2276 a clean slate and doesn't interfere with the parent process. */
2280 if ((pid = exim_fork(US"delivery-local")) == 0)
2282 BOOL replicate = TRUE;
2284 /* Prevent core dumps, as we don't want them in users' home directories.
2285 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2286 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2287 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2288 complain if the error is "not supported".
2290 There are two scenarios where changing the max limit has an effect. In one,
2291 the user is using a .forward and invoking a command of their choice via pipe;
2292 for these, we do need the max limit to be 0 unless the admin chooses to
2293 permit an increased limit. In the other, the command is invoked directly by
2294 the transport and is under administrator control, thus being able to raise
2295 the limit aids in debugging. So there's no general always-right answer.
2297 Thus we inhibit core-dumps completely but let individual transports, while
2298 still root, re-raise the limits back up to aid debugging. We make the
2299 default be no core-dumps -- few enough people can use core dumps in
2300 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2307 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2309 # ifdef SETRLIMIT_NOT_SUPPORTED
2310 if (errno != ENOSYS && errno != ENOTSUP)
2312 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2317 /* Reset the random number generator, so different processes don't all
2318 have the same sequence. */
2322 /* If the transport has a setup entry, call this first, while still
2323 privileged. (Appendfile uses this to expand quota, for example, while
2324 able to read private files.) */
2326 if (addr->transport->setup)
2327 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2331 addr->transport_return = DEFER;
2335 addr->transport_return = PANIC;
2339 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2340 when the process becomes unprivileged, it won't be able to write to the
2341 process log. SIGHUP is ignored throughout exim, except when it is being
2344 signal(SIGINT, SIG_IGN);
2345 signal(SIGTERM, SIG_IGN);
2346 signal(SIGUSR1, SIG_IGN);
2348 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2349 half - for transports that exec things (e.g. pipe). Then set the required
2352 (void)close(pfd[pipe_read]);
2353 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2355 exim_setugid(uid, gid, use_initgroups,
2356 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2357 addr->address, addr->transport->name));
2361 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2362 for (address_item * batched = addr->next; batched; batched = batched->next)
2363 debug_printf("additional batched address: %s\n", batched->address);
2366 /* Set an appropriate working directory. */
2368 if (Uchdir(working_directory) < 0)
2370 addr->transport_return = DEFER;
2371 addr->basic_errno = errno;
2372 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2375 /* If successful, call the transport */
2380 set_process_info("delivering %s to %s using %s", message_id,
2381 addr->local_part, tp->name);
2383 /* Setting these globals in the subprocess means we need never clear them */
2385 transport_name = tp->name;
2386 if (addr->router) router_name = addr->router->name;
2387 driver_srcfile = tp->srcfile;
2388 driver_srcline = tp->srcline;
2390 /* If a transport filter has been specified, set up its argument list.
2391 Any errors will get put into the address, and FALSE yielded. */
2393 if (tp->filter_command)
2395 ok = transport_set_up_command(&transport_filter_argv,
2397 TSUC_EXPAND_ARGS, PANIC, addr, US"transport filter", NULL);
2398 transport_filter_timeout = tp->filter_timeout;
2400 else transport_filter_argv = NULL;
2404 debug_print_string(tp->debug_string);
2405 replicate = !(tp->info->code)(addr->transport, addr);
2409 /* Pass the results back down the pipe. If necessary, first replicate the
2410 status in the top address to the others in the batch. The label is the
2411 subject of a goto when a call to the transport's setup function fails. We
2412 pass the pointer to the transport back in case it got changed as a result of
2413 file_format in appendfile. */
2417 if (replicate) replicate_status(addr);
2418 for (addr2 = addr; addr2; addr2 = addr2->next)
2421 int local_part_length = Ustrlen(addr2->local_part);
2425 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2426 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2427 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2428 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2429 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2430 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2431 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2432 || (ret = write(pfd[pipe_write], &addr2->transport,
2433 sizeof(transport_instance *))) != sizeof(transport_instance *)
2435 /* For a file delivery, pass back the local part, in case the original
2436 was only part of the final delivery path. This gives more complete
2439 || (testflag(addr2, af_file)
2440 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2441 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2445 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2446 ret == -1 ? strerror(errno) : "short write");
2448 /* Now any messages */
2450 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2452 int message_length = s ? Ustrlen(s) + 1 : 0;
2453 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2454 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2456 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2457 ret == -1 ? strerror(errno) : "short write");
2461 /* OK, this process is now done. Free any cached resources that it opened,
2462 and close the pipe we were writing down before exiting. */
2464 (void)close(pfd[pipe_write]);
2465 exim_exit(EXIT_SUCCESS);
2468 /* Back in the main process: panic if the fork did not succeed. This seems
2469 better than returning an error - if forking is failing it is probably best
2470 not to try other deliveries for this message. */
2473 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2476 /* Read the pipe to get the delivery status codes and error messages. Our copy
2477 of the writing end must be closed first, as otherwise read() won't return zero
2478 on an empty pipe. We check that a status exists for each address before
2479 overwriting the address structure. If data is missing, the default DEFER status
2480 will remain. Afterwards, close the reading end. */
2482 (void)close(pfd[pipe_write]);
2484 for (addr2 = addr; addr2; addr2 = addr2->next)
2486 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2491 addr2->transport_return = status;
2492 len = read(pfd[pipe_read], &transport_count,
2493 sizeof(transport_count));
2494 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2495 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2496 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2497 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2498 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2499 len = read(pfd[pipe_read], &addr2->transport,
2500 sizeof(transport_instance *));
2502 if (testflag(addr2, af_file))
2505 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2506 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2509 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2510 " from delivery subprocess");
2513 /* sanity-checked llen so disable the Coverity error */
2514 /* coverity[tainted_data] */
2515 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2517 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2518 " from delivery subprocess");
2521 big_buffer[llen] = 0;
2522 addr2->local_part = string_copy(big_buffer);
2525 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2528 len = read(pfd[pipe_read], &message_length, sizeof(int));
2529 if (message_length > 0)
2531 len = read(pfd[pipe_read], big_buffer, message_length);
2532 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2533 if (len > 0) *sptr = string_copy(big_buffer);
2540 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2541 "from delivery subprocess", addr2->unique);
2546 (void)close(pfd[pipe_read]);
2548 /* Unless shadowing, write all successful addresses immediately to the journal
2549 file, to ensure they are recorded asap. For homonymic addresses, use the base
2550 address plus the transport name. Failure to write the journal is panic-worthy,
2551 but don't stop, as it may prove possible subsequently to update the spool file
2552 in order to record the delivery. */
2556 for (addr2 = addr; addr2; addr2 = addr2->next)
2557 if (addr2->transport_return == OK)
2559 if (testflag(addr2, af_homonym))
2560 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2562 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2564 /* In the test harness, wait just a bit to let the subprocess finish off
2565 any debug output etc first. */
2567 testharness_pause_ms(300);
2569 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2570 len = Ustrlen(big_buffer);
2571 if (write(journal_fd, big_buffer, len) != len)
2572 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2573 big_buffer, strerror(errno));
2576 /* Ensure the journal file is pushed out to disk. */
2578 if (EXIMfsync(journal_fd) < 0)
2579 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2583 /* Wait for the process to finish. If it terminates with a non-zero code,
2584 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2585 status values of all the addresses as they are. Take care to handle the case
2586 when the subprocess doesn't seem to exist. This has been seen on one system
2587 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2588 happens, wait() doesn't recognize the termination of child processes. Exim now
2589 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2591 while ((rc = wait(&status)) != pid)
2592 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2594 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2595 addr->transport->driver_name);
2600 if ((status & 0xffff) != 0)
2602 int msb = (status >> 8) & 255;
2603 int lsb = status & 255;
2604 int code = (msb == 0)? (lsb & 0x7f) : msb;
2605 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2606 addr->special_action = SPECIAL_FREEZE;
2607 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2608 "status 0x%04x: %s %d",
2609 addr->transport->driver_name,
2611 msb == 0 ? "terminated by signal" : "exit code",
2615 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2617 if (addr->special_action == SPECIAL_WARN)
2619 uschar * warn_message = addr->transport->warn_message;
2620 GET_OPTION("quota_warn_message");
2626 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2628 if (!(warn_message = expand_string(warn_message)))
2629 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2630 "message for %s transport): %s", addr->transport->warn_message,
2631 addr->transport->name, expand_string_message);
2633 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2635 FILE * f = fdopen(fd, "wb");
2636 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2637 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2638 fprintf(f, "Auto-Submitted: auto-replied\n");
2639 if (!contains_header(US"From", warn_message))
2641 fprintf(f, "%s", CS warn_message);
2643 /* Close and wait for child process to complete, without a timeout. */
2646 (void)child_close(pid, 0);
2649 addr->special_action = SPECIAL_NONE;
2657 /* Check transport for the given concurrency limit. Return TRUE if over
2658 the limit (or an expansion failure), else FALSE and if there was a limit,
2659 the key for the hints database used for the concurrency count. */
2662 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2664 unsigned max_parallel;
2666 GET_OPTION("max_parallel");
2667 if (!tp->max_parallel) return FALSE;
2669 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2670 if (expand_string_message)
2672 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2673 "in %s transport (%s): %s", tp->name, addr->address,
2674 expand_string_message);
2678 if (max_parallel > 0)
2680 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2681 if (!enq_start(serialize_key, max_parallel))
2683 address_item * next;
2685 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2686 tp->name, max_parallel);
2690 addr->message = US"concurrency limit reached for transport";
2691 addr->basic_errno = ERRNO_TRETRY;
2692 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2693 } while ((addr = next));
2696 *key = serialize_key;
2703 /*************************************************
2704 * Do local deliveries *
2705 *************************************************/
2707 /* This function processes the list of addresses in addr_local. True local
2708 deliveries are always done one address at a time. However, local deliveries can
2709 be batched up in some cases. Typically this is when writing batched SMTP output
2710 files for use by some external transport mechanism, or when running local
2711 deliveries over LMTP.
2718 do_local_deliveries(void)
2721 open_db *dbm_file = NULL;
2722 time_t now = time(NULL);
2724 /* Loop until we have exhausted the supply of local deliveries */
2728 struct timeval delivery_start;
2729 struct timeval deliver_time;
2730 address_item *addr2, *addr3, *nextaddr;
2731 int logflags = LOG_MAIN;
2732 int logchar = f.dont_deliver? '*' : '=';
2733 transport_instance *tp;
2734 uschar * serialize_key = NULL;
2736 /* Pick the first undelivered address off the chain */
2738 address_item *addr = addr_local;
2739 addr_local = addr->next;
2742 DEBUG(D_deliver|D_transport)
2743 debug_printf("--------> %s <--------\n", addr->address);
2745 /* An internal disaster if there is no transport. Should not occur! */
2747 if (!(tp = addr->transport))
2749 logflags |= LOG_PANIC;
2750 f.disable_logging = FALSE; /* Jic */
2751 addr->message = addr->router
2752 ? string_sprintf("No transport set by %s router", addr->router->name)
2753 : US"No transport set by system filter";
2754 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2758 /* Check that this base address hasn't previously been delivered to this
2759 transport. The check is necessary at this point to handle homonymic addresses
2760 correctly in cases where the pattern of redirection changes between delivery
2761 attempts. Non-homonymic previous delivery is detected earlier, at routing
2764 if (previously_transported(addr, FALSE)) continue;
2766 /* There are weird cases where logging is disabled */
2768 f.disable_logging = tp->disable_logging;
2770 /* Check for batched addresses and possible amalgamation. Skip all the work
2771 if either batch_max <= 1 or there aren't any other addresses for local
2774 if (tp->batch_max > 1 && addr_local)
2776 int batch_count = 1;
2777 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2778 BOOL uses_lp = ( testflag(addr, af_pfr)
2779 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2781 || readconf_depends((driver_instance *)tp, US"local_part");
2782 uschar *batch_id = NULL;
2783 address_item **anchor = &addr_local;
2784 address_item *last = addr;
2787 /* Expand the batch_id string for comparison with other addresses.
2788 Expansion failure suppresses batching. */
2790 GET_OPTION("batch_id");
2793 deliver_set_expansions(addr);
2794 batch_id = expand_string(tp->batch_id);
2795 deliver_set_expansions(NULL);
2798 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2799 "in %s transport (%s): %s", tp->name, addr->address,
2800 expand_string_message);
2801 batch_count = tp->batch_max;
2805 /* Until we reach the batch_max limit, pick off addresses which have the
2806 same characteristics. These are:
2809 not previously delivered (see comment about 50 lines above)
2810 same local part if the transport's configuration contains $local_part
2811 or if this is a file or pipe delivery from a redirection
2812 same domain if the transport's configuration contains $domain
2814 same additional headers
2815 same headers to be removed
2816 same uid/gid for running the transport
2817 same first host if a host list is set
2820 while ((next = *anchor) && batch_count < tp->batch_max)
2823 tp == next->transport
2824 && !previously_transported(next, TRUE)
2825 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2826 && testflag(addr, af_file) == testflag(next, af_file)
2827 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2828 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2829 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2830 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2831 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2832 && same_ugid(tp, addr, next)
2833 && ( !addr->host_list && !next->host_list
2836 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2839 /* If the transport has a batch_id setting, batch_id will be non-NULL
2840 from the expansion outside the loop. Expand for this address and compare.
2841 Expansion failure makes this address ineligible for batching. */
2846 address_item * save_nextnext = next->next;
2847 next->next = NULL; /* Expansion for a single address */
2848 deliver_set_expansions(next);
2849 next->next = save_nextnext;
2850 GET_OPTION("batch_id");
2851 bid = expand_string(tp->batch_id);
2852 deliver_set_expansions(NULL);
2855 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2856 "in %s transport (%s): %s", tp->name, next->address,
2857 expand_string_message);
2860 else ok = (Ustrcmp(batch_id, bid) == 0);
2863 /* Take address into batch if OK. */
2867 *anchor = next->next; /* Include the address */
2873 else anchor = &next->next; /* Skip the address */
2877 /* We now have one or more addresses that can be delivered in a batch. Check
2878 whether the transport is prepared to accept a message of this size. If not,
2879 fail them all forthwith. If the expansion fails, or does not yield an
2880 integer, defer delivery. */
2882 if (tp->message_size_limit)
2884 int rc = check_message_size(tp, addr);
2887 replicate_status(addr);
2891 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2894 continue; /* With next batch of addresses */
2898 /* If we are not running the queue, or if forcing, all deliveries will be
2899 attempted. Otherwise, we must respect the retry times for each address. Even
2900 when not doing this, we need to set up the retry key string, and determine
2901 whether a retry record exists, because after a successful delivery, a delete
2902 retry item must be set up. Keep the retry database open only for the duration
2903 of these checks, rather than for all local deliveries, because some local
2904 deliveries (e.g. to pipes) can take a substantial time. */
2906 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2907 DEBUG(D_deliver|D_retry|D_hints_lookup)
2908 debug_printf("no retry data available\n");
2914 BOOL ok = TRUE; /* to deliver this address */
2917 /* Set up the retry key to include the domain or not, and change its
2918 leading character from "R" to "T". Must make a copy before doing this,
2919 because the old key may be pointed to from a "delete" retry item after
2922 retry_key = string_copy(
2923 tp->retry_use_local_part ? addr2->address_retry_key :
2924 addr2->domain_retry_key);
2927 /* Inspect the retry data. If there is no hints file, delivery happens. */
2931 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2933 /* If there is no retry record, delivery happens. If there is,
2934 remember it exists so it can be deleted after a successful delivery. */
2938 setflag(addr2, af_lt_retry_exists);
2940 /* A retry record exists for this address. If queue running and not
2941 forcing, inspect its contents. If the record is too old, or if its
2942 retry time has come, or if it has passed its cutoff time, delivery
2947 debug_printf("retry record exists: age=%s ",
2948 readconf_printtime(now - retry_record->time_stamp));
2949 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2950 debug_printf(" time to retry = %s expired = %d\n",
2951 readconf_printtime(retry_record->next_try - now),
2952 retry_record->expired);
2955 if (f.queue_running && !f.deliver_force)
2957 ok = (now - retry_record->time_stamp > retry_data_expire)
2958 || (now >= retry_record->next_try)
2959 || retry_record->expired;
2961 /* If we haven't reached the retry time, there is one more check
2962 to do, which is for the ultimate address timeout. */
2965 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2969 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2972 /* This address is to be delivered. Leave it on the chain. */
2977 addr2 = addr2->next;
2980 /* This address is to be deferred. Take it out of the chain, and
2981 post-process it as complete. Must take it out of the chain first,
2982 because post processing puts it on another chain. */
2986 address_item *this = addr2;
2987 this->message = US"Retry time not yet reached";
2988 this->basic_errno = ERRNO_LRETRY;
2989 addr2 = addr3 ? (addr3->next = addr2->next)
2990 : (addr = addr2->next);
2991 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2995 if (dbm_file) dbfn_close(dbm_file);
2997 /* If there are no addresses left on the chain, they all deferred. Loop
2998 for the next set of addresses. */
3000 if (!addr) continue;
3002 /* If the transport is limited for parallellism, enforce that here.
3003 We use a hints DB entry, incremented here and decremented after
3004 the transport (and any shadow transport) completes. */
3006 if (tpt_parallel_check(tp, addr, &serialize_key))
3008 if (expand_string_message)
3010 logflags |= LOG_PANIC;
3014 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3015 } while ((addr = addr2));
3017 continue; /* Loop for the next set of addresses. */
3021 /* So, finally, we do have some addresses that can be passed to the
3022 transport. Before doing so, set up variables that are relevant to a
3025 deliver_set_expansions(addr);
3027 gettimeofday(&delivery_start, NULL);
3028 deliver_local(addr, FALSE);
3029 timesince(&deliver_time, &delivery_start);
3031 /* If a shadow transport (which must perforce be another local transport), is
3032 defined, and its condition is met, we must pass the message to the shadow
3033 too, but only those addresses that succeeded. We do this by making a new
3034 chain of addresses - also to keep the original chain uncontaminated. We must
3035 use a chain rather than doing it one by one, because the shadow transport may
3038 NOTE: if the condition fails because of a lookup defer, there is nothing we
3042 && ( !tp->shadow_condition
3043 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3046 transport_instance *stp;
3047 address_item *shadow_addr = NULL;
3048 address_item **last = &shadow_addr;
3050 for (stp = transports; stp; stp = stp->next)
3051 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3054 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3057 /* Pick off the addresses that have succeeded, and make clones. Put into
3058 the shadow_message field a pointer to the shadow_message field of the real
3061 else for (addr2 = addr; addr2; addr2 = addr2->next)
3062 if (addr2->transport_return == OK)
3064 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3067 addr3->shadow_message = US &addr2->shadow_message;
3068 addr3->transport = stp;
3069 addr3->transport_return = DEFER;
3070 addr3->return_filename = NULL;
3071 addr3->return_file = -1;
3073 last = &addr3->next;
3076 /* If we found any addresses to shadow, run the delivery, and stick any
3077 message back into the shadow_message field in the original. */
3081 int save_count = transport_count;
3083 DEBUG(D_deliver|D_transport)
3084 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3085 deliver_local(shadow_addr, TRUE);
3087 for(; shadow_addr; shadow_addr = shadow_addr->next)
3089 int sresult = shadow_addr->transport_return;
3090 *(uschar **)shadow_addr->shadow_message =
3092 ? string_sprintf(" ST=%s", stp->name)
3093 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3094 shadow_addr->basic_errno <= 0
3096 : US strerror(shadow_addr->basic_errno),
3097 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3100 shadow_addr->message
3101 ? shadow_addr->message
3102 : shadow_addr->basic_errno <= 0
3106 DEBUG(D_deliver|D_transport)
3107 debug_printf("%s shadow transport returned %s for %s\n",
3108 stp->name, rc_to_string(sresult), shadow_addr->address);
3111 DEBUG(D_deliver|D_transport)
3112 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3114 transport_count = save_count; /* Restore original transport count */
3118 /* Cancel the expansions that were set up for the delivery. */
3120 deliver_set_expansions(NULL);
3122 /* If the transport was parallelism-limited, decrement the hints DB record. */
3124 if (serialize_key) enq_end(serialize_key);
3126 /* Now we can process the results of the real transport. We must take each
3127 address off the chain first, because post_process_one() puts it on another
3130 for (addr2 = addr; addr2; addr2 = nextaddr)
3132 int result = addr2->transport_return;
3133 nextaddr = addr2->next;
3135 DEBUG(D_deliver|D_transport)
3136 debug_printf("%s transport returned %s for %s\n",
3137 tp->name, rc_to_string(result), addr2->address);
3139 /* If there is a retry_record, or if delivery is deferred, build a retry
3140 item for setting a new retry time or deleting the old retry record from
3141 the database. These items are handled all together after all addresses
3142 have been handled (so the database is open just for a short time for
3145 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3147 int flags = result == DEFER ? 0 : rf_delete;
3148 uschar * retry_key = string_copy(tp->retry_use_local_part
3149 ? addr2->address_retry_key : addr2->domain_retry_key);
3151 retry_add_item(addr2, retry_key, flags);
3154 /* Done with this address */
3156 addr2->delivery_time = deliver_time;
3157 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3159 /* If a pipe delivery generated text to be sent back, the result may be
3160 changed to FAIL, and we must copy this for subsequent addresses in the
3163 if (addr2->transport_return != result)
3165 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3167 addr3->transport_return = addr2->transport_return;
3168 addr3->basic_errno = addr2->basic_errno;
3169 addr3->message = addr2->message;
3171 result = addr2->transport_return;
3174 /* Whether or not the result was changed to FAIL, we need to copy the
3175 return_file value from the first address into all the addresses of the
3176 batch, so they are all listed in the error message. */
3178 addr2->return_file = addr->return_file;
3180 /* Change log character for recording successful deliveries. */
3182 if (result == OK) logchar = '-';
3184 } /* Loop back for next batch of addresses */
3190 /*************************************************
3191 * Sort remote deliveries *
3192 *************************************************/
3194 /* This function is called if remote_sort_domains is set. It arranges that the
3195 chain of addresses for remote deliveries is ordered according to the strings
3196 specified. Try to make this shuffling reasonably efficient by handling
3197 sequences of addresses rather than just single ones.
3204 sort_remote_deliveries(void)
3207 address_item **aptr = &addr_remote;
3208 const uschar *listptr = remote_sort_domains;
3212 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3214 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3217 address_item *moved = NULL;
3218 address_item **bptr = &moved;
3222 address_item **next;
3223 deliver_domain = (*aptr)->domain; /* set $domain */
3224 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3225 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3227 aptr = &(*aptr)->next;
3231 next = &(*aptr)->next;
3233 && (deliver_domain = (*next)->domain, /* Set $domain */
3234 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3235 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3237 next = &(*next)->next;
3239 /* If the batch of non-matchers is at the end, add on any that were
3240 extracted further up the chain, and end this iteration. Otherwise,
3241 extract them from the chain and hang on the moved chain. */
3253 aptr = &(*aptr)->next;
3256 /* If the loop ended because the final address matched, *aptr will
3257 be NULL. Add on to the end any extracted non-matching addresses. If
3258 *aptr is not NULL, the loop ended via "break" when *next is null, that
3259 is, there was a string of non-matching addresses at the end. In this
3260 case the extracted addresses have already been added on the end. */
3262 if (!*aptr) *aptr = moved;
3267 debug_printf("remote addresses after sorting:\n");
3268 for (address_item * addr = addr_remote; addr; addr = addr->next)
3269 debug_printf(" %s\n", addr->address);
3275 /*************************************************
3276 * Read from pipe for remote delivery subprocess *
3277 *************************************************/
3279 /* This function is called when the subprocess is complete, but can also be
3280 called before it is complete, in order to empty a pipe that is full (to prevent
3281 deadlock). It must therefore keep track of its progress in the parlist data
3284 We read the pipe to get the delivery status codes and a possible error message
3285 for each address, optionally preceded by unusability data for the hosts and
3286 also by optional retry data.
3288 Read in large chunks into the big buffer and then scan through, interpreting
3289 the data therein. In most cases, only a single read will be necessary. No
3290 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3291 that we read the next chunk when there is less than 2500 bytes left in the
3292 non-final chunk, we can assume each item is complete in the buffer before
3293 handling it. Each item is written using a single write(), which is atomic for
3294 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3295 often bigger) so even if we are reading while the subprocess is still going, we
3296 should never have only a partial item in the buffer.
3298 hs12: This assumption is not true anymore, since we get quite large items (certificate
3299 information and such).
3302 poffset the offset of the parlist item
3303 eop TRUE if the process has completed
3305 Returns: TRUE if the terminating 'Z' item has been read,
3306 or there has been a disaster (i.e. no more data needed);
3311 par_read_pipe(int poffset, BOOL eop)
3314 pardata *p = parlist + poffset;
3315 address_item *addrlist = p->addrlist;
3316 address_item *addr = p->addr;
3320 uschar *msg = p->msg;
3321 BOOL done = p->done;
3323 /* Loop through all items, reading from the pipe when necessary. The pipe
3324 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3325 here, as the preceding poll() tells us, if data is available for reading.
3327 A read() on a "selected" handle should never block, but(!) it may return
3328 less data then we expected. (The buffer size we pass to read() shouldn't be
3329 understood as a "request", but as a "limit".)
3331 Each separate item is written to the pipe in a timely manner. But, especially for
3332 larger items, the read(2) may already return partial data from the write(2).
3334 The write is atomic mostly (depending on the amount written), but atomic does
3335 not imply "all or noting", it just is "not intermixed" with other writes on the
3336 same channel (pipe).
3340 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3341 (int)p->pid, eop? "ended" : "not ended yet");
3345 retry_item *r, **rp;
3346 uschar pipeheader[PIPE_HEADER_SIZE+1];
3347 uschar *id = &pipeheader[0];
3348 uschar *subid = &pipeheader[1];
3349 uschar *ptr = big_buffer;
3350 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3353 DEBUG(D_deliver) debug_printf(
3354 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3356 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3357 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3358 If we get less, we can assume the subprocess do be done and do not expect any further
3359 information from it. */
3361 if ((got = readn(fd, pipeheader, required)) != required)
3363 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3364 "from transport process %d for transport %s",
3365 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3370 pipeheader[PIPE_HEADER_SIZE] = '\0';
3372 debug_printf("got %ld bytes (pipeheader) '%c' from transport process %d\n",
3373 (long) got, *id, pid);
3376 /* If we can't decode the pipeheader, the subprocess seems to have a
3377 problem, we do not expect any furher information from it. */
3379 required = Ustrtol(pipeheader+2, &endc, 10);
3382 msg = string_sprintf("failed to read pipe "
3383 "from transport process %d for transport %s: error decoding size from header",
3384 pid, addr->transport->driver_name);
3391 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3392 (u_long)required, pid);
3394 /* Same as above, the transport process will write the bytes announced
3395 in a timely manner, so we can just wait for the bytes, getting less than expected
3396 is considered a problem of the subprocess, we do not expect anything else from it. */
3397 if ((got = readn(fd, big_buffer, required)) != required)
3399 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3400 " bytes (pipedata) from transport process %d for transport %s",
3401 got, required, pid, addr->transport->driver_name);
3406 /* Handle each possible type of item, assuming the complete item is
3407 available in store. */
3411 /* Host items exist only if any hosts were marked unusable. Match
3412 up by checking the IP address. */
3415 for (h = addrlist->host_list; h; h = h->next)
3417 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3425 /* Retry items are sent in a preceding R item for each address. This is
3426 kept separate to keep each message short enough to guarantee it won't
3427 be split in the pipe. Hopefully, in the majority of cases, there won't in
3428 fact be any retry items at all.
3430 The complete set of retry items might include an item to delete a
3431 routing retry if there was a previous routing delay. However, routing
3432 retries are also used when a remote transport identifies an address error.
3433 In that case, there may also be an "add" item for the same key. Arrange
3434 that a "delete" item is dropped in favour of an "add" item. */
3437 if (!addr) goto ADDR_MISMATCH;
3439 DEBUG(D_deliver|D_retry)
3440 debug_printf("reading retry information for %s from subprocess\n",
3443 /* Cut out any "delete" items on the list. */
3445 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3446 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3448 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3449 *rp = r->next; /* Excise a delete item */
3450 DEBUG(D_deliver|D_retry)
3451 debug_printf(" existing delete item dropped\n");
3454 /* We want to add a delete item only if there is no non-delete item;
3455 however we still have to step ptr through the data. */
3457 if (!r || !(*ptr & rf_delete))
3459 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3460 r->next = addr->retries;
3463 r->key = string_copy(ptr);
3465 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3466 ptr += sizeof(r->basic_errno);
3467 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3468 ptr += sizeof(r->more_errno);
3469 r->message = *ptr ? string_copy(ptr) : NULL;
3470 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3471 r->flags & rf_delete ? "delete" : "retry");
3476 DEBUG(D_deliver|D_retry)
3477 debug_printf(" delete item not added: non-delete item exists\n");
3480 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3486 /* Put the amount of data written into the parlist block */
3488 case 'S': /* Size */
3489 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3490 ptr += sizeof(transport_count);
3493 /* Address items are in the order of items on the address chain. We
3494 remember the current address value in case this function is called
3495 several times to empty the pipe in stages. Information about delivery
3496 over TLS is sent in a preceding X item for each address. We don't put
3497 it in with the other info, in order to keep each message short enough to
3498 guarantee it won't be split in the pipe. */
3501 case 'X': /* TLS details */
3502 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3506 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3510 addr->cipher = string_copy(ptr);
3511 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3515 addr->peerdn = string_copy(ptr);
3520 (void) tls_import_cert(ptr, &addr->peercert);
3522 addr->peercert = NULL;
3527 (void) tls_import_cert(ptr, &addr->ourcert);
3529 addr->ourcert = NULL;
3532 # ifndef DISABLE_OCSP
3534 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3540 #endif /*DISABLE_TLS*/
3542 case 'C': /* client authenticator information */
3545 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3546 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3547 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3552 #ifndef DISABLE_PRDR
3554 setflag(addr, af_prdr_used);
3561 #ifndef DISABLE_PIPE_CONNECT
3562 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3564 case 1: setflag(addr, af_pipelining); break;
3569 setflag(addr, af_chunking_used);
3573 setflag(addr, af_tcp_fastopen_conn);
3574 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3575 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3579 if (!addr) goto ADDR_MISMATCH;
3580 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3581 ptr += sizeof(addr->dsn_aware);
3582 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3585 case 'A': /* Per-address info */
3589 msg = string_sprintf("address count mismatch for data read from pipe "
3590 "for transport process %d for transport %s", pid,
3591 addrlist->transport->driver_name);
3598 #ifndef DISABLE_DKIM
3599 case '4': /* DKIM information */
3600 addr->dkim_used = string_copy(ptr);
3605 case '3': /* explicit notification of continued-connection (non)use;
3606 overrides caller's knowlege. */
3607 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3608 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3611 #ifdef SUPPORT_SOCKS
3612 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3613 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3618 proxy_local_address = string_copy(ptr);
3620 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3621 ptr += sizeof(proxy_local_port);
3626 #ifdef EXPERIMENTAL_DSN_INFO
3627 case '1': /* must arrive before A0, and applies to that addr */
3628 /* Two strings: smtp_greeting and helo_response */
3629 addr->smtp_greeting = string_copy(ptr);
3631 addr->helo_response = string_copy(ptr);
3636 case '0': /* results of trying to send to this address */
3637 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3638 addr->transport_return = *ptr++;
3639 addr->special_action = *ptr++;
3640 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3641 ptr += sizeof(addr->basic_errno);
3642 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3643 ptr += sizeof(addr->more_errno);
3644 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3645 ptr += sizeof(addr->delivery_time);
3646 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3647 ptr += sizeof(addr->flags);
3648 addr->message = *ptr ? string_copy(ptr) : NULL;
3650 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3653 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3657 h = store_get(sizeof(host_item), GET_UNTAINTED);
3658 h->name = string_copy(ptr);
3660 h->address = string_copy(ptr);
3662 memcpy(&h->port, ptr, sizeof(h->port));
3663 ptr += sizeof(h->port);
3664 h->dnssec = *ptr == '2' ? DS_YES
3665 : *ptr == '1' ? DS_NO
3668 addr->host_used = h;
3672 /* Finished with this address */
3679 /* Local interface address/port */
3681 if (*ptr) sending_ip_address = string_copy(ptr);
3683 if (*ptr) sending_port = atoi(CS ptr);
3687 /* Z marks the logical end of the data. It is followed by '0' if
3688 continue_transport was NULL at the end of transporting, otherwise '1'.
3689 We need to know when it becomes NULL during a delivery down a passed SMTP
3690 channel so that we don't try to pass anything more down it. Of course, for
3691 most normal messages it will remain NULL all the time. */
3696 continue_transport = NULL;
3697 continue_hostname = NULL;
3700 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3703 /* Anything else is a disaster. */
3706 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3707 "process %d for transport %s", ptr[-1], pid,
3708 addr->transport->driver_name);
3714 /* The done flag is inspected externally, to determine whether or not to
3715 call the function again when the process finishes. */
3719 /* If the process hadn't finished, and we haven't seen the end of the data
3720 or if we suffered a disaster, update the rest of the state, and return FALSE to
3721 indicate "not finished". */
3730 /* Close our end of the pipe, to prevent deadlock if the far end is still
3731 pushing stuff into it. */
3736 /* If we have finished without error, but haven't had data for every address,
3737 something is wrong. */
3740 msg = string_sprintf("insufficient address data read from pipe "
3741 "for transport process %d for transport %s", pid,
3742 addr->transport->driver_name);
3744 /* If an error message is set, something has gone wrong in getting back
3745 the delivery data. Put the message into each address and freeze it. */
3748 for (addr = addrlist; addr; addr = addr->next)
3750 addr->transport_return = DEFER;
3751 addr->special_action = SPECIAL_FREEZE;
3752 addr->message = msg;
3753 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3756 /* Return TRUE to indicate we have got all we need from this process, even
3757 if it hasn't actually finished yet. */
3764 /*************************************************
3765 * Post-process a set of remote addresses *
3766 *************************************************/
3768 /* Do what has to be done immediately after a remote delivery for each set of
3769 addresses, then re-write the spool if necessary. Note that post_process_one
3770 puts the address on an appropriate queue; hence we must fish off the next
3771 one first. This function is also called if there is a problem with setting
3772 up a subprocess to do a remote delivery in parallel. In this case, the final
3773 argument contains a message, and the action must be forced to DEFER.
3776 addr pointer to chain of address items
3777 logflags flags for logging
3778 msg NULL for normal cases; -> error message for unexpected problems
3779 fallback TRUE if processing fallback hosts
3785 remote_post_process(address_item * addr, int logflags, uschar * msg,
3788 /* If any host addresses were found to be unusable, add them to the unusable
3789 tree so that subsequent deliveries don't try them. */
3791 for (host_item * h = addr->host_list; h; h = h->next)
3793 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3795 /* Now handle each address on the chain. The transport has placed '=' or '-'
3796 into the special_action field for each successful delivery. */
3800 address_item * next = addr->next;
3802 /* If msg == NULL (normal processing) and the result is DEFER and we are
3803 processing the main hosts and there are fallback hosts available, put the
3804 address on the list for fallback delivery. */
3806 if ( addr->transport_return == DEFER
3807 && addr->fallback_hosts
3812 addr->host_list = addr->fallback_hosts;
3813 addr->next = addr_fallback;
3814 addr_fallback = addr;
3815 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3818 /* If msg is set (=> unexpected problem), set it in the address before
3819 doing the ordinary post processing. */
3825 addr->message = msg;
3826 addr->transport_return = DEFER;
3828 (void)post_process_one(addr, addr->transport_return, logflags,
3829 EXIM_DTYPE_TRANSPORT, addr->special_action);
3837 /* If we have just delivered down a passed SMTP channel, and that was
3838 the last address, the channel will have been closed down. Now that
3839 we have logged that delivery, set continue_sequence to 1 so that
3840 any subsequent deliveries don't get "*" incorrectly logged. */
3842 if (!continue_transport) continue_sequence = 1;
3847 /*************************************************
3848 * Wait for one remote delivery subprocess *
3849 *************************************************/
3851 /* This function is called while doing remote deliveries when either the
3852 maximum number of processes exist and we need one to complete so that another
3853 can be created, or when waiting for the last ones to complete. It must wait for
3854 the completion of one subprocess, empty the control block slot, and return a
3855 pointer to the address chain.
3858 Returns: pointer to the chain of addresses handled by the process;
3859 NULL if no subprocess found - this is an unexpected error
3862 static address_item *
3865 int poffset, status;
3866 address_item * addr, * addrlist;
3869 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3870 "to finish", message_id);
3872 /* Loop until either a subprocess completes, or there are no subprocesses in
3873 existence - in which case give an error return. We cannot proceed just by
3874 waiting for a completion, because a subprocess may have filled up its pipe, and
3875 be waiting for it to be emptied. Therefore, if no processes have finished, we
3876 wait for one of the pipes to acquire some data by calling poll(), with a
3877 timeout just in case.
3879 The simple approach is just to iterate after reading data from a ready pipe.
3880 This leads to non-ideal behaviour when the subprocess has written its final Z
3881 item, closed the pipe, and is in the process of exiting (the common case). A
3882 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3883 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3886 To avoid this, if all the data that is needed has been read from a subprocess
3887 after poll(), an explicit wait() for it is done. We know that all it is doing
3888 is writing to the pipe and then exiting, so the wait should not be long.
3890 The non-blocking waitpid() is to some extent just insurance; if we could
3891 reliably detect end-of-file on the pipe, we could always know when to do a
3892 blocking wait() for a completed process. However, because some systems use
3893 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3894 use code that functions without the need to recognize EOF.
3896 There's a double loop here just in case we end up with a process that is not in
3897 the list of remote delivery processes. Something has obviously gone wrong if
3898 this is the case. (For example, a process that is incorrectly left over from
3899 routing or local deliveries might be found.) The damage can be minimized by
3900 looping back and looking for another process. If there aren't any, the error
3901 return will happen. */
3903 for (;;) /* Normally we do not repeat this loop */
3905 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3909 /* A return value of -1 can mean several things. If errno != ECHILD, it
3910 either means invalid options (which we discount), or that this process was
3911 interrupted by a signal. Just loop to try the waitpid() again.
3913 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3914 in existence. This should never happen, and is an unexpected error.
3915 However, there is a nasty complication when running under Linux. If "strace
3916 -f" is being used under Linux to trace this process and its children,
3917 subprocesses are "stolen" from their parents and become the children of the
3918 tracing process. A general wait such as the one we've just obeyed returns
3919 as if there are no children while subprocesses are running. Once a
3920 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3921 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3924 This does not happen using "truss" on Solaris, nor (I think) with other
3925 tracing facilities on other OS. It seems to be specific to Linux.
3927 What we do to get round this is to use kill() to see if any of our
3928 subprocesses are still in existence. If kill() gives an OK return, we know
3929 it must be for one of our processes - it can't be for a re-use of the pid,
3930 because if our process had finished, waitpid() would have found it. If any
3931 of our subprocesses are in existence, we proceed to use poll() as if
3932 waitpid() had returned zero. I think this is safe. */
3936 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3939 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3940 "for process existence\n");
3942 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3944 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3946 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3947 "stolen by strace\n", (int)pid);
3948 break; /* With poffset set */
3952 if (poffset >= remote_max_parallel)
3954 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3955 return NULL; /* This is the error return */
3959 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3960 been handled above. A return value of zero means that there is at least one
3961 subprocess, but there are no completed subprocesses. See if any pipes are
3962 ready with any data for reading. */
3964 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3966 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3967 if (parlist[poffset].pid != 0)
3969 parpoll[poffset].fd = parlist[poffset].fd;
3970 parpoll[poffset].events = POLLIN;
3973 parpoll[poffset].fd = -1;
3975 /* Stick in a 60-second timeout, just in case. */
3977 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3979 /* Scan through the pipes and read any that are ready; use the count
3980 returned by poll() to stop when there are no more. Select() can return
3981 with no processes (e.g. if interrupted). This shouldn't matter.
3983 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3984 read, or there was a disaster. In either case, we are finished with this
3985 process. Do an explicit wait() for the process and break the main loop if
3988 It turns out that we have to deal with the case of an interrupted system
3989 call, which can happen on some operating systems if the signal handling is
3990 set up to do that by default. */
3993 readycount > 0 && poffset < remote_max_parallel;
3996 if ( (pid = parlist[poffset].pid) != 0
3997 && parpoll[poffset].revents
4001 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4002 for (;;) /* Loop for signals */
4004 pid_t endedpid = waitpid(pid, &status, 0);
4005 if (endedpid == pid) goto PROCESS_DONE;
4006 if (endedpid != (pid_t)(-1) || errno != EINTR)
4007 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4008 "%d (errno = %d) from waitpid() for process %d",
4009 (int)endedpid, errno, (int)pid);
4014 /* Now go back and look for a completed subprocess again. */
4017 /* A completed process was detected by the non-blocking waitpid(). Find the
4018 data block that corresponds to this subprocess. */
4020 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4021 if (pid == parlist[poffset].pid) break;
4023 /* Found the data block; this is a known remote delivery process. We don't
4024 need to repeat the outer loop. This should be what normally happens. */
4026 if (poffset < remote_max_parallel) break;
4028 /* This situation is an error, but it's probably better to carry on looking
4029 for another process than to give up (as we used to do). */
4031 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4032 "transport process list", pid);
4033 } /* End of the "for" loop */
4035 /* Come here when all the data was completely read after a poll(), and
4036 the process in pid has been wait()ed for. */
4043 debug_printf("remote delivery process %d ended\n", (int)pid);
4045 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4049 set_process_info("delivering %s", message_id);
4051 /* Get the chain of processed addresses */
4053 addrlist = parlist[poffset].addrlist;
4055 /* If the process did not finish cleanly, record an error and freeze (except
4056 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4057 in case the delivery did actually happen. */
4059 if ((status & 0xffff) != 0)
4062 int msb = (status >> 8) & 255;
4063 int lsb = status & 255;
4064 int code = (msb == 0)? (lsb & 0x7f) : msb;
4066 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4068 addrlist->transport->driver_name,
4070 msb == 0 ? "terminated by signal" : "exit code",
4073 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4074 addrlist->special_action = SPECIAL_FREEZE;
4076 for (addr = addrlist; addr; addr = addr->next)
4078 addr->transport_return = DEFER;
4079 addr->message = msg;
4082 remove_journal = FALSE;
4085 /* Else complete reading the pipe to get the result of the delivery, if all
4086 the data has not yet been obtained. */
4088 else if (!parlist[poffset].done)
4089 (void) par_read_pipe(poffset, TRUE);
4091 /* Put the data count and return path into globals, mark the data slot unused,
4092 decrement the count of subprocesses, and return the address chain. */
4094 transport_count = parlist[poffset].transport_count;
4095 used_return_path = parlist[poffset].return_path;
4096 parlist[poffset].pid = 0;
4103 /*************************************************
4104 * Wait for subprocesses and post-process *
4105 *************************************************/
4107 /* This function waits for subprocesses until the number that are still running
4108 is below a given threshold. For each complete subprocess, the addresses are
4109 post-processed. If we can't find a running process, there is some shambles.
4110 Better not bomb out, as that might lead to multiple copies of the message. Just
4111 log and proceed as if all done.
4114 max maximum number of subprocesses to leave running
4115 fallback TRUE if processing fallback hosts
4121 par_reduce(int max, BOOL fallback)
4123 while (parcount > max)
4125 address_item * doneaddr = par_wait();
4128 log_write(0, LOG_MAIN|LOG_PANIC,
4129 "remote delivery process count got out of step");
4134 transport_instance * tp = doneaddr->transport;
4135 if (tp->max_parallel)
4136 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4138 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4144 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4146 uschar pipe_header[PIPE_HEADER_SIZE+1];
4147 size_t total_len = PIPE_HEADER_SIZE + size;
4149 struct iovec iov[2] = {
4150 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4151 { buf, size } /* *the* data */
4156 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4157 /* complain to log if someone tries with buffer sizes we can't handle*/
4159 if (size > BIG_BUFFER_SIZE-1)
4161 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4162 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4164 size = BIG_BUFFER_SIZE;
4167 /* Should we check that we do not write more than PIPE_BUF? What would
4170 /* convert size to human readable string prepended by id and subid */
4171 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4172 id, subid, (long)size))
4173 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4175 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4176 id, subid, (long)size, pipe_header);
4178 if ((ret = writev(fd, iov, 2)) != total_len)
4179 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4180 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4181 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4184 /*************************************************
4185 * Do remote deliveries *
4186 *************************************************/
4188 /* This function is called to process the addresses in addr_remote. We must
4189 pick off the queue all addresses that have the same transport, remote
4190 destination, and errors address, and hand them to the transport in one go,
4191 subject to some configured limitations. If this is a run to continue delivering
4192 to an existing delivery channel, skip all but those addresses that can go to
4193 that channel. The skipped addresses just get deferred.
4195 If mua_wrapper is set, all addresses must be able to be sent in a single
4196 transaction. If not, this function yields FALSE.
4198 In Exim 4, remote deliveries are always done in separate processes, even
4199 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4200 is so that the base process can retain privilege. This makes the
4201 implementation of fallback transports feasible (though not initially done.)
4203 We create up to the configured number of subprocesses, each of which passes
4204 back the delivery state via a pipe. (However, when sending down an existing
4205 connection, remote_max_parallel is forced to 1.)
4208 fallback TRUE if processing fallback hosts
4210 Returns: TRUE normally
4211 FALSE if mua_wrapper is set and the addresses cannot all be sent
4216 do_remote_deliveries(BOOL fallback)
4221 parcount = 0; /* Number of executing subprocesses */
4223 /* When sending down an existing channel, only do one delivery at a time.
4224 We use a local variable (parmax) to hold the maximum number of processes;
4225 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4227 if (continue_transport) remote_max_parallel = 1;
4228 parmax = remote_max_parallel;
4230 /* If the data for keeping a list of processes hasn't yet been
4235 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4236 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4237 parlist[poffset].pid = 0;
4238 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4241 /* Now loop for each remote delivery */
4243 for (int delivery_count = 0; addr_remote; delivery_count++)
4249 int address_count = 1;
4250 int address_count_max;
4252 BOOL use_initgroups;
4253 BOOL pipe_done = FALSE;
4254 transport_instance *tp;
4255 address_item **anchor = &addr_remote;
4256 address_item *addr = addr_remote;
4257 address_item *last = addr;
4260 uschar * serialize_key = NULL;
4262 /* Pull the first address right off the list. */
4264 addr_remote = addr->next;
4267 DEBUG(D_deliver|D_transport)
4268 debug_printf("--------> %s <--------\n", addr->address);
4270 /* If no transport has been set, there has been a big screw-up somewhere. */
4272 if (!(tp = addr->transport))
4274 f.disable_logging = FALSE; /* Jic */
4275 panicmsg = US"No transport set by router";
4276 goto panic_continue;
4279 /* Check that this base address hasn't previously been delivered to this
4280 transport. The check is necessary at this point to handle homonymic addresses
4281 correctly in cases where the pattern of redirection changes between delivery
4282 attempts. Non-homonymic previous delivery is detected earlier, at routing
4285 if (previously_transported(addr, FALSE)) continue;
4287 /* Force failure if the message is too big. */
4289 if (tp->message_size_limit)
4291 int rc = check_message_size(tp, addr);
4294 addr->transport_return = rc;
4295 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4300 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4301 So look out for the place it gets used.
4304 /* Get the flag which specifies whether the transport can handle different
4305 domains that nevertheless resolve to the same set of hosts. If it needs
4306 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4307 $host, $host_address, $host_port. */
4308 if (tp->expand_multi_domain)
4309 deliver_set_expansions(addr);
4311 if (exp_bool(addr, US"transport", tp->name, D_transport,
4312 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4313 &multi_domain) != OK)
4315 deliver_set_expansions(NULL);
4316 panicmsg = addr->message;
4317 goto panic_continue;
4320 /* Get the maximum it can handle in one envelope, with zero meaning
4321 unlimited, which is forced for the MUA wrapper case and if the
4322 value could vary depending on the messages.
4323 For those, we only split (below) by (tpt,dest,erraddr,hdrs) and rely on the
4324 transport splitting further by max_rcp. So we potentially lose some
4327 address_count_max = mua_wrapper || Ustrchr(tp->max_addresses, '$')
4328 ? UNLIMITED_ADDRS : expand_max_rcpt(tp->max_addresses);
4331 /************************************************************************/
4332 /***** This is slightly experimental code, but should be safe. *****/
4334 /* The address_count_max value is the maximum number of addresses that the
4335 transport can send in one envelope. However, the transport must be capable of
4336 dealing with any number of addresses. If the number it gets exceeds its
4337 envelope limitation, it must send multiple copies of the message. This can be
4338 done over a single connection for SMTP, so uses less resources than making
4339 multiple connections. On the other hand, if remote_max_parallel is greater
4340 than one, it is perhaps a good idea to use parallel processing to move the
4341 message faster, even if that results in multiple simultaneous connections to
4344 How can we come to some compromise between these two ideals? What we do is to
4345 limit the number of addresses passed to a single instance of a transport to
4346 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4347 number of addresses routed to remote transports divided by
4348 remote_max_parallel. For example, if the message has 100 remote recipients,
4349 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4350 once. But if rcpt_max is 100, we could send up to 100.
4352 Of course, not all the remotely addresses in a message are going to go to the
4353 same set of hosts (except in smarthost configurations), so this is just a
4354 heuristic way of dividing up the work.
4356 Furthermore (1), because this may not be wanted in some cases, and also to
4357 cope with really pathological cases, there is also a limit to the number of
4358 messages that are sent over one connection. This is the same limit that is
4359 used when sending several different messages over the same connection.
4360 Continue_sequence is set when in this situation, to the number sent so
4361 far, including this message.
4363 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4364 is probably because they are using VERP, in which case they want to pass only
4365 one address at a time to the transport, in order to be able to use
4366 $local_part and $domain in constructing a new return path. We could test for
4367 the use of these variables, but as it is so likely they will be used when the
4368 maximum is 1, we don't bother. Just leave the value alone. */
4370 if ( address_count_max != 1
4371 && address_count_max < remote_delivery_count/remote_max_parallel
4374 int new_max = remote_delivery_count/remote_max_parallel;
4375 int message_max = tp->connection_max_messages;
4376 if (connection_max_messages >= 0) message_max = connection_max_messages;
4377 message_max -= continue_sequence - 1;
4378 if (message_max > 0 && new_max > address_count_max * message_max)
4379 new_max = address_count_max * message_max;
4380 address_count_max = new_max;
4383 /************************************************************************/
4386 /*XXX don't know yet if DANE will be used. So tpt will have to
4387 check at the point if gets next addr from list, and skip/defer any
4391 /* Pick off all addresses which have the same transport, errors address,
4392 destination, and extra headers. In some cases they point to the same host
4393 list, but we also need to check for identical host lists generated from
4394 entirely different domains. The host list pointers can be NULL in the case
4395 where the hosts are defined in the transport. There is also a configured
4396 maximum limit of addresses that can be handled at once (see comments above
4397 for how it is computed).
4398 If the transport does not handle multiple domains, enforce that also,
4399 and if it might need a per-address check for this, re-evaluate it.
4402 while ((next = *anchor) && address_count < address_count_max)
4405 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4406 && tp == next->transport
4407 && same_hosts(next->host_list, addr->host_list)
4408 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4409 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4410 && same_ugid(tp, next, addr)
4411 && ( next->prop.remove_headers == addr->prop.remove_headers
4412 || ( next->prop.remove_headers
4413 && addr->prop.remove_headers
4414 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4418 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4420 US"transport", next->transport->name, D_transport,
4421 US"multi_domain", next->transport->multi_domain,
4422 next->transport->expand_multi_domain, &md) == OK
4427 *anchor = next->next;
4429 next->first = addr; /* remember top one (for retry processing) */
4434 else anchor = &(next->next);
4435 deliver_set_expansions(NULL);
4438 /* If we are acting as an MUA wrapper, all addresses must go in a single
4439 transaction. If not, put them back on the chain and yield FALSE. */
4441 if (mua_wrapper && addr_remote)
4443 last->next = addr_remote;
4448 /* If the transport is limited for parallellism, enforce that here.
4449 The hints DB entry is decremented in par_reduce(), when we reap the
4450 transport process. */
4452 if (tpt_parallel_check(tp, addr, &serialize_key))
4453 if ((panicmsg = expand_string_message))
4454 goto panic_continue;
4456 continue; /* Loop for the next set of addresses. */
4458 /* Set up the expansion variables for this set of addresses */
4460 deliver_set_expansions(addr);
4462 /* Ensure any transport-set auth info is fresh */
4463 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4465 /* Compute the return path, expanding a new one if required. The old one
4466 must be set first, as it might be referred to in the expansion. */
4468 if(addr->prop.errors_address)
4469 return_path = addr->prop.errors_address;
4471 return_path = sender_address;
4473 GET_OPTION("return_path");
4474 if (tp->return_path)
4476 uschar * new_return_path = expand_string(tp->return_path);
4477 if (new_return_path)
4478 return_path = new_return_path;
4479 else if (!f.expand_string_forcedfail)
4481 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4482 tp->return_path, expand_string_message);
4487 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4488 logs and sets up error messages, so we just post-process and continue with
4489 the next address. */
4491 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4497 /* If this transport has a setup function, call it now so that it gets
4498 run in this process and not in any subprocess. That way, the results of
4499 any setup that are retained by the transport can be reusable. One of the
4500 things the setup does is to set the fallback host lists in the addresses.
4501 That is why it is called at this point, before the continue delivery
4502 processing, because that might use the fallback hosts. */
4505 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4507 /* If we have a connection still open from a verify stage (lazy-close)
4508 treat it as if it is a continued connection (apart from the counter used
4509 for the log line mark). */
4511 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4514 debug_printf("lazy-callout-close: have conn still open from verification\n");
4515 continue_transport = cutthrough.transport;
4516 continue_hostname = string_copy(cutthrough.host.name);
4517 continue_host_address = string_copy(cutthrough.host.address);
4518 continue_sequence = 1;
4519 sending_ip_address = cutthrough.snd_ip;
4520 sending_port = cutthrough.snd_port;
4521 smtp_peer_options = cutthrough.peer_options;
4524 /* If this is a run to continue delivery down an already-established
4525 channel, check that this set of addresses matches the transport and
4526 the channel. If it does not, defer the addresses. If a host list exists,
4527 we must check that the continue host is on the list. Otherwise, the
4528 host is set in the transport. */
4530 f.continue_more = FALSE; /* In case got set for the last lot */
4531 if (continue_transport)
4533 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4534 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4536 /* If the transport is about to override the host list do not check
4537 it here but take the cost of running the transport process to discover
4538 if the continued_hostname connection is suitable. This is a layering
4539 violation which is unfortunate as it requires we haul in the smtp
4544 smtp_transport_options_block * ob;
4546 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4547 && (ob = (smtp_transport_options_block *)tp->options_block)
4548 && ob->hosts_override && ob->hosts
4554 for (host_item * h = addr->host_list; h; h = h->next)
4555 if (Ustrcmp(h->name, continue_hostname) == 0)
4556 /*XXX should also check port here */
4557 { ok = TRUE; break; }
4561 /* Addresses not suitable; defer or queue for fallback hosts (which
4562 might be the continue host) and skip to next address. */
4566 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4567 Ustrcmp(continue_transport, tp->name) != 0
4568 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4569 : string_sprintf("no host matching %s", continue_hostname));
4570 if (serialize_key) enq_end(serialize_key);
4572 if (addr->fallback_hosts && !fallback)
4574 for (next = addr; ; next = next->next)
4576 next->host_list = next->fallback_hosts;
4577 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4578 if (!next->next) break;
4580 next->next = addr_fallback;
4581 addr_fallback = addr;
4586 for (next = addr; ; next = next->next)
4588 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4589 if (!next->next) break;
4591 next->next = addr_defer;
4598 /* Set a flag indicating whether there are further addresses that list
4599 the continued host. This tells the transport to leave the channel open,
4600 but not to pass it to another delivery process. We'd like to do that
4601 for non-continue_transport cases too but the knowlege of which host is
4602 connected to is too hard to manage. Perhaps we need a finer-grain
4603 interface to the transport. */
4605 for (next = addr_remote; next && !f.continue_more; next = next->next)
4606 for (host_item * h = next->host_list; h; h = h->next)
4607 if (Ustrcmp(h->name, continue_hostname) == 0)
4608 { f.continue_more = TRUE; break; }
4611 /* The transports set up the process info themselves as they may connect
4612 to more than one remote machine. They also have to set up the filter
4613 arguments, if required, so that the host name and address are available
4616 transport_filter_argv = NULL;
4618 /* Create the pipe for inter-process communication. If pipe creation
4619 fails, it is probably because the value of remote_max_parallel is so
4620 large that too many file descriptors for pipes have been created. Arrange
4621 to wait for a process to finish, and then try again. If we still can't
4622 create a pipe when all processes have finished, break the retry loop. */
4626 if (pipe(pfd) == 0) pipe_done = TRUE;
4627 else if (parcount > 0) parmax = parcount;
4630 /* We need to make the reading end of the pipe non-blocking. There are
4631 two different options for this. Exim is cunningly (I hope!) coded so
4632 that it can use either of them, though it prefers O_NONBLOCK, which
4633 distinguishes between EOF and no-more-data. */
4635 /* The data appears in a timely manner and we already did a poll on
4636 all pipes, so I do not see a reason to use non-blocking IO here
4639 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4641 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4645 /* If the maximum number of subprocesses already exist, wait for a process
4646 to finish. If we ran out of file descriptors, parmax will have been reduced
4647 from its initial value of remote_max_parallel. */
4649 par_reduce(parmax - 1, fallback);
4652 /* If we failed to create a pipe and there were no processes to wait
4653 for, we have to give up on this one. Do this outside the above loop
4654 so that we can continue the main loop. */
4658 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4662 /* Find a free slot in the pardata list. Must do this after the possible
4663 waiting for processes to finish, because a terminating process will free
4666 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4667 if (parlist[poffset].pid == 0)
4670 /* If there isn't one, there has been a horrible disaster. */
4672 if (poffset >= remote_max_parallel)
4674 (void)close(pfd[pipe_write]);
4675 (void)close(pfd[pipe_read]);
4676 panicmsg = US"Unexpectedly no free subprocess slot";
4680 /* Now fork a subprocess to do the remote delivery, but before doing so,
4681 ensure that any cached resources are released so as not to interfere with
4682 what happens in the subprocess. */
4686 if ((pid = exim_fork(US"transport")) == 0)
4688 int fd = pfd[pipe_write];
4691 /* Setting these globals in the subprocess means we need never clear them */
4693 transport_name = tp->name;
4694 if (addr->router) router_name = addr->router->name;
4695 driver_srcfile = tp->srcfile;
4696 driver_srcline = tp->srcline;
4698 /* There are weird circumstances in which logging is disabled */
4699 f.disable_logging = tp->disable_logging;
4701 /* Show pids on debug output if parallelism possible */
4703 if (parmax > 1 && (parcount > 0 || addr_remote))
4704 DEBUG(D_any|D_v) debug_selector |= D_pid;
4706 /* Reset the random number generator, so different processes don't all
4707 have the same sequence. In the test harness we want different, but
4708 predictable settings for each delivery process, so do something explicit
4709 here rather they rely on the fixed reset in the random number function. */
4711 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4713 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4714 a new process that may be forked to do another delivery down the same
4717 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4719 /* Close open file descriptors for the pipes of other processes
4720 that are running in parallel. */
4722 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4723 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4725 /* This process has inherited a copy of the file descriptor
4726 for the data file, but its file pointer is shared with all the
4727 other processes running in parallel. Therefore, we have to re-open
4728 the file in order to get a new file descriptor with its own
4729 file pointer. We don't need to lock it, as the lock is held by
4730 the parent process. There doesn't seem to be any way of doing
4731 a dup-with-new-file-pointer. */
4733 (void)close(deliver_datafile);
4735 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4737 if ( (deliver_datafile = Uopen(fname, EXIM_CLOEXEC | O_RDWR | O_APPEND, 0))
4739 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4740 "parallel delivery: %s", fname, strerror(errno));
4743 #ifndef O_CLOEXEC /* Set the close-on-exec flag */
4744 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4748 /* Set the uid/gid of this process; bombs out on failure. */
4750 exim_setugid(uid, gid, use_initgroups,
4751 string_sprintf("remote delivery to %s with transport=%s",
4752 addr->address, tp->name));
4754 /* Close the unwanted half of this process' pipe, set the process state,
4755 and run the transport. Afterwards, transport_count will contain the number
4756 of bytes written. */
4758 (void)close(pfd[pipe_read]);
4759 set_process_info("delivering %s using %s", message_id, tp->name);
4760 debug_print_string(tp->debug_string);
4761 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4763 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4764 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4766 /* Ensure any cached resources that we used are now released */
4770 /* Pass the result back down the pipe. This is a lot more information
4771 than is needed for a local delivery. We have to send back the error
4772 status for each address, the usability status for each host that is
4773 flagged as unusable, and all the retry items. When TLS is in use, we
4774 send also the cipher and peerdn information. Each type of information
4775 is flagged by an identifying byte, and is then in a fixed format (with
4776 strings terminated by zeros), and there is a final terminator at the
4777 end. The host information and retry information is all attached to
4778 the first address, so that gets sent at the start. */
4780 /* Host unusability information: for most success cases this will
4783 for (h = addr->host_list; h; h = h->next)
4785 if (!h->address || h->status < hstatus_unusable) continue;
4786 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4787 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4790 /* The number of bytes written. This is the same for each address. Even
4791 if we sent several copies of the message down the same connection, the
4792 size of each one is the same, and it's that value we have got because
4793 transport_count gets reset before calling transport_write_message(). */
4795 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4796 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4798 /* Information about what happened to each address. Four item types are
4799 used: an optional 'X' item first, for TLS information, then an optional "C"
4800 item for any client-auth info followed by 'R' items for any retry settings,
4801 and finally an 'A' item for the remaining data. */
4803 for(; addr; addr = addr->next)
4807 /* The certificate verification status goes into the flags */
4808 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4810 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4812 # ifndef DISABLE_TLS_RESUME
4813 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4816 /* Use an X item only if there's something to send */
4820 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4824 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4826 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4828 else if (continue_proxy_cipher)
4830 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4832 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4838 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4842 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4847 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4851 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4853 # ifndef DISABLE_OCSP
4854 if (addr->ocsp > OCSP_NOT_REQ)
4856 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4857 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4860 #endif /*DISABLE_TLS*/
4862 if (client_authenticator)
4864 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4865 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4867 if (client_authenticated_id)
4869 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4870 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4872 if (client_authenticated_sender)
4874 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4875 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4878 #ifndef DISABLE_PRDR
4879 if (testflag(addr, af_prdr_used))
4880 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4883 if (testflag(addr, af_pipelining))
4884 #ifndef DISABLE_PIPE_CONNECT
4885 if (testflag(addr, af_early_pipe))
4886 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4889 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4891 if (testflag(addr, af_chunking_used))
4892 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4894 if (testflag(addr, af_tcp_fastopen_conn))
4895 rmt_dlv_checked_write(fd, 'T',
4896 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4900 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4901 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4903 /* Retry information: for most success cases this will be null. */
4905 for (retry_item * r = addr->retries; r; r = r->next)
4907 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4908 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4909 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4910 ptr += sizeof(r->basic_errno);
4911 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4912 ptr += sizeof(r->more_errno);
4913 if (!r->message) *ptr++ = 0; else
4915 sprintf(CS ptr, "%.512s", r->message);
4918 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4921 #ifndef DISABLE_DKIM
4922 if (addr->dkim_used && LOGGING(dkim_verbose))
4924 DEBUG(D_deliver) debug_printf("dkim used: %s\n", addr->dkim_used);
4925 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->dkim_used) + 1;
4926 rmt_dlv_checked_write(fd, 'A', '4', big_buffer, ptr - big_buffer);
4930 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4932 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4933 testflag(addr, af_new_conn) ? "non-" : "");
4934 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4935 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4938 #ifdef SUPPORT_SOCKS
4939 if (LOGGING(proxy) && proxy_session)
4942 if (proxy_local_address)
4944 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4945 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4946 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4947 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4948 ptr += sizeof(proxy_local_port);
4952 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4956 #ifdef EXPERIMENTAL_DSN_INFO
4957 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4958 if (addr->smtp_greeting)
4960 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4961 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4962 if (addr->helo_response)
4964 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4965 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4969 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4973 /* The rest of the information goes in an 'A0' item. */
4975 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4976 ptr = big_buffer + 2;
4977 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4978 ptr += sizeof(addr->basic_errno);
4979 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4980 ptr += sizeof(addr->more_errno);
4981 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4982 ptr += sizeof(addr->delivery_time);
4983 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4984 ptr += sizeof(addr->flags);
4986 if (!addr->message) *ptr++ = 0; else
4987 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4989 if (!addr->user_message) *ptr++ = 0; else
4990 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4992 if (!addr->host_used) *ptr++ = 0; else
4994 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4995 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4996 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4997 ptr += sizeof(addr->host_used->port);
4999 /* DNS lookup status */
5000 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
5001 : addr->host_used->dnssec==DS_NO ? '1' : '0';
5004 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
5007 /* Local interface address/port */
5008 #ifdef EXPERIMENTAL_DSN_INFO
5009 if (sending_ip_address)
5011 if (LOGGING(incoming_interface) && sending_ip_address)
5015 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
5016 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
5017 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
5020 /* Add termination flag, close the pipe, and that's it. The character
5021 after 'Z' indicates whether continue_transport is now NULL or not.
5022 A change from non-NULL to NULL indicates a problem with a continuing
5025 big_buffer[0] = continue_transport ? '1' : '0';
5026 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5028 exim_exit(EXIT_SUCCESS);
5031 /* Back in the mainline: close the unwanted half of the pipe. */
5033 (void)close(pfd[pipe_write]);
5035 /* If we have a connection still open from a verify stage (lazy-close)
5036 release its TLS library context (if any) as responsibility was passed to
5037 the delivery child process. */
5039 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5042 if (cutthrough.is_tls)
5043 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5045 (void) close(cutthrough.cctx.sock);
5046 release_cutthrough_connection(US"passed to transport proc");
5049 /* Fork failed; defer with error message */
5053 (void)close(pfd[pipe_read]);
5054 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5055 addr->domain, strerror(errno));
5059 /* Fork succeeded; increment the count, and remember relevant data for
5060 when the process finishes. */
5063 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5064 parlist[poffset].pid = pid;
5065 parlist[poffset].fd = pfd[pipe_read];
5066 parlist[poffset].done = FALSE;
5067 parlist[poffset].msg = NULL;
5068 parlist[poffset].return_path = return_path;
5070 /* If the process we've just started is sending a message down an existing
5071 channel, wait for it now. This ensures that only one such process runs at
5072 once, whatever the value of remote_max parallel. Otherwise, we might try to
5073 send two or more messages simultaneously down the same channel. This could
5074 happen if there are different domains that include the same host in otherwise
5075 different host lists.
5077 Also, if the transport closes down the channel, this information gets back
5078 (continue_transport gets set to NULL) before we consider any other addresses
5081 if (continue_transport) par_reduce(0, fallback);
5083 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5084 newly created process get going before we create another process. This should
5085 ensure repeatability in the tests. Wait long enough for most cases to complete
5088 else testharness_pause_ms(600);
5093 if (serialize_key) enq_end(serialize_key);
5095 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5099 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5100 are still running and post-process their addresses. */
5102 par_reduce(0, fallback);
5109 /*************************************************
5110 * Split an address into local part and domain *
5111 *************************************************/
5113 /* This function initializes an address for routing by splitting it up into a
5114 local part and a domain. The local part is set up twice - once in its original
5115 casing, and once in lower case, and it is dequoted. We also do the "percent
5116 hack" for configured domains. This may lead to a DEFER result if a lookup
5117 defers. When a percent-hacking takes place, we insert a copy of the original
5118 address as a new parent of this address, as if we have had a redirection.
5121 addr points to an addr_item block containing the address
5124 DEFER - could not determine if domain is %-hackable
5128 deliver_split_address(address_item * addr)
5130 const uschar * address = addr->address;
5135 if (!(domain = Ustrrchr(address, '@')))
5136 return DEFER; /* should always have a domain, but just in case... */
5138 len = domain - address;
5139 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5141 /* The implication in the RFCs (though I can't say I've seen it spelled out
5142 explicitly) is that quoting should be removed from local parts at the point
5143 where they are locally interpreted. [The new draft "821" is more explicit on
5144 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5145 removing quoting backslashes and any unquoted doublequotes. */
5147 addr->cc_local_part = t = store_get(len+1, address);
5151 if (c == '\"') continue;
5161 /* We do the percent hack only for those domains that are listed in
5162 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5164 if (percent_hack_domains)
5167 uschar * new_address = NULL;
5168 const uschar * local_part = addr->cc_local_part;
5170 deliver_domain = addr->domain; /* set $domain */
5172 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5173 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5175 && (t = Ustrrchr(local_part, '%')) != NULL
5178 new_address = string_copy(local_part);
5179 new_address[t - local_part] = '@';
5180 deliver_domain = string_copylc(t+1);
5181 local_part = string_copyn(local_part, t - local_part);
5184 if (rc == DEFER) return DEFER; /* lookup deferred */
5186 /* If hackery happened, set up new parent and alter the current address. */
5190 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5191 *new_parent = *addr;
5192 addr->parent = new_parent;
5193 new_parent->child_count = 1;
5194 addr->address = new_address;
5195 addr->unique = string_copy(new_address);
5196 addr->domain = deliver_domain;
5197 addr->cc_local_part = local_part;
5198 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5203 /* Create the lowercased version of the final local part, and make that the
5204 default one to be used. */
5206 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5213 /*************************************************
5214 * Get next error message text *
5215 *************************************************/
5217 /* If f is not NULL, read the next "paragraph", from a customized error message
5218 text file, terminated by a line containing ****, and expand it.
5221 f NULL or a file to read from
5222 which string indicating which string (for errors)
5224 Returns: NULL or an expanded string
5228 next_emf(FILE *f, uschar *which)
5234 if (!f) return NULL;
5236 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5239 para = string_get(256);
5242 para = string_cat(para, buffer);
5243 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5246 if ((yield = expand_string(string_from_gstring(para))))
5249 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5250 "bounce_message_file or warn_message_file (%s): %s", which,
5251 expand_string_message);
5258 /*************************************************
5259 * Close down a passed transport channel *
5260 *************************************************/
5262 /* This function is called when a passed transport channel cannot be used.
5263 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5264 so that the function call can be the argument of a "return" statement.
5267 Returns: DELIVER_NOT_ATTEMPTED
5271 continue_closedown(void)
5273 if (continue_transport)
5274 for (transport_instance * t = transports; t; t = t->next)
5275 if (Ustrcmp(t->name, continue_transport) == 0)
5277 if (t->info->closedown) (t->info->closedown)(t);
5280 return DELIVER_NOT_ATTEMPTED;
5286 /*************************************************
5287 * Print address information *
5288 *************************************************/
5290 /* This function is called to output an address, or information about an
5291 address, for bounce or defer messages. If the hide_child flag is set, all we
5292 output is the original ancestor address.
5295 addr points to the address
5296 f the FILE to print to
5297 si an initial string
5298 sc a continuation string for before "generated"
5301 Returns: TRUE if the address is not hidden
5305 print_address_information(address_item * addr, FILE * f, uschar * si,
5306 uschar * sc, uschar * se)
5309 const uschar * printed = US"";
5310 address_item * ancestor = addr;
5311 while (ancestor->parent) ancestor = ancestor->parent;
5313 fprintf(f, "%s", CS si);
5315 if (addr->parent && testflag(addr, af_hide_child))
5317 printed = US"an undisclosed address";
5320 else if (!testflag(addr, af_pfr) || !addr->parent)
5321 printed = addr->address;
5325 const uschar * s = addr->address;
5328 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5329 else if (addr->address[0] == '|') ss = US"pipe";
5332 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5333 printed = addr->parent->address;
5336 fprintf(f, "%s", CS string_printing(printed));
5338 if (ancestor != addr)
5340 const uschar * original = ancestor->onetime_parent;
5341 if (!original) original= ancestor->address;
5342 if (strcmpic(original, printed) != 0)
5343 fprintf(f, "%s(%sgenerated from %s)", sc,
5344 ancestor != addr->parent ? "ultimately " : "",
5345 string_printing(original));
5348 if (addr->host_used)
5349 fprintf(f, "\n host %s [%s]",
5350 addr->host_used->name, addr->host_used->address);
5352 fprintf(f, "%s", CS se);
5360 /*************************************************
5361 * Print error for an address *
5362 *************************************************/
5364 /* This function is called to print the error information out of an address for
5365 a bounce or a warning message. It tries to format the message reasonably by
5366 introducing newlines. All lines are indented by 4; the initial printing
5367 position must be set before calling.
5369 This function used always to print the error. Nowadays we want to restrict it
5370 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5371 and filter "fail". We no longer pass other information willy-nilly in bounce
5372 and warning messages. Text in user_message is always output; text in message
5373 only if the af_pass_message flag is set.
5377 f the FILE to print on
5384 print_address_error(address_item * addr, FILE * f, const uschar * t)
5386 int count = Ustrlen(t);
5387 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5389 if (!s && !(s = addr->user_message))
5392 fprintf(f, "\n %s", t);
5395 if (*s == '\\' && s[1] == 'n')
5405 if (*s++ == ':' && isspace(*s) && count > 45)
5407 fprintf(f, "\n "); /* sic (because space follows) */
5410 else if (count > 254) /* arbitrary limit */
5412 fprintf(f, "[truncated]");
5413 do s++; while (*s && !(*s == '\\' && s[1] == '\n'));
5419 /***********************************************************
5420 * Print Diagnostic-Code for an address *
5421 ************************************************************/
5423 /* This function is called to print the error information out of an address for
5424 a bounce or a warning message. It tries to format the message reasonably as
5425 required by RFC 3461 by adding a space after each newline
5427 it uses the same logic as print_address_error() above. if af_pass_message is true
5428 and addr->message is set it uses the remote host answer. if not addr->user_message
5429 is used instead if available.
5433 f the FILE to print on
5439 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5441 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5444 /* af_pass_message and addr->message set ? print remote host answer */
5449 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5451 /* search first ": ". we assume to find the remote-MTA answer there */
5452 if (!(s = Ustrstr(addr->message, ": ")))
5453 return; /* not found, bail out */
5455 s += 2; /* skip ": " */
5456 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5460 if (cnt > 950) /* RFC line length limit: 998 */
5462 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5463 fputs("[truncated]", f);
5467 if (*s == '\\' && s[1] == 'n')
5469 fputs("\n ", f); /* as defined in RFC 3461 */
5484 /*************************************************
5485 * Check list of addresses for duplication *
5486 *************************************************/
5488 /* This function was introduced when the test for duplicate addresses that are
5489 not pipes, files, or autoreplies was moved from the middle of routing to when
5490 routing was complete. That was to fix obscure cases when the routing history
5491 affects the subsequent routing of identical addresses. This function is called
5492 after routing, to check that the final routed addresses are not duplicates.
5494 If we detect a duplicate, we remember what it is a duplicate of. Note that
5495 pipe, file, and autoreply de-duplication is handled during routing, so we must
5496 leave such "addresses" alone here, as otherwise they will incorrectly be
5499 Argument: address of list anchor
5504 do_duplicate_check(address_item **anchor)
5507 while ((addr = *anchor))
5510 if (testflag(addr, af_pfr))
5512 anchor = &(addr->next);
5514 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5516 DEBUG(D_deliver|D_route)
5517 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5518 *anchor = addr->next;
5519 addr->dupof = tnode->data.ptr;
5520 addr->next = addr_duplicate;
5521 addr_duplicate = addr;
5525 tree_add_duplicate(addr->unique, addr);
5526 anchor = &(addr->next);
5534 /************************************************/
5537 print_dsn_addr_action(FILE * f, address_item * addr,
5538 uschar * action, uschar * status)
5542 if (addr->dsn_orcpt)
5543 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5545 for (pa = addr; pa->parent; ) pa = pa->parent;
5546 fprintf(f, "Action: %s\n"
5547 "Final-Recipient: rfc822;%s\n"
5549 action, pa->address, status);
5554 /* When running in the test harness, there's an option that allows us to
5555 fudge this time so as to get repeatability of the tests. Take the first
5556 time off the list. In queue runs, the list pointer gets updated in the
5560 test_harness_fudged_queue_time(int actual_time)
5563 if ( f.running_in_test_harness && *fudged_queue_times
5564 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5566 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5567 fudged_queue_times);
5573 /************************************************/
5576 expand_open(const uschar * filename,
5577 const uschar * optname, const uschar * reason)
5579 const uschar * s = expand_cstring(filename);
5583 log_write(0, LOG_MAIN|LOG_PANIC,
5584 "Failed to expand %s: '%s'\n", optname, filename);
5585 else if (*s != '/' || is_tainted(s))
5586 log_write(0, LOG_MAIN|LOG_PANIC,
5587 "%s is not %s after expansion: '%s'\n",
5588 optname, *s == '/' ? "untainted" : "absolute", s);
5589 else if (!(fp = Ufopen(s, "rb")))
5590 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5591 "message texts: %s", s, reason, strerror(errno));
5596 /* Output the given header and string, converting either
5597 the sequence "\n" or a real newline into newline plus space.
5598 If that still takes us past column 78, look for the last space
5599 and split there too.
5600 Append a newline if string did not have one.
5601 Limit to about 1024 chars total. */
5604 dsn_put_wrapped(FILE * fp, const uschar * header, const uschar * s)
5606 gstring * g = string_cat(NULL, header);
5608 g = string_cat(g, s);
5609 gstring_release_unused(g);
5610 fprintf(fp, "%s\n", wrap_header(string_from_gstring(g), 79, 1023, US" ", 1));
5616 /*************************************************
5617 * Send a bounce message *
5618 *************************************************/
5620 /* Find the error address for the first address, then send a message that
5621 includes all failed addresses that have the same error address. Note the
5622 bounce_recipient is a global so that it can be accessed by $bounce_recipient
5623 while creating a customized error message. */
5626 send_bounce_message(time_t now, const uschar * logtod)
5631 if (!(bounce_recipient = addr_failed->prop.errors_address))
5632 bounce_recipient = sender_address;
5634 /* Make a subprocess to send a message, using its stdin */
5636 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
5637 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5638 "create child process to send failure message: %s", getpid(),
5639 getppid(), strerror(errno));
5641 /* Creation of child succeeded */
5645 int ch, rc, filecount = 0, rcount = 0;
5646 uschar * bcc, * emf_text;
5647 FILE * fp = fdopen(fd, "wb"), * emf = NULL;
5648 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5649 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5650 DELIVER_IN_BUFFER_SIZE;
5651 uschar * bound, * dsnlimitmsg, * dsnnotifyhdr;
5653 address_item ** paddr;
5654 address_item * msgchain = NULL, ** pmsgchain = &msgchain;
5655 address_item * handled_addr = NULL;
5658 debug_printf("sending error message to: %s\n", bounce_recipient);
5660 /* Scan the addresses for all that have the same errors address, removing
5661 them from the addr_failed chain, and putting them on msgchain. */
5663 paddr = &addr_failed;
5664 for (address_item * addr = addr_failed; addr; addr = *paddr)
5665 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
5666 ? addr->prop.errors_address : sender_address) == 0)
5667 { /* The same - dechain */
5668 *paddr = addr->next;
5671 pmsgchain = &addr->next;
5674 paddr = &addr->next; /* Not the same; skip */
5676 /* Include X-Failed-Recipients: for automatic interpretation, but do
5677 not let any one header line get too long. We do this by starting a
5678 new header every 50 recipients. Omit any addresses for which the
5679 "hide_child" flag is set. */
5681 for (address_item * addr = msgchain; addr; addr = addr->next)
5683 if (testflag(addr, af_hide_child)) continue;
5691 ? "X-Failed-Recipients: "
5693 testflag(addr, af_pfr) && addr->parent
5694 ? string_printing(addr->parent->address)
5695 : string_printing(addr->address));
5697 if (rcount > 0) fprintf(fp, "\n");
5699 /* Output the standard headers */
5701 if (errors_reply_to)
5702 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
5703 fprintf(fp, "Auto-Submitted: auto-replied\n");
5704 moan_write_from(fp);
5705 fprintf(fp, "To: %s\n", bounce_recipient);
5706 moan_write_references(fp, NULL);
5708 /* generate boundary string and output MIME-Headers */
5709 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
5711 fprintf(fp, "Content-Type: multipart/report;"
5712 " report-type=delivery-status; boundary=%s\n"
5713 "MIME-Version: 1.0\n",
5716 /* Open a template file if one is provided. Log failure to open, but
5717 carry on - default texts will be used. */
5719 GET_OPTION("bounce_message_file");
5720 if (bounce_message_file)
5721 emf = expand_open(bounce_message_file,
5722 US"bounce_message_file", US"error");
5724 /* Quietly copy to configured additional addresses if required. */
5726 if ((bcc = moan_check_errorcopy(bounce_recipient)))
5727 fprintf(fp, "Bcc: %s\n", bcc);
5729 /* The texts for the message can be read from a template file; if there
5730 isn't one, or if it is too short, built-in texts are used. The first
5731 emf text is a Subject: and any other headers. */
5733 if ((emf_text = next_emf(emf, US"header")))
5734 fprintf(fp, "%s\n", emf_text);
5736 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
5737 to_sender? ": returning message to sender" : "");
5739 /* output human readable part as text/plain section */
5740 fprintf(fp, "--%s\n"
5741 "Content-type: text/plain; charset=us-ascii\n\n",
5744 if ((emf_text = next_emf(emf, US"intro")))
5745 fprintf(fp, "%s", CS emf_text);
5749 /* This message has been reworded several times. It seems to be confusing to
5750 somebody, however it is worded. I have retreated to the original, simple
5752 "This message was created automatically by mail delivery software.\n");
5754 if (bounce_message_text)
5755 fprintf(fp, "%s", CS bounce_message_text);
5758 "\nA message that you sent could not be delivered to one or more of its\n"
5759 "recipients. This is a permanent error. The following address(es) failed:\n");
5762 "\nA message sent by\n\n <%s>\n\n"
5763 "could not be delivered to one or more of its recipients. The following\n"
5764 "address(es) failed:\n", sender_address);
5768 /* Process the addresses, leaving them on the msgchain if they have a
5769 file name for a return message. (There has already been a check in
5770 post_process_one() for the existence of data in the message file.) A TRUE
5771 return from print_address_information() means that the address is not
5775 for (address_item * addr = msgchain; addr; addr = *paddr)
5777 if (print_address_information(addr, fp, US" ", US"\n ", US""))
5778 print_address_error(addr, fp, US"");
5780 /* End the final line for the address */
5784 /* Leave on msgchain if there's a return file. */
5786 if (addr->return_file >= 0)
5788 paddr = &addr->next;
5792 /* Else save so that we can tick off the recipient when the
5797 *paddr = addr->next;
5798 addr->next = handled_addr;
5799 handled_addr = addr;
5805 /* Get the next text, whether we need it or not, so as to be
5806 positioned for the one after. */
5808 emf_text = next_emf(emf, US"generated text");
5810 /* If there were any file messages passed by the local transports,
5811 include them in the message. Then put the address on the handled chain.
5812 In the case of a batch of addresses that were all sent to the same
5813 transport, the return_file field in all of them will contain the same
5814 fd, and the return_filename field in the *last* one will be set (to the
5815 name of the file). */
5819 address_item * nextaddr;
5822 fprintf(fp, "%s", CS emf_text);
5825 "The following text was generated during the delivery "
5826 "attempt%s:\n", (filecount > 1)? "s" : "");
5828 for (address_item * addr = msgchain; addr; addr = nextaddr)
5831 address_item *topaddr = addr;
5833 /* List all the addresses that relate to this file */
5836 while(addr) /* Insurance */
5838 print_address_information(addr, fp, US"------ ", US"\n ",
5840 if (addr->return_filename) break;
5845 /* Now copy the file */
5847 if (!(fm = Ufopen(addr->return_filename, "rb")))
5848 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
5852 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
5855 Uunlink(addr->return_filename);
5857 /* Can now add to handled chain, first fishing off the next
5858 address on the msgchain. */
5860 nextaddr = addr->next;
5861 addr->next = handled_addr;
5862 handled_addr = topaddr;
5867 /* output machine readable part */
5869 if (message_smtputf8)
5870 fprintf(fp, "--%s\n"
5871 "Content-type: message/global-delivery-status\n\n"
5872 "Reporting-MTA: dns; %s\n",
5873 bound, smtp_active_hostname);
5876 fprintf(fp, "--%s\n"
5877 "Content-type: message/delivery-status\n\n"
5878 "Reporting-MTA: dns; %s\n",
5879 bound, smtp_active_hostname);
5883 /* must be decoded from xtext: see RFC 3461:6.3a */
5884 uschar * xdec_envid;
5885 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
5886 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
5888 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
5892 for (address_item * addr = handled_addr; addr; addr = addr->next)
5895 #ifdef EXPERIMENTAL_DSN_INFO
5899 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
5901 if ((hu = addr->host_used) && hu->name)
5903 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
5904 #ifdef EXPERIMENTAL_DSN_INFO
5907 uschar * p = hu->port == 25
5908 ? US"" : string_sprintf(":%d", hu->port);
5909 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
5911 if ((s = addr->smtp_greeting) && *s)
5912 dsn_put_wrapped(fp, US"X-Remote-MTA-smtp-greeting: X-str; ", s);
5913 if ((s = addr->helo_response) && *s)
5914 dsn_put_wrapped(fp, US"X-Remote-MTA-helo-response: X-str; ", s);
5915 if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5916 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5918 print_dsn_diagnostic_code(addr, fp);
5920 #ifdef EXPERIMENTAL_DSN_INFO
5921 else if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5922 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5927 /* Now copy the message, trying to give an intelligible comment if
5928 it is too long for it all to be copied. The limit isn't strictly
5929 applied because of the buffering. There is, however, an option
5930 to suppress copying altogether. */
5932 emf_text = next_emf(emf, US"copy");
5935 we ignore the intro text from template and add
5936 the text for bounce_return_size_limit at the end.
5938 bounce_return_message is ignored
5939 in case RET= is defined we honor these values
5940 otherwise bounce_return_body is honored.
5942 bounce_return_size_limit is always honored.
5945 fprintf(fp, "--%s\n", bound);
5947 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
5948 dsnnotifyhdr = NULL;
5949 topt = topt_add_return_path;
5951 /* RET=HDRS? top priority */
5952 if (dsn_ret == dsn_ret_hdrs)
5953 topt |= topt_no_body;
5956 struct stat statbuf;
5958 /* no full body return at all? */
5959 if (!bounce_return_body)
5961 topt |= topt_no_body;
5962 /* add header if we overrule RET=FULL */
5963 if (dsn_ret == dsn_ret_full)
5964 dsnnotifyhdr = dsnlimitmsg;
5966 /* line length limited... return headers only if oversize */
5967 /* size limited ... return headers only if limit reached */
5968 else if ( max_received_linelength > bounce_return_linesize_limit
5969 || ( bounce_return_size_limit > 0
5970 && fstat(deliver_datafile, &statbuf) == 0
5971 && statbuf.st_size > max
5974 topt |= topt_no_body;
5975 dsnnotifyhdr = dsnlimitmsg;
5980 if (message_smtputf8)
5981 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
5982 : "Content-type: message/global\n\n",
5986 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
5987 : "Content-type: message/rfc822\n\n",
5991 transport_filter_argv = NULL; /* Just in case */
5992 return_path = sender_address; /* In case not previously set */
5993 { /* Dummy transport for headers add */
5994 transport_ctx tctx = {{0}};
5995 transport_instance tb = {0};
5997 tctx.u.fd = fileno(fp);
5999 tctx.options = topt | topt_truncate_headers;
6000 tb.add_headers = dsnnotifyhdr;
6002 /*XXX no checking for failure! buggy! */
6003 transport_write_message(&tctx, 0);
6007 /* we never add the final text. close the file */
6011 fprintf(fp, "\n--%s--\n", bound);
6013 /* Close the file, which should send an EOF to the child process
6014 that is receiving the message. Wait for it to finish. */
6017 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6019 /* If the process failed, there was some disaster in setting up the
6020 error message. Unless the message is very old, ensure that addr_defer
6021 is non-null, which will have the effect of leaving the message on the
6022 spool. The failed addresses will get tried again next time. However, we
6023 don't really want this to happen too often, so freeze the message unless
6024 there are some genuine deferred addresses to try. To do this we have
6025 to call spool_write_header() here, because with no genuine deferred
6026 addresses the normal code below doesn't get run. */
6031 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
6033 addr_defer = (address_item *)(+1);
6034 f.deliver_freeze = TRUE;
6035 deliver_frozen_at = time(NULL);
6036 /* Panic-dies on error */
6037 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6040 deliver_msglog("Process failed (%d) when writing error message "
6041 "to %s%s", rc, bounce_recipient, s);
6042 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6043 "to %s%s", rc, bounce_recipient, s);
6046 /* The message succeeded. Ensure that the recipients that failed are
6047 now marked finished with on the spool and their parents updated. */
6051 for (address_item * addr = handled_addr; addr; addr = addr->next)
6053 address_done(addr, logtod);
6054 child_done(addr, logtod);
6056 /* Panic-dies on error */
6057 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6062 /*************************************************
6063 * Send a warning message *
6064 *************************************************/
6065 /* Return: boolean success */
6068 send_warning_message(const uschar * recipients, int queue_time, int show_time)
6071 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
6072 FILE * wmf = NULL, * f = fdopen(fd, "wb");
6073 uschar * wmf_text, * bound;
6074 transport_ctx tctx = {{0}};
6077 if (pid <= 0) return FALSE;
6079 GET_OPTION("warn_message_file");
6080 if (warn_message_file)
6081 wmf = expand_open(warn_message_file,
6082 US"warn_message_file", US"warning");
6084 warnmsg_recipients = recipients;
6085 warnmsg_delay = queue_time < 120*60
6086 ? string_sprintf("%d minutes", show_time/60)
6087 : string_sprintf("%d hours", show_time/3600);
6089 if (errors_reply_to)
6090 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6091 fprintf(f, "Auto-Submitted: auto-replied\n");
6093 fprintf(f, "To: %s\n", recipients);
6094 moan_write_references(f, NULL);
6096 /* generated boundary string and output MIME-Headers */
6097 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6099 fprintf(f, "Content-Type: multipart/report;"
6100 " report-type=delivery-status; boundary=%s\n"
6101 "MIME-Version: 1.0\n",
6104 if ((wmf_text = next_emf(wmf, US"header")))
6105 fprintf(f, "%s\n", wmf_text);
6107 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6108 message_id, warnmsg_delay);
6110 /* output human readable part as text/plain section */
6112 "Content-type: text/plain; charset=us-ascii\n\n",
6115 if ((wmf_text = next_emf(wmf, US"intro")))
6116 fprintf(f, "%s", CS wmf_text);
6120 "This message was created automatically by mail delivery software.\n");
6122 if (Ustrcmp(recipients, sender_address) == 0)
6124 "A message that you sent has not yet been delivered to one or more of its\n"
6125 "recipients after more than ");
6129 "A message sent by\n\n <%s>\n\n"
6130 "has not yet been delivered to one or more of its recipients after more than \n",
6133 fprintf(f, "%s on the queue on %s.\n\n"
6134 "The message identifier is: %s\n",
6135 warnmsg_delay, primary_hostname, message_id);
6137 for (header_line * h = header_list; h; h = h->next)
6138 if (strncmpic(h->text, US"Subject:", 8) == 0)
6139 fprintf(f, "The subject of the message is: %s", h->text + 9);
6140 else if (strncmpic(h->text, US"Date:", 5) == 0)
6141 fprintf(f, "The date of the message is: %s", h->text + 6);
6144 fprintf(f, "The address%s to which the message has not yet been "
6146 !addr_defer->next ? "" : "es",
6147 !addr_defer->next ? "is": "are");
6150 /* List the addresses, with error information if allowed */
6153 for (address_item * addr = addr_defer; addr; addr = addr->next)
6155 if (print_address_information(addr, f, US" ", US"\n ", US""))
6156 print_address_error(addr, f, US"Delay reason: ");
6165 if ((wmf_text = next_emf(wmf, US"final")))
6166 fprintf(f, "%s", CS wmf_text);
6172 "No action is required on your part. Delivery attempts will continue for\n"
6173 "some time, and this warning may be repeated at intervals if the message\n"
6174 "remains undelivered. Eventually the mail delivery software will give up,\n"
6175 "and when that happens, the message will be returned to you.\n");
6178 /* output machine readable part */
6179 fprintf(f, "\n--%s\n"
6180 "Content-type: message/delivery-status\n\n"
6181 "Reporting-MTA: dns; %s\n",
6183 smtp_active_hostname);
6188 /* must be decoded from xtext: see RFC 3461:6.3a */
6190 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6191 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6193 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6197 for (address_item * addr = addr_defer; addr; addr = addr->next)
6201 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
6203 if ((hu = addr->host_used) && hu->name)
6205 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
6206 print_dsn_diagnostic_code(addr, f);
6212 "Content-type: text/rfc822-headers\n\n",
6216 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6217 tctx.u.fd = fileno(f);
6218 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6219 transport_filter_argv = NULL; /* Just in case */
6220 return_path = sender_address; /* In case not previously set */
6222 /* Write the original email out */
6223 /*XXX no checking for failure! buggy! */
6224 transport_write_message(&tctx, 0);
6227 fprintf(f,"\n--%s--\n", bound);
6231 /* Close and wait for child process to complete, without a timeout.
6232 If there's an error, don't update the count. */
6235 return child_close(pid, 0) == 0;
6238 /*************************************************
6239 * Send a success-DSN *
6240 *************************************************/
6243 maybe_send_dsn(const address_item * const addr_succeed)
6245 address_item * addr_senddsn = NULL;
6247 for (const address_item * a = addr_succeed; a; a = a->next)
6249 /* af_ignore_error not honored here. it's not an error */
6250 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
6251 "DSN: processing successful delivery address: %s\n"
6252 "DSN: Sender_address: %s\n"
6253 "DSN: orcpt: %s flags: 0x%x\n"
6254 "DSN: envid: %s ret: %d\n"
6255 "DSN: Final recipient: %s\n"
6256 "DSN: Remote SMTP server supports DSN: %d\n",
6257 a->router ? a->router->name : US"(unknown)",
6260 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
6262 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
6267 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6268 and a report was requested */
6270 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
6271 && a->dsn_flags & rf_notify_success
6274 /* copy and relink address_item and send report with all of them at once later */
6275 address_item * addr_next = addr_senddsn;
6276 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
6278 addr_senddsn->next = addr_next;
6281 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6285 { /* create exim process to send message */
6287 pid_t pid = child_open_exim(&fd, US"DSN");
6289 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6291 if (pid < 0) /* Creation of child failed */
6293 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6294 "create child process to send success-dsn message: %s", getpid(),
6295 getppid(), strerror(errno));
6297 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6299 else /* Creation of child succeeded */
6301 FILE * f = fdopen(fd, "wb");
6302 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6304 transport_ctx tctx = {{0}};
6307 debug_printf("sending success-dsn to: %s\n", sender_address);
6309 /* build unique id for MIME boundary */
6310 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6311 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6313 if (errors_reply_to)
6314 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6317 fprintf(f, "Auto-Submitted: auto-generated\n"
6319 "Subject: Delivery Status Notification\n",
6321 moan_write_references(f, NULL);
6322 fprintf(f, "Content-Type: multipart/report;"
6323 " report-type=delivery-status; boundary=%s\n"
6324 "MIME-Version: 1.0\n\n"
6327 "Content-type: text/plain; charset=us-ascii\n\n"
6329 "This message was created automatically by mail delivery software.\n"
6330 " ----- The following addresses had successful delivery notifications -----\n",
6333 for (address_item * a = addr_senddsn; a; a = a->next)
6334 fprintf(f, "<%s> (relayed %s)\n\n",
6336 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
6337 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
6338 : "via non \"Remote SMTP\" router"
6342 "Content-type: message/delivery-status\n\n"
6343 "Reporting-MTA: dns; %s\n",
6344 bound, smtp_active_hostname);
6347 { /* must be decoded from xtext: see RFC 3461:6.3a */
6348 uschar * xdec_envid;
6349 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6350 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6352 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6356 for (address_item * a = addr_senddsn; a; a = a->next)
6360 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
6362 if ((hu = a->host_used) && hu->name)
6363 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6366 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6367 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
6370 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6373 transport_filter_argv = NULL; /* Just in case */
6374 return_path = sender_address; /* In case not previously set */
6376 /* Write the original email out */
6379 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6380 /*XXX hmm, FALSE(fail) retval ignored.
6381 Could error for any number of reasons, and they are not handled. */
6382 transport_write_message(&tctx, 0);
6385 fprintf(f,"\n--%s--\n", bound);
6389 (void) child_close(pid, 0); /* Waits for child to close, no timeout */
6394 /*************************************************
6395 * Deliver one message *
6396 *************************************************/
6398 /* This is the function which is called when a message is to be delivered. It
6399 is passed the id of the message. It is possible that the message no longer
6400 exists, if some other process has delivered it, and it is also possible that
6401 the message is being worked on by another process, in which case the data file
6404 If no delivery is attempted for any of the above reasons, the function returns
6405 DELIVER_NOT_ATTEMPTED.
6407 If the give_up flag is set true, do not attempt any deliveries, but instead
6408 fail all outstanding addresses and return the message to the sender (or
6411 A delivery operation has a process all to itself; we never deliver more than
6412 one message in the same process. Therefore we needn't worry too much about
6415 Liable to be called as root.
6418 id the id of the message to be delivered
6419 forced TRUE if delivery was forced by an administrator; this overrides
6420 retry delays and causes a delivery to be tried regardless
6421 give_up TRUE if an administrator has requested that delivery attempts
6424 Returns: When the global variable mua_wrapper is FALSE:
6425 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
6426 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
6427 When the global variable mua_wrapper is TRUE:
6428 DELIVER_MUA_SUCCEEDED if delivery succeeded
6429 DELIVER_MUA_FAILED if delivery failed
6430 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
6434 deliver_message(const uschar * id, BOOL forced, BOOL give_up)
6437 int final_yield = DELIVER_ATTEMPTED_NORMAL;
6438 time_t now = time(NULL);
6439 address_item *addr_last = NULL;
6440 uschar *filter_message = NULL;
6441 int process_recipients = RECIP_ACCEPT;
6444 extern int acl_where;
6447 #ifdef MEASURE_TIMING
6448 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
6451 info = queue_run_pid == (pid_t)0
6452 ? string_sprintf("delivering %s", id)
6453 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
6455 /* If the D_process_info bit is on, set_process_info() will output debugging
6456 information. If not, we want to show this initial information if D_deliver or
6457 D_queue_run is set or in verbose mode. */
6459 set_process_info("%s", info);
6461 if ( !(debug_selector & D_process_info)
6462 && (debug_selector & (D_deliver|D_queue_run|D_v))
6464 debug_printf("%s\n", info);
6466 /* Ensure that we catch any subprocesses that are created. Although Exim
6467 sets SIG_DFL as its initial default, some routes through the code end up
6468 here with it set to SIG_IGN - cases where a non-synchronous delivery process
6469 has been forked, but no re-exec has been done. We use sigaction rather than
6470 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
6471 sure it is turned off. (There was a problem on AIX with this.) */
6475 struct sigaction act;
6476 act.sa_handler = SIG_DFL;
6477 sigemptyset(&(act.sa_mask));
6479 sigaction(SIGCHLD, &act, NULL);
6482 signal(SIGCHLD, SIG_DFL);
6485 /* Make the forcing flag available for routers and transports, set up the
6486 global message id field, and initialize the count for returned files and the
6487 message size. This use of strcpy() is OK because the length id is checked when
6488 it is obtained from a command line (the -M or -q options), and otherwise it is
6489 known to be a valid message id. */
6491 if (id != message_id)
6492 Ustrcpy(message_id, id);
6493 f.deliver_force = forced;
6497 /* Initialize some flags */
6499 update_spool = FALSE;
6500 remove_journal = TRUE;
6502 /* Set a known context for any ACLs we call via expansions */
6503 acl_where = ACL_WHERE_DELIVERY;
6505 /* Reset the random number generator, so that if several delivery processes are
6506 started from a queue runner that has already used random numbers (for sorting),
6507 they don't all get the same sequence. */
6511 /* Open and lock the message's data file. Exim locks on this one because the
6512 header file may get replaced as it is re-written during the delivery process.
6513 Any failures cause messages to be written to the log, except for missing files
6514 while queue running - another process probably completed delivery. As part of
6515 opening the data file, message_subdir gets set. */
6517 if ((deliver_datafile = spool_open_datafile(id)) < 0)
6518 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6520 /* tHe value of message_size at this point has been set to the data length,
6521 plus one for the blank line that notionally precedes the data. */
6523 /* Now read the contents of the header file, which will set up the headers in
6524 store, and also the list of recipients and the tree of non-recipients and
6525 assorted flags. It updates message_size. If there is a reading or format error,
6526 give up; if the message has been around for sufficiently long, remove it. */
6529 uschar * spoolname = string_sprintf("%s-H", id);
6530 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
6532 if (errno == ERRNO_SPOOLFORMAT)
6534 struct stat statbuf;
6535 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
6537 log_write(0, LOG_MAIN, "Format error in spool file %s: "
6538 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
6540 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
6543 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
6546 /* If we managed to read the envelope data, received_time contains the
6547 time the message was received. Otherwise, we can calculate it from the
6550 if (rc != spool_read_hdrerror)
6552 received_time.tv_sec = received_time.tv_usec = 0;
6553 /*III subsec precision?*/
6554 for (i = 0; i < MESSAGE_ID_TIME_LEN; i++)
6555 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
6558 /* If we've had this malformed message too long, sling it. */
6560 if (now - received_time.tv_sec > keep_malformed)
6562 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
6563 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
6564 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
6565 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
6566 log_write(0, LOG_MAIN, "Message removed because older than %s",
6567 readconf_printtime(keep_malformed));
6570 (void)close(deliver_datafile);
6571 deliver_datafile = -1;
6572 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6576 /* The spool header file has been read. Look to see if there is an existing
6577 journal file for this message. If there is, it means that a previous delivery
6578 attempt crashed (program or host) before it could update the spool header file.
6579 Read the list of delivered addresses from the journal and add them to the
6580 nonrecipients tree. Then update the spool file. We can leave the journal in
6581 existence, as it will get further successful deliveries added to it in this
6582 run, and it will be deleted if this function gets to its end successfully.
6583 Otherwise it might be needed again. */
6586 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6589 if ( (journal_fd = Uopen(fname,
6590 O_RDWR|O_APPEND | EXIM_CLOEXEC | EXIM_NOFOLLOW, SPOOL_MODE)) >= 0
6591 && lseek(journal_fd, 0, SEEK_SET) == 0
6592 && (jread = fdopen(journal_fd, "rb"))
6595 while (Ufgets(big_buffer, big_buffer_size, jread))
6597 int n = Ustrlen(big_buffer);
6598 big_buffer[n-1] = 0;
6599 tree_add_nonrecipient(big_buffer);
6600 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
6601 "journal file\n", big_buffer);
6604 if ((journal_fd = dup(fileno(jread))) < 0)
6605 journal_fd = fileno(jread);
6607 (void) fclose(jread); /* Try to not leak the FILE resource */
6609 /* Panic-dies on error */
6610 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6612 else if (errno != ENOENT)
6614 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
6615 "%s", strerror(errno));
6616 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6619 /* A null recipients list indicates some kind of disaster. */
6621 if (!recipients_list)
6623 (void)close(deliver_datafile);
6624 deliver_datafile = -1;
6625 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
6626 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6631 /* Handle a message that is frozen. There are a number of different things that
6632 can happen, but in the default situation, unless forced, no delivery is
6635 if (f.deliver_freeze)
6637 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6638 /* Moving to another directory removes the message from Exim's view. Other
6639 tools must be used to deal with it. Logging of this action happens in
6640 spool_move_message() and its subfunctions. */
6642 if ( move_frozen_messages
6643 && spool_move_message(id, message_subdir, US"", US"F")
6645 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6648 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
6649 maximum time to keep messages that are frozen. Thaw if we reach it, with a
6650 flag causing all recipients to be failed. The time is the age of the
6651 message, not the time since freezing. */
6653 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
6655 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
6656 process_recipients = RECIP_FAIL_TIMEOUT;
6659 /* For bounce messages (and others with no sender), thaw if the error message
6660 ignore timer is exceeded. The message will be discarded if this delivery
6663 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
6664 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
6666 /* If this is a bounce message, or there's no auto thaw, or we haven't
6667 reached the auto thaw time yet, and this delivery is not forced by an admin
6668 user, do not attempt delivery of this message. Note that forced is set for
6669 continuing messages down the same channel, in order to skip load checking and
6670 ignore hold domains, but we don't want unfreezing in that case. */
6674 if ( ( sender_address[0] == 0
6676 || now <= deliver_frozen_at + auto_thaw
6678 && ( !forced || !f.deliver_force_thaw
6679 || !f.admin_user || continue_hostname
6682 (void)close(deliver_datafile);
6683 deliver_datafile = -1;
6684 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
6685 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6688 /* If delivery was forced (by an admin user), assume a manual thaw.
6689 Otherwise it's an auto thaw. */
6693 f.deliver_manual_thaw = TRUE;
6694 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
6696 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
6699 /* We get here if any of the rules for unfreezing have triggered. */
6701 f.deliver_freeze = FALSE;
6702 update_spool = TRUE;
6706 /* Open the message log file if we are using them. This records details of
6707 deliveries, deferments, and failures for the benefit of the mail administrator.
6708 The log is not used by exim itself to track the progress of a message; that is
6709 done by rewriting the header spool file. */
6713 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
6717 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
6719 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
6720 fname, strerror(errno));
6721 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6724 /* Make a stdio stream out of it. */
6726 if (!(message_log = fdopen(fd, "a")))
6728 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
6729 fname, strerror(errno));
6730 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6735 /* If asked to give up on a message, log who did it, and set the action for all
6740 struct passwd *pw = getpwuid(real_uid);
6741 log_write(0, LOG_MAIN, "cancelled by %s",
6742 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
6743 process_recipients = RECIP_FAIL;
6746 /* Otherwise, if there are too many Received: headers, fail all recipients. */
6748 else if (received_count > received_headers_max)
6749 process_recipients = RECIP_FAIL_LOOP;
6751 /* Otherwise, if a system-wide, address-independent message filter is
6752 specified, run it now, except in the case when we are failing all recipients as
6753 a result of timeout_frozen_after. If the system filter yields "delivered", then
6754 ignore the true recipients of the message. Failure of the filter file is
6755 logged, and the delivery attempt fails. */
6757 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
6762 redirect_block redirect;
6764 if (system_filter_uid_set)
6766 ugid.uid = system_filter_uid;
6767 ugid.gid = system_filter_gid;
6768 ugid.uid_set = ugid.gid_set = TRUE;
6771 ugid.uid_set = ugid.gid_set = FALSE;
6773 return_path = sender_address;
6774 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
6775 f.system_filtering = TRUE;
6777 /* Any error in the filter file causes a delivery to be abandoned. */
6779 GET_OPTION("system_filter");
6780 redirect.string = system_filter;
6781 redirect.isfile = TRUE;
6782 redirect.check_owner = redirect.check_group = FALSE;
6783 redirect.owners = NULL;
6784 redirect.owngroups = NULL;
6786 redirect.modemask = 0;
6788 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
6791 &redirect, /* Where the data is */
6792 RDO_DEFER | /* Turn on all the enabling options */
6793 RDO_FAIL | /* Leave off all the disabling options */
6798 NULL, /* No :include: restriction (not used in filter) */
6799 NULL, /* No sieve vacation directory (not sieve!) */
6800 NULL, /* No sieve enotify mailto owner (not sieve!) */
6801 NULL, /* No sieve user address (not sieve!) */
6802 NULL, /* No sieve subaddress (not sieve!) */
6803 &ugid, /* uid/gid data */
6804 &addr_new, /* Where to hang generated addresses */
6805 &filter_message, /* Where to put error message */
6806 NULL, /* Don't skip syntax errors */
6807 &filtertype, /* Will always be set to FILTER_EXIM for this call */
6808 US"system filter"); /* For error messages */
6810 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
6812 if (rc == FF_ERROR || rc == FF_NONEXIST)
6814 (void)close(deliver_datafile);
6815 deliver_datafile = -1;
6816 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
6817 string_printing(filter_message));
6818 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6821 /* Reset things. If the filter message is an empty string, which can happen
6822 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
6824 f.system_filtering = FALSE;
6825 f.enable_dollar_recipients = FALSE;
6826 if (filter_message && filter_message[0] == 0) filter_message = NULL;
6828 /* Save the values of the system filter variables so that user filters
6831 memcpy(filter_sn, filter_n, sizeof(filter_sn));
6833 /* The filter can request that delivery of the original addresses be
6838 process_recipients = RECIP_DEFER;
6839 deliver_msglog("Delivery deferred by system filter\n");
6840 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6843 /* The filter can request that a message be frozen, but this does not
6844 take place if the message has been manually thawed. In that case, we must
6845 unset "delivered", which is forced by the "freeze" command to make -bF
6848 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6850 f.deliver_freeze = TRUE;
6851 deliver_frozen_at = time(NULL);
6852 process_recipients = RECIP_DEFER;
6853 frozen_info = string_sprintf(" by the system filter%s%s",
6854 filter_message ? US": " : US"",
6855 filter_message ? filter_message : US"");
6858 /* The filter can request that a message be failed. The error message may be
6859 quite long - it is sent back to the sender in the bounce - but we don't want
6860 to fill up the log with repetitions of it. If it starts with << then the text
6861 between << and >> is written to the log, with the rest left for the bounce
6864 else if (rc == FF_FAIL)
6866 uschar *colon = US"";
6867 uschar *logmsg = US"";
6870 process_recipients = RECIP_FAIL_FILTER;
6876 if ( filter_message[0] == '<'
6877 && filter_message[1] == '<'
6878 && (logend = Ustrstr(filter_message, ">>"))
6881 logmsg = filter_message + 2;
6882 loglen = logend - logmsg;
6883 filter_message = logend + 2;
6884 if (filter_message[0] == 0) filter_message = NULL;
6888 logmsg = filter_message;
6889 loglen = Ustrlen(filter_message);
6893 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6897 /* Delivery can be restricted only to those recipients (if any) that the
6898 filter specified. */
6900 else if (rc == FF_DELIVERED)
6902 process_recipients = RECIP_IGNORE;
6904 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6906 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6909 /* If any new addresses were created by the filter, fake up a "parent"
6910 for them. This is necessary for pipes, etc., which are expected to have
6911 parents, and it also gives some sensible logging for others. Allow
6912 pipes, files, and autoreplies, and run them as the filter uid if set,
6913 otherwise as the current uid. */
6917 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6918 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6920 /* The text "system-filter" is tested in transport_set_up_command() and in
6921 set_up_shell_command() in the pipe transport, to enable them to permit
6922 $recipients, so don't change it here without also changing it there. */
6924 address_item *p = addr_new;
6925 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6927 parent->domain = string_copylc(qualify_domain_recipient);
6928 parent->local_part = US"system-filter";
6930 /* As part of this loop, we arrange for addr_last to end up pointing
6931 at the final address. This is used if we go on to add addresses for the
6932 original recipients. */
6936 if (parent->child_count == USHRT_MAX)
6937 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6938 "than %d delivery addresses", USHRT_MAX);
6939 parent->child_count++;
6942 if (testflag(p, af_pfr))
6948 setflag(p, af_uid_set);
6949 setflag(p, af_gid_set);
6950 setflag(p, af_allow_file);
6951 setflag(p, af_allow_pipe);
6952 setflag(p, af_allow_reply);
6954 /* Find the name of the system filter's appropriate pfr transport */
6956 if (p->address[0] == '|')
6959 GET_OPTION("system_filter_pipe_transport");
6960 tpname = system_filter_pipe_transport;
6961 address_pipe = p->address;
6963 else if (p->address[0] == '>')
6966 GET_OPTION("system_filter_reply_transport");
6967 tpname = system_filter_reply_transport;
6971 if (p->address[Ustrlen(p->address)-1] == '/')
6973 type = US"directory";
6974 GET_OPTION("system_filter_directory_transport");
6975 tpname = system_filter_directory_transport;
6980 GET_OPTION("system_filter_file_transport");
6981 tpname = system_filter_file_transport;
6983 address_file = p->address;
6986 /* Now find the actual transport, first expanding the name. We have
6987 set address_file or address_pipe above. */
6991 uschar *tmp = expand_string(tpname);
6992 address_file = address_pipe = NULL;
6994 p->message = string_sprintf("failed to expand \"%s\" as a "
6995 "system filter transport name", tpname);
6996 if (is_tainted(tmp))
6997 p->message = string_sprintf("attempt to used tainted value '%s' for"
6998 "transport '%s' as a system filter", tmp, tpname);
7002 p->message = string_sprintf("system_filter_%s_transport is unset",
7007 transport_instance *tp;
7008 for (tp = transports; tp; tp = tp->next)
7009 if (Ustrcmp(tp->name, tpname) == 0)
7015 p->message = string_sprintf("failed to find \"%s\" transport "
7016 "for system filter delivery", tpname);
7019 /* If we couldn't set up a transport, defer the delivery, putting the
7020 error on the panic log as well as the main log. */
7024 address_item * badp = p;
7026 if (!addr_last) addr_new = p; else addr_last->next = p;
7027 badp->local_part = badp->address; /* Needed for log line */
7028 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
7031 } /* End of pfr handling */
7033 /* Either a non-pfr delivery, or we found a transport */
7035 DEBUG(D_deliver|D_filter)
7036 debug_printf("system filter added %s\n", p->address);
7040 } /* Loop through all addr_new addresses */
7045 /* Scan the recipients list, and for every one that is not in the non-
7046 recipients tree, add an addr item to the chain of new addresses. If the pno
7047 value is non-negative, we must set the onetime parent from it. This which
7048 points to the relevant entry in the recipients list.
7050 This processing can be altered by the setting of the process_recipients
7051 variable, which is changed if recipients are to be ignored, failed, or
7052 deferred. This can happen as a result of system filter activity, or if the -Mg
7053 option is used to fail all of them.
7055 Duplicate addresses are handled later by a different tree structure; we can't
7056 just extend the non-recipients tree, because that will be re-written to the
7057 spool if the message is deferred, and in any case there are casing
7058 complications for local addresses. */
7060 if (process_recipients != RECIP_IGNORE)
7061 for (i = 0; i < recipients_count; i++)
7062 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
7064 recipient_item * r = recipients_list + i;
7065 address_item * new = deliver_make_addr(r->address, FALSE);
7067 new->prop.errors_address = r->errors_to;
7069 if ((new->prop.utf8_msg = message_smtputf8))
7071 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
7072 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
7073 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
7074 new->prop.utf8_downcvt ? "yes"
7075 : new->prop.utf8_downcvt_maybe ? "ifneeded"
7081 new->onetime_parent = recipients_list[r->pno].address;
7083 /* If DSN support is enabled, set the dsn flags and the original receipt
7084 to be passed on to other DSN enabled MTAs */
7086 new->dsn_flags = r->dsn_flags & rf_dsnflags;
7087 new->dsn_orcpt = r->orcpt;
7088 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
7089 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
7091 switch (process_recipients)
7093 /* RECIP_DEFER is set when a system filter freezes a message. */
7096 new->next = addr_defer;
7101 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
7104 case RECIP_FAIL_FILTER:
7106 filter_message ? filter_message : US"delivery cancelled";
7107 setflag(new, af_pass_message);
7108 goto RECIP_QUEUE_FAILED; /* below */
7111 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
7112 than the value in timeout_frozen_after. Treat non-bounce messages
7113 similarly to -Mg; for bounce messages we just want to discard, so
7114 don't put the address on the failed list. The timeout has already
7117 case RECIP_FAIL_TIMEOUT:
7118 new->message = US"delivery cancelled; message timed out";
7119 goto RECIP_QUEUE_FAILED; /* below */
7122 /* RECIP_FAIL is set when -Mg has been used. */
7125 new->message = US"delivery cancelled by administrator";
7126 /* not setting af_pass_message here means that will not
7127 appear in the bounce message */
7130 /* Common code for the failure cases above. If this is not a bounce
7131 message, put the address on the failed list so that it is used to
7132 create a bounce. Otherwise do nothing - this just discards the address.
7133 The incident has already been logged. */
7136 if (*sender_address)
7138 new->next = addr_failed;
7144 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
7145 in the message. Process each address as a routing failure; if this
7146 is a bounce message, it will get frozen. */
7148 case RECIP_FAIL_LOOP:
7149 new->message = US"Too many \"Received\" headers - suspected mail loop";
7150 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7154 /* Value should be RECIP_ACCEPT; take this as the safe default. */
7157 if (!addr_new) addr_new = new; else addr_last->next = new;
7162 #ifndef DISABLE_EVENT
7163 if (process_recipients != RECIP_ACCEPT && event_action)
7165 const uschar * save_local = deliver_localpart;
7166 const uschar * save_domain = deliver_domain;
7167 const uschar * addr = new->address;
7168 uschar * errmsg = NULL;
7169 int start, end, dom;
7171 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
7172 log_write(0, LOG_MAIN|LOG_PANIC,
7173 "failed to parse address '%.100s': %s\n", addr, errmsg);
7177 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
7178 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
7180 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
7182 deliver_localpart = save_local;
7183 deliver_domain = save_domain;
7191 debug_printf("Delivery address list:\n");
7192 for (address_item * p = addr_new; p; p = p->next)
7193 debug_printf(" %s %s\n", p->address,
7194 p->onetime_parent ? p->onetime_parent : US"");
7197 /* Set up the buffers used for copying over the file when delivering. */
7199 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
7200 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
7204 /* Until there are no more new addresses, handle each one as follows:
7206 . If this is a generated address (indicated by the presence of a parent
7207 pointer) then check to see whether it is a pipe, file, or autoreply, and
7208 if so, handle it directly here. The router that produced the address will
7209 have set the allow flags into the address, and also set the uid/gid required.
7210 Having the routers generate new addresses and then checking them here at
7211 the outer level is tidier than making each router do the checking, and
7212 means that routers don't need access to the failed address queue.
7214 . Break up the address into local part and domain, and make lowercased
7215 versions of these strings. We also make unquoted versions of the local part.
7217 . Handle the percent hack for those domains for which it is valid.
7219 . For child addresses, determine if any of the parents have the same address.
7220 If so, generate a different string for previous delivery checking. Without
7221 this code, if the address spqr generates spqr via a forward or alias file,
7222 delivery of the generated spqr stops further attempts at the top level spqr,
7223 which is not what is wanted - it may have generated other addresses.
7225 . Check on the retry database to see if routing was previously deferred, but
7226 only if in a queue run. Addresses that are to be routed are put on the
7227 addr_route chain. Addresses that are to be deferred are put on the
7228 addr_defer chain. We do all the checking first, so as not to keep the
7229 retry database open any longer than necessary.
7231 . Now we run the addresses through the routers. A router may put the address
7232 on either the addr_local or the addr_remote chain for local or remote
7233 delivery, respectively, or put it on the addr_failed chain if it is
7234 undeliveable, or it may generate child addresses and put them on the
7235 addr_new chain, or it may defer an address. All the chain anchors are
7236 passed as arguments so that the routers can be called for verification
7239 . If new addresses have been generated by the routers, da capo.
7242 f.header_rewritten = FALSE; /* No headers rewritten yet */
7243 while (addr_new) /* Loop until all addresses dealt with */
7245 address_item * addr, * parent;
7247 /* Failure to open the retry database is treated the same as if it does
7248 not exist. In both cases, dbm_file is NULL. */
7250 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
7251 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
7252 debug_printf("no retry data available\n");
7254 /* Scan the current batch of new addresses, to handle pipes, files and
7255 autoreplies, and determine which others are ready for routing. */
7261 dbdata_retry * domain_retry_record, * address_retry_record;
7264 addr_new = addr->next;
7266 DEBUG(D_deliver|D_retry|D_route)
7268 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7269 debug_printf("Considering: %s\n", addr->address);
7272 /* Handle generated address that is a pipe or a file or an autoreply. */
7274 if (testflag(addr, af_pfr))
7276 /* If an autoreply in a filter could not generate a syntactically valid
7277 address, give up forthwith. Set af_ignore_error so that we don't try to
7278 generate a bounce. */
7280 if (testflag(addr, af_bad_reply))
7282 addr->basic_errno = ERRNO_BADADDRESS2;
7283 addr->local_part = addr->address;
7285 US"filter autoreply generated syntactically invalid recipient";
7286 addr->prop.ignore_error = TRUE;
7287 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7288 continue; /* with the next new address */
7291 /* If two different users specify delivery to the same pipe or file or
7292 autoreply, there should be two different deliveries, so build a unique
7293 string that incorporates the original address, and use this for
7294 duplicate testing and recording delivery, and also for retrying. */
7297 string_sprintf("%s:%s", addr->address, addr->parent->unique +
7298 (testflag(addr->parent, af_homonym) ? 3:0));
7300 addr->address_retry_key = addr->domain_retry_key =
7301 string_sprintf("T:%s", addr->unique);
7303 /* If a filter file specifies two deliveries to the same pipe or file,
7304 we want to de-duplicate, but this is probably not wanted for two mail
7305 commands to the same address, where probably both should be delivered.
7306 So, we have to invent a different unique string in that case. Just
7307 keep piling '>' characters on the front. */
7309 if (addr->address[0] == '>')
7310 while (tree_search(tree_duplicates, addr->unique))
7311 addr->unique = string_sprintf(">%s", addr->unique);
7313 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
7315 DEBUG(D_deliver|D_route)
7316 debug_printf("%s is a duplicate address: discarded\n", addr->address);
7317 addr->dupof = tnode->data.ptr;
7318 addr->next = addr_duplicate;
7319 addr_duplicate = addr;
7323 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7325 /* Check for previous delivery */
7327 if (tree_search(tree_nonrecipients, addr->unique))
7329 DEBUG(D_deliver|D_route)
7330 debug_printf("%s was previously delivered: discarded\n", addr->address);
7331 child_done(addr, tod_stamp(tod_log));
7335 /* Save for checking future duplicates */
7337 tree_add_duplicate(addr->unique, addr);
7339 /* Set local part and domain */
7341 addr->local_part = addr->address;
7342 addr->domain = addr->parent->domain;
7344 /* Ensure that the delivery is permitted. */
7346 if (testflag(addr, af_file))
7348 if (!testflag(addr, af_allow_file))
7350 addr->basic_errno = ERRNO_FORBIDFILE;
7351 addr->message = US"delivery to file forbidden";
7352 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7353 continue; /* with the next new address */
7356 else if (addr->address[0] == '|')
7358 if (!testflag(addr, af_allow_pipe))
7360 addr->basic_errno = ERRNO_FORBIDPIPE;
7361 addr->message = US"delivery to pipe forbidden";
7362 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7363 continue; /* with the next new address */
7366 else if (!testflag(addr, af_allow_reply))
7368 addr->basic_errno = ERRNO_FORBIDREPLY;
7369 addr->message = US"autoreply forbidden";
7370 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7371 continue; /* with the next new address */
7374 /* If the errno field is already set to BADTRANSPORT, it indicates
7375 failure to expand a transport string, or find the associated transport,
7376 or an unset transport when one is required. Leave this test till now so
7377 that the forbid errors are given in preference. */
7379 if (addr->basic_errno == ERRNO_BADTRANSPORT)
7381 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7385 /* Treat /dev/null as a special case and abandon the delivery. This
7386 avoids having to specify a uid on the transport just for this case.
7387 Arrange for the transport name to be logged as "**bypassed**".
7388 Copy the transport for this fairly unusual case rather than having
7389 to make all transports mutable. */
7391 if (Ustrcmp(addr->address, "/dev/null") == 0)
7393 transport_instance * save_t = addr->transport;
7394 transport_instance * t = store_get(sizeof(*t), save_t);
7396 t->name = US"**bypassed**";
7397 addr->transport = t;
7398 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
7399 addr->transport= save_t;
7400 continue; /* with the next new address */
7403 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
7406 DEBUG(D_deliver|D_route)
7407 debug_printf("queued for %s transport\n", addr->transport->name);
7408 addr->next = addr_local;
7410 continue; /* with the next new address */
7413 /* Handle normal addresses. First, split up into local part and domain,
7414 handling the %-hack if necessary. There is the possibility of a defer from
7415 a lookup in percent_hack_domains. */
7417 if ((rc = deliver_split_address(addr)) == DEFER)
7419 addr->message = US"cannot check percent_hack_domains";
7420 addr->basic_errno = ERRNO_LISTDEFER;
7421 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7425 /* Check to see if the domain is held. If so, proceed only if the
7426 delivery was forced by hand. */
7428 deliver_domain = addr->domain; /* set $domain */
7429 if ( !forced && hold_domains
7430 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
7431 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
7437 addr->message = US"hold_domains lookup deferred";
7438 addr->basic_errno = ERRNO_LISTDEFER;
7442 addr->message = US"domain is held";
7443 addr->basic_errno = ERRNO_HELD;
7445 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7449 /* Now we can check for duplicates and previously delivered addresses. In
7450 order to do this, we have to generate a "unique" value for each address,
7451 because there may be identical actual addresses in a line of descendents.
7452 The "unique" field is initialized to the same value as the "address" field,
7453 but gets changed here to cope with identically-named descendents. */
7455 for (parent = addr->parent; parent; parent = parent->parent)
7456 if (strcmpic(addr->address, parent->address) == 0) break;
7458 /* If there's an ancestor with the same name, set the homonym flag. This
7459 influences how deliveries are recorded. Then add a prefix on the front of
7460 the unique address. We use \n\ where n starts at 0 and increases each time.
7461 It is unlikely to pass 9, but if it does, it may look odd but will still
7462 work. This means that siblings or cousins with the same names are treated
7463 as duplicates, which is what we want. */
7467 setflag(addr, af_homonym);
7468 if (parent->unique[0] != '\\')
7469 addr->unique = string_sprintf("\\0\\%s", addr->address);
7471 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
7475 /* Ensure that the domain in the unique field is lower cased, because
7476 domains are always handled caselessly. */
7478 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
7480 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7482 if (tree_search(tree_nonrecipients, addr->unique))
7484 DEBUG(D_deliver|D_route)
7485 debug_printf("%s was previously delivered: discarded\n", addr->unique);
7486 child_done(addr, tod_stamp(tod_log));
7490 /* Get the routing retry status, saving the two retry keys (with and
7491 without the local part) for subsequent use. If there is no retry record for
7492 the standard address routing retry key, we look for the same key with the
7493 sender attached, because this form is used by the smtp transport after a
7494 4xx response to RCPT when address_retry_include_sender is true. */
7496 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
7497 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
7502 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
7503 if ( domain_retry_record
7504 && now - domain_retry_record->time_stamp > retry_data_expire
7507 DEBUG(D_deliver|D_retry)
7508 debug_printf("domain retry record present but expired\n");
7509 domain_retry_record = NULL; /* Ignore if too old */
7512 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
7513 if ( address_retry_record
7514 && now - address_retry_record->time_stamp > retry_data_expire
7517 DEBUG(D_deliver|D_retry)
7518 debug_printf("address retry record present but expired\n");
7519 address_retry_record = NULL; /* Ignore if too old */
7522 if (!address_retry_record)
7524 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7526 address_retry_record = dbfn_read(dbm_file, altkey);
7527 if ( address_retry_record
7528 && now - address_retry_record->time_stamp > retry_data_expire)
7530 DEBUG(D_deliver|D_retry)
7531 debug_printf("address<sender> retry record present but expired\n");
7532 address_retry_record = NULL; /* Ignore if too old */
7537 domain_retry_record = address_retry_record = NULL;
7539 DEBUG(D_deliver|D_retry)
7541 if (!domain_retry_record)
7542 debug_printf("no domain retry record\n");
7544 debug_printf("have domain retry record; next_try = now%+d\n",
7545 f.running_in_test_harness ? 0 :
7546 (int)(domain_retry_record->next_try - now));
7548 if (!address_retry_record)
7549 debug_printf("no address retry record\n");
7551 debug_printf("have address retry record; next_try = now%+d\n",
7552 f.running_in_test_harness ? 0 :
7553 (int)(address_retry_record->next_try - now));
7556 /* If we are sending a message down an existing SMTP connection, we must
7557 assume that the message which created the connection managed to route
7558 an address to that connection. We do not want to run the risk of taking
7559 a long time over routing here, because if we do, the server at the other
7560 end of the connection may time it out. This is especially true for messages
7561 with lots of addresses. For this kind of delivery, queue_running is not
7562 set, so we would normally route all addresses. We take a pragmatic approach
7563 and defer routing any addresses that have any kind of domain retry record.
7564 That is, we don't even look at their retry times. It doesn't matter if this
7565 doesn't work occasionally. This is all just an optimization, after all.
7567 The reason for not doing the same for address retries is that they normally
7568 arise from 4xx responses, not DNS timeouts. */
7570 if (continue_hostname && domain_retry_record)
7572 addr->message = US"reusing SMTP connection skips previous routing defer";
7573 addr->basic_errno = ERRNO_RRETRY;
7574 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7576 addr->message = domain_retry_record->text;
7577 setflag(addr, af_pass_message);
7580 /* If we are in a queue run, defer routing unless there is no retry data or
7581 we've passed the next retry time, or this message is forced. In other
7582 words, ignore retry data when not in a queue run.
7584 However, if the domain retry time has expired, always allow the routing
7585 attempt. If it fails again, the address will be failed. This ensures that
7586 each address is routed at least once, even after long-term routing
7589 If there is an address retry, check that too; just wait for the next
7590 retry time. This helps with the case when the temporary error on the
7591 address was really message-specific rather than address specific, since
7592 it allows other messages through.
7594 We also wait for the next retry time if this is a message sent down an
7595 existing SMTP connection (even though that will be forced). Otherwise there
7596 will be far too many attempts for an address that gets a 4xx error. In
7597 fact, after such an error, we should not get here because, the host should
7598 not be remembered as one this message needs. However, there was a bug that
7599 used to cause this to happen, so it is best to be on the safe side.
7601 Even if we haven't reached the retry time in the hints, there is one more
7602 check to do, which is for the ultimate address timeout. We only do this
7603 check if there is an address retry record and there is not a domain retry
7604 record; this implies that previous attempts to handle the address had the
7605 retry_use_local_parts option turned on. We use this as an approximation
7606 for the destination being like a local delivery, for example delivery over
7607 LMTP to an IMAP message store. In this situation users are liable to bump
7608 into their quota and thereby have intermittently successful deliveries,
7609 which keep the retry record fresh, which can lead to us perpetually
7610 deferring messages. */
7612 else if ( ( f.queue_running && !f.deliver_force
7613 || continue_hostname
7615 && ( ( domain_retry_record
7616 && now < domain_retry_record->next_try
7617 && !domain_retry_record->expired
7619 || ( address_retry_record
7620 && now < address_retry_record->next_try
7622 && ( domain_retry_record
7623 || !address_retry_record
7624 || !retry_ultimate_address_timeout(addr->address_retry_key,
7625 addr->domain, address_retry_record, now)
7628 addr->message = US"retry time not reached";
7629 addr->basic_errno = ERRNO_RRETRY;
7630 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7632 /* For remote-retry errors (here and just above) that we've not yet
7633 hit the retry time, use the error recorded in the retry database
7634 as info in the warning message. This lets us send a message even
7635 when we're not failing on a fresh attempt. We assume that this
7636 info is not sensitive. */
7638 addr->message = domain_retry_record
7639 ? domain_retry_record->text : address_retry_record->text;
7640 setflag(addr, af_pass_message);
7643 /* The domain is OK for routing. Remember if retry data exists so it
7644 can be cleaned up after a successful delivery. */
7648 if (domain_retry_record || address_retry_record)
7649 setflag(addr, af_dr_retry_exists);
7650 addr->next = addr_route;
7652 DEBUG(D_deliver|D_route)
7653 debug_printf("%s: queued for routing\n", addr->address);
7657 /* The database is closed while routing is actually happening. Requests to
7658 update it are put on a chain and all processed together at the end. */
7660 if (dbm_file) dbfn_close(dbm_file);
7662 /* If queue_domains is set, we don't even want to try routing addresses in
7663 those domains. During queue runs, queue_domains is forced to be unset.
7664 Optimize by skipping this pass through the addresses if nothing is set. */
7666 if (!f.deliver_force && queue_domains)
7668 address_item *okaddr = NULL;
7671 address_item *addr = addr_route;
7672 addr_route = addr->next;
7674 deliver_domain = addr->domain; /* set $domain */
7675 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
7676 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
7680 addr->basic_errno = ERRNO_LISTDEFER;
7681 addr->message = US"queue_domains lookup deferred";
7682 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7686 addr->next = okaddr;
7691 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
7692 addr->message = US"domain is in queue_domains";
7693 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7697 addr_route = okaddr;
7700 /* Now route those addresses that are not deferred. */
7705 address_item *addr = addr_route;
7706 const uschar *old_domain = addr->domain;
7707 uschar *old_unique = addr->unique;
7708 addr_route = addr->next;
7711 /* Just in case some router parameter refers to it. */
7713 if (!(return_path = addr->prop.errors_address))
7714 return_path = sender_address;
7716 /* If a router defers an address, add a retry item. Whether or not to
7717 use the local part in the key is a property of the router. */
7719 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
7720 &addr_succeed, v_none)) == DEFER)
7721 retry_add_item(addr,
7722 addr->router->retry_use_local_part
7723 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
7724 : string_sprintf("R:%s", addr->domain),
7727 /* Otherwise, if there is an existing retry record in the database, add
7728 retry items to delete both forms. We must also allow for the possibility
7729 of a routing retry that includes the sender address. Since the domain might
7730 have been rewritten (expanded to fully qualified) as a result of routing,
7731 ensure that the rewritten form is also deleted. */
7733 else if (testflag(addr, af_dr_retry_exists))
7735 uschar * altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7737 retry_add_item(addr, altkey, rf_delete);
7738 retry_add_item(addr, addr->address_retry_key, rf_delete);
7739 retry_add_item(addr, addr->domain_retry_key, rf_delete);
7740 if (Ustrcmp(addr->domain, old_domain) != 0)
7741 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
7744 /* DISCARD is given for :blackhole: and "seen finish". The event has been
7745 logged, but we need to ensure the address (and maybe parents) is marked
7750 address_done(addr, tod_stamp(tod_log));
7751 continue; /* route next address */
7754 /* The address is finished with (failed or deferred). */
7758 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7759 continue; /* route next address */
7762 /* The address has been routed. If the router changed the domain, it will
7763 also have changed the unique address. We have to test whether this address
7764 has already been delivered, because it's the unique address that finally
7767 if ( addr->unique != old_unique
7768 && tree_search(tree_nonrecipients, addr->unique) != 0
7771 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
7772 "discarded\n", addr->address);
7773 if (addr_remote == addr) addr_remote = addr->next;
7774 else if (addr_local == addr) addr_local = addr->next;
7777 /* If the router has same_domain_copy_routing set, we are permitted to copy
7778 the routing for any other addresses with the same domain. This is an
7779 optimisation to save repeated DNS lookups for "standard" remote domain
7780 routing. The option is settable only on routers that generate host lists.
7781 We play it very safe, and do the optimization only if the address is routed
7782 to a remote transport, there are no header changes, and the domain was not
7783 modified by the router. */
7785 if ( addr_remote == addr
7786 && addr->router->same_domain_copy_routing
7787 && !addr->prop.extra_headers
7788 && !addr->prop.remove_headers
7789 && old_domain == addr->domain
7792 address_item **chain = &addr_route;
7795 address_item *addr2 = *chain;
7796 if (Ustrcmp(addr2->domain, addr->domain) != 0)
7798 chain = &(addr2->next);
7802 /* Found a suitable address; take it off the routing list and add it to
7803 the remote delivery list. */
7805 *chain = addr2->next;
7806 addr2->next = addr_remote;
7807 addr_remote = addr2;
7809 /* Copy the routing data */
7811 addr2->domain = addr->domain;
7812 addr2->router = addr->router;
7813 addr2->transport = addr->transport;
7814 addr2->host_list = addr->host_list;
7815 addr2->fallback_hosts = addr->fallback_hosts;
7816 addr2->prop.errors_address = addr->prop.errors_address;
7817 copyflag(addr2, addr, af_hide_child);
7818 copyflag(addr2, addr, af_local_host_removed);
7820 DEBUG(D_deliver|D_route)
7821 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
7823 "Routing for %s copied from %s\n",
7824 addr2->address, addr2->address, addr->address);
7827 } /* Continue with routing the next address. */
7828 } /* Loop to process any child addresses that the routers created, and
7829 any rerouted addresses that got put back on the new chain. */
7832 /* Debugging: show the results of the routing */
7834 DEBUG(D_deliver|D_retry|D_route)
7836 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7837 debug_printf("After routing:\n Local deliveries:\n");
7838 for (address_item * p = addr_local; p; p = p->next)
7839 debug_printf(" %s\n", p->address);
7841 debug_printf(" Remote deliveries:\n");
7842 for (address_item * p = addr_remote; p; p = p->next)
7843 debug_printf(" %s\n", p->address);
7845 debug_printf(" Failed addresses:\n");
7846 for (address_item * p = addr_failed; p; p = p->next)
7847 debug_printf(" %s\n", p->address);
7849 debug_printf(" Deferred addresses:\n");
7850 for (address_item * p = addr_defer; p; p = p->next)
7851 debug_printf(" %s\n", p->address);
7854 /* Free any resources that were cached during routing. */
7859 /* These two variables are set only during routing, after check_local_user.
7860 Ensure they are not set in transports. */
7862 local_user_gid = (gid_t)(-1);
7863 local_user_uid = (uid_t)(-1);
7865 /* Check for any duplicate addresses. This check is delayed until after
7866 routing, because the flexibility of the routing configuration means that
7867 identical addresses with different parentage may end up being redirected to
7868 different addresses. Checking for duplicates too early (as we previously used
7869 to) makes this kind of thing not work. */
7871 do_duplicate_check(&addr_local);
7872 do_duplicate_check(&addr_remote);
7874 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7875 remote transport. The check that they all end up in one transaction happens in
7876 the do_remote_deliveries() function. */
7879 && (addr_local || addr_failed || addr_defer)
7883 uschar *which, *colon, *msg;
7890 else if (addr_defer)
7893 which = US"deferred";
7901 while (addr->parent) addr = addr->parent;
7906 msg = addr->message;
7908 else colon = msg = US"";
7910 /* We don't need to log here for a forced failure as it will already
7911 have been logged. Defer will also have been logged, but as a defer, so we do
7912 need to do the failure logging. */
7914 if (addr != addr_failed)
7915 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7916 addr->address, which);
7918 /* Always write an error to the caller */
7920 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7923 final_yield = DELIVER_MUA_FAILED;
7924 addr_failed = addr_defer = NULL; /* So that we remove the message */
7925 goto DELIVERY_TIDYUP;
7929 /* If this is a run to continue deliveries to an external channel that is
7930 already set up, defer any local deliveries.
7932 jgh 2020/12/20: I don't see why; locals should be quick.
7933 The defer goes back to version 1.62 in 1997. A local being still deliverable
7934 during a continued run might result from something like a defer during the
7935 original delivery, eg. in a DB lookup. Unlikely but possible.
7937 To avoid delaying a local when combined with a callout-hold for a remote
7938 delivery, test continue_sequence rather than continue_transport. */
7940 if (continue_sequence > 1 && addr_local)
7942 DEBUG(D_deliver|D_retry|D_route)
7943 debug_printf("deferring local deliveries due to continued-transport\n");
7946 address_item * addr = addr_defer;
7947 while (addr->next) addr = addr->next;
7948 addr->next = addr_local;
7951 addr_defer = addr_local;
7956 /* Because address rewriting can happen in the routers, we should not really do
7957 ANY deliveries until all addresses have been routed, so that all recipients of
7958 the message get the same headers. However, this is in practice not always
7959 possible, since sometimes remote addresses give DNS timeouts for days on end.
7960 The pragmatic approach is to deliver what we can now, saving any rewritten
7961 headers so that at least the next lot of recipients benefit from the rewriting
7962 that has already been done.
7964 If any headers have been rewritten during routing, update the spool file to
7965 remember them for all subsequent deliveries. This can be delayed till later if
7966 there is only address to be delivered - if it succeeds the spool write need not
7969 if ( f.header_rewritten
7970 && ( addr_local && (addr_local->next || addr_remote)
7971 || addr_remote && addr_remote->next
7974 /* Panic-dies on error */
7975 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7976 f.header_rewritten = FALSE;
7980 /* If there are any deliveries to do and we do not already have the journal
7981 file, create it. This is used to record successful deliveries as soon as
7982 possible after each delivery is known to be complete. A file opened with
7983 O_APPEND is used so that several processes can run simultaneously.
7985 The journal is just insurance against crashes. When the spool file is
7986 ultimately updated at the end of processing, the journal is deleted. If a
7987 journal is found to exist at the start of delivery, the addresses listed
7988 therein are added to the non-recipients. */
7990 if (addr_local || addr_remote)
7994 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7996 if ((journal_fd = Uopen(fname,
7997 EXIM_CLOEXEC | O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7999 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
8000 fname, strerror(errno));
8001 return DELIVER_NOT_ATTEMPTED;
8004 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
8005 that the mode is correct - the group setting doesn't always seem to get
8006 set automatically. */
8008 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
8009 || fchmod(journal_fd, SPOOL_MODE)
8011 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
8015 int ret = Uunlink(fname);
8016 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
8017 fname, strerror(errno));
8018 if(ret && errno != ENOENT)
8019 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8020 fname, strerror(errno));
8021 return DELIVER_NOT_ATTEMPTED;
8025 else if (journal_fd >= 0)
8033 /* Now we can get down to the business of actually doing deliveries. Local
8034 deliveries are done first, then remote ones. If ever the problems of how to
8035 handle fallback transports are figured out, this section can be put into a loop
8036 for handling fallbacks, though the uid switching will have to be revised. */
8038 /* Precompile a regex that is used to recognize a parameter in response
8039 to an LHLO command, if is isn't already compiled. This may be used on both
8040 local and remote LMTP deliveries. */
8042 if (!regex_IGNOREQUOTA)
8044 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", MCS_NOFLAGS, TRUE);
8046 /* Handle local deliveries */
8050 DEBUG(D_deliver|D_transport)
8051 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
8052 do_local_deliveries();
8053 f.disable_logging = FALSE;
8056 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
8057 so just queue them all. */
8059 if (f.queue_run_local)
8062 address_item *addr = addr_remote;
8063 addr_remote = addr->next;
8065 addr->basic_errno = ERRNO_LOCAL_ONLY;
8066 addr->message = US"remote deliveries suppressed";
8067 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
8070 /* Handle remote deliveries */
8074 DEBUG(D_deliver|D_transport)
8075 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
8077 /* Precompile some regex that are used to recognize parameters in response
8078 to an EHLO command, if they aren't already compiled. */
8080 smtp_deliver_init();
8082 /* Now sort the addresses if required, and do the deliveries. The yield of
8083 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
8084 cannot be delivered in one transaction. */
8086 if (remote_sort_domains) sort_remote_deliveries();
8087 if (!do_remote_deliveries(FALSE))
8089 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
8090 "be delivered in one transaction");
8091 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
8093 final_yield = DELIVER_MUA_FAILED;
8094 addr_failed = addr_defer = NULL; /* So that we remove the message */
8095 goto DELIVERY_TIDYUP;
8098 /* See if any of the addresses that failed got put on the queue for delivery
8099 to their fallback hosts. We do it this way because often the same fallback
8100 host is used for many domains, so all can be sent in a single transaction
8101 (if appropriately configured). */
8103 if (addr_fallback && !mua_wrapper)
8105 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
8106 addr_remote = addr_fallback;
8107 addr_fallback = NULL;
8108 if (remote_sort_domains) sort_remote_deliveries();
8109 do_remote_deliveries(TRUE);
8111 f.disable_logging = FALSE;
8115 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
8116 phase, to minimize cases of half-done things. */
8119 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
8120 cancel_cutthrough_connection(TRUE, US"deliveries are done");
8122 /* Root privilege is no longer needed */
8124 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
8126 set_process_info("tidying up after delivering %s", message_id);
8127 signal(SIGTERM, SIG_IGN);
8129 /* When we are acting as an MUA wrapper, the smtp transport will either have
8130 succeeded for all addresses, or failed them all in normal cases. However, there
8131 are some setup situations (e.g. when a named port does not exist) that cause an
8132 immediate exit with deferral of all addresses. Convert those into failures. We
8133 do not ever want to retry, nor do we want to send a bounce message. */
8139 address_item * nextaddr;
8140 for (address_item * addr = addr_defer; addr; addr = nextaddr)
8142 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
8143 "delivery", addr->address);
8144 nextaddr = addr->next;
8145 addr->next = addr_failed;
8151 /* Now all should either have succeeded or failed. */
8154 final_yield = DELIVER_MUA_SUCCEEDED;
8158 uschar *s = addr_failed->user_message;
8160 if (!s) s = addr_failed->message;
8162 fprintf(stderr, "Delivery failed: ");
8163 if (addr_failed->basic_errno > 0)
8165 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
8166 if (s) fprintf(stderr, ": ");
8168 if ((host = addr_failed->host_used))
8169 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
8171 fprintf(stderr, "%s", CS s);
8172 else if (addr_failed->basic_errno <= 0)
8173 fprintf(stderr, "unknown error");
8174 fprintf(stderr, "\n");
8176 final_yield = DELIVER_MUA_FAILED;
8181 /* In a normal configuration, we now update the retry database. This is done in
8182 one fell swoop at the end in order not to keep opening and closing (and
8183 locking) the database. The code for handling retries is hived off into a
8184 separate module for convenience. We pass it the addresses of the various
8185 chains, because deferred addresses can get moved onto the failed chain if the
8186 retry cutoff time has expired for all alternative destinations. Bypass the
8187 updating of the database if the -N flag is set, which is a debugging thing that
8188 prevents actual delivery. */
8190 else if (!f.dont_deliver)
8191 retry_update(&addr_defer, &addr_failed, &addr_succeed);
8193 /* Send DSN for successful messages if requested */
8195 maybe_send_dsn(addr_succeed);
8197 /* If any addresses failed, we must send a message to somebody, unless
8198 af_ignore_error is set, in which case no action is taken. It is possible for
8199 several messages to get sent if there are addresses with different
8204 const uschar * logtod = tod_stamp(tod_log);
8205 address_item * addr;
8207 /* There are weird cases when logging is disabled in the transport. However,
8208 there may not be a transport (address failed by a router). */
8210 f.disable_logging = FALSE;
8211 if (addr_failed->transport)
8212 f.disable_logging = addr_failed->transport->disable_logging;
8215 debug_printf("processing failed address %s\n", addr_failed->address);
8217 /* There are only two ways an address in a bounce message can get here:
8219 (1) When delivery was initially deferred, but has now timed out (in the call
8220 to retry_update() above). We can detect this by testing for
8221 af_retry_timedout. If the address does not have its own errors address,
8222 we arrange to ignore the error.
8224 (2) If delivery failures for bounce messages are being ignored. We can detect
8225 this by testing for af_ignore_error. This will also be set if a bounce
8226 message has been autothawed and the ignore_bounce_errors_after time has
8227 passed. It might also be set if a router was explicitly configured to
8228 ignore errors (errors_to = "").
8230 If neither of these cases obtains, something has gone wrong. Log the
8231 incident, but then ignore the error. */
8233 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
8235 if ( !testflag(addr_failed, af_retry_timedout)
8236 && !addr_failed->prop.ignore_error)
8237 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
8238 "failure is neither frozen nor ignored (it's been ignored)");
8240 addr_failed->prop.ignore_error = TRUE;
8243 /* If the first address on the list has af_ignore_error set, just remove
8244 it from the list, throw away any saved message file, log it, and
8245 mark the recipient done. */
8247 if ( addr_failed->prop.ignore_error
8248 || addr_failed->dsn_flags & rf_dsnflags
8249 && !(addr_failed->dsn_flags & rf_notify_failure)
8253 addr_failed = addr->next;
8254 if (addr->return_filename) Uunlink(addr->return_filename);
8256 #ifndef DISABLE_EVENT
8257 msg_event_raise(US"msg:fail:delivery", addr);
8259 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
8261 !addr->parent ? US"" : US" <",
8262 !addr->parent ? US"" : addr->parent->address,
8263 !addr->parent ? US"" : US">",
8264 addr->prop.ignore_error
8265 ? US"" : US": RFC 3461 DSN, failure notify not requested");
8267 address_done(addr, logtod);
8268 child_done(addr, logtod);
8269 /* Panic-dies on error */
8270 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8273 /* Otherwise, handle the sending of a message. Find the error address for
8274 the first address, then send a message that includes all failed addresses
8275 that have the same error address. */
8278 send_bounce_message(now, logtod);
8281 f.disable_logging = FALSE; /* In case left set */
8283 /* Come here from the mua_wrapper case if routing goes wrong */
8287 /* If there are now no deferred addresses, we are done. Preserve the
8288 message log if so configured, and we are using them. Otherwise, sling it.
8289 Then delete the message itself. */
8297 fname = spool_fname(US"msglog", message_subdir, id, US"");
8298 if (preserve_message_logs)
8301 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8303 if ((rc = Urename(fname, moname)) < 0)
8305 (void)directory_make(spool_directory,
8306 spool_sname(US"msglog.OLD", US""),
8307 MSGLOG_DIRECTORY_MODE, TRUE);
8308 rc = Urename(fname, moname);
8311 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8312 "msglog.OLD directory", fname);
8315 if (Uunlink(fname) < 0)
8316 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8317 fname, strerror(errno));
8320 /* Remove the two message files. */
8322 fname = spool_fname(US"input", message_subdir, id, US"-D");
8323 if (Uunlink(fname) < 0)
8324 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8325 fname, strerror(errno));
8326 fname = spool_fname(US"input", message_subdir, id, US"-H");
8327 if (Uunlink(fname) < 0)
8328 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8329 fname, strerror(errno));
8331 /* Log the end of this message, with queue time if requested. */
8333 if (LOGGING(queue_time_overall))
8334 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8336 log_write(0, LOG_MAIN, "Completed");
8338 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8339 f.deliver_freeze = FALSE;
8341 #ifndef DISABLE_EVENT
8342 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8346 /* If there are deferred addresses, we are keeping this message because it is
8347 not yet completed. Lose any temporary files that were catching output from
8348 pipes for any of the deferred addresses, handle one-time aliases, and see if
8349 the message has been on the queue for so long that it is time to send a warning
8350 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8351 have the same domain, we can set deliver_domain for the expansion of
8352 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8353 the parent's domain.
8355 If all the deferred addresses have an error number that indicates "retry time
8356 not reached", skip sending the warning message, because it won't contain the
8357 reason for the delay. It will get sent at the next real delivery attempt.
8358 Exception: for retries caused by a remote peer we use the error message
8359 store in the retry DB as the reason.
8360 However, if at least one address has tried, we'd better include all of them in
8363 If we can't make a process to send the message, don't worry.
8365 For mailing list expansions we want to send the warning message to the
8366 mailing list manager. We can't do a perfect job here, as some addresses may
8367 have different errors addresses, but if we take the errors address from
8368 each deferred address it will probably be right in most cases.
8370 If addr_defer == +1, it means there was a problem sending an error message
8371 for failed addresses, and there were no "real" deferred addresses. The value
8372 was set just to keep the message on the spool, so there is nothing to do here.
8375 else if (addr_defer != (address_item *)(+1))
8377 uschar * recipients = US"";
8378 BOOL want_warning_msg = FALSE;
8380 deliver_domain = testflag(addr_defer, af_pfr)
8381 ? addr_defer->parent->domain : addr_defer->domain;
8383 for (address_item * addr = addr_defer; addr; addr = addr->next)
8385 address_item * otaddr;
8387 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8391 const uschar *d = testflag(addr, af_pfr)
8392 ? addr->parent->domain : addr->domain;
8394 /* The domain may be unset for an address that has never been routed
8395 because the system filter froze the message. */
8397 if (!d || Ustrcmp(d, deliver_domain) != 0)
8398 deliver_domain = NULL;
8401 if (addr->return_filename) Uunlink(addr->return_filename);
8403 /* Handle the case of one-time aliases. If any address in the ancestry
8404 of this one is flagged, ensure it is in the recipients list, suitably
8405 flagged, and that its parent is marked delivered. */
8407 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8408 if (otaddr->onetime_parent) break;
8413 int t = recipients_count;
8415 for (i = 0; i < recipients_count; i++)
8417 const uschar * r = recipients_list[i].address;
8418 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8419 if (Ustrcmp(otaddr->address, r) == 0) break;
8422 /* Didn't find the address already in the list, and did find the
8423 ultimate parent's address in the list, and they really are different
8424 (i.e. not from an identity-redirect). After adding the recipient,
8425 update the errors address in the recipients list. */
8427 if ( i >= recipients_count && t < recipients_count
8428 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8430 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8431 otaddr->address, otaddr->parent->address);
8432 receive_add_recipient(otaddr->address, t);
8433 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8434 tree_add_nonrecipient(otaddr->parent->address);
8435 update_spool = TRUE;
8439 /* Except for error messages, ensure that either the errors address for
8440 this deferred address or, if there is none, the sender address, is on the
8441 list of recipients for a warning message. */
8443 if (sender_address[0])
8445 const uschar * s = addr->prop.errors_address;
8446 if (!s) s = sender_address;
8447 if (Ustrstr(recipients, s) == NULL)
8448 recipients = string_sprintf("%s%s%s", recipients,
8449 recipients[0] ? "," : "", s);
8453 /* Send a warning message if the conditions are right. If the condition check
8454 fails because of a lookup defer, there is nothing we can do. The warning
8455 is not sent. Another attempt will be made at the next delivery attempt (if
8458 if ( !f.queue_2stage
8460 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8461 || addr_defer->dsn_flags & rf_notify_delay
8463 && delay_warning[1] > 0
8464 && sender_address[0] != 0)
8466 GET_OPTION("delay_warning_condition");
8467 if ( ( !delay_warning_condition
8468 || expand_check_condition(delay_warning_condition,
8469 US"delay_warning", US"option")
8475 int queue_time = time(NULL) - received_time.tv_sec;
8477 queue_time = test_harness_fudged_queue_time(queue_time);
8479 /* See how many warnings we should have sent by now */
8481 for (count = 0; count < delay_warning[1]; count++)
8482 if (queue_time < delay_warning[count+2]) break;
8484 show_time = delay_warning[count+1];
8486 if (count >= delay_warning[1])
8489 int last_gap = show_time;
8490 if (count > 1) last_gap -= delay_warning[count];
8491 extra = (queue_time - delay_warning[count+1])/last_gap;
8492 show_time += last_gap * extra;
8498 debug_printf("time on queue = %s id %s addr %s\n",
8499 readconf_printtime(queue_time), message_id, addr_defer->address);
8500 debug_printf("warning counts: required %d done %d\n", count,
8504 /* We have computed the number of warnings there should have been by now.
8505 If there haven't been enough, send one, and up the count to what it should
8508 if (warning_count < count)
8509 if (send_warning_message(recipients, queue_time, show_time))
8511 warning_count = count;
8512 update_spool = TRUE; /* Ensure spool rewritten */
8517 /* Clear deliver_domain */
8519 deliver_domain = NULL;
8521 /* If this was a first delivery attempt, unset the first time flag, and
8522 ensure that the spool gets updated. */
8524 if (f.deliver_firsttime && !f.queue_2stage)
8526 f.deliver_firsttime = FALSE;
8527 update_spool = TRUE;
8530 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8531 message, unless the message is a local error message (to avoid loops). Then
8532 log the freezing. If the text in "frozen_info" came from a system filter,
8533 it has been escaped into printing characters so as not to mess up log lines.
8534 For the "tell" message, we turn \n back into newline. Also, insert a newline
8535 near the start instead of the ": " string. */
8537 if (f.deliver_freeze)
8539 if (freeze_tell && *freeze_tell && !f.local_error_message)
8541 uschar * s = string_copy(frozen_info);
8542 uschar * ss = Ustrstr(s, " by the system filter: ");
8551 if (*ss == '\\' && ss[1] == 'n')
8552 { *ss++ = ' '; *ss++ = '\n'; }
8556 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8557 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8561 /* Log freezing just before we update the -H file, to minimize the chance
8562 of a race problem. */
8564 deliver_msglog("*** Frozen%s\n", frozen_info);
8565 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8568 /* If there have been any updates to the non-recipients list, or other things
8569 that get written to the spool, we must now update the spool header file so
8570 that it has the right information for the next delivery attempt. If there
8571 was more than one address being delivered, the header_change update is done
8572 earlier, in case one succeeds and then something crashes. */
8575 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8576 update_spool, f.header_rewritten);
8578 if (update_spool || f.header_rewritten)
8579 /* Panic-dies on error */
8580 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8583 /* Finished with the message log. If the message is complete, it will have
8584 been unlinked or renamed above. */
8586 if (message_logs) (void)fclose(message_log);
8588 /* Now we can close and remove the journal file. Its only purpose is to record
8589 successfully completed deliveries asap so that this information doesn't get
8590 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8591 not serious, as trying it again is not harmful. The journal might not be open
8592 if all addresses were deferred at routing or directing. Nevertheless, we must
8593 remove it if it exists (may have been lying around from a crash during the
8594 previous delivery attempt). We don't remove the journal if a delivery
8595 subprocess failed to pass back delivery information; this is controlled by
8596 the remove_journal flag. When the journal is left, we also don't move the
8597 message off the main spool if frozen and the option is set. It should get moved
8598 at the next attempt, after the journal has been inspected. */
8600 if (journal_fd >= 0) (void)close(journal_fd);
8604 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8606 if (Uunlink(fname) < 0 && errno != ENOENT)
8607 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8610 /* Move the message off the spool if requested */
8612 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8613 if (f.deliver_freeze && move_frozen_messages)
8614 (void)spool_move_message(id, message_subdir, US"", US"F");
8618 /* Closing the data file frees the lock; if the file has been unlinked it
8619 will go away. Otherwise the message becomes available for another process
8622 (void)close(deliver_datafile);
8623 deliver_datafile = -1;
8624 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8625 #ifdef MEASURE_TIMING
8626 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8629 /* It is unlikely that there will be any cached resources, since they are
8630 released after routing, and in the delivery subprocesses. However, it's
8631 possible for an expansion for something afterwards (for example,
8632 expand_check_condition) to do a lookup. We must therefore be sure everything is
8636 acl_where = ACL_WHERE_UNKNOWN;
8645 #ifdef EXIM_TFO_PROBE
8648 f.tcp_fastopen_ok = TRUE;
8654 /* Called from a commandline, or from the daemon, to do a delivery.
8655 We need to regain privs; do this by exec of the exim binary. */
8658 delivery_re_exec(int exec_type)
8662 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8664 int channel_fd = cutthrough.cctx.sock;
8666 smtp_peer_options = cutthrough.peer_options;
8667 continue_sequence = 0;
8670 if (cutthrough.is_tls)
8674 smtp_peer_options |= OPTION_TLS;
8675 sending_ip_address = cutthrough.snd_ip;
8676 sending_port = cutthrough.snd_port;
8678 where = US"socketpair";
8679 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8683 testharness_pause_ms(150);
8684 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8687 if (pid == 0) /* child: will fork again to totally disconnect */
8689 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8690 pfd, 5*60, cutthrough.host.name);
8691 /* does not return */
8695 waitpid(pid, NULL, 0);
8696 (void) close(channel_fd); /* release the client socket */
8697 channel_fd = pfd[1];
8701 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8702 cutthrough.host.address, message_id, channel_fd);
8706 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8707 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8709 return; /* compiler quietening; control does not reach here. */
8714 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8715 "delivery re-exec %s failed: %s", where, strerror(errno));
8717 /* Get here if exec_type == CEE_EXEC_EXIT.
8718 Note: this must be _exit(), not exit(). */
8720 _exit(EX_EXECFAILED);
8726 /* End of deliver.c */