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]);
2469 /* Back in the main process: panic if the fork did not succeed. This seems
2470 better than returning an error - if forking is failing it is probably best
2471 not to try other deliveries for this message. */
2474 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2477 /* Read the pipe to get the delivery status codes and error messages. Our copy
2478 of the writing end must be closed first, as otherwise read() won't return zero
2479 on an empty pipe. We check that a status exists for each address before
2480 overwriting the address structure. If data is missing, the default DEFER status
2481 will remain. Afterwards, close the reading end. */
2483 (void)close(pfd[pipe_write]);
2485 for (addr2 = addr; addr2; addr2 = addr2->next)
2487 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2492 addr2->transport_return = status;
2493 len = read(pfd[pipe_read], &transport_count,
2494 sizeof(transport_count));
2495 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2496 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2497 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2498 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2499 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2500 len = read(pfd[pipe_read], &addr2->transport,
2501 sizeof(transport_instance *));
2503 if (testflag(addr2, af_file))
2506 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2507 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2510 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2511 " from delivery subprocess");
2514 /* sanity-checked llen so disable the Coverity error */
2515 /* coverity[tainted_data] */
2516 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2518 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2519 " from delivery subprocess");
2522 big_buffer[llen] = 0;
2523 addr2->local_part = string_copy(big_buffer);
2526 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2529 len = read(pfd[pipe_read], &message_length, sizeof(int));
2530 if (message_length > 0)
2532 len = read(pfd[pipe_read], big_buffer, message_length);
2533 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2534 if (len > 0) *sptr = string_copy(big_buffer);
2541 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2542 "from delivery subprocess", addr2->unique);
2547 (void)close(pfd[pipe_read]);
2549 /* Unless shadowing, write all successful addresses immediately to the journal
2550 file, to ensure they are recorded asap. For homonymic addresses, use the base
2551 address plus the transport name. Failure to write the journal is panic-worthy,
2552 but don't stop, as it may prove possible subsequently to update the spool file
2553 in order to record the delivery. */
2557 for (addr2 = addr; addr2; addr2 = addr2->next)
2558 if (addr2->transport_return == OK)
2560 if (testflag(addr2, af_homonym))
2561 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2563 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2565 /* In the test harness, wait just a bit to let the subprocess finish off
2566 any debug output etc first. */
2568 testharness_pause_ms(300);
2570 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2571 len = Ustrlen(big_buffer);
2572 if (write(journal_fd, big_buffer, len) != len)
2573 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2574 big_buffer, strerror(errno));
2577 /* Ensure the journal file is pushed out to disk. */
2579 if (EXIMfsync(journal_fd) < 0)
2580 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2584 /* Wait for the process to finish. If it terminates with a non-zero code,
2585 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2586 status values of all the addresses as they are. Take care to handle the case
2587 when the subprocess doesn't seem to exist. This has been seen on one system
2588 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2589 happens, wait() doesn't recognize the termination of child processes. Exim now
2590 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2592 while ((rc = wait(&status)) != pid)
2593 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2595 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2596 addr->transport->driver_name);
2601 if ((status & 0xffff) != 0)
2603 int msb = (status >> 8) & 255;
2604 int lsb = status & 255;
2605 int code = (msb == 0)? (lsb & 0x7f) : msb;
2606 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2607 addr->special_action = SPECIAL_FREEZE;
2608 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2609 "status 0x%04x: %s %d",
2610 addr->transport->driver_name,
2612 msb == 0 ? "terminated by signal" : "exit code",
2616 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2618 if (addr->special_action == SPECIAL_WARN)
2620 uschar * warn_message = addr->transport->warn_message;
2621 GET_OPTION("quota_warn_message");
2627 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2629 if (!(warn_message = expand_string(warn_message)))
2630 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2631 "message for %s transport): %s", addr->transport->warn_message,
2632 addr->transport->name, expand_string_message);
2634 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2636 FILE * f = fdopen(fd, "wb");
2637 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2638 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2639 fprintf(f, "Auto-Submitted: auto-replied\n");
2640 if (!contains_header(US"From", warn_message))
2642 fprintf(f, "%s", CS warn_message);
2644 /* Close and wait for child process to complete, without a timeout. */
2647 (void)child_close(pid, 0);
2650 addr->special_action = SPECIAL_NONE;
2658 /* Check transport for the given concurrency limit. Return TRUE if over
2659 the limit (or an expansion failure), else FALSE and if there was a limit,
2660 the key for the hints database used for the concurrency count. */
2663 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2665 unsigned max_parallel;
2667 GET_OPTION("max_parallel");
2668 if (!tp->max_parallel) return FALSE;
2670 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2671 if (expand_string_message)
2673 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2674 "in %s transport (%s): %s", tp->name, addr->address,
2675 expand_string_message);
2679 if (max_parallel > 0)
2681 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2682 if (!enq_start(serialize_key, max_parallel))
2684 address_item * next;
2686 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2687 tp->name, max_parallel);
2691 addr->message = US"concurrency limit reached for transport";
2692 addr->basic_errno = ERRNO_TRETRY;
2693 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2694 } while ((addr = next));
2697 *key = serialize_key;
2704 /*************************************************
2705 * Do local deliveries *
2706 *************************************************/
2708 /* This function processes the list of addresses in addr_local. True local
2709 deliveries are always done one address at a time. However, local deliveries can
2710 be batched up in some cases. Typically this is when writing batched SMTP output
2711 files for use by some external transport mechanism, or when running local
2712 deliveries over LMTP.
2719 do_local_deliveries(void)
2722 open_db *dbm_file = NULL;
2723 time_t now = time(NULL);
2725 /* Loop until we have exhausted the supply of local deliveries */
2729 struct timeval delivery_start;
2730 struct timeval deliver_time;
2731 address_item *addr2, *addr3, *nextaddr;
2732 int logflags = LOG_MAIN;
2733 int logchar = f.dont_deliver? '*' : '=';
2734 transport_instance *tp;
2735 uschar * serialize_key = NULL;
2737 /* Pick the first undelivered address off the chain */
2739 address_item *addr = addr_local;
2740 addr_local = addr->next;
2743 DEBUG(D_deliver|D_transport)
2744 debug_printf("--------> %s <--------\n", addr->address);
2746 /* An internal disaster if there is no transport. Should not occur! */
2748 if (!(tp = addr->transport))
2750 logflags |= LOG_PANIC;
2751 f.disable_logging = FALSE; /* Jic */
2752 addr->message = addr->router
2753 ? string_sprintf("No transport set by %s router", addr->router->name)
2754 : US"No transport set by system filter";
2755 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2759 /* Check that this base address hasn't previously been delivered to this
2760 transport. The check is necessary at this point to handle homonymic addresses
2761 correctly in cases where the pattern of redirection changes between delivery
2762 attempts. Non-homonymic previous delivery is detected earlier, at routing
2765 if (previously_transported(addr, FALSE)) continue;
2767 /* There are weird cases where logging is disabled */
2769 f.disable_logging = tp->disable_logging;
2771 /* Check for batched addresses and possible amalgamation. Skip all the work
2772 if either batch_max <= 1 or there aren't any other addresses for local
2775 if (tp->batch_max > 1 && addr_local)
2777 int batch_count = 1;
2778 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2779 BOOL uses_lp = ( testflag(addr, af_pfr)
2780 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2782 || readconf_depends((driver_instance *)tp, US"local_part");
2783 uschar *batch_id = NULL;
2784 address_item **anchor = &addr_local;
2785 address_item *last = addr;
2788 /* Expand the batch_id string for comparison with other addresses.
2789 Expansion failure suppresses batching. */
2791 GET_OPTION("batch_id");
2794 deliver_set_expansions(addr);
2795 batch_id = expand_string(tp->batch_id);
2796 deliver_set_expansions(NULL);
2799 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2800 "in %s transport (%s): %s", tp->name, addr->address,
2801 expand_string_message);
2802 batch_count = tp->batch_max;
2806 /* Until we reach the batch_max limit, pick off addresses which have the
2807 same characteristics. These are:
2810 not previously delivered (see comment about 50 lines above)
2811 same local part if the transport's configuration contains $local_part
2812 or if this is a file or pipe delivery from a redirection
2813 same domain if the transport's configuration contains $domain
2815 same additional headers
2816 same headers to be removed
2817 same uid/gid for running the transport
2818 same first host if a host list is set
2821 while ((next = *anchor) && batch_count < tp->batch_max)
2824 tp == next->transport
2825 && !previously_transported(next, TRUE)
2826 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2827 && testflag(addr, af_file) == testflag(next, af_file)
2828 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2829 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2830 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2831 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2832 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2833 && same_ugid(tp, addr, next)
2834 && ( !addr->host_list && !next->host_list
2837 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2840 /* If the transport has a batch_id setting, batch_id will be non-NULL
2841 from the expansion outside the loop. Expand for this address and compare.
2842 Expansion failure makes this address ineligible for batching. */
2847 address_item * save_nextnext = next->next;
2848 next->next = NULL; /* Expansion for a single address */
2849 deliver_set_expansions(next);
2850 next->next = save_nextnext;
2851 GET_OPTION("batch_id");
2852 bid = expand_string(tp->batch_id);
2853 deliver_set_expansions(NULL);
2856 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2857 "in %s transport (%s): %s", tp->name, next->address,
2858 expand_string_message);
2861 else ok = (Ustrcmp(batch_id, bid) == 0);
2864 /* Take address into batch if OK. */
2868 *anchor = next->next; /* Include the address */
2874 else anchor = &next->next; /* Skip the address */
2878 /* We now have one or more addresses that can be delivered in a batch. Check
2879 whether the transport is prepared to accept a message of this size. If not,
2880 fail them all forthwith. If the expansion fails, or does not yield an
2881 integer, defer delivery. */
2883 if (tp->message_size_limit)
2885 int rc = check_message_size(tp, addr);
2888 replicate_status(addr);
2892 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2895 continue; /* With next batch of addresses */
2899 /* If we are not running the queue, or if forcing, all deliveries will be
2900 attempted. Otherwise, we must respect the retry times for each address. Even
2901 when not doing this, we need to set up the retry key string, and determine
2902 whether a retry record exists, because after a successful delivery, a delete
2903 retry item must be set up. Keep the retry database open only for the duration
2904 of these checks, rather than for all local deliveries, because some local
2905 deliveries (e.g. to pipes) can take a substantial time. */
2907 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2908 DEBUG(D_deliver|D_retry|D_hints_lookup)
2909 debug_printf("no retry data available\n");
2915 BOOL ok = TRUE; /* to deliver this address */
2918 /* Set up the retry key to include the domain or not, and change its
2919 leading character from "R" to "T". Must make a copy before doing this,
2920 because the old key may be pointed to from a "delete" retry item after
2923 retry_key = string_copy(
2924 tp->retry_use_local_part ? addr2->address_retry_key :
2925 addr2->domain_retry_key);
2928 /* Inspect the retry data. If there is no hints file, delivery happens. */
2932 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2934 /* If there is no retry record, delivery happens. If there is,
2935 remember it exists so it can be deleted after a successful delivery. */
2939 setflag(addr2, af_lt_retry_exists);
2941 /* A retry record exists for this address. If queue running and not
2942 forcing, inspect its contents. If the record is too old, or if its
2943 retry time has come, or if it has passed its cutoff time, delivery
2948 debug_printf("retry record exists: age=%s ",
2949 readconf_printtime(now - retry_record->time_stamp));
2950 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2951 debug_printf(" time to retry = %s expired = %d\n",
2952 readconf_printtime(retry_record->next_try - now),
2953 retry_record->expired);
2956 if (f.queue_running && !f.deliver_force)
2958 ok = (now - retry_record->time_stamp > retry_data_expire)
2959 || (now >= retry_record->next_try)
2960 || retry_record->expired;
2962 /* If we haven't reached the retry time, there is one more check
2963 to do, which is for the ultimate address timeout. */
2966 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2970 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2973 /* This address is to be delivered. Leave it on the chain. */
2978 addr2 = addr2->next;
2981 /* This address is to be deferred. Take it out of the chain, and
2982 post-process it as complete. Must take it out of the chain first,
2983 because post processing puts it on another chain. */
2987 address_item *this = addr2;
2988 this->message = US"Retry time not yet reached";
2989 this->basic_errno = ERRNO_LRETRY;
2990 addr2 = addr3 ? (addr3->next = addr2->next)
2991 : (addr = addr2->next);
2992 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2996 if (dbm_file) dbfn_close(dbm_file);
2998 /* If there are no addresses left on the chain, they all deferred. Loop
2999 for the next set of addresses. */
3001 if (!addr) continue;
3003 /* If the transport is limited for parallellism, enforce that here.
3004 We use a hints DB entry, incremented here and decremented after
3005 the transport (and any shadow transport) completes. */
3007 if (tpt_parallel_check(tp, addr, &serialize_key))
3009 if (expand_string_message)
3011 logflags |= LOG_PANIC;
3015 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3016 } while ((addr = addr2));
3018 continue; /* Loop for the next set of addresses. */
3022 /* So, finally, we do have some addresses that can be passed to the
3023 transport. Before doing so, set up variables that are relevant to a
3026 deliver_set_expansions(addr);
3028 gettimeofday(&delivery_start, NULL);
3029 deliver_local(addr, FALSE);
3030 timesince(&deliver_time, &delivery_start);
3032 /* If a shadow transport (which must perforce be another local transport), is
3033 defined, and its condition is met, we must pass the message to the shadow
3034 too, but only those addresses that succeeded. We do this by making a new
3035 chain of addresses - also to keep the original chain uncontaminated. We must
3036 use a chain rather than doing it one by one, because the shadow transport may
3039 NOTE: if the condition fails because of a lookup defer, there is nothing we
3043 && ( !tp->shadow_condition
3044 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3047 transport_instance *stp;
3048 address_item *shadow_addr = NULL;
3049 address_item **last = &shadow_addr;
3051 for (stp = transports; stp; stp = stp->next)
3052 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3055 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3058 /* Pick off the addresses that have succeeded, and make clones. Put into
3059 the shadow_message field a pointer to the shadow_message field of the real
3062 else for (addr2 = addr; addr2; addr2 = addr2->next)
3063 if (addr2->transport_return == OK)
3065 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3068 addr3->shadow_message = US &addr2->shadow_message;
3069 addr3->transport = stp;
3070 addr3->transport_return = DEFER;
3071 addr3->return_filename = NULL;
3072 addr3->return_file = -1;
3074 last = &addr3->next;
3077 /* If we found any addresses to shadow, run the delivery, and stick any
3078 message back into the shadow_message field in the original. */
3082 int save_count = transport_count;
3084 DEBUG(D_deliver|D_transport)
3085 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3086 deliver_local(shadow_addr, TRUE);
3088 for(; shadow_addr; shadow_addr = shadow_addr->next)
3090 int sresult = shadow_addr->transport_return;
3091 *(uschar **)shadow_addr->shadow_message =
3093 ? string_sprintf(" ST=%s", stp->name)
3094 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3095 shadow_addr->basic_errno <= 0
3097 : US strerror(shadow_addr->basic_errno),
3098 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3101 shadow_addr->message
3102 ? shadow_addr->message
3103 : shadow_addr->basic_errno <= 0
3107 DEBUG(D_deliver|D_transport)
3108 debug_printf("%s shadow transport returned %s for %s\n",
3109 stp->name, rc_to_string(sresult), shadow_addr->address);
3112 DEBUG(D_deliver|D_transport)
3113 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3115 transport_count = save_count; /* Restore original transport count */
3119 /* Cancel the expansions that were set up for the delivery. */
3121 deliver_set_expansions(NULL);
3123 /* If the transport was parallelism-limited, decrement the hints DB record. */
3125 if (serialize_key) enq_end(serialize_key);
3127 /* Now we can process the results of the real transport. We must take each
3128 address off the chain first, because post_process_one() puts it on another
3131 for (addr2 = addr; addr2; addr2 = nextaddr)
3133 int result = addr2->transport_return;
3134 nextaddr = addr2->next;
3136 DEBUG(D_deliver|D_transport)
3137 debug_printf("%s transport returned %s for %s\n",
3138 tp->name, rc_to_string(result), addr2->address);
3140 /* If there is a retry_record, or if delivery is deferred, build a retry
3141 item for setting a new retry time or deleting the old retry record from
3142 the database. These items are handled all together after all addresses
3143 have been handled (so the database is open just for a short time for
3146 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3148 int flags = result == DEFER ? 0 : rf_delete;
3149 uschar * retry_key = string_copy(tp->retry_use_local_part
3150 ? addr2->address_retry_key : addr2->domain_retry_key);
3152 retry_add_item(addr2, retry_key, flags);
3155 /* Done with this address */
3157 addr2->delivery_time = deliver_time;
3158 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3160 /* If a pipe delivery generated text to be sent back, the result may be
3161 changed to FAIL, and we must copy this for subsequent addresses in the
3164 if (addr2->transport_return != result)
3166 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3168 addr3->transport_return = addr2->transport_return;
3169 addr3->basic_errno = addr2->basic_errno;
3170 addr3->message = addr2->message;
3172 result = addr2->transport_return;
3175 /* Whether or not the result was changed to FAIL, we need to copy the
3176 return_file value from the first address into all the addresses of the
3177 batch, so they are all listed in the error message. */
3179 addr2->return_file = addr->return_file;
3181 /* Change log character for recording successful deliveries. */
3183 if (result == OK) logchar = '-';
3185 } /* Loop back for next batch of addresses */
3191 /*************************************************
3192 * Sort remote deliveries *
3193 *************************************************/
3195 /* This function is called if remote_sort_domains is set. It arranges that the
3196 chain of addresses for remote deliveries is ordered according to the strings
3197 specified. Try to make this shuffling reasonably efficient by handling
3198 sequences of addresses rather than just single ones.
3205 sort_remote_deliveries(void)
3208 address_item **aptr = &addr_remote;
3209 const uschar *listptr = remote_sort_domains;
3213 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3215 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3218 address_item *moved = NULL;
3219 address_item **bptr = &moved;
3223 address_item **next;
3224 deliver_domain = (*aptr)->domain; /* set $domain */
3225 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3226 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3228 aptr = &(*aptr)->next;
3232 next = &(*aptr)->next;
3234 && (deliver_domain = (*next)->domain, /* Set $domain */
3235 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3236 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3238 next = &(*next)->next;
3240 /* If the batch of non-matchers is at the end, add on any that were
3241 extracted further up the chain, and end this iteration. Otherwise,
3242 extract them from the chain and hang on the moved chain. */
3254 aptr = &(*aptr)->next;
3257 /* If the loop ended because the final address matched, *aptr will
3258 be NULL. Add on to the end any extracted non-matching addresses. If
3259 *aptr is not NULL, the loop ended via "break" when *next is null, that
3260 is, there was a string of non-matching addresses at the end. In this
3261 case the extracted addresses have already been added on the end. */
3263 if (!*aptr) *aptr = moved;
3268 debug_printf("remote addresses after sorting:\n");
3269 for (address_item * addr = addr_remote; addr; addr = addr->next)
3270 debug_printf(" %s\n", addr->address);
3276 /*************************************************
3277 * Read from pipe for remote delivery subprocess *
3278 *************************************************/
3280 /* This function is called when the subprocess is complete, but can also be
3281 called before it is complete, in order to empty a pipe that is full (to prevent
3282 deadlock). It must therefore keep track of its progress in the parlist data
3285 We read the pipe to get the delivery status codes and a possible error message
3286 for each address, optionally preceded by unusability data for the hosts and
3287 also by optional retry data.
3289 Read in large chunks into the big buffer and then scan through, interpreting
3290 the data therein. In most cases, only a single read will be necessary. No
3291 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3292 that we read the next chunk when there is less than 2500 bytes left in the
3293 non-final chunk, we can assume each item is complete in the buffer before
3294 handling it. Each item is written using a single write(), which is atomic for
3295 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3296 often bigger) so even if we are reading while the subprocess is still going, we
3297 should never have only a partial item in the buffer.
3299 hs12: This assumption is not true anymore, since we get quite large items (certificate
3300 information and such).
3303 poffset the offset of the parlist item
3304 eop TRUE if the process has completed
3306 Returns: TRUE if the terminating 'Z' item has been read,
3307 or there has been a disaster (i.e. no more data needed);
3312 par_read_pipe(int poffset, BOOL eop)
3315 pardata *p = parlist + poffset;
3316 address_item *addrlist = p->addrlist;
3317 address_item *addr = p->addr;
3321 uschar *msg = p->msg;
3322 BOOL done = p->done;
3324 /* Loop through all items, reading from the pipe when necessary. The pipe
3325 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3326 here, as the preceding poll() tells us, if data is available for reading.
3328 A read() on a "selected" handle should never block, but(!) it may return
3329 less data then we expected. (The buffer size we pass to read() shouldn't be
3330 understood as a "request", but as a "limit".)
3332 Each separate item is written to the pipe in a timely manner. But, especially for
3333 larger items, the read(2) may already return partial data from the write(2).
3335 The write is atomic mostly (depending on the amount written), but atomic does
3336 not imply "all or noting", it just is "not intermixed" with other writes on the
3337 same channel (pipe).
3341 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3342 (int)p->pid, eop? "ended" : "not ended yet");
3346 retry_item *r, **rp;
3347 uschar pipeheader[PIPE_HEADER_SIZE+1];
3348 uschar *id = &pipeheader[0];
3349 uschar *subid = &pipeheader[1];
3350 uschar *ptr = big_buffer;
3351 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3354 DEBUG(D_deliver) debug_printf(
3355 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3357 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3358 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3359 If we get less, we can assume the subprocess do be done and do not expect any further
3360 information from it. */
3362 if ((got = readn(fd, pipeheader, required)) != required)
3364 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3365 "from transport process %d for transport %s",
3366 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3371 pipeheader[PIPE_HEADER_SIZE] = '\0';
3373 debug_printf("got %ld bytes (pipeheader) '%c' from transport process %d\n",
3374 (long) got, *id, pid);
3377 /* If we can't decode the pipeheader, the subprocess seems to have a
3378 problem, we do not expect any furher information from it. */
3380 required = Ustrtol(pipeheader+2, &endc, 10);
3383 msg = string_sprintf("failed to read pipe "
3384 "from transport process %d for transport %s: error decoding size from header",
3385 pid, addr->transport->driver_name);
3392 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3393 (u_long)required, pid);
3395 /* Same as above, the transport process will write the bytes announced
3396 in a timely manner, so we can just wait for the bytes, getting less than expected
3397 is considered a problem of the subprocess, we do not expect anything else from it. */
3398 if ((got = readn(fd, big_buffer, required)) != required)
3400 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3401 " bytes (pipedata) from transport process %d for transport %s",
3402 got, required, pid, addr->transport->driver_name);
3407 /* Handle each possible type of item, assuming the complete item is
3408 available in store. */
3412 /* Host items exist only if any hosts were marked unusable. Match
3413 up by checking the IP address. */
3416 for (h = addrlist->host_list; h; h = h->next)
3418 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3426 /* Retry items are sent in a preceding R item for each address. This is
3427 kept separate to keep each message short enough to guarantee it won't
3428 be split in the pipe. Hopefully, in the majority of cases, there won't in
3429 fact be any retry items at all.
3431 The complete set of retry items might include an item to delete a
3432 routing retry if there was a previous routing delay. However, routing
3433 retries are also used when a remote transport identifies an address error.
3434 In that case, there may also be an "add" item for the same key. Arrange
3435 that a "delete" item is dropped in favour of an "add" item. */
3438 if (!addr) goto ADDR_MISMATCH;
3440 DEBUG(D_deliver|D_retry)
3441 debug_printf("reading retry information for %s from subprocess\n",
3444 /* Cut out any "delete" items on the list. */
3446 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3447 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3449 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3450 *rp = r->next; /* Excise a delete item */
3451 DEBUG(D_deliver|D_retry)
3452 debug_printf(" existing delete item dropped\n");
3455 /* We want to add a delete item only if there is no non-delete item;
3456 however we still have to step ptr through the data. */
3458 if (!r || !(*ptr & rf_delete))
3460 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3461 r->next = addr->retries;
3464 r->key = string_copy(ptr);
3466 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3467 ptr += sizeof(r->basic_errno);
3468 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3469 ptr += sizeof(r->more_errno);
3470 r->message = *ptr ? string_copy(ptr) : NULL;
3471 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3472 r->flags & rf_delete ? "delete" : "retry");
3477 DEBUG(D_deliver|D_retry)
3478 debug_printf(" delete item not added: non-delete item exists\n");
3481 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3487 /* Put the amount of data written into the parlist block */
3489 case 'S': /* Size */
3490 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3491 ptr += sizeof(transport_count);
3494 /* Address items are in the order of items on the address chain. We
3495 remember the current address value in case this function is called
3496 several times to empty the pipe in stages. Information about delivery
3497 over TLS is sent in a preceding X item for each address. We don't put
3498 it in with the other info, in order to keep each message short enough to
3499 guarantee it won't be split in the pipe. */
3502 case 'X': /* TLS details */
3503 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3507 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3511 addr->cipher = string_copy(ptr);
3512 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3516 addr->peerdn = string_copy(ptr);
3521 (void) tls_import_cert(ptr, &addr->peercert);
3523 addr->peercert = NULL;
3528 (void) tls_import_cert(ptr, &addr->ourcert);
3530 addr->ourcert = NULL;
3533 # ifndef DISABLE_OCSP
3535 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3541 #endif /*DISABLE_TLS*/
3543 case 'C': /* client authenticator information */
3546 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3547 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3548 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3553 #ifndef DISABLE_PRDR
3555 setflag(addr, af_prdr_used);
3562 #ifndef DISABLE_PIPE_CONNECT
3563 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3565 case 1: setflag(addr, af_pipelining); break;
3570 setflag(addr, af_chunking_used);
3574 setflag(addr, af_tcp_fastopen_conn);
3575 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3576 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3580 if (!addr) goto ADDR_MISMATCH;
3581 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3582 ptr += sizeof(addr->dsn_aware);
3583 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3586 case 'A': /* Per-address info */
3590 msg = string_sprintf("address count mismatch for data read from pipe "
3591 "for transport process %d for transport %s", pid,
3592 addrlist->transport->driver_name);
3599 #ifndef DISABLE_DKIM
3600 case '4': /* DKIM information */
3601 addr->dkim_used = string_copy(ptr);
3606 case '3': /* explicit notification of continued-connection (non)use;
3607 overrides caller's knowlege. */
3608 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3609 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3612 #ifdef SUPPORT_SOCKS
3613 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3614 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3619 proxy_local_address = string_copy(ptr);
3621 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3622 ptr += sizeof(proxy_local_port);
3627 #ifdef EXPERIMENTAL_DSN_INFO
3628 case '1': /* must arrive before A0, and applies to that addr */
3629 /* Two strings: smtp_greeting and helo_response */
3630 addr->smtp_greeting = string_copy(ptr);
3632 addr->helo_response = string_copy(ptr);
3637 case '0': /* results of trying to send to this address */
3638 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3639 addr->transport_return = *ptr++;
3640 addr->special_action = *ptr++;
3641 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3642 ptr += sizeof(addr->basic_errno);
3643 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3644 ptr += sizeof(addr->more_errno);
3645 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3646 ptr += sizeof(addr->delivery_time);
3647 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3648 ptr += sizeof(addr->flags);
3649 addr->message = *ptr ? string_copy(ptr) : NULL;
3651 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3654 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3658 h = store_get(sizeof(host_item), GET_UNTAINTED);
3659 h->name = string_copy(ptr);
3661 h->address = string_copy(ptr);
3663 memcpy(&h->port, ptr, sizeof(h->port));
3664 ptr += sizeof(h->port);
3665 h->dnssec = *ptr == '2' ? DS_YES
3666 : *ptr == '1' ? DS_NO
3669 addr->host_used = h;
3673 /* Finished with this address */
3680 /* Local interface address/port */
3682 if (*ptr) sending_ip_address = string_copy(ptr);
3684 if (*ptr) sending_port = atoi(CS ptr);
3688 /* Z marks the logical end of the data. It is followed by '0' if
3689 continue_transport was NULL at the end of transporting, otherwise '1'.
3690 We need to know when it becomes NULL during a delivery down a passed SMTP
3691 channel so that we don't try to pass anything more down it. Of course, for
3692 most normal messages it will remain NULL all the time. */
3697 continue_transport = NULL;
3698 continue_hostname = NULL;
3701 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3704 /* Anything else is a disaster. */
3707 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3708 "process %d for transport %s", ptr[-1], pid,
3709 addr->transport->driver_name);
3715 /* The done flag is inspected externally, to determine whether or not to
3716 call the function again when the process finishes. */
3720 /* If the process hadn't finished, and we haven't seen the end of the data
3721 or if we suffered a disaster, update the rest of the state, and return FALSE to
3722 indicate "not finished". */
3731 /* Close our end of the pipe, to prevent deadlock if the far end is still
3732 pushing stuff into it. */
3737 /* If we have finished without error, but haven't had data for every address,
3738 something is wrong. */
3741 msg = string_sprintf("insufficient address data read from pipe "
3742 "for transport process %d for transport %s", pid,
3743 addr->transport->driver_name);
3745 /* If an error message is set, something has gone wrong in getting back
3746 the delivery data. Put the message into each address and freeze it. */
3749 for (addr = addrlist; addr; addr = addr->next)
3751 addr->transport_return = DEFER;
3752 addr->special_action = SPECIAL_FREEZE;
3753 addr->message = msg;
3754 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3757 /* Return TRUE to indicate we have got all we need from this process, even
3758 if it hasn't actually finished yet. */
3765 /*************************************************
3766 * Post-process a set of remote addresses *
3767 *************************************************/
3769 /* Do what has to be done immediately after a remote delivery for each set of
3770 addresses, then re-write the spool if necessary. Note that post_process_one
3771 puts the address on an appropriate queue; hence we must fish off the next
3772 one first. This function is also called if there is a problem with setting
3773 up a subprocess to do a remote delivery in parallel. In this case, the final
3774 argument contains a message, and the action must be forced to DEFER.
3777 addr pointer to chain of address items
3778 logflags flags for logging
3779 msg NULL for normal cases; -> error message for unexpected problems
3780 fallback TRUE if processing fallback hosts
3786 remote_post_process(address_item * addr, int logflags, uschar * msg,
3789 /* If any host addresses were found to be unusable, add them to the unusable
3790 tree so that subsequent deliveries don't try them. */
3792 for (host_item * h = addr->host_list; h; h = h->next)
3794 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3796 /* Now handle each address on the chain. The transport has placed '=' or '-'
3797 into the special_action field for each successful delivery. */
3801 address_item * next = addr->next;
3803 /* If msg == NULL (normal processing) and the result is DEFER and we are
3804 processing the main hosts and there are fallback hosts available, put the
3805 address on the list for fallback delivery. */
3807 if ( addr->transport_return == DEFER
3808 && addr->fallback_hosts
3813 addr->host_list = addr->fallback_hosts;
3814 addr->next = addr_fallback;
3815 addr_fallback = addr;
3816 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3819 /* If msg is set (=> unexpected problem), set it in the address before
3820 doing the ordinary post processing. */
3826 addr->message = msg;
3827 addr->transport_return = DEFER;
3829 (void)post_process_one(addr, addr->transport_return, logflags,
3830 EXIM_DTYPE_TRANSPORT, addr->special_action);
3838 /* If we have just delivered down a passed SMTP channel, and that was
3839 the last address, the channel will have been closed down. Now that
3840 we have logged that delivery, set continue_sequence to 1 so that
3841 any subsequent deliveries don't get "*" incorrectly logged. */
3843 if (!continue_transport) continue_sequence = 1;
3848 /*************************************************
3849 * Wait for one remote delivery subprocess *
3850 *************************************************/
3852 /* This function is called while doing remote deliveries when either the
3853 maximum number of processes exist and we need one to complete so that another
3854 can be created, or when waiting for the last ones to complete. It must wait for
3855 the completion of one subprocess, empty the control block slot, and return a
3856 pointer to the address chain.
3859 Returns: pointer to the chain of addresses handled by the process;
3860 NULL if no subprocess found - this is an unexpected error
3863 static address_item *
3866 int poffset, status;
3867 address_item * addr, * addrlist;
3870 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3871 "to finish", message_id);
3873 /* Loop until either a subprocess completes, or there are no subprocesses in
3874 existence - in which case give an error return. We cannot proceed just by
3875 waiting for a completion, because a subprocess may have filled up its pipe, and
3876 be waiting for it to be emptied. Therefore, if no processes have finished, we
3877 wait for one of the pipes to acquire some data by calling poll(), with a
3878 timeout just in case.
3880 The simple approach is just to iterate after reading data from a ready pipe.
3881 This leads to non-ideal behaviour when the subprocess has written its final Z
3882 item, closed the pipe, and is in the process of exiting (the common case). A
3883 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3884 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3887 To avoid this, if all the data that is needed has been read from a subprocess
3888 after poll(), an explicit wait() for it is done. We know that all it is doing
3889 is writing to the pipe and then exiting, so the wait should not be long.
3891 The non-blocking waitpid() is to some extent just insurance; if we could
3892 reliably detect end-of-file on the pipe, we could always know when to do a
3893 blocking wait() for a completed process. However, because some systems use
3894 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3895 use code that functions without the need to recognize EOF.
3897 There's a double loop here just in case we end up with a process that is not in
3898 the list of remote delivery processes. Something has obviously gone wrong if
3899 this is the case. (For example, a process that is incorrectly left over from
3900 routing or local deliveries might be found.) The damage can be minimized by
3901 looping back and looking for another process. If there aren't any, the error
3902 return will happen. */
3904 for (;;) /* Normally we do not repeat this loop */
3906 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3910 /* A return value of -1 can mean several things. If errno != ECHILD, it
3911 either means invalid options (which we discount), or that this process was
3912 interrupted by a signal. Just loop to try the waitpid() again.
3914 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3915 in existence. This should never happen, and is an unexpected error.
3916 However, there is a nasty complication when running under Linux. If "strace
3917 -f" is being used under Linux to trace this process and its children,
3918 subprocesses are "stolen" from their parents and become the children of the
3919 tracing process. A general wait such as the one we've just obeyed returns
3920 as if there are no children while subprocesses are running. Once a
3921 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3922 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3925 This does not happen using "truss" on Solaris, nor (I think) with other
3926 tracing facilities on other OS. It seems to be specific to Linux.
3928 What we do to get round this is to use kill() to see if any of our
3929 subprocesses are still in existence. If kill() gives an OK return, we know
3930 it must be for one of our processes - it can't be for a re-use of the pid,
3931 because if our process had finished, waitpid() would have found it. If any
3932 of our subprocesses are in existence, we proceed to use poll() as if
3933 waitpid() had returned zero. I think this is safe. */
3937 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3940 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3941 "for process existence\n");
3943 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3945 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3947 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3948 "stolen by strace\n", (int)pid);
3949 break; /* With poffset set */
3953 if (poffset >= remote_max_parallel)
3955 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3956 return NULL; /* This is the error return */
3960 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3961 been handled above. A return value of zero means that there is at least one
3962 subprocess, but there are no completed subprocesses. See if any pipes are
3963 ready with any data for reading. */
3965 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3967 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3968 if (parlist[poffset].pid != 0)
3970 parpoll[poffset].fd = parlist[poffset].fd;
3971 parpoll[poffset].events = POLLIN;
3974 parpoll[poffset].fd = -1;
3976 /* Stick in a 60-second timeout, just in case. */
3978 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3980 /* Scan through the pipes and read any that are ready; use the count
3981 returned by poll() to stop when there are no more. Select() can return
3982 with no processes (e.g. if interrupted). This shouldn't matter.
3984 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3985 read, or there was a disaster. In either case, we are finished with this
3986 process. Do an explicit wait() for the process and break the main loop if
3989 It turns out that we have to deal with the case of an interrupted system
3990 call, which can happen on some operating systems if the signal handling is
3991 set up to do that by default. */
3994 readycount > 0 && poffset < remote_max_parallel;
3997 if ( (pid = parlist[poffset].pid) != 0
3998 && parpoll[poffset].revents
4002 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4003 for (;;) /* Loop for signals */
4005 pid_t endedpid = waitpid(pid, &status, 0);
4006 if (endedpid == pid) goto PROCESS_DONE;
4007 if (endedpid != (pid_t)(-1) || errno != EINTR)
4008 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4009 "%d (errno = %d) from waitpid() for process %d",
4010 (int)endedpid, errno, (int)pid);
4015 /* Now go back and look for a completed subprocess again. */
4018 /* A completed process was detected by the non-blocking waitpid(). Find the
4019 data block that corresponds to this subprocess. */
4021 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4022 if (pid == parlist[poffset].pid) break;
4024 /* Found the data block; this is a known remote delivery process. We don't
4025 need to repeat the outer loop. This should be what normally happens. */
4027 if (poffset < remote_max_parallel) break;
4029 /* This situation is an error, but it's probably better to carry on looking
4030 for another process than to give up (as we used to do). */
4032 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4033 "transport process list", pid);
4034 } /* End of the "for" loop */
4036 /* Come here when all the data was completely read after a poll(), and
4037 the process in pid has been wait()ed for. */
4044 debug_printf("remote delivery process %d ended\n", (int)pid);
4046 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4050 set_process_info("delivering %s", message_id);
4052 /* Get the chain of processed addresses */
4054 addrlist = parlist[poffset].addrlist;
4056 /* If the process did not finish cleanly, record an error and freeze (except
4057 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4058 in case the delivery did actually happen. */
4060 if ((status & 0xffff) != 0)
4063 int msb = (status >> 8) & 255;
4064 int lsb = status & 255;
4065 int code = (msb == 0)? (lsb & 0x7f) : msb;
4067 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4069 addrlist->transport->driver_name,
4071 msb == 0 ? "terminated by signal" : "exit code",
4074 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4075 addrlist->special_action = SPECIAL_FREEZE;
4077 for (addr = addrlist; addr; addr = addr->next)
4079 addr->transport_return = DEFER;
4080 addr->message = msg;
4083 remove_journal = FALSE;
4086 /* Else complete reading the pipe to get the result of the delivery, if all
4087 the data has not yet been obtained. */
4089 else if (!parlist[poffset].done)
4090 (void) par_read_pipe(poffset, TRUE);
4092 /* Put the data count and return path into globals, mark the data slot unused,
4093 decrement the count of subprocesses, and return the address chain. */
4095 transport_count = parlist[poffset].transport_count;
4096 used_return_path = parlist[poffset].return_path;
4097 parlist[poffset].pid = 0;
4104 /*************************************************
4105 * Wait for subprocesses and post-process *
4106 *************************************************/
4108 /* This function waits for subprocesses until the number that are still running
4109 is below a given threshold. For each complete subprocess, the addresses are
4110 post-processed. If we can't find a running process, there is some shambles.
4111 Better not bomb out, as that might lead to multiple copies of the message. Just
4112 log and proceed as if all done.
4115 max maximum number of subprocesses to leave running
4116 fallback TRUE if processing fallback hosts
4122 par_reduce(int max, BOOL fallback)
4124 while (parcount > max)
4126 address_item * doneaddr = par_wait();
4129 log_write(0, LOG_MAIN|LOG_PANIC,
4130 "remote delivery process count got out of step");
4135 transport_instance * tp = doneaddr->transport;
4136 if (tp->max_parallel)
4137 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4139 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4145 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4147 uschar pipe_header[PIPE_HEADER_SIZE+1];
4148 size_t total_len = PIPE_HEADER_SIZE + size;
4150 struct iovec iov[2] = {
4151 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4152 { buf, size } /* *the* data */
4157 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4158 /* complain to log if someone tries with buffer sizes we can't handle*/
4160 if (size > BIG_BUFFER_SIZE-1)
4162 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4163 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4165 size = BIG_BUFFER_SIZE;
4168 /* Should we check that we do not write more than PIPE_BUF? What would
4171 /* convert size to human readable string prepended by id and subid */
4172 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4173 id, subid, (long)size))
4174 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4176 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4177 id, subid, (long)size, pipe_header);
4179 if ((ret = writev(fd, iov, 2)) != total_len)
4180 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4181 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4182 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4185 /*************************************************
4186 * Do remote deliveries *
4187 *************************************************/
4189 /* This function is called to process the addresses in addr_remote. We must
4190 pick off the queue all addresses that have the same transport, remote
4191 destination, and errors address, and hand them to the transport in one go,
4192 subject to some configured limitations. If this is a run to continue delivering
4193 to an existing delivery channel, skip all but those addresses that can go to
4194 that channel. The skipped addresses just get deferred.
4196 If mua_wrapper is set, all addresses must be able to be sent in a single
4197 transaction. If not, this function yields FALSE.
4199 In Exim 4, remote deliveries are always done in separate processes, even
4200 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4201 is so that the base process can retain privilege. This makes the
4202 implementation of fallback transports feasible (though not initially done.)
4204 We create up to the configured number of subprocesses, each of which passes
4205 back the delivery state via a pipe. (However, when sending down an existing
4206 connection, remote_max_parallel is forced to 1.)
4209 fallback TRUE if processing fallback hosts
4211 Returns: TRUE normally
4212 FALSE if mua_wrapper is set and the addresses cannot all be sent
4217 do_remote_deliveries(BOOL fallback)
4222 parcount = 0; /* Number of executing subprocesses */
4224 /* When sending down an existing channel, only do one delivery at a time.
4225 We use a local variable (parmax) to hold the maximum number of processes;
4226 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4228 if (continue_transport) remote_max_parallel = 1;
4229 parmax = remote_max_parallel;
4231 /* If the data for keeping a list of processes hasn't yet been
4236 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4237 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4238 parlist[poffset].pid = 0;
4239 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4242 /* Now loop for each remote delivery */
4244 for (int delivery_count = 0; addr_remote; delivery_count++)
4250 int address_count = 1;
4251 int address_count_max;
4253 BOOL use_initgroups;
4254 BOOL pipe_done = FALSE;
4255 transport_instance *tp;
4256 address_item **anchor = &addr_remote;
4257 address_item *addr = addr_remote;
4258 address_item *last = addr;
4261 uschar * serialize_key = NULL;
4263 /* Pull the first address right off the list. */
4265 addr_remote = addr->next;
4268 DEBUG(D_deliver|D_transport)
4269 debug_printf("--------> %s <--------\n", addr->address);
4271 /* If no transport has been set, there has been a big screw-up somewhere. */
4273 if (!(tp = addr->transport))
4275 f.disable_logging = FALSE; /* Jic */
4276 panicmsg = US"No transport set by router";
4277 goto panic_continue;
4280 /* Check that this base address hasn't previously been delivered to this
4281 transport. The check is necessary at this point to handle homonymic addresses
4282 correctly in cases where the pattern of redirection changes between delivery
4283 attempts. Non-homonymic previous delivery is detected earlier, at routing
4286 if (previously_transported(addr, FALSE)) continue;
4288 /* Force failure if the message is too big. */
4290 if (tp->message_size_limit)
4292 int rc = check_message_size(tp, addr);
4295 addr->transport_return = rc;
4296 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4301 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4302 So look out for the place it gets used.
4305 /* Get the flag which specifies whether the transport can handle different
4306 domains that nevertheless resolve to the same set of hosts. If it needs
4307 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4308 $host, $host_address, $host_port. */
4309 if (tp->expand_multi_domain)
4310 deliver_set_expansions(addr);
4312 if (exp_bool(addr, US"transport", tp->name, D_transport,
4313 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4314 &multi_domain) != OK)
4316 deliver_set_expansions(NULL);
4317 panicmsg = addr->message;
4318 goto panic_continue;
4321 /* Get the maximum it can handle in one envelope, with zero meaning
4322 unlimited, which is forced for the MUA wrapper case and if the
4323 value could vary depending on the messages.
4324 For those, we only split (below) by (tpt,dest,erraddr,hdrs) and rely on the
4325 transport splitting further by max_rcp. So we potentially lose some
4328 address_count_max = mua_wrapper || Ustrchr(tp->max_addresses, '$')
4329 ? UNLIMITED_ADDRS : expand_max_rcpt(tp->max_addresses);
4332 /************************************************************************/
4333 /***** This is slightly experimental code, but should be safe. *****/
4335 /* The address_count_max value is the maximum number of addresses that the
4336 transport can send in one envelope. However, the transport must be capable of
4337 dealing with any number of addresses. If the number it gets exceeds its
4338 envelope limitation, it must send multiple copies of the message. This can be
4339 done over a single connection for SMTP, so uses less resources than making
4340 multiple connections. On the other hand, if remote_max_parallel is greater
4341 than one, it is perhaps a good idea to use parallel processing to move the
4342 message faster, even if that results in multiple simultaneous connections to
4345 How can we come to some compromise between these two ideals? What we do is to
4346 limit the number of addresses passed to a single instance of a transport to
4347 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4348 number of addresses routed to remote transports divided by
4349 remote_max_parallel. For example, if the message has 100 remote recipients,
4350 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4351 once. But if rcpt_max is 100, we could send up to 100.
4353 Of course, not all the remotely addresses in a message are going to go to the
4354 same set of hosts (except in smarthost configurations), so this is just a
4355 heuristic way of dividing up the work.
4357 Furthermore (1), because this may not be wanted in some cases, and also to
4358 cope with really pathological cases, there is also a limit to the number of
4359 messages that are sent over one connection. This is the same limit that is
4360 used when sending several different messages over the same connection.
4361 Continue_sequence is set when in this situation, to the number sent so
4362 far, including this message.
4364 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4365 is probably because they are using VERP, in which case they want to pass only
4366 one address at a time to the transport, in order to be able to use
4367 $local_part and $domain in constructing a new return path. We could test for
4368 the use of these variables, but as it is so likely they will be used when the
4369 maximum is 1, we don't bother. Just leave the value alone. */
4371 if ( address_count_max != 1
4372 && address_count_max < remote_delivery_count/remote_max_parallel
4375 int new_max = remote_delivery_count/remote_max_parallel;
4376 int message_max = tp->connection_max_messages;
4377 if (connection_max_messages >= 0) message_max = connection_max_messages;
4378 message_max -= continue_sequence - 1;
4379 if (message_max > 0 && new_max > address_count_max * message_max)
4380 new_max = address_count_max * message_max;
4381 address_count_max = new_max;
4384 /************************************************************************/
4387 /*XXX don't know yet if DANE will be used. So tpt will have to
4388 check at the point if gets next addr from list, and skip/defer any
4392 /* Pick off all addresses which have the same transport, errors address,
4393 destination, and extra headers. In some cases they point to the same host
4394 list, but we also need to check for identical host lists generated from
4395 entirely different domains. The host list pointers can be NULL in the case
4396 where the hosts are defined in the transport. There is also a configured
4397 maximum limit of addresses that can be handled at once (see comments above
4398 for how it is computed).
4399 If the transport does not handle multiple domains, enforce that also,
4400 and if it might need a per-address check for this, re-evaluate it.
4403 while ((next = *anchor) && address_count < address_count_max)
4406 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4407 && tp == next->transport
4408 && same_hosts(next->host_list, addr->host_list)
4409 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4410 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4411 && same_ugid(tp, next, addr)
4412 && ( next->prop.remove_headers == addr->prop.remove_headers
4413 || ( next->prop.remove_headers
4414 && addr->prop.remove_headers
4415 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4419 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4421 US"transport", next->transport->name, D_transport,
4422 US"multi_domain", next->transport->multi_domain,
4423 next->transport->expand_multi_domain, &md) == OK
4428 *anchor = next->next;
4430 next->first = addr; /* remember top one (for retry processing) */
4435 else anchor = &(next->next);
4436 deliver_set_expansions(NULL);
4439 /* If we are acting as an MUA wrapper, all addresses must go in a single
4440 transaction. If not, put them back on the chain and yield FALSE. */
4442 if (mua_wrapper && addr_remote)
4444 last->next = addr_remote;
4449 /* If the transport is limited for parallellism, enforce that here.
4450 The hints DB entry is decremented in par_reduce(), when we reap the
4451 transport process. */
4453 if (tpt_parallel_check(tp, addr, &serialize_key))
4454 if ((panicmsg = expand_string_message))
4455 goto panic_continue;
4457 continue; /* Loop for the next set of addresses. */
4459 /* Set up the expansion variables for this set of addresses */
4461 deliver_set_expansions(addr);
4463 /* Ensure any transport-set auth info is fresh */
4464 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4466 /* Compute the return path, expanding a new one if required. The old one
4467 must be set first, as it might be referred to in the expansion. */
4469 if(addr->prop.errors_address)
4470 return_path = addr->prop.errors_address;
4472 return_path = sender_address;
4474 GET_OPTION("return_path");
4475 if (tp->return_path)
4477 uschar * new_return_path = expand_string(tp->return_path);
4478 if (new_return_path)
4479 return_path = new_return_path;
4480 else if (!f.expand_string_forcedfail)
4482 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4483 tp->return_path, expand_string_message);
4488 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4489 logs and sets up error messages, so we just post-process and continue with
4490 the next address. */
4492 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4498 /* If this transport has a setup function, call it now so that it gets
4499 run in this process and not in any subprocess. That way, the results of
4500 any setup that are retained by the transport can be reusable. One of the
4501 things the setup does is to set the fallback host lists in the addresses.
4502 That is why it is called at this point, before the continue delivery
4503 processing, because that might use the fallback hosts. */
4506 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4508 /* If we have a connection still open from a verify stage (lazy-close)
4509 treat it as if it is a continued connection (apart from the counter used
4510 for the log line mark). */
4512 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4515 debug_printf("lazy-callout-close: have conn still open from verification\n");
4516 continue_transport = cutthrough.transport;
4517 continue_hostname = string_copy(cutthrough.host.name);
4518 continue_host_address = string_copy(cutthrough.host.address);
4519 continue_sequence = 1;
4520 sending_ip_address = cutthrough.snd_ip;
4521 sending_port = cutthrough.snd_port;
4522 smtp_peer_options = cutthrough.peer_options;
4525 /* If this is a run to continue delivery down an already-established
4526 channel, check that this set of addresses matches the transport and
4527 the channel. If it does not, defer the addresses. If a host list exists,
4528 we must check that the continue host is on the list. Otherwise, the
4529 host is set in the transport. */
4531 f.continue_more = FALSE; /* In case got set for the last lot */
4532 if (continue_transport)
4534 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4535 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4537 /* If the transport is about to override the host list do not check
4538 it here but take the cost of running the transport process to discover
4539 if the continued_hostname connection is suitable. This is a layering
4540 violation which is unfortunate as it requires we haul in the smtp
4545 smtp_transport_options_block * ob;
4547 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4548 && (ob = (smtp_transport_options_block *)tp->options_block)
4549 && ob->hosts_override && ob->hosts
4555 for (host_item * h = addr->host_list; h; h = h->next)
4556 if (Ustrcmp(h->name, continue_hostname) == 0)
4557 /*XXX should also check port here */
4558 { ok = TRUE; break; }
4562 /* Addresses not suitable; defer or queue for fallback hosts (which
4563 might be the continue host) and skip to next address. */
4567 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4568 Ustrcmp(continue_transport, tp->name) != 0
4569 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4570 : string_sprintf("no host matching %s", continue_hostname));
4571 if (serialize_key) enq_end(serialize_key);
4573 if (addr->fallback_hosts && !fallback)
4575 for (next = addr; ; next = next->next)
4577 next->host_list = next->fallback_hosts;
4578 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4579 if (!next->next) break;
4581 next->next = addr_fallback;
4582 addr_fallback = addr;
4587 for (next = addr; ; next = next->next)
4589 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4590 if (!next->next) break;
4592 next->next = addr_defer;
4599 /* Set a flag indicating whether there are further addresses that list
4600 the continued host. This tells the transport to leave the channel open,
4601 but not to pass it to another delivery process. We'd like to do that
4602 for non-continue_transport cases too but the knowlege of which host is
4603 connected to is too hard to manage. Perhaps we need a finer-grain
4604 interface to the transport. */
4606 for (next = addr_remote; next && !f.continue_more; next = next->next)
4607 for (host_item * h = next->host_list; h; h = h->next)
4608 if (Ustrcmp(h->name, continue_hostname) == 0)
4609 { f.continue_more = TRUE; break; }
4612 /* The transports set up the process info themselves as they may connect
4613 to more than one remote machine. They also have to set up the filter
4614 arguments, if required, so that the host name and address are available
4617 transport_filter_argv = NULL;
4619 /* Create the pipe for inter-process communication. If pipe creation
4620 fails, it is probably because the value of remote_max_parallel is so
4621 large that too many file descriptors for pipes have been created. Arrange
4622 to wait for a process to finish, and then try again. If we still can't
4623 create a pipe when all processes have finished, break the retry loop. */
4627 if (pipe(pfd) == 0) pipe_done = TRUE;
4628 else if (parcount > 0) parmax = parcount;
4631 /* We need to make the reading end of the pipe non-blocking. There are
4632 two different options for this. Exim is cunningly (I hope!) coded so
4633 that it can use either of them, though it prefers O_NONBLOCK, which
4634 distinguishes between EOF and no-more-data. */
4636 /* The data appears in a timely manner and we already did a poll on
4637 all pipes, so I do not see a reason to use non-blocking IO here
4640 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4642 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4646 /* If the maximum number of subprocesses already exist, wait for a process
4647 to finish. If we ran out of file descriptors, parmax will have been reduced
4648 from its initial value of remote_max_parallel. */
4650 par_reduce(parmax - 1, fallback);
4653 /* If we failed to create a pipe and there were no processes to wait
4654 for, we have to give up on this one. Do this outside the above loop
4655 so that we can continue the main loop. */
4659 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4663 /* Find a free slot in the pardata list. Must do this after the possible
4664 waiting for processes to finish, because a terminating process will free
4667 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4668 if (parlist[poffset].pid == 0)
4671 /* If there isn't one, there has been a horrible disaster. */
4673 if (poffset >= remote_max_parallel)
4675 (void)close(pfd[pipe_write]);
4676 (void)close(pfd[pipe_read]);
4677 panicmsg = US"Unexpectedly no free subprocess slot";
4681 /* Now fork a subprocess to do the remote delivery, but before doing so,
4682 ensure that any cached resources are released so as not to interfere with
4683 what happens in the subprocess. */
4687 if ((pid = exim_fork(US"transport")) == 0)
4689 int fd = pfd[pipe_write];
4692 /* Setting these globals in the subprocess means we need never clear them */
4694 transport_name = tp->name;
4695 if (addr->router) router_name = addr->router->name;
4696 driver_srcfile = tp->srcfile;
4697 driver_srcline = tp->srcline;
4699 /* There are weird circumstances in which logging is disabled */
4700 f.disable_logging = tp->disable_logging;
4702 /* Show pids on debug output if parallelism possible */
4704 if (parmax > 1 && (parcount > 0 || addr_remote))
4705 DEBUG(D_any|D_v) debug_selector |= D_pid;
4707 /* Reset the random number generator, so different processes don't all
4708 have the same sequence. In the test harness we want different, but
4709 predictable settings for each delivery process, so do something explicit
4710 here rather they rely on the fixed reset in the random number function. */
4712 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4714 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4715 a new process that may be forked to do another delivery down the same
4718 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4720 /* Close open file descriptors for the pipes of other processes
4721 that are running in parallel. */
4723 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4724 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4726 /* This process has inherited a copy of the file descriptor
4727 for the data file, but its file pointer is shared with all the
4728 other processes running in parallel. Therefore, we have to re-open
4729 the file in order to get a new file descriptor with its own
4730 file pointer. We don't need to lock it, as the lock is held by
4731 the parent process. There doesn't seem to be any way of doing
4732 a dup-with-new-file-pointer. */
4734 (void)close(deliver_datafile);
4736 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4738 if ( (deliver_datafile = Uopen(fname, EXIM_CLOEXEC | O_RDWR | O_APPEND, 0))
4740 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4741 "parallel delivery: %s", fname, strerror(errno));
4744 #ifndef O_CLOEXEC /* Set the close-on-exec flag */
4745 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4749 /* Set the uid/gid of this process; bombs out on failure. */
4751 exim_setugid(uid, gid, use_initgroups,
4752 string_sprintf("remote delivery to %s with transport=%s",
4753 addr->address, tp->name));
4755 /* Close the unwanted half of this process' pipe, set the process state,
4756 and run the transport. Afterwards, transport_count will contain the number
4757 of bytes written. */
4759 (void)close(pfd[pipe_read]);
4760 set_process_info("delivering %s using %s", message_id, tp->name);
4761 debug_print_string(tp->debug_string);
4762 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4764 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4765 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4767 /* Ensure any cached resources that we used are now released */
4771 /* Pass the result back down the pipe. This is a lot more information
4772 than is needed for a local delivery. We have to send back the error
4773 status for each address, the usability status for each host that is
4774 flagged as unusable, and all the retry items. When TLS is in use, we
4775 send also the cipher and peerdn information. Each type of information
4776 is flagged by an identifying byte, and is then in a fixed format (with
4777 strings terminated by zeros), and there is a final terminator at the
4778 end. The host information and retry information is all attached to
4779 the first address, so that gets sent at the start. */
4781 /* Host unusability information: for most success cases this will
4784 for (h = addr->host_list; h; h = h->next)
4786 if (!h->address || h->status < hstatus_unusable) continue;
4787 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4788 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4791 /* The number of bytes written. This is the same for each address. Even
4792 if we sent several copies of the message down the same connection, the
4793 size of each one is the same, and it's that value we have got because
4794 transport_count gets reset before calling transport_write_message(). */
4796 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4797 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4799 /* Information about what happened to each address. Four item types are
4800 used: an optional 'X' item first, for TLS information, then an optional "C"
4801 item for any client-auth info followed by 'R' items for any retry settings,
4802 and finally an 'A' item for the remaining data. */
4804 for(; addr; addr = addr->next)
4808 /* The certificate verification status goes into the flags */
4809 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4811 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4813 # ifndef DISABLE_TLS_RESUME
4814 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4817 /* Use an X item only if there's something to send */
4821 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4825 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4827 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4829 else if (continue_proxy_cipher)
4831 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4833 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4839 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4843 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4848 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4852 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4854 # ifndef DISABLE_OCSP
4855 if (addr->ocsp > OCSP_NOT_REQ)
4857 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4858 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4861 #endif /*DISABLE_TLS*/
4863 if (client_authenticator)
4865 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4866 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4868 if (client_authenticated_id)
4870 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4871 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4873 if (client_authenticated_sender)
4875 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4876 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4879 #ifndef DISABLE_PRDR
4880 if (testflag(addr, af_prdr_used))
4881 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4884 if (testflag(addr, af_pipelining))
4885 #ifndef DISABLE_PIPE_CONNECT
4886 if (testflag(addr, af_early_pipe))
4887 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4890 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4892 if (testflag(addr, af_chunking_used))
4893 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4895 if (testflag(addr, af_tcp_fastopen_conn))
4896 rmt_dlv_checked_write(fd, 'T',
4897 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4901 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4902 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4904 /* Retry information: for most success cases this will be null. */
4906 for (retry_item * r = addr->retries; r; r = r->next)
4908 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4909 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4910 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4911 ptr += sizeof(r->basic_errno);
4912 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4913 ptr += sizeof(r->more_errno);
4914 if (!r->message) *ptr++ = 0; else
4916 sprintf(CS ptr, "%.512s", r->message);
4919 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4922 #ifndef DISABLE_DKIM
4923 if (addr->dkim_used && LOGGING(dkim_verbose))
4925 DEBUG(D_deliver) debug_printf("dkim used: %s\n", addr->dkim_used);
4926 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->dkim_used) + 1;
4927 rmt_dlv_checked_write(fd, 'A', '4', big_buffer, ptr - big_buffer);
4931 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4933 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4934 testflag(addr, af_new_conn) ? "non-" : "");
4935 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4936 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4939 #ifdef SUPPORT_SOCKS
4940 if (LOGGING(proxy) && proxy_session)
4943 if (proxy_local_address)
4945 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4946 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4947 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4948 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4949 ptr += sizeof(proxy_local_port);
4953 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4957 #ifdef EXPERIMENTAL_DSN_INFO
4958 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4959 if (addr->smtp_greeting)
4961 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4962 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4963 if (addr->helo_response)
4965 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4966 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4970 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4974 /* The rest of the information goes in an 'A0' item. */
4976 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4977 ptr = big_buffer + 2;
4978 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4979 ptr += sizeof(addr->basic_errno);
4980 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4981 ptr += sizeof(addr->more_errno);
4982 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4983 ptr += sizeof(addr->delivery_time);
4984 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4985 ptr += sizeof(addr->flags);
4987 if (!addr->message) *ptr++ = 0; else
4988 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4990 if (!addr->user_message) *ptr++ = 0; else
4991 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4993 if (!addr->host_used) *ptr++ = 0; else
4995 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4996 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4997 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4998 ptr += sizeof(addr->host_used->port);
5000 /* DNS lookup status */
5001 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
5002 : addr->host_used->dnssec==DS_NO ? '1' : '0';
5005 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
5008 /* Local interface address/port */
5009 #ifdef EXPERIMENTAL_DSN_INFO
5010 if (sending_ip_address)
5012 if (LOGGING(incoming_interface) && sending_ip_address)
5016 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
5017 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
5018 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
5021 /* Add termination flag, close the pipe, and that's it. The character
5022 after 'Z' indicates whether continue_transport is now NULL or not.
5023 A change from non-NULL to NULL indicates a problem with a continuing
5026 big_buffer[0] = continue_transport ? '1' : '0';
5027 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5032 /* Back in the mainline: close the unwanted half of the pipe. */
5034 (void)close(pfd[pipe_write]);
5036 /* If we have a connection still open from a verify stage (lazy-close)
5037 release its TLS library context (if any) as responsibility was passed to
5038 the delivery child process. */
5040 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5043 if (cutthrough.is_tls)
5044 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5046 (void) close(cutthrough.cctx.sock);
5047 release_cutthrough_connection(US"passed to transport proc");
5050 /* Fork failed; defer with error message */
5054 (void)close(pfd[pipe_read]);
5055 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5056 addr->domain, strerror(errno));
5060 /* Fork succeeded; increment the count, and remember relevant data for
5061 when the process finishes. */
5064 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5065 parlist[poffset].pid = pid;
5066 parlist[poffset].fd = pfd[pipe_read];
5067 parlist[poffset].done = FALSE;
5068 parlist[poffset].msg = NULL;
5069 parlist[poffset].return_path = return_path;
5071 /* If the process we've just started is sending a message down an existing
5072 channel, wait for it now. This ensures that only one such process runs at
5073 once, whatever the value of remote_max parallel. Otherwise, we might try to
5074 send two or more messages simultaneously down the same channel. This could
5075 happen if there are different domains that include the same host in otherwise
5076 different host lists.
5078 Also, if the transport closes down the channel, this information gets back
5079 (continue_transport gets set to NULL) before we consider any other addresses
5082 if (continue_transport) par_reduce(0, fallback);
5084 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5085 newly created process get going before we create another process. This should
5086 ensure repeatability in the tests. Wait long enough for most cases to complete
5089 else testharness_pause_ms(600);
5094 if (serialize_key) enq_end(serialize_key);
5096 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5100 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5101 are still running and post-process their addresses. */
5103 par_reduce(0, fallback);
5110 /*************************************************
5111 * Split an address into local part and domain *
5112 *************************************************/
5114 /* This function initializes an address for routing by splitting it up into a
5115 local part and a domain. The local part is set up twice - once in its original
5116 casing, and once in lower case, and it is dequoted. We also do the "percent
5117 hack" for configured domains. This may lead to a DEFER result if a lookup
5118 defers. When a percent-hacking takes place, we insert a copy of the original
5119 address as a new parent of this address, as if we have had a redirection.
5122 addr points to an addr_item block containing the address
5125 DEFER - could not determine if domain is %-hackable
5129 deliver_split_address(address_item * addr)
5131 const uschar * address = addr->address;
5136 if (!(domain = Ustrrchr(address, '@')))
5137 return DEFER; /* should always have a domain, but just in case... */
5139 len = domain - address;
5140 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5142 /* The implication in the RFCs (though I can't say I've seen it spelled out
5143 explicitly) is that quoting should be removed from local parts at the point
5144 where they are locally interpreted. [The new draft "821" is more explicit on
5145 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5146 removing quoting backslashes and any unquoted doublequotes. */
5148 addr->cc_local_part = t = store_get(len+1, address);
5152 if (c == '\"') continue;
5162 /* We do the percent hack only for those domains that are listed in
5163 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5165 if (percent_hack_domains)
5168 uschar * new_address = NULL;
5169 const uschar * local_part = addr->cc_local_part;
5171 deliver_domain = addr->domain; /* set $domain */
5173 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5174 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5176 && (t = Ustrrchr(local_part, '%')) != NULL
5179 new_address = string_copy(local_part);
5180 new_address[t - local_part] = '@';
5181 deliver_domain = string_copylc(t+1);
5182 local_part = string_copyn(local_part, t - local_part);
5185 if (rc == DEFER) return DEFER; /* lookup deferred */
5187 /* If hackery happened, set up new parent and alter the current address. */
5191 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5192 *new_parent = *addr;
5193 addr->parent = new_parent;
5194 new_parent->child_count = 1;
5195 addr->address = new_address;
5196 addr->unique = string_copy(new_address);
5197 addr->domain = deliver_domain;
5198 addr->cc_local_part = local_part;
5199 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5204 /* Create the lowercased version of the final local part, and make that the
5205 default one to be used. */
5207 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5214 /*************************************************
5215 * Get next error message text *
5216 *************************************************/
5218 /* If f is not NULL, read the next "paragraph", from a customized error message
5219 text file, terminated by a line containing ****, and expand it.
5222 f NULL or a file to read from
5223 which string indicating which string (for errors)
5225 Returns: NULL or an expanded string
5229 next_emf(FILE *f, uschar *which)
5235 if (!f) return NULL;
5237 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5240 para = string_get(256);
5243 para = string_cat(para, buffer);
5244 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5247 if ((yield = expand_string(string_from_gstring(para))))
5250 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5251 "bounce_message_file or warn_message_file (%s): %s", which,
5252 expand_string_message);
5259 /*************************************************
5260 * Close down a passed transport channel *
5261 *************************************************/
5263 /* This function is called when a passed transport channel cannot be used.
5264 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5265 so that the function call can be the argument of a "return" statement.
5268 Returns: DELIVER_NOT_ATTEMPTED
5272 continue_closedown(void)
5274 if (continue_transport)
5275 for (transport_instance * t = transports; t; t = t->next)
5276 if (Ustrcmp(t->name, continue_transport) == 0)
5278 if (t->info->closedown) (t->info->closedown)(t);
5281 return DELIVER_NOT_ATTEMPTED;
5287 /*************************************************
5288 * Print address information *
5289 *************************************************/
5291 /* This function is called to output an address, or information about an
5292 address, for bounce or defer messages. If the hide_child flag is set, all we
5293 output is the original ancestor address.
5296 addr points to the address
5297 f the FILE to print to
5298 si an initial string
5299 sc a continuation string for before "generated"
5302 Returns: TRUE if the address is not hidden
5306 print_address_information(address_item * addr, FILE * f, uschar * si,
5307 uschar * sc, uschar * se)
5310 const uschar * printed = US"";
5311 address_item * ancestor = addr;
5312 while (ancestor->parent) ancestor = ancestor->parent;
5314 fprintf(f, "%s", CS si);
5316 if (addr->parent && testflag(addr, af_hide_child))
5318 printed = US"an undisclosed address";
5321 else if (!testflag(addr, af_pfr) || !addr->parent)
5322 printed = addr->address;
5326 const uschar * s = addr->address;
5329 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5330 else if (addr->address[0] == '|') ss = US"pipe";
5333 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5334 printed = addr->parent->address;
5337 fprintf(f, "%s", CS string_printing(printed));
5339 if (ancestor != addr)
5341 const uschar * original = ancestor->onetime_parent;
5342 if (!original) original= ancestor->address;
5343 if (strcmpic(original, printed) != 0)
5344 fprintf(f, "%s(%sgenerated from %s)", sc,
5345 ancestor != addr->parent ? "ultimately " : "",
5346 string_printing(original));
5349 if (addr->host_used)
5350 fprintf(f, "\n host %s [%s]",
5351 addr->host_used->name, addr->host_used->address);
5353 fprintf(f, "%s", CS se);
5361 /*************************************************
5362 * Print error for an address *
5363 *************************************************/
5365 /* This function is called to print the error information out of an address for
5366 a bounce or a warning message. It tries to format the message reasonably by
5367 introducing newlines. All lines are indented by 4; the initial printing
5368 position must be set before calling.
5370 This function used always to print the error. Nowadays we want to restrict it
5371 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5372 and filter "fail". We no longer pass other information willy-nilly in bounce
5373 and warning messages. Text in user_message is always output; text in message
5374 only if the af_pass_message flag is set.
5378 f the FILE to print on
5385 print_address_error(address_item * addr, FILE * f, const uschar * t)
5387 int count = Ustrlen(t);
5388 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5390 if (!s && !(s = addr->user_message))
5393 fprintf(f, "\n %s", t);
5396 if (*s == '\\' && s[1] == 'n')
5406 if (*s++ == ':' && isspace(*s) && count > 45)
5408 fprintf(f, "\n "); /* sic (because space follows) */
5411 else if (count > 254) /* arbitrary limit */
5413 fprintf(f, "[truncated]");
5414 do s++; while (*s && !(*s == '\\' && s[1] == '\n'));
5420 /***********************************************************
5421 * Print Diagnostic-Code for an address *
5422 ************************************************************/
5424 /* This function is called to print the error information out of an address for
5425 a bounce or a warning message. It tries to format the message reasonably as
5426 required by RFC 3461 by adding a space after each newline
5428 it uses the same logic as print_address_error() above. if af_pass_message is true
5429 and addr->message is set it uses the remote host answer. if not addr->user_message
5430 is used instead if available.
5434 f the FILE to print on
5440 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5442 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5445 /* af_pass_message and addr->message set ? print remote host answer */
5450 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5452 /* search first ": ". we assume to find the remote-MTA answer there */
5453 if (!(s = Ustrstr(addr->message, ": ")))
5454 return; /* not found, bail out */
5456 s += 2; /* skip ": " */
5457 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5461 if (cnt > 950) /* RFC line length limit: 998 */
5463 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5464 fputs("[truncated]", f);
5468 if (*s == '\\' && s[1] == 'n')
5470 fputs("\n ", f); /* as defined in RFC 3461 */
5485 /*************************************************
5486 * Check list of addresses for duplication *
5487 *************************************************/
5489 /* This function was introduced when the test for duplicate addresses that are
5490 not pipes, files, or autoreplies was moved from the middle of routing to when
5491 routing was complete. That was to fix obscure cases when the routing history
5492 affects the subsequent routing of identical addresses. This function is called
5493 after routing, to check that the final routed addresses are not duplicates.
5495 If we detect a duplicate, we remember what it is a duplicate of. Note that
5496 pipe, file, and autoreply de-duplication is handled during routing, so we must
5497 leave such "addresses" alone here, as otherwise they will incorrectly be
5500 Argument: address of list anchor
5505 do_duplicate_check(address_item **anchor)
5508 while ((addr = *anchor))
5511 if (testflag(addr, af_pfr))
5513 anchor = &(addr->next);
5515 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5517 DEBUG(D_deliver|D_route)
5518 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5519 *anchor = addr->next;
5520 addr->dupof = tnode->data.ptr;
5521 addr->next = addr_duplicate;
5522 addr_duplicate = addr;
5526 tree_add_duplicate(addr->unique, addr);
5527 anchor = &(addr->next);
5535 /************************************************/
5538 print_dsn_addr_action(FILE * f, address_item * addr,
5539 uschar * action, uschar * status)
5543 if (addr->dsn_orcpt)
5544 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5546 for (pa = addr; pa->parent; ) pa = pa->parent;
5547 fprintf(f, "Action: %s\n"
5548 "Final-Recipient: rfc822;%s\n"
5550 action, pa->address, status);
5555 /* When running in the test harness, there's an option that allows us to
5556 fudge this time so as to get repeatability of the tests. Take the first
5557 time off the list. In queue runs, the list pointer gets updated in the
5561 test_harness_fudged_queue_time(int actual_time)
5564 if ( f.running_in_test_harness && *fudged_queue_times
5565 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5567 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5568 fudged_queue_times);
5574 /************************************************/
5577 expand_open(const uschar * filename,
5578 const uschar * optname, const uschar * reason)
5580 const uschar * s = expand_cstring(filename);
5584 log_write(0, LOG_MAIN|LOG_PANIC,
5585 "Failed to expand %s: '%s'\n", optname, filename);
5586 else if (*s != '/' || is_tainted(s))
5587 log_write(0, LOG_MAIN|LOG_PANIC,
5588 "%s is not %s after expansion: '%s'\n",
5589 optname, *s == '/' ? "untainted" : "absolute", s);
5590 else if (!(fp = Ufopen(s, "rb")))
5591 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5592 "message texts: %s", s, reason, strerror(errno));
5597 /* Output the given header and string, converting either
5598 the sequence "\n" or a real newline into newline plus space.
5599 If that still takes us past column 78, look for the last space
5600 and split there too.
5601 Append a newline if string did not have one.
5602 Limit to about 1024 chars total. */
5605 dsn_put_wrapped(FILE * fp, const uschar * header, const uschar * s)
5607 gstring * g = string_cat(NULL, header);
5609 g = string_cat(g, s);
5610 gstring_release_unused(g);
5611 fprintf(fp, "%s\n", wrap_header(string_from_gstring(g), 79, 1023, US" ", 1));
5617 /*************************************************
5618 * Send a bounce message *
5619 *************************************************/
5621 /* Find the error address for the first address, then send a message that
5622 includes all failed addresses that have the same error address. Note the
5623 bounce_recipient is a global so that it can be accessed by $bounce_recipient
5624 while creating a customized error message. */
5627 send_bounce_message(time_t now, const uschar * logtod)
5632 if (!(bounce_recipient = addr_failed->prop.errors_address))
5633 bounce_recipient = sender_address;
5635 /* Make a subprocess to send a message, using its stdin */
5637 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
5638 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5639 "create child process to send failure message: %s", getpid(),
5640 getppid(), strerror(errno));
5642 /* Creation of child succeeded */
5646 int ch, rc, filecount = 0, rcount = 0;
5647 uschar * bcc, * emf_text;
5648 FILE * fp = fdopen(fd, "wb"), * emf = NULL;
5649 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5650 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5651 DELIVER_IN_BUFFER_SIZE;
5652 uschar * bound, * dsnlimitmsg, * dsnnotifyhdr;
5654 address_item ** paddr;
5655 address_item * msgchain = NULL, ** pmsgchain = &msgchain;
5656 address_item * handled_addr = NULL;
5659 debug_printf("sending error message to: %s\n", bounce_recipient);
5661 /* Scan the addresses for all that have the same errors address, removing
5662 them from the addr_failed chain, and putting them on msgchain. */
5664 paddr = &addr_failed;
5665 for (address_item * addr = addr_failed; addr; addr = *paddr)
5666 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
5667 ? addr->prop.errors_address : sender_address) == 0)
5668 { /* The same - dechain */
5669 *paddr = addr->next;
5672 pmsgchain = &addr->next;
5675 paddr = &addr->next; /* Not the same; skip */
5677 /* Include X-Failed-Recipients: for automatic interpretation, but do
5678 not let any one header line get too long. We do this by starting a
5679 new header every 50 recipients. Omit any addresses for which the
5680 "hide_child" flag is set. */
5682 for (address_item * addr = msgchain; addr; addr = addr->next)
5684 if (testflag(addr, af_hide_child)) continue;
5692 ? "X-Failed-Recipients: "
5694 testflag(addr, af_pfr) && addr->parent
5695 ? string_printing(addr->parent->address)
5696 : string_printing(addr->address));
5698 if (rcount > 0) fprintf(fp, "\n");
5700 /* Output the standard headers */
5702 if (errors_reply_to)
5703 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
5704 fprintf(fp, "Auto-Submitted: auto-replied\n");
5705 moan_write_from(fp);
5706 fprintf(fp, "To: %s\n", bounce_recipient);
5707 moan_write_references(fp, NULL);
5709 /* generate boundary string and output MIME-Headers */
5710 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
5712 fprintf(fp, "Content-Type: multipart/report;"
5713 " report-type=delivery-status; boundary=%s\n"
5714 "MIME-Version: 1.0\n",
5717 /* Open a template file if one is provided. Log failure to open, but
5718 carry on - default texts will be used. */
5720 GET_OPTION("bounce_message_file");
5721 if (bounce_message_file)
5722 emf = expand_open(bounce_message_file,
5723 US"bounce_message_file", US"error");
5725 /* Quietly copy to configured additional addresses if required. */
5727 if ((bcc = moan_check_errorcopy(bounce_recipient)))
5728 fprintf(fp, "Bcc: %s\n", bcc);
5730 /* The texts for the message can be read from a template file; if there
5731 isn't one, or if it is too short, built-in texts are used. The first
5732 emf text is a Subject: and any other headers. */
5734 if ((emf_text = next_emf(emf, US"header")))
5735 fprintf(fp, "%s\n", emf_text);
5737 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
5738 to_sender? ": returning message to sender" : "");
5740 /* output human readable part as text/plain section */
5741 fprintf(fp, "--%s\n"
5742 "Content-type: text/plain; charset=us-ascii\n\n",
5745 if ((emf_text = next_emf(emf, US"intro")))
5746 fprintf(fp, "%s", CS emf_text);
5750 /* This message has been reworded several times. It seems to be confusing to
5751 somebody, however it is worded. I have retreated to the original, simple
5753 "This message was created automatically by mail delivery software.\n");
5755 if (bounce_message_text)
5756 fprintf(fp, "%s", CS bounce_message_text);
5759 "\nA message that you sent could not be delivered to one or more of its\n"
5760 "recipients. This is a permanent error. The following address(es) failed:\n");
5763 "\nA message sent by\n\n <%s>\n\n"
5764 "could not be delivered to one or more of its recipients. The following\n"
5765 "address(es) failed:\n", sender_address);
5769 /* Process the addresses, leaving them on the msgchain if they have a
5770 file name for a return message. (There has already been a check in
5771 post_process_one() for the existence of data in the message file.) A TRUE
5772 return from print_address_information() means that the address is not
5776 for (address_item * addr = msgchain; addr; addr = *paddr)
5778 if (print_address_information(addr, fp, US" ", US"\n ", US""))
5779 print_address_error(addr, fp, US"");
5781 /* End the final line for the address */
5785 /* Leave on msgchain if there's a return file. */
5787 if (addr->return_file >= 0)
5789 paddr = &addr->next;
5793 /* Else save so that we can tick off the recipient when the
5798 *paddr = addr->next;
5799 addr->next = handled_addr;
5800 handled_addr = addr;
5806 /* Get the next text, whether we need it or not, so as to be
5807 positioned for the one after. */
5809 emf_text = next_emf(emf, US"generated text");
5811 /* If there were any file messages passed by the local transports,
5812 include them in the message. Then put the address on the handled chain.
5813 In the case of a batch of addresses that were all sent to the same
5814 transport, the return_file field in all of them will contain the same
5815 fd, and the return_filename field in the *last* one will be set (to the
5816 name of the file). */
5820 address_item * nextaddr;
5823 fprintf(fp, "%s", CS emf_text);
5826 "The following text was generated during the delivery "
5827 "attempt%s:\n", (filecount > 1)? "s" : "");
5829 for (address_item * addr = msgchain; addr; addr = nextaddr)
5832 address_item *topaddr = addr;
5834 /* List all the addresses that relate to this file */
5837 while(addr) /* Insurance */
5839 print_address_information(addr, fp, US"------ ", US"\n ",
5841 if (addr->return_filename) break;
5846 /* Now copy the file */
5848 if (!(fm = Ufopen(addr->return_filename, "rb")))
5849 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
5853 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
5856 Uunlink(addr->return_filename);
5858 /* Can now add to handled chain, first fishing off the next
5859 address on the msgchain. */
5861 nextaddr = addr->next;
5862 addr->next = handled_addr;
5863 handled_addr = topaddr;
5868 /* output machine readable part */
5870 if (message_smtputf8)
5871 fprintf(fp, "--%s\n"
5872 "Content-type: message/global-delivery-status\n\n"
5873 "Reporting-MTA: dns; %s\n",
5874 bound, smtp_active_hostname);
5877 fprintf(fp, "--%s\n"
5878 "Content-type: message/delivery-status\n\n"
5879 "Reporting-MTA: dns; %s\n",
5880 bound, smtp_active_hostname);
5884 /* must be decoded from xtext: see RFC 3461:6.3a */
5885 uschar * xdec_envid;
5886 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
5887 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
5889 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
5893 for (address_item * addr = handled_addr; addr; addr = addr->next)
5896 #ifdef EXPERIMENTAL_DSN_INFO
5900 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
5902 if ((hu = addr->host_used) && hu->name)
5904 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
5905 #ifdef EXPERIMENTAL_DSN_INFO
5908 uschar * p = hu->port == 25
5909 ? US"" : string_sprintf(":%d", hu->port);
5910 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
5912 if ((s = addr->smtp_greeting) && *s)
5913 dsn_put_wrapped(fp, US"X-Remote-MTA-smtp-greeting: X-str; ", s);
5914 if ((s = addr->helo_response) && *s)
5915 dsn_put_wrapped(fp, US"X-Remote-MTA-helo-response: X-str; ", s);
5916 if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5917 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5919 print_dsn_diagnostic_code(addr, fp);
5921 #ifdef EXPERIMENTAL_DSN_INFO
5922 else if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5923 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5928 /* Now copy the message, trying to give an intelligible comment if
5929 it is too long for it all to be copied. The limit isn't strictly
5930 applied because of the buffering. There is, however, an option
5931 to suppress copying altogether. */
5933 emf_text = next_emf(emf, US"copy");
5936 we ignore the intro text from template and add
5937 the text for bounce_return_size_limit at the end.
5939 bounce_return_message is ignored
5940 in case RET= is defined we honor these values
5941 otherwise bounce_return_body is honored.
5943 bounce_return_size_limit is always honored.
5946 fprintf(fp, "--%s\n", bound);
5948 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
5949 dsnnotifyhdr = NULL;
5950 topt = topt_add_return_path;
5952 /* RET=HDRS? top priority */
5953 if (dsn_ret == dsn_ret_hdrs)
5954 topt |= topt_no_body;
5957 struct stat statbuf;
5959 /* no full body return at all? */
5960 if (!bounce_return_body)
5962 topt |= topt_no_body;
5963 /* add header if we overrule RET=FULL */
5964 if (dsn_ret == dsn_ret_full)
5965 dsnnotifyhdr = dsnlimitmsg;
5967 /* line length limited... return headers only if oversize */
5968 /* size limited ... return headers only if limit reached */
5969 else if ( max_received_linelength > bounce_return_linesize_limit
5970 || ( bounce_return_size_limit > 0
5971 && fstat(deliver_datafile, &statbuf) == 0
5972 && statbuf.st_size > max
5975 topt |= topt_no_body;
5976 dsnnotifyhdr = dsnlimitmsg;
5981 if (message_smtputf8)
5982 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
5983 : "Content-type: message/global\n\n",
5987 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
5988 : "Content-type: message/rfc822\n\n",
5992 transport_filter_argv = NULL; /* Just in case */
5993 return_path = sender_address; /* In case not previously set */
5994 { /* Dummy transport for headers add */
5995 transport_ctx tctx = {{0}};
5996 transport_instance tb = {0};
5998 tctx.u.fd = fileno(fp);
6000 tctx.options = topt | topt_truncate_headers;
6001 tb.add_headers = dsnnotifyhdr;
6003 /*XXX no checking for failure! buggy! */
6004 transport_write_message(&tctx, 0);
6008 /* we never add the final text. close the file */
6012 fprintf(fp, "\n--%s--\n", bound);
6014 /* Close the file, which should send an EOF to the child process
6015 that is receiving the message. Wait for it to finish. */
6018 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
6020 /* If the process failed, there was some disaster in setting up the
6021 error message. Unless the message is very old, ensure that addr_defer
6022 is non-null, which will have the effect of leaving the message on the
6023 spool. The failed addresses will get tried again next time. However, we
6024 don't really want this to happen too often, so freeze the message unless
6025 there are some genuine deferred addresses to try. To do this we have
6026 to call spool_write_header() here, because with no genuine deferred
6027 addresses the normal code below doesn't get run. */
6032 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
6034 addr_defer = (address_item *)(+1);
6035 f.deliver_freeze = TRUE;
6036 deliver_frozen_at = time(NULL);
6037 /* Panic-dies on error */
6038 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6041 deliver_msglog("Process failed (%d) when writing error message "
6042 "to %s%s", rc, bounce_recipient, s);
6043 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6044 "to %s%s", rc, bounce_recipient, s);
6047 /* The message succeeded. Ensure that the recipients that failed are
6048 now marked finished with on the spool and their parents updated. */
6052 for (address_item * addr = handled_addr; addr; addr = addr->next)
6054 address_done(addr, logtod);
6055 child_done(addr, logtod);
6057 /* Panic-dies on error */
6058 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6063 /*************************************************
6064 * Send a warning message *
6065 *************************************************/
6066 /* Return: boolean success */
6069 send_warning_message(const uschar * recipients, int queue_time, int show_time)
6072 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
6073 FILE * wmf = NULL, * f = fdopen(fd, "wb");
6074 uschar * wmf_text, * bound;
6075 transport_ctx tctx = {{0}};
6078 if (pid <= 0) return FALSE;
6080 GET_OPTION("warn_message_file");
6081 if (warn_message_file)
6082 wmf = expand_open(warn_message_file,
6083 US"warn_message_file", US"warning");
6085 warnmsg_recipients = recipients;
6086 warnmsg_delay = queue_time < 120*60
6087 ? string_sprintf("%d minutes", show_time/60)
6088 : string_sprintf("%d hours", show_time/3600);
6090 if (errors_reply_to)
6091 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6092 fprintf(f, "Auto-Submitted: auto-replied\n");
6094 fprintf(f, "To: %s\n", recipients);
6095 moan_write_references(f, NULL);
6097 /* generated boundary string and output MIME-Headers */
6098 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6100 fprintf(f, "Content-Type: multipart/report;"
6101 " report-type=delivery-status; boundary=%s\n"
6102 "MIME-Version: 1.0\n",
6105 if ((wmf_text = next_emf(wmf, US"header")))
6106 fprintf(f, "%s\n", wmf_text);
6108 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6109 message_id, warnmsg_delay);
6111 /* output human readable part as text/plain section */
6113 "Content-type: text/plain; charset=us-ascii\n\n",
6116 if ((wmf_text = next_emf(wmf, US"intro")))
6117 fprintf(f, "%s", CS wmf_text);
6121 "This message was created automatically by mail delivery software.\n");
6123 if (Ustrcmp(recipients, sender_address) == 0)
6125 "A message that you sent has not yet been delivered to one or more of its\n"
6126 "recipients after more than ");
6130 "A message sent by\n\n <%s>\n\n"
6131 "has not yet been delivered to one or more of its recipients after more than \n",
6134 fprintf(f, "%s on the queue on %s.\n\n"
6135 "The message identifier is: %s\n",
6136 warnmsg_delay, primary_hostname, message_id);
6138 for (header_line * h = header_list; h; h = h->next)
6139 if (strncmpic(h->text, US"Subject:", 8) == 0)
6140 fprintf(f, "The subject of the message is: %s", h->text + 9);
6141 else if (strncmpic(h->text, US"Date:", 5) == 0)
6142 fprintf(f, "The date of the message is: %s", h->text + 6);
6145 fprintf(f, "The address%s to which the message has not yet been "
6147 !addr_defer->next ? "" : "es",
6148 !addr_defer->next ? "is": "are");
6151 /* List the addresses, with error information if allowed */
6154 for (address_item * addr = addr_defer; addr; addr = addr->next)
6156 if (print_address_information(addr, f, US" ", US"\n ", US""))
6157 print_address_error(addr, f, US"Delay reason: ");
6166 if ((wmf_text = next_emf(wmf, US"final")))
6167 fprintf(f, "%s", CS wmf_text);
6173 "No action is required on your part. Delivery attempts will continue for\n"
6174 "some time, and this warning may be repeated at intervals if the message\n"
6175 "remains undelivered. Eventually the mail delivery software will give up,\n"
6176 "and when that happens, the message will be returned to you.\n");
6179 /* output machine readable part */
6180 fprintf(f, "\n--%s\n"
6181 "Content-type: message/delivery-status\n\n"
6182 "Reporting-MTA: dns; %s\n",
6184 smtp_active_hostname);
6189 /* must be decoded from xtext: see RFC 3461:6.3a */
6191 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6192 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6194 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6198 for (address_item * addr = addr_defer; addr; addr = addr->next)
6202 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
6204 if ((hu = addr->host_used) && hu->name)
6206 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
6207 print_dsn_diagnostic_code(addr, f);
6213 "Content-type: text/rfc822-headers\n\n",
6217 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6218 tctx.u.fd = fileno(f);
6219 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6220 transport_filter_argv = NULL; /* Just in case */
6221 return_path = sender_address; /* In case not previously set */
6223 /* Write the original email out */
6224 /*XXX no checking for failure! buggy! */
6225 transport_write_message(&tctx, 0);
6228 fprintf(f,"\n--%s--\n", bound);
6232 /* Close and wait for child process to complete, without a timeout.
6233 If there's an error, don't update the count. */
6236 return child_close(pid, 0) == 0;
6239 /*************************************************
6240 * Send a success-DSN *
6241 *************************************************/
6244 maybe_send_dsn(const address_item * const addr_succeed)
6246 address_item * addr_senddsn = NULL;
6248 for (const address_item * a = addr_succeed; a; a = a->next)
6250 /* af_ignore_error not honored here. it's not an error */
6251 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
6252 "DSN: processing successful delivery address: %s\n"
6253 "DSN: Sender_address: %s\n"
6254 "DSN: orcpt: %s flags: 0x%x\n"
6255 "DSN: envid: %s ret: %d\n"
6256 "DSN: Final recipient: %s\n"
6257 "DSN: Remote SMTP server supports DSN: %d\n",
6258 a->router ? a->router->name : US"(unknown)",
6261 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
6263 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
6268 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6269 and a report was requested */
6271 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
6272 && a->dsn_flags & rf_notify_success
6275 /* copy and relink address_item and send report with all of them at once later */
6276 address_item * addr_next = addr_senddsn;
6277 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
6279 addr_senddsn->next = addr_next;
6282 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6286 { /* create exim process to send message */
6288 pid_t pid = child_open_exim(&fd, US"DSN");
6290 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6292 if (pid < 0) /* Creation of child failed */
6294 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6295 "create child process to send success-dsn message: %s", getpid(),
6296 getppid(), strerror(errno));
6298 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6300 else /* Creation of child succeeded */
6302 FILE * f = fdopen(fd, "wb");
6303 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6305 transport_ctx tctx = {{0}};
6308 debug_printf("sending success-dsn to: %s\n", sender_address);
6310 /* build unique id for MIME boundary */
6311 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6312 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6314 if (errors_reply_to)
6315 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6318 fprintf(f, "Auto-Submitted: auto-generated\n"
6320 "Subject: Delivery Status Notification\n",
6322 moan_write_references(f, NULL);
6323 fprintf(f, "Content-Type: multipart/report;"
6324 " report-type=delivery-status; boundary=%s\n"
6325 "MIME-Version: 1.0\n\n"
6328 "Content-type: text/plain; charset=us-ascii\n\n"
6330 "This message was created automatically by mail delivery software.\n"
6331 " ----- The following addresses had successful delivery notifications -----\n",
6334 for (address_item * a = addr_senddsn; a; a = a->next)
6335 fprintf(f, "<%s> (relayed %s)\n\n",
6337 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
6338 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
6339 : "via non \"Remote SMTP\" router"
6343 "Content-type: message/delivery-status\n\n"
6344 "Reporting-MTA: dns; %s\n",
6345 bound, smtp_active_hostname);
6348 { /* must be decoded from xtext: see RFC 3461:6.3a */
6349 uschar * xdec_envid;
6350 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6351 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6353 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6357 for (address_item * a = addr_senddsn; a; a = a->next)
6361 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
6363 if ((hu = a->host_used) && hu->name)
6364 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6367 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6368 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
6371 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6374 transport_filter_argv = NULL; /* Just in case */
6375 return_path = sender_address; /* In case not previously set */
6377 /* Write the original email out */
6380 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6381 /*XXX hmm, FALSE(fail) retval ignored.
6382 Could error for any number of reasons, and they are not handled. */
6383 transport_write_message(&tctx, 0);
6386 fprintf(f,"\n--%s--\n", bound);
6390 (void) child_close(pid, 0); /* Waits for child to close, no timeout */
6395 /*************************************************
6396 * Deliver one message *
6397 *************************************************/
6399 /* This is the function which is called when a message is to be delivered. It
6400 is passed the id of the message. It is possible that the message no longer
6401 exists, if some other process has delivered it, and it is also possible that
6402 the message is being worked on by another process, in which case the data file
6405 If no delivery is attempted for any of the above reasons, the function returns
6406 DELIVER_NOT_ATTEMPTED.
6408 If the give_up flag is set true, do not attempt any deliveries, but instead
6409 fail all outstanding addresses and return the message to the sender (or
6412 A delivery operation has a process all to itself; we never deliver more than
6413 one message in the same process. Therefore we needn't worry too much about
6416 Liable to be called as root.
6419 id the id of the message to be delivered
6420 forced TRUE if delivery was forced by an administrator; this overrides
6421 retry delays and causes a delivery to be tried regardless
6422 give_up TRUE if an administrator has requested that delivery attempts
6425 Returns: When the global variable mua_wrapper is FALSE:
6426 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
6427 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
6428 When the global variable mua_wrapper is TRUE:
6429 DELIVER_MUA_SUCCEEDED if delivery succeeded
6430 DELIVER_MUA_FAILED if delivery failed
6431 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
6435 deliver_message(const uschar * id, BOOL forced, BOOL give_up)
6438 int final_yield = DELIVER_ATTEMPTED_NORMAL;
6439 time_t now = time(NULL);
6440 address_item *addr_last = NULL;
6441 uschar *filter_message = NULL;
6442 int process_recipients = RECIP_ACCEPT;
6445 extern int acl_where;
6448 #ifdef MEASURE_TIMING
6449 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
6452 info = queue_run_pid == (pid_t)0
6453 ? string_sprintf("delivering %s", id)
6454 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
6456 /* If the D_process_info bit is on, set_process_info() will output debugging
6457 information. If not, we want to show this initial information if D_deliver or
6458 D_queue_run is set or in verbose mode. */
6460 set_process_info("%s", info);
6462 if ( !(debug_selector & D_process_info)
6463 && (debug_selector & (D_deliver|D_queue_run|D_v))
6465 debug_printf("%s\n", info);
6467 /* Ensure that we catch any subprocesses that are created. Although Exim
6468 sets SIG_DFL as its initial default, some routes through the code end up
6469 here with it set to SIG_IGN - cases where a non-synchronous delivery process
6470 has been forked, but no re-exec has been done. We use sigaction rather than
6471 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
6472 sure it is turned off. (There was a problem on AIX with this.) */
6476 struct sigaction act;
6477 act.sa_handler = SIG_DFL;
6478 sigemptyset(&(act.sa_mask));
6480 sigaction(SIGCHLD, &act, NULL);
6483 signal(SIGCHLD, SIG_DFL);
6486 /* Make the forcing flag available for routers and transports, set up the
6487 global message id field, and initialize the count for returned files and the
6488 message size. This use of strcpy() is OK because the length id is checked when
6489 it is obtained from a command line (the -M or -q options), and otherwise it is
6490 known to be a valid message id. */
6492 if (id != message_id)
6493 Ustrcpy(message_id, id);
6494 f.deliver_force = forced;
6498 /* Initialize some flags */
6500 update_spool = FALSE;
6501 remove_journal = TRUE;
6503 /* Set a known context for any ACLs we call via expansions */
6504 acl_where = ACL_WHERE_DELIVERY;
6506 /* Reset the random number generator, so that if several delivery processes are
6507 started from a queue runner that has already used random numbers (for sorting),
6508 they don't all get the same sequence. */
6512 /* Open and lock the message's data file. Exim locks on this one because the
6513 header file may get replaced as it is re-written during the delivery process.
6514 Any failures cause messages to be written to the log, except for missing files
6515 while queue running - another process probably completed delivery. As part of
6516 opening the data file, message_subdir gets set. */
6518 if ((deliver_datafile = spool_open_datafile(id)) < 0)
6519 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6521 /* tHe value of message_size at this point has been set to the data length,
6522 plus one for the blank line that notionally precedes the data. */
6524 /* Now read the contents of the header file, which will set up the headers in
6525 store, and also the list of recipients and the tree of non-recipients and
6526 assorted flags. It updates message_size. If there is a reading or format error,
6527 give up; if the message has been around for sufficiently long, remove it. */
6530 uschar * spoolname = string_sprintf("%s-H", id);
6531 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
6533 if (errno == ERRNO_SPOOLFORMAT)
6535 struct stat statbuf;
6536 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
6538 log_write(0, LOG_MAIN, "Format error in spool file %s: "
6539 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
6541 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
6544 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
6547 /* If we managed to read the envelope data, received_time contains the
6548 time the message was received. Otherwise, we can calculate it from the
6551 if (rc != spool_read_hdrerror)
6553 received_time.tv_sec = received_time.tv_usec = 0;
6554 /*III subsec precision?*/
6555 for (i = 0; i < MESSAGE_ID_TIME_LEN; i++)
6556 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
6559 /* If we've had this malformed message too long, sling it. */
6561 if (now - received_time.tv_sec > keep_malformed)
6563 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
6564 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
6565 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
6566 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
6567 log_write(0, LOG_MAIN, "Message removed because older than %s",
6568 readconf_printtime(keep_malformed));
6571 (void)close(deliver_datafile);
6572 deliver_datafile = -1;
6573 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6577 /* The spool header file has been read. Look to see if there is an existing
6578 journal file for this message. If there is, it means that a previous delivery
6579 attempt crashed (program or host) before it could update the spool header file.
6580 Read the list of delivered addresses from the journal and add them to the
6581 nonrecipients tree. Then update the spool file. We can leave the journal in
6582 existence, as it will get further successful deliveries added to it in this
6583 run, and it will be deleted if this function gets to its end successfully.
6584 Otherwise it might be needed again. */
6587 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6590 if ( (journal_fd = Uopen(fname,
6591 O_RDWR|O_APPEND | EXIM_CLOEXEC | EXIM_NOFOLLOW, SPOOL_MODE)) >= 0
6592 && lseek(journal_fd, 0, SEEK_SET) == 0
6593 && (jread = fdopen(journal_fd, "rb"))
6596 while (Ufgets(big_buffer, big_buffer_size, jread))
6598 int n = Ustrlen(big_buffer);
6599 big_buffer[n-1] = 0;
6600 tree_add_nonrecipient(big_buffer);
6601 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
6602 "journal file\n", big_buffer);
6605 if ((journal_fd = dup(fileno(jread))) < 0)
6606 journal_fd = fileno(jread);
6608 (void) fclose(jread); /* Try to not leak the FILE resource */
6610 /* Panic-dies on error */
6611 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6613 else if (errno != ENOENT)
6615 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
6616 "%s", strerror(errno));
6617 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6620 /* A null recipients list indicates some kind of disaster. */
6622 if (!recipients_list)
6624 (void)close(deliver_datafile);
6625 deliver_datafile = -1;
6626 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
6627 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6632 /* Handle a message that is frozen. There are a number of different things that
6633 can happen, but in the default situation, unless forced, no delivery is
6636 if (f.deliver_freeze)
6638 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6639 /* Moving to another directory removes the message from Exim's view. Other
6640 tools must be used to deal with it. Logging of this action happens in
6641 spool_move_message() and its subfunctions. */
6643 if ( move_frozen_messages
6644 && spool_move_message(id, message_subdir, US"", US"F")
6646 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6649 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
6650 maximum time to keep messages that are frozen. Thaw if we reach it, with a
6651 flag causing all recipients to be failed. The time is the age of the
6652 message, not the time since freezing. */
6654 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
6656 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
6657 process_recipients = RECIP_FAIL_TIMEOUT;
6660 /* For bounce messages (and others with no sender), thaw if the error message
6661 ignore timer is exceeded. The message will be discarded if this delivery
6664 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
6665 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
6667 /* If this is a bounce message, or there's no auto thaw, or we haven't
6668 reached the auto thaw time yet, and this delivery is not forced by an admin
6669 user, do not attempt delivery of this message. Note that forced is set for
6670 continuing messages down the same channel, in order to skip load checking and
6671 ignore hold domains, but we don't want unfreezing in that case. */
6675 if ( ( sender_address[0] == 0
6677 || now <= deliver_frozen_at + auto_thaw
6679 && ( !forced || !f.deliver_force_thaw
6680 || !f.admin_user || continue_hostname
6683 (void)close(deliver_datafile);
6684 deliver_datafile = -1;
6685 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
6686 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6689 /* If delivery was forced (by an admin user), assume a manual thaw.
6690 Otherwise it's an auto thaw. */
6694 f.deliver_manual_thaw = TRUE;
6695 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
6697 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
6700 /* We get here if any of the rules for unfreezing have triggered. */
6702 f.deliver_freeze = FALSE;
6703 update_spool = TRUE;
6707 /* Open the message log file if we are using them. This records details of
6708 deliveries, deferments, and failures for the benefit of the mail administrator.
6709 The log is not used by exim itself to track the progress of a message; that is
6710 done by rewriting the header spool file. */
6714 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
6718 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
6720 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
6721 fname, strerror(errno));
6722 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6725 /* Make a stdio stream out of it. */
6727 if (!(message_log = fdopen(fd, "a")))
6729 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
6730 fname, strerror(errno));
6731 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6736 /* If asked to give up on a message, log who did it, and set the action for all
6741 struct passwd *pw = getpwuid(real_uid);
6742 log_write(0, LOG_MAIN, "cancelled by %s",
6743 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
6744 process_recipients = RECIP_FAIL;
6747 /* Otherwise, if there are too many Received: headers, fail all recipients. */
6749 else if (received_count > received_headers_max)
6750 process_recipients = RECIP_FAIL_LOOP;
6752 /* Otherwise, if a system-wide, address-independent message filter is
6753 specified, run it now, except in the case when we are failing all recipients as
6754 a result of timeout_frozen_after. If the system filter yields "delivered", then
6755 ignore the true recipients of the message. Failure of the filter file is
6756 logged, and the delivery attempt fails. */
6758 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
6763 redirect_block redirect;
6765 if (system_filter_uid_set)
6767 ugid.uid = system_filter_uid;
6768 ugid.gid = system_filter_gid;
6769 ugid.uid_set = ugid.gid_set = TRUE;
6772 ugid.uid_set = ugid.gid_set = FALSE;
6774 return_path = sender_address;
6775 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
6776 f.system_filtering = TRUE;
6778 /* Any error in the filter file causes a delivery to be abandoned. */
6780 GET_OPTION("system_filter");
6781 redirect.string = system_filter;
6782 redirect.isfile = TRUE;
6783 redirect.check_owner = redirect.check_group = FALSE;
6784 redirect.owners = NULL;
6785 redirect.owngroups = NULL;
6787 redirect.modemask = 0;
6789 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
6792 &redirect, /* Where the data is */
6793 RDO_DEFER | /* Turn on all the enabling options */
6794 RDO_FAIL | /* Leave off all the disabling options */
6799 NULL, /* No :include: restriction (not used in filter) */
6800 NULL, /* No sieve vacation directory (not sieve!) */
6801 NULL, /* No sieve enotify mailto owner (not sieve!) */
6802 NULL, /* No sieve user address (not sieve!) */
6803 NULL, /* No sieve subaddress (not sieve!) */
6804 &ugid, /* uid/gid data */
6805 &addr_new, /* Where to hang generated addresses */
6806 &filter_message, /* Where to put error message */
6807 NULL, /* Don't skip syntax errors */
6808 &filtertype, /* Will always be set to FILTER_EXIM for this call */
6809 US"system filter"); /* For error messages */
6811 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
6813 if (rc == FF_ERROR || rc == FF_NONEXIST)
6815 (void)close(deliver_datafile);
6816 deliver_datafile = -1;
6817 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
6818 string_printing(filter_message));
6819 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6822 /* Reset things. If the filter message is an empty string, which can happen
6823 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
6825 f.system_filtering = FALSE;
6826 f.enable_dollar_recipients = FALSE;
6827 if (filter_message && filter_message[0] == 0) filter_message = NULL;
6829 /* Save the values of the system filter variables so that user filters
6832 memcpy(filter_sn, filter_n, sizeof(filter_sn));
6834 /* The filter can request that delivery of the original addresses be
6839 process_recipients = RECIP_DEFER;
6840 deliver_msglog("Delivery deferred by system filter\n");
6841 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6844 /* The filter can request that a message be frozen, but this does not
6845 take place if the message has been manually thawed. In that case, we must
6846 unset "delivered", which is forced by the "freeze" command to make -bF
6849 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6851 f.deliver_freeze = TRUE;
6852 deliver_frozen_at = time(NULL);
6853 process_recipients = RECIP_DEFER;
6854 frozen_info = string_sprintf(" by the system filter%s%s",
6855 filter_message ? US": " : US"",
6856 filter_message ? filter_message : US"");
6859 /* The filter can request that a message be failed. The error message may be
6860 quite long - it is sent back to the sender in the bounce - but we don't want
6861 to fill up the log with repetitions of it. If it starts with << then the text
6862 between << and >> is written to the log, with the rest left for the bounce
6865 else if (rc == FF_FAIL)
6867 uschar *colon = US"";
6868 uschar *logmsg = US"";
6871 process_recipients = RECIP_FAIL_FILTER;
6877 if ( filter_message[0] == '<'
6878 && filter_message[1] == '<'
6879 && (logend = Ustrstr(filter_message, ">>"))
6882 logmsg = filter_message + 2;
6883 loglen = logend - logmsg;
6884 filter_message = logend + 2;
6885 if (filter_message[0] == 0) filter_message = NULL;
6889 logmsg = filter_message;
6890 loglen = Ustrlen(filter_message);
6894 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6898 /* Delivery can be restricted only to those recipients (if any) that the
6899 filter specified. */
6901 else if (rc == FF_DELIVERED)
6903 process_recipients = RECIP_IGNORE;
6905 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6907 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6910 /* If any new addresses were created by the filter, fake up a "parent"
6911 for them. This is necessary for pipes, etc., which are expected to have
6912 parents, and it also gives some sensible logging for others. Allow
6913 pipes, files, and autoreplies, and run them as the filter uid if set,
6914 otherwise as the current uid. */
6918 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6919 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6921 /* The text "system-filter" is tested in transport_set_up_command() and in
6922 set_up_shell_command() in the pipe transport, to enable them to permit
6923 $recipients, so don't change it here without also changing it there. */
6925 address_item *p = addr_new;
6926 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6928 parent->domain = string_copylc(qualify_domain_recipient);
6929 parent->local_part = US"system-filter";
6931 /* As part of this loop, we arrange for addr_last to end up pointing
6932 at the final address. This is used if we go on to add addresses for the
6933 original recipients. */
6937 if (parent->child_count == USHRT_MAX)
6938 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6939 "than %d delivery addresses", USHRT_MAX);
6940 parent->child_count++;
6943 if (testflag(p, af_pfr))
6949 setflag(p, af_uid_set);
6950 setflag(p, af_gid_set);
6951 setflag(p, af_allow_file);
6952 setflag(p, af_allow_pipe);
6953 setflag(p, af_allow_reply);
6955 /* Find the name of the system filter's appropriate pfr transport */
6957 if (p->address[0] == '|')
6960 GET_OPTION("system_filter_pipe_transport");
6961 tpname = system_filter_pipe_transport;
6962 address_pipe = p->address;
6964 else if (p->address[0] == '>')
6967 GET_OPTION("system_filter_reply_transport");
6968 tpname = system_filter_reply_transport;
6972 if (p->address[Ustrlen(p->address)-1] == '/')
6974 type = US"directory";
6975 GET_OPTION("system_filter_directory_transport");
6976 tpname = system_filter_directory_transport;
6981 GET_OPTION("system_filter_file_transport");
6982 tpname = system_filter_file_transport;
6984 address_file = p->address;
6987 /* Now find the actual transport, first expanding the name. We have
6988 set address_file or address_pipe above. */
6992 uschar *tmp = expand_string(tpname);
6993 address_file = address_pipe = NULL;
6995 p->message = string_sprintf("failed to expand \"%s\" as a "
6996 "system filter transport name", tpname);
6997 if (is_tainted(tmp))
6998 p->message = string_sprintf("attempt to used tainted value '%s' for"
6999 "transport '%s' as a system filter", tmp, tpname);
7003 p->message = string_sprintf("system_filter_%s_transport is unset",
7008 transport_instance *tp;
7009 for (tp = transports; tp; tp = tp->next)
7010 if (Ustrcmp(tp->name, tpname) == 0)
7016 p->message = string_sprintf("failed to find \"%s\" transport "
7017 "for system filter delivery", tpname);
7020 /* If we couldn't set up a transport, defer the delivery, putting the
7021 error on the panic log as well as the main log. */
7025 address_item * badp = p;
7027 if (!addr_last) addr_new = p; else addr_last->next = p;
7028 badp->local_part = badp->address; /* Needed for log line */
7029 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
7032 } /* End of pfr handling */
7034 /* Either a non-pfr delivery, or we found a transport */
7036 DEBUG(D_deliver|D_filter)
7037 debug_printf("system filter added %s\n", p->address);
7041 } /* Loop through all addr_new addresses */
7046 /* Scan the recipients list, and for every one that is not in the non-
7047 recipients tree, add an addr item to the chain of new addresses. If the pno
7048 value is non-negative, we must set the onetime parent from it. This which
7049 points to the relevant entry in the recipients list.
7051 This processing can be altered by the setting of the process_recipients
7052 variable, which is changed if recipients are to be ignored, failed, or
7053 deferred. This can happen as a result of system filter activity, or if the -Mg
7054 option is used to fail all of them.
7056 Duplicate addresses are handled later by a different tree structure; we can't
7057 just extend the non-recipients tree, because that will be re-written to the
7058 spool if the message is deferred, and in any case there are casing
7059 complications for local addresses. */
7061 if (process_recipients != RECIP_IGNORE)
7062 for (i = 0; i < recipients_count; i++)
7063 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
7065 recipient_item * r = recipients_list + i;
7066 address_item * new = deliver_make_addr(r->address, FALSE);
7068 new->prop.errors_address = r->errors_to;
7070 if ((new->prop.utf8_msg = message_smtputf8))
7072 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
7073 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
7074 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
7075 new->prop.utf8_downcvt ? "yes"
7076 : new->prop.utf8_downcvt_maybe ? "ifneeded"
7082 new->onetime_parent = recipients_list[r->pno].address;
7084 /* If DSN support is enabled, set the dsn flags and the original receipt
7085 to be passed on to other DSN enabled MTAs */
7087 new->dsn_flags = r->dsn_flags & rf_dsnflags;
7088 new->dsn_orcpt = r->orcpt;
7089 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
7090 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
7092 switch (process_recipients)
7094 /* RECIP_DEFER is set when a system filter freezes a message. */
7097 new->next = addr_defer;
7102 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
7105 case RECIP_FAIL_FILTER:
7107 filter_message ? filter_message : US"delivery cancelled";
7108 setflag(new, af_pass_message);
7109 goto RECIP_QUEUE_FAILED; /* below */
7112 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
7113 than the value in timeout_frozen_after. Treat non-bounce messages
7114 similarly to -Mg; for bounce messages we just want to discard, so
7115 don't put the address on the failed list. The timeout has already
7118 case RECIP_FAIL_TIMEOUT:
7119 new->message = US"delivery cancelled; message timed out";
7120 goto RECIP_QUEUE_FAILED; /* below */
7123 /* RECIP_FAIL is set when -Mg has been used. */
7126 new->message = US"delivery cancelled by administrator";
7127 /* not setting af_pass_message here means that will not
7128 appear in the bounce message */
7131 /* Common code for the failure cases above. If this is not a bounce
7132 message, put the address on the failed list so that it is used to
7133 create a bounce. Otherwise do nothing - this just discards the address.
7134 The incident has already been logged. */
7137 if (*sender_address)
7139 new->next = addr_failed;
7145 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
7146 in the message. Process each address as a routing failure; if this
7147 is a bounce message, it will get frozen. */
7149 case RECIP_FAIL_LOOP:
7150 new->message = US"Too many \"Received\" headers - suspected mail loop";
7151 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7155 /* Value should be RECIP_ACCEPT; take this as the safe default. */
7158 if (!addr_new) addr_new = new; else addr_last->next = new;
7163 #ifndef DISABLE_EVENT
7164 if (process_recipients != RECIP_ACCEPT && event_action)
7166 const uschar * save_local = deliver_localpart;
7167 const uschar * save_domain = deliver_domain;
7168 const uschar * addr = new->address;
7169 uschar * errmsg = NULL;
7170 int start, end, dom;
7172 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
7173 log_write(0, LOG_MAIN|LOG_PANIC,
7174 "failed to parse address '%.100s': %s\n", addr, errmsg);
7178 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
7179 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
7181 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
7183 deliver_localpart = save_local;
7184 deliver_domain = save_domain;
7192 debug_printf("Delivery address list:\n");
7193 for (address_item * p = addr_new; p; p = p->next)
7194 debug_printf(" %s %s\n", p->address,
7195 p->onetime_parent ? p->onetime_parent : US"");
7198 /* Set up the buffers used for copying over the file when delivering. */
7200 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
7201 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
7205 /* Until there are no more new addresses, handle each one as follows:
7207 . If this is a generated address (indicated by the presence of a parent
7208 pointer) then check to see whether it is a pipe, file, or autoreply, and
7209 if so, handle it directly here. The router that produced the address will
7210 have set the allow flags into the address, and also set the uid/gid required.
7211 Having the routers generate new addresses and then checking them here at
7212 the outer level is tidier than making each router do the checking, and
7213 means that routers don't need access to the failed address queue.
7215 . Break up the address into local part and domain, and make lowercased
7216 versions of these strings. We also make unquoted versions of the local part.
7218 . Handle the percent hack for those domains for which it is valid.
7220 . For child addresses, determine if any of the parents have the same address.
7221 If so, generate a different string for previous delivery checking. Without
7222 this code, if the address spqr generates spqr via a forward or alias file,
7223 delivery of the generated spqr stops further attempts at the top level spqr,
7224 which is not what is wanted - it may have generated other addresses.
7226 . Check on the retry database to see if routing was previously deferred, but
7227 only if in a queue run. Addresses that are to be routed are put on the
7228 addr_route chain. Addresses that are to be deferred are put on the
7229 addr_defer chain. We do all the checking first, so as not to keep the
7230 retry database open any longer than necessary.
7232 . Now we run the addresses through the routers. A router may put the address
7233 on either the addr_local or the addr_remote chain for local or remote
7234 delivery, respectively, or put it on the addr_failed chain if it is
7235 undeliveable, or it may generate child addresses and put them on the
7236 addr_new chain, or it may defer an address. All the chain anchors are
7237 passed as arguments so that the routers can be called for verification
7240 . If new addresses have been generated by the routers, da capo.
7243 f.header_rewritten = FALSE; /* No headers rewritten yet */
7244 while (addr_new) /* Loop until all addresses dealt with */
7246 address_item * addr, * parent;
7248 /* Failure to open the retry database is treated the same as if it does
7249 not exist. In both cases, dbm_file is NULL. */
7251 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
7252 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
7253 debug_printf("no retry data available\n");
7255 /* Scan the current batch of new addresses, to handle pipes, files and
7256 autoreplies, and determine which others are ready for routing. */
7262 dbdata_retry * domain_retry_record, * address_retry_record;
7265 addr_new = addr->next;
7267 DEBUG(D_deliver|D_retry|D_route)
7269 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7270 debug_printf("Considering: %s\n", addr->address);
7273 /* Handle generated address that is a pipe or a file or an autoreply. */
7275 if (testflag(addr, af_pfr))
7277 /* If an autoreply in a filter could not generate a syntactically valid
7278 address, give up forthwith. Set af_ignore_error so that we don't try to
7279 generate a bounce. */
7281 if (testflag(addr, af_bad_reply))
7283 addr->basic_errno = ERRNO_BADADDRESS2;
7284 addr->local_part = addr->address;
7286 US"filter autoreply generated syntactically invalid recipient";
7287 addr->prop.ignore_error = TRUE;
7288 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7289 continue; /* with the next new address */
7292 /* If two different users specify delivery to the same pipe or file or
7293 autoreply, there should be two different deliveries, so build a unique
7294 string that incorporates the original address, and use this for
7295 duplicate testing and recording delivery, and also for retrying. */
7298 string_sprintf("%s:%s", addr->address, addr->parent->unique +
7299 (testflag(addr->parent, af_homonym) ? 3:0));
7301 addr->address_retry_key = addr->domain_retry_key =
7302 string_sprintf("T:%s", addr->unique);
7304 /* If a filter file specifies two deliveries to the same pipe or file,
7305 we want to de-duplicate, but this is probably not wanted for two mail
7306 commands to the same address, where probably both should be delivered.
7307 So, we have to invent a different unique string in that case. Just
7308 keep piling '>' characters on the front. */
7310 if (addr->address[0] == '>')
7311 while (tree_search(tree_duplicates, addr->unique))
7312 addr->unique = string_sprintf(">%s", addr->unique);
7314 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
7316 DEBUG(D_deliver|D_route)
7317 debug_printf("%s is a duplicate address: discarded\n", addr->address);
7318 addr->dupof = tnode->data.ptr;
7319 addr->next = addr_duplicate;
7320 addr_duplicate = addr;
7324 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7326 /* Check for previous delivery */
7328 if (tree_search(tree_nonrecipients, addr->unique))
7330 DEBUG(D_deliver|D_route)
7331 debug_printf("%s was previously delivered: discarded\n", addr->address);
7332 child_done(addr, tod_stamp(tod_log));
7336 /* Save for checking future duplicates */
7338 tree_add_duplicate(addr->unique, addr);
7340 /* Set local part and domain */
7342 addr->local_part = addr->address;
7343 addr->domain = addr->parent->domain;
7345 /* Ensure that the delivery is permitted. */
7347 if (testflag(addr, af_file))
7349 if (!testflag(addr, af_allow_file))
7351 addr->basic_errno = ERRNO_FORBIDFILE;
7352 addr->message = US"delivery to file forbidden";
7353 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7354 continue; /* with the next new address */
7357 else if (addr->address[0] == '|')
7359 if (!testflag(addr, af_allow_pipe))
7361 addr->basic_errno = ERRNO_FORBIDPIPE;
7362 addr->message = US"delivery to pipe forbidden";
7363 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7364 continue; /* with the next new address */
7367 else if (!testflag(addr, af_allow_reply))
7369 addr->basic_errno = ERRNO_FORBIDREPLY;
7370 addr->message = US"autoreply forbidden";
7371 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7372 continue; /* with the next new address */
7375 /* If the errno field is already set to BADTRANSPORT, it indicates
7376 failure to expand a transport string, or find the associated transport,
7377 or an unset transport when one is required. Leave this test till now so
7378 that the forbid errors are given in preference. */
7380 if (addr->basic_errno == ERRNO_BADTRANSPORT)
7382 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7386 /* Treat /dev/null as a special case and abandon the delivery. This
7387 avoids having to specify a uid on the transport just for this case.
7388 Arrange for the transport name to be logged as "**bypassed**".
7389 Copy the transport for this fairly unusual case rather than having
7390 to make all transports mutable. */
7392 if (Ustrcmp(addr->address, "/dev/null") == 0)
7394 transport_instance * save_t = addr->transport;
7395 transport_instance * t = store_get(sizeof(*t), save_t);
7397 t->name = US"**bypassed**";
7398 addr->transport = t;
7399 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
7400 addr->transport= save_t;
7401 continue; /* with the next new address */
7404 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
7407 DEBUG(D_deliver|D_route)
7408 debug_printf("queued for %s transport\n", addr->transport->name);
7409 addr->next = addr_local;
7411 continue; /* with the next new address */
7414 /* Handle normal addresses. First, split up into local part and domain,
7415 handling the %-hack if necessary. There is the possibility of a defer from
7416 a lookup in percent_hack_domains. */
7418 if ((rc = deliver_split_address(addr)) == DEFER)
7420 addr->message = US"cannot check percent_hack_domains";
7421 addr->basic_errno = ERRNO_LISTDEFER;
7422 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7426 /* Check to see if the domain is held. If so, proceed only if the
7427 delivery was forced by hand. */
7429 deliver_domain = addr->domain; /* set $domain */
7430 if ( !forced && hold_domains
7431 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
7432 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
7438 addr->message = US"hold_domains lookup deferred";
7439 addr->basic_errno = ERRNO_LISTDEFER;
7443 addr->message = US"domain is held";
7444 addr->basic_errno = ERRNO_HELD;
7446 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7450 /* Now we can check for duplicates and previously delivered addresses. In
7451 order to do this, we have to generate a "unique" value for each address,
7452 because there may be identical actual addresses in a line of descendents.
7453 The "unique" field is initialized to the same value as the "address" field,
7454 but gets changed here to cope with identically-named descendents. */
7456 for (parent = addr->parent; parent; parent = parent->parent)
7457 if (strcmpic(addr->address, parent->address) == 0) break;
7459 /* If there's an ancestor with the same name, set the homonym flag. This
7460 influences how deliveries are recorded. Then add a prefix on the front of
7461 the unique address. We use \n\ where n starts at 0 and increases each time.
7462 It is unlikely to pass 9, but if it does, it may look odd but will still
7463 work. This means that siblings or cousins with the same names are treated
7464 as duplicates, which is what we want. */
7468 setflag(addr, af_homonym);
7469 if (parent->unique[0] != '\\')
7470 addr->unique = string_sprintf("\\0\\%s", addr->address);
7472 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
7476 /* Ensure that the domain in the unique field is lower cased, because
7477 domains are always handled caselessly. */
7479 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
7481 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7483 if (tree_search(tree_nonrecipients, addr->unique))
7485 DEBUG(D_deliver|D_route)
7486 debug_printf("%s was previously delivered: discarded\n", addr->unique);
7487 child_done(addr, tod_stamp(tod_log));
7491 /* Get the routing retry status, saving the two retry keys (with and
7492 without the local part) for subsequent use. If there is no retry record for
7493 the standard address routing retry key, we look for the same key with the
7494 sender attached, because this form is used by the smtp transport after a
7495 4xx response to RCPT when address_retry_include_sender is true. */
7497 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
7498 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
7503 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
7504 if ( domain_retry_record
7505 && now - domain_retry_record->time_stamp > retry_data_expire
7508 DEBUG(D_deliver|D_retry)
7509 debug_printf("domain retry record present but expired\n");
7510 domain_retry_record = NULL; /* Ignore if too old */
7513 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
7514 if ( address_retry_record
7515 && now - address_retry_record->time_stamp > retry_data_expire
7518 DEBUG(D_deliver|D_retry)
7519 debug_printf("address retry record present but expired\n");
7520 address_retry_record = NULL; /* Ignore if too old */
7523 if (!address_retry_record)
7525 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7527 address_retry_record = dbfn_read(dbm_file, altkey);
7528 if ( address_retry_record
7529 && now - address_retry_record->time_stamp > retry_data_expire)
7531 DEBUG(D_deliver|D_retry)
7532 debug_printf("address<sender> retry record present but expired\n");
7533 address_retry_record = NULL; /* Ignore if too old */
7538 domain_retry_record = address_retry_record = NULL;
7540 DEBUG(D_deliver|D_retry)
7542 if (!domain_retry_record)
7543 debug_printf("no domain retry record\n");
7545 debug_printf("have domain retry record; next_try = now%+d\n",
7546 f.running_in_test_harness ? 0 :
7547 (int)(domain_retry_record->next_try - now));
7549 if (!address_retry_record)
7550 debug_printf("no address retry record\n");
7552 debug_printf("have address retry record; next_try = now%+d\n",
7553 f.running_in_test_harness ? 0 :
7554 (int)(address_retry_record->next_try - now));
7557 /* If we are sending a message down an existing SMTP connection, we must
7558 assume that the message which created the connection managed to route
7559 an address to that connection. We do not want to run the risk of taking
7560 a long time over routing here, because if we do, the server at the other
7561 end of the connection may time it out. This is especially true for messages
7562 with lots of addresses. For this kind of delivery, queue_running is not
7563 set, so we would normally route all addresses. We take a pragmatic approach
7564 and defer routing any addresses that have any kind of domain retry record.
7565 That is, we don't even look at their retry times. It doesn't matter if this
7566 doesn't work occasionally. This is all just an optimization, after all.
7568 The reason for not doing the same for address retries is that they normally
7569 arise from 4xx responses, not DNS timeouts. */
7571 if (continue_hostname && domain_retry_record)
7573 addr->message = US"reusing SMTP connection skips previous routing defer";
7574 addr->basic_errno = ERRNO_RRETRY;
7575 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7577 addr->message = domain_retry_record->text;
7578 setflag(addr, af_pass_message);
7581 /* If we are in a queue run, defer routing unless there is no retry data or
7582 we've passed the next retry time, or this message is forced. In other
7583 words, ignore retry data when not in a queue run.
7585 However, if the domain retry time has expired, always allow the routing
7586 attempt. If it fails again, the address will be failed. This ensures that
7587 each address is routed at least once, even after long-term routing
7590 If there is an address retry, check that too; just wait for the next
7591 retry time. This helps with the case when the temporary error on the
7592 address was really message-specific rather than address specific, since
7593 it allows other messages through.
7595 We also wait for the next retry time if this is a message sent down an
7596 existing SMTP connection (even though that will be forced). Otherwise there
7597 will be far too many attempts for an address that gets a 4xx error. In
7598 fact, after such an error, we should not get here because, the host should
7599 not be remembered as one this message needs. However, there was a bug that
7600 used to cause this to happen, so it is best to be on the safe side.
7602 Even if we haven't reached the retry time in the hints, there is one more
7603 check to do, which is for the ultimate address timeout. We only do this
7604 check if there is an address retry record and there is not a domain retry
7605 record; this implies that previous attempts to handle the address had the
7606 retry_use_local_parts option turned on. We use this as an approximation
7607 for the destination being like a local delivery, for example delivery over
7608 LMTP to an IMAP message store. In this situation users are liable to bump
7609 into their quota and thereby have intermittently successful deliveries,
7610 which keep the retry record fresh, which can lead to us perpetually
7611 deferring messages. */
7613 else if ( ( f.queue_running && !f.deliver_force
7614 || continue_hostname
7616 && ( ( domain_retry_record
7617 && now < domain_retry_record->next_try
7618 && !domain_retry_record->expired
7620 || ( address_retry_record
7621 && now < address_retry_record->next_try
7623 && ( domain_retry_record
7624 || !address_retry_record
7625 || !retry_ultimate_address_timeout(addr->address_retry_key,
7626 addr->domain, address_retry_record, now)
7629 addr->message = US"retry time not reached";
7630 addr->basic_errno = ERRNO_RRETRY;
7631 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7633 /* For remote-retry errors (here and just above) that we've not yet
7634 hit the retry time, use the error recorded in the retry database
7635 as info in the warning message. This lets us send a message even
7636 when we're not failing on a fresh attempt. We assume that this
7637 info is not sensitive. */
7639 addr->message = domain_retry_record
7640 ? domain_retry_record->text : address_retry_record->text;
7641 setflag(addr, af_pass_message);
7644 /* The domain is OK for routing. Remember if retry data exists so it
7645 can be cleaned up after a successful delivery. */
7649 if (domain_retry_record || address_retry_record)
7650 setflag(addr, af_dr_retry_exists);
7651 addr->next = addr_route;
7653 DEBUG(D_deliver|D_route)
7654 debug_printf("%s: queued for routing\n", addr->address);
7658 /* The database is closed while routing is actually happening. Requests to
7659 update it are put on a chain and all processed together at the end. */
7661 if (dbm_file) dbfn_close(dbm_file);
7663 /* If queue_domains is set, we don't even want to try routing addresses in
7664 those domains. During queue runs, queue_domains is forced to be unset.
7665 Optimize by skipping this pass through the addresses if nothing is set. */
7667 if (!f.deliver_force && queue_domains)
7669 address_item *okaddr = NULL;
7672 address_item *addr = addr_route;
7673 addr_route = addr->next;
7675 deliver_domain = addr->domain; /* set $domain */
7676 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
7677 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
7681 addr->basic_errno = ERRNO_LISTDEFER;
7682 addr->message = US"queue_domains lookup deferred";
7683 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7687 addr->next = okaddr;
7692 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
7693 addr->message = US"domain is in queue_domains";
7694 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7698 addr_route = okaddr;
7701 /* Now route those addresses that are not deferred. */
7706 address_item *addr = addr_route;
7707 const uschar *old_domain = addr->domain;
7708 uschar *old_unique = addr->unique;
7709 addr_route = addr->next;
7712 /* Just in case some router parameter refers to it. */
7714 if (!(return_path = addr->prop.errors_address))
7715 return_path = sender_address;
7717 /* If a router defers an address, add a retry item. Whether or not to
7718 use the local part in the key is a property of the router. */
7720 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
7721 &addr_succeed, v_none)) == DEFER)
7722 retry_add_item(addr,
7723 addr->router->retry_use_local_part
7724 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
7725 : string_sprintf("R:%s", addr->domain),
7728 /* Otherwise, if there is an existing retry record in the database, add
7729 retry items to delete both forms. We must also allow for the possibility
7730 of a routing retry that includes the sender address. Since the domain might
7731 have been rewritten (expanded to fully qualified) as a result of routing,
7732 ensure that the rewritten form is also deleted. */
7734 else if (testflag(addr, af_dr_retry_exists))
7736 uschar * altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7738 retry_add_item(addr, altkey, rf_delete);
7739 retry_add_item(addr, addr->address_retry_key, rf_delete);
7740 retry_add_item(addr, addr->domain_retry_key, rf_delete);
7741 if (Ustrcmp(addr->domain, old_domain) != 0)
7742 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
7745 /* DISCARD is given for :blackhole: and "seen finish". The event has been
7746 logged, but we need to ensure the address (and maybe parents) is marked
7751 address_done(addr, tod_stamp(tod_log));
7752 continue; /* route next address */
7755 /* The address is finished with (failed or deferred). */
7759 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7760 continue; /* route next address */
7763 /* The address has been routed. If the router changed the domain, it will
7764 also have changed the unique address. We have to test whether this address
7765 has already been delivered, because it's the unique address that finally
7768 if ( addr->unique != old_unique
7769 && tree_search(tree_nonrecipients, addr->unique) != 0
7772 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
7773 "discarded\n", addr->address);
7774 if (addr_remote == addr) addr_remote = addr->next;
7775 else if (addr_local == addr) addr_local = addr->next;
7778 /* If the router has same_domain_copy_routing set, we are permitted to copy
7779 the routing for any other addresses with the same domain. This is an
7780 optimisation to save repeated DNS lookups for "standard" remote domain
7781 routing. The option is settable only on routers that generate host lists.
7782 We play it very safe, and do the optimization only if the address is routed
7783 to a remote transport, there are no header changes, and the domain was not
7784 modified by the router. */
7786 if ( addr_remote == addr
7787 && addr->router->same_domain_copy_routing
7788 && !addr->prop.extra_headers
7789 && !addr->prop.remove_headers
7790 && old_domain == addr->domain
7793 address_item **chain = &addr_route;
7796 address_item *addr2 = *chain;
7797 if (Ustrcmp(addr2->domain, addr->domain) != 0)
7799 chain = &(addr2->next);
7803 /* Found a suitable address; take it off the routing list and add it to
7804 the remote delivery list. */
7806 *chain = addr2->next;
7807 addr2->next = addr_remote;
7808 addr_remote = addr2;
7810 /* Copy the routing data */
7812 addr2->domain = addr->domain;
7813 addr2->router = addr->router;
7814 addr2->transport = addr->transport;
7815 addr2->host_list = addr->host_list;
7816 addr2->fallback_hosts = addr->fallback_hosts;
7817 addr2->prop.errors_address = addr->prop.errors_address;
7818 copyflag(addr2, addr, af_hide_child);
7819 copyflag(addr2, addr, af_local_host_removed);
7821 DEBUG(D_deliver|D_route)
7822 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
7824 "Routing for %s copied from %s\n",
7825 addr2->address, addr2->address, addr->address);
7828 } /* Continue with routing the next address. */
7829 } /* Loop to process any child addresses that the routers created, and
7830 any rerouted addresses that got put back on the new chain. */
7833 /* Debugging: show the results of the routing */
7835 DEBUG(D_deliver|D_retry|D_route)
7837 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7838 debug_printf("After routing:\n Local deliveries:\n");
7839 for (address_item * p = addr_local; p; p = p->next)
7840 debug_printf(" %s\n", p->address);
7842 debug_printf(" Remote deliveries:\n");
7843 for (address_item * p = addr_remote; p; p = p->next)
7844 debug_printf(" %s\n", p->address);
7846 debug_printf(" Failed addresses:\n");
7847 for (address_item * p = addr_failed; p; p = p->next)
7848 debug_printf(" %s\n", p->address);
7850 debug_printf(" Deferred addresses:\n");
7851 for (address_item * p = addr_defer; p; p = p->next)
7852 debug_printf(" %s\n", p->address);
7855 /* Free any resources that were cached during routing. */
7860 /* These two variables are set only during routing, after check_local_user.
7861 Ensure they are not set in transports. */
7863 local_user_gid = (gid_t)(-1);
7864 local_user_uid = (uid_t)(-1);
7866 /* Check for any duplicate addresses. This check is delayed until after
7867 routing, because the flexibility of the routing configuration means that
7868 identical addresses with different parentage may end up being redirected to
7869 different addresses. Checking for duplicates too early (as we previously used
7870 to) makes this kind of thing not work. */
7872 do_duplicate_check(&addr_local);
7873 do_duplicate_check(&addr_remote);
7875 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7876 remote transport. The check that they all end up in one transaction happens in
7877 the do_remote_deliveries() function. */
7880 && (addr_local || addr_failed || addr_defer)
7884 uschar *which, *colon, *msg;
7891 else if (addr_defer)
7894 which = US"deferred";
7902 while (addr->parent) addr = addr->parent;
7907 msg = addr->message;
7909 else colon = msg = US"";
7911 /* We don't need to log here for a forced failure as it will already
7912 have been logged. Defer will also have been logged, but as a defer, so we do
7913 need to do the failure logging. */
7915 if (addr != addr_failed)
7916 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7917 addr->address, which);
7919 /* Always write an error to the caller */
7921 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7924 final_yield = DELIVER_MUA_FAILED;
7925 addr_failed = addr_defer = NULL; /* So that we remove the message */
7926 goto DELIVERY_TIDYUP;
7930 /* If this is a run to continue deliveries to an external channel that is
7931 already set up, defer any local deliveries.
7933 jgh 2020/12/20: I don't see why; locals should be quick.
7934 The defer goes back to version 1.62 in 1997. A local being still deliverable
7935 during a continued run might result from something like a defer during the
7936 original delivery, eg. in a DB lookup. Unlikely but possible.
7938 To avoid delaying a local when combined with a callout-hold for a remote
7939 delivery, test continue_sequence rather than continue_transport. */
7941 if (continue_sequence > 1 && addr_local)
7943 DEBUG(D_deliver|D_retry|D_route)
7944 debug_printf("deferring local deliveries due to continued-transport\n");
7947 address_item * addr = addr_defer;
7948 while (addr->next) addr = addr->next;
7949 addr->next = addr_local;
7952 addr_defer = addr_local;
7957 /* Because address rewriting can happen in the routers, we should not really do
7958 ANY deliveries until all addresses have been routed, so that all recipients of
7959 the message get the same headers. However, this is in practice not always
7960 possible, since sometimes remote addresses give DNS timeouts for days on end.
7961 The pragmatic approach is to deliver what we can now, saving any rewritten
7962 headers so that at least the next lot of recipients benefit from the rewriting
7963 that has already been done.
7965 If any headers have been rewritten during routing, update the spool file to
7966 remember them for all subsequent deliveries. This can be delayed till later if
7967 there is only address to be delivered - if it succeeds the spool write need not
7970 if ( f.header_rewritten
7971 && ( addr_local && (addr_local->next || addr_remote)
7972 || addr_remote && addr_remote->next
7975 /* Panic-dies on error */
7976 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7977 f.header_rewritten = FALSE;
7981 /* If there are any deliveries to do and we do not already have the journal
7982 file, create it. This is used to record successful deliveries as soon as
7983 possible after each delivery is known to be complete. A file opened with
7984 O_APPEND is used so that several processes can run simultaneously.
7986 The journal is just insurance against crashes. When the spool file is
7987 ultimately updated at the end of processing, the journal is deleted. If a
7988 journal is found to exist at the start of delivery, the addresses listed
7989 therein are added to the non-recipients. */
7991 if (addr_local || addr_remote)
7995 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7997 if ((journal_fd = Uopen(fname,
7998 EXIM_CLOEXEC | O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
8000 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
8001 fname, strerror(errno));
8002 return DELIVER_NOT_ATTEMPTED;
8005 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
8006 that the mode is correct - the group setting doesn't always seem to get
8007 set automatically. */
8009 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
8010 || fchmod(journal_fd, SPOOL_MODE)
8012 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
8016 int ret = Uunlink(fname);
8017 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
8018 fname, strerror(errno));
8019 if(ret && errno != ENOENT)
8020 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8021 fname, strerror(errno));
8022 return DELIVER_NOT_ATTEMPTED;
8026 else if (journal_fd >= 0)
8034 /* Now we can get down to the business of actually doing deliveries. Local
8035 deliveries are done first, then remote ones. If ever the problems of how to
8036 handle fallback transports are figured out, this section can be put into a loop
8037 for handling fallbacks, though the uid switching will have to be revised. */
8039 /* Precompile a regex that is used to recognize a parameter in response
8040 to an LHLO command, if is isn't already compiled. This may be used on both
8041 local and remote LMTP deliveries. */
8043 if (!regex_IGNOREQUOTA)
8045 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", MCS_NOFLAGS, TRUE);
8047 /* Handle local deliveries */
8051 DEBUG(D_deliver|D_transport)
8052 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
8053 do_local_deliveries();
8054 f.disable_logging = FALSE;
8057 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
8058 so just queue them all. */
8060 if (f.queue_run_local)
8063 address_item *addr = addr_remote;
8064 addr_remote = addr->next;
8066 addr->basic_errno = ERRNO_LOCAL_ONLY;
8067 addr->message = US"remote deliveries suppressed";
8068 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
8071 /* Handle remote deliveries */
8075 DEBUG(D_deliver|D_transport)
8076 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
8078 /* Precompile some regex that are used to recognize parameters in response
8079 to an EHLO command, if they aren't already compiled. */
8081 smtp_deliver_init();
8083 /* Now sort the addresses if required, and do the deliveries. The yield of
8084 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
8085 cannot be delivered in one transaction. */
8087 if (remote_sort_domains) sort_remote_deliveries();
8088 if (!do_remote_deliveries(FALSE))
8090 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
8091 "be delivered in one transaction");
8092 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
8094 final_yield = DELIVER_MUA_FAILED;
8095 addr_failed = addr_defer = NULL; /* So that we remove the message */
8096 goto DELIVERY_TIDYUP;
8099 /* See if any of the addresses that failed got put on the queue for delivery
8100 to their fallback hosts. We do it this way because often the same fallback
8101 host is used for many domains, so all can be sent in a single transaction
8102 (if appropriately configured). */
8104 if (addr_fallback && !mua_wrapper)
8106 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
8107 addr_remote = addr_fallback;
8108 addr_fallback = NULL;
8109 if (remote_sort_domains) sort_remote_deliveries();
8110 do_remote_deliveries(TRUE);
8112 f.disable_logging = FALSE;
8116 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
8117 phase, to minimize cases of half-done things. */
8120 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
8121 cancel_cutthrough_connection(TRUE, US"deliveries are done");
8123 /* Root privilege is no longer needed */
8125 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
8127 set_process_info("tidying up after delivering %s", message_id);
8128 signal(SIGTERM, SIG_IGN);
8130 /* When we are acting as an MUA wrapper, the smtp transport will either have
8131 succeeded for all addresses, or failed them all in normal cases. However, there
8132 are some setup situations (e.g. when a named port does not exist) that cause an
8133 immediate exit with deferral of all addresses. Convert those into failures. We
8134 do not ever want to retry, nor do we want to send a bounce message. */
8140 address_item * nextaddr;
8141 for (address_item * addr = addr_defer; addr; addr = nextaddr)
8143 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
8144 "delivery", addr->address);
8145 nextaddr = addr->next;
8146 addr->next = addr_failed;
8152 /* Now all should either have succeeded or failed. */
8155 final_yield = DELIVER_MUA_SUCCEEDED;
8159 uschar *s = addr_failed->user_message;
8161 if (!s) s = addr_failed->message;
8163 fprintf(stderr, "Delivery failed: ");
8164 if (addr_failed->basic_errno > 0)
8166 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
8167 if (s) fprintf(stderr, ": ");
8169 if ((host = addr_failed->host_used))
8170 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
8172 fprintf(stderr, "%s", CS s);
8173 else if (addr_failed->basic_errno <= 0)
8174 fprintf(stderr, "unknown error");
8175 fprintf(stderr, "\n");
8177 final_yield = DELIVER_MUA_FAILED;
8182 /* In a normal configuration, we now update the retry database. This is done in
8183 one fell swoop at the end in order not to keep opening and closing (and
8184 locking) the database. The code for handling retries is hived off into a
8185 separate module for convenience. We pass it the addresses of the various
8186 chains, because deferred addresses can get moved onto the failed chain if the
8187 retry cutoff time has expired for all alternative destinations. Bypass the
8188 updating of the database if the -N flag is set, which is a debugging thing that
8189 prevents actual delivery. */
8191 else if (!f.dont_deliver)
8192 retry_update(&addr_defer, &addr_failed, &addr_succeed);
8194 /* Send DSN for successful messages if requested */
8196 maybe_send_dsn(addr_succeed);
8198 /* If any addresses failed, we must send a message to somebody, unless
8199 af_ignore_error is set, in which case no action is taken. It is possible for
8200 several messages to get sent if there are addresses with different
8205 const uschar * logtod = tod_stamp(tod_log);
8206 address_item * addr;
8208 /* There are weird cases when logging is disabled in the transport. However,
8209 there may not be a transport (address failed by a router). */
8211 f.disable_logging = FALSE;
8212 if (addr_failed->transport)
8213 f.disable_logging = addr_failed->transport->disable_logging;
8216 debug_printf("processing failed address %s\n", addr_failed->address);
8218 /* There are only two ways an address in a bounce message can get here:
8220 (1) When delivery was initially deferred, but has now timed out (in the call
8221 to retry_update() above). We can detect this by testing for
8222 af_retry_timedout. If the address does not have its own errors address,
8223 we arrange to ignore the error.
8225 (2) If delivery failures for bounce messages are being ignored. We can detect
8226 this by testing for af_ignore_error. This will also be set if a bounce
8227 message has been autothawed and the ignore_bounce_errors_after time has
8228 passed. It might also be set if a router was explicitly configured to
8229 ignore errors (errors_to = "").
8231 If neither of these cases obtains, something has gone wrong. Log the
8232 incident, but then ignore the error. */
8234 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
8236 if ( !testflag(addr_failed, af_retry_timedout)
8237 && !addr_failed->prop.ignore_error)
8238 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
8239 "failure is neither frozen nor ignored (it's been ignored)");
8241 addr_failed->prop.ignore_error = TRUE;
8244 /* If the first address on the list has af_ignore_error set, just remove
8245 it from the list, throw away any saved message file, log it, and
8246 mark the recipient done. */
8248 if ( addr_failed->prop.ignore_error
8249 || addr_failed->dsn_flags & rf_dsnflags
8250 && !(addr_failed->dsn_flags & rf_notify_failure)
8254 addr_failed = addr->next;
8255 if (addr->return_filename) Uunlink(addr->return_filename);
8257 #ifndef DISABLE_EVENT
8258 msg_event_raise(US"msg:fail:delivery", addr);
8260 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
8262 !addr->parent ? US"" : US" <",
8263 !addr->parent ? US"" : addr->parent->address,
8264 !addr->parent ? US"" : US">",
8265 addr->prop.ignore_error
8266 ? US"" : US": RFC 3461 DSN, failure notify not requested");
8268 address_done(addr, logtod);
8269 child_done(addr, logtod);
8270 /* Panic-dies on error */
8271 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8274 /* Otherwise, handle the sending of a message. Find the error address for
8275 the first address, then send a message that includes all failed addresses
8276 that have the same error address. */
8279 send_bounce_message(now, logtod);
8282 f.disable_logging = FALSE; /* In case left set */
8284 /* Come here from the mua_wrapper case if routing goes wrong */
8288 /* If there are now no deferred addresses, we are done. Preserve the
8289 message log if so configured, and we are using them. Otherwise, sling it.
8290 Then delete the message itself. */
8298 fname = spool_fname(US"msglog", message_subdir, id, US"");
8299 if (preserve_message_logs)
8302 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8304 if ((rc = Urename(fname, moname)) < 0)
8306 (void)directory_make(spool_directory,
8307 spool_sname(US"msglog.OLD", US""),
8308 MSGLOG_DIRECTORY_MODE, TRUE);
8309 rc = Urename(fname, moname);
8312 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8313 "msglog.OLD directory", fname);
8316 if (Uunlink(fname) < 0)
8317 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8318 fname, strerror(errno));
8321 /* Remove the two message files. */
8323 fname = spool_fname(US"input", message_subdir, id, US"-D");
8324 if (Uunlink(fname) < 0)
8325 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8326 fname, strerror(errno));
8327 fname = spool_fname(US"input", message_subdir, id, US"-H");
8328 if (Uunlink(fname) < 0)
8329 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8330 fname, strerror(errno));
8332 /* Log the end of this message, with queue time if requested. */
8334 if (LOGGING(queue_time_overall))
8335 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8337 log_write(0, LOG_MAIN, "Completed");
8339 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8340 f.deliver_freeze = FALSE;
8342 #ifndef DISABLE_EVENT
8343 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8347 /* If there are deferred addresses, we are keeping this message because it is
8348 not yet completed. Lose any temporary files that were catching output from
8349 pipes for any of the deferred addresses, handle one-time aliases, and see if
8350 the message has been on the queue for so long that it is time to send a warning
8351 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8352 have the same domain, we can set deliver_domain for the expansion of
8353 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8354 the parent's domain.
8356 If all the deferred addresses have an error number that indicates "retry time
8357 not reached", skip sending the warning message, because it won't contain the
8358 reason for the delay. It will get sent at the next real delivery attempt.
8359 Exception: for retries caused by a remote peer we use the error message
8360 store in the retry DB as the reason.
8361 However, if at least one address has tried, we'd better include all of them in
8364 If we can't make a process to send the message, don't worry.
8366 For mailing list expansions we want to send the warning message to the
8367 mailing list manager. We can't do a perfect job here, as some addresses may
8368 have different errors addresses, but if we take the errors address from
8369 each deferred address it will probably be right in most cases.
8371 If addr_defer == +1, it means there was a problem sending an error message
8372 for failed addresses, and there were no "real" deferred addresses. The value
8373 was set just to keep the message on the spool, so there is nothing to do here.
8376 else if (addr_defer != (address_item *)(+1))
8378 uschar * recipients = US"";
8379 BOOL want_warning_msg = FALSE;
8381 deliver_domain = testflag(addr_defer, af_pfr)
8382 ? addr_defer->parent->domain : addr_defer->domain;
8384 for (address_item * addr = addr_defer; addr; addr = addr->next)
8386 address_item * otaddr;
8388 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8392 const uschar *d = testflag(addr, af_pfr)
8393 ? addr->parent->domain : addr->domain;
8395 /* The domain may be unset for an address that has never been routed
8396 because the system filter froze the message. */
8398 if (!d || Ustrcmp(d, deliver_domain) != 0)
8399 deliver_domain = NULL;
8402 if (addr->return_filename) Uunlink(addr->return_filename);
8404 /* Handle the case of one-time aliases. If any address in the ancestry
8405 of this one is flagged, ensure it is in the recipients list, suitably
8406 flagged, and that its parent is marked delivered. */
8408 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8409 if (otaddr->onetime_parent) break;
8414 int t = recipients_count;
8416 for (i = 0; i < recipients_count; i++)
8418 const uschar * r = recipients_list[i].address;
8419 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8420 if (Ustrcmp(otaddr->address, r) == 0) break;
8423 /* Didn't find the address already in the list, and did find the
8424 ultimate parent's address in the list, and they really are different
8425 (i.e. not from an identity-redirect). After adding the recipient,
8426 update the errors address in the recipients list. */
8428 if ( i >= recipients_count && t < recipients_count
8429 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8431 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8432 otaddr->address, otaddr->parent->address);
8433 receive_add_recipient(otaddr->address, t);
8434 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8435 tree_add_nonrecipient(otaddr->parent->address);
8436 update_spool = TRUE;
8440 /* Except for error messages, ensure that either the errors address for
8441 this deferred address or, if there is none, the sender address, is on the
8442 list of recipients for a warning message. */
8444 if (sender_address[0])
8446 const uschar * s = addr->prop.errors_address;
8447 if (!s) s = sender_address;
8448 if (Ustrstr(recipients, s) == NULL)
8449 recipients = string_sprintf("%s%s%s", recipients,
8450 recipients[0] ? "," : "", s);
8454 /* Send a warning message if the conditions are right. If the condition check
8455 fails because of a lookup defer, there is nothing we can do. The warning
8456 is not sent. Another attempt will be made at the next delivery attempt (if
8459 if ( !f.queue_2stage
8461 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8462 || addr_defer->dsn_flags & rf_notify_delay
8464 && delay_warning[1] > 0
8465 && sender_address[0] != 0)
8467 GET_OPTION("delay_warning_condition");
8468 if ( ( !delay_warning_condition
8469 || expand_check_condition(delay_warning_condition,
8470 US"delay_warning", US"option")
8476 int queue_time = time(NULL) - received_time.tv_sec;
8478 queue_time = test_harness_fudged_queue_time(queue_time);
8480 /* See how many warnings we should have sent by now */
8482 for (count = 0; count < delay_warning[1]; count++)
8483 if (queue_time < delay_warning[count+2]) break;
8485 show_time = delay_warning[count+1];
8487 if (count >= delay_warning[1])
8490 int last_gap = show_time;
8491 if (count > 1) last_gap -= delay_warning[count];
8492 extra = (queue_time - delay_warning[count+1])/last_gap;
8493 show_time += last_gap * extra;
8499 debug_printf("time on queue = %s id %s addr %s\n",
8500 readconf_printtime(queue_time), message_id, addr_defer->address);
8501 debug_printf("warning counts: required %d done %d\n", count,
8505 /* We have computed the number of warnings there should have been by now.
8506 If there haven't been enough, send one, and up the count to what it should
8509 if (warning_count < count)
8510 if (send_warning_message(recipients, queue_time, show_time))
8512 warning_count = count;
8513 update_spool = TRUE; /* Ensure spool rewritten */
8518 /* Clear deliver_domain */
8520 deliver_domain = NULL;
8522 /* If this was a first delivery attempt, unset the first time flag, and
8523 ensure that the spool gets updated. */
8525 if (f.deliver_firsttime && !f.queue_2stage)
8527 f.deliver_firsttime = FALSE;
8528 update_spool = TRUE;
8531 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8532 message, unless the message is a local error message (to avoid loops). Then
8533 log the freezing. If the text in "frozen_info" came from a system filter,
8534 it has been escaped into printing characters so as not to mess up log lines.
8535 For the "tell" message, we turn \n back into newline. Also, insert a newline
8536 near the start instead of the ": " string. */
8538 if (f.deliver_freeze)
8540 if (freeze_tell && *freeze_tell && !f.local_error_message)
8542 uschar * s = string_copy(frozen_info);
8543 uschar * ss = Ustrstr(s, " by the system filter: ");
8552 if (*ss == '\\' && ss[1] == 'n')
8553 { *ss++ = ' '; *ss++ = '\n'; }
8557 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8558 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8562 /* Log freezing just before we update the -H file, to minimize the chance
8563 of a race problem. */
8565 deliver_msglog("*** Frozen%s\n", frozen_info);
8566 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8569 /* If there have been any updates to the non-recipients list, or other things
8570 that get written to the spool, we must now update the spool header file so
8571 that it has the right information for the next delivery attempt. If there
8572 was more than one address being delivered, the header_change update is done
8573 earlier, in case one succeeds and then something crashes. */
8576 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8577 update_spool, f.header_rewritten);
8579 if (update_spool || f.header_rewritten)
8580 /* Panic-dies on error */
8581 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8584 /* Finished with the message log. If the message is complete, it will have
8585 been unlinked or renamed above. */
8587 if (message_logs) (void)fclose(message_log);
8589 /* Now we can close and remove the journal file. Its only purpose is to record
8590 successfully completed deliveries asap so that this information doesn't get
8591 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8592 not serious, as trying it again is not harmful. The journal might not be open
8593 if all addresses were deferred at routing or directing. Nevertheless, we must
8594 remove it if it exists (may have been lying around from a crash during the
8595 previous delivery attempt). We don't remove the journal if a delivery
8596 subprocess failed to pass back delivery information; this is controlled by
8597 the remove_journal flag. When the journal is left, we also don't move the
8598 message off the main spool if frozen and the option is set. It should get moved
8599 at the next attempt, after the journal has been inspected. */
8601 if (journal_fd >= 0) (void)close(journal_fd);
8605 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8607 if (Uunlink(fname) < 0 && errno != ENOENT)
8608 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8611 /* Move the message off the spool if requested */
8613 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8614 if (f.deliver_freeze && move_frozen_messages)
8615 (void)spool_move_message(id, message_subdir, US"", US"F");
8619 /* Closing the data file frees the lock; if the file has been unlinked it
8620 will go away. Otherwise the message becomes available for another process
8623 (void)close(deliver_datafile);
8624 deliver_datafile = -1;
8625 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8626 #ifdef MEASURE_TIMING
8627 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8630 /* It is unlikely that there will be any cached resources, since they are
8631 released after routing, and in the delivery subprocesses. However, it's
8632 possible for an expansion for something afterwards (for example,
8633 expand_check_condition) to do a lookup. We must therefore be sure everything is
8637 acl_where = ACL_WHERE_UNKNOWN;
8646 #ifdef EXIM_TFO_PROBE
8649 f.tcp_fastopen_ok = TRUE;
8655 /* Called from a commandline, or from the daemon, to do a delivery.
8656 We need to regain privs; do this by exec of the exim binary. */
8659 delivery_re_exec(int exec_type)
8663 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8665 int channel_fd = cutthrough.cctx.sock;
8667 smtp_peer_options = cutthrough.peer_options;
8668 continue_sequence = 0;
8671 if (cutthrough.is_tls)
8675 smtp_peer_options |= OPTION_TLS;
8676 sending_ip_address = cutthrough.snd_ip;
8677 sending_port = cutthrough.snd_port;
8679 where = US"socketpair";
8680 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8684 testharness_pause_ms(150);
8685 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8688 if (pid == 0) /* child: will fork again to totally disconnect */
8690 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8691 pfd, 5*60, cutthrough.host.name);
8692 /* does not return */
8696 waitpid(pid, NULL, 0);
8697 (void) close(channel_fd); /* release the client socket */
8698 channel_fd = pfd[1];
8702 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8703 cutthrough.host.address, message_id, channel_fd);
8707 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8708 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8710 return; /* compiler quietening; control does not reach here. */
8715 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8716 "delivery re-exec %s failed: %s", where, strerror(errno));
8718 /* Get here if exec_type == CEE_EXEC_EXIT.
8719 Note: this must be _exit(), not exit(). */
8721 _exit(EX_EXECFAILED);
8727 /* End of deliver.c */