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