1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* General functions concerned with transportation, and generic options for all
14 #ifdef HAVE_LINUX_SENDFILE
15 #include <sys/sendfile.h>
18 /* Structure for keeping list of addresses that have been added to
19 Envelope-To:, in order to avoid duplication. */
27 /* Static data for write_chunk() */
29 static uschar *chunk_ptr; /* chunk pointer */
30 static uschar *nl_check; /* string to look for at line start */
31 static int nl_check_length; /* length of same */
32 static uschar *nl_escape; /* string to insert */
33 static int nl_escape_length; /* length of same */
34 static int nl_partial_match; /* length matched at chunk end */
37 /* Generic options for transports, all of which live inside transport_instance
38 data blocks and which therefore have the opt_public flag set. Note that there
39 are other options living inside this structure which can be set only from
40 certain transports. */
42 optionlist optionlist_transports[] = {
43 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
44 (void *)offsetof(transport_instance, expand_gid) },
45 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
46 (void *)offsetof(transport_instance, expand_uid) },
47 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
48 (void *)offsetof(transport_instance, rewrite_existflags) },
49 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
50 (void *)offsetof(transport_instance, rewrite_rules) },
51 { "*set_group", opt_bool|opt_hidden|opt_public,
52 (void *)offsetof(transport_instance, gid_set) },
53 { "*set_user", opt_bool|opt_hidden|opt_public,
54 (void *)offsetof(transport_instance, uid_set) },
55 { "body_only", opt_bool|opt_public,
56 (void *)offsetof(transport_instance, body_only) },
57 { "current_directory", opt_stringptr|opt_public,
58 (void *)offsetof(transport_instance, current_dir) },
59 { "debug_print", opt_stringptr | opt_public,
60 (void *)offsetof(transport_instance, debug_string) },
61 { "delivery_date_add", opt_bool|opt_public,
62 (void *)(offsetof(transport_instance, delivery_date_add)) },
63 { "disable_logging", opt_bool|opt_public,
64 (void *)(offsetof(transport_instance, disable_logging)) },
65 { "driver", opt_stringptr|opt_public,
66 (void *)offsetof(transport_instance, driver_name) },
67 { "envelope_to_add", opt_bool|opt_public,
68 (void *)(offsetof(transport_instance, envelope_to_add)) },
70 { "event_action", opt_stringptr | opt_public,
71 (void *)offsetof(transport_instance, event_action) },
73 { "group", opt_expand_gid|opt_public,
74 (void *)offsetof(transport_instance, gid) },
75 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
76 (void *)offsetof(transport_instance, add_headers) },
77 { "headers_only", opt_bool|opt_public,
78 (void *)offsetof(transport_instance, headers_only) },
79 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
80 (void *)offsetof(transport_instance, remove_headers) },
81 { "headers_rewrite", opt_rewrite|opt_public,
82 (void *)offsetof(transport_instance, headers_rewrite) },
83 { "home_directory", opt_stringptr|opt_public,
84 (void *)offsetof(transport_instance, home_dir) },
85 { "initgroups", opt_bool|opt_public,
86 (void *)offsetof(transport_instance, initgroups) },
87 { "max_parallel", opt_stringptr|opt_public,
88 (void *)offsetof(transport_instance, max_parallel) },
89 { "message_size_limit", opt_stringptr|opt_public,
90 (void *)offsetof(transport_instance, message_size_limit) },
91 { "rcpt_include_affixes", opt_bool|opt_public,
92 (void *)offsetof(transport_instance, rcpt_include_affixes) },
93 { "retry_use_local_part", opt_bool|opt_public,
94 (void *)offsetof(transport_instance, retry_use_local_part) },
95 { "return_path", opt_stringptr|opt_public,
96 (void *)(offsetof(transport_instance, return_path)) },
97 { "return_path_add", opt_bool|opt_public,
98 (void *)(offsetof(transport_instance, return_path_add)) },
99 { "shadow_condition", opt_stringptr|opt_public,
100 (void *)offsetof(transport_instance, shadow_condition) },
101 { "shadow_transport", opt_stringptr|opt_public,
102 (void *)offsetof(transport_instance, shadow) },
103 { "transport_filter", opt_stringptr|opt_public,
104 (void *)offsetof(transport_instance, filter_command) },
105 { "transport_filter_timeout", opt_time|opt_public,
106 (void *)offsetof(transport_instance, filter_timeout) },
107 { "user", opt_expand_uid|opt_public,
108 (void *)offsetof(transport_instance, uid) }
111 int optionlist_transports_size =
112 sizeof(optionlist_transports)/sizeof(optionlist);
115 /*************************************************
116 * Initialize transport list *
117 *************************************************/
119 /* Read the transports section of the configuration file, and set up a chain of
120 transport instances according to its contents. Each transport has generic
121 options and may also have its own private options. This function is only ever
122 called when transports == NULL. We use generic code in readconf to do most of
128 transport_instance *t;
130 readconf_driver_init(US"transport",
131 (driver_instance **)(&transports), /* chain anchor */
132 (driver_info *)transports_available, /* available drivers */
133 sizeof(transport_info), /* size of info block */
134 &transport_defaults, /* default values for generic options */
135 sizeof(transport_instance), /* size of instance block */
136 optionlist_transports, /* generic options */
137 optionlist_transports_size);
139 /* Now scan the configured transports and check inconsistencies. A shadow
140 transport is permitted only for local transports. */
142 for (t = transports; t != NULL; t = t->next)
146 if (t->shadow != NULL)
147 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
148 "shadow transport not allowed on non-local transport %s", t->name);
151 if (t->body_only && t->headers_only)
152 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
153 "%s transport: body_only and headers_only are mutually exclusive",
160 /*************************************************
161 * Write block of data *
162 *************************************************/
164 /* Subroutine called by write_chunk() and at the end of the message actually
165 to write a data block. Also called directly by some transports to write
166 additional data to the file descriptor (e.g. prefix, suffix).
168 If a transport wants data transfers to be timed, it sets a non-zero value in
169 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
170 be set for each block of data written from here. If time runs out, then write()
171 fails and provokes an error return. The caller can then inspect sigalrm_seen to
174 On some systems, if a quota is exceeded during the write, the yield is the
175 number of bytes written rather than an immediate error code. This also happens
176 on some systems in other cases, for example a pipe that goes away because the
177 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
178 get the error codes the first time.
180 The write() function is also interruptible; the Solaris 2.6 man page says:
182 If write() is interrupted by a signal before it writes any
183 data, it will return -1 with errno set to EINTR.
185 If write() is interrupted by a signal after it successfully
186 writes some data, it will return the number of bytes written.
188 To handle these cases, we want to restart the write() to output the remainder
189 of the data after a non-negative return from write(), except after a timeout.
190 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
191 proper error then occurs. In principle, after an interruption, the second
192 write() could suffer the same fate, but we do not want to continue for
193 evermore, so stick a maximum repetition count on the loop to act as a
197 fd file descriptor to write to
198 block block of bytes to write
199 len number of bytes to write
201 Returns: TRUE on success, FALSE on failure (with errno preserved);
202 transport_count is incremented by the number of bytes written
206 transport_write_block(int fd, uschar *block, int len)
208 int i, rc, save_errno;
209 int local_timeout = transport_write_timeout;
211 /* This loop is for handling incomplete writes and other retries. In most
212 normal cases, it is only ever executed once. */
214 for (i = 0; i < 100; i++)
217 debug_printf("writing data block fd=%d size=%d timeout=%d\n",
218 fd, len, local_timeout);
220 /* This code makes use of alarm() in order to implement the timeout. This
221 isn't a very tidy way of doing things. Using non-blocking I/O with select()
222 provides a neater approach. However, I don't know how to do this when TLS is
225 if (transport_write_timeout <= 0) /* No timeout wanted */
228 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
230 rc = write(fd, block, len);
234 /* Timeout wanted. */
238 alarm(local_timeout);
240 if (tls_out.active == fd)
241 rc = tls_write(FALSE, block, len);
244 rc = write(fd, block, len);
246 local_timeout = alarm(0);
254 /* Hopefully, the most common case is success, so test that first. */
256 if (rc == len) { transport_count += len; return TRUE; }
258 /* A non-negative return code is an incomplete write. Try again for the rest
259 of the block. If we have exactly hit the timeout, give up. */
265 transport_count += rc;
266 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
267 goto CHECK_TIMEOUT; /* A few lines below */
270 /* A negative return code with an EINTR error is another form of
271 incomplete write, zero bytes having been written */
273 if (save_errno == EINTR)
276 debug_printf("write interrupted before anything written\n");
277 goto CHECK_TIMEOUT; /* A few lines below */
280 /* A response of EAGAIN from write() is likely only in the case of writing
281 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
283 if (save_errno == EAGAIN)
286 debug_printf("write temporarily locked out, waiting 1 sec\n");
289 /* Before continuing to try another write, check that we haven't run out of
293 if (transport_write_timeout > 0 && local_timeout <= 0)
301 /* Otherwise there's been an error */
303 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
304 strerror(save_errno));
309 /* We've tried and tried and tried but still failed */
311 errno = ERRNO_WRITEINCOMPLETE;
318 /*************************************************
319 * Write formatted string *
320 *************************************************/
322 /* This is called by various transports. It is a convenience function.
327 ... arguments for format
329 Returns: the yield of transport_write_block()
333 transport_write_string(int fd, const char *format, ...)
336 va_start(ap, format);
337 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
338 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
340 return transport_write_block(fd, big_buffer, Ustrlen(big_buffer));
346 /*************************************************
347 * Write character chunk *
348 *************************************************/
350 /* Subroutine used by transport_write_message() to scan character chunks for
351 newlines and act appropriately. The object is to minimise the number of writes.
352 The output byte stream is buffered up in deliver_out_buffer, which is written
353 only when it gets full, thus minimizing write operations and TCP packets.
355 Static data is used to handle the case when the last character of the previous
356 chunk was NL, or matched part of the data that has to be escaped.
359 fd file descript to write to
360 chunk pointer to data to write
361 len length of data to write
362 flags bitmap of topt_ flags for processing options
363 use_crlf terminate lines with CRLF
364 use_bdat prepend chunks with RFC3030 BDAT header
366 In addition, the static nl_xxx variables must be set as required.
368 Returns: TRUE on success, FALSE on failure (with errno preserved)
372 write_chunk(int fd, uschar *chunk, int len, unsigned flags)
374 uschar *start = chunk;
375 uschar *end = chunk + len;
377 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
379 /* The assumption is made that the check string will never stretch over move
380 than one chunk since the only time there are partial matches is when copying
381 the body in large buffers. There is always enough room in the buffer for an
382 escape string, since the loop below ensures this for each character it
383 processes, and it won't have stuck in the escape string if it left a partial
386 if (nl_partial_match >= 0)
388 if (nl_check_length > 0 && len >= nl_check_length &&
389 Ustrncmp(start, nl_check + nl_partial_match,
390 nl_check_length - nl_partial_match) == 0)
392 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
393 chunk_ptr += nl_escape_length;
394 start += nl_check_length - nl_partial_match;
397 /* The partial match was a false one. Insert the characters carried over
398 from the previous chunk. */
400 else if (nl_partial_match > 0)
402 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
403 chunk_ptr += nl_partial_match;
406 nl_partial_match = -1;
409 /* Now process the characters in the chunk. Whenever we hit a newline we check
410 for possible escaping. The code for the non-NL route should be as fast as
413 for (ptr = start; ptr < end; ptr++)
417 /* Flush the buffer if it has reached the threshold - we want to leave enough
418 room for the next uschar, plus a possible extra CR for an LF, plus the escape
420 /*XXX CHUNKING: need to prefix write_block with a BDAT cmd. Also possibly
421 reap a response from a previous BDAT first. NEED a callback into the tpt
424 if (chunk_ptr - deliver_out_buffer > mlen)
426 if (!transport_write_block(fd, deliver_out_buffer,
427 chunk_ptr - deliver_out_buffer))
429 chunk_ptr = deliver_out_buffer;
432 if ((ch = *ptr) == '\n')
434 int left = end - ptr - 1; /* count of chars left after NL */
436 /* Insert CR before NL if required */
438 if (flags & topt_use_crlf) *chunk_ptr++ = '\r';
440 transport_newlines++;
442 /* The check_string test (formerly "from hack") replaces the specific
443 string at the start of a line with an escape string (e.g. "From " becomes
444 ">From " or "." becomes "..". It is a case-sensitive test. The length
445 check above ensures there is always enough room to insert this string. */
447 if (nl_check_length > 0)
449 if (left >= nl_check_length &&
450 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
452 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
453 chunk_ptr += nl_escape_length;
454 ptr += nl_check_length;
457 /* Handle the case when there isn't enough left to match the whole
458 check string, but there may be a partial match. We remember how many
459 characters matched, and finish processing this chunk. */
461 else if (left <= 0) nl_partial_match = 0;
463 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
465 nl_partial_match = left;
471 /* Not a NL character */
473 else *chunk_ptr++ = ch;
482 /*************************************************
483 * Generate address for RCPT TO *
484 *************************************************/
486 /* This function puts together an address for RCPT to, using the caseful
487 version of the local part and the caseful version of the domain. If there is no
488 prefix or suffix, or if affixes are to be retained, we can just use the
489 original address. Otherwise, if there is a prefix but no suffix we can use a
490 pointer into the original address. If there is a suffix, however, we have to
494 addr the address item
495 include_affixes TRUE if affixes are to be included
501 transport_rcpt_address(address_item *addr, BOOL include_affixes)
508 setflag(addr, af_include_affixes); /* Affects logged => line */
509 return addr->address;
512 if (addr->suffix == NULL)
514 if (addr->prefix == NULL) return addr->address;
515 return addr->address + Ustrlen(addr->prefix);
518 at = Ustrrchr(addr->address, '@');
519 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
520 slen = Ustrlen(addr->suffix);
522 return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
523 addr->address + plen, at + 1);
527 /*************************************************
528 * Output Envelope-To: address & scan duplicates *
529 *************************************************/
531 /* This function is called from internal_transport_write_message() below, when
532 generating an Envelope-To: header line. It checks for duplicates of the given
533 address and its ancestors. When one is found, this function calls itself
534 recursively, to output the envelope address of the duplicate.
536 We want to avoid duplication in the list, which can arise for example when
537 A->B,C and then both B and C alias to D. This can also happen when there are
538 unseen drivers in use. So a list of addresses that have been output is kept in
541 It is also possible to have loops in the address ancestry/duplication graph,
542 for example if there are two top level addresses A and B and we have A->B,C and
543 B->A. To break the loop, we use a list of processed addresses in the dlist
546 After handling duplication, this function outputs the progenitor of the given
550 p the address we are interested in
551 pplist address of anchor of the list of addresses not to output
552 pdlist address of anchor of the list of processed addresses
553 first TRUE if this is the first address; set it FALSE afterwards
554 fd the file descriptor to write to
555 flags to be passed on to write_chunk()
557 Returns: FALSE if writing failed
561 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
562 BOOL *first, int fd, unsigned flags)
567 /* Do nothing if we have already handled this address. If not, remember it
568 so that we don't handle it again. */
570 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
572 ppp = store_get(sizeof(struct aci));
577 /* Now scan up the ancestry, checking for duplicates at each generation. */
579 for (pp = p;; pp = pp->parent)
582 for (dup = addr_duplicate; dup; dup = dup->next)
583 if (dup->dupof == pp) /* a dup of our address */
584 if (!write_env_to(dup, pplist, pdlist, first, fd, flags))
586 if (!pp->parent) break;
589 /* Check to see if we have already output the progenitor. */
591 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
592 if (ppp) return TRUE;
594 /* Remember what we have output, and output it. */
596 ppp = store_get(sizeof(struct aci));
601 if (!*first && !write_chunk(fd, US",\n ", 3, flags)) return FALSE;
603 return write_chunk(fd, pp->address, Ustrlen(pp->address), flags);
609 /* Add/remove/rewwrite headers, and send them plus the empty-line sparator.
615 addr (chain of) addresses (for extra headers), or NULL;
616 only the first address is used
617 fd file descriptor to write the message to
618 sendfn function for output (transport or verify)
619 use_crlf turn NL into CR LF
620 rewrite_rules chain of header rewriting rules
621 rewrite_existflags flags for the rewriting rules
623 Returns: TRUE on success; FALSE on failure.
626 transport_headers_send(address_item *addr, int fd, uschar *add_headers, uschar *remove_headers,
627 BOOL (*sendfn)(int fd, uschar * s, int len, unsigned options),
628 BOOL use_crlf, rewrite_rule *rewrite_rules, int rewrite_existflags)
631 unsigned wck_flags = use_crlf ? topt_use_bdat : 0;
633 /* Then the message's headers. Don't write any that are flagged as "old";
634 that means they were rewritten, or are a record of envelope rewriting, or
635 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
636 match any entries therein. It is a colon-sep list; expand the items
637 separately and squash any empty ones.
638 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
640 for (h = header_list; h; h = h->next) if (h->type != htype_old)
643 const uschar *list = remove_headers;
645 BOOL include_header = TRUE;
647 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
651 int sep = ':'; /* This is specified as a colon-separated list */
653 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
658 if (!(s = expand_string(s)) && !expand_string_forcedfail)
660 errno = ERRNO_CHHEADER_FAIL;
663 len = s ? Ustrlen(s) : 0;
664 if (strncmpic(h->text, s, len) != 0) continue;
666 while (*ss == ' ' || *ss == '\t') ss++;
667 if (*ss == ':') break;
669 if (s != NULL) { include_header = FALSE; break; }
671 if (addr != NULL) list = addr->prop.remove_headers;
674 /* If this header is to be output, try to rewrite it if there are rewriting
681 void *reset_point = store_get(0);
684 if ((hh = rewrite_header(h, NULL, NULL, rewrite_rules, rewrite_existflags, FALSE)))
686 if (!sendfn(fd, hh->text, hh->slen, wck_flags)) return FALSE;
687 store_reset(reset_point);
688 continue; /* With the next header line */
692 /* Either no rewriting rules, or it didn't get rewritten */
694 if (!sendfn(fd, h->text, h->slen, wck_flags)) return FALSE;
701 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
705 /* Add on any address-specific headers. If there are multiple addresses,
706 they will all have the same headers in order to be batched. The headers
707 are chained in reverse order of adding (so several addresses from the
708 same alias might share some of them) but we want to output them in the
709 opposite order. This is a bit tedious, but there shouldn't be very many
710 of them. We just walk the list twice, reversing the pointers each time,
711 but on the second time, write out the items.
713 Headers added to an address by a router are guaranteed to end with a newline.
719 header_line *hprev = addr->prop.extra_headers;
721 for (i = 0; i < 2; i++)
722 for (h = hprev, hprev = NULL; h; h = hnext)
729 if (!sendfn(fd, h->text, h->slen, wck_flags)) return FALSE;
731 debug_printf("added header line(s):\n%s---\n", h->text);
736 /* If a string containing additional headers exists it is a newline-sep
737 list. Expand each item and write out the result. This is done last so that
738 if it (deliberately or accidentally) isn't in header format, it won't mess
739 up any other headers. An empty string or a forced expansion failure are
740 noops. An added header string from a transport may not end with a newline;
741 add one if it does not. */
748 while ((s = string_nextinlist(CUSS &add_headers, &sep, NULL, 0)))
749 if ((s = expand_string(s)))
751 int len = Ustrlen(s);
754 if (!sendfn(fd, s, len, wck_flags)) return FALSE;
755 if (s[len-1] != '\n' && !sendfn(fd, US"\n", 1, wck_flags))
759 debug_printf("added header line:\n%s", s);
760 if (s[len-1] != '\n') debug_printf("\n");
761 debug_printf("---\n");
765 else if (!expand_string_forcedfail)
766 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
769 /* Separate headers from body with a blank line */
771 return sendfn(fd, US"\n", 1, wck_flags);
775 /*************************************************
776 * Write the message *
777 *************************************************/
779 /* This function writes the message to the given file descriptor. The headers
780 are in the in-store data structure, and the rest of the message is in the open
781 file descriptor deliver_datafile. Make sure we start it at the beginning.
783 . If add_return_path is TRUE, a "return-path:" header is added to the message,
784 containing the envelope sender's address.
786 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
787 giving the top-level envelope address that caused this delivery to happen.
789 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
790 message. It gives the time and date that delivery took place.
792 . If check_string is not null, the start of each line is checked for that
793 string. If it is found, it is replaced by escape_string. This used to be
794 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
796 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
798 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
799 any writing or reading error, leaving the code in errno intact. Error exits
800 can include timeouts for certain transports, which are requested by setting
801 transport_write_timeout non-zero.
804 addr (chain of) addresses (for extra headers), or NULL;
805 only the first address is used
806 fd file descriptor to write the message to
807 options bit-wise options:
808 add_return_path if TRUE, add a "return-path" header
809 add_envelope_to if TRUE, add a "envelope-to" header
810 add_delivery_date if TRUE, add a "delivery-date" header
811 use_crlf if TRUE, turn NL into CR LF
812 end_dot if TRUE, send a terminating "." line at the end
813 no_headers if TRUE, omit the headers
814 no_body if TRUE, omit the body
815 use_bdat if TRUE, prepend written data with RFC3030 BDAT hdrs
816 size_limit if > 0, this is a limit to the size of message written;
817 it is used when returning messages to their senders,
818 and is approximate rather than exact, owing to chunk
820 add_headers a string containing one or more headers to add; it is
821 expanded, and must be in correct RFC 822 format as
822 it is transmitted verbatim; NULL => no additions,
823 and so does empty string or forced expansion fail
824 remove_headers a colon-separated list of headers to remove, or NULL
825 check_string a string to check for at the start of lines, or NULL
826 escape_string a string to insert in front of any check string
827 rewrite_rules chain of header rewriting rules
828 rewrite_existflags flags for the rewriting rules
830 Returns: TRUE on success; FALSE (with errno) on failure.
831 In addition, the global variable transport_count
832 is incremented by the number of bytes written.
836 internal_transport_write_message(address_item *addr, int fd, int options,
837 int size_limit, uschar *add_headers, uschar *remove_headers, uschar *check_string,
838 uschar *escape_string, rewrite_rule *rewrite_rules, int rewrite_existflags)
841 unsigned wck_flags = (unsigned) options;
845 /* Initialize pointer in output buffer. */
847 chunk_ptr = deliver_out_buffer;
849 /* Set up the data for start-of-line data checking and escaping */
851 nl_partial_match = -1;
852 if (check_string && escape_string)
854 nl_check = check_string;
855 nl_check_length = Ustrlen(nl_check);
856 nl_escape = escape_string;
857 nl_escape_length = Ustrlen(nl_escape);
860 nl_check_length = nl_escape_length = 0;
862 /* Whether the escaping mechanism is applied to headers or not is controlled by
863 an option (set for SMTP, not otherwise). Negate the length if not wanted till
864 after the headers. */
866 if (!(options & topt_escape_headers))
867 nl_check_length = -nl_check_length;
869 /* Write the headers if required, including any that have to be added. If there
870 are header rewriting rules, apply them. */
872 if (!(options & topt_no_headers))
874 /* Add return-path: if requested. */
876 if (options & topt_add_return_path)
878 uschar buffer[ADDRESS_MAXLENGTH + 20];
879 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
881 if (!write_chunk(fd, buffer, n, wck_flags)) return FALSE;
884 /* Add envelope-to: if requested */
886 if (options & topt_add_envelope_to)
890 struct aci *plist = NULL;
891 struct aci *dlist = NULL;
892 void *reset_point = store_get(0);
894 if (!write_chunk(fd, US"Envelope-to: ", 13, wck_flags)) return FALSE;
896 /* Pick up from all the addresses. The plist and dlist variables are
897 anchors for lists of addresses already handled; they have to be defined at
898 this level becuase write_env_to() calls itself recursively. */
900 for (p = addr; p; p = p->next)
901 if (!write_env_to(p, &plist, &dlist, &first, fd, wck_flags))
904 /* Add a final newline and reset the store used for tracking duplicates */
906 if (!write_chunk(fd, US"\n", 1, wck_flags)) return FALSE;
907 store_reset(reset_point);
910 /* Add delivery-date: if requested. */
912 if (options & topt_add_delivery_date)
915 int n = sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
916 if (!write_chunk(fd, buffer, n, wck_flags)) return FALSE;
919 /* Then the message's headers. Don't write any that are flagged as "old";
920 that means they were rewritten, or are a record of envelope rewriting, or
921 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
922 match any entries therein. Then check addr->prop.remove_headers too, provided that
924 if (!transport_headers_send(addr, fd, add_headers, remove_headers, &write_chunk,
925 wck_flags, rewrite_rules, rewrite_existflags))
929 /* When doing RFC3030 CHUNKING output, work out how much data will be in the
930 last BDAT, consisting of the current write_chunk() output buffer fill
931 (optimally, all of the headers - but it does not matter if we already had to
932 flush that buffer with non-last BDAT prependix) plus the amount of body data
933 (as expanded for CRLF lines). Then create and write the BDAT, and ensure
934 that further use of write_chunk() will not prepend BDATs. */
936 if (options & topt_use_bdat)
938 if ((size = chunk_ptr - deliver_out_buffer) < 0)
940 if (!(options & topt_no_body))
942 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
943 fsize -= SPOOL_DATA_START_OFFSET;
944 if (size_limit > 0 && fsize > size_limit)
947 if (options & topt_use_crlf)
948 size += body_linecount; /* account for CRLF-expansion */
951 /*XXX need an smtp_outblock here; can't really use the smtp
952 tpts one. so that had better have been flushed.
954 WORRY: smtp cmd response sync, needs an inblock and a LOT
955 of tpt info. NEED a callback into the tpt.
958 smtp_write_command(&outblock, FALSE, "BDAT %d LAST\r\n", size);
959 if (count < 0) return FALSE;
966 wck_flags &= ~topt_use_bdat;
969 /* If the body is required, ensure that the data for check strings (formerly
970 the "from hack") is enabled by negating the length if necessary. (It will be
971 negative in cases where it isn't to apply to the headers). Then ensure the body
972 is positioned at the start of its file (following the message id), then write
973 it, applying the size limit if required. */
975 if (!(options & topt_no_body))
977 nl_check_length = abs(nl_check_length);
978 nl_partial_match = 0;
979 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
981 while ( (len = MAX(DELIVER_IN_BUFFER_SIZE, size)) > 0
982 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
983 if (!write_chunk(fd, deliver_in_buffer, len, wck_flags))
986 /* A read error on the body will have left len == -1 and errno set. */
988 if (len != 0) return FALSE;
991 /* Finished with the check string */
993 nl_check_length = nl_escape_length = 0;
995 /* If requested, add a terminating "." line (SMTP output). */
997 if (options & topt_end_dot && !write_chunk(fd, US".\n", 2, wck_flags))
1000 /* Write out any remaining data in the buffer before returning. */
1002 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1003 transport_write_block(fd, deliver_out_buffer, len);
1007 #ifndef DISABLE_DKIM
1009 /***************************************************************************************************
1010 * External interface to write the message, while signing it with DKIM and/or Domainkeys *
1011 ***************************************************************************************************/
1013 /* This function is a wrapper around transport_write_message().
1014 It is only called from the smtp transport if DKIM or Domainkeys support
1015 is compiled in. The function sets up a replacement fd into a -K file,
1016 then calls the normal function. This way, the exact bits that exim would
1017 have put "on the wire" will end up in the file (except for TLS
1018 encapsulation, which is the very very last thing). When we are done
1019 signing the file, send the signed message down the original fd (or TLS fd).
1022 as for internal_transport_write_message() above, with additional arguments
1025 Returns: TRUE on success; FALSE (with errno) for any failure
1029 dkim_transport_write_message(address_item *addr, int out_fd, int options,
1030 uschar *add_headers, uschar *remove_headers,
1031 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1032 int rewrite_existflags, struct ob_dkim * dkim)
1037 uschar * dkim_spool_name;
1040 uschar *dkim_signature = NULL;
1044 /* If we can't sign, just call the original function. */
1046 if (!(dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector))
1047 return transport_write_message(addr, out_fd, options,
1048 0, add_headers, remove_headers,
1049 check_string, escape_string, rewrite_rules,
1050 rewrite_existflags);
1052 dkim_spool_name = spool_fname(US"input", message_subdir, message_id,
1053 string_sprintf("-%d-K", (int)getpid()));
1055 if ((dkim_fd = Uopen(dkim_spool_name, O_RDWR|O_CREAT|O_TRUNC, SPOOL_MODE)) < 0)
1057 /* Can't create spool file. Ugh. */
1063 /* Call original function to write the -K file; does the CRLF expansion */
1065 rc = transport_write_message(addr, dkim_fd, options,
1066 0, add_headers, remove_headers,
1067 check_string, escape_string, rewrite_rules,
1068 rewrite_existflags);
1070 /* Save error state. We must clean up before returning. */
1077 if (dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector)
1079 /* Rewind file and feed it to the goats^W DKIM lib */
1080 lseek(dkim_fd, 0, SEEK_SET);
1081 dkim_signature = dkim_exim_sign(dkim_fd,
1082 dkim->dkim_private_key,
1084 dkim->dkim_selector,
1086 dkim->dkim_sign_headers);
1087 if (!dkim_signature)
1089 if (dkim->dkim_strict)
1091 uschar *dkim_strict_result = expand_string(dkim->dkim_strict);
1092 if (dkim_strict_result)
1093 if ( (strcmpic(dkim->dkim_strict,US"1") == 0) ||
1094 (strcmpic(dkim->dkim_strict,US"true") == 0) )
1096 /* Set errno to something halfway meaningful */
1097 save_errno = EACCES;
1098 log_write(0, LOG_MAIN, "DKIM: message could not be signed,"
1099 " and dkim_strict is set. Deferring message delivery.");
1111 siglen = Ustrlen(dkim_signature);
1115 wwritten = tls_out.active == out_fd
1116 ? tls_write(FALSE, dkim_signature, siglen)
1117 : write(out_fd, dkim_signature, siglen);
1119 wwritten = write(out_fd, dkim_signature, siglen);
1123 /* error, bail out */
1129 dkim_signature += wwritten;
1133 #ifdef HAVE_LINUX_SENDFILE
1134 /* We can use sendfile() to shove the file contents
1135 to the socket. However only if we don't use TLS,
1136 as then there's another layer of indirection
1137 before the data finally hits the socket. */
1138 if (tls_out.active != out_fd)
1143 k_file_size = lseek(dkim_fd, 0, SEEK_END); /* Fetch file size */
1146 lseek(dkim_fd, 0, SEEK_SET);
1148 while(copied >= 0 && offset < k_file_size)
1149 copied = sendfile(out_fd, dkim_fd, &offset, k_file_size - offset);
1162 lseek(dkim_fd, 0, SEEK_SET);
1164 /* Send file down the original fd */
1165 while((sread = read(dkim_fd, deliver_out_buffer, DELIVER_OUT_BUFFER_SIZE)) >0)
1167 char *p = deliver_out_buffer;
1168 /* write the chunk */
1173 wwritten = tls_out.active == out_fd
1174 ? tls_write(FALSE, US p, sread)
1175 : write(out_fd, p, sread);
1177 wwritten = write(out_fd, p, sread);
1181 /* error, bail out */
1199 /* unlink -K file */
1200 (void)close(dkim_fd);
1201 Uunlink(dkim_spool_name);
1210 /*************************************************
1211 * External interface to write the message *
1212 *************************************************/
1214 /* If there is no filtering required, call the internal function above to do
1215 the real work, passing over all the arguments from this function. Otherwise,
1216 set up a filtering process, fork another process to call the internal function
1217 to write to the filter, and in this process just suck from the filter and write
1218 down the given fd. At the end, tidy up the pipes and the processes.
1220 Arguments: as for internal_transport_write_message() above
1222 Returns: TRUE on success; FALSE (with errno) for any failure
1223 transport_count is incremented by the number of bytes written
1227 transport_write_message(address_item *addr, int fd, int options,
1228 int size_limit, uschar *add_headers, uschar *remove_headers,
1229 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1230 int rewrite_existflags)
1233 BOOL last_filter_was_NL = TRUE;
1234 int rc, len, yield, fd_read, fd_write, save_errno;
1235 int pfd[2] = {-1, -1};
1236 pid_t filter_pid, write_pid;
1238 transport_filter_timed_out = FALSE;
1240 /* If there is no filter command set up, call the internal function that does
1241 the actual work, passing it the incoming fd, and return its result. */
1243 if ( !transport_filter_argv
1244 || !*transport_filter_argv
1245 || !**transport_filter_argv
1247 return internal_transport_write_message(addr, fd, options, size_limit,
1248 add_headers, remove_headers, check_string, escape_string,
1249 rewrite_rules, rewrite_existflags);
1251 /* Otherwise the message must be written to a filter process and read back
1252 before being written to the incoming fd. First set up the special processing to
1253 be done during the copying. */
1255 wck_flags = options & topt_use_crlf;
1256 nl_partial_match = -1;
1258 if (check_string != NULL && escape_string != NULL)
1260 nl_check = check_string;
1261 nl_check_length = Ustrlen(nl_check);
1262 nl_escape = escape_string;
1263 nl_escape_length = Ustrlen(nl_escape);
1265 else nl_check_length = nl_escape_length = 0;
1267 /* Start up a subprocess to run the command. Ensure that our main fd will
1268 be closed when the subprocess execs, but remove the flag afterwards.
1269 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1270 process to deliver another message.) We get back stdin/stdout file descriptors.
1271 If the process creation failed, give an error return. */
1277 write_pid = (pid_t)(-1);
1279 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1280 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1281 &fd_write, &fd_read, FALSE);
1282 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
1283 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1286 debug_printf("process %d running as transport filter: write=%d read=%d\n",
1287 (int)filter_pid, fd_write, fd_read);
1289 /* Fork subprocess to write the message to the filter, and return the result
1290 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1291 smtp dots, or check string processing. */
1293 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1294 if ((write_pid = fork()) == 0)
1297 (void)close(fd_read);
1298 (void)close(pfd[pipe_read]);
1299 nl_check_length = nl_escape_length = 0;
1300 rc = internal_transport_write_message(addr, fd_write,
1301 (options & ~(topt_use_crlf | topt_end_dot)),
1302 size_limit, add_headers, remove_headers, NULL, NULL,
1303 rewrite_rules, rewrite_existflags);
1305 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1307 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1309 || write(pfd[pipe_write], (void *)&(addr->more_errno), sizeof(int))
1312 rc = FALSE; /* compiler quietening */
1317 /* Parent process: close our copy of the writing subprocess' pipes. */
1319 (void)close(pfd[pipe_write]);
1320 (void)close(fd_write);
1323 /* Writing process creation failed */
1327 errno = save_errno; /* restore */
1331 /* When testing, let the subprocess get going */
1333 if (running_in_test_harness) millisleep(250);
1336 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1338 /* Copy the message from the filter to the output fd. A read error leaves len
1339 == -1 and errno set. We need to apply a timeout to the read, to cope with
1340 the case when the filter gets stuck, but it can be quite a long one. The
1341 default is 5m, but this is now configurable. */
1343 DEBUG(D_transport) debug_printf("copying from the filter\n");
1345 /* Copy the output of the filter, remembering if the last character was NL. If
1346 no data is returned, that counts as "ended with NL" (default setting of the
1347 variable is TRUE). */
1349 chunk_ptr = deliver_out_buffer;
1353 sigalrm_seen = FALSE;
1354 alarm(transport_filter_timeout);
1355 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1360 transport_filter_timed_out = TRUE;
1364 /* If the read was successful, write the block down the original fd,
1365 remembering whether it ends in \n or not. */
1369 if (!write_chunk(fd, deliver_in_buffer, len, wck_flags)) goto TIDY_UP;
1370 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1373 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1377 if (len == 0) yield = TRUE;
1382 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1383 to something. Ensure the pipes are all closed and the processes are removed. If
1384 there has been an error, kill the processes before waiting for them, just to be
1385 sure. Also apply a paranoia timeout. */
1390 (void)close(fd_read);
1391 if (fd_write > 0) (void)close(fd_write);
1395 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1396 if (write_pid > 0) kill(write_pid, SIGKILL);
1399 /* Wait for the filter process to complete. */
1401 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1402 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1405 save_errno = ERRNO_FILTER_FAIL;
1406 addr->more_errno = rc;
1407 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1410 /* Wait for the writing process to complete. If it ends successfully,
1411 read the results from its pipe, provided we haven't already had a filter
1414 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1417 rc = child_close(write_pid, 30);
1423 int dummy = read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
1426 dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1427 dummy = read(pfd[pipe_read], (void *)&(addr->more_errno), sizeof(int));
1434 save_errno = ERRNO_FILTER_FAIL;
1435 addr->more_errno = rc;
1436 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1440 (void)close(pfd[pipe_read]);
1442 /* If there have been no problems we can now add the terminating "." if this is
1443 SMTP output, turning off escaping beforehand. If the last character from the
1444 filter was not NL, insert a NL to make the SMTP protocol work. */
1448 nl_check_length = nl_escape_length = 0;
1449 if ( options & topt_end_dot
1450 && ( last_filter_was_NL
1451 ? !write_chunk(fd, US".\n", 2, wck_flags)
1452 : !write_chunk(fd, US"\n.\n", 3, wck_flags)
1456 /* Write out any remaining data in the buffer. */
1459 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1460 || transport_write_block(fd, deliver_out_buffer, len);
1463 errno = save_errno; /* From some earlier error */
1467 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1469 debug_printf("errno=%d more_errno=%d\n", errno, addr->more_errno);
1479 /*************************************************
1480 * Update waiting database *
1481 *************************************************/
1483 /* This is called when an address is deferred by remote transports that are
1484 capable of sending more than one message over one connection. A database is
1485 maintained for each transport, keeping track of which messages are waiting for
1486 which hosts. The transport can then consult this when eventually a successful
1487 delivery happens, and if it finds that another message is waiting for the same
1488 host, it can fire up a new process to deal with it using the same connection.
1490 The database records are keyed by host name. They can get full if there are
1491 lots of messages waiting, and so there is a continuation mechanism for them.
1493 Each record contains a list of message ids, packed end to end without any
1494 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1495 in this record, and the sequence field says if there are any other records for
1496 this host. If the sequence field is 0, there are none. If it is 1, then another
1497 record with the name <hostname>:0 exists; if it is 2, then two other records
1498 with sequence numbers 0 and 1 exist, and so on.
1500 Currently, an exhaustive search of all continuation records has to be done to
1501 determine whether to add a message id to a given record. This shouldn't be
1502 too bad except in extreme cases. I can't figure out a *simple* way of doing
1505 Old records should eventually get swept up by the exim_tidydb utility.
1508 hostlist list of hosts that this message could be sent to
1509 tpname name of the transport
1515 transport_update_waiting(host_item *hostlist, uschar *tpname)
1518 const uschar *prevname = US"";
1523 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1525 /* Open the database for this transport */
1527 sprintf(CS buffer, "wait-%.200s", tpname);
1528 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1529 if (dbm_file == NULL) return;
1531 /* Scan the list of hosts for which this message is waiting, and ensure
1532 that the message id is in each host record. */
1534 for (host = hostlist; host!= NULL; host = host->next)
1536 BOOL already = FALSE;
1537 dbdata_wait *host_record;
1541 /* Skip if this is the same host as we just processed; otherwise remember
1542 the name for next time. */
1544 if (Ustrcmp(prevname, host->name) == 0) continue;
1545 prevname = host->name;
1547 /* Look up the host record; if there isn't one, make an empty one. */
1549 host_record = dbfn_read(dbm_file, host->name);
1550 if (host_record == NULL)
1552 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1553 host_record->count = host_record->sequence = 0;
1556 /* Compute the current length */
1558 host_length = host_record->count * MESSAGE_ID_LENGTH;
1560 /* Search the record to see if the current message is already in it. */
1562 for (s = host_record->text; s < host_record->text + host_length;
1563 s += MESSAGE_ID_LENGTH)
1565 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1566 { already = TRUE; break; }
1569 /* If we haven't found this message in the main record, search any
1570 continuation records that exist. */
1572 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1575 sprintf(CS buffer, "%.200s:%d", host->name, i);
1576 cont = dbfn_read(dbm_file, buffer);
1579 int clen = cont->count * MESSAGE_ID_LENGTH;
1580 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1582 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1583 { already = TRUE; break; }
1588 /* If this message is already in a record, no need to update. */
1592 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1597 /* If this record is full, write it out with a new name constructed
1598 from the sequence number, increase the sequence number, and empty
1601 if (host_record->count >= WAIT_NAME_MAX)
1603 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1604 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1605 host_record->sequence++;
1606 host_record->count = 0;
1610 /* If this record is not full, increase the size of the record to
1611 allow for one new message id. */
1616 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1617 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1621 /* Now add the new name on the end */
1623 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1624 host_record->count++;
1625 host_length += MESSAGE_ID_LENGTH;
1627 /* Update the database */
1629 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1630 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1635 dbfn_close(dbm_file);
1641 /*************************************************
1642 * Test for waiting messages *
1643 *************************************************/
1645 /* This function is called by a remote transport which uses the previous
1646 function to remember which messages are waiting for which remote hosts. It's
1647 called after a successful delivery and its job is to check whether there is
1648 another message waiting for the same host. However, it doesn't do this if the
1649 current continue sequence is greater than the maximum supplied as an argument,
1650 or greater than the global connection_max_messages, which, if set, overrides.
1653 transport_name name of the transport
1654 hostname name of the host
1655 local_message_max maximum number of messages down one connection
1656 as set by the caller transport
1657 new_message_id set to the message id of a waiting message
1658 more set TRUE if there are yet more messages waiting
1659 oicf_func function to call to validate if it is ok to send
1660 to this message_id from the current instance.
1661 oicf_data opaque data for oicf_func
1663 Returns: TRUE if new_message_id set; FALSE otherwise
1666 typedef struct msgq_s
1668 uschar message_id [MESSAGE_ID_LENGTH + 1];
1673 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1674 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1676 dbdata_wait *host_record;
1683 struct stat statbuf;
1689 debug_printf("transport_check_waiting entered\n");
1690 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1691 continue_sequence, local_message_max, connection_max_messages);
1694 /* Do nothing if we have hit the maximum number that can be send down one
1697 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1698 if (local_message_max > 0 && continue_sequence >= local_message_max)
1701 debug_printf("max messages for one connection reached: returning\n");
1705 /* Open the waiting information database. */
1707 sprintf(CS buffer, "wait-%.200s", transport_name);
1708 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1709 if (dbm_file == NULL) return FALSE;
1711 /* See if there is a record for this host; if not, there's nothing to do. */
1713 if (!(host_record = dbfn_read(dbm_file, hostname)))
1715 dbfn_close(dbm_file);
1716 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1720 /* If the data in the record looks corrupt, just log something and
1721 don't try to use it. */
1723 if (host_record->count > WAIT_NAME_MAX)
1725 dbfn_close(dbm_file);
1726 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1727 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1731 /* Scan the message ids in the record from the end towards the beginning,
1732 until one is found for which a spool file actually exists. If the record gets
1733 emptied, delete it and continue with any continuation records that may exist.
1736 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1737 but the 1 off will remain without it. This code now allows me to SKIP over
1738 a message I do not want to send out on this run. */
1740 host_length = host_record->count * MESSAGE_ID_LENGTH;
1746 int msgq_actual = 0;
1747 BOOL bFound = FALSE;
1748 BOOL bContinuation = FALSE;
1750 /* create an array to read entire message queue into memory for processing */
1752 msgq = (msgq_t*) malloc(sizeof(msgq_t) * host_record->count);
1753 msgq_count = host_record->count;
1754 msgq_actual = msgq_count;
1756 for (i = 0; i < host_record->count; ++i)
1758 msgq[i].bKeep = TRUE;
1760 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1762 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1765 /* first thing remove current message id if it exists */
1767 for (i = 0; i < msgq_count; ++i)
1768 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1770 msgq[i].bKeep = FALSE;
1774 /* now find the next acceptable message_id */
1776 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1780 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1783 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1785 msgq[i].bKeep = FALSE;
1786 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1788 Ustrcpy(new_message_id, msgq[i].message_id);
1789 msgq[i].bKeep = FALSE;
1796 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1800 /* reassemble the host record, based on removed message ids, from in
1803 if (msgq_actual <= 0)
1806 host_record->count = 0;
1810 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1811 host_record->count = msgq_actual;
1813 if (msgq_actual < msgq_count)
1816 for (new_count = 0, i = 0; i < msgq_count; ++i)
1818 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1819 msgq[i].message_id, MESSAGE_ID_LENGTH);
1821 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1825 /* Jeremy: check for a continuation record, this code I do not know how to
1826 test but the code should work */
1828 while (host_length <= 0)
1831 dbdata_wait * newr = NULL;
1833 /* Search for a continuation */
1835 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1837 sprintf(CS buffer, "%.200s:%d", hostname, i);
1838 newr = dbfn_read(dbm_file, buffer);
1841 /* If no continuation, delete the current and break the loop */
1845 dbfn_delete(dbm_file, hostname);
1849 /* Else replace the current with the continuation */
1851 dbfn_delete(dbm_file, buffer);
1853 host_length = host_record->count * MESSAGE_ID_LENGTH;
1855 bContinuation = TRUE;
1858 if (bFound) /* Usual exit from main loop */
1864 /* If host_length <= 0 we have emptied a record and not found a good message,
1865 and there are no continuation records. Otherwise there is a continuation
1866 record to process. */
1868 if (host_length <= 0)
1870 dbfn_close(dbm_file);
1871 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1875 /* we were not able to find an acceptable message, nor was there a
1876 * continuation record. So bug out, outer logic will clean this up.
1881 Ustrcpy(new_message_id, message_id);
1882 dbfn_close(dbm_file);
1887 } /* we need to process a continuation record */
1889 /* Control gets here when an existing message has been encountered; its
1890 id is in new_message_id, and host_length is the revised length of the
1891 host record. If it is zero, the record has been removed. Update the
1892 record if required, close the database, and return TRUE. */
1894 if (host_length > 0)
1896 host_record->count = host_length/MESSAGE_ID_LENGTH;
1898 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1902 dbfn_close(dbm_file);
1906 /*************************************************
1907 * Deliver waiting message down same socket *
1908 *************************************************/
1910 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1911 get a clean delivery process, and to regain root privilege in cases where it
1912 has been given away.
1915 transport_name to pass to the new process
1918 id the new message to process
1919 socket_fd the connected socket
1921 Returns: FALSE if fork fails; TRUE otherwise
1925 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1926 const uschar *hostaddress, uschar *id, int socket_fd)
1931 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1933 if ((pid = fork()) == 0)
1936 const uschar **argv;
1938 /* Disconnect entirely from the parent process. If we are running in the
1939 test harness, wait for a bit to allow the previous process time to finish,
1940 write the log, etc., so that the output is always in the same order for
1941 automatic comparison. */
1943 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
1944 if (running_in_test_harness) sleep(1);
1946 /* Set up the calling arguments; use the standard function for the basics,
1947 but we have a number of extras that may be added. */
1949 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1951 if (smtp_use_dsn) argv[i++] = US"-MCD";
1953 if (smtp_authenticated) argv[i++] = US"-MCA";
1956 if (tls_offered) argv[i++] = US"-MCT";
1959 if (smtp_use_size) argv[i++] = US"-MCS";
1960 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1962 if (queue_run_pid != (pid_t)0)
1964 argv[i++] = US"-MCQ";
1965 argv[i++] = string_sprintf("%d", queue_run_pid);
1966 argv[i++] = string_sprintf("%d", queue_run_pipe);
1969 argv[i++] = US"-MC";
1970 argv[i++] = US transport_name;
1971 argv[i++] = US hostname;
1972 argv[i++] = US hostaddress;
1973 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1977 /* Arrange for the channel to be on stdin. */
1981 (void)dup2(socket_fd, 0);
1982 (void)close(socket_fd);
1985 DEBUG(D_exec) debug_print_argv(argv);
1986 exim_nullstd(); /* Ensure std{out,err} exist */
1987 execv(CS argv[0], (char *const *)argv);
1989 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1990 _exit(errno); /* Note: must be _exit(), NOT exit() */
1993 /* If the process creation succeeded, wait for the first-level child, which
1994 immediately exits, leaving the second level process entirely disconnected from
2000 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
2001 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
2006 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
2014 /*************************************************
2015 * Set up direct (non-shell) command *
2016 *************************************************/
2018 /* This function is called when a command line is to be parsed and executed
2019 directly, without the use of /bin/sh. It is called by the pipe transport,
2020 the queryprogram router, and also from the main delivery code when setting up a
2021 transport filter process. The code for ETRN also makes use of this; in that
2022 case, no addresses are passed.
2025 argvptr pointer to anchor for argv vector
2026 cmd points to the command string (modified IN PLACE)
2027 expand_arguments true if expansion is to occur
2028 expand_failed error value to set if expansion fails; not relevant if
2030 addr chain of addresses, or NULL
2031 etext text for use in error messages
2032 errptr where to put error message if addr is NULL;
2033 otherwise it is put in the first address
2035 Returns: TRUE if all went well; otherwise an error will be
2036 set in the first address and FALSE returned
2040 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2041 BOOL expand_arguments, int expand_failed, address_item *addr,
2042 uschar *etext, uschar **errptr)
2045 const uschar **argv;
2047 int address_count = 0;
2051 /* Get store in which to build an argument list. Count the number of addresses
2052 supplied, and allow for that many arguments, plus an additional 60, which
2053 should be enough for anybody. Multiple addresses happen only when the local
2054 delivery batch option is set. */
2056 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2057 max_args = address_count + 60;
2058 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2060 /* Split the command up into arguments terminated by white space. Lose
2061 trailing space at the start and end. Double-quoted arguments can contain \\ and
2062 \" escapes and so can be handled by the standard function; single-quoted
2063 arguments are verbatim. Copy each argument into a new string. */
2066 while (isspace(*s)) s++;
2068 while (*s != 0 && argcount < max_args)
2073 while (*ss != 0 && *ss != '\'') ss++;
2074 argv[argcount++] = ss = store_get(ss - s++);
2075 while (*s != 0 && *s != '\'') *ss++ = *s++;
2079 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2080 while (isspace(*s)) s++;
2083 argv[argcount] = (uschar *)0;
2085 /* If *s != 0 we have run out of argument slots. */
2089 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2093 addr->transport_return = FAIL;
2094 addr->message = msg;
2100 /* Expand each individual argument if required. Expansion happens for pipes set
2101 up in filter files and with directly-supplied commands. It does not happen if
2102 the pipe comes from a traditional .forward file. A failing expansion is a big
2103 disaster if the command came from Exim's configuration; if it came from a user
2104 it is just a normal failure. The expand_failed value is used as the error value
2105 to cater for these two cases.
2107 An argument consisting just of the text "$pipe_addresses" is treated specially.
2108 It is not passed to the general expansion function. Instead, it is replaced by
2109 a number of arguments, one for each address. This avoids problems with shell
2110 metacharacters and spaces in addresses.
2112 If the parent of the top address has an original part of "system-filter", this
2113 pipe was set up by the system filter, and we can permit the expansion of
2118 debug_printf("direct command:\n");
2119 for (i = 0; argv[i] != (uschar *)0; i++)
2120 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2123 if (expand_arguments)
2125 BOOL allow_dollar_recipients = addr != NULL &&
2126 addr->parent != NULL &&
2127 Ustrcmp(addr->parent->address, "system-filter") == 0;
2129 for (i = 0; argv[i] != (uschar *)0; i++)
2132 /* Handle special fudge for passing an address list */
2135 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2136 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2140 if (argcount + address_count - 1 > max_args)
2142 addr->transport_return = FAIL;
2143 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2144 "in %s", cmd, etext);
2148 additional = address_count - 1;
2150 memmove(argv + i + 1 + additional, argv + i + 1,
2151 (argcount - i)*sizeof(uschar *));
2153 for (ad = addr; ad != NULL; ad = ad->next) {
2154 argv[i++] = ad->address;
2158 /* Subtract one since we replace $pipe_addresses */
2163 /* Handle special case of $address_pipe when af_force_command is set */
2165 else if (addr != NULL && testflag(addr,af_force_command) &&
2166 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2167 Ustrcmp(argv[i], "${address_pipe}") == 0))
2170 int address_pipe_argcount = 0;
2171 int address_pipe_max_args;
2172 uschar **address_pipe_argv;
2174 /* We can never have more then the argv we will be loading into */
2175 address_pipe_max_args = max_args - argcount + 1;
2178 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2180 /* We allocate an additional for (uschar *)0 */
2181 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2183 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2184 s = expand_string(addr->local_part + 1);
2186 if (s == NULL || *s == '\0')
2188 addr->transport_return = FAIL;
2189 addr->message = string_sprintf("Expansion of \"%s\" "
2190 "from command \"%s\" in %s failed: %s",
2191 (addr->local_part + 1), cmd, etext, expand_string_message);
2195 while (isspace(*s)) s++; /* strip leading space */
2197 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2202 while (*ss != 0 && *ss != '\'') ss++;
2203 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2204 while (*s != 0 && *s != '\'') *ss++ = *s++;
2208 else address_pipe_argv[address_pipe_argcount++] =
2209 string_copy(string_dequote(CUSS &s));
2210 while (isspace(*s)) s++; /* strip space after arg */
2213 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2215 /* If *s != 0 we have run out of argument slots. */
2218 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2219 "\"%s\" in %s", addr->local_part + 1, etext);
2222 addr->transport_return = FAIL;
2223 addr->message = msg;
2229 /* address_pipe_argcount - 1
2230 * because we are replacing $address_pipe in the argument list
2231 * with the first thing it expands to */
2232 if (argcount + address_pipe_argcount - 1 > max_args)
2234 addr->transport_return = FAIL;
2235 addr->message = string_sprintf("Too many arguments to command "
2236 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2240 /* If we are not just able to replace the slot that contained
2241 * $address_pipe (address_pipe_argcount == 1)
2242 * We have to move the existing argv by address_pipe_argcount - 1
2243 * Visually if address_pipe_argcount == 2:
2244 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2245 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2247 if (address_pipe_argcount > 1)
2249 /* current position + additonal args */
2250 argv + i + address_pipe_argcount,
2251 /* current position + 1 (for the (uschar *)0 at the end) */
2253 /* -1 for the (uschar *)0 at the end)*/
2254 (argcount - i)*sizeof(uschar *)
2257 /* Now we fill in the slots we just moved argv out of
2258 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2260 for (address_pipe_i = 0;
2261 address_pipe_argv[address_pipe_i] != (uschar *)0;
2264 argv[i++] = address_pipe_argv[address_pipe_i];
2268 /* Subtract one since we replace $address_pipe */
2273 /* Handle normal expansion string */
2277 const uschar *expanded_arg;
2278 enable_dollar_recipients = allow_dollar_recipients;
2279 expanded_arg = expand_cstring(argv[i]);
2280 enable_dollar_recipients = FALSE;
2282 if (expanded_arg == NULL)
2284 uschar *msg = string_sprintf("Expansion of \"%s\" "
2285 "from command \"%s\" in %s failed: %s",
2286 argv[i], cmd, etext, expand_string_message);
2289 addr->transport_return = expand_failed;
2290 addr->message = msg;
2295 argv[i] = expanded_arg;
2301 debug_printf("direct command after expansion:\n");
2302 for (i = 0; argv[i] != (uschar *)0; i++)
2303 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2312 /* End of transport.c */