1
/* -*- coding: utf-8 -*- */
3
* Mandos plugin runner - Run Mandos plugins
5
* Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
7
* This program is free software: you can redistribute it and/or
8
* modify it under the terms of the GNU General Public License as
9
* published by the Free Software Foundation, either version 3 of the
10
* License, or (at your option) any later version.
12
* This program is distributed in the hope that it will be useful, but
13
* WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
* General Public License for more details.
17
* You should have received a copy of the GNU General Public License
18
* along with this program. If not, see
19
* <http://www.gnu.org/licenses/>.
21
* Contact the authors at <mandos@fukt.bsnet.se>.
24
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
26
#include <stddef.h> /* size_t, NULL */
27
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
28
EXIT_SUCCESS, realloc() */
29
#include <stdbool.h> /* bool, true, false */
30
#include <stdio.h> /* perror, popen(), fileno(),
31
fprintf(), stderr, STDOUT_FILENO */
32
#include <sys/types.h> /* DIR, opendir(), stat(), struct
33
stat, waitpid(), WIFEXITED(),
34
WEXITSTATUS(), wait(), pid_t,
35
uid_t, gid_t, getuid(), getgid(),
37
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
38
FD_SET(), FD_ISSET(), FD_CLR */
39
#include <sys/wait.h> /* wait(), waitpid(), WIFEXITED(),
41
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
42
#include <iso646.h> /* and, or, not */
43
#include <dirent.h> /* DIR, struct dirent, opendir(),
44
readdir(), closedir(), dirfd() */
45
#include <unistd.h> /* struct stat, stat(), S_ISREG(),
46
fcntl(), setuid(), setgid(),
47
F_GETFD, F_SETFD, FD_CLOEXEC,
48
access(), pipe(), fork(), close()
49
dup2, STDOUT_FILENO, _exit(),
50
execv(), write(), read(),
52
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
54
#include <string.h> /* strsep, strlen(), asprintf() */
55
#include <errno.h> /* errno */
56
#include <argp.h> /* struct argp_option, struct
57
argp_state, struct argp,
58
argp_parse(), ARGP_ERR_UNKNOWN,
59
ARGP_KEY_END, ARGP_KEY_ARG,
61
#include <signal.h> /* struct sigaction, sigemptyset(),
62
sigaddset(), sigaction(),
63
sigprocmask(), SIG_BLOCK, SIGCHLD,
64
SIG_UNBLOCK, kill() */
65
#include <errno.h> /* errno, EBADF */
67
#define BUFFER_SIZE 256
68
#define ARGFILE "/conf/conf.d/mandos/plugin-runner.conf"
70
const char *argp_program_version = "plugin-runner 1.0";
71
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
75
typedef struct process{
82
volatile bool completed;
87
typedef struct plugin{
88
char *name; /* can be NULL or any plugin name */
97
static plugin *getplugin(char *name, plugin **plugin_list){
98
for (plugin *p = *plugin_list; p != NULL; p = p->next){
100
or (p->name and name and (strcmp(p->name, name) == 0))){
104
/* Create a new plugin */
105
plugin *new_plugin = malloc(sizeof(plugin));
106
if (new_plugin == NULL){
109
char *copy_name = NULL;
111
copy_name = strdup(name);
112
if(copy_name == NULL){
117
*new_plugin = (plugin) { .name = copy_name,
121
.next = *plugin_list };
123
new_plugin->argv = malloc(sizeof(char *) * 2);
124
if (new_plugin->argv == NULL){
129
new_plugin->argv[0] = copy_name;
130
new_plugin->argv[1] = NULL;
132
new_plugin->environ = malloc(sizeof(char *));
133
if(new_plugin->environ == NULL){
135
free(new_plugin->argv);
139
new_plugin->environ[0] = NULL;
140
/* Append the new plugin to the list */
141
*plugin_list = new_plugin;
145
/* Helper function for add_argument and add_environment */
146
static bool add_to_char_array(const char *new, char ***array,
148
/* Resize the pointed-to array to hold one more pointer */
149
*array = realloc(*array, sizeof(char *)
150
* (size_t) ((*len) + 2));
155
/* Make a copy of the new string */
156
char *copy = strdup(new);
160
/* Insert the copy */
161
(*array)[*len] = copy;
163
/* Add a new terminating NULL pointer to the last element */
164
(*array)[*len] = NULL;
168
/* Add to a plugin's argument vector */
169
static bool add_argument(plugin *p, const char *arg){
173
return add_to_char_array(arg, &(p->argv), &(p->argc));
176
/* Add to a plugin's environment */
177
static bool add_environment(plugin *p, const char *def){
181
return add_to_char_array(def, &(p->environ), &(p->envc));
186
* Based on the example in the GNU LibC manual chapter 13.13 "File
188
* *Note File Descriptor Flags:(libc)Descriptor Flags.
190
static int set_cloexec_flag(int fd)
192
int ret = fcntl(fd, F_GETFD, 0);
193
/* If reading the flags failed, return error indication now. */
197
/* Store modified flag word in the descriptor. */
198
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
201
process *process_list = NULL;
203
/* Mark processes as completed when they exit, and save their exit
205
void handle_sigchld(__attribute__((unused)) int sig){
207
process *proc = process_list;
209
pid_t pid = waitpid(-1, &status, WNOHANG);
211
/* Only still running child processes */
215
if (errno != ECHILD){
218
/* No child processes */
222
/* A child exited, find it in process_list */
223
while(proc != NULL and proc->pid != pid){
227
/* Process not found in process list */
230
proc->status = status;
231
proc->completed = true;
235
bool print_out_password(const char *buffer, size_t length){
237
if(length>0 and buffer[length-1] == '\n'){
240
for(size_t written = 0; written < length; written += (size_t)ret){
241
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
250
static void free_plugin_list(plugin *plugin_list){
251
for(plugin *next; plugin_list != NULL; plugin_list = next){
252
next = plugin_list->next;
253
for(char **arg = plugin_list->argv; *arg != NULL; arg++){
256
free(plugin_list->argv);
257
for(char **env = plugin_list->environ; *env != NULL; env++){
260
free(plugin_list->environ);
265
int main(int argc, char *argv[]){
266
const char *plugindir = "/lib/mandos/plugins.d";
267
const char *argfile = ARGFILE;
271
struct dirent *dirst;
278
int exitstatus = EXIT_SUCCESS;
279
struct sigaction old_sigchld_action;
280
struct sigaction sigchld_action = { .sa_handler = handle_sigchld,
281
.sa_flags = SA_NOCLDSTOP };
282
char **custom_argv = NULL;
285
/* Establish a signal handler */
286
sigemptyset(&sigchld_action.sa_mask);
287
ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
290
exitstatus = EXIT_FAILURE;
293
ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
296
exitstatus = EXIT_FAILURE;
300
/* The options we understand. */
301
struct argp_option options[] = {
302
{ .name = "global-options", .key = 'g',
303
.arg = "OPTION[,OPTION[,...]]",
304
.doc = "Options passed to all plugins" },
305
{ .name = "global-envs", .key = 'e',
307
.doc = "Environment variable passed to all plugins" },
308
{ .name = "options-for", .key = 'o',
309
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
310
.doc = "Options passed only to specified plugin" },
311
{ .name = "envs-for", .key = 'f',
312
.arg = "PLUGIN:ENV=value",
313
.doc = "Environment variable passed to specified plugin" },
314
{ .name = "disable", .key = 'd',
316
.doc = "Disable a specific plugin", .group = 1 },
317
{ .name = "plugin-dir", .key = 128,
319
.doc = "Specify a different plugin directory", .group = 2 },
320
{ .name = "userid", .key = 129,
321
.arg = "ID", .flags = 0,
322
.doc = "User ID the plugins will run as", .group = 2 },
323
{ .name = "groupid", .key = 130,
324
.arg = "ID", .flags = 0,
325
.doc = "Group ID the plugins will run as", .group = 2 },
326
{ .name = "debug", .key = 131,
327
.doc = "Debug mode", .group = 3 },
331
error_t parse_opt (int key, char *arg, struct argp_state *state) {
332
/* Get the INPUT argument from `argp_parse', which we know is a
333
pointer to our plugin list pointer. */
334
plugin **plugins = state->input;
339
while((p = strsep(&arg, ",")) != NULL){
343
if(not add_argument(getplugin(NULL, plugins), p)){
344
perror("add_argument");
345
return ARGP_ERR_UNKNOWN;
355
char *envdef = strdup(arg);
359
if(not add_environment(getplugin(NULL, plugins), envdef)){
360
perror("add_environment");
366
char *p_name = strsep(&arg, ":");
367
if(p_name[0] == '\0'){
370
char *opt = strsep(&arg, ":");
376
while((p = strsep(&opt, ",")) != NULL){
380
if(not add_argument(getplugin(p_name, plugins), p)){
381
perror("add_argument");
382
return ARGP_ERR_UNKNOWN;
393
char *envdef = strchr(arg, ':');
397
char *p_name = strndup(arg, (size_t) (envdef-arg));
402
if(not add_environment(getplugin(p_name, plugins), envdef)){
403
perror("add_environment");
409
plugin *p = getplugin(arg, plugins);
411
return ARGP_ERR_UNKNOWN;
420
uid = (uid_t)strtol(arg, NULL, 10);
423
gid = (gid_t)strtol(arg, NULL, 10);
429
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
434
return ARGP_ERR_UNKNOWN;
439
plugin *plugin_list = NULL;
441
struct argp argp = { .options = options, .parser = parse_opt,
442
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
443
.doc = "Mandos plugin runner -- Run plugins" };
445
ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
446
if (ret == ARGP_ERR_UNKNOWN){
447
fprintf(stderr, "Unknown error while parsing arguments\n");
448
exitstatus = EXIT_FAILURE;
452
conffp = fopen(argfile, "r");
454
char *org_line = NULL;
455
char *p, *arg, *new_arg, *line;
458
const char whitespace_delims[] = " \r\t\f\v\n";
459
const char comment_delim[] = "#";
462
custom_argv = malloc(sizeof(char*) * 2);
463
if(custom_argv == NULL){
465
exitstatus = EXIT_FAILURE;
468
custom_argv[0] = argv[0];
469
custom_argv[1] = NULL;
472
sret = getline(&org_line, &size, conffp);
478
arg = strsep(&line, comment_delim);
479
while((p = strsep(&arg, whitespace_delims)) != NULL){
486
custom_argv = realloc(custom_argv, sizeof(char *)
487
* ((unsigned int) custom_argc + 1));
488
if(custom_argv == NULL){
490
exitstatus = EXIT_FAILURE;
494
custom_argv[custom_argc-1] = new_arg;
495
custom_argv[custom_argc] = NULL;
500
/* Check for harmful errors and go to fallback. Other errors might
501
not affect opening plugins */
502
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
504
exitstatus = EXIT_FAILURE;
509
if(custom_argv != NULL){
510
ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, &plugin_list);
511
if (ret == ARGP_ERR_UNKNOWN){
512
fprintf(stderr, "Unknown error while parsing arguments\n");
513
exitstatus = EXIT_FAILURE;
519
for(plugin *p = plugin_list; p != NULL; p=p->next){
520
fprintf(stderr, "Plugin: %s has %d arguments\n",
521
p->name ? p->name : "Global", p->argc - 1);
522
for(char **a = p->argv; *a != NULL; a++){
523
fprintf(stderr, "\tArg: %s\n", *a);
525
fprintf(stderr, "...and %u environment variables\n", p->envc);
526
for(char **a = p->environ; *a != NULL; a++){
527
fprintf(stderr, "\t%s\n", *a);
542
dir = opendir(plugindir);
544
perror("Could not open plugin dir");
545
exitstatus = EXIT_FAILURE;
549
/* Set the FD_CLOEXEC flag on the directory, if possible */
551
int dir_fd = dirfd(dir);
553
ret = set_cloexec_flag(dir_fd);
555
perror("set_cloexec_flag");
556
exitstatus = EXIT_FAILURE;
565
dirst = readdir(dir);
567
// All directory entries have been processed
571
exitstatus = EXIT_FAILURE;
577
d_name_len = strlen(dirst->d_name);
579
// Ignore dotfiles, backup files and other junk
581
bool bad_name = false;
583
const char const *bad_prefixes[] = { ".", "#", NULL };
585
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
587
".dpkg-divert", NULL };
588
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
589
size_t pre_len = strlen(*pre);
590
if((d_name_len >= pre_len)
591
and strncmp((dirst->d_name), *pre, pre_len) == 0){
593
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
594
" with bad prefix %s\n", dirst->d_name, *pre);
605
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
606
size_t suf_len = strlen(*suf);
607
if((d_name_len >= suf_len)
608
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
611
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
612
" with bad suffix %s\n", dirst->d_name, *suf);
625
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
631
ret = stat(filename, &st);
638
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
640
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
641
" with bad type or mode\n", filename);
646
plugin *p = getplugin(dirst->d_name, &plugin_list);
654
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
661
/* Add global arguments to argument list for this plugin */
662
plugin *g = getplugin(NULL, &plugin_list);
664
for(char **a = g->argv + 1; *a != NULL; a++){
665
if(not add_argument(p, *a)){
666
perror("add_argument");
669
/* Add global environment variables */
670
for(char **e = g->environ; *e != NULL; e++){
671
if(not add_environment(p, *e)){
672
perror("add_environment");
677
/* If this plugin has any environment variables, we will call
678
using execve and need to duplicate the environment from this
680
if(p->environ[0] != NULL){
681
for(char **e = environ; *e != NULL; e++){
682
char *copy = strdup(*e);
687
if(not add_environment(p, copy)){
688
perror("add_environment");
697
exitstatus = EXIT_FAILURE;
700
ret = set_cloexec_flag(pipefd[0]);
702
perror("set_cloexec_flag");
703
exitstatus = EXIT_FAILURE;
706
ret = set_cloexec_flag(pipefd[1]);
708
perror("set_cloexec_flag");
709
exitstatus = EXIT_FAILURE;
712
/* Block SIGCHLD until process is safely in process list */
713
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
715
perror("sigprocmask");
716
exitstatus = EXIT_FAILURE;
719
// Starting a new process to be watched
723
exitstatus = EXIT_FAILURE;
727
/* this is the child process */
728
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
733
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
735
perror("sigprocmask");
739
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
746
/* If dir has no file descriptor, we could not set FD_CLOEXEC
747
above and must now close it manually here. */
750
if(p->environ[0] == NULL){
751
if(execv(filename, p->argv) < 0){
756
if(execve(filename, p->argv, p->environ) < 0){
765
close(pipefd[1]); /* close unused write end of pipe */
766
process *new_process = malloc(sizeof(process));
767
if (new_process == NULL){
769
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
771
perror("sigprocmask");
773
exitstatus = EXIT_FAILURE;
777
*new_process = (struct process){ .pid = pid,
779
.next = process_list };
781
process_list = new_process;
782
/* Unblock SIGCHLD so signal handler can be run if this process
783
has already completed */
784
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
786
perror("sigprocmask");
787
exitstatus = EXIT_FAILURE;
791
FD_SET(new_process->fd, &rfds_all);
793
if (maxfd < new_process->fd){
794
maxfd = new_process->fd;
799
free_plugin_list(plugin_list);
805
if (process_list == NULL){
806
fprintf(stderr, "No plugin processes started. Incorrect plugin"
811
fd_set rfds = rfds_all;
812
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
813
if (select_ret == -1){
815
exitstatus = EXIT_FAILURE;
818
/* OK, now either a process completed, or something can be read
820
for(process *proc = process_list; proc ; proc = proc->next){
821
/* Is this process completely done? */
822
if(proc->eof and proc->completed){
823
/* Only accept the plugin output if it exited cleanly */
824
if(not WIFEXITED(proc->status)
825
or WEXITSTATUS(proc->status) != 0){
826
/* Bad exit by plugin */
828
if(WIFEXITED(proc->status)){
829
fprintf(stderr, "Plugin %u exited with status %d\n",
830
(unsigned int) (proc->pid),
831
WEXITSTATUS(proc->status));
832
} else if(WIFSIGNALED(proc->status)) {
833
fprintf(stderr, "Plugin %u killed by signal %d\n",
834
(unsigned int) (proc->pid),
835
WTERMSIG(proc->status));
836
} else if(WCOREDUMP(proc->status)){
837
fprintf(stderr, "Plugin %d dumped core\n",
838
(unsigned int) (proc->pid));
841
/* Remove the plugin */
842
FD_CLR(proc->fd, &rfds_all);
843
/* Block signal while modifying process_list */
844
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
846
perror("sigprocmask");
847
exitstatus = EXIT_FAILURE;
850
/* Delete this process entry from the list */
851
if(process_list == proc){
852
/* First one - simple */
853
process_list = proc->next;
855
/* Second one or later */
856
for(process *p = process_list; p != NULL; p = p->next){
858
p->next = proc->next;
863
/* We are done modifying process list, so unblock signal */
864
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
867
perror("sigprocmask");
871
/* We deleted this process from the list, so we can't go
872
proc->next. Therefore, start over from the beginning of
876
/* This process exited nicely, so print its buffer */
878
bool bret = print_out_password(proc->buffer,
879
proc->buffer_length);
881
perror("print_out_password");
882
exitstatus = EXIT_FAILURE;
886
/* This process has not completed. Does it have any output? */
887
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
888
/* This process had nothing to say at this time */
891
/* Before reading, make the process' data buffer large enough */
892
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
893
proc->buffer = realloc(proc->buffer, proc->buffer_size
894
+ (size_t) BUFFER_SIZE);
895
if (proc->buffer == NULL){
897
exitstatus = EXIT_FAILURE;
900
proc->buffer_size += BUFFER_SIZE;
902
/* Read from the process */
903
ret = read(proc->fd, proc->buffer + proc->buffer_length,
906
/* Read error from this process; ignore the error */
913
proc->buffer_length += (size_t) ret;
921
if(process_list == NULL or exitstatus != EXIT_SUCCESS){
922
/* Fallback if all plugins failed, none are found or an error
925
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
926
char *passwordbuffer = getpass("Password: ");
927
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
929
perror("print_out_password");
930
exitstatus = EXIT_FAILURE;
934
/* Restore old signal handler */
935
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
938
exitstatus = EXIT_FAILURE;
941
if(custom_argv != NULL){
942
for(char **arg = custom_argv+1; *arg != NULL; arg++){
947
free_plugin_list(plugin_list);
953
/* Free the process list and kill the processes */
954
for(process *next; process_list != NULL; process_list = next){
955
next = process_list->next;
956
close(process_list->fd);
957
ret = kill(process_list->pid, SIGTERM);
958
if(ret == -1 and errno != ESRCH){
959
/* set-uid proccesses migth not get closed */
962
free(process_list->buffer);
966
/* Wait for any remaining child processes to terminate */