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 /* Structure for keeping list of addresses that have been added to
15 Envelope-To:, in order to avoid duplication. */
23 /* Static data for write_chunk() */
25 static uschar *chunk_ptr; /* chunk pointer */
26 static uschar *nl_check; /* string to look for at line start */
27 static int nl_check_length; /* length of same */
28 static uschar *nl_escape; /* string to insert */
29 static int nl_escape_length; /* length of same */
30 static int nl_partial_match; /* length matched at chunk end */
33 /* Generic options for transports, all of which live inside transport_instance
34 data blocks and which therefore have the opt_public flag set. Note that there
35 are other options living inside this structure which can be set only from
36 certain transports. */
38 optionlist optionlist_transports[] = {
39 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
40 (void *)offsetof(transport_instance, expand_gid) },
41 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
42 (void *)offsetof(transport_instance, expand_uid) },
43 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
44 (void *)offsetof(transport_instance, rewrite_existflags) },
45 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
46 (void *)offsetof(transport_instance, rewrite_rules) },
47 { "*set_group", opt_bool|opt_hidden|opt_public,
48 (void *)offsetof(transport_instance, gid_set) },
49 { "*set_user", opt_bool|opt_hidden|opt_public,
50 (void *)offsetof(transport_instance, uid_set) },
51 { "body_only", opt_bool|opt_public,
52 (void *)offsetof(transport_instance, body_only) },
53 { "current_directory", opt_stringptr|opt_public,
54 (void *)offsetof(transport_instance, current_dir) },
55 { "debug_print", opt_stringptr | opt_public,
56 (void *)offsetof(transport_instance, debug_string) },
57 { "delivery_date_add", opt_bool|opt_public,
58 (void *)(offsetof(transport_instance, delivery_date_add)) },
59 { "disable_logging", opt_bool|opt_public,
60 (void *)(offsetof(transport_instance, disable_logging)) },
61 { "driver", opt_stringptr|opt_public,
62 (void *)offsetof(transport_instance, driver_name) },
63 { "envelope_to_add", opt_bool|opt_public,
64 (void *)(offsetof(transport_instance, envelope_to_add)) },
66 { "event_action", opt_stringptr | opt_public,
67 (void *)offsetof(transport_instance, event_action) },
69 { "group", opt_expand_gid|opt_public,
70 (void *)offsetof(transport_instance, gid) },
71 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
72 (void *)offsetof(transport_instance, add_headers) },
73 { "headers_only", opt_bool|opt_public,
74 (void *)offsetof(transport_instance, headers_only) },
75 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
76 (void *)offsetof(transport_instance, remove_headers) },
77 { "headers_rewrite", opt_rewrite|opt_public,
78 (void *)offsetof(transport_instance, headers_rewrite) },
79 { "home_directory", opt_stringptr|opt_public,
80 (void *)offsetof(transport_instance, home_dir) },
81 { "initgroups", opt_bool|opt_public,
82 (void *)offsetof(transport_instance, initgroups) },
83 { "max_parallel", opt_stringptr|opt_public,
84 (void *)offsetof(transport_instance, max_parallel) },
85 { "message_size_limit", opt_stringptr|opt_public,
86 (void *)offsetof(transport_instance, message_size_limit) },
87 { "rcpt_include_affixes", opt_bool|opt_public,
88 (void *)offsetof(transport_instance, rcpt_include_affixes) },
89 { "retry_use_local_part", opt_bool|opt_public,
90 (void *)offsetof(transport_instance, retry_use_local_part) },
91 { "return_path", opt_stringptr|opt_public,
92 (void *)(offsetof(transport_instance, return_path)) },
93 { "return_path_add", opt_bool|opt_public,
94 (void *)(offsetof(transport_instance, return_path_add)) },
95 { "shadow_condition", opt_stringptr|opt_public,
96 (void *)offsetof(transport_instance, shadow_condition) },
97 { "shadow_transport", opt_stringptr|opt_public,
98 (void *)offsetof(transport_instance, shadow) },
99 { "transport_filter", opt_stringptr|opt_public,
100 (void *)offsetof(transport_instance, filter_command) },
101 { "transport_filter_timeout", opt_time|opt_public,
102 (void *)offsetof(transport_instance, filter_timeout) },
103 { "user", opt_expand_uid|opt_public,
104 (void *)offsetof(transport_instance, uid) }
107 int optionlist_transports_size = nelem(optionlist_transports);
111 readconf_options_transports(void)
113 struct transport_info * ti;
115 readconf_options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
117 for (ti = transports_available; ti->driver_name[0]; ti++)
119 macro_create(string_sprintf("_DRIVER_TRANSPORT_%T", ti->driver_name), US"y", FALSE, TRUE);
120 readconf_options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
124 /*************************************************
125 * Initialize transport list *
126 *************************************************/
128 /* Read the transports section of the configuration file, and set up a chain of
129 transport instances according to its contents. Each transport has generic
130 options and may also have its own private options. This function is only ever
131 called when transports == NULL. We use generic code in readconf to do most of
137 transport_instance *t;
139 readconf_driver_init(US"transport",
140 (driver_instance **)(&transports), /* chain anchor */
141 (driver_info *)transports_available, /* available drivers */
142 sizeof(transport_info), /* size of info block */
143 &transport_defaults, /* default values for generic options */
144 sizeof(transport_instance), /* size of instance block */
145 optionlist_transports, /* generic options */
146 optionlist_transports_size);
148 /* Now scan the configured transports and check inconsistencies. A shadow
149 transport is permitted only for local transports. */
151 for (t = transports; t; t = t->next)
153 if (!t->info->local && t->shadow)
154 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
155 "shadow transport not allowed on non-local transport %s", t->name);
157 if (t->body_only && t->headers_only)
158 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
159 "%s transport: body_only and headers_only are mutually exclusive",
166 /*************************************************
167 * Write block of data *
168 *************************************************/
170 /* Subroutine called by write_chunk() and at the end of the message actually
171 to write a data block. Also called directly by some transports to write
172 additional data to the file descriptor (e.g. prefix, suffix).
174 If a transport wants data transfers to be timed, it sets a non-zero value in
175 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
176 be set for each block of data written from here. If time runs out, then write()
177 fails and provokes an error return. The caller can then inspect sigalrm_seen to
180 On some systems, if a quota is exceeded during the write, the yield is the
181 number of bytes written rather than an immediate error code. This also happens
182 on some systems in other cases, for example a pipe that goes away because the
183 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
184 get the error codes the first time.
186 The write() function is also interruptible; the Solaris 2.6 man page says:
188 If write() is interrupted by a signal before it writes any
189 data, it will return -1 with errno set to EINTR.
191 If write() is interrupted by a signal after it successfully
192 writes some data, it will return the number of bytes written.
194 To handle these cases, we want to restart the write() to output the remainder
195 of the data after a non-negative return from write(), except after a timeout.
196 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
197 proper error then occurs. In principle, after an interruption, the second
198 write() could suffer the same fate, but we do not want to continue for
199 evermore, so stick a maximum repetition count on the loop to act as a
203 tctx transport context: file descriptor or string to write to
204 block block of bytes to write
205 len number of bytes to write
207 Returns: TRUE on success, FALSE on failure (with errno preserved);
208 transport_count is incremented by the number of bytes written
212 transport_write_block_fd(transport_ctx * tctx, uschar *block, int len, BOOL more)
214 int i, rc, save_errno;
215 int local_timeout = transport_write_timeout;
218 /* This loop is for handling incomplete writes and other retries. In most
219 normal cases, it is only ever executed once. */
221 for (i = 0; i < 100; i++)
224 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
225 fd, len, local_timeout, more ? " (more expected)" : "");
227 /* This code makes use of alarm() in order to implement the timeout. This
228 isn't a very tidy way of doing things. Using non-blocking I/O with select()
229 provides a neater approach. However, I don't know how to do this when TLS is
232 if (transport_write_timeout <= 0) /* No timeout wanted */
236 (tls_out.active == fd) ? tls_write(FALSE, block, len) :
239 more ? send(fd, block, len, MSG_MORE) :
241 write(fd, block, len);
245 /* Timeout wanted. */
249 alarm(local_timeout);
253 (tls_out.active == fd) ? tls_write(FALSE, block, len) :
256 more ? send(fd, block, len, MSG_MORE) :
258 write(fd, block, len);
261 local_timeout = alarm(0);
269 /* Hopefully, the most common case is success, so test that first. */
271 if (rc == len) { transport_count += len; return TRUE; }
273 /* A non-negative return code is an incomplete write. Try again for the rest
274 of the block. If we have exactly hit the timeout, give up. */
280 transport_count += rc;
281 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
282 goto CHECK_TIMEOUT; /* A few lines below */
285 /* A negative return code with an EINTR error is another form of
286 incomplete write, zero bytes having been written */
288 if (save_errno == EINTR)
291 debug_printf("write interrupted before anything written\n");
292 goto CHECK_TIMEOUT; /* A few lines below */
295 /* A response of EAGAIN from write() is likely only in the case of writing
296 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
298 if (save_errno == EAGAIN)
301 debug_printf("write temporarily locked out, waiting 1 sec\n");
304 /* Before continuing to try another write, check that we haven't run out of
308 if (transport_write_timeout > 0 && local_timeout <= 0)
316 /* Otherwise there's been an error */
318 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
319 strerror(save_errno));
324 /* We've tried and tried and tried but still failed */
326 errno = ERRNO_WRITEINCOMPLETE;
332 transport_write_block(transport_ctx * tctx, uschar *block, int len, BOOL more)
334 if (!(tctx->options & topt_output_string))
335 return transport_write_block_fd(tctx, block, len, more);
337 /* Write to expanding-string. NOTE: not NUL-terminated */
341 tctx->u.msg = store_get(tctx->msg_size = 1024);
345 tctx->u.msg = string_catn(tctx->u.msg, &tctx->msg_size, &tctx->msg_ptr, block, len);
352 /*************************************************
353 * Write formatted string *
354 *************************************************/
356 /* This is called by various transports. It is a convenience function.
361 ... arguments for format
363 Returns: the yield of transport_write_block()
367 transport_write_string(int fd, const char *format, ...)
369 transport_ctx tctx = {0};
371 va_start(ap, format);
372 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
373 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
376 return transport_write_block(&tctx, big_buffer, Ustrlen(big_buffer), FALSE);
383 transport_write_reset(int options)
385 if (!(options & topt_continuation)) chunk_ptr = deliver_out_buffer;
386 nl_partial_match = -1;
387 nl_check_length = nl_escape_length = 0;
392 /*************************************************
393 * Write character chunk *
394 *************************************************/
396 /* Subroutine used by transport_write_message() to scan character chunks for
397 newlines and act appropriately. The object is to minimise the number of writes.
398 The output byte stream is buffered up in deliver_out_buffer, which is written
399 only when it gets full, thus minimizing write operations and TCP packets.
401 Static data is used to handle the case when the last character of the previous
402 chunk was NL, or matched part of the data that has to be escaped.
405 tctx transport context - processing to be done during output,
406 and file descriptor to write to
407 chunk pointer to data to write
408 len length of data to write
410 In addition, the static nl_xxx variables must be set as required.
412 Returns: TRUE on success, FALSE on failure (with errno preserved)
416 write_chunk(transport_ctx * tctx, uschar *chunk, int len)
418 uschar *start = chunk;
419 uschar *end = chunk + len;
421 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
423 /* The assumption is made that the check string will never stretch over move
424 than one chunk since the only time there are partial matches is when copying
425 the body in large buffers. There is always enough room in the buffer for an
426 escape string, since the loop below ensures this for each character it
427 processes, and it won't have stuck in the escape string if it left a partial
430 if (nl_partial_match >= 0)
432 if (nl_check_length > 0 && len >= nl_check_length &&
433 Ustrncmp(start, nl_check + nl_partial_match,
434 nl_check_length - nl_partial_match) == 0)
436 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
437 chunk_ptr += nl_escape_length;
438 start += nl_check_length - nl_partial_match;
441 /* The partial match was a false one. Insert the characters carried over
442 from the previous chunk. */
444 else if (nl_partial_match > 0)
446 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
447 chunk_ptr += nl_partial_match;
450 nl_partial_match = -1;
453 /* Now process the characters in the chunk. Whenever we hit a newline we check
454 for possible escaping. The code for the non-NL route should be as fast as
457 for (ptr = start; ptr < end; ptr++)
461 /* Flush the buffer if it has reached the threshold - we want to leave enough
462 room for the next uschar, plus a possible extra CR for an LF, plus the escape
465 if ((len = chunk_ptr - deliver_out_buffer) > mlen)
467 DEBUG(D_transport) debug_printf("flushing headers buffer\n");
469 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
470 from previous SMTP commands. */
472 if (tctx->options & topt_use_bdat && tctx->chunk_cb)
474 if ( tctx->chunk_cb(tctx, (unsigned)len, 0) != OK
475 || !transport_write_block(tctx, deliver_out_buffer, len, FALSE)
476 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
481 if (!transport_write_block(tctx, deliver_out_buffer, len, FALSE))
483 chunk_ptr = deliver_out_buffer;
486 /* Remove CR before NL if required */
488 if ( *ptr == '\r' && ptr[1] == '\n'
489 && !(tctx->options & topt_use_crlf)
490 && spool_file_wireformat
494 if ((ch = *ptr) == '\n')
496 int left = end - ptr - 1; /* count of chars left after NL */
498 /* Insert CR before NL if required */
500 if (tctx->options & topt_use_crlf && !spool_file_wireformat)
503 transport_newlines++;
505 /* The check_string test (formerly "from hack") replaces the specific
506 string at the start of a line with an escape string (e.g. "From " becomes
507 ">From " or "." becomes "..". It is a case-sensitive test. The length
508 check above ensures there is always enough room to insert this string. */
510 if (nl_check_length > 0)
512 if (left >= nl_check_length &&
513 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
515 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
516 chunk_ptr += nl_escape_length;
517 ptr += nl_check_length;
520 /* Handle the case when there isn't enough left to match the whole
521 check string, but there may be a partial match. We remember how many
522 characters matched, and finish processing this chunk. */
524 else if (left <= 0) nl_partial_match = 0;
526 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
528 nl_partial_match = left;
534 /* Not a NL character */
536 else *chunk_ptr++ = ch;
545 /*************************************************
546 * Generate address for RCPT TO *
547 *************************************************/
549 /* This function puts together an address for RCPT to, using the caseful
550 version of the local part and the caseful version of the domain. If there is no
551 prefix or suffix, or if affixes are to be retained, we can just use the
552 original address. Otherwise, if there is a prefix but no suffix we can use a
553 pointer into the original address. If there is a suffix, however, we have to
557 addr the address item
558 include_affixes TRUE if affixes are to be included
564 transport_rcpt_address(address_item *addr, BOOL include_affixes)
571 setflag(addr, af_include_affixes); /* Affects logged => line */
572 return addr->address;
575 if (addr->suffix == NULL)
577 if (addr->prefix == NULL) return addr->address;
578 return addr->address + Ustrlen(addr->prefix);
581 at = Ustrrchr(addr->address, '@');
582 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
583 slen = Ustrlen(addr->suffix);
585 return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
586 addr->address + plen, at + 1);
590 /*************************************************
591 * Output Envelope-To: address & scan duplicates *
592 *************************************************/
594 /* This function is called from internal_transport_write_message() below, when
595 generating an Envelope-To: header line. It checks for duplicates of the given
596 address and its ancestors. When one is found, this function calls itself
597 recursively, to output the envelope address of the duplicate.
599 We want to avoid duplication in the list, which can arise for example when
600 A->B,C and then both B and C alias to D. This can also happen when there are
601 unseen drivers in use. So a list of addresses that have been output is kept in
604 It is also possible to have loops in the address ancestry/duplication graph,
605 for example if there are two top level addresses A and B and we have A->B,C and
606 B->A. To break the loop, we use a list of processed addresses in the dlist
609 After handling duplication, this function outputs the progenitor of the given
613 p the address we are interested in
614 pplist address of anchor of the list of addresses not to output
615 pdlist address of anchor of the list of processed addresses
616 first TRUE if this is the first address; set it FALSE afterwards
617 tctx transport context - processing to be done during output
618 and the file descriptor to write to
620 Returns: FALSE if writing failed
624 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
625 BOOL *first, transport_ctx * tctx)
630 /* Do nothing if we have already handled this address. If not, remember it
631 so that we don't handle it again. */
633 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
635 ppp = store_get(sizeof(struct aci));
640 /* Now scan up the ancestry, checking for duplicates at each generation. */
642 for (pp = p;; pp = pp->parent)
645 for (dup = addr_duplicate; dup; dup = dup->next)
646 if (dup->dupof == pp) /* a dup of our address */
647 if (!write_env_to(dup, pplist, pdlist, first, tctx))
649 if (!pp->parent) break;
652 /* Check to see if we have already output the progenitor. */
654 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
655 if (ppp) return TRUE;
657 /* Remember what we have output, and output it. */
659 ppp = store_get(sizeof(struct aci));
664 if (!*first && !write_chunk(tctx, US",\n ", 3)) return FALSE;
666 return write_chunk(tctx, pp->address, Ustrlen(pp->address));
672 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
678 addr (chain of) addresses (for extra headers), or NULL;
679 only the first address is used
680 tctx transport context
681 sendfn function for output (transport or verify)
683 Returns: TRUE on success; FALSE on failure.
686 transport_headers_send(transport_ctx * tctx,
687 BOOL (*sendfn)(transport_ctx * tctx, uschar * s, int len))
691 transport_instance * tblock = tctx ? tctx->tblock : NULL;
692 address_item * addr = tctx ? tctx->addr : NULL;
694 /* Then the message's headers. Don't write any that are flagged as "old";
695 that means they were rewritten, or are a record of envelope rewriting, or
696 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
697 match any entries therein. It is a colon-sep list; expand the items
698 separately and squash any empty ones.
699 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
701 for (h = header_list; h; h = h->next) if (h->type != htype_old)
704 BOOL include_header = TRUE;
706 list = tblock ? tblock->remove_headers : NULL;
707 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
711 int sep = ':'; /* This is specified as a colon-separated list */
713 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
718 if (!(s = expand_string(s)) && !expand_string_forcedfail)
720 errno = ERRNO_CHHEADER_FAIL;
723 len = s ? Ustrlen(s) : 0;
724 if (strncmpic(h->text, s, len) != 0) continue;
726 while (*ss == ' ' || *ss == '\t') ss++;
727 if (*ss == ':') break;
729 if (s) { include_header = FALSE; break; }
731 if (addr) list = addr->prop.remove_headers;
734 /* If this header is to be output, try to rewrite it if there are rewriting
739 if (tblock && tblock->rewrite_rules)
741 void *reset_point = store_get(0);
744 if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
745 tblock->rewrite_existflags, FALSE)))
747 if (!sendfn(tctx, hh->text, hh->slen)) return FALSE;
748 store_reset(reset_point);
749 continue; /* With the next header line */
753 /* Either no rewriting rules, or it didn't get rewritten */
755 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
761 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
764 /* Add on any address-specific headers. If there are multiple addresses,
765 they will all have the same headers in order to be batched. The headers
766 are chained in reverse order of adding (so several addresses from the
767 same alias might share some of them) but we want to output them in the
768 opposite order. This is a bit tedious, but there shouldn't be very many
769 of them. We just walk the list twice, reversing the pointers each time,
770 but on the second time, write out the items.
772 Headers added to an address by a router are guaranteed to end with a newline.
778 header_line *hprev = addr->prop.extra_headers;
780 for (i = 0; i < 2; i++)
781 for (h = hprev, hprev = NULL; h; h = hnext)
788 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
790 debug_printf("added header line(s):\n%s---\n", h->text);
795 /* If a string containing additional headers exists it is a newline-sep
796 list. Expand each item and write out the result. This is done last so that
797 if it (deliberately or accidentally) isn't in header format, it won't mess
798 up any other headers. An empty string or a forced expansion failure are
799 noops. An added header string from a transport may not end with a newline;
800 add one if it does not. */
802 if (tblock && (list = CUS tblock->add_headers))
807 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
808 if ((s = expand_string(s)))
810 int len = Ustrlen(s);
813 if (!sendfn(tctx, s, len)) return FALSE;
814 if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
818 debug_printf("added header line:\n%s", s);
819 if (s[len-1] != '\n') debug_printf("\n");
820 debug_printf("---\n");
824 else if (!expand_string_forcedfail)
825 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
828 /* Separate headers from body with a blank line */
830 return sendfn(tctx, US"\n", 1);
834 /*************************************************
835 * Write the message *
836 *************************************************/
838 /* This function writes the message to the given file descriptor. The headers
839 are in the in-store data structure, and the rest of the message is in the open
840 file descriptor deliver_datafile. Make sure we start it at the beginning.
842 . If add_return_path is TRUE, a "return-path:" header is added to the message,
843 containing the envelope sender's address.
845 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
846 giving the top-level envelope address that caused this delivery to happen.
848 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
849 message. It gives the time and date that delivery took place.
851 . If check_string is not null, the start of each line is checked for that
852 string. If it is found, it is replaced by escape_string. This used to be
853 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
855 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
857 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
858 any writing or reading error, leaving the code in errno intact. Error exits
859 can include timeouts for certain transports, which are requested by setting
860 transport_write_timeout non-zero.
864 (fd, msg) Either and fd, to write the message to,
865 or a string: if null write message to allocated space
866 otherwire take content as headers.
867 addr (chain of) addresses (for extra headers), or NULL;
868 only the first address is used
869 tblock optional transport instance block (NULL signifies NULL/0):
870 add_headers a string containing one or more headers to add; it is
871 expanded, and must be in correct RFC 822 format as
872 it is transmitted verbatim; NULL => no additions,
873 and so does empty string or forced expansion fail
874 remove_headers a colon-separated list of headers to remove, or NULL
875 rewrite_rules chain of header rewriting rules
876 rewrite_existflags flags for the rewriting rules
877 options bit-wise options:
878 add_return_path if TRUE, add a "return-path" header
879 add_envelope_to if TRUE, add a "envelope-to" header
880 add_delivery_date if TRUE, add a "delivery-date" header
881 use_crlf if TRUE, turn NL into CR LF
882 end_dot if TRUE, send a terminating "." line at the end
883 no_headers if TRUE, omit the headers
884 no_body if TRUE, omit the body
885 check_string a string to check for at the start of lines, or NULL
886 escape_string a string to insert in front of any check string
887 size_limit if > 0, this is a limit to the size of message written;
888 it is used when returning messages to their senders,
889 and is approximate rather than exact, owing to chunk
892 Returns: TRUE on success; FALSE (with errno) on failure.
893 In addition, the global variable transport_count
894 is incremented by the number of bytes written.
898 internal_transport_write_message(transport_ctx * tctx, int size_limit)
902 /* Initialize pointer in output buffer. */
904 transport_write_reset(tctx->options);
906 /* Set up the data for start-of-line data checking and escaping */
908 if (tctx->check_string && tctx->escape_string)
910 nl_check = tctx->check_string;
911 nl_check_length = Ustrlen(nl_check);
912 nl_escape = tctx->escape_string;
913 nl_escape_length = Ustrlen(nl_escape);
916 /* Whether the escaping mechanism is applied to headers or not is controlled by
917 an option (set for SMTP, not otherwise). Negate the length if not wanted till
918 after the headers. */
920 if (!(tctx->options & topt_escape_headers))
921 nl_check_length = -nl_check_length;
923 /* Write the headers if required, including any that have to be added. If there
924 are header rewriting rules, apply them. The datasource is not the -D spoolfile
925 so temporarily hide the global that adjusts for its format. */
927 if (!(tctx->options & topt_no_headers))
929 BOOL save_wireformat = spool_file_wireformat;
930 spool_file_wireformat = FALSE;
932 /* Add return-path: if requested. */
934 if (tctx->options & topt_add_return_path)
936 uschar buffer[ADDRESS_MAXLENGTH + 20];
937 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
939 if (!write_chunk(tctx, buffer, n)) goto bad;
942 /* Add envelope-to: if requested */
944 if (tctx->options & topt_add_envelope_to)
948 struct aci *plist = NULL;
949 struct aci *dlist = NULL;
950 void *reset_point = store_get(0);
952 if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
954 /* Pick up from all the addresses. The plist and dlist variables are
955 anchors for lists of addresses already handled; they have to be defined at
956 this level because write_env_to() calls itself recursively. */
958 for (p = tctx->addr; p; p = p->next)
959 if (!write_env_to(p, &plist, &dlist, &first, tctx)) goto bad;
961 /* Add a final newline and reset the store used for tracking duplicates */
963 if (!write_chunk(tctx, US"\n", 1)) goto bad;
964 store_reset(reset_point);
967 /* Add delivery-date: if requested. */
969 if (tctx->options & topt_add_delivery_date)
972 int n = sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
973 if (!write_chunk(tctx, buffer, n)) goto bad;
976 /* Then the message's headers. Don't write any that are flagged as "old";
977 that means they were rewritten, or are a record of envelope rewriting, or
978 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
979 match any entries therein. Then check addr->prop.remove_headers too, provided that
982 if (!transport_headers_send(tctx, &write_chunk))
985 spool_file_wireformat = save_wireformat;
989 spool_file_wireformat = save_wireformat;
992 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
993 last-BDAT, consisting of the current write_chunk() output buffer fill
994 (optimally, all of the headers - but it does not matter if we already had to
995 flush that buffer with non-last BDAT prependix) plus the amount of body data
996 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
997 that further use of write_chunk() will not prepend BDATs.
998 The first BDAT written will also first flush any outstanding MAIL and RCPT
999 commands which were buffered thans to PIPELINING.
1000 Commands go out (using a send()) from a different buffer to data (using a
1001 write()). They might not end up in the same TCP segment, which is
1004 if (tctx->options & topt_use_bdat)
1009 if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1011 if (!(tctx->options & topt_no_body))
1013 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1014 fsize -= SPOOL_DATA_START_OFFSET;
1015 if (size_limit > 0 && fsize > size_limit)
1017 size = hsize + fsize;
1018 if (tctx->options & topt_use_crlf && !spool_file_wireformat)
1019 size += body_linecount; /* account for CRLF-expansion */
1021 /* With topt_use_bdat we never do dot-stuffing; no need to
1022 account for any expansion due to that. */
1025 /* If the message is large, emit first a non-LAST chunk with just the
1026 headers, and reap the command responses. This lets us error out early
1027 on RCPT rejects rather than sending megabytes of data. Include headers
1028 on the assumption they are cheap enough and some clever implementations
1029 might errorcheck them too, on-the-fly, and reject that chunk. */
1031 if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1034 debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1035 if ( tctx->chunk_cb(tctx, hsize, 0) != OK
1036 || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1037 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1040 chunk_ptr = deliver_out_buffer;
1044 /* Emit a LAST datachunk command, and unmark the context for further
1047 if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1049 tctx->options &= ~topt_use_bdat;
1052 /* If the body is required, ensure that the data for check strings (formerly
1053 the "from hack") is enabled by negating the length if necessary. (It will be
1054 negative in cases where it isn't to apply to the headers). Then ensure the body
1055 is positioned at the start of its file (following the message id), then write
1056 it, applying the size limit if required. */
1058 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1059 and we want to send a body without dotstuffing or ending-dot, in-clear,
1060 then we can just dump it using sendfile.
1061 This should get used for CHUNKING output and also for writing the -K file for
1062 dkim signing, when we had CHUNKING input. */
1065 if ( spool_file_wireformat
1066 && !(tctx->options & (topt_no_body | topt_end_dot))
1068 && tls_out.active != tctx->u.fd
1072 off_t offset = SPOOL_DATA_START_OFFSET;
1074 /* Write out any header data in the buffer */
1076 if ((len = chunk_ptr - deliver_out_buffer) > 0)
1078 if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1083 DEBUG(D_transport) debug_printf("using sendfile for body\n");
1087 if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1093 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1097 if (!(tctx->options & topt_no_body))
1098 debug_printf("cannot use sendfile for body: %s\n",
1099 !spool_file_wireformat ? "spoolfile not wireformat"
1100 : tctx->options & topt_end_dot ? "terminating dot wanted"
1101 : nl_check_length ? "dot- or From-stuffing wanted"
1102 : "TLS output wanted");
1104 if (!(tctx->options & topt_no_body))
1106 int size = size_limit;
1108 nl_check_length = abs(nl_check_length);
1109 nl_partial_match = 0;
1110 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
1112 while ( (len = MAX(DELIVER_IN_BUFFER_SIZE, size)) > 0
1113 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1115 if (!write_chunk(tctx, deliver_in_buffer, len))
1120 /* A read error on the body will have left len == -1 and errno set. */
1122 if (len != 0) return FALSE;
1125 /* Finished with the check string */
1127 nl_check_length = nl_escape_length = 0;
1129 /* If requested, add a terminating "." line (SMTP output). */
1131 if (tctx->options & topt_end_dot && !write_chunk(tctx, US".\n", 2))
1134 /* Write out any remaining data in the buffer before returning. */
1136 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1137 transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1143 /*************************************************
1144 * External interface to write the message *
1145 *************************************************/
1147 /* If there is no filtering required, call the internal function above to do
1148 the real work, passing over all the arguments from this function. Otherwise,
1149 set up a filtering process, fork another process to call the internal function
1150 to write to the filter, and in this process just suck from the filter and write
1151 down the fd in the transport context. At the end, tidy up the pipes and the
1154 Arguments: as for internal_transport_write_message() above
1156 Returns: TRUE on success; FALSE (with errno) for any failure
1157 transport_count is incremented by the number of bytes written
1161 transport_write_message(transport_ctx * tctx, int size_limit)
1163 BOOL last_filter_was_NL = TRUE;
1164 BOOL save_spool_file_wireformat = spool_file_wireformat;
1165 int rc, len, yield, fd_read, fd_write, save_errno;
1166 int pfd[2] = {-1, -1};
1167 pid_t filter_pid, write_pid;
1168 static transport_ctx dummy_tctx = {0};
1170 transport_filter_timed_out = FALSE;
1172 /* If there is no filter command set up, call the internal function that does
1173 the actual work, passing it the incoming fd, and return its result. */
1175 if ( !transport_filter_argv
1176 || !*transport_filter_argv
1177 || !**transport_filter_argv
1179 return internal_transport_write_message(tctx, size_limit);
1181 /* Otherwise the message must be written to a filter process and read back
1182 before being written to the incoming fd. First set up the special processing to
1183 be done during the copying. */
1185 nl_partial_match = -1;
1187 if (tctx->check_string && tctx->escape_string)
1189 nl_check = tctx->check_string;
1190 nl_check_length = Ustrlen(nl_check);
1191 nl_escape = tctx->escape_string;
1192 nl_escape_length = Ustrlen(nl_escape);
1194 else nl_check_length = nl_escape_length = 0;
1196 /* Start up a subprocess to run the command. Ensure that our main fd will
1197 be closed when the subprocess execs, but remove the flag afterwards.
1198 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1199 process to deliver another message.) We get back stdin/stdout file descriptors.
1200 If the process creation failed, give an error return. */
1206 write_pid = (pid_t)(-1);
1209 int bits = fcntl(tctx->u.fd, F_GETFD);
1210 (void)fcntl(tctx->u.fd, F_SETFD, bits | FD_CLOEXEC);
1211 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1212 &fd_write, &fd_read, FALSE);
1213 (void)fcntl(tctx->u.fd, F_SETFD, bits & ~FD_CLOEXEC);
1215 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1218 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1219 (int)filter_pid, fd_write, fd_read);
1221 /* Fork subprocess to write the message to the filter, and return the result
1222 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1223 smtp dots, or check string processing. */
1225 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1226 if ((write_pid = fork()) == 0)
1229 (void)close(fd_read);
1230 (void)close(pfd[pipe_read]);
1231 nl_check_length = nl_escape_length = 0;
1233 tctx->u.fd = fd_write;
1234 tctx->check_string = tctx->escape_string = NULL;
1235 tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat);
1237 rc = internal_transport_write_message(tctx, size_limit);
1240 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1242 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1244 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1247 rc = FALSE; /* compiler quietening */
1252 /* Parent process: close our copy of the writing subprocess' pipes. */
1254 (void)close(pfd[pipe_write]);
1255 (void)close(fd_write);
1258 /* Writing process creation failed */
1262 errno = save_errno; /* restore */
1266 /* When testing, let the subprocess get going */
1268 if (running_in_test_harness) millisleep(250);
1271 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1273 /* Copy the message from the filter to the output fd. A read error leaves len
1274 == -1 and errno set. We need to apply a timeout to the read, to cope with
1275 the case when the filter gets stuck, but it can be quite a long one. The
1276 default is 5m, but this is now configurable. */
1278 DEBUG(D_transport) debug_printf("copying from the filter\n");
1280 /* Copy the output of the filter, remembering if the last character was NL. If
1281 no data is returned, that counts as "ended with NL" (default setting of the
1282 variable is TRUE). The output should always be unix-format as we converted
1283 any wireformat source on writing input to the filter. */
1285 spool_file_wireformat = FALSE;
1286 chunk_ptr = deliver_out_buffer;
1290 sigalrm_seen = FALSE;
1291 alarm(transport_filter_timeout);
1292 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1297 transport_filter_timed_out = TRUE;
1301 /* If the read was successful, write the block down the original fd,
1302 remembering whether it ends in \n or not. */
1306 if (!write_chunk(tctx, deliver_in_buffer, len)) goto TIDY_UP;
1307 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1310 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1314 if (len == 0) yield = TRUE;
1319 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1320 to something. Ensure the pipes are all closed and the processes are removed. If
1321 there has been an error, kill the processes before waiting for them, just to be
1322 sure. Also apply a paranoia timeout. */
1325 spool_file_wireformat = save_spool_file_wireformat;
1328 (void)close(fd_read);
1329 if (fd_write > 0) (void)close(fd_write);
1333 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1334 if (write_pid > 0) kill(write_pid, SIGKILL);
1337 /* Wait for the filter process to complete. */
1339 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1340 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1343 save_errno = ERRNO_FILTER_FAIL;
1344 tctx->addr->more_errno = rc;
1345 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1348 /* Wait for the writing process to complete. If it ends successfully,
1349 read the results from its pipe, provided we haven't already had a filter
1352 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1355 rc = child_close(write_pid, 30);
1360 if (read(pfd[pipe_read], (void *)&ok, sizeof(BOOL)) != sizeof(BOOL))
1363 debug_printf("pipe read from writing process: %s\n", strerror(errno));
1364 save_errno = ERRNO_FILTER_FAIL;
1369 int dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1370 dummy = read(pfd[pipe_read], (void *)&(tctx->addr->more_errno), sizeof(int));
1377 save_errno = ERRNO_FILTER_FAIL;
1378 tctx->addr->more_errno = rc;
1379 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1382 (void)close(pfd[pipe_read]);
1384 /* If there have been no problems we can now add the terminating "." if this is
1385 SMTP output, turning off escaping beforehand. If the last character from the
1386 filter was not NL, insert a NL to make the SMTP protocol work. */
1390 nl_check_length = nl_escape_length = 0;
1391 if ( tctx->options & topt_end_dot
1392 && ( last_filter_was_NL
1393 ? !write_chunk(tctx, US".\n", 2)
1394 : !write_chunk(tctx, US"\n.\n", 3)
1398 /* Write out any remaining data in the buffer. */
1401 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1402 || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1405 errno = save_errno; /* From some earlier error */
1409 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1411 debug_printf("errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1421 /*************************************************
1422 * Update waiting database *
1423 *************************************************/
1425 /* This is called when an address is deferred by remote transports that are
1426 capable of sending more than one message over one connection. A database is
1427 maintained for each transport, keeping track of which messages are waiting for
1428 which hosts. The transport can then consult this when eventually a successful
1429 delivery happens, and if it finds that another message is waiting for the same
1430 host, it can fire up a new process to deal with it using the same connection.
1432 The database records are keyed by host name. They can get full if there are
1433 lots of messages waiting, and so there is a continuation mechanism for them.
1435 Each record contains a list of message ids, packed end to end without any
1436 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1437 in this record, and the sequence field says if there are any other records for
1438 this host. If the sequence field is 0, there are none. If it is 1, then another
1439 record with the name <hostname>:0 exists; if it is 2, then two other records
1440 with sequence numbers 0 and 1 exist, and so on.
1442 Currently, an exhaustive search of all continuation records has to be done to
1443 determine whether to add a message id to a given record. This shouldn't be
1444 too bad except in extreme cases. I can't figure out a *simple* way of doing
1447 Old records should eventually get swept up by the exim_tidydb utility.
1450 hostlist list of hosts that this message could be sent to
1451 tpname name of the transport
1457 transport_update_waiting(host_item *hostlist, uschar *tpname)
1459 const uschar *prevname = US"";
1464 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1466 /* Open the database for this transport */
1468 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", tpname),
1469 O_RDWR, &dbblock, TRUE)))
1472 /* Scan the list of hosts for which this message is waiting, and ensure
1473 that the message id is in each host record. */
1475 for (host = hostlist; host; host = host->next)
1477 BOOL already = FALSE;
1478 dbdata_wait *host_record;
1483 /* Skip if this is the same host as we just processed; otherwise remember
1484 the name for next time. */
1486 if (Ustrcmp(prevname, host->name) == 0) continue;
1487 prevname = host->name;
1489 /* Look up the host record; if there isn't one, make an empty one. */
1491 if (!(host_record = dbfn_read(dbm_file, host->name)))
1493 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1494 host_record->count = host_record->sequence = 0;
1497 /* Compute the current length */
1499 host_length = host_record->count * MESSAGE_ID_LENGTH;
1501 /* Search the record to see if the current message is already in it. */
1503 for (s = host_record->text; s < host_record->text + host_length;
1504 s += MESSAGE_ID_LENGTH)
1505 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1506 { already = TRUE; break; }
1508 /* If we haven't found this message in the main record, search any
1509 continuation records that exist. */
1511 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1514 sprintf(CS buffer, "%.200s:%d", host->name, i);
1515 if ((cont = dbfn_read(dbm_file, buffer)))
1517 int clen = cont->count * MESSAGE_ID_LENGTH;
1518 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1519 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1520 { already = TRUE; break; }
1524 /* If this message is already in a record, no need to update. */
1528 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1533 /* If this record is full, write it out with a new name constructed
1534 from the sequence number, increase the sequence number, and empty
1537 if (host_record->count >= WAIT_NAME_MAX)
1539 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1540 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1541 host_record->sequence++;
1542 host_record->count = 0;
1546 /* If this record is not full, increase the size of the record to
1547 allow for one new message id. */
1552 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1553 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1557 /* Now add the new name on the end */
1559 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1560 host_record->count++;
1561 host_length += MESSAGE_ID_LENGTH;
1563 /* Update the database */
1565 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1566 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1571 dbfn_close(dbm_file);
1577 /*************************************************
1578 * Test for waiting messages *
1579 *************************************************/
1581 /* This function is called by a remote transport which uses the previous
1582 function to remember which messages are waiting for which remote hosts. It's
1583 called after a successful delivery and its job is to check whether there is
1584 another message waiting for the same host. However, it doesn't do this if the
1585 current continue sequence is greater than the maximum supplied as an argument,
1586 or greater than the global connection_max_messages, which, if set, overrides.
1589 transport_name name of the transport
1590 hostname name of the host
1591 local_message_max maximum number of messages down one connection
1592 as set by the caller transport
1593 new_message_id set to the message id of a waiting message
1594 more set TRUE if there are yet more messages waiting
1595 oicf_func function to call to validate if it is ok to send
1596 to this message_id from the current instance.
1597 oicf_data opaque data for oicf_func
1599 Returns: TRUE if new_message_id set; FALSE otherwise
1602 typedef struct msgq_s
1604 uschar message_id [MESSAGE_ID_LENGTH + 1];
1609 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1610 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1612 dbdata_wait *host_record;
1618 struct stat statbuf;
1624 debug_printf("transport_check_waiting entered\n");
1625 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1626 continue_sequence, local_message_max, connection_max_messages);
1629 /* Do nothing if we have hit the maximum number that can be send down one
1632 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1633 if (local_message_max > 0 && continue_sequence >= local_message_max)
1636 debug_printf("max messages for one connection reached: returning\n");
1640 /* Open the waiting information database. */
1642 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1643 O_RDWR, &dbblock, TRUE)))
1646 /* See if there is a record for this host; if not, there's nothing to do. */
1648 if (!(host_record = dbfn_read(dbm_file, hostname)))
1650 dbfn_close(dbm_file);
1651 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1655 /* If the data in the record looks corrupt, just log something and
1656 don't try to use it. */
1658 if (host_record->count > WAIT_NAME_MAX)
1660 dbfn_close(dbm_file);
1661 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1662 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1666 /* Scan the message ids in the record from the end towards the beginning,
1667 until one is found for which a spool file actually exists. If the record gets
1668 emptied, delete it and continue with any continuation records that may exist.
1671 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1672 but the 1 off will remain without it. This code now allows me to SKIP over
1673 a message I do not want to send out on this run. */
1675 host_length = host_record->count * MESSAGE_ID_LENGTH;
1681 int msgq_actual = 0;
1682 BOOL bFound = FALSE;
1683 BOOL bContinuation = FALSE;
1685 /* create an array to read entire message queue into memory for processing */
1687 msgq = store_malloc(sizeof(msgq_t) * host_record->count);
1688 msgq_count = host_record->count;
1689 msgq_actual = msgq_count;
1691 for (i = 0; i < host_record->count; ++i)
1693 msgq[i].bKeep = TRUE;
1695 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1697 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1700 /* first thing remove current message id if it exists */
1702 for (i = 0; i < msgq_count; ++i)
1703 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1705 msgq[i].bKeep = FALSE;
1709 /* now find the next acceptable message_id */
1711 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1715 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1718 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1720 msgq[i].bKeep = FALSE;
1721 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1723 Ustrcpy(new_message_id, msgq[i].message_id);
1724 msgq[i].bKeep = FALSE;
1731 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1735 /* reassemble the host record, based on removed message ids, from in
1738 if (msgq_actual <= 0)
1741 host_record->count = 0;
1745 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1746 host_record->count = msgq_actual;
1748 if (msgq_actual < msgq_count)
1751 for (new_count = 0, i = 0; i < msgq_count; ++i)
1753 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1754 msgq[i].message_id, MESSAGE_ID_LENGTH);
1756 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1760 /* Check for a continuation record. */
1762 while (host_length <= 0)
1765 dbdata_wait * newr = NULL;
1768 /* Search for a continuation */
1770 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1772 sprintf(CS buffer, "%.200s:%d", hostname, i);
1773 newr = dbfn_read(dbm_file, buffer);
1776 /* If no continuation, delete the current and break the loop */
1780 dbfn_delete(dbm_file, hostname);
1784 /* Else replace the current with the continuation */
1786 dbfn_delete(dbm_file, buffer);
1788 host_length = host_record->count * MESSAGE_ID_LENGTH;
1790 bContinuation = TRUE;
1793 if (bFound) /* Usual exit from main loop */
1799 /* If host_length <= 0 we have emptied a record and not found a good message,
1800 and there are no continuation records. Otherwise there is a continuation
1801 record to process. */
1803 if (host_length <= 0)
1805 dbfn_close(dbm_file);
1806 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1810 /* we were not able to find an acceptable message, nor was there a
1811 * continuation record. So bug out, outer logic will clean this up.
1816 Ustrcpy(new_message_id, message_id);
1817 dbfn_close(dbm_file);
1822 } /* we need to process a continuation record */
1824 /* Control gets here when an existing message has been encountered; its
1825 id is in new_message_id, and host_length is the revised length of the
1826 host record. If it is zero, the record has been removed. Update the
1827 record if required, close the database, and return TRUE. */
1829 if (host_length > 0)
1831 host_record->count = host_length/MESSAGE_ID_LENGTH;
1833 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1837 dbfn_close(dbm_file);
1841 /*************************************************
1842 * Deliver waiting message down same socket *
1843 *************************************************/
1845 /* Just the regain-root-privilege exec portion */
1847 transport_do_pass_socket(const uschar *transport_name, const uschar *hostname,
1848 const uschar *hostaddress, uschar *id, int socket_fd)
1851 const uschar **argv;
1853 /* Set up the calling arguments; use the standard function for the basics,
1854 but we have a number of extras that may be added. */
1856 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1858 if (smtp_authenticated) argv[i++] = US"-MCA";
1859 if (smtp_peer_options & PEER_OFFERED_CHUNKING) argv[i++] = US"-MCK";
1860 if (smtp_peer_options & PEER_OFFERED_DSN) argv[i++] = US"-MCD";
1861 if (smtp_peer_options & PEER_OFFERED_PIPE) argv[i++] = US"-MCP";
1862 if (smtp_peer_options & PEER_OFFERED_SIZE) argv[i++] = US"-MCS";
1864 if (smtp_peer_options & PEER_OFFERED_TLS)
1865 if (tls_out.active >= 0 || continue_proxy_cipher)
1867 argv[i++] = US"-MCt";
1868 argv[i++] = sending_ip_address;
1869 argv[i++] = string_sprintf("%d", sending_port);
1870 argv[i++] = tls_out.active >= 0 ? tls_out.cipher : continue_proxy_cipher;
1873 argv[i++] = US"-MCT";
1876 if (queue_run_pid != (pid_t)0)
1878 argv[i++] = US"-MCQ";
1879 argv[i++] = string_sprintf("%d", queue_run_pid);
1880 argv[i++] = string_sprintf("%d", queue_run_pipe);
1883 argv[i++] = US"-MC";
1884 argv[i++] = US transport_name;
1885 argv[i++] = US hostname;
1886 argv[i++] = US hostaddress;
1887 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1891 /* Arrange for the channel to be on stdin. */
1895 (void)dup2(socket_fd, 0);
1896 (void)close(socket_fd);
1899 DEBUG(D_exec) debug_print_argv(argv);
1900 exim_nullstd(); /* Ensure std{out,err} exist */
1901 execv(CS argv[0], (char *const *)argv);
1903 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1904 _exit(errno); /* Note: must be _exit(), NOT exit() */
1909 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1910 get a clean delivery process, and to regain root privilege in cases where it
1911 has been given away.
1914 transport_name to pass to the new process
1917 id the new message to process
1918 socket_fd the connected socket
1920 Returns: FALSE if fork fails; TRUE otherwise
1924 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1925 const uschar *hostaddress, uschar *id, int socket_fd)
1930 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1932 if ((pid = fork()) == 0)
1934 /* Disconnect entirely from the parent process. If we are running in the
1935 test harness, wait for a bit to allow the previous process time to finish,
1936 write the log, etc., so that the output is always in the same order for
1937 automatic comparison. */
1939 if ((pid = fork()) != 0)
1941 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (final-pid %d)\n", pid);
1942 _exit(EXIT_SUCCESS);
1944 if (running_in_test_harness) sleep(1);
1946 transport_do_pass_socket(transport_name, hostname, hostaddress,
1950 /* If the process creation succeeded, wait for the first-level child, which
1951 immediately exits, leaving the second level process entirely disconnected from
1957 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1958 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (inter-pid %d)\n", pid);
1963 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1971 /*************************************************
1972 * Set up direct (non-shell) command *
1973 *************************************************/
1975 /* This function is called when a command line is to be parsed and executed
1976 directly, without the use of /bin/sh. It is called by the pipe transport,
1977 the queryprogram router, and also from the main delivery code when setting up a
1978 transport filter process. The code for ETRN also makes use of this; in that
1979 case, no addresses are passed.
1982 argvptr pointer to anchor for argv vector
1983 cmd points to the command string (modified IN PLACE)
1984 expand_arguments true if expansion is to occur
1985 expand_failed error value to set if expansion fails; not relevant if
1987 addr chain of addresses, or NULL
1988 etext text for use in error messages
1989 errptr where to put error message if addr is NULL;
1990 otherwise it is put in the first address
1992 Returns: TRUE if all went well; otherwise an error will be
1993 set in the first address and FALSE returned
1997 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
1998 BOOL expand_arguments, int expand_failed, address_item *addr,
1999 uschar *etext, uschar **errptr)
2002 const uschar **argv;
2004 int address_count = 0;
2008 /* Get store in which to build an argument list. Count the number of addresses
2009 supplied, and allow for that many arguments, plus an additional 60, which
2010 should be enough for anybody. Multiple addresses happen only when the local
2011 delivery batch option is set. */
2013 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2014 max_args = address_count + 60;
2015 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2017 /* Split the command up into arguments terminated by white space. Lose
2018 trailing space at the start and end. Double-quoted arguments can contain \\ and
2019 \" escapes and so can be handled by the standard function; single-quoted
2020 arguments are verbatim. Copy each argument into a new string. */
2023 while (isspace(*s)) s++;
2025 while (*s != 0 && argcount < max_args)
2030 while (*ss != 0 && *ss != '\'') ss++;
2031 argv[argcount++] = ss = store_get(ss - s++);
2032 while (*s != 0 && *s != '\'') *ss++ = *s++;
2036 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2037 while (isspace(*s)) s++;
2040 argv[argcount] = (uschar *)0;
2042 /* If *s != 0 we have run out of argument slots. */
2046 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2050 addr->transport_return = FAIL;
2051 addr->message = msg;
2057 /* Expand each individual argument if required. Expansion happens for pipes set
2058 up in filter files and with directly-supplied commands. It does not happen if
2059 the pipe comes from a traditional .forward file. A failing expansion is a big
2060 disaster if the command came from Exim's configuration; if it came from a user
2061 it is just a normal failure. The expand_failed value is used as the error value
2062 to cater for these two cases.
2064 An argument consisting just of the text "$pipe_addresses" is treated specially.
2065 It is not passed to the general expansion function. Instead, it is replaced by
2066 a number of arguments, one for each address. This avoids problems with shell
2067 metacharacters and spaces in addresses.
2069 If the parent of the top address has an original part of "system-filter", this
2070 pipe was set up by the system filter, and we can permit the expansion of
2075 debug_printf("direct command:\n");
2076 for (i = 0; argv[i] != (uschar *)0; i++)
2077 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2080 if (expand_arguments)
2082 BOOL allow_dollar_recipients = addr != NULL &&
2083 addr->parent != NULL &&
2084 Ustrcmp(addr->parent->address, "system-filter") == 0;
2086 for (i = 0; argv[i] != (uschar *)0; i++)
2089 /* Handle special fudge for passing an address list */
2092 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2093 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2097 if (argcount + address_count - 1 > max_args)
2099 addr->transport_return = FAIL;
2100 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2101 "in %s", cmd, etext);
2105 additional = address_count - 1;
2107 memmove(argv + i + 1 + additional, argv + i + 1,
2108 (argcount - i)*sizeof(uschar *));
2110 for (ad = addr; ad != NULL; ad = ad->next) {
2111 argv[i++] = ad->address;
2115 /* Subtract one since we replace $pipe_addresses */
2120 /* Handle special case of $address_pipe when af_force_command is set */
2122 else if (addr != NULL && testflag(addr,af_force_command) &&
2123 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2124 Ustrcmp(argv[i], "${address_pipe}") == 0))
2127 int address_pipe_argcount = 0;
2128 int address_pipe_max_args;
2129 uschar **address_pipe_argv;
2131 /* We can never have more then the argv we will be loading into */
2132 address_pipe_max_args = max_args - argcount + 1;
2135 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2137 /* We allocate an additional for (uschar *)0 */
2138 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2140 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2141 s = expand_string(addr->local_part + 1);
2143 if (s == NULL || *s == '\0')
2145 addr->transport_return = FAIL;
2146 addr->message = string_sprintf("Expansion of \"%s\" "
2147 "from command \"%s\" in %s failed: %s",
2148 (addr->local_part + 1), cmd, etext, expand_string_message);
2152 while (isspace(*s)) s++; /* strip leading space */
2154 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2159 while (*ss != 0 && *ss != '\'') ss++;
2160 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2161 while (*s != 0 && *s != '\'') *ss++ = *s++;
2165 else address_pipe_argv[address_pipe_argcount++] =
2166 string_copy(string_dequote(CUSS &s));
2167 while (isspace(*s)) s++; /* strip space after arg */
2170 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2172 /* If *s != 0 we have run out of argument slots. */
2175 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2176 "\"%s\" in %s", addr->local_part + 1, etext);
2179 addr->transport_return = FAIL;
2180 addr->message = msg;
2186 /* address_pipe_argcount - 1
2187 * because we are replacing $address_pipe in the argument list
2188 * with the first thing it expands to */
2189 if (argcount + address_pipe_argcount - 1 > max_args)
2191 addr->transport_return = FAIL;
2192 addr->message = string_sprintf("Too many arguments to command "
2193 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2197 /* If we are not just able to replace the slot that contained
2198 * $address_pipe (address_pipe_argcount == 1)
2199 * We have to move the existing argv by address_pipe_argcount - 1
2200 * Visually if address_pipe_argcount == 2:
2201 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2202 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2204 if (address_pipe_argcount > 1)
2206 /* current position + additional args */
2207 argv + i + address_pipe_argcount,
2208 /* current position + 1 (for the (uschar *)0 at the end) */
2210 /* -1 for the (uschar *)0 at the end)*/
2211 (argcount - i)*sizeof(uschar *)
2214 /* Now we fill in the slots we just moved argv out of
2215 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2217 for (address_pipe_i = 0;
2218 address_pipe_argv[address_pipe_i] != (uschar *)0;
2221 argv[i++] = address_pipe_argv[address_pipe_i];
2225 /* Subtract one since we replace $address_pipe */
2230 /* Handle normal expansion string */
2234 const uschar *expanded_arg;
2235 enable_dollar_recipients = allow_dollar_recipients;
2236 expanded_arg = expand_cstring(argv[i]);
2237 enable_dollar_recipients = FALSE;
2239 if (expanded_arg == NULL)
2241 uschar *msg = string_sprintf("Expansion of \"%s\" "
2242 "from command \"%s\" in %s failed: %s",
2243 argv[i], cmd, etext, expand_string_message);
2246 addr->transport_return = expand_failed;
2247 addr->message = msg;
2252 argv[i] = expanded_arg;
2258 debug_printf("direct command after expansion:\n");
2259 for (i = 0; argv[i] != (uschar *)0; i++)
2260 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2269 /* End of transport.c */