1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
5 /* Copyright (c) University of Cambridge 1995 - 2016 */
6 /* See the file NOTICE for conditions of use and distribution. */
8 /* General functions concerned with transportation, and generic options for all
14 /* Structure for keeping list of addresses that have been added to
15 Envelope-To:, in order to avoid duplication. */
23 /* Static data for write_chunk() */
25 static uschar
*chunk_ptr
; /* chunk pointer */
26 static uschar
*nl_check
; /* string to look for at line start */
27 static int nl_check_length
; /* length of same */
28 static uschar
*nl_escape
; /* string to insert */
29 static int nl_escape_length
; /* length of same */
30 static int nl_partial_match
; /* length matched at chunk end */
33 /* Generic options for transports, all of which live inside transport_instance
34 data blocks and which therefore have the opt_public flag set. Note that there
35 are other options living inside this structure which can be set only from
36 certain transports. */
38 optionlist optionlist_transports
[] = {
39 { "*expand_group", opt_stringptr
|opt_hidden
|opt_public
,
40 (void *)offsetof(transport_instance
, expand_gid
) },
41 { "*expand_user", opt_stringptr
|opt_hidden
|opt_public
,
42 (void *)offsetof(transport_instance
, expand_uid
) },
43 { "*headers_rewrite_flags", opt_int
|opt_public
|opt_hidden
,
44 (void *)offsetof(transport_instance
, rewrite_existflags
) },
45 { "*headers_rewrite_rules", opt_void
|opt_public
|opt_hidden
,
46 (void *)offsetof(transport_instance
, rewrite_rules
) },
47 { "*set_group", opt_bool
|opt_hidden
|opt_public
,
48 (void *)offsetof(transport_instance
, gid_set
) },
49 { "*set_user", opt_bool
|opt_hidden
|opt_public
,
50 (void *)offsetof(transport_instance
, uid_set
) },
51 { "body_only", opt_bool
|opt_public
,
52 (void *)offsetof(transport_instance
, body_only
) },
53 { "current_directory", opt_stringptr
|opt_public
,
54 (void *)offsetof(transport_instance
, current_dir
) },
55 { "debug_print", opt_stringptr
| opt_public
,
56 (void *)offsetof(transport_instance
, debug_string
) },
57 { "delivery_date_add", opt_bool
|opt_public
,
58 (void *)(offsetof(transport_instance
, delivery_date_add
)) },
59 { "disable_logging", opt_bool
|opt_public
,
60 (void *)(offsetof(transport_instance
, disable_logging
)) },
61 { "driver", opt_stringptr
|opt_public
,
62 (void *)offsetof(transport_instance
, driver_name
) },
63 { "envelope_to_add", opt_bool
|opt_public
,
64 (void *)(offsetof(transport_instance
, envelope_to_add
)) },
66 { "event_action", opt_stringptr
| opt_public
,
67 (void *)offsetof(transport_instance
, event_action
) },
69 { "group", opt_expand_gid
|opt_public
,
70 (void *)offsetof(transport_instance
, gid
) },
71 { "headers_add", opt_stringptr
|opt_public
|opt_rep_str
,
72 (void *)offsetof(transport_instance
, add_headers
) },
73 { "headers_only", opt_bool
|opt_public
,
74 (void *)offsetof(transport_instance
, headers_only
) },
75 { "headers_remove", opt_stringptr
|opt_public
|opt_rep_str
,
76 (void *)offsetof(transport_instance
, remove_headers
) },
77 { "headers_rewrite", opt_rewrite
|opt_public
,
78 (void *)offsetof(transport_instance
, headers_rewrite
) },
79 { "home_directory", opt_stringptr
|opt_public
,
80 (void *)offsetof(transport_instance
, home_dir
) },
81 { "initgroups", opt_bool
|opt_public
,
82 (void *)offsetof(transport_instance
, initgroups
) },
83 { "max_parallel", opt_stringptr
|opt_public
,
84 (void *)offsetof(transport_instance
, max_parallel
) },
85 { "message_size_limit", opt_stringptr
|opt_public
,
86 (void *)offsetof(transport_instance
, message_size_limit
) },
87 { "rcpt_include_affixes", opt_bool
|opt_public
,
88 (void *)offsetof(transport_instance
, rcpt_include_affixes
) },
89 { "retry_use_local_part", opt_bool
|opt_public
,
90 (void *)offsetof(transport_instance
, retry_use_local_part
) },
91 { "return_path", opt_stringptr
|opt_public
,
92 (void *)(offsetof(transport_instance
, return_path
)) },
93 { "return_path_add", opt_bool
|opt_public
,
94 (void *)(offsetof(transport_instance
, return_path_add
)) },
95 { "shadow_condition", opt_stringptr
|opt_public
,
96 (void *)offsetof(transport_instance
, shadow_condition
) },
97 { "shadow_transport", opt_stringptr
|opt_public
,
98 (void *)offsetof(transport_instance
, shadow
) },
99 { "transport_filter", opt_stringptr
|opt_public
,
100 (void *)offsetof(transport_instance
, filter_command
) },
101 { "transport_filter_timeout", opt_time
|opt_public
,
102 (void *)offsetof(transport_instance
, filter_timeout
) },
103 { "user", opt_expand_uid
|opt_public
,
104 (void *)offsetof(transport_instance
, uid
) }
107 int optionlist_transports_size
= nelem(optionlist_transports
);
111 readconf_options_transports(void)
113 struct transport_info
* ti
;
115 readconf_options_from_list(optionlist_transports
, nelem(optionlist_transports
), US
"TRANSPORTS", NULL
);
117 for (ti
= transports_available
; ti
->driver_name
[0]; ti
++)
119 macro_create(string_sprintf("_DRIVER_TRANSPORT_%T", ti
->driver_name
), US
"y", FALSE
, TRUE
);
120 readconf_options_from_list(ti
->options
, (unsigned)*ti
->options_count
, US
"TRANSPORT", ti
->driver_name
);
124 /*************************************************
125 * Initialize transport list *
126 *************************************************/
128 /* Read the transports section of the configuration file, and set up a chain of
129 transport instances according to its contents. Each transport has generic
130 options and may also have its own private options. This function is only ever
131 called when transports == NULL. We use generic code in readconf to do most of
137 transport_instance
*t
;
139 readconf_driver_init(US
"transport",
140 (driver_instance
**)(&transports
), /* chain anchor */
141 (driver_info
*)transports_available
, /* available drivers */
142 sizeof(transport_info
), /* size of info block */
143 &transport_defaults
, /* default values for generic options */
144 sizeof(transport_instance
), /* size of instance block */
145 optionlist_transports
, /* generic options */
146 optionlist_transports_size
);
148 /* Now scan the configured transports and check inconsistencies. A shadow
149 transport is permitted only for local transports. */
151 for (t
= transports
; t
; t
= t
->next
)
153 if (!t
->info
->local
&& t
->shadow
)
154 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
155 "shadow transport not allowed on non-local transport %s", t
->name
);
157 if (t
->body_only
&& t
->headers_only
)
158 log_write(0, LOG_PANIC_DIE
|LOG_CONFIG
,
159 "%s transport: body_only and headers_only are mutually exclusive",
166 /*************************************************
167 * Write block of data *
168 *************************************************/
170 /* Subroutine called by write_chunk() and at the end of the message actually
171 to write a data block. Also called directly by some transports to write
172 additional data to the file descriptor (e.g. prefix, suffix).
174 If a transport wants data transfers to be timed, it sets a non-zero value in
175 transport_write_timeout. A non-zero transport_write_timeout causes a timer to
176 be set for each block of data written from here. If time runs out, then write()
177 fails and provokes an error return. The caller can then inspect sigalrm_seen to
180 On some systems, if a quota is exceeded during the write, the yield is the
181 number of bytes written rather than an immediate error code. This also happens
182 on some systems in other cases, for example a pipe that goes away because the
183 other end's process terminates (Linux). On other systems, (e.g. Solaris 2) you
184 get the error codes the first time.
186 The write() function is also interruptible; the Solaris 2.6 man page says:
188 If write() is interrupted by a signal before it writes any
189 data, it will return -1 with errno set to EINTR.
191 If write() is interrupted by a signal after it successfully
192 writes some data, it will return the number of bytes written.
194 To handle these cases, we want to restart the write() to output the remainder
195 of the data after a non-negative return from write(), except after a timeout.
196 In the error cases (EDQUOT, EPIPE) no bytes get written the second time, and a
197 proper error then occurs. In principle, after an interruption, the second
198 write() could suffer the same fate, but we do not want to continue for
199 evermore, so stick a maximum repetition count on the loop to act as a
203 tctx transport context: file descriptor or string to write to
204 block block of bytes to write
205 len number of bytes to write
206 more further data expected soon
208 Returns: TRUE on success, FALSE on failure (with errno preserved);
209 transport_count is incremented by the number of bytes written
213 transport_write_block_fd(transport_ctx
* tctx
, uschar
*block
, int len
, BOOL more
)
215 int i
, rc
, save_errno
;
216 int local_timeout
= transport_write_timeout
;
219 /* This loop is for handling incomplete writes and other retries. In most
220 normal cases, it is only ever executed once. */
222 for (i
= 0; i
< 100; i
++)
225 debug_printf("writing data block fd=%d size=%d timeout=%d%s\n",
226 fd
, len
, local_timeout
, more
? " (more expected)" : "");
228 /* This code makes use of alarm() in order to implement the timeout. This
229 isn't a very tidy way of doing things. Using non-blocking I/O with select()
230 provides a neater approach. However, I don't know how to do this when TLS is
233 if (transport_write_timeout
<= 0) /* No timeout wanted */
237 tls_out
.active
== fd
? tls_write(FALSE
, block
, len
, more
) :
240 more
? send(fd
, block
, len
, MSG_MORE
) :
242 write(fd
, block
, len
);
246 /* Timeout wanted. */
250 alarm(local_timeout
);
254 tls_out
.active
== fd
? tls_write(FALSE
, block
, len
, more
) :
257 more
? send(fd
, block
, len
, MSG_MORE
) :
259 write(fd
, block
, len
);
262 local_timeout
= alarm(0);
270 /* Hopefully, the most common case is success, so test that first. */
272 if (rc
== len
) { transport_count
+= len
; return TRUE
; }
274 /* A non-negative return code is an incomplete write. Try again for the rest
275 of the block. If we have exactly hit the timeout, give up. */
281 transport_count
+= rc
;
282 DEBUG(D_transport
) debug_printf("write incomplete (%d)\n", rc
);
283 goto CHECK_TIMEOUT
; /* A few lines below */
286 /* A negative return code with an EINTR error is another form of
287 incomplete write, zero bytes having been written */
289 if (save_errno
== EINTR
)
292 debug_printf("write interrupted before anything written\n");
293 goto CHECK_TIMEOUT
; /* A few lines below */
296 /* A response of EAGAIN from write() is likely only in the case of writing
297 to a FIFO that is not swallowing the data as fast as Exim is writing it. */
299 if (save_errno
== EAGAIN
)
302 debug_printf("write temporarily locked out, waiting 1 sec\n");
305 /* Before continuing to try another write, check that we haven't run out of
309 if (transport_write_timeout
> 0 && local_timeout
<= 0)
317 /* Otherwise there's been an error */
319 DEBUG(D_transport
) debug_printf("writing error %d: %s\n", save_errno
,
320 strerror(save_errno
));
325 /* We've tried and tried and tried but still failed */
327 errno
= ERRNO_WRITEINCOMPLETE
;
333 transport_write_block(transport_ctx
* tctx
, uschar
*block
, int len
, BOOL more
)
335 if (!(tctx
->options
& topt_output_string
))
336 return transport_write_block_fd(tctx
, block
, len
, more
);
338 /* Write to expanding-string. NOTE: not NUL-terminated */
342 tctx
->u
.msg
= store_get(tctx
->msg_size
= 1024);
346 tctx
->u
.msg
= string_catn(tctx
->u
.msg
, &tctx
->msg_size
, &tctx
->msg_ptr
, block
, len
);
353 /*************************************************
354 * Write formatted string *
355 *************************************************/
357 /* This is called by various transports. It is a convenience function.
362 ... arguments for format
364 Returns: the yield of transport_write_block()
368 transport_write_string(int fd
, const char *format
, ...)
370 transport_ctx tctx
= {0};
372 va_start(ap
, format
);
373 if (!string_vformat(big_buffer
, big_buffer_size
, format
, ap
))
374 log_write(0, LOG_MAIN
|LOG_PANIC_DIE
, "overlong formatted string in transport");
377 return transport_write_block(&tctx
, big_buffer
, Ustrlen(big_buffer
), FALSE
);
384 transport_write_reset(int options
)
386 if (!(options
& topt_continuation
)) chunk_ptr
= deliver_out_buffer
;
387 nl_partial_match
= -1;
388 nl_check_length
= nl_escape_length
= 0;
393 /*************************************************
394 * Write character chunk *
395 *************************************************/
397 /* Subroutine used by transport_write_message() to scan character chunks for
398 newlines and act appropriately. The object is to minimise the number of writes.
399 The output byte stream is buffered up in deliver_out_buffer, which is written
400 only when it gets full, thus minimizing write operations and TCP packets.
402 Static data is used to handle the case when the last character of the previous
403 chunk was NL, or matched part of the data that has to be escaped.
406 tctx transport context - processing to be done during output,
407 and file descriptor to write to
408 chunk pointer to data to write
409 len length of data to write
411 In addition, the static nl_xxx variables must be set as required.
413 Returns: TRUE on success, FALSE on failure (with errno preserved)
417 write_chunk(transport_ctx
* tctx
, uschar
*chunk
, int len
)
419 uschar
*start
= chunk
;
420 uschar
*end
= chunk
+ len
;
422 int mlen
= DELIVER_OUT_BUFFER_SIZE
- nl_escape_length
- 2;
424 /* The assumption is made that the check string will never stretch over move
425 than one chunk since the only time there are partial matches is when copying
426 the body in large buffers. There is always enough room in the buffer for an
427 escape string, since the loop below ensures this for each character it
428 processes, and it won't have stuck in the escape string if it left a partial
431 if (nl_partial_match
>= 0)
433 if (nl_check_length
> 0 && len
>= nl_check_length
&&
434 Ustrncmp(start
, nl_check
+ nl_partial_match
,
435 nl_check_length
- nl_partial_match
) == 0)
437 Ustrncpy(chunk_ptr
, nl_escape
, nl_escape_length
);
438 chunk_ptr
+= nl_escape_length
;
439 start
+= nl_check_length
- nl_partial_match
;
442 /* The partial match was a false one. Insert the characters carried over
443 from the previous chunk. */
445 else if (nl_partial_match
> 0)
447 Ustrncpy(chunk_ptr
, nl_check
, nl_partial_match
);
448 chunk_ptr
+= nl_partial_match
;
451 nl_partial_match
= -1;
454 /* Now process the characters in the chunk. Whenever we hit a newline we check
455 for possible escaping. The code for the non-NL route should be as fast as
458 for (ptr
= start
; ptr
< end
; ptr
++)
462 /* Flush the buffer if it has reached the threshold - we want to leave enough
463 room for the next uschar, plus a possible extra CR for an LF, plus the escape
466 if ((len
= chunk_ptr
- deliver_out_buffer
) > mlen
)
468 DEBUG(D_transport
) debug_printf("flushing headers buffer\n");
470 /* If CHUNKING, prefix with BDAT (size) NON-LAST. Also, reap responses
471 from previous SMTP commands. */
473 if (tctx
->options
& topt_use_bdat
&& tctx
->chunk_cb
)
475 if ( tctx
->chunk_cb(tctx
, (unsigned)len
, 0) != OK
476 || !transport_write_block(tctx
, deliver_out_buffer
, len
, FALSE
)
477 || tctx
->chunk_cb(tctx
, 0, tc_reap_prev
) != OK
482 if (!transport_write_block(tctx
, deliver_out_buffer
, len
, FALSE
))
484 chunk_ptr
= deliver_out_buffer
;
487 /* Remove CR before NL if required */
489 if ( *ptr
== '\r' && ptr
[1] == '\n'
490 && !(tctx
->options
& topt_use_crlf
)
491 && spool_file_wireformat
495 if ((ch
= *ptr
) == '\n')
497 int left
= end
- ptr
- 1; /* count of chars left after NL */
499 /* Insert CR before NL if required */
501 if (tctx
->options
& topt_use_crlf
&& !spool_file_wireformat
)
504 transport_newlines
++;
506 /* The check_string test (formerly "from hack") replaces the specific
507 string at the start of a line with an escape string (e.g. "From " becomes
508 ">From " or "." becomes "..". It is a case-sensitive test. The length
509 check above ensures there is always enough room to insert this string. */
511 if (nl_check_length
> 0)
513 if (left
>= nl_check_length
&&
514 Ustrncmp(ptr
+1, nl_check
, nl_check_length
) == 0)
516 Ustrncpy(chunk_ptr
, nl_escape
, nl_escape_length
);
517 chunk_ptr
+= nl_escape_length
;
518 ptr
+= nl_check_length
;
521 /* Handle the case when there isn't enough left to match the whole
522 check string, but there may be a partial match. We remember how many
523 characters matched, and finish processing this chunk. */
525 else if (left
<= 0) nl_partial_match
= 0;
527 else if (Ustrncmp(ptr
+1, nl_check
, left
) == 0)
529 nl_partial_match
= left
;
535 /* Not a NL character */
537 else *chunk_ptr
++ = ch
;
546 /*************************************************
547 * Generate address for RCPT TO *
548 *************************************************/
550 /* This function puts together an address for RCPT to, using the caseful
551 version of the local part and the caseful version of the domain. If there is no
552 prefix or suffix, or if affixes are to be retained, we can just use the
553 original address. Otherwise, if there is a prefix but no suffix we can use a
554 pointer into the original address. If there is a suffix, however, we have to
558 addr the address item
559 include_affixes TRUE if affixes are to be included
565 transport_rcpt_address(address_item
*addr
, BOOL include_affixes
)
572 setflag(addr
, af_include_affixes
); /* Affects logged => line */
573 return addr
->address
;
576 if (addr
->suffix
== NULL
)
578 if (addr
->prefix
== NULL
) return addr
->address
;
579 return addr
->address
+ Ustrlen(addr
->prefix
);
582 at
= Ustrrchr(addr
->address
, '@');
583 plen
= (addr
->prefix
== NULL
)? 0 : Ustrlen(addr
->prefix
);
584 slen
= Ustrlen(addr
->suffix
);
586 return string_sprintf("%.*s@%s", (at
- addr
->address
- plen
- slen
),
587 addr
->address
+ plen
, at
+ 1);
591 /*************************************************
592 * Output Envelope-To: address & scan duplicates *
593 *************************************************/
595 /* This function is called from internal_transport_write_message() below, when
596 generating an Envelope-To: header line. It checks for duplicates of the given
597 address and its ancestors. When one is found, this function calls itself
598 recursively, to output the envelope address of the duplicate.
600 We want to avoid duplication in the list, which can arise for example when
601 A->B,C and then both B and C alias to D. This can also happen when there are
602 unseen drivers in use. So a list of addresses that have been output is kept in
605 It is also possible to have loops in the address ancestry/duplication graph,
606 for example if there are two top level addresses A and B and we have A->B,C and
607 B->A. To break the loop, we use a list of processed addresses in the dlist
610 After handling duplication, this function outputs the progenitor of the given
614 p the address we are interested in
615 pplist address of anchor of the list of addresses not to output
616 pdlist address of anchor of the list of processed addresses
617 first TRUE if this is the first address; set it FALSE afterwards
618 tctx transport context - processing to be done during output
619 and the file descriptor to write to
621 Returns: FALSE if writing failed
625 write_env_to(address_item
*p
, struct aci
**pplist
, struct aci
**pdlist
,
626 BOOL
*first
, transport_ctx
* tctx
)
631 /* Do nothing if we have already handled this address. If not, remember it
632 so that we don't handle it again. */
634 for (ppp
= *pdlist
; ppp
; ppp
= ppp
->next
) if (p
== ppp
->ptr
) return TRUE
;
636 ppp
= store_get(sizeof(struct aci
));
641 /* Now scan up the ancestry, checking for duplicates at each generation. */
643 for (pp
= p
;; pp
= pp
->parent
)
646 for (dup
= addr_duplicate
; dup
; dup
= dup
->next
)
647 if (dup
->dupof
== pp
) /* a dup of our address */
648 if (!write_env_to(dup
, pplist
, pdlist
, first
, tctx
))
650 if (!pp
->parent
) break;
653 /* Check to see if we have already output the progenitor. */
655 for (ppp
= *pplist
; ppp
; ppp
= ppp
->next
) if (pp
== ppp
->ptr
) break;
656 if (ppp
) return TRUE
;
658 /* Remember what we have output, and output it. */
660 ppp
= store_get(sizeof(struct aci
));
665 if (!*first
&& !write_chunk(tctx
, US
",\n ", 3)) return FALSE
;
667 return write_chunk(tctx
, pp
->address
, Ustrlen(pp
->address
));
673 /* Add/remove/rewrite headers, and send them plus the empty-line separator.
679 addr (chain of) addresses (for extra headers), or NULL;
680 only the first address is used
681 tctx transport context
682 sendfn function for output (transport or verify)
684 Returns: TRUE on success; FALSE on failure.
687 transport_headers_send(transport_ctx
* tctx
,
688 BOOL (*sendfn
)(transport_ctx
* tctx
, uschar
* s
, int len
))
692 transport_instance
* tblock
= tctx
? tctx
->tblock
: NULL
;
693 address_item
* addr
= tctx
? tctx
->addr
: NULL
;
695 /* Then the message's headers. Don't write any that are flagged as "old";
696 that means they were rewritten, or are a record of envelope rewriting, or
697 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
698 match any entries therein. It is a colon-sep list; expand the items
699 separately and squash any empty ones.
700 Then check addr->prop.remove_headers too, provided that addr is not NULL. */
702 for (h
= header_list
; h
; h
= h
->next
) if (h
->type
!= htype_old
)
705 BOOL include_header
= TRUE
;
707 list
= tblock
? tblock
->remove_headers
: NULL
;
708 for (i
= 0; i
< 2; i
++) /* For remove_headers && addr->prop.remove_headers */
712 int sep
= ':'; /* This is specified as a colon-separated list */
714 while ((s
= string_nextinlist(&list
, &sep
, NULL
, 0)))
719 if (!(s
= expand_string(s
)) && !expand_string_forcedfail
)
721 errno
= ERRNO_CHHEADER_FAIL
;
724 len
= s
? Ustrlen(s
) : 0;
725 if (strncmpic(h
->text
, s
, len
) != 0) continue;
727 while (*ss
== ' ' || *ss
== '\t') ss
++;
728 if (*ss
== ':') break;
730 if (s
) { include_header
= FALSE
; break; }
732 if (addr
) list
= addr
->prop
.remove_headers
;
735 /* If this header is to be output, try to rewrite it if there are rewriting
740 if (tblock
&& tblock
->rewrite_rules
)
742 void *reset_point
= store_get(0);
745 if ((hh
= rewrite_header(h
, NULL
, NULL
, tblock
->rewrite_rules
,
746 tblock
->rewrite_existflags
, FALSE
)))
748 if (!sendfn(tctx
, hh
->text
, hh
->slen
)) return FALSE
;
749 store_reset(reset_point
);
750 continue; /* With the next header line */
754 /* Either no rewriting rules, or it didn't get rewritten */
756 if (!sendfn(tctx
, h
->text
, h
->slen
)) return FALSE
;
762 DEBUG(D_transport
) debug_printf("removed header line:\n%s---\n", h
->text
);
765 /* Add on any address-specific headers. If there are multiple addresses,
766 they will all have the same headers in order to be batched. The headers
767 are chained in reverse order of adding (so several addresses from the
768 same alias might share some of them) but we want to output them in the
769 opposite order. This is a bit tedious, but there shouldn't be very many
770 of them. We just walk the list twice, reversing the pointers each time,
771 but on the second time, write out the items.
773 Headers added to an address by a router are guaranteed to end with a newline.
779 header_line
*hprev
= addr
->prop
.extra_headers
;
781 for (i
= 0; i
< 2; i
++)
782 for (h
= hprev
, hprev
= NULL
; h
; h
= hnext
)
789 if (!sendfn(tctx
, h
->text
, h
->slen
)) return FALSE
;
791 debug_printf("added header line(s):\n%s---\n", h
->text
);
796 /* If a string containing additional headers exists it is a newline-sep
797 list. Expand each item and write out the result. This is done last so that
798 if it (deliberately or accidentally) isn't in header format, it won't mess
799 up any other headers. An empty string or a forced expansion failure are
800 noops. An added header string from a transport may not end with a newline;
801 add one if it does not. */
803 if (tblock
&& (list
= CUS tblock
->add_headers
))
808 while ((s
= string_nextinlist(&list
, &sep
, NULL
, 0)))
809 if ((s
= expand_string(s
)))
811 int len
= Ustrlen(s
);
814 if (!sendfn(tctx
, s
, len
)) return FALSE
;
815 if (s
[len
-1] != '\n' && !sendfn(tctx
, US
"\n", 1))
819 debug_printf("added header line:\n%s", s
);
820 if (s
[len
-1] != '\n') debug_printf("\n");
821 debug_printf("---\n");
825 else if (!expand_string_forcedfail
)
826 { errno
= ERRNO_CHHEADER_FAIL
; return FALSE
; }
829 /* Separate headers from body with a blank line */
831 return sendfn(tctx
, US
"\n", 1);
835 /*************************************************
836 * Write the message *
837 *************************************************/
839 /* This function writes the message to the given file descriptor. The headers
840 are in the in-store data structure, and the rest of the message is in the open
841 file descriptor deliver_datafile. Make sure we start it at the beginning.
843 . If add_return_path is TRUE, a "return-path:" header is added to the message,
844 containing the envelope sender's address.
846 . If add_envelope_to is TRUE, a "envelope-to:" header is added to the message,
847 giving the top-level envelope address that caused this delivery to happen.
849 . If add_delivery_date is TRUE, a "delivery-date:" header is added to the
850 message. It gives the time and date that delivery took place.
852 . If check_string is not null, the start of each line is checked for that
853 string. If it is found, it is replaced by escape_string. This used to be
854 the "from hack" for files, and "smtp_dots" for escaping SMTP dots.
856 . If use_crlf is true, newlines are turned into CRLF (SMTP output).
858 The yield is TRUE if all went well, and FALSE if not. Exit *immediately* after
859 any writing or reading error, leaving the code in errno intact. Error exits
860 can include timeouts for certain transports, which are requested by setting
861 transport_write_timeout non-zero.
865 (fd, msg) Either and fd, to write the message to,
866 or a string: if null write message to allocated space
867 otherwire take content as headers.
868 addr (chain of) addresses (for extra headers), or NULL;
869 only the first address is used
870 tblock optional transport instance block (NULL signifies NULL/0):
871 add_headers a string containing one or more headers to add; it is
872 expanded, and must be in correct RFC 822 format as
873 it is transmitted verbatim; NULL => no additions,
874 and so does empty string or forced expansion fail
875 remove_headers a colon-separated list of headers to remove, or NULL
876 rewrite_rules chain of header rewriting rules
877 rewrite_existflags flags for the rewriting rules
878 options bit-wise options:
879 add_return_path if TRUE, add a "return-path" header
880 add_envelope_to if TRUE, add a "envelope-to" header
881 add_delivery_date if TRUE, add a "delivery-date" header
882 use_crlf if TRUE, turn NL into CR LF
883 end_dot if TRUE, send a terminating "." line at the end
884 no_headers if TRUE, omit the headers
885 no_body if TRUE, omit the body
886 check_string a string to check for at the start of lines, or NULL
887 escape_string a string to insert in front of any check string
888 size_limit if > 0, this is a limit to the size of message written;
889 it is used when returning messages to their senders,
890 and is approximate rather than exact, owing to chunk
893 Returns: TRUE on success; FALSE (with errno) on failure.
894 In addition, the global variable transport_count
895 is incremented by the number of bytes written.
899 internal_transport_write_message(transport_ctx
* tctx
, int size_limit
)
903 /* Initialize pointer in output buffer. */
905 transport_write_reset(tctx
->options
);
907 /* Set up the data for start-of-line data checking and escaping */
909 if (tctx
->check_string
&& tctx
->escape_string
)
911 nl_check
= tctx
->check_string
;
912 nl_check_length
= Ustrlen(nl_check
);
913 nl_escape
= tctx
->escape_string
;
914 nl_escape_length
= Ustrlen(nl_escape
);
917 /* Whether the escaping mechanism is applied to headers or not is controlled by
918 an option (set for SMTP, not otherwise). Negate the length if not wanted till
919 after the headers. */
921 if (!(tctx
->options
& topt_escape_headers
))
922 nl_check_length
= -nl_check_length
;
924 /* Write the headers if required, including any that have to be added. If there
925 are header rewriting rules, apply them. The datasource is not the -D spoolfile
926 so temporarily hide the global that adjusts for its format. */
928 if (!(tctx
->options
& topt_no_headers
))
930 BOOL save_wireformat
= spool_file_wireformat
;
931 spool_file_wireformat
= FALSE
;
933 /* Add return-path: if requested. */
935 if (tctx
->options
& topt_add_return_path
)
937 uschar buffer
[ADDRESS_MAXLENGTH
+ 20];
938 int n
= sprintf(CS buffer
, "Return-path: <%.*s>\n", ADDRESS_MAXLENGTH
,
940 if (!write_chunk(tctx
, buffer
, n
)) goto bad
;
943 /* Add envelope-to: if requested */
945 if (tctx
->options
& topt_add_envelope_to
)
949 struct aci
*plist
= NULL
;
950 struct aci
*dlist
= NULL
;
951 void *reset_point
= store_get(0);
953 if (!write_chunk(tctx
, US
"Envelope-to: ", 13)) goto bad
;
955 /* Pick up from all the addresses. The plist and dlist variables are
956 anchors for lists of addresses already handled; they have to be defined at
957 this level because write_env_to() calls itself recursively. */
959 for (p
= tctx
->addr
; p
; p
= p
->next
)
960 if (!write_env_to(p
, &plist
, &dlist
, &first
, tctx
)) goto bad
;
962 /* Add a final newline and reset the store used for tracking duplicates */
964 if (!write_chunk(tctx
, US
"\n", 1)) goto bad
;
965 store_reset(reset_point
);
968 /* Add delivery-date: if requested. */
970 if (tctx
->options
& topt_add_delivery_date
)
973 int n
= sprintf(CS buffer
, "Delivery-date: %s\n", tod_stamp(tod_full
));
974 if (!write_chunk(tctx
, buffer
, n
)) goto bad
;
977 /* Then the message's headers. Don't write any that are flagged as "old";
978 that means they were rewritten, or are a record of envelope rewriting, or
979 were removed (e.g. Bcc). If remove_headers is not null, skip any headers that
980 match any entries therein. Then check addr->prop.remove_headers too, provided that
983 if (!transport_headers_send(tctx
, &write_chunk
))
986 spool_file_wireformat
= save_wireformat
;
990 spool_file_wireformat
= save_wireformat
;
993 /* When doing RFC3030 CHUNKING output, work out how much data would be in a
994 last-BDAT, consisting of the current write_chunk() output buffer fill
995 (optimally, all of the headers - but it does not matter if we already had to
996 flush that buffer with non-last BDAT prependix) plus the amount of body data
997 (as expanded for CRLF lines). Then create and write BDAT(s), and ensure
998 that further use of write_chunk() will not prepend BDATs.
999 The first BDAT written will also first flush any outstanding MAIL and RCPT
1000 commands which were buffered thans to PIPELINING.
1001 Commands go out (using a send()) from a different buffer to data (using a
1002 write()). They might not end up in the same TCP segment, which is
1005 if (tctx
->options
& topt_use_bdat
)
1010 if ((hsize
= chunk_ptr
- deliver_out_buffer
) < 0)
1012 if (!(tctx
->options
& topt_no_body
))
1014 if ((fsize
= lseek(deliver_datafile
, 0, SEEK_END
)) < 0) return FALSE
;
1015 fsize
-= SPOOL_DATA_START_OFFSET
;
1016 if (size_limit
> 0 && fsize
> size_limit
)
1018 size
= hsize
+ fsize
;
1019 if (tctx
->options
& topt_use_crlf
&& !spool_file_wireformat
)
1020 size
+= body_linecount
; /* account for CRLF-expansion */
1022 /* With topt_use_bdat we never do dot-stuffing; no need to
1023 account for any expansion due to that. */
1026 /* If the message is large, emit first a non-LAST chunk with just the
1027 headers, and reap the command responses. This lets us error out early
1028 on RCPT rejects rather than sending megabytes of data. Include headers
1029 on the assumption they are cheap enough and some clever implementations
1030 might errorcheck them too, on-the-fly, and reject that chunk. */
1032 if (size
> DELIVER_OUT_BUFFER_SIZE
&& hsize
> 0)
1035 debug_printf("sending small initial BDAT; hsize=%d\n", hsize
);
1036 if ( tctx
->chunk_cb(tctx
, hsize
, 0) != OK
1037 || !transport_write_block(tctx
, deliver_out_buffer
, hsize
, FALSE
)
1038 || tctx
->chunk_cb(tctx
, 0, tc_reap_prev
) != OK
1041 chunk_ptr
= deliver_out_buffer
;
1045 /* Emit a LAST datachunk command, and unmark the context for further
1048 if (tctx
->chunk_cb(tctx
, size
, tc_chunk_last
) != OK
)
1050 tctx
->options
&= ~topt_use_bdat
;
1053 /* If the body is required, ensure that the data for check strings (formerly
1054 the "from hack") is enabled by negating the length if necessary. (It will be
1055 negative in cases where it isn't to apply to the headers). Then ensure the body
1056 is positioned at the start of its file (following the message id), then write
1057 it, applying the size limit if required. */
1059 /* If we have a wireformat -D file (CRNL lines, non-dotstuffed, no ending dot)
1060 and we want to send a body without dotstuffing or ending-dot, in-clear,
1061 then we can just dump it using sendfile.
1062 This should get used for CHUNKING output and also for writing the -K file for
1063 dkim signing, when we had CHUNKING input. */
1066 if ( spool_file_wireformat
1067 && !(tctx
->options
& (topt_no_body
| topt_end_dot
))
1069 && tls_out
.active
!= tctx
->u
.fd
1073 off_t offset
= SPOOL_DATA_START_OFFSET
;
1075 /* Write out any header data in the buffer */
1077 if ((len
= chunk_ptr
- deliver_out_buffer
) > 0)
1079 if (!transport_write_block(tctx
, deliver_out_buffer
, len
, TRUE
))
1084 DEBUG(D_transport
) debug_printf("using sendfile for body\n");
1088 if ((copied
= os_sendfile(tctx
->u
.fd
, deliver_datafile
, &offset
, size
)) <= 0) break;
1094 DEBUG(D_transport
) debug_printf("cannot use sendfile for body: no support\n");
1098 if (!(tctx
->options
& topt_no_body
))
1099 debug_printf("cannot use sendfile for body: %s\n",
1100 !spool_file_wireformat
? "spoolfile not wireformat"
1101 : tctx
->options
& topt_end_dot
? "terminating dot wanted"
1102 : nl_check_length
? "dot- or From-stuffing wanted"
1103 : "TLS output wanted");
1105 if (!(tctx
->options
& topt_no_body
))
1107 int size
= size_limit
;
1109 nl_check_length
= abs(nl_check_length
);
1110 nl_partial_match
= 0;
1111 if (lseek(deliver_datafile
, SPOOL_DATA_START_OFFSET
, SEEK_SET
) < 0)
1113 while ( (len
= MAX(DELIVER_IN_BUFFER_SIZE
, size
)) > 0
1114 && (len
= read(deliver_datafile
, deliver_in_buffer
, len
)) > 0)
1116 if (!write_chunk(tctx
, deliver_in_buffer
, len
))
1121 /* A read error on the body will have left len == -1 and errno set. */
1123 if (len
!= 0) return FALSE
;
1126 /* Finished with the check string */
1128 nl_check_length
= nl_escape_length
= 0;
1130 /* If requested, add a terminating "." line (SMTP output). */
1132 if (tctx
->options
& topt_end_dot
&& !write_chunk(tctx
, US
".\n", 2))
1135 /* Write out any remaining data in the buffer before returning. */
1137 return (len
= chunk_ptr
- deliver_out_buffer
) <= 0 ||
1138 transport_write_block(tctx
, deliver_out_buffer
, len
, FALSE
);
1144 /*************************************************
1145 * External interface to write the message *
1146 *************************************************/
1148 /* If there is no filtering required, call the internal function above to do
1149 the real work, passing over all the arguments from this function. Otherwise,
1150 set up a filtering process, fork another process to call the internal function
1151 to write to the filter, and in this process just suck from the filter and write
1152 down the fd in the transport context. At the end, tidy up the pipes and the
1155 Arguments: as for internal_transport_write_message() above
1157 Returns: TRUE on success; FALSE (with errno) for any failure
1158 transport_count is incremented by the number of bytes written
1162 transport_write_message(transport_ctx
* tctx
, int size_limit
)
1164 BOOL last_filter_was_NL
= TRUE
;
1165 BOOL save_spool_file_wireformat
= spool_file_wireformat
;
1166 int rc
, len
, yield
, fd_read
, fd_write
, save_errno
;
1167 int pfd
[2] = {-1, -1};
1168 pid_t filter_pid
, write_pid
;
1169 static transport_ctx dummy_tctx
= {0};
1171 transport_filter_timed_out
= FALSE
;
1173 /* If there is no filter command set up, call the internal function that does
1174 the actual work, passing it the incoming fd, and return its result. */
1176 if ( !transport_filter_argv
1177 || !*transport_filter_argv
1178 || !**transport_filter_argv
1180 return internal_transport_write_message(tctx
, size_limit
);
1182 /* Otherwise the message must be written to a filter process and read back
1183 before being written to the incoming fd. First set up the special processing to
1184 be done during the copying. */
1186 nl_partial_match
= -1;
1188 if (tctx
->check_string
&& tctx
->escape_string
)
1190 nl_check
= tctx
->check_string
;
1191 nl_check_length
= Ustrlen(nl_check
);
1192 nl_escape
= tctx
->escape_string
;
1193 nl_escape_length
= Ustrlen(nl_escape
);
1195 else nl_check_length
= nl_escape_length
= 0;
1197 /* Start up a subprocess to run the command. Ensure that our main fd will
1198 be closed when the subprocess execs, but remove the flag afterwards.
1199 (Otherwise, if this is a TCP/IP socket, it can't get passed on to another
1200 process to deliver another message.) We get back stdin/stdout file descriptors.
1201 If the process creation failed, give an error return. */
1207 write_pid
= (pid_t
)(-1);
1210 int bits
= fcntl(tctx
->u
.fd
, F_GETFD
);
1211 (void)fcntl(tctx
->u
.fd
, F_SETFD
, bits
| FD_CLOEXEC
);
1212 filter_pid
= child_open(USS transport_filter_argv
, NULL
, 077,
1213 &fd_write
, &fd_read
, FALSE
);
1214 (void)fcntl(tctx
->u
.fd
, F_SETFD
, bits
& ~FD_CLOEXEC
);
1216 if (filter_pid
< 0) goto TIDY_UP
; /* errno set */
1219 debug_printf("process %d running as transport filter: fd_write=%d fd_read=%d\n",
1220 (int)filter_pid
, fd_write
, fd_read
);
1222 /* Fork subprocess to write the message to the filter, and return the result
1223 via a(nother) pipe. While writing to the filter, we do not do the CRLF,
1224 smtp dots, or check string processing. */
1226 if (pipe(pfd
) != 0) goto TIDY_UP
; /* errno set */
1227 if ((write_pid
= fork()) == 0)
1230 (void)close(fd_read
);
1231 (void)close(pfd
[pipe_read
]);
1232 nl_check_length
= nl_escape_length
= 0;
1234 tctx
->u
.fd
= fd_write
;
1235 tctx
->check_string
= tctx
->escape_string
= NULL
;
1236 tctx
->options
&= ~(topt_use_crlf
| topt_end_dot
| topt_use_bdat
);
1238 rc
= internal_transport_write_message(tctx
, size_limit
);
1241 if ( write(pfd
[pipe_write
], (void *)&rc
, sizeof(BOOL
))
1243 || write(pfd
[pipe_write
], (void *)&save_errno
, sizeof(int))
1245 || write(pfd
[pipe_write
], (void *)&tctx
->addr
->more_errno
, sizeof(int))
1248 rc
= FALSE
; /* compiler quietening */
1253 /* Parent process: close our copy of the writing subprocess' pipes. */
1255 (void)close(pfd
[pipe_write
]);
1256 (void)close(fd_write
);
1259 /* Writing process creation failed */
1263 errno
= save_errno
; /* restore */
1267 /* When testing, let the subprocess get going */
1269 if (running_in_test_harness
) millisleep(250);
1272 debug_printf("process %d writing to transport filter\n", (int)write_pid
);
1274 /* Copy the message from the filter to the output fd. A read error leaves len
1275 == -1 and errno set. We need to apply a timeout to the read, to cope with
1276 the case when the filter gets stuck, but it can be quite a long one. The
1277 default is 5m, but this is now configurable. */
1279 DEBUG(D_transport
) debug_printf("copying from the filter\n");
1281 /* Copy the output of the filter, remembering if the last character was NL. If
1282 no data is returned, that counts as "ended with NL" (default setting of the
1283 variable is TRUE). The output should always be unix-format as we converted
1284 any wireformat source on writing input to the filter. */
1286 spool_file_wireformat
= FALSE
;
1287 chunk_ptr
= deliver_out_buffer
;
1291 sigalrm_seen
= FALSE
;
1292 alarm(transport_filter_timeout
);
1293 len
= read(fd_read
, deliver_in_buffer
, DELIVER_IN_BUFFER_SIZE
);
1298 transport_filter_timed_out
= TRUE
;
1302 /* If the read was successful, write the block down the original fd,
1303 remembering whether it ends in \n or not. */
1307 if (!write_chunk(tctx
, deliver_in_buffer
, len
)) goto TIDY_UP
;
1308 last_filter_was_NL
= (deliver_in_buffer
[len
-1] == '\n');
1311 /* Otherwise, break the loop. If we have hit EOF, set yield = TRUE. */
1315 if (len
== 0) yield
= TRUE
;
1320 /* Tidying up code. If yield = FALSE there has been an error and errno is set
1321 to something. Ensure the pipes are all closed and the processes are removed. If
1322 there has been an error, kill the processes before waiting for them, just to be
1323 sure. Also apply a paranoia timeout. */
1326 spool_file_wireformat
= save_spool_file_wireformat
;
1329 (void)close(fd_read
);
1330 if (fd_write
> 0) (void)close(fd_write
);
1334 if (filter_pid
> 0) kill(filter_pid
, SIGKILL
);
1335 if (write_pid
> 0) kill(write_pid
, SIGKILL
);
1338 /* Wait for the filter process to complete. */
1340 DEBUG(D_transport
) debug_printf("waiting for filter process\n");
1341 if (filter_pid
> 0 && (rc
= child_close(filter_pid
, 30)) != 0 && yield
)
1344 save_errno
= ERRNO_FILTER_FAIL
;
1345 tctx
->addr
->more_errno
= rc
;
1346 DEBUG(D_transport
) debug_printf("filter process returned %d\n", rc
);
1349 /* Wait for the writing process to complete. If it ends successfully,
1350 read the results from its pipe, provided we haven't already had a filter
1353 DEBUG(D_transport
) debug_printf("waiting for writing process\n");
1356 rc
= child_close(write_pid
, 30);
1361 if (read(pfd
[pipe_read
], (void *)&ok
, sizeof(BOOL
)) != sizeof(BOOL
))
1364 debug_printf("pipe read from writing process: %s\n", strerror(errno
));
1365 save_errno
= ERRNO_FILTER_FAIL
;
1370 int dummy
= read(pfd
[pipe_read
], (void *)&save_errno
, sizeof(int));
1371 dummy
= read(pfd
[pipe_read
], (void *)&(tctx
->addr
->more_errno
), sizeof(int));
1378 save_errno
= ERRNO_FILTER_FAIL
;
1379 tctx
->addr
->more_errno
= rc
;
1380 DEBUG(D_transport
) debug_printf("writing process returned %d\n", rc
);
1383 (void)close(pfd
[pipe_read
]);
1385 /* If there have been no problems we can now add the terminating "." if this is
1386 SMTP output, turning off escaping beforehand. If the last character from the
1387 filter was not NL, insert a NL to make the SMTP protocol work. */
1391 nl_check_length
= nl_escape_length
= 0;
1392 if ( tctx
->options
& topt_end_dot
1393 && ( last_filter_was_NL
1394 ? !write_chunk(tctx
, US
".\n", 2)
1395 : !write_chunk(tctx
, US
"\n.\n", 3)
1399 /* Write out any remaining data in the buffer. */
1402 yield
= (len
= chunk_ptr
- deliver_out_buffer
) <= 0
1403 || transport_write_block(tctx
, deliver_out_buffer
, len
, FALSE
);
1406 errno
= save_errno
; /* From some earlier error */
1410 debug_printf("end of filtering transport writing: yield=%d\n", yield
);
1412 debug_printf("errno=%d more_errno=%d\n", errno
, tctx
->addr
->more_errno
);
1422 /*************************************************
1423 * Update waiting database *
1424 *************************************************/
1426 /* This is called when an address is deferred by remote transports that are
1427 capable of sending more than one message over one connection. A database is
1428 maintained for each transport, keeping track of which messages are waiting for
1429 which hosts. The transport can then consult this when eventually a successful
1430 delivery happens, and if it finds that another message is waiting for the same
1431 host, it can fire up a new process to deal with it using the same connection.
1433 The database records are keyed by host name. They can get full if there are
1434 lots of messages waiting, and so there is a continuation mechanism for them.
1436 Each record contains a list of message ids, packed end to end without any
1437 zeros. Each one is MESSAGE_ID_LENGTH bytes long. The count field says how many
1438 in this record, and the sequence field says if there are any other records for
1439 this host. If the sequence field is 0, there are none. If it is 1, then another
1440 record with the name <hostname>:0 exists; if it is 2, then two other records
1441 with sequence numbers 0 and 1 exist, and so on.
1443 Currently, an exhaustive search of all continuation records has to be done to
1444 determine whether to add a message id to a given record. This shouldn't be
1445 too bad except in extreme cases. I can't figure out a *simple* way of doing
1448 Old records should eventually get swept up by the exim_tidydb utility.
1451 hostlist list of hosts that this message could be sent to
1452 tpname name of the transport
1458 transport_update_waiting(host_item
*hostlist
, uschar
*tpname
)
1460 const uschar
*prevname
= US
"";
1465 DEBUG(D_transport
) debug_printf("updating wait-%s database\n", tpname
);
1467 /* Open the database for this transport */
1469 if (!(dbm_file
= dbfn_open(string_sprintf("wait-%.200s", tpname
),
1470 O_RDWR
, &dbblock
, TRUE
)))
1473 /* Scan the list of hosts for which this message is waiting, and ensure
1474 that the message id is in each host record. */
1476 for (host
= hostlist
; host
; host
= host
->next
)
1478 BOOL already
= FALSE
;
1479 dbdata_wait
*host_record
;
1484 /* Skip if this is the same host as we just processed; otherwise remember
1485 the name for next time. */
1487 if (Ustrcmp(prevname
, host
->name
) == 0) continue;
1488 prevname
= host
->name
;
1490 /* Look up the host record; if there isn't one, make an empty one. */
1492 if (!(host_record
= dbfn_read(dbm_file
, host
->name
)))
1494 host_record
= store_get(sizeof(dbdata_wait
) + MESSAGE_ID_LENGTH
);
1495 host_record
->count
= host_record
->sequence
= 0;
1498 /* Compute the current length */
1500 host_length
= host_record
->count
* MESSAGE_ID_LENGTH
;
1502 /* Search the record to see if the current message is already in it. */
1504 for (s
= host_record
->text
; s
< host_record
->text
+ host_length
;
1505 s
+= MESSAGE_ID_LENGTH
)
1506 if (Ustrncmp(s
, message_id
, MESSAGE_ID_LENGTH
) == 0)
1507 { already
= TRUE
; break; }
1509 /* If we haven't found this message in the main record, search any
1510 continuation records that exist. */
1512 for (i
= host_record
->sequence
- 1; i
>= 0 && !already
; i
--)
1515 sprintf(CS buffer
, "%.200s:%d", host
->name
, i
);
1516 if ((cont
= dbfn_read(dbm_file
, buffer
)))
1518 int clen
= cont
->count
* MESSAGE_ID_LENGTH
;
1519 for (s
= cont
->text
; s
< cont
->text
+ clen
; s
+= MESSAGE_ID_LENGTH
)
1520 if (Ustrncmp(s
, message_id
, MESSAGE_ID_LENGTH
) == 0)
1521 { already
= TRUE
; break; }
1525 /* If this message is already in a record, no need to update. */
1529 DEBUG(D_transport
) debug_printf("already listed for %s\n", host
->name
);
1534 /* If this record is full, write it out with a new name constructed
1535 from the sequence number, increase the sequence number, and empty
1538 if (host_record
->count
>= WAIT_NAME_MAX
)
1540 sprintf(CS buffer
, "%.200s:%d", host
->name
, host_record
->sequence
);
1541 dbfn_write(dbm_file
, buffer
, host_record
, sizeof(dbdata_wait
) + host_length
);
1542 host_record
->sequence
++;
1543 host_record
->count
= 0;
1547 /* If this record is not full, increase the size of the record to
1548 allow for one new message id. */
1553 store_get(sizeof(dbdata_wait
) + host_length
+ MESSAGE_ID_LENGTH
);
1554 memcpy(newr
, host_record
, sizeof(dbdata_wait
) + host_length
);
1558 /* Now add the new name on the end */
1560 memcpy(host_record
->text
+ host_length
, message_id
, MESSAGE_ID_LENGTH
);
1561 host_record
->count
++;
1562 host_length
+= MESSAGE_ID_LENGTH
;
1564 /* Update the database */
1566 dbfn_write(dbm_file
, host
->name
, host_record
, sizeof(dbdata_wait
) + host_length
);
1567 DEBUG(D_transport
) debug_printf("added to list for %s\n", host
->name
);
1572 dbfn_close(dbm_file
);
1578 /*************************************************
1579 * Test for waiting messages *
1580 *************************************************/
1582 /* This function is called by a remote transport which uses the previous
1583 function to remember which messages are waiting for which remote hosts. It's
1584 called after a successful delivery and its job is to check whether there is
1585 another message waiting for the same host. However, it doesn't do this if the
1586 current continue sequence is greater than the maximum supplied as an argument,
1587 or greater than the global connection_max_messages, which, if set, overrides.
1590 transport_name name of the transport
1591 hostname name of the host
1592 local_message_max maximum number of messages down one connection
1593 as set by the caller transport
1594 new_message_id set to the message id of a waiting message
1595 more set TRUE if there are yet more messages waiting
1596 oicf_func function to call to validate if it is ok to send
1597 to this message_id from the current instance.
1598 oicf_data opaque data for oicf_func
1600 Returns: TRUE if new_message_id set; FALSE otherwise
1603 typedef struct msgq_s
1605 uschar message_id
[MESSAGE_ID_LENGTH
+ 1];
1610 transport_check_waiting(const uschar
*transport_name
, const uschar
*hostname
,
1611 int local_message_max
, uschar
*new_message_id
, BOOL
*more
, oicf oicf_func
, void *oicf_data
)
1613 dbdata_wait
*host_record
;
1619 struct stat statbuf
;
1625 debug_printf("transport_check_waiting entered\n");
1626 debug_printf(" sequence=%d local_max=%d global_max=%d\n",
1627 continue_sequence
, local_message_max
, connection_max_messages
);
1630 /* Do nothing if we have hit the maximum number that can be send down one
1633 if (connection_max_messages
>= 0) local_message_max
= connection_max_messages
;
1634 if (local_message_max
> 0 && continue_sequence
>= local_message_max
)
1637 debug_printf("max messages for one connection reached: returning\n");
1641 /* Open the waiting information database. */
1643 if (!(dbm_file
= dbfn_open(string_sprintf("wait-%.200s", transport_name
),
1644 O_RDWR
, &dbblock
, TRUE
)))
1647 /* See if there is a record for this host; if not, there's nothing to do. */
1649 if (!(host_record
= dbfn_read(dbm_file
, hostname
)))
1651 dbfn_close(dbm_file
);
1652 DEBUG(D_transport
) debug_printf("no messages waiting for %s\n", hostname
);
1656 /* If the data in the record looks corrupt, just log something and
1657 don't try to use it. */
1659 if (host_record
->count
> WAIT_NAME_MAX
)
1661 dbfn_close(dbm_file
);
1662 log_write(0, LOG_MAIN
|LOG_PANIC
, "smtp-wait database entry for %s has bad "
1663 "count=%d (max=%d)", hostname
, host_record
->count
, WAIT_NAME_MAX
);
1667 /* Scan the message ids in the record from the end towards the beginning,
1668 until one is found for which a spool file actually exists. If the record gets
1669 emptied, delete it and continue with any continuation records that may exist.
1672 /* For Bug 1141, I refactored this major portion of the routine, it is risky
1673 but the 1 off will remain without it. This code now allows me to SKIP over
1674 a message I do not want to send out on this run. */
1676 host_length
= host_record
->count
* MESSAGE_ID_LENGTH
;
1682 int msgq_actual
= 0;
1683 BOOL bFound
= FALSE
;
1684 BOOL bContinuation
= FALSE
;
1686 /* create an array to read entire message queue into memory for processing */
1688 msgq
= store_malloc(sizeof(msgq_t
) * host_record
->count
);
1689 msgq_count
= host_record
->count
;
1690 msgq_actual
= msgq_count
;
1692 for (i
= 0; i
< host_record
->count
; ++i
)
1694 msgq
[i
].bKeep
= TRUE
;
1696 Ustrncpy(msgq
[i
].message_id
, host_record
->text
+ (i
* MESSAGE_ID_LENGTH
),
1698 msgq
[i
].message_id
[MESSAGE_ID_LENGTH
] = 0;
1701 /* first thing remove current message id if it exists */
1703 for (i
= 0; i
< msgq_count
; ++i
)
1704 if (Ustrcmp(msgq
[i
].message_id
, message_id
) == 0)
1706 msgq
[i
].bKeep
= FALSE
;
1710 /* now find the next acceptable message_id */
1712 for (i
= msgq_count
- 1; i
>= 0; --i
) if (msgq
[i
].bKeep
)
1716 subdir
[0] = split_spool_directory
? msgq
[i
].message_id
[5] : 0;
1719 if (Ustat(spool_fname(US
"input", subdir
, msgq
[i
].message_id
, US
"-D"),
1721 msgq
[i
].bKeep
= FALSE
;
1722 else if (!oicf_func
|| oicf_func(msgq
[i
].message_id
, oicf_data
))
1724 Ustrcpy(new_message_id
, msgq
[i
].message_id
);
1725 msgq
[i
].bKeep
= FALSE
;
1732 for (msgq_actual
= 0, i
= 0; i
< msgq_count
; ++i
)
1736 /* reassemble the host record, based on removed message ids, from in
1739 if (msgq_actual
<= 0)
1742 host_record
->count
= 0;
1746 host_length
= msgq_actual
* MESSAGE_ID_LENGTH
;
1747 host_record
->count
= msgq_actual
;
1749 if (msgq_actual
< msgq_count
)
1752 for (new_count
= 0, i
= 0; i
< msgq_count
; ++i
)
1754 Ustrncpy(&host_record
->text
[new_count
++ * MESSAGE_ID_LENGTH
],
1755 msgq
[i
].message_id
, MESSAGE_ID_LENGTH
);
1757 host_record
->text
[new_count
* MESSAGE_ID_LENGTH
] = 0;
1761 /* Check for a continuation record. */
1763 while (host_length
<= 0)
1766 dbdata_wait
* newr
= NULL
;
1769 /* Search for a continuation */
1771 for (i
= host_record
->sequence
- 1; i
>= 0 && !newr
; i
--)
1773 sprintf(CS buffer
, "%.200s:%d", hostname
, i
);
1774 newr
= dbfn_read(dbm_file
, buffer
);
1777 /* If no continuation, delete the current and break the loop */
1781 dbfn_delete(dbm_file
, hostname
);
1785 /* Else replace the current with the continuation */
1787 dbfn_delete(dbm_file
, buffer
);
1789 host_length
= host_record
->count
* MESSAGE_ID_LENGTH
;
1791 bContinuation
= TRUE
;
1794 if (bFound
) /* Usual exit from main loop */
1800 /* If host_length <= 0 we have emptied a record and not found a good message,
1801 and there are no continuation records. Otherwise there is a continuation
1802 record to process. */
1804 if (host_length
<= 0)
1806 dbfn_close(dbm_file
);
1807 DEBUG(D_transport
) debug_printf("waiting messages already delivered\n");
1811 /* we were not able to find an acceptable message, nor was there a
1812 * continuation record. So bug out, outer logic will clean this up.
1817 Ustrcpy(new_message_id
, message_id
);
1818 dbfn_close(dbm_file
);
1823 } /* we need to process a continuation record */
1825 /* Control gets here when an existing message has been encountered; its
1826 id is in new_message_id, and host_length is the revised length of the
1827 host record. If it is zero, the record has been removed. Update the
1828 record if required, close the database, and return TRUE. */
1830 if (host_length
> 0)
1832 host_record
->count
= host_length
/MESSAGE_ID_LENGTH
;
1834 dbfn_write(dbm_file
, hostname
, host_record
, (int)sizeof(dbdata_wait
) + host_length
);
1838 dbfn_close(dbm_file
);
1842 /*************************************************
1843 * Deliver waiting message down same socket *
1844 *************************************************/
1846 /* Just the regain-root-privilege exec portion */
1848 transport_do_pass_socket(const uschar
*transport_name
, const uschar
*hostname
,
1849 const uschar
*hostaddress
, uschar
*id
, int socket_fd
)
1852 const uschar
**argv
;
1854 /* Set up the calling arguments; use the standard function for the basics,
1855 but we have a number of extras that may be added. */
1857 argv
= CUSS
child_exec_exim(CEE_RETURN_ARGV
, TRUE
, &i
, FALSE
, 0);
1859 if (smtp_authenticated
) argv
[i
++] = US
"-MCA";
1860 if (smtp_peer_options
& PEER_OFFERED_CHUNKING
) argv
[i
++] = US
"-MCK";
1861 if (smtp_peer_options
& PEER_OFFERED_DSN
) argv
[i
++] = US
"-MCD";
1862 if (smtp_peer_options
& PEER_OFFERED_PIPE
) argv
[i
++] = US
"-MCP";
1863 if (smtp_peer_options
& PEER_OFFERED_SIZE
) argv
[i
++] = US
"-MCS";
1865 if (smtp_peer_options
& PEER_OFFERED_TLS
)
1866 if (tls_out
.active
>= 0 || continue_proxy_cipher
)
1868 argv
[i
++] = US
"-MCt";
1869 argv
[i
++] = sending_ip_address
;
1870 argv
[i
++] = string_sprintf("%d", sending_port
);
1871 argv
[i
++] = tls_out
.active
>= 0 ? tls_out
.cipher
: continue_proxy_cipher
;
1874 argv
[i
++] = US
"-MCT";
1877 if (queue_run_pid
!= (pid_t
)0)
1879 argv
[i
++] = US
"-MCQ";
1880 argv
[i
++] = string_sprintf("%d", queue_run_pid
);
1881 argv
[i
++] = string_sprintf("%d", queue_run_pipe
);
1884 argv
[i
++] = US
"-MC";
1885 argv
[i
++] = US transport_name
;
1886 argv
[i
++] = US hostname
;
1887 argv
[i
++] = US hostaddress
;
1888 argv
[i
++] = string_sprintf("%d", continue_sequence
+ 1);
1892 /* Arrange for the channel to be on stdin. */
1896 (void)dup2(socket_fd
, 0);
1897 (void)close(socket_fd
);
1900 DEBUG(D_exec
) debug_print_argv(argv
);
1901 exim_nullstd(); /* Ensure std{out,err} exist */
1902 execv(CS argv
[0], (char *const *)argv
);
1904 DEBUG(D_any
) debug_printf("execv failed: %s\n", strerror(errno
));
1905 _exit(errno
); /* Note: must be _exit(), NOT exit() */
1910 /* Fork a new exim process to deliver the message, and do a re-exec, both to
1911 get a clean delivery process, and to regain root privilege in cases where it
1912 has been given away.
1915 transport_name to pass to the new process
1918 id the new message to process
1919 socket_fd the connected socket
1921 Returns: FALSE if fork fails; TRUE otherwise
1925 transport_pass_socket(const uschar
*transport_name
, const uschar
*hostname
,
1926 const uschar
*hostaddress
, uschar
*id
, int socket_fd
)
1931 DEBUG(D_transport
) debug_printf("transport_pass_socket entered\n");
1933 if ((pid
= fork()) == 0)
1935 /* Disconnect entirely from the parent process. If we are running in the
1936 test harness, wait for a bit to allow the previous process time to finish,
1937 write the log, etc., so that the output is always in the same order for
1938 automatic comparison. */
1940 if ((pid
= fork()) != 0)
1942 DEBUG(D_transport
) debug_printf("transport_pass_socket succeeded (final-pid %d)\n", pid
);
1943 _exit(EXIT_SUCCESS
);
1945 if (running_in_test_harness
) sleep(1);
1947 transport_do_pass_socket(transport_name
, hostname
, hostaddress
,
1951 /* If the process creation succeeded, wait for the first-level child, which
1952 immediately exits, leaving the second level process entirely disconnected from
1958 while ((rc
= wait(&status
)) != pid
&& (rc
>= 0 || errno
!= ECHILD
));
1959 DEBUG(D_transport
) debug_printf("transport_pass_socket succeeded (inter-pid %d)\n", pid
);
1964 DEBUG(D_transport
) debug_printf("transport_pass_socket failed to fork: %s\n",
1972 /*************************************************
1973 * Set up direct (non-shell) command *
1974 *************************************************/
1976 /* This function is called when a command line is to be parsed and executed
1977 directly, without the use of /bin/sh. It is called by the pipe transport,
1978 the queryprogram router, and also from the main delivery code when setting up a
1979 transport filter process. The code for ETRN also makes use of this; in that
1980 case, no addresses are passed.
1983 argvptr pointer to anchor for argv vector
1984 cmd points to the command string (modified IN PLACE)
1985 expand_arguments true if expansion is to occur
1986 expand_failed error value to set if expansion fails; not relevant if
1988 addr chain of addresses, or NULL
1989 etext text for use in error messages
1990 errptr where to put error message if addr is NULL;
1991 otherwise it is put in the first address
1993 Returns: TRUE if all went well; otherwise an error will be
1994 set in the first address and FALSE returned
1998 transport_set_up_command(const uschar
***argvptr
, uschar
*cmd
,
1999 BOOL expand_arguments
, int expand_failed
, address_item
*addr
,
2000 uschar
*etext
, uschar
**errptr
)
2003 const uschar
**argv
;
2005 int address_count
= 0;
2009 /* Get store in which to build an argument list. Count the number of addresses
2010 supplied, and allow for that many arguments, plus an additional 60, which
2011 should be enough for anybody. Multiple addresses happen only when the local
2012 delivery batch option is set. */
2014 for (ad
= addr
; ad
!= NULL
; ad
= ad
->next
) address_count
++;
2015 max_args
= address_count
+ 60;
2016 *argvptr
= argv
= store_get((max_args
+1)*sizeof(uschar
*));
2018 /* Split the command up into arguments terminated by white space. Lose
2019 trailing space at the start and end. Double-quoted arguments can contain \\ and
2020 \" escapes and so can be handled by the standard function; single-quoted
2021 arguments are verbatim. Copy each argument into a new string. */
2024 while (isspace(*s
)) s
++;
2026 while (*s
!= 0 && argcount
< max_args
)
2031 while (*ss
!= 0 && *ss
!= '\'') ss
++;
2032 argv
[argcount
++] = ss
= store_get(ss
- s
++);
2033 while (*s
!= 0 && *s
!= '\'') *ss
++ = *s
++;
2037 else argv
[argcount
++] = string_copy(string_dequote(CUSS
&s
));
2038 while (isspace(*s
)) s
++;
2041 argv
[argcount
] = (uschar
*)0;
2043 /* If *s != 0 we have run out of argument slots. */
2047 uschar
*msg
= string_sprintf("Too many arguments in command \"%s\" in "
2051 addr
->transport_return
= FAIL
;
2052 addr
->message
= msg
;
2058 /* Expand each individual argument if required. Expansion happens for pipes set
2059 up in filter files and with directly-supplied commands. It does not happen if
2060 the pipe comes from a traditional .forward file. A failing expansion is a big
2061 disaster if the command came from Exim's configuration; if it came from a user
2062 it is just a normal failure. The expand_failed value is used as the error value
2063 to cater for these two cases.
2065 An argument consisting just of the text "$pipe_addresses" is treated specially.
2066 It is not passed to the general expansion function. Instead, it is replaced by
2067 a number of arguments, one for each address. This avoids problems with shell
2068 metacharacters and spaces in addresses.
2070 If the parent of the top address has an original part of "system-filter", this
2071 pipe was set up by the system filter, and we can permit the expansion of
2076 debug_printf("direct command:\n");
2077 for (i
= 0; argv
[i
] != (uschar
*)0; i
++)
2078 debug_printf(" argv[%d] = %s\n", i
, string_printing(argv
[i
]));
2081 if (expand_arguments
)
2083 BOOL allow_dollar_recipients
= addr
!= NULL
&&
2084 addr
->parent
!= NULL
&&
2085 Ustrcmp(addr
->parent
->address
, "system-filter") == 0;
2087 for (i
= 0; argv
[i
] != (uschar
*)0; i
++)
2090 /* Handle special fudge for passing an address list */
2093 (Ustrcmp(argv
[i
], "$pipe_addresses") == 0 ||
2094 Ustrcmp(argv
[i
], "${pipe_addresses}") == 0))
2098 if (argcount
+ address_count
- 1 > max_args
)
2100 addr
->transport_return
= FAIL
;
2101 addr
->message
= string_sprintf("Too many arguments to command \"%s\" "
2102 "in %s", cmd
, etext
);
2106 additional
= address_count
- 1;
2108 memmove(argv
+ i
+ 1 + additional
, argv
+ i
+ 1,
2109 (argcount
- i
)*sizeof(uschar
*));
2111 for (ad
= addr
; ad
!= NULL
; ad
= ad
->next
) {
2112 argv
[i
++] = ad
->address
;
2116 /* Subtract one since we replace $pipe_addresses */
2121 /* Handle special case of $address_pipe when af_force_command is set */
2123 else if (addr
!= NULL
&& testflag(addr
,af_force_command
) &&
2124 (Ustrcmp(argv
[i
], "$address_pipe") == 0 ||
2125 Ustrcmp(argv
[i
], "${address_pipe}") == 0))
2128 int address_pipe_argcount
= 0;
2129 int address_pipe_max_args
;
2130 uschar
**address_pipe_argv
;
2132 /* We can never have more then the argv we will be loading into */
2133 address_pipe_max_args
= max_args
- argcount
+ 1;
2136 debug_printf("address_pipe_max_args=%d\n", address_pipe_max_args
);
2138 /* We allocate an additional for (uschar *)0 */
2139 address_pipe_argv
= store_get((address_pipe_max_args
+1)*sizeof(uschar
*));
2141 /* +1 because addr->local_part[0] == '|' since af_force_command is set */
2142 s
= expand_string(addr
->local_part
+ 1);
2144 if (s
== NULL
|| *s
== '\0')
2146 addr
->transport_return
= FAIL
;
2147 addr
->message
= string_sprintf("Expansion of \"%s\" "
2148 "from command \"%s\" in %s failed: %s",
2149 (addr
->local_part
+ 1), cmd
, etext
, expand_string_message
);
2153 while (isspace(*s
)) s
++; /* strip leading space */
2155 while (*s
!= 0 && address_pipe_argcount
< address_pipe_max_args
)
2160 while (*ss
!= 0 && *ss
!= '\'') ss
++;
2161 address_pipe_argv
[address_pipe_argcount
++] = ss
= store_get(ss
- s
++);
2162 while (*s
!= 0 && *s
!= '\'') *ss
++ = *s
++;
2166 else address_pipe_argv
[address_pipe_argcount
++] =
2167 string_copy(string_dequote(CUSS
&s
));
2168 while (isspace(*s
)) s
++; /* strip space after arg */
2171 address_pipe_argv
[address_pipe_argcount
] = (uschar
*)0;
2173 /* If *s != 0 we have run out of argument slots. */
2176 uschar
*msg
= string_sprintf("Too many arguments in $address_pipe "
2177 "\"%s\" in %s", addr
->local_part
+ 1, etext
);
2180 addr
->transport_return
= FAIL
;
2181 addr
->message
= msg
;
2187 /* address_pipe_argcount - 1
2188 * because we are replacing $address_pipe in the argument list
2189 * with the first thing it expands to */
2190 if (argcount
+ address_pipe_argcount
- 1 > max_args
)
2192 addr
->transport_return
= FAIL
;
2193 addr
->message
= string_sprintf("Too many arguments to command "
2194 "\"%s\" after expanding $address_pipe in %s", cmd
, etext
);
2198 /* If we are not just able to replace the slot that contained
2199 * $address_pipe (address_pipe_argcount == 1)
2200 * We have to move the existing argv by address_pipe_argcount - 1
2201 * Visually if address_pipe_argcount == 2:
2202 * [argv 0][argv 1][argv 2($address_pipe)][argv 3][0]
2203 * [argv 0][argv 1][ap_arg0][ap_arg1][old argv 3][0]
2205 if (address_pipe_argcount
> 1)
2207 /* current position + additional args */
2208 argv
+ i
+ address_pipe_argcount
,
2209 /* current position + 1 (for the (uschar *)0 at the end) */
2211 /* -1 for the (uschar *)0 at the end)*/
2212 (argcount
- i
)*sizeof(uschar
*)
2215 /* Now we fill in the slots we just moved argv out of
2216 * [argv 0][argv 1][argv 2=pipeargv[0]][argv 3=pipeargv[1]][old argv 3][0]
2218 for (address_pipe_i
= 0;
2219 address_pipe_argv
[address_pipe_i
] != (uschar
*)0;
2222 argv
[i
++] = address_pipe_argv
[address_pipe_i
];
2226 /* Subtract one since we replace $address_pipe */
2231 /* Handle normal expansion string */
2235 const uschar
*expanded_arg
;
2236 enable_dollar_recipients
= allow_dollar_recipients
;
2237 expanded_arg
= expand_cstring(argv
[i
]);
2238 enable_dollar_recipients
= FALSE
;
2240 if (expanded_arg
== NULL
)
2242 uschar
*msg
= string_sprintf("Expansion of \"%s\" "
2243 "from command \"%s\" in %s failed: %s",
2244 argv
[i
], cmd
, etext
, expand_string_message
);
2247 addr
->transport_return
= expand_failed
;
2248 addr
->message
= msg
;
2253 argv
[i
] = expanded_arg
;
2259 debug_printf("direct command after expansion:\n");
2260 for (i
= 0; argv
[i
] != (uschar
*)0; i
++)
2261 debug_printf(" argv[%d] = %s\n", i
, string_printing(argv
[i
]));
2270 /* End of transport.c */