1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* General functions concerned with transportation, and generic options for all
14 /* Generic options for transports, all of which live inside transport_instance
15 data blocks and which therefore have the opt_public flag set. Note that there
16 are other options living inside this structure which can be set only from
17 certain transports. */
19 optionlist optionlist_transports[] = {
21 { "*expand_group", opt_stringptr|opt_hidden|opt_public,
22 (void *)offsetof(transport_instance, expand_gid) },
23 { "*expand_user", opt_stringptr|opt_hidden|opt_public,
24 (void *)offsetof(transport_instance, expand_uid) },
25 { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
26 (void *)offsetof(transport_instance, rewrite_existflags) },
27 { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
28 (void *)offsetof(transport_instance, rewrite_rules) },
29 { "*set_group", opt_bool|opt_hidden|opt_public,
30 (void *)offsetof(transport_instance, gid_set) },
31 { "*set_user", opt_bool|opt_hidden|opt_public,
32 (void *)offsetof(transport_instance, uid_set) },
33 { "body_only", opt_bool|opt_public,
34 (void *)offsetof(transport_instance, body_only) },
35 { "current_directory", opt_stringptr|opt_public,
36 (void *)offsetof(transport_instance, current_dir) },
37 { "debug_print", opt_stringptr | opt_public,
38 (void *)offsetof(transport_instance, debug_string) },
39 { "delivery_date_add", opt_bool|opt_public,
40 (void *)(offsetof(transport_instance, delivery_date_add)) },
41 { "disable_logging", opt_bool|opt_public,
42 (void *)(offsetof(transport_instance, disable_logging)) },
43 { "driver", opt_stringptr|opt_public,
44 (void *)offsetof(transport_instance, driver_name) },
45 { "envelope_to_add", opt_bool|opt_public,
46 (void *)(offsetof(transport_instance, envelope_to_add)) },
48 { "event_action", opt_stringptr | opt_public,
49 (void *)offsetof(transport_instance, event_action) },
51 { "group", opt_expand_gid|opt_public,
52 (void *)offsetof(transport_instance, gid) },
53 { "headers_add", opt_stringptr|opt_public|opt_rep_str,
54 (void *)offsetof(transport_instance, add_headers) },
55 { "headers_only", opt_bool|opt_public,
56 (void *)offsetof(transport_instance, headers_only) },
57 { "headers_remove", opt_stringptr|opt_public|opt_rep_str,
58 (void *)offsetof(transport_instance, remove_headers) },
59 { "headers_rewrite", opt_rewrite|opt_public,
60 (void *)offsetof(transport_instance, headers_rewrite) },
61 { "home_directory", opt_stringptr|opt_public,
62 (void *)offsetof(transport_instance, home_dir) },
63 { "initgroups", opt_bool|opt_public,
64 (void *)offsetof(transport_instance, initgroups) },
65 { "max_parallel", opt_stringptr|opt_public,
66 (void *)offsetof(transport_instance, max_parallel) },
67 { "message_size_limit", opt_stringptr|opt_public,
68 (void *)offsetof(transport_instance, message_size_limit) },
69 { "rcpt_include_affixes", opt_bool|opt_public,
70 (void *)offsetof(transport_instance, rcpt_include_affixes) },
71 { "retry_use_local_part", opt_bool|opt_public,
72 (void *)offsetof(transport_instance, retry_use_local_part) },
73 { "return_path", opt_stringptr|opt_public,
74 (void *)(offsetof(transport_instance, return_path)) },
75 { "return_path_add", opt_bool|opt_public,
76 (void *)(offsetof(transport_instance, return_path_add)) },
77 { "shadow_condition", opt_stringptr|opt_public,
78 (void *)offsetof(transport_instance, shadow_condition) },
79 { "shadow_transport", opt_stringptr|opt_public,
80 (void *)offsetof(transport_instance, shadow) },
81 { "transport_filter", opt_stringptr|opt_public,
82 (void *)offsetof(transport_instance, filter_command) },
83 { "transport_filter_timeout", opt_time|opt_public,
84 (void *)offsetof(transport_instance, filter_timeout) },
85 { "user", opt_expand_uid|opt_public,
86 (void *)offsetof(transport_instance, uid) }
89 int optionlist_transports_size = nelem(optionlist_transports);
93 # include "macro_predef.h"
96 options_transports(void)
98 struct transport_info * ti;
101 options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
103 for (ti = transports_available; ti->driver_name[0]; ti++)
105 spf(buf, sizeof(buf), US"_DRIVER_TRANSPORT_%T", ti->driver_name);
106 builtin_macro_create(buf);
107 options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
111 #else /*!MACRO_PREDEF*/
113 /* Structure for keeping list of addresses that have been added to
114 Envelope-To:, in order to avoid duplication. */
122 /* Static data for write_chunk() */
124 static uschar *chunk_ptr; /* chunk pointer */
125 static uschar *nl_check; /* string to look for at line start */
126 static int nl_check_length; /* length of same */
127 static uschar *nl_escape; /* string to insert */
128 static int nl_escape_length; /* length of same */
129 static int nl_partial_match; /* length matched at chunk end */
132 /*************************************************
133 * Initialize transport list *
134 *************************************************/
136 /* Read the transports section of the configuration file, and set up a chain of
137 transport instances according to its contents. Each transport has generic
138 options and may also have its own private options. This function is only ever
139 called when transports == NULL. We use generic code in readconf to do most of
145 transport_instance *t;
147 readconf_driver_init(US"transport",
148 (driver_instance **)(&transports), /* chain anchor */
149 (driver_info *)transports_available, /* available drivers */
150 sizeof(transport_info), /* size of info block */
151 &transport_defaults, /* default values for generic options */
152 sizeof(transport_instance), /* size of instance block */
153 optionlist_transports, /* generic options */
154 optionlist_transports_size);
156 /* Now scan the configured transports and check inconsistencies. A shadow
157 transport is permitted only for local transports. */
159 for (t = transports; t; t = t->next)
161 if (!t->info->local && t->shadow)
162 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
163 "shadow transport not allowed on non-local transport %s", t->name);
165 if (t->body_only && t->headers_only)
166 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
167 "%s transport: body_only and headers_only are mutually exclusive",
174 /*************************************************
175 * Write block of data *
176 *************************************************/
178 /* Subroutine called by write_chunk() and at the end of the message actually
179 to write a data block. Also called directly by some transports to write
180 additional data to the file descriptor (e.g. prefix, suffix).
182 If a transport wants data transfers to be timed, it sets a non-zero value in
183 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
184 be set for each block of data written from here. If time runs out, then write()
185 fails and provokes an error return. The caller can then inspect sigalrm_seen to
188 On some systems, if a quota is exceeded during the write, the yield is the
189 number of bytes written rather than an immediate error code. This also happens
190 on some systems in other cases, for example a pipe that goes away because the
191 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
192 get the error codes the first time.
194 The write() function is also interruptible; the Solaris 2.6 man page says:
196 If write() is interrupted by a signal before it writes any
197 data, it will return -1 with errno set to EINTR.
199 If write() is interrupted by a signal after it successfully
200 writes some data, it will return the number of bytes written.
202 To handle these cases, we want to restart the write() to output the remainder
203 of the data after a non-negative return from write(), except after a timeout.
204 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
205 proper error then occurs. In principle, after an interruption, the second
206 write() could suffer the same fate, but we do not want to continue for
207 evermore, so stick a maximum repetition count on the loop to act as a
211 tctx transport context: file descriptor or string to write to
212 block block of bytes to write
213 len number of bytes to write
214 more further data expected soon
216 Returns: TRUE on success, FALSE on failure (with errno preserved);
217 transport_count is incremented by the number of bytes written
221 transport_write_block_fd(transport_ctx * tctx, uschar *block, int len, BOOL more)
223 int i, rc, save_errno;
224 int local_timeout = transport_write_timeout;
227 /* This loop is for handling incomplete writes and other retries. In most
228 normal cases, it is only ever executed once. */
230 for (i = 0; i < 100; i++)
233 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
234 fd, len, local_timeout, more ? " (more expected)" : "");
236 /* This code makes use of alarm() in order to implement the timeout. This
237 isn't a very tidy way of doing things. Using non-blocking I/O with select()
238 provides a neater approach. However, I don't know how to do this when TLS is
241 if (transport_write_timeout <= 0) /* No timeout wanted */
245 tls_out.active.sock == fd ? tls_write(tls_out.active.tls_ctx, block, len, more) :
248 more && !(tctx->options & topt_not_socket)
249 ? send(fd, block, len, MSG_MORE) :
251 write(fd, block, len);
255 /* Timeout wanted. */
259 ALARM(local_timeout);
263 tls_out.active.sock == fd ? tls_write(tls_out.active.tls_ctx, block, len, more) :
266 more && !(tctx->options & topt_not_socket)
267 ? send(fd, block, len, MSG_MORE) :
269 write(fd, block, len);
272 local_timeout = ALARM_CLR(0);
280 /* Hopefully, the most common case is success, so test that first. */
282 if (rc == len) { transport_count += len; return TRUE; }
284 /* A non-negative return code is an incomplete write. Try again for the rest
285 of the block. If we have exactly hit the timeout, give up. */
291 transport_count += rc;
292 DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
293 goto CHECK_TIMEOUT; /* A few lines below */
296 /* A negative return code with an EINTR error is another form of
297 incomplete write, zero bytes having been written */
299 if (save_errno == EINTR)
302 debug_printf("write interrupted before anything written\n");
303 goto CHECK_TIMEOUT; /* A few lines below */
306 /* A response of EAGAIN from write() is likely only in the case of writing
307 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
309 if (save_errno == EAGAIN)
312 debug_printf("write temporarily locked out, waiting 1 sec\n");
315 /* Before continuing to try another write, check that we haven't run out of
319 if (transport_write_timeout > 0 && local_timeout <= 0)
327 /* Otherwise there's been an error */
329 DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
330 strerror(save_errno));
335 /* We've tried and tried and tried but still failed */
337 errno = ERRNO_WRITEINCOMPLETE;
343 transport_write_block(transport_ctx * tctx, uschar *block, int len, BOOL more)
345 if (!(tctx->options & topt_output_string))
346 return transport_write_block_fd(tctx, block, len, more);
348 /* Write to expanding-string. NOTE: not NUL-terminated */
351 tctx->u.msg = string_get(1024);
353 tctx->u.msg = string_catn(tctx->u.msg, block, len);
360 /*************************************************
361 * Write formatted string *
362 *************************************************/
364 /* This is called by various transports. It is a convenience function.
369 ... arguments for format
371 Returns: the yield of transport_write_block()
375 transport_write_string(int fd, const char *format, ...)
377 transport_ctx tctx = {{0}};
378 gstring gs = { .size = big_buffer_size, .ptr = 0, .s = big_buffer };
381 va_start(ap, format);
382 if (!string_vformat(&gs, FALSE, format, ap))
383 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
386 return transport_write_block(&tctx, gs.s, gs.ptr, FALSE);
393 transport_write_reset(int options)
395 if (!(options & topt_continuation)) chunk_ptr = deliver_out_buffer;
396 nl_partial_match = -1;
397 nl_check_length = nl_escape_length = 0;
402 /*************************************************
403 * Write character chunk *
404 *************************************************/
406 /* Subroutine used by transport_write_message() to scan character chunks for
407 newlines and act appropriately. The object is to minimise the number of writes.
408 The output byte stream is buffered up in deliver_out_buffer, which is written
409 only when it gets full, thus minimizing write operations and TCP packets.
411 Static data is used to handle the case when the last character of the previous
412 chunk was NL, or matched part of the data that has to be escaped.
415 tctx transport context - processing to be done during output,
416 and file descriptor to write to
417 chunk pointer to data to write
418 len length of data to write
420 In addition, the static nl_xxx variables must be set as required.
422 Returns: TRUE on success, FALSE on failure (with errno preserved)
426 write_chunk(transport_ctx * tctx, uschar *chunk, int len)
428 uschar *start = chunk;
429 uschar *end = chunk + len;
431 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
433 /* The assumption is made that the check string will never stretch over move
434 than one chunk since the only time there are partial matches is when copying
435 the body in large buffers. There is always enough room in the buffer for an
436 escape string, since the loop below ensures this for each character it
437 processes, and it won't have stuck in the escape string if it left a partial
440 if (nl_partial_match >= 0)
442 if (nl_check_length > 0 && len >= nl_check_length &&
443 Ustrncmp(start, nl_check + nl_partial_match,
444 nl_check_length - nl_partial_match) == 0)
446 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
447 chunk_ptr += nl_escape_length;
448 start += nl_check_length - nl_partial_match;
451 /* The partial match was a false one. Insert the characters carried over
452 from the previous chunk. */
454 else if (nl_partial_match > 0)
456 Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
457 chunk_ptr += nl_partial_match;
460 nl_partial_match = -1;
463 /* Now process the characters in the chunk. Whenever we hit a newline we check
464 for possible escaping. The code for the non-NL route should be as fast as
467 for (ptr = start; ptr < end; ptr++)
471 /* Flush the buffer if it has reached the threshold - we want to leave enough
472 room for the next uschar, plus a possible extra CR for an LF, plus the escape
475 if ((len = chunk_ptr - deliver_out_buffer) > mlen)
477 DEBUG(D_transport) debug_printf("flushing headers buffer\n");
479 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
480 from previous SMTP commands. */
482 if (tctx->options & topt_use_bdat && tctx->chunk_cb)
484 if ( tctx->chunk_cb(tctx, (unsigned)len, 0) != OK
485 || !transport_write_block(tctx, deliver_out_buffer, len, FALSE)
486 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
491 if (!transport_write_block(tctx, deliver_out_buffer, len, FALSE))
493 chunk_ptr = deliver_out_buffer;
496 /* Remove CR before NL if required */
498 if ( *ptr == '\r' && ptr[1] == '\n'
499 && !(tctx->options & topt_use_crlf)
500 && f.spool_file_wireformat
504 if ((ch = *ptr) == '\n')
506 int left = end - ptr - 1; /* count of chars left after NL */
508 /* Insert CR before NL if required */
510 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
513 transport_newlines++;
515 /* The check_string test (formerly "from hack") replaces the specific
516 string at the start of a line with an escape string (e.g. "From " becomes
517 ">From " or "." becomes "..". It is a case-sensitive test. The length
518 check above ensures there is always enough room to insert this string. */
520 if (nl_check_length > 0)
522 if (left >= nl_check_length &&
523 Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
525 Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
526 chunk_ptr += nl_escape_length;
527 ptr += nl_check_length;
530 /* Handle the case when there isn't enough left to match the whole
531 check string, but there may be a partial match. We remember how many
532 characters matched, and finish processing this chunk. */
534 else if (left <= 0) nl_partial_match = 0;
536 else if (Ustrncmp(ptr+1, nl_check, left) == 0)
538 nl_partial_match = left;
544 /* Not a NL character */
546 else *chunk_ptr++ = ch;
555 /*************************************************
556 * Generate address for RCPT TO *
557 *************************************************/
559 /* This function puts together an address for RCPT to, using the caseful
560 version of the local part and the caseful version of the domain. If there is no
561 prefix or suffix, or if affixes are to be retained, we can just use the
562 original address. Otherwise, if there is a prefix but no suffix we can use a
563 pointer into the original address. If there is a suffix, however, we have to
567 addr the address item
568 include_affixes TRUE if affixes are to be included
574 transport_rcpt_address(address_item *addr, BOOL include_affixes)
581 setflag(addr, af_include_affixes); /* Affects logged => line */
582 return addr->address;
585 if (addr->suffix == NULL)
587 if (addr->prefix == NULL) return addr->address;
588 return addr->address + Ustrlen(addr->prefix);
591 at = Ustrrchr(addr->address, '@');
592 plen = (addr->prefix == NULL)? 0 : Ustrlen(addr->prefix);
593 slen = Ustrlen(addr->suffix);
595 return string_sprintf("%.*s@%s", (int)(at - addr->address - plen - slen),
596 addr->address + plen, at + 1);
600 /*************************************************
601 * Output Envelope-To: address & scan duplicates *
602 *************************************************/
604 /* This function is called from internal_transport_write_message() below, when
605 generating an Envelope-To: header line. It checks for duplicates of the given
606 address and its ancestors. When one is found, this function calls itself
607 recursively, to output the envelope address of the duplicate.
609 We want to avoid duplication in the list, which can arise for example when
610 A->B,C and then both B and C alias to D. This can also happen when there are
611 unseen drivers in use. So a list of addresses that have been output is kept in
614 It is also possible to have loops in the address ancestry/duplication graph,
615 for example if there are two top level addresses A and B and we have A->B,C and
616 B->A. To break the loop, we use a list of processed addresses in the dlist
619 After handling duplication, this function outputs the progenitor of the given
623 p the address we are interested in
624 pplist address of anchor of the list of addresses not to output
625 pdlist address of anchor of the list of processed addresses
626 first TRUE if this is the first address; set it FALSE afterwards
627 tctx transport context - processing to be done during output
628 and the file descriptor to write to
630 Returns: FALSE if writing failed
634 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
635 BOOL *first, transport_ctx * tctx)
640 /* Do nothing if we have already handled this address. If not, remember it
641 so that we don't handle it again. */
643 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
645 ppp = store_get(sizeof(struct aci));
650 /* Now scan up the ancestry, checking for duplicates at each generation. */
652 for (pp = p;; pp = pp->parent)
655 for (dup = addr_duplicate; dup; dup = dup->next)
656 if (dup->dupof == pp) /* a dup of our address */
657 if (!write_env_to(dup, pplist, pdlist, first, tctx))
659 if (!pp->parent) break;
662 /* Check to see if we have already output the progenitor. */
664 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
665 if (ppp) return TRUE;
667 /* Remember what we have output, and output it. */
669 ppp = store_get(sizeof(struct aci));
674 if (!*first && !write_chunk(tctx, US",\n ", 3)) return FALSE;
676 return write_chunk(tctx, pp->address, Ustrlen(pp->address));
682 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
688 addr (chain of) addresses (for extra headers), or NULL;
689 only the first address is used
690 tctx transport context
691 sendfn function for output (transport or verify)
693 Returns: TRUE on success; FALSE on failure.
696 transport_headers_send(transport_ctx * tctx,
697 BOOL (*sendfn)(transport_ctx * tctx, uschar * s, int len))
701 transport_instance * tblock = tctx ? tctx->tblock : NULL;
702 address_item * addr = tctx ? tctx->addr : NULL;
704 /* Then the message's headers. Don't write any that are flagged as "old";
705 that means they were rewritten, or are a record of envelope rewriting, or
706 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
707 match any entries therein. It is a colon-sep list; expand the items
708 separately and squash any empty ones.
709 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
711 for (h = header_list; h; h = h->next) if (h->type != htype_old)
714 BOOL include_header = TRUE;
716 list = tblock ? tblock->remove_headers : NULL;
717 for (i = 0; i < 2; i++) /* For remove_headers && addr->prop.remove_headers */
721 int sep = ':'; /* This is specified as a colon-separated list */
723 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
728 if (!(s = expand_string(s)) && !f.expand_string_forcedfail)
730 errno = ERRNO_CHHEADER_FAIL;
733 len = s ? Ustrlen(s) : 0;
734 if (strncmpic(h->text, s, len) != 0) continue;
736 while (*ss == ' ' || *ss == '\t') ss++;
737 if (*ss == ':') break;
739 if (s) { include_header = FALSE; break; }
741 if (addr) list = addr->prop.remove_headers;
744 /* If this header is to be output, try to rewrite it if there are rewriting
749 if (tblock && tblock->rewrite_rules)
751 void *reset_point = store_get(0);
754 if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
755 tblock->rewrite_existflags, FALSE)))
757 if (!sendfn(tctx, hh->text, hh->slen)) return FALSE;
758 store_reset(reset_point);
759 continue; /* With the next header line */
763 /* Either no rewriting rules, or it didn't get rewritten */
765 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
771 DEBUG(D_transport) debug_printf("removed header line:\n%s---\n", h->text);
774 /* Add on any address-specific headers. If there are multiple addresses,
775 they will all have the same headers in order to be batched. The headers
776 are chained in reverse order of adding (so several addresses from the
777 same alias might share some of them) but we want to output them in the
778 opposite order. This is a bit tedious, but there shouldn't be very many
779 of them. We just walk the list twice, reversing the pointers each time,
780 but on the second time, write out the items.
782 Headers added to an address by a router are guaranteed to end with a newline.
788 header_line *hprev = addr->prop.extra_headers;
790 for (i = 0; i < 2; i++)
791 for (h = hprev, hprev = NULL; h; h = hnext)
798 if (!sendfn(tctx, h->text, h->slen)) return FALSE;
800 debug_printf("added header line(s):\n%s---\n", h->text);
805 /* If a string containing additional headers exists it is a newline-sep
806 list. Expand each item and write out the result. This is done last so that
807 if it (deliberately or accidentally) isn't in header format, it won't mess
808 up any other headers. An empty string or a forced expansion failure are
809 noops. An added header string from a transport may not end with a newline;
810 add one if it does not. */
812 if (tblock && (list = CUS tblock->add_headers))
817 while ((s = string_nextinlist(&list, &sep, NULL, 0)))
818 if ((s = expand_string(s)))
820 int len = Ustrlen(s);
823 if (!sendfn(tctx, s, len)) return FALSE;
824 if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
828 debug_printf("added header line:\n%s", s);
829 if (s[len-1] != '\n') debug_printf("\n");
830 debug_printf("---\n");
834 else if (!f.expand_string_forcedfail)
835 { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
838 /* Separate headers from body with a blank line */
840 return sendfn(tctx, US"\n", 1);
844 /*************************************************
845 * Write the message *
846 *************************************************/
848 /* This function writes the message to the given file descriptor. The headers
849 are in the in-store data structure, and the rest of the message is in the open
850 file descriptor deliver_datafile. Make sure we start it at the beginning.
852 . If add_return_path is TRUE, a "return-path:" header is added to the message,
853 containing the envelope sender's address.
855 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
856 giving the top-level envelope address that caused this delivery to happen.
858 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
859 message. It gives the time and date that delivery took place.
861 . If check_string is not null, the start of each line is checked for that
862 string. If it is found, it is replaced by escape_string. This used to be
863 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
865 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
867 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
868 any writing or reading error, leaving the code in errno intact. Error exits
869 can include timeouts for certain transports, which are requested by setting
870 transport_write_timeout non-zero.
874 (fd, msg) Either and fd, to write the message to,
875 or a string: if null write message to allocated space
876 otherwire take content as headers.
877 addr (chain of) addresses (for extra headers), or NULL;
878 only the first address is used
879 tblock optional transport instance block (NULL signifies NULL/0):
880 add_headers a string containing one or more headers to add; it is
881 expanded, and must be in correct RFC 822 format as
882 it is transmitted verbatim; NULL => no additions,
883 and so does empty string or forced expansion fail
884 remove_headers a colon-separated list of headers to remove, or NULL
885 rewrite_rules chain of header rewriting rules
886 rewrite_existflags flags for the rewriting rules
887 options bit-wise options:
888 add_return_path if TRUE, add a "return-path" header
889 add_envelope_to if TRUE, add a "envelope-to" header
890 add_delivery_date if TRUE, add a "delivery-date" header
891 use_crlf if TRUE, turn NL into CR LF
892 end_dot if TRUE, send a terminating "." line at the end
893 no_headers if TRUE, omit the headers
894 no_body if TRUE, omit the body
895 check_string a string to check for at the start of lines, or NULL
896 escape_string a string to insert in front of any check string
897 size_limit if > 0, this is a limit to the size of message written;
898 it is used when returning messages to their senders,
899 and is approximate rather than exact, owing to chunk
902 Returns: TRUE on success; FALSE (with errno) on failure.
903 In addition, the global variable transport_count
904 is incremented by the number of bytes written.
908 internal_transport_write_message(transport_ctx * tctx, int size_limit)
912 /* Initialize pointer in output buffer. */
914 transport_write_reset(tctx->options);
916 /* Set up the data for start-of-line data checking and escaping */
918 if (tctx->check_string && tctx->escape_string)
920 nl_check = tctx->check_string;
921 nl_check_length = Ustrlen(nl_check);
922 nl_escape = tctx->escape_string;
923 nl_escape_length = Ustrlen(nl_escape);
926 /* Whether the escaping mechanism is applied to headers or not is controlled by
927 an option (set for SMTP, not otherwise). Negate the length if not wanted till
928 after the headers. */
930 if (!(tctx->options & topt_escape_headers))
931 nl_check_length = -nl_check_length;
933 /* Write the headers if required, including any that have to be added. If there
934 are header rewriting rules, apply them. The datasource is not the -D spoolfile
935 so temporarily hide the global that adjusts for its format. */
937 if (!(tctx->options & topt_no_headers))
939 BOOL save_wireformat = f.spool_file_wireformat;
940 f.spool_file_wireformat = FALSE;
942 /* Add return-path: if requested. */
944 if (tctx->options & topt_add_return_path)
946 uschar buffer[ADDRESS_MAXLENGTH + 20];
947 int n = sprintf(CS buffer, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH,
949 if (!write_chunk(tctx, buffer, n)) goto bad;
952 /* Add envelope-to: if requested */
954 if (tctx->options & topt_add_envelope_to)
958 struct aci *plist = NULL;
959 struct aci *dlist = NULL;
960 void *reset_point = store_get(0);
962 if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
964 /* Pick up from all the addresses. The plist and dlist variables are
965 anchors for lists of addresses already handled; they have to be defined at
966 this level because write_env_to() calls itself recursively. */
968 for (p = tctx->addr; p; p = p->next)
969 if (!write_env_to(p, &plist, &dlist, &first, tctx)) goto bad;
971 /* Add a final newline and reset the store used for tracking duplicates */
973 if (!write_chunk(tctx, US"\n", 1)) goto bad;
974 store_reset(reset_point);
977 /* Add delivery-date: if requested. */
979 if (tctx->options & topt_add_delivery_date)
981 uschar * s = tod_stamp(tod_full);
983 if ( !write_chunk(tctx, US"Delivery-date: ", 15)
984 || !write_chunk(tctx, s, Ustrlen(s))
985 || !write_chunk(tctx, US"\n", 1)) goto bad;
988 /* Then the message's headers. Don't write any that are flagged as "old";
989 that means they were rewritten, or are a record of envelope rewriting, or
990 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
991 match any entries therein. Then check addr->prop.remove_headers too, provided that
994 if (!transport_headers_send(tctx, &write_chunk))
997 f.spool_file_wireformat = save_wireformat;
1001 f.spool_file_wireformat = save_wireformat;
1004 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
1005 last-BDAT, consisting of the current write_chunk() output buffer fill
1006 (optimally, all of the headers - but it does not matter if we already had to
1007 flush that buffer with non-last BDAT prependix) plus the amount of body data
1008 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
1009 that further use of write_chunk() will not prepend BDATs.
1010 The first BDAT written will also first flush any outstanding MAIL and RCPT
1011 commands which were buffered thans to PIPELINING.
1012 Commands go out (using a send()) from a different buffer to data (using a
1013 write()). They might not end up in the same TCP segment, which is
1016 if (tctx->options & topt_use_bdat)
1021 if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1023 if (!(tctx->options & topt_no_body))
1025 if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1026 fsize -= SPOOL_DATA_START_OFFSET;
1027 if (size_limit > 0 && fsize > size_limit)
1029 size = hsize + fsize;
1030 if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
1031 size += body_linecount; /* account for CRLF-expansion */
1033 /* With topt_use_bdat we never do dot-stuffing; no need to
1034 account for any expansion due to that. */
1037 /* If the message is large, emit first a non-LAST chunk with just the
1038 headers, and reap the command responses. This lets us error out early
1039 on RCPT rejects rather than sending megabytes of data. Include headers
1040 on the assumption they are cheap enough and some clever implementations
1041 might errorcheck them too, on-the-fly, and reject that chunk. */
1043 if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1046 debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1047 if ( tctx->chunk_cb(tctx, hsize, 0) != OK
1048 || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1049 || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1052 chunk_ptr = deliver_out_buffer;
1056 /* Emit a LAST datachunk command, and unmark the context for further
1059 if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1061 tctx->options &= ~topt_use_bdat;
1064 /* If the body is required, ensure that the data for check strings (formerly
1065 the "from hack") is enabled by negating the length if necessary. (It will be
1066 negative in cases where it isn't to apply to the headers). Then ensure the body
1067 is positioned at the start of its file (following the message id), then write
1068 it, applying the size limit if required. */
1070 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1071 and we want to send a body without dotstuffing or ending-dot, in-clear,
1072 then we can just dump it using sendfile.
1073 This should get used for CHUNKING output and also for writing the -K file for
1074 dkim signing, when we had CHUNKING input. */
1077 if ( f.spool_file_wireformat
1078 && !(tctx->options & (topt_no_body | topt_end_dot))
1080 && tls_out.active.sock != tctx->u.fd
1084 off_t offset = SPOOL_DATA_START_OFFSET;
1086 /* Write out any header data in the buffer */
1088 if ((len = chunk_ptr - deliver_out_buffer) > 0)
1090 if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1095 DEBUG(D_transport) debug_printf("using sendfile for body\n");
1099 if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1105 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1109 if (!(tctx->options & topt_no_body))
1110 debug_printf("cannot use sendfile for body: %s\n",
1111 !f.spool_file_wireformat ? "spoolfile not wireformat"
1112 : tctx->options & topt_end_dot ? "terminating dot wanted"
1113 : nl_check_length ? "dot- or From-stuffing wanted"
1114 : "TLS output wanted");
1116 if (!(tctx->options & topt_no_body))
1118 int size = size_limit;
1120 nl_check_length = abs(nl_check_length);
1121 nl_partial_match = 0;
1122 if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
1124 while ( (len = MAX(DELIVER_IN_BUFFER_SIZE, size)) > 0
1125 && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1127 if (!write_chunk(tctx, deliver_in_buffer, len))
1132 /* A read error on the body will have left len == -1 and errno set. */
1134 if (len != 0) return FALSE;
1137 /* Finished with the check string, and spool-format consideration */
1139 nl_check_length = nl_escape_length = 0;
1140 f.spool_file_wireformat = FALSE;
1142 /* If requested, add a terminating "." line (SMTP output). */
1144 if (tctx->options & topt_end_dot && !write_chunk(tctx, US".\n", 2))
1147 /* Write out any remaining data in the buffer before returning. */
1149 return (len = chunk_ptr - deliver_out_buffer) <= 0 ||
1150 transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1156 /*************************************************
1157 * External interface to write the message *
1158 *************************************************/
1160 /* If there is no filtering required, call the internal function above to do
1161 the real work, passing over all the arguments from this function. Otherwise,
1162 set up a filtering process, fork another process to call the internal function
1163 to write to the filter, and in this process just suck from the filter and write
1164 down the fd in the transport context. At the end, tidy up the pipes and the
1167 Arguments: as for internal_transport_write_message() above
1169 Returns: TRUE on success; FALSE (with errno) for any failure
1170 transport_count is incremented by the number of bytes written
1174 transport_write_message(transport_ctx * tctx, int size_limit)
1176 BOOL last_filter_was_NL = TRUE;
1177 BOOL save_spool_file_wireformat = f.spool_file_wireformat;
1178 int rc, len, yield, fd_read, fd_write, save_errno;
1179 int pfd[2] = {-1, -1};
1180 pid_t filter_pid, write_pid;
1182 f.transport_filter_timed_out = FALSE;
1184 /* If there is no filter command set up, call the internal function that does
1185 the actual work, passing it the incoming fd, and return its result. */
1187 if ( !transport_filter_argv
1188 || !*transport_filter_argv
1189 || !**transport_filter_argv
1191 return internal_transport_write_message(tctx, size_limit);
1193 /* Otherwise the message must be written to a filter process and read back
1194 before being written to the incoming fd. First set up the special processing to
1195 be done during the copying. */
1197 nl_partial_match = -1;
1199 if (tctx->check_string && tctx->escape_string)
1201 nl_check = tctx->check_string;
1202 nl_check_length = Ustrlen(nl_check);
1203 nl_escape = tctx->escape_string;
1204 nl_escape_length = Ustrlen(nl_escape);
1206 else nl_check_length = nl_escape_length = 0;
1208 /* Start up a subprocess to run the command. Ensure that our main fd will
1209 be closed when the subprocess execs, but remove the flag afterwards.
1210 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1211 process to deliver another message.) We get back stdin/stdout file descriptors.
1212 If the process creation failed, give an error return. */
1218 write_pid = (pid_t)(-1);
1221 int bits = fcntl(tctx->u.fd, F_GETFD);
1222 (void)fcntl(tctx->u.fd, F_SETFD, bits | FD_CLOEXEC);
1223 filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1224 &fd_write, &fd_read, FALSE);
1225 (void)fcntl(tctx->u.fd, F_SETFD, bits & ~FD_CLOEXEC);
1227 if (filter_pid < 0) goto TIDY_UP; /* errno set */
1230 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1231 (int)filter_pid, fd_write, fd_read);
1233 /* Fork subprocess to write the message to the filter, and return the result
1234 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1235 smtp dots, or check string processing. */
1237 if (pipe(pfd) != 0) goto TIDY_UP; /* errno set */
1238 if ((write_pid = fork()) == 0)
1241 (void)close(fd_read);
1242 (void)close(pfd[pipe_read]);
1243 nl_check_length = nl_escape_length = 0;
1245 tctx->u.fd = fd_write;
1246 tctx->check_string = tctx->escape_string = NULL;
1247 tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat);
1249 rc = internal_transport_write_message(tctx, size_limit);
1252 if ( write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1254 || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1256 || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1258 || write(pfd[pipe_write], (void *)&tctx->addr->delivery_usec, sizeof(int))
1261 rc = FALSE; /* compiler quietening */
1266 /* Parent process: close our copy of the writing subprocess' pipes. */
1268 (void)close(pfd[pipe_write]);
1269 (void)close(fd_write);
1272 /* Writing process creation failed */
1276 errno = save_errno; /* restore */
1280 /* When testing, let the subprocess get going */
1282 if (f.running_in_test_harness) millisleep(250);
1285 debug_printf("process %d writing to transport filter\n", (int)write_pid);
1287 /* Copy the message from the filter to the output fd. A read error leaves len
1288 == -1 and errno set. We need to apply a timeout to the read, to cope with
1289 the case when the filter gets stuck, but it can be quite a long one. The
1290 default is 5m, but this is now configurable. */
1292 DEBUG(D_transport) debug_printf("copying from the filter\n");
1294 /* Copy the output of the filter, remembering if the last character was NL. If
1295 no data is returned, that counts as "ended with NL" (default setting of the
1296 variable is TRUE). The output should always be unix-format as we converted
1297 any wireformat source on writing input to the filter. */
1299 f.spool_file_wireformat = FALSE;
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 f.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(tctx, deliver_in_buffer, len)) 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. */
1339 f.spool_file_wireformat = save_spool_file_wireformat;
1342 (void)close(fd_read);
1343 if (fd_write > 0) (void)close(fd_write);
1347 if (filter_pid > 0) kill(filter_pid, SIGKILL);
1348 if (write_pid > 0) kill(write_pid, SIGKILL);
1351 /* Wait for the filter process to complete. */
1353 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1354 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1357 save_errno = ERRNO_FILTER_FAIL;
1358 tctx->addr->more_errno = rc;
1359 DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1362 /* Wait for the writing process to complete. If it ends successfully,
1363 read the results from its pipe, provided we haven't already had a filter
1366 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1369 rc = child_close(write_pid, 30);
1374 if (read(pfd[pipe_read], (void *)&ok, sizeof(BOOL)) != sizeof(BOOL))
1377 debug_printf("pipe read from writing process: %s\n", strerror(errno));
1378 save_errno = ERRNO_FILTER_FAIL;
1383 int dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1384 dummy = read(pfd[pipe_read], (void *)&tctx->addr->more_errno, sizeof(int));
1385 dummy = read(pfd[pipe_read], (void *)&tctx->addr->delivery_usec, sizeof(int));
1386 dummy = dummy; /* compiler quietening */
1393 save_errno = ERRNO_FILTER_FAIL;
1394 tctx->addr->more_errno = rc;
1395 DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1398 (void)close(pfd[pipe_read]);
1400 /* If there have been no problems we can now add the terminating "." if this is
1401 SMTP output, turning off escaping beforehand. If the last character from the
1402 filter was not NL, insert a NL to make the SMTP protocol work. */
1406 nl_check_length = nl_escape_length = 0;
1407 f.spool_file_wireformat = FALSE;
1408 if ( tctx->options & topt_end_dot
1409 && ( last_filter_was_NL
1410 ? !write_chunk(tctx, US".\n", 2)
1411 : !write_chunk(tctx, US"\n.\n", 3)
1415 /* Write out any remaining data in the buffer. */
1418 yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1419 || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1422 errno = save_errno; /* From some earlier error */
1426 debug_printf("end of filtering transport writing: yield=%d\n", yield);
1428 debug_printf("errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1438 /*************************************************
1439 * Update waiting database *
1440 *************************************************/
1442 /* This is called when an address is deferred by remote transports that are
1443 capable of sending more than one message over one connection. A database is
1444 maintained for each transport, keeping track of which messages are waiting for
1445 which hosts. The transport can then consult this when eventually a successful
1446 delivery happens, and if it finds that another message is waiting for the same
1447 host, it can fire up a new process to deal with it using the same connection.
1449 The database records are keyed by host name. They can get full if there are
1450 lots of messages waiting, and so there is a continuation mechanism for them.
1452 Each record contains a list of message ids, packed end to end without any
1453 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1454 in this record, and the sequence field says if there are any other records for
1455 this host. If the sequence field is 0, there are none. If it is 1, then another
1456 record with the name <hostname>:0 exists; if it is 2, then two other records
1457 with sequence numbers 0 and 1 exist, and so on.
1459 Currently, an exhaustive search of all continuation records has to be done to
1460 determine whether to add a message id to a given record. This shouldn't be
1461 too bad except in extreme cases. I can't figure out a *simple* way of doing
1464 Old records should eventually get swept up by the exim_tidydb utility.
1467 hostlist list of hosts that this message could be sent to
1468 tpname name of the transport
1474 transport_update_waiting(host_item *hostlist, uschar *tpname)
1476 const uschar *prevname = US"";
1481 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1483 /* Open the database for this transport */
1485 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", tpname),
1486 O_RDWR, &dbblock, TRUE)))
1489 /* Scan the list of hosts for which this message is waiting, and ensure
1490 that the message id is in each host record. */
1492 for (host = hostlist; host; host = host->next)
1494 BOOL already = FALSE;
1495 dbdata_wait *host_record;
1500 /* Skip if this is the same host as we just processed; otherwise remember
1501 the name for next time. */
1503 if (Ustrcmp(prevname, host->name) == 0) continue;
1504 prevname = host->name;
1506 /* Look up the host record; if there isn't one, make an empty one. */
1508 if (!(host_record = dbfn_read(dbm_file, host->name)))
1510 host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH);
1511 host_record->count = host_record->sequence = 0;
1514 /* Compute the current length */
1516 host_length = host_record->count * MESSAGE_ID_LENGTH;
1518 /* Search the record to see if the current message is already in it. */
1520 for (s = host_record->text; s < host_record->text + host_length;
1521 s += MESSAGE_ID_LENGTH)
1522 if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1523 { already = TRUE; break; }
1525 /* If we haven't found this message in the main record, search any
1526 continuation records that exist. */
1528 for (i = host_record->sequence - 1; i >= 0 && !already; i--)
1531 sprintf(CS buffer, "%.200s:%d", host->name, i);
1532 if ((cont = dbfn_read(dbm_file, buffer)))
1534 int clen = cont->count * MESSAGE_ID_LENGTH;
1535 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; }
1541 /* If this message is already in a record, no need to update. */
1545 DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1550 /* If this record is full, write it out with a new name constructed
1551 from the sequence number, increase the sequence number, and empty
1554 if (host_record->count >= WAIT_NAME_MAX)
1556 sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1557 dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1558 host_record->sequence++;
1559 host_record->count = 0;
1563 /* If this record is not full, increase the size of the record to
1564 allow for one new message id. */
1569 store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH);
1570 memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1574 /* Now add the new name on the end */
1576 memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1577 host_record->count++;
1578 host_length += MESSAGE_ID_LENGTH;
1580 /* Update the database */
1582 dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1583 DEBUG(D_transport) debug_printf("added to list for %s\n", host->name);
1588 dbfn_close(dbm_file);
1594 /*************************************************
1595 * Test for waiting messages *
1596 *************************************************/
1598 /* This function is called by a remote transport which uses the previous
1599 function to remember which messages are waiting for which remote hosts. It's
1600 called after a successful delivery and its job is to check whether there is
1601 another message waiting for the same host. However, it doesn't do this if the
1602 current continue sequence is greater than the maximum supplied as an argument,
1603 or greater than the global connection_max_messages, which, if set, overrides.
1606 transport_name name of the transport
1607 hostname name of the host
1608 local_message_max maximum number of messages down one connection
1609 as set by the caller transport
1610 new_message_id set to the message id of a waiting message
1611 more set TRUE if there are yet more messages waiting
1612 oicf_func function to call to validate if it is ok to send
1613 to this message_id from the current instance.
1614 oicf_data opaque data for oicf_func
1616 Returns: TRUE if new_message_id set; FALSE otherwise
1619 typedef struct msgq_s
1621 uschar message_id [MESSAGE_ID_LENGTH + 1];
1626 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1627 int local_message_max, uschar *new_message_id, BOOL *more, oicf oicf_func, void *oicf_data)
1629 dbdata_wait *host_record;
1635 struct stat statbuf;
1641 debug_printf("transport_check_waiting entered\n");
1642 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1643 continue_sequence, local_message_max, connection_max_messages);
1646 /* Do nothing if we have hit the maximum number that can be send down one
1649 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1650 if (local_message_max > 0 && continue_sequence >= local_message_max)
1653 debug_printf("max messages for one connection reached: returning\n");
1657 /* Open the waiting information database. */
1659 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1660 O_RDWR, &dbblock, TRUE)))
1663 /* See if there is a record for this host; if not, there's nothing to do. */
1665 if (!(host_record = dbfn_read(dbm_file, hostname)))
1667 dbfn_close(dbm_file);
1668 DEBUG(D_transport) debug_printf("no messages waiting for %s\n", hostname);
1672 /* If the data in the record looks corrupt, just log something and
1673 don't try to use it. */
1675 if (host_record->count > WAIT_NAME_MAX)
1677 dbfn_close(dbm_file);
1678 log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1679 "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1683 /* Scan the message ids in the record from the end towards the beginning,
1684 until one is found for which a spool file actually exists. If the record gets
1685 emptied, delete it and continue with any continuation records that may exist.
1688 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1689 but the 1 off will remain without it. This code now allows me to SKIP over
1690 a message I do not want to send out on this run. */
1692 host_length = host_record->count * MESSAGE_ID_LENGTH;
1698 int msgq_actual = 0;
1699 BOOL bFound = FALSE;
1700 BOOL bContinuation = FALSE;
1702 /* create an array to read entire message queue into memory for processing */
1704 msgq = store_malloc(sizeof(msgq_t) * host_record->count);
1705 msgq_count = host_record->count;
1706 msgq_actual = msgq_count;
1708 for (i = 0; i < host_record->count; ++i)
1710 msgq[i].bKeep = TRUE;
1712 Ustrncpy(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1714 msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1717 /* first thing remove current message id if it exists */
1719 for (i = 0; i < msgq_count; ++i)
1720 if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1722 msgq[i].bKeep = FALSE;
1726 /* now find the next acceptable message_id */
1728 for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1732 subdir[0] = split_spool_directory ? msgq[i].message_id[5] : 0;
1735 if (Ustat(spool_fname(US"input", subdir, msgq[i].message_id, US"-D"),
1737 msgq[i].bKeep = FALSE;
1738 else if (!oicf_func || oicf_func(msgq[i].message_id, oicf_data))
1740 Ustrcpy(new_message_id, msgq[i].message_id);
1741 msgq[i].bKeep = FALSE;
1748 for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1752 /* reassemble the host record, based on removed message ids, from in
1755 if (msgq_actual <= 0)
1758 host_record->count = 0;
1762 host_length = msgq_actual * MESSAGE_ID_LENGTH;
1763 host_record->count = msgq_actual;
1765 if (msgq_actual < msgq_count)
1768 for (new_count = 0, i = 0; i < msgq_count; ++i)
1770 Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1771 msgq[i].message_id, MESSAGE_ID_LENGTH);
1773 host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1777 /* Check for a continuation record. */
1779 while (host_length <= 0)
1782 dbdata_wait * newr = NULL;
1785 /* Search for a continuation */
1787 for (i = host_record->sequence - 1; i >= 0 && !newr; i--)
1789 sprintf(CS buffer, "%.200s:%d", hostname, i);
1790 newr = dbfn_read(dbm_file, buffer);
1793 /* If no continuation, delete the current and break the loop */
1797 dbfn_delete(dbm_file, hostname);
1801 /* Else replace the current with the continuation */
1803 dbfn_delete(dbm_file, buffer);
1805 host_length = host_record->count * MESSAGE_ID_LENGTH;
1807 bContinuation = TRUE;
1810 if (bFound) /* Usual exit from main loop */
1816 /* If host_length <= 0 we have emptied a record and not found a good message,
1817 and there are no continuation records. Otherwise there is a continuation
1818 record to process. */
1820 if (host_length <= 0)
1822 dbfn_close(dbm_file);
1823 DEBUG(D_transport) debug_printf("waiting messages already delivered\n");
1827 /* we were not able to find an acceptable message, nor was there a
1828 * continuation record. So bug out, outer logic will clean this up.
1833 Ustrcpy(new_message_id, message_id);
1834 dbfn_close(dbm_file);
1839 } /* we need to process a continuation record */
1841 /* Control gets here when an existing message has been encountered; its
1842 id is in new_message_id, and host_length is the revised length of the
1843 host record. If it is zero, the record has been removed. Update the
1844 record if required, close the database, and return TRUE. */
1846 if (host_length > 0)
1848 host_record->count = host_length/MESSAGE_ID_LENGTH;
1850 dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1854 dbfn_close(dbm_file);
1858 /*************************************************
1859 * Deliver waiting message down same socket *
1860 *************************************************/
1862 /* Just the regain-root-privilege exec portion */
1864 transport_do_pass_socket(const uschar *transport_name, const uschar *hostname,
1865 const uschar *hostaddress, uschar *id, int socket_fd)
1868 const uschar **argv;
1870 /* Set up the calling arguments; use the standard function for the basics,
1871 but we have a number of extras that may be added. */
1873 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1875 if (f.smtp_authenticated) argv[i++] = US"-MCA";
1876 if (smtp_peer_options & OPTION_CHUNKING) argv[i++] = US"-MCK";
1877 if (smtp_peer_options & OPTION_DSN) argv[i++] = US"-MCD";
1878 if (smtp_peer_options & OPTION_PIPE) argv[i++] = US"-MCP";
1879 if (smtp_peer_options & OPTION_SIZE) argv[i++] = US"-MCS";
1881 if (smtp_peer_options & OPTION_TLS)
1882 if (tls_out.active.sock >= 0 || continue_proxy_cipher)
1884 argv[i++] = US"-MCt";
1885 argv[i++] = sending_ip_address;
1886 argv[i++] = string_sprintf("%d", sending_port);
1887 argv[i++] = tls_out.active.sock >= 0 ? tls_out.cipher : continue_proxy_cipher;
1890 argv[i++] = US"-MCT";
1893 if (queue_run_pid != (pid_t)0)
1895 argv[i++] = US"-MCQ";
1896 argv[i++] = string_sprintf("%d", queue_run_pid);
1897 argv[i++] = string_sprintf("%d", queue_run_pipe);
1900 argv[i++] = US"-MC";
1901 argv[i++] = US transport_name;
1902 argv[i++] = US hostname;
1903 argv[i++] = US hostaddress;
1904 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1908 /* Arrange for the channel to be on stdin. */
1912 (void)dup2(socket_fd, 0);
1913 (void)close(socket_fd);
1916 DEBUG(D_exec) debug_print_argv(argv);
1917 exim_nullstd(); /* Ensure std{out,err} exist */
1918 execv(CS argv[0], (char *const *)argv);
1920 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1921 _exit(errno); /* Note: must be _exit(), NOT exit() */
1926 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1927 get a clean delivery process, and to regain root privilege in cases where it
1928 has been given away.
1931 transport_name to pass to the new process
1934 id the new message to process
1935 socket_fd the connected socket
1937 Returns: FALSE if fork fails; TRUE otherwise
1941 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
1942 const uschar *hostaddress, uschar *id, int socket_fd)
1947 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
1949 if ((pid = fork()) == 0)
1951 /* Disconnect entirely from the parent process. If we are running in the
1952 test harness, wait for a bit to allow the previous process time to finish,
1953 write the log, etc., so that the output is always in the same order for
1954 automatic comparison. */
1956 if ((pid = fork()) != 0)
1958 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (final-pid %d)\n", pid);
1959 _exit(EXIT_SUCCESS);
1961 if (f.running_in_test_harness) sleep(1);
1963 transport_do_pass_socket(transport_name, hostname, hostaddress,
1967 /* If the process creation succeeded, wait for the first-level child, which
1968 immediately exits, leaving the second level process entirely disconnected from
1974 while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
1975 DEBUG(D_transport) debug_printf("transport_pass_socket succeeded (inter-pid %d)\n", pid);
1980 DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
1988 /*************************************************
1989 * Set up direct (non-shell) command *
1990 *************************************************/
1992 /* This function is called when a command line is to be parsed and executed
1993 directly, without the use of /bin/sh. It is called by the pipe transport,
1994 the queryprogram router, and also from the main delivery code when setting up a
1995 transport filter process. The code for ETRN also makes use of this; in that
1996 case, no addresses are passed.
1999 argvptr pointer to anchor for argv vector
2000 cmd points to the command string (modified IN PLACE)
2001 expand_arguments true if expansion is to occur
2002 expand_failed error value to set if expansion fails; not relevant if
2004 addr chain of addresses, or NULL
2005 etext text for use in error messages
2006 errptr where to put error message if addr is NULL;
2007 otherwise it is put in the first address
2009 Returns: TRUE if all went well; otherwise an error will be
2010 set in the first address and FALSE returned
2014 transport_set_up_command(const uschar ***argvptr, uschar *cmd,
2015 BOOL expand_arguments, int expand_failed, address_item *addr,
2016 uschar *etext, uschar **errptr)
2019 const uschar **argv;
2021 int address_count = 0;
2025 /* Get store in which to build an argument list. Count the number of addresses
2026 supplied, and allow for that many arguments, plus an additional 60, which
2027 should be enough for anybody. Multiple addresses happen only when the local
2028 delivery batch option is set. */
2030 for (ad = addr; ad != NULL; ad = ad->next) address_count++;
2031 max_args = address_count + 60;
2032 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *));
2034 /* Split the command up into arguments terminated by white space. Lose
2035 trailing space at the start and end. Double-quoted arguments can contain \\ and
2036 \" escapes and so can be handled by the standard function; single-quoted
2037 arguments are verbatim. Copy each argument into a new string. */
2040 while (isspace(*s)) s++;
2042 while (*s != 0 && argcount < max_args)
2047 while (*ss != 0 && *ss != '\'') ss++;
2048 argv[argcount++] = ss = store_get(ss - s++);
2049 while (*s != 0 && *s != '\'') *ss++ = *s++;
2053 else argv[argcount++] = string_copy(string_dequote(CUSS &s));
2054 while (isspace(*s)) s++;
2057 argv[argcount] = US 0;
2059 /* If *s != 0 we have run out of argument slots. */
2063 uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2067 addr->transport_return = FAIL;
2068 addr->message = msg;
2074 /* Expand each individual argument if required. Expansion happens for pipes set
2075 up in filter files and with directly-supplied commands. It does not happen if
2076 the pipe comes from a traditional .forward file. A failing expansion is a big
2077 disaster if the command came from Exim's configuration; if it came from a user
2078 it is just a normal failure. The expand_failed value is used as the error value
2079 to cater for these two cases.
2081 An argument consisting just of the text "$pipe_addresses" is treated specially.
2082 It is not passed to the general expansion function. Instead, it is replaced by
2083 a number of arguments, one for each address. This avoids problems with shell
2084 metacharacters and spaces in addresses.
2086 If the parent of the top address has an original part of "system-filter", this
2087 pipe was set up by the system filter, and we can permit the expansion of
2092 debug_printf("direct command:\n");
2093 for (i = 0; argv[i] != US 0; i++)
2094 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2097 if (expand_arguments)
2099 BOOL allow_dollar_recipients = addr != NULL &&
2100 addr->parent != NULL &&
2101 Ustrcmp(addr->parent->address, "system-filter") == 0;
2103 for (i = 0; argv[i] != US 0; i++)
2106 /* Handle special fudge for passing an address list */
2109 (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2110 Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2114 if (argcount + address_count - 1 > max_args)
2116 addr->transport_return = FAIL;
2117 addr->message = string_sprintf("Too many arguments to command \"%s\" "
2118 "in %s", cmd, etext);
2122 additional = address_count - 1;
2124 memmove(argv + i + 1 + additional, argv + i + 1,
2125 (argcount - i)*sizeof(uschar *));
2127 for (ad = addr; ad != NULL; ad = ad->next) {
2128 argv[i++] = ad->address;
2132 /* Subtract one since we replace $pipe_addresses */
2137 /* Handle special case of $address_pipe when af_force_command is set */
2139 else if (addr != NULL && testflag(addr,af_force_command) &&
2140 (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2141 Ustrcmp(argv[i], "${address_pipe}") == 0))
2144 int address_pipe_argcount = 0;
2145 int address_pipe_max_args;
2146 uschar **address_pipe_argv;
2148 /* We can never have more then the argv we will be loading into */
2149 address_pipe_max_args = max_args - argcount + 1;
2152 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2154 /* We allocate an additional for (uschar *)0 */
2155 address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *));
2157 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2158 s = expand_string(addr->local_part + 1);
2160 if (s == NULL || *s == '\0')
2162 addr->transport_return = FAIL;
2163 addr->message = string_sprintf("Expansion of \"%s\" "
2164 "from command \"%s\" in %s failed: %s",
2165 (addr->local_part + 1), cmd, etext, expand_string_message);
2169 while (isspace(*s)) s++; /* strip leading space */
2171 while (*s != 0 && address_pipe_argcount < address_pipe_max_args)
2176 while (*ss != 0 && *ss != '\'') ss++;
2177 address_pipe_argv[address_pipe_argcount++] = ss = store_get(ss - s++);
2178 while (*s != 0 && *s != '\'') *ss++ = *s++;
2182 else address_pipe_argv[address_pipe_argcount++] =
2183 string_copy(string_dequote(CUSS &s));
2184 while (isspace(*s)) s++; /* strip space after arg */
2187 address_pipe_argv[address_pipe_argcount] = US 0;
2189 /* If *s != 0 we have run out of argument slots. */
2192 uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2193 "\"%s\" in %s", addr->local_part + 1, etext);
2196 addr->transport_return = FAIL;
2197 addr->message = msg;
2203 /* address_pipe_argcount - 1
2204 * because we are replacing $address_pipe in the argument list
2205 * with the first thing it expands to */
2206 if (argcount + address_pipe_argcount - 1 > max_args)
2208 addr->transport_return = FAIL;
2209 addr->message = string_sprintf("Too many arguments to command "
2210 "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2214 /* If we are not just able to replace the slot that contained
2215 * $address_pipe (address_pipe_argcount == 1)
2216 * We have to move the existing argv by address_pipe_argcount - 1
2217 * Visually if address_pipe_argcount == 2:
2218 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2219 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2221 if (address_pipe_argcount > 1)
2223 /* current position + additional args */
2224 argv + i + address_pipe_argcount,
2225 /* current position + 1 (for the (uschar *)0 at the end) */
2227 /* -1 for the (uschar *)0 at the end)*/
2228 (argcount - i)*sizeof(uschar *)
2231 /* Now we fill in the slots we just moved argv out of
2232 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2234 for (address_pipe_i = 0;
2235 address_pipe_argv[address_pipe_i] != US 0;
2238 argv[i++] = address_pipe_argv[address_pipe_i];
2242 /* Subtract one since we replace $address_pipe */
2247 /* Handle normal expansion string */
2251 const uschar *expanded_arg;
2252 f.enable_dollar_recipients = allow_dollar_recipients;
2253 expanded_arg = expand_cstring(argv[i]);
2254 f.enable_dollar_recipients = FALSE;
2256 if (expanded_arg == NULL)
2258 uschar *msg = string_sprintf("Expansion of \"%s\" "
2259 "from command \"%s\" in %s failed: %s",
2260 argv[i], cmd, etext, expand_string_message);
2263 addr->transport_return = expand_failed;
2264 addr->message = msg;
2269 argv[i] = expanded_arg;
2275 debug_printf("direct command after expansion:\n");
2276 for (i = 0; argv[i] != US 0; i++)
2277 debug_printf(" argv[%d] = %s\n", i, string_printing(argv[i]));
2284 #endif /*!MACRO_PREDEF*/
2287 /* End of transport.c */