1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* The main code for delivering a message. */
12 #include "transports/smtp.h"
17 /* Data block for keeping track of subprocesses for parallel remote
20 typedef struct pardata
{
21 address_item
*addrlist
; /* chain of addresses */
22 address_item
*addr
; /* next address data expected for */
23 pid_t pid
; /* subprocess pid */
24 int fd
; /* pipe fd for getting result from subprocess */
25 int transport_count
; /* returned transport count value */
26 BOOL done
; /* no more data needed */
27 uschar
*msg
; /* error message */
28 uschar
*return_path
; /* return_path for these addresses */
31 /* Values for the process_recipients variable */
33 enum { RECIP_ACCEPT
, RECIP_IGNORE
, RECIP_DEFER
,
34 RECIP_FAIL
, RECIP_FAIL_FILTER
, RECIP_FAIL_TIMEOUT
,
37 /* Mutually recursive functions for marking addresses done. */
39 static void child_done(address_item
*, uschar
*);
40 static void address_done(address_item
*, uschar
*);
42 /* Table for turning base-62 numbers into binary */
44 static uschar tab62
[] =
45 {0,1,2,3,4,5,6,7,8,9,0,0,0,0,0,0, /* 0-9 */
46 0,10,11,12,13,14,15,16,17,18,19,20, /* A-K */
47 21,22,23,24,25,26,27,28,29,30,31,32, /* L-W */
48 33,34,35, 0, 0, 0, 0, 0, /* X-Z */
49 0,36,37,38,39,40,41,42,43,44,45,46, /* a-k */
50 47,48,49,50,51,52,53,54,55,56,57,58, /* l-w */
54 /*************************************************
55 * Local static variables *
56 *************************************************/
58 /* addr_duplicate is global because it needs to be seen from the Envelope-To
61 static address_item
*addr_defer
= NULL
;
62 static address_item
*addr_failed
= NULL
;
63 static address_item
*addr_fallback
= NULL
;
64 static address_item
*addr_local
= NULL
;
65 static address_item
*addr_new
= NULL
;
66 static address_item
*addr_remote
= NULL
;
67 static address_item
*addr_route
= NULL
;
68 static address_item
*addr_succeed
= NULL
;
69 static address_item
*addr_dsntmp
= NULL
;
70 static address_item
*addr_senddsn
= NULL
;
72 static FILE *message_log
= NULL
;
73 static BOOL update_spool
;
74 static BOOL remove_journal
;
75 static int parcount
= 0;
76 static pardata
*parlist
= NULL
;
77 static int return_count
;
78 static uschar
*frozen_info
= US
"";
79 static uschar
*used_return_path
= NULL
;
83 /*************************************************
84 * read as much as requested *
85 *************************************************/
87 /* The syscall read(2) doesn't always returns as much as we want. For
88 several reasons it might get less. (Not talking about signals, as syscalls
89 are restartable). When reading from a network or pipe connection the sender
90 might send in smaller chunks, with delays between these chunks. The read(2)
91 may return such a chunk.
93 The more the writer writes and the smaller the pipe between write and read is,
94 the more we get the chance of reading leass than requested. (See bug 2130)
96 This function read(2)s until we got all the data we *requested*.
98 Note: This function may block. Use it only if you're sure about the
99 amount of data you will get.
102 fd the file descriptor to read from
103 buffer pointer to a buffer of size len
104 len the requested(!) amount of bytes
106 Returns: the amount of bytes read
109 readn(int fd
, void * buffer
, size_t len
)
111 void * next
= buffer
;
112 void * end
= buffer
+ len
;
116 ssize_t got
= read(fd
, next
, end
- next
);
118 /* I'm not sure if there are signals that can interrupt us,
119 for now I assume the worst */
120 if (got
== -1 && errno
== EINTR
) continue;
121 if (got
<= 0) return next
- buffer
;
129 /*************************************************
130 * Make a new address item *
131 *************************************************/
133 /* This function gets the store and initializes with default values. The
134 transport_return value defaults to DEFER, so that any unexpected failure to
135 deliver does not wipe out the message. The default unique string is set to a
136 copy of the address, so that its domain can be lowercased.
139 address the RFC822 address string
140 copy force a copy of the address
142 Returns: a pointer to an initialized address_item
146 deliver_make_addr(uschar
*address
, BOOL copy
)
148 address_item
*addr
= store_get(sizeof(address_item
));
149 *addr
= address_defaults
;
150 if (copy
) address
= string_copy(address
);
151 addr
->address
= address
;
152 addr
->unique
= string_copy(address
);
159 /*************************************************
160 * Set expansion values for an address *
161 *************************************************/
163 /* Certain expansion variables are valid only when handling an address or
164 address list. This function sets them up or clears the values, according to its
168 addr the address in question, or NULL to clear values
173 deliver_set_expansions(address_item
*addr
)
177 const uschar
***p
= address_expansions
;
178 while (*p
) **p
++ = NULL
;
182 /* Exactly what gets set depends on whether there is one or more addresses, and
183 what they contain. These first ones are always set, taking their values from
184 the first address. */
186 if (!addr
->host_list
)
188 deliver_host
= deliver_host_address
= US
"";
189 deliver_host_port
= 0;
193 deliver_host
= addr
->host_list
->name
;
194 deliver_host_address
= addr
->host_list
->address
;
195 deliver_host_port
= addr
->host_list
->port
;
198 deliver_recipients
= addr
;
199 deliver_address_data
= addr
->prop
.address_data
;
200 deliver_domain_data
= addr
->prop
.domain_data
;
201 deliver_localpart_data
= addr
->prop
.localpart_data
;
203 /* These may be unset for multiple addresses */
205 deliver_domain
= addr
->domain
;
206 self_hostname
= addr
->self_hostname
;
208 #ifdef EXPERIMENTAL_BRIGHTMAIL
209 bmi_deliver
= 1; /* deliver by default */
210 bmi_alt_location
= NULL
;
211 bmi_base64_verdict
= NULL
;
212 bmi_base64_tracker_verdict
= NULL
;
215 /* If there's only one address we can set everything. */
219 address_item
*addr_orig
;
221 deliver_localpart
= addr
->local_part
;
222 deliver_localpart_prefix
= addr
->prefix
;
223 deliver_localpart_suffix
= addr
->suffix
;
225 for (addr_orig
= addr
; addr_orig
->parent
; addr_orig
= addr_orig
->parent
) ;
226 deliver_domain_orig
= addr_orig
->domain
;
228 /* Re-instate any prefix and suffix in the original local part. In all
229 normal cases, the address will have a router associated with it, and we can
230 choose the caseful or caseless version accordingly. However, when a system
231 filter sets up a pipe, file, or autoreply delivery, no router is involved.
232 In this case, though, there won't be any prefix or suffix to worry about. */
234 deliver_localpart_orig
= !addr_orig
->router
235 ? addr_orig
->local_part
236 : addr_orig
->router
->caseful_local_part
237 ? addr_orig
->cc_local_part
238 : addr_orig
->lc_local_part
;
240 /* If there's a parent, make its domain and local part available, and if
241 delivering to a pipe or file, or sending an autoreply, get the local
242 part from the parent. For pipes and files, put the pipe or file string
243 into address_pipe and address_file. */
247 deliver_domain_parent
= addr
->parent
->domain
;
248 deliver_localpart_parent
= !addr
->parent
->router
249 ? addr
->parent
->local_part
250 : addr
->parent
->router
->caseful_local_part
251 ? addr
->parent
->cc_local_part
252 : addr
->parent
->lc_local_part
;
254 /* File deliveries have their own flag because they need to be picked out
255 as special more often. */
257 if (testflag(addr
, af_pfr
))
259 if (testflag(addr
, af_file
)) address_file
= addr
->local_part
;
260 else if (deliver_localpart
[0] == '|') address_pipe
= addr
->local_part
;
261 deliver_localpart
= addr
->parent
->local_part
;
262 deliver_localpart_prefix
= addr
->parent
->prefix
;
263 deliver_localpart_suffix
= addr
->parent
->suffix
;
267 #ifdef EXPERIMENTAL_BRIGHTMAIL
268 /* Set expansion variables related to Brightmail AntiSpam */
269 bmi_base64_verdict
= bmi_get_base64_verdict(deliver_localpart_orig
, deliver_domain_orig
);
270 bmi_base64_tracker_verdict
= bmi_get_base64_tracker_verdict(bmi_base64_verdict
);
271 /* get message delivery status (0 - don't deliver | 1 - deliver) */
272 bmi_deliver
= bmi_get_delivery_status(bmi_base64_verdict
);
273 /* if message is to be delivered, get eventual alternate location */
274 if (bmi_deliver
== 1)
275 bmi_alt_location
= bmi_get_alt_location(bmi_base64_verdict
);
280 /* For multiple addresses, don't set local part, and leave the domain and
281 self_hostname set only if it is the same for all of them. It is possible to
282 have multiple pipe and file addresses, but only when all addresses have routed
283 to the same pipe or file. */
288 if (testflag(addr
, af_pfr
))
290 if (testflag(addr
, af_file
)) address_file
= addr
->local_part
;
291 else if (addr
->local_part
[0] == '|') address_pipe
= addr
->local_part
;
293 for (addr2
= addr
->next
; addr2
; addr2
= addr2
->next
)
295 if (deliver_domain
&& Ustrcmp(deliver_domain
, addr2
->domain
) != 0)
296 deliver_domain
= NULL
;
298 && ( !addr2
->self_hostname
299 || Ustrcmp(self_hostname
, addr2
->self_hostname
) != 0
301 self_hostname
= NULL
;
302 if (!deliver_domain
&& !self_hostname
) break;
310 /*************************************************
311 * Open a msglog file *
312 *************************************************/
314 /* This function is used both for normal message logs, and for files in the
315 msglog directory that are used to catch output from pipes. Try to create the
316 directory if it does not exist. From release 4.21, normal message logs should
317 be created when the message is received.
319 Called from deliver_message(), can be operating as root.
322 filename the file name
323 mode the mode required
324 error used for saying what failed
326 Returns: a file descriptor, or -1 (with errno set)
330 open_msglog_file(uschar
*filename
, int mode
, uschar
**error
)
334 for (i
= 2; i
> 0; i
--)
343 O_WRONLY
|O_APPEND
|O_CREAT
, mode
);
346 /* Set the close-on-exec flag and change the owner to the exim uid/gid (this
347 function is called as root). Double check the mode, because the group setting
348 doesn't always get set automatically. */
351 (void)fcntl(fd
, F_SETFD
, fcntl(fd
, F_GETFD
) | FD_CLOEXEC
);
353 if (fchown(fd
, exim_uid
, exim_gid
) < 0)
358 if (fchmod(fd
, mode
) < 0)
368 (void)directory_make(spool_directory
,
369 spool_sname(US
"msglog", message_subdir
),
370 MSGLOG_DIRECTORY_MODE
, TRUE
);
380 /*************************************************
381 * Write to msglog if required *
382 *************************************************/
384 /* Write to the message log, if configured. This function may also be called
388 format a string format
394 deliver_msglog(const char *format
, ...)
397 if (!message_logs
) return;
398 va_start(ap
, format
);
399 vfprintf(message_log
, format
, ap
);
407 /*************************************************
408 * Replicate status for batch *
409 *************************************************/
411 /* When a transport handles a batch of addresses, it may treat them
412 individually, or it may just put the status in the first one, and return FALSE,
413 requesting that the status be copied to all the others externally. This is the
414 replication function. As well as the status, it copies the transport pointer,
415 which may have changed if appendfile passed the addresses on to a different
418 Argument: pointer to the first address in a chain
423 replicate_status(address_item
*addr
)
426 for (addr2
= addr
->next
; addr2
; addr2
= addr2
->next
)
428 addr2
->transport
= addr
->transport
;
429 addr2
->transport_return
= addr
->transport_return
;
430 addr2
->basic_errno
= addr
->basic_errno
;
431 addr2
->more_errno
= addr
->more_errno
;
432 addr2
->delivery_usec
= addr
->delivery_usec
;
433 addr2
->special_action
= addr
->special_action
;
434 addr2
->message
= addr
->message
;
435 addr2
->user_message
= addr
->user_message
;
441 /*************************************************
442 * Compare lists of hosts *
443 *************************************************/
445 /* This function is given two pointers to chains of host items, and it yields
446 TRUE if the lists refer to the same hosts in the same order, except that
448 (1) Multiple hosts with the same non-negative MX values are permitted to appear
449 in different orders. Round-robinning nameservers can cause this to happen.
451 (2) Multiple hosts with the same negative MX values less than MX_NONE are also
452 permitted to appear in different orders. This is caused by randomizing
455 This enables Exim to use a single SMTP transaction for sending to two entirely
456 different domains that happen to end up pointing at the same hosts.
459 one points to the first host list
460 two points to the second host list
462 Returns: TRUE if the lists refer to the same host set
466 same_hosts(host_item
*one
, host_item
*two
)
470 if (Ustrcmp(one
->name
, two
->name
) != 0)
473 host_item
*end_one
= one
;
474 host_item
*end_two
= two
;
476 /* Batch up only if there was no MX and the list was not randomized */
478 if (mx
== MX_NONE
) return FALSE
;
480 /* Find the ends of the shortest sequence of identical MX values */
482 while ( end_one
->next
&& end_one
->next
->mx
== mx
483 && end_two
->next
&& end_two
->next
->mx
== mx
)
485 end_one
= end_one
->next
;
486 end_two
= end_two
->next
;
489 /* If there aren't any duplicates, there's no match. */
491 if (end_one
== one
) return FALSE
;
493 /* For each host in the 'one' sequence, check that it appears in the 'two'
494 sequence, returning FALSE if not. */
499 for (hi
= two
; hi
!= end_two
->next
; hi
= hi
->next
)
500 if (Ustrcmp(one
->name
, hi
->name
) == 0) break;
501 if (hi
== end_two
->next
) return FALSE
;
502 if (one
== end_one
) break;
506 /* All the hosts in the 'one' sequence were found in the 'two' sequence.
507 Ensure both are pointing at the last host, and carry on as for equality. */
512 /* if the names matched but ports do not, mismatch */
513 else if (one
->port
!= two
->port
)
522 /* True if both are NULL */
529 /*************************************************
530 * Compare header lines *
531 *************************************************/
533 /* This function is given two pointers to chains of header items, and it yields
534 TRUE if they are the same header texts in the same order.
537 one points to the first header list
538 two points to the second header list
540 Returns: TRUE if the lists refer to the same header set
544 same_headers(header_line
*one
, header_line
*two
)
546 for (;; one
= one
->next
, two
= two
->next
)
548 if (one
== two
) return TRUE
; /* Includes the case where both NULL */
549 if (!one
|| !two
) return FALSE
;
550 if (Ustrcmp(one
->text
, two
->text
) != 0) return FALSE
;
556 /*************************************************
557 * Compare string settings *
558 *************************************************/
560 /* This function is given two pointers to strings, and it returns
561 TRUE if they are the same pointer, or if the two strings are the same.
564 one points to the first string
565 two points to the second string
567 Returns: TRUE or FALSE
571 same_strings(uschar
*one
, uschar
*two
)
573 if (one
== two
) return TRUE
; /* Includes the case where both NULL */
574 if (!one
|| !two
) return FALSE
;
575 return (Ustrcmp(one
, two
) == 0);
580 /*************************************************
581 * Compare uid/gid for addresses *
582 *************************************************/
584 /* This function is given a transport and two addresses. It yields TRUE if the
585 uid/gid/initgroups settings for the two addresses are going to be the same when
590 addr1 the first address
591 addr2 the second address
593 Returns: TRUE or FALSE
597 same_ugid(transport_instance
*tp
, address_item
*addr1
, address_item
*addr2
)
599 if ( !tp
->uid_set
&& !tp
->expand_uid
600 && !tp
->deliver_as_creator
601 && ( testflag(addr1
, af_uid_set
) != testflag(addr2
, af_gid_set
)
602 || ( testflag(addr1
, af_uid_set
)
603 && ( addr1
->uid
!= addr2
->uid
604 || testflag(addr1
, af_initgroups
) != testflag(addr2
, af_initgroups
)
608 if ( !tp
->gid_set
&& !tp
->expand_gid
609 && ( testflag(addr1
, af_gid_set
) != testflag(addr2
, af_gid_set
)
610 || ( testflag(addr1
, af_gid_set
)
611 && addr1
->gid
!= addr2
->gid
621 /*************************************************
622 * Record that an address is complete *
623 *************************************************/
625 /* This function records that an address is complete. This is straightforward
626 for most addresses, where the unique address is just the full address with the
627 domain lower cased. For homonyms (addresses that are the same as one of their
628 ancestors) their are complications. Their unique addresses have \x\ prepended
629 (where x = 0, 1, 2...), so that de-duplication works correctly for siblings and
632 Exim used to record the unique addresses of homonyms as "complete". This,
633 however, fails when the pattern of redirection varies over time (e.g. if taking
634 unseen copies at only some times of day) because the prepended numbers may vary
635 from one delivery run to the next. This problem is solved by never recording
636 prepended unique addresses as complete. Instead, when a homonymic address has
637 actually been delivered via a transport, we record its basic unique address
638 followed by the name of the transport. This is checked in subsequent delivery
639 runs whenever an address is routed to a transport.
641 If the completed address is a top-level one (has no parent, which means it
642 cannot be homonymic) we also add the original address to the non-recipients
643 tree, so that it gets recorded in the spool file and therefore appears as
644 "done" in any spool listings. The original address may differ from the unique
645 address in the case of the domain.
647 Finally, this function scans the list of duplicates, marks as done any that
648 match this address, and calls child_done() for their ancestors.
651 addr address item that has been completed
652 now current time as a string
658 address_done(address_item
*addr
, uschar
*now
)
662 update_spool
= TRUE
; /* Ensure spool gets updated */
664 /* Top-level address */
668 tree_add_nonrecipient(addr
->unique
);
669 tree_add_nonrecipient(addr
->address
);
672 /* Homonymous child address */
674 else if (testflag(addr
, af_homonym
))
677 tree_add_nonrecipient(
678 string_sprintf("%s/%s", addr
->unique
+ 3, addr
->transport
->name
));
681 /* Non-homonymous child address */
683 else tree_add_nonrecipient(addr
->unique
);
685 /* Check the list of duplicate addresses and ensure they are now marked
688 for (dup
= addr_duplicate
; dup
; dup
= dup
->next
)
689 if (Ustrcmp(addr
->unique
, dup
->unique
) == 0)
691 tree_add_nonrecipient(dup
->unique
);
692 child_done(dup
, now
);
699 /*************************************************
700 * Decrease counts in parents and mark done *
701 *************************************************/
703 /* This function is called when an address is complete. If there is a parent
704 address, its count of children is decremented. If there are still other
705 children outstanding, the function exits. Otherwise, if the count has become
706 zero, address_done() is called to mark the parent and its duplicates complete.
707 Then loop for any earlier ancestors.
710 addr points to the completed address item
711 now the current time as a string, for writing to the message log
717 child_done(address_item
*addr
, uschar
*now
)
723 if (--addr
->child_count
> 0) return; /* Incomplete parent */
724 address_done(addr
, now
);
726 /* Log the completion of all descendents only when there is no ancestor with
727 the same original address. */
729 for (aa
= addr
->parent
; aa
; aa
= aa
->parent
)
730 if (Ustrcmp(aa
->address
, addr
->address
) == 0) break;
733 deliver_msglog("%s %s: children all complete\n", now
, addr
->address
);
734 DEBUG(D_deliver
) debug_printf("%s: children all complete\n", addr
->address
);
740 /*************************************************
741 * Delivery logging support functions *
742 *************************************************/
744 /* The LOGGING() checks in d_log_interface() are complicated for backwards
745 compatibility. When outgoing interface logging was originally added, it was
746 conditional on just incoming_interface (which is off by default). The
747 outgoing_interface option is on by default to preserve this behaviour, but
748 you can enable incoming_interface and disable outgoing_interface to get I=
749 fields on incoming lines only.
753 addr The address to be logged
755 Returns: New value for s
759 d_log_interface(gstring
* g
)
761 if (LOGGING(incoming_interface
) && LOGGING(outgoing_interface
)
762 && sending_ip_address
)
764 g
= string_fmt_append(g
, " I=[%s]", sending_ip_address
);
765 if (LOGGING(outgoing_port
))
766 g
= string_fmt_append(g
, "%d", sending_port
);
774 d_hostlog(gstring
* g
, address_item
* addr
)
776 host_item
* h
= addr
->host_used
;
778 g
= string_append(g
, 2, US
" H=", h
->name
);
780 if (LOGGING(dnssec
) && h
->dnssec
== DS_YES
)
781 g
= string_catn(g
, US
" DS", 3);
783 g
= string_append(g
, 3, US
" [", h
->address
, US
"]");
785 if (LOGGING(outgoing_port
))
786 g
= string_fmt_append(g
, ":%d", h
->port
);
789 if (LOGGING(proxy
) && proxy_local_address
)
791 g
= string_append(g
, 3, US
" PRX=[", proxy_local_address
, US
"]");
792 if (LOGGING(outgoing_port
))
793 g
= string_fmt_append(g
, ":%d", proxy_local_port
);
797 g
= d_log_interface(g
);
799 if (testflag(addr
, af_tcp_fastopen
))
800 g
= string_catn(g
, US
" TFO*", testflag(addr
, af_tcp_fastopen_data
) ?
5 : 4);
811 d_tlslog(gstring
* s
, address_item
* addr
)
813 if (LOGGING(tls_cipher
) && addr
->cipher
)
814 s
= string_append(s
, 2, US
" X=", addr
->cipher
);
815 if (LOGGING(tls_certificate_verified
) && addr
->cipher
)
816 s
= string_append(s
, 2, US
" CV=",
817 testflag(addr
, af_cert_verified
)
820 testflag(addr
, af_dane_verified
)
826 if (LOGGING(tls_peerdn
) && addr
->peerdn
)
827 s
= string_append(s
, 3, US
" DN=\"", string_printing(addr
->peerdn
), US
"\"");
835 #ifndef DISABLE_EVENT
837 event_raise(uschar
* action
, const uschar
* event
, uschar
* ev_data
)
843 debug_printf("Event(%s): event_action=|%s| delivery_IP=%s\n",
845 action
, deliver_host_address
);
848 event_data
= ev_data
;
850 if (!(s
= expand_string(action
)) && *expand_string_message
)
851 log_write(0, LOG_MAIN
|LOG_PANIC
,
852 "failed to expand event_action %s in %s: %s\n",
853 event
, transport_name ? transport_name
: US
"main", expand_string_message
);
855 event_name
= event_data
= NULL
;
857 /* If the expansion returns anything but an empty string, flag for
858 the caller to modify his normal processing
863 debug_printf("Event(%s): event_action returned \"%s\"\n", event
, s
);
871 msg_event_raise(const uschar
* event
, const address_item
* addr
)
873 const uschar
* save_domain
= deliver_domain
;
874 uschar
* save_local
= deliver_localpart
;
875 const uschar
* save_host
= deliver_host
;
876 const uschar
* save_address
= deliver_host_address
;
877 const int save_port
= deliver_host_port
;
879 router_name
= addr
->router ? addr
->router
->name
: NULL
;
880 deliver_domain
= addr
->domain
;
881 deliver_localpart
= addr
->local_part
;
882 deliver_host
= addr
->host_used ? addr
->host_used
->name
: NULL
;
884 if (!addr
->transport
)
886 if (Ustrcmp(event
, "msg:fail:delivery") == 0)
888 /* An address failed with no transport involved. This happens when
889 a filter was used which triggered a fail command (in such a case
890 a transport isn't needed). Convert it to an internal fail event. */
892 (void) event_raise(event_action
, US
"msg:fail:internal", addr
->message
);
897 transport_name
= addr
->transport
->name
;
899 (void) event_raise(addr
->transport
->event_action
, event
,
901 || Ustrcmp(addr
->transport
->driver_name
, "smtp") == 0
902 || Ustrcmp(addr
->transport
->driver_name
, "lmtp") == 0
903 || Ustrcmp(addr
->transport
->driver_name
, "autoreply") == 0
904 ? addr
->message
: NULL
);
907 deliver_host_port
= save_port
;
908 deliver_host_address
= save_address
;
909 deliver_host
= save_host
;
910 deliver_localpart
= save_local
;
911 deliver_domain
= save_domain
;
912 router_name
= transport_name
= NULL
;
914 #endif /*DISABLE_EVENT*/
918 /******************************************************************************/
921 /*************************************************
922 * Generate local prt for logging *
923 *************************************************/
925 /* This function is a subroutine for use in string_log_address() below.
928 addr the address being logged
929 yield the current dynamic buffer pointer
931 Returns: the new value of the buffer pointer
935 string_get_localpart(address_item
* addr
, gstring
* yield
)
940 if (testflag(addr
, af_include_affixes
) && s
)
943 if (testflag(addr
, af_utf8_downcvt
))
944 s
= string_localpart_utf8_to_alabel(s
, NULL
);
946 yield
= string_cat(yield
, s
);
949 s
= addr
->local_part
;
951 if (testflag(addr
, af_utf8_downcvt
))
952 s
= string_localpart_utf8_to_alabel(s
, NULL
);
954 yield
= string_cat(yield
, s
);
957 if (testflag(addr
, af_include_affixes
) && s
)
960 if (testflag(addr
, af_utf8_downcvt
))
961 s
= string_localpart_utf8_to_alabel(s
, NULL
);
963 yield
= string_cat(yield
, s
);
970 /*************************************************
971 * Generate log address list *
972 *************************************************/
974 /* This function generates a list consisting of an address and its parents, for
975 use in logging lines. For saved onetime aliased addresses, the onetime parent
976 field is used. If the address was delivered by a transport with rcpt_include_
977 affixes set, the af_include_affixes bit will be set in the address. In that
978 case, we include the affixes here too.
981 g points to growing-string struct
982 addr bottom (ultimate) address
983 all_parents if TRUE, include all parents
984 success TRUE for successful delivery
986 Returns: a growable string in dynamic store
990 string_log_address(gstring
* g
,
991 address_item
*addr
, BOOL all_parents
, BOOL success
)
993 BOOL add_topaddr
= TRUE
;
994 address_item
*topaddr
;
996 /* Find the ultimate parent */
998 for (topaddr
= addr
; topaddr
->parent
; topaddr
= topaddr
->parent
) ;
1000 /* We start with just the local part for pipe, file, and reply deliveries, and
1001 for successful local deliveries from routers that have the log_as_local flag
1002 set. File deliveries from filters can be specified as non-absolute paths in
1003 cases where the transport is going to complete the path. If there is an error
1004 before this happens (expansion failure) the local part will not be updated, and
1005 so won't necessarily look like a path. Add extra text for this case. */
1007 if ( testflag(addr
, af_pfr
)
1009 && addr
->router
&& addr
->router
->log_as_local
1010 && addr
->transport
&& addr
->transport
->info
->local
1013 if (testflag(addr
, af_file
) && addr
->local_part
[0] != '/')
1014 g
= string_catn(g
, CUS
"save ", 5);
1015 g
= string_get_localpart(addr
, g
);
1018 /* Other deliveries start with the full address. It we have split it into local
1019 part and domain, use those fields. Some early failures can happen before the
1020 splitting is done; in those cases use the original field. */
1024 uschar
* cmp
= g
->s
+ g
->ptr
;
1026 if (addr
->local_part
)
1029 g
= string_get_localpart(addr
, g
);
1030 g
= string_catn(g
, US
"@", 1);
1033 if (testflag(addr
, af_utf8_downcvt
))
1034 s
= string_localpart_utf8_to_alabel(s
, NULL
);
1036 g
= string_cat(g
, s
);
1039 g
= string_cat(g
, addr
->address
);
1041 /* If the address we are going to print is the same as the top address,
1042 and all parents are not being included, don't add on the top address. First
1043 of all, do a caseless comparison; if this succeeds, do a caseful comparison
1044 on the local parts. */
1046 string_from_gstring(g
); /* ensure nul-terminated */
1047 if ( strcmpic(cmp
, topaddr
->address
) == 0
1048 && Ustrncmp(cmp
, topaddr
->address
, Ustrchr(cmp
, '@') - cmp
) == 0
1049 && !addr
->onetime_parent
1050 && (!all_parents
|| !addr
->parent
|| addr
->parent
== topaddr
)
1052 add_topaddr
= FALSE
;
1055 /* If all parents are requested, or this is a local pipe/file/reply, and
1056 there is at least one intermediate parent, show it in brackets, and continue
1057 with all of them if all are wanted. */
1059 if ( (all_parents
|| testflag(addr
, af_pfr
))
1061 && addr
->parent
!= topaddr
)
1064 address_item
*addr2
;
1065 for (addr2
= addr
->parent
; addr2
!= topaddr
; addr2
= addr2
->parent
)
1067 g
= string_catn(g
, s
, 2);
1068 g
= string_cat (g
, addr2
->address
);
1069 if (!all_parents
) break;
1072 g
= string_catn(g
, US
")", 1);
1075 /* Add the top address if it is required */
1078 g
= string_append(g
, 3,
1080 addr
->onetime_parent ? addr
->onetime_parent
: topaddr
->address
,
1089 timesince(struct timeval
* diff
, struct timeval
* then
)
1091 gettimeofday(diff
, NULL
);
1092 diff
->tv_sec
-= then
->tv_sec
;
1093 if ((diff
->tv_usec
-= then
->tv_usec
) < 0)
1096 diff
->tv_usec
+= 1000*1000;
1103 string_timediff(struct timeval
* diff
)
1105 static uschar buf
[sizeof("0.000s")];
1107 if (diff
->tv_sec
>= 5 || !LOGGING(millisec
))
1108 return readconf_printtime((int)diff
->tv_sec
);
1110 sprintf(CS buf
, "%u.%03us", (uint
)diff
->tv_sec
, (uint
)diff
->tv_usec
/1000);
1116 string_timesince(struct timeval
* then
)
1118 struct timeval diff
;
1120 timesince(&diff
, then
);
1121 return string_timediff(&diff
);
1124 /******************************************************************************/
1128 /* If msg is NULL this is a delivery log and logchar is used. Otherwise
1129 this is a nonstandard call; no two-character delivery flag is written
1130 but sender-host and sender are prefixed and "msg" is inserted in the log line.
1133 flags passed to log_write()
1136 delivery_log(int flags
, address_item
* addr
, int logchar
, uschar
* msg
)
1138 gstring
* g
; /* Used for a temporary, expanding buffer, for building log lines */
1139 void * reset_point
; /* released afterwards. */
1141 /* Log the delivery on the main log. We use an extensible string to build up
1142 the log line, and reset the store afterwards. Remote deliveries should always
1143 have a pointer to the host item that succeeded; local deliveries can have a
1144 pointer to a single host item in their host list, for use by the transport. */
1146 #ifndef DISABLE_EVENT
1147 /* presume no successful remote delivery */
1148 lookup_dnssec_authenticated
= NULL
;
1151 g
= reset_point
= string_get(256);
1154 g
= string_append(g
, 2, host_and_ident(TRUE
), US
" ");
1157 g
->s
[0] = logchar
; g
->ptr
= 1;
1158 g
= string_catn(g
, US
"> ", 2);
1160 g
= string_log_address(g
, addr
, LOGGING(all_parents
), TRUE
);
1162 if (LOGGING(sender_on_delivery
) || msg
)
1163 g
= string_append(g
, 3, US
" F=<",
1165 testflag(addr
, af_utf8_downcvt
)
1166 ?
string_address_utf8_to_alabel(sender_address
, NULL
)
1173 g
= string_append(g
, 2, US
" Q=", queue_name
);
1175 #ifdef EXPERIMENTAL_SRS
1176 if(addr
->prop
.srs_sender
)
1177 g
= string_append(g
, 3, US
" SRS=<", addr
->prop
.srs_sender
, US
">");
1180 /* You might think that the return path must always be set for a successful
1181 delivery; indeed, I did for some time, until this statement crashed. The case
1182 when it is not set is for a delivery to /dev/null which is optimised by not
1183 being run at all. */
1185 if (used_return_path
&& LOGGING(return_path_on_delivery
))
1186 g
= string_append(g
, 3, US
" P=<", used_return_path
, US
">");
1189 g
= string_append(g
, 2, US
" ", msg
);
1191 /* For a delivery from a system filter, there may not be a router */
1193 g
= string_append(g
, 2, US
" R=", addr
->router
->name
);
1195 g
= string_append(g
, 2, US
" T=", addr
->transport
->name
);
1197 if (LOGGING(delivery_size
))
1198 g
= string_fmt_append(g
, " S=%d", transport_count
);
1200 /* Local delivery */
1202 if (addr
->transport
->info
->local
)
1204 if (addr
->host_list
)
1205 g
= string_append(g
, 2, US
" H=", addr
->host_list
->name
);
1206 g
= d_log_interface(g
);
1207 if (addr
->shadow_message
)
1208 g
= string_cat(g
, addr
->shadow_message
);
1211 /* Remote delivery */
1215 if (addr
->host_used
)
1217 g
= d_hostlog(g
, addr
);
1218 if (continue_sequence
> 1)
1219 g
= string_catn(g
, US
"*", 1);
1221 #ifndef DISABLE_EVENT
1222 deliver_host_address
= addr
->host_used
->address
;
1223 deliver_host_port
= addr
->host_used
->port
;
1224 deliver_host
= addr
->host_used
->name
;
1226 /* DNS lookup status */
1227 lookup_dnssec_authenticated
= addr
->host_used
->dnssec
==DS_YES ? US
"yes"
1228 : addr
->host_used
->dnssec
==DS_NO ? US
"no"
1234 g
= d_tlslog(g
, addr
);
1237 if (addr
->authenticator
)
1239 g
= string_append(g
, 2, US
" A=", addr
->authenticator
);
1242 g
= string_append(g
, 2, US
":", addr
->auth_id
);
1243 if (LOGGING(smtp_mailauth
) && addr
->auth_sndr
)
1244 g
= string_append(g
, 2, US
":", addr
->auth_sndr
);
1248 if (LOGGING(pipelining
))
1250 if (testflag(addr
, af_pipelining
))
1251 g
= string_catn(g
, US
" L", 2);
1252 #ifdef EXPERIMENTAL_PIPE_CONNECT
1253 if (testflag(addr
, af_early_pipe
))
1254 g
= string_catn(g
, US
"*", 1);
1258 #ifndef DISABLE_PRDR
1259 if (testflag(addr
, af_prdr_used
))
1260 g
= string_catn(g
, US
" PRDR", 5);
1263 if (testflag(addr
, af_chunking_used
))
1264 g
= string_catn(g
, US
" K", 2);
1267 /* confirmation message (SMTP (host_used) and LMTP (driver_name)) */
1269 if ( LOGGING(smtp_confirmation
)
1271 && (addr
->host_used
|| Ustrcmp(addr
->transport
->driver_name
, "lmtp") == 0)
1275 unsigned lim
= big_buffer_size
< 1024 ? big_buffer_size
: 1024;
1276 uschar
*p
= big_buffer
;
1277 uschar
*ss
= addr
->message
;
1279 for (i
= 0; i
< lim
&& ss
[i
] != 0; i
++) /* limit logged amount */
1281 if (ss
[i
] == '\"' || ss
[i
] == '\\') *p
++ = '\\'; /* quote \ and " */
1286 g
= string_append(g
, 2, US
" C=", big_buffer
);
1289 /* Time on queue and actual time taken to deliver */
1291 if (LOGGING(queue_time
))
1292 g
= string_append(g
, 2, US
" QT=",
1293 string_timesince(&received_time
));
1295 if (LOGGING(deliver_time
))
1297 struct timeval diff
= {.tv_sec
= addr
->more_errno
, .tv_usec
= addr
->delivery_usec
};
1298 g
= string_append(g
, 2, US
" DT=", string_timediff(&diff
));
1301 /* string_cat() always leaves room for the terminator. Release the
1302 store we used to build the line after writing it. */
1304 log_write(0, flags
, "%s", string_from_gstring(g
));
1306 #ifndef DISABLE_EVENT
1307 if (!msg
) msg_event_raise(US
"msg:delivery", addr
);
1310 store_reset(reset_point
);
1317 deferral_log(address_item
* addr
, uschar
* now
,
1318 int logflags
, uschar
* driver_name
, uschar
* driver_kind
)
1323 /* Build up the line that is used for both the message log and the main
1326 g
= reset_point
= string_get(256);
1328 /* Create the address string for logging. Must not do this earlier, because
1329 an OK result may be changed to FAIL when a pipe returns text. */
1331 g
= string_log_address(g
, addr
, LOGGING(all_parents
), FALSE
);
1334 g
= string_append(g
, 2, US
" Q=", queue_name
);
1336 /* Either driver_name contains something and driver_kind contains
1337 " router" or " transport" (note the leading space), or driver_name is
1338 a null string and driver_kind contains "routing" without the leading
1339 space, if all routing has been deferred. When a domain has been held,
1340 so nothing has been done at all, both variables contain null strings. */
1344 if (driver_kind
[1] == 't' && addr
->router
)
1345 g
= string_append(g
, 2, US
" R=", addr
->router
->name
);
1346 g
= string_fmt_append(g
, " %c=%s", toupper(driver_kind
[1]), driver_name
);
1348 else if (driver_kind
)
1349 g
= string_append(g
, 2, US
" ", driver_kind
);
1351 g
= string_fmt_append(g
, " defer (%d)", addr
->basic_errno
);
1353 if (addr
->basic_errno
> 0)
1354 g
= string_append(g
, 2, US
": ",
1355 US
strerror(addr
->basic_errno
));
1357 if (addr
->host_used
)
1359 g
= string_append(g
, 5,
1360 US
" H=", addr
->host_used
->name
,
1361 US
" [", addr
->host_used
->address
, US
"]");
1362 if (LOGGING(outgoing_port
))
1364 int port
= addr
->host_used
->port
;
1365 g
= string_fmt_append(g
, ":%d", port
== PORT_NONE ?
25 : port
);
1370 g
= string_append(g
, 2, US
": ", addr
->message
);
1372 (void) string_from_gstring(g
);
1374 /* Log the deferment in the message log, but don't clutter it
1375 up with retry-time defers after the first delivery attempt. */
1377 if (f
.deliver_firsttime
|| addr
->basic_errno
> ERRNO_RETRY_BASE
)
1378 deliver_msglog("%s %s\n", now
, g
->s
);
1380 /* Write the main log and reset the store.
1381 For errors of the type "retry time not reached" (also remotes skipped
1382 on queue run), logging is controlled by L_retry_defer. Note that this kind
1383 of error number is negative, and all the retry ones are less than any
1387 log_write(addr
->basic_errno
<= ERRNO_RETRY_BASE ? L_retry_defer
: 0, logflags
,
1390 store_reset(reset_point
);
1397 failure_log(address_item
* addr
, uschar
* driver_kind
, uschar
* now
)
1400 gstring
* g
= reset_point
= string_get(256);
1402 #ifndef DISABLE_EVENT
1403 /* Message failures for which we will send a DSN get their event raised
1404 later so avoid doing it here. */
1406 if ( !addr
->prop
.ignore_error
1407 && !(addr
->dsn_flags
& (rf_dsnflags
& ~rf_notify_failure
))
1409 msg_event_raise(US
"msg:fail:delivery", addr
);
1412 /* Build up the log line for the message and main logs */
1414 /* Create the address string for logging. Must not do this earlier, because
1415 an OK result may be changed to FAIL when a pipe returns text. */
1417 g
= string_log_address(g
, addr
, LOGGING(all_parents
), FALSE
);
1419 if (LOGGING(sender_on_delivery
))
1420 g
= string_append(g
, 3, US
" F=<", sender_address
, US
">");
1423 g
= string_append(g
, 2, US
" Q=", queue_name
);
1425 /* Return path may not be set if no delivery actually happened */
1427 if (used_return_path
&& LOGGING(return_path_on_delivery
))
1428 g
= string_append(g
, 3, US
" P=<", used_return_path
, US
">");
1431 g
= string_append(g
, 2, US
" R=", addr
->router
->name
);
1432 if (addr
->transport
)
1433 g
= string_append(g
, 2, US
" T=", addr
->transport
->name
);
1435 if (addr
->host_used
)
1436 g
= d_hostlog(g
, addr
);
1439 g
= d_tlslog(g
, addr
);
1442 if (addr
->basic_errno
> 0)
1443 g
= string_append(g
, 2, US
": ", US
strerror(addr
->basic_errno
));
1446 g
= string_append(g
, 2, US
": ", addr
->message
);
1448 (void) string_from_gstring(g
);
1450 /* Do the logging. For the message log, "routing failed" for those cases,
1451 just to make it clearer. */
1454 deliver_msglog("%s %s failed for %s\n", now
, driver_kind
, g
->s
);
1456 deliver_msglog("%s %s\n", now
, g
->s
);
1458 log_write(0, LOG_MAIN
, "** %s", g
->s
);
1460 store_reset(reset_point
);
1466 /*************************************************
1467 * Actions at the end of handling an address *
1468 *************************************************/
1470 /* This is a function for processing a single address when all that can be done
1471 with it has been done.
1474 addr points to the address block
1475 result the result of the delivery attempt
1476 logflags flags for log_write() (LOG_MAIN and/or LOG_PANIC)
1477 driver_type indicates which type of driver (transport, or router) was last
1478 to process the address
1479 logchar '=' or '-' for use when logging deliveries with => or ->
1485 post_process_one(address_item
*addr
, int result
, int logflags
, int driver_type
,
1488 uschar
*now
= tod_stamp(tod_log
);
1489 uschar
*driver_kind
= NULL
;
1490 uschar
*driver_name
= NULL
;
1492 DEBUG(D_deliver
) debug_printf("post-process %s (%d)\n", addr
->address
, result
);
1494 /* Set up driver kind and name for logging. Disable logging if the router or
1495 transport has disabled it. */
1497 if (driver_type
== EXIM_DTYPE_TRANSPORT
)
1499 if (addr
->transport
)
1501 driver_name
= addr
->transport
->name
;
1502 driver_kind
= US
" transport";
1503 f
.disable_logging
= addr
->transport
->disable_logging
;
1505 else driver_kind
= US
"transporting";
1507 else if (driver_type
== EXIM_DTYPE_ROUTER
)
1511 driver_name
= addr
->router
->name
;
1512 driver_kind
= US
" router";
1513 f
.disable_logging
= addr
->router
->disable_logging
;
1515 else driver_kind
= US
"routing";
1518 /* If there's an error message set, ensure that it contains only printing
1519 characters - it should, but occasionally things slip in and this at least
1520 stops the log format from getting wrecked. We also scan the message for an LDAP
1521 expansion item that has a password setting, and flatten the password. This is a
1522 fudge, but I don't know a cleaner way of doing this. (If the item is badly
1523 malformed, it won't ever have gone near LDAP.) */
1527 const uschar
* s
= string_printing(addr
->message
);
1529 /* deconst cast ok as string_printing known to have alloc'n'copied */
1530 addr
->message
= expand_hide_passwords(US s
);
1533 /* If we used a transport that has one of the "return_output" options set, and
1534 if it did in fact generate some output, then for return_output we treat the
1535 message as failed if it was not already set that way, so that the output gets
1536 returned to the sender, provided there is a sender to send it to. For
1537 return_fail_output, do this only if the delivery failed. Otherwise we just
1538 unlink the file, and remove the name so that if the delivery failed, we don't
1539 try to send back an empty or unwanted file. The log_output options operate only
1540 on a non-empty file.
1542 In any case, we close the message file, because we cannot afford to leave a
1543 file-descriptor for one address while processing (maybe very many) others. */
1545 if (addr
->return_file
>= 0 && addr
->return_filename
)
1547 BOOL return_output
= FALSE
;
1548 struct stat statbuf
;
1549 (void)EXIMfsync(addr
->return_file
);
1551 /* If there is no output, do nothing. */
1553 if (fstat(addr
->return_file
, &statbuf
) == 0 && statbuf
.st_size
> 0)
1555 transport_instance
*tb
= addr
->transport
;
1557 /* Handle logging options */
1560 || result
== FAIL
&& tb
->log_fail_output
1561 || result
== DEFER
&& tb
->log_defer_output
1565 FILE *f
= Ufopen(addr
->return_filename
, "rb");
1567 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to open %s to log output "
1568 "from %s transport: %s", addr
->return_filename
, tb
->name
,
1571 if ((s
= US
Ufgets(big_buffer
, big_buffer_size
, f
)))
1573 uschar
*p
= big_buffer
+ Ustrlen(big_buffer
);
1575 while (p
> big_buffer
&& isspace(p
[-1])) p
--;
1577 sp
= string_printing(big_buffer
);
1578 log_write(0, LOG_MAIN
, "<%s>: %s transport output: %s",
1579 addr
->address
, tb
->name
, sp
);
1584 /* Handle returning options, but only if there is an address to return
1587 if (sender_address
[0] != 0 || addr
->prop
.errors_address
)
1588 if (tb
->return_output
)
1590 addr
->transport_return
= result
= FAIL
;
1591 if (addr
->basic_errno
== 0 && !addr
->message
)
1592 addr
->message
= US
"return message generated";
1593 return_output
= TRUE
;
1596 if (tb
->return_fail_output
&& result
== FAIL
) return_output
= TRUE
;
1599 /* Get rid of the file unless it might be returned, but close it in
1604 Uunlink(addr
->return_filename
);
1605 addr
->return_filename
= NULL
;
1606 addr
->return_file
= -1;
1609 (void)close(addr
->return_file
);
1612 /* The success case happens only after delivery by a transport. */
1616 addr
->next
= addr_succeed
;
1617 addr_succeed
= addr
;
1619 /* Call address_done() to ensure that we don't deliver to this address again,
1620 and write appropriate things to the message log. If it is a child address, we
1621 call child_done() to scan the ancestors and mark them complete if this is the
1622 last child to complete. */
1624 address_done(addr
, now
);
1625 DEBUG(D_deliver
) debug_printf("%s delivered\n", addr
->address
);
1628 deliver_msglog("%s %s: %s%s succeeded\n", now
, addr
->address
,
1629 driver_name
, driver_kind
);
1632 deliver_msglog("%s %s <%s>: %s%s succeeded\n", now
, addr
->address
,
1633 addr
->parent
->address
, driver_name
, driver_kind
);
1634 child_done(addr
, now
);
1637 /* Certificates for logging (via events) */
1639 tls_out
.ourcert
= addr
->ourcert
;
1640 addr
->ourcert
= NULL
;
1641 tls_out
.peercert
= addr
->peercert
;
1642 addr
->peercert
= NULL
;
1644 tls_out
.cipher
= addr
->cipher
;
1645 tls_out
.peerdn
= addr
->peerdn
;
1646 tls_out
.ocsp
= addr
->ocsp
;
1647 # ifdef SUPPORT_DANE
1648 tls_out
.dane_verified
= testflag(addr
, af_dane_verified
);
1652 delivery_log(LOG_MAIN
, addr
, logchar
, NULL
);
1655 tls_free_cert(&tls_out
.ourcert
);
1656 tls_free_cert(&tls_out
.peercert
);
1657 tls_out
.cipher
= NULL
;
1658 tls_out
.peerdn
= NULL
;
1659 tls_out
.ocsp
= OCSP_NOT_REQ
;
1660 # ifdef SUPPORT_DANE
1661 tls_out
.dane_verified
= FALSE
;
1667 /* Soft failure, or local delivery process failed; freezing may be
1670 else if (result
== DEFER
|| result
== PANIC
)
1672 if (result
== PANIC
) logflags
|= LOG_PANIC
;
1674 /* This puts them on the chain in reverse order. Do not change this, because
1675 the code for handling retries assumes that the one with the retry
1676 information is last. */
1678 addr
->next
= addr_defer
;
1681 /* The only currently implemented special action is to freeze the
1682 message. Logging of this is done later, just before the -H file is
1685 if (addr
->special_action
== SPECIAL_FREEZE
)
1687 f
.deliver_freeze
= TRUE
;
1688 deliver_frozen_at
= time(NULL
);
1689 update_spool
= TRUE
;
1692 /* If doing a 2-stage queue run, we skip writing to either the message
1693 log or the main log for SMTP defers. */
1695 if (!f
.queue_2stage
|| addr
->basic_errno
!= 0)
1696 deferral_log(addr
, now
, logflags
, driver_name
, driver_kind
);
1700 /* Hard failure. If there is an address to which an error message can be sent,
1701 put this address on the failed list. If not, put it on the deferred list and
1702 freeze the mail message for human attention. The latter action can also be
1703 explicitly requested by a router or transport. */
1707 /* If this is a delivery error, or a message for which no replies are
1708 wanted, and the message's age is greater than ignore_bounce_errors_after,
1709 force the af_ignore_error flag. This will cause the address to be discarded
1710 later (with a log entry). */
1712 if (!*sender_address
&& message_age
>= ignore_bounce_errors_after
)
1713 addr
->prop
.ignore_error
= TRUE
;
1715 /* Freeze the message if requested, or if this is a bounce message (or other
1716 message with null sender) and this address does not have its own errors
1717 address. However, don't freeze if errors are being ignored. The actual code
1718 to ignore occurs later, instead of sending a message. Logging of freezing
1719 occurs later, just before writing the -H file. */
1721 if ( !addr
->prop
.ignore_error
1722 && ( addr
->special_action
== SPECIAL_FREEZE
1723 || (sender_address
[0] == 0 && !addr
->prop
.errors_address
)
1726 frozen_info
= addr
->special_action
== SPECIAL_FREEZE
1728 : f
.sender_local
&& !f
.local_error_message
1729 ? US
" (message created with -f <>)"
1730 : US
" (delivery error message)";
1731 f
.deliver_freeze
= TRUE
;
1732 deliver_frozen_at
= time(NULL
);
1733 update_spool
= TRUE
;
1735 /* The address is put on the defer rather than the failed queue, because
1736 the message is being retained. */
1738 addr
->next
= addr_defer
;
1742 /* Don't put the address on the nonrecipients tree yet; wait until an
1743 error message has been successfully sent. */
1747 addr
->next
= addr_failed
;
1751 failure_log(addr
, driver_name ? NULL
: driver_kind
, now
);
1754 /* Ensure logging is turned on again in all cases */
1756 f
.disable_logging
= FALSE
;
1762 /*************************************************
1763 * Address-independent error *
1764 *************************************************/
1766 /* This function is called when there's an error that is not dependent on a
1767 particular address, such as an expansion string failure. It puts the error into
1768 all the addresses in a batch, logs the incident on the main and panic logs, and
1769 clears the expansions. It is mostly called from local_deliver(), but can be
1770 called for a remote delivery via findugid().
1773 logit TRUE if (MAIN+PANIC) logging required
1774 addr the first of the chain of addresses
1776 format format string for error message, or NULL if already set in addr
1777 ... arguments for the format
1783 common_error(BOOL logit
, address_item
*addr
, int code
, uschar
*format
, ...)
1785 address_item
*addr2
;
1786 addr
->basic_errno
= code
;
1793 va_start(ap
, format
);
1794 g
= string_vformat(NULL
, TRUE
, CS format
, ap
);
1796 addr
->message
= string_from_gstring(g
);
1799 for (addr2
= addr
->next
; addr2
; addr2
= addr2
->next
)
1801 addr2
->basic_errno
= code
;
1802 addr2
->message
= addr
->message
;
1805 if (logit
) log_write(0, LOG_MAIN
|LOG_PANIC
, "%s", addr
->message
);
1806 deliver_set_expansions(NULL
);
1812 /*************************************************
1813 * Check a "never users" list *
1814 *************************************************/
1816 /* This function is called to check whether a uid is on one of the two "never
1820 uid the uid to be checked
1821 nusers the list to be scanned; the first item in the list is the count
1823 Returns: TRUE if the uid is on the list
1827 check_never_users(uid_t uid
, uid_t
*nusers
)
1830 if (!nusers
) return FALSE
;
1831 for (i
= 1; i
<= (int)(nusers
[0]); i
++) if (nusers
[i
] == uid
) return TRUE
;
1837 /*************************************************
1838 * Find uid and gid for a transport *
1839 *************************************************/
1841 /* This function is called for both local and remote deliveries, to find the
1842 uid/gid under which to run the delivery. The values are taken preferentially
1843 from the transport (either explicit or deliver_as_creator), then from the
1844 address (i.e. the router), and if nothing is set, the exim uid/gid are used. If
1845 the resulting uid is on the "never_users" or the "fixed_never_users" list, a
1846 panic error is logged, and the function fails (which normally leads to delivery
1850 addr the address (possibly a chain)
1852 uidp pointer to uid field
1853 gidp pointer to gid field
1854 igfp pointer to the use_initgroups field
1856 Returns: FALSE if failed - error has been set in address(es)
1860 findugid(address_item
*addr
, transport_instance
*tp
, uid_t
*uidp
, gid_t
*gidp
,
1864 BOOL gid_set
= FALSE
;
1866 /* Default initgroups flag comes from the transport */
1868 *igfp
= tp
->initgroups
;
1870 /* First see if there's a gid on the transport, either fixed or expandable.
1871 The expanding function always logs failure itself. */
1878 else if (tp
->expand_gid
)
1880 if (!route_find_expanded_group(tp
->expand_gid
, tp
->name
, US
"transport", gidp
,
1883 common_error(FALSE
, addr
, ERRNO_GIDFAIL
, NULL
);
1889 /* If the transport did not set a group, see if the router did. */
1891 if (!gid_set
&& testflag(addr
, af_gid_set
))
1897 /* Pick up a uid from the transport if one is set. */
1899 if (tp
->uid_set
) *uidp
= tp
->uid
;
1901 /* Otherwise, try for an expandable uid field. If it ends up as a numeric id,
1902 it does not provide a passwd value from which a gid can be taken. */
1904 else if (tp
->expand_uid
)
1907 if (!route_find_expanded_user(tp
->expand_uid
, tp
->name
, US
"transport", &pw
,
1908 uidp
, &(addr
->message
)))
1910 common_error(FALSE
, addr
, ERRNO_UIDFAIL
, NULL
);
1920 /* If the transport doesn't set the uid, test the deliver_as_creator flag. */
1922 else if (tp
->deliver_as_creator
)
1924 *uidp
= originator_uid
;
1927 *gidp
= originator_gid
;
1932 /* Otherwise see if the address specifies the uid and if so, take it and its
1935 else if (testflag(addr
, af_uid_set
))
1938 *igfp
= testflag(addr
, af_initgroups
);
1941 /* Nothing has specified the uid - default to the Exim user, and group if the
1954 /* If no gid is set, it is a disaster. We default to the Exim gid only if
1955 defaulting to the Exim uid. In other words, if the configuration has specified
1956 a uid, it must also provide a gid. */
1960 common_error(TRUE
, addr
, ERRNO_GIDFAIL
, US
"User set without group for "
1961 "%s transport", tp
->name
);
1965 /* Check that the uid is not on the lists of banned uids that may not be used
1966 for delivery processes. */
1968 nuname
= check_never_users(*uidp
, never_users
)
1970 : check_never_users(*uidp
, fixed_never_users
)
1971 ? US
"fixed_never_users"
1975 common_error(TRUE
, addr
, ERRNO_UIDFAIL
, US
"User %ld set for %s transport "
1976 "is on the %s list", (long int)(*uidp
), tp
->name
, nuname
);
1988 /*************************************************
1989 * Check the size of a message for a transport *
1990 *************************************************/
1992 /* Checks that the message isn't too big for the selected transport.
1993 This is called only when it is known that the limit is set.
1997 addr the (first) address being delivered
2000 DEFER expansion failed or did not yield an integer
2001 FAIL message too big
2005 check_message_size(transport_instance
*tp
, address_item
*addr
)
2010 deliver_set_expansions(addr
);
2011 size_limit
= expand_string_integer(tp
->message_size_limit
, TRUE
);
2012 deliver_set_expansions(NULL
);
2014 if (expand_string_message
)
2017 addr
->message
= size_limit
== -1
2018 ?
string_sprintf("failed to expand message_size_limit "
2019 "in %s transport: %s", tp
->name
, expand_string_message
)
2020 : string_sprintf("invalid message_size_limit "
2021 "in %s transport: %s", tp
->name
, expand_string_message
);
2023 else if (size_limit
> 0 && message_size
> size_limit
)
2027 string_sprintf("message is too big (transport limit = %d)",
2036 /*************************************************
2037 * Transport-time check for a previous delivery *
2038 *************************************************/
2040 /* Check that this base address hasn't previously been delivered to its routed
2041 transport. If it has been delivered, mark it done. The check is necessary at
2042 delivery time in order to handle homonymic addresses correctly in cases where
2043 the pattern of redirection changes between delivery attempts (so the unique
2044 fields change). Non-homonymic previous delivery is detected earlier, at routing
2045 time (which saves unnecessary routing).
2048 addr the address item
2049 testing TRUE if testing wanted only, without side effects
2051 Returns: TRUE if previously delivered by the transport
2055 previously_transported(address_item
*addr
, BOOL testing
)
2057 (void)string_format(big_buffer
, big_buffer_size
, "%s/%s",
2058 addr
->unique
+ (testflag(addr
, af_homonym
)?
3:0), addr
->transport
->name
);
2060 if (tree_search(tree_nonrecipients
, big_buffer
) != 0)
2062 DEBUG(D_deliver
|D_route
|D_transport
)
2063 debug_printf("%s was previously delivered (%s transport): discarded\n",
2064 addr
->address
, addr
->transport
->name
);
2065 if (!testing
) child_done(addr
, tod_stamp(tod_log
));
2074 /******************************************************
2075 * Check for a given header in a header string *
2076 ******************************************************/
2078 /* This function is used when generating quota warnings. The configuration may
2079 specify any header lines it likes in quota_warn_message. If certain of them are
2080 missing, defaults are inserted, so we need to be able to test for the presence
2084 hdr the required header name
2085 hstring the header string
2087 Returns: TRUE the header is in the string
2088 FALSE the header is not in the string
2092 contains_header(uschar
*hdr
, uschar
*hstring
)
2094 int len
= Ustrlen(hdr
);
2095 uschar
*p
= hstring
;
2098 if (strncmpic(p
, hdr
, len
) == 0)
2101 while (*p
== ' ' || *p
== '\t') p
++;
2102 if (*p
== ':') return TRUE
;
2104 while (*p
!= 0 && *p
!= '\n') p
++;
2105 if (*p
== '\n') p
++;
2113 /*************************************************
2114 * Perform a local delivery *
2115 *************************************************/
2117 /* Each local delivery is performed in a separate process which sets its
2118 uid and gid as specified. This is a safer way than simply changing and
2119 restoring using seteuid(); there is a body of opinion that seteuid() cannot be
2120 used safely. From release 4, Exim no longer makes any use of it. Besides, not
2121 all systems have seteuid().
2123 If the uid/gid are specified in the transport_instance, they are used; the
2124 transport initialization must ensure that either both or neither are set.
2125 Otherwise, the values associated with the address are used. If neither are set,
2126 it is a configuration error.
2128 The transport or the address may specify a home directory (transport over-
2129 rides), and if they do, this is set as $home. If neither have set a working
2130 directory, this value is used for that as well. Otherwise $home is left unset
2131 and the cwd is set to "/" - a directory that should be accessible to all users.
2133 Using a separate process makes it more complicated to get error information
2134 back. We use a pipe to pass the return code and also an error code and error
2135 text string back to the parent process.
2138 addr points to an address block for this delivery; for "normal" local
2139 deliveries this is the only address to be delivered, but for
2140 pseudo-remote deliveries (e.g. by batch SMTP to a file or pipe)
2141 a number of addresses can be handled simultaneously, and in this
2142 case addr will point to a chain of addresses with the same
2145 shadowing TRUE if running a shadow transport; this causes output from pipes
2152 deliver_local(address_item
*addr
, BOOL shadowing
)
2154 BOOL use_initgroups
;
2157 int status
, len
, rc
;
2160 uschar
*working_directory
;
2161 address_item
*addr2
;
2162 transport_instance
*tp
= addr
->transport
;
2164 /* Set up the return path from the errors or sender address. If the transport
2165 has its own return path setting, expand it and replace the existing value. */
2167 if(addr
->prop
.errors_address
)
2168 return_path
= addr
->prop
.errors_address
;
2169 #ifdef EXPERIMENTAL_SRS
2170 else if (addr
->prop
.srs_sender
)
2171 return_path
= addr
->prop
.srs_sender
;
2174 return_path
= sender_address
;
2176 if (tp
->return_path
)
2178 uschar
*new_return_path
= expand_string(tp
->return_path
);
2179 if (!new_return_path
)
2181 if (!f
.expand_string_forcedfail
)
2183 common_error(TRUE
, addr
, ERRNO_EXPANDFAIL
,
2184 US
"Failed to expand return path \"%s\" in %s transport: %s",
2185 tp
->return_path
, tp
->name
, expand_string_message
);
2189 else return_path
= new_return_path
;
2192 /* For local deliveries, one at a time, the value used for logging can just be
2193 set directly, once and for all. */
2195 used_return_path
= return_path
;
2197 /* Sort out the uid, gid, and initgroups flag. If an error occurs, the message
2198 gets put into the address(es), and the expansions are unset, so we can just
2201 if (!findugid(addr
, tp
, &uid
, &gid
, &use_initgroups
)) return;
2203 /* See if either the transport or the address specifies a home directory. A
2204 home directory set in the address may already be expanded; a flag is set to
2205 indicate that. In other cases we must expand it. */
2207 if ( (deliver_home
= tp
->home_dir
) /* Set in transport, or */
2208 || ( (deliver_home
= addr
->home_dir
) /* Set in address and */
2209 && !testflag(addr
, af_home_expanded
) /* not expanded */
2212 uschar
*rawhome
= deliver_home
;
2213 deliver_home
= NULL
; /* in case it contains $home */
2214 if (!(deliver_home
= expand_string(rawhome
)))
2216 common_error(TRUE
, addr
, ERRNO_EXPANDFAIL
, US
"home directory \"%s\" failed "
2217 "to expand for %s transport: %s", rawhome
, tp
->name
,
2218 expand_string_message
);
2221 if (*deliver_home
!= '/')
2223 common_error(TRUE
, addr
, ERRNO_NOTABSOLUTE
, US
"home directory path \"%s\" "
2224 "is not absolute for %s transport", deliver_home
, tp
->name
);
2229 /* See if either the transport or the address specifies a current directory,
2230 and if so, expand it. If nothing is set, use the home directory, unless it is
2231 also unset in which case use "/", which is assumed to be a directory to which
2232 all users have access. It is necessary to be in a visible directory for some
2233 operating systems when running pipes, as some commands (e.g. "rm" under Solaris
2234 2.5) require this. */
2236 working_directory
= tp
->current_dir ? tp
->current_dir
: addr
->current_dir
;
2237 if (working_directory
)
2239 uschar
*raw
= working_directory
;
2240 if (!(working_directory
= expand_string(raw
)))
2242 common_error(TRUE
, addr
, ERRNO_EXPANDFAIL
, US
"current directory \"%s\" "
2243 "failed to expand for %s transport: %s", raw
, tp
->name
,
2244 expand_string_message
);
2247 if (*working_directory
!= '/')
2249 common_error(TRUE
, addr
, ERRNO_NOTABSOLUTE
, US
"current directory path "
2250 "\"%s\" is not absolute for %s transport", working_directory
, tp
->name
);
2254 else working_directory
= deliver_home ? deliver_home
: US
"/";
2256 /* If one of the return_output flags is set on the transport, create and open a
2257 file in the message log directory for the transport to write its output onto.
2258 This is mainly used by pipe transports. The file needs to be unique to the
2259 address. This feature is not available for shadow transports. */
2262 && ( tp
->return_output
|| tp
->return_fail_output
2263 || tp
->log_output
|| tp
->log_fail_output
|| tp
->log_defer_output
2268 addr
->return_filename
=
2269 spool_fname(US
"msglog", message_subdir
, message_id
,
2270 string_sprintf("-%d-%d", getpid(), return_count
++));
2272 if ((addr
->return_file
= open_msglog_file(addr
->return_filename
, 0400, &error
)) < 0)
2274 common_error(TRUE
, addr
, errno
, US
"Unable to %s file for %s transport "
2275 "to return message: %s", error
, tp
->name
, strerror(errno
));
2280 /* Create the pipe for inter-process communication. */
2284 common_error(TRUE
, addr
, ERRNO_PIPEFAIL
, US
"Creation of pipe failed: %s",
2289 /* Now fork the process to do the real work in the subprocess, but first
2290 ensure that all cached resources are freed so that the subprocess starts with
2291 a clean slate and doesn't interfere with the parent process. */
2295 if ((pid
= fork()) == 0)
2297 BOOL replicate
= TRUE
;
2299 /* Prevent core dumps, as we don't want them in users' home directories.
2300 HP-UX doesn't have RLIMIT_CORE; I don't know how to do this in that
2301 system. Some experimental/developing systems (e.g. GNU/Hurd) may define
2302 RLIMIT_CORE but not support it in setrlimit(). For such systems, do not
2303 complain if the error is "not supported".
2305 There are two scenarios where changing the max limit has an effect. In one,
2306 the user is using a .forward and invoking a command of their choice via pipe;
2307 for these, we do need the max limit to be 0 unless the admin chooses to
2308 permit an increased limit. In the other, the command is invoked directly by
2309 the transport and is under administrator control, thus being able to raise
2310 the limit aids in debugging. So there's no general always-right answer.
2312 Thus we inhibit core-dumps completely but let individual transports, while
2313 still root, re-raise the limits back up to aid debugging. We make the
2314 default be no core-dumps -- few enough people can use core dumps in
2315 diagnosis that it's reasonable to make them something that has to be explicitly requested.
2322 if (setrlimit(RLIMIT_CORE
, &rl
) < 0)
2324 # ifdef SETRLIMIT_NOT_SUPPORTED
2325 if (errno
!= ENOSYS
&& errno
!= ENOTSUP
)
2327 log_write(0, LOG_MAIN
|LOG_PANIC
, "setrlimit(RLIMIT_CORE) failed: %s",
2332 /* Reset the random number generator, so different processes don't all
2333 have the same sequence. */
2337 /* If the transport has a setup entry, call this first, while still
2338 privileged. (Appendfile uses this to expand quota, for example, while
2339 able to read private files.) */
2341 if (addr
->transport
->setup
)
2342 switch((addr
->transport
->setup
)(addr
->transport
, addr
, NULL
, uid
, gid
,
2346 addr
->transport_return
= DEFER
;
2350 addr
->transport_return
= PANIC
;
2354 /* Ignore SIGINT and SIGTERM during delivery. Also ignore SIGUSR1, as
2355 when the process becomes unprivileged, it won't be able to write to the
2356 process log. SIGHUP is ignored throughout exim, except when it is being
2359 signal(SIGINT
, SIG_IGN
);
2360 signal(SIGTERM
, SIG_IGN
);
2361 signal(SIGUSR1
, SIG_IGN
);
2363 /* Close the unwanted half of the pipe, and set close-on-exec for the other
2364 half - for transports that exec things (e.g. pipe). Then set the required
2367 (void)close(pfd
[pipe_read
]);
2368 (void)fcntl(pfd
[pipe_write
], F_SETFD
, fcntl(pfd
[pipe_write
], F_GETFD
) |
2370 exim_setugid(uid
, gid
, use_initgroups
,
2371 string_sprintf("local delivery to %s <%s> transport=%s", addr
->local_part
,
2372 addr
->address
, addr
->transport
->name
));
2376 address_item
*batched
;
2377 debug_printf(" home=%s current=%s\n", deliver_home
, working_directory
);
2378 for (batched
= addr
->next
; batched
; batched
= batched
->next
)
2379 debug_printf("additional batched address: %s\n", batched
->address
);
2382 /* Set an appropriate working directory. */
2384 if (Uchdir(working_directory
) < 0)
2386 addr
->transport_return
= DEFER
;
2387 addr
->basic_errno
= errno
;
2388 addr
->message
= string_sprintf("failed to chdir to %s", working_directory
);
2391 /* If successful, call the transport */
2396 set_process_info("delivering %s to %s using %s", message_id
,
2397 addr
->local_part
, addr
->transport
->name
);
2399 /* Setting this global in the subprocess means we need never clear it */
2400 transport_name
= addr
->transport
->name
;
2402 /* If a transport filter has been specified, set up its argument list.
2403 Any errors will get put into the address, and FALSE yielded. */
2405 if (addr
->transport
->filter_command
)
2407 ok
= transport_set_up_command(&transport_filter_argv
,
2408 addr
->transport
->filter_command
,
2409 TRUE
, PANIC
, addr
, US
"transport filter", NULL
);
2410 transport_filter_timeout
= addr
->transport
->filter_timeout
;
2412 else transport_filter_argv
= NULL
;
2416 debug_print_string(addr
->transport
->debug_string
);
2417 replicate
= !(addr
->transport
->info
->code
)(addr
->transport
, addr
);
2421 /* Pass the results back down the pipe. If necessary, first replicate the
2422 status in the top address to the others in the batch. The label is the
2423 subject of a goto when a call to the transport's setup function fails. We
2424 pass the pointer to the transport back in case it got changed as a result of
2425 file_format in appendfile. */
2429 if (replicate
) replicate_status(addr
);
2430 for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
2433 int local_part_length
= Ustrlen(addr2
->local_part
);
2437 if( (ret
= write(pfd
[pipe_write
], &addr2
->transport_return
, sizeof(int))) != sizeof(int)
2438 || (ret
= write(pfd
[pipe_write
], &transport_count
, sizeof(transport_count
))) != sizeof(transport_count
)
2439 || (ret
= write(pfd
[pipe_write
], &addr2
->flags
, sizeof(addr2
->flags
))) != sizeof(addr2
->flags
)
2440 || (ret
= write(pfd
[pipe_write
], &addr2
->basic_errno
, sizeof(int))) != sizeof(int)
2441 || (ret
= write(pfd
[pipe_write
], &addr2
->more_errno
, sizeof(int))) != sizeof(int)
2442 || (ret
= write(pfd
[pipe_write
], &addr2
->delivery_usec
, sizeof(int))) != sizeof(int)
2443 || (ret
= write(pfd
[pipe_write
], &addr2
->special_action
, sizeof(int))) != sizeof(int)
2444 || (ret
= write(pfd
[pipe_write
], &addr2
->transport
,
2445 sizeof(transport_instance
*))) != sizeof(transport_instance
*)
2447 /* For a file delivery, pass back the local part, in case the original
2448 was only part of the final delivery path. This gives more complete
2451 || (testflag(addr2
, af_file
)
2452 && ( (ret
= write(pfd
[pipe_write
], &local_part_length
, sizeof(int))) != sizeof(int)
2453 || (ret
= write(pfd
[pipe_write
], addr2
->local_part
, local_part_length
)) != local_part_length
2457 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed writing transport results to pipe: %s",
2458 ret
== -1 ?
strerror(errno
) : "short write");
2460 /* Now any messages */
2462 for (i
= 0, s
= addr2
->message
; i
< 2; i
++, s
= addr2
->user_message
)
2464 int message_length
= s ?
Ustrlen(s
) + 1 : 0;
2465 if( (ret
= write(pfd
[pipe_write
], &message_length
, sizeof(int))) != sizeof(int)
2466 || message_length
> 0 && (ret
= write(pfd
[pipe_write
], s
, message_length
)) != message_length
2468 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed writing transport results to pipe: %s",
2469 ret
== -1 ?
strerror(errno
) : "short write");
2473 /* OK, this process is now done. Free any cached resources that it opened,
2474 and close the pipe we were writing down before exiting. */
2476 (void)close(pfd
[pipe_write
]);
2481 /* Back in the main process: panic if the fork did not succeed. This seems
2482 better than returning an error - if forking is failing it is probably best
2483 not to try other deliveries for this message. */
2486 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Fork failed for local delivery to %s",
2489 /* Read the pipe to get the delivery status codes and error messages. Our copy
2490 of the writing end must be closed first, as otherwise read() won't return zero
2491 on an empty pipe. We check that a status exists for each address before
2492 overwriting the address structure. If data is missing, the default DEFER status
2493 will remain. Afterwards, close the reading end. */
2495 (void)close(pfd
[pipe_write
]);
2497 for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
2499 if ((len
= read(pfd
[pipe_read
], &status
, sizeof(int))) > 0)
2504 addr2
->transport_return
= status
;
2505 len
= read(pfd
[pipe_read
], &transport_count
,
2506 sizeof(transport_count
));
2507 len
= read(pfd
[pipe_read
], &addr2
->flags
, sizeof(addr2
->flags
));
2508 len
= read(pfd
[pipe_read
], &addr2
->basic_errno
, sizeof(int));
2509 len
= read(pfd
[pipe_read
], &addr2
->more_errno
, sizeof(int));
2510 len
= read(pfd
[pipe_read
], &addr2
->delivery_usec
, sizeof(int));
2511 len
= read(pfd
[pipe_read
], &addr2
->special_action
, sizeof(int));
2512 len
= read(pfd
[pipe_read
], &addr2
->transport
,
2513 sizeof(transport_instance
*));
2515 if (testflag(addr2
, af_file
))
2518 if ( read(pfd
[pipe_read
], &llen
, sizeof(int)) != sizeof(int)
2519 || llen
> 64*4 /* limit from rfc 5821, times I18N factor */
2522 log_write(0, LOG_MAIN
|LOG_PANIC
, "bad local_part length read"
2523 " from delivery subprocess");
2526 /* sanity-checked llen so disable the Coverity error */
2527 /* coverity[tainted_data] */
2528 if (read(pfd
[pipe_read
], big_buffer
, llen
) != llen
)
2530 log_write(0, LOG_MAIN
|LOG_PANIC
, "bad local_part read"
2531 " from delivery subprocess");
2534 big_buffer
[llen
] = 0;
2535 addr2
->local_part
= string_copy(big_buffer
);
2538 for (i
= 0, sptr
= &addr2
->message
; i
< 2; i
++, sptr
= &addr2
->user_message
)
2541 len
= read(pfd
[pipe_read
], &message_length
, sizeof(int));
2542 if (message_length
> 0)
2544 len
= read(pfd
[pipe_read
], big_buffer
, message_length
);
2545 big_buffer
[big_buffer_size
-1] = '\0'; /* guard byte */
2546 if (len
> 0) *sptr
= string_copy(big_buffer
);
2553 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to read delivery status for %s "
2554 "from delivery subprocess", addr2
->unique
);
2559 (void)close(pfd
[pipe_read
]);
2561 /* Unless shadowing, write all successful addresses immediately to the journal
2562 file, to ensure they are recorded asap. For homonymic addresses, use the base
2563 address plus the transport name. Failure to write the journal is panic-worthy,
2564 but don't stop, as it may prove possible subsequently to update the spool file
2565 in order to record the delivery. */
2569 for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
2570 if (addr2
->transport_return
== OK
)
2572 if (testflag(addr2
, af_homonym
))
2573 sprintf(CS big_buffer
, "%.500s/%s\n", addr2
->unique
+ 3, tp
->name
);
2575 sprintf(CS big_buffer
, "%.500s\n", addr2
->unique
);
2577 /* In the test harness, wait just a bit to let the subprocess finish off
2578 any debug output etc first. */
2580 if (f
.running_in_test_harness
) millisleep(300);
2582 DEBUG(D_deliver
) debug_printf("journalling %s", big_buffer
);
2583 len
= Ustrlen(big_buffer
);
2584 if (write(journal_fd
, big_buffer
, len
) != len
)
2585 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to update journal for %s: %s",
2586 big_buffer
, strerror(errno
));
2589 /* Ensure the journal file is pushed out to disk. */
2591 if (EXIMfsync(journal_fd
) < 0)
2592 log_write(0, LOG_MAIN
|LOG_PANIC
, "failed to fsync journal: %s",
2596 /* Wait for the process to finish. If it terminates with a non-zero code,
2597 freeze the message (except for SIGTERM, SIGKILL and SIGQUIT), but leave the
2598 status values of all the addresses as they are. Take care to handle the case
2599 when the subprocess doesn't seem to exist. This has been seen on one system
2600 when Exim was called from an MUA that set SIGCHLD to SIG_IGN. When that
2601 happens, wait() doesn't recognize the termination of child processes. Exim now
2602 resets SIGCHLD to SIG_DFL, but this code should still be robust. */
2604 while ((rc
= wait(&status
)) != pid
)
2605 if (rc
< 0 && errno
== ECHILD
) /* Process has vanished */
2607 log_write(0, LOG_MAIN
, "%s transport process vanished unexpectedly",
2608 addr
->transport
->driver_name
);
2613 if ((status
& 0xffff) != 0)
2615 int msb
= (status
>> 8) & 255;
2616 int lsb
= status
& 255;
2617 int code
= (msb
== 0)?
(lsb
& 0x7f) : msb
;
2618 if (msb
!= 0 || (code
!= SIGTERM
&& code
!= SIGKILL
&& code
!= SIGQUIT
))
2619 addr
->special_action
= SPECIAL_FREEZE
;
2620 log_write(0, LOG_MAIN
|LOG_PANIC
, "%s transport process returned non-zero "
2621 "status 0x%04x: %s %d",
2622 addr
->transport
->driver_name
,
2624 msb
== 0 ?
"terminated by signal" : "exit code",
2628 /* If SPECIAL_WARN is set in the top address, send a warning message. */
2630 if (addr
->special_action
== SPECIAL_WARN
&& addr
->transport
->warn_message
)
2633 uschar
*warn_message
;
2636 DEBUG(D_deliver
) debug_printf("Warning message requested by transport\n");
2638 if (!(warn_message
= expand_string(addr
->transport
->warn_message
)))
2639 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand \"%s\" (warning "
2640 "message for %s transport): %s", addr
->transport
->warn_message
,
2641 addr
->transport
->name
, expand_string_message
);
2643 else if ((pid
= child_open_exim(&fd
)) > 0)
2645 FILE *f
= fdopen(fd
, "wb");
2646 if (errors_reply_to
&& !contains_header(US
"Reply-To", warn_message
))
2647 fprintf(f
, "Reply-To: %s\n", errors_reply_to
);
2648 fprintf(f
, "Auto-Submitted: auto-replied\n");
2649 if (!contains_header(US
"From", warn_message
))
2651 fprintf(f
, "%s", CS warn_message
);
2653 /* Close and wait for child process to complete, without a timeout. */
2656 (void)child_close(pid
, 0);
2659 addr
->special_action
= SPECIAL_NONE
;
2666 /* Check transport for the given concurrency limit. Return TRUE if over
2667 the limit (or an expansion failure), else FALSE and if there was a limit,
2668 the key for the hints database used for the concurrency count. */
2671 tpt_parallel_check(transport_instance
* tp
, address_item
* addr
, uschar
** key
)
2673 unsigned max_parallel
;
2675 if (!tp
->max_parallel
) return FALSE
;
2677 max_parallel
= (unsigned) expand_string_integer(tp
->max_parallel
, TRUE
);
2678 if (expand_string_message
)
2680 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand max_parallel option "
2681 "in %s transport (%s): %s", tp
->name
, addr
->address
,
2682 expand_string_message
);
2686 if (max_parallel
> 0)
2688 uschar
* serialize_key
= string_sprintf("tpt-serialize-%s", tp
->name
);
2689 if (!enq_start(serialize_key
, max_parallel
))
2691 address_item
* next
;
2693 debug_printf("skipping tpt %s because concurrency limit %u reached\n",
2694 tp
->name
, max_parallel
);
2698 addr
->message
= US
"concurrency limit reached for transport";
2699 addr
->basic_errno
= ERRNO_TRETRY
;
2700 post_process_one(addr
, DEFER
, LOG_MAIN
, EXIM_DTYPE_TRANSPORT
, 0);
2701 } while ((addr
= next
));
2704 *key
= serialize_key
;
2711 /*************************************************
2712 * Do local deliveries *
2713 *************************************************/
2715 /* This function processes the list of addresses in addr_local. True local
2716 deliveries are always done one address at a time. However, local deliveries can
2717 be batched up in some cases. Typically this is when writing batched SMTP output
2718 files for use by some external transport mechanism, or when running local
2719 deliveries over LMTP.
2726 do_local_deliveries(void)
2729 open_db
*dbm_file
= NULL
;
2730 time_t now
= time(NULL
);
2732 /* Loop until we have exhausted the supply of local deliveries */
2736 struct timeval delivery_start
;
2737 struct timeval deliver_time
;
2738 address_item
*addr2
, *addr3
, *nextaddr
;
2739 int logflags
= LOG_MAIN
;
2740 int logchar
= f
.dont_deliver?
'*' : '=';
2741 transport_instance
*tp
;
2742 uschar
* serialize_key
= NULL
;
2744 /* Pick the first undelivered address off the chain */
2746 address_item
*addr
= addr_local
;
2747 addr_local
= addr
->next
;
2750 DEBUG(D_deliver
|D_transport
)
2751 debug_printf("--------> %s <--------\n", addr
->address
);
2753 /* An internal disaster if there is no transport. Should not occur! */
2755 if (!(tp
= addr
->transport
))
2757 logflags
|= LOG_PANIC
;
2758 f
.disable_logging
= FALSE
; /* Jic */
2759 addr
->message
= addr
->router
2760 ?
string_sprintf("No transport set by %s router", addr
->router
->name
)
2761 : string_sprintf("No transport set by system filter");
2762 post_process_one(addr
, DEFER
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
2766 /* Check that this base address hasn't previously been delivered to this
2767 transport. The check is necessary at this point to handle homonymic addresses
2768 correctly in cases where the pattern of redirection changes between delivery
2769 attempts. Non-homonymic previous delivery is detected earlier, at routing
2772 if (previously_transported(addr
, FALSE
)) continue;
2774 /* There are weird cases where logging is disabled */
2776 f
.disable_logging
= tp
->disable_logging
;
2778 /* Check for batched addresses and possible amalgamation. Skip all the work
2779 if either batch_max <= 1 or there aren't any other addresses for local
2782 if (tp
->batch_max
> 1 && addr_local
)
2784 int batch_count
= 1;
2785 BOOL uses_dom
= readconf_depends((driver_instance
*)tp
, US
"domain");
2786 BOOL uses_lp
= ( testflag(addr
, af_pfr
)
2787 && (testflag(addr
, af_file
) || addr
->local_part
[0] == '|')
2789 || readconf_depends((driver_instance
*)tp
, US
"local_part");
2790 uschar
*batch_id
= NULL
;
2791 address_item
**anchor
= &addr_local
;
2792 address_item
*last
= addr
;
2795 /* Expand the batch_id string for comparison with other addresses.
2796 Expansion failure suppresses batching. */
2800 deliver_set_expansions(addr
);
2801 batch_id
= expand_string(tp
->batch_id
);
2802 deliver_set_expansions(NULL
);
2805 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand batch_id option "
2806 "in %s transport (%s): %s", tp
->name
, addr
->address
,
2807 expand_string_message
);
2808 batch_count
= tp
->batch_max
;
2812 /* Until we reach the batch_max limit, pick off addresses which have the
2813 same characteristics. These are:
2816 not previously delivered (see comment about 50 lines above)
2817 same local part if the transport's configuration contains $local_part
2818 or if this is a file or pipe delivery from a redirection
2819 same domain if the transport's configuration contains $domain
2821 same additional headers
2822 same headers to be removed
2823 same uid/gid for running the transport
2824 same first host if a host list is set
2827 while ((next
= *anchor
) && batch_count
< tp
->batch_max
)
2830 tp
== next
->transport
2831 && !previously_transported(next
, TRUE
)
2832 && testflag(addr
, af_pfr
) == testflag(next
, af_pfr
)
2833 && testflag(addr
, af_file
) == testflag(next
, af_file
)
2834 && (!uses_lp
|| Ustrcmp(next
->local_part
, addr
->local_part
) == 0)
2835 && (!uses_dom
|| Ustrcmp(next
->domain
, addr
->domain
) == 0)
2836 && same_strings(next
->prop
.errors_address
, addr
->prop
.errors_address
)
2837 && same_headers(next
->prop
.extra_headers
, addr
->prop
.extra_headers
)
2838 && same_strings(next
->prop
.remove_headers
, addr
->prop
.remove_headers
)
2839 && same_ugid(tp
, addr
, next
)
2840 && ( !addr
->host_list
&& !next
->host_list
2843 && Ustrcmp(addr
->host_list
->name
, next
->host_list
->name
) == 0
2846 /* If the transport has a batch_id setting, batch_id will be non-NULL
2847 from the expansion outside the loop. Expand for this address and compare.
2848 Expansion failure makes this address ineligible for batching. */
2853 address_item
*save_nextnext
= next
->next
;
2854 next
->next
= NULL
; /* Expansion for a single address */
2855 deliver_set_expansions(next
);
2856 next
->next
= save_nextnext
;
2857 bid
= expand_string(tp
->batch_id
);
2858 deliver_set_expansions(NULL
);
2861 log_write(0, LOG_MAIN
|LOG_PANIC
, "Failed to expand batch_id option "
2862 "in %s transport (%s): %s", tp
->name
, next
->address
,
2863 expand_string_message
);
2866 else ok
= (Ustrcmp(batch_id
, bid
) == 0);
2869 /* Take address into batch if OK. */
2873 *anchor
= next
->next
; /* Include the address */
2879 else anchor
= &next
->next
; /* Skip the address */
2883 /* We now have one or more addresses that can be delivered in a batch. Check
2884 whether the transport is prepared to accept a message of this size. If not,
2885 fail them all forthwith. If the expansion fails, or does not yield an
2886 integer, defer delivery. */
2888 if (tp
->message_size_limit
)
2890 int rc
= check_message_size(tp
, addr
);
2893 replicate_status(addr
);
2897 post_process_one(addr
, rc
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
2900 continue; /* With next batch of addresses */
2904 /* If we are not running the queue, or if forcing, all deliveries will be
2905 attempted. Otherwise, we must respect the retry times for each address. Even
2906 when not doing this, we need to set up the retry key string, and determine
2907 whether a retry record exists, because after a successful delivery, a delete
2908 retry item must be set up. Keep the retry database open only for the duration
2909 of these checks, rather than for all local deliveries, because some local
2910 deliveries (e.g. to pipes) can take a substantial time. */
2912 if (!(dbm_file
= dbfn_open(US
"retry", O_RDONLY
, &dbblock
, FALSE
)))
2914 DEBUG(D_deliver
|D_retry
|D_hints_lookup
)
2915 debug_printf("no retry data available\n");
2922 BOOL ok
= TRUE
; /* to deliver this address */
2925 /* Set up the retry key to include the domain or not, and change its
2926 leading character from "R" to "T". Must make a copy before doing this,
2927 because the old key may be pointed to from a "delete" retry item after
2930 retry_key
= string_copy(
2931 tp
->retry_use_local_part ? addr2
->address_retry_key
:
2932 addr2
->domain_retry_key
);
2935 /* Inspect the retry data. If there is no hints file, delivery happens. */
2939 dbdata_retry
*retry_record
= dbfn_read(dbm_file
, retry_key
);
2941 /* If there is no retry record, delivery happens. If there is,
2942 remember it exists so it can be deleted after a successful delivery. */
2946 setflag(addr2
, af_lt_retry_exists
);
2948 /* A retry record exists for this address. If queue running and not
2949 forcing, inspect its contents. If the record is too old, or if its
2950 retry time has come, or if it has passed its cutoff time, delivery
2955 debug_printf("retry record exists: age=%s ",
2956 readconf_printtime(now
- retry_record
->time_stamp
));
2957 debug_printf("(max %s)\n", readconf_printtime(retry_data_expire
));
2958 debug_printf(" time to retry = %s expired = %d\n",
2959 readconf_printtime(retry_record
->next_try
- now
),
2960 retry_record
->expired
);
2963 if (f
.queue_running
&& !f
.deliver_force
)
2965 ok
= (now
- retry_record
->time_stamp
> retry_data_expire
)
2966 || (now
>= retry_record
->next_try
)
2967 || retry_record
->expired
;
2969 /* If we haven't reached the retry time, there is one more check
2970 to do, which is for the ultimate address timeout. */
2973 ok
= retry_ultimate_address_timeout(retry_key
, addr2
->domain
,
2977 else DEBUG(D_retry
) debug_printf("no retry record exists\n");
2980 /* This address is to be delivered. Leave it on the chain. */
2985 addr2
= addr2
->next
;
2988 /* This address is to be deferred. Take it out of the chain, and
2989 post-process it as complete. Must take it out of the chain first,
2990 because post processing puts it on another chain. */
2994 address_item
*this = addr2
;
2995 this->message
= US
"Retry time not yet reached";
2996 this->basic_errno
= ERRNO_LRETRY
;
2997 addr2
= addr3 ?
(addr3
->next
= addr2
->next
)
2998 : (addr
= addr2
->next
);
2999 post_process_one(this, DEFER
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
3003 if (dbm_file
) dbfn_close(dbm_file
);
3005 /* If there are no addresses left on the chain, they all deferred. Loop
3006 for the next set of addresses. */
3008 if (!addr
) continue;
3010 /* If the transport is limited for parallellism, enforce that here.
3011 We use a hints DB entry, incremented here and decremented after
3012 the transport (and any shadow transport) completes. */
3014 if (tpt_parallel_check(tp
, addr
, &serialize_key
))
3016 if (expand_string_message
)
3018 logflags
|= LOG_PANIC
;
3022 post_process_one(addr
, DEFER
, logflags
, EXIM_DTYPE_TRANSPORT
, 0);
3023 } while ((addr
= addr2
));
3025 continue; /* Loop for the next set of addresses. */
3029 /* So, finally, we do have some addresses that can be passed to the
3030 transport. Before doing so, set up variables that are relevant to a
3033 deliver_set_expansions(addr
);
3035 gettimeofday(&delivery_start
, NULL
);
3036 deliver_local(addr
, FALSE
);
3037 timesince(&deliver_time
, &delivery_start
);
3039 /* If a shadow transport (which must perforce be another local transport), is
3040 defined, and its condition is met, we must pass the message to the shadow
3041 too, but only those addresses that succeeded. We do this by making a new
3042 chain of addresses - also to keep the original chain uncontaminated. We must
3043 use a chain rather than doing it one by one, because the shadow transport may
3046 NOTE: if the condition fails because of a lookup defer, there is nothing we
3050 && ( !tp
->shadow_condition
3051 || expand_check_condition(tp
->shadow_condition
, tp
->name
, US
"transport")
3054 transport_instance
*stp
;
3055 address_item
*shadow_addr
= NULL
;
3056 address_item
**last
= &shadow_addr
;
3058 for (stp
= transports
; stp
; stp
= stp
->next
)
3059 if (Ustrcmp(stp
->name
, tp
->shadow
) == 0) break;
3062 log_write(0, LOG_MAIN
|LOG_PANIC
, "shadow transport \"%s\" not found ",
3065 /* Pick off the addresses that have succeeded, and make clones. Put into
3066 the shadow_message field a pointer to the shadow_message field of the real
3069 else for (addr2
= addr
; addr2
; addr2
= addr2
->next
)
3070 if (addr2
->transport_return
== OK
)
3072 addr3
= store_get(sizeof(address_item
));
3075 addr3
->shadow_message
= US
&addr2
->shadow_message
;
3076 addr3
->transport
= stp
;
3077 addr3
->transport_return
= DEFER
;
3078 addr3
->return_filename
= NULL
;
3079 addr3
->return_file
= -1;
3081 last
= &addr3
->next
;
3084 /* If we found any addresses to shadow, run the delivery, and stick any
3085 message back into the shadow_message field in the original. */
3089 int save_count
= transport_count
;
3091 DEBUG(D_deliver
|D_transport
)
3092 debug_printf(">>>>>>>>>>>>>>>> Shadow delivery >>>>>>>>>>>>>>>>\n");
3093 deliver_local(shadow_addr
, TRUE
);
3095 for(; shadow_addr
; shadow_addr
= shadow_addr
->next
)
3097 int sresult
= shadow_addr
->transport_return
;
3098 *(uschar
**)shadow_addr
->shadow_message
=
3100 ?
string_sprintf(" ST=%s", stp
->name
)
3101 : string_sprintf(" ST=%s (%s%s%s)", stp
->name
,
3102 shadow_addr
->basic_errno
<= 0
3104 : US
strerror(shadow_addr
->basic_errno
),
3105 shadow_addr
->basic_errno
<= 0 || !shadow_addr
->message
3108 shadow_addr
->message
3109 ? shadow_addr
->message
3110 : shadow_addr
->basic_errno
<= 0
3114 DEBUG(D_deliver
|D_transport
)
3115 debug_printf("%s shadow transport returned %s for %s\n",
3117 sresult
== OK ?
"OK" :
3118 sresult
== DEFER ?
"DEFER" :
3119 sresult
== FAIL ?
"FAIL" :
3120 sresult
== PANIC ?
"PANIC" : "?",
3121 shadow_addr
->address
);
3124 DEBUG(D_deliver
|D_transport
)
3125 debug_printf(">>>>>>>>>>>>>>>> End shadow delivery >>>>>>>>>>>>>>>>\n");
3127 transport_count
= save_count
; /* Restore original transport count */
3131 /* Cancel the expansions that were set up for the delivery. */
3133 deliver_set_expansions(NULL
);
3135 /* If the transport was parallelism-limited, decrement the hints DB record. */
3137 if (serialize_key
) enq_end(serialize_key
);
3139 /* Now we can process the results of the real transport. We must take each
3140 address off the chain first, because post_process_one() puts it on another
3143 for (addr2
= addr
; addr2
; addr2
= nextaddr
)
3145 int result
= addr2
->transport_return
;
3146 nextaddr
= addr2
->next
;
3148 DEBUG(D_deliver
|D_transport
)
3149 debug_printf("%s transport returned %s for %s\n",
3151 result
== OK ?
"OK" :
3152 result
== DEFER ?
"DEFER" :
3153 result
== FAIL ?
"FAIL" :
3154 result
== PANIC ?
"PANIC" : "?",
3157 /* If there is a retry_record, or if delivery is deferred, build a retry
3158 item for setting a new retry time or deleting the old retry record from
3159 the database. These items are handled all together after all addresses
3160 have been handled (so the database is open just for a short time for
3163 if (result
== DEFER
|| testflag(addr2
, af_lt_retry_exists
))
3165 int flags
= result
== DEFER ?
0 : rf_delete
;
3166 uschar
*retry_key
= string_copy(tp
->retry_use_local_part
3167 ? addr2
->address_retry_key
: addr2
->domain_retry_key
);
3169 retry_add_item(addr2
, retry_key
, flags
);
3172 /* Done with this address */
3176 addr2
->more_errno
= deliver_time
.tv_sec
;
3177 addr2
->delivery_usec
= deliver_time
.tv_usec
;
3179 post_process_one(addr2
, result
, logflags
, EXIM_DTYPE_TRANSPORT
, logchar
);
3181 /* If a pipe delivery generated text to be sent back, the result may be
3182 changed to FAIL, and we must copy this for subsequent addresses in the
3185 if (addr2
->transport_return
!= result
)
3187 for (addr3
= nextaddr
; addr3
; addr3
= addr3
->next
)
3189 addr3
->transport_return
= addr2
->transport_return
;
3190 addr3
->basic_errno
= addr2
->basic_errno
;
3191 addr3
->message
= addr2
->message
;
3193 result
= addr2
->transport_return
;
3196 /* Whether or not the result was changed to FAIL, we need to copy the
3197 return_file value from the first address into all the addresses of the
3198 batch, so they are all listed in the error message. */
3200 addr2
->return_file
= addr
->return_file
;
3202 /* Change log character for recording successful deliveries. */
3204 if (result
== OK
) logchar
= '-';
3206 } /* Loop back for next batch of addresses */
3212 /*************************************************
3213 * Sort remote deliveries *
3214 *************************************************/
3216 /* This function is called if remote_sort_domains is set. It arranges that the
3217 chain of addresses for remote deliveries is ordered according to the strings
3218 specified. Try to make this shuffling reasonably efficient by handling
3219 sequences of addresses rather than just single ones.
3226 sort_remote_deliveries(void)
3229 address_item
**aptr
= &addr_remote
;
3230 const uschar
*listptr
= remote_sort_domains
;
3235 && (pattern
= string_nextinlist(&listptr
, &sep
, patbuf
, sizeof(patbuf
)))
3238 address_item
*moved
= NULL
;
3239 address_item
**bptr
= &moved
;
3243 address_item
**next
;
3244 deliver_domain
= (*aptr
)->domain
; /* set $domain */
3245 if (match_isinlist(deliver_domain
, (const uschar
**)&pattern
, UCHAR_MAX
+1,
3246 &domainlist_anchor
, NULL
, MCL_DOMAIN
, TRUE
, NULL
) == OK
)
3248 aptr
= &(*aptr
)->next
;
3252 next
= &(*aptr
)->next
;
3254 && (deliver_domain
= (*next
)->domain
, /* Set $domain */
3255 match_isinlist(deliver_domain
, (const uschar
**)&pattern
, UCHAR_MAX
+1,
3256 &domainlist_anchor
, NULL
, MCL_DOMAIN
, TRUE
, NULL
)) != OK
3258 next
= &(*next
)->next
;
3260 /* If the batch of non-matchers is at the end, add on any that were
3261 extracted further up the chain, and end this iteration. Otherwise,
3262 extract them from the chain and hang on the moved chain. */
3274 aptr
= &(*aptr
)->next
;
3277 /* If the loop ended because the final address matched, *aptr will
3278 be NULL. Add on to the end any extracted non-matching addresses. If
3279 *aptr is not NULL, the loop ended via "break" when *next is null, that
3280 is, there was a string of non-matching addresses at the end. In this
3281 case the extracted addresses have already been added on the end. */
3283 if (!*aptr
) *aptr
= moved
;
3289 debug_printf("remote addresses after sorting:\n");
3290 for (addr
= addr_remote
; addr
; addr
= addr
->next
)
3291 debug_printf(" %s\n", addr
->address
);
3297 /*************************************************
3298 * Read from pipe for remote delivery subprocess *
3299 *************************************************/
3301 /* This function is called when the subprocess is complete, but can also be
3302 called before it is complete, in order to empty a pipe that is full (to prevent
3303 deadlock). It must therefore keep track of its progress in the parlist data
3306 We read the pipe to get the delivery status codes and a possible error message
3307 for each address, optionally preceded by unusability data for the hosts and
3308 also by optional retry data.
3310 Read in large chunks into the big buffer and then scan through, interpreting
3311 the data therein. In most cases, only a single read will be necessary. No
3312 individual item will ever be anywhere near 2500 bytes in length, so by ensuring
3313 that we read the next chunk when there is less than 2500 bytes left in the
3314 non-final chunk, we can assume each item is complete in the buffer before
3315 handling it. Each item is written using a single write(), which is atomic for
3316 small items (less than PIPE_BUF, which seems to be at least 512 in any Unix and
3317 often bigger) so even if we are reading while the subprocess is still going, we
3318 should never have only a partial item in the buffer.
3320 hs12: This assumption is not true anymore, since we get quite large items (certificate
3321 information and such).
3324 poffset the offset of the parlist item
3325 eop TRUE if the process has completed
3327 Returns: TRUE if the terminating 'Z' item has been read,
3328 or there has been a disaster (i.e. no more data needed);
3333 par_read_pipe(int poffset
, BOOL eop
)
3336 pardata
*p
= parlist
+ poffset
;
3337 address_item
*addrlist
= p
->addrlist
;
3338 address_item
*addr
= p
->addr
;
3342 uschar
*msg
= p
->msg
;
3343 BOOL done
= p
->done
;
3345 /* Loop through all items, reading from the pipe when necessary. The pipe
3346 used to be non-blocking. But I do not see a reason for using non-blocking I/O
3347 here, as the preceding select() tells us, if data is available for reading.
3349 A read() on a "selected" handle should never block, but(!) it may return
3350 less data then we expected. (The buffer size we pass to read() shouldn't be
3351 understood as a "request", but as a "limit".)
3353 Each separate item is written to the pipe in a timely manner. But, especially for
3354 larger items, the read(2) may already return partial data from the write(2).
3356 The write is atomic mostly (depending on the amount written), but atomic does
3357 not imply "all or noting", it just is "not intermixed" with other writes on the
3358 same channel (pipe).
3362 DEBUG(D_deliver
) debug_printf("reading pipe for subprocess %d (%s)\n",
3363 (int)p
->pid
, eop?
"ended" : "not ended yet");
3367 retry_item
*r
, **rp
;
3368 uschar pipeheader
[PIPE_HEADER_SIZE
+1];
3369 uschar
*id
= &pipeheader
[0];
3370 uschar
*subid
= &pipeheader
[1];
3371 uschar
*ptr
= big_buffer
;
3372 size_t required
= PIPE_HEADER_SIZE
; /* first the pipehaeder, later the data */
3375 DEBUG(D_deliver
) debug_printf(
3376 "expect %lu bytes (pipeheader) from tpt process %d\n", (u_long
)required
, pid
);
3378 /* We require(!) all the PIPE_HEADER_SIZE bytes here, as we know,
3379 they're written in a timely manner, so waiting for the write shouldn't hurt a lot.
3380 If we get less, we can assume the subprocess do be done and do not expect any further
3381 information from it. */
3383 if ((got
= readn(fd
, pipeheader
, required
)) != required
)
3385 msg
= string_sprintf("got " SSIZE_T_FMT
" of %d bytes (pipeheader) "
3386 "from transport process %d for transport %s",
3387 got
, PIPE_HEADER_SIZE
, pid
, addr
->transport
->driver_name
);
3392 pipeheader
[PIPE_HEADER_SIZE
] = '\0';
3394 debug_printf("got %ld bytes (pipeheader) from transport process %d\n",
3398 /* If we can't decode the pipeheader, the subprocess seems to have a
3399 problem, we do not expect any furher information from it. */
3401 required
= Ustrtol(pipeheader
+2, &endc
, 10);
3404 msg
= string_sprintf("failed to read pipe "
3405 "from transport process %d for transport %s: error decoding size from header",
3406 pid
, addr
->transport
->driver_name
);
3413 debug_printf("expect %lu bytes (pipedata) from transport process %d\n",
3414 (u_long
)required
, pid
);
3416 /* Same as above, the transport process will write the bytes announced
3417 in a timely manner, so we can just wait for the bytes, getting less than expected
3418 is considered a problem of the subprocess, we do not expect anything else from it. */
3419 if ((got
= readn(fd
, big_buffer
, required
)) != required
)
3421 msg
= string_sprintf("got only " SSIZE_T_FMT
" of " SIZE_T_FMT
3422 " bytes (pipedata) from transport process %d for transport %s",
3423 got
, required
, pid
, addr
->transport
->driver_name
);
3428 /* Handle each possible type of item, assuming the complete item is
3429 available in store. */
3433 /* Host items exist only if any hosts were marked unusable. Match
3434 up by checking the IP address. */
3437 for (h
= addrlist
->host_list
; h
; h
= h
->next
)
3439 if (!h
->address
|| Ustrcmp(h
->address
, ptr
+2) != 0) continue;
3447 /* Retry items are sent in a preceding R item for each address. This is
3448 kept separate to keep each message short enough to guarantee it won't
3449 be split in the pipe. Hopefully, in the majority of cases, there won't in
3450 fact be any retry items at all.
3452 The complete set of retry items might include an item to delete a
3453 routing retry if there was a previous routing delay. However, routing
3454 retries are also used when a remote transport identifies an address error.
3455 In that case, there may also be an "add" item for the same key. Arrange
3456 that a "delete" item is dropped in favour of an "add" item. */
3459 if (!addr
) goto ADDR_MISMATCH
;
3461 DEBUG(D_deliver
|D_retry
)
3462 debug_printf("reading retry information for %s from subprocess\n",
3465 /* Cut out any "delete" items on the list. */
3467 for (rp
= &addr
->retries
; (r
= *rp
); rp
= &r
->next
)
3468 if (Ustrcmp(r
->key
, ptr
+1) == 0) /* Found item with same key */
3470 if (!(r
->flags
& rf_delete
)) break; /* It was not "delete" */
3471 *rp
= r
->next
; /* Excise a delete item */
3472 DEBUG(D_deliver
|D_retry
)
3473 debug_printf(" existing delete item dropped\n");
3476 /* We want to add a delete item only if there is no non-delete item;
3477 however we still have to step ptr through the data. */
3479 if (!r
|| !(*ptr
& rf_delete
))
3481 r
= store_get(sizeof(retry_item
));
3482 r
->next
= addr
->retries
;
3485 r
->key
= string_copy(ptr
);
3487 memcpy(&r
->basic_errno
, ptr
, sizeof(r
->basic_errno
));
3488 ptr
+= sizeof(r
->basic_errno
);
3489 memcpy(&r
->more_errno
, ptr
, sizeof(r
->more_errno
));
3490 ptr
+= sizeof(r
->more_errno
);
3491 r
->message
= *ptr ?
string_copy(ptr
) : NULL
;
3492 DEBUG(D_deliver
|D_retry
) debug_printf(" added %s item\n",
3493 r
->flags
& rf_delete ?
"delete" : "retry");
3498 DEBUG(D_deliver
|D_retry
)
3499 debug_printf(" delete item not added: non-delete item exists\n");
3502 ptr
+= sizeof(r
->basic_errno
) + sizeof(r
->more_errno
);
3508 /* Put the amount of data written into the parlist block */
3511 memcpy(&(p
->transport_count
), ptr
, sizeof(transport_count
));
3512 ptr
+= sizeof(transport_count
);
3515 /* Address items are in the order of items on the address chain. We
3516 remember the current address value in case this function is called
3517 several times to empty the pipe in stages. Information about delivery
3518 over TLS is sent in a preceding X item for each address. We don't put
3519 it in with the other info, in order to keep each message short enough to
3520 guarantee it won't be split in the pipe. */
3524 if (!addr
) goto ADDR_MISMATCH
; /* Below, in 'A' handler */
3528 addr
->cipher
= NULL
;
3529 addr
->peerdn
= NULL
;
3532 addr
->cipher
= string_copy(ptr
);
3535 addr
->peerdn
= string_copy(ptr
);
3540 (void) tls_import_cert(ptr
, &addr
->peercert
);
3542 addr
->peercert
= NULL
;
3547 (void) tls_import_cert(ptr
, &addr
->ourcert
);
3549 addr
->ourcert
= NULL
;
3552 # ifndef DISABLE_OCSP
3554 addr
->ocsp
= *ptr ?
*ptr
- '0' : OCSP_NOT_REQ
;
3560 #endif /*SUPPORT_TLS*/
3562 case 'C': /* client authenticator information */
3565 case '1': addr
->authenticator
= *ptr ?
string_copy(ptr
) : NULL
; break;
3566 case '2': addr
->auth_id
= *ptr ?
string_copy(ptr
) : NULL
; break;
3567 case '3': addr
->auth_sndr
= *ptr ?
string_copy(ptr
) : NULL
; break;
3572 #ifndef DISABLE_PRDR
3574 setflag(addr
, af_prdr_used
);
3581 #ifdef EXPERIMENTAL_PIPE_CONNECT
3582 case 2: setflag(addr
, af_early_pipe
); /*FALLTHROUGH*/
3584 case 1: setflag(addr
, af_pipelining
); break;
3589 setflag(addr
, af_chunking_used
);
3593 setflag(addr
, af_tcp_fastopen_conn
);
3594 if (*subid
> '0') setflag(addr
, af_tcp_fastopen
);
3595 if (*subid
> '1') setflag(addr
, af_tcp_fastopen_data
);
3599 if (!addr
) goto ADDR_MISMATCH
;
3600 memcpy(&(addr
->dsn_aware
), ptr
, sizeof(addr
->dsn_aware
));
3601 ptr
+= sizeof(addr
->dsn_aware
);
3602 DEBUG(D_deliver
) debug_printf("DSN read: addr->dsn_aware = %d\n", addr
->dsn_aware
);
3609 msg
= string_sprintf("address count mismatch for data read from pipe "
3610 "for transport process %d for transport %s", pid
,
3611 addrlist
->transport
->driver_name
);
3618 #ifdef SUPPORT_SOCKS
3619 case '2': /* proxy information; must arrive before A0 and applies to that addr XXX oops*/
3620 proxy_session
= TRUE
; /*XXX should this be cleared somewhere? */
3625 proxy_local_address
= string_copy(ptr
);
3627 memcpy(&proxy_local_port
, ptr
, sizeof(proxy_local_port
));
3628 ptr
+= sizeof(proxy_local_port
);
3633 #ifdef EXPERIMENTAL_DSN_INFO
3634 case '1': /* must arrive before A0, and applies to that addr */
3635 /* Two strings: smtp_greeting and helo_response */
3636 addr
->smtp_greeting
= string_copy(ptr
);
3638 addr
->helo_response
= string_copy(ptr
);
3644 DEBUG(D_deliver
) debug_printf("A0 %s tret %d\n", addr
->address
, *ptr
);
3645 addr
->transport_return
= *ptr
++;
3646 addr
->special_action
= *ptr
++;
3647 memcpy(&addr
->basic_errno
, ptr
, sizeof(addr
->basic_errno
));
3648 ptr
+= sizeof(addr
->basic_errno
);
3649 memcpy(&addr
->more_errno
, ptr
, sizeof(addr
->more_errno
));
3650 ptr
+= sizeof(addr
->more_errno
);
3651 memcpy(&addr
->delivery_usec
, ptr
, sizeof(addr
->delivery_usec
));
3652 ptr
+= sizeof(addr
->delivery_usec
);
3653 memcpy(&addr
->flags
, ptr
, sizeof(addr
->flags
));
3654 ptr
+= sizeof(addr
->flags
);
3655 addr
->message
= *ptr ?
string_copy(ptr
) : NULL
;
3657 addr
->user_message
= *ptr ?
string_copy(ptr
) : NULL
;
3660 /* Always two strings for host information, followed by the port number and DNSSEC mark */
3664 h
= store_get(sizeof(host_item
));
3665 h
->name
= string_copy(ptr
);
3667 h
->address
= string_copy(ptr
);
3669 memcpy(&h
->port
, ptr
, sizeof(h
->port
));
3670 ptr
+= sizeof(h
->port
);
3671 h
->dnssec
= *ptr
== '2' ? DS_YES
3672 : *ptr
== '1' ? DS_NO
3675 addr
->host_used
= h
;
3679 /* Finished with this address */
3686 /* Local interface address/port */
3688 if (*ptr
) sending_ip_address
= string_copy(ptr
);
3690 if (*ptr
) sending_port
= atoi(CS ptr
);
3694 /* Z marks the logical end of the data. It is followed by '0' if
3695 continue_transport was NULL at the end of transporting, otherwise '1'.
3696 We need to know when it becomes NULL during a delivery down a passed SMTP
3697 channel so that we don't try to pass anything more down it. Of course, for
3698 most normal messages it will remain NULL all the time. */
3703 continue_transport
= NULL
;
3704 continue_hostname
= NULL
;
3707 DEBUG(D_deliver
) debug_printf("Z0%c item read\n", *ptr
);
3710 /* Anything else is a disaster. */
3713 msg
= string_sprintf("malformed data (%d) read from pipe for transport "
3714 "process %d for transport %s", ptr
[-1], pid
,
3715 addr
->transport
->driver_name
);
3721 /* The done flag is inspected externally, to determine whether or not to
3722 call the function again when the process finishes. */
3726 /* If the process hadn't finished, and we haven't seen the end of the data
3727 or if we suffered a disaster, update the rest of the state, and return FALSE to
3728 indicate "not finished". */
3737 /* Close our end of the pipe, to prevent deadlock if the far end is still
3738 pushing stuff into it. */
3743 /* If we have finished without error, but haven't had data for every address,
3744 something is wrong. */
3747 msg
= string_sprintf("insufficient address data read from pipe "
3748 "for transport process %d for transport %s", pid
,
3749 addr
->transport
->driver_name
);
3751 /* If an error message is set, something has gone wrong in getting back
3752 the delivery data. Put the message into each address and freeze it. */
3755 for (addr
= addrlist
; addr
; addr
= addr
->next
)
3757 addr
->transport_return
= DEFER
;
3758 addr
->special_action
= SPECIAL_FREEZE
;
3759 addr
->message
= msg
;
3760 log_write(0, LOG_MAIN
|LOG_PANIC
, "Delivery status for %s: %s\n", addr
->address
, addr
->message
);
3763 /* Return TRUE to indicate we have got all we need from this process, even
3764 if it hasn't actually finished yet. */
3771 /*************************************************
3772 * Post-process a set of remote addresses *
3773 *************************************************/
3775 /* Do what has to be done immediately after a remote delivery for each set of
3776 addresses, then re-write the spool if necessary. Note that post_process_one
3777 puts the address on an appropriate queue; hence we must fish off the next
3778 one first. This function is also called if there is a problem with setting
3779 up a subprocess to do a remote delivery in parallel. In this case, the final
3780 argument contains a message, and the action must be forced to DEFER.
3783 addr pointer to chain of address items
3784 logflags flags for logging
3785 msg NULL for normal cases; -> error message for unexpected problems
3786 fallback TRUE if processing fallback hosts
3792 remote_post_process(address_item
*addr
, int logflags
, uschar
*msg
,
3797 /* If any host addresses were found to be unusable, add them to the unusable
3798 tree so that subsequent deliveries don't try them. */
3800 for (h
= addr
->host_list
; h
; h
= h
->next
)
3802 if (h
->status
>= hstatus_unusable
) tree_add_unusable(h
);
3804 /* Now handle each address on the chain. The transport has placed '=' or '-'
3805 into the special_action field for each successful delivery. */
3809 address_item
*next
= addr
->next
;
3811 /* If msg == NULL (normal processing) and the result is DEFER and we are
3812 processing the main hosts and there are fallback hosts available, put the
3813 address on the list for fallback delivery. */
3815 if ( addr
->transport_return
== DEFER
3816 && addr
->fallback_hosts
3821 addr
->host_list
= addr
->fallback_hosts
;
3822 addr
->next
= addr_fallback
;
3823 addr_fallback
= addr
;
3824 DEBUG(D_deliver
) debug_printf("%s queued for fallback host(s)\n", addr
->address
);
3827 /* If msg is set (=> unexpected problem), set it in the address before
3828 doing the ordinary post processing. */
3834 addr
->message
= msg
;
3835 addr
->transport_return
= DEFER
;
3837 (void)post_process_one(addr
, addr
->transport_return
, logflags
,
3838 EXIM_DTYPE_TRANSPORT
, addr
->special_action
);
3846 /* If we have just delivered down a passed SMTP channel, and that was
3847 the last address, the channel will have been closed down. Now that
3848 we have logged that delivery, set continue_sequence to 1 so that
3849 any subsequent deliveries don't get "*" incorrectly logged. */
3851 if (!continue_transport
) continue_sequence
= 1;
3856 /*************************************************
3857 * Wait for one remote delivery subprocess *
3858 *************************************************/
3860 /* This function is called while doing remote deliveries when either the
3861 maximum number of processes exist and we need one to complete so that another
3862 can be created, or when waiting for the last ones to complete. It must wait for
3863 the completion of one subprocess, empty the control block slot, and return a
3864 pointer to the address chain.
3867 Returns: pointer to the chain of addresses handled by the process;
3868 NULL if no subprocess found - this is an unexpected error
3871 static address_item
*
3874 int poffset
, status
;
3875 address_item
*addr
, *addrlist
;
3878 set_process_info("delivering %s: waiting for a remote delivery subprocess "
3879 "to finish", message_id
);
3881 /* Loop until either a subprocess completes, or there are no subprocesses in
3882 existence - in which case give an error return. We cannot proceed just by
3883 waiting for a completion, because a subprocess may have filled up its pipe, and
3884 be waiting for it to be emptied. Therefore, if no processes have finished, we
3885 wait for one of the pipes to acquire some data by calling select(), with a
3886 timeout just in case.
3888 The simple approach is just to iterate after reading data from a ready pipe.
3889 This leads to non-ideal behaviour when the subprocess has written its final Z
3890 item, closed the pipe, and is in the process of exiting (the common case). A
3891 call to waitpid() yields nothing completed, but select() shows the pipe ready -
3892 reading it yields EOF, so you end up with busy-waiting until the subprocess has
3895 To avoid this, if all the data that is needed has been read from a subprocess
3896 after select(), an explicit wait() for it is done. We know that all it is doing
3897 is writing to the pipe and then exiting, so the wait should not be long.
3899 The non-blocking waitpid() is to some extent just insurance; if we could
3900 reliably detect end-of-file on the pipe, we could always know when to do a
3901 blocking wait() for a completed process. However, because some systems use
3902 NDELAY, which doesn't distinguish between EOF and pipe empty, it is easier to
3903 use code that functions without the need to recognize EOF.
3905 There's a double loop here just in case we end up with a process that is not in
3906 the list of remote delivery processes. Something has obviously gone wrong if
3907 this is the case. (For example, a process that is incorrectly left over from
3908 routing or local deliveries might be found.) The damage can be minimized by
3909 looping back and looking for another process. If there aren't any, the error
3910 return will happen. */
3912 for (;;) /* Normally we do not repeat this loop */
3914 while ((pid
= waitpid(-1, &status
, WNOHANG
)) <= 0)
3917 fd_set select_pipes
;
3918 int maxpipe
, readycount
;
3920 /* A return value of -1 can mean several things. If errno != ECHILD, it
3921 either means invalid options (which we discount), or that this process was
3922 interrupted by a signal. Just loop to try the waitpid() again.
3924 If errno == ECHILD, waitpid() is telling us that there are no subprocesses
3925 in existence. This should never happen, and is an unexpected error.
3926 However, there is a nasty complication when running under Linux. If "strace
3927 -f" is being used under Linux to trace this process and its children,
3928 subprocesses are "stolen" from their parents and become the children of the
3929 tracing process. A general wait such as the one we've just obeyed returns
3930 as if there are no children while subprocesses are running. Once a
3931 subprocess completes, it is restored to the parent, and waitpid(-1) finds
3932 it. Thanks to Joachim Wieland for finding all this out and suggesting a
3935 This does not happen using "truss" on Solaris, nor (I think) with other
3936 tracing facilities on other OS. It seems to be specific to Linux.
3938 What we do to get round this is to use kill() to see if any of our
3939 subprocesses are still in existence. If kill() gives an OK return, we know
3940 it must be for one of our processes - it can't be for a re-use of the pid,
3941 because if our process had finished, waitpid() would have found it. If any
3942 of our subprocesses are in existence, we proceed to use select() as if
3943 waitpid() had returned zero. I think this is safe. */
3947 if (errno
!= ECHILD
) continue; /* Repeats the waitpid() */
3950 debug_printf("waitpid() returned -1/ECHILD: checking explicitly "
3951 "for process existence\n");
3953 for (poffset
= 0; poffset
< remote_max_parallel
; poffset
++)
3955 if ((pid
= parlist
[poffset
].pid
) != 0 && kill(pid
, 0) == 0)
3957 DEBUG(D_deliver
) debug_printf("process %d still exists: assume "
3958 "stolen by strace\n", (int)pid
);
3959 break; /* With poffset set */
3963 if (poffset
>= remote_max_parallel
)
3965 DEBUG(D_deliver
) debug_printf("*** no delivery children found\n");
3966 return NULL
; /* This is the error return */
3970 /* A pid value greater than 0 breaks the "while" loop. A negative value has
3971 been handled above. A return value of zero means that there is at least one
3972 subprocess, but there are no completed subprocesses. See if any pipes are
3973 ready with any data for reading. */
3975 DEBUG(D_deliver
) debug_printf("selecting on subprocess pipes\n");
3978 FD_ZERO(&select_pipes
);
3979 for (poffset
= 0; poffset
< remote_max_parallel
; poffset
++)
3980 if (parlist
[poffset
].pid
!= 0)
3982 int fd
= parlist
[poffset
].fd
;
3983 FD_SET(fd
, &select_pipes
);
3984 if (fd
> maxpipe
) maxpipe
= fd
;
3987 /* Stick in a 60-second timeout, just in case. */
3992 readycount
= select(maxpipe
+ 1, (SELECT_ARG2_TYPE
*)&select_pipes
,
3995 /* Scan through the pipes and read any that are ready; use the count
3996 returned by select() to stop when there are no more. Select() can return
3997 with no processes (e.g. if interrupted). This shouldn't matter.
3999 If par_read_pipe() returns TRUE, it means that either the terminating Z was
4000 read, or there was a disaster. In either case, we are finished with this
4001 process. Do an explicit wait() for the process and break the main loop if
4004 It turns out that we have to deal with the case of an interrupted system
4005 call, which can happen on some operating systems if the signal handling is
4006 set up to do that by default. */
4009 readycount
> 0 && poffset
< remote_max_parallel
;
4012 if ( (pid
= parlist
[poffset
].pid
) != 0
4013 && FD_ISSET(parlist
[poffset
].fd
, &select_pipes
)
4017 if (par_read_pipe(poffset
, FALSE
)) /* Finished with this pipe */
4018 for (;;) /* Loop for signals */
4020 pid_t endedpid
= waitpid(pid
, &status
, 0);
4021 if (endedpid
== pid
) goto PROCESS_DONE
;
4022 if (endedpid
!= (pid_t
)(-1) || errno
!= EINTR
)
4023 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "Unexpected error return "
4024 "%d (errno = %d) from waitpid() for process %d",
4025 (int)endedpid
, errno
, (int)pid
);
4030 /* Now go back and look for a completed subprocess again. */
4033 /* A completed process was detected by the non-blocking waitpid(). Find the
4034 data block that corresponds to this subprocess. */
4036 for (poffset
= 0; poffset
< remote_max_parallel
; poffset
++)
4037 if (pid
== parlist
[poffset
].pid
) break;
4039 /* Found the data block; this is a known remote delivery process. We don't
4040 need to repeat the outer loop. This should be what normally happens. */
4042 if (poffset
< remote_max_parallel
) break;
4044 /* This situation is an error, but it's probably better to carry on looking
4045 for another process than to give up (as we used to do). */
4047 log_write(0, LOG_MAIN
|LOG_PANIC
, "Process %d finished: not found in remote "
4048 "transport process list", pid
);
4049 } /* End of the "for" loop */
4051 /* Come here when all the data was completely read after a select(), and
4052 the process in pid has been wait()ed for. */