Adding upstream version 1:2.3.19.1+dfsg1.upstream/1%2.3.19.1+dfsg1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 556 insertions, 0 deletions

diff --git a/src/lib-program-client/program-client-local.c b/src/lib-program-client/program-client-local.c
new file mode 100644
index 0000000..499b2b5
--- /dev/null
+++ b/src/lib-program-client/program-client-local.c
@@ -0,0 +1,556 @@
+/* Copyright (c) 2002-2018 Dovecot authors, see the included COPYING file */
+
+#include "lib.h"
+#include "lib-signals.h"
+#include "env-util.h"
+#include "execv-const.h"
+#include "array.h"
+#include "net.h"
+#include "istream.h"
+#include "ostream.h"
+#include "restrict-access.h"
+#include "child-wait.h"
+#include "time-util.h"
+#include "program-client-private.h"
+
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/stat.h>
+#include <sys/wait.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <grp.h>
+
+#define KILL_TIMEOUT 5000
+
+struct program_client_local {
+	struct program_client client;
+
+	struct child_wait *child_wait;
+	struct timeout *to_kill;
+
+	char *bin_path;
+
+	pid_t pid;
+	int status;
+	bool exited:1;
+	bool stopping:1;
+	bool sent_term:1;
+};
+
+static void
+program_client_local_waitchild(const struct child_wait_status *status,
+			       struct program_client_local *plclient);
+static void
+program_client_local_disconnect(struct program_client *pclient, bool force);
+static void
+program_client_local_exited(struct program_client_local *plclient);
+
+static void
+exec_child(const char *bin_path, const char *const *args,
+	   ARRAY_TYPE(const_string) *envs, int in_fd, int out_fd,
+	   int *extra_fds, bool drop_stderr)
+{
+	ARRAY_TYPE(const_string) exec_args;
+
+	/* Setup stdin/stdout */
+
+	if (in_fd < 0)
+		in_fd = dev_null_fd;
+	if (out_fd < 0)
+		out_fd = dev_null_fd;
+
+	if (in_fd != STDIN_FILENO && dup2(in_fd, STDIN_FILENO) < 0)
+		i_fatal("program %s: dup2(stdin) failed: %m", bin_path);
+	if (out_fd != STDOUT_FILENO && dup2(out_fd, STDOUT_FILENO) < 0)
+		i_fatal("program %s: dup2(stdout) failed: %m", bin_path);
+
+	if (in_fd != STDIN_FILENO && in_fd != dev_null_fd && close(in_fd) < 0)
+		i_error("program %s: close(in_fd) failed: %m", bin_path);
+	if (out_fd != STDOUT_FILENO && out_fd != dev_null_fd &&
+	    (out_fd != in_fd) && close(out_fd) < 0)
+		i_error("program %s: close(out_fd) failed: %m", bin_path);
+
+	/* Drop stderr if requested */
+	if (drop_stderr) {
+		if (dup2(dev_null_fd, STDERR_FILENO) < 0) {
+			i_fatal("program %s: "
+				"dup2(stderr) failed: %m", bin_path);
+		}
+	}
+
+	/* Setup extra fds */
+	if (extra_fds != NULL) {
+		int *efd;
+		for(efd = extra_fds; *efd != -1; efd += 2) {
+			i_assert(efd[1] != STDIN_FILENO);
+			i_assert(efd[1] != STDOUT_FILENO);
+			i_assert(efd[1] != STDERR_FILENO);
+			if (efd[0] != efd[1]) {
+				if (dup2(efd[0], efd[1]) < 0) {
+					i_fatal("program %s"
+						"dup2(extra_fd=%d) failed: %m",
+						bin_path, efd[1]);
+				}
+			}
+		}
+		for(efd = extra_fds; *efd != -1; efd += 2) {
+			if (efd[0] != efd[1] && efd[0] != STDIN_FILENO &&
+			    efd[0] != STDOUT_FILENO &&
+			    efd[0] != STDERR_FILENO) {
+				if (close(efd[0]) < 0) {
+					i_error("program %s"
+						"close(extra_fd=%d) failed: %m",
+						bin_path, efd[1]);
+				}
+			}
+		}
+	}
+
+	/* Compose argv */
+
+	t_array_init(&exec_args, 16);
+	array_push_back(&exec_args, &bin_path);
+	if (args != NULL) {
+		for(; *args != NULL; args++)
+			array_push_back(&exec_args, args);
+	}
+	(void) array_append_space(&exec_args);
+
+	/* Setup environment */
+
+	env_clean();
+	if (array_is_created(envs)) {
+		array_append_zero(envs);
+		env_put_array(array_front(envs));
+	}
+
+	/* Execute */
+
+	args = array_front(&exec_args);
+	execvp_const(args[0], args);
+}
+
+static void
+program_client_local_waitchild(const struct child_wait_status *status,
+			       struct program_client_local *plclient)
+{
+	struct program_client *pclient = &plclient->client;
+
+	i_assert(plclient->pid == status->pid);
+
+	e_debug(pclient->event, "Child process ended");
+
+	plclient->status = status->status;
+	plclient->exited = TRUE;
+	plclient->pid = -1;
+
+	if (plclient->stopping ||
+	    (pclient->fd_in < 0 && pclient->fd_out < 0))
+		program_client_local_exited(plclient);
+}
+
+static int
+program_client_local_connect(struct program_client *pclient)
+{
+	struct program_client_local *plclient =
+		(struct program_client_local *)pclient;
+	int fd_in[2] = { -1, -1 }, fd_out[2] = {-1, -1};
+	struct program_client_extra_fd *efds = NULL;
+	int *parent_extra_fds = NULL, *child_extra_fds = NULL;
+	unsigned int xfd_count = 0, i;
+
+	/* create normal I/O fds */
+	if (pclient->input != NULL) {
+		if (pipe(fd_in) < 0) {
+			e_error(pclient->event, "pipe(in) failed: %m");
+			return -1;
+		}
+	}
+	if (pclient->output != NULL) {
+		if (pipe(fd_out) < 0) {
+			e_error(pclient->event, "pipe(out) failed: %m");
+			return -1;
+		}
+	}
+
+	/* create pipes for additional output through side-channel fds */
+	if (array_is_created(&pclient->extra_fds)) {
+		int extra_fd[2];
+
+		efds = array_get_modifiable(&pclient->extra_fds, &xfd_count);
+		if (xfd_count > 0) {
+			i_assert(xfd_count < INT_MAX);
+			parent_extra_fds = t_new(int, xfd_count);
+			child_extra_fds = t_new(int, xfd_count * 2 + 1);
+			for(i = 0; i < xfd_count; i++) {
+				if (pipe(extra_fd) < 0) {
+					e_error(pclient->event,
+						"pipe(extra=%d) failed: %m",
+						extra_fd[1]);
+					return -1;
+				}
+				parent_extra_fds[i] = extra_fd[0];
+				child_extra_fds[i * 2 + 0] = extra_fd[1];
+				child_extra_fds[i * 2 + 1] = efds[i].child_fd;
+			}
+			child_extra_fds[xfd_count * 2] = -1;
+		}
+	}
+
+	/* fork child */
+	if ((plclient->pid = fork()) == (pid_t)-1) {
+		e_error(pclient->event, "fork() failed: %m");
+
+		/* clean up */
+		if (fd_in[0] >= 0 && close(fd_in[0]) < 0) {
+			e_error(pclient->event,
+				"close(pipe:in:rd) failed: %m");
+		}
+		if (fd_in[1] >= 0 && close(fd_in[1]) < 0) {
+			e_error(pclient->event,
+				"close(pipe:in:wr) failed: %m");
+		}
+		if (fd_out[0] >= 0 && close(fd_out[0]) < 0) {
+			e_error(pclient->event,
+				"close(pipe:out:rd) failed: %m");
+		}
+		if (fd_out[1] >= 0 && close(fd_out[1]) < 0) {
+			e_error(pclient->event,
+				"close(pipe:out:wr) failed: %m");
+		}
+		for(i = 0; i < xfd_count; i++) {
+			if (close(child_extra_fds[i * 2]) < 0) {
+				e_error(pclient->event,
+					"close(pipe:extra=%d:wr) failed: %m",
+					child_extra_fds[i * 2 + 1]);
+			}
+			if (close(parent_extra_fds[i]) < 0) {
+				e_error(pclient->event,
+					"close(pipe:extra=%d:rd) failed: %m",
+					child_extra_fds[i * 2 + 1]);
+			}
+		}
+		return -1;
+	}
+
+	if (plclient->pid == 0) {
+		/* child */
+		if (fd_in[1] >= 0 && close(fd_in[1]) < 0) {
+			e_error(pclient->event,
+				"close(pipe:in:wr) failed: %m");
+		}
+		if (fd_out[0] >= 0 && close(fd_out[0]) < 0) {
+			e_error(pclient->event,
+				"close(pipe:out:rd) failed: %m");
+		}
+		for(i = 0; i < xfd_count; i++) {
+			if (close(parent_extra_fds[i]) < 0) {
+				e_error(pclient->event,
+					"close(pipe:extra=%d:rd) failed: %m",
+					child_extra_fds[i * 2 + 1]);
+			}
+		}
+
+		/* if we want to allow root, then we will not drop
+		   root privileges */
+		restrict_access(&pclient->set.restrict_set,
+				(pclient->set.allow_root ?
+					RESTRICT_ACCESS_FLAG_ALLOW_ROOT : 0),
+				pclient->set.home);
+
+		exec_child(plclient->bin_path, pclient->args, &pclient->envs,
+			   fd_in[0], fd_out[1], child_extra_fds,
+			   pclient->set.drop_stderr);
+		i_unreached();
+	}
+
+	/* parent */
+	e_debug(pclient->event, "Forked child process");
+
+	program_client_set_label(pclient,
+		t_strdup_printf("exec:%s (%d)", plclient->bin_path,
+				plclient->pid));
+
+	if (fd_in[0] >= 0 && close(fd_in[0]) < 0) {
+		e_error(pclient->event, "close(pipe:in:rd) failed: %m");
+	}
+	if (fd_out[1] >= 0 && close(fd_out[1]) < 0) {
+		e_error(pclient->event, "close(pipe:out:wr) failed: %m");
+	}
+	if (fd_in[1] >= 0) {
+		net_set_nonblock(fd_in[1], TRUE);
+		pclient->fd_out = fd_in[1];
+	}
+	if (fd_out[0] >= 0) {
+		net_set_nonblock(fd_out[0], TRUE);
+		pclient->fd_in = fd_out[0];
+	}
+	for(i = 0; i < xfd_count; i++) {
+		if (close(child_extra_fds[i * 2]) < 0) {
+			e_error(pclient->event,
+				"close(pipe:extra=%d:wr) failed: %m",
+				child_extra_fds[i * 2 + 1]);
+		}
+		net_set_nonblock(parent_extra_fds[i], TRUE);
+		efds[i].parent_fd = parent_extra_fds[i];
+	}
+
+	program_client_init_streams(pclient);
+
+	plclient->child_wait =
+		child_wait_new_with_pid(plclient->pid,
+					program_client_local_waitchild,
+					plclient);
+	program_client_connected(pclient);
+	return 0;
+}
+
+static int
+program_client_local_close_output(struct program_client *pclient)
+{
+	int fd_out = pclient->fd_out;
+
+	pclient->fd_out = -1;
+
+	/* Shutdown output; program stdin will get EOF */
+	if (fd_out >= 0 && close(fd_out) < 0) {
+		e_error(pclient->event,
+			"close(fd_out) failed: %m");
+		return -1;
+	}
+	return 1;
+}
+
+static void
+program_client_local_exited(struct program_client_local *plclient)
+{
+	struct program_client *pclient = &plclient->client;
+
+	timeout_remove(&plclient->to_kill);
+	if (plclient->child_wait != NULL)
+		child_wait_free(&plclient->child_wait);
+
+	plclient->exited = TRUE;
+	plclient->pid = -1;
+	/* Evaluate child exit status */
+	pclient->exit_status = PROGRAM_CLIENT_EXIT_STATUS_INTERNAL_FAILURE;
+
+	if (WIFEXITED(plclient->status)) {
+		/* Exited */
+		int exit_code = WEXITSTATUS(plclient->status);
+
+		if (exit_code != 0) {
+			e_info(pclient->event,
+			       "Terminated with non-zero exit code %d",
+			       exit_code);
+			pclient->exit_status =
+				PROGRAM_CLIENT_EXIT_STATUS_FAILURE;
+		} else {
+			pclient->exit_status =
+				PROGRAM_CLIENT_EXIT_STATUS_SUCCESS;
+		}
+	} else if (WIFSIGNALED(plclient->status)) {
+		/* Killed with a signal */
+		if (plclient->sent_term) {
+			e_error(pclient->event,
+				"Forcibly terminated with signal %d",
+				WTERMSIG(plclient->status));
+		} else {
+			e_error(pclient->event,
+				"Terminated abnormally with signal %d",
+				WTERMSIG(plclient->status));
+		}
+	} else if (WIFSTOPPED(plclient->status)) {
+		/* Stopped */
+		e_error(pclient->event,
+			"Stopped with signal %d",
+			WSTOPSIG(plclient->status));
+	} else {
+		/* Something else */
+		e_error(pclient->event,
+			"Terminated abnormally with status %d",
+			plclient->status);
+	}
+
+	program_client_disconnected(pclient);
+}
+
+static void
+program_client_local_kill_now(struct program_client_local *plclient)
+{
+	struct program_client *pclient = &plclient->client;
+
+	if (plclient->child_wait != NULL) {
+		/* no need for this anymore */
+		child_wait_free(&plclient->child_wait);
+	}
+
+	if (plclient->pid < 0)
+		return;
+
+	e_debug(pclient->event, "Sending SIGKILL signal to program");
+
+	/* kill it brutally now: it should die right away */
+	if (kill(plclient->pid, SIGKILL) < 0) {
+		e_error(pclient->event,
+			"Failed to send SIGKILL signal to program");
+	} else if (waitpid(plclient->pid, &plclient->status, 0) < 0) {
+		e_error(pclient->event, "waitpid(%d) failed: %m",
+			plclient->pid);
+	}
+}
+
+static void
+program_client_local_kill(struct program_client_local *plclient)
+{
+	struct program_client *pclient = &plclient->client;
+
+	/* time to die */
+	timeout_remove(&plclient->to_kill);
+
+	i_assert(plclient->pid != (pid_t)-1);
+
+	if (plclient->client.error == PROGRAM_CLIENT_ERROR_NONE)
+		plclient->client.error = PROGRAM_CLIENT_ERROR_RUN_TIMEOUT;
+
+	if (plclient->sent_term) {
+		/* Timed out again */
+		e_debug(pclient->event,
+			"Program did not die after %d milliseconds",
+			KILL_TIMEOUT);
+
+		program_client_local_kill_now(plclient);
+		program_client_local_exited(plclient);
+		return;
+	}
+
+	e_debug(pclient->event,
+		"Execution timed out after %u milliseconds: "
+		"Sending TERM signal",
+		pclient->set.input_idle_timeout_msecs);
+
+	/* send sigterm, keep on waiting */
+	plclient->sent_term = TRUE;
+
+	/* Kill child gently first */
+	if (kill(plclient->pid, SIGTERM) < 0) {
+		e_error(pclient->event,
+			"Failed to send SIGTERM signal to program");
+		(void)kill(plclient->pid, SIGKILL);
+		program_client_local_exited(plclient);
+		return;
+	}
+
+	i_assert(plclient->child_wait != NULL);
+
+	plclient->to_kill = timeout_add_short(KILL_TIMEOUT,
+			    program_client_local_kill, plclient);
+}
+
+static void
+program_client_local_disconnect(struct program_client *pclient, bool force)
+{
+	struct program_client_local *plclient =
+		(struct program_client_local *) pclient;
+	pid_t pid = plclient->pid;
+	unsigned long runtime, timeout = 0;
+
+	if (plclient->exited) {
+		program_client_local_exited(plclient);
+		return;
+	}
+
+	if (plclient->stopping) return;
+	plclient->stopping = TRUE;
+
+	if (pid < 0) {
+		/* program never started */
+		e_debug(pclient->event, "Child process never started");
+		pclient->exit_status = PROGRAM_CLIENT_EXIT_STATUS_FAILURE;
+		program_client_local_exited(plclient);
+		return;
+	}
+
+	/* make sure it hasn't already been reaped */
+	if (waitpid(plclient->pid, &plclient->status, WNOHANG) > 0) {
+		e_debug(pclient->event, "Child process ended");
+		program_client_local_exited(plclient);
+		return;
+	}
+
+	/* Calculate timeout */
+	runtime = timeval_diff_msecs(&ioloop_timeval, &pclient->start_time);
+	if (force || (pclient->set.input_idle_timeout_msecs > 0 &&
+		      runtime >= pclient->set.input_idle_timeout_msecs)) {
+		e_debug(pclient->event,
+			"Terminating program immediately");
+
+		program_client_local_kill(plclient);
+		return;
+	}
+
+	if (runtime < pclient->set.input_idle_timeout_msecs)
+		timeout = pclient->set.input_idle_timeout_msecs - runtime;
+
+	e_debug(pclient->event,
+		"Waiting for program to finish after %lu msecs "
+		"(timeout = %lu msecs)", runtime, timeout);
+
+	if (timeout == 0)
+		return;
+
+	plclient->to_kill = timeout_add_short(timeout,
+					      program_client_local_kill,
+					      plclient);
+}
+
+static void
+program_client_local_destroy(struct program_client *pclient)
+{
+	struct program_client_local *plclient =
+		(struct program_client_local *)pclient;
+
+	timeout_remove(&plclient->to_kill);
+
+	program_client_local_kill_now(plclient);
+	child_wait_deinit();
+}
+
+static void
+program_client_local_switch_ioloop(struct program_client *pclient)
+{
+	struct program_client_local *plclient =
+		(struct program_client_local *)pclient;
+
+	if (plclient->to_kill != NULL)
+		plclient->to_kill = io_loop_move_timeout(&plclient->to_kill);
+	child_wait_switch_ioloop();
+}
+
+struct program_client *
+program_client_local_create(const char *bin_path,
+			    const char *const *args,
+			    const struct program_client_settings *set)
+{
+	struct program_client_local *plclient;
+	const char *label;
+	pool_t pool;
+
+	label = t_strconcat("exec:", bin_path, NULL);
+
+	pool = pool_alloconly_create("program client local", 1024);
+	plclient = p_new(pool, struct program_client_local, 1);
+	program_client_init(&plclient->client, pool, label, args, set);
+	plclient->client.connect = program_client_local_connect;
+	plclient->client.close_output = program_client_local_close_output;
+	plclient->client.switch_ioloop = program_client_local_switch_ioloop;
+	plclient->client.disconnect = program_client_local_disconnect;
+	plclient->client.destroy = program_client_local_destroy;
+	plclient->bin_path = p_strdup(pool, bin_path);
+	plclient->pid = -1;
+
+	child_wait_init();
+
+	return &plclient->client;
+}