1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
9 /* General functions concerned with transportation, and generic options for all
15 /* Generic options for transports, all of which live inside transport_instance
16 data blocks and which therefore have the opt_public flag set. Note that there
17 are other options living inside this structure which can be set only from
18 certain transports. */
19 #define LOFF(field) OPT_OFF(transport_instance, field)
21 optionlist optionlist_transports[] = {
23 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
25 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
27 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
28 LOFF(rewrite_existflags) },
29 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
30 LOFF(rewrite_rules) },
31 { "*set_group", opt_bool|opt_hidden|opt_public,
33 { "*set_user", opt_bool|opt_hidden|opt_public,
35 { "body_only", opt_bool|opt_public,
37 { "current_directory", opt_stringptr|opt_public,
39 { "debug_print", opt_stringptr | opt_public,
41 { "delivery_date_add", opt_bool|opt_public,
42 LOFF(delivery_date_add) },
43 { "disable_logging", opt_bool|opt_public,
44 LOFF(disable_logging) },
45 { "driver", opt_stringptr|opt_public,
47 { "envelope_to_add", opt_bool|opt_public,
48 LOFF(envelope_to_add) },
50 { "event_action", opt_stringptr | opt_public,
53 { "group", opt_expand_gid|opt_public,
55 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
57 { "headers_only", opt_bool|opt_public,
59 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
60 LOFF(remove_headers) },
61 { "headers_rewrite", opt_rewrite|opt_public,
62 LOFF(headers_rewrite) },
63 { "home_directory", opt_stringptr|opt_public,
65 { "initgroups", opt_bool|opt_public,
67 { "max_parallel", opt_stringptr|opt_public,
69 { "message_size_limit", opt_stringptr|opt_public,
70 LOFF(message_size_limit) },
71 { "rcpt_include_affixes", opt_bool|opt_public,
72 LOFF(rcpt_include_affixes) },
73 { "retry_use_local_part", opt_bool|opt_public,
74 LOFF(retry_use_local_part) },
75 { "return_path", opt_stringptr|opt_public,
77 { "return_path_add", opt_bool|opt_public,
78 LOFF(return_path_add) },
79 { "shadow_condition", opt_stringptr|opt_public,
80 LOFF(shadow_condition) },
81 { "shadow_transport", opt_stringptr|opt_public,
83 { "transport_filter", opt_stringptr|opt_public,
84 LOFF(filter_command) },
85 { "transport_filter_timeout", opt_time|opt_public,
86 LOFF(filter_timeout) },
87 { "user", opt_expand_uid|opt_public,
91 int optionlist_transports_size = nelem(optionlist_transports);
95 # include "macro_predef.h"
98 options_transports(void)
102 options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
104 for (transport_info * ti = transports_available; ti->driver_name[0]; ti++)
106 spf(buf, sizeof(buf), US"_DRIVER_TRANSPORT_%T", ti->driver_name);
107 builtin_macro_create(buf);
108 options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
112 #else /*!MACRO_PREDEF*/
114 /* Structure for keeping list of addresses that have been added to
115 Envelope-To:, in order to avoid duplication. */
123 /* Static data for write_chunk() */
125 static uschar *chunk_ptr; /* chunk pointer */
126 static uschar *nl_check; /* string to look for at line start */
127 static int nl_check_length; /* length of same */
128 static uschar *nl_escape; /* string to insert */
129 static int nl_escape_length; /* length of same */
130 static int nl_partial_match; /* length matched at chunk end */
133 /*************************************************
134 * Initialize transport list *
135 *************************************************/
137 /* Read the transports section of the configuration file, and set up a chain of
138 transport instances according to its contents. Each transport has generic
139 options and may also have its own private options. This function is only ever
140 called when transports == NULL. We use generic code in readconf to do most of
146 readconf_driver_init(US"transport",
147 (driver_instance **)(&transports), /* chain anchor */
148 (driver_info *)transports_available, /* available drivers */
149 sizeof(transport_info), /* size of info block */
150 &transport_defaults, /* default values for generic options */
151 sizeof(transport_instance), /* size of instance block */
152 optionlist_transports, /* generic options */
153 optionlist_transports_size);
155 /* Now scan the configured transports and check inconsistencies. A shadow
156 transport is permitted only for local transports. */
158 for (transport_instance * t = transports; t; t = t->next)
160 if (!t->info->local && t->shadow)
161 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
162 "shadow transport not allowed on non-local transport %s", t->name);
164 if (t->body_only && t->headers_only)
165 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
166 "%s transport: body_only and headers_only are mutually exclusive",
173 /*************************************************
174 * Write block of data *
175 *************************************************/
178 tpt_write(int fd, uschar * block, int len, BOOL more, int options)
182 tls_out.active.sock == fd
183 ? tls_write(tls_out.active.tls_ctx, block, len, more) :
186 more && !(options & topt_not_socket) ? send(fd, block, len, MSG_MORE) :
188 write(fd, block, len);
191 /* Subroutine called by write_chunk() and at the end of the message actually
192 to write a data block. Also called directly by some transports to write
193 additional data to the file descriptor (e.g. prefix, suffix).
195 If a transport wants data transfers to be timed, it sets a non-zero value in
196 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
197 be set for each block of data written from here. If time runs out, then write()
198 fails and provokes an error return. The caller can then inspect sigalrm_seen to
201 On some systems, if a quota is exceeded during the write, the yield is the
202 number of bytes written rather than an immediate error code. This also happens
203 on some systems in other cases, for example a pipe that goes away because the
204 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
205 get the error codes the first time.
207 The write() function is also interruptible; the Solaris 2.6 man page says:
209 If write() is interrupted by a signal before it writes any
210 data, it will return -1 with errno set to EINTR.
212 If write() is interrupted by a signal after it successfully
213 writes some data, it will return the number of bytes written.
215 To handle these cases, we want to restart the write() to output the remainder
216 of the data after a non-negative return from write(), except after a timeout.
217 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
218 proper error then occurs. In principle, after an interruption, the second
219 write() could suffer the same fate, but we do not want to continue for
220 evermore, so stick a maximum repetition count on the loop to act as a
224 tctx transport context: file descriptor or string to write to
225 block block of bytes to write
226 len number of bytes to write
227 more further data expected soon
229 Returns: TRUE on success, FALSE on failure (with errno preserved);
230 transport_count is incremented by the number of bytes written
234 transport_write_block_fd(transport_ctx * tctx, uschar * block, int len, BOOL more)
237 int local_timeout = transport_write_timeout;
241 /* This loop is for handling incomplete writes and other retries. In most
242 normal cases, it is only ever executed once. */
244 for (int i = 0; i < 100; i++)
247 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
248 fd, len, local_timeout, more ? " (more expected)" : "");
250 /* When doing TCP Fast Open we may get this far before the 3-way handshake
251 is complete, and write returns ENOTCONN. Detect that, wait for the socket
252 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 FD_ZERO(&fds); FD_SET(fd, &fds);
285 select(fd+1, NULL, &fds, NULL, NULL); /* could set timout? */
289 /* Hopefully, the most common case is success, so test that first. */
291 if (rc == len) { transport_count += len; return TRUE; }
293 /* A non-negative return code is an incomplete write. Try again for the rest
294 of the block. If we have exactly hit the timeout, give up. */
300 transport_count += rc;
301 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
302 goto CHECK_TIMEOUT; /* A few lines below */
305 /* A negative return code with an EINTR error is another form of
306 incomplete write, zero bytes having been written */
308 if (save_errno == EINTR)
311 debug_printf("write interrupted before anything written\n");
312 goto CHECK_TIMEOUT; /* A few lines below */
315 /* A response of EAGAIN from write() is likely only in the case of writing
316 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
318 if (save_errno == EAGAIN)
321 debug_printf("write temporarily locked out, waiting 1 sec\n");
324 /* Before continuing to try another write, check that we haven't run out of
328 if (transport_write_timeout > 0 && local_timeout <= 0)
336 /* Otherwise there's been an error */
338 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
339 strerror(save_errno));
344 /* We've tried and tried and tried but still failed */
346 errno = ERRNO_WRITEINCOMPLETE;
352 transport_write_block(transport_ctx * tctx, uschar *block, int len, BOOL more)
354 if (!(tctx->options & topt_output_string))
355 return transport_write_block_fd(tctx, block, len, more);
357 /* Write to expanding-string. NOTE: not NUL-terminated */
360 tctx->u.msg = string_get(1024);
362 tctx->u.msg = string_catn(tctx->u.msg, block, len);
369 /*************************************************
370 * Write formatted string *
371 *************************************************/
373 /* This is called by various transports. It is a convenience function.
378 ... arguments for format
380 Returns: the yield of transport_write_block()
384 transport_write_string(int fd, const char *format, ...)
386 transport_ctx tctx = {{0}};
387 gstring gs = { .size = big_buffer_size, .ptr = 0, .s = big_buffer };
390 /* Use taint-unchecked routines for writing into big_buffer, trusting
391 that the result will never be expanded. */
393 va_start(ap, format);
394 if (!string_vformat(&gs, SVFMT_TAINT_NOCHK, format, ap))
395 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
398 return transport_write_block(&tctx, gs.s, gs.ptr, FALSE);
405 transport_write_reset(int options)
407 if (!(options & topt_continuation)) chunk_ptr = deliver_out_buffer;
408 nl_partial_match = -1;
409 nl_check_length = nl_escape_length = 0;
414 /*************************************************
415 * Write character chunk *
416 *************************************************/
418 /* Subroutine used by transport_write_message() to scan character chunks for
419 newlines and act appropriately. The object is to minimise the number of writes.
420 The output byte stream is buffered up in deliver_out_buffer, which is written
421 only when it gets full, thus minimizing write operations and TCP packets.
423 Static data is used to handle the case when the last character of the previous
424 chunk was NL, or matched part of the data that has to be escaped.
427 tctx transport context - processing to be done during output,
428 and file descriptor to write to
429 chunk pointer to data to write
430 len length of data to write
432 In addition, the static nl_xxx variables must be set as required.
434 Returns: TRUE on success, FALSE on failure (with errno preserved)
438 write_chunk(transport_ctx * tctx, uschar *chunk, int len)
440 uschar *start = chunk;
441 uschar *end = chunk + len;
442 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
444 /* The assumption is made that the check string will never stretch over move
445 than one chunk since the only time there are partial matches is when copying
446 the body in large buffers. There is always enough room in the buffer for an
447 escape string, since the loop below ensures this for each character it
448 processes, and it won't have stuck in the escape string if it left a partial
451 if (nl_partial_match >= 0)
453 if (nl_check_length > 0 && len >= nl_check_length &&
454 Ustrncmp(start, nl_check + nl_partial_match,
455 nl_check_length - nl_partial_match) == 0)
457 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
458 chunk_ptr += nl_escape_length;
459 start += nl_check_length - nl_partial_match;
462 /* The partial match was a false one. Insert the characters carried over
463 from the previous chunk. */
465 else if (nl_partial_match > 0)
467 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
468 chunk_ptr += nl_partial_match;
471 nl_partial_match = -1;
474 /* Now process the characters in the chunk. Whenever we hit a newline we check
475 for possible escaping. The code for the non-NL route should be as fast as
478 for (uschar * ptr = start; ptr < end; ptr++)
482 /* Flush the buffer if it has reached the threshold - we want to leave enough
483 room for the next uschar, plus a possible extra CR for an LF, plus the escape
486 if ((len = chunk_ptr - deliver_out_buffer) > mlen)
488 DEBUG(D_transport) debug_printf("flushing headers buffer\n");
490 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
491 from previous SMTP commands. */
493 if (tctx->options & topt_use_bdat && tctx->chunk_cb)
495 if ( tctx->chunk_cb(tctx, (unsigned)len, 0) != OK
496 || !transport_write_block(tctx, deliver_out_buffer, len, FALSE)
497 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
502 if (!transport_write_block(tctx, deliver_out_buffer, len, FALSE))
504 chunk_ptr = deliver_out_buffer;
507 /* Remove CR before NL if required */
509 if ( *ptr == '\r' && ptr[1] == '\n'
510 && !(tctx->options & topt_use_crlf)
511 && f.spool_file_wireformat
515 if ((ch = *ptr) == '\n')
517 int left = end - ptr - 1; /* count of chars left after NL */
519 /* Insert CR before NL if required */
521 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
524 transport_newlines++;
526 /* The check_string test (formerly "from hack") replaces the specific
527 string at the start of a line with an escape string (e.g. "From " becomes
528 ">From " or "." becomes "..". It is a case-sensitive test. The length
529 check above ensures there is always enough room to insert this string. */
531 if (nl_check_length > 0)
533 if (left >= nl_check_length &&
534 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
536 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
537 chunk_ptr += nl_escape_length;
538 ptr += nl_check_length;
541 /* Handle the case when there isn't enough left to match the whole
542 check string, but there may be a partial match. We remember how many
543 characters matched, and finish processing this chunk. */
545 else if (left <= 0) nl_partial_match = 0;
547 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
549 nl_partial_match = left;
555 /* Not a NL character */
557 else *chunk_ptr++ = ch;
566 /*************************************************
567 * Generate address for RCPT TO *
568 *************************************************/
570 /* This function puts together an address for RCPT to, using the caseful
571 version of the local part and the caseful version of the domain. If there is no
572 prefix or suffix, or if affixes are to be retained, we can just use the
573 original address. Otherwise, if there is a prefix but no suffix we can use a
574 pointer into the original address. If there is a suffix, however, we have to
578 addr the address item
579 include_affixes TRUE if affixes are to be included
585 transport_rcpt_address(address_item *addr, BOOL include_affixes)
592 setflag(addr, af_include_affixes); /* Affects logged => line */
593 return addr->address;
598 if (!addr->prefix) return addr->address;
599 return addr->address + Ustrlen(addr->prefix);
602 at = Ustrrchr(addr->address, '@');
603 plen = addr->prefix ? Ustrlen(addr->prefix) : 0;
604 slen = Ustrlen(addr->suffix);
606 return string_sprintf("%.*s@%s", (int)(at - addr->address - plen - slen),
607 addr->address + plen, at + 1);
611 /*************************************************
612 * Output Envelope-To: address & scan duplicates *
613 *************************************************/
615 /* This function is called from internal_transport_write_message() below, when
616 generating an Envelope-To: header line. It checks for duplicates of the given
617 address and its ancestors. When one is found, this function calls itself
618 recursively, to output the envelope address of the duplicate.
620 We want to avoid duplication in the list, which can arise for example when
621 A->B,C and then both B and C alias to D. This can also happen when there are
622 unseen drivers in use. So a list of addresses that have been output is kept in
625 It is also possible to have loops in the address ancestry/duplication graph,
626 for example if there are two top level addresses A and B and we have A->B,C and
627 B->A. To break the loop, we use a list of processed addresses in the dlist
630 After handling duplication, this function outputs the progenitor of the given
634 p the address we are interested in
635 pplist address of anchor of the list of addresses not to output
636 pdlist address of anchor of the list of processed addresses
637 first TRUE if this is the first address; set it FALSE afterwards
638 tctx transport context - processing to be done during output
639 and the file descriptor to write to
641 Returns: FALSE if writing failed
645 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
646 BOOL *first, transport_ctx * tctx)
651 /* Do nothing if we have already handled this address. If not, remember it
652 so that we don't handle it again. */
654 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
656 ppp = store_get(sizeof(struct aci), FALSE);
661 /* Now scan up the ancestry, checking for duplicates at each generation. */
663 for (pp = p;; pp = pp->parent)
666 for (dup = addr_duplicate; dup; dup = dup->next)
667 if (dup->dupof == pp) /* a dup of our address */
668 if (!write_env_to(dup, pplist, pdlist, first, tctx))
670 if (!pp->parent) break;
673 /* Check to see if we have already output the progenitor. */
675 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
676 if (ppp) return TRUE;
678 /* Remember what we have output, and output it. */
680 ppp = store_get(sizeof(struct aci), FALSE);
685 if (!*first && !write_chunk(tctx, US",\n ", 3)) return FALSE;
687 return write_chunk(tctx, pp->address, Ustrlen(pp->address));
693 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
699 addr (chain of) addresses (for extra headers), or NULL;
700 only the first address is used
701 tctx transport context
702 sendfn function for output (transport or verify)
704 Returns: TRUE on success; FALSE on failure.
707 transport_headers_send(transport_ctx * tctx,
708 BOOL (*sendfn)(transport_ctx * tctx, uschar * s, int len))
711 transport_instance * tblock = tctx ? tctx->tblock : NULL;
712 address_item * addr = tctx ? tctx->addr : NULL;
714 /* Then the message's headers. Don't write any that are flagged as "old";
715 that means they were rewritten, or are a record of envelope rewriting, or
716 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
717 match any entries therein. It is a colon-sep list; expand the items
718 separately and squash any empty ones.
719 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
721 for (header_line * h = header_list; h; h = h->next) if (h->type != htype_old)
723 BOOL include_header = TRUE;
725 list = tblock ? tblock->remove_headers : NULL;
726 for (int i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
730 int sep = ':'; /* This is specified as a colon-separated list */
732 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
737 if (!(s = expand_string(s)) && !f.expand_string_forcedfail)
739 errno = ERRNO_CHHEADER_FAIL;
742 len = s ? Ustrlen(s) : 0;
743 if (len && s[len-1] == '*') /* trailing glob */
745 if (strncmpic(h->text, s, len-1) == 0) break;
749 if (strncmpic(h->text, s, len) != 0) continue;
751 while (*ss == ' ' || *ss == '\t') ss++;
752 if (*ss == ':') break;
755 if (s) { include_header = FALSE; break; }
757 if (addr) list = addr->prop.remove_headers;
760 /* 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)))
773 if (!sendfn(tctx, hh->text, hh->slen)) return FALSE;
774 store_reset(reset_point);
775 continue; /* With the next header line */
779 /* Either no rewriting rules, or it didn't get rewritten */
781 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
787 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
790 /* Add on any address-specific headers. If there are multiple addresses,
791 they will all have the same headers in order to be batched. The headers
792 are chained in reverse order of adding (so several addresses from the
793 same alias might share some of them) but we want to output them in the
794 opposite order. This is a bit tedious, but there shouldn't be very many
795 of them. We just walk the list twice, reversing the pointers each time,
796 but on the second time, write out the items.
798 Headers added to an address by a router are guaranteed to end with a newline.
803 header_line *hprev = addr->prop.extra_headers;
804 header_line *hnext, * h;
805 for (int i = 0; i < 2; i++)
806 for (h = hprev, hprev = NULL; h; h = hnext)
813 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
815 debug_printf("added header line(s):\n%s---\n", h->text);
820 /* If a string containing additional headers exists it is a newline-sep
821 list. Expand each item and write out the result. This is done last so that
822 if it (deliberately or accidentally) isn't in header format, it won't mess
823 up any other headers. An empty string or a forced expansion failure are
824 noops. An added header string from a transport may not end with a newline;
825 add one if it does not. */
827 if (tblock && (list = CUS tblock->add_headers))
832 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
833 if ((s = expand_string(s)))
835 int len = Ustrlen(s);
838 if (!sendfn(tctx, s, len)) return FALSE;
839 if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
843 debug_printf("added header line:\n%s", s);
844 if (s[len-1] != '\n') debug_printf("\n");
845 debug_printf("---\n");
849 else if (!f.expand_string_forcedfail)
850 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
853 /* Separate headers from body with a blank line */
855 return sendfn(tctx, US"\n", 1);
859 /*************************************************
860 * Write the message *
861 *************************************************/
863 /* This function writes the message to the given file descriptor. The headers
864 are in the in-store data structure, and the rest of the message is in the open
865 file descriptor deliver_datafile. Make sure we start it at the beginning.
867 . If add_return_path is TRUE, a "return-path:" header is added to the message,
868 containing the envelope sender's address.
870 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
871 giving the top-level envelope address that caused this delivery to happen.
873 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
874 message. It gives the time and date that delivery took place.
876 . If check_string is not null, the start of each line is checked for that
877 string. If it is found, it is replaced by escape_string. This used to be
878 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
880 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
882 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
883 any writing or reading error, leaving the code in errno intact. Error exits
884 can include timeouts for certain transports, which are requested by setting
885 transport_write_timeout non-zero.
889 (fd, msg) Either an fd, to write the message to,
890 or a string: if null write message to allocated space
891 otherwire take content as headers.
892 addr (chain of) addresses (for extra headers), or NULL;
893 only the first address is used
894 tblock optional transport instance block (NULL signifies NULL/0):
895 add_headers a string containing one or more headers to add; it is
896 expanded, and must be in correct RFC 822 format as
897 it is transmitted verbatim; NULL => no additions,
898 and so does empty string or forced expansion fail
899 remove_headers a colon-separated list of headers to remove, or NULL
900 rewrite_rules chain of header rewriting rules
901 rewrite_existflags flags for the rewriting rules
902 options bit-wise options:
903 add_return_path if TRUE, add a "return-path" header
904 add_envelope_to if TRUE, add a "envelope-to" header
905 add_delivery_date if TRUE, add a "delivery-date" header
906 use_crlf if TRUE, turn NL into CR LF
907 end_dot if TRUE, send a terminating "." line at the end
908 no_flush if TRUE, do not flush at end
909 no_headers if TRUE, omit the headers
910 no_body if TRUE, omit the body
911 check_string a string to check for at the start of lines, or NULL
912 escape_string a string to insert in front of any check string
913 size_limit if > 0, this is a limit to the size of message written;
914 it is used when returning messages to their senders,
915 and is approximate rather than exact, owing to chunk
918 Returns: TRUE on success; FALSE (with errno) on failure.
919 In addition, the global variable transport_count
920 is incremented by the number of bytes written.
924 internal_transport_write_message(transport_ctx * tctx, int size_limit)
928 /* Initialize pointer in output buffer. */
930 transport_write_reset(tctx->options);
932 /* Set up the data for start-of-line data checking and escaping */
934 if (tctx->check_string && tctx->escape_string)
936 nl_check = tctx->check_string;
937 nl_check_length = Ustrlen(nl_check);
938 nl_escape = tctx->escape_string;
939 nl_escape_length = Ustrlen(nl_escape);
942 /* Whether the escaping mechanism is applied to headers or not is controlled by
943 an option (set for SMTP, not otherwise). Negate the length if not wanted till
944 after the headers. */
946 if (!(tctx->options & topt_escape_headers))
947 nl_check_length = -nl_check_length;
949 /* Write the headers if required, including any that have to be added. If there
950 are header rewriting rules, apply them. The datasource is not the -D spoolfile
951 so temporarily hide the global that adjusts for its format. */
953 if (!(tctx->options & topt_no_headers))
955 BOOL save_wireformat = f.spool_file_wireformat;
956 f.spool_file_wireformat = FALSE;
958 /* Add return-path: if requested. */
960 if (tctx->options & topt_add_return_path)
963 uschar * s = string_sprintf("Return-path: <%.*s>\n%n",
964 EXIM_EMAILADDR_MAX, return_path, &n);
965 if (!write_chunk(tctx, s, n)) goto bad;
968 /* Add envelope-to: if requested */
970 if (tctx->options & topt_add_envelope_to)
973 struct aci *plist = NULL;
974 struct aci *dlist = NULL;
975 rmark reset_point = store_mark();
977 if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
979 /* Pick up from all the addresses. The plist and dlist variables are
980 anchors for lists of addresses already handled; they have to be defined at
981 this level because write_env_to() calls itself recursively. */
983 for (address_item * p = tctx->addr; p; p = p->next)
984 if (!write_env_to(p, &plist, &dlist, &first, tctx))
987 /* Add a final newline and reset the store used for tracking duplicates */
989 if (!write_chunk(tctx, US"\n", 1)) goto bad;
990 store_reset(reset_point);
993 /* Add delivery-date: if requested. */
995 if (tctx->options & topt_add_delivery_date)
997 uschar * s = tod_stamp(tod_full);
999 if ( !write_chunk(tctx, US"Delivery-date: ", 15)
1000 || !write_chunk(tctx, s, Ustrlen(s))
1001 || !write_chunk(tctx, US"\n", 1)) goto bad;
1004 /* Then the message's headers. Don't write any that are flagged as "old";
1005 that means they were rewritten, or are a record of envelope rewriting, or
1006 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
1007 match any entries therein. Then check addr->prop.remove_headers too, provided that
1008 addr is not NULL. */
1010 if (!transport_headers_send(tctx, &write_chunk))
1013 f.spool_file_wireformat = save_wireformat;
1017 f.spool_file_wireformat = save_wireformat;
1020 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
1021 last-BDAT, consisting of the current write_chunk() output buffer fill
1022 (optimally, all of the headers - but it does not matter if we already had to
1023 flush that buffer with non-last BDAT prependix) plus the amount of body data
1024 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
1025 that further use of write_chunk() will not prepend BDATs.
1026 The first BDAT written will also first flush any outstanding MAIL and RCPT
1027 commands which were buffered thans to PIPELINING.
1028 Commands go out (using a send()) from a different buffer to data (using a
1029 write()). They might not end up in the same TCP segment, which is
1032 if (tctx->options & topt_use_bdat)
1037 if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1039 if (!(tctx->options & topt_no_body))
1041 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1042 fsize -= SPOOL_DATA_START_OFFSET;
1043 if (size_limit > 0 && fsize > size_limit)
1045 size = hsize + fsize;
1046 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
1047 size += body_linecount; /* account for CRLF-expansion */
1049 /* With topt_use_bdat we never do dot-stuffing; no need to
1050 account for any expansion due to that. */
1053 /* If the message is large, emit first a non-LAST chunk with just the
1054 headers, and reap the command responses. This lets us error out early
1055 on RCPT rejects rather than sending megabytes of data. Include headers
1056 on the assumption they are cheap enough and some clever implementations
1057 might errorcheck them too, on-the-fly, and reject that chunk. */
1059 if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1062 debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1063 if ( tctx->chunk_cb(tctx, hsize, 0) != OK
1064 || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1065 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1068 chunk_ptr = deliver_out_buffer;
1072 /* Emit a LAST datachunk command, and unmark the context for further
1075 if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1077 tctx->options &= ~topt_use_bdat;
1080 /* If the body is required, ensure that the data for check strings (formerly
1081 the "from hack") is enabled by negating the length if necessary. (It will be
1082 negative in cases where it isn't to apply to the headers). Then ensure the body
1083 is positioned at the start of its file (following the message id), then write
1084 it, applying the size limit if required. */
1086 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1087 and we want to send a body without dotstuffing or ending-dot, in-clear,
1088 then we can just dump it using sendfile.
1089 This should get used for CHUNKING output and also for writing the -K file for
1090 dkim signing, when we had CHUNKING input. */
1093 if ( f.spool_file_wireformat
1094 && !(tctx->options & (topt_no_body | topt_end_dot))
1096 && tls_out.active.sock != tctx->u.fd
1100 off_t offset = SPOOL_DATA_START_OFFSET;
1102 /* Write out any header data in the buffer */
1104 if ((len = chunk_ptr - deliver_out_buffer) > 0)
1106 if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1111 DEBUG(D_transport) debug_printf("using sendfile for body\n");
1115 if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1121 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1125 if (!(tctx->options & topt_no_body))
1126 debug_printf("cannot use sendfile for body: %s\n",
1127 !f.spool_file_wireformat ? "spoolfile not wireformat"
1128 : tctx->options & topt_end_dot ? "terminating dot wanted"
1129 : nl_check_length ? "dot- or From-stuffing wanted"
1130 : "TLS output wanted");
1132 if (!(tctx->options & topt_no_body))
1134 unsigned long size = size_limit > 0 ? size_limit : ULONG_MAX;
1136 nl_check_length = abs(nl_check_length);
1137 nl_partial_match = 0;
1138 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
1140 while ( (len = MIN(DELIVER_IN_BUFFER_SIZE, size)) > 0
1141 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1143 if (!write_chunk(tctx, deliver_in_buffer, len))
1148 /* A read error on the body will have left len == -1 and errno set. */
1150 if (len != 0) return FALSE;
1153 /* Finished with the check string, and spool-format consideration */
1155 nl_check_length = nl_escape_length = 0;
1156 f.spool_file_wireformat = FALSE;
1158 /* If requested, add a terminating "." line (SMTP output). */
1160 if (tctx->options & topt_end_dot && !write_chunk(tctx, US".\n", 2))
1163 /* Write out any remaining data in the buffer before returning. */
1165 return (len = chunk_ptr - deliver_out_buffer) <= 0
1166 || transport_write_block(tctx, deliver_out_buffer, len,
1167 !!(tctx->options & topt_no_flush));
1173 /*************************************************
1174 * External interface to write the message *
1175 *************************************************/
1177 /* If there is no filtering required, call the internal function above to do
1178 the real work, passing over all the arguments from this function. Otherwise,
1179 set up a filtering process, fork another process to call the internal function
1180 to write to the filter, and in this process just suck from the filter and write
1181 down the fd in the transport context. At the end, tidy up the pipes and the
1184 Arguments: as for internal_transport_write_message() above
1186 Returns: TRUE on success; FALSE (with errno) for any failure
1187 transport_count is incremented by the number of bytes written
1191 transport_write_message(transport_ctx * tctx, int size_limit)
1193 BOOL last_filter_was_NL = TRUE;
1194 BOOL save_spool_file_wireformat = f.spool_file_wireformat;
1196 int rc, len, fd_read, fd_write, save_errno;
1197 int pfd[2] = {-1, -1};
1198 pid_t filter_pid, write_pid;
1200 f.transport_filter_timed_out = FALSE;
1202 /* If there is no filter command set up, call the internal function that does
1203 the actual work, passing it the incoming fd, and return its result. */
1205 if ( !transport_filter_argv
1206 || !*transport_filter_argv
1207 || !**transport_filter_argv
1209 return internal_transport_write_message(tctx, size_limit);
1211 /* Otherwise the message must be written to a filter process and read back
1212 before being written to the incoming fd. First set up the special processing to
1213 be done during the copying. */
1215 nl_partial_match = -1;
1217 if (tctx->check_string && tctx->escape_string)
1219 nl_check = tctx->check_string;
1220 nl_check_length = Ustrlen(nl_check);
1221 nl_escape = tctx->escape_string;
1222 nl_escape_length = Ustrlen(nl_escape);
1224 else nl_check_length = nl_escape_length = 0;
1226 /* Start up a subprocess to run the command. Ensure that our main fd will
1227 be closed when the subprocess execs, but remove the flag afterwards.
1228 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1229 process to deliver another message.) We get back stdin/stdout file descriptors.
1230 If the process creation failed, give an error return. */
1236 write_pid = (pid_t)(-1);
1239 int bits = fcntl(tctx->u.fd, F_GETFD);
1240 (void) fcntl(tctx->u.fd, F_SETFD, bits | FD_CLOEXEC);
1241 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1242 &fd_write, &fd_read, FALSE, US"transport-filter");
1243 (void) fcntl(tctx->u.fd, F_SETFD, bits & ~FD_CLOEXEC);
1245 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1248 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1249 (int)filter_pid, fd_write, fd_read);
1251 /* Fork subprocess to write the message to the filter, and return the result
1252 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1253 smtp dots, or check string processing. */
1255 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1256 if ((write_pid = exim_fork(US"tpt-filter-writer")) == 0)
1259 (void)close(fd_read);
1260 (void)close(pfd[pipe_read]);
1261 nl_check_length = nl_escape_length = 0;
1263 tctx->u.fd = fd_write;
1264 tctx->check_string = tctx->escape_string = NULL;
1265 tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat | topt_no_flush);
1267 rc = internal_transport_write_message(tctx, size_limit);
1270 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1272 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1274 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1276 || write(pfd[pipe_write], (void *)&tctx->addr->delivery_time, sizeof(struct timeval))
1277 != sizeof(struct timeval)
1279 rc = FALSE; /* compiler quietening */
1280 exim_underbar_exit(EXIT_SUCCESS);
1284 /* Parent process: close our copy of the writing subprocess' pipes. */
1286 (void)close(pfd[pipe_write]);
1287 (void)close(fd_write);
1290 /* Writing process creation failed */
1294 errno = save_errno; /* restore */
1298 /* When testing, let the subprocess get going */
1300 testharness_pause_ms(250);
1303 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1305 /* Copy the message from the filter to the output fd. A read error leaves len
1306 == -1 and errno set. We need to apply a timeout to the read, to cope with
1307 the case when the filter gets stuck, but it can be quite a long one. The
1308 default is 5m, but this is now configurable. */
1310 DEBUG(D_transport) debug_printf("copying from the filter\n");
1312 /* Copy the output of the filter, remembering if the last character was NL. If
1313 no data is returned, that counts as "ended with NL" (default setting of the
1314 variable is TRUE). The output should always be unix-format as we converted
1315 any wireformat source on writing input to the filter. */
1317 f.spool_file_wireformat = FALSE;
1318 chunk_ptr = deliver_out_buffer;
1322 sigalrm_seen = FALSE;
1323 ALARM(transport_filter_timeout);
1324 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1328 DEBUG(D_transport) debug_printf("timed out reading from filter\n");
1330 f.transport_filter_timed_out = TRUE;
1334 /* If the read was successful, write the block down the original fd,
1335 remembering whether it ends in \n or not. */
1339 if (!write_chunk(tctx, deliver_in_buffer, len)) goto TIDY_UP;
1340 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1343 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1347 if (len == 0) yield = TRUE;
1352 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1353 to something. Ensure the pipes are all closed and the processes are removed. If
1354 there has been an error, kill the processes before waiting for them, just to be
1355 sure. Also apply a paranoia timeout. */
1358 f.spool_file_wireformat = save_spool_file_wireformat;
1361 (void)close(fd_read);
1362 if (fd_write > 0) (void)close(fd_write);
1366 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1367 if (write_pid > 0) kill(write_pid, SIGKILL);
1370 /* Wait for the filter process to complete. */
1372 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1373 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1376 save_errno = ERRNO_FILTER_FAIL;
1377 tctx->addr->more_errno = rc;
1378 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1381 /* Wait for the writing process to complete. If it ends successfully,
1382 read the results from its pipe, provided we haven't already had a filter
1385 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1388 rc = child_close(write_pid, 30);
1393 if (read(pfd[pipe_read], (void *)&ok, sizeof(BOOL)) != sizeof(BOOL))
1396 debug_printf("pipe read from writing process: %s\n", strerror(errno));
1397 save_errno = ERRNO_FILTER_FAIL;
1402 int dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1403 dummy = read(pfd[pipe_read], (void *)&tctx->addr->more_errno, sizeof(int));
1404 dummy = read(pfd[pipe_read], (void *)&tctx->addr->delivery_time, sizeof(struct timeval));
1411 save_errno = ERRNO_FILTER_FAIL;
1412 tctx->addr->more_errno = rc;
1413 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1416 (void)close(pfd[pipe_read]);
1418 /* If there have been no problems we can now add the terminating "." if this is
1419 SMTP output, turning off escaping beforehand. If the last character from the
1420 filter was not NL, insert a NL to make the SMTP protocol work. */
1424 nl_check_length = nl_escape_length = 0;
1425 f.spool_file_wireformat = FALSE;
1426 if ( tctx->options & topt_end_dot
1427 && ( last_filter_was_NL
1428 ? !write_chunk(tctx, US".\n", 2)
1429 : !write_chunk(tctx, US"\n.\n", 3)
1433 /* Write out any remaining data in the buffer. */
1436 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1437 || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1440 errno = save_errno; /* From some earlier error */
1444 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1446 debug_printf(" errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1456 /*************************************************
1457 * Update waiting database *
1458 *************************************************/
1460 /* This is called when an address is deferred by remote transports that are
1461 capable of sending more than one message over one connection. A database is
1462 maintained for each transport, keeping track of which messages are waiting for
1463 which hosts. The transport can then consult this when eventually a successful
1464 delivery happens, and if it finds that another message is waiting for the same
1465 host, it can fire up a new process to deal with it using the same connection.
1467 The database records are keyed by host name. They can get full if there are
1468 lots of messages waiting, and so there is a continuation mechanism for them.
1470 Each record contains a list of message ids, packed end to end without any
1471 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1472 in this record, and the sequence field says if there are any other records for
1473 this host. If the sequence field is 0, there are none. If it is 1, then another
1474 record with the name <hostname>:0 exists; if it is 2, then two other records
1475 with sequence numbers 0 and 1 exist, and so on.
1477 Currently, an exhaustive search of all continuation records has to be done to
1478 determine whether to add a message id to a given record. This shouldn't be
1479 too bad except in extreme cases. I can't figure out a *simple* way of doing
1482 Old records should eventually get swept up by the exim_tidydb utility.
1485 hostlist list of hosts that this message could be sent to
1486 tpname name of the transport
1492 transport_update_waiting(host_item *hostlist, uschar *tpname)
1494 const uschar *prevname = US"";
1498 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1500 /* Open the database for this transport */
1502 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", tpname),
1503 O_RDWR, &dbblock, TRUE, TRUE)))
1506 /* Scan the list of hosts for which this message is waiting, and ensure
1507 that the message id is in each host record. */
1509 for (host_item * host = hostlist; host; host = host->next)
1511 BOOL already = FALSE;
1512 dbdata_wait *host_record;
1516 /* Skip if this is the same host as we just processed; otherwise remember
1517 the name for next time. */
1519 if (Ustrcmp(prevname, host->name) == 0) continue;
1520 prevname = host->name;
1522 /* Look up the host record; if there isn't one, make an empty one. */
1524 if (!(host_record = dbfn_read(dbm_file, host->name)))
1526 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH, FALSE);
1527 host_record->count = host_record->sequence = 0;
1530 /* Compute the current length */
1532 host_length = host_record->count * MESSAGE_ID_LENGTH;
1534 /* Search the record to see if the current message is already in it. */
1536 for (uschar * s = host_record->text; s < host_record->text + host_length;
1537 s += MESSAGE_ID_LENGTH)
1538 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1539 { already = TRUE; break; }
1541 /* If we haven't found this message in the main record, search any
1542 continuation records that exist. */
1544 for (int i = host_record->sequence - 1; i >= 0 && !already; i--)
1547 sprintf(CS buffer, "%.200s:%d", host->name, i);
1548 if ((cont = dbfn_read(dbm_file, buffer)))
1550 int clen = cont->count * MESSAGE_ID_LENGTH;
1551 for (uschar * s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1552 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1553 { already = TRUE; break; }
1557 /* If this message is already in a record, no need to update. */
1561 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1566 /* If this record is full, write it out with a new name constructed
1567 from the sequence number, increase the sequence number, and empty
1568 the record. If we're doing a two-phase queue run initial phase, ping the
1569 daemon to consider running a delivery on this host. */
1571 if (host_record->count >= WAIT_NAME_MAX)
1573 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1574 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1575 #ifndef DISABLE_QUEUE_RAMP
1576 if (f.queue_2stage && queue_fast_ramp && !queue_run_in_order)
1577 queue_notify_daemon(message_id);
1579 host_record->sequence++;
1580 host_record->count = 0;
1584 /* If this record is not full, increase the size of the record to
1585 allow for one new message id. */
1590 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH, FALSE);
1591 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1595 /* Now add the new name on the end */
1597 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1598 host_record->count++;
1599 host_length += MESSAGE_ID_LENGTH;
1601 /* Update the database */
1603 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1604 DEBUG(D_transport) debug_printf("added %.*s to queue for %s\n",
1605 MESSAGE_ID_LENGTH, message_id, host->name);
1610 dbfn_close(dbm_file);
1616 /*************************************************
1617 * Test for waiting messages *
1618 *************************************************/
1620 /* This function is called by a remote transport which uses the previous
1621 function to remember which messages are waiting for which remote hosts. It's
1622 called after a successful delivery and its job is to check whether there is
1623 another message waiting for the same host. However, it doesn't do this if the
1624 current continue sequence is greater than the maximum supplied as an argument,
1625 or greater than the global connection_max_messages, which, if set, overrides.
1628 transport_name name of the transport
1629 hostname name of the host
1630 local_message_max maximum number of messages down one connection
1631 as set by the caller transport
1632 new_message_id set to the message id of a waiting message
1633 oicf_func function to call to validate if it is ok to send
1634 to this message_id from the current instance.
1635 oicf_data opaque data for oicf_func
1637 Returns: TRUE if new_message_id set; FALSE otherwise
1640 typedef struct msgq_s
1642 uschar message_id [MESSAGE_ID_LENGTH + 1];
1647 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1648 int local_message_max, uschar *new_message_id, oicf oicf_func, void *oicf_data)
1650 dbdata_wait *host_record;
1656 struct stat statbuf;
1660 debug_printf("transport_check_waiting entered\n");
1661 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1662 continue_sequence, local_message_max, connection_max_messages);
1666 /* Do nothing if we have hit the maximum number that can be send down one
1669 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1670 if (local_message_max > 0 && continue_sequence >= local_message_max)
1673 debug_printf_indent("max messages for one connection reached: returning\n");
1677 /* Open the waiting information database. */
1679 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1680 O_RDWR, &dbblock, TRUE, TRUE)))
1683 /* See if there is a record for this host; if not, there's nothing to do. */
1685 if (!(host_record = dbfn_read(dbm_file, hostname)))
1687 dbfn_close(dbm_file);
1688 DEBUG(D_transport) debug_printf_indent("no messages waiting for %s\n", hostname);
1692 /* If the data in the record looks corrupt, just log something and
1693 don't try to use it. */
1695 if (host_record->count > WAIT_NAME_MAX)
1697 dbfn_close(dbm_file);
1698 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1699 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1703 /* Scan the message ids in the record from the end towards the beginning,
1704 until one is found for which a spool file actually exists. If the record gets
1705 emptied, delete it and continue with any continuation records that may exist.
1708 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1709 but the 1 off will remain without it. This code now allows me to SKIP over
1710 a message I do not want to send out on this run. */
1712 host_length = host_record->count * MESSAGE_ID_LENGTH;
1718 int msgq_actual = 0;
1719 BOOL bFound = FALSE;
1720 BOOL bContinuation = FALSE;
1722 /* create an array to read entire message queue into memory for processing */
1724 msgq = store_get(sizeof(msgq_t) * host_record->count, FALSE);
1725 msgq_count = host_record->count;
1726 msgq_actual = msgq_count;
1728 for (i = 0; i < host_record->count; ++i)
1730 msgq[i].bKeep = TRUE;
1732 Ustrncpy_nt(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1734 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1737 /* first thing remove current message id if it exists */
1738 /*XXX but what if it has un-sent addrs? */
1740 for (i = 0; i < msgq_count; ++i)
1741 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1743 msgq[i].bKeep = FALSE;
1747 /* now find the next acceptable message_id */
1749 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1752 uschar * mid = msgq[i].message_id;
1754 set_subdir_str(subdir, mid, 0);
1755 if (Ustat(spool_fname(US"input", subdir, mid, US"-D"), &statbuf) != 0)
1756 msgq[i].bKeep = FALSE;
1757 else if (!oicf_func || oicf_func(mid, oicf_data))
1759 Ustrcpy_nt(new_message_id, mid);
1760 msgq[i].bKeep = FALSE;
1767 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1771 /* reassemble the host record, based on removed message ids, from in
1774 if (msgq_actual <= 0)
1777 host_record->count = 0;
1781 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1782 host_record->count = msgq_actual;
1784 if (msgq_actual < msgq_count)
1787 for (new_count = 0, i = 0; i < msgq_count; ++i)
1789 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1790 msgq[i].message_id, MESSAGE_ID_LENGTH);
1792 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1796 /* Check for a continuation record. */
1798 while (host_length <= 0)
1800 dbdata_wait * newr = NULL;
1803 /* Search for a continuation */
1805 for (int i = host_record->sequence - 1; i >= 0 && !newr; i--)
1807 sprintf(CS buffer, "%.200s:%d", hostname, i);
1808 newr = dbfn_read(dbm_file, buffer);
1811 /* If no continuation, delete the current and break the loop */
1815 dbfn_delete(dbm_file, hostname);
1819 /* Else replace the current with the continuation */
1821 dbfn_delete(dbm_file, buffer);
1823 host_length = host_record->count * MESSAGE_ID_LENGTH;
1825 bContinuation = TRUE;
1828 if (bFound) /* Usual exit from main loop */
1831 /* If host_length <= 0 we have emptied a record and not found a good message,
1832 and there are no continuation records. Otherwise there is a continuation
1833 record to process. */
1835 if (host_length <= 0)
1837 dbfn_close(dbm_file);
1838 DEBUG(D_transport) debug_printf_indent("waiting messages already delivered\n");
1842 /* we were not able to find an acceptable message, nor was there a
1843 * continuation record. So bug out, outer logic will clean this up.
1848 Ustrcpy(new_message_id, message_id);
1849 dbfn_close(dbm_file);
1852 } /* we need to process a continuation record */
1854 /* Control gets here when an existing message has been encountered; its
1855 id is in new_message_id, and host_length is the revised length of the
1856 host record. If it is zero, the record has been removed. Update the
1857 record if required, close the database, and return TRUE. */
1859 if (host_length > 0)
1861 host_record->count = host_length/MESSAGE_ID_LENGTH;
1862 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1865 dbfn_close(dbm_file);
1866 DEBUG(D_transport) {acl_level--; debug_printf("transport_check_waiting: TRUE\n"); }
1870 DEBUG(D_transport) {acl_level--; debug_printf("transport_check_waiting: FALSE\n"); }
1874 /*************************************************
1875 * Deliver waiting message down same socket *
1876 *************************************************/
1878 /* Just the regain-root-privilege exec portion */
1880 transport_do_pass_socket(const uschar *transport_name, const uschar *hostname,
1881 const uschar *hostaddress, uschar *id, int socket_fd)
1884 const uschar **argv;
1887 if (smtp_peer_options & OPTION_TLS) i += 6;
1889 #ifdef EXPERIMENTAL_ESMTP_LIMITS
1890 if (continue_limit_mail || continue_limit_rcpt || continue_limit_rcptdom)
1893 if (queue_run_pid != (pid_t)0) i += 3;
1894 #ifdef SUPPORT_SOCKS
1895 if (proxy_session) i += 5;
1898 /* Set up the calling arguments; use the standard function for the basics,
1899 but we have a number of extras that may be added. */
1901 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1903 if (f.smtp_authenticated) argv[i++] = US"-MCA";
1904 if (smtp_peer_options & OPTION_CHUNKING) argv[i++] = US"-MCK";
1905 if (smtp_peer_options & OPTION_DSN) argv[i++] = US"-MCD";
1906 if (smtp_peer_options & OPTION_PIPE) argv[i++] = US"-MCP";
1907 if (smtp_peer_options & OPTION_SIZE) argv[i++] = US"-MCS";
1909 if (smtp_peer_options & OPTION_TLS)
1910 if (tls_out.active.sock >= 0 || continue_proxy_cipher)
1912 argv[i++] = US"-MCt";
1913 argv[i++] = sending_ip_address;
1914 argv[i++] = string_sprintf("%d", sending_port);
1915 argv[i++] = tls_out.active.sock >= 0 ? tls_out.cipher : continue_proxy_cipher;
1921 tls_out.dane_verified ? US"-MCr" :
1924 argv[i++] = tls_out.sni;
1928 argv[i++] = US"-MCT";
1931 #ifdef EXPERIMENTAL_ESMTP_LIMITS
1932 if (continue_limit_rcpt || continue_limit_rcptdom)
1934 argv[i++] = US"-MCL";
1935 argv[i++] = string_sprintf("%u", continue_limit_mail);
1936 argv[i++] = string_sprintf("%u", continue_limit_rcpt);
1937 argv[i++] = string_sprintf("%u", continue_limit_rcptdom);
1941 if (queue_run_pid != (pid_t)0)
1943 argv[i++] = US"-MCQ";
1944 argv[i++] = string_sprintf("%d", queue_run_pid);
1945 argv[i++] = string_sprintf("%d", queue_run_pipe);
1948 #ifdef SUPPORT_SOCKS
1951 argv[i++] = US"-MCp";
1952 argv[i++] = proxy_local_address;
1953 argv[i++] = string_sprintf("%d", proxy_local_port);
1954 argv[i++] = proxy_external_address;
1955 argv[i++] = string_sprintf("%d", proxy_external_port);
1959 argv[i++] = US"-MC";
1960 argv[i++] = US transport_name;
1961 argv[i++] = US hostname;
1962 argv[i++] = US hostaddress;
1963 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1967 /* Arrange for the channel to be on stdin. */
1971 (void)dup2(socket_fd, 0);
1972 (void)close(socket_fd);
1975 DEBUG(D_exec) debug_print_argv(argv);
1976 exim_nullstd(); /* Ensure std{out,err} exist */
1977 execv(CS argv[0], (char *const *)argv);
1979 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1980 _exit(errno); /* Note: must be _exit(), NOT exit() */
1985 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1986 get a clean delivery process, and to regain root privilege in cases where it
1987 has been given away.
1990 transport_name to pass to the new process
1993 id the new message to process
1994 socket_fd the connected socket
1996 Returns: FALSE if fork fails; TRUE otherwise
2000 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
2001 const uschar *hostaddress, uschar *id, int socket_fd
2002 #ifdef EXPERIMENTAL_ESMTP_LIMITS
2003 , unsigned peer_limit_mail, unsigned peer_limit_rcpt, unsigned peer_limit_rcptdom
2010 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
2012 #ifdef EXPERIMENTAL_ESMTP_LIMITS
2013 continue_limit_mail = peer_limit_mail;
2014 continue_limit_rcpt = peer_limit_rcpt;
2015 continue_limit_rcptdom = peer_limit_rcptdom;
2018 if ((pid = exim_fork(US"continued-transport-interproc")) == 0)
2020 /* Disconnect entirely from the parent process. If we are running in the
2021 test harness, wait for a bit to allow the previous process time to finish,
2022 write the log, etc., so that the output is always in the same order for
2023 automatic comparison. */
2025 if ((pid = exim_fork(US"continued-transport")) != 0)
2026 _exit(EXIT_SUCCESS);
2027 testharness_pause_ms(1000);
2029 transport_do_pass_socket(transport_name, hostname, hostaddress,
2033 /* If the process creation succeeded, wait for the first-level child, which
2034 immediately exits, leaving the second level process entirely disconnected from
2040 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
2045 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
2053 /*************************************************
2054 * Set up direct (non-shell) command *
2055 *************************************************/
2057 /* This function is called when a command line is to be parsed and executed
2058 directly, without the use of /bin/sh. It is called by the pipe transport,
2059 the queryprogram router, and also from the main delivery code when setting up a
2060 transport filter process. The code for ETRN also makes use of this; in that
2061 case, no addresses are passed.
2064 argvptr pointer to anchor for argv vector
2065 cmd points to the command string (modified IN PLACE)
2066 expand_arguments true if expansion is to occur
2067 expand_failed error value to set if expansion fails; not relevant if
2069 addr chain of addresses, or NULL
2070 etext text for use in error messages
2071 errptr where to put error message if addr is NULL;
2072 otherwise it is put in the first address
2074 Returns: TRUE if all went well; otherwise an error will be
2075 set in the first address and FALSE returned
2079 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2080 BOOL expand_arguments, int expand_failed, address_item *addr,
2081 uschar *etext, uschar **errptr)
2083 const uschar **argv;
2085 int address_count = 0;
2089 /* Get store in which to build an argument list. Count the number of addresses
2090 supplied, and allow for that many arguments, plus an additional 60, which
2091 should be enough for anybody. Multiple addresses happen only when the local
2092 delivery batch option is set. */
2094 for (address_item * ad = addr; ad; ad = ad->next) address_count++;
2095 max_args = address_count + 60;
2096 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *), FALSE);
2098 /* Split the command up into arguments terminated by white space. Lose
2099 trailing space at the start and end. Double-quoted arguments can contain \\ and
2100 \" escapes and so can be handled by the standard function; single-quoted
2101 arguments are verbatim. Copy each argument into a new string. */
2104 while (isspace(*s)) s++;
2106 for (; *s != 0 && argcount < max_args; argcount++)
2111 while (*ss != 0 && *ss != '\'') ss++;
2112 argv[argcount] = ss = store_get(ss - s++, is_tainted(cmd));
2113 while (*s != 0 && *s != '\'') *ss++ = *s++;
2118 argv[argcount] = string_dequote(CUSS &s);
2119 while (isspace(*s)) s++;
2122 argv[argcount] = US 0;
2124 /* If *s != 0 we have run out of argument slots. */
2128 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2132 addr->transport_return = FAIL;
2133 addr->message = msg;
2139 /* Expand each individual argument if required. Expansion happens for pipes set
2140 up in filter files and with directly-supplied commands. It does not happen if
2141 the pipe comes from a traditional .forward file. A failing expansion is a big
2142 disaster if the command came from Exim's configuration; if it came from a user
2143 it is just a normal failure. The expand_failed value is used as the error value
2144 to cater for these two cases.
2146 An argument consisting just of the text "$pipe_addresses" is treated specially.
2147 It is not passed to the general expansion function. Instead, it is replaced by
2148 a number of arguments, one for each address. This avoids problems with shell
2149 metacharacters and spaces in addresses.
2151 If the parent of the top address has an original part of "system-filter", this
2152 pipe was set up by the system filter, and we can permit the expansion of
2157 debug_printf("direct command:\n");
2158 for (int i = 0; argv[i]; i++)
2159 debug_printf(" argv[%d] = '%s'\n", i, string_printing(argv[i]));
2162 if (expand_arguments)
2164 BOOL allow_dollar_recipients = addr != NULL &&
2165 addr->parent != NULL &&
2166 Ustrcmp(addr->parent->address, "system-filter") == 0;
2168 for (int i = 0; argv[i] != US 0; i++)
2171 /* Handle special fudge for passing an address list */
2174 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2175 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2179 if (argcount + address_count - 1 > max_args)
2181 addr->transport_return = FAIL;
2182 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2183 "in %s", cmd, etext);
2187 additional = address_count - 1;
2189 memmove(argv + i + 1 + additional, argv + i + 1,
2190 (argcount - i)*sizeof(uschar *));
2192 for (address_item * ad = addr; ad; ad = ad->next)
2194 argv[i++] = ad->address;
2198 /* Subtract one since we replace $pipe_addresses */
2203 /* Handle special case of $address_pipe when af_force_command is set */
2205 else if (addr != NULL && testflag(addr,af_force_command) &&
2206 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2207 Ustrcmp(argv[i], "${address_pipe}") == 0))
2209 int address_pipe_argcount = 0;
2210 int address_pipe_max_args;
2211 uschar **address_pipe_argv;
2214 /* We can never have more then the argv we will be loading into */
2215 address_pipe_max_args = max_args - argcount + 1;
2218 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2220 /* We allocate an additional for (uschar *)0 */
2221 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *), FALSE);
2223 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2224 s = expand_string(addr->local_part + 1);
2225 tainted = is_tainted(s);
2227 if (s == NULL || *s == '\0')
2229 addr->transport_return = FAIL;
2230 addr->message = string_sprintf("Expansion of \"%s\" "
2231 "from command \"%s\" in %s failed: %s",
2232 (addr->local_part + 1), cmd, etext, expand_string_message);
2236 while (isspace(*s)) s++; /* strip leading space */
2238 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2243 while (*ss != 0 && *ss != '\'') ss++;
2244 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++, tainted);
2245 while (*s != 0 && *s != '\'') *ss++ = *s++;
2249 else address_pipe_argv[address_pipe_argcount++] =
2250 string_copy(string_dequote(CUSS &s));
2251 while (isspace(*s)) s++; /* strip space after arg */
2254 address_pipe_argv[address_pipe_argcount] = US 0;
2256 /* If *s != 0 we have run out of argument slots. */
2259 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2260 "\"%s\" in %s", addr->local_part + 1, etext);
2263 addr->transport_return = FAIL;
2264 addr->message = msg;
2270 /* address_pipe_argcount - 1
2271 * because we are replacing $address_pipe in the argument list
2272 * with the first thing it expands to */
2273 if (argcount + address_pipe_argcount - 1 > max_args)
2275 addr->transport_return = FAIL;
2276 addr->message = string_sprintf("Too many arguments to command "
2277 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2281 /* If we are not just able to replace the slot that contained
2282 $address_pipe (address_pipe_argcount == 1)
2283 We have to move the existing argv by address_pipe_argcount - 1
2284 Visually if address_pipe_argcount == 2:
2285 [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2286 [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0] */
2288 if (address_pipe_argcount > 1)
2290 /* current position + additional args */
2291 argv + i + address_pipe_argcount,
2292 /* current position + 1 (for the (uschar *)0 at the end) */
2294 /* -1 for the (uschar *)0 at the end)*/
2295 (argcount - i)*sizeof(uschar *)
2298 /* Now we fill in the slots we just moved argv out of
2299 [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0] */
2301 for (int address_pipe_i = 0;
2302 address_pipe_argv[address_pipe_i] != US 0;
2303 address_pipe_i++, argcount++)
2304 argv[i++] = address_pipe_argv[address_pipe_i];
2306 /* Subtract one since we replace $address_pipe */
2311 /* Handle normal expansion string */
2315 const uschar *expanded_arg;
2316 f.enable_dollar_recipients = allow_dollar_recipients;
2317 expanded_arg = expand_cstring(argv[i]);
2318 f.enable_dollar_recipients = FALSE;
2322 uschar *msg = string_sprintf("Expansion of \"%s\" "
2323 "from command \"%s\" in %s failed: %s",
2324 argv[i], cmd, etext, expand_string_message);
2327 addr->transport_return = expand_failed;
2328 addr->message = msg;
2333 argv[i] = expanded_arg;
2339 debug_printf("direct command after expansion:\n");
2340 for (int i = 0; argv[i] != US 0; i++)
2341 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2348 #endif /*!MACRO_PREDEF*/
2351 /* End of transport.c */