diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:36:47 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 17:36:47 +0000 |
commit | 0441d265f2bb9da249c7abf333f0f771fadb4ab5 (patch) | |
tree | 3f3789daa2f6db22da6e55e92bee0062a7d613fe /src/util/rawlog.c | |
parent | Initial commit. (diff) | |
download | dovecot-0441d265f2bb9da249c7abf333f0f771fadb4ab5.tar.xz dovecot-0441d265f2bb9da249c7abf333f0f771fadb4ab5.zip |
Adding upstream version 1:2.3.21+dfsg1.upstream/1%2.3.21+dfsg1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/util/rawlog.c')
-rw-r--r-- | src/util/rawlog.c | 428 |
1 files changed, 428 insertions, 0 deletions
diff --git a/src/util/rawlog.c b/src/util/rawlog.c new file mode 100644 index 0000000..f4e428b --- /dev/null +++ b/src/util/rawlog.c @@ -0,0 +1,428 @@ +/* Copyright (c) 2002-2018 Dovecot authors, see the included COPYING file */ + +#include "lib.h" + +#include "ioloop.h" +#include "net.h" +#include "str.h" +#include "write-full.h" +#include "istream.h" +#include "ostream.h" +#include "process-title.h" +#include "restrict-access.h" +#include "time-util.h" +#include "master-service.h" + +#include <unistd.h> +#include <fcntl.h> +#include <sys/stat.h> +#include <sys/socket.h> + +#define OUTBUF_THRESHOLD IO_BLOCK_SIZE +#define RAWLOG_TIMEOUT_FLUSH_MSECS 1000 + +static struct ioloop *ioloop; + +enum rawlog_flags { + RAWLOG_FLAG_LOG_INPUT = 0x01, + RAWLOG_FLAG_LOG_OUTPUT = 0x02, + RAWLOG_FLAG_LOG_TIMESTAMPS = 0x04, + RAWLOG_FLAG_LOG_BOUNDARIES = 0x10, + RAWLOG_FLAG_LOG_IP_IN_FILENAME = 0x20 +}; + +struct rawlog_proxy { + int client_in_fd, client_out_fd, server_fd; + struct io *client_io, *server_io; + struct ostream *client_output, *server_output; + struct timeout *to_flush; + + struct ostream *in_output, *out_output; + enum rawlog_flags flags; + bool prev_lf_in, prev_lf_out; +}; + +static void rawlog_proxy_destroy(struct rawlog_proxy *proxy) +{ + if (proxy->in_output != NULL) { + o_stream_uncork(proxy->in_output); + if (o_stream_finish(proxy->in_output) < 0) { + i_error("write(in) failed: %s", + o_stream_get_error(proxy->in_output)); + } + o_stream_destroy(&proxy->in_output); + } + if (proxy->out_output != NULL) { + o_stream_uncork(proxy->out_output); + if (o_stream_finish(proxy->out_output) < 0) { + i_error("write(out) failed: %s", + o_stream_get_error(proxy->out_output)); + } + o_stream_destroy(&proxy->out_output); + } + io_remove(&proxy->client_io); + io_remove(&proxy->server_io); + timeout_remove(&proxy->to_flush); + + o_stream_destroy(&proxy->client_output); + o_stream_destroy(&proxy->server_output); + + if (close(proxy->client_in_fd) < 0) + i_error("close(client_in_fd) failed: %m"); + if (close(proxy->client_out_fd) < 0) + i_error("close(client_out_fd) failed: %m"); + if (close(proxy->server_fd) < 0) + i_error("close(server_fd) failed: %m"); + i_free(proxy); + + io_loop_stop(ioloop); +} + +static void +write_with_timestamps(struct ostream *output, bool *prev_lf, + const unsigned char *data, size_t size) +{ + T_BEGIN { + const char *timestamp = t_strdup_printf("%ld.%06lu ", + (long)ioloop_timeval.tv_sec, + (unsigned long)ioloop_timeval.tv_usec); + string_t *str = t_str_new(size + 128); + size_t i; + + if (*prev_lf) + str_append(str, timestamp); + + for (i = 0; i < size; i++) { + str_append_c(str, data[i]); + if (data[i] == '\n' && i+1 != size) + str_append(str, timestamp); + } + *prev_lf = data[i-1] == '\n'; + o_stream_nsend(output, str_data(str), str_len(str)); + } T_END; +} + +static void proxy_flush_timeout(struct rawlog_proxy *proxy) +{ + bool flushed = TRUE; + + if (o_stream_flush(proxy->in_output) == 0) + flushed = FALSE; + if (o_stream_flush(proxy->out_output) == 0) + flushed = FALSE; + if (flushed) + timeout_remove(&proxy->to_flush); +} + +static void proxy_write_data(struct rawlog_proxy *proxy, struct ostream *output, + bool *prev_lf, const void *data, size_t size) +{ + if (output == NULL || output->closed || size == 0) + return; + + if ((proxy->flags & RAWLOG_FLAG_LOG_BOUNDARIES) != 0) + o_stream_nsend_str(output, "<<<\n"); + + if ((proxy->flags & RAWLOG_FLAG_LOG_TIMESTAMPS) != 0) + write_with_timestamps(output, prev_lf, data, size); + else + o_stream_nsend(output, data, size); + + if ((proxy->flags & RAWLOG_FLAG_LOG_BOUNDARIES) != 0) + o_stream_nsend_str(output, ">>>\n"); + + if (proxy->to_flush == NULL) { + proxy->to_flush = timeout_add(RAWLOG_TIMEOUT_FLUSH_MSECS, + proxy_flush_timeout, proxy); + } +} + +static void proxy_write_in(struct rawlog_proxy *proxy, + const void *data, size_t size) +{ + proxy_write_data(proxy, proxy->in_output, &proxy->prev_lf_in, + data, size); +} + +static void proxy_write_out(struct rawlog_proxy *proxy, + const void *data, size_t size) +{ + proxy_write_data(proxy, proxy->out_output, &proxy->prev_lf_out, + data, size); +} + +static void server_input(struct rawlog_proxy *proxy) +{ + unsigned char buf[OUTBUF_THRESHOLD]; + ssize_t ret; + + if (o_stream_get_buffer_used_size(proxy->client_output) > + OUTBUF_THRESHOLD) { + /* client's output buffer is already quite full. + don't send more until we're below threshold. */ + io_remove(&proxy->server_io); + return; + } + + ret = net_receive(proxy->server_fd, buf, sizeof(buf)); + if (ret > 0) { + o_stream_nsend(proxy->client_output, buf, ret); + proxy_write_out(proxy, buf, ret); + } else if (ret <= 0) + rawlog_proxy_destroy(proxy); +} + +static void client_input(struct rawlog_proxy *proxy) +{ + unsigned char buf[OUTBUF_THRESHOLD]; + ssize_t ret; + + if (o_stream_get_buffer_used_size(proxy->server_output) > + OUTBUF_THRESHOLD) { + /* proxy's output buffer is already quite full. + don't send more until we're below threshold. */ + io_remove(&proxy->client_io); + return; + } + + ret = net_receive(proxy->client_in_fd, buf, sizeof(buf)); + if (ret > 0) { + o_stream_nsend(proxy->server_output, buf, ret); + proxy_write_in(proxy, buf, ret); + } else if (ret < 0) + rawlog_proxy_destroy(proxy); +} + +static int server_output(struct rawlog_proxy *proxy) +{ + if (o_stream_flush(proxy->server_output) < 0) { + rawlog_proxy_destroy(proxy); + return 1; + } + + if (proxy->client_io == NULL && + o_stream_get_buffer_used_size(proxy->server_output) < + OUTBUF_THRESHOLD) { + /* there's again space in proxy's output buffer, so we can + read more from client. */ + proxy->client_io = io_add(proxy->client_in_fd, IO_READ, + client_input, proxy); + } + return 1; +} + +static int client_output(struct rawlog_proxy *proxy) +{ + if (o_stream_flush(proxy->client_output) < 0) { + rawlog_proxy_destroy(proxy); + return 1; + } + + if (proxy->server_io == NULL && + o_stream_get_buffer_used_size(proxy->client_output) < + OUTBUF_THRESHOLD) { + /* there's again space in client's output buffer, so we can + read more from proxy. */ + proxy->server_io = + io_add(proxy->server_fd, IO_READ, server_input, proxy); + } + return 1; +} + +static void proxy_open_logs(struct rawlog_proxy *proxy, const char *path, + const char *ip_addr) +{ + const char *fname, *timestamp; + string_t *path_prefix; + int fd; + + timestamp = t_strflocaltime("%Y%m%d-%H%M%S", time(NULL)); + path_prefix = t_str_new(128); + str_printfa(path_prefix, "%s/", path); + if (ip_addr != NULL && + (proxy->flags & RAWLOG_FLAG_LOG_IP_IN_FILENAME) != 0) + str_printfa(path_prefix, "%s-", ip_addr); + str_printfa(path_prefix, "%s-%s", timestamp, dec2str(getpid())); + + if ((proxy->flags & RAWLOG_FLAG_LOG_INPUT) != 0) { + fname = t_strdup_printf("%s.in", str_c(path_prefix)); + fd = open(fname, O_CREAT|O_EXCL|O_WRONLY, 0600); + if (fd == -1) { + i_error("rawlog_open: creat(%s): %m", fname); + return; + } + proxy->in_output = o_stream_create_fd_file_autoclose(&fd, 0); + o_stream_cork(proxy->in_output); + } + + if ((proxy->flags & RAWLOG_FLAG_LOG_OUTPUT) != 0) { + fname = t_strdup_printf("%s.out", str_c(path_prefix)); + fd = open(fname, O_CREAT|O_EXCL|O_WRONLY, 0600); + if (fd == -1) { + i_error("rawlog_open: creat(%s): %m", fname); + o_stream_destroy(&proxy->in_output); + return; + } + proxy->out_output = o_stream_create_fd_file_autoclose(&fd, 0); + o_stream_cork(proxy->out_output); + } +} + +static struct rawlog_proxy * +rawlog_proxy_create(int client_in_fd, int client_out_fd, int server_fd, + const char *path, const char *ip_addr, + enum rawlog_flags flags) +{ + struct rawlog_proxy *proxy; + + proxy = i_new(struct rawlog_proxy, 1); + proxy->server_fd = server_fd; + proxy->server_output = o_stream_create_fd(server_fd, SIZE_MAX); + o_stream_set_no_error_handling(proxy->server_output, TRUE); + o_stream_set_flush_callback(proxy->server_output, server_output, proxy); + proxy->server_io = io_add(server_fd, IO_READ, server_input, proxy); + + proxy->client_in_fd = client_in_fd; + proxy->client_out_fd = client_out_fd; + proxy->client_output = + o_stream_create_fd(client_out_fd, SIZE_MAX); + o_stream_set_no_error_handling(proxy->client_output, TRUE); + proxy->client_io = io_add(proxy->client_in_fd, IO_READ, + client_input, proxy); + o_stream_set_flush_callback(proxy->client_output, client_output, proxy); + + fd_set_nonblock(client_in_fd, TRUE); + fd_set_nonblock(client_out_fd, TRUE); + + proxy->flags = flags; + + proxy->prev_lf_in = proxy->prev_lf_out = TRUE; + proxy_open_logs(proxy, path, ip_addr); + return proxy; +} + +static void rawlog_open(enum rawlog_flags flags) +{ + const char *chroot_dir, *home, *path; + struct stat st; + int sfd[2]; + pid_t pid; + + chroot_dir = getenv("RESTRICT_CHROOT"); + home = getenv("HOME"); + if (chroot_dir != NULL) + home = t_strconcat(chroot_dir, home, NULL); + else if (home == NULL) + home = "."; + + /* see if we want rawlog */ + path = t_strconcat(home, "/dovecot.rawlog", NULL); + if (lstat(path, &st) < 0) { + if (errno != ENOENT) + i_warning("lstat() failed for %s: %m", path); + else if (getenv("DEBUG") != NULL) + i_info("rawlog: %s doesn't exist", path); + return; + } + if (!S_ISDIR(st.st_mode)) { + if (getenv("DEBUG") != NULL) + i_info("rawlog: %s is not a directory", path); + return; + } + + if (chroot_dir != NULL) { + /* we'll chroot soon. skip over the chroot in the path. */ + path += strlen(chroot_dir); + } + + if (socketpair(AF_UNIX, SOCK_STREAM, 0, sfd) < 0) + i_fatal("socketpair() failed: %m"); + fd_set_nonblock(sfd[0], TRUE); + fd_set_nonblock(sfd[1], TRUE); + + pid = fork(); + if (pid < 0) + i_fatal("fork() failed: %m"); + + if (pid > 0) { + /* parent */ + if (dup2(sfd[1], 0) < 0) + i_fatal("dup2(sfd, 0)"); + if (dup2(sfd[1], 1) < 0) + i_fatal("dup2(sfd, 1)"); + i_close_fd(&sfd[0]); + i_close_fd(&sfd[1]); + return; + } + i_close_fd(&sfd[1]); + + restrict_access_by_env(0, getenv("HOME")); + + process_title_set(t_strdup_printf("[%s:%s rawlog]", getenv("USER"), + dec2str(getppid()))); + + ioloop = io_loop_create(); + (void)rawlog_proxy_create(0, 1, sfd[0], path, getenv("IP"), flags); + io_loop_run(ioloop); + io_loop_destroy(&ioloop); + + lib_deinit(); + lib_exit(0); +} + +int main(int argc, char *argv[]) +{ + const enum master_service_flags service_flags = + MASTER_SERVICE_FLAG_DONT_SEND_STATS; + char *executable, *p; + enum rawlog_flags flags = + RAWLOG_FLAG_LOG_INPUT | RAWLOG_FLAG_LOG_OUTPUT; + int c; + + master_service = master_service_init("rawlog", service_flags, + &argc, &argv, "+f:bIt"); + while ((c = master_getopt(master_service)) > 0) { + switch (c) { + case 'f': + if (strcmp(optarg, "in") == 0) + flags &= ENUM_NEGATE(RAWLOG_FLAG_LOG_OUTPUT); + else if (strcmp(optarg, "out") == 0) + flags &= ENUM_NEGATE(RAWLOG_FLAG_LOG_INPUT); + else + i_fatal("Invalid filter: %s", optarg); + break; + case 'b': + flags |= RAWLOG_FLAG_LOG_BOUNDARIES; + break; + case 'I': + flags |= RAWLOG_FLAG_LOG_IP_IN_FILENAME; + break; + case 't': + flags |= RAWLOG_FLAG_LOG_TIMESTAMPS; + break; + default: + return FATAL_DEFAULT; + } + } + argc -= optind; + argv += optind; + + if (argc < 1) + i_fatal("Usage: rawlog [-f in|out] [-I] [-b] [-t] <binary> <arguments>"); + + master_service_init_log(master_service); + master_service_init_finish(master_service); + + executable = argv[0]; + rawlog_open(flags); + + /* hide the executable path, it's ugly */ + p = strrchr(argv[0], '/'); + if (p != NULL) argv[0] = p+1; + execv(executable, argv); + + i_fatal_status(FATAL_EXEC, "execv(%s) failed: %m", executable); + + /* not reached */ + return FATAL_EXEC; +} |