1
/* -*- coding: utf-8 -*- */
1
/* -*- coding: utf-8; mode: c; mode: orgtbl -*- */
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,
37
38
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
38
39
FD_SET(), FD_ISSET(), FD_CLR */
39
40
#include <sys/wait.h> /* wait(), waitpid(), WIFEXITED(),
41
WEXITSTATUS(), WTERMSIG(),
41
43
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
42
44
#include <iso646.h> /* and, or, not */
43
45
#include <dirent.h> /* DIR, struct dirent, opendir(),
46
48
fcntl(), setuid(), setgid(),
47
49
F_GETFD, F_SETFD, FD_CLOEXEC,
48
50
access(), pipe(), fork(), close()
49
dup2, STDOUT_FILENO, _exit(),
51
dup2(), STDOUT_FILENO, _exit(),
50
52
execv(), write(), read(),
52
54
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
54
#include <string.h> /* strsep, strlen(), asprintf() */
56
#include <string.h> /* strsep, strlen(), asprintf(),
55
58
#include <errno.h> /* errno */
56
59
#include <argp.h> /* struct argp_option, struct
57
60
argp_state, struct argp,
61
64
#include <signal.h> /* struct sigaction, sigemptyset(),
62
65
sigaddset(), sigaction(),
63
66
sigprocmask(), SIG_BLOCK, SIGCHLD,
64
SIG_UNBLOCK, kill() */
67
SIG_UNBLOCK, kill(), sig_atomic_t
65
69
#include <errno.h> /* errno, EBADF */
70
#include <inttypes.h> /* intmax_t, PRIdMAX, strtoimax() */
67
72
#define BUFFER_SIZE 256
69
74
#define PDIR "/lib/mandos/plugins.d"
70
75
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
72
const char *argp_program_version = "plugin-runner 1.0";
77
const char *argp_program_version = "plugin-runner " VERSION;
73
78
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
77
80
typedef struct plugin{
78
81
char *name; /* can be NULL or any plugin name */
89
92
size_t buffer_size;
90
93
size_t buffer_length;
92
volatile bool completed;
95
volatile sig_atomic_t completed;
94
97
struct plugin *next;
97
100
static plugin *plugin_list = NULL;
99
/* Gets a existing plugin based on name,
102
/* Gets an existing plugin based on name,
100
103
or if none is found, creates a new one */
101
104
static plugin *getplugin(char *name){
102
105
/* 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))){
106
for(plugin *p = plugin_list; p != NULL; p = p->next){
108
or (p->name and name and (strcmp(p->name, name) == 0))){
109
112
/* Create a new plugin */
110
113
plugin *new_plugin = malloc(sizeof(plugin));
111
if (new_plugin == NULL){
114
if(new_plugin == NULL){
114
117
char *copy_name = NULL;
115
118
if(name != NULL){
116
119
copy_name = strdup(name);
117
120
if(copy_name == NULL){
122
*new_plugin = (plugin) { .name = copy_name,
125
.next = plugin_list };
126
*new_plugin = (plugin){ .name = copy_name,
129
.next = plugin_list };
127
131
new_plugin->argv = malloc(sizeof(char *) * 2);
128
if (new_plugin->argv == NULL){
132
if(new_plugin->argv == NULL){
130
134
free(new_plugin);
187
191
size_t namelen = (size_t)(strchrnul(def, '=') - def);
188
192
/* Search for this environment variable */
189
193
for(char **e = p->environ; *e != NULL; e++){
190
if(strncmp(*e, def, namelen+1) == 0){
194
if(strncmp(*e, def, namelen + 1) == 0){
191
195
/* It already exists */
193
char *new = realloc(*e, strlen(def));
197
char *new = realloc(*e, strlen(def) + 1);
207
211
* Based on the example in the GNU LibC manual chapter 13.13 "File
208
212
* Descriptor Flags".
209
* *Note File Descriptor Flags:(libc)Descriptor Flags.
213
| [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
211
static int set_cloexec_flag(int fd)
215
static int set_cloexec_flag(int fd){
213
216
int ret = fcntl(fd, F_GETFD, 0);
214
217
/* If reading the flags failed, return error indication now. */
250
254
proc->status = status;
251
proc->completed = true;
255
260
/* Prints out a password to stdout */
256
bool print_out_password(const char *buffer, size_t length){
261
static bool print_out_password(const char *buffer, size_t length){
258
if(length>0 and buffer[length-1] == '\n'){
261
263
for(size_t written = 0; written < length; written += (size_t)ret){
262
264
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
263
265
length - written));
344
348
{ .name = "global-options", .key = 'g',
345
349
.arg = "OPTION[,OPTION[,...]]",
346
350
.doc = "Options passed to all plugins" },
347
{ .name = "global-env", .key = 'e',
351
{ .name = "global-env", .key = 'G',
348
352
.arg = "VAR=value",
349
353
.doc = "Environment variable passed to all plugins" },
350
354
{ .name = "options-for", .key = 'o',
351
355
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
352
356
.doc = "Options passed only to specified plugin" },
353
{ .name = "env-for", .key = 'f',
357
{ .name = "env-for", .key = 'E',
354
358
.arg = "PLUGIN:ENV=value",
355
359
.doc = "Environment variable passed to specified plugin" },
356
360
{ .name = "disable", .key = 'd',
358
362
.doc = "Disable a specific plugin", .group = 1 },
363
{ .name = "enable", .key = 'e',
365
.doc = "Enable a specific plugin", .group = 1 },
359
366
{ .name = "plugin-dir", .key = 128,
360
367
.arg = "DIRECTORY",
361
368
.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. */
383
error_t parse_opt(int key, char *arg, __attribute__((unused))
384
struct argp_state *state){
381
387
case 'g': /* --global-options */
384
while((p = strsep(&arg, ",")) != NULL){
390
while((plugin_option = strsep(&arg, ",")) != NULL){
391
if(plugin_option[0] == '\0'){
388
if(not add_argument(getplugin(NULL), p)){
394
if(not add_argument(getplugin(NULL), plugin_option)){
389
395
perror("add_argument");
390
396
return ARGP_ERR_UNKNOWN;
395
case 'e': /* --global-env */
401
case 'G': /* --global-env */
400
char *envdef = strdup(arg);
404
if(not add_environment(getplugin(NULL), envdef, true)){
405
perror("add_environment");
405
if(not add_environment(getplugin(NULL), arg, true)){
406
perror("add_environment");
409
409
case 'o': /* --options-for */
411
char *p_name = strsep(&arg, ":");
412
if(p_name[0] == '\0'){
415
char *opt = strsep(&arg, ":");
421
while((p = strsep(&opt, ",")) != NULL){
425
if(not add_argument(getplugin(p_name), p)){
426
perror("add_argument");
427
return ARGP_ERR_UNKNOWN;
411
char *plugin_name = strsep(&arg, ":");
412
if(plugin_name[0] == '\0'){
416
while((plugin_option = strsep(&arg, ",")) != NULL){
417
if(not add_argument(getplugin(plugin_name), plugin_option)){
418
perror("add_argument");
419
return ARGP_ERR_UNKNOWN;
433
case 'f': /* --env-for */
424
case 'E': /* --env-for */
439
430
if(envdef == NULL){
442
char *p_name = strndup(arg, (size_t) (envdef-arg));
447
if(not add_environment(getplugin(p_name), envdef, true)){
434
if(not add_environment(getplugin(arg), envdef+1, true)){
448
435
perror("add_environment");
452
439
case 'd': /* --disable */
454
441
plugin *p = getplugin(arg);
456
443
return ARGP_ERR_UNKNOWN;
458
445
p->disabled = true;
448
case 'e': /* --enable */
450
plugin *p = getplugin(arg);
452
return ARGP_ERR_UNKNOWN;
461
457
case 128: /* --plugin-dir */
462
459
plugindir = strdup(arg);
463
460
if(plugindir == NULL){
464
461
perror("strdup");
467
case 129: /* --config-file */
464
case 129: /* --config-file */
465
/* This is already done by parse_opt_config_file() */
467
case 130: /* --userid */
469
tmpmax = strtoimax(arg, &tmp, 10);
470
if(errno != 0 or tmp == arg or *tmp != '\0'
471
or tmpmax != (uid_t)tmpmax){
472
fprintf(stderr, "Bad user ID number: \"%s\", using %"
473
PRIdMAX "\n", arg, (intmax_t)uid);
478
case 131: /* --groupid */
480
tmpmax = strtoimax(arg, &tmp, 10);
481
if(errno != 0 or tmp == arg or *tmp != '\0'
482
or tmpmax != (gid_t)tmpmax){
483
fprintf(stderr, "Bad group ID number: \"%s\", using %"
484
PRIdMAX "\n", arg, (intmax_t)gid);
489
case 132: /* --debug */
493
* When adding more options before this line, remember to also add a
494
* "case" to the "parse_opt_config_file" function below.
497
/* Cryptsetup always passes an argument, which is an empty
498
string if "none" was specified in /etc/crypttab. So if
499
argument was empty, we ignore it silently. */
501
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
507
return ARGP_ERR_UNKNOWN;
512
/* This option parser is the same as parse_opt() above, except it
513
ignores everything but the --config-file option. */
514
error_t parse_opt_config_file(int key, char *arg,
515
__attribute__((unused))
516
struct argp_state *state){
518
case 'g': /* --global-options */
519
case 'G': /* --global-env */
520
case 'o': /* --options-for */
521
case 'E': /* --env-for */
522
case 'd': /* --disable */
523
case 'e': /* --enable */
524
case 128: /* --plugin-dir */
526
case 129: /* --config-file */
468
528
argfile = strdup(arg);
469
529
if(argfile == NULL){
470
530
perror("strdup");
473
533
case 130: /* --userid */
474
uid = (uid_t)strtol(arg, NULL, 10);
476
534
case 131: /* --groupid */
477
gid = (gid_t)strtol(arg, NULL, 10);
479
535
case 132: /* --debug */
482
536
case ARGP_KEY_ARG:
483
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
485
537
case ARGP_KEY_END:
493
struct argp argp = { .options = options, .parser = parse_opt,
545
struct argp argp = { .options = options,
546
.parser = parse_opt_config_file,
495
548
.doc = "Mandos plugin runner -- Run plugins" };
550
/* Parse using parse_opt_config_file() in order to get the custom
551
config file location, if any. */
552
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
553
if(ret == ARGP_ERR_UNKNOWN){
554
fprintf(stderr, "Unknown error while parsing arguments\n");
555
exitstatus = EXIT_FAILURE;
559
/* Reset to the normal argument parser */
560
argp.parser = parse_opt;
497
562
/* Open the configfile if available */
498
if (argfile == NULL){
499
564
conffp = fopen(AFILE, "r");
501
566
conffp = fopen(argfile, "r");
503
568
if(conffp != NULL){
504
569
char *org_line = NULL;
505
570
char *p, *arg, *new_arg, *line;
508
572
const char whitespace_delims[] = " \r\t\f\v\n";
509
573
const char comment_delim[] = "#";
512
576
custom_argv = malloc(sizeof(char*) * 2);
513
577
if(custom_argv == NULL){
552
616
custom_argv[custom_argc-1] = new_arg;
553
custom_argv[custom_argc] = NULL;
617
custom_argv[custom_argc] = NULL;
621
ret = fclose(conffp);
622
}while(ret == EOF and errno == EINTR);
625
exitstatus = EXIT_FAILURE;
558
630
/* Check for harmful errors and go to fallback. Other errors might
559
631
not affect opening plugins */
560
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
632
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
562
634
exitstatus = EXIT_FAILURE;
566
638
/* If there was any arguments from configuration file,
567
639
pass them to parser as command arguments */
568
640
if(custom_argv != NULL){
569
ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
571
if (ret == ARGP_ERR_UNKNOWN){
641
ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
643
if(ret == ARGP_ERR_UNKNOWN){
572
644
fprintf(stderr, "Unknown error while parsing arguments\n");
573
645
exitstatus = EXIT_FAILURE;
578
650
/* 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){
652
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
653
if(ret == ARGP_ERR_UNKNOWN){
582
654
fprintf(stderr, "Unknown error while parsing arguments\n");
583
655
exitstatus = EXIT_FAILURE;
591
663
for(char **a = p->argv; *a != NULL; a++){
592
664
fprintf(stderr, "\tArg: %s\n", *a);
594
fprintf(stderr, "...and %u environment variables\n", p->envc);
666
fprintf(stderr, "...and %d environment variables\n", p->envc);
595
667
for(char **a = p->environ; *a != NULL; a++){
596
668
fprintf(stderr, "\t%s\n", *a);
698
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
771
if(plugindir == NULL){
772
ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
774
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
700
777
perror("asprintf");
704
781
ret = stat(filename, &st);
711
788
/* Ignore non-executable files */
712
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
789
if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
714
791
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
715
792
" with bad type or mode\n", filename);
878
955
free_plugin_list();
882
959
/* Main loop while running plugins exist */
883
960
while(plugin_list){
884
961
fd_set rfds = rfds_all;
885
962
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
886
if (select_ret == -1){
963
if(select_ret == -1){
887
964
perror("select");
888
965
exitstatus = EXIT_FAILURE;
891
968
/* OK, now either a process completed, or something can be read
892
969
from one of them */
893
for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
970
for(plugin *proc = plugin_list; proc != NULL;){
894
971
/* Is this process completely done? */
895
if(proc->eof and proc->completed){
972
if(proc->completed and proc->eof){
896
973
/* Only accept the plugin output if it exited cleanly */
897
974
if(not WIFEXITED(proc->status)
898
975
or WEXITSTATUS(proc->status) != 0){
899
976
/* Bad exit by plugin */
902
979
if(WIFEXITED(proc->status)){
903
fprintf(stderr, "Plugin %u exited with status %d\n",
904
(unsigned int) (proc->pid),
980
fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
981
" status %d\n", proc->name,
982
(intmax_t) (proc->pid),
905
983
WEXITSTATUS(proc->status));
906
} else if(WIFSIGNALED(proc->status)) {
907
fprintf(stderr, "Plugin %u killed by signal %d\n",
908
(unsigned int) (proc->pid),
909
WTERMSIG(proc->status));
984
} else if(WIFSIGNALED(proc->status)){
985
fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
986
" signal %d: %s\n", proc->name,
987
(intmax_t) (proc->pid),
988
WTERMSIG(proc->status),
989
strsignal(WTERMSIG(proc->status)));
910
990
} else if(WCOREDUMP(proc->status)){
911
fprintf(stderr, "Plugin %d dumped core\n",
912
(unsigned int) (proc->pid));
991
fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
992
" core\n", proc->name, (intmax_t) (proc->pid));
916
996
/* Remove the plugin */
917
997
FD_CLR(proc->fd, &rfds_all);
919
999
/* Block signal while modifying process_list */
920
1000
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
923
1003
exitstatus = EXIT_FAILURE;
1007
plugin *next_plugin = proc->next;
926
1008
free_plugin(proc);
927
1011
/* We are done modifying process list, so unblock signal */
928
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
1012
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
931
1015
perror("sigprocmask");
932
1016
exitstatus = EXIT_FAILURE;
953
1038
/* This process has not completed. Does it have any output? */
954
1039
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
955
1040
/* This process had nothing to say at this time */
958
1044
/* Before reading, make the process' data buffer large enough */
959
1045
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
960
1046
proc->buffer = realloc(proc->buffer, proc->buffer_size
961
1047
+ (size_t) BUFFER_SIZE);
962
if (proc->buffer == NULL){
1048
if(proc->buffer == NULL){
963
1049
perror("malloc");
964
1050
exitstatus = EXIT_FAILURE;
967
1053
proc->buffer_size += BUFFER_SIZE;
969
1055
/* Read from the process */
970
ret = read(proc->fd, proc->buffer + proc->buffer_length,
1056
sret = read(proc->fd, proc->buffer + proc->buffer_length,
973
1059
/* Read error from this process; ignore the error */
978
1065
proc->eof = true;
980
proc->buffer_length += (size_t) ret;
1067
proc->buffer_length += (size_t) sret;
988
1075
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
992
1079
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
993
1080
char *passwordbuffer = getpass("Password: ");
994
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1081
size_t len = strlen(passwordbuffer);
1082
/* Strip trailing newline */
1083
if(len > 0 and passwordbuffer[len-1] == '\n'){
1084
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1087
bret = print_out_password(passwordbuffer, len);
996
1089
perror("print_out_password");
997
1090
exitstatus = EXIT_FAILURE;