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