3
3
* Mandos plugin runner - Run Mandos plugins
5
* Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
5
* Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
7
7
* This program is free software: you can redistribute it and/or
8
8
* modify it under the terms of the GNU General Public License as
27
27
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
28
28
EXIT_SUCCESS, realloc() */
29
29
#include <stdbool.h> /* bool, true, false */
30
#include <stdio.h> /* perror, popen(), fileno(),
31
fprintf(), stderr, STDOUT_FILENO */
30
#include <stdio.h> /* perror, fileno(), fprintf(),
31
stderr, STDOUT_FILENO */
32
32
#include <sys/types.h> /* DIR, opendir(), stat(), struct
33
33
stat, waitpid(), WIFEXITED(),
34
34
WEXITSTATUS(), wait(), pid_t,
46
46
fcntl(), setuid(), setgid(),
47
47
F_GETFD, F_SETFD, FD_CLOEXEC,
48
48
access(), pipe(), fork(), close()
49
dup2, STDOUT_FILENO, _exit(),
49
dup2(), STDOUT_FILENO, _exit(),
50
50
execv(), write(), read(),
52
52
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
69
69
#define PDIR "/lib/mandos/plugins.d"
70
70
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
72
const char *argp_program_version = "plugin-runner 1.0";
72
const char *argp_program_version = "plugin-runner " VERSION;
73
73
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
75
typedef struct plugin{
76
char *name; /* can be NULL or any plugin name */
77
typedef struct process{
83
/* Variables used for running processes*/
84
90
volatile bool completed;
85
91
volatile int status;
89
typedef struct plugin{
90
char *name; /* can be NULL or any plugin name */
96
92
struct plugin *next;
99
static plugin *getplugin(char *name, plugin **plugin_list){
100
for (plugin *p = *plugin_list; p != NULL; p = p->next){
95
static plugin *plugin_list = NULL;
97
/* Gets an existing plugin based on name,
98
or if none is found, creates a new one */
99
static plugin *getplugin(char *name){
100
/* Check for exiting plugin with that name */
101
for (plugin *p = plugin_list; p != NULL; p = p->next){
101
102
if ((p->name == name)
102
103
or (p->name and name and (strcmp(p->name, name) == 0))){
178
179
/* Add to a plugin's environment */
179
static bool add_environment(plugin *p, const char *def){
180
static bool add_environment(plugin *p, const char *def, bool replace){
184
/* namelen = length of name of environment variable */
185
size_t namelen = (size_t)(strchrnul(def, '=') - def);
186
/* Search for this environment variable */
187
for(char **e = p->environ; *e != NULL; e++){
188
if(strncmp(*e, def, namelen + 1) == 0){
189
/* It already exists */
191
char *new = realloc(*e, strlen(def) + 1);
183
201
return add_to_char_array(def, &(p->environ), &(p->envc));
188
205
* Based on the example in the GNU LibC manual chapter 13.13 "File
189
206
* Descriptor Flags".
190
207
* *Note File Descriptor Flags:(libc)Descriptor Flags.
192
static int set_cloexec_flag(int fd)
209
static int set_cloexec_flag(int fd){
194
210
int ret = fcntl(fd, F_GETFD, 0);
195
211
/* If reading the flags failed, return error indication now. */
200
216
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
203
process *process_list = NULL;
205
220
/* Mark processes as completed when they exit, and save their exit
207
void handle_sigchld(__attribute__((unused)) int sig){
222
static void handle_sigchld(__attribute__((unused)) int sig){
209
process *proc = process_list;
224
plugin *proc = plugin_list;
211
226
pid_t pid = waitpid(-1, &status, WNOHANG);
237
bool print_out_password(const char *buffer, size_t length){
252
/* Prints out a password to stdout */
253
static bool print_out_password(const char *buffer, size_t length){
239
if(length>0 and buffer[length-1] == '\n'){
242
255
for(size_t written = 0; written < length; written += (size_t)ret){
243
256
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
244
257
length - written));
252
static void free_plugin_list(plugin *plugin_list){
253
for(plugin *next; plugin_list != NULL; plugin_list = next){
254
next = plugin_list->next;
255
for(char **arg = plugin_list->argv; *arg != NULL; arg++){
258
free(plugin_list->argv);
259
for(char **env = plugin_list->environ; *env != NULL; env++){
262
free(plugin_list->environ);
265
/* Removes and free a plugin from the plugin list */
266
static void free_plugin(plugin *plugin_node){
268
for(char **arg = plugin_node->argv; *arg != NULL; arg++){
271
free(plugin_node->argv);
272
for(char **env = plugin_node->environ; *env != NULL; env++){
275
free(plugin_node->environ);
276
free(plugin_node->buffer);
278
/* Removes the plugin from the singly-linked list */
279
if(plugin_node == plugin_list){
280
/* First one - simple */
281
plugin_list = plugin_list->next;
283
/* Second one or later */
284
for(plugin *p = plugin_list; p != NULL; p = p->next){
285
if(p->next == plugin_node){
286
p->next = plugin_node->next;
295
static void free_plugin_list(void){
296
while(plugin_list != NULL){
297
free_plugin(plugin_list);
304
338
{ .name = "global-options", .key = 'g',
305
339
.arg = "OPTION[,OPTION[,...]]",
306
340
.doc = "Options passed to all plugins" },
307
{ .name = "global-envs", .key = 'e',
341
{ .name = "global-env", .key = 'G',
308
342
.arg = "VAR=value",
309
343
.doc = "Environment variable passed to all plugins" },
310
344
{ .name = "options-for", .key = 'o',
311
345
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
312
346
.doc = "Options passed only to specified plugin" },
313
{ .name = "envs-for", .key = 'f',
347
{ .name = "env-for", .key = 'E',
314
348
.arg = "PLUGIN:ENV=value",
315
349
.doc = "Environment variable passed to specified plugin" },
316
350
{ .name = "disable", .key = 'd',
318
352
.doc = "Disable a specific plugin", .group = 1 },
353
{ .name = "enable", .key = 'e',
355
.doc = "Enable a specific plugin", .group = 1 },
319
356
{ .name = "plugin-dir", .key = 128,
320
357
.arg = "DIRECTORY",
321
358
.doc = "Specify a different plugin directory", .group = 2 },
336
error_t parse_opt (int key, char *arg, struct argp_state *state) {
337
/* Get the INPUT argument from `argp_parse', which we know is a
338
pointer to our plugin list pointer. */
339
plugin **plugins = state->input;
373
error_t parse_opt (int key, char *arg, __attribute__((unused))
374
struct argp_state *state) {
376
case 'g': /* --global-options */
342
377
if (arg != NULL){
344
379
while((p = strsep(&arg, ",")) != NULL){
345
380
if(p[0] == '\0'){
348
if(not add_argument(getplugin(NULL, plugins), p)){
383
if(not add_argument(getplugin(NULL), p)){
349
384
perror("add_argument");
350
385
return ARGP_ERR_UNKNOWN;
390
case 'G': /* --global-env */
360
char *envdef = strdup(arg);
364
if(not add_environment(getplugin(NULL, plugins), envdef)){
365
perror("add_environment");
394
if(not add_environment(getplugin(NULL), arg, true)){
395
perror("add_environment");
398
case 'o': /* --options-for */
370
399
if (arg != NULL){
371
400
char *p_name = strsep(&arg, ":");
372
if(p_name[0] == '\0'){
401
if(p_name[0] == '\0' or arg == NULL){
375
404
char *opt = strsep(&arg, ":");
405
if(opt[0] == '\0' or opt == NULL){
381
while((p = strsep(&opt, ",")) != NULL){
385
if(not add_argument(getplugin(p_name, plugins), p)){
386
perror("add_argument");
387
return ARGP_ERR_UNKNOWN;
409
while((p = strsep(&opt, ",")) != NULL){
413
if(not add_argument(getplugin(p_name), p)){
414
perror("add_argument");
415
return ARGP_ERR_UNKNOWN;
420
case 'E': /* --env-for */
399
426
if(envdef == NULL){
402
char *p_name = strndup(arg, (size_t) (envdef-arg));
407
if(not add_environment(getplugin(p_name, plugins), envdef)){
430
if(not add_environment(getplugin(arg), envdef+1, true)){
408
431
perror("add_environment");
435
case 'd': /* --disable */
413
436
if (arg != NULL){
414
plugin *p = getplugin(arg, plugins);
437
plugin *p = getplugin(arg);
416
439
return ARGP_ERR_UNKNOWN;
418
441
p->disabled = true;
444
case 'e': /* --enable */
446
plugin *p = getplugin(arg);
448
return ARGP_ERR_UNKNOWN;
453
case 128: /* --plugin-dir */
422
455
plugindir = strdup(arg);
423
456
if(plugindir == NULL){
424
457
perror("strdup");
460
case 129: /* --config-file */
461
/* This is already done by parse_opt_config_file() */
463
case 130: /* --userid */
464
uid = (uid_t)strtol(arg, NULL, 10);
466
case 131: /* --groupid */
467
gid = (gid_t)strtol(arg, NULL, 10);
469
case 132: /* --debug */
473
/* Cryptsetup always passes an argument, which is an empty
474
string if "none" was specified in /etc/crypttab. So if
475
argument was empty, we ignore it silently. */
477
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
483
return ARGP_ERR_UNKNOWN;
488
/* This option parser is the same as parse_opt() above, except it
489
ignores everything but the --config-file option. */
490
error_t parse_opt_config_file (int key, char *arg,
491
__attribute__((unused))
492
struct argp_state *state) {
494
case 'g': /* --global-options */
495
case 'G': /* --global-env */
496
case 'o': /* --options-for */
497
case 'E': /* --env-for */
498
case 'd': /* --disable */
499
case 'e': /* --enable */
500
case 128: /* --plugin-dir */
502
case 129: /* --config-file */
428
504
argfile = strdup(arg);
429
505
if(argfile == NULL){
430
506
perror("strdup");
434
uid = (uid_t)strtol(arg, NULL, 10);
437
gid = (gid_t)strtol(arg, NULL, 10);
509
case 130: /* --userid */
510
case 131: /* --groupid */
511
case 132: /* --debug */
442
512
case ARGP_KEY_ARG:
443
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
445
513
case ARGP_KEY_END:
453
plugin *plugin_list = NULL;
455
struct argp argp = { .options = options, .parser = parse_opt,
456
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
521
struct argp argp = { .options = options,
522
.parser = parse_opt_config_file,
457
524
.doc = "Mandos plugin runner -- Run plugins" };
459
ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
526
/* Parse using the parse_opt_config_file in order to get the custom
527
config file location, if any. */
528
ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
460
529
if (ret == ARGP_ERR_UNKNOWN){
461
530
fprintf(stderr, "Unknown error while parsing arguments\n");
462
531
exitstatus = EXIT_FAILURE;
535
/* Reset to the normal argument parser */
536
argp.parser = parse_opt;
538
/* Open the configfile if available */
466
539
if (argfile == NULL){
467
540
conffp = fopen(AFILE, "r");
469
542
conffp = fopen(argfile, "r");
472
544
if(conffp != NULL){
473
545
char *org_line = NULL;
474
546
char *p, *arg, *new_arg, *line;
607
/* If there was any arguments from configuration file,
608
pass them to parser as command arguments */
534
609
if(custom_argv != NULL){
535
ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, &plugin_list);
610
ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
536
612
if (ret == ARGP_ERR_UNKNOWN){
537
613
fprintf(stderr, "Unknown error while parsing arguments\n");
538
614
exitstatus = EXIT_FAILURE;
619
/* Parse actual command line arguments, to let them override the
621
ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
622
if (ret == ARGP_ERR_UNKNOWN){
623
fprintf(stderr, "Unknown error while parsing arguments\n");
624
exitstatus = EXIT_FAILURE;
544
629
for(plugin *p = plugin_list; p != NULL; p=p->next){
545
630
fprintf(stderr, "Plugin: %s has %d arguments\n",
655
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
739
if(plugindir == NULL){
740
ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
742
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
657
745
perror("asprintf");
691
781
/* Add global arguments to argument list for this plugin */
692
plugin *g = getplugin(NULL, &plugin_list);
782
plugin *g = getplugin(NULL);
694
784
for(char **a = g->argv + 1; *a != NULL; a++){
695
785
if(not add_argument(p, *a)){
699
789
/* Add global environment variables */
700
790
for(char **e = g->environ; *e != NULL; e++){
701
if(not add_environment(p, *e)){
791
if(not add_environment(p, *e, false)){
702
792
perror("add_environment");
710
800
if(p->environ[0] != NULL){
711
801
for(char **e = environ; *e != NULL; e++){
712
char *copy = strdup(*e);
717
if(not add_environment(p, copy)){
802
if(not add_environment(p, *e, false)){
718
803
perror("add_environment");
760
846
perror("sigaction");
761
847
_exit(EXIT_FAILURE);
763
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
849
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
765
851
perror("sigprocmask");
766
852
_exit(EXIT_FAILURE);
769
855
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
880
close(pipefd[1]); /* Close unused write end of pipe */
795
close(pipefd[1]); /* close unused write end of pipe */
796
process *new_process = malloc(sizeof(process));
797
if (new_process == NULL){
882
plugin *new_plugin = getplugin(dirst->d_name);
883
if (new_plugin == NULL){
799
885
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
801
perror("sigprocmask");
887
perror("sigprocmask");
803
889
exitstatus = EXIT_FAILURE;
807
*new_process = (struct process){ .pid = pid,
809
.next = process_list };
811
process_list = new_process;
893
new_plugin->pid = pid;
894
new_plugin->fd = pipefd[0];
812
896
/* Unblock SIGCHLD so signal handler can be run if this process
813
897
has already completed */
814
898
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
821
FD_SET(new_process->fd, &rfds_all);
905
FD_SET(new_plugin->fd, &rfds_all);
823
if (maxfd < new_process->fd){
824
maxfd = new_process->fd;
907
if (maxfd < new_plugin->fd){
908
maxfd = new_plugin->fd;
829
free_plugin_list(plugin_list);
835
if (process_list == NULL){
836
fprintf(stderr, "No plugin processes started. Incorrect plugin"
915
for(plugin *p = plugin_list; p != NULL; p = p->next){
920
fprintf(stderr, "No plugin processes started. Incorrect plugin"
926
/* Main loop while running plugins exist */
841
928
fd_set rfds = rfds_all;
842
929
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
843
930
if (select_ret == -1){
848
935
/* OK, now either a process completed, or something can be read
849
936
from one of them */
850
for(process *proc = process_list; proc ; proc = proc->next){
937
for(plugin *proc = plugin_list; proc != NULL;){
851
938
/* Is this process completely done? */
852
939
if(proc->eof and proc->completed){
853
940
/* Only accept the plugin output if it exited cleanly */
854
941
if(not WIFEXITED(proc->status)
855
942
or WEXITSTATUS(proc->status) != 0){
856
943
/* Bad exit by plugin */
858
946
if(WIFEXITED(proc->status)){
859
947
fprintf(stderr, "Plugin %u exited with status %d\n",
868
956
(unsigned int) (proc->pid));
871
960
/* Remove the plugin */
872
961
FD_CLR(proc->fd, &rfds_all);
873
963
/* Block signal while modifying process_list */
874
964
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
877
967
exitstatus = EXIT_FAILURE;
880
/* Delete this process entry from the list */
881
if(process_list == proc){
882
/* First one - simple */
883
process_list = proc->next;
885
/* Second one or later */
886
for(process *p = process_list; p != NULL; p = p->next){
888
p->next = proc->next;
971
plugin *next_plugin = proc->next;
893
975
/* We are done modifying process list, so unblock signal */
894
976
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
897
979
perror("sigprocmask");
901
/* We deleted this process from the list, so we can't go
902
proc->next. Therefore, start over from the beginning of
980
exitstatus = EXIT_FAILURE;
984
if(plugin_list == NULL){
906
991
/* This process exited nicely, so print its buffer */
908
993
bool bret = print_out_password(proc->buffer,
909
994
proc->buffer_length);
951
if(process_list == NULL or exitstatus != EXIT_SUCCESS){
1039
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
952
1040
/* Fallback if all plugins failed, none are found or an error
955
1043
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
956
1044
char *passwordbuffer = getpass("Password: ");
957
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1045
size_t len = strlen(passwordbuffer);
1046
/* Strip trailing newline */
1047
if(len > 0 and passwordbuffer[len-1] == '\n'){
1048
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1051
bret = print_out_password(passwordbuffer, len);
959
1053
perror("print_out_password");
960
1054
exitstatus = EXIT_FAILURE;
967
1061
perror("sigaction");
968
1062
exitstatus = EXIT_FAILURE;
971
1065
if(custom_argv != NULL){
972
1066
for(char **arg = custom_argv+1; *arg != NULL; arg++){
975
1069
free(custom_argv);
977
free_plugin_list(plugin_list);
979
1072
if(dir != NULL){
983
/* Free the process list and kill the processes */
984
for(process *next; process_list != NULL; process_list = next){
985
next = process_list->next;
986
close(process_list->fd);
987
ret = kill(process_list->pid, SIGTERM);
988
if(ret == -1 and errno != ESRCH){
989
/* set-uid proccesses migth not get closed */
1076
/* Kill the processes */
1077
for(plugin *p = plugin_list; p != NULL; p = p->next){
1080
ret = kill(p->pid, SIGTERM);
1081
if(ret == -1 and errno != ESRCH){
1082
/* Set-uid proccesses might not get closed */
992
free(process_list->buffer);
996
1088
/* Wait for any remaining child processes to terminate */