46
47
fcntl(), setuid(), setgid(),
47
48
F_GETFD, F_SETFD, FD_CLOEXEC,
48
49
access(), pipe(), fork(), close()
49
dup2, STDOUT_FILENO, _exit(),
50
dup2(), STDOUT_FILENO, _exit(),
50
51
execv(), write(), read(),
52
53
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
54
#include <string.h> /* strtok, strlen(), strcpy(),
55
#include <string.h> /* strsep, strlen(), asprintf() */
56
56
#include <errno.h> /* errno */
57
57
#include <argp.h> /* struct argp_option, struct
58
58
argp_state, struct argp,
59
59
argp_parse(), ARGP_ERR_UNKNOWN,
60
ARGP_KEY_END, ARGP_KEY_ARG, error_t */
60
ARGP_KEY_END, ARGP_KEY_ARG,
61
62
#include <signal.h> /* struct sigaction, sigemptyset(),
62
63
sigaddset(), sigaction(),
63
64
sigprocmask(), SIG_BLOCK, SIGCHLD,
64
65
SIG_UNBLOCK, kill() */
65
66
#include <errno.h> /* errno, EBADF */
67
#include <inttypes.h> /* intmax_t, SCNdMAX, PRIdMAX, */
67
69
#define BUFFER_SIZE 256
69
const char *argp_program_version = "plugin-runner 1.0";
71
#define PDIR "/lib/mandos/plugins.d"
72
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
74
const char *argp_program_version = "plugin-runner " VERSION;
70
75
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
77
typedef struct plugin{
78
char *name; /* can be NULL or any plugin name */
74
typedef struct process{
85
/* Variables used for running processes*/
78
89
size_t buffer_size;
79
90
size_t buffer_length;
86
typedef struct plugin{
87
char *name; /* can be NULL or any plugin name */
92
volatile bool completed;
91
94
struct plugin *next;
94
static plugin *getplugin(char *name, plugin **plugin_list){
95
for (plugin *p = *plugin_list; p != NULL; p = p->next){
97
or (p->name and name and (strcmp(p->name, name) == 0))){
97
static plugin *plugin_list = NULL;
99
/* Gets an existing plugin based on name,
100
or if none is found, creates a new one */
101
static plugin *getplugin(char *name){
102
/* Check for exiting plugin with that name */
103
for(plugin *p = plugin_list; p != NULL; p = p->next){
105
or (p->name and name and (strcmp(p->name, name) == 0))){
101
109
/* Create a new plugin */
102
110
plugin *new_plugin = malloc(sizeof(plugin));
103
if (new_plugin == NULL){
107
new_plugin->name = name;
111
if(new_plugin == NULL){
114
char *copy_name = NULL;
116
copy_name = strdup(name);
117
if(copy_name == NULL){
123
*new_plugin = (plugin) { .name = copy_name,
126
.next = plugin_list };
108
128
new_plugin->argv = malloc(sizeof(char *) * 2);
109
if (new_plugin->argv == NULL){
129
if(new_plugin->argv == NULL){
113
new_plugin->argv[0] = name;
134
new_plugin->argv[0] = copy_name;
114
135
new_plugin->argv[1] = NULL;
115
new_plugin->argc = 1;
116
new_plugin->disabled = false;
117
new_plugin->next = *plugin_list;
137
new_plugin->environ = malloc(sizeof(char *));
138
if(new_plugin->environ == NULL){
140
free(new_plugin->argv);
144
new_plugin->environ[0] = NULL;
118
146
/* Append the new plugin to the list */
119
*plugin_list = new_plugin;
147
plugin_list = new_plugin;
120
148
return new_plugin;
123
static void addargument(plugin *p, char *arg){
124
p->argv[p->argc] = arg;
125
p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
126
if (p->argv == NULL){
131
p->argv[p->argc] = NULL;
151
/* Helper function for add_argument and add_environment */
152
static bool add_to_char_array(const char *new, char ***array,
154
/* Resize the pointed-to array to hold one more pointer */
155
*array = realloc(*array, sizeof(char *)
156
* (size_t) ((*len) + 2));
161
/* Make a copy of the new string */
162
char *copy = strdup(new);
166
/* Insert the copy */
167
(*array)[*len] = copy;
169
/* Add a new terminating NULL pointer to the last element */
170
(*array)[*len] = NULL;
174
/* Add to a plugin's argument vector */
175
static bool add_argument(plugin *p, const char *arg){
179
return add_to_char_array(arg, &(p->argv), &(p->argc));
182
/* Add to a plugin's environment */
183
static bool add_environment(plugin *p, const char *def, bool replace){
187
/* namelen = length of name of environment variable */
188
size_t namelen = (size_t)(strchrnul(def, '=') - def);
189
/* Search for this environment variable */
190
for(char **e = p->environ; *e != NULL; e++){
191
if(strncmp(*e, def, namelen + 1) == 0){
192
/* It already exists */
194
char *new = realloc(*e, strlen(def) + 1);
204
return add_to_char_array(def, &(p->environ), &(p->envc));
221
343
{ .name = "global-options", .key = 'g',
222
344
.arg = "OPTION[,OPTION[,...]]",
223
345
.doc = "Options passed to all plugins" },
346
{ .name = "global-env", .key = 'G',
348
.doc = "Environment variable passed to all plugins" },
224
349
{ .name = "options-for", .key = 'o',
225
350
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
226
351
.doc = "Options passed only to specified plugin" },
352
{ .name = "env-for", .key = 'E',
353
.arg = "PLUGIN:ENV=value",
354
.doc = "Environment variable passed to specified plugin" },
227
355
{ .name = "disable", .key = 'd',
229
357
.doc = "Disable a specific plugin", .group = 1 },
358
{ .name = "enable", .key = 'e',
360
.doc = "Enable a specific plugin", .group = 1 },
230
361
{ .name = "plugin-dir", .key = 128,
231
362
.arg = "DIRECTORY",
232
363
.doc = "Specify a different plugin directory", .group = 2 },
233
{ .name = "userid", .key = 129,
234
.arg = "ID", .flags = 0,
235
.doc = "User ID the plugins will run as", .group = 2 },
236
{ .name = "groupid", .key = 130,
237
.arg = "ID", .flags = 0,
238
.doc = "Group ID the plugins will run as", .group = 2 },
239
{ .name = "debug", .key = 131,
240
.doc = "Debug mode", .group = 3 },
364
{ .name = "config-file", .key = 129,
366
.doc = "Specify a different configuration file", .group = 2 },
367
{ .name = "userid", .key = 130,
368
.arg = "ID", .flags = 0,
369
.doc = "User ID the plugins will run as", .group = 3 },
370
{ .name = "groupid", .key = 131,
371
.arg = "ID", .flags = 0,
372
.doc = "Group ID the plugins will run as", .group = 3 },
373
{ .name = "debug", .key = 132,
374
.doc = "Debug mode", .group = 4 },
244
error_t parse_opt (int key, char *arg, struct argp_state *state) {
245
/* Get the INPUT argument from `argp_parse', which we know is a
246
pointer to our plugin list pointer. */
247
plugin **plugins = state->input;
251
char *p = strtok(arg, ",");
253
addargument(getplugin(NULL, plugins), p);
254
p = strtok(NULL, ",");
260
char *name = strtok(arg, ":");
261
char *p = strtok(NULL, ":");
265
addargument(getplugin(name, plugins), p);
266
p = strtok(NULL, ",");
273
getplugin(arg, plugins)->disabled = true;
280
uid = (uid_t)strtol(arg, NULL, 10);
283
gid = (gid_t)strtol(arg, NULL, 10);
378
error_t parse_opt(int key, char *arg, __attribute__((unused))
379
struct argp_state *state) {
381
case 'g': /* --global-options */
384
while((p = strsep(&arg, ",")) != NULL){
388
if(not add_argument(getplugin(NULL), p)){
389
perror("add_argument");
390
return ARGP_ERR_UNKNOWN;
395
case 'G': /* --global-env */
399
if(not add_environment(getplugin(NULL), arg, true)){
400
perror("add_environment");
403
case 'o': /* --options-for */
405
char *p_name = strsep(&arg, ":");
406
if(p_name[0] == '\0' or arg == NULL){
409
char *opt = strsep(&arg, ":");
410
if(opt[0] == '\0' or opt == NULL){
414
while((p = strsep(&opt, ",")) != NULL){
418
if(not add_argument(getplugin(p_name), p)){
419
perror("add_argument");
420
return ARGP_ERR_UNKNOWN;
425
case 'E': /* --env-for */
430
char *envdef = strchr(arg, ':');
435
if(not add_environment(getplugin(arg), envdef+1, true)){
436
perror("add_environment");
440
case 'd': /* --disable */
442
plugin *p = getplugin(arg);
444
return ARGP_ERR_UNKNOWN;
449
case 'e': /* --enable */
451
plugin *p = getplugin(arg);
453
return ARGP_ERR_UNKNOWN;
458
case 128: /* --plugin-dir */
460
plugindir = strdup(arg);
461
if(plugindir == NULL){
465
case 129: /* --config-file */
466
/* This is already done by parse_opt_config_file() */
468
case 130: /* --userid */
469
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
470
if(ret < 1 or tmpmax != (uid_t)tmpmax
471
or arg[numchars] != '\0'){
472
fprintf(stderr, "Bad user ID number: \"%s\", using %"
473
PRIdMAX "\n", arg, (intmax_t)uid);
478
case 131: /* --groupid */
479
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
480
if(ret < 1 or tmpmax != (gid_t)tmpmax
481
or arg[numchars] != '\0'){
482
fprintf(stderr, "Bad group ID number: \"%s\", using %"
483
PRIdMAX "\n", arg, (intmax_t)gid);
488
case 132: /* --debug */
289
if(plus_options != NULL or arg == NULL or arg[0] != '+'){
297
return ARGP_ERR_UNKNOWN;
302
plugin *plugin_list = NULL;
304
struct argp argp = { .options = options, .parser = parse_opt,
305
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
492
* When adding more options before this line, remember to also add a
493
* "case" to the "parse_opt_config_file" function below.
496
/* Cryptsetup always passes an argument, which is an empty
497
string if "none" was specified in /etc/crypttab. So if
498
argument was empty, we ignore it silently. */
500
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
506
return ARGP_ERR_UNKNOWN;
511
/* This option parser is the same as parse_opt() above, except it
512
ignores everything but the --config-file option. */
513
error_t parse_opt_config_file(int key, char *arg,
514
__attribute__((unused))
515
struct argp_state *state) {
517
case 'g': /* --global-options */
518
case 'G': /* --global-env */
519
case 'o': /* --options-for */
520
case 'E': /* --env-for */
521
case 'd': /* --disable */
522
case 'e': /* --enable */
523
case 128: /* --plugin-dir */
525
case 129: /* --config-file */
527
argfile = strdup(arg);
532
case 130: /* --userid */
533
case 131: /* --groupid */
534
case 132: /* --debug */
539
return ARGP_ERR_UNKNOWN;
544
struct argp argp = { .options = options,
545
.parser = parse_opt_config_file,
306
547
.doc = "Mandos plugin runner -- Run plugins" };
308
ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
309
if (ret == ARGP_ERR_UNKNOWN){
549
/* Parse using parse_opt_config_file() in order to get the custom
550
config file location, if any. */
551
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
552
if(ret == ARGP_ERR_UNKNOWN){
310
553
fprintf(stderr, "Unknown error while parsing arguments\n");
311
554
exitstatus = EXIT_FAILURE;
316
/* This is a mangled argument in the form of
317
"+--option+--other-option=parameter+--yet-another-option", etc */
318
/* Make new argc and argv vars, and call argp_parse() again. */
319
plus_options++; /* skip the first '+' character */
320
const char delims[] = "+";
323
plus_argv = malloc(sizeof(char*) * 2);
324
if(plus_argv == NULL){
558
/* Reset to the normal argument parser */
559
argp.parser = parse_opt;
561
/* Open the configfile if available */
563
conffp = fopen(AFILE, "r");
565
conffp = fopen(argfile, "r");
568
char *org_line = NULL;
569
char *p, *arg, *new_arg, *line;
571
const char whitespace_delims[] = " \r\t\f\v\n";
572
const char comment_delim[] = "#";
575
custom_argv = malloc(sizeof(char*) * 2);
576
if(custom_argv == NULL){
325
577
perror("malloc");
326
578
exitstatus = EXIT_FAILURE;
329
plus_argv[0] = argv[0];
331
arg = strtok(plus_options, delims); /* Get first argument */
334
plus_argv = realloc(plus_argv, sizeof(char *)
335
* ((unsigned int) new_argc + 1));
336
if(plus_argv == NULL){
338
exitstatus = EXIT_FAILURE;
341
plus_argv[new_argc-1] = arg;
342
plus_argv[new_argc] = NULL;
343
arg = strtok(NULL, delims); /* Get next argument */
345
ret = argp_parse (&argp, new_argc, plus_argv, 0, 0, &plugin_list);
346
if (ret == ARGP_ERR_UNKNOWN){
581
custom_argv[0] = argv[0];
582
custom_argv[1] = NULL;
584
/* for each line in the config file, strip whitespace and ignore
587
sret = getline(&org_line, &size, conffp);
593
arg = strsep(&line, comment_delim);
594
while((p = strsep(&arg, whitespace_delims)) != NULL){
601
exitstatus = EXIT_FAILURE;
607
custom_argv = realloc(custom_argv, sizeof(char *)
608
* ((unsigned int) custom_argc + 1));
609
if(custom_argv == NULL){
611
exitstatus = EXIT_FAILURE;
615
custom_argv[custom_argc-1] = new_arg;
616
custom_argv[custom_argc] = NULL;
621
/* Check for harmful errors and go to fallback. Other errors might
622
not affect opening plugins */
623
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
625
exitstatus = EXIT_FAILURE;
629
/* If there was any arguments from configuration file,
630
pass them to parser as command arguments */
631
if(custom_argv != NULL){
632
ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
634
if(ret == ARGP_ERR_UNKNOWN){
347
635
fprintf(stderr, "Unknown error while parsing arguments\n");
348
636
exitstatus = EXIT_FAILURE;
641
/* Parse actual command line arguments, to let them override the
643
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
644
if(ret == ARGP_ERR_UNKNOWN){
645
fprintf(stderr, "Unknown error while parsing arguments\n");
646
exitstatus = EXIT_FAILURE;
354
651
for(plugin *p = plugin_list; p != NULL; p=p->next){
355
652
fprintf(stderr, "Plugin: %s has %d arguments\n",
549
886
above and must now close it manually here. */
552
if(execv(filename, p->argv) < 0){
889
if(p->environ[0] == NULL){
890
if(execv(filename, p->argv) < 0){
895
if(execve(filename, p->argv, p->environ) < 0){
903
close(pipefd[1]); /* Close unused write end of pipe */
560
close(pipefd[1]); /* close unused write end of pipe */
561
process *new_process = malloc(sizeof(process));
562
if (new_process == NULL){
564
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
905
plugin *new_plugin = getplugin(dirst->d_name);
906
if(new_plugin == NULL){
908
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
566
perror("sigprocmask");
910
perror("sigprocmask");
568
912
exitstatus = EXIT_FAILURE;
572
*new_process = (struct process){ .pid = pid,
574
.next = process_list };
576
process_list = new_process;
916
new_plugin->pid = pid;
917
new_plugin->fd = pipefd[0];
577
919
/* Unblock SIGCHLD so signal handler can be run if this process
578
920
has already completed */
579
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
921
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
581
923
perror("sigprocmask");
582
924
exitstatus = EXIT_FAILURE;
586
FD_SET(new_process->fd, &rfds_all);
588
if (maxfd < new_process->fd){
589
maxfd = new_process->fd;
594
/* Free the plugin list */
595
for(plugin *next; plugin_list != NULL; plugin_list = next){
596
next = plugin_list->next;
597
free(plugin_list->argv);
928
FD_SET(new_plugin->fd, &rfds_all);
930
if(maxfd < new_plugin->fd){
931
maxfd = new_plugin->fd;
604
if (process_list == NULL){
605
fprintf(stderr, "No plugin processes started. Incorrect plugin"
938
for(plugin *p = plugin_list; p != NULL; p = p->next){
943
fprintf(stderr, "No plugin processes started. Incorrect plugin"
949
/* Main loop while running plugins exist */
610
951
fd_set rfds = rfds_all;
611
952
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
612
if (select_ret == -1){
953
if(select_ret == -1){
613
954
perror("select");
614
955
exitstatus = EXIT_FAILURE;
617
958
/* OK, now either a process completed, or something can be read
618
959
from one of them */
619
for(process *proc = process_list; proc ; proc = proc->next){
960
for(plugin *proc = plugin_list; proc != NULL;){
620
961
/* Is this process completely done? */
621
962
if(proc->eof and proc->completed){
622
963
/* Only accept the plugin output if it exited cleanly */
623
964
if(not WIFEXITED(proc->status)
624
965
or WEXITSTATUS(proc->status) != 0){
625
966
/* Bad exit by plugin */
627
969
if(WIFEXITED(proc->status)){
628
fprintf(stderr, "Plugin %u exited with status %d\n",
629
(unsigned int) (proc->pid),
970
fprintf(stderr, "Plugin %" PRIdMAX " exited with status"
971
" %d\n", (intmax_t) (proc->pid),
630
972
WEXITSTATUS(proc->status));
631
973
} else if(WIFSIGNALED(proc->status)) {
632
fprintf(stderr, "Plugin %u killed by signal %d\n",
633
(unsigned int) (proc->pid),
974
fprintf(stderr, "Plugin %" PRIdMAX " killed by signal"
975
" %d\n", (intmax_t) (proc->pid),
634
976
WTERMSIG(proc->status));
635
977
} else if(WCOREDUMP(proc->status)){
636
fprintf(stderr, "Plugin %d dumped core\n",
637
(unsigned int) (proc->pid));
978
fprintf(stderr, "Plugin %" PRIdMAX " dumped core\n",
979
(intmax_t) (proc->pid));
640
983
/* Remove the plugin */
641
984
FD_CLR(proc->fd, &rfds_all);
642
986
/* Block signal while modifying process_list */
643
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
987
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
645
989
perror("sigprocmask");
646
990
exitstatus = EXIT_FAILURE;
649
/* Delete this process entry from the list */
650
if(process_list == proc){
651
/* First one - simple */
652
process_list = proc->next;
654
/* Second one or later */
655
for(process *p = process_list; p != NULL; p = p->next){
657
p->next = proc->next;
994
plugin *next_plugin = proc->next;
662
998
/* We are done modifying process list, so unblock signal */
663
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
999
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
666
1002
perror("sigprocmask");
670
/* We deleted this process from the list, so we can't go
671
proc->next. Therefore, start over from the beginning of
1003
exitstatus = EXIT_FAILURE;
1007
if(plugin_list == NULL){
675
1014
/* This process exited nicely, so print its buffer */
677
bool bret = print_out_password(proc->buffer, proc->buffer_length);
1016
bool bret = print_out_password(proc->buffer,
1017
proc->buffer_length);
679
1019
perror("print_out_password");
680
1020
exitstatus = EXIT_FAILURE;
684
1025
/* This process has not completed. Does it have any output? */
685
1026
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
686
1027
/* This process had nothing to say at this time */
689
1031
/* Before reading, make the process' data buffer large enough */
690
1032
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
691
1033
proc->buffer = realloc(proc->buffer, proc->buffer_size
692
1034
+ (size_t) BUFFER_SIZE);
693
if (proc->buffer == NULL){
1035
if(proc->buffer == NULL){
694
1036
perror("malloc");
695
1037
exitstatus = EXIT_FAILURE;
698
1040
proc->buffer_size += BUFFER_SIZE;
700
1042
/* Read from the process */
701
ret = read(proc->fd, proc->buffer + proc->buffer_length,
1043
sret = read(proc->fd, proc->buffer + proc->buffer_length,
704
1046
/* Read error from this process; ignore the error */
709
1052
proc->eof = true;
711
proc->buffer_length += (size_t) ret;
1054
proc->buffer_length += (size_t) sret;
719
if(process_list == NULL or exitstatus != EXIT_SUCCESS){
720
/* Fallback if all plugins failed, none are found or an error occured */
1062
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
1063
/* Fallback if all plugins failed, none are found or an error
722
1066
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
723
1067
char *passwordbuffer = getpass("Password: ");
724
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1068
size_t len = strlen(passwordbuffer);
1069
/* Strip trailing newline */
1070
if(len > 0 and passwordbuffer[len-1] == '\n'){
1071
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1074
bret = print_out_password(passwordbuffer, len);
726
1076
perror("print_out_password");
727
1077
exitstatus = EXIT_FAILURE;
732
1081
/* Restore old signal handler */
733
sigaction(SIGCHLD, &old_sigchld_action, NULL);
737
/* Free the plugin list */
738
for(plugin *next; plugin_list != NULL; plugin_list = next){
739
next = plugin_list->next;
740
free(plugin_list->argv);
1082
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1084
perror("sigaction");
1085
exitstatus = EXIT_FAILURE;
1088
if(custom_argv != NULL){
1089
for(char **arg = custom_argv+1; *arg != NULL; arg++){
744
1095
if(dir != NULL){
748
/* Free the process list and kill the processes */
749
for(process *next; process_list != NULL; process_list = next){
750
next = process_list->next;
751
close(process_list->fd);
752
ret = kill(process_list->pid, SIGTERM);
753
if(ret == -1 and errno != ESRCH){
754
/* set-uid proccesses migth not get closed */
1099
/* Kill the processes */
1100
for(plugin *p = plugin_list; p != NULL; p = p->next){
1103
ret = kill(p->pid, SIGTERM);
1104
if(ret == -1 and errno != ESRCH){
1105
/* Set-uid proccesses might not get closed */
757
free(process_list->buffer);
761
1111
/* Wait for any remaining child processes to terminate */