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