1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* General functions concerned with transportation, and generic options for all
14 #ifdef HAVE_LINUX_SENDFILE
15 #include <sys/sendfile.h>
18 /* Structure for keeping list of addresses that have been added to
19 Envelope-To:, in order to avoid duplication. */
27 /* Static data for write_chunk() */
29 static uschar *chunk_ptr; /* chunk pointer */
30 static uschar *nl_check; /* string to look for at line start */
31 static int nl_check_length; /* length of same */
32 static uschar *nl_escape; /* string to insert */
33 static int nl_escape_length; /* length of same */
34 static int nl_partial_match; /* length matched at chunk end */
37 /* Generic options for transports, all of which live inside transport_instance
38 data blocks and which therefore have the opt_public flag set. Note that there
39 are other options living inside this structure which can be set only from
40 certain transports. */
42 optionlist optionlist_transports[] = {
43 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
44 (void *)offsetof(transport_instance, expand_gid) },
45 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
46 (void *)offsetof(transport_instance, expand_uid) },
47 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
48 (void *)offsetof(transport_instance, rewrite_existflags) },
49 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
50 (void *)offsetof(transport_instance, rewrite_rules) },
51 { "*set_group", opt_bool|opt_hidden|opt_public,
52 (void *)offsetof(transport_instance, gid_set) },
53 { "*set_user", opt_bool|opt_hidden|opt_public,
54 (void *)offsetof(transport_instance, uid_set) },
55 { "body_only", opt_bool|opt_public,
56 (void *)offsetof(transport_instance, body_only) },
57 { "current_directory", opt_stringptr|opt_public,
58 (void *)offsetof(transport_instance, current_dir) },
59 { "debug_print", opt_stringptr | opt_public,
60 (void *)offsetof(transport_instance, debug_string) },
61 { "delivery_date_add", opt_bool|opt_public,
62 (void *)(offsetof(transport_instance, delivery_date_add)) },
63 { "disable_logging", opt_bool|opt_public,
64 (void *)(offsetof(transport_instance, disable_logging)) },
65 { "driver", opt_stringptr|opt_public,
66 (void *)offsetof(transport_instance, driver_name) },
67 { "envelope_to_add", opt_bool|opt_public,
68 (void *)(offsetof(transport_instance, envelope_to_add)) },
70 { "event_action", opt_stringptr | opt_public,
71 (void *)offsetof(transport_instance, event_action) },
73 { "group", opt_expand_gid|opt_public,
74 (void *)offsetof(transport_instance, gid) },
75 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
76 (void *)offsetof(transport_instance, add_headers) },
77 { "headers_only", opt_bool|opt_public,
78 (void *)offsetof(transport_instance, headers_only) },
79 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
80 (void *)offsetof(transport_instance, remove_headers) },
81 { "headers_rewrite", opt_rewrite|opt_public,
82 (void *)offsetof(transport_instance, headers_rewrite) },
83 { "home_directory", opt_stringptr|opt_public,
84 (void *)offsetof(transport_instance, home_dir) },
85 { "initgroups", opt_bool|opt_public,
86 (void *)offsetof(transport_instance, initgroups) },
87 { "max_parallel", opt_stringptr|opt_public,
88 (void *)offsetof(transport_instance, max_parallel) },
89 { "message_size_limit", opt_stringptr|opt_public,
90 (void *)offsetof(transport_instance, message_size_limit) },
91 { "rcpt_include_affixes", opt_bool|opt_public,
92 (void *)offsetof(transport_instance, rcpt_include_affixes) },
93 { "retry_use_local_part", opt_bool|opt_public,
94 (void *)offsetof(transport_instance, retry_use_local_part) },
95 { "return_path", opt_stringptr|opt_public,
96 (void *)(offsetof(transport_instance, return_path)) },
97 { "return_path_add", opt_bool|opt_public,
98 (void *)(offsetof(transport_instance, return_path_add)) },
99 { "shadow_condition", opt_stringptr|opt_public,
100 (void *)offsetof(transport_instance, shadow_condition) },
101 { "shadow_transport", opt_stringptr|opt_public,
102 (void *)offsetof(transport_instance, shadow) },
103 { "transport_filter", opt_stringptr|opt_public,
104 (void *)offsetof(transport_instance, filter_command) },
105 { "transport_filter_timeout", opt_time|opt_public,
106 (void *)offsetof(transport_instance, filter_timeout) },
107 { "user", opt_expand_uid|opt_public,
108 (void *)offsetof(transport_instance, uid) }
111 int optionlist_transports_size =
112 sizeof(optionlist_transports)/sizeof(optionlist);
115 /*************************************************
116 * Initialize transport list *
117 *************************************************/
119 /* Read the transports section of the configuration file, and set up a chain of
120 transport instances according to its contents. Each transport has generic
121 options and may also have its own private options. This function is only ever
122 called when transports == NULL. We use generic code in readconf to do most of
128 transport_instance *t;
130 readconf_driver_init(US"transport",
131 (driver_instance **)(&transports), /* chain anchor */
132 (driver_info *)transports_available, /* available drivers */
133 sizeof(transport_info), /* size of info block */
134 &transport_defaults, /* default values for generic options */
135 sizeof(transport_instance), /* size of instance block */
136 optionlist_transports, /* generic options */
137 optionlist_transports_size);
139 /* Now scan the configured transports and check inconsistencies. A shadow
140 transport is permitted only for local transports. */
142 for (t = transports; t != NULL; t = t->next)
146 if (t->shadow != NULL)
147 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
148 "shadow transport not allowed on non-local transport %s", t->name);
151 if (t->body_only && t->headers_only)
152 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
153 "%s transport: body_only and headers_only are mutually exclusive",
160 /*************************************************
161 * Write block of data *
162 *************************************************/
164 /* Subroutine called by write_chunk() and at the end of the message actually
165 to write a data block. Also called directly by some transports to write
166 additional data to the file descriptor (e.g. prefix, suffix).
168 If a transport wants data transfers to be timed, it sets a non-zero value in
169 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
170 be set for each block of data written from here. If time runs out, then write()
171 fails and provokes an error return. The caller can then inspect sigalrm_seen to
174 On some systems, if a quota is exceeded during the write, the yield is the
175 number of bytes written rather than an immediate error code. This also happens
176 on some systems in other cases, for example a pipe that goes away because the
177 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
178 get the error codes the first time.
180 The write() function is also interruptible; the Solaris 2.6 man page says:
182 If write() is interrupted by a signal before it writes any
183 data, it will return -1 with errno set to EINTR.
185 If write() is interrupted by a signal after it successfully
186 writes some data, it will return the number of bytes written.
188 To handle these cases, we want to restart the write() to output the remainder
189 of the data after a non-negative return from write(), except after a timeout.
190 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
191 proper error then occurs. In principle, after an interruption, the second
192 write() could suffer the same fate, but we do not want to continue for
193 evermore, so stick a maximum repetition count on the loop to act as a
197 fd file descriptor to write to
198 block block of bytes to write
199 len number of bytes to write
201 Returns: TRUE on success, FALSE on failure (with errno preserved);
202 transport_count is incremented by the number of bytes written
206 transport_write_block(int fd, uschar *block, int len)
208 int i, rc, save_errno;
209 int local_timeout = transport_write_timeout;
211 /* This loop is for handling incomplete writes and other retries. In most
212 normal cases, it is only ever executed once. */
214 for (i = 0; i < 100; i++)
217 debug_printf("writing data block fd=%d size=%d timeout=%d\n",
218 fd, len, local_timeout);
220 /* This code makes use of alarm() in order to implement the timeout. This
221 isn't a very tidy way of doing things. Using non-blocking I/O with select()
222 provides a neater approach. However, I don't know how to do this when TLS is
225 if (transport_write_timeout <= 0) /* No timeout wanted */
228 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
230 rc = write(fd, block, len);
234 /* Timeout wanted. */
238 alarm(local_timeout);
240 if (tls_out.active == fd)
241 rc = tls_write(FALSE, block, len);
244 rc = write(fd, block, len);
246 local_timeout = alarm(0);
254 /* Hopefully, the most common case is success, so test that first. */
256 if (rc == len) { transport_count += len; return TRUE; }
258 /* A non-negative return code is an incomplete write. Try again for the rest
259 of the block. If we have exactly hit the timeout, give up. */
265 transport_count += rc;
266 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
267 goto CHECK_TIMEOUT; /* A few lines below */
270 /* A negative return code with an EINTR error is another form of
271 incomplete write, zero bytes having been written */
273 if (save_errno == EINTR)
276 debug_printf("write interrupted before anything written\n");
277 goto CHECK_TIMEOUT; /* A few lines below */
280 /* A response of EAGAIN from write() is likely only in the case of writing
281 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
283 if (save_errno == EAGAIN)
286 debug_printf("write temporarily locked out, waiting 1 sec\n");
289 /* Before continuing to try another write, check that we haven't run out of
293 if (transport_write_timeout > 0 && local_timeout <= 0)
301 /* Otherwise there's been an error */
303 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
304 strerror(save_errno));
309 /* We've tried and tried and tried but still failed */
311 errno = ERRNO_WRITEINCOMPLETE;
318 /*************************************************
319 * Write formatted string *
320 *************************************************/
322 /* This is called by various transports. It is a convenience function.
327 ... arguments for format
329 Returns: the yield of transport_write_block()
333 transport_write_string(int fd, const char *format, ...)
336 va_start(ap, format);
337 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
340 return transport_write_block(fd, big_buffer, Ustrlen(big_buffer));
346 /*************************************************
347 * Write character chunk *
348 *************************************************/
350 /* Subroutine used by transport_write_message() to scan character chunks for
351 newlines and act appropriately. The object is to minimise the number of writes.
352 The output byte stream is buffered up in deliver_out_buffer, which is written
353 only when it gets full, thus minimizing write operations and TCP packets.
355 Static data is used to handle the case when the last character of the previous
356 chunk was NL, or matched part of the data that has to be escaped.
359 fd file descript to write to
360 chunk pointer to data to write
361 len length of data to write
362 tctx transport context - processing to be done during output
364 In addition, the static nl_xxx variables must be set as required.
366 Returns: TRUE on success, FALSE on failure (with errno preserved)
370 write_chunk(int fd, transport_ctx * tctx, uschar *chunk, int len)
372 uschar *start = chunk;
373 uschar *end = chunk + len;
375 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
377 /* The assumption is made that the check string will never stretch over move
378 than one chunk since the only time there are partial matches is when copying
379 the body in large buffers. There is always enough room in the buffer for an
380 escape string, since the loop below ensures this for each character it
381 processes, and it won't have stuck in the escape string if it left a partial
384 if (nl_partial_match >= 0)
386 if (nl_check_length > 0 && len >= nl_check_length &&
387 Ustrncmp(start, nl_check + nl_partial_match,
388 nl_check_length - nl_partial_match) == 0)
390 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
391 chunk_ptr += nl_escape_length;
392 start += nl_check_length - nl_partial_match;
395 /* The partial match was a false one. Insert the characters carried over
396 from the previous chunk. */
398 else if (nl_partial_match > 0)
400 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
401 chunk_ptr += nl_partial_match;
404 nl_partial_match = -1;
407 /* Now process the characters in the chunk. Whenever we hit a newline we check
408 for possible escaping. The code for the non-NL route should be as fast as
411 for (ptr = start; ptr < end; ptr++)
415 /* Flush the buffer if it has reached the threshold - we want to leave enough
416 room for the next uschar, plus a possible extra CR for an LF, plus the escape
419 /*XXX CHUNKING: probably want to increase DELIVER_OUT_BUFFER_SIZE */
420 if ((len = chunk_ptr - deliver_out_buffer) > mlen)
422 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
423 from previous SMTP commands. */
425 if (tctx && tctx->options & topt_use_bdat && tctx->chunk_cb)
426 if (tctx->chunk_cb(fd, tctx, (unsigned)len, FALSE) != OK)
429 if (!transport_write_block(fd, deliver_out_buffer, len))
431 chunk_ptr = deliver_out_buffer;
434 if ((ch = *ptr) == '\n')
436 int left = end - ptr - 1; /* count of chars left after NL */
438 /* Insert CR before NL if required */
440 if (tctx && tctx->options & topt_use_crlf) *chunk_ptr++ = '\r';
442 transport_newlines++;
444 /* The check_string test (formerly "from hack") replaces the specific
445 string at the start of a line with an escape string (e.g. "From " becomes
446 ">From " or "." becomes "..". It is a case-sensitive test. The length
447 check above ensures there is always enough room to insert this string. */
449 if (nl_check_length > 0)
451 if (left >= nl_check_length &&
452 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
454 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
455 chunk_ptr += nl_escape_length;
456 ptr += nl_check_length;
459 /* Handle the case when there isn't enough left to match the whole
460 check string, but there may be a partial match. We remember how many
461 characters matched, and finish processing this chunk. */
463 else if (left <= 0) nl_partial_match = 0;
465 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
467 nl_partial_match = left;
473 /* Not a NL character */
475 else *chunk_ptr++ = ch;
484 /*************************************************
485 * Generate address for RCPT TO *
486 *************************************************/
488 /* This function puts together an address for RCPT to, using the caseful
489 version of the local part and the caseful version of the domain. If there is no
490 prefix or suffix, or if affixes are to be retained, we can just use the
491 original address. Otherwise, if there is a prefix but no suffix we can use a
492 pointer into the original address. If there is a suffix, however, we have to
496 addr the address item
497 include_affixes TRUE if affixes are to be included
503 transport_rcpt_address(address_item *addr, BOOL include_affixes)
510 setflag(addr, af_include_affixes); /* Affects logged => line */
511 return addr->address;
514 if (addr->suffix == NULL)
516 if (addr->prefix == NULL) return addr->address;
517 return addr->address + Ustrlen(addr->prefix);
520 at = Ustrrchr(addr->address, '@');
521 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
522 slen = Ustrlen(addr->suffix);
524 return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
525 addr->address + plen, at + 1);
529 /*************************************************
530 * Output Envelope-To: address & scan duplicates *
531 *************************************************/
533 /* This function is called from internal_transport_write_message() below, when
534 generating an Envelope-To: header line. It checks for duplicates of the given
535 address and its ancestors. When one is found, this function calls itself
536 recursively, to output the envelope address of the duplicate.
538 We want to avoid duplication in the list, which can arise for example when
539 A->B,C and then both B and C alias to D. This can also happen when there are
540 unseen drivers in use. So a list of addresses that have been output is kept in
543 It is also possible to have loops in the address ancestry/duplication graph,
544 for example if there are two top level addresses A and B and we have A->B,C and
545 B->A. To break the loop, we use a list of processed addresses in the dlist
548 After handling duplication, this function outputs the progenitor of the given
552 p the address we are interested in
553 pplist address of anchor of the list of addresses not to output
554 pdlist address of anchor of the list of processed addresses
555 first TRUE if this is the first address; set it FALSE afterwards
556 fd the file descriptor to write to
557 tctx transport context - processing to be done during output
559 Returns: FALSE if writing failed
563 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
564 BOOL *first, int fd, transport_ctx * tctx)
569 /* Do nothing if we have already handled this address. If not, remember it
570 so that we don't handle it again. */
572 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
574 ppp = store_get(sizeof(struct aci));
579 /* Now scan up the ancestry, checking for duplicates at each generation. */
581 for (pp = p;; pp = pp->parent)
584 for (dup = addr_duplicate; dup; dup = dup->next)
585 if (dup->dupof == pp) /* a dup of our address */
586 if (!write_env_to(dup, pplist, pdlist, first, fd, tctx))
588 if (!pp->parent) break;
591 /* Check to see if we have already output the progenitor. */
593 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
594 if (ppp) return TRUE;
596 /* Remember what we have output, and output it. */
598 ppp = store_get(sizeof(struct aci));
603 if (!*first && !write_chunk(fd, tctx, US",\n ", 3)) return FALSE;
605 return write_chunk(fd, tctx, pp->address, Ustrlen(pp->address));
611 /* Add/remove/rewwrite headers, and send them plus the empty-line sparator.
617 addr (chain of) addresses (for extra headers), or NULL;
618 only the first address is used
619 fd file descriptor to write the message to
620 sendfn function for output (transport or verify)
622 use_crlf turn NL into CR LF
623 use_bdat callback before chunk flush
624 rewrite_rules chain of header rewriting rules
625 rewrite_existflags flags for the rewriting rules
626 chunk_cb transport callback function for data-chunk commands
628 Returns: TRUE on success; FALSE on failure.
631 transport_headers_send(int fd, transport_ctx * tctx,
632 BOOL (*sendfn)(int fd, transport_ctx * tctx, uschar * s, int len))
636 transport_instance * tblock = tctx ? tctx->tblock : NULL;
637 address_item * addr = tctx ? tctx->addr : NULL;
639 /* Then the message's headers. Don't write any that are flagged as "old";
640 that means they were rewritten, or are a record of envelope rewriting, or
641 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
642 match any entries therein. It is a colon-sep list; expand the items
643 separately and squash any empty ones.
644 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
646 for (h = header_list; h; h = h->next) if (h->type != htype_old)
649 BOOL include_header = TRUE;
651 list = tblock ? tblock->remove_headers : NULL;
652 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
656 int sep = ':'; /* This is specified as a colon-separated list */
658 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
663 if (!(s = expand_string(s)) && !expand_string_forcedfail)
665 errno = ERRNO_CHHEADER_FAIL;
668 len = s ? Ustrlen(s) : 0;
669 if (strncmpic(h->text, s, len) != 0) continue;
671 while (*ss == ' ' || *ss == '\t') ss++;
672 if (*ss == ':') break;
674 if (s) { include_header = FALSE; break; }
676 if (addr) list = addr->prop.remove_headers;
679 /* If this header is to be output, try to rewrite it if there are rewriting
684 if (tblock && tblock->rewrite_rules)
686 void *reset_point = store_get(0);
689 if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
690 tblock->rewrite_existflags, FALSE)))
692 if (!sendfn(fd, tctx, hh->text, hh->slen)) return FALSE;
693 store_reset(reset_point);
694 continue; /* With the next header line */
698 /* Either no rewriting rules, or it didn't get rewritten */
700 if (!sendfn(fd, tctx, h->text, h->slen)) return FALSE;
707 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
711 /* Add on any address-specific headers. If there are multiple addresses,
712 they will all have the same headers in order to be batched. The headers
713 are chained in reverse order of adding (so several addresses from the
714 same alias might share some of them) but we want to output them in the
715 opposite order. This is a bit tedious, but there shouldn't be very many
716 of them. We just walk the list twice, reversing the pointers each time,
717 but on the second time, write out the items.
719 Headers added to an address by a router are guaranteed to end with a newline.
725 header_line *hprev = addr->prop.extra_headers;
727 for (i = 0; i < 2; i++)
728 for (h = hprev, hprev = NULL; h; h = hnext)
735 if (!sendfn(fd, tctx, h->text, h->slen)) return FALSE;
737 debug_printf("added header line(s):\n%s---\n", h->text);
742 /* If a string containing additional headers exists it is a newline-sep
743 list. Expand each item and write out the result. This is done last so that
744 if it (deliberately or accidentally) isn't in header format, it won't mess
745 up any other headers. An empty string or a forced expansion failure are
746 noops. An added header string from a transport may not end with a newline;
747 add one if it does not. */
749 if (tblock && (list = CUS tblock->add_headers))
754 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
755 if ((s = expand_string(s)))
757 int len = Ustrlen(s);
760 if (!sendfn(fd, tctx, s, len)) return FALSE;
761 if (s[len-1] != '\n' && !sendfn(fd, tctx, US"\n", 1))
765 debug_printf("added header line:\n%s", s);
766 if (s[len-1] != '\n') debug_printf("\n");
767 debug_printf("---\n");
771 else if (!expand_string_forcedfail)
772 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
775 /* Separate headers from body with a blank line */
777 return sendfn(fd, tctx, US"\n", 1);
781 /*************************************************
782 * Write the message *
783 *************************************************/
785 /* This function writes the message to the given file descriptor. The headers
786 are in the in-store data structure, and the rest of the message is in the open
787 file descriptor deliver_datafile. Make sure we start it at the beginning.
789 . If add_return_path is TRUE, a "return-path:" header is added to the message,
790 containing the envelope sender's address.
792 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
793 giving the top-level envelope address that caused this delivery to happen.
795 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
796 message. It gives the time and date that delivery took place.
798 . If check_string is not null, the start of each line is checked for that
799 string. If it is found, it is replaced by escape_string. This used to be
800 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
802 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
804 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
805 any writing or reading error, leaving the code in errno intact. Error exits
806 can include timeouts for certain transports, which are requested by setting
807 transport_write_timeout non-zero.
810 fd file descriptor to write the message to
812 addr (chain of) addresses (for extra headers), or NULL;
813 only the first address is used
814 tblock optional transport instance block (NULL signifies NULL/0):
815 add_headers a string containing one or more headers to add; it is
816 expanded, and must be in correct RFC 822 format as
817 it is transmitted verbatim; NULL => no additions,
818 and so does empty string or forced expansion fail
819 remove_headers a colon-separated list of headers to remove, or NULL
820 rewrite_rules chain of header rewriting rules
821 rewrite_existflags flags for the rewriting rules
822 options bit-wise options:
823 add_return_path if TRUE, add a "return-path" header
824 add_envelope_to if TRUE, add a "envelope-to" header
825 add_delivery_date if TRUE, add a "delivery-date" header
826 use_crlf if TRUE, turn NL into CR LF
827 end_dot if TRUE, send a terminating "." line at the end
828 no_headers if TRUE, omit the headers
829 no_body if TRUE, omit the body
830 size_limit if > 0, this is a limit to the size of message written;
831 it is used when returning messages to their senders,
832 and is approximate rather than exact, owing to chunk
834 check_string a string to check for at the start of lines, or NULL
835 escape_string a string to insert in front of any check string
837 Returns: TRUE on success; FALSE (with errno) on failure.
838 In addition, the global variable transport_count
839 is incremented by the number of bytes written.
843 internal_transport_write_message(int fd, transport_ctx * tctx, int size_limit)
849 /* Initialize pointer in output buffer. */
851 chunk_ptr = deliver_out_buffer;
853 /* Set up the data for start-of-line data checking and escaping */
855 nl_partial_match = -1;
856 if (tctx->check_string && tctx->escape_string)
858 nl_check = tctx->check_string;
859 nl_check_length = Ustrlen(nl_check);
860 nl_escape = tctx->escape_string;
861 nl_escape_length = Ustrlen(nl_escape);
864 nl_check_length = nl_escape_length = 0;
866 /* Whether the escaping mechanism is applied to headers or not is controlled by
867 an option (set for SMTP, not otherwise). Negate the length if not wanted till
868 after the headers. */
870 if (!(tctx->options & topt_escape_headers))
871 nl_check_length = -nl_check_length;
873 /* Write the headers if required, including any that have to be added. If there
874 are header rewriting rules, apply them. */
876 if (!(tctx->options & topt_no_headers))
878 /* Add return-path: if requested. */
880 if (tctx->options & topt_add_return_path)
882 uschar buffer[ADDRESS_MAXLENGTH + 20];
883 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
885 if (!write_chunk(fd, tctx, buffer, n)) return FALSE;
888 /* Add envelope-to: if requested */
890 if (tctx->options & topt_add_envelope_to)
894 struct aci *plist = NULL;
895 struct aci *dlist = NULL;
896 void *reset_point = store_get(0);
898 if (!write_chunk(fd, tctx, US"Envelope-to: ", 13)) return FALSE;
900 /* Pick up from all the addresses. The plist and dlist variables are
901 anchors for lists of addresses already handled; they have to be defined at
902 this level becuase write_env_to() calls itself recursively. */
904 for (p = tctx->addr; p; p = p->next)
905 if (!write_env_to(p, &plist, &dlist, &first, fd, tctx))
908 /* Add a final newline and reset the store used for tracking duplicates */
910 if (!write_chunk(fd, tctx, US"\n", 1)) return FALSE;
911 store_reset(reset_point);
914 /* Add delivery-date: if requested. */
916 if (tctx->options & topt_add_delivery_date)
919 int n = sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
920 if (!write_chunk(fd, tctx, buffer, n)) return FALSE;
923 /* Then the message's headers. Don't write any that are flagged as "old";
924 that means they were rewritten, or are a record of envelope rewriting, or
925 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
926 match any entries therein. Then check addr->prop.remove_headers too, provided that
929 if (!transport_headers_send(fd, tctx, &write_chunk))
933 /* When doing RFC3030 CHUNKING output, work out how much data will be in the
934 last BDAT, consisting of the current write_chunk() output buffer fill
935 (optimally, all of the headers - but it does not matter if we already had to
936 flush that buffer with non-last BDAT prependix) plus the amount of body data
937 (as expanded for CRLF lines). Then create and write the BDAT, and ensure
938 that further use of write_chunk() will not prepend BDATs. */
940 if (tctx->options & topt_use_bdat)
942 if ((size = chunk_ptr - deliver_out_buffer) < 0)
944 if (!(tctx->options & topt_no_body))
946 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
947 fsize -= SPOOL_DATA_START_OFFSET;
948 if (size_limit > 0 && fsize > size_limit)
951 if (tctx->options & topt_use_crlf)
952 size += body_linecount; /* account for CRLF-expansion */
956 Emit a LAST datachunk command. */
958 if (tctx->chunk_cb(fd, tctx, size, TRUE) != OK)
961 tctx->options &= ~topt_use_bdat;
964 /* If the body is required, ensure that the data for check strings (formerly
965 the "from hack") is enabled by negating the length if necessary. (It will be
966 negative in cases where it isn't to apply to the headers). Then ensure the body
967 is positioned at the start of its file (following the message id), then write
968 it, applying the size limit if required. */
970 if (!(tctx->options & topt_no_body))
972 nl_check_length = abs(nl_check_length);
973 nl_partial_match = 0;
974 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
976 while ( (len = MAX(DELIVER_IN_BUFFER_SIZE, size)) > 0
977 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
978 if (!write_chunk(fd, tctx, deliver_in_buffer, len))
981 /* A read error on the body will have left len == -1 and errno set. */
983 if (len != 0) return FALSE;
986 /* Finished with the check string */
988 nl_check_length = nl_escape_length = 0;
990 /* If requested, add a terminating "." line (SMTP output). */
992 if (tctx->options & topt_end_dot && !write_chunk(fd, tctx, US".\n", 2))
995 /* Write out any remaining data in the buffer before returning. */
997 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
998 transport_write_block(fd, deliver_out_buffer, len);
1002 #ifndef DISABLE_DKIM
1004 /***************************************************************************************************
1005 * External interface to write the message, while signing it with DKIM and/or Domainkeys *
1006 ***************************************************************************************************/
1008 /* This function is a wrapper around transport_write_message().
1009 It is only called from the smtp transport if DKIM or Domainkeys support
1010 is compiled in. The function sets up a replacement fd into a -K file,
1011 then calls the normal function. This way, the exact bits that exim would
1012 have put "on the wire" will end up in the file (except for TLS
1013 encapsulation, which is the very very last thing). When we are done
1014 signing the file, send the signed message down the original fd (or TLS fd).
1017 as for internal_transport_write_message() above, with additional arguments
1020 Returns: TRUE on success; FALSE (with errno) for any failure
1024 dkim_transport_write_message(int out_fd, transport_ctx * tctx,
1025 struct ob_dkim * dkim)
1030 uschar * dkim_spool_name;
1033 uschar *dkim_signature = NULL;
1037 /* If we can't sign, just call the original function. */
1039 if (!(dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector))
1040 return transport_write_message(out_fd, tctx, 0);
1042 dkim_spool_name = spool_fname(US"input", message_subdir, message_id,
1043 string_sprintf("-%d-K", (int)getpid()));
1045 if ((dkim_fd = Uopen(dkim_spool_name, O_RDWR|O_CREAT|O_TRUNC, SPOOL_MODE)) < 0)
1047 /* Can't create spool file. Ugh. */
1053 /* Call original function to write the -K file; does the CRLF expansion */
1055 tctx->options &= ~topt_use_bdat;
1056 rc = transport_write_message(dkim_fd, tctx, 0);
1058 /* Save error state. We must clean up before returning. */
1065 if (dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector)
1067 /* Rewind file and feed it to the goats^W DKIM lib */
1068 lseek(dkim_fd, 0, SEEK_SET);
1069 dkim_signature = dkim_exim_sign(dkim_fd,
1070 dkim->dkim_private_key,
1072 dkim->dkim_selector,
1074 dkim->dkim_sign_headers);
1075 if (!dkim_signature)
1077 if (dkim->dkim_strict)
1079 uschar *dkim_strict_result = expand_string(dkim->dkim_strict);
1080 if (dkim_strict_result)
1081 if ( (strcmpic(dkim->dkim_strict,US"1") == 0) ||
1082 (strcmpic(dkim->dkim_strict,US"true") == 0) )
1084 /* Set errno to something halfway meaningful */
1085 save_errno = EACCES;
1086 log_write(0, LOG_MAIN, "DKIM: message could not be signed,"
1087 " and dkim_strict is set. Deferring message delivery.");
1099 siglen = Ustrlen(dkim_signature);
1103 wwritten = tls_out.active == out_fd
1104 ? tls_write(FALSE, dkim_signature, siglen)
1105 : write(out_fd, dkim_signature, siglen);
1107 wwritten = write(out_fd, dkim_signature, siglen);
1111 /* error, bail out */
1117 dkim_signature += wwritten;
1121 #ifdef HAVE_LINUX_SENDFILE
1122 /* We can use sendfile() to shove the file contents
1123 to the socket. However only if we don't use TLS,
1124 as then there's another layer of indirection
1125 before the data finally hits the socket. */
1126 if (tls_out.active != out_fd)
1131 k_file_size = lseek(dkim_fd, 0, SEEK_END); /* Fetch file size */
1134 lseek(dkim_fd, 0, SEEK_SET);
1136 while(copied >= 0 && offset < k_file_size)
1137 copied = sendfile(out_fd, dkim_fd, &offset, k_file_size - offset);
1150 lseek(dkim_fd, 0, SEEK_SET);
1152 /* Send file down the original fd */
1153 while((sread = read(dkim_fd, deliver_out_buffer, DELIVER_OUT_BUFFER_SIZE)) >0)
1155 char *p = deliver_out_buffer;
1156 /* write the chunk */
1161 wwritten = tls_out.active == out_fd
1162 ? tls_write(FALSE, US p, sread)
1163 : write(out_fd, p, sread);
1165 wwritten = write(out_fd, p, sread);
1169 /* error, bail out */
1187 /* unlink -K file */
1188 (void)close(dkim_fd);
1189 Uunlink(dkim_spool_name);
1198 /*************************************************
1199 * External interface to write the message *
1200 *************************************************/
1202 /* If there is no filtering required, call the internal function above to do
1203 the real work, passing over all the arguments from this function. Otherwise,
1204 set up a filtering process, fork another process to call the internal function
1205 to write to the filter, and in this process just suck from the filter and write
1206 down the given fd. At the end, tidy up the pipes and the processes.
1209 Arguments: as for internal_transport_write_message() above
1211 Returns: TRUE on success; FALSE (with errno) for any failure
1212 transport_count is incremented by the number of bytes written
1216 transport_write_message(int fd, transport_ctx * tctx, int size_limit)
1219 BOOL last_filter_was_NL = TRUE;
1220 int rc, len, yield, fd_read, fd_write, save_errno;
1221 int pfd[2] = {-1, -1};
1222 pid_t filter_pid, write_pid;
1223 static transport_ctx dummy_tctx = {0};
1225 if (!tctx) tctx = &dummy_tctx;
1227 transport_filter_timed_out = FALSE;
1229 /* If there is no filter command set up, call the internal function that does
1230 the actual work, passing it the incoming fd, and return its result. */
1232 if ( !transport_filter_argv
1233 || !*transport_filter_argv
1234 || !**transport_filter_argv
1236 return internal_transport_write_message(fd, tctx, size_limit);
1238 /* Otherwise the message must be written to a filter process and read back
1239 before being written to the incoming fd. First set up the special processing to
1240 be done during the copying. */
1242 wck_flags = tctx->options & topt_use_crlf;
1243 nl_partial_match = -1;
1245 if (tctx->check_string && tctx->escape_string)
1247 nl_check = tctx->check_string;
1248 nl_check_length = Ustrlen(nl_check);
1249 nl_escape = tctx->escape_string;
1250 nl_escape_length = Ustrlen(nl_escape);
1252 else nl_check_length = nl_escape_length = 0;
1254 /* Start up a subprocess to run the command. Ensure that our main fd will
1255 be closed when the subprocess execs, but remove the flag afterwards.
1256 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1257 process to deliver another message.) We get back stdin/stdout file descriptors.
1258 If the process creation failed, give an error return. */
1264 write_pid = (pid_t)(-1);
1266 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1267 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1268 &fd_write, &fd_read, FALSE);
1269 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
1270 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1273 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1274 (int)filter_pid, fd_write, fd_read);
1276 /* Fork subprocess to write the message to the filter, and return the result
1277 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1278 smtp dots, or check string processing. */
1280 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1281 if ((write_pid = fork()) == 0)
1284 (void)close(fd_read);
1285 (void)close(pfd[pipe_read]);
1286 nl_check_length = nl_escape_length = 0;
1288 tctx->check_string = tctx->escape_string = NULL;
1289 tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat);
1291 rc = internal_transport_write_message(fd_write, tctx, size_limit);
1294 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1296 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1298 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1301 rc = FALSE; /* compiler quietening */
1306 /* Parent process: close our copy of the writing subprocess' pipes. */
1308 (void)close(pfd[pipe_write]);
1309 (void)close(fd_write);
1312 /* Writing process creation failed */
1316 errno = save_errno; /* restore */
1320 /* When testing, let the subprocess get going */
1322 if (running_in_test_harness) millisleep(250);
1325 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1327 /* Copy the message from the filter to the output fd. A read error leaves len
1328 == -1 and errno set. We need to apply a timeout to the read, to cope with
1329 the case when the filter gets stuck, but it can be quite a long one. The
1330 default is 5m, but this is now configurable. */
1332 DEBUG(D_transport) debug_printf("copying from the filter\n");
1334 /* Copy the output of the filter, remembering if the last character was NL. If
1335 no data is returned, that counts as "ended with NL" (default setting of the
1336 variable is TRUE). */
1338 chunk_ptr = deliver_out_buffer;
1342 sigalrm_seen = FALSE;
1343 alarm(transport_filter_timeout);
1344 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1349 transport_filter_timed_out = TRUE;
1353 /* If the read was successful, write the block down the original fd,
1354 remembering whether it ends in \n or not. */
1358 if (!write_chunk(fd, tctx, deliver_in_buffer, len)) goto TIDY_UP;
1359 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1362 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1366 if (len == 0) yield = TRUE;
1371 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1372 to something. Ensure the pipes are all closed and the processes are removed. If
1373 there has been an error, kill the processes before waiting for them, just to be
1374 sure. Also apply a paranoia timeout. */
1379 (void)close(fd_read);
1380 if (fd_write > 0) (void)close(fd_write);
1384 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1385 if (write_pid > 0) kill(write_pid, SIGKILL);
1388 /* Wait for the filter process to complete. */
1390 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1391 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1394 save_errno = ERRNO_FILTER_FAIL;
1395 tctx->addr->more_errno = rc;
1396 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1399 /* Wait for the writing process to complete. If it ends successfully,
1400 read the results from its pipe, provided we haven't already had a filter
1403 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1406 rc = child_close(write_pid, 30);
1412 int dummy = read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
1415 dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1416 dummy = read(pfd[pipe_read], (void *)&(tctx->addr->more_errno), sizeof(int));
1423 save_errno = ERRNO_FILTER_FAIL;
1424 tctx->addr->more_errno = rc;
1425 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1429 (void)close(pfd[pipe_read]);
1431 /* If there have been no problems we can now add the terminating "." if this is
1432 SMTP output, turning off escaping beforehand. If the last character from the
1433 filter was not NL, insert a NL to make the SMTP protocol work. */
1437 nl_check_length = nl_escape_length = 0;
1438 if ( tctx->options & topt_end_dot
1439 && ( last_filter_was_NL
1440 ? !write_chunk(fd, tctx, US".\n", 2)
1441 : !write_chunk(fd, tctx, US"\n.\n", 3)
1445 /* Write out any remaining data in the buffer. */
1448 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1449 || transport_write_block(fd, deliver_out_buffer, len);
1452 errno = save_errno; /* From some earlier error */
1456 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1458 debug_printf("errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1468 /*************************************************
1469 * Update waiting database *
1470 *************************************************/
1472 /* This is called when an address is deferred by remote transports that are
1473 capable of sending more than one message over one connection. A database is
1474 maintained for each transport, keeping track of which messages are waiting for
1475 which hosts. The transport can then consult this when eventually a successful
1476 delivery happens, and if it finds that another message is waiting for the same
1477 host, it can fire up a new process to deal with it using the same connection.
1479 The database records are keyed by host name. They can get full if there are
1480 lots of messages waiting, and so there is a continuation mechanism for them.
1482 Each record contains a list of message ids, packed end to end without any
1483 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1484 in this record, and the sequence field says if there are any other records for
1485 this host. If the sequence field is 0, there are none. If it is 1, then another
1486 record with the name <hostname>:0 exists; if it is 2, then two other records
1487 with sequence numbers 0 and 1 exist, and so on.
1489 Currently, an exhaustive search of all continuation records has to be done to
1490 determine whether to add a message id to a given record. This shouldn't be
1491 too bad except in extreme cases. I can't figure out a *simple* way of doing
1494 Old records should eventually get swept up by the exim_tidydb utility.
1497 hostlist list of hosts that this message could be sent to
1498 tpname name of the transport
1504 transport_update_waiting(host_item *hostlist, uschar *tpname)
1507 const uschar *prevname = US"";
1512 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1514 /* Open the database for this transport */
1516 sprintf(CS buffer, "wait-%.200s", tpname);
1517 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1518 if (dbm_file == NULL) return;
1520 /* Scan the list of hosts for which this message is waiting, and ensure
1521 that the message id is in each host record. */
1523 for (host = hostlist; host!= NULL; host = host->next)
1525 BOOL already = FALSE;
1526 dbdata_wait *host_record;
1530 /* Skip if this is the same host as we just processed; otherwise remember
1531 the name for next time. */
1533 if (Ustrcmp(prevname, host->name) == 0) continue;
1534 prevname = host->name;
1536 /* Look up the host record; if there isn't one, make an empty one. */
1538 host_record = dbfn_read(dbm_file, host->name);
1539 if (host_record == NULL)
1541 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1542 host_record->count = host_record->sequence = 0;
1545 /* Compute the current length */
1547 host_length = host_record->count * MESSAGE_ID_LENGTH;
1549 /* Search the record to see if the current message is already in it. */
1551 for (s = host_record->text; s < host_record->text + host_length;
1552 s += MESSAGE_ID_LENGTH)
1554 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1555 { already = TRUE; break; }
1558 /* If we haven't found this message in the main record, search any
1559 continuation records that exist. */
1561 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1564 sprintf(CS buffer, "%.200s:%d", host->name, i);
1565 cont = dbfn_read(dbm_file, buffer);
1568 int clen = cont->count * MESSAGE_ID_LENGTH;
1569 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1571 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1572 { already = TRUE; break; }
1577 /* If this message is already in a record, no need to update. */
1581 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1586 /* If this record is full, write it out with a new name constructed
1587 from the sequence number, increase the sequence number, and empty
1590 if (host_record->count >= WAIT_NAME_MAX)
1592 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1593 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1594 host_record->sequence++;
1595 host_record->count = 0;
1599 /* If this record is not full, increase the size of the record to
1600 allow for one new message id. */
1605 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1606 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1610 /* Now add the new name on the end */
1612 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1613 host_record->count++;
1614 host_length += MESSAGE_ID_LENGTH;
1616 /* Update the database */
1618 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1619 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1624 dbfn_close(dbm_file);
1630 /*************************************************
1631 * Test for waiting messages *
1632 *************************************************/
1634 /* This function is called by a remote transport which uses the previous
1635 function to remember which messages are waiting for which remote hosts. It's
1636 called after a successful delivery and its job is to check whether there is
1637 another message waiting for the same host. However, it doesn't do this if the
1638 current continue sequence is greater than the maximum supplied as an argument,
1639 or greater than the global connection_max_messages, which, if set, overrides.
1642 transport_name name of the transport
1643 hostname name of the host
1644 local_message_max maximum number of messages down one connection
1645 as set by the caller transport
1646 new_message_id set to the message id of a waiting message
1647 more set TRUE if there are yet more messages waiting
1648 oicf_func function to call to validate if it is ok to send
1649 to this message_id from the current instance.
1650 oicf_data opaque data for oicf_func
1652 Returns: TRUE if new_message_id set; FALSE otherwise
1655 typedef struct msgq_s
1657 uschar message_id [MESSAGE_ID_LENGTH + 1];
1662 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1663 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1665 dbdata_wait *host_record;
1672 struct stat statbuf;
1678 debug_printf("transport_check_waiting entered\n");
1679 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1680 continue_sequence, local_message_max, connection_max_messages);
1683 /* Do nothing if we have hit the maximum number that can be send down one
1686 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1687 if (local_message_max > 0 && continue_sequence >= local_message_max)
1690 debug_printf("max messages for one connection reached: returning\n");
1694 /* Open the waiting information database. */
1696 sprintf(CS buffer, "wait-%.200s", transport_name);
1697 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1698 if (dbm_file == NULL) return FALSE;
1700 /* See if there is a record for this host; if not, there's nothing to do. */
1702 if (!(host_record = dbfn_read(dbm_file, hostname)))
1704 dbfn_close(dbm_file);
1705 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1709 /* If the data in the record looks corrupt, just log something and
1710 don't try to use it. */
1712 if (host_record->count > WAIT_NAME_MAX)
1714 dbfn_close(dbm_file);
1715 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1716 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1720 /* Scan the message ids in the record from the end towards the beginning,
1721 until one is found for which a spool file actually exists. If the record gets
1722 emptied, delete it and continue with any continuation records that may exist.
1725 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1726 but the 1 off will remain without it. This code now allows me to SKIP over
1727 a message I do not want to send out on this run. */
1729 host_length = host_record->count * MESSAGE_ID_LENGTH;
1735 int msgq_actual = 0;
1736 BOOL bFound = FALSE;
1737 BOOL bContinuation = FALSE;
1739 /* create an array to read entire message queue into memory for processing */
1741 msgq = (msgq_t*) malloc(sizeof(msgq_t) * host_record->count);
1742 msgq_count = host_record->count;
1743 msgq_actual = msgq_count;
1745 for (i = 0; i < host_record->count; ++i)
1747 msgq[i].bKeep = TRUE;
1749 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1751 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1754 /* first thing remove current message id if it exists */
1756 for (i = 0; i < msgq_count; ++i)
1757 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1759 msgq[i].bKeep = FALSE;
1763 /* now find the next acceptable message_id */
1765 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1769 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1772 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1774 msgq[i].bKeep = FALSE;
1775 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1777 Ustrcpy(new_message_id, msgq[i].message_id);
1778 msgq[i].bKeep = FALSE;
1785 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1789 /* reassemble the host record, based on removed message ids, from in
1792 if (msgq_actual <= 0)
1795 host_record->count = 0;
1799 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1800 host_record->count = msgq_actual;
1802 if (msgq_actual < msgq_count)
1805 for (new_count = 0, i = 0; i < msgq_count; ++i)
1807 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1808 msgq[i].message_id, MESSAGE_ID_LENGTH);
1810 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1814 /* Jeremy: check for a continuation record, this code I do not know how to
1815 test but the code should work */
1817 while (host_length <= 0)
1820 dbdata_wait * newr = NULL;
1822 /* Search for a continuation */
1824 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1826 sprintf(CS buffer, "%.200s:%d", hostname, i);
1827 newr = dbfn_read(dbm_file, buffer);
1830 /* If no continuation, delete the current and break the loop */
1834 dbfn_delete(dbm_file, hostname);
1838 /* Else replace the current with the continuation */
1840 dbfn_delete(dbm_file, buffer);
1842 host_length = host_record->count * MESSAGE_ID_LENGTH;
1844 bContinuation = TRUE;
1847 if (bFound) /* Usual exit from main loop */
1853 /* If host_length <= 0 we have emptied a record and not found a good message,
1854 and there are no continuation records. Otherwise there is a continuation
1855 record to process. */
1857 if (host_length <= 0)
1859 dbfn_close(dbm_file);
1860 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1864 /* we were not able to find an acceptable message, nor was there a
1865 * continuation record. So bug out, outer logic will clean this up.
1870 Ustrcpy(new_message_id, message_id);
1871 dbfn_close(dbm_file);
1876 } /* we need to process a continuation record */
1878 /* Control gets here when an existing message has been encountered; its
1879 id is in new_message_id, and host_length is the revised length of the
1880 host record. If it is zero, the record has been removed. Update the
1881 record if required, close the database, and return TRUE. */
1883 if (host_length > 0)
1885 host_record->count = host_length/MESSAGE_ID_LENGTH;
1887 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1891 dbfn_close(dbm_file);
1895 /*************************************************
1896 * Deliver waiting message down same socket *
1897 *************************************************/
1899 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1900 get a clean delivery process, and to regain root privilege in cases where it
1901 has been given away.
1904 transport_name to pass to the new process
1907 id the new message to process
1908 socket_fd the connected socket
1910 Returns: FALSE if fork fails; TRUE otherwise
1914 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1915 const uschar *hostaddress, uschar *id, int socket_fd)
1920 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1922 if ((pid = fork()) == 0)
1925 const uschar **argv;
1927 /* Disconnect entirely from the parent process. If we are running in the
1928 test harness, wait for a bit to allow the previous process time to finish,
1929 write the log, etc., so that the output is always in the same order for
1930 automatic comparison. */
1932 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
1933 if (running_in_test_harness) sleep(1);
1935 /* Set up the calling arguments; use the standard function for the basics,
1936 but we have a number of extras that may be added. */
1938 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1940 if (smtp_use_dsn) argv[i++] = US"-MCD";
1942 if (smtp_authenticated) argv[i++] = US"-MCA";
1945 if (tls_offered) argv[i++] = US"-MCT";
1948 if (smtp_use_size) argv[i++] = US"-MCS";
1949 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1951 if (queue_run_pid != (pid_t)0)
1953 argv[i++] = US"-MCQ";
1954 argv[i++] = string_sprintf("%d", queue_run_pid);
1955 argv[i++] = string_sprintf("%d", queue_run_pipe);
1958 argv[i++] = US"-MC";
1959 argv[i++] = US transport_name;
1960 argv[i++] = US hostname;
1961 argv[i++] = US hostaddress;
1962 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1966 /* Arrange for the channel to be on stdin. */
1970 (void)dup2(socket_fd, 0);
1971 (void)close(socket_fd);
1974 DEBUG(D_exec) debug_print_argv(argv);
1975 exim_nullstd(); /* Ensure std{out,err} exist */
1976 execv(CS argv[0], (char *const *)argv);
1978 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1979 _exit(errno); /* Note: must be _exit(), NOT exit() */
1982 /* If the process creation succeeded, wait for the first-level child, which
1983 immediately exits, leaving the second level process entirely disconnected from
1989 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1990 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
1995 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
2003 /*************************************************
2004 * Set up direct (non-shell) command *
2005 *************************************************/
2007 /* This function is called when a command line is to be parsed and executed
2008 directly, without the use of /bin/sh. It is called by the pipe transport,
2009 the queryprogram router, and also from the main delivery code when setting up a
2010 transport filter process. The code for ETRN also makes use of this; in that
2011 case, no addresses are passed.
2014 argvptr pointer to anchor for argv vector
2015 cmd points to the command string (modified IN PLACE)
2016 expand_arguments true if expansion is to occur
2017 expand_failed error value to set if expansion fails; not relevant if
2019 addr chain of addresses, or NULL
2020 etext text for use in error messages
2021 errptr where to put error message if addr is NULL;
2022 otherwise it is put in the first address
2024 Returns: TRUE if all went well; otherwise an error will be
2025 set in the first address and FALSE returned
2029 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2030 BOOL expand_arguments, int expand_failed, address_item *addr,
2031 uschar *etext, uschar **errptr)
2034 const uschar **argv;
2036 int address_count = 0;
2040 /* Get store in which to build an argument list. Count the number of addresses
2041 supplied, and allow for that many arguments, plus an additional 60, which
2042 should be enough for anybody. Multiple addresses happen only when the local
2043 delivery batch option is set. */
2045 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2046 max_args = address_count + 60;
2047 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2049 /* Split the command up into arguments terminated by white space. Lose
2050 trailing space at the start and end. Double-quoted arguments can contain \\ and
2051 \" escapes and so can be handled by the standard function; single-quoted
2052 arguments are verbatim. Copy each argument into a new string. */
2055 while (isspace(*s)) s++;
2057 while (*s != 0 && argcount < max_args)
2062 while (*ss != 0 && *ss != '\'') ss++;
2063 argv[argcount++] = ss = store_get(ss - s++);
2064 while (*s != 0 && *s != '\'') *ss++ = *s++;
2068 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2069 while (isspace(*s)) s++;
2072 argv[argcount] = (uschar *)0;
2074 /* If *s != 0 we have run out of argument slots. */
2078 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2082 addr->transport_return = FAIL;
2083 addr->message = msg;
2089 /* Expand each individual argument if required. Expansion happens for pipes set
2090 up in filter files and with directly-supplied commands. It does not happen if
2091 the pipe comes from a traditional .forward file. A failing expansion is a big
2092 disaster if the command came from Exim's configuration; if it came from a user
2093 it is just a normal failure. The expand_failed value is used as the error value
2094 to cater for these two cases.
2096 An argument consisting just of the text "$pipe_addresses" is treated specially.
2097 It is not passed to the general expansion function. Instead, it is replaced by
2098 a number of arguments, one for each address. This avoids problems with shell
2099 metacharacters and spaces in addresses.
2101 If the parent of the top address has an original part of "system-filter", this
2102 pipe was set up by the system filter, and we can permit the expansion of
2107 debug_printf("direct command:\n");
2108 for (i = 0; argv[i] != (uschar *)0; i++)
2109 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2112 if (expand_arguments)
2114 BOOL allow_dollar_recipients = addr != NULL &&
2115 addr->parent != NULL &&
2116 Ustrcmp(addr->parent->address, "system-filter") == 0;
2118 for (i = 0; argv[i] != (uschar *)0; i++)
2121 /* Handle special fudge for passing an address list */
2124 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2125 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2129 if (argcount + address_count - 1 > max_args)
2131 addr->transport_return = FAIL;
2132 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2133 "in %s", cmd, etext);
2137 additional = address_count - 1;
2139 memmove(argv + i + 1 + additional, argv + i + 1,
2140 (argcount - i)*sizeof(uschar *));
2142 for (ad = addr; ad != NULL; ad = ad->next) {
2143 argv[i++] = ad->address;
2147 /* Subtract one since we replace $pipe_addresses */
2152 /* Handle special case of $address_pipe when af_force_command is set */
2154 else if (addr != NULL && testflag(addr,af_force_command) &&
2155 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2156 Ustrcmp(argv[i], "${address_pipe}") == 0))
2159 int address_pipe_argcount = 0;
2160 int address_pipe_max_args;
2161 uschar **address_pipe_argv;
2163 /* We can never have more then the argv we will be loading into */
2164 address_pipe_max_args = max_args - argcount + 1;
2167 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2169 /* We allocate an additional for (uschar *)0 */
2170 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2172 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2173 s = expand_string(addr->local_part + 1);
2175 if (s == NULL || *s == '\0')
2177 addr->transport_return = FAIL;
2178 addr->message = string_sprintf("Expansion of \"%s\" "
2179 "from command \"%s\" in %s failed: %s",
2180 (addr->local_part + 1), cmd, etext, expand_string_message);
2184 while (isspace(*s)) s++; /* strip leading space */
2186 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2191 while (*ss != 0 && *ss != '\'') ss++;
2192 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2193 while (*s != 0 && *s != '\'') *ss++ = *s++;
2197 else address_pipe_argv[address_pipe_argcount++] =
2198 string_copy(string_dequote(CUSS &s));
2199 while (isspace(*s)) s++; /* strip space after arg */
2202 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2204 /* If *s != 0 we have run out of argument slots. */
2207 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2208 "\"%s\" in %s", addr->local_part + 1, etext);
2211 addr->transport_return = FAIL;
2212 addr->message = msg;
2218 /* address_pipe_argcount - 1
2219 * because we are replacing $address_pipe in the argument list
2220 * with the first thing it expands to */
2221 if (argcount + address_pipe_argcount - 1 > max_args)
2223 addr->transport_return = FAIL;
2224 addr->message = string_sprintf("Too many arguments to command "
2225 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2229 /* If we are not just able to replace the slot that contained
2230 * $address_pipe (address_pipe_argcount == 1)
2231 * We have to move the existing argv by address_pipe_argcount - 1
2232 * Visually if address_pipe_argcount == 2:
2233 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2234 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2236 if (address_pipe_argcount > 1)
2238 /* current position + additonal args */
2239 argv + i + address_pipe_argcount,
2240 /* current position + 1 (for the (uschar *)0 at the end) */
2242 /* -1 for the (uschar *)0 at the end)*/
2243 (argcount - i)*sizeof(uschar *)
2246 /* Now we fill in the slots we just moved argv out of
2247 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2249 for (address_pipe_i = 0;
2250 address_pipe_argv[address_pipe_i] != (uschar *)0;
2253 argv[i++] = address_pipe_argv[address_pipe_i];
2257 /* Subtract one since we replace $address_pipe */
2262 /* Handle normal expansion string */
2266 const uschar *expanded_arg;
2267 enable_dollar_recipients = allow_dollar_recipients;
2268 expanded_arg = expand_cstring(argv[i]);
2269 enable_dollar_recipients = FALSE;
2271 if (expanded_arg == NULL)
2273 uschar *msg = string_sprintf("Expansion of \"%s\" "
2274 "from command \"%s\" in %s failed: %s",
2275 argv[i], cmd, etext, expand_string_message);
2278 addr->transport_return = expand_failed;
2279 addr->message = msg;
2284 argv[i] = expanded_arg;
2290 debug_printf("direct command after expansion:\n");
2291 for (i = 0; argv[i] != (uschar *)0; i++)
2292 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2301 /* End of transport.c */