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