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) rc = tls_write(FALSE, block, len); else
242 rc = write(fd, block, len);
244 local_timeout = alarm(0);
252 /* Hopefully, the most common case is success, so test that first. */
254 if (rc == len) { transport_count += len; return TRUE; }
256 /* A non-negative return code is an incomplete write. Try again for the rest
257 of the block. If we have exactly hit the timeout, give up. */
263 transport_count += rc;
264 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
265 goto CHECK_TIMEOUT; /* A few lines below */
268 /* A negative return code with an EINTR error is another form of
269 incomplete write, zero bytes having been written */
271 if (save_errno == EINTR)
274 debug_printf("write interrupted before anything written\n");
275 goto CHECK_TIMEOUT; /* A few lines below */
278 /* A response of EAGAIN from write() is likely only in the case of writing
279 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
281 if (save_errno == EAGAIN)
284 debug_printf("write temporarily locked out, waiting 1 sec\n");
287 /* Before continuing to try another write, check that we haven't run out of
291 if (transport_write_timeout > 0 && local_timeout <= 0)
299 /* Otherwise there's been an error */
301 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
302 strerror(save_errno));
307 /* We've tried and tried and tried but still failed */
309 errno = ERRNO_WRITEINCOMPLETE;
316 /*************************************************
317 * Write formatted string *
318 *************************************************/
320 /* This is called by various transports. It is a convenience function.
325 ... arguments for format
327 Returns: the yield of transport_write_block()
331 transport_write_string(int fd, const char *format, ...)
334 va_start(ap, format);
335 if (!string_vformat(big_buffer, big_buffer_size, format, ap))
336 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
338 return transport_write_block(fd, big_buffer, Ustrlen(big_buffer));
344 /*************************************************
345 * Write character chunk *
346 *************************************************/
348 /* Subroutine used by transport_write_message() to scan character chunks for
349 newlines and act appropriately. The object is to minimise the number of writes.
350 The output byte stream is buffered up in deliver_out_buffer, which is written
351 only when it gets full, thus minimizing write operations and TCP packets.
353 Static data is used to handle the case when the last character of the previous
354 chunk was NL, or matched part of the data that has to be escaped.
357 fd file descript to write to
358 chunk pointer to data to write
359 len length of data to write
360 usr_crlf TRUE if CR LF is wanted at the end of each line
362 In addition, the static nl_xxx variables must be set as required.
364 Returns: TRUE on success, FALSE on failure (with errno preserved)
368 write_chunk(int fd, uschar *chunk, int len, BOOL use_crlf)
370 uschar *start = chunk;
371 uschar *end = chunk + len;
373 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
375 /* The assumption is made that the check string will never stretch over move
376 than one chunk since the only time there are partial matches is when copying
377 the body in large buffers. There is always enough room in the buffer for an
378 escape string, since the loop below ensures this for each character it
379 processes, and it won't have stuck in the escape string if it left a partial
382 if (nl_partial_match >= 0)
384 if (nl_check_length > 0 && len >= nl_check_length &&
385 Ustrncmp(start, nl_check + nl_partial_match,
386 nl_check_length - nl_partial_match) == 0)
388 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
389 chunk_ptr += nl_escape_length;
390 start += nl_check_length - nl_partial_match;
393 /* The partial match was a false one. Insert the characters carried over
394 from the previous chunk. */
396 else if (nl_partial_match > 0)
398 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
399 chunk_ptr += nl_partial_match;
402 nl_partial_match = -1;
405 /* Now process the characters in the chunk. Whenever we hit a newline we check
406 for possible escaping. The code for the non-NL route should be as fast as
409 for (ptr = start; ptr < end; ptr++)
413 /* Flush the buffer if it has reached the threshold - we want to leave enough
414 room for the next uschar, plus a possible extra CR for an LF, plus the escape
417 if (chunk_ptr - deliver_out_buffer > mlen)
419 if (!transport_write_block(fd, deliver_out_buffer,
420 chunk_ptr - deliver_out_buffer))
422 chunk_ptr = deliver_out_buffer;
425 if ((ch = *ptr) == '\n')
427 int left = end - ptr - 1; /* count of chars left after NL */
429 /* Insert CR before NL if required */
431 if (use_crlf) *chunk_ptr++ = '\r';
433 transport_newlines++;
435 /* The check_string test (formerly "from hack") replaces the specific
436 string at the start of a line with an escape string (e.g. "From " becomes
437 ">From " or "." becomes "..". It is a case-sensitive test. The length
438 check above ensures there is always enough room to insert this string. */
440 if (nl_check_length > 0)
442 if (left >= nl_check_length &&
443 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
445 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
446 chunk_ptr += nl_escape_length;
447 ptr += nl_check_length;
450 /* Handle the case when there isn't enough left to match the whole
451 check string, but there may be a partial match. We remember how many
452 characters matched, and finish processing this chunk. */
454 else if (left <= 0) nl_partial_match = 0;
456 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
458 nl_partial_match = left;
464 /* Not a NL character */
466 else *chunk_ptr++ = ch;
475 /*************************************************
476 * Generate address for RCPT TO *
477 *************************************************/
479 /* This function puts together an address for RCPT to, using the caseful
480 version of the local part and the caseful version of the domain. If there is no
481 prefix or suffix, or if affixes are to be retained, we can just use the
482 original address. Otherwise, if there is a prefix but no suffix we can use a
483 pointer into the original address. If there is a suffix, however, we have to
487 addr the address item
488 include_affixes TRUE if affixes are to be included
494 transport_rcpt_address(address_item *addr, BOOL include_affixes)
501 setflag(addr, af_include_affixes); /* Affects logged => line */
502 return addr->address;
505 if (addr->suffix == NULL)
507 if (addr->prefix == NULL) return addr->address;
508 return addr->address + Ustrlen(addr->prefix);
511 at = Ustrrchr(addr->address, '@');
512 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
513 slen = Ustrlen(addr->suffix);
515 return string_sprintf("%.*s@%s", (at - addr->address - plen - slen),
516 addr->address + plen, at + 1);
520 /*************************************************
521 * Output Envelope-To: address & scan duplicates *
522 *************************************************/
524 /* This function is called from internal_transport_write_message() below, when
525 generating an Envelope-To: header line. It checks for duplicates of the given
526 address and its ancestors. When one is found, this function calls itself
527 recursively, to output the envelope address of the duplicate.
529 We want to avoid duplication in the list, which can arise for example when
530 A->B,C and then both B and C alias to D. This can also happen when there are
531 unseen drivers in use. So a list of addresses that have been output is kept in
534 It is also possible to have loops in the address ancestry/duplication graph,
535 for example if there are two top level addresses A and B and we have A->B,C and
536 B->A. To break the loop, we use a list of processed addresses in the dlist
539 After handling duplication, this function outputs the progenitor of the given
543 p the address we are interested in
544 pplist address of anchor of the list of addresses not to output
545 pdlist address of anchor of the list of processed addresses
546 first TRUE if this is the first address; set it FALSE afterwards
547 fd the file descriptor to write to
548 use_crlf to be passed on to write_chunk()
550 Returns: FALSE if writing failed
554 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
555 BOOL *first, int fd, BOOL use_crlf)
560 /* Do nothing if we have already handled this address. If not, remember it
561 so that we don't handle it again. */
563 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
565 ppp = store_get(sizeof(struct aci));
570 /* Now scan up the ancestry, checking for duplicates at each generation. */
572 for (pp = p;; pp = pp->parent)
575 for (dup = addr_duplicate; dup; dup = dup->next)
576 if (dup->dupof == pp) /* a dup of our address */
577 if (!write_env_to(dup, pplist, pdlist, first, fd, use_crlf))
579 if (!pp->parent) break;
582 /* Check to see if we have already output the progenitor. */
584 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
585 if (ppp) return TRUE;
587 /* Remember what we have output, and output it. */
589 ppp = store_get(sizeof(struct aci));
594 if (!(*first) && !write_chunk(fd, US",\n ", 3, use_crlf)) return FALSE;
596 return write_chunk(fd, pp->address, Ustrlen(pp->address), use_crlf);
602 /* Add/remove/rewwrite headers, and send them plus the empty-line sparator.
608 addr (chain of) addresses (for extra headers), or NULL;
609 only the first address is used
610 fd file descriptor to write the message to
611 sendfn function for output
612 use_crlf turn NL into CR LF
613 rewrite_rules chain of header rewriting rules
614 rewrite_existflags flags for the rewriting rules
616 Returns: TRUE on success; FALSE on failure.
619 transport_headers_send(address_item *addr, int fd, transport_instance * tblock,
620 BOOL (*sendfn)(int fd, uschar * s, int len, BOOL use_crlf),
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->prop.remove_headers too, provided that addr is not NULL. */
633 for (h = header_list; h; h = h->next) if (h->type != htype_old)
636 BOOL include_header = TRUE;
638 list = tblock ? tblock->remove_headers : NULL;
639 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
643 int sep = ':'; /* This is specified as a colon-separated list */
645 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
650 if (!(s = expand_string(s)) && !expand_string_forcedfail)
652 errno = ERRNO_CHHEADER_FAIL;
655 len = s ? Ustrlen(s) : 0;
656 if (strncmpic(h->text, s, len) != 0) continue;
658 while (*ss == ' ' || *ss == '\t') ss++;
659 if (*ss == ':') break;
661 if (s) { include_header = FALSE; break; }
663 if (addr) list = addr->prop.remove_headers;
666 /* If this header is to be output, try to rewrite it if there are rewriting
671 if (tblock && tblock->rewrite_rules)
673 void *reset_point = store_get(0);
676 if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
677 tblock->rewrite_existflags, FALSE)))
679 if (!sendfn(fd, hh->text, hh->slen, use_crlf)) return FALSE;
680 store_reset(reset_point);
681 continue; /* With the next header line */
685 /* Either no rewriting rules, or it didn't get rewritten */
687 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
694 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
698 /* Add on any address-specific headers. If there are multiple addresses,
699 they will all have the same headers in order to be batched. The headers
700 are chained in reverse order of adding (so several addresses from the
701 same alias might share some of them) but we want to output them in the
702 opposite order. This is a bit tedious, but there shouldn't be very many
703 of them. We just walk the list twice, reversing the pointers each time,
704 but on the second time, write out the items.
706 Headers added to an address by a router are guaranteed to end with a newline.
712 header_line *hprev = addr->prop.extra_headers;
714 for (i = 0; i < 2; i++)
715 for (h = hprev, hprev = NULL; h; h = hnext)
722 if (!sendfn(fd, h->text, h->slen, use_crlf)) return FALSE;
724 debug_printf("added header line(s):\n%s---\n", h->text);
729 /* If a string containing additional headers exists it is a newline-sep
730 list. Expand each item and write out the result. This is done last so that
731 if it (deliberately or accidentally) isn't in header format, it won't mess
732 up any other headers. An empty string or a forced expansion failure are
733 noops. An added header string from a transport may not end with a newline;
734 add one if it does not. */
736 if (tblock && (list = CUS tblock->add_headers))
741 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
742 if ((s = expand_string(s)))
744 int len = Ustrlen(s);
747 if (!sendfn(fd, s, len, use_crlf)) return FALSE;
748 if (s[len-1] != '\n' && !sendfn(fd, US"\n", 1, use_crlf))
752 debug_printf("added header line:\n%s", s);
753 if (s[len-1] != '\n') debug_printf("\n");
754 debug_printf("---\n");
758 else if (!expand_string_forcedfail)
759 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
762 /* Separate headers from body with a blank line */
764 return sendfn(fd, US"\n", 1, use_crlf);
768 /*************************************************
769 * Write the message *
770 *************************************************/
772 /* This function writes the message to the given file descriptor. The headers
773 are in the in-store data structure, and the rest of the message is in the open
774 file descriptor deliver_datafile. Make sure we start it at the beginning.
776 . If add_return_path is TRUE, a "return-path:" header is added to the message,
777 containing the envelope sender's address.
779 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
780 giving the top-level envelope address that caused this delivery to happen.
782 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
783 message. It gives the time and date that delivery took place.
785 . If check_string is not null, the start of each line is checked for that
786 string. If it is found, it is replaced by escape_string. This used to be
787 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
789 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
791 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
792 any writing or reading error, leaving the code in errno intact. Error exits
793 can include timeouts for certain transports, which are requested by setting
794 transport_write_timeout non-zero.
797 fd file descriptor to write the message to
799 addr (chain of) addresses (for extra headers), or NULL;
800 only the first address is used
801 tblock optional transport instance block (NULL signifies NULL/0):
802 add_headers a string containing one or more headers to add; it is
803 expanded, and must be in correct RFC 822 format as
804 it is transmitted verbatim; NULL => no additions,
805 and so does empty string or forced expansion fail
806 remove_headers a colon-separated list of headers to remove, or NULL
807 rewrite_rules chain of header rewriting rules
808 rewrite_existflags flags for the rewriting rules
809 options bit-wise options:
810 add_return_path if TRUE, add a "return-path" header
811 add_envelope_to if TRUE, add a "envelope-to" header
812 add_delivery_date if TRUE, add a "delivery-date" header
813 use_crlf if TRUE, turn NL into CR LF
814 end_dot if TRUE, send a terminating "." line at the end
815 no_headers if TRUE, omit the headers
816 no_body if TRUE, omit the body
817 size_limit if > 0, this is a limit to the size of message written;
818 it is used when returning messages to their senders,
819 and is approximate rather than exact, owing to chunk
821 check_string a string to check for at the start of lines, or NULL
822 escape_string a string to insert in front of any check string
824 Returns: TRUE on success; FALSE (with errno) on failure.
825 In addition, the global variable transport_count
826 is incremented by the number of bytes written.
830 internal_transport_write_message(int fd, transport_ctx * tctx, int size_limit)
834 BOOL use_crlf = (tctx->options & topt_use_crlf) != 0;
836 /* Initialize pointer in output buffer. */
838 chunk_ptr = deliver_out_buffer;
840 /* Set up the data for start-of-line data checking and escaping */
842 nl_partial_match = -1;
843 if (tctx->check_string && tctx->escape_string)
845 nl_check = tctx->check_string;
846 nl_check_length = Ustrlen(nl_check);
847 nl_escape = tctx->escape_string;
848 nl_escape_length = Ustrlen(nl_escape);
851 nl_check_length = nl_escape_length = 0;
853 /* Whether the escaping mechanism is applied to headers or not is controlled by
854 an option (set for SMTP, not otherwise). Negate the length if not wanted till
855 after the headers. */
857 if (!(tctx->options & topt_escape_headers))
858 nl_check_length = -nl_check_length;
860 /* Write the headers if required, including any that have to be added. If there
861 are header rewriting rules, apply them. */
863 if (!(tctx->options & topt_no_headers))
865 /* Add return-path: if requested. */
867 if (tctx->options & topt_add_return_path)
869 uschar buffer[ADDRESS_MAXLENGTH + 20];
870 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
872 if (!write_chunk(fd, buffer, n, use_crlf)) return FALSE;
875 /* Add envelope-to: if requested */
877 if (tctx->options & topt_add_envelope_to)
881 struct aci *plist = NULL;
882 struct aci *dlist = NULL;
883 void *reset_point = store_get(0);
885 if (!write_chunk(fd, US"Envelope-to: ", 13, use_crlf)) return FALSE;
887 /* Pick up from all the addresses. The plist and dlist variables are
888 anchors for lists of addresses already handled; they have to be defined at
889 this level becuase write_env_to() calls itself recursively. */
891 for (p = tctx->addr; p; p = p->next)
892 if (!write_env_to(p, &plist, &dlist, &first, fd, use_crlf))
895 /* Add a final newline and reset the store used for tracking duplicates */
897 if (!write_chunk(fd, US"\n", 1, use_crlf)) return FALSE;
898 store_reset(reset_point);
901 /* Add delivery-date: if requested. */
903 if (tctx->options & topt_add_delivery_date)
906 int n = sprintf(CS buffer, "Delivery-date: %s\n", tod_stamp(tod_full));
907 if (!write_chunk(fd, buffer, n, use_crlf)) return FALSE;
910 /* Then the message's headers. Don't write any that are flagged as "old";
911 that means they were rewritten, or are a record of envelope rewriting, or
912 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
913 match any entries therein. Then check addr->prop.remove_headers too, provided that
916 if (!transport_headers_send(tctx->addr, fd, tctx->tblock, &write_chunk, use_crlf))
920 /* If the body is required, ensure that the data for check strings (formerly
921 the "from hack") is enabled by negating the length if necessary. (It will be
922 negative in cases where it isn't to apply to the headers). Then ensure the body
923 is positioned at the start of its file (following the message id), then write
924 it, applying the size limit if required. */
926 if (!(tctx->options & topt_no_body))
928 nl_check_length = abs(nl_check_length);
929 nl_partial_match = 0;
930 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
932 while ((len = read(deliver_datafile, deliver_in_buffer,
933 DELIVER_IN_BUFFER_SIZE)) > 0)
935 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) return FALSE;
939 if (written > size_limit)
941 len = 0; /* Pretend EOF */
947 /* A read error on the body will have left len == -1 and errno set. */
949 if (len != 0) return FALSE;
952 /* Finished with the check string */
954 nl_check_length = nl_escape_length = 0;
956 /* If requested, add a terminating "." line (SMTP output). */
958 if (tctx->options & topt_end_dot && !write_chunk(fd, US".\n", 2, use_crlf))
961 /* Write out any remaining data in the buffer before returning. */
963 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
964 transport_write_block(fd, deliver_out_buffer, len);
970 /***************************************************************************************************
971 * External interface to write the message, while signing it with DKIM and/or Domainkeys *
972 ***************************************************************************************************/
974 /* This function is a wrapper around transport_write_message().
975 It is only called from the smtp transport if DKIM or Domainkeys support
976 is compiled in. The function sets up a replacement fd into a -K file,
977 then calls the normal function. This way, the exact bits that exim would
978 have put "on the wire" will end up in the file (except for TLS
979 encapsulation, which is the very very last thing). When we are done
980 signing the file, send the signed message down the original fd (or TLS fd).
983 as for internal_transport_write_message() above, with additional arguments
986 Returns: TRUE on success; FALSE (with errno) for any failure
990 dkim_transport_write_message(int out_fd, transport_ctx * tctx,
991 struct ob_dkim * dkim)
996 uschar * dkim_spool_name;
999 uschar *dkim_signature = NULL;
1002 /* If we can't sign, just call the original function. */
1004 if (!(dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector))
1005 return transport_write_message(out_fd, tctx, 0);
1007 dkim_spool_name = spool_fname(US"input", message_subdir, message_id,
1008 string_sprintf("-%d-K", (int)getpid()));
1010 if ((dkim_fd = Uopen(dkim_spool_name, O_RDWR|O_CREAT|O_TRUNC, SPOOL_MODE)) < 0)
1012 /* Can't create spool file. Ugh. */
1018 /* Call original function to write the -K file; does the CRLF expansion */
1020 rc = transport_write_message(dkim_fd, tctx, 0);
1022 /* Save error state. We must clean up before returning. */
1029 if (dkim->dkim_private_key && dkim->dkim_domain && dkim->dkim_selector)
1031 /* Rewind file and feed it to the goats^W DKIM lib */
1032 lseek(dkim_fd, 0, SEEK_SET);
1033 dkim_signature = dkim_exim_sign(dkim_fd,
1034 dkim->dkim_private_key,
1036 dkim->dkim_selector,
1038 dkim->dkim_sign_headers);
1039 if (!dkim_signature)
1041 if (dkim->dkim_strict)
1043 uschar *dkim_strict_result = expand_string(dkim->dkim_strict);
1044 if (dkim_strict_result)
1045 if ( (strcmpic(dkim->dkim_strict,US"1") == 0) ||
1046 (strcmpic(dkim->dkim_strict,US"true") == 0) )
1048 /* Set errno to something halfway meaningful */
1049 save_errno = EACCES;
1050 log_write(0, LOG_MAIN, "DKIM: message could not be signed,"
1051 " and dkim_strict is set. Deferring message delivery.");
1060 int siglen = Ustrlen(dkim_signature);
1064 wwritten = tls_out.active == out_fd
1065 ? tls_write(FALSE, dkim_signature, siglen)
1066 : write(out_fd, dkim_signature, siglen);
1068 wwritten = write(out_fd, dkim_signature, siglen);
1072 /* error, bail out */
1078 dkim_signature += wwritten;
1083 #ifdef HAVE_LINUX_SENDFILE
1084 /* We can use sendfile() to shove the file contents
1085 to the socket. However only if we don't use TLS,
1086 as then there's another layer of indirection
1087 before the data finally hits the socket. */
1088 if (tls_out.active != out_fd)
1093 k_file_size = lseek(dkim_fd, 0, SEEK_END); /* Fetch file size */
1096 lseek(dkim_fd, 0, SEEK_SET);
1098 while(copied >= 0 && offset < k_file_size)
1099 copied = sendfile(out_fd, dkim_fd, &offset, k_file_size - offset);
1112 lseek(dkim_fd, 0, SEEK_SET);
1114 /* Send file down the original fd */
1115 while((sread = read(dkim_fd, deliver_out_buffer, DELIVER_OUT_BUFFER_SIZE)) >0)
1117 char *p = deliver_out_buffer;
1118 /* write the chunk */
1123 wwritten = tls_out.active == out_fd
1124 ? tls_write(FALSE, US p, sread)
1125 : write(out_fd, p, sread);
1127 wwritten = write(out_fd, p, sread);
1131 /* error, bail out */
1149 /* unlink -K file */
1150 (void)close(dkim_fd);
1151 Uunlink(dkim_spool_name);
1160 /*************************************************
1161 * External interface to write the message *
1162 *************************************************/
1164 /* If there is no filtering required, call the internal function above to do
1165 the real work, passing over all the arguments from this function. Otherwise,
1166 set up a filtering process, fork another process to call the internal function
1167 to write to the filter, and in this process just suck from the filter and write
1168 down the given fd. At the end, tidy up the pipes and the processes.
1171 Arguments: as for internal_transport_write_message() above
1173 Returns: TRUE on success; FALSE (with errno) for any failure
1174 transport_count is incremented by the number of bytes written
1178 transport_write_message(int fd, transport_ctx * tctx, int size_limit)
1181 BOOL last_filter_was_NL = TRUE;
1182 int rc, len, yield, fd_read, fd_write, save_errno;
1183 int pfd[2] = {-1, -1};
1184 pid_t filter_pid, write_pid;
1185 static transport_ctx dummy_tctx = { NULL, NULL, NULL, NULL, 0 };
1187 if (!tctx) tctx = &dummy_tctx;
1189 transport_filter_timed_out = FALSE;
1191 /* If there is no filter command set up, call the internal function that does
1192 the actual work, passing it the incoming fd, and return its result. */
1194 if ( !transport_filter_argv
1195 || !*transport_filter_argv
1196 || !**transport_filter_argv
1198 return internal_transport_write_message(fd, tctx, size_limit);
1200 /* Otherwise the message must be written to a filter process and read back
1201 before being written to the incoming fd. First set up the special processing to
1202 be done during the copying. */
1204 use_crlf = (tctx->options & topt_use_crlf) != 0;
1205 nl_partial_match = -1;
1207 if (tctx->check_string && tctx->escape_string)
1209 nl_check = tctx->check_string;
1210 nl_check_length = Ustrlen(nl_check);
1211 nl_escape = tctx->escape_string;
1212 nl_escape_length = Ustrlen(nl_escape);
1214 else nl_check_length = nl_escape_length = 0;
1216 /* Start up a subprocess to run the command. Ensure that our main fd will
1217 be closed when the subprocess execs, but remove the flag afterwards.
1218 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1219 process to deliver another message.) We get back stdin/stdout file descriptors.
1220 If the process creation failed, give an error return. */
1226 write_pid = (pid_t)(-1);
1228 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) | FD_CLOEXEC);
1229 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1230 &fd_write, &fd_read, FALSE);
1231 (void)fcntl(fd, F_SETFD, fcntl(fd, F_GETFD) & ~FD_CLOEXEC);
1232 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1235 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1236 (int)filter_pid, fd_write, fd_read);
1238 /* Fork subprocess to write the message to the filter, and return the result
1239 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1240 smtp dots, or check string processing. */
1242 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1243 if ((write_pid = fork()) == 0)
1246 (void)close(fd_read);
1247 (void)close(pfd[pipe_read]);
1248 nl_check_length = nl_escape_length = 0;
1250 tctx->check_string = tctx->escape_string = NULL;
1251 tctx->options &= ~(topt_use_crlf | topt_end_dot);
1253 rc = internal_transport_write_message(fd_write, tctx, size_limit);
1256 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1258 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1260 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1263 rc = FALSE; /* compiler quietening */
1268 /* Parent process: close our copy of the writing subprocess' pipes. */
1270 (void)close(pfd[pipe_write]);
1271 (void)close(fd_write);
1274 /* Writing process creation failed */
1278 errno = save_errno; /* restore */
1282 /* When testing, let the subprocess get going */
1284 if (running_in_test_harness) millisleep(250);
1287 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1289 /* Copy the message from the filter to the output fd. A read error leaves len
1290 == -1 and errno set. We need to apply a timeout to the read, to cope with
1291 the case when the filter gets stuck, but it can be quite a long one. The
1292 default is 5m, but this is now configurable. */
1294 DEBUG(D_transport) debug_printf("copying from the filter\n");
1296 /* Copy the output of the filter, remembering if the last character was NL. If
1297 no data is returned, that counts as "ended with NL" (default setting of the
1298 variable is TRUE). */
1300 chunk_ptr = deliver_out_buffer;
1304 sigalrm_seen = FALSE;
1305 alarm(transport_filter_timeout);
1306 len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1311 transport_filter_timed_out = TRUE;
1315 /* If the read was successful, write the block down the original fd,
1316 remembering whether it ends in \n or not. */
1320 if (!write_chunk(fd, deliver_in_buffer, len, use_crlf)) goto TIDY_UP;
1321 last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1324 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1328 if (len == 0) yield = TRUE;
1333 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1334 to something. Ensure the pipes are all closed and the processes are removed. If
1335 there has been an error, kill the processes before waiting for them, just to be
1336 sure. Also apply a paranoia timeout. */
1341 (void)close(fd_read);
1342 if (fd_write > 0) (void)close(fd_write);
1346 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1347 if (write_pid > 0) kill(write_pid, SIGKILL);
1350 /* Wait for the filter process to complete. */
1352 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1353 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1356 save_errno = ERRNO_FILTER_FAIL;
1357 tctx->addr->more_errno = rc;
1358 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1361 /* Wait for the writing process to complete. If it ends successfully,
1362 read the results from its pipe, provided we haven't already had a filter
1365 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1368 rc = child_close(write_pid, 30);
1374 int dummy = read(pfd[pipe_read], (void *)&ok, sizeof(BOOL));
1377 dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1378 dummy = read(pfd[pipe_read], (void *)&(tctx->addr->more_errno), sizeof(int));
1385 save_errno = ERRNO_FILTER_FAIL;
1386 tctx->addr->more_errno = rc;
1387 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1391 (void)close(pfd[pipe_read]);
1393 /* If there have been no problems we can now add the terminating "." if this is
1394 SMTP output, turning off escaping beforehand. If the last character from the
1395 filter was not NL, insert a NL to make the SMTP protocol work. */
1399 nl_check_length = nl_escape_length = 0;
1400 if ( tctx->options & topt_end_dot
1401 && ( last_filter_was_NL
1402 ? !write_chunk(fd, US".\n", 2, use_crlf)
1403 : !write_chunk(fd, US"\n.\n", 3, use_crlf)
1407 /* Write out any remaining data in the buffer. */
1410 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1411 || transport_write_block(fd, deliver_out_buffer, len);
1414 errno = save_errno; /* From some earlier error */
1418 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1420 debug_printf("errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1430 /*************************************************
1431 * Update waiting database *
1432 *************************************************/
1434 /* This is called when an address is deferred by remote transports that are
1435 capable of sending more than one message over one connection. A database is
1436 maintained for each transport, keeping track of which messages are waiting for
1437 which hosts. The transport can then consult this when eventually a successful
1438 delivery happens, and if it finds that another message is waiting for the same
1439 host, it can fire up a new process to deal with it using the same connection.
1441 The database records are keyed by host name. They can get full if there are
1442 lots of messages waiting, and so there is a continuation mechanism for them.
1444 Each record contains a list of message ids, packed end to end without any
1445 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1446 in this record, and the sequence field says if there are any other records for
1447 this host. If the sequence field is 0, there are none. If it is 1, then another
1448 record with the name <hostname>:0 exists; if it is 2, then two other records
1449 with sequence numbers 0 and 1 exist, and so on.
1451 Currently, an exhaustive search of all continuation records has to be done to
1452 determine whether to add a message id to a given record. This shouldn't be
1453 too bad except in extreme cases. I can't figure out a *simple* way of doing
1456 Old records should eventually get swept up by the exim_tidydb utility.
1459 hostlist list of hosts that this message could be sent to
1460 tpname name of the transport
1466 transport_update_waiting(host_item *hostlist, uschar *tpname)
1469 const uschar *prevname = US"";
1474 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1476 /* Open the database for this transport */
1478 sprintf(CS buffer, "wait-%.200s", tpname);
1479 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1480 if (dbm_file == NULL) return;
1482 /* Scan the list of hosts for which this message is waiting, and ensure
1483 that the message id is in each host record. */
1485 for (host = hostlist; host!= NULL; host = host->next)
1487 BOOL already = FALSE;
1488 dbdata_wait *host_record;
1492 /* Skip if this is the same host as we just processed; otherwise remember
1493 the name for next time. */
1495 if (Ustrcmp(prevname, host->name) == 0) continue;
1496 prevname = host->name;
1498 /* Look up the host record; if there isn't one, make an empty one. */
1500 host_record = dbfn_read(dbm_file, host->name);
1501 if (host_record == NULL)
1503 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1504 host_record->count = host_record->sequence = 0;
1507 /* Compute the current length */
1509 host_length = host_record->count * MESSAGE_ID_LENGTH;
1511 /* Search the record to see if the current message is already in it. */
1513 for (s = host_record->text; s < host_record->text + host_length;
1514 s += MESSAGE_ID_LENGTH)
1516 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1517 { already = TRUE; break; }
1520 /* If we haven't found this message in the main record, search any
1521 continuation records that exist. */
1523 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1526 sprintf(CS buffer, "%.200s:%d", host->name, i);
1527 cont = dbfn_read(dbm_file, buffer);
1530 int clen = cont->count * MESSAGE_ID_LENGTH;
1531 for (s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1533 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1534 { already = TRUE; break; }
1539 /* If this message is already in a record, no need to update. */
1543 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1548 /* If this record is full, write it out with a new name constructed
1549 from the sequence number, increase the sequence number, and empty
1552 if (host_record->count >= WAIT_NAME_MAX)
1554 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1555 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1556 host_record->sequence++;
1557 host_record->count = 0;
1561 /* If this record is not full, increase the size of the record to
1562 allow for one new message id. */
1567 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1568 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1572 /* Now add the new name on the end */
1574 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1575 host_record->count++;
1576 host_length += MESSAGE_ID_LENGTH;
1578 /* Update the database */
1580 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1581 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1586 dbfn_close(dbm_file);
1592 /*************************************************
1593 * Test for waiting messages *
1594 *************************************************/
1596 /* This function is called by a remote transport which uses the previous
1597 function to remember which messages are waiting for which remote hosts. It's
1598 called after a successful delivery and its job is to check whether there is
1599 another message waiting for the same host. However, it doesn't do this if the
1600 current continue sequence is greater than the maximum supplied as an argument,
1601 or greater than the global connection_max_messages, which, if set, overrides.
1604 transport_name name of the transport
1605 hostname name of the host
1606 local_message_max maximum number of messages down one connection
1607 as set by the caller transport
1608 new_message_id set to the message id of a waiting message
1609 more set TRUE if there are yet more messages waiting
1610 oicf_func function to call to validate if it is ok to send
1611 to this message_id from the current instance.
1612 oicf_data opaque data for oicf_func
1614 Returns: TRUE if new_message_id set; FALSE otherwise
1617 typedef struct msgq_s
1619 uschar message_id [MESSAGE_ID_LENGTH + 1];
1624 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1625 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1627 dbdata_wait *host_record;
1634 struct stat statbuf;
1640 debug_printf("transport_check_waiting entered\n");
1641 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1642 continue_sequence, local_message_max, connection_max_messages);
1645 /* Do nothing if we have hit the maximum number that can be send down one
1648 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1649 if (local_message_max > 0 && continue_sequence >= local_message_max)
1652 debug_printf("max messages for one connection reached: returning\n");
1656 /* Open the waiting information database. */
1658 sprintf(CS buffer, "wait-%.200s", transport_name);
1659 dbm_file = dbfn_open(buffer, O_RDWR, &dbblock, TRUE);
1660 if (dbm_file == NULL) return FALSE;
1662 /* See if there is a record for this host; if not, there's nothing to do. */
1664 if (!(host_record = dbfn_read(dbm_file, hostname)))
1666 dbfn_close(dbm_file);
1667 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1671 /* If the data in the record looks corrupt, just log something and
1672 don't try to use it. */
1674 if (host_record->count > WAIT_NAME_MAX)
1676 dbfn_close(dbm_file);
1677 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1678 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1682 /* Scan the message ids in the record from the end towards the beginning,
1683 until one is found for which a spool file actually exists. If the record gets
1684 emptied, delete it and continue with any continuation records that may exist.
1687 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1688 but the 1 off will remain without it. This code now allows me to SKIP over
1689 a message I do not want to send out on this run. */
1691 host_length = host_record->count * MESSAGE_ID_LENGTH;
1697 int msgq_actual = 0;
1698 BOOL bFound = FALSE;
1699 BOOL bContinuation = FALSE;
1701 /* create an array to read entire message queue into memory for processing */
1703 msgq = (msgq_t*) malloc(sizeof(msgq_t) * host_record->count);
1704 msgq_count = host_record->count;
1705 msgq_actual = msgq_count;
1707 for (i = 0; i < host_record->count; ++i)
1709 msgq[i].bKeep = TRUE;
1711 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1713 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1716 /* first thing remove current message id if it exists */
1718 for (i = 0; i < msgq_count; ++i)
1719 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1721 msgq[i].bKeep = FALSE;
1725 /* now find the next acceptable message_id */
1727 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1731 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1734 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1736 msgq[i].bKeep = FALSE;
1737 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1739 Ustrcpy(new_message_id, msgq[i].message_id);
1740 msgq[i].bKeep = FALSE;
1747 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1751 /* reassemble the host record, based on removed message ids, from in
1754 if (msgq_actual <= 0)
1757 host_record->count = 0;
1761 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1762 host_record->count = msgq_actual;
1764 if (msgq_actual < msgq_count)
1767 for (new_count = 0, i = 0; i < msgq_count; ++i)
1769 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1770 msgq[i].message_id, MESSAGE_ID_LENGTH);
1772 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1776 /* Jeremy: check for a continuation record, this code I do not know how to
1777 test but the code should work */
1779 while (host_length <= 0)
1782 dbdata_wait * newr = NULL;
1784 /* Search for a continuation */
1786 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1788 sprintf(CS buffer, "%.200s:%d", hostname, i);
1789 newr = dbfn_read(dbm_file, buffer);
1792 /* If no continuation, delete the current and break the loop */
1796 dbfn_delete(dbm_file, hostname);
1800 /* Else replace the current with the continuation */
1802 dbfn_delete(dbm_file, buffer);
1804 host_length = host_record->count * MESSAGE_ID_LENGTH;
1806 bContinuation = TRUE;
1809 if (bFound) /* Usual exit from main loop */
1815 /* If host_length <= 0 we have emptied a record and not found a good message,
1816 and there are no continuation records. Otherwise there is a continuation
1817 record to process. */
1819 if (host_length <= 0)
1821 dbfn_close(dbm_file);
1822 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1826 /* we were not able to find an acceptable message, nor was there a
1827 * continuation record. So bug out, outer logic will clean this up.
1832 Ustrcpy(new_message_id, message_id);
1833 dbfn_close(dbm_file);
1838 } /* we need to process a continuation record */
1840 /* Control gets here when an existing message has been encountered; its
1841 id is in new_message_id, and host_length is the revised length of the
1842 host record. If it is zero, the record has been removed. Update the
1843 record if required, close the database, and return TRUE. */
1845 if (host_length > 0)
1847 host_record->count = host_length/MESSAGE_ID_LENGTH;
1849 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1853 dbfn_close(dbm_file);
1857 /*************************************************
1858 * Deliver waiting message down same socket *
1859 *************************************************/
1861 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1862 get a clean delivery process, and to regain root privilege in cases where it
1863 has been given away.
1866 transport_name to pass to the new process
1869 id the new message to process
1870 socket_fd the connected socket
1872 Returns: FALSE if fork fails; TRUE otherwise
1876 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1877 const uschar *hostaddress, uschar *id, int socket_fd)
1882 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1884 if ((pid = fork()) == 0)
1887 const uschar **argv;
1889 /* Disconnect entirely from the parent process. If we are running in the
1890 test harness, wait for a bit to allow the previous process time to finish,
1891 write the log, etc., so that the output is always in the same order for
1892 automatic comparison. */
1894 if ((pid = fork()) != 0) _exit(EXIT_SUCCESS);
1895 if (running_in_test_harness) sleep(1);
1897 /* Set up the calling arguments; use the standard function for the basics,
1898 but we have a number of extras that may be added. */
1900 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1902 if (smtp_use_dsn) argv[i++] = US"-MCD";
1904 if (smtp_authenticated) argv[i++] = US"-MCA";
1907 if (tls_offered) argv[i++] = US"-MCT";
1910 if (smtp_use_size) argv[i++] = US"-MCS";
1911 if (smtp_use_pipelining) argv[i++] = US"-MCP";
1913 if (queue_run_pid != (pid_t)0)
1915 argv[i++] = US"-MCQ";
1916 argv[i++] = string_sprintf("%d", queue_run_pid);
1917 argv[i++] = string_sprintf("%d", queue_run_pipe);
1920 argv[i++] = US"-MC";
1921 argv[i++] = US transport_name;
1922 argv[i++] = US hostname;
1923 argv[i++] = US hostaddress;
1924 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1928 /* Arrange for the channel to be on stdin. */
1932 (void)dup2(socket_fd, 0);
1933 (void)close(socket_fd);
1936 DEBUG(D_exec) debug_print_argv(argv);
1937 exim_nullstd(); /* Ensure std{out,err} exist */
1938 execv(CS argv[0], (char *const *)argv);
1940 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1941 _exit(errno); /* Note: must be _exit(), NOT exit() */
1944 /* If the process creation succeeded, wait for the first-level child, which
1945 immediately exits, leaving the second level process entirely disconnected from
1951 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1952 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded\n");
1957 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1965 /*************************************************
1966 * Set up direct (non-shell) command *
1967 *************************************************/
1969 /* This function is called when a command line is to be parsed and executed
1970 directly, without the use of /bin/sh. It is called by the pipe transport,
1971 the queryprogram router, and also from the main delivery code when setting up a
1972 transport filter process. The code for ETRN also makes use of this; in that
1973 case, no addresses are passed.
1976 argvptr pointer to anchor for argv vector
1977 cmd points to the command string (modified IN PLACE)
1978 expand_arguments true if expansion is to occur
1979 expand_failed error value to set if expansion fails; not relevant if
1981 addr chain of addresses, or NULL
1982 etext text for use in error messages
1983 errptr where to put error message if addr is NULL;
1984 otherwise it is put in the first address
1986 Returns: TRUE if all went well; otherwise an error will be
1987 set in the first address and FALSE returned
1991 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
1992 BOOL expand_arguments, int expand_failed, address_item *addr,
1993 uschar *etext, uschar **errptr)
1996 const uschar **argv;
1998 int address_count = 0;
2002 /* Get store in which to build an argument list. Count the number of addresses
2003 supplied, and allow for that many arguments, plus an additional 60, which
2004 should be enough for anybody. Multiple addresses happen only when the local
2005 delivery batch option is set. */
2007 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2008 max_args = address_count + 60;
2009 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2011 /* Split the command up into arguments terminated by white space. Lose
2012 trailing space at the start and end. Double-quoted arguments can contain \\ and
2013 \" escapes and so can be handled by the standard function; single-quoted
2014 arguments are verbatim. Copy each argument into a new string. */
2017 while (isspace(*s)) s++;
2019 while (*s != 0 && argcount < max_args)
2024 while (*ss != 0 && *ss != '\'') ss++;
2025 argv[argcount++] = ss = store_get(ss - s++);
2026 while (*s != 0 && *s != '\'') *ss++ = *s++;
2030 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2031 while (isspace(*s)) s++;
2034 argv[argcount] = (uschar *)0;
2036 /* If *s != 0 we have run out of argument slots. */
2040 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2044 addr->transport_return = FAIL;
2045 addr->message = msg;
2051 /* Expand each individual argument if required. Expansion happens for pipes set
2052 up in filter files and with directly-supplied commands. It does not happen if
2053 the pipe comes from a traditional .forward file. A failing expansion is a big
2054 disaster if the command came from Exim's configuration; if it came from a user
2055 it is just a normal failure. The expand_failed value is used as the error value
2056 to cater for these two cases.
2058 An argument consisting just of the text "$pipe_addresses" is treated specially.
2059 It is not passed to the general expansion function. Instead, it is replaced by
2060 a number of arguments, one for each address. This avoids problems with shell
2061 metacharacters and spaces in addresses.
2063 If the parent of the top address has an original part of "system-filter", this
2064 pipe was set up by the system filter, and we can permit the expansion of
2069 debug_printf("direct command:\n");
2070 for (i = 0; argv[i] != (uschar *)0; i++)
2071 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2074 if (expand_arguments)
2076 BOOL allow_dollar_recipients = addr != NULL &&
2077 addr->parent != NULL &&
2078 Ustrcmp(addr->parent->address, "system-filter") == 0;
2080 for (i = 0; argv[i] != (uschar *)0; i++)
2083 /* Handle special fudge for passing an address list */
2086 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2087 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2091 if (argcount + address_count - 1 > max_args)
2093 addr->transport_return = FAIL;
2094 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2095 "in %s", cmd, etext);
2099 additional = address_count - 1;
2101 memmove(argv + i + 1 + additional, argv + i + 1,
2102 (argcount - i)*sizeof(uschar *));
2104 for (ad = addr; ad != NULL; ad = ad->next) {
2105 argv[i++] = ad->address;
2109 /* Subtract one since we replace $pipe_addresses */
2114 /* Handle special case of $address_pipe when af_force_command is set */
2116 else if (addr != NULL && testflag(addr,af_force_command) &&
2117 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2118 Ustrcmp(argv[i], "${address_pipe}") == 0))
2121 int address_pipe_argcount = 0;
2122 int address_pipe_max_args;
2123 uschar **address_pipe_argv;
2125 /* We can never have more then the argv we will be loading into */
2126 address_pipe_max_args = max_args - argcount + 1;
2129 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2131 /* We allocate an additional for (uschar *)0 */
2132 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2134 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2135 s = expand_string(addr->local_part + 1);
2137 if (s == NULL || *s == '\0')
2139 addr->transport_return = FAIL;
2140 addr->message = string_sprintf("Expansion of \"%s\" "
2141 "from command \"%s\" in %s failed: %s",
2142 (addr->local_part + 1), cmd, etext, expand_string_message);
2146 while (isspace(*s)) s++; /* strip leading space */
2148 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2153 while (*ss != 0 && *ss != '\'') ss++;
2154 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2155 while (*s != 0 && *s != '\'') *ss++ = *s++;
2159 else address_pipe_argv[address_pipe_argcount++] =
2160 string_copy(string_dequote(CUSS &s));
2161 while (isspace(*s)) s++; /* strip space after arg */
2164 address_pipe_argv[address_pipe_argcount] = (uschar *)0;
2166 /* If *s != 0 we have run out of argument slots. */
2169 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2170 "\"%s\" in %s", addr->local_part + 1, etext);
2173 addr->transport_return = FAIL;
2174 addr->message = msg;
2180 /* address_pipe_argcount - 1
2181 * because we are replacing $address_pipe in the argument list
2182 * with the first thing it expands to */
2183 if (argcount + address_pipe_argcount - 1 > max_args)
2185 addr->transport_return = FAIL;
2186 addr->message = string_sprintf("Too many arguments to command "
2187 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2191 /* If we are not just able to replace the slot that contained
2192 * $address_pipe (address_pipe_argcount == 1)
2193 * We have to move the existing argv by address_pipe_argcount - 1
2194 * Visually if address_pipe_argcount == 2:
2195 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2196 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2198 if (address_pipe_argcount > 1)
2200 /* current position + additonal args */
2201 argv + i + address_pipe_argcount,
2202 /* current position + 1 (for the (uschar *)0 at the end) */
2204 /* -1 for the (uschar *)0 at the end)*/
2205 (argcount - i)*sizeof(uschar *)
2208 /* Now we fill in the slots we just moved argv out of
2209 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2211 for (address_pipe_i = 0;
2212 address_pipe_argv[address_pipe_i] != (uschar *)0;
2215 argv[i++] = address_pipe_argv[address_pipe_i];
2219 /* Subtract one since we replace $address_pipe */
2224 /* Handle normal expansion string */
2228 const uschar *expanded_arg;
2229 enable_dollar_recipients = allow_dollar_recipients;
2230 expanded_arg = expand_cstring(argv[i]);
2231 enable_dollar_recipients = FALSE;
2233 if (expanded_arg == NULL)
2235 uschar *msg = string_sprintf("Expansion of \"%s\" "
2236 "from command \"%s\" in %s failed: %s",
2237 argv[i], cmd, etext, expand_string_message);
2240 addr->transport_return = expand_failed;
2241 addr->message = msg;
2246 argv[i] = expanded_arg;
2252 debug_printf("direct command after expansion:\n");
2253 for (i = 0; argv[i] != (uschar *)0; i++)
2254 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2263 /* End of transport.c */