diff options
author | Todd C. Miller <Todd.Miller@sudo.ws> | 2020-10-26 15:24:35 -0600 |
---|---|---|
committer | Todd C. Miller <Todd.Miller@sudo.ws> | 2020-10-26 15:24:35 -0600 |
commit | 6a2d96a047308113fa4b97ebb02927ac153888dc (patch) | |
tree | 7ebdef5f9cbfeeb20193aa368babf4fc9ac77737 | |
parent | bd71ffde6fb2143f1f4e9f6c4204244542663125 (diff) | |
download | sudo-6a2d96a047308113fa4b97ebb02927ac153888dc.tar.gz |
Refactor eventlog code into a library
-rw-r--r-- | MANIFEST | 3 | ||||
-rw-r--r-- | Makefile.in | 13 | ||||
-rwxr-xr-x | configure | 3 | ||||
-rw-r--r-- | configure.ac | 2 | ||||
-rw-r--r-- | include/sudo_eventlog.h | 95 | ||||
-rw-r--r-- | lib/eventlog/Makefile.in | 187 | ||||
-rw-r--r-- | lib/eventlog/eventlog.c | 737 | ||||
-rw-r--r-- | logsrvd/logsrvd.h | 1 |
8 files changed, 1033 insertions, 8 deletions
@@ -91,6 +91,7 @@ include/sudo_debug.h include/sudo_digest.h include/sudo_dso.h include/sudo_event.h +include/sudo_eventlog.h include/sudo_fatal.h include/sudo_gettext.h include/sudo_iolog.h @@ -101,6 +102,8 @@ include/sudo_queue.h include/sudo_rand.h include/sudo_util.h install-sh +lib/eventlog/Makefile.in +lib/eventlog/eventlog.c lib/iolog/Makefile.in lib/iolog/host_port.c lib/iolog/hostcheck.c diff --git a/Makefile.in b/Makefile.in index be8f44a93..d6b73a596 100644 --- a/Makefile.in +++ b/Makefile.in @@ -56,10 +56,10 @@ shlib_mode = @SHLIB_MODE@ # Version of python detected by configure (major.minor) python_version = @PYTHON_VERSION@ -SUBDIRS = lib/util @ZLIB_SRC@ lib/iolog @LOGSRV_SRC@ @LOGSRVD_SRC@ \ - plugins/audit_json plugins/group_file plugins/sample_approval \ - plugins/sudoers plugins/system_group @PYTHON_PLUGIN_SRC@ src \ - include doc examples +SUBDIRS = lib/util @ZLIB_SRC@ lib/eventlog lib/iolog @LOGSRV_SRC@ \ + @LOGSRVD_SRC@ plugins/audit_json plugins/group_file \ + plugins/sample_approval plugins/sudoers plugins/system_group \ + @PYTHON_PLUGIN_SRC@ src include doc examples SAMPLES = plugins/sample @@ -210,7 +210,7 @@ siglist.c signame.c: depend: siglist.c signame.c $(scriptdir)/mkdep.pl \ --srcdir=$(abs_top_srcdir) --builddir=$(abs_top_builddir) \ - lib/util/Makefile.in lib/zlib/Makefile.in \ + lib/util/Makefile.in lib/zlib/Makefile.in lib/eventlog/Makefile.in \ lib/iolog/Makefile.in lib/logsrv/Makefile.in logsrvd/Makefile.in \ plugins/group_file/Makefile.in plugins/sample/Makefile.in \ plugins/sudoers/Makefile.in plugins/system_group/Makefile.in \ @@ -218,6 +218,7 @@ depend: siglist.c signame.c src/Makefile.in && \ $(top_builddir)/config.status --file $(top_builddir)/lib/util/Makefile \ --file $(top_builddir)/lib/zlib/Makefile \ + --file $(top_builddir)/lib/eventlog/Makefile \ --file $(top_builddir)/lib/iolog/Makefile \ --file $(top_builddir)/lib/logsrv/Makefile \ --file $(top_builddir)/logsrvd/Makefile \ @@ -275,7 +276,7 @@ update-pot: -e 's/^mailsub="/gettext "/p' configure.ac \ >> confstr.sh; \ tmpfiles=confstr.sh; \ - cfiles="lib/iolog/*.c logsrvd/*.c plugins/sudoers/*.c plugins/sudoers/auth/*.c";; \ + cfiles="lib/eventlog/*.c lib/iolog/*.c logsrvd/*.c plugins/sudoers/*.c plugins/sudoers/auth/*.c";; \ *) echo unknown domain $$domain; continue;; \ esac; \ $(XGETTEXT) $(XGETTEXT_OPTS) -d$$domain $$cfiles $$tmpfiles -o $$pot.tmp; \ @@ -28154,7 +28154,7 @@ elif test X"$TMPFILES_D" != X""; then fi -ac_config_files="$ac_config_files Makefile doc/Makefile examples/Makefile examples/sudo.conf include/Makefile lib/iolog/Makefile lib/logsrv/Makefile lib/util/Makefile lib/util/util.exp logsrvd/Makefile src/sudo_usage.h src/Makefile plugins/audit_json/Makefile plugins/sample/Makefile plugins/group_file/Makefile plugins/sample_approval/Makefile plugins/system_group/Makefile plugins/sudoers/Makefile plugins/sudoers/sudoers" +ac_config_files="$ac_config_files Makefile doc/Makefile examples/Makefile examples/sudo.conf include/Makefile lib/eventlog/Makefile lib/iolog/Makefile lib/logsrv/Makefile lib/util/Makefile lib/util/util.exp logsrvd/Makefile src/sudo_usage.h src/Makefile plugins/audit_json/Makefile plugins/sample/Makefile plugins/group_file/Makefile plugins/sample_approval/Makefile plugins/system_group/Makefile plugins/sudoers/Makefile plugins/sudoers/sudoers" cat >confcache <<\_ACEOF @@ -29155,6 +29155,7 @@ do "examples/Makefile") CONFIG_FILES="$CONFIG_FILES examples/Makefile" ;; "examples/sudo.conf") CONFIG_FILES="$CONFIG_FILES examples/sudo.conf" ;; "include/Makefile") CONFIG_FILES="$CONFIG_FILES include/Makefile" ;; + "lib/eventlog/Makefile") CONFIG_FILES="$CONFIG_FILES lib/eventlog/Makefile" ;; "lib/iolog/Makefile") CONFIG_FILES="$CONFIG_FILES lib/iolog/Makefile" ;; "lib/logsrv/Makefile") CONFIG_FILES="$CONFIG_FILES lib/logsrv/Makefile" ;; "lib/util/Makefile") CONFIG_FILES="$CONFIG_FILES lib/util/Makefile" ;; diff --git a/configure.ac b/configure.ac index c76db476d..c91eea73a 100644 --- a/configure.ac +++ b/configure.ac @@ -4809,7 +4809,7 @@ elif test X"$TMPFILES_D" != X""; then AC_CONFIG_FILES([etc/init.d/sudo.conf]) fi -AC_CONFIG_FILES([Makefile doc/Makefile examples/Makefile examples/sudo.conf include/Makefile lib/iolog/Makefile lib/logsrv/Makefile lib/util/Makefile lib/util/util.exp logsrvd/Makefile src/sudo_usage.h src/Makefile plugins/audit_json/Makefile plugins/sample/Makefile plugins/group_file/Makefile plugins/sample_approval/Makefile plugins/system_group/Makefile plugins/sudoers/Makefile plugins/sudoers/sudoers]) +AC_CONFIG_FILES([Makefile doc/Makefile examples/Makefile examples/sudo.conf include/Makefile lib/eventlog/Makefile lib/iolog/Makefile lib/logsrv/Makefile lib/util/Makefile lib/util/util.exp logsrvd/Makefile src/sudo_usage.h src/Makefile plugins/audit_json/Makefile plugins/sample/Makefile plugins/group_file/Makefile plugins/sample_approval/Makefile plugins/system_group/Makefile plugins/sudoers/Makefile plugins/sudoers/sudoers]) AC_OUTPUT diff --git a/include/sudo_eventlog.h b/include/sudo_eventlog.h new file mode 100644 index 000000000..38dc4cf08 --- /dev/null +++ b/include/sudo_eventlog.h @@ -0,0 +1,95 @@ +/* + * SPDX-License-Identifier: ISC + * + * Copyright (c) 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 SUDO_EVENTLOG_H +#define SUDO_EVENTLOG_H + +#include <sys/types.h> /* for gid_t, uid_t */ +#include <time.h> /* for struct timespec */ + +/* Supported event types. */ +enum event_type { + EVLOG_ACCEPT, + EVLOG_REJECT, + EVLOG_ALERT +}; + +/* Supported eventlog types. */ +#define EVLOG_NONE 0x0 +#define EVLOG_SYSLOG 0x2 +#define EVLOG_FILE 0x4 + +/* Supported eventlog formats. */ +enum eventlog_format { + EVLOG_SUDO, + EVLOG_JSON +}; + +/* + * Event log config, used with eventlog_setconf() + */ +struct eventlog_config { + int type; + enum eventlog_format format; + int syslog_acceptpri; + int syslog_rejectpri; + int syslog_alertpri; + int syslog_maxlen; + const char *logpath; + const char *time_fmt; + FILE *(*open_log)(int type, const char *); + void (*close_log)(int type, FILE *); +}; + +/* + * Info present in the eventlog file, regardless of format. + */ +struct eventlog { + char *iolog_path; + const char *iolog_file; /* substring of iolog_path, do not free */ + char *command; + char *cwd; + char *runchroot; + char *runcwd; + char *rungroup; + char *runuser; + char *submithost; + char *submituser; + char *submitgroup; + char *ttyname; + char **argv; + char **env_add; + char **envp; + struct timespec submit_time; + int lines; + int columns; + uid_t runuid; + gid_t rungid; + char sessid[7]; +}; + +/* Callback from eventlog code to write log info */ +struct json_container; +typedef bool (*eventlog_json_callback_t)(struct json_container *, void *); + +bool eventlog_accept(const struct eventlog *details, struct timespec *submit_time, eventlog_json_callback_t info_cb, void *info); +bool eventlog_alert(const struct eventlog *details, struct timespec *alert_time, const char *reason); +bool eventlog_reject(const struct eventlog *details, const char *reason, struct timespec *submit_time, eventlog_json_callback_t info_cb, void *info); +bool eventlog_setconf(struct eventlog_config *conf); + +#endif /* SUDO_EVENTLOG_H */ diff --git a/lib/eventlog/Makefile.in b/lib/eventlog/Makefile.in new file mode 100644 index 000000000..e9276cc99 --- /dev/null +++ b/lib/eventlog/Makefile.in @@ -0,0 +1,187 @@ +# +# SPDX-License-Identifier: ISC +# +# Copyright (c) 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. +# +# @configure_input@ +# + +#### Start of system configuration section. #### + +srcdir = @srcdir@ +abs_srcdir = @abs_srcdir@ +top_srcdir = @top_srcdir@ +abs_top_srcdir = @abs_top_srcdir@ +top_builddir = @top_builddir@ +abs_top_builddir = @abs_top_builddir@ +devdir = @devdir@ +scriptdir = $(top_srcdir)/scripts +incdir = $(top_srcdir)/include + +# Compiler & tools to use +CC = @CC@ +LIBTOOL = @LIBTOOL@ + +# C preprocessor flags +CPPFLAGS = -I$(incdir) -I$(top_builddir) -I$(srcdir) -I$(top_srcdir) @CPPFLAGS@ + +# Usually -O and/or -g +CFLAGS = @CFLAGS@ + +# Flags to pass to libtool +LTFLAGS = @LT_STATIC@ + +# Address sanitizer flags +ASAN_CFLAGS = @ASAN_CFLAGS@ +ASAN_LDFLAGS = @ASAN_LDFLAGS@ + +# PIE flags +PIE_CFLAGS = @PIE_CFLAGS@ +PIE_LDFLAGS = @PIE_LDFLAGS@ + +# Stack smashing protection flags +SSP_CFLAGS = @SSP_CFLAGS@ +SSP_LDFLAGS = @SSP_LDFLAGS@ + +# cppcheck options, usually set in the top-level Makefile +CPPCHECK_OPTS = -q --force --enable=warning,performance,portability --suppress=constStatement --error-exitcode=1 --inline-suppr -Dva_copy=va_copy -U__cplusplus -UQUAD_MAX -UQUAD_MIN -UUQUAD_MAX -U_POSIX_HOST_NAME_MAX -U_POSIX_PATH_MAX -U__NBBY -DNSIG=64 + +# splint options, usually set in the top-level Makefile +SPLINT_OPTS = -D__restrict= -checks + +# PVS-studio options +PVS_CFG = $(top_srcdir)/PVS-Studio.cfg +PVS_IGNORE = 'V707,V011,V002,V536' +PVS_LOG_OPTS = -a 'GA:1,2' -e -t errorfile -d $(PVS_IGNORE) + +# Set to non-empty for development mode +DEVEL = @DEVEL@ + +#### End of system configuration section. #### + +SHELL = @SHELL@ + +LIBEVENTLOG_OBJS = eventlog.lo + +IOBJS = $(LIBEVENTLOG_OBJS:.lo=.i) + +POBJS = $(IOBJS:.i=.plog) + +GENERATED = log_server.pb-c.h log_server.pb-c.c + +all: libsudo_eventlog.la + +pvs-log-files: $(POBJS) + +pvs-studio: $(POBJS) + plog-converter $(PVS_LOG_OPTS) $(POBJS) + +depend: + $(scriptdir)/mkdep.pl --srcdir=$(abs_top_srcdir) \ + --builddir=$(abs_top_builddir) lib/eventlog/Makefile.in + cd $(top_builddir) && ./config.status --file lib/eventlog/Makefile + +Makefile: $(srcdir)/Makefile.in + cd $(top_builddir) && ./config.status --file lib/eventlog/Makefile + +.SUFFIXES: .c .h .i .lo .plog + +.c.lo: + $(LIBTOOL) $(LTFLAGS) --mode=compile $(CC) -c -o $@ $(CPPFLAGS) $(CFLAGS) $(ASAN_CFLAGS) $(PIE_CFLAGS) $(SSP_CFLAGS) $< + +.c.i: + $(CC) -E -o $@ $(CPPFLAGS) $< + +.i.plog: + ifile=$<; rm -f $@; pvs-studio --cfg $(PVS_CFG) --sourcetree-root $(top_srcdir) --skip-cl-exe yes --source-file $${ifile%i}c --i-file $< --output-file $@ + +$(devdir)/log_server.pb-c.c: $(srcdir)/log_server.proto + @if [ -n "$(DEVEL)" ]; then \ + cmd='protoc-c --c_out=$(devdir) --proto_path=$(srcdir) $(srcdir)/log_server.proto'; \ + echo "$$cmd"; eval $$cmd; \ + cmd='$(scriptdir)/unanon $(devdir)/log_server.pb-c.h $(devdir)/log_server.pb-c.c'; \ + echo "$$cmd"; eval $$cmd; \ + if [ "$(devdir)" == "$(srcdir)" ]; then \ + cmd='mv -f $(devdir)/log_server.pb-c.h $(incdir)/log_server.pb-c.h'; \ + else \ + cmd='mv -f $(devdir)/log_server.pb-c.h $(top_builddir)/log_server.pb-c.h'; \ + fi; \ + echo "$$cmd"; eval $$cmd; \ + fi + +libsudo_eventlog.la: $(LIBEVENTLOG_OBJS) + $(LIBTOOL) $(LTFLAGS) --mode=link $(CC) -o $@ $(LIBEVENTLOG_OBJS) + +pre-install: + +install: + +install-binaries: + +install-includes: + +install-doc: + +install-plugin: + +uninstall: + +splint: + splint $(SPLINT_OPTS) -I$(incdir) -I$(top_builddir) -I$(top_srcdir) $(srcdir)/*.c + +cppcheck: + cppcheck $(CPPCHECK_OPTS) -I$(incdir) -I$(top_builddir) -I$(top_srcdir) $(srcdir)/*.c + +pvs-log-files: $(POBJS) + +check: + +clean: + -$(LIBTOOL) $(LTFLAGS) --mode=clean rm -f *.lo *.o *.la + -rm -f *.i *.plog stamp-* core *.core core.* + +mostlyclean: clean + +distclean: clean + -rm -rf Makefile .libs + @if [ -n "$(DEVEL)" -a "$(devdir)" != "$(srcdir)" ]; then \ + cmd='rm -rf $(GENERATED)'; \ + echo "$$cmd"; eval $$cmd; \ + fi + +clobber: distclean + +realclean: distclean + rm -f TAGS tags + +cleandir: realclean + +# Autogenerated dependencies, do not modify +eventlog.lo: $(srcdir)/eventlog.c $(incdir)/compat/stdbool.h \ + $(incdir)/sudo_compat.h $(incdir)/sudo_debug.h \ + $(incdir)/sudo_eventlog.h $(incdir)/sudo_fatal.h \ + $(incdir)/sudo_gettext.h $(incdir)/sudo_json.h \ + $(incdir)/sudo_plugin.h $(incdir)/sudo_queue.h \ + $(incdir)/sudo_util.h $(top_builddir)/config.h + $(LIBTOOL) $(LTFLAGS) --mode=compile $(CC) -c -o $@ $(CPPFLAGS) $(CFLAGS) $(ASAN_CFLAGS) $(PIE_CFLAGS) $(SSP_CFLAGS) $(srcdir)/eventlog.c +eventlog.i: $(srcdir)/eventlog.c $(incdir)/compat/stdbool.h \ + $(incdir)/sudo_compat.h $(incdir)/sudo_debug.h \ + $(incdir)/sudo_eventlog.h $(incdir)/sudo_fatal.h \ + $(incdir)/sudo_gettext.h $(incdir)/sudo_json.h \ + $(incdir)/sudo_plugin.h $(incdir)/sudo_queue.h \ + $(incdir)/sudo_util.h $(top_builddir)/config.h + $(CC) -E -o $@ $(CPPFLAGS) $< +eventlog.plog: eventlog.i + rm -f $@; pvs-studio --cfg $(PVS_CFG) --sourcetree-root $(top_srcdir) --skip-cl-exe yes --source-file $(srcdir)/eventlog.c --i-file $< --output-file $@ diff --git a/lib/eventlog/eventlog.c b/lib/eventlog/eventlog.c new file mode 100644 index 000000000..9a541a094 --- /dev/null +++ b/lib/eventlog/eventlog.c @@ -0,0 +1,737 @@ +/* + * SPDX-License-Identifier: ISC + * + * Copyright (c) 1994-1996, 1998-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. + * + * Sponsored in part by the Defense Advanced Research Projects + * Agency (DARPA) and Air Force Research Laboratory, Air Force + * Materiel Command, USAF, under agreement number F39502-99-1-0512. + */ + +/* + * This is an open source non-commercial project. Dear PVS-Studio, please check it. + * PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com + */ + +#include <config.h> + +#include <sys/types.h> +#include <sys/socket.h> +#include <sys/stat.h> +#include <netinet/in.h> + +#include <ctype.h> +#include <errno.h> +#include <fcntl.h> +#include <grp.h> +#include <pwd.h> +#include <signal.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <syslog.h> +#include <time.h> +#include <unistd.h> + +#include "sudo_compat.h" +#include "sudo_debug.h" +#include "sudo_eventlog.h" +#include "sudo_fatal.h" +#include "sudo_gettext.h" +#include "sudo_json.h" +#include "sudo_queue.h" +#include "sudo_util.h" + +#define LL_HOST_STR "HOST=" +#define LL_TTY_STR "TTY=" +#define LL_CHROOT_STR "CHROOT=" +#define LL_CWD_STR "PWD=" +#define LL_USER_STR "USER=" +#define LL_GROUP_STR "GROUP=" +#define LL_ENV_STR "ENV=" +#define LL_CMND_STR "COMMAND=" +#define LL_TSID_STR "TSID=" + +#define IS_SESSID(s) ( \ + isalnum((unsigned char)(s)[0]) && isalnum((unsigned char)(s)[1]) && \ + (s)[2] == '/' && \ + isalnum((unsigned char)(s)[3]) && isalnum((unsigned char)(s)[4]) && \ + (s)[5] == '/' && \ + isalnum((unsigned char)(s)[6]) && isalnum((unsigned char)(s)[7]) && \ + (s)[8] == '\0') + +/* Eventlog config settings */ +static struct eventlog_config evl_conf; + +/* + * Allocate and fill in a new logline. + */ +static char * +new_logline(const char *message, const char *errstr, + const struct eventlog *details) +{ + char *line = NULL, *evstr = NULL; + const char *iolog_file = details->iolog_file; + char sessid[7]; + const char *tsid = NULL; + size_t len = 0; + int i; + debug_decl(new_logline, SUDO_DEBUG_UTIL); + + /* A TSID may be a sudoers-style session ID or a free-form string. */ + if (iolog_file != NULL) { + if (IS_SESSID(iolog_file)) { + sessid[0] = iolog_file[0]; + sessid[1] = iolog_file[1]; + sessid[2] = iolog_file[3]; + sessid[3] = iolog_file[4]; + sessid[4] = iolog_file[6]; + sessid[5] = iolog_file[7]; + sessid[6] = '\0'; + tsid = sessid; + } else { + tsid = iolog_file; + } + } + + /* + * Compute line length + */ + if (message != NULL) + len += strlen(message) + 3; + if (errstr != NULL) + len += strlen(errstr) + 3; + if (details->submithost != NULL) + len += sizeof(LL_HOST_STR) + 2 + strlen(details->submithost); + if (details->ttyname != NULL) + len += sizeof(LL_TTY_STR) + 2 + strlen(details->ttyname); + if (details->runchroot != NULL) + len += sizeof(LL_CHROOT_STR) + 2 + strlen(details->runchroot); + if (details->runcwd != NULL) + len += sizeof(LL_CWD_STR) + 2 + strlen(details->runcwd); + if (details->runuser != NULL) + len += sizeof(LL_USER_STR) + 2 + strlen(details->runuser); + if (details->rungroup != NULL) + len += sizeof(LL_GROUP_STR) + 2 + strlen(details->rungroup); + if (tsid != NULL) + len += sizeof(LL_TSID_STR) + 2 + strlen(tsid); + if (details->env_add != NULL) { + size_t evlen = 0; + char * const *ep; + + for (ep = details->env_add; *ep != NULL; ep++) + evlen += strlen(*ep) + 1; + if (evlen != 0) { + if ((evstr = malloc(evlen)) == NULL) + goto oom; + ep = details->env_add; + if (strlcpy(evstr, *ep, evlen) >= evlen) + goto toobig; + while (*++ep != NULL) { + if (strlcat(evstr, " ", evlen) >= evlen || + strlcat(evstr, *ep, evlen) >= evlen) + goto toobig; + } + len += sizeof(LL_ENV_STR) + 2 + evlen; + } + } + if (details->command != NULL) { + len += sizeof(LL_CMND_STR) - 1 + strlen(details->command); + for (i = 1; details->argv[i] != NULL; i++) + len += strlen(details->argv[i]) + 1; + } + + /* + * Allocate and build up the line. + */ + if ((line = malloc(++len)) == NULL) + goto oom; + line[0] = '\0'; + + if (message != NULL) { + if (strlcat(line, message, len) >= len || + strlcat(line, errstr ? " : " : " ; ", len) >= len) + goto toobig; + } + if (errstr != NULL) { + if (strlcat(line, errstr, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (details->submithost != NULL) { + if (strlcat(line, LL_HOST_STR, len) >= len || + strlcat(line, details->submithost, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (details->ttyname != NULL) { + if (strlcat(line, LL_TTY_STR, len) >= len || + strlcat(line, details->ttyname, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (details->runchroot != NULL) { + if (strlcat(line, LL_CHROOT_STR, len) >= len || + strlcat(line, details->runchroot, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (details->runcwd != NULL) { + if (strlcat(line, LL_CWD_STR, len) >= len || + strlcat(line, details->runcwd, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (details->runuser != NULL) { + if (strlcat(line, LL_USER_STR, len) >= len || + strlcat(line, details->runuser, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (details->rungroup != NULL) { + if (strlcat(line, LL_GROUP_STR, len) >= len || + strlcat(line, details->rungroup, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (tsid != NULL) { + if (strlcat(line, LL_TSID_STR, len) >= len || + strlcat(line, tsid, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + } + if (evstr != NULL) { + if (strlcat(line, LL_ENV_STR, len) >= len || + strlcat(line, evstr, len) >= len || + strlcat(line, " ; ", len) >= len) + goto toobig; + free(evstr); + evstr = NULL; + } + if (details->command != NULL) { + if (strlcat(line, LL_CMND_STR, len) >= len) + goto toobig; + if (strlcat(line, details->command, len) >= len) + goto toobig; + for (i = 1; details->argv[i] != NULL; i++) { + if (strlcat(line, " ", len) >= len || + strlcat(line, details->argv[i], len) >= len) + goto toobig; + } + } + + debug_return_str(line); +oom: + free(evstr); + sudo_warnx(U_("%s: %s"), __func__, U_("unable to allocate memory")); + debug_return_str(NULL); +toobig: + free(evstr); + free(line); + sudo_warnx(U_("internal error, %s overflow"), __func__); + debug_return_str(NULL); +} + +static bool +json_add_timestamp(struct json_container *json, const char *name, + struct timespec *ts) +{ + const char *timefmt = evl_conf.time_fmt; + struct json_value json_value; + time_t secs = ts->tv_sec; + char timebuf[1024]; + struct tm *tm; + debug_decl(json_add_timestamp, SUDO_DEBUG_PLUGIN); + + if ((tm = gmtime(&secs)) == NULL) + debug_return_bool(false); + + if (!sudo_json_open_object(json, name)) + goto oom; + + json_value.type = JSON_NUMBER; + json_value.u.number = ts->tv_sec; + if (!sudo_json_add_value(json, "seconds", &json_value)) + goto oom; + + json_value.type = JSON_NUMBER; + json_value.u.number = ts->tv_nsec; + if (!sudo_json_add_value(json, "nanoseconds", &json_value)) + goto oom; + + strftime(timebuf, sizeof(timebuf), "%Y%m%d%H%M%SZ", tm); + json_value.type = JSON_STRING; + json_value.u.string = timebuf; + if (!sudo_json_add_value(json, "iso8601", &json_value)) + goto oom; + + strftime(timebuf, sizeof(timebuf), timefmt, tm); + json_value.type = JSON_STRING; + json_value.u.string = timebuf; + if (!sudo_json_add_value(json, "localtime", &json_value)) + goto oom; + + if (!sudo_json_close_object(json)) + goto oom; + + debug_return_bool(true); +oom: + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_ERRNO|SUDO_DEBUG_LINENO, + "%s: %s", __func__, "unable to allocate memory"); + debug_return_bool(false); +} + +static char * +format_json(int event_type, const char *reason, + const struct eventlog *details, struct timespec *event_time, + eventlog_json_callback_t info_cb, void *info, bool compact) +{ + const char *type_str; + const char *time_str; + struct json_container json = { 0 }; + struct json_value json_value; + struct timespec now; + debug_decl(format_json, SUDO_DEBUG_UTIL); + + if (sudo_gettime_real(&now) == -1) { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO|SUDO_DEBUG_ERRNO, + "unable to read the clock"); + debug_return_str(NULL); + } + + switch (event_type) { + case EVLOG_ACCEPT: + type_str = "accept"; + time_str = "submit_time"; + break; + case EVLOG_REJECT: + type_str = "reject"; + time_str = "submit_time"; + break; + case EVLOG_ALERT: + type_str = "alert"; + time_str = "alert_time"; + break; + default: + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO, + "unexpected event type %d", event_type); + debug_return_str(NULL); + } + + if (!sudo_json_init(&json, 4, compact, false)) + goto bad; + if (!sudo_json_open_object(&json, type_str)) + goto bad; + + /* Reject and Alert events include a reason */ + if (reason != NULL) { + json_value.type = JSON_STRING; + json_value.u.string = reason; + if (!sudo_json_add_value(&json, "reason", &json_value)) + goto bad; + } + + /* XXX - create and log uuid? */ + + /* Log event time on server (set earlier) */ + if (!json_add_timestamp(&json, "server_time", &now)) { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_ERRNO|SUDO_DEBUG_LINENO, + "unable format timestamp"); + goto bad; + } + + /* Log event time from client */ + if (!json_add_timestamp(&json, time_str, event_time)) { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_ERRNO|SUDO_DEBUG_LINENO, + "unable format timestamp"); + goto bad; + } + + if (details->iolog_path != NULL) { + json_value.type = JSON_STRING; + json_value.u.string = details->iolog_path; + if (!sudo_json_add_value(&json, "iolog_path", &json_value)) + goto bad; + } + + /* Dump details if present. */ + if (info_cb != NULL) { + if (!info_cb(&json, info)) + goto bad; + } + + if (!sudo_json_close_object(&json)) + goto bad; + + /* Caller is responsible for freeing the buffer. */ + debug_return_str(sudo_json_get_buf(&json)); + +bad: + sudo_json_free(&json); + debug_return_str(NULL); +} + +/* + * Log a message to syslog, pre-pending the username and splitting the + * message into parts if it is longer than syslog_maxlen. + */ +static bool +do_syslog_sudo(int pri, const char *reason, const struct eventlog *details) +{ + size_t len, maxlen; + char *logline, *p, *tmp, save; + const char *fmt; + debug_decl(do_syslog_sudo, SUDO_DEBUG_UTIL); + + /* A priority of -1 corresponds to "none". */ + if (pri == -1) + debug_return_bool(true); + + if ((logline = new_logline(reason, NULL, details)) == NULL) + debug_return_bool(false); + + evl_conf.open_log(EVLOG_SYSLOG, NULL); + + /* + * Log the full line, breaking into multiple syslog(3) calls if necessary + */ + fmt = _("%8s : %s"); + maxlen = evl_conf.syslog_maxlen - + (strlen(fmt) - 5 + strlen(details->submituser)); + for (p = logline; *p != '\0'; ) { + len = strlen(p); + if (len > maxlen) { + /* + * Break up the line into what will fit on one syslog(3) line + * Try to avoid breaking words into several lines if possible. + */ + tmp = memrchr(p, ' ', maxlen); + if (tmp == NULL) + tmp = p + maxlen; + + /* NULL terminate line, but save the char to restore later */ + save = *tmp; + *tmp = '\0'; + + /* XXX - assumes openlog() already done */ + syslog(pri, fmt, details->submituser, p); + + *tmp = save; /* restore saved character */ + + /* Advance p and eliminate leading whitespace */ + for (p = tmp; *p == ' '; p++) + continue; + } else { + syslog(pri, fmt, details->submituser, p); + p += len; + } + fmt = _("%8s : (command continued) %s"); + maxlen = evl_conf.syslog_maxlen - + (strlen(fmt) - 5 + strlen(details->submituser)); + } + free(logline); + evl_conf.close_log(EVLOG_SYSLOG, NULL); + + debug_return_bool(true); +} + +static bool +do_syslog_json(int pri, int event_type, const char *reason, + const struct eventlog *details, struct timespec *event_time, + eventlog_json_callback_t info_cb, void *info) +{ + char *json_str; + debug_decl(do_syslog_json, SUDO_DEBUG_UTIL); + + /* A priority of -1 corresponds to "none". */ + if (pri == -1) + debug_return_bool(true); + + /* Format as a compact JSON message (no newlines) */ + json_str = format_json(event_type, reason, details, event_time, + info_cb, info, true); + if (json_str == NULL) + debug_return_bool(false); + + /* Syslog it with a @cee: prefix */ + /* TODO: use evl_conf.syslog_maxlen to break up long messages. */ + evl_conf.open_log(EVLOG_SYSLOG, NULL); + syslog(pri, "@cee:{%s }", json_str); + evl_conf.close_log(EVLOG_SYSLOG, NULL); + free(json_str); + debug_return_bool(true); +} + +/* + * Log a message to syslog in either sudo or JSON format. + */ +static bool +do_syslog(int event_type, const char *reason, + const struct eventlog *details, struct timespec *event_time, + eventlog_json_callback_t info_cb, void *info) +{ + int pri; + bool ret = false; + debug_decl(do_syslog, SUDO_DEBUG_UTIL); + + switch (event_type) { + case EVLOG_ACCEPT: + pri = evl_conf.syslog_acceptpri; + break; + case EVLOG_REJECT: + pri = evl_conf.syslog_rejectpri; + break; + case EVLOG_ALERT: + pri = evl_conf.syslog_alertpri; + break; + default: + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO, + "unexpected event type %d", event_type); + pri = -1; + break; + } + if (pri == -1) { + /* syslog disabled for this message type */ + debug_return_bool(true); + } + + switch (evl_conf.format) { + case EVLOG_SUDO: + ret = do_syslog_sudo(pri, reason, details); + break; + case EVLOG_JSON: + ret = do_syslog_json(pri, event_type, reason, details, event_time, + info_cb, info); + break; + default: + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO, + "unexpected eventlog format %d", evl_conf.format); + break; + } + + debug_return_bool(ret); +} + +static bool +do_logfile_sudo(const char *reason, const struct eventlog *details) +{ + const char *timefmt = evl_conf.time_fmt; + const char *logfile = evl_conf.logpath; + char *logline, timebuf[8192], *timestr = NULL; + struct tm *timeptr; + bool ret = false; + FILE *fp; + debug_decl(do_logfile_sudo, SUDO_DEBUG_UTIL); + + if ((fp = evl_conf.open_log(EVLOG_FILE, logfile)) == NULL) + debug_return_bool(false); + + if ((logline = new_logline(reason, NULL, details)) == NULL) + debug_return_bool(false); + + if (!sudo_lock_file(fileno(fp), SUDO_LOCK)) { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO|SUDO_DEBUG_ERRNO, + "unable to lock log file %s", logfile); + goto done; + } + + if ((timeptr = localtime(&details->submit_time.tv_sec)) != NULL) { + /* strftime() does not guarantee to NUL-terminate so we must check. */ + timebuf[sizeof(timebuf) - 1] = '\0'; + if (strftime(timebuf, sizeof(timebuf), timefmt, timeptr) != 0 && + timebuf[sizeof(timebuf) - 1] == '\0') { + timestr = timebuf; + } + } + (void)fprintf(fp, "%s : %s : %s\n", timestr ? timestr : "invalid date", + details->submituser, logline); + (void)fflush(fp); + if (ferror(fp)) { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO|SUDO_DEBUG_ERRNO, + "unable to write log file %s", logfile); + goto done; + } + ret = true; + +done: + free(logline); + (void)sudo_lock_file(fileno(fp), SUDO_UNLOCK); + evl_conf.close_log(EVLOG_FILE, fp); + debug_return_bool(ret); +} + +static bool +do_logfile_json(int event_type, const char *reason, + const struct eventlog *details, struct timespec *event_time, + eventlog_json_callback_t info_cb, void *info) +{ + const char *logfile = evl_conf.logpath; + struct stat sb; + char *json_str; + int ret = false; + FILE *fp; + debug_decl(do_logfile_json, SUDO_DEBUG_UTIL); + + if ((fp = evl_conf.open_log(EVLOG_FILE, logfile)) == NULL) + debug_return_bool(false); + + json_str = format_json(event_type, reason, details, event_time, + info_cb, info, false); + if (json_str == NULL) + goto done; + + if (!sudo_lock_file(fileno(fp), SUDO_LOCK)) { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO|SUDO_DEBUG_ERRNO, + "unable to lock log file %s", logfile); + goto done; + } + + /* Note: assumes file ends in "\n}\n" */ + if (fstat(fileno(fp), &sb) == -1) { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_ERRNO|SUDO_DEBUG_LINENO, + "unable to stat %s", logfile); + goto done; + } + if (sb.st_size == 0) { + /* New file */ + putc('{', fp); + } else if (fseeko(fp, -3, SEEK_END) == 0) { + /* Continue file, overwrite the final "\n}\n" */ + putc(',', fp); + } else { + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_ERRNO|SUDO_DEBUG_LINENO, + "unable to seek %s", logfile); + goto done; + } + fputs(json_str, fp); + fputs("\n}\n", fp); /* close JSON */ + fflush(fp); + /* XXX - check for file error and recover */ + + ret = true; + +done: + free(json_str); + (void)sudo_lock_file(fileno(fp), SUDO_UNLOCK); + evl_conf.close_log(EVLOG_FILE, fp); + debug_return_bool(ret); +} + +static bool +do_logfile(int event_type, const char *reason, + const struct eventlog *details, struct timespec *event_time, + eventlog_json_callback_t info_cb, void *info) +{ + bool ret = false; + debug_decl(do_logfile, SUDO_DEBUG_UTIL); + + switch (evl_conf.format) { + case EVLOG_SUDO: + ret = do_logfile_sudo(reason, details); + break; + case EVLOG_JSON: + ret = do_logfile_json(event_type, reason, details, event_time, + info_cb, info); + break; + default: + sudo_debug_printf(SUDO_DEBUG_ERROR|SUDO_DEBUG_LINENO, + "unexpected eventlog format %d", evl_conf.format); + break; + } + + debug_return_bool(ret); +} + +bool +eventlog_accept(const struct eventlog *details, struct timespec *submit_time, + eventlog_json_callback_t info_cb, void *info) +{ + const int log_type = evl_conf.type; + bool ret = true; + debug_decl(log_accept, SUDO_DEBUG_UTIL); + + if (log_type == EVLOG_NONE) + debug_return_bool(true); + + if (ISSET(log_type, EVLOG_SYSLOG)) { + if (!do_syslog(EVLOG_ACCEPT, NULL, details, submit_time, info_cb, info)) + ret = false; + } + if (ISSET(log_type, EVLOG_FILE)) { + if (!do_logfile(EVLOG_ACCEPT, NULL, details, submit_time, info_cb, info)) + ret = false; + } + + debug_return_bool(ret); +} + +bool +eventlog_reject(const struct eventlog *details, const char *reason, + struct timespec *submit_time, eventlog_json_callback_t info_cb, void *info) +{ + const int log_type = evl_conf.type; + bool ret = true; + debug_decl(log_reject, SUDO_DEBUG_UTIL); + + if (ISSET(log_type, EVLOG_SYSLOG)) { + if (!do_syslog(EVLOG_REJECT, reason, details, submit_time, + info_cb, info)) + ret = false; + } + if (ISSET(log_type, EVLOG_FILE)) { + if (!do_logfile(EVLOG_REJECT, reason, details, submit_time, + info_cb, info)) + ret = false; + } + + debug_return_bool(ret); +} + +bool +eventlog_alert(const struct eventlog *details, struct timespec *alert_time, + const char *reason) +{ + const int log_type = evl_conf.type; + bool ret = true; + debug_decl(log_alert, SUDO_DEBUG_UTIL); + + /* TODO: log alert_time */ + if (ISSET(log_type, EVLOG_SYSLOG)) { + if (!do_syslog(EVLOG_ALERT, reason, details, alert_time, NULL, NULL)) + ret = false; + } + if (ISSET(log_type, EVLOG_FILE)) { + if (!do_logfile(EVLOG_ALERT, reason, details, alert_time, NULL, NULL)) + ret = false; + } + + debug_return_bool(ret); +} + +/* + * Set eventlog config settings. + */ +bool +eventlog_setconf(struct eventlog_config *conf) +{ + debug_decl(eventlog_setconf, SUDO_DEBUG_UTIL); + + if (conf != NULL) { + memcpy(&evl_conf, conf, sizeof(evl_conf)); + } else { + memset(&evl_conf, 0, sizeof(evl_conf)); + } + debug_return_bool(true); +} diff --git a/logsrvd/logsrvd.h b/logsrvd/logsrvd.h index 01453efb4..fdafe1bd9 100644 --- a/logsrvd/logsrvd.h +++ b/logsrvd/logsrvd.h @@ -42,6 +42,7 @@ /* * I/O log details from the AcceptMessage + iolog path and sessid. + * XXX - struct eventlog */ struct iolog_details { char *iolog_path; |