1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* General functions concerned with transportation, and generic options for all
14 /* Generic options for transports, all of which live inside transport_instance
15 data blocks and which therefore have the opt_public flag set. Note that there
16 are other options living inside this structure which can be set only from
17 certain transports. */
18 #define LOFF(field) OPT_OFF(transport_instance, field)
20 optionlist optionlist_transports[] = {
22 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
24 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
26 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
27 LOFF(rewrite_existflags) },
28 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
29 LOFF(rewrite_rules) },
30 { "*set_group", opt_bool|opt_hidden|opt_public,
32 { "*set_user", opt_bool|opt_hidden|opt_public,
34 { "body_only", opt_bool|opt_public,
36 { "current_directory", opt_stringptr|opt_public,
38 { "debug_print", opt_stringptr | opt_public,
40 { "delivery_date_add", opt_bool|opt_public,
41 LOFF(delivery_date_add) },
42 { "disable_logging", opt_bool|opt_public,
43 LOFF(disable_logging) },
44 { "driver", opt_stringptr|opt_public,
46 { "envelope_to_add", opt_bool|opt_public,
47 LOFF(envelope_to_add) },
49 { "event_action", opt_stringptr | opt_public,
52 { "group", opt_expand_gid|opt_public,
54 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
56 { "headers_only", opt_bool|opt_public,
58 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
59 LOFF(remove_headers) },
60 { "headers_rewrite", opt_rewrite|opt_public,
61 LOFF(headers_rewrite) },
62 { "home_directory", opt_stringptr|opt_public,
64 { "initgroups", opt_bool|opt_public,
66 { "max_parallel", opt_stringptr|opt_public,
68 { "message_size_limit", opt_stringptr|opt_public,
69 LOFF(message_size_limit) },
70 { "rcpt_include_affixes", opt_bool|opt_public,
71 LOFF(rcpt_include_affixes) },
72 { "retry_use_local_part", opt_bool|opt_public,
73 LOFF(retry_use_local_part) },
74 { "return_path", opt_stringptr|opt_public,
76 { "return_path_add", opt_bool|opt_public,
77 LOFF(return_path_add) },
78 { "shadow_condition", opt_stringptr|opt_public,
79 LOFF(shadow_condition) },
80 { "shadow_transport", opt_stringptr|opt_public,
82 { "transport_filter", opt_stringptr|opt_public,
83 LOFF(filter_command) },
84 { "transport_filter_timeout", opt_time|opt_public,
85 LOFF(filter_timeout) },
86 { "user", opt_expand_uid|opt_public,
90 int optionlist_transports_size = nelem(optionlist_transports);
94 # include "macro_predef.h"
97 options_transports(void)
101 options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
103 for (transport_info * ti = transports_available; ti->driver_name[0]; ti++)
105 spf(buf, sizeof(buf), US"_DRIVER_TRANSPORT_%T", ti->driver_name);
106 builtin_macro_create(buf);
107 options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
111 #else /*!MACRO_PREDEF*/
113 /* Structure for keeping list of addresses that have been added to
114 Envelope-To:, in order to avoid duplication. */
122 /* Static data for write_chunk() */
124 static uschar *chunk_ptr; /* chunk pointer */
125 static uschar *nl_check; /* string to look for at line start */
126 static int nl_check_length; /* length of same */
127 static uschar *nl_escape; /* string to insert */
128 static int nl_escape_length; /* length of same */
129 static int nl_partial_match; /* length matched at chunk end */
132 /*************************************************
133 * Initialize transport list *
134 *************************************************/
136 /* Read the transports section of the configuration file, and set up a chain of
137 transport instances according to its contents. Each transport has generic
138 options and may also have its own private options. This function is only ever
139 called when transports == NULL. We use generic code in readconf to do most of
145 readconf_driver_init(US"transport",
146 (driver_instance **)(&transports), /* chain anchor */
147 (driver_info *)transports_available, /* available drivers */
148 sizeof(transport_info), /* size of info block */
149 &transport_defaults, /* default values for generic options */
150 sizeof(transport_instance), /* size of instance block */
151 optionlist_transports, /* generic options */
152 optionlist_transports_size);
154 /* Now scan the configured transports and check inconsistencies. A shadow
155 transport is permitted only for local transports. */
157 for (transport_instance * t = transports; t; t = t->next)
159 if (!t->info->local && t->shadow)
160 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
161 "shadow transport not allowed on non-local transport %s", t->name);
163 if (t->body_only && t->headers_only)
164 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
165 "%s transport: body_only and headers_only are mutually exclusive",
172 /*************************************************
173 * Write block of data *
174 *************************************************/
177 tpt_write(int fd, uschar * block, int len, BOOL more, int options)
181 tls_out.active.sock == fd
182 ? tls_write(tls_out.active.tls_ctx, block, len, more) :
185 more && !(options & topt_not_socket) ? send(fd, block, len, MSG_MORE) :
187 write(fd, block, len);
190 /* Subroutine called by write_chunk() and at the end of the message actually
191 to write a data block. Also called directly by some transports to write
192 additional data to the file descriptor (e.g. prefix, suffix).
194 If a transport wants data transfers to be timed, it sets a non-zero value in
195 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
196 be set for each block of data written from here. If time runs out, then write()
197 fails and provokes an error return. The caller can then inspect sigalrm_seen to
200 On some systems, if a quota is exceeded during the write, the yield is the
201 number of bytes written rather than an immediate error code. This also happens
202 on some systems in other cases, for example a pipe that goes away because the
203 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
204 get the error codes the first time.
206 The write() function is also interruptible; the Solaris 2.6 man page says:
208 If write() is interrupted by a signal before it writes any
209 data, it will return -1 with errno set to EINTR.
211 If write() is interrupted by a signal after it successfully
212 writes some data, it will return the number of bytes written.
214 To handle these cases, we want to restart the write() to output the remainder
215 of the data after a non-negative return from write(), except after a timeout.
216 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
217 proper error then occurs. In principle, after an interruption, the second
218 write() could suffer the same fate, but we do not want to continue for
219 evermore, so stick a maximum repetition count on the loop to act as a
223 tctx transport context: file descriptor or string to write to
224 block block of bytes to write
225 len number of bytes to write
226 more further data expected soon
228 Returns: TRUE on success, FALSE on failure (with errno preserved);
229 transport_count is incremented by the number of bytes written
233 transport_write_block_fd(transport_ctx * tctx, uschar * block, int len, BOOL more)
236 int local_timeout = transport_write_timeout;
240 /* This loop is for handling incomplete writes and other retries. In most
241 normal cases, it is only ever executed once. */
243 for (int i = 0; i < 100; i++)
246 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
247 fd, len, local_timeout, more ? " (more expected)" : "");
249 /* When doing TCP Fast Open we may get this far before the 3-way handshake
250 is complete, and write returns ENOTCONN. Detect that, wait for the socket
251 to become writable, and retry once only. */
256 /* This code makes use of alarm() in order to implement the timeout. This
257 isn't a very tidy way of doing things. Using non-blocking I/O with select()
258 provides a neater approach. However, I don't know how to do this when TLS is
261 if (transport_write_timeout <= 0) /* No timeout wanted */
263 rc = tpt_write(fd, block, len, more, tctx->options);
266 else /* Timeout wanted. */
268 sigalrm_seen = FALSE;
269 ALARM(local_timeout);
270 rc = tpt_write(fd, block, len, more, tctx->options);
272 local_timeout = ALARM_CLR(0);
280 if (rc >= 0 || errno != ENOTCONN || connretry <= 0)
283 FD_ZERO(&fds); FD_SET(fd, &fds);
284 select(fd+1, NULL, &fds, NULL, NULL); /* could set timout? */
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), FALSE);
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), FALSE);
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
764 if (tblock && tblock->rewrite_rules)
766 rmark reset_point = store_mark();
769 if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
770 tblock->rewrite_existflags, FALSE)))
772 if (!sendfn(tctx, hh->text, hh->slen)) return FALSE;
773 store_reset(reset_point);
774 continue; /* With the next header line */
778 /* Either no rewriting rules, or it didn't get rewritten */
780 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
786 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
789 /* Add on any address-specific headers. If there are multiple addresses,
790 they will all have the same headers in order to be batched. The headers
791 are chained in reverse order of adding (so several addresses from the
792 same alias might share some of them) but we want to output them in the
793 opposite order. This is a bit tedious, but there shouldn't be very many
794 of them. We just walk the list twice, reversing the pointers each time,
795 but on the second time, write out the items.
797 Headers added to an address by a router are guaranteed to end with a newline.
802 header_line *hprev = addr->prop.extra_headers;
803 header_line *hnext, * h;
804 for (int i = 0; i < 2; i++)
805 for (h = hprev, hprev = NULL; h; h = hnext)
812 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
814 debug_printf("added header line(s):\n%s---\n", h->text);
819 /* If a string containing additional headers exists it is a newline-sep
820 list. Expand each item and write out the result. This is done last so that
821 if it (deliberately or accidentally) isn't in header format, it won't mess
822 up any other headers. An empty string or a forced expansion failure are
823 noops. An added header string from a transport may not end with a newline;
824 add one if it does not. */
826 if (tblock && (list = CUS tblock->add_headers))
831 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
832 if ((s = expand_string(s)))
834 int len = Ustrlen(s);
837 if (!sendfn(tctx, s, len)) return FALSE;
838 if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
842 debug_printf("added header line:\n%s", s);
843 if (s[len-1] != '\n') debug_printf("\n");
844 debug_printf("---\n");
848 else if (!f.expand_string_forcedfail)
849 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
852 /* Separate headers from body with a blank line */
854 return sendfn(tctx, US"\n", 1);
858 /*************************************************
859 * Write the message *
860 *************************************************/
862 /* This function writes the message to the given file descriptor. The headers
863 are in the in-store data structure, and the rest of the message is in the open
864 file descriptor deliver_datafile. Make sure we start it at the beginning.
866 . If add_return_path is TRUE, a "return-path:" header is added to the message,
867 containing the envelope sender's address.
869 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
870 giving the top-level envelope address that caused this delivery to happen.
872 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
873 message. It gives the time and date that delivery took place.
875 . If check_string is not null, the start of each line is checked for that
876 string. If it is found, it is replaced by escape_string. This used to be
877 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
879 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
881 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
882 any writing or reading error, leaving the code in errno intact. Error exits
883 can include timeouts for certain transports, which are requested by setting
884 transport_write_timeout non-zero.
888 (fd, msg) Either and fd, to write the message to,
889 or a string: if null write message to allocated space
890 otherwire take content as headers.
891 addr (chain of) addresses (for extra headers), or NULL;
892 only the first address is used
893 tblock optional transport instance block (NULL signifies NULL/0):
894 add_headers a string containing one or more headers to add; it is
895 expanded, and must be in correct RFC 822 format as
896 it is transmitted verbatim; NULL => no additions,
897 and so does empty string or forced expansion fail
898 remove_headers a colon-separated list of headers to remove, or NULL
899 rewrite_rules chain of header rewriting rules
900 rewrite_existflags flags for the rewriting rules
901 options bit-wise options:
902 add_return_path if TRUE, add a "return-path" header
903 add_envelope_to if TRUE, add a "envelope-to" header
904 add_delivery_date if TRUE, add a "delivery-date" header
905 use_crlf if TRUE, turn NL into CR LF
906 end_dot if TRUE, send a terminating "." line at the end
907 no_headers if TRUE, omit the headers
908 no_body if TRUE, omit the body
909 check_string a string to check for at the start of lines, or NULL
910 escape_string a string to insert in front of any check string
911 size_limit if > 0, this is a limit to the size of message written;
912 it is used when returning messages to their senders,
913 and is approximate rather than exact, owing to chunk
916 Returns: TRUE on success; FALSE (with errno) on failure.
917 In addition, the global variable transport_count
918 is incremented by the number of bytes written.
922 internal_transport_write_message(transport_ctx * tctx, int size_limit)
926 /* Initialize pointer in output buffer. */
928 transport_write_reset(tctx->options);
930 /* Set up the data for start-of-line data checking and escaping */
932 if (tctx->check_string && tctx->escape_string)
934 nl_check = tctx->check_string;
935 nl_check_length = Ustrlen(nl_check);
936 nl_escape = tctx->escape_string;
937 nl_escape_length = Ustrlen(nl_escape);
940 /* Whether the escaping mechanism is applied to headers or not is controlled by
941 an option (set for SMTP, not otherwise). Negate the length if not wanted till
942 after the headers. */
944 if (!(tctx->options & topt_escape_headers))
945 nl_check_length = -nl_check_length;
947 /* Write the headers if required, including any that have to be added. If there
948 are header rewriting rules, apply them. The datasource is not the -D spoolfile
949 so temporarily hide the global that adjusts for its format. */
951 if (!(tctx->options & topt_no_headers))
953 BOOL save_wireformat = f.spool_file_wireformat;
954 f.spool_file_wireformat = FALSE;
956 /* Add return-path: if requested. */
958 if (tctx->options & topt_add_return_path)
960 uschar buffer[ADDRESS_MAXLENGTH + 20];
961 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
963 if (!write_chunk(tctx, buffer, n)) goto bad;
966 /* Add envelope-to: if requested */
968 if (tctx->options & topt_add_envelope_to)
971 struct aci *plist = NULL;
972 struct aci *dlist = NULL;
973 rmark reset_point = store_mark();
975 if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
977 /* Pick up from all the addresses. The plist and dlist variables are
978 anchors for lists of addresses already handled; they have to be defined at
979 this level because write_env_to() calls itself recursively. */
981 for (address_item * p = tctx->addr; p; p = p->next)
982 if (!write_env_to(p, &plist, &dlist, &first, tctx))
985 /* Add a final newline and reset the store used for tracking duplicates */
987 if (!write_chunk(tctx, US"\n", 1)) goto bad;
988 store_reset(reset_point);
991 /* Add delivery-date: if requested. */
993 if (tctx->options & topt_add_delivery_date)
995 uschar * s = tod_stamp(tod_full);
997 if ( !write_chunk(tctx, US"Delivery-date: ", 15)
998 || !write_chunk(tctx, s, Ustrlen(s))
999 || !write_chunk(tctx, US"\n", 1)) goto bad;
1002 /* Then the message's headers. Don't write any that are flagged as "old";
1003 that means they were rewritten, or are a record of envelope rewriting, or
1004 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
1005 match any entries therein. Then check addr->prop.remove_headers too, provided that
1006 addr is not NULL. */
1008 if (!transport_headers_send(tctx, &write_chunk))
1011 f.spool_file_wireformat = save_wireformat;
1015 f.spool_file_wireformat = save_wireformat;
1018 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
1019 last-BDAT, consisting of the current write_chunk() output buffer fill
1020 (optimally, all of the headers - but it does not matter if we already had to
1021 flush that buffer with non-last BDAT prependix) plus the amount of body data
1022 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
1023 that further use of write_chunk() will not prepend BDATs.
1024 The first BDAT written will also first flush any outstanding MAIL and RCPT
1025 commands which were buffered thans to PIPELINING.
1026 Commands go out (using a send()) from a different buffer to data (using a
1027 write()). They might not end up in the same TCP segment, which is
1030 if (tctx->options & topt_use_bdat)
1035 if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1037 if (!(tctx->options & topt_no_body))
1039 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1040 fsize -= SPOOL_DATA_START_OFFSET;
1041 if (size_limit > 0 && fsize > size_limit)
1043 size = hsize + fsize;
1044 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
1045 size += body_linecount; /* account for CRLF-expansion */
1047 /* With topt_use_bdat we never do dot-stuffing; no need to
1048 account for any expansion due to that. */
1051 /* If the message is large, emit first a non-LAST chunk with just the
1052 headers, and reap the command responses. This lets us error out early
1053 on RCPT rejects rather than sending megabytes of data. Include headers
1054 on the assumption they are cheap enough and some clever implementations
1055 might errorcheck them too, on-the-fly, and reject that chunk. */
1057 if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1060 debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1061 if ( tctx->chunk_cb(tctx, hsize, 0) != OK
1062 || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1063 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1066 chunk_ptr = deliver_out_buffer;
1070 /* Emit a LAST datachunk command, and unmark the context for further
1073 if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1075 tctx->options &= ~topt_use_bdat;
1078 /* If the body is required, ensure that the data for check strings (formerly
1079 the "from hack") is enabled by negating the length if necessary. (It will be
1080 negative in cases where it isn't to apply to the headers). Then ensure the body
1081 is positioned at the start of its file (following the message id), then write
1082 it, applying the size limit if required. */
1084 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1085 and we want to send a body without dotstuffing or ending-dot, in-clear,
1086 then we can just dump it using sendfile.
1087 This should get used for CHUNKING output and also for writing the -K file for
1088 dkim signing, when we had CHUNKING input. */
1091 if ( f.spool_file_wireformat
1092 && !(tctx->options & (topt_no_body | topt_end_dot))
1094 && tls_out.active.sock != tctx->u.fd
1098 off_t offset = SPOOL_DATA_START_OFFSET;
1100 /* Write out any header data in the buffer */
1102 if ((len = chunk_ptr - deliver_out_buffer) > 0)
1104 if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1109 DEBUG(D_transport) debug_printf("using sendfile for body\n");
1113 if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1119 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1123 if (!(tctx->options & topt_no_body))
1124 debug_printf("cannot use sendfile for body: %s\n",
1125 !f.spool_file_wireformat ? "spoolfile not wireformat"
1126 : tctx->options & topt_end_dot ? "terminating dot wanted"
1127 : nl_check_length ? "dot- or From-stuffing wanted"
1128 : "TLS output wanted");
1130 if (!(tctx->options & topt_no_body))
1132 unsigned long size = size_limit > 0 ? size_limit : ULONG_MAX;
1134 nl_check_length = abs(nl_check_length);
1135 nl_partial_match = 0;
1136 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
1138 while ( (len = MIN(DELIVER_IN_BUFFER_SIZE, size)) > 0
1139 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1141 if (!write_chunk(tctx, deliver_in_buffer, len))
1146 /* A read error on the body will have left len == -1 and errno set. */
1148 if (len != 0) return FALSE;
1151 /* Finished with the check string, and spool-format consideration */
1153 nl_check_length = nl_escape_length = 0;
1154 f.spool_file_wireformat = FALSE;
1156 /* If requested, add a terminating "." line (SMTP output). */
1158 if (tctx->options & topt_end_dot && !write_chunk(tctx, US".\n", 2))
1161 /* Write out any remaining data in the buffer before returning. */
1163 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1164 transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1170 /*************************************************
1171 * External interface to write the message *
1172 *************************************************/
1174 /* If there is no filtering required, call the internal function above to do
1175 the real work, passing over all the arguments from this function. Otherwise,
1176 set up a filtering process, fork another process to call the internal function
1177 to write to the filter, and in this process just suck from the filter and write
1178 down the fd in the transport context. At the end, tidy up the pipes and the
1181 Arguments: as for internal_transport_write_message() above
1183 Returns: TRUE on success; FALSE (with errno) for any failure
1184 transport_count is incremented by the number of bytes written
1188 transport_write_message(transport_ctx * tctx, int size_limit)
1190 BOOL last_filter_was_NL = TRUE;
1191 BOOL save_spool_file_wireformat = f.spool_file_wireformat;
1192 int rc, len, yield, fd_read, fd_write, save_errno;
1193 int pfd[2] = {-1, -1};
1194 pid_t filter_pid, write_pid;
1196 f.transport_filter_timed_out = FALSE;
1198 /* If there is no filter command set up, call the internal function that does
1199 the actual work, passing it the incoming fd, and return its result. */
1201 if ( !transport_filter_argv
1202 || !*transport_filter_argv
1203 || !**transport_filter_argv
1205 return internal_transport_write_message(tctx, size_limit);
1207 /* Otherwise the message must be written to a filter process and read back
1208 before being written to the incoming fd. First set up the special processing to
1209 be done during the copying. */
1211 nl_partial_match = -1;
1213 if (tctx->check_string && tctx->escape_string)
1215 nl_check = tctx->check_string;
1216 nl_check_length = Ustrlen(nl_check);
1217 nl_escape = tctx->escape_string;
1218 nl_escape_length = Ustrlen(nl_escape);
1220 else nl_check_length = nl_escape_length = 0;
1222 /* Start up a subprocess to run the command. Ensure that our main fd will
1223 be closed when the subprocess execs, but remove the flag afterwards.
1224 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1225 process to deliver another message.) We get back stdin/stdout file descriptors.
1226 If the process creation failed, give an error return. */
1232 write_pid = (pid_t)(-1);
1235 int bits = fcntl(tctx->u.fd, F_GETFD);
1236 (void)fcntl(tctx->u.fd, F_SETFD, bits | FD_CLOEXEC);
1237 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1238 &fd_write, &fd_read, FALSE);
1239 (void)fcntl(tctx->u.fd, F_SETFD, bits & ~FD_CLOEXEC);
1241 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1244 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1245 (int)filter_pid, fd_write, fd_read);
1247 /* Fork subprocess to write the message to the filter, and return the result
1248 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1249 smtp dots, or check string processing. */
1251 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1252 if ((write_pid = fork()) == 0)
1255 (void)close(fd_read);
1256 (void)close(pfd[pipe_read]);
1257 nl_check_length = nl_escape_length = 0;
1259 tctx->u.fd = fd_write;
1260 tctx->check_string = tctx->escape_string = NULL;
1261 tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat);
1263 rc = internal_transport_write_message(tctx, size_limit);
1266 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1268 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1270 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1272 || write(pfd[pipe_write], (void *)&tctx->addr->delivery_time, sizeof(struct timeval))
1273 != sizeof(struct timeval)
1275 rc = FALSE; /* compiler quietening */
1276 exim_underbar_exit(0, US"tpt-filter");
1280 /* Parent process: close our copy of the writing subprocess' pipes. */
1282 (void)close(pfd[pipe_write]);
1283 (void)close(fd_write);
1286 /* Writing process creation failed */
1290 errno = save_errno; /* restore */
1294 /* When testing, let the subprocess get going */
1296 testharness_pause_ms(250);
1299 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1301 /* Copy the message from the filter to the output fd. A read error leaves len
1302 == -1 and errno set. We need to apply a timeout to the read, to cope with
1303 the case when the filter gets stuck, but it can be quite a long one. The
1304 default is 5m, but this is now configurable. */
1306 DEBUG(D_transport) debug_printf("copying from the filter\n");
1308 /* Copy the output of the filter, remembering if the last character was NL. If
1309 no data is returned, that counts as "ended with NL" (default setting of the
1310 variable is TRUE). The output should always be unix-format as we converted
1311 any wireformat source on writing input to the filter. */
1313 f.spool_file_wireformat = FALSE;
1314 chunk_ptr = deliver_out_buffer;
1318 sigalrm_seen = FALSE;
1319 ALARM(transport_filter_timeout);
1320 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1325 f.transport_filter_timed_out = TRUE;
1329 /* If the read was successful, write the block down the original fd,
1330 remembering whether it ends in \n or not. */
1334 if (!write_chunk(tctx, deliver_in_buffer, len)) goto TIDY_UP;
1335 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1338 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1342 if (len == 0) yield = TRUE;
1347 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1348 to something. Ensure the pipes are all closed and the processes are removed. If
1349 there has been an error, kill the processes before waiting for them, just to be
1350 sure. Also apply a paranoia timeout. */
1353 f.spool_file_wireformat = save_spool_file_wireformat;
1356 (void)close(fd_read);
1357 if (fd_write > 0) (void)close(fd_write);
1361 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1362 if (write_pid > 0) kill(write_pid, SIGKILL);
1365 /* Wait for the filter process to complete. */
1367 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1368 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1371 save_errno = ERRNO_FILTER_FAIL;
1372 tctx->addr->more_errno = rc;
1373 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1376 /* Wait for the writing process to complete. If it ends successfully,
1377 read the results from its pipe, provided we haven't already had a filter
1380 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1383 rc = child_close(write_pid, 30);
1388 if (read(pfd[pipe_read], (void *)&ok, sizeof(BOOL)) != sizeof(BOOL))
1391 debug_printf("pipe read from writing process: %s\n", strerror(errno));
1392 save_errno = ERRNO_FILTER_FAIL;
1397 int dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1398 dummy = read(pfd[pipe_read], (void *)&tctx->addr->more_errno, sizeof(int));
1399 dummy = read(pfd[pipe_read], (void *)&tctx->addr->delivery_time, sizeof(struct timeval));
1400 dummy = dummy; /* compiler quietening */
1407 save_errno = ERRNO_FILTER_FAIL;
1408 tctx->addr->more_errno = rc;
1409 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1412 (void)close(pfd[pipe_read]);
1414 /* If there have been no problems we can now add the terminating "." if this is
1415 SMTP output, turning off escaping beforehand. If the last character from the
1416 filter was not NL, insert a NL to make the SMTP protocol work. */
1420 nl_check_length = nl_escape_length = 0;
1421 f.spool_file_wireformat = FALSE;
1422 if ( tctx->options & topt_end_dot
1423 && ( last_filter_was_NL
1424 ? !write_chunk(tctx, US".\n", 2)
1425 : !write_chunk(tctx, US"\n.\n", 3)
1429 /* Write out any remaining data in the buffer. */
1432 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1433 || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1436 errno = save_errno; /* From some earlier error */
1440 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1442 debug_printf("errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1452 /*************************************************
1453 * Update waiting database *
1454 *************************************************/
1456 /* This is called when an address is deferred by remote transports that are
1457 capable of sending more than one message over one connection. A database is
1458 maintained for each transport, keeping track of which messages are waiting for
1459 which hosts. The transport can then consult this when eventually a successful
1460 delivery happens, and if it finds that another message is waiting for the same
1461 host, it can fire up a new process to deal with it using the same connection.
1463 The database records are keyed by host name. They can get full if there are
1464 lots of messages waiting, and so there is a continuation mechanism for them.
1466 Each record contains a list of message ids, packed end to end without any
1467 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1468 in this record, and the sequence field says if there are any other records for
1469 this host. If the sequence field is 0, there are none. If it is 1, then another
1470 record with the name <hostname>:0 exists; if it is 2, then two other records
1471 with sequence numbers 0 and 1 exist, and so on.
1473 Currently, an exhaustive search of all continuation records has to be done to
1474 determine whether to add a message id to a given record. This shouldn't be
1475 too bad except in extreme cases. I can't figure out a *simple* way of doing
1478 Old records should eventually get swept up by the exim_tidydb utility.
1481 hostlist list of hosts that this message could be sent to
1482 tpname name of the transport
1488 transport_update_waiting(host_item *hostlist, uschar *tpname)
1490 const uschar *prevname = US"";
1494 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1496 /* Open the database for this transport */
1498 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", tpname),
1499 O_RDWR, &dbblock, TRUE, TRUE)))
1502 /* Scan the list of hosts for which this message is waiting, and ensure
1503 that the message id is in each host record. */
1505 for (host_item * host = hostlist; host; host = host->next)
1507 BOOL already = FALSE;
1508 dbdata_wait *host_record;
1512 /* Skip if this is the same host as we just processed; otherwise remember
1513 the name for next time. */
1515 if (Ustrcmp(prevname, host->name) == 0) continue;
1516 prevname = host->name;
1518 /* Look up the host record; if there isn't one, make an empty one. */
1520 if (!(host_record = dbfn_read(dbm_file, host->name)))
1522 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH, FALSE);
1523 host_record->count = host_record->sequence = 0;
1526 /* Compute the current length */
1528 host_length = host_record->count * MESSAGE_ID_LENGTH;
1530 /* Search the record to see if the current message is already in it. */
1532 for (uschar * s = host_record->text; s < host_record->text + host_length;
1533 s += MESSAGE_ID_LENGTH)
1534 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1535 { already = TRUE; break; }
1537 /* If we haven't found this message in the main record, search any
1538 continuation records that exist. */
1540 for (int i = host_record->sequence - 1; i >= 0 && !already; i--)
1543 sprintf(CS buffer, "%.200s:%d", host->name, i);
1544 if ((cont = dbfn_read(dbm_file, buffer)))
1546 int clen = cont->count * MESSAGE_ID_LENGTH;
1547 for (uschar * s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1548 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1549 { already = TRUE; break; }
1553 /* If this message is already in a record, no need to update. */
1557 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1562 /* If this record is full, write it out with a new name constructed
1563 from the sequence number, increase the sequence number, and empty
1564 the record. If we're doing a two-phase queue run initial phase, ping the
1565 daemon to consider running a delivery on this host. */
1567 if (host_record->count >= WAIT_NAME_MAX)
1569 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1570 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1571 #ifdef EXPERIMENTAL_QUEUE_RAMP
1572 if (f.queue_2stage && queue_fast_ramp && !queue_run_in_order)
1573 queue_notify_daemon(message_id);
1575 host_record->sequence++;
1576 host_record->count = 0;
1580 /* If this record is not full, increase the size of the record to
1581 allow for one new message id. */
1586 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH, FALSE);
1587 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1591 /* Now add the new name on the end */
1593 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1594 host_record->count++;
1595 host_length += MESSAGE_ID_LENGTH;
1597 /* Update the database */
1599 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1600 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1605 dbfn_close(dbm_file);
1611 /*************************************************
1612 * Test for waiting messages *
1613 *************************************************/
1615 /* This function is called by a remote transport which uses the previous
1616 function to remember which messages are waiting for which remote hosts. It's
1617 called after a successful delivery and its job is to check whether there is
1618 another message waiting for the same host. However, it doesn't do this if the
1619 current continue sequence is greater than the maximum supplied as an argument,
1620 or greater than the global connection_max_messages, which, if set, overrides.
1623 transport_name name of the transport
1624 hostname name of the host
1625 local_message_max maximum number of messages down one connection
1626 as set by the caller transport
1627 new_message_id set to the message id of a waiting message
1628 more set TRUE if there are yet more messages waiting
1629 oicf_func function to call to validate if it is ok to send
1630 to this message_id from the current instance.
1631 oicf_data opaque data for oicf_func
1633 Returns: TRUE if new_message_id set; FALSE otherwise
1636 typedef struct msgq_s
1638 uschar message_id [MESSAGE_ID_LENGTH + 1];
1643 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1644 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1646 dbdata_wait *host_record;
1652 struct stat statbuf;
1658 debug_printf("transport_check_waiting entered\n");
1659 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1660 continue_sequence, local_message_max, connection_max_messages);
1663 /* Do nothing if we have hit the maximum number that can be send down one
1666 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1667 if (local_message_max > 0 && continue_sequence >= local_message_max)
1670 debug_printf("max messages for one connection reached: returning\n");
1674 /* Open the waiting information database. */
1676 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1677 O_RDWR, &dbblock, TRUE, TRUE)))
1680 /* See if there is a record for this host; if not, there's nothing to do. */
1682 if (!(host_record = dbfn_read(dbm_file, hostname)))
1684 dbfn_close(dbm_file);
1685 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1689 /* If the data in the record looks corrupt, just log something and
1690 don't try to use it. */
1692 if (host_record->count > WAIT_NAME_MAX)
1694 dbfn_close(dbm_file);
1695 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1696 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1700 /* Scan the message ids in the record from the end towards the beginning,
1701 until one is found for which a spool file actually exists. If the record gets
1702 emptied, delete it and continue with any continuation records that may exist.
1705 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1706 but the 1 off will remain without it. This code now allows me to SKIP over
1707 a message I do not want to send out on this run. */
1709 host_length = host_record->count * MESSAGE_ID_LENGTH;
1715 int msgq_actual = 0;
1716 BOOL bFound = FALSE;
1717 BOOL bContinuation = FALSE;
1719 /* create an array to read entire message queue into memory for processing */
1721 msgq = store_get(sizeof(msgq_t) * host_record->count, FALSE);
1722 msgq_count = host_record->count;
1723 msgq_actual = msgq_count;
1725 for (i = 0; i < host_record->count; ++i)
1727 msgq[i].bKeep = TRUE;
1729 Ustrncpy_nt(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1731 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1734 /* first thing remove current message id if it exists */
1736 for (i = 0; i < msgq_count; ++i)
1737 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1739 msgq[i].bKeep = FALSE;
1743 /* now find the next acceptable message_id */
1745 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1748 uschar * mid = msgq[i].message_id;
1750 set_subdir_str(subdir, mid, 0);
1751 if (Ustat(spool_fname(US"input", subdir, mid, US"-D"), &statbuf) != 0)
1752 msgq[i].bKeep = FALSE;
1753 else if (!oicf_func || oicf_func(mid, oicf_data))
1755 Ustrcpy_nt(new_message_id, mid);
1756 msgq[i].bKeep = FALSE;
1763 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1767 /* reassemble the host record, based on removed message ids, from in
1770 if (msgq_actual <= 0)
1773 host_record->count = 0;
1777 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1778 host_record->count = msgq_actual;
1780 if (msgq_actual < msgq_count)
1783 for (new_count = 0, i = 0; i < msgq_count; ++i)
1785 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1786 msgq[i].message_id, MESSAGE_ID_LENGTH);
1788 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1792 /* Check for a continuation record. */
1794 while (host_length <= 0)
1796 dbdata_wait * newr = NULL;
1799 /* Search for a continuation */
1801 for (int i = host_record->sequence - 1; i >= 0 && !newr; i--)
1803 sprintf(CS buffer, "%.200s:%d", hostname, i);
1804 newr = dbfn_read(dbm_file, buffer);
1807 /* If no continuation, delete the current and break the loop */
1811 dbfn_delete(dbm_file, hostname);
1815 /* Else replace the current with the continuation */
1817 dbfn_delete(dbm_file, buffer);
1819 host_length = host_record->count * MESSAGE_ID_LENGTH;
1821 bContinuation = TRUE;
1824 if (bFound) /* Usual exit from main loop */
1827 /* If host_length <= 0 we have emptied a record and not found a good message,
1828 and there are no continuation records. Otherwise there is a continuation
1829 record to process. */
1831 if (host_length <= 0)
1833 dbfn_close(dbm_file);
1834 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1838 /* we were not able to find an acceptable message, nor was there a
1839 * continuation record. So bug out, outer logic will clean this up.
1844 Ustrcpy(new_message_id, message_id);
1845 dbfn_close(dbm_file);
1848 } /* we need to process a continuation record */
1850 /* Control gets here when an existing message has been encountered; its
1851 id is in new_message_id, and host_length is the revised length of the
1852 host record. If it is zero, the record has been removed. Update the
1853 record if required, close the database, and return TRUE. */
1855 if (host_length > 0)
1857 host_record->count = host_length/MESSAGE_ID_LENGTH;
1859 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1863 dbfn_close(dbm_file);
1867 /*************************************************
1868 * Deliver waiting message down same socket *
1869 *************************************************/
1871 /* Just the regain-root-privilege exec portion */
1873 transport_do_pass_socket(const uschar *transport_name, const uschar *hostname,
1874 const uschar *hostaddress, uschar *id, int socket_fd)
1877 const uschar **argv;
1879 /* Set up the calling arguments; use the standard function for the basics,
1880 but we have a number of extras that may be added. */
1882 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1884 if (f.smtp_authenticated) argv[i++] = US"-MCA";
1885 if (smtp_peer_options & OPTION_CHUNKING) argv[i++] = US"-MCK";
1886 if (smtp_peer_options & OPTION_DSN) argv[i++] = US"-MCD";
1887 if (smtp_peer_options & OPTION_PIPE) argv[i++] = US"-MCP";
1888 if (smtp_peer_options & OPTION_SIZE) argv[i++] = US"-MCS";
1890 if (smtp_peer_options & OPTION_TLS)
1891 if (tls_out.active.sock >= 0 || continue_proxy_cipher)
1893 argv[i++] = US"-MCt";
1894 argv[i++] = sending_ip_address;
1895 argv[i++] = string_sprintf("%d", sending_port);
1896 argv[i++] = tls_out.active.sock >= 0 ? tls_out.cipher : continue_proxy_cipher;
1899 argv[i++] = US"-MCT";
1902 if (queue_run_pid != (pid_t)0)
1904 argv[i++] = US"-MCQ";
1905 argv[i++] = string_sprintf("%d", queue_run_pid);
1906 argv[i++] = string_sprintf("%d", queue_run_pipe);
1909 argv[i++] = US"-MC";
1910 argv[i++] = US transport_name;
1911 argv[i++] = US hostname;
1912 argv[i++] = US hostaddress;
1913 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1917 /* Arrange for the channel to be on stdin. */
1921 (void)dup2(socket_fd, 0);
1922 (void)close(socket_fd);
1925 DEBUG(D_exec) debug_print_argv(argv);
1926 exim_nullstd(); /* Ensure std{out,err} exist */
1927 execv(CS argv[0], (char *const *)argv);
1929 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1930 _exit(errno); /* Note: must be _exit(), NOT exit() */
1935 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1936 get a clean delivery process, and to regain root privilege in cases where it
1937 has been given away.
1940 transport_name to pass to the new process
1943 id the new message to process
1944 socket_fd the connected socket
1946 Returns: FALSE if fork fails; TRUE otherwise
1950 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1951 const uschar *hostaddress, uschar *id, int socket_fd)
1956 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1958 if ((pid = fork()) == 0)
1960 /* Disconnect entirely from the parent process. If we are running in the
1961 test harness, wait for a bit to allow the previous process time to finish,
1962 write the log, etc., so that the output is always in the same order for
1963 automatic comparison. */
1965 if ((pid = fork()) != 0)
1967 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (final-pid %d)\n", pid);
1968 _exit(EXIT_SUCCESS);
1970 testharness_pause_ms(1000);
1972 transport_do_pass_socket(transport_name, hostname, hostaddress,
1976 /* If the process creation succeeded, wait for the first-level child, which
1977 immediately exits, leaving the second level process entirely disconnected from
1983 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1984 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (inter-pid %d)\n", pid);
1989 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1997 /*************************************************
1998 * Set up direct (non-shell) command *
1999 *************************************************/
2001 /* This function is called when a command line is to be parsed and executed
2002 directly, without the use of /bin/sh. It is called by the pipe transport,
2003 the queryprogram router, and also from the main delivery code when setting up a
2004 transport filter process. The code for ETRN also makes use of this; in that
2005 case, no addresses are passed.
2008 argvptr pointer to anchor for argv vector
2009 cmd points to the command string (modified IN PLACE)
2010 expand_arguments true if expansion is to occur
2011 expand_failed error value to set if expansion fails; not relevant if
2013 addr chain of addresses, or NULL
2014 etext text for use in error messages
2015 errptr where to put error message if addr is NULL;
2016 otherwise it is put in the first address
2018 Returns: TRUE if all went well; otherwise an error will be
2019 set in the first address and FALSE returned
2023 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2024 BOOL expand_arguments, int expand_failed, address_item *addr,
2025 uschar *etext, uschar **errptr)
2027 const uschar **argv;
2029 int address_count = 0;
2033 /* Get store in which to build an argument list. Count the number of addresses
2034 supplied, and allow for that many arguments, plus an additional 60, which
2035 should be enough for anybody. Multiple addresses happen only when the local
2036 delivery batch option is set. */
2038 for (address_item * ad = addr; ad; ad = ad->next) address_count++;
2039 max_args = address_count + 60;
2040 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *), FALSE);
2042 /* Split the command up into arguments terminated by white space. Lose
2043 trailing space at the start and end. Double-quoted arguments can contain \\ and
2044 \" escapes and so can be handled by the standard function; single-quoted
2045 arguments are verbatim. Copy each argument into a new string. */
2048 while (isspace(*s)) s++;
2050 for (; *s != 0 && argcount < max_args; argcount++)
2055 while (*ss != 0 && *ss != '\'') ss++;
2056 argv[argcount] = ss = store_get(ss - s++, is_tainted(cmd));
2057 while (*s != 0 && *s != '\'') *ss++ = *s++;
2062 argv[argcount] = string_dequote(CUSS &s);
2063 while (isspace(*s)) s++;
2066 argv[argcount] = US 0;
2068 /* If *s != 0 we have run out of argument slots. */
2072 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2076 addr->transport_return = FAIL;
2077 addr->message = msg;
2083 /* Expand each individual argument if required. Expansion happens for pipes set
2084 up in filter files and with directly-supplied commands. It does not happen if
2085 the pipe comes from a traditional .forward file. A failing expansion is a big
2086 disaster if the command came from Exim's configuration; if it came from a user
2087 it is just a normal failure. The expand_failed value is used as the error value
2088 to cater for these two cases.
2090 An argument consisting just of the text "$pipe_addresses" is treated specially.
2091 It is not passed to the general expansion function. Instead, it is replaced by
2092 a number of arguments, one for each address. This avoids problems with shell
2093 metacharacters and spaces in addresses.
2095 If the parent of the top address has an original part of "system-filter", this
2096 pipe was set up by the system filter, and we can permit the expansion of
2101 debug_printf("direct command:\n");
2102 for (int i = 0; argv[i]; i++)
2103 debug_printf(" argv[%d] = '%s'\n", i, string_printing(argv[i]));
2106 if (expand_arguments)
2108 BOOL allow_dollar_recipients = addr != NULL &&
2109 addr->parent != NULL &&
2110 Ustrcmp(addr->parent->address, "system-filter") == 0;
2112 for (int i = 0; argv[i] != US 0; i++)
2115 /* Handle special fudge for passing an address list */
2118 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2119 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2123 if (argcount + address_count - 1 > max_args)
2125 addr->transport_return = FAIL;
2126 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2127 "in %s", cmd, etext);
2131 additional = address_count - 1;
2133 memmove(argv + i + 1 + additional, argv + i + 1,
2134 (argcount - i)*sizeof(uschar *));
2136 for (address_item * ad = addr; ad; ad = ad->next)
2138 argv[i++] = ad->address;
2142 /* Subtract one since we replace $pipe_addresses */
2147 /* Handle special case of $address_pipe when af_force_command is set */
2149 else if (addr != NULL && testflag(addr,af_force_command) &&
2150 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2151 Ustrcmp(argv[i], "${address_pipe}") == 0))
2153 int address_pipe_argcount = 0;
2154 int address_pipe_max_args;
2155 uschar **address_pipe_argv;
2158 /* We can never have more then the argv we will be loading into */
2159 address_pipe_max_args = max_args - argcount + 1;
2162 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2164 /* We allocate an additional for (uschar *)0 */
2165 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *), FALSE);
2167 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2168 s = expand_string(addr->local_part + 1);
2169 tainted = is_tainted(s);
2171 if (s == NULL || *s == '\0')
2173 addr->transport_return = FAIL;
2174 addr->message = string_sprintf("Expansion of \"%s\" "
2175 "from command \"%s\" in %s failed: %s",
2176 (addr->local_part + 1), cmd, etext, expand_string_message);
2180 while (isspace(*s)) s++; /* strip leading space */
2182 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2187 while (*ss != 0 && *ss != '\'') ss++;
2188 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++, tainted);
2189 while (*s != 0 && *s != '\'') *ss++ = *s++;
2193 else address_pipe_argv[address_pipe_argcount++] =
2194 string_copy(string_dequote(CUSS &s));
2195 while (isspace(*s)) s++; /* strip space after arg */
2198 address_pipe_argv[address_pipe_argcount] = US 0;
2200 /* If *s != 0 we have run out of argument slots. */
2203 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2204 "\"%s\" in %s", addr->local_part + 1, etext);
2207 addr->transport_return = FAIL;
2208 addr->message = msg;
2214 /* address_pipe_argcount - 1
2215 * because we are replacing $address_pipe in the argument list
2216 * with the first thing it expands to */
2217 if (argcount + address_pipe_argcount - 1 > max_args)
2219 addr->transport_return = FAIL;
2220 addr->message = string_sprintf("Too many arguments to command "
2221 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2225 /* If we are not just able to replace the slot that contained
2226 * $address_pipe (address_pipe_argcount == 1)
2227 * We have to move the existing argv by address_pipe_argcount - 1
2228 * Visually if address_pipe_argcount == 2:
2229 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2230 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2232 if (address_pipe_argcount > 1)
2234 /* current position + additional args */
2235 argv + i + address_pipe_argcount,
2236 /* current position + 1 (for the (uschar *)0 at the end) */
2238 /* -1 for the (uschar *)0 at the end)*/
2239 (argcount - i)*sizeof(uschar *)
2242 /* Now we fill in the slots we just moved argv out of
2243 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2245 for (int address_pipe_i = 0;
2246 address_pipe_argv[address_pipe_i] != US 0;
2249 argv[i++] = address_pipe_argv[address_pipe_i];
2253 /* Subtract one since we replace $address_pipe */
2258 /* Handle normal expansion string */
2262 const uschar *expanded_arg;
2263 f.enable_dollar_recipients = allow_dollar_recipients;
2264 expanded_arg = expand_cstring(argv[i]);
2265 f.enable_dollar_recipients = FALSE;
2269 uschar *msg = string_sprintf("Expansion of \"%s\" "
2270 "from command \"%s\" in %s failed: %s",
2271 argv[i], cmd, etext, expand_string_message);
2274 addr->transport_return = expand_failed;
2275 addr->message = msg;
2280 argv[i] = expanded_arg;
2286 debug_printf("direct command after expansion:\n");
2287 for (int i = 0; argv[i] != US 0; i++)
2288 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2295 #endif /*!MACRO_PREDEF*/
2298 /* End of transport.c */