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