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