1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* The main code for delivering a message. */
14 #include "transports/smtp.h"
19 /* Data block for keeping track of subprocesses for parallel remote
22 typedef struct pardata {
23 address_item *addrlist; /* chain of addresses */
24 address_item *addr; /* next address data expected for */
25 pid_t pid; /* subprocess pid */
26 int fd; /* pipe fd for getting result from subprocess */
27 int transport_count; /* returned transport count value */
28 BOOL done; /* no more data needed */
29 uschar *msg; /* error message */
30 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 uschar *used_return_path = NULL;
84 /*************************************************
85 * read as much as requested *
86 *************************************************/
88 /* The syscall read(2) doesn't always returns as much as we want. For
89 several reasons it might get less. (Not talking about signals, as syscalls
90 are restartable). When reading from a network or pipe connection the sender
91 might send in smaller chunks, with delays between these chunks. The read(2)
92 may return such a chunk.
94 The more the writer writes and the smaller the pipe between write and read is,
95 the more we get the chance of reading leass than requested. (See bug 2130)
97 This function read(2)s until we got all the data we *requested*.
99 Note: This function may block. Use it only if you're sure about the
100 amount of data you will get.
103 fd the file descriptor to read from
104 buffer pointer to a buffer of size len
105 len the requested(!) amount of bytes
107 Returns: the amount of bytes read
110 readn(int fd, void * buffer, size_t len)
112 uschar * next = buffer;
113 uschar * end = next + len;
117 ssize_t got = read(fd, next, end - next);
119 /* I'm not sure if there are signals that can interrupt us,
120 for now I assume the worst */
121 if (got == -1 && errno == EINTR) continue;
122 if (got <= 0) return next - US buffer;
130 /*************************************************
131 * Make a new address item *
132 *************************************************/
134 /* This function gets the store and initializes with default values. The
135 transport_return value defaults to DEFER, so that any unexpected failure to
136 deliver does not wipe out the message. The default unique string is set to a
137 copy of the address, so that its domain can be lowercased.
140 address the RFC822 address string
141 copy force a copy of the address
143 Returns: a pointer to an initialized address_item
147 deliver_make_addr(uschar *address, BOOL copy)
149 address_item * addr = store_get(sizeof(address_item), GET_UNTAINTED);
150 *addr = address_defaults;
151 if (copy) address = string_copy(address);
152 addr->address = address;
153 addr->unique = string_copy(address);
160 /*************************************************
161 * Set expansion values for an address *
162 *************************************************/
164 /* Certain expansion variables are valid only when handling an address or
165 address list. This function sets them up or clears the values, according to its
169 addr the address in question, or NULL to clear values
174 deliver_set_expansions(address_item *addr)
178 const uschar ***p = address_expansions;
179 while (*p) **p++ = NULL;
183 /* Exactly what gets set depends on whether there is one or more addresses, and
184 what they contain. These first ones are always set, taking their values from
185 the first address. */
187 if (!addr->host_list)
189 deliver_host = deliver_host_address = US"";
190 deliver_host_port = 0;
194 deliver_host = addr->host_list->name;
195 deliver_host_address = addr->host_list->address;
196 deliver_host_port = addr->host_list->port;
199 deliver_recipients = addr;
200 deliver_address_data = addr->prop.address_data;
201 deliver_domain_data = addr->prop.domain_data;
202 deliver_localpart_data = addr->prop.localpart_data;
203 router_var = addr->prop.variables;
205 /* These may be unset for multiple addresses */
207 deliver_domain = addr->domain;
208 self_hostname = addr->self_hostname;
210 #ifdef EXPERIMENTAL_BRIGHTMAIL
211 bmi_deliver = 1; /* deliver by default */
212 bmi_alt_location = NULL;
213 bmi_base64_verdict = NULL;
214 bmi_base64_tracker_verdict = NULL;
217 /* If there's only one address we can set everything. */
221 address_item *addr_orig;
223 deliver_localpart = addr->local_part;
224 deliver_localpart_prefix = addr->prefix;
225 deliver_localpart_prefix_v = addr->prefix_v;
226 deliver_localpart_suffix = addr->suffix;
227 deliver_localpart_suffix_v = addr->suffix_v;
229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230 deliver_domain_orig = addr_orig->domain;
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
251 deliver_domain_parent = addr->parent->domain;
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
261 if (testflag(addr, af_pfr))
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
267 deliver_localpart_prefix_v = addr->parent->prefix_v;
268 deliver_localpart_suffix = addr->parent->suffix;
269 deliver_localpart_suffix_v = addr->parent->suffix_v;
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
280 if (bmi_deliver == 1)
281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
293 if (testflag(addr, af_pfr))
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301 deliver_domain = NULL;
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
306 self_hostname = NULL;
307 if (!deliver_domain && !self_hostname) break;
315 /*************************************************
316 * Open a msglog file *
317 *************************************************/
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
324 Called from deliver_message(), can be operating as root.
327 filename the file name
328 mode the mode required
329 error used for saying what failed
331 Returns: a file descriptor, or -1 (with errno set)
335 open_msglog_file(uschar *filename, int mode, uschar **error)
337 if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
341 for (int i = 2; i > 0; i--)
343 int fd = Uopen(filename,
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(uschar *one, 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(uschar * action, const uschar * event, uschar * ev_data, int * errnop)
868 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
870 action, deliver_host_address);
873 event_data = ev_data;
875 if (!(s = expand_string(action)) && *expand_string_message)
876 log_write(0, LOG_MAIN|LOG_PANIC,
877 "failed to expand event_action %s in %s: %s\n",
878 event, transport_name ? transport_name : US"main", expand_string_message);
880 event_name = event_data = NULL;
882 /* If the expansion returns anything but an empty string, flag for
883 the caller to modify his normal processing
888 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
890 *errnop = ERRNO_EVENT;
898 msg_event_raise(const uschar * event, const address_item * addr)
900 const uschar * save_domain = deliver_domain;
901 uschar * save_local = deliver_localpart;
902 const uschar * save_host = deliver_host;
903 const uschar * save_address = deliver_host_address;
904 const int save_port = deliver_host_port;
906 router_name = addr->router ? addr->router->name : NULL;
907 deliver_domain = addr->domain;
908 deliver_localpart = addr->local_part;
909 deliver_host = addr->host_used ? addr->host_used->name : NULL;
911 if (!addr->transport)
913 if (Ustrcmp(event, "msg:fail:delivery") == 0)
915 /* An address failed with no transport involved. This happens when
916 a filter was used which triggered a fail command (in such a case
917 a transport isn't needed). Convert it to an internal fail event. */
919 (void) event_raise(event_action, US"msg:fail:internal", addr->message, NULL);
924 transport_name = addr->transport->name;
926 (void) event_raise(addr->transport->event_action, event,
928 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
929 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
930 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
931 ? addr->message : NULL,
935 deliver_host_port = save_port;
936 deliver_host_address = save_address;
937 deliver_host = save_host;
938 deliver_localpart = save_local;
939 deliver_domain = save_domain;
940 router_name = transport_name = NULL;
942 #endif /*DISABLE_EVENT*/
946 /******************************************************************************/
949 /*************************************************
950 * Generate local part for logging *
951 *************************************************/
954 string_get_lpart_sub(const address_item * addr, uschar * s)
957 if (testflag(addr, af_utf8_downcvt))
959 uschar * t = string_localpart_utf8_to_alabel(s, NULL);
960 return t ? t : s; /* t is NULL on a failed conversion */
966 /* This function is a subroutine for use in string_log_address() below.
969 addr the address being logged
970 yield the current dynamic buffer pointer
972 Returns: the new value of the buffer pointer
976 string_get_localpart(address_item * addr, gstring * yield)
980 if (testflag(addr, af_include_affixes) && (s = addr->prefix))
981 yield = string_cat(yield, string_get_lpart_sub(addr, s));
983 yield = string_cat(yield, string_get_lpart_sub(addr, addr->local_part));
985 if (testflag(addr, af_include_affixes) && (s = addr->suffix))
986 yield = string_cat(yield, string_get_lpart_sub(addr, s));
992 /*************************************************
993 * Generate log address list *
994 *************************************************/
996 /* This function generates a list consisting of an address and its parents, for
997 use in logging lines. For saved onetime aliased addresses, the onetime parent
998 field is used. If the address was delivered by a transport with rcpt_include_
999 affixes set, the af_include_affixes bit will be set in the address. In that
1000 case, we include the affixes here too.
1003 g points to growing-string struct
1004 addr bottom (ultimate) address
1005 all_parents if TRUE, include all parents
1006 success TRUE for successful delivery
1008 Returns: a growable string in dynamic store
1012 string_log_address(gstring * g,
1013 address_item *addr, BOOL all_parents, BOOL success)
1015 BOOL add_topaddr = TRUE;
1016 address_item *topaddr;
1018 /* Find the ultimate parent */
1020 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1022 /* We start with just the local part for pipe, file, and reply deliveries, and
1023 for successful local deliveries from routers that have the log_as_local flag
1024 set. File deliveries from filters can be specified as non-absolute paths in
1025 cases where the transport is going to complete the path. If there is an error
1026 before this happens (expansion failure) the local part will not be updated, and
1027 so won't necessarily look like a path. Add extra text for this case. */
1029 if ( testflag(addr, af_pfr)
1031 && addr->router && addr->router->log_as_local
1032 && addr->transport && addr->transport->info->local
1035 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1036 g = string_catn(g, CUS"save ", 5);
1037 g = string_get_localpart(addr, g);
1040 /* Other deliveries start with the full address. It we have split it into local
1041 part and domain, use those fields. Some early failures can happen before the
1042 splitting is done; in those cases use the original field. */
1047 int off = gstring_length(g); /* start of the "full address" */
1049 if (addr->local_part)
1052 g = string_get_localpart(addr, g);
1053 g = string_catn(g, US"@", 1);
1056 if (testflag(addr, af_utf8_downcvt))
1057 s = string_localpart_utf8_to_alabel(s, NULL);
1059 g = string_cat(g, s);
1062 g = string_cat(g, addr->address);
1064 /* If the address we are going to print is the same as the top address,
1065 and all parents are not being included, don't add on the top address. First
1066 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1067 on the local parts. */
1069 cmp = g->s + off; /* only now, as rebuffer likely done */
1070 string_from_gstring(g); /* ensure nul-terminated */
1071 if ( strcmpic(cmp, topaddr->address) == 0
1072 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1073 && !addr->onetime_parent
1074 && (!all_parents || !addr->parent || addr->parent == topaddr)
1076 add_topaddr = FALSE;
1079 /* If all parents are requested, or this is a local pipe/file/reply, and
1080 there is at least one intermediate parent, show it in brackets, and continue
1081 with all of them if all are wanted. */
1083 if ( (all_parents || testflag(addr, af_pfr))
1085 && addr->parent != topaddr)
1088 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1090 g = string_catn(g, s, 2);
1091 g = string_cat (g, addr2->address);
1092 if (!all_parents) break;
1095 g = string_catn(g, US")", 1);
1098 /* Add the top address if it is required */
1101 g = string_append(g, 3,
1103 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1111 /******************************************************************************/
1115 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1116 this is a nonstandard call; no two-character delivery flag is written
1117 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1120 flags passed to log_write()
1123 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1125 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1128 /* Log the delivery on the main log. We use an extensible string to build up
1129 the log line, and reset the store afterwards. Remote deliveries should always
1130 have a pointer to the host item that succeeded; local deliveries can have a
1131 pointer to a single host item in their host list, for use by the transport. */
1133 #ifndef DISABLE_EVENT
1134 /* presume no successful remote delivery */
1135 lookup_dnssec_authenticated = NULL;
1138 reset_point = store_mark();
1139 g = string_get_tainted(256, GET_TAINTED); /* addrs will be tainted, so avoid copy */
1142 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1145 g->s[0] = logchar; g->ptr = 1;
1146 g = string_catn(g, US"> ", 2);
1148 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1150 if (LOGGING(sender_on_delivery) || msg)
1151 g = string_append(g, 3, US" F=<",
1153 testflag(addr, af_utf8_downcvt)
1154 ? string_address_utf8_to_alabel(sender_address, NULL)
1161 g = string_append(g, 2, US" Q=", queue_name);
1163 /* You might think that the return path must always be set for a successful
1164 delivery; indeed, I did for some time, until this statement crashed. The case
1165 when it is not set is for a delivery to /dev/null which is optimised by not
1166 being run at all. */
1168 if (used_return_path && LOGGING(return_path_on_delivery))
1169 g = string_append(g, 3, US" P=<", used_return_path, US">");
1172 g = string_append(g, 2, US" ", msg);
1174 /* For a delivery from a system filter, there may not be a router */
1176 g = string_append(g, 2, US" R=", addr->router->name);
1178 g = string_append(g, 2, US" T=", addr->transport->name);
1180 if (LOGGING(delivery_size))
1181 g = string_fmt_append(g, " S=%d", transport_count);
1183 /* Local delivery */
1185 if (addr->transport->info->local)
1187 if (addr->host_list)
1188 g = string_append(g, 2, US" H=", addr->host_list->name);
1189 g = d_log_interface(g);
1190 if (addr->shadow_message)
1191 g = string_cat(g, addr->shadow_message);
1194 /* Remote delivery */
1198 if (addr->host_used)
1200 g = d_hostlog(g, addr);
1202 #ifndef DISABLE_EVENT
1203 deliver_host_address = addr->host_used->address;
1204 deliver_host_port = addr->host_used->port;
1205 deliver_host = addr->host_used->name;
1207 /* DNS lookup status */
1208 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1209 : addr->host_used->dnssec==DS_NO ? US"no"
1215 g = d_tlslog(g, addr);
1218 if (addr->authenticator)
1220 g = string_append(g, 2, US" A=", addr->authenticator);
1223 g = string_append(g, 2, US":", addr->auth_id);
1224 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1225 g = string_append(g, 2, US":", addr->auth_sndr);
1229 if (LOGGING(pipelining))
1231 if (testflag(addr, af_pipelining))
1232 g = string_catn(g, US" L", 2);
1233 #ifndef DISABLE_PIPE_CONNECT
1234 if (testflag(addr, af_early_pipe))
1235 g = string_catn(g, US"*", 1);
1239 #ifndef DISABLE_PRDR
1240 if (testflag(addr, af_prdr_used))
1241 g = string_catn(g, US" PRDR", 5);
1244 if (testflag(addr, af_chunking_used))
1245 g = string_catn(g, US" K", 2);
1248 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1250 if ( LOGGING(smtp_confirmation)
1252 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1255 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1256 uschar *p = big_buffer;
1257 uschar *ss = addr->message;
1259 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1261 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1266 g = string_append(g, 2, US" C=", big_buffer);
1269 /* Time on queue and actual time taken to deliver */
1271 if (LOGGING(queue_time))
1272 g = string_append(g, 2, US" QT=", string_timesince(
1273 LOGGING(queue_time_exclusive) ? &received_time_complete : &received_time));
1275 if (LOGGING(deliver_time))
1276 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1278 /* string_cat() always leaves room for the terminator. Release the
1279 store we used to build the line after writing it. */
1281 log_write(0, flags, "%Y", g);
1283 #ifndef DISABLE_EVENT
1284 if (!msg) msg_event_raise(US"msg:delivery", addr);
1287 store_reset(reset_point);
1294 deferral_log(address_item * addr, uschar * now,
1295 int logflags, uschar * driver_name, uschar * driver_kind)
1297 rmark reset_point = store_mark();
1298 gstring * g = string_get(256);
1300 /* Build up the line that is used for both the message log and the main
1303 /* Create the address string for logging. Must not do this earlier, because
1304 an OK result may be changed to FAIL when a pipe returns text. */
1306 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1309 g = string_append(g, 2, US" Q=", queue_name);
1311 /* Either driver_name contains something and driver_kind contains
1312 " router" or " transport" (note the leading space), or driver_name is
1313 a null string and driver_kind contains "routing" without the leading
1314 space, if all routing has been deferred. When a domain has been held,
1315 so nothing has been done at all, both variables contain null strings. */
1319 if (driver_kind[1] == 't' && addr->router)
1320 g = string_append(g, 2, US" R=", addr->router->name);
1321 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1323 else if (driver_kind)
1324 g = string_append(g, 2, US" ", driver_kind);
1326 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1328 if (addr->basic_errno > 0)
1329 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1331 if (addr->host_used)
1332 g = d_hostlog(g, addr);
1334 if (LOGGING(deliver_time))
1335 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1338 g = string_append(g, 2, US": ", addr->message);
1340 /* Log the deferment in the message log, but don't clutter it
1341 up with retry-time defers after the first delivery attempt. */
1343 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1344 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1346 /* Write the main log and reset the store.
1347 For errors of the type "retry time not reached" (also remotes skipped
1348 on queue run), logging is controlled by L_retry_defer. Note that this kind
1349 of error number is negative, and all the retry ones are less than any
1353 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1356 store_reset(reset_point);
1363 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1365 rmark reset_point = store_mark();
1366 gstring * g = string_get(256);
1368 #ifndef DISABLE_EVENT
1369 /* Message failures for which we will send a DSN get their event raised
1370 later so avoid doing it here. */
1372 if ( !addr->prop.ignore_error
1373 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1375 msg_event_raise(US"msg:fail:delivery", addr);
1378 /* Build up the log line for the message and main logs */
1380 /* Create the address string for logging. Must not do this earlier, because
1381 an OK result may be changed to FAIL when a pipe returns text. */
1383 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1385 if (LOGGING(sender_on_delivery))
1386 g = string_append(g, 3, US" F=<", sender_address, US">");
1389 g = string_append(g, 2, US" Q=", queue_name);
1391 /* Return path may not be set if no delivery actually happened */
1393 if (used_return_path && LOGGING(return_path_on_delivery))
1394 g = string_append(g, 3, US" P=<", used_return_path, US">");
1397 g = string_append(g, 2, US" R=", addr->router->name);
1398 if (addr->transport)
1399 g = string_append(g, 2, US" T=", addr->transport->name);
1401 if (addr->host_used)
1402 g = d_hostlog(g, addr);
1405 g = d_tlslog(g, addr);
1408 if (addr->basic_errno > 0)
1409 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1412 g = string_append(g, 2, US": ", addr->message);
1414 if (LOGGING(deliver_time))
1415 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1417 /* Do the logging. For the message log, "routing failed" for those cases,
1418 just to make it clearer. */
1421 deliver_msglog("%s %s failed for %.*s\n", now, driver_kind, g->ptr, g->s);
1423 deliver_msglog("%s %.*s\n", now, g->ptr, g->s);
1425 log_write(0, LOG_MAIN, "** %Y", g);
1427 store_reset(reset_point);
1433 /*************************************************
1434 * Actions at the end of handling an address *
1435 *************************************************/
1437 /* This is a function for processing a single address when all that can be done
1438 with it has been done.
1441 addr points to the address block
1442 result the result of the delivery attempt
1443 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1444 driver_type indicates which type of driver (transport, or router) was last
1445 to process the address
1446 logchar '=' or '-' for use when logging deliveries with => or ->
1452 post_process_one(address_item * addr, int result, int logflags, int driver_type,
1455 uschar * now = tod_stamp(tod_log);
1456 uschar * driver_kind = NULL;
1457 uschar * driver_name = NULL;
1459 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1461 /* Set up driver kind and name for logging. Disable logging if the router or
1462 transport has disabled it. */
1464 if (driver_type == EXIM_DTYPE_TRANSPORT)
1466 if (addr->transport)
1468 driver_name = addr->transport->name;
1469 driver_kind = US" transport";
1470 f.disable_logging = addr->transport->disable_logging;
1472 else driver_kind = US"transporting";
1474 else if (driver_type == EXIM_DTYPE_ROUTER)
1478 driver_name = addr->router->name;
1479 driver_kind = US" router";
1480 f.disable_logging = addr->router->disable_logging;
1482 else driver_kind = US"routing";
1485 /* If there's an error message set, ensure that it contains only printing
1486 characters - it should, but occasionally things slip in and this at least
1487 stops the log format from getting wrecked. We also scan the message for an LDAP
1488 expansion item that has a password setting, and flatten the password. This is a
1489 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1490 malformed, it won't ever have gone near LDAP.) */
1494 const uschar * s = string_printing(addr->message);
1496 /* deconst cast ok as string_printing known to have alloc'n'copied */
1497 addr->message = expand_hide_passwords(US s);
1500 /* If we used a transport that has one of the "return_output" options set, and
1501 if it did in fact generate some output, then for return_output we treat the
1502 message as failed if it was not already set that way, so that the output gets
1503 returned to the sender, provided there is a sender to send it to. For
1504 return_fail_output, do this only if the delivery failed. Otherwise we just
1505 unlink the file, and remove the name so that if the delivery failed, we don't
1506 try to send back an empty or unwanted file. The log_output options operate only
1507 on a non-empty file.
1509 In any case, we close the message file, because we cannot afford to leave a
1510 file-descriptor for one address while processing (maybe very many) others. */
1512 if (addr->return_file >= 0 && addr->return_filename)
1514 BOOL return_output = FALSE;
1515 struct stat statbuf;
1516 (void)EXIMfsync(addr->return_file);
1518 /* If there is no output, do nothing. */
1520 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1522 transport_instance *tb = addr->transport;
1524 /* Handle logging options */
1527 || result == FAIL && tb->log_fail_output
1528 || result == DEFER && tb->log_defer_output
1532 FILE *f = Ufopen(addr->return_filename, "rb");
1534 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1535 "from %s transport: %s", addr->return_filename, tb->name,
1538 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1540 uschar *p = big_buffer + Ustrlen(big_buffer);
1542 while (p > big_buffer && isspace(p[-1])) p--;
1544 sp = string_printing(big_buffer);
1545 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1546 addr->address, tb->name, sp);
1551 /* Handle returning options, but only if there is an address to return
1554 if (sender_address[0] != 0 || addr->prop.errors_address)
1555 if (tb->return_output)
1557 addr->transport_return = result = FAIL;
1558 if (addr->basic_errno == 0 && !addr->message)
1559 addr->message = US"return message generated";
1560 return_output = TRUE;
1563 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1566 /* Get rid of the file unless it might be returned, but close it in
1571 Uunlink(addr->return_filename);
1572 addr->return_filename = NULL;
1573 addr->return_file = -1;
1576 (void)close(addr->return_file);
1579 /* Check if the transport notifed continue-conn status explicitly, and
1580 update our knowlege. */
1582 if (testflag(addr, af_new_conn)) continue_sequence = 1;
1583 else if (testflag(addr, af_cont_conn)) continue_sequence++;
1585 /* The success case happens only after delivery by a transport. */
1589 addr->next = addr_succeed;
1590 addr_succeed = addr;
1592 /* Call address_done() to ensure that we don't deliver to this address again,
1593 and write appropriate things to the message log. If it is a child address, we
1594 call child_done() to scan the ancestors and mark them complete if this is the
1595 last child to complete. */
1597 address_done(addr, now);
1598 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1601 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1602 driver_name, driver_kind);
1605 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1606 addr->parent->address, driver_name, driver_kind);
1607 child_done(addr, now);
1610 /* Certificates for logging (via events) */
1612 tls_out.ourcert = addr->ourcert;
1613 addr->ourcert = NULL;
1614 tls_out.peercert = addr->peercert;
1615 addr->peercert = NULL;
1617 tls_out.ver = addr->tlsver;
1618 tls_out.cipher = addr->cipher;
1619 tls_out.peerdn = addr->peerdn;
1620 tls_out.ocsp = addr->ocsp;
1621 # ifdef SUPPORT_DANE
1622 tls_out.dane_verified = testflag(addr, af_dane_verified);
1626 delivery_log(LOG_MAIN, addr, logchar, NULL);
1629 tls_free_cert(&tls_out.ourcert);
1630 tls_free_cert(&tls_out.peercert);
1632 tls_out.cipher = NULL;
1633 tls_out.peerdn = NULL;
1634 tls_out.ocsp = OCSP_NOT_REQ;
1635 # ifdef SUPPORT_DANE
1636 tls_out.dane_verified = FALSE;
1642 /* Soft failure, or local delivery process failed; freezing may be
1645 else if (result == DEFER || result == PANIC)
1647 if (result == PANIC) logflags |= LOG_PANIC;
1649 /* This puts them on the chain in reverse order. Do not change this, because
1650 the code for handling retries assumes that the one with the retry
1651 information is last. */
1653 addr->next = addr_defer;
1656 /* The only currently implemented special action is to freeze the
1657 message. Logging of this is done later, just before the -H file is
1660 if (addr->special_action == SPECIAL_FREEZE)
1662 f.deliver_freeze = TRUE;
1663 deliver_frozen_at = time(NULL);
1664 update_spool = TRUE;
1667 /* If doing a 2-stage queue run, we skip writing to either the message
1668 log or the main log for SMTP defers. */
1670 if (!f.queue_2stage || addr->basic_errno != 0)
1671 deferral_log(addr, now, logflags, driver_name, driver_kind);
1675 /* Hard failure. If there is an address to which an error message can be sent,
1676 put this address on the failed list. If not, put it on the deferred list and
1677 freeze the mail message for human attention. The latter action can also be
1678 explicitly requested by a router or transport. */
1682 /* If this is a delivery error, or a message for which no replies are
1683 wanted, and the message's age is greater than ignore_bounce_errors_after,
1684 force the af_ignore_error flag. This will cause the address to be discarded
1685 later (with a log entry). */
1687 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1688 addr->prop.ignore_error = TRUE;
1690 /* Freeze the message if requested, or if this is a bounce message (or other
1691 message with null sender) and this address does not have its own errors
1692 address. However, don't freeze if errors are being ignored. The actual code
1693 to ignore occurs later, instead of sending a message. Logging of freezing
1694 occurs later, just before writing the -H file. */
1696 if ( !addr->prop.ignore_error
1697 && ( addr->special_action == SPECIAL_FREEZE
1698 || (sender_address[0] == 0 && !addr->prop.errors_address)
1701 frozen_info = addr->special_action == SPECIAL_FREEZE
1703 : f.sender_local && !f.local_error_message
1704 ? US" (message created with -f <>)"
1705 : US" (delivery error message)";
1706 f.deliver_freeze = TRUE;
1707 deliver_frozen_at = time(NULL);
1708 update_spool = TRUE;
1710 /* The address is put on the defer rather than the failed queue, because
1711 the message is being retained. */
1713 addr->next = addr_defer;
1717 /* Don't put the address on the nonrecipients tree yet; wait until an
1718 error message has been successfully sent. */
1722 addr->next = addr_failed;
1726 failure_log(addr, driver_name ? NULL : driver_kind, now);
1729 /* Ensure logging is turned on again in all cases */
1731 f.disable_logging = FALSE;
1737 /*************************************************
1738 * Address-independent error *
1739 *************************************************/
1741 /* This function is called when there's an error that is not dependent on a
1742 particular address, such as an expansion string failure. It puts the error into
1743 all the addresses in a batch, logs the incident on the main and panic logs, and
1744 clears the expansions. It is mostly called from local_deliver(), but can be
1745 called for a remote delivery via findugid().
1748 logit TRUE if (MAIN+PANIC) logging required
1749 addr the first of the chain of addresses
1751 format format string for error message, or NULL if already set in addr
1752 ... arguments for the format
1758 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1760 addr->basic_errno = code;
1767 va_start(ap, format);
1768 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1770 addr->message = string_from_gstring(g);
1773 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1775 addr2->basic_errno = code;
1776 addr2->message = addr->message;
1779 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1780 deliver_set_expansions(NULL);
1786 /*************************************************
1787 * Check a "never users" list *
1788 *************************************************/
1790 /* This function is called to check whether a uid is on one of the two "never
1794 uid the uid to be checked
1795 nusers the list to be scanned; the first item in the list is the count
1797 Returns: TRUE if the uid is on the list
1801 check_never_users(uid_t uid, uid_t *nusers)
1803 if (!nusers) return FALSE;
1804 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1810 /*************************************************
1811 * Find uid and gid for a transport *
1812 *************************************************/
1814 /* This function is called for both local and remote deliveries, to find the
1815 uid/gid under which to run the delivery. The values are taken preferentially
1816 from the transport (either explicit or deliver_as_creator), then from the
1817 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1818 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1819 panic error is logged, and the function fails (which normally leads to delivery
1823 addr the address (possibly a chain)
1825 uidp pointer to uid field
1826 gidp pointer to gid field
1827 igfp pointer to the use_initgroups field
1829 Returns: FALSE if failed - error has been set in address(es)
1833 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1837 BOOL gid_set = FALSE;
1839 /* Default initgroups flag comes from the transport */
1841 *igfp = tp->initgroups;
1843 /* First see if there's a gid on the transport, either fixed or expandable.
1844 The expanding function always logs failure itself. */
1851 else if (tp->expand_gid)
1853 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1856 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1862 /* If the transport did not set a group, see if the router did. */
1864 if (!gid_set && testflag(addr, af_gid_set))
1870 /* Pick up a uid from the transport if one is set. */
1872 if (tp->uid_set) *uidp = tp->uid;
1874 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1875 it does not provide a passwd value from which a gid can be taken. */
1877 else if (tp->expand_uid)
1880 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1881 uidp, &(addr->message)))
1883 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1893 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1895 else if (tp->deliver_as_creator)
1897 *uidp = originator_uid;
1900 *gidp = originator_gid;
1905 /* Otherwise see if the address specifies the uid and if so, take it and its
1908 else if (testflag(addr, af_uid_set))
1911 *igfp = testflag(addr, af_initgroups);
1914 /* Nothing has specified the uid - default to the Exim user, and group if the
1927 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1928 defaulting to the Exim uid. In other words, if the configuration has specified
1929 a uid, it must also provide a gid. */
1933 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1934 "%s transport", tp->name);
1938 /* Check that the uid is not on the lists of banned uids that may not be used
1939 for delivery processes. */
1941 nuname = check_never_users(*uidp, never_users)
1943 : check_never_users(*uidp, fixed_never_users)
1944 ? US"fixed_never_users"
1948 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1949 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1961 /*************************************************
1962 * Check the size of a message for a transport *
1963 *************************************************/
1965 /* Checks that the message isn't too big for the selected transport.
1966 This is called only when it is known that the limit is set.
1970 addr the (first) address being delivered
1973 DEFER expansion failed or did not yield an integer
1974 FAIL message too big
1978 check_message_size(transport_instance *tp, address_item *addr)
1983 deliver_set_expansions(addr);
1984 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1985 deliver_set_expansions(NULL);
1987 if (expand_string_message)
1990 addr->message = size_limit == -1
1991 ? string_sprintf("failed to expand message_size_limit "
1992 "in %s transport: %s", tp->name, expand_string_message)
1993 : string_sprintf("invalid message_size_limit "
1994 "in %s transport: %s", tp->name, expand_string_message);
1996 else if (size_limit > 0 && message_size > size_limit)
2000 string_sprintf("message is too big (transport limit = %d)",
2009 /*************************************************
2010 * Transport-time check for a previous delivery *
2011 *************************************************/
2013 /* Check that this base address hasn't previously been delivered to its routed
2014 transport. If it has been delivered, mark it done. The check is necessary at
2015 delivery time in order to handle homonymic addresses correctly in cases where
2016 the pattern of redirection changes between delivery attempts (so the unique
2017 fields change). Non-homonymic previous delivery is detected earlier, at routing
2018 time (which saves unnecessary routing).
2021 addr the address item
2022 testing TRUE if testing wanted only, without side effects
2024 Returns: TRUE if previously delivered by the transport
2028 previously_transported(address_item *addr, BOOL testing)
2030 uschar * s = string_sprintf("%s/%s",
2031 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2033 if (tree_search(tree_nonrecipients, s) != 0)
2035 DEBUG(D_deliver|D_route|D_transport)
2036 debug_printf("%s was previously delivered (%s transport): discarded\n",
2037 addr->address, addr->transport->name);
2038 if (!testing) child_done(addr, tod_stamp(tod_log));
2047 /******************************************************
2048 * Check for a given header in a header string *
2049 ******************************************************/
2051 /* This function is used when generating quota warnings. The configuration may
2052 specify any header lines it likes in quota_warn_message. If certain of them are
2053 missing, defaults are inserted, so we need to be able to test for the presence
2057 hdr the required header name
2058 hstring the header string
2060 Returns: TRUE the header is in the string
2061 FALSE the header is not in the string
2065 contains_header(uschar *hdr, uschar *hstring)
2067 int len = Ustrlen(hdr);
2068 uschar *p = hstring;
2071 if (strncmpic(p, hdr, len) == 0)
2074 while (*p == ' ' || *p == '\t') p++;
2075 if (*p == ':') return TRUE;
2077 while (*p != 0 && *p != '\n') p++;
2078 if (*p == '\n') p++;
2086 /*************************************************
2087 * Perform a local delivery *
2088 *************************************************/
2090 /* Each local delivery is performed in a separate process which sets its
2091 uid and gid as specified. This is a safer way than simply changing and
2092 restoring using seteuid(); there is a body of opinion that seteuid()
2093 cannot be used safely. From release 4, Exim no longer makes any use of
2094 it for delivery. Besides, not all systems have seteuid().
2096 If the uid/gid are specified in the transport_instance, they are used; the
2097 transport initialization must ensure that either both or neither are set.
2098 Otherwise, the values associated with the address are used. If neither are set,
2099 it is a configuration error.
2101 The transport or the address may specify a home directory (transport over-
2102 rides), and if they do, this is set as $home. If neither have set a working
2103 directory, this value is used for that as well. Otherwise $home is left unset
2104 and the cwd is set to "/" - a directory that should be accessible to all users.
2106 Using a separate process makes it more complicated to get error information
2107 back. We use a pipe to pass the return code and also an error code and error
2108 text string back to the parent process.
2111 addr points to an address block for this delivery; for "normal" local
2112 deliveries this is the only address to be delivered, but for
2113 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2114 a number of addresses can be handled simultaneously, and in this
2115 case addr will point to a chain of addresses with the same
2118 shadowing TRUE if running a shadow transport; this causes output from pipes
2125 deliver_local(address_item *addr, BOOL shadowing)
2127 BOOL use_initgroups;
2130 int status, len, rc;
2133 uschar *working_directory;
2134 address_item *addr2;
2135 transport_instance *tp = addr->transport;
2137 /* Set up the return path from the errors or sender address. If the transport
2138 has its own return path setting, expand it and replace the existing value. */
2140 if(addr->prop.errors_address)
2141 return_path = addr->prop.errors_address;
2143 return_path = sender_address;
2145 if (tp->return_path)
2147 uschar * new_return_path = expand_string(tp->return_path);
2148 if (new_return_path)
2149 return_path = new_return_path;
2150 else if (!f.expand_string_forcedfail)
2152 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2153 US"Failed to expand return path \"%s\" in %s transport: %s",
2154 tp->return_path, tp->name, expand_string_message);
2159 /* For local deliveries, one at a time, the value used for logging can just be
2160 set directly, once and for all. */
2162 used_return_path = return_path;
2164 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2165 gets put into the address(es), and the expansions are unset, so we can just
2168 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2170 /* See if either the transport or the address specifies a home directory. A
2171 home directory set in the address may already be expanded; a flag is set to
2172 indicate that. In other cases we must expand it. */
2174 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2175 || ( (deliver_home = addr->home_dir) /* Set in address and */
2176 && !testflag(addr, af_home_expanded) /* not expanded */
2179 uschar *rawhome = deliver_home;
2180 deliver_home = NULL; /* in case it contains $home */
2181 if (!(deliver_home = expand_string(rawhome)))
2183 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2184 "to expand for %s transport: %s", rawhome, tp->name,
2185 expand_string_message);
2188 if (*deliver_home != '/')
2190 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2191 "is not absolute for %s transport", deliver_home, tp->name);
2196 /* See if either the transport or the address specifies a current directory,
2197 and if so, expand it. If nothing is set, use the home directory, unless it is
2198 also unset in which case use "/", which is assumed to be a directory to which
2199 all users have access. It is necessary to be in a visible directory for some
2200 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2201 2.5) require this. */
2203 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2204 if (working_directory)
2206 uschar *raw = working_directory;
2207 if (!(working_directory = expand_string(raw)))
2209 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2210 "failed to expand for %s transport: %s", raw, tp->name,
2211 expand_string_message);
2214 if (*working_directory != '/')
2216 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2217 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2221 else working_directory = deliver_home ? deliver_home : US"/";
2223 /* If one of the return_output flags is set on the transport, create and open a
2224 file in the message log directory for the transport to write its output onto.
2225 This is mainly used by pipe transports. The file needs to be unique to the
2226 address. This feature is not available for shadow transports. */
2229 && ( tp->return_output || tp->return_fail_output
2230 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2235 addr->return_filename =
2236 spool_fname(US"msglog", message_subdir, message_id,
2237 string_sprintf("-%d-%d", getpid(), return_count++));
2239 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2241 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2242 "to return message: %s", error, tp->name, strerror(errno));
2247 /* Create the pipe for inter-process communication. */
2251 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2256 /* Now fork the process to do the real work in the subprocess, but first
2257 ensure that all cached resources are freed so that the subprocess starts with
2258 a clean slate and doesn't interfere with the parent process. */
2262 if ((pid = exim_fork(US"delivery-local")) == 0)
2264 BOOL replicate = TRUE;
2266 /* Prevent core dumps, as we don't want them in users' home directories.
2267 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2268 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2269 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2270 complain if the error is "not supported".
2272 There are two scenarios where changing the max limit has an effect. In one,
2273 the user is using a .forward and invoking a command of their choice via pipe;
2274 for these, we do need the max limit to be 0 unless the admin chooses to
2275 permit an increased limit. In the other, the command is invoked directly by
2276 the transport and is under administrator control, thus being able to raise
2277 the limit aids in debugging. So there's no general always-right answer.
2279 Thus we inhibit core-dumps completely but let individual transports, while
2280 still root, re-raise the limits back up to aid debugging. We make the
2281 default be no core-dumps -- few enough people can use core dumps in
2282 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2289 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2291 # ifdef SETRLIMIT_NOT_SUPPORTED
2292 if (errno != ENOSYS && errno != ENOTSUP)
2294 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2299 /* Reset the random number generator, so different processes don't all
2300 have the same sequence. */
2304 /* If the transport has a setup entry, call this first, while still
2305 privileged. (Appendfile uses this to expand quota, for example, while
2306 able to read private files.) */
2308 if (addr->transport->setup)
2309 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2313 addr->transport_return = DEFER;
2317 addr->transport_return = PANIC;
2321 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2322 when the process becomes unprivileged, it won't be able to write to the
2323 process log. SIGHUP is ignored throughout exim, except when it is being
2326 signal(SIGINT, SIG_IGN);
2327 signal(SIGTERM, SIG_IGN);
2328 signal(SIGUSR1, SIG_IGN);
2330 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2331 half - for transports that exec things (e.g. pipe). Then set the required
2334 (void)close(pfd[pipe_read]);
2335 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2337 exim_setugid(uid, gid, use_initgroups,
2338 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2339 addr->address, addr->transport->name));
2343 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2344 for (address_item * batched = addr->next; batched; batched = batched->next)
2345 debug_printf("additional batched address: %s\n", batched->address);
2348 /* Set an appropriate working directory. */
2350 if (Uchdir(working_directory) < 0)
2352 addr->transport_return = DEFER;
2353 addr->basic_errno = errno;
2354 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2357 /* If successful, call the transport */
2362 set_process_info("delivering %s to %s using %s", message_id,
2363 addr->local_part, tp->name);
2365 /* Setting these globals in the subprocess means we need never clear them */
2367 transport_name = tp->name;
2368 if (addr->router) router_name = addr->router->name;
2369 driver_srcfile = tp->srcfile;
2370 driver_srcline = tp->srcline;
2372 /* If a transport filter has been specified, set up its argument list.
2373 Any errors will get put into the address, and FALSE yielded. */
2375 if (tp->filter_command)
2377 ok = transport_set_up_command(&transport_filter_argv,
2379 TSUC_EXPAND_ARGS, PANIC, addr, US"transport filter", NULL);
2380 transport_filter_timeout = tp->filter_timeout;
2382 else transport_filter_argv = NULL;
2386 debug_print_string(tp->debug_string);
2387 replicate = !(tp->info->code)(addr->transport, addr);
2391 /* Pass the results back down the pipe. If necessary, first replicate the
2392 status in the top address to the others in the batch. The label is the
2393 subject of a goto when a call to the transport's setup function fails. We
2394 pass the pointer to the transport back in case it got changed as a result of
2395 file_format in appendfile. */
2399 if (replicate) replicate_status(addr);
2400 for (addr2 = addr; addr2; addr2 = addr2->next)
2403 int local_part_length = Ustrlen(addr2->local_part);
2407 if( (i = addr2->transport_return, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2408 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2409 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2410 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2411 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2412 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2413 || (i = addr2->special_action, (ret = write(pfd[pipe_write], &i, sizeof(int))) != sizeof(int))
2414 || (ret = write(pfd[pipe_write], &addr2->transport,
2415 sizeof(transport_instance *))) != sizeof(transport_instance *)
2417 /* For a file delivery, pass back the local part, in case the original
2418 was only part of the final delivery path. This gives more complete
2421 || (testflag(addr2, af_file)
2422 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2423 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2427 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2428 ret == -1 ? strerror(errno) : "short write");
2430 /* Now any messages */
2432 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2434 int message_length = s ? Ustrlen(s) + 1 : 0;
2435 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2436 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2438 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2439 ret == -1 ? strerror(errno) : "short write");
2443 /* OK, this process is now done. Free any cached resources that it opened,
2444 and close the pipe we were writing down before exiting. */
2446 (void)close(pfd[pipe_write]);
2451 /* Back in the main process: panic if the fork did not succeed. This seems
2452 better than returning an error - if forking is failing it is probably best
2453 not to try other deliveries for this message. */
2456 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2459 /* Read the pipe to get the delivery status codes and error messages. Our copy
2460 of the writing end must be closed first, as otherwise read() won't return zero
2461 on an empty pipe. We check that a status exists for each address before
2462 overwriting the address structure. If data is missing, the default DEFER status
2463 will remain. Afterwards, close the reading end. */
2465 (void)close(pfd[pipe_write]);
2467 for (addr2 = addr; addr2; addr2 = addr2->next)
2469 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2474 addr2->transport_return = status;
2475 len = read(pfd[pipe_read], &transport_count,
2476 sizeof(transport_count));
2477 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2478 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2479 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2480 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2481 len = read(pfd[pipe_read], &i, sizeof(int)); addr2->special_action = i;
2482 len = read(pfd[pipe_read], &addr2->transport,
2483 sizeof(transport_instance *));
2485 if (testflag(addr2, af_file))
2488 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2489 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2492 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2493 " from delivery subprocess");
2496 /* sanity-checked llen so disable the Coverity error */
2497 /* coverity[tainted_data] */
2498 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2500 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2501 " from delivery subprocess");
2504 big_buffer[llen] = 0;
2505 addr2->local_part = string_copy(big_buffer);
2508 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2511 len = read(pfd[pipe_read], &message_length, sizeof(int));
2512 if (message_length > 0)
2514 len = read(pfd[pipe_read], big_buffer, message_length);
2515 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2516 if (len > 0) *sptr = string_copy(big_buffer);
2523 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2524 "from delivery subprocess", addr2->unique);
2529 (void)close(pfd[pipe_read]);
2531 /* Unless shadowing, write all successful addresses immediately to the journal
2532 file, to ensure they are recorded asap. For homonymic addresses, use the base
2533 address plus the transport name. Failure to write the journal is panic-worthy,
2534 but don't stop, as it may prove possible subsequently to update the spool file
2535 in order to record the delivery. */
2539 for (addr2 = addr; addr2; addr2 = addr2->next)
2540 if (addr2->transport_return == OK)
2542 if (testflag(addr2, af_homonym))
2543 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2545 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2547 /* In the test harness, wait just a bit to let the subprocess finish off
2548 any debug output etc first. */
2550 testharness_pause_ms(300);
2552 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2553 len = Ustrlen(big_buffer);
2554 if (write(journal_fd, big_buffer, len) != len)
2555 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2556 big_buffer, strerror(errno));
2559 /* Ensure the journal file is pushed out to disk. */
2561 if (EXIMfsync(journal_fd) < 0)
2562 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2566 /* Wait for the process to finish. If it terminates with a non-zero code,
2567 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2568 status values of all the addresses as they are. Take care to handle the case
2569 when the subprocess doesn't seem to exist. This has been seen on one system
2570 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2571 happens, wait() doesn't recognize the termination of child processes. Exim now
2572 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2574 while ((rc = wait(&status)) != pid)
2575 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2577 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2578 addr->transport->driver_name);
2583 if ((status & 0xffff) != 0)
2585 int msb = (status >> 8) & 255;
2586 int lsb = status & 255;
2587 int code = (msb == 0)? (lsb & 0x7f) : msb;
2588 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2589 addr->special_action = SPECIAL_FREEZE;
2590 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2591 "status 0x%04x: %s %d",
2592 addr->transport->driver_name,
2594 msb == 0 ? "terminated by signal" : "exit code",
2598 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2600 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2603 uschar *warn_message;
2606 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2608 if (!(warn_message = expand_string(addr->transport->warn_message)))
2609 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2610 "message for %s transport): %s", addr->transport->warn_message,
2611 addr->transport->name, expand_string_message);
2613 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2615 FILE *f = fdopen(fd, "wb");
2616 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2617 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2618 fprintf(f, "Auto-Submitted: auto-replied\n");
2619 if (!contains_header(US"From", warn_message))
2621 fprintf(f, "%s", CS warn_message);
2623 /* Close and wait for child process to complete, without a timeout. */
2626 (void)child_close(pid, 0);
2629 addr->special_action = SPECIAL_NONE;
2636 /* Check transport for the given concurrency limit. Return TRUE if over
2637 the limit (or an expansion failure), else FALSE and if there was a limit,
2638 the key for the hints database used for the concurrency count. */
2641 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2643 unsigned max_parallel;
2645 if (!tp->max_parallel) return FALSE;
2647 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2648 if (expand_string_message)
2650 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2651 "in %s transport (%s): %s", tp->name, addr->address,
2652 expand_string_message);
2656 if (max_parallel > 0)
2658 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2659 if (!enq_start(serialize_key, max_parallel))
2661 address_item * next;
2663 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2664 tp->name, max_parallel);
2668 addr->message = US"concurrency limit reached for transport";
2669 addr->basic_errno = ERRNO_TRETRY;
2670 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2671 } while ((addr = next));
2674 *key = serialize_key;
2681 /*************************************************
2682 * Do local deliveries *
2683 *************************************************/
2685 /* This function processes the list of addresses in addr_local. True local
2686 deliveries are always done one address at a time. However, local deliveries can
2687 be batched up in some cases. Typically this is when writing batched SMTP output
2688 files for use by some external transport mechanism, or when running local
2689 deliveries over LMTP.
2696 do_local_deliveries(void)
2699 open_db *dbm_file = NULL;
2700 time_t now = time(NULL);
2702 /* Loop until we have exhausted the supply of local deliveries */
2706 struct timeval delivery_start;
2707 struct timeval deliver_time;
2708 address_item *addr2, *addr3, *nextaddr;
2709 int logflags = LOG_MAIN;
2710 int logchar = f.dont_deliver? '*' : '=';
2711 transport_instance *tp;
2712 uschar * serialize_key = NULL;
2714 /* Pick the first undelivered address off the chain */
2716 address_item *addr = addr_local;
2717 addr_local = addr->next;
2720 DEBUG(D_deliver|D_transport)
2721 debug_printf("--------> %s <--------\n", addr->address);
2723 /* An internal disaster if there is no transport. Should not occur! */
2725 if (!(tp = addr->transport))
2727 logflags |= LOG_PANIC;
2728 f.disable_logging = FALSE; /* Jic */
2729 addr->message = addr->router
2730 ? string_sprintf("No transport set by %s router", addr->router->name)
2731 : US"No transport set by system filter";
2732 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2736 /* Check that this base address hasn't previously been delivered to this
2737 transport. The check is necessary at this point to handle homonymic addresses
2738 correctly in cases where the pattern of redirection changes between delivery
2739 attempts. Non-homonymic previous delivery is detected earlier, at routing
2742 if (previously_transported(addr, FALSE)) continue;
2744 /* There are weird cases where logging is disabled */
2746 f.disable_logging = tp->disable_logging;
2748 /* Check for batched addresses and possible amalgamation. Skip all the work
2749 if either batch_max <= 1 or there aren't any other addresses for local
2752 if (tp->batch_max > 1 && addr_local)
2754 int batch_count = 1;
2755 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2756 BOOL uses_lp = ( testflag(addr, af_pfr)
2757 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2759 || readconf_depends((driver_instance *)tp, US"local_part");
2760 uschar *batch_id = NULL;
2761 address_item **anchor = &addr_local;
2762 address_item *last = addr;
2765 /* Expand the batch_id string for comparison with other addresses.
2766 Expansion failure suppresses batching. */
2770 deliver_set_expansions(addr);
2771 batch_id = expand_string(tp->batch_id);
2772 deliver_set_expansions(NULL);
2775 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2776 "in %s transport (%s): %s", tp->name, addr->address,
2777 expand_string_message);
2778 batch_count = tp->batch_max;
2782 /* Until we reach the batch_max limit, pick off addresses which have the
2783 same characteristics. These are:
2786 not previously delivered (see comment about 50 lines above)
2787 same local part if the transport's configuration contains $local_part
2788 or if this is a file or pipe delivery from a redirection
2789 same domain if the transport's configuration contains $domain
2791 same additional headers
2792 same headers to be removed
2793 same uid/gid for running the transport
2794 same first host if a host list is set
2797 while ((next = *anchor) && batch_count < tp->batch_max)
2800 tp == next->transport
2801 && !previously_transported(next, TRUE)
2802 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2803 && testflag(addr, af_file) == testflag(next, af_file)
2804 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2805 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2806 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2807 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2808 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2809 && same_ugid(tp, addr, next)
2810 && ( !addr->host_list && !next->host_list
2813 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2816 /* If the transport has a batch_id setting, batch_id will be non-NULL
2817 from the expansion outside the loop. Expand for this address and compare.
2818 Expansion failure makes this address ineligible for batching. */
2823 address_item *save_nextnext = next->next;
2824 next->next = NULL; /* Expansion for a single address */
2825 deliver_set_expansions(next);
2826 next->next = save_nextnext;
2827 bid = expand_string(tp->batch_id);
2828 deliver_set_expansions(NULL);
2831 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2832 "in %s transport (%s): %s", tp->name, next->address,
2833 expand_string_message);
2836 else ok = (Ustrcmp(batch_id, bid) == 0);
2839 /* Take address into batch if OK. */
2843 *anchor = next->next; /* Include the address */
2849 else anchor = &next->next; /* Skip the address */
2853 /* We now have one or more addresses that can be delivered in a batch. Check
2854 whether the transport is prepared to accept a message of this size. If not,
2855 fail them all forthwith. If the expansion fails, or does not yield an
2856 integer, defer delivery. */
2858 if (tp->message_size_limit)
2860 int rc = check_message_size(tp, addr);
2863 replicate_status(addr);
2867 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2870 continue; /* With next batch of addresses */
2874 /* If we are not running the queue, or if forcing, all deliveries will be
2875 attempted. Otherwise, we must respect the retry times for each address. Even
2876 when not doing this, we need to set up the retry key string, and determine
2877 whether a retry record exists, because after a successful delivery, a delete
2878 retry item must be set up. Keep the retry database open only for the duration
2879 of these checks, rather than for all local deliveries, because some local
2880 deliveries (e.g. to pipes) can take a substantial time. */
2882 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2883 DEBUG(D_deliver|D_retry|D_hints_lookup)
2884 debug_printf("no retry data available\n");
2890 BOOL ok = TRUE; /* to deliver this address */
2893 /* Set up the retry key to include the domain or not, and change its
2894 leading character from "R" to "T". Must make a copy before doing this,
2895 because the old key may be pointed to from a "delete" retry item after
2898 retry_key = string_copy(
2899 tp->retry_use_local_part ? addr2->address_retry_key :
2900 addr2->domain_retry_key);
2903 /* Inspect the retry data. If there is no hints file, delivery happens. */
2907 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2909 /* If there is no retry record, delivery happens. If there is,
2910 remember it exists so it can be deleted after a successful delivery. */
2914 setflag(addr2, af_lt_retry_exists);
2916 /* A retry record exists for this address. If queue running and not
2917 forcing, inspect its contents. If the record is too old, or if its
2918 retry time has come, or if it has passed its cutoff time, delivery
2923 debug_printf("retry record exists: age=%s ",
2924 readconf_printtime(now - retry_record->time_stamp));
2925 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2926 debug_printf(" time to retry = %s expired = %d\n",
2927 readconf_printtime(retry_record->next_try - now),
2928 retry_record->expired);
2931 if (f.queue_running && !f.deliver_force)
2933 ok = (now - retry_record->time_stamp > retry_data_expire)
2934 || (now >= retry_record->next_try)
2935 || retry_record->expired;
2937 /* If we haven't reached the retry time, there is one more check
2938 to do, which is for the ultimate address timeout. */
2941 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2945 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2948 /* This address is to be delivered. Leave it on the chain. */
2953 addr2 = addr2->next;
2956 /* This address is to be deferred. Take it out of the chain, and
2957 post-process it as complete. Must take it out of the chain first,
2958 because post processing puts it on another chain. */
2962 address_item *this = addr2;
2963 this->message = US"Retry time not yet reached";
2964 this->basic_errno = ERRNO_LRETRY;
2965 addr2 = addr3 ? (addr3->next = addr2->next)
2966 : (addr = addr2->next);
2967 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2971 if (dbm_file) dbfn_close(dbm_file);
2973 /* If there are no addresses left on the chain, they all deferred. Loop
2974 for the next set of addresses. */
2976 if (!addr) continue;
2978 /* If the transport is limited for parallellism, enforce that here.
2979 We use a hints DB entry, incremented here and decremented after
2980 the transport (and any shadow transport) completes. */
2982 if (tpt_parallel_check(tp, addr, &serialize_key))
2984 if (expand_string_message)
2986 logflags |= LOG_PANIC;
2990 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2991 } while ((addr = addr2));
2993 continue; /* Loop for the next set of addresses. */
2997 /* So, finally, we do have some addresses that can be passed to the
2998 transport. Before doing so, set up variables that are relevant to a
3001 deliver_set_expansions(addr);
3003 gettimeofday(&delivery_start, NULL);
3004 deliver_local(addr, FALSE);
3005 timesince(&deliver_time, &delivery_start);
3007 /* If a shadow transport (which must perforce be another local transport), is
3008 defined, and its condition is met, we must pass the message to the shadow
3009 too, but only those addresses that succeeded. We do this by making a new
3010 chain of addresses - also to keep the original chain uncontaminated. We must
3011 use a chain rather than doing it one by one, because the shadow transport may
3014 NOTE: if the condition fails because of a lookup defer, there is nothing we
3018 && ( !tp->shadow_condition
3019 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3022 transport_instance *stp;
3023 address_item *shadow_addr = NULL;
3024 address_item **last = &shadow_addr;
3026 for (stp = transports; stp; stp = stp->next)
3027 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3030 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3033 /* Pick off the addresses that have succeeded, and make clones. Put into
3034 the shadow_message field a pointer to the shadow_message field of the real
3037 else for (addr2 = addr; addr2; addr2 = addr2->next)
3038 if (addr2->transport_return == OK)
3040 addr3 = store_get(sizeof(address_item), GET_UNTAINTED);
3043 addr3->shadow_message = US &addr2->shadow_message;
3044 addr3->transport = stp;
3045 addr3->transport_return = DEFER;
3046 addr3->return_filename = NULL;
3047 addr3->return_file = -1;
3049 last = &addr3->next;
3052 /* If we found any addresses to shadow, run the delivery, and stick any
3053 message back into the shadow_message field in the original. */
3057 int save_count = transport_count;
3059 DEBUG(D_deliver|D_transport)
3060 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3061 deliver_local(shadow_addr, TRUE);
3063 for(; shadow_addr; shadow_addr = shadow_addr->next)
3065 int sresult = shadow_addr->transport_return;
3066 *(uschar **)shadow_addr->shadow_message =
3068 ? string_sprintf(" ST=%s", stp->name)
3069 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3070 shadow_addr->basic_errno <= 0
3072 : US strerror(shadow_addr->basic_errno),
3073 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3076 shadow_addr->message
3077 ? shadow_addr->message
3078 : shadow_addr->basic_errno <= 0
3082 DEBUG(D_deliver|D_transport)
3083 debug_printf("%s shadow transport returned %s for %s\n",
3084 stp->name, rc_to_string(sresult), shadow_addr->address);
3087 DEBUG(D_deliver|D_transport)
3088 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3090 transport_count = save_count; /* Restore original transport count */
3094 /* Cancel the expansions that were set up for the delivery. */
3096 deliver_set_expansions(NULL);
3098 /* If the transport was parallelism-limited, decrement the hints DB record. */
3100 if (serialize_key) enq_end(serialize_key);
3102 /* Now we can process the results of the real transport. We must take each
3103 address off the chain first, because post_process_one() puts it on another
3106 for (addr2 = addr; addr2; addr2 = nextaddr)
3108 int result = addr2->transport_return;
3109 nextaddr = addr2->next;
3111 DEBUG(D_deliver|D_transport)
3112 debug_printf("%s transport returned %s for %s\n",
3113 tp->name, rc_to_string(result), addr2->address);
3115 /* If there is a retry_record, or if delivery is deferred, build a retry
3116 item for setting a new retry time or deleting the old retry record from
3117 the database. These items are handled all together after all addresses
3118 have been handled (so the database is open just for a short time for
3121 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3123 int flags = result == DEFER ? 0 : rf_delete;
3124 uschar *retry_key = string_copy(tp->retry_use_local_part
3125 ? addr2->address_retry_key : addr2->domain_retry_key);
3127 retry_add_item(addr2, retry_key, flags);
3130 /* Done with this address */
3132 addr2->delivery_time = deliver_time;
3133 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3135 /* If a pipe delivery generated text to be sent back, the result may be
3136 changed to FAIL, and we must copy this for subsequent addresses in the
3139 if (addr2->transport_return != result)
3141 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3143 addr3->transport_return = addr2->transport_return;
3144 addr3->basic_errno = addr2->basic_errno;
3145 addr3->message = addr2->message;
3147 result = addr2->transport_return;
3150 /* Whether or not the result was changed to FAIL, we need to copy the
3151 return_file value from the first address into all the addresses of the
3152 batch, so they are all listed in the error message. */
3154 addr2->return_file = addr->return_file;
3156 /* Change log character for recording successful deliveries. */
3158 if (result == OK) logchar = '-';
3160 } /* Loop back for next batch of addresses */
3166 /*************************************************
3167 * Sort remote deliveries *
3168 *************************************************/
3170 /* This function is called if remote_sort_domains is set. It arranges that the
3171 chain of addresses for remote deliveries is ordered according to the strings
3172 specified. Try to make this shuffling reasonably efficient by handling
3173 sequences of addresses rather than just single ones.
3180 sort_remote_deliveries(void)
3183 address_item **aptr = &addr_remote;
3184 const uschar *listptr = remote_sort_domains;
3188 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3190 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3193 address_item *moved = NULL;
3194 address_item **bptr = &moved;
3198 address_item **next;
3199 deliver_domain = (*aptr)->domain; /* set $domain */
3200 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3201 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3203 aptr = &(*aptr)->next;
3207 next = &(*aptr)->next;
3209 && (deliver_domain = (*next)->domain, /* Set $domain */
3210 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3211 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3213 next = &(*next)->next;
3215 /* If the batch of non-matchers is at the end, add on any that were
3216 extracted further up the chain, and end this iteration. Otherwise,
3217 extract them from the chain and hang on the moved chain. */
3229 aptr = &(*aptr)->next;
3232 /* If the loop ended because the final address matched, *aptr will
3233 be NULL. Add on to the end any extracted non-matching addresses. If
3234 *aptr is not NULL, the loop ended via "break" when *next is null, that
3235 is, there was a string of non-matching addresses at the end. In this
3236 case the extracted addresses have already been added on the end. */
3238 if (!*aptr) *aptr = moved;
3243 debug_printf("remote addresses after sorting:\n");
3244 for (address_item * addr = addr_remote; addr; addr = addr->next)
3245 debug_printf(" %s\n", addr->address);
3251 /*************************************************
3252 * Read from pipe for remote delivery subprocess *
3253 *************************************************/
3255 /* This function is called when the subprocess is complete, but can also be
3256 called before it is complete, in order to empty a pipe that is full (to prevent
3257 deadlock). It must therefore keep track of its progress in the parlist data
3260 We read the pipe to get the delivery status codes and a possible error message
3261 for each address, optionally preceded by unusability data for the hosts and
3262 also by optional retry data.
3264 Read in large chunks into the big buffer and then scan through, interpreting
3265 the data therein. In most cases, only a single read will be necessary. No
3266 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3267 that we read the next chunk when there is less than 2500 bytes left in the
3268 non-final chunk, we can assume each item is complete in the buffer before
3269 handling it. Each item is written using a single write(), which is atomic for
3270 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3271 often bigger) so even if we are reading while the subprocess is still going, we
3272 should never have only a partial item in the buffer.
3274 hs12: This assumption is not true anymore, since we get quite large items (certificate
3275 information and such).
3278 poffset the offset of the parlist item
3279 eop TRUE if the process has completed
3281 Returns: TRUE if the terminating 'Z' item has been read,
3282 or there has been a disaster (i.e. no more data needed);
3287 par_read_pipe(int poffset, BOOL eop)
3290 pardata *p = parlist + poffset;
3291 address_item *addrlist = p->addrlist;
3292 address_item *addr = p->addr;
3296 uschar *msg = p->msg;
3297 BOOL done = p->done;
3299 /* Loop through all items, reading from the pipe when necessary. The pipe
3300 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3301 here, as the preceding poll() tells us, if data is available for reading.
3303 A read() on a "selected" handle should never block, but(!) it may return
3304 less data then we expected. (The buffer size we pass to read() shouldn't be
3305 understood as a "request", but as a "limit".)
3307 Each separate item is written to the pipe in a timely manner. But, especially for
3308 larger items, the read(2) may already return partial data from the write(2).
3310 The write is atomic mostly (depending on the amount written), but atomic does
3311 not imply "all or noting", it just is "not intermixed" with other writes on the
3312 same channel (pipe).
3316 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3317 (int)p->pid, eop? "ended" : "not ended yet");
3321 retry_item *r, **rp;
3322 uschar pipeheader[PIPE_HEADER_SIZE+1];
3323 uschar *id = &pipeheader[0];
3324 uschar *subid = &pipeheader[1];
3325 uschar *ptr = big_buffer;
3326 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3329 DEBUG(D_deliver) debug_printf(
3330 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3332 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3333 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3334 If we get less, we can assume the subprocess do be done and do not expect any further
3335 information from it. */
3337 if ((got = readn(fd, pipeheader, required)) != required)
3339 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3340 "from transport process %d for transport %s",
3341 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3346 pipeheader[PIPE_HEADER_SIZE] = '\0';
3348 debug_printf("got %ld bytes (pipeheader) '%c' from transport process %d\n",
3349 (long) got, *id, pid);
3352 /* If we can't decode the pipeheader, the subprocess seems to have a
3353 problem, we do not expect any furher information from it. */
3355 required = Ustrtol(pipeheader+2, &endc, 10);
3358 msg = string_sprintf("failed to read pipe "
3359 "from transport process %d for transport %s: error decoding size from header",
3360 pid, addr->transport->driver_name);
3367 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3368 (u_long)required, pid);
3370 /* Same as above, the transport process will write the bytes announced
3371 in a timely manner, so we can just wait for the bytes, getting less than expected
3372 is considered a problem of the subprocess, we do not expect anything else from it. */
3373 if ((got = readn(fd, big_buffer, required)) != required)
3375 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3376 " bytes (pipedata) from transport process %d for transport %s",
3377 got, required, pid, addr->transport->driver_name);
3382 /* Handle each possible type of item, assuming the complete item is
3383 available in store. */
3387 /* Host items exist only if any hosts were marked unusable. Match
3388 up by checking the IP address. */
3391 for (h = addrlist->host_list; h; h = h->next)
3393 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3401 /* Retry items are sent in a preceding R item for each address. This is
3402 kept separate to keep each message short enough to guarantee it won't
3403 be split in the pipe. Hopefully, in the majority of cases, there won't in
3404 fact be any retry items at all.
3406 The complete set of retry items might include an item to delete a
3407 routing retry if there was a previous routing delay. However, routing
3408 retries are also used when a remote transport identifies an address error.
3409 In that case, there may also be an "add" item for the same key. Arrange
3410 that a "delete" item is dropped in favour of an "add" item. */
3413 if (!addr) goto ADDR_MISMATCH;
3415 DEBUG(D_deliver|D_retry)
3416 debug_printf("reading retry information for %s from subprocess\n",
3419 /* Cut out any "delete" items on the list. */
3421 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3422 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3424 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3425 *rp = r->next; /* Excise a delete item */
3426 DEBUG(D_deliver|D_retry)
3427 debug_printf(" existing delete item dropped\n");
3430 /* We want to add a delete item only if there is no non-delete item;
3431 however we still have to step ptr through the data. */
3433 if (!r || !(*ptr & rf_delete))
3435 r = store_get(sizeof(retry_item), GET_UNTAINTED);
3436 r->next = addr->retries;
3439 r->key = string_copy(ptr);
3441 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3442 ptr += sizeof(r->basic_errno);
3443 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3444 ptr += sizeof(r->more_errno);
3445 r->message = *ptr ? string_copy(ptr) : NULL;
3446 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3447 r->flags & rf_delete ? "delete" : "retry");
3452 DEBUG(D_deliver|D_retry)
3453 debug_printf(" delete item not added: non-delete item exists\n");
3456 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3462 /* Put the amount of data written into the parlist block */
3464 case 'S': /* Size */
3465 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3466 ptr += sizeof(transport_count);
3469 /* Address items are in the order of items on the address chain. We
3470 remember the current address value in case this function is called
3471 several times to empty the pipe in stages. Information about delivery
3472 over TLS is sent in a preceding X item for each address. We don't put
3473 it in with the other info, in order to keep each message short enough to
3474 guarantee it won't be split in the pipe. */
3477 case 'X': /* TLS details */
3478 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3482 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3486 addr->cipher = string_copy(ptr);
3487 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3491 addr->peerdn = string_copy(ptr);
3496 (void) tls_import_cert(ptr, &addr->peercert);
3498 addr->peercert = NULL;
3503 (void) tls_import_cert(ptr, &addr->ourcert);
3505 addr->ourcert = NULL;
3508 # ifndef DISABLE_OCSP
3510 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3516 #endif /*DISABLE_TLS*/
3518 case 'C': /* client authenticator information */
3521 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3522 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3523 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3528 #ifndef DISABLE_PRDR
3530 setflag(addr, af_prdr_used);
3537 #ifndef DISABLE_PIPE_CONNECT
3538 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3540 case 1: setflag(addr, af_pipelining); break;
3545 setflag(addr, af_chunking_used);
3549 setflag(addr, af_tcp_fastopen_conn);
3550 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3551 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3555 if (!addr) goto ADDR_MISMATCH;
3556 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3557 ptr += sizeof(addr->dsn_aware);
3558 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3561 case 'A': /* Per-address info */
3565 msg = string_sprintf("address count mismatch for data read from pipe "
3566 "for transport process %d for transport %s", pid,
3567 addrlist->transport->driver_name);
3574 case 3: /* explicit notification of continued-connection (non)use;
3575 overrides caller's knowlege. */
3576 if (*ptr & BIT(1)) setflag(addr, af_new_conn);
3577 else if (*ptr & BIT(2)) setflag(addr, af_cont_conn);
3580 #ifdef SUPPORT_SOCKS
3581 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3582 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3587 proxy_local_address = string_copy(ptr);
3589 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3590 ptr += sizeof(proxy_local_port);
3595 #ifdef EXPERIMENTAL_DSN_INFO
3596 case '1': /* must arrive before A0, and applies to that addr */
3597 /* Two strings: smtp_greeting and helo_response */
3598 addr->smtp_greeting = string_copy(ptr);
3600 addr->helo_response = string_copy(ptr);
3605 case '0': /* results of trying to send to this address */
3606 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3607 addr->transport_return = *ptr++;
3608 addr->special_action = *ptr++;
3609 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3610 ptr += sizeof(addr->basic_errno);
3611 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3612 ptr += sizeof(addr->more_errno);
3613 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3614 ptr += sizeof(addr->delivery_time);
3615 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3616 ptr += sizeof(addr->flags);
3617 addr->message = *ptr ? string_copy(ptr) : NULL;
3619 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3622 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3626 h = store_get(sizeof(host_item), GET_UNTAINTED);
3627 h->name = string_copy(ptr);
3629 h->address = string_copy(ptr);
3631 memcpy(&h->port, ptr, sizeof(h->port));
3632 ptr += sizeof(h->port);
3633 h->dnssec = *ptr == '2' ? DS_YES
3634 : *ptr == '1' ? DS_NO
3637 addr->host_used = h;
3641 /* Finished with this address */
3648 /* Local interface address/port */
3650 if (*ptr) sending_ip_address = string_copy(ptr);
3652 if (*ptr) sending_port = atoi(CS ptr);
3656 /* Z marks the logical end of the data. It is followed by '0' if
3657 continue_transport was NULL at the end of transporting, otherwise '1'.
3658 We need to know when it becomes NULL during a delivery down a passed SMTP
3659 channel so that we don't try to pass anything more down it. Of course, for
3660 most normal messages it will remain NULL all the time. */
3665 continue_transport = NULL;
3666 continue_hostname = NULL;
3669 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3672 /* Anything else is a disaster. */
3675 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3676 "process %d for transport %s", ptr[-1], pid,
3677 addr->transport->driver_name);
3683 /* The done flag is inspected externally, to determine whether or not to
3684 call the function again when the process finishes. */
3688 /* If the process hadn't finished, and we haven't seen the end of the data
3689 or if we suffered a disaster, update the rest of the state, and return FALSE to
3690 indicate "not finished". */
3699 /* Close our end of the pipe, to prevent deadlock if the far end is still
3700 pushing stuff into it. */
3705 /* If we have finished without error, but haven't had data for every address,
3706 something is wrong. */
3709 msg = string_sprintf("insufficient address data read from pipe "
3710 "for transport process %d for transport %s", pid,
3711 addr->transport->driver_name);
3713 /* If an error message is set, something has gone wrong in getting back
3714 the delivery data. Put the message into each address and freeze it. */
3717 for (addr = addrlist; addr; addr = addr->next)
3719 addr->transport_return = DEFER;
3720 addr->special_action = SPECIAL_FREEZE;
3721 addr->message = msg;
3722 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3725 /* Return TRUE to indicate we have got all we need from this process, even
3726 if it hasn't actually finished yet. */
3733 /*************************************************
3734 * Post-process a set of remote addresses *
3735 *************************************************/
3737 /* Do what has to be done immediately after a remote delivery for each set of
3738 addresses, then re-write the spool if necessary. Note that post_process_one
3739 puts the address on an appropriate queue; hence we must fish off the next
3740 one first. This function is also called if there is a problem with setting
3741 up a subprocess to do a remote delivery in parallel. In this case, the final
3742 argument contains a message, and the action must be forced to DEFER.
3745 addr pointer to chain of address items
3746 logflags flags for logging
3747 msg NULL for normal cases; -> error message for unexpected problems
3748 fallback TRUE if processing fallback hosts
3754 remote_post_process(address_item * addr, int logflags, uschar * msg,
3757 /* If any host addresses were found to be unusable, add them to the unusable
3758 tree so that subsequent deliveries don't try them. */
3760 for (host_item * h = addr->host_list; h; h = h->next)
3762 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3764 /* Now handle each address on the chain. The transport has placed '=' or '-'
3765 into the special_action field for each successful delivery. */
3769 address_item * next = addr->next;
3771 /* If msg == NULL (normal processing) and the result is DEFER and we are
3772 processing the main hosts and there are fallback hosts available, put the
3773 address on the list for fallback delivery. */
3775 if ( addr->transport_return == DEFER
3776 && addr->fallback_hosts
3781 addr->host_list = addr->fallback_hosts;
3782 addr->next = addr_fallback;
3783 addr_fallback = addr;
3784 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3787 /* If msg is set (=> unexpected problem), set it in the address before
3788 doing the ordinary post processing. */
3794 addr->message = msg;
3795 addr->transport_return = DEFER;
3797 (void)post_process_one(addr, addr->transport_return, logflags,
3798 EXIM_DTYPE_TRANSPORT, addr->special_action);
3806 /* If we have just delivered down a passed SMTP channel, and that was
3807 the last address, the channel will have been closed down. Now that
3808 we have logged that delivery, set continue_sequence to 1 so that
3809 any subsequent deliveries don't get "*" incorrectly logged. */
3811 if (!continue_transport) continue_sequence = 1;
3816 /*************************************************
3817 * Wait for one remote delivery subprocess *
3818 *************************************************/
3820 /* This function is called while doing remote deliveries when either the
3821 maximum number of processes exist and we need one to complete so that another
3822 can be created, or when waiting for the last ones to complete. It must wait for
3823 the completion of one subprocess, empty the control block slot, and return a
3824 pointer to the address chain.
3827 Returns: pointer to the chain of addresses handled by the process;
3828 NULL if no subprocess found - this is an unexpected error
3831 static address_item *
3834 int poffset, status;
3835 address_item * addr, * addrlist;
3838 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3839 "to finish", message_id);
3841 /* Loop until either a subprocess completes, or there are no subprocesses in
3842 existence - in which case give an error return. We cannot proceed just by
3843 waiting for a completion, because a subprocess may have filled up its pipe, and
3844 be waiting for it to be emptied. Therefore, if no processes have finished, we
3845 wait for one of the pipes to acquire some data by calling poll(), with a
3846 timeout just in case.
3848 The simple approach is just to iterate after reading data from a ready pipe.
3849 This leads to non-ideal behaviour when the subprocess has written its final Z
3850 item, closed the pipe, and is in the process of exiting (the common case). A
3851 call to waitpid() yields nothing completed, but poll() shows the pipe ready -
3852 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3855 To avoid this, if all the data that is needed has been read from a subprocess
3856 after poll(), an explicit wait() for it is done. We know that all it is doing
3857 is writing to the pipe and then exiting, so the wait should not be long.
3859 The non-blocking waitpid() is to some extent just insurance; if we could
3860 reliably detect end-of-file on the pipe, we could always know when to do a
3861 blocking wait() for a completed process. However, because some systems use
3862 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3863 use code that functions without the need to recognize EOF.
3865 There's a double loop here just in case we end up with a process that is not in
3866 the list of remote delivery processes. Something has obviously gone wrong if
3867 this is the case. (For example, a process that is incorrectly left over from
3868 routing or local deliveries might be found.) The damage can be minimized by
3869 looping back and looking for another process. If there aren't any, the error
3870 return will happen. */
3872 for (;;) /* Normally we do not repeat this loop */
3874 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3878 /* A return value of -1 can mean several things. If errno != ECHILD, it
3879 either means invalid options (which we discount), or that this process was
3880 interrupted by a signal. Just loop to try the waitpid() again.
3882 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3883 in existence. This should never happen, and is an unexpected error.
3884 However, there is a nasty complication when running under Linux. If "strace
3885 -f" is being used under Linux to trace this process and its children,
3886 subprocesses are "stolen" from their parents and become the children of the
3887 tracing process. A general wait such as the one we've just obeyed returns
3888 as if there are no children while subprocesses are running. Once a
3889 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3890 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3893 This does not happen using "truss" on Solaris, nor (I think) with other
3894 tracing facilities on other OS. It seems to be specific to Linux.
3896 What we do to get round this is to use kill() to see if any of our
3897 subprocesses are still in existence. If kill() gives an OK return, we know
3898 it must be for one of our processes - it can't be for a re-use of the pid,
3899 because if our process had finished, waitpid() would have found it. If any
3900 of our subprocesses are in existence, we proceed to use poll() as if
3901 waitpid() had returned zero. I think this is safe. */
3905 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3908 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3909 "for process existence\n");
3911 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3913 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3915 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3916 "stolen by strace\n", (int)pid);
3917 break; /* With poffset set */
3921 if (poffset >= remote_max_parallel)
3923 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3924 return NULL; /* This is the error return */
3928 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3929 been handled above. A return value of zero means that there is at least one
3930 subprocess, but there are no completed subprocesses. See if any pipes are
3931 ready with any data for reading. */
3933 DEBUG(D_deliver) debug_printf("polling subprocess pipes\n");
3935 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3936 if (parlist[poffset].pid != 0)
3938 parpoll[poffset].fd = parlist[poffset].fd;
3939 parpoll[poffset].events = POLLIN;
3942 parpoll[poffset].fd = -1;
3944 /* Stick in a 60-second timeout, just in case. */
3946 readycount = poll(parpoll, remote_max_parallel, 60 * 1000);
3948 /* Scan through the pipes and read any that are ready; use the count
3949 returned by poll() to stop when there are no more. Select() can return
3950 with no processes (e.g. if interrupted). This shouldn't matter.
3952 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3953 read, or there was a disaster. In either case, we are finished with this
3954 process. Do an explicit wait() for the process and break the main loop if
3957 It turns out that we have to deal with the case of an interrupted system
3958 call, which can happen on some operating systems if the signal handling is
3959 set up to do that by default. */
3962 readycount > 0 && poffset < remote_max_parallel;
3965 if ( (pid = parlist[poffset].pid) != 0
3966 && parpoll[poffset].revents
3970 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3971 for (;;) /* Loop for signals */
3973 pid_t endedpid = waitpid(pid, &status, 0);
3974 if (endedpid == pid) goto PROCESS_DONE;
3975 if (endedpid != (pid_t)(-1) || errno != EINTR)
3976 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3977 "%d (errno = %d) from waitpid() for process %d",
3978 (int)endedpid, errno, (int)pid);
3983 /* Now go back and look for a completed subprocess again. */
3986 /* A completed process was detected by the non-blocking waitpid(). Find the
3987 data block that corresponds to this subprocess. */
3989 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3990 if (pid == parlist[poffset].pid) break;
3992 /* Found the data block; this is a known remote delivery process. We don't
3993 need to repeat the outer loop. This should be what normally happens. */
3995 if (poffset < remote_max_parallel) break;
3997 /* This situation is an error, but it's probably better to carry on looking
3998 for another process than to give up (as we used to do). */
4000 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4001 "transport process list", pid);
4002 } /* End of the "for" loop */
4004 /* Come here when all the data was completely read after a poll(), and
4005 the process in pid has been wait()ed for. */
4012 debug_printf("remote delivery process %d ended\n", (int)pid);
4014 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4018 set_process_info("delivering %s", message_id);
4020 /* Get the chain of processed addresses */
4022 addrlist = parlist[poffset].addrlist;
4024 /* If the process did not finish cleanly, record an error and freeze (except
4025 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4026 in case the delivery did actually happen. */
4028 if ((status & 0xffff) != 0)
4031 int msb = (status >> 8) & 255;
4032 int lsb = status & 255;
4033 int code = (msb == 0)? (lsb & 0x7f) : msb;
4035 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4037 addrlist->transport->driver_name,
4039 msb == 0 ? "terminated by signal" : "exit code",
4042 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4043 addrlist->special_action = SPECIAL_FREEZE;
4045 for (addr = addrlist; addr; addr = addr->next)
4047 addr->transport_return = DEFER;
4048 addr->message = msg;
4051 remove_journal = FALSE;
4054 /* Else complete reading the pipe to get the result of the delivery, if all
4055 the data has not yet been obtained. */
4057 else if (!parlist[poffset].done)
4058 (void) par_read_pipe(poffset, TRUE);
4060 /* Put the data count and return path into globals, mark the data slot unused,
4061 decrement the count of subprocesses, and return the address chain. */
4063 transport_count = parlist[poffset].transport_count;
4064 used_return_path = parlist[poffset].return_path;
4065 parlist[poffset].pid = 0;
4072 /*************************************************
4073 * Wait for subprocesses and post-process *
4074 *************************************************/
4076 /* This function waits for subprocesses until the number that are still running
4077 is below a given threshold. For each complete subprocess, the addresses are
4078 post-processed. If we can't find a running process, there is some shambles.
4079 Better not bomb out, as that might lead to multiple copies of the message. Just
4080 log and proceed as if all done.
4083 max maximum number of subprocesses to leave running
4084 fallback TRUE if processing fallback hosts
4090 par_reduce(int max, BOOL fallback)
4092 while (parcount > max)
4094 address_item * doneaddr = par_wait();
4097 log_write(0, LOG_MAIN|LOG_PANIC,
4098 "remote delivery process count got out of step");
4103 transport_instance * tp = doneaddr->transport;
4104 if (tp->max_parallel)
4105 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4107 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4113 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4115 uschar pipe_header[PIPE_HEADER_SIZE+1];
4116 size_t total_len = PIPE_HEADER_SIZE + size;
4118 struct iovec iov[2] = {
4119 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4120 { buf, size } /* *the* data */
4125 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4126 /* complain to log if someone tries with buffer sizes we can't handle*/
4128 if (size > BIG_BUFFER_SIZE-1)
4130 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4131 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4133 size = BIG_BUFFER_SIZE;
4136 /* Should we check that we do not write more than PIPE_BUF? What would
4139 /* convert size to human readable string prepended by id and subid */
4140 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4141 id, subid, (long)size))
4142 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4144 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4145 id, subid, (long)size, pipe_header);
4147 if ((ret = writev(fd, iov, 2)) != total_len)
4148 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4149 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4150 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4153 /*************************************************
4154 * Do remote deliveries *
4155 *************************************************/
4157 /* This function is called to process the addresses in addr_remote. We must
4158 pick off the queue all addresses that have the same transport, remote
4159 destination, and errors address, and hand them to the transport in one go,
4160 subject to some configured limitations. If this is a run to continue delivering
4161 to an existing delivery channel, skip all but those addresses that can go to
4162 that channel. The skipped addresses just get deferred.
4164 If mua_wrapper is set, all addresses must be able to be sent in a single
4165 transaction. If not, this function yields FALSE.
4167 In Exim 4, remote deliveries are always done in separate processes, even
4168 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4169 is so that the base process can retain privilege. This makes the
4170 implementation of fallback transports feasible (though not initially done.)
4172 We create up to the configured number of subprocesses, each of which passes
4173 back the delivery state via a pipe. (However, when sending down an existing
4174 connection, remote_max_parallel is forced to 1.)
4177 fallback TRUE if processing fallback hosts
4179 Returns: TRUE normally
4180 FALSE if mua_wrapper is set and the addresses cannot all be sent
4185 do_remote_deliveries(BOOL fallback)
4190 parcount = 0; /* Number of executing subprocesses */
4192 /* When sending down an existing channel, only do one delivery at a time.
4193 We use a local variable (parmax) to hold the maximum number of processes;
4194 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4196 if (continue_transport) remote_max_parallel = 1;
4197 parmax = remote_max_parallel;
4199 /* If the data for keeping a list of processes hasn't yet been
4204 parlist = store_get(remote_max_parallel * sizeof(pardata), GET_UNTAINTED);
4205 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4206 parlist[poffset].pid = 0;
4207 parpoll = store_get(remote_max_parallel * sizeof(struct pollfd), GET_UNTAINTED);
4210 /* Now loop for each remote delivery */
4212 for (int delivery_count = 0; addr_remote; delivery_count++)
4218 int address_count = 1;
4219 int address_count_max;
4221 BOOL use_initgroups;
4222 BOOL pipe_done = FALSE;
4223 transport_instance *tp;
4224 address_item **anchor = &addr_remote;
4225 address_item *addr = addr_remote;
4226 address_item *last = addr;
4229 uschar * serialize_key = NULL;
4231 /* Pull the first address right off the list. */
4233 addr_remote = addr->next;
4236 DEBUG(D_deliver|D_transport)
4237 debug_printf("--------> %s <--------\n", addr->address);
4239 /* If no transport has been set, there has been a big screw-up somewhere. */
4241 if (!(tp = addr->transport))
4243 f.disable_logging = FALSE; /* Jic */
4244 panicmsg = US"No transport set by router";
4245 goto panic_continue;
4248 /* Check that this base address hasn't previously been delivered to this
4249 transport. The check is necessary at this point to handle homonymic addresses
4250 correctly in cases where the pattern of redirection changes between delivery
4251 attempts. Non-homonymic previous delivery is detected earlier, at routing
4254 if (previously_transported(addr, FALSE)) continue;
4256 /* Force failure if the message is too big. */
4258 if (tp->message_size_limit)
4260 int rc = check_message_size(tp, addr);
4263 addr->transport_return = rc;
4264 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4269 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4270 So look out for the place it gets used.
4273 /* Get the flag which specifies whether the transport can handle different
4274 domains that nevertheless resolve to the same set of hosts. If it needs
4275 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4276 $host, $host_address, $host_port. */
4277 if (tp->expand_multi_domain)
4278 deliver_set_expansions(addr);
4280 if (exp_bool(addr, US"transport", tp->name, D_transport,
4281 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4282 &multi_domain) != OK)
4284 deliver_set_expansions(NULL);
4285 panicmsg = addr->message;
4286 goto panic_continue;
4289 /* Get the maximum it can handle in one envelope, with zero meaning
4290 unlimited, which is forced for the MUA wrapper case and if the
4291 value could vary depending on the messages.
4292 For those, we only split (below) by (tpt,dest,erraddr,hdrs) and rely on the
4293 transport splitting further by max_rcp. So we potentially lose some
4296 address_count_max = mua_wrapper || Ustrchr(tp->max_addresses, '$')
4297 ? UNLIMITED_ADDRS : expand_max_rcpt(tp->max_addresses);
4300 /************************************************************************/
4301 /***** This is slightly experimental code, but should be safe. *****/
4303 /* The address_count_max value is the maximum number of addresses that the
4304 transport can send in one envelope. However, the transport must be capable of
4305 dealing with any number of addresses. If the number it gets exceeds its
4306 envelope limitation, it must send multiple copies of the message. This can be
4307 done over a single connection for SMTP, so uses less resources than making
4308 multiple connections. On the other hand, if remote_max_parallel is greater
4309 than one, it is perhaps a good idea to use parallel processing to move the
4310 message faster, even if that results in multiple simultaneous connections to
4313 How can we come to some compromise between these two ideals? What we do is to
4314 limit the number of addresses passed to a single instance of a transport to
4315 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4316 number of addresses routed to remote transports divided by
4317 remote_max_parallel. For example, if the message has 100 remote recipients,
4318 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4319 once. But if rcpt_max is 100, we could send up to 100.
4321 Of course, not all the remotely addresses in a message are going to go to the
4322 same set of hosts (except in smarthost configurations), so this is just a
4323 heuristic way of dividing up the work.
4325 Furthermore (1), because this may not be wanted in some cases, and also to
4326 cope with really pathological cases, there is also a limit to the number of
4327 messages that are sent over one connection. This is the same limit that is
4328 used when sending several different messages over the same connection.
4329 Continue_sequence is set when in this situation, to the number sent so
4330 far, including this message.
4332 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4333 is probably because they are using VERP, in which case they want to pass only
4334 one address at a time to the transport, in order to be able to use
4335 $local_part and $domain in constructing a new return path. We could test for
4336 the use of these variables, but as it is so likely they will be used when the
4337 maximum is 1, we don't bother. Just leave the value alone. */
4339 if ( address_count_max != 1
4340 && address_count_max < remote_delivery_count/remote_max_parallel
4343 int new_max = remote_delivery_count/remote_max_parallel;
4344 int message_max = tp->connection_max_messages;
4345 if (connection_max_messages >= 0) message_max = connection_max_messages;
4346 message_max -= continue_sequence - 1;
4347 if (message_max > 0 && new_max > address_count_max * message_max)
4348 new_max = address_count_max * message_max;
4349 address_count_max = new_max;
4352 /************************************************************************/
4355 /*XXX don't know yet if DANE will be used. So tpt will have to
4356 check at the point if gets next addr from list, and skip/defer any
4360 /* Pick off all addresses which have the same transport, errors address,
4361 destination, and extra headers. In some cases they point to the same host
4362 list, but we also need to check for identical host lists generated from
4363 entirely different domains. The host list pointers can be NULL in the case
4364 where the hosts are defined in the transport. There is also a configured
4365 maximum limit of addresses that can be handled at once (see comments above
4366 for how it is computed).
4367 If the transport does not handle multiple domains, enforce that also,
4368 and if it might need a per-address check for this, re-evaluate it.
4371 while ((next = *anchor) && address_count < address_count_max)
4374 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4375 && tp == next->transport
4376 && same_hosts(next->host_list, addr->host_list)
4377 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4378 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4379 && same_ugid(tp, next, addr)
4380 && ( next->prop.remove_headers == addr->prop.remove_headers
4381 || ( next->prop.remove_headers
4382 && addr->prop.remove_headers
4383 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4387 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4389 US"transport", next->transport->name, D_transport,
4390 US"multi_domain", next->transport->multi_domain,
4391 next->transport->expand_multi_domain, &md) == OK
4396 *anchor = next->next;
4398 next->first = addr; /* remember top one (for retry processing) */
4403 else anchor = &(next->next);
4404 deliver_set_expansions(NULL);
4407 /* If we are acting as an MUA wrapper, all addresses must go in a single
4408 transaction. If not, put them back on the chain and yield FALSE. */
4410 if (mua_wrapper && addr_remote)
4412 last->next = addr_remote;
4417 /* If the transport is limited for parallellism, enforce that here.
4418 The hints DB entry is decremented in par_reduce(), when we reap the
4419 transport process. */
4421 if (tpt_parallel_check(tp, addr, &serialize_key))
4422 if ((panicmsg = expand_string_message))
4423 goto panic_continue;
4425 continue; /* Loop for the next set of addresses. */
4427 /* Set up the expansion variables for this set of addresses */
4429 deliver_set_expansions(addr);
4431 /* Ensure any transport-set auth info is fresh */
4432 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4434 /* Compute the return path, expanding a new one if required. The old one
4435 must be set first, as it might be referred to in the expansion. */
4437 if(addr->prop.errors_address)
4438 return_path = addr->prop.errors_address;
4440 return_path = sender_address;
4442 if (tp->return_path)
4444 uschar *new_return_path = expand_string(tp->return_path);
4445 if (new_return_path)
4446 return_path = new_return_path;
4447 else if (!f.expand_string_forcedfail)
4449 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4450 tp->return_path, expand_string_message);
4455 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4456 logs and sets up error messages, so we just post-process and continue with
4457 the next address. */
4459 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4465 /* If this transport has a setup function, call it now so that it gets
4466 run in this process and not in any subprocess. That way, the results of
4467 any setup that are retained by the transport can be reusable. One of the
4468 things the setup does is to set the fallback host lists in the addresses.
4469 That is why it is called at this point, before the continue delivery
4470 processing, because that might use the fallback hosts. */
4473 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4475 /* If we have a connection still open from a verify stage (lazy-close)
4476 treat it as if it is a continued connection (apart from the counter used
4477 for the log line mark). */
4479 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4482 debug_printf("lazy-callout-close: have conn still open from verification\n");
4483 continue_transport = cutthrough.transport;
4484 continue_hostname = string_copy(cutthrough.host.name);
4485 continue_host_address = string_copy(cutthrough.host.address);
4486 continue_sequence = 1;
4487 sending_ip_address = cutthrough.snd_ip;
4488 sending_port = cutthrough.snd_port;
4489 smtp_peer_options = cutthrough.peer_options;
4492 /* If this is a run to continue delivery down an already-established
4493 channel, check that this set of addresses matches the transport and
4494 the channel. If it does not, defer the addresses. If a host list exists,
4495 we must check that the continue host is on the list. Otherwise, the
4496 host is set in the transport. */
4498 f.continue_more = FALSE; /* In case got set for the last lot */
4499 if (continue_transport)
4501 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4502 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4504 /* If the transport is about to override the host list do not check
4505 it here but take the cost of running the transport process to discover
4506 if the continued_hostname connection is suitable. This is a layering
4507 violation which is unfortunate as it requires we haul in the smtp
4512 smtp_transport_options_block * ob;
4514 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4515 && (ob = (smtp_transport_options_block *)tp->options_block)
4516 && ob->hosts_override && ob->hosts
4522 for (host_item * h = addr->host_list; h; h = h->next)
4523 if (Ustrcmp(h->name, continue_hostname) == 0)
4524 /*XXX should also check port here */
4525 { ok = TRUE; break; }
4529 /* Addresses not suitable; defer or queue for fallback hosts (which
4530 might be the continue host) and skip to next address. */
4534 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4535 Ustrcmp(continue_transport, tp->name) != 0
4536 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4537 : string_sprintf("no host matching %s", continue_hostname));
4538 if (serialize_key) enq_end(serialize_key);
4540 if (addr->fallback_hosts && !fallback)
4542 for (next = addr; ; next = next->next)
4544 next->host_list = next->fallback_hosts;
4545 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4546 if (!next->next) break;
4548 next->next = addr_fallback;
4549 addr_fallback = addr;
4554 for (next = addr; ; next = next->next)
4556 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4557 if (!next->next) break;
4559 next->next = addr_defer;
4566 /* Set a flag indicating whether there are further addresses that list
4567 the continued host. This tells the transport to leave the channel open,
4568 but not to pass it to another delivery process. We'd like to do that
4569 for non-continue_transport cases too but the knowlege of which host is
4570 connected to is too hard to manage. Perhaps we need a finer-grain
4571 interface to the transport. */
4573 for (next = addr_remote; next && !f.continue_more; next = next->next)
4574 for (host_item * h = next->host_list; h; h = h->next)
4575 if (Ustrcmp(h->name, continue_hostname) == 0)
4576 { f.continue_more = TRUE; break; }
4579 /* The transports set up the process info themselves as they may connect
4580 to more than one remote machine. They also have to set up the filter
4581 arguments, if required, so that the host name and address are available
4584 transport_filter_argv = NULL;
4586 /* Create the pipe for inter-process communication. If pipe creation
4587 fails, it is probably because the value of remote_max_parallel is so
4588 large that too many file descriptors for pipes have been created. Arrange
4589 to wait for a process to finish, and then try again. If we still can't
4590 create a pipe when all processes have finished, break the retry loop. */
4594 if (pipe(pfd) == 0) pipe_done = TRUE;
4595 else if (parcount > 0) parmax = parcount;
4598 /* We need to make the reading end of the pipe non-blocking. There are
4599 two different options for this. Exim is cunningly (I hope!) coded so
4600 that it can use either of them, though it prefers O_NONBLOCK, which
4601 distinguishes between EOF and no-more-data. */
4603 /* The data appears in a timely manner and we already did a poll on
4604 all pipes, so I do not see a reason to use non-blocking IO here
4607 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4609 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4613 /* If the maximum number of subprocesses already exist, wait for a process
4614 to finish. If we ran out of file descriptors, parmax will have been reduced
4615 from its initial value of remote_max_parallel. */
4617 par_reduce(parmax - 1, fallback);
4620 /* If we failed to create a pipe and there were no processes to wait
4621 for, we have to give up on this one. Do this outside the above loop
4622 so that we can continue the main loop. */
4626 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4630 /* Find a free slot in the pardata list. Must do this after the possible
4631 waiting for processes to finish, because a terminating process will free
4634 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4635 if (parlist[poffset].pid == 0)
4638 /* If there isn't one, there has been a horrible disaster. */
4640 if (poffset >= remote_max_parallel)
4642 (void)close(pfd[pipe_write]);
4643 (void)close(pfd[pipe_read]);
4644 panicmsg = US"Unexpectedly no free subprocess slot";
4648 /* Now fork a subprocess to do the remote delivery, but before doing so,
4649 ensure that any cached resources are released so as not to interfere with
4650 what happens in the subprocess. */
4654 if ((pid = exim_fork(US"transport")) == 0)
4656 int fd = pfd[pipe_write];
4659 /* Setting these globals in the subprocess means we need never clear them */
4661 transport_name = tp->name;
4662 if (addr->router) router_name = addr->router->name;
4663 driver_srcfile = tp->srcfile;
4664 driver_srcline = tp->srcline;
4666 /* There are weird circumstances in which logging is disabled */
4667 f.disable_logging = tp->disable_logging;
4669 /* Show pids on debug output if parallelism possible */
4671 if (parmax > 1 && (parcount > 0 || addr_remote))
4672 DEBUG(D_any|D_v) debug_selector |= D_pid;
4674 /* Reset the random number generator, so different processes don't all
4675 have the same sequence. In the test harness we want different, but
4676 predictable settings for each delivery process, so do something explicit
4677 here rather they rely on the fixed reset in the random number function. */
4679 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4681 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4682 a new process that may be forked to do another delivery down the same
4685 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4687 /* Close open file descriptors for the pipes of other processes
4688 that are running in parallel. */
4690 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4691 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4693 /* This process has inherited a copy of the file descriptor
4694 for the data file, but its file pointer is shared with all the
4695 other processes running in parallel. Therefore, we have to re-open
4696 the file in order to get a new file descriptor with its own
4697 file pointer. We don't need to lock it, as the lock is held by
4698 the parent process. There doesn't seem to be any way of doing
4699 a dup-with-new-file-pointer. */
4701 (void)close(deliver_datafile);
4703 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4705 if ( (deliver_datafile = Uopen(fname, EXIM_CLOEXEC | O_RDWR | O_APPEND, 0))
4707 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4708 "parallel delivery: %s", fname, strerror(errno));
4711 #ifndef O_CLOEXEC /* Set the close-on-exec flag */
4712 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4716 /* Set the uid/gid of this process; bombs out on failure. */
4718 exim_setugid(uid, gid, use_initgroups,
4719 string_sprintf("remote delivery to %s with transport=%s",
4720 addr->address, tp->name));
4722 /* Close the unwanted half of this process' pipe, set the process state,
4723 and run the transport. Afterwards, transport_count will contain the number
4724 of bytes written. */
4726 (void)close(pfd[pipe_read]);
4727 set_process_info("delivering %s using %s", message_id, tp->name);
4728 debug_print_string(tp->debug_string);
4729 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4731 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4732 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4734 /* Ensure any cached resources that we used are now released */
4738 /* Pass the result back down the pipe. This is a lot more information
4739 than is needed for a local delivery. We have to send back the error
4740 status for each address, the usability status for each host that is
4741 flagged as unusable, and all the retry items. When TLS is in use, we
4742 send also the cipher and peerdn information. Each type of information
4743 is flagged by an identifying byte, and is then in a fixed format (with
4744 strings terminated by zeros), and there is a final terminator at the
4745 end. The host information and retry information is all attached to
4746 the first address, so that gets sent at the start. */
4748 /* Host unusability information: for most success cases this will
4751 for (h = addr->host_list; h; h = h->next)
4753 if (!h->address || h->status < hstatus_unusable) continue;
4754 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4755 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4758 /* The number of bytes written. This is the same for each address. Even
4759 if we sent several copies of the message down the same connection, the
4760 size of each one is the same, and it's that value we have got because
4761 transport_count gets reset before calling transport_write_message(). */
4763 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4764 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4766 /* Information about what happened to each address. Four item types are
4767 used: an optional 'X' item first, for TLS information, then an optional "C"
4768 item for any client-auth info followed by 'R' items for any retry settings,
4769 and finally an 'A' item for the remaining data. */
4771 for(; addr; addr = addr->next)
4775 /* The certificate verification status goes into the flags */
4776 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4778 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4780 # ifndef DISABLE_TLS_RESUME
4781 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4784 /* Use an X item only if there's something to send */
4788 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4792 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4794 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4796 else if (continue_proxy_cipher)
4798 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4800 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4806 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4810 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4815 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4819 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4821 # ifndef DISABLE_OCSP
4822 if (addr->ocsp > OCSP_NOT_REQ)
4824 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4825 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4828 #endif /*DISABLE_TLS*/
4830 if (client_authenticator)
4832 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4833 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4835 if (client_authenticated_id)
4837 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4838 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4840 if (client_authenticated_sender)
4842 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4843 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4846 #ifndef DISABLE_PRDR
4847 if (testflag(addr, af_prdr_used))
4848 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4851 if (testflag(addr, af_pipelining))
4852 #ifndef DISABLE_PIPE_CONNECT
4853 if (testflag(addr, af_early_pipe))
4854 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4857 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4859 if (testflag(addr, af_chunking_used))
4860 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4862 if (testflag(addr, af_tcp_fastopen_conn))
4863 rmt_dlv_checked_write(fd, 'T',
4864 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4868 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4869 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4871 /* Retry information: for most success cases this will be null. */
4873 for (retry_item * r = addr->retries; r; r = r->next)
4875 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4876 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4877 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4878 ptr += sizeof(r->basic_errno);
4879 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4880 ptr += sizeof(r->more_errno);
4881 if (!r->message) *ptr++ = 0; else
4883 sprintf(CS ptr, "%.512s", r->message);
4886 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4889 if (testflag(addr, af_new_conn) || testflag(addr, af_cont_conn))
4891 DEBUG(D_deliver) debug_printf("%scontinued-connection\n",
4892 testflag(addr, af_new_conn) ? "non-" : "");
4893 big_buffer[0] = testflag(addr, af_new_conn) ? BIT(1) : BIT(2);
4894 rmt_dlv_checked_write(fd, 'A', '3', big_buffer, 1);
4897 #ifdef SUPPORT_SOCKS
4898 if (LOGGING(proxy) && proxy_session)
4901 if (proxy_local_address)
4903 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4904 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4905 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4906 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4907 ptr += sizeof(proxy_local_port);
4911 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4915 #ifdef EXPERIMENTAL_DSN_INFO
4916 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4917 if (addr->smtp_greeting)
4919 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4920 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4921 if (addr->helo_response)
4923 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4924 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4928 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4932 /* The rest of the information goes in an 'A0' item. */
4934 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4935 ptr = big_buffer + 2;
4936 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4937 ptr += sizeof(addr->basic_errno);
4938 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4939 ptr += sizeof(addr->more_errno);
4940 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4941 ptr += sizeof(addr->delivery_time);
4942 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4943 ptr += sizeof(addr->flags);
4945 if (!addr->message) *ptr++ = 0; else
4946 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4948 if (!addr->user_message) *ptr++ = 0; else
4949 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4951 if (!addr->host_used) *ptr++ = 0; else
4953 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4954 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4955 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4956 ptr += sizeof(addr->host_used->port);
4958 /* DNS lookup status */
4959 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4960 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4963 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4966 /* Local interface address/port */
4967 #ifdef EXPERIMENTAL_DSN_INFO
4968 if (sending_ip_address)
4970 if (LOGGING(incoming_interface) && sending_ip_address)
4974 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4975 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4976 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4979 /* Add termination flag, close the pipe, and that's it. The character
4980 after 'Z' indicates whether continue_transport is now NULL or not.
4981 A change from non-NULL to NULL indicates a problem with a continuing
4984 big_buffer[0] = continue_transport ? '1' : '0';
4985 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4990 /* Back in the mainline: close the unwanted half of the pipe. */
4992 (void)close(pfd[pipe_write]);
4994 /* If we have a connection still open from a verify stage (lazy-close)
4995 release its TLS library context (if any) as responsibility was passed to
4996 the delivery child process. */
4998 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5001 if (cutthrough.is_tls)
5002 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5004 (void) close(cutthrough.cctx.sock);
5005 release_cutthrough_connection(US"passed to transport proc");
5008 /* Fork failed; defer with error message */
5012 (void)close(pfd[pipe_read]);
5013 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5014 addr->domain, strerror(errno));
5018 /* Fork succeeded; increment the count, and remember relevant data for
5019 when the process finishes. */
5022 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5023 parlist[poffset].pid = pid;
5024 parlist[poffset].fd = pfd[pipe_read];
5025 parlist[poffset].done = FALSE;
5026 parlist[poffset].msg = NULL;
5027 parlist[poffset].return_path = return_path;
5029 /* If the process we've just started is sending a message down an existing
5030 channel, wait for it now. This ensures that only one such process runs at
5031 once, whatever the value of remote_max parallel. Otherwise, we might try to
5032 send two or more messages simultaneously down the same channel. This could
5033 happen if there are different domains that include the same host in otherwise
5034 different host lists.
5036 Also, if the transport closes down the channel, this information gets back
5037 (continue_transport gets set to NULL) before we consider any other addresses
5040 if (continue_transport) par_reduce(0, fallback);
5042 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5043 newly created process get going before we create another process. This should
5044 ensure repeatability in the tests. Wait long enough for most cases to complete
5047 else testharness_pause_ms(600);
5052 if (serialize_key) enq_end(serialize_key);
5054 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5058 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5059 are still running and post-process their addresses. */
5061 par_reduce(0, fallback);
5068 /*************************************************
5069 * Split an address into local part and domain *
5070 *************************************************/
5072 /* This function initializes an address for routing by splitting it up into a
5073 local part and a domain. The local part is set up twice - once in its original
5074 casing, and once in lower case, and it is dequoted. We also do the "percent
5075 hack" for configured domains. This may lead to a DEFER result if a lookup
5076 defers. When a percent-hacking takes place, we insert a copy of the original
5077 address as a new parent of this address, as if we have had a redirection.
5080 addr points to an addr_item block containing the address
5083 DEFER - could not determine if domain is %-hackable
5087 deliver_split_address(address_item * addr)
5089 uschar * address = addr->address;
5094 if (!(domain = Ustrrchr(address, '@')))
5095 return DEFER; /* should always have a domain, but just in case... */
5097 len = domain - address;
5098 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5100 /* The implication in the RFCs (though I can't say I've seen it spelled out
5101 explicitly) is that quoting should be removed from local parts at the point
5102 where they are locally interpreted. [The new draft "821" is more explicit on
5103 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5104 removing quoting backslashes and any unquoted doublequotes. */
5106 t = addr->cc_local_part = store_get(len+1, address);
5110 if (c == '\"') continue;
5120 /* We do the percent hack only for those domains that are listed in
5121 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5123 if (percent_hack_domains)
5126 uschar *new_address = NULL;
5127 uschar *local_part = addr->cc_local_part;
5129 deliver_domain = addr->domain; /* set $domain */
5131 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5132 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5134 && (t = Ustrrchr(local_part, '%')) != NULL
5137 new_address = string_copy(local_part);
5138 new_address[t - local_part] = '@';
5139 deliver_domain = string_copylc(t+1);
5140 local_part = string_copyn(local_part, t - local_part);
5143 if (rc == DEFER) return DEFER; /* lookup deferred */
5145 /* If hackery happened, set up new parent and alter the current address. */
5149 address_item * new_parent = store_get(sizeof(address_item), GET_UNTAINTED);
5150 *new_parent = *addr;
5151 addr->parent = new_parent;
5152 new_parent->child_count = 1;
5153 addr->address = new_address;
5154 addr->unique = string_copy(new_address);
5155 addr->domain = deliver_domain;
5156 addr->cc_local_part = local_part;
5157 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5162 /* Create the lowercased version of the final local part, and make that the
5163 default one to be used. */
5165 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5172 /*************************************************
5173 * Get next error message text *
5174 *************************************************/
5176 /* If f is not NULL, read the next "paragraph", from a customized error message
5177 text file, terminated by a line containing ****, and expand it.
5180 f NULL or a file to read from
5181 which string indicating which string (for errors)
5183 Returns: NULL or an expanded string
5187 next_emf(FILE *f, uschar *which)
5193 if (!f) return NULL;
5195 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5198 para = string_get(256);
5201 para = string_cat(para, buffer);
5202 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5205 if ((yield = expand_string(string_from_gstring(para))))
5208 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5209 "bounce_message_file or warn_message_file (%s): %s", which,
5210 expand_string_message);
5217 /*************************************************
5218 * Close down a passed transport channel *
5219 *************************************************/
5221 /* This function is called when a passed transport channel cannot be used.
5222 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5223 so that the function call can be the argument of a "return" statement.
5226 Returns: DELIVER_NOT_ATTEMPTED
5230 continue_closedown(void)
5232 if (continue_transport)
5233 for (transport_instance * t = transports; t; t = t->next)
5234 if (Ustrcmp(t->name, continue_transport) == 0)
5236 if (t->info->closedown) (t->info->closedown)(t);
5239 return DELIVER_NOT_ATTEMPTED;
5245 /*************************************************
5246 * Print address information *
5247 *************************************************/
5249 /* This function is called to output an address, or information about an
5250 address, for bounce or defer messages. If the hide_child flag is set, all we
5251 output is the original ancestor address.
5254 addr points to the address
5255 f the FILE to print to
5256 si an initial string
5257 sc a continuation string for before "generated"
5260 Returns: TRUE if the address is not hidden
5264 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5268 uschar *printed = US"";
5269 address_item *ancestor = addr;
5270 while (ancestor->parent) ancestor = ancestor->parent;
5272 fprintf(f, "%s", CS si);
5274 if (addr->parent && testflag(addr, af_hide_child))
5276 printed = US"an undisclosed address";
5279 else if (!testflag(addr, af_pfr) || !addr->parent)
5280 printed = addr->address;
5284 uschar *s = addr->address;
5287 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5288 else if (addr->address[0] == '|') ss = US"pipe";
5291 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5292 printed = addr->parent->address;
5295 fprintf(f, "%s", CS string_printing(printed));
5297 if (ancestor != addr)
5299 uschar *original = ancestor->onetime_parent;
5300 if (!original) original= ancestor->address;
5301 if (strcmpic(original, printed) != 0)
5302 fprintf(f, "%s(%sgenerated from %s)", sc,
5303 ancestor != addr->parent ? "ultimately " : "",
5304 string_printing(original));
5307 if (addr->host_used)
5308 fprintf(f, "\n host %s [%s]",
5309 addr->host_used->name, addr->host_used->address);
5311 fprintf(f, "%s", CS se);
5319 /*************************************************
5320 * Print error for an address *
5321 *************************************************/
5323 /* This function is called to print the error information out of an address for
5324 a bounce or a warning message. It tries to format the message reasonably by
5325 introducing newlines. All lines are indented by 4; the initial printing
5326 position must be set before calling.
5328 This function used always to print the error. Nowadays we want to restrict it
5329 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5330 and filter "fail". We no longer pass other information willy-nilly in bounce
5331 and warning messages. Text in user_message is always output; text in message
5332 only if the af_pass_message flag is set.
5336 f the FILE to print on
5343 print_address_error(address_item * addr, FILE * f, const uschar * t)
5345 int count = Ustrlen(t);
5346 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5348 if (!s && !(s = addr->user_message))
5351 fprintf(f, "\n %s", t);
5354 if (*s == '\\' && s[1] == 'n')
5364 if (*s++ == ':' && isspace(*s) && count > 45)
5366 fprintf(f, "\n "); /* sic (because space follows) */
5369 else if (count > 254) /* arbitrary limit */
5371 fprintf(f, "[truncated]");
5372 do s++; while (*s && !(*s == '\\' && s[1] == '\n'));
5378 /***********************************************************
5379 * Print Diagnostic-Code for an address *
5380 ************************************************************/
5382 /* This function is called to print the error information out of an address for
5383 a bounce or a warning message. It tries to format the message reasonably as
5384 required by RFC 3461 by adding a space after each newline
5386 it uses the same logic as print_address_error() above. if af_pass_message is true
5387 and addr->message is set it uses the remote host answer. if not addr->user_message
5388 is used instead if available.
5392 f the FILE to print on
5398 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5400 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5403 /* af_pass_message and addr->message set ? print remote host answer */
5408 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5410 /* search first ": ". we assume to find the remote-MTA answer there */
5411 if (!(s = Ustrstr(addr->message, ": ")))
5412 return; /* not found, bail out */
5414 s += 2; /* skip ": " */
5415 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5419 if (cnt > 950) /* RFC line length limit: 998 */
5421 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5422 fputs("[truncated]", f);
5426 if (*s == '\\' && s[1] == 'n')
5428 fputs("\n ", f); /* as defined in RFC 3461 */
5443 /*************************************************
5444 * Check list of addresses for duplication *
5445 *************************************************/
5447 /* This function was introduced when the test for duplicate addresses that are
5448 not pipes, files, or autoreplies was moved from the middle of routing to when
5449 routing was complete. That was to fix obscure cases when the routing history
5450 affects the subsequent routing of identical addresses. This function is called
5451 after routing, to check that the final routed addresses are not duplicates.
5453 If we detect a duplicate, we remember what it is a duplicate of. Note that
5454 pipe, file, and autoreply de-duplication is handled during routing, so we must
5455 leave such "addresses" alone here, as otherwise they will incorrectly be
5458 Argument: address of list anchor
5463 do_duplicate_check(address_item **anchor)
5466 while ((addr = *anchor))
5469 if (testflag(addr, af_pfr))
5471 anchor = &(addr->next);
5473 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5475 DEBUG(D_deliver|D_route)
5476 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5477 *anchor = addr->next;
5478 addr->dupof = tnode->data.ptr;
5479 addr->next = addr_duplicate;
5480 addr_duplicate = addr;
5484 tree_add_duplicate(addr->unique, addr);
5485 anchor = &(addr->next);
5493 /************************************************/
5496 print_dsn_addr_action(FILE * f, address_item * addr,
5497 uschar * action, uschar * status)
5501 if (addr->dsn_orcpt)
5502 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5504 for (pa = addr; pa->parent; ) pa = pa->parent;
5505 fprintf(f, "Action: %s\n"
5506 "Final-Recipient: rfc822;%s\n"
5508 action, pa->address, status);
5513 /* When running in the test harness, there's an option that allows us to
5514 fudge this time so as to get repeatability of the tests. Take the first
5515 time off the list. In queue runs, the list pointer gets updated in the
5519 test_harness_fudged_queue_time(int actual_time)
5522 if ( f.running_in_test_harness && *fudged_queue_times
5523 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5525 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5526 fudged_queue_times);
5532 /************************************************/
5535 expand_open(const uschar * filename,
5536 const uschar * varname, const uschar * reason)
5538 const uschar * s = expand_cstring(filename);
5542 log_write(0, LOG_MAIN|LOG_PANIC,
5543 "Failed to expand %s: '%s'\n", varname, filename);
5544 else if (*s != '/' || is_tainted(s))
5545 log_write(0, LOG_MAIN|LOG_PANIC,
5546 "%s is not %s after expansion: '%s'\n",
5547 varname, *s == '/' ? "untainted" : "absolute", s);
5548 else if (!(fp = Ufopen(s, "rb")))
5549 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5550 "message texts: %s", s, reason, strerror(errno));
5555 /* Output the given header and string, converting either
5556 the sequence "\n" or a real newline into newline plus space.
5557 If that still takes us past column 78, look for the last space
5558 and split there too.
5559 Append a newline if string did not have one.
5560 Limit to about 1024 chars total. */
5563 dsn_put_wrapped(FILE * fp, const uschar * header, const uschar * s)
5565 gstring * g = string_cat(NULL, header);
5567 g = string_cat(g, s);
5568 gstring_release_unused(g);
5569 fprintf(fp, "%s\n", wrap_header(string_from_gstring(g), 79, 1023, US" ", 1));
5575 /*************************************************
5576 * Send a bounce message *
5577 *************************************************/
5579 /* Find the error address for the first address, then send a message that
5580 includes all failed addresses that have the same error address. Note the
5581 bounce_recipient is a global so that it can be accessed by $bounce_recipient
5582 while creating a customized error message. */
5585 send_bounce_message(time_t now, const uschar * logtod)
5590 if (!(bounce_recipient = addr_failed->prop.errors_address))
5591 bounce_recipient = sender_address;
5593 /* Make a subprocess to send a message, using its stdin */
5595 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
5596 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
5597 "create child process to send failure message: %s", getpid(),
5598 getppid(), strerror(errno));
5600 /* Creation of child succeeded */
5604 int ch, rc, filecount = 0, rcount = 0;
5605 uschar * bcc, * emf_text;
5606 FILE * fp = fdopen(fd, "wb"), * emf = NULL;
5607 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
5608 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
5609 DELIVER_IN_BUFFER_SIZE;
5610 uschar * bound, * dsnlimitmsg, * dsnnotifyhdr;
5612 address_item ** paddr;
5613 address_item * msgchain = NULL, ** pmsgchain = &msgchain;
5614 address_item * handled_addr = NULL;
5617 debug_printf("sending error message to: %s\n", bounce_recipient);
5619 /* Scan the addresses for all that have the same errors address, removing
5620 them from the addr_failed chain, and putting them on msgchain. */
5622 paddr = &addr_failed;
5623 for (address_item * addr = addr_failed; addr; addr = *paddr)
5624 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
5625 ? addr->prop.errors_address : sender_address) == 0)
5626 { /* The same - dechain */
5627 *paddr = addr->next;
5630 pmsgchain = &addr->next;
5633 paddr = &addr->next; /* Not the same; skip */
5635 /* Include X-Failed-Recipients: for automatic interpretation, but do
5636 not let any one header line get too long. We do this by starting a
5637 new header every 50 recipients. Omit any addresses for which the
5638 "hide_child" flag is set. */
5640 for (address_item * addr = msgchain; addr; addr = addr->next)
5642 if (testflag(addr, af_hide_child)) continue;
5650 ? "X-Failed-Recipients: "
5652 testflag(addr, af_pfr) && addr->parent
5653 ? string_printing(addr->parent->address)
5654 : string_printing(addr->address));
5656 if (rcount > 0) fprintf(fp, "\n");
5658 /* Output the standard headers */
5660 if (errors_reply_to)
5661 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
5662 fprintf(fp, "Auto-Submitted: auto-replied\n");
5663 moan_write_from(fp);
5664 fprintf(fp, "To: %s\n", bounce_recipient);
5665 moan_write_references(fp, NULL);
5667 /* generate boundary string and output MIME-Headers */
5668 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
5670 fprintf(fp, "Content-Type: multipart/report;"
5671 " report-type=delivery-status; boundary=%s\n"
5672 "MIME-Version: 1.0\n",
5675 /* Open a template file if one is provided. Log failure to open, but
5676 carry on - default texts will be used. */
5678 if (bounce_message_file)
5679 emf = expand_open(bounce_message_file,
5680 US"bounce_message_file", US"error");
5682 /* Quietly copy to configured additional addresses if required. */
5684 if ((bcc = moan_check_errorcopy(bounce_recipient)))
5685 fprintf(fp, "Bcc: %s\n", bcc);
5687 /* The texts for the message can be read from a template file; if there
5688 isn't one, or if it is too short, built-in texts are used. The first
5689 emf text is a Subject: and any other headers. */
5691 if ((emf_text = next_emf(emf, US"header")))
5692 fprintf(fp, "%s\n", emf_text);
5694 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
5695 to_sender? ": returning message to sender" : "");
5697 /* output human readable part as text/plain section */
5698 fprintf(fp, "--%s\n"
5699 "Content-type: text/plain; charset=us-ascii\n\n",
5702 if ((emf_text = next_emf(emf, US"intro")))
5703 fprintf(fp, "%s", CS emf_text);
5707 /* This message has been reworded several times. It seems to be confusing to
5708 somebody, however it is worded. I have retreated to the original, simple
5710 "This message was created automatically by mail delivery software.\n");
5712 if (bounce_message_text)
5713 fprintf(fp, "%s", CS bounce_message_text);
5716 "\nA message that you sent could not be delivered to one or more of its\n"
5717 "recipients. This is a permanent error. The following address(es) failed:\n");
5720 "\nA message sent by\n\n <%s>\n\n"
5721 "could not be delivered to one or more of its recipients. The following\n"
5722 "address(es) failed:\n", sender_address);
5726 /* Process the addresses, leaving them on the msgchain if they have a
5727 file name for a return message. (There has already been a check in
5728 post_process_one() for the existence of data in the message file.) A TRUE
5729 return from print_address_information() means that the address is not
5733 for (address_item * addr = msgchain; addr; addr = *paddr)
5735 if (print_address_information(addr, fp, US" ", US"\n ", US""))
5736 print_address_error(addr, fp, US"");
5738 /* End the final line for the address */
5742 /* Leave on msgchain if there's a return file. */
5744 if (addr->return_file >= 0)
5746 paddr = &addr->next;
5750 /* Else save so that we can tick off the recipient when the
5755 *paddr = addr->next;
5756 addr->next = handled_addr;
5757 handled_addr = addr;
5763 /* Get the next text, whether we need it or not, so as to be
5764 positioned for the one after. */
5766 emf_text = next_emf(emf, US"generated text");
5768 /* If there were any file messages passed by the local transports,
5769 include them in the message. Then put the address on the handled chain.
5770 In the case of a batch of addresses that were all sent to the same
5771 transport, the return_file field in all of them will contain the same
5772 fd, and the return_filename field in the *last* one will be set (to the
5773 name of the file). */
5777 address_item * nextaddr;
5780 fprintf(fp, "%s", CS emf_text);
5783 "The following text was generated during the delivery "
5784 "attempt%s:\n", (filecount > 1)? "s" : "");
5786 for (address_item * addr = msgchain; addr; addr = nextaddr)
5789 address_item *topaddr = addr;
5791 /* List all the addresses that relate to this file */
5794 while(addr) /* Insurance */
5796 print_address_information(addr, fp, US"------ ", US"\n ",
5798 if (addr->return_filename) break;
5803 /* Now copy the file */
5805 if (!(fm = Ufopen(addr->return_filename, "rb")))
5806 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
5810 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
5813 Uunlink(addr->return_filename);
5815 /* Can now add to handled chain, first fishing off the next
5816 address on the msgchain. */
5818 nextaddr = addr->next;
5819 addr->next = handled_addr;
5820 handled_addr = topaddr;
5825 /* output machine readable part */
5827 if (message_smtputf8)
5828 fprintf(fp, "--%s\n"
5829 "Content-type: message/global-delivery-status\n\n"
5830 "Reporting-MTA: dns; %s\n",
5831 bound, smtp_active_hostname);
5834 fprintf(fp, "--%s\n"
5835 "Content-type: message/delivery-status\n\n"
5836 "Reporting-MTA: dns; %s\n",
5837 bound, smtp_active_hostname);
5841 /* must be decoded from xtext: see RFC 3461:6.3a */
5842 uschar * xdec_envid;
5843 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
5844 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
5846 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
5850 for (address_item * addr = handled_addr; addr; addr = addr->next)
5853 #ifdef EXPERIMENTAL_DSN_INFO
5857 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
5859 if ((hu = addr->host_used) && hu->name)
5861 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
5862 #ifdef EXPERIMENTAL_DSN_INFO
5865 uschar * p = hu->port == 25
5866 ? US"" : string_sprintf(":%d", hu->port);
5867 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
5869 if ((s = addr->smtp_greeting) && *s)
5870 dsn_put_wrapped(fp, US"X-Remote-MTA-smtp-greeting: X-str; ", s);
5871 if ((s = addr->helo_response) && *s)
5872 dsn_put_wrapped(fp, US"X-Remote-MTA-helo-response: X-str; ", s);
5873 if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5874 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5876 print_dsn_diagnostic_code(addr, fp);
5878 #ifdef EXPERIMENTAL_DSN_INFO
5879 else if (testflag(addr, af_pass_message) && (s = addr->message) && *s)
5880 dsn_put_wrapped(fp, US"X-Exim-Diagnostic: X-str; ", s);
5885 /* Now copy the message, trying to give an intelligible comment if
5886 it is too long for it all to be copied. The limit isn't strictly
5887 applied because of the buffering. There is, however, an option
5888 to suppress copying altogether. */
5890 emf_text = next_emf(emf, US"copy");
5893 we ignore the intro text from template and add
5894 the text for bounce_return_size_limit at the end.
5896 bounce_return_message is ignored
5897 in case RET= is defined we honor these values
5898 otherwise bounce_return_body is honored.
5900 bounce_return_size_limit is always honored.
5903 fprintf(fp, "--%s\n", bound);
5905 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
5906 dsnnotifyhdr = NULL;
5907 topt = topt_add_return_path;
5909 /* RET=HDRS? top priority */
5910 if (dsn_ret == dsn_ret_hdrs)
5911 topt |= topt_no_body;
5914 struct stat statbuf;
5916 /* no full body return at all? */
5917 if (!bounce_return_body)
5919 topt |= topt_no_body;
5920 /* add header if we overrule RET=FULL */
5921 if (dsn_ret == dsn_ret_full)
5922 dsnnotifyhdr = dsnlimitmsg;
5924 /* line length limited... return headers only if oversize */
5925 /* size limited ... return headers only if limit reached */
5926 else if ( max_received_linelength > bounce_return_linesize_limit
5927 || ( bounce_return_size_limit > 0
5928 && fstat(deliver_datafile, &statbuf) == 0
5929 && statbuf.st_size > max
5932 topt |= topt_no_body;
5933 dsnnotifyhdr = dsnlimitmsg;
5938 if (message_smtputf8)
5939 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
5940 : "Content-type: message/global\n\n",
5944 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
5945 : "Content-type: message/rfc822\n\n",
5949 transport_filter_argv = NULL; /* Just in case */
5950 return_path = sender_address; /* In case not previously set */
5951 { /* Dummy transport for headers add */
5952 transport_ctx tctx = {{0}};
5953 transport_instance tb = {0};
5955 tctx.u.fd = fileno(fp);
5957 tctx.options = topt | topt_truncate_headers;
5958 tb.add_headers = dsnnotifyhdr;
5960 /*XXX no checking for failure! buggy! */
5961 transport_write_message(&tctx, 0);
5965 /* we never add the final text. close the file */
5969 fprintf(fp, "\n--%s--\n", bound);
5971 /* Close the file, which should send an EOF to the child process
5972 that is receiving the message. Wait for it to finish. */
5975 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
5977 /* If the process failed, there was some disaster in setting up the
5978 error message. Unless the message is very old, ensure that addr_defer
5979 is non-null, which will have the effect of leaving the message on the
5980 spool. The failed addresses will get tried again next time. However, we
5981 don't really want this to happen too often, so freeze the message unless
5982 there are some genuine deferred addresses to try. To do this we have
5983 to call spool_write_header() here, because with no genuine deferred
5984 addresses the normal code below doesn't get run. */
5989 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
5991 addr_defer = (address_item *)(+1);
5992 f.deliver_freeze = TRUE;
5993 deliver_frozen_at = time(NULL);
5994 /* Panic-dies on error */
5995 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5998 deliver_msglog("Process failed (%d) when writing error message "
5999 "to %s%s", rc, bounce_recipient, s);
6000 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
6001 "to %s%s", rc, bounce_recipient, s);
6004 /* The message succeeded. Ensure that the recipients that failed are
6005 now marked finished with on the spool and their parents updated. */
6009 for (address_item * addr = handled_addr; addr; addr = addr->next)
6011 address_done(addr, logtod);
6012 child_done(addr, logtod);
6014 /* Panic-dies on error */
6015 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6020 /*************************************************
6021 * Send a warning message *
6022 *************************************************/
6023 /* Return: boolean success */
6026 send_warning_message(const uschar * recipients, int queue_time, int show_time)
6029 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
6030 FILE * wmf = NULL, * f = fdopen(fd, "wb");
6031 uschar * wmf_text, * bound;
6032 transport_ctx tctx = {{0}};
6035 if (pid <= 0) return FALSE;
6037 if (warn_message_file)
6038 wmf = expand_open(warn_message_file,
6039 US"warn_message_file", US"warning");
6041 warnmsg_recipients = recipients;
6042 warnmsg_delay = queue_time < 120*60
6043 ? string_sprintf("%d minutes", show_time/60)
6044 : string_sprintf("%d hours", show_time/3600);
6046 if (errors_reply_to)
6047 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6048 fprintf(f, "Auto-Submitted: auto-replied\n");
6050 fprintf(f, "To: %s\n", recipients);
6051 moan_write_references(f, NULL);
6053 /* generated boundary string and output MIME-Headers */
6054 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6056 fprintf(f, "Content-Type: multipart/report;"
6057 " report-type=delivery-status; boundary=%s\n"
6058 "MIME-Version: 1.0\n",
6061 if ((wmf_text = next_emf(wmf, US"header")))
6062 fprintf(f, "%s\n", wmf_text);
6064 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
6065 message_id, warnmsg_delay);
6067 /* output human readable part as text/plain section */
6069 "Content-type: text/plain; charset=us-ascii\n\n",
6072 if ((wmf_text = next_emf(wmf, US"intro")))
6073 fprintf(f, "%s", CS wmf_text);
6077 "This message was created automatically by mail delivery software.\n");
6079 if (Ustrcmp(recipients, sender_address) == 0)
6081 "A message that you sent has not yet been delivered to one or more of its\n"
6082 "recipients after more than ");
6086 "A message sent by\n\n <%s>\n\n"
6087 "has not yet been delivered to one or more of its recipients after more than \n",
6090 fprintf(f, "%s on the queue on %s.\n\n"
6091 "The message identifier is: %s\n",
6092 warnmsg_delay, primary_hostname, message_id);
6094 for (header_line * h = header_list; h; h = h->next)
6095 if (strncmpic(h->text, US"Subject:", 8) == 0)
6096 fprintf(f, "The subject of the message is: %s", h->text + 9);
6097 else if (strncmpic(h->text, US"Date:", 5) == 0)
6098 fprintf(f, "The date of the message is: %s", h->text + 6);
6101 fprintf(f, "The address%s to which the message has not yet been "
6103 !addr_defer->next ? "" : "es",
6104 !addr_defer->next ? "is": "are");
6107 /* List the addresses, with error information if allowed */
6110 for (address_item * addr = addr_defer; addr; addr = addr->next)
6112 if (print_address_information(addr, f, US" ", US"\n ", US""))
6113 print_address_error(addr, f, US"Delay reason: ");
6122 if ((wmf_text = next_emf(wmf, US"final")))
6123 fprintf(f, "%s", CS wmf_text);
6129 "No action is required on your part. Delivery attempts will continue for\n"
6130 "some time, and this warning may be repeated at intervals if the message\n"
6131 "remains undelivered. Eventually the mail delivery software will give up,\n"
6132 "and when that happens, the message will be returned to you.\n");
6135 /* output machine readable part */
6136 fprintf(f, "\n--%s\n"
6137 "Content-type: message/delivery-status\n\n"
6138 "Reporting-MTA: dns; %s\n",
6140 smtp_active_hostname);
6145 /* must be decoded from xtext: see RFC 3461:6.3a */
6147 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6148 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
6150 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6154 for (address_item * addr = addr_defer; addr; addr = addr->next)
6158 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
6160 if ((hu = addr->host_used) && hu->name)
6162 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
6163 print_dsn_diagnostic_code(addr, f);
6169 "Content-type: text/rfc822-headers\n\n",
6173 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6174 tctx.u.fd = fileno(f);
6175 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6176 transport_filter_argv = NULL; /* Just in case */
6177 return_path = sender_address; /* In case not previously set */
6179 /* Write the original email out */
6180 /*XXX no checking for failure! buggy! */
6181 transport_write_message(&tctx, 0);
6184 fprintf(f,"\n--%s--\n", bound);
6188 /* Close and wait for child process to complete, without a timeout.
6189 If there's an error, don't update the count. */
6192 return child_close(pid, 0) == 0;
6195 /*************************************************
6196 * Send a success-DSN *
6197 *************************************************/
6200 maybe_send_dsn(const address_item * const addr_succeed)
6202 address_item * addr_senddsn = NULL;
6204 for (const address_item * a = addr_succeed; a; a = a->next)
6206 /* af_ignore_error not honored here. it's not an error */
6207 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
6208 "DSN: processing successful delivery address: %s\n"
6209 "DSN: Sender_address: %s\n"
6210 "DSN: orcpt: %s flags: 0x%x\n"
6211 "DSN: envid: %s ret: %d\n"
6212 "DSN: Final recipient: %s\n"
6213 "DSN: Remote SMTP server supports DSN: %d\n",
6214 a->router ? a->router->name : US"(unknown)",
6217 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
6219 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
6224 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
6225 and a report was requested */
6227 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
6228 && a->dsn_flags & rf_notify_success
6231 /* copy and relink address_item and send report with all of them at once later */
6232 address_item * addr_next = addr_senddsn;
6233 addr_senddsn = store_get(sizeof(address_item), GET_UNTAINTED);
6235 addr_senddsn->next = addr_next;
6238 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
6242 { /* create exim process to send message */
6244 pid_t pid = child_open_exim(&fd, US"DSN");
6246 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
6248 if (pid < 0) /* Creation of child failed */
6250 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
6251 "create child process to send success-dsn message: %s", getpid(),
6252 getppid(), strerror(errno));
6254 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
6256 else /* Creation of child succeeded */
6258 FILE * f = fdopen(fd, "wb");
6259 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
6261 transport_ctx tctx = {{0}};
6264 debug_printf("sending success-dsn to: %s\n", sender_address);
6266 /* build unique id for MIME boundary */
6267 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
6268 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
6270 if (errors_reply_to)
6271 fprintf(f, "Reply-To: %s\n", errors_reply_to);
6274 fprintf(f, "Auto-Submitted: auto-generated\n"
6276 "Subject: Delivery Status Notification\n",
6278 moan_write_references(f, NULL);
6279 fprintf(f, "Content-Type: multipart/report;"
6280 " report-type=delivery-status; boundary=%s\n"
6281 "MIME-Version: 1.0\n\n"
6284 "Content-type: text/plain; charset=us-ascii\n\n"
6286 "This message was created automatically by mail delivery software.\n"
6287 " ----- The following addresses had successful delivery notifications -----\n",
6290 for (address_item * a = addr_senddsn; a; a = a->next)
6291 fprintf(f, "<%s> (relayed %s)\n\n",
6293 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
6294 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
6295 : "via non \"Remote SMTP\" router"
6299 "Content-type: message/delivery-status\n\n"
6300 "Reporting-MTA: dns; %s\n",
6301 bound, smtp_active_hostname);
6304 { /* must be decoded from xtext: see RFC 3461:6.3a */
6305 uschar * xdec_envid;
6306 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
6307 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
6309 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
6313 for (address_item * a = addr_senddsn; a; a = a->next)
6317 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
6319 if ((hu = a->host_used) && hu->name)
6320 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
6323 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
6324 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
6327 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
6330 transport_filter_argv = NULL; /* Just in case */
6331 return_path = sender_address; /* In case not previously set */
6333 /* Write the original email out */
6336 tctx.options = topt_add_return_path | topt_truncate_headers | topt_no_body;
6337 /*XXX hmm, FALSE(fail) retval ignored.
6338 Could error for any number of reasons, and they are not handled. */
6339 transport_write_message(&tctx, 0);
6342 fprintf(f,"\n--%s--\n", bound);
6346 (void) child_close(pid, 0); /* Waits for child to close, no timeout */
6351 /*************************************************
6352 * Deliver one message *
6353 *************************************************/
6355 /* This is the function which is called when a message is to be delivered. It
6356 is passed the id of the message. It is possible that the message no longer
6357 exists, if some other process has delivered it, and it is also possible that
6358 the message is being worked on by another process, in which case the data file
6361 If no delivery is attempted for any of the above reasons, the function returns
6362 DELIVER_NOT_ATTEMPTED.
6364 If the give_up flag is set true, do not attempt any deliveries, but instead
6365 fail all outstanding addresses and return the message to the sender (or
6368 A delivery operation has a process all to itself; we never deliver more than
6369 one message in the same process. Therefore we needn't worry too much about
6372 Liable to be called as root.
6375 id the id of the message to be delivered
6376 forced TRUE if delivery was forced by an administrator; this overrides
6377 retry delays and causes a delivery to be tried regardless
6378 give_up TRUE if an administrator has requested that delivery attempts
6381 Returns: When the global variable mua_wrapper is FALSE:
6382 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
6383 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
6384 When the global variable mua_wrapper is TRUE:
6385 DELIVER_MUA_SUCCEEDED if delivery succeeded
6386 DELIVER_MUA_FAILED if delivery failed
6387 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
6391 deliver_message(const uschar * id, BOOL forced, BOOL give_up)
6394 int final_yield = DELIVER_ATTEMPTED_NORMAL;
6395 time_t now = time(NULL);
6396 address_item *addr_last = NULL;
6397 uschar *filter_message = NULL;
6398 int process_recipients = RECIP_ACCEPT;
6401 extern int acl_where;
6404 #ifdef MEASURE_TIMING
6405 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
6408 info = queue_run_pid == (pid_t)0
6409 ? string_sprintf("delivering %s", id)
6410 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
6412 /* If the D_process_info bit is on, set_process_info() will output debugging
6413 information. If not, we want to show this initial information if D_deliver or
6414 D_queue_run is set or in verbose mode. */
6416 set_process_info("%s", info);
6418 if ( !(debug_selector & D_process_info)
6419 && (debug_selector & (D_deliver|D_queue_run|D_v))
6421 debug_printf("%s\n", info);
6423 /* Ensure that we catch any subprocesses that are created. Although Exim
6424 sets SIG_DFL as its initial default, some routes through the code end up
6425 here with it set to SIG_IGN - cases where a non-synchronous delivery process
6426 has been forked, but no re-exec has been done. We use sigaction rather than
6427 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
6428 sure it is turned off. (There was a problem on AIX with this.) */
6432 struct sigaction act;
6433 act.sa_handler = SIG_DFL;
6434 sigemptyset(&(act.sa_mask));
6436 sigaction(SIGCHLD, &act, NULL);
6439 signal(SIGCHLD, SIG_DFL);
6442 /* Make the forcing flag available for routers and transports, set up the
6443 global message id field, and initialize the count for returned files and the
6444 message size. This use of strcpy() is OK because the length id is checked when
6445 it is obtained from a command line (the -M or -q options), and otherwise it is
6446 known to be a valid message id. */
6448 if (id != message_id)
6449 Ustrcpy(message_id, id);
6450 f.deliver_force = forced;
6454 /* Initialize some flags */
6456 update_spool = FALSE;
6457 remove_journal = TRUE;
6459 /* Set a known context for any ACLs we call via expansions */
6460 acl_where = ACL_WHERE_DELIVERY;
6462 /* Reset the random number generator, so that if several delivery processes are
6463 started from a queue runner that has already used random numbers (for sorting),
6464 they don't all get the same sequence. */
6468 /* Open and lock the message's data file. Exim locks on this one because the
6469 header file may get replaced as it is re-written during the delivery process.
6470 Any failures cause messages to be written to the log, except for missing files
6471 while queue running - another process probably completed delivery. As part of
6472 opening the data file, message_subdir gets set. */
6474 if ((deliver_datafile = spool_open_datafile(id)) < 0)
6475 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6477 /* tHe value of message_size at this point has been set to the data length,
6478 plus one for the blank line that notionally precedes the data. */
6480 /* Now read the contents of the header file, which will set up the headers in
6481 store, and also the list of recipients and the tree of non-recipients and
6482 assorted flags. It updates message_size. If there is a reading or format error,
6483 give up; if the message has been around for sufficiently long, remove it. */
6486 uschar * spoolname = string_sprintf("%s-H", id);
6487 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
6489 if (errno == ERRNO_SPOOLFORMAT)
6491 struct stat statbuf;
6492 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
6494 log_write(0, LOG_MAIN, "Format error in spool file %s: "
6495 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
6497 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
6500 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
6503 /* If we managed to read the envelope data, received_time contains the
6504 time the message was received. Otherwise, we can calculate it from the
6507 if (rc != spool_read_hdrerror)
6509 received_time.tv_sec = received_time.tv_usec = 0;
6510 /*III subsec precision?*/
6511 for (i = 0; i < MESSAGE_ID_TIME_LEN; i++)
6512 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
6515 /* If we've had this malformed message too long, sling it. */
6517 if (now - received_time.tv_sec > keep_malformed)
6519 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
6520 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
6521 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
6522 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
6523 log_write(0, LOG_MAIN, "Message removed because older than %s",
6524 readconf_printtime(keep_malformed));
6527 (void)close(deliver_datafile);
6528 deliver_datafile = -1;
6529 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6533 /* The spool header file has been read. Look to see if there is an existing
6534 journal file for this message. If there is, it means that a previous delivery
6535 attempt crashed (program or host) before it could update the spool header file.
6536 Read the list of delivered addresses from the journal and add them to the
6537 nonrecipients tree. Then update the spool file. We can leave the journal in
6538 existence, as it will get further successful deliveries added to it in this
6539 run, and it will be deleted if this function gets to its end successfully.
6540 Otherwise it might be needed again. */
6543 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
6546 if ( (journal_fd = Uopen(fname,
6547 O_RDWR|O_APPEND | EXIM_CLOEXEC | EXIM_NOFOLLOW, SPOOL_MODE)) >= 0
6548 && lseek(journal_fd, 0, SEEK_SET) == 0
6549 && (jread = fdopen(journal_fd, "rb"))
6552 while (Ufgets(big_buffer, big_buffer_size, jread))
6554 int n = Ustrlen(big_buffer);
6555 big_buffer[n-1] = 0;
6556 tree_add_nonrecipient(big_buffer);
6557 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
6558 "journal file\n", big_buffer);
6561 if ((journal_fd = dup(fileno(jread))) < 0)
6562 journal_fd = fileno(jread);
6564 (void) fclose(jread); /* Try to not leak the FILE resource */
6566 /* Panic-dies on error */
6567 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
6569 else if (errno != ENOENT)
6571 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
6572 "%s", strerror(errno));
6573 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6576 /* A null recipients list indicates some kind of disaster. */
6578 if (!recipients_list)
6580 (void)close(deliver_datafile);
6581 deliver_datafile = -1;
6582 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
6583 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6588 /* Handle a message that is frozen. There are a number of different things that
6589 can happen, but in the default situation, unless forced, no delivery is
6592 if (f.deliver_freeze)
6594 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
6595 /* Moving to another directory removes the message from Exim's view. Other
6596 tools must be used to deal with it. Logging of this action happens in
6597 spool_move_message() and its subfunctions. */
6599 if ( move_frozen_messages
6600 && spool_move_message(id, message_subdir, US"", US"F")
6602 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6605 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
6606 maximum time to keep messages that are frozen. Thaw if we reach it, with a
6607 flag causing all recipients to be failed. The time is the age of the
6608 message, not the time since freezing. */
6610 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
6612 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
6613 process_recipients = RECIP_FAIL_TIMEOUT;
6616 /* For bounce messages (and others with no sender), thaw if the error message
6617 ignore timer is exceeded. The message will be discarded if this delivery
6620 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
6621 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
6623 /* If this is a bounce message, or there's no auto thaw, or we haven't
6624 reached the auto thaw time yet, and this delivery is not forced by an admin
6625 user, do not attempt delivery of this message. Note that forced is set for
6626 continuing messages down the same channel, in order to skip load checking and
6627 ignore hold domains, but we don't want unfreezing in that case. */
6631 if ( ( sender_address[0] == 0
6633 || now <= deliver_frozen_at + auto_thaw
6635 && ( !forced || !f.deliver_force_thaw
6636 || !f.admin_user || continue_hostname
6639 (void)close(deliver_datafile);
6640 deliver_datafile = -1;
6641 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
6642 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6645 /* If delivery was forced (by an admin user), assume a manual thaw.
6646 Otherwise it's an auto thaw. */
6650 f.deliver_manual_thaw = TRUE;
6651 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
6653 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
6656 /* We get here if any of the rules for unfreezing have triggered. */
6658 f.deliver_freeze = FALSE;
6659 update_spool = TRUE;
6663 /* Open the message log file if we are using them. This records details of
6664 deliveries, deferments, and failures for the benefit of the mail administrator.
6665 The log is not used by exim itself to track the progress of a message; that is
6666 done by rewriting the header spool file. */
6670 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
6674 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
6676 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
6677 fname, strerror(errno));
6678 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6681 /* Make a stdio stream out of it. */
6683 if (!(message_log = fdopen(fd, "a")))
6685 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
6686 fname, strerror(errno));
6687 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6692 /* If asked to give up on a message, log who did it, and set the action for all
6697 struct passwd *pw = getpwuid(real_uid);
6698 log_write(0, LOG_MAIN, "cancelled by %s",
6699 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
6700 process_recipients = RECIP_FAIL;
6703 /* Otherwise, if there are too many Received: headers, fail all recipients. */
6705 else if (received_count > received_headers_max)
6706 process_recipients = RECIP_FAIL_LOOP;
6708 /* Otherwise, if a system-wide, address-independent message filter is
6709 specified, run it now, except in the case when we are failing all recipients as
6710 a result of timeout_frozen_after. If the system filter yields "delivered", then
6711 ignore the true recipients of the message. Failure of the filter file is
6712 logged, and the delivery attempt fails. */
6714 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
6719 redirect_block redirect;
6721 if (system_filter_uid_set)
6723 ugid.uid = system_filter_uid;
6724 ugid.gid = system_filter_gid;
6725 ugid.uid_set = ugid.gid_set = TRUE;
6728 ugid.uid_set = ugid.gid_set = FALSE;
6730 return_path = sender_address;
6731 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
6732 f.system_filtering = TRUE;
6734 /* Any error in the filter file causes a delivery to be abandoned. */
6736 redirect.string = system_filter;
6737 redirect.isfile = TRUE;
6738 redirect.check_owner = redirect.check_group = FALSE;
6739 redirect.owners = NULL;
6740 redirect.owngroups = NULL;
6742 redirect.modemask = 0;
6744 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
6747 &redirect, /* Where the data is */
6748 RDO_DEFER | /* Turn on all the enabling options */
6749 RDO_FAIL | /* Leave off all the disabling options */
6754 NULL, /* No :include: restriction (not used in filter) */
6755 NULL, /* No sieve vacation directory (not sieve!) */
6756 NULL, /* No sieve enotify mailto owner (not sieve!) */
6757 NULL, /* No sieve user address (not sieve!) */
6758 NULL, /* No sieve subaddress (not sieve!) */
6759 &ugid, /* uid/gid data */
6760 &addr_new, /* Where to hang generated addresses */
6761 &filter_message, /* Where to put error message */
6762 NULL, /* Don't skip syntax errors */
6763 &filtertype, /* Will always be set to FILTER_EXIM for this call */
6764 US"system filter"); /* For error messages */
6766 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
6768 if (rc == FF_ERROR || rc == FF_NONEXIST)
6770 (void)close(deliver_datafile);
6771 deliver_datafile = -1;
6772 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
6773 string_printing(filter_message));
6774 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
6777 /* Reset things. If the filter message is an empty string, which can happen
6778 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
6780 f.system_filtering = FALSE;
6781 f.enable_dollar_recipients = FALSE;
6782 if (filter_message && filter_message[0] == 0) filter_message = NULL;
6784 /* Save the values of the system filter variables so that user filters
6787 memcpy(filter_sn, filter_n, sizeof(filter_sn));
6789 /* The filter can request that delivery of the original addresses be
6794 process_recipients = RECIP_DEFER;
6795 deliver_msglog("Delivery deferred by system filter\n");
6796 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
6799 /* The filter can request that a message be frozen, but this does not
6800 take place if the message has been manually thawed. In that case, we must
6801 unset "delivered", which is forced by the "freeze" command to make -bF
6804 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6806 f.deliver_freeze = TRUE;
6807 deliver_frozen_at = time(NULL);
6808 process_recipients = RECIP_DEFER;
6809 frozen_info = string_sprintf(" by the system filter%s%s",
6810 filter_message ? US": " : US"",
6811 filter_message ? filter_message : US"");
6814 /* The filter can request that a message be failed. The error message may be
6815 quite long - it is sent back to the sender in the bounce - but we don't want
6816 to fill up the log with repetitions of it. If it starts with << then the text
6817 between << and >> is written to the log, with the rest left for the bounce
6820 else if (rc == FF_FAIL)
6822 uschar *colon = US"";
6823 uschar *logmsg = US"";
6826 process_recipients = RECIP_FAIL_FILTER;
6832 if ( filter_message[0] == '<'
6833 && filter_message[1] == '<'
6834 && (logend = Ustrstr(filter_message, ">>"))
6837 logmsg = filter_message + 2;
6838 loglen = logend - logmsg;
6839 filter_message = logend + 2;
6840 if (filter_message[0] == 0) filter_message = NULL;
6844 logmsg = filter_message;
6845 loglen = Ustrlen(filter_message);
6849 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6853 /* Delivery can be restricted only to those recipients (if any) that the
6854 filter specified. */
6856 else if (rc == FF_DELIVERED)
6858 process_recipients = RECIP_IGNORE;
6860 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6862 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6865 /* If any new addresses were created by the filter, fake up a "parent"
6866 for them. This is necessary for pipes, etc., which are expected to have
6867 parents, and it also gives some sensible logging for others. Allow
6868 pipes, files, and autoreplies, and run them as the filter uid if set,
6869 otherwise as the current uid. */
6873 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6874 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6876 /* The text "system-filter" is tested in transport_set_up_command() and in
6877 set_up_shell_command() in the pipe transport, to enable them to permit
6878 $recipients, so don't change it here without also changing it there. */
6880 address_item *p = addr_new;
6881 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6883 parent->domain = string_copylc(qualify_domain_recipient);
6884 parent->local_part = US"system-filter";
6886 /* As part of this loop, we arrange for addr_last to end up pointing
6887 at the final address. This is used if we go on to add addresses for the
6888 original recipients. */
6892 if (parent->child_count == USHRT_MAX)
6893 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6894 "than %d delivery addresses", USHRT_MAX);
6895 parent->child_count++;
6898 if (testflag(p, af_pfr))
6904 setflag(p, af_uid_set);
6905 setflag(p, af_gid_set);
6906 setflag(p, af_allow_file);
6907 setflag(p, af_allow_pipe);
6908 setflag(p, af_allow_reply);
6910 /* Find the name of the system filter's appropriate pfr transport */
6912 if (p->address[0] == '|')
6915 tpname = system_filter_pipe_transport;
6916 address_pipe = p->address;
6918 else if (p->address[0] == '>')
6921 tpname = system_filter_reply_transport;
6925 if (p->address[Ustrlen(p->address)-1] == '/')
6927 type = US"directory";
6928 tpname = system_filter_directory_transport;
6933 tpname = system_filter_file_transport;
6935 address_file = p->address;
6938 /* Now find the actual transport, first expanding the name. We have
6939 set address_file or address_pipe above. */
6943 uschar *tmp = expand_string(tpname);
6944 address_file = address_pipe = NULL;
6946 p->message = string_sprintf("failed to expand \"%s\" as a "
6947 "system filter transport name", tpname);
6948 if (is_tainted(tmp))
6949 p->message = string_sprintf("attempt to used tainted value '%s' for"
6950 "transport '%s' as a system filter", tmp, tpname);
6954 p->message = string_sprintf("system_filter_%s_transport is unset",
6959 transport_instance *tp;
6960 for (tp = transports; tp; tp = tp->next)
6961 if (Ustrcmp(tp->name, tpname) == 0)
6967 p->message = string_sprintf("failed to find \"%s\" transport "
6968 "for system filter delivery", tpname);
6971 /* If we couldn't set up a transport, defer the delivery, putting the
6972 error on the panic log as well as the main log. */
6976 address_item *badp = p;
6978 if (!addr_last) addr_new = p; else addr_last->next = p;
6979 badp->local_part = badp->address; /* Needed for log line */
6980 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6983 } /* End of pfr handling */
6985 /* Either a non-pfr delivery, or we found a transport */
6987 DEBUG(D_deliver|D_filter)
6988 debug_printf("system filter added %s\n", p->address);
6992 } /* Loop through all addr_new addresses */
6997 /* Scan the recipients list, and for every one that is not in the non-
6998 recipients tree, add an addr item to the chain of new addresses. If the pno
6999 value is non-negative, we must set the onetime parent from it. This which
7000 points to the relevant entry in the recipients list.
7002 This processing can be altered by the setting of the process_recipients
7003 variable, which is changed if recipients are to be ignored, failed, or
7004 deferred. This can happen as a result of system filter activity, or if the -Mg
7005 option is used to fail all of them.
7007 Duplicate addresses are handled later by a different tree structure; we can't
7008 just extend the non-recipients tree, because that will be re-written to the
7009 spool if the message is deferred, and in any case there are casing
7010 complications for local addresses. */
7012 if (process_recipients != RECIP_IGNORE)
7013 for (i = 0; i < recipients_count; i++)
7014 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
7016 recipient_item * r = recipients_list + i;
7017 address_item * new = deliver_make_addr(r->address, FALSE);
7019 new->prop.errors_address = r->errors_to;
7021 if ((new->prop.utf8_msg = message_smtputf8))
7023 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
7024 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
7025 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
7026 new->prop.utf8_downcvt ? "yes"
7027 : new->prop.utf8_downcvt_maybe ? "ifneeded"
7033 new->onetime_parent = recipients_list[r->pno].address;
7035 /* If DSN support is enabled, set the dsn flags and the original receipt
7036 to be passed on to other DSN enabled MTAs */
7038 new->dsn_flags = r->dsn_flags & rf_dsnflags;
7039 new->dsn_orcpt = r->orcpt;
7040 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
7041 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
7043 switch (process_recipients)
7045 /* RECIP_DEFER is set when a system filter freezes a message. */
7048 new->next = addr_defer;
7053 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
7056 case RECIP_FAIL_FILTER:
7058 filter_message ? filter_message : US"delivery cancelled";
7059 setflag(new, af_pass_message);
7060 goto RECIP_QUEUE_FAILED; /* below */
7063 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
7064 than the value in timeout_frozen_after. Treat non-bounce messages
7065 similarly to -Mg; for bounce messages we just want to discard, so
7066 don't put the address on the failed list. The timeout has already
7069 case RECIP_FAIL_TIMEOUT:
7070 new->message = US"delivery cancelled; message timed out";
7071 goto RECIP_QUEUE_FAILED; /* below */
7074 /* RECIP_FAIL is set when -Mg has been used. */
7077 new->message = US"delivery cancelled by administrator";
7078 /* not setting af_pass_message here means that will not
7079 appear in the bounce message */
7082 /* Common code for the failure cases above. If this is not a bounce
7083 message, put the address on the failed list so that it is used to
7084 create a bounce. Otherwise do nothing - this just discards the address.
7085 The incident has already been logged. */
7088 if (*sender_address)
7090 new->next = addr_failed;
7096 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
7097 in the message. Process each address as a routing failure; if this
7098 is a bounce message, it will get frozen. */
7100 case RECIP_FAIL_LOOP:
7101 new->message = US"Too many \"Received\" headers - suspected mail loop";
7102 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7106 /* Value should be RECIP_ACCEPT; take this as the safe default. */
7109 if (!addr_new) addr_new = new; else addr_last->next = new;
7114 #ifndef DISABLE_EVENT
7115 if (process_recipients != RECIP_ACCEPT && event_action)
7117 uschar * save_local = deliver_localpart;
7118 const uschar * save_domain = deliver_domain;
7119 uschar * addr = new->address, * errmsg = NULL;
7120 int start, end, dom;
7122 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
7123 log_write(0, LOG_MAIN|LOG_PANIC,
7124 "failed to parse address '%.100s': %s\n", addr, errmsg);
7128 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
7129 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
7131 (void) event_raise(event_action, US"msg:fail:internal", new->message, NULL);
7133 deliver_localpart = save_local;
7134 deliver_domain = save_domain;
7142 debug_printf("Delivery address list:\n");
7143 for (address_item * p = addr_new; p; p = p->next)
7144 debug_printf(" %s %s\n", p->address,
7145 p->onetime_parent ? p->onetime_parent : US"");
7148 /* Set up the buffers used for copying over the file when delivering. */
7150 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
7151 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
7155 /* Until there are no more new addresses, handle each one as follows:
7157 . If this is a generated address (indicated by the presence of a parent
7158 pointer) then check to see whether it is a pipe, file, or autoreply, and
7159 if so, handle it directly here. The router that produced the address will
7160 have set the allow flags into the address, and also set the uid/gid required.
7161 Having the routers generate new addresses and then checking them here at
7162 the outer level is tidier than making each router do the checking, and
7163 means that routers don't need access to the failed address queue.
7165 . Break up the address into local part and domain, and make lowercased
7166 versions of these strings. We also make unquoted versions of the local part.
7168 . Handle the percent hack for those domains for which it is valid.
7170 . For child addresses, determine if any of the parents have the same address.
7171 If so, generate a different string for previous delivery checking. Without
7172 this code, if the address spqr generates spqr via a forward or alias file,
7173 delivery of the generated spqr stops further attempts at the top level spqr,
7174 which is not what is wanted - it may have generated other addresses.
7176 . Check on the retry database to see if routing was previously deferred, but
7177 only if in a queue run. Addresses that are to be routed are put on the
7178 addr_route chain. Addresses that are to be deferred are put on the
7179 addr_defer chain. We do all the checking first, so as not to keep the
7180 retry database open any longer than necessary.
7182 . Now we run the addresses through the routers. A router may put the address
7183 on either the addr_local or the addr_remote chain for local or remote
7184 delivery, respectively, or put it on the addr_failed chain if it is
7185 undeliveable, or it may generate child addresses and put them on the
7186 addr_new chain, or it may defer an address. All the chain anchors are
7187 passed as arguments so that the routers can be called for verification
7190 . If new addresses have been generated by the routers, da capo.
7193 f.header_rewritten = FALSE; /* No headers rewritten yet */
7194 while (addr_new) /* Loop until all addresses dealt with */
7196 address_item * addr, * parent;
7198 /* Failure to open the retry database is treated the same as if it does
7199 not exist. In both cases, dbm_file is NULL. */
7201 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
7202 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
7203 debug_printf("no retry data available\n");
7205 /* Scan the current batch of new addresses, to handle pipes, files and
7206 autoreplies, and determine which others are ready for routing. */
7212 dbdata_retry * domain_retry_record, * address_retry_record;
7215 addr_new = addr->next;
7217 DEBUG(D_deliver|D_retry|D_route)
7219 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7220 debug_printf("Considering: %s\n", addr->address);
7223 /* Handle generated address that is a pipe or a file or an autoreply. */
7225 if (testflag(addr, af_pfr))
7227 /* If an autoreply in a filter could not generate a syntactically valid
7228 address, give up forthwith. Set af_ignore_error so that we don't try to
7229 generate a bounce. */
7231 if (testflag(addr, af_bad_reply))
7233 addr->basic_errno = ERRNO_BADADDRESS2;
7234 addr->local_part = addr->address;
7236 US"filter autoreply generated syntactically invalid recipient";
7237 addr->prop.ignore_error = TRUE;
7238 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7239 continue; /* with the next new address */
7242 /* If two different users specify delivery to the same pipe or file or
7243 autoreply, there should be two different deliveries, so build a unique
7244 string that incorporates the original address, and use this for
7245 duplicate testing and recording delivery, and also for retrying. */
7248 string_sprintf("%s:%s", addr->address, addr->parent->unique +
7249 (testflag(addr->parent, af_homonym)? 3:0));
7251 addr->address_retry_key = addr->domain_retry_key =
7252 string_sprintf("T:%s", addr->unique);
7254 /* If a filter file specifies two deliveries to the same pipe or file,
7255 we want to de-duplicate, but this is probably not wanted for two mail
7256 commands to the same address, where probably both should be delivered.
7257 So, we have to invent a different unique string in that case. Just
7258 keep piling '>' characters on the front. */
7260 if (addr->address[0] == '>')
7261 while (tree_search(tree_duplicates, addr->unique))
7262 addr->unique = string_sprintf(">%s", addr->unique);
7264 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
7266 DEBUG(D_deliver|D_route)
7267 debug_printf("%s is a duplicate address: discarded\n", addr->address);
7268 addr->dupof = tnode->data.ptr;
7269 addr->next = addr_duplicate;
7270 addr_duplicate = addr;
7274 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7276 /* Check for previous delivery */
7278 if (tree_search(tree_nonrecipients, addr->unique))
7280 DEBUG(D_deliver|D_route)
7281 debug_printf("%s was previously delivered: discarded\n", addr->address);
7282 child_done(addr, tod_stamp(tod_log));
7286 /* Save for checking future duplicates */
7288 tree_add_duplicate(addr->unique, addr);
7290 /* Set local part and domain */
7292 addr->local_part = addr->address;
7293 addr->domain = addr->parent->domain;
7295 /* Ensure that the delivery is permitted. */
7297 if (testflag(addr, af_file))
7299 if (!testflag(addr, af_allow_file))
7301 addr->basic_errno = ERRNO_FORBIDFILE;
7302 addr->message = US"delivery to file forbidden";
7303 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7304 continue; /* with the next new address */
7307 else if (addr->address[0] == '|')
7309 if (!testflag(addr, af_allow_pipe))
7311 addr->basic_errno = ERRNO_FORBIDPIPE;
7312 addr->message = US"delivery to pipe forbidden";
7313 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7314 continue; /* with the next new address */
7317 else if (!testflag(addr, af_allow_reply))
7319 addr->basic_errno = ERRNO_FORBIDREPLY;
7320 addr->message = US"autoreply forbidden";
7321 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7322 continue; /* with the next new address */
7325 /* If the errno field is already set to BADTRANSPORT, it indicates
7326 failure to expand a transport string, or find the associated transport,
7327 or an unset transport when one is required. Leave this test till now so
7328 that the forbid errors are given in preference. */
7330 if (addr->basic_errno == ERRNO_BADTRANSPORT)
7332 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7336 /* Treat /dev/null as a special case and abandon the delivery. This
7337 avoids having to specify a uid on the transport just for this case.
7338 Arrange for the transport name to be logged as "**bypassed**".
7339 Copy the transport for this fairly unusual case rather than having
7340 to make all transports mutable. */
7342 if (Ustrcmp(addr->address, "/dev/null") == 0)
7344 transport_instance * save_t = addr->transport;
7345 transport_instance * t = store_get(sizeof(*t), save_t);
7347 t->name = US"**bypassed**";
7348 addr->transport = t;
7349 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
7350 addr->transport= save_t;
7351 continue; /* with the next new address */
7354 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
7357 DEBUG(D_deliver|D_route)
7358 debug_printf("queued for %s transport\n", addr->transport->name);
7359 addr->next = addr_local;
7361 continue; /* with the next new address */
7364 /* Handle normal addresses. First, split up into local part and domain,
7365 handling the %-hack if necessary. There is the possibility of a defer from
7366 a lookup in percent_hack_domains. */
7368 if ((rc = deliver_split_address(addr)) == DEFER)
7370 addr->message = US"cannot check percent_hack_domains";
7371 addr->basic_errno = ERRNO_LISTDEFER;
7372 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7376 /* Check to see if the domain is held. If so, proceed only if the
7377 delivery was forced by hand. */
7379 deliver_domain = addr->domain; /* set $domain */
7380 if ( !forced && hold_domains
7381 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
7382 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
7388 addr->message = US"hold_domains lookup deferred";
7389 addr->basic_errno = ERRNO_LISTDEFER;
7393 addr->message = US"domain is held";
7394 addr->basic_errno = ERRNO_HELD;
7396 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
7400 /* Now we can check for duplicates and previously delivered addresses. In
7401 order to do this, we have to generate a "unique" value for each address,
7402 because there may be identical actual addresses in a line of descendents.
7403 The "unique" field is initialized to the same value as the "address" field,
7404 but gets changed here to cope with identically-named descendents. */
7406 for (parent = addr->parent; parent; parent = parent->parent)
7407 if (strcmpic(addr->address, parent->address) == 0) break;
7409 /* If there's an ancestor with the same name, set the homonym flag. This
7410 influences how deliveries are recorded. Then add a prefix on the front of
7411 the unique address. We use \n\ where n starts at 0 and increases each time.
7412 It is unlikely to pass 9, but if it does, it may look odd but will still
7413 work. This means that siblings or cousins with the same names are treated
7414 as duplicates, which is what we want. */
7418 setflag(addr, af_homonym);
7419 if (parent->unique[0] != '\\')
7420 addr->unique = string_sprintf("\\0\\%s", addr->address);
7422 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
7426 /* Ensure that the domain in the unique field is lower cased, because
7427 domains are always handled caselessly. */
7429 for (uschar * p = Ustrrchr(addr->unique, '@'); *p; p++) *p = tolower(*p);
7431 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
7433 if (tree_search(tree_nonrecipients, addr->unique))
7435 DEBUG(D_deliver|D_route)
7436 debug_printf("%s was previously delivered: discarded\n", addr->unique);
7437 child_done(addr, tod_stamp(tod_log));
7441 /* Get the routing retry status, saving the two retry keys (with and
7442 without the local part) for subsequent use. If there is no retry record for
7443 the standard address routing retry key, we look for the same key with the
7444 sender attached, because this form is used by the smtp transport after a
7445 4xx response to RCPT when address_retry_include_sender is true. */
7447 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
7448 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
7453 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
7454 if ( domain_retry_record
7455 && now - domain_retry_record->time_stamp > retry_data_expire
7458 DEBUG(D_deliver|D_retry)
7459 debug_printf("domain retry record present but expired\n");
7460 domain_retry_record = NULL; /* Ignore if too old */
7463 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
7464 if ( address_retry_record
7465 && now - address_retry_record->time_stamp > retry_data_expire
7468 DEBUG(D_deliver|D_retry)
7469 debug_printf("address retry record present but expired\n");
7470 address_retry_record = NULL; /* Ignore if too old */
7473 if (!address_retry_record)
7475 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7477 address_retry_record = dbfn_read(dbm_file, altkey);
7478 if ( address_retry_record
7479 && now - address_retry_record->time_stamp > retry_data_expire)
7481 DEBUG(D_deliver|D_retry)
7482 debug_printf("address<sender> retry record present but expired\n");
7483 address_retry_record = NULL; /* Ignore if too old */
7488 domain_retry_record = address_retry_record = NULL;
7490 DEBUG(D_deliver|D_retry)
7492 if (!domain_retry_record)
7493 debug_printf("no domain retry record\n");
7495 debug_printf("have domain retry record; next_try = now%+d\n",
7496 f.running_in_test_harness ? 0 :
7497 (int)(domain_retry_record->next_try - now));
7499 if (!address_retry_record)
7500 debug_printf("no address retry record\n");
7502 debug_printf("have address retry record; next_try = now%+d\n",
7503 f.running_in_test_harness ? 0 :
7504 (int)(address_retry_record->next_try - now));
7507 /* If we are sending a message down an existing SMTP connection, we must
7508 assume that the message which created the connection managed to route
7509 an address to that connection. We do not want to run the risk of taking
7510 a long time over routing here, because if we do, the server at the other
7511 end of the connection may time it out. This is especially true for messages
7512 with lots of addresses. For this kind of delivery, queue_running is not
7513 set, so we would normally route all addresses. We take a pragmatic approach
7514 and defer routing any addresses that have any kind of domain retry record.
7515 That is, we don't even look at their retry times. It doesn't matter if this
7516 doesn't work occasionally. This is all just an optimization, after all.
7518 The reason for not doing the same for address retries is that they normally
7519 arise from 4xx responses, not DNS timeouts. */
7521 if (continue_hostname && domain_retry_record)
7523 addr->message = US"reusing SMTP connection skips previous routing defer";
7524 addr->basic_errno = ERRNO_RRETRY;
7525 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7527 addr->message = domain_retry_record->text;
7528 setflag(addr, af_pass_message);
7531 /* If we are in a queue run, defer routing unless there is no retry data or
7532 we've passed the next retry time, or this message is forced. In other
7533 words, ignore retry data when not in a queue run.
7535 However, if the domain retry time has expired, always allow the routing
7536 attempt. If it fails again, the address will be failed. This ensures that
7537 each address is routed at least once, even after long-term routing
7540 If there is an address retry, check that too; just wait for the next
7541 retry time. This helps with the case when the temporary error on the
7542 address was really message-specific rather than address specific, since
7543 it allows other messages through.
7545 We also wait for the next retry time if this is a message sent down an
7546 existing SMTP connection (even though that will be forced). Otherwise there
7547 will be far too many attempts for an address that gets a 4xx error. In
7548 fact, after such an error, we should not get here because, the host should
7549 not be remembered as one this message needs. However, there was a bug that
7550 used to cause this to happen, so it is best to be on the safe side.
7552 Even if we haven't reached the retry time in the hints, there is one more
7553 check to do, which is for the ultimate address timeout. We only do this
7554 check if there is an address retry record and there is not a domain retry
7555 record; this implies that previous attempts to handle the address had the
7556 retry_use_local_parts option turned on. We use this as an approximation
7557 for the destination being like a local delivery, for example delivery over
7558 LMTP to an IMAP message store. In this situation users are liable to bump
7559 into their quota and thereby have intermittently successful deliveries,
7560 which keep the retry record fresh, which can lead to us perpetually
7561 deferring messages. */
7563 else if ( ( f.queue_running && !f.deliver_force
7564 || continue_hostname
7566 && ( ( domain_retry_record
7567 && now < domain_retry_record->next_try
7568 && !domain_retry_record->expired
7570 || ( address_retry_record
7571 && now < address_retry_record->next_try
7573 && ( domain_retry_record
7574 || !address_retry_record
7575 || !retry_ultimate_address_timeout(addr->address_retry_key,
7576 addr->domain, address_retry_record, now)
7579 addr->message = US"retry time not reached";
7580 addr->basic_errno = ERRNO_RRETRY;
7581 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7583 /* For remote-retry errors (here and just above) that we've not yet
7584 hit the retry time, use the error recorded in the retry database
7585 as info in the warning message. This lets us send a message even
7586 when we're not failing on a fresh attempt. We assume that this
7587 info is not sensitive. */
7589 addr->message = domain_retry_record
7590 ? domain_retry_record->text : address_retry_record->text;
7591 setflag(addr, af_pass_message);
7594 /* The domain is OK for routing. Remember if retry data exists so it
7595 can be cleaned up after a successful delivery. */
7599 if (domain_retry_record || address_retry_record)
7600 setflag(addr, af_dr_retry_exists);
7601 addr->next = addr_route;
7603 DEBUG(D_deliver|D_route)
7604 debug_printf("%s: queued for routing\n", addr->address);
7608 /* The database is closed while routing is actually happening. Requests to
7609 update it are put on a chain and all processed together at the end. */
7611 if (dbm_file) dbfn_close(dbm_file);
7613 /* If queue_domains is set, we don't even want to try routing addresses in
7614 those domains. During queue runs, queue_domains is forced to be unset.
7615 Optimize by skipping this pass through the addresses if nothing is set. */
7617 if (!f.deliver_force && queue_domains)
7619 address_item *okaddr = NULL;
7622 address_item *addr = addr_route;
7623 addr_route = addr->next;
7625 deliver_domain = addr->domain; /* set $domain */
7626 if ((rc = match_isinlist(addr->domain, CUSS &queue_domains, 0,
7627 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
7631 addr->basic_errno = ERRNO_LISTDEFER;
7632 addr->message = US"queue_domains lookup deferred";
7633 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7637 addr->next = okaddr;
7642 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
7643 addr->message = US"domain is in queue_domains";
7644 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7648 addr_route = okaddr;
7651 /* Now route those addresses that are not deferred. */
7656 address_item *addr = addr_route;
7657 const uschar *old_domain = addr->domain;
7658 uschar *old_unique = addr->unique;
7659 addr_route = addr->next;
7662 /* Just in case some router parameter refers to it. */
7664 if (!(return_path = addr->prop.errors_address))
7665 return_path = sender_address;
7667 /* If a router defers an address, add a retry item. Whether or not to
7668 use the local part in the key is a property of the router. */
7670 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
7671 &addr_succeed, v_none)) == DEFER)
7672 retry_add_item(addr,
7673 addr->router->retry_use_local_part
7674 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
7675 : string_sprintf("R:%s", addr->domain),
7678 /* Otherwise, if there is an existing retry record in the database, add
7679 retry items to delete both forms. We must also allow for the possibility
7680 of a routing retry that includes the sender address. Since the domain might
7681 have been rewritten (expanded to fully qualified) as a result of routing,
7682 ensure that the rewritten form is also deleted. */
7684 else if (testflag(addr, af_dr_retry_exists))
7686 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
7688 retry_add_item(addr, altkey, rf_delete);
7689 retry_add_item(addr, addr->address_retry_key, rf_delete);
7690 retry_add_item(addr, addr->domain_retry_key, rf_delete);
7691 if (Ustrcmp(addr->domain, old_domain) != 0)
7692 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
7695 /* DISCARD is given for :blackhole: and "seen finish". The event has been
7696 logged, but we need to ensure the address (and maybe parents) is marked
7701 address_done(addr, tod_stamp(tod_log));
7702 continue; /* route next address */
7705 /* The address is finished with (failed or deferred). */
7709 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
7710 continue; /* route next address */
7713 /* The address has been routed. If the router changed the domain, it will
7714 also have changed the unique address. We have to test whether this address
7715 has already been delivered, because it's the unique address that finally
7718 if ( addr->unique != old_unique
7719 && tree_search(tree_nonrecipients, addr->unique) != 0
7722 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
7723 "discarded\n", addr->address);
7724 if (addr_remote == addr) addr_remote = addr->next;
7725 else if (addr_local == addr) addr_local = addr->next;
7728 /* If the router has same_domain_copy_routing set, we are permitted to copy
7729 the routing for any other addresses with the same domain. This is an
7730 optimisation to save repeated DNS lookups for "standard" remote domain
7731 routing. The option is settable only on routers that generate host lists.
7732 We play it very safe, and do the optimization only if the address is routed
7733 to a remote transport, there are no header changes, and the domain was not
7734 modified by the router. */
7736 if ( addr_remote == addr
7737 && addr->router->same_domain_copy_routing
7738 && !addr->prop.extra_headers
7739 && !addr->prop.remove_headers
7740 && old_domain == addr->domain
7743 address_item **chain = &addr_route;
7746 address_item *addr2 = *chain;
7747 if (Ustrcmp(addr2->domain, addr->domain) != 0)
7749 chain = &(addr2->next);
7753 /* Found a suitable address; take it off the routing list and add it to
7754 the remote delivery list. */
7756 *chain = addr2->next;
7757 addr2->next = addr_remote;
7758 addr_remote = addr2;
7760 /* Copy the routing data */
7762 addr2->domain = addr->domain;
7763 addr2->router = addr->router;
7764 addr2->transport = addr->transport;
7765 addr2->host_list = addr->host_list;
7766 addr2->fallback_hosts = addr->fallback_hosts;
7767 addr2->prop.errors_address = addr->prop.errors_address;
7768 copyflag(addr2, addr, af_hide_child);
7769 copyflag(addr2, addr, af_local_host_removed);
7771 DEBUG(D_deliver|D_route)
7772 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
7774 "Routing for %s copied from %s\n",
7775 addr2->address, addr2->address, addr->address);
7778 } /* Continue with routing the next address. */
7779 } /* Loop to process any child addresses that the routers created, and
7780 any rerouted addresses that got put back on the new chain. */
7783 /* Debugging: show the results of the routing */
7785 DEBUG(D_deliver|D_retry|D_route)
7787 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
7788 debug_printf("After routing:\n Local deliveries:\n");
7789 for (address_item * p = addr_local; p; p = p->next)
7790 debug_printf(" %s\n", p->address);
7792 debug_printf(" Remote deliveries:\n");
7793 for (address_item * p = addr_remote; p; p = p->next)
7794 debug_printf(" %s\n", p->address);
7796 debug_printf(" Failed addresses:\n");
7797 for (address_item * p = addr_failed; p; p = p->next)
7798 debug_printf(" %s\n", p->address);
7800 debug_printf(" Deferred addresses:\n");
7801 for (address_item * p = addr_defer; p; p = p->next)
7802 debug_printf(" %s\n", p->address);
7805 /* Free any resources that were cached during routing. */
7810 /* These two variables are set only during routing, after check_local_user.
7811 Ensure they are not set in transports. */
7813 local_user_gid = (gid_t)(-1);
7814 local_user_uid = (uid_t)(-1);
7816 /* Check for any duplicate addresses. This check is delayed until after
7817 routing, because the flexibility of the routing configuration means that
7818 identical addresses with different parentage may end up being redirected to
7819 different addresses. Checking for duplicates too early (as we previously used
7820 to) makes this kind of thing not work. */
7822 do_duplicate_check(&addr_local);
7823 do_duplicate_check(&addr_remote);
7825 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7826 remote transport. The check that they all end up in one transaction happens in
7827 the do_remote_deliveries() function. */
7830 && (addr_local || addr_failed || addr_defer)
7834 uschar *which, *colon, *msg;
7841 else if (addr_defer)
7844 which = US"deferred";
7852 while (addr->parent) addr = addr->parent;
7857 msg = addr->message;
7859 else colon = msg = US"";
7861 /* We don't need to log here for a forced failure as it will already
7862 have been logged. Defer will also have been logged, but as a defer, so we do
7863 need to do the failure logging. */
7865 if (addr != addr_failed)
7866 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7867 addr->address, which);
7869 /* Always write an error to the caller */
7871 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7874 final_yield = DELIVER_MUA_FAILED;
7875 addr_failed = addr_defer = NULL; /* So that we remove the message */
7876 goto DELIVERY_TIDYUP;
7880 /* If this is a run to continue deliveries to an external channel that is
7881 already set up, defer any local deliveries.
7883 jgh 2020/12/20: I don't see why; locals should be quick.
7884 The defer goes back to version 1.62 in 1997. A local being still deliverable
7885 during a continued run might result from something like a defer during the
7886 original delivery, eg. in a DB lookup. Unlikely but possible.
7888 To avoid delaying a local when combined with a callout-hold for a remote
7889 delivery, test continue_sequence rather than continue_transport. */
7891 if (continue_sequence > 1 && addr_local)
7893 DEBUG(D_deliver|D_retry|D_route)
7894 debug_printf("deferring local deliveries due to continued-transport\n");
7897 address_item * addr = addr_defer;
7898 while (addr->next) addr = addr->next;
7899 addr->next = addr_local;
7902 addr_defer = addr_local;
7907 /* Because address rewriting can happen in the routers, we should not really do
7908 ANY deliveries until all addresses have been routed, so that all recipients of
7909 the message get the same headers. However, this is in practice not always
7910 possible, since sometimes remote addresses give DNS timeouts for days on end.
7911 The pragmatic approach is to deliver what we can now, saving any rewritten
7912 headers so that at least the next lot of recipients benefit from the rewriting
7913 that has already been done.
7915 If any headers have been rewritten during routing, update the spool file to
7916 remember them for all subsequent deliveries. This can be delayed till later if
7917 there is only address to be delivered - if it succeeds the spool write need not
7920 if ( f.header_rewritten
7921 && ( addr_local && (addr_local->next || addr_remote)
7922 || addr_remote && addr_remote->next
7925 /* Panic-dies on error */
7926 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7927 f.header_rewritten = FALSE;
7931 /* If there are any deliveries to do and we do not already have the journal
7932 file, create it. This is used to record successful deliveries as soon as
7933 possible after each delivery is known to be complete. A file opened with
7934 O_APPEND is used so that several processes can run simultaneously.
7936 The journal is just insurance against crashes. When the spool file is
7937 ultimately updated at the end of processing, the journal is deleted. If a
7938 journal is found to exist at the start of delivery, the addresses listed
7939 therein are added to the non-recipients. */
7941 if (addr_local || addr_remote)
7945 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7947 if ((journal_fd = Uopen(fname,
7948 EXIM_CLOEXEC | O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7950 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7951 fname, strerror(errno));
7952 return DELIVER_NOT_ATTEMPTED;
7955 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7956 that the mode is correct - the group setting doesn't always seem to get
7957 set automatically. */
7959 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7960 || fchmod(journal_fd, SPOOL_MODE)
7962 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7966 int ret = Uunlink(fname);
7967 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7968 fname, strerror(errno));
7969 if(ret && errno != ENOENT)
7970 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7971 fname, strerror(errno));
7972 return DELIVER_NOT_ATTEMPTED;
7976 else if (journal_fd >= 0)
7984 /* Now we can get down to the business of actually doing deliveries. Local
7985 deliveries are done first, then remote ones. If ever the problems of how to
7986 handle fallback transports are figured out, this section can be put into a loop
7987 for handling fallbacks, though the uid switching will have to be revised. */
7989 /* Precompile a regex that is used to recognize a parameter in response
7990 to an LHLO command, if is isn't already compiled. This may be used on both
7991 local and remote LMTP deliveries. */
7993 if (!regex_IGNOREQUOTA)
7995 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", MCS_NOFLAGS, TRUE);
7997 /* Handle local deliveries */
8001 DEBUG(D_deliver|D_transport)
8002 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
8003 do_local_deliveries();
8004 f.disable_logging = FALSE;
8007 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
8008 so just queue them all. */
8010 if (f.queue_run_local)
8013 address_item *addr = addr_remote;
8014 addr_remote = addr->next;
8016 addr->basic_errno = ERRNO_LOCAL_ONLY;
8017 addr->message = US"remote deliveries suppressed";
8018 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
8021 /* Handle remote deliveries */
8025 DEBUG(D_deliver|D_transport)
8026 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
8028 /* Precompile some regex that are used to recognize parameters in response
8029 to an EHLO command, if they aren't already compiled. */
8031 smtp_deliver_init();
8033 /* Now sort the addresses if required, and do the deliveries. The yield of
8034 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
8035 cannot be delivered in one transaction. */
8037 if (remote_sort_domains) sort_remote_deliveries();
8038 if (!do_remote_deliveries(FALSE))
8040 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
8041 "be delivered in one transaction");
8042 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
8044 final_yield = DELIVER_MUA_FAILED;
8045 addr_failed = addr_defer = NULL; /* So that we remove the message */
8046 goto DELIVERY_TIDYUP;
8049 /* See if any of the addresses that failed got put on the queue for delivery
8050 to their fallback hosts. We do it this way because often the same fallback
8051 host is used for many domains, so all can be sent in a single transaction
8052 (if appropriately configured). */
8054 if (addr_fallback && !mua_wrapper)
8056 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
8057 addr_remote = addr_fallback;
8058 addr_fallback = NULL;
8059 if (remote_sort_domains) sort_remote_deliveries();
8060 do_remote_deliveries(TRUE);
8062 f.disable_logging = FALSE;
8066 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
8067 phase, to minimize cases of half-done things. */
8070 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
8071 cancel_cutthrough_connection(TRUE, US"deliveries are done");
8073 /* Root privilege is no longer needed */
8075 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
8077 set_process_info("tidying up after delivering %s", message_id);
8078 signal(SIGTERM, SIG_IGN);
8080 /* When we are acting as an MUA wrapper, the smtp transport will either have
8081 succeeded for all addresses, or failed them all in normal cases. However, there
8082 are some setup situations (e.g. when a named port does not exist) that cause an
8083 immediate exit with deferral of all addresses. Convert those into failures. We
8084 do not ever want to retry, nor do we want to send a bounce message. */
8090 address_item * nextaddr;
8091 for (address_item * addr = addr_defer; addr; addr = nextaddr)
8093 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
8094 "delivery", addr->address);
8095 nextaddr = addr->next;
8096 addr->next = addr_failed;
8102 /* Now all should either have succeeded or failed. */
8105 final_yield = DELIVER_MUA_SUCCEEDED;
8109 uschar *s = addr_failed->user_message;
8111 if (!s) s = addr_failed->message;
8113 fprintf(stderr, "Delivery failed: ");
8114 if (addr_failed->basic_errno > 0)
8116 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
8117 if (s) fprintf(stderr, ": ");
8119 if ((host = addr_failed->host_used))
8120 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
8122 fprintf(stderr, "%s", CS s);
8123 else if (addr_failed->basic_errno <= 0)
8124 fprintf(stderr, "unknown error");
8125 fprintf(stderr, "\n");
8127 final_yield = DELIVER_MUA_FAILED;
8132 /* In a normal configuration, we now update the retry database. This is done in
8133 one fell swoop at the end in order not to keep opening and closing (and
8134 locking) the database. The code for handling retries is hived off into a
8135 separate module for convenience. We pass it the addresses of the various
8136 chains, because deferred addresses can get moved onto the failed chain if the
8137 retry cutoff time has expired for all alternative destinations. Bypass the
8138 updating of the database if the -N flag is set, which is a debugging thing that
8139 prevents actual delivery. */
8141 else if (!f.dont_deliver)
8142 retry_update(&addr_defer, &addr_failed, &addr_succeed);
8144 /* Send DSN for successful messages if requested */
8146 maybe_send_dsn(addr_succeed);
8148 /* If any addresses failed, we must send a message to somebody, unless
8149 af_ignore_error is set, in which case no action is taken. It is possible for
8150 several messages to get sent if there are addresses with different
8155 const uschar * logtod = tod_stamp(tod_log);
8156 address_item * addr;
8158 /* There are weird cases when logging is disabled in the transport. However,
8159 there may not be a transport (address failed by a router). */
8161 f.disable_logging = FALSE;
8162 if (addr_failed->transport)
8163 f.disable_logging = addr_failed->transport->disable_logging;
8166 debug_printf("processing failed address %s\n", addr_failed->address);
8168 /* There are only two ways an address in a bounce message can get here:
8170 (1) When delivery was initially deferred, but has now timed out (in the call
8171 to retry_update() above). We can detect this by testing for
8172 af_retry_timedout. If the address does not have its own errors address,
8173 we arrange to ignore the error.
8175 (2) If delivery failures for bounce messages are being ignored. We can detect
8176 this by testing for af_ignore_error. This will also be set if a bounce
8177 message has been autothawed and the ignore_bounce_errors_after time has
8178 passed. It might also be set if a router was explicitly configured to
8179 ignore errors (errors_to = "").
8181 If neither of these cases obtains, something has gone wrong. Log the
8182 incident, but then ignore the error. */
8184 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
8186 if ( !testflag(addr_failed, af_retry_timedout)
8187 && !addr_failed->prop.ignore_error)
8188 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
8189 "failure is neither frozen nor ignored (it's been ignored)");
8191 addr_failed->prop.ignore_error = TRUE;
8194 /* If the first address on the list has af_ignore_error set, just remove
8195 it from the list, throw away any saved message file, log it, and
8196 mark the recipient done. */
8198 if ( addr_failed->prop.ignore_error
8199 || addr_failed->dsn_flags & rf_dsnflags
8200 && !(addr_failed->dsn_flags & rf_notify_failure)
8204 addr_failed = addr->next;
8205 if (addr->return_filename) Uunlink(addr->return_filename);
8207 #ifndef DISABLE_EVENT
8208 msg_event_raise(US"msg:fail:delivery", addr);
8210 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
8212 !addr->parent ? US"" : US" <",
8213 !addr->parent ? US"" : addr->parent->address,
8214 !addr->parent ? US"" : US">",
8215 addr->prop.ignore_error
8216 ? US"" : US": RFC 3461 DSN, failure notify not requested");
8218 address_done(addr, logtod);
8219 child_done(addr, logtod);
8220 /* Panic-dies on error */
8221 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8224 /* Otherwise, handle the sending of a message. Find the error address for
8225 the first address, then send a message that includes all failed addresses
8226 that have the same error address. */
8229 send_bounce_message(now, logtod);
8232 f.disable_logging = FALSE; /* In case left set */
8234 /* Come here from the mua_wrapper case if routing goes wrong */
8238 /* If there are now no deferred addresses, we are done. Preserve the
8239 message log if so configured, and we are using them. Otherwise, sling it.
8240 Then delete the message itself. */
8248 fname = spool_fname(US"msglog", message_subdir, id, US"");
8249 if (preserve_message_logs)
8252 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8254 if ((rc = Urename(fname, moname)) < 0)
8256 (void)directory_make(spool_directory,
8257 spool_sname(US"msglog.OLD", US""),
8258 MSGLOG_DIRECTORY_MODE, TRUE);
8259 rc = Urename(fname, moname);
8262 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8263 "msglog.OLD directory", fname);
8266 if (Uunlink(fname) < 0)
8267 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8268 fname, strerror(errno));
8271 /* Remove the two message files. */
8273 fname = spool_fname(US"input", message_subdir, id, US"-D");
8274 if (Uunlink(fname) < 0)
8275 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8276 fname, strerror(errno));
8277 fname = spool_fname(US"input", message_subdir, id, US"-H");
8278 if (Uunlink(fname) < 0)
8279 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8280 fname, strerror(errno));
8282 /* Log the end of this message, with queue time if requested. */
8284 if (LOGGING(queue_time_overall))
8285 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8287 log_write(0, LOG_MAIN, "Completed");
8289 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8290 f.deliver_freeze = FALSE;
8292 #ifndef DISABLE_EVENT
8293 (void) event_raise(event_action, US"msg:complete", NULL, NULL);
8297 /* If there are deferred addresses, we are keeping this message because it is
8298 not yet completed. Lose any temporary files that were catching output from
8299 pipes for any of the deferred addresses, handle one-time aliases, and see if
8300 the message has been on the queue for so long that it is time to send a warning
8301 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8302 have the same domain, we can set deliver_domain for the expansion of
8303 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8304 the parent's domain.
8306 If all the deferred addresses have an error number that indicates "retry time
8307 not reached", skip sending the warning message, because it won't contain the
8308 reason for the delay. It will get sent at the next real delivery attempt.
8309 Exception: for retries caused by a remote peer we use the error message
8310 store in the retry DB as the reason.
8311 However, if at least one address has tried, we'd better include all of them in
8314 If we can't make a process to send the message, don't worry.
8316 For mailing list expansions we want to send the warning message to the
8317 mailing list manager. We can't do a perfect job here, as some addresses may
8318 have different errors addresses, but if we take the errors address from
8319 each deferred address it will probably be right in most cases.
8321 If addr_defer == +1, it means there was a problem sending an error message
8322 for failed addresses, and there were no "real" deferred addresses. The value
8323 was set just to keep the message on the spool, so there is nothing to do here.
8326 else if (addr_defer != (address_item *)(+1))
8328 uschar * recipients = US"";
8329 BOOL want_warning_msg = FALSE;
8331 deliver_domain = testflag(addr_defer, af_pfr)
8332 ? addr_defer->parent->domain : addr_defer->domain;
8334 for (address_item * addr = addr_defer; addr; addr = addr->next)
8336 address_item * otaddr;
8338 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8342 const uschar *d = testflag(addr, af_pfr)
8343 ? addr->parent->domain : addr->domain;
8345 /* The domain may be unset for an address that has never been routed
8346 because the system filter froze the message. */
8348 if (!d || Ustrcmp(d, deliver_domain) != 0)
8349 deliver_domain = NULL;
8352 if (addr->return_filename) Uunlink(addr->return_filename);
8354 /* Handle the case of one-time aliases. If any address in the ancestry
8355 of this one is flagged, ensure it is in the recipients list, suitably
8356 flagged, and that its parent is marked delivered. */
8358 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8359 if (otaddr->onetime_parent) break;
8364 int t = recipients_count;
8366 for (i = 0; i < recipients_count; i++)
8368 uschar *r = recipients_list[i].address;
8369 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8370 if (Ustrcmp(otaddr->address, r) == 0) break;
8373 /* Didn't find the address already in the list, and did find the
8374 ultimate parent's address in the list, and they really are different
8375 (i.e. not from an identity-redirect). After adding the recipient,
8376 update the errors address in the recipients list. */
8378 if ( i >= recipients_count && t < recipients_count
8379 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8381 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8382 otaddr->address, otaddr->parent->address);
8383 receive_add_recipient(otaddr->address, t);
8384 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8385 tree_add_nonrecipient(otaddr->parent->address);
8386 update_spool = TRUE;
8390 /* Except for error messages, ensure that either the errors address for
8391 this deferred address or, if there is none, the sender address, is on the
8392 list of recipients for a warning message. */
8394 if (sender_address[0])
8396 uschar * s = addr->prop.errors_address;
8397 if (!s) s = sender_address;
8398 if (Ustrstr(recipients, s) == NULL)
8399 recipients = string_sprintf("%s%s%s", recipients,
8400 recipients[0] ? "," : "", s);
8404 /* Send a warning message if the conditions are right. If the condition check
8405 fails because of a lookup defer, there is nothing we can do. The warning
8406 is not sent. Another attempt will be made at the next delivery attempt (if
8409 if ( !f.queue_2stage
8411 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8412 || addr_defer->dsn_flags & rf_notify_delay
8414 && delay_warning[1] > 0
8415 && sender_address[0] != 0
8416 && ( !delay_warning_condition
8417 || expand_check_condition(delay_warning_condition,
8418 US"delay_warning", US"option")
8424 int queue_time = time(NULL) - received_time.tv_sec;
8426 queue_time = test_harness_fudged_queue_time(queue_time);
8428 /* See how many warnings we should have sent by now */
8430 for (count = 0; count < delay_warning[1]; count++)
8431 if (queue_time < delay_warning[count+2]) break;
8433 show_time = delay_warning[count+1];
8435 if (count >= delay_warning[1])
8438 int last_gap = show_time;
8439 if (count > 1) last_gap -= delay_warning[count];
8440 extra = (queue_time - delay_warning[count+1])/last_gap;
8441 show_time += last_gap * extra;
8447 debug_printf("time on queue = %s id %s addr %s\n",
8448 readconf_printtime(queue_time), message_id, addr_defer->address);
8449 debug_printf("warning counts: required %d done %d\n", count,
8453 /* We have computed the number of warnings there should have been by now.
8454 If there haven't been enough, send one, and up the count to what it should
8457 if (warning_count < count)
8458 if (send_warning_message(recipients, queue_time, show_time))
8460 warning_count = count;
8461 update_spool = TRUE; /* Ensure spool rewritten */
8465 /* Clear deliver_domain */
8467 deliver_domain = NULL;
8469 /* If this was a first delivery attempt, unset the first time flag, and
8470 ensure that the spool gets updated. */
8472 if (f.deliver_firsttime && !f.queue_2stage)
8474 f.deliver_firsttime = FALSE;
8475 update_spool = TRUE;
8478 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8479 message, unless the message is a local error message (to avoid loops). Then
8480 log the freezing. If the text in "frozen_info" came from a system filter,
8481 it has been escaped into printing characters so as not to mess up log lines.
8482 For the "tell" message, we turn \n back into newline. Also, insert a newline
8483 near the start instead of the ": " string. */
8485 if (f.deliver_freeze)
8487 if (freeze_tell && *freeze_tell && !f.local_error_message)
8489 uschar * s = string_copy(frozen_info);
8490 uschar * ss = Ustrstr(s, " by the system filter: ");
8499 if (*ss == '\\' && ss[1] == 'n')
8500 { *ss++ = ' '; *ss++ = '\n'; }
8504 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8505 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8509 /* Log freezing just before we update the -H file, to minimize the chance
8510 of a race problem. */
8512 deliver_msglog("*** Frozen%s\n", frozen_info);
8513 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8516 /* If there have been any updates to the non-recipients list, or other things
8517 that get written to the spool, we must now update the spool header file so
8518 that it has the right information for the next delivery attempt. If there
8519 was more than one address being delivered, the header_change update is done
8520 earlier, in case one succeeds and then something crashes. */
8523 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8524 update_spool, f.header_rewritten);
8526 if (update_spool || f.header_rewritten)
8527 /* Panic-dies on error */
8528 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8531 /* Finished with the message log. If the message is complete, it will have
8532 been unlinked or renamed above. */
8534 if (message_logs) (void)fclose(message_log);
8536 /* Now we can close and remove the journal file. Its only purpose is to record
8537 successfully completed deliveries asap so that this information doesn't get
8538 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8539 not serious, as trying it again is not harmful. The journal might not be open
8540 if all addresses were deferred at routing or directing. Nevertheless, we must
8541 remove it if it exists (may have been lying around from a crash during the
8542 previous delivery attempt). We don't remove the journal if a delivery
8543 subprocess failed to pass back delivery information; this is controlled by
8544 the remove_journal flag. When the journal is left, we also don't move the
8545 message off the main spool if frozen and the option is set. It should get moved
8546 at the next attempt, after the journal has been inspected. */
8548 if (journal_fd >= 0) (void)close(journal_fd);
8552 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8554 if (Uunlink(fname) < 0 && errno != ENOENT)
8555 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8558 /* Move the message off the spool if requested */
8560 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8561 if (f.deliver_freeze && move_frozen_messages)
8562 (void)spool_move_message(id, message_subdir, US"", US"F");
8566 /* Closing the data file frees the lock; if the file has been unlinked it
8567 will go away. Otherwise the message becomes available for another process
8570 (void)close(deliver_datafile);
8571 deliver_datafile = -1;
8572 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8573 #ifdef MEASURE_TIMING
8574 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8577 /* It is unlikely that there will be any cached resources, since they are
8578 released after routing, and in the delivery subprocesses. However, it's
8579 possible for an expansion for something afterwards (for example,
8580 expand_check_condition) to do a lookup. We must therefore be sure everything is
8584 acl_where = ACL_WHERE_UNKNOWN;
8593 #ifdef EXIM_TFO_PROBE
8596 f.tcp_fastopen_ok = TRUE;
8602 /* Called from a commandline, or from the daemon, to do a delivery.
8603 We need to regain privs; do this by exec of the exim binary. */
8606 delivery_re_exec(int exec_type)
8610 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8612 int channel_fd = cutthrough.cctx.sock;
8614 smtp_peer_options = cutthrough.peer_options;
8615 continue_sequence = 0;
8618 if (cutthrough.is_tls)
8622 smtp_peer_options |= OPTION_TLS;
8623 sending_ip_address = cutthrough.snd_ip;
8624 sending_port = cutthrough.snd_port;
8626 where = US"socketpair";
8627 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8631 testharness_pause_ms(150);
8632 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8635 if (pid == 0) /* child: will fork again to totally disconnect */
8637 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8638 pfd, 5*60, cutthrough.host.name);
8639 /* does not return */
8643 waitpid(pid, NULL, 0);
8644 (void) close(channel_fd); /* release the client socket */
8645 channel_fd = pfd[1];
8649 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8650 cutthrough.host.address, message_id, channel_fd);
8654 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8655 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8657 return; /* compiler quietening; control does not reach here. */
8662 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8663 "delivery re-exec %s failed: %s", where, strerror(errno));
8665 /* Get here if exec_type == CEE_EXEC_EXIT.
8666 Note: this must be _exit(), not exit(). */
8668 _exit(EX_EXECFAILED);
8674 /* End of deliver.c */