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