1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) The Exim Maintainers 2020 - 2023 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
10 /* General functions concerned with transportation, and generic options for all
16 /* Generic options for transports, all of which live inside transport_instance
17 data blocks and which therefore have the opt_public flag set. Note that there
18 are other options living inside this structure which can be set only from
19 certain transports. */
20 #define LOFF(field) OPT_OFF(transport_instance, field)
22 optionlist optionlist_transports[] = {
24 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
26 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
28 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
29 LOFF(rewrite_existflags) },
30 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
31 LOFF(rewrite_rules) },
32 { "*set_group", opt_bool|opt_hidden|opt_public,
34 { "*set_user", opt_bool|opt_hidden|opt_public,
36 { "body_only", opt_bool|opt_public,
38 { "current_directory", opt_stringptr|opt_public,
40 { "debug_print", opt_stringptr | opt_public,
42 { "delivery_date_add", opt_bool|opt_public,
43 LOFF(delivery_date_add) },
44 { "disable_logging", opt_bool|opt_public,
45 LOFF(disable_logging) },
46 { "driver", opt_stringptr|opt_public,
48 { "envelope_to_add", opt_bool|opt_public,
49 LOFF(envelope_to_add) },
51 { "event_action", opt_stringptr | opt_public,
54 { "group", opt_expand_gid|opt_public,
56 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
58 { "headers_only", opt_bool|opt_public,
60 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
61 LOFF(remove_headers) },
62 { "headers_rewrite", opt_rewrite|opt_public,
63 LOFF(headers_rewrite) },
64 { "home_directory", opt_stringptr|opt_public,
66 { "initgroups", opt_bool|opt_public,
68 { "max_parallel", opt_stringptr|opt_public,
70 { "message_size_limit", opt_stringptr|opt_public,
71 LOFF(message_size_limit) },
72 { "rcpt_include_affixes", opt_bool|opt_public,
73 LOFF(rcpt_include_affixes) },
74 { "retry_use_local_part", opt_bool|opt_public,
75 LOFF(retry_use_local_part) },
76 { "return_path", opt_stringptr|opt_public,
78 { "return_path_add", opt_bool|opt_public,
79 LOFF(return_path_add) },
80 { "shadow_condition", opt_stringptr|opt_public,
81 LOFF(shadow_condition) },
82 { "shadow_transport", opt_stringptr|opt_public,
84 { "transport_filter", opt_stringptr|opt_public,
85 LOFF(filter_command) },
86 { "transport_filter_timeout", opt_time|opt_public,
87 LOFF(filter_timeout) },
88 { "user", opt_expand_uid|opt_public,
92 int optionlist_transports_size = nelem(optionlist_transports);
96 # include "macro_predef.h"
99 options_transports(void)
103 options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
105 for (transport_info * ti = transports_available; ti->driver_name[0]; ti++)
107 spf(buf, sizeof(buf), US"_DRIVER_TRANSPORT_%T", ti->driver_name);
108 builtin_macro_create(buf);
109 options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
113 #else /*!MACRO_PREDEF*/
115 /* Structure for keeping list of addresses that have been added to
116 Envelope-To:, in order to avoid duplication. */
124 /* Static data for write_chunk() */
126 static uschar *chunk_ptr; /* chunk pointer */
127 static uschar *nl_check; /* string to look for at line start */
128 static int nl_check_length; /* length of same */
129 static uschar *nl_escape; /* string to insert */
130 static int nl_escape_length; /* length of same */
131 static int nl_partial_match; /* length matched at chunk end */
134 /*************************************************
135 * Initialize transport list *
136 *************************************************/
138 /* Read the transports section of the configuration file, and set up a chain of
139 transport instances according to its contents. Each transport has generic
140 options and may also have its own private options. This function is only ever
141 called when transports == NULL. We use generic code in readconf to do most of
147 readconf_driver_init(US"transport",
148 (driver_instance **)(&transports), /* chain anchor */
149 (driver_info *)transports_available, /* available drivers */
150 sizeof(transport_info), /* size of info block */
151 &transport_defaults, /* default values for generic options */
152 sizeof(transport_instance), /* size of instance block */
153 optionlist_transports, /* generic options */
154 optionlist_transports_size);
156 /* Now scan the configured transports and check inconsistencies. A shadow
157 transport is permitted only for local transports. */
159 for (transport_instance * t = transports; t; t = t->next)
161 if (!t->info->local && t->shadow)
162 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
163 "shadow transport not allowed on non-local transport %s", t->name);
165 if (t->body_only && t->headers_only)
166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
167 "%s transport: body_only and headers_only are mutually exclusive",
174 /*************************************************
175 * Write block of data *
176 *************************************************/
179 tpt_write(int fd, uschar * block, int len, BOOL more, int options)
183 tls_out.active.sock == fd
184 ? tls_write(tls_out.active.tls_ctx, block, len, more) :
187 more && !(options & topt_not_socket) ? send(fd, block, len, MSG_MORE) :
189 write(fd, block, len);
192 /* Subroutine called by write_chunk() and at the end of the message actually
193 to write a data block. Also called directly by some transports to write
194 additional data to the file descriptor (e.g. prefix, suffix).
196 If a transport wants data transfers to be timed, it sets a non-zero value in
197 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
198 be set for each block of data written from here. If time runs out, then write()
199 fails and provokes an error return. The caller can then inspect sigalrm_seen to
202 On some systems, if a quota is exceeded during the write, the yield is the
203 number of bytes written rather than an immediate error code. This also happens
204 on some systems in other cases, for example a pipe that goes away because the
205 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
206 get the error codes the first time.
208 The write() function is also interruptible; the Solaris 2.6 man page says:
210 If write() is interrupted by a signal before it writes any
211 data, it will return -1 with errno set to EINTR.
213 If write() is interrupted by a signal after it successfully
214 writes some data, it will return the number of bytes written.
216 To handle these cases, we want to restart the write() to output the remainder
217 of the data after a non-negative return from write(), except after a timeout.
218 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
219 proper error then occurs. In principle, after an interruption, the second
220 write() could suffer the same fate, but we do not want to continue for
221 evermore, so stick a maximum repetition count on the loop to act as a
225 tctx transport context: file descriptor or string to write to
226 block block of bytes to write
227 len number of bytes to write
228 more further data expected soon
230 Returns: TRUE on success, FALSE on failure (with errno preserved);
231 transport_count is incremented by the number of bytes written
235 transport_write_block_fd(transport_ctx * tctx, uschar * block, int len, BOOL more)
238 int local_timeout = transport_write_timeout;
242 /* This loop is for handling incomplete writes and other retries. In most
243 normal cases, it is only ever executed once. */
245 for (int i = 0; i < 100; i++)
248 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
249 fd, len, local_timeout, more ? " (more expected)" : "");
251 /* When doing TCP Fast Open we may get this far before the 3-way handshake
252 is complete, and write returns ENOTCONN. Detect that, wait for the socket
253 to become writable, and retry once only. */
257 /* This code makes use of alarm() in order to implement the timeout. This
258 isn't a very tidy way of doing things. Using non-blocking I/O with select()
259 provides a neater approach. However, I don't know how to do this when TLS is
262 if (transport_write_timeout <= 0) /* No timeout wanted */
264 rc = tpt_write(fd, block, len, more, tctx->options);
267 else /* Timeout wanted. */
269 sigalrm_seen = FALSE;
270 ALARM(local_timeout);
271 rc = tpt_write(fd, block, len, more, tctx->options);
273 local_timeout = ALARM_CLR(0);
281 if (rc >= 0 || errno != ENOTCONN || connretry <= 0)
284 poll_one_fd(fd, POLLOUT, -1); /* could set timeout? retval check? */
288 /* Hopefully, the most common case is success, so test that first. */
290 if (rc == len) { transport_count += len; return TRUE; }
292 /* A non-negative return code is an incomplete write. Try again for the rest
293 of the block. If we have exactly hit the timeout, give up. */
299 transport_count += rc;
300 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
301 goto CHECK_TIMEOUT; /* A few lines below */
304 /* A negative return code with an EINTR error is another form of
305 incomplete write, zero bytes having been written */
307 if (save_errno == EINTR)
310 debug_printf("write interrupted before anything written\n");
311 goto CHECK_TIMEOUT; /* A few lines below */
314 /* A response of EAGAIN from write() is likely only in the case of writing
315 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
317 if (save_errno == EAGAIN)
320 debug_printf("write temporarily locked out, waiting 1 sec\n");
323 /* Before continuing to try another write, check that we haven't run out of
327 if (transport_write_timeout > 0 && local_timeout <= 0)
335 /* Otherwise there's been an error */
337 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
338 strerror(save_errno));
343 /* We've tried and tried and tried but still failed */
345 errno = ERRNO_WRITEINCOMPLETE;
351 transport_write_block(transport_ctx * tctx, uschar *block, int len, BOOL more)
353 if (!(tctx->options & topt_output_string))
354 return transport_write_block_fd(tctx, block, len, more);
356 /* Write to expanding-string. NOTE: not NUL-terminated */
359 tctx->u.msg = string_get(1024);
361 tctx->u.msg = string_catn(tctx->u.msg, block, len);
368 /*************************************************
369 * Write formatted string *
370 *************************************************/
372 /* This is called by various transports. It is a convenience function.
377 ... arguments for format
379 Returns: the yield of transport_write_block()
383 transport_write_string(int fd, const char *format, ...)
385 transport_ctx tctx = {{0}};
386 gstring gs = { .size = big_buffer_size, .ptr = 0, .s = big_buffer };
389 /* Use taint-unchecked routines for writing into big_buffer, trusting
390 that the result will never be expanded. */
392 va_start(ap, format);
393 if (!string_vformat(&gs, SVFMT_TAINT_NOCHK, format, ap))
394 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
397 return transport_write_block(&tctx, gs.s, gs.ptr, FALSE);
404 transport_write_reset(int options)
406 if (!(options & topt_continuation)) chunk_ptr = deliver_out_buffer;
407 nl_partial_match = -1;
408 nl_check_length = nl_escape_length = 0;
413 /*************************************************
414 * Write character chunk *
415 *************************************************/
417 /* Subroutine used by transport_write_message() to scan character chunks for
418 newlines and act appropriately. The object is to minimise the number of writes.
419 The output byte stream is buffered up in deliver_out_buffer, which is written
420 only when it gets full, thus minimizing write operations and TCP packets.
422 Static data is used to handle the case when the last character of the previous
423 chunk was NL, or matched part of the data that has to be escaped.
426 tctx transport context - processing to be done during output,
427 and file descriptor to write to
428 chunk pointer to data to write
429 len length of data to write
431 In addition, the static nl_xxx variables must be set as required.
433 Returns: TRUE on success, FALSE on failure (with errno preserved)
437 write_chunk(transport_ctx * tctx, uschar *chunk, int len)
439 uschar *start = chunk;
440 uschar *end = chunk + len;
441 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
443 /* The assumption is made that the check string will never stretch over move
444 than one chunk since the only time there are partial matches is when copying
445 the body in large buffers. There is always enough room in the buffer for an
446 escape string, since the loop below ensures this for each character it
447 processes, and it won't have stuck in the escape string if it left a partial
450 if (nl_partial_match >= 0)
452 if (nl_check_length > 0 && len >= nl_check_length &&
453 Ustrncmp(start, nl_check + nl_partial_match,
454 nl_check_length - nl_partial_match) == 0)
456 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
457 chunk_ptr += nl_escape_length;
458 start += nl_check_length - nl_partial_match;
461 /* The partial match was a false one. Insert the characters carried over
462 from the previous chunk. */
464 else if (nl_partial_match > 0)
466 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
467 chunk_ptr += nl_partial_match;
470 nl_partial_match = -1;
473 /* Now process the characters in the chunk. Whenever we hit a newline we check
474 for possible escaping. The code for the non-NL route should be as fast as
477 for (uschar * ptr = start; ptr < end; ptr++)
481 /* Flush the buffer if it has reached the threshold - we want to leave enough
482 room for the next uschar, plus a possible extra CR for an LF, plus the escape
485 if ((len = chunk_ptr - deliver_out_buffer) > mlen)
487 DEBUG(D_transport) debug_printf("flushing headers buffer\n");
489 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
490 from previous SMTP commands. */
492 if (tctx->options & topt_use_bdat && tctx->chunk_cb)
494 if ( tctx->chunk_cb(tctx, (unsigned)len, 0) != OK
495 || !transport_write_block(tctx, deliver_out_buffer, len, FALSE)
496 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
501 if (!transport_write_block(tctx, deliver_out_buffer, len, FALSE))
503 chunk_ptr = deliver_out_buffer;
506 /* Remove CR before NL if required */
508 if ( *ptr == '\r' && ptr[1] == '\n'
509 && !(tctx->options & topt_use_crlf)
510 && f.spool_file_wireformat
514 if ((ch = *ptr) == '\n')
516 int left = end - ptr - 1; /* count of chars left after NL */
518 /* Insert CR before NL if required */
520 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
523 transport_newlines++;
525 /* The check_string test (formerly "from hack") replaces the specific
526 string at the start of a line with an escape string (e.g. "From " becomes
527 ">From " or "." becomes "..". It is a case-sensitive test. The length
528 check above ensures there is always enough room to insert this string. */
530 if (nl_check_length > 0)
532 if (left >= nl_check_length &&
533 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
535 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
536 chunk_ptr += nl_escape_length;
537 ptr += nl_check_length;
540 /* Handle the case when there isn't enough left to match the whole
541 check string, but there may be a partial match. We remember how many
542 characters matched, and finish processing this chunk. */
544 else if (left <= 0) nl_partial_match = 0;
546 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
548 nl_partial_match = left;
554 /* Not a NL character */
556 else *chunk_ptr++ = ch;
565 /*************************************************
566 * Generate address for RCPT TO *
567 *************************************************/
569 /* This function puts together an address for RCPT to, using the caseful
570 version of the local part and the caseful version of the domain. If there is no
571 prefix or suffix, or if affixes are to be retained, we can just use the
572 original address. Otherwise, if there is a prefix but no suffix we can use a
573 pointer into the original address. If there is a suffix, however, we have to
577 addr the address item
578 include_affixes TRUE if affixes are to be included
584 transport_rcpt_address(address_item *addr, BOOL include_affixes)
591 setflag(addr, af_include_affixes); /* Affects logged => line */
592 return addr->address;
597 if (!addr->prefix) return addr->address;
598 return addr->address + Ustrlen(addr->prefix);
601 at = Ustrrchr(addr->address, '@');
602 plen = addr->prefix ? Ustrlen(addr->prefix) : 0;
603 slen = Ustrlen(addr->suffix);
605 return string_sprintf("%.*s@%s", (int)(at - addr->address - plen - slen),
606 addr->address + plen, at + 1);
610 /*************************************************
611 * Output Envelope-To: address & scan duplicates *
612 *************************************************/
614 /* This function is called from internal_transport_write_message() below, when
615 generating an Envelope-To: header line. It checks for duplicates of the given
616 address and its ancestors. When one is found, this function calls itself
617 recursively, to output the envelope address of the duplicate.
619 We want to avoid duplication in the list, which can arise for example when
620 A->B,C and then both B and C alias to D. This can also happen when there are
621 unseen drivers in use. So a list of addresses that have been output is kept in
624 It is also possible to have loops in the address ancestry/duplication graph,
625 for example if there are two top level addresses A and B and we have A->B,C and
626 B->A. To break the loop, we use a list of processed addresses in the dlist
629 After handling duplication, this function outputs the progenitor of the given
633 p the address we are interested in
634 pplist address of anchor of the list of addresses not to output
635 pdlist address of anchor of the list of processed addresses
636 first TRUE if this is the first address; set it FALSE afterwards
637 tctx transport context - processing to be done during output
638 and the file descriptor to write to
640 Returns: FALSE if writing failed
644 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
645 BOOL *first, transport_ctx * tctx)
650 /* Do nothing if we have already handled this address. If not, remember it
651 so that we don't handle it again. */
653 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
655 ppp = store_get(sizeof(struct aci), GET_UNTAINTED);
660 /* Now scan up the ancestry, checking for duplicates at each generation. */
662 for (pp = p;; pp = pp->parent)
665 for (dup = addr_duplicate; dup; dup = dup->next)
666 if (dup->dupof == pp) /* a dup of our address */
667 if (!write_env_to(dup, pplist, pdlist, first, tctx))
669 if (!pp->parent) break;
672 /* Check to see if we have already output the progenitor. */
674 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
675 if (ppp) return TRUE;
677 /* Remember what we have output, and output it. */
679 ppp = store_get(sizeof(struct aci), GET_UNTAINTED);
684 if (!*first && !write_chunk(tctx, US",\n ", 3)) return FALSE;
686 return write_chunk(tctx, pp->address, Ustrlen(pp->address));
692 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
698 addr (chain of) addresses (for extra headers), or NULL;
699 only the first address is used
700 tctx transport context
701 sendfn function for output (transport or verify)
703 Returns: TRUE on success; FALSE on failure.
706 transport_headers_send(transport_ctx * tctx,
707 BOOL (*sendfn)(transport_ctx * tctx, uschar * s, int len))
710 transport_instance * tblock = tctx ? tctx->tblock : NULL;
711 address_item * addr = tctx ? tctx->addr : NULL;
713 /* Then the message's headers. Don't write any that are flagged as "old";
714 that means they were rewritten, or are a record of envelope rewriting, or
715 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
716 match any entries therein. It is a colon-sep list; expand the items
717 separately and squash any empty ones.
718 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
720 for (header_line * h = header_list; h; h = h->next) if (h->type != htype_old)
722 BOOL include_header = TRUE;
724 list = tblock ? tblock->remove_headers : NULL;
725 for (int i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
729 int sep = ':'; /* This is specified as a colon-separated list */
731 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
736 if (!(s = expand_string(s)) && !f.expand_string_forcedfail)
738 errno = ERRNO_CHHEADER_FAIL;
741 len = s ? Ustrlen(s) : 0;
742 if (len && s[len-1] == '*') /* trailing glob */
744 if (strncmpic(h->text, s, len-1) == 0) break;
748 if (strncmpic(h->text, s, len) != 0) continue;
750 while (*ss == ' ' || *ss == '\t') ss++;
751 if (*ss == ':') break;
754 if (s) { include_header = FALSE; break; }
756 if (addr) list = addr->prop.remove_headers;
759 /* If this header is to be output, try to rewrite it if there are rewriting
765 if (tblock && tblock->rewrite_rules)
767 rmark reset_point = store_mark();
770 if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
771 tblock->rewrite_existflags, FALSE)))
774 if (tctx->options & topt_truncate_headers && len > 998) len = 998;
775 if (!sendfn(tctx, hh->text, len)) return FALSE;
776 store_reset(reset_point);
777 continue; /* With the next header line */
781 /* Either no rewriting rules, or it didn't get rewritten */
784 if (tctx->options & topt_truncate_headers && len > 998) len = 998;
785 if (!sendfn(tctx, h->text, len)) return FALSE;
791 DEBUG(D_transport) debug_printf("removed header line:\n %s---\n", h->text);
794 /* Add on any address-specific headers. If there are multiple addresses,
795 they will all have the same headers in order to be batched. The headers
796 are chained in reverse order of adding (so several addresses from the
797 same alias might share some of them) but we want to output them in the
798 opposite order. This is a bit tedious, but there shouldn't be very many
799 of them. We just walk the list twice, reversing the pointers each time,
800 but on the second time, write out the items.
802 Headers added to an address by a router are guaranteed to end with a newline.
807 header_line * hprev = addr->prop.extra_headers, * hnext, * h;
809 for (int i = 0; i < 2; i++)
810 for (h = hprev, hprev = NULL; h; h = hnext)
817 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
819 debug_printf("added header line(s):\n %s---\n", h->text);
824 /* If a string containing additional headers exists it is a newline-sep
825 list. Expand each item and write out the result. This is done last so that
826 if it (deliberately or accidentally) isn't in header format, it won't mess
827 up any other headers. An empty string or a forced expansion failure are
828 noops. An added header string from a transport may not end with a newline;
829 add one if it does not. */
831 if (tblock && (list = CUS tblock->add_headers))
836 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
837 if ((s = expand_string(s)))
839 int len = Ustrlen(s);
842 if (!sendfn(tctx, s, len)) return FALSE;
843 if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
847 debug_printf("added header line:\n %s", s);
848 if (s[len-1] != '\n') debug_printf("\n");
849 debug_printf("---\n");
853 else if (!f.expand_string_forcedfail)
854 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
857 /* Separate headers from body with a blank line */
859 return sendfn(tctx, US"\n", 1);
863 /*************************************************
864 * Write the message *
865 *************************************************/
867 /* This function writes the message to the given file descriptor. The headers
868 are in the in-store data structure, and the rest of the message is in the open
869 file descriptor deliver_datafile. Make sure we start it at the beginning.
871 . If add_return_path is TRUE, a "return-path:" header is added to the message,
872 containing the envelope sender's address.
874 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
875 giving the top-level envelope address that caused this delivery to happen.
877 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
878 message. It gives the time and date that delivery took place.
880 . If check_string is not null, the start of each line is checked for that
881 string. If it is found, it is replaced by escape_string. This used to be
882 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
884 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
886 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
887 any writing or reading error, leaving the code in errno intact. Error exits
888 can include timeouts for certain transports, which are requested by setting
889 transport_write_timeout non-zero.
893 (fd, msg) Either an fd, to write the message to,
894 or a string: if null write message to allocated space
895 otherwire take content as headers.
896 addr (chain of) addresses (for extra headers), or NULL;
897 only the first address is used
898 tblock optional transport instance block (NULL signifies NULL/0):
899 add_headers a string containing one or more headers to add; it is
900 expanded, and must be in correct RFC 822 format as
901 it is transmitted verbatim; NULL => no additions,
902 and so does empty string or forced expansion fail
903 remove_headers a colon-separated list of headers to remove, or NULL
904 rewrite_rules chain of header rewriting rules
905 rewrite_existflags flags for the rewriting rules
906 options bit-wise options:
907 add_return_path if TRUE, add a "return-path" header
908 add_envelope_to if TRUE, add a "envelope-to" header
909 add_delivery_date if TRUE, add a "delivery-date" header
910 use_crlf if TRUE, turn NL into CR LF
911 end_dot if TRUE, send a terminating "." line at the end
912 no_flush if TRUE, do not flush at end
913 no_headers if TRUE, omit the headers
914 no_body if TRUE, omit the body
915 check_string a string to check for at the start of lines, or NULL
916 escape_string a string to insert in front of any check string
917 size_limit if > 0, this is a limit to the size of message written;
918 it is used when returning messages to their senders,
919 and is approximate rather than exact, owing to chunk
922 Returns: TRUE on success; FALSE (with errno) on failure.
923 In addition, the global variable transport_count
924 is incremented by the number of bytes written.
928 internal_transport_write_message(transport_ctx * tctx, int size_limit)
932 /* Initialize pointer in output buffer. */
934 transport_write_reset(tctx->options);
936 /* Set up the data for start-of-line data checking and escaping */
938 if (tctx->check_string && tctx->escape_string)
940 nl_check = tctx->check_string;
941 nl_check_length = Ustrlen(nl_check);
942 nl_escape = tctx->escape_string;
943 nl_escape_length = Ustrlen(nl_escape);
946 /* Whether the escaping mechanism is applied to headers or not is controlled by
947 an option (set for SMTP, not otherwise). Negate the length if not wanted till
948 after the headers. */
950 if (!(tctx->options & topt_escape_headers))
951 nl_check_length = -nl_check_length;
953 /* Write the headers if required, including any that have to be added. If there
954 are header rewriting rules, apply them. The datasource is not the -D spoolfile
955 so temporarily hide the global that adjusts for its format. */
957 if (!(tctx->options & topt_no_headers))
959 BOOL save_wireformat = f.spool_file_wireformat;
960 f.spool_file_wireformat = FALSE;
962 /* Add return-path: if requested. */
964 if (tctx->options & topt_add_return_path)
967 uschar * s = string_sprintf("Return-path: <%.*s>\n%n",
968 EXIM_EMAILADDR_MAX, return_path, &n);
969 if (!write_chunk(tctx, s, n)) goto bad;
972 /* Add envelope-to: if requested */
974 if (tctx->options & topt_add_envelope_to)
977 struct aci *plist = NULL;
978 struct aci *dlist = NULL;
979 rmark reset_point = store_mark();
981 if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
983 /* Pick up from all the addresses. The plist and dlist variables are
984 anchors for lists of addresses already handled; they have to be defined at
985 this level because write_env_to() calls itself recursively. */
987 for (address_item * p = tctx->addr; p; p = p->next)
988 if (!write_env_to(p, &plist, &dlist, &first, tctx))
991 /* Add a final newline and reset the store used for tracking duplicates */
993 if (!write_chunk(tctx, US"\n", 1)) goto bad;
994 store_reset(reset_point);
997 /* Add delivery-date: if requested. */
999 if (tctx->options & topt_add_delivery_date)
1001 uschar * s = tod_stamp(tod_full);
1003 if ( !write_chunk(tctx, US"Delivery-date: ", 15)
1004 || !write_chunk(tctx, s, Ustrlen(s))
1005 || !write_chunk(tctx, US"\n", 1)) goto bad;
1008 /* Then the message's headers. Don't write any that are flagged as "old";
1009 that means they were rewritten, or are a record of envelope rewriting, or
1010 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
1011 match any entries therein. Then check addr->prop.remove_headers too, provided that
1012 addr is not NULL. */
1014 if (!transport_headers_send(tctx, &write_chunk))
1017 f.spool_file_wireformat = save_wireformat;
1021 f.spool_file_wireformat = save_wireformat;
1024 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
1025 last-BDAT, consisting of the current write_chunk() output buffer fill
1026 (optimally, all of the headers - but it does not matter if we already had to
1027 flush that buffer with non-last BDAT prependix) plus the amount of body data
1028 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
1029 that further use of write_chunk() will not prepend BDATs.
1030 The first BDAT written will also first flush any outstanding MAIL and RCPT
1031 commands which were buffered thans to PIPELINING.
1032 Commands go out (using a send()) from a different buffer to data (using a
1033 write()). They might not end up in the same TCP segment, which is
1036 if (tctx->options & topt_use_bdat)
1041 if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1043 if (!(tctx->options & topt_no_body))
1045 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1046 fsize -= spool_data_start_offset(message_id);
1047 if (size_limit > 0 && fsize > size_limit)
1049 size = hsize + fsize;
1050 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
1051 size += body_linecount; /* account for CRLF-expansion */
1053 /* With topt_use_bdat we never do dot-stuffing; no need to
1054 account for any expansion due to that. */
1057 /* If the message is large, emit first a non-LAST chunk with just the
1058 headers, and reap the command responses. This lets us error out early
1059 on RCPT rejects rather than sending megabytes of data. Include headers
1060 on the assumption they are cheap enough and some clever implementations
1061 might errorcheck them too, on-the-fly, and reject that chunk. */
1063 if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1066 debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1067 if ( tctx->chunk_cb(tctx, hsize, 0) != OK
1068 || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1069 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1072 chunk_ptr = deliver_out_buffer;
1076 /* Emit a LAST datachunk command, and unmark the context for further
1079 if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1081 tctx->options &= ~topt_use_bdat;
1084 /* If the body is required, ensure that the data for check strings (formerly
1085 the "from hack") is enabled by negating the length if necessary. (It will be
1086 negative in cases where it isn't to apply to the headers). Then ensure the body
1087 is positioned at the start of its file (following the message id), then write
1088 it, applying the size limit if required. */
1090 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1091 and we want to send a body without dotstuffing or ending-dot, in-clear,
1092 then we can just dump it using sendfile.
1093 This should get used for CHUNKING output and also for writing the -K file for
1094 dkim signing, when we had CHUNKING input. */
1097 if ( f.spool_file_wireformat
1098 && !(tctx->options & (topt_no_body | topt_end_dot))
1100 && tls_out.active.sock != tctx->u.fd
1104 off_t offset = spool_data_start_offset(message_id);
1106 /* Write out any header data in the buffer */
1108 if ((len = chunk_ptr - deliver_out_buffer) > 0)
1110 if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1115 DEBUG(D_transport) debug_printf("using sendfile for body\n");
1119 if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1125 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1129 if (!(tctx->options & topt_no_body))
1130 debug_printf("cannot use sendfile for body: %s\n",
1131 !f.spool_file_wireformat ? "spoolfile not wireformat"
1132 : tctx->options & topt_end_dot ? "terminating dot wanted"
1133 : nl_check_length ? "dot- or From-stuffing wanted"
1134 : "TLS output wanted");
1136 if (!(tctx->options & topt_no_body))
1138 unsigned long size = size_limit > 0 ? size_limit : ULONG_MAX;
1140 nl_check_length = abs(nl_check_length);
1141 nl_partial_match = 0;
1142 if (lseek(deliver_datafile, spool_data_start_offset(message_id), SEEK_SET) < 0)
1144 while ( (len = MIN(DELIVER_IN_BUFFER_SIZE, size)) > 0
1145 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1147 if (!write_chunk(tctx, deliver_in_buffer, len))
1152 /* A read error on the body will have left len == -1 and errno set. */
1154 if (len != 0) return FALSE;
1157 /* Finished with the check string, and spool-format consideration */
1159 nl_check_length = nl_escape_length = 0;
1160 f.spool_file_wireformat = FALSE;
1162 /* If requested, add a terminating "." line (SMTP output). */
1164 if (tctx->options & topt_end_dot)
1166 smtp_debug_cmd(US".", 0);
1167 if (!write_chunk(tctx, US".\n", 2))
1171 /* Write out any remaining data in the buffer before returning. */
1173 return (len = chunk_ptr - deliver_out_buffer) <= 0
1174 || transport_write_block(tctx, deliver_out_buffer, len,
1175 !!(tctx->options & topt_no_flush));
1181 /*************************************************
1182 * External interface to write the message *
1183 *************************************************/
1185 /* If there is no filtering required, call the internal function above to do
1186 the real work, passing over all the arguments from this function. Otherwise,
1187 set up a filtering process, fork another process to call the internal function
1188 to write to the filter, and in this process just suck from the filter and write
1189 down the fd in the transport context. At the end, tidy up the pipes and the
1192 Arguments: as for internal_transport_write_message() above
1194 Returns: TRUE on success; FALSE (with errno) for any failure
1195 transport_count is incremented by the number of bytes written
1199 transport_write_message(transport_ctx * tctx, int size_limit)
1201 BOOL last_filter_was_NL = TRUE;
1202 BOOL save_spool_file_wireformat = f.spool_file_wireformat;
1204 int rc, len, fd_read, fd_write, save_errno;
1205 int pfd[2] = {-1, -1};
1206 pid_t filter_pid, write_pid;
1208 f.transport_filter_timed_out = FALSE;
1210 /* If there is no filter command set up, call the internal function that does
1211 the actual work, passing it the incoming fd, and return its result. */
1213 if ( !transport_filter_argv
1214 || !*transport_filter_argv
1215 || !**transport_filter_argv
1217 return internal_transport_write_message(tctx, size_limit);
1219 /* Otherwise the message must be written to a filter process and read back
1220 before being written to the incoming fd. First set up the special processing to
1221 be done during the copying. */
1223 nl_partial_match = -1;
1225 if (tctx->check_string && tctx->escape_string)
1227 nl_check = tctx->check_string;
1228 nl_check_length = Ustrlen(nl_check);
1229 nl_escape = tctx->escape_string;
1230 nl_escape_length = Ustrlen(nl_escape);
1232 else nl_check_length = nl_escape_length = 0;
1234 /* Start up a subprocess to run the command. Ensure that our main fd will
1235 be closed when the subprocess execs, but remove the flag afterwards.
1236 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1237 process to deliver another message.) We get back stdin/stdout file descriptors.
1238 If the process creation failed, give an error return. */
1244 write_pid = (pid_t)(-1);
1247 int bits = fcntl(tctx->u.fd, F_GETFD);
1248 (void) fcntl(tctx->u.fd, F_SETFD, bits | FD_CLOEXEC);
1249 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1250 &fd_write, &fd_read, FALSE, US"transport-filter");
1251 (void) fcntl(tctx->u.fd, F_SETFD, bits & ~FD_CLOEXEC);
1253 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1256 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1257 (int)filter_pid, fd_write, fd_read);
1259 /* Fork subprocess to write the message to the filter, and return the result
1260 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1261 smtp dots, or check string processing. */
1263 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1264 if ((write_pid = exim_fork(US"tpt-filter-writer")) == 0)
1267 (void)close(fd_read);
1268 (void)close(pfd[pipe_read]);
1269 nl_check_length = nl_escape_length = 0;
1271 tctx->u.fd = fd_write;
1272 tctx->check_string = tctx->escape_string = NULL;
1273 tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat | topt_no_flush);
1275 rc = internal_transport_write_message(tctx, size_limit);
1278 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1280 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1282 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1284 || write(pfd[pipe_write], (void *)&tctx->addr->delivery_time, sizeof(struct timeval))
1285 != sizeof(struct timeval)
1287 rc = FALSE; /* compiler quietening */
1288 exim_underbar_exit(EXIT_SUCCESS);
1292 /* Parent process: close our copy of the writing subprocess' pipes. */
1294 (void)close(pfd[pipe_write]);
1295 (void)close(fd_write);
1298 /* Writing process creation failed */
1302 errno = save_errno; /* restore */
1306 /* When testing, let the subprocess get going */
1308 testharness_pause_ms(250);
1311 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1313 /* Copy the message from the filter to the output fd. A read error leaves len
1314 == -1 and errno set. We need to apply a timeout to the read, to cope with
1315 the case when the filter gets stuck, but it can be quite a long one. The
1316 default is 5m, but this is now configurable. */
1318 DEBUG(D_transport) debug_printf("copying from the filter\n");
1320 /* Copy the output of the filter, remembering if the last character was NL. If
1321 no data is returned, that counts as "ended with NL" (default setting of the
1322 variable is TRUE). The output should always be unix-format as we converted
1323 any wireformat source on writing input to the filter. */
1325 f.spool_file_wireformat = FALSE;
1326 chunk_ptr = deliver_out_buffer;
1330 sigalrm_seen = FALSE;
1331 ALARM(transport_filter_timeout);
1332 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1336 DEBUG(D_transport) debug_printf("timed out reading from filter\n");
1338 f.transport_filter_timed_out = TRUE;
1342 /* If the read was successful, write the block down the original fd,
1343 remembering whether it ends in \n or not. */
1347 if (!write_chunk(tctx, deliver_in_buffer, len)) goto TIDY_UP;
1348 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1351 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1355 if (len == 0) yield = TRUE;
1360 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1361 to something. Ensure the pipes are all closed and the processes are removed. If
1362 there has been an error, kill the processes before waiting for them, just to be
1363 sure. Also apply a paranoia timeout. */
1366 f.spool_file_wireformat = save_spool_file_wireformat;
1369 (void)close(fd_read);
1370 if (fd_write > 0) (void)close(fd_write);
1374 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1375 if (write_pid > 0) kill(write_pid, SIGKILL);
1378 /* Wait for the filter process to complete. */
1380 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1381 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1384 save_errno = ERRNO_FILTER_FAIL;
1385 tctx->addr->more_errno = rc;
1386 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1389 /* Wait for the writing process to complete. If it ends successfully,
1390 read the results from its pipe, provided we haven't already had a filter
1393 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1396 rc = child_close(write_pid, 30);
1401 if (read(pfd[pipe_read], (void *)&ok, sizeof(BOOL)) != sizeof(BOOL))
1404 debug_printf("pipe read from writing process: %s\n", strerror(errno));
1405 save_errno = ERRNO_FILTER_FAIL;
1409 { /* Try to drain the pipe; read fails are don't care */
1410 int dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1411 dummy = read(pfd[pipe_read], (void *)&tctx->addr->more_errno, sizeof(int));
1412 dummy = read(pfd[pipe_read], (void *)&tctx->addr->delivery_time, sizeof(struct timeval));
1419 save_errno = ERRNO_FILTER_FAIL;
1420 tctx->addr->more_errno = rc;
1421 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1424 (void)close(pfd[pipe_read]);
1426 /* If there have been no problems we can now add the terminating "." if this is
1427 SMTP output, turning off escaping beforehand. If the last character from the
1428 filter was not NL, insert a NL to make the SMTP protocol work. */
1432 nl_check_length = nl_escape_length = 0;
1433 f.spool_file_wireformat = FALSE;
1434 if ( tctx->options & topt_end_dot
1435 && ( last_filter_was_NL
1436 ? !write_chunk(tctx, US".\n", 2)
1437 : !write_chunk(tctx, US"\n.\n", 3)
1439 { smtp_debug_cmd(US".", 0); yield = FALSE; }
1441 /* Write out any remaining data in the buffer. */
1444 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1445 || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1448 errno = save_errno; /* From some earlier error */
1452 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1454 debug_printf(" errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1464 /*************************************************
1465 * Update waiting database *
1466 *************************************************/
1468 /* This is called when an address is deferred by remote transports that are
1469 capable of sending more than one message over one connection. A database is
1470 maintained for each transport, keeping track of which messages are waiting for
1471 which hosts. The transport can then consult this when eventually a successful
1472 delivery happens, and if it finds that another message is waiting for the same
1473 host, it can fire up a new process to deal with it using the same connection.
1475 The database records are keyed by host name. They can get full if there are
1476 lots of messages waiting, and so there is a continuation mechanism for them.
1478 Each record contains a list of message ids, packed end to end without any
1479 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1480 in this record, and the sequence field says if there are any other records for
1481 this host. If the sequence field is 0, there are none. If it is 1, then another
1482 record with the name <hostname>:0 exists; if it is 2, then two other records
1483 with sequence numbers 0 and 1 exist, and so on.
1485 Currently, an exhaustive search of all continuation records has to be done to
1486 determine whether to add a message id to a given record. This shouldn't be
1487 too bad except in extreme cases. I can't figure out a *simple* way of doing
1490 Old records should eventually get swept up by the exim_tidydb utility.
1493 hostlist list of hosts that this message could be sent to
1494 tpname name of the transport
1500 transport_update_waiting(host_item * hostlist, uschar * tpname)
1502 const uschar *prevname = US"";
1506 if (!is_new_message_id(message_id))
1508 DEBUG(D_transport) debug_printf("message_id %s is not new format; "
1509 "skipping wait-%s database update\n", tpname);
1513 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1515 /* Open the database for this transport */
1517 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", tpname),
1518 O_RDWR, &dbblock, TRUE, TRUE)))
1521 /* Scan the list of hosts for which this message is waiting, and ensure
1522 that the message id is in each host record. */
1524 for (host_item * host = hostlist; host; host = host->next)
1526 BOOL already = FALSE;
1527 dbdata_wait * host_record;
1531 /* Skip if this is the same host as we just processed; otherwise remember
1532 the name for next time. */
1534 if (Ustrcmp(prevname, host->name) == 0) continue;
1535 prevname = host->name;
1537 /* Look up the host record; if there isn't one, make an empty one. */
1539 if (!(host_record = dbfn_read(dbm_file, host->name)))
1541 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH, GET_UNTAINTED);
1542 host_record->count = host_record->sequence = 0;
1545 /* Compute the current length */
1547 host_length = host_record->count * MESSAGE_ID_LENGTH;
1549 /* Search the record to see if the current message is already in it. */
1551 for (uschar * s = host_record->text; s < host_record->text + host_length;
1552 s += MESSAGE_ID_LENGTH)
1554 /* If any ID is seen which is not new-format, wipe the record and
1555 any continuations */
1557 if (!is_new_message_id(s))
1559 DEBUG(D_hints_lookup)
1560 debug_printf_indent("NOTE: old or corrupt message-id found in wait=%.200s"
1561 " hints DB; deleting records for %s\n", tpname, host->name);
1563 (void) dbfn_delete(dbm_file, host->name);
1564 for (int i = host_record->sequence - 1; i >= 0; i--)
1565 (void) dbfn_delete(dbm_file,
1566 (sprintf(CS buffer, "%.200s:%d", host->name, i), buffer));
1568 host_record->count = host_record->sequence = 0;
1571 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1572 { already = TRUE; break; }
1575 /* If we haven't found this message in the main record, search any
1576 continuation records that exist. */
1578 for (int i = host_record->sequence - 1; i >= 0 && !already; i--)
1581 sprintf(CS buffer, "%.200s:%d", host->name, i);
1582 if ((cont = dbfn_read(dbm_file, buffer)))
1584 int clen = cont->count * MESSAGE_ID_LENGTH;
1585 for (uschar * s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1586 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1587 { already = TRUE; break; }
1591 /* If this message is already in a record, no need to update. */
1595 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1600 /* If this record is full, write it out with a new name constructed
1601 from the sequence number, increase the sequence number, and empty
1602 the record. If we're doing a two-phase queue run initial phase, ping the
1603 daemon to consider running a delivery on this host. */
1605 if (host_record->count >= WAIT_NAME_MAX)
1607 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1608 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1609 #ifndef DISABLE_QUEUE_RAMP
1610 if (f.queue_2stage && queue_fast_ramp && !queue_run_in_order)
1611 queue_notify_daemon(message_id);
1613 host_record->sequence++;
1614 host_record->count = 0;
1618 /* If this record is not full, increase the size of the record to
1619 allow for one new message id. */
1624 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH, GET_UNTAINTED);
1625 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1629 /* Now add the new name on the end */
1631 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1632 host_record->count++;
1633 host_length += MESSAGE_ID_LENGTH;
1635 /* Update the database */
1637 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1638 DEBUG(D_transport) debug_printf("added %.*s to queue for %s\n",
1639 MESSAGE_ID_LENGTH, message_id, host->name);
1644 dbfn_close(dbm_file);
1650 /*************************************************
1651 * Test for waiting messages *
1652 *************************************************/
1654 /* This function is called by a remote transport which uses the previous
1655 function to remember which messages are waiting for which remote hosts. It's
1656 called after a successful delivery and its job is to check whether there is
1657 another message waiting for the same host. However, it doesn't do this if the
1658 current continue sequence is greater than the maximum supplied as an argument,
1659 or greater than the global connection_max_messages, which, if set, overrides.
1662 transport_name name of the transport
1663 hostname name of the host
1664 local_message_max maximum number of messages down one connection
1665 as set by the caller transport
1666 new_message_id set to the message id of a waiting message
1667 oicf_func function to call to validate if it is ok to send
1668 to this message_id from the current instance.
1669 oicf_data opaque data for oicf_func
1671 Returns: TRUE if new_message_id set; FALSE otherwise
1674 typedef struct msgq_s
1676 uschar message_id [MESSAGE_ID_LENGTH + 1];
1681 transport_check_waiting(const uschar * transport_name, const uschar * hostname,
1682 int local_message_max, uschar * new_message_id,
1683 oicf oicf_func, void * oicf_data)
1685 dbdata_wait * host_record;
1691 struct stat statbuf;
1695 debug_printf("transport_check_waiting entered\n");
1696 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1697 continue_sequence, local_message_max, connection_max_messages);
1701 /* Do nothing if we have hit the maximum number that can be send down one
1704 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1705 if (local_message_max > 0 && continue_sequence >= local_message_max)
1708 debug_printf_indent("max messages for one connection reached: returning\n");
1712 /* Open the waiting information database. */
1714 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1715 O_RDWR, &dbblock, TRUE, TRUE)))
1718 /* See if there is a record for this host; if not, there's nothing to do. */
1720 if (!(host_record = dbfn_read(dbm_file, hostname)))
1722 dbfn_close(dbm_file);
1723 DEBUG(D_transport) debug_printf_indent("no messages waiting for %s\n", hostname);
1727 /* If the data in the record looks corrupt, just log something and
1728 don't try to use it. */
1730 if (host_record->count > WAIT_NAME_MAX)
1732 dbfn_close(dbm_file);
1733 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1734 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1738 /* Scan the message ids in the record from the end towards the beginning,
1739 until one is found for which a spool file actually exists. If the record gets
1740 emptied, delete it and continue with any continuation records that may exist.
1743 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1744 but the 1 off will remain without it. This code now allows me to SKIP over
1745 a message I do not want to send out on this run. */
1747 host_length = host_record->count * MESSAGE_ID_LENGTH;
1753 int msgq_actual = 0;
1754 BOOL bFound = FALSE;
1755 BOOL bContinuation = FALSE;
1757 /* create an array to read entire message queue into memory for processing */
1759 msgq = store_get(sizeof(msgq_t) * host_record->count, GET_UNTAINTED);
1760 msgq_count = host_record->count;
1761 msgq_actual = msgq_count;
1763 for (i = 0; i < host_record->count; ++i)
1765 /* If any ID is seen which is not new-format, wipe the record and
1766 any continuations */
1768 if (!is_new_message_id(host_record->text + (i * MESSAGE_ID_LENGTH)))
1771 DEBUG(D_hints_lookup)
1772 debug_printf_indent("NOTE: old or corrupt message-id found in wait=%.200s"
1773 " hints DB; deleting records for %s\n", transport_name, hostname);
1774 (void) dbfn_delete(dbm_file, hostname);
1775 for (int i = host_record->sequence - 1; i >= 0; i--)
1776 (void) dbfn_delete(dbm_file,
1777 (sprintf(CS buffer, "%.200s:%d", hostname, i), buffer));
1778 dbfn_close(dbm_file);
1781 msgq[i].bKeep = TRUE;
1783 Ustrncpy_nt(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1785 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1788 /* first thing remove current message id if it exists */
1789 /*XXX but what if it has un-sent addrs? */
1791 for (i = 0; i < msgq_count; ++i)
1792 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1794 msgq[i].bKeep = FALSE;
1798 /* now find the next acceptable message_id */
1800 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1803 uschar * mid = msgq[i].message_id;
1805 set_subdir_str(subdir, mid, 0);
1806 if (Ustat(spool_fname(US"input", subdir, mid, US"-D"), &statbuf) != 0)
1807 msgq[i].bKeep = FALSE;
1808 else if (!oicf_func || oicf_func(mid, oicf_data))
1810 Ustrcpy_nt(new_message_id, mid);
1811 msgq[i].bKeep = FALSE;
1818 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1822 /* reassemble the host record, based on removed message ids, from in
1825 if (msgq_actual <= 0)
1828 host_record->count = 0;
1832 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1833 host_record->count = msgq_actual;
1835 if (msgq_actual < msgq_count)
1838 for (new_count = 0, i = 0; i < msgq_count; ++i)
1840 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1841 msgq[i].message_id, MESSAGE_ID_LENGTH);
1843 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1847 /* Check for a continuation record. */
1849 while (host_length <= 0)
1851 dbdata_wait * newr = NULL;
1854 /* Search for a continuation */
1856 for (int i = host_record->sequence - 1; i >= 0 && !newr; i--)
1858 sprintf(CS buffer, "%.200s:%d", hostname, i);
1859 newr = dbfn_read(dbm_file, buffer);
1862 /* If no continuation, delete the current and break the loop */
1866 dbfn_delete(dbm_file, hostname);
1870 /* Else replace the current with the continuation */
1872 dbfn_delete(dbm_file, buffer);
1874 host_length = host_record->count * MESSAGE_ID_LENGTH;
1876 bContinuation = TRUE;
1879 if (bFound) /* Usual exit from main loop */
1882 /* If host_length <= 0 we have emptied a record and not found a good message,
1883 and there are no continuation records. Otherwise there is a continuation
1884 record to process. */
1886 if (host_length <= 0)
1888 dbfn_close(dbm_file);
1889 DEBUG(D_transport) debug_printf_indent("waiting messages already delivered\n");
1893 /* we were not able to find an acceptable message, nor was there a
1894 * continuation record. So bug out, outer logic will clean this up.
1899 Ustrcpy(new_message_id, message_id);
1900 dbfn_close(dbm_file);
1903 } /* we need to process a continuation record */
1905 /* Control gets here when an existing message has been encountered; its
1906 id is in new_message_id, and host_length is the revised length of the
1907 host record. If it is zero, the record has been removed. Update the
1908 record if required, close the database, and return TRUE. */
1910 if (host_length > 0)
1912 host_record->count = host_length/MESSAGE_ID_LENGTH;
1913 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1916 dbfn_close(dbm_file);
1917 DEBUG(D_transport) {acl_level--; debug_printf("transport_check_waiting: TRUE\n"); }
1921 DEBUG(D_transport) {acl_level--; debug_printf("transport_check_waiting: FALSE\n"); }
1925 /*************************************************
1926 * Deliver waiting message down same socket *
1927 *************************************************/
1929 /* Just the regain-root-privilege exec portion */
1931 transport_do_pass_socket(const uschar * transport_name, const uschar * hostname,
1932 const uschar * hostaddress, uschar * id, int socket_fd)
1935 const uschar **argv;
1938 if (smtp_peer_options & OPTION_TLS) i += 6;
1940 #ifdef EXPERIMENTAL_ESMTP_LIMITS
1941 if (continue_limit_mail || continue_limit_rcpt || continue_limit_rcptdom)
1944 if (queue_run_pid != (pid_t)0) i += 3;
1945 #ifdef SUPPORT_SOCKS
1946 if (proxy_session) i += 5;
1949 /* Set up the calling arguments; use the standard function for the basics,
1950 but we have a number of extras that may be added. */
1952 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1954 if (f.smtp_authenticated) argv[i++] = US"-MCA";
1955 if (smtp_peer_options & OPTION_CHUNKING) argv[i++] = US"-MCK";
1956 if (smtp_peer_options & OPTION_DSN) argv[i++] = US"-MCD";
1957 if (smtp_peer_options & OPTION_PIPE) argv[i++] = US"-MCP";
1958 if (smtp_peer_options & OPTION_SIZE) argv[i++] = US"-MCS";
1960 if (smtp_peer_options & OPTION_TLS)
1961 if (tls_out.active.sock >= 0 || continue_proxy_cipher)
1963 argv[i++] = US"-MCt";
1964 argv[i++] = sending_ip_address;
1965 argv[i++] = string_sprintf("%d", sending_port);
1966 argv[i++] = tls_out.active.sock >= 0 ? tls_out.cipher : continue_proxy_cipher;
1972 tls_out.dane_verified ? US"-MCr" :
1975 argv[i++] = tls_out.sni;
1979 argv[i++] = US"-MCT";
1982 #ifdef EXPERIMENTAL_ESMTP_LIMITS
1983 if (continue_limit_rcpt || continue_limit_rcptdom)
1985 argv[i++] = US"-MCL";
1986 argv[i++] = string_sprintf("%u", continue_limit_mail);
1987 argv[i++] = string_sprintf("%u", continue_limit_rcpt);
1988 argv[i++] = string_sprintf("%u", continue_limit_rcptdom);
1992 if (queue_run_pid != (pid_t)0)
1994 argv[i++] = US"-MCQ";
1995 argv[i++] = string_sprintf("%d", queue_run_pid);
1996 argv[i++] = string_sprintf("%d", queue_run_pipe);
1999 #ifdef SUPPORT_SOCKS
2002 argv[i++] = US"-MCp";
2003 argv[i++] = proxy_local_address;
2004 argv[i++] = string_sprintf("%d", proxy_local_port);
2005 argv[i++] = proxy_external_address;
2006 argv[i++] = string_sprintf("%d", proxy_external_port);
2010 argv[i++] = US"-MC";
2011 argv[i++] = US transport_name;
2012 argv[i++] = US hostname;
2013 argv[i++] = US hostaddress;
2014 argv[i++] = string_sprintf("%d", continue_sequence + 1);
2018 /* Arrange for the channel to be on stdin. */
2022 (void)dup2(socket_fd, 0);
2023 (void)close(socket_fd);
2026 DEBUG(D_exec) debug_print_argv(argv);
2027 exim_nullstd(); /* Ensure std{out,err} exist */
2028 /* argv[0] should be untainted, from child_exec_exim() */
2029 execv(CS argv[0], (char *const *)argv);
2031 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
2032 _exit(errno); /* Note: must be _exit(), NOT exit() */
2037 /* Fork a new exim process to deliver the message, and do a re-exec, both to
2038 get a clean delivery process, and to regain root privilege in cases where it
2039 has been given away.
2042 transport_name to pass to the new process
2045 id the new message to process
2046 socket_fd the connected socket
2048 Returns: FALSE if fork fails; TRUE otherwise
2052 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
2053 const uschar *hostaddress, uschar *id, int socket_fd
2054 #ifdef EXPERIMENTAL_ESMTP_LIMITS
2055 , unsigned peer_limit_mail, unsigned peer_limit_rcpt, unsigned peer_limit_rcptdom
2062 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
2064 #ifdef EXPERIMENTAL_ESMTP_LIMITS
2065 continue_limit_mail = peer_limit_mail;
2066 continue_limit_rcpt = peer_limit_rcpt;
2067 continue_limit_rcptdom = peer_limit_rcptdom;
2070 if ((pid = exim_fork(US"continued-transport-interproc")) == 0)
2072 /* Disconnect entirely from the parent process. If we are running in the
2073 test harness, wait for a bit to allow the previous process time to finish,
2074 write the log, etc., so that the output is always in the same order for
2075 automatic comparison. */
2077 if ((pid = exim_fork(US"continued-transport")) != 0)
2078 _exit(EXIT_SUCCESS);
2079 testharness_pause_ms(1000);
2081 transport_do_pass_socket(transport_name, hostname, hostaddress,
2085 /* If the process creation succeeded, wait for the first-level child, which
2086 immediately exits, leaving the second level process entirely disconnected from
2092 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
2097 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
2105 /* Enforce all args untainted, for consistency with a router-sourced pipe
2106 command, where (because the whole line is passed as one to the tpt) a
2107 tainted arg taints the executable name. It's unclear also that letting an
2108 attacker supply command arguments is wise. */
2111 arg_is_tainted(const uschar * s, int argn, address_item * addr,
2112 const uschar * etext, uschar ** errptr)
2116 uschar * msg = string_sprintf("Tainted arg %d for %s command: '%s'",
2120 addr->transport_return = FAIL;
2121 addr->message = msg;
2130 /*************************************************
2131 * Set up direct (non-shell) command *
2132 *************************************************/
2134 /* This function is called when a command line is to be parsed and executed
2135 directly, without the use of /bin/sh. It is called by the pipe transport,
2136 the queryprogram router, for any ${run } expansion,
2137 and also from the main delivery code when setting up a
2138 transport filter process. The code for ETRN also makes use of this; in that
2139 case, no addresses are passed.
2142 argvptr pointer to anchor for argv vector
2143 cmd points to the command string (modified IN PLACE)
2144 flags bits for expand-args, allow taint, allow $recipients
2145 expand_failed error value to set if expansion fails; not relevant if
2147 addr chain of addresses, or NULL
2148 etext text for use in error messages
2149 errptr where to put error message if addr is NULL;
2150 otherwise it is put in the first address
2152 Returns: TRUE if all went well; otherwise an error will be
2153 set in the first address and FALSE returned
2157 transport_set_up_command(const uschar *** argvptr, const uschar * cmd,
2158 unsigned flags, int expand_failed, address_item * addr,
2159 const uschar * etext, uschar ** errptr)
2161 const uschar ** argv, * s;
2162 int address_count = 0, argcount = 0, max_args;
2164 /* Get store in which to build an argument list. Count the number of addresses
2165 supplied, and allow for that many arguments, plus an additional 60, which
2166 should be enough for anybody. Multiple addresses happen only when the local
2167 delivery batch option is set. */
2169 for (address_item * ad = addr; ad; ad = ad->next) address_count++;
2170 max_args = address_count + 60;
2171 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *), GET_UNTAINTED);
2173 /* Split the command up into arguments terminated by white space. Lose
2174 trailing space at the start and end. Double-quoted arguments can contain \\ and
2175 \" escapes and so can be handled by the standard function; single-quoted
2176 arguments are verbatim. Copy each argument into a new string. */
2179 Uskip_whitespace(&s);
2181 for (; *s && argcount < max_args; argcount++)
2185 int n = Ustrcspn(++s, "'");
2186 argv[argcount] = string_copyn(s, n);
2187 if (*(s += n) == '\'') s++;
2190 argv[argcount] = string_dequote(CUSS &s);
2191 Uskip_whitespace(&s);
2194 argv[argcount] = NULL;
2196 /* If *s != 0 we have run out of argument slots. */
2200 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2204 addr->transport_return = FAIL;
2205 addr->message = msg;
2211 /* Expand each individual argument if required. Expansion happens for pipes set
2212 up in filter files and with directly-supplied commands. It does not happen if
2213 the pipe comes from a traditional .forward file. A failing expansion is a big
2214 disaster if the command came from Exim's configuration; if it came from a user
2215 it is just a normal failure. The expand_failed value is used as the error value
2216 to cater for these two cases.
2218 An argument consisting just of the text "$pipe_addresses" is treated specially.
2219 It is not passed to the general expansion function. Instead, it is replaced by
2220 a number of arguments, one for each address. This avoids problems with shell
2221 metacharacters and spaces in addresses.
2223 If the parent of the top address has an original part of "system-filter", this
2224 pipe was set up by the system filter, and we can permit the expansion of
2229 debug_printf("direct command:\n");
2230 for (int i = 0; argv[i]; i++)
2231 debug_printf(" argv[%d] = '%s'\n", i, string_printing(argv[i]));
2234 if (flags & TSUC_EXPAND_ARGS)
2236 BOOL allow_dollar_recipients = (flags & TSUC_ALLOW_RECIPIENTS)
2237 || (addr && addr->parent && Ustrcmp(addr->parent->address, "system-filter") == 0); /*XXX could we check this at caller? */
2239 for (int i = 0; argv[i]; i++)
2241 DEBUG(D_expand) debug_printf_indent("arg %d\n", i);
2243 /* Handle special fudge for passing an address list */
2246 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2247 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2251 if (argcount + address_count - 1 > max_args)
2253 addr->transport_return = FAIL;
2254 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2255 "in %s", cmd, etext);
2259 additional = address_count - 1;
2261 memmove(argv + i + 1 + additional, argv + i + 1,
2262 (argcount - i)*sizeof(uschar *));
2264 for (address_item * ad = addr; ad; ad = ad->next)
2266 /* $pipe_addresses is spefically not checked for taint, because there is
2267 a testcase (321) depending on it. It's unclear if the exact thing being
2268 done really needs to be legitimate, though I suspect it reflects an
2269 actual use-case that showed up a bug.
2270 This is a hole in the taint-pretection, mitigated only in that
2271 shell-syntax metachars cannot be injected via this route. */
2273 DEBUG(D_transport) if (is_tainted(ad->address))
2274 debug_printf("tainted element '%s' from $pipe_addresses\n", ad->address);
2276 argv[i++] = ad->address;
2280 /* Subtract one since we replace $pipe_addresses */
2285 /* Handle special case of $address_pipe when af_force_command is set */
2287 else if (addr && testflag(addr,af_force_command) &&
2288 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2289 Ustrcmp(argv[i], "${address_pipe}") == 0))
2291 int address_pipe_argcount = 0;
2292 int address_pipe_max_args;
2293 uschar **address_pipe_argv;
2295 /* We can never have more then the argv we will be loading into */
2296 address_pipe_max_args = max_args - argcount + 1;
2299 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2301 /* We allocate an additional for (uschar *)0 */
2302 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *), GET_UNTAINTED);
2304 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2305 s = expand_string(addr->local_part + 1);
2309 addr->transport_return = FAIL;
2310 addr->message = string_sprintf("Expansion of \"%s\" "
2311 "from command \"%s\" in %s failed: %s",
2312 (addr->local_part + 1), cmd, etext, expand_string_message);
2316 Uskip_whitespace(&s); /* strip leading space */
2318 while (*s && address_pipe_argcount < address_pipe_max_args)
2322 int n = Ustrcspn(++s, "'");
2323 argv[argcount] = string_copyn(s, n);
2324 if (*(s += n) == '\'') s++;
2327 address_pipe_argv[address_pipe_argcount++] = string_dequote(CUSS &s);
2328 Uskip_whitespace(&s); /* strip space after arg */
2331 address_pipe_argv[address_pipe_argcount] = NULL;
2333 /* If *s != 0 we have run out of argument slots. */
2336 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2337 "\"%s\" in %s", addr->local_part + 1, etext);
2340 addr->transport_return = FAIL;
2341 addr->message = msg;
2347 /* address_pipe_argcount - 1
2348 because we are replacing $address_pipe in the argument list
2349 with the first thing it expands to */
2351 if (argcount + address_pipe_argcount - 1 > max_args)
2353 addr->transport_return = FAIL;
2354 addr->message = string_sprintf("Too many arguments to command "
2355 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2359 /* If we are not just able to replace the slot that contained
2360 $address_pipe (address_pipe_argcount == 1)
2361 We have to move the existing argv by address_pipe_argcount - 1
2362 Visually if address_pipe_argcount == 2:
2363 [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2364 [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0] */
2366 if (address_pipe_argcount > 1)
2368 /* current position + additional args */
2369 argv + i + address_pipe_argcount,
2370 /* current position + 1 (for the (uschar *)0 at the end) */
2372 /* -1 for the (uschar *)0 at the end)*/
2373 (argcount - i)*sizeof(uschar *)
2376 /* Now we fill in the slots we just moved argv out of
2377 [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0] */
2379 for (int address_pipe_i = 0;
2380 address_pipe_argv[address_pipe_i];
2381 address_pipe_i++, argcount++)
2383 uschar * s = address_pipe_argv[address_pipe_i];
2384 if (arg_is_tainted(s, i, addr, etext, errptr)) return FALSE;
2388 /* Subtract one since we replace $address_pipe */
2393 /* Handle normal expansion string */
2397 const uschar *expanded_arg;
2398 BOOL enable_dollar_recipients_g = f.enable_dollar_recipients;
2399 f.enable_dollar_recipients = allow_dollar_recipients;
2400 expanded_arg = expand_cstring(argv[i]);
2401 f.enable_dollar_recipients = enable_dollar_recipients_g;
2405 uschar *msg = string_sprintf("Expansion of \"%s\" "
2406 "from command \"%s\" in %s failed: %s",
2407 argv[i], cmd, etext, expand_string_message);
2410 addr->transport_return = expand_failed;
2411 addr->message = msg;
2417 if ( f.running_in_test_harness && is_tainted(expanded_arg)
2418 && Ustrcmp(etext, "queryprogram router") == 0)
2419 { /* hack, would be good to not need it */
2421 debug_printf("SPECIFIC TESTSUITE EXEMPTION: tainted arg '%s'\n",
2424 else if ( !(flags & TSUC_ALLOW_TAINTED_ARGS)
2425 && arg_is_tainted(expanded_arg, i, addr, etext, errptr))
2427 argv[i] = expanded_arg;
2433 debug_printf("direct command after expansion:\n");
2434 for (int i = 0; argv[i]; i++)
2436 debug_printf(" argv[%d] = '%s'\n", i, string_printing(argv[i]));
2437 debug_print_taint(argv[i]);
2447 /* For error messages, a string describing the config location associated
2448 with current processing. NULL if we are not in a transport. */
2449 /* Name only, for now */
2452 transport_current_name(void)
2454 if (!transport_name) return NULL;
2455 return string_sprintf(" (transport %s, %s %d)", transport_name, driver_srcfile, driver_srcline);
2458 #endif /*!MACRO_PREDEF*/
2461 /* End of transport.c */