Merge branch 'debian'
[hcoop/debian/exim4.git] / src / transports / pipe.c
1 /*************************************************
2 * Exim - an Internet mail transport agent *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2018 */
6 /* See the file NOTICE for conditions of use and distribution. */
7
8
9 #include "../exim.h"
10 #include "pipe.h"
11
12 #ifdef HAVE_SETCLASSRESOURCES
13 #include <login_cap.h>
14 #endif
15
16
17
18 /* Options specific to the pipe transport. They must be in alphabetic
19 order (note that "_" comes before the lower case letters). Those starting
20 with "*" are not settable by the user but are used by the option-reading
21 software for alternative value types. Some options are stored in the transport
22 instance block so as to be publicly visible; these are flagged with opt_public.
23 */
24
25 optionlist pipe_transport_options[] = {
26 { "allow_commands", opt_stringptr,
27 (void *)offsetof(pipe_transport_options_block, allow_commands) },
28 { "batch_id", opt_stringptr | opt_public,
29 (void *)offsetof(transport_instance, batch_id) },
30 { "batch_max", opt_int | opt_public,
31 (void *)offsetof(transport_instance, batch_max) },
32 { "check_string", opt_stringptr,
33 (void *)offsetof(pipe_transport_options_block, check_string) },
34 { "command", opt_stringptr,
35 (void *)offsetof(pipe_transport_options_block, cmd) },
36 { "environment", opt_stringptr,
37 (void *)offsetof(pipe_transport_options_block, environment) },
38 { "escape_string", opt_stringptr,
39 (void *)offsetof(pipe_transport_options_block, escape_string) },
40 { "force_command", opt_bool,
41 (void *)offsetof(pipe_transport_options_block, force_command) },
42 { "freeze_exec_fail", opt_bool,
43 (void *)offsetof(pipe_transport_options_block, freeze_exec_fail) },
44 { "freeze_signal", opt_bool,
45 (void *)offsetof(pipe_transport_options_block, freeze_signal) },
46 { "ignore_status", opt_bool,
47 (void *)offsetof(pipe_transport_options_block, ignore_status) },
48 { "log_defer_output", opt_bool | opt_public,
49 (void *)offsetof(transport_instance, log_defer_output) },
50 { "log_fail_output", opt_bool | opt_public,
51 (void *)offsetof(transport_instance, log_fail_output) },
52 { "log_output", opt_bool | opt_public,
53 (void *)offsetof(transport_instance, log_output) },
54 { "max_output", opt_mkint,
55 (void *)offsetof(pipe_transport_options_block, max_output) },
56 { "message_prefix", opt_stringptr,
57 (void *)offsetof(pipe_transport_options_block, message_prefix) },
58 { "message_suffix", opt_stringptr,
59 (void *)offsetof(pipe_transport_options_block, message_suffix) },
60 { "path", opt_stringptr,
61 (void *)offsetof(pipe_transport_options_block, path) },
62 { "permit_coredump", opt_bool,
63 (void *)offsetof(pipe_transport_options_block, permit_coredump) },
64 { "pipe_as_creator", opt_bool | opt_public,
65 (void *)offsetof(transport_instance, deliver_as_creator) },
66 { "restrict_to_path", opt_bool,
67 (void *)offsetof(pipe_transport_options_block, restrict_to_path) },
68 { "return_fail_output",opt_bool | opt_public,
69 (void *)offsetof(transport_instance, return_fail_output) },
70 { "return_output", opt_bool | opt_public,
71 (void *)offsetof(transport_instance, return_output) },
72 { "temp_errors", opt_stringptr,
73 (void *)offsetof(pipe_transport_options_block, temp_errors) },
74 { "timeout", opt_time,
75 (void *)offsetof(pipe_transport_options_block, timeout) },
76 { "timeout_defer", opt_bool,
77 (void *)offsetof(pipe_transport_options_block, timeout_defer) },
78 { "umask", opt_octint,
79 (void *)offsetof(pipe_transport_options_block, umask) },
80 { "use_bsmtp", opt_bool,
81 (void *)offsetof(pipe_transport_options_block, use_bsmtp) },
82 #ifdef HAVE_SETCLASSRESOURCES
83 { "use_classresources", opt_bool,
84 (void *)offsetof(pipe_transport_options_block, use_classresources) },
85 #endif
86 { "use_crlf", opt_bool,
87 (void *)offsetof(pipe_transport_options_block, use_crlf) },
88 { "use_shell", opt_bool,
89 (void *)offsetof(pipe_transport_options_block, use_shell) },
90 };
91
92 /* Size of the options list. An extern variable has to be used so that its
93 address can appear in the tables drtables.c. */
94
95 int pipe_transport_options_count =
96 sizeof(pipe_transport_options)/sizeof(optionlist);
97
98
99 #ifdef MACRO_PREDEF
100
101 /* Dummy values */
102 pipe_transport_options_block pipe_transport_option_defaults = {0};
103 void pipe_transport_init(transport_instance *tblock) {}
104 BOOL pipe_transport_entry(transport_instance *tblock, address_item *addr) {return FALSE;}
105
106 #else /*!MACRO_PREDEF*/
107
108
109 /* Default private options block for the pipe transport. */
110
111 pipe_transport_options_block pipe_transport_option_defaults = {
112 NULL, /* cmd */
113 NULL, /* allow_commands */
114 NULL, /* environment */
115 US"/bin:/usr/bin", /* path */
116 NULL, /* message_prefix (reset in init if not bsmtp) */
117 NULL, /* message_suffix (ditto) */
118 US mac_expanded_string(EX_TEMPFAIL) ":" /* temp_errors */
119 mac_expanded_string(EX_CANTCREAT),
120 NULL, /* check_string */
121 NULL, /* escape_string */
122 022, /* umask */
123 20480, /* max_output */
124 60*60, /* timeout */
125 0, /* options */
126 FALSE, /* force_command */
127 FALSE, /* freeze_exec_fail */
128 FALSE, /* freeze_signal */
129 FALSE, /* ignore_status */
130 FALSE, /* permit_coredump */
131 FALSE, /* restrict_to_path */
132 FALSE, /* timeout_defer */
133 FALSE, /* use_shell */
134 FALSE, /* use_bsmtp */
135 FALSE, /* use_classresources */
136 FALSE /* use_crlf */
137 };
138
139
140
141 /*************************************************
142 * Setup entry point *
143 *************************************************/
144
145 /* Called for each delivery in the privileged state, just before the uid/gid
146 are changed and the main entry point is called. In a system that supports the
147 login_cap facilities, this function is used to set the class resource limits
148 for the user. It may also re-enable coredumps.
149
150 Arguments:
151 tblock points to the transport instance
152 addrlist addresses about to be delivered (not used)
153 dummy not used (doesn't pass back data)
154 uid the uid that will be set (not used)
155 gid the gid that will be set (not used)
156 errmsg where to put an error message
157
158 Returns: OK, FAIL, or DEFER
159 */
160
161 static int
162 pipe_transport_setup(transport_instance *tblock, address_item *addrlist,
163 transport_feedback *dummy, uid_t uid, gid_t gid, uschar **errmsg)
164 {
165 pipe_transport_options_block *ob =
166 (pipe_transport_options_block *)(tblock->options_block);
167
168 addrlist = addrlist; /* Keep compiler happy */
169 dummy = dummy;
170 uid = uid;
171 gid = gid;
172 errmsg = errmsg;
173 ob = ob;
174
175 #ifdef HAVE_SETCLASSRESOURCES
176 if (ob->use_classresources)
177 {
178 struct passwd *pw = getpwuid(uid);
179 if (pw != NULL)
180 {
181 login_cap_t *lc = login_getpwclass(pw);
182 if (lc != NULL)
183 {
184 setclassresources(lc);
185 login_close(lc);
186 }
187 }
188 }
189 #endif
190
191 #ifdef RLIMIT_CORE
192 if (ob->permit_coredump)
193 {
194 struct rlimit rl;
195 rl.rlim_cur = RLIM_INFINITY;
196 rl.rlim_max = RLIM_INFINITY;
197 if (setrlimit(RLIMIT_CORE, &rl) < 0)
198 {
199 #ifdef SETRLIMIT_NOT_SUPPORTED
200 if (errno != ENOSYS && errno != ENOTSUP)
201 #endif
202 log_write(0, LOG_MAIN,
203 "delivery setrlimit(RLIMIT_CORE, RLIM_INFINITY) failed: %s",
204 strerror(errno));
205 }
206 }
207 #endif
208
209 return OK;
210 }
211
212
213
214 /*************************************************
215 * Initialization entry point *
216 *************************************************/
217
218 /* Called for each instance, after its options have been read, to
219 enable consistency checks to be done, or anything else that needs
220 to be set up. */
221
222 void
223 pipe_transport_init(transport_instance *tblock)
224 {
225 pipe_transport_options_block *ob =
226 (pipe_transport_options_block *)(tblock->options_block);
227
228 /* Set up the setup entry point, to be called in the privileged state */
229
230 tblock->setup = pipe_transport_setup;
231
232 /* If pipe_as_creator is set, then uid/gid should not be set. */
233
234 if (tblock->deliver_as_creator && (tblock->uid_set || tblock->gid_set ||
235 tblock->expand_uid != NULL || tblock->expand_gid != NULL))
236 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
237 "both pipe_as_creator and an explicit uid/gid are set for the %s "
238 "transport", tblock->name);
239
240 /* If a fixed uid field is set, then a gid field must also be set. */
241
242 if (tblock->uid_set && !tblock->gid_set && tblock->expand_gid == NULL)
243 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
244 "user set without group for the %s transport", tblock->name);
245
246 /* Temp_errors must consist only of digits and colons, but there can be
247 spaces round the colons, so allow them too. */
248
249 if (ob->temp_errors != NULL && Ustrcmp(ob->temp_errors, "*") != 0)
250 {
251 size_t p = Ustrspn(ob->temp_errors, "0123456789: ");
252 if (ob->temp_errors[p] != 0)
253 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
254 "temp_errors must be a list of numbers or an asterisk for the %s "
255 "transport", tblock->name);
256 }
257
258 /* Only one of return_output/return_fail_output or log_output/log_fail_output
259 should be set. */
260
261 if (tblock->return_output && tblock->return_fail_output)
262 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
263 "both return_output and return_fail_output set for %s transport",
264 tblock->name);
265
266 if (tblock->log_output && tblock->log_fail_output)
267 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
268 "both log_output and log_fail_output set for the %s transport",
269 tblock->name);
270
271 /* If batch SMTP is set, force the check and escape strings, and arrange that
272 headers are also escaped. */
273
274 if (ob->use_bsmtp)
275 {
276 ob->check_string = US".";
277 ob->escape_string = US"..";
278 ob->options |= topt_escape_headers;
279 }
280
281 /* If not batch SMTP, and message_prefix or message_suffix are unset, insert
282 default values for them. */
283
284 else
285 {
286 if (ob->message_prefix == NULL) ob->message_prefix =
287 US"From ${if def:return_path{$return_path}{MAILER-DAEMON}} ${tod_bsdinbox}\n";
288 if (ob->message_suffix == NULL) ob->message_suffix = US"\n";
289 }
290
291 /* The restrict_to_path and use_shell options are incompatible */
292
293 if (ob->restrict_to_path && ob->use_shell)
294 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
295 "both restrict_to_path and use_shell set for %s transport",
296 tblock->name);
297
298 /* The allow_commands and use_shell options are incompatible */
299
300 if (ob->allow_commands && ob->use_shell)
301 log_write(0, LOG_PANIC_DIE|LOG_CONFIG,
302 "both allow_commands and use_shell set for %s transport",
303 tblock->name);
304
305 /* Set up the bitwise options for transport_write_message from the various
306 driver options. Only one of body_only and headers_only can be set. */
307
308 ob->options |=
309 (tblock->body_only? topt_no_headers : 0) |
310 (tblock->headers_only? topt_no_body : 0) |
311 (tblock->return_path_add? topt_add_return_path : 0) |
312 (tblock->delivery_date_add? topt_add_delivery_date : 0) |
313 (tblock->envelope_to_add? topt_add_envelope_to : 0) |
314 (ob->use_crlf? topt_use_crlf : 0);
315 }
316
317
318
319 /*************************************************
320 * Set up direct (non-shell) command *
321 *************************************************/
322
323 /* This function is called when a command line is to be parsed by the transport
324 and executed directly, without the use of /bin/sh.
325
326 Arguments:
327 argvptr pointer to anchor for argv vector
328 cmd points to the command string
329 expand_arguments true if expansion is to occur
330 expand_fail error if expansion fails
331 addr chain of addresses
332 tname the transport name
333 ob the transport options block
334
335 Returns: TRUE if all went well; otherwise an error will be
336 set in the first address and FALSE returned
337 */
338
339 static BOOL
340 set_up_direct_command(const uschar ***argvptr, uschar *cmd,
341 BOOL expand_arguments, int expand_fail, address_item *addr, uschar *tname,
342 pipe_transport_options_block *ob)
343 {
344 BOOL permitted = FALSE;
345 const uschar **argv;
346
347 /* Set up "transport <name>" to be put in any error messages, and then
348 call the common function for creating an argument list and expanding
349 the items if necessary. If it fails, this function fails (error information
350 is in the addresses). */
351
352 if (!transport_set_up_command(argvptr, cmd, expand_arguments, expand_fail,
353 addr, string_sprintf("%.50s transport", tname), NULL))
354 return FALSE;
355
356 /* Point to the set-up arguments. */
357
358 argv = *argvptr;
359
360 /* If allow_commands is set, see if the command is in the permitted list. */
361
362 if (ob->allow_commands)
363 {
364 int sep = 0;
365 const uschar *s;
366 uschar *p;
367
368 if (!(s = expand_string(ob->allow_commands)))
369 {
370 addr->transport_return = DEFER;
371 addr->message = string_sprintf("failed to expand string \"%s\" "
372 "for %s transport: %s", ob->allow_commands, tname, expand_string_message);
373 return FALSE;
374 }
375
376 while ((p = string_nextinlist(&s, &sep, NULL, 0)))
377 if (Ustrcmp(p, argv[0]) == 0) { permitted = TRUE; break; }
378 }
379
380 /* If permitted is TRUE it means the command was found in the allowed list, and
381 no further checks are done. If permitted = FALSE, it either means
382 allow_commands wasn't set, or that the command didn't match anything in the
383 list. In both cases, if restrict_to_path is set, we fail if the command
384 contains any slashes, but if restrict_to_path is not set, we must fail the
385 command only if allow_commands is set. */
386
387 if (!permitted)
388 {
389 if (ob->restrict_to_path)
390 {
391 if (Ustrchr(argv[0], '/') != NULL)
392 {
393 addr->transport_return = FAIL;
394 addr->message = string_sprintf("\"/\" found in \"%s\" (command for %s "
395 "transport) - failed for security reasons", cmd, tname);
396 return FALSE;
397 }
398 }
399
400 else if (ob->allow_commands)
401 {
402 addr->transport_return = FAIL;
403 addr->message = string_sprintf("\"%s\" command not permitted by %s "
404 "transport", argv[0], tname);
405 return FALSE;
406 }
407 }
408
409 /* If the command is not an absolute path, search the PATH directories
410 for it. */
411
412 if (argv[0][0] != '/')
413 {
414 int sep = 0;
415 uschar *p;
416 const uschar *listptr = expand_string(ob->path);
417
418 while ((p = string_nextinlist(&listptr, &sep, NULL, 0)))
419 {
420 struct stat statbuf;
421 sprintf(CS big_buffer, "%.256s/%.256s", p, argv[0]);
422 if (Ustat(big_buffer, &statbuf) == 0)
423 {
424 argv[0] = string_copy(big_buffer);
425 break;
426 }
427 }
428 if (!p)
429 {
430 addr->transport_return = FAIL;
431 addr->message = string_sprintf("\"%s\" command not found for %s transport",
432 argv[0], tname);
433 return FALSE;
434 }
435 }
436
437 return TRUE;
438 }
439
440
441 /*************************************************
442 * Set up shell command *
443 *************************************************/
444
445 /* This function is called when a command line is to be passed to /bin/sh
446 without parsing inside the transport.
447
448 Arguments:
449 argvptr pointer to anchor for argv vector
450 cmd points to the command string
451 expand_arguments true if expansion is to occur
452 expand_fail error if expansion fails
453 addr chain of addresses
454 tname the transport name
455
456 Returns: TRUE if all went well; otherwise an error will be
457 set in the first address and FALSE returned
458 */
459
460 static BOOL
461 set_up_shell_command(const uschar ***argvptr, uschar *cmd,
462 BOOL expand_arguments, int expand_fail, address_item *addr, uschar *tname)
463 {
464 const uschar **argv;
465
466 *argvptr = argv = store_get((4)*sizeof(uschar *));
467
468 argv[0] = US"/bin/sh";
469 argv[1] = US"-c";
470
471 /* We have to take special action to handle the special "variable" called
472 $pipe_addresses, which is not recognized by the normal expansion function. */
473
474 if (expand_arguments)
475 {
476 uschar * p = Ustrstr(cmd, "pipe_addresses");
477 gstring * g = NULL;
478
479 DEBUG(D_transport)
480 debug_printf("shell pipe command before expansion:\n %s\n", cmd);
481
482 /* Allow $recipients in the expansion iff it comes from a system filter */
483
484 f.enable_dollar_recipients = addr && addr->parent &&
485 Ustrcmp(addr->parent->address, "system-filter") == 0;
486
487 if (p != NULL && (
488 (p > cmd && p[-1] == '$') ||
489 (p > cmd + 1 && p[-2] == '$' && p[-1] == '{' && p[14] == '}')))
490 {
491 address_item *ad;
492 uschar *q = p + 14;
493
494 if (p[-1] == '{') { q++; p--; }
495
496 g = string_get(Ustrlen(cmd) + 64);
497 g = string_catn(g, cmd, p - cmd - 1);
498
499 for (ad = addr; ad; ad = ad->next)
500 {
501 /*XXX string_append_listele() ? */
502 if (ad != addr) g = string_catn(g, US" ", 1);
503 g = string_cat(g, ad->address);
504 }
505
506 g = string_cat(g, q);
507 argv[2] = (cmd = string_from_gstring(g)) ? expand_string(cmd) : NULL;
508 }
509 else
510 argv[2] = expand_string(cmd);
511
512 f.enable_dollar_recipients = FALSE;
513
514 if (!argv[2])
515 {
516 addr->transport_return = f.search_find_defer ? DEFER : expand_fail;
517 addr->message = string_sprintf("Expansion of command \"%s\" "
518 "in %s transport failed: %s",
519 cmd, tname, expand_string_message);
520 return FALSE;
521 }
522
523 DEBUG(D_transport)
524 debug_printf("shell pipe command after expansion:\n %s\n", argv[2]);
525 }
526 else
527 {
528 DEBUG(D_transport)
529 debug_printf("shell pipe command (no expansion):\n %s\n", cmd);
530 argv[2] = cmd;
531 }
532
533 argv[3] = US 0;
534 return TRUE;
535 }
536
537
538
539
540 /*************************************************
541 * Main entry point *
542 *************************************************/
543
544 /* See local README for interface details. This transport always returns FALSE,
545 indicating that the status in the first address is the status for all addresses
546 in a batch. */
547
548 BOOL
549 pipe_transport_entry(
550 transport_instance *tblock, /* data for this instantiation */
551 address_item *addr) /* address(es) we are working on */
552 {
553 pid_t pid, outpid;
554 int fd_in, fd_out, rc;
555 int envcount = 0;
556 int envsep = 0;
557 int expand_fail;
558 pipe_transport_options_block *ob =
559 (pipe_transport_options_block *)(tblock->options_block);
560 int timeout = ob->timeout;
561 BOOL written_ok = FALSE;
562 BOOL expand_arguments;
563 const uschar **argv;
564 uschar *envp[50];
565 const uschar *envlist = ob->environment;
566 uschar *cmd, *ss;
567 uschar *eol = ob->use_crlf ? US"\r\n" : US"\n";
568 transport_ctx tctx = {
569 .tblock = tblock,
570 .addr = addr,
571 .check_string = ob->check_string,
572 .escape_string = ob->escape_string,
573 ob->options | topt_not_socket /* set at initialization time */
574 };
575
576 DEBUG(D_transport) debug_printf("%s transport entered\n", tblock->name);
577
578 /* Set up for the good case */
579
580 addr->transport_return = OK;
581 addr->basic_errno = 0;
582
583 /* Pipes are not accepted as general addresses, but they can be generated from
584 .forward files or alias files. In those cases, the pfr flag is set, and the
585 command to be obeyed is pointed to by addr->local_part; it starts with the pipe
586 symbol. In other cases, the command is supplied as one of the pipe transport's
587 options. */
588
589 if (testflag(addr, af_pfr) && addr->local_part[0] == '|')
590 {
591 if (ob->force_command)
592 {
593 /* Enables expansion of $address_pipe into separate arguments */
594 setflag(addr, af_force_command);
595 cmd = ob->cmd;
596 expand_arguments = TRUE;
597 expand_fail = PANIC;
598 }
599 else
600 {
601 cmd = addr->local_part + 1;
602 while (isspace(*cmd)) cmd++;
603 expand_arguments = testflag(addr, af_expand_pipe);
604 expand_fail = FAIL;
605 }
606 }
607 else
608 {
609 cmd = ob->cmd;
610 expand_arguments = TRUE;
611 expand_fail = PANIC;
612 }
613
614 /* If no command has been supplied, we are in trouble.
615 * We also check for an empty string since it may be
616 * coming from addr->local_part[0] == '|'
617 */
618
619 if (cmd == NULL || *cmd == '\0')
620 {
621 addr->transport_return = DEFER;
622 addr->message = string_sprintf("no command specified for %s transport",
623 tblock->name);
624 return FALSE;
625 }
626
627 /* When a pipe is set up by a filter file, there may be values for $thisaddress
628 and numerical the variables in existence. These are passed in
629 addr->pipe_expandn for use here. */
630
631 if (expand_arguments && addr->pipe_expandn)
632 {
633 uschar **ss = addr->pipe_expandn;
634 expand_nmax = -1;
635 if (*ss != NULL) filter_thisaddress = *ss++;
636 while (*ss != NULL)
637 {
638 expand_nstring[++expand_nmax] = *ss;
639 expand_nlength[expand_nmax] = Ustrlen(*ss++);
640 }
641 }
642
643 /* The default way of processing the command is to split it up into arguments
644 here, and run it directly. This offers some security advantages. However, there
645 are installations that want by default to run commands under /bin/sh always, so
646 there is an option to do that. */
647
648 if (ob->use_shell)
649 {
650 if (!set_up_shell_command(&argv, cmd, expand_arguments, expand_fail, addr,
651 tblock->name)) return FALSE;
652 }
653 else if (!set_up_direct_command(&argv, cmd, expand_arguments, expand_fail, addr,
654 tblock->name, ob)) return FALSE;
655
656 expand_nmax = -1; /* Reset */
657 filter_thisaddress = NULL;
658
659 /* Set up the environment for the command. */
660
661 envp[envcount++] = string_sprintf("LOCAL_PART=%s", deliver_localpart);
662 envp[envcount++] = string_sprintf("LOGNAME=%s", deliver_localpart);
663 envp[envcount++] = string_sprintf("USER=%s", deliver_localpart);
664 envp[envcount++] = string_sprintf("LOCAL_PART_PREFIX=%#s",
665 deliver_localpart_prefix);
666 envp[envcount++] = string_sprintf("LOCAL_PART_SUFFIX=%#s",
667 deliver_localpart_suffix);
668 envp[envcount++] = string_sprintf("DOMAIN=%s", deliver_domain);
669 envp[envcount++] = string_sprintf("HOME=%#s", deliver_home);
670 envp[envcount++] = string_sprintf("MESSAGE_ID=%s", message_id);
671 envp[envcount++] = string_sprintf("PATH=%s", expand_string(ob->path));
672 envp[envcount++] = string_sprintf("RECIPIENT=%#s%#s%#s@%#s",
673 deliver_localpart_prefix, deliver_localpart, deliver_localpart_suffix,
674 deliver_domain);
675 envp[envcount++] = string_sprintf("QUALIFY_DOMAIN=%s", qualify_domain_sender);
676 envp[envcount++] = string_sprintf("SENDER=%s", sender_address);
677 envp[envcount++] = US"SHELL=/bin/sh";
678
679 if (addr->host_list != NULL)
680 envp[envcount++] = string_sprintf("HOST=%s", addr->host_list->name);
681
682 if (f.timestamps_utc) envp[envcount++] = US"TZ=UTC";
683 else if (timezone_string != NULL && timezone_string[0] != 0)
684 envp[envcount++] = string_sprintf("TZ=%s", timezone_string);
685
686 /* Add any requested items */
687
688 if (envlist)
689 {
690 envlist = expand_cstring(envlist);
691 if (envlist == NULL)
692 {
693 addr->transport_return = DEFER;
694 addr->message = string_sprintf("failed to expand string \"%s\" "
695 "for %s transport: %s", ob->environment, tblock->name,
696 expand_string_message);
697 return FALSE;
698 }
699 }
700
701 while ((ss = string_nextinlist(&envlist, &envsep, big_buffer, big_buffer_size)))
702 {
703 if (envcount > nelem(envp) - 2)
704 {
705 addr->transport_return = DEFER;
706 addr->message = string_sprintf("too many environment settings for "
707 "%s transport", tblock->name);
708 return FALSE;
709 }
710 envp[envcount++] = string_copy(ss);
711 }
712
713 envp[envcount] = NULL;
714
715 /* If the -N option is set, can't do any more. */
716
717 if (f.dont_deliver)
718 {
719 DEBUG(D_transport)
720 debug_printf("*** delivery by %s transport bypassed by -N option",
721 tblock->name);
722 return FALSE;
723 }
724
725
726 /* Handling the output from the pipe is tricky. If a file for catching this
727 output is provided, we could in theory just hand that fd over to the process,
728 but this isn't very safe because it might loop and carry on writing for
729 ever (which is exactly what happened in early versions of Exim). Therefore we
730 use the standard child_open() function, which creates pipes. We can then read
731 our end of the output pipe and count the number of bytes that come through,
732 chopping the sub-process if it exceeds some limit.
733
734 However, this means we want to run a sub-process with both its input and output
735 attached to pipes. We can't handle that easily from a single parent process
736 using straightforward code such as the transport_write_message() function
737 because the subprocess might not be reading its input because it is trying to
738 write to a full output pipe. The complication of redesigning the world to
739 handle this is too great - simpler just to run another process to do the
740 reading of the output pipe. */
741
742
743 /* As this is a local transport, we are already running with the required
744 uid/gid and current directory. Request that the new process be a process group
745 leader, so we can kill it and all its children on a timeout. */
746
747 if ((pid = child_open(USS argv, envp, ob->umask, &fd_in, &fd_out, TRUE)) < 0)
748 {
749 addr->transport_return = DEFER;
750 addr->message = string_sprintf(
751 "Failed to create child process for %s transport: %s", tblock->name,
752 strerror(errno));
753 return FALSE;
754 }
755 tctx.u.fd = fd_in;
756
757 /* Now fork a process to handle the output that comes down the pipe. */
758
759 if ((outpid = fork()) < 0)
760 {
761 addr->basic_errno = errno;
762 addr->transport_return = DEFER;
763 addr->message = string_sprintf(
764 "Failed to create process for handling output in %s transport",
765 tblock->name);
766 (void)close(fd_in);
767 (void)close(fd_out);
768 return FALSE;
769 }
770
771 /* This is the code for the output-handling subprocess. Read from the pipe
772 in chunks, and write to the return file if one is provided. Keep track of
773 the number of bytes handled. If the limit is exceeded, try to kill the
774 subprocess group, and in any case close the pipe and exit, which should cause
775 the subprocess to fail. */
776
777 if (outpid == 0)
778 {
779 int count = 0;
780 (void)close(fd_in);
781 set_process_info("reading output from |%s", cmd);
782 while ((rc = read(fd_out, big_buffer, big_buffer_size)) > 0)
783 {
784 if (addr->return_file >= 0)
785 if(write(addr->return_file, big_buffer, rc) != rc)
786 DEBUG(D_transport) debug_printf("Problem writing to return_file\n");
787 count += rc;
788 if (count > ob->max_output)
789 {
790 DEBUG(D_transport) debug_printf("Too much output from pipe - killed\n");
791 if (addr->return_file >= 0)
792 {
793 uschar *message = US"\n\n*** Too much output - remainder discarded ***\n";
794 rc = Ustrlen(message);
795 if(write(addr->return_file, message, rc) != rc)
796 DEBUG(D_transport) debug_printf("Problem writing to return_file\n");
797 }
798 killpg(pid, SIGKILL);
799 break;
800 }
801 }
802 (void)close(fd_out);
803 _exit(0);
804 }
805
806 (void)close(fd_out); /* Not used in this process */
807
808
809 /* Carrying on now with the main parent process. Attempt to write the message
810 to it down the pipe. It is a fallacy to think that you can detect write errors
811 when the sub-process fails to read the pipe. The parent process may complete
812 writing and close the pipe before the sub-process completes. We could sleep a
813 bit here to let the sub-process get going, but it may still not complete. So we
814 ignore all writing errors. (When in the test harness, we do do a short sleep so
815 any debugging output is likely to be in the same order.) */
816
817 if (f.running_in_test_harness) millisleep(500);
818
819 DEBUG(D_transport) debug_printf("Writing message to pipe\n");
820
821 /* Arrange to time out writes if there is a timeout set. */
822
823 if (timeout > 0)
824 {
825 sigalrm_seen = FALSE;
826 transport_write_timeout = timeout;
827 }
828
829 /* Reset the counter of bytes written */
830
831 transport_count = 0;
832
833 /* First write any configured prefix information */
834
835 if (ob->message_prefix != NULL)
836 {
837 uschar *prefix = expand_string(ob->message_prefix);
838 if (prefix == NULL)
839 {
840 addr->transport_return = f.search_find_defer? DEFER : PANIC;
841 addr->message = string_sprintf("Expansion of \"%s\" (prefix for %s "
842 "transport) failed: %s", ob->message_prefix, tblock->name,
843 expand_string_message);
844 return FALSE;
845 }
846 if (!transport_write_block(&tctx, prefix, Ustrlen(prefix), FALSE))
847 goto END_WRITE;
848 }
849
850 /* If the use_bsmtp option is set, we need to write SMTP prefix information.
851 The various different values for batching are handled outside; if there is more
852 than one address available here, all must be included. Force SMTP dot-handling.
853 */
854
855 if (ob->use_bsmtp)
856 {
857 address_item *a;
858
859 if (!transport_write_string(fd_in, "MAIL FROM:<%s>%s", return_path, eol))
860 goto END_WRITE;
861
862 for (a = addr; a; a = a->next)
863 if (!transport_write_string(fd_in,
864 "RCPT TO:<%s>%s",
865 transport_rcpt_address(a, tblock->rcpt_include_affixes),
866 eol))
867 goto END_WRITE;
868
869 if (!transport_write_string(fd_in, "DATA%s", eol)) goto END_WRITE;
870 }
871
872 /* Now the actual message */
873
874 if (!transport_write_message(&tctx, 0))
875 goto END_WRITE;
876
877 /* Now any configured suffix */
878
879 if (ob->message_suffix)
880 {
881 uschar *suffix = expand_string(ob->message_suffix);
882 if (!suffix)
883 {
884 addr->transport_return = f.search_find_defer? DEFER : PANIC;
885 addr->message = string_sprintf("Expansion of \"%s\" (suffix for %s "
886 "transport) failed: %s", ob->message_suffix, tblock->name,
887 expand_string_message);
888 return FALSE;
889 }
890 if (!transport_write_block(&tctx, suffix, Ustrlen(suffix), FALSE))
891 goto END_WRITE;
892 }
893
894 /* If local_smtp, write the terminating dot. */
895
896 if (ob->use_bsmtp && !transport_write_string(fd_in, ".%s", eol))
897 goto END_WRITE;
898
899 /* Flag all writing completed successfully. */
900
901 written_ok = TRUE;
902
903 /* Come here if there are errors during writing. */
904
905 END_WRITE:
906
907 /* OK, the writing is now all done. Close the pipe. */
908
909 (void) close(fd_in);
910
911 /* Handle errors during writing. For timeouts, set the timeout for waiting for
912 the child process to 1 second. If the process at the far end of the pipe died
913 without reading all of it, we expect an EPIPE error, which should be ignored.
914 We used also to ignore WRITEINCOMPLETE but the writing function is now cleverer
915 at handling OS where the death of a pipe doesn't give EPIPE immediately. See
916 comments therein. */
917
918 if (!written_ok)
919 {
920 if (errno == ETIMEDOUT)
921 {
922 addr->message = string_sprintf("%stimeout while writing to pipe",
923 f.transport_filter_timed_out ? "transport filter " : "");
924 addr->transport_return = ob->timeout_defer? DEFER : FAIL;
925 timeout = 1;
926 }
927 else if (errno == EPIPE)
928 {
929 debug_printf("transport error EPIPE ignored\n");
930 }
931 else
932 {
933 addr->transport_return = PANIC;
934 addr->basic_errno = errno;
935 if (errno == ERRNO_CHHEADER_FAIL)
936 addr->message =
937 string_sprintf("Failed to expand headers_add or headers_remove: %s",
938 expand_string_message);
939 else if (errno == ERRNO_FILTER_FAIL)
940 addr->message = string_sprintf("Transport filter process failed (%d)%s",
941 addr->more_errno,
942 (addr->more_errno == EX_EXECFAILED)? ": unable to execute command" : "");
943 else if (errno == ERRNO_WRITEINCOMPLETE)
944 addr->message = string_sprintf("Failed repeatedly to write data");
945 else
946 addr->message = string_sprintf("Error %d", errno);
947 return FALSE;
948 }
949 }
950
951 /* Wait for the child process to complete and take action if the returned
952 status is nonzero. The timeout will be just 1 second if any of the writes
953 above timed out. */
954
955 if ((rc = child_close(pid, timeout)) != 0)
956 {
957 uschar *tmsg = (addr->message == NULL)? US"" :
958 string_sprintf(" (preceded by %s)", addr->message);
959
960 /* The process did not complete in time; kill its process group and fail
961 the delivery. It appears to be necessary to kill the output process too, as
962 otherwise it hangs on for some time if the actual pipe process is sleeping.
963 (At least, that's what I observed on Solaris 2.5.1.) Since we are failing
964 the delivery, that shouldn't cause any problem. */
965
966 if (rc == -256)
967 {
968 killpg(pid, SIGKILL);
969 kill(outpid, SIGKILL);
970 addr->transport_return = ob->timeout_defer? DEFER : FAIL;
971 addr->message = string_sprintf("pipe delivery process timed out%s", tmsg);
972 }
973
974 /* Wait() failed. */
975
976 else if (rc == -257)
977 {
978 addr->transport_return = PANIC;
979 addr->message = string_sprintf("Wait() failed for child process of %s "
980 "transport: %s%s", tblock->name, strerror(errno), tmsg);
981 }
982
983 /* Since the transport_filter timed out we assume it has sent the child process
984 a malformed or incomplete data stream. Kill off the child process
985 and prevent checking its exit status as it will has probably exited in error.
986 This prevents the transport_filter timeout message from getting overwritten
987 by the exit error which is not the cause of the problem. */
988
989 else if (f.transport_filter_timed_out)
990 {
991 killpg(pid, SIGKILL);
992 kill(outpid, SIGKILL);
993 }
994
995 /* Either the process completed, but yielded a non-zero (necessarily
996 positive) status, or the process was terminated by a signal (rc will contain
997 the negation of the signal number). Treat killing by signal as failure unless
998 status is being ignored. By default, the message is bounced back, unless
999 freeze_signal is set, in which case it is frozen instead. */
1000
1001 else if (rc < 0)
1002 {
1003 if (ob->freeze_signal)
1004 {
1005 addr->transport_return = DEFER;
1006 addr->special_action = SPECIAL_FREEZE;
1007 addr->message = string_sprintf("Child process of %s transport (running "
1008 "command \"%s\") was terminated by signal %d (%s)%s", tblock->name, cmd,
1009 -rc, os_strsignal(-rc), tmsg);
1010 }
1011 else if (!ob->ignore_status)
1012 {
1013 addr->transport_return = FAIL;
1014 addr->message = string_sprintf("Child process of %s transport (running "
1015 "command \"%s\") was terminated by signal %d (%s)%s", tblock->name, cmd,
1016 -rc, os_strsignal(-rc), tmsg);
1017 }
1018 }
1019
1020 /* For positive values (process terminated with non-zero status), we need a
1021 status code to request deferral. A number of systems contain the following
1022 line in sysexits.h:
1023
1024 #define EX_TEMPFAIL 75
1025
1026 with the description
1027
1028 EX_TEMPFAIL -- temporary failure, indicating something that
1029 is not really an error. In sendmail, this means
1030 that a mailer (e.g.) could not create a connection,
1031 and the request should be reattempted later.
1032
1033 Based on this, we use exit code EX_TEMPFAIL as a default to mean "defer" when
1034 not ignoring the returned status. However, there is now an option that
1035 contains a list of temporary codes, with TEMPFAIL and CANTCREAT as defaults.
1036
1037 Another case that needs special treatment is if execve() failed (typically
1038 the command that was given is a non-existent path). By default this is
1039 treated as just another failure, but if freeze_exec_fail is set, the reaction
1040 is to freeze the message rather than bounce the address. Exim used to signal
1041 this failure with EX_UNAVAILABLE, which is defined in many systems as
1042
1043 #define EX_UNAVAILABLE 69
1044
1045 with the description
1046
1047 EX_UNAVAILABLE -- A service is unavailable. This can occur
1048 if a support program or file does not exist. This
1049 can also be used as a catchall message when something
1050 you wanted to do doesn't work, but you don't know why.
1051
1052 However, this can be confused with a command that actually returns 69 because
1053 something *it* wanted is unavailable. At release 4.21, Exim was changed to
1054 use return code 127 instead, because this is what the shell returns when it
1055 is unable to exec a command. We define it as EX_EXECFAILED, and use it in
1056 child.c to signal execve() failure and other unexpected failures such as
1057 setuid() not working - though that won't be the case here because we aren't
1058 changing uid. */
1059
1060 else
1061 {
1062 /* Always handle execve() failure specially if requested to */
1063
1064 if (ob->freeze_exec_fail && (rc == EX_EXECFAILED))
1065 {
1066 addr->transport_return = DEFER;
1067 addr->special_action = SPECIAL_FREEZE;
1068 addr->message = string_sprintf("pipe process failed to exec \"%s\"%s",
1069 cmd, tmsg);
1070 }
1071
1072 /* Otherwise take action only if not ignoring status */
1073
1074 else if (!ob->ignore_status)
1075 {
1076 uschar *ss;
1077 gstring * g;
1078 int i;
1079
1080 /* If temp_errors is "*" all codes are temporary. Initialization checks
1081 that it's either "*" or a list of numbers. If not "*", scan the list of
1082 temporary failure codes; if any match, the result is DEFER. */
1083
1084 if (ob->temp_errors[0] == '*')
1085 addr->transport_return = DEFER;
1086
1087 else
1088 {
1089 const uschar *s = ob->temp_errors;
1090 uschar *p;
1091 int sep = 0;
1092
1093 addr->transport_return = FAIL;
1094 while ((p = string_nextinlist(&s,&sep,NULL,0)))
1095 if (rc == Uatoi(p)) { addr->transport_return = DEFER; break; }
1096 }
1097
1098 /* Ensure the message contains the expanded command and arguments. This
1099 doesn't have to be brilliantly efficient - it is an error situation. */
1100
1101 addr->message = string_sprintf("Child process of %s transport returned "
1102 "%d", tblock->name, rc);
1103 g = string_cat(NULL, addr->message);
1104
1105 /* If the return code is > 128, it often means that a shell command
1106 was terminated by a signal. */
1107
1108 ss = (rc > 128)?
1109 string_sprintf("(could mean shell command ended by signal %d (%s))",
1110 rc-128, os_strsignal(rc-128)) :
1111 US os_strexit(rc);
1112
1113 if (*ss != 0)
1114 {
1115 g = string_catn(g, US" ", 1);
1116 g = string_cat (g, ss);
1117 }
1118
1119 /* Now add the command and arguments */
1120
1121 g = string_catn(g, US" from command:", 14);
1122
1123 for (i = 0; i < sizeof(argv)/sizeof(int *) && argv[i] != NULL; i++)
1124 {
1125 BOOL quote = FALSE;
1126 g = string_catn(g, US" ", 1);
1127 if (Ustrpbrk(argv[i], " \t") != NULL)
1128 {
1129 quote = TRUE;
1130 g = string_catn(g, US"\"", 1);
1131 }
1132 g = string_cat(g, argv[i]);
1133 if (quote)
1134 g = string_catn(g, US"\"", 1);
1135 }
1136
1137 /* Add previous filter timeout message, if present. */
1138
1139 if (*tmsg)
1140 g = string_cat(g, tmsg);
1141
1142 addr->message = string_from_gstring(g);
1143 }
1144 }
1145 }
1146
1147 /* Ensure all subprocesses (in particular, the output handling process)
1148 are complete before we pass this point. */
1149
1150 while (wait(&rc) >= 0);
1151
1152 DEBUG(D_transport) debug_printf("%s transport yielded %d\n", tblock->name,
1153 addr->transport_return);
1154
1155 /* If there has been a problem, the message in addr->message contains details
1156 of the pipe command. We don't want to expose these to the world, so we set up
1157 something bland to return to the sender. */
1158
1159 if (addr->transport_return != OK)
1160 addr->user_message = US"local delivery failed";
1161
1162 return FALSE;
1163 }
1164
1165 #endif /*!MACRO_PREDEF*/
1166 /* End of transport/pipe.c */