21
21
* Contact the authors at <mandos@fukt.bsnet.se>.
24
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY() */
26
#include <stdio.h> /* popen(), fileno(), fprintf(),
27
stderr, STDOUT_FILENO */
24
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
26
#include <stddef.h> /* size_t, NULL */
27
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
28
EXIT_SUCCESS, realloc() */
29
#include <stdbool.h> /* bool, true, false */
30
#include <stdio.h> /* perror, popen(), fileno(),
31
fprintf(), stderr, STDOUT_FILENO */
32
#include <sys/types.h> /* DIR, opendir(), stat(), struct
33
stat, waitpid(), WIFEXITED(),
34
WEXITSTATUS(), wait(), pid_t,
35
uid_t, gid_t, getuid(), getgid(),
37
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
38
FD_SET(), FD_ISSET(), FD_CLR */
39
#include <sys/wait.h> /* wait(), waitpid(), WIFEXITED(),
41
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
28
42
#include <iso646.h> /* and, or, not */
29
#include <sys/types.h> /* DIR, opendir(), stat(),
30
struct stat, waitpid(),
31
WIFEXITED(), WEXITSTATUS(),
33
#include <sys/wait.h> /* wait() */
34
43
#include <dirent.h> /* DIR, struct dirent, opendir(),
35
readdir(), closedir() */
36
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
44
readdir(), closedir(), dirfd() */
37
45
#include <unistd.h> /* struct stat, stat(), S_ISREG(),
39
#include <fcntl.h> /* fcntl() */
40
#include <stddef.h> /* NULL */
41
#include <stdlib.h> /* EXIT_FAILURE */
42
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
43
FD_SET(), FD_ISSET() */
44
#include <string.h> /* strlen(), strcpy(), strcat() */
45
#include <stdbool.h> /* true */
46
#include <sys/wait.h> /* waitpid(), WIFEXITED(),
46
fcntl(), setuid(), setgid(),
47
F_GETFD, F_SETFD, FD_CLOEXEC,
48
access(), pipe(), fork(), close()
49
dup2, STDOUT_FILENO, _exit(),
50
execv(), write(), read(),
52
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
54
#include <string.h> /* strsep, strlen(), asprintf() */
48
55
#include <errno.h> /* errno */
49
#include <argp.h> /* struct argp_option,
50
struct argp_state, struct argp,
55
typedef struct process{
56
#include <argp.h> /* struct argp_option, struct
57
argp_state, struct argp,
58
argp_parse(), ARGP_ERR_UNKNOWN,
59
ARGP_KEY_END, ARGP_KEY_ARG,
61
#include <signal.h> /* struct sigaction, sigemptyset(),
62
sigaddset(), sigaction(),
63
sigprocmask(), SIG_BLOCK, SIGCHLD,
64
SIG_UNBLOCK, kill() */
65
#include <errno.h> /* errno, EBADF */
67
#define BUFFER_SIZE 256
69
#define PDIR "/lib/mandos/plugins.d"
70
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
72
const char *argp_program_version = "plugin-runner 1.0";
73
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
77
typedef struct plugin{
78
char *name; /* can be NULL or any plugin name */
85
/* Variables used for running processes*/
59
89
size_t buffer_size;
60
90
size_t buffer_length;
67
typedef struct plugin{
68
char *name; /* can be NULL or any plugin name */
92
volatile bool completed;
72
94
struct plugin *next;
75
plugin *getplugin(char *name, plugin **plugin_list){
76
for (plugin *p = *plugin_list; p != NULL; p = p->next){
97
static plugin *plugin_list = NULL;
99
/* Gets a 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){
77
104
if ((p->name == name)
78
105
or (p->name and name and (strcmp(p->name, name) == 0))){
82
109
/* Create a new plugin */
83
110
plugin *new_plugin = malloc(sizeof(plugin));
84
111
if (new_plugin == NULL){
88
new_plugin->name = name;
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 };
89
127
new_plugin->argv = malloc(sizeof(char *) * 2);
90
128
if (new_plugin->argv == NULL){
94
new_plugin->argv[0] = name;
133
new_plugin->argv[0] = copy_name;
95
134
new_plugin->argv[1] = NULL;
97
new_plugin->disabled = false;
98
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;
99
145
/* Append the new plugin to the list */
100
*plugin_list = new_plugin;
146
plugin_list = new_plugin;
101
147
return new_plugin;
104
void addargument(plugin *p, char *arg){
105
p->argv[p->argc] = arg;
106
p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
107
if (p->argv == NULL){
112
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){
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
/* Refuse to add an existing variable */
195
return add_to_char_array(def, &(p->environ), &(p->envc));
128
211
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
131
#define BUFFER_SIZE 256
133
const char *argp_program_version = "plugbasedclient 0.9";
134
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
136
process *process_list = NULL;
138
/* Mark a process as completed when it exits, and save its exit
215
/* Mark processes as completed when they exit, and save their exit
140
217
void handle_sigchld(__attribute__((unused)) int sig){
141
process *proc = process_list;
143
pid_t pid = wait(&status);
144
while(proc != NULL and proc->pid != pid){
148
/* Process not found in process list */
151
proc->status = status;
152
proc->completed = true;
219
plugin *proc = plugin_list;
221
pid_t pid = waitpid(-1, &status, WNOHANG);
223
/* Only still running child processes */
227
if (errno != ECHILD){
230
/* No child processes */
234
/* A child exited, find it in process_list */
235
while(proc != NULL and proc->pid != pid){
239
/* Process not found in process list */
242
proc->status = status;
243
proc->completed = true;
247
/* Prints out a password to stdout */
248
bool print_out_password(const char *buffer, size_t length){
250
if(length>0 and buffer[length-1] == '\n'){
253
for(size_t written = 0; written < length; written += (size_t)ret){
254
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
263
/* Removes and free a plugin from the plugin list */
264
static void free_plugin(plugin *plugin_node){
266
for(char **arg = plugin_node->argv; *arg != NULL; arg++){
269
free(plugin_node->argv);
270
for(char **env = plugin_node->environ; *env != NULL; env++){
273
free(plugin_node->environ);
274
free(plugin_node->buffer);
276
/* Removes the plugin from the singly-linked list */
277
if(plugin_node == plugin_list){
278
/* First one - simple */
279
plugin_list = plugin_list->next;
281
/* Second one or later */
282
for(plugin *p = plugin_list; p != NULL; p = p->next){
283
if(p->next == plugin_node){
284
p->next = plugin_node->next;
293
static void free_plugin_list(void){
294
while(plugin_list != NULL){
295
free_plugin(plugin_list);
155
299
int main(int argc, char *argv[]){
156
const char *plugindir = "/conf/conf.d/mandos/plugins.d";
300
char *plugindir = NULL;
301
char *argfile = NULL;
157
303
size_t d_name_len;
159
305
struct dirent *dirst;
186
336
{ .name = "global-options", .key = 'g',
187
337
.arg = "OPTION[,OPTION[,...]]",
188
338
.doc = "Options passed to all plugins" },
339
{ .name = "global-env", .key = 'e',
341
.doc = "Environment variable passed to all plugins" },
189
342
{ .name = "options-for", .key = 'o',
190
343
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
191
344
.doc = "Options passed only to specified plugin" },
345
{ .name = "env-for", .key = 'f',
346
.arg = "PLUGIN:ENV=value",
347
.doc = "Environment variable passed to specified plugin" },
192
348
{ .name = "disable", .key = 'd',
194
350
.doc = "Disable a specific plugin", .group = 1 },
195
351
{ .name = "plugin-dir", .key = 128,
196
352
.arg = "DIRECTORY",
197
353
.doc = "Specify a different plugin directory", .group = 2 },
198
{ .name = "userid", .key = 129,
199
.arg = "ID", .flags = 0,
200
.doc = "User ID the plugins will run as", .group = 2 },
201
{ .name = "groupid", .key = 130,
202
.arg = "ID", .flags = 0,
203
.doc = "Group ID the plugins will run as", .group = 2 },
204
{ .name = "debug", .key = 131,
205
.doc = "Debug mode", .group = 3 },
354
{ .name = "config-file", .key = 129,
356
.doc = "Specify a different configuration file", .group = 2 },
357
{ .name = "userid", .key = 130,
358
.arg = "ID", .flags = 0,
359
.doc = "User ID the plugins will run as", .group = 3 },
360
{ .name = "groupid", .key = 131,
361
.arg = "ID", .flags = 0,
362
.doc = "Group ID the plugins will run as", .group = 3 },
363
{ .name = "debug", .key = 132,
364
.doc = "Debug mode", .group = 4 },
209
error_t parse_opt (int key, char *arg, struct argp_state *state) {
368
error_t parse_opt (int key, char *arg, __attribute__((unused))
369
struct argp_state *state) {
210
370
/* Get the INPUT argument from `argp_parse', which we know is a
211
371
pointer to our plugin list pointer. */
212
plugin **plugins = state->input;
216
char *p = strtok(arg, ",");
218
addargument(getplugin(NULL, plugins), p);
219
p = strtok(NULL, ",");
225
char *name = strtok(arg, ":");
226
char *p = strtok(NULL, ":");
230
addargument(getplugin(name, plugins), p);
231
p = strtok(NULL, ",");
238
getplugin(arg, plugins)->disabled = true;
373
case 'g': /* --global-options */
376
while((p = strsep(&arg, ",")) != NULL){
380
if(not add_argument(getplugin(NULL), p)){
381
perror("add_argument");
382
return ARGP_ERR_UNKNOWN;
387
case 'e': /* --global-env */
392
char *envdef = strdup(arg);
396
if(not add_environment(getplugin(NULL), envdef)){
397
perror("add_environment");
401
case 'o': /* --options-for */
403
char *p_name = strsep(&arg, ":");
404
if(p_name[0] == '\0'){
407
char *opt = strsep(&arg, ":");
413
while((p = strsep(&opt, ",")) != NULL){
417
if(not add_argument(getplugin(p_name), p)){
418
perror("add_argument");
419
return ARGP_ERR_UNKNOWN;
425
case 'f': /* --env-for */
430
char *envdef = strchr(arg, ':');
434
char *p_name = strndup(arg, (size_t) (envdef-arg));
439
if(not add_environment(getplugin(p_name), envdef)){
440
perror("add_environment");
444
case 'd': /* --disable */
446
plugin *p = getplugin(arg);
448
return ARGP_ERR_UNKNOWN;
453
case 128: /* --plugin-dir */
454
plugindir = strdup(arg);
455
if(plugindir == NULL){
459
case 129: /* --config-file */
460
argfile = strdup(arg);
465
case 130: /* --userid */
245
466
uid = (uid_t)strtol(arg, NULL, 10);
468
case 131: /* --groupid */
248
469
gid = (gid_t)strtol(arg, NULL, 10);
471
case 132: /* --debug */
253
474
case ARGP_KEY_ARG:
475
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
256
477
case ARGP_KEY_END:
264
plugin *plugin_list = NULL;
266
485
struct argp argp = { .options = options, .parser = parse_opt,
486
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
268
487
.doc = "Mandos plugin runner -- Run plugins" };
270
argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
489
ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
490
if (ret == ARGP_ERR_UNKNOWN){
491
fprintf(stderr, "Unknown error while parsing arguments\n");
492
exitstatus = EXIT_FAILURE;
496
/* Opens the configfile if aviable */
497
if (argfile == NULL){
498
conffp = fopen(AFILE, "r");
500
conffp = fopen(argfile, "r");
503
char *org_line = NULL;
504
char *p, *arg, *new_arg, *line;
507
const char whitespace_delims[] = " \r\t\f\v\n";
508
const char comment_delim[] = "#";
511
custom_argv = malloc(sizeof(char*) * 2);
512
if(custom_argv == NULL){
514
exitstatus = EXIT_FAILURE;
517
custom_argv[0] = argv[0];
518
custom_argv[1] = NULL;
520
/* for each line in the config file, strip whitespace and ignore
523
sret = getline(&org_line, &size, conffp);
529
arg = strsep(&line, comment_delim);
530
while((p = strsep(&arg, whitespace_delims)) != NULL){
537
exitstatus = EXIT_FAILURE;
543
custom_argv = realloc(custom_argv, sizeof(char *)
544
* ((unsigned int) custom_argc + 1));
545
if(custom_argv == NULL){
547
exitstatus = EXIT_FAILURE;
551
custom_argv[custom_argc-1] = new_arg;
552
custom_argv[custom_argc] = NULL;
557
/* Check for harmful errors and go to fallback. Other errors might
558
not affect opening plugins */
559
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
561
exitstatus = EXIT_FAILURE;
565
/* If there was any arguments from configuration file,
566
pass them to parser as command arguments */
567
if(custom_argv != NULL){
568
ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
569
if (ret == ARGP_ERR_UNKNOWN){
570
fprintf(stderr, "Unknown error while parsing arguments\n");
571
exitstatus = EXIT_FAILURE;
273
577
for(plugin *p = plugin_list; p != NULL; p=p->next){
274
578
fprintf(stderr, "Plugin: %s has %d arguments\n",
397
plugin *p = getplugin(dirst->d_name, &plugin_list);
399
725
/* Add global arguments to argument list for this plugin */
400
plugin *g = getplugin(NULL, &plugin_list);
401
for(char **a = g->argv + 1; *a != NULL; a++){
726
plugin *g = getplugin(NULL);
728
for(char **a = g->argv + 1; *a != NULL; a++){
729
if(not add_argument(p, *a)){
730
perror("add_argument");
733
/* Add global environment variables */
734
for(char **e = g->environ; *e != NULL; e++){
735
if(not add_environment(p, *e)){
736
perror("add_environment");
741
/* If this plugin has any environment variables, we will call
742
using execve and need to duplicate the environment from this
744
if(p->environ[0] != NULL){
745
for(char **e = environ; *e != NULL; e++){
746
char *copy = strdup(*e);
751
if(not add_environment(p, copy)){
752
perror("add_environment");
406
758
ret = pipe(pipefd);
409
761
exitstatus = EXIT_FAILURE;
764
/* Ask OS to automatic close the pipe on exec */
412
765
ret = set_cloexec_flag(pipefd[0]);
414
767
perror("set_cloexec_flag");
415
768
exitstatus = EXIT_FAILURE;
418
771
ret = set_cloexec_flag(pipefd[1]);
420
773
perror("set_cloexec_flag");
421
774
exitstatus = EXIT_FAILURE;
424
777
/* Block SIGCHLD until process is safely in process list */
425
778
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
427
780
perror("sigprocmask");
428
781
exitstatus = EXIT_FAILURE;
431
784
// Starting a new process to be watched
432
785
pid_t pid = fork();
788
exitstatus = EXIT_FAILURE;
434
792
/* this is the child process */
435
793
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
442
800
perror("sigprocmask");
443
801
_exit(EXIT_FAILURE);
445
dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
804
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
447
810
if(dirfd(dir) < 0){
448
811
/* If dir has no file descriptor, we could not set FD_CLOEXEC
449
812
above and must now close it manually here. */
452
if(execv(filename, p->argv) < 0){
815
if(p->environ[0] == NULL){
816
if(execv(filename, p->argv) < 0){
821
if(execve(filename, p->argv, p->environ) < 0){
829
close(pipefd[1]); /* Close unused write end of pipe */
460
close(pipefd[1]); /* close unused write end of pipe */
461
process *new_process = malloc(sizeof(process));
462
if (new_process == NULL){
831
plugin *new_plugin = getplugin(dirst->d_name);
832
if (new_plugin == NULL){
464
834
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
466
perror("sigprocmask");
836
perror("sigprocmask");
468
838
exitstatus = EXIT_FAILURE;
472
*new_process = (struct process){ .pid = pid,
474
.next = process_list };
476
process_list = new_process;
842
new_plugin->pid = pid;
843
new_plugin->fd = pipefd[0];
477
845
/* Unblock SIGCHLD so signal handler can be run if this process
478
846
has already completed */
479
847
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
481
849
perror("sigprocmask");
482
850
exitstatus = EXIT_FAILURE;
486
FD_SET(new_process->fd, &rfds_all);
488
if (maxfd < new_process->fd){
489
maxfd = new_process->fd;
494
/* Free the plugin list */
495
for(plugin *next; plugin_list != NULL; plugin_list = next){
496
next = plugin_list->next;
497
free(plugin_list->argv);
854
FD_SET(new_plugin->fd, &rfds_all);
856
if (maxfd < new_plugin->fd){
857
maxfd = new_plugin->fd;
504
if (process_list == NULL){
505
fprintf(stderr, "No plugin processes started, exiting\n");
506
exitstatus = EXIT_FAILURE;
865
for(plugin *p = plugin_list; p != NULL; p = p->next){
870
fprintf(stderr, "No plugin processes started. Incorrect plugin"
876
/* Main loop while running plugins exist */
510
878
fd_set rfds = rfds_all;
511
879
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
512
880
if (select_ret == -1){
513
881
perror("select");
514
882
exitstatus = EXIT_FAILURE;
517
885
/* OK, now either a process completed, or something can be read
518
886
from one of them */
519
for(process *proc = process_list; proc ; proc = proc->next){
887
for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
520
888
/* Is this process completely done? */
521
889
if(proc->eof and proc->completed){
522
890
/* Only accept the plugin output if it exited cleanly */
523
891
if(not WIFEXITED(proc->status)
524
892
or WEXITSTATUS(proc->status) != 0){
525
893
/* Bad exit by plugin */
527
896
if(WIFEXITED(proc->status)){
528
fprintf(stderr, "Plugin %d exited with status %d\n",
529
proc->pid, WEXITSTATUS(proc->status));
897
fprintf(stderr, "Plugin %u exited with status %d\n",
898
(unsigned int) (proc->pid),
899
WEXITSTATUS(proc->status));
530
900
} else if(WIFSIGNALED(proc->status)) {
531
fprintf(stderr, "Plugin %d killed by signal %d\n",
532
proc->pid, WTERMSIG(proc->status));
901
fprintf(stderr, "Plugin %u killed by signal %d\n",
902
(unsigned int) (proc->pid),
903
WTERMSIG(proc->status));
533
904
} else if(WCOREDUMP(proc->status)){
534
fprintf(stderr, "Plugin %d dumped core\n", proc->pid);
905
fprintf(stderr, "Plugin %d dumped core\n",
906
(unsigned int) (proc->pid));
537
910
/* Remove the plugin */
538
911
FD_CLR(proc->fd, &rfds_all);
539
913
/* Block signal while modifying process_list */
540
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
914
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
542
916
perror("sigprocmask");
543
917
exitstatus = EXIT_FAILURE;
546
/* Delete this process entry from the list */
547
if(process_list == proc){
548
/* First one - simple */
549
process_list = proc->next;
551
/* Second one or later */
552
for(process *p = process_list; p != NULL; p = p->next){
554
p->next = proc->next;
559
921
/* We are done modifying process list, so unblock signal */
560
922
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
563
925
perror("sigprocmask");
567
/* We deleted this process from the list, so we can't go
568
proc->next. Therefore, start over from the beginning of
926
exitstatus = EXIT_FAILURE;
930
if(plugin_list == NULL){
572
936
/* This process exited nicely, so print its buffer */
573
for(size_t written = 0; written < proc->buffer_length;
574
written += (size_t)ret){
575
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO,
576
proc->buffer + written,
581
exitstatus = EXIT_FAILURE;
938
bool bret = print_out_password(proc->buffer,
939
proc->buffer_length);
941
perror("print_out_password");
942
exitstatus = EXIT_FAILURE;
587
947
/* This process has not completed. Does it have any output? */
588
948
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
589
949
/* This process had nothing to say at this time */
618
if(process_list == NULL){
619
fprintf(stderr, "All plugin processes failed, exiting\n");
620
exitstatus = EXIT_FAILURE;
982
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
983
/* Fallback if all plugins failed, none are found or an error
986
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
987
char *passwordbuffer = getpass("Password: ");
988
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
990
perror("print_out_password");
991
exitstatus = EXIT_FAILURE;
624
995
/* Restore old signal handler */
625
sigaction(SIGCHLD, &old_sigchld_action, NULL);
627
/* Free the plugin list */
628
for(plugin *next; plugin_list != NULL; plugin_list = next){
629
next = plugin_list->next;
630
free(plugin_list->argv);
996
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
999
exitstatus = EXIT_FAILURE;
1002
if(custom_argv != NULL){
1003
for(char **arg = custom_argv+1; *arg != NULL; arg++){
634
1009
if(dir != NULL){