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