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