1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* The main code for delivering a message. */
13 #include "transports/smtp.h"
18 /* Data block for keeping track of subprocesses for parallel remote
21 typedef struct pardata {
22 address_item *addrlist; /* chain of addresses */
23 address_item *addr; /* next address data expected for */
24 pid_t pid; /* subprocess pid */
25 int fd; /* pipe fd for getting result from subprocess */
26 int transport_count; /* returned transport count value */
27 BOOL done; /* no more data needed */
28 uschar *msg; /* error message */
29 uschar *return_path; /* return_path for these addresses */
32 /* Values for the process_recipients variable */
34 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
35 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
38 /* Mutually recursive functions for marking addresses done. */
40 static void child_done(address_item *, uschar *);
41 static void address_done(address_item *, uschar *);
43 /* Table for turning base-62 numbers into binary */
45 static uschar tab62[] =
46 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
47 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
48 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
49 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
50 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
51 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
55 /*************************************************
56 * Local static variables *
57 *************************************************/
59 /* addr_duplicate is global because it needs to be seen from the Envelope-To
62 static address_item *addr_defer = NULL;
63 static address_item *addr_failed = NULL;
64 static address_item *addr_fallback = NULL;
65 static address_item *addr_local = NULL;
66 static address_item *addr_new = NULL;
67 static address_item *addr_remote = NULL;
68 static address_item *addr_route = NULL;
69 static address_item *addr_succeed = NULL;
70 static address_item *addr_senddsn = NULL;
72 static FILE *message_log = NULL;
73 static BOOL update_spool;
74 static BOOL remove_journal;
75 static int parcount = 0;
76 static pardata *parlist = NULL;
77 static int return_count;
78 static uschar *frozen_info = US"";
79 static uschar *used_return_path = NULL;
83 /*************************************************
84 * read as much as requested *
85 *************************************************/
87 /* The syscall read(2) doesn't always returns as much as we want. For
88 several reasons it might get less. (Not talking about signals, as syscalls
89 are restartable). When reading from a network or pipe connection the sender
90 might send in smaller chunks, with delays between these chunks. The read(2)
91 may return such a chunk.
93 The more the writer writes and the smaller the pipe between write and read is,
94 the more we get the chance of reading leass than requested. (See bug 2130)
96 This function read(2)s until we got all the data we *requested*.
98 Note: This function may block. Use it only if you're sure about the
99 amount of data you will get.
102 fd the file descriptor to read from
103 buffer pointer to a buffer of size len
104 len the requested(!) amount of bytes
106 Returns: the amount of bytes read
109 readn(int fd, void * buffer, size_t len)
111 uschar * next = buffer;
112 uschar * end = next + len;
116 ssize_t got = read(fd, next, end - next);
118 /* I'm not sure if there are signals that can interrupt us,
119 for now I assume the worst */
120 if (got == -1 && errno == EINTR) continue;
121 if (got <= 0) return next - US buffer;
129 /*************************************************
130 * Make a new address item *
131 *************************************************/
133 /* This function gets the store and initializes with default values. The
134 transport_return value defaults to DEFER, so that any unexpected failure to
135 deliver does not wipe out the message. The default unique string is set to a
136 copy of the address, so that its domain can be lowercased.
139 address the RFC822 address string
140 copy force a copy of the address
142 Returns: a pointer to an initialized address_item
146 deliver_make_addr(uschar *address, BOOL copy)
148 address_item *addr = store_get(sizeof(address_item), FALSE);
149 *addr = address_defaults;
150 if (copy) address = string_copy(address);
151 addr->address = address;
152 addr->unique = string_copy(address);
159 /*************************************************
160 * Set expansion values for an address *
161 *************************************************/
163 /* Certain expansion variables are valid only when handling an address or
164 address list. This function sets them up or clears the values, according to its
168 addr the address in question, or NULL to clear values
173 deliver_set_expansions(address_item *addr)
177 const uschar ***p = address_expansions;
178 while (*p) **p++ = NULL;
182 /* Exactly what gets set depends on whether there is one or more addresses, and
183 what they contain. These first ones are always set, taking their values from
184 the first address. */
186 if (!addr->host_list)
188 deliver_host = deliver_host_address = US"";
189 deliver_host_port = 0;
193 deliver_host = addr->host_list->name;
194 deliver_host_address = addr->host_list->address;
195 deliver_host_port = addr->host_list->port;
198 deliver_recipients = addr;
199 deliver_address_data = addr->prop.address_data;
200 deliver_domain_data = addr->prop.domain_data;
201 deliver_localpart_data = addr->prop.localpart_data;
202 router_var = addr->prop.variables;
204 /* These may be unset for multiple addresses */
206 deliver_domain = addr->domain;
207 self_hostname = addr->self_hostname;
209 #ifdef EXPERIMENTAL_BRIGHTMAIL
210 bmi_deliver = 1; /* deliver by default */
211 bmi_alt_location = NULL;
212 bmi_base64_verdict = NULL;
213 bmi_base64_tracker_verdict = NULL;
216 /* If there's only one address we can set everything. */
220 address_item *addr_orig;
222 deliver_localpart = addr->local_part;
223 deliver_localpart_prefix = addr->prefix;
224 deliver_localpart_prefix_v = addr->prefix_v;
225 deliver_localpart_suffix = addr->suffix;
226 deliver_localpart_suffix_v = addr->suffix_v;
228 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
229 deliver_domain_orig = addr_orig->domain;
231 /* Re-instate any prefix and suffix in the original local part. In all
232 normal cases, the address will have a router associated with it, and we can
233 choose the caseful or caseless version accordingly. However, when a system
234 filter sets up a pipe, file, or autoreply delivery, no router is involved.
235 In this case, though, there won't be any prefix or suffix to worry about. */
237 deliver_localpart_orig = !addr_orig->router
238 ? addr_orig->local_part
239 : addr_orig->router->caseful_local_part
240 ? addr_orig->cc_local_part
241 : addr_orig->lc_local_part;
243 /* If there's a parent, make its domain and local part available, and if
244 delivering to a pipe or file, or sending an autoreply, get the local
245 part from the parent. For pipes and files, put the pipe or file string
246 into address_pipe and address_file. */
250 deliver_domain_parent = addr->parent->domain;
251 deliver_localpart_parent = !addr->parent->router
252 ? addr->parent->local_part
253 : addr->parent->router->caseful_local_part
254 ? addr->parent->cc_local_part
255 : addr->parent->lc_local_part;
257 /* File deliveries have their own flag because they need to be picked out
258 as special more often. */
260 if (testflag(addr, af_pfr))
262 if (testflag(addr, af_file)) address_file = addr->local_part;
263 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
264 deliver_localpart = addr->parent->local_part;
265 deliver_localpart_prefix = addr->parent->prefix;
266 deliver_localpart_prefix_v = addr->parent->prefix_v;
267 deliver_localpart_suffix = addr->parent->suffix;
268 deliver_localpart_suffix_v = addr->parent->suffix_v;
272 #ifdef EXPERIMENTAL_BRIGHTMAIL
273 /* Set expansion variables related to Brightmail AntiSpam */
274 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
275 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
276 /* get message delivery status (0 - don't deliver | 1 - deliver) */
277 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
278 /* if message is to be delivered, get eventual alternate location */
279 if (bmi_deliver == 1)
280 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
285 /* For multiple addresses, don't set local part, and leave the domain and
286 self_hostname set only if it is the same for all of them. It is possible to
287 have multiple pipe and file addresses, but only when all addresses have routed
288 to the same pipe or file. */
292 if (testflag(addr, af_pfr))
294 if (testflag(addr, af_file)) address_file = addr->local_part;
295 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
297 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
299 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
300 deliver_domain = NULL;
302 && ( !addr2->self_hostname
303 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
305 self_hostname = NULL;
306 if (!deliver_domain && !self_hostname) break;
314 /*************************************************
315 * Open a msglog file *
316 *************************************************/
318 /* This function is used both for normal message logs, and for files in the
319 msglog directory that are used to catch output from pipes. Try to create the
320 directory if it does not exist. From release 4.21, normal message logs should
321 be created when the message is received.
323 Called from deliver_message(), can be operating as root.
326 filename the file name
327 mode the mode required
328 error used for saying what failed
330 Returns: a file descriptor, or -1 (with errno set)
334 open_msglog_file(uschar *filename, int mode, uschar **error)
336 if (Ustrstr(filename, US"/../"))
337 log_write(0, LOG_MAIN|LOG_PANIC,
338 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
340 for (int i = 2; i > 0; i--)
342 int fd = Uopen(filename,
349 O_WRONLY|O_APPEND|O_CREAT, mode);
352 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
353 function is called as root). Double check the mode, because the group setting
354 doesn't always get set automatically. */
357 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
359 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
364 if (fchmod(fd, mode) < 0)
374 (void)directory_make(spool_directory,
375 spool_sname(US"msglog", message_subdir),
376 MSGLOG_DIRECTORY_MODE, TRUE);
379 *error = US"create or open";
386 /*************************************************
387 * Write to msglog if required *
388 *************************************************/
390 /* Write to the message log, if configured. This function may also be called
394 format a string format
400 deliver_msglog(const char *format, ...)
403 if (!message_logs) return;
404 va_start(ap, format);
405 vfprintf(message_log, format, ap);
413 /*************************************************
414 * Replicate status for batch *
415 *************************************************/
417 /* When a transport handles a batch of addresses, it may treat them
418 individually, or it may just put the status in the first one, and return FALSE,
419 requesting that the status be copied to all the others externally. This is the
420 replication function. As well as the status, it copies the transport pointer,
421 which may have changed if appendfile passed the addresses on to a different
424 Argument: pointer to the first address in a chain
429 replicate_status(address_item *addr)
431 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
433 addr2->transport = addr->transport;
434 addr2->transport_return = addr->transport_return;
435 addr2->basic_errno = addr->basic_errno;
436 addr2->more_errno = addr->more_errno;
437 addr2->delivery_time = addr->delivery_time;
438 addr2->special_action = addr->special_action;
439 addr2->message = addr->message;
440 addr2->user_message = addr->user_message;
446 /*************************************************
447 * Compare lists of hosts *
448 *************************************************/
450 /* This function is given two pointers to chains of host items, and it yields
451 TRUE if the lists refer to the same hosts in the same order, except that
453 (1) Multiple hosts with the same non-negative MX values are permitted to appear
454 in different orders. Round-robinning nameservers can cause this to happen.
456 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
457 permitted to appear in different orders. This is caused by randomizing
460 This enables Exim to use a single SMTP transaction for sending to two entirely
461 different domains that happen to end up pointing at the same hosts.
463 We do not try to batch up different A-record host names that refer to the
467 one points to the first host list
468 two points to the second host list
470 Returns: TRUE if the lists refer to the same host set
474 same_hosts(host_item *one, host_item *two)
478 if (Ustrcmp(one->name, two->name) != 0)
481 host_item *end_one = one;
482 host_item *end_two = two;
484 /* Batch up only if there was no MX and the list was not randomized */
486 if (mx == MX_NONE) return FALSE;
488 /* Find the ends of the shortest sequence of identical MX values */
490 while ( end_one->next && end_one->next->mx == mx
491 && end_two->next && end_two->next->mx == mx)
493 end_one = end_one->next;
494 end_two = end_two->next;
497 /* If there aren't any duplicates, there's no match. */
499 if (end_one == one) return FALSE;
501 /* For each host in the 'one' sequence, check that it appears in the 'two'
502 sequence, returning FALSE if not. */
507 for (hi = two; hi != end_two->next; hi = hi->next)
508 if (Ustrcmp(one->name, hi->name) == 0) break;
509 if (hi == end_two->next) return FALSE;
510 if (one == end_one) break;
514 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
515 Ensure both are pointing at the last host, and carry on as for equality. */
520 /* if the names matched but ports do not, mismatch */
521 else if (one->port != two->port)
530 /* True if both are NULL */
537 /*************************************************
538 * Compare header lines *
539 *************************************************/
541 /* This function is given two pointers to chains of header items, and it yields
542 TRUE if they are the same header texts in the same order.
545 one points to the first header list
546 two points to the second header list
548 Returns: TRUE if the lists refer to the same header set
552 same_headers(header_line *one, header_line *two)
554 for (;; one = one->next, two = two->next)
556 if (one == two) return TRUE; /* Includes the case where both NULL */
557 if (!one || !two) return FALSE;
558 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
564 /*************************************************
565 * Compare string settings *
566 *************************************************/
568 /* This function is given two pointers to strings, and it returns
569 TRUE if they are the same pointer, or if the two strings are the same.
572 one points to the first string
573 two points to the second string
575 Returns: TRUE or FALSE
579 same_strings(uschar *one, uschar *two)
581 if (one == two) return TRUE; /* Includes the case where both NULL */
582 if (!one || !two) return FALSE;
583 return (Ustrcmp(one, two) == 0);
588 /*************************************************
589 * Compare uid/gid for addresses *
590 *************************************************/
592 /* This function is given a transport and two addresses. It yields TRUE if the
593 uid/gid/initgroups settings for the two addresses are going to be the same when
598 addr1 the first address
599 addr2 the second address
601 Returns: TRUE or FALSE
605 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
607 if ( !tp->uid_set && !tp->expand_uid
608 && !tp->deliver_as_creator
609 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
610 || ( testflag(addr1, af_uid_set)
611 && ( addr1->uid != addr2->uid
612 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
616 if ( !tp->gid_set && !tp->expand_gid
617 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
618 || ( testflag(addr1, af_gid_set)
619 && addr1->gid != addr2->gid
629 /*************************************************
630 * Record that an address is complete *
631 *************************************************/
633 /* This function records that an address is complete. This is straightforward
634 for most addresses, where the unique address is just the full address with the
635 domain lower cased. For homonyms (addresses that are the same as one of their
636 ancestors) their are complications. Their unique addresses have \x\ prepended
637 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
640 Exim used to record the unique addresses of homonyms as "complete". This,
641 however, fails when the pattern of redirection varies over time (e.g. if taking
642 unseen copies at only some times of day) because the prepended numbers may vary
643 from one delivery run to the next. This problem is solved by never recording
644 prepended unique addresses as complete. Instead, when a homonymic address has
645 actually been delivered via a transport, we record its basic unique address
646 followed by the name of the transport. This is checked in subsequent delivery
647 runs whenever an address is routed to a transport.
649 If the completed address is a top-level one (has no parent, which means it
650 cannot be homonymic) we also add the original address to the non-recipients
651 tree, so that it gets recorded in the spool file and therefore appears as
652 "done" in any spool listings. The original address may differ from the unique
653 address in the case of the domain.
655 Finally, this function scans the list of duplicates, marks as done any that
656 match this address, and calls child_done() for their ancestors.
659 addr address item that has been completed
660 now current time as a string
666 address_done(address_item *addr, uschar *now)
668 update_spool = TRUE; /* Ensure spool gets updated */
670 /* Top-level address */
674 tree_add_nonrecipient(addr->unique);
675 tree_add_nonrecipient(addr->address);
678 /* Homonymous child address */
680 else if (testflag(addr, af_homonym))
683 tree_add_nonrecipient(
684 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
687 /* Non-homonymous child address */
689 else tree_add_nonrecipient(addr->unique);
691 /* Check the list of duplicate addresses and ensure they are now marked
694 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
695 if (Ustrcmp(addr->unique, dup->unique) == 0)
697 tree_add_nonrecipient(dup->unique);
698 child_done(dup, now);
705 /*************************************************
706 * Decrease counts in parents and mark done *
707 *************************************************/
709 /* This function is called when an address is complete. If there is a parent
710 address, its count of children is decremented. If there are still other
711 children outstanding, the function exits. Otherwise, if the count has become
712 zero, address_done() is called to mark the parent and its duplicates complete.
713 Then loop for any earlier ancestors.
716 addr points to the completed address item
717 now the current time as a string, for writing to the message log
723 child_done(address_item *addr, uschar *now)
730 if (--addr->child_count > 0) return; /* Incomplete parent */
731 address_done(addr, now);
733 /* Log the completion of all descendents only when there is no ancestor with
734 the same original address. */
736 for (aa = addr->parent; aa; aa = aa->parent)
737 if (Ustrcmp(aa->address, addr->address) == 0) break;
740 deliver_msglog("%s %s: children all complete\n", now, addr->address);
741 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
747 /*************************************************
748 * Delivery logging support functions *
749 *************************************************/
751 /* The LOGGING() checks in d_log_interface() are complicated for backwards
752 compatibility. When outgoing interface logging was originally added, it was
753 conditional on just incoming_interface (which is off by default). The
754 outgoing_interface option is on by default to preserve this behaviour, but
755 you can enable incoming_interface and disable outgoing_interface to get I=
756 fields on incoming lines only.
760 addr The address to be logged
762 Returns: New value for s
766 d_log_interface(gstring * g)
768 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
769 && sending_ip_address)
771 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
772 if (LOGGING(outgoing_port))
773 g = string_fmt_append(g, ":%d", sending_port);
781 d_hostlog(gstring * g, address_item * addr)
783 host_item * h = addr->host_used;
785 g = string_append(g, 2, US" H=", h->name);
787 if (LOGGING(dnssec) && h->dnssec == DS_YES)
788 g = string_catn(g, US" DS", 3);
790 g = string_append(g, 3, US" [", h->address, US"]");
792 if (LOGGING(outgoing_port))
793 g = string_fmt_append(g, ":%d", h->port);
796 if (LOGGING(proxy) && proxy_local_address)
798 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
799 if (LOGGING(outgoing_port))
800 g = string_fmt_append(g, ":%d", proxy_local_port);
804 g = d_log_interface(g);
806 if (testflag(addr, af_tcp_fastopen))
807 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
818 d_tlslog(gstring * g, address_item * addr)
820 if (LOGGING(tls_cipher) && addr->cipher)
822 g = string_append(g, 2, US" X=", addr->cipher);
823 #ifndef DISABLE_TLS_RESUME
824 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
825 g = string_catn(g, US"*", 1);
828 if (LOGGING(tls_certificate_verified) && addr->cipher)
829 g = string_append(g, 2, US" CV=",
830 testflag(addr, af_cert_verified)
833 testflag(addr, af_dane_verified)
839 if (LOGGING(tls_peerdn) && addr->peerdn)
840 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
848 #ifndef DISABLE_EVENT
850 event_raise(uschar * action, const uschar * event, uschar * ev_data)
856 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
858 action, deliver_host_address);
861 event_data = ev_data;
863 if (!(s = expand_string(action)) && *expand_string_message)
864 log_write(0, LOG_MAIN|LOG_PANIC,
865 "failed to expand event_action %s in %s: %s\n",
866 event, transport_name ? transport_name : US"main", expand_string_message);
868 event_name = event_data = NULL;
870 /* If the expansion returns anything but an empty string, flag for
871 the caller to modify his normal processing
876 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
885 msg_event_raise(const uschar * event, const address_item * addr)
887 const uschar * save_domain = deliver_domain;
888 uschar * save_local = deliver_localpart;
889 const uschar * save_host = deliver_host;
890 const uschar * save_address = deliver_host_address;
891 const int save_port = deliver_host_port;
893 router_name = addr->router ? addr->router->name : NULL;
894 deliver_domain = addr->domain;
895 deliver_localpart = addr->local_part;
896 deliver_host = addr->host_used ? addr->host_used->name : NULL;
898 if (!addr->transport)
900 if (Ustrcmp(event, "msg:fail:delivery") == 0)
902 /* An address failed with no transport involved. This happens when
903 a filter was used which triggered a fail command (in such a case
904 a transport isn't needed). Convert it to an internal fail event. */
906 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
911 transport_name = addr->transport->name;
913 (void) event_raise(addr->transport->event_action, event,
915 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
916 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
917 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
918 ? addr->message : NULL);
921 deliver_host_port = save_port;
922 deliver_host_address = save_address;
923 deliver_host = save_host;
924 deliver_localpart = save_local;
925 deliver_domain = save_domain;
926 router_name = transport_name = NULL;
928 #endif /*DISABLE_EVENT*/
932 /******************************************************************************/
935 /*************************************************
936 * Generate local prt for logging *
937 *************************************************/
939 /* This function is a subroutine for use in string_log_address() below.
942 addr the address being logged
943 yield the current dynamic buffer pointer
945 Returns: the new value of the buffer pointer
949 string_get_localpart(address_item * addr, gstring * yield)
954 if (testflag(addr, af_include_affixes) && s)
957 if (testflag(addr, af_utf8_downcvt))
958 s = string_localpart_utf8_to_alabel(s, NULL);
960 yield = string_cat(yield, s);
963 s = addr->local_part;
965 if (testflag(addr, af_utf8_downcvt))
966 s = string_localpart_utf8_to_alabel(s, NULL);
968 yield = string_cat(yield, s);
971 if (testflag(addr, af_include_affixes) && s)
974 if (testflag(addr, af_utf8_downcvt))
975 s = string_localpart_utf8_to_alabel(s, NULL);
977 yield = string_cat(yield, s);
984 /*************************************************
985 * Generate log address list *
986 *************************************************/
988 /* This function generates a list consisting of an address and its parents, for
989 use in logging lines. For saved onetime aliased addresses, the onetime parent
990 field is used. If the address was delivered by a transport with rcpt_include_
991 affixes set, the af_include_affixes bit will be set in the address. In that
992 case, we include the affixes here too.
995 g points to growing-string struct
996 addr bottom (ultimate) address
997 all_parents if TRUE, include all parents
998 success TRUE for successful delivery
1000 Returns: a growable string in dynamic store
1004 string_log_address(gstring * g,
1005 address_item *addr, BOOL all_parents, BOOL success)
1007 BOOL add_topaddr = TRUE;
1008 address_item *topaddr;
1010 /* Find the ultimate parent */
1012 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1014 /* We start with just the local part for pipe, file, and reply deliveries, and
1015 for successful local deliveries from routers that have the log_as_local flag
1016 set. File deliveries from filters can be specified as non-absolute paths in
1017 cases where the transport is going to complete the path. If there is an error
1018 before this happens (expansion failure) the local part will not be updated, and
1019 so won't necessarily look like a path. Add extra text for this case. */
1021 if ( testflag(addr, af_pfr)
1023 && addr->router && addr->router->log_as_local
1024 && addr->transport && addr->transport->info->local
1027 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1028 g = string_catn(g, CUS"save ", 5);
1029 g = string_get_localpart(addr, g);
1032 /* Other deliveries start with the full address. It we have split it into local
1033 part and domain, use those fields. Some early failures can happen before the
1034 splitting is done; in those cases use the original field. */
1039 int off = g->ptr; /* start of the "full address" */
1041 if (addr->local_part)
1044 g = string_get_localpart(addr, g);
1045 g = string_catn(g, US"@", 1);
1048 if (testflag(addr, af_utf8_downcvt))
1049 s = string_localpart_utf8_to_alabel(s, NULL);
1051 g = string_cat(g, s);
1054 g = string_cat(g, addr->address);
1056 /* If the address we are going to print is the same as the top address,
1057 and all parents are not being included, don't add on the top address. First
1058 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1059 on the local parts. */
1061 cmp = g->s + off; /* only now, as rebuffer likely done */
1062 string_from_gstring(g); /* ensure nul-terminated */
1063 if ( strcmpic(cmp, topaddr->address) == 0
1064 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1065 && !addr->onetime_parent
1066 && (!all_parents || !addr->parent || addr->parent == topaddr)
1068 add_topaddr = FALSE;
1071 /* If all parents are requested, or this is a local pipe/file/reply, and
1072 there is at least one intermediate parent, show it in brackets, and continue
1073 with all of them if all are wanted. */
1075 if ( (all_parents || testflag(addr, af_pfr))
1077 && addr->parent != topaddr)
1080 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1082 g = string_catn(g, s, 2);
1083 g = string_cat (g, addr2->address);
1084 if (!all_parents) break;
1087 g = string_catn(g, US")", 1);
1090 /* Add the top address if it is required */
1093 g = string_append(g, 3,
1095 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1103 /******************************************************************************/
1107 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1108 this is a nonstandard call; no two-character delivery flag is written
1109 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1112 flags passed to log_write()
1115 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1117 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1120 /* Log the delivery on the main log. We use an extensible string to build up
1121 the log line, and reset the store afterwards. Remote deliveries should always
1122 have a pointer to the host item that succeeded; local deliveries can have a
1123 pointer to a single host item in their host list, for use by the transport. */
1125 #ifndef DISABLE_EVENT
1126 /* presume no successful remote delivery */
1127 lookup_dnssec_authenticated = NULL;
1130 reset_point = store_mark();
1131 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1134 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1137 g->s[0] = logchar; g->ptr = 1;
1138 g = string_catn(g, US"> ", 2);
1140 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1142 if (LOGGING(sender_on_delivery) || msg)
1143 g = string_append(g, 3, US" F=<",
1145 testflag(addr, af_utf8_downcvt)
1146 ? string_address_utf8_to_alabel(sender_address, NULL)
1153 g = string_append(g, 2, US" Q=", queue_name);
1155 #ifdef EXPERIMENTAL_SRS_ALT
1156 if(addr->prop.srs_sender)
1157 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1160 /* You might think that the return path must always be set for a successful
1161 delivery; indeed, I did for some time, until this statement crashed. The case
1162 when it is not set is for a delivery to /dev/null which is optimised by not
1163 being run at all. */
1165 if (used_return_path && LOGGING(return_path_on_delivery))
1166 g = string_append(g, 3, US" P=<", used_return_path, US">");
1169 g = string_append(g, 2, US" ", msg);
1171 /* For a delivery from a system filter, there may not be a router */
1173 g = string_append(g, 2, US" R=", addr->router->name);
1175 g = string_append(g, 2, US" T=", addr->transport->name);
1177 if (LOGGING(delivery_size))
1178 g = string_fmt_append(g, " S=%d", transport_count);
1180 /* Local delivery */
1182 if (addr->transport->info->local)
1184 if (addr->host_list)
1185 g = string_append(g, 2, US" H=", addr->host_list->name);
1186 g = d_log_interface(g);
1187 if (addr->shadow_message)
1188 g = string_cat(g, addr->shadow_message);
1191 /* Remote delivery */
1195 if (addr->host_used)
1197 g = d_hostlog(g, addr);
1198 if (continue_sequence > 1) /*XXX this is wrong for a dropped proxyconn. Would have to pass back from transport */
1199 g = string_catn(g, US"*", 1);
1201 #ifndef DISABLE_EVENT
1202 deliver_host_address = addr->host_used->address;
1203 deliver_host_port = addr->host_used->port;
1204 deliver_host = addr->host_used->name;
1206 /* DNS lookup status */
1207 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1208 : addr->host_used->dnssec==DS_NO ? US"no"
1214 g = d_tlslog(g, addr);
1217 if (addr->authenticator)
1219 g = string_append(g, 2, US" A=", addr->authenticator);
1222 g = string_append(g, 2, US":", addr->auth_id);
1223 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1224 g = string_append(g, 2, US":", addr->auth_sndr);
1228 if (LOGGING(pipelining))
1230 if (testflag(addr, af_pipelining))
1231 g = string_catn(g, US" L", 2);
1232 #ifndef DISABLE_PIPE_CONNECT
1233 if (testflag(addr, af_early_pipe))
1234 g = string_catn(g, US"*", 1);
1238 #ifndef DISABLE_PRDR
1239 if (testflag(addr, af_prdr_used))
1240 g = string_catn(g, US" PRDR", 5);
1243 if (testflag(addr, af_chunking_used))
1244 g = string_catn(g, US" K", 2);
1247 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1249 if ( LOGGING(smtp_confirmation)
1251 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1254 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1255 uschar *p = big_buffer;
1256 uschar *ss = addr->message;
1258 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1260 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1265 g = string_append(g, 2, US" C=", big_buffer);
1268 /* Time on queue and actual time taken to deliver */
1270 if (LOGGING(queue_time))
1271 g = string_append(g, 2, US" QT=",
1272 string_timesince(&received_time));
1274 if (LOGGING(deliver_time))
1275 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1277 /* string_cat() always leaves room for the terminator. Release the
1278 store we used to build the line after writing it. */
1280 log_write(0, flags, "%s", string_from_gstring(g));
1282 #ifndef DISABLE_EVENT
1283 if (!msg) msg_event_raise(US"msg:delivery", addr);
1286 store_reset(reset_point);
1293 deferral_log(address_item * addr, uschar * now,
1294 int logflags, uschar * driver_name, uschar * driver_kind)
1296 rmark reset_point = store_mark();
1297 gstring * g = string_get(256);
1299 /* Build up the line that is used for both the message log and the main
1302 /* Create the address string for logging. Must not do this earlier, because
1303 an OK result may be changed to FAIL when a pipe returns text. */
1305 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1308 g = string_append(g, 2, US" Q=", queue_name);
1310 /* Either driver_name contains something and driver_kind contains
1311 " router" or " transport" (note the leading space), or driver_name is
1312 a null string and driver_kind contains "routing" without the leading
1313 space, if all routing has been deferred. When a domain has been held,
1314 so nothing has been done at all, both variables contain null strings. */
1318 if (driver_kind[1] == 't' && addr->router)
1319 g = string_append(g, 2, US" R=", addr->router->name);
1320 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1322 else if (driver_kind)
1323 g = string_append(g, 2, US" ", driver_kind);
1325 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1327 if (addr->basic_errno > 0)
1328 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1330 if (addr->host_used)
1331 g = d_hostlog(g, addr);
1333 if (LOGGING(deliver_time))
1334 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1337 g = string_append(g, 2, US": ", addr->message);
1339 (void) string_from_gstring(g);
1341 /* Log the deferment in the message log, but don't clutter it
1342 up with retry-time defers after the first delivery attempt. */
1344 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1345 deliver_msglog("%s %s\n", now, g->s);
1347 /* Write the main log and reset the store.
1348 For errors of the type "retry time not reached" (also remotes skipped
1349 on queue run), logging is controlled by L_retry_defer. Note that this kind
1350 of error number is negative, and all the retry ones are less than any
1354 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1357 store_reset(reset_point);
1364 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1366 rmark reset_point = store_mark();
1367 gstring * g = string_get(256);
1369 #ifndef DISABLE_EVENT
1370 /* Message failures for which we will send a DSN get their event raised
1371 later so avoid doing it here. */
1373 if ( !addr->prop.ignore_error
1374 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1376 msg_event_raise(US"msg:fail:delivery", addr);
1379 /* Build up the log line for the message and main logs */
1381 /* Create the address string for logging. Must not do this earlier, because
1382 an OK result may be changed to FAIL when a pipe returns text. */
1384 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1386 if (LOGGING(sender_on_delivery))
1387 g = string_append(g, 3, US" F=<", sender_address, US">");
1390 g = string_append(g, 2, US" Q=", queue_name);
1392 /* Return path may not be set if no delivery actually happened */
1394 if (used_return_path && LOGGING(return_path_on_delivery))
1395 g = string_append(g, 3, US" P=<", used_return_path, US">");
1398 g = string_append(g, 2, US" R=", addr->router->name);
1399 if (addr->transport)
1400 g = string_append(g, 2, US" T=", addr->transport->name);
1402 if (addr->host_used)
1403 g = d_hostlog(g, addr);
1406 g = d_tlslog(g, addr);
1409 if (addr->basic_errno > 0)
1410 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1413 g = string_append(g, 2, US": ", addr->message);
1415 if (LOGGING(deliver_time))
1416 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1418 (void) string_from_gstring(g);
1420 /* Do the logging. For the message log, "routing failed" for those cases,
1421 just to make it clearer. */
1424 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1426 deliver_msglog("%s %s\n", now, g->s);
1428 log_write(0, LOG_MAIN, "** %s", g->s);
1430 store_reset(reset_point);
1436 /*************************************************
1437 * Actions at the end of handling an address *
1438 *************************************************/
1440 /* This is a function for processing a single address when all that can be done
1441 with it has been done.
1444 addr points to the address block
1445 result the result of the delivery attempt
1446 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1447 driver_type indicates which type of driver (transport, or router) was last
1448 to process the address
1449 logchar '=' or '-' for use when logging deliveries with => or ->
1455 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1458 uschar *now = tod_stamp(tod_log);
1459 uschar *driver_kind = NULL;
1460 uschar *driver_name = NULL;
1462 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1464 /* Set up driver kind and name for logging. Disable logging if the router or
1465 transport has disabled it. */
1467 if (driver_type == EXIM_DTYPE_TRANSPORT)
1469 if (addr->transport)
1471 driver_name = addr->transport->name;
1472 driver_kind = US" transport";
1473 f.disable_logging = addr->transport->disable_logging;
1475 else driver_kind = US"transporting";
1477 else if (driver_type == EXIM_DTYPE_ROUTER)
1481 driver_name = addr->router->name;
1482 driver_kind = US" router";
1483 f.disable_logging = addr->router->disable_logging;
1485 else driver_kind = US"routing";
1488 /* If there's an error message set, ensure that it contains only printing
1489 characters - it should, but occasionally things slip in and this at least
1490 stops the log format from getting wrecked. We also scan the message for an LDAP
1491 expansion item that has a password setting, and flatten the password. This is a
1492 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1493 malformed, it won't ever have gone near LDAP.) */
1497 const uschar * s = string_printing(addr->message);
1499 /* deconst cast ok as string_printing known to have alloc'n'copied */
1500 addr->message = expand_hide_passwords(US s);
1503 /* If we used a transport that has one of the "return_output" options set, and
1504 if it did in fact generate some output, then for return_output we treat the
1505 message as failed if it was not already set that way, so that the output gets
1506 returned to the sender, provided there is a sender to send it to. For
1507 return_fail_output, do this only if the delivery failed. Otherwise we just
1508 unlink the file, and remove the name so that if the delivery failed, we don't
1509 try to send back an empty or unwanted file. The log_output options operate only
1510 on a non-empty file.
1512 In any case, we close the message file, because we cannot afford to leave a
1513 file-descriptor for one address while processing (maybe very many) others. */
1515 if (addr->return_file >= 0 && addr->return_filename)
1517 BOOL return_output = FALSE;
1518 struct stat statbuf;
1519 (void)EXIMfsync(addr->return_file);
1521 /* If there is no output, do nothing. */
1523 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1525 transport_instance *tb = addr->transport;
1527 /* Handle logging options */
1530 || result == FAIL && tb->log_fail_output
1531 || result == DEFER && tb->log_defer_output
1535 FILE *f = Ufopen(addr->return_filename, "rb");
1537 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1538 "from %s transport: %s", addr->return_filename, tb->name,
1541 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1543 uschar *p = big_buffer + Ustrlen(big_buffer);
1545 while (p > big_buffer && isspace(p[-1])) p--;
1547 sp = string_printing(big_buffer);
1548 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1549 addr->address, tb->name, sp);
1554 /* Handle returning options, but only if there is an address to return
1557 if (sender_address[0] != 0 || addr->prop.errors_address)
1558 if (tb->return_output)
1560 addr->transport_return = result = FAIL;
1561 if (addr->basic_errno == 0 && !addr->message)
1562 addr->message = US"return message generated";
1563 return_output = TRUE;
1566 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1569 /* Get rid of the file unless it might be returned, but close it in
1574 Uunlink(addr->return_filename);
1575 addr->return_filename = NULL;
1576 addr->return_file = -1;
1579 (void)close(addr->return_file);
1582 /* The success case happens only after delivery by a transport. */
1586 addr->next = addr_succeed;
1587 addr_succeed = addr;
1589 /* Call address_done() to ensure that we don't deliver to this address again,
1590 and write appropriate things to the message log. If it is a child address, we
1591 call child_done() to scan the ancestors and mark them complete if this is the
1592 last child to complete. */
1594 address_done(addr, now);
1595 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1598 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1599 driver_name, driver_kind);
1602 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1603 addr->parent->address, driver_name, driver_kind);
1604 child_done(addr, now);
1607 /* Certificates for logging (via events) */
1609 tls_out.ourcert = addr->ourcert;
1610 addr->ourcert = NULL;
1611 tls_out.peercert = addr->peercert;
1612 addr->peercert = NULL;
1614 tls_out.ver = addr->tlsver;
1615 tls_out.cipher = addr->cipher;
1616 tls_out.peerdn = addr->peerdn;
1617 tls_out.ocsp = addr->ocsp;
1618 # ifdef SUPPORT_DANE
1619 tls_out.dane_verified = testflag(addr, af_dane_verified);
1623 delivery_log(LOG_MAIN, addr, logchar, NULL);
1626 tls_free_cert(&tls_out.ourcert);
1627 tls_free_cert(&tls_out.peercert);
1629 tls_out.cipher = NULL;
1630 tls_out.peerdn = NULL;
1631 tls_out.ocsp = OCSP_NOT_REQ;
1632 # ifdef SUPPORT_DANE
1633 tls_out.dane_verified = FALSE;
1639 /* Soft failure, or local delivery process failed; freezing may be
1642 else if (result == DEFER || result == PANIC)
1644 if (result == PANIC) logflags |= LOG_PANIC;
1646 /* This puts them on the chain in reverse order. Do not change this, because
1647 the code for handling retries assumes that the one with the retry
1648 information is last. */
1650 addr->next = addr_defer;
1653 /* The only currently implemented special action is to freeze the
1654 message. Logging of this is done later, just before the -H file is
1657 if (addr->special_action == SPECIAL_FREEZE)
1659 f.deliver_freeze = TRUE;
1660 deliver_frozen_at = time(NULL);
1661 update_spool = TRUE;
1664 /* If doing a 2-stage queue run, we skip writing to either the message
1665 log or the main log for SMTP defers. */
1667 if (!f.queue_2stage || addr->basic_errno != 0)
1668 deferral_log(addr, now, logflags, driver_name, driver_kind);
1672 /* Hard failure. If there is an address to which an error message can be sent,
1673 put this address on the failed list. If not, put it on the deferred list and
1674 freeze the mail message for human attention. The latter action can also be
1675 explicitly requested by a router or transport. */
1679 /* If this is a delivery error, or a message for which no replies are
1680 wanted, and the message's age is greater than ignore_bounce_errors_after,
1681 force the af_ignore_error flag. This will cause the address to be discarded
1682 later (with a log entry). */
1684 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1685 addr->prop.ignore_error = TRUE;
1687 /* Freeze the message if requested, or if this is a bounce message (or other
1688 message with null sender) and this address does not have its own errors
1689 address. However, don't freeze if errors are being ignored. The actual code
1690 to ignore occurs later, instead of sending a message. Logging of freezing
1691 occurs later, just before writing the -H file. */
1693 if ( !addr->prop.ignore_error
1694 && ( addr->special_action == SPECIAL_FREEZE
1695 || (sender_address[0] == 0 && !addr->prop.errors_address)
1698 frozen_info = addr->special_action == SPECIAL_FREEZE
1700 : f.sender_local && !f.local_error_message
1701 ? US" (message created with -f <>)"
1702 : US" (delivery error message)";
1703 f.deliver_freeze = TRUE;
1704 deliver_frozen_at = time(NULL);
1705 update_spool = TRUE;
1707 /* The address is put on the defer rather than the failed queue, because
1708 the message is being retained. */
1710 addr->next = addr_defer;
1714 /* Don't put the address on the nonrecipients tree yet; wait until an
1715 error message has been successfully sent. */
1719 addr->next = addr_failed;
1723 failure_log(addr, driver_name ? NULL : driver_kind, now);
1726 /* Ensure logging is turned on again in all cases */
1728 f.disable_logging = FALSE;
1734 /*************************************************
1735 * Address-independent error *
1736 *************************************************/
1738 /* This function is called when there's an error that is not dependent on a
1739 particular address, such as an expansion string failure. It puts the error into
1740 all the addresses in a batch, logs the incident on the main and panic logs, and
1741 clears the expansions. It is mostly called from local_deliver(), but can be
1742 called for a remote delivery via findugid().
1745 logit TRUE if (MAIN+PANIC) logging required
1746 addr the first of the chain of addresses
1748 format format string for error message, or NULL if already set in addr
1749 ... arguments for the format
1755 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1757 addr->basic_errno = code;
1764 va_start(ap, format);
1765 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1767 addr->message = string_from_gstring(g);
1770 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1772 addr2->basic_errno = code;
1773 addr2->message = addr->message;
1776 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1777 deliver_set_expansions(NULL);
1783 /*************************************************
1784 * Check a "never users" list *
1785 *************************************************/
1787 /* This function is called to check whether a uid is on one of the two "never
1791 uid the uid to be checked
1792 nusers the list to be scanned; the first item in the list is the count
1794 Returns: TRUE if the uid is on the list
1798 check_never_users(uid_t uid, uid_t *nusers)
1800 if (!nusers) return FALSE;
1801 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1807 /*************************************************
1808 * Find uid and gid for a transport *
1809 *************************************************/
1811 /* This function is called for both local and remote deliveries, to find the
1812 uid/gid under which to run the delivery. The values are taken preferentially
1813 from the transport (either explicit or deliver_as_creator), then from the
1814 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1815 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1816 panic error is logged, and the function fails (which normally leads to delivery
1820 addr the address (possibly a chain)
1822 uidp pointer to uid field
1823 gidp pointer to gid field
1824 igfp pointer to the use_initgroups field
1826 Returns: FALSE if failed - error has been set in address(es)
1830 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1834 BOOL gid_set = FALSE;
1836 /* Default initgroups flag comes from the transport */
1838 *igfp = tp->initgroups;
1840 /* First see if there's a gid on the transport, either fixed or expandable.
1841 The expanding function always logs failure itself. */
1848 else if (tp->expand_gid)
1850 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1853 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1859 /* If the transport did not set a group, see if the router did. */
1861 if (!gid_set && testflag(addr, af_gid_set))
1867 /* Pick up a uid from the transport if one is set. */
1869 if (tp->uid_set) *uidp = tp->uid;
1871 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1872 it does not provide a passwd value from which a gid can be taken. */
1874 else if (tp->expand_uid)
1877 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1878 uidp, &(addr->message)))
1880 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1890 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1892 else if (tp->deliver_as_creator)
1894 *uidp = originator_uid;
1897 *gidp = originator_gid;
1902 /* Otherwise see if the address specifies the uid and if so, take it and its
1905 else if (testflag(addr, af_uid_set))
1908 *igfp = testflag(addr, af_initgroups);
1911 /* Nothing has specified the uid - default to the Exim user, and group if the
1924 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1925 defaulting to the Exim uid. In other words, if the configuration has specified
1926 a uid, it must also provide a gid. */
1930 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1931 "%s transport", tp->name);
1935 /* Check that the uid is not on the lists of banned uids that may not be used
1936 for delivery processes. */
1938 nuname = check_never_users(*uidp, never_users)
1940 : check_never_users(*uidp, fixed_never_users)
1941 ? US"fixed_never_users"
1945 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1946 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1958 /*************************************************
1959 * Check the size of a message for a transport *
1960 *************************************************/
1962 /* Checks that the message isn't too big for the selected transport.
1963 This is called only when it is known that the limit is set.
1967 addr the (first) address being delivered
1970 DEFER expansion failed or did not yield an integer
1971 FAIL message too big
1975 check_message_size(transport_instance *tp, address_item *addr)
1980 deliver_set_expansions(addr);
1981 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1982 deliver_set_expansions(NULL);
1984 if (expand_string_message)
1987 addr->message = size_limit == -1
1988 ? string_sprintf("failed to expand message_size_limit "
1989 "in %s transport: %s", tp->name, expand_string_message)
1990 : string_sprintf("invalid message_size_limit "
1991 "in %s transport: %s", tp->name, expand_string_message);
1993 else if (size_limit > 0 && message_size > size_limit)
1997 string_sprintf("message is too big (transport limit = %d)",
2006 /*************************************************
2007 * Transport-time check for a previous delivery *
2008 *************************************************/
2010 /* Check that this base address hasn't previously been delivered to its routed
2011 transport. If it has been delivered, mark it done. The check is necessary at
2012 delivery time in order to handle homonymic addresses correctly in cases where
2013 the pattern of redirection changes between delivery attempts (so the unique
2014 fields change). Non-homonymic previous delivery is detected earlier, at routing
2015 time (which saves unnecessary routing).
2018 addr the address item
2019 testing TRUE if testing wanted only, without side effects
2021 Returns: TRUE if previously delivered by the transport
2025 previously_transported(address_item *addr, BOOL testing)
2027 uschar * s = string_sprintf("%s/%s",
2028 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2030 if (tree_search(tree_nonrecipients, s) != 0)
2032 DEBUG(D_deliver|D_route|D_transport)
2033 debug_printf("%s was previously delivered (%s transport): discarded\n",
2034 addr->address, addr->transport->name);
2035 if (!testing) child_done(addr, tod_stamp(tod_log));
2044 /******************************************************
2045 * Check for a given header in a header string *
2046 ******************************************************/
2048 /* This function is used when generating quota warnings. The configuration may
2049 specify any header lines it likes in quota_warn_message. If certain of them are
2050 missing, defaults are inserted, so we need to be able to test for the presence
2054 hdr the required header name
2055 hstring the header string
2057 Returns: TRUE the header is in the string
2058 FALSE the header is not in the string
2062 contains_header(uschar *hdr, uschar *hstring)
2064 int len = Ustrlen(hdr);
2065 uschar *p = hstring;
2068 if (strncmpic(p, hdr, len) == 0)
2071 while (*p == ' ' || *p == '\t') p++;
2072 if (*p == ':') return TRUE;
2074 while (*p != 0 && *p != '\n') p++;
2075 if (*p == '\n') p++;
2083 /*************************************************
2084 * Perform a local delivery *
2085 *************************************************/
2087 /* Each local delivery is performed in a separate process which sets its
2088 uid and gid as specified. This is a safer way than simply changing and
2089 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2090 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2091 all systems have seteuid().
2093 If the uid/gid are specified in the transport_instance, they are used; the
2094 transport initialization must ensure that either both or neither are set.
2095 Otherwise, the values associated with the address are used. If neither are set,
2096 it is a configuration error.
2098 The transport or the address may specify a home directory (transport over-
2099 rides), and if they do, this is set as $home. If neither have set a working
2100 directory, this value is used for that as well. Otherwise $home is left unset
2101 and the cwd is set to "/" - a directory that should be accessible to all users.
2103 Using a separate process makes it more complicated to get error information
2104 back. We use a pipe to pass the return code and also an error code and error
2105 text string back to the parent process.
2108 addr points to an address block for this delivery; for "normal" local
2109 deliveries this is the only address to be delivered, but for
2110 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2111 a number of addresses can be handled simultaneously, and in this
2112 case addr will point to a chain of addresses with the same
2115 shadowing TRUE if running a shadow transport; this causes output from pipes
2122 deliver_local(address_item *addr, BOOL shadowing)
2124 BOOL use_initgroups;
2127 int status, len, rc;
2130 uschar *working_directory;
2131 address_item *addr2;
2132 transport_instance *tp = addr->transport;
2134 /* Set up the return path from the errors or sender address. If the transport
2135 has its own return path setting, expand it and replace the existing value. */
2137 if(addr->prop.errors_address)
2138 return_path = addr->prop.errors_address;
2139 #ifdef EXPERIMENTAL_SRS_ALT
2140 else if (addr->prop.srs_sender)
2141 return_path = addr->prop.srs_sender;
2144 return_path = sender_address;
2146 if (tp->return_path)
2148 uschar * new_return_path = expand_string(tp->return_path);
2149 if (new_return_path)
2150 return_path = new_return_path;
2151 else if (!f.expand_string_forcedfail)
2153 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2154 US"Failed to expand return path \"%s\" in %s transport: %s",
2155 tp->return_path, tp->name, expand_string_message);
2160 /* For local deliveries, one at a time, the value used for logging can just be
2161 set directly, once and for all. */
2163 used_return_path = return_path;
2165 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2166 gets put into the address(es), and the expansions are unset, so we can just
2169 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2171 /* See if either the transport or the address specifies a home directory. A
2172 home directory set in the address may already be expanded; a flag is set to
2173 indicate that. In other cases we must expand it. */
2175 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2176 || ( (deliver_home = addr->home_dir) /* Set in address and */
2177 && !testflag(addr, af_home_expanded) /* not expanded */
2180 uschar *rawhome = deliver_home;
2181 deliver_home = NULL; /* in case it contains $home */
2182 if (!(deliver_home = expand_string(rawhome)))
2184 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2185 "to expand for %s transport: %s", rawhome, tp->name,
2186 expand_string_message);
2189 if (*deliver_home != '/')
2191 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2192 "is not absolute for %s transport", deliver_home, tp->name);
2197 /* See if either the transport or the address specifies a current directory,
2198 and if so, expand it. If nothing is set, use the home directory, unless it is
2199 also unset in which case use "/", which is assumed to be a directory to which
2200 all users have access. It is necessary to be in a visible directory for some
2201 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2202 2.5) require this. */
2204 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2205 if (working_directory)
2207 uschar *raw = working_directory;
2208 if (!(working_directory = expand_string(raw)))
2210 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2211 "failed to expand for %s transport: %s", raw, tp->name,
2212 expand_string_message);
2215 if (*working_directory != '/')
2217 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2218 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2222 else working_directory = deliver_home ? deliver_home : US"/";
2224 /* If one of the return_output flags is set on the transport, create and open a
2225 file in the message log directory for the transport to write its output onto.
2226 This is mainly used by pipe transports. The file needs to be unique to the
2227 address. This feature is not available for shadow transports. */
2230 && ( tp->return_output || tp->return_fail_output
2231 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2236 addr->return_filename =
2237 spool_fname(US"msglog", message_subdir, message_id,
2238 string_sprintf("-%d-%d", getpid(), return_count++));
2240 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2242 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2243 "to return message: %s", error, tp->name, strerror(errno));
2248 /* Create the pipe for inter-process communication. */
2252 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2257 /* Now fork the process to do the real work in the subprocess, but first
2258 ensure that all cached resources are freed so that the subprocess starts with
2259 a clean slate and doesn't interfere with the parent process. */
2263 if ((pid = exim_fork(US"delivery-local")) == 0)
2265 BOOL replicate = TRUE;
2267 /* Prevent core dumps, as we don't want them in users' home directories.
2268 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2269 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2270 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2271 complain if the error is "not supported".
2273 There are two scenarios where changing the max limit has an effect. In one,
2274 the user is using a .forward and invoking a command of their choice via pipe;
2275 for these, we do need the max limit to be 0 unless the admin chooses to
2276 permit an increased limit. In the other, the command is invoked directly by
2277 the transport and is under administrator control, thus being able to raise
2278 the limit aids in debugging. So there's no general always-right answer.
2280 Thus we inhibit core-dumps completely but let individual transports, while
2281 still root, re-raise the limits back up to aid debugging. We make the
2282 default be no core-dumps -- few enough people can use core dumps in
2283 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2290 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2292 # ifdef SETRLIMIT_NOT_SUPPORTED
2293 if (errno != ENOSYS && errno != ENOTSUP)
2295 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2300 /* Reset the random number generator, so different processes don't all
2301 have the same sequence. */
2305 /* If the transport has a setup entry, call this first, while still
2306 privileged. (Appendfile uses this to expand quota, for example, while
2307 able to read private files.) */
2309 if (addr->transport->setup)
2310 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2314 addr->transport_return = DEFER;
2318 addr->transport_return = PANIC;
2322 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2323 when the process becomes unprivileged, it won't be able to write to the
2324 process log. SIGHUP is ignored throughout exim, except when it is being
2327 signal(SIGINT, SIG_IGN);
2328 signal(SIGTERM, SIG_IGN);
2329 signal(SIGUSR1, SIG_IGN);
2331 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2332 half - for transports that exec things (e.g. pipe). Then set the required
2335 (void)close(pfd[pipe_read]);
2336 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2338 exim_setugid(uid, gid, use_initgroups,
2339 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2340 addr->address, addr->transport->name));
2344 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2345 for (address_item * batched = addr->next; batched; batched = batched->next)
2346 debug_printf("additional batched address: %s\n", batched->address);
2349 /* Set an appropriate working directory. */
2351 if (Uchdir(working_directory) < 0)
2353 addr->transport_return = DEFER;
2354 addr->basic_errno = errno;
2355 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2358 /* If successful, call the transport */
2363 set_process_info("delivering %s to %s using %s", message_id,
2364 addr->local_part, addr->transport->name);
2366 /* Setting this global in the subprocess means we need never clear it */
2367 transport_name = addr->transport->name;
2369 /* If a transport filter has been specified, set up its argument list.
2370 Any errors will get put into the address, and FALSE yielded. */
2372 if (addr->transport->filter_command)
2374 ok = transport_set_up_command(&transport_filter_argv,
2375 addr->transport->filter_command,
2376 TRUE, PANIC, addr, US"transport filter", NULL);
2377 transport_filter_timeout = addr->transport->filter_timeout;
2379 else transport_filter_argv = NULL;
2383 debug_print_string(addr->transport->debug_string);
2384 replicate = !(addr->transport->info->code)(addr->transport, addr);
2388 /* Pass the results back down the pipe. If necessary, first replicate the
2389 status in the top address to the others in the batch. The label is the
2390 subject of a goto when a call to the transport's setup function fails. We
2391 pass the pointer to the transport back in case it got changed as a result of
2392 file_format in appendfile. */
2396 if (replicate) replicate_status(addr);
2397 for (addr2 = addr; addr2; addr2 = addr2->next)
2400 int local_part_length = Ustrlen(addr2->local_part);
2404 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2405 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2406 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2407 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2408 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2409 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2410 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2411 || (ret = write(pfd[pipe_write], &addr2->transport,
2412 sizeof(transport_instance *))) != sizeof(transport_instance *)
2414 /* For a file delivery, pass back the local part, in case the original
2415 was only part of the final delivery path. This gives more complete
2418 || (testflag(addr2, af_file)
2419 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2420 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2424 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2425 ret == -1 ? strerror(errno) : "short write");
2427 /* Now any messages */
2429 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2431 int message_length = s ? Ustrlen(s) + 1 : 0;
2432 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2433 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2435 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2436 ret == -1 ? strerror(errno) : "short write");
2440 /* OK, this process is now done. Free any cached resources that it opened,
2441 and close the pipe we were writing down before exiting. */
2443 (void)close(pfd[pipe_write]);
2448 /* Back in the main process: panic if the fork did not succeed. This seems
2449 better than returning an error - if forking is failing it is probably best
2450 not to try other deliveries for this message. */
2453 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2456 /* Read the pipe to get the delivery status codes and error messages. Our copy
2457 of the writing end must be closed first, as otherwise read() won't return zero
2458 on an empty pipe. We check that a status exists for each address before
2459 overwriting the address structure. If data is missing, the default DEFER status
2460 will remain. Afterwards, close the reading end. */
2462 (void)close(pfd[pipe_write]);
2464 for (addr2 = addr; addr2; addr2 = addr2->next)
2466 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2471 addr2->transport_return = status;
2472 len = read(pfd[pipe_read], &transport_count,
2473 sizeof(transport_count));
2474 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2475 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2476 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2477 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2478 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2479 len = read(pfd[pipe_read], &addr2->transport,
2480 sizeof(transport_instance *));
2482 if (testflag(addr2, af_file))
2485 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2486 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2489 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2490 " from delivery subprocess");
2493 /* sanity-checked llen so disable the Coverity error */
2494 /* coverity[tainted_data] */
2495 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2497 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2498 " from delivery subprocess");
2501 big_buffer[llen] = 0;
2502 addr2->local_part = string_copy(big_buffer);
2505 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2508 len = read(pfd[pipe_read], &message_length, sizeof(int));
2509 if (message_length > 0)
2511 len = read(pfd[pipe_read], big_buffer, message_length);
2512 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2513 if (len > 0) *sptr = string_copy(big_buffer);
2520 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2521 "from delivery subprocess", addr2->unique);
2526 (void)close(pfd[pipe_read]);
2528 /* Unless shadowing, write all successful addresses immediately to the journal
2529 file, to ensure they are recorded asap. For homonymic addresses, use the base
2530 address plus the transport name. Failure to write the journal is panic-worthy,
2531 but don't stop, as it may prove possible subsequently to update the spool file
2532 in order to record the delivery. */
2536 for (addr2 = addr; addr2; addr2 = addr2->next)
2537 if (addr2->transport_return == OK)
2539 if (testflag(addr2, af_homonym))
2540 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2542 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2544 /* In the test harness, wait just a bit to let the subprocess finish off
2545 any debug output etc first. */
2547 testharness_pause_ms(300);
2549 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2550 len = Ustrlen(big_buffer);
2551 if (write(journal_fd, big_buffer, len) != len)
2552 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2553 big_buffer, strerror(errno));
2556 /* Ensure the journal file is pushed out to disk. */
2558 if (EXIMfsync(journal_fd) < 0)
2559 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2563 /* Wait for the process to finish. If it terminates with a non-zero code,
2564 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2565 status values of all the addresses as they are. Take care to handle the case
2566 when the subprocess doesn't seem to exist. This has been seen on one system
2567 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2568 happens, wait() doesn't recognize the termination of child processes. Exim now
2569 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2571 while ((rc = wait(&status)) != pid)
2572 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2574 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2575 addr->transport->driver_name);
2580 if ((status & 0xffff) != 0)
2582 int msb = (status >> 8) & 255;
2583 int lsb = status & 255;
2584 int code = (msb == 0)? (lsb & 0x7f) : msb;
2585 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2586 addr->special_action = SPECIAL_FREEZE;
2587 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2588 "status 0x%04x: %s %d",
2589 addr->transport->driver_name,
2591 msb == 0 ? "terminated by signal" : "exit code",
2595 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2597 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2600 uschar *warn_message;
2603 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2605 if (!(warn_message = expand_string(addr->transport->warn_message)))
2606 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2607 "message for %s transport): %s", addr->transport->warn_message,
2608 addr->transport->name, expand_string_message);
2610 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2612 FILE *f = fdopen(fd, "wb");
2613 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2614 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2615 fprintf(f, "Auto-Submitted: auto-replied\n");
2616 if (!contains_header(US"From", warn_message))
2618 fprintf(f, "%s", CS warn_message);
2620 /* Close and wait for child process to complete, without a timeout. */
2623 (void)child_close(pid, 0);
2626 addr->special_action = SPECIAL_NONE;
2633 /* Check transport for the given concurrency limit. Return TRUE if over
2634 the limit (or an expansion failure), else FALSE and if there was a limit,
2635 the key for the hints database used for the concurrency count. */
2638 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2640 unsigned max_parallel;
2642 if (!tp->max_parallel) return FALSE;
2644 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2645 if (expand_string_message)
2647 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2648 "in %s transport (%s): %s", tp->name, addr->address,
2649 expand_string_message);
2653 if (max_parallel > 0)
2655 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2656 if (!enq_start(serialize_key, max_parallel))
2658 address_item * next;
2660 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2661 tp->name, max_parallel);
2665 addr->message = US"concurrency limit reached for transport";
2666 addr->basic_errno = ERRNO_TRETRY;
2667 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2668 } while ((addr = next));
2671 *key = serialize_key;
2678 /*************************************************
2679 * Do local deliveries *
2680 *************************************************/
2682 /* This function processes the list of addresses in addr_local. True local
2683 deliveries are always done one address at a time. However, local deliveries can
2684 be batched up in some cases. Typically this is when writing batched SMTP output
2685 files for use by some external transport mechanism, or when running local
2686 deliveries over LMTP.
2693 do_local_deliveries(void)
2696 open_db *dbm_file = NULL;
2697 time_t now = time(NULL);
2699 /* Loop until we have exhausted the supply of local deliveries */
2703 struct timeval delivery_start;
2704 struct timeval deliver_time;
2705 address_item *addr2, *addr3, *nextaddr;
2706 int logflags = LOG_MAIN;
2707 int logchar = f.dont_deliver? '*' : '=';
2708 transport_instance *tp;
2709 uschar * serialize_key = NULL;
2711 /* Pick the first undelivered address off the chain */
2713 address_item *addr = addr_local;
2714 addr_local = addr->next;
2717 DEBUG(D_deliver|D_transport)
2718 debug_printf("--------> %s <--------\n", addr->address);
2720 /* An internal disaster if there is no transport. Should not occur! */
2722 if (!(tp = addr->transport))
2724 logflags |= LOG_PANIC;
2725 f.disable_logging = FALSE; /* Jic */
2726 addr->message = addr->router
2727 ? string_sprintf("No transport set by %s router", addr->router->name)
2728 : US"No transport set by system filter";
2729 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2733 /* Check that this base address hasn't previously been delivered to this
2734 transport. The check is necessary at this point to handle homonymic addresses
2735 correctly in cases where the pattern of redirection changes between delivery
2736 attempts. Non-homonymic previous delivery is detected earlier, at routing
2739 if (previously_transported(addr, FALSE)) continue;
2741 /* There are weird cases where logging is disabled */
2743 f.disable_logging = tp->disable_logging;
2745 /* Check for batched addresses and possible amalgamation. Skip all the work
2746 if either batch_max <= 1 or there aren't any other addresses for local
2749 if (tp->batch_max > 1 && addr_local)
2751 int batch_count = 1;
2752 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2753 BOOL uses_lp = ( testflag(addr, af_pfr)
2754 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2756 || readconf_depends((driver_instance *)tp, US"local_part");
2757 uschar *batch_id = NULL;
2758 address_item **anchor = &addr_local;
2759 address_item *last = addr;
2762 /* Expand the batch_id string for comparison with other addresses.
2763 Expansion failure suppresses batching. */
2767 deliver_set_expansions(addr);
2768 batch_id = expand_string(tp->batch_id);
2769 deliver_set_expansions(NULL);
2772 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2773 "in %s transport (%s): %s", tp->name, addr->address,
2774 expand_string_message);
2775 batch_count = tp->batch_max;
2779 /* Until we reach the batch_max limit, pick off addresses which have the
2780 same characteristics. These are:
2783 not previously delivered (see comment about 50 lines above)
2784 same local part if the transport's configuration contains $local_part
2785 or if this is a file or pipe delivery from a redirection
2786 same domain if the transport's configuration contains $domain
2788 same additional headers
2789 same headers to be removed
2790 same uid/gid for running the transport
2791 same first host if a host list is set
2794 while ((next = *anchor) && batch_count < tp->batch_max)
2797 tp == next->transport
2798 && !previously_transported(next, TRUE)
2799 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2800 && testflag(addr, af_file) == testflag(next, af_file)
2801 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2802 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2803 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2804 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2805 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2806 && same_ugid(tp, addr, next)
2807 && ( !addr->host_list && !next->host_list
2810 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2813 /* If the transport has a batch_id setting, batch_id will be non-NULL
2814 from the expansion outside the loop. Expand for this address and compare.
2815 Expansion failure makes this address ineligible for batching. */
2820 address_item *save_nextnext = next->next;
2821 next->next = NULL; /* Expansion for a single address */
2822 deliver_set_expansions(next);
2823 next->next = save_nextnext;
2824 bid = expand_string(tp->batch_id);
2825 deliver_set_expansions(NULL);
2828 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2829 "in %s transport (%s): %s", tp->name, next->address,
2830 expand_string_message);
2833 else ok = (Ustrcmp(batch_id, bid) == 0);
2836 /* Take address into batch if OK. */
2840 *anchor = next->next; /* Include the address */
2846 else anchor = &next->next; /* Skip the address */
2850 /* We now have one or more addresses that can be delivered in a batch. Check
2851 whether the transport is prepared to accept a message of this size. If not,
2852 fail them all forthwith. If the expansion fails, or does not yield an
2853 integer, defer delivery. */
2855 if (tp->message_size_limit)
2857 int rc = check_message_size(tp, addr);
2860 replicate_status(addr);
2864 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2867 continue; /* With next batch of addresses */
2871 /* If we are not running the queue, or if forcing, all deliveries will be
2872 attempted. Otherwise, we must respect the retry times for each address. Even
2873 when not doing this, we need to set up the retry key string, and determine
2874 whether a retry record exists, because after a successful delivery, a delete
2875 retry item must be set up. Keep the retry database open only for the duration
2876 of these checks, rather than for all local deliveries, because some local
2877 deliveries (e.g. to pipes) can take a substantial time. */
2879 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2881 DEBUG(D_deliver|D_retry|D_hints_lookup)
2882 debug_printf("no retry data available\n");
2889 BOOL ok = TRUE; /* to deliver this address */
2892 /* Set up the retry key to include the domain or not, and change its
2893 leading character from "R" to "T". Must make a copy before doing this,
2894 because the old key may be pointed to from a "delete" retry item after
2897 retry_key = string_copy(
2898 tp->retry_use_local_part ? addr2->address_retry_key :
2899 addr2->domain_retry_key);
2902 /* Inspect the retry data. If there is no hints file, delivery happens. */
2906 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2908 /* If there is no retry record, delivery happens. If there is,
2909 remember it exists so it can be deleted after a successful delivery. */
2913 setflag(addr2, af_lt_retry_exists);
2915 /* A retry record exists for this address. If queue running and not
2916 forcing, inspect its contents. If the record is too old, or if its
2917 retry time has come, or if it has passed its cutoff time, delivery
2922 debug_printf("retry record exists: age=%s ",
2923 readconf_printtime(now - retry_record->time_stamp));
2924 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2925 debug_printf(" time to retry = %s expired = %d\n",
2926 readconf_printtime(retry_record->next_try - now),
2927 retry_record->expired);
2930 if (f.queue_running && !f.deliver_force)
2932 ok = (now - retry_record->time_stamp > retry_data_expire)
2933 || (now >= retry_record->next_try)
2934 || retry_record->expired;
2936 /* If we haven't reached the retry time, there is one more check
2937 to do, which is for the ultimate address timeout. */
2940 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2944 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2947 /* This address is to be delivered. Leave it on the chain. */
2952 addr2 = addr2->next;
2955 /* This address is to be deferred. Take it out of the chain, and
2956 post-process it as complete. Must take it out of the chain first,
2957 because post processing puts it on another chain. */
2961 address_item *this = addr2;
2962 this->message = US"Retry time not yet reached";
2963 this->basic_errno = ERRNO_LRETRY;
2964 addr2 = addr3 ? (addr3->next = addr2->next)
2965 : (addr = addr2->next);
2966 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2970 if (dbm_file) dbfn_close(dbm_file);
2972 /* If there are no addresses left on the chain, they all deferred. Loop
2973 for the next set of addresses. */
2975 if (!addr) continue;
2977 /* If the transport is limited for parallellism, enforce that here.
2978 We use a hints DB entry, incremented here and decremented after
2979 the transport (and any shadow transport) completes. */
2981 if (tpt_parallel_check(tp, addr, &serialize_key))
2983 if (expand_string_message)
2985 logflags |= LOG_PANIC;
2989 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2990 } while ((addr = addr2));
2992 continue; /* Loop for the next set of addresses. */
2996 /* So, finally, we do have some addresses that can be passed to the
2997 transport. Before doing so, set up variables that are relevant to a
3000 deliver_set_expansions(addr);
3002 gettimeofday(&delivery_start, NULL);
3003 deliver_local(addr, FALSE);
3004 timesince(&deliver_time, &delivery_start);
3006 /* If a shadow transport (which must perforce be another local transport), is
3007 defined, and its condition is met, we must pass the message to the shadow
3008 too, but only those addresses that succeeded. We do this by making a new
3009 chain of addresses - also to keep the original chain uncontaminated. We must
3010 use a chain rather than doing it one by one, because the shadow transport may
3013 NOTE: if the condition fails because of a lookup defer, there is nothing we
3017 && ( !tp->shadow_condition
3018 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3021 transport_instance *stp;
3022 address_item *shadow_addr = NULL;
3023 address_item **last = &shadow_addr;
3025 for (stp = transports; stp; stp = stp->next)
3026 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3029 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3032 /* Pick off the addresses that have succeeded, and make clones. Put into
3033 the shadow_message field a pointer to the shadow_message field of the real
3036 else for (addr2 = addr; addr2; addr2 = addr2->next)
3037 if (addr2->transport_return == OK)
3039 addr3 = store_get(sizeof(address_item), FALSE);
3042 addr3->shadow_message = US &addr2->shadow_message;
3043 addr3->transport = stp;
3044 addr3->transport_return = DEFER;
3045 addr3->return_filename = NULL;
3046 addr3->return_file = -1;
3048 last = &addr3->next;
3051 /* If we found any addresses to shadow, run the delivery, and stick any
3052 message back into the shadow_message field in the original. */
3056 int save_count = transport_count;
3058 DEBUG(D_deliver|D_transport)
3059 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3060 deliver_local(shadow_addr, TRUE);
3062 for(; shadow_addr; shadow_addr = shadow_addr->next)
3064 int sresult = shadow_addr->transport_return;
3065 *(uschar **)shadow_addr->shadow_message =
3067 ? string_sprintf(" ST=%s", stp->name)
3068 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3069 shadow_addr->basic_errno <= 0
3071 : US strerror(shadow_addr->basic_errno),
3072 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3075 shadow_addr->message
3076 ? shadow_addr->message
3077 : shadow_addr->basic_errno <= 0
3081 DEBUG(D_deliver|D_transport)
3082 debug_printf("%s shadow transport returned %s for %s\n",
3083 stp->name, rc_to_string(sresult), shadow_addr->address);
3086 DEBUG(D_deliver|D_transport)
3087 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3089 transport_count = save_count; /* Restore original transport count */
3093 /* Cancel the expansions that were set up for the delivery. */
3095 deliver_set_expansions(NULL);
3097 /* If the transport was parallelism-limited, decrement the hints DB record. */
3099 if (serialize_key) enq_end(serialize_key);
3101 /* Now we can process the results of the real transport. We must take each
3102 address off the chain first, because post_process_one() puts it on another
3105 for (addr2 = addr; addr2; addr2 = nextaddr)
3107 int result = addr2->transport_return;
3108 nextaddr = addr2->next;
3110 DEBUG(D_deliver|D_transport)
3111 debug_printf("%s transport returned %s for %s\n",
3112 tp->name, rc_to_string(result), addr2->address);
3114 /* If there is a retry_record, or if delivery is deferred, build a retry
3115 item for setting a new retry time or deleting the old retry record from
3116 the database. These items are handled all together after all addresses
3117 have been handled (so the database is open just for a short time for
3120 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3122 int flags = result == DEFER ? 0 : rf_delete;
3123 uschar *retry_key = string_copy(tp->retry_use_local_part
3124 ? addr2->address_retry_key : addr2->domain_retry_key);
3126 retry_add_item(addr2, retry_key, flags);
3129 /* Done with this address */
3131 addr2->delivery_time = deliver_time;
3132 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3134 /* If a pipe delivery generated text to be sent back, the result may be
3135 changed to FAIL, and we must copy this for subsequent addresses in the
3138 if (addr2->transport_return != result)
3140 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3142 addr3->transport_return = addr2->transport_return;
3143 addr3->basic_errno = addr2->basic_errno;
3144 addr3->message = addr2->message;
3146 result = addr2->transport_return;
3149 /* Whether or not the result was changed to FAIL, we need to copy the
3150 return_file value from the first address into all the addresses of the
3151 batch, so they are all listed in the error message. */
3153 addr2->return_file = addr->return_file;
3155 /* Change log character for recording successful deliveries. */
3157 if (result == OK) logchar = '-';
3159 } /* Loop back for next batch of addresses */
3165 /*************************************************
3166 * Sort remote deliveries *
3167 *************************************************/
3169 /* This function is called if remote_sort_domains is set. It arranges that the
3170 chain of addresses for remote deliveries is ordered according to the strings
3171 specified. Try to make this shuffling reasonably efficient by handling
3172 sequences of addresses rather than just single ones.
3179 sort_remote_deliveries(void)
3182 address_item **aptr = &addr_remote;
3183 const uschar *listptr = remote_sort_domains;
3187 /*XXX The list is used before expansion. Not sure how that ties up with the docs */
3189 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3192 address_item *moved = NULL;
3193 address_item **bptr = &moved;
3197 address_item **next;
3198 deliver_domain = (*aptr)->domain; /* set $domain */
3199 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3200 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3202 aptr = &(*aptr)->next;
3206 next = &(*aptr)->next;
3208 && (deliver_domain = (*next)->domain, /* Set $domain */
3209 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3210 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3212 next = &(*next)->next;
3214 /* If the batch of non-matchers is at the end, add on any that were
3215 extracted further up the chain, and end this iteration. Otherwise,
3216 extract them from the chain and hang on the moved chain. */
3228 aptr = &(*aptr)->next;
3231 /* If the loop ended because the final address matched, *aptr will
3232 be NULL. Add on to the end any extracted non-matching addresses. If
3233 *aptr is not NULL, the loop ended via "break" when *next is null, that
3234 is, there was a string of non-matching addresses at the end. In this
3235 case the extracted addresses have already been added on the end. */
3237 if (!*aptr) *aptr = moved;
3242 debug_printf("remote addresses after sorting:\n");
3243 for (address_item * addr = addr_remote; addr; addr = addr->next)
3244 debug_printf(" %s\n", addr->address);
3250 /*************************************************
3251 * Read from pipe for remote delivery subprocess *
3252 *************************************************/
3254 /* This function is called when the subprocess is complete, but can also be
3255 called before it is complete, in order to empty a pipe that is full (to prevent
3256 deadlock). It must therefore keep track of its progress in the parlist data
3259 We read the pipe to get the delivery status codes and a possible error message
3260 for each address, optionally preceded by unusability data for the hosts and
3261 also by optional retry data.
3263 Read in large chunks into the big buffer and then scan through, interpreting
3264 the data therein. In most cases, only a single read will be necessary. No
3265 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3266 that we read the next chunk when there is less than 2500 bytes left in the
3267 non-final chunk, we can assume each item is complete in the buffer before
3268 handling it. Each item is written using a single write(), which is atomic for
3269 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3270 often bigger) so even if we are reading while the subprocess is still going, we
3271 should never have only a partial item in the buffer.
3273 hs12: This assumption is not true anymore, since we get quite large items (certificate
3274 information and such).
3277 poffset the offset of the parlist item
3278 eop TRUE if the process has completed
3280 Returns: TRUE if the terminating 'Z' item has been read,
3281 or there has been a disaster (i.e. no more data needed);
3286 par_read_pipe(int poffset, BOOL eop)
3289 pardata *p = parlist + poffset;
3290 address_item *addrlist = p->addrlist;
3291 address_item *addr = p->addr;
3295 uschar *msg = p->msg;
3296 BOOL done = p->done;
3298 /* Loop through all items, reading from the pipe when necessary. The pipe
3299 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3300 here, as the preceding select() tells us, if data is available for reading.
3302 A read() on a "selected" handle should never block, but(!) it may return
3303 less data then we expected. (The buffer size we pass to read() shouldn't be
3304 understood as a "request", but as a "limit".)
3306 Each separate item is written to the pipe in a timely manner. But, especially for
3307 larger items, the read(2) may already return partial data from the write(2).
3309 The write is atomic mostly (depending on the amount written), but atomic does
3310 not imply "all or noting", it just is "not intermixed" with other writes on the
3311 same channel (pipe).
3315 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3316 (int)p->pid, eop? "ended" : "not ended yet");
3320 retry_item *r, **rp;
3321 uschar pipeheader[PIPE_HEADER_SIZE+1];
3322 uschar *id = &pipeheader[0];
3323 uschar *subid = &pipeheader[1];
3324 uschar *ptr = big_buffer;
3325 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3328 DEBUG(D_deliver) debug_printf(
3329 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3331 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3332 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3333 If we get less, we can assume the subprocess do be done and do not expect any further
3334 information from it. */
3336 if ((got = readn(fd, pipeheader, required)) != required)
3338 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3339 "from transport process %d for transport %s",
3340 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3345 pipeheader[PIPE_HEADER_SIZE] = '\0';
3347 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3351 /* If we can't decode the pipeheader, the subprocess seems to have a
3352 problem, we do not expect any furher information from it. */
3354 required = Ustrtol(pipeheader+2, &endc, 10);
3357 msg = string_sprintf("failed to read pipe "
3358 "from transport process %d for transport %s: error decoding size from header",
3359 pid, addr->transport->driver_name);
3366 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3367 (u_long)required, pid);
3369 /* Same as above, the transport process will write the bytes announced
3370 in a timely manner, so we can just wait for the bytes, getting less than expected
3371 is considered a problem of the subprocess, we do not expect anything else from it. */
3372 if ((got = readn(fd, big_buffer, required)) != required)
3374 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3375 " bytes (pipedata) from transport process %d for transport %s",
3376 got, required, pid, addr->transport->driver_name);
3381 /* Handle each possible type of item, assuming the complete item is
3382 available in store. */
3386 /* Host items exist only if any hosts were marked unusable. Match
3387 up by checking the IP address. */
3390 for (h = addrlist->host_list; h; h = h->next)
3392 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3400 /* Retry items are sent in a preceding R item for each address. This is
3401 kept separate to keep each message short enough to guarantee it won't
3402 be split in the pipe. Hopefully, in the majority of cases, there won't in
3403 fact be any retry items at all.
3405 The complete set of retry items might include an item to delete a
3406 routing retry if there was a previous routing delay. However, routing
3407 retries are also used when a remote transport identifies an address error.
3408 In that case, there may also be an "add" item for the same key. Arrange
3409 that a "delete" item is dropped in favour of an "add" item. */
3412 if (!addr) goto ADDR_MISMATCH;
3414 DEBUG(D_deliver|D_retry)
3415 debug_printf("reading retry information for %s from subprocess\n",
3418 /* Cut out any "delete" items on the list. */
3420 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3421 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3423 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3424 *rp = r->next; /* Excise a delete item */
3425 DEBUG(D_deliver|D_retry)
3426 debug_printf(" existing delete item dropped\n");
3429 /* We want to add a delete item only if there is no non-delete item;
3430 however we still have to step ptr through the data. */
3432 if (!r || !(*ptr & rf_delete))
3434 r = store_get(sizeof(retry_item), FALSE);
3435 r->next = addr->retries;
3438 r->key = string_copy(ptr);
3440 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3441 ptr += sizeof(r->basic_errno);
3442 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3443 ptr += sizeof(r->more_errno);
3444 r->message = *ptr ? string_copy(ptr) : NULL;
3445 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3446 r->flags & rf_delete ? "delete" : "retry");
3451 DEBUG(D_deliver|D_retry)
3452 debug_printf(" delete item not added: non-delete item exists\n");
3455 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3461 /* Put the amount of data written into the parlist block */
3464 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3465 ptr += sizeof(transport_count);
3468 /* Address items are in the order of items on the address chain. We
3469 remember the current address value in case this function is called
3470 several times to empty the pipe in stages. Information about delivery
3471 over TLS is sent in a preceding X item for each address. We don't put
3472 it in with the other info, in order to keep each message short enough to
3473 guarantee it won't be split in the pipe. */
3477 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3481 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3485 addr->cipher = string_copy(ptr);
3486 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3490 addr->peerdn = string_copy(ptr);
3495 (void) tls_import_cert(ptr, &addr->peercert);
3497 addr->peercert = NULL;
3502 (void) tls_import_cert(ptr, &addr->ourcert);
3504 addr->ourcert = NULL;
3507 # ifndef DISABLE_OCSP
3509 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3515 #endif /*DISABLE_TLS*/
3517 case 'C': /* client authenticator information */
3520 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3521 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3522 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3527 #ifndef DISABLE_PRDR
3529 setflag(addr, af_prdr_used);
3536 #ifndef DISABLE_PIPE_CONNECT
3537 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3539 case 1: setflag(addr, af_pipelining); break;
3544 setflag(addr, af_chunking_used);
3548 setflag(addr, af_tcp_fastopen_conn);
3549 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3550 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3554 if (!addr) goto ADDR_MISMATCH;
3555 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3556 ptr += sizeof(addr->dsn_aware);
3557 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3564 msg = string_sprintf("address count mismatch for data read from pipe "
3565 "for transport process %d for transport %s", pid,
3566 addrlist->transport->driver_name);
3573 #ifdef SUPPORT_SOCKS
3574 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3575 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3580 proxy_local_address = string_copy(ptr);
3582 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3583 ptr += sizeof(proxy_local_port);
3588 #ifdef EXPERIMENTAL_DSN_INFO
3589 case '1': /* must arrive before A0, and applies to that addr */
3590 /* Two strings: smtp_greeting and helo_response */
3591 addr->smtp_greeting = string_copy(ptr);
3593 addr->helo_response = string_copy(ptr);
3599 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3600 addr->transport_return = *ptr++;
3601 addr->special_action = *ptr++;
3602 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3603 ptr += sizeof(addr->basic_errno);
3604 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3605 ptr += sizeof(addr->more_errno);
3606 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3607 ptr += sizeof(addr->delivery_time);
3608 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3609 ptr += sizeof(addr->flags);
3610 addr->message = *ptr ? string_copy(ptr) : NULL;
3612 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3615 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3619 h = store_get(sizeof(host_item), FALSE);
3620 h->name = string_copy(ptr);
3622 h->address = string_copy(ptr);
3624 memcpy(&h->port, ptr, sizeof(h->port));
3625 ptr += sizeof(h->port);
3626 h->dnssec = *ptr == '2' ? DS_YES
3627 : *ptr == '1' ? DS_NO
3630 addr->host_used = h;
3634 /* Finished with this address */
3641 /* Local interface address/port */
3643 if (*ptr) sending_ip_address = string_copy(ptr);
3645 if (*ptr) sending_port = atoi(CS ptr);
3649 /* Z marks the logical end of the data. It is followed by '0' if
3650 continue_transport was NULL at the end of transporting, otherwise '1'.
3651 We need to know when it becomes NULL during a delivery down a passed SMTP
3652 channel so that we don't try to pass anything more down it. Of course, for
3653 most normal messages it will remain NULL all the time. */
3658 continue_transport = NULL;
3659 continue_hostname = NULL;
3662 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3665 /* Anything else is a disaster. */
3668 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3669 "process %d for transport %s", ptr[-1], pid,
3670 addr->transport->driver_name);
3676 /* The done flag is inspected externally, to determine whether or not to
3677 call the function again when the process finishes. */
3681 /* If the process hadn't finished, and we haven't seen the end of the data
3682 or if we suffered a disaster, update the rest of the state, and return FALSE to
3683 indicate "not finished". */
3692 /* Close our end of the pipe, to prevent deadlock if the far end is still
3693 pushing stuff into it. */
3698 /* If we have finished without error, but haven't had data for every address,
3699 something is wrong. */
3702 msg = string_sprintf("insufficient address data read from pipe "
3703 "for transport process %d for transport %s", pid,
3704 addr->transport->driver_name);
3706 /* If an error message is set, something has gone wrong in getting back
3707 the delivery data. Put the message into each address and freeze it. */
3710 for (addr = addrlist; addr; addr = addr->next)
3712 addr->transport_return = DEFER;
3713 addr->special_action = SPECIAL_FREEZE;
3714 addr->message = msg;
3715 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3718 /* Return TRUE to indicate we have got all we need from this process, even
3719 if it hasn't actually finished yet. */
3726 /*************************************************
3727 * Post-process a set of remote addresses *
3728 *************************************************/
3730 /* Do what has to be done immediately after a remote delivery for each set of
3731 addresses, then re-write the spool if necessary. Note that post_process_one
3732 puts the address on an appropriate queue; hence we must fish off the next
3733 one first. This function is also called if there is a problem with setting
3734 up a subprocess to do a remote delivery in parallel. In this case, the final
3735 argument contains a message, and the action must be forced to DEFER.
3738 addr pointer to chain of address items
3739 logflags flags for logging
3740 msg NULL for normal cases; -> error message for unexpected problems
3741 fallback TRUE if processing fallback hosts
3747 remote_post_process(address_item *addr, int logflags, uschar *msg,
3750 /* If any host addresses were found to be unusable, add them to the unusable
3751 tree so that subsequent deliveries don't try them. */
3753 for (host_item * h = addr->host_list; h; h = h->next)
3755 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3757 /* Now handle each address on the chain. The transport has placed '=' or '-'
3758 into the special_action field for each successful delivery. */
3762 address_item *next = addr->next;
3764 /* If msg == NULL (normal processing) and the result is DEFER and we are
3765 processing the main hosts and there are fallback hosts available, put the
3766 address on the list for fallback delivery. */
3768 if ( addr->transport_return == DEFER
3769 && addr->fallback_hosts
3774 addr->host_list = addr->fallback_hosts;
3775 addr->next = addr_fallback;
3776 addr_fallback = addr;
3777 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3780 /* If msg is set (=> unexpected problem), set it in the address before
3781 doing the ordinary post processing. */
3787 addr->message = msg;
3788 addr->transport_return = DEFER;
3790 (void)post_process_one(addr, addr->transport_return, logflags,
3791 EXIM_DTYPE_TRANSPORT, addr->special_action);
3799 /* If we have just delivered down a passed SMTP channel, and that was
3800 the last address, the channel will have been closed down. Now that
3801 we have logged that delivery, set continue_sequence to 1 so that
3802 any subsequent deliveries don't get "*" incorrectly logged. */
3804 if (!continue_transport) continue_sequence = 1;
3809 /*************************************************
3810 * Wait for one remote delivery subprocess *
3811 *************************************************/
3813 /* This function is called while doing remote deliveries when either the
3814 maximum number of processes exist and we need one to complete so that another
3815 can be created, or when waiting for the last ones to complete. It must wait for
3816 the completion of one subprocess, empty the control block slot, and return a
3817 pointer to the address chain.
3820 Returns: pointer to the chain of addresses handled by the process;
3821 NULL if no subprocess found - this is an unexpected error
3824 static address_item *
3827 int poffset, status;
3828 address_item *addr, *addrlist;
3831 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3832 "to finish", message_id);
3834 /* Loop until either a subprocess completes, or there are no subprocesses in
3835 existence - in which case give an error return. We cannot proceed just by
3836 waiting for a completion, because a subprocess may have filled up its pipe, and
3837 be waiting for it to be emptied. Therefore, if no processes have finished, we
3838 wait for one of the pipes to acquire some data by calling select(), with a
3839 timeout just in case.
3841 The simple approach is just to iterate after reading data from a ready pipe.
3842 This leads to non-ideal behaviour when the subprocess has written its final Z
3843 item, closed the pipe, and is in the process of exiting (the common case). A
3844 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3845 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3848 To avoid this, if all the data that is needed has been read from a subprocess
3849 after select(), an explicit wait() for it is done. We know that all it is doing
3850 is writing to the pipe and then exiting, so the wait should not be long.
3852 The non-blocking waitpid() is to some extent just insurance; if we could
3853 reliably detect end-of-file on the pipe, we could always know when to do a
3854 blocking wait() for a completed process. However, because some systems use
3855 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3856 use code that functions without the need to recognize EOF.
3858 There's a double loop here just in case we end up with a process that is not in
3859 the list of remote delivery processes. Something has obviously gone wrong if
3860 this is the case. (For example, a process that is incorrectly left over from
3861 routing or local deliveries might be found.) The damage can be minimized by
3862 looping back and looking for another process. If there aren't any, the error
3863 return will happen. */
3865 for (;;) /* Normally we do not repeat this loop */
3867 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3870 fd_set select_pipes;
3871 int maxpipe, readycount;
3873 /* A return value of -1 can mean several things. If errno != ECHILD, it
3874 either means invalid options (which we discount), or that this process was
3875 interrupted by a signal. Just loop to try the waitpid() again.
3877 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3878 in existence. This should never happen, and is an unexpected error.
3879 However, there is a nasty complication when running under Linux. If "strace
3880 -f" is being used under Linux to trace this process and its children,
3881 subprocesses are "stolen" from their parents and become the children of the
3882 tracing process. A general wait such as the one we've just obeyed returns
3883 as if there are no children while subprocesses are running. Once a
3884 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3885 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3888 This does not happen using "truss" on Solaris, nor (I think) with other
3889 tracing facilities on other OS. It seems to be specific to Linux.
3891 What we do to get round this is to use kill() to see if any of our
3892 subprocesses are still in existence. If kill() gives an OK return, we know
3893 it must be for one of our processes - it can't be for a re-use of the pid,
3894 because if our process had finished, waitpid() would have found it. If any
3895 of our subprocesses are in existence, we proceed to use select() as if
3896 waitpid() had returned zero. I think this is safe. */
3900 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3903 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3904 "for process existence\n");
3906 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3908 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3910 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3911 "stolen by strace\n", (int)pid);
3912 break; /* With poffset set */
3916 if (poffset >= remote_max_parallel)
3918 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3919 return NULL; /* This is the error return */
3923 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3924 been handled above. A return value of zero means that there is at least one
3925 subprocess, but there are no completed subprocesses. See if any pipes are
3926 ready with any data for reading. */
3928 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3931 FD_ZERO(&select_pipes);
3932 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3933 if (parlist[poffset].pid != 0)
3935 int fd = parlist[poffset].fd;
3936 FD_SET(fd, &select_pipes);
3937 if (fd > maxpipe) maxpipe = fd;
3940 /* Stick in a 60-second timeout, just in case. */
3945 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3948 /* Scan through the pipes and read any that are ready; use the count
3949 returned by select() to stop when there are no more. Select() can return
3950 with no processes (e.g. if interrupted). This shouldn't matter.
3952 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3953 read, or there was a disaster. In either case, we are finished with this
3954 process. Do an explicit wait() for the process and break the main loop if
3957 It turns out that we have to deal with the case of an interrupted system
3958 call, which can happen on some operating systems if the signal handling is
3959 set up to do that by default. */
3962 readycount > 0 && poffset < remote_max_parallel;
3965 if ( (pid = parlist[poffset].pid) != 0
3966 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3970 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3971 for (;;) /* Loop for signals */
3973 pid_t endedpid = waitpid(pid, &status, 0);
3974 if (endedpid == pid) goto PROCESS_DONE;
3975 if (endedpid != (pid_t)(-1) || errno != EINTR)
3976 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3977 "%d (errno = %d) from waitpid() for process %d",
3978 (int)endedpid, errno, (int)pid);
3983 /* Now go back and look for a completed subprocess again. */
3986 /* A completed process was detected by the non-blocking waitpid(). Find the
3987 data block that corresponds to this subprocess. */
3989 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3990 if (pid == parlist[poffset].pid) break;
3992 /* Found the data block; this is a known remote delivery process. We don't
3993 need to repeat the outer loop. This should be what normally happens. */
3995 if (poffset < remote_max_parallel) break;
3997 /* This situation is an error, but it's probably better to carry on looking
3998 for another process than to give up (as we used to do). */
4000 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4001 "transport process list", pid);
4002 } /* End of the "for" loop */
4004 /* Come here when all the data was completely read after a select(), and
4005 the process in pid has been wait()ed for. */
4012 debug_printf("remote delivery process %d ended\n", (int)pid);
4014 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4018 set_process_info("delivering %s", message_id);
4020 /* Get the chain of processed addresses */
4022 addrlist = parlist[poffset].addrlist;
4024 /* If the process did not finish cleanly, record an error and freeze (except
4025 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4026 in case the delivery did actually happen. */
4028 if ((status & 0xffff) != 0)
4031 int msb = (status >> 8) & 255;
4032 int lsb = status & 255;
4033 int code = (msb == 0)? (lsb & 0x7f) : msb;
4035 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4037 addrlist->transport->driver_name,
4039 (msb == 0)? "terminated by signal" : "exit code",
4042 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4043 addrlist->special_action = SPECIAL_FREEZE;
4045 for (addr = addrlist; addr; addr = addr->next)
4047 addr->transport_return = DEFER;
4048 addr->message = msg;
4051 remove_journal = FALSE;
4054 /* Else complete reading the pipe to get the result of the delivery, if all
4055 the data has not yet been obtained. */
4057 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4059 /* Put the data count and return path into globals, mark the data slot unused,
4060 decrement the count of subprocesses, and return the address chain. */
4062 transport_count = parlist[poffset].transport_count;
4063 used_return_path = parlist[poffset].return_path;
4064 parlist[poffset].pid = 0;
4071 /*************************************************
4072 * Wait for subprocesses and post-process *
4073 *************************************************/
4075 /* This function waits for subprocesses until the number that are still running
4076 is below a given threshold. For each complete subprocess, the addresses are
4077 post-processed. If we can't find a running process, there is some shambles.
4078 Better not bomb out, as that might lead to multiple copies of the message. Just
4079 log and proceed as if all done.
4082 max maximum number of subprocesses to leave running
4083 fallback TRUE if processing fallback hosts
4089 par_reduce(int max, BOOL fallback)
4091 while (parcount > max)
4093 address_item *doneaddr = par_wait();
4096 log_write(0, LOG_MAIN|LOG_PANIC,
4097 "remote delivery process count got out of step");
4102 transport_instance * tp = doneaddr->transport;
4103 if (tp->max_parallel)
4104 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4106 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4112 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4114 uschar pipe_header[PIPE_HEADER_SIZE+1];
4115 size_t total_len = PIPE_HEADER_SIZE + size;
4117 struct iovec iov[2] = {
4118 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4119 { buf, size } /* *the* data */
4124 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4125 /* complain to log if someone tries with buffer sizes we can't handle*/
4127 if (size > BIG_BUFFER_SIZE-1)
4129 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4130 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4132 size = BIG_BUFFER_SIZE;
4135 /* Should we check that we do not write more than PIPE_BUF? What would
4138 /* convert size to human readable string prepended by id and subid */
4139 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4140 id, subid, (long)size))
4141 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4143 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4144 id, subid, (long)size, pipe_header);
4146 if ((ret = writev(fd, iov, 2)) != total_len)
4147 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4148 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4149 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4152 /*************************************************
4153 * Do remote deliveries *
4154 *************************************************/
4156 /* This function is called to process the addresses in addr_remote. We must
4157 pick off the queue all addresses that have the same transport, remote
4158 destination, and errors address, and hand them to the transport in one go,
4159 subject to some configured limitations. If this is a run to continue delivering
4160 to an existing delivery channel, skip all but those addresses that can go to
4161 that channel. The skipped addresses just get deferred.
4163 If mua_wrapper is set, all addresses must be able to be sent in a single
4164 transaction. If not, this function yields FALSE.
4166 In Exim 4, remote deliveries are always done in separate processes, even
4167 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4168 is so that the base process can retain privilege. This makes the
4169 implementation of fallback transports feasible (though not initially done.)
4171 We create up to the configured number of subprocesses, each of which passes
4172 back the delivery state via a pipe. (However, when sending down an existing
4173 connection, remote_max_parallel is forced to 1.)
4176 fallback TRUE if processing fallback hosts
4178 Returns: TRUE normally
4179 FALSE if mua_wrapper is set and the addresses cannot all be sent
4184 do_remote_deliveries(BOOL fallback)
4189 parcount = 0; /* Number of executing subprocesses */
4191 /* When sending down an existing channel, only do one delivery at a time.
4192 We use a local variable (parmax) to hold the maximum number of processes;
4193 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4195 if (continue_transport) remote_max_parallel = 1;
4196 parmax = remote_max_parallel;
4198 /* If the data for keeping a list of processes hasn't yet been
4203 parlist = store_get(remote_max_parallel * sizeof(pardata), FALSE);
4204 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4205 parlist[poffset].pid = 0;
4208 /* Now loop for each remote delivery */
4210 for (int delivery_count = 0; addr_remote; delivery_count++)
4216 int address_count = 1;
4217 int address_count_max;
4219 BOOL use_initgroups;
4220 BOOL pipe_done = FALSE;
4221 transport_instance *tp;
4222 address_item **anchor = &addr_remote;
4223 address_item *addr = addr_remote;
4224 address_item *last = addr;
4227 uschar * serialize_key = NULL;
4229 /* Pull the first address right off the list. */
4231 addr_remote = addr->next;
4234 DEBUG(D_deliver|D_transport)
4235 debug_printf("--------> %s <--------\n", addr->address);
4237 /* If no transport has been set, there has been a big screw-up somewhere. */
4239 if (!(tp = addr->transport))
4241 f.disable_logging = FALSE; /* Jic */
4242 panicmsg = US"No transport set by router";
4243 goto panic_continue;
4246 /* Check that this base address hasn't previously been delivered to this
4247 transport. The check is necessary at this point to handle homonymic addresses
4248 correctly in cases where the pattern of redirection changes between delivery
4249 attempts. Non-homonymic previous delivery is detected earlier, at routing
4252 if (previously_transported(addr, FALSE)) continue;
4254 /* Force failure if the message is too big. */
4256 if (tp->message_size_limit)
4258 int rc = check_message_size(tp, addr);
4261 addr->transport_return = rc;
4262 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4267 /*XXX need to defeat this when DANE is used - but we don't know that yet.
4268 So look out for the place it gets used.
4271 /* Get the flag which specifies whether the transport can handle different
4272 domains that nevertheless resolve to the same set of hosts. If it needs
4273 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4274 $host, $host_address, $host_port. */
4275 if (tp->expand_multi_domain)
4276 deliver_set_expansions(addr);
4278 if (exp_bool(addr, US"transport", tp->name, D_transport,
4279 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4280 &multi_domain) != OK)
4282 deliver_set_expansions(NULL);
4283 panicmsg = addr->message;
4284 goto panic_continue;
4287 /* Get the maximum it can handle in one envelope, with zero meaning
4288 unlimited, which is forced for the MUA wrapper case. */
4290 address_count_max = tp->max_addresses;
4291 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4294 /************************************************************************/
4295 /***** This is slightly experimental code, but should be safe. *****/
4297 /* The address_count_max value is the maximum number of addresses that the
4298 transport can send in one envelope. However, the transport must be capable of
4299 dealing with any number of addresses. If the number it gets exceeds its
4300 envelope limitation, it must send multiple copies of the message. This can be
4301 done over a single connection for SMTP, so uses less resources than making
4302 multiple connections. On the other hand, if remote_max_parallel is greater
4303 than one, it is perhaps a good idea to use parallel processing to move the
4304 message faster, even if that results in multiple simultaneous connections to
4307 How can we come to some compromise between these two ideals? What we do is to
4308 limit the number of addresses passed to a single instance of a transport to
4309 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4310 number of addresses routed to remote transports divided by
4311 remote_max_parallel. For example, if the message has 100 remote recipients,
4312 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4313 once. But if rcpt_max is 100, we could send up to 100.
4315 Of course, not all the remotely addresses in a message are going to go to the
4316 same set of hosts (except in smarthost configurations), so this is just a
4317 heuristic way of dividing up the work.
4319 Furthermore (1), because this may not be wanted in some cases, and also to
4320 cope with really pathological cases, there is also a limit to the number of
4321 messages that are sent over one connection. This is the same limit that is
4322 used when sending several different messages over the same connection.
4323 Continue_sequence is set when in this situation, to the number sent so
4324 far, including this message.
4326 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4327 is probably because they are using VERP, in which case they want to pass only
4328 one address at a time to the transport, in order to be able to use
4329 $local_part and $domain in constructing a new return path. We could test for
4330 the use of these variables, but as it is so likely they will be used when the
4331 maximum is 1, we don't bother. Just leave the value alone. */
4333 if ( address_count_max != 1
4334 && address_count_max < remote_delivery_count/remote_max_parallel
4337 int new_max = remote_delivery_count/remote_max_parallel;
4338 int message_max = tp->connection_max_messages;
4339 if (connection_max_messages >= 0) message_max = connection_max_messages;
4340 message_max -= continue_sequence - 1;
4341 if (message_max > 0 && new_max > address_count_max * message_max)
4342 new_max = address_count_max * message_max;
4343 address_count_max = new_max;
4346 /************************************************************************/
4349 /*XXX don't know yet if DANE will be used. So tpt will have to
4350 check at the point if gets next addr from list, and skip/defer any
4354 /* Pick off all addresses which have the same transport, errors address,
4355 destination, and extra headers. In some cases they point to the same host
4356 list, but we also need to check for identical host lists generated from
4357 entirely different domains. The host list pointers can be NULL in the case
4358 where the hosts are defined in the transport. There is also a configured
4359 maximum limit of addresses that can be handled at once (see comments above
4360 for how it is computed).
4361 If the transport does not handle multiple domains, enforce that also,
4362 and if it might need a per-address check for this, re-evaluate it.
4365 while ((next = *anchor) && address_count < address_count_max)
4368 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4369 && tp == next->transport
4370 && same_hosts(next->host_list, addr->host_list)
4371 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4372 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4373 && same_ugid(tp, next, addr)
4374 && ( next->prop.remove_headers == addr->prop.remove_headers
4375 || ( next->prop.remove_headers
4376 && addr->prop.remove_headers
4377 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4381 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4383 US"transport", next->transport->name, D_transport,
4384 US"multi_domain", next->transport->multi_domain,
4385 next->transport->expand_multi_domain, &md) == OK
4390 *anchor = next->next;
4392 next->first = addr; /* remember top one (for retry processing) */
4397 else anchor = &(next->next);
4398 deliver_set_expansions(NULL);
4401 /* If we are acting as an MUA wrapper, all addresses must go in a single
4402 transaction. If not, put them back on the chain and yield FALSE. */
4404 if (mua_wrapper && addr_remote)
4406 last->next = addr_remote;
4411 /* If the transport is limited for parallellism, enforce that here.
4412 The hints DB entry is decremented in par_reduce(), when we reap the
4413 transport process. */
4415 if (tpt_parallel_check(tp, addr, &serialize_key))
4416 if ((panicmsg = expand_string_message))
4417 goto panic_continue;
4419 continue; /* Loop for the next set of addresses. */
4421 /* Set up the expansion variables for this set of addresses */
4423 deliver_set_expansions(addr);
4425 /* Ensure any transport-set auth info is fresh */
4426 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4428 /* Compute the return path, expanding a new one if required. The old one
4429 must be set first, as it might be referred to in the expansion. */
4431 if(addr->prop.errors_address)
4432 return_path = addr->prop.errors_address;
4433 #ifdef EXPERIMENTAL_SRS_ALT
4434 else if(addr->prop.srs_sender)
4435 return_path = addr->prop.srs_sender;
4438 return_path = sender_address;
4440 if (tp->return_path)
4442 uschar *new_return_path = expand_string(tp->return_path);
4443 if (new_return_path)
4444 return_path = new_return_path;
4445 else if (!f.expand_string_forcedfail)
4447 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4448 tp->return_path, expand_string_message);
4453 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4454 logs and sets up error messages, so we just post-process and continue with
4455 the next address. */
4457 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4463 /* If this transport has a setup function, call it now so that it gets
4464 run in this process and not in any subprocess. That way, the results of
4465 any setup that are retained by the transport can be reusable. One of the
4466 things the setup does is to set the fallback host lists in the addresses.
4467 That is why it is called at this point, before the continue delivery
4468 processing, because that might use the fallback hosts. */
4471 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4473 /* If we have a connection still open from a verify stage (lazy-close)
4474 treat it as if it is a continued connection (apart from the counter used
4475 for the log line mark). */
4477 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4480 debug_printf("lazy-callout-close: have conn still open from verification\n");
4481 continue_transport = cutthrough.transport;
4482 continue_hostname = string_copy(cutthrough.host.name);
4483 continue_host_address = string_copy(cutthrough.host.address);
4484 continue_sequence = 1;
4485 sending_ip_address = cutthrough.snd_ip;
4486 sending_port = cutthrough.snd_port;
4487 smtp_peer_options = cutthrough.peer_options;
4490 /* If this is a run to continue delivery down an already-established
4491 channel, check that this set of addresses matches the transport and
4492 the channel. If it does not, defer the addresses. If a host list exists,
4493 we must check that the continue host is on the list. Otherwise, the
4494 host is set in the transport. */
4496 f.continue_more = FALSE; /* In case got set for the last lot */
4497 if (continue_transport)
4499 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4500 /*XXX do we need to check for a DANEd conn vs. a change of domain? */
4502 /* If the transport is about to override the host list do not check
4503 it here but take the cost of running the transport process to discover
4504 if the continued_hostname connection is suitable. This is a layering
4505 violation which is unfortunate as it requires we haul in the smtp
4510 smtp_transport_options_block * ob;
4512 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4513 && (ob = (smtp_transport_options_block *)tp->options_block)
4514 && ob->hosts_override && ob->hosts
4520 for (host_item * h = addr->host_list; h; h = h->next)
4521 if (Ustrcmp(h->name, continue_hostname) == 0)
4522 /*XXX should also check port here */
4523 { ok = TRUE; break; }
4527 /* Addresses not suitable; defer or queue for fallback hosts (which
4528 might be the continue host) and skip to next address. */
4532 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4533 Ustrcmp(continue_transport, tp->name) != 0
4534 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4535 : string_sprintf("no host matching %s", continue_hostname));
4536 if (serialize_key) enq_end(serialize_key);
4538 if (addr->fallback_hosts && !fallback)
4540 for (next = addr; ; next = next->next)
4542 next->host_list = next->fallback_hosts;
4543 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4544 if (!next->next) break;
4546 next->next = addr_fallback;
4547 addr_fallback = addr;
4552 for (next = addr; ; next = next->next)
4554 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4555 if (!next->next) break;
4557 next->next = addr_defer;
4564 /* Set a flag indicating whether there are further addresses that list
4565 the continued host. This tells the transport to leave the channel open,
4566 but not to pass it to another delivery process. We'd like to do that
4567 for non-continue_transport cases too but the knowlege of which host is
4568 connected to is too hard to manage. Perhaps we need a finer-grain
4569 interface to the transport. */
4571 for (next = addr_remote; next && !f.continue_more; next = next->next)
4572 for (host_item * h = next->host_list; h; h = h->next)
4573 if (Ustrcmp(h->name, continue_hostname) == 0)
4574 { f.continue_more = TRUE; break; }
4577 /* The transports set up the process info themselves as they may connect
4578 to more than one remote machine. They also have to set up the filter
4579 arguments, if required, so that the host name and address are available
4582 transport_filter_argv = NULL;
4584 /* Create the pipe for inter-process communication. If pipe creation
4585 fails, it is probably because the value of remote_max_parallel is so
4586 large that too many file descriptors for pipes have been created. Arrange
4587 to wait for a process to finish, and then try again. If we still can't
4588 create a pipe when all processes have finished, break the retry loop. */
4592 if (pipe(pfd) == 0) pipe_done = TRUE;
4593 else if (parcount > 0) parmax = parcount;
4596 /* We need to make the reading end of the pipe non-blocking. There are
4597 two different options for this. Exim is cunningly (I hope!) coded so
4598 that it can use either of them, though it prefers O_NONBLOCK, which
4599 distinguishes between EOF and no-more-data. */
4601 /* The data appears in a timely manner and we already did a select on
4602 all pipes, so I do not see a reason to use non-blocking IO here
4605 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4607 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4611 /* If the maximum number of subprocesses already exist, wait for a process
4612 to finish. If we ran out of file descriptors, parmax will have been reduced
4613 from its initial value of remote_max_parallel. */
4615 par_reduce(parmax - 1, fallback);
4618 /* If we failed to create a pipe and there were no processes to wait
4619 for, we have to give up on this one. Do this outside the above loop
4620 so that we can continue the main loop. */
4624 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4628 /* Find a free slot in the pardata list. Must do this after the possible
4629 waiting for processes to finish, because a terminating process will free
4632 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4633 if (parlist[poffset].pid == 0)
4636 /* If there isn't one, there has been a horrible disaster. */
4638 if (poffset >= remote_max_parallel)
4640 (void)close(pfd[pipe_write]);
4641 (void)close(pfd[pipe_read]);
4642 panicmsg = US"Unexpectedly no free subprocess slot";
4646 /* Now fork a subprocess to do the remote delivery, but before doing so,
4647 ensure that any cached resources are released so as not to interfere with
4648 what happens in the subprocess. */
4652 if ((pid = exim_fork(US"transport")) == 0)
4654 int fd = pfd[pipe_write];
4657 /* Setting this global in the subprocess means we need never clear it */
4658 transport_name = tp->name;
4660 /* There are weird circumstances in which logging is disabled */
4661 f.disable_logging = tp->disable_logging;
4663 /* Show pids on debug output if parallelism possible */
4665 if (parmax > 1 && (parcount > 0 || addr_remote))
4666 DEBUG(D_any|D_v) debug_selector |= D_pid;
4668 /* Reset the random number generator, so different processes don't all
4669 have the same sequence. In the test harness we want different, but
4670 predictable settings for each delivery process, so do something explicit
4671 here rather they rely on the fixed reset in the random number function. */
4673 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4675 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4676 a new process that may be forked to do another delivery down the same
4679 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4681 /* Close open file descriptors for the pipes of other processes
4682 that are running in parallel. */
4684 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4685 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4687 /* This process has inherited a copy of the file descriptor
4688 for the data file, but its file pointer is shared with all the
4689 other processes running in parallel. Therefore, we have to re-open
4690 the file in order to get a new file descriptor with its own
4691 file pointer. We don't need to lock it, as the lock is held by
4692 the parent process. There doesn't seem to be any way of doing
4693 a dup-with-new-file-pointer. */
4695 (void)close(deliver_datafile);
4697 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4699 if ((deliver_datafile = Uopen(fname,
4703 O_RDWR | O_APPEND, 0)) < 0)
4704 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4705 "parallel delivery: %s", fname, strerror(errno));
4708 /* Set the close-on-exec flag */
4710 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4714 /* Set the uid/gid of this process; bombs out on failure. */
4716 exim_setugid(uid, gid, use_initgroups,
4717 string_sprintf("remote delivery to %s with transport=%s",
4718 addr->address, tp->name));
4720 /* Close the unwanted half of this process' pipe, set the process state,
4721 and run the transport. Afterwards, transport_count will contain the number
4722 of bytes written. */
4724 (void)close(pfd[pipe_read]);
4725 set_process_info("delivering %s using %s", message_id, tp->name);
4726 debug_print_string(tp->debug_string);
4727 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4729 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4730 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4732 /* Ensure any cached resources that we used are now released */
4736 /* Pass the result back down the pipe. This is a lot more information
4737 than is needed for a local delivery. We have to send back the error
4738 status for each address, the usability status for each host that is
4739 flagged as unusable, and all the retry items. When TLS is in use, we
4740 send also the cipher and peerdn information. Each type of information
4741 is flagged by an identifying byte, and is then in a fixed format (with
4742 strings terminated by zeros), and there is a final terminator at the
4743 end. The host information and retry information is all attached to
4744 the first address, so that gets sent at the start. */
4746 /* Host unusability information: for most success cases this will
4749 for (h = addr->host_list; h; h = h->next)
4751 if (!h->address || h->status < hstatus_unusable) continue;
4752 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4753 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4756 /* The number of bytes written. This is the same for each address. Even
4757 if we sent several copies of the message down the same connection, the
4758 size of each one is the same, and it's that value we have got because
4759 transport_count gets reset before calling transport_write_message(). */
4761 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4762 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4764 /* Information about what happened to each address. Four item types are
4765 used: an optional 'X' item first, for TLS information, then an optional "C"
4766 item for any client-auth info followed by 'R' items for any retry settings,
4767 and finally an 'A' item for the remaining data. */
4769 for(; addr; addr = addr->next)
4773 /* The certificate verification status goes into the flags */
4774 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4776 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4778 # ifndef DISABLE_TLS_RESUME
4779 if (tls_out.resumption & RESUME_USED) setflag(addr, af_tls_resume);
4782 /* Use an X item only if there's something to send */
4786 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4790 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4792 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4794 else if (continue_proxy_cipher)
4796 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4798 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4804 if (tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4808 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4813 if (tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4817 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4819 # ifndef DISABLE_OCSP
4820 if (addr->ocsp > OCSP_NOT_REQ)
4822 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4823 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4826 #endif /*DISABLE_TLS*/
4828 if (client_authenticator)
4830 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4831 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4833 if (client_authenticated_id)
4835 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4836 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4838 if (client_authenticated_sender)
4840 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4841 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4844 #ifndef DISABLE_PRDR
4845 if (testflag(addr, af_prdr_used))
4846 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4849 if (testflag(addr, af_pipelining))
4850 #ifndef DISABLE_PIPE_CONNECT
4851 if (testflag(addr, af_early_pipe))
4852 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4855 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4857 if (testflag(addr, af_chunking_used))
4858 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4860 if (testflag(addr, af_tcp_fastopen_conn))
4861 rmt_dlv_checked_write(fd, 'T',
4862 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4866 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4867 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4869 /* Retry information: for most success cases this will be null. */
4871 for (retry_item * r = addr->retries; r; r = r->next)
4873 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4874 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4875 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4876 ptr += sizeof(r->basic_errno);
4877 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4878 ptr += sizeof(r->more_errno);
4879 if (!r->message) *ptr++ = 0; else
4881 sprintf(CS ptr, "%.512s", r->message);
4884 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4887 #ifdef SUPPORT_SOCKS
4888 if (LOGGING(proxy) && proxy_session)
4891 if (proxy_local_address)
4893 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4894 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4895 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4896 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4897 ptr += sizeof(proxy_local_port);
4901 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4905 #ifdef EXPERIMENTAL_DSN_INFO
4906 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4907 if (addr->smtp_greeting)
4909 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4910 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4911 if (addr->helo_response)
4913 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4914 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4918 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4922 /* The rest of the information goes in an 'A0' item. */
4924 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4925 ptr = big_buffer + 2;
4926 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4927 ptr += sizeof(addr->basic_errno);
4928 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4929 ptr += sizeof(addr->more_errno);
4930 memcpy(ptr, &addr->delivery_time, sizeof(addr->delivery_time));
4931 ptr += sizeof(addr->delivery_time);
4932 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4933 ptr += sizeof(addr->flags);
4935 if (!addr->message) *ptr++ = 0; else
4936 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4938 if (!addr->user_message) *ptr++ = 0; else
4939 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4941 if (!addr->host_used) *ptr++ = 0; else
4943 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4944 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4945 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4946 ptr += sizeof(addr->host_used->port);
4948 /* DNS lookup status */
4949 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4950 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4953 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4956 /* Local interface address/port */
4957 #ifdef EXPERIMENTAL_DSN_INFO
4958 if (sending_ip_address)
4960 if (LOGGING(incoming_interface) && sending_ip_address)
4964 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4965 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4966 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4969 /* Add termination flag, close the pipe, and that's it. The character
4970 after 'Z' indicates whether continue_transport is now NULL or not.
4971 A change from non-NULL to NULL indicates a problem with a continuing
4974 big_buffer[0] = continue_transport ? '1' : '0';
4975 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
4980 /* Back in the mainline: close the unwanted half of the pipe. */
4982 (void)close(pfd[pipe_write]);
4984 /* If we have a connection still open from a verify stage (lazy-close)
4985 release its TLS library context (if any) as responsibility was passed to
4986 the delivery child process. */
4988 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4991 if (cutthrough.is_tls)
4992 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
4994 (void) close(cutthrough.cctx.sock);
4995 release_cutthrough_connection(US"passed to transport proc");
4998 /* Fork failed; defer with error message */
5002 (void)close(pfd[pipe_read]);
5003 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5004 addr->domain, strerror(errno));
5008 /* Fork succeeded; increment the count, and remember relevant data for
5009 when the process finishes. */
5012 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5013 parlist[poffset].pid = pid;
5014 parlist[poffset].fd = pfd[pipe_read];
5015 parlist[poffset].done = FALSE;
5016 parlist[poffset].msg = NULL;
5017 parlist[poffset].return_path = return_path;
5019 /* If the process we've just started is sending a message down an existing
5020 channel, wait for it now. This ensures that only one such process runs at
5021 once, whatever the value of remote_max parallel. Otherwise, we might try to
5022 send two or more messages simultaneously down the same channel. This could
5023 happen if there are different domains that include the same host in otherwise
5024 different host lists.
5026 Also, if the transport closes down the channel, this information gets back
5027 (continue_transport gets set to NULL) before we consider any other addresses
5030 if (continue_transport) par_reduce(0, fallback);
5032 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5033 newly created process get going before we create another process. This should
5034 ensure repeatability in the tests. Wait long enough for most cases to complete
5037 else testharness_pause_ms(600);
5042 if (serialize_key) enq_end(serialize_key);
5044 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5048 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5049 are still running and post-process their addresses. */
5051 par_reduce(0, fallback);
5058 /*************************************************
5059 * Split an address into local part and domain *
5060 *************************************************/
5062 /* This function initializes an address for routing by splitting it up into a
5063 local part and a domain. The local part is set up twice - once in its original
5064 casing, and once in lower case, and it is dequoted. We also do the "percent
5065 hack" for configured domains. This may lead to a DEFER result if a lookup
5066 defers. When a percent-hacking takes place, we insert a copy of the original
5067 address as a new parent of this address, as if we have had a redirection.
5070 addr points to an addr_item block containing the address
5073 DEFER - could not determine if domain is %-hackable
5077 deliver_split_address(address_item * addr)
5079 uschar * address = addr->address;
5084 if (!(domain = Ustrrchr(address, '@')))
5085 return DEFER; /* should always have a domain, but just in case... */
5087 len = domain - address;
5088 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5090 /* The implication in the RFCs (though I can't say I've seen it spelled out
5091 explicitly) is that quoting should be removed from local parts at the point
5092 where they are locally interpreted. [The new draft "821" is more explicit on
5093 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5094 removing quoting backslashes and any unquoted doublequotes. */
5096 t = addr->cc_local_part = store_get(len+1, is_tainted(address));
5100 if (c == '\"') continue;
5110 /* We do the percent hack only for those domains that are listed in
5111 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5113 if (percent_hack_domains)
5116 uschar *new_address = NULL;
5117 uschar *local_part = addr->cc_local_part;
5119 deliver_domain = addr->domain; /* set $domain */
5121 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5122 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5124 && (t = Ustrrchr(local_part, '%')) != NULL
5127 new_address = string_copy(local_part);
5128 new_address[t - local_part] = '@';
5129 deliver_domain = string_copylc(t+1);
5130 local_part = string_copyn(local_part, t - local_part);
5133 if (rc == DEFER) return DEFER; /* lookup deferred */
5135 /* If hackery happened, set up new parent and alter the current address. */
5139 address_item *new_parent = store_get(sizeof(address_item), FALSE);
5140 *new_parent = *addr;
5141 addr->parent = new_parent;
5142 new_parent->child_count = 1;
5143 addr->address = new_address;
5144 addr->unique = string_copy(new_address);
5145 addr->domain = deliver_domain;
5146 addr->cc_local_part = local_part;
5147 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5152 /* Create the lowercased version of the final local part, and make that the
5153 default one to be used. */
5155 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5162 /*************************************************
5163 * Get next error message text *
5164 *************************************************/
5166 /* If f is not NULL, read the next "paragraph", from a customized error message
5167 text file, terminated by a line containing ****, and expand it.
5170 f NULL or a file to read from
5171 which string indicating which string (for errors)
5173 Returns: NULL or an expanded string
5177 next_emf(FILE *f, uschar *which)
5183 if (!f) return NULL;
5185 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5188 para = string_get(256);
5191 para = string_cat(para, buffer);
5192 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5195 if ((yield = expand_string(string_from_gstring(para))))
5198 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5199 "bounce_message_file or warn_message_file (%s): %s", which,
5200 expand_string_message);
5207 /*************************************************
5208 * Close down a passed transport channel *
5209 *************************************************/
5211 /* This function is called when a passed transport channel cannot be used.
5212 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5213 so that the function call can be the argument of a "return" statement.
5216 Returns: DELIVER_NOT_ATTEMPTED
5220 continue_closedown(void)
5222 if (continue_transport)
5223 for (transport_instance * t = transports; t; t = t->next)
5224 if (Ustrcmp(t->name, continue_transport) == 0)
5226 if (t->info->closedown) (t->info->closedown)(t);
5229 return DELIVER_NOT_ATTEMPTED;
5235 /*************************************************
5236 * Print address information *
5237 *************************************************/
5239 /* This function is called to output an address, or information about an
5240 address, for bounce or defer messages. If the hide_child flag is set, all we
5241 output is the original ancestor address.
5244 addr points to the address
5245 f the FILE to print to
5246 si an initial string
5247 sc a continuation string for before "generated"
5250 Returns: TRUE if the address is not hidden
5254 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5258 uschar *printed = US"";
5259 address_item *ancestor = addr;
5260 while (ancestor->parent) ancestor = ancestor->parent;
5262 fprintf(f, "%s", CS si);
5264 if (addr->parent && testflag(addr, af_hide_child))
5266 printed = US"an undisclosed address";
5269 else if (!testflag(addr, af_pfr) || !addr->parent)
5270 printed = addr->address;
5274 uschar *s = addr->address;
5277 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5278 else if (addr->address[0] == '|') ss = US"pipe";
5281 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5282 printed = addr->parent->address;
5285 fprintf(f, "%s", CS string_printing(printed));
5287 if (ancestor != addr)
5289 uschar *original = ancestor->onetime_parent;
5290 if (!original) original= ancestor->address;
5291 if (strcmpic(original, printed) != 0)
5292 fprintf(f, "%s(%sgenerated from %s)", sc,
5293 ancestor != addr->parent ? "ultimately " : "",
5294 string_printing(original));
5297 if (addr->host_used)
5298 fprintf(f, "\n host %s [%s]",
5299 addr->host_used->name, addr->host_used->address);
5301 fprintf(f, "%s", CS se);
5309 /*************************************************
5310 * Print error for an address *
5311 *************************************************/
5313 /* This function is called to print the error information out of an address for
5314 a bounce or a warning message. It tries to format the message reasonably by
5315 introducing newlines. All lines are indented by 4; the initial printing
5316 position must be set before calling.
5318 This function used always to print the error. Nowadays we want to restrict it
5319 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5320 and filter "fail". We no longer pass other information willy-nilly in bounce
5321 and warning messages. Text in user_message is always output; text in message
5322 only if the af_pass_message flag is set.
5326 f the FILE to print on
5333 print_address_error(address_item *addr, FILE *f, uschar *t)
5335 int count = Ustrlen(t);
5336 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5338 if (!s && !(s = addr->user_message))
5341 fprintf(f, "\n %s", t);
5344 if (*s == '\\' && s[1] == 'n')
5354 if (*s++ == ':' && isspace(*s) && count > 45)
5356 fprintf(f, "\n "); /* sic (because space follows) */
5363 /***********************************************************
5364 * Print Diagnostic-Code for an address *
5365 ************************************************************/
5367 /* This function is called to print the error information out of an address for
5368 a bounce or a warning message. It tries to format the message reasonably as
5369 required by RFC 3461 by adding a space after each newline
5371 it uses the same logic as print_address_error() above. if af_pass_message is true
5372 and addr->message is set it uses the remote host answer. if not addr->user_message
5373 is used instead if available.
5377 f the FILE to print on
5383 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5385 uschar * s = testflag(addr, af_pass_message) ? addr->message : NULL;
5388 /* af_pass_message and addr->message set ? print remote host answer */
5392 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5394 /* search first ": ". we assume to find the remote-MTA answer there */
5395 if (!(s = Ustrstr(addr->message, ": ")))
5396 return; /* not found, bail out */
5397 s += 2; /* skip ": " */
5398 cnt = fprintf(f, "Diagnostic-Code: smtp; ");
5400 /* no message available. do nothing */
5405 if (cnt > 950) /* RFC line length limit: 998 */
5407 DEBUG(D_deliver) debug_printf("print_dsn_diagnostic_code() truncated line\n");
5408 fputs("[truncated]", f);
5412 if (*s == '\\' && s[1] == 'n')
5414 fputs("\n ", f); /* as defined in RFC 3461 */
5429 /*************************************************
5430 * Check list of addresses for duplication *
5431 *************************************************/
5433 /* This function was introduced when the test for duplicate addresses that are
5434 not pipes, files, or autoreplies was moved from the middle of routing to when
5435 routing was complete. That was to fix obscure cases when the routing history
5436 affects the subsequent routing of identical addresses. This function is called
5437 after routing, to check that the final routed addresses are not duplicates.
5439 If we detect a duplicate, we remember what it is a duplicate of. Note that
5440 pipe, file, and autoreply de-duplication is handled during routing, so we must
5441 leave such "addresses" alone here, as otherwise they will incorrectly be
5444 Argument: address of list anchor
5449 do_duplicate_check(address_item **anchor)
5452 while ((addr = *anchor))
5455 if (testflag(addr, af_pfr))
5457 anchor = &(addr->next);
5459 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5461 DEBUG(D_deliver|D_route)
5462 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5463 *anchor = addr->next;
5464 addr->dupof = tnode->data.ptr;
5465 addr->next = addr_duplicate;
5466 addr_duplicate = addr;
5470 tree_add_duplicate(addr->unique, addr);
5471 anchor = &(addr->next);
5479 /************************************************/
5482 print_dsn_addr_action(FILE * f, address_item * addr,
5483 uschar * action, uschar * status)
5487 if (addr->dsn_orcpt)
5488 fprintf(f,"Original-Recipient: %s\n", addr->dsn_orcpt);
5490 for (pa = addr; pa->parent; ) pa = pa->parent;
5491 fprintf(f, "Action: %s\n"
5492 "Final-Recipient: rfc822;%s\n"
5494 action, pa->address, status);
5499 /* When running in the test harness, there's an option that allows us to
5500 fudge this time so as to get repeatability of the tests. Take the first
5501 time off the list. In queue runs, the list pointer gets updated in the
5505 test_harness_fudged_queue_time(int actual_time)
5508 if ( f.running_in_test_harness && *fudged_queue_times
5509 && (qt = readconf_readtime(fudged_queue_times, '/', FALSE)) >= 0)
5511 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
5512 fudged_queue_times);
5518 /************************************************/
5521 expand_open(const uschar * filename,
5522 const uschar * varname, const uschar * reason)
5524 const uschar * s = expand_cstring(filename);
5528 log_write(0, LOG_MAIN|LOG_PANIC,
5529 "Failed to expand %s: '%s'\n", varname, filename);
5530 else if (*s != '/' || is_tainted(s))
5531 log_write(0, LOG_MAIN|LOG_PANIC,
5532 "%s is not %s after expansion: '%s'\n",
5533 varname, *s == '/' ? "untainted" : "absolute", s);
5534 else if (!(fp = Ufopen(s, "rb")))
5535 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for %s "
5536 "message texts: %s", s, reason, strerror(errno));
5540 /*************************************************
5541 * Deliver one message *
5542 *************************************************/
5544 /* This is the function which is called when a message is to be delivered. It
5545 is passed the id of the message. It is possible that the message no longer
5546 exists, if some other process has delivered it, and it is also possible that
5547 the message is being worked on by another process, in which case the data file
5550 If no delivery is attempted for any of the above reasons, the function returns
5551 DELIVER_NOT_ATTEMPTED.
5553 If the give_up flag is set true, do not attempt any deliveries, but instead
5554 fail all outstanding addresses and return the message to the sender (or
5557 A delivery operation has a process all to itself; we never deliver more than
5558 one message in the same process. Therefore we needn't worry too much about
5561 Liable to be called as root.
5564 id the id of the message to be delivered
5565 forced TRUE if delivery was forced by an administrator; this overrides
5566 retry delays and causes a delivery to be tried regardless
5567 give_up TRUE if an administrator has requested that delivery attempts
5570 Returns: When the global variable mua_wrapper is FALSE:
5571 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5572 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5573 When the global variable mua_wrapper is TRUE:
5574 DELIVER_MUA_SUCCEEDED if delivery succeeded
5575 DELIVER_MUA_FAILED if delivery failed
5576 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5580 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5583 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5584 time_t now = time(NULL);
5585 address_item *addr_last = NULL;
5586 uschar *filter_message = NULL;
5587 int process_recipients = RECIP_ACCEPT;
5590 extern int acl_where;
5593 #ifdef MEASURE_TIMING
5594 report_time_since(×tamp_startup, US"delivery start"); /* testcase 0022, 2100 */
5597 info = queue_run_pid == (pid_t)0
5598 ? string_sprintf("delivering %s", id)
5599 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5601 /* If the D_process_info bit is on, set_process_info() will output debugging
5602 information. If not, we want to show this initial information if D_deliver or
5603 D_queue_run is set or in verbose mode. */
5605 set_process_info("%s", info);
5607 if ( !(debug_selector & D_process_info)
5608 && (debug_selector & (D_deliver|D_queue_run|D_v))
5610 debug_printf("%s\n", info);
5612 /* Ensure that we catch any subprocesses that are created. Although Exim
5613 sets SIG_DFL as its initial default, some routes through the code end up
5614 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5615 has been forked, but no re-exec has been done. We use sigaction rather than
5616 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5617 sure it is turned off. (There was a problem on AIX with this.) */
5621 struct sigaction act;
5622 act.sa_handler = SIG_DFL;
5623 sigemptyset(&(act.sa_mask));
5625 sigaction(SIGCHLD, &act, NULL);
5628 signal(SIGCHLD, SIG_DFL);
5631 /* Make the forcing flag available for routers and transports, set up the
5632 global message id field, and initialize the count for returned files and the
5633 message size. This use of strcpy() is OK because the length id is checked when
5634 it is obtained from a command line (the -M or -q options), and otherwise it is
5635 known to be a valid message id. */
5637 if (id != message_id)
5638 Ustrcpy(message_id, id);
5639 f.deliver_force = forced;
5643 /* Initialize some flags */
5645 update_spool = FALSE;
5646 remove_journal = TRUE;
5648 /* Set a known context for any ACLs we call via expansions */
5649 acl_where = ACL_WHERE_DELIVERY;
5651 /* Reset the random number generator, so that if several delivery processes are
5652 started from a queue runner that has already used random numbers (for sorting),
5653 they don't all get the same sequence. */
5657 /* Open and lock the message's data file. Exim locks on this one because the
5658 header file may get replaced as it is re-written during the delivery process.
5659 Any failures cause messages to be written to the log, except for missing files
5660 while queue running - another process probably completed delivery. As part of
5661 opening the data file, message_subdir gets set. */
5663 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5664 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5666 /* The value of message_size at this point has been set to the data length,
5667 plus one for the blank line that notionally precedes the data. */
5669 /* Now read the contents of the header file, which will set up the headers in
5670 store, and also the list of recipients and the tree of non-recipients and
5671 assorted flags. It updates message_size. If there is a reading or format error,
5672 give up; if the message has been around for sufficiently long, remove it. */
5675 uschar * spoolname = string_sprintf("%s-H", id);
5676 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5678 if (errno == ERRNO_SPOOLFORMAT)
5680 struct stat statbuf;
5681 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5683 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5684 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5686 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5689 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5692 /* If we managed to read the envelope data, received_time contains the
5693 time the message was received. Otherwise, we can calculate it from the
5696 if (rc != spool_read_hdrerror)
5698 received_time.tv_sec = received_time.tv_usec = 0;
5699 /*XXX subsec precision?*/
5700 for (i = 0; i < 6; i++)
5701 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5704 /* If we've had this malformed message too long, sling it. */
5706 if (now - received_time.tv_sec > keep_malformed)
5708 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5709 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5710 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5711 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5712 log_write(0, LOG_MAIN, "Message removed because older than %s",
5713 readconf_printtime(keep_malformed));
5716 (void)close(deliver_datafile);
5717 deliver_datafile = -1;
5718 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5722 /* The spool header file has been read. Look to see if there is an existing
5723 journal file for this message. If there is, it means that a previous delivery
5724 attempt crashed (program or host) before it could update the spool header file.
5725 Read the list of delivered addresses from the journal and add them to the
5726 nonrecipients tree. Then update the spool file. We can leave the journal in
5727 existence, as it will get further successful deliveries added to it in this
5728 run, and it will be deleted if this function gets to its end successfully.
5729 Otherwise it might be needed again. */
5732 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5735 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5743 && lseek(journal_fd, 0, SEEK_SET) == 0
5744 && (jread = fdopen(journal_fd, "rb"))
5747 while (Ufgets(big_buffer, big_buffer_size, jread))
5749 int n = Ustrlen(big_buffer);
5750 big_buffer[n-1] = 0;
5751 tree_add_nonrecipient(big_buffer);
5752 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5753 "journal file\n", big_buffer);
5756 if ((journal_fd = dup(fileno(jread))) < 0)
5757 journal_fd = fileno(jread);
5759 (void) fclose(jread); /* Try to not leak the FILE resource */
5761 /* Panic-dies on error */
5762 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5764 else if (errno != ENOENT)
5766 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5767 "%s", strerror(errno));
5768 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5771 /* A null recipients list indicates some kind of disaster. */
5773 if (!recipients_list)
5775 (void)close(deliver_datafile);
5776 deliver_datafile = -1;
5777 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5778 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5783 /* Handle a message that is frozen. There are a number of different things that
5784 can happen, but in the default situation, unless forced, no delivery is
5787 if (f.deliver_freeze)
5789 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5790 /* Moving to another directory removes the message from Exim's view. Other
5791 tools must be used to deal with it. Logging of this action happens in
5792 spool_move_message() and its subfunctions. */
5794 if ( move_frozen_messages
5795 && spool_move_message(id, message_subdir, US"", US"F")
5797 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5800 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5801 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5802 flag causing all recipients to be failed. The time is the age of the
5803 message, not the time since freezing. */
5805 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5807 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5808 process_recipients = RECIP_FAIL_TIMEOUT;
5811 /* For bounce messages (and others with no sender), thaw if the error message
5812 ignore timer is exceeded. The message will be discarded if this delivery
5815 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5816 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5818 /* If this is a bounce message, or there's no auto thaw, or we haven't
5819 reached the auto thaw time yet, and this delivery is not forced by an admin
5820 user, do not attempt delivery of this message. Note that forced is set for
5821 continuing messages down the same channel, in order to skip load checking and
5822 ignore hold domains, but we don't want unfreezing in that case. */
5826 if ( ( sender_address[0] == 0
5828 || now <= deliver_frozen_at + auto_thaw
5830 && ( !forced || !f.deliver_force_thaw
5831 || !f.admin_user || continue_hostname
5834 (void)close(deliver_datafile);
5835 deliver_datafile = -1;
5836 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5837 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5840 /* If delivery was forced (by an admin user), assume a manual thaw.
5841 Otherwise it's an auto thaw. */
5845 f.deliver_manual_thaw = TRUE;
5846 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5848 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5851 /* We get here if any of the rules for unfreezing have triggered. */
5853 f.deliver_freeze = FALSE;
5854 update_spool = TRUE;
5858 /* Open the message log file if we are using them. This records details of
5859 deliveries, deferments, and failures for the benefit of the mail administrator.
5860 The log is not used by exim itself to track the progress of a message; that is
5861 done by rewriting the header spool file. */
5865 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5869 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5871 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5872 fname, strerror(errno));
5873 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5876 /* Make a C stream out of it. */
5878 if (!(message_log = fdopen(fd, "a")))
5880 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5881 fname, strerror(errno));
5882 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5887 /* If asked to give up on a message, log who did it, and set the action for all
5892 struct passwd *pw = getpwuid(real_uid);
5893 log_write(0, LOG_MAIN, "cancelled by %s",
5894 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5895 process_recipients = RECIP_FAIL;
5898 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5900 else if (received_count > received_headers_max)
5901 process_recipients = RECIP_FAIL_LOOP;
5903 /* Otherwise, if a system-wide, address-independent message filter is
5904 specified, run it now, except in the case when we are failing all recipients as
5905 a result of timeout_frozen_after. If the system filter yields "delivered", then
5906 ignore the true recipients of the message. Failure of the filter file is
5907 logged, and the delivery attempt fails. */
5909 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5914 redirect_block redirect;
5916 if (system_filter_uid_set)
5918 ugid.uid = system_filter_uid;
5919 ugid.gid = system_filter_gid;
5920 ugid.uid_set = ugid.gid_set = TRUE;
5923 ugid.uid_set = ugid.gid_set = FALSE;
5925 return_path = sender_address;
5926 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5927 f.system_filtering = TRUE;
5929 /* Any error in the filter file causes a delivery to be abandoned. */
5931 redirect.string = system_filter;
5932 redirect.isfile = TRUE;
5933 redirect.check_owner = redirect.check_group = FALSE;
5934 redirect.owners = NULL;
5935 redirect.owngroups = NULL;
5937 redirect.modemask = 0;
5939 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5942 &redirect, /* Where the data is */
5943 RDO_DEFER | /* Turn on all the enabling options */
5944 RDO_FAIL | /* Leave off all the disabling options */
5949 NULL, /* No :include: restriction (not used in filter) */
5950 NULL, /* No sieve vacation directory (not sieve!) */
5951 NULL, /* No sieve enotify mailto owner (not sieve!) */
5952 NULL, /* No sieve user address (not sieve!) */
5953 NULL, /* No sieve subaddress (not sieve!) */
5954 &ugid, /* uid/gid data */
5955 &addr_new, /* Where to hang generated addresses */
5956 &filter_message, /* Where to put error message */
5957 NULL, /* Don't skip syntax errors */
5958 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5959 US"system filter"); /* For error messages */
5961 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5963 if (rc == FF_ERROR || rc == FF_NONEXIST)
5965 (void)close(deliver_datafile);
5966 deliver_datafile = -1;
5967 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5968 string_printing(filter_message));
5969 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5972 /* Reset things. If the filter message is an empty string, which can happen
5973 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5975 f.system_filtering = FALSE;
5976 f.enable_dollar_recipients = FALSE;
5977 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5979 /* Save the values of the system filter variables so that user filters
5982 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5984 /* The filter can request that delivery of the original addresses be
5989 process_recipients = RECIP_DEFER;
5990 deliver_msglog("Delivery deferred by system filter\n");
5991 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5994 /* The filter can request that a message be frozen, but this does not
5995 take place if the message has been manually thawed. In that case, we must
5996 unset "delivered", which is forced by the "freeze" command to make -bF
5999 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
6001 f.deliver_freeze = TRUE;
6002 deliver_frozen_at = time(NULL);
6003 process_recipients = RECIP_DEFER;
6004 frozen_info = string_sprintf(" by the system filter%s%s",
6005 filter_message ? US": " : US"",
6006 filter_message ? filter_message : US"");
6009 /* The filter can request that a message be failed. The error message may be
6010 quite long - it is sent back to the sender in the bounce - but we don't want
6011 to fill up the log with repetitions of it. If it starts with << then the text
6012 between << and >> is written to the log, with the rest left for the bounce
6015 else if (rc == FF_FAIL)
6017 uschar *colon = US"";
6018 uschar *logmsg = US"";
6021 process_recipients = RECIP_FAIL_FILTER;
6027 if ( filter_message[0] == '<'
6028 && filter_message[1] == '<'
6029 && (logend = Ustrstr(filter_message, ">>"))
6032 logmsg = filter_message + 2;
6033 loglen = logend - logmsg;
6034 filter_message = logend + 2;
6035 if (filter_message[0] == 0) filter_message = NULL;
6039 logmsg = filter_message;
6040 loglen = Ustrlen(filter_message);
6044 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
6048 /* Delivery can be restricted only to those recipients (if any) that the
6049 filter specified. */
6051 else if (rc == FF_DELIVERED)
6053 process_recipients = RECIP_IGNORE;
6055 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6057 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6060 /* If any new addresses were created by the filter, fake up a "parent"
6061 for them. This is necessary for pipes, etc., which are expected to have
6062 parents, and it also gives some sensible logging for others. Allow
6063 pipes, files, and autoreplies, and run them as the filter uid if set,
6064 otherwise as the current uid. */
6068 int uid = system_filter_uid_set ? system_filter_uid : geteuid();
6069 int gid = system_filter_gid_set ? system_filter_gid : getegid();
6071 /* The text "system-filter" is tested in transport_set_up_command() and in
6072 set_up_shell_command() in the pipe transport, to enable them to permit
6073 $recipients, so don't change it here without also changing it there. */
6075 address_item *p = addr_new;
6076 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6078 parent->domain = string_copylc(qualify_domain_recipient);
6079 parent->local_part = US"system-filter";
6081 /* As part of this loop, we arrange for addr_last to end up pointing
6082 at the final address. This is used if we go on to add addresses for the
6083 original recipients. */
6087 if (parent->child_count == USHRT_MAX)
6088 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6089 "than %d delivery addresses", USHRT_MAX);
6090 parent->child_count++;
6093 if (testflag(p, af_pfr))
6099 setflag(p, af_uid_set);
6100 setflag(p, af_gid_set);
6101 setflag(p, af_allow_file);
6102 setflag(p, af_allow_pipe);
6103 setflag(p, af_allow_reply);
6105 /* Find the name of the system filter's appropriate pfr transport */
6107 if (p->address[0] == '|')
6110 tpname = system_filter_pipe_transport;
6111 address_pipe = p->address;
6113 else if (p->address[0] == '>')
6116 tpname = system_filter_reply_transport;
6120 if (p->address[Ustrlen(p->address)-1] == '/')
6122 type = US"directory";
6123 tpname = system_filter_directory_transport;
6128 tpname = system_filter_file_transport;
6130 address_file = p->address;
6133 /* Now find the actual transport, first expanding the name. We have
6134 set address_file or address_pipe above. */
6138 uschar *tmp = expand_string(tpname);
6139 address_file = address_pipe = NULL;
6141 p->message = string_sprintf("failed to expand \"%s\" as a "
6142 "system filter transport name", tpname);
6143 if (is_tainted(tmp))
6144 p->message = string_sprintf("attempt to used tainted value '%s' for"
6145 "transport '%s' as a system filter", tmp, tpname);
6149 p->message = string_sprintf("system_filter_%s_transport is unset",
6154 transport_instance *tp;
6155 for (tp = transports; tp; tp = tp->next)
6156 if (Ustrcmp(tp->name, tpname) == 0)
6162 p->message = string_sprintf("failed to find \"%s\" transport "
6163 "for system filter delivery", tpname);
6166 /* If we couldn't set up a transport, defer the delivery, putting the
6167 error on the panic log as well as the main log. */
6171 address_item *badp = p;
6173 if (!addr_last) addr_new = p; else addr_last->next = p;
6174 badp->local_part = badp->address; /* Needed for log line */
6175 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6178 } /* End of pfr handling */
6180 /* Either a non-pfr delivery, or we found a transport */
6182 DEBUG(D_deliver|D_filter)
6183 debug_printf("system filter added %s\n", p->address);
6187 } /* Loop through all addr_new addresses */
6192 /* Scan the recipients list, and for every one that is not in the non-
6193 recipients tree, add an addr item to the chain of new addresses. If the pno
6194 value is non-negative, we must set the onetime parent from it. This which
6195 points to the relevant entry in the recipients list.
6197 This processing can be altered by the setting of the process_recipients
6198 variable, which is changed if recipients are to be ignored, failed, or
6199 deferred. This can happen as a result of system filter activity, or if the -Mg
6200 option is used to fail all of them.
6202 Duplicate addresses are handled later by a different tree structure; we can't
6203 just extend the non-recipients tree, because that will be re-written to the
6204 spool if the message is deferred, and in any case there are casing
6205 complications for local addresses. */
6207 if (process_recipients != RECIP_IGNORE)
6208 for (i = 0; i < recipients_count; i++)
6209 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6211 recipient_item *r = recipients_list + i;
6212 address_item *new = deliver_make_addr(r->address, FALSE);
6213 new->prop.errors_address = r->errors_to;
6215 if ((new->prop.utf8_msg = message_smtputf8))
6217 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6218 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6219 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6220 new->prop.utf8_downcvt ? "yes"
6221 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6227 new->onetime_parent = recipients_list[r->pno].address;
6229 /* If DSN support is enabled, set the dsn flags and the original receipt
6230 to be passed on to other DSN enabled MTAs */
6232 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6233 new->dsn_orcpt = r->orcpt;
6234 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: 0x%x\n",
6235 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6237 switch (process_recipients)
6239 /* RECIP_DEFER is set when a system filter freezes a message. */
6242 new->next = addr_defer;
6247 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6250 case RECIP_FAIL_FILTER:
6252 filter_message ? filter_message : US"delivery cancelled";
6253 setflag(new, af_pass_message);
6254 goto RECIP_QUEUE_FAILED; /* below */
6257 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6258 than the value in timeout_frozen_after. Treat non-bounce messages
6259 similarly to -Mg; for bounce messages we just want to discard, so
6260 don't put the address on the failed list. The timeout has already
6263 case RECIP_FAIL_TIMEOUT:
6264 new->message = US"delivery cancelled; message timed out";
6265 goto RECIP_QUEUE_FAILED; /* below */
6268 /* RECIP_FAIL is set when -Mg has been used. */
6271 new->message = US"delivery cancelled by administrator";
6274 /* Common code for the failure cases above. If this is not a bounce
6275 message, put the address on the failed list so that it is used to
6276 create a bounce. Otherwise do nothing - this just discards the address.
6277 The incident has already been logged. */
6280 if (sender_address[0])
6282 new->next = addr_failed;
6288 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6289 in the message. Process each address as a routing failure; if this
6290 is a bounce message, it will get frozen. */
6292 case RECIP_FAIL_LOOP:
6293 new->message = US"Too many \"Received\" headers - suspected mail loop";
6294 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6298 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6301 if (!addr_new) addr_new = new; else addr_last->next = new;
6306 #ifndef DISABLE_EVENT
6307 if (process_recipients != RECIP_ACCEPT && event_action)
6309 uschar * save_local = deliver_localpart;
6310 const uschar * save_domain = deliver_domain;
6311 uschar * addr = new->address, * errmsg = NULL;
6312 int start, end, dom;
6314 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6315 log_write(0, LOG_MAIN|LOG_PANIC,
6316 "failed to parse address '%.100s': %s\n", addr, errmsg);
6320 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6321 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6323 event_raise(event_action, US"msg:fail:internal", new->message);
6325 deliver_localpart = save_local;
6326 deliver_domain = save_domain;
6334 debug_printf("Delivery address list:\n");
6335 for (address_item * p = addr_new; p; p = p->next)
6336 debug_printf(" %s %s\n", p->address,
6337 p->onetime_parent ? p->onetime_parent : US"");
6340 /* Set up the buffers used for copying over the file when delivering. */
6342 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6343 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6347 /* Until there are no more new addresses, handle each one as follows:
6349 . If this is a generated address (indicated by the presence of a parent
6350 pointer) then check to see whether it is a pipe, file, or autoreply, and
6351 if so, handle it directly here. The router that produced the address will
6352 have set the allow flags into the address, and also set the uid/gid required.
6353 Having the routers generate new addresses and then checking them here at
6354 the outer level is tidier than making each router do the checking, and
6355 means that routers don't need access to the failed address queue.
6357 . Break up the address into local part and domain, and make lowercased
6358 versions of these strings. We also make unquoted versions of the local part.
6360 . Handle the percent hack for those domains for which it is valid.
6362 . For child addresses, determine if any of the parents have the same address.
6363 If so, generate a different string for previous delivery checking. Without
6364 this code, if the address spqr generates spqr via a forward or alias file,
6365 delivery of the generated spqr stops further attempts at the top level spqr,
6366 which is not what is wanted - it may have generated other addresses.
6368 . Check on the retry database to see if routing was previously deferred, but
6369 only if in a queue run. Addresses that are to be routed are put on the
6370 addr_route chain. Addresses that are to be deferred are put on the
6371 addr_defer chain. We do all the checking first, so as not to keep the
6372 retry database open any longer than necessary.
6374 . Now we run the addresses through the routers. A router may put the address
6375 on either the addr_local or the addr_remote chain for local or remote
6376 delivery, respectively, or put it on the addr_failed chain if it is
6377 undeliveable, or it may generate child addresses and put them on the
6378 addr_new chain, or it may defer an address. All the chain anchors are
6379 passed as arguments so that the routers can be called for verification
6382 . If new addresses have been generated by the routers, da capo.
6385 f.header_rewritten = FALSE; /* No headers rewritten yet */
6386 while (addr_new) /* Loop until all addresses dealt with */
6388 address_item *addr, *parent;
6390 /* Failure to open the retry database is treated the same as if it does
6391 not exist. In both cases, dbm_file is NULL. */
6393 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
6394 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6395 debug_printf("no retry data available\n");
6397 /* Scan the current batch of new addresses, to handle pipes, files and
6398 autoreplies, and determine which others are ready for routing. */
6405 dbdata_retry *domain_retry_record;
6406 dbdata_retry *address_retry_record;
6409 addr_new = addr->next;
6411 DEBUG(D_deliver|D_retry|D_route)
6413 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6414 debug_printf("Considering: %s\n", addr->address);
6417 /* Handle generated address that is a pipe or a file or an autoreply. */
6419 if (testflag(addr, af_pfr))
6421 /* If an autoreply in a filter could not generate a syntactically valid
6422 address, give up forthwith. Set af_ignore_error so that we don't try to
6423 generate a bounce. */
6425 if (testflag(addr, af_bad_reply))
6427 addr->basic_errno = ERRNO_BADADDRESS2;
6428 addr->local_part = addr->address;
6430 US"filter autoreply generated syntactically invalid recipient";
6431 addr->prop.ignore_error = TRUE;
6432 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6433 continue; /* with the next new address */
6436 /* If two different users specify delivery to the same pipe or file or
6437 autoreply, there should be two different deliveries, so build a unique
6438 string that incorporates the original address, and use this for
6439 duplicate testing and recording delivery, and also for retrying. */
6442 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6443 (testflag(addr->parent, af_homonym)? 3:0));
6445 addr->address_retry_key = addr->domain_retry_key =
6446 string_sprintf("T:%s", addr->unique);
6448 /* If a filter file specifies two deliveries to the same pipe or file,
6449 we want to de-duplicate, but this is probably not wanted for two mail
6450 commands to the same address, where probably both should be delivered.
6451 So, we have to invent a different unique string in that case. Just
6452 keep piling '>' characters on the front. */
6454 if (addr->address[0] == '>')
6455 while (tree_search(tree_duplicates, addr->unique))
6456 addr->unique = string_sprintf(">%s", addr->unique);
6458 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6460 DEBUG(D_deliver|D_route)
6461 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6462 addr->dupof = tnode->data.ptr;
6463 addr->next = addr_duplicate;
6464 addr_duplicate = addr;
6468 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6470 /* Check for previous delivery */
6472 if (tree_search(tree_nonrecipients, addr->unique))
6474 DEBUG(D_deliver|D_route)
6475 debug_printf("%s was previously delivered: discarded\n", addr->address);
6476 child_done(addr, tod_stamp(tod_log));
6480 /* Save for checking future duplicates */
6482 tree_add_duplicate(addr->unique, addr);
6484 /* Set local part and domain */
6486 addr->local_part = addr->address;
6487 addr->domain = addr->parent->domain;
6489 /* Ensure that the delivery is permitted. */
6491 if (testflag(addr, af_file))
6493 if (!testflag(addr, af_allow_file))
6495 addr->basic_errno = ERRNO_FORBIDFILE;
6496 addr->message = US"delivery to file forbidden";
6497 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6498 continue; /* with the next new address */
6501 else if (addr->address[0] == '|')
6503 if (!testflag(addr, af_allow_pipe))
6505 addr->basic_errno = ERRNO_FORBIDPIPE;
6506 addr->message = US"delivery to pipe forbidden";
6507 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6508 continue; /* with the next new address */
6511 else if (!testflag(addr, af_allow_reply))
6513 addr->basic_errno = ERRNO_FORBIDREPLY;
6514 addr->message = US"autoreply forbidden";
6515 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6516 continue; /* with the next new address */
6519 /* If the errno field is already set to BADTRANSPORT, it indicates
6520 failure to expand a transport string, or find the associated transport,
6521 or an unset transport when one is required. Leave this test till now so
6522 that the forbid errors are given in preference. */
6524 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6526 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6530 /* Treat /dev/null as a special case and abandon the delivery. This
6531 avoids having to specify a uid on the transport just for this case.
6532 Arrange for the transport name to be logged as "**bypassed**". */
6534 if (Ustrcmp(addr->address, "/dev/null") == 0)
6536 uschar *save = addr->transport->name;
6537 addr->transport->name = US"**bypassed**";
6538 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6539 addr->transport->name = save;
6540 continue; /* with the next new address */
6543 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6546 DEBUG(D_deliver|D_route)
6547 debug_printf("queued for %s transport\n", addr->transport->name);
6548 addr->next = addr_local;
6550 continue; /* with the next new address */
6553 /* Handle normal addresses. First, split up into local part and domain,
6554 handling the %-hack if necessary. There is the possibility of a defer from
6555 a lookup in percent_hack_domains. */
6557 if ((rc = deliver_split_address(addr)) == DEFER)
6559 addr->message = US"cannot check percent_hack_domains";
6560 addr->basic_errno = ERRNO_LISTDEFER;
6561 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6565 /* Check to see if the domain is held. If so, proceed only if the
6566 delivery was forced by hand. */
6568 deliver_domain = addr->domain; /* set $domain */
6569 if ( !forced && hold_domains
6570 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6571 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6577 addr->message = US"hold_domains lookup deferred";
6578 addr->basic_errno = ERRNO_LISTDEFER;
6582 addr->message = US"domain is held";
6583 addr->basic_errno = ERRNO_HELD;
6585 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6589 /* Now we can check for duplicates and previously delivered addresses. In
6590 order to do this, we have to generate a "unique" value for each address,
6591 because there may be identical actual addresses in a line of descendents.
6592 The "unique" field is initialized to the same value as the "address" field,
6593 but gets changed here to cope with identically-named descendents. */
6595 for (parent = addr->parent; parent; parent = parent->parent)
6596 if (strcmpic(addr->address, parent->address) == 0) break;
6598 /* If there's an ancestor with the same name, set the homonym flag. This
6599 influences how deliveries are recorded. Then add a prefix on the front of
6600 the unique address. We use \n\ where n starts at 0 and increases each time.
6601 It is unlikely to pass 9, but if it does, it may look odd but will still
6602 work. This means that siblings or cousins with the same names are treated
6603 as duplicates, which is what we want. */
6607 setflag(addr, af_homonym);
6608 if (parent->unique[0] != '\\')
6609 addr->unique = string_sprintf("\\0\\%s", addr->address);
6611 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6615 /* Ensure that the domain in the unique field is lower cased, because
6616 domains are always handled caselessly. */
6618 p = Ustrrchr(addr->unique, '@');
6619 while (*p != 0) { *p = tolower(*p); p++; }
6621 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6623 if (tree_search(tree_nonrecipients, addr->unique))
6625 DEBUG(D_deliver|D_route)
6626 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6627 child_done(addr, tod_stamp(tod_log));
6631 /* Get the routing retry status, saving the two retry keys (with and
6632 without the local part) for subsequent use. If there is no retry record for
6633 the standard address routing retry key, we look for the same key with the
6634 sender attached, because this form is used by the smtp transport after a
6635 4xx response to RCPT when address_retry_include_sender is true. */
6637 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6638 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6643 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6644 if ( domain_retry_record
6645 && now - domain_retry_record->time_stamp > retry_data_expire
6648 DEBUG(D_deliver|D_retry)
6649 debug_printf("domain retry record present but expired\n");
6650 domain_retry_record = NULL; /* Ignore if too old */
6653 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6654 if ( address_retry_record
6655 && now - address_retry_record->time_stamp > retry_data_expire
6658 DEBUG(D_deliver|D_retry)
6659 debug_printf("address retry record present but expired\n");
6660 address_retry_record = NULL; /* Ignore if too old */
6663 if (!address_retry_record)
6665 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6667 address_retry_record = dbfn_read(dbm_file, altkey);
6668 if ( address_retry_record
6669 && now - address_retry_record->time_stamp > retry_data_expire)
6671 DEBUG(D_deliver|D_retry)
6672 debug_printf("address<sender> retry record present but expired\n");
6673 address_retry_record = NULL; /* Ignore if too old */
6678 domain_retry_record = address_retry_record = NULL;
6680 DEBUG(D_deliver|D_retry)
6682 if (!domain_retry_record)
6683 debug_printf("no domain retry record\n");
6685 debug_printf("have domain retry record; next_try = now%+d\n",
6686 f.running_in_test_harness ? 0 :
6687 (int)(domain_retry_record->next_try - now));
6689 if (!address_retry_record)
6690 debug_printf("no address retry record\n");
6692 debug_printf("have address retry record; next_try = now%+d\n",
6693 f.running_in_test_harness ? 0 :
6694 (int)(address_retry_record->next_try - now));
6697 /* If we are sending a message down an existing SMTP connection, we must
6698 assume that the message which created the connection managed to route
6699 an address to that connection. We do not want to run the risk of taking
6700 a long time over routing here, because if we do, the server at the other
6701 end of the connection may time it out. This is especially true for messages
6702 with lots of addresses. For this kind of delivery, queue_running is not
6703 set, so we would normally route all addresses. We take a pragmatic approach
6704 and defer routing any addresses that have any kind of domain retry record.
6705 That is, we don't even look at their retry times. It doesn't matter if this
6706 doesn't work occasionally. This is all just an optimization, after all.
6708 The reason for not doing the same for address retries is that they normally
6709 arise from 4xx responses, not DNS timeouts. */
6711 if (continue_hostname && domain_retry_record)
6713 addr->message = US"reusing SMTP connection skips previous routing defer";
6714 addr->basic_errno = ERRNO_RRETRY;
6715 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6717 addr->message = domain_retry_record->text;
6718 setflag(addr, af_pass_message);
6721 /* If we are in a queue run, defer routing unless there is no retry data or
6722 we've passed the next retry time, or this message is forced. In other
6723 words, ignore retry data when not in a queue run.
6725 However, if the domain retry time has expired, always allow the routing
6726 attempt. If it fails again, the address will be failed. This ensures that
6727 each address is routed at least once, even after long-term routing
6730 If there is an address retry, check that too; just wait for the next
6731 retry time. This helps with the case when the temporary error on the
6732 address was really message-specific rather than address specific, since
6733 it allows other messages through.
6735 We also wait for the next retry time if this is a message sent down an
6736 existing SMTP connection (even though that will be forced). Otherwise there
6737 will be far too many attempts for an address that gets a 4xx error. In
6738 fact, after such an error, we should not get here because, the host should
6739 not be remembered as one this message needs. However, there was a bug that
6740 used to cause this to happen, so it is best to be on the safe side.
6742 Even if we haven't reached the retry time in the hints, there is one more
6743 check to do, which is for the ultimate address timeout. We only do this
6744 check if there is an address retry record and there is not a domain retry
6745 record; this implies that previous attempts to handle the address had the
6746 retry_use_local_parts option turned on. We use this as an approximation
6747 for the destination being like a local delivery, for example delivery over
6748 LMTP to an IMAP message store. In this situation users are liable to bump
6749 into their quota and thereby have intermittently successful deliveries,
6750 which keep the retry record fresh, which can lead to us perpetually
6751 deferring messages. */
6753 else if ( ( f.queue_running && !f.deliver_force
6754 || continue_hostname
6756 && ( ( domain_retry_record
6757 && now < domain_retry_record->next_try
6758 && !domain_retry_record->expired
6760 || ( address_retry_record
6761 && now < address_retry_record->next_try
6763 && ( domain_retry_record
6764 || !address_retry_record
6765 || !retry_ultimate_address_timeout(addr->address_retry_key,
6766 addr->domain, address_retry_record, now)
6769 addr->message = US"retry time not reached";
6770 addr->basic_errno = ERRNO_RRETRY;
6771 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6773 /* For remote-retry errors (here and just above) that we've not yet
6774 hit the retry time, use the error recorded in the retry database
6775 as info in the warning message. This lets us send a message even
6776 when we're not failing on a fresh attempt. We assume that this
6777 info is not sensitive. */
6779 addr->message = domain_retry_record
6780 ? domain_retry_record->text : address_retry_record->text;
6781 setflag(addr, af_pass_message);
6784 /* The domain is OK for routing. Remember if retry data exists so it
6785 can be cleaned up after a successful delivery. */
6789 if (domain_retry_record || address_retry_record)
6790 setflag(addr, af_dr_retry_exists);
6791 addr->next = addr_route;
6793 DEBUG(D_deliver|D_route)
6794 debug_printf("%s: queued for routing\n", addr->address);
6798 /* The database is closed while routing is actually happening. Requests to
6799 update it are put on a chain and all processed together at the end. */
6801 if (dbm_file) dbfn_close(dbm_file);
6803 /* If queue_domains is set, we don't even want to try routing addresses in
6804 those domains. During queue runs, queue_domains is forced to be unset.
6805 Optimize by skipping this pass through the addresses if nothing is set. */
6807 if (!f.deliver_force && queue_domains)
6809 address_item *okaddr = NULL;
6812 address_item *addr = addr_route;
6813 addr_route = addr->next;
6815 deliver_domain = addr->domain; /* set $domain */
6816 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6817 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6821 addr->basic_errno = ERRNO_LISTDEFER;
6822 addr->message = US"queue_domains lookup deferred";
6823 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6827 addr->next = okaddr;
6832 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6833 addr->message = US"domain is in queue_domains";
6834 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6838 addr_route = okaddr;
6841 /* Now route those addresses that are not deferred. */
6846 address_item *addr = addr_route;
6847 const uschar *old_domain = addr->domain;
6848 uschar *old_unique = addr->unique;
6849 addr_route = addr->next;
6852 /* Just in case some router parameter refers to it. */
6854 if (!(return_path = addr->prop.errors_address))
6855 return_path = sender_address;
6857 /* If a router defers an address, add a retry item. Whether or not to
6858 use the local part in the key is a property of the router. */
6860 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6861 &addr_succeed, v_none)) == DEFER)
6862 retry_add_item(addr,
6863 addr->router->retry_use_local_part
6864 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6865 : string_sprintf("R:%s", addr->domain),
6868 /* Otherwise, if there is an existing retry record in the database, add
6869 retry items to delete both forms. We must also allow for the possibility
6870 of a routing retry that includes the sender address. Since the domain might
6871 have been rewritten (expanded to fully qualified) as a result of routing,
6872 ensure that the rewritten form is also deleted. */
6874 else if (testflag(addr, af_dr_retry_exists))
6876 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6878 retry_add_item(addr, altkey, rf_delete);
6879 retry_add_item(addr, addr->address_retry_key, rf_delete);
6880 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6881 if (Ustrcmp(addr->domain, old_domain) != 0)
6882 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6885 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6886 logged, but we need to ensure the address (and maybe parents) is marked
6891 address_done(addr, tod_stamp(tod_log));
6892 continue; /* route next address */
6895 /* The address is finished with (failed or deferred). */
6899 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6900 continue; /* route next address */
6903 /* The address has been routed. If the router changed the domain, it will
6904 also have changed the unique address. We have to test whether this address
6905 has already been delivered, because it's the unique address that finally
6908 if ( addr->unique != old_unique
6909 && tree_search(tree_nonrecipients, addr->unique) != 0
6912 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6913 "discarded\n", addr->address);
6914 if (addr_remote == addr) addr_remote = addr->next;
6915 else if (addr_local == addr) addr_local = addr->next;
6918 /* If the router has same_domain_copy_routing set, we are permitted to copy
6919 the routing for any other addresses with the same domain. This is an
6920 optimisation to save repeated DNS lookups for "standard" remote domain
6921 routing. The option is settable only on routers that generate host lists.
6922 We play it very safe, and do the optimization only if the address is routed
6923 to a remote transport, there are no header changes, and the domain was not
6924 modified by the router. */
6926 if ( addr_remote == addr
6927 && addr->router->same_domain_copy_routing
6928 && !addr->prop.extra_headers
6929 && !addr->prop.remove_headers
6930 && old_domain == addr->domain
6933 address_item **chain = &addr_route;
6936 address_item *addr2 = *chain;
6937 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6939 chain = &(addr2->next);
6943 /* Found a suitable address; take it off the routing list and add it to
6944 the remote delivery list. */
6946 *chain = addr2->next;
6947 addr2->next = addr_remote;
6948 addr_remote = addr2;
6950 /* Copy the routing data */
6952 addr2->domain = addr->domain;
6953 addr2->router = addr->router;
6954 addr2->transport = addr->transport;
6955 addr2->host_list = addr->host_list;
6956 addr2->fallback_hosts = addr->fallback_hosts;
6957 addr2->prop.errors_address = addr->prop.errors_address;
6958 copyflag(addr2, addr, af_hide_child);
6959 copyflag(addr2, addr, af_local_host_removed);
6961 DEBUG(D_deliver|D_route)
6962 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6964 "Routing for %s copied from %s\n",
6965 addr2->address, addr2->address, addr->address);
6968 } /* Continue with routing the next address. */
6969 } /* Loop to process any child addresses that the routers created, and
6970 any rerouted addresses that got put back on the new chain. */
6973 /* Debugging: show the results of the routing */
6975 DEBUG(D_deliver|D_retry|D_route)
6977 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6978 debug_printf("After routing:\n Local deliveries:\n");
6979 for (address_item * p = addr_local; p; p = p->next)
6980 debug_printf(" %s\n", p->address);
6982 debug_printf(" Remote deliveries:\n");
6983 for (address_item * p = addr_remote; p; p = p->next)
6984 debug_printf(" %s\n", p->address);
6986 debug_printf(" Failed addresses:\n");
6987 for (address_item * p = addr_failed; p; p = p->next)
6988 debug_printf(" %s\n", p->address);
6990 debug_printf(" Deferred addresses:\n");
6991 for (address_item * p = addr_defer; p; p = p->next)
6992 debug_printf(" %s\n", p->address);
6995 /* Free any resources that were cached during routing. */
7000 /* These two variables are set only during routing, after check_local_user.
7001 Ensure they are not set in transports. */
7003 local_user_gid = (gid_t)(-1);
7004 local_user_uid = (uid_t)(-1);
7006 /* Check for any duplicate addresses. This check is delayed until after
7007 routing, because the flexibility of the routing configuration means that
7008 identical addresses with different parentage may end up being redirected to
7009 different addresses. Checking for duplicates too early (as we previously used
7010 to) makes this kind of thing not work. */
7012 do_duplicate_check(&addr_local);
7013 do_duplicate_check(&addr_remote);
7015 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
7016 remote transport. The check that they all end up in one transaction happens in
7017 the do_remote_deliveries() function. */
7020 && (addr_local || addr_failed || addr_defer)
7024 uschar *which, *colon, *msg;
7031 else if (addr_defer)
7034 which = US"deferred";
7042 while (addr->parent) addr = addr->parent;
7047 msg = addr->message;
7049 else colon = msg = US"";
7051 /* We don't need to log here for a forced failure as it will already
7052 have been logged. Defer will also have been logged, but as a defer, so we do
7053 need to do the failure logging. */
7055 if (addr != addr_failed)
7056 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7057 addr->address, which);
7059 /* Always write an error to the caller */
7061 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7064 final_yield = DELIVER_MUA_FAILED;
7065 addr_failed = addr_defer = NULL; /* So that we remove the message */
7066 goto DELIVERY_TIDYUP;
7070 /* If this is a run to continue deliveries to an external channel that is
7071 already set up, defer any local deliveries.
7073 jgh 2020/12/20: I don't see why; locals should be quick.
7074 The defer goes back to version 1.62 in 1997. A local being still deliverable
7075 during a continued run might result from something like a defer during the
7076 original delivery, eg. in a DB lookup. Unlikely but possible.
7078 To avoid delaying a local when combined with a callout-hold for a remote
7079 delivery, test continue_sequence rather than continue_transport. */
7081 if (continue_sequence > 1 && addr_local)
7083 DEBUG(D_deliver|D_retry|D_route)
7084 debug_printf("deferring local deliveries due to continued-transport\n");
7087 address_item * addr = addr_defer;
7088 while (addr->next) addr = addr->next;
7089 addr->next = addr_local;
7092 addr_defer = addr_local;
7097 /* Because address rewriting can happen in the routers, we should not really do
7098 ANY deliveries until all addresses have been routed, so that all recipients of
7099 the message get the same headers. However, this is in practice not always
7100 possible, since sometimes remote addresses give DNS timeouts for days on end.
7101 The pragmatic approach is to deliver what we can now, saving any rewritten
7102 headers so that at least the next lot of recipients benefit from the rewriting
7103 that has already been done.
7105 If any headers have been rewritten during routing, update the spool file to
7106 remember them for all subsequent deliveries. This can be delayed till later if
7107 there is only address to be delivered - if it succeeds the spool write need not
7110 if ( f.header_rewritten
7111 && ( addr_local && (addr_local->next || addr_remote)
7112 || addr_remote && addr_remote->next
7115 /* Panic-dies on error */
7116 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7117 f.header_rewritten = FALSE;
7121 /* If there are any deliveries to do and we do not already have the journal
7122 file, create it. This is used to record successful deliveries as soon as
7123 possible after each delivery is known to be complete. A file opened with
7124 O_APPEND is used so that several processes can run simultaneously.
7126 The journal is just insurance against crashes. When the spool file is
7127 ultimately updated at the end of processing, the journal is deleted. If a
7128 journal is found to exist at the start of delivery, the addresses listed
7129 therein are added to the non-recipients. */
7131 if (addr_local || addr_remote)
7135 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7137 if ((journal_fd = Uopen(fname,
7141 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7143 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7144 fname, strerror(errno));
7145 return DELIVER_NOT_ATTEMPTED;
7148 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7149 that the mode is correct - the group setting doesn't always seem to get
7150 set automatically. */
7152 if( exim_fchown(journal_fd, exim_uid, exim_gid, fname)
7153 || fchmod(journal_fd, SPOOL_MODE)
7155 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7159 int ret = Uunlink(fname);
7160 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7161 fname, strerror(errno));
7162 if(ret && errno != ENOENT)
7163 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7164 fname, strerror(errno));
7165 return DELIVER_NOT_ATTEMPTED;
7169 else if (journal_fd >= 0)
7177 /* Now we can get down to the business of actually doing deliveries. Local
7178 deliveries are done first, then remote ones. If ever the problems of how to
7179 handle fallback transports are figured out, this section can be put into a loop
7180 for handling fallbacks, though the uid switching will have to be revised. */
7182 /* Precompile a regex that is used to recognize a parameter in response
7183 to an LHLO command, if is isn't already compiled. This may be used on both
7184 local and remote LMTP deliveries. */
7186 if (!regex_IGNOREQUOTA)
7188 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7190 /* Handle local deliveries */
7194 DEBUG(D_deliver|D_transport)
7195 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7196 do_local_deliveries();
7197 f.disable_logging = FALSE;
7200 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7201 so just queue them all. */
7203 if (f.queue_run_local)
7206 address_item *addr = addr_remote;
7207 addr_remote = addr->next;
7209 addr->basic_errno = ERRNO_LOCAL_ONLY;
7210 addr->message = US"remote deliveries suppressed";
7211 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7214 /* Handle remote deliveries */
7218 DEBUG(D_deliver|D_transport)
7219 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7221 /* Precompile some regex that are used to recognize parameters in response
7222 to an EHLO command, if they aren't already compiled. */
7224 smtp_deliver_init();
7226 /* Now sort the addresses if required, and do the deliveries. The yield of
7227 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7228 cannot be delivered in one transaction. */
7230 if (remote_sort_domains) sort_remote_deliveries();
7231 if (!do_remote_deliveries(FALSE))
7233 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7234 "be delivered in one transaction");
7235 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7237 final_yield = DELIVER_MUA_FAILED;
7238 addr_failed = addr_defer = NULL; /* So that we remove the message */
7239 goto DELIVERY_TIDYUP;
7242 /* See if any of the addresses that failed got put on the queue for delivery
7243 to their fallback hosts. We do it this way because often the same fallback
7244 host is used for many domains, so all can be sent in a single transaction
7245 (if appropriately configured). */
7247 if (addr_fallback && !mua_wrapper)
7249 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7250 addr_remote = addr_fallback;
7251 addr_fallback = NULL;
7252 if (remote_sort_domains) sort_remote_deliveries();
7253 do_remote_deliveries(TRUE);
7255 f.disable_logging = FALSE;
7259 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7260 phase, to minimize cases of half-done things. */
7263 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7264 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7266 /* Root privilege is no longer needed */
7268 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7270 set_process_info("tidying up after delivering %s", message_id);
7271 signal(SIGTERM, SIG_IGN);
7273 /* When we are acting as an MUA wrapper, the smtp transport will either have
7274 succeeded for all addresses, or failed them all in normal cases. However, there
7275 are some setup situations (e.g. when a named port does not exist) that cause an
7276 immediate exit with deferral of all addresses. Convert those into failures. We
7277 do not ever want to retry, nor do we want to send a bounce message. */
7283 address_item * nextaddr;
7284 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7286 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7287 "delivery", addr->address);
7288 nextaddr = addr->next;
7289 addr->next = addr_failed;
7295 /* Now all should either have succeeded or failed. */
7298 final_yield = DELIVER_MUA_SUCCEEDED;
7302 uschar *s = addr_failed->user_message;
7304 if (!s) s = addr_failed->message;
7306 fprintf(stderr, "Delivery failed: ");
7307 if (addr_failed->basic_errno > 0)
7309 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7310 if (s) fprintf(stderr, ": ");
7312 if ((host = addr_failed->host_used))
7313 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7315 fprintf(stderr, "%s", CS s);
7316 else if (addr_failed->basic_errno <= 0)
7317 fprintf(stderr, "unknown error");
7318 fprintf(stderr, "\n");
7320 final_yield = DELIVER_MUA_FAILED;
7325 /* In a normal configuration, we now update the retry database. This is done in
7326 one fell swoop at the end in order not to keep opening and closing (and
7327 locking) the database. The code for handling retries is hived off into a
7328 separate module for convenience. We pass it the addresses of the various
7329 chains, because deferred addresses can get moved onto the failed chain if the
7330 retry cutoff time has expired for all alternative destinations. Bypass the
7331 updating of the database if the -N flag is set, which is a debugging thing that
7332 prevents actual delivery. */
7334 else if (!f.dont_deliver)
7335 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7337 /* Send DSN for successful messages if requested */
7338 addr_senddsn = NULL;
7340 for (address_item * a = addr_succeed; a; a = a->next)
7342 /* af_ignore_error not honored here. it's not an error */
7343 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7344 "DSN: processing successful delivery address: %s\n"
7345 "DSN: Sender_address: %s\n"
7346 "DSN: orcpt: %s flags: 0x%x\n"
7347 "DSN: envid: %s ret: %d\n"
7348 "DSN: Final recipient: %s\n"
7349 "DSN: Remote SMTP server supports DSN: %d\n",
7350 a->router ? a->router->name : US"(unknown)",
7353 a->dsn_orcpt ? a->dsn_orcpt : US"NULL",
7355 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7360 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7361 and a report was requested */
7363 if ( (a->dsn_aware != dsn_support_yes || a->dsn_flags & rf_dsnlasthop)
7364 && a->dsn_flags & rf_notify_success
7367 /* copy and relink address_item and send report with all of them at once later */
7368 address_item * addr_next = addr_senddsn;
7369 addr_senddsn = store_get(sizeof(address_item), FALSE);
7371 addr_senddsn->next = addr_next;
7374 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7382 /* create exim process to send message */
7383 pid = child_open_exim(&fd, US"DSN");
7385 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7387 if (pid < 0) /* Creation of child failed */
7389 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7390 "create child process to send success-dsn message: %s", getpid(),
7391 getppid(), strerror(errno));
7393 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7395 else /* Creation of child succeeded */
7397 FILE * f = fdopen(fd, "wb");
7398 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7400 transport_ctx tctx = {{0}};
7403 debug_printf("sending success-dsn to: %s\n", sender_address);
7405 /* build unique id for MIME boundary */
7406 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7407 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7409 if (errors_reply_to)
7410 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7413 fprintf(f, "Auto-Submitted: auto-generated\n"
7415 "Subject: Delivery Status Notification\n",
7417 moan_write_references(f, NULL);
7418 fprintf(f, "Content-Type: multipart/report;"
7419 " report-type=delivery-status; boundary=%s\n"
7420 "MIME-Version: 1.0\n\n"
7423 "Content-type: text/plain; charset=us-ascii\n\n"
7425 "This message was created automatically by mail delivery software.\n"
7426 " ----- The following addresses had successful delivery notifications -----\n",
7429 for (address_item * a = addr_senddsn; a; a = a->next)
7430 fprintf(f, "<%s> (relayed %s)\n\n",
7432 a->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7433 : a->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7434 : "via non \"Remote SMTP\" router"
7438 "Content-type: message/delivery-status\n\n"
7439 "Reporting-MTA: dns; %s\n",
7440 bound, smtp_active_hostname);
7443 { /* must be decoded from xtext: see RFC 3461:6.3a */
7445 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7446 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7448 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7452 for (address_item * a = addr_senddsn; a; a = a->next)
7456 print_dsn_addr_action(f, a, US"delivered", US"2.0.0");
7458 if ((hu = a->host_used) && hu->name)
7459 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7462 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7463 a->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7466 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7469 transport_filter_argv = NULL; /* Just in case */
7470 return_path = sender_address; /* In case not previously set */
7472 /* Write the original email out */
7475 tctx.options = topt_add_return_path | topt_no_body;
7476 /*XXX hmm, FALSE(fail) retval ignored.
7477 Could error for any number of reasons, and they are not handled. */
7478 transport_write_message(&tctx, 0);
7481 fprintf(f,"\n--%s--\n", bound);
7485 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7489 /* If any addresses failed, we must send a message to somebody, unless
7490 af_ignore_error is set, in which case no action is taken. It is possible for
7491 several messages to get sent if there are addresses with different
7498 uschar *logtod = tod_stamp(tod_log);
7500 address_item *handled_addr = NULL;
7501 address_item **paddr;
7502 address_item *msgchain = NULL;
7503 address_item **pmsgchain = &msgchain;
7505 /* There are weird cases when logging is disabled in the transport. However,
7506 there may not be a transport (address failed by a router). */
7508 f.disable_logging = FALSE;
7509 if (addr_failed->transport)
7510 f.disable_logging = addr_failed->transport->disable_logging;
7513 debug_printf("processing failed address %s\n", addr_failed->address);
7515 /* There are only two ways an address in a bounce message can get here:
7517 (1) When delivery was initially deferred, but has now timed out (in the call
7518 to retry_update() above). We can detect this by testing for
7519 af_retry_timedout. If the address does not have its own errors address,
7520 we arrange to ignore the error.
7522 (2) If delivery failures for bounce messages are being ignored. We can detect
7523 this by testing for af_ignore_error. This will also be set if a bounce
7524 message has been autothawed and the ignore_bounce_errors_after time has
7525 passed. It might also be set if a router was explicitly configured to
7526 ignore errors (errors_to = "").
7528 If neither of these cases obtains, something has gone wrong. Log the
7529 incident, but then ignore the error. */
7531 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7533 if ( !testflag(addr_failed, af_retry_timedout)
7534 && !addr_failed->prop.ignore_error)
7535 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7536 "failure is neither frozen nor ignored (it's been ignored)");
7538 addr_failed->prop.ignore_error = TRUE;
7541 /* If the first address on the list has af_ignore_error set, just remove
7542 it from the list, throw away any saved message file, log it, and
7543 mark the recipient done. */
7545 if ( addr_failed->prop.ignore_error
7546 || addr_failed->dsn_flags & rf_dsnflags
7547 && !(addr_failed->dsn_flags & rf_notify_failure)
7551 addr_failed = addr->next;
7552 if (addr->return_filename) Uunlink(addr->return_filename);
7554 #ifndef DISABLE_EVENT
7555 msg_event_raise(US"msg:fail:delivery", addr);
7557 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored%s",
7559 !addr->parent ? US"" : US" <",
7560 !addr->parent ? US"" : addr->parent->address,
7561 !addr->parent ? US"" : US">",
7562 addr->prop.ignore_error
7563 ? US"" : US": RFC 3461 DSN, failure notify not requested");
7565 address_done(addr, logtod);
7566 child_done(addr, logtod);
7567 /* Panic-dies on error */
7568 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7571 /* Otherwise, handle the sending of a message. Find the error address for
7572 the first address, then send a message that includes all failed addresses
7573 that have the same error address. Note the bounce_recipient is a global so
7574 that it can be accessed by $bounce_recipient while creating a customized
7579 if (!(bounce_recipient = addr_failed->prop.errors_address))
7580 bounce_recipient = sender_address;
7582 /* Make a subprocess to send a message */
7584 if ((pid = child_open_exim(&fd, US"bounce-message")) < 0)
7585 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7586 "create child process to send failure message: %s", getpid(),
7587 getppid(), strerror(errno));
7589 /* Creation of child succeeded */
7596 uschar *bcc, *emf_text;
7597 FILE * fp = fdopen(fd, "wb");
7599 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7600 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7601 DELIVER_IN_BUFFER_SIZE;
7603 uschar *dsnlimitmsg;
7604 uschar *dsnnotifyhdr;
7608 debug_printf("sending error message to: %s\n", bounce_recipient);
7610 /* Scan the addresses for all that have the same errors address, removing
7611 them from the addr_failed chain, and putting them on msgchain. */
7613 paddr = &addr_failed;
7614 for (addr = addr_failed; addr; addr = *paddr)
7615 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7616 ? addr->prop.errors_address : sender_address) == 0)
7617 { /* The same - dechain */
7618 *paddr = addr->next;
7621 pmsgchain = &(addr->next);
7624 paddr = &addr->next; /* Not the same; skip */
7626 /* Include X-Failed-Recipients: for automatic interpretation, but do
7627 not let any one header line get too long. We do this by starting a
7628 new header every 50 recipients. Omit any addresses for which the
7629 "hide_child" flag is set. */
7631 for (addr = msgchain; addr; addr = addr->next)
7633 if (testflag(addr, af_hide_child)) continue;
7641 ? "X-Failed-Recipients: "
7643 testflag(addr, af_pfr) && addr->parent
7644 ? string_printing(addr->parent->address)
7645 : string_printing(addr->address));
7647 if (rcount > 0) fprintf(fp, "\n");
7649 /* Output the standard headers */
7651 if (errors_reply_to)
7652 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7653 fprintf(fp, "Auto-Submitted: auto-replied\n");
7654 moan_write_from(fp);
7655 fprintf(fp, "To: %s\n", bounce_recipient);
7656 moan_write_references(fp, NULL);
7658 /* generate boundary string and output MIME-Headers */
7659 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7661 fprintf(fp, "Content-Type: multipart/report;"
7662 " report-type=delivery-status; boundary=%s\n"
7663 "MIME-Version: 1.0\n",
7666 /* Open a template file if one is provided. Log failure to open, but
7667 carry on - default texts will be used. */
7669 if (bounce_message_file)
7670 emf = expand_open(bounce_message_file,
7671 US"bounce_message_file", US"error");
7673 /* Quietly copy to configured additional addresses if required. */
7675 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7676 fprintf(fp, "Bcc: %s\n", bcc);
7678 /* The texts for the message can be read from a template file; if there
7679 isn't one, or if it is too short, built-in texts are used. The first
7680 emf text is a Subject: and any other headers. */
7682 if ((emf_text = next_emf(emf, US"header")))
7683 fprintf(fp, "%s\n", emf_text);
7685 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7686 to_sender? ": returning message to sender" : "");
7688 /* output human readable part as text/plain section */
7689 fprintf(fp, "--%s\n"
7690 "Content-type: text/plain; charset=us-ascii\n\n",
7693 if ((emf_text = next_emf(emf, US"intro")))
7694 fprintf(fp, "%s", CS emf_text);
7698 /* This message has been reworded several times. It seems to be confusing to
7699 somebody, however it is worded. I have retreated to the original, simple
7701 "This message was created automatically by mail delivery software.\n");
7703 if (bounce_message_text)
7704 fprintf(fp, "%s", CS bounce_message_text);
7707 "\nA message that you sent could not be delivered to one or more of its\n"
7708 "recipients. This is a permanent error. The following address(es) failed:\n");
7711 "\nA message sent by\n\n <%s>\n\n"
7712 "could not be delivered to one or more of its recipients. The following\n"
7713 "address(es) failed:\n", sender_address);
7717 /* Process the addresses, leaving them on the msgchain if they have a
7718 file name for a return message. (There has already been a check in
7719 post_process_one() for the existence of data in the message file.) A TRUE
7720 return from print_address_information() means that the address is not
7724 for (addr = msgchain; addr; addr = *paddr)
7726 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7727 print_address_error(addr, fp, US"");
7729 /* End the final line for the address */
7733 /* Leave on msgchain if there's a return file. */
7735 if (addr->return_file >= 0)
7737 paddr = &(addr->next);
7741 /* Else save so that we can tick off the recipient when the
7746 *paddr = addr->next;
7747 addr->next = handled_addr;
7748 handled_addr = addr;
7754 /* Get the next text, whether we need it or not, so as to be
7755 positioned for the one after. */
7757 emf_text = next_emf(emf, US"generated text");
7759 /* If there were any file messages passed by the local transports,
7760 include them in the message. Then put the address on the handled chain.
7761 In the case of a batch of addresses that were all sent to the same
7762 transport, the return_file field in all of them will contain the same
7763 fd, and the return_filename field in the *last* one will be set (to the
7764 name of the file). */
7768 address_item *nextaddr;
7771 fprintf(fp, "%s", CS emf_text);
7774 "The following text was generated during the delivery "
7775 "attempt%s:\n", (filecount > 1)? "s" : "");
7777 for (addr = msgchain; addr; addr = nextaddr)
7780 address_item *topaddr = addr;
7782 /* List all the addresses that relate to this file */
7785 while(addr) /* Insurance */
7787 print_address_information(addr, fp, US"------ ", US"\n ",
7789 if (addr->return_filename) break;
7794 /* Now copy the file */
7796 if (!(fm = Ufopen(addr->return_filename, "rb")))
7797 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7801 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7804 Uunlink(addr->return_filename);
7806 /* Can now add to handled chain, first fishing off the next
7807 address on the msgchain. */
7809 nextaddr = addr->next;
7810 addr->next = handled_addr;
7811 handled_addr = topaddr;
7816 /* output machine readable part */
7818 if (message_smtputf8)
7819 fprintf(fp, "--%s\n"
7820 "Content-type: message/global-delivery-status\n\n"
7821 "Reporting-MTA: dns; %s\n",
7822 bound, smtp_active_hostname);
7825 fprintf(fp, "--%s\n"
7826 "Content-type: message/delivery-status\n\n"
7827 "Reporting-MTA: dns; %s\n",
7828 bound, smtp_active_hostname);
7832 /* must be decoded from xtext: see RFC 3461:6.3a */
7834 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7835 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7837 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7841 for (addr = handled_addr; addr; addr = addr->next)
7845 print_dsn_addr_action(fp, addr, US"failed", US"5.0.0");
7847 if ((hu = addr->host_used) && hu->name)
7849 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7850 #ifdef EXPERIMENTAL_DSN_INFO
7855 uschar * p = hu->port == 25
7856 ? US"" : string_sprintf(":%d", hu->port);
7857 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7859 if ((s = addr->smtp_greeting) && *s)
7860 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %.900s\n", s);
7861 if ((s = addr->helo_response) && *s)
7862 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %.900s\n", s);
7863 if ((s = addr->message) && *s)
7864 fprintf(fp, "X-Exim-Diagnostic: X-str; %.900s\n", s);
7867 print_dsn_diagnostic_code(addr, fp);
7872 /* Now copy the message, trying to give an intelligible comment if
7873 it is too long for it all to be copied. The limit isn't strictly
7874 applied because of the buffering. There is, however, an option
7875 to suppress copying altogether. */
7877 emf_text = next_emf(emf, US"copy");
7880 we ignore the intro text from template and add
7881 the text for bounce_return_size_limit at the end.
7883 bounce_return_message is ignored
7884 in case RET= is defined we honor these values
7885 otherwise bounce_return_body is honored.
7887 bounce_return_size_limit is always honored.
7890 fprintf(fp, "--%s\n", bound);
7892 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7893 dsnnotifyhdr = NULL;
7894 topt = topt_add_return_path;
7896 /* RET=HDRS? top priority */
7897 if (dsn_ret == dsn_ret_hdrs)
7898 topt |= topt_no_body;
7901 struct stat statbuf;
7903 /* no full body return at all? */
7904 if (!bounce_return_body)
7906 topt |= topt_no_body;
7907 /* add header if we overrule RET=FULL */
7908 if (dsn_ret == dsn_ret_full)
7909 dsnnotifyhdr = dsnlimitmsg;
7911 /* line length limited... return headers only if oversize */
7912 /* size limited ... return headers only if limit reached */
7913 else if ( max_received_linelength > bounce_return_linesize_limit
7914 || ( bounce_return_size_limit > 0
7915 && fstat(deliver_datafile, &statbuf) == 0
7916 && statbuf.st_size > max
7919 topt |= topt_no_body;
7920 dsnnotifyhdr = dsnlimitmsg;
7925 if (message_smtputf8)
7926 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7927 : "Content-type: message/global\n\n",
7931 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7932 : "Content-type: message/rfc822\n\n",
7936 transport_filter_argv = NULL; /* Just in case */
7937 return_path = sender_address; /* In case not previously set */
7938 { /* Dummy transport for headers add */
7939 transport_ctx tctx = {{0}};
7940 transport_instance tb = {0};
7942 tctx.u.fd = fileno(fp);
7944 tctx.options = topt;
7945 tb.add_headers = dsnnotifyhdr;
7947 /*XXX no checking for failure! buggy! */
7948 transport_write_message(&tctx, 0);
7952 /* we never add the final text. close the file */
7956 fprintf(fp, "\n--%s--\n", bound);
7958 /* Close the file, which should send an EOF to the child process
7959 that is receiving the message. Wait for it to finish. */
7962 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7964 /* If the process failed, there was some disaster in setting up the
7965 error message. Unless the message is very old, ensure that addr_defer
7966 is non-null, which will have the effect of leaving the message on the
7967 spool. The failed addresses will get tried again next time. However, we
7968 don't really want this to happen too often, so freeze the message unless
7969 there are some genuine deferred addresses to try. To do this we have
7970 to call spool_write_header() here, because with no genuine deferred
7971 addresses the normal code below doesn't get run. */
7976 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7978 addr_defer = (address_item *)(+1);
7979 f.deliver_freeze = TRUE;
7980 deliver_frozen_at = time(NULL);
7981 /* Panic-dies on error */
7982 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7985 deliver_msglog("Process failed (%d) when writing error message "
7986 "to %s%s", rc, bounce_recipient, s);
7987 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7988 "to %s%s", rc, bounce_recipient, s);
7991 /* The message succeeded. Ensure that the recipients that failed are
7992 now marked finished with on the spool and their parents updated. */
7996 for (addr = handled_addr; addr; addr = addr->next)
7998 address_done(addr, logtod);
7999 child_done(addr, logtod);
8001 /* Panic-dies on error */
8002 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8008 f.disable_logging = FALSE; /* In case left set */
8010 /* Come here from the mua_wrapper case if routing goes wrong */
8014 /* If there are now no deferred addresses, we are done. Preserve the
8015 message log if so configured, and we are using them. Otherwise, sling it.
8016 Then delete the message itself. */
8024 fname = spool_fname(US"msglog", message_subdir, id, US"");
8025 if (preserve_message_logs)
8028 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
8030 if ((rc = Urename(fname, moname)) < 0)
8032 (void)directory_make(spool_directory,
8033 spool_sname(US"msglog.OLD", US""),
8034 MSGLOG_DIRECTORY_MODE, TRUE);
8035 rc = Urename(fname, moname);
8038 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
8039 "msglog.OLD directory", fname);
8042 if (Uunlink(fname) < 0)
8043 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8044 fname, strerror(errno));
8047 /* Remove the two message files. */
8049 fname = spool_fname(US"input", message_subdir, id, US"-D");
8050 if (Uunlink(fname) < 0)
8051 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8052 fname, strerror(errno));
8053 fname = spool_fname(US"input", message_subdir, id, US"-H");
8054 if (Uunlink(fname) < 0)
8055 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
8056 fname, strerror(errno));
8058 /* Log the end of this message, with queue time if requested. */
8060 if (LOGGING(queue_time_overall))
8061 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8063 log_write(0, LOG_MAIN, "Completed");
8065 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8066 f.deliver_freeze = FALSE;
8068 #ifndef DISABLE_EVENT
8069 (void) event_raise(event_action, US"msg:complete", NULL);
8073 /* If there are deferred addresses, we are keeping this message because it is
8074 not yet completed. Lose any temporary files that were catching output from
8075 pipes for any of the deferred addresses, handle one-time aliases, and see if
8076 the message has been on the queue for so long that it is time to send a warning
8077 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8078 have the same domain, we can set deliver_domain for the expansion of
8079 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8080 the parent's domain.
8082 If all the deferred addresses have an error number that indicates "retry time
8083 not reached", skip sending the warning message, because it won't contain the
8084 reason for the delay. It will get sent at the next real delivery attempt.
8085 Exception: for retries caused by a remote peer we use the error message
8086 store in the retry DB as the reason.
8087 However, if at least one address has tried, we'd better include all of them in
8090 If we can't make a process to send the message, don't worry.
8092 For mailing list expansions we want to send the warning message to the
8093 mailing list manager. We can't do a perfect job here, as some addresses may
8094 have different errors addresses, but if we take the errors address from
8095 each deferred address it will probably be right in most cases.
8097 If addr_defer == +1, it means there was a problem sending an error message
8098 for failed addresses, and there were no "real" deferred addresses. The value
8099 was set just to keep the message on the spool, so there is nothing to do here.
8102 else if (addr_defer != (address_item *)(+1))
8104 uschar *recipients = US"";
8105 BOOL want_warning_msg = FALSE;
8107 deliver_domain = testflag(addr_defer, af_pfr)
8108 ? addr_defer->parent->domain : addr_defer->domain;
8110 for (address_item * addr = addr_defer; addr; addr = addr->next)
8112 address_item *otaddr;
8114 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8118 const uschar *d = testflag(addr, af_pfr)
8119 ? addr->parent->domain : addr->domain;
8121 /* The domain may be unset for an address that has never been routed
8122 because the system filter froze the message. */
8124 if (!d || Ustrcmp(d, deliver_domain) != 0)
8125 deliver_domain = NULL;
8128 if (addr->return_filename) Uunlink(addr->return_filename);
8130 /* Handle the case of one-time aliases. If any address in the ancestry
8131 of this one is flagged, ensure it is in the recipients list, suitably
8132 flagged, and that its parent is marked delivered. */
8134 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8135 if (otaddr->onetime_parent) break;
8140 int t = recipients_count;
8142 for (i = 0; i < recipients_count; i++)
8144 uschar *r = recipients_list[i].address;
8145 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8146 if (Ustrcmp(otaddr->address, r) == 0) break;
8149 /* Didn't find the address already in the list, and did find the
8150 ultimate parent's address in the list, and they really are different
8151 (i.e. not from an identity-redirect). After adding the recipient,
8152 update the errors address in the recipients list. */
8154 if ( i >= recipients_count && t < recipients_count
8155 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8157 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8158 otaddr->address, otaddr->parent->address);
8159 receive_add_recipient(otaddr->address, t);
8160 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8161 tree_add_nonrecipient(otaddr->parent->address);
8162 update_spool = TRUE;
8166 /* Except for error messages, ensure that either the errors address for
8167 this deferred address or, if there is none, the sender address, is on the
8168 list of recipients for a warning message. */
8170 if (sender_address[0])
8172 uschar * s = addr->prop.errors_address;
8173 if (!s) s = sender_address;
8174 if (Ustrstr(recipients, s) == NULL)
8175 recipients = string_sprintf("%s%s%s", recipients,
8176 recipients[0] ? "," : "", s);
8180 /* Send a warning message if the conditions are right. If the condition check
8181 fails because of a lookup defer, there is nothing we can do. The warning
8182 is not sent. Another attempt will be made at the next delivery attempt (if
8185 if ( !f.queue_2stage
8187 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8188 || addr_defer->dsn_flags & rf_notify_delay
8190 && delay_warning[1] > 0
8191 && sender_address[0] != 0
8192 && ( !delay_warning_condition
8193 || expand_check_condition(delay_warning_condition,
8194 US"delay_warning", US"option")
8200 int queue_time = time(NULL) - received_time.tv_sec;
8202 queue_time = test_harness_fudged_queue_time(queue_time);
8204 /* See how many warnings we should have sent by now */
8206 for (count = 0; count < delay_warning[1]; count++)
8207 if (queue_time < delay_warning[count+2]) break;
8209 show_time = delay_warning[count+1];
8211 if (count >= delay_warning[1])
8214 int last_gap = show_time;
8215 if (count > 1) last_gap -= delay_warning[count];
8216 extra = (queue_time - delay_warning[count+1])/last_gap;
8217 show_time += last_gap * extra;
8223 debug_printf("time on queue = %s id %s addr %s\n",
8224 readconf_printtime(queue_time), message_id, addr_defer->address);
8225 debug_printf("warning counts: required %d done %d\n", count,
8229 /* We have computed the number of warnings there should have been by now.
8230 If there haven't been enough, send one, and up the count to what it should
8233 if (warning_count < count)
8237 pid_t pid = child_open_exim(&fd, US"delay-warning-message");
8243 FILE * f = fdopen(fd, "wb");
8245 transport_ctx tctx = {{0}};
8247 if (warn_message_file)
8248 wmf = expand_open(warn_message_file,
8249 US"warn_message_file", US"warning");
8251 warnmsg_recipients = recipients;
8252 warnmsg_delay = queue_time < 120*60
8253 ? string_sprintf("%d minutes", show_time/60)
8254 : string_sprintf("%d hours", show_time/3600);
8256 if (errors_reply_to)
8257 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8258 fprintf(f, "Auto-Submitted: auto-replied\n");
8260 fprintf(f, "To: %s\n", recipients);
8261 moan_write_references(f, NULL);
8263 /* generated boundary string and output MIME-Headers */
8264 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8266 fprintf(f, "Content-Type: multipart/report;"
8267 " report-type=delivery-status; boundary=%s\n"
8268 "MIME-Version: 1.0\n",
8271 if ((wmf_text = next_emf(wmf, US"header")))
8272 fprintf(f, "%s\n", wmf_text);
8274 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8275 message_id, warnmsg_delay);
8277 /* output human readable part as text/plain section */
8279 "Content-type: text/plain; charset=us-ascii\n\n",
8282 if ((wmf_text = next_emf(wmf, US"intro")))
8283 fprintf(f, "%s", CS wmf_text);
8287 "This message was created automatically by mail delivery software.\n");
8289 if (Ustrcmp(recipients, sender_address) == 0)
8291 "A message that you sent has not yet been delivered to one or more of its\n"
8292 "recipients after more than ");
8296 "A message sent by\n\n <%s>\n\n"
8297 "has not yet been delivered to one or more of its recipients after more than \n",
8300 fprintf(f, "%s on the queue on %s.\n\n"
8301 "The message identifier is: %s\n",
8302 warnmsg_delay, primary_hostname, message_id);
8304 for (h = header_list; h; h = h->next)
8305 if (strncmpic(h->text, US"Subject:", 8) == 0)
8306 fprintf(f, "The subject of the message is: %s", h->text + 9);
8307 else if (strncmpic(h->text, US"Date:", 5) == 0)
8308 fprintf(f, "The date of the message is: %s", h->text + 6);
8311 fprintf(f, "The address%s to which the message has not yet been "
8313 !addr_defer->next ? "" : "es",
8314 !addr_defer->next ? "is": "are");
8317 /* List the addresses, with error information if allowed */
8320 for (address_item * addr = addr_defer; addr; addr = addr->next)
8322 if (print_address_information(addr, f, US" ", US"\n ", US""))
8323 print_address_error(addr, f, US"Delay reason: ");
8332 if ((wmf_text = next_emf(wmf, US"final")))
8333 fprintf(f, "%s", CS wmf_text);
8339 "No action is required on your part. Delivery attempts will continue for\n"
8340 "some time, and this warning may be repeated at intervals if the message\n"
8341 "remains undelivered. Eventually the mail delivery software will give up,\n"
8342 "and when that happens, the message will be returned to you.\n");
8345 /* output machine readable part */
8346 fprintf(f, "\n--%s\n"
8347 "Content-type: message/delivery-status\n\n"
8348 "Reporting-MTA: dns; %s\n",
8350 smtp_active_hostname);
8355 /* must be decoded from xtext: see RFC 3461:6.3a */
8357 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8358 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8360 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8364 for (address_item * addr = addr_defer; addr; addr = addr->next)
8368 print_dsn_addr_action(f, addr, US"delayed", US"4.0.0");
8370 if ((hu = addr->host_used) && hu->name)
8372 fprintf(f, "Remote-MTA: dns; %s\n", hu->name);
8373 print_dsn_diagnostic_code(addr, f);
8379 "Content-type: text/rfc822-headers\n\n",
8383 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8384 tctx.u.fd = fileno(f);
8385 tctx.options = topt_add_return_path | topt_no_body;
8386 transport_filter_argv = NULL; /* Just in case */
8387 return_path = sender_address; /* In case not previously set */
8389 /* Write the original email out */
8390 /*XXX no checking for failure! buggy! */
8391 transport_write_message(&tctx, 0);
8394 fprintf(f,"\n--%s--\n", bound);
8398 /* Close and wait for child process to complete, without a timeout.
8399 If there's an error, don't update the count. */
8402 if (child_close(pid, 0) == 0)
8404 warning_count = count;
8405 update_spool = TRUE; /* Ensure spool rewritten */
8411 /* Clear deliver_domain */
8413 deliver_domain = NULL;
8415 /* If this was a first delivery attempt, unset the first time flag, and
8416 ensure that the spool gets updated. */
8418 if (f.deliver_firsttime)
8420 f.deliver_firsttime = FALSE;
8421 update_spool = TRUE;
8424 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8425 message, unless the message is a local error message (to avoid loops). Then
8426 log the freezing. If the text in "frozen_info" came from a system filter,
8427 it has been escaped into printing characters so as not to mess up log lines.
8428 For the "tell" message, we turn \n back into newline. Also, insert a newline
8429 near the start instead of the ": " string. */
8431 if (f.deliver_freeze)
8433 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8435 uschar *s = string_copy(frozen_info);
8436 uschar *ss = Ustrstr(s, " by the system filter: ");
8447 if (*ss == '\\' && ss[1] == 'n')
8454 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8455 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8459 /* Log freezing just before we update the -H file, to minimize the chance
8460 of a race problem. */
8462 deliver_msglog("*** Frozen%s\n", frozen_info);
8463 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8466 /* If there have been any updates to the non-recipients list, or other things
8467 that get written to the spool, we must now update the spool header file so
8468 that it has the right information for the next delivery attempt. If there
8469 was more than one address being delivered, the header_change update is done
8470 earlier, in case one succeeds and then something crashes. */
8473 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8474 update_spool, f.header_rewritten);
8476 if (update_spool || f.header_rewritten)
8477 /* Panic-dies on error */
8478 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8481 /* Finished with the message log. If the message is complete, it will have
8482 been unlinked or renamed above. */
8484 if (message_logs) (void)fclose(message_log);
8486 /* Now we can close and remove the journal file. Its only purpose is to record
8487 successfully completed deliveries asap so that this information doesn't get
8488 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8489 not serious, as trying it again is not harmful. The journal might not be open
8490 if all addresses were deferred at routing or directing. Nevertheless, we must
8491 remove it if it exists (may have been lying around from a crash during the
8492 previous delivery attempt). We don't remove the journal if a delivery
8493 subprocess failed to pass back delivery information; this is controlled by
8494 the remove_journal flag. When the journal is left, we also don't move the
8495 message off the main spool if frozen and the option is set. It should get moved
8496 at the next attempt, after the journal has been inspected. */
8498 if (journal_fd >= 0) (void)close(journal_fd);
8502 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8504 if (Uunlink(fname) < 0 && errno != ENOENT)
8505 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8508 /* Move the message off the spool if requested */
8510 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8511 if (f.deliver_freeze && move_frozen_messages)
8512 (void)spool_move_message(id, message_subdir, US"", US"F");
8516 /* Closing the data file frees the lock; if the file has been unlinked it
8517 will go away. Otherwise the message becomes available for another process
8520 (void)close(deliver_datafile);
8521 deliver_datafile = -1;
8522 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8523 #ifdef MEASURE_TIMING
8524 report_time_since(×tamp_startup, US"delivery end"); /* testcase 0005 */
8527 /* It is unlikely that there will be any cached resources, since they are
8528 released after routing, and in the delivery subprocesses. However, it's
8529 possible for an expansion for something afterwards (for example,
8530 expand_check_condition) to do a lookup. We must therefore be sure everything is
8534 acl_where = ACL_WHERE_UNKNOWN;
8543 #ifdef EXIM_TFO_PROBE
8546 f.tcp_fastopen_ok = TRUE;
8552 deliver_get_sender_address (uschar * id)
8555 uschar * new_sender_address,
8556 * save_sender_address;
8557 BOOL save_qr = f.queue_running;
8560 /* make spool_open_datafile non-noisy on fail */
8562 f.queue_running = TRUE;
8564 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8566 deliver_datafile = spool_open_datafile(id);
8567 f.queue_running = save_qr;
8568 if (deliver_datafile < 0)
8571 /* Save and restore the global sender_address. I'm not sure if we should
8572 not save/restore all the other global variables too, because
8573 spool_read_header() may change all of them. But OTOH, when this
8574 deliver_get_sender_address() gets called, the current message is done
8575 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8577 spoolname = string_sprintf("%s-H", id);
8578 save_sender_address = sender_address;
8580 rc = spool_read_header(spoolname, TRUE, TRUE);
8582 new_sender_address = sender_address;
8583 sender_address = save_sender_address;
8585 if (rc != spool_read_OK)
8588 assert(new_sender_address);
8590 (void)close(deliver_datafile);
8591 deliver_datafile = -1;
8593 return new_sender_address;
8599 delivery_re_exec(int exec_type)
8603 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8605 int channel_fd = cutthrough.cctx.sock;
8607 smtp_peer_options = cutthrough.peer_options;
8608 continue_sequence = 0;
8611 if (cutthrough.is_tls)
8615 smtp_peer_options |= OPTION_TLS;
8616 sending_ip_address = cutthrough.snd_ip;
8617 sending_port = cutthrough.snd_port;
8619 where = US"socketpair";
8620 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8624 testharness_pause_ms(150);
8625 if ((pid = exim_fork(US"tls-proxy-interproc")) < 0)
8628 if (pid == 0) /* child: will fork again to totally disconnect */
8630 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8632 /* does not return */
8636 waitpid(pid, NULL, 0);
8637 (void) close(channel_fd); /* release the client socket */
8638 channel_fd = pfd[1];
8642 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8643 cutthrough.host.address, message_id, channel_fd);
8647 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8648 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8650 return; /* compiler quietening; control does not reach here. */
8655 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8656 "delivery re-exec %s failed: %s", where, strerror(errno));
8658 /* Get here if exec_type == CEE_EXEC_EXIT.
8659 Note: this must be _exit(), not exit(). */
8661 _exit(EX_EXECFAILED);
8667 /* End of deliver.c */