1
/* -*- coding: utf-8 -*- */
3
* Mandos plugin runner - Run Mandos plugins
5
* Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
7
* This program is free software: you can redistribute it and/or
8
* modify it under the terms of the GNU General Public License as
9
* published by the Free Software Foundation, either version 3 of the
10
* License, or (at your option) any later version.
12
* This program is distributed in the hope that it will be useful, but
13
* WITHOUT ANY WARRANTY; without even the implied warranty of
14
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
* General Public License for more details.
17
* You should have received a copy of the GNU General Public License
18
* along with this program. If not, see
19
* <http://www.gnu.org/licenses/>.
21
* Contact the authors at <mandos@fukt.bsnet.se>.
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() */
42
#include <iso646.h> /* and, or, not */
43
#include <dirent.h> /* DIR, struct dirent, opendir(),
44
readdir(), closedir(), dirfd() */
45
#include <unistd.h> /* struct stat, stat(), S_ISREG(),
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() */
55
#include <errno.h> /* errno */
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 process{
84
volatile bool completed;
89
typedef struct plugin{
90
char *name; /* can be NULL or any plugin name */
99
static plugin *getplugin(char *name, plugin **plugin_list){
100
for (plugin *p = *plugin_list; p != NULL; p = p->next){
101
if ((p->name == name)
102
or (p->name and name and (strcmp(p->name, name) == 0))){
106
/* Create a new plugin */
107
plugin *new_plugin = malloc(sizeof(plugin));
108
if (new_plugin == NULL){
111
char *copy_name = NULL;
113
copy_name = strdup(name);
114
if(copy_name == NULL){
119
*new_plugin = (plugin) { .name = copy_name,
123
.next = *plugin_list };
125
new_plugin->argv = malloc(sizeof(char *) * 2);
126
if (new_plugin->argv == NULL){
131
new_plugin->argv[0] = copy_name;
132
new_plugin->argv[1] = NULL;
134
new_plugin->environ = malloc(sizeof(char *));
135
if(new_plugin->environ == NULL){
137
free(new_plugin->argv);
141
new_plugin->environ[0] = NULL;
142
/* Append the new plugin to the list */
143
*plugin_list = new_plugin;
147
/* Helper function for add_argument and add_environment */
148
static bool add_to_char_array(const char *new, char ***array,
150
/* Resize the pointed-to array to hold one more pointer */
151
*array = realloc(*array, sizeof(char *)
152
* (size_t) ((*len) + 2));
157
/* Make a copy of the new string */
158
char *copy = strdup(new);
162
/* Insert the copy */
163
(*array)[*len] = copy;
165
/* Add a new terminating NULL pointer to the last element */
166
(*array)[*len] = NULL;
170
/* Add to a plugin's argument vector */
171
static bool add_argument(plugin *p, const char *arg){
175
return add_to_char_array(arg, &(p->argv), &(p->argc));
178
/* Add to a plugin's environment */
179
static bool add_environment(plugin *p, const char *def){
183
return add_to_char_array(def, &(p->environ), &(p->envc));
188
* Based on the example in the GNU LibC manual chapter 13.13 "File
190
* *Note File Descriptor Flags:(libc)Descriptor Flags.
192
static int set_cloexec_flag(int fd)
194
int ret = fcntl(fd, F_GETFD, 0);
195
/* If reading the flags failed, return error indication now. */
199
/* Store modified flag word in the descriptor. */
200
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
203
process *process_list = NULL;
205
/* Mark processes as completed when they exit, and save their exit
207
void handle_sigchld(__attribute__((unused)) int sig){
209
process *proc = process_list;
211
pid_t pid = waitpid(-1, &status, WNOHANG);
213
/* Only still running child processes */
217
if (errno != ECHILD){
220
/* No child processes */
224
/* A child exited, find it in process_list */
225
while(proc != NULL and proc->pid != pid){
229
/* Process not found in process list */
232
proc->status = status;
233
proc->completed = true;
237
bool print_out_password(const char *buffer, size_t length){
239
if(length>0 and buffer[length-1] == '\n'){
242
for(size_t written = 0; written < length; written += (size_t)ret){
243
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + 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);
267
int main(int argc, char *argv[]){
268
char *plugindir = NULL;
269
char *argfile = NULL;
273
struct dirent *dirst;
280
int exitstatus = EXIT_SUCCESS;
281
struct sigaction old_sigchld_action;
282
struct sigaction sigchld_action = { .sa_handler = handle_sigchld,
283
.sa_flags = SA_NOCLDSTOP };
284
char **custom_argv = NULL;
287
/* Establish a signal handler */
288
sigemptyset(&sigchld_action.sa_mask);
289
ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
292
exitstatus = EXIT_FAILURE;
295
ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
298
exitstatus = EXIT_FAILURE;
302
/* The options we understand. */
303
struct argp_option options[] = {
304
{ .name = "global-options", .key = 'g',
305
.arg = "OPTION[,OPTION[,...]]",
306
.doc = "Options passed to all plugins" },
307
{ .name = "global-envs", .key = 'e',
309
.doc = "Environment variable passed to all plugins" },
310
{ .name = "options-for", .key = 'o',
311
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
312
.doc = "Options passed only to specified plugin" },
313
{ .name = "envs-for", .key = 'f',
314
.arg = "PLUGIN:ENV=value",
315
.doc = "Environment variable passed to specified plugin" },
316
{ .name = "disable", .key = 'd',
318
.doc = "Disable a specific plugin", .group = 1 },
319
{ .name = "plugin-dir", .key = 128,
321
.doc = "Specify a different plugin directory", .group = 2 },
322
{ .name = "config-file", .key = 129,
324
.doc = "Specify a different configuration file", .group = 2 },
325
{ .name = "userid", .key = 130,
326
.arg = "ID", .flags = 0,
327
.doc = "User ID the plugins will run as", .group = 3 },
328
{ .name = "groupid", .key = 131,
329
.arg = "ID", .flags = 0,
330
.doc = "Group ID the plugins will run as", .group = 3 },
331
{ .name = "debug", .key = 132,
332
.doc = "Debug mode", .group = 4 },
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;
344
while((p = strsep(&arg, ",")) != NULL){
348
if(not add_argument(getplugin(NULL, plugins), p)){
349
perror("add_argument");
350
return ARGP_ERR_UNKNOWN;
360
char *envdef = strdup(arg);
364
if(not add_environment(getplugin(NULL, plugins), envdef)){
365
perror("add_environment");
371
char *p_name = strsep(&arg, ":");
372
if(p_name[0] == '\0'){
375
char *opt = strsep(&arg, ":");
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;
398
char *envdef = strchr(arg, ':');
402
char *p_name = strndup(arg, (size_t) (envdef-arg));
407
if(not add_environment(getplugin(p_name, plugins), envdef)){
408
perror("add_environment");
414
plugin *p = getplugin(arg, plugins);
416
return ARGP_ERR_UNKNOWN;
422
plugindir = strdup(arg);
423
if(plugindir == NULL){
428
argfile = strdup(arg);
434
uid = (uid_t)strtol(arg, NULL, 10);
437
gid = (gid_t)strtol(arg, NULL, 10);
443
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
448
return ARGP_ERR_UNKNOWN;
453
plugin *plugin_list = NULL;
455
struct argp argp = { .options = options, .parser = parse_opt,
456
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
457
.doc = "Mandos plugin runner -- Run plugins" };
459
ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
460
if (ret == ARGP_ERR_UNKNOWN){
461
fprintf(stderr, "Unknown error while parsing arguments\n");
462
exitstatus = EXIT_FAILURE;
466
if (argfile == NULL){
467
conffp = fopen(AFILE, "r");
469
conffp = fopen(argfile, "r");
473
char *org_line = NULL;
474
char *p, *arg, *new_arg, *line;
477
const char whitespace_delims[] = " \r\t\f\v\n";
478
const char comment_delim[] = "#";
481
custom_argv = malloc(sizeof(char*) * 2);
482
if(custom_argv == NULL){
484
exitstatus = EXIT_FAILURE;
487
custom_argv[0] = argv[0];
488
custom_argv[1] = NULL;
491
sret = getline(&org_line, &size, conffp);
497
arg = strsep(&line, comment_delim);
498
while((p = strsep(&arg, whitespace_delims)) != NULL){
505
exitstatus = EXIT_FAILURE;
511
custom_argv = realloc(custom_argv, sizeof(char *)
512
* ((unsigned int) custom_argc + 1));
513
if(custom_argv == NULL){
515
exitstatus = EXIT_FAILURE;
519
custom_argv[custom_argc-1] = new_arg;
520
custom_argv[custom_argc] = NULL;
525
/* Check for harmful errors and go to fallback. Other errors might
526
not affect opening plugins */
527
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
529
exitstatus = EXIT_FAILURE;
534
if(custom_argv != NULL){
535
ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, &plugin_list);
536
if (ret == ARGP_ERR_UNKNOWN){
537
fprintf(stderr, "Unknown error while parsing arguments\n");
538
exitstatus = EXIT_FAILURE;
544
for(plugin *p = plugin_list; p != NULL; p=p->next){
545
fprintf(stderr, "Plugin: %s has %d arguments\n",
546
p->name ? p->name : "Global", p->argc - 1);
547
for(char **a = p->argv; *a != NULL; a++){
548
fprintf(stderr, "\tArg: %s\n", *a);
550
fprintf(stderr, "...and %u environment variables\n", p->envc);
551
for(char **a = p->environ; *a != NULL; a++){
552
fprintf(stderr, "\t%s\n", *a);
567
if (plugindir == NULL){
570
dir = opendir(plugindir);
574
perror("Could not open plugin dir");
575
exitstatus = EXIT_FAILURE;
579
/* Set the FD_CLOEXEC flag on the directory, if possible */
581
int dir_fd = dirfd(dir);
583
ret = set_cloexec_flag(dir_fd);
585
perror("set_cloexec_flag");
586
exitstatus = EXIT_FAILURE;
595
dirst = readdir(dir);
597
// All directory entries have been processed
601
exitstatus = EXIT_FAILURE;
607
d_name_len = strlen(dirst->d_name);
609
// Ignore dotfiles, backup files and other junk
611
bool bad_name = false;
613
const char const *bad_prefixes[] = { ".", "#", NULL };
615
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
617
".dpkg-divert", NULL };
618
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
619
size_t pre_len = strlen(*pre);
620
if((d_name_len >= pre_len)
621
and strncmp((dirst->d_name), *pre, pre_len) == 0){
623
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
624
" with bad prefix %s\n", dirst->d_name, *pre);
635
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
636
size_t suf_len = strlen(*suf);
637
if((d_name_len >= suf_len)
638
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
641
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
642
" with bad suffix %s\n", dirst->d_name, *suf);
655
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
661
ret = stat(filename, &st);
668
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
670
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
671
" with bad type or mode\n", filename);
676
plugin *p = getplugin(dirst->d_name, &plugin_list);
684
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
691
/* Add global arguments to argument list for this plugin */
692
plugin *g = getplugin(NULL, &plugin_list);
694
for(char **a = g->argv + 1; *a != NULL; a++){
695
if(not add_argument(p, *a)){
696
perror("add_argument");
699
/* Add global environment variables */
700
for(char **e = g->environ; *e != NULL; e++){
701
if(not add_environment(p, *e)){
702
perror("add_environment");
707
/* If this plugin has any environment variables, we will call
708
using execve and need to duplicate the environment from this
710
if(p->environ[0] != NULL){
711
for(char **e = environ; *e != NULL; e++){
712
char *copy = strdup(*e);
717
if(not add_environment(p, copy)){
718
perror("add_environment");
727
exitstatus = EXIT_FAILURE;
730
ret = set_cloexec_flag(pipefd[0]);
732
perror("set_cloexec_flag");
733
exitstatus = EXIT_FAILURE;
736
ret = set_cloexec_flag(pipefd[1]);
738
perror("set_cloexec_flag");
739
exitstatus = EXIT_FAILURE;
742
/* Block SIGCHLD until process is safely in process list */
743
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
745
perror("sigprocmask");
746
exitstatus = EXIT_FAILURE;
749
// Starting a new process to be watched
753
exitstatus = EXIT_FAILURE;
757
/* this is the child process */
758
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
763
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
765
perror("sigprocmask");
769
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
776
/* If dir has no file descriptor, we could not set FD_CLOEXEC
777
above and must now close it manually here. */
780
if(p->environ[0] == NULL){
781
if(execv(filename, p->argv) < 0){
786
if(execve(filename, p->argv, p->environ) < 0){
795
close(pipefd[1]); /* close unused write end of pipe */
796
process *new_process = malloc(sizeof(process));
797
if (new_process == NULL){
799
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
801
perror("sigprocmask");
803
exitstatus = EXIT_FAILURE;
807
*new_process = (struct process){ .pid = pid,
809
.next = process_list };
811
process_list = new_process;
812
/* Unblock SIGCHLD so signal handler can be run if this process
813
has already completed */
814
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
816
perror("sigprocmask");
817
exitstatus = EXIT_FAILURE;
821
FD_SET(new_process->fd, &rfds_all);
823
if (maxfd < new_process->fd){
824
maxfd = new_process->fd;
829
free_plugin_list(plugin_list);
835
if (process_list == NULL){
836
fprintf(stderr, "No plugin processes started. Incorrect plugin"
841
fd_set rfds = rfds_all;
842
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
843
if (select_ret == -1){
845
exitstatus = EXIT_FAILURE;
848
/* OK, now either a process completed, or something can be read
850
for(process *proc = process_list; proc ; proc = proc->next){
851
/* Is this process completely done? */
852
if(proc->eof and proc->completed){
853
/* Only accept the plugin output if it exited cleanly */
854
if(not WIFEXITED(proc->status)
855
or WEXITSTATUS(proc->status) != 0){
856
/* Bad exit by plugin */
858
if(WIFEXITED(proc->status)){
859
fprintf(stderr, "Plugin %u exited with status %d\n",
860
(unsigned int) (proc->pid),
861
WEXITSTATUS(proc->status));
862
} else if(WIFSIGNALED(proc->status)) {
863
fprintf(stderr, "Plugin %u killed by signal %d\n",
864
(unsigned int) (proc->pid),
865
WTERMSIG(proc->status));
866
} else if(WCOREDUMP(proc->status)){
867
fprintf(stderr, "Plugin %d dumped core\n",
868
(unsigned int) (proc->pid));
871
/* Remove the plugin */
872
FD_CLR(proc->fd, &rfds_all);
873
/* Block signal while modifying process_list */
874
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
876
perror("sigprocmask");
877
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;
893
/* We are done modifying process list, so unblock signal */
894
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
897
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
906
/* This process exited nicely, so print its buffer */
908
bool bret = print_out_password(proc->buffer,
909
proc->buffer_length);
911
perror("print_out_password");
912
exitstatus = EXIT_FAILURE;
916
/* This process has not completed. Does it have any output? */
917
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
918
/* This process had nothing to say at this time */
921
/* Before reading, make the process' data buffer large enough */
922
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
923
proc->buffer = realloc(proc->buffer, proc->buffer_size
924
+ (size_t) BUFFER_SIZE);
925
if (proc->buffer == NULL){
927
exitstatus = EXIT_FAILURE;
930
proc->buffer_size += BUFFER_SIZE;
932
/* Read from the process */
933
ret = read(proc->fd, proc->buffer + proc->buffer_length,
936
/* Read error from this process; ignore the error */
943
proc->buffer_length += (size_t) ret;
951
if(process_list == NULL or exitstatus != EXIT_SUCCESS){
952
/* Fallback if all plugins failed, none are found or an error
955
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
956
char *passwordbuffer = getpass("Password: ");
957
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
959
perror("print_out_password");
960
exitstatus = EXIT_FAILURE;
964
/* Restore old signal handler */
965
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
968
exitstatus = EXIT_FAILURE;
971
if(custom_argv != NULL){
972
for(char **arg = custom_argv+1; *arg != NULL; arg++){
977
free_plugin_list(plugin_list);
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 */
992
free(process_list->buffer);
996
/* Wait for any remaining child processes to terminate */
1000
if(errno != ECHILD){