From 73404a09d4f26522902a11b02f27896fa1a23d37 Mon Sep 17 00:00:00 2001 From: David Oberhollenzer Date: Sun, 19 Aug 2018 13:37:42 +0200 Subject: usyslogd: minor header restructuring/file structure cleanup Signed-off-by: David Oberhollenzer --- syslogd/Makemodule.am | 5 +- syslogd/backend.h | 59 ---------- syslogd/logfile.c | 3 +- syslogd/main.c | 291 -------------------------------------------------- syslogd/proto.c | 2 +- syslogd/proto.h | 35 ------ syslogd/syslogd.c | 285 ++++++++++++++++++++++++++++++++++++++++++++++++ syslogd/syslogd.h | 89 +++++++++++++++ 8 files changed, 378 insertions(+), 391 deletions(-) delete mode 100644 syslogd/backend.h delete mode 100644 syslogd/main.c delete mode 100644 syslogd/proto.h create mode 100644 syslogd/syslogd.c create mode 100644 syslogd/syslogd.h diff --git a/syslogd/Makemodule.am b/syslogd/Makemodule.am index d954769..022946b 100644 --- a/syslogd/Makemodule.am +++ b/syslogd/Makemodule.am @@ -1,6 +1,5 @@ -usyslogd_SOURCES = syslogd/main.c -usyslogd_SOURCES += syslogd/logfile.c syslogd/backend.h -usyslogd_SOURCES += syslogd/proto.c syslogd/proto.h +usyslogd_SOURCES = syslogd/syslogd.c syslogd/syslogd.h +usyslogd_SOURCES += syslogd/proto.c syslogd/logfile.c usyslogd_CPPFLAGS = $(AM_CPPFLAGS) usyslogd_CFLAGS = $(AM_CFLAGS) usyslogd_LDFLAGS = $(AM_LDFLAGS) diff --git a/syslogd/backend.h b/syslogd/backend.h deleted file mode 100644 index 5880ee3..0000000 --- a/syslogd/backend.h +++ /dev/null @@ -1,59 +0,0 @@ -/* SPDX-License-Identifier: GPL-3.0-or-later */ -/* - * Copyright (C) 2018 - David Oberhollenzer - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -#ifndef LOGFILE_H -#define LOGFILE_H - -#include "proto.h" - -enum { - /* - Rotate log data in a way that we still generate a continuous stream - of log data. E.g. in the case of log files, move the current log file - to one suffixed with a timestamp. We don't lose any log data. - */ - LOG_ROTATE_CONTINUOUS = 0x00, - - /* - Rotate log data by overwriting old data with more recent data. - E.g. in the case of log files, move the current log file to one - with a constant prefix, overwriting any existing data. - */ - LOG_ROTATE_OVERWRITE = 0x01, - - /* - Automatically do a log rotatation if a log stream reaches a preset - size limit. - */ - LOG_ROTATE_SIZE_LIMIT = 0x10, -}; - -typedef struct log_backend_t { - int (*init)(struct log_backend_t *log, int flags, size_t sizelimit); - - void (*cleanup)(struct log_backend_t *log); - - int (*write)(struct log_backend_t *log, const syslog_msg_t *msg); - - void (*rotate)(struct log_backend_t *log); -} log_backend_t; - - -extern log_backend_t *logmgr; - - -#endif /* LOGFILE_H */ diff --git a/syslogd/logfile.c b/syslogd/logfile.c index 513b027..ec82d0c 100644 --- a/syslogd/logfile.c +++ b/syslogd/logfile.c @@ -24,8 +24,7 @@ #include #include -#include "backend.h" -#include "config.h" +#include "syslogd.h" #include "util.h" diff --git a/syslogd/main.c b/syslogd/main.c deleted file mode 100644 index e2cc804..0000000 --- a/syslogd/main.c +++ /dev/null @@ -1,291 +0,0 @@ -/* SPDX-License-Identifier: GPL-3.0-or-later */ -/* - * Copyright (C) 2018 - David Oberhollenzer - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#include "backend.h" -#include "proto.h" -#include "util.h" - - -#define SYSLOG_SOCKET PREFIXPATH "/dev/log" -#define SYSLOG_PATH PREFIXPATH "/var/log" -#define DEFAULT_USER "syslogd" -#define DEFAULT_GROUP "syslogd" - -#define GPL_URL "https://gnu.org/licenses/gpl.html" - - -static const struct option long_opts[] = { - { "help", no_argument, NULL, 'h' }, - { "version", no_argument, NULL, 'V' }, - { "rotate-replace", no_argument, NULL, 'r' }, - { "max-size", required_argument, NULL, 'm' }, - { "user", required_argument, NULL, 'u' }, - { "group", required_argument, NULL, 'g' }, - { "chroot", required_argument, NULL, 'c' }, - { NULL, 0, NULL, 0 }, -}; - -const char *short_opts = "hVrm:"; - -const char *version_string = -"usyslogd (pygos init) " PACKAGE_VERSION "\n" -"Copyright (C) 2018 David Oberhollenzer\n\n" -"License GPLv3+: GNU GPL version 3 or later <" GPL_URL ">.\n" -"This is free software: you are free to change and redistribute it.\n" -"There is NO WARRANTY, to the extent permitted by law.\n"; - -const char *usage_string = -"Usage: usyslogd [OPTIONS..]\n\n" -"The following options are supported:\n" -" -h, --help Print this help text and exit\n" -" -V, --version Print version information and exit\n" -" -r, --rotate-replace Replace old log files when doing log rotation.\n" -" -m, --max-size Automatically rotate log files bigger than this.\n" -" -u, --user Run the syslog daemon as this user. If not set,\n" -" try to use the user '" DEFAULT_USER "'.\n" -" -g, --group Run the syslog daemon as this group. If not set,\n" -" try to use the group '" DEFAULT_GROUP "'.\n" -" -c, --chroot If set, do a chroot into the log file path.\n"; - - - -static volatile sig_atomic_t syslog_run = 1; -static volatile sig_atomic_t syslog_rotate = 0; -static int log_flags = 0; -static size_t max_size = 0; -static uid_t uid = 0; -static gid_t gid = 0; -static bool dochroot = false; - - - -static void sighandler(int signo) -{ - switch (signo) { - case SIGINT: - case SIGTERM: - syslog_run = 0; - break; - case SIGHUP: - syslog_rotate = 1; - break; - default: - break; - } -} - -static void signal_setup(void) -{ - struct sigaction act; - - memset(&act, 0, sizeof(act)); - act.sa_handler = sighandler; - - sigaction(SIGINT, &act, NULL); - sigaction(SIGTERM, &act, NULL); - sigaction(SIGHUP, &act, NULL); -} - -static int handle_data(int fd) -{ - char buffer[2048]; - syslog_msg_t msg; - ssize_t ret; - - memset(buffer, 0, sizeof(buffer)); - - ret = read(fd, buffer, sizeof(buffer)); - if (ret <= 0) - return -1; - - if (syslog_msg_parse(&msg, buffer)) - return -1; - - return logmgr->write(logmgr, &msg); -} - -static void process_options(int argc, char **argv) -{ - struct passwd *pw = getpwnam(DEFAULT_USER); - struct group *grp = getgrnam(DEFAULT_GROUP); - char *end; - int i; - - if (pw != NULL) - uid = pw->pw_uid; - - if (grp != NULL) - gid = grp->gr_gid; - - for (;;) { - i = getopt_long(argc, argv, short_opts, long_opts, NULL); - if (i == -1) - break; - - switch (i) { - case 'r': - log_flags |= LOG_ROTATE_OVERWRITE; - break; - case 'm': - log_flags |= LOG_ROTATE_SIZE_LIMIT; - max_size = strtol(optarg, &end, 10); - if (max_size == 0 || *end != '\0') { - fputs("Numeric argument > 0 expected for -m\n", - stderr); - goto fail; - } - break; - case 'u': - pw = getpwnam(optarg); - if (pw == NULL) { - fprintf(stderr, "Cannot get UID for user %s\n", - optarg); - goto fail; - } - uid = pw->pw_uid; - break; - case 'g': - grp = getgrnam(optarg); - if (grp == NULL) { - fprintf(stderr, - "Cannot get GID for group %s\n", - optarg); - goto fail; - } - gid = grp->gr_gid; - break; - case 'c': - dochroot = true; - break; - case 'h': - fputs(usage_string, stdout); - exit(EXIT_SUCCESS); - case 'V': - fputs(version_string, stdout); - exit(EXIT_SUCCESS); - default: - goto fail; - } - } - return; -fail: - fputs("Try `usyslogd --help' for more information\n", stderr); - exit(EXIT_FAILURE); -} - -static int chroot_setup(void) -{ - if (mkdir(SYSLOG_PATH, 0750)) { - if (errno != EEXIST) { - perror("mkdir " SYSLOG_PATH); - return -1; - } - } - - if (uid > 0 && gid > 0 && chown(SYSLOG_PATH, uid, gid) != 0) { - perror("chown " SYSLOG_PATH); - return -1; - } - - if (chmod(SYSLOG_PATH, 0750)) { - perror("chmod " SYSLOG_PATH); - return -1; - } - - if (chdir(SYSLOG_PATH)) { - perror("cd " SYSLOG_PATH); - return -1; - } - - if (dochroot && chroot(SYSLOG_PATH) != 0) { - perror("chroot " SYSLOG_PATH); - return -1; - } - - return 0; -} - -static int user_setup(void) -{ - if (gid > 0 && setresgid(gid, gid, gid) != 0) { - perror("setgid"); - return -1; - } - if (uid > 0 && setresuid(uid, uid, uid) != 0) { - perror("setuid"); - return -1; - } - return 0; -} - -int main(int argc, char **argv) -{ - int sfd, status = EXIT_FAILURE; - - process_options(argc, argv); - - signal_setup(); - - sfd = mksock(SYSLOG_SOCKET, SOCK_FLAG_EVERYONE | SOCK_FLAG_DGRAM); - if (sfd < 0) - return EXIT_FAILURE; - - if (uid > 0 && gid > 0 && chown(SYSLOG_SOCKET, uid, gid) != 0) { - perror("chown " SYSLOG_SOCKET); - return -1; - } - - if (chroot_setup()) - return EXIT_FAILURE; - - if (user_setup()) - return EXIT_FAILURE; - - if (logmgr->init(logmgr, log_flags, max_size)) - goto out; - - while (syslog_run) { - if (syslog_rotate) { - logmgr->rotate(logmgr); - syslog_rotate = 0; - } - - handle_data(sfd); - } - - status = EXIT_SUCCESS; -out: - logmgr->cleanup(logmgr); - if (sfd > 0) - close(sfd); - unlink(SYSLOG_SOCKET); - return status; -} diff --git a/syslogd/proto.c b/syslogd/proto.c index 8a285dd..0851ced 100644 --- a/syslogd/proto.c +++ b/syslogd/proto.c @@ -20,7 +20,7 @@ #include #include -#include "proto.h" +#include "syslogd.h" static const char *months[] = { "Jan", "Feb", "Mar", "Apr", diff --git a/syslogd/proto.h b/syslogd/proto.h deleted file mode 100644 index c64c9e1..0000000 --- a/syslogd/proto.h +++ /dev/null @@ -1,35 +0,0 @@ -/* SPDX-License-Identifier: GPL-3.0-or-later */ -/* - * Copyright (C) 2018 - David Oberhollenzer - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -#ifndef PROTO_H -#define PROTO_H - -#include -#include - -typedef struct { - int facility; - int level; - time_t timestamp; - pid_t pid; - const char *ident; - const char *message; -} syslog_msg_t; - -int syslog_msg_parse(syslog_msg_t *msg, char *str); - -#endif /* PROTO_H */ diff --git a/syslogd/syslogd.c b/syslogd/syslogd.c new file mode 100644 index 0000000..03f4b55 --- /dev/null +++ b/syslogd/syslogd.c @@ -0,0 +1,285 @@ +/* SPDX-License-Identifier: GPL-3.0-or-later */ +/* + * Copyright (C) 2018 - David Oberhollenzer + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "syslogd.h" +#include "util.h" + + +#define GPL_URL "https://gnu.org/licenses/gpl.html" + + +static const struct option long_opts[] = { + { "help", no_argument, NULL, 'h' }, + { "version", no_argument, NULL, 'V' }, + { "rotate-replace", no_argument, NULL, 'r' }, + { "max-size", required_argument, NULL, 'm' }, + { "user", required_argument, NULL, 'u' }, + { "group", required_argument, NULL, 'g' }, + { "chroot", required_argument, NULL, 'c' }, + { NULL, 0, NULL, 0 }, +}; + +const char *short_opts = "hVrm:"; + +const char *version_string = +"usyslogd (pygos init) " PACKAGE_VERSION "\n" +"Copyright (C) 2018 David Oberhollenzer\n\n" +"License GPLv3+: GNU GPL version 3 or later <" GPL_URL ">.\n" +"This is free software: you are free to change and redistribute it.\n" +"There is NO WARRANTY, to the extent permitted by law.\n"; + +const char *usage_string = +"Usage: usyslogd [OPTIONS..]\n\n" +"The following options are supported:\n" +" -h, --help Print this help text and exit\n" +" -V, --version Print version information and exit\n" +" -r, --rotate-replace Replace old log files when doing log rotation.\n" +" -m, --max-size Automatically rotate log files bigger than this.\n" +" -u, --user Run the syslog daemon as this user. If not set,\n" +" try to use the user '" DEFAULT_USER "'.\n" +" -g, --group Run the syslog daemon as this group. If not set,\n" +" try to use the group '" DEFAULT_GROUP "'.\n" +" -c, --chroot If set, do a chroot into the log file path.\n"; + + + +static volatile sig_atomic_t syslog_run = 1; +static volatile sig_atomic_t syslog_rotate = 0; +static int log_flags = 0; +static size_t max_size = 0; +static uid_t uid = 0; +static gid_t gid = 0; +static bool dochroot = false; + + + +static void sighandler(int signo) +{ + switch (signo) { + case SIGINT: + case SIGTERM: + syslog_run = 0; + break; + case SIGHUP: + syslog_rotate = 1; + break; + default: + break; + } +} + +static void signal_setup(void) +{ + struct sigaction act; + + memset(&act, 0, sizeof(act)); + act.sa_handler = sighandler; + + sigaction(SIGINT, &act, NULL); + sigaction(SIGTERM, &act, NULL); + sigaction(SIGHUP, &act, NULL); +} + +static int handle_data(int fd) +{ + char buffer[2048]; + syslog_msg_t msg; + ssize_t ret; + + memset(buffer, 0, sizeof(buffer)); + + ret = read(fd, buffer, sizeof(buffer)); + if (ret <= 0) + return -1; + + if (syslog_msg_parse(&msg, buffer)) + return -1; + + return logmgr->write(logmgr, &msg); +} + +static void process_options(int argc, char **argv) +{ + struct passwd *pw = getpwnam(DEFAULT_USER); + struct group *grp = getgrnam(DEFAULT_GROUP); + char *end; + int i; + + if (pw != NULL) + uid = pw->pw_uid; + + if (grp != NULL) + gid = grp->gr_gid; + + for (;;) { + i = getopt_long(argc, argv, short_opts, long_opts, NULL); + if (i == -1) + break; + + switch (i) { + case 'r': + log_flags |= LOG_ROTATE_OVERWRITE; + break; + case 'm': + log_flags |= LOG_ROTATE_SIZE_LIMIT; + max_size = strtol(optarg, &end, 10); + if (max_size == 0 || *end != '\0') { + fputs("Numeric argument > 0 expected for -m\n", + stderr); + goto fail; + } + break; + case 'u': + pw = getpwnam(optarg); + if (pw == NULL) { + fprintf(stderr, "Cannot get UID for user %s\n", + optarg); + goto fail; + } + uid = pw->pw_uid; + break; + case 'g': + grp = getgrnam(optarg); + if (grp == NULL) { + fprintf(stderr, + "Cannot get GID for group %s\n", + optarg); + goto fail; + } + gid = grp->gr_gid; + break; + case 'c': + dochroot = true; + break; + case 'h': + fputs(usage_string, stdout); + exit(EXIT_SUCCESS); + case 'V': + fputs(version_string, stdout); + exit(EXIT_SUCCESS); + default: + goto fail; + } + } + return; +fail: + fputs("Try `usyslogd --help' for more information\n", stderr); + exit(EXIT_FAILURE); +} + +static int chroot_setup(void) +{ + if (mkdir(SYSLOG_PATH, 0750)) { + if (errno != EEXIST) { + perror("mkdir " SYSLOG_PATH); + return -1; + } + } + + if (uid > 0 && gid > 0 && chown(SYSLOG_PATH, uid, gid) != 0) { + perror("chown " SYSLOG_PATH); + return -1; + } + + if (chmod(SYSLOG_PATH, 0750)) { + perror("chmod " SYSLOG_PATH); + return -1; + } + + if (chdir(SYSLOG_PATH)) { + perror("cd " SYSLOG_PATH); + return -1; + } + + if (dochroot && chroot(SYSLOG_PATH) != 0) { + perror("chroot " SYSLOG_PATH); + return -1; + } + + return 0; +} + +static int user_setup(void) +{ + if (gid > 0 && setresgid(gid, gid, gid) != 0) { + perror("setgid"); + return -1; + } + if (uid > 0 && setresuid(uid, uid, uid) != 0) { + perror("setuid"); + return -1; + } + return 0; +} + +int main(int argc, char **argv) +{ + int sfd, status = EXIT_FAILURE; + + process_options(argc, argv); + + signal_setup(); + + sfd = mksock(SYSLOG_SOCKET, SOCK_FLAG_EVERYONE | SOCK_FLAG_DGRAM); + if (sfd < 0) + return EXIT_FAILURE; + + if (uid > 0 && gid > 0 && chown(SYSLOG_SOCKET, uid, gid) != 0) { + perror("chown " SYSLOG_SOCKET); + return -1; + } + + if (chroot_setup()) + return EXIT_FAILURE; + + if (user_setup()) + return EXIT_FAILURE; + + if (logmgr->init(logmgr, log_flags, max_size)) + goto out; + + while (syslog_run) { + if (syslog_rotate) { + logmgr->rotate(logmgr); + syslog_rotate = 0; + } + + handle_data(sfd); + } + + status = EXIT_SUCCESS; +out: + logmgr->cleanup(logmgr); + if (sfd > 0) + close(sfd); + unlink(SYSLOG_SOCKET); + return status; +} diff --git a/syslogd/syslogd.h b/syslogd/syslogd.h new file mode 100644 index 0000000..47fc31c --- /dev/null +++ b/syslogd/syslogd.h @@ -0,0 +1,89 @@ +/* SPDX-License-Identifier: GPL-3.0-or-later */ +/* + * Copyright (C) 2018 - David Oberhollenzer + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#ifndef SYSLOGD_H +#define SYSLOGD_H + + +#include +#include + +#include "config.h" + + +#define SYSLOG_SOCKET PREFIXPATH "/dev/log" +#define SYSLOG_PATH PREFIXPATH "/var/log" +#define DEFAULT_USER "syslogd" +#define DEFAULT_GROUP "syslogd" + + +/* + encapsulates the split up data from a message received + through the local syslog socket. + */ +typedef struct { + int facility; + int level; + time_t timestamp; + pid_t pid; + const char *ident; + const char *message; +} syslog_msg_t; + + +enum { + /* + Rotate log data in a way that we still generate a continuous stream + of log data. E.g. in the case of log files, move the current log file + to one suffixed with a timestamp. We don't lose any log data. + */ + LOG_ROTATE_CONTINUOUS = 0x00, + + /* + Rotate log data by overwriting old data with more recent data. + E.g. in the case of log files, move the current log file to one + with a constant prefix, overwriting any existing data. + */ + LOG_ROTATE_OVERWRITE = 0x01, + + /* + Automatically do a log rotatation if a log stream reaches a preset + size limit. + */ + LOG_ROTATE_SIZE_LIMIT = 0x10, +}; + +typedef struct log_backend_t { + int (*init)(struct log_backend_t *log, int flags, size_t sizelimit); + + void (*cleanup)(struct log_backend_t *log); + + int (*write)(struct log_backend_t *log, const syslog_msg_t *msg); + + void (*rotate)(struct log_backend_t *log); +} log_backend_t; + + +extern log_backend_t *logmgr; + +/* + Parse a message string received from the syslog socket and produce + a split up representation for the message. + */ +int syslog_msg_parse(syslog_msg_t *msg, char *str); + +#endif /* LOGFILE_H */ -- cgit v1.2.3