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 = "mandos-client 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){
122
*new_plugin = (plugin) { .name = copy_name,
125
.next = plugin_list };
108
127
new_plugin->argv = malloc(sizeof(char *) * 2);
109
if (new_plugin->argv == NULL){
128
if(new_plugin->argv == NULL){
113
new_plugin->argv[0] = name;
133
new_plugin->argv[0] = copy_name;
114
134
new_plugin->argv[1] = NULL;
115
new_plugin->argc = 1;
116
new_plugin->disabled = false;
117
new_plugin->next = *plugin_list;
136
new_plugin->environ = malloc(sizeof(char *));
137
if(new_plugin->environ == NULL){
139
free(new_plugin->argv);
143
new_plugin->environ[0] = NULL;
118
145
/* Append the new plugin to the list */
119
*plugin_list = new_plugin;
146
plugin_list = new_plugin;
120
147
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;
150
/* Helper function for add_argument and add_environment */
151
static bool add_to_char_array(const char *new, char ***array,
153
/* Resize the pointed-to array to hold one more pointer */
154
*array = realloc(*array, sizeof(char *)
155
* (size_t) ((*len) + 2));
160
/* Make a copy of the new string */
161
char *copy = strdup(new);
165
/* Insert the copy */
166
(*array)[*len] = copy;
168
/* Add a new terminating NULL pointer to the last element */
169
(*array)[*len] = NULL;
173
/* Add to a plugin's argument vector */
174
static bool add_argument(plugin *p, const char *arg){
178
return add_to_char_array(arg, &(p->argv), &(p->argc));
181
/* Add to a plugin's environment */
182
static bool add_environment(plugin *p, const char *def, bool replace){
186
/* namelen = length of name of environment variable */
187
size_t namelen = (size_t)(strchrnul(def, '=') - def);
188
/* Search for this environment variable */
189
for(char **e = p->environ; *e != NULL; e++){
190
if(strncmp(*e, def, namelen + 1) == 0){
191
/* It already exists */
193
char *new = realloc(*e, strlen(def) + 1);
203
return add_to_char_array(def, &(p->environ), &(p->envc));
221
342
{ .name = "global-options", .key = 'g',
222
343
.arg = "OPTION[,OPTION[,...]]",
223
344
.doc = "Options passed to all plugins" },
345
{ .name = "global-env", .key = 'G',
347
.doc = "Environment variable passed to all plugins" },
224
348
{ .name = "options-for", .key = 'o',
225
349
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
226
350
.doc = "Options passed only to specified plugin" },
351
{ .name = "env-for", .key = 'E',
352
.arg = "PLUGIN:ENV=value",
353
.doc = "Environment variable passed to specified plugin" },
227
354
{ .name = "disable", .key = 'd',
229
356
.doc = "Disable a specific plugin", .group = 1 },
357
{ .name = "enable", .key = 'e',
359
.doc = "Enable a specific plugin", .group = 1 },
230
360
{ .name = "plugin-dir", .key = 128,
231
361
.arg = "DIRECTORY",
232
362
.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 },
363
{ .name = "config-file", .key = 129,
365
.doc = "Specify a different configuration file", .group = 2 },
366
{ .name = "userid", .key = 130,
367
.arg = "ID", .flags = 0,
368
.doc = "User ID the plugins will run as", .group = 3 },
369
{ .name = "groupid", .key = 131,
370
.arg = "ID", .flags = 0,
371
.doc = "Group ID the plugins will run as", .group = 3 },
372
{ .name = "debug", .key = 132,
373
.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);
377
error_t parse_opt(int key, char *arg, __attribute__((unused))
378
struct argp_state *state) {
380
case 'g': /* --global-options */
383
while((p = strsep(&arg, ",")) != NULL){
387
if(not add_argument(getplugin(NULL), p)){
388
perror("add_argument");
389
return ARGP_ERR_UNKNOWN;
394
case 'G': /* --global-env */
398
if(not add_environment(getplugin(NULL), arg, true)){
399
perror("add_environment");
402
case 'o': /* --options-for */
404
char *p_name = strsep(&arg, ":");
405
if(p_name[0] == '\0' or arg == NULL){
408
char *opt = strsep(&arg, ":");
409
if(opt[0] == '\0' or opt == NULL){
413
while((p = strsep(&opt, ",")) != NULL){
417
if(not add_argument(getplugin(p_name), p)){
418
perror("add_argument");
419
return ARGP_ERR_UNKNOWN;
424
case 'E': /* --env-for */
429
char *envdef = strchr(arg, ':');
434
if(not add_environment(getplugin(arg), envdef+1, true)){
435
perror("add_environment");
439
case 'd': /* --disable */
441
plugin *p = getplugin(arg);
443
return ARGP_ERR_UNKNOWN;
448
case 'e': /* --enable */
450
plugin *p = getplugin(arg);
452
return ARGP_ERR_UNKNOWN;
457
case 128: /* --plugin-dir */
459
plugindir = strdup(arg);
460
if(plugindir == NULL){
464
case 129: /* --config-file */
465
/* This is already done by parse_opt_config_file() */
467
case 130: /* --userid */
468
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
469
if(ret < 1 or tmpmax != (uid_t)tmpmax
470
or arg[numchars] != '\0'){
471
fprintf(stderr, "Bad user ID number: \"%s\", using %"
472
PRIdMAX "\n", arg, (intmax_t)uid);
477
case 131: /* --groupid */
478
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
479
if(ret < 1 or tmpmax != (gid_t)tmpmax
480
or arg[numchars] != '\0'){
481
fprintf(stderr, "Bad group ID number: \"%s\", using %"
482
PRIdMAX "\n", arg, (intmax_t)gid);
487
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]",
491
* When adding more options before this line, remember to also add a
492
* "case" to the "parse_opt_config_file" function below.
495
/* Cryptsetup always passes an argument, which is an empty
496
string if "none" was specified in /etc/crypttab. So if
497
argument was empty, we ignore it silently. */
499
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
505
return ARGP_ERR_UNKNOWN;
510
/* This option parser is the same as parse_opt() above, except it
511
ignores everything but the --config-file option. */
512
error_t parse_opt_config_file(int key, char *arg,
513
__attribute__((unused))
514
struct argp_state *state) {
516
case 'g': /* --global-options */
517
case 'G': /* --global-env */
518
case 'o': /* --options-for */
519
case 'E': /* --env-for */
520
case 'd': /* --disable */
521
case 'e': /* --enable */
522
case 128: /* --plugin-dir */
524
case 129: /* --config-file */
526
argfile = strdup(arg);
531
case 130: /* --userid */
532
case 131: /* --groupid */
533
case 132: /* --debug */
538
return ARGP_ERR_UNKNOWN;
543
struct argp argp = { .options = options,
544
.parser = parse_opt_config_file,
306
546
.doc = "Mandos plugin runner -- Run plugins" };
308
ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
309
if (ret == ARGP_ERR_UNKNOWN){
548
/* Parse using parse_opt_config_file() in order to get the custom
549
config file location, if any. */
550
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
551
if(ret == ARGP_ERR_UNKNOWN){
310
552
fprintf(stderr, "Unknown error while parsing arguments\n");
311
553
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){
557
/* Reset to the normal argument parser */
558
argp.parser = parse_opt;
560
/* Open the configfile if available */
562
conffp = fopen(AFILE, "r");
564
conffp = fopen(argfile, "r");
567
char *org_line = NULL;
568
char *p, *arg, *new_arg, *line;
570
const char whitespace_delims[] = " \r\t\f\v\n";
571
const char comment_delim[] = "#";
574
custom_argv = malloc(sizeof(char*) * 2);
575
if(custom_argv == NULL){
325
576
perror("malloc");
326
577
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){
580
custom_argv[0] = argv[0];
581
custom_argv[1] = NULL;
583
/* for each line in the config file, strip whitespace and ignore
586
sret = getline(&org_line, &size, conffp);
592
arg = strsep(&line, comment_delim);
593
while((p = strsep(&arg, whitespace_delims)) != NULL){
600
exitstatus = EXIT_FAILURE;
606
custom_argv = realloc(custom_argv, sizeof(char *)
607
* ((unsigned int) custom_argc + 1));
608
if(custom_argv == NULL){
610
exitstatus = EXIT_FAILURE;
614
custom_argv[custom_argc-1] = new_arg;
615
custom_argv[custom_argc] = NULL;
620
/* Check for harmful errors and go to fallback. Other errors might
621
not affect opening plugins */
622
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
624
exitstatus = EXIT_FAILURE;
628
/* If there was any arguments from configuration file,
629
pass them to parser as command arguments */
630
if(custom_argv != NULL){
631
ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
633
if(ret == ARGP_ERR_UNKNOWN){
347
634
fprintf(stderr, "Unknown error while parsing arguments\n");
348
635
exitstatus = EXIT_FAILURE;
640
/* Parse actual command line arguments, to let them override the
642
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
643
if(ret == ARGP_ERR_UNKNOWN){
644
fprintf(stderr, "Unknown error while parsing arguments\n");
645
exitstatus = EXIT_FAILURE;
354
650
for(plugin *p = plugin_list; p != NULL; p=p->next){
355
651
fprintf(stderr, "Plugin: %s has %d arguments\n",
545
885
above and must now close it manually here. */
548
if(execv(filename, p->argv) < 0){
888
if(p->environ[0] == NULL){
889
if(execv(filename, p->argv) < 0){
894
if(execve(filename, p->argv, p->environ) < 0){
902
close(pipefd[1]); /* Close unused write end of pipe */
556
close(pipefd[1]); /* close unused write end of pipe */
557
process *new_process = malloc(sizeof(process));
558
if (new_process == NULL){
560
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
904
plugin *new_plugin = getplugin(dirst->d_name);
905
if(new_plugin == NULL){
907
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
562
perror("sigprocmask");
909
perror("sigprocmask");
564
911
exitstatus = EXIT_FAILURE;
568
*new_process = (struct process){ .pid = pid,
570
.next = process_list };
572
process_list = new_process;
915
new_plugin->pid = pid;
916
new_plugin->fd = pipefd[0];
573
918
/* Unblock SIGCHLD so signal handler can be run if this process
574
919
has already completed */
575
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
920
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
577
922
perror("sigprocmask");
578
923
exitstatus = EXIT_FAILURE;
582
FD_SET(new_process->fd, &rfds_all);
584
if (maxfd < new_process->fd){
585
maxfd = new_process->fd;
590
/* Free the plugin list */
591
for(plugin *next; plugin_list != NULL; plugin_list = next){
592
next = plugin_list->next;
593
free(plugin_list->argv);
927
FD_SET(new_plugin->fd, &rfds_all);
929
if(maxfd < new_plugin->fd){
930
maxfd = new_plugin->fd;
600
if (process_list == NULL){
601
fprintf(stderr, "No plugin processes started. Incorrect plugin"
937
for(plugin *p = plugin_list; p != NULL; p = p->next){
942
fprintf(stderr, "No plugin processes started. Incorrect plugin"
948
/* Main loop while running plugins exist */
606
950
fd_set rfds = rfds_all;
607
951
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
608
if (select_ret == -1){
952
if(select_ret == -1){
609
953
perror("select");
610
954
exitstatus = EXIT_FAILURE;
613
957
/* OK, now either a process completed, or something can be read
614
958
from one of them */
615
for(process *proc = process_list; proc ; proc = proc->next){
959
for(plugin *proc = plugin_list; proc != NULL;){
616
960
/* Is this process completely done? */
617
961
if(proc->eof and proc->completed){
618
962
/* Only accept the plugin output if it exited cleanly */
619
963
if(not WIFEXITED(proc->status)
620
964
or WEXITSTATUS(proc->status) != 0){
621
965
/* Bad exit by plugin */
623
968
if(WIFEXITED(proc->status)){
624
fprintf(stderr, "Plugin %u exited with status %d\n",
625
(unsigned int) (proc->pid),
969
fprintf(stderr, "Plugin %" PRIdMAX " exited with status"
970
" %d\n", (intmax_t) (proc->pid),
626
971
WEXITSTATUS(proc->status));
627
972
} else if(WIFSIGNALED(proc->status)) {
628
fprintf(stderr, "Plugin %u killed by signal %d\n",
629
(unsigned int) (proc->pid),
973
fprintf(stderr, "Plugin %" PRIdMAX " killed by signal"
974
" %d\n", (intmax_t) (proc->pid),
630
975
WTERMSIG(proc->status));
631
976
} else if(WCOREDUMP(proc->status)){
632
fprintf(stderr, "Plugin %d dumped core\n",
633
(unsigned int) (proc->pid));
977
fprintf(stderr, "Plugin %" PRIdMAX " dumped core\n",
978
(intmax_t) (proc->pid));
636
982
/* Remove the plugin */
637
983
FD_CLR(proc->fd, &rfds_all);
638
985
/* Block signal while modifying process_list */
639
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
986
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
641
988
perror("sigprocmask");
642
989
exitstatus = EXIT_FAILURE;
645
/* Delete this process entry from the list */
646
if(process_list == proc){
647
/* First one - simple */
648
process_list = proc->next;
650
/* Second one or later */
651
for(process *p = process_list; p != NULL; p = p->next){
653
p->next = proc->next;
993
plugin *next_plugin = proc->next;
658
997
/* We are done modifying process list, so unblock signal */
659
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
998
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
662
1001
perror("sigprocmask");
666
/* We deleted this process from the list, so we can't go
667
proc->next. Therefore, start over from the beginning of
1002
exitstatus = EXIT_FAILURE;
1006
if(plugin_list == NULL){
671
1013
/* This process exited nicely, so print its buffer */
673
bool bret = print_out_password(proc->buffer, proc->buffer_length);
1015
bool bret = print_out_password(proc->buffer,
1016
proc->buffer_length);
675
1018
perror("print_out_password");
676
1019
exitstatus = EXIT_FAILURE;
680
1024
/* This process has not completed. Does it have any output? */
681
1025
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
682
1026
/* This process had nothing to say at this time */
685
1030
/* Before reading, make the process' data buffer large enough */
686
1031
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
687
1032
proc->buffer = realloc(proc->buffer, proc->buffer_size
688
1033
+ (size_t) BUFFER_SIZE);
689
if (proc->buffer == NULL){
1034
if(proc->buffer == NULL){
690
1035
perror("malloc");
691
1036
exitstatus = EXIT_FAILURE;
694
1039
proc->buffer_size += BUFFER_SIZE;
696
1041
/* Read from the process */
697
ret = read(proc->fd, proc->buffer + proc->buffer_length,
1042
sret = read(proc->fd, proc->buffer + proc->buffer_length,
700
1045
/* Read error from this process; ignore the error */
705
1051
proc->eof = true;
707
proc->buffer_length += (size_t) ret;
1053
proc->buffer_length += (size_t) sret;
712
if(process_list == NULL){
1061
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
1062
/* Fallback if all plugins failed, none are found or an error
714
1065
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
715
1066
char *passwordbuffer = getpass("Password: ");
716
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1067
size_t len = strlen(passwordbuffer);
1068
/* Strip trailing newline */
1069
if(len > 0 and passwordbuffer[len-1] == '\n'){
1070
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1073
bret = print_out_password(passwordbuffer, len);
718
1075
perror("print_out_password");
719
1076
exitstatus = EXIT_FAILURE;
726
1080
/* Restore old signal handler */
727
sigaction(SIGCHLD, &old_sigchld_action, NULL);
731
/* Free the plugin list */
732
for(plugin *next; plugin_list != NULL; plugin_list = next){
733
next = plugin_list->next;
734
free(plugin_list->argv);
1081
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1083
perror("sigaction");
1084
exitstatus = EXIT_FAILURE;
1087
if(custom_argv != NULL){
1088
for(char **arg = custom_argv+1; *arg != NULL; arg++){
738
1094
if(dir != NULL){
742
/* Free the process list and kill the processes */
743
for(process *next; process_list != NULL; process_list = next){
744
next = process_list->next;
745
close(process_list->fd);
746
ret = kill(process_list->pid, SIGTERM);
747
if(ret == -1 and errno != ESRCH){
748
/* set-uid proccesses migth not get closed */
1098
/* Kill the processes */
1099
for(plugin *p = plugin_list; p != NULL; p = p->next){
1102
ret = kill(p->pid, SIGTERM);
1103
if(ret == -1 and errno != ESRCH){
1104
/* Set-uid proccesses might not get closed */
751
free(process_list->buffer);
755
1110
/* Wait for any remaining child processes to terminate */