c8d7e837a68ae34c16c650d691741b62dc720c4b
[exim.git] / src / src / deliver.c
1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9 /* The main code for delivering a message. */
10
11
12 #include "exim.h"
13 #include "transports/smtp.h"
14 #include <sys/uio.h>
15 #include <assert.h>
16
17
18 /* Data block for keeping track of subprocesses for parallel remote
19 delivery. */
20
21 typedef struct pardata {
22 address_item *addrlist; /* chain of addresses */
23 address_item *addr; /* next address data expected for */
24 pid_t pid; /* subprocess pid */
25 int fd; /* pipe fd for getting result from subprocess */
26 int transport_count; /* returned transport count value */
27 BOOL done; /* no more data needed */
28 uschar *msg; /* error message */
29 uschar *return_path; /* return_path for these addresses */
30 } pardata;
31
32 /* Values for the process_recipients variable */
33
34 enum { RECIP_ACCEPT, RECIP_IGNORE, RECIP_DEFER,
35 RECIP_FAIL, RECIP_FAIL_FILTER, RECIP_FAIL_TIMEOUT,
36 RECIP_FAIL_LOOP};
37
38 /* Mutually recursive functions for marking addresses done. */
39
40 static void child_done(address_item *, uschar *);
41 static void address_done(address_item *, uschar *);
42
43 /* Table for turning base-62 numbers into binary */
44
45 static uschar tab62[] =
46 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
47 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
48 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
49 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
50 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
51 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
52 59,60,61}; /* x-z */
53
54
55 /*************************************************
56 * Local static variables *
57 *************************************************/
58
59 /* addr_duplicate is global because it needs to be seen from the Envelope-To
60 writing code. */
61
62 static address_item *addr_defer = NULL;
63 static address_item *addr_failed = NULL;
64 static address_item *addr_fallback = NULL;
65 static address_item *addr_local = NULL;
66 static address_item *addr_new = NULL;
67 static address_item *addr_remote = NULL;
68 static address_item *addr_route = NULL;
69 static address_item *addr_succeed = NULL;
70 static address_item *addr_senddsn = NULL;
71
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;
80
81
82
83 /*************************************************
84 * read as much as requested *
85 *************************************************/
86
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.
92
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)
95
96 This function read(2)s until we got all the data we *requested*.
97
98 Note: This function may block. Use it only if you're sure about the
99 amount of data you will get.
100
101 Argument:
102 fd the file descriptor to read from
103 buffer pointer to a buffer of size len
104 len the requested(!) amount of bytes
105
106 Returns: the amount of bytes read
107 */
108 static ssize_t
109 readn(int fd, void * buffer, size_t len)
110 {
111 uschar * next = buffer;
112 uschar * end = next + len;
113
114 while (next < end)
115 {
116 ssize_t got = read(fd, next, end - next);
117
118 /* I'm not sure if there are signals that can interrupt us,
119 for now I assume the worst */
120 if (got == -1 && errno == EINTR) continue;
121 if (got <= 0) return next - US buffer;
122 next += got;
123 }
124
125 return len;
126 }
127
128
129 /*************************************************
130 * Make a new address item *
131 *************************************************/
132
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.
137
138 Argument:
139 address the RFC822 address string
140 copy force a copy of the address
141
142 Returns: a pointer to an initialized address_item
143 */
144
145 address_item *
146 deliver_make_addr(uschar *address, BOOL copy)
147 {
148 address_item *addr = store_get(sizeof(address_item), FALSE);
149 *addr = address_defaults;
150 if (copy) address = string_copy(address);
151 addr->address = address;
152 addr->unique = string_copy(address);
153 return addr;
154 }
155
156
157
158
159 /*************************************************
160 * Set expansion values for an address *
161 *************************************************/
162
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
165 argument.
166
167 Arguments:
168 addr the address in question, or NULL to clear values
169 Returns: nothing
170 */
171
172 void
173 deliver_set_expansions(address_item *addr)
174 {
175 if (!addr)
176 {
177 const uschar ***p = address_expansions;
178 while (*p) **p++ = NULL;
179 return;
180 }
181
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. */
185
186 if (!addr->host_list)
187 {
188 deliver_host = deliver_host_address = US"";
189 deliver_host_port = 0;
190 }
191 else
192 {
193 deliver_host = addr->host_list->name;
194 deliver_host_address = addr->host_list->address;
195 deliver_host_port = addr->host_list->port;
196 }
197
198 deliver_recipients = addr;
199 deliver_address_data = addr->prop.address_data;
200 deliver_domain_data = addr->prop.domain_data;
201 deliver_localpart_data = addr->prop.localpart_data;
202 router_var = addr->prop.variables;
203
204 /* These may be unset for multiple addresses */
205
206 deliver_domain = addr->domain;
207 self_hostname = addr->self_hostname;
208
209 #ifdef EXPERIMENTAL_BRIGHTMAIL
210 bmi_deliver = 1; /* deliver by default */
211 bmi_alt_location = NULL;
212 bmi_base64_verdict = NULL;
213 bmi_base64_tracker_verdict = NULL;
214 #endif
215
216 /* If there's only one address we can set everything. */
217
218 if (!addr->next)
219 {
220 address_item *addr_orig;
221
222 deliver_localpart = addr->local_part;
223 deliver_localpart_verified = addr->local_part_verified;
224 deliver_localpart_prefix = addr->prefix;
225 deliver_localpart_prefix_v = addr->prefix_v;
226 deliver_localpart_suffix = addr->suffix;
227 deliver_localpart_suffix_v = addr->suffix_v;
228
229 for (addr_orig = addr; addr_orig->parent; addr_orig = addr_orig->parent) ;
230 deliver_domain_orig = addr_orig->domain;
231
232 /* Re-instate any prefix and suffix in the original local part. In all
233 normal cases, the address will have a router associated with it, and we can
234 choose the caseful or caseless version accordingly. However, when a system
235 filter sets up a pipe, file, or autoreply delivery, no router is involved.
236 In this case, though, there won't be any prefix or suffix to worry about. */
237
238 deliver_localpart_orig = !addr_orig->router
239 ? addr_orig->local_part
240 : addr_orig->router->caseful_local_part
241 ? addr_orig->cc_local_part
242 : addr_orig->lc_local_part;
243
244 /* If there's a parent, make its domain and local part available, and if
245 delivering to a pipe or file, or sending an autoreply, get the local
246 part from the parent. For pipes and files, put the pipe or file string
247 into address_pipe and address_file. */
248
249 if (addr->parent)
250 {
251 deliver_domain_parent = addr->parent->domain;
252 deliver_localpart_parent = !addr->parent->router
253 ? addr->parent->local_part
254 : addr->parent->router->caseful_local_part
255 ? addr->parent->cc_local_part
256 : addr->parent->lc_local_part;
257
258 /* File deliveries have their own flag because they need to be picked out
259 as special more often. */
260
261 if (testflag(addr, af_pfr))
262 {
263 if (testflag(addr, af_file)) address_file = addr->local_part;
264 else if (deliver_localpart[0] == '|') address_pipe = addr->local_part;
265 deliver_localpart = addr->parent->local_part;
266 deliver_localpart_prefix = addr->parent->prefix;
267 deliver_localpart_prefix_v = addr->parent->prefix_v;
268 deliver_localpart_suffix = addr->parent->suffix;
269 deliver_localpart_suffix_v = addr->parent->suffix_v;
270 }
271 }
272
273 #ifdef EXPERIMENTAL_BRIGHTMAIL
274 /* Set expansion variables related to Brightmail AntiSpam */
275 bmi_base64_verdict = bmi_get_base64_verdict(deliver_localpart_orig, deliver_domain_orig);
276 bmi_base64_tracker_verdict = bmi_get_base64_tracker_verdict(bmi_base64_verdict);
277 /* get message delivery status (0 - don't deliver | 1 - deliver) */
278 bmi_deliver = bmi_get_delivery_status(bmi_base64_verdict);
279 /* if message is to be delivered, get eventual alternate location */
280 if (bmi_deliver == 1)
281 bmi_alt_location = bmi_get_alt_location(bmi_base64_verdict);
282 #endif
283
284 }
285
286 /* For multiple addresses, don't set local part, and leave the domain and
287 self_hostname set only if it is the same for all of them. It is possible to
288 have multiple pipe and file addresses, but only when all addresses have routed
289 to the same pipe or file. */
290
291 else
292 {
293 if (testflag(addr, af_pfr))
294 {
295 if (testflag(addr, af_file)) address_file = addr->local_part;
296 else if (addr->local_part[0] == '|') address_pipe = addr->local_part;
297 }
298 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
299 {
300 if (deliver_domain && Ustrcmp(deliver_domain, addr2->domain) != 0)
301 deliver_domain = NULL;
302 if ( self_hostname
303 && ( !addr2->self_hostname
304 || Ustrcmp(self_hostname, addr2->self_hostname) != 0
305 ) )
306 self_hostname = NULL;
307 if (!deliver_domain && !self_hostname) break;
308 }
309 }
310 }
311
312
313
314
315 /*************************************************
316 * Open a msglog file *
317 *************************************************/
318
319 /* This function is used both for normal message logs, and for files in the
320 msglog directory that are used to catch output from pipes. Try to create the
321 directory if it does not exist. From release 4.21, normal message logs should
322 be created when the message is received.
323
324 Called from deliver_message(), can be operating as root.
325
326 Argument:
327 filename the file name
328 mode the mode required
329 error used for saying what failed
330
331 Returns: a file descriptor, or -1 (with errno set)
332 */
333
334 static int
335 open_msglog_file(uschar *filename, int mode, uschar **error)
336 {
337 if (Ustrstr(filename, US"/../"))
338 log_write(0, LOG_MAIN|LOG_PANIC,
339 "Attempt to open msglog file path with upward-traversal: '%s'\n", filename);
340
341 for (int i = 2; i > 0; i--)
342 {
343 int fd = Uopen(filename,
344 #ifdef O_CLOEXEC
345 O_CLOEXEC |
346 #endif
347 #ifdef O_NOFOLLOW
348 O_NOFOLLOW |
349 #endif
350 O_WRONLY|O_APPEND|O_CREAT, mode);
351 if (fd >= 0)
352 {
353 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
354 function is called as root). Double check the mode, because the group setting
355 doesn't always get set automatically. */
356
357 #ifndef O_CLOEXEC
358 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
359 #endif
360 if (exim_fchown(fd, exim_uid, exim_gid, filename) < 0)
361 {
362 *error = US"chown";
363 return -1;
364 }
365 if (fchmod(fd, mode) < 0)
366 {
367 *error = US"chmod";
368 return -1;
369 }
370 return fd;
371 }
372 if (errno != ENOENT)
373 break;
374
375 (void)directory_make(spool_directory,
376 spool_sname(US"msglog", message_subdir),
377 MSGLOG_DIRECTORY_MODE, TRUE);
378 }
379
380 *error = US"create or open";
381 return -1;
382 }
383
384
385
386
387 /*************************************************
388 * Write to msglog if required *
389 *************************************************/
390
391 /* Write to the message log, if configured. This function may also be called
392 from transports.
393
394 Arguments:
395 format a string format
396
397 Returns: nothing
398 */
399
400 void
401 deliver_msglog(const char *format, ...)
402 {
403 va_list ap;
404 if (!message_logs) return;
405 va_start(ap, format);
406 vfprintf(message_log, format, ap);
407 fflush(message_log);
408 va_end(ap);
409 }
410
411
412
413
414 /*************************************************
415 * Replicate status for batch *
416 *************************************************/
417
418 /* When a transport handles a batch of addresses, it may treat them
419 individually, or it may just put the status in the first one, and return FALSE,
420 requesting that the status be copied to all the others externally. This is the
421 replication function. As well as the status, it copies the transport pointer,
422 which may have changed if appendfile passed the addresses on to a different
423 transport.
424
425 Argument: pointer to the first address in a chain
426 Returns: nothing
427 */
428
429 static void
430 replicate_status(address_item *addr)
431 {
432 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
433 {
434 addr2->transport = addr->transport;
435 addr2->transport_return = addr->transport_return;
436 addr2->basic_errno = addr->basic_errno;
437 addr2->more_errno = addr->more_errno;
438 addr2->delivery_time = addr->delivery_time;
439 addr2->special_action = addr->special_action;
440 addr2->message = addr->message;
441 addr2->user_message = addr->user_message;
442 }
443 }
444
445
446
447 /*************************************************
448 * Compare lists of hosts *
449 *************************************************/
450
451 /* This function is given two pointers to chains of host items, and it yields
452 TRUE if the lists refer to the same hosts in the same order, except that
453
454 (1) Multiple hosts with the same non-negative MX values are permitted to appear
455 in different orders. Round-robinning nameservers can cause this to happen.
456
457 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
458 permitted to appear in different orders. This is caused by randomizing
459 hosts lists.
460
461 This enables Exim to use a single SMTP transaction for sending to two entirely
462 different domains that happen to end up pointing at the same hosts.
463
464 Arguments:
465 one points to the first host list
466 two points to the second host list
467
468 Returns: TRUE if the lists refer to the same host set
469 */
470
471 static BOOL
472 same_hosts(host_item *one, host_item *two)
473 {
474 while (one && two)
475 {
476 if (Ustrcmp(one->name, two->name) != 0)
477 {
478 int mx = one->mx;
479 host_item *end_one = one;
480 host_item *end_two = two;
481
482 /* Batch up only if there was no MX and the list was not randomized */
483
484 if (mx == MX_NONE) return FALSE;
485
486 /* Find the ends of the shortest sequence of identical MX values */
487
488 while ( end_one->next && end_one->next->mx == mx
489 && end_two->next && end_two->next->mx == mx)
490 {
491 end_one = end_one->next;
492 end_two = end_two->next;
493 }
494
495 /* If there aren't any duplicates, there's no match. */
496
497 if (end_one == one) return FALSE;
498
499 /* For each host in the 'one' sequence, check that it appears in the 'two'
500 sequence, returning FALSE if not. */
501
502 for (;;)
503 {
504 host_item *hi;
505 for (hi = two; hi != end_two->next; hi = hi->next)
506 if (Ustrcmp(one->name, hi->name) == 0) break;
507 if (hi == end_two->next) return FALSE;
508 if (one == end_one) break;
509 one = one->next;
510 }
511
512 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
513 Ensure both are pointing at the last host, and carry on as for equality. */
514
515 two = end_two;
516 }
517
518 /* if the names matched but ports do not, mismatch */
519 else if (one->port != two->port)
520 return FALSE;
521
522 /* Hosts matched */
523
524 one = one->next;
525 two = two->next;
526 }
527
528 /* True if both are NULL */
529
530 return (one == two);
531 }
532
533
534
535 /*************************************************
536 * Compare header lines *
537 *************************************************/
538
539 /* This function is given two pointers to chains of header items, and it yields
540 TRUE if they are the same header texts in the same order.
541
542 Arguments:
543 one points to the first header list
544 two points to the second header list
545
546 Returns: TRUE if the lists refer to the same header set
547 */
548
549 static BOOL
550 same_headers(header_line *one, header_line *two)
551 {
552 for (;; one = one->next, two = two->next)
553 {
554 if (one == two) return TRUE; /* Includes the case where both NULL */
555 if (!one || !two) return FALSE;
556 if (Ustrcmp(one->text, two->text) != 0) return FALSE;
557 }
558 }
559
560
561
562 /*************************************************
563 * Compare string settings *
564 *************************************************/
565
566 /* This function is given two pointers to strings, and it returns
567 TRUE if they are the same pointer, or if the two strings are the same.
568
569 Arguments:
570 one points to the first string
571 two points to the second string
572
573 Returns: TRUE or FALSE
574 */
575
576 static BOOL
577 same_strings(uschar *one, uschar *two)
578 {
579 if (one == two) return TRUE; /* Includes the case where both NULL */
580 if (!one || !two) return FALSE;
581 return (Ustrcmp(one, two) == 0);
582 }
583
584
585
586 /*************************************************
587 * Compare uid/gid for addresses *
588 *************************************************/
589
590 /* This function is given a transport and two addresses. It yields TRUE if the
591 uid/gid/initgroups settings for the two addresses are going to be the same when
592 they are delivered.
593
594 Arguments:
595 tp the transort
596 addr1 the first address
597 addr2 the second address
598
599 Returns: TRUE or FALSE
600 */
601
602 static BOOL
603 same_ugid(transport_instance *tp, address_item *addr1, address_item *addr2)
604 {
605 if ( !tp->uid_set && !tp->expand_uid
606 && !tp->deliver_as_creator
607 && ( testflag(addr1, af_uid_set) != testflag(addr2, af_gid_set)
608 || ( testflag(addr1, af_uid_set)
609 && ( addr1->uid != addr2->uid
610 || testflag(addr1, af_initgroups) != testflag(addr2, af_initgroups)
611 ) ) ) )
612 return FALSE;
613
614 if ( !tp->gid_set && !tp->expand_gid
615 && ( testflag(addr1, af_gid_set) != testflag(addr2, af_gid_set)
616 || ( testflag(addr1, af_gid_set)
617 && addr1->gid != addr2->gid
618 ) ) )
619 return FALSE;
620
621 return TRUE;
622 }
623
624
625
626
627 /*************************************************
628 * Record that an address is complete *
629 *************************************************/
630
631 /* This function records that an address is complete. This is straightforward
632 for most addresses, where the unique address is just the full address with the
633 domain lower cased. For homonyms (addresses that are the same as one of their
634 ancestors) their are complications. Their unique addresses have \x\ prepended
635 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
636 cousins.
637
638 Exim used to record the unique addresses of homonyms as "complete". This,
639 however, fails when the pattern of redirection varies over time (e.g. if taking
640 unseen copies at only some times of day) because the prepended numbers may vary
641 from one delivery run to the next. This problem is solved by never recording
642 prepended unique addresses as complete. Instead, when a homonymic address has
643 actually been delivered via a transport, we record its basic unique address
644 followed by the name of the transport. This is checked in subsequent delivery
645 runs whenever an address is routed to a transport.
646
647 If the completed address is a top-level one (has no parent, which means it
648 cannot be homonymic) we also add the original address to the non-recipients
649 tree, so that it gets recorded in the spool file and therefore appears as
650 "done" in any spool listings. The original address may differ from the unique
651 address in the case of the domain.
652
653 Finally, this function scans the list of duplicates, marks as done any that
654 match this address, and calls child_done() for their ancestors.
655
656 Arguments:
657 addr address item that has been completed
658 now current time as a string
659
660 Returns: nothing
661 */
662
663 static void
664 address_done(address_item *addr, uschar *now)
665 {
666 update_spool = TRUE; /* Ensure spool gets updated */
667
668 /* Top-level address */
669
670 if (!addr->parent)
671 {
672 tree_add_nonrecipient(addr->unique);
673 tree_add_nonrecipient(addr->address);
674 }
675
676 /* Homonymous child address */
677
678 else if (testflag(addr, af_homonym))
679 {
680 if (addr->transport)
681 tree_add_nonrecipient(
682 string_sprintf("%s/%s", addr->unique + 3, addr->transport->name));
683 }
684
685 /* Non-homonymous child address */
686
687 else tree_add_nonrecipient(addr->unique);
688
689 /* Check the list of duplicate addresses and ensure they are now marked
690 done as well. */
691
692 for (address_item * dup = addr_duplicate; dup; dup = dup->next)
693 if (Ustrcmp(addr->unique, dup->unique) == 0)
694 {
695 tree_add_nonrecipient(dup->unique);
696 child_done(dup, now);
697 }
698 }
699
700
701
702
703 /*************************************************
704 * Decrease counts in parents and mark done *
705 *************************************************/
706
707 /* This function is called when an address is complete. If there is a parent
708 address, its count of children is decremented. If there are still other
709 children outstanding, the function exits. Otherwise, if the count has become
710 zero, address_done() is called to mark the parent and its duplicates complete.
711 Then loop for any earlier ancestors.
712
713 Arguments:
714 addr points to the completed address item
715 now the current time as a string, for writing to the message log
716
717 Returns: nothing
718 */
719
720 static void
721 child_done(address_item *addr, uschar *now)
722 {
723 while (addr->parent)
724 {
725 address_item *aa;
726
727 addr = addr->parent;
728 if (--addr->child_count > 0) return; /* Incomplete parent */
729 address_done(addr, now);
730
731 /* Log the completion of all descendents only when there is no ancestor with
732 the same original address. */
733
734 for (aa = addr->parent; aa; aa = aa->parent)
735 if (Ustrcmp(aa->address, addr->address) == 0) break;
736 if (aa) continue;
737
738 deliver_msglog("%s %s: children all complete\n", now, addr->address);
739 DEBUG(D_deliver) debug_printf("%s: children all complete\n", addr->address);
740 }
741 }
742
743
744
745 /*************************************************
746 * Delivery logging support functions *
747 *************************************************/
748
749 /* The LOGGING() checks in d_log_interface() are complicated for backwards
750 compatibility. When outgoing interface logging was originally added, it was
751 conditional on just incoming_interface (which is off by default). The
752 outgoing_interface option is on by default to preserve this behaviour, but
753 you can enable incoming_interface and disable outgoing_interface to get I=
754 fields on incoming lines only.
755
756 Arguments:
757 g The log line
758 addr The address to be logged
759
760 Returns: New value for s
761 */
762
763 static gstring *
764 d_log_interface(gstring * g)
765 {
766 if (LOGGING(incoming_interface) && LOGGING(outgoing_interface)
767 && sending_ip_address)
768 {
769 g = string_fmt_append(g, " I=[%s]", sending_ip_address);
770 if (LOGGING(outgoing_port))
771 g = string_fmt_append(g, ":%d", sending_port);
772 }
773 return g;
774 }
775
776
777
778 static gstring *
779 d_hostlog(gstring * g, address_item * addr)
780 {
781 host_item * h = addr->host_used;
782
783 g = string_append(g, 2, US" H=", h->name);
784
785 if (LOGGING(dnssec) && h->dnssec == DS_YES)
786 g = string_catn(g, US" DS", 3);
787
788 g = string_append(g, 3, US" [", h->address, US"]");
789
790 if (LOGGING(outgoing_port))
791 g = string_fmt_append(g, ":%d", h->port);
792
793 #ifdef SUPPORT_SOCKS
794 if (LOGGING(proxy) && proxy_local_address)
795 {
796 g = string_append(g, 3, US" PRX=[", proxy_local_address, US"]");
797 if (LOGGING(outgoing_port))
798 g = string_fmt_append(g, ":%d", proxy_local_port);
799 }
800 #endif
801
802 g = d_log_interface(g);
803
804 if (testflag(addr, af_tcp_fastopen))
805 g = string_catn(g, US" TFO*", testflag(addr, af_tcp_fastopen_data) ? 5 : 4);
806
807 return g;
808 }
809
810
811
812
813
814 #ifndef DISABLE_TLS
815 static gstring *
816 d_tlslog(gstring * g, address_item * addr)
817 {
818 if (LOGGING(tls_cipher) && addr->cipher)
819 {
820 g = string_append(g, 2, US" X=", addr->cipher);
821 #ifdef EXPERIMENTAL_TLS_RESUME
822 if (LOGGING(tls_resumption) && testflag(addr, af_tls_resume))
823 g = string_catn(g, US"*", 1);
824 #endif
825 }
826 if (LOGGING(tls_certificate_verified) && addr->cipher)
827 g = string_append(g, 2, US" CV=",
828 testflag(addr, af_cert_verified)
829 ?
830 #ifdef SUPPORT_DANE
831 testflag(addr, af_dane_verified)
832 ? "dane"
833 :
834 #endif
835 "yes"
836 : "no");
837 if (LOGGING(tls_peerdn) && addr->peerdn)
838 g = string_append(g, 3, US" DN=\"", string_printing(addr->peerdn), US"\"");
839 return g;
840 }
841 #endif
842
843
844
845
846 #ifndef DISABLE_EVENT
847 uschar *
848 event_raise(uschar * action, const uschar * event, uschar * ev_data)
849 {
850 uschar * s;
851 if (action)
852 {
853 DEBUG(D_deliver)
854 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
855 event,
856 action, deliver_host_address);
857
858 event_name = event;
859 event_data = ev_data;
860
861 if (!(s = expand_string(action)) && *expand_string_message)
862 log_write(0, LOG_MAIN|LOG_PANIC,
863 "failed to expand event_action %s in %s: %s\n",
864 event, transport_name ? transport_name : US"main", expand_string_message);
865
866 event_name = event_data = NULL;
867
868 /* If the expansion returns anything but an empty string, flag for
869 the caller to modify his normal processing
870 */
871 if (s && *s)
872 {
873 DEBUG(D_deliver)
874 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
875 errno = ERRNO_EVENT;
876 return s;
877 }
878 }
879 return NULL;
880 }
881
882 void
883 msg_event_raise(const uschar * event, const address_item * addr)
884 {
885 const uschar * save_domain = deliver_domain;
886 uschar * save_local = deliver_localpart;
887 const uschar * save_host = deliver_host;
888 const uschar * save_address = deliver_host_address;
889 const int save_port = deliver_host_port;
890
891 router_name = addr->router ? addr->router->name : NULL;
892 deliver_domain = addr->domain;
893 deliver_localpart = addr->local_part;
894 deliver_host = addr->host_used ? addr->host_used->name : NULL;
895
896 if (!addr->transport)
897 {
898 if (Ustrcmp(event, "msg:fail:delivery") == 0)
899 {
900 /* An address failed with no transport involved. This happens when
901 a filter was used which triggered a fail command (in such a case
902 a transport isn't needed). Convert it to an internal fail event. */
903
904 (void) event_raise(event_action, US"msg:fail:internal", addr->message);
905 }
906 }
907 else
908 {
909 transport_name = addr->transport->name;
910
911 (void) event_raise(addr->transport->event_action, event,
912 addr->host_used
913 || Ustrcmp(addr->transport->driver_name, "smtp") == 0
914 || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
915 || Ustrcmp(addr->transport->driver_name, "autoreply") == 0
916 ? addr->message : NULL);
917 }
918
919 deliver_host_port = save_port;
920 deliver_host_address = save_address;
921 deliver_host = save_host;
922 deliver_localpart = save_local;
923 deliver_domain = save_domain;
924 router_name = transport_name = NULL;
925 }
926 #endif /*DISABLE_EVENT*/
927
928
929
930 /******************************************************************************/
931
932
933 /*************************************************
934 * Generate local prt for logging *
935 *************************************************/
936
937 /* This function is a subroutine for use in string_log_address() below.
938
939 Arguments:
940 addr the address being logged
941 yield the current dynamic buffer pointer
942
943 Returns: the new value of the buffer pointer
944 */
945
946 static gstring *
947 string_get_localpart(address_item * addr, gstring * yield)
948 {
949 uschar * s;
950
951 s = addr->prefix;
952 if (testflag(addr, af_include_affixes) && s)
953 {
954 #ifdef SUPPORT_I18N
955 if (testflag(addr, af_utf8_downcvt))
956 s = string_localpart_utf8_to_alabel(s, NULL);
957 #endif
958 yield = string_cat(yield, s);
959 }
960
961 s = addr->local_part;
962 #ifdef SUPPORT_I18N
963 if (testflag(addr, af_utf8_downcvt))
964 s = string_localpart_utf8_to_alabel(s, NULL);
965 #endif
966 yield = string_cat(yield, s);
967
968 s = addr->suffix;
969 if (testflag(addr, af_include_affixes) && s)
970 {
971 #ifdef SUPPORT_I18N
972 if (testflag(addr, af_utf8_downcvt))
973 s = string_localpart_utf8_to_alabel(s, NULL);
974 #endif
975 yield = string_cat(yield, s);
976 }
977
978 return yield;
979 }
980
981
982 /*************************************************
983 * Generate log address list *
984 *************************************************/
985
986 /* This function generates a list consisting of an address and its parents, for
987 use in logging lines. For saved onetime aliased addresses, the onetime parent
988 field is used. If the address was delivered by a transport with rcpt_include_
989 affixes set, the af_include_affixes bit will be set in the address. In that
990 case, we include the affixes here too.
991
992 Arguments:
993 g points to growing-string struct
994 addr bottom (ultimate) address
995 all_parents if TRUE, include all parents
996 success TRUE for successful delivery
997
998 Returns: a growable string in dynamic store
999 */
1000
1001 static gstring *
1002 string_log_address(gstring * g,
1003 address_item *addr, BOOL all_parents, BOOL success)
1004 {
1005 BOOL add_topaddr = TRUE;
1006 address_item *topaddr;
1007
1008 /* Find the ultimate parent */
1009
1010 for (topaddr = addr; topaddr->parent; topaddr = topaddr->parent) ;
1011
1012 /* We start with just the local part for pipe, file, and reply deliveries, and
1013 for successful local deliveries from routers that have the log_as_local flag
1014 set. File deliveries from filters can be specified as non-absolute paths in
1015 cases where the transport is going to complete the path. If there is an error
1016 before this happens (expansion failure) the local part will not be updated, and
1017 so won't necessarily look like a path. Add extra text for this case. */
1018
1019 if ( testflag(addr, af_pfr)
1020 || ( success
1021 && addr->router && addr->router->log_as_local
1022 && addr->transport && addr->transport->info->local
1023 ) )
1024 {
1025 if (testflag(addr, af_file) && addr->local_part[0] != '/')
1026 g = string_catn(g, CUS"save ", 5);
1027 g = string_get_localpart(addr, g);
1028 }
1029
1030 /* Other deliveries start with the full address. It we have split it into local
1031 part and domain, use those fields. Some early failures can happen before the
1032 splitting is done; in those cases use the original field. */
1033
1034 else
1035 {
1036 uschar * cmp;
1037 int off = g->ptr; /* start of the "full address" */
1038
1039 if (addr->local_part)
1040 {
1041 const uschar * s;
1042 g = string_get_localpart(addr, g);
1043 g = string_catn(g, US"@", 1);
1044 s = addr->domain;
1045 #ifdef SUPPORT_I18N
1046 if (testflag(addr, af_utf8_downcvt))
1047 s = string_localpart_utf8_to_alabel(s, NULL);
1048 #endif
1049 g = string_cat(g, s);
1050 }
1051 else
1052 g = string_cat(g, addr->address);
1053
1054 /* If the address we are going to print is the same as the top address,
1055 and all parents are not being included, don't add on the top address. First
1056 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1057 on the local parts. */
1058
1059 cmp = g->s + off; /* only now, as rebuffer likely done */
1060 string_from_gstring(g); /* ensure nul-terminated */
1061 if ( strcmpic(cmp, topaddr->address) == 0
1062 && Ustrncmp(cmp, topaddr->address, Ustrchr(cmp, '@') - cmp) == 0
1063 && !addr->onetime_parent
1064 && (!all_parents || !addr->parent || addr->parent == topaddr)
1065 )
1066 add_topaddr = FALSE;
1067 }
1068
1069 /* If all parents are requested, or this is a local pipe/file/reply, and
1070 there is at least one intermediate parent, show it in brackets, and continue
1071 with all of them if all are wanted. */
1072
1073 if ( (all_parents || testflag(addr, af_pfr))
1074 && addr->parent
1075 && addr->parent != topaddr)
1076 {
1077 uschar *s = US" (";
1078 for (address_item * addr2 = addr->parent; addr2 != topaddr; addr2 = addr2->parent)
1079 {
1080 g = string_catn(g, s, 2);
1081 g = string_cat (g, addr2->address);
1082 if (!all_parents) break;
1083 s = US", ";
1084 }
1085 g = string_catn(g, US")", 1);
1086 }
1087
1088 /* Add the top address if it is required */
1089
1090 if (add_topaddr)
1091 g = string_append(g, 3,
1092 US" <",
1093 addr->onetime_parent ? addr->onetime_parent : topaddr->address,
1094 US">");
1095
1096 return g;
1097 }
1098
1099
1100
1101 /******************************************************************************/
1102
1103
1104
1105 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1106 this is a nonstandard call; no two-character delivery flag is written
1107 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1108
1109 Arguments:
1110 flags passed to log_write()
1111 */
1112 void
1113 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1114 {
1115 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1116 rmark reset_point;
1117
1118 /* Log the delivery on the main log. We use an extensible string to build up
1119 the log line, and reset the store afterwards. Remote deliveries should always
1120 have a pointer to the host item that succeeded; local deliveries can have a
1121 pointer to a single host item in their host list, for use by the transport. */
1122
1123 #ifndef DISABLE_EVENT
1124 /* presume no successful remote delivery */
1125 lookup_dnssec_authenticated = NULL;
1126 #endif
1127
1128 reset_point = store_mark();
1129 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1130
1131 if (msg)
1132 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1133 else
1134 {
1135 g->s[0] = logchar; g->ptr = 1;
1136 g = string_catn(g, US"> ", 2);
1137 }
1138 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1139
1140 if (LOGGING(sender_on_delivery) || msg)
1141 g = string_append(g, 3, US" F=<",
1142 #ifdef SUPPORT_I18N
1143 testflag(addr, af_utf8_downcvt)
1144 ? string_address_utf8_to_alabel(sender_address, NULL)
1145 :
1146 #endif
1147 sender_address,
1148 US">");
1149
1150 if (*queue_name)
1151 g = string_append(g, 2, US" Q=", queue_name);
1152
1153 #ifdef EXPERIMENTAL_SRS
1154 if(addr->prop.srs_sender)
1155 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1156 #endif
1157
1158 /* You might think that the return path must always be set for a successful
1159 delivery; indeed, I did for some time, until this statement crashed. The case
1160 when it is not set is for a delivery to /dev/null which is optimised by not
1161 being run at all. */
1162
1163 if (used_return_path && LOGGING(return_path_on_delivery))
1164 g = string_append(g, 3, US" P=<", used_return_path, US">");
1165
1166 if (msg)
1167 g = string_append(g, 2, US" ", msg);
1168
1169 /* For a delivery from a system filter, there may not be a router */
1170 if (addr->router)
1171 g = string_append(g, 2, US" R=", addr->router->name);
1172
1173 g = string_append(g, 2, US" T=", addr->transport->name);
1174
1175 if (LOGGING(delivery_size))
1176 g = string_fmt_append(g, " S=%d", transport_count);
1177
1178 /* Local delivery */
1179
1180 if (addr->transport->info->local)
1181 {
1182 if (addr->host_list)
1183 g = string_append(g, 2, US" H=", addr->host_list->name);
1184 g = d_log_interface(g);
1185 if (addr->shadow_message)
1186 g = string_cat(g, addr->shadow_message);
1187 }
1188
1189 /* Remote delivery */
1190
1191 else
1192 {
1193 if (addr->host_used)
1194 {
1195 g = d_hostlog(g, addr);
1196 if (continue_sequence > 1)
1197 g = string_catn(g, US"*", 1);
1198
1199 #ifndef DISABLE_EVENT
1200 deliver_host_address = addr->host_used->address;
1201 deliver_host_port = addr->host_used->port;
1202 deliver_host = addr->host_used->name;
1203
1204 /* DNS lookup status */
1205 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1206 : addr->host_used->dnssec==DS_NO ? US"no"
1207 : NULL;
1208 #endif
1209 }
1210
1211 #ifndef DISABLE_TLS
1212 g = d_tlslog(g, addr);
1213 #endif
1214
1215 if (addr->authenticator)
1216 {
1217 g = string_append(g, 2, US" A=", addr->authenticator);
1218 if (addr->auth_id)
1219 {
1220 g = string_append(g, 2, US":", addr->auth_id);
1221 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1222 g = string_append(g, 2, US":", addr->auth_sndr);
1223 }
1224 }
1225
1226 if (LOGGING(pipelining))
1227 {
1228 if (testflag(addr, af_pipelining))
1229 g = string_catn(g, US" L", 2);
1230 #ifndef DISABLE_PIPE_CONNECT
1231 if (testflag(addr, af_early_pipe))
1232 g = string_catn(g, US"*", 1);
1233 #endif
1234 }
1235
1236 #ifndef DISABLE_PRDR
1237 if (testflag(addr, af_prdr_used))
1238 g = string_catn(g, US" PRDR", 5);
1239 #endif
1240
1241 if (testflag(addr, af_chunking_used))
1242 g = string_catn(g, US" K", 2);
1243 }
1244
1245 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1246
1247 if ( LOGGING(smtp_confirmation)
1248 && addr->message
1249 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1250 )
1251 {
1252 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1253 uschar *p = big_buffer;
1254 uschar *ss = addr->message;
1255 *p++ = '\"';
1256 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1257 {
1258 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1259 *p++ = ss[i];
1260 }
1261 *p++ = '\"';
1262 *p = 0;
1263 g = string_append(g, 2, US" C=", big_buffer);
1264 }
1265
1266 /* Time on queue and actual time taken to deliver */
1267
1268 if (LOGGING(queue_time))
1269 g = string_append(g, 2, US" QT=",
1270 string_timesince(&received_time));
1271
1272 if (LOGGING(deliver_time))
1273 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1274
1275 /* string_cat() always leaves room for the terminator. Release the
1276 store we used to build the line after writing it. */
1277
1278 log_write(0, flags, "%s", string_from_gstring(g));
1279
1280 #ifndef DISABLE_EVENT
1281 if (!msg) msg_event_raise(US"msg:delivery", addr);
1282 #endif
1283
1284 store_reset(reset_point);
1285 return;
1286 }
1287
1288
1289
1290 static void
1291 deferral_log(address_item * addr, uschar * now,
1292 int logflags, uschar * driver_name, uschar * driver_kind)
1293 {
1294 rmark reset_point = store_mark();
1295 gstring * g = string_get(256);
1296
1297 /* Build up the line that is used for both the message log and the main
1298 log. */
1299
1300 /* Create the address string for logging. Must not do this earlier, because
1301 an OK result may be changed to FAIL when a pipe returns text. */
1302
1303 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1304
1305 if (*queue_name)
1306 g = string_append(g, 2, US" Q=", queue_name);
1307
1308 /* Either driver_name contains something and driver_kind contains
1309 " router" or " transport" (note the leading space), or driver_name is
1310 a null string and driver_kind contains "routing" without the leading
1311 space, if all routing has been deferred. When a domain has been held,
1312 so nothing has been done at all, both variables contain null strings. */
1313
1314 if (driver_name)
1315 {
1316 if (driver_kind[1] == 't' && addr->router)
1317 g = string_append(g, 2, US" R=", addr->router->name);
1318 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1319 }
1320 else if (driver_kind)
1321 g = string_append(g, 2, US" ", driver_kind);
1322
1323 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1324
1325 if (addr->basic_errno > 0)
1326 g = string_append(g, 2, US": ",
1327 US strerror(addr->basic_errno));
1328
1329 if (addr->host_used)
1330 {
1331 g = string_append(g, 5,
1332 US" H=", addr->host_used->name,
1333 US" [", addr->host_used->address, US"]");
1334 if (LOGGING(outgoing_port))
1335 {
1336 int port = addr->host_used->port;
1337 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1338 }
1339 }
1340
1341 if (LOGGING(deliver_time))
1342 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1343
1344 if (addr->message)
1345 g = string_append(g, 2, US": ", addr->message);
1346
1347 (void) string_from_gstring(g);
1348
1349 /* Log the deferment in the message log, but don't clutter it
1350 up with retry-time defers after the first delivery attempt. */
1351
1352 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1353 deliver_msglog("%s %s\n", now, g->s);
1354
1355 /* Write the main log and reset the store.
1356 For errors of the type "retry time not reached" (also remotes skipped
1357 on queue run), logging is controlled by L_retry_defer. Note that this kind
1358 of error number is negative, and all the retry ones are less than any
1359 others. */
1360
1361
1362 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1363 "== %s", g->s);
1364
1365 store_reset(reset_point);
1366 return;
1367 }
1368
1369
1370
1371 static void
1372 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1373 {
1374 rmark reset_point = store_mark();
1375 gstring * g = string_get(256);
1376
1377 #ifndef DISABLE_EVENT
1378 /* Message failures for which we will send a DSN get their event raised
1379 later so avoid doing it here. */
1380
1381 if ( !addr->prop.ignore_error
1382 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1383 )
1384 msg_event_raise(US"msg:fail:delivery", addr);
1385 #endif
1386
1387 /* Build up the log line for the message and main logs */
1388
1389 /* Create the address string for logging. Must not do this earlier, because
1390 an OK result may be changed to FAIL when a pipe returns text. */
1391
1392 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1393
1394 if (LOGGING(sender_on_delivery))
1395 g = string_append(g, 3, US" F=<", sender_address, US">");
1396
1397 if (*queue_name)
1398 g = string_append(g, 2, US" Q=", queue_name);
1399
1400 /* Return path may not be set if no delivery actually happened */
1401
1402 if (used_return_path && LOGGING(return_path_on_delivery))
1403 g = string_append(g, 3, US" P=<", used_return_path, US">");
1404
1405 if (addr->router)
1406 g = string_append(g, 2, US" R=", addr->router->name);
1407 if (addr->transport)
1408 g = string_append(g, 2, US" T=", addr->transport->name);
1409
1410 if (addr->host_used)
1411 g = d_hostlog(g, addr);
1412
1413 #ifndef DISABLE_TLS
1414 g = d_tlslog(g, addr);
1415 #endif
1416
1417 if (addr->basic_errno > 0)
1418 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1419
1420 if (addr->message)
1421 g = string_append(g, 2, US": ", addr->message);
1422
1423 if (LOGGING(deliver_time))
1424 g = string_append(g, 2, US" DT=", string_timediff(&addr->delivery_time));
1425
1426 (void) string_from_gstring(g);
1427
1428 /* Do the logging. For the message log, "routing failed" for those cases,
1429 just to make it clearer. */
1430
1431 if (driver_kind)
1432 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1433 else
1434 deliver_msglog("%s %s\n", now, g->s);
1435
1436 log_write(0, LOG_MAIN, "** %s", g->s);
1437
1438 store_reset(reset_point);
1439 return;
1440 }
1441
1442
1443
1444 /*************************************************
1445 * Actions at the end of handling an address *
1446 *************************************************/
1447
1448 /* This is a function for processing a single address when all that can be done
1449 with it has been done.
1450
1451 Arguments:
1452 addr points to the address block
1453 result the result of the delivery attempt
1454 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1455 driver_type indicates which type of driver (transport, or router) was last
1456 to process the address
1457 logchar '=' or '-' for use when logging deliveries with => or ->
1458
1459 Returns: nothing
1460 */
1461
1462 static void
1463 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1464 int logchar)
1465 {
1466 uschar *now = tod_stamp(tod_log);
1467 uschar *driver_kind = NULL;
1468 uschar *driver_name = NULL;
1469
1470 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1471
1472 /* Set up driver kind and name for logging. Disable logging if the router or
1473 transport has disabled it. */
1474
1475 if (driver_type == EXIM_DTYPE_TRANSPORT)
1476 {
1477 if (addr->transport)
1478 {
1479 driver_name = addr->transport->name;
1480 driver_kind = US" transport";
1481 f.disable_logging = addr->transport->disable_logging;
1482 }
1483 else driver_kind = US"transporting";
1484 }
1485 else if (driver_type == EXIM_DTYPE_ROUTER)
1486 {
1487 if (addr->router)
1488 {
1489 driver_name = addr->router->name;
1490 driver_kind = US" router";
1491 f.disable_logging = addr->router->disable_logging;
1492 }
1493 else driver_kind = US"routing";
1494 }
1495
1496 /* If there's an error message set, ensure that it contains only printing
1497 characters - it should, but occasionally things slip in and this at least
1498 stops the log format from getting wrecked. We also scan the message for an LDAP
1499 expansion item that has a password setting, and flatten the password. This is a
1500 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1501 malformed, it won't ever have gone near LDAP.) */
1502
1503 if (addr->message)
1504 {
1505 const uschar * s = string_printing(addr->message);
1506
1507 /* deconst cast ok as string_printing known to have alloc'n'copied */
1508 addr->message = expand_hide_passwords(US s);
1509 }
1510
1511 /* If we used a transport that has one of the "return_output" options set, and
1512 if it did in fact generate some output, then for return_output we treat the
1513 message as failed if it was not already set that way, so that the output gets
1514 returned to the sender, provided there is a sender to send it to. For
1515 return_fail_output, do this only if the delivery failed. Otherwise we just
1516 unlink the file, and remove the name so that if the delivery failed, we don't
1517 try to send back an empty or unwanted file. The log_output options operate only
1518 on a non-empty file.
1519
1520 In any case, we close the message file, because we cannot afford to leave a
1521 file-descriptor for one address while processing (maybe very many) others. */
1522
1523 if (addr->return_file >= 0 && addr->return_filename)
1524 {
1525 BOOL return_output = FALSE;
1526 struct stat statbuf;
1527 (void)EXIMfsync(addr->return_file);
1528
1529 /* If there is no output, do nothing. */
1530
1531 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1532 {
1533 transport_instance *tb = addr->transport;
1534
1535 /* Handle logging options */
1536
1537 if ( tb->log_output
1538 || result == FAIL && tb->log_fail_output
1539 || result == DEFER && tb->log_defer_output
1540 )
1541 {
1542 uschar *s;
1543 FILE *f = Ufopen(addr->return_filename, "rb");
1544 if (!f)
1545 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1546 "from %s transport: %s", addr->return_filename, tb->name,
1547 strerror(errno));
1548 else
1549 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1550 {
1551 uschar *p = big_buffer + Ustrlen(big_buffer);
1552 const uschar * sp;
1553 while (p > big_buffer && isspace(p[-1])) p--;
1554 *p = 0;
1555 sp = string_printing(big_buffer);
1556 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1557 addr->address, tb->name, sp);
1558 }
1559 (void)fclose(f);
1560 }
1561
1562 /* Handle returning options, but only if there is an address to return
1563 the text to. */
1564
1565 if (sender_address[0] != 0 || addr->prop.errors_address)
1566 if (tb->return_output)
1567 {
1568 addr->transport_return = result = FAIL;
1569 if (addr->basic_errno == 0 && !addr->message)
1570 addr->message = US"return message generated";
1571 return_output = TRUE;
1572 }
1573 else
1574 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1575 }
1576
1577 /* Get rid of the file unless it might be returned, but close it in
1578 all cases. */
1579
1580 if (!return_output)
1581 {
1582 Uunlink(addr->return_filename);
1583 addr->return_filename = NULL;
1584 addr->return_file = -1;
1585 }
1586
1587 (void)close(addr->return_file);
1588 }
1589
1590 /* The success case happens only after delivery by a transport. */
1591
1592 if (result == OK)
1593 {
1594 addr->next = addr_succeed;
1595 addr_succeed = addr;
1596
1597 /* Call address_done() to ensure that we don't deliver to this address again,
1598 and write appropriate things to the message log. If it is a child address, we
1599 call child_done() to scan the ancestors and mark them complete if this is the
1600 last child to complete. */
1601
1602 address_done(addr, now);
1603 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1604
1605 if (!addr->parent)
1606 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1607 driver_name, driver_kind);
1608 else
1609 {
1610 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1611 addr->parent->address, driver_name, driver_kind);
1612 child_done(addr, now);
1613 }
1614
1615 /* Certificates for logging (via events) */
1616 #ifndef DISABLE_TLS
1617 tls_out.ourcert = addr->ourcert;
1618 addr->ourcert = NULL;
1619 tls_out.peercert = addr->peercert;
1620 addr->peercert = NULL;
1621
1622 tls_out.ver = addr->tlsver;
1623 tls_out.cipher = addr->cipher;
1624 tls_out.peerdn = addr->peerdn;
1625 tls_out.ocsp = addr->ocsp;
1626 # ifdef SUPPORT_DANE
1627 tls_out.dane_verified = testflag(addr, af_dane_verified);
1628 # endif
1629 #endif
1630
1631 delivery_log(LOG_MAIN, addr, logchar, NULL);
1632
1633 #ifndef DISABLE_TLS
1634 tls_free_cert(&tls_out.ourcert);
1635 tls_free_cert(&tls_out.peercert);
1636 tls_out.ver = NULL;
1637 tls_out.cipher = NULL;
1638 tls_out.peerdn = NULL;
1639 tls_out.ocsp = OCSP_NOT_REQ;
1640 # ifdef SUPPORT_DANE
1641 tls_out.dane_verified = FALSE;
1642 # endif
1643 #endif
1644 }
1645
1646
1647 /* Soft failure, or local delivery process failed; freezing may be
1648 requested. */
1649
1650 else if (result == DEFER || result == PANIC)
1651 {
1652 if (result == PANIC) logflags |= LOG_PANIC;
1653
1654 /* This puts them on the chain in reverse order. Do not change this, because
1655 the code for handling retries assumes that the one with the retry
1656 information is last. */
1657
1658 addr->next = addr_defer;
1659 addr_defer = addr;
1660
1661 /* The only currently implemented special action is to freeze the
1662 message. Logging of this is done later, just before the -H file is
1663 updated. */
1664
1665 if (addr->special_action == SPECIAL_FREEZE)
1666 {
1667 f.deliver_freeze = TRUE;
1668 deliver_frozen_at = time(NULL);
1669 update_spool = TRUE;
1670 }
1671
1672 /* If doing a 2-stage queue run, we skip writing to either the message
1673 log or the main log for SMTP defers. */
1674
1675 if (!f.queue_2stage || addr->basic_errno != 0)
1676 deferral_log(addr, now, logflags, driver_name, driver_kind);
1677 }
1678
1679
1680 /* Hard failure. If there is an address to which an error message can be sent,
1681 put this address on the failed list. If not, put it on the deferred list and
1682 freeze the mail message for human attention. The latter action can also be
1683 explicitly requested by a router or transport. */
1684
1685 else
1686 {
1687 /* If this is a delivery error, or a message for which no replies are
1688 wanted, and the message's age is greater than ignore_bounce_errors_after,
1689 force the af_ignore_error flag. This will cause the address to be discarded
1690 later (with a log entry). */
1691
1692 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1693 addr->prop.ignore_error = TRUE;
1694
1695 /* Freeze the message if requested, or if this is a bounce message (or other
1696 message with null sender) and this address does not have its own errors
1697 address. However, don't freeze if errors are being ignored. The actual code
1698 to ignore occurs later, instead of sending a message. Logging of freezing
1699 occurs later, just before writing the -H file. */
1700
1701 if ( !addr->prop.ignore_error
1702 && ( addr->special_action == SPECIAL_FREEZE
1703 || (sender_address[0] == 0 && !addr->prop.errors_address)
1704 ) )
1705 {
1706 frozen_info = addr->special_action == SPECIAL_FREEZE
1707 ? US""
1708 : f.sender_local && !f.local_error_message
1709 ? US" (message created with -f <>)"
1710 : US" (delivery error message)";
1711 f.deliver_freeze = TRUE;
1712 deliver_frozen_at = time(NULL);
1713 update_spool = TRUE;
1714
1715 /* The address is put on the defer rather than the failed queue, because
1716 the message is being retained. */
1717
1718 addr->next = addr_defer;
1719 addr_defer = addr;
1720 }
1721
1722 /* Don't put the address on the nonrecipients tree yet; wait until an
1723 error message has been successfully sent. */
1724
1725 else
1726 {
1727 addr->next = addr_failed;
1728 addr_failed = addr;
1729 }
1730
1731 failure_log(addr, driver_name ? NULL : driver_kind, now);
1732 }
1733
1734 /* Ensure logging is turned on again in all cases */
1735
1736 f.disable_logging = FALSE;
1737 }
1738
1739
1740
1741
1742 /*************************************************
1743 * Address-independent error *
1744 *************************************************/
1745
1746 /* This function is called when there's an error that is not dependent on a
1747 particular address, such as an expansion string failure. It puts the error into
1748 all the addresses in a batch, logs the incident on the main and panic logs, and
1749 clears the expansions. It is mostly called from local_deliver(), but can be
1750 called for a remote delivery via findugid().
1751
1752 Arguments:
1753 logit TRUE if (MAIN+PANIC) logging required
1754 addr the first of the chain of addresses
1755 code the error code
1756 format format string for error message, or NULL if already set in addr
1757 ... arguments for the format
1758
1759 Returns: nothing
1760 */
1761
1762 static void
1763 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1764 {
1765 addr->basic_errno = code;
1766
1767 if (format)
1768 {
1769 va_list ap;
1770 gstring * g;
1771
1772 va_start(ap, format);
1773 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1774 va_end(ap);
1775 addr->message = string_from_gstring(g);
1776 }
1777
1778 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1779 {
1780 addr2->basic_errno = code;
1781 addr2->message = addr->message;
1782 }
1783
1784 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1785 deliver_set_expansions(NULL);
1786 }
1787
1788
1789
1790
1791 /*************************************************
1792 * Check a "never users" list *
1793 *************************************************/
1794
1795 /* This function is called to check whether a uid is on one of the two "never
1796 users" lists.
1797
1798 Arguments:
1799 uid the uid to be checked
1800 nusers the list to be scanned; the first item in the list is the count
1801
1802 Returns: TRUE if the uid is on the list
1803 */
1804
1805 static BOOL
1806 check_never_users(uid_t uid, uid_t *nusers)
1807 {
1808 if (!nusers) return FALSE;
1809 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1810 return FALSE;
1811 }
1812
1813
1814
1815 /*************************************************
1816 * Find uid and gid for a transport *
1817 *************************************************/
1818
1819 /* This function is called for both local and remote deliveries, to find the
1820 uid/gid under which to run the delivery. The values are taken preferentially
1821 from the transport (either explicit or deliver_as_creator), then from the
1822 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1823 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1824 panic error is logged, and the function fails (which normally leads to delivery
1825 deferral).
1826
1827 Arguments:
1828 addr the address (possibly a chain)
1829 tp the transport
1830 uidp pointer to uid field
1831 gidp pointer to gid field
1832 igfp pointer to the use_initgroups field
1833
1834 Returns: FALSE if failed - error has been set in address(es)
1835 */
1836
1837 static BOOL
1838 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1839 BOOL *igfp)
1840 {
1841 uschar *nuname;
1842 BOOL gid_set = FALSE;
1843
1844 /* Default initgroups flag comes from the transport */
1845
1846 *igfp = tp->initgroups;
1847
1848 /* First see if there's a gid on the transport, either fixed or expandable.
1849 The expanding function always logs failure itself. */
1850
1851 if (tp->gid_set)
1852 {
1853 *gidp = tp->gid;
1854 gid_set = TRUE;
1855 }
1856 else if (tp->expand_gid)
1857 {
1858 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1859 &(addr->message)))
1860 {
1861 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1862 return FALSE;
1863 }
1864 gid_set = TRUE;
1865 }
1866
1867 /* If the transport did not set a group, see if the router did. */
1868
1869 if (!gid_set && testflag(addr, af_gid_set))
1870 {
1871 *gidp = addr->gid;
1872 gid_set = TRUE;
1873 }
1874
1875 /* Pick up a uid from the transport if one is set. */
1876
1877 if (tp->uid_set) *uidp = tp->uid;
1878
1879 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1880 it does not provide a passwd value from which a gid can be taken. */
1881
1882 else if (tp->expand_uid)
1883 {
1884 struct passwd *pw;
1885 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1886 uidp, &(addr->message)))
1887 {
1888 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1889 return FALSE;
1890 }
1891 if (!gid_set && pw)
1892 {
1893 *gidp = pw->pw_gid;
1894 gid_set = TRUE;
1895 }
1896 }
1897
1898 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1899
1900 else if (tp->deliver_as_creator)
1901 {
1902 *uidp = originator_uid;
1903 if (!gid_set)
1904 {
1905 *gidp = originator_gid;
1906 gid_set = TRUE;
1907 }
1908 }
1909
1910 /* Otherwise see if the address specifies the uid and if so, take it and its
1911 initgroups flag. */
1912
1913 else if (testflag(addr, af_uid_set))
1914 {
1915 *uidp = addr->uid;
1916 *igfp = testflag(addr, af_initgroups);
1917 }
1918
1919 /* Nothing has specified the uid - default to the Exim user, and group if the
1920 gid is not set. */
1921
1922 else
1923 {
1924 *uidp = exim_uid;
1925 if (!gid_set)
1926 {
1927 *gidp = exim_gid;
1928 gid_set = TRUE;
1929 }
1930 }
1931
1932 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1933 defaulting to the Exim uid. In other words, if the configuration has specified
1934 a uid, it must also provide a gid. */
1935
1936 if (!gid_set)
1937 {
1938 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1939 "%s transport", tp->name);
1940 return FALSE;
1941 }
1942
1943 /* Check that the uid is not on the lists of banned uids that may not be used
1944 for delivery processes. */
1945
1946 nuname = check_never_users(*uidp, never_users)
1947 ? US"never_users"
1948 : check_never_users(*uidp, fixed_never_users)
1949 ? US"fixed_never_users"
1950 : NULL;
1951 if (nuname)
1952 {
1953 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1954 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1955 return FALSE;
1956 }
1957
1958 /* All is well */
1959
1960 return TRUE;
1961 }
1962
1963
1964
1965
1966 /*************************************************
1967 * Check the size of a message for a transport *
1968 *************************************************/
1969
1970 /* Checks that the message isn't too big for the selected transport.
1971 This is called only when it is known that the limit is set.
1972
1973 Arguments:
1974 tp the transport
1975 addr the (first) address being delivered
1976
1977 Returns: OK
1978 DEFER expansion failed or did not yield an integer
1979 FAIL message too big
1980 */
1981
1982 int
1983 check_message_size(transport_instance *tp, address_item *addr)
1984 {
1985 int rc = OK;
1986 int size_limit;
1987
1988 deliver_set_expansions(addr);
1989 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1990 deliver_set_expansions(NULL);
1991
1992 if (expand_string_message)
1993 {
1994 rc = DEFER;
1995 addr->message = size_limit == -1
1996 ? string_sprintf("failed to expand message_size_limit "
1997 "in %s transport: %s", tp->name, expand_string_message)
1998 : string_sprintf("invalid message_size_limit "
1999 "in %s transport: %s", tp->name, expand_string_message);
2000 }
2001 else if (size_limit > 0 && message_size > size_limit)
2002 {
2003 rc = FAIL;
2004 addr->message =
2005 string_sprintf("message is too big (transport limit = %d)",
2006 size_limit);
2007 }
2008
2009 return rc;
2010 }
2011
2012
2013
2014 /*************************************************
2015 * Transport-time check for a previous delivery *
2016 *************************************************/
2017
2018 /* Check that this base address hasn't previously been delivered to its routed
2019 transport. If it has been delivered, mark it done. The check is necessary at
2020 delivery time in order to handle homonymic addresses correctly in cases where
2021 the pattern of redirection changes between delivery attempts (so the unique
2022 fields change). Non-homonymic previous delivery is detected earlier, at routing
2023 time (which saves unnecessary routing).
2024
2025 Arguments:
2026 addr the address item
2027 testing TRUE if testing wanted only, without side effects
2028
2029 Returns: TRUE if previously delivered by the transport
2030 */
2031
2032 static BOOL
2033 previously_transported(address_item *addr, BOOL testing)
2034 {
2035 uschar * s = string_sprintf("%s/%s",
2036 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2037
2038 if (tree_search(tree_nonrecipients, s) != 0)
2039 {
2040 DEBUG(D_deliver|D_route|D_transport)
2041 debug_printf("%s was previously delivered (%s transport): discarded\n",
2042 addr->address, addr->transport->name);
2043 if (!testing) child_done(addr, tod_stamp(tod_log));
2044 return TRUE;
2045 }
2046
2047 return FALSE;
2048 }
2049
2050
2051
2052 /******************************************************
2053 * Check for a given header in a header string *
2054 ******************************************************/
2055
2056 /* This function is used when generating quota warnings. The configuration may
2057 specify any header lines it likes in quota_warn_message. If certain of them are
2058 missing, defaults are inserted, so we need to be able to test for the presence
2059 of a given header.
2060
2061 Arguments:
2062 hdr the required header name
2063 hstring the header string
2064
2065 Returns: TRUE the header is in the string
2066 FALSE the header is not in the string
2067 */
2068
2069 static BOOL
2070 contains_header(uschar *hdr, uschar *hstring)
2071 {
2072 int len = Ustrlen(hdr);
2073 uschar *p = hstring;
2074 while (*p != 0)
2075 {
2076 if (strncmpic(p, hdr, len) == 0)
2077 {
2078 p += len;
2079 while (*p == ' ' || *p == '\t') p++;
2080 if (*p == ':') return TRUE;
2081 }
2082 while (*p != 0 && *p != '\n') p++;
2083 if (*p == '\n') p++;
2084 }
2085 return FALSE;
2086 }
2087
2088
2089
2090
2091 /*************************************************
2092 * Perform a local delivery *
2093 *************************************************/
2094
2095 /* Each local delivery is performed in a separate process which sets its
2096 uid and gid as specified. This is a safer way than simply changing and
2097 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2098 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2099 all systems have seteuid().
2100
2101 If the uid/gid are specified in the transport_instance, they are used; the
2102 transport initialization must ensure that either both or neither are set.
2103 Otherwise, the values associated with the address are used. If neither are set,
2104 it is a configuration error.
2105
2106 The transport or the address may specify a home directory (transport over-
2107 rides), and if they do, this is set as $home. If neither have set a working
2108 directory, this value is used for that as well. Otherwise $home is left unset
2109 and the cwd is set to "/" - a directory that should be accessible to all users.
2110
2111 Using a separate process makes it more complicated to get error information
2112 back. We use a pipe to pass the return code and also an error code and error
2113 text string back to the parent process.
2114
2115 Arguments:
2116 addr points to an address block for this delivery; for "normal" local
2117 deliveries this is the only address to be delivered, but for
2118 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2119 a number of addresses can be handled simultaneously, and in this
2120 case addr will point to a chain of addresses with the same
2121 characteristics.
2122
2123 shadowing TRUE if running a shadow transport; this causes output from pipes
2124 to be ignored.
2125
2126 Returns: nothing
2127 */
2128
2129 static void
2130 deliver_local(address_item *addr, BOOL shadowing)
2131 {
2132 BOOL use_initgroups;
2133 uid_t uid;
2134 gid_t gid;
2135 int status, len, rc;
2136 int pfd[2];
2137 pid_t pid;
2138 uschar *working_directory;
2139 address_item *addr2;
2140 transport_instance *tp = addr->transport;
2141
2142 /* Set up the return path from the errors or sender address. If the transport
2143 has its own return path setting, expand it and replace the existing value. */
2144
2145 if(addr->prop.errors_address)
2146 return_path = addr->prop.errors_address;
2147 #ifdef EXPERIMENTAL_SRS
2148 else if (addr->prop.srs_sender)
2149 return_path = addr->prop.srs_sender;
2150 #endif
2151 else
2152 return_path = sender_address;
2153
2154 if (tp->return_path)
2155 {
2156 uschar *new_return_path = expand_string(tp->return_path);
2157 if (!new_return_path)
2158 {
2159 if (!f.expand_string_forcedfail)
2160 {
2161 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2162 US"Failed to expand return path \"%s\" in %s transport: %s",
2163 tp->return_path, tp->name, expand_string_message);
2164 return;
2165 }
2166 }
2167 else return_path = new_return_path;
2168 }
2169
2170 /* For local deliveries, one at a time, the value used for logging can just be
2171 set directly, once and for all. */
2172
2173 used_return_path = return_path;
2174
2175 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2176 gets put into the address(es), and the expansions are unset, so we can just
2177 return. */
2178
2179 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2180
2181 /* See if either the transport or the address specifies a home directory. A
2182 home directory set in the address may already be expanded; a flag is set to
2183 indicate that. In other cases we must expand it. */
2184
2185 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2186 || ( (deliver_home = addr->home_dir) /* Set in address and */
2187 && !testflag(addr, af_home_expanded) /* not expanded */
2188 ) )
2189 {
2190 uschar *rawhome = deliver_home;
2191 deliver_home = NULL; /* in case it contains $home */
2192 if (!(deliver_home = expand_string(rawhome)))
2193 {
2194 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2195 "to expand for %s transport: %s", rawhome, tp->name,
2196 expand_string_message);
2197 return;
2198 }
2199 if (*deliver_home != '/')
2200 {
2201 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2202 "is not absolute for %s transport", deliver_home, tp->name);
2203 return;
2204 }
2205 }
2206
2207 /* See if either the transport or the address specifies a current directory,
2208 and if so, expand it. If nothing is set, use the home directory, unless it is
2209 also unset in which case use "/", which is assumed to be a directory to which
2210 all users have access. It is necessary to be in a visible directory for some
2211 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2212 2.5) require this. */
2213
2214 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2215 if (working_directory)
2216 {
2217 uschar *raw = working_directory;
2218 if (!(working_directory = expand_string(raw)))
2219 {
2220 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2221 "failed to expand for %s transport: %s", raw, tp->name,
2222 expand_string_message);
2223 return;
2224 }
2225 if (*working_directory != '/')
2226 {
2227 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2228 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2229 return;
2230 }
2231 }
2232 else working_directory = deliver_home ? deliver_home : US"/";
2233
2234 /* If one of the return_output flags is set on the transport, create and open a
2235 file in the message log directory for the transport to write its output onto.
2236 This is mainly used by pipe transports. The file needs to be unique to the
2237 address. This feature is not available for shadow transports. */
2238
2239 if ( !shadowing
2240 && ( tp->return_output || tp->return_fail_output
2241 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2242 ) )
2243 {
2244 uschar * error;
2245
2246 addr->return_filename =
2247 spool_fname(US"msglog", message_subdir, message_id,
2248 string_sprintf("-%d-%d", getpid(), return_count++));
2249
2250 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2251 {
2252 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2253 "to return message: %s", error, tp->name, strerror(errno));
2254 return;
2255 }
2256 }
2257
2258 /* Create the pipe for inter-process communication. */
2259
2260 if (pipe(pfd) != 0)
2261 {
2262 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2263 strerror(errno));
2264 return;
2265 }
2266
2267 /* Now fork the process to do the real work in the subprocess, but first
2268 ensure that all cached resources are freed so that the subprocess starts with
2269 a clean slate and doesn't interfere with the parent process. */
2270
2271 search_tidyup();
2272
2273 if ((pid = exim_fork(US"delivery-local")) == 0)
2274 {
2275 BOOL replicate = TRUE;
2276
2277 /* Prevent core dumps, as we don't want them in users' home directories.
2278 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2279 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2280 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2281 complain if the error is "not supported".
2282
2283 There are two scenarios where changing the max limit has an effect. In one,
2284 the user is using a .forward and invoking a command of their choice via pipe;
2285 for these, we do need the max limit to be 0 unless the admin chooses to
2286 permit an increased limit. In the other, the command is invoked directly by
2287 the transport and is under administrator control, thus being able to raise
2288 the limit aids in debugging. So there's no general always-right answer.
2289
2290 Thus we inhibit core-dumps completely but let individual transports, while
2291 still root, re-raise the limits back up to aid debugging. We make the
2292 default be no core-dumps -- few enough people can use core dumps in
2293 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2294 */
2295
2296 #ifdef RLIMIT_CORE
2297 struct rlimit rl;
2298 rl.rlim_cur = 0;
2299 rl.rlim_max = 0;
2300 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2301 {
2302 # ifdef SETRLIMIT_NOT_SUPPORTED
2303 if (errno != ENOSYS && errno != ENOTSUP)
2304 # endif
2305 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2306 strerror(errno));
2307 }
2308 #endif
2309
2310 /* Reset the random number generator, so different processes don't all
2311 have the same sequence. */
2312
2313 random_seed = 0;
2314
2315 /* If the transport has a setup entry, call this first, while still
2316 privileged. (Appendfile uses this to expand quota, for example, while
2317 able to read private files.) */
2318
2319 if (addr->transport->setup)
2320 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2321 &(addr->message)))
2322 {
2323 case DEFER:
2324 addr->transport_return = DEFER;
2325 goto PASS_BACK;
2326
2327 case FAIL:
2328 addr->transport_return = PANIC;
2329 goto PASS_BACK;
2330 }
2331
2332 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2333 when the process becomes unprivileged, it won't be able to write to the
2334 process log. SIGHUP is ignored throughout exim, except when it is being
2335 run as a daemon. */
2336
2337 signal(SIGINT, SIG_IGN);
2338 signal(SIGTERM, SIG_IGN);
2339 signal(SIGUSR1, SIG_IGN);
2340
2341 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2342 half - for transports that exec things (e.g. pipe). Then set the required
2343 gid/uid. */
2344
2345 (void)close(pfd[pipe_read]);
2346 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2347 FD_CLOEXEC);
2348 exim_setugid(uid, gid, use_initgroups,
2349 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2350 addr->address, addr->transport->name));
2351
2352 DEBUG(D_deliver)
2353 {
2354 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2355 for (address_item * batched = addr->next; batched; batched = batched->next)
2356 debug_printf("additional batched address: %s\n", batched->address);
2357 }
2358
2359 /* Set an appropriate working directory. */
2360
2361 if (Uchdir(working_directory) < 0)
2362 {
2363 addr->transport_return = DEFER;
2364 addr->basic_errno = errno;
2365 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2366 }
2367
2368 /* If successful, call the transport */
2369
2370 else
2371 {
2372 BOOL ok = TRUE;
2373 set_process_info("delivering %s to %s using %s", message_id,
2374 addr->local_part, addr->transport->name);
2375
2376 /* Setting this global in the subprocess means we need never clear it */
2377 transport_name = addr->transport->name;
2378
2379 /* If a transport filter has been specified, set up its argument list.
2380 Any errors will get put into the address, and FALSE yielded. */
2381
2382 if (addr->transport->filter_command)
2383 {
2384 ok = transport_set_up_command(&transport_filter_argv,
2385 addr->transport->filter_command,
2386 TRUE, PANIC, addr, US"transport filter", NULL);
2387 transport_filter_timeout = addr->transport->filter_timeout;
2388 }
2389 else transport_filter_argv = NULL;
2390
2391 if (ok)
2392 {
2393 debug_print_string(addr->transport->debug_string);
2394 replicate = !(addr->transport->info->code)(addr->transport, addr);
2395 }
2396 }
2397
2398 /* Pass the results back down the pipe. If necessary, first replicate the
2399 status in the top address to the others in the batch. The label is the
2400 subject of a goto when a call to the transport's setup function fails. We
2401 pass the pointer to the transport back in case it got changed as a result of
2402 file_format in appendfile. */
2403
2404 PASS_BACK:
2405
2406 if (replicate) replicate_status(addr);
2407 for (addr2 = addr; addr2; addr2 = addr2->next)
2408 {
2409 int i;
2410 int local_part_length = Ustrlen(addr2->local_part);
2411 uschar *s;
2412 int ret;
2413
2414 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2415 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2416 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2417 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2418 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2419 || (ret = write(pfd[pipe_write], &addr2->delivery_time, sizeof(struct timeval))) != sizeof(struct timeval)
2420 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2421 || (ret = write(pfd[pipe_write], &addr2->transport,
2422 sizeof(transport_instance *))) != sizeof(transport_instance *)
2423
2424 /* For a file delivery, pass back the local part, in case the original
2425 was only part of the final delivery path. This gives more complete
2426 logging. */
2427
2428 || (testflag(addr2, af_file)
2429 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2430 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2431 )
2432 )
2433 )
2434 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2435 ret == -1 ? strerror(errno) : "short write");
2436
2437 /* Now any messages */
2438
2439 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2440 {
2441 int message_length = s ? Ustrlen(s) + 1 : 0;
2442 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2443 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2444 )
2445 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2446 ret == -1 ? strerror(errno) : "short write");
2447 }
2448 }
2449
2450 /* OK, this process is now done. Free any cached resources that it opened,
2451 and close the pipe we were writing down before exiting. */
2452
2453 (void)close(pfd[pipe_write]);
2454 search_tidyup();
2455 exit(EXIT_SUCCESS);
2456 }
2457
2458 /* Back in the main process: panic if the fork did not succeed. This seems
2459 better than returning an error - if forking is failing it is probably best
2460 not to try other deliveries for this message. */
2461
2462 if (pid < 0)
2463 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2464 addr->address);
2465
2466 /* Read the pipe to get the delivery status codes and error messages. Our copy
2467 of the writing end must be closed first, as otherwise read() won't return zero
2468 on an empty pipe. We check that a status exists for each address before
2469 overwriting the address structure. If data is missing, the default DEFER status
2470 will remain. Afterwards, close the reading end. */
2471
2472 (void)close(pfd[pipe_write]);
2473
2474 for (addr2 = addr; addr2; addr2 = addr2->next)
2475 {
2476 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2477 {
2478 int i;
2479 uschar **sptr;
2480
2481 addr2->transport_return = status;
2482 len = read(pfd[pipe_read], &transport_count,
2483 sizeof(transport_count));
2484 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2485 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2486 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2487 len = read(pfd[pipe_read], &addr2->delivery_time, sizeof(struct timeval));
2488 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2489 len = read(pfd[pipe_read], &addr2->transport,
2490 sizeof(transport_instance *));
2491
2492 if (testflag(addr2, af_file))
2493 {
2494 int llen;
2495 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2496 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2497 )
2498 {
2499 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2500 " from delivery subprocess");
2501 break;
2502 }
2503 /* sanity-checked llen so disable the Coverity error */
2504 /* coverity[tainted_data] */
2505 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2506 {
2507 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2508 " from delivery subprocess");
2509 break;
2510 }
2511 big_buffer[llen] = 0;
2512 addr2->local_part = string_copy(big_buffer);
2513 }
2514
2515 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2516 {
2517 int message_length;
2518 len = read(pfd[pipe_read], &message_length, sizeof(int));
2519 if (message_length > 0)
2520 {
2521 len = read(pfd[pipe_read], big_buffer, message_length);
2522 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2523 if (len > 0) *sptr = string_copy(big_buffer);
2524 }
2525 }
2526 }
2527
2528 else
2529 {
2530 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2531 "from delivery subprocess", addr2->unique);
2532 break;
2533 }
2534 }
2535
2536 (void)close(pfd[pipe_read]);
2537
2538 /* Unless shadowing, write all successful addresses immediately to the journal
2539 file, to ensure they are recorded asap. For homonymic addresses, use the base
2540 address plus the transport name. Failure to write the journal is panic-worthy,
2541 but don't stop, as it may prove possible subsequently to update the spool file
2542 in order to record the delivery. */
2543
2544 if (!shadowing)
2545 {
2546 for (addr2 = addr; addr2; addr2 = addr2->next)
2547 if (addr2->transport_return == OK)
2548 {
2549 if (testflag(addr2, af_homonym))
2550 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2551 else
2552 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2553
2554 /* In the test harness, wait just a bit to let the subprocess finish off
2555 any debug output etc first. */
2556
2557 testharness_pause_ms(300);
2558
2559 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2560 len = Ustrlen(big_buffer);
2561 if (write(journal_fd, big_buffer, len) != len)
2562 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2563 big_buffer, strerror(errno));
2564 }
2565
2566 /* Ensure the journal file is pushed out to disk. */
2567
2568 if (EXIMfsync(journal_fd) < 0)
2569 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2570 strerror(errno));
2571 }
2572
2573 /* Wait for the process to finish. If it terminates with a non-zero code,
2574 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2575 status values of all the addresses as they are. Take care to handle the case
2576 when the subprocess doesn't seem to exist. This has been seen on one system
2577 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2578 happens, wait() doesn't recognize the termination of child processes. Exim now
2579 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2580
2581 while ((rc = wait(&status)) != pid)
2582 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2583 {
2584 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2585 addr->transport->driver_name);
2586 status = 0;
2587 break;
2588 }
2589
2590 if ((status & 0xffff) != 0)
2591 {
2592 int msb = (status >> 8) & 255;
2593 int lsb = status & 255;
2594 int code = (msb == 0)? (lsb & 0x7f) : msb;
2595 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2596 addr->special_action = SPECIAL_FREEZE;
2597 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2598 "status 0x%04x: %s %d",
2599 addr->transport->driver_name,
2600 status,
2601 msb == 0 ? "terminated by signal" : "exit code",
2602 code);
2603 }
2604
2605 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2606
2607 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2608 {
2609 int fd;
2610 uschar *warn_message;
2611 pid_t pid;
2612
2613 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2614
2615 if (!(warn_message = expand_string(addr->transport->warn_message)))
2616 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2617 "message for %s transport): %s", addr->transport->warn_message,
2618 addr->transport->name, expand_string_message);
2619
2620 else if ((pid = child_open_exim(&fd, US"tpt-warning-message")) > 0)
2621 {
2622 FILE *f = fdopen(fd, "wb");
2623 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2624 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2625 fprintf(f, "Auto-Submitted: auto-replied\n");
2626 if (!contains_header(US"From", warn_message))
2627 moan_write_from(f);
2628 fprintf(f, "%s", CS warn_message);
2629
2630 /* Close and wait for child process to complete, without a timeout. */
2631
2632 (void)fclose(f);
2633 (void)child_close(pid, 0);
2634 }
2635
2636 addr->special_action = SPECIAL_NONE;
2637 }
2638 }
2639
2640
2641
2642
2643 /* Check transport for the given concurrency limit. Return TRUE if over
2644 the limit (or an expansion failure), else FALSE and if there was a limit,
2645 the key for the hints database used for the concurrency count. */
2646
2647 static BOOL
2648 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2649 {
2650 unsigned max_parallel;
2651
2652 if (!tp->max_parallel) return FALSE;
2653
2654 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2655 if (expand_string_message)
2656 {
2657 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2658 "in %s transport (%s): %s", tp->name, addr->address,
2659 expand_string_message);
2660 return TRUE;
2661 }
2662
2663 if (max_parallel > 0)
2664 {
2665 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2666 if (!enq_start(serialize_key, max_parallel))
2667 {
2668 address_item * next;
2669 DEBUG(D_transport)
2670 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2671 tp->name, max_parallel);
2672 do
2673 {
2674 next = addr->next;
2675 addr->message = US"concurrency limit reached for transport";
2676 addr->basic_errno = ERRNO_TRETRY;
2677 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2678 } while ((addr = next));
2679 return TRUE;
2680 }
2681 *key = serialize_key;
2682 }
2683 return FALSE;
2684 }
2685
2686
2687
2688 /*************************************************
2689 * Do local deliveries *
2690 *************************************************/
2691
2692 /* This function processes the list of addresses in addr_local. True local
2693 deliveries are always done one address at a time. However, local deliveries can
2694 be batched up in some cases. Typically this is when writing batched SMTP output
2695 files for use by some external transport mechanism, or when running local
2696 deliveries over LMTP.
2697
2698 Arguments: None
2699 Returns: Nothing
2700 */
2701
2702 static void
2703 do_local_deliveries(void)
2704 {
2705 open_db dbblock;
2706 open_db *dbm_file = NULL;
2707 time_t now = time(NULL);
2708
2709 /* Loop until we have exhausted the supply of local deliveries */
2710
2711 while (addr_local)
2712 {
2713 struct timeval delivery_start;
2714 struct timeval deliver_time;
2715 address_item *addr2, *addr3, *nextaddr;
2716 int logflags = LOG_MAIN;
2717 int logchar = f.dont_deliver? '*' : '=';
2718 transport_instance *tp;
2719 uschar * serialize_key = NULL;
2720
2721 /* Pick the first undelivered address off the chain */
2722
2723 address_item *addr = addr_local;
2724 addr_local = addr->next;
2725 addr->next = NULL;
2726
2727 DEBUG(D_deliver|D_transport)
2728 debug_printf("--------> %s <--------\n", addr->address);
2729
2730 /* An internal disaster if there is no transport. Should not occur! */
2731
2732 if (!(tp = addr->transport))
2733 {
2734 logflags |= LOG_PANIC;
2735 f.disable_logging = FALSE; /* Jic */
2736 addr->message = addr->router
2737 ? string_sprintf("No transport set by %s router", addr->router->name)
2738 : US"No transport set by system filter";
2739 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2740 continue;
2741 }
2742
2743 /* Check that this base address hasn't previously been delivered to this
2744 transport. The check is necessary at this point to handle homonymic addresses
2745 correctly in cases where the pattern of redirection changes between delivery
2746 attempts. Non-homonymic previous delivery is detected earlier, at routing
2747 time. */
2748
2749 if (previously_transported(addr, FALSE)) continue;
2750
2751 /* There are weird cases where logging is disabled */
2752
2753 f.disable_logging = tp->disable_logging;
2754
2755 /* Check for batched addresses and possible amalgamation. Skip all the work
2756 if either batch_max <= 1 or there aren't any other addresses for local
2757 delivery. */
2758
2759 if (tp->batch_max > 1 && addr_local)
2760 {
2761 int batch_count = 1;
2762 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2763 BOOL uses_lp = ( testflag(addr, af_pfr)
2764 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2765 )
2766 || readconf_depends((driver_instance *)tp, US"local_part");
2767 uschar *batch_id = NULL;
2768 address_item **anchor = &addr_local;
2769 address_item *last = addr;
2770 address_item *next;
2771
2772 /* Expand the batch_id string for comparison with other addresses.
2773 Expansion failure suppresses batching. */
2774
2775 if (tp->batch_id)
2776 {
2777 deliver_set_expansions(addr);
2778 batch_id = expand_string(tp->batch_id);
2779 deliver_set_expansions(NULL);
2780 if (!batch_id)
2781 {
2782 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2783 "in %s transport (%s): %s", tp->name, addr->address,
2784 expand_string_message);
2785 batch_count = tp->batch_max;
2786 }
2787 }
2788
2789 /* Until we reach the batch_max limit, pick off addresses which have the
2790 same characteristics. These are:
2791
2792 same transport
2793 not previously delivered (see comment about 50 lines above)
2794 same local part if the transport's configuration contains $local_part
2795 or if this is a file or pipe delivery from a redirection
2796 same domain if the transport's configuration contains $domain
2797 same errors address
2798 same additional headers
2799 same headers to be removed
2800 same uid/gid for running the transport
2801 same first host if a host list is set
2802 */
2803
2804 while ((next = *anchor) && batch_count < tp->batch_max)
2805 {
2806 BOOL ok =
2807 tp == next->transport
2808 && !previously_transported(next, TRUE)
2809 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2810 && testflag(addr, af_file) == testflag(next, af_file)
2811 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2812 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2813 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2814 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2815 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2816 && same_ugid(tp, addr, next)
2817 && ( !addr->host_list && !next->host_list
2818 || addr->host_list
2819 && next->host_list
2820 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2821 );
2822
2823 /* If the transport has a batch_id setting, batch_id will be non-NULL
2824 from the expansion outside the loop. Expand for this address and compare.
2825 Expansion failure makes this address ineligible for batching. */
2826
2827 if (ok && batch_id)
2828 {
2829 uschar *bid;
2830 address_item *save_nextnext = next->next;
2831 next->next = NULL; /* Expansion for a single address */
2832 deliver_set_expansions(next);
2833 next->next = save_nextnext;
2834 bid = expand_string(tp->batch_id);
2835 deliver_set_expansions(NULL);
2836 if (!bid)
2837 {
2838 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2839 "in %s transport (%s): %s", tp->name, next->address,
2840 expand_string_message);
2841 ok = FALSE;
2842 }
2843 else ok = (Ustrcmp(batch_id, bid) == 0);
2844 }
2845
2846 /* Take address into batch if OK. */
2847
2848 if (ok)
2849 {
2850 *anchor = next->next; /* Include the address */
2851 next->next = NULL;
2852 last->next = next;
2853 last = next;
2854 batch_count++;
2855 }
2856 else anchor = &next->next; /* Skip the address */
2857 }
2858 }
2859
2860 /* We now have one or more addresses that can be delivered in a batch. Check
2861 whether the transport is prepared to accept a message of this size. If not,
2862 fail them all forthwith. If the expansion fails, or does not yield an
2863 integer, defer delivery. */
2864
2865 if (tp->message_size_limit)
2866 {
2867 int rc = check_message_size(tp, addr);
2868 if (rc != OK)
2869 {
2870 replicate_status(addr);
2871 while (addr)
2872 {
2873 addr2 = addr->next;
2874 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2875 addr = addr2;
2876 }
2877 continue; /* With next batch of addresses */
2878 }
2879 }
2880
2881 /* If we are not running the queue, or if forcing, all deliveries will be
2882 attempted. Otherwise, we must respect the retry times for each address. Even
2883 when not doing this, we need to set up the retry key string, and determine
2884 whether a retry record exists, because after a successful delivery, a delete
2885 retry item must be set up. Keep the retry database open only for the duration
2886 of these checks, rather than for all local deliveries, because some local
2887 deliveries (e.g. to pipes) can take a substantial time. */
2888
2889 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2890 {
2891 DEBUG(D_deliver|D_retry|D_hints_lookup)
2892 debug_printf("no retry data available\n");
2893 }
2894
2895 addr2 = addr;
2896 addr3 = NULL;
2897 while (addr2)
2898 {
2899 BOOL ok = TRUE; /* to deliver this address */
2900 uschar *retry_key;
2901
2902 /* Set up the retry key to include the domain or not, and change its
2903 leading character from "R" to "T". Must make a copy before doing this,
2904 because the old key may be pointed to from a "delete" retry item after
2905 a routing delay. */
2906
2907 retry_key = string_copy(
2908 tp->retry_use_local_part ? addr2->address_retry_key :
2909 addr2->domain_retry_key);
2910 *retry_key = 'T';
2911
2912 /* Inspect the retry data. If there is no hints file, delivery happens. */
2913
2914 if (dbm_file)
2915 {
2916 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2917
2918 /* If there is no retry record, delivery happens. If there is,
2919 remember it exists so it can be deleted after a successful delivery. */
2920
2921 if (retry_record)
2922 {
2923 setflag(addr2, af_lt_retry_exists);
2924
2925 /* A retry record exists for this address. If queue running and not
2926 forcing, inspect its contents. If the record is too old, or if its
2927 retry time has come, or if it has passed its cutoff time, delivery
2928 will go ahead. */
2929
2930 DEBUG(D_retry)
2931 {
2932 debug_printf("retry record exists: age=%s ",
2933 readconf_printtime(now - retry_record->time_stamp));
2934 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2935 debug_printf(" time to retry = %s expired = %d\n",
2936 readconf_printtime(retry_record->next_try - now),
2937 retry_record->expired);
2938 }
2939
2940 if (f.queue_running && !f.deliver_force)
2941 {
2942 ok = (now - retry_record->time_stamp > retry_data_expire)
2943 || (now >= retry_record->next_try)
2944 || retry_record->expired;
2945
2946 /* If we haven't reached the retry time, there is one more check
2947 to do, which is for the ultimate address timeout. */
2948
2949 if (!ok)
2950 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2951 retry_record, now);
2952 }
2953 }
2954 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2955 }
2956
2957 /* This address is to be delivered. Leave it on the chain. */
2958
2959 if (ok)
2960 {
2961 addr3 = addr2;
2962 addr2 = addr2->next;
2963 }
2964
2965 /* This address is to be deferred. Take it out of the chain, and
2966 post-process it as complete. Must take it out of the chain first,
2967 because post processing puts it on another chain. */
2968
2969 else
2970 {
2971 address_item *this = addr2;
2972 this->message = US"Retry time not yet reached";
2973 this->basic_errno = ERRNO_LRETRY;
2974 addr2 = addr3 ? (addr3->next = addr2->next)
2975 : (addr = addr2->next);
2976 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2977 }
2978 }
2979
2980 if (dbm_file) dbfn_close(dbm_file);
2981
2982 /* If there are no addresses left on the chain, they all deferred. Loop
2983 for the next set of addresses. */
2984
2985 if (!addr) continue;
2986
2987 /* If the transport is limited for parallellism, enforce that here.
2988 We use a hints DB entry, incremented here and decremented after
2989 the transport (and any shadow transport) completes. */
2990
2991 if (tpt_parallel_check(tp, addr, &serialize_key))
2992 {
2993 if (expand_string_message)
2994 {
2995 logflags |= LOG_PANIC;
2996 do
2997 {
2998 addr = addr->next;
2999 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
3000 } while ((addr = addr2));
3001 }
3002 continue; /* Loop for the next set of addresses. */
3003 }
3004
3005
3006 /* So, finally, we do have some addresses that can be passed to the
3007 transport. Before doing so, set up variables that are relevant to a
3008 single delivery. */
3009
3010 deliver_set_expansions(addr);
3011
3012 gettimeofday(&delivery_start, NULL);
3013 deliver_local(addr, FALSE);
3014 timesince(&deliver_time, &delivery_start);
3015
3016 /* If a shadow transport (which must perforce be another local transport), is
3017 defined, and its condition is met, we must pass the message to the shadow
3018 too, but only those addresses that succeeded. We do this by making a new
3019 chain of addresses - also to keep the original chain uncontaminated. We must
3020 use a chain rather than doing it one by one, because the shadow transport may
3021 batch.
3022
3023 NOTE: if the condition fails because of a lookup defer, there is nothing we
3024 can do! */
3025
3026 if ( tp->shadow
3027 && ( !tp->shadow_condition
3028 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3029 ) )
3030 {
3031 transport_instance *stp;
3032 address_item *shadow_addr = NULL;
3033 address_item **last = &shadow_addr;
3034
3035 for (stp = transports; stp; stp = stp->next)
3036 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3037
3038 if (!stp)
3039 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3040 tp->shadow);
3041
3042 /* Pick off the addresses that have succeeded, and make clones. Put into
3043 the shadow_message field a pointer to the shadow_message field of the real
3044 address. */
3045
3046 else for (addr2 = addr; addr2; addr2 = addr2->next)
3047 if (addr2->transport_return == OK)
3048 {
3049 addr3 = store_get(sizeof(address_item), FALSE);
3050 *addr3 = *addr2;
3051 addr3->next = NULL;
3052 addr3->shadow_message = US &addr2->shadow_message;
3053 addr3->transport = stp;
3054 addr3->transport_return = DEFER;
3055 addr3->return_filename = NULL;
3056 addr3->return_file = -1;
3057 *last = addr3;
3058 last = &addr3->next;
3059 }
3060
3061 /* If we found any addresses to shadow, run the delivery, and stick any
3062 message back into the shadow_message field in the original. */
3063
3064 if (shadow_addr)
3065 {
3066 int save_count = transport_count;
3067
3068 DEBUG(D_deliver|D_transport)
3069 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3070 deliver_local(shadow_addr, TRUE);
3071
3072 for(; shadow_addr; shadow_addr = shadow_addr->next)
3073 {
3074 int sresult = shadow_addr->transport_return;
3075 *(uschar **)shadow_addr->shadow_message =
3076 sresult == OK
3077 ? string_sprintf(" ST=%s", stp->name)
3078 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3079 shadow_addr->basic_errno <= 0
3080 ? US""
3081 : US strerror(shadow_addr->basic_errno),
3082 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3083 ? US""
3084 : US": ",
3085 shadow_addr->message
3086 ? shadow_addr->message
3087 : shadow_addr->basic_errno <= 0
3088 ? US"unknown error"
3089 : US"");
3090
3091 DEBUG(D_deliver|D_transport)
3092 debug_printf("%s shadow transport returned %s for %s\n",
3093 stp->name, rc_to_string(sresult), shadow_addr->address);
3094 }
3095
3096 DEBUG(D_deliver|D_transport)
3097 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3098
3099 transport_count = save_count; /* Restore original transport count */
3100 }
3101 }
3102
3103 /* Cancel the expansions that were set up for the delivery. */
3104
3105 deliver_set_expansions(NULL);
3106
3107 /* If the transport was parallelism-limited, decrement the hints DB record. */
3108
3109 if (serialize_key) enq_end(serialize_key);
3110
3111 /* Now we can process the results of the real transport. We must take each
3112 address off the chain first, because post_process_one() puts it on another
3113 chain. */
3114
3115 for (addr2 = addr; addr2; addr2 = nextaddr)
3116 {
3117 int result = addr2->transport_return;
3118 nextaddr = addr2->next;
3119
3120 DEBUG(D_deliver|D_transport)
3121 debug_printf("%s transport returned %s for %s\n",
3122 tp->name, rc_to_string(result), addr2->address);
3123
3124 /* If there is a retry_record, or if delivery is deferred, build a retry
3125 item for setting a new retry time or deleting the old retry record from
3126 the database. These items are handled all together after all addresses
3127 have been handled (so the database is open just for a short time for
3128 updating). */
3129
3130 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3131 {
3132 int flags = result == DEFER ? 0 : rf_delete;
3133 uschar *retry_key = string_copy(tp->retry_use_local_part
3134 ? addr2->address_retry_key : addr2->domain_retry_key);
3135 *retry_key = 'T';
3136 retry_add_item(addr2, retry_key, flags);
3137 }
3138
3139 /* Done with this address */
3140
3141 addr2->delivery_time = deliver_time;
3142 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3143
3144 /* If a pipe delivery generated text to be sent back, the result may be
3145 changed to FAIL, and we must copy this for subsequent addresses in the
3146 batch. */
3147
3148 if (addr2->transport_return != result)
3149 {
3150 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3151 {
3152 addr3->transport_return = addr2->transport_return;
3153 addr3->basic_errno = addr2->basic_errno;
3154 addr3->message = addr2->message;
3155 }
3156 result = addr2->transport_return;
3157 }
3158
3159 /* Whether or not the result was changed to FAIL, we need to copy the
3160 return_file value from the first address into all the addresses of the
3161 batch, so they are all listed in the error message. */
3162
3163 addr2->return_file = addr->return_file;
3164
3165 /* Change log character for recording successful deliveries. */
3166
3167 if (result == OK) logchar = '-';
3168 }
3169 } /* Loop back for next batch of addresses */
3170 }
3171
3172
3173
3174
3175 /*************************************************
3176 * Sort remote deliveries *
3177 *************************************************/
3178
3179 /* This function is called if remote_sort_domains is set. It arranges that the
3180 chain of addresses for remote deliveries is ordered according to the strings
3181 specified. Try to make this shuffling reasonably efficient by handling
3182 sequences of addresses rather than just single ones.
3183
3184 Arguments: None
3185 Returns: Nothing
3186 */
3187
3188 static void
3189 sort_remote_deliveries(void)
3190 {
3191 int sep = 0;
3192 address_item **aptr = &addr_remote;
3193 const uschar *listptr = remote_sort_domains;
3194 uschar *pattern;
3195 uschar patbuf[256];
3196
3197 while ( *aptr
3198 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3199 )
3200 {
3201 address_item *moved = NULL;
3202 address_item **bptr = &moved;
3203
3204 while (*aptr)
3205 {
3206 address_item **next;
3207 deliver_domain = (*aptr)->domain; /* set $domain */
3208 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3209 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3210 {
3211 aptr = &(*aptr)->next;
3212 continue;
3213 }
3214
3215 next = &(*aptr)->next;
3216 while ( *next
3217 && (deliver_domain = (*next)->domain, /* Set $domain */
3218 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3219 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3220 )
3221 next = &(*next)->next;
3222
3223 /* If the batch of non-matchers is at the end, add on any that were
3224 extracted further up the chain, and end this iteration. Otherwise,
3225 extract them from the chain and hang on the moved chain. */
3226
3227 if (!*next)
3228 {
3229 *next = moved;
3230 break;
3231 }
3232
3233 *bptr = *aptr;
3234 *aptr = *next;
3235 *next = NULL;
3236 bptr = next;
3237 aptr = &(*aptr)->next;
3238 }
3239
3240 /* If the loop ended because the final address matched, *aptr will
3241 be NULL. Add on to the end any extracted non-matching addresses. If
3242 *aptr is not NULL, the loop ended via "break" when *next is null, that
3243 is, there was a string of non-matching addresses at the end. In this
3244 case the extracted addresses have already been added on the end. */
3245
3246 if (!*aptr) *aptr = moved;
3247 }
3248
3249 DEBUG(D_deliver)
3250 {
3251 debug_printf("remote addresses after sorting:\n");
3252 for (address_item * addr = addr_remote; addr; addr = addr->next)
3253 debug_printf(" %s\n", addr->address);
3254 }
3255 }
3256
3257
3258
3259 /*************************************************
3260 * Read from pipe for remote delivery subprocess *
3261 *************************************************/
3262
3263 /* This function is called when the subprocess is complete, but can also be
3264 called before it is complete, in order to empty a pipe that is full (to prevent
3265 deadlock). It must therefore keep track of its progress in the parlist data
3266 block.
3267
3268 We read the pipe to get the delivery status codes and a possible error message
3269 for each address, optionally preceded by unusability data for the hosts and
3270 also by optional retry data.
3271
3272 Read in large chunks into the big buffer and then scan through, interpreting
3273 the data therein. In most cases, only a single read will be necessary. No
3274 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3275 that we read the next chunk when there is less than 2500 bytes left in the
3276 non-final chunk, we can assume each item is complete in the buffer before
3277 handling it. Each item is written using a single write(), which is atomic for
3278 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3279 often bigger) so even if we are reading while the subprocess is still going, we
3280 should never have only a partial item in the buffer.
3281
3282 hs12: This assumption is not true anymore, since we get quite large items (certificate
3283 information and such).
3284
3285 Argument:
3286 poffset the offset of the parlist item
3287 eop TRUE if the process has completed
3288
3289 Returns: TRUE if the terminating 'Z' item has been read,
3290 or there has been a disaster (i.e. no more data needed);
3291 FALSE otherwise
3292 */
3293
3294 static BOOL
3295 par_read_pipe(int poffset, BOOL eop)
3296 {
3297 host_item *h;
3298 pardata *p = parlist + poffset;
3299 address_item *addrlist = p->addrlist;
3300 address_item *addr = p->addr;
3301 pid_t pid = p->pid;
3302 int fd = p->fd;
3303
3304 uschar *msg = p->msg;
3305 BOOL done = p->done;
3306
3307 /* Loop through all items, reading from the pipe when necessary. The pipe
3308 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3309 here, as the preceding select() tells us, if data is available for reading.
3310
3311 A read() on a "selected" handle should never block, but(!) it may return
3312 less data then we expected. (The buffer size we pass to read() shouldn't be
3313 understood as a "request", but as a "limit".)
3314
3315 Each separate item is written to the pipe in a timely manner. But, especially for
3316 larger items, the read(2) may already return partial data from the write(2).
3317
3318 The write is atomic mostly (depending on the amount written), but atomic does
3319 not imply "all or noting", it just is "not intermixed" with other writes on the
3320 same channel (pipe).
3321
3322 */
3323
3324 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3325 (int)p->pid, eop? "ended" : "not ended yet");
3326
3327 while (!done)
3328 {
3329 retry_item *r, **rp;
3330 uschar pipeheader[PIPE_HEADER_SIZE+1];
3331 uschar *id = &pipeheader[0];
3332 uschar *subid = &pipeheader[1];
3333 uschar *ptr = big_buffer;
3334 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3335 ssize_t got;
3336
3337 DEBUG(D_deliver) debug_printf(
3338 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3339
3340 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3341 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3342 If we get less, we can assume the subprocess do be done and do not expect any further
3343 information from it. */
3344
3345 if ((got = readn(fd, pipeheader, required)) != required)
3346 {
3347 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3348 "from transport process %d for transport %s",
3349 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3350 done = TRUE;
3351 break;
3352 }
3353
3354 pipeheader[PIPE_HEADER_SIZE] = '\0';
3355 DEBUG(D_deliver)
3356 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3357 (long) got, pid);
3358
3359 {
3360 /* If we can't decode the pipeheader, the subprocess seems to have a
3361 problem, we do not expect any furher information from it. */
3362 char *endc;
3363 required = Ustrtol(pipeheader+2, &endc, 10);
3364 if (*endc)
3365 {
3366 msg = string_sprintf("failed to read pipe "
3367 "from transport process %d for transport %s: error decoding size from header",
3368 pid, addr->transport->driver_name);
3369 done = TRUE;
3370 break;
3371 }
3372 }
3373
3374 DEBUG(D_deliver)
3375 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3376 (u_long)required, pid);
3377
3378 /* Same as above, the transport process will write the bytes announced
3379 in a timely manner, so we can just wait for the bytes, getting less than expected
3380 is considered a problem of the subprocess, we do not expect anything else from it. */
3381 if ((got = readn(fd, big_buffer, required)) != required)
3382 {
3383 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3384 " bytes (pipedata) from transport process %d for transport %s",
3385 got, required, pid, addr->transport->driver_name);
3386 done = TRUE;
3387 break;
3388 }
3389
3390 /* Handle each possible type of item, assuming the complete item is
3391 available in store. */
3392
3393 switch (*id)
3394 {
3395 /* Host items exist only if any hosts were marked unusable. Match
3396 up by checking the IP address. */
3397
3398 case 'H':
3399 for (h = addrlist->host_list; h; h = h->next)
3400 {
3401 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3402 h->status = ptr[0];
3403 h->why = ptr[1];
3404 }
3405 ptr += 2;
3406 while (*ptr++);
3407 break;
3408
3409 /* Retry items are sent in a preceding R item for each address. This is
3410 kept separate to keep each message short enough to guarantee it won't
3411 be split in the pipe. Hopefully, in the majority of cases, there won't in
3412 fact be any retry items at all.
3413
3414 The complete set of retry items might include an item to delete a
3415 routing retry if there was a previous routing delay. However, routing
3416 retries are also used when a remote transport identifies an address error.
3417 In that case, there may also be an "add" item for the same key. Arrange
3418 that a "delete" item is dropped in favour of an "add" item. */
3419
3420 case 'R':
3421 if (!addr) goto ADDR_MISMATCH;
3422
3423 DEBUG(D_deliver|D_retry)
3424 debug_printf("reading retry information for %s from subprocess\n",
3425 ptr+1);
3426
3427 /* Cut out any "delete" items on the list. */
3428
3429 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3430 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3431 {
3432 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3433 *rp = r->next; /* Excise a delete item */
3434 DEBUG(D_deliver|D_retry)
3435 debug_printf(" existing delete item dropped\n");
3436 }
3437
3438 /* We want to add a delete item only if there is no non-delete item;
3439 however we still have to step ptr through the data. */
3440
3441 if (!r || !(*ptr & rf_delete))
3442 {
3443 r = store_get(sizeof(retry_item), FALSE);
3444 r->next = addr->retries;
3445 addr->retries = r;
3446 r->flags = *ptr++;
3447 r->key = string_copy(ptr);
3448 while (*ptr++);
3449 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3450 ptr += sizeof(r->basic_errno);
3451 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3452 ptr += sizeof(r->more_errno);
3453 r->message = *ptr ? string_copy(ptr) : NULL;
3454 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3455 r->flags & rf_delete ? "delete" : "retry");
3456 }
3457
3458 else
3459 {
3460 DEBUG(D_deliver|D_retry)
3461 debug_printf(" delete item not added: non-delete item exists\n");
3462 ptr++;
3463 while(*ptr++);
3464 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3465 }
3466
3467 while(*ptr++);
3468 break;
3469
3470 /* Put the amount of data written into the parlist block */
3471
3472 case 'S':
3473 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3474 ptr += sizeof(transport_count);
3475 break;
3476
3477 /* Address items are in the order of items on the address chain. We
3478 remember the current address value in case this function is called
3479 several times to empty the pipe in stages. Information about delivery
3480 over TLS is sent in a preceding X item for each address. We don't put
3481 it in with the other info, in order to keep each message short enough to
3482 guarantee it won't be split in the pipe. */
3483
3484 #ifndef DISABLE_TLS
3485 case 'X':
3486 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3487 switch (*subid)
3488 {
3489 case '1':
3490 addr->tlsver = addr->cipher = addr->peerdn = NULL;
3491
3492 if (*ptr)
3493 {
3494 addr->cipher = string_copy(ptr);
3495 addr->tlsver = string_copyn(ptr, Ustrchr(ptr, ':') - ptr);
3496 }
3497 while (*ptr++);
3498 if (*ptr)
3499 addr->peerdn = string_copy(ptr);
3500 break;
3501
3502 case '2':
3503 if (*ptr)
3504 (void) tls_import_cert(ptr, &addr->peercert);
3505 else
3506 addr->peercert = NULL;
3507 break;
3508
3509 case '3':
3510 if (*ptr)
3511 (void) tls_import_cert(ptr, &addr->ourcert);
3512 else
3513 addr->ourcert = NULL;
3514 break;
3515
3516 # ifndef DISABLE_OCSP
3517 case '4':
3518 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3519 break;
3520 # endif
3521 }
3522 while (*ptr++);
3523 break;
3524 #endif /*DISABLE_TLS*/
3525
3526 case 'C': /* client authenticator information */
3527 switch (*subid)
3528 {
3529 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3530 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3531 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3532 }
3533 while (*ptr++);
3534 break;
3535
3536 #ifndef DISABLE_PRDR
3537 case 'P':
3538 setflag(addr, af_prdr_used);
3539 break;
3540 #endif
3541
3542 case 'L':
3543 switch (*subid)
3544 {
3545 #ifndef DISABLE_PIPE_CONNECT
3546 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3547 #endif
3548 case 1: setflag(addr, af_pipelining); break;
3549 }
3550 break;
3551
3552 case 'K':
3553 setflag(addr, af_chunking_used);
3554 break;
3555
3556 case 'T':
3557 setflag(addr, af_tcp_fastopen_conn);
3558 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3559 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3560 break;
3561
3562 case 'D':
3563 if (!addr) goto ADDR_MISMATCH;
3564 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3565 ptr += sizeof(addr->dsn_aware);
3566 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3567 break;
3568
3569 case 'A':
3570 if (!addr)
3571 {
3572 ADDR_MISMATCH:
3573 msg = string_sprintf("address count mismatch for data read from pipe "
3574 "for transport process %d for transport %s", pid,
3575 addrlist->transport->driver_name);
3576 done = TRUE;
3577 break;
3578 }
3579
3580 switch (*subid)
3581 {
3582 #ifdef SUPPORT_SOCKS
3583 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3584 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3585 if (*ptr == 0)
3586 ptr++;
3587 else
3588 {
3589 proxy_local_address = string_copy(ptr);
3590 while(*ptr++);
3591 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3592 ptr += sizeof(proxy_local_port);
3593 }
3594 break;
3595 #endif
3596
3597 #ifdef EXPERIMENTAL_DSN_INFO
3598 case '1': /* must arrive before A0, and applies to that addr */
3599 /* Two strings: smtp_greeting and helo_response */
3600 addr->smtp_greeting = string_copy(ptr);
3601 while(*ptr++);
3602 addr->helo_response = string_copy(ptr);
3603 while(*ptr++);
3604 break;
3605 #endif
3606
3607 case '0':
3608 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3609 addr->transport_return = *ptr++;
3610 addr->special_action = *ptr++;
3611 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3612 ptr += sizeof(addr->basic_errno);
3613 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3614 ptr += sizeof(addr->more_errno);
3615 memcpy(&addr->delivery_time, ptr, sizeof(addr->delivery_time));
3616 ptr += sizeof(addr->delivery_time);
3617 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3618 ptr += sizeof(addr->flags);
3619 addr->message = *ptr ? string_copy(ptr) : NULL;
3620 while(*ptr++);
3621 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3622 while(*ptr++);
3623
3624 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3625
3626 if (*ptr)
3627 {
3628 h = store_get(sizeof(host_item), FALSE);
3629 h->name = string_copy(ptr);
3630 while (*ptr++);
3631 h->address = string_copy(ptr);
3632 while(*ptr++);
3633 memcpy(&h->port, ptr, sizeof(h->port));
3634 ptr += sizeof(h->port);
3635 h->dnssec = *ptr == '2' ? DS_YES
3636 : *ptr == '1' ? DS_NO
3637 : DS_UNK;
3638 ptr++;
3639 addr->host_used = h;
3640 }
3641 else ptr++;
3642
3643 /* Finished with this address */
3644
3645 addr = addr->next;
3646 break;
3647 }
3648 break;
3649
3650 /* Local interface address/port */
3651 case 'I':
3652 if (*ptr) sending_ip_address = string_copy(ptr);
3653 while (*ptr++) ;
3654 if (*ptr) sending_port = atoi(CS ptr);
3655 while (*ptr++) ;
3656 break;
3657
3658 /* Z marks the logical end of the data. It is followed by '0' if
3659 continue_transport was NULL at the end of transporting, otherwise '1'.
3660 We need to know when it becomes NULL during a delivery down a passed SMTP
3661 channel so that we don't try to pass anything more down it. Of course, for
3662 most normal messages it will remain NULL all the time. */
3663
3664 case 'Z':
3665 if (*ptr == '0')
3666 {
3667 continue_transport = NULL;
3668 continue_hostname = NULL;
3669 }
3670 done = TRUE;
3671 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3672 break;
3673
3674 /* Anything else is a disaster. */
3675
3676 default:
3677 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3678 "process %d for transport %s", ptr[-1], pid,
3679 addr->transport->driver_name);
3680 done = TRUE;
3681 break;
3682 }
3683 }
3684
3685 /* The done flag is inspected externally, to determine whether or not to
3686 call the function again when the process finishes. */
3687
3688 p->done = done;
3689
3690 /* If the process hadn't finished, and we haven't seen the end of the data
3691 or if we suffered a disaster, update the rest of the state, and return FALSE to
3692 indicate "not finished". */
3693
3694 if (!eop && !done)
3695 {
3696 p->addr = addr;
3697 p->msg = msg;
3698 return FALSE;
3699 }
3700
3701 /* Close our end of the pipe, to prevent deadlock if the far end is still
3702 pushing stuff into it. */
3703
3704 (void)close(fd);
3705 p->fd = -1;
3706
3707 /* If we have finished without error, but haven't had data for every address,
3708 something is wrong. */
3709
3710 if (!msg && addr)
3711 msg = string_sprintf("insufficient address data read from pipe "
3712 "for transport process %d for transport %s", pid,
3713 addr->transport->driver_name);
3714
3715 /* If an error message is set, something has gone wrong in getting back
3716 the delivery data. Put the message into each address and freeze it. */
3717
3718 if (msg)
3719 for (addr = addrlist; addr; addr = addr->next)
3720 {
3721 addr->transport_return = DEFER;
3722 addr->special_action = SPECIAL_FREEZE;
3723 addr->message = msg;
3724 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3725 }
3726
3727 /* Return TRUE to indicate we have got all we need from this process, even
3728 if it hasn't actually finished yet. */
3729
3730 return TRUE;
3731 }
3732
3733
3734
3735 /*************************************************
3736 * Post-process a set of remote addresses *
3737 *************************************************/
3738
3739 /* Do what has to be done immediately after a remote delivery for each set of
3740 addresses, then re-write the spool if necessary. Note that post_process_one
3741 puts the address on an appropriate queue; hence we must fish off the next
3742 one first. This function is also called if there is a problem with setting
3743 up a subprocess to do a remote delivery in parallel. In this case, the final
3744 argument contains a message, and the action must be forced to DEFER.
3745
3746 Argument:
3747 addr pointer to chain of address items
3748 logflags flags for logging
3749 msg NULL for normal cases; -> error message for unexpected problems
3750 fallback TRUE if processing fallback hosts
3751
3752 Returns: nothing
3753 */
3754
3755 static void
3756 remote_post_process(address_item *addr, int logflags, uschar *msg,
3757 BOOL fallback)
3758 {
3759 /* If any host addresses were found to be unusable, add them to the unusable
3760 tree so that subsequent deliveries don't try them. */
3761
3762 for (host_item * h = addr->host_list; h; h = h->next)
3763 if (h->address)
3764 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3765
3766 /* Now handle each address on the chain. The transport has placed '=' or '-'
3767 into the special_action field for each successful delivery. */
3768
3769 while (addr)
3770 {
3771 address_item *next = addr->next;
3772
3773 /* If msg == NULL (normal processing) and the result is DEFER and we are
3774 processing the main hosts and there are fallback hosts available, put the
3775 address on the list for fallback delivery. */
3776
3777 if ( addr->transport_return == DEFER
3778 && addr->fallback_hosts
3779 && !fallback
3780 && !msg
3781 )
3782 {
3783 addr->host_list = addr->fallback_hosts;
3784 addr->next = addr_fallback;
3785 addr_fallback = addr;
3786 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3787 }
3788
3789 /* If msg is set (=> unexpected problem), set it in the address before
3790 doing the ordinary post processing. */
3791
3792 else
3793 {
3794 if (msg)
3795 {
3796 addr->message = msg;
3797 addr->transport_return = DEFER;
3798 }
3799 (void)post_process_one(addr, addr->transport_return, logflags,
3800 EXIM_DTYPE_TRANSPORT, addr->special_action);
3801 }
3802
3803 /* Next address */
3804
3805 addr = next;
3806 }
3807
3808 /* If we have just delivered down a passed SMTP channel, and that was
3809 the last address, the channel will have been closed down. Now that
3810 we have logged that delivery, set continue_sequence to 1 so that
3811 any subsequent deliveries don't get "*" incorrectly logged. */
3812
3813 if (!continue_transport) continue_sequence = 1;
3814 }
3815
3816
3817
3818 /*************************************************
3819 * Wait for one remote delivery subprocess *
3820 *************************************************/
3821
3822 /* This function is called while doing remote deliveries when either the
3823 maximum number of processes exist and we need one to complete so that another
3824 can be created, or when waiting for the last ones to complete. It must wait for
3825 the completion of one subprocess, empty the control block slot, and return a
3826 pointer to the address chain.
3827
3828 Arguments: none
3829 Returns: pointer to the chain of addresses handled by the process;
3830 NULL if no subprocess found - this is an unexpected error
3831 */
3832
3833 static address_item *
3834 par_wait(void)
3835 {
3836 int poffset, status;
3837 address_item *addr, *addrlist;
3838 pid_t pid;
3839
3840 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3841 "to finish", message_id);
3842
3843 /* Loop until either a subprocess completes, or there are no subprocesses in
3844 existence - in which case give an error return. We cannot proceed just by
3845 waiting for a completion, because a subprocess may have filled up its pipe, and
3846 be waiting for it to be emptied. Therefore, if no processes have finished, we
3847 wait for one of the pipes to acquire some data by calling select(), with a
3848 timeout just in case.
3849
3850 The simple approach is just to iterate after reading data from a ready pipe.
3851 This leads to non-ideal behaviour when the subprocess has written its final Z
3852 item, closed the pipe, and is in the process of exiting (the common case). A
3853 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3854 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3855 actually finished.
3856
3857 To avoid this, if all the data that is needed has been read from a subprocess
3858 after select(), an explicit wait() for it is done. We know that all it is doing
3859 is writing to the pipe and then exiting, so the wait should not be long.
3860
3861 The non-blocking waitpid() is to some extent just insurance; if we could
3862 reliably detect end-of-file on the pipe, we could always know when to do a
3863 blocking wait() for a completed process. However, because some systems use
3864 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3865 use code that functions without the need to recognize EOF.
3866
3867 There's a double loop here just in case we end up with a process that is not in
3868 the list of remote delivery processes. Something has obviously gone wrong if
3869 this is the case. (For example, a process that is incorrectly left over from
3870 routing or local deliveries might be found.) The damage can be minimized by
3871 looping back and looking for another process. If there aren't any, the error
3872 return will happen. */
3873
3874 for (;;) /* Normally we do not repeat this loop */
3875 {
3876 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3877 {
3878 struct timeval tv;
3879 fd_set select_pipes;
3880 int maxpipe, readycount;
3881
3882 /* A return value of -1 can mean several things. If errno != ECHILD, it
3883 either means invalid options (which we discount), or that this process was
3884 interrupted by a signal. Just loop to try the waitpid() again.
3885
3886 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3887 in existence. This should never happen, and is an unexpected error.
3888 However, there is a nasty complication when running under Linux. If "strace
3889 -f" is being used under Linux to trace this process and its children,
3890 subprocesses are "stolen" from their parents and become the children of the
3891 tracing process. A general wait such as the one we've just obeyed returns
3892 as if there are no children while subprocesses are running. Once a
3893 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3894 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3895 palliative.
3896
3897 This does not happen using "truss" on Solaris, nor (I think) with other
3898 tracing facilities on other OS. It seems to be specific to Linux.
3899
3900 What we do to get round this is to use kill() to see if any of our
3901 subprocesses are still in existence. If kill() gives an OK return, we know
3902 it must be for one of our processes - it can't be for a re-use of the pid,
3903 because if our process had finished, waitpid() would have found it. If any
3904 of our subprocesses are in existence, we proceed to use select() as if
3905 waitpid() had returned zero. I think this is safe. */
3906
3907 if (pid < 0)
3908 {
3909 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3910
3911 DEBUG(D_deliver)
3912 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3913 "for process existence\n");
3914
3915 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3916 {
3917 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3918 {
3919 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3920 "stolen by strace\n", (int)pid);
3921 break; /* With poffset set */
3922 }
3923 }
3924
3925 if (poffset >= remote_max_parallel)
3926 {
3927 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3928 return NULL; /* This is the error return */
3929 }
3930 }
3931
3932 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3933 been handled above. A return value of zero means that there is at least one
3934 subprocess, but there are no completed subprocesses. See if any pipes are
3935 ready with any data for reading. */
3936
3937 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3938
3939 maxpipe = 0;
3940 FD_ZERO(&select_pipes);
3941 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3942 if (parlist[poffset].pid != 0)
3943 {
3944 int fd = parlist[poffset].fd;
3945 FD_SET(fd, &select_pipes);
3946 if (fd > maxpipe) maxpipe = fd;
3947 }
3948
3949 /* Stick in a 60-second timeout, just in case. */
3950
3951 tv.tv_sec = 60;
3952 tv.tv_usec = 0;
3953
3954 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3955 NULL, NULL, &tv);
3956
3957 /* Scan through the pipes and read any that are ready; use the count
3958 returned by select() to stop when there are no more. Select() can return
3959 with no processes (e.g. if interrupted). This shouldn't matter.
3960
3961 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3962 read, or there was a disaster. In either case, we are finished with this
3963 process. Do an explicit wait() for the process and break the main loop if
3964 it succeeds.
3965
3966 It turns out that we have to deal with the case of an interrupted system
3967 call, which can happen on some operating systems if the signal handling is
3968 set up to do that by default. */
3969
3970 for (poffset = 0;
3971 readycount > 0 && poffset < remote_max_parallel;
3972 poffset++)
3973 {
3974 if ( (pid = parlist[poffset].pid) != 0
3975 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3976 )
3977 {
3978 readycount--;
3979 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3980 for (;;) /* Loop for signals */
3981 {
3982 pid_t endedpid = waitpid(pid, &status, 0);
3983 if (endedpid == pid) goto PROCESS_DONE;
3984 if (endedpid != (pid_t)(-1) || errno != EINTR)
3985 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3986 "%d (errno = %d) from waitpid() for process %d",
3987 (int)endedpid, errno, (int)pid);
3988 }
3989 }
3990 }
3991
3992 /* Now go back and look for a completed subprocess again. */
3993 }
3994
3995 /* A completed process was detected by the non-blocking waitpid(). Find the
3996 data block that corresponds to this subprocess. */
3997
3998 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3999 if (pid == parlist[poffset].pid) break;
4000
4001 /* Found the data block; this is a known remote delivery process. We don't
4002 need to repeat the outer loop. This should be what normally happens. */
4003
4004 if (poffset < remote_max_parallel) break;
4005
4006 /* This situation is an error, but it's probably better to carry on looking
4007 for another process than to give up (as we used to do). */
4008
4009 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4010 "transport process list", pid);
4011 } /* End of the "for" loop */
4012
4013 /* Come here when all the data was completely read after a select(), and
4014 the process in pid has been wait()ed for. */
4015
4016 PROCESS_DONE:
4017
4018 DEBUG(D_deliver)
4019 {
4020 if (status == 0)
4021 debug_printf("remote delivery process %d ended\n", (int)pid);
4022 else
4023 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4024 status);
4025 }
4026
4027 set_process_info("delivering %s", message_id);
4028
4029 /* Get the chain of processed addresses */
4030
4031 addrlist = parlist[poffset].addrlist;
4032
4033 /* If the process did not finish cleanly, record an error and freeze (except
4034 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4035 in case the delivery did actually happen. */
4036
4037 if ((status & 0xffff) != 0)
4038 {
4039 uschar *msg;
4040 int msb = (status >> 8) & 255;
4041 int lsb = status & 255;
4042 int code = (msb == 0)? (lsb & 0x7f) : msb;
4043
4044 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4045 "%s %d"