Pipe transport: fix log_defer_output option. Bug 840
[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, "]", 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 return d_log_interface(s, sizep, ptrp);
722 }
723
724
725
726 #ifdef SUPPORT_TLS
727 static uschar *
728 d_tlslog(uschar * s, int * sizep, int * ptrp, address_item * addr)
729 {
730 if (LOGGING(tls_cipher) && addr->cipher)
731 s = string_append(s, sizep, ptrp, 2, US" X=", addr->cipher);
732 if (LOGGING(tls_certificate_verified) && addr->cipher)
733 s = string_append(s, sizep, ptrp, 2, US" CV=",
734 testflag(addr, af_cert_verified)
735 ?
736 #ifdef EXPERIMENTAL_DANE
737 testflag(addr, af_dane_verified)
738 ? "dane"
739 :
740 #endif
741 "yes"
742 : "no");
743 if (LOGGING(tls_peerdn) && addr->peerdn)
744 s = string_append(s, sizep, ptrp, 3, US" DN=\"",
745 string_printing(addr->peerdn), US"\"");
746 return s;
747 }
748 #endif
749
750
751
752
753 #ifdef EXPERIMENTAL_EVENT
754 uschar *
755 event_raise(uschar * action, const uschar * event, uschar * ev_data)
756 {
757 uschar * s;
758 if (action)
759 {
760 DEBUG(D_deliver)
761 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
762 event,
763 action, deliver_host_address);
764
765 event_name = event;
766 event_data = ev_data;
767
768 if (!(s = expand_string(action)) && *expand_string_message)
769 log_write(0, LOG_MAIN|LOG_PANIC,
770 "failed to expand event_action %s in %s: %s\n",
771 event, transport_name, expand_string_message);
772
773 event_name = event_data = NULL;
774
775 /* If the expansion returns anything but an empty string, flag for
776 the caller to modify his normal processing
777 */
778 if (s && *s)
779 {
780 DEBUG(D_deliver)
781 debug_printf("Event(%s): event_action returned \"%s\"\n", event, s);
782 return s;
783 }
784 }
785 return NULL;
786 }
787
788 static void
789 msg_event_raise(const uschar * event, const address_item * addr)
790 {
791 const uschar * save_domain = deliver_domain;
792 uschar * save_local = deliver_localpart;
793 const uschar * save_host = deliver_host;
794
795 if (!addr->transport)
796 return;
797
798 router_name = addr->router ? addr->router->name : NULL;
799 transport_name = addr->transport->name;
800 deliver_domain = addr->domain;
801 deliver_localpart = addr->local_part;
802 deliver_host = addr->host_used ? addr->host_used->name : NULL;
803
804 (void) event_raise(addr->transport->event_action, event,
805 addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0
806 ? addr->message : NULL);
807
808 deliver_host = save_host;
809 deliver_localpart = save_local;
810 deliver_domain = save_domain;
811 router_name = transport_name = NULL;
812 }
813 #endif /*EXPERIMENTAL_EVENT*/
814
815
816
817 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
818 this is a nonstandard call; no two-character delivery flag is written
819 but sender-host and sender are prefixed and "msg" is inserted in the log line.
820
821 Arguments:
822 flags passed to log_write()
823 */
824 void
825 delivery_log(int flags, address_item * addr, int logchar, uschar * msg)
826 {
827 uschar *log_address;
828 int size = 256; /* Used for a temporary, */
829 int ptr = 0; /* expanding buffer, for */
830 uschar *s; /* building log lines; */
831 void *reset_point; /* released afterwards. */
832
833 /* Log the delivery on the main log. We use an extensible string to build up
834 the log line, and reset the store afterwards. Remote deliveries should always
835 have a pointer to the host item that succeeded; local deliveries can have a
836 pointer to a single host item in their host list, for use by the transport. */
837
838 #ifdef EXPERIMENTAL_EVENT
839 /* presume no successful remote delivery */
840 lookup_dnssec_authenticated = NULL;
841 #endif
842
843 s = reset_point = store_get(size);
844
845 log_address = string_log_address(addr, LOGGING(all_parents), TRUE);
846 if (msg)
847 s = string_append(s, &size, &ptr, 3, host_and_ident(TRUE), US" ", log_address);
848 else
849 {
850 s[ptr++] = logchar;
851 s = string_append(s, &size, &ptr, 2, US"> ", log_address);
852 }
853
854 if (LOGGING(sender_on_delivery) || msg)
855 s = string_append(s, &size, &ptr, 3, US" F=<",
856 #ifdef EXPERIMENTAL_INTERNATIONAL
857 testflag(addr, af_utf8_downcvt)
858 ? string_address_utf8_to_alabel(sender_address, NULL)
859 :
860 #endif
861 sender_address,
862 US">");
863
864 #ifdef EXPERIMENTAL_SRS
865 if(addr->prop.srs_sender)
866 s = string_append(s, &size, &ptr, 3, US" SRS=<", addr->prop.srs_sender, US">");
867 #endif
868
869 /* You might think that the return path must always be set for a successful
870 delivery; indeed, I did for some time, until this statement crashed. The case
871 when it is not set is for a delivery to /dev/null which is optimised by not
872 being run at all. */
873
874 if (used_return_path && LOGGING(return_path_on_delivery))
875 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
876
877 if (msg)
878 s = string_append(s, &size, &ptr, 2, US" ", msg);
879
880 /* For a delivery from a system filter, there may not be a router */
881 if (addr->router)
882 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
883
884 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
885
886 if (LOGGING(delivery_size))
887 s = string_append(s, &size, &ptr, 2, US" S=",
888 string_sprintf("%d", transport_count));
889
890 /* Local delivery */
891
892 if (addr->transport->info->local)
893 {
894 if (addr->host_list)
895 s = string_append(s, &size, &ptr, 2, US" H=", addr->host_list->name);
896 s = d_log_interface(s, &size, &ptr);
897 if (addr->shadow_message)
898 s = string_cat(s, &size, &ptr, addr->shadow_message,
899 Ustrlen(addr->shadow_message));
900 }
901
902 /* Remote delivery */
903
904 else
905 {
906 if (addr->host_used)
907 {
908 s = d_hostlog(s, &size, &ptr, addr);
909 if (continue_sequence > 1)
910 s = string_cat(s, &size, &ptr, US"*", 1);
911
912 #ifdef EXPERIMENTAL_EVENT
913 deliver_host_address = addr->host_used->address;
914 deliver_host_port = addr->host_used->port;
915 deliver_host = addr->host_used->name;
916
917 /* DNS lookup status */
918 lookup_dnssec_authenticated = addr->host_used->dnssec==DS_YES ? US"yes"
919 : addr->host_used->dnssec==DS_NO ? US"no"
920 : NULL;
921 #endif
922 }
923
924 #ifdef SUPPORT_TLS
925 s = d_tlslog(s, &size, &ptr, addr);
926 #endif
927
928 if (addr->authenticator)
929 {
930 s = string_append(s, &size, &ptr, 2, US" A=", addr->authenticator);
931 if (addr->auth_id)
932 {
933 s = string_append(s, &size, &ptr, 2, US":", addr->auth_id);
934 if (LOGGING(smtp_mailauth) && addr->auth_sndr)
935 s = string_append(s, &size, &ptr, 2, US":", addr->auth_sndr);
936 }
937 }
938
939 #ifndef DISABLE_PRDR
940 if (addr->flags & af_prdr_used)
941 s = string_append(s, &size, &ptr, 1, US" PRDR");
942 #endif
943 }
944
945 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
946
947 if ( LOGGING(smtp_confirmation)
948 && addr->message
949 && (addr->host_used || Ustrcmp(addr->transport->driver_name, "lmtp") == 0)
950 )
951 {
952 unsigned i;
953 unsigned lim = big_buffer_size < 1024 ? big_buffer_size : 1024;
954 uschar *p = big_buffer;
955 uschar *ss = addr->message;
956 *p++ = '\"';
957 for (i = 0; i < lim && ss[i] != 0; i++) /* limit logged amount */
958 {
959 if (ss[i] == '\"' || ss[i] == '\\') *p++ = '\\'; /* quote \ and " */
960 *p++ = ss[i];
961 }
962 *p++ = '\"';
963 *p = 0;
964 s = string_append(s, &size, &ptr, 2, US" C=", big_buffer);
965 }
966
967 /* Time on queue and actual time taken to deliver */
968
969 if (LOGGING(queue_time))
970 s = string_append(s, &size, &ptr, 2, US" QT=",
971 readconf_printtime( (int) ((long)time(NULL) - (long)received_time)) );
972
973 if (LOGGING(deliver_time))
974 s = string_append(s, &size, &ptr, 2, US" DT=",
975 readconf_printtime(addr->more_errno));
976
977 /* string_cat() always leaves room for the terminator. Release the
978 store we used to build the line after writing it. */
979
980 s[ptr] = 0;
981 log_write(0, flags, "%s", s);
982
983 #ifdef EXPERIMENTAL_EVENT
984 if (!msg) msg_event_raise(US"msg:delivery", addr);
985 #endif
986
987 store_reset(reset_point);
988 return;
989 }
990
991
992
993 /*************************************************
994 * Actions at the end of handling an address *
995 *************************************************/
996
997 /* This is a function for processing a single address when all that can be done
998 with it has been done.
999
1000 Arguments:
1001 addr points to the address block
1002 result the result of the delivery attempt
1003 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1004 driver_type indicates which type of driver (transport, or router) was last
1005 to process the address
1006 logchar '=' or '-' for use when logging deliveries with => or ->
1007
1008 Returns: nothing
1009 */
1010
1011 static void
1012 post_process_one(address_item *addr, int result, int logflags, int driver_type,
1013 int logchar)
1014 {
1015 uschar *now = tod_stamp(tod_log);
1016 uschar *driver_kind = NULL;
1017 uschar *driver_name = NULL;
1018 uschar *log_address;
1019
1020 int size = 256; /* Used for a temporary, */
1021 int ptr = 0; /* expanding buffer, for */
1022 uschar *s; /* building log lines; */
1023 void *reset_point; /* released afterwards. */
1024
1025 DEBUG(D_deliver) debug_printf("post-process %s (%d)\n", addr->address, result);
1026
1027 /* Set up driver kind and name for logging. Disable logging if the router or
1028 transport has disabled it. */
1029
1030 if (driver_type == DTYPE_TRANSPORT)
1031 {
1032 if (addr->transport)
1033 {
1034 driver_name = addr->transport->name;
1035 driver_kind = US" transport";
1036 disable_logging = addr->transport->disable_logging;
1037 }
1038 else driver_kind = US"transporting";
1039 }
1040 else if (driver_type == DTYPE_ROUTER)
1041 {
1042 if (addr->router)
1043 {
1044 driver_name = addr->router->name;
1045 driver_kind = US" router";
1046 disable_logging = addr->router->disable_logging;
1047 }
1048 else driver_kind = US"routing";
1049 }
1050
1051 /* If there's an error message set, ensure that it contains only printing
1052 characters - it should, but occasionally things slip in and this at least
1053 stops the log format from getting wrecked. We also scan the message for an LDAP
1054 expansion item that has a password setting, and flatten the password. This is a
1055 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1056 malformed, it won't ever have gone near LDAP.) */
1057
1058 if (addr->message)
1059 {
1060 const uschar * s = string_printing(addr->message);
1061 if (s != addr->message)
1062 addr->message = US s;
1063 /* deconst cast ok as string_printing known to have alloc'n'copied */
1064 if ( ( Ustrstr(s, "failed to expand") != NULL
1065 || Ustrstr(s, "expansion of ") != NULL
1066 )
1067 && ( Ustrstr(s, "mysql") != NULL
1068 || Ustrstr(s, "pgsql") != NULL
1069 #ifdef EXPERIMENTAL_REDIS
1070 || Ustrstr(s, "redis") != NULL
1071 #endif
1072 || Ustrstr(s, "sqlite") != NULL
1073 || Ustrstr(s, "ldap:") != NULL
1074 || Ustrstr(s, "ldapdn:") != NULL
1075 || Ustrstr(s, "ldapm:") != NULL
1076 ) )
1077 addr->message = string_sprintf("Temporary internal error");
1078 }
1079
1080 /* If we used a transport that has one of the "return_output" options set, and
1081 if it did in fact generate some output, then for return_output we treat the
1082 message as failed if it was not already set that way, so that the output gets
1083 returned to the sender, provided there is a sender to send it to. For
1084 return_fail_output, do this only if the delivery failed. Otherwise we just
1085 unlink the file, and remove the name so that if the delivery failed, we don't
1086 try to send back an empty or unwanted file. The log_output options operate only
1087 on a non-empty file.
1088
1089 In any case, we close the message file, because we cannot afford to leave a
1090 file-descriptor for one address while processing (maybe very many) others. */
1091
1092 if (addr->return_file >= 0 && addr->return_filename)
1093 {
1094 BOOL return_output = FALSE;
1095 struct stat statbuf;
1096 (void)EXIMfsync(addr->return_file);
1097
1098 /* If there is no output, do nothing. */
1099
1100 if (fstat(addr->return_file, &statbuf) == 0 && statbuf.st_size > 0)
1101 {
1102 transport_instance *tb = addr->transport;
1103
1104 /* Handle logging options */
1105
1106 if ( tb->log_output
1107 || result == FAIL && tb->log_fail_output
1108 || result == DEFER && tb->log_defer_output
1109 )
1110 {
1111 uschar *s;
1112 FILE *f = Ufopen(addr->return_filename, "rb");
1113 if (!f)
1114 log_write(0, LOG_MAIN|LOG_PANIC, "failed to open %s to log output "
1115 "from %s transport: %s", addr->return_filename, tb->name,
1116 strerror(errno));
1117 else
1118 if ((s = US Ufgets(big_buffer, big_buffer_size, f)))
1119 {
1120 uschar *p = big_buffer + Ustrlen(big_buffer);
1121 const uschar * sp;
1122 while (p > big_buffer && isspace(p[-1])) p--;
1123 *p = 0;
1124 sp = string_printing(big_buffer);
1125 log_write(0, LOG_MAIN, "<%s>: %s transport output: %s",
1126 addr->address, tb->name, sp);
1127 }
1128 (void)fclose(f);
1129 }
1130
1131 /* Handle returning options, but only if there is an address to return
1132 the text to. */
1133
1134 if (sender_address[0] != 0 || addr->prop.errors_address)
1135 if (tb->return_output)
1136 {
1137 addr->transport_return = result = FAIL;
1138 if (addr->basic_errno == 0 && !addr->message)
1139 addr->message = US"return message generated";
1140 return_output = TRUE;
1141 }
1142 else
1143 if (tb->return_fail_output && result == FAIL) return_output = TRUE;
1144 }
1145
1146 /* Get rid of the file unless it might be returned, but close it in
1147 all cases. */
1148
1149 if (!return_output)
1150 {
1151 Uunlink(addr->return_filename);
1152 addr->return_filename = NULL;
1153 addr->return_file = -1;
1154 }
1155
1156 (void)close(addr->return_file);
1157 }
1158
1159 /* The success case happens only after delivery by a transport. */
1160
1161 if (result == OK)
1162 {
1163 addr->next = addr_succeed;
1164 addr_succeed = addr;
1165
1166 /* Call address_done() to ensure that we don't deliver to this address again,
1167 and write appropriate things to the message log. If it is a child address, we
1168 call child_done() to scan the ancestors and mark them complete if this is the
1169 last child to complete. */
1170
1171 address_done(addr, now);
1172 DEBUG(D_deliver) debug_printf("%s delivered\n", addr->address);
1173
1174 if (!addr->parent)
1175 deliver_msglog("%s %s: %s%s succeeded\n", now, addr->address,
1176 driver_name, driver_kind);
1177 else
1178 {
1179 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now, addr->address,
1180 addr->parent->address, driver_name, driver_kind);
1181 child_done(addr, now);
1182 }
1183
1184 /* Certificates for logging (via events) */
1185 #ifdef SUPPORT_TLS
1186 tls_out.ourcert = addr->ourcert;
1187 addr->ourcert = NULL;
1188 tls_out.peercert = addr->peercert;
1189 addr->peercert = NULL;
1190
1191 tls_out.cipher = addr->cipher;
1192 tls_out.peerdn = addr->peerdn;
1193 tls_out.ocsp = addr->ocsp;
1194 # ifdef EXPERIMENTAL_DANE
1195 tls_out.dane_verified = testflag(addr, af_dane_verified);
1196 # endif
1197 #endif
1198
1199 delivery_log(LOG_MAIN, addr, logchar, NULL);
1200
1201 #ifdef SUPPORT_TLS
1202 tls_free_cert(&tls_out.ourcert);
1203 tls_free_cert(&tls_out.peercert);
1204 tls_out.cipher = NULL;
1205 tls_out.peerdn = NULL;
1206 tls_out.ocsp = OCSP_NOT_REQ;
1207 # ifdef EXPERIMENTAL_DANE
1208 tls_out.dane_verified = FALSE;
1209 # endif
1210 #endif
1211 }
1212
1213
1214 /* Soft failure, or local delivery process failed; freezing may be
1215 requested. */
1216
1217 else if (result == DEFER || result == PANIC)
1218 {
1219 if (result == PANIC) logflags |= LOG_PANIC;
1220
1221 /* This puts them on the chain in reverse order. Do not change this, because
1222 the code for handling retries assumes that the one with the retry
1223 information is last. */
1224
1225 addr->next = addr_defer;
1226 addr_defer = addr;
1227
1228 /* The only currently implemented special action is to freeze the
1229 message. Logging of this is done later, just before the -H file is
1230 updated. */
1231
1232 if (addr->special_action == SPECIAL_FREEZE)
1233 {
1234 deliver_freeze = TRUE;
1235 deliver_frozen_at = time(NULL);
1236 update_spool = TRUE;
1237 }
1238
1239 /* If doing a 2-stage queue run, we skip writing to either the message
1240 log or the main log for SMTP defers. */
1241
1242 if (!queue_2stage || addr->basic_errno != 0)
1243 {
1244 uschar ss[32];
1245
1246 /* For errors of the type "retry time not reached" (also remotes skipped
1247 on queue run), logging is controlled by L_retry_defer. Note that this kind
1248 of error number is negative, and all the retry ones are less than any
1249 others. */
1250
1251 unsigned int use_log_selector = addr->basic_errno <= ERRNO_RETRY_BASE
1252 ? L_retry_defer : 0;
1253
1254 /* Build up the line that is used for both the message log and the main
1255 log. */
1256
1257 s = reset_point = store_get(size);
1258
1259 /* Create the address string for logging. Must not do this earlier, because
1260 an OK result may be changed to FAIL when a pipe returns text. */
1261
1262 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1263
1264 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1265
1266 /* Either driver_name contains something and driver_kind contains
1267 " router" or " transport" (note the leading space), or driver_name is
1268 a null string and driver_kind contains "routing" without the leading
1269 space, if all routing has been deferred. When a domain has been held,
1270 so nothing has been done at all, both variables contain null strings. */
1271
1272 if (driver_name)
1273 {
1274 if (driver_kind[1] == 't' && addr->router)
1275 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1276 Ustrcpy(ss, " ?=");
1277 ss[1] = toupper(driver_kind[1]);
1278 s = string_append(s, &size, &ptr, 2, ss, driver_name);
1279 }
1280 else if (driver_kind)
1281 s = string_append(s, &size, &ptr, 2, US" ", driver_kind);
1282
1283 sprintf(CS ss, " defer (%d)", addr->basic_errno);
1284 s = string_cat(s, &size, &ptr, ss, Ustrlen(ss));
1285
1286 if (addr->basic_errno > 0)
1287 s = string_append(s, &size, &ptr, 2, US": ",
1288 US strerror(addr->basic_errno));
1289
1290 if (addr->host_used)
1291 s = string_append(s, &size, &ptr, 5,
1292 US" H=", addr->host_used->name,
1293 US" [", addr->host_used->address, US"]");
1294
1295 if (addr->message)
1296 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1297
1298 s[ptr] = 0;
1299
1300 /* Log the deferment in the message log, but don't clutter it
1301 up with retry-time defers after the first delivery attempt. */
1302
1303 if (deliver_firsttime || addr->basic_errno > ERRNO_RETRY_BASE)
1304 deliver_msglog("%s %s\n", now, s);
1305
1306 /* Write the main log and reset the store */
1307
1308 log_write(use_log_selector, logflags, "== %s", s);
1309 store_reset(reset_point);
1310 }
1311 }
1312
1313
1314 /* Hard failure. If there is an address to which an error message can be sent,
1315 put this address on the failed list. If not, put it on the deferred list and
1316 freeze the mail message for human attention. The latter action can also be
1317 explicitly requested by a router or transport. */
1318
1319 else
1320 {
1321 /* If this is a delivery error, or a message for which no replies are
1322 wanted, and the message's age is greater than ignore_bounce_errors_after,
1323 force the af_ignore_error flag. This will cause the address to be discarded
1324 later (with a log entry). */
1325
1326 if (sender_address[0] == 0 && message_age >= ignore_bounce_errors_after)
1327 setflag(addr, af_ignore_error);
1328
1329 /* Freeze the message if requested, or if this is a bounce message (or other
1330 message with null sender) and this address does not have its own errors
1331 address. However, don't freeze if errors are being ignored. The actual code
1332 to ignore occurs later, instead of sending a message. Logging of freezing
1333 occurs later, just before writing the -H file. */
1334
1335 if ( !testflag(addr, af_ignore_error)
1336 && ( addr->special_action == SPECIAL_FREEZE
1337 || (sender_address[0] == 0 && !addr->prop.errors_address)
1338 ) )
1339 {
1340 frozen_info = addr->special_action == SPECIAL_FREEZE
1341 ? US""
1342 : sender_local && !local_error_message
1343 ? US" (message created with -f <>)"
1344 : US" (delivery error message)";
1345 deliver_freeze = TRUE;
1346 deliver_frozen_at = time(NULL);
1347 update_spool = TRUE;
1348
1349 /* The address is put on the defer rather than the failed queue, because
1350 the message is being retained. */
1351
1352 addr->next = addr_defer;
1353 addr_defer = addr;
1354 }
1355
1356 /* Don't put the address on the nonrecipients tree yet; wait until an
1357 error message has been successfully sent. */
1358
1359 else
1360 {
1361 addr->next = addr_failed;
1362 addr_failed = addr;
1363 }
1364
1365 /* Build up the log line for the message and main logs */
1366
1367 s = reset_point = store_get(size);
1368
1369 /* Create the address string for logging. Must not do this earlier, because
1370 an OK result may be changed to FAIL when a pipe returns text. */
1371
1372 log_address = string_log_address(addr, LOGGING(all_parents), result == OK);
1373
1374 s = string_cat(s, &size, &ptr, log_address, Ustrlen(log_address));
1375
1376 if (LOGGING(sender_on_delivery))
1377 s = string_append(s, &size, &ptr, 3, US" F=<", sender_address, US">");
1378
1379 /* Return path may not be set if no delivery actually happened */
1380
1381 if (used_return_path && LOGGING(return_path_on_delivery))
1382 s = string_append(s, &size, &ptr, 3, US" P=<", used_return_path, US">");
1383
1384 if (addr->router)
1385 s = string_append(s, &size, &ptr, 2, US" R=", addr->router->name);
1386 if (addr->transport)
1387 s = string_append(s, &size, &ptr, 2, US" T=", addr->transport->name);
1388
1389 if (addr->host_used)
1390 s = d_hostlog(s, &size, &ptr, addr);
1391
1392 #ifdef SUPPORT_TLS
1393 s = d_tlslog(s, &size, &ptr, addr);
1394 #endif
1395
1396 if (addr->basic_errno > 0)
1397 s = string_append(s, &size, &ptr, 2, US": ",
1398 US strerror(addr->basic_errno));
1399
1400 if (addr->message)
1401 s = string_append(s, &size, &ptr, 2, US": ", addr->message);
1402
1403 s[ptr] = 0;
1404
1405 /* Do the logging. For the message log, "routing failed" for those cases,
1406 just to make it clearer. */
1407
1408 if (driver_name)
1409 deliver_msglog("%s %s\n", now, s);
1410 else
1411 deliver_msglog("%s %s failed for %s\n", now, driver_kind, s);
1412
1413 log_write(0, LOG_MAIN, "** %s", s);
1414
1415 #ifdef EXPERIMENTAL_EVENT
1416 msg_event_raise(US"msg:fail:delivery", addr);
1417 #endif
1418
1419 store_reset(reset_point);
1420 }
1421
1422 /* Ensure logging is turned on again in all cases */
1423
1424 disable_logging = FALSE;
1425 }
1426
1427
1428
1429
1430 /*************************************************
1431 * Address-independent error *
1432 *************************************************/
1433
1434 /* This function is called when there's an error that is not dependent on a
1435 particular address, such as an expansion string failure. It puts the error into
1436 all the addresses in a batch, logs the incident on the main and panic logs, and
1437 clears the expansions. It is mostly called from local_deliver(), but can be
1438 called for a remote delivery via findugid().
1439
1440 Arguments:
1441 logit TRUE if (MAIN+PANIC) logging required
1442 addr the first of the chain of addresses
1443 code the error code
1444 format format string for error message, or NULL if already set in addr
1445 ... arguments for the format
1446
1447 Returns: nothing
1448 */
1449
1450 static void
1451 common_error(BOOL logit, address_item *addr, int code, uschar *format, ...)
1452 {
1453 address_item *addr2;
1454 addr->basic_errno = code;
1455
1456 if (format)
1457 {
1458 va_list ap;
1459 uschar buffer[512];
1460 va_start(ap, format);
1461 if (!string_vformat(buffer, sizeof(buffer), CS format, ap))
1462 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1463 "common_error expansion was longer than " SIZE_T_FMT, sizeof(buffer));
1464 va_end(ap);
1465 addr->message = string_copy(buffer);
1466 }
1467
1468 for (addr2 = addr->next; addr2; addr2 = addr2->next)
1469 {
1470 addr2->basic_errno = code;
1471 addr2->message = addr->message;
1472 }
1473
1474 if (logit) log_write(0, LOG_MAIN|LOG_PANIC, "%s", addr->message);
1475 deliver_set_expansions(NULL);
1476 }
1477
1478
1479
1480
1481 /*************************************************
1482 * Check a "never users" list *
1483 *************************************************/
1484
1485 /* This function is called to check whether a uid is on one of the two "never
1486 users" lists.
1487
1488 Arguments:
1489 uid the uid to be checked
1490 nusers the list to be scanned; the first item in the list is the count
1491
1492 Returns: TRUE if the uid is on the list
1493 */
1494
1495 static BOOL
1496 check_never_users(uid_t uid, uid_t *nusers)
1497 {
1498 int i;
1499 if (!nusers) return FALSE;
1500 for (i = 1; i <= (int)(nusers[0]); i++) if (nusers[i] == uid) return TRUE;
1501 return FALSE;
1502 }
1503
1504
1505
1506 /*************************************************
1507 * Find uid and gid for a transport *
1508 *************************************************/
1509
1510 /* This function is called for both local and remote deliveries, to find the
1511 uid/gid under which to run the delivery. The values are taken preferentially
1512 from the transport (either explicit or deliver_as_creator), then from the
1513 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1514 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1515 panic error is logged, and the function fails (which normally leads to delivery
1516 deferral).
1517
1518 Arguments:
1519 addr the address (possibly a chain)
1520 tp the transport
1521 uidp pointer to uid field
1522 gidp pointer to gid field
1523 igfp pointer to the use_initgroups field
1524
1525 Returns: FALSE if failed - error has been set in address(es)
1526 */
1527
1528 static BOOL
1529 findugid(address_item *addr, transport_instance *tp, uid_t *uidp, gid_t *gidp,
1530 BOOL *igfp)
1531 {
1532 uschar *nuname;
1533 BOOL gid_set = FALSE;
1534
1535 /* Default initgroups flag comes from the transport */
1536
1537 *igfp = tp->initgroups;
1538
1539 /* First see if there's a gid on the transport, either fixed or expandable.
1540 The expanding function always logs failure itself. */
1541
1542 if (tp->gid_set)
1543 {
1544 *gidp = tp->gid;
1545 gid_set = TRUE;
1546 }
1547 else if (tp->expand_gid)
1548 {
1549 if (!route_find_expanded_group(tp->expand_gid, tp->name, US"transport", gidp,
1550 &(addr->message)))
1551 {
1552 common_error(FALSE, addr, ERRNO_GIDFAIL, NULL);
1553 return FALSE;
1554 }
1555 gid_set = TRUE;
1556 }
1557
1558 /* If the transport did not set a group, see if the router did. */
1559
1560 if (!gid_set && testflag(addr, af_gid_set))
1561 {
1562 *gidp = addr->gid;
1563 gid_set = TRUE;
1564 }
1565
1566 /* Pick up a uid from the transport if one is set. */
1567
1568 if (tp->uid_set) *uidp = tp->uid;
1569
1570 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1571 it does not provide a passwd value from which a gid can be taken. */
1572
1573 else if (tp->expand_uid)
1574 {
1575 struct passwd *pw;
1576 if (!route_find_expanded_user(tp->expand_uid, tp->name, US"transport", &pw,
1577 uidp, &(addr->message)))
1578 {
1579 common_error(FALSE, addr, ERRNO_UIDFAIL, NULL);
1580 return FALSE;
1581 }
1582 if (!gid_set && pw)
1583 {
1584 *gidp = pw->pw_gid;
1585 gid_set = TRUE;
1586 }
1587 }
1588
1589 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1590
1591 else if (tp->deliver_as_creator)
1592 {
1593 *uidp = originator_uid;
1594 if (!gid_set)
1595 {
1596 *gidp = originator_gid;
1597 gid_set = TRUE;
1598 }
1599 }
1600
1601 /* Otherwise see if the address specifies the uid and if so, take it and its
1602 initgroups flag. */
1603
1604 else if (testflag(addr, af_uid_set))
1605 {
1606 *uidp = addr->uid;
1607 *igfp = testflag(addr, af_initgroups);
1608 }
1609
1610 /* Nothing has specified the uid - default to the Exim user, and group if the
1611 gid is not set. */
1612
1613 else
1614 {
1615 *uidp = exim_uid;
1616 if (!gid_set)
1617 {
1618 *gidp = exim_gid;
1619 gid_set = TRUE;
1620 }
1621 }
1622
1623 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1624 defaulting to the Exim uid. In other words, if the configuration has specified
1625 a uid, it must also provide a gid. */
1626
1627 if (!gid_set)
1628 {
1629 common_error(TRUE, addr, ERRNO_GIDFAIL, US"User set without group for "
1630 "%s transport", tp->name);
1631 return FALSE;
1632 }
1633
1634 /* Check that the uid is not on the lists of banned uids that may not be used
1635 for delivery processes. */
1636
1637 nuname = check_never_users(*uidp, never_users)
1638 ? US"never_users"
1639 : check_never_users(*uidp, fixed_never_users)
1640 ? US"fixed_never_users"
1641 : NULL;
1642 if (nuname)
1643 {
1644 common_error(TRUE, addr, ERRNO_UIDFAIL, US"User %ld set for %s transport "
1645 "is on the %s list", (long int)(*uidp), tp->name, nuname);
1646 return FALSE;
1647 }
1648
1649 /* All is well */
1650
1651 return TRUE;
1652 }
1653
1654
1655
1656
1657 /*************************************************
1658 * Check the size of a message for a transport *
1659 *************************************************/
1660
1661 /* Checks that the message isn't too big for the selected transport.
1662 This is called only when it is known that the limit is set.
1663
1664 Arguments:
1665 tp the transport
1666 addr the (first) address being delivered
1667
1668 Returns: OK
1669 DEFER expansion failed or did not yield an integer
1670 FAIL message too big
1671 */
1672
1673 int
1674 check_message_size(transport_instance *tp, address_item *addr)
1675 {
1676 int rc = OK;
1677 int size_limit;
1678
1679 deliver_set_expansions(addr);
1680 size_limit = expand_string_integer(tp->message_size_limit, TRUE);
1681 deliver_set_expansions(NULL);
1682
1683 if (expand_string_message)
1684 {
1685 rc = DEFER;
1686 addr->message = size_limit == -1
1687 ? string_sprintf("failed to expand message_size_limit "
1688 "in %s transport: %s", tp->name, expand_string_message)
1689 : string_sprintf("invalid message_size_limit "
1690 "in %s transport: %s", tp->name, expand_string_message);
1691 }
1692 else if (size_limit > 0 && message_size > size_limit)
1693 {
1694 rc = FAIL;
1695 addr->message =
1696 string_sprintf("message is too big (transport limit = %d)",
1697 size_limit);
1698 }
1699
1700 return rc;
1701 }
1702
1703
1704
1705 /*************************************************
1706 * Transport-time check for a previous delivery *
1707 *************************************************/
1708
1709 /* Check that this base address hasn't previously been delivered to its routed
1710 transport. If it has been delivered, mark it done. The check is necessary at
1711 delivery time in order to handle homonymic addresses correctly in cases where
1712 the pattern of redirection changes between delivery attempts (so the unique
1713 fields change). Non-homonymic previous delivery is detected earlier, at routing
1714 time (which saves unnecessary routing).
1715
1716 Arguments:
1717 addr the address item
1718 testing TRUE if testing wanted only, without side effects
1719
1720 Returns: TRUE if previously delivered by the transport
1721 */
1722
1723 static BOOL
1724 previously_transported(address_item *addr, BOOL testing)
1725 {
1726 (void)string_format(big_buffer, big_buffer_size, "%s/%s",
1727 addr->unique + (testflag(addr, af_homonym)? 3:0), addr->transport->name);
1728
1729 if (tree_search(tree_nonrecipients, big_buffer) != 0)
1730 {
1731 DEBUG(D_deliver|D_route|D_transport)
1732 debug_printf("%s was previously delivered (%s transport): discarded\n",
1733 addr->address, addr->transport->name);
1734 if (!testing) child_done(addr, tod_stamp(tod_log));
1735 return TRUE;
1736 }
1737
1738 return FALSE;
1739 }
1740
1741
1742
1743 /******************************************************
1744 * Check for a given header in a header string *
1745 ******************************************************/
1746
1747 /* This function is used when generating quota warnings. The configuration may
1748 specify any header lines it likes in quota_warn_message. If certain of them are
1749 missing, defaults are inserted, so we need to be able to test for the presence
1750 of a given header.
1751
1752 Arguments:
1753 hdr the required header name
1754 hstring the header string
1755
1756 Returns: TRUE the header is in the string
1757 FALSE the header is not in the string
1758 */
1759
1760 static BOOL
1761 contains_header(uschar *hdr, uschar *hstring)
1762 {
1763 int len = Ustrlen(hdr);
1764 uschar *p = hstring;
1765 while (*p != 0)
1766 {
1767 if (strncmpic(p, hdr, len) == 0)
1768 {
1769 p += len;
1770 while (*p == ' ' || *p == '\t') p++;
1771 if (*p == ':') return TRUE;
1772 }
1773 while (*p != 0 && *p != '\n') p++;
1774 if (*p == '\n') p++;
1775 }
1776 return FALSE;
1777 }
1778
1779
1780
1781
1782 /*************************************************
1783 * Perform a local delivery *
1784 *************************************************/
1785
1786 /* Each local delivery is performed in a separate process which sets its
1787 uid and gid as specified. This is a safer way than simply changing and
1788 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
1789 used safely. From release 4, Exim no longer makes any use of it. Besides, not
1790 all systems have seteuid().
1791
1792 If the uid/gid are specified in the transport_instance, they are used; the
1793 transport initialization must ensure that either both or neither are set.
1794 Otherwise, the values associated with the address are used. If neither are set,
1795 it is a configuration error.
1796
1797 The transport or the address may specify a home directory (transport over-
1798 rides), and if they do, this is set as $home. If neither have set a working
1799 directory, this value is used for that as well. Otherwise $home is left unset
1800 and the cwd is set to "/" - a directory that should be accessible to all users.
1801
1802 Using a separate process makes it more complicated to get error information
1803 back. We use a pipe to pass the return code and also an error code and error
1804 text string back to the parent process.
1805
1806 Arguments:
1807 addr points to an address block for this delivery; for "normal" local
1808 deliveries this is the only address to be delivered, but for
1809 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
1810 a number of addresses can be handled simultaneously, and in this
1811 case addr will point to a chain of addresses with the same
1812 characteristics.
1813
1814 shadowing TRUE if running a shadow transport; this causes output from pipes
1815 to be ignored.
1816
1817 Returns: nothing
1818 */
1819
1820 static void
1821 deliver_local(address_item *addr, BOOL shadowing)
1822 {
1823 BOOL use_initgroups;
1824 uid_t uid;
1825 gid_t gid;
1826 int status, len, rc;
1827 int pfd[2];
1828 pid_t pid;
1829 uschar *working_directory;
1830 address_item *addr2;
1831 transport_instance *tp = addr->transport;
1832
1833 /* Set up the return path from the errors or sender address. If the transport
1834 has its own return path setting, expand it and replace the existing value. */
1835
1836 if(addr->prop.errors_address)
1837 return_path = addr->prop.errors_address;
1838 #ifdef EXPERIMENTAL_SRS
1839 else if (addr->prop.srs_sender)
1840 return_path = addr->prop.srs_sender;
1841 #endif
1842 else
1843 return_path = sender_address;
1844
1845 if (tp->return_path)
1846 {
1847 uschar *new_return_path = expand_string(tp->return_path);
1848 if (!new_return_path)
1849 {
1850 if (!expand_string_forcedfail)
1851 {
1852 common_error(TRUE, addr, ERRNO_EXPANDFAIL,
1853 US"Failed to expand return path \"%s\" in %s transport: %s",
1854 tp->return_path, tp->name, expand_string_message);
1855 return;
1856 }
1857 }
1858 else return_path = new_return_path;
1859 }
1860
1861 /* For local deliveries, one at a time, the value used for logging can just be
1862 set directly, once and for all. */
1863
1864 used_return_path = return_path;
1865
1866 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
1867 gets put into the address(es), and the expansions are unset, so we can just
1868 return. */
1869
1870 if (!findugid(addr, tp, &uid, &gid, &use_initgroups)) return;
1871
1872 /* See if either the transport or the address specifies a home directory. A
1873 home directory set in the address may already be expanded; a flag is set to
1874 indicate that. In other cases we must expand it. */
1875
1876 if ( (deliver_home = tp->home_dir) /* Set in transport, or */
1877 || ( (deliver_home = addr->home_dir) /* Set in address and */
1878 && !testflag(addr, af_home_expanded) /* not expanded */
1879 ) )
1880 {
1881 uschar *rawhome = deliver_home;
1882 deliver_home = NULL; /* in case it contains $home */
1883 if (!(deliver_home = expand_string(rawhome)))
1884 {
1885 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"home directory \"%s\" failed "
1886 "to expand for %s transport: %s", rawhome, tp->name,
1887 expand_string_message);
1888 return;
1889 }
1890 if (*deliver_home != '/')
1891 {
1892 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"home directory path \"%s\" "
1893 "is not absolute for %s transport", deliver_home, tp->name);
1894 return;
1895 }
1896 }
1897
1898 /* See if either the transport or the address specifies a current directory,
1899 and if so, expand it. If nothing is set, use the home directory, unless it is
1900 also unset in which case use "/", which is assumed to be a directory to which
1901 all users have access. It is necessary to be in a visible directory for some
1902 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
1903 2.5) require this. */
1904
1905 working_directory = tp->current_dir ? tp->current_dir : addr->current_dir;
1906 if (working_directory)
1907 {
1908 uschar *raw = working_directory;
1909 if (!(working_directory = expand_string(raw)))
1910 {
1911 common_error(TRUE, addr, ERRNO_EXPANDFAIL, US"current directory \"%s\" "
1912 "failed to expand for %s transport: %s", raw, tp->name,
1913 expand_string_message);
1914 return;
1915 }
1916 if (*working_directory != '/')
1917 {
1918 common_error(TRUE, addr, ERRNO_NOTABSOLUTE, US"current directory path "
1919 "\"%s\" is not absolute for %s transport", working_directory, tp->name);
1920 return;
1921 }
1922 }
1923 else working_directory = deliver_home ? deliver_home : US"/";
1924
1925 /* If one of the return_output flags is set on the transport, create and open a
1926 file in the message log directory for the transport to write its output onto.
1927 This is mainly used by pipe transports. The file needs to be unique to the
1928 address. This feature is not available for shadow transports. */
1929
1930 if ( !shadowing
1931 && ( tp->return_output || tp->return_fail_output
1932 || tp->log_output || tp->log_fail_output || tp->log_defer_output
1933 ) )
1934 {
1935 uschar *error;
1936 addr->return_filename =
1937 string_sprintf("%s/msglog/%s/%s-%d-%d", spool_directory, message_subdir,
1938 message_id, getpid(), return_count++);
1939 addr->return_file = open_msglog_file(addr->return_filename, 0400, &error);
1940 if (addr->return_file < 0)
1941 {
1942 common_error(TRUE, addr, errno, US"Unable to %s file for %s transport "
1943 "to return message: %s", error, tp->name, strerror(errno));
1944 return;
1945 }
1946 }
1947
1948 /* Create the pipe for inter-process communication. */
1949
1950 if (pipe(pfd) != 0)
1951 {
1952 common_error(TRUE, addr, ERRNO_PIPEFAIL, US"Creation of pipe failed: %s",
1953 strerror(errno));
1954 return;
1955 }
1956
1957 /* Now fork the process to do the real work in the subprocess, but first
1958 ensure that all cached resources are freed so that the subprocess starts with
1959 a clean slate and doesn't interfere with the parent process. */
1960
1961 search_tidyup();
1962
1963 if ((pid = fork()) == 0)
1964 {
1965 BOOL replicate = TRUE;
1966
1967 /* Prevent core dumps, as we don't want them in users' home directories.
1968 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
1969 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
1970 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
1971 complain if the error is "not supported".
1972
1973 There are two scenarios where changing the max limit has an effect. In one,
1974 the user is using a .forward and invoking a command of their choice via pipe;
1975 for these, we do need the max limit to be 0 unless the admin chooses to
1976 permit an increased limit. In the other, the command is invoked directly by
1977 the transport and is under administrator control, thus being able to raise
1978 the limit aids in debugging. So there's no general always-right answer.
1979
1980 Thus we inhibit core-dumps completely but let individual transports, while
1981 still root, re-raise the limits back up to aid debugging. We make the
1982 default be no core-dumps -- few enough people can use core dumps in
1983 diagnosis that it's reasonable to make them something that has to be explicitly requested.
1984 */
1985
1986 #ifdef RLIMIT_CORE
1987 struct rlimit rl;
1988 rl.rlim_cur = 0;
1989 rl.rlim_max = 0;
1990 if (setrlimit(RLIMIT_CORE, &rl) < 0)
1991 {
1992 # ifdef SETRLIMIT_NOT_SUPPORTED
1993 if (errno != ENOSYS && errno != ENOTSUP)
1994 # endif
1995 log_write(0, LOG_MAIN|LOG_PANIC, "setrlimit(RLIMIT_CORE) failed: %s",
1996 strerror(errno));
1997 }
1998 #endif
1999
2000 /* Reset the random number generator, so different processes don't all
2001 have the same sequence. */
2002
2003 random_seed = 0;
2004
2005 /* If the transport has a setup entry, call this first, while still
2006 privileged. (Appendfile uses this to expand quota, for example, while
2007 able to read private files.) */
2008
2009 if (addr->transport->setup)
2010 switch((addr->transport->setup)(addr->transport, addr, NULL, uid, gid,
2011 &(addr->message)))
2012 {
2013 case DEFER:
2014 addr->transport_return = DEFER;
2015 goto PASS_BACK;
2016
2017 case FAIL:
2018 addr->transport_return = PANIC;
2019 goto PASS_BACK;
2020 }
2021
2022 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2023 when the process becomes unprivileged, it won't be able to write to the
2024 process log. SIGHUP is ignored throughout exim, except when it is being
2025 run as a daemon. */
2026
2027 signal(SIGINT, SIG_IGN);
2028 signal(SIGTERM, SIG_IGN);
2029 signal(SIGUSR1, SIG_IGN);
2030
2031 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2032 half - for transports that exec things (e.g. pipe). Then set the required
2033 gid/uid. */
2034
2035 (void)close(pfd[pipe_read]);
2036 (void)fcntl(pfd[pipe_write], F_SETFD, fcntl(pfd[pipe_write], F_GETFD) |
2037 FD_CLOEXEC);
2038 exim_setugid(uid, gid, use_initgroups,
2039 string_sprintf("local delivery to %s <%s> transport=%s", addr->local_part,
2040 addr->address, addr->transport->name));
2041
2042 DEBUG(D_deliver)
2043 {
2044 address_item *batched;
2045 debug_printf(" home=%s current=%s\n", deliver_home, working_directory);
2046 for (batched = addr->next; batched; batched = batched->next)
2047 debug_printf("additional batched address: %s\n", batched->address);
2048 }
2049
2050 /* Set an appropriate working directory. */
2051
2052 if (Uchdir(working_directory) < 0)
2053 {
2054 addr->transport_return = DEFER;
2055 addr->basic_errno = errno;
2056 addr->message = string_sprintf("failed to chdir to %s", working_directory);
2057 }
2058
2059 /* If successful, call the transport */
2060
2061 else
2062 {
2063 BOOL ok = TRUE;
2064 set_process_info("delivering %s to %s using %s", message_id,
2065 addr->local_part, addr->transport->name);
2066
2067 /* Setting this global in the subprocess means we need never clear it */
2068 transport_name = addr->transport->name;
2069
2070 /* If a transport filter has been specified, set up its argument list.
2071 Any errors will get put into the address, and FALSE yielded. */
2072
2073 if (addr->transport->filter_command)
2074 {
2075 ok = transport_set_up_command(&transport_filter_argv,
2076 addr->transport->filter_command,
2077 TRUE, PANIC, addr, US"transport filter", NULL);
2078 transport_filter_timeout = addr->transport->filter_timeout;
2079 }
2080 else transport_filter_argv = NULL;
2081
2082 if (ok)
2083 {
2084 debug_print_string(addr->transport->debug_string);
2085 replicate = !(addr->transport->info->code)(addr->transport, addr);
2086 }
2087 }
2088
2089 /* Pass the results back down the pipe. If necessary, first replicate the
2090 status in the top address to the others in the batch. The label is the
2091 subject of a goto when a call to the transport's setup function fails. We
2092 pass the pointer to the transport back in case it got changed as a result of
2093 file_format in appendfile. */
2094
2095 PASS_BACK:
2096
2097 if (replicate) replicate_status(addr);
2098 for (addr2 = addr; addr2; addr2 = addr2->next)
2099 {
2100 int i;
2101 int local_part_length = Ustrlen(addr2->local_part);
2102 uschar *s;
2103 int ret;
2104
2105 if( (ret = write(pfd[pipe_write], &addr2->transport_return, sizeof(int))) != sizeof(int)
2106 || (ret = write(pfd[pipe_write], &transport_count, sizeof(transport_count))) != sizeof(transport_count)
2107 || (ret = write(pfd[pipe_write], &addr2->flags, sizeof(addr2->flags))) != sizeof(addr2->flags)
2108 || (ret = write(pfd[pipe_write], &addr2->basic_errno, sizeof(int))) != sizeof(int)
2109 || (ret = write(pfd[pipe_write], &addr2->more_errno, sizeof(int))) != sizeof(int)
2110 || (ret = write(pfd[pipe_write], &addr2->special_action, sizeof(int))) != sizeof(int)
2111 || (ret = write(pfd[pipe_write], &addr2->transport,
2112 sizeof(transport_instance *))) != sizeof(transport_instance *)
2113
2114 /* For a file delivery, pass back the local part, in case the original
2115 was only part of the final delivery path. This gives more complete
2116 logging. */
2117
2118 || (testflag(addr2, af_file)
2119 && ( (ret = write(pfd[pipe_write], &local_part_length, sizeof(int))) != sizeof(int)
2120 || (ret = write(pfd[pipe_write], addr2->local_part, local_part_length)) != local_part_length
2121 )
2122 )
2123 )
2124 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2125 ret == -1 ? strerror(errno) : "short write");
2126
2127 /* Now any messages */
2128
2129 for (i = 0, s = addr2->message; i < 2; i++, s = addr2->user_message)
2130 {
2131 int message_length = s ? Ustrlen(s) + 1 : 0;
2132 if( (ret = write(pfd[pipe_write], &message_length, sizeof(int))) != sizeof(int)
2133 || message_length > 0 && (ret = write(pfd[pipe_write], s, message_length)) != message_length
2134 )
2135 log_write(0, LOG_MAIN|LOG_PANIC, "Failed writing transport results to pipe: %s\n",
2136 ret == -1 ? strerror(errno) : "short write");
2137 }
2138 }
2139
2140 /* OK, this process is now done. Free any cached resources that it opened,
2141 and close the pipe we were writing down before exiting. */
2142
2143 (void)close(pfd[pipe_write]);
2144 search_tidyup();
2145 exit(EXIT_SUCCESS);
2146 }
2147
2148 /* Back in the main process: panic if the fork did not succeed. This seems
2149 better than returning an error - if forking is failing it is probably best
2150 not to try other deliveries for this message. */
2151
2152 if (pid < 0)
2153 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Fork failed for local delivery to %s",
2154 addr->address);
2155
2156 /* Read the pipe to get the delivery status codes and error messages. Our copy
2157 of the writing end must be closed first, as otherwise read() won't return zero
2158 on an empty pipe. We check that a status exists for each address before
2159 overwriting the address structure. If data is missing, the default DEFER status
2160 will remain. Afterwards, close the reading end. */
2161
2162 (void)close(pfd[pipe_write]);
2163
2164 for (addr2 = addr; addr2; addr2 = addr2->next)
2165 {
2166 len = read(pfd[pipe_read], &status, sizeof(int));
2167 if (len > 0)
2168 {
2169 int i;
2170 uschar **sptr;
2171
2172 addr2->transport_return = status;
2173 len = read(pfd[pipe_read], &transport_count,
2174 sizeof(transport_count));
2175 len = read(pfd[pipe_read], &addr2->flags, sizeof(addr2->flags));
2176 len = read(pfd[pipe_read], &addr2->basic_errno, sizeof(int));
2177 len = read(pfd[pipe_read], &addr2->more_errno, sizeof(int));
2178 len = read(pfd[pipe_read], &addr2->special_action, sizeof(int));
2179 len = read(pfd[pipe_read], &addr2->transport,
2180 sizeof(transport_instance *));
2181
2182 if (testflag(addr2, af_file))
2183 {
2184 int local_part_length;
2185 len = read(pfd[pipe_read], &local_part_length, sizeof(int));
2186 len = read(pfd[pipe_read], big_buffer, local_part_length);
2187 big_buffer[local_part_length] = 0;
2188 addr2->local_part = string_copy(big_buffer);
2189 }
2190
2191 for (i = 0, sptr = &addr2->message; i < 2; i++, sptr = &addr2->user_message)
2192 {
2193 int message_length;
2194 len = read(pfd[pipe_read], &message_length, sizeof(int));
2195 if (message_length > 0)
2196 {
2197 len = read(pfd[pipe_read], big_buffer, message_length);
2198 if (len > 0) *sptr = string_copy(big_buffer);
2199 }
2200 }
2201 }
2202
2203 else
2204 {
2205 log_write(0, LOG_MAIN|LOG_PANIC, "failed to read delivery status for %s "
2206 "from delivery subprocess", addr2->unique);
2207 break;
2208 }
2209 }
2210
2211 (void)close(pfd[pipe_read]);
2212
2213 /* Unless shadowing, write all successful addresses immediately to the journal
2214 file, to ensure they are recorded asap. For homonymic addresses, use the base
2215 address plus the transport name. Failure to write the journal is panic-worthy,
2216 but don't stop, as it may prove possible subsequently to update the spool file
2217 in order to record the delivery. */
2218
2219 if (!shadowing)
2220 {
2221 for (addr2 = addr; addr2; addr2 = addr2->next)
2222 if (addr2->transport_return == OK)
2223 {
2224 if (testflag(addr2, af_homonym))
2225 sprintf(CS big_buffer, "%.500s/%s\n", addr2->unique + 3, tp->name);
2226 else
2227 sprintf(CS big_buffer, "%.500s\n", addr2->unique);
2228
2229 /* In the test harness, wait just a bit to let the subprocess finish off
2230 any debug output etc first. */
2231
2232 if (running_in_test_harness) millisleep(300);
2233
2234 DEBUG(D_deliver) debug_printf("journalling %s", big_buffer);
2235 len = Ustrlen(big_buffer);
2236 if (write(journal_fd, big_buffer, len) != len)
2237 log_write(0, LOG_MAIN|LOG_PANIC, "failed to update journal for %s: %s",
2238 big_buffer, strerror(errno));
2239 }
2240
2241 /* Ensure the journal file is pushed out to disk. */
2242
2243 if (EXIMfsync(journal_fd) < 0)
2244 log_write(0, LOG_MAIN|LOG_PANIC, "failed to fsync journal: %s",
2245 strerror(errno));
2246 }
2247
2248 /* Wait for the process to finish. If it terminates with a non-zero code,
2249 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2250 status values of all the addresses as they are. Take care to handle the case
2251 when the subprocess doesn't seem to exist. This has been seen on one system
2252 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2253 happens, wait() doesn't recognize the termination of child processes. Exim now
2254 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2255
2256 while ((rc = wait(&status)) != pid)
2257 if (rc < 0 && errno == ECHILD) /* Process has vanished */
2258 {
2259 log_write(0, LOG_MAIN, "%s transport process vanished unexpectedly",
2260 addr->transport->driver_name);
2261 status = 0;
2262 break;
2263 }
2264
2265 if ((status & 0xffff) != 0)
2266 {
2267 int msb = (status >> 8) & 255;
2268 int lsb = status & 255;
2269 int code = (msb == 0)? (lsb & 0x7f) : msb;
2270 if (msb != 0 || (code != SIGTERM && code != SIGKILL && code != SIGQUIT))
2271 addr->special_action = SPECIAL_FREEZE;
2272 log_write(0, LOG_MAIN|LOG_PANIC, "%s transport process returned non-zero "
2273 "status 0x%04x: %s %d",
2274 addr->transport->driver_name,
2275 status,
2276 msb == 0 ? "terminated by signal" : "exit code",
2277 code);
2278 }
2279
2280 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2281
2282 if (addr->special_action == SPECIAL_WARN && addr->transport->warn_message)
2283 {
2284 int fd;
2285 uschar *warn_message;
2286 pid_t pid;
2287
2288 DEBUG(D_deliver) debug_printf("Warning message requested by transport\n");
2289
2290 if (!(warn_message = expand_string(addr->transport->warn_message)))
2291 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand \"%s\" (warning "
2292 "message for %s transport): %s", addr->transport->warn_message,
2293 addr->transport->name, expand_string_message);
2294
2295 else if ((pid = child_open_exim(&fd)) > 0)
2296 {
2297 FILE *f = fdopen(fd, "wb");
2298 if (errors_reply_to && !contains_header(US"Reply-To", warn_message))
2299 fprintf(f, "Reply-To: %s\n", errors_reply_to);
2300 fprintf(f, "Auto-Submitted: auto-replied\n");
2301 if (!contains_header(US"From", warn_message))
2302 moan_write_from(f);
2303 fprintf(f, "%s", CS warn_message);
2304
2305 /* Close and wait for child process to complete, without a timeout. */
2306
2307 (void)fclose(f);
2308 (void)child_close(pid, 0);
2309 }
2310
2311 addr->special_action = SPECIAL_NONE;
2312 }
2313 }
2314
2315
2316
2317
2318 /* Check transport for the given concurrency limit. Return TRUE if over
2319 the limit (or an expansion failure), else FALSE and if there was a limit,
2320 the key for the hints database used for the concurrency count. */
2321
2322 static BOOL
2323 tpt_parallel_check(transport_instance * tp, address_item * addr, uschar ** key)
2324 {
2325 unsigned max_parallel;
2326
2327 if (!tp->max_parallel) return FALSE;
2328
2329 max_parallel = (unsigned) expand_string_integer(tp->max_parallel, TRUE);
2330 if (expand_string_message)
2331 {
2332 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand max_parallel option "
2333 "in %s transport (%s): %s", tp->name, addr->address,
2334 expand_string_message);
2335 return TRUE;
2336 }
2337
2338 if (max_parallel > 0)
2339 {
2340 uschar * serialize_key = string_sprintf("tpt-serialize-%s", tp->name);
2341 if (!enq_start(serialize_key, max_parallel))
2342 {
2343 address_item * next;
2344 DEBUG(D_transport)
2345 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2346 tp->name, max_parallel);
2347 do
2348 {
2349 next = addr->next;
2350 addr->message = US"concurrency limit reached for transport";
2351 addr->basic_errno = ERRNO_TRETRY;
2352 post_process_one(addr, DEFER, LOG_MAIN, DTYPE_TRANSPORT, 0);
2353 } while ((addr = next));
2354 return TRUE;
2355 }
2356 *key = serialize_key;
2357 }
2358 return FALSE;
2359 }
2360
2361
2362
2363 /*************************************************
2364 * Do local deliveries *
2365 *************************************************/
2366
2367 /* This function processes the list of addresses in addr_local. True local
2368 deliveries are always done one address at a time. However, local deliveries can
2369 be batched up in some cases. Typically this is when writing batched SMTP output
2370 files for use by some external transport mechanism, or when running local
2371 deliveries over LMTP.
2372
2373 Arguments: None
2374 Returns: Nothing
2375 */
2376
2377 static void
2378 do_local_deliveries(void)
2379 {
2380 open_db dbblock;
2381 open_db *dbm_file = NULL;
2382 time_t now = time(NULL);
2383
2384 /* Loop until we have exhausted the supply of local deliveries */
2385
2386 while (addr_local)
2387 {
2388 time_t delivery_start;
2389 int deliver_time;
2390 address_item *addr2, *addr3, *nextaddr;
2391 int logflags = LOG_MAIN;
2392 int logchar = dont_deliver? '*' : '=';
2393 transport_instance *tp;
2394 uschar * serialize_key = NULL;
2395
2396 /* Pick the first undelivered address off the chain */
2397
2398 address_item *addr = addr_local;
2399 addr_local = addr->next;
2400 addr->next = NULL;
2401
2402 DEBUG(D_deliver|D_transport)
2403 debug_printf("--------> %s <--------\n", addr->address);
2404
2405 /* An internal disaster if there is no transport. Should not occur! */
2406
2407 if (!(tp = addr->transport))
2408 {
2409 logflags |= LOG_PANIC;
2410 disable_logging = FALSE; /* Jic */
2411 addr->message = addr->router
2412 ? string_sprintf("No transport set by %s router", addr->router->name)
2413 : string_sprintf("No transport set by system filter");
2414 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2415 continue;
2416 }
2417
2418 /* Check that this base address hasn't previously been delivered to this
2419 transport. The check is necessary at this point to handle homonymic addresses
2420 correctly in cases where the pattern of redirection changes between delivery
2421 attempts. Non-homonymic previous delivery is detected earlier, at routing
2422 time. */
2423
2424 if (previously_transported(addr, FALSE)) continue;
2425
2426 /* There are weird cases where logging is disabled */
2427
2428 disable_logging = tp->disable_logging;
2429
2430 /* Check for batched addresses and possible amalgamation. Skip all the work
2431 if either batch_max <= 1 or there aren't any other addresses for local
2432 delivery. */
2433
2434 if (tp->batch_max > 1 && addr_local)
2435 {
2436 int batch_count = 1;
2437 BOOL uses_dom = readconf_depends((driver_instance *)tp, US"domain");
2438 BOOL uses_lp = ( testflag(addr, af_pfr)
2439 && (testflag(addr, af_file) || addr->local_part[0] == '|')
2440 )
2441 || readconf_depends((driver_instance *)tp, US"local_part");
2442 uschar *batch_id = NULL;
2443 address_item **anchor = &addr_local;
2444 address_item *last = addr;
2445 address_item *next;
2446
2447 /* Expand the batch_id string for comparison with other addresses.
2448 Expansion failure suppresses batching. */
2449
2450 if (tp->batch_id)
2451 {
2452 deliver_set_expansions(addr);
2453 batch_id = expand_string(tp->batch_id);
2454 deliver_set_expansions(NULL);
2455 if (!batch_id)
2456 {
2457 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2458 "in %s transport (%s): %s", tp->name, addr->address,
2459 expand_string_message);
2460 batch_count = tp->batch_max;
2461 }
2462 }
2463
2464 /* Until we reach the batch_max limit, pick off addresses which have the
2465 same characteristics. These are:
2466
2467 same transport
2468 not previously delivered (see comment about 50 lines above)
2469 same local part if the transport's configuration contains $local_part
2470 or if this is a file or pipe delivery from a redirection
2471 same domain if the transport's configuration contains $domain
2472 same errors address
2473 same additional headers
2474 same headers to be removed
2475 same uid/gid for running the transport
2476 same first host if a host list is set
2477 */
2478
2479 while ((next = *anchor) && batch_count < tp->batch_max)
2480 {
2481 BOOL ok =
2482 tp == next->transport
2483 && !previously_transported(next, TRUE)
2484 && (addr->flags & (af_pfr|af_file)) == (next->flags & (af_pfr|af_file))
2485 && (!uses_lp || Ustrcmp(next->local_part, addr->local_part) == 0)
2486 && (!uses_dom || Ustrcmp(next->domain, addr->domain) == 0)
2487 && same_strings(next->prop.errors_address, addr->prop.errors_address)
2488 && same_headers(next->prop.extra_headers, addr->prop.extra_headers)
2489 && same_strings(next->prop.remove_headers, addr->prop.remove_headers)
2490 && same_ugid(tp, addr, next)
2491 && ( !addr->host_list && !next->host_list
2492 || addr->host_list
2493 && next->host_list
2494 && Ustrcmp(addr->host_list->name, next->host_list->name) == 0
2495 );
2496
2497 /* If the transport has a batch_id setting, batch_id will be non-NULL
2498 from the expansion outside the loop. Expand for this address and compare.
2499 Expansion failure makes this address ineligible for batching. */
2500
2501 if (ok && batch_id)
2502 {
2503 uschar *bid;
2504 address_item *save_nextnext = next->next;
2505 next->next = NULL; /* Expansion for a single address */
2506 deliver_set_expansions(next);
2507 next->next = save_nextnext;
2508 bid = expand_string(tp->batch_id);
2509 deliver_set_expansions(NULL);
2510 if (!bid)
2511 {
2512 log_write(0, LOG_MAIN|LOG_PANIC, "Failed to expand batch_id option "
2513 "in %s transport (%s): %s", tp->name, next->address,
2514 expand_string_message);
2515 ok = FALSE;
2516 }
2517 else ok = (Ustrcmp(batch_id, bid) == 0);
2518 }
2519
2520 /* Take address into batch if OK. */
2521
2522 if (ok)
2523 {
2524 *anchor = next->next; /* Include the address */
2525 next->next = NULL;
2526 last->next = next;
2527 last = next;
2528 batch_count++;
2529 }
2530 else anchor = &next->next; /* Skip the address */
2531 }
2532 }
2533
2534 /* We now have one or more addresses that can be delivered in a batch. Check
2535 whether the transport is prepared to accept a message of this size. If not,
2536 fail them all forthwith. If the expansion fails, or does not yield an
2537 integer, defer delivery. */
2538
2539 if (tp->message_size_limit)
2540 {
2541 int rc = check_message_size(tp, addr);
2542 if (rc != OK)
2543 {
2544 replicate_status(addr);
2545 while (addr)
2546 {
2547 addr2 = addr->next;
2548 post_process_one(addr, rc, logflags, DTYPE_TRANSPORT, 0);
2549 addr = addr2;
2550 }
2551 continue; /* With next batch of addresses */
2552 }
2553 }
2554
2555 /* If we are not running the queue, or if forcing, all deliveries will be
2556 attempted. Otherwise, we must respect the retry times for each address. Even
2557 when not doing this, we need to set up the retry key string, and determine
2558 whether a retry record exists, because after a successful delivery, a delete
2559 retry item must be set up. Keep the retry database open only for the duration
2560 of these checks, rather than for all local deliveries, because some local
2561 deliveries (e.g. to pipes) can take a substantial time. */
2562
2563 if (!(dbm_file = dbfn_open(US"retry", O_RDONLY, &dbblock, FALSE)))
2564 {
2565 DEBUG(D_deliver|D_retry|D_hints_lookup)
2566 debug_printf("no retry data available\n");
2567 }
2568
2569 addr2 = addr;
2570 addr3 = NULL;
2571 while (addr2)
2572 {
2573 BOOL ok = TRUE; /* to deliver this address */
2574 uschar *retry_key;
2575
2576 /* Set up the retry key to include the domain or not, and change its
2577 leading character from "R" to "T". Must make a copy before doing this,
2578 because the old key may be pointed to from a "delete" retry item after
2579 a routing delay. */
2580
2581 retry_key = string_copy(
2582 tp->retry_use_local_part ? addr2->address_retry_key :
2583 addr2->domain_retry_key);
2584 *retry_key = 'T';
2585
2586 /* Inspect the retry data. If there is no hints file, delivery happens. */
2587
2588 if (dbm_file)
2589 {
2590 dbdata_retry *retry_record = dbfn_read(dbm_file, retry_key);
2591
2592 /* If there is no retry record, delivery happens. If there is,
2593 remember it exists so it can be deleted after a successful delivery. */
2594
2595 if (retry_record)
2596 {
2597 setflag(addr2, af_lt_retry_exists);
2598
2599 /* A retry record exists for this address. If queue running and not
2600 forcing, inspect its contents. If the record is too old, or if its
2601 retry time has come, or if it has passed its cutoff time, delivery
2602 will go ahead. */
2603
2604 DEBUG(D_retry)
2605 {
2606 debug_printf("retry record exists: age=%s ",
2607 readconf_printtime(now - retry_record->time_stamp));
2608 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire));
2609 debug_printf(" time to retry = %s expired = %d\n",
2610 readconf_printtime(retry_record->next_try - now),
2611 retry_record->expired);
2612 }
2613
2614 if (queue_running && !deliver_force)
2615 {
2616 ok = (now - retry_record->time_stamp > retry_data_expire)
2617 || (now >= retry_record->next_try)
2618 || retry_record->expired;
2619
2620 /* If we haven't reached the retry time, there is one more check
2621 to do, which is for the ultimate address timeout. */
2622
2623 if (!ok)
2624 ok = retry_ultimate_address_timeout(retry_key, addr2->domain,
2625 retry_record, now);
2626 }
2627 }
2628 else DEBUG(D_retry) debug_printf("no retry record exists\n");
2629 }
2630
2631 /* This address is to be delivered. Leave it on the chain. */
2632
2633 if (ok)
2634 {
2635 addr3 = addr2;
2636 addr2 = addr2->next;
2637 }
2638
2639 /* This address is to be deferred. Take it out of the chain, and
2640 post-process it as complete. Must take it out of the chain first,
2641 because post processing puts it on another chain. */
2642
2643 else
2644 {
2645 address_item *this = addr2;
2646 this->message = US"Retry time not yet reached";
2647 this->basic_errno = ERRNO_LRETRY;
2648 addr2 = addr3 ? (addr3->next = addr2->next)
2649 : (addr = addr2->next);
2650 post_process_one(this, DEFER, logflags, DTYPE_TRANSPORT, 0);
2651 }
2652 }
2653
2654 if (dbm_file) dbfn_close(dbm_file);
2655
2656 /* If there are no addresses left on the chain, they all deferred. Loop
2657 for the next set of addresses. */
2658
2659 if (!addr) continue;
2660
2661 /* If the transport is limited for parallellism, enforce that here.
2662 We use a hints DB entry, incremented here and decremented after
2663 the transport (and any shadow transport) completes. */
2664
2665 if (tpt_parallel_check(tp, addr, &serialize_key))
2666 {
2667 if (expand_string_message)
2668 {
2669 logflags |= LOG_PANIC;
2670 do
2671 {
2672 addr = addr->next;
2673 post_process_one(addr, DEFER, logflags, DTYPE_TRANSPORT, 0);
2674 } while ((addr = addr2));
2675 }
2676 continue; /* Loop for the next set of addresses. */
2677 }
2678
2679
2680 /* So, finally, we do have some addresses that can be passed to the
2681 transport. Before doing so, set up variables that are relevant to a
2682 single delivery. */
2683
2684 deliver_set_expansions(addr);
2685 delivery_start = time(NULL);
2686 deliver_local(addr, FALSE);
2687 deliver_time = (int)(time(NULL) - delivery_start);
2688
2689 /* If a shadow transport (which must perforce be another local transport), is
2690 defined, and its condition is met, we must pass the message to the shadow
2691 too, but only those addresses that succeeded. We do this by making a new
2692 chain of addresses - also to keep the original chain uncontaminated. We must
2693 use a chain rather than doing it one by one, because the shadow transport may
2694 batch.
2695
2696 NOTE: if the condition fails because of a lookup defer, there is nothing we
2697 can do! */
2698
2699 if ( tp->shadow
2700 && ( !tp->shadow_condition
2701 || expand_check_condition(tp->shadow_condition, tp->name, US"transport")
2702 ) )
2703 {
2704 transport_instance *stp;
2705 address_item *shadow_addr = NULL;
2706 address_item **last = &shadow_addr;
2707
2708 for (stp = transports; stp; stp = stp->next)
2709 if (Ustrcmp(stp->name, tp->shadow) == 0) break;
2710
2711 if (!stp)
2712 log_write(0, LOG_MAIN|LOG_PANIC, "shadow transport \"%s\" not found ",
2713 tp->shadow);
2714
2715 /* Pick off the addresses that have succeeded, and make clones. Put into
2716 the shadow_message field a pointer to the shadow_message field of the real
2717 address. */
2718
2719 else for (addr2 = addr; addr2; addr2 = addr2->next)
2720 if (addr2->transport_return == OK)
2721 {
2722 addr3 = store_get(sizeof(address_item));
2723 *addr3 = *addr2;
2724 addr3->next = NULL;
2725 addr3->shadow_message = (uschar *) &(addr2->shadow_message);
2726 addr3->transport = stp;
2727 addr3->transport_return = DEFER;
2728 addr3->return_filename = NULL;
2729 addr3->return_file = -1;
2730 *last = addr3;
2731 last = &(addr3->next);
2732 }
2733
2734 /* If we found any addresses to shadow, run the delivery, and stick any
2735 message back into the shadow_message field in the original. */
2736
2737 if (shadow_addr)
2738 {
2739 int save_count = transport_count;
2740
2741 DEBUG(D_deliver|D_transport)
2742 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
2743 deliver_local(shadow_addr, TRUE);
2744
2745 for(; shadow_addr; shadow_addr = shadow_addr->next)
2746 {
2747 int sresult = shadow_addr->transport_return;
2748 *(uschar **)shadow_addr->shadow_message =
2749 sresult == OK
2750 ? string_sprintf(" ST=%s", stp->name)
2751 : string_sprintf(" ST=%s (%s%s%s)", stp->name,
2752 shadow_addr->basic_errno <= 0
2753 ? US""
2754 : US strerror(shadow_addr->basic_errno),
2755 shadow_addr->basic_errno <= 0 || !shadow_addr->message
2756 ? US""
2757 : US": ",
2758 shadow_addr->message
2759 ? shadow_addr->message
2760 : shadow_addr->basic_errno <= 0
2761 ? US"unknown error"
2762 : US"");
2763
2764 DEBUG(D_deliver|D_transport)
2765 debug_printf("%s shadow transport returned %s for %s\n",
2766 stp->name,
2767 sresult == OK ? "OK" :
2768 sresult == DEFER ? "DEFER" :
2769 sresult == FAIL ? "FAIL" :
2770 sresult == PANIC ? "PANIC" : "?",
2771 shadow_addr->address);
2772 }
2773
2774 DEBUG(D_deliver|D_transport)
2775 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
2776
2777 transport_count = save_count; /* Restore original transport count */
2778 }
2779 }
2780
2781 /* Cancel the expansions that were set up for the delivery. */
2782
2783 deliver_set_expansions(NULL);
2784
2785 /* If the transport was parallelism-limited, decrement the hints DB record. */
2786
2787 if (serialize_key) enq_end(serialize_key);
2788
2789 /* Now we can process the results of the real transport. We must take each
2790 address off the chain first, because post_process_one() puts it on another
2791 chain. */
2792
2793 for (addr2 = addr; addr2; addr2 = nextaddr)
2794 {
2795 int result = addr2->transport_return;
2796 nextaddr = addr2->next;
2797
2798 DEBUG(D_deliver|D_transport)
2799 debug_printf("%s transport returned %s for %s\n",
2800 tp->name,
2801 result == OK ? "OK" :
2802 result == DEFER ? "DEFER" :
2803 result == FAIL ? "FAIL" :
2804 result == PANIC ? "PANIC" : "?",
2805 addr2->address);
2806
2807 /* If there is a retry_record, or if delivery is deferred, build a retry
2808 item for setting a new retry time or deleting the old retry record from
2809 the database. These items are handled all together after all addresses
2810 have been handled (so the database is open just for a short time for
2811 updating). */
2812
2813 if (result == DEFER || testflag(addr2, af_lt_retry_exists))
2814 {
2815 int flags = result == DEFER ? 0 : rf_delete;
2816 uschar *retry_key = string_copy(tp->retry_use_local_part
2817 ? addr2->address_retry_key : addr2->domain_retry_key);
2818 *retry_key = 'T';
2819 retry_add_item(addr2, retry_key, flags);
2820 }
2821
2822 /* Done with this address */
2823
2824 if (result == OK) addr2->more_errno = deliver_time;
2825 post_process_one(addr2, result, logflags, DTYPE_TRANSPORT, logchar);
2826
2827 /* If a pipe delivery generated text to be sent back, the result may be
2828 changed to FAIL, and we must copy this for subsequent addresses in the
2829 batch. */
2830
2831 if (addr2->transport_return != result)
2832 {
2833 for (addr3 = nextaddr; addr3; addr3 = addr3->next)
2834 {
2835 addr3->transport_return = addr2->transport_return;
2836 addr3->basic_errno = addr2->basic_errno;
2837 addr3->message = addr2->message;
2838 }
2839 result = addr2->transport_return;
2840 }
2841
2842 /* Whether or not the result was changed to FAIL, we need to copy the
2843 return_file value from the first address into all the addresses of the
2844 batch, so they are all listed in the error message. */
2845
2846 addr2->return_file = addr->return_file;
2847
2848 /* Change log character for recording successful deliveries. */
2849
2850 if (result == OK) logchar = '-';
2851 }
2852 } /* Loop back for next batch of addresses */
2853 }
2854
2855
2856
2857
2858 /*************************************************
2859 * Sort remote deliveries *
2860 *************************************************/
2861
2862 /* This function is called if remote_sort_domains is set. It arranges that the
2863 chain of addresses for remote deliveries is ordered according to the strings
2864 specified. Try to make this shuffling reasonably efficient by handling
2865 sequences of addresses rather than just single ones.
2866
2867 Arguments: None
2868 Returns: Nothing
2869 */
2870
2871 static void
2872 sort_remote_deliveries(void)
2873 {
2874 int sep = 0;
2875 address_item **aptr = &addr_remote;
2876 const uschar *listptr = remote_sort_domains;
2877 uschar *pattern;
2878 uschar patbuf[256];
2879
2880 while ( *aptr
2881 && (pattern = string_nextinlist(&listptr, &sep, patbuf, sizeof(patbuf)))
2882 )
2883 {
2884 address_item *moved = NULL;
2885 address_item **bptr = &moved;
2886
2887 while (*aptr)
2888 {
2889 address_item **next;
2890 deliver_domain = (*aptr)->domain; /* set $domain */
2891 if (match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2892 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL) == OK)
2893 {
2894 aptr = &(*aptr)->next;
2895 continue;
2896 }
2897
2898 next = &(*aptr)->next;
2899 while ( *next
2900 && (deliver_domain = (*next)->domain, /* Set $domain */
2901 match_isinlist(deliver_domain, (const uschar **)&pattern, UCHAR_MAX+1,
2902 &domainlist_anchor, NULL, MCL_DOMAIN, TRUE, NULL)) != OK
2903 )
2904 next = &(*next)->next;
2905
2906 /* If the batch of non-matchers is at the end, add on any that were
2907 extracted further up the chain, and end this iteration. Otherwise,
2908 extract them from the chain and hang on the moved chain. */
2909
2910 if (!*next)
2911 {
2912 *next = moved;
2913 break;
2914 }
2915
2916 *bptr = *aptr;
2917 *aptr = *next;
2918 *next = NULL;
2919 bptr = next;
2920 aptr = &(*aptr)->next;
2921 }
2922
2923 /* If the loop ended because the final address matched, *aptr will
2924 be NULL. Add on to the end any extracted non-matching addresses. If
2925 *aptr is not NULL, the loop ended via "break" when *next is null, that
2926 is, there was a string of non-matching addresses at the end. In this
2927 case the extracted addresses have already been added on the end. */
2928
2929 if (!*aptr) *aptr = moved;
2930 }
2931
2932 DEBUG(D_deliver)
2933 {
2934 address_item *addr;
2935 debug_printf("remote addresses after sorting:\n");
2936 for (addr = addr_remote; addr; addr = addr->next)
2937 debug_printf(" %s\n", addr->address);
2938 }
2939 }
2940
2941
2942
2943 /*************************************************
2944 * Read from pipe for remote delivery subprocess *
2945 *************************************************/
2946
2947 /* This function is called when the subprocess is complete, but can also be
2948 called before it is complete, in order to empty a pipe that is full (to prevent
2949 deadlock). It must therefore keep track of its progress in the parlist data
2950 block.
2951
2952 We read the pipe to get the delivery status codes and a possible error message
2953 for each address, optionally preceded by unusability data for the hosts and
2954 also by optional retry data.
2955
2956 Read in large chunks into the big buffer and then scan through, interpreting
2957 the data therein. In most cases, only a single read will be necessary. No
2958 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
2959 that we read the next chunk when there is less than 2500 bytes left in the
2960 non-final chunk, we can assume each item is complete in the buffer before
2961 handling it. Each item is written using a single write(), which is atomic for
2962 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
2963 often bigger) so even if we are reading while the subprocess is still going, we
2964 should never have only a partial item in the buffer.
2965
2966 Argument:
2967 poffset the offset of the parlist item
2968 eop TRUE if the process has completed
2969
2970 Returns: TRUE if the terminating 'Z' item has been read,
2971 or there has been a disaster (i.e. no more data needed);
2972 FALSE otherwise
2973 */
2974
2975 static BOOL
2976 par_read_pipe(int poffset, BOOL eop)
2977 {
2978 host_item *h;
2979 pardata *p = parlist + poffset;
2980 address_item *addrlist = p->addrlist;
2981 address_item *addr = p->addr;
2982 pid_t pid = p->pid;
2983 int fd = p->fd;
2984 uschar *endptr = big_buffer;
2985 uschar *ptr = endptr;
2986 uschar *msg = p->msg;
2987 BOOL done = p->done;
2988 BOOL unfinished = TRUE;
2989 /* minimum size to read is header size including id, subid and length */
2990 int required = PIPE_HEADER_SIZE;
2991
2992 /* Loop through all items, reading from the pipe when necessary. The pipe
2993 is set up to be non-blocking, but there are two different Unix mechanisms in
2994 use. Exim uses O_NONBLOCK if it is defined. This returns 0 for end of file,
2995 and EAGAIN for no more data. If O_NONBLOCK is not defined, Exim uses O_NDELAY,
2996 which returns 0 for both end of file and no more data. We distinguish the
2997 two cases by taking 0 as end of file only when we know the process has
2998 completed.
2999
3000 Each separate item is written to the pipe in a single write(), and as they are
3001 all short items, the writes will all be atomic and we should never find
3002 ourselves in the position of having read an incomplete item. "Short" in this
3003 case can mean up to about 1K in the case when there is a long error message
3004 associated with an address. */
3005
3006 DEBUG(D_deliver) debug_printf("reading pipe for subprocess %d (%s)\n",
3007 (int)p->pid, eop? "ended" : "not ended");
3008
3009 while (!done)
3010 {
3011 retry_item *r, **rp;
3012 int remaining = endptr - ptr;
3013 uschar header[PIPE_HEADER_SIZE + 1];
3014 uschar id, subid;
3015 uschar *endc;
3016
3017 /* Read (first time) or top up the chars in the buffer if necessary.
3018 There will be only one read if we get all the available data (i.e. don't
3019 fill the buffer completely). */
3020
3021 if (remaining < required && unfinished)
3022 {
3023 int len;
3024 int available = big_buffer_size - remaining;
3025
3026 if (remaining > 0) memmove(big_buffer, ptr, remaining);
3027
3028 ptr = big_buffer;
3029 endptr = big_buffer + remaining;
3030 len = read(fd, endptr, available);
3031
3032 DEBUG(D_deliver) debug_printf("read() yielded %d\n", len);
3033
3034 /* If the result is EAGAIN and the process is not complete, just
3035 stop reading any more and process what we have already. */
3036
3037 if (len < 0)
3038 {
3039 if (!eop && errno == EAGAIN) len = 0; else
3040 {
3041 msg = string_sprintf("failed to read pipe from transport process "
3042 "%d for transport %s: %s", pid, addr->transport->driver_name,
3043 strerror(errno));
3044 break;
3045 }
3046 }
3047
3048 /* If the length is zero (eof or no-more-data), just process what we
3049 already have. Note that if the process is still running and we have
3050 read all the data in the pipe (but less that "available") then we
3051 won't read any more, as "unfinished" will get set FALSE. */
3052
3053 endptr += len;
3054 remaining += len;
3055 unfinished = len == available;
3056 }
3057
3058 /* If we are at the end of the available data, exit the loop. */
3059 if (ptr >= endptr) break;
3060
3061 /* copy and read header */
3062 memcpy(header, ptr, PIPE_HEADER_SIZE);
3063 header[PIPE_HEADER_SIZE] = '\0';
3064 id = header[0];
3065 subid = header[1];
3066 required = Ustrtol(header + 2, &endc, 10) + PIPE_HEADER_SIZE; /* header + data */
3067 if (*endc)
3068 {
3069 msg = string_sprintf("failed to read pipe from transport process "
3070 "%d for transport %s: error reading size from header", pid, addr->transport->driver_name);
3071 done = TRUE;
3072 break;
3073 }
3074
3075 DEBUG(D_deliver)
3076 debug_printf("header read id:%c,subid:%c,size:%s,required:%d,remaining:%d,unfinished:%d\n",
3077 id, subid, header+2, required, remaining, unfinished);
3078
3079 /* is there room for the dataset we want to read ? */
3080 if (required > big_buffer_size - PIPE_HEADER_SIZE)
3081 {
3082 msg = string_sprintf("failed to read pipe from transport process "
3083 "%d for transport %s: big_buffer too small! required size=%d buffer size=%d", pid, addr->transport->driver_name,
3084 required, big_buffer_size - PIPE_HEADER_SIZE);
3085 done = TRUE;
3086 break;
3087 }
3088
3089 /* we wrote all datasets with atomic write() calls
3090 remaining < required only happens if big_buffer was too small
3091 to get all available data from pipe. unfinished has to be true
3092 as well. */
3093 if (remaining < required)
3094 {
3095 if (unfinished)
3096 continue;
3097 msg = string_sprintf("failed to read pipe from transport process "
3098 "%d for transport %s: required size=%d > remaining size=%d and unfinished=false",
3099 pid, addr->transport->driver_name, required, remaining);
3100 done = TRUE;
3101 break;
3102 }
3103
3104 /* step behind the header */
3105 ptr += PIPE_HEADER_SIZE;
3106
3107 /* Handle each possible type of item, assuming the complete item is
3108 available in store. */
3109
3110 switch (id)
3111 {
3112 /* Host items exist only if any hosts were marked unusable. Match
3113 up by checking the IP address. */
3114
3115 case 'H':
3116 for (h = addrlist->host_list; h; h = h->next)
3117 {
3118 if (!h->address || Ustrcmp(h->address, ptr+2) != 0) continue;
3119 h->status = ptr[0];
3120 h->why = ptr[1];
3121 }
3122 ptr += 2;
3123 while (*ptr++);
3124 break;
3125
3126 /* Retry items are sent in a preceding R item for each address. This is
3127 kept separate to keep each message short enough to guarantee it won't
3128 be split in the pipe. Hopefully, in the majority of cases, there won't in
3129 fact be any retry items at all.
3130
3131 The complete set of retry items might include an item to delete a
3132 routing retry if there was a previous routing delay. However, routing
3133 retries are also used when a remote transport identifies an address error.
3134 In that case, there may also be an "add" item for the same key. Arrange
3135 that a "delete" item is dropped in favour of an "add" item. */
3136
3137 case 'R':
3138 if (!addr) goto ADDR_MISMATCH;
3139
3140 DEBUG(D_deliver|D_retry)
3141 debug_printf("reading retry information for %s from subprocess\n",
3142 ptr+1);
3143
3144 /* Cut out any "delete" items on the list. */
3145
3146 for (rp = &(addr->retries); (r = *rp); rp = &r->next)
3147 if (Ustrcmp(r->key, ptr+1) == 0) /* Found item with same key */
3148 {
3149 if ((r->flags & rf_delete) == 0) break; /* It was not "delete" */
3150 *rp = r->next; /* Excise a delete item */
3151 DEBUG(D_deliver|D_retry)
3152 debug_printf(" existing delete item dropped\n");
3153 }
3154
3155 /* We want to add a delete item only if there is no non-delete item;
3156 however we still have to step ptr through the data. */
3157
3158 if (!r || (*ptr & rf_delete) == 0)
3159 {
3160 r = store_get(sizeof(retry_item));
3161 r->next = addr->retries;
3162 addr->retries = r;
3163 r->flags = *ptr++;
3164 r->key = string_copy(ptr);
3165 while (*ptr++);
3166 memcpy(&(r->basic_errno), ptr, sizeof(r->basic_errno));
3167 ptr += sizeof(r->basic_errno);
3168 memcpy(&(r->more_errno), ptr, sizeof(r->more_errno));
3169 ptr += sizeof(r->more_errno);
3170 r->message = (*ptr)? string_copy(ptr) : NULL;
3171 DEBUG(D_deliver|D_retry)
3172 debug_printf(" added %s item\n",
3173 ((r->flags & rf_delete) == 0)? "retry" : "delete");
3174 }
3175
3176 else
3177 {
3178 DEBUG(D_deliver|D_retry)
3179 debug_printf(" delete item not added: non-delete item exists\n");
3180 ptr++;
3181 while(*ptr++);
3182 ptr += sizeof(r->basic_errno) + sizeof(r->more_errno);
3183 }
3184
3185 while(*ptr++);
3186 break;
3187
3188 /* Put the amount of data written into the parlist block */
3189
3190 case 'S':
3191 memcpy(&(p->transport_count), ptr, sizeof(transport_count));
3192 ptr += sizeof(transport_count);
3193 break;
3194
3195 /* Address items are in the order of items on the address chain. We
3196 remember the current address value in case this function is called
3197 several times to empty the pipe in stages. Information about delivery
3198 over TLS is sent in a preceding X item for each address. We don't put
3199 it in with the other info, in order to keep each message short enough to
3200 guarantee it won't be split in the pipe. */
3201
3202 #ifdef SUPPORT_TLS
3203 case 'X':
3204 if (!addr) goto ADDR_MISMATCH; /* Below, in 'A' handler */
3205 switch (subid)
3206 {
3207 case '1':
3208 addr->cipher = NULL;
3209 addr->peerdn = NULL;
3210
3211 if (*ptr)
3212 addr->cipher = string_copy(ptr);
3213 while (*ptr++);
3214 if (*ptr)
3215 addr->peerdn = string_copy(ptr);
3216 break;
3217
3218 case '2':
3219 if (*ptr)
3220 (void) tls_import_cert(ptr, &addr->peercert);
3221 else
3222 addr->peercert = NULL;
3223 break;
3224
3225 case '3':
3226 if (*ptr)
3227 (void) tls_import_cert(ptr, &addr->ourcert);
3228 else
3229 addr->ourcert = NULL;
3230 break;
3231
3232 # ifndef DISABLE_OCSP
3233 case '4':
3234 addr->ocsp = OCSP_NOT_REQ;
3235 if (*ptr)
3236 addr->ocsp = *ptr - '0';
3237 break;
3238 # endif
3239 }
3240 while (*ptr++);
3241 break;
3242 #endif /*SUPPORT_TLS*/
3243
3244 case 'C': /* client authenticator information */
3245 switch (subid)
3246 {
3247 case '1':
3248 addr->authenticator = (*ptr)? string_copy(ptr) : NULL;
3249 break;
3250 case '2':
3251 addr->auth_id = (*ptr)? string_copy(ptr) : NULL;
3252 break;
3253 case '3':
3254 addr->auth_sndr = (*ptr)? string_copy(ptr) : NULL;
3255 break;
3256 }
3257 while (*ptr++);
3258 break;
3259
3260 #ifndef DISABLE_PRDR
3261 case 'P':
3262 addr->flags |= af_prdr_used;
3263 break;
3264 #endif
3265
3266 case 'D':
3267 if (!addr) goto ADDR_MISMATCH;
3268 memcpy(&(addr->dsn_aware), ptr, sizeof(addr->dsn_aware));
3269 ptr += sizeof(addr->dsn_aware);
3270 DEBUG(D_deliver) debug_printf("DSN read: addr->dsn_aware = %d\n", addr->dsn_aware);
3271 break;
3272
3273 case 'A':
3274 if (!addr)
3275 {
3276 ADDR_MISMATCH:
3277 msg = string_sprintf("address count mismatch for data read from pipe "
3278 "for transport process %d for transport %s", pid,
3279 addrlist->transport->driver_name);
3280 done = TRUE;
3281 break;
3282 }
3283
3284 switch (subid)
3285 {
3286 #ifdef EXPERIMENTAL_DSN_INFO
3287 case '1': /* must arrive before A0, and applies to that addr */
3288 /* Two strings: smtp_greeting and helo_response */
3289 addr->smtp_greeting = string_copy(ptr);
3290 while(*ptr++);
3291 addr->helo_response = string_copy(ptr);
3292 while(*ptr++);
3293 break;
3294 #endif
3295
3296 case '0':
3297 addr->transport_return = *ptr++;
3298 addr->special_action = *ptr++;
3299 memcpy(&(addr->basic_errno), ptr, sizeof(addr->basic_errno));
3300 ptr += sizeof(addr->basic_errno);
3301 memcpy(&(addr->more_errno), ptr, sizeof(addr->more_errno));
3302 ptr += sizeof(addr->more_errno);
3303 memcpy(&(addr->flags), ptr, sizeof(addr->flags));
3304 ptr += sizeof(addr->flags);
3305 addr->message = (*ptr)? string_copy(ptr) : NULL;
3306 while(*ptr++);
3307 addr->user_message = (*ptr)? string_copy(ptr) : NULL;
3308 while(*ptr++);
3309
3310 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3311
3312 if (*ptr != 0)
3313 {
3314 h = store_get(sizeof(host_item));
3315 h->name = string_copy(ptr);
3316 while (*ptr++);
3317 h->address = string_copy(ptr);
3318 while(*ptr++);
3319 memcpy(&(h->port), ptr, sizeof(h->port));
3320 ptr += sizeof(h->port);
3321 h->dnssec = *ptr == '2' ? DS_YES
3322 : *ptr == '1' ? DS_NO
3323 : DS_UNK;
3324 ptr++;
3325 addr->host_used = h;
3326 }
3327 else ptr++;
3328
3329 /* Finished with this address */
3330
3331 addr = addr->next;
3332 break;
3333 }
3334 break;
3335
3336 /* Local interface address/port */
3337 case 'I':
3338 if (*ptr) sending_ip_address = string_copy(ptr);
3339 while (*ptr++) ;
3340 if (*ptr) sending_port = atoi(CS ptr);
3341 while (*ptr++) ;
3342 break;
3343
3344 /* Z marks the logical end of the data. It is followed by '0' if
3345 continue_transport was NULL at the end of transporting, otherwise '1'.
3346 We need to know when it becomes NULL during a delivery down a passed SMTP
3347 channel so that we don't try to pass anything more down it. Of course, for
3348 most normal messages it will remain NULL all the time. */
3349
3350 case 'Z':
3351 if (*ptr == '0')
3352 {
3353 continue_transport = NULL;
3354 continue_hostname = NULL;
3355 }
3356 done = TRUE;
3357 DEBUG(D_deliver) debug_printf("Z0%c item read\n", *ptr);
3358 break;
3359
3360 /* Anything else is a disaster. */
3361
3362 default:
3363 msg = string_sprintf("malformed data (%d) read from pipe for transport "
3364 "process %d for transport %s", ptr[-1], pid,
3365 addr->transport->driver_name);
3366 done = TRUE;
3367 break;
3368 }
3369 }
3370
3371 /* The done flag is inspected externally, to determine whether or not to
3372 call the function again when the process finishes. */
3373
3374 p->done = done;
3375
3376 /* If the process hadn't finished, and we haven't seen the end of the data
3377 or suffered a disaster, update the rest of the state, and return FALSE to
3378 indicate "not finished". */
3379
3380 if (!eop && !done)
3381 {
3382 p->addr = addr;
3383 p->msg = msg;
3384 return FALSE;
3385 }
3386
3387 /* Close our end of the pipe, to prevent deadlock if the far end is still
3388 pushing stuff into it. */
3389
3390 (void)close(fd);
3391 p->fd = -1;
3392
3393 /* If we have finished without error, but haven't had data for every address,
3394 something is wrong. */
3395
3396 if (!msg && addr)
3397 msg = string_sprintf("insufficient address data read from pipe "
3398 "for transport process %d for transport %s", pid,
3399 addr->transport->driver_name);
3400
3401 /* If an error message is set, something has gone wrong in getting back
3402 the delivery data. Put the message into each address and freeze it. */
3403
3404 if (msg)
3405 for (addr = addrlist; addr; addr = addr->next)
3406 {
3407 addr->transport_return = DEFER;
3408 addr->special_action = SPECIAL_FREEZE;
3409 addr->message = msg;
3410 }
3411
3412 /* Return TRUE to indicate we have got all we need from this process, even
3413 if it hasn't actually finished yet. */
3414
3415 return TRUE;
3416 }
3417
3418
3419
3420 /*************************************************
3421 * Post-process a set of remote addresses *
3422 *************************************************/
3423
3424 /* Do what has to be done immediately after a remote delivery for each set of
3425 addresses, then re-write the spool if necessary. Note that post_process_one
3426 puts the address on an appropriate queue; hence we must fish off the next
3427 one first. This function is also called if there is a problem with setting
3428 up a subprocess to do a remote delivery in parallel. In this case, the final
3429 argument contains a message, and the action must be forced to DEFER.
3430
3431 Argument:
3432 addr pointer to chain of address items
3433 logflags flags for logging
3434 msg NULL for normal cases; -> error message for unexpected problems
3435 fallback TRUE if processing fallback hosts
3436
3437 Returns: nothing
3438 */