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)
98 struct transport_info * ti;
101 options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
103 for (ti = transports_available; ti->driver_name[0]; ti++)
105 spf(buf, sizeof(buf), US"_DRIVER_TRANSPORT_%T", ti->driver_name);
106 builtin_macro_create(buf);
107 options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
111 #else /*!MACRO_PREDEF*/
113 /* Structure for keeping list of addresses that have been added to
114 Envelope-To:, in order to avoid duplication. */
122 /* Static data for write_chunk() */
124 static uschar *chunk_ptr; /* chunk pointer */
125 static uschar *nl_check; /* string to look for at line start */
126 static int nl_check_length; /* length of same */
127 static uschar *nl_escape; /* string to insert */
128 static int nl_escape_length; /* length of same */
129 static int nl_partial_match; /* length matched at chunk end */
132 /*************************************************
133 * Initialize transport list *
134 *************************************************/
136 /* Read the transports section of the configuration file, and set up a chain of
137 transport instances according to its contents. Each transport has generic
138 options and may also have its own private options. This function is only ever
139 called when transports == NULL. We use generic code in readconf to do most of
145 transport_instance *t;
147 readconf_driver_init(US"transport",
148 (driver_instance **)(&transports), /* chain anchor */
149 (driver_info *)transports_available, /* available drivers */
150 sizeof(transport_info), /* size of info block */
151 &transport_defaults, /* default values for generic options */
152 sizeof(transport_instance), /* size of instance block */
153 optionlist_transports, /* generic options */
154 optionlist_transports_size);
156 /* Now scan the configured transports and check inconsistencies. A shadow
157 transport is permitted only for local transports. */
159 for (t = transports; t; t = t->next)
161 if (!t->info->local && t->shadow)
162 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
163 "shadow transport not allowed on non-local transport %s", t->name);
165 if (t->body_only && t->headers_only)
166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
167 "%s transport: body_only and headers_only are mutually exclusive",
174 /*************************************************
175 * Write block of data *
176 *************************************************/
178 /* Subroutine called by write_chunk() and at the end of the message actually
179 to write a data block. Also called directly by some transports to write
180 additional data to the file descriptor (e.g. prefix, suffix).
182 If a transport wants data transfers to be timed, it sets a non-zero value in
183 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
184 be set for each block of data written from here. If time runs out, then write()
185 fails and provokes an error return. The caller can then inspect sigalrm_seen to
188 On some systems, if a quota is exceeded during the write, the yield is the
189 number of bytes written rather than an immediate error code. This also happens
190 on some systems in other cases, for example a pipe that goes away because the
191 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
192 get the error codes the first time.
194 The write() function is also interruptible; the Solaris 2.6 man page says:
196 If write() is interrupted by a signal before it writes any
197 data, it will return -1 with errno set to EINTR.
199 If write() is interrupted by a signal after it successfully
200 writes some data, it will return the number of bytes written.
202 To handle these cases, we want to restart the write() to output the remainder
203 of the data after a non-negative return from write(), except after a timeout.
204 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
205 proper error then occurs. In principle, after an interruption, the second
206 write() could suffer the same fate, but we do not want to continue for
207 evermore, so stick a maximum repetition count on the loop to act as a
211 tctx transport context: file descriptor or string to write to
212 block block of bytes to write
213 len number of bytes to write
214 more further data expected soon
216 Returns: TRUE on success, FALSE on failure (with errno preserved);
217 transport_count is incremented by the number of bytes written
221 transport_write_block_fd(transport_ctx * tctx, uschar *block, int len, BOOL more)
223 int i, rc, save_errno;
224 int local_timeout = transport_write_timeout;
227 /* This loop is for handling incomplete writes and other retries. In most
228 normal cases, it is only ever executed once. */
230 for (i = 0; i < 100; i++)
233 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
234 fd, len, local_timeout, more ? " (more expected)" : "");
236 /* This code makes use of alarm() in order to implement the timeout. This
237 isn't a very tidy way of doing things. Using non-blocking I/O with select()
238 provides a neater approach. However, I don't know how to do this when TLS is
241 if (transport_write_timeout <= 0) /* No timeout wanted */
245 tls_out.active == fd ? tls_write(FALSE, block, len, more) :
248 more && !(tctx->options & topt_not_socket)
249 ? send(fd, block, len, MSG_MORE) :
251 write(fd, block, len);
255 /* Timeout wanted. */
259 alarm(local_timeout);
263 tls_out.active == fd ? tls_write(FALSE, block, len, more) :
266 more ? send(fd, block, len, MSG_MORE) :
268 write(fd, block, len);
271 local_timeout = alarm(0);
279 /* Hopefully, the most common case is success, so test that first. */
281 if (rc == len) { transport_count += len; return TRUE; }
283 /* A non-negative return code is an incomplete write. Try again for the rest
284 of the block. If we have exactly hit the timeout, give up. */
290 transport_count += rc;
291 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
292 goto CHECK_TIMEOUT; /* A few lines below */
295 /* A negative return code with an EINTR error is another form of
296 incomplete write, zero bytes having been written */
298 if (save_errno == EINTR)
301 debug_printf("write interrupted before anything written\n");
302 goto CHECK_TIMEOUT; /* A few lines below */
305 /* A response of EAGAIN from write() is likely only in the case of writing
306 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
308 if (save_errno == EAGAIN)
311 debug_printf("write temporarily locked out, waiting 1 sec\n");
314 /* Before continuing to try another write, check that we haven't run out of
318 if (transport_write_timeout > 0 && local_timeout <= 0)
326 /* Otherwise there's been an error */
328 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
329 strerror(save_errno));
334 /* We've tried and tried and tried but still failed */
336 errno = ERRNO_WRITEINCOMPLETE;
342 transport_write_block(transport_ctx * tctx, uschar *block, int len, BOOL more)
344 if (!(tctx->options & topt_output_string))
345 return transport_write_block_fd(tctx, block, len, more);
347 /* Write to expanding-string. NOTE: not NUL-terminated */
350 tctx->u.msg = string_get(1024);
352 tctx->u.msg = string_catn(tctx->u.msg, block, len);
359 /*************************************************
360 * Write formatted string *
361 *************************************************/
363 /* This is called by various transports. It is a convenience function.
368 ... arguments for format
370 Returns: the yield of transport_write_block()
374 transport_write_string(int fd, const char *format, ...)
376 transport_ctx tctx = {{0}};
378 va_start(ap, format);
379 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
380 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
383 return transport_write_block(&tctx, big_buffer, Ustrlen(big_buffer), FALSE);
390 transport_write_reset(int options)
392 if (!(options & topt_continuation)) chunk_ptr = deliver_out_buffer;
393 nl_partial_match = -1;
394 nl_check_length = nl_escape_length = 0;
399 /*************************************************
400 * Write character chunk *
401 *************************************************/
403 /* Subroutine used by transport_write_message() to scan character chunks for
404 newlines and act appropriately. The object is to minimise the number of writes.
405 The output byte stream is buffered up in deliver_out_buffer, which is written
406 only when it gets full, thus minimizing write operations and TCP packets.
408 Static data is used to handle the case when the last character of the previous
409 chunk was NL, or matched part of the data that has to be escaped.
412 tctx transport context - processing to be done during output,
413 and file descriptor to write to
414 chunk pointer to data to write
415 len length of data to write
417 In addition, the static nl_xxx variables must be set as required.
419 Returns: TRUE on success, FALSE on failure (with errno preserved)
423 write_chunk(transport_ctx * tctx, uschar *chunk, int len)
425 uschar *start = chunk;
426 uschar *end = chunk + len;
428 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
430 /* The assumption is made that the check string will never stretch over move
431 than one chunk since the only time there are partial matches is when copying
432 the body in large buffers. There is always enough room in the buffer for an
433 escape string, since the loop below ensures this for each character it
434 processes, and it won't have stuck in the escape string if it left a partial
437 if (nl_partial_match >= 0)
439 if (nl_check_length > 0 && len >= nl_check_length &&
440 Ustrncmp(start, nl_check + nl_partial_match,
441 nl_check_length - nl_partial_match) == 0)
443 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
444 chunk_ptr += nl_escape_length;
445 start += nl_check_length - nl_partial_match;
448 /* The partial match was a false one. Insert the characters carried over
449 from the previous chunk. */
451 else if (nl_partial_match > 0)
453 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
454 chunk_ptr += nl_partial_match;
457 nl_partial_match = -1;
460 /* Now process the characters in the chunk. Whenever we hit a newline we check
461 for possible escaping. The code for the non-NL route should be as fast as
464 for (ptr = start; ptr < end; ptr++)
468 /* Flush the buffer if it has reached the threshold - we want to leave enough
469 room for the next uschar, plus a possible extra CR for an LF, plus the escape
472 if ((len = chunk_ptr - deliver_out_buffer) > mlen)
474 DEBUG(D_transport) debug_printf("flushing headers buffer\n");
476 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
477 from previous SMTP commands. */
479 if (tctx->options & topt_use_bdat && tctx->chunk_cb)
481 if ( tctx->chunk_cb(tctx, (unsigned)len, 0) != OK
482 || !transport_write_block(tctx, deliver_out_buffer, len, FALSE)
483 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
488 if (!transport_write_block(tctx, deliver_out_buffer, len, FALSE))
490 chunk_ptr = deliver_out_buffer;
493 /* Remove CR before NL if required */
495 if ( *ptr == '\r' && ptr[1] == '\n'
496 && !(tctx->options & topt_use_crlf)
497 && spool_file_wireformat
501 if ((ch = *ptr) == '\n')
503 int left = end - ptr - 1; /* count of chars left after NL */
505 /* Insert CR before NL if required */
507 if (tctx->options & topt_use_crlf && !spool_file_wireformat)
510 transport_newlines++;
512 /* The check_string test (formerly "from hack") replaces the specific
513 string at the start of a line with an escape string (e.g. "From " becomes
514 ">From " or "." becomes "..". It is a case-sensitive test. The length
515 check above ensures there is always enough room to insert this string. */
517 if (nl_check_length > 0)
519 if (left >= nl_check_length &&
520 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
522 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
523 chunk_ptr += nl_escape_length;
524 ptr += nl_check_length;
527 /* Handle the case when there isn't enough left to match the whole
528 check string, but there may be a partial match. We remember how many
529 characters matched, and finish processing this chunk. */
531 else if (left <= 0) nl_partial_match = 0;
533 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
535 nl_partial_match = left;
541 /* Not a NL character */
543 else *chunk_ptr++ = ch;
552 /*************************************************
553 * Generate address for RCPT TO *
554 *************************************************/
556 /* This function puts together an address for RCPT to, using the caseful
557 version of the local part and the caseful version of the domain. If there is no
558 prefix or suffix, or if affixes are to be retained, we can just use the
559 original address. Otherwise, if there is a prefix but no suffix we can use a
560 pointer into the original address. If there is a suffix, however, we have to
564 addr the address item
565 include_affixes TRUE if affixes are to be included
571 transport_rcpt_address(address_item *addr, BOOL include_affixes)
578 setflag(addr, af_include_affixes); /* Affects logged => line */
579 return addr->address;
582 if (addr->suffix == NULL)
584 if (addr->prefix == NULL) return addr->address;
585 return addr->address + Ustrlen(addr->prefix);
588 at = Ustrrchr(addr->address, '@');
589 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
590 slen = Ustrlen(addr->suffix);
592 return string_sprintf("%.*s@%s", (int)(at - addr->address - plen - slen),
593 addr->address + plen, at + 1);
597 /*************************************************
598 * Output Envelope-To: address & scan duplicates *
599 *************************************************/
601 /* This function is called from internal_transport_write_message() below, when
602 generating an Envelope-To: header line. It checks for duplicates of the given
603 address and its ancestors. When one is found, this function calls itself
604 recursively, to output the envelope address of the duplicate.
606 We want to avoid duplication in the list, which can arise for example when
607 A->B,C and then both B and C alias to D. This can also happen when there are
608 unseen drivers in use. So a list of addresses that have been output is kept in
611 It is also possible to have loops in the address ancestry/duplication graph,
612 for example if there are two top level addresses A and B and we have A->B,C and
613 B->A. To break the loop, we use a list of processed addresses in the dlist
616 After handling duplication, this function outputs the progenitor of the given
620 p the address we are interested in
621 pplist address of anchor of the list of addresses not to output
622 pdlist address of anchor of the list of processed addresses
623 first TRUE if this is the first address; set it FALSE afterwards
624 tctx transport context - processing to be done during output
625 and the file descriptor to write to
627 Returns: FALSE if writing failed
631 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
632 BOOL *first, transport_ctx * tctx)
637 /* Do nothing if we have already handled this address. If not, remember it
638 so that we don't handle it again. */
640 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
642 ppp = store_get(sizeof(struct aci));
647 /* Now scan up the ancestry, checking for duplicates at each generation. */
649 for (pp = p;; pp = pp->parent)
652 for (dup = addr_duplicate; dup; dup = dup->next)
653 if (dup->dupof == pp) /* a dup of our address */
654 if (!write_env_to(dup, pplist, pdlist, first, tctx))
656 if (!pp->parent) break;
659 /* Check to see if we have already output the progenitor. */
661 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
662 if (ppp) return TRUE;
664 /* Remember what we have output, and output it. */
666 ppp = store_get(sizeof(struct aci));
671 if (!*first && !write_chunk(tctx, US",\n ", 3)) return FALSE;
673 return write_chunk(tctx, pp->address, Ustrlen(pp->address));
679 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
685 addr (chain of) addresses (for extra headers), or NULL;
686 only the first address is used
687 tctx transport context
688 sendfn function for output (transport or verify)
690 Returns: TRUE on success; FALSE on failure.
693 transport_headers_send(transport_ctx * tctx,
694 BOOL (*sendfn)(transport_ctx * tctx, uschar * s, int len))
698 transport_instance * tblock = tctx ? tctx->tblock : NULL;
699 address_item * addr = tctx ? tctx->addr : NULL;
701 /* Then the message's headers. Don't write any that are flagged as "old";
702 that means they were rewritten, or are a record of envelope rewriting, or
703 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
704 match any entries therein. It is a colon-sep list; expand the items
705 separately and squash any empty ones.
706 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
708 for (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 (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)) && !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 void *reset_point = store_get(0);
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.
785 header_line *hprev = addr->prop.extra_headers;
787 for (i = 0; i < 2; i++)
788 for (h = hprev, hprev = NULL; h; h = hnext)
795 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
797 debug_printf("added header line(s):\n%s---\n", h->text);
802 /* If a string containing additional headers exists it is a newline-sep
803 list. Expand each item and write out the result. This is done last so that
804 if it (deliberately or accidentally) isn't in header format, it won't mess
805 up any other headers. An empty string or a forced expansion failure are
806 noops. An added header string from a transport may not end with a newline;
807 add one if it does not. */
809 if (tblock && (list = CUS tblock->add_headers))
814 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
815 if ((s = expand_string(s)))
817 int len = Ustrlen(s);
820 if (!sendfn(tctx, s, len)) return FALSE;
821 if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
825 debug_printf("added header line:\n%s", s);
826 if (s[len-1] != '\n') debug_printf("\n");
827 debug_printf("---\n");
831 else if (!expand_string_forcedfail)
832 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
835 /* Separate headers from body with a blank line */
837 return sendfn(tctx, US"\n", 1);
841 /*************************************************
842 * Write the message *
843 *************************************************/
845 /* This function writes the message to the given file descriptor. The headers
846 are in the in-store data structure, and the rest of the message is in the open
847 file descriptor deliver_datafile. Make sure we start it at the beginning.
849 . If add_return_path is TRUE, a "return-path:" header is added to the message,
850 containing the envelope sender's address.
852 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
853 giving the top-level envelope address that caused this delivery to happen.
855 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
856 message. It gives the time and date that delivery took place.
858 . If check_string is not null, the start of each line is checked for that
859 string. If it is found, it is replaced by escape_string. This used to be
860 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
862 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
864 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
865 any writing or reading error, leaving the code in errno intact. Error exits
866 can include timeouts for certain transports, which are requested by setting
867 transport_write_timeout non-zero.
871 (fd, msg) Either and fd, to write the message to,
872 or a string: if null write message to allocated space
873 otherwire take content as headers.
874 addr (chain of) addresses (for extra headers), or NULL;
875 only the first address is used
876 tblock optional transport instance block (NULL signifies NULL/0):
877 add_headers a string containing one or more headers to add; it is
878 expanded, and must be in correct RFC 822 format as
879 it is transmitted verbatim; NULL => no additions,
880 and so does empty string or forced expansion fail
881 remove_headers a colon-separated list of headers to remove, or NULL
882 rewrite_rules chain of header rewriting rules
883 rewrite_existflags flags for the rewriting rules
884 options bit-wise options:
885 add_return_path if TRUE, add a "return-path" header
886 add_envelope_to if TRUE, add a "envelope-to" header
887 add_delivery_date if TRUE, add a "delivery-date" header
888 use_crlf if TRUE, turn NL into CR LF
889 end_dot if TRUE, send a terminating "." line at the end
890 no_headers if TRUE, omit the headers
891 no_body if TRUE, omit the body
892 check_string a string to check for at the start of lines, or NULL
893 escape_string a string to insert in front of any check string
894 size_limit if > 0, this is a limit to the size of message written;
895 it is used when returning messages to their senders,
896 and is approximate rather than exact, owing to chunk
899 Returns: TRUE on success; FALSE (with errno) on failure.
900 In addition, the global variable transport_count
901 is incremented by the number of bytes written.
905 internal_transport_write_message(transport_ctx * tctx, int size_limit)
909 /* Initialize pointer in output buffer. */
911 transport_write_reset(tctx->options);
913 /* Set up the data for start-of-line data checking and escaping */
915 if (tctx->check_string && tctx->escape_string)
917 nl_check = tctx->check_string;
918 nl_check_length = Ustrlen(nl_check);
919 nl_escape = tctx->escape_string;
920 nl_escape_length = Ustrlen(nl_escape);
923 /* Whether the escaping mechanism is applied to headers or not is controlled by
924 an option (set for SMTP, not otherwise). Negate the length if not wanted till
925 after the headers. */
927 if (!(tctx->options & topt_escape_headers))
928 nl_check_length = -nl_check_length;
930 /* Write the headers if required, including any that have to be added. If there
931 are header rewriting rules, apply them. The datasource is not the -D spoolfile
932 so temporarily hide the global that adjusts for its format. */
934 if (!(tctx->options & topt_no_headers))
936 BOOL save_wireformat = spool_file_wireformat;
937 spool_file_wireformat = FALSE;
939 /* Add return-path: if requested. */
941 if (tctx->options & topt_add_return_path)
943 uschar buffer[ADDRESS_MAXLENGTH + 20];
944 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
946 if (!write_chunk(tctx, buffer, n)) goto bad;
949 /* Add envelope-to: if requested */
951 if (tctx->options & topt_add_envelope_to)
955 struct aci *plist = NULL;
956 struct aci *dlist = NULL;
957 void *reset_point = store_get(0);
959 if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
961 /* Pick up from all the addresses. The plist and dlist variables are
962 anchors for lists of addresses already handled; they have to be defined at
963 this level because write_env_to() calls itself recursively. */
965 for (p = tctx->addr; p; p = p->next)
966 if (!write_env_to(p, &plist, &dlist, &first, tctx)) goto bad;
968 /* Add a final newline and reset the store used for tracking duplicates */
970 if (!write_chunk(tctx, US"\n", 1)) goto bad;
971 store_reset(reset_point);
974 /* Add delivery-date: if requested. */
976 if (tctx->options & topt_add_delivery_date)
978 uschar * s = tod_stamp(tod_full);
980 if ( !write_chunk(tctx, US"Delivery-date: ", 15)
981 || !write_chunk(tctx, s, Ustrlen(s))
982 || !write_chunk(tctx, US"\n", 1)) goto bad;
985 /* Then the message's headers. Don't write any that are flagged as "old";
986 that means they were rewritten, or are a record of envelope rewriting, or
987 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
988 match any entries therein. Then check addr->prop.remove_headers too, provided that
991 if (!transport_headers_send(tctx, &write_chunk))
994 spool_file_wireformat = save_wireformat;
998 spool_file_wireformat = save_wireformat;
1001 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
1002 last-BDAT, consisting of the current write_chunk() output buffer fill
1003 (optimally, all of the headers - but it does not matter if we already had to
1004 flush that buffer with non-last BDAT prependix) plus the amount of body data
1005 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
1006 that further use of write_chunk() will not prepend BDATs.
1007 The first BDAT written will also first flush any outstanding MAIL and RCPT
1008 commands which were buffered thans to PIPELINING.
1009 Commands go out (using a send()) from a different buffer to data (using a
1010 write()). They might not end up in the same TCP segment, which is
1013 if (tctx->options & topt_use_bdat)
1018 if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1020 if (!(tctx->options & topt_no_body))
1022 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1023 fsize -= SPOOL_DATA_START_OFFSET;
1024 if (size_limit > 0 && fsize > size_limit)
1026 size = hsize + fsize;
1027 if (tctx->options & topt_use_crlf && !spool_file_wireformat)
1028 size += body_linecount; /* account for CRLF-expansion */
1030 /* With topt_use_bdat we never do dot-stuffing; no need to
1031 account for any expansion due to that. */
1034 /* If the message is large, emit first a non-LAST chunk with just the
1035 headers, and reap the command responses. This lets us error out early
1036 on RCPT rejects rather than sending megabytes of data. Include headers
1037 on the assumption they are cheap enough and some clever implementations
1038 might errorcheck them too, on-the-fly, and reject that chunk. */
1040 if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1043 debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1044 if ( tctx->chunk_cb(tctx, hsize, 0) != OK
1045 || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1046 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1049 chunk_ptr = deliver_out_buffer;
1053 /* Emit a LAST datachunk command, and unmark the context for further
1056 if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1058 tctx->options &= ~topt_use_bdat;
1061 /* If the body is required, ensure that the data for check strings (formerly
1062 the "from hack") is enabled by negating the length if necessary. (It will be
1063 negative in cases where it isn't to apply to the headers). Then ensure the body
1064 is positioned at the start of its file (following the message id), then write
1065 it, applying the size limit if required. */
1067 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1068 and we want to send a body without dotstuffing or ending-dot, in-clear,
1069 then we can just dump it using sendfile.
1070 This should get used for CHUNKING output and also for writing the -K file for
1071 dkim signing, when we had CHUNKING input. */
1074 if ( spool_file_wireformat
1075 && !(tctx->options & (topt_no_body | topt_end_dot))
1077 && tls_out.active != tctx->u.fd
1081 off_t offset = SPOOL_DATA_START_OFFSET;
1083 /* Write out any header data in the buffer */
1085 if ((len = chunk_ptr - deliver_out_buffer) > 0)
1087 if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1092 DEBUG(D_transport) debug_printf("using sendfile for body\n");
1096 if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1102 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1106 if (!(tctx->options & topt_no_body))
1107 debug_printf("cannot use sendfile for body: %s\n",
1108 !spool_file_wireformat ? "spoolfile not wireformat"
1109 : tctx->options & topt_end_dot ? "terminating dot wanted"
1110 : nl_check_length ? "dot- or From-stuffing wanted"
1111 : "TLS output wanted");
1113 if (!(tctx->options & topt_no_body))
1115 int size = size_limit;
1117 nl_check_length = abs(nl_check_length);
1118 nl_partial_match = 0;
1119 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
1121 while ( (len = MAX(DELIVER_IN_BUFFER_SIZE, size)) > 0
1122 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1124 if (!write_chunk(tctx, deliver_in_buffer, len))
1129 /* A read error on the body will have left len == -1 and errno set. */
1131 if (len != 0) return FALSE;
1134 /* Finished with the check string */
1136 nl_check_length = nl_escape_length = 0;
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 = 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 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 */
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 (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 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 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 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 if ( tctx->options & topt_end_dot
1404 && ( last_filter_was_NL
1405 ? !write_chunk(tctx, US".\n", 2)
1406 : !write_chunk(tctx, US"\n.\n", 3)
1410 /* Write out any remaining data in the buffer. */
1413 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1414 || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1417 errno = save_errno; /* From some earlier error */
1421 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1423 debug_printf("errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1433 /*************************************************
1434 * Update waiting database *
1435 *************************************************/
1437 /* This is called when an address is deferred by remote transports that are
1438 capable of sending more than one message over one connection. A database is
1439 maintained for each transport, keeping track of which messages are waiting for
1440 which hosts. The transport can then consult this when eventually a successful
1441 delivery happens, and if it finds that another message is waiting for the same
1442 host, it can fire up a new process to deal with it using the same connection.
1444 The database records are keyed by host name. They can get full if there are
1445 lots of messages waiting, and so there is a continuation mechanism for them.
1447 Each record contains a list of message ids, packed end to end without any
1448 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1449 in this record, and the sequence field says if there are any other records for
1450 this host. If the sequence field is 0, there are none. If it is 1, then another
1451 record with the name <hostname>:0 exists; if it is 2, then two other records
1452 with sequence numbers 0 and 1 exist, and so on.
1454 Currently, an exhaustive search of all continuation records has to be done to
1455 determine whether to add a message id to a given record. This shouldn't be
1456 too bad except in extreme cases. I can't figure out a *simple* way of doing
1459 Old records should eventually get swept up by the exim_tidydb utility.
1462 hostlist list of hosts that this message could be sent to
1463 tpname name of the transport
1469 transport_update_waiting(host_item *hostlist, uschar *tpname)
1471 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)))
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 = hostlist; host; host = host->next)
1489 BOOL already = FALSE;
1490 dbdata_wait *host_record;
1495 /* Skip if this is the same host as we just processed; otherwise remember
1496 the name for next time. */
1498 if (Ustrcmp(prevname, host->name) == 0) continue;
1499 prevname = host->name;
1501 /* Look up the host record; if there isn't one, make an empty one. */
1503 if (!(host_record = dbfn_read(dbm_file, host->name)))
1505 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1506 host_record->count = host_record->sequence = 0;
1509 /* Compute the current length */
1511 host_length = host_record->count * MESSAGE_ID_LENGTH;
1513 /* Search the record to see if the current message is already in it. */
1515 for (s = host_record->text; s < host_record->text + host_length;
1516 s += MESSAGE_ID_LENGTH)
1517 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1518 { already = TRUE; break; }
1520 /* If we haven't found this message in the main record, search any
1521 continuation records that exist. */
1523 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1526 sprintf(CS buffer, "%.200s:%d", host->name, i);
1527 if ((cont = dbfn_read(dbm_file, buffer)))
1529 int clen = cont->count * MESSAGE_ID_LENGTH;
1530 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1531 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1532 { already = TRUE; break; }
1536 /* If this message is already in a record, no need to update. */
1540 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1545 /* If this record is full, write it out with a new name constructed
1546 from the sequence number, increase the sequence number, and empty
1549 if (host_record->count >= WAIT_NAME_MAX)
1551 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1552 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1553 host_record->sequence++;
1554 host_record->count = 0;
1558 /* If this record is not full, increase the size of the record to
1559 allow for one new message id. */
1564 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1565 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1569 /* Now add the new name on the end */
1571 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1572 host_record->count++;
1573 host_length += MESSAGE_ID_LENGTH;
1575 /* Update the database */
1577 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1578 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1583 dbfn_close(dbm_file);
1589 /*************************************************
1590 * Test for waiting messages *
1591 *************************************************/
1593 /* This function is called by a remote transport which uses the previous
1594 function to remember which messages are waiting for which remote hosts. It's
1595 called after a successful delivery and its job is to check whether there is
1596 another message waiting for the same host. However, it doesn't do this if the
1597 current continue sequence is greater than the maximum supplied as an argument,
1598 or greater than the global connection_max_messages, which, if set, overrides.
1601 transport_name name of the transport
1602 hostname name of the host
1603 local_message_max maximum number of messages down one connection
1604 as set by the caller transport
1605 new_message_id set to the message id of a waiting message
1606 more set TRUE if there are yet more messages waiting
1607 oicf_func function to call to validate if it is ok to send
1608 to this message_id from the current instance.
1609 oicf_data opaque data for oicf_func
1611 Returns: TRUE if new_message_id set; FALSE otherwise
1614 typedef struct msgq_s
1616 uschar message_id [MESSAGE_ID_LENGTH + 1];
1621 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1622 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1624 dbdata_wait *host_record;
1630 struct stat statbuf;
1636 debug_printf("transport_check_waiting entered\n");
1637 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1638 continue_sequence, local_message_max, connection_max_messages);
1641 /* Do nothing if we have hit the maximum number that can be send down one
1644 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1645 if (local_message_max > 0 && continue_sequence >= local_message_max)
1648 debug_printf("max messages for one connection reached: returning\n");
1652 /* Open the waiting information database. */
1654 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1655 O_RDWR, &dbblock, TRUE)))
1658 /* See if there is a record for this host; if not, there's nothing to do. */
1660 if (!(host_record = dbfn_read(dbm_file, hostname)))
1662 dbfn_close(dbm_file);
1663 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1667 /* If the data in the record looks corrupt, just log something and
1668 don't try to use it. */
1670 if (host_record->count > WAIT_NAME_MAX)
1672 dbfn_close(dbm_file);
1673 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1674 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1678 /* Scan the message ids in the record from the end towards the beginning,
1679 until one is found for which a spool file actually exists. If the record gets
1680 emptied, delete it and continue with any continuation records that may exist.
1683 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1684 but the 1 off will remain without it. This code now allows me to SKIP over
1685 a message I do not want to send out on this run. */
1687 host_length = host_record->count * MESSAGE_ID_LENGTH;
1693 int msgq_actual = 0;
1694 BOOL bFound = FALSE;
1695 BOOL bContinuation = FALSE;
1697 /* create an array to read entire message queue into memory for processing */
1699 msgq = store_malloc(sizeof(msgq_t) * host_record->count);
1700 msgq_count = host_record->count;
1701 msgq_actual = msgq_count;
1703 for (i = 0; i < host_record->count; ++i)
1705 msgq[i].bKeep = TRUE;
1707 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1709 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1712 /* first thing remove current message id if it exists */
1714 for (i = 0; i < msgq_count; ++i)
1715 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1717 msgq[i].bKeep = FALSE;
1721 /* now find the next acceptable message_id */
1723 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1727 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1730 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1732 msgq[i].bKeep = FALSE;
1733 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1735 Ustrcpy(new_message_id, msgq[i].message_id);
1736 msgq[i].bKeep = FALSE;
1743 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1747 /* reassemble the host record, based on removed message ids, from in
1750 if (msgq_actual <= 0)
1753 host_record->count = 0;
1757 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1758 host_record->count = msgq_actual;
1760 if (msgq_actual < msgq_count)
1763 for (new_count = 0, i = 0; i < msgq_count; ++i)
1765 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1766 msgq[i].message_id, MESSAGE_ID_LENGTH);
1768 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1772 /* Check for a continuation record. */
1774 while (host_length <= 0)
1777 dbdata_wait * newr = NULL;
1780 /* Search for a continuation */
1782 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1784 sprintf(CS buffer, "%.200s:%d", hostname, i);
1785 newr = dbfn_read(dbm_file, buffer);
1788 /* If no continuation, delete the current and break the loop */
1792 dbfn_delete(dbm_file, hostname);
1796 /* Else replace the current with the continuation */
1798 dbfn_delete(dbm_file, buffer);
1800 host_length = host_record->count * MESSAGE_ID_LENGTH;
1802 bContinuation = TRUE;
1805 if (bFound) /* Usual exit from main loop */
1811 /* If host_length <= 0 we have emptied a record and not found a good message,
1812 and there are no continuation records. Otherwise there is a continuation
1813 record to process. */
1815 if (host_length <= 0)
1817 dbfn_close(dbm_file);
1818 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1822 /* we were not able to find an acceptable message, nor was there a
1823 * continuation record. So bug out, outer logic will clean this up.
1828 Ustrcpy(new_message_id, message_id);
1829 dbfn_close(dbm_file);
1834 } /* we need to process a continuation record */
1836 /* Control gets here when an existing message has been encountered; its
1837 id is in new_message_id, and host_length is the revised length of the
1838 host record. If it is zero, the record has been removed. Update the
1839 record if required, close the database, and return TRUE. */
1841 if (host_length > 0)
1843 host_record->count = host_length/MESSAGE_ID_LENGTH;
1845 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1849 dbfn_close(dbm_file);
1853 /*************************************************
1854 * Deliver waiting message down same socket *
1855 *************************************************/
1857 /* Just the regain-root-privilege exec portion */
1859 transport_do_pass_socket(const uschar *transport_name, const uschar *hostname,
1860 const uschar *hostaddress, uschar *id, int socket_fd)
1863 const uschar **argv;
1865 /* Set up the calling arguments; use the standard function for the basics,
1866 but we have a number of extras that may be added. */
1868 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1870 if (smtp_authenticated) argv[i++] = US"-MCA";
1871 if (smtp_peer_options & OPTION_CHUNKING) argv[i++] = US"-MCK";
1872 if (smtp_peer_options & OPTION_DSN) argv[i++] = US"-MCD";
1873 if (smtp_peer_options & OPTION_PIPE) argv[i++] = US"-MCP";
1874 if (smtp_peer_options & OPTION_SIZE) argv[i++] = US"-MCS";
1876 if (smtp_peer_options & OPTION_TLS)
1877 if (tls_out.active >= 0 || continue_proxy_cipher)
1879 argv[i++] = US"-MCt";
1880 argv[i++] = sending_ip_address;
1881 argv[i++] = string_sprintf("%d", sending_port);
1882 argv[i++] = tls_out.active >= 0 ? tls_out.cipher : continue_proxy_cipher;
1885 argv[i++] = US"-MCT";
1888 if (queue_run_pid != (pid_t)0)
1890 argv[i++] = US"-MCQ";
1891 argv[i++] = string_sprintf("%d", queue_run_pid);
1892 argv[i++] = string_sprintf("%d", queue_run_pipe);
1895 argv[i++] = US"-MC";
1896 argv[i++] = US transport_name;
1897 argv[i++] = US hostname;
1898 argv[i++] = US hostaddress;
1899 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1903 /* Arrange for the channel to be on stdin. */
1907 (void)dup2(socket_fd, 0);
1908 (void)close(socket_fd);
1911 DEBUG(D_exec) debug_print_argv(argv);
1912 exim_nullstd(); /* Ensure std{out,err} exist */
1913 execv(CS argv[0], (char *const *)argv);
1915 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1916 _exit(errno); /* Note: must be _exit(), NOT exit() */
1921 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1922 get a clean delivery process, and to regain root privilege in cases where it
1923 has been given away.
1926 transport_name to pass to the new process
1929 id the new message to process
1930 socket_fd the connected socket
1932 Returns: FALSE if fork fails; TRUE otherwise
1936 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1937 const uschar *hostaddress, uschar *id, int socket_fd)
1942 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1944 if ((pid = fork()) == 0)
1946 /* Disconnect entirely from the parent process. If we are running in the
1947 test harness, wait for a bit to allow the previous process time to finish,
1948 write the log, etc., so that the output is always in the same order for
1949 automatic comparison. */
1951 if ((pid = fork()) != 0)
1953 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (final-pid %d)\n", pid);
1954 _exit(EXIT_SUCCESS);
1956 if (running_in_test_harness) sleep(1);
1958 transport_do_pass_socket(transport_name, hostname, hostaddress,
1962 /* If the process creation succeeded, wait for the first-level child, which
1963 immediately exits, leaving the second level process entirely disconnected from
1969 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1970 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (inter-pid %d)\n", pid);
1975 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1983 /*************************************************
1984 * Set up direct (non-shell) command *
1985 *************************************************/
1987 /* This function is called when a command line is to be parsed and executed
1988 directly, without the use of /bin/sh. It is called by the pipe transport,
1989 the queryprogram router, and also from the main delivery code when setting up a
1990 transport filter process. The code for ETRN also makes use of this; in that
1991 case, no addresses are passed.
1994 argvptr pointer to anchor for argv vector
1995 cmd points to the command string (modified IN PLACE)
1996 expand_arguments true if expansion is to occur
1997 expand_failed error value to set if expansion fails; not relevant if
1999 addr chain of addresses, or NULL
2000 etext text for use in error messages
2001 errptr where to put error message if addr is NULL;
2002 otherwise it is put in the first address
2004 Returns: TRUE if all went well; otherwise an error will be
2005 set in the first address and FALSE returned
2009 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2010 BOOL expand_arguments, int expand_failed, address_item *addr,
2011 uschar *etext, uschar **errptr)
2014 const uschar **argv;
2016 int address_count = 0;
2020 /* Get store in which to build an argument list. Count the number of addresses
2021 supplied, and allow for that many arguments, plus an additional 60, which
2022 should be enough for anybody. Multiple addresses happen only when the local
2023 delivery batch option is set. */
2025 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2026 max_args = address_count + 60;
2027 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2029 /* Split the command up into arguments terminated by white space. Lose
2030 trailing space at the start and end. Double-quoted arguments can contain \\ and
2031 \" escapes and so can be handled by the standard function; single-quoted
2032 arguments are verbatim. Copy each argument into a new string. */
2035 while (isspace(*s)) s++;
2037 while (*s != 0 && argcount < max_args)
2042 while (*ss != 0 && *ss != '\'') ss++;
2043 argv[argcount++] = ss = store_get(ss - s++);
2044 while (*s != 0 && *s != '\'') *ss++ = *s++;
2048 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2049 while (isspace(*s)) s++;
2052 argv[argcount] = US 0;
2054 /* If *s != 0 we have run out of argument slots. */
2058 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2062 addr->transport_return = FAIL;
2063 addr->message = msg;
2069 /* Expand each individual argument if required. Expansion happens for pipes set
2070 up in filter files and with directly-supplied commands. It does not happen if
2071 the pipe comes from a traditional .forward file. A failing expansion is a big
2072 disaster if the command came from Exim's configuration; if it came from a user
2073 it is just a normal failure. The expand_failed value is used as the error value
2074 to cater for these two cases.
2076 An argument consisting just of the text "$pipe_addresses" is treated specially.
2077 It is not passed to the general expansion function. Instead, it is replaced by
2078 a number of arguments, one for each address. This avoids problems with shell
2079 metacharacters and spaces in addresses.
2081 If the parent of the top address has an original part of "system-filter", this
2082 pipe was set up by the system filter, and we can permit the expansion of
2087 debug_printf("direct command:\n");
2088 for (i = 0; argv[i] != US 0; i++)
2089 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2092 if (expand_arguments)
2094 BOOL allow_dollar_recipients = addr != NULL &&
2095 addr->parent != NULL &&
2096 Ustrcmp(addr->parent->address, "system-filter") == 0;
2098 for (i = 0; argv[i] != US 0; i++)
2101 /* Handle special fudge for passing an address list */
2104 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2105 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2109 if (argcount + address_count - 1 > max_args)
2111 addr->transport_return = FAIL;
2112 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2113 "in %s", cmd, etext);
2117 additional = address_count - 1;
2119 memmove(argv + i + 1 + additional, argv + i + 1,
2120 (argcount - i)*sizeof(uschar *));
2122 for (ad = addr; ad != NULL; ad = ad->next) {
2123 argv[i++] = ad->address;
2127 /* Subtract one since we replace $pipe_addresses */
2132 /* Handle special case of $address_pipe when af_force_command is set */
2134 else if (addr != NULL && testflag(addr,af_force_command) &&
2135 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2136 Ustrcmp(argv[i], "${address_pipe}") == 0))
2139 int address_pipe_argcount = 0;
2140 int address_pipe_max_args;
2141 uschar **address_pipe_argv;
2143 /* We can never have more then the argv we will be loading into */
2144 address_pipe_max_args = max_args - argcount + 1;
2147 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2149 /* We allocate an additional for (uschar *)0 */
2150 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2152 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2153 s = expand_string(addr->local_part + 1);
2155 if (s == NULL || *s == '\0')
2157 addr->transport_return = FAIL;
2158 addr->message = string_sprintf("Expansion of \"%s\" "
2159 "from command \"%s\" in %s failed: %s",
2160 (addr->local_part + 1), cmd, etext, expand_string_message);
2164 while (isspace(*s)) s++; /* strip leading space */
2166 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2171 while (*ss != 0 && *ss != '\'') ss++;
2172 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2173 while (*s != 0 && *s != '\'') *ss++ = *s++;
2177 else address_pipe_argv[address_pipe_argcount++] =
2178 string_copy(string_dequote(CUSS &s));
2179 while (isspace(*s)) s++; /* strip space after arg */
2182 address_pipe_argv[address_pipe_argcount] = US 0;
2184 /* If *s != 0 we have run out of argument slots. */
2187 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2188 "\"%s\" in %s", addr->local_part + 1, etext);
2191 addr->transport_return = FAIL;
2192 addr->message = msg;
2198 /* address_pipe_argcount - 1
2199 * because we are replacing $address_pipe in the argument list
2200 * with the first thing it expands to */
2201 if (argcount + address_pipe_argcount - 1 > max_args)
2203 addr->transport_return = FAIL;
2204 addr->message = string_sprintf("Too many arguments to command "
2205 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2209 /* If we are not just able to replace the slot that contained
2210 * $address_pipe (address_pipe_argcount == 1)
2211 * We have to move the existing argv by address_pipe_argcount - 1
2212 * Visually if address_pipe_argcount == 2:
2213 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2214 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2216 if (address_pipe_argcount > 1)
2218 /* current position + additional args */
2219 argv + i + address_pipe_argcount,
2220 /* current position + 1 (for the (uschar *)0 at the end) */
2222 /* -1 for the (uschar *)0 at the end)*/
2223 (argcount - i)*sizeof(uschar *)
2226 /* Now we fill in the slots we just moved argv out of
2227 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2229 for (address_pipe_i = 0;
2230 address_pipe_argv[address_pipe_i] != US 0;
2233 argv[i++] = address_pipe_argv[address_pipe_i];
2237 /* Subtract one since we replace $address_pipe */
2242 /* Handle normal expansion string */
2246 const uschar *expanded_arg;
2247 enable_dollar_recipients = allow_dollar_recipients;
2248 expanded_arg = expand_cstring(argv[i]);
2249 enable_dollar_recipients = FALSE;
2251 if (expanded_arg == NULL)
2253 uschar *msg = string_sprintf("Expansion of \"%s\" "
2254 "from command \"%s\" in %s failed: %s",
2255 argv[i], cmd, etext, expand_string_message);
2258 addr->transport_return = expand_failed;
2259 addr->message = msg;
2264 argv[i] = expanded_arg;
2270 debug_printf("direct command after expansion:\n");
2271 for (i = 0; argv[i] != US 0; i++)
2272 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2279 #endif /*!MACRO_PREDEF*/
2282 /* End of transport.c */