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() */
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(), strcpy(),
56
#include <errno.h> /* errno */
57
#include <argp.h> /* struct argp_option, struct
58
argp_state, struct argp,
59
argp_parse(), ARGP_ERR_UNKNOWN,
60
ARGP_KEY_END, ARGP_KEY_ARG, error_t */
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
68
#define ARGFILE "/conf/conf.d/mandos/plugins.conf"
70
const char *argp_program_version = "plugin-runner 1.0";
71
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
75
typedef struct process{
87
typedef struct plugin{
88
char *name; /* can be NULL or any plugin name */
95
static plugin *getplugin(char *name, plugin **plugin_list){
96
for (plugin *p = *plugin_list; p != NULL; p = p->next){
98
or (p->name and name and (strcmp(p->name, name) == 0))){
102
/* Create a new plugin */
103
plugin *new_plugin = malloc(sizeof(plugin));
104
if (new_plugin == NULL){
108
new_plugin->name = name;
109
new_plugin->argv = malloc(sizeof(char *) * 2);
110
if (new_plugin->argv == NULL){
114
new_plugin->argv[0] = name;
115
new_plugin->argv[1] = NULL;
116
new_plugin->argc = 1;
117
new_plugin->disabled = false;
118
new_plugin->next = *plugin_list;
119
/* Append the new plugin to the list */
120
*plugin_list = new_plugin;
124
static void addargument(plugin *p, char *arg){
125
p->argv[p->argc] = arg;
126
p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
127
if (p->argv == NULL){
132
p->argv[p->argc] = NULL;
136
* Based on the example in the GNU LibC manual chapter 13.13 "File
138
* *Note File Descriptor Flags:(libc)Descriptor Flags.
140
static int set_cloexec_flag(int fd)
142
int ret = fcntl(fd, F_GETFD, 0);
143
/* If reading the flags failed, return error indication now. */
147
/* Store modified flag word in the descriptor. */
148
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
151
process *process_list = NULL;
153
/* Mark a process as completed when it exits, and save its exit
155
void handle_sigchld(__attribute__((unused)) int sig){
156
process *proc = process_list;
158
pid_t pid = wait(&status);
163
while(proc != NULL and proc->pid != pid){
167
/* Process not found in process list */
170
proc->status = status;
171
proc->completed = true;
174
bool print_out_password(const char *buffer, size_t length){
176
if(length>0 and buffer[length-1] == '\n'){
179
for(size_t written = 0; written < length; written += (size_t)ret){
180
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
189
char ** addcustomargument(char **argv, int *argc, char *arg){
193
argv = malloc(sizeof(char*) * 2);
197
argv[0] = NULL; /* Will be set to argv[0] in main before parsing */
201
argv = realloc(argv, sizeof(char *)
202
* ((unsigned int) *argc + 1));
211
int main(int argc, char *argv[]){
212
const char *plugindir = "/lib/mandos/plugins.d";
213
const char *argfile = ARGFILE;
217
struct dirent *dirst;
224
int exitstatus = EXIT_SUCCESS;
225
struct sigaction old_sigchld_action;
226
struct sigaction sigchld_action = { .sa_handler = handle_sigchld,
227
.sa_flags = SA_NOCLDSTOP };
228
char **custom_argv = NULL;
231
/* Establish a signal handler */
232
sigemptyset(&sigchld_action.sa_mask);
233
ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
238
ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
244
/* The options we understand. */
245
struct argp_option options[] = {
246
{ .name = "global-options", .key = 'g',
247
.arg = "OPTION[,OPTION[,...]]",
248
.doc = "Options passed to all plugins" },
249
{ .name = "options-for", .key = 'o',
250
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
251
.doc = "Options passed only to specified plugin" },
252
{ .name = "disable", .key = 'd',
254
.doc = "Disable a specific plugin", .group = 1 },
255
{ .name = "plugin-dir", .key = 128,
257
.doc = "Specify a different plugin directory", .group = 2 },
258
{ .name = "userid", .key = 129,
259
.arg = "ID", .flags = 0,
260
.doc = "User ID the plugins will run as", .group = 2 },
261
{ .name = "groupid", .key = 130,
262
.arg = "ID", .flags = 0,
263
.doc = "Group ID the plugins will run as", .group = 2 },
264
{ .name = "debug", .key = 131,
265
.doc = "Debug mode", .group = 3 },
269
error_t parse_opt (int key, char *arg, struct argp_state *state) {
270
/* Get the INPUT argument from `argp_parse', which we know is a
271
pointer to our plugin list pointer. */
272
plugin **plugins = state->input;
277
while((p = strsep(&arg, ",")) != NULL){
281
addargument(getplugin(NULL, plugins), p);
287
char *name = strsep(&arg, ":");
291
char *opt = strsep(&arg, ":");
297
while((p = strsep(&opt, ",")) != NULL){
301
addargument(getplugin(name, plugins), p);
308
getplugin(arg, plugins)->disabled = true;
315
uid = (uid_t)strtol(arg, NULL, 10);
318
gid = (gid_t)strtol(arg, NULL, 10);
324
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
329
return ARGP_ERR_UNKNOWN;
334
plugin *plugin_list = NULL;
336
struct argp argp = { .options = options, .parser = parse_opt,
337
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
338
.doc = "Mandos plugin runner -- Run plugins" };
340
ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
341
if (ret == ARGP_ERR_UNKNOWN){
342
fprintf(stderr, "Unknown error while parsing arguments\n");
343
exitstatus = EXIT_FAILURE;
347
conffp = fopen(argfile, "r");
349
char *org_line = NULL;
352
char *p, *arg, *new_arg, *line;
353
const char whitespace_delims[] = " \r\t\f\v\n";
354
const char comment_delim[] = "#";
357
sret = getline(&org_line, &size, conffp);
363
arg = strsep(&line, comment_delim);
364
while((p = strsep(&arg, whitespace_delims)) != NULL){
369
custom_argv = addcustomargument(custom_argv, &custom_argc, new_arg);
370
if (custom_argv == NULL){
371
perror("addcustomargument");
372
exitstatus = EXIT_FAILURE;
379
/* Check for harmful errors and go to fallback. Other errors might
380
not affect opening plugins */
381
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
383
exitstatus = EXIT_FAILURE;
388
if(custom_argv != NULL){
389
custom_argv[0] = argv[0];
390
ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, &plugin_list);
391
if (ret == ARGP_ERR_UNKNOWN){
392
fprintf(stderr, "Unknown error while parsing arguments\n");
393
exitstatus = EXIT_FAILURE;
399
for(plugin *p = plugin_list; p != NULL; p=p->next){
400
fprintf(stderr, "Plugin: %s has %d arguments\n",
401
p->name ? p->name : "Global", p->argc - 1);
402
for(char **a = p->argv; *a != NULL; a++){
403
fprintf(stderr, "\tArg: %s\n", *a);
418
dir = opendir(plugindir);
420
perror("Could not open plugin dir");
421
exitstatus = EXIT_FAILURE;
425
/* Set the FD_CLOEXEC flag on the directory, if possible */
427
int dir_fd = dirfd(dir);
429
ret = set_cloexec_flag(dir_fd);
431
perror("set_cloexec_flag");
432
exitstatus = EXIT_FAILURE;
441
dirst = readdir(dir);
443
// All directory entries have been processed
447
exitstatus = EXIT_FAILURE;
453
d_name_len = strlen(dirst->d_name);
455
// Ignore dotfiles, backup files and other junk
457
bool bad_name = false;
459
const char const *bad_prefixes[] = { ".", "#", NULL };
461
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
463
".dpkg-divert", NULL };
464
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
465
size_t pre_len = strlen(*pre);
466
if((d_name_len >= pre_len)
467
and strncmp((dirst->d_name), *pre, pre_len) == 0){
469
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
470
" with bad prefix %s\n", dirst->d_name, *pre);
481
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
482
size_t suf_len = strlen(*suf);
483
if((d_name_len >= suf_len)
484
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
487
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
488
" with bad suffix %s\n", dirst->d_name, *suf);
500
char *filename = malloc(d_name_len + strlen(plugindir) + 2);
501
if (filename == NULL){
505
strcpy(filename, plugindir); /* Spurious warning */
506
strcat(filename, "/"); /* Spurious warning */
507
strcat(filename, dirst->d_name); /* Spurious warning */
509
ret = stat(filename, &st);
516
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
518
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
519
" with bad type or mode\n", filename);
524
if(getplugin(dirst->d_name, &plugin_list)->disabled){
526
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
532
plugin *p = getplugin(dirst->d_name, &plugin_list);
534
/* Add global arguments to argument list for this plugin */
535
plugin *g = getplugin(NULL, &plugin_list);
536
for(char **a = g->argv + 1; *a != NULL; a++){
544
exitstatus = EXIT_FAILURE;
547
ret = set_cloexec_flag(pipefd[0]);
549
perror("set_cloexec_flag");
550
exitstatus = EXIT_FAILURE;
553
ret = set_cloexec_flag(pipefd[1]);
555
perror("set_cloexec_flag");
556
exitstatus = EXIT_FAILURE;
559
/* Block SIGCHLD until process is safely in process list */
560
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
562
perror("sigprocmask");
563
exitstatus = EXIT_FAILURE;
566
// Starting a new process to be watched
570
exitstatus = EXIT_FAILURE;
574
/* this is the child process */
575
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
580
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
582
perror("sigprocmask");
586
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
593
/* If dir has no file descriptor, we could not set FD_CLOEXEC
594
above and must now close it manually here. */
597
if(execv(filename, p->argv) < 0){
605
close(pipefd[1]); /* close unused write end of pipe */
606
process *new_process = malloc(sizeof(process));
607
if (new_process == NULL){
609
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
611
perror("sigprocmask");
613
exitstatus = EXIT_FAILURE;
617
*new_process = (struct process){ .pid = pid,
619
.next = process_list };
621
process_list = new_process;
622
/* Unblock SIGCHLD so signal handler can be run if this process
623
has already completed */
624
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
626
perror("sigprocmask");
627
exitstatus = EXIT_FAILURE;
631
FD_SET(new_process->fd, &rfds_all);
633
if (maxfd < new_process->fd){
634
maxfd = new_process->fd;
639
/* Free the plugin list */
640
for(plugin *next; plugin_list != NULL; plugin_list = next){
641
next = plugin_list->next;
642
free(plugin_list->argv);
649
if (process_list == NULL){
650
fprintf(stderr, "No plugin processes started. Incorrect plugin"
655
fd_set rfds = rfds_all;
656
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
657
if (select_ret == -1){
659
exitstatus = EXIT_FAILURE;
662
/* OK, now either a process completed, or something can be read
664
for(process *proc = process_list; proc ; proc = proc->next){
665
/* Is this process completely done? */
666
if(proc->eof and proc->completed){
667
/* Only accept the plugin output if it exited cleanly */
668
if(not WIFEXITED(proc->status)
669
or WEXITSTATUS(proc->status) != 0){
670
/* Bad exit by plugin */
672
if(WIFEXITED(proc->status)){
673
fprintf(stderr, "Plugin %u exited with status %d\n",
674
(unsigned int) (proc->pid),
675
WEXITSTATUS(proc->status));
676
} else if(WIFSIGNALED(proc->status)) {
677
fprintf(stderr, "Plugin %u killed by signal %d\n",
678
(unsigned int) (proc->pid),
679
WTERMSIG(proc->status));
680
} else if(WCOREDUMP(proc->status)){
681
fprintf(stderr, "Plugin %d dumped core\n",
682
(unsigned int) (proc->pid));
685
/* Remove the plugin */
686
FD_CLR(proc->fd, &rfds_all);
687
/* Block signal while modifying process_list */
688
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
690
perror("sigprocmask");
691
exitstatus = EXIT_FAILURE;
694
/* Delete this process entry from the list */
695
if(process_list == proc){
696
/* First one - simple */
697
process_list = proc->next;
699
/* Second one or later */
700
for(process *p = process_list; p != NULL; p = p->next){
702
p->next = proc->next;
707
/* We are done modifying process list, so unblock signal */
708
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
711
perror("sigprocmask");
715
/* We deleted this process from the list, so we can't go
716
proc->next. Therefore, start over from the beginning of
720
/* This process exited nicely, so print its buffer */
722
bool bret = print_out_password(proc->buffer, proc->buffer_length);
724
perror("print_out_password");
725
exitstatus = EXIT_FAILURE;
729
/* This process has not completed. Does it have any output? */
730
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
731
/* This process had nothing to say at this time */
734
/* Before reading, make the process' data buffer large enough */
735
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
736
proc->buffer = realloc(proc->buffer, proc->buffer_size
737
+ (size_t) BUFFER_SIZE);
738
if (proc->buffer == NULL){
740
exitstatus = EXIT_FAILURE;
743
proc->buffer_size += BUFFER_SIZE;
745
/* Read from the process */
746
ret = read(proc->fd, proc->buffer + proc->buffer_length,
749
/* Read error from this process; ignore the error */
756
proc->buffer_length += (size_t) ret;
764
if(process_list == NULL or exitstatus != EXIT_SUCCESS){
765
/* Fallback if all plugins failed, none are found or an error occured */
767
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
768
char *passwordbuffer = getpass("Password: ");
769
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
771
perror("print_out_password");
772
exitstatus = EXIT_FAILURE;
777
/* Restore old signal handler */
778
sigaction(SIGCHLD, &old_sigchld_action, NULL);
782
/* Free the plugin list */
783
for(plugin *next; plugin_list != NULL; plugin_list = next){
784
next = plugin_list->next;
785
free(plugin_list->argv);
793
/* Free the process list and kill the processes */
794
for(process *next; process_list != NULL; process_list = next){
795
next = process_list->next;
796
close(process_list->fd);
797
ret = kill(process_list->pid, SIGTERM);
798
if(ret == -1 and errno != ESRCH){
799
/* set-uid proccesses migth not get closed */
802
free(process_list->buffer);
806
/* Wait for any remaining child processes to terminate */