3
3
* Mandos plugin runner - Run Mandos plugins
5
* Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
5
* Copyright © 2008,2009 Teddy Hogeborn
6
* Copyright © 2008,2009 Björn Påhlsson
7
8
* This program is free software: you can redistribute it and/or
8
9
* modify it under the terms of the GNU General Public License as
27
28
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
28
29
EXIT_SUCCESS, realloc() */
29
30
#include <stdbool.h> /* bool, true, false */
30
#include <stdio.h> /* perror, popen(), fileno(),
31
fprintf(), stderr, STDOUT_FILENO */
31
#include <stdio.h> /* perror, fileno(), fprintf(),
32
stderr, STDOUT_FILENO */
32
33
#include <sys/types.h> /* DIR, opendir(), stat(), struct
33
34
stat, waitpid(), WIFEXITED(),
34
35
WEXITSTATUS(), wait(), pid_t,
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,
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
71
#define PDIR "/lib/mandos/plugins.d"
70
72
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
72
const char *argp_program_version = "plugin-runner 1.0";
74
const char *argp_program_version = "plugin-runner " VERSION;
73
75
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
77
77
typedef struct plugin{
78
78
char *name; /* can be NULL or any plugin name */
89
89
size_t buffer_size;
90
90
size_t buffer_length;
92
volatile bool completed;
92
volatile sig_atomic_t completed;
94
94
struct plugin *next;
97
97
static plugin *plugin_list = NULL;
99
/* Gets a existing plugin based on name,
99
/* Gets an existing plugin based on name,
100
100
or if none is found, creates a new one */
101
101
static plugin *getplugin(char *name){
102
102
/* Check for exiting plugin with that name */
103
for (plugin *p = plugin_list; p != NULL; p = p->next){
104
if ((p->name == name)
105
or (p->name and name and (strcmp(p->name, name) == 0))){
103
for(plugin *p = plugin_list; p != NULL; p = p->next){
105
or (p->name and name and (strcmp(p->name, name) == 0))){
109
109
/* Create a new plugin */
110
110
plugin *new_plugin = malloc(sizeof(plugin));
111
if (new_plugin == NULL){
111
if(new_plugin == NULL){
114
114
char *copy_name = NULL;
115
115
if(name != NULL){
116
116
copy_name = strdup(name);
117
117
if(copy_name == NULL){
122
*new_plugin = (plugin) { .name = copy_name,
125
.next = plugin_list };
123
*new_plugin = (plugin){ .name = copy_name,
126
.next = plugin_list };
127
128
new_plugin->argv = malloc(sizeof(char *) * 2);
128
if (new_plugin->argv == NULL){
129
if(new_plugin->argv == NULL){
130
131
free(new_plugin);
187
188
size_t namelen = (size_t)(strchrnul(def, '=') - def);
188
189
/* Search for this environment variable */
189
190
for(char **e = p->environ; *e != NULL; e++){
190
if(strncmp(*e, def, namelen+1) == 0){
191
if(strncmp(*e, def, namelen + 1) == 0){
191
192
/* It already exists */
193
char *new = realloc(*e, strlen(def));
194
char *new = realloc(*e, strlen(def) + 1);
208
209
* Descriptor Flags".
209
210
* *Note File Descriptor Flags:(libc)Descriptor Flags.
211
static int set_cloexec_flag(int fd)
212
static int set_cloexec_flag(int fd){
213
213
int ret = fcntl(fd, F_GETFD, 0);
214
214
/* If reading the flags failed, return error indication now. */
250
251
proc->status = status;
251
proc->completed = true;
255
257
/* Prints out a password to stdout */
256
bool print_out_password(const char *buffer, size_t length){
258
static bool print_out_password(const char *buffer, size_t length){
258
if(length>0 and buffer[length-1] == '\n'){
261
260
for(size_t written = 0; written < length; written += (size_t)ret){
262
261
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
263
262
length - written));
344
345
{ .name = "global-options", .key = 'g',
345
346
.arg = "OPTION[,OPTION[,...]]",
346
347
.doc = "Options passed to all plugins" },
347
{ .name = "global-env", .key = 'e',
348
{ .name = "global-env", .key = 'G',
348
349
.arg = "VAR=value",
349
350
.doc = "Environment variable passed to all plugins" },
350
351
{ .name = "options-for", .key = 'o',
351
352
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
352
353
.doc = "Options passed only to specified plugin" },
353
{ .name = "env-for", .key = 'f',
354
{ .name = "env-for", .key = 'E',
354
355
.arg = "PLUGIN:ENV=value",
355
356
.doc = "Environment variable passed to specified plugin" },
356
357
{ .name = "disable", .key = 'd',
358
359
.doc = "Disable a specific plugin", .group = 1 },
360
{ .name = "enable", .key = 'e',
362
.doc = "Enable a specific plugin", .group = 1 },
359
363
{ .name = "plugin-dir", .key = 128,
360
364
.arg = "DIRECTORY",
361
365
.doc = "Specify a different plugin directory", .group = 2 },
376
error_t parse_opt (int key, char *arg, __attribute__((unused))
377
struct argp_state *state) {
378
/* Get the INPUT argument from `argp_parse', which we know is a
379
pointer to our plugin list pointer. */
380
error_t parse_opt(int key, char *arg, __attribute__((unused))
381
struct argp_state *state){
381
383
case 'g': /* --global-options */
384
386
while((p = strsep(&arg, ",")) != NULL){
385
387
if(p[0] == '\0'){
395
case 'e': /* --global-env */
397
case 'G': /* --global-env */
400
char *envdef = strdup(arg);
404
if(not add_environment(getplugin(NULL), envdef, true)){
405
perror("add_environment");
401
if(not add_environment(getplugin(NULL), arg, true)){
402
perror("add_environment");
409
405
case 'o': /* --options-for */
411
407
char *p_name = strsep(&arg, ":");
412
if(p_name[0] == '\0'){
408
if(p_name[0] == '\0' or arg == NULL){
415
411
char *opt = strsep(&arg, ":");
412
if(opt[0] == '\0' or opt == NULL){
421
while((p = strsep(&opt, ",")) != NULL){
425
if(not add_argument(getplugin(p_name), p)){
426
perror("add_argument");
427
return ARGP_ERR_UNKNOWN;
416
while((p = strsep(&opt, ",")) != NULL){
420
if(not add_argument(getplugin(p_name), p)){
421
perror("add_argument");
422
return ARGP_ERR_UNKNOWN;
433
case 'f': /* --env-for */
427
case 'E': /* --env-for */
439
433
if(envdef == NULL){
442
char *p_name = strndup(arg, (size_t) (envdef-arg));
447
if(not add_environment(getplugin(p_name), envdef, true)){
437
if(not add_environment(getplugin(arg), envdef+1, true)){
448
438
perror("add_environment");
452
442
case 'd': /* --disable */
454
444
plugin *p = getplugin(arg);
456
446
return ARGP_ERR_UNKNOWN;
458
448
p->disabled = true;
451
case 'e': /* --enable */
453
plugin *p = getplugin(arg);
455
return ARGP_ERR_UNKNOWN;
461
460
case 128: /* --plugin-dir */
462
462
plugindir = strdup(arg);
463
463
if(plugindir == NULL){
464
464
perror("strdup");
467
467
case 129: /* --config-file */
468
/* This is already done by parse_opt_config_file() */
470
case 130: /* --userid */
471
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
472
if(ret < 1 or tmpmax != (uid_t)tmpmax
473
or arg[numchars] != '\0'){
474
fprintf(stderr, "Bad user ID number: \"%s\", using %"
475
PRIdMAX "\n", arg, (intmax_t)uid);
480
case 131: /* --groupid */
481
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
482
if(ret < 1 or tmpmax != (gid_t)tmpmax
483
or arg[numchars] != '\0'){
484
fprintf(stderr, "Bad group ID number: \"%s\", using %"
485
PRIdMAX "\n", arg, (intmax_t)gid);
490
case 132: /* --debug */
494
* When adding more options before this line, remember to also add a
495
* "case" to the "parse_opt_config_file" function below.
498
/* Cryptsetup always passes an argument, which is an empty
499
string if "none" was specified in /etc/crypttab. So if
500
argument was empty, we ignore it silently. */
502
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
508
return ARGP_ERR_UNKNOWN;
513
/* This option parser is the same as parse_opt() above, except it
514
ignores everything but the --config-file option. */
515
error_t parse_opt_config_file(int key, char *arg,
516
__attribute__((unused))
517
struct argp_state *state){
519
case 'g': /* --global-options */
520
case 'G': /* --global-env */
521
case 'o': /* --options-for */
522
case 'E': /* --env-for */
523
case 'd': /* --disable */
524
case 'e': /* --enable */
525
case 128: /* --plugin-dir */
527
case 129: /* --config-file */
468
529
argfile = strdup(arg);
469
530
if(argfile == NULL){
470
531
perror("strdup");
473
534
case 130: /* --userid */
474
uid = (uid_t)strtol(arg, NULL, 10);
476
535
case 131: /* --groupid */
477
gid = (gid_t)strtol(arg, NULL, 10);
479
536
case 132: /* --debug */
482
537
case ARGP_KEY_ARG:
483
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
485
538
case ARGP_KEY_END:
493
struct argp argp = { .options = options, .parser = parse_opt,
546
struct argp argp = { .options = options,
547
.parser = parse_opt_config_file,
495
549
.doc = "Mandos plugin runner -- Run plugins" };
551
/* Parse using parse_opt_config_file() in order to get the custom
552
config file location, if any. */
553
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
554
if(ret == ARGP_ERR_UNKNOWN){
555
fprintf(stderr, "Unknown error while parsing arguments\n");
556
exitstatus = EXIT_FAILURE;
560
/* Reset to the normal argument parser */
561
argp.parser = parse_opt;
497
563
/* Open the configfile if available */
498
if (argfile == NULL){
499
565
conffp = fopen(AFILE, "r");
501
567
conffp = fopen(argfile, "r");
566
631
/* If there was any arguments from configuration file,
567
632
pass them to parser as command arguments */
568
633
if(custom_argv != NULL){
569
ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
571
if (ret == ARGP_ERR_UNKNOWN){
634
ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
636
if(ret == ARGP_ERR_UNKNOWN){
572
637
fprintf(stderr, "Unknown error while parsing arguments\n");
573
638
exitstatus = EXIT_FAILURE;
578
643
/* Parse actual command line arguments, to let them override the
580
ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
581
if (ret == ARGP_ERR_UNKNOWN){
645
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
646
if(ret == ARGP_ERR_UNKNOWN){
582
647
fprintf(stderr, "Unknown error while parsing arguments\n");
583
648
exitstatus = EXIT_FAILURE;
591
656
for(char **a = p->argv; *a != NULL; a++){
592
657
fprintf(stderr, "\tArg: %s\n", *a);
594
fprintf(stderr, "...and %u environment variables\n", p->envc);
659
fprintf(stderr, "...and %d environment variables\n", p->envc);
595
660
for(char **a = p->environ; *a != NULL; a++){
596
661
fprintf(stderr, "\t%s\n", *a);
698
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
764
if(plugindir == NULL){
765
ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
767
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
700
770
perror("asprintf");
704
774
ret = stat(filename, &st);
711
781
/* Ignore non-executable files */
712
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
782
if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
714
784
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
715
785
" with bad type or mode\n", filename);
878
947
free_plugin_list();
882
951
/* Main loop while running plugins exist */
883
952
while(plugin_list){
884
953
fd_set rfds = rfds_all;
885
954
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
886
if (select_ret == -1){
955
if(select_ret == -1){
887
956
perror("select");
888
957
exitstatus = EXIT_FAILURE;
891
960
/* OK, now either a process completed, or something can be read
892
961
from one of them */
893
for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
962
for(plugin *proc = plugin_list; proc != NULL;){
894
963
/* Is this process completely done? */
895
if(proc->eof and proc->completed){
964
if(proc->completed and proc->eof){
896
965
/* Only accept the plugin output if it exited cleanly */
897
966
if(not WIFEXITED(proc->status)
898
967
or WEXITSTATUS(proc->status) != 0){
902
971
if(WIFEXITED(proc->status)){
903
fprintf(stderr, "Plugin %u exited with status %d\n",
904
(unsigned int) (proc->pid),
972
fprintf(stderr, "Plugin %" PRIdMAX " exited with status"
973
" %d\n", (intmax_t) (proc->pid),
905
974
WEXITSTATUS(proc->status));
906
} else if(WIFSIGNALED(proc->status)) {
907
fprintf(stderr, "Plugin %u killed by signal %d\n",
908
(unsigned int) (proc->pid),
975
} else if(WIFSIGNALED(proc->status)){
976
fprintf(stderr, "Plugin %" PRIdMAX " killed by signal"
977
" %d\n", (intmax_t) (proc->pid),
909
978
WTERMSIG(proc->status));
910
979
} else if(WCOREDUMP(proc->status)){
911
fprintf(stderr, "Plugin %d dumped core\n",
912
(unsigned int) (proc->pid));
980
fprintf(stderr, "Plugin %" PRIdMAX " dumped core\n",
981
(intmax_t) (proc->pid));
923
992
exitstatus = EXIT_FAILURE;
996
plugin *next_plugin = proc->next;
926
997
free_plugin(proc);
927
1000
/* We are done modifying process list, so unblock signal */
928
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
1001
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
931
1004
perror("sigprocmask");
932
1005
exitstatus = EXIT_FAILURE;
953
1027
/* This process has not completed. Does it have any output? */
954
1028
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
955
1029
/* This process had nothing to say at this time */
958
1033
/* Before reading, make the process' data buffer large enough */
959
1034
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
960
1035
proc->buffer = realloc(proc->buffer, proc->buffer_size
961
1036
+ (size_t) BUFFER_SIZE);
962
if (proc->buffer == NULL){
1037
if(proc->buffer == NULL){
963
1038
perror("malloc");
964
1039
exitstatus = EXIT_FAILURE;
967
1042
proc->buffer_size += BUFFER_SIZE;
969
1044
/* Read from the process */
970
ret = read(proc->fd, proc->buffer + proc->buffer_length,
1045
sret = read(proc->fd, proc->buffer + proc->buffer_length,
973
1048
/* Read error from this process; ignore the error */
978
1054
proc->eof = true;
980
proc->buffer_length += (size_t) ret;
1056
proc->buffer_length += (size_t) sret;
992
1068
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
993
1069
char *passwordbuffer = getpass("Password: ");
994
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1070
size_t len = strlen(passwordbuffer);
1071
/* Strip trailing newline */
1072
if(len > 0 and passwordbuffer[len-1] == '\n'){
1073
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1076
bret = print_out_password(passwordbuffer, len);
996
1078
perror("print_out_password");
997
1079
exitstatus = EXIT_FAILURE;