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