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