d04ea516a5c4e3bc59366ed619393cf2160c0385
[exim.git] / src / src / transport.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) The Exim Maintainers 2020 - 2022 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
9
10 /* General functions concerned with transportation, and generic options for all
11 transports. */
12
13
14 #include "exim.h"
15
16 /* Generic options for transports, all of which live inside transport_instance
17 data blocks and which therefore have the opt_public flag set. Note that there
18 are other options living inside this structure which can be set only from
19 certain transports. */
20 #define LOFF(field) OPT_OFF(transport_instance, field)
21
22 optionlist optionlist_transports[] = {
23   /*    name            type                                    value */
24   { "*expand_group",    opt_stringptr|opt_hidden|opt_public,
25                  LOFF(expand_gid) },
26   { "*expand_user",     opt_stringptr|opt_hidden|opt_public,
27                  LOFF(expand_uid) },
28   { "*headers_rewrite_flags", opt_int|opt_public|opt_hidden,
29                  LOFF(rewrite_existflags) },
30   { "*headers_rewrite_rules", opt_void|opt_public|opt_hidden,
31                  LOFF(rewrite_rules) },
32   { "*set_group",       opt_bool|opt_hidden|opt_public,
33                  LOFF(gid_set) },
34   { "*set_user",        opt_bool|opt_hidden|opt_public,
35                  LOFF(uid_set) },
36   { "body_only",        opt_bool|opt_public,
37                  LOFF(body_only) },
38   { "current_directory", opt_stringptr|opt_public,
39                  LOFF(current_dir) },
40   { "debug_print",      opt_stringptr | opt_public,
41                  LOFF(debug_string) },
42   { "delivery_date_add", opt_bool|opt_public,
43                  LOFF(delivery_date_add) },
44   { "disable_logging",  opt_bool|opt_public,
45                  LOFF(disable_logging) },
46   { "driver",           opt_stringptr|opt_public,
47                  LOFF(driver_name) },
48   { "envelope_to_add",   opt_bool|opt_public,
49                  LOFF(envelope_to_add) },
50 #ifndef DISABLE_EVENT
51   { "event_action",     opt_stringptr | opt_public,
52                  LOFF(event_action) },
53 #endif
54   { "group",             opt_expand_gid|opt_public,
55                  LOFF(gid) },
56   { "headers_add",      opt_stringptr|opt_public|opt_rep_str,
57                  LOFF(add_headers) },
58   { "headers_only",     opt_bool|opt_public,
59                  LOFF(headers_only) },
60   { "headers_remove",   opt_stringptr|opt_public|opt_rep_str,
61                  LOFF(remove_headers) },
62   { "headers_rewrite",  opt_rewrite|opt_public,
63                  LOFF(headers_rewrite) },
64   { "home_directory",   opt_stringptr|opt_public,
65                  LOFF(home_dir) },
66   { "initgroups",       opt_bool|opt_public,
67                  LOFF(initgroups) },
68   { "max_parallel",     opt_stringptr|opt_public,
69                  LOFF(max_parallel) },
70   { "message_size_limit", opt_stringptr|opt_public,
71                  LOFF(message_size_limit) },
72   { "rcpt_include_affixes", opt_bool|opt_public,
73                  LOFF(rcpt_include_affixes) },
74   { "retry_use_local_part", opt_bool|opt_public,
75                  LOFF(retry_use_local_part) },
76   { "return_path",      opt_stringptr|opt_public,
77                  LOFF(return_path) },
78   { "return_path_add",   opt_bool|opt_public,
79                  LOFF(return_path_add) },
80   { "shadow_condition", opt_stringptr|opt_public,
81                  LOFF(shadow_condition) },
82   { "shadow_transport", opt_stringptr|opt_public,
83                  LOFF(shadow) },
84   { "transport_filter", opt_stringptr|opt_public,
85                  LOFF(filter_command) },
86   { "transport_filter_timeout", opt_time|opt_public,
87                  LOFF(filter_timeout) },
88   { "user",             opt_expand_uid|opt_public,
89                  LOFF(uid) }
90 };
91
92 int optionlist_transports_size = nelem(optionlist_transports);
93
94 #ifdef MACRO_PREDEF
95
96 # include "macro_predef.h"
97
98 void
99 options_transports(void)
100 {
101 uschar buf[64];
102
103 options_from_list(optionlist_transports, nelem(optionlist_transports), US"TRANSPORTS", NULL);
104
105 for (transport_info * ti = transports_available; ti->driver_name[0]; ti++)
106   {
107   spf(buf, sizeof(buf), US"_DRIVER_TRANSPORT_%T", ti->driver_name);
108   builtin_macro_create(buf);
109   options_from_list(ti->options, (unsigned)*ti->options_count, US"TRANSPORT", ti->driver_name);
110   }
111 }
112
113 #else   /*!MACRO_PREDEF*/
114
115 /* Structure for keeping list of addresses that have been added to
116 Envelope-To:, in order to avoid duplication. */
117
118 struct aci {
119   struct aci *next;
120   address_item *ptr;
121   };
122
123
124 /* Static data for write_chunk() */
125
126 static uschar *chunk_ptr;           /* chunk pointer */
127 static uschar *nl_check;            /* string to look for at line start */
128 static int     nl_check_length;     /* length of same */
129 static uschar *nl_escape;           /* string to insert */
130 static int     nl_escape_length;    /* length of same */
131 static int     nl_partial_match;    /* length matched at chunk end */
132
133
134 /*************************************************
135 *             Initialize transport list           *
136 *************************************************/
137
138 /* Read the transports section of the configuration file, and set up a chain of
139 transport instances according to its contents. Each transport has generic
140 options and may also have its own private options. This function is only ever
141 called when transports == NULL. We use generic code in readconf to do most of
142 the work. */
143
144 void
145 transport_init(void)
146 {
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);
155
156 /* Now scan the configured transports and check inconsistencies. A shadow
157 transport is permitted only for local transports. */
158
159 for (transport_instance * t = transports; t; t = t->next)
160   {
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);
164
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",
168       t->name);
169   }
170 }
171
172
173
174 /*************************************************
175 *             Write block of data                *
176 *************************************************/
177
178 static int
179 tpt_write(int fd, uschar * block, int len, BOOL more, int options)
180 {
181 return
182 #ifndef DISABLE_TLS
183   tls_out.active.sock == fd
184     ? tls_write(tls_out.active.tls_ctx, block, len, more) :
185 #endif
186 #ifdef MSG_MORE
187   more && !(options & topt_not_socket) ? send(fd, block, len, MSG_MORE) :
188 #endif
189   write(fd, block, len);
190 }
191
192 /* Subroutine called by write_chunk() and at the end of the message actually
193 to write a data block. Also called directly by some transports to write
194 additional data to the file descriptor (e.g. prefix, suffix).
195
196 If a transport wants data transfers to be timed, it sets a non-zero value in
197 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
198 be set for each block of data written from here. If time runs out, then write()
199 fails and provokes an error return. The caller can then inspect sigalrm_seen to
200 check for a timeout.
201
202 On some systems, if a quota is exceeded during the write, the yield is the
203 number of bytes written rather than an immediate error code. This also happens
204 on some systems in other cases, for example a pipe that goes away because the
205 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
206 get the error codes the first time.
207
208 The write() function is also interruptible; the Solaris 2.6 man page says:
209
210      If write() is interrupted by a signal before it writes any
211      data, it will return -1 with errno set to EINTR.
212
213      If write() is interrupted by a signal after it successfully
214      writes some data, it will return the number of bytes written.
215
216 To handle these cases, we want to restart the write() to output the remainder
217 of the data after a non-negative return from write(), except after a timeout.
218 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
219 proper error then occurs. In principle, after an interruption, the second
220 write() could suffer the same fate, but we do not want to continue for
221 evermore, so stick a maximum repetition count on the loop to act as a
222 longstop.
223
224 Arguments:
225   tctx      transport context: file descriptor or string to write to
226   block     block of bytes to write
227   len       number of bytes to write
228   more      further data expected soon
229
230 Returns:    TRUE on success, FALSE on failure (with errno preserved);
231               transport_count is incremented by the number of bytes written
232 */
233
234 static BOOL
235 transport_write_block_fd(transport_ctx * tctx, uschar * block, int len, BOOL more)
236 {
237 int rc, save_errno;
238 int local_timeout = transport_write_timeout;
239 int connretry = 1;
240 int fd = tctx->u.fd;
241
242 /* This loop is for handling incomplete writes and other retries. In most
243 normal cases, it is only ever executed once. */
244
245 for (int i = 0; i < 100; i++)
246   {
247   DEBUG(D_transport)
248     debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
249       fd, len, local_timeout, more ? " (more expected)" : "");
250
251   /* When doing TCP Fast Open we may get this far before the 3-way handshake
252   is complete, and write returns ENOTCONN.  Detect that, wait for the socket
253   to become writable, and retry once only. */
254
255   for(;;)
256     {
257     /* This code makes use of alarm() in order to implement the timeout. This
258     isn't a very tidy way of doing things. Using non-blocking I/O with select()
259     provides a neater approach. However, I don't know how to do this when TLS is
260     in use. */
261
262     if (transport_write_timeout <= 0)   /* No timeout wanted */
263       {
264       rc = tpt_write(fd, block, len, more, tctx->options);
265       save_errno = errno;
266       }
267     else                                /* Timeout wanted. */
268       {
269       sigalrm_seen = FALSE;
270       ALARM(local_timeout);
271         rc = tpt_write(fd, block, len, more, tctx->options);
272         save_errno = errno;
273       local_timeout = ALARM_CLR(0);
274       if (sigalrm_seen)
275         {
276         errno = ETIMEDOUT;
277         return FALSE;
278         }
279       }
280
281     if (rc >= 0 || errno != ENOTCONN || connretry <= 0)
282       break;
283
284     poll_one_fd(fd, POLLOUT, -1);               /* could set timeout? retval check? */
285     connretry--;
286     }
287
288   /* Hopefully, the most common case is success, so test that first. */
289
290   if (rc == len) { transport_count += len; return TRUE; }
291
292   /* A non-negative return code is an incomplete write. Try again for the rest
293   of the block. If we have exactly hit the timeout, give up. */
294
295   if (rc >= 0)
296     {
297     len -= rc;
298     block += rc;
299     transport_count += rc;
300     DEBUG(D_transport) debug_printf("write incomplete (%d)\n", rc);
301     goto CHECK_TIMEOUT;   /* A few lines below */
302     }
303
304   /* A negative return code with an EINTR error is another form of
305   incomplete write, zero bytes having been written */
306
307   if (save_errno == EINTR)
308     {
309     DEBUG(D_transport)
310       debug_printf("write interrupted before anything written\n");
311     goto CHECK_TIMEOUT;   /* A few lines below */
312     }
313
314   /* A response of EAGAIN from write() is likely only in the case of writing
315   to a FIFO that is not swallowing the data as fast as Exim is writing it. */
316
317   if (save_errno == EAGAIN)
318     {
319     DEBUG(D_transport)
320       debug_printf("write temporarily locked out, waiting 1 sec\n");
321     sleep(1);
322
323     /* Before continuing to try another write, check that we haven't run out of
324     time. */
325
326     CHECK_TIMEOUT:
327     if (transport_write_timeout > 0 && local_timeout <= 0)
328       {
329       errno = ETIMEDOUT;
330       return FALSE;
331       }
332     continue;
333     }
334
335   /* Otherwise there's been an error */
336
337   DEBUG(D_transport) debug_printf("writing error %d: %s\n", save_errno,
338     strerror(save_errno));
339   errno = save_errno;
340   return FALSE;
341   }
342
343 /* We've tried and tried and tried but still failed */
344
345 errno = ERRNO_WRITEINCOMPLETE;
346 return FALSE;
347 }
348
349
350 BOOL
351 transport_write_block(transport_ctx * tctx, uschar *block, int len, BOOL more)
352 {
353 if (!(tctx->options & topt_output_string))
354   return transport_write_block_fd(tctx, block, len, more);
355
356 /* Write to expanding-string.  NOTE: not NUL-terminated */
357
358 if (!tctx->u.msg)
359   tctx->u.msg = string_get(1024);
360
361 tctx->u.msg = string_catn(tctx->u.msg, block, len);
362 return TRUE;
363 }
364
365
366
367
368 /*************************************************
369 *             Write formatted string             *
370 *************************************************/
371
372 /* This is called by various transports. It is a convenience function.
373
374 Arguments:
375   fd          file descriptor
376   format      string format
377   ...         arguments for format
378
379 Returns:      the yield of transport_write_block()
380 */
381
382 BOOL
383 transport_write_string(int fd, const char *format, ...)
384 {
385 transport_ctx tctx = {{0}};
386 gstring gs = { .size = big_buffer_size, .ptr = 0, .s = big_buffer };
387 va_list ap;
388
389 /* Use taint-unchecked routines for writing into big_buffer, trusting
390 that the result will never be expanded. */
391
392 va_start(ap, format);
393 if (!string_vformat(&gs, SVFMT_TAINT_NOCHK, format, ap))
394   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "overlong formatted string in transport");
395 va_end(ap);
396 tctx.u.fd = fd;
397 return transport_write_block(&tctx, gs.s, gs.ptr, FALSE);
398 }
399
400
401
402
403 void
404 transport_write_reset(int options)
405 {
406 if (!(options & topt_continuation)) chunk_ptr = deliver_out_buffer;
407 nl_partial_match = -1;
408 nl_check_length = nl_escape_length = 0;
409 }
410
411
412
413 /*************************************************
414 *              Write character chunk             *
415 *************************************************/
416
417 /* Subroutine used by transport_write_message() to scan character chunks for
418 newlines and act appropriately. The object is to minimise the number of writes.
419 The output byte stream is buffered up in deliver_out_buffer, which is written
420 only when it gets full, thus minimizing write operations and TCP packets.
421
422 Static data is used to handle the case when the last character of the previous
423 chunk was NL, or matched part of the data that has to be escaped.
424
425 Arguments:
426   tctx       transport context - processing to be done during output,
427                 and file descriptor to write to
428   chunk      pointer to data to write
429   len        length of data to write
430
431 In addition, the static nl_xxx variables must be set as required.
432
433 Returns:     TRUE on success, FALSE on failure (with errno preserved)
434 */
435
436 BOOL
437 write_chunk(transport_ctx * tctx, uschar *chunk, int len)
438 {
439 uschar *start = chunk;
440 uschar *end = chunk + len;
441 int mlen = DELIVER_OUT_BUFFER_SIZE - nl_escape_length - 2;
442
443 /* The assumption is made that the check string will never stretch over move
444 than one chunk since the only time there are partial matches is when copying
445 the body in large buffers. There is always enough room in the buffer for an
446 escape string, since the loop below ensures this for each character it
447 processes, and it won't have stuck in the escape string if it left a partial
448 match. */
449
450 if (nl_partial_match >= 0)
451   {
452   if (nl_check_length > 0 && len >= nl_check_length &&
453       Ustrncmp(start, nl_check + nl_partial_match,
454         nl_check_length - nl_partial_match) == 0)
455     {
456     Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
457     chunk_ptr += nl_escape_length;
458     start += nl_check_length - nl_partial_match;
459     }
460
461   /* The partial match was a false one. Insert the characters carried over
462   from the previous chunk. */
463
464   else if (nl_partial_match > 0)
465     {
466     Ustrncpy(chunk_ptr, nl_check, nl_partial_match);
467     chunk_ptr += nl_partial_match;
468     }
469
470   nl_partial_match = -1;
471   }
472
473 /* Now process the characters in the chunk. Whenever we hit a newline we check
474 for possible escaping. The code for the non-NL route should be as fast as
475 possible. */
476
477 for (uschar * ptr = start; ptr < end; ptr++)
478   {
479   int ch, len;
480
481   /* Flush the buffer if it has reached the threshold - we want to leave enough
482   room for the next uschar, plus a possible extra CR for an LF, plus the escape
483   string. */
484
485   if ((len = chunk_ptr - deliver_out_buffer) > mlen)
486     {
487     DEBUG(D_transport) debug_printf("flushing headers buffer\n");
488
489     /* If CHUNKING, prefix with BDAT (size) NON-LAST.  Also, reap responses
490     from previous SMTP commands. */
491
492     if (tctx->options & topt_use_bdat  &&  tctx->chunk_cb)
493       {
494       if (  tctx->chunk_cb(tctx, (unsigned)len, 0) != OK
495          || !transport_write_block(tctx, deliver_out_buffer, len, FALSE)
496          || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
497          )
498         return FALSE;
499       }
500     else
501       if (!transport_write_block(tctx, deliver_out_buffer, len, FALSE))
502         return FALSE;
503     chunk_ptr = deliver_out_buffer;
504     }
505
506   /* Remove CR before NL if required */
507
508   if (  *ptr == '\r' && ptr[1] == '\n'
509      && !(tctx->options & topt_use_crlf)
510      && f.spool_file_wireformat
511      )
512     ptr++;
513
514   if ((ch = *ptr) == '\n')
515     {
516     int left = end - ptr - 1;  /* count of chars left after NL */
517
518     /* Insert CR before NL if required */
519
520     if (tctx->options & topt_use_crlf && !f.spool_file_wireformat)
521       *chunk_ptr++ = '\r';
522     *chunk_ptr++ = '\n';
523     transport_newlines++;
524
525     /* The check_string test (formerly "from hack") replaces the specific
526     string at the start of a line with an escape string (e.g. "From " becomes
527     ">From " or "." becomes "..". It is a case-sensitive test. The length
528     check above ensures there is always enough room to insert this string. */
529
530     if (nl_check_length > 0)
531       {
532       if (left >= nl_check_length &&
533           Ustrncmp(ptr+1, nl_check, nl_check_length) == 0)
534         {
535         Ustrncpy(chunk_ptr, nl_escape, nl_escape_length);
536         chunk_ptr += nl_escape_length;
537         ptr += nl_check_length;
538         }
539
540       /* Handle the case when there isn't enough left to match the whole
541       check string, but there may be a partial match. We remember how many
542       characters matched, and finish processing this chunk. */
543
544       else if (left <= 0) nl_partial_match = 0;
545
546       else if (Ustrncmp(ptr+1, nl_check, left) == 0)
547         {
548         nl_partial_match = left;
549         ptr = end;
550         }
551       }
552     }
553
554   /* Not a NL character */
555
556   else *chunk_ptr++ = ch;
557   }
558
559 return TRUE;
560 }
561
562
563
564
565 /*************************************************
566 *        Generate address for RCPT TO            *
567 *************************************************/
568
569 /* This function puts together an address for RCPT to, using the caseful
570 version of the local part and the caseful version of the domain. If there is no
571 prefix or suffix, or if affixes are to be retained, we can just use the
572 original address. Otherwise, if there is a prefix but no suffix we can use a
573 pointer into the original address. If there is a suffix, however, we have to
574 build a new string.
575
576 Arguments:
577   addr              the address item
578   include_affixes   TRUE if affixes are to be included
579
580 Returns:            a string
581 */
582
583 uschar *
584 transport_rcpt_address(address_item *addr, BOOL include_affixes)
585 {
586 uschar *at;
587 int plen, slen;
588
589 if (include_affixes)
590   {
591   setflag(addr, af_include_affixes);  /* Affects logged => line */
592   return addr->address;
593   }
594
595 if (!addr->suffix)
596   {
597   if (!addr->prefix) return addr->address;
598   return addr->address + Ustrlen(addr->prefix);
599   }
600
601 at = Ustrrchr(addr->address, '@');
602 plen = addr->prefix ? Ustrlen(addr->prefix) : 0;
603 slen = Ustrlen(addr->suffix);
604
605 return string_sprintf("%.*s@%s", (int)(at - addr->address - plen - slen),
606    addr->address + plen, at + 1);
607 }
608
609
610 /*************************************************
611 *  Output Envelope-To: address & scan duplicates *
612 *************************************************/
613
614 /* This function is called from internal_transport_write_message() below, when
615 generating an Envelope-To: header line. It checks for duplicates of the given
616 address and its ancestors. When one is found, this function calls itself
617 recursively, to output the envelope address of the duplicate.
618
619 We want to avoid duplication in the list, which can arise for example when
620 A->B,C and then both B and C alias to D. This can also happen when there are
621 unseen drivers in use. So a list of addresses that have been output is kept in
622 the plist variable.
623
624 It is also possible to have loops in the address ancestry/duplication graph,
625 for example if there are two top level addresses A and B and we have A->B,C and
626 B->A. To break the loop, we use a list of processed addresses in the dlist
627 variable.
628
629 After handling duplication, this function outputs the progenitor of the given
630 address.
631
632 Arguments:
633   p         the address we are interested in
634   pplist    address of anchor of the list of addresses not to output
635   pdlist    address of anchor of the list of processed addresses
636   first     TRUE if this is the first address; set it FALSE afterwards
637   tctx      transport context - processing to be done during output
638               and the file descriptor to write to
639
640 Returns:    FALSE if writing failed
641 */
642
643 static BOOL
644 write_env_to(address_item *p, struct aci **pplist, struct aci **pdlist,
645   BOOL *first, transport_ctx * tctx)
646 {
647 address_item *pp;
648 struct aci *ppp;
649
650 /* Do nothing if we have already handled this address. If not, remember it
651 so that we don't handle it again. */
652
653 for (ppp = *pdlist; ppp; ppp = ppp->next) if (p == ppp->ptr) return TRUE;
654
655 ppp = store_get(sizeof(struct aci), GET_UNTAINTED);
656 ppp->next = *pdlist;
657 *pdlist = ppp;
658 ppp->ptr = p;
659
660 /* Now scan up the ancestry, checking for duplicates at each generation. */
661
662 for (pp = p;; pp = pp->parent)
663   {
664   address_item *dup;
665   for (dup = addr_duplicate; dup; dup = dup->next)
666     if (dup->dupof == pp)   /* a dup of our address */
667       if (!write_env_to(dup, pplist, pdlist, first, tctx))
668         return FALSE;
669   if (!pp->parent) break;
670   }
671
672 /* Check to see if we have already output the progenitor. */
673
674 for (ppp = *pplist; ppp; ppp = ppp->next) if (pp == ppp->ptr) break;
675 if (ppp) return TRUE;
676
677 /* Remember what we have output, and output it. */
678
679 ppp = store_get(sizeof(struct aci), GET_UNTAINTED);
680 ppp->next = *pplist;
681 *pplist = ppp;
682 ppp->ptr = pp;
683
684 if (!*first && !write_chunk(tctx, US",\n ", 3)) return FALSE;
685 *first = FALSE;
686 return write_chunk(tctx, pp->address, Ustrlen(pp->address));
687 }
688
689
690
691
692 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
693
694 Globals:
695   header_list
696
697 Arguments:
698   addr                  (chain of) addresses (for extra headers), or NULL;
699                           only the first address is used
700   tctx                  transport context
701   sendfn                function for output (transport or verify)
702
703 Returns:                TRUE on success; FALSE on failure.
704 */
705 BOOL
706 transport_headers_send(transport_ctx * tctx,
707   BOOL (*sendfn)(transport_ctx * tctx, uschar * s, int len))
708 {
709 const uschar *list;
710 transport_instance * tblock = tctx ? tctx->tblock : NULL;
711 address_item * addr = tctx ? tctx->addr : NULL;
712
713 /* Then the message's headers. Don't write any that are flagged as "old";
714 that means they were rewritten, or are a record of envelope rewriting, or
715 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
716 match any entries therein.  It is a colon-sep list; expand the items
717 separately and squash any empty ones.
718 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
719
720 for (header_line * h = header_list; h; h = h->next) if (h->type != htype_old)
721   {
722   BOOL include_header = TRUE;
723
724   list = tblock ? tblock->remove_headers : NULL;
725   for (int i = 0; i < 2; i++)    /* For remove_headers && addr->prop.remove_headers */
726     {
727     if (list)
728       {
729       int sep = ':';         /* This is specified as a colon-separated list */
730       uschar *s, *ss;
731       while ((s = string_nextinlist(&list, &sep, NULL, 0)))
732         {
733         int len;
734
735         if (i == 0)
736           if (!(s = expand_string(s)) && !f.expand_string_forcedfail)
737             {
738             errno = ERRNO_CHHEADER_FAIL;
739             return FALSE;
740             }
741         len = s ? Ustrlen(s) : 0;
742         if (len && s[len-1] == '*')     /* trailing glob */
743           {
744           if (strncmpic(h->text, s, len-1) == 0) break;
745           }
746         else
747           {
748           if (strncmpic(h->text, s, len) != 0) continue;
749           ss = h->text + len;
750           while (*ss == ' ' || *ss == '\t') ss++;
751           if (*ss == ':') break;
752           }
753         }
754       if (s) { include_header = FALSE; break; }
755       }
756     if (addr) list = addr->prop.remove_headers;
757     }
758
759   /* If this header is to be output, try to rewrite it if there are rewriting
760   rules. */
761
762   if (include_header)
763     {
764     if (tblock && tblock->rewrite_rules)
765       {
766       rmark reset_point = store_mark();
767       header_line *hh;
768
769       if ((hh = rewrite_header(h, NULL, NULL, tblock->rewrite_rules,
770                   tblock->rewrite_existflags, FALSE)))
771         {
772         if (!sendfn(tctx, hh->text, hh->slen)) return FALSE;
773         store_reset(reset_point);
774         continue;     /* With the next header line */
775         }
776       }
777
778     /* Either no rewriting rules, or it didn't get rewritten */
779
780     if (!sendfn(tctx, h->text, h->slen)) return FALSE;
781     }
782
783   /* Header removed */
784
785   else
786     DEBUG(D_transport) debug_printf("removed header line:\n %s---\n", h->text);
787   }
788
789 /* Add on any address-specific headers. If there are multiple addresses,
790 they will all have the same headers in order to be batched. The headers
791 are chained in reverse order of adding (so several addresses from the
792 same alias might share some of them) but we want to output them in the
793 opposite order. This is a bit tedious, but there shouldn't be very many
794 of them. We just walk the list twice, reversing the pointers each time,
795 but on the second time, write out the items.
796
797 Headers added to an address by a router are guaranteed to end with a newline.
798 */
799
800 if (addr)
801   {
802   header_line * hprev = addr->prop.extra_headers, * hnext, * h;
803
804   for (int i = 0; i < 2; i++)
805     for (h = hprev, hprev = NULL; h; h = hnext)
806       {
807       hnext = h->next;
808       h->next = hprev;
809       hprev = h;
810       if (i == 1)
811         {
812         if (!sendfn(tctx, h->text, h->slen)) return FALSE;
813         DEBUG(D_transport)
814           debug_printf("added header line(s):\n %s---\n", h->text);
815         }
816       }
817   }
818
819 /* If a string containing additional headers exists it is a newline-sep
820 list.  Expand each item and write out the result.  This is done last so that
821 if it (deliberately or accidentally) isn't in header format, it won't mess
822 up any other headers. An empty string or a forced expansion failure are
823 noops. An added header string from a transport may not end with a newline;
824 add one if it does not. */
825
826 if (tblock && (list = CUS tblock->add_headers))
827   {
828   int sep = '\n';
829   uschar * s;
830
831   while ((s = string_nextinlist(&list, &sep, NULL, 0)))
832     if ((s = expand_string(s)))
833       {
834       int len = Ustrlen(s);
835       if (len > 0)
836         {
837         if (!sendfn(tctx, s, len)) return FALSE;
838         if (s[len-1] != '\n' && !sendfn(tctx, US"\n", 1))
839           return FALSE;
840         DEBUG(D_transport)
841           {
842           debug_printf("added header line:\n %s", s);
843           if (s[len-1] != '\n') debug_printf("\n");
844           debug_printf("---\n");
845           }
846         }
847       }
848     else if (!f.expand_string_forcedfail)
849       { errno = ERRNO_CHHEADER_FAIL; return FALSE; }
850   }
851
852 /* Separate headers from body with a blank line */
853
854 return sendfn(tctx, US"\n", 1);
855 }
856
857
858 /*************************************************
859 *                Write the message               *
860 *************************************************/
861
862 /* This function writes the message to the given file descriptor. The headers
863 are in the in-store data structure, and the rest of the message is in the open
864 file descriptor deliver_datafile. Make sure we start it at the beginning.
865
866 . If add_return_path is TRUE, a "return-path:" header is added to the message,
867   containing the envelope sender's address.
868
869 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
870   giving the top-level envelope address that caused this delivery to happen.
871
872 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
873   message. It gives the time and date that delivery took place.
874
875 . If check_string is not null, the start of each line is checked for that
876   string. If it is found, it is replaced by escape_string. This used to be
877   the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
878
879 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
880
881 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
882 any writing or reading error, leaving the code in errno intact. Error exits
883 can include timeouts for certain transports, which are requested by setting
884 transport_write_timeout non-zero.
885
886 Arguments:
887   tctx
888     (fd, msg)           Either an fd, to write the message to,
889                         or a string: if null write message to allocated space
890                         otherwire take content as headers.
891     addr                (chain of) addresses (for extra headers), or NULL;
892                           only the first address is used
893     tblock              optional transport instance block (NULL signifies NULL/0):
894       add_headers           a string containing one or more headers to add; it is
895                             expanded, and must be in correct RFC 822 format as
896                             it is transmitted verbatim; NULL => no additions,
897                             and so does empty string or forced expansion fail
898       remove_headers        a colon-separated list of headers to remove, or NULL
899       rewrite_rules         chain of header rewriting rules
900       rewrite_existflags    flags for the rewriting rules
901     options               bit-wise options:
902       add_return_path       if TRUE, add a "return-path" header
903       add_envelope_to       if TRUE, add a "envelope-to" header
904       add_delivery_date     if TRUE, add a "delivery-date" header
905       use_crlf              if TRUE, turn NL into CR LF
906       end_dot               if TRUE, send a terminating "." line at the end
907       no_flush              if TRUE, do not flush at end
908       no_headers            if TRUE, omit the headers
909       no_body               if TRUE, omit the body
910     check_string          a string to check for at the start of lines, or NULL
911     escape_string         a string to insert in front of any check string
912   size_limit              if > 0, this is a limit to the size of message written;
913                             it is used when returning messages to their senders,
914                             and is approximate rather than exact, owing to chunk
915                             buffering
916
917 Returns:                TRUE on success; FALSE (with errno) on failure.
918                         In addition, the global variable transport_count
919                         is incremented by the number of bytes written.
920 */
921
922 static BOOL
923 internal_transport_write_message(transport_ctx * tctx, int size_limit)
924 {
925 int len, size = 0;
926
927 /* Initialize pointer in output buffer. */
928
929 transport_write_reset(tctx->options);
930
931 /* Set up the data for start-of-line data checking and escaping */
932
933 if (tctx->check_string && tctx->escape_string)
934   {
935   nl_check = tctx->check_string;
936   nl_check_length = Ustrlen(nl_check);
937   nl_escape = tctx->escape_string;
938   nl_escape_length = Ustrlen(nl_escape);
939   }
940
941 /* Whether the escaping mechanism is applied to headers or not is controlled by
942 an option (set for SMTP, not otherwise). Negate the length if not wanted till
943 after the headers. */
944
945 if (!(tctx->options & topt_escape_headers))
946   nl_check_length = -nl_check_length;
947
948 /* Write the headers if required, including any that have to be added. If there
949 are header rewriting rules, apply them.  The datasource is not the -D spoolfile
950 so temporarily hide the global that adjusts for its format. */
951
952 if (!(tctx->options & topt_no_headers))
953   {
954   BOOL save_wireformat = f.spool_file_wireformat;
955   f.spool_file_wireformat = FALSE;
956
957   /* Add return-path: if requested. */
958
959   if (tctx->options & topt_add_return_path)
960     {
961     int n;
962     uschar * s = string_sprintf("Return-path: <%.*s>\n%n",
963                           EXIM_EMAILADDR_MAX, return_path, &n);
964     if (!write_chunk(tctx, s, n)) goto bad;
965     }
966
967   /* Add envelope-to: if requested */
968
969   if (tctx->options & topt_add_envelope_to)
970     {
971     BOOL first = TRUE;
972     struct aci *plist = NULL;
973     struct aci *dlist = NULL;
974     rmark reset_point = store_mark();
975
976     if (!write_chunk(tctx, US"Envelope-to: ", 13)) goto bad;
977
978     /* Pick up from all the addresses. The plist and dlist variables are
979     anchors for lists of addresses already handled; they have to be defined at
980     this level because write_env_to() calls itself recursively. */
981
982     for (address_item * p = tctx->addr; p; p = p->next)
983       if (!write_env_to(p, &plist, &dlist, &first, tctx))
984         goto bad;
985
986     /* Add a final newline and reset the store used for tracking duplicates */
987
988     if (!write_chunk(tctx, US"\n", 1)) goto bad;
989     store_reset(reset_point);
990     }
991
992   /* Add delivery-date: if requested. */
993
994   if (tctx->options & topt_add_delivery_date)
995     {
996     uschar * s = tod_stamp(tod_full);
997
998     if (  !write_chunk(tctx, US"Delivery-date: ", 15)
999        || !write_chunk(tctx, s, Ustrlen(s))
1000        || !write_chunk(tctx, US"\n", 1)) goto bad;
1001     }
1002
1003   /* Then the message's headers. Don't write any that are flagged as "old";
1004   that means they were rewritten, or are a record of envelope rewriting, or
1005   were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
1006   match any entries therein. Then check addr->prop.remove_headers too, provided that
1007   addr is not NULL. */
1008
1009   if (!transport_headers_send(tctx, &write_chunk))
1010     {
1011 bad:
1012     f.spool_file_wireformat = save_wireformat;
1013     return FALSE;
1014     }
1015
1016   f.spool_file_wireformat = save_wireformat;
1017   }
1018
1019 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
1020 last-BDAT, consisting of the current write_chunk() output buffer fill
1021 (optimally, all of the headers - but it does not matter if we already had to
1022 flush that buffer with non-last BDAT prependix) plus the amount of body data
1023 (as expanded for CRLF lines).  Then create and write BDAT(s), and ensure
1024 that further use of write_chunk() will not prepend BDATs.
1025 The first BDAT written will also first flush any outstanding MAIL and RCPT
1026 commands which were buffered thans to PIPELINING.
1027 Commands go out (using a send()) from a different buffer to data (using a
1028 write()).  They might not end up in the same TCP segment, which is
1029 suboptimal. */
1030
1031 if (tctx->options & topt_use_bdat)
1032   {
1033   off_t fsize;
1034   int hsize;
1035
1036   if ((hsize = chunk_ptr - deliver_out_buffer) < 0)
1037     hsize = 0;
1038   if (!(tctx->options & topt_no_body))
1039     {
1040     if ((fsize = lseek(deliver_datafile, 0, SEEK_END)) < 0) return FALSE;
1041     fsize -= SPOOL_DATA_START_OFFSET;
1042     if (size_limit > 0  &&  fsize > size_limit)
1043       fsize = size_limit;
1044     size = hsize + fsize;
1045     if (tctx->options & topt_use_crlf  &&  !f.spool_file_wireformat)
1046       size += body_linecount;   /* account for CRLF-expansion */
1047
1048     /* With topt_use_bdat we never do dot-stuffing; no need to
1049     account for any expansion due to that. */
1050     }
1051
1052   /* If the message is large, emit first a non-LAST chunk with just the
1053   headers, and reap the command responses.  This lets us error out early
1054   on RCPT rejects rather than sending megabytes of data.  Include headers
1055   on the assumption they are cheap enough and some clever implementations
1056   might errorcheck them too, on-the-fly, and reject that chunk. */
1057
1058   if (size > DELIVER_OUT_BUFFER_SIZE && hsize > 0)
1059     {
1060     DEBUG(D_transport)
1061       debug_printf("sending small initial BDAT; hsize=%d\n", hsize);
1062     if (  tctx->chunk_cb(tctx, hsize, 0) != OK
1063        || !transport_write_block(tctx, deliver_out_buffer, hsize, FALSE)
1064        || tctx->chunk_cb(tctx, 0, tc_reap_prev) != OK
1065        )
1066       return FALSE;
1067     chunk_ptr = deliver_out_buffer;
1068     size -= hsize;
1069     }
1070
1071   /* Emit a LAST datachunk command, and unmark the context for further
1072   BDAT commands. */
1073
1074   if (tctx->chunk_cb(tctx, size, tc_chunk_last) != OK)
1075     return FALSE;
1076   tctx->options &= ~topt_use_bdat;
1077   }
1078
1079 /* If the body is required, ensure that the data for check strings (formerly
1080 the "from hack") is enabled by negating the length if necessary. (It will be
1081 negative in cases where it isn't to apply to the headers). Then ensure the body
1082 is positioned at the start of its file (following the message id), then write
1083 it, applying the size limit if required. */
1084
1085 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1086 and we want to send a body without dotstuffing or ending-dot, in-clear,
1087 then we can just dump it using sendfile.
1088 This should get used for CHUNKING output and also for writing the -K file for
1089 dkim signing,  when we had CHUNKING input.  */
1090
1091 #ifdef OS_SENDFILE
1092 if (  f.spool_file_wireformat
1093    && !(tctx->options & (topt_no_body | topt_end_dot))
1094    && !nl_check_length
1095    && tls_out.active.sock != tctx->u.fd
1096    )
1097   {
1098   ssize_t copied = 0;
1099   off_t offset = SPOOL_DATA_START_OFFSET;
1100
1101   /* Write out any header data in the buffer */
1102
1103   if ((len = chunk_ptr - deliver_out_buffer) > 0)
1104     {
1105     if (!transport_write_block(tctx, deliver_out_buffer, len, TRUE))
1106       return FALSE;
1107     size -= len;
1108     }
1109
1110   DEBUG(D_transport) debug_printf("using sendfile for body\n");
1111
1112   while(size > 0)
1113     {
1114     if ((copied = os_sendfile(tctx->u.fd, deliver_datafile, &offset, size)) <= 0) break;
1115     size -= copied;
1116     }
1117   return copied >= 0;
1118   }
1119 #else
1120 DEBUG(D_transport) debug_printf("cannot use sendfile for body: no support\n");
1121 #endif
1122
1123 DEBUG(D_transport)
1124   if (!(tctx->options & topt_no_body))
1125     debug_printf("cannot use sendfile for body: %s\n",
1126       !f.spool_file_wireformat ? "spoolfile not wireformat"
1127       : tctx->options & topt_end_dot ? "terminating dot wanted"
1128       : nl_check_length ? "dot- or From-stuffing wanted"
1129       : "TLS output wanted");
1130
1131 if (!(tctx->options & topt_no_body))
1132   {
1133   unsigned long size = size_limit > 0 ? size_limit : ULONG_MAX;
1134
1135   nl_check_length = abs(nl_check_length);
1136   nl_partial_match = 0;
1137   if (lseek(deliver_datafile, SPOOL_DATA_START_OFFSET, SEEK_SET) < 0)
1138     return FALSE;
1139   while (  (len = MIN(DELIVER_IN_BUFFER_SIZE, size)) > 0
1140         && (len = read(deliver_datafile, deliver_in_buffer, len)) > 0)
1141     {
1142     if (!write_chunk(tctx, deliver_in_buffer, len))
1143       return FALSE;
1144     size -= len;
1145     }
1146
1147   /* A read error on the body will have left len == -1 and errno set. */
1148
1149   if (len != 0) return FALSE;
1150   }
1151
1152 /* Finished with the check string, and spool-format consideration */
1153
1154 nl_check_length = nl_escape_length = 0;
1155 f.spool_file_wireformat = FALSE;
1156
1157 /* If requested, add a terminating "." line (SMTP output). */
1158
1159 if (tctx->options & topt_end_dot)
1160   {
1161   smtp_debug_cmd(US".", 0);
1162   if (!write_chunk(tctx, US".\n", 2))
1163     return FALSE;
1164   }
1165
1166 /* Write out any remaining data in the buffer before returning. */
1167
1168 return (len = chunk_ptr - deliver_out_buffer) <= 0
1169   || transport_write_block(tctx, deliver_out_buffer, len,
1170                             !!(tctx->options & topt_no_flush));
1171 }
1172
1173
1174
1175
1176 /*************************************************
1177 *    External interface to write the message     *
1178 *************************************************/
1179
1180 /* If there is no filtering required, call the internal function above to do
1181 the real work, passing over all the arguments from this function. Otherwise,
1182 set up a filtering process, fork another process to call the internal function
1183 to write to the filter, and in this process just suck from the filter and write
1184 down the fd in the transport context. At the end, tidy up the pipes and the
1185 processes.
1186
1187 Arguments:     as for internal_transport_write_message() above
1188
1189 Returns:       TRUE on success; FALSE (with errno) for any failure
1190                transport_count is incremented by the number of bytes written
1191 */
1192
1193 BOOL
1194 transport_write_message(transport_ctx * tctx, int size_limit)
1195 {
1196 BOOL last_filter_was_NL = TRUE;
1197 BOOL save_spool_file_wireformat = f.spool_file_wireformat;
1198 BOOL yield;
1199 int rc, len, fd_read, fd_write, save_errno;
1200 int pfd[2] = {-1, -1};
1201 pid_t filter_pid, write_pid;
1202
1203 f.transport_filter_timed_out = FALSE;
1204
1205 /* If there is no filter command set up, call the internal function that does
1206 the actual work, passing it the incoming fd, and return its result. */
1207
1208 if (  !transport_filter_argv
1209    || !*transport_filter_argv
1210    || !**transport_filter_argv
1211    )
1212   return internal_transport_write_message(tctx, size_limit);
1213
1214 /* Otherwise the message must be written to a filter process and read back
1215 before being written to the incoming fd. First set up the special processing to
1216 be done during the copying. */
1217
1218 nl_partial_match = -1;
1219
1220 if (tctx->check_string && tctx->escape_string)
1221   {
1222   nl_check = tctx->check_string;
1223   nl_check_length = Ustrlen(nl_check);
1224   nl_escape = tctx->escape_string;
1225   nl_escape_length = Ustrlen(nl_escape);
1226   }
1227 else nl_check_length = nl_escape_length = 0;
1228
1229 /* Start up a subprocess to run the command. Ensure that our main fd will
1230 be closed when the subprocess execs, but remove the flag afterwards.
1231 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1232 process to deliver another message.) We get back stdin/stdout file descriptors.
1233 If the process creation failed, give an error return. */
1234
1235 fd_read = -1;
1236 fd_write = -1;
1237 save_errno = 0;
1238 yield = FALSE;
1239 write_pid = (pid_t)(-1);
1240
1241   {
1242   int bits = fcntl(tctx->u.fd, F_GETFD);
1243   (void) fcntl(tctx->u.fd, F_SETFD, bits | FD_CLOEXEC);
1244   filter_pid = child_open(USS transport_filter_argv, NULL, 077,
1245                           &fd_write, &fd_read, FALSE, US"transport-filter");
1246   (void) fcntl(tctx->u.fd, F_SETFD, bits & ~FD_CLOEXEC);
1247   }
1248 if (filter_pid < 0) goto TIDY_UP;      /* errno set */
1249
1250 DEBUG(D_transport)
1251   debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1252     (int)filter_pid, fd_write, fd_read);
1253
1254 /* Fork subprocess to write the message to the filter, and return the result
1255 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1256 smtp dots, or check string processing. */
1257
1258 if (pipe(pfd) != 0) goto TIDY_UP;      /* errno set */
1259 if ((write_pid = exim_fork(US"tpt-filter-writer")) == 0)
1260   {
1261   BOOL rc;
1262   (void)close(fd_read);
1263   (void)close(pfd[pipe_read]);
1264   nl_check_length = nl_escape_length = 0;
1265
1266   tctx->u.fd = fd_write;
1267   tctx->check_string = tctx->escape_string = NULL;
1268   tctx->options &= ~(topt_use_crlf | topt_end_dot | topt_use_bdat | topt_no_flush);
1269
1270   rc = internal_transport_write_message(tctx, size_limit);
1271
1272   save_errno = errno;
1273   if (  write(pfd[pipe_write], (void *)&rc, sizeof(BOOL))
1274         != sizeof(BOOL)
1275      || write(pfd[pipe_write], (void *)&save_errno, sizeof(int))
1276         != sizeof(int)
1277      || write(pfd[pipe_write], (void *)&tctx->addr->more_errno, sizeof(int))
1278         != sizeof(int)
1279      || write(pfd[pipe_write], (void *)&tctx->addr->delivery_time, sizeof(struct timeval))
1280         != sizeof(struct timeval)
1281      )
1282     rc = FALSE; /* compiler quietening */
1283   exim_underbar_exit(EXIT_SUCCESS);
1284   }
1285 save_errno = errno;
1286
1287 /* Parent process: close our copy of the writing subprocess' pipes. */
1288
1289 (void)close(pfd[pipe_write]);
1290 (void)close(fd_write);
1291 fd_write = -1;
1292
1293 /* Writing process creation failed */
1294
1295 if (write_pid < 0)
1296   {
1297   errno = save_errno;    /* restore */
1298   goto TIDY_UP;
1299   }
1300
1301 /* When testing, let the subprocess get going */
1302
1303 testharness_pause_ms(250);
1304
1305 DEBUG(D_transport)
1306   debug_printf("process %d writing to transport filter\n", (int)write_pid);
1307
1308 /* Copy the message from the filter to the output fd. A read error leaves len
1309 == -1 and errno set. We need to apply a timeout to the read, to cope with
1310 the case when the filter gets stuck, but it can be quite a long one. The
1311 default is 5m, but this is now configurable. */
1312
1313 DEBUG(D_transport) debug_printf("copying from the filter\n");
1314
1315 /* Copy the output of the filter, remembering if the last character was NL. If
1316 no data is returned, that counts as "ended with NL" (default setting of the
1317 variable is TRUE).  The output should always be unix-format as we converted
1318 any wireformat source on writing input to the filter. */
1319
1320 f.spool_file_wireformat = FALSE;
1321 chunk_ptr = deliver_out_buffer;
1322
1323 for (;;)
1324   {
1325   sigalrm_seen = FALSE;
1326   ALARM(transport_filter_timeout);
1327   len = read(fd_read, deliver_in_buffer, DELIVER_IN_BUFFER_SIZE);
1328   ALARM_CLR(0);
1329   if (sigalrm_seen)
1330     {
1331     DEBUG(D_transport) debug_printf("timed out reading from filter\n");
1332     errno = ETIMEDOUT;
1333     f.transport_filter_timed_out = TRUE;
1334     goto TIDY_UP;
1335     }
1336
1337   /* If the read was successful, write the block down the original fd,
1338   remembering whether it ends in \n or not. */
1339
1340   if (len > 0)
1341     {
1342     if (!write_chunk(tctx, deliver_in_buffer, len)) goto TIDY_UP;
1343     last_filter_was_NL = (deliver_in_buffer[len-1] == '\n');
1344     }
1345
1346   /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1347
1348   else
1349     {
1350     if (len == 0) yield = TRUE;
1351     break;
1352     }
1353   }
1354
1355 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1356 to something. Ensure the pipes are all closed and the processes are removed. If
1357 there has been an error, kill the processes before waiting for them, just to be
1358 sure. Also apply a paranoia timeout. */
1359
1360 TIDY_UP:
1361 f.spool_file_wireformat = save_spool_file_wireformat;
1362 save_errno = errno;
1363
1364 (void)close(fd_read);
1365 if (fd_write > 0) (void)close(fd_write);
1366
1367 if (!yield)
1368   {
1369   if (filter_pid > 0) kill(filter_pid, SIGKILL);
1370   if (write_pid > 0)  kill(write_pid, SIGKILL);
1371   }
1372
1373 /* Wait for the filter process to complete. */
1374
1375 DEBUG(D_transport) debug_printf("waiting for filter process\n");
1376 if (filter_pid > 0 && (rc = child_close(filter_pid, 30)) != 0 && yield)
1377   {
1378   yield = FALSE;
1379   save_errno = ERRNO_FILTER_FAIL;
1380   tctx->addr->more_errno = rc;
1381   DEBUG(D_transport) debug_printf("filter process returned %d\n", rc);
1382   }
1383
1384 /* Wait for the writing process to complete. If it ends successfully,
1385 read the results from its pipe, provided we haven't already had a filter
1386 process failure. */
1387
1388 DEBUG(D_transport) debug_printf("waiting for writing process\n");
1389 if (write_pid > 0)
1390   {
1391   rc = child_close(write_pid, 30);
1392   if (yield)
1393     if (rc == 0)
1394       {
1395       BOOL ok;
1396       if (read(pfd[pipe_read], (void *)&ok, sizeof(BOOL)) != sizeof(BOOL))
1397         {
1398         DEBUG(D_transport)
1399           debug_printf("pipe read from writing process: %s\n", strerror(errno));
1400         save_errno = ERRNO_FILTER_FAIL;
1401         yield = FALSE;
1402         }
1403       else if (!ok)
1404         {               /* Try to drain the pipe; read fails are don't care */
1405         int dummy = read(pfd[pipe_read], (void *)&save_errno, sizeof(int));
1406         dummy = read(pfd[pipe_read], (void *)&tctx->addr->more_errno, sizeof(int));
1407         dummy = read(pfd[pipe_read], (void *)&tctx->addr->delivery_time, sizeof(struct timeval));
1408         yield = FALSE;
1409         }
1410       }
1411     else
1412       {
1413       yield = FALSE;
1414       save_errno = ERRNO_FILTER_FAIL;
1415       tctx->addr->more_errno = rc;
1416       DEBUG(D_transport) debug_printf("writing process returned %d\n", rc);
1417       }
1418   }
1419 (void)close(pfd[pipe_read]);
1420
1421 /* If there have been no problems we can now add the terminating "." if this is
1422 SMTP output, turning off escaping beforehand. If the last character from the
1423 filter was not NL, insert a NL to make the SMTP protocol work. */
1424
1425 if (yield)
1426   {
1427   nl_check_length = nl_escape_length = 0;
1428   f.spool_file_wireformat = FALSE;
1429   if (  tctx->options & topt_end_dot
1430      && ( last_filter_was_NL
1431         ? !write_chunk(tctx, US".\n", 2)
1432         : !write_chunk(tctx, US"\n.\n", 3)
1433      )  )
1434     { smtp_debug_cmd(US".", 0); yield = FALSE; }
1435
1436   /* Write out any remaining data in the buffer. */
1437
1438   else
1439     yield = (len = chunk_ptr - deliver_out_buffer) <= 0
1440           || transport_write_block(tctx, deliver_out_buffer, len, FALSE);
1441   }
1442 else
1443   errno = save_errno;      /* From some earlier error */
1444
1445 DEBUG(D_transport)
1446   {
1447   debug_printf("end of filtering transport writing: yield=%d\n", yield);
1448   if (!yield)
1449     debug_printf(" errno=%d more_errno=%d\n", errno, tctx->addr->more_errno);
1450   }
1451
1452 return yield;
1453 }
1454
1455
1456
1457
1458
1459 /*************************************************
1460 *            Update waiting database             *
1461 *************************************************/
1462
1463 /* This is called when an address is deferred by remote transports that are
1464 capable of sending more than one message over one connection. A database is
1465 maintained for each transport, keeping track of which messages are waiting for
1466 which hosts. The transport can then consult this when eventually a successful
1467 delivery happens, and if it finds that another message is waiting for the same
1468 host, it can fire up a new process to deal with it using the same connection.
1469
1470 The database records are keyed by host name. They can get full if there are
1471 lots of messages waiting, and so there is a continuation mechanism for them.
1472
1473 Each record contains a list of message ids, packed end to end without any
1474 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1475 in this record, and the sequence field says if there are any other records for
1476 this host. If the sequence field is 0, there are none. If it is 1, then another
1477 record with the name <hostname>:0 exists; if it is 2, then two other records
1478 with sequence numbers 0 and 1 exist, and so on.
1479
1480 Currently, an exhaustive search of all continuation records has to be done to
1481 determine whether to add a message id to a given record. This shouldn't be
1482 too bad except in extreme cases. I can't figure out a *simple* way of doing
1483 better.
1484
1485 Old records should eventually get swept up by the exim_tidydb utility.
1486
1487 Arguments:
1488   hostlist  list of hosts that this message could be sent to
1489   tpname    name of the transport
1490
1491 Returns:    nothing
1492 */
1493
1494 void
1495 transport_update_waiting(host_item *hostlist, uschar *tpname)
1496 {
1497 const uschar *prevname = US"";
1498 open_db dbblock;
1499 open_db *dbm_file;
1500
1501 DEBUG(D_transport) debug_printf("updating wait-%s database\n", tpname);
1502
1503 /* Open the database for this transport */
1504
1505 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", tpname),
1506                       O_RDWR, &dbblock, TRUE, TRUE)))
1507   return;
1508
1509 /* Scan the list of hosts for which this message is waiting, and ensure
1510 that the message id is in each host record. */
1511
1512 for (host_item * host = hostlist; host; host = host->next)
1513   {
1514   BOOL already = FALSE;
1515   dbdata_wait *host_record;
1516   int host_length;
1517   uschar buffer[256];
1518
1519   /* Skip if this is the same host as we just processed; otherwise remember
1520   the name for next time. */
1521
1522   if (Ustrcmp(prevname, host->name) == 0) continue;
1523   prevname = host->name;
1524
1525   /* Look up the host record; if there isn't one, make an empty one. */
1526
1527   if (!(host_record = dbfn_read(dbm_file, host->name)))
1528     {
1529     host_record = store_get(sizeof(dbdata_wait) + MESSAGE_ID_LENGTH, GET_UNTAINTED);
1530     host_record->count = host_record->sequence = 0;
1531     }
1532
1533   /* Compute the current length */
1534
1535   host_length = host_record->count * MESSAGE_ID_LENGTH;
1536
1537   /* Search the record to see if the current message is already in it. */
1538
1539   for (uschar * s = host_record->text; s < host_record->text + host_length;
1540        s += MESSAGE_ID_LENGTH)
1541     if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1542       { already = TRUE; break; }
1543
1544   /* If we haven't found this message in the main record, search any
1545   continuation records that exist. */
1546
1547   for (int i = host_record->sequence - 1; i >= 0 && !already; i--)
1548     {
1549     dbdata_wait *cont;
1550     sprintf(CS buffer, "%.200s:%d", host->name, i);
1551     if ((cont = dbfn_read(dbm_file, buffer)))
1552       {
1553       int clen = cont->count * MESSAGE_ID_LENGTH;
1554       for (uschar * s = cont->text; s < cont->text + clen; s += MESSAGE_ID_LENGTH)
1555         if (Ustrncmp(s, message_id, MESSAGE_ID_LENGTH) == 0)
1556           { already = TRUE; break; }
1557       }
1558     }
1559
1560   /* If this message is already in a record, no need to update. */
1561
1562   if (already)
1563     {
1564     DEBUG(D_transport) debug_printf("already listed for %s\n", host->name);
1565     continue;
1566     }
1567
1568
1569   /* If this record is full, write it out with a new name constructed
1570   from the sequence number, increase the sequence number, and empty
1571   the record.  If we're doing a two-phase queue run initial phase, ping the
1572   daemon to consider running a delivery on this host. */
1573
1574   if (host_record->count >= WAIT_NAME_MAX)
1575     {
1576     sprintf(CS buffer, "%.200s:%d", host->name, host_record->sequence);
1577     dbfn_write(dbm_file, buffer, host_record, sizeof(dbdata_wait) + host_length);
1578 #ifndef DISABLE_QUEUE_RAMP
1579     if (f.queue_2stage && queue_fast_ramp && !queue_run_in_order)
1580       queue_notify_daemon(message_id);
1581 #endif
1582     host_record->sequence++;
1583     host_record->count = 0;
1584     host_length = 0;
1585     }
1586
1587   /* If this record is not full, increase the size of the record to
1588   allow for one new message id. */
1589
1590   else
1591     {
1592     dbdata_wait *newr =
1593       store_get(sizeof(dbdata_wait) + host_length + MESSAGE_ID_LENGTH, GET_UNTAINTED);
1594     memcpy(newr, host_record, sizeof(dbdata_wait) + host_length);
1595     host_record = newr;
1596     }
1597
1598   /* Now add the new name on the end */
1599
1600   memcpy(host_record->text + host_length, message_id, MESSAGE_ID_LENGTH);
1601   host_record->count++;
1602   host_length += MESSAGE_ID_LENGTH;
1603
1604   /* Update the database */
1605
1606   dbfn_write(dbm_file, host->name, host_record, sizeof(dbdata_wait) + host_length);
1607   DEBUG(D_transport) debug_printf("added %.*s to queue for %s\n",
1608                                   MESSAGE_ID_LENGTH, message_id, host->name);
1609   }
1610
1611 /* All now done */
1612
1613 dbfn_close(dbm_file);
1614 }
1615
1616
1617
1618
1619 /*************************************************
1620 *         Test for waiting messages              *
1621 *************************************************/
1622
1623 /* This function is called by a remote transport which uses the previous
1624 function to remember which messages are waiting for which remote hosts. It's
1625 called after a successful delivery and its job is to check whether there is
1626 another message waiting for the same host. However, it doesn't do this if the
1627 current continue sequence is greater than the maximum supplied as an argument,
1628 or greater than the global connection_max_messages, which, if set, overrides.
1629
1630 Arguments:
1631   transport_name     name of the transport
1632   hostname           name of the host
1633   local_message_max  maximum number of messages down one connection
1634                        as set by the caller transport
1635   new_message_id     set to the message id of a waiting message
1636   oicf_func          function to call to validate if it is ok to send
1637                      to this message_id from the current instance.
1638   oicf_data          opaque data for oicf_func
1639
1640 Returns:             TRUE if new_message_id set; FALSE otherwise
1641 */
1642
1643 typedef struct msgq_s
1644 {
1645     uschar  message_id [MESSAGE_ID_LENGTH + 1];
1646     BOOL    bKeep;
1647 } msgq_t;
1648
1649 BOOL
1650 transport_check_waiting(const uschar *transport_name, const uschar *hostname,
1651   int local_message_max, uschar *new_message_id, oicf oicf_func, void *oicf_data)
1652 {
1653 dbdata_wait *host_record;
1654 int host_length;
1655 open_db dbblock;
1656 open_db *dbm_file;
1657
1658 int         i;
1659 struct stat statbuf;
1660
1661 DEBUG(D_transport)
1662   {
1663   debug_printf("transport_check_waiting entered\n");
1664   debug_printf("  sequence=%d local_max=%d global_max=%d\n",
1665     continue_sequence, local_message_max, connection_max_messages);
1666   acl_level++;
1667   }
1668
1669 /* Do nothing if we have hit the maximum number that can be send down one
1670 connection. */
1671
1672 if (connection_max_messages >= 0) local_message_max = connection_max_messages;
1673 if (local_message_max > 0 && continue_sequence >= local_message_max)
1674   {
1675   DEBUG(D_transport)
1676     debug_printf_indent("max messages for one connection reached: returning\n");
1677   goto retfalse;
1678   }
1679
1680 /* Open the waiting information database. */
1681
1682 if (!(dbm_file = dbfn_open(string_sprintf("wait-%.200s", transport_name),
1683                           O_RDWR, &dbblock, TRUE, TRUE)))
1684   goto retfalse;
1685
1686 /* See if there is a record for this host; if not, there's nothing to do. */
1687
1688 if (!(host_record = dbfn_read(dbm_file, hostname)))
1689   {
1690   dbfn_close(dbm_file);
1691   DEBUG(D_transport) debug_printf_indent("no messages waiting for %s\n", hostname);
1692   goto retfalse;
1693   }
1694
1695 /* If the data in the record looks corrupt, just log something and
1696 don't try to use it. */
1697
1698 if (host_record->count > WAIT_NAME_MAX)
1699   {
1700   dbfn_close(dbm_file);
1701   log_write(0, LOG_MAIN|LOG_PANIC, "smtp-wait database entry for %s has bad "
1702     "count=%d (max=%d)", hostname, host_record->count, WAIT_NAME_MAX);
1703   goto retfalse;
1704   }
1705
1706 /* Scan the message ids in the record from the end towards the beginning,
1707 until one is found for which a spool file actually exists. If the record gets
1708 emptied, delete it and continue with any continuation records that may exist.
1709 */
1710
1711 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1712 but the 1 off will remain without it.  This code now allows me to SKIP over
1713 a message I do not want to send out on this run.  */
1714
1715 host_length = host_record->count * MESSAGE_ID_LENGTH;
1716
1717 while (1)
1718   {
1719   msgq_t      *msgq;
1720   int         msgq_count = 0;
1721   int         msgq_actual = 0;
1722   BOOL        bFound = FALSE;
1723   BOOL        bContinuation = FALSE;
1724
1725   /* create an array to read entire message queue into memory for processing  */
1726
1727   msgq = store_get(sizeof(msgq_t) * host_record->count, GET_UNTAINTED);
1728   msgq_count = host_record->count;
1729   msgq_actual = msgq_count;
1730
1731   for (i = 0; i < host_record->count; ++i)
1732     {
1733     msgq[i].bKeep = TRUE;
1734
1735     Ustrncpy_nt(msgq[i].message_id, host_record->text + (i * MESSAGE_ID_LENGTH),
1736       MESSAGE_ID_LENGTH);
1737     msgq[i].message_id[MESSAGE_ID_LENGTH] = 0;
1738     }
1739
1740   /* first thing remove current message id if it exists */
1741   /*XXX but what if it has un-sent addrs? */
1742
1743   for (i = 0; i < msgq_count; ++i)
1744     if (Ustrcmp(msgq[i].message_id, message_id) == 0)
1745       {
1746       msgq[i].bKeep = FALSE;
1747       break;
1748       }
1749
1750   /* now find the next acceptable message_id */
1751
1752   for (i = msgq_count - 1; i >= 0; --i) if (msgq[i].bKeep)
1753     {
1754     uschar subdir[2];
1755     uschar * mid = msgq[i].message_id;
1756
1757     set_subdir_str(subdir, mid, 0);
1758     if (Ustat(spool_fname(US"input", subdir, mid, US"-D"), &statbuf) != 0)
1759       msgq[i].bKeep = FALSE;
1760     else if (!oicf_func || oicf_func(mid, oicf_data))
1761       {
1762       Ustrcpy_nt(new_message_id, mid);
1763       msgq[i].bKeep = FALSE;
1764       bFound = TRUE;
1765       break;
1766       }
1767     }
1768
1769   /* re-count */
1770   for (msgq_actual = 0, i = 0; i < msgq_count; ++i)
1771     if (msgq[i].bKeep)
1772       msgq_actual++;
1773
1774   /* reassemble the host record, based on removed message ids, from in
1775   memory queue  */
1776
1777   if (msgq_actual <= 0)
1778     {
1779     host_length = 0;
1780     host_record->count = 0;
1781     }
1782   else
1783     {
1784     host_length = msgq_actual * MESSAGE_ID_LENGTH;
1785     host_record->count = msgq_actual;
1786
1787     if (msgq_actual < msgq_count)
1788       {
1789       int new_count;
1790       for (new_count = 0, i = 0; i < msgq_count; ++i)
1791         if (msgq[i].bKeep)
1792           Ustrncpy(&host_record->text[new_count++ * MESSAGE_ID_LENGTH],
1793             msgq[i].message_id, MESSAGE_ID_LENGTH);
1794
1795       host_record->text[new_count * MESSAGE_ID_LENGTH] = 0;
1796       }
1797     }
1798
1799   /* Check for a continuation record. */
1800
1801   while (host_length <= 0)
1802     {
1803     dbdata_wait * newr = NULL;
1804     uschar buffer[256];
1805
1806     /* Search for a continuation */
1807
1808     for (int i = host_record->sequence - 1; i >= 0 && !newr; i--)
1809       {
1810       sprintf(CS buffer, "%.200s:%d", hostname, i);
1811       newr = dbfn_read(dbm_file, buffer);
1812       }
1813
1814     /* If no continuation, delete the current and break the loop */
1815
1816     if (!newr)
1817       {
1818       dbfn_delete(dbm_file, hostname);
1819       break;
1820       }
1821
1822     /* Else replace the current with the continuation */
1823
1824     dbfn_delete(dbm_file, buffer);
1825     host_record = newr;
1826     host_length = host_record->count * MESSAGE_ID_LENGTH;
1827
1828     bContinuation = TRUE;
1829     }
1830
1831   if (bFound)           /* Usual exit from main loop */
1832     break;
1833
1834   /* If host_length <= 0 we have emptied a record and not found a good message,
1835   and there are no continuation records. Otherwise there is a continuation
1836   record to process. */
1837
1838   if (host_length <= 0)
1839     {
1840     dbfn_close(dbm_file);
1841     DEBUG(D_transport) debug_printf_indent("waiting messages already delivered\n");
1842     goto retfalse;
1843     }
1844
1845   /* we were not able to find an acceptable message, nor was there a
1846    * continuation record.  So bug out, outer logic will clean this up.
1847    */
1848
1849   if (!bContinuation)
1850     {
1851     Ustrcpy(new_message_id, message_id);
1852     dbfn_close(dbm_file);
1853     goto retfalse;
1854     }
1855   }             /* we need to process a continuation record */
1856
1857 /* Control gets here when an existing message has been encountered; its
1858 id is in new_message_id, and host_length is the revised length of the
1859 host record. If it is zero, the record has been removed. Update the
1860 record if required, close the database, and return TRUE. */
1861
1862 if (host_length > 0)
1863   {
1864   host_record->count = host_length/MESSAGE_ID_LENGTH;
1865   dbfn_write(dbm_file, hostname, host_record, (int)sizeof(dbdata_wait) + host_length);
1866   }
1867
1868 dbfn_close(dbm_file);
1869 DEBUG(D_transport) {acl_level--; debug_printf("transport_check_waiting: TRUE\n"); }
1870 return TRUE;
1871
1872 retfalse:
1873 DEBUG(D_transport) {acl_level--; debug_printf("transport_check_waiting: FALSE\n"); }
1874 return FALSE;
1875 }
1876
1877 /*************************************************
1878 *    Deliver waiting message down same socket    *
1879 *************************************************/
1880
1881 /* Just the regain-root-privilege exec portion */
1882 void
1883 transport_do_pass_socket(const uschar *transport_name, const uschar *hostname,
1884   const uschar *hostaddress, uschar *id, int socket_fd)
1885 {
1886 int i = 13;
1887 const uschar **argv;
1888
1889 #ifndef DISABLE_TLS
1890 if (smtp_peer_options & OPTION_TLS) i += 6;
1891 #endif
1892 #ifdef EXPERIMENTAL_ESMTP_LIMITS
1893 if (continue_limit_mail || continue_limit_rcpt || continue_limit_rcptdom)
1894                                     i += 4;
1895 #endif
1896 if (queue_run_pid != (pid_t)0)      i += 3;
1897 #ifdef SUPPORT_SOCKS
1898 if (proxy_session)                  i += 5;
1899 #endif
1900
1901 /* Set up the calling arguments; use the standard function for the basics,
1902 but we have a number of extras that may be added. */
1903
1904 argv = CUSS child_exec_exim(CEE_RETURN_ARGV, TRUE, &i, FALSE, 0);
1905
1906 if (f.smtp_authenticated)                       argv[i++] = US"-MCA";
1907 if (smtp_peer_options & OPTION_CHUNKING)        argv[i++] = US"-MCK";
1908 if (smtp_peer_options & OPTION_DSN)             argv[i++] = US"-MCD";
1909 if (smtp_peer_options & OPTION_PIPE)            argv[i++] = US"-MCP";
1910 if (smtp_peer_options & OPTION_SIZE)            argv[i++] = US"-MCS";
1911 #ifndef DISABLE_TLS
1912 if (smtp_peer_options & OPTION_TLS)
1913   if (tls_out.active.sock >= 0 || continue_proxy_cipher)
1914     {
1915     argv[i++] = US"-MCt";
1916     argv[i++] = sending_ip_address;
1917     argv[i++] = string_sprintf("%d", sending_port);
1918     argv[i++] = tls_out.active.sock >= 0 ? tls_out.cipher : continue_proxy_cipher;
1919
1920     if (tls_out.sni)
1921       {
1922       argv[i++] =
1923 #ifdef SUPPORT_DANE
1924         tls_out.dane_verified ? US"-MCr" :
1925 #endif
1926         US"-MCs";
1927       argv[i++] = tls_out.sni;
1928       }
1929     }
1930   else
1931     argv[i++] = US"-MCT";
1932 #endif
1933
1934 #ifdef EXPERIMENTAL_ESMTP_LIMITS
1935 if (continue_limit_rcpt || continue_limit_rcptdom)
1936   {
1937   argv[i++] = US"-MCL";
1938   argv[i++] = string_sprintf("%u", continue_limit_mail);
1939   argv[i++] = string_sprintf("%u", continue_limit_rcpt);
1940   argv[i++] = string_sprintf("%u", continue_limit_rcptdom);
1941   }
1942 #endif
1943
1944 if (queue_run_pid != (pid_t)0)
1945   {
1946   argv[i++] = US"-MCQ";
1947   argv[i++] = string_sprintf("%d", queue_run_pid);
1948   argv[i++] = string_sprintf("%d", queue_run_pipe);
1949   }
1950
1951 #ifdef SUPPORT_SOCKS
1952 if (proxy_session)
1953   {
1954   argv[i++] = US"-MCp";
1955   argv[i++] = proxy_local_address;
1956   argv[i++] = string_sprintf("%d", proxy_local_port);
1957   argv[i++] = proxy_external_address;
1958   argv[i++] = string_sprintf("%d", proxy_external_port);
1959   }
1960 #endif
1961
1962 argv[i++] = US"-MC";
1963 argv[i++] = US transport_name;
1964 argv[i++] = US hostname;
1965 argv[i++] = US hostaddress;
1966 argv[i++] = string_sprintf("%d", continue_sequence + 1);
1967 argv[i++] = id;
1968 argv[i++] = NULL;
1969
1970 /* Arrange for the channel to be on stdin. */
1971
1972 if (socket_fd != 0)
1973   {
1974   (void)dup2(socket_fd, 0);
1975   (void)close(socket_fd);
1976   }
1977
1978 DEBUG(D_exec) debug_print_argv(argv);
1979 exim_nullstd();                          /* Ensure std{out,err} exist */
1980 /* argv[0] should be untainted, from child_exec_exim() */
1981 execv(CS argv[0], (char *const *)argv);
1982
1983 DEBUG(D_any) debug_printf("execv failed: %s\n", strerror(errno));
1984 _exit(errno);         /* Note: must be _exit(), NOT exit() */
1985 }
1986
1987
1988
1989 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1990 get a clean delivery process, and to regain root privilege in cases where it
1991 has been given away.
1992
1993 Arguments:
1994   transport_name  to pass to the new process
1995   hostname        ditto
1996   hostaddress     ditto
1997   id              the new message to process
1998   socket_fd       the connected socket
1999
2000 Returns:          FALSE if fork fails; TRUE otherwise
2001 */
2002
2003 BOOL
2004 transport_pass_socket(const uschar *transport_name, const uschar *hostname,
2005   const uschar *hostaddress, uschar *id, int socket_fd
2006 #ifdef EXPERIMENTAL_ESMTP_LIMITS
2007   , unsigned peer_limit_mail, unsigned peer_limit_rcpt, unsigned peer_limit_rcptdom
2008 #endif
2009   )
2010 {
2011 pid_t pid;
2012 int status;
2013
2014 DEBUG(D_transport) debug_printf("transport_pass_socket entered\n");
2015
2016 #ifdef EXPERIMENTAL_ESMTP_LIMITS
2017 continue_limit_mail = peer_limit_mail;
2018 continue_limit_rcpt = peer_limit_rcpt;
2019 continue_limit_rcptdom = peer_limit_rcptdom;
2020 #endif
2021
2022 if ((pid = exim_fork(US"continued-transport-interproc")) == 0)
2023   {
2024   /* Disconnect entirely from the parent process. If we are running in the
2025   test harness, wait for a bit to allow the previous process time to finish,
2026   write the log, etc., so that the output is always in the same order for
2027   automatic comparison. */
2028
2029   if ((pid = exim_fork(US"continued-transport")) != 0)
2030     _exit(EXIT_SUCCESS);
2031   testharness_pause_ms(1000);
2032
2033   transport_do_pass_socket(transport_name, hostname, hostaddress,
2034     id, socket_fd);
2035   }
2036
2037 /* If the process creation succeeded, wait for the first-level child, which
2038 immediately exits, leaving the second level process entirely disconnected from
2039 this one. */
2040
2041 if (pid > 0)
2042   {
2043   int rc;
2044   while ((rc = wait(&status)) != pid && (rc >= 0 || errno != ECHILD));
2045   return TRUE;
2046   }
2047 else
2048   {
2049   DEBUG(D_transport) debug_printf("transport_pass_socket failed to fork: %s\n",
2050     strerror(errno));
2051   return FALSE;
2052   }
2053 }
2054
2055
2056
2057 /* Enforce all args untainted, for consistency with a router-sourced pipe
2058 command, where (because the whole line is passed as one to the tpt) a
2059 tainted arg taints the executable name.  It's unclear also that letting an
2060 attacker supply command arguments is wise. */
2061
2062 static BOOL
2063 arg_is_tainted(const uschar * s, int argn, address_item * addr,
2064   const uschar * etext, uschar ** errptr)
2065 {
2066 if (is_tainted(s))
2067   {
2068   uschar * msg = string_sprintf("Tainted arg %d for %s command: '%s'",
2069                                 argn, etext, s);
2070   if (addr)
2071     {
2072     addr->transport_return = FAIL;
2073     addr->message = msg;
2074     }
2075   else *errptr = msg;
2076   return TRUE;
2077   }
2078 return FALSE;
2079 }
2080
2081
2082 /*************************************************
2083 *          Set up direct (non-shell) command     *
2084 *************************************************/
2085
2086 /* This function is called when a command line is to be parsed and executed
2087 directly, without the use of /bin/sh. It is called by the pipe transport,
2088 the queryprogram router, and also from the main delivery code when setting up a
2089 transport filter process. The code for ETRN also makes use of this; in that
2090 case, no addresses are passed.
2091
2092 Arguments:
2093   argvptr            pointer to anchor for argv vector
2094   cmd                points to the command string (modified IN PLACE)
2095   expand_arguments   true if expansion is to occur
2096   expand_failed      error value to set if expansion fails; not relevant if
2097                      addr == NULL
2098   addr               chain of addresses, or NULL
2099   allow_tainted_args as it says; used for ${run}
2100   etext              text for use in error messages
2101   errptr             where to put error message if addr is NULL;
2102                      otherwise it is put in the first address
2103
2104 Returns:             TRUE if all went well; otherwise an error will be
2105                      set in the first address and FALSE returned
2106 */
2107
2108 BOOL
2109 transport_set_up_command(const uschar *** argvptr, const uschar * cmd,
2110   BOOL expand_arguments, int expand_failed, address_item * addr,
2111   BOOL allow_tainted_args, const uschar * etext, uschar ** errptr)
2112 {
2113 const uschar ** argv, * s;
2114 int address_count = 0, argcount = 0, max_args;
2115
2116 /* Get store in which to build an argument list. Count the number of addresses
2117 supplied, and allow for that many arguments, plus an additional 60, which
2118 should be enough for anybody. Multiple addresses happen only when the local
2119 delivery batch option is set. */
2120
2121 for (address_item * ad = addr; ad; ad = ad->next) address_count++;
2122 max_args = address_count + 60;
2123 *argvptr = argv = store_get((max_args+1)*sizeof(uschar *), GET_UNTAINTED);
2124
2125 /* Split the command up into arguments terminated by white space. Lose
2126 trailing space at the start and end. Double-quoted arguments can contain \\ and
2127 \" escapes and so can be handled by the standard function; single-quoted
2128 arguments are verbatim. Copy each argument into a new string. */
2129
2130 s = cmd;
2131 Uskip_whitespace(&s);
2132
2133 for (; *s && argcount < max_args; argcount++)
2134   {
2135   if (*s == '\'')
2136     {
2137     int n = Ustrcspn(++s, "'");
2138     argv[argcount] = string_copyn(s, n);
2139     if (*(s += n) == '\'') s++;
2140     }
2141   else
2142     argv[argcount] = string_dequote(CUSS &s);
2143   Uskip_whitespace(&s);
2144   }
2145
2146 argv[argcount] = NULL;
2147
2148 /* If *s != 0 we have run out of argument slots. */
2149
2150 if (*s)
2151   {
2152   uschar *msg = string_sprintf("Too many arguments in command \"%s\" in "
2153     "%s", cmd, etext);
2154   if (addr)
2155     {
2156     addr->transport_return = FAIL;
2157     addr->message = msg;
2158     }
2159   else *errptr = msg;
2160   return FALSE;
2161   }
2162
2163 /* Expand each individual argument if required. Expansion happens for pipes set
2164 up in filter files and with directly-supplied commands. It does not happen if
2165 the pipe comes from a traditional .forward file. A failing expansion is a big
2166 disaster if the command came from Exim's configuration; if it came from a user
2167 it is just a normal failure. The expand_failed value is used as the error value
2168 to cater for these two cases.
2169
2170 An argument consisting just of the text "$pipe_addresses" is treated specially.
2171 It is not passed to the general expansion function. Instead, it is replaced by
2172 a number of arguments, one for each address. This avoids problems with shell
2173 metacharacters and spaces in addresses.
2174
2175 If the parent of the top address has an original part of "system-filter", this
2176 pipe was set up by the system filter, and we can permit the expansion of
2177 $recipients. */
2178
2179 DEBUG(D_transport)
2180   {
2181   debug_printf("direct command:\n");
2182   for (int i = 0; argv[i]; i++)
2183     debug_printf("  argv[%d] = '%s'\n", i, string_printing(argv[i]));
2184   }
2185
2186 if (expand_arguments)
2187   {
2188   BOOL allow_dollar_recipients = addr && addr->parent
2189     && Ustrcmp(addr->parent->address, "system-filter") == 0;
2190
2191   for (int i = 0; argv[i]; i++)
2192     {
2193     /* Handle special fudge for passing an address list */
2194
2195     if (addr &&
2196         (Ustrcmp(argv[i], "$pipe_addresses") == 0 ||
2197          Ustrcmp(argv[i], "${pipe_addresses}") == 0))
2198       {
2199       int additional;
2200
2201       if (argcount + address_count - 1 > max_args)
2202         {
2203         addr->transport_return = FAIL;
2204         addr->message = string_sprintf("Too many arguments to command \"%s\" "
2205           "in %s", cmd, etext);
2206         return FALSE;
2207         }
2208
2209       additional = address_count - 1;
2210       if (additional > 0)
2211         memmove(argv + i + 1 + additional, argv + i + 1,
2212           (argcount - i)*sizeof(uschar *));
2213
2214       for (address_item * ad = addr; ad; ad = ad->next)
2215         {
2216         /* $pipe_addresses is spefically not checked for taint, because there is
2217         a testcase (321) depending on it.  It's unclear if the exact thing being
2218         done really needs to be legitimate, though I suspect it reflects an
2219         actual use-case that showed up a bug.
2220         This is a hole in the taint-pretection, mitigated only in that
2221         shell-syntax metachars cannot be injected via this route. */
2222
2223         DEBUG(D_transport) if (is_tainted(ad->address))
2224           debug_printf("tainted element '%s' from $pipe_addresses\n", ad->address);
2225
2226         argv[i++] = ad->address;
2227         argcount++;
2228         }
2229
2230       /* Subtract one since we replace $pipe_addresses */
2231       argcount--;
2232       i--;
2233       }
2234
2235       /* Handle special case of $address_pipe when af_force_command is set */
2236
2237     else if (addr && testflag(addr,af_force_command) &&
2238         (Ustrcmp(argv[i], "$address_pipe") == 0 ||
2239          Ustrcmp(argv[i], "${address_pipe}") == 0))
2240       {
2241       int address_pipe_argcount = 0;
2242       int address_pipe_max_args;
2243       uschar **address_pipe_argv;
2244
2245       /* We can never have more then the argv we will be loading into */
2246       address_pipe_max_args = max_args - argcount + 1;
2247
2248       DEBUG(D_transport)
2249         debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args);
2250
2251       /* We allocate an additional for (uschar *)0 */
2252       address_pipe_argv = store_get((address_pipe_max_args+1)*sizeof(uschar *), GET_UNTAINTED);
2253
2254       /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2255       s = expand_string(addr->local_part + 1);
2256
2257       if (!s || !*s)
2258         {
2259         addr->transport_return = FAIL;
2260         addr->message = string_sprintf("Expansion of \"%s\" "
2261            "from command \"%s\" in %s failed: %s",
2262            (addr->local_part + 1), cmd, etext, expand_string_message);
2263         return FALSE;
2264         }
2265
2266       Uskip_whitespace(&s);                     /* strip leading space */
2267
2268       while (*s && address_pipe_argcount < address_pipe_max_args)
2269         {
2270         if (*s == '\'')
2271           {
2272           int n = Ustrcspn(++s, "'");
2273           argv[argcount] = string_copyn(s, n);
2274           if (*(s += n) == '\'') s++;
2275           }
2276         else
2277           address_pipe_argv[address_pipe_argcount++] = string_dequote(CUSS &s);
2278         Uskip_whitespace(&s);                   /* strip space after arg */
2279         }
2280
2281       address_pipe_argv[address_pipe_argcount] = NULL;
2282
2283       /* If *s != 0 we have run out of argument slots. */
2284       if (*s)
2285         {
2286         uschar *msg = string_sprintf("Too many arguments in $address_pipe "
2287           "\"%s\" in %s", addr->local_part + 1, etext);
2288         if (addr)
2289           {
2290           addr->transport_return = FAIL;
2291           addr->message = msg;
2292           }
2293         else *errptr = msg;
2294         return FALSE;
2295         }
2296
2297       /* address_pipe_argcount - 1
2298       because we are replacing $address_pipe in the argument list
2299       with the first thing it expands to */
2300
2301       if (argcount + address_pipe_argcount - 1 > max_args)
2302         {
2303         addr->transport_return = FAIL;
2304         addr->message = string_sprintf("Too many arguments to command "
2305           "\"%s\" after expanding $address_pipe in %s", cmd, etext);
2306         return FALSE;
2307         }
2308
2309       /* If we are not just able to replace the slot that contained
2310       $address_pipe (address_pipe_argcount == 1)
2311       We have to move the existing argv by address_pipe_argcount - 1
2312       Visually if address_pipe_argcount == 2:
2313       [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2314       [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0] */
2315
2316       if (address_pipe_argcount > 1)
2317         memmove(
2318           /* current position + additional args */
2319           argv + i + address_pipe_argcount,
2320           /* current position + 1 (for the (uschar *)0 at the end) */
2321           argv + i + 1,
2322           /* -1 for the (uschar *)0 at the end)*/
2323           (argcount - i)*sizeof(uschar *)
2324         );
2325
2326       /* Now we fill in the slots we just moved argv out of
2327       [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0] */
2328
2329       for (int address_pipe_i = 0;
2330            address_pipe_argv[address_pipe_i];
2331            address_pipe_i++, argcount++)
2332         {
2333         uschar * s = address_pipe_argv[address_pipe_i];
2334         if (arg_is_tainted(s, i, addr, etext, errptr)) return FALSE;
2335         argv[i++] = s;
2336         }
2337
2338       /* Subtract one since we replace $address_pipe */
2339       argcount--;
2340       i--;
2341       }
2342
2343     /* Handle normal expansion string */
2344
2345     else
2346       {
2347       const uschar *expanded_arg;
2348       BOOL enable_dollar_recipients_g = f.enable_dollar_recipients;
2349       f.enable_dollar_recipients = allow_dollar_recipients;
2350       expanded_arg = expand_cstring(argv[i]);
2351       f.enable_dollar_recipients = enable_dollar_recipients_g;
2352
2353       if (!expanded_arg)
2354         {
2355         uschar *msg = string_sprintf("Expansion of \"%s\" "
2356           "from command \"%s\" in %s failed: %s",
2357           argv[i], cmd, etext, expand_string_message);
2358         if (addr)
2359           {
2360           addr->transport_return = expand_failed;
2361           addr->message = msg;
2362           }
2363         else *errptr = msg;
2364         return FALSE;
2365         }
2366
2367       if ( f.running_in_test_harness && is_tainted(expanded_arg)
2368          && Ustrcmp(etext, "queryprogram router") == 0)
2369         {                       /* hack, would be good to not need it */
2370         DEBUG(D_transport)
2371           debug_printf("SPECIFIC TESTSUITE EXEMPTION: tainted arg '%s'\n",
2372                       expanded_arg);
2373         }
2374       else if (  !allow_tainted_args
2375               && arg_is_tainted(expanded_arg, i, addr, etext, errptr))
2376         return FALSE;
2377       argv[i] = expanded_arg;
2378       }
2379     }
2380
2381   DEBUG(D_transport)
2382     {
2383     debug_printf("direct command after expansion:\n");
2384     for (int i = 0; argv[i]; i++)
2385       {
2386       debug_printf("  argv[%d] = '%s'\n", i, string_printing(argv[i]));
2387       debug_print_taint(argv[i]);
2388       }
2389     }
2390   }
2391
2392 return TRUE;
2393 }
2394
2395
2396
2397 /* For error messages, a string describing the config location associated
2398 with current processing.  NULL if we are not in a transport. */
2399 /* Name only, for now */
2400
2401 uschar *
2402 transport_current_name(void)
2403 {
2404 if (!transport_name) return NULL;
2405 return string_sprintf(" (transport %s, %s %d)", transport_name, driver_srcfile, driver_srcline);
2406 }
2407
2408 #endif  /*!MACRO_PREDEF*/
2409 /* vi: aw ai sw=2
2410 */
2411 /* End of transport.c */