Rename iolog_plugin.h to log_client.h.

It is no longer I/O log specific and is used by sudoers_audit too.
2025-08-31 22:35:10 +00:00 · 2020-11-09 17:13:04 -07:00
parent 62547746d3
commit e56c3b342b
6 changed files with 43 additions and 45 deletions
--- a/plugins/sudoers/log_client.h
+++ b/plugins/sudoers/log_client.h
@@ -0,0 +1,121 @@
+/*
+ * SPDX-License-Identifier: ISC
+ *
+ * Copyright (c) 2019-2020 Todd C. Miller <Todd.Miller@sudo.ws>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#ifndef SUDOERS_LOG_CLIENT_H
+#define SUDOERS_LOG_CLIENT_H
+
+#include <netinet/in.h>			/* for INET6?_ADDRSTRLEN */
+#if defined(HAVE_OPENSSL)
+# include <openssl/ssl.h>
+#endif /* HAVE_OPENSSL */
+
+#include "log_server.pb-c.h"
+#include "strlist.h"
+
+#if PROTOBUF_C_VERSION_NUMBER < 1003000
+# error protobuf-c version 1.30 or higher required
+#endif
+
+/* Default ports to listen on */
+#define DEFAULT_PORT		"30343"
+#define DEFAULT_PORT_TLS	"30344"
+
+/* Maximum message size (2Mb) */
+#define MESSAGE_SIZE_MAX	(2 * 1024 * 1024)
+
+/* TODO - share with logsrvd/sendlog */
+struct connection_buffer {
+    TAILQ_ENTRY(connection_buffer) entries;
+    uint8_t *data;
+    unsigned int size;
+    unsigned int len;
+    unsigned int off;
+};
+TAILQ_HEAD(connection_buffer_list, connection_buffer);
+
+struct log_details {
+    struct eventlog *evlog;
+    struct sudoers_str_list *log_servers;
+    struct timespec server_timeout;
+#if defined(HAVE_OPENSSL)
+    char *ca_bundle;
+    char *cert_file;
+    char *key_file;
+#endif /* HAVE_OPENSSL */
+    bool keepalive;
+    bool verify_server;
+    bool ignore_log_errors;
+};
+
+enum client_state {
+    ERROR,
+    RECV_HELLO,
+    SEND_RESTART,	/* TODO: currently unimplemented */
+    SEND_ACCEPT,
+    SEND_IO,
+    SEND_EXIT,
+    CLOSING,
+    FINISHED
+};
+
+/* Remote connection closure, non-zero fields must come first. */
+struct client_closure {
+    int sock;
+    bool read_instead_of_write;
+    bool write_instead_of_read;
+    bool temporary_write_event;
+    bool log_io;
+    char *server_name;
+#if defined(HAVE_STRUCT_IN6_ADDR)
+    char server_ip[INET6_ADDRSTRLEN];
+#else
+    char server_ip[INET_ADDRSTRLEN];
+#endif
+#if defined(HAVE_OPENSSL)
+    SSL_CTX *ssl_ctx;
+    SSL *ssl;
+    bool ssl_initialized;
+#endif /* HAVE_OPENSSL */
+    bool disabled;
+    enum client_state state;
+    struct connection_buffer_list write_bufs;
+    struct connection_buffer_list free_bufs;
+    struct connection_buffer read_buf;
+    struct sudo_plugin_event *read_ev;
+    struct sudo_plugin_event *write_ev;
+    struct log_details *log_details;
+    struct timespec start_time;
+    struct timespec elapsed;
+    struct timespec committed;
+    char *iolog_id;
+};
+
+/* iolog_client.c */
+struct client_closure *log_server_open(struct log_details *details, struct timespec *now, bool log_io, struct sudo_plugin_event * (*event_alloc)(void));
+bool log_server_close(struct client_closure *closure, int exit_status, int error);
+bool fmt_accept_message(struct client_closure *closure);
+bool fmt_client_message(struct client_closure *closure, ClientMessage *msg);
+bool fmt_exit_message(struct client_closure *closure, int exit_status, int error);
+bool fmt_io_buf(struct client_closure *closure, int type, const char *buf, unsigned int len, struct timespec *delay);
+bool fmt_suspend(struct client_closure *closure, const char *signame, struct timespec *delay);
+bool fmt_winsize(struct client_closure *closure, unsigned int lines, unsigned int cols, struct timespec *delay);
+bool log_server_connect(struct client_closure *closure);
+void client_closure_free(struct client_closure *closure);
+bool read_server_hello(struct client_closure *closure);
+
+#endif /* SUDOERS_LOG_CLIENT_H */