1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* The main code for delivering a message. */
13 #include "transports/smtp.h"
18 /* Data block for keeping track of subprocesses for parallel remote
21 typedef struct pardata {
22 address_item *addrlist; /* chain of addresses */
23 address_item *addr; /* next address data expected for */
24 pid_t pid; /* subprocess pid */
25 int fd; /* pipe fd for getting result from subprocess */
26 int transport_count; /* returned transport count value */
27 BOOL done; /* no more data needed */
28 uschar *msg; /* error message */
29 uschar *return_path; /* return_path for these addresses */
32 /* Values for the process_recipients variable */
34 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
35 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
38 /* Mutually recursive functions for marking addresses done. */
40 static void child_done(address_item *, uschar *);
41 static void address_done(address_item *, uschar *);
43 /* Table for turning base-62 numbers into binary */
45 static uschar tab62[] =
46 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
47 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
48 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
49 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
50 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
51 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
55 /*************************************************
56 * Local static variables *
57 *************************************************/
59 /* addr_duplicate is global because it needs to be seen from the Envelope-To
62 static address_item *addr_defer = NULL;
63 static address_item *addr_failed = NULL;
64 static address_item *addr_fallback = NULL;
65 static address_item *addr_local = NULL;
66 static address_item *addr_new = NULL;
67 static address_item *addr_remote = NULL;
68 static address_item *addr_route = NULL;
69 static address_item *addr_succeed = NULL;
70 static address_item *addr_senddsn = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static int return_count;
78 static uschar *frozen_info = US"";
79 static uschar *used_return_path = NULL;
83 /*************************************************
84 * read as much as requested *
85 *************************************************/
87 /* The syscall read(2) doesn't always returns as much as we want. For
88 several reasons it might get less. (Not talking about signals, as syscalls
89 are restartable). When reading from a network or pipe connection the sender
90 might send in smaller chunks, with delays between these chunks. The read(2)
91 may return such a chunk.
93 The more the writer writes and the smaller the pipe between write and read is,
94 the more we get the chance of reading leass than requested. (See bug 2130)
96 This function read(2)s until we got all the data we *requested*.
98 Note: This function may block. Use it only if you're sure about the
99 amount of data you will get.
102 fd the file descriptor to read from
103 buffer pointer to a buffer of size len
104 len the requested(!) amount of bytes
106 Returns: the amount of bytes read
109 readn(int fd, void * buffer, size_t len)
111 uschar * next = buffer;
112 uschar * end = next + len;
116 ssize_t got = read(fd, next, end - next);
118 /* I'm not sure if there are signals that can interrupt us,
119 for now I assume the worst */
120 if (got == -1 && errno == EINTR) continue;
121 if (got <= 0) return next - US buffer;
129 /*************************************************
130 * Make a new address item *
131 *************************************************/
133 /* This function gets the store and initializes with default values. The
134 transport_return value defaults to DEFER, so that any unexpected failure to
135 deliver does not wipe out the message. The default unique string is set to a
136 copy of the address, so that its domain can be lowercased.
139 address the RFC822 address string
140 copy force a copy of the address
142 Returns: a pointer to an initialized address_item
146 deliver_make_addr(uschar *address, BOOL copy)
148 address_item *addr = store_get(sizeof(address_item), FALSE);
149 *addr = address_defaults;
150 if (copy) address = string_copy(address);
151 addr->address = address;
152 addr->unique = string_copy(address);
159 /*************************************************
160 * Set expansion values for an address *
161 *************************************************/
163 /* Certain expansion variables are valid only when handling an address or
164 address list. This function sets them up or clears the values, according to its
168 addr the address in question, or NULL to clear values
173 deliver_set_expansions(address_item *addr)
177 const uschar ***p = address_expansions;
178 while (*p) **p++ = NULL;
182 /* Exactly what gets set depends on whether there is one or more addresses, and
183 what they contain. These first ones are always set, taking their values from
184 the first address. */
186 if (!addr->host_list)
188 deliver_host = deliver_host_address = US"";
189 deliver_host_port = 0;
193 deliver_host = addr->host_list->name;
194 deliver_host_address = addr->host_list->address;
195 deliver_host_port = addr->host_list->port;
198 deliver_recipients = addr;
199 deliver_address_data = addr->prop.address_data;
200 deliver_domain_data = addr->prop.domain_data;
201 deliver_localpart_data = addr->prop.localpart_data;
202 router_var = addr->prop.variables;
204 /* These may be unset for multiple addresses */
206 deliver_domain = addr->domain;
207 self_hostname = addr->self_hostname;
209 #ifdef EXPERIMENTAL_BRIGHTMAIL
210 bmi_deliver = 1; /* deliver by default */
211 bmi_alt_location = NULL;
212 bmi_base64_verdict = NULL;
213 bmi_base64_tracker_verdict = NULL;
216 /* If there's only one address we can set everything. */
220 address_item *addr_orig;
222 deliver_localpart = addr->local_part;
223 deliver_localpart_prefix = addr->prefix;
224 deliver_localpart_prefix_v = addr->prefix_v;
225 deliver_localpart_suffix = addr->suffix;
226 deliver_localpart_suffix_v = addr->suffix_v;
228 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
229 deliver_domain_orig = addr_orig->domain;
231 /* Re-instate any prefix and suffix in the original local part. In all
232 normal cases, the address will have a router associated with it, and we can
233 choose the caseful or caseless version accordingly. However, when a system
234 filter sets up a pipe, file, or autoreply delivery, no router is involved.
235 In this case, though, there won't be any prefix or suffix to worry about. */
237 deliver_localpart_orig = !addr_orig->router
238 ? addr_orig->local_part
239 : addr_orig->router->caseful_local_part
240 ? addr_orig->cc_local_part
241 : addr_orig->lc_local_part;
243 /* If there's a parent, make its domain and local part available, and if
244 delivering to a pipe or file, or sending an autoreply, get the local
245 part from the parent. For pipes and files, put the pipe or file string
246 into address_pipe and address_file. */
250 deliver_domain_parent = addr->parent->domain;
251 deliver_localpart_parent = !addr->parent->router
252 ? addr->parent->local_part
253 : addr->parent->router->caseful_local_part
254 ? addr->parent->cc_local_part
255 : addr->parent->lc_local_part;
257 /* File deliveries have their own flag because they need to be picked out
258 as special more often. */
260 if (testflag(addr, af_pfr))
262 if (testflag(addr, af_file)) address_file = addr->local_part;
263 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
264 deliver_localpart = addr->parent->local_part;
265 deliver_localpart_prefix = addr->parent->prefix;
266 deliver_localpart_prefix_v = addr->parent->prefix_v;
267 deliver_localpart_suffix = addr->parent->suffix;
268 deliver_localpart_suffix_v = addr->parent->suffix_v;
272 #ifdef EXPERIMENTAL_BRIGHTMAIL
273 /* Set expansion variables related to Brightmail AntiSpam */
274 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
275 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
276 /* get message delivery status (0 - don't deliver | 1 - deliver) */
277 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
278 /* if message is to be delivered, get eventual alternate location */
279 if (bmi_deliver == 1)
280 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
285 /* For multiple addresses, don't set local part, and leave the domain and
286 self_hostname set only if it is the same for all of them. It is possible to
287 have multiple pipe and file addresses, but only when all addresses have routed
288 to the same pipe or file. */
292 if (testflag(addr, af_pfr))
294 if (testflag(addr, af_file)) address_file = addr->local_part;
295 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
297 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
299 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
300 deliver_domain = NULL;
302 && ( !addr2->self_hostname
303 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
305 self_hostname = NULL;
306 if (!deliver_domain && !self_hostname) break;
314 /*************************************************
315 * Open a msglog file *
316 *************************************************/
318 /* This function is used both for normal message logs, and for files in the
319 msglog directory that are used to catch output from pipes. Try to create the
320 directory if it does not exist. From release 4.21, normal message logs should
321 be created when the message is received.
323 Called from deliver_message(), can be operating as root.
326 filename the file name
327 mode the mode required
328 error used for saying what failed
330 Returns: a file descriptor, or -1 (with errno set)
334 open_msglog_file(uschar *filename, int mode, uschar **error)
336 if (Ustrstr(filename, US"/../"))
337 log_write(0, LOG_MAIN|LOG_PANIC,
338 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
340 for (int i = 2; i > 0; i--)
342 int fd = Uopen(filename,
349 O_WRONLY|O_APPEND|O_CREAT, mode);
352 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
353 function is called as root). Double check the mode, because the group setting
354 doesn't always get set automatically. */
357 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
359 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
364 if (fchmod(fd, mode) < 0)
374 (void)directory_make(spool_directory,
375 spool_sname(US"msglog", message_subdir),
376 MSGLOG_DIRECTORY_MODE, TRUE);
379 *error = US"create or open";
386 /*************************************************
387 * Write to msglog if required *
388 *************************************************/
390 /* Write to the message log, if configured. This function may also be called
394 format a string format
400 deliver_msglog(const char *format, ...)
403 if (!message_logs) return;
404 va_start(ap, format);
405 vfprintf(message_log, format, ap);
413 /*************************************************
414 * Replicate status for batch *
415 *************************************************/
417 /* When a transport handles a batch of addresses, it may treat them
418 individually, or it may just put the status in the first one, and return FALSE,
419 requesting that the status be copied to all the others externally. This is the
420 replication function. As well as the status, it copies the transport pointer,
421 which may have changed if appendfile passed the addresses on to a different
424 Argument: pointer to the first address in a chain
429 replicate_status(address_item *addr)
431 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
433 addr2->transport = addr->transport;
434 addr2->transport_return = addr->transport_return;
435 addr2->basic_errno = addr->basic_errno;
436 addr2->more_errno = addr->more_errno;
437 addr2->delivery_time = addr->delivery_time;
438 addr2->special_action = addr->special_action;
439 addr2->message = addr->message;
440 addr2->user_message = addr->user_message;
446 /*************************************************
447 * Compare lists of hosts *
448 *************************************************/
450 /* This function is given two pointers to chains of host items, and it yields
451 TRUE if the lists refer to the same hosts in the same order, except that
453 (1) Multiple hosts with the same non-negative MX values are permitted to appear
454 in different orders. Round-robinning nameservers can cause this to happen.
456 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
457 permitted to appear in different orders. This is caused by randomizing
460 This enables Exim to use a single SMTP transaction for sending to two entirely
461 different domains that happen to end up pointing at the same hosts.
463 We do not try to batch up different A-record host names that refer to the
467 one points to the first host list
468 two points to the second host list
470 Returns: TRUE if the lists refer to the same host set
474 same_hosts(host_item *one, host_item *two)
478 if (Ustrcmp(one->name, two->name) != 0)
481 host_item *end_one = one;
482 host_item *end_two = two;
484 /* Batch up only if there was no MX and the list was not randomized */
486 if (mx == MX_NONE) return FALSE;
488 /* Find the ends of the shortest sequence of identical MX values */
490 while ( end_one->next && end_one->next->mx == mx
491 && end_two->next && end_two->next->mx == mx)
493 end_one = end_one->next;
494 end_two = end_two->next;
497 /* If there aren't any duplicates, there's no match. */
499 if (end_one == one) return FALSE;
501 /* For each host in the 'one' sequence, check that it appears in the 'two'
502 sequence, returning FALSE if not. */
507 for (hi = two; hi != end_two->next; hi = hi->next)
508 if (Ustrcmp(one->name, hi->name) == 0) break;
509 if (hi == end_two->next) return FALSE;
510 if (one == end_one) break;
514 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
515 Ensure both are pointing at the last host, and carry on as for equality. */
520 /* if the names matched but ports do not, mismatch */
521 else if (one->port != two->port)
530 /* True if both are NULL */
537 /*************************************************
538 * Compare header lines *
539 *************************************************/
541 /* This function is given two pointers to chains of header items, and it yields
542 TRUE if they are the same header texts in the same order.
545 one points to the first header list
546 two points to the second header list
548 Returns: TRUE if the lists refer to the same header set
552 same_headers(header_line *one, header_line *two)
554 for (;; one = one->next, two = two->next)
556 if (one == two) return TRUE; /* Includes the case where both NULL */
557 if (!one || !two) return FALSE;
558 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
564 /*************************************************
565 * Compare string settings *
566 *************************************************/
568 /* This function is given two pointers to strings, and it returns
569 TRUE if they are the same pointer, or if the two strings are the same.
572 one points to the first string
573 two points to the second string
575 Returns: TRUE or FALSE
579 same_strings(uschar *one, uschar *two)
581 if (one == two) return TRUE; /* Includes the case where both NULL */
582 if (!one || !two) return FALSE;
583 return (Ustrcmp(one, two) == 0);
588 /*************************************************
589 * Compare uid/gid for addresses *
590 *************************************************/
592 /* This function is given a transport and two addresses. It yields TRUE if the
593 uid/gid/initgroups settings for the two addresses are going to be the same when
598 addr1 the first address
599 addr2 the second address
601 Returns: TRUE or FALSE
605 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
607 if ( !tp->uid_set && !tp->expand_uid
608 && !tp->deliver_as_creator
609 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
610 || ( testflag(addr1, af_uid_set)
611 && ( addr1->uid != addr2->uid
612 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
616 if ( !tp->gid_set && !tp->expand_gid
617 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
618 || ( testflag(addr1, af_gid_set)
619 && addr1->gid != addr2->gid
629 /*************************************************
630 * Record that an address is complete *
631 *************************************************/
633 /* This function records that an address is complete. This is straightforward
634 for most addresses, where the unique address is just the full address with the
635 domain lower cased. For homonyms (addresses that are the same as one of their
636 ancestors) their are complications. Their unique addresses have \x\ prepended
637 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
640 Exim used to record the unique addresses of homonyms as "complete". This,
641 however, fails when the pattern of redirection varies over time (e.g. if taking
642 unseen copies at only some times of day) because the prepended numbers may vary
643 from one delivery run to the next. This problem is solved by never recording
644 prepended unique addresses as complete. Instead, when a homonymic address has
645 actually been delivered via a transport, we record its basic unique address
646 followed by the name of the transport. This is checked in subsequent delivery
647 runs whenever an address is routed to a transport.
649 If the completed address is a top-level one (has no parent, which means it
650 cannot be homonymic) we also add the original address to the non-recipients
651 tree, so that it gets recorded in the spool file and therefore appears as
652 "done" in any spool listings. The original address may differ from the unique
653 address in the case of the domain.
655 Finally, this function scans the list of duplicates, marks as done any that
656 match this address, and calls child_done() for their ancestors.
659 addr address item that has been completed
660 now current time as a string
666 address_done(address_item *addr, uschar *now)
668 update_spool = TRUE; /* Ensure spool gets updated */
670 /* Top-level address */
674 tree_add_nonrecipient(addr->unique);
675 tree_add_nonrecipient(addr->address);
678 /* Homonymous child address */
680 else if (testflag(addr, af_homonym))
683 tree_add_nonrecipient(
684 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
687 /* Non-homonymous child address */
689 else tree_add_nonrecipient(addr->unique);
691 /* Check the list of duplicate addresses and ensure they are now marked
694 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
695 if (Ustrcmp(addr->unique, dup->unique) == 0)
697 tree_add_nonrecipient(dup->unique);
698 child_done(dup, now);
705 /*************************************************
706 * Decrease counts in parents and mark done *
707 *************************************************/
709 /* This function is called when an address is complete. If there is a parent
710 address, its count of children is decremented. If there are still other
711 children outstanding, the function exits. Otherwise, if the count has become
712 zero, address_done() is called to mark the parent and its duplicates complete.
713 Then loop for any earlier ancestors.
716 addr points to the completed address item
717 now the current time as a string, for writing to the message log
723 child_done(address_item *addr, uschar *now)
730 if (--addr->child_count > 0) return; /* Incomplete parent */
731 address_done(addr, now);
733 /* Log the completion of all descendents only when there is no ancestor with
734 the same original address. */
736 for (aa = addr->parent; aa; aa = aa->parent)
737 if (Ustrcmp(aa->address, addr->address) == 0) break;
740 deliver_msglog("%s %s: children all complete\n", now, addr->address);
741 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
747 /*************************************************
748 * Delivery logging support functions *
749 *************************************************/
751 /* The LOGGING() checks in d_log_interface() are complicated for backwards
752 compatibility. When outgoing interface logging was originally added, it was
753 conditional on just incoming_interface (which is off by default). The
754 outgoing_interface option is on by default to preserve this behaviour, but
755 you can enable incoming_interface and disable outgoing_interface to get I=
756 fields on incoming lines only.
760 addr The address to be logged
762 Returns: New value for s
766 d_log_interface(gstring * g)
768 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
769 && sending_ip_address)
771 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
772 if (LOGGING(outgoing_port))
773 g = string_fmt_append(g, ":%d", sending_port);
781 d_hostlog(gstring * g, address_item * addr)
783 host_item * h = addr->host_used;
785 g = string_append(g, 2, US" H=", h->name);
787 if (LOGGING(dnssec) && h->dnssec == DS_YES)
788 g = string_catn(g, US" DS", 3);
790 g = string_append(g, 3, US" [", h->address, US"]");
792 if (LOGGING(outgoing_port))
793 g = string_fmt_append(g, ":%d", h->port);
795 if (continue_sequence > 1) /*XXX this is wrong for a dropped proxyconn. Would have to pass back from transport */
796 g = string_catn(g, US"*", 1);
799 if (LOGGING(proxy) && proxy_local_address)
801 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
802 if (LOGGING(outgoing_port))
803 g = string_fmt_append(g, ":%d", proxy_local_port);
807 g = d_log_interface(g);
809 if (testflag(addr, af_tcp_fastopen))
810 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
821 d_tlslog(gstring * g, address_item * addr)
823 if (LOGGING(tls_cipher) && addr->cipher)
825 g = string_append(g, 2, US" X=", addr->cipher);
826 #ifndef DISABLE_TLS_RESUME
827 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
828 g = string_catn(g, US"*", 1);
831 if (LOGGING(tls_certificate_verified) && addr->cipher)
832 g = string_append(g, 2, US" CV=",
833 testflag(addr, af_cert_verified)
836 testflag(addr, af_dane_verified)
842 if (LOGGING(tls_peerdn) && addr->peerdn)
843 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
851 #ifndef DISABLE_EVENT
853 event_raise(uschar * action, const uschar * event, uschar * ev_data)
859 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
861 action, deliver_host_address);
864 event_data = ev_data;
866 if (!(s = expand_string(action)) && *expand_string_message)
867 log_write(0, LOG_MAIN|LOG_PANIC,
868 "failed to expand event_action %s in %s: %s\n",
869 event, transport_name ? transport_name : US"main", expand_string_message);
871 event_name = event_data = NULL;
873 /* If the expansion returns anything but an empty string, flag for
874 the caller to modify his normal processing
879 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
888 msg_event_raise(const uschar * event, const address_item * addr)
890 const uschar * save_domain = deliver_domain;
891 uschar * save_local = deliver_localpart;
892 const uschar * save_host = deliver_host;
893 const uschar * save_address = deliver_host_address;
894 const int save_port = deliver_host_port;
896 router_name = addr->router ? addr->router->name : NULL;
897 deliver_domain = addr->domain;
898 deliver_localpart = addr->local_part;
899 deliver_host = addr->host_used ? addr->host_used->name : NULL;
901 if (!addr->transport)
903 if (Ustrcmp(event, "msg:fail:delivery") == 0)
905 /* An address failed with no transport involved. This happens when
906 a filter was used which triggered a fail command (in such a case
907 a transport isn't needed). Convert it to an internal fail event. */
909 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
914 transport_name = addr->transport->name;
916 (void) event_raise(addr->transport->event_action, event,
918 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
919 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
920 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
921 ? addr->message : NULL);
924 deliver_host_port = save_port;
925 deliver_host_address = save_address;
926 deliver_host = save_host;
927 deliver_localpart = save_local;
928 deliver_domain = save_domain;
929 router_name = transport_name = NULL;
931 #endif /*DISABLE_EVENT*/
935 /******************************************************************************/
938 /*************************************************
939 * Generate local prt for logging *
940 *************************************************/
942 /* This function is a subroutine for use in string_log_address() below.
945 addr the address being logged
946 yield the current dynamic buffer pointer
948 Returns: the new value of the buffer pointer
952 string_get_localpart(address_item * addr, gstring * yield)
957 if (testflag(addr, af_include_affixes) && s)
960 if (testflag(addr, af_utf8_downcvt))
961 s = string_localpart_utf8_to_alabel(s, NULL);
963 yield = string_cat(yield, s);
966 s = addr->local_part;
968 if (testflag(addr, af_utf8_downcvt))
969 s = string_localpart_utf8_to_alabel(s, NULL);
971 yield = string_cat(yield, s);
974 if (testflag(addr, af_include_affixes) && s)
977 if (testflag(addr, af_utf8_downcvt))
978 s = string_localpart_utf8_to_alabel(s, NULL);
980 yield = string_cat(yield, s);
987 /*************************************************
988 * Generate log address list *
989 *************************************************/
991 /* This function generates a list consisting of an address and its parents, for
992 use in logging lines. For saved onetime aliased addresses, the onetime parent
993 field is used. If the address was delivered by a transport with rcpt_include_
994 affixes set, the af_include_affixes bit will be set in the address. In that
995 case, we include the affixes here too.
998 g points to growing-string struct
999 addr bottom (ultimate) address
1000 all_parents if TRUE, include all parents
1001 success TRUE for successful delivery
1003 Returns: a growable string in dynamic store
1007 string_log_address(gstring * g,
1008 address_item *addr, BOOL all_parents, BOOL success)
1010 BOOL add_topaddr = TRUE;
1011 address_item *topaddr;
1013 /* Find the ultimate parent */
1015 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1017 /* We start with just the local part for pipe, file, and reply deliveries, and
1018 for successful local deliveries from routers that have the log_as_local flag
1019 set. File deliveries from filters can be specified as non-absolute paths in
1020 cases where the transport is going to complete the path. If there is an error
1021 before this happens (expansion failure) the local part will not be updated, and
1022 so won't necessarily look like a path. Add extra text for this case. */
1024 if ( testflag(addr, af_pfr)
1026 && addr->router && addr->router->log_as_local
1027 && addr->transport && addr->transport->info->local
1030 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1031 g = string_catn(g, CUS"save ", 5);
1032 g = string_get_localpart(addr, g);
1035 /* Other deliveries start with the full address. It we have split it into local
1036 part and domain, use those fields. Some early failures can happen before the
1037 splitting is done; in those cases use the original field. */
1042 int off = g->ptr; /* start of the "full address" */
1044 if (addr->local_part)
1047 g = string_get_localpart(addr, g);
1048 g = string_catn(g, US"@", 1);
1051 if (testflag(addr, af_utf8_downcvt))
1052 s = string_localpart_utf8_to_alabel(s, NULL);
1054 g = string_cat(g, s);
1057 g = string_cat(g, addr->address);
1059 /* If the address we are going to print is the same as the top address,
1060 and all parents are not being included, don't add on the top address. First
1061 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1062 on the local parts. */
1064 cmp = g->s + off; /* only now, as rebuffer likely done */
1065 string_from_gstring(g); /* ensure nul-terminated */
1066 if ( strcmpic(cmp, topaddr->address) == 0
1067 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1068 && !addr->onetime_parent
1069 && (!all_parents || !addr->parent || addr->parent == topaddr)
1071 add_topaddr = FALSE;
1074 /* If all parents are requested, or this is a local pipe/file/reply, and
1075 there is at least one intermediate parent, show it in brackets, and continue
1076 with all of them if all are wanted. */
1078 if ( (all_parents || testflag(addr, af_pfr))
1080 && addr->parent != topaddr)
1083 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1085 g = string_catn(g, s, 2);
1086 g = string_cat (g, addr2->address);
1087 if (!all_parents) break;
1090 g = string_catn(g, US")", 1);
1093 /* Add the top address if it is required */
1096 g = string_append(g, 3,
1098 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1106 /******************************************************************************/
1110 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1111 this is a nonstandard call; no two-character delivery flag is written
1112 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1115 flags passed to log_write()
1118 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1120 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1123 /* Log the delivery on the main log. We use an extensible string to build up
1124 the log line, and reset the store afterwards. Remote deliveries should always
1125 have a pointer to the host item that succeeded; local deliveries can have a
1126 pointer to a single host item in their host list, for use by the transport. */
1128 #ifndef DISABLE_EVENT
1129 /* presume no successful remote delivery */
1130 lookup_dnssec_authenticated = NULL;
1133 reset_point = store_mark();
1134 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1137 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1140 g->s[0] = logchar; g->ptr = 1;
1141 g = string_catn(g, US"> ", 2);
1143 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1145 if (LOGGING(sender_on_delivery) || msg)
1146 g = string_append(g, 3, US" F=<",
1148 testflag(addr, af_utf8_downcvt)
1149 ? string_address_utf8_to_alabel(sender_address, NULL)
1156 g = string_append(g, 2, US" Q=", queue_name);
1158 #ifdef EXPERIMENTAL_SRS_ALT
1159 if(addr->prop.srs_sender)
1160 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
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=",
1273 string_timesince(&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, "%s", string_from_gstring(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 (void) string_from_gstring(g);
1342 /* Log the deferment in the message log, but don't clutter it
1343 up with retry-time defers after the first delivery attempt. */
1345 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1346 deliver_msglog("%s %s\n", now, g->s);
1348 /* Write the main log and reset the store.
1349 For errors of the type "retry time not reached" (also remotes skipped
1350 on queue run), logging is controlled by L_retry_defer. Note that this kind
1351 of error number is negative, and all the retry ones are less than any
1355 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1358 store_reset(reset_point);
1365 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1367 rmark reset_point = store_mark();
1368 gstring * g = string_get(256);
1370 #ifndef DISABLE_EVENT
1371 /* Message failures for which we will send a DSN get their event raised
1372 later so avoid doing it here. */
1374 if ( !addr->prop.ignore_error
1375 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1377 msg_event_raise(US"msg:fail:delivery", addr);
1380 /* Build up the log line for the message and main logs */
1382 /* Create the address string for logging. Must not do this earlier, because
1383 an OK result may be changed to FAIL when a pipe returns text. */
1385 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1387 if (LOGGING(sender_on_delivery))
1388 g = string_append(g, 3, US" F=<", sender_address, US">");
1391 g = string_append(g, 2, US" Q=", queue_name);
1393 /* Return path may not be set if no delivery actually happened */
1395 if (used_return_path && LOGGING(return_path_on_delivery))
1396 g = string_append(g, 3, US" P=<", used_return_path, US">");
1399 g = string_append(g, 2, US" R=", addr->router->name);
1400 if (addr->transport)
1401 g = string_append(g, 2, US" T=", addr->transport->name);
1403 if (addr->host_used)
1404 g = d_hostlog(g, addr);
1407 g = d_tlslog(g, addr);
1410 if (addr->basic_errno > 0)
1411 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1414 g = string_append(g, 2, US": ", addr->message);
1416 if (LOGGING(deliver_time))
1417 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1419 (void) string_from_gstring(g);
1421 /* Do the logging. For the message log, "routing failed" for those cases,
1422 just to make it clearer. */
1425 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1427 deliver_msglog("%s %s\n", now, g->s);
1429 log_write(0, LOG_MAIN, "** %s", g->s);
1431 store_reset(reset_point);
1437 /*************************************************
1438 * Actions at the end of handling an address *
1439 *************************************************/
1441 /* This is a function for processing a single address when all that can be done
1442 with it has been done.
1445 addr points to the address block
1446 result the result of the delivery attempt
1447 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1448 driver_type indicates which type of driver (transport, or router) was last
1449 to process the address
1450 logchar '=' or '-' for use when logging deliveries with => or ->
1456 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1459 uschar *now = tod_stamp(tod_log);
1460 uschar *driver_kind = NULL;
1461 uschar *driver_name = NULL;
1463 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1465 /* Set up driver kind and name for logging. Disable logging if the router or
1466 transport has disabled it. */
1468 if (driver_type == EXIM_DTYPE_TRANSPORT)
1470 if (addr->transport)
1472 driver_name = addr->transport->name;
1473 driver_kind = US" transport";
1474 f.disable_logging = addr->transport->disable_logging;
1476 else driver_kind = US"transporting";
1478 else if (driver_type == EXIM_DTYPE_ROUTER)
1482 driver_name = addr->router->name;
1483 driver_kind = US" router";
1484 f.disable_logging = addr->router->disable_logging;
1486 else driver_kind = US"routing";
1489 /* If there's an error message set, ensure that it contains only printing
1490 characters - it should, but occasionally things slip in and this at least
1491 stops the log format from getting wrecked. We also scan the message for an LDAP
1492 expansion item that has a password setting, and flatten the password. This is a
1493 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1494 malformed, it won't ever have gone near LDAP.) */
1498 const uschar * s = string_printing(addr->message);
1500 /* deconst cast ok as string_printing known to have alloc'n'copied */
1501 addr->message = expand_hide_passwords(US s);
1504 /* If we used a transport that has one of the "return_output" options set, and
1505 if it did in fact generate some output, then for return_output we treat the
1506 message as failed if it was not already set that way, so that the output gets
1507 returned to the sender, provided there is a sender to send it to. For
1508 return_fail_output, do this only if the delivery failed. Otherwise we just
1509 unlink the file, and remove the name so that if the delivery failed, we don't
1510 try to send back an empty or unwanted file. The log_output options operate only
1511 on a non-empty file.
1513 In any case, we close the message file, because we cannot afford to leave a
1514 file-descriptor for one address while processing (maybe very many) others. */
1516 if (addr->return_file >= 0 && addr->return_filename)
1518 BOOL return_output = FALSE;
1519 struct stat statbuf;
1520 (void)EXIMfsync(addr->return_file);
1522 /* If there is no output, do nothing. */
1524 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1526 transport_instance *tb = addr->transport;
1528 /* Handle logging options */
1531 || result == FAIL && tb->log_fail_output
1532 || result == DEFER && tb->log_defer_output
1536 FILE *f = Ufopen(addr->return_filename, "rb");
1538 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1539 "from %s transport: %s", addr->return_filename, tb->name,
1542 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1544 uschar *p = big_buffer + Ustrlen(big_buffer);
1546 while (p > big_buffer && isspace(p[-1])) p--;
1548 sp = string_printing(big_buffer);
1549 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1550 addr->address, tb->name, sp);
1555 /* Handle returning options, but only if there is an address to return
1558 if (sender_address[0] != 0 || addr->prop.errors_address)
1559 if (tb->return_output)
1561 addr->transport_return = result = FAIL;
1562 if (addr->basic_errno == 0 && !addr->message)
1563 addr->message = US"return message generated";
1564 return_output = TRUE;
1567 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1570 /* Get rid of the file unless it might be returned, but close it in
1575 Uunlink(addr->return_filename);
1576 addr->return_filename = NULL;
1577 addr->return_file = -1;
1580 (void)close(addr->return_file);
1583 /* The success case happens only after delivery by a transport. */
1587 addr->next = addr_succeed;
1588 addr_succeed = addr;
1590 /* Call address_done() to ensure that we don't deliver to this address again,
1591 and write appropriate things to the message log. If it is a child address, we
1592 call child_done() to scan the ancestors and mark them complete if this is the
1593 last child to complete. */
1595 address_done(addr, now);
1596 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1599 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1600 driver_name, driver_kind);
1603 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1604 addr->parent->address, driver_name, driver_kind);
1605 child_done(addr, now);
1608 /* Certificates for logging (via events) */
1610 tls_out.ourcert = addr->ourcert;
1611 addr->ourcert = NULL;
1612 tls_out.peercert = addr->peercert;
1613 addr->peercert = NULL;
1615 tls_out.ver = addr->tlsver;
1616 tls_out.cipher = addr->cipher;
1617 tls_out.peerdn = addr->peerdn;
1618 tls_out.ocsp = addr->ocsp;
1619 # ifdef SUPPORT_DANE
1620 tls_out.dane_verified = testflag(addr, af_dane_verified);
1624 delivery_log(LOG_MAIN, addr, logchar, NULL);
1627 tls_free_cert(&tls_out.ourcert);
1628 tls_free_cert(&tls_out.peercert);
1630 tls_out.cipher = NULL;
1631 tls_out.peerdn = NULL;
1632 tls_out.ocsp = OCSP_NOT_REQ;
1633 # ifdef SUPPORT_DANE
1634 tls_out.dane_verified = FALSE;
1640 /* Soft failure, or local delivery process failed; freezing may be
1643 else if (result == DEFER || result == PANIC)
1645 if (result == PANIC) logflags |= LOG_PANIC;
1647 /* This puts them on the chain in reverse order. Do not change this, because
1648 the code for handling retries assumes that the one with the retry
1649 information is last. */
1651 addr->next = addr_defer;
1654 /* The only currently implemented special action is to freeze the
1655 message. Logging of this is done later, just before the -H file is
1658 if (addr->special_action == SPECIAL_FREEZE)
1660 f.deliver_freeze = TRUE;
1661 deliver_frozen_at = time(NULL);
1662 update_spool = TRUE;
1665 /* If doing a 2-stage queue run, we skip writing to either the message
1666 log or the main log for SMTP defers. */
1668 if (!f.queue_2stage || addr->basic_errno != 0)
1669 deferral_log(addr, now, logflags, driver_name, driver_kind);
1673 /* Hard failure. If there is an address to which an error message can be sent,
1674 put this address on the failed list. If not, put it on the deferred list and
1675 freeze the mail message for human attention. The latter action can also be
1676 explicitly requested by a router or transport. */
1680 /* If this is a delivery error, or a message for which no replies are
1681 wanted, and the message's age is greater than ignore_bounce_errors_after,
1682 force the af_ignore_error flag. This will cause the address to be discarded
1683 later (with a log entry). */
1685 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1686 addr->prop.ignore_error = TRUE;
1688 /* Freeze the message if requested, or if this is a bounce message (or other
1689 message with null sender) and this address does not have its own errors
1690 address. However, don't freeze if errors are being ignored. The actual code
1691 to ignore occurs later, instead of sending a message. Logging of freezing
1692 occurs later, just before writing the -H file. */
1694 if ( !addr->prop.ignore_error
1695 && ( addr->special_action == SPECIAL_FREEZE
1696 || (sender_address[0] == 0 && !addr->prop.errors_address)
1699 frozen_info = addr->special_action == SPECIAL_FREEZE
1701 : f.sender_local && !f.local_error_message
1702 ? US" (message created with -f <>)"
1703 : US" (delivery error message)";
1704 f.deliver_freeze = TRUE;
1705 deliver_frozen_at = time(NULL);
1706 update_spool = TRUE;
1708 /* The address is put on the defer rather than the failed queue, because
1709 the message is being retained. */
1711 addr->next = addr_defer;
1715 /* Don't put the address on the nonrecipients tree yet; wait until an
1716 error message has been successfully sent. */
1720 addr->next = addr_failed;
1724 failure_log(addr, driver_name ? NULL : driver_kind, now);
1727 /* Ensure logging is turned on again in all cases */
1729 f.disable_logging = FALSE;
1735 /*************************************************
1736 * Address-independent error *
1737 *************************************************/
1739 /* This function is called when there's an error that is not dependent on a
1740 particular address, such as an expansion string failure. It puts the error into
1741 all the addresses in a batch, logs the incident on the main and panic logs, and
1742 clears the expansions. It is mostly called from local_deliver(), but can be
1743 called for a remote delivery via findugid().
1746 logit TRUE if (MAIN+PANIC) logging required
1747 addr the first of the chain of addresses
1749 format format string for error message, or NULL if already set in addr
1750 ... arguments for the format
1756 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1758 addr->basic_errno = code;
1765 va_start(ap, format);
1766 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1768 addr->message = string_from_gstring(g);
1771 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1773 addr2->basic_errno = code;
1774 addr2->message = addr->message;
1777 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1778 deliver_set_expansions(NULL);
1784 /*************************************************
1785 * Check a "never users" list *
1786 *************************************************/
1788 /* This function is called to check whether a uid is on one of the two "never
1792 uid the uid to be checked
1793 nusers the list to be scanned; the first item in the list is the count
1795 Returns: TRUE if the uid is on the list
1799 check_never_users(uid_t uid, uid_t *nusers)
1801 if (!nusers) return FALSE;
1802 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1808 /*************************************************
1809 * Find uid and gid for a transport *
1810 *************************************************/
1812 /* This function is called for both local and remote deliveries, to find the
1813 uid/gid under which to run the delivery. The values are taken preferentially
1814 from the transport (either explicit or deliver_as_creator), then from the
1815 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1816 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1817 panic error is logged, and the function fails (which normally leads to delivery
1821 addr the address (possibly a chain)
1823 uidp pointer to uid field
1824 gidp pointer to gid field
1825 igfp pointer to the use_initgroups field
1827 Returns: FALSE if failed - error has been set in address(es)
1831 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1835 BOOL gid_set = FALSE;
1837 /* Default initgroups flag comes from the transport */
1839 *igfp = tp->initgroups;
1841 /* First see if there's a gid on the transport, either fixed or expandable.
1842 The expanding function always logs failure itself. */
1849 else if (tp->expand_gid)
1851 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1854 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1860 /* If the transport did not set a group, see if the router did. */
1862 if (!gid_set && testflag(addr, af_gid_set))
1868 /* Pick up a uid from the transport if one is set. */
1870 if (tp->uid_set) *uidp = tp->uid;
1872 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1873 it does not provide a passwd value from which a gid can be taken. */
1875 else if (tp->expand_uid)
1878 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1879 uidp, &(addr->message)))
1881 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1891 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1893 else if (tp->deliver_as_creator)
1895 *uidp = originator_uid;
1898 *gidp = originator_gid;
1903 /* Otherwise see if the address specifies the uid and if so, take it and its
1906 else if (testflag(addr, af_uid_set))
1909 *igfp = testflag(addr, af_initgroups);
1912 /* Nothing has specified the uid - default to the Exim user, and group if the
1925 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1926 defaulting to the Exim uid. In other words, if the configuration has specified
1927 a uid, it must also provide a gid. */
1931 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1932 "%s transport", tp->name);
1936 /* Check that the uid is not on the lists of banned uids that may not be used
1937 for delivery processes. */
1939 nuname = check_never_users(*uidp, never_users)
1941 : check_never_users(*uidp, fixed_never_users)
1942 ? US"fixed_never_users"
1946 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1947 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1959 /*************************************************
1960 * Check the size of a message for a transport *
1961 *************************************************/
1963 /* Checks that the message isn't too big for the selected transport.
1964 This is called only when it is known that the limit is set.
1968 addr the (first) address being delivered
1971 DEFER expansion failed or did not yield an integer
1972 FAIL message too big
1976 check_message_size(transport_instance *tp, address_item *addr)
1981 deliver_set_expansions(addr);
1982 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1983 deliver_set_expansions(NULL);
1985 if (expand_string_message)
1988 addr->message = size_limit == -1
1989 ? string_sprintf("failed to expand message_size_limit "
1990 "in %s transport: %s", tp->name, expand_string_message)
1991 : string_sprintf("invalid message_size_limit "
1992 "in %s transport: %s", tp->name, expand_string_message);
1994 else if (size_limit > 0 && message_size > size_limit)
1998 string_sprintf("message is too big (transport limit = %d)",
2007 /*************************************************
2008 * Transport-time check for a previous delivery *
2009 *************************************************/
2011 /* Check that this base address hasn't previously been delivered to its routed
2012 transport. If it has been delivered, mark it done. The check is necessary at
2013 delivery time in order to handle homonymic addresses correctly in cases where
2014 the pattern of redirection changes between delivery attempts (so the unique
2015 fields change). Non-homonymic previous delivery is detected earlier, at routing
2016 time (which saves unnecessary routing).
2019 addr the address item
2020 testing TRUE if testing wanted only, without side effects
2022 Returns: TRUE if previously delivered by the transport
2026 previously_transported(address_item *addr, BOOL testing)
2028 uschar * s = string_sprintf("%s/%s",
2029 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2031 if (tree_search(tree_nonrecipients, s) != 0)
2033 DEBUG(D_deliver|D_route|D_transport)
2034 debug_printf("%s was previously delivered (%s transport): discarded\n",
2035 addr->address, addr->transport->name);
2036 if (!testing) child_done(addr, tod_stamp(tod_log));
2045 /******************************************************
2046 * Check for a given header in a header string *
2047 ******************************************************/
2049 /* This function is used when generating quota warnings. The configuration may
2050 specify any header lines it likes in quota_warn_message. If certain of them are
2051 missing, defaults are inserted, so we need to be able to test for the presence
2055 hdr the required header name
2056 hstring the header string
2058 Returns: TRUE the header is in the string
2059 FALSE the header is not in the string
2063 contains_header(uschar *hdr, uschar *hstring)
2065 int len = Ustrlen(hdr);
2066 uschar *p = hstring;
2069 if (strncmpic(p, hdr, len) == 0)
2072 while (*p == ' ' || *p == '\t') p++;
2073 if (*p == ':') return TRUE;
2075 while (*p != 0 && *p != '\n') p++;
2076 if (*p == '\n') p++;
2084 /*************************************************
2085 * Perform a local delivery *
2086 *************************************************/
2088 /* Each local delivery is performed in a separate process which sets its
2089 uid and gid as specified. This is a safer way than simply changing and
2090 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2091 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2092 all systems have seteuid().
2094 If the uid/gid are specified in the transport_instance, they are used; the
2095 transport initialization must ensure that either both or neither are set.
2096 Otherwise, the values associated with the address are used. If neither are set,
2097 it is a configuration error.
2099 The transport or the address may specify a home directory (transport over-
2100 rides), and if they do, this is set as $home. If neither have set a working
2101 directory, this value is used for that as well. Otherwise $home is left unset
2102 and the cwd is set to "/" - a directory that should be accessible to all users.
2104 Using a separate process makes it more complicated to get error information
2105 back. We use a pipe to pass the return code and also an error code and error
2106 text string back to the parent process.
2109 addr points to an address block for this delivery; for "normal" local
2110 deliveries this is the only address to be delivered, but for
2111 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2112 a number of addresses can be handled simultaneously, and in this
2113 case addr will point to a chain of addresses with the same
2116 shadowing TRUE if running a shadow transport; this causes output from pipes
2123 deliver_local(address_item *addr, BOOL shadowing)
2125 BOOL use_initgroups;
2128 int status, len, rc;
2131 uschar *working_directory;
2132 address_item *addr2;
2133 transport_instance *tp = addr->transport;
2135 /* Set up the return path from the errors or sender address. If the transport
2136 has its own return path setting, expand it and replace the existing value. */
2138 if(addr->prop.errors_address)
2139 return_path = addr->prop.errors_address;
2140 #ifdef EXPERIMENTAL_SRS_ALT
2141 else if (addr->prop.srs_sender)
2142 return_path = addr->prop.srs_sender;
2145 return_path = sender_address;
2147 if (tp->return_path)
2149 uschar * new_return_path = expand_string(tp->return_path);
2150 if (new_return_path)
2151 return_path = new_return_path;
2152 else if (!f.expand_string_forcedfail)
2154 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2155 US"Failed to expand return path \"%s\" in %s transport: %s",
2156 tp->return_path, tp->name, expand_string_message);
2161 /* For local deliveries, one at a time, the value used for logging can just be
2162 set directly, once and for all. */
2164 used_return_path = return_path;
2166 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2167 gets put into the address(es), and the expansions are unset, so we can just
2170 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2172 /* See if either the transport or the address specifies a home directory. A
2173 home directory set in the address may already be expanded; a flag is set to
2174 indicate that. In other cases we must expand it. */
2176 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2177 || ( (deliver_home = addr->home_dir) /* Set in address and */
2178 && !testflag(addr, af_home_expanded) /* not expanded */
2181 uschar *rawhome = deliver_home;
2182 deliver_home = NULL; /* in case it contains $home */
2183 if (!(deliver_home = expand_string(rawhome)))
2185 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2186 "to expand for %s transport: %s", rawhome, tp->name,
2187 expand_string_message);
2190 if (*deliver_home != '/')
2192 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2193 "is not absolute for %s transport", deliver_home, tp->name);
2198 /* See if either the transport or the address specifies a current directory,
2199 and if so, expand it. If nothing is set, use the home directory, unless it is
2200 also unset in which case use "/", which is assumed to be a directory to which
2201 all users have access. It is necessary to be in a visible directory for some
2202 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2203 2.5) require this. */
2205 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2206 if (working_directory)
2208 uschar *raw = working_directory;
2209 if (!(working_directory = expand_string(raw)))
2211 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2212 "failed to expand for %s transport: %s", raw, tp->name,
2213 expand_string_message);
2216 if (*working_directory != '/')
2218 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2219 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2223 else working_directory = deliver_home ? deliver_home : US"/";
2225 /* If one of the return_output flags is set on the transport, create and open a
2226 file in the message log directory for the transport to write its output onto.
2227 This is mainly used by pipe transports. The file needs to be unique to the
2228 address. This feature is not available for shadow transports. */
2231 && ( tp->return_output || tp->return_fail_output
2232 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2237 addr->return_filename =
2238 spool_fname(US"msglog", message_subdir, message_id,
2239 string_sprintf("-%d-%d", getpid(), return_count++));
2241 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2243 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2244 "to return message: %s", error, tp->name, strerror(errno));
2249 /* Create the pipe for inter-process communication. */
2253 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2258 /* Now fork the process to do the real work in the subprocess, but first
2259 ensure that all cached resources are freed so that the subprocess starts with
2260 a clean slate and doesn't interfere with the parent process. */
2264 if ((pid = exim_fork(US"delivery-local")) == 0)
2266 BOOL replicate = TRUE;
2268 /* Prevent core dumps, as we don't want them in users' home directories.
2269 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2270 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2271 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2272 complain if the error is "not supported".
2274 There are two scenarios where changing the max limit has an effect. In one,
2275 the user is using a .forward and invoking a command of their choice via pipe;
2276 for these, we do need the max limit to be 0 unless the admin chooses to
2277 permit an increased limit. In the other, the command is invoked directly by
2278 the transport and is under administrator control, thus being able to raise
2279 the limit aids in debugging. So there's no general always-right answer.
2281 Thus we inhibit core-dumps completely but let individual transports, while
2282 still root, re-raise the limits back up to aid debugging. We make the
2283 default be no core-dumps -- few enough people can use core dumps in
2284 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2291 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2293 # ifdef SETRLIMIT_NOT_SUPPORTED
2294 if (errno != ENOSYS && errno != ENOTSUP)
2296 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2301 /* Reset the random number generator, so different processes don't all
2302 have the same sequence. */
2306 /* If the transport has a setup entry, call this first, while still
2307 privileged. (Appendfile uses this to expand quota, for example, while
2308 able to read private files.) */
2310 if (addr->transport->setup)
2311 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2315 addr->transport_return = DEFER;
2319 addr->transport_return = PANIC;
2323 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2324 when the process becomes unprivileged, it won't be able to write to the
2325 process log. SIGHUP is ignored throughout exim, except when it is being
2328 signal(SIGINT, SIG_IGN);
2329 signal(SIGTERM, SIG_IGN);
2330 signal(SIGUSR1, SIG_IGN);
2332 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2333 half - for transports that exec things (e.g. pipe). Then set the required
2336 (void)close(pfd[pipe_read]);
2337 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2339 exim_setugid(uid, gid, use_initgroups,
2340 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2341 addr->address, addr->transport->name));
2345 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2346 for (address_item * batched = addr->next; batched; batched = batched->next)
2347 debug_printf("additional batched address: %s\n", batched->address);
2350 /* Set an appropriate working directory. */
2352 if (Uchdir(working_directory) < 0)
2354 addr->transport_return = DEFER;
2355 addr->basic_errno = errno;
2356 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2359 /* If successful, call the transport */
2364 set_process_info("delivering %s to %s using %s", message_id,
2365 addr->local_part, addr->transport->name);
2367 /* Setting this global in the subprocess means we need never clear it */
2368 transport_name = addr->transport->name;
2370 /* If a transport filter has been specified, set up its argument list.
2371 Any errors will get put into the address, and FALSE yielded. */
2373 if (addr->transport->filter_command)
2375 ok = transport_set_up_command(&transport_filter_argv,
2376 addr->transport->filter_command,
2377 TRUE, PANIC, addr, US"transport filter", NULL);
2378 transport_filter_timeout = addr->transport->filter_timeout;
2380 else transport_filter_argv = NULL;
2384 debug_print_string(addr->transport->debug_string);
2385 replicate = !(addr->transport->info->code)(addr->transport, addr);
2389 /* Pass the results back down the pipe. If necessary, first replicate the
2390 status in the top address to the others in the batch. The label is the
2391 subject of a goto when a call to the transport's setup function fails. We
2392 pass the pointer to the transport back in case it got changed as a result of
2393 file_format in appendfile. */
2397 if (replicate) replicate_status(addr);
2398 for (addr2 = addr; addr2; addr2 = addr2->next)
2401 int local_part_length = Ustrlen(addr2->local_part);
2405 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2406 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2407 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2408 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2409 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2410 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2411 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2412 || (ret = write(pfd[pipe_write], &addr2->transport,
2413 sizeof(transport_instance *))) != sizeof(transport_instance *)
2415 /* For a file delivery, pass back the local part, in case the original
2416 was only part of the final delivery path. This gives more complete
2419 || (testflag(addr2, af_file)
2420 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2421 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2425 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2426 ret == -1 ? strerror(errno) : "short write");
2428 /* Now any messages */
2430 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2432 int message_length = s ? Ustrlen(s) + 1 : 0;
2433 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2434 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2436 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2437 ret == -1 ? strerror(errno) : "short write");
2441 /* OK, this process is now done. Free any cached resources that it opened,
2442 and close the pipe we were writing down before exiting. */
2444 (void)close(pfd[pipe_write]);
2449 /* Back in the main process: panic if the fork did not succeed. This seems
2450 better than returning an error - if forking is failing it is probably best
2451 not to try other deliveries for this message. */
2454 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2457 /* Read the pipe to get the delivery status codes and error messages. Our copy
2458 of the writing end must be closed first, as otherwise read() won't return zero
2459 on an empty pipe. We check that a status exists for each address before
2460 overwriting the address structure. If data is missing, the default DEFER status
2461 will remain. Afterwards, close the reading end. */
2463 (void)close(pfd[pipe_write]);
2465 for (addr2 = addr; addr2; addr2 = addr2->next)
2467 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2472 addr2->transport_return = status;
2473 len = read(pfd[pipe_read], &transport_count,
2474 sizeof(transport_count));
2475 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2476 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2477 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2478 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2479 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2480 len = read(pfd[pipe_read], &addr2->transport,
2481 sizeof(transport_instance *));
2483 if (testflag(addr2, af_file))
2486 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2487 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2490 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2491 " from delivery subprocess");
2494 /* sanity-checked llen so disable the Coverity error */
2495 /* coverity[tainted_data] */
2496 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2498 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2499 " from delivery subprocess");
2502 big_buffer[llen] = 0;
2503 addr2->local_part = string_copy(big_buffer);
2506 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2509 len = read(pfd[pipe_read], &message_length, sizeof(int));
2510 if (message_length > 0)
2512 len = read(pfd[pipe_read], big_buffer, message_length);
2513 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2514 if (len > 0) *sptr = string_copy(big_buffer);
2521 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2522 "from delivery subprocess", addr2->unique);
2527 (void)close(pfd[pipe_read]);
2529 /* Unless shadowing, write all successful addresses immediately to the journal
2530 file, to ensure they are recorded asap. For homonymic addresses, use the base
2531 address plus the transport name. Failure to write the journal is panic-worthy,
2532 but don't stop, as it may prove possible subsequently to update the spool file
2533 in order to record the delivery. */
2537 for (addr2 = addr; addr2; addr2 = addr2->next)
2538 if (addr2->transport_return == OK)
2540 if (testflag(addr2, af_homonym))
2541 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2543 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2545 /* In the test harness, wait just a bit to let the subprocess finish off
2546 any debug output etc first. */
2548 testharness_pause_ms(300);
2550 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2551 len = Ustrlen(big_buffer);
2552 if (write(journal_fd, big_buffer, len) != len)
2553 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2554 big_buffer, strerror(errno));
2557 /* Ensure the journal file is pushed out to disk. */
2559 if (EXIMfsync(journal_fd) < 0)
2560 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2564 /* Wait for the process to finish. If it terminates with a non-zero code,
2565 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2566 status values of all the addresses as they are. Take care to handle the case
2567 when the subprocess doesn't seem to exist. This has been seen on one system
2568 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2569 happens, wait() doesn't recognize the termination of child processes. Exim now
2570 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2572 while ((rc = wait(&status)) != pid)
2573 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2575 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2576 addr->transport->driver_name);
2581 if ((status & 0xffff) != 0)
2583 int msb = (status >> 8) & 255;
2584 int lsb = status & 255;
2585 int code = (msb == 0)? (lsb & 0x7f) : msb;
2586 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2587 addr->special_action = SPECIAL_FREEZE;
2588 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2589 "status 0x%04x: %s %d",
2590 addr->transport->driver_name,
2592 msb == 0 ? "terminated by signal" : "exit code",
2596 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2598 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2601 uschar *warn_message;
2604 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2606 if (!(warn_message = expand_string(addr->transport->warn_message)))
2607 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2608 "message for %s transport): %s", addr->transport->warn_message,
2609 addr->transport->name, expand_string_message);
2611 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2613 FILE *f = fdopen(fd, "wb");
2614 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2615 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2616 fprintf(f, "Auto-Submitted: auto-replied\n");
2617 if (!contains_header(US"From", warn_message))
2619 fprintf(f, "%s", CS warn_message);
2621 /* Close and wait for child process to complete, without a timeout. */
2624 (void)child_close(pid, 0);
2627 addr->special_action = SPECIAL_NONE;
2634 /* Check transport for the given concurrency limit. Return TRUE if over
2635 the limit (or an expansion failure), else FALSE and if there was a limit,
2636 the key for the hints database used for the concurrency count. */
2639 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2641 unsigned max_parallel;
2643 if (!tp->max_parallel) return FALSE;
2645 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2646 if (expand_string_message)
2648 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2649 "in %s transport (%s): %s", tp->name, addr->address,
2650 expand_string_message);
2654 if (max_parallel > 0)
2656 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2657 if (!enq_start(serialize_key, max_parallel))
2659 address_item * next;
2661 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2662 tp->name, max_parallel);
2666 addr->message = US"concurrency limit reached for transport";
2667 addr->basic_errno = ERRNO_TRETRY;
2668 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2669 } while ((addr = next));
2672 *key = serialize_key;
2679 /*************************************************
2680 * Do local deliveries *
2681 *************************************************/
2683 /* This function processes the list of addresses in addr_local. True local
2684 deliveries are always done one address at a time. However, local deliveries can
2685 be batched up in some cases. Typically this is when writing batched SMTP output
2686 files for use by some external transport mechanism, or when running local
2687 deliveries over LMTP.
2694 do_local_deliveries(void)
2697 open_db *dbm_file = NULL;
2698 time_t now = time(NULL);
2700 /* Loop until we have exhausted the supply of local deliveries */
2704 struct timeval delivery_start;
2705 struct timeval deliver_time;
2706 address_item *addr2, *addr3, *nextaddr;
2707 int logflags = LOG_MAIN;
2708 int logchar = f.dont_deliver? '*' : '=';
2709 transport_instance *tp;
2710 uschar * serialize_key = NULL;
2712 /* Pick the first undelivered address off the chain */
2714 address_item *addr = addr_local;
2715 addr_local = addr->next;
2718 DEBUG(D_deliver|D_transport)
2719 debug_printf("--------> %s <--------\n", addr->address);
2721 /* An internal disaster if there is no transport. Should not occur! */
2723 if (!(tp = addr->transport))
2725 logflags |= LOG_PANIC;
2726 f.disable_logging = FALSE; /* Jic */
2727 addr->message = addr->router
2728 ? string_sprintf("No transport set by %s router", addr->router->name)
2729 : US"No transport set by system filter";
2730 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2734 /* Check that this base address hasn't previously been delivered to this
2735 transport. The check is necessary at this point to handle homonymic addresses
2736 correctly in cases where the pattern of redirection changes between delivery
2737 attempts. Non-homonymic previous delivery is detected earlier, at routing
2740 if (previously_transported(addr, FALSE)) continue;
2742 /* There are weird cases where logging is disabled */
2744 f.disable_logging = tp->disable_logging;
2746 /* Check for batched addresses and possible amalgamation. Skip all the work
2747 if either batch_max <= 1 or there aren't any other addresses for local
2750 if (tp->batch_max > 1 && addr_local)
2752 int batch_count = 1;
2753 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2754 BOOL uses_lp = ( testflag(addr, af_pfr)
2755 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2757 || readconf_depends((driver_instance *)tp, US"local_part");
2758 uschar *batch_id = NULL;
2759 address_item **anchor = &addr_local;
2760 address_item *last = addr;
2763 /* Expand the batch_id string for comparison with other addresses.
2764 Expansion failure suppresses batching. */
2768 deliver_set_expansions(addr);
2769 batch_id = expand_string(tp->batch_id);
2770 deliver_set_expansions(NULL);
2773 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2774 "in %s transport (%s): %s", tp->name, addr->address,
2775 expand_string_message);
2776 batch_count = tp->batch_max;
2780 /* Until we reach the batch_max limit, pick off addresses which have the
2781 same characteristics. These are:
2784 not previously delivered (see comment about 50 lines above)
2785 same local part if the transport's configuration contains $local_part
2786 or if this is a file or pipe delivery from a redirection
2787 same domain if the transport's configuration contains $domain
2789 same additional headers
2790 same headers to be removed
2791 same uid/gid for running the transport
2792 same first host if a host list is set
2795 while ((next = *anchor) && batch_count < tp->batch_max)
2798 tp == next->transport
2799 && !previously_transported(next, TRUE)
2800 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2801 && testflag(addr, af_file) == testflag(next, af_file)
2802 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2803 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2804 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2805 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2806 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2807 && same_ugid(tp, addr, next)
2808 && ( !addr->host_list && !next->host_list
2811 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2814 /* If the transport has a batch_id setting, batch_id will be non-NULL
2815 from the expansion outside the loop. Expand for this address and compare.
2816 Expansion failure makes this address ineligible for batching. */
2821 address_item *save_nextnext = next->next;
2822 next->next = NULL; /* Expansion for a single address */
2823 deliver_set_expansions(next);
2824 next->next = save_nextnext;
2825 bid = expand_string(tp->batch_id);
2826 deliver_set_expansions(NULL);
2829 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2830 "in %s transport (%s): %s", tp->name, next->address,
2831 expand_string_message);
2834 else ok = (Ustrcmp(batch_id, bid) == 0);
2837 /* Take address into batch if OK. */
2841 *anchor = next->next; /* Include the address */
2847 else anchor = &next->next; /* Skip the address */
2851 /* We now have one or more addresses that can be delivered in a batch. Check
2852 whether the transport is prepared to accept a message of this size. If not,
2853 fail them all forthwith. If the expansion fails, or does not yield an
2854 integer, defer delivery. */
2856 if (tp->message_size_limit)
2858 int rc = check_message_size(tp, addr);
2861 replicate_status(addr);
2865 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2868 continue; /* With next batch of addresses */
2872 /* If we are not running the queue, or if forcing, all deliveries will be
2873 attempted. Otherwise, we must respect the retry times for each address. Even
2874 when not doing this, we need to set up the retry key string, and determine
2875 whether a retry record exists, because after a successful delivery, a delete
2876 retry item must be set up. Keep the retry database open only for the duration
2877 of these checks, rather than for all local deliveries, because some local
2878 deliveries (e.g. to pipes) can take a substantial time. */
2880 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2882 DEBUG(D_deliver|D_retry|D_hints_lookup)
2883 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), FALSE);
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 select() 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) from transport process %d\n",
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), FALSE);
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 */
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. */
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);
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 #ifdef SUPPORT_SOCKS
3575 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3576 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3581 proxy_local_address = string_copy(ptr);
3583 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3584 ptr += sizeof(proxy_local_port);
3589 #ifdef EXPERIMENTAL_DSN_INFO
3590 case '1': /* must arrive before A0, and applies to that addr */
3591 /* Two strings: smtp_greeting and helo_response */
3592 addr->smtp_greeting = string_copy(ptr);
3594 addr->helo_response = string_copy(ptr);
3600 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3601 addr->transport_return = *ptr++;
3602 addr->special_action = *ptr++;
3603 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3604 ptr += sizeof(addr->basic_errno);
3605 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3606 ptr += sizeof(addr->more_errno);
3607 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3608 ptr += sizeof(addr->delivery_time);
3609 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3610 ptr += sizeof(addr->flags);
3611 addr->message = *ptr ? string_copy(ptr) : NULL;
3613 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3616 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3620 h = store_get(sizeof(host_item), FALSE);
3621 h->name = string_copy(ptr);
3623 h->address = string_copy(ptr);
3625 memcpy(&h->port, ptr, sizeof(h->port));
3626 ptr += sizeof(h->port);
3627 h->dnssec = *ptr == '2' ? DS_YES
3628 : *ptr == '1' ? DS_NO
3631 addr->host_used = h;
3635 /* Finished with this address */
3642 /* Local interface address/port */
3644 if (*ptr) sending_ip_address = string_copy(ptr);
3646 if (*ptr) sending_port = atoi(CS ptr);
3650 /* Z marks the logical end of the data. It is followed by '0' if
3651 continue_transport was NULL at the end of transporting, otherwise '1'.
3652 We need to know when it becomes NULL during a delivery down a passed SMTP
3653 channel so that we don't try to pass anything more down it. Of course, for
3654 most normal messages it will remain NULL all the time. */
3659 continue_transport = NULL;
3660 continue_hostname = NULL;
3663 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3666 /* Anything else is a disaster. */
3669 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3670 "process %d for transport %s", ptr[-1], pid,
3671 addr->transport->driver_name);
3677 /* The done flag is inspected externally, to determine whether or not to
3678 call the function again when the process finishes. */
3682 /* If the process hadn't finished, and we haven't seen the end of the data
3683 or if we suffered a disaster, update the rest of the state, and return FALSE to
3684 indicate "not finished". */
3693 /* Close our end of the pipe, to prevent deadlock if the far end is still
3694 pushing stuff into it. */
3699 /* If we have finished without error, but haven't had data for every address,
3700 something is wrong. */
3703 msg = string_sprintf("insufficient address data read from pipe "
3704 "for transport process %d for transport %s", pid,
3705 addr->transport->driver_name);
3707 /* If an error message is set, something has gone wrong in getting back
3708 the delivery data. Put the message into each address and freeze it. */
3711 for (addr = addrlist; addr; addr = addr->next)
3713 addr->transport_return = DEFER;
3714 addr->special_action = SPECIAL_FREEZE;
3715 addr->message = msg;
3716 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3719 /* Return TRUE to indicate we have got all we need from this process, even
3720 if it hasn't actually finished yet. */
3727 /*************************************************
3728 * Post-process a set of remote addresses *
3729 *************************************************/
3731 /* Do what has to be done immediately after a remote delivery for each set of
3732 addresses, then re-write the spool if necessary. Note that post_process_one
3733 puts the address on an appropriate queue; hence we must fish off the next
3734 one first. This function is also called if there is a problem with setting
3735 up a subprocess to do a remote delivery in parallel. In this case, the final
3736 argument contains a message, and the action must be forced to DEFER.
3739 addr pointer to chain of address items
3740 logflags flags for logging
3741 msg NULL for normal cases; -> error message for unexpected problems
3742 fallback TRUE if processing fallback hosts
3748 remote_post_process(address_item *addr, int logflags, uschar *msg,
3751 /* If any host addresses were found to be unusable, add them to the unusable
3752 tree so that subsequent deliveries don't try them. */
3754 for (host_item * h = addr->host_list; h; h = h->next)
3756 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3758 /* Now handle each address on the chain. The transport has placed '=' or '-'
3759 into the special_action field for each successful delivery. */
3763 address_item *next = addr->next;
3765 /* If msg == NULL (normal processing) and the result is DEFER and we are
3766 processing the main hosts and there are fallback hosts available, put the
3767 address on the list for fallback delivery. */
3769 if ( addr->transport_return == DEFER
3770 && addr->fallback_hosts
3775 addr->host_list = addr->fallback_hosts;
3776 addr->next = addr_fallback;
3777 addr_fallback = addr;
3778 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3781 /* If msg is set (=> unexpected problem), set it in the address before
3782 doing the ordinary post processing. */
3788 addr->message = msg;
3789 addr->transport_return = DEFER;
3791 (void)post_process_one(addr, addr->transport_return, logflags,
3792 EXIM_DTYPE_TRANSPORT, addr->special_action);
3800 /* If we have just delivered down a passed SMTP channel, and that was
3801 the last address, the channel will have been closed down. Now that
3802 we have logged that delivery, set continue_sequence to 1 so that
3803 any subsequent deliveries don't get "*" incorrectly logged. */
3805 if (!continue_transport) continue_sequence = 1;
3810 /*************************************************
3811 * Wait for one remote delivery subprocess *
3812 *************************************************/
3814 /* This function is called while doing remote deliveries when either the
3815 maximum number of processes exist and we need one to complete so that another
3816 can be created, or when waiting for the last ones to complete. It must wait for
3817 the completion of one subprocess, empty the control block slot, and return a
3818 pointer to the address chain.
3821 Returns: pointer to the chain of addresses handled by the process;
3822 NULL if no subprocess found - this is an unexpected error
3825 static address_item *
3828 int poffset, status;
3829 address_item *addr, *addrlist;
3832 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3833 "to finish", message_id);
3835 /* Loop until either a subprocess completes, or there are no subprocesses in
3836 existence - in which case give an error return. We cannot proceed just by
3837 waiting for a completion, because a subprocess may have filled up its pipe, and
3838 be waiting for it to be emptied. Therefore, if no processes have finished, we
3839 wait for one of the pipes to acquire some data by calling select(), with a
3840 timeout just in case.
3842 The simple approach is just to iterate after reading data from a ready pipe.
3843 This leads to non-ideal behaviour when the subprocess has written its final Z
3844 item, closed the pipe, and is in the process of exiting (the common case). A
3845 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3846 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3849 To avoid this, if all the data that is needed has been read from a subprocess
3850 after select(), an explicit wait() for it is done. We know that all it is doing
3851 is writing to the pipe and then exiting, so the wait should not be long.
3853 The non-blocking waitpid() is to some extent just insurance; if we could
3854 reliably detect end-of-file on the pipe, we could always know when to do a
3855 blocking wait() for a completed process. However, because some systems use
3856 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3857 use code that functions without the need to recognize EOF.
3859 There's a double loop here just in case we end up with a process that is not in
3860 the list of remote delivery processes. Something has obviously gone wrong if
3861 this is the case. (For example, a process that is incorrectly left over from
3862 routing or local deliveries might be found.) The damage can be minimized by
3863 looping back and looking for another process. If there aren't any, the error
3864 return will happen. */
3866 for (;;) /* Normally we do not repeat this loop */
3868 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3871 fd_set select_pipes;
3872 int maxpipe, readycount;
3874 /* A return value of -1 can mean several things. If errno != ECHILD, it
3875 either means invalid options (which we discount), or that this process was
3876 interrupted by a signal. Just loop to try the waitpid() again.
3878 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3879 in existence. This should never happen, and is an unexpected error.
3880 However, there is a nasty complication when running under Linux. If "strace
3881 -f" is being used under Linux to trace this process and its children,
3882 subprocesses are "stolen" from their parents and become the children of the
3883 tracing process. A general wait such as the one we've just obeyed returns
3884 as if there are no children while subprocesses are running. Once a
3885 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3886 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3889 This does not happen using "truss" on Solaris, nor (I think) with other
3890 tracing facilities on other OS. It seems to be specific to Linux.
3892 What we do to get round this is to use kill() to see if any of our
3893 subprocesses are still in existence. If kill() gives an OK return, we know
3894 it must be for one of our processes - it can't be for a re-use of the pid,
3895 because if our process had finished, waitpid() would have found it. If any
3896 of our subprocesses are in existence, we proceed to use select() as if
3897 waitpid() had returned zero. I think this is safe. */
3901 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3904 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3905 "for process existence\n");
3907 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3909 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3911 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3912 "stolen by strace\n", (int)pid);
3913 break; /* With poffset set */
3917 if (poffset >= remote_max_parallel)
3919 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3920 return NULL; /* This is the error return */
3924 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3925 been handled above. A return value of zero means that there is at least one
3926 subprocess, but there are no completed subprocesses. See if any pipes are
3927 ready with any data for reading. */
3929 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3932 FD_ZERO(&select_pipes);
3933 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3934 if (parlist[poffset].pid != 0)
3936 int fd = parlist[poffset].fd;
3937 FD_SET(fd, &select_pipes);
3938 if (fd > maxpipe) maxpipe = fd;
3941 /* Stick in a 60-second timeout, just in case. */
3946 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3949 /* Scan through the pipes and read any that are ready; use the count
3950 returned by select() to stop when there are no more. Select() can return
3951 with no processes (e.g. if interrupted). This shouldn't matter.
3953 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3954 read, or there was a disaster. In either case, we are finished with this
3955 process. Do an explicit wait() for the process and break the main loop if
3958 It turns out that we have to deal with the case of an interrupted system
3959 call, which can happen on some operating systems if the signal handling is
3960 set up to do that by default. */
3963 readycount > 0 && poffset < remote_max_parallel;
3966 if ( (pid = parlist[poffset].pid) != 0
3967 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3971 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3972 for (;;) /* Loop for signals */
3974 pid_t endedpid = waitpid(pid, &status, 0);
3975 if (endedpid == pid) goto PROCESS_DONE;
3976 if (endedpid != (pid_t)(-1) || errno != EINTR)
3977 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3978 "%d (errno = %d) from waitpid() for process %d",
3979 (int)endedpid, errno, (int)pid);
3984 /* Now go back and look for a completed subprocess again. */
3987 /* A completed process was detected by the non-blocking waitpid(). Find the
3988 data block that corresponds to this subprocess. */
3990 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3991 if (pid == parlist[poffset].pid) break;
3993 /* Found the data block; this is a known remote delivery process. We don't
3994 need to repeat the outer loop. This should be what normally happens. */
3996 if (poffset < remote_max_parallel) break;
3998 /* This situation is an error, but it's probably better to carry on looking
3999 for another process than to give up (as we used to do). */
4001 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4002 "transport process list", pid);
4003 } /* End of the "for" loop */
4005 /* Come here when all the data was completely read after a select(), and
4006 the process in pid has been wait()ed for. */
4013 debug_printf("remote delivery process %d ended\n", (int)pid);
4015 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4019 set_process_info("delivering %s", message_id);
4021 /* Get the chain of processed addresses */
4023 addrlist = parlist[poffset].addrlist;
4025 /* If the process did not finish cleanly, record an error and freeze (except
4026 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4027 in case the delivery did actually happen. */
4029 if ((status & 0xffff) != 0)
4032 int msb = (status >> 8) & 255;
4033 int lsb = status & 255;
4034 int code = (msb == 0)? (lsb & 0x7f) : msb;
4036 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4038 addrlist->transport->driver_name,
4040 (msb == 0)? "terminated by signal" : "exit code",
4043 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4044 addrlist->special_action = SPECIAL_FREEZE;
4046 for (addr = addrlist; addr; addr = addr->next)
4048 addr->transport_return = DEFER;
4049 addr->message = msg;
4052 remove_journal = FALSE;
4055 /* Else complete reading the pipe to get the result of the delivery, if all
4056 the data has not yet been obtained. */
4058 else if (!parlist[poffset].done) (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), FALSE);
4205 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4206 parlist[poffset].pid = 0;
4209 /* Now loop for each remote delivery */
4211 for (int delivery_count = 0; addr_remote; delivery_count++)
4217 int address_count = 1;
4218 int address_count_max;
4220 BOOL use_initgroups;
4221 BOOL pipe_done = FALSE;
4222 transport_instance *tp;
4223 address_item **anchor = &addr_remote;
4224 address_item *addr = addr_remote;
4225 address_item *last = addr;
4228 uschar * serialize_key = NULL;
4230 /* Pull the first address right off the list. */
4232 addr_remote = addr->next;
4235 DEBUG(D_deliver|D_transport)
4236 debug_printf("--------> %s <--------\n", addr->address);
4238 /* If no transport has been set, there has been a big screw-up somewhere. */
4240 if (!(tp = addr->transport))
4242 f.disable_logging = FALSE; /* Jic */
4243 panicmsg = US"No transport set by router";
4244 goto panic_continue;
4247 /* Check that this base address hasn't previously been delivered to this
4248 transport. The check is necessary at this point to handle homonymic addresses
4249 correctly in cases where the pattern of redirection changes between delivery
4250 attempts. Non-homonymic previous delivery is detected earlier, at routing
4253 if (previously_transported(addr, FALSE)) continue;
4255 /* Force failure if the message is too big. */
4257 if (tp->message_size_limit)
4259 int rc = check_message_size(tp, addr);
4262 addr->transport_return = rc;
4263 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4268 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4269 So look out for the place it gets used.
4272 /* Get the flag which specifies whether the transport can handle different
4273 domains that nevertheless resolve to the same set of hosts. If it needs
4274 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4275 $host, $host_address, $host_port. */
4276 if (tp->expand_multi_domain)
4277 deliver_set_expansions(addr);
4279 if (exp_bool(addr, US"transport", tp->name, D_transport,
4280 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4281 &multi_domain) != OK)
4283 deliver_set_expansions(NULL);
4284 panicmsg = addr->message;
4285 goto panic_continue;
4288 /* Get the maximum it can handle in one envelope, with zero meaning
4289 unlimited, which is forced for the MUA wrapper case. */
4291 address_count_max = tp->max_addresses;
4292 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4295 /************************************************************************/
4296 /***** This is slightly experimental code, but should be safe. *****/
4298 /* The address_count_max value is the maximum number of addresses that the
4299 transport can send in one envelope. However, the transport must be capable of
4300 dealing with any number of addresses. If the number it gets exceeds its
4301 envelope limitation, it must send multiple copies of the message. This can be
4302 done over a single connection for SMTP, so uses less resources than making
4303 multiple connections. On the other hand, if remote_max_parallel is greater
4304 than one, it is perhaps a good idea to use parallel processing to move the
4305 message faster, even if that results in multiple simultaneous connections to
4308 How can we come to some compromise between these two ideals? What we do is to
4309 limit the number of addresses passed to a single instance of a transport to
4310 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4311 number of addresses routed to remote transports divided by
4312 remote_max_parallel. For example, if the message has 100 remote recipients,
4313 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4314 once. But if rcpt_max is 100, we could send up to 100.
4316 Of course, not all the remotely addresses in a message are going to go to the
4317 same set of hosts (except in smarthost configurations), so this is just a
4318 heuristic way of dividing up the work.
4320 Furthermore (1), because this may not be wanted in some cases, and also to
4321 cope with really pathological cases, there is also a limit to the number of
4322 messages that are sent over one connection. This is the same limit that is
4323 used when sending several different messages over the same connection.
4324 Continue_sequence is set when in this situation, to the number sent so
4325 far, including this message.
4327 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4328 is probably because they are using VERP, in which case they want to pass only
4329 one address at a time to the transport, in order to be able to use
4330 $local_part and $domain in constructing a new return path. We could test for
4331 the use of these variables, but as it is so likely they will be used when the
4332 maximum is 1, we don't bother. Just leave the value alone. */
4334 if ( address_count_max != 1
4335 && address_count_max < remote_delivery_count/remote_max_parallel
4338 int new_max = remote_delivery_count/remote_max_parallel;
4339 int message_max = tp->connection_max_messages;
4340 if (connection_max_messages >= 0) message_max = connection_max_messages;
4341 message_max -= continue_sequence - 1;
4342 if (message_max > 0 && new_max > address_count_max * message_max)
4343 new_max = address_count_max * message_max;
4344 address_count_max = new_max;
4347 /************************************************************************/
4350 /*XXX don't know yet if DANE will be used. So tpt will have to
4351 check at the point if gets next addr from list, and skip/defer any
4355 /* Pick off all addresses which have the same transport, errors address,
4356 destination, and extra headers. In some cases they point to the same host
4357 list, but we also need to check for identical host lists generated from
4358 entirely different domains. The host list pointers can be NULL in the case
4359 where the hosts are defined in the transport. There is also a configured
4360 maximum limit of addresses that can be handled at once (see comments above
4361 for how it is computed).
4362 If the transport does not handle multiple domains, enforce that also,
4363 and if it might need a per-address check for this, re-evaluate it.
4366 while ((next = *anchor) && address_count < address_count_max)
4369 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4370 && tp == next->transport
4371 && same_hosts(next->host_list, addr->host_list)
4372 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4373 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4374 && same_ugid(tp, next, addr)
4375 && ( next->prop.remove_headers == addr->prop.remove_headers
4376 || ( next->prop.remove_headers
4377 && addr->prop.remove_headers
4378 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4382 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4384 US"transport", next->transport->name, D_transport,
4385 US"multi_domain", next->transport->multi_domain,
4386 next->transport->expand_multi_domain, &md) == OK
4391 *anchor = next->next;
4393 next->first = addr; /* remember top one (for retry processing) */
4398 else anchor = &(next->next);
4399 deliver_set_expansions(NULL);
4402 /* If we are acting as an MUA wrapper, all addresses must go in a single
4403 transaction. If not, put them back on the chain and yield FALSE. */
4405 if (mua_wrapper && addr_remote)
4407 last->next = addr_remote;
4412 /* If the transport is limited for parallellism, enforce that here.
4413 The hints DB entry is decremented in par_reduce(), when we reap the
4414 transport process. */
4416 if (tpt_parallel_check(tp, addr, &serialize_key))
4417 if ((panicmsg = expand_string_message))
4418 goto panic_continue;
4420 continue; /* Loop for the next set of addresses. */
4422 /* Set up the expansion variables for this set of addresses */
4424 deliver_set_expansions(addr);
4426 /* Ensure any transport-set auth info is fresh */
4427 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4429 /* Compute the return path, expanding a new one if required. The old one
4430 must be set first, as it might be referred to in the expansion. */
4432 if(addr->prop.errors_address)
4433 return_path = addr->prop.errors_address;
4434 #ifdef EXPERIMENTAL_SRS_ALT
4435 else if(addr->prop.srs_sender)
4436 return_path = addr->prop.srs_sender;
4439 return_path = sender_address;
4441 if (tp->return_path)
4443 uschar *new_return_path = expand_string(tp->return_path);
4444 if (new_return_path)
4445 return_path = new_return_path;
4446 else if (!f.expand_string_forcedfail)
4448 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4449 tp->return_path, expand_string_message);
4454 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4455 logs and sets up error messages, so we just post-process and continue with
4456 the next address. */
4458 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4464 /* If this transport has a setup function, call it now so that it gets
4465 run in this process and not in any subprocess. That way, the results of
4466 any setup that are retained by the transport can be reusable. One of the
4467 things the setup does is to set the fallback host lists in the addresses.
4468 That is why it is called at this point, before the continue delivery
4469 processing, because that might use the fallback hosts. */
4472 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4474 /* If we have a connection still open from a verify stage (lazy-close)
4475 treat it as if it is a continued connection (apart from the counter used
4476 for the log line mark). */
4478 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4481 debug_printf("lazy-callout-close: have conn still open from verification\n");
4482 continue_transport = cutthrough.transport;
4483 continue_hostname = string_copy(cutthrough.host.name);
4484 continue_host_address = string_copy(cutthrough.host.address);
4485 continue_sequence = 1;
4486 sending_ip_address = cutthrough.snd_ip;
4487 sending_port = cutthrough.snd_port;
4488 smtp_peer_options = cutthrough.peer_options;
4491 /* If this is a run to continue delivery down an already-established
4492 channel, check that this set of addresses matches the transport and
4493 the channel. If it does not, defer the addresses. If a host list exists,
4494 we must check that the continue host is on the list. Otherwise, the
4495 host is set in the transport. */
4497 f.continue_more = FALSE; /* In case got set for the last lot */
4498 if (continue_transport)
4500 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4501 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4503 /* If the transport is about to override the host list do not check
4504 it here but take the cost of running the transport process to discover
4505 if the continued_hostname connection is suitable. This is a layering
4506 violation which is unfortunate as it requires we haul in the smtp
4511 smtp_transport_options_block * ob;
4513 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4514 && (ob = (smtp_transport_options_block *)tp->options_block)
4515 && ob->hosts_override && ob->hosts
4521 for (host_item * h = addr->host_list; h; h = h->next)
4522 if (Ustrcmp(h->name, continue_hostname) == 0)
4523 /*XXX should also check port here */
4524 { ok = TRUE; break; }
4528 /* Addresses not suitable; defer or queue for fallback hosts (which
4529 might be the continue host) and skip to next address. */
4533 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4534 Ustrcmp(continue_transport, tp->name) != 0
4535 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4536 : string_sprintf("no host matching %s", continue_hostname));
4537 if (serialize_key) enq_end(serialize_key);
4539 if (addr->fallback_hosts && !fallback)
4541 for (next = addr; ; next = next->next)
4543 next->host_list = next->fallback_hosts;
4544 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4545 if (!next->next) break;
4547 next->next = addr_fallback;
4548 addr_fallback = addr;
4553 for (next = addr; ; next = next->next)
4555 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4556 if (!next->next) break;
4558 next->next = addr_defer;
4565 /* Set a flag indicating whether there are further addresses that list
4566 the continued host. This tells the transport to leave the channel open,
4567 but not to pass it to another delivery process. We'd like to do that
4568 for non-continue_transport cases too but the knowlege of which host is
4569 connected to is too hard to manage. Perhaps we need a finer-grain
4570 interface to the transport. */
4572 for (next = addr_remote; next && !f.continue_more; next = next->next)
4573 for (host_item * h = next->host_list; h; h = h->next)
4574 if (Ustrcmp(h->name, continue_hostname) == 0)
4575 { f.continue_more = TRUE; break; }
4578 /* The transports set up the process info themselves as they may connect
4579 to more than one remote machine. They also have to set up the filter
4580 arguments, if required, so that the host name and address are available
4583 transport_filter_argv = NULL;
4585 /* Create the pipe for inter-process communication. If pipe creation
4586 fails, it is probably because the value of remote_max_parallel is so
4587 large that too many file descriptors for pipes have been created. Arrange
4588 to wait for a process to finish, and then try again. If we still can't
4589 create a pipe when all processes have finished, break the retry loop. */
4593 if (pipe(pfd) == 0) pipe_done = TRUE;
4594 else if (parcount > 0) parmax = parcount;
4597 /* We need to make the reading end of the pipe non-blocking. There are
4598 two different options for this. Exim is cunningly (I hope!) coded so
4599 that it can use either of them, though it prefers O_NONBLOCK, which
4600 distinguishes between EOF and no-more-data. */
4602 /* The data appears in a timely manner and we already did a select on
4603 all pipes, so I do not see a reason to use non-blocking IO here
4606 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4608 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4612 /* If the maximum number of subprocesses already exist, wait for a process
4613 to finish. If we ran out of file descriptors, parmax will have been reduced
4614 from its initial value of remote_max_parallel. */
4616 par_reduce(parmax - 1, fallback);
4619 /* If we failed to create a pipe and there were no processes to wait
4620 for, we have to give up on this one. Do this outside the above loop
4621 so that we can continue the main loop. */
4625 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4629 /* Find a free slot in the pardata list. Must do this after the possible
4630 waiting for processes to finish, because a terminating process will free
4633 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4634 if (parlist[poffset].pid == 0)
4637 /* If there isn't one, there has been a horrible disaster. */
4639 if (poffset >= remote_max_parallel)
4641 (void)close(pfd[pipe_write]);
4642 (void)close(pfd[pipe_read]);
4643 panicmsg = US"Unexpectedly no free subprocess slot";
4647 /* Now fork a subprocess to do the remote delivery, but before doing so,
4648 ensure that any cached resources are released so as not to interfere with
4649 what happens in the subprocess. */
4653 if ((pid = exim_fork(US"transport")) == 0)
4655 int fd = pfd[pipe_write];
4658 /* Setting this global in the subprocess means we need never clear it */
4659 transport_name = tp->name;
4661 /* There are weird circumstances in which logging is disabled */
4662 f.disable_logging = tp->disable_logging;
4664 /* Show pids on debug output if parallelism possible */
4666 if (parmax > 1 && (parcount > 0 || addr_remote))
4667 DEBUG(D_any|D_v) debug_selector |= D_pid;
4669 /* Reset the random number generator, so different processes don't all
4670 have the same sequence. In the test harness we want different, but
4671 predictable settings for each delivery process, so do something explicit
4672 here rather they rely on the fixed reset in the random number function. */
4674 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4676 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4677 a new process that may be forked to do another delivery down the same
4680 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4682 /* Close open file descriptors for the pipes of other processes
4683 that are running in parallel. */
4685 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4686 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4688 /* This process has inherited a copy of the file descriptor
4689 for the data file, but its file pointer is shared with all the
4690 other processes running in parallel. Therefore, we have to re-open
4691 the file in order to get a new file descriptor with its own
4692 file pointer. We don't need to lock it, as the lock is held by
4693 the parent process. There doesn't seem to be any way of doing
4694 a dup-with-new-file-pointer. */
4696 (void)close(deliver_datafile);
4698 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4700 if ((deliver_datafile = Uopen(fname,
4704 O_RDWR | O_APPEND, 0)) < 0)
4705 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4706 "parallel delivery: %s", fname, strerror(errno));
4709 /* Set the close-on-exec flag */
4711 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4715 /* Set the uid/gid of this process; bombs out on failure. */
4717 exim_setugid(uid, gid, use_initgroups,
4718 string_sprintf("remote delivery to %s with transport=%s",
4719 addr->address, tp->name));
4721 /* Close the unwanted half of this process' pipe, set the process state,
4722 and run the transport. Afterwards, transport_count will contain the number
4723 of bytes written. */
4725 (void)close(pfd[pipe_read]);
4726 set_process_info("delivering %s using %s", message_id, tp->name);
4727 debug_print_string(tp->debug_string);
4728 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4730 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4731 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4733 /* Ensure any cached resources that we used are now released */
4737 /* Pass the result back down the pipe. This is a lot more information
4738 than is needed for a local delivery. We have to send back the error
4739 status for each address, the usability status for each host that is
4740 flagged as unusable, and all the retry items. When TLS is in use, we
4741 send also the cipher and peerdn information. Each type of information
4742 is flagged by an identifying byte, and is then in a fixed format (with
4743 strings terminated by zeros), and there is a final terminator at the
4744 end. The host information and retry information is all attached to
4745 the first address, so that gets sent at the start. */
4747 /* Host unusability information: for most success cases this will
4750 for (h = addr->host_list; h; h = h->next)
4752 if (!h->address || h->status < hstatus_unusable) continue;
4753 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4754 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4757 /* The number of bytes written. This is the same for each address. Even
4758 if we sent several copies of the message down the same connection, the
4759 size of each one is the same, and it's that value we have got because
4760 transport_count gets reset before calling transport_write_message(). */
4762 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4763 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4765 /* Information about what happened to each address. Four item types are
4766 used: an optional 'X' item first, for TLS information, then an optional "C"
4767 item for any client-auth info followed by 'R' items for any retry settings,
4768 and finally an 'A' item for the remaining data. */
4770 for(; addr; addr = addr->next)
4774 /* The certificate verification status goes into the flags */
4775 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4777 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4779 # ifndef DISABLE_TLS_RESUME
4780 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4783 /* Use an X item only if there's something to send */
4787 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4791 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4793 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4795 else if (continue_proxy_cipher)
4797 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4799 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4805 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4809 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4814 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4818 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4820 # ifndef DISABLE_OCSP
4821 if (addr->ocsp > OCSP_NOT_REQ)
4823 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4824 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4827 #endif /*DISABLE_TLS*/
4829 if (client_authenticator)
4831 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4832 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4834 if (client_authenticated_id)
4836 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4837 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4839 if (client_authenticated_sender)
4841 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4842 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4845 #ifndef DISABLE_PRDR
4846 if (testflag(addr, af_prdr_used))
4847 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4850 if (testflag(addr, af_pipelining))
4851 #ifndef DISABLE_PIPE_CONNECT
4852 if (testflag(addr, af_early_pipe))
4853 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4856 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4858 if (testflag(addr, af_chunking_used))
4859 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4861 if (testflag(addr, af_tcp_fastopen_conn))
4862 rmt_dlv_checked_write(fd, 'T',
4863 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4867 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4868 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4870 /* Retry information: for most success cases this will be null. */
4872 for (retry_item * r = addr->retries; r; r = r->next)
4874 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4875 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4876 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4877 ptr += sizeof(r->basic_errno);
4878 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4879 ptr += sizeof(r->more_errno);
4880 if (!r->message) *ptr++ = 0; else
4882 sprintf(CS ptr, "%.512s", r->message);
4885 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4888 #ifdef SUPPORT_SOCKS
4889 if (LOGGING(proxy) && proxy_session)
4892 if (proxy_local_address)
4894 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4895 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4896 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4897 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4898 ptr += sizeof(proxy_local_port);
4902 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4906 #ifdef EXPERIMENTAL_DSN_INFO
4907 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4908 if (addr->smtp_greeting)
4910 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4911 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4912 if (addr->helo_response)
4914 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4915 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4919 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4923 /* The rest of the information goes in an 'A0' item. */
4925 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4926 ptr = big_buffer + 2;
4927 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4928 ptr += sizeof(addr->basic_errno);
4929 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4930 ptr += sizeof(addr->more_errno);
4931 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4932 ptr += sizeof(addr->delivery_time);
4933 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4934 ptr += sizeof(addr->flags);
4936 if (!addr->message) *ptr++ = 0; else
4937 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4939 if (!addr->user_message) *ptr++ = 0; else
4940 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4942 if (!addr->host_used) *ptr++ = 0; else
4944 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4945 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4946 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4947 ptr += sizeof(addr->host_used->port);
4949 /* DNS lookup status */
4950 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4951 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4954 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4957 /* Local interface address/port */
4958 #ifdef EXPERIMENTAL_DSN_INFO
4959 if (sending_ip_address)
4961 if (LOGGING(incoming_interface) && sending_ip_address)
4965 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4966 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4967 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4970 /* Add termination flag, close the pipe, and that's it. The character
4971 after 'Z' indicates whether continue_transport is now NULL or not.
4972 A change from non-NULL to NULL indicates a problem with a continuing
4975 big_buffer[0] = continue_transport ? '1' : '0';
4976 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4981 /* Back in the mainline: close the unwanted half of the pipe. */
4983 (void)close(pfd[pipe_write]);
4985 /* If we have a connection still open from a verify stage (lazy-close)
4986 release its TLS library context (if any) as responsibility was passed to
4987 the delivery child process. */
4989 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4992 if (cutthrough.is_tls)
4993 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
4995 (void) close(cutthrough.cctx.sock);
4996 release_cutthrough_connection(US"passed to transport proc");
4999 /* Fork failed; defer with error message */
5003 (void)close(pfd[pipe_read]);
5004 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5005 addr->domain, strerror(errno));
5009 /* Fork succeeded; increment the count, and remember relevant data for
5010 when the process finishes. */
5013 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5014 parlist[poffset].pid = pid;
5015 parlist[poffset].fd = pfd[pipe_read];
5016 parlist[poffset].done = FALSE;
5017 parlist[poffset].msg = NULL;
5018 parlist[poffset].return_path = return_path;
5020 /* If the process we've just started is sending a message down an existing
5021 channel, wait for it now. This ensures that only one such process runs at
5022 once, whatever the value of remote_max parallel. Otherwise, we might try to
5023 send two or more messages simultaneously down the same channel. This could
5024 happen if there are different domains that include the same host in otherwise
5025 different host lists.
5027 Also, if the transport closes down the channel, this information gets back
5028 (continue_transport gets set to NULL) before we consider any other addresses
5031 if (continue_transport) par_reduce(0, fallback);
5033 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5034 newly created process get going before we create another process. This should
5035 ensure repeatability in the tests. Wait long enough for most cases to complete
5038 else testharness_pause_ms(600);
5043 if (serialize_key) enq_end(serialize_key);
5045 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5049 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5050 are still running and post-process their addresses. */
5052 par_reduce(0, fallback);
5059 /*************************************************
5060 * Split an address into local part and domain *
5061 *************************************************/
5063 /* This function initializes an address for routing by splitting it up into a
5064 local part and a domain. The local part is set up twice - once in its original
5065 casing, and once in lower case, and it is dequoted. We also do the "percent
5066 hack" for configured domains. This may lead to a DEFER result if a lookup
5067 defers. When a percent-hacking takes place, we insert a copy of the original
5068 address as a new parent of this address, as if we have had a redirection.
5071 addr points to an addr_item block containing the address
5074 DEFER - could not determine if domain is %-hackable
5078 deliver_split_address(address_item * addr)
5080 uschar * address = addr->address;
5085 if (!(domain = Ustrrchr(address, '@')))
5086 return DEFER; /* should always have a domain, but just in case... */
5088 len = domain - address;
5089 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5091 /* The implication in the RFCs (though I can't say I've seen it spelled out
5092 explicitly) is that quoting should be removed from local parts at the point
5093 where they are locally interpreted. [The new draft "821" is more explicit on
5094 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5095 removing quoting backslashes and any unquoted doublequotes. */
5097 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5101 if (c == '\"') continue;
5111 /* We do the percent hack only for those domains that are listed in
5112 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5114 if (percent_hack_domains)
5117 uschar *new_address = NULL;
5118 uschar *local_part = addr->cc_local_part;
5120 deliver_domain = addr->domain; /* set $domain */
5122 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5123 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5125 && (t = Ustrrchr(local_part, '%')) != NULL
5128 new_address = string_copy(local_part);
5129 new_address[t - local_part] = '@';
5130 deliver_domain = string_copylc(t+1);
5131 local_part = string_copyn(local_part, t - local_part);
5134 if (rc == DEFER) return DEFER; /* lookup deferred */
5136 /* If hackery happened, set up new parent and alter the current address. */
5140 address_item *new_parent = store_get(sizeof(address_item), FALSE);
5141 *new_parent = *addr;
5142 addr->parent = new_parent;
5143 new_parent->child_count = 1;
5144 addr->address = new_address;
5145 addr->unique = string_copy(new_address);
5146 addr->domain = deliver_domain;
5147 addr->cc_local_part = local_part;
5148 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5153 /* Create the lowercased version of the final local part, and make that the
5154 default one to be used. */
5156 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5163 /*************************************************
5164 * Get next error message text *
5165 *************************************************/
5167 /* If f is not NULL, read the next "paragraph", from a customized error message
5168 text file, terminated by a line containing ****, and expand it.
5171 f NULL or a file to read from
5172 which string indicating which string (for errors)
5174 Returns: NULL or an expanded string
5178 next_emf(FILE *f, uschar *which)
5184 if (!f) return NULL;
5186 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5189 para = string_get(256);
5192 para = string_cat(para, buffer);
5193 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5196 if ((yield = expand_string(string_from_gstring(para))))
5199 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5200 "bounce_message_file or warn_message_file (%s): %s", which,
5201 expand_string_message);
5208 /*************************************************
5209 * Close down a passed transport channel *
5210 *************************************************/
5212 /* This function is called when a passed transport channel cannot be used.
5213 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5214 so that the function call can be the argument of a "return" statement.
5217 Returns: DELIVER_NOT_ATTEMPTED
5221 continue_closedown(void)
5223 if (continue_transport)
5224 for (transport_instance * t = transports; t; t = t->next)
5225 if (Ustrcmp(t->name, continue_transport) == 0)
5227 if (t->info->closedown) (t->info->closedown)(t);
5230 return DELIVER_NOT_ATTEMPTED;
5236 /*************************************************
5237 * Print address information *
5238 *************************************************/
5240 /* This function is called to output an address, or information about an
5241 address, for bounce or defer messages. If the hide_child flag is set, all we
5242 output is the original ancestor address.
5245 addr points to the address
5246 f the FILE to print to
5247 si an initial string
5248 sc a continuation string for before "generated"
5251 Returns: TRUE if the address is not hidden
5255 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5259 uschar *printed = US"";
5260 address_item *ancestor = addr;
5261 while (ancestor->parent) ancestor = ancestor->parent;
5263 fprintf(f, "%s", CS si);
5265 if (addr->parent && testflag(addr, af_hide_child))
5267 printed = US"an undisclosed address";
5270 else if (!testflag(addr, af_pfr) || !addr->parent)
5271 printed = addr->address;
5275 uschar *s = addr->address;
5278 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5279 else if (addr->address[0] == '|') ss = US"pipe";
5282 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5283 printed = addr->parent->address;
5286 fprintf(f, "%s", CS string_printing(printed));
5288 if (ancestor != addr)
5290 uschar *original = ancestor->onetime_parent;
5291 if (!original) original= ancestor->address;
5292 if (strcmpic(original, printed) != 0)
5293 fprintf(f, "%s(%sgenerated from %s)", sc,
5294 ancestor != addr->parent ? "ultimately " : "",
5295 string_printing(original));
5298 if (addr->host_used)
5299 fprintf(f, "\n host %s [%s]",
5300 addr->host_used->name, addr->host_used->address);
5302 fprintf(f, "%s", CS se);
5310 /*************************************************
5311 * Print error for an address *
5312 *************************************************/
5314 /* This function is called to print the error information out of an address for
5315 a bounce or a warning message. It tries to format the message reasonably by
5316 introducing newlines. All lines are indented by 4; the initial printing
5317 position must be set before calling.
5319 This function used always to print the error. Nowadays we want to restrict it
5320 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5321 and filter "fail". We no longer pass other information willy-nilly in bounce
5322 and warning messages. Text in user_message is always output; text in message
5323 only if the af_pass_message flag is set.
5327 f the FILE to print on
5334 print_address_error(address_item *addr, FILE *f, uschar *t)
5336 int count = Ustrlen(t);
5337 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5339 if (!s && !(s = addr->user_message))
5342 fprintf(f, "\n %s", t);
5345 if (*s == '\\' && s[1] == 'n')
5355 if (*s++ == ':' && isspace(*s) && count > 45)
5357 fprintf(f, "\n "); /* sic (because space follows) */
5364 /***********************************************************
5365 * Print Diagnostic-Code for an address *
5366 ************************************************************/
5368 /* This function is called to print the error information out of an address for
5369 a bounce or a warning message. It tries to format the message reasonably as
5370 required by RFC 3461 by adding a space after each newline
5372 it uses the same logic as print_address_error() above. if af_pass_message is true
5373 and addr->message is set it uses the remote host answer. if not addr->user_message
5374 is used instead if available.
5378 f the FILE to print on
5384 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5386 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5389 /* af_pass_message and addr->message set ? print remote host answer */
5393 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5395 /* search first ": ". we assume to find the remote-MTA answer there */
5396 if (!(s = Ustrstr(addr->message, ": ")))
5397 return; /* not found, bail out */
5398 s += 2; /* skip ": " */
5399 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5401 /* no message available. do nothing */
5406 if (cnt > 950) /* RFC line length limit: 998 */
5408 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5409 fputs("[truncated]", f);
5413 if (*s == '\\' && s[1] == 'n')
5415 fputs("\n ", f); /* as defined in RFC 3461 */
5430 /*************************************************
5431 * Check list of addresses for duplication *
5432 *************************************************/
5434 /* This function was introduced when the test for duplicate addresses that are
5435 not pipes, files, or autoreplies was moved from the middle of routing to when
5436 routing was complete. That was to fix obscure cases when the routing history
5437 affects the subsequent routing of identical addresses. This function is called
5438 after routing, to check that the final routed addresses are not duplicates.
5440 If we detect a duplicate, we remember what it is a duplicate of. Note that
5441 pipe, file, and autoreply de-duplication is handled during routing, so we must
5442 leave such "addresses" alone here, as otherwise they will incorrectly be
5445 Argument: address of list anchor
5450 do_duplicate_check(address_item **anchor)
5453 while ((addr = *anchor))
5456 if (testflag(addr, af_pfr))
5458 anchor = &(addr->next);
5460 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5462 DEBUG(D_deliver|D_route)
5463 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5464 *anchor = addr->next;
5465 addr->dupof = tnode->data.ptr;
5466 addr->next = addr_duplicate;
5467 addr_duplicate = addr;
5471 tree_add_duplicate(addr->unique, addr);
5472 anchor = &(addr->next);
5480 /************************************************/
5483 print_dsn_addr_action(FILE * f, address_item * addr,
5484 uschar * action, uschar * status)
5488 if (addr->dsn_orcpt)
5489 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5491 for (pa = addr; pa->parent; ) pa = pa->parent;
5492 fprintf(f, "Action: %s\n"
5493 "Final-Recipient: rfc822;%s\n"
5495 action, pa->address, status);
5500 /* When running in the test harness, there's an option that allows us to
5501 fudge this time so as to get repeatability of the tests. Take the first
5502 time off the list. In queue runs, the list pointer gets updated in the
5506 test_harness_fudged_queue_time(int actual_time)
5509 if ( f.running_in_test_harness && *fudged_queue_times
5510 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5512 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5513 fudged_queue_times);
5519 /************************************************/
5522 expand_open(const uschar * filename,
5523 const uschar * varname, const uschar * reason)
5525 const uschar * s = expand_cstring(filename);
5529 log_write(0, LOG_MAIN|LOG_PANIC,
5530 "Failed to expand %s: '%s'\n", varname, filename);
5531 else if (*s != '/' || is_tainted(s))
5532 log_write(0, LOG_MAIN|LOG_PANIC,
5533 "%s is not %s after expansion: '%s'\n",
5534 varname, *s == '/' ? "untainted" : "absolute", s);
5535 else if (!(fp = Ufopen(s, "rb")))
5536 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5537 "message texts: %s", s, reason, strerror(errno));
5541 /*************************************************
5542 * Deliver one message *
5543 *************************************************/
5545 /* This is the function which is called when a message is to be delivered. It
5546 is passed the id of the message. It is possible that the message no longer
5547 exists, if some other process has delivered it, and it is also possible that
5548 the message is being worked on by another process, in which case the data file
5551 If no delivery is attempted for any of the above reasons, the function returns
5552 DELIVER_NOT_ATTEMPTED.
5554 If the give_up flag is set true, do not attempt any deliveries, but instead
5555 fail all outstanding addresses and return the message to the sender (or
5558 A delivery operation has a process all to itself; we never deliver more than
5559 one message in the same process. Therefore we needn't worry too much about
5562 Liable to be called as root.
5565 id the id of the message to be delivered
5566 forced TRUE if delivery was forced by an administrator; this overrides
5567 retry delays and causes a delivery to be tried regardless
5568 give_up TRUE if an administrator has requested that delivery attempts
5571 Returns: When the global variable mua_wrapper is FALSE:
5572 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5573 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5574 When the global variable mua_wrapper is TRUE:
5575 DELIVER_MUA_SUCCEEDED if delivery succeeded
5576 DELIVER_MUA_FAILED if delivery failed
5577 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5581 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5584 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5585 time_t now = time(NULL);
5586 address_item *addr_last = NULL;
5587 uschar *filter_message = NULL;
5588 int process_recipients = RECIP_ACCEPT;
5591 extern int acl_where;
5594 #ifdef MEASURE_TIMING
5595 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
5598 info = queue_run_pid == (pid_t)0
5599 ? string_sprintf("delivering %s", id)
5600 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5602 /* If the D_process_info bit is on, set_process_info() will output debugging
5603 information. If not, we want to show this initial information if D_deliver or
5604 D_queue_run is set or in verbose mode. */
5606 set_process_info("%s", info);
5608 if ( !(debug_selector & D_process_info)
5609 && (debug_selector & (D_deliver|D_queue_run|D_v))
5611 debug_printf("%s\n", info);
5613 /* Ensure that we catch any subprocesses that are created. Although Exim
5614 sets SIG_DFL as its initial default, some routes through the code end up
5615 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5616 has been forked, but no re-exec has been done. We use sigaction rather than
5617 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5618 sure it is turned off. (There was a problem on AIX with this.) */
5622 struct sigaction act;
5623 act.sa_handler = SIG_DFL;
5624 sigemptyset(&(act.sa_mask));
5626 sigaction(SIGCHLD, &act, NULL);
5629 signal(SIGCHLD, SIG_DFL);
5632 /* Make the forcing flag available for routers and transports, set up the
5633 global message id field, and initialize the count for returned files and the
5634 message size. This use of strcpy() is OK because the length id is checked when
5635 it is obtained from a command line (the -M or -q options), and otherwise it is
5636 known to be a valid message id. */
5638 if (id != message_id)
5639 Ustrcpy(message_id, id);
5640 f.deliver_force = forced;
5644 /* Initialize some flags */
5646 update_spool = FALSE;
5647 remove_journal = TRUE;
5649 /* Set a known context for any ACLs we call via expansions */
5650 acl_where = ACL_WHERE_DELIVERY;
5652 /* Reset the random number generator, so that if several delivery processes are
5653 started from a queue runner that has already used random numbers (for sorting),
5654 they don't all get the same sequence. */
5658 /* Open and lock the message's data file. Exim locks on this one because the
5659 header file may get replaced as it is re-written during the delivery process.
5660 Any failures cause messages to be written to the log, except for missing files
5661 while queue running - another process probably completed delivery. As part of
5662 opening the data file, message_subdir gets set. */
5664 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5665 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5667 /* The value of message_size at this point has been set to the data length,
5668 plus one for the blank line that notionally precedes the data. */
5670 /* Now read the contents of the header file, which will set up the headers in
5671 store, and also the list of recipients and the tree of non-recipients and
5672 assorted flags. It updates message_size. If there is a reading or format error,
5673 give up; if the message has been around for sufficiently long, remove it. */
5676 uschar * spoolname = string_sprintf("%s-H", id);
5677 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5679 if (errno == ERRNO_SPOOLFORMAT)
5681 struct stat statbuf;
5682 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5684 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5685 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5687 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5690 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5693 /* If we managed to read the envelope data, received_time contains the
5694 time the message was received. Otherwise, we can calculate it from the
5697 if (rc != spool_read_hdrerror)
5699 received_time.tv_sec = received_time.tv_usec = 0;
5700 /*XXX subsec precision?*/
5701 for (i = 0; i < 6; i++)
5702 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5705 /* If we've had this malformed message too long, sling it. */
5707 if (now - received_time.tv_sec > keep_malformed)
5709 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5710 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5711 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5712 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5713 log_write(0, LOG_MAIN, "Message removed because older than %s",
5714 readconf_printtime(keep_malformed));
5717 (void)close(deliver_datafile);
5718 deliver_datafile = -1;
5719 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5723 /* The spool header file has been read. Look to see if there is an existing
5724 journal file for this message. If there is, it means that a previous delivery
5725 attempt crashed (program or host) before it could update the spool header file.
5726 Read the list of delivered addresses from the journal and add them to the
5727 nonrecipients tree. Then update the spool file. We can leave the journal in
5728 existence, as it will get further successful deliveries added to it in this
5729 run, and it will be deleted if this function gets to its end successfully.
5730 Otherwise it might be needed again. */
5733 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5736 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5744 && lseek(journal_fd, 0, SEEK_SET) == 0
5745 && (jread = fdopen(journal_fd, "rb"))
5748 while (Ufgets(big_buffer, big_buffer_size, jread))
5750 int n = Ustrlen(big_buffer);
5751 big_buffer[n-1] = 0;
5752 tree_add_nonrecipient(big_buffer);
5753 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5754 "journal file\n", big_buffer);
5757 if ((journal_fd = dup(fileno(jread))) < 0)
5758 journal_fd = fileno(jread);
5760 (void) fclose(jread); /* Try to not leak the FILE resource */
5762 /* Panic-dies on error */
5763 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5765 else if (errno != ENOENT)
5767 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5768 "%s", strerror(errno));
5769 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5772 /* A null recipients list indicates some kind of disaster. */
5774 if (!recipients_list)
5776 (void)close(deliver_datafile);
5777 deliver_datafile = -1;
5778 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5779 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5784 /* Handle a message that is frozen. There are a number of different things that
5785 can happen, but in the default situation, unless forced, no delivery is
5788 if (f.deliver_freeze)
5790 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5791 /* Moving to another directory removes the message from Exim's view. Other
5792 tools must be used to deal with it. Logging of this action happens in
5793 spool_move_message() and its subfunctions. */
5795 if ( move_frozen_messages
5796 && spool_move_message(id, message_subdir, US"", US"F")
5798 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5801 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5802 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5803 flag causing all recipients to be failed. The time is the age of the
5804 message, not the time since freezing. */
5806 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5808 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5809 process_recipients = RECIP_FAIL_TIMEOUT;
5812 /* For bounce messages (and others with no sender), thaw if the error message
5813 ignore timer is exceeded. The message will be discarded if this delivery
5816 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5817 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5819 /* If this is a bounce message, or there's no auto thaw, or we haven't
5820 reached the auto thaw time yet, and this delivery is not forced by an admin
5821 user, do not attempt delivery of this message. Note that forced is set for
5822 continuing messages down the same channel, in order to skip load checking and
5823 ignore hold domains, but we don't want unfreezing in that case. */
5827 if ( ( sender_address[0] == 0
5829 || now <= deliver_frozen_at + auto_thaw
5831 && ( !forced || !f.deliver_force_thaw
5832 || !f.admin_user || continue_hostname
5835 (void)close(deliver_datafile);
5836 deliver_datafile = -1;
5837 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5838 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5841 /* If delivery was forced (by an admin user), assume a manual thaw.
5842 Otherwise it's an auto thaw. */
5846 f.deliver_manual_thaw = TRUE;
5847 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5849 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5852 /* We get here if any of the rules for unfreezing have triggered. */
5854 f.deliver_freeze = FALSE;
5855 update_spool = TRUE;
5859 /* Open the message log file if we are using them. This records details of
5860 deliveries, deferments, and failures for the benefit of the mail administrator.
5861 The log is not used by exim itself to track the progress of a message; that is
5862 done by rewriting the header spool file. */
5866 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5870 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5872 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5873 fname, strerror(errno));
5874 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5877 /* Make a C stream out of it. */
5879 if (!(message_log = fdopen(fd, "a")))
5881 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5882 fname, strerror(errno));
5883 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5888 /* If asked to give up on a message, log who did it, and set the action for all
5893 struct passwd *pw = getpwuid(real_uid);
5894 log_write(0, LOG_MAIN, "cancelled by %s",
5895 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5896 process_recipients = RECIP_FAIL;
5899 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5901 else if (received_count > received_headers_max)
5902 process_recipients = RECIP_FAIL_LOOP;
5904 /* Otherwise, if a system-wide, address-independent message filter is
5905 specified, run it now, except in the case when we are failing all recipients as
5906 a result of timeout_frozen_after. If the system filter yields "delivered", then
5907 ignore the true recipients of the message. Failure of the filter file is
5908 logged, and the delivery attempt fails. */
5910 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5915 redirect_block redirect;
5917 if (system_filter_uid_set)
5919 ugid.uid = system_filter_uid;
5920 ugid.gid = system_filter_gid;
5921 ugid.uid_set = ugid.gid_set = TRUE;
5924 ugid.uid_set = ugid.gid_set = FALSE;
5926 return_path = sender_address;
5927 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5928 f.system_filtering = TRUE;
5930 /* Any error in the filter file causes a delivery to be abandoned. */
5932 redirect.string = system_filter;
5933 redirect.isfile = TRUE;
5934 redirect.check_owner = redirect.check_group = FALSE;
5935 redirect.owners = NULL;
5936 redirect.owngroups = NULL;
5938 redirect.modemask = 0;
5940 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5943 &redirect, /* Where the data is */
5944 RDO_DEFER | /* Turn on all the enabling options */
5945 RDO_FAIL | /* Leave off all the disabling options */
5950 NULL, /* No :include: restriction (not used in filter) */
5951 NULL, /* No sieve vacation directory (not sieve!) */
5952 NULL, /* No sieve enotify mailto owner (not sieve!) */
5953 NULL, /* No sieve user address (not sieve!) */
5954 NULL, /* No sieve subaddress (not sieve!) */
5955 &ugid, /* uid/gid data */
5956 &addr_new, /* Where to hang generated addresses */
5957 &filter_message, /* Where to put error message */
5958 NULL, /* Don't skip syntax errors */
5959 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5960 US"system filter"); /* For error messages */
5962 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5964 if (rc == FF_ERROR || rc == FF_NONEXIST)
5966 (void)close(deliver_datafile);
5967 deliver_datafile = -1;
5968 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5969 string_printing(filter_message));
5970 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5973 /* Reset things. If the filter message is an empty string, which can happen
5974 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5976 f.system_filtering = FALSE;
5977 f.enable_dollar_recipients = FALSE;
5978 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5980 /* Save the values of the system filter variables so that user filters
5983 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5985 /* The filter can request that delivery of the original addresses be
5990 process_recipients = RECIP_DEFER;
5991 deliver_msglog("Delivery deferred by system filter\n");
5992 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5995 /* The filter can request that a message be frozen, but this does not
5996 take place if the message has been manually thawed. In that case, we must
5997 unset "delivered", which is forced by the "freeze" command to make -bF
6000 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6002 f.deliver_freeze = TRUE;
6003 deliver_frozen_at = time(NULL);
6004 process_recipients = RECIP_DEFER;
6005 frozen_info = string_sprintf(" by the system filter%s%s",
6006 filter_message ? US": " : US"",
6007 filter_message ? filter_message : US"");
6010 /* The filter can request that a message be failed. The error message may be
6011 quite long - it is sent back to the sender in the bounce - but we don't want
6012 to fill up the log with repetitions of it. If it starts with << then the text
6013 between << and >> is written to the log, with the rest left for the bounce
6016 else if (rc == FF_FAIL)
6018 uschar *colon = US"";
6019 uschar *logmsg = US"";
6022 process_recipients = RECIP_FAIL_FILTER;
6028 if ( filter_message[0] == '<'
6029 && filter_message[1] == '<'
6030 && (logend = Ustrstr(filter_message, ">>"))
6033 logmsg = filter_message + 2;
6034 loglen = logend - logmsg;
6035 filter_message = logend + 2;
6036 if (filter_message[0] == 0) filter_message = NULL;
6040 logmsg = filter_message;
6041 loglen = Ustrlen(filter_message);
6045 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6049 /* Delivery can be restricted only to those recipients (if any) that the
6050 filter specified. */
6052 else if (rc == FF_DELIVERED)
6054 process_recipients = RECIP_IGNORE;
6056 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6058 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6061 /* If any new addresses were created by the filter, fake up a "parent"
6062 for them. This is necessary for pipes, etc., which are expected to have
6063 parents, and it also gives some sensible logging for others. Allow
6064 pipes, files, and autoreplies, and run them as the filter uid if set,
6065 otherwise as the current uid. */
6069 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6070 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6072 /* The text "system-filter" is tested in transport_set_up_command() and in
6073 set_up_shell_command() in the pipe transport, to enable them to permit
6074 $recipients, so don't change it here without also changing it there. */
6076 address_item *p = addr_new;
6077 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6079 parent->domain = string_copylc(qualify_domain_recipient);
6080 parent->local_part = US"system-filter";
6082 /* As part of this loop, we arrange for addr_last to end up pointing
6083 at the final address. This is used if we go on to add addresses for the
6084 original recipients. */
6088 if (parent->child_count == USHRT_MAX)
6089 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6090 "than %d delivery addresses", USHRT_MAX);
6091 parent->child_count++;
6094 if (testflag(p, af_pfr))
6100 setflag(p, af_uid_set);
6101 setflag(p, af_gid_set);
6102 setflag(p, af_allow_file);
6103 setflag(p, af_allow_pipe);
6104 setflag(p, af_allow_reply);
6106 /* Find the name of the system filter's appropriate pfr transport */
6108 if (p->address[0] == '|')
6111 tpname = system_filter_pipe_transport;
6112 address_pipe = p->address;
6114 else if (p->address[0] == '>')
6117 tpname = system_filter_reply_transport;
6121 if (p->address[Ustrlen(p->address)-1] == '/')
6123 type = US"directory";
6124 tpname = system_filter_directory_transport;
6129 tpname = system_filter_file_transport;
6131 address_file = p->address;
6134 /* Now find the actual transport, first expanding the name. We have
6135 set address_file or address_pipe above. */
6139 uschar *tmp = expand_string(tpname);
6140 address_file = address_pipe = NULL;
6142 p->message = string_sprintf("failed to expand \"%s\" as a "
6143 "system filter transport name", tpname);
6144 if (is_tainted(tmp))
6145 p->message = string_sprintf("attempt to used tainted value '%s' for"
6146 "transport '%s' as a system filter", tmp, tpname);
6150 p->message = string_sprintf("system_filter_%s_transport is unset",
6155 transport_instance *tp;
6156 for (tp = transports; tp; tp = tp->next)
6157 if (Ustrcmp(tp->name, tpname) == 0)
6163 p->message = string_sprintf("failed to find \"%s\" transport "
6164 "for system filter delivery", tpname);
6167 /* If we couldn't set up a transport, defer the delivery, putting the
6168 error on the panic log as well as the main log. */
6172 address_item *badp = p;
6174 if (!addr_last) addr_new = p; else addr_last->next = p;
6175 badp->local_part = badp->address; /* Needed for log line */
6176 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6179 } /* End of pfr handling */
6181 /* Either a non-pfr delivery, or we found a transport */
6183 DEBUG(D_deliver|D_filter)
6184 debug_printf("system filter added %s\n", p->address);
6188 } /* Loop through all addr_new addresses */
6193 /* Scan the recipients list, and for every one that is not in the non-
6194 recipients tree, add an addr item to the chain of new addresses. If the pno
6195 value is non-negative, we must set the onetime parent from it. This which
6196 points to the relevant entry in the recipients list.
6198 This processing can be altered by the setting of the process_recipients
6199 variable, which is changed if recipients are to be ignored, failed, or
6200 deferred. This can happen as a result of system filter activity, or if the -Mg
6201 option is used to fail all of them.
6203 Duplicate addresses are handled later by a different tree structure; we can't
6204 just extend the non-recipients tree, because that will be re-written to the
6205 spool if the message is deferred, and in any case there are casing
6206 complications for local addresses. */
6208 if (process_recipients != RECIP_IGNORE)
6209 for (i = 0; i < recipients_count; i++)
6210 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6212 recipient_item *r = recipients_list + i;
6213 address_item *new = deliver_make_addr(r->address, FALSE);
6214 new->prop.errors_address = r->errors_to;
6216 if ((new->prop.utf8_msg = message_smtputf8))
6218 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6219 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6220 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6221 new->prop.utf8_downcvt ? "yes"
6222 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6228 new->onetime_parent = recipients_list[r->pno].address;
6230 /* If DSN support is enabled, set the dsn flags and the original receipt
6231 to be passed on to other DSN enabled MTAs */
6233 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6234 new->dsn_orcpt = r->orcpt;
6235 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6236 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6238 switch (process_recipients)
6240 /* RECIP_DEFER is set when a system filter freezes a message. */
6243 new->next = addr_defer;
6248 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6251 case RECIP_FAIL_FILTER:
6253 filter_message ? filter_message : US"delivery cancelled";
6254 setflag(new, af_pass_message);
6255 goto RECIP_QUEUE_FAILED; /* below */
6258 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6259 than the value in timeout_frozen_after. Treat non-bounce messages
6260 similarly to -Mg; for bounce messages we just want to discard, so
6261 don't put the address on the failed list. The timeout has already
6264 case RECIP_FAIL_TIMEOUT:
6265 new->message = US"delivery cancelled; message timed out";
6266 goto RECIP_QUEUE_FAILED; /* below */
6269 /* RECIP_FAIL is set when -Mg has been used. */
6272 new->message = US"delivery cancelled by administrator";
6275 /* Common code for the failure cases above. If this is not a bounce
6276 message, put the address on the failed list so that it is used to
6277 create a bounce. Otherwise do nothing - this just discards the address.
6278 The incident has already been logged. */
6281 if (sender_address[0])
6283 new->next = addr_failed;
6289 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6290 in the message. Process each address as a routing failure; if this
6291 is a bounce message, it will get frozen. */
6293 case RECIP_FAIL_LOOP:
6294 new->message = US"Too many \"Received\" headers - suspected mail loop";
6295 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6299 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6302 if (!addr_new) addr_new = new; else addr_last->next = new;
6307 #ifndef DISABLE_EVENT
6308 if (process_recipients != RECIP_ACCEPT && event_action)
6310 uschar * save_local = deliver_localpart;
6311 const uschar * save_domain = deliver_domain;
6312 uschar * addr = new->address, * errmsg = NULL;
6313 int start, end, dom;
6315 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6316 log_write(0, LOG_MAIN|LOG_PANIC,
6317 "failed to parse address '%.100s': %s\n", addr, errmsg);
6321 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6322 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6324 event_raise(event_action, US"msg:fail:internal", new->message);
6326 deliver_localpart = save_local;
6327 deliver_domain = save_domain;
6335 debug_printf("Delivery address list:\n");
6336 for (address_item * p = addr_new; p; p = p->next)
6337 debug_printf(" %s %s\n", p->address,
6338 p->onetime_parent ? p->onetime_parent : US"");
6341 /* Set up the buffers used for copying over the file when delivering. */
6343 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6344 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6348 /* Until there are no more new addresses, handle each one as follows:
6350 . If this is a generated address (indicated by the presence of a parent
6351 pointer) then check to see whether it is a pipe, file, or autoreply, and
6352 if so, handle it directly here. The router that produced the address will
6353 have set the allow flags into the address, and also set the uid/gid required.
6354 Having the routers generate new addresses and then checking them here at
6355 the outer level is tidier than making each router do the checking, and
6356 means that routers don't need access to the failed address queue.
6358 . Break up the address into local part and domain, and make lowercased
6359 versions of these strings. We also make unquoted versions of the local part.
6361 . Handle the percent hack for those domains for which it is valid.
6363 . For child addresses, determine if any of the parents have the same address.
6364 If so, generate a different string for previous delivery checking. Without
6365 this code, if the address spqr generates spqr via a forward or alias file,
6366 delivery of the generated spqr stops further attempts at the top level spqr,
6367 which is not what is wanted - it may have generated other addresses.
6369 . Check on the retry database to see if routing was previously deferred, but
6370 only if in a queue run. Addresses that are to be routed are put on the
6371 addr_route chain. Addresses that are to be deferred are put on the
6372 addr_defer chain. We do all the checking first, so as not to keep the
6373 retry database open any longer than necessary.
6375 . Now we run the addresses through the routers. A router may put the address
6376 on either the addr_local or the addr_remote chain for local or remote
6377 delivery, respectively, or put it on the addr_failed chain if it is
6378 undeliveable, or it may generate child addresses and put them on the
6379 addr_new chain, or it may defer an address. All the chain anchors are
6380 passed as arguments so that the routers can be called for verification
6383 . If new addresses have been generated by the routers, da capo.
6386 f.header_rewritten = FALSE; /* No headers rewritten yet */
6387 while (addr_new) /* Loop until all addresses dealt with */
6389 address_item *addr, *parent;
6391 /* Failure to open the retry database is treated the same as if it does
6392 not exist. In both cases, dbm_file is NULL. */
6394 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6395 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6396 debug_printf("no retry data available\n");
6398 /* Scan the current batch of new addresses, to handle pipes, files and
6399 autoreplies, and determine which others are ready for routing. */
6406 dbdata_retry *domain_retry_record;
6407 dbdata_retry *address_retry_record;
6410 addr_new = addr->next;
6412 DEBUG(D_deliver|D_retry|D_route)
6414 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6415 debug_printf("Considering: %s\n", addr->address);
6418 /* Handle generated address that is a pipe or a file or an autoreply. */
6420 if (testflag(addr, af_pfr))
6422 /* If an autoreply in a filter could not generate a syntactically valid
6423 address, give up forthwith. Set af_ignore_error so that we don't try to
6424 generate a bounce. */
6426 if (testflag(addr, af_bad_reply))
6428 addr->basic_errno = ERRNO_BADADDRESS2;
6429 addr->local_part = addr->address;
6431 US"filter autoreply generated syntactically invalid recipient";
6432 addr->prop.ignore_error = TRUE;
6433 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6434 continue; /* with the next new address */
6437 /* If two different users specify delivery to the same pipe or file or
6438 autoreply, there should be two different deliveries, so build a unique
6439 string that incorporates the original address, and use this for
6440 duplicate testing and recording delivery, and also for retrying. */
6443 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6444 (testflag(addr->parent, af_homonym)? 3:0));
6446 addr->address_retry_key = addr->domain_retry_key =
6447 string_sprintf("T:%s", addr->unique);
6449 /* If a filter file specifies two deliveries to the same pipe or file,
6450 we want to de-duplicate, but this is probably not wanted for two mail
6451 commands to the same address, where probably both should be delivered.
6452 So, we have to invent a different unique string in that case. Just
6453 keep piling '>' characters on the front. */
6455 if (addr->address[0] == '>')
6456 while (tree_search(tree_duplicates, addr->unique))
6457 addr->unique = string_sprintf(">%s", addr->unique);
6459 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6461 DEBUG(D_deliver|D_route)
6462 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6463 addr->dupof = tnode->data.ptr;
6464 addr->next = addr_duplicate;
6465 addr_duplicate = addr;
6469 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6471 /* Check for previous delivery */
6473 if (tree_search(tree_nonrecipients, addr->unique))
6475 DEBUG(D_deliver|D_route)
6476 debug_printf("%s was previously delivered: discarded\n", addr->address);
6477 child_done(addr, tod_stamp(tod_log));
6481 /* Save for checking future duplicates */
6483 tree_add_duplicate(addr->unique, addr);
6485 /* Set local part and domain */
6487 addr->local_part = addr->address;
6488 addr->domain = addr->parent->domain;
6490 /* Ensure that the delivery is permitted. */
6492 if (testflag(addr, af_file))
6494 if (!testflag(addr, af_allow_file))
6496 addr->basic_errno = ERRNO_FORBIDFILE;
6497 addr->message = US"delivery to file forbidden";
6498 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6499 continue; /* with the next new address */
6502 else if (addr->address[0] == '|')
6504 if (!testflag(addr, af_allow_pipe))
6506 addr->basic_errno = ERRNO_FORBIDPIPE;
6507 addr->message = US"delivery to pipe forbidden";
6508 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6509 continue; /* with the next new address */
6512 else if (!testflag(addr, af_allow_reply))
6514 addr->basic_errno = ERRNO_FORBIDREPLY;
6515 addr->message = US"autoreply forbidden";
6516 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6517 continue; /* with the next new address */
6520 /* If the errno field is already set to BADTRANSPORT, it indicates
6521 failure to expand a transport string, or find the associated transport,
6522 or an unset transport when one is required. Leave this test till now so
6523 that the forbid errors are given in preference. */
6525 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6527 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6531 /* Treat /dev/null as a special case and abandon the delivery. This
6532 avoids having to specify a uid on the transport just for this case.
6533 Arrange for the transport name to be logged as "**bypassed**". */
6535 if (Ustrcmp(addr->address, "/dev/null") == 0)
6537 uschar *save = addr->transport->name;
6538 addr->transport->name = US"**bypassed**";
6539 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6540 addr->transport->name = save;
6541 continue; /* with the next new address */
6544 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6547 DEBUG(D_deliver|D_route)
6548 debug_printf("queued for %s transport\n", addr->transport->name);
6549 addr->next = addr_local;
6551 continue; /* with the next new address */
6554 /* Handle normal addresses. First, split up into local part and domain,
6555 handling the %-hack if necessary. There is the possibility of a defer from
6556 a lookup in percent_hack_domains. */
6558 if ((rc = deliver_split_address(addr)) == DEFER)
6560 addr->message = US"cannot check percent_hack_domains";
6561 addr->basic_errno = ERRNO_LISTDEFER;
6562 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6566 /* Check to see if the domain is held. If so, proceed only if the
6567 delivery was forced by hand. */
6569 deliver_domain = addr->domain; /* set $domain */
6570 if ( !forced && hold_domains
6571 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6572 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6578 addr->message = US"hold_domains lookup deferred";
6579 addr->basic_errno = ERRNO_LISTDEFER;
6583 addr->message = US"domain is held";
6584 addr->basic_errno = ERRNO_HELD;
6586 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6590 /* Now we can check for duplicates and previously delivered addresses. In
6591 order to do this, we have to generate a "unique" value for each address,
6592 because there may be identical actual addresses in a line of descendents.
6593 The "unique" field is initialized to the same value as the "address" field,
6594 but gets changed here to cope with identically-named descendents. */
6596 for (parent = addr->parent; parent; parent = parent->parent)
6597 if (strcmpic(addr->address, parent->address) == 0) break;
6599 /* If there's an ancestor with the same name, set the homonym flag. This
6600 influences how deliveries are recorded. Then add a prefix on the front of
6601 the unique address. We use \n\ where n starts at 0 and increases each time.
6602 It is unlikely to pass 9, but if it does, it may look odd but will still
6603 work. This means that siblings or cousins with the same names are treated
6604 as duplicates, which is what we want. */
6608 setflag(addr, af_homonym);
6609 if (parent->unique[0] != '\\')
6610 addr->unique = string_sprintf("\\0\\%s", addr->address);
6612 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6616 /* Ensure that the domain in the unique field is lower cased, because
6617 domains are always handled caselessly. */
6619 p = Ustrrchr(addr->unique, '@');
6620 while (*p != 0) { *p = tolower(*p); p++; }
6622 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6624 if (tree_search(tree_nonrecipients, addr->unique))
6626 DEBUG(D_deliver|D_route)
6627 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6628 child_done(addr, tod_stamp(tod_log));
6632 /* Get the routing retry status, saving the two retry keys (with and
6633 without the local part) for subsequent use. If there is no retry record for
6634 the standard address routing retry key, we look for the same key with the
6635 sender attached, because this form is used by the smtp transport after a
6636 4xx response to RCPT when address_retry_include_sender is true. */
6638 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6639 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6644 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6645 if ( domain_retry_record
6646 && now - domain_retry_record->time_stamp > retry_data_expire
6649 DEBUG(D_deliver|D_retry)
6650 debug_printf("domain retry record present but expired\n");
6651 domain_retry_record = NULL; /* Ignore if too old */
6654 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6655 if ( address_retry_record
6656 && now - address_retry_record->time_stamp > retry_data_expire
6659 DEBUG(D_deliver|D_retry)
6660 debug_printf("address retry record present but expired\n");
6661 address_retry_record = NULL; /* Ignore if too old */
6664 if (!address_retry_record)
6666 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6668 address_retry_record = dbfn_read(dbm_file, altkey);
6669 if ( address_retry_record
6670 && now - address_retry_record->time_stamp > retry_data_expire)
6672 DEBUG(D_deliver|D_retry)
6673 debug_printf("address<sender> retry record present but expired\n");
6674 address_retry_record = NULL; /* Ignore if too old */
6679 domain_retry_record = address_retry_record = NULL;
6681 DEBUG(D_deliver|D_retry)
6683 if (!domain_retry_record)
6684 debug_printf("no domain retry record\n");
6686 debug_printf("have domain retry record; next_try = now%+d\n",
6687 f.running_in_test_harness ? 0 :
6688 (int)(domain_retry_record->next_try - now));
6690 if (!address_retry_record)
6691 debug_printf("no address retry record\n");
6693 debug_printf("have address retry record; next_try = now%+d\n",
6694 f.running_in_test_harness ? 0 :
6695 (int)(address_retry_record->next_try - now));
6698 /* If we are sending a message down an existing SMTP connection, we must
6699 assume that the message which created the connection managed to route
6700 an address to that connection. We do not want to run the risk of taking
6701 a long time over routing here, because if we do, the server at the other
6702 end of the connection may time it out. This is especially true for messages
6703 with lots of addresses. For this kind of delivery, queue_running is not
6704 set, so we would normally route all addresses. We take a pragmatic approach
6705 and defer routing any addresses that have any kind of domain retry record.
6706 That is, we don't even look at their retry times. It doesn't matter if this
6707 doesn't work occasionally. This is all just an optimization, after all.
6709 The reason for not doing the same for address retries is that they normally
6710 arise from 4xx responses, not DNS timeouts. */
6712 if (continue_hostname && domain_retry_record)
6714 addr->message = US"reusing SMTP connection skips previous routing defer";
6715 addr->basic_errno = ERRNO_RRETRY;
6716 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6718 addr->message = domain_retry_record->text;
6719 setflag(addr, af_pass_message);
6722 /* If we are in a queue run, defer routing unless there is no retry data or
6723 we've passed the next retry time, or this message is forced. In other
6724 words, ignore retry data when not in a queue run.
6726 However, if the domain retry time has expired, always allow the routing
6727 attempt. If it fails again, the address will be failed. This ensures that
6728 each address is routed at least once, even after long-term routing
6731 If there is an address retry, check that too; just wait for the next
6732 retry time. This helps with the case when the temporary error on the
6733 address was really message-specific rather than address specific, since
6734 it allows other messages through.
6736 We also wait for the next retry time if this is a message sent down an
6737 existing SMTP connection (even though that will be forced). Otherwise there
6738 will be far too many attempts for an address that gets a 4xx error. In
6739 fact, after such an error, we should not get here because, the host should
6740 not be remembered as one this message needs. However, there was a bug that
6741 used to cause this to happen, so it is best to be on the safe side.
6743 Even if we haven't reached the retry time in the hints, there is one more
6744 check to do, which is for the ultimate address timeout. We only do this
6745 check if there is an address retry record and there is not a domain retry
6746 record; this implies that previous attempts to handle the address had the
6747 retry_use_local_parts option turned on. We use this as an approximation
6748 for the destination being like a local delivery, for example delivery over
6749 LMTP to an IMAP message store. In this situation users are liable to bump
6750 into their quota and thereby have intermittently successful deliveries,
6751 which keep the retry record fresh, which can lead to us perpetually
6752 deferring messages. */
6754 else if ( ( f.queue_running && !f.deliver_force
6755 || continue_hostname
6757 && ( ( domain_retry_record
6758 && now < domain_retry_record->next_try
6759 && !domain_retry_record->expired
6761 || ( address_retry_record
6762 && now < address_retry_record->next_try
6764 && ( domain_retry_record
6765 || !address_retry_record
6766 || !retry_ultimate_address_timeout(addr->address_retry_key,
6767 addr->domain, address_retry_record, now)
6770 addr->message = US"retry time not reached";
6771 addr->basic_errno = ERRNO_RRETRY;
6772 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6774 /* For remote-retry errors (here and just above) that we've not yet
6775 hit the retry time, use the error recorded in the retry database
6776 as info in the warning message. This lets us send a message even
6777 when we're not failing on a fresh attempt. We assume that this
6778 info is not sensitive. */
6780 addr->message = domain_retry_record
6781 ? domain_retry_record->text : address_retry_record->text;
6782 setflag(addr, af_pass_message);
6785 /* The domain is OK for routing. Remember if retry data exists so it
6786 can be cleaned up after a successful delivery. */
6790 if (domain_retry_record || address_retry_record)
6791 setflag(addr, af_dr_retry_exists);
6792 addr->next = addr_route;
6794 DEBUG(D_deliver|D_route)
6795 debug_printf("%s: queued for routing\n", addr->address);
6799 /* The database is closed while routing is actually happening. Requests to
6800 update it are put on a chain and all processed together at the end. */
6802 if (dbm_file) dbfn_close(dbm_file);
6804 /* If queue_domains is set, we don't even want to try routing addresses in
6805 those domains. During queue runs, queue_domains is forced to be unset.
6806 Optimize by skipping this pass through the addresses if nothing is set. */
6808 if (!f.deliver_force && queue_domains)
6810 address_item *okaddr = NULL;
6813 address_item *addr = addr_route;
6814 addr_route = addr->next;
6816 deliver_domain = addr->domain; /* set $domain */
6817 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6818 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6822 addr->basic_errno = ERRNO_LISTDEFER;
6823 addr->message = US"queue_domains lookup deferred";
6824 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6828 addr->next = okaddr;
6833 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6834 addr->message = US"domain is in queue_domains";
6835 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6839 addr_route = okaddr;
6842 /* Now route those addresses that are not deferred. */
6847 address_item *addr = addr_route;
6848 const uschar *old_domain = addr->domain;
6849 uschar *old_unique = addr->unique;
6850 addr_route = addr->next;
6853 /* Just in case some router parameter refers to it. */
6855 if (!(return_path = addr->prop.errors_address))
6856 return_path = sender_address;
6858 /* If a router defers an address, add a retry item. Whether or not to
6859 use the local part in the key is a property of the router. */
6861 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6862 &addr_succeed, v_none)) == DEFER)
6863 retry_add_item(addr,
6864 addr->router->retry_use_local_part
6865 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6866 : string_sprintf("R:%s", addr->domain),
6869 /* Otherwise, if there is an existing retry record in the database, add
6870 retry items to delete both forms. We must also allow for the possibility
6871 of a routing retry that includes the sender address. Since the domain might
6872 have been rewritten (expanded to fully qualified) as a result of routing,
6873 ensure that the rewritten form is also deleted. */
6875 else if (testflag(addr, af_dr_retry_exists))
6877 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6879 retry_add_item(addr, altkey, rf_delete);
6880 retry_add_item(addr, addr->address_retry_key, rf_delete);
6881 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6882 if (Ustrcmp(addr->domain, old_domain) != 0)
6883 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6886 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6887 logged, but we need to ensure the address (and maybe parents) is marked
6892 address_done(addr, tod_stamp(tod_log));
6893 continue; /* route next address */
6896 /* The address is finished with (failed or deferred). */
6900 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6901 continue; /* route next address */
6904 /* The address has been routed. If the router changed the domain, it will
6905 also have changed the unique address. We have to test whether this address
6906 has already been delivered, because it's the unique address that finally
6909 if ( addr->unique != old_unique
6910 && tree_search(tree_nonrecipients, addr->unique) != 0
6913 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6914 "discarded\n", addr->address);
6915 if (addr_remote == addr) addr_remote = addr->next;
6916 else if (addr_local == addr) addr_local = addr->next;
6919 /* If the router has same_domain_copy_routing set, we are permitted to copy
6920 the routing for any other addresses with the same domain. This is an
6921 optimisation to save repeated DNS lookups for "standard" remote domain
6922 routing. The option is settable only on routers that generate host lists.
6923 We play it very safe, and do the optimization only if the address is routed
6924 to a remote transport, there are no header changes, and the domain was not
6925 modified by the router. */
6927 if ( addr_remote == addr
6928 && addr->router->same_domain_copy_routing
6929 && !addr->prop.extra_headers
6930 && !addr->prop.remove_headers
6931 && old_domain == addr->domain
6934 address_item **chain = &addr_route;
6937 address_item *addr2 = *chain;
6938 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6940 chain = &(addr2->next);
6944 /* Found a suitable address; take it off the routing list and add it to
6945 the remote delivery list. */
6947 *chain = addr2->next;
6948 addr2->next = addr_remote;
6949 addr_remote = addr2;
6951 /* Copy the routing data */
6953 addr2->domain = addr->domain;
6954 addr2->router = addr->router;
6955 addr2->transport = addr->transport;
6956 addr2->host_list = addr->host_list;
6957 addr2->fallback_hosts = addr->fallback_hosts;
6958 addr2->prop.errors_address = addr->prop.errors_address;
6959 copyflag(addr2, addr, af_hide_child);
6960 copyflag(addr2, addr, af_local_host_removed);
6962 DEBUG(D_deliver|D_route)
6963 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6965 "Routing for %s copied from %s\n",
6966 addr2->address, addr2->address, addr->address);
6969 } /* Continue with routing the next address. */
6970 } /* Loop to process any child addresses that the routers created, and
6971 any rerouted addresses that got put back on the new chain. */
6974 /* Debugging: show the results of the routing */
6976 DEBUG(D_deliver|D_retry|D_route)
6978 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6979 debug_printf("After routing:\n Local deliveries:\n");
6980 for (address_item * p = addr_local; p; p = p->next)
6981 debug_printf(" %s\n", p->address);
6983 debug_printf(" Remote deliveries:\n");
6984 for (address_item * p = addr_remote; p; p = p->next)
6985 debug_printf(" %s\n", p->address);
6987 debug_printf(" Failed addresses:\n");
6988 for (address_item * p = addr_failed; p; p = p->next)
6989 debug_printf(" %s\n", p->address);
6991 debug_printf(" Deferred addresses:\n");
6992 for (address_item * p = addr_defer; p; p = p->next)
6993 debug_printf(" %s\n", p->address);
6996 /* Free any resources that were cached during routing. */
7001 /* These two variables are set only during routing, after check_local_user.
7002 Ensure they are not set in transports. */
7004 local_user_gid = (gid_t)(-1);
7005 local_user_uid = (uid_t)(-1);
7007 /* Check for any duplicate addresses. This check is delayed until after
7008 routing, because the flexibility of the routing configuration means that
7009 identical addresses with different parentage may end up being redirected to
7010 different addresses. Checking for duplicates too early (as we previously used
7011 to) makes this kind of thing not work. */
7013 do_duplicate_check(&addr_local);
7014 do_duplicate_check(&addr_remote);
7016 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7017 remote transport. The check that they all end up in one transaction happens in
7018 the do_remote_deliveries() function. */
7021 && (addr_local || addr_failed || addr_defer)
7025 uschar *which, *colon, *msg;
7032 else if (addr_defer)
7035 which = US"deferred";
7043 while (addr->parent) addr = addr->parent;
7048 msg = addr->message;
7050 else colon = msg = US"";
7052 /* We don't need to log here for a forced failure as it will already
7053 have been logged. Defer will also have been logged, but as a defer, so we do
7054 need to do the failure logging. */
7056 if (addr != addr_failed)
7057 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7058 addr->address, which);
7060 /* Always write an error to the caller */
7062 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7065 final_yield = DELIVER_MUA_FAILED;
7066 addr_failed = addr_defer = NULL; /* So that we remove the message */
7067 goto DELIVERY_TIDYUP;
7071 /* If this is a run to continue deliveries to an external channel that is
7072 already set up, defer any local deliveries.
7074 jgh 2020/12/20: I don't see why; locals should be quick.
7075 The defer goes back to version 1.62 in 1997. A local being still deliverable
7076 during a continued run might result from something like a defer during the
7077 original delivery, eg. in a DB lookup. Unlikely but possible.
7079 To avoid delaying a local when combined with a callout-hold for a remote
7080 delivery, test continue_sequence rather than continue_transport. */
7082 if (continue_sequence > 1 && addr_local)
7084 DEBUG(D_deliver|D_retry|D_route)
7085 debug_printf("deferring local deliveries due to continued-transport\n");
7088 address_item * addr = addr_defer;
7089 while (addr->next) addr = addr->next;
7090 addr->next = addr_local;
7093 addr_defer = addr_local;
7098 /* Because address rewriting can happen in the routers, we should not really do
7099 ANY deliveries until all addresses have been routed, so that all recipients of
7100 the message get the same headers. However, this is in practice not always
7101 possible, since sometimes remote addresses give DNS timeouts for days on end.
7102 The pragmatic approach is to deliver what we can now, saving any rewritten
7103 headers so that at least the next lot of recipients benefit from the rewriting
7104 that has already been done.
7106 If any headers have been rewritten during routing, update the spool file to
7107 remember them for all subsequent deliveries. This can be delayed till later if
7108 there is only address to be delivered - if it succeeds the spool write need not
7111 if ( f.header_rewritten
7112 && ( addr_local && (addr_local->next || addr_remote)
7113 || addr_remote && addr_remote->next
7116 /* Panic-dies on error */
7117 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7118 f.header_rewritten = FALSE;
7122 /* If there are any deliveries to do and we do not already have the journal
7123 file, create it. This is used to record successful deliveries as soon as
7124 possible after each delivery is known to be complete. A file opened with
7125 O_APPEND is used so that several processes can run simultaneously.
7127 The journal is just insurance against crashes. When the spool file is
7128 ultimately updated at the end of processing, the journal is deleted. If a
7129 journal is found to exist at the start of delivery, the addresses listed
7130 therein are added to the non-recipients. */
7132 if (addr_local || addr_remote)
7136 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7138 if ((journal_fd = Uopen(fname,
7142 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7144 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7145 fname, strerror(errno));
7146 return DELIVER_NOT_ATTEMPTED;
7149 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7150 that the mode is correct - the group setting doesn't always seem to get
7151 set automatically. */
7153 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7154 || fchmod(journal_fd, SPOOL_MODE)
7156 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7160 int ret = Uunlink(fname);
7161 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7162 fname, strerror(errno));
7163 if(ret && errno != ENOENT)
7164 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7165 fname, strerror(errno));
7166 return DELIVER_NOT_ATTEMPTED;
7170 else if (journal_fd >= 0)
7178 /* Now we can get down to the business of actually doing deliveries. Local
7179 deliveries are done first, then remote ones. If ever the problems of how to
7180 handle fallback transports are figured out, this section can be put into a loop
7181 for handling fallbacks, though the uid switching will have to be revised. */
7183 /* Precompile a regex that is used to recognize a parameter in response
7184 to an LHLO command, if is isn't already compiled. This may be used on both
7185 local and remote LMTP deliveries. */
7187 if (!regex_IGNOREQUOTA)
7189 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7191 /* Handle local deliveries */
7195 DEBUG(D_deliver|D_transport)
7196 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7197 do_local_deliveries();
7198 f.disable_logging = FALSE;
7201 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7202 so just queue them all. */
7204 if (f.queue_run_local)
7207 address_item *addr = addr_remote;
7208 addr_remote = addr->next;
7210 addr->basic_errno = ERRNO_LOCAL_ONLY;
7211 addr->message = US"remote deliveries suppressed";
7212 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7215 /* Handle remote deliveries */
7219 DEBUG(D_deliver|D_transport)
7220 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7222 /* Precompile some regex that are used to recognize parameters in response
7223 to an EHLO command, if they aren't already compiled. */
7225 smtp_deliver_init();
7227 /* Now sort the addresses if required, and do the deliveries. The yield of
7228 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7229 cannot be delivered in one transaction. */
7231 if (remote_sort_domains) sort_remote_deliveries();
7232 if (!do_remote_deliveries(FALSE))
7234 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7235 "be delivered in one transaction");
7236 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7238 final_yield = DELIVER_MUA_FAILED;
7239 addr_failed = addr_defer = NULL; /* So that we remove the message */
7240 goto DELIVERY_TIDYUP;
7243 /* See if any of the addresses that failed got put on the queue for delivery
7244 to their fallback hosts. We do it this way because often the same fallback
7245 host is used for many domains, so all can be sent in a single transaction
7246 (if appropriately configured). */
7248 if (addr_fallback && !mua_wrapper)
7250 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7251 addr_remote = addr_fallback;
7252 addr_fallback = NULL;
7253 if (remote_sort_domains) sort_remote_deliveries();
7254 do_remote_deliveries(TRUE);
7256 f.disable_logging = FALSE;
7260 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7261 phase, to minimize cases of half-done things. */
7264 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7265 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7267 /* Root privilege is no longer needed */
7269 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7271 set_process_info("tidying up after delivering %s", message_id);
7272 signal(SIGTERM, SIG_IGN);
7274 /* When we are acting as an MUA wrapper, the smtp transport will either have
7275 succeeded for all addresses, or failed them all in normal cases. However, there
7276 are some setup situations (e.g. when a named port does not exist) that cause an
7277 immediate exit with deferral of all addresses. Convert those into failures. We
7278 do not ever want to retry, nor do we want to send a bounce message. */
7284 address_item * nextaddr;
7285 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7287 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7288 "delivery", addr->address);
7289 nextaddr = addr->next;
7290 addr->next = addr_failed;
7296 /* Now all should either have succeeded or failed. */
7299 final_yield = DELIVER_MUA_SUCCEEDED;
7303 uschar *s = addr_failed->user_message;
7305 if (!s) s = addr_failed->message;
7307 fprintf(stderr, "Delivery failed: ");
7308 if (addr_failed->basic_errno > 0)
7310 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7311 if (s) fprintf(stderr, ": ");
7313 if ((host = addr_failed->host_used))
7314 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7316 fprintf(stderr, "%s", CS s);
7317 else if (addr_failed->basic_errno <= 0)
7318 fprintf(stderr, "unknown error");
7319 fprintf(stderr, "\n");
7321 final_yield = DELIVER_MUA_FAILED;
7326 /* In a normal configuration, we now update the retry database. This is done in
7327 one fell swoop at the end in order not to keep opening and closing (and
7328 locking) the database. The code for handling retries is hived off into a
7329 separate module for convenience. We pass it the addresses of the various
7330 chains, because deferred addresses can get moved onto the failed chain if the
7331 retry cutoff time has expired for all alternative destinations. Bypass the
7332 updating of the database if the -N flag is set, which is a debugging thing that
7333 prevents actual delivery. */
7335 else if (!f.dont_deliver)
7336 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7338 /* Send DSN for successful messages if requested */
7339 addr_senddsn = NULL;
7341 for (address_item * a = addr_succeed; a; a = a->next)
7343 /* af_ignore_error not honored here. it's not an error */
7344 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7345 "DSN: processing successful delivery address: %s\n"
7346 "DSN: Sender_address: %s\n"
7347 "DSN: orcpt: %s flags: 0x%x\n"
7348 "DSN: envid: %s ret: %d\n"
7349 "DSN: Final recipient: %s\n"
7350 "DSN: Remote SMTP server supports DSN: %d\n",
7351 a->router ? a->router->name : US"(unknown)",
7354 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7356 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7361 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7362 and a report was requested */
7364 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7365 && a->dsn_flags & rf_notify_success
7368 /* copy and relink address_item and send report with all of them at once later */
7369 address_item * addr_next = addr_senddsn;
7370 addr_senddsn = store_get(sizeof(address_item), FALSE);
7372 addr_senddsn->next = addr_next;
7375 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7383 /* create exim process to send message */
7384 pid = child_open_exim(&fd, US"DSN");
7386 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7388 if (pid < 0) /* Creation of child failed */
7390 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7391 "create child process to send success-dsn message: %s", getpid(),
7392 getppid(), strerror(errno));
7394 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7396 else /* Creation of child succeeded */
7398 FILE * f = fdopen(fd, "wb");
7399 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7401 transport_ctx tctx = {{0}};
7404 debug_printf("sending success-dsn to: %s\n", sender_address);
7406 /* build unique id for MIME boundary */
7407 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7408 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7410 if (errors_reply_to)
7411 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7414 fprintf(f, "Auto-Submitted: auto-generated\n"
7416 "Subject: Delivery Status Notification\n",
7418 moan_write_references(f, NULL);
7419 fprintf(f, "Content-Type: multipart/report;"
7420 " report-type=delivery-status; boundary=%s\n"
7421 "MIME-Version: 1.0\n\n"
7424 "Content-type: text/plain; charset=us-ascii\n\n"
7426 "This message was created automatically by mail delivery software.\n"
7427 " ----- The following addresses had successful delivery notifications -----\n",
7430 for (address_item * a = addr_senddsn; a; a = a->next)
7431 fprintf(f, "<%s> (relayed %s)\n\n",
7433 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7434 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7435 : "via non \"Remote SMTP\" router"
7439 "Content-type: message/delivery-status\n\n"
7440 "Reporting-MTA: dns; %s\n",
7441 bound, smtp_active_hostname);
7444 { /* must be decoded from xtext: see RFC 3461:6.3a */
7446 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7447 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7449 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7453 for (address_item * a = addr_senddsn; a; a = a->next)
7457 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7459 if ((hu = a->host_used) && hu->name)
7460 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7463 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7464 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7467 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7470 transport_filter_argv = NULL; /* Just in case */
7471 return_path = sender_address; /* In case not previously set */
7473 /* Write the original email out */
7476 tctx.options = topt_add_return_path | topt_no_body;
7477 /*XXX hmm, FALSE(fail) retval ignored.
7478 Could error for any number of reasons, and they are not handled. */
7479 transport_write_message(&tctx, 0);
7482 fprintf(f,"\n--%s--\n", bound);
7486 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7490 /* If any addresses failed, we must send a message to somebody, unless
7491 af_ignore_error is set, in which case no action is taken. It is possible for
7492 several messages to get sent if there are addresses with different
7499 uschar *logtod = tod_stamp(tod_log);
7501 address_item *handled_addr = NULL;
7502 address_item **paddr;
7503 address_item *msgchain = NULL;
7504 address_item **pmsgchain = &msgchain;
7506 /* There are weird cases when logging is disabled in the transport. However,
7507 there may not be a transport (address failed by a router). */
7509 f.disable_logging = FALSE;
7510 if (addr_failed->transport)
7511 f.disable_logging = addr_failed->transport->disable_logging;
7514 debug_printf("processing failed address %s\n", addr_failed->address);
7516 /* There are only two ways an address in a bounce message can get here:
7518 (1) When delivery was initially deferred, but has now timed out (in the call
7519 to retry_update() above). We can detect this by testing for
7520 af_retry_timedout. If the address does not have its own errors address,
7521 we arrange to ignore the error.
7523 (2) If delivery failures for bounce messages are being ignored. We can detect
7524 this by testing for af_ignore_error. This will also be set if a bounce
7525 message has been autothawed and the ignore_bounce_errors_after time has
7526 passed. It might also be set if a router was explicitly configured to
7527 ignore errors (errors_to = "").
7529 If neither of these cases obtains, something has gone wrong. Log the
7530 incident, but then ignore the error. */
7532 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7534 if ( !testflag(addr_failed, af_retry_timedout)
7535 && !addr_failed->prop.ignore_error)
7536 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7537 "failure is neither frozen nor ignored (it's been ignored)");
7539 addr_failed->prop.ignore_error = TRUE;
7542 /* If the first address on the list has af_ignore_error set, just remove
7543 it from the list, throw away any saved message file, log it, and
7544 mark the recipient done. */
7546 if ( addr_failed->prop.ignore_error
7547 || addr_failed->dsn_flags & rf_dsnflags
7548 && !(addr_failed->dsn_flags & rf_notify_failure)
7552 addr_failed = addr->next;
7553 if (addr->return_filename) Uunlink(addr->return_filename);
7555 #ifndef DISABLE_EVENT
7556 msg_event_raise(US"msg:fail:delivery", addr);
7558 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7560 !addr->parent ? US"" : US" <",
7561 !addr->parent ? US"" : addr->parent->address,
7562 !addr->parent ? US"" : US">",
7563 addr->prop.ignore_error
7564 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7566 address_done(addr, logtod);
7567 child_done(addr, logtod);
7568 /* Panic-dies on error */
7569 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7572 /* Otherwise, handle the sending of a message. Find the error address for
7573 the first address, then send a message that includes all failed addresses
7574 that have the same error address. Note the bounce_recipient is a global so
7575 that it can be accessed by $bounce_recipient while creating a customized
7580 if (!(bounce_recipient = addr_failed->prop.errors_address))
7581 bounce_recipient = sender_address;
7583 /* Make a subprocess to send a message */
7585 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7586 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7587 "create child process to send failure message: %s", getpid(),
7588 getppid(), strerror(errno));
7590 /* Creation of child succeeded */
7597 uschar *bcc, *emf_text;
7598 FILE * fp = fdopen(fd, "wb");
7600 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7601 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7602 DELIVER_IN_BUFFER_SIZE;
7604 uschar *dsnlimitmsg;
7605 uschar *dsnnotifyhdr;
7609 debug_printf("sending error message to: %s\n", bounce_recipient);
7611 /* Scan the addresses for all that have the same errors address, removing
7612 them from the addr_failed chain, and putting them on msgchain. */
7614 paddr = &addr_failed;
7615 for (addr = addr_failed; addr; addr = *paddr)
7616 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7617 ? addr->prop.errors_address : sender_address) == 0)
7618 { /* The same - dechain */
7619 *paddr = addr->next;
7622 pmsgchain = &(addr->next);
7625 paddr = &addr->next; /* Not the same; skip */
7627 /* Include X-Failed-Recipients: for automatic interpretation, but do
7628 not let any one header line get too long. We do this by starting a
7629 new header every 50 recipients. Omit any addresses for which the
7630 "hide_child" flag is set. */
7632 for (addr = msgchain; addr; addr = addr->next)
7634 if (testflag(addr, af_hide_child)) continue;
7642 ? "X-Failed-Recipients: "
7644 testflag(addr, af_pfr) && addr->parent
7645 ? string_printing(addr->parent->address)
7646 : string_printing(addr->address));
7648 if (rcount > 0) fprintf(fp, "\n");
7650 /* Output the standard headers */
7652 if (errors_reply_to)
7653 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7654 fprintf(fp, "Auto-Submitted: auto-replied\n");
7655 moan_write_from(fp);
7656 fprintf(fp, "To: %s\n", bounce_recipient);
7657 moan_write_references(fp, NULL);
7659 /* generate boundary string and output MIME-Headers */
7660 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7662 fprintf(fp, "Content-Type: multipart/report;"
7663 " report-type=delivery-status; boundary=%s\n"
7664 "MIME-Version: 1.0\n",
7667 /* Open a template file if one is provided. Log failure to open, but
7668 carry on - default texts will be used. */
7670 if (bounce_message_file)
7671 emf = expand_open(bounce_message_file,
7672 US"bounce_message_file", US"error");
7674 /* Quietly copy to configured additional addresses if required. */
7676 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7677 fprintf(fp, "Bcc: %s\n", bcc);
7679 /* The texts for the message can be read from a template file; if there
7680 isn't one, or if it is too short, built-in texts are used. The first
7681 emf text is a Subject: and any other headers. */
7683 if ((emf_text = next_emf(emf, US"header")))
7684 fprintf(fp, "%s\n", emf_text);
7686 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7687 to_sender? ": returning message to sender" : "");
7689 /* output human readable part as text/plain section */
7690 fprintf(fp, "--%s\n"
7691 "Content-type: text/plain; charset=us-ascii\n\n",
7694 if ((emf_text = next_emf(emf, US"intro")))
7695 fprintf(fp, "%s", CS emf_text);
7699 /* This message has been reworded several times. It seems to be confusing to
7700 somebody, however it is worded. I have retreated to the original, simple
7702 "This message was created automatically by mail delivery software.\n");
7704 if (bounce_message_text)
7705 fprintf(fp, "%s", CS bounce_message_text);
7708 "\nA message that you sent could not be delivered to one or more of its\n"
7709 "recipients. This is a permanent error. The following address(es) failed:\n");
7712 "\nA message sent by\n\n <%s>\n\n"
7713 "could not be delivered to one or more of its recipients. The following\n"
7714 "address(es) failed:\n", sender_address);
7718 /* Process the addresses, leaving them on the msgchain if they have a
7719 file name for a return message. (There has already been a check in
7720 post_process_one() for the existence of data in the message file.) A TRUE
7721 return from print_address_information() means that the address is not
7725 for (addr = msgchain; addr; addr = *paddr)
7727 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7728 print_address_error(addr, fp, US"");
7730 /* End the final line for the address */
7734 /* Leave on msgchain if there's a return file. */
7736 if (addr->return_file >= 0)
7738 paddr = &(addr->next);
7742 /* Else save so that we can tick off the recipient when the
7747 *paddr = addr->next;
7748 addr->next = handled_addr;
7749 handled_addr = addr;
7755 /* Get the next text, whether we need it or not, so as to be
7756 positioned for the one after. */
7758 emf_text = next_emf(emf, US"generated text");
7760 /* If there were any file messages passed by the local transports,
7761 include them in the message. Then put the address on the handled chain.
7762 In the case of a batch of addresses that were all sent to the same
7763 transport, the return_file field in all of them will contain the same
7764 fd, and the return_filename field in the *last* one will be set (to the
7765 name of the file). */
7769 address_item *nextaddr;
7772 fprintf(fp, "%s", CS emf_text);
7775 "The following text was generated during the delivery "
7776 "attempt%s:\n", (filecount > 1)? "s" : "");
7778 for (addr = msgchain; addr; addr = nextaddr)
7781 address_item *topaddr = addr;
7783 /* List all the addresses that relate to this file */
7786 while(addr) /* Insurance */
7788 print_address_information(addr, fp, US"------ ", US"\n ",
7790 if (addr->return_filename) break;
7795 /* Now copy the file */
7797 if (!(fm = Ufopen(addr->return_filename, "rb")))
7798 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7802 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7805 Uunlink(addr->return_filename);
7807 /* Can now add to handled chain, first fishing off the next
7808 address on the msgchain. */
7810 nextaddr = addr->next;
7811 addr->next = handled_addr;
7812 handled_addr = topaddr;
7817 /* output machine readable part */
7819 if (message_smtputf8)
7820 fprintf(fp, "--%s\n"
7821 "Content-type: message/global-delivery-status\n\n"
7822 "Reporting-MTA: dns; %s\n",
7823 bound, smtp_active_hostname);
7826 fprintf(fp, "--%s\n"
7827 "Content-type: message/delivery-status\n\n"
7828 "Reporting-MTA: dns; %s\n",
7829 bound, smtp_active_hostname);
7833 /* must be decoded from xtext: see RFC 3461:6.3a */
7835 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7836 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7838 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7842 for (addr = handled_addr; addr; addr = addr->next)
7846 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7848 if ((hu = addr->host_used) && hu->name)
7850 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7851 #ifdef EXPERIMENTAL_DSN_INFO
7856 uschar * p = hu->port == 25
7857 ? US"" : string_sprintf(":%d", hu->port);
7858 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7860 if ((s = addr->smtp_greeting) && *s)
7861 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %.900s\n", s);
7862 if ((s = addr->helo_response) && *s)
7863 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %.900s\n", s);
7864 if ((s = addr->message) && *s)
7865 fprintf(fp, "X-Exim-Diagnostic: X-str; %.900s\n", s);
7868 print_dsn_diagnostic_code(addr, fp);
7873 /* Now copy the message, trying to give an intelligible comment if
7874 it is too long for it all to be copied. The limit isn't strictly
7875 applied because of the buffering. There is, however, an option
7876 to suppress copying altogether. */
7878 emf_text = next_emf(emf, US"copy");
7881 we ignore the intro text from template and add
7882 the text for bounce_return_size_limit at the end.
7884 bounce_return_message is ignored
7885 in case RET= is defined we honor these values
7886 otherwise bounce_return_body is honored.
7888 bounce_return_size_limit is always honored.
7891 fprintf(fp, "--%s\n", bound);
7893 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7894 dsnnotifyhdr = NULL;
7895 topt = topt_add_return_path;
7897 /* RET=HDRS? top priority */
7898 if (dsn_ret == dsn_ret_hdrs)
7899 topt |= topt_no_body;
7902 struct stat statbuf;
7904 /* no full body return at all? */
7905 if (!bounce_return_body)
7907 topt |= topt_no_body;
7908 /* add header if we overrule RET=FULL */
7909 if (dsn_ret == dsn_ret_full)
7910 dsnnotifyhdr = dsnlimitmsg;
7912 /* line length limited... return headers only if oversize */
7913 /* size limited ... return headers only if limit reached */
7914 else if ( max_received_linelength > bounce_return_linesize_limit
7915 || ( bounce_return_size_limit > 0
7916 && fstat(deliver_datafile, &statbuf) == 0
7917 && statbuf.st_size > max
7920 topt |= topt_no_body;
7921 dsnnotifyhdr = dsnlimitmsg;
7926 if (message_smtputf8)
7927 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7928 : "Content-type: message/global\n\n",
7932 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7933 : "Content-type: message/rfc822\n\n",
7937 transport_filter_argv = NULL; /* Just in case */
7938 return_path = sender_address; /* In case not previously set */
7939 { /* Dummy transport for headers add */
7940 transport_ctx tctx = {{0}};
7941 transport_instance tb = {0};
7943 tctx.u.fd = fileno(fp);
7945 tctx.options = topt;
7946 tb.add_headers = dsnnotifyhdr;
7948 /*XXX no checking for failure! buggy! */
7949 transport_write_message(&tctx, 0);
7953 /* we never add the final text. close the file */
7957 fprintf(fp, "\n--%s--\n", bound);
7959 /* Close the file, which should send an EOF to the child process
7960 that is receiving the message. Wait for it to finish. */
7963 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7965 /* If the process failed, there was some disaster in setting up the
7966 error message. Unless the message is very old, ensure that addr_defer
7967 is non-null, which will have the effect of leaving the message on the
7968 spool. The failed addresses will get tried again next time. However, we
7969 don't really want this to happen too often, so freeze the message unless
7970 there are some genuine deferred addresses to try. To do this we have
7971 to call spool_write_header() here, because with no genuine deferred
7972 addresses the normal code below doesn't get run. */
7977 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7979 addr_defer = (address_item *)(+1);
7980 f.deliver_freeze = TRUE;
7981 deliver_frozen_at = time(NULL);
7982 /* Panic-dies on error */
7983 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7986 deliver_msglog("Process failed (%d) when writing error message "
7987 "to %s%s", rc, bounce_recipient, s);
7988 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7989 "to %s%s", rc, bounce_recipient, s);
7992 /* The message succeeded. Ensure that the recipients that failed are
7993 now marked finished with on the spool and their parents updated. */
7997 for (addr = handled_addr; addr; addr = addr->next)
7999 address_done(addr, logtod);
8000 child_done(addr, logtod);
8002 /* Panic-dies on error */
8003 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8009 f.disable_logging = FALSE; /* In case left set */
8011 /* Come here from the mua_wrapper case if routing goes wrong */
8015 /* If there are now no deferred addresses, we are done. Preserve the
8016 message log if so configured, and we are using them. Otherwise, sling it.
8017 Then delete the message itself. */
8025 fname = spool_fname(US"msglog", message_subdir, id, US"");
8026 if (preserve_message_logs)
8029 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8031 if ((rc = Urename(fname, moname)) < 0)
8033 (void)directory_make(spool_directory,
8034 spool_sname(US"msglog.OLD", US""),
8035 MSGLOG_DIRECTORY_MODE, TRUE);
8036 rc = Urename(fname, moname);
8039 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8040 "msglog.OLD directory", fname);
8043 if (Uunlink(fname) < 0)
8044 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8045 fname, strerror(errno));
8048 /* Remove the two message files. */
8050 fname = spool_fname(US"input", message_subdir, id, US"-D");
8051 if (Uunlink(fname) < 0)
8052 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8053 fname, strerror(errno));
8054 fname = spool_fname(US"input", message_subdir, id, US"-H");
8055 if (Uunlink(fname) < 0)
8056 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8057 fname, strerror(errno));
8059 /* Log the end of this message, with queue time if requested. */
8061 if (LOGGING(queue_time_overall))
8062 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8064 log_write(0, LOG_MAIN, "Completed");
8066 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8067 f.deliver_freeze = FALSE;
8069 #ifndef DISABLE_EVENT
8070 (void) event_raise(event_action, US"msg:complete", NULL);
8074 /* If there are deferred addresses, we are keeping this message because it is
8075 not yet completed. Lose any temporary files that were catching output from
8076 pipes for any of the deferred addresses, handle one-time aliases, and see if
8077 the message has been on the queue for so long that it is time to send a warning
8078 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8079 have the same domain, we can set deliver_domain for the expansion of
8080 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8081 the parent's domain.
8083 If all the deferred addresses have an error number that indicates "retry time
8084 not reached", skip sending the warning message, because it won't contain the
8085 reason for the delay. It will get sent at the next real delivery attempt.
8086 Exception: for retries caused by a remote peer we use the error message
8087 store in the retry DB as the reason.
8088 However, if at least one address has tried, we'd better include all of them in
8091 If we can't make a process to send the message, don't worry.
8093 For mailing list expansions we want to send the warning message to the
8094 mailing list manager. We can't do a perfect job here, as some addresses may
8095 have different errors addresses, but if we take the errors address from
8096 each deferred address it will probably be right in most cases.
8098 If addr_defer == +1, it means there was a problem sending an error message
8099 for failed addresses, and there were no "real" deferred addresses. The value
8100 was set just to keep the message on the spool, so there is nothing to do here.
8103 else if (addr_defer != (address_item *)(+1))
8105 uschar *recipients = US"";
8106 BOOL want_warning_msg = FALSE;
8108 deliver_domain = testflag(addr_defer, af_pfr)
8109 ? addr_defer->parent->domain : addr_defer->domain;
8111 for (address_item * addr = addr_defer; addr; addr = addr->next)
8113 address_item *otaddr;
8115 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8119 const uschar *d = testflag(addr, af_pfr)
8120 ? addr->parent->domain : addr->domain;
8122 /* The domain may be unset for an address that has never been routed
8123 because the system filter froze the message. */
8125 if (!d || Ustrcmp(d, deliver_domain) != 0)
8126 deliver_domain = NULL;
8129 if (addr->return_filename) Uunlink(addr->return_filename);
8131 /* Handle the case of one-time aliases. If any address in the ancestry
8132 of this one is flagged, ensure it is in the recipients list, suitably
8133 flagged, and that its parent is marked delivered. */
8135 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8136 if (otaddr->onetime_parent) break;
8141 int t = recipients_count;
8143 for (i = 0; i < recipients_count; i++)
8145 uschar *r = recipients_list[i].address;
8146 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8147 if (Ustrcmp(otaddr->address, r) == 0) break;
8150 /* Didn't find the address already in the list, and did find the
8151 ultimate parent's address in the list, and they really are different
8152 (i.e. not from an identity-redirect). After adding the recipient,
8153 update the errors address in the recipients list. */
8155 if ( i >= recipients_count && t < recipients_count
8156 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8158 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8159 otaddr->address, otaddr->parent->address);
8160 receive_add_recipient(otaddr->address, t);
8161 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8162 tree_add_nonrecipient(otaddr->parent->address);
8163 update_spool = TRUE;
8167 /* Except for error messages, ensure that either the errors address for
8168 this deferred address or, if there is none, the sender address, is on the
8169 list of recipients for a warning message. */
8171 if (sender_address[0])
8173 uschar * s = addr->prop.errors_address;
8174 if (!s) s = sender_address;
8175 if (Ustrstr(recipients, s) == NULL)
8176 recipients = string_sprintf("%s%s%s", recipients,
8177 recipients[0] ? "," : "", s);
8181 /* Send a warning message if the conditions are right. If the condition check
8182 fails because of a lookup defer, there is nothing we can do. The warning
8183 is not sent. Another attempt will be made at the next delivery attempt (if
8186 if ( !f.queue_2stage
8188 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8189 || addr_defer->dsn_flags & rf_notify_delay
8191 && delay_warning[1] > 0
8192 && sender_address[0] != 0
8193 && ( !delay_warning_condition
8194 || expand_check_condition(delay_warning_condition,
8195 US"delay_warning", US"option")
8201 int queue_time = time(NULL) - received_time.tv_sec;
8203 queue_time = test_harness_fudged_queue_time(queue_time);
8205 /* See how many warnings we should have sent by now */
8207 for (count = 0; count < delay_warning[1]; count++)
8208 if (queue_time < delay_warning[count+2]) break;
8210 show_time = delay_warning[count+1];
8212 if (count >= delay_warning[1])
8215 int last_gap = show_time;
8216 if (count > 1) last_gap -= delay_warning[count];
8217 extra = (queue_time - delay_warning[count+1])/last_gap;
8218 show_time += last_gap * extra;
8224 debug_printf("time on queue = %s id %s addr %s\n",
8225 readconf_printtime(queue_time), message_id, addr_defer->address);
8226 debug_printf("warning counts: required %d done %d\n", count,
8230 /* We have computed the number of warnings there should have been by now.
8231 If there haven't been enough, send one, and up the count to what it should
8234 if (warning_count < count)
8238 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8244 FILE * f = fdopen(fd, "wb");
8246 transport_ctx tctx = {{0}};
8248 if (warn_message_file)
8249 wmf = expand_open(warn_message_file,
8250 US"warn_message_file", US"warning");
8252 warnmsg_recipients = recipients;
8253 warnmsg_delay = queue_time < 120*60
8254 ? string_sprintf("%d minutes", show_time/60)
8255 : string_sprintf("%d hours", show_time/3600);
8257 if (errors_reply_to)
8258 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8259 fprintf(f, "Auto-Submitted: auto-replied\n");
8261 fprintf(f, "To: %s\n", recipients);
8262 moan_write_references(f, NULL);
8264 /* generated boundary string and output MIME-Headers */
8265 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8267 fprintf(f, "Content-Type: multipart/report;"
8268 " report-type=delivery-status; boundary=%s\n"
8269 "MIME-Version: 1.0\n",
8272 if ((wmf_text = next_emf(wmf, US"header")))
8273 fprintf(f, "%s\n", wmf_text);
8275 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8276 message_id, warnmsg_delay);
8278 /* output human readable part as text/plain section */
8280 "Content-type: text/plain; charset=us-ascii\n\n",
8283 if ((wmf_text = next_emf(wmf, US"intro")))
8284 fprintf(f, "%s", CS wmf_text);
8288 "This message was created automatically by mail delivery software.\n");
8290 if (Ustrcmp(recipients, sender_address) == 0)
8292 "A message that you sent has not yet been delivered to one or more of its\n"
8293 "recipients after more than ");
8297 "A message sent by\n\n <%s>\n\n"
8298 "has not yet been delivered to one or more of its recipients after more than \n",
8301 fprintf(f, "%s on the queue on %s.\n\n"
8302 "The message identifier is: %s\n",
8303 warnmsg_delay, primary_hostname, message_id);
8305 for (h = header_list; h; h = h->next)
8306 if (strncmpic(h->text, US"Subject:", 8) == 0)
8307 fprintf(f, "The subject of the message is: %s", h->text + 9);
8308 else if (strncmpic(h->text, US"Date:", 5) == 0)
8309 fprintf(f, "The date of the message is: %s", h->text + 6);
8312 fprintf(f, "The address%s to which the message has not yet been "
8314 !addr_defer->next ? "" : "es",
8315 !addr_defer->next ? "is": "are");
8318 /* List the addresses, with error information if allowed */
8321 for (address_item * addr = addr_defer; addr; addr = addr->next)
8323 if (print_address_information(addr, f, US" ", US"\n ", US""))
8324 print_address_error(addr, f, US"Delay reason: ");
8333 if ((wmf_text = next_emf(wmf, US"final")))
8334 fprintf(f, "%s", CS wmf_text);
8340 "No action is required on your part. Delivery attempts will continue for\n"
8341 "some time, and this warning may be repeated at intervals if the message\n"
8342 "remains undelivered. Eventually the mail delivery software will give up,\n"
8343 "and when that happens, the message will be returned to you.\n");
8346 /* output machine readable part */
8347 fprintf(f, "\n--%s\n"
8348 "Content-type: message/delivery-status\n\n"
8349 "Reporting-MTA: dns; %s\n",
8351 smtp_active_hostname);
8356 /* must be decoded from xtext: see RFC 3461:6.3a */
8358 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8359 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8361 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8365 for (address_item * addr = addr_defer; addr; addr = addr->next)
8369 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8371 if ((hu = addr->host_used) && hu->name)
8373 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8374 print_dsn_diagnostic_code(addr, f);
8380 "Content-type: text/rfc822-headers\n\n",
8384 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8385 tctx.u.fd = fileno(f);
8386 tctx.options = topt_add_return_path | topt_no_body;
8387 transport_filter_argv = NULL; /* Just in case */
8388 return_path = sender_address; /* In case not previously set */
8390 /* Write the original email out */
8391 /*XXX no checking for failure! buggy! */
8392 transport_write_message(&tctx, 0);
8395 fprintf(f,"\n--%s--\n", bound);
8399 /* Close and wait for child process to complete, without a timeout.
8400 If there's an error, don't update the count. */
8403 if (child_close(pid, 0) == 0)
8405 warning_count = count;
8406 update_spool = TRUE; /* Ensure spool rewritten */
8412 /* Clear deliver_domain */
8414 deliver_domain = NULL;
8416 /* If this was a first delivery attempt, unset the first time flag, and
8417 ensure that the spool gets updated. */
8419 if (f.deliver_firsttime)
8421 f.deliver_firsttime = FALSE;
8422 update_spool = TRUE;
8425 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8426 message, unless the message is a local error message (to avoid loops). Then
8427 log the freezing. If the text in "frozen_info" came from a system filter,
8428 it has been escaped into printing characters so as not to mess up log lines.
8429 For the "tell" message, we turn \n back into newline. Also, insert a newline
8430 near the start instead of the ": " string. */
8432 if (f.deliver_freeze)
8434 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8436 uschar *s = string_copy(frozen_info);
8437 uschar *ss = Ustrstr(s, " by the system filter: ");
8448 if (*ss == '\\' && ss[1] == 'n')
8455 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8456 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8460 /* Log freezing just before we update the -H file, to minimize the chance
8461 of a race problem. */
8463 deliver_msglog("*** Frozen%s\n", frozen_info);
8464 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8467 /* If there have been any updates to the non-recipients list, or other things
8468 that get written to the spool, we must now update the spool header file so
8469 that it has the right information for the next delivery attempt. If there
8470 was more than one address being delivered, the header_change update is done
8471 earlier, in case one succeeds and then something crashes. */
8474 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8475 update_spool, f.header_rewritten);
8477 if (update_spool || f.header_rewritten)
8478 /* Panic-dies on error */
8479 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8482 /* Finished with the message log. If the message is complete, it will have
8483 been unlinked or renamed above. */
8485 if (message_logs) (void)fclose(message_log);
8487 /* Now we can close and remove the journal file. Its only purpose is to record
8488 successfully completed deliveries asap so that this information doesn't get
8489 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8490 not serious, as trying it again is not harmful. The journal might not be open
8491 if all addresses were deferred at routing or directing. Nevertheless, we must
8492 remove it if it exists (may have been lying around from a crash during the
8493 previous delivery attempt). We don't remove the journal if a delivery
8494 subprocess failed to pass back delivery information; this is controlled by
8495 the remove_journal flag. When the journal is left, we also don't move the
8496 message off the main spool if frozen and the option is set. It should get moved
8497 at the next attempt, after the journal has been inspected. */
8499 if (journal_fd >= 0) (void)close(journal_fd);
8503 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8505 if (Uunlink(fname) < 0 && errno != ENOENT)
8506 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8509 /* Move the message off the spool if requested */
8511 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8512 if (f.deliver_freeze && move_frozen_messages)
8513 (void)spool_move_message(id, message_subdir, US"", US"F");
8517 /* Closing the data file frees the lock; if the file has been unlinked it
8518 will go away. Otherwise the message becomes available for another process
8521 (void)close(deliver_datafile);
8522 deliver_datafile = -1;
8523 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8524 #ifdef MEASURE_TIMING
8525 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8528 /* It is unlikely that there will be any cached resources, since they are
8529 released after routing, and in the delivery subprocesses. However, it's
8530 possible for an expansion for something afterwards (for example,
8531 expand_check_condition) to do a lookup. We must therefore be sure everything is
8535 acl_where = ACL_WHERE_UNKNOWN;
8544 #ifdef EXIM_TFO_PROBE
8547 f.tcp_fastopen_ok = TRUE;
8553 deliver_get_sender_address (uschar * id)
8556 uschar * new_sender_address,
8557 * save_sender_address;
8558 BOOL save_qr = f.queue_running;
8561 /* make spool_open_datafile non-noisy on fail */
8563 f.queue_running = TRUE;
8565 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8567 deliver_datafile = spool_open_datafile(id);
8568 f.queue_running = save_qr;
8569 if (deliver_datafile < 0)
8572 /* Save and restore the global sender_address. I'm not sure if we should
8573 not save/restore all the other global variables too, because
8574 spool_read_header() may change all of them. But OTOH, when this
8575 deliver_get_sender_address() gets called, the current message is done
8576 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8578 spoolname = string_sprintf("%s-H", id);
8579 save_sender_address = sender_address;
8581 rc = spool_read_header(spoolname, TRUE, TRUE);
8583 new_sender_address = sender_address;
8584 sender_address = save_sender_address;
8586 if (rc != spool_read_OK)
8589 assert(new_sender_address);
8591 (void)close(deliver_datafile);
8592 deliver_datafile = -1;
8594 return new_sender_address;
8600 delivery_re_exec(int exec_type)
8604 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8606 int channel_fd = cutthrough.cctx.sock;
8608 smtp_peer_options = cutthrough.peer_options;
8609 continue_sequence = 0;
8612 if (cutthrough.is_tls)
8616 smtp_peer_options |= OPTION_TLS;
8617 sending_ip_address = cutthrough.snd_ip;
8618 sending_port = cutthrough.snd_port;
8620 where = US"socketpair";
8621 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8625 testharness_pause_ms(150);
8626 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8629 if (pid == 0) /* child: will fork again to totally disconnect */
8631 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8633 /* does not return */
8637 waitpid(pid, NULL, 0);
8638 (void) close(channel_fd); /* release the client socket */
8639 channel_fd = pfd[1];
8643 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8644 cutthrough.host.address, message_id, channel_fd);
8648 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8649 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8651 return; /* compiler quietening; control does not reach here. */
8656 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8657 "delivery re-exec %s failed: %s", where, strerror(errno));
8659 /* Get here if exec_type == CEE_EXEC_EXIT.
8660 Note: this must be _exit(), not exit(). */
8662 _exit(EX_EXECFAILED);
8668 /* End of deliver.c */