1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* General functions concerned with transportation, and generic options for all
14 /* Generic options for transports, all of which live inside transport_instance
15 data blocks and which therefore have the opt_public flag set. Note that there
16 are other options living inside this structure which can be set only from
17 certain transports. */
19 optionlist optionlist_transports[] = {
21 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
22 (void *)offsetof(transport_instance, expand_gid) },
23 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
24 (void *)offsetof(transport_instance, expand_uid) },
25 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
26 (void *)offsetof(transport_instance, rewrite_existflags) },
27 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
28 (void *)offsetof(transport_instance, rewrite_rules) },
29 { "*set_group", opt_bool|opt_hidden|opt_public,
30 (void *)offsetof(transport_instance, gid_set) },
31 { "*set_user", opt_bool|opt_hidden|opt_public,
32 (void *)offsetof(transport_instance, uid_set) },
33 { "body_only", opt_bool|opt_public,
34 (void *)offsetof(transport_instance, body_only) },
35 { "current_directory", opt_stringptr|opt_public,
36 (void *)offsetof(transport_instance, current_dir) },
37 { "debug_print", opt_stringptr | opt_public,
38 (void *)offsetof(transport_instance, debug_string) },
39 { "delivery_date_add", opt_bool|opt_public,
40 (void *)(offsetof(transport_instance, delivery_date_add)) },
41 { "disable_logging", opt_bool|opt_public,
42 (void *)(offsetof(transport_instance, disable_logging)) },
43 { "driver", opt_stringptr|opt_public,
44 (void *)offsetof(transport_instance, driver_name) },
45 { "envelope_to_add", opt_bool|opt_public,
46 (void *)(offsetof(transport_instance, envelope_to_add)) },
48 { "event_action", opt_stringptr | opt_public,
49 (void *)offsetof(transport_instance, event_action) },
51 { "group", opt_expand_gid|opt_public,
52 (void *)offsetof(transport_instance, gid) },
53 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
54 (void *)offsetof(transport_instance, add_headers) },
55 { "headers_only", opt_bool|opt_public,
56 (void *)offsetof(transport_instance, headers_only) },
57 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
58 (void *)offsetof(transport_instance, remove_headers) },
59 { "headers_rewrite", opt_rewrite|opt_public,
60 (void *)offsetof(transport_instance, headers_rewrite) },
61 { "home_directory", opt_stringptr|opt_public,
62 (void *)offsetof(transport_instance, home_dir) },
63 { "initgroups", opt_bool|opt_public,
64 (void *)offsetof(transport_instance, initgroups) },
65 { "max_parallel", opt_stringptr|opt_public,
66 (void *)offsetof(transport_instance, max_parallel) },
67 { "message_size_limit", opt_stringptr|opt_public,
68 (void *)offsetof(transport_instance, message_size_limit) },
69 { "rcpt_include_affixes", opt_bool|opt_public,
70 (void *)offsetof(transport_instance, rcpt_include_affixes) },
71 { "retry_use_local_part", opt_bool|opt_public,
72 (void *)offsetof(transport_instance, retry_use_local_part) },
73 { "return_path", opt_stringptr|opt_public,
74 (void *)(offsetof(transport_instance, return_path)) },
75 { "return_path_add", opt_bool|opt_public,
76 (void *)(offsetof(transport_instance, return_path_add)) },
77 { "shadow_condition", opt_stringptr|opt_public,
78 (void *)offsetof(transport_instance, shadow_condition) },
79 { "shadow_transport", opt_stringptr|opt_public,
80 (void *)offsetof(transport_instance, shadow) },
81 { "transport_filter", opt_stringptr|opt_public,
82 (void *)offsetof(transport_instance, filter_command) },
83 { "transport_filter_timeout", opt_time|opt_public,
84 (void *)offsetof(transport_instance, filter_timeout) },
85 { "user", opt_expand_uid|opt_public,
86 (void *)offsetof(transport_instance, uid) }
89 int optionlist_transports_size = nelem(optionlist_transports);
93 # include "macro_predef.h"
96 options_transports(void)
100 options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
102 for (transport_info * ti = transports_available; ti->driver_name[0]; ti++)
104 spf(buf, sizeof(buf), US"_DRIVER_TRANSPORT_%T", ti->driver_name);
105 builtin_macro_create(buf);
106 options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
110 #else /*!MACRO_PREDEF*/
112 /* Structure for keeping list of addresses that have been added to
113 Envelope-To:, in order to avoid duplication. */
121 /* Static data for write_chunk() */
123 static uschar *chunk_ptr; /* chunk pointer */
124 static uschar *nl_check; /* string to look for at line start */
125 static int nl_check_length; /* length of same */
126 static uschar *nl_escape; /* string to insert */
127 static int nl_escape_length; /* length of same */
128 static int nl_partial_match; /* length matched at chunk end */
131 /*************************************************
132 * Initialize transport list *
133 *************************************************/
135 /* Read the transports section of the configuration file, and set up a chain of
136 transport instances according to its contents. Each transport has generic
137 options and may also have its own private options. This function is only ever
138 called when transports == NULL. We use generic code in readconf to do most of
144 readconf_driver_init(US"transport",
145 (driver_instance **)(&transports), /* chain anchor */
146 (driver_info *)transports_available, /* available drivers */
147 sizeof(transport_info), /* size of info block */
148 &transport_defaults, /* default values for generic options */
149 sizeof(transport_instance), /* size of instance block */
150 optionlist_transports, /* generic options */
151 optionlist_transports_size);
153 /* Now scan the configured transports and check inconsistencies. A shadow
154 transport is permitted only for local transports. */
156 for (transport_instance * t = transports; t; t = t->next)
158 if (!t->info->local && t->shadow)
159 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
160 "shadow transport not allowed on non-local transport %s", t->name);
162 if (t->body_only && t->headers_only)
163 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
164 "%s transport: body_only and headers_only are mutually exclusive",
171 /*************************************************
172 * Write block of data *
173 *************************************************/
175 /* Subroutine called by write_chunk() and at the end of the message actually
176 to write a data block. Also called directly by some transports to write
177 additional data to the file descriptor (e.g. prefix, suffix).
179 If a transport wants data transfers to be timed, it sets a non-zero value in
180 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
181 be set for each block of data written from here. If time runs out, then write()
182 fails and provokes an error return. The caller can then inspect sigalrm_seen to
185 On some systems, if a quota is exceeded during the write, the yield is the
186 number of bytes written rather than an immediate error code. This also happens
187 on some systems in other cases, for example a pipe that goes away because the
188 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
189 get the error codes the first time.
191 The write() function is also interruptible; the Solaris 2.6 man page says:
193 If write() is interrupted by a signal before it writes any
194 data, it will return -1 with errno set to EINTR.
196 If write() is interrupted by a signal after it successfully
197 writes some data, it will return the number of bytes written.
199 To handle these cases, we want to restart the write() to output the remainder
200 of the data after a non-negative return from write(), except after a timeout.
201 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
202 proper error then occurs. In principle, after an interruption, the second
203 write() could suffer the same fate, but we do not want to continue for
204 evermore, so stick a maximum repetition count on the loop to act as a
208 tctx transport context: file descriptor or string to write to
209 block block of bytes to write
210 len number of bytes to write
211 more further data expected soon
213 Returns: TRUE on success, FALSE on failure (with errno preserved);
214 transport_count is incremented by the number of bytes written
218 transport_write_block_fd(transport_ctx * tctx, uschar *block, int len, BOOL more)
221 int local_timeout = transport_write_timeout;
224 /* This loop is for handling incomplete writes and other retries. In most
225 normal cases, it is only ever executed once. */
227 for (int i = 0; i < 100; i++)
230 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
231 fd, len, local_timeout, more ? " (more expected)" : "");
233 /* This code makes use of alarm() in order to implement the timeout. This
234 isn't a very tidy way of doing things. Using non-blocking I/O with select()
235 provides a neater approach. However, I don't know how to do this when TLS is
238 if (transport_write_timeout <= 0) /* No timeout wanted */
242 tls_out.active.sock == fd ? tls_write(tls_out.active.tls_ctx, block, len, more) :
245 more && !(tctx->options & topt_not_socket)
246 ? send(fd, block, len, MSG_MORE) :
248 write(fd, block, len);
252 /* Timeout wanted. */
256 ALARM(local_timeout);
260 tls_out.active.sock == fd ? tls_write(tls_out.active.tls_ctx, block, len, more) :
263 more && !(tctx->options & topt_not_socket)
264 ? send(fd, block, len, MSG_MORE) :
266 write(fd, block, len);
269 local_timeout = ALARM_CLR(0);
277 /* Hopefully, the most common case is success, so test that first. */
279 if (rc == len) { transport_count += len; return TRUE; }
281 /* A non-negative return code is an incomplete write. Try again for the rest
282 of the block. If we have exactly hit the timeout, give up. */
288 transport_count += rc;
289 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
290 goto CHECK_TIMEOUT; /* A few lines below */
293 /* A negative return code with an EINTR error is another form of
294 incomplete write, zero bytes having been written */
296 if (save_errno == EINTR)
299 debug_printf("write interrupted before anything written\n");
300 goto CHECK_TIMEOUT; /* A few lines below */
303 /* A response of EAGAIN from write() is likely only in the case of writing
304 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
306 if (save_errno == EAGAIN)
309 debug_printf("write temporarily locked out, waiting 1 sec\n");
312 /* Before continuing to try another write, check that we haven't run out of
316 if (transport_write_timeout > 0 && local_timeout <= 0)
324 /* Otherwise there's been an error */
326 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
327 strerror(save_errno));
332 /* We've tried and tried and tried but still failed */
334 errno = ERRNO_WRITEINCOMPLETE;
340 transport_write_block(transport_ctx * tctx, uschar *block, int len, BOOL more)
342 if (!(tctx->options & topt_output_string))
343 return transport_write_block_fd(tctx, block, len, more);
345 /* Write to expanding-string. NOTE: not NUL-terminated */
348 tctx->u.msg = string_get(1024);
350 tctx->u.msg = string_catn(tctx->u.msg, block, len);
357 /*************************************************
358 * Write formatted string *
359 *************************************************/
361 /* This is called by various transports. It is a convenience function.
366 ... arguments for format
368 Returns: the yield of transport_write_block()
372 transport_write_string(int fd, const char *format, ...)
374 transport_ctx tctx = {{0}};
375 gstring gs = { .size = big_buffer_size, .ptr = 0, .s = big_buffer };
378 /* Use taint-unchecked routines for writing into big_buffer, trusting
379 that the result will never be expanded. */
381 va_start(ap, format);
382 if (!string_vformat(&gs, SVFMT_TAINT_NOCHK, format, ap))
383 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
386 return transport_write_block(&tctx, gs.s, gs.ptr, FALSE);
393 transport_write_reset(int options)
395 if (!(options & topt_continuation)) chunk_ptr = deliver_out_buffer;
396 nl_partial_match = -1;
397 nl_check_length = nl_escape_length = 0;
402 /*************************************************
403 * Write character chunk *
404 *************************************************/
406 /* Subroutine used by transport_write_message() to scan character chunks for
407 newlines and act appropriately. The object is to minimise the number of writes.
408 The output byte stream is buffered up in deliver_out_buffer, which is written
409 only when it gets full, thus minimizing write operations and TCP packets.
411 Static data is used to handle the case when the last character of the previous
412 chunk was NL, or matched part of the data that has to be escaped.
415 tctx transport context - processing to be done during output,
416 and file descriptor to write to
417 chunk pointer to data to write
418 len length of data to write
420 In addition, the static nl_xxx variables must be set as required.
422 Returns: TRUE on success, FALSE on failure (with errno preserved)
426 write_chunk(transport_ctx * tctx, uschar *chunk, int len)
428 uschar *start = chunk;
429 uschar *end = chunk + len;
430 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
432 /* The assumption is made that the check string will never stretch over move
433 than one chunk since the only time there are partial matches is when copying
434 the body in large buffers. There is always enough room in the buffer for an
435 escape string, since the loop below ensures this for each character it
436 processes, and it won't have stuck in the escape string if it left a partial
439 if (nl_partial_match >= 0)
441 if (nl_check_length > 0 && len >= nl_check_length &&
442 Ustrncmp(start, nl_check + nl_partial_match,
443 nl_check_length - nl_partial_match) == 0)
445 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
446 chunk_ptr += nl_escape_length;
447 start += nl_check_length - nl_partial_match;
450 /* The partial match was a false one. Insert the characters carried over
451 from the previous chunk. */
453 else if (nl_partial_match > 0)
455 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
456 chunk_ptr += nl_partial_match;
459 nl_partial_match = -1;
462 /* Now process the characters in the chunk. Whenever we hit a newline we check
463 for possible escaping. The code for the non-NL route should be as fast as
466 for (uschar * ptr = start; ptr < end; ptr++)
470 /* Flush the buffer if it has reached the threshold - we want to leave enough
471 room for the next uschar, plus a possible extra CR for an LF, plus the escape
474 if ((len = chunk_ptr - deliver_out_buffer) > mlen)
476 DEBUG(D_transport) debug_printf("flushing headers buffer\n");
478 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
479 from previous SMTP commands. */
481 if (tctx->options & topt_use_bdat && tctx->chunk_cb)
483 if ( tctx->chunk_cb(tctx, (unsigned)len, 0) != OK
484 || !transport_write_block(tctx, deliver_out_buffer, len, FALSE)
485 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
490 if (!transport_write_block(tctx, deliver_out_buffer, len, FALSE))
492 chunk_ptr = deliver_out_buffer;
495 /* Remove CR before NL if required */
497 if ( *ptr == '\r' && ptr[1] == '\n'
498 && !(tctx->options & topt_use_crlf)
499 && f.spool_file_wireformat
503 if ((ch = *ptr) == '\n')
505 int left = end - ptr - 1; /* count of chars left after NL */
507 /* Insert CR before NL if required */
509 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
512 transport_newlines++;
514 /* The check_string test (formerly "from hack") replaces the specific
515 string at the start of a line with an escape string (e.g. "From " becomes
516 ">From " or "." becomes "..". It is a case-sensitive test. The length
517 check above ensures there is always enough room to insert this string. */
519 if (nl_check_length > 0)
521 if (left >= nl_check_length &&
522 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
524 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
525 chunk_ptr += nl_escape_length;
526 ptr += nl_check_length;
529 /* Handle the case when there isn't enough left to match the whole
530 check string, but there may be a partial match. We remember how many
531 characters matched, and finish processing this chunk. */
533 else if (left <= 0) nl_partial_match = 0;
535 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
537 nl_partial_match = left;
543 /* Not a NL character */
545 else *chunk_ptr++ = ch;
554 /*************************************************
555 * Generate address for RCPT TO *
556 *************************************************/
558 /* This function puts together an address for RCPT to, using the caseful
559 version of the local part and the caseful version of the domain. If there is no
560 prefix or suffix, or if affixes are to be retained, we can just use the
561 original address. Otherwise, if there is a prefix but no suffix we can use a
562 pointer into the original address. If there is a suffix, however, we have to
566 addr the address item
567 include_affixes TRUE if affixes are to be included
573 transport_rcpt_address(address_item *addr, BOOL include_affixes)
580 setflag(addr, af_include_affixes); /* Affects logged => line */
581 return addr->address;
584 if (addr->suffix == NULL)
586 if (addr->prefix == NULL) return addr->address;
587 return addr->address + Ustrlen(addr->prefix);
590 at = Ustrrchr(addr->address, '@');
591 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
592 slen = Ustrlen(addr->suffix);
594 return string_sprintf("%.*s@%s", (int)(at - addr->address - plen - slen),
595 addr->address + plen, at + 1);
599 /*************************************************
600 * Output Envelope-To: address & scan duplicates *
601 *************************************************/
603 /* This function is called from internal_transport_write_message() below, when
604 generating an Envelope-To: header line. It checks for duplicates of the given
605 address and its ancestors. When one is found, this function calls itself
606 recursively, to output the envelope address of the duplicate.
608 We want to avoid duplication in the list, which can arise for example when
609 A->B,C and then both B and C alias to D. This can also happen when there are
610 unseen drivers in use. So a list of addresses that have been output is kept in
613 It is also possible to have loops in the address ancestry/duplication graph,
614 for example if there are two top level addresses A and B and we have A->B,C and
615 B->A. To break the loop, we use a list of processed addresses in the dlist
618 After handling duplication, this function outputs the progenitor of the given
622 p the address we are interested in
623 pplist address of anchor of the list of addresses not to output
624 pdlist address of anchor of the list of processed addresses
625 first TRUE if this is the first address; set it FALSE afterwards
626 tctx transport context - processing to be done during output
627 and the file descriptor to write to
629 Returns: FALSE if writing failed
633 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
634 BOOL *first, transport_ctx * tctx)
639 /* Do nothing if we have already handled this address. If not, remember it
640 so that we don't handle it again. */
642 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
644 ppp = store_get(sizeof(struct aci), FALSE);
649 /* Now scan up the ancestry, checking for duplicates at each generation. */
651 for (pp = p;; pp = pp->parent)
654 for (dup = addr_duplicate; dup; dup = dup->next)
655 if (dup->dupof == pp) /* a dup of our address */
656 if (!write_env_to(dup, pplist, pdlist, first, tctx))
658 if (!pp->parent) break;
661 /* Check to see if we have already output the progenitor. */
663 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
664 if (ppp) return TRUE;
666 /* Remember what we have output, and output it. */
668 ppp = store_get(sizeof(struct aci), FALSE);
673 if (!*first && !write_chunk(tctx, US",\n ", 3)) return FALSE;
675 return write_chunk(tctx, pp->address, Ustrlen(pp->address));
681 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
687 addr (chain of) addresses (for extra headers), or NULL;
688 only the first address is used
689 tctx transport context
690 sendfn function for output (transport or verify)
692 Returns: TRUE on success; FALSE on failure.
695 transport_headers_send(transport_ctx * tctx,
696 BOOL (*sendfn)(transport_ctx * tctx, uschar * s, int len))
699 transport_instance * tblock = tctx ? tctx->tblock : NULL;
700 address_item * addr = tctx ? tctx->addr : NULL;
702 /* Then the message's headers. Don't write any that are flagged as "old";
703 that means they were rewritten, or are a record of envelope rewriting, or
704 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
705 match any entries therein. It is a colon-sep list; expand the items
706 separately and squash any empty ones.
707 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
709 for (header_line * h = header_list; h; h = h->next) if (h->type != htype_old)
711 BOOL include_header = TRUE;
713 list = tblock ? tblock->remove_headers : NULL;
714 for (int i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
718 int sep = ':'; /* This is specified as a colon-separated list */
720 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
725 if (!(s = expand_string(s)) && !f.expand_string_forcedfail)
727 errno = ERRNO_CHHEADER_FAIL;
730 len = s ? Ustrlen(s) : 0;
731 if (strncmpic(h->text, s, len) != 0) continue;
733 while (*ss == ' ' || *ss == '\t') ss++;
734 if (*ss == ':') break;
736 if (s) { include_header = FALSE; break; }
738 if (addr) list = addr->prop.remove_headers;
741 /* If this header is to be output, try to rewrite it if there are rewriting
746 if (tblock && tblock->rewrite_rules)
748 rmark reset_point = store_mark();
751 if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
752 tblock->rewrite_existflags, FALSE)))
754 if (!sendfn(tctx, hh->text, hh->slen)) return FALSE;
755 store_reset(reset_point);
756 continue; /* With the next header line */
760 /* Either no rewriting rules, or it didn't get rewritten */
762 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
768 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
771 /* Add on any address-specific headers. If there are multiple addresses,
772 they will all have the same headers in order to be batched. The headers
773 are chained in reverse order of adding (so several addresses from the
774 same alias might share some of them) but we want to output them in the
775 opposite order. This is a bit tedious, but there shouldn't be very many
776 of them. We just walk the list twice, reversing the pointers each time,
777 but on the second time, write out the items.
779 Headers added to an address by a router are guaranteed to end with a newline.
784 header_line *hprev = addr->prop.extra_headers;
785 header_line *hnext, * h;
786 for (int i = 0; i < 2; i++)
787 for (h = hprev, hprev = NULL; h; h = hnext)
794 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
796 debug_printf("added header line(s):\n%s---\n", h->text);
801 /* If a string containing additional headers exists it is a newline-sep
802 list. Expand each item and write out the result. This is done last so that
803 if it (deliberately or accidentally) isn't in header format, it won't mess
804 up any other headers. An empty string or a forced expansion failure are
805 noops. An added header string from a transport may not end with a newline;
806 add one if it does not. */
808 if (tblock && (list = CUS tblock->add_headers))
813 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
814 if ((s = expand_string(s)))
816 int len = Ustrlen(s);
819 if (!sendfn(tctx, s, len)) return FALSE;
820 if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
824 debug_printf("added header line:\n%s", s);
825 if (s[len-1] != '\n') debug_printf("\n");
826 debug_printf("---\n");
830 else if (!f.expand_string_forcedfail)
831 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
834 /* Separate headers from body with a blank line */
836 return sendfn(tctx, US"\n", 1);
840 /*************************************************
841 * Write the message *
842 *************************************************/
844 /* This function writes the message to the given file descriptor. The headers
845 are in the in-store data structure, and the rest of the message is in the open
846 file descriptor deliver_datafile. Make sure we start it at the beginning.
848 . If add_return_path is TRUE, a "return-path:" header is added to the message,
849 containing the envelope sender's address.
851 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
852 giving the top-level envelope address that caused this delivery to happen.
854 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
855 message. It gives the time and date that delivery took place.
857 . If check_string is not null, the start of each line is checked for that
858 string. If it is found, it is replaced by escape_string. This used to be
859 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
861 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
863 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
864 any writing or reading error, leaving the code in errno intact. Error exits
865 can include timeouts for certain transports, which are requested by setting
866 transport_write_timeout non-zero.
870 (fd, msg) Either and fd, to write the message to,
871 or a string: if null write message to allocated space
872 otherwire take content as headers.
873 addr (chain of) addresses (for extra headers), or NULL;
874 only the first address is used
875 tblock optional transport instance block (NULL signifies NULL/0):
876 add_headers a string containing one or more headers to add; it is
877 expanded, and must be in correct RFC 822 format as
878 it is transmitted verbatim; NULL => no additions,
879 and so does empty string or forced expansion fail
880 remove_headers a colon-separated list of headers to remove, or NULL
881 rewrite_rules chain of header rewriting rules
882 rewrite_existflags flags for the rewriting rules
883 options bit-wise options:
884 add_return_path if TRUE, add a "return-path" header
885 add_envelope_to if TRUE, add a "envelope-to" header
886 add_delivery_date if TRUE, add a "delivery-date" header
887 use_crlf if TRUE, turn NL into CR LF
888 end_dot if TRUE, send a terminating "." line at the end
889 no_headers if TRUE, omit the headers
890 no_body if TRUE, omit the body
891 check_string a string to check for at the start of lines, or NULL
892 escape_string a string to insert in front of any check string
893 size_limit if > 0, this is a limit to the size of message written;
894 it is used when returning messages to their senders,
895 and is approximate rather than exact, owing to chunk
898 Returns: TRUE on success; FALSE (with errno) on failure.
899 In addition, the global variable transport_count
900 is incremented by the number of bytes written.
904 internal_transport_write_message(transport_ctx * tctx, int size_limit)
908 /* Initialize pointer in output buffer. */
910 transport_write_reset(tctx->options);
912 /* Set up the data for start-of-line data checking and escaping */
914 if (tctx->check_string && tctx->escape_string)
916 nl_check = tctx->check_string;
917 nl_check_length = Ustrlen(nl_check);
918 nl_escape = tctx->escape_string;
919 nl_escape_length = Ustrlen(nl_escape);
922 /* Whether the escaping mechanism is applied to headers or not is controlled by
923 an option (set for SMTP, not otherwise). Negate the length if not wanted till
924 after the headers. */
926 if (!(tctx->options & topt_escape_headers))
927 nl_check_length = -nl_check_length;
929 /* Write the headers if required, including any that have to be added. If there
930 are header rewriting rules, apply them. The datasource is not the -D spoolfile
931 so temporarily hide the global that adjusts for its format. */
933 if (!(tctx->options & topt_no_headers))
935 BOOL save_wireformat = f.spool_file_wireformat;
936 f.spool_file_wireformat = FALSE;
938 /* Add return-path: if requested. */
940 if (tctx->options & topt_add_return_path)
942 uschar buffer[ADDRESS_MAXLENGTH + 20];
943 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
945 if (!write_chunk(tctx, buffer, n)) goto bad;
948 /* Add envelope-to: if requested */
950 if (tctx->options & topt_add_envelope_to)
953 struct aci *plist = NULL;
954 struct aci *dlist = NULL;
955 rmark reset_point = store_mark();
957 if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
959 /* Pick up from all the addresses. The plist and dlist variables are
960 anchors for lists of addresses already handled; they have to be defined at
961 this level because write_env_to() calls itself recursively. */
963 for (address_item * p = tctx->addr; p; p = p->next)
964 if (!write_env_to(p, &plist, &dlist, &first, tctx))
967 /* Add a final newline and reset the store used for tracking duplicates */
969 if (!write_chunk(tctx, US"\n", 1)) goto bad;
970 store_reset(reset_point);
973 /* Add delivery-date: if requested. */
975 if (tctx->options & topt_add_delivery_date)
977 uschar * s = tod_stamp(tod_full);
979 if ( !write_chunk(tctx, US"Delivery-date: ", 15)
980 || !write_chunk(tctx, s, Ustrlen(s))
981 || !write_chunk(tctx, US"\n", 1)) goto bad;
984 /* Then the message's headers. Don't write any that are flagged as "old";
985 that means they were rewritten, or are a record of envelope rewriting, or
986 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
987 match any entries therein. Then check addr->prop.remove_headers too, provided that
990 if (!transport_headers_send(tctx, &write_chunk))
993 f.spool_file_wireformat = save_wireformat;
997 f.spool_file_wireformat = save_wireformat;
1000 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
1001 last-BDAT, consisting of the current write_chunk() output buffer fill
1002 (optimally, all of the headers - but it does not matter if we already had to
1003 flush that buffer with non-last BDAT prependix) plus the amount of body data
1004 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
1005 that further use of write_chunk() will not prepend BDATs.
1006 The first BDAT written will also first flush any outstanding MAIL and RCPT
1007 commands which were buffered thans to PIPELINING.
1008 Commands go out (using a send()) from a different buffer to data (using a
1009 write()). They might not end up in the same TCP segment, which is
1012 if (tctx->options & topt_use_bdat)
1017 if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1019 if (!(tctx->options & topt_no_body))
1021 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1022 fsize -= SPOOL_DATA_START_OFFSET;
1023 if (size_limit > 0 && fsize > size_limit)
1025 size = hsize + fsize;
1026 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
1027 size += body_linecount; /* account for CRLF-expansion */
1029 /* With topt_use_bdat we never do dot-stuffing; no need to
1030 account for any expansion due to that. */
1033 /* If the message is large, emit first a non-LAST chunk with just the
1034 headers, and reap the command responses. This lets us error out early
1035 on RCPT rejects rather than sending megabytes of data. Include headers
1036 on the assumption they are cheap enough and some clever implementations
1037 might errorcheck them too, on-the-fly, and reject that chunk. */
1039 if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1042 debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1043 if ( tctx->chunk_cb(tctx, hsize, 0) != OK
1044 || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1045 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1048 chunk_ptr = deliver_out_buffer;
1052 /* Emit a LAST datachunk command, and unmark the context for further
1055 if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1057 tctx->options &= ~topt_use_bdat;
1060 /* If the body is required, ensure that the data for check strings (formerly
1061 the "from hack") is enabled by negating the length if necessary. (It will be
1062 negative in cases where it isn't to apply to the headers). Then ensure the body
1063 is positioned at the start of its file (following the message id), then write
1064 it, applying the size limit if required. */
1066 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1067 and we want to send a body without dotstuffing or ending-dot, in-clear,
1068 then we can just dump it using sendfile.
1069 This should get used for CHUNKING output and also for writing the -K file for
1070 dkim signing, when we had CHUNKING input. */
1073 if ( f.spool_file_wireformat
1074 && !(tctx->options & (topt_no_body | topt_end_dot))
1076 && tls_out.active.sock != tctx->u.fd
1080 off_t offset = SPOOL_DATA_START_OFFSET;
1082 /* Write out any header data in the buffer */
1084 if ((len = chunk_ptr - deliver_out_buffer) > 0)
1086 if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1091 DEBUG(D_transport) debug_printf("using sendfile for body\n");
1095 if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1101 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1105 if (!(tctx->options & topt_no_body))
1106 debug_printf("cannot use sendfile for body: %s\n",
1107 !f.spool_file_wireformat ? "spoolfile not wireformat"
1108 : tctx->options & topt_end_dot ? "terminating dot wanted"
1109 : nl_check_length ? "dot- or From-stuffing wanted"
1110 : "TLS output wanted");
1112 if (!(tctx->options & topt_no_body))
1114 unsigned long size = size_limit > 0 ? size_limit : ULONG_MAX;
1116 nl_check_length = abs(nl_check_length);
1117 nl_partial_match = 0;
1118 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
1120 while ( (len = MIN(DELIVER_IN_BUFFER_SIZE, size)) > 0
1121 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1123 if (!write_chunk(tctx, deliver_in_buffer, len))
1128 /* A read error on the body will have left len == -1 and errno set. */
1130 if (len != 0) return FALSE;
1133 /* Finished with the check string, and spool-format consideration */
1135 nl_check_length = nl_escape_length = 0;
1136 f.spool_file_wireformat = FALSE;
1138 /* If requested, add a terminating "." line (SMTP output). */
1140 if (tctx->options & topt_end_dot && !write_chunk(tctx, US".\n", 2))
1143 /* Write out any remaining data in the buffer before returning. */
1145 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1146 transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1152 /*************************************************
1153 * External interface to write the message *
1154 *************************************************/
1156 /* If there is no filtering required, call the internal function above to do
1157 the real work, passing over all the arguments from this function. Otherwise,
1158 set up a filtering process, fork another process to call the internal function
1159 to write to the filter, and in this process just suck from the filter and write
1160 down the fd in the transport context. At the end, tidy up the pipes and the
1163 Arguments: as for internal_transport_write_message() above
1165 Returns: TRUE on success; FALSE (with errno) for any failure
1166 transport_count is incremented by the number of bytes written
1170 transport_write_message(transport_ctx * tctx, int size_limit)
1172 BOOL last_filter_was_NL = TRUE;
1173 BOOL save_spool_file_wireformat = f.spool_file_wireformat;
1174 int rc, len, yield, fd_read, fd_write, save_errno;
1175 int pfd[2] = {-1, -1};
1176 pid_t filter_pid, write_pid;
1178 f.transport_filter_timed_out = FALSE;
1180 /* If there is no filter command set up, call the internal function that does
1181 the actual work, passing it the incoming fd, and return its result. */
1183 if ( !transport_filter_argv
1184 || !*transport_filter_argv
1185 || !**transport_filter_argv
1187 return internal_transport_write_message(tctx, size_limit);
1189 /* Otherwise the message must be written to a filter process and read back
1190 before being written to the incoming fd. First set up the special processing to
1191 be done during the copying. */
1193 nl_partial_match = -1;
1195 if (tctx->check_string && tctx->escape_string)
1197 nl_check = tctx->check_string;
1198 nl_check_length = Ustrlen(nl_check);
1199 nl_escape = tctx->escape_string;
1200 nl_escape_length = Ustrlen(nl_escape);
1202 else nl_check_length = nl_escape_length = 0;
1204 /* Start up a subprocess to run the command. Ensure that our main fd will
1205 be closed when the subprocess execs, but remove the flag afterwards.
1206 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1207 process to deliver another message.) We get back stdin/stdout file descriptors.
1208 If the process creation failed, give an error return. */
1214 write_pid = (pid_t)(-1);
1217 int bits = fcntl(tctx->u.fd, F_GETFD);
1218 (void)fcntl(tctx->u.fd, F_SETFD, bits | FD_CLOEXEC);
1219 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1220 &fd_write, &fd_read, FALSE);
1221 (void)fcntl(tctx->u.fd, F_SETFD, bits & ~FD_CLOEXEC);
1223 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1226 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1227 (int)filter_pid, fd_write, fd_read);
1229 /* Fork subprocess to write the message to the filter, and return the result
1230 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1231 smtp dots, or check string processing. */
1233 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1234 if ((write_pid = fork()) == 0)
1237 (void)close(fd_read);
1238 (void)close(pfd[pipe_read]);
1239 nl_check_length = nl_escape_length = 0;
1241 tctx->u.fd = fd_write;
1242 tctx->check_string = tctx->escape_string = NULL;
1243 tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat);
1245 rc = internal_transport_write_message(tctx, size_limit);
1248 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1250 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1252 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1254 || write(pfd[pipe_write], (void *)&tctx->addr->delivery_usec, sizeof(int))
1257 rc = FALSE; /* compiler quietening */
1258 exim_underbar_exit(0);
1262 /* Parent process: close our copy of the writing subprocess' pipes. */
1264 (void)close(pfd[pipe_write]);
1265 (void)close(fd_write);
1268 /* Writing process creation failed */
1272 errno = save_errno; /* restore */
1276 /* When testing, let the subprocess get going */
1278 if (f.running_in_test_harness) millisleep(250);
1281 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1283 /* Copy the message from the filter to the output fd. A read error leaves len
1284 == -1 and errno set. We need to apply a timeout to the read, to cope with
1285 the case when the filter gets stuck, but it can be quite a long one. The
1286 default is 5m, but this is now configurable. */
1288 DEBUG(D_transport) debug_printf("copying from the filter\n");
1290 /* Copy the output of the filter, remembering if the last character was NL. If
1291 no data is returned, that counts as "ended with NL" (default setting of the
1292 variable is TRUE). The output should always be unix-format as we converted
1293 any wireformat source on writing input to the filter. */
1295 f.spool_file_wireformat = FALSE;
1296 chunk_ptr = deliver_out_buffer;
1300 sigalrm_seen = FALSE;
1301 ALARM(transport_filter_timeout);
1302 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1307 f.transport_filter_timed_out = TRUE;
1311 /* If the read was successful, write the block down the original fd,
1312 remembering whether it ends in \n or not. */
1316 if (!write_chunk(tctx, deliver_in_buffer, len)) goto TIDY_UP;
1317 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1320 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1324 if (len == 0) yield = TRUE;
1329 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1330 to something. Ensure the pipes are all closed and the processes are removed. If
1331 there has been an error, kill the processes before waiting for them, just to be
1332 sure. Also apply a paranoia timeout. */
1335 f.spool_file_wireformat = save_spool_file_wireformat;
1338 (void)close(fd_read);
1339 if (fd_write > 0) (void)close(fd_write);
1343 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1344 if (write_pid > 0) kill(write_pid, SIGKILL);
1347 /* Wait for the filter process to complete. */
1349 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1350 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1353 save_errno = ERRNO_FILTER_FAIL;
1354 tctx->addr->more_errno = rc;
1355 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1358 /* Wait for the writing process to complete. If it ends successfully,
1359 read the results from its pipe, provided we haven't already had a filter
1362 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1365 rc = child_close(write_pid, 30);
1370 if (read(pfd[pipe_read], (void *)&ok, sizeof(BOOL)) != sizeof(BOOL))
1373 debug_printf("pipe read from writing process: %s\n", strerror(errno));
1374 save_errno = ERRNO_FILTER_FAIL;
1379 int dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1380 dummy = read(pfd[pipe_read], (void *)&tctx->addr->more_errno, sizeof(int));
1381 dummy = read(pfd[pipe_read], (void *)&tctx->addr->delivery_usec, sizeof(int));
1382 dummy = dummy; /* compiler quietening */
1389 save_errno = ERRNO_FILTER_FAIL;
1390 tctx->addr->more_errno = rc;
1391 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1394 (void)close(pfd[pipe_read]);
1396 /* If there have been no problems we can now add the terminating "." if this is
1397 SMTP output, turning off escaping beforehand. If the last character from the
1398 filter was not NL, insert a NL to make the SMTP protocol work. */
1402 nl_check_length = nl_escape_length = 0;
1403 f.spool_file_wireformat = FALSE;
1404 if ( tctx->options & topt_end_dot
1405 && ( last_filter_was_NL
1406 ? !write_chunk(tctx, US".\n", 2)
1407 : !write_chunk(tctx, US"\n.\n", 3)
1411 /* Write out any remaining data in the buffer. */
1414 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1415 || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1418 errno = save_errno; /* From some earlier error */
1422 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1424 debug_printf("errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1434 /*************************************************
1435 * Update waiting database *
1436 *************************************************/
1438 /* This is called when an address is deferred by remote transports that are
1439 capable of sending more than one message over one connection. A database is
1440 maintained for each transport, keeping track of which messages are waiting for
1441 which hosts. The transport can then consult this when eventually a successful
1442 delivery happens, and if it finds that another message is waiting for the same
1443 host, it can fire up a new process to deal with it using the same connection.
1445 The database records are keyed by host name. They can get full if there are
1446 lots of messages waiting, and so there is a continuation mechanism for them.
1448 Each record contains a list of message ids, packed end to end without any
1449 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1450 in this record, and the sequence field says if there are any other records for
1451 this host. If the sequence field is 0, there are none. If it is 1, then another
1452 record with the name <hostname>:0 exists; if it is 2, then two other records
1453 with sequence numbers 0 and 1 exist, and so on.
1455 Currently, an exhaustive search of all continuation records has to be done to
1456 determine whether to add a message id to a given record. This shouldn't be
1457 too bad except in extreme cases. I can't figure out a *simple* way of doing
1460 Old records should eventually get swept up by the exim_tidydb utility.
1463 hostlist list of hosts that this message could be sent to
1464 tpname name of the transport
1470 transport_update_waiting(host_item *hostlist, uschar *tpname)
1472 const uschar *prevname = US"";
1476 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1478 /* Open the database for this transport */
1480 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", tpname),
1481 O_RDWR, &dbblock, TRUE, TRUE)))
1484 /* Scan the list of hosts for which this message is waiting, and ensure
1485 that the message id is in each host record. */
1487 for (host_item * host = hostlist; host; host = host->next)
1489 BOOL already = FALSE;
1490 dbdata_wait *host_record;
1494 /* Skip if this is the same host as we just processed; otherwise remember
1495 the name for next time. */
1497 if (Ustrcmp(prevname, host->name) == 0) continue;
1498 prevname = host->name;
1500 /* Look up the host record; if there isn't one, make an empty one. */
1502 if (!(host_record = dbfn_read(dbm_file, host->name)))
1504 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH, FALSE);
1505 host_record->count = host_record->sequence = 0;
1508 /* Compute the current length */
1510 host_length = host_record->count * MESSAGE_ID_LENGTH;
1512 /* Search the record to see if the current message is already in it. */
1514 for (uschar * s = host_record->text; s < host_record->text + host_length;
1515 s += MESSAGE_ID_LENGTH)
1516 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1517 { already = TRUE; break; }
1519 /* If we haven't found this message in the main record, search any
1520 continuation records that exist. */
1522 for (int i = host_record->sequence - 1; i >= 0 && !already; i--)
1525 sprintf(CS buffer, "%.200s:%d", host->name, i);
1526 if ((cont = dbfn_read(dbm_file, buffer)))
1528 int clen = cont->count * MESSAGE_ID_LENGTH;
1529 for (uschar * s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1530 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1531 { already = TRUE; break; }
1535 /* If this message is already in a record, no need to update. */
1539 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1544 /* If this record is full, write it out with a new name constructed
1545 from the sequence number, increase the sequence number, and empty
1548 if (host_record->count >= WAIT_NAME_MAX)
1550 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1551 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1552 host_record->sequence++;
1553 host_record->count = 0;
1557 /* If this record is not full, increase the size of the record to
1558 allow for one new message id. */
1563 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH, FALSE);
1564 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1568 /* Now add the new name on the end */
1570 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1571 host_record->count++;
1572 host_length += MESSAGE_ID_LENGTH;
1574 /* Update the database */
1576 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1577 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1582 dbfn_close(dbm_file);
1588 /*************************************************
1589 * Test for waiting messages *
1590 *************************************************/
1592 /* This function is called by a remote transport which uses the previous
1593 function to remember which messages are waiting for which remote hosts. It's
1594 called after a successful delivery and its job is to check whether there is
1595 another message waiting for the same host. However, it doesn't do this if the
1596 current continue sequence is greater than the maximum supplied as an argument,
1597 or greater than the global connection_max_messages, which, if set, overrides.
1600 transport_name name of the transport
1601 hostname name of the host
1602 local_message_max maximum number of messages down one connection
1603 as set by the caller transport
1604 new_message_id set to the message id of a waiting message
1605 more set TRUE if there are yet more messages waiting
1606 oicf_func function to call to validate if it is ok to send
1607 to this message_id from the current instance.
1608 oicf_data opaque data for oicf_func
1610 Returns: TRUE if new_message_id set; FALSE otherwise
1613 typedef struct msgq_s
1615 uschar message_id [MESSAGE_ID_LENGTH + 1];
1620 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1621 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1623 dbdata_wait *host_record;
1629 struct stat statbuf;
1635 debug_printf("transport_check_waiting entered\n");
1636 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1637 continue_sequence, local_message_max, connection_max_messages);
1640 /* Do nothing if we have hit the maximum number that can be send down one
1643 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1644 if (local_message_max > 0 && continue_sequence >= local_message_max)
1647 debug_printf("max messages for one connection reached: returning\n");
1651 /* Open the waiting information database. */
1653 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1654 O_RDWR, &dbblock, TRUE, TRUE)))
1657 /* See if there is a record for this host; if not, there's nothing to do. */
1659 if (!(host_record = dbfn_read(dbm_file, hostname)))
1661 dbfn_close(dbm_file);
1662 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1666 /* If the data in the record looks corrupt, just log something and
1667 don't try to use it. */
1669 if (host_record->count > WAIT_NAME_MAX)
1671 dbfn_close(dbm_file);
1672 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1673 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1677 /* Scan the message ids in the record from the end towards the beginning,
1678 until one is found for which a spool file actually exists. If the record gets
1679 emptied, delete it and continue with any continuation records that may exist.
1682 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1683 but the 1 off will remain without it. This code now allows me to SKIP over
1684 a message I do not want to send out on this run. */
1686 host_length = host_record->count * MESSAGE_ID_LENGTH;
1692 int msgq_actual = 0;
1693 BOOL bFound = FALSE;
1694 BOOL bContinuation = FALSE;
1696 /* create an array to read entire message queue into memory for processing */
1698 msgq = store_get(sizeof(msgq_t) * host_record->count, FALSE);
1699 msgq_count = host_record->count;
1700 msgq_actual = msgq_count;
1702 for (i = 0; i < host_record->count; ++i)
1704 msgq[i].bKeep = TRUE;
1706 Ustrncpy_nt(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1708 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1711 /* first thing remove current message id if it exists */
1713 for (i = 0; i < msgq_count; ++i)
1714 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1716 msgq[i].bKeep = FALSE;
1720 /* now find the next acceptable message_id */
1722 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1725 uschar * mid = msgq[i].message_id;
1727 set_subdir_str(subdir, mid, 0);
1728 if (Ustat(spool_fname(US"input", subdir, mid, US"-D"), &statbuf) != 0)
1729 msgq[i].bKeep = FALSE;
1730 else if (!oicf_func || oicf_func(mid, oicf_data))
1732 Ustrcpy_nt(new_message_id, mid);
1733 msgq[i].bKeep = FALSE;
1740 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1744 /* reassemble the host record, based on removed message ids, from in
1747 if (msgq_actual <= 0)
1750 host_record->count = 0;
1754 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1755 host_record->count = msgq_actual;
1757 if (msgq_actual < msgq_count)
1760 for (new_count = 0, i = 0; i < msgq_count; ++i)
1762 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1763 msgq[i].message_id, MESSAGE_ID_LENGTH);
1765 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1769 /* Check for a continuation record. */
1771 while (host_length <= 0)
1773 dbdata_wait * newr = NULL;
1776 /* Search for a continuation */
1778 for (int i = host_record->sequence - 1; i >= 0 && !newr; i--)
1780 sprintf(CS buffer, "%.200s:%d", hostname, i);
1781 newr = dbfn_read(dbm_file, buffer);
1784 /* If no continuation, delete the current and break the loop */
1788 dbfn_delete(dbm_file, hostname);
1792 /* Else replace the current with the continuation */
1794 dbfn_delete(dbm_file, buffer);
1796 host_length = host_record->count * MESSAGE_ID_LENGTH;
1798 bContinuation = TRUE;
1801 if (bFound) /* Usual exit from main loop */
1804 /* If host_length <= 0 we have emptied a record and not found a good message,
1805 and there are no continuation records. Otherwise there is a continuation
1806 record to process. */
1808 if (host_length <= 0)
1810 dbfn_close(dbm_file);
1811 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1815 /* we were not able to find an acceptable message, nor was there a
1816 * continuation record. So bug out, outer logic will clean this up.
1821 Ustrcpy(new_message_id, message_id);
1822 dbfn_close(dbm_file);
1825 } /* we need to process a continuation record */
1827 /* Control gets here when an existing message has been encountered; its
1828 id is in new_message_id, and host_length is the revised length of the
1829 host record. If it is zero, the record has been removed. Update the
1830 record if required, close the database, and return TRUE. */
1832 if (host_length > 0)
1834 host_record->count = host_length/MESSAGE_ID_LENGTH;
1836 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1840 dbfn_close(dbm_file);
1844 /*************************************************
1845 * Deliver waiting message down same socket *
1846 *************************************************/
1848 /* Just the regain-root-privilege exec portion */
1850 transport_do_pass_socket(const uschar *transport_name, const uschar *hostname,
1851 const uschar *hostaddress, uschar *id, int socket_fd)
1854 const uschar **argv;
1856 /* Set up the calling arguments; use the standard function for the basics,
1857 but we have a number of extras that may be added. */
1859 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1861 if (f.smtp_authenticated) argv[i++] = US"-MCA";
1862 if (smtp_peer_options & OPTION_CHUNKING) argv[i++] = US"-MCK";
1863 if (smtp_peer_options & OPTION_DSN) argv[i++] = US"-MCD";
1864 if (smtp_peer_options & OPTION_PIPE) argv[i++] = US"-MCP";
1865 if (smtp_peer_options & OPTION_SIZE) argv[i++] = US"-MCS";
1867 if (smtp_peer_options & OPTION_TLS)
1868 if (tls_out.active.sock >= 0 || continue_proxy_cipher)
1870 argv[i++] = US"-MCt";
1871 argv[i++] = sending_ip_address;
1872 argv[i++] = string_sprintf("%d", sending_port);
1873 argv[i++] = tls_out.active.sock >= 0 ? tls_out.cipher : continue_proxy_cipher;
1876 argv[i++] = US"-MCT";
1879 if (queue_run_pid != (pid_t)0)
1881 argv[i++] = US"-MCQ";
1882 argv[i++] = string_sprintf("%d", queue_run_pid);
1883 argv[i++] = string_sprintf("%d", queue_run_pipe);
1886 argv[i++] = US"-MC";
1887 argv[i++] = US transport_name;
1888 argv[i++] = US hostname;
1889 argv[i++] = US hostaddress;
1890 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1894 /* Arrange for the channel to be on stdin. */
1898 (void)dup2(socket_fd, 0);
1899 (void)close(socket_fd);
1902 DEBUG(D_exec) debug_print_argv(argv);
1903 exim_nullstd(); /* Ensure std{out,err} exist */
1904 execv(CS argv[0], (char *const *)argv);
1906 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1907 _exit(errno); /* Note: must be _exit(), NOT exit() */
1912 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1913 get a clean delivery process, and to regain root privilege in cases where it
1914 has been given away.
1917 transport_name to pass to the new process
1920 id the new message to process
1921 socket_fd the connected socket
1923 Returns: FALSE if fork fails; TRUE otherwise
1927 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1928 const uschar *hostaddress, uschar *id, int socket_fd)
1933 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1935 if ((pid = fork()) == 0)
1937 /* Disconnect entirely from the parent process. If we are running in the
1938 test harness, wait for a bit to allow the previous process time to finish,
1939 write the log, etc., so that the output is always in the same order for
1940 automatic comparison. */
1942 if ((pid = fork()) != 0)
1944 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (final-pid %d)\n", pid);
1945 _exit(EXIT_SUCCESS);
1947 if (f.running_in_test_harness) sleep(1);
1949 transport_do_pass_socket(transport_name, hostname, hostaddress,
1953 /* If the process creation succeeded, wait for the first-level child, which
1954 immediately exits, leaving the second level process entirely disconnected from
1960 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1961 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (inter-pid %d)\n", pid);
1966 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1974 /*************************************************
1975 * Set up direct (non-shell) command *
1976 *************************************************/
1978 /* This function is called when a command line is to be parsed and executed
1979 directly, without the use of /bin/sh. It is called by the pipe transport,
1980 the queryprogram router, and also from the main delivery code when setting up a
1981 transport filter process. The code for ETRN also makes use of this; in that
1982 case, no addresses are passed.
1985 argvptr pointer to anchor for argv vector
1986 cmd points to the command string (modified IN PLACE)
1987 expand_arguments true if expansion is to occur
1988 expand_failed error value to set if expansion fails; not relevant if
1990 addr chain of addresses, or NULL
1991 etext text for use in error messages
1992 errptr where to put error message if addr is NULL;
1993 otherwise it is put in the first address
1995 Returns: TRUE if all went well; otherwise an error will be
1996 set in the first address and FALSE returned
2000 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2001 BOOL expand_arguments, int expand_failed, address_item *addr,
2002 uschar *etext, uschar **errptr)
2004 const uschar **argv;
2006 int address_count = 0;
2010 /* Get store in which to build an argument list. Count the number of addresses
2011 supplied, and allow for that many arguments, plus an additional 60, which
2012 should be enough for anybody. Multiple addresses happen only when the local
2013 delivery batch option is set. */
2015 for (address_item * ad = addr; ad; ad = ad->next) address_count++;
2016 max_args = address_count + 60;
2017 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *), FALSE);
2019 /* Split the command up into arguments terminated by white space. Lose
2020 trailing space at the start and end. Double-quoted arguments can contain \\ and
2021 \" escapes and so can be handled by the standard function; single-quoted
2022 arguments are verbatim. Copy each argument into a new string. */
2025 while (isspace(*s)) s++;
2027 for (; *s != 0 && argcount < max_args; argcount++)
2032 while (*ss != 0 && *ss != '\'') ss++;
2033 argv[argcount] = ss = store_get(ss - s++, is_tainted(cmd));
2034 while (*s != 0 && *s != '\'') *ss++ = *s++;
2039 argv[argcount] = string_dequote(CUSS &s);
2040 while (isspace(*s)) s++;
2043 argv[argcount] = US 0;
2045 /* If *s != 0 we have run out of argument slots. */
2049 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2053 addr->transport_return = FAIL;
2054 addr->message = msg;
2060 /* Expand each individual argument if required. Expansion happens for pipes set
2061 up in filter files and with directly-supplied commands. It does not happen if
2062 the pipe comes from a traditional .forward file. A failing expansion is a big
2063 disaster if the command came from Exim's configuration; if it came from a user
2064 it is just a normal failure. The expand_failed value is used as the error value
2065 to cater for these two cases.
2067 An argument consisting just of the text "$pipe_addresses" is treated specially.
2068 It is not passed to the general expansion function. Instead, it is replaced by
2069 a number of arguments, one for each address. This avoids problems with shell
2070 metacharacters and spaces in addresses.
2072 If the parent of the top address has an original part of "system-filter", this
2073 pipe was set up by the system filter, and we can permit the expansion of
2078 debug_printf("direct command:\n");
2079 for (int i = 0; argv[i]; i++)
2080 debug_printf(" argv[%d] = '%s'\n", i, string_printing(argv[i]));
2083 if (expand_arguments)
2085 BOOL allow_dollar_recipients = addr != NULL &&
2086 addr->parent != NULL &&
2087 Ustrcmp(addr->parent->address, "system-filter") == 0;
2089 for (int i = 0; argv[i] != US 0; i++)
2092 /* Handle special fudge for passing an address list */
2095 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2096 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2100 if (argcount + address_count - 1 > max_args)
2102 addr->transport_return = FAIL;
2103 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2104 "in %s", cmd, etext);
2108 additional = address_count - 1;
2110 memmove(argv + i + 1 + additional, argv + i + 1,
2111 (argcount - i)*sizeof(uschar *));
2113 for (address_item * ad = addr; ad; ad = ad->next)
2115 argv[i++] = ad->address;
2119 /* Subtract one since we replace $pipe_addresses */
2124 /* Handle special case of $address_pipe when af_force_command is set */
2126 else if (addr != NULL && testflag(addr,af_force_command) &&
2127 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2128 Ustrcmp(argv[i], "${address_pipe}") == 0))
2130 int address_pipe_argcount = 0;
2131 int address_pipe_max_args;
2132 uschar **address_pipe_argv;
2135 /* We can never have more then the argv we will be loading into */
2136 address_pipe_max_args = max_args - argcount + 1;
2139 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2141 /* We allocate an additional for (uschar *)0 */
2142 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *), FALSE);
2144 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2145 s = expand_string(addr->local_part + 1);
2146 tainted = is_tainted(s);
2148 if (s == NULL || *s == '\0')
2150 addr->transport_return = FAIL;
2151 addr->message = string_sprintf("Expansion of \"%s\" "
2152 "from command \"%s\" in %s failed: %s",
2153 (addr->local_part + 1), cmd, etext, expand_string_message);
2157 while (isspace(*s)) s++; /* strip leading space */
2159 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2164 while (*ss != 0 && *ss != '\'') ss++;
2165 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++, tainted);
2166 while (*s != 0 && *s != '\'') *ss++ = *s++;
2170 else address_pipe_argv[address_pipe_argcount++] =
2171 string_copy(string_dequote(CUSS &s));
2172 while (isspace(*s)) s++; /* strip space after arg */
2175 address_pipe_argv[address_pipe_argcount] = US 0;
2177 /* If *s != 0 we have run out of argument slots. */
2180 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2181 "\"%s\" in %s", addr->local_part + 1, etext);
2184 addr->transport_return = FAIL;
2185 addr->message = msg;
2191 /* address_pipe_argcount - 1
2192 * because we are replacing $address_pipe in the argument list
2193 * with the first thing it expands to */
2194 if (argcount + address_pipe_argcount - 1 > max_args)
2196 addr->transport_return = FAIL;
2197 addr->message = string_sprintf("Too many arguments to command "
2198 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2202 /* If we are not just able to replace the slot that contained
2203 * $address_pipe (address_pipe_argcount == 1)
2204 * We have to move the existing argv by address_pipe_argcount - 1
2205 * Visually if address_pipe_argcount == 2:
2206 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2207 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2209 if (address_pipe_argcount > 1)
2211 /* current position + additional args */
2212 argv + i + address_pipe_argcount,
2213 /* current position + 1 (for the (uschar *)0 at the end) */
2215 /* -1 for the (uschar *)0 at the end)*/
2216 (argcount - i)*sizeof(uschar *)
2219 /* Now we fill in the slots we just moved argv out of
2220 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2222 for (int address_pipe_i = 0;
2223 address_pipe_argv[address_pipe_i] != US 0;
2226 argv[i++] = address_pipe_argv[address_pipe_i];
2230 /* Subtract one since we replace $address_pipe */
2235 /* Handle normal expansion string */
2239 const uschar *expanded_arg;
2240 f.enable_dollar_recipients = allow_dollar_recipients;
2241 expanded_arg = expand_cstring(argv[i]);
2242 f.enable_dollar_recipients = FALSE;
2246 uschar *msg = string_sprintf("Expansion of \"%s\" "
2247 "from command \"%s\" in %s failed: %s",
2248 argv[i], cmd, etext, expand_string_message);
2251 addr->transport_return = expand_failed;
2252 addr->message = msg;
2257 argv[i] = expanded_arg;
2263 debug_printf("direct command after expansion:\n");
2264 for (int i = 0; argv[i] != US 0; i++)
2265 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2272 #endif /*!MACRO_PREDEF*/
2275 /* End of transport.c */