b89671c572188d031d7a2a2101aab39564655956
[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 /******************************************************************************/
1096
1097
1098
1099 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1100 this is a nonstandard call; no two-character delivery flag is written
1101 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1102
1103 Arguments:
1104 flags passed to log_write()
1105 */
1106 void
1107 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
1108 {
1109 gstring * g; /* Used for a temporary, expanding buffer, for building log lines */
1110 rmark reset_point;
1111
1112 /* Log the delivery on the main log. We use an extensible string to build up
1113 the log line, and reset the store afterwards. Remote deliveries should always
1114 have a pointer to the host item that succeeded; local deliveries can have a
1115 pointer to a single host item in their host list, for use by the transport. */
1116
1117 #ifndef DISABLE_EVENT
1118 /* presume no successful remote delivery */
1119 lookup_dnssec_authenticated = NULL;
1120 #endif
1121
1122 reset_point = store_mark();
1123 g = string_get_tainted(256, TRUE); /* addrs will be tainted, so avoid copy */
1124
1125 if (msg)
1126 g = string_append(g, 2, host_and_ident(TRUE), US" ");
1127 else
1128 {
1129 g->s[0] = logchar; g->ptr = 1;
1130 g = string_catn(g, US"> ", 2);
1131 }
1132 g = string_log_address(g, addr, LOGGING(all_parents), TRUE);
1133
1134 if (LOGGING(sender_on_delivery) || msg)
1135 g = string_append(g, 3, US" F=<",
1136 #ifdef SUPPORT_I18N
1137 testflag(addr, af_utf8_downcvt)
1138 ? string_address_utf8_to_alabel(sender_address, NULL)
1139 :
1140 #endif
1141 sender_address,
1142 US">");
1143
1144 if (*queue_name)
1145 g = string_append(g, 2, US" Q=", queue_name);
1146
1147 #ifdef EXPERIMENTAL_SRS
1148 if(addr->prop.srs_sender)
1149 g = string_append(g, 3, US" SRS=<", addr->prop.srs_sender, US">");
1150 #endif
1151
1152 /* You might think that the return path must always be set for a successful
1153 delivery; indeed, I did for some time, until this statement crashed. The case
1154 when it is not set is for a delivery to /dev/null which is optimised by not
1155 being run at all. */
1156
1157 if (used_return_path && LOGGING(return_path_on_delivery))
1158 g = string_append(g, 3, US" P=<", used_return_path, US">");
1159
1160 if (msg)
1161 g = string_append(g, 2, US" ", msg);
1162
1163 /* For a delivery from a system filter, there may not be a router */
1164 if (addr->router)
1165 g = string_append(g, 2, US" R=", addr->router->name);
1166
1167 g = string_append(g, 2, US" T=", addr->transport->name);
1168
1169 if (LOGGING(delivery_size))
1170 g = string_fmt_append(g, " S=%d", transport_count);
1171
1172 /* Local delivery */
1173
1174 if (addr->transport->info->local)
1175 {
1176 if (addr->host_list)
1177 g = string_append(g, 2, US" H=", addr->host_list->name);
1178 g = d_log_interface(g);
1179 if (addr->shadow_message)
1180 g = string_cat(g, addr->shadow_message);
1181 }
1182
1183 /* Remote delivery */
1184
1185 else
1186 {
1187 if (addr->host_used)
1188 {
1189 g = d_hostlog(g, addr);
1190 if (continue_sequence > 1)
1191 g = string_catn(g, US"*", 1);
1192
1193 #ifndef DISABLE_EVENT
1194 deliver_host_address = addr->host_used->address;
1195 deliver_host_port = addr->host_used->port;
1196 deliver_host = addr->host_used->name;
1197
1198 /* DNS lookup status */
1199 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
1200 : addr->host_used->dnssec==DS_NO ? US"no"
1201 : NULL;
1202 #endif
1203 }
1204
1205 #ifndef DISABLE_TLS
1206 g = d_tlslog(g, addr);
1207 #endif
1208
1209 if (addr->authenticator)
1210 {
1211 g = string_append(g, 2, US" A=", addr->authenticator);
1212 if (addr->auth_id)
1213 {
1214 g = string_append(g, 2, US":", addr->auth_id);
1215 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
1216 g = string_append(g, 2, US":", addr->auth_sndr);
1217 }
1218 }
1219
1220 if (LOGGING(pipelining))
1221 {
1222 if (testflag(addr, af_pipelining))
1223 g = string_catn(g, US" L", 2);
1224 #ifndef DISABLE_PIPE_CONNECT
1225 if (testflag(addr, af_early_pipe))
1226 g = string_catn(g, US"*", 1);
1227 #endif
1228 }
1229
1230 #ifndef DISABLE_PRDR
1231 if (testflag(addr, af_prdr_used))
1232 g = string_catn(g, US" PRDR", 5);
1233 #endif
1234
1235 if (testflag(addr, af_chunking_used))
1236 g = string_catn(g, US" K", 2);
1237 }
1238
1239 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1240
1241 if ( LOGGING(smtp_confirmation)
1242 && addr->message
1243 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
1244 )
1245 {
1246 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
1247 uschar *p = big_buffer;
1248 uschar *ss = addr->message;
1249 *p++ = '\"';
1250 for (int i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
1251 {
1252 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
1253 *p++ = ss[i];
1254 }
1255 *p++ = '\"';
1256 *p = 0;
1257 g = string_append(g, 2, US" C=", big_buffer);
1258 }
1259
1260 /* Time on queue and actual time taken to deliver */
1261
1262 if (LOGGING(queue_time))
1263 g = string_append(g, 2, US" QT=",
1264 string_timesince(&received_time));
1265
1266 if (LOGGING(deliver_time))
1267 {
1268 struct timeval diff = {.tv_sec = addr->more_errno, .tv_usec = addr->delivery_usec};
1269 g = string_append(g, 2, US" DT=", string_timediff(&diff));
1270 }
1271
1272 /* string_cat() always leaves room for the terminator. Release the
1273 store we used to build the line after writing it. */
1274
1275 log_write(0, flags, "%s", string_from_gstring(g));
1276
1277 #ifndef DISABLE_EVENT
1278 if (!msg) msg_event_raise(US"msg:delivery", addr);
1279 #endif
1280
1281 store_reset(reset_point);
1282 return;
1283 }
1284
1285
1286
1287 static void
1288 deferral_log(address_item * addr, uschar * now,
1289 int logflags, uschar * driver_name, uschar * driver_kind)
1290 {
1291 rmark reset_point = store_mark();
1292 gstring * g = string_get(256);
1293
1294 /* Build up the line that is used for both the message log and the main
1295 log. */
1296
1297 /* Create the address string for logging. Must not do this earlier, because
1298 an OK result may be changed to FAIL when a pipe returns text. */
1299
1300 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1301
1302 if (*queue_name)
1303 g = string_append(g, 2, US" Q=", queue_name);
1304
1305 /* Either driver_name contains something and driver_kind contains
1306 " router" or " transport" (note the leading space), or driver_name is
1307 a null string and driver_kind contains "routing" without the leading
1308 space, if all routing has been deferred. When a domain has been held,
1309 so nothing has been done at all, both variables contain null strings. */
1310
1311 if (driver_name)
1312 {
1313 if (driver_kind[1] == 't' && addr->router)
1314 g = string_append(g, 2, US" R=", addr->router->name);
1315 g = string_fmt_append(g, " %c=%s", toupper(driver_kind[1]), driver_name);
1316 }
1317 else if (driver_kind)
1318 g = string_append(g, 2, US" ", driver_kind);
1319
1320 g = string_fmt_append(g, " defer (%d)", addr->basic_errno);
1321
1322 if (addr->basic_errno > 0)
1323 g = string_append(g, 2, US": ",
1324 US strerror(addr->basic_errno));
1325
1326 if (addr->host_used)
1327 {
1328 g = string_append(g, 5,
1329 US" H=", addr->host_used->name,
1330 US" [", addr->host_used->address, US"]");
1331 if (LOGGING(outgoing_port))
1332 {
1333 int port = addr->host_used->port;
1334 g = string_fmt_append(g, ":%d", port == PORT_NONE ? 25 : port);
1335 }
1336 }
1337
1338 if (addr->message)
1339 g = string_append(g, 2, US": ", addr->message);
1340
1341 (void) string_from_gstring(g);
1342
1343 /* Log the deferment in the message log, but don't clutter it
1344 up with retry-time defers after the first delivery attempt. */
1345
1346 if (f.deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1347 deliver_msglog("%s %s\n", now, g->s);
1348
1349 /* Write the main log and reset the store.
1350 For errors of the type "retry time not reached" (also remotes skipped
1351 on queue run), logging is controlled by L_retry_defer. Note that this kind
1352 of error number is negative, and all the retry ones are less than any
1353 others. */
1354
1355
1356 log_write(addr->basic_errno <= ERRNO_RETRY_BASE ? L_retry_defer : 0, logflags,
1357 "== %s", g->s);
1358
1359 store_reset(reset_point);
1360 return;
1361 }
1362
1363
1364
1365 static void
1366 failure_log(address_item * addr, uschar * driver_kind, uschar * now)
1367 {
1368 rmark reset_point = store_mark();
1369 gstring * g = string_get(256);
1370
1371 #ifndef DISABLE_EVENT
1372 /* Message failures for which we will send a DSN get their event raised
1373 later so avoid doing it here. */
1374
1375 if ( !addr->prop.ignore_error
1376 && !(addr->dsn_flags & (rf_dsnflags & ~rf_notify_failure))
1377 )
1378 msg_event_raise(US"msg:fail:delivery", addr);
1379 #endif
1380
1381 /* Build up the log line for the message and main logs */
1382
1383 /* Create the address string for logging. Must not do this earlier, because
1384 an OK result may be changed to FAIL when a pipe returns text. */
1385
1386 g = string_log_address(g, addr, LOGGING(all_parents), FALSE);
1387
1388 if (LOGGING(sender_on_delivery))
1389 g = string_append(g, 3, US" F=<", sender_address, US">");
1390
1391 if (*queue_name)
1392 g = string_append(g, 2, US" Q=", queue_name);
1393
1394 /* Return path may not be set if no delivery actually happened */
1395
1396 if (used_return_path && LOGGING(return_path_on_delivery))
1397 g = string_append(g, 3, US" P=<", used_return_path, US">");
1398
1399 if (addr->router)
1400 g = string_append(g, 2, US" R=", addr->router->name);
1401 if (addr->transport)
1402 g = string_append(g, 2, US" T=", addr->transport->name);
1403
1404 if (addr->host_used)
1405 g = d_hostlog(g, addr);
1406
1407 #ifndef DISABLE_TLS
1408 g = d_tlslog(g, addr);
1409 #endif
1410
1411 if (addr->basic_errno > 0)
1412 g = string_append(g, 2, US": ", US strerror(addr->basic_errno));
1413
1414 if (addr->message)
1415 g = string_append(g, 2, US": ", addr->message);
1416
1417 (void) string_from_gstring(g);
1418
1419 /* Do the logging. For the message log, "routing failed" for those cases,
1420 just to make it clearer. */
1421
1422 if (driver_kind)
1423 deliver_msglog("%s %s failed for %s\n", now, driver_kind, g->s);
1424 else
1425 deliver_msglog("%s %s\n", now, g->s);
1426
1427 log_write(0, LOG_MAIN, "** %s", g->s);
1428
1429 store_reset(reset_point);
1430 return;
1431 }
1432
1433
1434
1435 /*************************************************
1436 * Actions at the end of handling an address *
1437 *************************************************/
1438
1439 /* This is a function for processing a single address when all that can be done
1440 with it has been done.
1441
1442 Arguments:
1443 addr points to the address block
1444 result the result of the delivery attempt
1445 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1446 driver_type indicates which type of driver (transport, or router) was last
1447 to process the address
1448 logchar '=' or '-' for use when logging deliveries with => or ->
1449
1450 Returns: nothing
1451 */
1452
1453 static void
1454 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1455 int logchar)
1456 {
1457 uschar *now = tod_stamp(tod_log);
1458 uschar *driver_kind = NULL;
1459 uschar *driver_name = NULL;
1460
1461 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1462
1463 /* Set up driver kind and name for logging. Disable logging if the router or
1464 transport has disabled it. */
1465
1466 if (driver_type == EXIM_DTYPE_TRANSPORT)
1467 {
1468 if (addr->transport)
1469 {
1470 driver_name = addr->transport->name;
1471 driver_kind = US" transport";
1472 f.disable_logging = addr->transport->disable_logging;
1473 }
1474 else driver_kind = US"transporting";
1475 }
1476 else if (driver_type == EXIM_DTYPE_ROUTER)
1477 {
1478 if (addr->router)
1479 {
1480 driver_name = addr->router->name;
1481 driver_kind = US" router";
1482 f.disable_logging = addr->router->disable_logging;
1483 }
1484 else driver_kind = US"routing";
1485 }
1486
1487 /* If there's an error message set, ensure that it contains only printing
1488 characters - it should, but occasionally things slip in and this at least
1489 stops the log format from getting wrecked. We also scan the message for an LDAP
1490 expansion item that has a password setting, and flatten the password. This is a
1491 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1492 malformed, it won't ever have gone near LDAP.) */
1493
1494 if (addr->message)
1495 {
1496 const uschar * s = string_printing(addr->message);
1497
1498 /* deconst cast ok as string_printing known to have alloc'n'copied */
1499 addr->message = expand_hide_passwords(US s);
1500 }
1501
1502 /* If we used a transport that has one of the "return_output" options set, and
1503 if it did in fact generate some output, then for return_output we treat the
1504 message as failed if it was not already set that way, so that the output gets
1505 returned to the sender, provided there is a sender to send it to. For
1506 return_fail_output, do this only if the delivery failed. Otherwise we just
1507 unlink the file, and remove the name so that if the delivery failed, we don't
1508 try to send back an empty or unwanted file. The log_output options operate only
1509 on a non-empty file.
1510
1511 In any case, we close the message file, because we cannot afford to leave a
1512 file-descriptor for one address while processing (maybe very many) others. */
1513
1514 if (addr->return_file >= 0 && addr->return_filename)
1515 {
1516 BOOL return_output = FALSE;
1517 struct stat statbuf;
1518 (void)EXIMfsync(addr->return_file);
1519
1520 /* If there is no output, do nothing. */
1521
1522 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1523 {
1524 transport_instance *tb = addr->transport;
1525
1526 /* Handle logging options */
1527
1528 if ( tb->log_output
1529 || result == FAIL && tb->log_fail_output
1530 || result == DEFER && tb->log_defer_output
1531 )
1532 {
1533 uschar *s;
1534 FILE *f = Ufopen(addr->return_filename, "rb");
1535 if (!f)
1536 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1537 "from %s transport: %s", addr->return_filename, tb->name,
1538 strerror(errno));
1539 else
1540 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1541 {
1542 uschar *p = big_buffer + Ustrlen(big_buffer);
1543 const uschar * sp;
1544 while (p > big_buffer && isspace(p[-1])) p--;
1545 *p = 0;
1546 sp = string_printing(big_buffer);
1547 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1548 addr->address, tb->name, sp);
1549 }
1550 (void)fclose(f);
1551 }
1552
1553 /* Handle returning options, but only if there is an address to return
1554 the text to. */
1555
1556 if (sender_address[0] != 0 || addr->prop.errors_address)
1557 if (tb->return_output)
1558 {
1559 addr->transport_return = result = FAIL;
1560 if (addr->basic_errno == 0 && !addr->message)
1561 addr->message = US"return message generated";
1562 return_output = TRUE;
1563 }
1564 else
1565 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1566 }
1567
1568 /* Get rid of the file unless it might be returned, but close it in
1569 all cases. */
1570
1571 if (!return_output)
1572 {
1573 Uunlink(addr->return_filename);
1574 addr->return_filename = NULL;
1575 addr->return_file = -1;
1576 }
1577
1578 (void)close(addr->return_file);
1579 }
1580
1581 /* The success case happens only after delivery by a transport. */
1582
1583 if (result == OK)
1584 {
1585 addr->next = addr_succeed;
1586 addr_succeed = addr;
1587
1588 /* Call address_done() to ensure that we don't deliver to this address again,
1589 and write appropriate things to the message log. If it is a child address, we
1590 call child_done() to scan the ancestors and mark them complete if this is the
1591 last child to complete. */
1592
1593 address_done(addr, now);
1594 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1595
1596 if (!addr->parent)
1597 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1598 driver_name, driver_kind);
1599 else
1600 {
1601 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1602 addr->parent->address, driver_name, driver_kind);
1603 child_done(addr, now);
1604 }
1605
1606 /* Certificates for logging (via events) */
1607 #ifndef DISABLE_TLS
1608 tls_out.ourcert = addr->ourcert;
1609 addr->ourcert = NULL;
1610 tls_out.peercert = addr->peercert;
1611 addr->peercert = NULL;
1612
1613 tls_out.cipher = addr->cipher;
1614 tls_out.peerdn = addr->peerdn;
1615 tls_out.ocsp = addr->ocsp;
1616 # ifdef SUPPORT_DANE
1617 tls_out.dane_verified = testflag(addr, af_dane_verified);
1618 # endif
1619 #endif
1620
1621 delivery_log(LOG_MAIN, addr, logchar, NULL);
1622
1623 #ifndef DISABLE_TLS
1624 tls_free_cert(&tls_out.ourcert);
1625 tls_free_cert(&tls_out.peercert);
1626 tls_out.cipher = NULL;
1627 tls_out.peerdn = NULL;
1628 tls_out.ocsp = OCSP_NOT_REQ;
1629 # ifdef SUPPORT_DANE
1630 tls_out.dane_verified = FALSE;
1631 # endif
1632 #endif
1633 }
1634
1635
1636 /* Soft failure, or local delivery process failed; freezing may be
1637 requested. */
1638
1639 else if (result == DEFER || result == PANIC)
1640 {
1641 if (result == PANIC) logflags |= LOG_PANIC;
1642
1643 /* This puts them on the chain in reverse order. Do not change this, because
1644 the code for handling retries assumes that the one with the retry
1645 information is last. */
1646
1647 addr->next = addr_defer;
1648 addr_defer = addr;
1649
1650 /* The only currently implemented special action is to freeze the
1651 message. Logging of this is done later, just before the -H file is
1652 updated. */
1653
1654 if (addr->special_action == SPECIAL_FREEZE)
1655 {
1656 f.deliver_freeze = TRUE;
1657 deliver_frozen_at = time(NULL);
1658 update_spool = TRUE;
1659 }
1660
1661 /* If doing a 2-stage queue run, we skip writing to either the message
1662 log or the main log for SMTP defers. */
1663
1664 if (!f.queue_2stage || addr->basic_errno != 0)
1665 deferral_log(addr, now, logflags, driver_name, driver_kind);
1666 }
1667
1668
1669 /* Hard failure. If there is an address to which an error message can be sent,
1670 put this address on the failed list. If not, put it on the deferred list and
1671 freeze the mail message for human attention. The latter action can also be
1672 explicitly requested by a router or transport. */
1673
1674 else
1675 {
1676 /* If this is a delivery error, or a message for which no replies are
1677 wanted, and the message's age is greater than ignore_bounce_errors_after,
1678 force the af_ignore_error flag. This will cause the address to be discarded
1679 later (with a log entry). */
1680
1681 if (!*sender_address && message_age >= ignore_bounce_errors_after)
1682 addr->prop.ignore_error = TRUE;
1683
1684 /* Freeze the message if requested, or if this is a bounce message (or other
1685 message with null sender) and this address does not have its own errors
1686 address. However, don't freeze if errors are being ignored. The actual code
1687 to ignore occurs later, instead of sending a message. Logging of freezing
1688 occurs later, just before writing the -H file. */
1689
1690 if ( !addr->prop.ignore_error
1691 && ( addr->special_action == SPECIAL_FREEZE
1692 || (sender_address[0] == 0 && !addr->prop.errors_address)
1693 ) )
1694 {
1695 frozen_info = addr->special_action == SPECIAL_FREEZE
1696 ? US""
1697 : f.sender_local && !f.local_error_message
1698 ? US" (message created with -f <>)"
1699 : US" (delivery error message)";
1700 f.deliver_freeze = TRUE;
1701 deliver_frozen_at = time(NULL);
1702 update_spool = TRUE;
1703
1704 /* The address is put on the defer rather than the failed queue, because
1705 the message is being retained. */
1706
1707 addr->next = addr_defer;
1708 addr_defer = addr;
1709 }
1710
1711 /* Don't put the address on the nonrecipients tree yet; wait until an
1712 error message has been successfully sent. */
1713
1714 else
1715 {
1716 addr->next = addr_failed;
1717 addr_failed = addr;
1718 }
1719
1720 failure_log(addr, driver_name ? NULL : driver_kind, now);
1721 }
1722
1723 /* Ensure logging is turned on again in all cases */
1724
1725 f.disable_logging = FALSE;
1726 }
1727
1728
1729
1730
1731 /*************************************************
1732 * Address-independent error *
1733 *************************************************/
1734
1735 /* This function is called when there's an error that is not dependent on a
1736 particular address, such as an expansion string failure. It puts the error into
1737 all the addresses in a batch, logs the incident on the main and panic logs, and
1738 clears the expansions. It is mostly called from local_deliver(), but can be
1739 called for a remote delivery via findugid().
1740
1741 Arguments:
1742 logit TRUE if (MAIN+PANIC) logging required
1743 addr the first of the chain of addresses
1744 code the error code
1745 format format string for error message, or NULL if already set in addr
1746 ... arguments for the format
1747
1748 Returns: nothing
1749 */
1750
1751 static void
1752 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1753 {
1754 addr->basic_errno = code;
1755
1756 if (format)
1757 {
1758 va_list ap;
1759 gstring * g;
1760
1761 va_start(ap, format);
1762 g = string_vformat(NULL, SVFMT_EXTEND|SVFMT_REBUFFER, CS format, ap);
1763 va_end(ap);
1764 addr->message = string_from_gstring(g);
1765 }
1766
1767 for (address_item * addr2 = addr->next; addr2; addr2 = addr2->next)
1768 {
1769 addr2->basic_errno = code;
1770 addr2->message = addr->message;
1771 }
1772
1773 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1774 deliver_set_expansions(NULL);
1775 }
1776
1777
1778
1779
1780 /*************************************************
1781 * Check a "never users" list *
1782 *************************************************/
1783
1784 /* This function is called to check whether a uid is on one of the two "never
1785 users" lists.
1786
1787 Arguments:
1788 uid the uid to be checked
1789 nusers the list to be scanned; the first item in the list is the count
1790
1791 Returns: TRUE if the uid is on the list
1792 */
1793
1794 static BOOL
1795 check_never_users(uid_t uid, uid_t *nusers)
1796 {
1797 if (!nusers) return FALSE;
1798 for (int i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1799 return FALSE;
1800 }
1801
1802
1803
1804 /*************************************************
1805 * Find uid and gid for a transport *
1806 *************************************************/
1807
1808 /* This function is called for both local and remote deliveries, to find the
1809 uid/gid under which to run the delivery. The values are taken preferentially
1810 from the transport (either explicit or deliver_as_creator), then from the
1811 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1812 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1813 panic error is logged, and the function fails (which normally leads to delivery
1814 deferral).
1815
1816 Arguments:
1817 addr the address (possibly a chain)
1818 tp the transport
1819 uidp pointer to uid field
1820 gidp pointer to gid field
1821 igfp pointer to the use_initgroups field
1822
1823 Returns: FALSE if failed - error has been set in address(es)
1824 */
1825
1826 static BOOL
1827 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1828 BOOL *igfp)
1829 {
1830 uschar *nuname;
1831 BOOL gid_set = FALSE;
1832
1833 /* Default initgroups flag comes from the transport */
1834
1835 *igfp = tp->initgroups;
1836
1837 /* First see if there's a gid on the transport, either fixed or expandable.
1838 The expanding function always logs failure itself. */
1839
1840 if (tp->gid_set)
1841 {
1842 *gidp = tp->gid;
1843 gid_set = TRUE;
1844 }
1845 else if (tp->expand_gid)
1846 {
1847 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1848 &(addr->message)))
1849 {
1850 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1851 return FALSE;
1852 }
1853 gid_set = TRUE;
1854 }
1855
1856 /* If the transport did not set a group, see if the router did. */
1857
1858 if (!gid_set && testflag(addr, af_gid_set))
1859 {
1860 *gidp = addr->gid;
1861 gid_set = TRUE;
1862 }
1863
1864 /* Pick up a uid from the transport if one is set. */
1865
1866 if (tp->uid_set) *uidp = tp->uid;
1867
1868 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1869 it does not provide a passwd value from which a gid can be taken. */
1870
1871 else if (tp->expand_uid)
1872 {
1873 struct passwd *pw;
1874 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1875 uidp, &(addr->message)))
1876 {
1877 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1878 return FALSE;
1879 }
1880 if (!gid_set && pw)
1881 {
1882 *gidp = pw->pw_gid;
1883 gid_set = TRUE;
1884 }
1885 }
1886
1887 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1888
1889 else if (tp->deliver_as_creator)
1890 {
1891 *uidp = originator_uid;
1892 if (!gid_set)
1893 {
1894 *gidp = originator_gid;
1895 gid_set = TRUE;
1896 }
1897 }
1898
1899 /* Otherwise see if the address specifies the uid and if so, take it and its
1900 initgroups flag. */
1901
1902 else if (testflag(addr, af_uid_set))
1903 {
1904 *uidp = addr->uid;
1905 *igfp = testflag(addr, af_initgroups);
1906 }
1907
1908 /* Nothing has specified the uid - default to the Exim user, and group if the
1909 gid is not set. */
1910
1911 else
1912 {
1913 *uidp = exim_uid;
1914 if (!gid_set)
1915 {
1916 *gidp = exim_gid;
1917 gid_set = TRUE;
1918 }
1919 }
1920
1921 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1922 defaulting to the Exim uid. In other words, if the configuration has specified
1923 a uid, it must also provide a gid. */
1924
1925 if (!gid_set)
1926 {
1927 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1928 "%s transport", tp->name);
1929 return FALSE;
1930 }
1931
1932 /* Check that the uid is not on the lists of banned uids that may not be used
1933 for delivery processes. */
1934
1935 nuname = check_never_users(*uidp, never_users)
1936 ? US"never_users"
1937 : check_never_users(*uidp, fixed_never_users)
1938 ? US"fixed_never_users"
1939 : NULL;
1940 if (nuname)
1941 {
1942 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1943 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1944 return FALSE;
1945 }
1946
1947 /* All is well */
1948
1949 return TRUE;
1950 }
1951
1952
1953
1954
1955 /*************************************************
1956 * Check the size of a message for a transport *
1957 *************************************************/
1958
1959 /* Checks that the message isn't too big for the selected transport.
1960 This is called only when it is known that the limit is set.
1961
1962 Arguments:
1963 tp the transport
1964 addr the (first) address being delivered
1965
1966 Returns: OK
1967 DEFER expansion failed or did not yield an integer
1968 FAIL message too big
1969 */
1970
1971 int
1972 check_message_size(transport_instance *tp, address_item *addr)
1973 {
1974 int rc = OK;
1975 int size_limit;
1976
1977 deliver_set_expansions(addr);
1978 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1979 deliver_set_expansions(NULL);
1980
1981 if (expand_string_message)
1982 {
1983 rc = DEFER;
1984 addr->message = size_limit == -1
1985 ? string_sprintf("failed to expand message_size_limit "
1986 "in %s transport: %s", tp->name, expand_string_message)
1987 : string_sprintf("invalid message_size_limit "
1988 "in %s transport: %s", tp->name, expand_string_message);
1989 }
1990 else if (size_limit > 0 && message_size > size_limit)
1991 {
1992 rc = FAIL;
1993 addr->message =
1994 string_sprintf("message is too big (transport limit = %d)",
1995 size_limit);
1996 }
1997
1998 return rc;
1999 }
2000
2001
2002
2003 /*************************************************
2004 * Transport-time check for a previous delivery *
2005 *************************************************/
2006
2007 /* Check that this base address hasn't previously been delivered to its routed
2008 transport. If it has been delivered, mark it done. The check is necessary at
2009 delivery time in order to handle homonymic addresses correctly in cases where
2010 the pattern of redirection changes between delivery attempts (so the unique
2011 fields change). Non-homonymic previous delivery is detected earlier, at routing
2012 time (which saves unnecessary routing).
2013
2014 Arguments:
2015 addr the address item
2016 testing TRUE if testing wanted only, without side effects
2017
2018 Returns: TRUE if previously delivered by the transport
2019 */
2020
2021 static BOOL
2022 previously_transported(address_item *addr, BOOL testing)
2023 {
2024 uschar * s = string_sprintf("%s/%s",
2025 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
2026
2027 if (tree_search(tree_nonrecipients, s) != 0)
2028 {
2029 DEBUG(D_deliver|D_route|D_transport)
2030 debug_printf("%s was previously delivered (%s transport): discarded\n",
2031 addr->address, addr->transport->name);
2032 if (!testing) child_done(addr, tod_stamp(tod_log));
2033 return TRUE;
2034 }
2035
2036 return FALSE;
2037 }
2038
2039
2040
2041 /******************************************************
2042 * Check for a given header in a header string *
2043 ******************************************************/
2044
2045 /* This function is used when generating quota warnings. The configuration may
2046 specify any header lines it likes in quota_warn_message. If certain of them are
2047 missing, defaults are inserted, so we need to be able to test for the presence
2048 of a given header.
2049
2050 Arguments:
2051 hdr the required header name
2052 hstring the header string
2053
2054 Returns: TRUE the header is in the string
2055 FALSE the header is not in the string
2056 */
2057
2058 static BOOL
2059 contains_header(uschar *hdr, uschar *hstring)
2060 {
2061 int len = Ustrlen(hdr);
2062 uschar *p = hstring;
2063 while (*p != 0)
2064 {
2065 if (strncmpic(p, hdr, len) == 0)
2066 {
2067 p += len;
2068 while (*p == ' ' || *p == '\t') p++;
2069 if (*p == ':') return TRUE;
2070 }
2071 while (*p != 0 && *p != '\n') p++;
2072 if (*p == '\n') p++;
2073 }
2074 return FALSE;
2075 }
2076
2077
2078
2079
2080 /*************************************************
2081 * Perform a local delivery *
2082 *************************************************/
2083
2084 /* Each local delivery is performed in a separate process which sets its
2085 uid and gid as specified. This is a safer way than simply changing and
2086 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2087 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2088 all systems have seteuid().
2089
2090 If the uid/gid are specified in the transport_instance, they are used; the
2091 transport initialization must ensure that either both or neither are set.
2092 Otherwise, the values associated with the address are used. If neither are set,
2093 it is a configuration error.
2094
2095 The transport or the address may specify a home directory (transport over-
2096 rides), and if they do, this is set as $home. If neither have set a working
2097 directory, this value is used for that as well. Otherwise $home is left unset
2098 and the cwd is set to "/" - a directory that should be accessible to all users.
2099
2100 Using a separate process makes it more complicated to get error information
2101 back. We use a pipe to pass the return code and also an error code and error
2102 text string back to the parent process.
2103
2104 Arguments:
2105 addr points to an address block for this delivery; for "normal" local
2106 deliveries this is the only address to be delivered, but for
2107 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2108 a number of addresses can be handled simultaneously, and in this
2109 case addr will point to a chain of addresses with the same
2110 characteristics.
2111
2112 shadowing TRUE if running a shadow transport; this causes output from pipes
2113 to be ignored.
2114
2115 Returns: nothing
2116 */
2117
2118 static void
2119 deliver_local(address_item *addr, BOOL shadowing)
2120 {
2121 BOOL use_initgroups;
2122 uid_t uid;
2123 gid_t gid;
2124 int status, len, rc;
2125 int pfd[2];
2126 pid_t pid;
2127 uschar *working_directory;
2128 address_item *addr2;
2129 transport_instance *tp = addr->transport;
2130
2131 /* Set up the return path from the errors or sender address. If the transport
2132 has its own return path setting, expand it and replace the existing value. */
2133
2134 if(addr->prop.errors_address)
2135 return_path = addr->prop.errors_address;
2136 #ifdef EXPERIMENTAL_SRS
2137 else if (addr->prop.srs_sender)
2138 return_path = addr->prop.srs_sender;
2139 #endif
2140 else
2141 return_path = sender_address;
2142
2143 if (tp->return_path)
2144 {
2145 uschar *new_return_path = expand_string(tp->return_path);
2146 if (!new_return_path)
2147 {
2148 if (!f.expand_string_forcedfail)
2149 {
2150 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
2151 US"Failed to expand return path \"%s\" in %s transport: %s",
2152 tp->return_path, tp->name, expand_string_message);
2153 return;
2154 }
2155 }
2156 else return_path = new_return_path;
2157 }
2158
2159 /* For local deliveries, one at a time, the value used for logging can just be
2160 set directly, once and for all. */
2161
2162 used_return_path = return_path;
2163
2164 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2165 gets put into the address(es), and the expansions are unset, so we can just
2166 return. */
2167
2168 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
2169
2170 /* See if either the transport or the address specifies a home directory. A
2171 home directory set in the address may already be expanded; a flag is set to
2172 indicate that. In other cases we must expand it. */
2173
2174 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
2175 || ( (deliver_home = addr->home_dir) /* Set in address and */
2176 && !testflag(addr, af_home_expanded) /* not expanded */
2177 ) )
2178 {
2179 uschar *rawhome = deliver_home;
2180 deliver_home = NULL; /* in case it contains $home */
2181 if (!(deliver_home = expand_string(rawhome)))
2182 {
2183 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
2184 "to expand for %s transport: %s", rawhome, tp->name,
2185 expand_string_message);
2186 return;
2187 }
2188 if (*deliver_home != '/')
2189 {
2190 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
2191 "is not absolute for %s transport", deliver_home, tp->name);
2192 return;
2193 }
2194 }
2195
2196 /* See if either the transport or the address specifies a current directory,
2197 and if so, expand it. If nothing is set, use the home directory, unless it is
2198 also unset in which case use "/", which is assumed to be a directory to which
2199 all users have access. It is necessary to be in a visible directory for some
2200 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2201 2.5) require this. */
2202
2203 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
2204 if (working_directory)
2205 {
2206 uschar *raw = working_directory;
2207 if (!(working_directory = expand_string(raw)))
2208 {
2209 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
2210 "failed to expand for %s transport: %s", raw, tp->name,
2211 expand_string_message);
2212 return;
2213 }
2214 if (*working_directory != '/')
2215 {
2216 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
2217 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
2218 return;
2219 }
2220 }
2221 else working_directory = deliver_home ? deliver_home : US"/";
2222
2223 /* If one of the return_output flags is set on the transport, create and open a
2224 file in the message log directory for the transport to write its output onto.
2225 This is mainly used by pipe transports. The file needs to be unique to the
2226 address. This feature is not available for shadow transports. */
2227
2228 if ( !shadowing
2229 && ( tp->return_output || tp->return_fail_output
2230 || tp->log_output || tp->log_fail_output || tp->log_defer_output
2231 ) )
2232 {
2233 uschar * error;
2234
2235 addr->return_filename =
2236 spool_fname(US"msglog", message_subdir, message_id,
2237 string_sprintf("-%d-%d", getpid(), return_count++));
2238
2239 if ((addr->return_file = open_msglog_file(addr->return_filename, 0400, &error)) < 0)
2240 {
2241 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
2242 "to return message: %s", error, tp->name, strerror(errno));
2243 return;
2244 }
2245 }
2246
2247 /* Create the pipe for inter-process communication. */
2248
2249 if (pipe(pfd) != 0)
2250 {
2251 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
2252 strerror(errno));
2253 return;
2254 }
2255
2256 /* Now fork the process to do the real work in the subprocess, but first
2257 ensure that all cached resources are freed so that the subprocess starts with
2258 a clean slate and doesn't interfere with the parent process. */
2259
2260 search_tidyup();
2261
2262 if ((pid = fork()) == 0)
2263 {
2264 BOOL replicate = TRUE;
2265
2266 /* Prevent core dumps, as we don't want them in users' home directories.
2267 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2268 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2269 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2270 complain if the error is "not supported".
2271
2272 There are two scenarios where changing the max limit has an effect. In one,
2273 the user is using a .forward and invoking a command of their choice via pipe;
2274 for these, we do need the max limit to be 0 unless the admin chooses to
2275 permit an increased limit. In the other, the command is invoked directly by
2276 the transport and is under administrator control, thus being able to raise
2277 the limit aids in debugging. So there's no general always-right answer.
2278
2279 Thus we inhibit core-dumps completely but let individual transports, while
2280 still root, re-raise the limits back up to aid debugging. We make the
2281 default be no core-dumps -- few enough people can use core dumps in
2282 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2283 */
2284
2285 #ifdef RLIMIT_CORE
2286 struct rlimit rl;
2287 rl.rlim_cur = 0;
2288 rl.rlim_max = 0;
2289 if (setrlimit(RLIMIT_CORE, &rl) < 0)
2290 {
2291 # ifdef SETRLIMIT_NOT_SUPPORTED
2292 if (errno != ENOSYS && errno != ENOTSUP)
2293 # endif
2294 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
2295 strerror(errno));
2296 }
2297 #endif
2298
2299 /* Reset the random number generator, so different processes don't all
2300 have the same sequence. */
2301
2302 random_seed = 0;
2303
2304 /* If the transport has a setup entry, call this first, while still
2305 privileged. (Appendfile uses this to expand quota, for example, while
2306 able to read private files.) */
2307
2308 if (addr->transport->setup)
2309 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2310 &(addr->message)))
2311 {
2312 case DEFER:
2313 addr->transport_return = DEFER;
2314 goto PASS_BACK;
2315
2316 case FAIL:
2317 addr->transport_return = PANIC;
2318 goto PASS_BACK;
2319 }
2320
2321 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2322 when the process becomes unprivileged, it won't be able to write to the
2323 process log. SIGHUP is ignored throughout exim, except when it is being
2324 run as a daemon. */
2325
2326 signal(SIGINT, SIG_IGN);
2327 signal(SIGTERM, SIG_IGN);
2328 signal(SIGUSR1, SIG_IGN);
2329
2330 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2331 half - for transports that exec things (e.g. pipe). Then set the required
2332 gid/uid. */
2333
2334 (void)close(pfd[pipe_read]);
2335 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2336 FD_CLOEXEC);
2337 exim_setugid(uid, gid, use_initgroups,
2338 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2339 addr->address, addr->transport->name));
2340
2341 DEBUG(D_deliver)
2342 {
2343 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2344 for (address_item * batched = addr->next; batched; batched = batched->next)
2345 debug_printf("additional batched address: %s\n", batched->address);
2346 }
2347
2348 /* Set an appropriate working directory. */
2349
2350 if (Uchdir(working_directory) < 0)
2351 {
2352 addr->transport_return = DEFER;
2353 addr->basic_errno = errno;
2354 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2355 }
2356
2357 /* If successful, call the transport */
2358
2359 else
2360 {
2361 BOOL ok = TRUE;
2362 set_process_info("delivering %s to %s using %s", message_id,
2363 addr->local_part, addr->transport->name);
2364
2365 /* Setting this global in the subprocess means we need never clear it */
2366 transport_name = addr->transport->name;
2367
2368 /* If a transport filter has been specified, set up its argument list.
2369 Any errors will get put into the address, and FALSE yielded. */
2370
2371 if (addr->transport->filter_command)
2372 {
2373 ok = transport_set_up_command(&transport_filter_argv,
2374 addr->transport->filter_command,
2375 TRUE, PANIC, addr, US"transport filter", NULL);
2376 transport_filter_timeout = addr->transport->filter_timeout;
2377 }
2378 else transport_filter_argv = NULL;
2379
2380 if (ok)
2381 {
2382 debug_print_string(addr->transport->debug_string);
2383 replicate = !(addr->transport->info->code)(addr->transport, addr);
2384 }
2385 }
2386
2387 /* Pass the results back down the pipe. If necessary, first replicate the
2388 status in the top address to the others in the batch. The label is the
2389 subject of a goto when a call to the transport's setup function fails. We
2390 pass the pointer to the transport back in case it got changed as a result of
2391 file_format in appendfile. */
2392
2393 PASS_BACK:
2394
2395 if (replicate) replicate_status(addr);
2396 for (addr2 = addr; addr2; addr2 = addr2->next)
2397 {
2398 int i;
2399 int local_part_length = Ustrlen(addr2->local_part);
2400 uschar *s;
2401 int ret;
2402
2403 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2404 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2405 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2406 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2407 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2408 || (ret = write(pfd[pipe_write], &addr2->delivery_usec, sizeof(int))) != sizeof(int)
2409 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2410 || (ret = write(pfd[pipe_write], &addr2->transport,
2411 sizeof(transport_instance *))) != sizeof(transport_instance *)
2412
2413 /* For a file delivery, pass back the local part, in case the original
2414 was only part of the final delivery path. This gives more complete
2415 logging. */
2416
2417 || (testflag(addr2, af_file)
2418 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2419 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2420 )
2421 )
2422 )
2423 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2424 ret == -1 ? strerror(errno) : "short write");
2425
2426 /* Now any messages */
2427
2428 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2429 {
2430 int message_length = s ? Ustrlen(s) + 1 : 0;
2431 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2432 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2433 )
2434 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s",
2435 ret == -1 ? strerror(errno) : "short write");
2436 }
2437 }
2438
2439 /* OK, this process is now done. Free any cached resources that it opened,
2440 and close the pipe we were writing down before exiting. */
2441
2442 (void)close(pfd[pipe_write]);
2443 search_tidyup();
2444 exit(EXIT_SUCCESS);
2445 }
2446
2447 /* Back in the main process: panic if the fork did not succeed. This seems
2448 better than returning an error - if forking is failing it is probably best
2449 not to try other deliveries for this message. */
2450
2451 if (pid < 0)
2452 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2453 addr->address);
2454
2455 /* Read the pipe to get the delivery status codes and error messages. Our copy
2456 of the writing end must be closed first, as otherwise read() won't return zero
2457 on an empty pipe. We check that a status exists for each address before
2458 overwriting the address structure. If data is missing, the default DEFER status
2459 will remain. Afterwards, close the reading end. */
2460
2461 (void)close(pfd[pipe_write]);
2462
2463 for (addr2 = addr; addr2; addr2 = addr2->next)
2464 {
2465 if ((len = read(pfd[pipe_read], &status, sizeof(int))) > 0)
2466 {
2467 int i;
2468 uschar **sptr;
2469
2470 addr2->transport_return = status;
2471 len = read(pfd[pipe_read], &transport_count,
2472 sizeof(transport_count));
2473 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2474 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2475 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2476 len = read(pfd[pipe_read], &addr2->delivery_usec, sizeof(int));
2477 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2478 len = read(pfd[pipe_read], &addr2->transport,
2479 sizeof(transport_instance *));
2480
2481 if (testflag(addr2, af_file))
2482 {
2483 int llen;
2484 if ( read(pfd[pipe_read], &llen, sizeof(int)) != sizeof(int)
2485 || llen > 64*4 /* limit from rfc 5821, times I18N factor */
2486 )
2487 {
2488 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part length read"
2489 " from delivery subprocess");
2490 break;
2491 }
2492 /* sanity-checked llen so disable the Coverity error */
2493 /* coverity[tainted_data] */
2494 if (read(pfd[pipe_read], big_buffer, llen) != llen)
2495 {
2496 log_write(0, LOG_MAIN|LOG_PANIC, "bad local_part read"
2497 " from delivery subprocess");
2498 break;
2499 }
2500 big_buffer[llen] = 0;
2501 addr2->local_part = string_copy(big_buffer);
2502 }
2503
2504 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2505 {
2506 int message_length;
2507 len = read(pfd[pipe_read], &message_length, sizeof(int));
2508 if (message_length > 0)
2509 {
2510 len = read(pfd[pipe_read], big_buffer, message_length);
2511 big_buffer[big_buffer_size-1] = '\0'; /* guard byte */
2512 if (len > 0) *sptr = string_copy(big_buffer);
2513 }
2514 }
2515 }
2516
2517 else
2518 {
2519 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2520 "from delivery subprocess", addr2->unique);
2521 break;
2522 }
2523 }
2524
2525 (void)close(pfd[pipe_read]);
2526
2527 /* Unless shadowing, write all successful addresses immediately to the journal
2528 file, to ensure they are recorded asap. For homonymic addresses, use the base
2529 address plus the transport name. Failure to write the journal is panic-worthy,
2530 but don't stop, as it may prove possible subsequently to update the spool file
2531 in order to record the delivery. */
2532
2533 if (!shadowing)
2534 {
2535 for (addr2 = addr; addr2; addr2 = addr2->next)
2536 if (addr2->transport_return == OK)
2537 {
2538 if (testflag(addr2, af_homonym))
2539 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2540 else
2541 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2542
2543 /* In the test harness, wait just a bit to let the subprocess finish off
2544 any debug output etc first. */
2545
2546 testharness_pause_ms(300);
2547
2548 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2549 len = Ustrlen(big_buffer);
2550 if (write(journal_fd, big_buffer, len) != len)
2551 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2552 big_buffer, strerror(errno));
2553 }
2554
2555 /* Ensure the journal file is pushed out to disk. */
2556
2557 if (EXIMfsync(journal_fd) < 0)
2558 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2559 strerror(errno));
2560 }
2561
2562 /* Wait for the process to finish. If it terminates with a non-zero code,
2563 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2564 status values of all the addresses as they are. Take care to handle the case
2565 when the subprocess doesn't seem to exist. This has been seen on one system
2566 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2567 happens, wait() doesn't recognize the termination of child processes. Exim now
2568 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2569
2570 while ((rc = wait(&status)) != pid)
2571 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2572 {
2573 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2574 addr->transport->driver_name);
2575 status = 0;
2576 break;
2577 }
2578
2579 if ((status & 0xffff) != 0)
2580 {
2581 int msb = (status >> 8) & 255;
2582 int lsb = status & 255;
2583 int code = (msb == 0)? (lsb & 0x7f) : msb;
2584 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2585 addr->special_action = SPECIAL_FREEZE;
2586 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2587 "status 0x%04x: %s %d",
2588 addr->transport->driver_name,
2589 status,
2590 msb == 0 ? "terminated by signal" : "exit code",
2591 code);
2592 }
2593
2594 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2595
2596 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2597 {
2598 int fd;
2599 uschar *warn_message;
2600 pid_t pid;
2601
2602 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2603
2604 if (!(warn_message = expand_string(addr->transport->warn_message)))
2605 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2606 "message for %s transport): %s", addr->transport->warn_message,
2607 addr->transport->name, expand_string_message);
2608
2609 else if ((pid = child_open_exim(&fd)) > 0)
2610 {
2611 FILE *f = fdopen(fd, "wb");
2612 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2613 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2614 fprintf(f, "Auto-Submitted: auto-replied\n");
2615 if (!contains_header(US"From", warn_message))
2616 moan_write_from(f);
2617 fprintf(f, "%s", CS warn_message);
2618
2619 /* Close and wait for child process to complete, without a timeout. */
2620
2621 (void)fclose(f);
2622 (void)child_close(pid, 0);
2623 }
2624
2625 addr->special_action = SPECIAL_NONE;
2626 }
2627 }
2628
2629
2630
2631
2632 /* Check transport for the given concurrency limit. Return TRUE if over
2633 the limit (or an expansion failure), else FALSE and if there was a limit,
2634 the key for the hints database used for the concurrency count. */
2635
2636 static BOOL
2637 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2638 {
2639 unsigned max_parallel;
2640
2641 if (!tp->max_parallel) return FALSE;
2642
2643 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2644 if (expand_string_message)
2645 {
2646 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2647 "in %s transport (%s): %s", tp->name, addr->address,
2648 expand_string_message);
2649 return TRUE;
2650 }
2651
2652 if (max_parallel > 0)
2653 {
2654 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2655 if (!enq_start(serialize_key, max_parallel))
2656 {
2657 address_item * next;
2658 DEBUG(D_transport)
2659 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2660 tp->name, max_parallel);
2661 do
2662 {
2663 next = addr->next;
2664 addr->message = US"concurrency limit reached for transport";
2665 addr->basic_errno = ERRNO_TRETRY;
2666 post_process_one(addr, DEFER, LOG_MAIN, EXIM_DTYPE_TRANSPORT, 0);
2667 } while ((addr = next));
2668 return TRUE;
2669 }
2670 *key = serialize_key;
2671 }
2672 return FALSE;
2673 }
2674
2675
2676
2677 /*************************************************
2678 * Do local deliveries *
2679 *************************************************/
2680
2681 /* This function processes the list of addresses in addr_local. True local
2682 deliveries are always done one address at a time. However, local deliveries can
2683 be batched up in some cases. Typically this is when writing batched SMTP output
2684 files for use by some external transport mechanism, or when running local
2685 deliveries over LMTP.
2686
2687 Arguments: None
2688 Returns: Nothing
2689 */
2690
2691 static void
2692 do_local_deliveries(void)
2693 {
2694 open_db dbblock;
2695 open_db *dbm_file = NULL;
2696 time_t now = time(NULL);
2697
2698 /* Loop until we have exhausted the supply of local deliveries */
2699
2700 while (addr_local)
2701 {
2702 struct timeval delivery_start;
2703 struct timeval deliver_time;
2704 address_item *addr2, *addr3, *nextaddr;
2705 int logflags = LOG_MAIN;
2706 int logchar = f.dont_deliver? '*' : '=';
2707 transport_instance *tp;
2708 uschar * serialize_key = NULL;
2709
2710 /* Pick the first undelivered address off the chain */
2711
2712 address_item *addr = addr_local;
2713 addr_local = addr->next;
2714 addr->next = NULL;
2715
2716 DEBUG(D_deliver|D_transport)
2717 debug_printf("--------> %s <--------\n", addr->address);
2718
2719 /* An internal disaster if there is no transport. Should not occur! */
2720
2721 if (!(tp = addr->transport))
2722 {
2723 logflags |= LOG_PANIC;
2724 f.disable_logging = FALSE; /* Jic */
2725 addr->message = addr->router
2726 ? string_sprintf("No transport set by %s router", addr->router->name)
2727 : US"No transport set by system filter";
2728 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2729 continue;
2730 }
2731
2732 /* Check that this base address hasn't previously been delivered to this
2733 transport. The check is necessary at this point to handle homonymic addresses
2734 correctly in cases where the pattern of redirection changes between delivery
2735 attempts. Non-homonymic previous delivery is detected earlier, at routing
2736 time. */
2737
2738 if (previously_transported(addr, FALSE)) continue;
2739
2740 /* There are weird cases where logging is disabled */
2741
2742 f.disable_logging = tp->disable_logging;
2743
2744 /* Check for batched addresses and possible amalgamation. Skip all the work
2745 if either batch_max <= 1 or there aren't any other addresses for local
2746 delivery. */
2747
2748 if (tp->batch_max > 1 && addr_local)
2749 {
2750 int batch_count = 1;
2751 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2752 BOOL uses_lp = ( testflag(addr, af_pfr)
2753 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2754 )
2755 || readconf_depends((driver_instance *)tp, US"local_part");
2756 uschar *batch_id = NULL;
2757 address_item **anchor = &addr_local;
2758 address_item *last = addr;
2759 address_item *next;
2760
2761 /* Expand the batch_id string for comparison with other addresses.
2762 Expansion failure suppresses batching. */
2763
2764 if (tp->batch_id)
2765 {
2766 deliver_set_expansions(addr);
2767 batch_id = expand_string(tp->batch_id);
2768 deliver_set_expansions(NULL);
2769 if (!batch_id)
2770 {
2771 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2772 "in %s transport (%s): %s", tp->name, addr->address,
2773 expand_string_message);
2774 batch_count = tp->batch_max;
2775 }
2776 }
2777
2778 /* Until we reach the batch_max limit, pick off addresses which have the
2779 same characteristics. These are:
2780
2781 same transport
2782 not previously delivered (see comment about 50 lines above)
2783 same local part if the transport's configuration contains $local_part
2784 or if this is a file or pipe delivery from a redirection
2785 same domain if the transport's configuration contains $domain
2786 same errors address
2787 same additional headers
2788 same headers to be removed
2789 same uid/gid for running the transport
2790 same first host if a host list is set
2791 */
2792
2793 while ((next = *anchor) && batch_count < tp->batch_max)
2794 {
2795 BOOL ok =
2796 tp == next->transport
2797 && !previously_transported(next, TRUE)
2798 && testflag(addr, af_pfr) == testflag(next, af_pfr)
2799 && testflag(addr, af_file) == testflag(next, af_file)
2800 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2801 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2802 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2803 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2804 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2805 && same_ugid(tp, addr, next)
2806 && ( !addr->host_list && !next->host_list
2807 || addr->host_list
2808 && next->host_list
2809 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2810 );
2811
2812 /* If the transport has a batch_id setting, batch_id will be non-NULL
2813 from the expansion outside the loop. Expand for this address and compare.
2814 Expansion failure makes this address ineligible for batching. */
2815
2816 if (ok && batch_id)
2817 {
2818 uschar *bid;
2819 address_item *save_nextnext = next->next;
2820 next->next = NULL; /* Expansion for a single address */
2821 deliver_set_expansions(next);
2822 next->next = save_nextnext;
2823 bid = expand_string(tp->batch_id);
2824 deliver_set_expansions(NULL);
2825 if (!bid)
2826 {
2827 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2828 "in %s transport (%s): %s", tp->name, next->address,
2829 expand_string_message);
2830 ok = FALSE;
2831 }
2832 else ok = (Ustrcmp(batch_id, bid) == 0);
2833 }
2834
2835 /* Take address into batch if OK. */
2836
2837 if (ok)
2838 {
2839 *anchor = next->next; /* Include the address */
2840 next->next = NULL;
2841 last->next = next;
2842 last = next;
2843 batch_count++;
2844 }
2845 else anchor = &next->next; /* Skip the address */
2846 }
2847 }
2848
2849 /* We now have one or more addresses that can be delivered in a batch. Check
2850 whether the transport is prepared to accept a message of this size. If not,
2851 fail them all forthwith. If the expansion fails, or does not yield an
2852 integer, defer delivery. */
2853
2854 if (tp->message_size_limit)
2855 {
2856 int rc = check_message_size(tp, addr);
2857 if (rc != OK)
2858 {
2859 replicate_status(addr);
2860 while (addr)
2861 {
2862 addr2 = addr->next;
2863 post_process_one(addr, rc, logflags, EXIM_DTYPE_TRANSPORT, 0);
2864 addr = addr2;
2865 }
2866 continue; /* With next batch of addresses */
2867 }
2868 }
2869
2870 /* If we are not running the queue, or if forcing, all deliveries will be
2871 attempted. Otherwise, we must respect the retry times for each address. Even
2872 when not doing this, we need to set up the retry key string, and determine
2873 whether a retry record exists, because after a successful delivery, a delete
2874 retry item must be set up. Keep the retry database open only for the duration
2875 of these checks, rather than for all local deliveries, because some local
2876 deliveries (e.g. to pipes) can take a substantial time. */
2877
2878 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE, TRUE)))
2879 {
2880 DEBUG(D_deliver|D_retry|D_hints_lookup)
2881 debug_printf("no retry data available\n");
2882 }
2883
2884 addr2 = addr;
2885 addr3 = NULL;
2886 while (addr2)
2887 {
2888 BOOL ok = TRUE; /* to deliver this address */
2889 uschar *retry_key;
2890
2891 /* Set up the retry key to include the domain or not, and change its
2892 leading character from "R" to "T". Must make a copy before doing this,
2893 because the old key may be pointed to from a "delete" retry item after
2894 a routing delay. */
2895
2896 retry_key = string_copy(
2897 tp->retry_use_local_part ? addr2->address_retry_key :
2898 addr2->domain_retry_key);
2899 *retry_key = 'T';
2900
2901 /* Inspect the retry data. If there is no hints file, delivery happens. */
2902
2903 if (dbm_file)
2904 {
2905 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2906
2907 /* If there is no retry record, delivery happens. If there is,
2908 remember it exists so it can be deleted after a successful delivery. */
2909
2910 if (retry_record)
2911 {
2912 setflag(addr2, af_lt_retry_exists);
2913
2914 /* A retry record exists for this address. If queue running and not
2915 forcing, inspect its contents. If the record is too old, or if its
2916 retry time has come, or if it has passed its cutoff time, delivery
2917 will go ahead. */
2918
2919 DEBUG(D_retry)
2920 {
2921 debug_printf("retry record exists: age=%s ",
2922 readconf_printtime(now - retry_record->time_stamp));
2923 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2924 debug_printf(" time to retry = %s expired = %d\n",
2925 readconf_printtime(retry_record->next_try - now),
2926 retry_record->expired);
2927 }
2928
2929 if (f.queue_running && !f.deliver_force)
2930 {
2931 ok = (now - retry_record->time_stamp > retry_data_expire)
2932 || (now >= retry_record->next_try)
2933 || retry_record->expired;
2934
2935 /* If we haven't reached the retry time, there is one more check
2936 to do, which is for the ultimate address timeout. */
2937
2938 if (!ok)
2939 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2940 retry_record, now);
2941 }
2942 }
2943 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2944 }
2945
2946 /* This address is to be delivered. Leave it on the chain. */
2947
2948 if (ok)
2949 {
2950 addr3 = addr2;
2951 addr2 = addr2->next;
2952 }
2953
2954 /* This address is to be deferred. Take it out of the chain, and
2955 post-process it as complete. Must take it out of the chain first,
2956 because post processing puts it on another chain. */
2957
2958 else
2959 {
2960 address_item *this = addr2;
2961 this->message = US"Retry time not yet reached";
2962 this->basic_errno = ERRNO_LRETRY;
2963 addr2 = addr3 ? (addr3->next = addr2->next)
2964 : (addr = addr2->next);
2965 post_process_one(this, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2966 }
2967 }
2968
2969 if (dbm_file) dbfn_close(dbm_file);
2970
2971 /* If there are no addresses left on the chain, they all deferred. Loop
2972 for the next set of addresses. */
2973
2974 if (!addr) continue;
2975
2976 /* If the transport is limited for parallellism, enforce that here.
2977 We use a hints DB entry, incremented here and decremented after
2978 the transport (and any shadow transport) completes. */
2979
2980 if (tpt_parallel_check(tp, addr, &serialize_key))
2981 {
2982 if (expand_string_message)
2983 {
2984 logflags |= LOG_PANIC;
2985 do
2986 {
2987 addr = addr->next;
2988 post_process_one(addr, DEFER, logflags, EXIM_DTYPE_TRANSPORT, 0);
2989 } while ((addr = addr2));
2990 }
2991 continue; /* Loop for the next set of addresses. */
2992 }
2993
2994
2995 /* So, finally, we do have some addresses that can be passed to the
2996 transport. Before doing so, set up variables that are relevant to a
2997 single delivery. */
2998
2999 deliver_set_expansions(addr);
3000
3001 gettimeofday(&delivery_start, NULL);
3002 deliver_local(addr, FALSE);
3003 timesince(&deliver_time, &delivery_start);
3004
3005 /* If a shadow transport (which must perforce be another local transport), is
3006 defined, and its condition is met, we must pass the message to the shadow
3007 too, but only those addresses that succeeded. We do this by making a new
3008 chain of addresses - also to keep the original chain uncontaminated. We must
3009 use a chain rather than doing it one by one, because the shadow transport may
3010 batch.
3011
3012 NOTE: if the condition fails because of a lookup defer, there is nothing we
3013 can do! */
3014
3015 if ( tp->shadow
3016 && ( !tp->shadow_condition
3017 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
3018 ) )
3019 {
3020 transport_instance *stp;
3021 address_item *shadow_addr = NULL;
3022 address_item **last = &shadow_addr;
3023
3024 for (stp = transports; stp; stp = stp->next)
3025 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
3026
3027 if (!stp)
3028 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
3029 tp->shadow);
3030
3031 /* Pick off the addresses that have succeeded, and make clones. Put into
3032 the shadow_message field a pointer to the shadow_message field of the real
3033 address. */
3034
3035 else for (addr2 = addr; addr2; addr2 = addr2->next)
3036 if (addr2->transport_return == OK)
3037 {
3038 addr3 = store_get(sizeof(address_item), FALSE);
3039 *addr3 = *addr2;
3040 addr3->next = NULL;
3041 addr3->shadow_message = US &addr2->shadow_message;
3042 addr3->transport = stp;
3043 addr3->transport_return = DEFER;
3044 addr3->return_filename = NULL;
3045 addr3->return_file = -1;
3046 *last = addr3;
3047 last = &addr3->next;
3048 }
3049
3050 /* If we found any addresses to shadow, run the delivery, and stick any
3051 message back into the shadow_message field in the original. */
3052
3053 if (shadow_addr)
3054 {
3055 int save_count = transport_count;
3056
3057 DEBUG(D_deliver|D_transport)
3058 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3059 deliver_local(shadow_addr, TRUE);
3060
3061 for(; shadow_addr; shadow_addr = shadow_addr->next)
3062 {
3063 int sresult = shadow_addr->transport_return;
3064 *(uschar **)shadow_addr->shadow_message =
3065 sresult == OK
3066 ? string_sprintf(" ST=%s", stp->name)
3067 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
3068 shadow_addr->basic_errno <= 0
3069 ? US""
3070 : US strerror(shadow_addr->basic_errno),
3071 shadow_addr->basic_errno <= 0 || !shadow_addr->message
3072 ? US""
3073 : US": ",
3074 shadow_addr->message
3075 ? shadow_addr->message
3076 : shadow_addr->basic_errno <= 0
3077 ? US"unknown error"
3078 : US"");
3079
3080 DEBUG(D_deliver|D_transport)
3081 debug_printf("%s shadow transport returned %s for %s\n",
3082 stp->name, rc_to_string(sresult), shadow_addr->address);
3083 }
3084
3085 DEBUG(D_deliver|D_transport)
3086 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3087
3088 transport_count = save_count; /* Restore original transport count */
3089 }
3090 }
3091
3092 /* Cancel the expansions that were set up for the delivery. */
3093
3094 deliver_set_expansions(NULL);
3095
3096 /* If the transport was parallelism-limited, decrement the hints DB record. */
3097
3098 if (serialize_key) enq_end(serialize_key);
3099
3100 /* Now we can process the results of the real transport. We must take each
3101 address off the chain first, because post_process_one() puts it on another
3102 chain. */
3103
3104 for (addr2 = addr; addr2; addr2 = nextaddr)
3105 {
3106 int result = addr2->transport_return;
3107 nextaddr = addr2->next;
3108
3109 DEBUG(D_deliver|D_transport)
3110 debug_printf("%s transport returned %s for %s\n",
3111 tp->name, rc_to_string(result), addr2->address);
3112
3113 /* If there is a retry_record, or if delivery is deferred, build a retry
3114 item for setting a new retry time or deleting the old retry record from
3115 the database. These items are handled all together after all addresses
3116 have been handled (so the database is open just for a short time for
3117 updating). */
3118
3119 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
3120 {
3121 int flags = result == DEFER ? 0 : rf_delete;
3122 uschar *retry_key = string_copy(tp->retry_use_local_part
3123 ? addr2->address_retry_key : addr2->domain_retry_key);
3124 *retry_key = 'T';
3125 retry_add_item(addr2, retry_key, flags);
3126 }
3127
3128 /* Done with this address */
3129
3130 if (result == OK)
3131 {
3132 addr2->more_errno = deliver_time.tv_sec;
3133 addr2->delivery_usec = deliver_time.tv_usec;
3134 }
3135 post_process_one(addr2, result, logflags, EXIM_DTYPE_TRANSPORT, logchar);
3136
3137 /* If a pipe delivery generated text to be sent back, the result may be
3138 changed to FAIL, and we must copy this for subsequent addresses in the
3139 batch. */
3140
3141 if (addr2->transport_return != result)
3142 {
3143 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
3144 {
3145 addr3->transport_return = addr2->transport_return;
3146 addr3->basic_errno = addr2->basic_errno;
3147 addr3->message = addr2->message;
3148 }
3149 result = addr2->transport_return;
3150 }
3151
3152 /* Whether or not the result was changed to FAIL, we need to copy the
3153 return_file value from the first address into all the addresses of the
3154 batch, so they are all listed in the error message. */
3155
3156 addr2->return_file = addr->return_file;
3157
3158 /* Change log character for recording successful deliveries. */
3159
3160 if (result == OK) logchar = '-';
3161 }
3162 } /* Loop back for next batch of addresses */
3163 }
3164
3165
3166
3167
3168 /*************************************************
3169 * Sort remote deliveries *
3170 *************************************************/
3171
3172 /* This function is called if remote_sort_domains is set. It arranges that the
3173 chain of addresses for remote deliveries is ordered according to the strings
3174 specified. Try to make this shuffling reasonably efficient by handling
3175 sequences of addresses rather than just single ones.
3176
3177 Arguments: None
3178 Returns: Nothing
3179 */
3180
3181 static void
3182 sort_remote_deliveries(void)
3183 {
3184 int sep = 0;
3185 address_item **aptr = &addr_remote;
3186 const uschar *listptr = remote_sort_domains;
3187 uschar *pattern;
3188 uschar patbuf[256];
3189
3190 while ( *aptr
3191 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
3192 )
3193 {
3194 address_item *moved = NULL;
3195 address_item **bptr = &moved;
3196
3197 while (*aptr)
3198 {
3199 address_item **next;
3200 deliver_domain = (*aptr)->domain; /* set $domain */
3201 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3202 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
3203 {
3204 aptr = &(*aptr)->next;
3205 continue;
3206 }
3207
3208 next = &(*aptr)->next;
3209 while ( *next
3210 && (deliver_domain = (*next)->domain, /* Set $domain */
3211 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
3212 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
3213 )
3214 next = &(*next)->next;
3215
3216 /* If the batch of non-matchers is at the end, add on any that were
3217 extracted further up the chain, and end this iteration. Otherwise,
3218 extract them from the chain and hang on the moved chain. */
3219
3220 if (!*next)
3221 {
3222 *next = moved;
3223 break;
3224 }
3225
3226 *bptr = *aptr;
3227 *aptr = *next;
3228 *next = NULL;
3229 bptr = next;
3230 aptr = &(*aptr)->next;
3231 }
3232
3233 /* If the loop ended because the final address matched, *aptr will
3234 be NULL. Add on to the end any extracted non-matching addresses. If
3235 *aptr is not NULL, the loop ended via "break" when *next is null, that
3236 is, there was a string of non-matching addresses at the end. In this
3237 case the extracted addresses have already been added on the end. */
3238
3239 if (!*aptr) *aptr = moved;
3240 }
3241
3242 DEBUG(D_deliver)
3243 {
3244 debug_printf("remote addresses after sorting:\n");
3245 for (address_item * addr = addr_remote; addr; addr = addr->next)
3246 debug_printf(" %s\n", addr->address);
3247 }
3248 }
3249
3250
3251
3252 /*************************************************
3253 * Read from pipe for remote delivery subprocess *
3254 *************************************************/
3255
3256 /* This function is called when the subprocess is complete, but can also be
3257 called before it is complete, in order to empty a pipe that is full (to prevent
3258 deadlock). It must therefore keep track of its progress in the parlist data
3259 block.
3260
3261 We read the pipe to get the delivery status codes and a possible error message
3262 for each address, optionally preceded by unusability data for the hosts and
3263 also by optional retry data.
3264
3265 Read in large chunks into the big buffer and then scan through, interpreting
3266 the data therein. In most cases, only a single read will be necessary. No
3267 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3268 that we read the next chunk when there is less than 2500 bytes left in the
3269 non-final chunk, we can assume each item is complete in the buffer before
3270 handling it. Each item is written using a single write(), which is atomic for
3271 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3272 often bigger) so even if we are reading while the subprocess is still going, we
3273 should never have only a partial item in the buffer.
3274
3275 hs12: This assumption is not true anymore, since we get quite large items (certificate
3276 information and such).
3277
3278 Argument:
3279 poffset the offset of the parlist item
3280 eop TRUE if the process has completed
3281
3282 Returns: TRUE if the terminating 'Z' item has been read,
3283 or there has been a disaster (i.e. no more data needed);
3284 FALSE otherwise
3285 */
3286
3287 static BOOL
3288 par_read_pipe(int poffset, BOOL eop)
3289 {
3290 host_item *h;
3291 pardata *p = parlist + poffset;
3292 address_item *addrlist = p->addrlist;
3293 address_item *addr = p->addr;
3294 pid_t pid = p->pid;
3295 int fd = p->fd;
3296
3297 uschar *msg = p->msg;
3298 BOOL done = p->done;
3299
3300 /* Loop through all items, reading from the pipe when necessary. The pipe
3301 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3302 here, as the preceding select() tells us, if data is available for reading.
3303
3304 A read() on a "selected" handle should never block, but(!) it may return
3305 less data then we expected. (The buffer size we pass to read() shouldn't be
3306 understood as a "request", but as a "limit".)
3307
3308 Each separate item is written to the pipe in a timely manner. But, especially for
3309 larger items, the read(2) may already return partial data from the write(2).
3310
3311 The write is atomic mostly (depending on the amount written), but atomic does
3312 not imply "all or noting", it just is "not intermixed" with other writes on the
3313 same channel (pipe).
3314
3315 */
3316
3317 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3318 (int)p->pid, eop? "ended" : "not ended yet");
3319
3320 while (!done)
3321 {
3322 retry_item *r, **rp;
3323 uschar pipeheader[PIPE_HEADER_SIZE+1];
3324 uschar *id = &pipeheader[0];
3325 uschar *subid = &pipeheader[1];
3326 uschar *ptr = big_buffer;
3327 size_t required = PIPE_HEADER_SIZE; /* first the pipehaeder, later the data */
3328 ssize_t got;
3329
3330 DEBUG(D_deliver) debug_printf(
3331 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long)required, pid);
3332
3333 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3334 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3335 If we get less, we can assume the subprocess do be done and do not expect any further
3336 information from it. */
3337
3338 if ((got = readn(fd, pipeheader, required)) != required)
3339 {
3340 msg = string_sprintf("got " SSIZE_T_FMT " of %d bytes (pipeheader) "
3341 "from transport process %d for transport %s",
3342 got, PIPE_HEADER_SIZE, pid, addr->transport->driver_name);
3343 done = TRUE;
3344 break;
3345 }
3346
3347 pipeheader[PIPE_HEADER_SIZE] = '\0';
3348 DEBUG(D_deliver)
3349 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3350 (long) got, pid);
3351
3352 {
3353 /* If we can't decode the pipeheader, the subprocess seems to have a
3354 problem, we do not expect any furher information from it. */
3355 char *endc;
3356 required = Ustrtol(pipeheader+2, &endc, 10);
3357 if (*endc)
3358 {
3359 msg = string_sprintf("failed to read pipe "
3360 "from transport process %d for transport %s: error decoding size from header",
3361 pid, addr->transport->driver_name);
3362 done = TRUE;
3363 break;
3364 }
3365 }
3366
3367 DEBUG(D_deliver)
3368 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3369 (u_long)required, pid);
3370
3371 /* Same as above, the transport process will write the bytes announced
3372 in a timely manner, so we can just wait for the bytes, getting less than expected
3373 is considered a problem of the subprocess, we do not expect anything else from it. */
3374 if ((got = readn(fd, big_buffer, required)) != required)
3375 {
3376 msg = string_sprintf("got only " SSIZE_T_FMT " of " SIZE_T_FMT
3377 " bytes (pipedata) from transport process %d for transport %s",
3378 got, required, pid, addr->transport->driver_name);
3379 done = TRUE;
3380 break;
3381 }
3382
3383 /* Handle each possible type of item, assuming the complete item is
3384 available in store. */
3385
3386 switch (*id)
3387 {
3388 /* Host items exist only if any hosts were marked unusable. Match
3389 up by checking the IP address. */
3390
3391 case 'H':
3392 for (h = addrlist->host_list; h; h = h->next)
3393 {
3394 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3395 h->status = ptr[0];
3396 h->why = ptr[1];
3397 }
3398 ptr += 2;
3399 while (*ptr++);
3400 break;
3401
3402 /* Retry items are sent in a preceding R item for each address. This is
3403 kept separate to keep each message short enough to guarantee it won't
3404 be split in the pipe. Hopefully, in the majority of cases, there won't in
3405 fact be any retry items at all.
3406
3407 The complete set of retry items might include an item to delete a
3408 routing retry if there was a previous routing delay. However, routing
3409 retries are also used when a remote transport identifies an address error.
3410 In that case, there may also be an "add" item for the same key. Arrange
3411 that a "delete" item is dropped in favour of an "add" item. */
3412
3413 case 'R':
3414 if (!addr) goto ADDR_MISMATCH;
3415
3416 DEBUG(D_deliver|D_retry)
3417 debug_printf("reading retry information for %s from subprocess\n",
3418 ptr+1);
3419
3420 /* Cut out any "delete" items on the list. */
3421
3422 for (rp = &addr->retries; (r = *rp); rp = &r->next)
3423 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3424 {
3425 if (!(r->flags & rf_delete)) break; /* It was not "delete" */
3426 *rp = r->next; /* Excise a delete item */
3427 DEBUG(D_deliver|D_retry)
3428 debug_printf(" existing delete item dropped\n");
3429 }
3430
3431 /* We want to add a delete item only if there is no non-delete item;
3432 however we still have to step ptr through the data. */
3433
3434 if (!r || !(*ptr & rf_delete))
3435 {
3436 r = store_get(sizeof(retry_item), FALSE);
3437 r->next = addr->retries;
3438 addr->retries = r;
3439 r->flags = *ptr++;
3440 r->key = string_copy(ptr);
3441 while (*ptr++);
3442 memcpy(&r->basic_errno, ptr, sizeof(r->basic_errno));
3443 ptr += sizeof(r->basic_errno);
3444 memcpy(&r->more_errno, ptr, sizeof(r->more_errno));
3445 ptr += sizeof(r->more_errno);
3446 r->message = *ptr ? string_copy(ptr) : NULL;
3447 DEBUG(D_deliver|D_retry) debug_printf(" added %s item\n",
3448 r->flags & rf_delete ? "delete" : "retry");
3449 }
3450
3451 else
3452 {
3453 DEBUG(D_deliver|D_retry)
3454 debug_printf(" delete item not added: non-delete item exists\n");
3455 ptr++;
3456 while(*ptr++);
3457 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3458 }
3459
3460 while(*ptr++);
3461 break;
3462
3463 /* Put the amount of data written into the parlist block */
3464
3465 case 'S':
3466 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3467 ptr += sizeof(transport_count);
3468 break;
3469
3470 /* Address items are in the order of items on the address chain. We
3471 remember the current address value in case this function is called
3472 several times to empty the pipe in stages. Information about delivery
3473 over TLS is sent in a preceding X item for each address. We don't put
3474 it in with the other info, in order to keep each message short enough to
3475 guarantee it won't be split in the pipe. */
3476
3477 #ifndef DISABLE_TLS
3478 case 'X':
3479 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3480 switch (*subid)
3481 {
3482 case '1':
3483 addr->cipher = NULL;
3484 addr->peerdn = NULL;
3485
3486 if (*ptr)
3487 addr->cipher = string_copy(ptr);
3488 while (*ptr++);
3489 if (*ptr)
3490 addr->peerdn = string_copy(ptr);
3491 break;
3492
3493 case '2':
3494 if (*ptr)
3495 (void) tls_import_cert(ptr, &addr->peercert);
3496 else
3497 addr->peercert = NULL;
3498 break;
3499
3500 case '3':
3501 if (*ptr)
3502 (void) tls_import_cert(ptr, &addr->ourcert);
3503 else
3504 addr->ourcert = NULL;
3505 break;
3506
3507 # ifndef DISABLE_OCSP
3508 case '4':
3509 addr->ocsp = *ptr ? *ptr - '0' : OCSP_NOT_REQ;
3510 break;
3511 # endif
3512 }
3513 while (*ptr++);
3514 break;
3515 #endif /*DISABLE_TLS*/
3516
3517 case 'C': /* client authenticator information */
3518 switch (*subid)
3519 {
3520 case '1': addr->authenticator = *ptr ? string_copy(ptr) : NULL; break;
3521 case '2': addr->auth_id = *ptr ? string_copy(ptr) : NULL; break;
3522 case '3': addr->auth_sndr = *ptr ? string_copy(ptr) : NULL; break;
3523 }
3524 while (*ptr++);
3525 break;
3526
3527 #ifndef DISABLE_PRDR
3528 case 'P':
3529 setflag(addr, af_prdr_used);
3530 break;
3531 #endif
3532
3533 case 'L':
3534 switch (*subid)
3535 {
3536 #ifndef DISABLE_PIPE_CONNECT
3537 case 2: setflag(addr, af_early_pipe); /*FALLTHROUGH*/
3538 #endif
3539 case 1: setflag(addr, af_pipelining); break;
3540 }
3541 break;
3542
3543 case 'K':
3544 setflag(addr, af_chunking_used);
3545 break;
3546
3547 case 'T':
3548 setflag(addr, af_tcp_fastopen_conn);
3549 if (*subid > '0') setflag(addr, af_tcp_fastopen);
3550 if (*subid > '1') setflag(addr, af_tcp_fastopen_data);
3551 break;
3552
3553 case 'D':
3554 if (!addr) goto ADDR_MISMATCH;
3555 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3556 ptr += sizeof(addr->dsn_aware);
3557 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3558 break;
3559
3560 case 'A':
3561 if (!addr)
3562 {
3563 ADDR_MISMATCH:
3564 msg = string_sprintf("address count mismatch for data read from pipe "
3565 "for transport process %d for transport %s", pid,
3566 addrlist->transport->driver_name);
3567 done = TRUE;
3568 break;
3569 }
3570
3571 switch (*subid)
3572 {
3573 #ifdef SUPPORT_SOCKS
3574 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3575 proxy_session = TRUE; /*XXX should this be cleared somewhere? */
3576 if (*ptr == 0)
3577 ptr++;
3578 else
3579 {
3580 proxy_local_address = string_copy(ptr);
3581 while(*ptr++);
3582 memcpy(&proxy_local_port, ptr, sizeof(proxy_local_port));
3583 ptr += sizeof(proxy_local_port);
3584 }
3585 break;
3586 #endif
3587
3588 #ifdef EXPERIMENTAL_DSN_INFO
3589 case '1': /* must arrive before A0, and applies to that addr */
3590 /* Two strings: smtp_greeting and helo_response */
3591 addr->smtp_greeting = string_copy(ptr);
3592 while(*ptr++);
3593 addr->helo_response = string_copy(ptr);
3594 while(*ptr++);
3595 break;
3596 #endif
3597
3598 case '0':
3599 DEBUG(D_deliver) debug_printf("A0 %s tret %d\n", addr->address, *ptr);
3600 addr->transport_return = *ptr++;
3601 addr->special_action = *ptr++;
3602 memcpy(&addr->basic_errno, ptr, sizeof(addr->basic_errno));
3603 ptr += sizeof(addr->basic_errno);
3604 memcpy(&addr->more_errno, ptr, sizeof(addr->more_errno));
3605 ptr += sizeof(addr->more_errno);
3606 memcpy(&addr->delivery_usec, ptr, sizeof(addr->delivery_usec));
3607 ptr += sizeof(addr->delivery_usec);
3608 memcpy(&addr->flags, ptr, sizeof(addr->flags));
3609 ptr += sizeof(addr->flags);
3610 addr->message = *ptr ? string_copy(ptr) : NULL;
3611 while(*ptr++);
3612 addr->user_message = *ptr ? string_copy(ptr) : NULL;
3613 while(*ptr++);
3614
3615 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3616
3617 if (*ptr)
3618 {
3619 h = store_get(sizeof(host_item), FALSE);
3620 h->name = string_copy(ptr);
3621 while (*ptr++);
3622 h->address = string_copy(ptr);
3623 while(*ptr++);
3624 memcpy(&h->port, ptr, sizeof(h->port));
3625 ptr += sizeof(h->port);
3626 h->dnssec = *ptr == '2' ? DS_YES
3627 : *ptr == '1' ? DS_NO
3628 : DS_UNK;
3629 ptr++;
3630 addr->host_used = h;
3631 }
3632 else ptr++;
3633
3634 /* Finished with this address */
3635
3636 addr = addr->next;
3637 break;
3638 }
3639 break;
3640
3641 /* Local interface address/port */
3642 case 'I':
3643 if (*ptr) sending_ip_address = string_copy(ptr);
3644 while (*ptr++) ;
3645 if (*ptr) sending_port = atoi(CS ptr);
3646 while (*ptr++) ;
3647 break;
3648
3649 /* Z marks the logical end of the data. It is followed by '0' if
3650 continue_transport was NULL at the end of transporting, otherwise '1'.
3651 We need to know when it becomes NULL during a delivery down a passed SMTP
3652 channel so that we don't try to pass anything more down it. Of course, for
3653 most normal messages it will remain NULL all the time. */
3654
3655 case 'Z':
3656 if (*ptr == '0')
3657 {
3658 continue_transport = NULL;
3659 continue_hostname = NULL;
3660 }
3661 done = TRUE;
3662 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3663 break;
3664
3665 /* Anything else is a disaster. */
3666
3667 default:
3668 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3669 "process %d for transport %s", ptr[-1], pid,
3670 addr->transport->driver_name);
3671 done = TRUE;
3672 break;
3673 }
3674 }
3675
3676 /* The done flag is inspected externally, to determine whether or not to
3677 call the function again when the process finishes. */
3678
3679 p->done = done;
3680
3681 /* If the process hadn't finished, and we haven't seen the end of the data
3682 or if we suffered a disaster, update the rest of the state, and return FALSE to
3683 indicate "not finished". */
3684
3685 if (!eop && !done)
3686 {
3687 p->addr = addr;
3688 p->msg = msg;
3689 return FALSE;
3690 }
3691
3692 /* Close our end of the pipe, to prevent deadlock if the far end is still
3693 pushing stuff into it. */
3694
3695 (void)close(fd);
3696 p->fd = -1;
3697
3698 /* If we have finished without error, but haven't had data for every address,
3699 something is wrong. */
3700
3701 if (!msg && addr)
3702 msg = string_sprintf("insufficient address data read from pipe "
3703 "for transport process %d for transport %s", pid,
3704 addr->transport->driver_name);
3705
3706 /* If an error message is set, something has gone wrong in getting back
3707 the delivery data. Put the message into each address and freeze it. */
3708
3709 if (msg)
3710 for (addr = addrlist; addr; addr = addr->next)
3711 {
3712 addr->transport_return = DEFER;
3713 addr->special_action = SPECIAL_FREEZE;
3714 addr->message = msg;
3715 log_write(0, LOG_MAIN|LOG_PANIC, "Delivery status for %s: %s\n", addr->address, addr->message);
3716 }
3717
3718 /* Return TRUE to indicate we have got all we need from this process, even
3719 if it hasn't actually finished yet. */
3720
3721 return TRUE;
3722 }
3723
3724
3725
3726 /*************************************************
3727 * Post-process a set of remote addresses *
3728 *************************************************/
3729
3730 /* Do what has to be done immediately after a remote delivery for each set of
3731 addresses, then re-write the spool if necessary. Note that post_process_one
3732 puts the address on an appropriate queue; hence we must fish off the next
3733 one first. This function is also called if there is a problem with setting
3734 up a subprocess to do a remote delivery in parallel. In this case, the final
3735 argument contains a message, and the action must be forced to DEFER.
3736
3737 Argument:
3738 addr pointer to chain of address items
3739 logflags flags for logging
3740 msg NULL for normal cases; -> error message for unexpected problems
3741 fallback TRUE if processing fallback hosts
3742
3743 Returns: nothing
3744 */
3745
3746 static void
3747 remote_post_process(address_item *addr, int logflags, uschar *msg,
3748 BOOL fallback)
3749 {
3750 /* If any host addresses were found to be unusable, add them to the unusable
3751 tree so that subsequent deliveries don't try them. */
3752
3753 for (host_item * h = addr->host_list; h; h = h->next)
3754 if (h->address)
3755 if (h->status >= hstatus_unusable) tree_add_unusable(h);
3756
3757 /* Now handle each address on the chain. The transport has placed '=' or '-'
3758 into the special_action field for each successful delivery. */
3759
3760 while (addr)
3761 {
3762 address_item *next = addr->next;
3763
3764 /* If msg == NULL (normal processing) and the result is DEFER and we are
3765 processing the main hosts and there are fallback hosts available, put the
3766 address on the list for fallback delivery. */
3767
3768 if ( addr->transport_return == DEFER
3769 && addr->fallback_hosts
3770 && !fallback
3771 && !msg
3772 )
3773 {
3774 addr->host_list = addr->fallback_hosts;
3775 addr->next = addr_fallback;
3776 addr_fallback = addr;
3777 DEBUG(D_deliver) debug_printf("%s queued for fallback host(s)\n", addr->address);
3778 }
3779
3780 /* If msg is set (=> unexpected problem), set it in the address before
3781 doing the ordinary post processing. */
3782
3783 else
3784 {
3785 if (msg)
3786 {
3787 addr->message = msg;
3788 addr->transport_return = DEFER;
3789 }
3790 (void)post_process_one(addr, addr->transport_return, logflags,
3791 EXIM_DTYPE_TRANSPORT, addr->special_action);
3792 }
3793
3794 /* Next address */
3795
3796 addr = next;
3797 }
3798
3799 /* If we have just delivered down a passed SMTP channel, and that was
3800 the last address, the channel will have been closed down. Now that
3801 we have logged that delivery, set continue_sequence to 1 so that
3802 any subsequent deliveries don't get "*" incorrectly logged. */
3803
3804 if (!continue_transport) continue_sequence = 1;
3805 }
3806
3807
3808
3809 /*************************************************
3810 * Wait for one remote delivery subprocess *
3811 *************************************************/
3812
3813 /* This function is called while doing remote deliveries when either the
3814 maximum number of processes exist and we need one to complete so that another
3815 can be created, or when waiting for the last ones to complete. It must wait for
3816 the completion of one subprocess, empty the control block slot, and return a
3817 pointer to the address chain.
3818
3819 Arguments: none
3820 Returns: pointer to the chain of addresses handled by the process;
3821 NULL if no subprocess found - this is an unexpected error
3822 */
3823
3824 static address_item *
3825 par_wait(void)
3826 {
3827 int poffset, status;
3828 address_item *addr, *addrlist;
3829 pid_t pid;
3830
3831 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3832 "to finish", message_id);
3833
3834 /* Loop until either a subprocess completes, or there are no subprocesses in
3835 existence - in which case give an error return. We cannot proceed just by
3836 waiting for a completion, because a subprocess may have filled up its pipe, and
3837 be waiting for it to be emptied. Therefore, if no processes have finished, we
3838 wait for one of the pipes to acquire some data by calling select(), with a
3839 timeout just in case.
3840
3841 The simple approach is just to iterate after reading data from a ready pipe.
3842 This leads to non-ideal behaviour when the subprocess has written its final Z
3843 item, closed the pipe, and is in the process of exiting (the common case). A
3844 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3845 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3846 actually finished.
3847
3848 To avoid this, if all the data that is needed has been read from a subprocess
3849 after select(), an explicit wait() for it is done. We know that all it is doing
3850 is writing to the pipe and then exiting, so the wait should not be long.
3851
3852 The non-blocking waitpid() is to some extent just insurance; if we could
3853 reliably detect end-of-file on the pipe, we could always know when to do a
3854 blocking wait() for a completed process. However, because some systems use
3855 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3856 use code that functions without the need to recognize EOF.
3857
3858 There's a double loop here just in case we end up with a process that is not in
3859 the list of remote delivery processes. Something has obviously gone wrong if
3860 this is the case. (For example, a process that is incorrectly left over from
3861 routing or local deliveries might be found.) The damage can be minimized by
3862 looping back and looking for another process. If there aren't any, the error
3863 return will happen. */
3864
3865 for (;;) /* Normally we do not repeat this loop */
3866 {
3867 while ((pid = waitpid(-1, &status, WNOHANG)) <= 0)
3868 {
3869 struct timeval tv;
3870 fd_set select_pipes;
3871 int maxpipe, readycount;
3872
3873 /* A return value of -1 can mean several things. If errno != ECHILD, it
3874 either means invalid options (which we discount), or that this process was
3875 interrupted by a signal. Just loop to try the waitpid() again.
3876
3877 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3878 in existence. This should never happen, and is an unexpected error.
3879 However, there is a nasty complication when running under Linux. If "strace
3880 -f" is being used under Linux to trace this process and its children,
3881 subprocesses are "stolen" from their parents and become the children of the
3882 tracing process. A general wait such as the one we've just obeyed returns
3883 as if there are no children while subprocesses are running. Once a
3884 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3885 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3886 palliative.
3887
3888 This does not happen using "truss" on Solaris, nor (I think) with other
3889 tracing facilities on other OS. It seems to be specific to Linux.
3890
3891 What we do to get round this is to use kill() to see if any of our
3892 subprocesses are still in existence. If kill() gives an OK return, we know
3893 it must be for one of our processes - it can't be for a re-use of the pid,
3894 because if our process had finished, waitpid() would have found it. If any
3895 of our subprocesses are in existence, we proceed to use select() as if
3896 waitpid() had returned zero. I think this is safe. */
3897
3898 if (pid < 0)
3899 {
3900 if (errno != ECHILD) continue; /* Repeats the waitpid() */
3901
3902 DEBUG(D_deliver)
3903 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3904 "for process existence\n");
3905
3906 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3907 {
3908 if ((pid = parlist[poffset].pid) != 0 && kill(pid, 0) == 0)
3909 {
3910 DEBUG(D_deliver) debug_printf("process %d still exists: assume "
3911 "stolen by strace\n", (int)pid);
3912 break; /* With poffset set */
3913 }
3914 }
3915
3916 if (poffset >= remote_max_parallel)
3917 {
3918 DEBUG(D_deliver) debug_printf("*** no delivery children found\n");
3919 return NULL; /* This is the error return */
3920 }
3921 }
3922
3923 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3924 been handled above. A return value of zero means that there is at least one
3925 subprocess, but there are no completed subprocesses. See if any pipes are
3926 ready with any data for reading. */
3927
3928 DEBUG(D_deliver) debug_printf("selecting on subprocess pipes\n");
3929
3930 maxpipe = 0;
3931 FD_ZERO(&select_pipes);
3932 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3933 if (parlist[poffset].pid != 0)
3934 {
3935 int fd = parlist[poffset].fd;
3936 FD_SET(fd, &select_pipes);
3937 if (fd > maxpipe) maxpipe = fd;
3938 }
3939
3940 /* Stick in a 60-second timeout, just in case. */
3941
3942 tv.tv_sec = 60;
3943 tv.tv_usec = 0;
3944
3945 readycount = select(maxpipe + 1, (SELECT_ARG2_TYPE *)&select_pipes,
3946 NULL, NULL, &tv);
3947
3948 /* Scan through the pipes and read any that are ready; use the count
3949 returned by select() to stop when there are no more. Select() can return
3950 with no processes (e.g. if interrupted). This shouldn't matter.
3951
3952 If par_read_pipe() returns TRUE, it means that either the terminating Z was
3953 read, or there was a disaster. In either case, we are finished with this
3954 process. Do an explicit wait() for the process and break the main loop if
3955 it succeeds.
3956
3957 It turns out that we have to deal with the case of an interrupted system
3958 call, which can happen on some operating systems if the signal handling is
3959 set up to do that by default. */
3960
3961 for (poffset = 0;
3962 readycount > 0 && poffset < remote_max_parallel;
3963 poffset++)
3964 {
3965 if ( (pid = parlist[poffset].pid) != 0
3966 && FD_ISSET(parlist[poffset].fd, &select_pipes)
3967 )
3968 {
3969 readycount--;
3970 if (par_read_pipe(poffset, FALSE)) /* Finished with this pipe */
3971 for (;;) /* Loop for signals */
3972 {
3973 pid_t endedpid = waitpid(pid, &status, 0);
3974 if (endedpid == pid) goto PROCESS_DONE;
3975 if (endedpid != (pid_t)(-1) || errno != EINTR)
3976 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Unexpected error return "
3977 "%d (errno = %d) from waitpid() for process %d",
3978 (int)endedpid, errno, (int)pid);
3979 }
3980 }
3981 }
3982
3983 /* Now go back and look for a completed subprocess again. */
3984 }
3985
3986 /* A completed process was detected by the non-blocking waitpid(). Find the
3987 data block that corresponds to this subprocess. */
3988
3989 for (poffset = 0; poffset < remote_max_parallel; poffset++)
3990 if (pid == parlist[poffset].pid) break;
3991
3992 /* Found the data block; this is a known remote delivery process. We don't
3993 need to repeat the outer loop. This should be what normally happens. */
3994
3995 if (poffset < remote_max_parallel) break;
3996
3997 /* This situation is an error, but it's probably better to carry on looking
3998 for another process than to give up (as we used to do). */
3999
4000 log_write(0, LOG_MAIN|LOG_PANIC, "Process %d finished: not found in remote "
4001 "transport process list", pid);
4002 } /* End of the "for" loop */
4003
4004 /* Come here when all the data was completely read after a select(), and
4005 the process in pid has been wait()ed for. */
4006
4007 PROCESS_DONE:
4008
4009 DEBUG(D_deliver)
4010 {
4011 if (status == 0)
4012 debug_printf("remote delivery process %d ended\n", (int)pid);
4013 else
4014 debug_printf("remote delivery process %d ended: status=%04x\n", (int)pid,
4015 status);
4016 }
4017
4018 set_process_info("delivering %s", message_id);
4019
4020 /* Get the chain of processed addresses */
4021
4022 addrlist = parlist[poffset].addrlist;
4023
4024 /* If the process did not finish cleanly, record an error and freeze (except
4025 for SIGTERM, SIGKILL and SIGQUIT), and also ensure the journal is not removed,
4026 in case the delivery did actually happen. */
4027
4028 if ((status & 0xffff) != 0)
4029 {
4030 uschar *msg;
4031 int msb = (status >> 8) & 255;
4032 int lsb = status & 255;
4033 int code = (msb == 0)? (lsb & 0x7f) : msb;
4034
4035 msg = string_sprintf("%s transport process returned non-zero status 0x%04x: "
4036 "%s %d",
4037 addrlist->transport->driver_name,
4038 status,
4039 (msb == 0)? "terminated by signal" : "exit code",
4040 code);
4041
4042 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
4043 addrlist->special_action = SPECIAL_FREEZE;
4044
4045 for (addr = addrlist; addr; addr = addr->next)
4046 {
4047 addr->transport_return = DEFER;
4048 addr->message = msg;
4049