1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata {
21 address_item *addrlist; /* chain of addresses */
22 address_item *addr; /* next address data expected for */
23 pid_t pid; /* subprocess pid */
24 int fd; /* pipe fd for getting result from subprocess */
25 int transport_count; /* returned transport count value */
26 BOOL done; /* no more data needed */
27 uschar *msg; /* error message */
28 uschar *return_path; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
34 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item *, uschar *);
40 static void address_done(address_item *, uschar *);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item *addr_defer = NULL;
62 static address_item *addr_failed = NULL;
63 static address_item *addr_fallback = NULL;
64 static address_item *addr_local = NULL;
65 static address_item *addr_new = NULL;
66 static address_item *addr_remote = NULL;
67 static address_item *addr_route = NULL;
68 static address_item *addr_succeed = NULL;
69 static address_item *addr_dsntmp = 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 void * next = buffer;
112 void * end = buffer + 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 - 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));
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;
203 /* These may be unset for multiple addresses */
205 deliver_domain = addr->domain;
206 self_hostname = addr->self_hostname;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver = 1; /* deliver by default */
210 bmi_alt_location = NULL;
211 bmi_base64_verdict = NULL;
212 bmi_base64_tracker_verdict = NULL;
215 /* If there's only one address we can set everything. */
219 address_item *addr_orig;
221 deliver_localpart = addr->local_part;
222 deliver_localpart_prefix = addr->prefix;
223 deliver_localpart_suffix = addr->suffix;
225 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
226 deliver_domain_orig = addr_orig->domain;
228 /* Re-instate any prefix and suffix in the original local part. In all
229 normal cases, the address will have a router associated with it, and we can
230 choose the caseful or caseless version accordingly. However, when a system
231 filter sets up a pipe, file, or autoreply delivery, no router is involved.
232 In this case, though, there won't be any prefix or suffix to worry about. */
234 deliver_localpart_orig = !addr_orig->router
235 ? addr_orig->local_part
236 : addr_orig->router->caseful_local_part
237 ? addr_orig->cc_local_part
238 : addr_orig->lc_local_part;
240 /* If there's a parent, make its domain and local part available, and if
241 delivering to a pipe or file, or sending an autoreply, get the local
242 part from the parent. For pipes and files, put the pipe or file string
243 into address_pipe and address_file. */
247 deliver_domain_parent = addr->parent->domain;
248 deliver_localpart_parent = !addr->parent->router
249 ? addr->parent->local_part
250 : addr->parent->router->caseful_local_part
251 ? addr->parent->cc_local_part
252 : addr->parent->lc_local_part;
254 /* File deliveries have their own flag because they need to be picked out
255 as special more often. */
257 if (testflag(addr, af_pfr))
259 if (testflag(addr, af_file)) address_file = addr->local_part;
260 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
261 deliver_localpart = addr->parent->local_part;
262 deliver_localpart_prefix = addr->parent->prefix;
263 deliver_localpart_suffix = addr->parent->suffix;
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 /* Set expansion variables related to Brightmail AntiSpam */
269 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
270 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
271 /* get message delivery status (0 - don't deliver | 1 - deliver) */
272 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
273 /* if message is to be delivered, get eventual alternate location */
274 if (bmi_deliver == 1)
275 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
280 /* For multiple addresses, don't set local part, and leave the domain and
281 self_hostname set only if it is the same for all of them. It is possible to
282 have multiple pipe and file addresses, but only when all addresses have routed
283 to the same pipe or file. */
287 if (testflag(addr, af_pfr))
289 if (testflag(addr, af_file)) address_file = addr->local_part;
290 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
292 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
294 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
295 deliver_domain = NULL;
297 && ( !addr2->self_hostname
298 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
300 self_hostname = NULL;
301 if (!deliver_domain && !self_hostname) break;
309 /*************************************************
310 * Open a msglog file *
311 *************************************************/
313 /* This function is used both for normal message logs, and for files in the
314 msglog directory that are used to catch output from pipes. Try to create the
315 directory if it does not exist. From release 4.21, normal message logs should
316 be created when the message is received.
318 Called from deliver_message(), can be operating as root.
321 filename the file name
322 mode the mode required
323 error used for saying what failed
325 Returns: a file descriptor, or -1 (with errno set)
329 open_msglog_file(uschar *filename, int mode, uschar **error)
331 for (int i = 2; i > 0; i--)
333 int fd = Uopen(filename,
340 O_WRONLY|O_APPEND|O_CREAT, mode);
343 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
344 function is called as root). Double check the mode, because the group setting
345 doesn't always get set automatically. */
348 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
350 if (fchown(fd, exim_uid, exim_gid) < 0)
355 if (fchmod(fd, mode) < 0)
365 (void)directory_make(spool_directory,
366 spool_sname(US"msglog", message_subdir),
367 MSGLOG_DIRECTORY_MODE, TRUE);
377 /*************************************************
378 * Write to msglog if required *
379 *************************************************/
381 /* Write to the message log, if configured. This function may also be called
385 format a string format
391 deliver_msglog(const char *format, ...)
394 if (!message_logs) return;
395 va_start(ap, format);
396 vfprintf(message_log, format, ap);
404 /*************************************************
405 * Replicate status for batch *
406 *************************************************/
408 /* When a transport handles a batch of addresses, it may treat them
409 individually, or it may just put the status in the first one, and return FALSE,
410 requesting that the status be copied to all the others externally. This is the
411 replication function. As well as the status, it copies the transport pointer,
412 which may have changed if appendfile passed the addresses on to a different
415 Argument: pointer to the first address in a chain
420 replicate_status(address_item *addr)
422 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
424 addr2->transport = addr->transport;
425 addr2->transport_return = addr->transport_return;
426 addr2->basic_errno = addr->basic_errno;
427 addr2->more_errno = addr->more_errno;
428 addr2->delivery_usec = addr->delivery_usec;
429 addr2->special_action = addr->special_action;
430 addr2->message = addr->message;
431 addr2->user_message = addr->user_message;
437 /*************************************************
438 * Compare lists of hosts *
439 *************************************************/
441 /* This function is given two pointers to chains of host items, and it yields
442 TRUE if the lists refer to the same hosts in the same order, except that
444 (1) Multiple hosts with the same non-negative MX values are permitted to appear
445 in different orders. Round-robinning nameservers can cause this to happen.
447 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
448 permitted to appear in different orders. This is caused by randomizing
451 This enables Exim to use a single SMTP transaction for sending to two entirely
452 different domains that happen to end up pointing at the same hosts.
455 one points to the first host list
456 two points to the second host list
458 Returns: TRUE if the lists refer to the same host set
462 same_hosts(host_item *one, host_item *two)
466 if (Ustrcmp(one->name, two->name) != 0)
469 host_item *end_one = one;
470 host_item *end_two = two;
472 /* Batch up only if there was no MX and the list was not randomized */
474 if (mx == MX_NONE) return FALSE;
476 /* Find the ends of the shortest sequence of identical MX values */
478 while ( end_one->next && end_one->next->mx == mx
479 && end_two->next && end_two->next->mx == mx)
481 end_one = end_one->next;
482 end_two = end_two->next;
485 /* If there aren't any duplicates, there's no match. */
487 if (end_one == one) return FALSE;
489 /* For each host in the 'one' sequence, check that it appears in the 'two'
490 sequence, returning FALSE if not. */
495 for (hi = two; hi != end_two->next; hi = hi->next)
496 if (Ustrcmp(one->name, hi->name) == 0) break;
497 if (hi == end_two->next) return FALSE;
498 if (one == end_one) break;
502 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
503 Ensure both are pointing at the last host, and carry on as for equality. */
508 /* if the names matched but ports do not, mismatch */
509 else if (one->port != two->port)
518 /* True if both are NULL */
525 /*************************************************
526 * Compare header lines *
527 *************************************************/
529 /* This function is given two pointers to chains of header items, and it yields
530 TRUE if they are the same header texts in the same order.
533 one points to the first header list
534 two points to the second header list
536 Returns: TRUE if the lists refer to the same header set
540 same_headers(header_line *one, header_line *two)
542 for (;; one = one->next, two = two->next)
544 if (one == two) return TRUE; /* Includes the case where both NULL */
545 if (!one || !two) return FALSE;
546 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
552 /*************************************************
553 * Compare string settings *
554 *************************************************/
556 /* This function is given two pointers to strings, and it returns
557 TRUE if they are the same pointer, or if the two strings are the same.
560 one points to the first string
561 two points to the second string
563 Returns: TRUE or FALSE
567 same_strings(uschar *one, uschar *two)
569 if (one == two) return TRUE; /* Includes the case where both NULL */
570 if (!one || !two) return FALSE;
571 return (Ustrcmp(one, two) == 0);
576 /*************************************************
577 * Compare uid/gid for addresses *
578 *************************************************/
580 /* This function is given a transport and two addresses. It yields TRUE if the
581 uid/gid/initgroups settings for the two addresses are going to be the same when
586 addr1 the first address
587 addr2 the second address
589 Returns: TRUE or FALSE
593 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
595 if ( !tp->uid_set && !tp->expand_uid
596 && !tp->deliver_as_creator
597 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
598 || ( testflag(addr1, af_uid_set)
599 && ( addr1->uid != addr2->uid
600 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
604 if ( !tp->gid_set && !tp->expand_gid
605 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
606 || ( testflag(addr1, af_gid_set)
607 && addr1->gid != addr2->gid
617 /*************************************************
618 * Record that an address is complete *
619 *************************************************/
621 /* This function records that an address is complete. This is straightforward
622 for most addresses, where the unique address is just the full address with the
623 domain lower cased. For homonyms (addresses that are the same as one of their
624 ancestors) their are complications. Their unique addresses have \x\ prepended
625 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
628 Exim used to record the unique addresses of homonyms as "complete". This,
629 however, fails when the pattern of redirection varies over time (e.g. if taking
630 unseen copies at only some times of day) because the prepended numbers may vary
631 from one delivery run to the next. This problem is solved by never recording
632 prepended unique addresses as complete. Instead, when a homonymic address has
633 actually been delivered via a transport, we record its basic unique address
634 followed by the name of the transport. This is checked in subsequent delivery
635 runs whenever an address is routed to a transport.
637 If the completed address is a top-level one (has no parent, which means it
638 cannot be homonymic) we also add the original address to the non-recipients
639 tree, so that it gets recorded in the spool file and therefore appears as
640 "done" in any spool listings. The original address may differ from the unique
641 address in the case of the domain.
643 Finally, this function scans the list of duplicates, marks as done any that
644 match this address, and calls child_done() for their ancestors.
647 addr address item that has been completed
648 now current time as a string
654 address_done(address_item *addr, uschar *now)
656 update_spool = TRUE; /* Ensure spool gets updated */
658 /* Top-level address */
662 tree_add_nonrecipient(addr->unique);
663 tree_add_nonrecipient(addr->address);
666 /* Homonymous child address */
668 else if (testflag(addr, af_homonym))
671 tree_add_nonrecipient(
672 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
675 /* Non-homonymous child address */
677 else tree_add_nonrecipient(addr->unique);
679 /* Check the list of duplicate addresses and ensure they are now marked
682 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
683 if (Ustrcmp(addr->unique, dup->unique) == 0)
685 tree_add_nonrecipient(dup->unique);
686 child_done(dup, now);
693 /*************************************************
694 * Decrease counts in parents and mark done *
695 *************************************************/
697 /* This function is called when an address is complete. If there is a parent
698 address, its count of children is decremented. If there are still other
699 children outstanding, the function exits. Otherwise, if the count has become
700 zero, address_done() is called to mark the parent and its duplicates complete.
701 Then loop for any earlier ancestors.
704 addr points to the completed address item
705 now the current time as a string, for writing to the message log
711 child_done(address_item *addr, uschar *now)
718 if (--addr->child_count > 0) return; /* Incomplete parent */
719 address_done(addr, now);
721 /* Log the completion of all descendents only when there is no ancestor with
722 the same original address. */
724 for (aa = addr->parent; aa; aa = aa->parent)
725 if (Ustrcmp(aa->address, addr->address) == 0) break;
728 deliver_msglog("%s %s: children all complete\n", now, addr->address);
729 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
735 /*************************************************
736 * Delivery logging support functions *
737 *************************************************/
739 /* The LOGGING() checks in d_log_interface() are complicated for backwards
740 compatibility. When outgoing interface logging was originally added, it was
741 conditional on just incoming_interface (which is off by default). The
742 outgoing_interface option is on by default to preserve this behaviour, but
743 you can enable incoming_interface and disable outgoing_interface to get I=
744 fields on incoming lines only.
748 addr The address to be logged
750 Returns: New value for s
754 d_log_interface(gstring * g)
756 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
757 && sending_ip_address)
759 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
760 if (LOGGING(outgoing_port))
761 g = string_fmt_append(g, "%d", sending_port);
769 d_hostlog(gstring * g, address_item * addr)
771 host_item * h = addr->host_used;
773 g = string_append(g, 2, US" H=", h->name);
775 if (LOGGING(dnssec) && h->dnssec == DS_YES)
776 g = string_catn(g, US" DS", 3);
778 g = string_append(g, 3, US" [", h->address, US"]");
780 if (LOGGING(outgoing_port))
781 g = string_fmt_append(g, ":%d", h->port);
784 if (LOGGING(proxy) && proxy_local_address)
786 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
787 if (LOGGING(outgoing_port))
788 g = string_fmt_append(g, ":%d", proxy_local_port);
792 g = d_log_interface(g);
794 if (testflag(addr, af_tcp_fastopen))
795 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
806 d_tlslog(gstring * s, address_item * addr)
808 if (LOGGING(tls_cipher) && addr->cipher)
809 s = string_append(s, 2, US" X=", addr->cipher);
810 if (LOGGING(tls_certificate_verified) && addr->cipher)
811 s = string_append(s, 2, US" CV=",
812 testflag(addr, af_cert_verified)
815 testflag(addr, af_dane_verified)
821 if (LOGGING(tls_peerdn) && addr->peerdn)
822 s = string_append(s, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
830 #ifndef DISABLE_EVENT
832 event_raise(uschar * action, const uschar * event, uschar * ev_data)
838 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
840 action, deliver_host_address);
843 event_data = ev_data;
845 if (!(s = expand_string(action)) && *expand_string_message)
846 log_write(0, LOG_MAIN|LOG_PANIC,
847 "failed to expand event_action %s in %s: %s\n",
848 event, transport_name ? transport_name : US"main", expand_string_message);
850 event_name = event_data = NULL;
852 /* If the expansion returns anything but an empty string, flag for
853 the caller to modify his normal processing
858 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
867 msg_event_raise(const uschar * event, const address_item * addr)
869 const uschar * save_domain = deliver_domain;
870 uschar * save_local = deliver_localpart;
871 const uschar * save_host = deliver_host;
872 const uschar * save_address = deliver_host_address;
873 const int save_port = deliver_host_port;
875 router_name = addr->router ? addr->router->name : NULL;
876 deliver_domain = addr->domain;
877 deliver_localpart = addr->local_part;
878 deliver_host = addr->host_used ? addr->host_used->name : NULL;
880 if (!addr->transport)
882 if (Ustrcmp(event, "msg:fail:delivery") == 0)
884 /* An address failed with no transport involved. This happens when
885 a filter was used which triggered a fail command (in such a case
886 a transport isn't needed). Convert it to an internal fail event. */
888 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
893 transport_name = addr->transport->name;
895 (void) event_raise(addr->transport->event_action, event,
897 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
898 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
899 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
900 ? addr->message : NULL);
903 deliver_host_port = save_port;
904 deliver_host_address = save_address;
905 deliver_host = save_host;
906 deliver_localpart = save_local;
907 deliver_domain = save_domain;
908 router_name = transport_name = NULL;
910 #endif /*DISABLE_EVENT*/
914 /******************************************************************************/
917 /*************************************************
918 * Generate local prt for logging *
919 *************************************************/
921 /* This function is a subroutine for use in string_log_address() below.
924 addr the address being logged
925 yield the current dynamic buffer pointer
927 Returns: the new value of the buffer pointer
931 string_get_localpart(address_item * addr, gstring * yield)
936 if (testflag(addr, af_include_affixes) && s)
939 if (testflag(addr, af_utf8_downcvt))
940 s = string_localpart_utf8_to_alabel(s, NULL);
942 yield = string_cat(yield, s);
945 s = addr->local_part;
947 if (testflag(addr, af_utf8_downcvt))
948 s = string_localpart_utf8_to_alabel(s, NULL);
950 yield = string_cat(yield, s);
953 if (testflag(addr, af_include_affixes) && s)
956 if (testflag(addr, af_utf8_downcvt))
957 s = string_localpart_utf8_to_alabel(s, NULL);
959 yield = string_cat(yield, s);
966 /*************************************************
967 * Generate log address list *
968 *************************************************/
970 /* This function generates a list consisting of an address and its parents, for
971 use in logging lines. For saved onetime aliased addresses, the onetime parent
972 field is used. If the address was delivered by a transport with rcpt_include_
973 affixes set, the af_include_affixes bit will be set in the address. In that
974 case, we include the affixes here too.
977 g points to growing-string struct
978 addr bottom (ultimate) address
979 all_parents if TRUE, include all parents
980 success TRUE for successful delivery
982 Returns: a growable string in dynamic store
986 string_log_address(gstring * g,
987 address_item *addr, BOOL all_parents, BOOL success)
989 BOOL add_topaddr = TRUE;
990 address_item *topaddr;
992 /* Find the ultimate parent */
994 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
996 /* We start with just the local part for pipe, file, and reply deliveries, and
997 for successful local deliveries from routers that have the log_as_local flag
998 set. File deliveries from filters can be specified as non-absolute paths in
999 cases where the transport is going to complete the path. If there is an error
1000 before this happens (expansion failure) the local part will not be updated, and
1001 so won't necessarily look like a path. Add extra text for this case. */
1003 if ( testflag(addr, af_pfr)
1005 && addr->router && addr->router->log_as_local
1006 && addr->transport && addr->transport->info->local
1009 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1010 g = string_catn(g, CUS"save ", 5);
1011 g = string_get_localpart(addr, g);
1014 /* Other deliveries start with the full address. It we have split it into local
1015 part and domain, use those fields. Some early failures can happen before the
1016 splitting is done; in those cases use the original field. */
1020 uschar * cmp = g->s + g->ptr;
1022 if (addr->local_part)
1025 g = string_get_localpart(addr, g);
1026 g = string_catn(g, US"@", 1);
1029 if (testflag(addr, af_utf8_downcvt))
1030 s = string_localpart_utf8_to_alabel(s, NULL);
1032 g = string_cat(g, s);
1035 g = string_cat(g, addr->address);
1037 /* If the address we are going to print is the same as the top address,
1038 and all parents are not being included, don't add on the top address. First
1039 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1040 on the local parts. */
1042 string_from_gstring(g); /* ensure nul-terminated */
1043 if ( strcmpic(cmp, topaddr->address) == 0
1044 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1045 && !addr->onetime_parent
1046 && (!all_parents || !addr->parent || addr->parent == topaddr)
1048 add_topaddr = FALSE;
1051 /* If all parents are requested, or this is a local pipe/file/reply, and
1052 there is at least one intermediate parent, show it in brackets, and continue
1053 with all of them if all are wanted. */
1055 if ( (all_parents || testflag(addr, af_pfr))
1057 && addr->parent != topaddr)
1060 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1062 g = string_catn(g, s, 2);
1063 g = string_cat (g, addr2->address);
1064 if (!all_parents) break;
1067 g = string_catn(g, US")", 1);
1070 /* Add the top address if it is required */
1073 g = string_append(g, 3,
1075 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1084 timesince(struct timeval * diff, struct timeval * then)
1086 gettimeofday(diff, NULL);
1087 diff->tv_sec -= then->tv_sec;
1088 if ((diff->tv_usec -= then->tv_usec) < 0)
1091 diff->tv_usec += 1000*1000;
1098 string_timediff(struct timeval * diff)
1100 static uschar buf[sizeof("0.000s")];
1102 if (diff->tv_sec >= 5 || !LOGGING(millisec))
1103 return readconf_printtime((int)diff->tv_sec);
1105 sprintf(CS buf, "%u.%03us", (uint)diff->tv_sec, (uint)diff->tv_usec/1000);
1111 string_timesince(struct timeval * then)
1113 struct timeval diff;
1115 timesince(&diff, then);
1116 return string_timediff(&diff);
1119 /******************************************************************************/
1123 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1124 this is a nonstandard call; no two-character delivery flag is written
1125 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1128 flags passed to log_write()
1131 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1133 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1134 void * reset_point; /* released afterwards. */
1136 /* Log the delivery on the main log. We use an extensible string to build up
1137 the log line, and reset the store afterwards. Remote deliveries should always
1138 have a pointer to the host item that succeeded; local deliveries can have a
1139 pointer to a single host item in their host list, for use by the transport. */
1141 #ifndef DISABLE_EVENT
1142 /* presume no successful remote delivery */
1143 lookup_dnssec_authenticated = NULL;
1146 g = reset_point = string_get(256);
1149 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1152 g->s[0] = logchar; g->ptr = 1;
1153 g = string_catn(g, US"> ", 2);
1155 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1157 if (LOGGING(sender_on_delivery) || msg)
1158 g = string_append(g, 3, US" F=<",
1160 testflag(addr, af_utf8_downcvt)
1161 ? string_address_utf8_to_alabel(sender_address, NULL)
1168 g = string_append(g, 2, US" Q=", queue_name);
1170 #ifdef EXPERIMENTAL_SRS
1171 if(addr->prop.srs_sender)
1172 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1175 /* You might think that the return path must always be set for a successful
1176 delivery; indeed, I did for some time, until this statement crashed. The case
1177 when it is not set is for a delivery to /dev/null which is optimised by not
1178 being run at all. */
1180 if (used_return_path && LOGGING(return_path_on_delivery))
1181 g = string_append(g, 3, US" P=<", used_return_path, US">");
1184 g = string_append(g, 2, US" ", msg);
1186 /* For a delivery from a system filter, there may not be a router */
1188 g = string_append(g, 2, US" R=", addr->router->name);
1190 g = string_append(g, 2, US" T=", addr->transport->name);
1192 if (LOGGING(delivery_size))
1193 g = string_fmt_append(g, " S=%d", transport_count);
1195 /* Local delivery */
1197 if (addr->transport->info->local)
1199 if (addr->host_list)
1200 g = string_append(g, 2, US" H=", addr->host_list->name);
1201 g = d_log_interface(g);
1202 if (addr->shadow_message)
1203 g = string_cat(g, addr->shadow_message);
1206 /* Remote delivery */
1210 if (addr->host_used)
1212 g = d_hostlog(g, addr);
1213 if (continue_sequence > 1)
1214 g = string_catn(g, US"*", 1);
1216 #ifndef DISABLE_EVENT
1217 deliver_host_address = addr->host_used->address;
1218 deliver_host_port = addr->host_used->port;
1219 deliver_host = addr->host_used->name;
1221 /* DNS lookup status */
1222 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1223 : addr->host_used->dnssec==DS_NO ? US"no"
1229 g = d_tlslog(g, addr);
1232 if (addr->authenticator)
1234 g = string_append(g, 2, US" A=", addr->authenticator);
1237 g = string_append(g, 2, US":", addr->auth_id);
1238 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1239 g = string_append(g, 2, US":", addr->auth_sndr);
1243 if (LOGGING(pipelining))
1245 if (testflag(addr, af_pipelining))
1246 g = string_catn(g, US" L", 2);
1247 #ifdef EXPERIMENTAL_PIPE_CONNECT
1248 if (testflag(addr, af_early_pipe))
1249 g = string_catn(g, US"*", 1);
1253 #ifndef DISABLE_PRDR
1254 if (testflag(addr, af_prdr_used))
1255 g = string_catn(g, US" PRDR", 5);
1258 if (testflag(addr, af_chunking_used))
1259 g = string_catn(g, US" K", 2);
1262 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1264 if ( LOGGING(smtp_confirmation)
1266 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1269 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1270 uschar *p = big_buffer;
1271 uschar *ss = addr->message;
1273 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1275 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1280 g = string_append(g, 2, US" C=", big_buffer);
1283 /* Time on queue and actual time taken to deliver */
1285 if (LOGGING(queue_time))
1286 g = string_append(g, 2, US" QT=",
1287 string_timesince(&received_time));
1289 if (LOGGING(deliver_time))
1291 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1292 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1295 /* string_cat() always leaves room for the terminator. Release the
1296 store we used to build the line after writing it. */
1298 log_write(0, flags, "%s", string_from_gstring(g));
1300 #ifndef DISABLE_EVENT
1301 if (!msg) msg_event_raise(US"msg:delivery", addr);
1304 store_reset(reset_point);
1311 deferral_log(address_item * addr, uschar * now,
1312 int logflags, uschar * driver_name, uschar * driver_kind)
1317 /* Build up the line that is used for both the message log and the main
1320 g = reset_point = string_get(256);
1322 /* Create the address string for logging. Must not do this earlier, because
1323 an OK result may be changed to FAIL when a pipe returns text. */
1325 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1328 g = string_append(g, 2, US" Q=", queue_name);
1330 /* Either driver_name contains something and driver_kind contains
1331 " router" or " transport" (note the leading space), or driver_name is
1332 a null string and driver_kind contains "routing" without the leading
1333 space, if all routing has been deferred. When a domain has been held,
1334 so nothing has been done at all, both variables contain null strings. */
1338 if (driver_kind[1] == 't' && addr->router)
1339 g = string_append(g, 2, US" R=", addr->router->name);
1340 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1342 else if (driver_kind)
1343 g = string_append(g, 2, US" ", driver_kind);
1345 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1347 if (addr->basic_errno > 0)
1348 g = string_append(g, 2, US": ",
1349 US strerror(addr->basic_errno));
1351 if (addr->host_used)
1353 g = string_append(g, 5,
1354 US" H=", addr->host_used->name,
1355 US" [", addr->host_used->address, US"]");
1356 if (LOGGING(outgoing_port))
1358 int port = addr->host_used->port;
1359 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1364 g = string_append(g, 2, US": ", addr->message);
1366 (void) string_from_gstring(g);
1368 /* Log the deferment in the message log, but don't clutter it
1369 up with retry-time defers after the first delivery attempt. */
1371 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1372 deliver_msglog("%s %s\n", now, g->s);
1374 /* Write the main log and reset the store.
1375 For errors of the type "retry time not reached" (also remotes skipped
1376 on queue run), logging is controlled by L_retry_defer. Note that this kind
1377 of error number is negative, and all the retry ones are less than any
1381 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1384 store_reset(reset_point);
1391 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1394 gstring * g = reset_point = string_get(256);
1396 #ifndef DISABLE_EVENT
1397 /* Message failures for which we will send a DSN get their event raised
1398 later so avoid doing it here. */
1400 if ( !addr->prop.ignore_error
1401 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1403 msg_event_raise(US"msg:fail:delivery", addr);
1406 /* Build up the log line for the message and main logs */
1408 /* Create the address string for logging. Must not do this earlier, because
1409 an OK result may be changed to FAIL when a pipe returns text. */
1411 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1413 if (LOGGING(sender_on_delivery))
1414 g = string_append(g, 3, US" F=<", sender_address, US">");
1417 g = string_append(g, 2, US" Q=", queue_name);
1419 /* Return path may not be set if no delivery actually happened */
1421 if (used_return_path && LOGGING(return_path_on_delivery))
1422 g = string_append(g, 3, US" P=<", used_return_path, US">");
1425 g = string_append(g, 2, US" R=", addr->router->name);
1426 if (addr->transport)
1427 g = string_append(g, 2, US" T=", addr->transport->name);
1429 if (addr->host_used)
1430 g = d_hostlog(g, addr);
1433 g = d_tlslog(g, addr);
1436 if (addr->basic_errno > 0)
1437 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1440 g = string_append(g, 2, US": ", addr->message);
1442 (void) string_from_gstring(g);
1444 /* Do the logging. For the message log, "routing failed" for those cases,
1445 just to make it clearer. */
1448 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1450 deliver_msglog("%s %s\n", now, g->s);
1452 log_write(0, LOG_MAIN, "** %s", g->s);
1454 store_reset(reset_point);
1460 /*************************************************
1461 * Actions at the end of handling an address *
1462 *************************************************/
1464 /* This is a function for processing a single address when all that can be done
1465 with it has been done.
1468 addr points to the address block
1469 result the result of the delivery attempt
1470 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1471 driver_type indicates which type of driver (transport, or router) was last
1472 to process the address
1473 logchar '=' or '-' for use when logging deliveries with => or ->
1479 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1482 uschar *now = tod_stamp(tod_log);
1483 uschar *driver_kind = NULL;
1484 uschar *driver_name = NULL;
1486 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1488 /* Set up driver kind and name for logging. Disable logging if the router or
1489 transport has disabled it. */
1491 if (driver_type == EXIM_DTYPE_TRANSPORT)
1493 if (addr->transport)
1495 driver_name = addr->transport->name;
1496 driver_kind = US" transport";
1497 f.disable_logging = addr->transport->disable_logging;
1499 else driver_kind = US"transporting";
1501 else if (driver_type == EXIM_DTYPE_ROUTER)
1505 driver_name = addr->router->name;
1506 driver_kind = US" router";
1507 f.disable_logging = addr->router->disable_logging;
1509 else driver_kind = US"routing";
1512 /* If there's an error message set, ensure that it contains only printing
1513 characters - it should, but occasionally things slip in and this at least
1514 stops the log format from getting wrecked. We also scan the message for an LDAP
1515 expansion item that has a password setting, and flatten the password. This is a
1516 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1517 malformed, it won't ever have gone near LDAP.) */
1521 const uschar * s = string_printing(addr->message);
1523 /* deconst cast ok as string_printing known to have alloc'n'copied */
1524 addr->message = expand_hide_passwords(US s);
1527 /* If we used a transport that has one of the "return_output" options set, and
1528 if it did in fact generate some output, then for return_output we treat the
1529 message as failed if it was not already set that way, so that the output gets
1530 returned to the sender, provided there is a sender to send it to. For
1531 return_fail_output, do this only if the delivery failed. Otherwise we just
1532 unlink the file, and remove the name so that if the delivery failed, we don't
1533 try to send back an empty or unwanted file. The log_output options operate only
1534 on a non-empty file.
1536 In any case, we close the message file, because we cannot afford to leave a
1537 file-descriptor for one address while processing (maybe very many) others. */
1539 if (addr->return_file >= 0 && addr->return_filename)
1541 BOOL return_output = FALSE;
1542 struct stat statbuf;
1543 (void)EXIMfsync(addr->return_file);
1545 /* If there is no output, do nothing. */
1547 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1549 transport_instance *tb = addr->transport;
1551 /* Handle logging options */
1554 || result == FAIL && tb->log_fail_output
1555 || result == DEFER && tb->log_defer_output
1559 FILE *f = Ufopen(addr->return_filename, "rb");
1561 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1562 "from %s transport: %s", addr->return_filename, tb->name,
1565 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1567 uschar *p = big_buffer + Ustrlen(big_buffer);
1569 while (p > big_buffer && isspace(p[-1])) p--;
1571 sp = string_printing(big_buffer);
1572 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1573 addr->address, tb->name, sp);
1578 /* Handle returning options, but only if there is an address to return
1581 if (sender_address[0] != 0 || addr->prop.errors_address)
1582 if (tb->return_output)
1584 addr->transport_return = result = FAIL;
1585 if (addr->basic_errno == 0 && !addr->message)
1586 addr->message = US"return message generated";
1587 return_output = TRUE;
1590 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1593 /* Get rid of the file unless it might be returned, but close it in
1598 Uunlink(addr->return_filename);
1599 addr->return_filename = NULL;
1600 addr->return_file = -1;
1603 (void)close(addr->return_file);
1606 /* The success case happens only after delivery by a transport. */
1610 addr->next = addr_succeed;
1611 addr_succeed = addr;
1613 /* Call address_done() to ensure that we don't deliver to this address again,
1614 and write appropriate things to the message log. If it is a child address, we
1615 call child_done() to scan the ancestors and mark them complete if this is the
1616 last child to complete. */
1618 address_done(addr, now);
1619 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1622 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1623 driver_name, driver_kind);
1626 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1627 addr->parent->address, driver_name, driver_kind);
1628 child_done(addr, now);
1631 /* Certificates for logging (via events) */
1633 tls_out.ourcert = addr->ourcert;
1634 addr->ourcert = NULL;
1635 tls_out.peercert = addr->peercert;
1636 addr->peercert = NULL;
1638 tls_out.cipher = addr->cipher;
1639 tls_out.peerdn = addr->peerdn;
1640 tls_out.ocsp = addr->ocsp;
1641 # ifdef SUPPORT_DANE
1642 tls_out.dane_verified = testflag(addr, af_dane_verified);
1646 delivery_log(LOG_MAIN, addr, logchar, NULL);
1649 tls_free_cert(&tls_out.ourcert);
1650 tls_free_cert(&tls_out.peercert);
1651 tls_out.cipher = NULL;
1652 tls_out.peerdn = NULL;
1653 tls_out.ocsp = OCSP_NOT_REQ;
1654 # ifdef SUPPORT_DANE
1655 tls_out.dane_verified = FALSE;
1661 /* Soft failure, or local delivery process failed; freezing may be
1664 else if (result == DEFER || result == PANIC)
1666 if (result == PANIC) logflags |= LOG_PANIC;
1668 /* This puts them on the chain in reverse order. Do not change this, because
1669 the code for handling retries assumes that the one with the retry
1670 information is last. */
1672 addr->next = addr_defer;
1675 /* The only currently implemented special action is to freeze the
1676 message. Logging of this is done later, just before the -H file is
1679 if (addr->special_action == SPECIAL_FREEZE)
1681 f.deliver_freeze = TRUE;
1682 deliver_frozen_at = time(NULL);
1683 update_spool = TRUE;
1686 /* If doing a 2-stage queue run, we skip writing to either the message
1687 log or the main log for SMTP defers. */
1689 if (!f.queue_2stage || addr->basic_errno != 0)
1690 deferral_log(addr, now, logflags, driver_name, driver_kind);
1694 /* Hard failure. If there is an address to which an error message can be sent,
1695 put this address on the failed list. If not, put it on the deferred list and
1696 freeze the mail message for human attention. The latter action can also be
1697 explicitly requested by a router or transport. */
1701 /* If this is a delivery error, or a message for which no replies are
1702 wanted, and the message's age is greater than ignore_bounce_errors_after,
1703 force the af_ignore_error flag. This will cause the address to be discarded
1704 later (with a log entry). */
1706 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1707 addr->prop.ignore_error = TRUE;
1709 /* Freeze the message if requested, or if this is a bounce message (or other
1710 message with null sender) and this address does not have its own errors
1711 address. However, don't freeze if errors are being ignored. The actual code
1712 to ignore occurs later, instead of sending a message. Logging of freezing
1713 occurs later, just before writing the -H file. */
1715 if ( !addr->prop.ignore_error
1716 && ( addr->special_action == SPECIAL_FREEZE
1717 || (sender_address[0] == 0 && !addr->prop.errors_address)
1720 frozen_info = addr->special_action == SPECIAL_FREEZE
1722 : f.sender_local && !f.local_error_message
1723 ? US" (message created with -f <>)"
1724 : US" (delivery error message)";
1725 f.deliver_freeze = TRUE;
1726 deliver_frozen_at = time(NULL);
1727 update_spool = TRUE;
1729 /* The address is put on the defer rather than the failed queue, because
1730 the message is being retained. */
1732 addr->next = addr_defer;
1736 /* Don't put the address on the nonrecipients tree yet; wait until an
1737 error message has been successfully sent. */
1741 addr->next = addr_failed;
1745 failure_log(addr, driver_name ? NULL : driver_kind, now);
1748 /* Ensure logging is turned on again in all cases */
1750 f.disable_logging = FALSE;
1756 /*************************************************
1757 * Address-independent error *
1758 *************************************************/
1760 /* This function is called when there's an error that is not dependent on a
1761 particular address, such as an expansion string failure. It puts the error into
1762 all the addresses in a batch, logs the incident on the main and panic logs, and
1763 clears the expansions. It is mostly called from local_deliver(), but can be
1764 called for a remote delivery via findugid().
1767 logit TRUE if (MAIN+PANIC) logging required
1768 addr the first of the chain of addresses
1770 format format string for error message, or NULL if already set in addr
1771 ... arguments for the format
1777 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1779 addr->basic_errno = code;
1786 va_start(ap, format);
1787 g = string_vformat(NULL, TRUE, CS format, ap);
1789 addr->message = string_from_gstring(g);
1792 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1794 addr2->basic_errno = code;
1795 addr2->message = addr->message;
1798 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1799 deliver_set_expansions(NULL);
1805 /*************************************************
1806 * Check a "never users" list *
1807 *************************************************/
1809 /* This function is called to check whether a uid is on one of the two "never
1813 uid the uid to be checked
1814 nusers the list to be scanned; the first item in the list is the count
1816 Returns: TRUE if the uid is on the list
1820 check_never_users(uid_t uid, uid_t *nusers)
1822 if (!nusers) return FALSE;
1823 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1829 /*************************************************
1830 * Find uid and gid for a transport *
1831 *************************************************/
1833 /* This function is called for both local and remote deliveries, to find the
1834 uid/gid under which to run the delivery. The values are taken preferentially
1835 from the transport (either explicit or deliver_as_creator), then from the
1836 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1837 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1838 panic error is logged, and the function fails (which normally leads to delivery
1842 addr the address (possibly a chain)
1844 uidp pointer to uid field
1845 gidp pointer to gid field
1846 igfp pointer to the use_initgroups field
1848 Returns: FALSE if failed - error has been set in address(es)
1852 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1856 BOOL gid_set = FALSE;
1858 /* Default initgroups flag comes from the transport */
1860 *igfp = tp->initgroups;
1862 /* First see if there's a gid on the transport, either fixed or expandable.
1863 The expanding function always logs failure itself. */
1870 else if (tp->expand_gid)
1872 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1875 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1881 /* If the transport did not set a group, see if the router did. */
1883 if (!gid_set && testflag(addr, af_gid_set))
1889 /* Pick up a uid from the transport if one is set. */
1891 if (tp->uid_set) *uidp = tp->uid;
1893 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1894 it does not provide a passwd value from which a gid can be taken. */
1896 else if (tp->expand_uid)
1899 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1900 uidp, &(addr->message)))
1902 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1912 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1914 else if (tp->deliver_as_creator)
1916 *uidp = originator_uid;
1919 *gidp = originator_gid;
1924 /* Otherwise see if the address specifies the uid and if so, take it and its
1927 else if (testflag(addr, af_uid_set))
1930 *igfp = testflag(addr, af_initgroups);
1933 /* Nothing has specified the uid - default to the Exim user, and group if the
1946 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1947 defaulting to the Exim uid. In other words, if the configuration has specified
1948 a uid, it must also provide a gid. */
1952 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1953 "%s transport", tp->name);
1957 /* Check that the uid is not on the lists of banned uids that may not be used
1958 for delivery processes. */
1960 nuname = check_never_users(*uidp, never_users)
1962 : check_never_users(*uidp, fixed_never_users)
1963 ? US"fixed_never_users"
1967 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1968 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1980 /*************************************************
1981 * Check the size of a message for a transport *
1982 *************************************************/
1984 /* Checks that the message isn't too big for the selected transport.
1985 This is called only when it is known that the limit is set.
1989 addr the (first) address being delivered
1992 DEFER expansion failed or did not yield an integer
1993 FAIL message too big
1997 check_message_size(transport_instance *tp, address_item *addr)
2002 deliver_set_expansions(addr);
2003 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
2004 deliver_set_expansions(NULL);
2006 if (expand_string_message)
2009 addr->message = size_limit == -1
2010 ? string_sprintf("failed to expand message_size_limit "
2011 "in %s transport: %s", tp->name, expand_string_message)
2012 : string_sprintf("invalid message_size_limit "
2013 "in %s transport: %s", tp->name, expand_string_message);
2015 else if (size_limit > 0 && message_size > size_limit)
2019 string_sprintf("message is too big (transport limit = %d)",
2028 /*************************************************
2029 * Transport-time check for a previous delivery *
2030 *************************************************/
2032 /* Check that this base address hasn't previously been delivered to its routed
2033 transport. If it has been delivered, mark it done. The check is necessary at
2034 delivery time in order to handle homonymic addresses correctly in cases where
2035 the pattern of redirection changes between delivery attempts (so the unique
2036 fields change). Non-homonymic previous delivery is detected earlier, at routing
2037 time (which saves unnecessary routing).
2040 addr the address item
2041 testing TRUE if testing wanted only, without side effects
2043 Returns: TRUE if previously delivered by the transport
2047 previously_transported(address_item *addr, BOOL testing)
2049 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
2050 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2052 if (tree_search(tree_nonrecipients, big_buffer) != 0)
2054 DEBUG(D_deliver|D_route|D_transport)
2055 debug_printf("%s was previously delivered (%s transport): discarded\n",
2056 addr->address, addr->transport->name);
2057 if (!testing) child_done(addr, tod_stamp(tod_log));
2066 /******************************************************
2067 * Check for a given header in a header string *
2068 ******************************************************/
2070 /* This function is used when generating quota warnings. The configuration may
2071 specify any header lines it likes in quota_warn_message. If certain of them are
2072 missing, defaults are inserted, so we need to be able to test for the presence
2076 hdr the required header name
2077 hstring the header string
2079 Returns: TRUE the header is in the string
2080 FALSE the header is not in the string
2084 contains_header(uschar *hdr, uschar *hstring)
2086 int len = Ustrlen(hdr);
2087 uschar *p = hstring;
2090 if (strncmpic(p, hdr, len) == 0)
2093 while (*p == ' ' || *p == '\t') p++;
2094 if (*p == ':') return TRUE;
2096 while (*p != 0 && *p != '\n') p++;
2097 if (*p == '\n') p++;
2105 /*************************************************
2106 * Perform a local delivery *
2107 *************************************************/
2109 /* Each local delivery is performed in a separate process which sets its
2110 uid and gid as specified. This is a safer way than simply changing and
2111 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2112 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2113 all systems have seteuid().
2115 If the uid/gid are specified in the transport_instance, they are used; the
2116 transport initialization must ensure that either both or neither are set.
2117 Otherwise, the values associated with the address are used. If neither are set,
2118 it is a configuration error.
2120 The transport or the address may specify a home directory (transport over-
2121 rides), and if they do, this is set as $home. If neither have set a working
2122 directory, this value is used for that as well. Otherwise $home is left unset
2123 and the cwd is set to "/" - a directory that should be accessible to all users.
2125 Using a separate process makes it more complicated to get error information
2126 back. We use a pipe to pass the return code and also an error code and error
2127 text string back to the parent process.
2130 addr points to an address block for this delivery; for "normal" local
2131 deliveries this is the only address to be delivered, but for
2132 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2133 a number of addresses can be handled simultaneously, and in this
2134 case addr will point to a chain of addresses with the same
2137 shadowing TRUE if running a shadow transport; this causes output from pipes
2144 deliver_local(address_item *addr, BOOL shadowing)
2146 BOOL use_initgroups;
2149 int status, len, rc;
2152 uschar *working_directory;
2153 address_item *addr2;
2154 transport_instance *tp = addr->transport;
2156 /* Set up the return path from the errors or sender address. If the transport
2157 has its own return path setting, expand it and replace the existing value. */
2159 if(addr->prop.errors_address)
2160 return_path = addr->prop.errors_address;
2161 #ifdef EXPERIMENTAL_SRS
2162 else if (addr->prop.srs_sender)
2163 return_path = addr->prop.srs_sender;
2166 return_path = sender_address;
2168 if (tp->return_path)
2170 uschar *new_return_path = expand_string(tp->return_path);
2171 if (!new_return_path)
2173 if (!f.expand_string_forcedfail)
2175 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2176 US"Failed to expand return path \"%s\" in %s transport: %s",
2177 tp->return_path, tp->name, expand_string_message);
2181 else return_path = new_return_path;
2184 /* For local deliveries, one at a time, the value used for logging can just be
2185 set directly, once and for all. */
2187 used_return_path = return_path;
2189 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2190 gets put into the address(es), and the expansions are unset, so we can just
2193 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2195 /* See if either the transport or the address specifies a home directory. A
2196 home directory set in the address may already be expanded; a flag is set to
2197 indicate that. In other cases we must expand it. */
2199 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2200 || ( (deliver_home = addr->home_dir) /* Set in address and */
2201 && !testflag(addr, af_home_expanded) /* not expanded */
2204 uschar *rawhome = deliver_home;
2205 deliver_home = NULL; /* in case it contains $home */
2206 if (!(deliver_home = expand_string(rawhome)))
2208 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2209 "to expand for %s transport: %s", rawhome, tp->name,
2210 expand_string_message);
2213 if (*deliver_home != '/')
2215 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2216 "is not absolute for %s transport", deliver_home, tp->name);
2221 /* See if either the transport or the address specifies a current directory,
2222 and if so, expand it. If nothing is set, use the home directory, unless it is
2223 also unset in which case use "/", which is assumed to be a directory to which
2224 all users have access. It is necessary to be in a visible directory for some
2225 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2226 2.5) require this. */
2228 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2229 if (working_directory)
2231 uschar *raw = working_directory;
2232 if (!(working_directory = expand_string(raw)))
2234 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2235 "failed to expand for %s transport: %s", raw, tp->name,
2236 expand_string_message);
2239 if (*working_directory != '/')
2241 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2242 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2246 else working_directory = deliver_home ? deliver_home : US"/";
2248 /* If one of the return_output flags is set on the transport, create and open a
2249 file in the message log directory for the transport to write its output onto.
2250 This is mainly used by pipe transports. The file needs to be unique to the
2251 address. This feature is not available for shadow transports. */
2254 && ( tp->return_output || tp->return_fail_output
2255 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2260 addr->return_filename =
2261 spool_fname(US"msglog", message_subdir, message_id,
2262 string_sprintf("-%d-%d", getpid(), return_count++));
2264 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2266 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2267 "to return message: %s", error, tp->name, strerror(errno));
2272 /* Create the pipe for inter-process communication. */
2276 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2281 /* Now fork the process to do the real work in the subprocess, but first
2282 ensure that all cached resources are freed so that the subprocess starts with
2283 a clean slate and doesn't interfere with the parent process. */
2287 if ((pid = fork()) == 0)
2289 BOOL replicate = TRUE;
2291 /* Prevent core dumps, as we don't want them in users' home directories.
2292 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2293 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2294 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2295 complain if the error is "not supported".
2297 There are two scenarios where changing the max limit has an effect. In one,
2298 the user is using a .forward and invoking a command of their choice via pipe;
2299 for these, we do need the max limit to be 0 unless the admin chooses to
2300 permit an increased limit. In the other, the command is invoked directly by
2301 the transport and is under administrator control, thus being able to raise
2302 the limit aids in debugging. So there's no general always-right answer.
2304 Thus we inhibit core-dumps completely but let individual transports, while
2305 still root, re-raise the limits back up to aid debugging. We make the
2306 default be no core-dumps -- few enough people can use core dumps in
2307 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2314 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2316 # ifdef SETRLIMIT_NOT_SUPPORTED
2317 if (errno != ENOSYS && errno != ENOTSUP)
2319 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2324 /* Reset the random number generator, so different processes don't all
2325 have the same sequence. */
2329 /* If the transport has a setup entry, call this first, while still
2330 privileged. (Appendfile uses this to expand quota, for example, while
2331 able to read private files.) */
2333 if (addr->transport->setup)
2334 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2338 addr->transport_return = DEFER;
2342 addr->transport_return = PANIC;
2346 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2347 when the process becomes unprivileged, it won't be able to write to the
2348 process log. SIGHUP is ignored throughout exim, except when it is being
2351 signal(SIGINT, SIG_IGN);
2352 signal(SIGTERM, SIG_IGN);
2353 signal(SIGUSR1, SIG_IGN);
2355 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2356 half - for transports that exec things (e.g. pipe). Then set the required
2359 (void)close(pfd[pipe_read]);
2360 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2362 exim_setugid(uid, gid, use_initgroups,
2363 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2364 addr->address, addr->transport->name));
2368 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2369 for (address_item * batched = addr->next; batched; batched = batched->next)
2370 debug_printf("additional batched address: %s\n", batched->address);
2373 /* Set an appropriate working directory. */
2375 if (Uchdir(working_directory) < 0)
2377 addr->transport_return = DEFER;
2378 addr->basic_errno = errno;
2379 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2382 /* If successful, call the transport */
2387 set_process_info("delivering %s to %s using %s", message_id,
2388 addr->local_part, addr->transport->name);
2390 /* Setting this global in the subprocess means we need never clear it */
2391 transport_name = addr->transport->name;
2393 /* If a transport filter has been specified, set up its argument list.
2394 Any errors will get put into the address, and FALSE yielded. */
2396 if (addr->transport->filter_command)
2398 ok = transport_set_up_command(&transport_filter_argv,
2399 addr->transport->filter_command,
2400 TRUE, PANIC, addr, US"transport filter", NULL);
2401 transport_filter_timeout = addr->transport->filter_timeout;
2403 else transport_filter_argv = NULL;
2407 debug_print_string(addr->transport->debug_string);
2408 replicate = !(addr->transport->info->code)(addr->transport, addr);
2412 /* Pass the results back down the pipe. If necessary, first replicate the
2413 status in the top address to the others in the batch. The label is the
2414 subject of a goto when a call to the transport's setup function fails. We
2415 pass the pointer to the transport back in case it got changed as a result of
2416 file_format in appendfile. */
2420 if (replicate) replicate_status(addr);
2421 for (addr2 = addr; addr2; addr2 = addr2->next)
2424 int local_part_length = Ustrlen(addr2->local_part);
2428 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2429 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2430 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2431 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2432 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2433 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2434 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2435 || (ret = write(pfd[pipe_write], &addr2->transport,
2436 sizeof(transport_instance *))) != sizeof(transport_instance *)
2438 /* For a file delivery, pass back the local part, in case the original
2439 was only part of the final delivery path. This gives more complete
2442 || (testflag(addr2, af_file)
2443 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2444 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2448 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2449 ret == -1 ? strerror(errno) : "short write");
2451 /* Now any messages */
2453 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2455 int message_length = s ? Ustrlen(s) + 1 : 0;
2456 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2457 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2459 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2460 ret == -1 ? strerror(errno) : "short write");
2464 /* OK, this process is now done. Free any cached resources that it opened,
2465 and close the pipe we were writing down before exiting. */
2467 (void)close(pfd[pipe_write]);
2472 /* Back in the main process: panic if the fork did not succeed. This seems
2473 better than returning an error - if forking is failing it is probably best
2474 not to try other deliveries for this message. */
2477 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2480 /* Read the pipe to get the delivery status codes and error messages. Our copy
2481 of the writing end must be closed first, as otherwise read() won't return zero
2482 on an empty pipe. We check that a status exists for each address before
2483 overwriting the address structure. If data is missing, the default DEFER status
2484 will remain. Afterwards, close the reading end. */
2486 (void)close(pfd[pipe_write]);
2488 for (addr2 = addr; addr2; addr2 = addr2->next)
2490 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2495 addr2->transport_return = status;
2496 len = read(pfd[pipe_read], &transport_count,
2497 sizeof(transport_count));
2498 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2499 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2500 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2501 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2502 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2503 len = read(pfd[pipe_read], &addr2->transport,
2504 sizeof(transport_instance *));
2506 if (testflag(addr2, af_file))
2509 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2510 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2513 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2514 " from delivery subprocess");
2517 /* sanity-checked llen so disable the Coverity error */
2518 /* coverity[tainted_data] */
2519 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2521 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2522 " from delivery subprocess");
2525 big_buffer[llen] = 0;
2526 addr2->local_part = string_copy(big_buffer);
2529 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2532 len = read(pfd[pipe_read], &message_length, sizeof(int));
2533 if (message_length > 0)
2535 len = read(pfd[pipe_read], big_buffer, message_length);
2536 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2537 if (len > 0) *sptr = string_copy(big_buffer);
2544 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2545 "from delivery subprocess", addr2->unique);
2550 (void)close(pfd[pipe_read]);
2552 /* Unless shadowing, write all successful addresses immediately to the journal
2553 file, to ensure they are recorded asap. For homonymic addresses, use the base
2554 address plus the transport name. Failure to write the journal is panic-worthy,
2555 but don't stop, as it may prove possible subsequently to update the spool file
2556 in order to record the delivery. */
2560 for (addr2 = addr; addr2; addr2 = addr2->next)
2561 if (addr2->transport_return == OK)
2563 if (testflag(addr2, af_homonym))
2564 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2566 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2568 /* In the test harness, wait just a bit to let the subprocess finish off
2569 any debug output etc first. */
2571 if (f.running_in_test_harness) millisleep(300);
2573 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2574 len = Ustrlen(big_buffer);
2575 if (write(journal_fd, big_buffer, len) != len)
2576 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2577 big_buffer, strerror(errno));
2580 /* Ensure the journal file is pushed out to disk. */
2582 if (EXIMfsync(journal_fd) < 0)
2583 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2587 /* Wait for the process to finish. If it terminates with a non-zero code,
2588 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2589 status values of all the addresses as they are. Take care to handle the case
2590 when the subprocess doesn't seem to exist. This has been seen on one system
2591 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2592 happens, wait() doesn't recognize the termination of child processes. Exim now
2593 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2595 while ((rc = wait(&status)) != pid)
2596 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2598 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2599 addr->transport->driver_name);
2604 if ((status & 0xffff) != 0)
2606 int msb = (status >> 8) & 255;
2607 int lsb = status & 255;
2608 int code = (msb == 0)? (lsb & 0x7f) : msb;
2609 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2610 addr->special_action = SPECIAL_FREEZE;
2611 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2612 "status 0x%04x: %s %d",
2613 addr->transport->driver_name,
2615 msb == 0 ? "terminated by signal" : "exit code",
2619 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2621 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2624 uschar *warn_message;
2627 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2629 if (!(warn_message = expand_string(addr->transport->warn_message)))
2630 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2631 "message for %s transport): %s", addr->transport->warn_message,
2632 addr->transport->name, expand_string_message);
2634 else if ((pid = child_open_exim(&fd)) > 0)
2636 FILE *f = fdopen(fd, "wb");
2637 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2638 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2639 fprintf(f, "Auto-Submitted: auto-replied\n");
2640 if (!contains_header(US"From", warn_message))
2642 fprintf(f, "%s", CS warn_message);
2644 /* Close and wait for child process to complete, without a timeout. */
2647 (void)child_close(pid, 0);
2650 addr->special_action = SPECIAL_NONE;
2657 /* Check transport for the given concurrency limit. Return TRUE if over
2658 the limit (or an expansion failure), else FALSE and if there was a limit,
2659 the key for the hints database used for the concurrency count. */
2662 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2664 unsigned max_parallel;
2666 if (!tp->max_parallel) return FALSE;
2668 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2669 if (expand_string_message)
2671 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2672 "in %s transport (%s): %s", tp->name, addr->address,
2673 expand_string_message);
2677 if (max_parallel > 0)
2679 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2680 if (!enq_start(serialize_key, max_parallel))
2682 address_item * next;
2684 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2685 tp->name, max_parallel);
2689 addr->message = US"concurrency limit reached for transport";
2690 addr->basic_errno = ERRNO_TRETRY;
2691 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2692 } while ((addr = next));
2695 *key = serialize_key;
2702 /*************************************************
2703 * Do local deliveries *
2704 *************************************************/
2706 /* This function processes the list of addresses in addr_local. True local
2707 deliveries are always done one address at a time. However, local deliveries can
2708 be batched up in some cases. Typically this is when writing batched SMTP output
2709 files for use by some external transport mechanism, or when running local
2710 deliveries over LMTP.
2717 do_local_deliveries(void)
2720 open_db *dbm_file = NULL;
2721 time_t now = time(NULL);
2723 /* Loop until we have exhausted the supply of local deliveries */
2727 struct timeval delivery_start;
2728 struct timeval deliver_time;
2729 address_item *addr2, *addr3, *nextaddr;
2730 int logflags = LOG_MAIN;
2731 int logchar = f.dont_deliver? '*' : '=';
2732 transport_instance *tp;
2733 uschar * serialize_key = NULL;
2735 /* Pick the first undelivered address off the chain */
2737 address_item *addr = addr_local;
2738 addr_local = addr->next;
2741 DEBUG(D_deliver|D_transport)
2742 debug_printf("--------> %s <--------\n", addr->address);
2744 /* An internal disaster if there is no transport. Should not occur! */
2746 if (!(tp = addr->transport))
2748 logflags |= LOG_PANIC;
2749 f.disable_logging = FALSE; /* Jic */
2750 addr->message = addr->router
2751 ? string_sprintf("No transport set by %s router", addr->router->name)
2752 : string_sprintf("No transport set by system filter");
2753 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2757 /* Check that this base address hasn't previously been delivered to this
2758 transport. The check is necessary at this point to handle homonymic addresses
2759 correctly in cases where the pattern of redirection changes between delivery
2760 attempts. Non-homonymic previous delivery is detected earlier, at routing
2763 if (previously_transported(addr, FALSE)) continue;
2765 /* There are weird cases where logging is disabled */
2767 f.disable_logging = tp->disable_logging;
2769 /* Check for batched addresses and possible amalgamation. Skip all the work
2770 if either batch_max <= 1 or there aren't any other addresses for local
2773 if (tp->batch_max > 1 && addr_local)
2775 int batch_count = 1;
2776 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2777 BOOL uses_lp = ( testflag(addr, af_pfr)
2778 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2780 || readconf_depends((driver_instance *)tp, US"local_part");
2781 uschar *batch_id = NULL;
2782 address_item **anchor = &addr_local;
2783 address_item *last = addr;
2786 /* Expand the batch_id string for comparison with other addresses.
2787 Expansion failure suppresses batching. */
2791 deliver_set_expansions(addr);
2792 batch_id = expand_string(tp->batch_id);
2793 deliver_set_expansions(NULL);
2796 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2797 "in %s transport (%s): %s", tp->name, addr->address,
2798 expand_string_message);
2799 batch_count = tp->batch_max;
2803 /* Until we reach the batch_max limit, pick off addresses which have the
2804 same characteristics. These are:
2807 not previously delivered (see comment about 50 lines above)
2808 same local part if the transport's configuration contains $local_part
2809 or if this is a file or pipe delivery from a redirection
2810 same domain if the transport's configuration contains $domain
2812 same additional headers
2813 same headers to be removed
2814 same uid/gid for running the transport
2815 same first host if a host list is set
2818 while ((next = *anchor) && batch_count < tp->batch_max)
2821 tp == next->transport
2822 && !previously_transported(next, TRUE)
2823 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2824 && testflag(addr, af_file) == testflag(next, af_file)
2825 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2826 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2827 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2828 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2829 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2830 && same_ugid(tp, addr, next)
2831 && ( !addr->host_list && !next->host_list
2834 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2837 /* If the transport has a batch_id setting, batch_id will be non-NULL
2838 from the expansion outside the loop. Expand for this address and compare.
2839 Expansion failure makes this address ineligible for batching. */
2844 address_item *save_nextnext = next->next;
2845 next->next = NULL; /* Expansion for a single address */
2846 deliver_set_expansions(next);
2847 next->next = save_nextnext;
2848 bid = expand_string(tp->batch_id);
2849 deliver_set_expansions(NULL);
2852 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2853 "in %s transport (%s): %s", tp->name, next->address,
2854 expand_string_message);
2857 else ok = (Ustrcmp(batch_id, bid) == 0);
2860 /* Take address into batch if OK. */
2864 *anchor = next->next; /* Include the address */
2870 else anchor = &next->next; /* Skip the address */
2874 /* We now have one or more addresses that can be delivered in a batch. Check
2875 whether the transport is prepared to accept a message of this size. If not,
2876 fail them all forthwith. If the expansion fails, or does not yield an
2877 integer, defer delivery. */
2879 if (tp->message_size_limit)
2881 int rc = check_message_size(tp, addr);
2884 replicate_status(addr);
2888 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2891 continue; /* With next batch of addresses */
2895 /* If we are not running the queue, or if forcing, all deliveries will be
2896 attempted. Otherwise, we must respect the retry times for each address. Even
2897 when not doing this, we need to set up the retry key string, and determine
2898 whether a retry record exists, because after a successful delivery, a delete
2899 retry item must be set up. Keep the retry database open only for the duration
2900 of these checks, rather than for all local deliveries, because some local
2901 deliveries (e.g. to pipes) can take a substantial time. */
2903 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2905 DEBUG(D_deliver|D_retry|D_hints_lookup)
2906 debug_printf("no retry data available\n");
2913 BOOL ok = TRUE; /* to deliver this address */
2916 /* Set up the retry key to include the domain or not, and change its
2917 leading character from "R" to "T". Must make a copy before doing this,
2918 because the old key may be pointed to from a "delete" retry item after
2921 retry_key = string_copy(
2922 tp->retry_use_local_part ? addr2->address_retry_key :
2923 addr2->domain_retry_key);
2926 /* Inspect the retry data. If there is no hints file, delivery happens. */
2930 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2932 /* If there is no retry record, delivery happens. If there is,
2933 remember it exists so it can be deleted after a successful delivery. */
2937 setflag(addr2, af_lt_retry_exists);
2939 /* A retry record exists for this address. If queue running and not
2940 forcing, inspect its contents. If the record is too old, or if its
2941 retry time has come, or if it has passed its cutoff time, delivery
2946 debug_printf("retry record exists: age=%s ",
2947 readconf_printtime(now - retry_record->time_stamp));
2948 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2949 debug_printf(" time to retry = %s expired = %d\n",
2950 readconf_printtime(retry_record->next_try - now),
2951 retry_record->expired);
2954 if (f.queue_running && !f.deliver_force)
2956 ok = (now - retry_record->time_stamp > retry_data_expire)
2957 || (now >= retry_record->next_try)
2958 || retry_record->expired;
2960 /* If we haven't reached the retry time, there is one more check
2961 to do, which is for the ultimate address timeout. */
2964 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2968 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2971 /* This address is to be delivered. Leave it on the chain. */
2976 addr2 = addr2->next;
2979 /* This address is to be deferred. Take it out of the chain, and
2980 post-process it as complete. Must take it out of the chain first,
2981 because post processing puts it on another chain. */
2985 address_item *this = addr2;
2986 this->message = US"Retry time not yet reached";
2987 this->basic_errno = ERRNO_LRETRY;
2988 addr2 = addr3 ? (addr3->next = addr2->next)
2989 : (addr = addr2->next);
2990 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2994 if (dbm_file) dbfn_close(dbm_file);
2996 /* If there are no addresses left on the chain, they all deferred. Loop
2997 for the next set of addresses. */
2999 if (!addr) continue;
3001 /* If the transport is limited for parallellism, enforce that here.
3002 We use a hints DB entry, incremented here and decremented after
3003 the transport (and any shadow transport) completes. */
3005 if (tpt_parallel_check(tp, addr, &serialize_key))
3007 if (expand_string_message)
3009 logflags |= LOG_PANIC;
3013 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3014 } while ((addr = addr2));
3016 continue; /* Loop for the next set of addresses. */
3020 /* So, finally, we do have some addresses that can be passed to the
3021 transport. Before doing so, set up variables that are relevant to a
3024 deliver_set_expansions(addr);
3026 gettimeofday(&delivery_start, NULL);
3027 deliver_local(addr, FALSE);
3028 timesince(&deliver_time, &delivery_start);
3030 /* If a shadow transport (which must perforce be another local transport), is
3031 defined, and its condition is met, we must pass the message to the shadow
3032 too, but only those addresses that succeeded. We do this by making a new
3033 chain of addresses - also to keep the original chain uncontaminated. We must
3034 use a chain rather than doing it one by one, because the shadow transport may
3037 NOTE: if the condition fails because of a lookup defer, there is nothing we
3041 && ( !tp->shadow_condition
3042 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3045 transport_instance *stp;
3046 address_item *shadow_addr = NULL;
3047 address_item **last = &shadow_addr;
3049 for (stp = transports; stp; stp = stp->next)
3050 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3053 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3056 /* Pick off the addresses that have succeeded, and make clones. Put into
3057 the shadow_message field a pointer to the shadow_message field of the real
3060 else for (addr2 = addr; addr2; addr2 = addr2->next)
3061 if (addr2->transport_return == OK)
3063 addr3 = store_get(sizeof(address_item));
3066 addr3->shadow_message = US &addr2->shadow_message;
3067 addr3->transport = stp;
3068 addr3->transport_return = DEFER;
3069 addr3->return_filename = NULL;
3070 addr3->return_file = -1;
3072 last = &addr3->next;
3075 /* If we found any addresses to shadow, run the delivery, and stick any
3076 message back into the shadow_message field in the original. */
3080 int save_count = transport_count;
3082 DEBUG(D_deliver|D_transport)
3083 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3084 deliver_local(shadow_addr, TRUE);
3086 for(; shadow_addr; shadow_addr = shadow_addr->next)
3088 int sresult = shadow_addr->transport_return;
3089 *(uschar **)shadow_addr->shadow_message =
3091 ? string_sprintf(" ST=%s", stp->name)
3092 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3093 shadow_addr->basic_errno <= 0
3095 : US strerror(shadow_addr->basic_errno),
3096 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3099 shadow_addr->message
3100 ? shadow_addr->message
3101 : shadow_addr->basic_errno <= 0
3105 DEBUG(D_deliver|D_transport)
3106 debug_printf("%s shadow transport returned %s for %s\n",
3108 sresult == OK ? "OK" :
3109 sresult == DEFER ? "DEFER" :
3110 sresult == FAIL ? "FAIL" :
3111 sresult == PANIC ? "PANIC" : "?",
3112 shadow_addr->address);
3115 DEBUG(D_deliver|D_transport)
3116 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3118 transport_count = save_count; /* Restore original transport count */
3122 /* Cancel the expansions that were set up for the delivery. */
3124 deliver_set_expansions(NULL);
3126 /* If the transport was parallelism-limited, decrement the hints DB record. */
3128 if (serialize_key) enq_end(serialize_key);
3130 /* Now we can process the results of the real transport. We must take each
3131 address off the chain first, because post_process_one() puts it on another
3134 for (addr2 = addr; addr2; addr2 = nextaddr)
3136 int result = addr2->transport_return;
3137 nextaddr = addr2->next;
3139 DEBUG(D_deliver|D_transport)
3140 debug_printf("%s transport returned %s for %s\n",
3142 result == OK ? "OK" :
3143 result == DEFER ? "DEFER" :
3144 result == FAIL ? "FAIL" :
3145 result == PANIC ? "PANIC" : "?",
3148 /* If there is a retry_record, or if delivery is deferred, build a retry
3149 item for setting a new retry time or deleting the old retry record from
3150 the database. These items are handled all together after all addresses
3151 have been handled (so the database is open just for a short time for
3154 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3156 int flags = result == DEFER ? 0 : rf_delete;
3157 uschar *retry_key = string_copy(tp->retry_use_local_part
3158 ? addr2->address_retry_key : addr2->domain_retry_key);
3160 retry_add_item(addr2, retry_key, flags);
3163 /* Done with this address */
3167 addr2->more_errno = deliver_time.tv_sec;
3168 addr2->delivery_usec = deliver_time.tv_usec;
3170 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3172 /* If a pipe delivery generated text to be sent back, the result may be
3173 changed to FAIL, and we must copy this for subsequent addresses in the
3176 if (addr2->transport_return != result)
3178 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3180 addr3->transport_return = addr2->transport_return;
3181 addr3->basic_errno = addr2->basic_errno;
3182 addr3->message = addr2->message;
3184 result = addr2->transport_return;
3187 /* Whether or not the result was changed to FAIL, we need to copy the
3188 return_file value from the first address into all the addresses of the
3189 batch, so they are all listed in the error message. */
3191 addr2->return_file = addr->return_file;
3193 /* Change log character for recording successful deliveries. */
3195 if (result == OK) logchar = '-';
3197 } /* Loop back for next batch of addresses */
3203 /*************************************************
3204 * Sort remote deliveries *
3205 *************************************************/
3207 /* This function is called if remote_sort_domains is set. It arranges that the
3208 chain of addresses for remote deliveries is ordered according to the strings
3209 specified. Try to make this shuffling reasonably efficient by handling
3210 sequences of addresses rather than just single ones.
3217 sort_remote_deliveries(void)
3220 address_item **aptr = &addr_remote;
3221 const uschar *listptr = remote_sort_domains;
3226 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3229 address_item *moved = NULL;
3230 address_item **bptr = &moved;
3234 address_item **next;
3235 deliver_domain = (*aptr)->domain; /* set $domain */
3236 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3237 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3239 aptr = &(*aptr)->next;
3243 next = &(*aptr)->next;
3245 && (deliver_domain = (*next)->domain, /* Set $domain */
3246 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3247 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3249 next = &(*next)->next;
3251 /* If the batch of non-matchers is at the end, add on any that were
3252 extracted further up the chain, and end this iteration. Otherwise,
3253 extract them from the chain and hang on the moved chain. */
3265 aptr = &(*aptr)->next;
3268 /* If the loop ended because the final address matched, *aptr will
3269 be NULL. Add on to the end any extracted non-matching addresses. If
3270 *aptr is not NULL, the loop ended via "break" when *next is null, that
3271 is, there was a string of non-matching addresses at the end. In this
3272 case the extracted addresses have already been added on the end. */
3274 if (!*aptr) *aptr = moved;
3279 debug_printf("remote addresses after sorting:\n");
3280 for (address_item * addr = addr_remote; addr; addr = addr->next)
3281 debug_printf(" %s\n", addr->address);
3287 /*************************************************
3288 * Read from pipe for remote delivery subprocess *
3289 *************************************************/
3291 /* This function is called when the subprocess is complete, but can also be
3292 called before it is complete, in order to empty a pipe that is full (to prevent
3293 deadlock). It must therefore keep track of its progress in the parlist data
3296 We read the pipe to get the delivery status codes and a possible error message
3297 for each address, optionally preceded by unusability data for the hosts and
3298 also by optional retry data.
3300 Read in large chunks into the big buffer and then scan through, interpreting
3301 the data therein. In most cases, only a single read will be necessary. No
3302 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3303 that we read the next chunk when there is less than 2500 bytes left in the
3304 non-final chunk, we can assume each item is complete in the buffer before
3305 handling it. Each item is written using a single write(), which is atomic for
3306 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3307 often bigger) so even if we are reading while the subprocess is still going, we
3308 should never have only a partial item in the buffer.
3310 hs12: This assumption is not true anymore, since we get quite large items (certificate
3311 information and such).
3314 poffset the offset of the parlist item
3315 eop TRUE if the process has completed
3317 Returns: TRUE if the terminating 'Z' item has been read,
3318 or there has been a disaster (i.e. no more data needed);
3323 par_read_pipe(int poffset, BOOL eop)
3326 pardata *p = parlist + poffset;
3327 address_item *addrlist = p->addrlist;
3328 address_item *addr = p->addr;
3332 uschar *msg = p->msg;
3333 BOOL done = p->done;
3335 /* Loop through all items, reading from the pipe when necessary. The pipe
3336 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3337 here, as the preceding select() tells us, if data is available for reading.
3339 A read() on a "selected" handle should never block, but(!) it may return
3340 less data then we expected. (The buffer size we pass to read() shouldn't be
3341 understood as a "request", but as a "limit".)
3343 Each separate item is written to the pipe in a timely manner. But, especially for
3344 larger items, the read(2) may already return partial data from the write(2).
3346 The write is atomic mostly (depending on the amount written), but atomic does
3347 not imply "all or noting", it just is "not intermixed" with other writes on the
3348 same channel (pipe).
3352 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3353 (int)p->pid, eop? "ended" : "not ended yet");
3357 retry_item *r, **rp;
3358 uschar pipeheader[PIPE_HEADER_SIZE+1];
3359 uschar *id = &pipeheader[0];
3360 uschar *subid = &pipeheader[1];
3361 uschar *ptr = big_buffer;
3362 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3365 DEBUG(D_deliver) debug_printf(
3366 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3368 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3369 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3370 If we get less, we can assume the subprocess do be done and do not expect any further
3371 information from it. */
3373 if ((got = readn(fd, pipeheader, required)) != required)
3375 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3376 "from transport process %d for transport %s",
3377 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3382 pipeheader[PIPE_HEADER_SIZE] = '\0';
3384 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3388 /* If we can't decode the pipeheader, the subprocess seems to have a
3389 problem, we do not expect any furher information from it. */
3391 required = Ustrtol(pipeheader+2, &endc, 10);
3394 msg = string_sprintf("failed to read pipe "
3395 "from transport process %d for transport %s: error decoding size from header",
3396 pid, addr->transport->driver_name);
3403 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3404 (u_long)required, pid);
3406 /* Same as above, the transport process will write the bytes announced
3407 in a timely manner, so we can just wait for the bytes, getting less than expected
3408 is considered a problem of the subprocess, we do not expect anything else from it. */
3409 if ((got = readn(fd, big_buffer, required)) != required)
3411 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3412 " bytes (pipedata) from transport process %d for transport %s",
3413 got, required, pid, addr->transport->driver_name);
3418 /* Handle each possible type of item, assuming the complete item is
3419 available in store. */
3423 /* Host items exist only if any hosts were marked unusable. Match
3424 up by checking the IP address. */
3427 for (h = addrlist->host_list; h; h = h->next)
3429 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3437 /* Retry items are sent in a preceding R item for each address. This is
3438 kept separate to keep each message short enough to guarantee it won't
3439 be split in the pipe. Hopefully, in the majority of cases, there won't in
3440 fact be any retry items at all.
3442 The complete set of retry items might include an item to delete a
3443 routing retry if there was a previous routing delay. However, routing
3444 retries are also used when a remote transport identifies an address error.
3445 In that case, there may also be an "add" item for the same key. Arrange
3446 that a "delete" item is dropped in favour of an "add" item. */
3449 if (!addr) goto ADDR_MISMATCH;
3451 DEBUG(D_deliver|D_retry)
3452 debug_printf("reading retry information for %s from subprocess\n",
3455 /* Cut out any "delete" items on the list. */
3457 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3458 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3460 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3461 *rp = r->next; /* Excise a delete item */
3462 DEBUG(D_deliver|D_retry)
3463 debug_printf(" existing delete item dropped\n");
3466 /* We want to add a delete item only if there is no non-delete item;
3467 however we still have to step ptr through the data. */
3469 if (!r || !(*ptr & rf_delete))
3471 r = store_get(sizeof(retry_item));
3472 r->next = addr->retries;
3475 r->key = string_copy(ptr);
3477 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3478 ptr += sizeof(r->basic_errno);
3479 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3480 ptr += sizeof(r->more_errno);
3481 r->message = *ptr ? string_copy(ptr) : NULL;
3482 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3483 r->flags & rf_delete ? "delete" : "retry");
3488 DEBUG(D_deliver|D_retry)
3489 debug_printf(" delete item not added: non-delete item exists\n");
3492 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3498 /* Put the amount of data written into the parlist block */
3501 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3502 ptr += sizeof(transport_count);
3505 /* Address items are in the order of items on the address chain. We
3506 remember the current address value in case this function is called
3507 several times to empty the pipe in stages. Information about delivery
3508 over TLS is sent in a preceding X item for each address. We don't put
3509 it in with the other info, in order to keep each message short enough to
3510 guarantee it won't be split in the pipe. */
3514 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3518 addr->cipher = NULL;
3519 addr->peerdn = NULL;
3522 addr->cipher = string_copy(ptr);
3525 addr->peerdn = string_copy(ptr);
3530 (void) tls_import_cert(ptr, &addr->peercert);
3532 addr->peercert = NULL;
3537 (void) tls_import_cert(ptr, &addr->ourcert);
3539 addr->ourcert = NULL;
3542 # ifndef DISABLE_OCSP
3544 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3550 #endif /*SUPPORT_TLS*/
3552 case 'C': /* client authenticator information */
3555 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3556 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3557 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3562 #ifndef DISABLE_PRDR
3564 setflag(addr, af_prdr_used);
3571 #ifdef EXPERIMENTAL_PIPE_CONNECT
3572 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3574 case 1: setflag(addr, af_pipelining); break;
3579 setflag(addr, af_chunking_used);
3583 setflag(addr, af_tcp_fastopen_conn);
3584 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3585 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3589 if (!addr) goto ADDR_MISMATCH;
3590 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3591 ptr += sizeof(addr->dsn_aware);
3592 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3599 msg = string_sprintf("address count mismatch for data read from pipe "
3600 "for transport process %d for transport %s", pid,
3601 addrlist->transport->driver_name);
3608 #ifdef SUPPORT_SOCKS
3609 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3610 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3615 proxy_local_address = string_copy(ptr);
3617 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3618 ptr += sizeof(proxy_local_port);
3623 #ifdef EXPERIMENTAL_DSN_INFO
3624 case '1': /* must arrive before A0, and applies to that addr */
3625 /* Two strings: smtp_greeting and helo_response */
3626 addr->smtp_greeting = string_copy(ptr);
3628 addr->helo_response = string_copy(ptr);
3634 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3635 addr->transport_return = *ptr++;
3636 addr->special_action = *ptr++;
3637 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3638 ptr += sizeof(addr->basic_errno);
3639 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3640 ptr += sizeof(addr->more_errno);
3641 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3642 ptr += sizeof(addr->delivery_usec);
3643 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3644 ptr += sizeof(addr->flags);
3645 addr->message = *ptr ? string_copy(ptr) : NULL;
3647 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3650 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3654 h = store_get(sizeof(host_item));
3655 h->name = string_copy(ptr);
3657 h->address = string_copy(ptr);
3659 memcpy(&h->port, ptr, sizeof(h->port));
3660 ptr += sizeof(h->port);
3661 h->dnssec = *ptr == '2' ? DS_YES
3662 : *ptr == '1' ? DS_NO
3665 addr->host_used = h;
3669 /* Finished with this address */
3676 /* Local interface address/port */
3678 if (*ptr) sending_ip_address = string_copy(ptr);
3680 if (*ptr) sending_port = atoi(CS ptr);
3684 /* Z marks the logical end of the data. It is followed by '0' if
3685 continue_transport was NULL at the end of transporting, otherwise '1'.
3686 We need to know when it becomes NULL during a delivery down a passed SMTP
3687 channel so that we don't try to pass anything more down it. Of course, for
3688 most normal messages it will remain NULL all the time. */
3693 continue_transport = NULL;
3694 continue_hostname = NULL;
3697 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3700 /* Anything else is a disaster. */
3703 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3704 "process %d for transport %s", ptr[-1], pid,
3705 addr->transport->driver_name);
3711 /* The done flag is inspected externally, to determine whether or not to
3712 call the function again when the process finishes. */
3716 /* If the process hadn't finished, and we haven't seen the end of the data
3717 or if we suffered a disaster, update the rest of the state, and return FALSE to
3718 indicate "not finished". */
3727 /* Close our end of the pipe, to prevent deadlock if the far end is still
3728 pushing stuff into it. */
3733 /* If we have finished without error, but haven't had data for every address,
3734 something is wrong. */
3737 msg = string_sprintf("insufficient address data read from pipe "
3738 "for transport process %d for transport %s", pid,
3739 addr->transport->driver_name);
3741 /* If an error message is set, something has gone wrong in getting back
3742 the delivery data. Put the message into each address and freeze it. */
3745 for (addr = addrlist; addr; addr = addr->next)
3747 addr->transport_return = DEFER;
3748 addr->special_action = SPECIAL_FREEZE;
3749 addr->message = msg;
3750 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3753 /* Return TRUE to indicate we have got all we need from this process, even
3754 if it hasn't actually finished yet. */
3761 /*************************************************
3762 * Post-process a set of remote addresses *
3763 *************************************************/
3765 /* Do what has to be done immediately after a remote delivery for each set of
3766 addresses, then re-write the spool if necessary. Note that post_process_one
3767 puts the address on an appropriate queue; hence we must fish off the next
3768 one first. This function is also called if there is a problem with setting
3769 up a subprocess to do a remote delivery in parallel. In this case, the final
3770 argument contains a message, and the action must be forced to DEFER.
3773 addr pointer to chain of address items
3774 logflags flags for logging
3775 msg NULL for normal cases; -> error message for unexpected problems
3776 fallback TRUE if processing fallback hosts
3782 remote_post_process(address_item *addr, int logflags, uschar *msg,
3785 /* If any host addresses were found to be unusable, add them to the unusable
3786 tree so that subsequent deliveries don't try them. */
3788 for (host_item * h = addr->host_list; h; h = h->next)
3790 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3792 /* Now handle each address on the chain. The transport has placed '=' or '-'
3793 into the special_action field for each successful delivery. */
3797 address_item *next = addr->next;
3799 /* If msg == NULL (normal processing) and the result is DEFER and we are
3800 processing the main hosts and there are fallback hosts available, put the
3801 address on the list for fallback delivery. */
3803 if ( addr->transport_return == DEFER
3804 && addr->fallback_hosts
3809 addr->host_list = addr->fallback_hosts;
3810 addr->next = addr_fallback;
3811 addr_fallback = addr;
3812 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3815 /* If msg is set (=> unexpected problem), set it in the address before
3816 doing the ordinary post processing. */
3822 addr->message = msg;
3823 addr->transport_return = DEFER;
3825 (void)post_process_one(addr, addr->transport_return, logflags,
3826 EXIM_DTYPE_TRANSPORT, addr->special_action);
3834 /* If we have just delivered down a passed SMTP channel, and that was
3835 the last address, the channel will have been closed down. Now that
3836 we have logged that delivery, set continue_sequence to 1 so that
3837 any subsequent deliveries don't get "*" incorrectly logged. */
3839 if (!continue_transport) continue_sequence = 1;
3844 /*************************************************
3845 * Wait for one remote delivery subprocess *
3846 *************************************************/
3848 /* This function is called while doing remote deliveries when either the
3849 maximum number of processes exist and we need one to complete so that another
3850 can be created, or when waiting for the last ones to complete. It must wait for
3851 the completion of one subprocess, empty the control block slot, and return a
3852 pointer to the address chain.
3855 Returns: pointer to the chain of addresses handled by the process;
3856 NULL if no subprocess found - this is an unexpected error
3859 static address_item *
3862 int poffset, status;
3863 address_item *addr, *addrlist;
3866 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3867 "to finish", message_id);
3869 /* Loop until either a subprocess completes, or there are no subprocesses in
3870 existence - in which case give an error return. We cannot proceed just by
3871 waiting for a completion, because a subprocess may have filled up its pipe, and
3872 be waiting for it to be emptied. Therefore, if no processes have finished, we
3873 wait for one of the pipes to acquire some data by calling select(), with a
3874 timeout just in case.
3876 The simple approach is just to iterate after reading data from a ready pipe.
3877 This leads to non-ideal behaviour when the subprocess has written its final Z
3878 item, closed the pipe, and is in the process of exiting (the common case). A
3879 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3880 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3883 To avoid this, if all the data that is needed has been read from a subprocess
3884 after select(), an explicit wait() for it is done. We know that all it is doing
3885 is writing to the pipe and then exiting, so the wait should not be long.
3887 The non-blocking waitpid() is to some extent just insurance; if we could
3888 reliably detect end-of-file on the pipe, we could always know when to do a
3889 blocking wait() for a completed process. However, because some systems use
3890 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3891 use code that functions without the need to recognize EOF.
3893 There's a double loop here just in case we end up with a process that is not in
3894 the list of remote delivery processes. Something has obviously gone wrong if
3895 this is the case. (For example, a process that is incorrectly left over from
3896 routing or local deliveries might be found.) The damage can be minimized by
3897 looping back and looking for another process. If there aren't any, the error
3898 return will happen. */
3900 for (;;) /* Normally we do not repeat this loop */
3902 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3905 fd_set select_pipes;
3906 int maxpipe, readycount;
3908 /* A return value of -1 can mean several things. If errno != ECHILD, it
3909 either means invalid options (which we discount), or that this process was
3910 interrupted by a signal. Just loop to try the waitpid() again.
3912 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3913 in existence. This should never happen, and is an unexpected error.
3914 However, there is a nasty complication when running under Linux. If "strace
3915 -f" is being used under Linux to trace this process and its children,
3916 subprocesses are "stolen" from their parents and become the children of the
3917 tracing process. A general wait such as the one we've just obeyed returns
3918 as if there are no children while subprocesses are running. Once a
3919 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3920 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3923 This does not happen using "truss" on Solaris, nor (I think) with other
3924 tracing facilities on other OS. It seems to be specific to Linux.
3926 What we do to get round this is to use kill() to see if any of our
3927 subprocesses are still in existence. If kill() gives an OK return, we know
3928 it must be for one of our processes - it can't be for a re-use of the pid,
3929 because if our process had finished, waitpid() would have found it. If any
3930 of our subprocesses are in existence, we proceed to use select() as if
3931 waitpid() had returned zero. I think this is safe. */
3935 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3938 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3939 "for process existence\n");
3941 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3943 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3945 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3946 "stolen by strace\n", (int)pid);
3947 break; /* With poffset set */
3951 if (poffset >= remote_max_parallel)
3953 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3954 return NULL; /* This is the error return */
3958 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3959 been handled above. A return value of zero means that there is at least one
3960 subprocess, but there are no completed subprocesses. See if any pipes are
3961 ready with any data for reading. */
3963 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3966 FD_ZERO(&select_pipes);
3967 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3968 if (parlist[poffset].pid != 0)
3970 int fd = parlist[poffset].fd;
3971 FD_SET(fd, &select_pipes);
3972 if (fd > maxpipe) maxpipe = fd;
3975 /* Stick in a 60-second timeout, just in case. */
3980 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3983 /* Scan through the pipes and read any that are ready; use the count
3984 returned by select() to stop when there are no more. Select() can return
3985 with no processes (e.g. if interrupted). This shouldn't matter.
3987 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3988 read, or there was a disaster. In either case, we are finished with this
3989 process. Do an explicit wait() for the process and break the main loop if
3992 It turns out that we have to deal with the case of an interrupted system
3993 call, which can happen on some operating systems if the signal handling is
3994 set up to do that by default. */
3997 readycount > 0 && poffset < remote_max_parallel;
4000 if ( (pid = parlist[poffset].pid) != 0
4001 && FD_ISSET(parlist[poffset].fd, &select_pipes)
4005 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
4006 for (;;) /* Loop for signals */
4008 pid_t endedpid = waitpid(pid, &status, 0);
4009 if (endedpid == pid) goto PROCESS_DONE;
4010 if (endedpid != (pid_t)(-1) || errno != EINTR)
4011 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
4012 "%d (errno = %d) from waitpid() for process %d",
4013 (int)endedpid, errno, (int)pid);
4018 /* Now go back and look for a completed subprocess again. */
4021 /* A completed process was detected by the non-blocking waitpid(). Find the
4022 data block that corresponds to this subprocess. */
4024 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4025 if (pid == parlist[poffset].pid) break;
4027 /* Found the data block; this is a known remote delivery process. We don't
4028 need to repeat the outer loop. This should be what normally happens. */
4030 if (poffset < remote_max_parallel) break;
4032 /* This situation is an error, but it's probably better to carry on looking
4033 for another process than to give up (as we used to do). */
4035 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4036 "transport process list", pid);
4037 } /* End of the "for" loop */
4039 /* Come here when all the data was completely read after a select(), and
4040 the process in pid has been wait()ed for. */
4047 debug_printf("remote delivery process %d ended\n", (int)pid);
4049 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4053 set_process_info("delivering %s", message_id);
4055 /* Get the chain of processed addresses */
4057 addrlist = parlist[poffset].addrlist;
4059 /* If the process did not finish cleanly, record an error and freeze (except
4060 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4061 in case the delivery did actually happen. */
4063 if ((status & 0xffff) != 0)
4066 int msb = (status >> 8) & 255;
4067 int lsb = status & 255;
4068 int code = (msb == 0)? (lsb & 0x7f) : msb;
4070 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4072 addrlist->transport->driver_name,
4074 (msb == 0)? "terminated by signal" : "exit code",
4077 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4078 addrlist->special_action = SPECIAL_FREEZE;
4080 for (addr = addrlist; addr; addr = addr->next)
4082 addr->transport_return = DEFER;
4083 addr->message = msg;
4086 remove_journal = FALSE;
4089 /* Else complete reading the pipe to get the result of the delivery, if all
4090 the data has not yet been obtained. */
4092 else if (!parlist[poffset].done) (void)par_read_pipe(poffset, TRUE);
4094 /* Put the data count and return path into globals, mark the data slot unused,
4095 decrement the count of subprocesses, and return the address chain. */
4097 transport_count = parlist[poffset].transport_count;
4098 used_return_path = parlist[poffset].return_path;
4099 parlist[poffset].pid = 0;
4106 /*************************************************
4107 * Wait for subprocesses and post-process *
4108 *************************************************/
4110 /* This function waits for subprocesses until the number that are still running
4111 is below a given threshold. For each complete subprocess, the addresses are
4112 post-processed. If we can't find a running process, there is some shambles.
4113 Better not bomb out, as that might lead to multiple copies of the message. Just
4114 log and proceed as if all done.
4117 max maximum number of subprocesses to leave running
4118 fallback TRUE if processing fallback hosts
4124 par_reduce(int max, BOOL fallback)
4126 while (parcount > max)
4128 address_item *doneaddr = par_wait();
4131 log_write(0, LOG_MAIN|LOG_PANIC,
4132 "remote delivery process count got out of step");
4137 transport_instance * tp = doneaddr->transport;
4138 if (tp->max_parallel)
4139 enq_end(string_sprintf("tpt-serialize-%s", tp->name));
4141 remote_post_process(doneaddr, LOG_MAIN, NULL, fallback);
4147 rmt_dlv_checked_write(int fd, char id, char subid, void * buf, ssize_t size)
4149 uschar pipe_header[PIPE_HEADER_SIZE+1];
4150 size_t total_len = PIPE_HEADER_SIZE + size;
4152 struct iovec iov[2] = {
4153 { pipe_header, PIPE_HEADER_SIZE }, /* indication about the data to expect */
4154 { buf, size } /* *the* data */
4159 /* we assume that size can't get larger then BIG_BUFFER_SIZE which currently is set to 16k */
4160 /* complain to log if someone tries with buffer sizes we can't handle*/
4162 if (size > BIG_BUFFER_SIZE-1)
4164 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4165 "Failed writing transport result to pipe: can't handle buffers > %d bytes. truncating!\n",
4167 size = BIG_BUFFER_SIZE;
4170 /* Should we check that we do not write more than PIPE_BUF? What would
4173 /* convert size to human readable string prepended by id and subid */
4174 if (PIPE_HEADER_SIZE != snprintf(CS pipe_header, PIPE_HEADER_SIZE+1, "%c%c%05ld",
4175 id, subid, (long)size))
4176 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "header snprintf failed\n");
4178 DEBUG(D_deliver) debug_printf("header write id:%c,subid:%c,size:%ld,final:%s\n",
4179 id, subid, (long)size, pipe_header);
4181 if ((ret = writev(fd, iov, 2)) != total_len)
4182 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
4183 "Failed writing transport result to pipe (%ld of %ld bytes): %s",
4184 (long)ret, (long)total_len, ret == -1 ? strerror(errno) : "short write");
4187 /*************************************************
4188 * Do remote deliveries *
4189 *************************************************/
4191 /* This function is called to process the addresses in addr_remote. We must
4192 pick off the queue all addresses that have the same transport, remote
4193 destination, and errors address, and hand them to the transport in one go,
4194 subject to some configured limitations. If this is a run to continue delivering
4195 to an existing delivery channel, skip all but those addresses that can go to
4196 that channel. The skipped addresses just get deferred.
4198 If mua_wrapper is set, all addresses must be able to be sent in a single
4199 transaction. If not, this function yields FALSE.
4201 In Exim 4, remote deliveries are always done in separate processes, even
4202 if remote_max_parallel = 1 or if there's only one delivery to do. The reason
4203 is so that the base process can retain privilege. This makes the
4204 implementation of fallback transports feasible (though not initially done.)
4206 We create up to the configured number of subprocesses, each of which passes
4207 back the delivery state via a pipe. (However, when sending down an existing
4208 connection, remote_max_parallel is forced to 1.)
4211 fallback TRUE if processing fallback hosts
4213 Returns: TRUE normally
4214 FALSE if mua_wrapper is set and the addresses cannot all be sent
4219 do_remote_deliveries(BOOL fallback)
4224 parcount = 0; /* Number of executing subprocesses */
4226 /* When sending down an existing channel, only do one delivery at a time.
4227 We use a local variable (parmax) to hold the maximum number of processes;
4228 this gets reduced from remote_max_parallel if we can't create enough pipes. */
4230 if (continue_transport) remote_max_parallel = 1;
4231 parmax = remote_max_parallel;
4233 /* If the data for keeping a list of processes hasn't yet been
4238 parlist = store_get(remote_max_parallel * sizeof(pardata));
4239 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4240 parlist[poffset].pid = 0;
4243 /* Now loop for each remote delivery */
4245 for (int delivery_count = 0; addr_remote; delivery_count++)
4251 int address_count = 1;
4252 int address_count_max;
4254 BOOL use_initgroups;
4255 BOOL pipe_done = FALSE;
4256 transport_instance *tp;
4257 address_item **anchor = &addr_remote;
4258 address_item *addr = addr_remote;
4259 address_item *last = addr;
4262 uschar * serialize_key = NULL;
4264 /* Pull the first address right off the list. */
4266 addr_remote = addr->next;
4269 DEBUG(D_deliver|D_transport)
4270 debug_printf("--------> %s <--------\n", addr->address);
4272 /* If no transport has been set, there has been a big screw-up somewhere. */
4274 if (!(tp = addr->transport))
4276 f.disable_logging = FALSE; /* Jic */
4277 panicmsg = US"No transport set by router";
4278 goto panic_continue;
4281 /* Check that this base address hasn't previously been delivered to this
4282 transport. The check is necessary at this point to handle homonymic addresses
4283 correctly in cases where the pattern of redirection changes between delivery
4284 attempts. Non-homonymic previous delivery is detected earlier, at routing
4287 if (previously_transported(addr, FALSE)) continue;
4289 /* Force failure if the message is too big. */
4291 if (tp->message_size_limit)
4293 int rc = check_message_size(tp, addr);
4296 addr->transport_return = rc;
4297 remote_post_process(addr, LOG_MAIN, NULL, fallback);
4302 /* Get the flag which specifies whether the transport can handle different
4303 domains that nevertheless resolve to the same set of hosts. If it needs
4304 expanding, get variables set: $address_data, $domain_data, $localpart_data,
4305 $host, $host_address, $host_port. */
4306 if (tp->expand_multi_domain)
4307 deliver_set_expansions(addr);
4309 if (exp_bool(addr, US"transport", tp->name, D_transport,
4310 US"multi_domain", tp->multi_domain, tp->expand_multi_domain,
4311 &multi_domain) != OK)
4313 deliver_set_expansions(NULL);
4314 panicmsg = addr->message;
4315 goto panic_continue;
4318 /* Get the maximum it can handle in one envelope, with zero meaning
4319 unlimited, which is forced for the MUA wrapper case. */
4321 address_count_max = tp->max_addresses;
4322 if (address_count_max == 0 || mua_wrapper) address_count_max = 999999;
4325 /************************************************************************/
4326 /***** This is slightly experimental code, but should be safe. *****/
4328 /* The address_count_max value is the maximum number of addresses that the
4329 transport can send in one envelope. However, the transport must be capable of
4330 dealing with any number of addresses. If the number it gets exceeds its
4331 envelope limitation, it must send multiple copies of the message. This can be
4332 done over a single connection for SMTP, so uses less resources than making
4333 multiple connections. On the other hand, if remote_max_parallel is greater
4334 than one, it is perhaps a good idea to use parallel processing to move the
4335 message faster, even if that results in multiple simultaneous connections to
4338 How can we come to some compromise between these two ideals? What we do is to
4339 limit the number of addresses passed to a single instance of a transport to
4340 the greater of (a) its address limit (rcpt_max for SMTP) and (b) the total
4341 number of addresses routed to remote transports divided by
4342 remote_max_parallel. For example, if the message has 100 remote recipients,
4343 remote max parallel is 2, and rcpt_max is 10, we'd never send more than 50 at
4344 once. But if rcpt_max is 100, we could send up to 100.
4346 Of course, not all the remotely addresses in a message are going to go to the
4347 same set of hosts (except in smarthost configurations), so this is just a
4348 heuristic way of dividing up the work.
4350 Furthermore (1), because this may not be wanted in some cases, and also to
4351 cope with really pathological cases, there is also a limit to the number of
4352 messages that are sent over one connection. This is the same limit that is
4353 used when sending several different messages over the same connection.
4354 Continue_sequence is set when in this situation, to the number sent so
4355 far, including this message.
4357 Furthermore (2), when somebody explicitly sets the maximum value to 1, it
4358 is probably because they are using VERP, in which case they want to pass only
4359 one address at a time to the transport, in order to be able to use
4360 $local_part and $domain in constructing a new return path. We could test for
4361 the use of these variables, but as it is so likely they will be used when the
4362 maximum is 1, we don't bother. Just leave the value alone. */
4364 if ( address_count_max != 1
4365 && address_count_max < remote_delivery_count/remote_max_parallel
4368 int new_max = remote_delivery_count/remote_max_parallel;
4369 int message_max = tp->connection_max_messages;
4370 if (connection_max_messages >= 0) message_max = connection_max_messages;
4371 message_max -= continue_sequence - 1;
4372 if (message_max > 0 && new_max > address_count_max * message_max)
4373 new_max = address_count_max * message_max;
4374 address_count_max = new_max;
4377 /************************************************************************/
4380 /* Pick off all addresses which have the same transport, errors address,
4381 destination, and extra headers. In some cases they point to the same host
4382 list, but we also need to check for identical host lists generated from
4383 entirely different domains. The host list pointers can be NULL in the case
4384 where the hosts are defined in the transport. There is also a configured
4385 maximum limit of addresses that can be handled at once (see comments above
4386 for how it is computed).
4387 If the transport does not handle multiple domains, enforce that also,
4388 and if it might need a per-address check for this, re-evaluate it.
4391 while ((next = *anchor) && address_count < address_count_max)
4394 if ( (multi_domain || Ustrcmp(next->domain, addr->domain) == 0)
4395 && tp == next->transport
4396 && same_hosts(next->host_list, addr->host_list)
4397 && same_strings(next->prop.errors_address, addr->prop.errors_address)
4398 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
4399 && same_ugid(tp, next, addr)
4400 && ( next->prop.remove_headers == addr->prop.remove_headers
4401 || ( next->prop.remove_headers
4402 && addr->prop.remove_headers
4403 && Ustrcmp(next->prop.remove_headers, addr->prop.remove_headers) == 0
4407 (void)(!tp->expand_multi_domain || ((void)deliver_set_expansions(next), 1)),
4409 US"transport", next->transport->name, D_transport,
4410 US"multi_domain", next->transport->multi_domain,
4411 next->transport->expand_multi_domain, &md) == OK
4416 *anchor = next->next;
4418 next->first = addr; /* remember top one (for retry processing) */
4423 else anchor = &(next->next);
4424 deliver_set_expansions(NULL);
4427 /* If we are acting as an MUA wrapper, all addresses must go in a single
4428 transaction. If not, put them back on the chain and yield FALSE. */
4430 if (mua_wrapper && addr_remote)
4432 last->next = addr_remote;
4437 /* If the transport is limited for parallellism, enforce that here.
4438 The hints DB entry is decremented in par_reduce(), when we reap the
4439 transport process. */
4441 if (tpt_parallel_check(tp, addr, &serialize_key))
4442 if ((panicmsg = expand_string_message))
4443 goto panic_continue;
4445 continue; /* Loop for the next set of addresses. */
4447 /* Set up the expansion variables for this set of addresses */
4449 deliver_set_expansions(addr);
4451 /* Ensure any transport-set auth info is fresh */
4452 addr->authenticator = addr->auth_id = addr->auth_sndr = NULL;
4454 /* Compute the return path, expanding a new one if required. The old one
4455 must be set first, as it might be referred to in the expansion. */
4457 if(addr->prop.errors_address)
4458 return_path = addr->prop.errors_address;
4459 #ifdef EXPERIMENTAL_SRS
4460 else if(addr->prop.srs_sender)
4461 return_path = addr->prop.srs_sender;
4464 return_path = sender_address;
4466 if (tp->return_path)
4468 uschar *new_return_path = expand_string(tp->return_path);
4469 if (new_return_path)
4470 return_path = new_return_path;
4471 else if (!f.expand_string_forcedfail)
4473 panicmsg = string_sprintf("Failed to expand return path \"%s\": %s",
4474 tp->return_path, expand_string_message);
4479 /* Find the uid, gid, and use_initgroups setting for this transport. Failure
4480 logs and sets up error messages, so we just post-process and continue with
4481 the next address. */
4483 if (!findugid(addr, tp, &uid, &gid, &use_initgroups))
4489 /* If this transport has a setup function, call it now so that it gets
4490 run in this process and not in any subprocess. That way, the results of
4491 any setup that are retained by the transport can be reusable. One of the
4492 things the setup does is to set the fallback host lists in the addresses.
4493 That is why it is called at this point, before the continue delivery
4494 processing, because that might use the fallback hosts. */
4497 (void)((tp->setup)(addr->transport, addr, NULL, uid, gid, NULL));
4499 /* If we have a connection still open from a verify stage (lazy-close)
4500 treat it as if it is a continued connection (apart from the counter used
4501 for the log line mark). */
4503 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
4506 debug_printf("lazy-callout-close: have conn still open from verification\n");
4507 continue_transport = cutthrough.transport;
4508 continue_hostname = string_copy(cutthrough.host.name);
4509 continue_host_address = string_copy(cutthrough.host.address);
4510 continue_sequence = 1;
4511 sending_ip_address = cutthrough.snd_ip;
4512 sending_port = cutthrough.snd_port;
4513 smtp_peer_options = cutthrough.peer_options;
4516 /* If this is a run to continue delivery down an already-established
4517 channel, check that this set of addresses matches the transport and
4518 the channel. If it does not, defer the addresses. If a host list exists,
4519 we must check that the continue host is on the list. Otherwise, the
4520 host is set in the transport. */
4522 f.continue_more = FALSE; /* In case got set for the last lot */
4523 if (continue_transport)
4525 BOOL ok = Ustrcmp(continue_transport, tp->name) == 0;
4527 /* If the transport is about to override the host list do not check
4528 it here but take the cost of running the transport process to discover
4529 if the continued_hostname connection is suitable. This is a layering
4530 violation which is unfortunate as it requires we haul in the smtp
4535 smtp_transport_options_block * ob;
4537 if ( !( Ustrcmp(tp->info->driver_name, "smtp") == 0
4538 && (ob = (smtp_transport_options_block *)tp->options_block)
4539 && ob->hosts_override && ob->hosts
4545 for (host_item * h = addr->host_list; h; h = h->next)
4546 if (Ustrcmp(h->name, continue_hostname) == 0)
4547 /*XXX should also check port here */
4548 { ok = TRUE; break; }
4552 /* Addresses not suitable; defer or queue for fallback hosts (which
4553 might be the continue host) and skip to next address. */
4557 DEBUG(D_deliver) debug_printf("not suitable for continue_transport (%s)\n",
4558 Ustrcmp(continue_transport, tp->name) != 0
4559 ? string_sprintf("tpt %s vs %s", continue_transport, tp->name)
4560 : string_sprintf("no host matching %s", continue_hostname));
4561 if (serialize_key) enq_end(serialize_key);
4563 if (addr->fallback_hosts && !fallback)
4565 for (next = addr; ; next = next->next)
4567 next->host_list = next->fallback_hosts;
4568 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", next->address);
4569 if (!next->next) break;
4571 next->next = addr_fallback;
4572 addr_fallback = addr;
4577 for (next = addr; ; next = next->next)
4579 DEBUG(D_deliver) debug_printf(" %s to def list\n", next->address);
4580 if (!next->next) break;
4582 next->next = addr_defer;
4589 /* Set a flag indicating whether there are further addresses that list
4590 the continued host. This tells the transport to leave the channel open,
4591 but not to pass it to another delivery process. We'd like to do that
4592 for non-continue_transport cases too but the knowlege of which host is
4593 connected to is too hard to manage. Perhaps we need a finer-grain
4594 interface to the transport. */
4596 for (next = addr_remote; next && !f.continue_more; next = next->next)
4597 for (host_item * h = next->host_list; h; h = h->next)
4598 if (Ustrcmp(h->name, continue_hostname) == 0)
4599 { f.continue_more = TRUE; break; }
4602 /* The transports set up the process info themselves as they may connect
4603 to more than one remote machine. They also have to set up the filter
4604 arguments, if required, so that the host name and address are available
4607 transport_filter_argv = NULL;
4609 /* Create the pipe for inter-process communication. If pipe creation
4610 fails, it is probably because the value of remote_max_parallel is so
4611 large that too many file descriptors for pipes have been created. Arrange
4612 to wait for a process to finish, and then try again. If we still can't
4613 create a pipe when all processes have finished, break the retry loop. */
4617 if (pipe(pfd) == 0) pipe_done = TRUE;
4618 else if (parcount > 0) parmax = parcount;
4621 /* We need to make the reading end of the pipe non-blocking. There are
4622 two different options for this. Exim is cunningly (I hope!) coded so
4623 that it can use either of them, though it prefers O_NONBLOCK, which
4624 distinguishes between EOF and no-more-data. */
4626 /* The data appears in a timely manner and we already did a select on
4627 all pipes, so I do not see a reason to use non-blocking IO here
4630 (void)fcntl(pfd[pipe_read], F_SETFL, O_NONBLOCK);
4632 (void)fcntl(pfd[pipe_read], F_SETFL, O_NDELAY);
4636 /* If the maximum number of subprocesses already exist, wait for a process
4637 to finish. If we ran out of file descriptors, parmax will have been reduced
4638 from its initial value of remote_max_parallel. */
4640 par_reduce(parmax - 1, fallback);
4643 /* If we failed to create a pipe and there were no processes to wait
4644 for, we have to give up on this one. Do this outside the above loop
4645 so that we can continue the main loop. */
4649 panicmsg = string_sprintf("unable to create pipe: %s", strerror(errno));
4653 /* Find a free slot in the pardata list. Must do this after the possible
4654 waiting for processes to finish, because a terminating process will free
4657 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4658 if (parlist[poffset].pid == 0)
4661 /* If there isn't one, there has been a horrible disaster. */
4663 if (poffset >= remote_max_parallel)
4665 (void)close(pfd[pipe_write]);
4666 (void)close(pfd[pipe_read]);
4667 panicmsg = US"Unexpectedly no free subprocess slot";
4671 /* Now fork a subprocess to do the remote delivery, but before doing so,
4672 ensure that any cached resources are released so as not to interfere with
4673 what happens in the subprocess. */
4677 if ((pid = fork()) == 0)
4679 int fd = pfd[pipe_write];
4682 /* Setting this global in the subprocess means we need never clear it */
4683 transport_name = tp->name;
4685 /* There are weird circumstances in which logging is disabled */
4686 f.disable_logging = tp->disable_logging;
4688 /* Show pids on debug output if parallelism possible */
4690 if (parmax > 1 && (parcount > 0 || addr_remote))
4692 DEBUG(D_any|D_v) debug_selector |= D_pid;
4693 DEBUG(D_deliver) debug_printf("Remote delivery process started\n");
4696 /* Reset the random number generator, so different processes don't all
4697 have the same sequence. In the test harness we want different, but
4698 predictable settings for each delivery process, so do something explicit
4699 here rather they rely on the fixed reset in the random number function. */
4701 random_seed = f.running_in_test_harness ? 42 + 2*delivery_count : 0;
4703 /* Set close-on-exec on the pipe so that it doesn't get passed on to
4704 a new process that may be forked to do another delivery down the same
4707 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
4709 /* Close open file descriptors for the pipes of other processes
4710 that are running in parallel. */
4712 for (poffset = 0; poffset < remote_max_parallel; poffset++)
4713 if (parlist[poffset].pid != 0) (void)close(parlist[poffset].fd);
4715 /* This process has inherited a copy of the file descriptor
4716 for the data file, but its file pointer is shared with all the
4717 other processes running in parallel. Therefore, we have to re-open
4718 the file in order to get a new file descriptor with its own
4719 file pointer. We don't need to lock it, as the lock is held by
4720 the parent process. There doesn't seem to be any way of doing
4721 a dup-with-new-file-pointer. */
4723 (void)close(deliver_datafile);
4725 uschar * fname = spool_fname(US"input", message_subdir, message_id, US"-D");
4727 if ((deliver_datafile = Uopen(fname,
4731 O_RDWR | O_APPEND, 0)) < 0)
4732 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Failed to reopen %s for remote "
4733 "parallel delivery: %s", fname, strerror(errno));
4736 /* Set the close-on-exec flag */
4738 (void)fcntl(deliver_datafile, F_SETFD, fcntl(deliver_datafile, F_GETFD) |
4742 /* Set the uid/gid of this process; bombs out on failure. */
4744 exim_setugid(uid, gid, use_initgroups,
4745 string_sprintf("remote delivery to %s with transport=%s",
4746 addr->address, tp->name));
4748 /* Close the unwanted half of this process' pipe, set the process state,
4749 and run the transport. Afterwards, transport_count will contain the number
4750 of bytes written. */
4752 (void)close(pfd[pipe_read]);
4753 set_process_info("delivering %s using %s", message_id, tp->name);
4754 debug_print_string(tp->debug_string);
4755 if (!(tp->info->code)(addr->transport, addr)) replicate_status(addr);
4757 set_process_info("delivering %s (just run %s for %s%s in subprocess)",
4758 message_id, tp->name, addr->address, addr->next ? ", ..." : "");
4760 /* Ensure any cached resources that we used are now released */
4764 /* Pass the result back down the pipe. This is a lot more information
4765 than is needed for a local delivery. We have to send back the error
4766 status for each address, the usability status for each host that is
4767 flagged as unusable, and all the retry items. When TLS is in use, we
4768 send also the cipher and peerdn information. Each type of information
4769 is flagged by an identifying byte, and is then in a fixed format (with
4770 strings terminated by zeros), and there is a final terminator at the
4771 end. The host information and retry information is all attached to
4772 the first address, so that gets sent at the start. */
4774 /* Host unusability information: for most success cases this will
4777 for (h = addr->host_list; h; h = h->next)
4779 if (!h->address || h->status < hstatus_unusable) continue;
4780 sprintf(CS big_buffer, "%c%c%s", h->status, h->why, h->address);
4781 rmt_dlv_checked_write(fd, 'H', '0', big_buffer, Ustrlen(big_buffer+2) + 3);
4784 /* The number of bytes written. This is the same for each address. Even
4785 if we sent several copies of the message down the same connection, the
4786 size of each one is the same, and it's that value we have got because
4787 transport_count gets reset before calling transport_write_message(). */
4789 memcpy(big_buffer, &transport_count, sizeof(transport_count));
4790 rmt_dlv_checked_write(fd, 'S', '0', big_buffer, sizeof(transport_count));
4792 /* Information about what happened to each address. Four item types are
4793 used: an optional 'X' item first, for TLS information, then an optional "C"
4794 item for any client-auth info followed by 'R' items for any retry settings,
4795 and finally an 'A' item for the remaining data. */
4797 for(; addr; addr = addr->next)
4802 /* The certificate verification status goes into the flags */
4803 if (tls_out.certificate_verified) setflag(addr, af_cert_verified);
4805 if (tls_out.dane_verified) setflag(addr, af_dane_verified);
4808 /* Use an X item only if there's something to send */
4812 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->cipher) + 1;
4816 ptr += sprintf(CS ptr, "%.512s", addr->peerdn) + 1;
4818 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4820 else if (continue_proxy_cipher)
4822 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", continue_proxy_cipher) + 1;
4824 rmt_dlv_checked_write(fd, 'X', '1', big_buffer, ptr - big_buffer);
4830 if (!tls_export_cert(ptr, big_buffer_size-2, addr->peercert))
4834 rmt_dlv_checked_write(fd, 'X', '2', big_buffer, ptr - big_buffer);
4839 if (!tls_export_cert(ptr, big_buffer_size-2, addr->ourcert))
4843 rmt_dlv_checked_write(fd, 'X', '3', big_buffer, ptr - big_buffer);
4845 # ifndef DISABLE_OCSP
4846 if (addr->ocsp > OCSP_NOT_REQ)
4848 ptr = big_buffer + sprintf(CS big_buffer, "%c", addr->ocsp + '0') + 1;
4849 rmt_dlv_checked_write(fd, 'X', '4', big_buffer, ptr - big_buffer);
4852 #endif /*SUPPORT_TLS*/
4854 if (client_authenticator)
4856 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticator) + 1;
4857 rmt_dlv_checked_write(fd, 'C', '1', big_buffer, ptr - big_buffer);
4859 if (client_authenticated_id)
4861 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_id) + 1;
4862 rmt_dlv_checked_write(fd, 'C', '2', big_buffer, ptr - big_buffer);
4864 if (client_authenticated_sender)
4866 ptr = big_buffer + sprintf(CS big_buffer, "%.64s", client_authenticated_sender) + 1;
4867 rmt_dlv_checked_write(fd, 'C', '3', big_buffer, ptr - big_buffer);
4870 #ifndef DISABLE_PRDR
4871 if (testflag(addr, af_prdr_used))
4872 rmt_dlv_checked_write(fd, 'P', '0', NULL, 0);
4875 if (testflag(addr, af_pipelining))
4876 #ifdef EXPERIMENTAL_PIPE_CONNECT
4877 if (testflag(addr, af_early_pipe))
4878 rmt_dlv_checked_write(fd, 'L', '2', NULL, 0);
4881 rmt_dlv_checked_write(fd, 'L', '1', NULL, 0);
4883 if (testflag(addr, af_chunking_used))
4884 rmt_dlv_checked_write(fd, 'K', '0', NULL, 0);
4886 if (testflag(addr, af_tcp_fastopen_conn))
4887 rmt_dlv_checked_write(fd, 'T',
4888 testflag(addr, af_tcp_fastopen) ? testflag(addr, af_tcp_fastopen_data)
4892 memcpy(big_buffer, &addr->dsn_aware, sizeof(addr->dsn_aware));
4893 rmt_dlv_checked_write(fd, 'D', '0', big_buffer, sizeof(addr->dsn_aware));
4895 /* Retry information: for most success cases this will be null. */
4897 for (r = addr->retries; r; r = r->next)
4899 sprintf(CS big_buffer, "%c%.500s", r->flags, r->key);
4900 ptr = big_buffer + Ustrlen(big_buffer+2) + 3;
4901 memcpy(ptr, &r->basic_errno, sizeof(r->basic_errno));
4902 ptr += sizeof(r->basic_errno);
4903 memcpy(ptr, &r->more_errno, sizeof(r->more_errno));
4904 ptr += sizeof(r->more_errno);
4905 if (!r->message) *ptr++ = 0; else
4907 sprintf(CS ptr, "%.512s", r->message);
4910 rmt_dlv_checked_write(fd, 'R', '0', big_buffer, ptr - big_buffer);
4913 #ifdef SUPPORT_SOCKS
4914 if (LOGGING(proxy) && proxy_session)
4917 if (proxy_local_address)
4919 DEBUG(D_deliver) debug_printf("proxy_local_address '%s'\n", proxy_local_address);
4920 ptr = big_buffer + sprintf(CS ptr, "%.128s", proxy_local_address) + 1;
4921 DEBUG(D_deliver) debug_printf("proxy_local_port %d\n", proxy_local_port);
4922 memcpy(ptr, &proxy_local_port, sizeof(proxy_local_port));
4923 ptr += sizeof(proxy_local_port);
4927 rmt_dlv_checked_write(fd, 'A', '2', big_buffer, ptr - big_buffer);
4931 #ifdef EXPERIMENTAL_DSN_INFO
4932 /*um, are they really per-addr? Other per-conn stuff is not (auth, tls). But host_used is! */
4933 if (addr->smtp_greeting)
4935 DEBUG(D_deliver) debug_printf("smtp_greeting '%s'\n", addr->smtp_greeting);
4936 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", addr->smtp_greeting) + 1;
4937 if (addr->helo_response)
4939 DEBUG(D_deliver) debug_printf("helo_response '%s'\n", addr->helo_response);
4940 ptr += sprintf(CS ptr, "%.128s", addr->helo_response) + 1;
4944 rmt_dlv_checked_write(fd, 'A', '1', big_buffer, ptr - big_buffer);
4948 /* The rest of the information goes in an 'A0' item. */
4950 sprintf(CS big_buffer, "%c%c", addr->transport_return, addr->special_action);
4951 ptr = big_buffer + 2;
4952 memcpy(ptr, &addr->basic_errno, sizeof(addr->basic_errno));
4953 ptr += sizeof(addr->basic_errno);
4954 memcpy(ptr, &addr->more_errno, sizeof(addr->more_errno));
4955 ptr += sizeof(addr->more_errno);
4956 memcpy(ptr, &addr->delivery_usec, sizeof(addr->delivery_usec));
4957 ptr += sizeof(addr->delivery_usec);
4958 memcpy(ptr, &addr->flags, sizeof(addr->flags));
4959 ptr += sizeof(addr->flags);
4961 if (!addr->message) *ptr++ = 0; else
4962 ptr += sprintf(CS ptr, "%.1024s", addr->message) + 1;
4964 if (!addr->user_message) *ptr++ = 0; else
4965 ptr += sprintf(CS ptr, "%.1024s", addr->user_message) + 1;
4967 if (!addr->host_used) *ptr++ = 0; else
4969 ptr += sprintf(CS ptr, "%.256s", addr->host_used->name) + 1;
4970 ptr += sprintf(CS ptr, "%.64s", addr->host_used->address) + 1;
4971 memcpy(ptr, &addr->host_used->port, sizeof(addr->host_used->port));
4972 ptr += sizeof(addr->host_used->port);
4974 /* DNS lookup status */
4975 *ptr++ = addr->host_used->dnssec==DS_YES ? '2'
4976 : addr->host_used->dnssec==DS_NO ? '1' : '0';
4979 rmt_dlv_checked_write(fd, 'A', '0', big_buffer, ptr - big_buffer);
4982 /* Local interface address/port */
4983 #ifdef EXPERIMENTAL_DSN_INFO
4984 if (sending_ip_address)
4986 if (LOGGING(incoming_interface) && sending_ip_address)
4990 ptr = big_buffer + sprintf(CS big_buffer, "%.128s", sending_ip_address) + 1;
4991 ptr += sprintf(CS ptr, "%d", sending_port) + 1;
4992 rmt_dlv_checked_write(fd, 'I', '0', big_buffer, ptr - big_buffer);
4995 /* Add termination flag, close the pipe, and that's it. The character
4996 after 'Z' indicates whether continue_transport is now NULL or not.
4997 A change from non-NULL to NULL indicates a problem with a continuing
5000 big_buffer[0] = continue_transport ? '1' : '0';
5001 rmt_dlv_checked_write(fd, 'Z', '0', big_buffer, 1);
5006 /* Back in the mainline: close the unwanted half of the pipe. */
5008 (void)close(pfd[pipe_write]);
5010 /* If we have a connection still open from a verify stage (lazy-close)
5011 release its TLS library context (if any) as responsibility was passed to
5012 the delivery child process. */
5014 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
5017 if (cutthrough.is_tls)
5018 tls_close(cutthrough.cctx.tls_ctx, TLS_NO_SHUTDOWN);
5020 (void) close(cutthrough.cctx.sock);
5021 release_cutthrough_connection(US"passed to transport proc");
5024 /* Fork failed; defer with error message */
5028 (void)close(pfd[pipe_read]);
5029 panicmsg = string_sprintf("fork failed for remote delivery to %s: %s",
5030 addr->domain, strerror(errno));
5034 /* Fork succeeded; increment the count, and remember relevant data for
5035 when the process finishes. */
5038 parlist[poffset].addrlist = parlist[poffset].addr = addr;
5039 parlist[poffset].pid = pid;
5040 parlist[poffset].fd = pfd[pipe_read];
5041 parlist[poffset].done = FALSE;
5042 parlist[poffset].msg = NULL;
5043 parlist[poffset].return_path = return_path;
5045 /* If the process we've just started is sending a message down an existing
5046 channel, wait for it now. This ensures that only one such process runs at
5047 once, whatever the value of remote_max parallel. Otherwise, we might try to
5048 send two or more messages simultaneously down the same channel. This could
5049 happen if there are different domains that include the same host in otherwise
5050 different host lists.
5052 Also, if the transport closes down the channel, this information gets back
5053 (continue_transport gets set to NULL) before we consider any other addresses
5056 if (continue_transport) par_reduce(0, fallback);
5058 /* Otherwise, if we are running in the test harness, wait a bit, to let the
5059 newly created process get going before we create another process. This should
5060 ensure repeatability in the tests. We only need to wait a tad. */
5062 else if (f.running_in_test_harness) millisleep(500);
5067 if (serialize_key) enq_end(serialize_key);
5069 remote_post_process(addr, LOG_MAIN|LOG_PANIC, panicmsg, fallback);
5073 /* Reached the end of the list of addresses. Wait for all the subprocesses that
5074 are still running and post-process their addresses. */
5076 par_reduce(0, fallback);
5083 /*************************************************
5084 * Split an address into local part and domain *
5085 *************************************************/
5087 /* This function initializes an address for routing by splitting it up into a
5088 local part and a domain. The local part is set up twice - once in its original
5089 casing, and once in lower case, and it is dequoted. We also do the "percent
5090 hack" for configured domains. This may lead to a DEFER result if a lookup
5091 defers. When a percent-hacking takes place, we insert a copy of the original
5092 address as a new parent of this address, as if we have had a redirection.
5095 addr points to an addr_item block containing the address
5098 DEFER - could not determine if domain is %-hackable
5102 deliver_split_address(address_item * addr)
5104 uschar * address = addr->address;
5109 if (!(domain = Ustrrchr(address, '@')))
5110 return DEFER; /* should always have a domain, but just in case... */
5112 len = domain - address;
5113 addr->domain = string_copylc(domain+1); /* Domains are always caseless */
5115 /* The implication in the RFCs (though I can't say I've seen it spelled out
5116 explicitly) is that quoting should be removed from local parts at the point
5117 where they are locally interpreted. [The new draft "821" is more explicit on
5118 this, Jan 1999.] We know the syntax is valid, so this can be done by simply
5119 removing quoting backslashes and any unquoted doublequotes. */
5121 t = addr->cc_local_part = store_get(len+1);
5125 if (c == '\"') continue;
5135 /* We do the percent hack only for those domains that are listed in
5136 percent_hack_domains. A loop is required, to copy with multiple %-hacks. */
5138 if (percent_hack_domains)
5141 uschar *new_address = NULL;
5142 uschar *local_part = addr->cc_local_part;
5144 deliver_domain = addr->domain; /* set $domain */
5146 while ( (rc = match_isinlist(deliver_domain, (const uschar **)&percent_hack_domains, 0,
5147 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
5149 && (t = Ustrrchr(local_part, '%')) != NULL
5152 new_address = string_copy(local_part);
5153 new_address[t - local_part] = '@';
5154 deliver_domain = string_copylc(t+1);
5155 local_part = string_copyn(local_part, t - local_part);
5158 if (rc == DEFER) return DEFER; /* lookup deferred */
5160 /* If hackery happened, set up new parent and alter the current address. */
5164 address_item *new_parent = store_get(sizeof(address_item));
5165 *new_parent = *addr;
5166 addr->parent = new_parent;
5167 new_parent->child_count = 1;
5168 addr->address = new_address;
5169 addr->unique = string_copy(new_address);
5170 addr->domain = deliver_domain;
5171 addr->cc_local_part = local_part;
5172 DEBUG(D_deliver) debug_printf("%%-hack changed address to: %s\n",
5177 /* Create the lowercased version of the final local part, and make that the
5178 default one to be used. */
5180 addr->local_part = addr->lc_local_part = string_copylc(addr->cc_local_part);
5187 /*************************************************
5188 * Get next error message text *
5189 *************************************************/
5191 /* If f is not NULL, read the next "paragraph", from a customized error message
5192 text file, terminated by a line containing ****, and expand it.
5195 f NULL or a file to read from
5196 which string indicating which string (for errors)
5198 Returns: NULL or an expanded string
5202 next_emf(FILE *f, uschar *which)
5208 if (!f) return NULL;
5210 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5213 para = string_get(256);
5216 para = string_cat(para, buffer);
5217 if (!Ufgets(buffer, sizeof(buffer), f) || Ustrcmp(buffer, "****\n") == 0)
5220 if ((yield = expand_string(string_from_gstring(para))))
5223 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand string from "
5224 "bounce_message_file or warn_message_file (%s): %s", which,
5225 expand_string_message);
5232 /*************************************************
5233 * Close down a passed transport channel *
5234 *************************************************/
5236 /* This function is called when a passed transport channel cannot be used.
5237 It attempts to close it down tidily. The yield is always DELIVER_NOT_ATTEMPTED
5238 so that the function call can be the argument of a "return" statement.
5241 Returns: DELIVER_NOT_ATTEMPTED
5245 continue_closedown(void)
5247 if (continue_transport)
5248 for (transport_instance * t = transports; t; t = t->next)
5249 if (Ustrcmp(t->name, continue_transport) == 0)
5251 if (t->info->closedown) (t->info->closedown)(t);
5254 return DELIVER_NOT_ATTEMPTED;
5260 /*************************************************
5261 * Print address information *
5262 *************************************************/
5264 /* This function is called to output an address, or information about an
5265 address, for bounce or defer messages. If the hide_child flag is set, all we
5266 output is the original ancestor address.
5269 addr points to the address
5270 f the FILE to print to
5271 si an initial string
5272 sc a continuation string for before "generated"
5275 Returns: TRUE if the address is not hidden
5279 print_address_information(address_item *addr, FILE *f, uschar *si, uschar *sc,
5283 uschar *printed = US"";
5284 address_item *ancestor = addr;
5285 while (ancestor->parent) ancestor = ancestor->parent;
5287 fprintf(f, "%s", CS si);
5289 if (addr->parent && testflag(addr, af_hide_child))
5291 printed = US"an undisclosed address";
5294 else if (!testflag(addr, af_pfr) || !addr->parent)
5295 printed = addr->address;
5299 uschar *s = addr->address;
5302 if (addr->address[0] == '>') { ss = US"mail"; s++; }
5303 else if (addr->address[0] == '|') ss = US"pipe";
5306 fprintf(f, "%s to %s%sgenerated by ", ss, s, sc);
5307 printed = addr->parent->address;
5310 fprintf(f, "%s", CS string_printing(printed));
5312 if (ancestor != addr)
5314 uschar *original = ancestor->onetime_parent;
5315 if (!original) original= ancestor->address;
5316 if (strcmpic(original, printed) != 0)
5317 fprintf(f, "%s(%sgenerated from %s)", sc,
5318 ancestor != addr->parent ? "ultimately " : "",
5319 string_printing(original));
5322 if (addr->host_used)
5323 fprintf(f, "\n host %s [%s]",
5324 addr->host_used->name, addr->host_used->address);
5326 fprintf(f, "%s", CS se);
5334 /*************************************************
5335 * Print error for an address *
5336 *************************************************/
5338 /* This function is called to print the error information out of an address for
5339 a bounce or a warning message. It tries to format the message reasonably by
5340 introducing newlines. All lines are indented by 4; the initial printing
5341 position must be set before calling.
5343 This function used always to print the error. Nowadays we want to restrict it
5344 to cases such as LMTP/SMTP errors from a remote host, and errors from :fail:
5345 and filter "fail". We no longer pass other information willy-nilly in bounce
5346 and warning messages. Text in user_message is always output; text in message
5347 only if the af_pass_message flag is set.
5351 f the FILE to print on
5358 print_address_error(address_item *addr, FILE *f, uschar *t)
5360 int count = Ustrlen(t);
5361 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5363 if (!s && !(s = addr->user_message))
5366 fprintf(f, "\n %s", t);
5369 if (*s == '\\' && s[1] == 'n')
5379 if (*s++ == ':' && isspace(*s) && count > 45)
5381 fprintf(f, "\n "); /* sic (because space follows) */
5388 /***********************************************************
5389 * Print Diagnostic-Code for an address *
5390 ************************************************************/
5392 /* This function is called to print the error information out of an address for
5393 a bounce or a warning message. It tries to format the message reasonably as
5394 required by RFC 3461 by adding a space after each newline
5396 it uses the same logic as print_address_error() above. if af_pass_message is true
5397 and addr->message is set it uses the remote host answer. if not addr->user_message
5398 is used instead if available.
5402 f the FILE to print on
5408 print_dsn_diagnostic_code(const address_item *addr, FILE *f)
5410 uschar *s = testflag(addr, af_pass_message) ? addr->message : NULL;
5412 /* af_pass_message and addr->message set ? print remote host answer */
5416 debug_printf("DSN Diagnostic-Code: addr->message = %s\n", addr->message);
5418 /* search first ": ". we assume to find the remote-MTA answer there */
5419 if (!(s = Ustrstr(addr->message, ": ")))
5420 return; /* not found, bail out */
5421 s += 2; /* skip ": " */
5422 fprintf(f, "Diagnostic-Code: smtp; ");
5424 /* no message available. do nothing */
5428 if (*s == '\\' && s[1] == 'n')
5430 fputs("\n ", f); /* as defined in RFC 3461 */
5440 /*************************************************
5441 * Check list of addresses for duplication *
5442 *************************************************/
5444 /* This function was introduced when the test for duplicate addresses that are
5445 not pipes, files, or autoreplies was moved from the middle of routing to when
5446 routing was complete. That was to fix obscure cases when the routing history
5447 affects the subsequent routing of identical addresses. This function is called
5448 after routing, to check that the final routed addresses are not duplicates.
5450 If we detect a duplicate, we remember what it is a duplicate of. Note that
5451 pipe, file, and autoreply de-duplication is handled during routing, so we must
5452 leave such "addresses" alone here, as otherwise they will incorrectly be
5455 Argument: address of list anchor
5460 do_duplicate_check(address_item **anchor)
5463 while ((addr = *anchor))
5466 if (testflag(addr, af_pfr))
5468 anchor = &(addr->next);
5470 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
5472 DEBUG(D_deliver|D_route)
5473 debug_printf("%s is a duplicate address: discarded\n", addr->unique);
5474 *anchor = addr->next;
5475 addr->dupof = tnode->data.ptr;
5476 addr->next = addr_duplicate;
5477 addr_duplicate = addr;
5481 tree_add_duplicate(addr->unique, addr);
5482 anchor = &(addr->next);
5490 /*************************************************
5491 * Deliver one message *
5492 *************************************************/
5494 /* This is the function which is called when a message is to be delivered. It
5495 is passed the id of the message. It is possible that the message no longer
5496 exists, if some other process has delivered it, and it is also possible that
5497 the message is being worked on by another process, in which case the data file
5500 If no delivery is attempted for any of the above reasons, the function returns
5501 DELIVER_NOT_ATTEMPTED.
5503 If the give_up flag is set true, do not attempt any deliveries, but instead
5504 fail all outstanding addresses and return the message to the sender (or
5507 A delivery operation has a process all to itself; we never deliver more than
5508 one message in the same process. Therefore we needn't worry too much about
5511 Liable to be called as root.
5514 id the id of the message to be delivered
5515 forced TRUE if delivery was forced by an administrator; this overrides
5516 retry delays and causes a delivery to be tried regardless
5517 give_up TRUE if an administrator has requested that delivery attempts
5520 Returns: When the global variable mua_wrapper is FALSE:
5521 DELIVER_ATTEMPTED_NORMAL if a delivery attempt was made
5522 DELIVER_NOT_ATTEMPTED otherwise (see comment above)
5523 When the global variable mua_wrapper is TRUE:
5524 DELIVER_MUA_SUCCEEDED if delivery succeeded
5525 DELIVER_MUA_FAILED if delivery failed
5526 DELIVER_NOT_ATTEMPTED if not attempted (should not occur)
5530 deliver_message(uschar *id, BOOL forced, BOOL give_up)
5533 int final_yield = DELIVER_ATTEMPTED_NORMAL;
5534 time_t now = time(NULL);
5535 address_item *addr_last = NULL;
5536 uschar *filter_message = NULL;
5537 int process_recipients = RECIP_ACCEPT;
5540 extern int acl_where;
5542 uschar *info = queue_run_pid == (pid_t)0
5543 ? string_sprintf("delivering %s", id)
5544 : string_sprintf("delivering %s (queue run pid %d)", id, queue_run_pid);
5546 /* If the D_process_info bit is on, set_process_info() will output debugging
5547 information. If not, we want to show this initial information if D_deliver or
5548 D_queue_run is set or in verbose mode. */
5550 set_process_info("%s", info);
5552 if ( !(debug_selector & D_process_info)
5553 && (debug_selector & (D_deliver|D_queue_run|D_v))
5555 debug_printf("%s\n", info);
5557 /* Ensure that we catch any subprocesses that are created. Although Exim
5558 sets SIG_DFL as its initial default, some routes through the code end up
5559 here with it set to SIG_IGN - cases where a non-synchronous delivery process
5560 has been forked, but no re-exec has been done. We use sigaction rather than
5561 plain signal() on those OS where SA_NOCLDWAIT exists, because we want to be
5562 sure it is turned off. (There was a problem on AIX with this.) */
5566 struct sigaction act;
5567 act.sa_handler = SIG_DFL;
5568 sigemptyset(&(act.sa_mask));
5570 sigaction(SIGCHLD, &act, NULL);
5573 signal(SIGCHLD, SIG_DFL);
5576 /* Make the forcing flag available for routers and transports, set up the
5577 global message id field, and initialize the count for returned files and the
5578 message size. This use of strcpy() is OK because the length id is checked when
5579 it is obtained from a command line (the -M or -q options), and otherwise it is
5580 known to be a valid message id. */
5582 if (id != message_id)
5583 Ustrcpy(message_id, id);
5584 f.deliver_force = forced;
5588 /* Initialize some flags */
5590 update_spool = FALSE;
5591 remove_journal = TRUE;
5593 /* Set a known context for any ACLs we call via expansions */
5594 acl_where = ACL_WHERE_DELIVERY;
5596 /* Reset the random number generator, so that if several delivery processes are
5597 started from a queue runner that has already used random numbers (for sorting),
5598 they don't all get the same sequence. */
5602 /* Open and lock the message's data file. Exim locks on this one because the
5603 header file may get replaced as it is re-written during the delivery process.
5604 Any failures cause messages to be written to the log, except for missing files
5605 while queue running - another process probably completed delivery. As part of
5606 opening the data file, message_subdir gets set. */
5608 if ((deliver_datafile = spool_open_datafile(id)) < 0)
5609 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5611 /* The value of message_size at this point has been set to the data length,
5612 plus one for the blank line that notionally precedes the data. */
5614 /* Now read the contents of the header file, which will set up the headers in
5615 store, and also the list of recipients and the tree of non-recipients and
5616 assorted flags. It updates message_size. If there is a reading or format error,
5617 give up; if the message has been around for sufficiently long, remove it. */
5620 uschar * spoolname = string_sprintf("%s-H", id);
5621 if ((rc = spool_read_header(spoolname, TRUE, TRUE)) != spool_read_OK)
5623 if (errno == ERRNO_SPOOLFORMAT)
5625 struct stat statbuf;
5626 if (Ustat(spool_fname(US"input", message_subdir, spoolname, US""),
5628 log_write(0, LOG_MAIN, "Format error in spool file %s: "
5629 "size=" OFF_T_FMT, spoolname, statbuf.st_size);
5631 log_write(0, LOG_MAIN, "Format error in spool file %s", spoolname);
5634 log_write(0, LOG_MAIN, "Error reading spool file %s: %s", spoolname,
5637 /* If we managed to read the envelope data, received_time contains the
5638 time the message was received. Otherwise, we can calculate it from the
5641 if (rc != spool_read_hdrerror)
5643 received_time.tv_sec = received_time.tv_usec = 0;
5644 /*XXX subsec precision?*/
5645 for (i = 0; i < 6; i++)
5646 received_time.tv_sec = received_time.tv_sec * BASE_62 + tab62[id[i] - '0'];
5649 /* If we've had this malformed message too long, sling it. */
5651 if (now - received_time.tv_sec > keep_malformed)
5653 Uunlink(spool_fname(US"msglog", message_subdir, id, US""));
5654 Uunlink(spool_fname(US"input", message_subdir, id, US"-D"));
5655 Uunlink(spool_fname(US"input", message_subdir, id, US"-H"));
5656 Uunlink(spool_fname(US"input", message_subdir, id, US"-J"));
5657 log_write(0, LOG_MAIN, "Message removed because older than %s",
5658 readconf_printtime(keep_malformed));
5661 (void)close(deliver_datafile);
5662 deliver_datafile = -1;
5663 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5667 /* The spool header file has been read. Look to see if there is an existing
5668 journal file for this message. If there is, it means that a previous delivery
5669 attempt crashed (program or host) before it could update the spool header file.
5670 Read the list of delivered addresses from the journal and add them to the
5671 nonrecipients tree. Then update the spool file. We can leave the journal in
5672 existence, as it will get further successful deliveries added to it in this
5673 run, and it will be deleted if this function gets to its end successfully.
5674 Otherwise it might be needed again. */
5677 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
5680 if ( (journal_fd = Uopen(fname, O_RDWR|O_APPEND
5688 && lseek(journal_fd, 0, SEEK_SET) == 0
5689 && (jread = fdopen(journal_fd, "rb"))
5692 while (Ufgets(big_buffer, big_buffer_size, jread))
5694 int n = Ustrlen(big_buffer);
5695 big_buffer[n-1] = 0;
5696 tree_add_nonrecipient(big_buffer);
5697 DEBUG(D_deliver) debug_printf("Previously delivered address %s taken from "
5698 "journal file\n", big_buffer);
5701 if ((journal_fd = dup(fileno(jread))) < 0)
5702 journal_fd = fileno(jread);
5704 (void) fclose(jread); /* Try to not leak the FILE resource */
5706 /* Panic-dies on error */
5707 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
5709 else if (errno != ENOENT)
5711 log_write(0, LOG_MAIN|LOG_PANIC, "attempt to open journal for reading gave: "
5712 "%s", strerror(errno));
5713 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5716 /* A null recipients list indicates some kind of disaster. */
5718 if (!recipients_list)
5720 (void)close(deliver_datafile);
5721 deliver_datafile = -1;
5722 log_write(0, LOG_MAIN, "Spool error: no recipients for %s", fname);
5723 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5728 /* Handle a message that is frozen. There are a number of different things that
5729 can happen, but in the default situation, unless forced, no delivery is
5732 if (f.deliver_freeze)
5734 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
5735 /* Moving to another directory removes the message from Exim's view. Other
5736 tools must be used to deal with it. Logging of this action happens in
5737 spool_move_message() and its subfunctions. */
5739 if ( move_frozen_messages
5740 && spool_move_message(id, message_subdir, US"", US"F")
5742 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5745 /* For all frozen messages (bounces or not), timeout_frozen_after sets the
5746 maximum time to keep messages that are frozen. Thaw if we reach it, with a
5747 flag causing all recipients to be failed. The time is the age of the
5748 message, not the time since freezing. */
5750 if (timeout_frozen_after > 0 && message_age >= timeout_frozen_after)
5752 log_write(0, LOG_MAIN, "cancelled by timeout_frozen_after");
5753 process_recipients = RECIP_FAIL_TIMEOUT;
5756 /* For bounce messages (and others with no sender), thaw if the error message
5757 ignore timer is exceeded. The message will be discarded if this delivery
5760 else if (!*sender_address && message_age >= ignore_bounce_errors_after)
5761 log_write(0, LOG_MAIN, "Unfrozen by errmsg timer");
5763 /* If this is a bounce message, or there's no auto thaw, or we haven't
5764 reached the auto thaw time yet, and this delivery is not forced by an admin
5765 user, do not attempt delivery of this message. Note that forced is set for
5766 continuing messages down the same channel, in order to skip load checking and
5767 ignore hold domains, but we don't want unfreezing in that case. */
5771 if ( ( sender_address[0] == 0
5773 || now <= deliver_frozen_at + auto_thaw
5775 && ( !forced || !f.deliver_force_thaw
5776 || !f.admin_user || continue_hostname
5779 (void)close(deliver_datafile);
5780 deliver_datafile = -1;
5781 log_write(L_skip_delivery, LOG_MAIN, "Message is frozen");
5782 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5785 /* If delivery was forced (by an admin user), assume a manual thaw.
5786 Otherwise it's an auto thaw. */
5790 f.deliver_manual_thaw = TRUE;
5791 log_write(0, LOG_MAIN, "Unfrozen by forced delivery");
5793 else log_write(0, LOG_MAIN, "Unfrozen by auto-thaw");
5796 /* We get here if any of the rules for unfreezing have triggered. */
5798 f.deliver_freeze = FALSE;
5799 update_spool = TRUE;
5803 /* Open the message log file if we are using them. This records details of
5804 deliveries, deferments, and failures for the benefit of the mail administrator.
5805 The log is not used by exim itself to track the progress of a message; that is
5806 done by rewriting the header spool file. */
5810 uschar * fname = spool_fname(US"msglog", message_subdir, id, US"");
5814 if ((fd = open_msglog_file(fname, SPOOL_MODE, &error)) < 0)
5816 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't %s message log %s: %s", error,
5817 fname, strerror(errno));
5818 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5821 /* Make a C stream out of it. */
5823 if (!(message_log = fdopen(fd, "a")))
5825 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't fdopen message log %s: %s",
5826 fname, strerror(errno));
5827 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5832 /* If asked to give up on a message, log who did it, and set the action for all
5837 struct passwd *pw = getpwuid(real_uid);
5838 log_write(0, LOG_MAIN, "cancelled by %s",
5839 pw ? US pw->pw_name : string_sprintf("uid %ld", (long int)real_uid));
5840 process_recipients = RECIP_FAIL;
5843 /* Otherwise, if there are too many Received: headers, fail all recipients. */
5845 else if (received_count > received_headers_max)
5846 process_recipients = RECIP_FAIL_LOOP;
5848 /* Otherwise, if a system-wide, address-independent message filter is
5849 specified, run it now, except in the case when we are failing all recipients as
5850 a result of timeout_frozen_after. If the system filter yields "delivered", then
5851 ignore the true recipients of the message. Failure of the filter file is
5852 logged, and the delivery attempt fails. */
5854 else if (system_filter && process_recipients != RECIP_FAIL_TIMEOUT)
5859 redirect_block redirect;
5861 if (system_filter_uid_set)
5863 ugid.uid = system_filter_uid;
5864 ugid.gid = system_filter_gid;
5865 ugid.uid_set = ugid.gid_set = TRUE;
5868 ugid.uid_set = ugid.gid_set = FALSE;
5870 return_path = sender_address;
5871 f.enable_dollar_recipients = TRUE; /* Permit $recipients in system filter */
5872 f.system_filtering = TRUE;
5874 /* Any error in the filter file causes a delivery to be abandoned. */
5876 redirect.string = system_filter;
5877 redirect.isfile = TRUE;
5878 redirect.check_owner = redirect.check_group = FALSE;
5879 redirect.owners = NULL;
5880 redirect.owngroups = NULL;
5882 redirect.modemask = 0;
5884 DEBUG(D_deliver|D_filter) debug_printf("running system filter\n");
5887 &redirect, /* Where the data is */
5888 RDO_DEFER | /* Turn on all the enabling options */
5889 RDO_FAIL | /* Leave off all the disabling options */
5894 NULL, /* No :include: restriction (not used in filter) */
5895 NULL, /* No sieve vacation directory (not sieve!) */
5896 NULL, /* No sieve enotify mailto owner (not sieve!) */
5897 NULL, /* No sieve user address (not sieve!) */
5898 NULL, /* No sieve subaddress (not sieve!) */
5899 &ugid, /* uid/gid data */
5900 &addr_new, /* Where to hang generated addresses */
5901 &filter_message, /* Where to put error message */
5902 NULL, /* Don't skip syntax errors */
5903 &filtertype, /* Will always be set to FILTER_EXIM for this call */
5904 US"system filter"); /* For error messages */
5906 DEBUG(D_deliver|D_filter) debug_printf("system filter returned %d\n", rc);
5908 if (rc == FF_ERROR || rc == FF_NONEXIST)
5910 (void)close(deliver_datafile);
5911 deliver_datafile = -1;
5912 log_write(0, LOG_MAIN|LOG_PANIC, "Error in system filter: %s",
5913 string_printing(filter_message));
5914 return continue_closedown(); /* yields DELIVER_NOT_ATTEMPTED */
5917 /* Reset things. If the filter message is an empty string, which can happen
5918 for a filter "fail" or "freeze" command with no text, reset it to NULL. */
5920 f.system_filtering = FALSE;
5921 f.enable_dollar_recipients = FALSE;
5922 if (filter_message && filter_message[0] == 0) filter_message = NULL;
5924 /* Save the values of the system filter variables so that user filters
5927 memcpy(filter_sn, filter_n, sizeof(filter_sn));
5929 /* The filter can request that delivery of the original addresses be
5934 process_recipients = RECIP_DEFER;
5935 deliver_msglog("Delivery deferred by system filter\n");
5936 log_write(0, LOG_MAIN, "Delivery deferred by system filter");
5939 /* The filter can request that a message be frozen, but this does not
5940 take place if the message has been manually thawed. In that case, we must
5941 unset "delivered", which is forced by the "freeze" command to make -bF
5944 else if (rc == FF_FREEZE && !f.deliver_manual_thaw)
5946 f.deliver_freeze = TRUE;
5947 deliver_frozen_at = time(NULL);
5948 process_recipients = RECIP_DEFER;
5949 frozen_info = string_sprintf(" by the system filter%s%s",
5950 filter_message ? US": " : US"",
5951 filter_message ? filter_message : US"");
5954 /* The filter can request that a message be failed. The error message may be
5955 quite long - it is sent back to the sender in the bounce - but we don't want
5956 to fill up the log with repetitions of it. If it starts with << then the text
5957 between << and >> is written to the log, with the rest left for the bounce
5960 else if (rc == FF_FAIL)
5962 uschar *colon = US"";
5963 uschar *logmsg = US"";
5966 process_recipients = RECIP_FAIL_FILTER;
5972 if ( filter_message[0] == '<'
5973 && filter_message[1] == '<'
5974 && (logend = Ustrstr(filter_message, ">>"))
5977 logmsg = filter_message + 2;
5978 loglen = logend - logmsg;
5979 filter_message = logend + 2;
5980 if (filter_message[0] == 0) filter_message = NULL;
5984 logmsg = filter_message;
5985 loglen = Ustrlen(filter_message);
5989 log_write(0, LOG_MAIN, "cancelled by system filter%s%.*s", colon, loglen,
5993 /* Delivery can be restricted only to those recipients (if any) that the
5994 filter specified. */
5996 else if (rc == FF_DELIVERED)
5998 process_recipients = RECIP_IGNORE;
6000 log_write(0, LOG_MAIN, "original recipients ignored (system filter)");
6002 log_write(0, LOG_MAIN, "=> discarded (system filter)");
6005 /* If any new addresses were created by the filter, fake up a "parent"
6006 for them. This is necessary for pipes, etc., which are expected to have
6007 parents, and it also gives some sensible logging for others. Allow
6008 pipes, files, and autoreplies, and run them as the filter uid if set,
6009 otherwise as the current uid. */
6013 int uid = (system_filter_uid_set)? system_filter_uid : geteuid();
6014 int gid = (system_filter_gid_set)? system_filter_gid : getegid();
6016 /* The text "system-filter" is tested in transport_set_up_command() and in
6017 set_up_shell_command() in the pipe transport, to enable them to permit
6018 $recipients, so don't change it here without also changing it there. */
6020 address_item *p = addr_new;
6021 address_item *parent = deliver_make_addr(US"system-filter", FALSE);
6023 parent->domain = string_copylc(qualify_domain_recipient);
6024 parent->local_part = US"system-filter";
6026 /* As part of this loop, we arrange for addr_last to end up pointing
6027 at the final address. This is used if we go on to add addresses for the
6028 original recipients. */
6032 if (parent->child_count == USHRT_MAX)
6033 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "system filter generated more "
6034 "than %d delivery addresses", USHRT_MAX);
6035 parent->child_count++;
6038 if (testflag(p, af_pfr))
6044 setflag(p, af_uid_set);
6045 setflag(p, af_gid_set);
6046 setflag(p, af_allow_file);
6047 setflag(p, af_allow_pipe);
6048 setflag(p, af_allow_reply);
6050 /* Find the name of the system filter's appropriate pfr transport */
6052 if (p->address[0] == '|')
6055 tpname = system_filter_pipe_transport;
6056 address_pipe = p->address;
6058 else if (p->address[0] == '>')
6061 tpname = system_filter_reply_transport;
6065 if (p->address[Ustrlen(p->address)-1] == '/')
6067 type = US"directory";
6068 tpname = system_filter_directory_transport;
6073 tpname = system_filter_file_transport;
6075 address_file = p->address;
6078 /* Now find the actual transport, first expanding the name. We have
6079 set address_file or address_pipe above. */
6083 uschar *tmp = expand_string(tpname);
6084 address_file = address_pipe = NULL;
6086 p->message = string_sprintf("failed to expand \"%s\" as a "
6087 "system filter transport name", tpname);
6091 p->message = string_sprintf("system_filter_%s_transport is unset",
6096 transport_instance *tp;
6097 for (tp = transports; tp; tp = tp->next)
6098 if (Ustrcmp(tp->name, tpname) == 0)
6104 p->message = string_sprintf("failed to find \"%s\" transport "
6105 "for system filter delivery", tpname);
6108 /* If we couldn't set up a transport, defer the delivery, putting the
6109 error on the panic log as well as the main log. */
6113 address_item *badp = p;
6115 if (!addr_last) addr_new = p; else addr_last->next = p;
6116 badp->local_part = badp->address; /* Needed for log line */
6117 post_process_one(badp, DEFER, LOG_MAIN|LOG_PANIC, EXIM_DTYPE_ROUTER, 0);
6120 } /* End of pfr handling */
6122 /* Either a non-pfr delivery, or we found a transport */
6124 DEBUG(D_deliver|D_filter)
6125 debug_printf("system filter added %s\n", p->address);
6129 } /* Loop through all addr_new addresses */
6134 /* Scan the recipients list, and for every one that is not in the non-
6135 recipients tree, add an addr item to the chain of new addresses. If the pno
6136 value is non-negative, we must set the onetime parent from it. This which
6137 points to the relevant entry in the recipients list.
6139 This processing can be altered by the setting of the process_recipients
6140 variable, which is changed if recipients are to be ignored, failed, or
6141 deferred. This can happen as a result of system filter activity, or if the -Mg
6142 option is used to fail all of them.
6144 Duplicate addresses are handled later by a different tree structure; we can't
6145 just extend the non-recipients tree, because that will be re-written to the
6146 spool if the message is deferred, and in any case there are casing
6147 complications for local addresses. */
6149 if (process_recipients != RECIP_IGNORE)
6150 for (i = 0; i < recipients_count; i++)
6151 if (!tree_search(tree_nonrecipients, recipients_list[i].address))
6153 recipient_item *r = recipients_list + i;
6154 address_item *new = deliver_make_addr(r->address, FALSE);
6155 new->prop.errors_address = r->errors_to;
6157 if ((new->prop.utf8_msg = message_smtputf8))
6159 new->prop.utf8_downcvt = message_utf8_downconvert == 1;
6160 new->prop.utf8_downcvt_maybe = message_utf8_downconvert == -1;
6161 DEBUG(D_deliver) debug_printf("utf8, downconvert %s\n",
6162 new->prop.utf8_downcvt ? "yes"
6163 : new->prop.utf8_downcvt_maybe ? "ifneeded"
6169 new->onetime_parent = recipients_list[r->pno].address;
6171 /* If DSN support is enabled, set the dsn flags and the original receipt
6172 to be passed on to other DSN enabled MTAs */
6173 new->dsn_flags = r->dsn_flags & rf_dsnflags;
6174 new->dsn_orcpt = r->orcpt;
6175 DEBUG(D_deliver) debug_printf("DSN: set orcpt: %s flags: %d\n",
6176 new->dsn_orcpt ? new->dsn_orcpt : US"", new->dsn_flags);
6178 switch (process_recipients)
6180 /* RECIP_DEFER is set when a system filter freezes a message. */
6183 new->next = addr_defer;
6188 /* RECIP_FAIL_FILTER is set when a system filter has obeyed a "fail"
6191 case RECIP_FAIL_FILTER:
6193 filter_message ? filter_message : US"delivery cancelled";
6194 setflag(new, af_pass_message);
6195 goto RECIP_QUEUE_FAILED; /* below */
6198 /* RECIP_FAIL_TIMEOUT is set when a message is frozen, but is older
6199 than the value in timeout_frozen_after. Treat non-bounce messages
6200 similarly to -Mg; for bounce messages we just want to discard, so
6201 don't put the address on the failed list. The timeout has already
6204 case RECIP_FAIL_TIMEOUT:
6205 new->message = US"delivery cancelled; message timed out";
6206 goto RECIP_QUEUE_FAILED; /* below */
6209 /* RECIP_FAIL is set when -Mg has been used. */
6212 new->message = US"delivery cancelled by administrator";
6215 /* Common code for the failure cases above. If this is not a bounce
6216 message, put the address on the failed list so that it is used to
6217 create a bounce. Otherwise do nothing - this just discards the address.
6218 The incident has already been logged. */
6221 if (sender_address[0])
6223 new->next = addr_failed;
6229 /* RECIP_FAIL_LOOP is set when there are too many Received: headers
6230 in the message. Process each address as a routing failure; if this
6231 is a bounce message, it will get frozen. */
6233 case RECIP_FAIL_LOOP:
6234 new->message = US"Too many \"Received\" headers - suspected mail loop";
6235 post_process_one(new, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6239 /* Value should be RECIP_ACCEPT; take this as the safe default. */
6242 if (!addr_new) addr_new = new; else addr_last->next = new;
6247 #ifndef DISABLE_EVENT
6248 if (process_recipients != RECIP_ACCEPT)
6250 uschar * save_local = deliver_localpart;
6251 const uschar * save_domain = deliver_domain;
6252 uschar * addr = new->address, * errmsg = NULL;
6253 int start, end, dom;
6255 if (!parse_extract_address(addr, &errmsg, &start, &end, &dom, TRUE))
6256 log_write(0, LOG_MAIN|LOG_PANIC,
6257 "failed to parse address '%.100s': %s\n", addr, errmsg);
6261 string_copyn(addr+start, dom ? (dom-1) - start : end - start);
6262 deliver_domain = dom ? CUS string_copyn(addr+dom, end - dom) : CUS"";
6264 event_raise(event_action, US"msg:fail:internal", new->message);
6266 deliver_localpart = save_local;
6267 deliver_domain = save_domain;
6275 debug_printf("Delivery address list:\n");
6276 for (address_item * p = addr_new; p; p = p->next)
6277 debug_printf(" %s %s\n", p->address,
6278 p->onetime_parent ? p->onetime_parent : US"");
6281 /* Set up the buffers used for copying over the file when delivering. */
6283 deliver_in_buffer = store_malloc(DELIVER_IN_BUFFER_SIZE);
6284 deliver_out_buffer = store_malloc(DELIVER_OUT_BUFFER_SIZE);
6288 /* Until there are no more new addresses, handle each one as follows:
6290 . If this is a generated address (indicated by the presence of a parent
6291 pointer) then check to see whether it is a pipe, file, or autoreply, and
6292 if so, handle it directly here. The router that produced the address will
6293 have set the allow flags into the address, and also set the uid/gid required.
6294 Having the routers generate new addresses and then checking them here at
6295 the outer level is tidier than making each router do the checking, and
6296 means that routers don't need access to the failed address queue.
6298 . Break up the address into local part and domain, and make lowercased
6299 versions of these strings. We also make unquoted versions of the local part.
6301 . Handle the percent hack for those domains for which it is valid.
6303 . For child addresses, determine if any of the parents have the same address.
6304 If so, generate a different string for previous delivery checking. Without
6305 this code, if the address spqr generates spqr via a forward or alias file,
6306 delivery of the generated spqr stops further attempts at the top level spqr,
6307 which is not what is wanted - it may have generated other addresses.
6309 . Check on the retry database to see if routing was previously deferred, but
6310 only if in a queue run. Addresses that are to be routed are put on the
6311 addr_route chain. Addresses that are to be deferred are put on the
6312 addr_defer chain. We do all the checking first, so as not to keep the
6313 retry database open any longer than necessary.
6315 . Now we run the addresses through the routers. A router may put the address
6316 on either the addr_local or the addr_remote chain for local or remote
6317 delivery, respectively, or put it on the addr_failed chain if it is
6318 undeliveable, or it may generate child addresses and put them on the
6319 addr_new chain, or it may defer an address. All the chain anchors are
6320 passed as arguments so that the routers can be called for verification
6323 . If new addresses have been generated by the routers, da capo.
6326 f.header_rewritten = FALSE; /* No headers rewritten yet */
6327 while (addr_new) /* Loop until all addresses dealt with */
6329 address_item *addr, *parent;
6331 /* Failure to open the retry database is treated the same as if it does
6332 not exist. In both cases, dbm_file is NULL. */
6334 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
6335 DEBUG(D_deliver|D_retry|D_route|D_hints_lookup)
6336 debug_printf("no retry data available\n");
6338 /* Scan the current batch of new addresses, to handle pipes, files and
6339 autoreplies, and determine which others are ready for routing. */
6346 dbdata_retry *domain_retry_record;
6347 dbdata_retry *address_retry_record;
6350 addr_new = addr->next;
6352 DEBUG(D_deliver|D_retry|D_route)
6354 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6355 debug_printf("Considering: %s\n", addr->address);
6358 /* Handle generated address that is a pipe or a file or an autoreply. */
6360 if (testflag(addr, af_pfr))
6362 /* If an autoreply in a filter could not generate a syntactically valid
6363 address, give up forthwith. Set af_ignore_error so that we don't try to
6364 generate a bounce. */
6366 if (testflag(addr, af_bad_reply))
6368 addr->basic_errno = ERRNO_BADADDRESS2;
6369 addr->local_part = addr->address;
6371 US"filter autoreply generated syntactically invalid recipient";
6372 addr->prop.ignore_error = TRUE;
6373 (void) post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6374 continue; /* with the next new address */
6377 /* If two different users specify delivery to the same pipe or file or
6378 autoreply, there should be two different deliveries, so build a unique
6379 string that incorporates the original address, and use this for
6380 duplicate testing and recording delivery, and also for retrying. */
6383 string_sprintf("%s:%s", addr->address, addr->parent->unique +
6384 (testflag(addr->parent, af_homonym)? 3:0));
6386 addr->address_retry_key = addr->domain_retry_key =
6387 string_sprintf("T:%s", addr->unique);
6389 /* If a filter file specifies two deliveries to the same pipe or file,
6390 we want to de-duplicate, but this is probably not wanted for two mail
6391 commands to the same address, where probably both should be delivered.
6392 So, we have to invent a different unique string in that case. Just
6393 keep piling '>' characters on the front. */
6395 if (addr->address[0] == '>')
6397 while (tree_search(tree_duplicates, addr->unique))
6398 addr->unique = string_sprintf(">%s", addr->unique);
6401 else if ((tnode = tree_search(tree_duplicates, addr->unique)))
6403 DEBUG(D_deliver|D_route)
6404 debug_printf("%s is a duplicate address: discarded\n", addr->address);
6405 addr->dupof = tnode->data.ptr;
6406 addr->next = addr_duplicate;
6407 addr_duplicate = addr;
6411 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6413 /* Check for previous delivery */
6415 if (tree_search(tree_nonrecipients, addr->unique))
6417 DEBUG(D_deliver|D_route)
6418 debug_printf("%s was previously delivered: discarded\n", addr->address);
6419 child_done(addr, tod_stamp(tod_log));
6423 /* Save for checking future duplicates */
6425 tree_add_duplicate(addr->unique, addr);
6427 /* Set local part and domain */
6429 addr->local_part = addr->address;
6430 addr->domain = addr->parent->domain;
6432 /* Ensure that the delivery is permitted. */
6434 if (testflag(addr, af_file))
6436 if (!testflag(addr, af_allow_file))
6438 addr->basic_errno = ERRNO_FORBIDFILE;
6439 addr->message = US"delivery to file forbidden";
6440 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6441 continue; /* with the next new address */
6444 else if (addr->address[0] == '|')
6446 if (!testflag(addr, af_allow_pipe))
6448 addr->basic_errno = ERRNO_FORBIDPIPE;
6449 addr->message = US"delivery to pipe forbidden";
6450 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6451 continue; /* with the next new address */
6454 else if (!testflag(addr, af_allow_reply))
6456 addr->basic_errno = ERRNO_FORBIDREPLY;
6457 addr->message = US"autoreply forbidden";
6458 (void)post_process_one(addr, FAIL, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6459 continue; /* with the next new address */
6462 /* If the errno field is already set to BADTRANSPORT, it indicates
6463 failure to expand a transport string, or find the associated transport,
6464 or an unset transport when one is required. Leave this test till now so
6465 that the forbid errors are given in preference. */
6467 if (addr->basic_errno == ERRNO_BADTRANSPORT)
6469 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6473 /* Treat /dev/null as a special case and abandon the delivery. This
6474 avoids having to specify a uid on the transport just for this case.
6475 Arrange for the transport name to be logged as "**bypassed**". */
6477 if (Ustrcmp(addr->address, "/dev/null") == 0)
6479 uschar *save = addr->transport->name;
6480 addr->transport->name = US"**bypassed**";
6481 (void)post_process_one(addr, OK, LOG_MAIN, EXIM_DTYPE_TRANSPORT, '=');
6482 addr->transport->name = save;
6483 continue; /* with the next new address */
6486 /* Pipe, file, or autoreply delivery is to go ahead as a normal local
6489 DEBUG(D_deliver|D_route)
6490 debug_printf("queued for %s transport\n", addr->transport->name);
6491 addr->next = addr_local;
6493 continue; /* with the next new address */
6496 /* Handle normal addresses. First, split up into local part and domain,
6497 handling the %-hack if necessary. There is the possibility of a defer from
6498 a lookup in percent_hack_domains. */
6500 if ((rc = deliver_split_address(addr)) == DEFER)
6502 addr->message = US"cannot check percent_hack_domains";
6503 addr->basic_errno = ERRNO_LISTDEFER;
6504 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6508 /* Check to see if the domain is held. If so, proceed only if the
6509 delivery was forced by hand. */
6511 deliver_domain = addr->domain; /* set $domain */
6512 if ( !forced && hold_domains
6513 && (rc = match_isinlist(addr->domain, (const uschar **)&hold_domains, 0,
6514 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE,
6520 addr->message = US"hold_domains lookup deferred";
6521 addr->basic_errno = ERRNO_LISTDEFER;
6525 addr->message = US"domain is held";
6526 addr->basic_errno = ERRNO_HELD;
6528 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_NONE, 0);
6532 /* Now we can check for duplicates and previously delivered addresses. In
6533 order to do this, we have to generate a "unique" value for each address,
6534 because there may be identical actual addresses in a line of descendents.
6535 The "unique" field is initialized to the same value as the "address" field,
6536 but gets changed here to cope with identically-named descendents. */
6538 for (parent = addr->parent; parent; parent = parent->parent)
6539 if (strcmpic(addr->address, parent->address) == 0) break;
6541 /* If there's an ancestor with the same name, set the homonym flag. This
6542 influences how deliveries are recorded. Then add a prefix on the front of
6543 the unique address. We use \n\ where n starts at 0 and increases each time.
6544 It is unlikely to pass 9, but if it does, it may look odd but will still
6545 work. This means that siblings or cousins with the same names are treated
6546 as duplicates, which is what we want. */
6550 setflag(addr, af_homonym);
6551 if (parent->unique[0] != '\\')
6552 addr->unique = string_sprintf("\\0\\%s", addr->address);
6554 addr->unique = string_sprintf("\\%c\\%s", parent->unique[1] + 1,
6558 /* Ensure that the domain in the unique field is lower cased, because
6559 domains are always handled caselessly. */
6561 p = Ustrrchr(addr->unique, '@');
6562 while (*p != 0) { *p = tolower(*p); p++; }
6564 DEBUG(D_deliver|D_route) debug_printf("unique = %s\n", addr->unique);
6566 if (tree_search(tree_nonrecipients, addr->unique))
6568 DEBUG(D_deliver|D_route)
6569 debug_printf("%s was previously delivered: discarded\n", addr->unique);
6570 child_done(addr, tod_stamp(tod_log));
6574 /* Get the routing retry status, saving the two retry keys (with and
6575 without the local part) for subsequent use. If there is no retry record for
6576 the standard address routing retry key, we look for the same key with the
6577 sender attached, because this form is used by the smtp transport after a
6578 4xx response to RCPT when address_retry_include_sender is true. */
6580 addr->domain_retry_key = string_sprintf("R:%s", addr->domain);
6581 addr->address_retry_key = string_sprintf("R:%s@%s", addr->local_part,
6586 domain_retry_record = dbfn_read(dbm_file, addr->domain_retry_key);
6587 if ( domain_retry_record
6588 && now - domain_retry_record->time_stamp > retry_data_expire
6591 DEBUG(D_deliver|D_retry)
6592 debug_printf("domain retry record present but expired\n");
6593 domain_retry_record = NULL; /* Ignore if too old */
6596 address_retry_record = dbfn_read(dbm_file, addr->address_retry_key);
6597 if ( address_retry_record
6598 && now - address_retry_record->time_stamp > retry_data_expire
6601 DEBUG(D_deliver|D_retry)
6602 debug_printf("address retry record present but expired\n");
6603 address_retry_record = NULL; /* Ignore if too old */
6606 if (!address_retry_record)
6608 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6610 address_retry_record = dbfn_read(dbm_file, altkey);
6611 if ( address_retry_record
6612 && now - address_retry_record->time_stamp > retry_data_expire)
6614 DEBUG(D_deliver|D_retry)
6615 debug_printf("address<sender> retry record present but expired\n");
6616 address_retry_record = NULL; /* Ignore if too old */
6621 domain_retry_record = address_retry_record = NULL;
6623 DEBUG(D_deliver|D_retry)
6625 if (!domain_retry_record)
6626 debug_printf("no domain retry record\n");
6628 debug_printf("have domain retry record; next_try = now%+d\n",
6629 f.running_in_test_harness ? 0 :
6630 (int)(domain_retry_record->next_try - now));
6632 if (!address_retry_record)
6633 debug_printf("no address retry record\n");
6635 debug_printf("have address retry record; next_try = now%+d\n",
6636 f.running_in_test_harness ? 0 :
6637 (int)(address_retry_record->next_try - now));
6640 /* If we are sending a message down an existing SMTP connection, we must
6641 assume that the message which created the connection managed to route
6642 an address to that connection. We do not want to run the risk of taking
6643 a long time over routing here, because if we do, the server at the other
6644 end of the connection may time it out. This is especially true for messages
6645 with lots of addresses. For this kind of delivery, queue_running is not
6646 set, so we would normally route all addresses. We take a pragmatic approach
6647 and defer routing any addresses that have any kind of domain retry record.
6648 That is, we don't even look at their retry times. It doesn't matter if this
6649 doesn't work occasionally. This is all just an optimization, after all.
6651 The reason for not doing the same for address retries is that they normally
6652 arise from 4xx responses, not DNS timeouts. */
6654 if (continue_hostname && domain_retry_record)
6656 addr->message = US"reusing SMTP connection skips previous routing defer";
6657 addr->basic_errno = ERRNO_RRETRY;
6658 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6660 addr->message = domain_retry_record->text;
6661 setflag(addr, af_pass_message);
6664 /* If we are in a queue run, defer routing unless there is no retry data or
6665 we've passed the next retry time, or this message is forced. In other
6666 words, ignore retry data when not in a queue run.
6668 However, if the domain retry time has expired, always allow the routing
6669 attempt. If it fails again, the address will be failed. This ensures that
6670 each address is routed at least once, even after long-term routing
6673 If there is an address retry, check that too; just wait for the next
6674 retry time. This helps with the case when the temporary error on the
6675 address was really message-specific rather than address specific, since
6676 it allows other messages through.
6678 We also wait for the next retry time if this is a message sent down an
6679 existing SMTP connection (even though that will be forced). Otherwise there
6680 will be far too many attempts for an address that gets a 4xx error. In
6681 fact, after such an error, we should not get here because, the host should
6682 not be remembered as one this message needs. However, there was a bug that
6683 used to cause this to happen, so it is best to be on the safe side.
6685 Even if we haven't reached the retry time in the hints, there is one more
6686 check to do, which is for the ultimate address timeout. We only do this
6687 check if there is an address retry record and there is not a domain retry
6688 record; this implies that previous attempts to handle the address had the
6689 retry_use_local_parts option turned on. We use this as an approximation
6690 for the destination being like a local delivery, for example delivery over
6691 LMTP to an IMAP message store. In this situation users are liable to bump
6692 into their quota and thereby have intermittently successful deliveries,
6693 which keep the retry record fresh, which can lead to us perpetually
6694 deferring messages. */
6696 else if ( ( f.queue_running && !f.deliver_force
6697 || continue_hostname
6699 && ( ( domain_retry_record
6700 && now < domain_retry_record->next_try
6701 && !domain_retry_record->expired
6703 || ( address_retry_record
6704 && now < address_retry_record->next_try
6706 && ( domain_retry_record
6707 || !address_retry_record
6708 || !retry_ultimate_address_timeout(addr->address_retry_key,
6709 addr->domain, address_retry_record, now)
6712 addr->message = US"retry time not reached";
6713 addr->basic_errno = ERRNO_RRETRY;
6714 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6716 /* For remote-retry errors (here and just above) that we've not yet
6717 hit the rery time, use the error recorded in the retry database
6718 as info in the warning message. This lets us send a message even
6719 when we're not failing on a fresh attempt. We assume that this
6720 info is not sensitive. */
6722 addr->message = domain_retry_record
6723 ? domain_retry_record->text : address_retry_record->text;
6724 setflag(addr, af_pass_message);
6727 /* The domain is OK for routing. Remember if retry data exists so it
6728 can be cleaned up after a successful delivery. */
6732 if (domain_retry_record || address_retry_record)
6733 setflag(addr, af_dr_retry_exists);
6734 addr->next = addr_route;
6736 DEBUG(D_deliver|D_route)
6737 debug_printf("%s: queued for routing\n", addr->address);
6741 /* The database is closed while routing is actually happening. Requests to
6742 update it are put on a chain and all processed together at the end. */
6744 if (dbm_file) dbfn_close(dbm_file);
6746 /* If queue_domains is set, we don't even want to try routing addresses in
6747 those domains. During queue runs, queue_domains is forced to be unset.
6748 Optimize by skipping this pass through the addresses if nothing is set. */
6750 if (!f.deliver_force && queue_domains)
6752 address_item *okaddr = NULL;
6755 address_item *addr = addr_route;
6756 addr_route = addr->next;
6758 deliver_domain = addr->domain; /* set $domain */
6759 if ((rc = match_isinlist(addr->domain, (const uschar **)&queue_domains, 0,
6760 &domainlist_anchor, addr->domain_cache, MCL_DOMAIN, TRUE, NULL))
6764 addr->basic_errno = ERRNO_LISTDEFER;
6765 addr->message = US"queue_domains lookup deferred";
6766 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6770 addr->next = okaddr;
6775 addr->basic_errno = ERRNO_QUEUE_DOMAIN;
6776 addr->message = US"domain is in queue_domains";
6777 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6781 addr_route = okaddr;
6784 /* Now route those addresses that are not deferred. */
6789 address_item *addr = addr_route;
6790 const uschar *old_domain = addr->domain;
6791 uschar *old_unique = addr->unique;
6792 addr_route = addr->next;
6795 /* Just in case some router parameter refers to it. */
6797 if (!(return_path = addr->prop.errors_address))
6798 return_path = sender_address;
6800 /* If a router defers an address, add a retry item. Whether or not to
6801 use the local part in the key is a property of the router. */
6803 if ((rc = route_address(addr, &addr_local, &addr_remote, &addr_new,
6804 &addr_succeed, v_none)) == DEFER)
6805 retry_add_item(addr,
6806 addr->router->retry_use_local_part
6807 ? string_sprintf("R:%s@%s", addr->local_part, addr->domain)
6808 : string_sprintf("R:%s", addr->domain),
6811 /* Otherwise, if there is an existing retry record in the database, add
6812 retry items to delete both forms. We must also allow for the possibility
6813 of a routing retry that includes the sender address. Since the domain might
6814 have been rewritten (expanded to fully qualified) as a result of routing,
6815 ensure that the rewritten form is also deleted. */
6817 else if (testflag(addr, af_dr_retry_exists))
6819 uschar *altkey = string_sprintf("%s:<%s>", addr->address_retry_key,
6821 retry_add_item(addr, altkey, rf_delete);
6822 retry_add_item(addr, addr->address_retry_key, rf_delete);
6823 retry_add_item(addr, addr->domain_retry_key, rf_delete);
6824 if (Ustrcmp(addr->domain, old_domain) != 0)
6825 retry_add_item(addr, string_sprintf("R:%s", old_domain), rf_delete);
6828 /* DISCARD is given for :blackhole: and "seen finish". The event has been
6829 logged, but we need to ensure the address (and maybe parents) is marked
6834 address_done(addr, tod_stamp(tod_log));
6835 continue; /* route next address */
6838 /* The address is finished with (failed or deferred). */
6842 (void)post_process_one(addr, rc, LOG_MAIN, EXIM_DTYPE_ROUTER, 0);
6843 continue; /* route next address */
6846 /* The address has been routed. If the router changed the domain, it will
6847 also have changed the unique address. We have to test whether this address
6848 has already been delivered, because it's the unique address that finally
6851 if ( addr->unique != old_unique
6852 && tree_search(tree_nonrecipients, addr->unique) != 0
6855 DEBUG(D_deliver|D_route) debug_printf("%s was previously delivered: "
6856 "discarded\n", addr->address);
6857 if (addr_remote == addr) addr_remote = addr->next;
6858 else if (addr_local == addr) addr_local = addr->next;
6861 /* If the router has same_domain_copy_routing set, we are permitted to copy
6862 the routing for any other addresses with the same domain. This is an
6863 optimisation to save repeated DNS lookups for "standard" remote domain
6864 routing. The option is settable only on routers that generate host lists.
6865 We play it very safe, and do the optimization only if the address is routed
6866 to a remote transport, there are no header changes, and the domain was not
6867 modified by the router. */
6869 if ( addr_remote == addr
6870 && addr->router->same_domain_copy_routing
6871 && !addr->prop.extra_headers
6872 && !addr->prop.remove_headers
6873 && old_domain == addr->domain
6876 address_item **chain = &addr_route;
6879 address_item *addr2 = *chain;
6880 if (Ustrcmp(addr2->domain, addr->domain) != 0)
6882 chain = &(addr2->next);
6886 /* Found a suitable address; take it off the routing list and add it to
6887 the remote delivery list. */
6889 *chain = addr2->next;
6890 addr2->next = addr_remote;
6891 addr_remote = addr2;
6893 /* Copy the routing data */
6895 addr2->domain = addr->domain;
6896 addr2->router = addr->router;
6897 addr2->transport = addr->transport;
6898 addr2->host_list = addr->host_list;
6899 addr2->fallback_hosts = addr->fallback_hosts;
6900 addr2->prop.errors_address = addr->prop.errors_address;
6901 copyflag(addr2, addr, af_hide_child);
6902 copyflag(addr2, addr, af_local_host_removed);
6904 DEBUG(D_deliver|D_route)
6905 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"
6907 "Routing for %s copied from %s\n",
6908 addr2->address, addr2->address, addr->address);
6911 } /* Continue with routing the next address. */
6912 } /* Loop to process any child addresses that the routers created, and
6913 any rerouted addresses that got put back on the new chain. */
6916 /* Debugging: show the results of the routing */
6918 DEBUG(D_deliver|D_retry|D_route)
6920 debug_printf(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n");
6921 debug_printf("After routing:\n Local deliveries:\n");
6922 for (address_item * p = addr_local; p; p = p->next)
6923 debug_printf(" %s\n", p->address);
6925 debug_printf(" Remote deliveries:\n");
6926 for (address_item * p = addr_remote; p; p = p->next)
6927 debug_printf(" %s\n", p->address);
6929 debug_printf(" Failed addresses:\n");
6930 for (address_item * p = addr_failed; p; p = p->next)
6931 debug_printf(" %s\n", p->address);
6933 debug_printf(" Deferred addresses:\n");
6934 for (address_item * p = addr_defer; p; p = p->next)
6935 debug_printf(" %s\n", p->address);
6938 /* Free any resources that were cached during routing. */
6943 /* These two variables are set only during routing, after check_local_user.
6944 Ensure they are not set in transports. */
6946 local_user_gid = (gid_t)(-1);
6947 local_user_uid = (uid_t)(-1);
6949 /* Check for any duplicate addresses. This check is delayed until after
6950 routing, because the flexibility of the routing configuration means that
6951 identical addresses with different parentage may end up being redirected to
6952 different addresses. Checking for duplicates too early (as we previously used
6953 to) makes this kind of thing not work. */
6955 do_duplicate_check(&addr_local);
6956 do_duplicate_check(&addr_remote);
6958 /* When acting as an MUA wrapper, we proceed only if all addresses route to a
6959 remote transport. The check that they all end up in one transaction happens in
6960 the do_remote_deliveries() function. */
6963 && (addr_local || addr_failed || addr_defer)
6967 uschar *which, *colon, *msg;
6974 else if (addr_defer)
6977 which = US"deferred";
6985 while (addr->parent) addr = addr->parent;
6990 msg = addr->message;
6992 else colon = msg = US"";
6994 /* We don't need to log here for a forced failure as it will already
6995 have been logged. Defer will also have been logged, but as a defer, so we do
6996 need to do the failure logging. */
6998 if (addr != addr_failed)
6999 log_write(0, LOG_MAIN, "** %s routing yielded a %s delivery",
7000 addr->address, which);
7002 /* Always write an error to the caller */
7004 fprintf(stderr, "routing %s yielded a %s delivery%s%s\n", addr->address,
7007 final_yield = DELIVER_MUA_FAILED;
7008 addr_failed = addr_defer = NULL; /* So that we remove the message */
7009 goto DELIVERY_TIDYUP;
7013 /* If this is a run to continue deliveries to an external channel that is
7014 already set up, defer any local deliveries. */
7016 if (continue_transport)
7020 address_item *addr = addr_defer;
7021 while (addr->next) addr = addr->next;
7022 addr->next = addr_local;
7025 addr_defer = addr_local;
7030 /* Because address rewriting can happen in the routers, we should not really do
7031 ANY deliveries until all addresses have been routed, so that all recipients of
7032 the message get the same headers. However, this is in practice not always
7033 possible, since sometimes remote addresses give DNS timeouts for days on end.
7034 The pragmatic approach is to deliver what we can now, saving any rewritten
7035 headers so that at least the next lot of recipients benefit from the rewriting
7036 that has already been done.
7038 If any headers have been rewritten during routing, update the spool file to
7039 remember them for all subsequent deliveries. This can be delayed till later if
7040 there is only address to be delivered - if it succeeds the spool write need not
7043 if ( f.header_rewritten
7044 && ( addr_local && (addr_local->next || addr_remote)
7045 || addr_remote && addr_remote->next
7048 /* Panic-dies on error */
7049 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7050 f.header_rewritten = FALSE;
7054 /* If there are any deliveries to do and we do not already have the journal
7055 file, create it. This is used to record successful deliveries as soon as
7056 possible after each delivery is known to be complete. A file opened with
7057 O_APPEND is used so that several processes can run simultaneously.
7059 The journal is just insurance against crashes. When the spool file is
7060 ultimately updated at the end of processing, the journal is deleted. If a
7061 journal is found to exist at the start of delivery, the addresses listed
7062 therein are added to the non-recipients. */
7064 if (addr_local || addr_remote)
7068 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
7070 if ((journal_fd = Uopen(fname,
7074 O_WRONLY|O_APPEND|O_CREAT|O_EXCL, SPOOL_MODE)) < 0)
7076 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't open journal file %s: %s",
7077 fname, strerror(errno));
7078 return DELIVER_NOT_ATTEMPTED;
7081 /* Set the close-on-exec flag, make the file owned by Exim, and ensure
7082 that the mode is correct - the group setting doesn't always seem to get
7083 set automatically. */
7085 if( fchown(journal_fd, exim_uid, exim_gid)
7086 || fchmod(journal_fd, SPOOL_MODE)
7088 || fcntl(journal_fd, F_SETFD, fcntl(journal_fd, F_GETFD) | FD_CLOEXEC)
7092 int ret = Uunlink(fname);
7093 log_write(0, LOG_MAIN|LOG_PANIC, "Couldn't set perms on journal file %s: %s",
7094 fname, strerror(errno));
7095 if(ret && errno != ENOENT)
7096 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7097 fname, strerror(errno));
7098 return DELIVER_NOT_ATTEMPTED;
7102 else if (journal_fd >= 0)
7110 /* Now we can get down to the business of actually doing deliveries. Local
7111 deliveries are done first, then remote ones. If ever the problems of how to
7112 handle fallback transports are figured out, this section can be put into a loop
7113 for handling fallbacks, though the uid switching will have to be revised. */
7115 /* Precompile a regex that is used to recognize a parameter in response
7116 to an LHLO command, if is isn't already compiled. This may be used on both
7117 local and remote LMTP deliveries. */
7119 if (!regex_IGNOREQUOTA)
7121 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
7123 /* Handle local deliveries */
7127 DEBUG(D_deliver|D_transport)
7128 debug_printf(">>>>>>>>>>>>>>>> Local deliveries >>>>>>>>>>>>>>>>\n");
7129 do_local_deliveries();
7130 f.disable_logging = FALSE;
7133 /* If queue_run_local is set, we do not want to attempt any remote deliveries,
7134 so just queue them all. */
7136 if (f.queue_run_local)
7139 address_item *addr = addr_remote;
7140 addr_remote = addr->next;
7142 addr->basic_errno = ERRNO_LOCAL_ONLY;
7143 addr->message = US"remote deliveries suppressed";
7144 (void)post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
7147 /* Handle remote deliveries */
7151 DEBUG(D_deliver|D_transport)
7152 debug_printf(">>>>>>>>>>>>>>>> Remote deliveries >>>>>>>>>>>>>>>>\n");
7154 /* Precompile some regex that are used to recognize parameters in response
7155 to an EHLO command, if they aren't already compiled. */
7159 /* Now sort the addresses if required, and do the deliveries. The yield of
7160 do_remote_deliveries is FALSE when mua_wrapper is set and all addresses
7161 cannot be delivered in one transaction. */
7163 if (remote_sort_domains) sort_remote_deliveries();
7164 if (!do_remote_deliveries(FALSE))
7166 log_write(0, LOG_MAIN, "** mua_wrapper is set but recipients cannot all "
7167 "be delivered in one transaction");
7168 fprintf(stderr, "delivery to smarthost failed (configuration problem)\n");
7170 final_yield = DELIVER_MUA_FAILED;
7171 addr_failed = addr_defer = NULL; /* So that we remove the message */
7172 goto DELIVERY_TIDYUP;
7175 /* See if any of the addresses that failed got put on the queue for delivery
7176 to their fallback hosts. We do it this way because often the same fallback
7177 host is used for many domains, so all can be sent in a single transaction
7178 (if appropriately configured). */
7180 if (addr_fallback && !mua_wrapper)
7182 DEBUG(D_deliver) debug_printf("Delivering to fallback hosts\n");
7183 addr_remote = addr_fallback;
7184 addr_fallback = NULL;
7185 if (remote_sort_domains) sort_remote_deliveries();
7186 do_remote_deliveries(TRUE);
7188 f.disable_logging = FALSE;
7192 /* All deliveries are now complete. Ignore SIGTERM during this tidying up
7193 phase, to minimize cases of half-done things. */
7196 debug_printf(">>>>>>>>>>>>>>>> deliveries are done >>>>>>>>>>>>>>>>\n");
7197 cancel_cutthrough_connection(TRUE, US"deliveries are done");
7199 /* Root privilege is no longer needed */
7201 exim_setugid(exim_uid, exim_gid, FALSE, US"post-delivery tidying");
7203 set_process_info("tidying up after delivering %s", message_id);
7204 signal(SIGTERM, SIG_IGN);
7206 /* When we are acting as an MUA wrapper, the smtp transport will either have
7207 succeeded for all addresses, or failed them all in normal cases. However, there
7208 are some setup situations (e.g. when a named port does not exist) that cause an
7209 immediate exit with deferral of all addresses. Convert those into failures. We
7210 do not ever want to retry, nor do we want to send a bounce message. */
7216 address_item * nextaddr;
7217 for (address_item * addr = addr_defer; addr; addr = nextaddr)
7219 log_write(0, LOG_MAIN, "** %s mua_wrapper forced failure for deferred "
7220 "delivery", addr->address);
7221 nextaddr = addr->next;
7222 addr->next = addr_failed;
7228 /* Now all should either have succeeded or failed. */
7231 final_yield = DELIVER_MUA_SUCCEEDED;
7235 uschar *s = addr_failed->user_message;
7237 if (!s) s = addr_failed->message;
7239 fprintf(stderr, "Delivery failed: ");
7240 if (addr_failed->basic_errno > 0)
7242 fprintf(stderr, "%s", strerror(addr_failed->basic_errno));
7243 if (s) fprintf(stderr, ": ");
7245 if ((host = addr_failed->host_used))
7246 fprintf(stderr, "H=%s [%s]: ", host->name, host->address);
7248 fprintf(stderr, "%s", CS s);
7249 else if (addr_failed->basic_errno <= 0)
7250 fprintf(stderr, "unknown error");
7251 fprintf(stderr, "\n");
7253 final_yield = DELIVER_MUA_FAILED;
7258 /* In a normal configuration, we now update the retry database. This is done in
7259 one fell swoop at the end in order not to keep opening and closing (and
7260 locking) the database. The code for handling retries is hived off into a
7261 separate module for convenience. We pass it the addresses of the various
7262 chains, because deferred addresses can get moved onto the failed chain if the
7263 retry cutoff time has expired for all alternative destinations. Bypass the
7264 updating of the database if the -N flag is set, which is a debugging thing that
7265 prevents actual delivery. */
7267 else if (!f.dont_deliver)
7268 retry_update(&addr_defer, &addr_failed, &addr_succeed);
7270 /* Send DSN for successful messages if requested */
7271 addr_senddsn = NULL;
7273 for (addr_dsntmp = addr_succeed; addr_dsntmp; addr_dsntmp = addr_dsntmp->next)
7275 /* af_ignore_error not honored here. it's not an error */
7276 DEBUG(D_deliver) debug_printf("DSN: processing router : %s\n"
7277 "DSN: processing successful delivery address: %s\n"
7278 "DSN: Sender_address: %s\n"
7279 "DSN: orcpt: %s flags: %d\n"
7280 "DSN: envid: %s ret: %d\n"
7281 "DSN: Final recipient: %s\n"
7282 "DSN: Remote SMTP server supports DSN: %d\n",
7283 addr_dsntmp->router ? addr_dsntmp->router->name : US"(unknown)",
7284 addr_dsntmp->address,
7286 addr_dsntmp->dsn_orcpt ? addr_dsntmp->dsn_orcpt : US"NULL",
7287 addr_dsntmp->dsn_flags,
7288 dsn_envid ? dsn_envid : US"NULL", dsn_ret,
7289 addr_dsntmp->address,
7290 addr_dsntmp->dsn_aware
7293 /* send report if next hop not DSN aware or a router flagged "last DSN hop"
7294 and a report was requested */
7295 if ( ( addr_dsntmp->dsn_aware != dsn_support_yes
7296 || addr_dsntmp->dsn_flags & rf_dsnlasthop
7298 && addr_dsntmp->dsn_flags & rf_notify_success
7301 /* copy and relink address_item and send report with all of them at once later */
7302 address_item * addr_next = addr_senddsn;
7303 addr_senddsn = store_get(sizeof(address_item));
7304 *addr_senddsn = *addr_dsntmp;
7305 addr_senddsn->next = addr_next;
7308 DEBUG(D_deliver) debug_printf("DSN: not sending DSN success message\n");
7316 /* create exim process to send message */
7317 pid = child_open_exim(&fd);
7319 DEBUG(D_deliver) debug_printf("DSN: child_open_exim returns: %d\n", pid);
7321 if (pid < 0) /* Creation of child failed */
7323 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7324 "create child process to send failure message: %s", getpid(),
7325 getppid(), strerror(errno));
7327 DEBUG(D_deliver) debug_printf("DSN: child_open_exim failed\n");
7329 else /* Creation of child succeeded */
7331 FILE * f = fdopen(fd, "wb");
7332 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
7334 transport_ctx tctx = {{0}};
7337 debug_printf("sending error message to: %s\n", sender_address);
7339 /* build unique id for MIME boundary */
7340 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7341 DEBUG(D_deliver) debug_printf("DSN: MIME boundary: %s\n", bound);
7343 if (errors_reply_to)
7344 fprintf(f, "Reply-To: %s\n", errors_reply_to);
7346 fprintf(f, "Auto-Submitted: auto-generated\n"
7347 "From: Mail Delivery System <Mailer-Daemon@%s>\n"
7349 "Subject: Delivery Status Notification\n"
7350 "Content-Type: multipart/report; report-type=delivery-status; boundary=%s\n"
7351 "MIME-Version: 1.0\n\n"
7354 "Content-type: text/plain; charset=us-ascii\n\n"
7356 "This message was created automatically by mail delivery software.\n"
7357 " ----- The following addresses had successful delivery notifications -----\n",
7358 qualify_domain_sender, sender_address, bound, bound);
7360 for (addr_dsntmp = addr_senddsn; addr_dsntmp;
7361 addr_dsntmp = addr_dsntmp->next)
7362 fprintf(f, "<%s> (relayed %s)\n\n",
7363 addr_dsntmp->address,
7364 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "via non DSN router"
7365 : addr_dsntmp->dsn_aware == dsn_support_no ? "to non-DSN-aware mailer"
7366 : "via non \"Remote SMTP\" router"
7370 "Content-type: message/delivery-status\n\n"
7371 "Reporting-MTA: dns; %s\n",
7372 bound, smtp_active_hostname);
7375 { /* must be decoded from xtext: see RFC 3461:6.3a */
7377 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7378 fprintf(f, "Original-Envelope-ID: %s\n", dsn_envid);
7380 fprintf(f, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7384 for (addr_dsntmp = addr_senddsn;
7386 addr_dsntmp = addr_dsntmp->next)
7388 if (addr_dsntmp->dsn_orcpt)
7389 fprintf(f,"Original-Recipient: %s\n", addr_dsntmp->dsn_orcpt);
7391 fprintf(f, "Action: delivered\n"
7392 "Final-Recipient: rfc822;%s\n"
7394 addr_dsntmp->address);
7396 if (addr_dsntmp->host_used && addr_dsntmp->host_used->name)
7397 fprintf(f, "Remote-MTA: dns; %s\nDiagnostic-Code: smtp; 250 Ok\n\n",
7398 addr_dsntmp->host_used->name);
7400 fprintf(f, "Diagnostic-Code: X-Exim; relayed via non %s router\n\n",
7401 addr_dsntmp->dsn_flags & rf_dsnlasthop ? "DSN" : "SMTP");
7404 fprintf(f, "--%s\nContent-type: text/rfc822-headers\n\n", bound);
7407 transport_filter_argv = NULL; /* Just in case */
7408 return_path = sender_address; /* In case not previously set */
7410 /* Write the original email out */
7413 tctx.options = topt_add_return_path | topt_no_body;
7414 /*XXX hmm, retval ignored.
7415 Could error for any number of reasons, and they are not handled. */
7416 transport_write_message(&tctx, 0);
7419 fprintf(f,"\n--%s--\n", bound);
7423 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7427 /* If any addresses failed, we must send a message to somebody, unless
7428 af_ignore_error is set, in which case no action is taken. It is possible for
7429 several messages to get sent if there are addresses with different
7436 uschar *logtod = tod_stamp(tod_log);
7438 address_item *handled_addr = NULL;
7439 address_item **paddr;
7440 address_item *msgchain = NULL;
7441 address_item **pmsgchain = &msgchain;
7443 /* There are weird cases when logging is disabled in the transport. However,
7444 there may not be a transport (address failed by a router). */
7446 f.disable_logging = FALSE;
7447 if (addr_failed->transport)
7448 f.disable_logging = addr_failed->transport->disable_logging;
7451 debug_printf("processing failed address %s\n", addr_failed->address);
7453 /* There are only two ways an address in a bounce message can get here:
7455 (1) When delivery was initially deferred, but has now timed out (in the call
7456 to retry_update() above). We can detect this by testing for
7457 af_retry_timedout. If the address does not have its own errors address,
7458 we arrange to ignore the error.
7460 (2) If delivery failures for bounce messages are being ignored. We can detect
7461 this by testing for af_ignore_error. This will also be set if a bounce
7462 message has been autothawed and the ignore_bounce_errors_after time has
7463 passed. It might also be set if a router was explicitly configured to
7464 ignore errors (errors_to = "").
7466 If neither of these cases obtains, something has gone wrong. Log the
7467 incident, but then ignore the error. */
7469 if (sender_address[0] == 0 && !addr_failed->prop.errors_address)
7471 if ( !testflag(addr_failed, af_retry_timedout)
7472 && !addr_failed->prop.ignore_error)
7473 log_write(0, LOG_MAIN|LOG_PANIC, "internal error: bounce message "
7474 "failure is neither frozen nor ignored (it's been ignored)");
7476 addr_failed->prop.ignore_error = TRUE;
7479 /* If the first address on the list has af_ignore_error set, just remove
7480 it from the list, throw away any saved message file, log it, and
7481 mark the recipient done. */
7483 if ( addr_failed->prop.ignore_error
7484 || addr_failed->dsn_flags & (rf_dsnflags & ~rf_notify_failure)
7488 addr_failed = addr->next;
7489 if (addr->return_filename) Uunlink(addr->return_filename);
7491 #ifndef DISABLE_EVENT
7492 msg_event_raise(US"msg:fail:delivery", addr);
7494 log_write(0, LOG_MAIN, "%s%s%s%s: error ignored",
7496 !addr->parent ? US"" : US" <",
7497 !addr->parent ? US"" : addr->parent->address,
7498 !addr->parent ? US"" : US">");
7500 address_done(addr, logtod);
7501 child_done(addr, logtod);
7502 /* Panic-dies on error */
7503 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7506 /* Otherwise, handle the sending of a message. Find the error address for
7507 the first address, then send a message that includes all failed addresses
7508 that have the same error address. Note the bounce_recipient is a global so
7509 that it can be accessed by $bounce_recipient while creating a customized
7514 if (!(bounce_recipient = addr_failed->prop.errors_address))
7515 bounce_recipient = sender_address;
7517 /* Make a subprocess to send a message */
7519 if ((pid = child_open_exim(&fd)) < 0)
7520 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Process %d (parent %d) failed to "
7521 "create child process to send failure message: %s", getpid(),
7522 getppid(), strerror(errno));
7524 /* Creation of child succeeded */
7531 uschar *bcc, *emf_text;
7532 FILE * fp = fdopen(fd, "wb");
7534 BOOL to_sender = strcmpic(sender_address, bounce_recipient) == 0;
7535 int max = (bounce_return_size_limit/DELIVER_IN_BUFFER_SIZE + 1) *
7536 DELIVER_IN_BUFFER_SIZE;
7538 uschar *dsnlimitmsg;
7539 uschar *dsnnotifyhdr;
7543 debug_printf("sending error message to: %s\n", bounce_recipient);
7545 /* Scan the addresses for all that have the same errors address, removing
7546 them from the addr_failed chain, and putting them on msgchain. */
7548 paddr = &addr_failed;
7549 for (addr = addr_failed; addr; addr = *paddr)
7550 if (Ustrcmp(bounce_recipient, addr->prop.errors_address
7551 ? addr->prop.errors_address : sender_address) == 0)
7552 { /* The same - dechain */
7553 *paddr = addr->next;
7556 pmsgchain = &(addr->next);
7559 paddr = &addr->next; /* Not the same; skip */
7561 /* Include X-Failed-Recipients: for automatic interpretation, but do
7562 not let any one header line get too long. We do this by starting a
7563 new header every 50 recipients. Omit any addresses for which the
7564 "hide_child" flag is set. */
7566 for (addr = msgchain; addr; addr = addr->next)
7568 if (testflag(addr, af_hide_child)) continue;
7576 ? "X-Failed-Recipients: "
7578 testflag(addr, af_pfr) && addr->parent
7579 ? string_printing(addr->parent->address)
7580 : string_printing(addr->address));
7582 if (rcount > 0) fprintf(fp, "\n");
7584 /* Output the standard headers */
7586 if (errors_reply_to)
7587 fprintf(fp, "Reply-To: %s\n", errors_reply_to);
7588 fprintf(fp, "Auto-Submitted: auto-replied\n");
7589 moan_write_from(fp);
7590 fprintf(fp, "To: %s\n", bounce_recipient);
7592 /* generate boundary string and output MIME-Headers */
7593 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
7595 fprintf(fp, "Content-Type: multipart/report;"
7596 " report-type=delivery-status; boundary=%s\n"
7597 "MIME-Version: 1.0\n",
7600 /* Open a template file if one is provided. Log failure to open, but
7601 carry on - default texts will be used. */
7603 if (bounce_message_file)
7604 if (!(emf = Ufopen(bounce_message_file, "rb")))
7605 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for error "
7606 "message texts: %s", bounce_message_file, strerror(errno));
7608 /* Quietly copy to configured additional addresses if required. */
7610 if ((bcc = moan_check_errorcopy(bounce_recipient)))
7611 fprintf(fp, "Bcc: %s\n", bcc);
7613 /* The texts for the message can be read from a template file; if there
7614 isn't one, or if it is too short, built-in texts are used. The first
7615 emf text is a Subject: and any other headers. */
7617 if ((emf_text = next_emf(emf, US"header")))
7618 fprintf(fp, "%s\n", emf_text);
7620 fprintf(fp, "Subject: Mail delivery failed%s\n\n",
7621 to_sender? ": returning message to sender" : "");
7623 /* output human readable part as text/plain section */
7624 fprintf(fp, "--%s\n"
7625 "Content-type: text/plain; charset=us-ascii\n\n",
7628 if ((emf_text = next_emf(emf, US"intro")))
7629 fprintf(fp, "%s", CS emf_text);
7633 /* This message has been reworded several times. It seems to be confusing to
7634 somebody, however it is worded. I have retreated to the original, simple
7636 "This message was created automatically by mail delivery software.\n");
7638 if (bounce_message_text)
7639 fprintf(fp, "%s", CS bounce_message_text);
7642 "\nA message that you sent could not be delivered to one or more of its\n"
7643 "recipients. This is a permanent error. The following address(es) failed:\n");
7646 "\nA message sent by\n\n <%s>\n\n"
7647 "could not be delivered to one or more of its recipients. The following\n"
7648 "address(es) failed:\n", sender_address);
7652 /* Process the addresses, leaving them on the msgchain if they have a
7653 file name for a return message. (There has already been a check in
7654 post_process_one() for the existence of data in the message file.) A TRUE
7655 return from print_address_information() means that the address is not
7659 for (addr = msgchain; addr; addr = *paddr)
7661 if (print_address_information(addr, fp, US" ", US"\n ", US""))
7662 print_address_error(addr, fp, US"");
7664 /* End the final line for the address */
7668 /* Leave on msgchain if there's a return file. */
7670 if (addr->return_file >= 0)
7672 paddr = &(addr->next);
7676 /* Else save so that we can tick off the recipient when the
7681 *paddr = addr->next;
7682 addr->next = handled_addr;
7683 handled_addr = addr;
7689 /* Get the next text, whether we need it or not, so as to be
7690 positioned for the one after. */
7692 emf_text = next_emf(emf, US"generated text");
7694 /* If there were any file messages passed by the local transports,
7695 include them in the message. Then put the address on the handled chain.
7696 In the case of a batch of addresses that were all sent to the same
7697 transport, the return_file field in all of them will contain the same
7698 fd, and the return_filename field in the *last* one will be set (to the
7699 name of the file). */
7703 address_item *nextaddr;
7706 fprintf(fp, "%s", CS emf_text);
7709 "The following text was generated during the delivery "
7710 "attempt%s:\n", (filecount > 1)? "s" : "");
7712 for (addr = msgchain; addr; addr = nextaddr)
7715 address_item *topaddr = addr;
7717 /* List all the addresses that relate to this file */
7720 while(addr) /* Insurance */
7722 print_address_information(addr, fp, US"------ ", US"\n ",
7724 if (addr->return_filename) break;
7729 /* Now copy the file */
7731 if (!(fm = Ufopen(addr->return_filename, "rb")))
7732 fprintf(fp, " +++ Exim error... failed to open text file: %s\n",
7736 while ((ch = fgetc(fm)) != EOF) fputc(ch, fp);
7739 Uunlink(addr->return_filename);
7741 /* Can now add to handled chain, first fishing off the next
7742 address on the msgchain. */
7744 nextaddr = addr->next;
7745 addr->next = handled_addr;
7746 handled_addr = topaddr;
7751 /* output machine readable part */
7753 if (message_smtputf8)
7754 fprintf(fp, "--%s\n"
7755 "Content-type: message/global-delivery-status\n\n"
7756 "Reporting-MTA: dns; %s\n",
7757 bound, smtp_active_hostname);
7760 fprintf(fp, "--%s\n"
7761 "Content-type: message/delivery-status\n\n"
7762 "Reporting-MTA: dns; %s\n",
7763 bound, smtp_active_hostname);
7767 /* must be decoded from xtext: see RFC 3461:6.3a */
7769 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
7770 fprintf(fp, "Original-Envelope-ID: %s\n", dsn_envid);
7772 fprintf(fp, "X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
7776 for (addr = handled_addr; addr; addr = addr->next)
7779 fprintf(fp, "Action: failed\n"
7780 "Final-Recipient: rfc822;%s\n"
7783 if ((hu = addr->host_used) && hu->name)
7785 fprintf(fp, "Remote-MTA: dns; %s\n", hu->name);
7786 #ifdef EXPERIMENTAL_DSN_INFO
7791 uschar * p = hu->port == 25
7792 ? US"" : string_sprintf(":%d", hu->port);
7793 fprintf(fp, "Remote-MTA: X-ip; [%s]%s\n", hu->address, p);
7795 if ((s = addr->smtp_greeting) && *s)
7796 fprintf(fp, "X-Remote-MTA-smtp-greeting: X-str; %s\n", s);
7797 if ((s = addr->helo_response) && *s)
7798 fprintf(fp, "X-Remote-MTA-helo-response: X-str; %s\n", s);
7799 if ((s = addr->message) && *s)
7800 fprintf(fp, "X-Exim-Diagnostic: X-str; %s\n", s);
7803 print_dsn_diagnostic_code(addr, fp);
7808 /* Now copy the message, trying to give an intelligible comment if
7809 it is too long for it all to be copied. The limit isn't strictly
7810 applied because of the buffering. There is, however, an option
7811 to suppress copying altogether. */
7813 emf_text = next_emf(emf, US"copy");
7816 we ignore the intro text from template and add
7817 the text for bounce_return_size_limit at the end.
7819 bounce_return_message is ignored
7820 in case RET= is defined we honor these values
7821 otherwise bounce_return_body is honored.
7823 bounce_return_size_limit is always honored.
7826 fprintf(fp, "--%s\n", bound);
7828 dsnlimitmsg = US"X-Exim-DSN-Information: Due to administrative limits only headers are returned";
7829 dsnnotifyhdr = NULL;
7830 topt = topt_add_return_path;
7832 /* RET=HDRS? top priority */
7833 if (dsn_ret == dsn_ret_hdrs)
7834 topt |= topt_no_body;
7837 struct stat statbuf;
7839 /* no full body return at all? */
7840 if (!bounce_return_body)
7842 topt |= topt_no_body;
7843 /* add header if we overrule RET=FULL */
7844 if (dsn_ret == dsn_ret_full)
7845 dsnnotifyhdr = dsnlimitmsg;
7847 /* line length limited... return headers only if oversize */
7848 /* size limited ... return headers only if limit reached */
7849 else if ( max_received_linelength > bounce_return_linesize_limit
7850 || ( bounce_return_size_limit > 0
7851 && fstat(deliver_datafile, &statbuf) == 0
7852 && statbuf.st_size > max
7855 topt |= topt_no_body;
7856 dsnnotifyhdr = dsnlimitmsg;
7861 if (message_smtputf8)
7862 fputs(topt & topt_no_body ? "Content-type: message/global-headers\n\n"
7863 : "Content-type: message/global\n\n",
7867 fputs(topt & topt_no_body ? "Content-type: text/rfc822-headers\n\n"
7868 : "Content-type: message/rfc822\n\n",
7872 transport_filter_argv = NULL; /* Just in case */
7873 return_path = sender_address; /* In case not previously set */
7874 { /* Dummy transport for headers add */
7875 transport_ctx tctx = {{0}};
7876 transport_instance tb = {0};
7878 tctx.u.fd = fileno(fp);
7880 tctx.options = topt;
7881 tb.add_headers = dsnnotifyhdr;
7883 /*XXX no checking for failure! buggy! */
7884 transport_write_message(&tctx, 0);
7888 /* we never add the final text. close the file */
7892 fprintf(fp, "\n--%s--\n", bound);
7894 /* Close the file, which should send an EOF to the child process
7895 that is receiving the message. Wait for it to finish. */
7898 rc = child_close(pid, 0); /* Waits for child to close, no timeout */
7900 /* In the test harness, let the child do it's thing first. */
7902 if (f.running_in_test_harness) millisleep(500);
7904 /* If the process failed, there was some disaster in setting up the
7905 error message. Unless the message is very old, ensure that addr_defer
7906 is non-null, which will have the effect of leaving the message on the
7907 spool. The failed addresses will get tried again next time. However, we
7908 don't really want this to happen too often, so freeze the message unless
7909 there are some genuine deferred addresses to try. To do this we have
7910 to call spool_write_header() here, because with no genuine deferred
7911 addresses the normal code below doesn't get run. */
7916 if (now - received_time.tv_sec < retry_maximum_timeout && !addr_defer)
7918 addr_defer = (address_item *)(+1);
7919 f.deliver_freeze = TRUE;
7920 deliver_frozen_at = time(NULL);
7921 /* Panic-dies on error */
7922 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7925 deliver_msglog("Process failed (%d) when writing error message "
7926 "to %s%s", rc, bounce_recipient, s);
7927 log_write(0, LOG_MAIN, "Process failed (%d) when writing error message "
7928 "to %s%s", rc, bounce_recipient, s);
7931 /* The message succeeded. Ensure that the recipients that failed are
7932 now marked finished with on the spool and their parents updated. */
7936 for (addr = handled_addr; addr; addr = addr->next)
7938 address_done(addr, logtod);
7939 child_done(addr, logtod);
7941 /* Panic-dies on error */
7942 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
7948 f.disable_logging = FALSE; /* In case left set */
7950 /* Come here from the mua_wrapper case if routing goes wrong */
7954 /* If there are now no deferred addresses, we are done. Preserve the
7955 message log if so configured, and we are using them. Otherwise, sling it.
7956 Then delete the message itself. */
7964 fname = spool_fname(US"msglog", message_subdir, id, US"");
7965 if (preserve_message_logs)
7968 uschar * moname = spool_fname(US"msglog.OLD", US"", id, US"");
7970 if ((rc = Urename(fname, moname)) < 0)
7972 (void)directory_make(spool_directory,
7973 spool_sname(US"msglog.OLD", US""),
7974 MSGLOG_DIRECTORY_MODE, TRUE);
7975 rc = Urename(fname, moname);
7978 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to move %s to the "
7979 "msglog.OLD directory", fname);
7982 if (Uunlink(fname) < 0)
7983 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7984 fname, strerror(errno));
7987 /* Remove the two message files. */
7989 fname = spool_fname(US"input", message_subdir, id, US"-D");
7990 if (Uunlink(fname) < 0)
7991 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7992 fname, strerror(errno));
7993 fname = spool_fname(US"input", message_subdir, id, US"-H");
7994 if (Uunlink(fname) < 0)
7995 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s",
7996 fname, strerror(errno));
7998 /* Log the end of this message, with queue time if requested. */
8000 if (LOGGING(queue_time_overall))
8001 log_write(0, LOG_MAIN, "Completed QT=%s", string_timesince(&received_time));
8003 log_write(0, LOG_MAIN, "Completed");
8005 /* Unset deliver_freeze so that we won't try to move the spool files further down */
8006 f.deliver_freeze = FALSE;
8008 #ifndef DISABLE_EVENT
8009 (void) event_raise(event_action, US"msg:complete", NULL);
8013 /* If there are deferred addresses, we are keeping this message because it is
8014 not yet completed. Lose any temporary files that were catching output from
8015 pipes for any of the deferred addresses, handle one-time aliases, and see if
8016 the message has been on the queue for so long that it is time to send a warning
8017 message to the sender, unless it is a mailer-daemon. If all deferred addresses
8018 have the same domain, we can set deliver_domain for the expansion of
8019 delay_warning_ condition - if any of them are pipes, files, or autoreplies, use
8020 the parent's domain.
8022 If all the deferred addresses have an error number that indicates "retry time
8023 not reached", skip sending the warning message, because it won't contain the
8024 reason for the delay. It will get sent at the next real delivery attempt.
8025 Exception: for retries caused by a remote peer we use the error message
8026 store in the retry DB as the reason.
8027 However, if at least one address has tried, we'd better include all of them in
8030 If we can't make a process to send the message, don't worry.
8032 For mailing list expansions we want to send the warning message to the
8033 mailing list manager. We can't do a perfect job here, as some addresses may
8034 have different errors addresses, but if we take the errors address from
8035 each deferred address it will probably be right in most cases.
8037 If addr_defer == +1, it means there was a problem sending an error message
8038 for failed addresses, and there were no "real" deferred addresses. The value
8039 was set just to keep the message on the spool, so there is nothing to do here.
8042 else if (addr_defer != (address_item *)(+1))
8044 uschar *recipients = US"";
8045 BOOL want_warning_msg = FALSE;
8047 deliver_domain = testflag(addr_defer, af_pfr)
8048 ? addr_defer->parent->domain : addr_defer->domain;
8050 for (address_item * addr = addr_defer; addr; addr = addr->next)
8052 address_item *otaddr;
8054 if (addr->basic_errno > ERRNO_WARN_BASE) want_warning_msg = TRUE;
8058 const uschar *d = testflag(addr, af_pfr)
8059 ? addr->parent->domain : addr->domain;
8061 /* The domain may be unset for an address that has never been routed
8062 because the system filter froze the message. */
8064 if (!d || Ustrcmp(d, deliver_domain) != 0)
8065 deliver_domain = NULL;
8068 if (addr->return_filename) Uunlink(addr->return_filename);
8070 /* Handle the case of one-time aliases. If any address in the ancestry
8071 of this one is flagged, ensure it is in the recipients list, suitably
8072 flagged, and that its parent is marked delivered. */
8074 for (otaddr = addr; otaddr; otaddr = otaddr->parent)
8075 if (otaddr->onetime_parent) break;
8080 int t = recipients_count;
8082 for (i = 0; i < recipients_count; i++)
8084 uschar *r = recipients_list[i].address;
8085 if (Ustrcmp(otaddr->onetime_parent, r) == 0) t = i;
8086 if (Ustrcmp(otaddr->address, r) == 0) break;
8089 /* Didn't find the address already in the list, and did find the
8090 ultimate parent's address in the list, and they really are different
8091 (i.e. not from an identity-redirect). After adding the recipient,
8092 update the errors address in the recipients list. */
8094 if ( i >= recipients_count && t < recipients_count
8095 && Ustrcmp(otaddr->address, otaddr->parent->address) != 0)
8097 DEBUG(D_deliver) debug_printf("one_time: adding %s in place of %s\n",
8098 otaddr->address, otaddr->parent->address);
8099 receive_add_recipient(otaddr->address, t);
8100 recipients_list[recipients_count-1].errors_to = otaddr->prop.errors_address;
8101 tree_add_nonrecipient(otaddr->parent->address);
8102 update_spool = TRUE;
8106 /* Except for error messages, ensure that either the errors address for
8107 this deferred address or, if there is none, the sender address, is on the
8108 list of recipients for a warning message. */
8110 if (sender_address[0])
8112 uschar * s = addr->prop.errors_address;
8113 if (!s) s = sender_address;
8114 if (Ustrstr(recipients, s) == NULL)
8115 recipients = string_sprintf("%s%s%s", recipients,
8116 recipients[0] ? "," : "", s);
8120 /* Send a warning message if the conditions are right. If the condition check
8121 fails because of a lookup defer, there is nothing we can do. The warning
8122 is not sent. Another attempt will be made at the next delivery attempt (if
8125 if ( !f.queue_2stage
8127 && ( !(addr_defer->dsn_flags & rf_dsnflags)
8128 || addr_defer->dsn_flags & rf_notify_delay
8130 && delay_warning[1] > 0
8131 && sender_address[0] != 0
8132 && ( !delay_warning_condition
8133 || expand_check_condition(delay_warning_condition,
8134 US"delay_warning", US"option")
8140 int queue_time = time(NULL) - received_time.tv_sec;
8142 /* When running in the test harness, there's an option that allows us to
8143 fudge this time so as to get repeatability of the tests. Take the first
8144 time off the list. In queue runs, the list pointer gets updated in the
8147 if (f.running_in_test_harness && fudged_queue_times[0] != 0)
8149 int qt = readconf_readtime(fudged_queue_times, '/', FALSE);
8152 DEBUG(D_deliver) debug_printf("fudged queue_times = %s\n",
8153 fudged_queue_times);
8158 /* See how many warnings we should have sent by now */
8160 for (count = 0; count < delay_warning[1]; count++)
8161 if (queue_time < delay_warning[count+2]) break;
8163 show_time = delay_warning[count+1];
8165 if (count >= delay_warning[1])
8168 int last_gap = show_time;
8169 if (count > 1) last_gap -= delay_warning[count];
8170 extra = (queue_time - delay_warning[count+1])/last_gap;
8171 show_time += last_gap * extra;
8177 debug_printf("time on queue = %s id %s addr %s\n", readconf_printtime(queue_time), message_id, addr_defer->address);
8178 debug_printf("warning counts: required %d done %d\n", count,
8182 /* We have computed the number of warnings there should have been by now.
8183 If there haven't been enough, send one, and up the count to what it should
8186 if (warning_count < count)
8190 pid_t pid = child_open_exim(&fd);
8196 FILE *f = fdopen(fd, "wb");
8198 transport_ctx tctx = {{0}};
8200 if (warn_message_file)
8201 if (!(wmf = Ufopen(warn_message_file, "rb")))
8202 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to open %s for warning "
8203 "message texts: %s", warn_message_file, strerror(errno));
8205 warnmsg_recipients = recipients;
8206 warnmsg_delay = queue_time < 120*60
8207 ? string_sprintf("%d minutes", show_time/60)
8208 : string_sprintf("%d hours", show_time/3600);
8210 if (errors_reply_to)
8211 fprintf(f, "Reply-To: %s\n", errors_reply_to);
8212 fprintf(f, "Auto-Submitted: auto-replied\n");
8214 fprintf(f, "To: %s\n", recipients);
8216 /* generated boundary string and output MIME-Headers */
8217 bound = string_sprintf(TIME_T_FMT "-eximdsn-%d", time(NULL), rand());
8219 fprintf(f, "Content-Type: multipart/report;"
8220 " report-type=delivery-status; boundary=%s\n"
8221 "MIME-Version: 1.0\n",
8224 if ((wmf_text = next_emf(wmf, US"header")))
8225 fprintf(f, "%s\n", wmf_text);
8227 fprintf(f, "Subject: Warning: message %s delayed %s\n\n",
8228 message_id, warnmsg_delay);
8230 /* output human readable part as text/plain section */
8232 "Content-type: text/plain; charset=us-ascii\n\n",
8235 if ((wmf_text = next_emf(wmf, US"intro")))
8236 fprintf(f, "%s", CS wmf_text);
8240 "This message was created automatically by mail delivery software.\n");
8242 if (Ustrcmp(recipients, sender_address) == 0)
8244 "A message that you sent has not yet been delivered to one or more of its\n"
8245 "recipients after more than ");
8249 "A message sent by\n\n <%s>\n\n"
8250 "has not yet been delivered to one or more of its recipients after more than \n",
8253 fprintf(f, "%s on the queue on %s.\n\n"
8254 "The message identifier is: %s\n",
8255 warnmsg_delay, primary_hostname, message_id);
8257 for (h = header_list; h; h = h->next)
8258 if (strncmpic(h->text, US"Subject:", 8) == 0)
8259 fprintf(f, "The subject of the message is: %s", h->text + 9);
8260 else if (strncmpic(h->text, US"Date:", 5) == 0)
8261 fprintf(f, "The date of the message is: %s", h->text + 6);
8264 fprintf(f, "The address%s to which the message has not yet been "
8266 !addr_defer->next ? "" : "es",
8267 !addr_defer->next ? "is": "are");
8270 /* List the addresses, with error information if allowed */
8272 /* store addr_defer for machine readable part */
8273 address_item *addr_dsndefer = addr_defer;
8277 address_item *addr = addr_defer;
8278 addr_defer = addr->next;
8279 if (print_address_information(addr, f, US" ", US"\n ", US""))
8280 print_address_error(addr, f, US"Delay reason: ");
8289 if ((wmf_text = next_emf(wmf, US"final")))
8290 fprintf(f, "%s", CS wmf_text);
8296 "No action is required on your part. Delivery attempts will continue for\n"
8297 "some time, and this warning may be repeated at intervals if the message\n"
8298 "remains undelivered. Eventually the mail delivery software will give up,\n"
8299 "and when that happens, the message will be returned to you.\n");
8302 /* output machine readable part */
8303 fprintf(f, "\n--%s\n"
8304 "Content-type: message/delivery-status\n\n"
8305 "Reporting-MTA: dns; %s\n",
8307 smtp_active_hostname);
8312 /* must be decoded from xtext: see RFC 3461:6.3a */
8314 if (auth_xtextdecode(dsn_envid, &xdec_envid) > 0)
8315 fprintf(f,"Original-Envelope-ID: %s\n", dsn_envid);
8317 fprintf(f,"X-Original-Envelope-ID: error decoding xtext formatted ENVID\n");
8321 for ( ; addr_dsndefer; addr_dsndefer = addr_dsndefer->next)
8323 if (addr_dsndefer->dsn_orcpt)
8324 fprintf(f, "Original-Recipient: %s\n", addr_dsndefer->dsn_orcpt);
8326 fprintf(f, "Action: delayed\n"
8327 "Final-Recipient: rfc822;%s\n"
8329 addr_dsndefer->address);
8330 if (addr_dsndefer->host_used && addr_dsndefer->host_used->name)
8332 fprintf(f, "Remote-MTA: dns; %s\n",
8333 addr_dsndefer->host_used->name);
8334 print_dsn_diagnostic_code(addr_dsndefer, f);
8340 "Content-type: text/rfc822-headers\n\n",
8344 /* header only as required by RFC. only failure DSN needs to honor RET=FULL */
8345 tctx.u.fd = fileno(f);
8346 tctx.options = topt_add_return_path | topt_no_body;
8347 transport_filter_argv = NULL; /* Just in case */
8348 return_path = sender_address; /* In case not previously set */
8350 /* Write the original email out */
8351 /*XXX no checking for failure! buggy! */
8352 transport_write_message(&tctx, 0);
8355 fprintf(f,"\n--%s--\n", bound);
8359 /* Close and wait for child process to complete, without a timeout.
8360 If there's an error, don't update the count. */
8363 if (child_close(pid, 0) == 0)
8365 warning_count = count;
8366 update_spool = TRUE; /* Ensure spool rewritten */
8372 /* Clear deliver_domain */
8374 deliver_domain = NULL;
8376 /* If this was a first delivery attempt, unset the first time flag, and
8377 ensure that the spool gets updated. */
8379 if (f.deliver_firsttime)
8381 f.deliver_firsttime = FALSE;
8382 update_spool = TRUE;
8385 /* If delivery was frozen and freeze_tell is set, generate an appropriate
8386 message, unless the message is a local error message (to avoid loops). Then
8387 log the freezing. If the text in "frozen_info" came from a system filter,
8388 it has been escaped into printing characters so as not to mess up log lines.
8389 For the "tell" message, we turn \n back into newline. Also, insert a newline
8390 near the start instead of the ": " string. */
8392 if (f.deliver_freeze)
8394 if (freeze_tell && freeze_tell[0] != 0 && !f.local_error_message)
8396 uschar *s = string_copy(frozen_info);
8397 uschar *ss = Ustrstr(s, " by the system filter: ");
8408 if (*ss == '\\' && ss[1] == 'n')
8415 moan_tell_someone(freeze_tell, addr_defer, US"Message frozen",
8416 "Message %s has been frozen%s.\nThe sender is <%s>.\n", message_id,
8420 /* Log freezing just before we update the -H file, to minimize the chance
8421 of a race problem. */
8423 deliver_msglog("*** Frozen%s\n", frozen_info);
8424 log_write(0, LOG_MAIN, "Frozen%s", frozen_info);
8427 /* If there have been any updates to the non-recipients list, or other things
8428 that get written to the spool, we must now update the spool header file so
8429 that it has the right information for the next delivery attempt. If there
8430 was more than one address being delivered, the header_change update is done
8431 earlier, in case one succeeds and then something crashes. */
8434 debug_printf("delivery deferred: update_spool=%d header_rewritten=%d\n",
8435 update_spool, f.header_rewritten);
8437 if (update_spool || f.header_rewritten)
8438 /* Panic-dies on error */
8439 (void)spool_write_header(message_id, SW_DELIVERING, NULL);
8442 /* Finished with the message log. If the message is complete, it will have
8443 been unlinked or renamed above. */
8445 if (message_logs) (void)fclose(message_log);
8447 /* Now we can close and remove the journal file. Its only purpose is to record
8448 successfully completed deliveries asap so that this information doesn't get
8449 lost if Exim (or the machine) crashes. Forgetting about a failed delivery is
8450 not serious, as trying it again is not harmful. The journal might not be open
8451 if all addresses were deferred at routing or directing. Nevertheless, we must
8452 remove it if it exists (may have been lying around from a crash during the
8453 previous delivery attempt). We don't remove the journal if a delivery
8454 subprocess failed to pass back delivery information; this is controlled by
8455 the remove_journal flag. When the journal is left, we also don't move the
8456 message off the main spool if frozen and the option is set. It should get moved
8457 at the next attempt, after the journal has been inspected. */
8459 if (journal_fd >= 0) (void)close(journal_fd);
8463 uschar * fname = spool_fname(US"input", message_subdir, id, US"-J");
8465 if (Uunlink(fname) < 0 && errno != ENOENT)
8466 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to unlink %s: %s", fname,
8469 /* Move the message off the spool if requested */
8471 #ifdef SUPPORT_MOVE_FROZEN_MESSAGES
8472 if (f.deliver_freeze && move_frozen_messages)
8473 (void)spool_move_message(id, message_subdir, US"", US"F");
8477 /* Closing the data file frees the lock; if the file has been unlinked it
8478 will go away. Otherwise the message becomes available for another process
8481 (void)close(deliver_datafile);
8482 deliver_datafile = -1;
8483 DEBUG(D_deliver) debug_printf("end delivery of %s\n", id);
8485 /* It is unlikely that there will be any cached resources, since they are
8486 released after routing, and in the delivery subprocesses. However, it's
8487 possible for an expansion for something afterwards (for example,
8488 expand_check_condition) to do a lookup. We must therefore be sure everything is
8492 acl_where = ACL_WHERE_UNKNOWN;
8501 #ifdef EXIM_TFO_PROBE
8504 f.tcp_fastopen_ok = TRUE;
8508 if (!regex_PIPELINING) regex_PIPELINING =
8509 regex_must_compile(US"\\n250[\\s\\-]PIPELINING(\\s|\\n|$)", FALSE, TRUE);
8511 if (!regex_SIZE) regex_SIZE =
8512 regex_must_compile(US"\\n250[\\s\\-]SIZE(\\s|\\n|$)", FALSE, TRUE);
8514 if (!regex_AUTH) regex_AUTH =
8515 regex_must_compile(AUTHS_REGEX, FALSE, TRUE);
8518 if (!regex_STARTTLS) regex_STARTTLS =
8519 regex_must_compile(US"\\n250[\\s\\-]STARTTLS(\\s|\\n|$)", FALSE, TRUE);
8521 # ifdef EXPERIMENTAL_REQUIRETLS
8522 if (!regex_REQUIRETLS) regex_REQUIRETLS =
8523 regex_must_compile(US"\\n250[\\s\\-]REQUIRETLS(\\s|\\n|$)", FALSE, TRUE);
8527 if (!regex_CHUNKING) regex_CHUNKING =
8528 regex_must_compile(US"\\n250[\\s\\-]CHUNKING(\\s|\\n|$)", FALSE, TRUE);
8530 #ifndef DISABLE_PRDR
8531 if (!regex_PRDR) regex_PRDR =
8532 regex_must_compile(US"\\n250[\\s\\-]PRDR(\\s|\\n|$)", FALSE, TRUE);
8536 if (!regex_UTF8) regex_UTF8 =
8537 regex_must_compile(US"\\n250[\\s\\-]SMTPUTF8(\\s|\\n|$)", FALSE, TRUE);
8540 if (!regex_DSN) regex_DSN =
8541 regex_must_compile(US"\\n250[\\s\\-]DSN(\\s|\\n|$)", FALSE, TRUE);
8543 if (!regex_IGNOREQUOTA) regex_IGNOREQUOTA =
8544 regex_must_compile(US"\\n250[\\s\\-]IGNOREQUOTA(\\s|\\n|$)", FALSE, TRUE);
8546 #ifdef EXPERIMENTAL_PIPE_CONNECT
8547 if (!regex_EARLY_PIPE) regex_EARLY_PIPE =
8548 regex_must_compile(US"\\n250[\\s\\-]" EARLY_PIPE_FEATURE_NAME "(\\s|\\n|$)", FALSE, TRUE);
8554 deliver_get_sender_address (uschar * id)
8557 uschar * new_sender_address,
8558 * save_sender_address;
8559 BOOL save_qr = f.queue_running;
8562 /* make spool_open_datafile non-noisy on fail */
8564 f.queue_running = TRUE;
8566 /* Side effect: message_subdir is set for the (possibly split) spool directory */
8568 deliver_datafile = spool_open_datafile(id);
8569 f.queue_running = save_qr;
8570 if (deliver_datafile < 0)
8573 /* Save and restore the global sender_address. I'm not sure if we should
8574 not save/restore all the other global variables too, because
8575 spool_read_header() may change all of them. But OTOH, when this
8576 deliver_get_sender_address() gets called, the current message is done
8577 already and nobody needs the globals anymore. (HS12, 2015-08-21) */
8579 spoolname = string_sprintf("%s-H", id);
8580 save_sender_address = sender_address;
8582 rc = spool_read_header(spoolname, TRUE, TRUE);
8584 new_sender_address = sender_address;
8585 sender_address = save_sender_address;
8587 if (rc != spool_read_OK)
8590 assert(new_sender_address);
8592 (void)close(deliver_datafile);
8593 deliver_datafile = -1;
8595 return new_sender_address;
8601 delivery_re_exec(int exec_type)
8605 if (cutthrough.cctx.sock >= 0 && cutthrough.callout_hold_only)
8607 int channel_fd = cutthrough.cctx.sock;
8609 smtp_peer_options = cutthrough.peer_options;
8610 continue_sequence = 0;
8613 if (cutthrough.is_tls)
8617 smtp_peer_options |= OPTION_TLS;
8618 sending_ip_address = cutthrough.snd_ip;
8619 sending_port = cutthrough.snd_port;
8621 where = US"socketpair";
8622 if (socketpair(AF_UNIX, SOCK_STREAM, 0, pfd) != 0)
8626 if ((pid = fork()) < 0)
8629 else if (pid == 0) /* child: fork again to totally disconnect */
8631 if (f.running_in_test_harness) millisleep(100); /* let parent debug out */
8632 /* does not return */
8633 smtp_proxy_tls(cutthrough.cctx.tls_ctx, big_buffer, big_buffer_size,
8637 DEBUG(D_transport) debug_printf("proxy-proc inter-pid %d\n", pid);
8639 waitpid(pid, NULL, 0);
8640 (void) close(channel_fd); /* release the client socket */
8641 channel_fd = pfd[1];
8645 transport_do_pass_socket(cutthrough.transport, cutthrough.host.name,
8646 cutthrough.host.address, message_id, channel_fd);
8650 cancel_cutthrough_connection(TRUE, US"non-continued delivery");
8651 (void) child_exec_exim(exec_type, FALSE, NULL, FALSE, 2, US"-Mc", message_id);
8653 return; /* compiler quietening; control does not reach here. */
8658 LOG_MAIN | (exec_type == CEE_EXEC_EXIT ? LOG_PANIC : LOG_PANIC_DIE),
8659 "delivery re-exec %s failed: %s", where, strerror(errno));
8661 /* Get here if exec_type == CEE_EXEC_EXIT.
8662 Note: this must be _exit(), not exit(). */
8664 _exit(EX_EXECFAILED);
8670 /* End of deliver.c */