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