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 plugin{
78
char *name; /* can be NULL or any plugin name */
85
/* Variables used for running processes*/
92
volatile bool completed;
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){
104
if ((p->name == name)
105
or (p->name and name and (strcmp(p->name, name) == 0))){
109
/* Create a new plugin */
110
plugin *new_plugin = malloc(sizeof(plugin));
111
if (new_plugin == NULL){
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 };
127
new_plugin->argv = malloc(sizeof(char *) * 2);
128
if (new_plugin->argv == NULL){
133
new_plugin->argv[0] = copy_name;
134
new_plugin->argv[1] = NULL;
136
new_plugin->environ = malloc(sizeof(char *));
137
if(new_plugin->environ == NULL){
139
free(new_plugin->argv);
143
new_plugin->environ[0] = NULL;
145
/* Append the new plugin to the list */
146
plugin_list = new_plugin;
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
return add_to_char_array(def, &(p->environ), &(p->envc));
190
* Based on the example in the GNU LibC manual chapter 13.13 "File
192
* *Note File Descriptor Flags:(libc)Descriptor Flags.
194
static int set_cloexec_flag(int fd)
196
int ret = fcntl(fd, F_GETFD, 0);
197
/* If reading the flags failed, return error indication now. */
201
/* Store modified flag word in the descriptor. */
202
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
206
/* Mark processes as completed when they exit, and save their exit
208
void handle_sigchld(__attribute__((unused)) int sig){
210
plugin *proc = plugin_list;
212
pid_t pid = waitpid(-1, &status, WNOHANG);
214
/* Only still running child processes */
218
if (errno != ECHILD){
221
/* No child processes */
225
/* A child exited, find it in process_list */
226
while(proc != NULL and proc->pid != pid){
230
/* Process not found in process list */
233
proc->status = status;
234
proc->completed = true;
238
/* Prints out a password to stdout */
239
bool print_out_password(const char *buffer, size_t length){
241
if(length>0 and buffer[length-1] == '\n'){
244
for(size_t written = 0; written < length; written += (size_t)ret){
245
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
254
/* Removes and free a plugin from the plugin list */
255
static void free_plugin(plugin *plugin_node){
257
for(char **arg = plugin_node->argv; *arg != NULL; arg++){
260
free(plugin_node->argv);
261
for(char **env = plugin_node->environ; *env != NULL; env++){
264
free(plugin_node->environ);
265
free(plugin_node->buffer);
267
/* Removes the plugin from the singly-linked list */
268
if(plugin_node == plugin_list){
269
/* First one - simple */
270
plugin_list = plugin_list->next;
272
/* Second one or later */
273
for(plugin *p = plugin_list; p != NULL; p = p->next){
274
if(p->next == plugin_node){
275
p->next = plugin_node->next;
284
static void free_plugin_list(void){
285
while(plugin_list != NULL){
286
free_plugin(plugin_list);
290
int main(int argc, char *argv[]){
291
char *plugindir = NULL;
292
char *argfile = NULL;
296
struct dirent *dirst;
303
int exitstatus = EXIT_SUCCESS;
304
struct sigaction old_sigchld_action;
305
struct sigaction sigchld_action = { .sa_handler = handle_sigchld,
306
.sa_flags = SA_NOCLDSTOP };
307
char **custom_argv = NULL;
310
/* Establish a signal handler */
311
sigemptyset(&sigchld_action.sa_mask);
312
ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
315
exitstatus = EXIT_FAILURE;
318
ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
321
exitstatus = EXIT_FAILURE;
325
/* The options we understand. */
326
struct argp_option options[] = {
327
{ .name = "global-options", .key = 'g',
328
.arg = "OPTION[,OPTION[,...]]",
329
.doc = "Options passed to all plugins" },
330
{ .name = "global-envs", .key = 'e',
332
.doc = "Environment variable passed to all plugins" },
333
{ .name = "options-for", .key = 'o',
334
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
335
.doc = "Options passed only to specified plugin" },
336
{ .name = "envs-for", .key = 'f',
337
.arg = "PLUGIN:ENV=value",
338
.doc = "Environment variable passed to specified plugin" },
339
{ .name = "disable", .key = 'd',
341
.doc = "Disable a specific plugin", .group = 1 },
342
{ .name = "plugin-dir", .key = 128,
344
.doc = "Specify a different plugin directory", .group = 2 },
345
{ .name = "config-file", .key = 129,
347
.doc = "Specify a different configuration file", .group = 2 },
348
{ .name = "userid", .key = 130,
349
.arg = "ID", .flags = 0,
350
.doc = "User ID the plugins will run as", .group = 3 },
351
{ .name = "groupid", .key = 131,
352
.arg = "ID", .flags = 0,
353
.doc = "Group ID the plugins will run as", .group = 3 },
354
{ .name = "debug", .key = 132,
355
.doc = "Debug mode", .group = 4 },
359
error_t parse_opt (int key, char *arg, __attribute__((unused))
360
struct argp_state *state) {
361
/* Get the INPUT argument from `argp_parse', which we know is a
362
pointer to our plugin list pointer. */
364
case 'g': /* --global-options */
367
while((p = strsep(&arg, ",")) != NULL){
371
if(not add_argument(getplugin(NULL), p)){
372
perror("add_argument");
373
return ARGP_ERR_UNKNOWN;
378
case 'e': /* --global-envs */
383
char *envdef = strdup(arg);
387
if(not add_environment(getplugin(NULL), envdef)){
388
perror("add_environment");
392
case 'o': /* --options-for */
394
char *p_name = strsep(&arg, ":");
395
if(p_name[0] == '\0'){
398
char *opt = strsep(&arg, ":");
404
while((p = strsep(&opt, ",")) != NULL){
408
if(not add_argument(getplugin(p_name), p)){
409
perror("add_argument");
410
return ARGP_ERR_UNKNOWN;
416
case 'f': /* --envs-for */
421
char *envdef = strchr(arg, ':');
425
char *p_name = strndup(arg, (size_t) (envdef-arg));
430
if(not add_environment(getplugin(p_name), envdef)){
431
perror("add_environment");
435
case 'd': /* --disable */
437
plugin *p = getplugin(arg);
439
return ARGP_ERR_UNKNOWN;
444
case 128: /* --plugin-dir */
445
plugindir = strdup(arg);
446
if(plugindir == NULL){
450
case 129: /* --config-file */
451
argfile = strdup(arg);
456
case 130: /* --userid */
457
uid = (uid_t)strtol(arg, NULL, 10);
459
case 131: /* --groupid */
460
gid = (gid_t)strtol(arg, NULL, 10);
462
case 132: /* --debug */
466
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
471
return ARGP_ERR_UNKNOWN;
476
struct argp argp = { .options = options, .parser = parse_opt,
477
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
478
.doc = "Mandos plugin runner -- Run plugins" };
480
ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
481
if (ret == ARGP_ERR_UNKNOWN){
482
fprintf(stderr, "Unknown error while parsing arguments\n");
483
exitstatus = EXIT_FAILURE;
487
/* Opens the configfile if aviable */
488
if (argfile == NULL){
489
conffp = fopen(AFILE, "r");
491
conffp = fopen(argfile, "r");
494
char *org_line = NULL;
495
char *p, *arg, *new_arg, *line;
498
const char whitespace_delims[] = " \r\t\f\v\n";
499
const char comment_delim[] = "#";
502
custom_argv = malloc(sizeof(char*) * 2);
503
if(custom_argv == NULL){
505
exitstatus = EXIT_FAILURE;
508
custom_argv[0] = argv[0];
509
custom_argv[1] = NULL;
511
/* for each line in the config file, strip whitespace and ignore
514
sret = getline(&org_line, &size, conffp);
520
arg = strsep(&line, comment_delim);
521
while((p = strsep(&arg, whitespace_delims)) != NULL){
528
exitstatus = EXIT_FAILURE;
534
custom_argv = realloc(custom_argv, sizeof(char *)
535
* ((unsigned int) custom_argc + 1));
536
if(custom_argv == NULL){
538
exitstatus = EXIT_FAILURE;
542
custom_argv[custom_argc-1] = new_arg;
543
custom_argv[custom_argc] = NULL;
548
/* Check for harmful errors and go to fallback. Other errors might
549
not affect opening plugins */
550
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
552
exitstatus = EXIT_FAILURE;
556
/* If there was any arguments from configuration file,
557
pass them to parser as command arguments */
558
if(custom_argv != NULL){
559
ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
560
if (ret == ARGP_ERR_UNKNOWN){
561
fprintf(stderr, "Unknown error while parsing arguments\n");
562
exitstatus = EXIT_FAILURE;
568
for(plugin *p = plugin_list; p != NULL; p=p->next){
569
fprintf(stderr, "Plugin: %s has %d arguments\n",
570
p->name ? p->name : "Global", p->argc - 1);
571
for(char **a = p->argv; *a != NULL; a++){
572
fprintf(stderr, "\tArg: %s\n", *a);
574
fprintf(stderr, "...and %u environment variables\n", p->envc);
575
for(char **a = p->environ; *a != NULL; a++){
576
fprintf(stderr, "\t%s\n", *a);
581
/* Strip permissions down to nobody */
591
if (plugindir == NULL){
594
dir = opendir(plugindir);
598
perror("Could not open plugin dir");
599
exitstatus = EXIT_FAILURE;
603
/* Set the FD_CLOEXEC flag on the directory, if possible */
605
int dir_fd = dirfd(dir);
607
ret = set_cloexec_flag(dir_fd);
609
perror("set_cloexec_flag");
610
exitstatus = EXIT_FAILURE;
618
/* Read and execute any executable in the plugin directory*/
620
dirst = readdir(dir);
622
// All directory entries have been processed
626
exitstatus = EXIT_FAILURE;
632
d_name_len = strlen(dirst->d_name);
634
// Ignore dotfiles, backup files and other junk
636
bool bad_name = false;
638
const char const *bad_prefixes[] = { ".", "#", NULL };
640
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
642
".dpkg-divert", NULL };
643
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
644
size_t pre_len = strlen(*pre);
645
if((d_name_len >= pre_len)
646
and strncmp((dirst->d_name), *pre, pre_len) == 0){
648
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
649
" with bad prefix %s\n", dirst->d_name, *pre);
658
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
659
size_t suf_len = strlen(*suf);
660
if((d_name_len >= suf_len)
661
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
664
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
665
" with bad suffix %s\n", dirst->d_name, *suf);
678
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
684
ret = stat(filename, &st);
691
/* Ignore non-executable files */
692
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
694
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
695
" with bad type or mode\n", filename);
701
plugin *p = getplugin(dirst->d_name);
709
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
716
/* Add global arguments to argument list for this plugin */
717
plugin *g = getplugin(NULL);
719
for(char **a = g->argv + 1; *a != NULL; a++){
720
if(not add_argument(p, *a)){
721
perror("add_argument");
724
/* Add global environment variables */
725
for(char **e = g->environ; *e != NULL; e++){
726
if(not add_environment(p, *e)){
727
perror("add_environment");
732
/* If this plugin has any environment variables, we will call
733
using execve and need to duplicate the environment from this
735
if(p->environ[0] != NULL){
736
for(char **e = environ; *e != NULL; e++){
737
char *copy = strdup(*e);
742
if(not add_environment(p, copy)){
743
perror("add_environment");
752
exitstatus = EXIT_FAILURE;
755
/* Ask OS to automatic close the pipe on exec */
756
ret = set_cloexec_flag(pipefd[0]);
758
perror("set_cloexec_flag");
759
exitstatus = EXIT_FAILURE;
762
ret = set_cloexec_flag(pipefd[1]);
764
perror("set_cloexec_flag");
765
exitstatus = EXIT_FAILURE;
768
/* Block SIGCHLD until process is safely in process list */
769
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
771
perror("sigprocmask");
772
exitstatus = EXIT_FAILURE;
775
// Starting a new process to be watched
779
exitstatus = EXIT_FAILURE;
783
/* this is the child process */
784
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
789
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
791
perror("sigprocmask");
795
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
802
/* If dir has no file descriptor, we could not set FD_CLOEXEC
803
above and must now close it manually here. */
806
if(p->environ[0] == NULL){
807
if(execv(filename, p->argv) < 0){
812
if(execve(filename, p->argv, p->environ) < 0){
820
close(pipefd[1]); /* Close unused write end of pipe */
822
plugin *new_plugin = getplugin(dirst->d_name);
823
if (new_plugin == NULL){
825
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
827
perror("sigprocmask");
829
exitstatus = EXIT_FAILURE;
833
new_plugin->pid = pid;
834
new_plugin->fd = pipefd[0];
836
/* Unblock SIGCHLD so signal handler can be run if this process
837
has already completed */
838
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
840
perror("sigprocmask");
841
exitstatus = EXIT_FAILURE;
845
FD_SET(new_plugin->fd, &rfds_all);
847
if (maxfd < new_plugin->fd){
848
maxfd = new_plugin->fd;
856
for(plugin *p = plugin_list; p != NULL; p = p->next){
861
fprintf(stderr, "No plugin processes started. Incorrect plugin"
867
/* Main loop while running plugins exist */
869
fd_set rfds = rfds_all;
870
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
871
if (select_ret == -1){
873
exitstatus = EXIT_FAILURE;
876
/* OK, now either a process completed, or something can be read
878
for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
879
/* Is this process completely done? */
880
if(proc->eof and proc->completed){
881
/* Only accept the plugin output if it exited cleanly */
882
if(not WIFEXITED(proc->status)
883
or WEXITSTATUS(proc->status) != 0){
884
/* Bad exit by plugin */
887
if(WIFEXITED(proc->status)){
888
fprintf(stderr, "Plugin %u exited with status %d\n",
889
(unsigned int) (proc->pid),
890
WEXITSTATUS(proc->status));
891
} else if(WIFSIGNALED(proc->status)) {
892
fprintf(stderr, "Plugin %u killed by signal %d\n",
893
(unsigned int) (proc->pid),
894
WTERMSIG(proc->status));
895
} else if(WCOREDUMP(proc->status)){
896
fprintf(stderr, "Plugin %d dumped core\n",
897
(unsigned int) (proc->pid));
901
/* Remove the plugin */
902
FD_CLR(proc->fd, &rfds_all);
904
/* Block signal while modifying process_list */
905
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
907
perror("sigprocmask");
908
exitstatus = EXIT_FAILURE;
912
/* We are done modifying process list, so unblock signal */
913
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
916
perror("sigprocmask");
917
exitstatus = EXIT_FAILURE;
921
if(plugin_list == NULL){
927
/* This process exited nicely, so print its buffer */
929
bool bret = print_out_password(proc->buffer,
930
proc->buffer_length);
932
perror("print_out_password");
933
exitstatus = EXIT_FAILURE;
938
/* This process has not completed. Does it have any output? */
939
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
940
/* This process had nothing to say at this time */
943
/* Before reading, make the process' data buffer large enough */
944
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
945
proc->buffer = realloc(proc->buffer, proc->buffer_size
946
+ (size_t) BUFFER_SIZE);
947
if (proc->buffer == NULL){
949
exitstatus = EXIT_FAILURE;
952
proc->buffer_size += BUFFER_SIZE;
954
/* Read from the process */
955
ret = read(proc->fd, proc->buffer + proc->buffer_length,
958
/* Read error from this process; ignore the error */
965
proc->buffer_length += (size_t) ret;
973
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
974
/* Fallback if all plugins failed, none are found or an error
977
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
978
char *passwordbuffer = getpass("Password: ");
979
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
981
perror("print_out_password");
982
exitstatus = EXIT_FAILURE;
986
/* Restore old signal handler */
987
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
990
exitstatus = EXIT_FAILURE;
993
if(custom_argv != NULL){
994
for(char **arg = custom_argv+1; *arg != NULL; arg++){
1004
/* Free the process list and kill the processes */
1005
for(plugin *p = plugin_list; p != NULL; p = p->next){
1008
ret = kill(p->pid, SIGTERM);
1009
if(ret == -1 and errno != ESRCH){
1010
/* Set-uid proccesses might not get closed */
1016
/* Wait for any remaining child processes to terminate */
1020
if(errno != ECHILD){