1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2014 */
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)) },
69 { "group", opt_expand_gid|opt_public,
70 (void *)offsetof(transport_instance, gid) },
71 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
72 (void *)offsetof(transport_instance, add_headers) },
73 { "headers_only", opt_bool|opt_public,
74 (void *)offsetof(transport_instance, headers_only) },
75 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
76 (void *)offsetof(transport_instance, remove_headers) },
77 { "headers_rewrite", opt_rewrite|opt_public,
78 (void *)offsetof(transport_instance, headers_rewrite) },
79 { "home_directory", opt_stringptr|opt_public,
80 (void *)offsetof(transport_instance, home_dir) },
81 { "initgroups", opt_bool|opt_public,
82 (void *)offsetof(transport_instance, initgroups) },
83 { "message_size_limit", opt_stringptr|opt_public,
84 (void *)offsetof(transport_instance, message_size_limit) },
85 { "rcpt_include_affixes", opt_bool|opt_public,
86 (void *)offsetof(transport_instance, rcpt_include_affixes) },
87 { "retry_use_local_part", opt_bool|opt_public,
88 (void *)offsetof(transport_instance, retry_use_local_part) },
89 { "return_path", opt_stringptr|opt_public,
90 (void *)(offsetof(transport_instance, return_path)) },
91 { "return_path_add", opt_bool|opt_public,
92 (void *)(offsetof(transport_instance, return_path_add)) },
93 { "shadow_condition", opt_stringptr|opt_public,
94 (void *)offsetof(transport_instance, shadow_condition) },
95 { "shadow_transport", opt_stringptr|opt_public,
96 (void *)offsetof(transport_instance, shadow) },
97 #ifdef EXPERIMENTAL_TPDA
98 { "tpda_delivery_action",opt_stringptr | opt_public,
99 (void *)offsetof(transport_instance, tpda_delivery_action) },
101 { "transport_filter", opt_stringptr|opt_public,
102 (void *)offsetof(transport_instance, filter_command) },
103 { "transport_filter_timeout", opt_time|opt_public,
104 (void *)offsetof(transport_instance, filter_timeout) },
105 { "user", opt_expand_uid|opt_public,
106 (void *)offsetof(transport_instance, uid) }
109 int optionlist_transports_size =
110 sizeof(optionlist_transports)/sizeof(optionlist);
113 /*************************************************
114 * Initialize transport list *
115 *************************************************/
117 /* Read the transports section of the configuration file, and set up a chain of
118 transport instances according to its contents. Each transport has generic
119 options and may also have its own private options. This function is only ever
120 called when transports == NULL. We use generic code in readconf to do most of
126 transport_instance *t;
128 readconf_driver_init(US"transport",
129 (driver_instance **)(&transports), /* chain anchor */
130 (driver_info *)transports_available, /* available drivers */
131 sizeof(transport_info), /* size of info block */
132 &transport_defaults, /* default values for generic options */
133 sizeof(transport_instance), /* size of instance block */
134 optionlist_transports, /* generic options */
135 optionlist_transports_size);
137 /* Now scan the configured transports and check inconsistencies. A shadow
138 transport is permitted only for local transports. */
140 for (t = transports; t != NULL; t = t->next)
144 if (t->shadow != NULL)
145 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
146 "shadow transport not allowed on non-local transport %s", t->name);
149 if (t->body_only && t->headers_only)
150 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
151 "%s transport: body_only and headers_only are mutually exclusive",
158 /*************************************************
159 * Write block of data *
160 *************************************************/
162 /* Subroutine called by write_chunk() and at the end of the message actually
163 to write a data block. Also called directly by some transports to write
164 additional data to the file descriptor (e.g. prefix, suffix).
166 If a transport wants data transfers to be timed, it sets a non-zero value in
167 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
168 be set for each block of data written from here. If time runs out, then write()
169 fails and provokes an error return. The caller can then inspect sigalrm_seen to
172 On some systems, if a quota is exceeded during the write, the yield is the
173 number of bytes written rather than an immediate error code. This also happens
174 on some systems in other cases, for example a pipe that goes away because the
175 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
176 get the error codes the first time.
178 The write() function is also interruptible; the Solaris 2.6 man page says:
180 If write() is interrupted by a signal before it writes any
181 data, it will return -1 with errno set to EINTR.
183 If write() is interrupted by a signal after it successfully
184 writes some data, it will return the number of bytes written.
186 To handle these cases, we want to restart the write() to output the remainder
187 of the data after a non-negative return from write(), except after a timeout.
188 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
189 proper error then occurs. In principle, after an interruption, the second
190 write() could suffer the same fate, but we do not want to continue for
191 evermore, so stick a maximum repetition count on the loop to act as a
195 fd file descriptor to write to
196 block block of bytes to write
197 len number of bytes to write
199 Returns: TRUE on success, FALSE on failure (with errno preserved);
200 transport_count is incremented by the number of bytes written
204 transport_write_block(int fd, uschar *block, int len)
206 int i, rc, save_errno;
207 int local_timeout = transport_write_timeout;
209 /* This loop is for handling incomplete writes and other retries. In most
210 normal cases, it is only ever executed once. */
212 for (i = 0; i < 100; i++)
215 debug_printf("writing data block fd=%d size=%d timeout=%d\n",
216 fd, len, local_timeout);
218 /* This code makes use of alarm() in order to implement the timeout. This
219 isn't a very tidy way of doing things. Using non-blocking I/O with select()
220 provides a neater approach. However, I don't know how to do this when TLS is
223 if (transport_write_timeout <= 0) /* No timeout wanted */
226 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
228 rc = write(fd, block, len);
232 /* Timeout wanted. */
236 alarm(local_timeout);
238 if (tls_out.active == fd) rc = tls_write(FALSE, block, len); else
240 rc = write(fd, block, len);
242 local_timeout = alarm(0);
250 /* Hopefully, the most common case is success, so test that first. */
252 if (rc == len) { transport_count += len; return TRUE; }
254 /* A non-negative return code is an incomplete write. Try again for the rest
255 of the block. If we have exactly hit the timeout, give up. */
261 transport_count += rc;
262 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
263 goto CHECK_TIMEOUT; /* A few lines below */
266 /* A negative return code with an EINTR error is another form of
267 incomplete write, zero bytes having been written */
269 if (save_errno == EINTR)
272 debug_printf("write interrupted before anything written\n");
273 goto CHECK_TIMEOUT; /* A few lines below */
276 /* A response of EAGAIN from write() is likely only in the case of writing
277 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
279 if (save_errno == EAGAIN)
282 debug_printf("write temporarily locked out, waiting 1 sec\n");
285 /* Before continuing to try another write, check that we haven't run out of
289 if (transport_write_timeout > 0 && local_timeout <= 0)
297 /* Otherwise there's been an error */
299 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
300 strerror(save_errno));
305 /* We've tried and tried and tried but still failed */
307 errno = ERRNO_WRITEINCOMPLETE;
314 /*************************************************
315 * Write formatted string *
316 *************************************************/
318 /* This is called by various transports. It is a convenience function.
323 ... arguments for format
325 Returns: the yield of transport_write_block()
329 transport_write_string(int fd, const char *format, ...)
332 va_start(ap, format);
333 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
334 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
336 return transport_write_block(fd, big_buffer, Ustrlen(big_buffer));
342 /*************************************************
343 * Write character chunk *
344 *************************************************/
346 /* Subroutine used by transport_write_message() to scan character chunks for
347 newlines and act appropriately. The object is to minimise the number of writes.
348 The output byte stream is buffered up in deliver_out_buffer, which is written
349 only when it gets full, thus minimizing write operations and TCP packets.
351 Static data is used to handle the case when the last character of the previous
352 chunk was NL, or matched part of the data that has to be escaped.
355 fd file descript to write to
356 chunk pointer to data to write
357 len length of data to write
358 usr_crlf TRUE if CR LF is wanted at the end of each line
360 In addition, the static nl_xxx variables must be set as required.
362 Returns: TRUE on success, FALSE on failure (with errno preserved)
366 write_chunk(int fd, uschar *chunk, int len, BOOL use_crlf)
368 uschar *start = chunk;
369 uschar *end = chunk + len;
370 register uschar *ptr;
371 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
373 /* The assumption is made that the check string will never stretch over move
374 than one chunk since the only time there are partial matches is when copying
375 the body in large buffers. There is always enough room in the buffer for an
376 escape string, since the loop below ensures this for each character it
377 processes, and it won't have stuck in the escape string if it left a partial
380 if (nl_partial_match >= 0)
382 if (nl_check_length > 0 && len >= nl_check_length &&
383 Ustrncmp(start, nl_check + nl_partial_match,
384 nl_check_length - nl_partial_match) == 0)
386 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
387 chunk_ptr += nl_escape_length;
388 start += nl_check_length - nl_partial_match;
391 /* The partial match was a false one. Insert the characters carried over
392 from the previous chunk. */
394 else if (nl_partial_match > 0)
396 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
397 chunk_ptr += nl_partial_match;
400 nl_partial_match = -1;
403 /* Now process the characters in the chunk. Whenever we hit a newline we check
404 for possible escaping. The code for the non-NL route should be as fast as
407 for (ptr = start; ptr < end; ptr++)
411 /* Flush the buffer if it has reached the threshold - we want to leave enough
412 room for the next uschar, plus a possible extra CR for an LF, plus the escape
415 if (chunk_ptr - deliver_out_buffer > mlen)
417 if (!transport_write_block(fd, deliver_out_buffer,
418 chunk_ptr - deliver_out_buffer))
420 chunk_ptr = deliver_out_buffer;
423 if ((ch = *ptr) == '\n')
425 int left = end - ptr - 1; /* count of chars left after NL */
427 /* Insert CR before NL if required */
429 if (use_crlf) *chunk_ptr++ = '\r';
431 transport_newlines++;
433 /* The check_string test (formerly "from hack") replaces the specific
434 string at the start of a line with an escape string (e.g. "From " becomes
435 ">From " or "." becomes "..". It is a case-sensitive test. The length
436 check above ensures there is always enough room to insert this string. */
438 if (nl_check_length > 0)
440 if (left >= nl_check_length &&
441 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
443 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
444 chunk_ptr += nl_escape_length;
445 ptr += nl_check_length;
448 /* Handle the case when there isn't enough left to match the whole
449 check string, but there may be a partial match. We remember how many
450 characters matched, and finish processing this chunk. */
452 else if (left <= 0) nl_partial_match = 0;
454 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
456 nl_partial_match = left;
462 /* Not a NL character */
464 else *chunk_ptr++ = ch;
473 /*************************************************
474 * Generate address for RCPT TO *
475 *************************************************/
477 /* This function puts together an address for RCPT to, using the caseful
478 version of the local part and the caseful version of the domain. If there is no
479 prefix or suffix, or if affixes are to be retained, we can just use the
480 original address. Otherwise, if there is a prefix but no suffix we can use a
481 pointer into the original address. If there is a suffix, however, we have to
485 addr the address item
486 include_affixes TRUE if affixes are to be included
492 transport_rcpt_address(address_item *addr, BOOL include_affixes)
499 setflag(addr, af_include_affixes); /* Affects logged => line */
500 return addr->address;
503 if (addr->suffix == NULL)
505 if (addr->prefix == NULL) return addr->address;
506 return addr->address + Ustrlen(addr->prefix);
509 at = Ustrrchr(addr->address, '@');
510 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
511 slen = Ustrlen(addr->suffix);
513 return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
514 addr->address + plen, at + 1);
518 /*************************************************
519 * Output Envelope-To: address & scan duplicates *
520 *************************************************/
522 /* This function is called from internal_transport_write_message() below, when
523 generating an Envelope-To: header line. It checks for duplicates of the given
524 address and its ancestors. When one is found, this function calls itself
525 recursively, to output the envelope address of the duplicate.
527 We want to avoid duplication in the list, which can arise for example when
528 A->B,C and then both B and C alias to D. This can also happen when there are
529 unseen drivers in use. So a list of addresses that have been output is kept in
532 It is also possible to have loops in the address ancestry/duplication graph,
533 for example if there are two top level addresses A and B and we have A->B,C and
534 B->A. To break the loop, we use a list of processed addresses in the dlist
537 After handling duplication, this function outputs the progenitor of the given
541 p the address we are interested in
542 pplist address of anchor of the list of addresses not to output
543 pdlist address of anchor of the list of processed addresses
544 first TRUE if this is the first address; set it FALSE afterwards
545 fd the file descriptor to write to
546 use_crlf to be passed on to write_chunk()
548 Returns: FALSE if writing failed
552 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
553 BOOL *first, int fd, BOOL use_crlf)
558 /* Do nothing if we have already handled this address. If not, remember it
559 so that we don't handle it again. */
561 for (ppp = *pdlist; ppp != NULL; ppp = ppp->next)
562 { if (p == ppp->ptr) return TRUE; }
564 ppp = store_get(sizeof(struct aci));
569 /* Now scan up the ancestry, checking for duplicates at each generation. */
571 for (pp = p;; pp = pp->parent)
574 for (dup = addr_duplicate; dup != NULL; dup = dup->next)
576 if (dup->dupof != pp) continue; /* Not a dup of our address */
577 if (!write_env_to(dup, pplist, pdlist, first, fd, use_crlf)) return FALSE;
579 if (pp->parent == NULL) break;
582 /* Check to see if we have already output the progenitor. */
584 for (ppp = *pplist; ppp != NULL; ppp = ppp->next)
585 { if (pp == ppp->ptr) break; }
586 if (ppp != NULL) return TRUE;
588 /* Remember what we have output, and output it. */
590 ppp = store_get(sizeof(struct aci));
595 if (!(*first) && !write_chunk(fd, US",\n ", 3, use_crlf)) return FALSE;
597 return write_chunk(fd, pp->address, Ustrlen(pp->address), use_crlf);
603 /* Add/remove/rewwrite headers, and send them plus the empty-line sparator.
609 addr (chain of) addresses (for extra headers), or NULL;
610 only the first address is used
611 fd file descriptor to write the message to
612 sendfn function for output
613 use_crlf turn NL into CR LF
614 rewrite_rules chain of header rewriting rules
615 rewrite_existflags flags for the rewriting rules
617 Returns: TRUE on success; FALSE on failure.
620 transport_headers_send(address_item *addr, int fd, uschar *add_headers, uschar *remove_headers,
621 BOOL (*sendfn)(int fd, uschar * s, int len, BOOL use_crlf),
622 BOOL use_crlf, rewrite_rule *rewrite_rules, int rewrite_existflags)
626 /* Then the message's headers. Don't write any that are flagged as "old";
627 that means they were rewritten, or are a record of envelope rewriting, or
628 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
629 match any entries therein. It is a colon-sep list; expand the items
630 separately and squash any empty ones.
631 Then check addr->p.remove_headers too, provided that addr is not NULL. */
633 for (h = header_list; h != NULL; h = h->next) if (h->type != htype_old)
636 uschar *list = remove_headers;
638 BOOL include_header = TRUE;
640 for (i = 0; i < 2; i++) /* For remove_headers && addr->p.remove_headers */
644 int sep = ':'; /* This is specified as a colon-separated list */
647 while ((s = string_nextinlist(&list, &sep, buffer, sizeof(buffer))))
652 if (!(s = expand_string(s)) && !expand_string_forcedfail)
654 errno = ERRNO_CHHEADER_FAIL;
658 if (strncmpic(h->text, s, len) != 0) continue;
660 while (*ss == ' ' || *ss == '\t') ss++;
661 if (*ss == ':') break;
663 if (s != NULL) { include_header = FALSE; break; }
665 if (addr != NULL) list = addr->p.remove_headers;
668 /* If this header is to be output, try to rewrite it if there are rewriting
675 void *reset_point = store_get(0);
678 if ((hh = rewrite_header(h, NULL, NULL, rewrite_rules, rewrite_existflags, FALSE)))
680 if (!sendfn(fd, hh->text, hh->slen, use_crlf)) return FALSE;
681 store_reset(reset_point);
682 continue; /* With the next header line */
686 /* Either no rewriting rules, or it didn't get rewritten */
688 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
695 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
699 /* Add on any address-specific headers. If there are multiple addresses,
700 they will all have the same headers in order to be batched. The headers
701 are chained in reverse order of adding (so several addresses from the
702 same alias might share some of them) but we want to output them in the
703 opposite order. This is a bit tedious, but there shouldn't be very many
704 of them. We just walk the list twice, reversing the pointers each time,
705 but on the second time, write out the items.
707 Headers added to an address by a router are guaranteed to end with a newline.
713 header_line *hprev = addr->p.extra_headers;
715 for (i = 0; i < 2; i++)
717 for (h = hprev, hprev = NULL; h != NULL; h = hnext)
724 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
726 debug_printf("added header line(s):\n%s---\n", h->text);
732 /* If a string containing additional headers exists it is a newline-sep
733 list. Expand each item and write out the result. This is done last so that
734 if it (deliberately or accidentally) isn't in header format, it won't mess
735 up any other headers. An empty string or a forced expansion failure are
736 noops. An added header string from a transport may not end with a newline;
737 add one if it does not. */
744 while ((s = string_nextinlist(&add_headers, &sep, NULL, 0)))
745 if (!(s = expand_string(s)))
747 if (!expand_string_forcedfail)
748 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
752 int len = Ustrlen(s);
755 if (!sendfn(fd, s, len, use_crlf)) return FALSE;
756 if (s[len-1] != '\n' && !sendfn(fd, US"\n", 1, use_crlf))
760 debug_printf("added header line:\n%s", s);
761 if (s[len-1] != '\n') debug_printf("\n");
762 debug_printf("---\n");
768 /* Separate headers from body with a blank line */
770 return sendfn(fd, US"\n", 1, use_crlf);
774 /*************************************************
775 * Write the message *
776 *************************************************/
778 /* This function writes the message to the given file descriptor. The headers
779 are in the in-store data structure, and the rest of the message is in the open
780 file descriptor deliver_datafile. Make sure we start it at the beginning.
782 . If add_return_path is TRUE, a "return-path:" header is added to the message,
783 containing the envelope sender's address.
785 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
786 giving the top-level envelope address that caused this delivery to happen.
788 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
789 message. It gives the time and date that delivery took place.
791 . If check_string is not null, the start of each line is checked for that
792 string. If it is found, it is replaced by escape_string. This used to be
793 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
795 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
797 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
798 any writing or reading error, leaving the code in errno intact. Error exits
799 can include timeouts for certain transports, which are requested by setting
800 transport_write_timeout non-zero.
803 addr (chain of) addresses (for extra headers), or NULL;
804 only the first address is used
805 fd file descriptor to write the message to
806 options bit-wise options:
807 add_return_path if TRUE, add a "return-path" header
808 add_envelope_to if TRUE, add a "envelope-to" header
809 add_delivery_date if TRUE, add a "delivery-date" header
810 use_crlf if TRUE, turn NL into CR LF
811 end_dot if TRUE, send a terminating "." line at the end
812 no_headers if TRUE, omit the headers
813 no_body if TRUE, omit the body
814 size_limit if > 0, this is a limit to the size of message written;
815 it is used when returning messages to their senders,
816 and is approximate rather than exact, owing to chunk
818 add_headers a string containing one or more headers to add; it is
819 expanded, and must be in correct RFC 822 format as
820 it is transmitted verbatim; NULL => no additions,
821 and so does empty string or forced expansion fail
822 remove_headers a colon-separated list of headers to remove, or NULL
823 check_string a string to check for at the start of lines, or NULL
824 escape_string a string to insert in front of any check string
825 rewrite_rules chain of header rewriting rules
826 rewrite_existflags flags for the rewriting rules
828 Returns: TRUE on success; FALSE (with errno) on failure.
829 In addition, the global variable transport_count
830 is incremented by the number of bytes written.
834 internal_transport_write_message(address_item *addr, int fd, int options,
835 int size_limit, uschar *add_headers, uschar *remove_headers, uschar *check_string,
836 uschar *escape_string, rewrite_rule *rewrite_rules, int rewrite_existflags)
840 BOOL use_crlf = (options & topt_use_crlf) != 0;
842 /* Initialize pointer in output buffer. */
844 chunk_ptr = deliver_out_buffer;
846 /* Set up the data for start-of-line data checking and escaping */
848 nl_partial_match = -1;
849 if (check_string != NULL && escape_string != NULL)
851 nl_check = check_string;
852 nl_check_length = Ustrlen(nl_check);
853 nl_escape = escape_string;
854 nl_escape_length = Ustrlen(nl_escape);
856 else nl_check_length = nl_escape_length = 0;
858 /* Whether the escaping mechanism is applied to headers or not is controlled by
859 an option (set for SMTP, not otherwise). Negate the length if not wanted till
860 after the headers. */
862 if ((options & topt_escape_headers) == 0) nl_check_length = -nl_check_length;
864 /* Write the headers if required, including any that have to be added. If there
865 are header rewriting rules, apply them. */
867 if ((options & topt_no_headers) == 0)
869 /* Add return-path: if requested. */
871 if ((options & topt_add_return_path) != 0)
873 uschar buffer[ADDRESS_MAXLENGTH + 20];
874 sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
876 if (!write_chunk(fd, buffer, Ustrlen(buffer), use_crlf)) return FALSE;
879 /* Add envelope-to: if requested */
881 if ((options & topt_add_envelope_to) != 0)
885 struct aci *plist = NULL;
886 struct aci *dlist = NULL;
887 void *reset_point = store_get(0);
889 if (!write_chunk(fd, US"Envelope-to: ", 13, use_crlf)) return FALSE;
891 /* Pick up from all the addresses. The plist and dlist variables are
892 anchors for lists of addresses already handled; they have to be defined at
893 this level becuase write_env_to() calls itself recursively. */
895 for (p = addr; p != NULL; p = p->next)
897 if (!write_env_to(p, &plist, &dlist, &first, fd, use_crlf)) return FALSE;
900 /* Add a final newline and reset the store used for tracking duplicates */
902 if (!write_chunk(fd, US"\n", 1, use_crlf)) return FALSE;
903 store_reset(reset_point);
906 /* Add delivery-date: if requested. */
908 if ((options & topt_add_delivery_date) != 0)
911 sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
912 if (!write_chunk(fd, buffer, Ustrlen(buffer), use_crlf)) return FALSE;
915 /* Then the message's headers. Don't write any that are flagged as "old";
916 that means they were rewritten, or are a record of envelope rewriting, or
917 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
918 match any entries therein. Then check addr->p.remove_headers too, provided that
920 if (!transport_headers_send(addr, fd, add_headers, remove_headers, &write_chunk,
921 use_crlf, rewrite_rules, rewrite_existflags))
925 /* If the body is required, ensure that the data for check strings (formerly
926 the "from hack") is enabled by negating the length if necessary. (It will be
927 negative in cases where it isn't to apply to the headers). Then ensure the body
928 is positioned at the start of its file (following the message id), then write
929 it, applying the size limit if required. */
931 if ((options & topt_no_body) == 0)
933 nl_check_length = abs(nl_check_length);
934 nl_partial_match = 0;
935 lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET);
936 while ((len = read(deliver_datafile, deliver_in_buffer,
937 DELIVER_IN_BUFFER_SIZE)) > 0)
939 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) return FALSE;
943 if (written > size_limit)
945 len = 0; /* Pretend EOF */
951 /* A read error on the body will have left len == -1 and errno set. */
953 if (len != 0) return FALSE;
956 /* Finished with the check string */
958 nl_check_length = nl_escape_length = 0;
960 /* If requested, add a terminating "." line (SMTP output). */
962 if ((options & topt_end_dot) != 0 && !write_chunk(fd, US".\n", 2, use_crlf))
965 /* Write out any remaining data in the buffer before returning. */
967 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
968 transport_write_block(fd, deliver_out_buffer, len);
974 /***************************************************************************************************
975 * External interface to write the message, while signing it with DKIM and/or Domainkeys *
976 ***************************************************************************************************/
978 /* This function is a wrapper around transport_write_message(). It is only called
979 from the smtp transport if DKIM or Domainkeys support is compiled in.
980 The function sets up a replacement fd into a -K file, then calls the normal
981 function. This way, the exact bits that exim would have put "on the wire" will
982 end up in the file (except for TLS encapsulation, which is the very
983 very last thing). When we are done signing the file, send the
984 signed message down the original fd (or TLS fd).
986 Arguments: as for internal_transport_write_message() above, with additional
988 uschar *dkim_private_key DKIM: The private key to use (filename or plain data)
989 uschar *dkim_domain DKIM: The domain to use
990 uschar *dkim_selector DKIM: The selector to use.
991 uschar *dkim_canon DKIM: The canonalization scheme to use, "simple" or "relaxed"
992 uschar *dkim_strict DKIM: What to do if signing fails: 1/true => throw error
993 0/false => send anyway
994 uschar *dkim_sign_headers DKIM: List of headers that should be included in signature
997 Returns: TRUE on success; FALSE (with errno) for any failure
1001 dkim_transport_write_message(address_item *addr, int fd, int options,
1002 int size_limit, uschar *add_headers, uschar *remove_headers,
1003 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1004 int rewrite_existflags, uschar *dkim_private_key, uschar *dkim_domain,
1005 uschar *dkim_selector, uschar *dkim_canon, uschar *dkim_strict, uschar *dkim_sign_headers
1011 uschar dkim_spool_name[256];
1015 uschar *dkim_signature = NULL;
1018 if (!( ((dkim_private_key != NULL) && (dkim_domain != NULL) && (dkim_selector != NULL)) )) {
1019 /* If we can't sign, just call the original function. */
1020 return transport_write_message(addr, fd, options,
1021 size_limit, add_headers, remove_headers,
1022 check_string, escape_string, rewrite_rules,
1023 rewrite_existflags);
1026 (void)string_format(dkim_spool_name, 256, "%s/input/%s/%s-%d-K",
1027 spool_directory, message_subdir, message_id, (int)getpid());
1028 dkim_fd = Uopen(dkim_spool_name, O_RDWR|O_CREAT|O_TRUNC, SPOOL_MODE);
1031 /* Can't create spool file. Ugh. */
1037 /* Call original function */
1038 rc = transport_write_message(addr, dkim_fd, options,
1039 size_limit, add_headers, remove_headers,
1040 check_string, escape_string, rewrite_rules,
1041 rewrite_existflags);
1043 /* Save error state. We must clean up before returning. */
1050 if ( (dkim_private_key != NULL) && (dkim_domain != NULL) && (dkim_selector != NULL) ) {
1051 /* Rewind file and feed it to the goats^W DKIM lib */
1052 lseek(dkim_fd, 0, SEEK_SET);
1053 dkim_signature = dkim_exim_sign(dkim_fd,
1059 if (dkim_signature == NULL) {
1060 if (dkim_strict != NULL) {
1061 uschar *dkim_strict_result = expand_string(dkim_strict);
1062 if (dkim_strict_result != NULL) {
1063 if ( (strcmpic(dkim_strict,US"1") == 0) ||
1064 (strcmpic(dkim_strict,US"true") == 0) ) {
1065 /* Set errno to something halfway meaningful */
1066 save_errno = EACCES;
1067 log_write(0, LOG_MAIN, "DKIM: message could not be signed, and dkim_strict is set. Deferring message delivery.");
1075 int siglen = Ustrlen(dkim_signature);
1078 if (tls_out.active == fd) wwritten = tls_write(FALSE, dkim_signature, siglen); else
1080 wwritten = write(fd,dkim_signature,siglen);
1081 if (wwritten == -1) {
1082 /* error, bail out */
1088 dkim_signature += wwritten;
1093 /* Fetch file positition (the size) */
1094 size = lseek(dkim_fd,0,SEEK_CUR);
1097 lseek(dkim_fd, 0, SEEK_SET);
1099 #ifdef HAVE_LINUX_SENDFILE
1100 /* We can use sendfile() to shove the file contents
1101 to the socket. However only if we don't use TLS,
1102 in which case theres another layer of indirection
1103 before the data finally hits the socket. */
1104 if (tls_out.active != fd)
1108 while((copied >= 0) && (offset<size))
1110 copied = sendfile(fd, dkim_fd, &offset, (size - offset));
1121 /* Send file down the original fd */
1122 while((sread = read(dkim_fd,sbuf,2048)) > 0)
1125 /* write the chunk */
1128 if (tls_out.active == fd) wwritten = tls_write(FALSE, US p, sread); else
1130 wwritten = write(fd,p,sread);
1133 /* error, bail out */
1138 if (wwritten < sread)
1140 /* short write, try again */
1155 /* unlink -K file */
1156 (void)close(dkim_fd);
1157 Uunlink(dkim_spool_name);
1166 /*************************************************
1167 * External interface to write the message *
1168 *************************************************/
1170 /* If there is no filtering required, call the internal function above to do
1171 the real work, passing over all the arguments from this function. Otherwise,
1172 set up a filtering process, fork another process to call the internal function
1173 to write to the filter, and in this process just suck from the filter and write
1174 down the given fd. At the end, tidy up the pipes and the processes.
1176 Arguments: as for internal_transport_write_message() above
1178 Returns: TRUE on success; FALSE (with errno) for any failure
1179 transport_count is incremented by the number of bytes written
1183 transport_write_message(address_item *addr, int fd, int options,
1184 int size_limit, uschar *add_headers, uschar *remove_headers,
1185 uschar *check_string, uschar *escape_string, rewrite_rule *rewrite_rules,
1186 int rewrite_existflags)
1189 BOOL last_filter_was_NL = TRUE;
1190 int rc, len, yield, fd_read, fd_write, save_errno;
1192 pid_t filter_pid, write_pid;
1194 transport_filter_timed_out = FALSE;
1196 /* If there is no filter command set up, call the internal function that does
1197 the actual work, passing it the incoming fd, and return its result. */
1199 if (transport_filter_argv == NULL)
1200 return internal_transport_write_message(addr, fd, options, size_limit,
1201 add_headers, remove_headers, check_string, escape_string,
1202 rewrite_rules, rewrite_existflags);
1204 /* Otherwise the message must be written to a filter process and read back
1205 before being written to the incoming fd. First set up the special processing to
1206 be done during the copying. */
1208 use_crlf = (options & topt_use_crlf) != 0;
1209 nl_partial_match = -1;
1211 if (check_string != NULL && escape_string != NULL)
1213 nl_check = check_string;
1214 nl_check_length = Ustrlen(nl_check);
1215 nl_escape = escape_string;
1216 nl_escape_length = Ustrlen(nl_escape);
1218 else nl_check_length = nl_escape_length = 0;
1220 /* Start up a subprocess to run the command. Ensure that our main fd will
1221 be closed when the subprocess execs, but remove the flag afterwards.
1222 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1223 process to deliver another message.) We get back stdin/stdout file descriptors.
1224 If the process creation failed, give an error return. */
1230 write_pid = (pid_t)(-1);
1232 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1233 filter_pid = child_open(transport_filter_argv, NULL, 077, &fd_write, &fd_read,
1235 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
1236 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1239 debug_printf("process %d running as transport filter: write=%d read=%d\n",
1240 (int)filter_pid, fd_write, fd_read);
1242 /* Fork subprocess to write the message to the filter, and return the result
1243 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1244 smtp dots, or check string processing. */
1246 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1247 if ((write_pid = fork()) == 0)
1250 (void)close(fd_read);
1251 (void)close(pfd[pipe_read]);
1252 nl_check_length = nl_escape_length = 0;
1253 rc = internal_transport_write_message(addr, fd_write,
1254 (options & ~(topt_use_crlf | topt_end_dot)),
1255 size_limit, add_headers, remove_headers, NULL, NULL,
1256 rewrite_rules, rewrite_existflags);
1258 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1260 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1262 || write(pfd[pipe_write], (void *)&(addr->more_errno), sizeof(int))
1265 rc = FALSE; /* compiler quietening */
1270 /* Parent process: close our copy of the writing subprocess' pipes. */
1272 (void)close(pfd[pipe_write]);
1273 (void)close(fd_write);
1276 /* Writing process creation failed */
1280 errno = save_errno; /* restore */
1284 /* When testing, let the subprocess get going */
1286 if (running_in_test_harness) millisleep(250);
1289 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1291 /* Copy the message from the filter to the output fd. A read error leaves len
1292 == -1 and errno set. We need to apply a timeout to the read, to cope with
1293 the case when the filter gets stuck, but it can be quite a long one. The
1294 default is 5m, but this is now configurable. */
1296 DEBUG(D_transport) debug_printf("copying from the filter\n");
1298 /* Copy the output of the filter, remembering if the last character was NL. If
1299 no data is returned, that counts as "ended with NL" (default setting of the
1300 variable is TRUE). */
1302 chunk_ptr = deliver_out_buffer;
1306 sigalrm_seen = FALSE;
1307 alarm(transport_filter_timeout);
1308 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1313 transport_filter_timed_out = TRUE;
1317 /* If the read was successful, write the block down the original fd,
1318 remembering whether it ends in \n or not. */
1322 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) goto TIDY_UP;
1323 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1326 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1330 if (len == 0) yield = TRUE;
1335 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1336 to something. Ensure the pipes are all closed and the processes are removed. If
1337 there has been an error, kill the processes before waiting for them, just to be
1338 sure. Also apply a paranoia timeout. */
1343 (void)close(fd_read);
1344 if (fd_write > 0) (void)close(fd_write);
1348 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1349 if (write_pid > 0) kill(write_pid, SIGKILL);
1352 /* Wait for the filter process to complete. */
1354 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1355 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1358 save_errno = ERRNO_FILTER_FAIL;
1359 addr->more_errno = rc;
1360 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1363 /* Wait for the writing process to complete. If it ends successfully,
1364 read the results from its pipe, provided we haven't already had a filter
1367 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1370 rc = child_close(write_pid, 30);
1376 int dummy = read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
1379 dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1380 dummy = read(pfd[pipe_read], (void *)&(addr->more_errno), sizeof(int));
1387 save_errno = ERRNO_FILTER_FAIL;
1388 addr->more_errno = rc;
1389 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1393 (void)close(pfd[pipe_read]);
1395 /* If there have been no problems we can now add the terminating "." if this is
1396 SMTP output, turning off escaping beforehand. If the last character from the
1397 filter was not NL, insert a NL to make the SMTP protocol work. */
1401 nl_check_length = nl_escape_length = 0;
1402 if ((options & topt_end_dot) != 0 && (last_filter_was_NL?
1403 !write_chunk(fd, US".\n", 2, use_crlf) :
1404 !write_chunk(fd, US"\n.\n", 3, use_crlf)))
1409 /* Write out any remaining data in the buffer. */
1413 yield = (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1414 transport_write_block(fd, deliver_out_buffer, len);
1417 else 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, 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)
1472 uschar *prevname = US"";
1477 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1479 /* Open the database for this transport */
1481 sprintf(CS buffer, "wait-%.200s", tpname);
1482 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1483 if (dbm_file == NULL) return;
1485 /* Scan the list of hosts for which this message is waiting, and ensure
1486 that the message id is in each host record. */
1488 for (host = hostlist; host!= NULL; host = host->next)
1490 BOOL already = FALSE;
1491 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 host_record = dbfn_read(dbm_file, host->name);
1504 if (host_record == NULL)
1506 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1507 host_record->count = host_record->sequence = 0;
1510 /* Compute the current length */
1512 host_length = host_record->count * MESSAGE_ID_LENGTH;
1514 /* Search the record to see if the current message is already in it. */
1516 for (s = host_record->text; s < host_record->text + host_length;
1517 s += MESSAGE_ID_LENGTH)
1519 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1520 { already = TRUE; break; }
1523 /* If we haven't found this message in the main record, search any
1524 continuation records that exist. */
1526 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1529 sprintf(CS buffer, "%.200s:%d", host->name, i);
1530 cont = dbfn_read(dbm_file, buffer);
1533 int clen = cont->count * MESSAGE_ID_LENGTH;
1534 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1536 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1537 { already = TRUE; break; }
1542 /* If this message is already in a record, no need to update. */
1546 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1551 /* If this record is full, write it out with a new name constructed
1552 from the sequence number, increase the sequence number, and empty
1555 if (host_record->count >= WAIT_NAME_MAX)
1557 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1558 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1559 host_record->sequence++;
1560 host_record->count = 0;
1564 /* If this record is not full, increase the size of the record to
1565 allow for one new message id. */
1570 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1571 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1575 /* Now add the new name on the end */
1577 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1578 host_record->count++;
1579 host_length += MESSAGE_ID_LENGTH;
1581 /* Update the database */
1583 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1584 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1589 dbfn_close(dbm_file);
1595 /*************************************************
1596 * Test for waiting messages *
1597 *************************************************/
1599 /* This function is called by a remote transport which uses the previous
1600 function to remember which messages are waiting for which remote hosts. It's
1601 called after a successful delivery and its job is to check whether there is
1602 another message waiting for the same host. However, it doesn't do this if the
1603 current continue sequence is greater than the maximum supplied as an argument,
1604 or greater than the global connection_max_messages, which, if set, overrides.
1607 transport_name name of the transport
1608 hostname name of the host
1609 local_message_max maximum number of messages down one connection
1610 as set by the caller transport
1611 new_message_id set to the message id of a waiting message
1612 more set TRUE if there are yet more messages waiting
1614 Returns: TRUE if new_message_id set; FALSE otherwise
1618 transport_check_waiting(uschar *transport_name, uschar *hostname,
1619 int local_message_max, uschar *new_message_id, BOOL *more)
1621 dbdata_wait *host_record;
1622 int host_length, path_len;
1631 debug_printf("transport_check_waiting entered\n");
1632 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1633 continue_sequence, local_message_max, connection_max_messages);
1636 /* Do nothing if we have hit the maximum number that can be send down one
1639 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1640 if (local_message_max > 0 && continue_sequence >= local_message_max)
1643 debug_printf("max messages for one connection reached: returning\n");
1647 /* Open the waiting information database. */
1649 sprintf(CS buffer, "wait-%.200s", transport_name);
1650 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1651 if (dbm_file == NULL) return FALSE;
1653 /* See if there is a record for this host; if not, there's nothing to do. */
1655 host_record = dbfn_read(dbm_file, hostname);
1656 if (host_record == NULL)
1658 dbfn_close(dbm_file);
1659 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1663 /* If the data in the record looks corrupt, just log something and
1664 don't try to use it. */
1666 if (host_record->count > WAIT_NAME_MAX)
1668 dbfn_close(dbm_file);
1669 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1670 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1674 /* Scan the message ids in the record from the end towards the beginning,
1675 until one is found for which a spool file actually exists. If the record gets
1676 emptied, delete it and continue with any continuation records that may exist.
1679 host_length = host_record->count * MESSAGE_ID_LENGTH;
1681 /* Loop to handle continuation host records in the database */
1687 sprintf(CS buffer, "%s/input/", spool_directory);
1688 path_len = Ustrlen(buffer);
1690 for (host_length -= MESSAGE_ID_LENGTH; host_length >= 0;
1691 host_length -= MESSAGE_ID_LENGTH)
1693 struct stat statbuf;
1694 Ustrncpy(new_message_id, host_record->text + host_length,
1696 new_message_id[MESSAGE_ID_LENGTH] = 0;
1698 if (split_spool_directory)
1699 sprintf(CS(buffer + path_len), "%c/%s-D", new_message_id[5], new_message_id);
1701 sprintf(CS(buffer + path_len), "%s-D", new_message_id);
1703 /* The listed message may be the one we are currently processing. If
1704 so, we want to remove it from the list without doing anything else.
1705 If not, do a stat to see if it is an existing message. If it is, break
1706 the loop to handle it. No need to bother about locks; as this is all
1707 "hint" processing, it won't matter if it doesn't exist by the time exim
1708 actually tries to deliver it. */
1710 if (Ustrcmp(new_message_id, message_id) != 0 &&
1711 Ustat(buffer, &statbuf) == 0)
1718 /* If we have removed all the message ids from the record delete the record.
1719 If there is a continuation record, fetch it and remove it from the file,
1720 as it will be rewritten as the main record. Repeat in the case of an
1721 empty continuation. */
1723 while (host_length <= 0)
1726 dbdata_wait *newr = NULL;
1728 /* Search for a continuation */
1730 for (i = host_record->sequence - 1; i >= 0 && newr == NULL; i--)
1732 sprintf(CS buffer, "%.200s:%d", hostname, i);
1733 newr = dbfn_read(dbm_file, buffer);
1736 /* If no continuation, delete the current and break the loop */
1740 dbfn_delete(dbm_file, hostname);
1744 /* Else replace the current with the continuation */
1746 dbfn_delete(dbm_file, buffer);
1748 host_length = host_record->count * MESSAGE_ID_LENGTH;
1751 /* If we found an existing message, break the continuation loop. */
1755 /* If host_length <= 0 we have emptied a record and not found a good message,
1756 and there are no continuation records. Otherwise there is a continuation
1757 record to process. */
1759 if (host_length <= 0)
1761 dbfn_close(dbm_file);
1762 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1767 /* Control gets here when an existing message has been encountered; its
1768 id is in new_message_id, and host_length is the revised length of the
1769 host record. If it is zero, the record has been removed. Update the
1770 record if required, close the database, and return TRUE. */
1772 if (host_length > 0)
1774 host_record->count = host_length/MESSAGE_ID_LENGTH;
1775 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1779 dbfn_close(dbm_file);
1785 /*************************************************
1786 * Deliver waiting message down same socket *
1787 *************************************************/
1789 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1790 get a clean delivery process, and to regain root privilege in cases where it
1791 has been given away.
1794 transport_name to pass to the new process
1797 id the new message to process
1798 socket_fd the connected socket
1800 Returns: FALSE if fork fails; TRUE otherwise
1804 transport_pass_socket(uschar *transport_name, uschar *hostname,
1805 uschar *hostaddress, uschar *id, int socket_fd)
1810 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1812 if ((pid = fork()) == 0)
1817 /* Disconnect entirely from the parent process. If we are running in the
1818 test harness, wait for a bit to allow the previous process time to finish,
1819 write the log, etc., so that the output is always in the same order for
1820 automatic comparison. */
1822 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
1823 if (running_in_test_harness) sleep(1);
1825 /* Set up the calling arguments; use the standard function for the basics,
1826 but we have a number of extras that may be added. */
1828 argv = child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1830 #ifdef EXPERIMENTAL_DSN
1831 /* Call with the dsn flag */
1832 if (smtp_use_dsn) argv[i++] = US"-MCD";
1835 if (smtp_authenticated) argv[i++] = US"-MCA";
1838 if (tls_offered) argv[i++] = US"-MCT";
1841 if (smtp_use_size) argv[i++] = US"-MCS";
1842 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1844 if (queue_run_pid != (pid_t)0)
1846 argv[i++] = US"-MCQ";
1847 argv[i++] = string_sprintf("%d", queue_run_pid);
1848 argv[i++] = string_sprintf("%d", queue_run_pipe);
1851 argv[i++] = US"-MC";
1852 argv[i++] = transport_name;
1853 argv[i++] = hostname;
1854 argv[i++] = hostaddress;
1855 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1859 /* Arrange for the channel to be on stdin. */
1863 (void)dup2(socket_fd, 0);
1864 (void)close(socket_fd);
1867 DEBUG(D_exec) debug_print_argv(argv);
1868 exim_nullstd(); /* Ensure std{out,err} exist */
1869 execv(CS argv[0], (char *const *)argv);
1871 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1872 _exit(errno); /* Note: must be _exit(), NOT exit() */
1875 /* If the process creation succeeded, wait for the first-level child, which
1876 immediately exits, leaving the second level process entirely disconnected from
1882 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1883 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
1888 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1896 /*************************************************
1897 * Set up direct (non-shell) command *
1898 *************************************************/
1900 /* This function is called when a command line is to be parsed and executed
1901 directly, without the use of /bin/sh. It is called by the pipe transport,
1902 the queryprogram router, and also from the main delivery code when setting up a
1903 transport filter process. The code for ETRN also makes use of this; in that
1904 case, no addresses are passed.
1907 argvptr pointer to anchor for argv vector
1908 cmd points to the command string
1909 expand_arguments true if expansion is to occur
1910 expand_failed error value to set if expansion fails; not relevant if
1912 addr chain of addresses, or NULL
1913 etext text for use in error messages
1914 errptr where to put error message if addr is NULL;
1915 otherwise it is put in the first address
1917 Returns: TRUE if all went well; otherwise an error will be
1918 set in the first address and FALSE returned
1922 transport_set_up_command(uschar ***argvptr, uschar *cmd, BOOL expand_arguments,
1923 int expand_failed, address_item *addr, uschar *etext, uschar **errptr)
1928 int address_count = 0;
1932 /* Get store in which to build an argument list. Count the number of addresses
1933 supplied, and allow for that many arguments, plus an additional 60, which
1934 should be enough for anybody. Multiple addresses happen only when the local
1935 delivery batch option is set. */
1937 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
1938 max_args = address_count + 60;
1939 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
1941 /* Split the command up into arguments terminated by white space. Lose
1942 trailing space at the start and end. Double-quoted arguments can contain \\ and
1943 \" escapes and so can be handled by the standard function; single-quoted
1944 arguments are verbatim. Copy each argument into a new string. */
1947 while (isspace(*s)) s++;
1949 while (*s != 0 && argcount < max_args)
1954 while (*ss != 0 && *ss != '\'') ss++;
1955 argv[argcount++] = ss = store_get(ss - s++);
1956 while (*s != 0 && *s != '\'') *ss++ = *s++;
1960 else argv[argcount++] = string_dequote(&s);
1961 while (isspace(*s)) s++;
1964 argv[argcount] = (uschar *)0;
1966 /* If *s != 0 we have run out of argument slots. */
1970 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
1974 addr->transport_return = FAIL;
1975 addr->message = msg;
1981 /* Expand each individual argument if required. Expansion happens for pipes set
1982 up in filter files and with directly-supplied commands. It does not happen if
1983 the pipe comes from a traditional .forward file. A failing expansion is a big
1984 disaster if the command came from Exim's configuration; if it came from a user
1985 it is just a normal failure. The expand_failed value is used as the error value
1986 to cater for these two cases.
1988 An argument consisting just of the text "$pipe_addresses" is treated specially.
1989 It is not passed to the general expansion function. Instead, it is replaced by
1990 a number of arguments, one for each address. This avoids problems with shell
1991 metacharacters and spaces in addresses.
1993 If the parent of the top address has an original part of "system-filter", this
1994 pipe was set up by the system filter, and we can permit the expansion of
1999 debug_printf("direct command:\n");
2000 for (i = 0; argv[i] != (uschar *)0; i++)
2001 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2004 if (expand_arguments)
2006 BOOL allow_dollar_recipients = addr != NULL &&
2007 addr->parent != NULL &&
2008 Ustrcmp(addr->parent->address, "system-filter") == 0;
2010 for (i = 0; argv[i] != (uschar *)0; i++)
2013 /* Handle special fudge for passing an address list */
2016 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2017 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2021 if (argcount + address_count - 1 > max_args)
2023 addr->transport_return = FAIL;
2024 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2025 "in %s", cmd, etext);
2029 additional = address_count - 1;
2031 memmove(argv + i + 1 + additional, argv + i + 1,
2032 (argcount - i)*sizeof(uschar *));
2034 for (ad = addr; ad != NULL; ad = ad->next) {
2035 argv[i++] = ad->address;
2039 /* Subtract one since we replace $pipe_addresses */
2044 /* Handle special case of $address_pipe when af_force_command is set */
2046 else if (addr != NULL && testflag(addr,af_force_command) &&
2047 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2048 Ustrcmp(argv[i], "${address_pipe}") == 0))
2051 int address_pipe_argcount = 0;
2052 int address_pipe_max_args;
2053 uschar **address_pipe_argv;
2055 /* We can never have more then the argv we will be loading into */
2056 address_pipe_max_args = max_args - argcount + 1;
2059 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2061 /* We allocate an additional for (uschar *)0 */
2062 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2064 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2065 s = expand_string(addr->local_part + 1);
2067 if (s == NULL || *s == '\0')
2069 addr->transport_return = FAIL;
2070 addr->message = string_sprintf("Expansion of \"%s\" "
2071 "from command \"%s\" in %s failed: %s",
2072 (addr->local_part + 1), cmd, etext, expand_string_message);
2076 while (isspace(*s)) s++; /* strip leading space */
2078 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2083 while (*ss != 0 && *ss != '\'') ss++;
2084 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2085 while (*s != 0 && *s != '\'') *ss++ = *s++;
2089 else address_pipe_argv[address_pipe_argcount++] = string_dequote(&s);
2090 while (isspace(*s)) s++; /* strip space after arg */
2093 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2095 /* If *s != 0 we have run out of argument slots. */
2098 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2099 "\"%s\" in %s", addr->local_part + 1, etext);
2102 addr->transport_return = FAIL;
2103 addr->message = msg;
2109 /* address_pipe_argcount - 1
2110 * because we are replacing $address_pipe in the argument list
2111 * with the first thing it expands to */
2112 if (argcount + address_pipe_argcount - 1 > max_args)
2114 addr->transport_return = FAIL;
2115 addr->message = string_sprintf("Too many arguments to command "
2116 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2120 /* If we are not just able to replace the slot that contained
2121 * $address_pipe (address_pipe_argcount == 1)
2122 * We have to move the existing argv by address_pipe_argcount - 1
2123 * Visually if address_pipe_argcount == 2:
2124 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2125 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2127 if (address_pipe_argcount > 1)
2129 /* current position + additonal args */
2130 argv + i + address_pipe_argcount,
2131 /* current position + 1 (for the (uschar *)0 at the end) */
2133 /* -1 for the (uschar *)0 at the end)*/
2134 (argcount - i)*sizeof(uschar *)
2137 /* Now we fill in the slots we just moved argv out of
2138 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2140 for (address_pipe_i = 0;
2141 address_pipe_argv[address_pipe_i] != (uschar *)0;
2144 argv[i++] = address_pipe_argv[address_pipe_i];
2148 /* Subtract one since we replace $address_pipe */
2153 /* Handle normal expansion string */
2157 uschar *expanded_arg;
2158 enable_dollar_recipients = allow_dollar_recipients;
2159 expanded_arg = expand_string(argv[i]);
2160 enable_dollar_recipients = FALSE;
2162 if (expanded_arg == NULL)
2164 uschar *msg = string_sprintf("Expansion of \"%s\" "
2165 "from command \"%s\" in %s failed: %s",
2166 argv[i], cmd, etext, expand_string_message);
2169 addr->transport_return = expand_failed;
2170 addr->message = msg;
2175 argv[i] = expanded_arg;
2181 debug_printf("direct command after expansion:\n");
2182 for (i = 0; argv[i] != (uschar *)0; i++)
2183 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2192 /* End of transport.c */