1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata {
21 address_item *addrlist; /* chain of addresses */
22 address_item *addr; /* next address data expected for */
23 pid_t pid; /* subprocess pid */
24 int fd; /* pipe fd for getting result from subprocess */
25 int transport_count; /* returned transport count value */
26 BOOL done; /* no more data needed */
27 uschar *msg; /* error message */
28 uschar *return_path; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
34 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item *, uschar *);
40 static void address_done(address_item *, uschar *);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item *addr_defer = NULL;
62 static address_item *addr_failed = NULL;
63 static address_item *addr_fallback = NULL;
64 static address_item *addr_local = NULL;
65 static address_item *addr_new = NULL;
66 static address_item *addr_remote = NULL;
67 static address_item *addr_route = NULL;
68 static address_item *addr_succeed = NULL;
69 static address_item *addr_senddsn = NULL;
71 static FILE *message_log = NULL;
72 static BOOL update_spool;
73 static BOOL remove_journal;
74 static int parcount = 0;
75 static pardata *parlist = NULL;
76 static int return_count;
77 static uschar *frozen_info = US"";
78 static uschar *used_return_path = NULL;
82 /*************************************************
83 * read as much as requested *
84 *************************************************/
86 /* The syscall read(2) doesn't always returns as much as we want. For
87 several reasons it might get less. (Not talking about signals, as syscalls
88 are restartable). When reading from a network or pipe connection the sender
89 might send in smaller chunks, with delays between these chunks. The read(2)
90 may return such a chunk.
92 The more the writer writes and the smaller the pipe between write and read is,
93 the more we get the chance of reading leass than requested. (See bug 2130)
95 This function read(2)s until we got all the data we *requested*.
97 Note: This function may block. Use it only if you're sure about the
98 amount of data you will get.
101 fd the file descriptor to read from
102 buffer pointer to a buffer of size len
103 len the requested(!) amount of bytes
105 Returns: the amount of bytes read
108 readn(int fd, void * buffer, size_t len)
110 uschar * next = buffer;
111 uschar * end = next + len;
115 ssize_t got = read(fd, next, end - next);
117 /* I'm not sure if there are signals that can interrupt us,
118 for now I assume the worst */
119 if (got == -1 && errno == EINTR) continue;
120 if (got <= 0) return next - US buffer;
128 /*************************************************
129 * Make a new address item *
130 *************************************************/
132 /* This function gets the store and initializes with default values. The
133 transport_return value defaults to DEFER, so that any unexpected failure to
134 deliver does not wipe out the message. The default unique string is set to a
135 copy of the address, so that its domain can be lowercased.
138 address the RFC822 address string
139 copy force a copy of the address
141 Returns: a pointer to an initialized address_item
145 deliver_make_addr(uschar *address, BOOL copy)
147 address_item *addr = store_get(sizeof(address_item), FALSE);
148 *addr = address_defaults;
149 if (copy) address = string_copy(address);
150 addr->address = address;
151 addr->unique = string_copy(address);
158 /*************************************************
159 * Set expansion values for an address *
160 *************************************************/
162 /* Certain expansion variables are valid only when handling an address or
163 address list. This function sets them up or clears the values, according to its
167 addr the address in question, or NULL to clear values
172 deliver_set_expansions(address_item *addr)
176 const uschar ***p = address_expansions;
177 while (*p) **p++ = NULL;
181 /* Exactly what gets set depends on whether there is one or more addresses, and
182 what they contain. These first ones are always set, taking their values from
183 the first address. */
185 if (!addr->host_list)
187 deliver_host = deliver_host_address = US"";
188 deliver_host_port = 0;
192 deliver_host = addr->host_list->name;
193 deliver_host_address = addr->host_list->address;
194 deliver_host_port = addr->host_list->port;
197 deliver_recipients = addr;
198 deliver_address_data = addr->prop.address_data;
199 deliver_domain_data = addr->prop.domain_data;
200 deliver_localpart_data = addr->prop.localpart_data;
201 router_var = addr->prop.variables;
203 /* These may be unset for multiple addresses */
205 deliver_domain = addr->domain;
206 self_hostname = addr->self_hostname;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver = 1; /* deliver by default */
210 bmi_alt_location = NULL;
211 bmi_base64_verdict = NULL;
212 bmi_base64_tracker_verdict = NULL;
215 /* If there's only one address we can set everything. */
219 address_item *addr_orig;
221 deliver_localpart = addr->local_part;
222 deliver_localpart_prefix = addr->prefix;
223 deliver_localpart_suffix = addr->suffix;
225 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
226 deliver_domain_orig = addr_orig->domain;
228 /* Re-instate any prefix and suffix in the original local part. In all
229 normal cases, the address will have a router associated with it, and we can
230 choose the caseful or caseless version accordingly. However, when a system
231 filter sets up a pipe, file, or autoreply delivery, no router is involved.
232 In this case, though, there won't be any prefix or suffix to worry about. */
234 deliver_localpart_orig = !addr_orig->router
235 ? addr_orig->local_part
236 : addr_orig->router->caseful_local_part
237 ? addr_orig->cc_local_part
238 : addr_orig->lc_local_part;
240 /* If there's a parent, make its domain and local part available, and if
241 delivering to a pipe or file, or sending an autoreply, get the local
242 part from the parent. For pipes and files, put the pipe or file string
243 into address_pipe and address_file. */
247 deliver_domain_parent = addr->parent->domain;
248 deliver_localpart_parent = !addr->parent->router
249 ? addr->parent->local_part
250 : addr->parent->router->caseful_local_part
251 ? addr->parent->cc_local_part
252 : addr->parent->lc_local_part;
254 /* File deliveries have their own flag because they need to be picked out
255 as special more often. */
257 if (testflag(addr, af_pfr))
259 if (testflag(addr, af_file)) address_file = addr->local_part;
260 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
261 deliver_localpart = addr->parent->local_part;
262 deliver_localpart_prefix = addr->parent->prefix;
263 deliver_localpart_suffix = addr->parent->suffix;
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 /* Set expansion variables related to Brightmail AntiSpam */
269 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
270 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
271 /* get message delivery status (0 - don't deliver | 1 - deliver) */
272 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
273 /* if message is to be delivered, get eventual alternate location */
274 if (bmi_deliver == 1)
275 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
280 /* For multiple addresses, don't set local part, and leave the domain and
281 self_hostname set only if it is the same for all of them. It is possible to
282 have multiple pipe and file addresses, but only when all addresses have routed
283 to the same pipe or file. */
287 if (testflag(addr, af_pfr))
289 if (testflag(addr, af_file)) address_file = addr->local_part;
290 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
292 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
294 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
295 deliver_domain = NULL;
297 && ( !addr2->self_hostname
298 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
300 self_hostname = NULL;
301 if (!deliver_domain && !self_hostname) break;
309 /*************************************************
310 * Open a msglog file *
311 *************************************************/
313 /* This function is used both for normal message logs, and for files in the
314 msglog directory that are used to catch output from pipes. Try to create the
315 directory if it does not exist. From release 4.21, normal message logs should
316 be created when the message is received.
318 Called from deliver_message(), can be operating as root.
321 filename the file name
322 mode the mode required
323 error used for saying what failed
325 Returns: a file descriptor, or -1 (with errno set)
329 open_msglog_file(uschar *filename, int mode, uschar **error)
331 if (Ustrstr(filename, US"/../"))
332 log_write(0, LOG_MAIN|LOG_PANIC,
333 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
335 for (int i = 2; i > 0; i--)
337 int fd = Uopen(filename,
344 O_WRONLY|O_APPEND|O_CREAT, mode);
347 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
348 function is called as root). Double check the mode, because the group setting
349 doesn't always get set automatically. */
352 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
354 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
359 if (fchmod(fd, mode) < 0)
369 (void)directory_make(spool_directory,
370 spool_sname(US"msglog", message_subdir),
371 MSGLOG_DIRECTORY_MODE, TRUE);
374 *error = US"create or open";
381 /*************************************************
382 * Write to msglog if required *
383 *************************************************/
385 /* Write to the message log, if configured. This function may also be called
389 format a string format
395 deliver_msglog(const char *format, ...)
398 if (!message_logs) return;
399 va_start(ap, format);
400 vfprintf(message_log, format, ap);
408 /*************************************************
409 * Replicate status for batch *
410 *************************************************/
412 /* When a transport handles a batch of addresses, it may treat them
413 individually, or it may just put the status in the first one, and return FALSE,
414 requesting that the status be copied to all the others externally. This is the
415 replication function. As well as the status, it copies the transport pointer,
416 which may have changed if appendfile passed the addresses on to a different
419 Argument: pointer to the first address in a chain
424 replicate_status(address_item *addr)
426 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
428 addr2->transport = addr->transport;
429 addr2->transport_return = addr->transport_return;
430 addr2->basic_errno = addr->basic_errno;
431 addr2->more_errno = addr->more_errno;
432 addr2->delivery_usec = addr->delivery_usec;
433 addr2->special_action = addr->special_action;
434 addr2->message = addr->message;
435 addr2->user_message = addr->user_message;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
459 one points to the first host list
460 two points to the second host list
462 Returns: TRUE if the lists refer to the same host set
466 same_hosts(host_item *one, host_item *two)
470 if (Ustrcmp(one->name, two->name) != 0)
473 host_item *end_one = one;
474 host_item *end_two = two;
476 /* Batch up only if there was no MX and the list was not randomized */
478 if (mx == MX_NONE) return FALSE;
480 /* Find the ends of the shortest sequence of identical MX values */
482 while ( end_one->next && end_one->next->mx == mx
483 && end_two->next && end_two->next->mx == mx)
485 end_one = end_one->next;
486 end_two = end_two->next;
489 /* If there aren't any duplicates, there's no match. */
491 if (end_one == one) return FALSE;
493 /* For each host in the 'one' sequence, check that it appears in the 'two'
494 sequence, returning FALSE if not. */
499 for (hi = two; hi != end_two->next; hi = hi->next)
500 if (Ustrcmp(one->name, hi->name) == 0) break;
501 if (hi == end_two->next) return FALSE;
502 if (one == end_one) break;
506 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
507 Ensure both are pointing at the last host, and carry on as for equality. */
512 /* if the names matched but ports do not, mismatch */
513 else if (one->port != two->port)
522 /* True if both are NULL */
529 /*************************************************
530 * Compare header lines *
531 *************************************************/
533 /* This function is given two pointers to chains of header items, and it yields
534 TRUE if they are the same header texts in the same order.
537 one points to the first header list
538 two points to the second header list
540 Returns: TRUE if the lists refer to the same header set
544 same_headers(header_line *one, header_line *two)
546 for (;; one = one->next, two = two->next)
548 if (one == two) return TRUE; /* Includes the case where both NULL */
549 if (!one || !two) return FALSE;
550 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
556 /*************************************************
557 * Compare string settings *
558 *************************************************/
560 /* This function is given two pointers to strings, and it returns
561 TRUE if they are the same pointer, or if the two strings are the same.
564 one points to the first string
565 two points to the second string
567 Returns: TRUE or FALSE
571 same_strings(uschar *one, uschar *two)
573 if (one == two) return TRUE; /* Includes the case where both NULL */
574 if (!one || !two) return FALSE;
575 return (Ustrcmp(one, two) == 0);
580 /*************************************************
581 * Compare uid/gid for addresses *
582 *************************************************/
584 /* This function is given a transport and two addresses. It yields TRUE if the
585 uid/gid/initgroups settings for the two addresses are going to be the same when
590 addr1 the first address
591 addr2 the second address
593 Returns: TRUE or FALSE
597 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
599 if ( !tp->uid_set && !tp->expand_uid
600 && !tp->deliver_as_creator
601 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
602 || ( testflag(addr1, af_uid_set)
603 && ( addr1->uid != addr2->uid
604 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
608 if ( !tp->gid_set && !tp->expand_gid
609 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
610 || ( testflag(addr1, af_gid_set)
611 && addr1->gid != addr2->gid
621 /*************************************************
622 * Record that an address is complete *
623 *************************************************/
625 /* This function records that an address is complete. This is straightforward
626 for most addresses, where the unique address is just the full address with the
627 domain lower cased. For homonyms (addresses that are the same as one of their
628 ancestors) their are complications. Their unique addresses have \x\ prepended
629 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
632 Exim used to record the unique addresses of homonyms as "complete". This,
633 however, fails when the pattern of redirection varies over time (e.g. if taking
634 unseen copies at only some times of day) because the prepended numbers may vary
635 from one delivery run to the next. This problem is solved by never recording
636 prepended unique addresses as complete. Instead, when a homonymic address has
637 actually been delivered via a transport, we record its basic unique address
638 followed by the name of the transport. This is checked in subsequent delivery
639 runs whenever an address is routed to a transport.
641 If the completed address is a top-level one (has no parent, which means it
642 cannot be homonymic) we also add the original address to the non-recipients
643 tree, so that it gets recorded in the spool file and therefore appears as
644 "done" in any spool listings. The original address may differ from the unique
645 address in the case of the domain.
647 Finally, this function scans the list of duplicates, marks as done any that
648 match this address, and calls child_done() for their ancestors.
651 addr address item that has been completed
652 now current time as a string
658 address_done(address_item *addr, uschar *now)
660 update_spool = TRUE; /* Ensure spool gets updated */
662 /* Top-level address */
666 tree_add_nonrecipient(addr->unique);
667 tree_add_nonrecipient(addr->address);
670 /* Homonymous child address */
672 else if (testflag(addr, af_homonym))
675 tree_add_nonrecipient(
676 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
679 /* Non-homonymous child address */
681 else tree_add_nonrecipient(addr->unique);
683 /* Check the list of duplicate addresses and ensure they are now marked
686 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
687 if (Ustrcmp(addr->unique, dup->unique) == 0)
689 tree_add_nonrecipient(dup->unique);
690 child_done(dup, now);
697 /*************************************************
698 * Decrease counts in parents and mark done *
699 *************************************************/
701 /* This function is called when an address is complete. If there is a parent
702 address, its count of children is decremented. If there are still other
703 children outstanding, the function exits. Otherwise, if the count has become
704 zero, address_done() is called to mark the parent and its duplicates complete.
705 Then loop for any earlier ancestors.
708 addr points to the completed address item
709 now the current time as a string, for writing to the message log
715 child_done(address_item *addr, uschar *now)
722 if (--addr->child_count > 0) return; /* Incomplete parent */
723 address_done(addr, now);
725 /* Log the completion of all descendents only when there is no ancestor with
726 the same original address. */
728 for (aa = addr->parent; aa; aa = aa->parent)
729 if (Ustrcmp(aa->address, addr->address) == 0) break;
732 deliver_msglog("%s %s: children all complete\n", now, addr->address);
733 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
739 /*************************************************
740 * Delivery logging support functions *
741 *************************************************/
743 /* The LOGGING() checks in d_log_interface() are complicated for backwards
744 compatibility. When outgoing interface logging was originally added, it was
745 conditional on just incoming_interface (which is off by default). The
746 outgoing_interface option is on by default to preserve this behaviour, but
747 you can enable incoming_interface and disable outgoing_interface to get I=
748 fields on incoming lines only.
752 addr The address to be logged
754 Returns: New value for s
758 d_log_interface(gstring * g)
760 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
761 && sending_ip_address)
763 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
764 if (LOGGING(outgoing_port))
765 g = string_fmt_append(g, ":%d", sending_port);
773 d_hostlog(gstring * g, address_item * addr)
775 host_item * h = addr->host_used;
777 g = string_append(g, 2, US" H=", h->name);
779 if (LOGGING(dnssec) && h->dnssec == DS_YES)
780 g = string_catn(g, US" DS", 3);
782 g = string_append(g, 3, US" [", h->address, US"]");
784 if (LOGGING(outgoing_port))
785 g = string_fmt_append(g, ":%d", h->port);
788 if (LOGGING(proxy) && proxy_local_address)
790 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
791 if (LOGGING(outgoing_port))
792 g = string_fmt_append(g, ":%d", proxy_local_port);
796 g = d_log_interface(g);
798 if (testflag(addr, af_tcp_fastopen))
799 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
810 d_tlslog(gstring * g, address_item * addr)
812 if (LOGGING(tls_cipher) && addr->cipher)
814 g = string_append(g, 2, US" X=", addr->cipher);
815 #ifdef EXPERIMENTAL_TLS_RESUME
816 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
817 g = string_catn(g, US"*", 1);
820 if (LOGGING(tls_certificate_verified) && addr->cipher)
821 g = string_append(g, 2, US" CV=",
822 testflag(addr, af_cert_verified)
825 testflag(addr, af_dane_verified)
831 if (LOGGING(tls_peerdn) && addr->peerdn)
832 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
840 #ifndef DISABLE_EVENT
842 event_raise(uschar * action, const uschar * event, uschar * ev_data)
848 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
850 action, deliver_host_address);
853 event_data = ev_data;
855 if (!(s = expand_string(action)) && *expand_string_message)
856 log_write(0, LOG_MAIN|LOG_PANIC,
857 "failed to expand event_action %s in %s: %s\n",
858 event, transport_name ? transport_name : US"main", expand_string_message);
860 event_name = event_data = NULL;
862 /* If the expansion returns anything but an empty string, flag for
863 the caller to modify his normal processing
868 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
877 msg_event_raise(const uschar * event, const address_item * addr)
879 const uschar * save_domain = deliver_domain;
880 uschar * save_local = deliver_localpart;
881 const uschar * save_host = deliver_host;
882 const uschar * save_address = deliver_host_address;
883 const int save_port = deliver_host_port;
885 router_name = addr->router ? addr->router->name : NULL;
886 deliver_domain = addr->domain;
887 deliver_localpart = addr->local_part;
888 deliver_host = addr->host_used ? addr->host_used->name : NULL;
890 if (!addr->transport)
892 if (Ustrcmp(event, "msg:fail:delivery") == 0)
894 /* An address failed with no transport involved. This happens when
895 a filter was used which triggered a fail command (in such a case
896 a transport isn't needed). Convert it to an internal fail event. */
898 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
903 transport_name = addr->transport->name;
905 (void) event_raise(addr->transport->event_action, event,
907 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
908 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
909 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
910 ? addr->message : NULL);
913 deliver_host_port = save_port;
914 deliver_host_address = save_address;
915 deliver_host = save_host;
916 deliver_localpart = save_local;
917 deliver_domain = save_domain;
918 router_name = transport_name = NULL;
920 #endif /*DISABLE_EVENT*/
924 /******************************************************************************/
927 /*************************************************
928 * Generate local prt for logging *
929 *************************************************/
931 /* This function is a subroutine for use in string_log_address() below.
934 addr the address being logged
935 yield the current dynamic buffer pointer
937 Returns: the new value of the buffer pointer
941 string_get_localpart(address_item * addr, gstring * yield)
946 if (testflag(addr, af_include_affixes) && s)
949 if (testflag(addr, af_utf8_downcvt))
950 s = string_localpart_utf8_to_alabel(s, NULL);
952 yield = string_cat(yield, s);
955 s = addr->local_part;
957 if (testflag(addr, af_utf8_downcvt))
958 s = string_localpart_utf8_to_alabel(s, NULL);
960 yield = string_cat(yield, s);
963 if (testflag(addr, af_include_affixes) && s)
966 if (testflag(addr, af_utf8_downcvt))
967 s = string_localpart_utf8_to_alabel(s, NULL);
969 yield = string_cat(yield, s);
976 /*************************************************
977 * Generate log address list *
978 *************************************************/
980 /* This function generates a list consisting of an address and its parents, for
981 use in logging lines. For saved onetime aliased addresses, the onetime parent
982 field is used. If the address was delivered by a transport with rcpt_include_
983 affixes set, the af_include_affixes bit will be set in the address. In that
984 case, we include the affixes here too.
987 g points to growing-string struct
988 addr bottom (ultimate) address
989 all_parents if TRUE, include all parents
990 success TRUE for successful delivery
992 Returns: a growable string in dynamic store
996 string_log_address(gstring * g,
997 address_item *addr, BOOL all_parents, BOOL success)
999 BOOL add_topaddr = TRUE;
1000 address_item *topaddr;
1002 /* Find the ultimate parent */
1004 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1006 /* We start with just the local part for pipe, file, and reply deliveries, and
1007 for successful local deliveries from routers that have the log_as_local flag
1008 set. File deliveries from filters can be specified as non-absolute paths in
1009 cases where the transport is going to complete the path. If there is an error
1010 before this happens (expansion failure) the local part will not be updated, and
1011 so won't necessarily look like a path. Add extra text for this case. */
1013 if ( testflag(addr, af_pfr)
1015 && addr->router && addr->router->log_as_local
1016 && addr->transport && addr->transport->info->local
1019 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1020 g = string_catn(g, CUS"save ", 5);
1021 g = string_get_localpart(addr, g);
1024 /* Other deliveries start with the full address. It we have split it into local
1025 part and domain, use those fields. Some early failures can happen before the
1026 splitting is done; in those cases use the original field. */
1031 int off = g->ptr; /* start of the "full address" */
1033 if (addr->local_part)
1036 g = string_get_localpart(addr, g);
1037 g = string_catn(g, US"@", 1);
1040 if (testflag(addr, af_utf8_downcvt))
1041 s = string_localpart_utf8_to_alabel(s, NULL);
1043 g = string_cat(g, s);
1046 g = string_cat(g, addr->address);
1048 /* If the address we are going to print is the same as the top address,
1049 and all parents are not being included, don't add on the top address. First
1050 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1051 on the local parts. */
1053 cmp = g->s + off; /* only now, as rebuffer likely done */
1054 string_from_gstring(g); /* ensure nul-terminated */
1055 if ( strcmpic(cmp, topaddr->address) == 0
1056 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1057 && !addr->onetime_parent
1058 && (!all_parents || !addr->parent || addr->parent == topaddr)
1060 add_topaddr = FALSE;
1063 /* If all parents are requested, or this is a local pipe/file/reply, and
1064 there is at least one intermediate parent, show it in brackets, and continue
1065 with all of them if all are wanted. */
1067 if ( (all_parents || testflag(addr, af_pfr))
1069 && addr->parent != topaddr)
1072 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1074 g = string_catn(g, s, 2);
1075 g = string_cat (g, addr2->address);
1076 if (!all_parents) break;
1079 g = string_catn(g, US")", 1);
1082 /* Add the top address if it is required */
1085 g = string_append(g, 3,
1087 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1096 timesince(struct timeval * diff, struct timeval * then)
1098 gettimeofday(diff, NULL);
1099 diff->tv_sec -= then->tv_sec;
1100 if ((diff->tv_usec -= then->tv_usec) < 0)
1103 diff->tv_usec += 1000*1000;
1110 string_timediff(struct timeval * diff)
1112 static uschar buf[sizeof("0.000s")];
1114 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1115 return readconf_printtime((int)diff->tv_sec);
1117 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1123 string_timesince(struct timeval * then)
1125 struct timeval diff;
1127 timesince(&diff, then);
1128 return string_timediff(&diff);
1131 /******************************************************************************/
1135 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1136 this is a nonstandard call; no two-character delivery flag is written
1137 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1140 flags passed to log_write()
1143 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1145 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1148 /* Log the delivery on the main log. We use an extensible string to build up
1149 the log line, and reset the store afterwards. Remote deliveries should always
1150 have a pointer to the host item that succeeded; local deliveries can have a
1151 pointer to a single host item in their host list, for use by the transport. */
1153 #ifndef DISABLE_EVENT
1154 /* presume no successful remote delivery */
1155 lookup_dnssec_authenticated = NULL;
1158 reset_point = store_mark();
1159 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1162 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1165 g->s[0] = logchar; g->ptr = 1;
1166 g = string_catn(g, US"> ", 2);
1168 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1170 if (LOGGING(sender_on_delivery) || msg)
1171 g = string_append(g, 3, US" F=<",
1173 testflag(addr, af_utf8_downcvt)
1174 ? string_address_utf8_to_alabel(sender_address, NULL)
1181 g = string_append(g, 2, US" Q=", queue_name);
1183 #ifdef EXPERIMENTAL_SRS
1184 if(addr->prop.srs_sender)
1185 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1188 /* You might think that the return path must always be set for a successful
1189 delivery; indeed, I did for some time, until this statement crashed. The case
1190 when it is not set is for a delivery to /dev/null which is optimised by not
1191 being run at all. */
1193 if (used_return_path && LOGGING(return_path_on_delivery))
1194 g = string_append(g, 3, US" P=<", used_return_path, US">");
1197 g = string_append(g, 2, US" ", msg);
1199 /* For a delivery from a system filter, there may not be a router */
1201 g = string_append(g, 2, US" R=", addr->router->name);
1203 g = string_append(g, 2, US" T=", addr->transport->name);
1205 if (LOGGING(delivery_size))
1206 g = string_fmt_append(g, " S=%d", transport_count);
1208 /* Local delivery */
1210 if (addr->transport->info->local)
1212 if (addr->host_list)
1213 g = string_append(g, 2, US" H=", addr->host_list->name);
1214 g = d_log_interface(g);
1215 if (addr->shadow_message)
1216 g = string_cat(g, addr->shadow_message);
1219 /* Remote delivery */
1223 if (addr->host_used)
1225 g = d_hostlog(g, addr);
1226 if (continue_sequence > 1)
1227 g = string_catn(g, US"*", 1);
1229 #ifndef DISABLE_EVENT
1230 deliver_host_address = addr->host_used->address;
1231 deliver_host_port = addr->host_used->port;
1232 deliver_host = addr->host_used->name;
1234 /* DNS lookup status */
1235 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1236 : addr->host_used->dnssec==DS_NO ? US"no"
1242 g = d_tlslog(g, addr);
1245 if (addr->authenticator)
1247 g = string_append(g, 2, US" A=", addr->authenticator);
1250 g = string_append(g, 2, US":", addr->auth_id);
1251 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1252 g = string_append(g, 2, US":", addr->auth_sndr);
1256 if (LOGGING(pipelining))
1258 if (testflag(addr, af_pipelining))
1259 g = string_catn(g, US" L", 2);
1260 #ifdef SUPPORT_PIPE_CONNECT
1261 if (testflag(addr, af_early_pipe))
1262 g = string_catn(g, US"*", 1);
1266 #ifndef DISABLE_PRDR
1267 if (testflag(addr, af_prdr_used))
1268 g = string_catn(g, US" PRDR", 5);
1271 if (testflag(addr, af_chunking_used))
1272 g = string_catn(g, US" K", 2);
1275 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1277 if ( LOGGING(smtp_confirmation)
1279 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1282 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1283 uschar *p = big_buffer;
1284 uschar *ss = addr->message;
1286 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1288 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1293 g = string_append(g, 2, US" C=", big_buffer);
1296 /* Time on queue and actual time taken to deliver */
1298 if (LOGGING(queue_time))
1299 g = string_append(g, 2, US" QT=",
1300 string_timesince(&received_time));
1302 if (LOGGING(deliver_time))
1304 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1305 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1308 /* string_cat() always leaves room for the terminator. Release the
1309 store we used to build the line after writing it. */
1311 log_write(0, flags, "%s", string_from_gstring(g));
1313 #ifndef DISABLE_EVENT
1314 if (!msg) msg_event_raise(US"msg:delivery", addr);
1317 store_reset(reset_point);
1324 deferral_log(address_item * addr, uschar * now,
1325 int logflags, uschar * driver_name, uschar * driver_kind)
1327 rmark reset_point = store_mark();
1328 gstring * g = string_get(256);
1330 /* Build up the line that is used for both the message log and the main
1333 /* Create the address string for logging. Must not do this earlier, because
1334 an OK result may be changed to FAIL when a pipe returns text. */
1336 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1339 g = string_append(g, 2, US" Q=", queue_name);
1341 /* Either driver_name contains something and driver_kind contains
1342 " router" or " transport" (note the leading space), or driver_name is
1343 a null string and driver_kind contains "routing" without the leading
1344 space, if all routing has been deferred. When a domain has been held,
1345 so nothing has been done at all, both variables contain null strings. */
1349 if (driver_kind[1] == 't' && addr->router)
1350 g = string_append(g, 2, US" R=", addr->router->name);
1351 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1353 else if (driver_kind)
1354 g = string_append(g, 2, US" ", driver_kind);
1356 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1358 if (addr->basic_errno > 0)
1359 g = string_append(g, 2, US": ",
1360 US strerror(addr->basic_errno));
1362 if (addr->host_used)
1364 g = string_append(g, 5,
1365 US" H=", addr->host_used->name,
1366 US" [", addr->host_used->address, US"]");
1367 if (LOGGING(outgoing_port))
1369 int port = addr->host_used->port;
1370 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1375 g = string_append(g, 2, US": ", addr->message);
1377 (void) string_from_gstring(g);
1379 /* Log the deferment in the message log, but don't clutter it
1380 up with retry-time defers after the first delivery attempt. */
1382 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1383 deliver_msglog("%s %s\n", now, g->s);
1385 /* Write the main log and reset the store.
1386 For errors of the type "retry time not reached" (also remotes skipped
1387 on queue run), logging is controlled by L_retry_defer. Note that this kind
1388 of error number is negative, and all the retry ones are less than any
1392 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1395 store_reset(reset_point);
1402 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1404 rmark reset_point = store_mark();
1405 gstring * g = string_get(256);
1407 #ifndef DISABLE_EVENT
1408 /* Message failures for which we will send a DSN get their event raised
1409 later so avoid doing it here. */
1411 if ( !addr->prop.ignore_error
1412 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1414 msg_event_raise(US"msg:fail:delivery", addr);
1417 /* Build up the log line for the message and main logs */
1419 /* Create the address string for logging. Must not do this earlier, because
1420 an OK result may be changed to FAIL when a pipe returns text. */
1422 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1424 if (LOGGING(sender_on_delivery))
1425 g = string_append(g, 3, US" F=<", sender_address, US">");
1428 g = string_append(g, 2, US" Q=", queue_name);
1430 /* Return path may not be set if no delivery actually happened */
1432 if (used_return_path && LOGGING(return_path_on_delivery))
1433 g = string_append(g, 3, US" P=<", used_return_path, US">");
1436 g = string_append(g, 2, US" R=", addr->router->name);
1437 if (addr->transport)
1438 g = string_append(g, 2, US" T=", addr->transport->name);
1440 if (addr->host_used)
1441 g = d_hostlog(g, addr);
1444 g = d_tlslog(g, addr);
1447 if (addr->basic_errno > 0)
1448 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1451 g = string_append(g, 2, US": ", addr->message);
1453 (void) string_from_gstring(g);
1455 /* Do the logging. For the message log, "routing failed" for those cases,
1456 just to make it clearer. */
1459 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1461 deliver_msglog("%s %s\n", now, g->s);
1463 log_write(0, LOG_MAIN, "** %s", g->s);
1465 store_reset(reset_point);
1471 /*************************************************
1472 * Actions at the end of handling an address *
1473 *************************************************/
1475 /* This is a function for processing a single address when all that can be done
1476 with it has been done.
1479 addr points to the address block
1480 result the result of the delivery attempt
1481 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1482 driver_type indicates which type of driver (transport, or router) was last
1483 to process the address
1484 logchar '=' or '-' for use when logging deliveries with => or ->
1490 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1493 uschar *now = tod_stamp(tod_log);
1494 uschar *driver_kind = NULL;
1495 uschar *driver_name = NULL;
1497 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1499 /* Set up driver kind and name for logging. Disable logging if the router or
1500 transport has disabled it. */
1502 if (driver_type == EXIM_DTYPE_TRANSPORT)
1504 if (addr->transport)
1506 driver_name = addr->transport->name;
1507 driver_kind = US" transport";
1508 f.disable_logging = addr->transport->disable_logging;
1510 else driver_kind = US"transporting";
1512 else if (driver_type == EXIM_DTYPE_ROUTER)
1516 driver_name = addr->router->name;
1517 driver_kind = US" router";
1518 f.disable_logging = addr->router->disable_logging;
1520 else driver_kind = US"routing";
1523 /* If there's an error message set, ensure that it contains only printing
1524 characters - it should, but occasionally things slip in and this at least
1525 stops the log format from getting wrecked. We also scan the message for an LDAP
1526 expansion item that has a password setting, and flatten the password. This is a
1527 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1528 malformed, it won't ever have gone near LDAP.) */
1532 const uschar * s = string_printing(addr->message);
1534 /* deconst cast ok as string_printing known to have alloc'n'copied */
1535 addr->message = expand_hide_passwords(US s);
1538 /* If we used a transport that has one of the "return_output" options set, and
1539 if it did in fact generate some output, then for return_output we treat the
1540 message as failed if it was not already set that way, so that the output gets
1541 returned to the sender, provided there is a sender to send it to. For
1542 return_fail_output, do this only if the delivery failed. Otherwise we just
1543 unlink the file, and remove the name so that if the delivery failed, we don't
1544 try to send back an empty or unwanted file. The log_output options operate only
1545 on a non-empty file.
1547 In any case, we close the message file, because we cannot afford to leave a
1548 file-descriptor for one address while processing (maybe very many) others. */
1550 if (addr->return_file >= 0 && addr->return_filename)
1552 BOOL return_output = FALSE;
1553 struct stat statbuf;
1554 (void)EXIMfsync(addr->return_file);
1556 /* If there is no output, do nothing. */
1558 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1560 transport_instance *tb = addr->transport;
1562 /* Handle logging options */
1565 || result == FAIL && tb->log_fail_output
1566 || result == DEFER && tb->log_defer_output
1570 FILE *f = Ufopen(addr->return_filename, "rb");
1572 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1573 "from %s transport: %s", addr->return_filename, tb->name,
1576 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1578 uschar *p = big_buffer + Ustrlen(big_buffer);
1580 while (p > big_buffer && isspace(p[-1])) p--;
1582 sp = string_printing(big_buffer);
1583 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1584 addr->address, tb->name, sp);
1589 /* Handle returning options, but only if there is an address to return
1592 if (sender_address[0] != 0 || addr->prop.errors_address)
1593 if (tb->return_output)
1595 addr->transport_return = result = FAIL;
1596 if (addr->basic_errno == 0 && !addr->message)
1597 addr->message = US"return message generated";
1598 return_output = TRUE;
1601 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1604 /* Get rid of the file unless it might be returned, but close it in
1609 Uunlink(addr->return_filename);
1610 addr->return_filename = NULL;
1611 addr->return_file = -1;
1614 (void)close(addr->return_file);
1617 /* The success case happens only after delivery by a transport. */
1621 addr->next = addr_succeed;
1622 addr_succeed = addr;
1624 /* Call address_done() to ensure that we don't deliver to this address again,
1625 and write appropriate things to the message log. If it is a child address, we
1626 call child_done() to scan the ancestors and mark them complete if this is the
1627 last child to complete. */
1629 address_done(addr, now);
1630 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1633 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1634 driver_name, driver_kind);
1637 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1638 addr->parent->address, driver_name, driver_kind);
1639 child_done(addr, now);
1642 /* Certificates for logging (via events) */
1644 tls_out.ourcert = addr->ourcert;
1645 addr->ourcert = NULL;
1646 tls_out.peercert = addr->peercert;
1647 addr->peercert = NULL;
1649 tls_out.cipher = addr->cipher;
1650 tls_out.peerdn = addr->peerdn;
1651 tls_out.ocsp = addr->ocsp;
1652 # ifdef SUPPORT_DANE
1653 tls_out.dane_verified = testflag(addr, af_dane_verified);
1657 delivery_log(LOG_MAIN, addr, logchar, NULL);
1660 tls_free_cert(&tls_out.ourcert);
1661 tls_free_cert(&tls_out.peercert);
1662 tls_out.cipher = NULL;
1663 tls_out.peerdn = NULL;
1664 tls_out.ocsp = OCSP_NOT_REQ;
1665 # ifdef SUPPORT_DANE
1666 tls_out.dane_verified = FALSE;
1672 /* Soft failure, or local delivery process failed; freezing may be
1675 else if (result == DEFER || result == PANIC)
1677 if (result == PANIC) logflags |= LOG_PANIC;
1679 /* This puts them on the chain in reverse order. Do not change this, because
1680 the code for handling retries assumes that the one with the retry
1681 information is last. */
1683 addr->next = addr_defer;
1686 /* The only currently implemented special action is to freeze the
1687 message. Logging of this is done later, just before the -H file is
1690 if (addr->special_action == SPECIAL_FREEZE)
1692 f.deliver_freeze = TRUE;
1693 deliver_frozen_at = time(NULL);
1694 update_spool = TRUE;
1697 /* If doing a 2-stage queue run, we skip writing to either the message
1698 log or the main log for SMTP defers. */
1700 if (!f.queue_2stage || addr->basic_errno != 0)
1701 deferral_log(addr, now, logflags, driver_name, driver_kind);
1705 /* Hard failure. If there is an address to which an error message can be sent,
1706 put this address on the failed list. If not, put it on the deferred list and
1707 freeze the mail message for human attention. The latter action can also be
1708 explicitly requested by a router or transport. */
1712 /* If this is a delivery error, or a message for which no replies are
1713 wanted, and the message's age is greater than ignore_bounce_errors_after,
1714 force the af_ignore_error flag. This will cause the address to be discarded
1715 later (with a log entry). */
1717 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1718 addr->prop.ignore_error = TRUE;
1720 /* Freeze the message if requested, or if this is a bounce message (or other
1721 message with null sender) and this address does not have its own errors
1722 address. However, don't freeze if errors are being ignored. The actual code
1723 to ignore occurs later, instead of sending a message. Logging of freezing
1724 occurs later, just before writing the -H file. */
1726 if ( !addr->prop.ignore_error
1727 && ( addr->special_action == SPECIAL_FREEZE
1728 || (sender_address[0] == 0 && !addr->prop.errors_address)
1731 frozen_info = addr->special_action == SPECIAL_FREEZE
1733 : f.sender_local && !f.local_error_message
1734 ? US" (message created with -f <>)"
1735 : US" (delivery error message)";
1736 f.deliver_freeze = TRUE;
1737 deliver_frozen_at = time(NULL);
1738 update_spool = TRUE;
1740 /* The address is put on the defer rather than the failed queue, because
1741 the message is being retained. */
1743 addr->next = addr_defer;
1747 /* Don't put the address on the nonrecipients tree yet; wait until an
1748 error message has been successfully sent. */
1752 addr->next = addr_failed;
1756 failure_log(addr, driver_name ? NULL : driver_kind, now);
1759 /* Ensure logging is turned on again in all cases */
1761 f.disable_logging = FALSE;
1767 /*************************************************
1768 * Address-independent error *
1769 *************************************************/
1771 /* This function is called when there's an error that is not dependent on a
1772 particular address, such as an expansion string failure. It puts the error into
1773 all the addresses in a batch, logs the incident on the main and panic logs, and
1774 clears the expansions. It is mostly called from local_deliver(), but can be
1775 called for a remote delivery via findugid().
1778 logit TRUE if (MAIN+PANIC) logging required
1779 addr the first of the chain of addresses
1781 format format string for error message, or NULL if already set in addr
1782 ... arguments for the format
1788 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1790 addr->basic_errno = code;
1797 va_start(ap, format);
1798 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1800 addr->message = string_from_gstring(g);
1803 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1805 addr2->basic_errno = code;
1806 addr2->message = addr->message;
1809 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1810 deliver_set_expansions(NULL);
1816 /*************************************************
1817 * Check a "never users" list *
1818 *************************************************/
1820 /* This function is called to check whether a uid is on one of the two "never
1824 uid the uid to be checked
1825 nusers the list to be scanned; the first item in the list is the count
1827 Returns: TRUE if the uid is on the list
1831 check_never_users(uid_t uid, uid_t *nusers)
1833 if (!nusers) return FALSE;
1834 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1840 /*************************************************
1841 * Find uid and gid for a transport *
1842 *************************************************/
1844 /* This function is called for both local and remote deliveries, to find the
1845 uid/gid under which to run the delivery. The values are taken preferentially
1846 from the transport (either explicit or deliver_as_creator), then from the
1847 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1848 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1849 panic error is logged, and the function fails (which normally leads to delivery
1853 addr the address (possibly a chain)
1855 uidp pointer to uid field
1856 gidp pointer to gid field
1857 igfp pointer to the use_initgroups field
1859 Returns: FALSE if failed - error has been set in address(es)
1863 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1867 BOOL gid_set = FALSE;
1869 /* Default initgroups flag comes from the transport */
1871 *igfp = tp->initgroups;
1873 /* First see if there's a gid on the transport, either fixed or expandable.
1874 The expanding function always logs failure itself. */
1881 else if (tp->expand_gid)
1883 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1886 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1892 /* If the transport did not set a group, see if the router did. */
1894 if (!gid_set && testflag(addr, af_gid_set))
1900 /* Pick up a uid from the transport if one is set. */
1902 if (tp->uid_set) *uidp = tp->uid;
1904 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1905 it does not provide a passwd value from which a gid can be taken. */
1907 else if (tp->expand_uid)
1910 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1911 uidp, &(addr->message)))
1913 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1923 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1925 else if (tp->deliver_as_creator)
1927 *uidp = originator_uid;
1930 *gidp = originator_gid;
1935 /* Otherwise see if the address specifies the uid and if so, take it and its
1938 else if (testflag(addr, af_uid_set))
1941 *igfp = testflag(addr, af_initgroups);
1944 /* Nothing has specified the uid - default to the Exim user, and group if the
1957 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1958 defaulting to the Exim uid. In other words, if the configuration has specified
1959 a uid, it must also provide a gid. */
1963 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1964 "%s transport", tp->name);
1968 /* Check that the uid is not on the lists of banned uids that may not be used
1969 for delivery processes. */
1971 nuname = check_never_users(*uidp, never_users)
1973 : check_never_users(*uidp, fixed_never_users)
1974 ? US"fixed_never_users"
1978 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1979 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1991 /*************************************************
1992 * Check the size of a message for a transport *
1993 *************************************************/
1995 /* Checks that the message isn't too big for the selected transport.
1996 This is called only when it is known that the limit is set.
2000 addr the (first) address being delivered
2003 DEFER expansion failed or did not yield an integer
2004 FAIL message too big
2008 check_message_size(transport_instance *tp, address_item *addr)
2013 deliver_set_expansions(addr);
2014 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2015 deliver_set_expansions(NULL);
2017 if (expand_string_message)
2020 addr->message = size_limit == -1
2021 ? string_sprintf("failed to expand message_size_limit "
2022 "in %s transport: %s", tp->name, expand_string_message)
2023 : string_sprintf("invalid message_size_limit "
2024 "in %s transport: %s", tp->name, expand_string_message);
2026 else if (size_limit > 0 && message_size > size_limit)
2030 string_sprintf("message is too big (transport limit = %d)",
2039 /*************************************************
2040 * Transport-time check for a previous delivery *
2041 *************************************************/
2043 /* Check that this base address hasn't previously been delivered to its routed
2044 transport. If it has been delivered, mark it done. The check is necessary at
2045 delivery time in order to handle homonymic addresses correctly in cases where
2046 the pattern of redirection changes between delivery attempts (so the unique
2047 fields change). Non-homonymic previous delivery is detected earlier, at routing
2048 time (which saves unnecessary routing).
2051 addr the address item
2052 testing TRUE if testing wanted only, without side effects
2054 Returns: TRUE if previously delivered by the transport
2058 previously_transported(address_item *addr, BOOL testing)
2060 uschar * s = string_sprintf("%s/%s",
2061 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2063 if (tree_search(tree_nonrecipients, s) != 0)
2065 DEBUG(D_deliver|D_route|D_transport)
2066 debug_printf("%s was previously delivered (%s transport): discarded\n",
2067 addr->address, addr->transport->name);
2068 if (!testing) child_done(addr, tod_stamp(tod_log));
2077 /******************************************************
2078 * Check for a given header in a header string *
2079 ******************************************************/
2081 /* This function is used when generating quota warnings. The configuration may
2082 specify any header lines it likes in quota_warn_message. If certain of them are
2083 missing, defaults are inserted, so we need to be able to test for the presence
2087 hdr the required header name
2088 hstring the header string
2090 Returns: TRUE the header is in the string
2091 FALSE the header is not in the string
2095 contains_header(uschar *hdr, uschar *hstring)
2097 int len = Ustrlen(hdr);
2098 uschar *p = hstring;
2101 if (strncmpic(p, hdr, len) == 0)
2104 while (*p == ' ' || *p == '\t') p++;
2105 if (*p == ':') return TRUE;
2107 while (*p != 0 && *p != '\n') p++;
2108 if (*p == '\n') p++;
2116 /*************************************************
2117 * Perform a local delivery *
2118 *************************************************/
2120 /* Each local delivery is performed in a separate process which sets its
2121 uid and gid as specified. This is a safer way than simply changing and
2122 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2123 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2124 all systems have seteuid().
2126 If the uid/gid are specified in the transport_instance, they are used; the
2127 transport initialization must ensure that either both or neither are set.
2128 Otherwise, the values associated with the address are used. If neither are set,
2129 it is a configuration error.
2131 The transport or the address may specify a home directory (transport over-
2132 rides), and if they do, this is set as $home. If neither have set a working
2133 directory, this value is used for that as well. Otherwise $home is left unset
2134 and the cwd is set to "/" - a directory that should be accessible to all users.
2136 Using a separate process makes it more complicated to get error information
2137 back. We use a pipe to pass the return code and also an error code and error
2138 text string back to the parent process.
2141 addr points to an address block for this delivery; for "normal" local
2142 deliveries this is the only address to be delivered, but for
2143 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2144 a number of addresses can be handled simultaneously, and in this
2145 case addr will point to a chain of addresses with the same
2148 shadowing TRUE if running a shadow transport; this causes output from pipes
2155 deliver_local(address_item *addr, BOOL shadowing)
2157 BOOL use_initgroups;
2160 int status, len, rc;
2163 uschar *working_directory;
2164 address_item *addr2;
2165 transport_instance *tp = addr->transport;
2167 /* Set up the return path from the errors or sender address. If the transport
2168 has its own return path setting, expand it and replace the existing value. */
2170 if(addr->prop.errors_address)
2171 return_path = addr->prop.errors_address;
2172 #ifdef EXPERIMENTAL_SRS
2173 else if (addr->prop.srs_sender)
2174 return_path = addr->prop.srs_sender;
2177 return_path = sender_address;
2179 if (tp->return_path)
2181 uschar *new_return_path = expand_string(tp->return_path);
2182 if (!new_return_path)
2184 if (!f.expand_string_forcedfail)
2186 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2187 US"Failed to expand return path \"%s\" in %s transport: %s",
2188 tp->return_path, tp->name, expand_string_message);
2192 else return_path = new_return_path;
2195 /* For local deliveries, one at a time, the value used for logging can just be
2196 set directly, once and for all. */
2198 used_return_path = return_path;
2200 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2201 gets put into the address(es), and the expansions are unset, so we can just
2204 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2206 /* See if either the transport or the address specifies a home directory. A
2207 home directory set in the address may already be expanded; a flag is set to
2208 indicate that. In other cases we must expand it. */
2210 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2211 || ( (deliver_home = addr->home_dir) /* Set in address and */
2212 && !testflag(addr, af_home_expanded) /* not expanded */
2215 uschar *rawhome = deliver_home;
2216 deliver_home = NULL; /* in case it contains $home */
2217 if (!(deliver_home = expand_string(rawhome)))
2219 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2220 "to expand for %s transport: %s", rawhome, tp->name,
2221 expand_string_message);
2224 if (*deliver_home != '/')
2226 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2227 "is not absolute for %s transport", deliver_home, tp->name);
2232 /* See if either the transport or the address specifies a current directory,
2233 and if so, expand it. If nothing is set, use the home directory, unless it is
2234 also unset in which case use "/", which is assumed to be a directory to which
2235 all users have access. It is necessary to be in a visible directory for some
2236 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2237 2.5) require this. */
2239 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2240 if (working_directory)
2242 uschar *raw = working_directory;
2243 if (!(working_directory = expand_string(raw)))
2245 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2246 "failed to expand for %s transport: %s", raw, tp->name,
2247 expand_string_message);
2250 if (*working_directory != '/')
2252 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2253 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2257 else working_directory = deliver_home ? deliver_home : US"/";
2259 /* If one of the return_output flags is set on the transport, create and open a
2260 file in the message log directory for the transport to write its output onto.
2261 This is mainly used by pipe transports. The file needs to be unique to the
2262 address. This feature is not available for shadow transports. */
2265 && ( tp->return_output || tp->return_fail_output
2266 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2271 addr->return_filename =
2272 spool_fname(US"msglog", message_subdir, message_id,
2273 string_sprintf("-%d-%d", getpid(), return_count++));
2275 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2277 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2278 "to return message: %s", error, tp->name, strerror(errno));
2283 /* Create the pipe for inter-process communication. */
2287 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2292 /* Now fork the process to do the real work in the subprocess, but first
2293 ensure that all cached resources are freed so that the subprocess starts with
2294 a clean slate and doesn't interfere with the parent process. */
2298 if ((pid = fork()) == 0)
2300 BOOL replicate = TRUE;
2302 /* Prevent core dumps, as we don't want them in users' home directories.
2303 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2304 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2305 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2306 complain if the error is "not supported".
2308 There are two scenarios where changing the max limit has an effect. In one,
2309 the user is using a .forward and invoking a command of their choice via pipe;
2310 for these, we do need the max limit to be 0 unless the admin chooses to
2311 permit an increased limit. In the other, the command is invoked directly by
2312 the transport and is under administrator control, thus being able to raise
2313 the limit aids in debugging. So there's no general always-right answer.
2315 Thus we inhibit core-dumps completely but let individual transports, while
2316 still root, re-raise the limits back up to aid debugging. We make the
2317 default be no core-dumps -- few enough people can use core dumps in
2318 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2325 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2327 # ifdef SETRLIMIT_NOT_SUPPORTED
2328 if (errno != ENOSYS && errno != ENOTSUP)
2330 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2335 /* Reset the random number generator, so different processes don't all
2336 have the same sequence. */
2340 /* If the transport has a setup entry, call this first, while still
2341 privileged. (Appendfile uses this to expand quota, for example, while
2342 able to read private files.) */
2344 if (addr->transport->setup)
2345 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2349 addr->transport_return = DEFER;
2353 addr->transport_return = PANIC;
2357 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2358 when the process becomes unprivileged, it won't be able to write to the
2359 process log. SIGHUP is ignored throughout exim, except when it is being
2362 signal(SIGINT, SIG_IGN);
2363 signal(SIGTERM, SIG_IGN);
2364 signal(SIGUSR1, SIG_IGN);
2366 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2367 half - for transports that exec things (e.g. pipe). Then set the required
2370 (void)close(pfd[pipe_read]);
2371 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2373 exim_setugid(uid, gid, use_initgroups,
2374 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2375 addr->address, addr->transport->name));
2379 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2380 for (address_item * batched = addr->next; batched; batched = batched->next)
2381 debug_printf("additional batched address: %s\n", batched->address);
2384 /* Set an appropriate working directory. */
2386 if (Uchdir(working_directory) < 0)
2388 addr->transport_return = DEFER;
2389 addr->basic_errno = errno;
2390 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2393 /* If successful, call the transport */
2398 set_process_info("delivering %s to %s using %s", message_id,
2399 addr->local_part, addr->transport->name);
2401 /* Setting this global in the subprocess means we need never clear it */
2402 transport_name = addr->transport->name;
2404 /* If a transport filter has been specified, set up its argument list.
2405 Any errors will get put into the address, and FALSE yielded. */
2407 if (addr->transport->filter_command)
2409 ok = transport_set_up_command(&transport_filter_argv,
2410 addr->transport->filter_command,
2411 TRUE, PANIC, addr, US"transport filter", NULL);
2412 transport_filter_timeout = addr->transport->filter_timeout;
2414 else transport_filter_argv = NULL;
2418 debug_print_string(addr->transport->debug_string);
2419 replicate = !(addr->transport->info->code)(addr->transport, addr);
2423 /* Pass the results back down the pipe. If necessary, first replicate the
2424 status in the top address to the others in the batch. The label is the
2425 subject of a goto when a call to the transport's setup function fails. We
2426 pass the pointer to the transport back in case it got changed as a result of
2427 file_format in appendfile. */
2431 if (replicate) replicate_status(addr);
2432 for (addr2 = addr; addr2; addr2 = addr2->next)
2435 int local_part_length = Ustrlen(addr2->local_part);
2439 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2440 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2441 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2442 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2443 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2444 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2445 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2446 || (ret = write(pfd[pipe_write], &addr2->transport,
2447 sizeof(transport_instance *))) != sizeof(transport_instance *)
2449 /* For a file delivery, pass back the local part, in case the original
2450 was only part of the final delivery path. This gives more complete
2453 || (testflag(addr2, af_file)
2454 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2455 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2459 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2460 ret == -1 ? strerror(errno) : "short write");
2462 /* Now any messages */
2464 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2466 int message_length = s ? Ustrlen(s) + 1 : 0;
2467 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2468 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2470 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2471 ret == -1 ? strerror(errno) : "short write");
2475 /* OK, this process is now done. Free any cached resources that it opened,
2476 and close the pipe we were writing down before exiting. */
2478 (void)close(pfd[pipe_write]);
2483 /* Back in the main process: panic if the fork did not succeed. This seems
2484 better than returning an error - if forking is failing it is probably best
2485 not to try other deliveries for this message. */
2488 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2491 /* Read the pipe to get the delivery status codes and error messages. Our copy
2492 of the writing end must be closed first, as otherwise read() won't return zero
2493 on an empty pipe. We check that a status exists for each address before
2494 overwriting the address structure. If data is missing, the default DEFER status
2495 will remain. Afterwards, close the reading end. */
2497 (void)close(pfd[pipe_write]);
2499 for (addr2 = addr; addr2; addr2 = addr2->next)
2501 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2506 addr2->transport_return = status;
2507 len = read(pfd[pipe_read], &transport_count,
2508 sizeof(transport_count));
2509 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2510 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2511 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2512 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2513 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2514 len = read(pfd[pipe_read], &addr2->transport,
2515 sizeof(transport_instance *));
2517 if (testflag(addr2, af_file))
2520 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2521 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2524 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2525 " from delivery subprocess");
2528 /* sanity-checked llen so disable the Coverity error */
2529 /* coverity[tainted_data] */
2530 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2532 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2533 " from delivery subprocess");
2536 big_buffer[llen] = 0;
2537 addr2->local_part = string_copy(big_buffer);
2540 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2543 len = read(pfd[pipe_read], &message_length, sizeof(int));
2544 if (message_length > 0)
2546 len = read(pfd[pipe_read], big_buffer, message_length);
2547 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2548 if (len > 0) *sptr = string_copy(big_buffer);
2555 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2556 "from delivery subprocess", addr2->unique);
2561 (void)close(pfd[pipe_read]);
2563 /* Unless shadowing, write all successful addresses immediately to the journal
2564 file, to ensure they are recorded asap. For homonymic addresses, use the base
2565 address plus the transport name. Failure to write the journal is panic-worthy,
2566 but don't stop, as it may prove possible subsequently to update the spool file
2567 in order to record the delivery. */
2571 for (addr2 = addr; addr2; addr2 = addr2->next)
2572 if (addr2->transport_return == OK)
2574 if (testflag(addr2, af_homonym))
2575 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2577 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2579 /* In the test harness, wait just a bit to let the subprocess finish off
2580 any debug output etc first. */
2582 if (f.running_in_test_harness) millisleep(300);
2584 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2585 len = Ustrlen(big_buffer);
2586 if (write(journal_fd, big_buffer, len) != len)
2587 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2588 big_buffer, strerror(errno));
2591 /* Ensure the journal file is pushed out to disk. */
2593 if (EXIMfsync(journal_fd) < 0)
2594 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2598 /* Wait for the process to finish. If it terminates with a non-zero code,
2599 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2600 status values of all the addresses as they are. Take care to handle the case
2601 when the subprocess doesn't seem to exist. This has been seen on one system
2602 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2603 happens, wait() doesn't recognize the termination of child processes. Exim now
2604 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2606 while ((rc = wait(&status)) != pid)
2607 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2609 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2610 addr->transport->driver_name);
2615 if ((status & 0xffff) != 0)
2617 int msb = (status >> 8) & 255;
2618 int lsb = status & 255;
2619 int code = (msb == 0)? (lsb & 0x7f) : msb;
2620 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2621 addr->special_action = SPECIAL_FREEZE;
2622 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2623 "status 0x%04x: %s %d",
2624 addr->transport->driver_name,
2626 msb == 0 ? "terminated by signal" : "exit code",
2630 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2632 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2635 uschar *warn_message;
2638 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2640 if (!(warn_message = expand_string(addr->transport->warn_message)))
2641 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2642 "message for %s transport): %s", addr->transport->warn_message,
2643 addr->transport->name, expand_string_message);
2645 else if ((pid = child_open_exim(&fd)) > 0)
2647 FILE *f = fdopen(fd, "wb");
2648 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2649 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2650 fprintf(f, "Auto-Submitted: auto-replied\n");
2651 if (!contains_header(US"From", warn_message))
2653 fprintf(f, "%s", CS warn_message);
2655 /* Close and wait for child process to complete, without a timeout. */
2658 (void)child_close(pid, 0);
2661 addr->special_action = SPECIAL_NONE;
2668 /* Check transport for the given concurrency limit. Return TRUE if over
2669 the limit (or an expansion failure), else FALSE and if there was a limit,
2670 the key for the hints database used for the concurrency count. */
2673 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2675 unsigned max_parallel;
2677 if (!tp->max_parallel) return FALSE;
2679 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2680 if (expand_string_message)
2682 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2683 "in %s transport (%s): %s", tp->name, addr->address,
2684 expand_string_message);
2688 if (max_parallel > 0)
2690 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2691 if (!enq_start(serialize_key, max_parallel))
2693 address_item * next;
2695 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2696 tp->name, max_parallel);
2700 addr->message = US"concurrency limit reached for transport";
2701 addr->basic_errno = ERRNO_TRETRY;
2702 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2703 } while ((addr = next));
2706 *key = serialize_key;
2713 /*************************************************
2714 * Do local deliveries *
2715 *************************************************/
2717 /* This function processes the list of addresses in addr_local. True local
2718 deliveries are always done one address at a time. However, local deliveries can
2719 be batched up in some cases. Typically this is when writing batched SMTP output
2720 files for use by some external transport mechanism, or when running local
2721 deliveries over LMTP.
2728 do_local_deliveries(void)
2731 open_db *dbm_file = NULL;
2732 time_t now = time(NULL);
2734 /* Loop until we have exhausted the supply of local deliveries */
2738 struct timeval delivery_start;
2739 struct timeval deliver_time;
2740 address_item *addr2, *addr3, *nextaddr;
2741 int logflags = LOG_MAIN;
2742 int logchar = f.dont_deliver? '*' : '=';
2743 transport_instance *tp;
2744 uschar * serialize_key = NULL;
2746 /* Pick the first undelivered address off the chain */
2748 address_item *addr = addr_local;
2749 addr_local = addr->next;
2752 DEBUG(D_deliver|D_transport)
2753 debug_printf("--------> %s <--------\n", addr->address);
2755 /* An internal disaster if there is no transport. Should not occur! */
2757 if (!(tp = addr->transport))
2759 logflags |= LOG_PANIC;
2760 f.disable_logging = FALSE; /* Jic */
2761 addr->message = addr->router
2762 ? string_sprintf("No transport set by %s router", addr->router->name)
2763 : US"No transport set by system filter";
2764 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2768 /* Check that this base address hasn't previously been delivered to this
2769 transport. The check is necessary at this point to handle homonymic addresses
2770 correctly in cases where the pattern of redirection changes between delivery
2771 attempts. Non-homonymic previous delivery is detected earlier, at routing
2774 if (previously_transported(addr, FALSE)) continue;
2776 /* There are weird cases where logging is disabled */
2778 f.disable_logging = tp->disable_logging;
2780 /* Check for batched addresses and possible amalgamation. Skip all the work
2781 if either batch_max <= 1 or there aren't any other addresses for local
2784 if (tp->batch_max > 1 && addr_local)
2786 int batch_count = 1;
2787 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2788 BOOL uses_lp = ( testflag(addr, af_pfr)
2789 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2791 || readconf_depends((driver_instance *)tp, US"local_part");
2792 uschar *batch_id = NULL;
2793 address_item **anchor = &addr_local;
2794 address_item *last = addr;
2797 /* Expand the batch_id string for comparison with other addresses.
2798 Expansion failure suppresses batching. */
2802 deliver_set_expansions(addr);
2803 batch_id = expand_string(tp->batch_id);
2804 deliver_set_expansions(NULL);
2807 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2808 "in %s transport (%s): %s", tp->name, addr->address,
2809 expand_string_message);
2810 batch_count = tp->batch_max;
2814 /* Until we reach the batch_max limit, pick off addresses which have the
2815 same characteristics. These are:
2818 not previously delivered (see comment about 50 lines above)
2819 same local part if the transport's configuration contains $local_part
2820 or if this is a file or pipe delivery from a redirection
2821 same domain if the transport's configuration contains $domain
2823 same additional headers
2824 same headers to be removed
2825 same uid/gid for running the transport
2826 same first host if a host list is set
2829 while ((next = *anchor) && batch_count < tp->batch_max)
2832 tp == next->transport
2833 && !previously_transported(next, TRUE)
2834 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2835 && testflag(addr, af_file) == testflag(next, af_file)
2836 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2837 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2838 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2839 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2840 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2841 && same_ugid(tp, addr, next)
2842 && ( !addr->host_list && !next->host_list
2845 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2848 /* If the transport has a batch_id setting, batch_id will be non-NULL
2849 from the expansion outside the loop. Expand for this address and compare.
2850 Expansion failure makes this address ineligible for batching. */
2855 address_item *save_nextnext = next->next;
2856 next->next = NULL; /* Expansion for a single address */
2857 deliver_set_expansions(next);
2858 next->next = save_nextnext;
2859 bid = expand_string(tp->batch_id);
2860 deliver_set_expansions(NULL);
2863 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2864 "in %s transport (%s): %s", tp->name, next->address,
2865 expand_string_message);
2868 else ok = (Ustrcmp(batch_id, bid) == 0);
2871 /* Take address into batch if OK. */
2875 *anchor = next->next; /* Include the address */
2881 else anchor = &next->next; /* Skip the address */
2885 /* We now have one or more addresses that can be delivered in a batch. Check
2886 whether the transport is prepared to accept a message of this size. If not,
2887 fail them all forthwith. If the expansion fails, or does not yield an
2888 integer, defer delivery. */
2890 if (tp->message_size_limit)
2892 int rc = check_message_size(tp, addr);
2895 replicate_status(addr);
2899 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2902 continue; /* With next batch of addresses */
2906 /* If we are not running the queue, or if forcing, all deliveries will be
2907 attempted. Otherwise, we must respect the retry times for each address. Even
2908 when not doing this, we need to set up the retry key string, and determine
2909 whether a retry record exists, because after a successful delivery, a delete
2910 retry item must be set up. Keep the retry database open only for the duration
2911 of these checks, rather than for all local deliveries, because some local
2912 deliveries (e.g. to pipes) can take a substantial time. */
2914 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2916 DEBUG(D_deliver|D_retry|D_hints_lookup)
2917 debug_printf("no retry data available\n");
2924 BOOL ok = TRUE; /* to deliver this address */
2927 /* Set up the retry key to include the domain or not, and change its
2928 leading character from "R" to "T". Must make a copy before doing this,
2929 because the old key may be pointed to from a "delete" retry item after
2932 retry_key = string_copy(
2933 tp->retry_use_local_part ? addr2->address_retry_key :
2934 addr2->domain_retry_key);
2937 /* Inspect the retry data. If there is no hints file, delivery happens. */
2941 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2943 /* If there is no retry record, delivery happens. If there is,
2944 remember it exists so it can be deleted after a successful delivery. */
2948 setflag(addr2, af_lt_retry_exists);
2950 /* A retry record exists for this address. If queue running and not
2951 forcing, inspect its contents. If the record is too old, or if its
2952 retry time has come, or if it has passed its cutoff time, delivery
2957 debug_printf("retry record exists: age=%s ",
2958 readconf_printtime(now - retry_record->time_stamp));
2959 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2960 debug_printf(" time to retry = %s expired = %d\n",
2961 readconf_printtime(retry_record->next_try - now),
2962 retry_record->expired);
2965 if (f.queue_running && !f.deliver_force)
2967 ok = (now - retry_record->time_stamp > retry_data_expire)
2968 || (now >= retry_record->next_try)
2969 || retry_record->expired;
2971 /* If we haven't reached the retry time, there is one more check
2972 to do, which is for the ultimate address timeout. */
2975 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2979 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2982 /* This address is to be delivered. Leave it on the chain. */
2987 addr2 = addr2->next;
2990 /* This address is to be deferred. Take it out of the chain, and
2991 post-process it as complete. Must take it out of the chain first,
2992 because post processing puts it on another chain. */
2996 address_item *this = addr2;
2997 this->message = US"Retry time not yet reached";
2998 this->basic_errno = ERRNO_LRETRY;
2999 addr2 = addr3 ? (addr3->next = addr2->next)
3000 : (addr = addr2->next);
3001 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3005 if (dbm_file) dbfn_close(dbm_file);
3007 /* If there are no addresses left on the chain, they all deferred. Loop
3008 for the next set of addresses. */
3010 if (!addr) continue;
3012 /* If the transport is limited for parallellism, enforce that here.
3013 We use a hints DB entry, incremented here and decremented after
3014 the transport (and any shadow transport) completes. */
3016 if (tpt_parallel_check(tp, addr, &serialize_key))
3018 if (expand_string_message)
3020 logflags |= LOG_PANIC;
3024 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3025 } while ((addr = addr2));
3027 continue; /* Loop for the next set of addresses. */
3031 /* So, finally, we do have some addresses that can be passed to the
3032 transport. Before doing so, set up variables that are relevant to a
3035 deliver_set_expansions(addr);
3037 gettimeofday(&delivery_start, NULL);
3038 deliver_local(addr, FALSE);
3039 timesince(&deliver_time, &delivery_start);
3041 /* If a shadow transport (which must perforce be another local transport), is
3042 defined, and its condition is met, we must pass the message to the shadow
3043 too, but only those addresses that succeeded. We do this by making a new
3044 chain of addresses - also to keep the original chain uncontaminated. We must
3045 use a chain rather than doing it one by one, because the shadow transport may
3048 NOTE: if the condition fails because of a lookup defer, there is nothing we
3052 && ( !tp->shadow_condition
3053 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3056 transport_instance *stp;
3057 address_item *shadow_addr = NULL;
3058 address_item **last = &shadow_addr;
3060 for (stp = transports; stp; stp = stp->next)
3061 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3064 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3067 /* Pick off the addresses that have succeeded, and make clones. Put into
3068 the shadow_message field a pointer to the shadow_message field of the real
3071 else for (addr2 = addr; addr2; addr2 = addr2->next)
3072 if (addr2->transport_return == OK)
3074 addr3 = store_get(sizeof(address_item), FALSE);
3077 addr3->shadow_message = US &addr2->shadow_message;
3078 addr3->transport = stp;
3079 addr3->transport_return = DEFER;
3080 addr3->return_filename = NULL;
3081 addr3->return_file = -1;
3083 last = &addr3->next;
3086 /* If we found any addresses to shadow, run the delivery, and stick any
3087 message back into the shadow_message field in the original. */
3091 int save_count = transport_count;
3093 DEBUG(D_deliver|D_transport)
3094 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3095 deliver_local(shadow_addr, TRUE);
3097 for(; shadow_addr; shadow_addr = shadow_addr->next)
3099 int sresult = shadow_addr->transport_return;
3100 *(uschar **)shadow_addr->shadow_message =
3102 ? string_sprintf(" ST=%s", stp->name)
3103 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3104 shadow_addr->basic_errno <= 0
3106 : US strerror(shadow_addr->basic_errno),
3107 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3110 shadow_addr->message
3111 ? shadow_addr->message
3112 : shadow_addr->basic_errno <= 0
3116 DEBUG(D_deliver|D_transport)
3117 debug_printf("%s shadow transport returned %s for %s\n",
3118 stp->name, rc_to_string(sresult), shadow_addr->address);
3121 DEBUG(D_deliver|D_transport)
3122 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3124 transport_count = save_count; /* Restore original transport count */
3128 /* Cancel the expansions that were set up for the delivery. */
3130 deliver_set_expansions(NULL);
3132 /* If the transport was parallelism-limited, decrement the hints DB record. */
3134 if (serialize_key) enq_end(serialize_key);
3136 /* Now we can process the results of the real transport. We must take each
3137 address off the chain first, because post_process_one() puts it on another
3140 for (addr2 = addr; addr2; addr2 = nextaddr)
3142 int result = addr2->transport_return;
3143 nextaddr = addr2->next;
3145 DEBUG(D_deliver|D_transport)
3146 debug_printf("%s transport returned %s for %s\n",
3147 tp->name, rc_to_string(result), addr2->address);
3149 /* If there is a retry_record, or if delivery is deferred, build a retry
3150 item for setting a new retry time or deleting the old retry record from
3151 the database. These items are handled all together after all addresses
3152 have been handled (so the database is open just for a short time for
3155 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3157 int flags = result == DEFER ? 0 : rf_delete;
3158 uschar *retry_key = string_copy(tp->retry_use_local_part
3159 ? addr2->address_retry_key : addr2->domain_retry_key);
3161 retry_add_item(addr2, retry_key, flags);
3164 /* Done with this address */
3168 addr2->more_errno = deliver_time.tv_sec;
3169 addr2->delivery_usec = deliver_time.tv_usec;
3171 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3173 /* If a pipe delivery generated text to be sent back, the result may be
3174 changed to FAIL, and we must copy this for subsequent addresses in the
3177 if (addr2->transport_return != result)
3179 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3181 addr3->transport_return = addr2->transport_return;
3182 addr3->basic_errno = addr2->basic_errno;
3183 addr3->message = addr2->message;
3185 result = addr2->transport_return;
3188 /* Whether or not the result was changed to FAIL, we need to copy the
3189 return_file value from the first address into all the addresses of the
3190 batch, so they are all listed in the error message. */
3192 addr2->return_file = addr->return_file;
3194 /* Change log character for recording successful deliveries. */
3196 if (result == OK) logchar = '-';
3198 } /* Loop back for next batch of addresses */
3204 /*************************************************
3205 * Sort remote deliveries *
3206 *************************************************/
3208 /* This function is called if remote_sort_domains is set. It arranges that the
3209 chain of addresses for remote deliveries is ordered according to the strings
3210 specified. Try to make this shuffling reasonably efficient by handling
3211 sequences of addresses rather than just single ones.
3218 sort_remote_deliveries(void)
3221 address_item **aptr = &addr_remote;
3222 const uschar *listptr = remote_sort_domains;
3227 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3230 address_item *moved = NULL;
3231 address_item **bptr = &moved;
3235 address_item **next;
3236 deliver_domain = (*aptr)->domain; /* set $domain */
3237 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3238 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3240 aptr = &(*aptr)->next;
3244 next = &(*aptr)->next;
3246 && (deliver_domain = (*next)->domain, /* Set $domain */
3247 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3248 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3250 next = &(*next)->next;
3252 /* If the batch of non-matchers is at the end, add on any that were
3253 extracted further up the chain, and end this iteration. Otherwise,
3254 extract them from the chain and hang on the moved chain. */
3266 aptr = &(*aptr)->next;
3269 /* If the loop ended because the final address matched, *aptr will
3270 be NULL. Add on to the end any extracted non-matching addresses. If
3271 *aptr is not NULL, the loop ended via "break" when *next is null, that
3272 is, there was a string of non-matching addresses at the end. In this
3273 case the extracted addresses have already been added on the end. */
3275 if (!*aptr) *aptr = moved;
3280 debug_printf("remote addresses after sorting:\n");
3281 for (address_item * addr = addr_remote; addr; addr = addr->next)
3282 debug_printf(" %s\n", addr->address);
3288 /*************************************************
3289 * Read from pipe for remote delivery subprocess *
3290 *************************************************/
3292 /* This function is called when the subprocess is complete, but can also be
3293 called before it is complete, in order to empty a pipe that is full (to prevent
3294 deadlock). It must therefore keep track of its progress in the parlist data
3297 We read the pipe to get the delivery status codes and a possible error message
3298 for each address, optionally preceded by unusability data for the hosts and
3299 also by optional retry data.
3301 Read in large chunks into the big buffer and then scan through, interpreting
3302 the data therein. In most cases, only a single read will be necessary. No
3303 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3304 that we read the next chunk when there is less than 2500 bytes left in the
3305 non-final chunk, we can assume each item is complete in the buffer before
3306 handling it. Each item is written using a single write(), which is atomic for
3307 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3308 often bigger) so even if we are reading while the subprocess is still going, we
3309 should never have only a partial item in the buffer.
3311 hs12: This assumption is not true anymore, since we get quite large items (certificate
3312 information and such).
3315 poffset the offset of the parlist item
3316 eop TRUE if the process has completed
3318 Returns: TRUE if the terminating 'Z' item has been read,
3319 or there has been a disaster (i.e. no more data needed);
3324 par_read_pipe(int poffset, BOOL eop)
3327 pardata *p = parlist + poffset;
3328 address_item *addrlist = p->addrlist;
3329 address_item *addr = p->addr;
3333 uschar *msg = p->msg;
3334 BOOL done = p->done;
3336 /* Loop through all items, reading from the pipe when necessary. The pipe
3337 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3338 here, as the preceding select() tells us, if data is available for reading.
3340 A read() on a "selected" handle should never block, but(!) it may return
3341 less data then we expected. (The buffer size we pass to read() shouldn't be
3342 understood as a "request", but as a "limit".)
3344 Each separate item is written to the pipe in a timely manner. But, especially for
3345 larger items, the read(2) may already return partial data from the write(2).
3347 The write is atomic mostly (depending on the amount written), but atomic does
3348 not imply "all or noting", it just is "not intermixed" with other writes on the
3349 same channel (pipe).
3353 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3354 (int)p->pid, eop? "ended" : "not ended yet");
3358 retry_item *r, **rp;
3359 uschar pipeheader[PIPE_HEADER_SIZE+1];
3360 uschar *id = &pipeheader[0];
3361 uschar *subid = &pipeheader[1];
3362 uschar *ptr = big_buffer;
3363 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3366 DEBUG(D_deliver) debug_printf(
3367 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3369 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3370 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3371 If we get less, we can assume the subprocess do be done and do not expect any further
3372 information from it. */
3374 if ((got = readn(fd, pipeheader, required)) != required)
3376 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3377 "from transport process %d for transport %s",
3378 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3383 pipeheader[PIPE_HEADER_SIZE] = '\0';
3385 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3389 /* If we can't decode the pipeheader, the subprocess seems to have a
3390 problem, we do not expect any furher information from it. */
3392 required = Ustrtol(pipeheader+2, &endc, 10);
3395 msg = string_sprintf("failed to read pipe "
3396 "from transport process %d for transport %s: error decoding size from header",
3397 pid, addr->transport->driver_name);
3404 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3405 (u_long)required, pid);
3407 /* Same as above, the transport process will write the bytes announced
3408 in a timely manner, so we can just wait for the bytes, getting less than expected
3409 is considered a problem of the subprocess, we do not expect anything else from it. */
3410 if ((got = readn(fd, big_buffer, required)) != required)
3412 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3413 " bytes (pipedata) from transport process %d for transport %s",
3414 got, required, pid, addr->transport->driver_name);
3419 /* Handle each possible type of item, assuming the complete item is
3420 available in store. */
3424 /* Host items exist only if any hosts were marked unusable. Match
3425 up by checking the IP address. */
3428 for (h = addrlist->host_list; h; h = h->next)
3430 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3438 /* Retry items are sent in a preceding R item for each address. This is
3439 kept separate to keep each message short enough to guarantee it won't
3440 be split in the pipe. Hopefully, in the majority of cases, there won't in
3441 fact be any retry items at all.
3443 The complete set of retry items might include an item to delete a
3444 routing retry if there was a previous routing delay. However, routing
3445 retries are also used when a remote transport identifies an address error.
3446 In that case, there may also be an "add" item for the same key. Arrange
3447 that a "delete" item is dropped in favour of an "add" item. */
3450 if (!addr) goto ADDR_MISMATCH;
3452 DEBUG(D_deliver|D_retry)
3453 debug_printf("reading retry information for %s from subprocess\n",
3456 /* Cut out any "delete" items on the list. */
3458 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3459 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3461 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3462 *rp = r->next; /* Excise a delete item */
3463 DEBUG(D_deliver|D_retry)
3464 debug_printf(" existing delete item dropped\n");
3467 /* We want to add a delete item only if there is no non-delete item;
3468 however we still have to step ptr through the data. */
3470 if (!r || !(*ptr & rf_delete))
3472 r = store_get(sizeof(retry_item), FALSE);
3473 r->next = addr->retries;
3476 r->key = string_copy(ptr);
3478 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3479 ptr += sizeof(r->basic_errno);
3480 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3481 ptr += sizeof(r->more_errno);
3482 r->message = *ptr ? string_copy(ptr) : NULL;
3483 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3484 r->flags & rf_delete ? "delete" : "retry");
3489 DEBUG(D_deliver|D_retry)
3490 debug_printf(" delete item not added: non-delete item exists\n");
3493 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3499 /* Put the amount of data written into the parlist block */
3502 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3503 ptr += sizeof(transport_count);
3506 /* Address items are in the order of items on the address chain. We
3507 remember the current address value in case this function is called
3508 several times to empty the pipe in stages. Information about delivery
3509 over TLS is sent in a preceding X item for each address. We don't put
3510 it in with the other info, in order to keep each message short enough to
3511 guarantee it won't be split in the pipe. */
3515 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3519 addr->cipher = NULL;
3520 addr->peerdn = NULL;
3523 addr->cipher = string_copy(ptr);
3526 addr->peerdn = string_copy(ptr);
3531 (void) tls_import_cert(ptr, &addr->peercert);
3533 addr->peercert = NULL;
3538 (void) tls_import_cert(ptr, &addr->ourcert);
3540 addr->ourcert = NULL;
3543 # ifndef DISABLE_OCSP
3545 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3551 #endif /*DISABLE_TLS*/
3553 case 'C': /* client authenticator information */
3556 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3557 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3558 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3563 #ifndef DISABLE_PRDR
3565 setflag(addr, af_prdr_used);
3572 #ifdef SUPPORT_PIPE_CONNECT
3573 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3575 case 1: setflag(addr, af_pipelining); break;
3580 setflag(addr, af_chunking_used);
3584 setflag(addr, af_tcp_fastopen_conn);
3585 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3586 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3590 if (!addr) goto ADDR_MISMATCH;
3591 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3592 ptr += sizeof(addr->dsn_aware);
3593 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3600 msg = string_sprintf("address count mismatch for data read from pipe "
3601 "for transport process %d for transport %s", pid,
3602 addrlist->transport->driver_name);
3609 #ifdef SUPPORT_SOCKS
3610 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3611 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3616 proxy_local_address = string_copy(ptr);
3618 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3619 ptr += sizeof(proxy_local_port);
3624 #ifdef EXPERIMENTAL_DSN_INFO
3625 case '1': /* must arrive before A0, and applies to that addr */
3626 /* Two strings: smtp_greeting and helo_response */
3627 addr->smtp_greeting = string_copy(ptr);
3629 addr->helo_response = string_copy(ptr);
3635 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3636 addr->transport_return = *ptr++;
3637 addr->special_action = *ptr++;
3638 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3639 ptr += sizeof(addr->basic_errno);
3640 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3641 ptr += sizeof(addr->more_errno);
3642 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3643 ptr += sizeof(addr->delivery_usec);
3644 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3645 ptr += sizeof(addr->flags);
3646 addr->message = *ptr ? string_copy(ptr) : NULL;
3648 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3651 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3655 h = store_get(sizeof(host_item), FALSE);
3656 h->name = string_copy(ptr);
3658 h->address = string_copy(ptr);
3660 memcpy(&h->port, ptr, sizeof(h->port));
3661 ptr += sizeof(h->port);
3662 h->dnssec = *ptr == '2' ? DS_YES
3663 : *ptr == '1' ? DS_NO
3666 addr->host_used = h;
3670 /* Finished with this address */
3677 /* Local interface address/port */
3679 if (*ptr) sending_ip_address = string_copy(ptr);
3681 if (*ptr) sending_port = atoi(CS ptr);
3685 /* Z marks the logical end of the data. It is followed by '0' if
3686 continue_transport was NULL at the end of transporting, otherwise '1'.
3687 We need to know when it becomes NULL during a delivery down a passed SMTP
3688 channel so that we don't try to pass anything more down it. Of course, for
3689 most normal messages it will remain NULL all the time. */
3694 continue_transport = NULL;
3695 continue_hostname = NULL;
3698 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3701 /* Anything else is a disaster. */
3704 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3705 "process %d for transport %s", ptr[-1], pid,
3706 addr->transport->driver_name);
3712 /* The done flag is inspected externally, to determine whether or not to
3713 call the function again when the process finishes. */
3717 /* If the process hadn't finished, and we haven't seen the end of the data
3718 or if we suffered a disaster, update the rest of the state, and return FALSE to
3719 indicate "not finished". */
3728 /* Close our end of the pipe, to prevent deadlock if the far end is still
3729 pushing stuff into it. */
3734 /* If we have finished without error, but haven't had data for every address,
3735 something is wrong. */
3738 msg = string_sprintf("insufficient address data read from pipe "
3739 "for transport process %d for transport %s", pid,
3740 addr->transport->driver_name);
3742 /* If an error message is set, something has gone wrong in getting back
3743 the delivery data. Put the message into each address and freeze it. */
3746 for (addr = addrlist; addr; addr = addr->next)
3748 addr->transport_return = DEFER;
3749 addr->special_action = SPECIAL_FREEZE;
3750 addr->message = msg;
3751 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3754 /* Return TRUE to indicate we have got all we need from this process, even
3755 if it hasn't actually finished yet. */
3762 /*************************************************
3763 * Post-process a set of remote addresses *
3764 *************************************************/
3766 /* Do what has to be done immediately after a remote delivery for each set of
3767 addresses, then re-write the spool if necessary. Note that post_process_one
3768 puts the address on an appropriate queue; hence we must fish off the next
3769 one first. This function is also called if there is a problem with setting
3770 up a subprocess to do a remote delivery in parallel. In this case, the final
3771 argument contains a message, and the action must be forced to DEFER.
3774 addr pointer to chain of address items
3775 logflags flags for logging
3776 msg NULL for normal cases; -> error message for unexpected problems
3777 fallback TRUE if processing fallback hosts
3783 remote_post_process(address_item *addr, int logflags, uschar *msg,
3786 /* If any host addresses were found to be unusable, add them to the unusable
3787 tree so that subsequent deliveries don't try them. */
3789 for (host_item * h = addr->host_list; h; h = h->next)
3791 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3793 /* Now handle each address on the chain. The transport has placed '=' or '-'
3794 into the special_action field for each successful delivery. */
3798 address_item *next = addr->next;
3800 /* If msg == NULL (normal processing) and the result is DEFER and we are
3801 processing the main hosts and there are fallback hosts available, put the
3802 address on the list for fallback delivery. */
3804 if ( addr->transport_return == DEFER
3805 && addr->fallback_hosts
3810 addr->host_list = addr->fallback_hosts;
3811 addr->next = addr_fallback;
3812 addr_fallback = addr;
3813 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3816 /* If msg is set (=> unexpected problem), set it in the address before
3817 doing the ordinary post processing. */
3823 addr->message = msg;
3824 addr->transport_return = DEFER;
3826 (void)post_process_one(addr, addr->transport_return, logflags,
3827 EXIM_DTYPE_TRANSPORT, addr->special_action);
3835 /* If we have just delivered down a passed SMTP channel, and that was
3836 the last address, the channel will have been closed down. Now that
3837 we have logged that delivery, set continue_sequence to 1 so that
3838 any subsequent deliveries don't get "*" incorrectly logged. */
3840 if (!continue_transport) continue_sequence = 1;
3845 /*************************************************
3846 * Wait for one remote delivery subprocess *
3847 *************************************************/
3849 /* This function is called while doing remote deliveries when either the
3850 maximum number of processes exist and we need one to complete so that another
3851 can be created, or when waiting for the last ones to complete. It must wait for
3852 the completion of one subprocess, empty the control block slot, and return a
3853 pointer to the address chain.
3856 Returns: pointer to the chain of addresses handled by the process;
3857 NULL if no subprocess found - this is an unexpected error
3860 static address_item *
3863 int poffset, status;
3864 address_item *addr, *addrlist;
3867 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3868 "to finish", message_id);
3870 /* Loop until either a subprocess completes, or there are no subprocesses in
3871 existence - in which case give an error return. We cannot proceed just by
3872 waiting for a completion, because a subprocess may have filled up its pipe, and
3873 be waiting for it to be emptied. Therefore, if no processes have finished, we
3874 wait for one of the pipes to acquire some data by calling select(), with a
3875 timeout just in case.
3877 The simple approach is just to iterate after reading data from a ready pipe.
3878 This leads to non-ideal behaviour when the subprocess has written its final Z
3879 item, closed the pipe, and is in the process of exiting (the common case). A
3880 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3881 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3884 To avoid this, if all the data that is needed has been read from a subprocess
3885 after select(), an explicit wait() for it is done. We know that all it is doing
3886 is writing to the pipe and then exiting, so the wait should not be long.
3888 The non-blocking waitpid() is to some extent just insurance; if we could
3889 reliably detect end-of-file on the pipe, we could always know when to do a
3890 blocking wait() for a completed process. However, because some systems use
3891 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3892 use code that functions without the need to recognize EOF.
3894 There's a double loop here just in case we end up with a process that is not in
3895 the list of remote delivery processes. Something has obviously gone wrong if
3896 this is the case. (For example, a process that is incorrectly left over from
3897 routing or local deliveries might be found.) The damage can be minimized by
3898 looping back and looking for another process. If there aren't any, the error
3899 return will happen. */
3901 for (;;) /* Normally we do not repeat this loop */
3903 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3906 fd_set select_pipes;
3907 int maxpipe, readycount;
3909 /* A return value of -1 can mean several things. If errno != ECHILD, it
3910 either means invalid options (which we discount), or that this process was
3911 interrupted by a signal. Just loop to try the waitpid() again.
3913 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3914 in existence. This should never happen, and is an unexpected error.
3915 However, there is a nasty complication when running under Linux. If "strace
3916 -f" is being used under Linux to trace this process and its children,
3917 subprocesses are "stolen" from their parents and become the children of the
3918 tracing process. A general wait such as the one we've just obeyed returns
3919 as if there are no children while subprocesses are running. Once a
3920 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3921 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3924 This does not happen using "truss" on Solaris, nor (I think) with other
3925 tracing facilities on other OS. It seems to be specific to Linux.
3927 What we do to get round this is to use kill() to see if any of our
3928 subprocesses are still in existence. If kill() gives an OK return, we know
3929 it must be for one of our processes - it can't be for a re-use of the pid,
3930 because if our process had finished, waitpid() would have found it. If any
3931 of our subprocesses are in existence, we proceed to use select() as if
3932 waitpid() had returned zero. I think this is safe. */
3936 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3939 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3940 "for process existence\n");
3942 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3944 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3946 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3947 "stolen by strace\n", (int)pid);
3948 break; /* With poffset set */
3952 if (poffset >= remote_max_parallel)
3954 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3955 return NULL; /* This is the error return */
3959 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3960 been handled above. A return value of zero means that there is at least one
3961 subprocess, but there are no completed subprocesses. See if any pipes are
3962 ready with any data for reading. */
3964 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3967 FD_ZERO(&select_pipes);
3968 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3969 if (parlist[poffset].pid != 0)
3971 int fd = parlist[poffset].fd;
3972 FD_SET(fd, &select_pipes);
3973 if (fd > maxpipe) maxpipe = fd;
3976 /* Stick in a 60-second timeout, just in case. */
3981 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3984 /* Scan through the pipes and read any that are ready; use the count
3985 returned by select() to stop when there are no more. Select() can return
3986 with no processes (e.g. if interrupted). This shouldn't matter.
3988 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3989 read, or there was a disaster. In either case, we are finished with this
3990 process. Do an explicit wait() for the process and break the main loop if
3993 It turns out that we have to deal with the case of an interrupted system
3994 call, which can happen on some operating systems if the signal handling is
3995 set up to do that by default. */
3998 readycount > 0 && poffset < remote_max_parallel;
4001 if ( (pid = parlist[poffset].pid) != 0
4002 && FD_ISSET(parlist[poffset].fd, &select_pipes)
4006 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4007 for (;;) /* Loop for signals */
4009 pid_t endedpid = waitpid(pid, &status, 0);
4010 if (endedpid == pid) goto PROCESS_DONE;
4011 if (endedpid != (pid_t)(-1) || errno != EINTR)
4012 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4013 "%d (errno = %d) from waitpid() for process %d",
4014 (int)endedpid, errno, (int)pid);
4019 /* Now go back and look for a completed subprocess again. */
4022 /* A completed process was detected by the non-blocking waitpid(). Find the
4023 data block that corresponds to this subprocess. */
4025 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4026 if (pid == parlist[poffset].pid) break;
4028 /* Found the data block; this is a known remote delivery process. We don't
4029 need to repeat the outer loop. This should be what normally happens. */
4031 if (poffset < remote_max_parallel) break;
4033 /* This situation is an error, but it's probably better to carry on looking
4034 for another process than to give up (as we used to do). */
4036 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4037 "transport process list", pid);
4038 } /* End of the "for" loop */
4040 /* Come here when all the data was completely read after a select(), and
4041 the process in pid has been wait()ed for. */
4048 debug_printf("remote delivery process %d ended\n", (int)pid);
4050 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4054 set_process_info("delivering %s", message_id);
4056 /* Get the chain of processed addresses */
4058 addrlist = parlist[poffset].addrlist;
4060 /* If the process did not finish cleanly, record an error and freeze (except
4061 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4062 in case the delivery did actually happen. */
4064 if ((status & 0xffff) != 0)
4067 int msb = (status >> 8) & 255;
4068 int lsb = status & 255;
4069 int code = (msb == 0)? (lsb & 0x7f) : msb;
4071 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4073 addrlist->transport->driver_name,
4075 (msb == 0)? "terminated by signal" : "exit code",
4078 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4079 addrlist->special_action = SPECIAL_FREEZE;
4081 for (addr = addrlist; addr; addr = addr->next)
4083 addr->transport_return = DEFER;
4084 addr->message = msg;
4087 remove_journal = FALSE;
4090 /* Else complete reading the pipe to get the result of the delivery, if all
4091 the data has not yet been obtained. */
4093 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4095 /* Put the data count and return path into globals, mark the data slot unused,
4096 decrement the count of subprocesses, and return the address chain. */
4098 transport_count = parlist[poffset].transport_count;
4099 used_return_path = parlist[poffset].return_path;
4100 parlist[poffset].pid = 0;
4107 /*************************************************
4108 * Wait for subprocesses and post-process *
4109 *************************************************/
4111 /* This function waits for subprocesses until the number that are still running
4112 is below a given threshold. For each complete subprocess, the addresses are
4113 post-processed. If we can't find a running process, there is some shambles.
4114 Better not bomb out, as that might lead to multiple copies of the message. Just
4115 log and proceed as if all done.
4118 max maximum number of subprocesses to leave running
4119 fallback TRUE if processing fallback hosts
4125 par_reduce(int max, BOOL fallback)
4127 while (parcount > max)
4129 address_item *doneaddr = par_wait();
4132 log_write(0, LOG_MAIN|LOG_PANIC,
4133 "remote delivery process count got out of step");
4138 transport_instance * tp = doneaddr->transport;
4139 if (tp->max_parallel)
4140 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4142 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4148 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4150 uschar pipe_header[PIPE_HEADER_SIZE+1];
4151 size_t total_len = PIPE_HEADER_SIZE + size;
4153 struct iovec iov[2] = {
4154 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4155 { buf, size } /* *the* data */
4160 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4161 /* complain to log if someone tries with buffer sizes we can't handle*/
4163 if (size > BIG_BUFFER_SIZE-1)
4165 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4166 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4168 size = BIG_BUFFER_SIZE;
4171 /* Should we check that we do not write more than PIPE_BUF? What would
4174 /* convert size to human readable string prepended by id and subid */
4175 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4176 id, subid, (long)size))
4177 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4179 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4180 id, subid, (long)size, pipe_header);
4182 if ((ret = writev(fd, iov, 2)) != total_len)
4183 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4184 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4185 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4188 /*************************************************
4189 * Do remote deliveries *
4190 *************************************************/
4192 /* This function is called to process the addresses in addr_remote. We must
4193 pick off the queue all addresses that have the same transport, remote
4194 destination, and errors address, and hand them to the transport in one go,
4195 subject to some configured limitations. If this is a run to continue delivering
4196 to an existing delivery channel, skip all but those addresses that can go to
4197 that channel. The skipped addresses just get deferred.
4199 If mua_wrapper is set, all addresses must be able to be sent in a single
4200 transaction. If not, this function yields FALSE.
4202 In Exim 4, remote deliveries are always done in separate processes, even
4203 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4204 is so that the base process can retain privilege. This makes the
4205 implementation of fallback transports feasible (though not initially done.)
4207 We create up to the configured number of subprocesses, each of which passes
4208 back the delivery state via a pipe. (However, when sending down an existing
4209 connection, remote_max_parallel is forced to 1.)
4212 fallback TRUE if processing fallback hosts
4214 Returns: TRUE normally
4215 FALSE if mua_wrapper is set and the addresses cannot all be sent
4220 do_remote_deliveries(BOOL fallback)
4225 parcount = 0; /* Number of executing subprocesses */
4227 /* When sending down an existing channel, only do one delivery at a time.
4228 We use a local variable (parmax) to hold the maximum number of processes;
4229 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4231 if (continue_transport) remote_max_parallel = 1;
4232 parmax = remote_max_parallel;
4234 /* If the data for keeping a list of processes hasn't yet been
4239 parlist = store_get(remote_max_parallel * sizeof(pardata), FALSE);
4240 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4241 parlist[poffset].pid = 0;
4244 /* Now loop for each remote delivery */
4246 for (int delivery_count = 0; addr_remote; delivery_count++)
4252 int address_count = 1;
4253 int address_count_max;
4255 BOOL use_initgroups;
4256 BOOL pipe_done = FALSE;
4257 transport_instance *tp;
4258 address_item **anchor = &addr_remote;
4259 address_item *addr = addr_remote;
4260 address_item *last = addr;
4263 uschar * serialize_key = NULL;
4265 /* Pull the first address right off the list. */
4267 addr_remote = addr->next;
4270 DEBUG(D_deliver|D_transport)
4271 debug_printf("--------> %s <--------\n", addr->address);
4273 /* If no transport has been set, there has been a big screw-up somewhere. */
4275 if (!(tp = addr->transport))
4277 f.disable_logging = FALSE; /* Jic */
4278 panicmsg = US"No transport set by router";
4279 goto panic_continue;
4282 /* Check that this base address hasn't previously been delivered to this
4283 transport. The check is necessary at this point to handle homonymic addresses
4284 correctly in cases where the pattern of redirection changes between delivery
4285 attempts. Non-homonymic previous delivery is detected earlier, at routing
4288 if (previously_transported(addr, FALSE)) continue;
4290 /* Force failure if the message is too big. */
4292 if (tp->message_size_limit)
4294 int rc = check_message_size(tp, addr);
4297 addr->transport_return = rc;
4298 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4303 /* Get the flag which specifies whether the transport can handle different
4304 domains that nevertheless resolve to the same set of hosts. If it needs
4305 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4306 $host, $host_address, $host_port. */
4307 if (tp->expand_multi_domain)
4308 deliver_set_expansions(addr);
4310 if (exp_bool(addr, US"transport", tp->name, D_transport,
4311 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4312 &multi_domain) != OK)
4314 deliver_set_expansions(NULL);
4315 panicmsg = addr->message;
4316 goto panic_continue;
4319 /* Get the maximum it can handle in one envelope, with zero meaning
4320 unlimited, which is forced for the MUA wrapper case. */
4322 address_count_max = tp->max_addresses;
4323 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4326 /************************************************************************/
4327 /***** This is slightly experimental code, but should be safe. *****/
4329 /* The address_count_max value is the maximum number of addresses that the
4330 transport can send in one envelope. However, the transport must be capable of
4331 dealing with any number of addresses. If the number it gets exceeds its
4332 envelope limitation, it must send multiple copies of the message. This can be
4333 done over a single connection for SMTP, so uses less resources than making
4334 multiple connections. On the other hand, if remote_max_parallel is greater
4335 than one, it is perhaps a good idea to use parallel processing to move the
4336 message faster, even if that results in multiple simultaneous connections to
4339 How can we come to some compromise between these two ideals? What we do is to
4340 limit the number of addresses passed to a single instance of a transport to
4341 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4342 number of addresses routed to remote transports divided by
4343 remote_max_parallel. For example, if the message has 100 remote recipients,
4344 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4345 once. But if rcpt_max is 100, we could send up to 100.
4347 Of course, not all the remotely addresses in a message are going to go to the
4348 same set of hosts (except in smarthost configurations), so this is just a
4349 heuristic way of dividing up the work.
4351 Furthermore (1), because this may not be wanted in some cases, and also to
4352 cope with really pathological cases, there is also a limit to the number of
4353 messages that are sent over one connection. This is the same limit that is
4354 used when sending several different messages over the same connection.
4355 Continue_sequence is set when in this situation, to the number sent so
4356 far, including this message.
4358 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4359 is probably because they are using VERP, in which case they want to pass only
4360 one address at a time to the transport, in order to be able to use
4361 $local_part and $domain in constructing a new return path. We could test for
4362 the use of these variables, but as it is so likely they will be used when the
4363 maximum is 1, we don't bother. Just leave the value alone. */
4365 if ( address_count_max != 1
4366 && address_count_max < remote_delivery_count/remote_max_parallel
4369 int new_max = remote_delivery_count/remote_max_parallel;
4370 int message_max = tp->connection_max_messages;
4371 if (connection_max_messages >= 0) message_max = connection_max_messages;
4372 message_max -= continue_sequence - 1;
4373 if (message_max > 0 && new_max > address_count_max * message_max)
4374 new_max = address_count_max * message_max;
4375 address_count_max = new_max;
4378 /************************************************************************/
4381 /* Pick off all addresses which have the same transport, errors address,
4382 destination, and extra headers. In some cases they point to the same host
4383 list, but we also need to check for identical host lists generated from
4384 entirely different domains. The host list pointers can be NULL in the case
4385 where the hosts are defined in the transport. There is also a configured
4386 maximum limit of addresses that can be handled at once (see comments above
4387 for how it is computed).
4388 If the transport does not handle multiple domains, enforce that also,
4389 and if it might need a per-address check for this, re-evaluate it.
4392 while ((next = *anchor) && address_count < address_count_max)
4395 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4396 && tp == next->transport
4397 && same_hosts(next->host_list, addr->host_list)
4398 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4399 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4400 && same_ugid(tp, next, addr)
4401 && ( next->prop.remove_headers == addr->prop.remove_headers
4402 || ( next->prop.remove_headers
4403 && addr->prop.remove_headers
4404 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4408 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4410 US"transport", next->transport->name, D_transport,
4411 US"multi_domain", next->transport->multi_domain,
4412 next->transport->expand_multi_domain, &md) == OK
4417 *anchor = next->next;
4419 next->first = addr; /* remember top one (for retry processing) */
4424 else anchor = &(next->next);
4425 deliver_set_expansions(NULL);
4428 /* If we are acting as an MUA wrapper, all addresses must go in a single
4429 transaction. If not, put them back on the chain and yield FALSE. */
4431 if (mua_wrapper && addr_remote)
4433 last->next = addr_remote;
4438 /* If the transport is limited for parallellism, enforce that here.
4439 The hints DB entry is decremented in par_reduce(), when we reap the
4440 transport process. */
4442 if (tpt_parallel_check(tp, addr, &serialize_key))
4443 if ((panicmsg = expand_string_message))
4444 goto panic_continue;
4446 continue; /* Loop for the next set of addresses. */
4448 /* Set up the expansion variables for this set of addresses */
4450 deliver_set_expansions(addr);
4452 /* Ensure any transport-set auth info is fresh */
4453 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4455 /* Compute the return path, expanding a new one if required. The old one
4456 must be set first, as it might be referred to in the expansion. */
4458 if(addr->prop.errors_address)
4459 return_path = addr->prop.errors_address;
4460 #ifdef EXPERIMENTAL_SRS
4461 else if(addr->prop.srs_sender)
4462 return_path = addr->prop.srs_sender;
4465 return_path = sender_address;
4467 if (tp->return_path)
4469 uschar *new_return_path = expand_string(tp->return_path);
4470 if (new_return_path)
4471 return_path = new_return_path;
4472 else if (!f.expand_string_forcedfail)
4474 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4475 tp->return_path, expand_string_message);
4480 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4481 logs and sets up error messages, so we just post-process and continue with
4482 the next address. */
4484 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4490 /* If this transport has a setup function, call it now so that it gets
4491 run in this process and not in any subprocess. That way, the results of
4492 any setup that are retained by the transport can be reusable. One of the
4493 things the setup does is to set the fallback host lists in the addresses.
4494 That is why it is called at this point, before the continue delivery
4495 processing, because that might use the fallback hosts. */
4498 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4500 /* If we have a connection still open from a verify stage (lazy-close)
4501 treat it as if it is a continued connection (apart from the counter used
4502 for the log line mark). */
4504 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4507 debug_printf("lazy-callout-close: have conn still open from verification\n");
4508 continue_transport = cutthrough.transport;
4509 continue_hostname = string_copy(cutthrough.host.name);
4510 continue_host_address = string_copy(cutthrough.host.address);
4511 continue_sequence = 1;
4512 sending_ip_address = cutthrough.snd_ip;
4513 sending_port = cutthrough.snd_port;
4514 smtp_peer_options = cutthrough.peer_options;
4517 /* If this is a run to continue delivery down an already-established
4518 channel, check that this set of addresses matches the transport and
4519 the channel. If it does not, defer the addresses. If a host list exists,
4520 we must check that the continue host is on the list. Otherwise, the
4521 host is set in the transport. */
4523 f.continue_more = FALSE; /* In case got set for the last lot */
4524 if (continue_transport)
4526 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4528 /* If the transport is about to override the host list do not check
4529 it here but take the cost of running the transport process to discover
4530 if the continued_hostname connection is suitable. This is a layering
4531 violation which is unfortunate as it requires we haul in the smtp
4536 smtp_transport_options_block * ob;
4538 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4539 && (ob = (smtp_transport_options_block *)tp->options_block)
4540 && ob->hosts_override && ob->hosts
4546 for (host_item * h = addr->host_list; h; h = h->next)
4547 if (Ustrcmp(h->name, continue_hostname) == 0)
4548 /*XXX should also check port here */
4549 { ok = TRUE; break; }
4553 /* Addresses not suitable; defer or queue for fallback hosts (which
4554 might be the continue host) and skip to next address. */
4558 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4559 Ustrcmp(continue_transport, tp->name) != 0
4560 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4561 : string_sprintf("no host matching %s", continue_hostname));
4562 if (serialize_key) enq_end(serialize_key);
4564 if (addr->fallback_hosts && !fallback)
4566 for (next = addr; ; next = next->next)
4568 next->host_list = next->fallback_hosts;
4569 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4570 if (!next->next) break;
4572 next->next = addr_fallback;
4573 addr_fallback = addr;
4578 for (next = addr; ; next = next->next)
4580 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4581 if (!next->next) break;
4583 next->next = addr_defer;
4590 /* Set a flag indicating whether there are further addresses that list
4591 the continued host. This tells the transport to leave the channel open,
4592 but not to pass it to another delivery process. We'd like to do that
4593 for non-continue_transport cases too but the knowlege of which host is
4594 connected to is too hard to manage. Perhaps we need a finer-grain
4595 interface to the transport. */
4597 for (next = addr_remote; next && !f.continue_more; next = next->next)
4598 for (host_item * h = next->host_list; h; h = h->next)
4599 if (Ustrcmp(h->name, continue_hostname) == 0)
4600 { f.continue_more = TRUE; break; }
4603 /* The transports set up the process info themselves as they may connect
4604 to more than one remote machine. They also have to set up the filter
4605 arguments, if required, so that the host name and address are available
4608 transport_filter_argv = NULL;
4610 /* Create the pipe for inter-process communication. If pipe creation
4611 fails, it is probably because the value of remote_max_parallel is so
4612 large that too many file descriptors for pipes have been created. Arrange
4613 to wait for a process to finish, and then try again. If we still can't
4614 create a pipe when all processes have finished, break the retry loop. */
4618 if (pipe(pfd) == 0) pipe_done = TRUE;
4619 else if (parcount > 0) parmax = parcount;
4622 /* We need to make the reading end of the pipe non-blocking. There are
4623 two different options for this. Exim is cunningly (I hope!) coded so
4624 that it can use either of them, though it prefers O_NONBLOCK, which
4625 distinguishes between EOF and no-more-data. */
4627 /* The data appears in a timely manner and we already did a select on
4628 all pipes, so I do not see a reason to use non-blocking IO here
4631 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4633 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4637 /* If the maximum number of subprocesses already exist, wait for a process
4638 to finish. If we ran out of file descriptors, parmax will have been reduced
4639 from its initial value of remote_max_parallel. */
4641 par_reduce(parmax - 1, fallback);
4644 /* If we failed to create a pipe and there were no processes to wait
4645 for, we have to give up on this one. Do this outside the above loop
4646 so that we can continue the main loop. */
4650 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4654 /* Find a free slot in the pardata list. Must do this after the possible
4655 waiting for processes to finish, because a terminating process will free
4658 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4659 if (parlist[poffset].pid == 0)
4662 /* If there isn't one, there has been a horrible disaster. */
4664 if (poffset >= remote_max_parallel)
4666 (void)close(pfd[pipe_write]);
4667 (void)close(pfd[pipe_read]);
4668 panicmsg = US"Unexpectedly no free subprocess slot";
4672 /* Now fork a subprocess to do the remote delivery, but before doing so,
4673 ensure that any cached resources are released so as not to interfere with
4674 what happens in the subprocess. */
4678 if ((pid = fork()) == 0)
4680 int fd = pfd[pipe_write];
4683 /* Setting this global in the subprocess means we need never clear it */
4684 transport_name = tp->name;
4686 /* There are weird circumstances in which logging is disabled */
4687 f.disable_logging = tp->disable_logging;
4689 /* Show pids on debug output if parallelism possible */
4691 if (parmax > 1 && (parcount > 0 || addr_remote))
4693 DEBUG(D_any|D_v) debug_selector |= D_pid;
4694 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4697 /* Reset the random number generator, so different processes don't all
4698 have the same sequence. In the test harness we want different, but
4699 predictable settings for each delivery process, so do something explicit
4700 here rather they rely on the fixed reset in the random number function. */
4702 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4704 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4705 a new process that may be forked to do another delivery down the same
4708 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4710 /* Close open file descriptors for the pipes of other processes
4711 that are running in parallel. */
4713 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4714 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4716 /* This process has inherited a copy of the file descriptor
4717 for the data file, but its file pointer is shared with all the
4718 other processes running in parallel. Therefore, we have to re-open
4719 the file in order to get a new file descriptor with its own
4720 file pointer. We don't need to lock it, as the lock is held by
4721 the parent process. There doesn't seem to be any way of doing
4722 a dup-with-new-file-pointer. */
4724 (void)close(deliver_datafile);
4726 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4728 if ((deliver_datafile = Uopen(fname,
4732 O_RDWR | O_APPEND, 0)) < 0)
4733 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4734 "parallel delivery: %s", fname, strerror(errno));
4737 /* Set the close-on-exec flag */
4739 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4743 /* Set the uid/gid of this process; bombs out on failure. */
4745 exim_setugid(uid, gid, use_initgroups,
4746 string_sprintf("remote delivery to %s with transport=%s",
4747 addr->address, tp->name));
4749 /* Close the unwanted half of this process' pipe, set the process state,
4750 and run the transport. Afterwards, transport_count will contain the number
4751 of bytes written. */
4753 (void)close(pfd[pipe_read]);
4754 set_process_info("delivering %s using %s", message_id, tp->name);
4755 debug_print_string(tp->debug_string);
4756 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4758 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4759 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4761 /* Ensure any cached resources that we used are now released */
4765 /* Pass the result back down the pipe. This is a lot more information
4766 than is needed for a local delivery. We have to send back the error
4767 status for each address, the usability status for each host that is
4768 flagged as unusable, and all the retry items. When TLS is in use, we
4769 send also the cipher and peerdn information. Each type of information
4770 is flagged by an identifying byte, and is then in a fixed format (with
4771 strings terminated by zeros), and there is a final terminator at the
4772 end. The host information and retry information is all attached to
4773 the first address, so that gets sent at the start. */
4775 /* Host unusability information: for most success cases this will
4778 for (h = addr->host_list; h; h = h->next)
4780 if (!h->address || h->status < hstatus_unusable) continue;
4781 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4782 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4785 /* The number of bytes written. This is the same for each address. Even
4786 if we sent several copies of the message down the same connection, the
4787 size of each one is the same, and it's that value we have got because
4788 transport_count gets reset before calling transport_write_message(). */
4790 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4791 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4793 /* Information about what happened to each address. Four item types are
4794 used: an optional 'X' item first, for TLS information, then an optional "C"
4795 item for any client-auth info followed by 'R' items for any retry settings,
4796 and finally an 'A' item for the remaining data. */
4798 for(; addr; addr = addr->next)
4802 /* The certificate verification status goes into the flags */
4803 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4805 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4807 # ifdef EXPERIMENTAL_TLS_RESUME
4808 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4811 /* Use an X item only if there's something to send */
4815 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4819 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4821 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4823 else if (continue_proxy_cipher)
4825 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4827 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4833 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4837 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4842 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4846 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4848 # ifndef DISABLE_OCSP
4849 if (addr->ocsp > OCSP_NOT_REQ)
4851 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4852 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4855 #endif /*DISABLE_TLS*/
4857 if (client_authenticator)
4859 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4860 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4862 if (client_authenticated_id)
4864 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4865 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4867 if (client_authenticated_sender)
4869 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4870 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4873 #ifndef DISABLE_PRDR
4874 if (testflag(addr, af_prdr_used))
4875 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4878 if (testflag(addr, af_pipelining))
4879 #ifdef SUPPORT_PIPE_CONNECT
4880 if (testflag(addr, af_early_pipe))
4881 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4884 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4886 if (testflag(addr, af_chunking_used))
4887 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4889 if (testflag(addr, af_tcp_fastopen_conn))
4890 rmt_dlv_checked_write(fd, 'T',
4891 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4895 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4896 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4898 /* Retry information: for most success cases this will be null. */
4900 for (retry_item * r = addr->retries; r; r = r->next)
4902 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4903 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4904 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4905 ptr += sizeof(r->basic_errno);
4906 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4907 ptr += sizeof(r->more_errno);
4908 if (!r->message) *ptr++ = 0; else
4910 sprintf(CS ptr, "%.512s", r->message);
4913 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4916 #ifdef SUPPORT_SOCKS
4917 if (LOGGING(proxy) && proxy_session)
4920 if (proxy_local_address)
4922 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4923 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4924 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4925 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4926 ptr += sizeof(proxy_local_port);
4930 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4934 #ifdef EXPERIMENTAL_DSN_INFO
4935 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4936 if (addr->smtp_greeting)
4938 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4939 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4940 if (addr->helo_response)
4942 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4943 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4947 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4951 /* The rest of the information goes in an 'A0' item. */
4953 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4954 ptr = big_buffer + 2;
4955 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4956 ptr += sizeof(addr->basic_errno);
4957 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4958 ptr += sizeof(addr->more_errno);
4959 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4960 ptr += sizeof(addr->delivery_usec);
4961 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4962 ptr += sizeof(addr->flags);
4964 if (!addr->message) *ptr++ = 0; else
4965 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4967 if (!addr->user_message) *ptr++ = 0; else
4968 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4970 if (!addr->host_used) *ptr++ = 0; else
4972 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4973 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4974 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4975 ptr += sizeof(addr->host_used->port);
4977 /* DNS lookup status */
4978 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4979 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4982 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4985 /* Local interface address/port */
4986 #ifdef EXPERIMENTAL_DSN_INFO
4987 if (sending_ip_address)
4989 if (LOGGING(incoming_interface) && sending_ip_address)
4993 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4994 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4995 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4998 /* Add termination flag, close the pipe, and that's it. The character
4999 after 'Z' indicates whether continue_transport is now NULL or not.
5000 A change from non-NULL to NULL indicates a problem with a continuing
5003 big_buffer[0] = continue_transport ? '1' : '0';
5004 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5009 /* Back in the mainline: close the unwanted half of the pipe. */
5011 (void)close(pfd[pipe_write]);
5013 /* If we have a connection still open from a verify stage (lazy-close)
5014 release its TLS library context (if any) as responsibility was passed to
5015 the delivery child process. */
5017 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5020 if (cutthrough.is_tls)
5021 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5023 (void) close(cutthrough.cctx.sock);
5024 release_cutthrough_connection(US"passed to transport proc");
5027 /* Fork failed; defer with error message */
5031 (void)close(pfd[pipe_read]);
5032 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5033 addr->domain, strerror(errno));
5037 /* Fork succeeded; increment the count, and remember relevant data for
5038 when the process finishes. */
5041 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5042 parlist[poffset].pid = pid;
5043 parlist[poffset].fd = pfd[pipe_read];
5044 parlist[poffset].done = FALSE;
5045 parlist[poffset].msg = NULL;
5046 parlist[poffset].return_path = return_path;
5048 /* If the process we've just started is sending a message down an existing
5049 channel, wait for it now. This ensures that only one such process runs at
5050 once, whatever the value of remote_max parallel. Otherwise, we might try to
5051 send two or more messages simultaneously down the same channel. This could
5052 happen if there are different domains that include the same host in otherwise
5053 different host lists.
5055 Also, if the transport closes down the channel, this information gets back
5056 (continue_transport gets set to NULL) before we consider any other addresses
5059 if (continue_transport) par_reduce(0, fallback);
5061 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5062 newly created process get going before we create another process. This should
5063 ensure repeatability in the tests. We only need to wait a tad. */
5065 else if (f.running_in_test_harness) millisleep(500);
5070 if (serialize_key) enq_end(serialize_key);
5072 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5076 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5077 are still running and post-process their addresses. */
5079 par_reduce(0, fallback);
5086 /*************************************************
5087 * Split an address into local part and domain *
5088 *************************************************/
5090 /* This function initializes an address for routing by splitting it up into a
5091 local part and a domain. The local part is set up twice - once in its original
5092 casing, and once in lower case, and it is dequoted. We also do the "percent
5093 hack" for configured domains. This may lead to a DEFER result if a lookup
5094 defers. When a percent-hacking takes place, we insert a copy of the original
5095 address as a new parent of this address, as if we have had a redirection.
5098 addr points to an addr_item block containing the address
5101 DEFER - could not determine if domain is %-hackable
5105 deliver_split_address(address_item * addr)
5107 uschar * address = addr->address;
5112 if (!(domain = Ustrrchr(address, '@')))
5113 return DEFER; /* should always have a domain, but just in case... */
5115 len = domain - address;
5116 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5118 /* The implication in the RFCs (though I can't say I've seen it spelled out
5119 explicitly) is that quoting should be removed from local parts at the point
5120 where they are locally interpreted. [The new draft "821" is more explicit on
5121 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5122 removing quoting backslashes and any unquoted doublequotes. */
5124 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5128 if (c == '\"') continue;
5138 /* We do the percent hack only for those domains that are listed in
5139 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5141 if (percent_hack_domains)
5144 uschar *new_address = NULL;
5145 uschar *local_part = addr->cc_local_part;
5147 deliver_domain = addr->domain; /* set $domain */
5149 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5150 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5152 && (t = Ustrrchr(local_part, '%')) != NULL
5155 new_address = string_copy(local_part);
5156 new_address[t - local_part] = '@';
5157 deliver_domain = string_copylc(t+1);
5158 local_part = string_copyn(local_part, t - local_part);
5161 if (rc == DEFER) return DEFER; /* lookup deferred */
5163 /* If hackery happened, set up new parent and alter the current address. */
5167 address_item *new_parent = store_get(sizeof(address_item), FALSE);
5168 *new_parent = *addr;
5169 addr->parent = new_parent;
5170 new_parent->child_count = 1;
5171 addr->address = new_address;
5172 addr->unique = string_copy(new_address);
5173 addr->domain = deliver_domain;
5174 addr->cc_local_part = local_part;
5175 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5180 /* Create the lowercased version of the final local part, and make that the
5181 default one to be used. */
5183 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5190 /*************************************************
5191 * Get next error message text *
5192 *************************************************/
5194 /* If f is not NULL, read the next "paragraph", from a customized error message
5195 text file, terminated by a line containing ****, and expand it.
5198 f NULL or a file to read from
5199 which string indicating which string (for errors)
5201 Returns: NULL or an expanded string
5205 next_emf(FILE *f, uschar *which)
5211 if (!f) return NULL;
5213 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5216 para = string_get(256);
5219 para = string_cat(para, buffer);
5220 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5223 if ((yield = expand_string(string_from_gstring(para))))
5226 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5227 "bounce_message_file or warn_message_file (%s): %s", which,
5228 expand_string_message);
5235 /*************************************************
5236 * Close down a passed transport channel *
5237 *************************************************/
5239 /* This function is called when a passed transport channel cannot be used.
5240 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5241 so that the function call can be the argument of a "return" statement.
5244 Returns: DELIVER_NOT_ATTEMPTED
5248 continue_closedown(void)
5250 if (continue_transport)
5251 for (transport_instance * t = transports; t; t = t->next)
5252 if (Ustrcmp(t->name, continue_transport) == 0)
5254 if (t->info->closedown) (t->info->closedown)(t);
5257 return DELIVER_NOT_ATTEMPTED;
5263 /*************************************************
5264 * Print address information *
5265 *************************************************/
5267 /* This function is called to output an address, or information about an
5268 address, for bounce or defer messages. If the hide_child flag is set, all we
5269 output is the original ancestor address.
5272 addr points to the address
5273 f the FILE to print to
5274 si an initial string
5275 sc a continuation string for before "generated"
5278 Returns: TRUE if the address is not hidden
5282 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5286 uschar *printed = US"";
5287 address_item *ancestor = addr;
5288 while (ancestor->parent) ancestor = ancestor->parent;
5290 fprintf(f, "%s", CS si);
5292 if (addr->parent && testflag(addr, af_hide_child))
5294 printed = US"an undisclosed address";
5297 else if (!testflag(addr, af_pfr) || !addr->parent)
5298 printed = addr->address;
5302 uschar *s = addr->address;
5305 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5306 else if (addr->address[0] == '|') ss = US"pipe";
5309 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5310 printed = addr->parent->address;
5313 fprintf(f, "%s", CS string_printing(printed));
5315 if (ancestor != addr)
5317 uschar *original = ancestor->onetime_parent;
5318 if (!original) original= ancestor->address;
5319 if (strcmpic(original, printed) != 0)
5320 fprintf(f, "%s(%sgenerated from %s)", sc,
5321 ancestor != addr->parent ? "ultimately " : "",
5322 string_printing(original));
5325 if (addr->host_used)
5326 fprintf(f, "\n host %s [%s]",
5327 addr->host_used->name, addr->host_used->address);
5329 fprintf(f, "%s", CS se);
5337 /*************************************************
5338 * Print error for an address *
5339 *************************************************/
5341 /* This function is called to print the error information out of an address for
5342 a bounce or a warning message. It tries to format the message reasonably by
5343 introducing newlines. All lines are indented by 4; the initial printing
5344 position must be set before calling.
5346 This function used always to print the error. Nowadays we want to restrict it
5347 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5348 and filter "fail". We no longer pass other information willy-nilly in bounce
5349 and warning messages. Text in user_message is always output; text in message
5350 only if the af_pass_message flag is set.
5354 f the FILE to print on
5361 print_address_error(address_item *addr, FILE *f, uschar *t)
5363 int count = Ustrlen(t);
5364 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5366 if (!s && !(s = addr->user_message))
5369 fprintf(f, "\n %s", t);
5372 if (*s == '\\' && s[1] == 'n')
5382 if (*s++ == ':' && isspace(*s) && count > 45)
5384 fprintf(f, "\n "); /* sic (because space follows) */
5391 /***********************************************************
5392 * Print Diagnostic-Code for an address *
5393 ************************************************************/
5395 /* This function is called to print the error information out of an address for
5396 a bounce or a warning message. It tries to format the message reasonably as
5397 required by RFC 3461 by adding a space after each newline
5399 it uses the same logic as print_address_error() above. if af_pass_message is true
5400 and addr->message is set it uses the remote host answer. if not addr->user_message
5401 is used instead if available.
5405 f the FILE to print on
5411 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5413 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5415 /* af_pass_message and addr->message set ? print remote host answer */
5419 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5421 /* search first ": ". we assume to find the remote-MTA answer there */
5422 if (!(s = Ustrstr(addr->message, ": ")))
5423 return; /* not found, bail out */
5424 s += 2; /* skip ": " */
5425 fprintf(f, "Diagnostic-Code: smtp; ");
5427 /* no message available. do nothing */
5431 if (*s == '\\' && s[1] == 'n')
5433 fputs("\n ", f); /* as defined in RFC 3461 */
5443 /*************************************************
5444 * Check list of addresses for duplication *
5445 *************************************************/
5447 /* This function was introduced when the test for duplicate addresses that are
5448 not pipes, files, or autoreplies was moved from the middle of routing to when
5449 routing was complete. That was to fix obscure cases when the routing history
5450 affects the subsequent routing of identical addresses. This function is called
5451 after routing, to check that the final routed addresses are not duplicates.
5453 If we detect a duplicate, we remember what it is a duplicate of. Note that
5454 pipe, file, and autoreply de-duplication is handled during routing, so we must
5455 leave such "addresses" alone here, as otherwise they will incorrectly be
5458 Argument: address of list anchor
5463 do_duplicate_check(address_item **anchor)
5466 while ((addr = *anchor))
5469 if (testflag(addr, af_pfr))
5471 anchor = &(addr->next);
5473 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5475 DEBUG(D_deliver|D_route)
5476 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5477 *anchor = addr->next;
5478 addr->dupof = tnode->data.ptr;
5479 addr->next = addr_duplicate;
5480 addr_duplicate = addr;
5484 tree_add_duplicate(addr->unique, addr);
5485 anchor = &(addr->next);
5493 /************************************************/
5496 print_dsn_addr_action(FILE * f, address_item * addr,
5497 uschar * action, uschar * status)
5501 if (addr->dsn_orcpt)
5502 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5504 for (pa = addr; pa->parent; ) pa = pa->parent;
5505 fprintf(f, "Action: %s\n"
5506 "Final-Recipient: rfc822;%s\n"
5508 action, pa->address, status);
5512 /*************************************************
5513 * Deliver one message *
5514 *************************************************/
5516 /* This is the function which is called when a message is to be delivered. It
5517 is passed the id of the message. It is possible that the message no longer
5518 exists, if some other process has delivered it, and it is also possible that
5519 the message is being worked on by another process, in which case the data file
5522 If no delivery is attempted for any of the above reasons, the function returns
5523 DELIVER_NOT_ATTEMPTED.
5525 If the give_up flag is set true, do not attempt any deliveries, but instead
5526 fail all outstanding addresses and return the message to the sender (or
5529 A delivery operation has a process all to itself; we never deliver more than
5530 one message in the same process. Therefore we needn't worry too much about
5533 Liable to be called as root.
5536 id the id of the message to be delivered
5537 forced TRUE if delivery was forced by an administrator; this overrides
5538 retry delays and causes a delivery to be tried regardless
5539 give_up TRUE if an administrator has requested that delivery attempts
5542 Returns: When the global variable mua_wrapper is FALSE:
5543 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5544 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5545 When the global variable mua_wrapper is TRUE:
5546 DELIVER_MUA_SUCCEEDED if delivery succeeded
5547 DELIVER_MUA_FAILED if delivery failed
5548 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5552 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5555 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5556 time_t now = time(NULL);
5557 address_item *addr_last = NULL;
5558 uschar *filter_message = NULL;
5559 int process_recipients = RECIP_ACCEPT;
5562 extern int acl_where;
5564 uschar *info = queue_run_pid == (pid_t)0
5565 ? string_sprintf("delivering %s", id)
5566 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5568 /* If the D_process_info bit is on, set_process_info() will output debugging
5569 information. If not, we want to show this initial information if D_deliver or
5570 D_queue_run is set or in verbose mode. */
5572 set_process_info("%s", info);
5574 if ( !(debug_selector & D_process_info)
5575 && (debug_selector & (D_deliver|D_queue_run|D_v))
5577 debug_printf("%s\n", info);
5579 /* Ensure that we catch any subprocesses that are created. Although Exim
5580 sets SIG_DFL as its initial default, some routes through the code end up
5581 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5582 has been forked, but no re-exec has been done. We use sigaction rather than
5583 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5584 sure it is turned off. (There was a problem on AIX with this.) */
5588 struct sigaction act;
5589 act.sa_handler = SIG_DFL;
5590 sigemptyset(&(act.sa_mask));
5592 sigaction(SIGCHLD, &act, NULL);
5595 signal(SIGCHLD, SIG_DFL);
5598 /* Make the forcing flag available for routers and transports, set up the
5599 global message id field, and initialize the count for returned files and the
5600 message size. This use of strcpy() is OK because the length id is checked when
5601 it is obtained from a command line (the -M or -q options), and otherwise it is
5602 known to be a valid message id. */
5604 if (id != message_id)
5605 Ustrcpy(message_id, id);
5606 f.deliver_force = forced;
5610 /* Initialize some flags */
5612 update_spool = FALSE;
5613 remove_journal = TRUE;
5615 /* Set a known context for any ACLs we call via expansions */
5616 acl_where = ACL_WHERE_DELIVERY;
5618 /* Reset the random number generator, so that if several delivery processes are
5619 started from a queue runner that has already used random numbers (for sorting),
5620 they don't all get the same sequence. */
5624 /* Open and lock the message's data file. Exim locks on this one because the
5625 header file may get replaced as it is re-written during the delivery process.
5626 Any failures cause messages to be written to the log, except for missing files
5627 while queue running - another process probably completed delivery. As part of
5628 opening the data file, message_subdir gets set. */
5630 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5631 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5633 /* The value of message_size at this point has been set to the data length,
5634 plus one for the blank line that notionally precedes the data. */
5636 /* Now read the contents of the header file, which will set up the headers in
5637 store, and also the list of recipients and the tree of non-recipients and
5638 assorted flags. It updates message_size. If there is a reading or format error,
5639 give up; if the message has been around for sufficiently long, remove it. */
5642 uschar * spoolname = string_sprintf("%s-H", id);
5643 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5645 if (errno == ERRNO_SPOOLFORMAT)
5647 struct stat statbuf;
5648 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5650 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5651 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5653 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5656 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5659 /* If we managed to read the envelope data, received_time contains the
5660 time the message was received. Otherwise, we can calculate it from the
5663 if (rc != spool_read_hdrerror)
5665 received_time.tv_sec = received_time.tv_usec = 0;
5666 /*XXX subsec precision?*/
5667 for (i = 0; i < 6; i++)
5668 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5671 /* If we've had this malformed message too long, sling it. */
5673 if (now - received_time.tv_sec > keep_malformed)
5675 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5676 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5677 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5678 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5679 log_write(0, LOG_MAIN, "Message removed because older than %s",
5680 readconf_printtime(keep_malformed));
5683 (void)close(deliver_datafile);
5684 deliver_datafile = -1;
5685 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5689 /* The spool header file has been read. Look to see if there is an existing
5690 journal file for this message. If there is, it means that a previous delivery
5691 attempt crashed (program or host) before it could update the spool header file.
5692 Read the list of delivered addresses from the journal and add them to the
5693 nonrecipients tree. Then update the spool file. We can leave the journal in
5694 existence, as it will get further successful deliveries added to it in this
5695 run, and it will be deleted if this function gets to its end successfully.
5696 Otherwise it might be needed again. */
5699 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5702 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5710 && lseek(journal_fd, 0, SEEK_SET) == 0
5711 && (jread = fdopen(journal_fd, "rb"))
5714 while (Ufgets(big_buffer, big_buffer_size, jread))
5716 int n = Ustrlen(big_buffer);
5717 big_buffer[n-1] = 0;
5718 tree_add_nonrecipient(big_buffer);
5719 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5720 "journal file\n", big_buffer);
5723 if ((journal_fd = dup(fileno(jread))) < 0)
5724 journal_fd = fileno(jread);
5726 (void) fclose(jread); /* Try to not leak the FILE resource */
5728 /* Panic-dies on error */
5729 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5731 else if (errno != ENOENT)
5733 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5734 "%s", strerror(errno));
5735 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5738 /* A null recipients list indicates some kind of disaster. */
5740 if (!recipients_list)
5742 (void)close(deliver_datafile);
5743 deliver_datafile = -1;
5744 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5745 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5750 /* Handle a message that is frozen. There are a number of different things that
5751 can happen, but in the default situation, unless forced, no delivery is
5754 if (f.deliver_freeze)
5756 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5757 /* Moving to another directory removes the message from Exim's view. Other
5758 tools must be used to deal with it. Logging of this action happens in
5759 spool_move_message() and its subfunctions. */
5761 if ( move_frozen_messages
5762 && spool_move_message(id, message_subdir, US"", US"F")
5764 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5767 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5768 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5769 flag causing all recipients to be failed. The time is the age of the
5770 message, not the time since freezing. */
5772 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5774 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5775 process_recipients = RECIP_FAIL_TIMEOUT;
5778 /* For bounce messages (and others with no sender), thaw if the error message
5779 ignore timer is exceeded. The message will be discarded if this delivery
5782 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5783 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5785 /* If this is a bounce message, or there's no auto thaw, or we haven't
5786 reached the auto thaw time yet, and this delivery is not forced by an admin
5787 user, do not attempt delivery of this message. Note that forced is set for
5788 continuing messages down the same channel, in order to skip load checking and
5789 ignore hold domains, but we don't want unfreezing in that case. */
5793 if ( ( sender_address[0] == 0
5795 || now <= deliver_frozen_at + auto_thaw
5797 && ( !forced || !f.deliver_force_thaw
5798 || !f.admin_user || continue_hostname
5801 (void)close(deliver_datafile);
5802 deliver_datafile = -1;
5803 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5804 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5807 /* If delivery was forced (by an admin user), assume a manual thaw.
5808 Otherwise it's an auto thaw. */
5812 f.deliver_manual_thaw = TRUE;
5813 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5815 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5818 /* We get here if any of the rules for unfreezing have triggered. */
5820 f.deliver_freeze = FALSE;
5821 update_spool = TRUE;
5825 /* Open the message log file if we are using them. This records details of
5826 deliveries, deferments, and failures for the benefit of the mail administrator.
5827 The log is not used by exim itself to track the progress of a message; that is
5828 done by rewriting the header spool file. */
5832 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5836 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5838 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5839 fname, strerror(errno));
5840 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5843 /* Make a C stream out of it. */
5845 if (!(message_log = fdopen(fd, "a")))
5847 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5848 fname, strerror(errno));
5849 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5854 /* If asked to give up on a message, log who did it, and set the action for all
5859 struct passwd *pw = getpwuid(real_uid);
5860 log_write(0, LOG_MAIN, "cancelled by %s",
5861 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5862 process_recipients = RECIP_FAIL;
5865 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5867 else if (received_count > received_headers_max)
5868 process_recipients = RECIP_FAIL_LOOP;
5870 /* Otherwise, if a system-wide, address-independent message filter is
5871 specified, run it now, except in the case when we are failing all recipients as
5872 a result of timeout_frozen_after. If the system filter yields "delivered", then
5873 ignore the true recipients of the message. Failure of the filter file is
5874 logged, and the delivery attempt fails. */
5876 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5881 redirect_block redirect;
5883 if (system_filter_uid_set)
5885 ugid.uid = system_filter_uid;
5886 ugid.gid = system_filter_gid;
5887 ugid.uid_set = ugid.gid_set = TRUE;
5890 ugid.uid_set = ugid.gid_set = FALSE;
5892 return_path = sender_address;
5893 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5894 f.system_filtering = TRUE;
5896 /* Any error in the filter file causes a delivery to be abandoned. */
5898 redirect.string = system_filter;
5899 redirect.isfile = TRUE;
5900 redirect.check_owner = redirect.check_group = FALSE;
5901 redirect.owners = NULL;
5902 redirect.owngroups = NULL;
5904 redirect.modemask = 0;
5906 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5909 &redirect, /* Where the data is */
5910 RDO_DEFER | /* Turn on all the enabling options */
5911 RDO_FAIL | /* Leave off all the disabling options */
5916 NULL, /* No :include: restriction (not used in filter) */
5917 NULL, /* No sieve vacation directory (not sieve!) */
5918 NULL, /* No sieve enotify mailto owner (not sieve!) */
5919 NULL, /* No sieve user address (not sieve!) */
5920 NULL, /* No sieve subaddress (not sieve!) */
5921 &ugid, /* uid/gid data */
5922 &addr_new, /* Where to hang generated addresses */
5923 &filter_message, /* Where to put error message */
5924 NULL, /* Don't skip syntax errors */
5925 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5926 US"system filter"); /* For error messages */
5928 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5930 if (rc == FF_ERROR || rc == FF_NONEXIST)
5932 (void)close(deliver_datafile);
5933 deliver_datafile = -1;
5934 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5935 string_printing(filter_message));
5936 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5939 /* Reset things. If the filter message is an empty string, which can happen
5940 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5942 f.system_filtering = FALSE;
5943 f.enable_dollar_recipients = FALSE;
5944 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5946 /* Save the values of the system filter variables so that user filters
5949 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5951 /* The filter can request that delivery of the original addresses be
5956 process_recipients = RECIP_DEFER;
5957 deliver_msglog("Delivery deferred by system filter\n");
5958 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5961 /* The filter can request that a message be frozen, but this does not
5962 take place if the message has been manually thawed. In that case, we must
5963 unset "delivered", which is forced by the "freeze" command to make -bF
5966 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5968 f.deliver_freeze = TRUE;
5969 deliver_frozen_at = time(NULL);
5970 process_recipients = RECIP_DEFER;
5971 frozen_info = string_sprintf(" by the system filter%s%s",
5972 filter_message ? US": " : US"",
5973 filter_message ? filter_message : US"");
5976 /* The filter can request that a message be failed. The error message may be
5977 quite long - it is sent back to the sender in the bounce - but we don't want
5978 to fill up the log with repetitions of it. If it starts with << then the text
5979 between << and >> is written to the log, with the rest left for the bounce
5982 else if (rc == FF_FAIL)
5984 uschar *colon = US"";
5985 uschar *logmsg = US"";
5988 process_recipients = RECIP_FAIL_FILTER;
5994 if ( filter_message[0] == '<'
5995 && filter_message[1] == '<'
5996 && (logend = Ustrstr(filter_message, ">>"))
5999 logmsg = filter_message + 2;
6000 loglen = logend - logmsg;
6001 filter_message = logend + 2;
6002 if (filter_message[0] == 0) filter_message = NULL;
6006 logmsg = filter_message;
6007 loglen = Ustrlen(filter_message);
6011 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6015 /* Delivery can be restricted only to those recipients (if any) that the
6016 filter specified. */
6018 else if (rc == FF_DELIVERED)
6020 process_recipients = RECIP_IGNORE;
6022 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6024 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6027 /* If any new addresses were created by the filter, fake up a "parent"
6028 for them. This is necessary for pipes, etc., which are expected to have
6029 parents, and it also gives some sensible logging for others. Allow
6030 pipes, files, and autoreplies, and run them as the filter uid if set,
6031 otherwise as the current uid. */
6035 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6036 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6038 /* The text "system-filter" is tested in transport_set_up_command() and in
6039 set_up_shell_command() in the pipe transport, to enable them to permit
6040 $recipients, so don't change it here without also changing it there. */
6042 address_item *p = addr_new;
6043 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6045 parent->domain = string_copylc(qualify_domain_recipient);
6046 parent->local_part = US"system-filter";
6048 /* As part of this loop, we arrange for addr_last to end up pointing
6049 at the final address. This is used if we go on to add addresses for the
6050 original recipients. */
6054 if (parent->child_count == USHRT_MAX)
6055 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6056 "than %d delivery addresses", USHRT_MAX);
6057 parent->child_count++;
6060 if (testflag(p, af_pfr))
6066 setflag(p, af_uid_set);
6067 setflag(p, af_gid_set);
6068 setflag(p, af_allow_file);
6069 setflag(p, af_allow_pipe);
6070 setflag(p, af_allow_reply);
6072 /* Find the name of the system filter's appropriate pfr transport */
6074 if (p->address[0] == '|')
6077 tpname = system_filter_pipe_transport;
6078 address_pipe = p->address;
6080 else if (p->address[0] == '>')
6083 tpname = system_filter_reply_transport;
6087 if (p->address[Ustrlen(p->address)-1] == '/')
6089 type = US"directory";
6090 tpname = system_filter_directory_transport;
6095 tpname = system_filter_file_transport;
6097 address_file = p->address;
6100 /* Now find the actual transport, first expanding the name. We have
6101 set address_file or address_pipe above. */
6105 uschar *tmp = expand_string(tpname);
6106 address_file = address_pipe = NULL;
6108 p->message = string_sprintf("failed to expand \"%s\" as a "
6109 "system filter transport name", tpname);
6110 if (is_tainted(tmp))
6111 p->message = string_sprintf("attempt to used tainted value '%s' for"
6112 "transport '%s' as a system filter", tmp, tpname);
6116 p->message = string_sprintf("system_filter_%s_transport is unset",
6121 transport_instance *tp;
6122 for (tp = transports; tp; tp = tp->next)
6123 if (Ustrcmp(tp->name, tpname) == 0)
6129 p->message = string_sprintf("failed to find \"%s\" transport "
6130 "for system filter delivery", tpname);
6133 /* If we couldn't set up a transport, defer the delivery, putting the
6134 error on the panic log as well as the main log. */
6138 address_item *badp = p;
6140 if (!addr_last) addr_new = p; else addr_last->next = p;
6141 badp->local_part = badp->address; /* Needed for log line */
6142 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6145 } /* End of pfr handling */
6147 /* Either a non-pfr delivery, or we found a transport */
6149 DEBUG(D_deliver|D_filter)
6150 debug_printf("system filter added %s\n", p->address);
6154 } /* Loop through all addr_new addresses */
6159 /* Scan the recipients list, and for every one that is not in the non-
6160 recipients tree, add an addr item to the chain of new addresses. If the pno
6161 value is non-negative, we must set the onetime parent from it. This which
6162 points to the relevant entry in the recipients list.
6164 This processing can be altered by the setting of the process_recipients
6165 variable, which is changed if recipients are to be ignored, failed, or
6166 deferred. This can happen as a result of system filter activity, or if the -Mg
6167 option is used to fail all of them.
6169 Duplicate addresses are handled later by a different tree structure; we can't
6170 just extend the non-recipients tree, because that will be re-written to the
6171 spool if the message is deferred, and in any case there are casing
6172 complications for local addresses. */
6174 if (process_recipients != RECIP_IGNORE)
6175 for (i = 0; i < recipients_count; i++)
6176 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6178 recipient_item *r = recipients_list + i;
6179 address_item *new = deliver_make_addr(r->address, FALSE);
6180 new->prop.errors_address = r->errors_to;
6182 if ((new->prop.utf8_msg = message_smtputf8))
6184 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6185 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6186 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6187 new->prop.utf8_downcvt ? "yes"
6188 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6194 new->onetime_parent = recipients_list[r->pno].address;
6196 /* If DSN support is enabled, set the dsn flags and the original receipt
6197 to be passed on to other DSN enabled MTAs */
6198 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6199 new->dsn_orcpt = r->orcpt;
6200 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6201 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6203 switch (process_recipients)
6205 /* RECIP_DEFER is set when a system filter freezes a message. */
6208 new->next = addr_defer;
6213 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6216 case RECIP_FAIL_FILTER:
6218 filter_message ? filter_message : US"delivery cancelled";
6219 setflag(new, af_pass_message);
6220 goto RECIP_QUEUE_FAILED; /* below */
6223 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6224 than the value in timeout_frozen_after. Treat non-bounce messages
6225 similarly to -Mg; for bounce messages we just want to discard, so
6226 don't put the address on the failed list. The timeout has already
6229 case RECIP_FAIL_TIMEOUT:
6230 new->message = US"delivery cancelled; message timed out";
6231 goto RECIP_QUEUE_FAILED; /* below */
6234 /* RECIP_FAIL is set when -Mg has been used. */
6237 new->message = US"delivery cancelled by administrator";
6240 /* Common code for the failure cases above. If this is not a bounce
6241 message, put the address on the failed list so that it is used to
6242 create a bounce. Otherwise do nothing - this just discards the address.
6243 The incident has already been logged. */
6246 if (sender_address[0])
6248 new->next = addr_failed;
6254 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6255 in the message. Process each address as a routing failure; if this
6256 is a bounce message, it will get frozen. */
6258 case RECIP_FAIL_LOOP:
6259 new->message = US"Too many \"Received\" headers - suspected mail loop";
6260 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6264 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6267 if (!addr_new) addr_new = new; else addr_last->next = new;
6272 #ifndef DISABLE_EVENT
6273 if (process_recipients != RECIP_ACCEPT && event_action)
6275 uschar * save_local = deliver_localpart;
6276 const uschar * save_domain = deliver_domain;
6277 uschar * addr = new->address, * errmsg = NULL;
6278 int start, end, dom;
6280 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6281 log_write(0, LOG_MAIN|LOG_PANIC,
6282 "failed to parse address '%.100s': %s\n", addr, errmsg);
6286 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6287 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6289 event_raise(event_action, US"msg:fail:internal", new->message);
6291 deliver_localpart = save_local;
6292 deliver_domain = save_domain;
6300 debug_printf("Delivery address list:\n");
6301 for (address_item * p = addr_new; p; p = p->next)
6302 debug_printf(" %s %s\n", p->address,
6303 p->onetime_parent ? p->onetime_parent : US"");
6306 /* Set up the buffers used for copying over the file when delivering. */
6308 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6309 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6313 /* Until there are no more new addresses, handle each one as follows:
6315 . If this is a generated address (indicated by the presence of a parent
6316 pointer) then check to see whether it is a pipe, file, or autoreply, and
6317 if so, handle it directly here. The router that produced the address will
6318 have set the allow flags into the address, and also set the uid/gid required.
6319 Having the routers generate new addresses and then checking them here at
6320 the outer level is tidier than making each router do the checking, and
6321 means that routers don't need access to the failed address queue.
6323 . Break up the address into local part and domain, and make lowercased
6324 versions of these strings. We also make unquoted versions of the local part.
6326 . Handle the percent hack for those domains for which it is valid.
6328 . For child addresses, determine if any of the parents have the same address.
6329 If so, generate a different string for previous delivery checking. Without
6330 this code, if the address spqr generates spqr via a forward or alias file,
6331 delivery of the generated spqr stops further attempts at the top level spqr,
6332 which is not what is wanted - it may have generated other addresses.
6334 . Check on the retry database to see if routing was previously deferred, but
6335 only if in a queue run. Addresses that are to be routed are put on the
6336 addr_route chain. Addresses that are to be deferred are put on the
6337 addr_defer chain. We do all the checking first, so as not to keep the
6338 retry database open any longer than necessary.
6340 . Now we run the addresses through the routers. A router may put the address
6341 on either the addr_local or the addr_remote chain for local or remote
6342 delivery, respectively, or put it on the addr_failed chain if it is
6343 undeliveable, or it may generate child addresses and put them on the
6344 addr_new chain, or it may defer an address. All the chain anchors are
6345 passed as arguments so that the routers can be called for verification
6348 . If new addresses have been generated by the routers, da capo.
6351 f.header_rewritten = FALSE; /* No headers rewritten yet */
6352 while (addr_new) /* Loop until all addresses dealt with */
6354 address_item *addr, *parent;
6356 /* Failure to open the retry database is treated the same as if it does
6357 not exist. In both cases, dbm_file is NULL. */
6359 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6360 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6361 debug_printf("no retry data available\n");
6363 /* Scan the current batch of new addresses, to handle pipes, files and
6364 autoreplies, and determine which others are ready for routing. */
6371 dbdata_retry *domain_retry_record;
6372 dbdata_retry *address_retry_record;
6375 addr_new = addr->next;
6377 DEBUG(D_deliver|D_retry|D_route)
6379 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6380 debug_printf("Considering: %s\n", addr->address);
6383 /* Handle generated address that is a pipe or a file or an autoreply. */
6385 if (testflag(addr, af_pfr))
6387 /* If an autoreply in a filter could not generate a syntactically valid
6388 address, give up forthwith. Set af_ignore_error so that we don't try to
6389 generate a bounce. */
6391 if (testflag(addr, af_bad_reply))
6393 addr->basic_errno = ERRNO_BADADDRESS2;
6394 addr->local_part = addr->address;
6396 US"filter autoreply generated syntactically invalid recipient";
6397 addr->prop.ignore_error = TRUE;
6398 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6399 continue; /* with the next new address */
6402 /* If two different users specify delivery to the same pipe or file or
6403 autoreply, there should be two different deliveries, so build a unique
6404 string that incorporates the original address, and use this for
6405 duplicate testing and recording delivery, and also for retrying. */
6408 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6409 (testflag(addr->parent, af_homonym)? 3:0));
6411 addr->address_retry_key = addr->domain_retry_key =
6412 string_sprintf("T:%s", addr->unique);
6414 /* If a filter file specifies two deliveries to the same pipe or file,
6415 we want to de-duplicate, but this is probably not wanted for two mail
6416 commands to the same address, where probably both should be delivered.
6417 So, we have to invent a different unique string in that case. Just
6418 keep piling '>' characters on the front. */
6420 if (addr->address[0] == '>')
6421 while (tree_search(tree_duplicates, addr->unique))
6422 addr->unique = string_sprintf(">%s", addr->unique);
6424 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6426 DEBUG(D_deliver|D_route)
6427 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6428 addr->dupof = tnode->data.ptr;
6429 addr->next = addr_duplicate;
6430 addr_duplicate = addr;
6434 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6436 /* Check for previous delivery */
6438 if (tree_search(tree_nonrecipients, addr->unique))
6440 DEBUG(D_deliver|D_route)
6441 debug_printf("%s was previously delivered: discarded\n", addr->address);
6442 child_done(addr, tod_stamp(tod_log));
6446 /* Save for checking future duplicates */
6448 tree_add_duplicate(addr->unique, addr);
6450 /* Set local part and domain */
6452 addr->local_part = addr->address;
6453 addr->domain = addr->parent->domain;
6455 /* Ensure that the delivery is permitted. */
6457 if (testflag(addr, af_file))
6459 if (!testflag(addr, af_allow_file))
6461 addr->basic_errno = ERRNO_FORBIDFILE;
6462 addr->message = US"delivery to file forbidden";
6463 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6464 continue; /* with the next new address */
6467 else if (addr->address[0] == '|')
6469 if (!testflag(addr, af_allow_pipe))
6471 addr->basic_errno = ERRNO_FORBIDPIPE;
6472 addr->message = US"delivery to pipe forbidden";
6473 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6474 continue; /* with the next new address */
6477 else if (!testflag(addr, af_allow_reply))
6479 addr->basic_errno = ERRNO_FORBIDREPLY;
6480 addr->message = US"autoreply forbidden";
6481 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6482 continue; /* with the next new address */
6485 /* If the errno field is already set to BADTRANSPORT, it indicates
6486 failure to expand a transport string, or find the associated transport,
6487 or an unset transport when one is required. Leave this test till now so
6488 that the forbid errors are given in preference. */
6490 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6492 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6496 /* Treat /dev/null as a special case and abandon the delivery. This
6497 avoids having to specify a uid on the transport just for this case.
6498 Arrange for the transport name to be logged as "**bypassed**". */
6500 if (Ustrcmp(addr->address, "/dev/null") == 0)
6502 uschar *save = addr->transport->name;
6503 addr->transport->name = US"**bypassed**";
6504 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6505 addr->transport->name = save;
6506 continue; /* with the next new address */
6509 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6512 DEBUG(D_deliver|D_route)
6513 debug_printf("queued for %s transport\n", addr->transport->name);
6514 addr->next = addr_local;
6516 continue; /* with the next new address */
6519 /* Handle normal addresses. First, split up into local part and domain,
6520 handling the %-hack if necessary. There is the possibility of a defer from
6521 a lookup in percent_hack_domains. */
6523 if ((rc = deliver_split_address(addr)) == DEFER)
6525 addr->message = US"cannot check percent_hack_domains";
6526 addr->basic_errno = ERRNO_LISTDEFER;
6527 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6531 /* Check to see if the domain is held. If so, proceed only if the
6532 delivery was forced by hand. */
6534 deliver_domain = addr->domain; /* set $domain */
6535 if ( !forced && hold_domains
6536 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6537 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6543 addr->message = US"hold_domains lookup deferred";
6544 addr->basic_errno = ERRNO_LISTDEFER;
6548 addr->message = US"domain is held";
6549 addr->basic_errno = ERRNO_HELD;
6551 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6555 /* Now we can check for duplicates and previously delivered addresses. In
6556 order to do this, we have to generate a "unique" value for each address,
6557 because there may be identical actual addresses in a line of descendents.
6558 The "unique" field is initialized to the same value as the "address" field,
6559 but gets changed here to cope with identically-named descendents. */
6561 for (parent = addr->parent; parent; parent = parent->parent)
6562 if (strcmpic(addr->address, parent->address) == 0) break;
6564 /* If there's an ancestor with the same name, set the homonym flag. This
6565 influences how deliveries are recorded. Then add a prefix on the front of
6566 the unique address. We use \n\ where n starts at 0 and increases each time.
6567 It is unlikely to pass 9, but if it does, it may look odd but will still
6568 work. This means that siblings or cousins with the same names are treated
6569 as duplicates, which is what we want. */
6573 setflag(addr, af_homonym);
6574 if (parent->unique[0] != '\\')
6575 addr->unique = string_sprintf("\\0\\%s", addr->address);
6577 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6581 /* Ensure that the domain in the unique field is lower cased, because
6582 domains are always handled caselessly. */
6584 p = Ustrrchr(addr->unique, '@');
6585 while (*p != 0) { *p = tolower(*p); p++; }
6587 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6589 if (tree_search(tree_nonrecipients, addr->unique))
6591 DEBUG(D_deliver|D_route)
6592 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6593 child_done(addr, tod_stamp(tod_log));
6597 /* Get the routing retry status, saving the two retry keys (with and
6598 without the local part) for subsequent use. If there is no retry record for
6599 the standard address routing retry key, we look for the same key with the
6600 sender attached, because this form is used by the smtp transport after a
6601 4xx response to RCPT when address_retry_include_sender is true. */
6603 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6604 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6609 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6610 if ( domain_retry_record
6611 && now - domain_retry_record->time_stamp > retry_data_expire
6614 DEBUG(D_deliver|D_retry)
6615 debug_printf("domain retry record present but expired\n");
6616 domain_retry_record = NULL; /* Ignore if too old */
6619 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6620 if ( address_retry_record
6621 && now - address_retry_record->time_stamp > retry_data_expire
6624 DEBUG(D_deliver|D_retry)
6625 debug_printf("address retry record present but expired\n");
6626 address_retry_record = NULL; /* Ignore if too old */
6629 if (!address_retry_record)
6631 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6633 address_retry_record = dbfn_read(dbm_file, altkey);
6634 if ( address_retry_record
6635 && now - address_retry_record->time_stamp > retry_data_expire)
6637 DEBUG(D_deliver|D_retry)
6638 debug_printf("address<sender> retry record present but expired\n");
6639 address_retry_record = NULL; /* Ignore if too old */
6644 domain_retry_record = address_retry_record = NULL;
6646 DEBUG(D_deliver|D_retry)
6648 if (!domain_retry_record)
6649 debug_printf("no domain retry record\n");
6651 debug_printf("have domain retry record; next_try = now%+d\n",
6652 f.running_in_test_harness ? 0 :
6653 (int)(domain_retry_record->next_try - now));
6655 if (!address_retry_record)
6656 debug_printf("no address retry record\n");
6658 debug_printf("have address retry record; next_try = now%+d\n",
6659 f.running_in_test_harness ? 0 :
6660 (int)(address_retry_record->next_try - now));
6663 /* If we are sending a message down an existing SMTP connection, we must
6664 assume that the message which created the connection managed to route
6665 an address to that connection. We do not want to run the risk of taking
6666 a long time over routing here, because if we do, the server at the other
6667 end of the connection may time it out. This is especially true for messages
6668 with lots of addresses. For this kind of delivery, queue_running is not
6669 set, so we would normally route all addresses. We take a pragmatic approach
6670 and defer routing any addresses that have any kind of domain retry record.
6671 That is, we don't even look at their retry times. It doesn't matter if this
6672 doesn't work occasionally. This is all just an optimization, after all.
6674 The reason for not doing the same for address retries is that they normally
6675 arise from 4xx responses, not DNS timeouts. */
6677 if (continue_hostname && domain_retry_record)
6679 addr->message = US"reusing SMTP connection skips previous routing defer";
6680 addr->basic_errno = ERRNO_RRETRY;
6681 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6683 addr->message = domain_retry_record->text;
6684 setflag(addr, af_pass_message);
6687 /* If we are in a queue run, defer routing unless there is no retry data or
6688 we've passed the next retry time, or this message is forced. In other
6689 words, ignore retry data when not in a queue run.
6691 However, if the domain retry time has expired, always allow the routing
6692 attempt. If it fails again, the address will be failed. This ensures that
6693 each address is routed at least once, even after long-term routing
6696 If there is an address retry, check that too; just wait for the next
6697 retry time. This helps with the case when the temporary error on the
6698 address was really message-specific rather than address specific, since
6699 it allows other messages through.
6701 We also wait for the next retry time if this is a message sent down an
6702 existing SMTP connection (even though that will be forced). Otherwise there
6703 will be far too many attempts for an address that gets a 4xx error. In
6704 fact, after such an error, we should not get here because, the host should
6705 not be remembered as one this message needs. However, there was a bug that
6706 used to cause this to happen, so it is best to be on the safe side.
6708 Even if we haven't reached the retry time in the hints, there is one more
6709 check to do, which is for the ultimate address timeout. We only do this
6710 check if there is an address retry record and there is not a domain retry
6711 record; this implies that previous attempts to handle the address had the
6712 retry_use_local_parts option turned on. We use this as an approximation
6713 for the destination being like a local delivery, for example delivery over
6714 LMTP to an IMAP message store. In this situation users are liable to bump
6715 into their quota and thereby have intermittently successful deliveries,
6716 which keep the retry record fresh, which can lead to us perpetually
6717 deferring messages. */
6719 else if ( ( f.queue_running && !f.deliver_force
6720 || continue_hostname
6722 && ( ( domain_retry_record
6723 && now < domain_retry_record->next_try
6724 && !domain_retry_record->expired
6726 || ( address_retry_record
6727 && now < address_retry_record->next_try
6729 && ( domain_retry_record
6730 || !address_retry_record
6731 || !retry_ultimate_address_timeout(addr->address_retry_key,
6732 addr->domain, address_retry_record, now)
6735 addr->message = US"retry time not reached";
6736 addr->basic_errno = ERRNO_RRETRY;
6737 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6739 /* For remote-retry errors (here and just above) that we've not yet
6740 hit the retry time, use the error recorded in the retry database
6741 as info in the warning message. This lets us send a message even
6742 when we're not failing on a fresh attempt. We assume that this
6743 info is not sensitive. */
6745 addr->message = domain_retry_record
6746 ? domain_retry_record->text : address_retry_record->text;
6747 setflag(addr, af_pass_message);
6750 /* The domain is OK for routing. Remember if retry data exists so it
6751 can be cleaned up after a successful delivery. */
6755 if (domain_retry_record || address_retry_record)
6756 setflag(addr, af_dr_retry_exists);
6757 addr->next = addr_route;
6759 DEBUG(D_deliver|D_route)
6760 debug_printf("%s: queued for routing\n", addr->address);
6764 /* The database is closed while routing is actually happening. Requests to
6765 update it are put on a chain and all processed together at the end. */
6767 if (dbm_file) dbfn_close(dbm_file);
6769 /* If queue_domains is set, we don't even want to try routing addresses in
6770 those domains. During queue runs, queue_domains is forced to be unset.
6771 Optimize by skipping this pass through the addresses if nothing is set. */
6773 if (!f.deliver_force && queue_domains)
6775 address_item *okaddr = NULL;
6778 address_item *addr = addr_route;
6779 addr_route = addr->next;
6781 deliver_domain = addr->domain; /* set $domain */
6782 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6783 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6787 addr->basic_errno = ERRNO_LISTDEFER;
6788 addr->message = US"queue_domains lookup deferred";
6789 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6793 addr->next = okaddr;
6798 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6799 addr->message = US"domain is in queue_domains";
6800 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6804 addr_route = okaddr;
6807 /* Now route those addresses that are not deferred. */
6812 address_item *addr = addr_route;
6813 const uschar *old_domain = addr->domain;
6814 uschar *old_unique = addr->unique;
6815 addr_route = addr->next;
6818 /* Just in case some router parameter refers to it. */
6820 if (!(return_path = addr->prop.errors_address))
6821 return_path = sender_address;
6823 /* If a router defers an address, add a retry item. Whether or not to
6824 use the local part in the key is a property of the router. */
6826 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6827 &addr_succeed, v_none)) == DEFER)
6828 retry_add_item(addr,
6829 addr->router->retry_use_local_part
6830 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6831 : string_sprintf("R:%s", addr->domain),
6834 /* Otherwise, if there is an existing retry record in the database, add
6835 retry items to delete both forms. We must also allow for the possibility
6836 of a routing retry that includes the sender address. Since the domain might
6837 have been rewritten (expanded to fully qualified) as a result of routing,
6838 ensure that the rewritten form is also deleted. */
6840 else if (testflag(addr, af_dr_retry_exists))
6842 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6844 retry_add_item(addr, altkey, rf_delete);
6845 retry_add_item(addr, addr->address_retry_key, rf_delete);
6846 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6847 if (Ustrcmp(addr->domain, old_domain) != 0)
6848 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6851 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6852 logged, but we need to ensure the address (and maybe parents) is marked
6857 address_done(addr, tod_stamp(tod_log));
6858 continue; /* route next address */
6861 /* The address is finished with (failed or deferred). */
6865 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6866 continue; /* route next address */
6869 /* The address has been routed. If the router changed the domain, it will
6870 also have changed the unique address. We have to test whether this address
6871 has already been delivered, because it's the unique address that finally
6874 if ( addr->unique != old_unique
6875 && tree_search(tree_nonrecipients, addr->unique) != 0
6878 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6879 "discarded\n", addr->address);
6880 if (addr_remote == addr) addr_remote = addr->next;
6881 else if (addr_local == addr) addr_local = addr->next;
6884 /* If the router has same_domain_copy_routing set, we are permitted to copy
6885 the routing for any other addresses with the same domain. This is an
6886 optimisation to save repeated DNS lookups for "standard" remote domain
6887 routing. The option is settable only on routers that generate host lists.
6888 We play it very safe, and do the optimization only if the address is routed
6889 to a remote transport, there are no header changes, and the domain was not
6890 modified by the router. */
6892 if ( addr_remote == addr
6893 && addr->router->same_domain_copy_routing
6894 && !addr->prop.extra_headers
6895 && !addr->prop.remove_headers
6896 && old_domain == addr->domain
6899 address_item **chain = &addr_route;
6902 address_item *addr2 = *chain;
6903 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6905 chain = &(addr2->next);
6909 /* Found a suitable address; take it off the routing list and add it to
6910 the remote delivery list. */
6912 *chain = addr2->next;
6913 addr2->next = addr_remote;
6914 addr_remote = addr2;
6916 /* Copy the routing data */
6918 addr2->domain = addr->domain;
6919 addr2->router = addr->router;
6920 addr2->transport = addr->transport;
6921 addr2->host_list = addr->host_list;
6922 addr2->fallback_hosts = addr->fallback_hosts;
6923 addr2->prop.errors_address = addr->prop.errors_address;
6924 copyflag(addr2, addr, af_hide_child);
6925 copyflag(addr2, addr, af_local_host_removed);
6927 DEBUG(D_deliver|D_route)
6928 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6930 "Routing for %s copied from %s\n",
6931 addr2->address, addr2->address, addr->address);
6934 } /* Continue with routing the next address. */
6935 } /* Loop to process any child addresses that the routers created, and
6936 any rerouted addresses that got put back on the new chain. */
6939 /* Debugging: show the results of the routing */
6941 DEBUG(D_deliver|D_retry|D_route)
6943 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6944 debug_printf("After routing:\n Local deliveries:\n");
6945 for (address_item * p = addr_local; p; p = p->next)
6946 debug_printf(" %s\n", p->address);
6948 debug_printf(" Remote deliveries:\n");
6949 for (address_item * p = addr_remote; p; p = p->next)
6950 debug_printf(" %s\n", p->address);
6952 debug_printf(" Failed addresses:\n");
6953 for (address_item * p = addr_failed; p; p = p->next)
6954 debug_printf(" %s\n", p->address);
6956 debug_printf(" Deferred addresses:\n");
6957 for (address_item * p = addr_defer; p; p = p->next)
6958 debug_printf(" %s\n", p->address);
6961 /* Free any resources that were cached during routing. */
6966 /* These two variables are set only during routing, after check_local_user.
6967 Ensure they are not set in transports. */
6969 local_user_gid = (gid_t)(-1);
6970 local_user_uid = (uid_t)(-1);
6972 /* Check for any duplicate addresses. This check is delayed until after
6973 routing, because the flexibility of the routing configuration means that
6974 identical addresses with different parentage may end up being redirected to
6975 different addresses. Checking for duplicates too early (as we previously used
6976 to) makes this kind of thing not work. */
6978 do_duplicate_check(&addr_local);
6979 do_duplicate_check(&addr_remote);
6981 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6982 remote transport. The check that they all end up in one transaction happens in
6983 the do_remote_deliveries() function. */
6986 && (addr_local || addr_failed || addr_defer)
6990 uschar *which, *colon, *msg;
6997 else if (addr_defer)
7000 which = US"deferred";
7008 while (addr->parent) addr = addr->parent;
7013 msg = addr->message;
7015 else colon = msg = US"";
7017 /* We don't need to log here for a forced failure as it will already
7018 have been logged. Defer will also have been logged, but as a defer, so we do
7019 need to do the failure logging. */
7021 if (addr != addr_failed)
7022 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7023 addr->address, which);
7025 /* Always write an error to the caller */
7027 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7030 final_yield = DELIVER_MUA_FAILED;
7031 addr_failed = addr_defer = NULL; /* So that we remove the message */
7032 goto DELIVERY_TIDYUP;
7036 /* If this is a run to continue deliveries to an external channel that is
7037 already set up, defer any local deliveries. */
7039 if (continue_transport)
7043 address_item *addr = addr_defer;
7044 while (addr->next) addr = addr->next;
7045 addr->next = addr_local;
7048 addr_defer = addr_local;
7053 /* Because address rewriting can happen in the routers, we should not really do
7054 ANY deliveries until all addresses have been routed, so that all recipients of
7055 the message get the same headers. However, this is in practice not always
7056 possible, since sometimes remote addresses give DNS timeouts for days on end.
7057 The pragmatic approach is to deliver what we can now, saving any rewritten
7058 headers so that at least the next lot of recipients benefit from the rewriting
7059 that has already been done.
7061 If any headers have been rewritten during routing, update the spool file to
7062 remember them for all subsequent deliveries. This can be delayed till later if
7063 there is only address to be delivered - if it succeeds the spool write need not
7066 if ( f.header_rewritten
7067 && ( addr_local && (addr_local->next || addr_remote)
7068 || addr_remote && addr_remote->next
7071 /* Panic-dies on error */
7072 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7073 f.header_rewritten = FALSE;
7077 /* If there are any deliveries to do and we do not already have the journal
7078 file, create it. This is used to record successful deliveries as soon as
7079 possible after each delivery is known to be complete. A file opened with
7080 O_APPEND is used so that several processes can run simultaneously.
7082 The journal is just insurance against crashes. When the spool file is
7083 ultimately updated at the end of processing, the journal is deleted. If a
7084 journal is found to exist at the start of delivery, the addresses listed
7085 therein are added to the non-recipients. */
7087 if (addr_local || addr_remote)
7091 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7093 if ((journal_fd = Uopen(fname,
7097 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7099 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7100 fname, strerror(errno));
7101 return DELIVER_NOT_ATTEMPTED;
7104 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7105 that the mode is correct - the group setting doesn't always seem to get
7106 set automatically. */
7108 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7109 || fchmod(journal_fd, SPOOL_MODE)
7111 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7115 int ret = Uunlink(fname);
7116 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7117 fname, strerror(errno));
7118 if(ret && errno != ENOENT)
7119 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7120 fname, strerror(errno));
7121 return DELIVER_NOT_ATTEMPTED;
7125 else if (journal_fd >= 0)
7133 /* Now we can get down to the business of actually doing deliveries. Local
7134 deliveries are done first, then remote ones. If ever the problems of how to
7135 handle fallback transports are figured out, this section can be put into a loop
7136 for handling fallbacks, though the uid switching will have to be revised. */
7138 /* Precompile a regex that is used to recognize a parameter in response
7139 to an LHLO command, if is isn't already compiled. This may be used on both
7140 local and remote LMTP deliveries. */
7142 if (!regex_IGNOREQUOTA)
7144 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7146 /* Handle local deliveries */
7150 DEBUG(D_deliver|D_transport)
7151 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7152 do_local_deliveries();
7153 f.disable_logging = FALSE;
7156 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7157 so just queue them all. */
7159 if (f.queue_run_local)
7162 address_item *addr = addr_remote;
7163 addr_remote = addr->next;
7165 addr->basic_errno = ERRNO_LOCAL_ONLY;
7166 addr->message = US"remote deliveries suppressed";
7167 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7170 /* Handle remote deliveries */
7174 DEBUG(D_deliver|D_transport)
7175 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7177 /* Precompile some regex that are used to recognize parameters in response
7178 to an EHLO command, if they aren't already compiled. */
7182 /* Now sort the addresses if required, and do the deliveries. The yield of
7183 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7184 cannot be delivered in one transaction. */
7186 if (remote_sort_domains) sort_remote_deliveries();
7187 if (!do_remote_deliveries(FALSE))
7189 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7190 "be delivered in one transaction");
7191 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7193 final_yield = DELIVER_MUA_FAILED;
7194 addr_failed = addr_defer = NULL; /* So that we remove the message */
7195 goto DELIVERY_TIDYUP;
7198 /* See if any of the addresses that failed got put on the queue for delivery
7199 to their fallback hosts. We do it this way because often the same fallback
7200 host is used for many domains, so all can be sent in a single transaction
7201 (if appropriately configured). */
7203 if (addr_fallback && !mua_wrapper)
7205 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7206 addr_remote = addr_fallback;
7207 addr_fallback = NULL;
7208 if (remote_sort_domains) sort_remote_deliveries();
7209 do_remote_deliveries(TRUE);
7211 f.disable_logging = FALSE;
7215 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7216 phase, to minimize cases of half-done things. */
7219 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7220 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7222 /* Root privilege is no longer needed */
7224 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7226 set_process_info("tidying up after delivering %s", message_id);
7227 signal(SIGTERM, SIG_IGN);
7229 /* When we are acting as an MUA wrapper, the smtp transport will either have
7230 succeeded for all addresses, or failed them all in normal cases. However, there
7231 are some setup situations (e.g. when a named port does not exist) that cause an
7232 immediate exit with deferral of all addresses. Convert those into failures. We
7233 do not ever want to retry, nor do we want to send a bounce message. */
7239 address_item * nextaddr;
7240 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7242 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7243 "delivery", addr->address);
7244 nextaddr = addr->next;
7245 addr->next = addr_failed;
7251 /* Now all should either have succeeded or failed. */
7254 final_yield = DELIVER_MUA_SUCCEEDED;
7258 uschar *s = addr_failed->user_message;
7260 if (!s) s = addr_failed->message;
7262 fprintf(stderr, "Delivery failed: ");
7263 if (addr_failed->basic_errno > 0)
7265 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7266 if (s) fprintf(stderr, ": ");
7268 if ((host = addr_failed->host_used))
7269 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7271 fprintf(stderr, "%s", CS s);
7272 else if (addr_failed->basic_errno <= 0)
7273 fprintf(stderr, "unknown error");
7274 fprintf(stderr, "\n");
7276 final_yield = DELIVER_MUA_FAILED;
7281 /* In a normal configuration, we now update the retry database. This is done in
7282 one fell swoop at the end in order not to keep opening and closing (and
7283 locking) the database. The code for handling retries is hived off into a
7284 separate module for convenience. We pass it the addresses of the various
7285 chains, because deferred addresses can get moved onto the failed chain if the
7286 retry cutoff time has expired for all alternative destinations. Bypass the
7287 updating of the database if the -N flag is set, which is a debugging thing that
7288 prevents actual delivery. */
7290 else if (!f.dont_deliver)
7291 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7293 /* Send DSN for successful messages if requested */
7294 addr_senddsn = NULL;
7296 for (address_item * a = addr_succeed; a; a = a->next)
7298 /* af_ignore_error not honored here. it's not an error */
7299 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7300 "DSN: processing successful delivery address: %s\n"
7301 "DSN: Sender_address: %s\n"
7302 "DSN: orcpt: %s flags: 0x%x\n"
7303 "DSN: envid: %s ret: %d\n"
7304 "DSN: Final recipient: %s\n"
7305 "DSN: Remote SMTP server supports DSN: %d\n",
7306 a->router ? a->router->name : US"(unknown)",
7309 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7311 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7316 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7317 and a report was requested */
7318 if ( ( a->dsn_aware != dsn_support_yes
7319 || a->dsn_flags & rf_dsnlasthop
7321 && a->dsn_flags & rf_notify_success
7324 /* copy and relink address_item and send report with all of them at once later */
7325 address_item * addr_next = addr_senddsn;
7326 addr_senddsn = store_get(sizeof(address_item), FALSE);
7328 addr_senddsn->next = addr_next;
7331 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7339 /* create exim process to send message */
7340 pid = child_open_exim(&fd);
7342 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7344 if (pid < 0) /* Creation of child failed */
7346 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7347 "create child process to send failure message: %s", getpid(),
7348 getppid(), strerror(errno));
7350 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7352 else /* Creation of child succeeded */
7354 FILE * f = fdopen(fd, "wb");
7355 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7357 transport_ctx tctx = {{0}};
7360 debug_printf("sending error message to: %s\n", sender_address);
7362 /* build unique id for MIME boundary */
7363 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7364 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7366 if (errors_reply_to)
7367 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7370 fprintf(f, "Auto-Submitted: auto-generated\n"
7372 "Subject: Delivery Status Notification\n"
7373 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7374 "MIME-Version: 1.0\n\n"
7377 "Content-type: text/plain; charset=us-ascii\n\n"
7379 "This message was created automatically by mail delivery software.\n"
7380 " ----- The following addresses had successful delivery notifications -----\n",
7381 sender_address, bound, bound);
7383 for (address_item * a = addr_senddsn; a; a = a->next)
7384 fprintf(f, "<%s> (relayed %s)\n\n",
7386 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7387 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7388 : "via non \"Remote SMTP\" router"
7392 "Content-type: message/delivery-status\n\n"
7393 "Reporting-MTA: dns; %s\n",
7394 bound, smtp_active_hostname);
7397 { /* must be decoded from xtext: see RFC 3461:6.3a */
7399 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7400 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7402 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7406 for (address_item * a = addr_senddsn; a; a = a->next)
7410 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7412 if ((hu = a->host_used) && hu->name)
7413 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7416 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7417 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7420 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7423 transport_filter_argv = NULL; /* Just in case */
7424 return_path = sender_address; /* In case not previously set */
7426 /* Write the original email out */
7429 tctx.options = topt_add_return_path | topt_no_body;
7430 /*XXX hmm, FALSE(fail) retval ignored.
7431 Could error for any number of reasons, and they are not handled. */
7432 transport_write_message(&tctx, 0);
7435 fprintf(f,"\n--%s--\n", bound);
7439 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7443 /* If any addresses failed, we must send a message to somebody, unless
7444 af_ignore_error is set, in which case no action is taken. It is possible for
7445 several messages to get sent if there are addresses with different
7452 uschar *logtod = tod_stamp(tod_log);
7454 address_item *handled_addr = NULL;
7455 address_item **paddr;
7456 address_item *msgchain = NULL;
7457 address_item **pmsgchain = &msgchain;
7459 /* There are weird cases when logging is disabled in the transport. However,
7460 there may not be a transport (address failed by a router). */
7462 f.disable_logging = FALSE;
7463 if (addr_failed->transport)
7464 f.disable_logging = addr_failed->transport->disable_logging;
7467 debug_printf("processing failed address %s\n", addr_failed->address);
7469 /* There are only two ways an address in a bounce message can get here:
7471 (1) When delivery was initially deferred, but has now timed out (in the call
7472 to retry_update() above). We can detect this by testing for
7473 af_retry_timedout. If the address does not have its own errors address,
7474 we arrange to ignore the error.
7476 (2) If delivery failures for bounce messages are being ignored. We can detect
7477 this by testing for af_ignore_error. This will also be set if a bounce
7478 message has been autothawed and the ignore_bounce_errors_after time has
7479 passed. It might also be set if a router was explicitly configured to
7480 ignore errors (errors_to = "").
7482 If neither of these cases obtains, something has gone wrong. Log the
7483 incident, but then ignore the error. */
7485 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7487 if ( !testflag(addr_failed, af_retry_timedout)
7488 && !addr_failed->prop.ignore_error)
7489 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7490 "failure is neither frozen nor ignored (it's been ignored)");
7492 addr_failed->prop.ignore_error = TRUE;
7495 /* If the first address on the list has af_ignore_error set, just remove
7496 it from the list, throw away any saved message file, log it, and
7497 mark the recipient done. */
7499 if ( addr_failed->prop.ignore_error
7500 || addr_failed->dsn_flags & rf_dsnflags
7501 && !(addr_failed->dsn_flags & rf_notify_failure)
7505 addr_failed = addr->next;
7506 if (addr->return_filename) Uunlink(addr->return_filename);
7508 #ifndef DISABLE_EVENT
7509 msg_event_raise(US"msg:fail:delivery", addr);
7511 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7513 !addr->parent ? US"" : US" <",
7514 !addr->parent ? US"" : addr->parent->address,
7515 !addr->parent ? US"" : US">",
7516 addr->prop.ignore_error
7517 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7519 address_done(addr, logtod);
7520 child_done(addr, logtod);
7521 /* Panic-dies on error */
7522 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7525 /* Otherwise, handle the sending of a message. Find the error address for
7526 the first address, then send a message that includes all failed addresses
7527 that have the same error address. Note the bounce_recipient is a global so
7528 that it can be accessed by $bounce_recipient while creating a customized
7533 if (!(bounce_recipient = addr_failed->prop.errors_address))
7534 bounce_recipient = sender_address;
7536 /* Make a subprocess to send a message */
7538 if ((pid = child_open_exim(&fd)) < 0)
7539 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7540 "create child process to send failure message: %s", getpid(),
7541 getppid(), strerror(errno));
7543 /* Creation of child succeeded */
7550 uschar *bcc, *emf_text;
7551 FILE * fp = fdopen(fd, "wb");
7553 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7554 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7555 DELIVER_IN_BUFFER_SIZE;
7557 uschar *dsnlimitmsg;
7558 uschar *dsnnotifyhdr;
7562 debug_printf("sending error message to: %s\n", bounce_recipient);
7564 /* Scan the addresses for all that have the same errors address, removing
7565 them from the addr_failed chain, and putting them on msgchain. */
7567 paddr = &addr_failed;
7568 for (addr = addr_failed; addr; addr = *paddr)
7569 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7570 ? addr->prop.errors_address : sender_address) == 0)
7571 { /* The same - dechain */
7572 *paddr = addr->next;
7575 pmsgchain = &(addr->next);
7578 paddr = &addr->next; /* Not the same; skip */
7580 /* Include X-Failed-Recipients: for automatic interpretation, but do
7581 not let any one header line get too long. We do this by starting a
7582 new header every 50 recipients. Omit any addresses for which the
7583 "hide_child" flag is set. */
7585 for (addr = msgchain; addr; addr = addr->next)
7587 if (testflag(addr, af_hide_child)) continue;
7595 ? "X-Failed-Recipients: "
7597 testflag(addr, af_pfr) && addr->parent
7598 ? string_printing(addr->parent->address)
7599 : string_printing(addr->address));
7601 if (rcount > 0) fprintf(fp, "\n");
7603 /* Output the standard headers */
7605 if (errors_reply_to)
7606 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7607 fprintf(fp, "Auto-Submitted: auto-replied\n");
7608 moan_write_from(fp);
7609 fprintf(fp, "To: %s\n", bounce_recipient);
7611 /* generate boundary string and output MIME-Headers */
7612 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7614 fprintf(fp, "Content-Type: multipart/report;"
7615 " report-type=delivery-status; boundary=%s\n"
7616 "MIME-Version: 1.0\n",
7619 /* Open a template file if one is provided. Log failure to open, but
7620 carry on - default texts will be used. */
7622 if (bounce_message_file)
7623 if (!(emf = Ufopen(bounce_message_file, "rb")))
7624 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7625 "message texts: %s", bounce_message_file, strerror(errno));
7627 /* Quietly copy to configured additional addresses if required. */
7629 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7630 fprintf(fp, "Bcc: %s\n", bcc);
7632 /* The texts for the message can be read from a template file; if there
7633 isn't one, or if it is too short, built-in texts are used. The first
7634 emf text is a Subject: and any other headers. */
7636 if ((emf_text = next_emf(emf, US"header")))
7637 fprintf(fp, "%s\n", emf_text);
7639 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7640 to_sender? ": returning message to sender" : "");
7642 /* output human readable part as text/plain section */
7643 fprintf(fp, "--%s\n"
7644 "Content-type: text/plain; charset=us-ascii\n\n",
7647 if ((emf_text = next_emf(emf, US"intro")))
7648 fprintf(fp, "%s", CS emf_text);
7652 /* This message has been reworded several times. It seems to be confusing to
7653 somebody, however it is worded. I have retreated to the original, simple
7655 "This message was created automatically by mail delivery software.\n");
7657 if (bounce_message_text)
7658 fprintf(fp, "%s", CS bounce_message_text);
7661 "\nA message that you sent could not be delivered to one or more of its\n"
7662 "recipients. This is a permanent error. The following address(es) failed:\n");
7665 "\nA message sent by\n\n <%s>\n\n"
7666 "could not be delivered to one or more of its recipients. The following\n"
7667 "address(es) failed:\n", sender_address);
7671 /* Process the addresses, leaving them on the msgchain if they have a
7672 file name for a return message. (There has already been a check in
7673 post_process_one() for the existence of data in the message file.) A TRUE
7674 return from print_address_information() means that the address is not
7678 for (addr = msgchain; addr; addr = *paddr)
7680 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7681 print_address_error(addr, fp, US"");
7683 /* End the final line for the address */
7687 /* Leave on msgchain if there's a return file. */
7689 if (addr->return_file >= 0)
7691 paddr = &(addr->next);
7695 /* Else save so that we can tick off the recipient when the
7700 *paddr = addr->next;
7701 addr->next = handled_addr;
7702 handled_addr = addr;
7708 /* Get the next text, whether we need it or not, so as to be
7709 positioned for the one after. */
7711 emf_text = next_emf(emf, US"generated text");
7713 /* If there were any file messages passed by the local transports,
7714 include them in the message. Then put the address on the handled chain.
7715 In the case of a batch of addresses that were all sent to the same
7716 transport, the return_file field in all of them will contain the same
7717 fd, and the return_filename field in the *last* one will be set (to the
7718 name of the file). */
7722 address_item *nextaddr;
7725 fprintf(fp, "%s", CS emf_text);
7728 "The following text was generated during the delivery "
7729 "attempt%s:\n", (filecount > 1)? "s" : "");
7731 for (addr = msgchain; addr; addr = nextaddr)
7734 address_item *topaddr = addr;
7736 /* List all the addresses that relate to this file */
7739 while(addr) /* Insurance */
7741 print_address_information(addr, fp, US"------ ", US"\n ",
7743 if (addr->return_filename) break;
7748 /* Now copy the file */
7750 if (!(fm = Ufopen(addr->return_filename, "rb")))
7751 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7755 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7758 Uunlink(addr->return_filename);
7760 /* Can now add to handled chain, first fishing off the next
7761 address on the msgchain. */
7763 nextaddr = addr->next;
7764 addr->next = handled_addr;
7765 handled_addr = topaddr;
7770 /* output machine readable part */
7772 if (message_smtputf8)
7773 fprintf(fp, "--%s\n"
7774 "Content-type: message/global-delivery-status\n\n"
7775 "Reporting-MTA: dns; %s\n",
7776 bound, smtp_active_hostname);
7779 fprintf(fp, "--%s\n"
7780 "Content-type: message/delivery-status\n\n"
7781 "Reporting-MTA: dns; %s\n",
7782 bound, smtp_active_hostname);
7786 /* must be decoded from xtext: see RFC 3461:6.3a */
7788 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7789 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7791 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7795 for (addr = handled_addr; addr; addr = addr->next)
7799 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7801 if ((hu = addr->host_used) && hu->name)
7803 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7804 #ifdef EXPERIMENTAL_DSN_INFO
7809 uschar * p = hu->port == 25
7810 ? US"" : string_sprintf(":%d", hu->port);
7811 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7813 if ((s = addr->smtp_greeting) && *s)
7814 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7815 if ((s = addr->helo_response) && *s)
7816 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7817 if ((s = addr->message) && *s)
7818 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7821 print_dsn_diagnostic_code(addr, fp);
7826 /* Now copy the message, trying to give an intelligible comment if
7827 it is too long for it all to be copied. The limit isn't strictly
7828 applied because of the buffering. There is, however, an option
7829 to suppress copying altogether. */
7831 emf_text = next_emf(emf, US"copy");
7834 we ignore the intro text from template and add
7835 the text for bounce_return_size_limit at the end.
7837 bounce_return_message is ignored
7838 in case RET= is defined we honor these values
7839 otherwise bounce_return_body is honored.
7841 bounce_return_size_limit is always honored.
7844 fprintf(fp, "--%s\n", bound);
7846 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7847 dsnnotifyhdr = NULL;
7848 topt = topt_add_return_path;
7850 /* RET=HDRS? top priority */
7851 if (dsn_ret == dsn_ret_hdrs)
7852 topt |= topt_no_body;
7855 struct stat statbuf;
7857 /* no full body return at all? */
7858 if (!bounce_return_body)
7860 topt |= topt_no_body;
7861 /* add header if we overrule RET=FULL */
7862 if (dsn_ret == dsn_ret_full)
7863 dsnnotifyhdr = dsnlimitmsg;
7865 /* line length limited... return headers only if oversize */
7866 /* size limited ... return headers only if limit reached */
7867 else if ( max_received_linelength > bounce_return_linesize_limit
7868 || ( bounce_return_size_limit > 0
7869 && fstat(deliver_datafile, &statbuf) == 0
7870 && statbuf.st_size > max
7873 topt |= topt_no_body;
7874 dsnnotifyhdr = dsnlimitmsg;
7879 if (message_smtputf8)
7880 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7881 : "Content-type: message/global\n\n",
7885 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7886 : "Content-type: message/rfc822\n\n",
7890 transport_filter_argv = NULL; /* Just in case */
7891 return_path = sender_address; /* In case not previously set */
7892 { /* Dummy transport for headers add */
7893 transport_ctx tctx = {{0}};
7894 transport_instance tb = {0};
7896 tctx.u.fd = fileno(fp);
7898 tctx.options = topt;
7899 tb.add_headers = dsnnotifyhdr;
7901 /*XXX no checking for failure! buggy! */
7902 transport_write_message(&tctx, 0);
7906 /* we never add the final text. close the file */
7910 fprintf(fp, "\n--%s--\n", bound);
7912 /* Close the file, which should send an EOF to the child process
7913 that is receiving the message. Wait for it to finish. */
7916 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7918 /* In the test harness, let the child do it's thing first. */
7920 if (f.running_in_test_harness) millisleep(500);
7922 /* If the process failed, there was some disaster in setting up the
7923 error message. Unless the message is very old, ensure that addr_defer
7924 is non-null, which will have the effect of leaving the message on the
7925 spool. The failed addresses will get tried again next time. However, we
7926 don't really want this to happen too often, so freeze the message unless
7927 there are some genuine deferred addresses to try. To do this we have
7928 to call spool_write_header() here, because with no genuine deferred
7929 addresses the normal code below doesn't get run. */
7934 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7936 addr_defer = (address_item *)(+1);
7937 f.deliver_freeze = TRUE;
7938 deliver_frozen_at = time(NULL);
7939 /* Panic-dies on error */
7940 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7943 deliver_msglog("Process failed (%d) when writing error message "
7944 "to %s%s", rc, bounce_recipient, s);
7945 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7946 "to %s%s", rc, bounce_recipient, s);
7949 /* The message succeeded. Ensure that the recipients that failed are
7950 now marked finished with on the spool and their parents updated. */
7954 for (addr = handled_addr; addr; addr = addr->next)
7956 address_done(addr, logtod);
7957 child_done(addr, logtod);
7959 /* Panic-dies on error */
7960 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7966 f.disable_logging = FALSE; /* In case left set */
7968 /* Come here from the mua_wrapper case if routing goes wrong */
7972 /* If there are now no deferred addresses, we are done. Preserve the
7973 message log if so configured, and we are using them. Otherwise, sling it.
7974 Then delete the message itself. */
7982 fname = spool_fname(US"msglog", message_subdir, id, US"");
7983 if (preserve_message_logs)
7986 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7988 if ((rc = Urename(fname, moname)) < 0)
7990 (void)directory_make(spool_directory,
7991 spool_sname(US"msglog.OLD", US""),
7992 MSGLOG_DIRECTORY_MODE, TRUE);
7993 rc = Urename(fname, moname);
7996 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7997 "msglog.OLD directory", fname);
8000 if (Uunlink(fname) < 0)
8001 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8002 fname, strerror(errno));
8005 /* Remove the two message files. */
8007 fname = spool_fname(US"input", message_subdir, id, US"-D");
8008 if (Uunlink(fname) < 0)
8009 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8010 fname, strerror(errno));
8011 fname = spool_fname(US"input", message_subdir, id, US"-H");
8012 if (Uunlink(fname) < 0)
8013 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8014 fname, strerror(errno));
8016 /* Log the end of this message, with queue time if requested. */
8018 if (LOGGING(queue_time_overall))
8019 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8021 log_write(0, LOG_MAIN, "Completed");
8023 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8024 f.deliver_freeze = FALSE;
8026 #ifndef DISABLE_EVENT
8027 (void) event_raise(event_action, US"msg:complete", NULL);
8031 /* If there are deferred addresses, we are keeping this message because it is
8032 not yet completed. Lose any temporary files that were catching output from
8033 pipes for any of the deferred addresses, handle one-time aliases, and see if
8034 the message has been on the queue for so long that it is time to send a warning
8035 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8036 have the same domain, we can set deliver_domain for the expansion of
8037 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8038 the parent's domain.
8040 If all the deferred addresses have an error number that indicates "retry time
8041 not reached", skip sending the warning message, because it won't contain the
8042 reason for the delay. It will get sent at the next real delivery attempt.
8043 Exception: for retries caused by a remote peer we use the error message
8044 store in the retry DB as the reason.
8045 However, if at least one address has tried, we'd better include all of them in
8048 If we can't make a process to send the message, don't worry.
8050 For mailing list expansions we want to send the warning message to the
8051 mailing list manager. We can't do a perfect job here, as some addresses may
8052 have different errors addresses, but if we take the errors address from
8053 each deferred address it will probably be right in most cases.
8055 If addr_defer == +1, it means there was a problem sending an error message
8056 for failed addresses, and there were no "real" deferred addresses. The value
8057 was set just to keep the message on the spool, so there is nothing to do here.
8060 else if (addr_defer != (address_item *)(+1))
8062 uschar *recipients = US"";
8063 BOOL want_warning_msg = FALSE;
8065 deliver_domain = testflag(addr_defer, af_pfr)
8066 ? addr_defer->parent->domain : addr_defer->domain;
8068 for (address_item * addr = addr_defer; addr; addr = addr->next)
8070 address_item *otaddr;
8072 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8076 const uschar *d = testflag(addr, af_pfr)
8077 ? addr->parent->domain : addr->domain;
8079 /* The domain may be unset for an address that has never been routed
8080 because the system filter froze the message. */
8082 if (!d || Ustrcmp(d, deliver_domain) != 0)
8083 deliver_domain = NULL;
8086 if (addr->return_filename) Uunlink(addr->return_filename);
8088 /* Handle the case of one-time aliases. If any address in the ancestry
8089 of this one is flagged, ensure it is in the recipients list, suitably
8090 flagged, and that its parent is marked delivered. */
8092 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8093 if (otaddr->onetime_parent) break;
8098 int t = recipients_count;
8100 for (i = 0; i < recipients_count; i++)
8102 uschar *r = recipients_list[i].address;
8103 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8104 if (Ustrcmp(otaddr->address, r) == 0) break;
8107 /* Didn't find the address already in the list, and did find the
8108 ultimate parent's address in the list, and they really are different
8109 (i.e. not from an identity-redirect). After adding the recipient,
8110 update the errors address in the recipients list. */
8112 if ( i >= recipients_count && t < recipients_count
8113 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8115 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8116 otaddr->address, otaddr->parent->address);
8117 receive_add_recipient(otaddr->address, t);
8118 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8119 tree_add_nonrecipient(otaddr->parent->address);
8120 update_spool = TRUE;
8124 /* Except for error messages, ensure that either the errors address for
8125 this deferred address or, if there is none, the sender address, is on the
8126 list of recipients for a warning message. */
8128 if (sender_address[0])
8130 uschar * s = addr->prop.errors_address;
8131 if (!s) s = sender_address;
8132 if (Ustrstr(recipients, s) == NULL)
8133 recipients = string_sprintf("%s%s%s", recipients,
8134 recipients[0] ? "," : "", s);
8138 /* Send a warning message if the conditions are right. If the condition check
8139 fails because of a lookup defer, there is nothing we can do. The warning
8140 is not sent. Another attempt will be made at the next delivery attempt (if
8143 if ( !f.queue_2stage
8145 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8146 || addr_defer->dsn_flags & rf_notify_delay
8148 && delay_warning[1] > 0
8149 && sender_address[0] != 0
8150 && ( !delay_warning_condition
8151 || expand_check_condition(delay_warning_condition,
8152 US"delay_warning", US"option")
8158 int queue_time = time(NULL) - received_time.tv_sec;
8160 /* When running in the test harness, there's an option that allows us to
8161 fudge this time so as to get repeatability of the tests. Take the first
8162 time off the list. In queue runs, the list pointer gets updated in the
8165 if (f.running_in_test_harness && fudged_queue_times[0] != 0)
8167 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8170 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8171 fudged_queue_times);
8176 /* See how many warnings we should have sent by now */
8178 for (count = 0; count < delay_warning[1]; count++)
8179 if (queue_time < delay_warning[count+2]) break;
8181 show_time = delay_warning[count+1];
8183 if (count >= delay_warning[1])
8186 int last_gap = show_time;
8187 if (count > 1) last_gap -= delay_warning[count];
8188 extra = (queue_time - delay_warning[count+1])/last_gap;
8189 show_time += last_gap * extra;
8195 debug_printf("time on queue = %s id %s addr %s\n", readconf_printtime(queue_time), message_id, addr_defer->address);
8196 debug_printf("warning counts: required %d done %d\n", count,
8200 /* We have computed the number of warnings there should have been by now.
8201 If there haven't been enough, send one, and up the count to what it should
8204 if (warning_count < count)
8208 pid_t pid = child_open_exim(&fd);
8214 FILE *f = fdopen(fd, "wb");
8216 transport_ctx tctx = {{0}};
8218 if (warn_message_file)
8219 if (!(wmf = Ufopen(warn_message_file, "rb")))
8220 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8221 "message texts: %s", warn_message_file, strerror(errno));
8223 warnmsg_recipients = recipients;
8224 warnmsg_delay = queue_time < 120*60
8225 ? string_sprintf("%d minutes", show_time/60)
8226 : string_sprintf("%d hours", show_time/3600);
8228 if (errors_reply_to)
8229 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8230 fprintf(f, "Auto-Submitted: auto-replied\n");
8232 fprintf(f, "To: %s\n", recipients);
8234 /* generated boundary string and output MIME-Headers */
8235 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8237 fprintf(f, "Content-Type: multipart/report;"
8238 " report-type=delivery-status; boundary=%s\n"
8239 "MIME-Version: 1.0\n",
8242 if ((wmf_text = next_emf(wmf, US"header")))
8243 fprintf(f, "%s\n", wmf_text);
8245 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8246 message_id, warnmsg_delay);
8248 /* output human readable part as text/plain section */
8250 "Content-type: text/plain; charset=us-ascii\n\n",
8253 if ((wmf_text = next_emf(wmf, US"intro")))
8254 fprintf(f, "%s", CS wmf_text);
8258 "This message was created automatically by mail delivery software.\n");
8260 if (Ustrcmp(recipients, sender_address) == 0)
8262 "A message that you sent has not yet been delivered to one or more of its\n"
8263 "recipients after more than ");
8267 "A message sent by\n\n <%s>\n\n"
8268 "has not yet been delivered to one or more of its recipients after more than \n",
8271 fprintf(f, "%s on the queue on %s.\n\n"
8272 "The message identifier is: %s\n",
8273 warnmsg_delay, primary_hostname, message_id);
8275 for (h = header_list; h; h = h->next)
8276 if (strncmpic(h->text, US"Subject:", 8) == 0)
8277 fprintf(f, "The subject of the message is: %s", h->text + 9);
8278 else if (strncmpic(h->text, US"Date:", 5) == 0)
8279 fprintf(f, "The date of the message is: %s", h->text + 6);
8282 fprintf(f, "The address%s to which the message has not yet been "
8284 !addr_defer->next ? "" : "es",
8285 !addr_defer->next ? "is": "are");
8288 /* List the addresses, with error information if allowed */
8291 for (address_item * addr = addr_defer; addr; addr = addr->next)
8293 if (print_address_information(addr, f, US" ", US"\n ", US""))
8294 print_address_error(addr, f, US"Delay reason: ");
8303 if ((wmf_text = next_emf(wmf, US"final")))
8304 fprintf(f, "%s", CS wmf_text);
8310 "No action is required on your part. Delivery attempts will continue for\n"
8311 "some time, and this warning may be repeated at intervals if the message\n"
8312 "remains undelivered. Eventually the mail delivery software will give up,\n"
8313 "and when that happens, the message will be returned to you.\n");
8316 /* output machine readable part */
8317 fprintf(f, "\n--%s\n"
8318 "Content-type: message/delivery-status\n\n"
8319 "Reporting-MTA: dns; %s\n",
8321 smtp_active_hostname);
8326 /* must be decoded from xtext: see RFC 3461:6.3a */
8328 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8329 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8331 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8335 for (address_item * addr = addr_defer; addr; addr = addr->next)
8339 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8341 if ((hu = addr->host_used) && hu->name)
8343 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8344 print_dsn_diagnostic_code(addr, f);
8350 "Content-type: text/rfc822-headers\n\n",
8354 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8355 tctx.u.fd = fileno(f);
8356 tctx.options = topt_add_return_path | topt_no_body;
8357 transport_filter_argv = NULL; /* Just in case */
8358 return_path = sender_address; /* In case not previously set */
8360 /* Write the original email out */
8361 /*XXX no checking for failure! buggy! */
8362 transport_write_message(&tctx, 0);
8365 fprintf(f,"\n--%s--\n", bound);
8369 /* Close and wait for child process to complete, without a timeout.
8370 If there's an error, don't update the count. */
8373 if (child_close(pid, 0) == 0)
8375 warning_count = count;
8376 update_spool = TRUE; /* Ensure spool rewritten */
8382 /* Clear deliver_domain */
8384 deliver_domain = NULL;
8386 /* If this was a first delivery attempt, unset the first time flag, and
8387 ensure that the spool gets updated. */
8389 if (f.deliver_firsttime)
8391 f.deliver_firsttime = FALSE;
8392 update_spool = TRUE;
8395 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8396 message, unless the message is a local error message (to avoid loops). Then
8397 log the freezing. If the text in "frozen_info" came from a system filter,
8398 it has been escaped into printing characters so as not to mess up log lines.
8399 For the "tell" message, we turn \n back into newline. Also, insert a newline
8400 near the start instead of the ": " string. */
8402 if (f.deliver_freeze)
8404 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8406 uschar *s = string_copy(frozen_info);
8407 uschar *ss = Ustrstr(s, " by the system filter: ");
8418 if (*ss == '\\' && ss[1] == 'n')
8425 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8426 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8430 /* Log freezing just before we update the -H file, to minimize the chance
8431 of a race problem. */
8433 deliver_msglog("*** Frozen%s\n", frozen_info);
8434 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8437 /* If there have been any updates to the non-recipients list, or other things
8438 that get written to the spool, we must now update the spool header file so
8439 that it has the right information for the next delivery attempt. If there
8440 was more than one address being delivered, the header_change update is done
8441 earlier, in case one succeeds and then something crashes. */
8444 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8445 update_spool, f.header_rewritten);
8447 if (update_spool || f.header_rewritten)
8448 /* Panic-dies on error */
8449 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8452 /* Finished with the message log. If the message is complete, it will have
8453 been unlinked or renamed above. */
8455 if (message_logs) (void)fclose(message_log);
8457 /* Now we can close and remove the journal file. Its only purpose is to record
8458 successfully completed deliveries asap so that this information doesn't get
8459 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8460 not serious, as trying it again is not harmful. The journal might not be open
8461 if all addresses were deferred at routing or directing. Nevertheless, we must
8462 remove it if it exists (may have been lying around from a crash during the
8463 previous delivery attempt). We don't remove the journal if a delivery
8464 subprocess failed to pass back delivery information; this is controlled by
8465 the remove_journal flag. When the journal is left, we also don't move the
8466 message off the main spool if frozen and the option is set. It should get moved
8467 at the next attempt, after the journal has been inspected. */
8469 if (journal_fd >= 0) (void)close(journal_fd);
8473 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8475 if (Uunlink(fname) < 0 && errno != ENOENT)
8476 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8479 /* Move the message off the spool if requested */
8481 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8482 if (f.deliver_freeze && move_frozen_messages)
8483 (void)spool_move_message(id, message_subdir, US"", US"F");
8487 /* Closing the data file frees the lock; if the file has been unlinked it
8488 will go away. Otherwise the message becomes available for another process
8491 (void)close(deliver_datafile);
8492 deliver_datafile = -1;
8493 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8495 /* It is unlikely that there will be any cached resources, since they are
8496 released after routing, and in the delivery subprocesses. However, it's
8497 possible for an expansion for something afterwards (for example,
8498 expand_check_condition) to do a lookup. We must therefore be sure everything is
8502 acl_where = ACL_WHERE_UNKNOWN;
8511 #ifdef EXIM_TFO_PROBE
8514 f.tcp_fastopen_ok = TRUE;
8518 if (!regex_PIPELINING) regex_PIPELINING =
8519 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8521 if (!regex_SIZE) regex_SIZE =
8522 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8524 if (!regex_AUTH) regex_AUTH =
8525 regex_must_compile(AUTHS_REGEX, FALSE, TRUE);
8528 if (!regex_STARTTLS) regex_STARTTLS =
8529 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8532 if (!regex_CHUNKING) regex_CHUNKING =
8533 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8535 #ifndef DISABLE_PRDR
8536 if (!regex_PRDR) regex_PRDR =
8537 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8541 if (!regex_UTF8) regex_UTF8 =
8542 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8545 if (!regex_DSN) regex_DSN =
8546 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8548 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8549 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8551 #ifdef SUPPORT_PIPE_CONNECT
8552 if (!regex_EARLY_PIPE) regex_EARLY_PIPE =
8553 regex_must_compile(US"\\n250[\\s\\-]" EARLY_PIPE_FEATURE_NAME "(\\s|\\n|$)", FALSE, TRUE);
8559 deliver_get_sender_address (uschar * id)
8562 uschar * new_sender_address,
8563 * save_sender_address;
8564 BOOL save_qr = f.queue_running;
8567 /* make spool_open_datafile non-noisy on fail */
8569 f.queue_running = TRUE;
8571 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8573 deliver_datafile = spool_open_datafile(id);
8574 f.queue_running = save_qr;
8575 if (deliver_datafile < 0)
8578 /* Save and restore the global sender_address. I'm not sure if we should
8579 not save/restore all the other global variables too, because
8580 spool_read_header() may change all of them. But OTOH, when this
8581 deliver_get_sender_address() gets called, the current message is done
8582 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8584 spoolname = string_sprintf("%s-H", id);
8585 save_sender_address = sender_address;
8587 rc = spool_read_header(spoolname, TRUE, TRUE);
8589 new_sender_address = sender_address;
8590 sender_address = save_sender_address;
8592 if (rc != spool_read_OK)
8595 assert(new_sender_address);
8597 (void)close(deliver_datafile);
8598 deliver_datafile = -1;
8600 return new_sender_address;
8606 delivery_re_exec(int exec_type)
8610 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8612 int channel_fd = cutthrough.cctx.sock;
8614 smtp_peer_options = cutthrough.peer_options;
8615 continue_sequence = 0;
8618 if (cutthrough.is_tls)
8622 smtp_peer_options |= OPTION_TLS;
8623 sending_ip_address = cutthrough.snd_ip;
8624 sending_port = cutthrough.snd_port;
8626 where = US"socketpair";
8627 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8631 if ((pid = fork()) < 0)
8634 else if (pid == 0) /* child: fork again to totally disconnect */
8636 if (f.running_in_test_harness) millisleep(100); /* let parent debug out */
8637 /* does not return */
8638 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8642 DEBUG(D_transport) debug_printf("proxy-proc inter-pid %d\n", pid);
8644 waitpid(pid, NULL, 0);
8645 (void) close(channel_fd); /* release the client socket */
8646 channel_fd = pfd[1];
8650 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8651 cutthrough.host.address, message_id, channel_fd);
8655 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8656 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8658 return; /* compiler quietening; control does not reach here. */
8663 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8664 "delivery re-exec %s failed: %s", where, strerror(errno));
8666 /* Get here if exec_type == CEE_EXEC_EXIT.
8667 Note: this must be _exit(), not exit(). */
8669 _exit(EX_EXECFAILED);
8675 /* End of deliver.c */