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
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
5
* Copyright © 2008-2022 Teddy Hogeborn
6
* Copyright © 2008-2022 Björn Påhlsson
8
* This file is part of Mandos.
10
* Mandos is free software: you can redistribute it and/or modify it
11
* under the terms of the GNU General Public License as published by
12
* the Free Software Foundation, either version 3 of the License, or
13
* (at your option) any later version.
15
* Mandos is distributed in the hope that it will be useful, but
13
16
* WITHOUT ANY WARRANTY; without even the implied warranty of
14
17
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
18
* General Public License for more details.
17
20
* 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
* along with Mandos. If not, see <http://www.gnu.org/licenses/>.
21
* Contact the authors at <mandos@fukt.bsnet.se>.
23
* Contact the authors at <mandos@recompile.se>.
24
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY() */
26
#define _GNU_SOURCE /* strchrnul(), TEMP_FAILURE_RETRY(),
27
getline(), asprintf(), O_CLOEXEC,
28
scandirat(), pipe2() */
29
#include <argp.h> /* argp_program_version,
30
argp_program_bug_address,
32
struct argp_state, argp_error(),
33
ARGP_NO_EXIT, argp_state_help,
35
ARGP_HELP_USAGE, ARGP_HELP_EXIT_OK,
36
ARGP_KEY_ARG, ARGP_ERR_UNKNOWN,
37
struct argp, argp_parse(),
38
ARGP_IN_ORDER, ARGP_NO_HELP */
39
#include <stdbool.h> /* bool, false, true */
40
#include <sys/types.h> /* pid_t, sig_atomic_t, uid_t, gid_t,
41
getuid(), setgid(), setuid() */
26
42
#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(),
43
#include <iso646.h> /* or, and, not */
44
#include <string.h> /* strcmp(), strdup(), strchrnul(),
45
strncmp(), strlen(), strcpy(),
46
strsep(), strchr(), strsignal() */
47
#include <stdlib.h> /* malloc(), free(), reallocarray(),
48
realloc(), EXIT_SUCCESS */
49
#include <errno.h> /* errno, EINTR, ENOMEM, ECHILD,
50
error_t, EINVAL, EMFILE, ENFILE,
52
#include <stdint.h> /* SIZE_MAX */
53
#define _GNU_SOURCE /* strchrnul(), TEMP_FAILURE_RETRY(),
54
getline(), asprintf(), O_CLOEXEC,
55
scandirat(), pipe2() */
56
#include <unistd.h> /* TEMP_FAILURE_RETRY(), ssize_t,
57
write(), STDOUT_FILENO, uid_t,
58
gid_t, getuid(), fchown(), close(),
59
symlink(), setgid(), setuid(),
60
faccessat(), X_OK, pipe(), pipe2(),
61
fork(), _exit(), dup2(), fexecve(),
52
63
#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 */
64
FD_CLOEXEC, open(), O_RDONLY,
65
O_CLOEXEC, openat() */
66
#include <sys/wait.h> /* waitpid(), WNOHANG, WIFEXITED(),
67
WEXITSTATUS(), WIFSIGNALED(),
69
#include <error.h> /* error() */
70
#include <stdio.h> /* FILE, fprintf(), fopen(),
71
getline(), fclose(), EOF,
73
#include <dirent.h> /* struct dirent, scandirat(),
75
#include <sys/stat.h> /* struct stat, fstat(), S_ISDIR(),
77
#include <sys/select.h> /* fd_set, FD_ZERO(), FD_SETSIZE,
78
FD_SET(), select(), FD_CLR(),
80
#include <signal.h> /* struct sigaction, SA_NOCLDSTOP,
81
sigemptyset(), sigaddset(),
82
SIGCHLD, sigprocmask(), SIG_BLOCK,
83
SIG_UNBLOCK, kill(), SIGTERM */
84
#include <sysexits.h> /* EX_OSERR, EX_USAGE, EX_IOERR,
85
EX_CONFIG, EX_UNAVAILABLE, EX_OK */
86
#include <inttypes.h> /* intmax_t, strtoimax(), PRIdMAX */
87
#include <fnmatch.h> /* fnmatch(), FNM_FILE_NAME,
88
FNM_PERIOD, FNM_NOMATCH */
67
90
#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{
92
#define PDIR "/lib/mandos/plugins.d"
93
#define PHDIR "/lib/mandos/plugin-helpers"
94
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
96
const char *argp_program_version = "plugin-runner " VERSION;
97
const char *argp_program_bug_address = "<mandos@recompile.se>";
99
typedef struct plugin{
100
char *name; /* can be NULL or any plugin name */
107
/* Variables used for running processes*/
79
111
size_t buffer_size;
80
112
size_t buffer_length;
114
volatile sig_atomic_t completed;
87
typedef struct plugin{
88
char *name; /* can be NULL or any plugin name */
92
116
struct plugin *next;
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))){
119
static plugin *plugin_list = NULL;
121
/* Gets an existing plugin based on name,
122
or if none is found, creates a new one */
123
__attribute__((warn_unused_result))
124
static plugin *getplugin(char *name){
125
/* Check for existing plugin with that name */
126
for(plugin *p = plugin_list; p != NULL; p = p->next){
128
or (p->name and name and (strcmp(p->name, name) == 0))){
102
132
/* 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;
133
plugin *new_plugin = NULL;
135
new_plugin = malloc(sizeof(plugin));
136
} while(new_plugin == NULL and errno == EINTR);
137
if(new_plugin == NULL){
140
char *copy_name = NULL;
143
copy_name = strdup(name);
144
} while(copy_name == NULL and errno == EINTR);
145
if(copy_name == NULL){
153
*new_plugin = (plugin){ .name = copy_name,
156
.next = plugin_list };
159
new_plugin->argv = malloc(sizeof(char *) * 2);
160
} while(new_plugin->argv == NULL and errno == EINTR);
161
if(new_plugin->argv == NULL){
168
new_plugin->argv[0] = copy_name;
115
169
new_plugin->argv[1] = NULL;
116
new_plugin->argc = 1;
117
new_plugin->disabled = false;
118
new_plugin->next = *plugin_list;
172
new_plugin->environ = malloc(sizeof(char *));
173
} while(new_plugin->environ == NULL and errno == EINTR);
174
if(new_plugin->environ == NULL){
177
free(new_plugin->argv);
182
new_plugin->environ[0] = NULL;
119
184
/* Append the new plugin to the list */
120
*plugin_list = new_plugin;
185
plugin_list = new_plugin;
121
186
return 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;
189
/* Helper function for add_argument and add_environment */
190
__attribute__((nonnull, warn_unused_result))
191
static bool add_to_char_array(const char *new, char ***array,
193
/* Resize the pointed-to array to hold one more pointer */
194
char **new_array = NULL;
196
#if defined(__GLIBC_PREREQ) and __GLIBC_PREREQ(2, 26)
197
new_array = reallocarray(*array, (size_t)((*len) + 2),
200
if(((size_t)((*len) + 2)) > (SIZE_MAX / sizeof(char *))){
205
new_array = realloc(*array, (size_t)((*len) + 2)
209
} while(new_array == NULL and errno == EINTR);
211
if(new_array == NULL){
215
/* Make a copy of the new string */
219
} while(copy == NULL and errno == EINTR);
223
/* Insert the copy */
224
(*array)[*len] = copy;
226
/* Add a new terminating NULL pointer to the last element */
227
(*array)[*len] = NULL;
231
/* Add to a plugin's argument vector */
232
__attribute__((nonnull(2), warn_unused_result))
233
static bool add_argument(plugin *p, const char *arg){
237
return add_to_char_array(arg, &(p->argv), &(p->argc));
240
/* Add to a plugin's environment */
241
__attribute__((nonnull(2), warn_unused_result))
242
static bool add_environment(plugin *p, const char *def, bool replace){
246
/* namelen = length of name of environment variable */
247
size_t namelen = (size_t)(strchrnul(def, '=') - def);
248
/* Search for this environment variable */
249
for(char **envdef = p->environ; *envdef != NULL; envdef++){
250
if(strncmp(*envdef, def, namelen + 1) == 0){
251
/* It already exists */
255
new_envdef = realloc(*envdef, strlen(def) + 1);
256
} while(new_envdef == NULL and errno == EINTR);
257
if(new_envdef == NULL){
260
*envdef = new_envdef;
261
strcpy(*envdef, def);
266
return add_to_char_array(def, &(p->environ), &(p->envc));
136
271
* Based on the example in the GNU LibC manual chapter 13.13 "File
137
272
* Descriptor Flags".
138
* *Note File Descriptor Flags:(libc)Descriptor Flags.
273
| [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
140
static int set_cloexec_flag(int fd)
142
int ret = fcntl(fd, F_GETFD, 0);
275
__attribute__((warn_unused_result))
276
static int set_cloexec_flag(int fd){
277
int ret = (int)TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD, 0));
143
278
/* If reading the flags failed, return error indication now. */
147
282
/* Store modified flag word in the descriptor. */
148
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
283
return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
151
process *process_list = NULL;
153
/* Mark a process as completed when it exits, and save its exit
286
#endif /* not O_CLOEXEC */
289
/* Mark processes as completed when they exit, and save their 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;
291
static void handle_sigchld(__attribute__((unused)) int sig){
292
int old_errno = errno;
294
plugin *proc = plugin_list;
296
pid_t pid = waitpid(-1, &status, WNOHANG);
298
/* Only still running child processes */
303
/* No child processes */
306
error(0, errno, "waitpid");
309
/* A child exited, find it in process_list */
310
while(proc != NULL and proc->pid != pid){
314
/* Process not found in process list */
317
proc->status = status;
174
bool print_out_password(const char *buffer, size_t length){
323
/* Prints out a password to stdout */
324
__attribute__((nonnull, warn_unused_result))
325
static bool print_out_password(const char *buffer, size_t length){
176
if(length>0 and buffer[length-1] == '\n'){
179
327
for(size_t written = 0; written < length; written += (size_t)ret){
180
328
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
181
329
length - written));
246
413
{ .name = "global-options", .key = 'g',
247
414
.arg = "OPTION[,OPTION[,...]]",
248
415
.doc = "Options passed to all plugins" },
416
{ .name = "global-env", .key = 'G',
418
.doc = "Environment variable passed to all plugins" },
249
419
{ .name = "options-for", .key = 'o',
250
420
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
251
421
.doc = "Options passed only to specified plugin" },
422
{ .name = "env-for", .key = 'E',
423
.arg = "PLUGIN:ENV=value",
424
.doc = "Environment variable passed to specified plugin" },
252
425
{ .name = "disable", .key = 'd',
254
427
.doc = "Disable a specific plugin", .group = 1 },
428
{ .name = "enable", .key = 'e',
430
.doc = "Enable a specific plugin", .group = 1 },
255
431
{ .name = "plugin-dir", .key = 128,
256
432
.arg = "DIRECTORY",
257
433
.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 },
434
{ .name = "config-file", .key = 129,
436
.doc = "Specify a different configuration file", .group = 2 },
437
{ .name = "userid", .key = 130,
438
.arg = "ID", .flags = 0,
439
.doc = "User ID the plugins will run as", .group = 3 },
440
{ .name = "groupid", .key = 131,
441
.arg = "ID", .flags = 0,
442
.doc = "Group ID the plugins will run as", .group = 3 },
443
{ .name = "debug", .key = 132,
444
.doc = "Debug mode", .group = 4 },
445
{ .name = "plugin-helper-dir", .key = 133,
447
.doc = "Specify a different plugin helper directory",
450
* These reproduce what we would get without ARGP_NO_HELP
452
{ .name = "help", .key = '?',
453
.doc = "Give this help list", .group = -1 },
454
{ .name = "usage", .key = -3,
455
.doc = "Give a short usage message", .group = -1 },
456
{ .name = "version", .key = 'V',
457
.doc = "Print program version", .group = -1 },
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);
461
__attribute__((nonnull(3)))
462
error_t parse_opt(int key, char *arg, struct argp_state *state){
467
case 'g': /* --global-options */
470
while((plugin_option = strsep(&arg, ",")) != NULL){
471
if(not add_argument(getplugin(NULL), plugin_option)){
478
case 'G': /* --global-env */
479
if(add_environment(getplugin(NULL), arg, true)){
483
case 'o': /* --options-for */
485
char *option_list = strchr(arg, ':');
486
if(option_list == NULL){
487
argp_error(state, "No colon in \"%s\"", arg);
494
argp_error(state, "Empty plugin name");
499
while((option = strsep(&option_list, ",")) != NULL){
500
if(not add_argument(getplugin(arg), option)){
507
case 'E': /* --env-for */
509
char *envdef = strchr(arg, ':');
511
argp_error(state, "No colon in \"%s\"", arg);
518
argp_error(state, "Empty plugin name");
522
if(add_environment(getplugin(arg), envdef, true)){
527
case 'd': /* --disable */
529
plugin *p = getplugin(arg);
536
case 'e': /* --enable */
538
plugin *p = getplugin(arg);
545
case 128: /* --plugin-dir */
547
plugindir = strdup(arg);
548
if(plugindir != NULL){
552
case 129: /* --config-file */
553
/* This is already done by parse_opt_config_file() */
555
case 130: /* --userid */
556
tmp_id = strtoimax(arg, &tmp, 10);
557
if(errno != 0 or tmp == arg or *tmp != '\0'
558
or tmp_id != (uid_t)tmp_id){
559
argp_error(state, "Bad user ID number: \"%s\", using %"
560
PRIdMAX, arg, (intmax_t)uid);
566
case 131: /* --groupid */
567
tmp_id = strtoimax(arg, &tmp, 10);
568
if(errno != 0 or tmp == arg or *tmp != '\0'
569
or tmp_id != (gid_t)tmp_id){
570
argp_error(state, "Bad group ID number: \"%s\", using %"
571
PRIdMAX, arg, (intmax_t)gid);
577
case 132: /* --debug */
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]",
580
case 133: /* --plugin-helper-dir */
581
free(pluginhelperdir);
582
pluginhelperdir = strdup(arg);
583
if(pluginhelperdir != NULL){
588
* These reproduce what we would get without ARGP_NO_HELP
590
case '?': /* --help */
591
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
592
argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
593
__builtin_unreachable();
594
case -3: /* --usage */
595
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
596
argp_state_help(state, state->out_stream,
597
ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
598
__builtin_unreachable();
599
case 'V': /* --version */
600
fprintf(state->out_stream, "%s\n", argp_program_version);
604
* When adding more options before this line, remember to also add a
605
* "case" to the "parse_opt_config_file" function below.
608
/* Cryptsetup always passes an argument, which is an empty
609
string if "none" was specified in /etc/crypttab. So if
610
argument was empty, we ignore it silently. */
615
__attribute__((fallthrough));
620
return ARGP_ERR_UNKNOWN;
622
return errno; /* Set to 0 at start */
625
/* This option parser is the same as parse_opt() above, except it
626
ignores everything but the --config-file option. */
627
error_t parse_opt_config_file(int key, char *arg,
628
__attribute__((unused))
629
struct argp_state *state){
632
case 'g': /* --global-options */
633
case 'G': /* --global-env */
634
case 'o': /* --options-for */
635
case 'E': /* --env-for */
636
case 'd': /* --disable */
637
case 'e': /* --enable */
638
case 128: /* --plugin-dir */
640
case 129: /* --config-file */
642
argfile = strdup(arg);
647
case 130: /* --userid */
648
case 131: /* --groupid */
649
case 132: /* --debug */
650
case 133: /* --plugin-helper-dir */
651
case '?': /* --help */
652
case -3: /* --usage */
653
case 'V': /* --version */
657
return ARGP_ERR_UNKNOWN;
662
struct argp argp = { .options = options,
663
.parser = parse_opt_config_file,
338
665
.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");
667
/* Parse using parse_opt_config_file() in order to get the custom
668
config file location, if any. */
669
ret = argp_parse(&argp, argc, argv,
670
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
678
error(0, errno, "argp_parse");
679
exitstatus = EX_OSERR;
682
exitstatus = EX_USAGE;
686
/* Reset to the normal argument parser */
687
argp.parser = parse_opt;
689
/* Open the configfile if available */
691
conffp = fopen(AFILE, "r");
693
conffp = fopen(argfile, "r");
348
695
if(conffp != NULL){
349
696
char *org_line = NULL;
697
char *p, *arg, *new_arg, *line;
352
char *p, *arg, *new_arg, *line;
353
699
const char whitespace_delims[] = " \r\t\f\v\n";
354
700
const char comment_delim[] = "#";
703
custom_argv = malloc(sizeof(char*) * 2);
704
if(custom_argv == NULL){
705
error(0, errno, "malloc");
706
exitstatus = EX_OSERR;
709
custom_argv[0] = argv[0];
710
custom_argv[1] = NULL;
712
/* for each line in the config file, strip whitespace and ignore
357
715
sret = getline(&org_line, &size, conffp);
363
721
arg = strsep(&line, comment_delim);
364
722
while((p = strsep(&arg, whitespace_delims)) != NULL){
368
726
new_arg = strdup(p);
369
custom_argv = addcustomargument(custom_argv, &custom_argc, new_arg);
370
if (custom_argv == NULL){
371
perror("addcustomargument");
372
exitstatus = EXIT_FAILURE;
728
error(0, errno, "strdup");
729
exitstatus = EX_OSERR;
736
#if defined(__GLIBC_PREREQ) and __GLIBC_PREREQ(2, 26)
737
char **new_argv = reallocarray(custom_argv,
738
(size_t)custom_argc + 1,
741
char **new_argv = NULL;
742
if(((size_t)custom_argc + 1) > (SIZE_MAX / sizeof(char *))){
746
new_argv = realloc(custom_argv, ((size_t)custom_argc + 1)
750
if(new_argv == NULL){
751
error(0, errno, "reallocarray");
752
exitstatus = EX_OSERR;
757
custom_argv = new_argv;
760
custom_argv[custom_argc-1] = new_arg;
761
custom_argv[custom_argc] = NULL;
765
ret = fclose(conffp);
766
} while(ret == EOF and errno == EINTR);
768
error(0, errno, "fclose");
769
exitstatus = EX_IOERR;
379
774
/* Check for harmful errors and go to fallback. Other errors might
380
775
not affect opening plugins */
381
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
383
exitstatus = EXIT_FAILURE;
776
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
777
error(0, errno, "fopen");
778
exitstatus = EX_OSERR;
782
/* If there were any arguments from the configuration file, pass
783
them to parser as command line arguments */
388
784
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;
785
ret = argp_parse(&argp, custom_argc, custom_argv,
786
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
794
error(0, errno, "argp_parse");
795
exitstatus = EX_OSERR;
798
exitstatus = EX_CONFIG;
803
/* Parse actual command line arguments, to let them override the
805
ret = argp_parse(&argp, argc, argv,
806
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
814
error(0, errno, "argp_parse");
815
exitstatus = EX_OSERR;
818
exitstatus = EX_USAGE;
823
char *pluginhelperenv;
825
ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
826
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
828
bret = add_environment(getplugin(NULL), pluginhelperenv, true);
830
if(ret == -1 or not bret){
831
error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
832
" environment variable to \"%s\" for all plugins\n",
833
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
836
free(pluginhelperenv);
399
for(plugin *p = plugin_list; p != NULL; p=p->next){
841
for(plugin *p = plugin_list; p != NULL; p = p->next){
400
842
fprintf(stderr, "Plugin: %s has %d arguments\n",
401
843
p->name ? p->name : "Global", p->argc - 1);
402
844
for(char **a = p->argv; *a != NULL; a++){
403
845
fprintf(stderr, "\tArg: %s\n", *a);
847
fprintf(stderr, "...and %d environment variables\n", p->envc);
848
for(char **a = p->environ; *a != NULL; a++){
849
fprintf(stderr, "\t%s\n", *a);
855
/* Work around Debian bug #633582:
856
<https://bugs.debian.org/633582> */
857
int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
858
if(plugindir_fd == -1){
860
error(0, errno, "open(\"" PDIR "\")");
863
ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
865
error(0, errno, "fstat");
867
if(S_ISDIR(st.st_mode) and st.st_uid == 0 and st.st_gid == 0){
868
ret = fchown(plugindir_fd, uid, gid);
870
error(0, errno, "fchown");
877
/* Work around Debian bug #981302
878
<https://bugs.debian.org/981302> */
879
if(lstat("/dev/fd", &st) != 0 and errno == ENOENT){
880
ret = symlink("/proc/self/fd", "/dev/fd");
882
error(0, errno, "Failed to create /dev/fd symlink");
887
/* Lower permissions */
890
error(0, errno, "setgid");
408
892
ret = setuid(uid);
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 */
894
error(0, errno, "setuid");
897
/* Open plugin directory with close_on_exec flag */
427
int dir_fd = dirfd(dir);
429
ret = set_cloexec_flag(dir_fd);
431
perror("set_cloexec_flag");
432
exitstatus = EXIT_FAILURE;
899
dir_fd = open(plugindir != NULL ? plugindir : PDIR, O_RDONLY |
902
#else /* not O_CLOEXEC */
904
#endif /* not O_CLOEXEC */
907
error(0, errno, "Could not open plugin dir");
908
exitstatus = EX_UNAVAILABLE;
913
/* Set the FD_CLOEXEC flag on the directory */
914
ret = set_cloexec_flag(dir_fd);
916
error(0, errno, "set_cloexec_flag");
917
exitstatus = EX_OSERR;
920
#endif /* O_CLOEXEC */
923
int good_name(const struct dirent * const dirent){
924
const char * const patterns[] = { ".*", "#*#", "*~", "*.dpkg-new",
925
"*.dpkg-old", "*.dpkg-bak",
926
"*.dpkg-divert", NULL };
928
#pragma GCC diagnostic push
929
#pragma GCC diagnostic ignored "-Wcast-qual"
931
for(const char **pat = (const char **)patterns;
932
*pat != NULL; pat++){
934
#pragma GCC diagnostic pop
936
if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
939
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
940
" matching pattern %s\n", dirent->d_name, *pat);
948
int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
950
if(numplugins == -1){
951
error(0, errno, "Could not scan plugin dir");
953
exitstatus = EX_OSERR;
438
957
FD_ZERO(&rfds_all);
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)){
959
/* Read and execute any executable in the plugin directory*/
960
for(int i = 0; i < numplugins; i++){
962
int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
964
error(0, errno, "Could not open plugin");
968
ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
970
error(0, errno, "stat");
976
/* Ignore non-executable files */
977
if(not S_ISREG(st.st_mode)
978
or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
518
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
519
" with bad type or mode\n", filename);
981
fprintf(stderr, "Ignoring plugin dir entry \"%s/%s\""
982
" with bad type or mode\n",
983
plugindir != NULL ? plugindir : PDIR,
984
direntries[i]->d_name);
524
if(getplugin(dirst->d_name, &plugin_list)->disabled){
991
plugin *p = getplugin(direntries[i]->d_name);
993
error(0, errno, "getplugin");
526
1000
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
1001
direntries[i]->d_name);
1004
free(direntries[i]);
532
plugin *p = getplugin(dirst->d_name, &plugin_list);
534
1008
/* 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;
1009
plugin *g = getplugin(NULL);
1011
for(char **a = g->argv + 1; *a != NULL; a++){
1012
if(not add_argument(p, *a)){
1013
error(0, errno, "add_argument");
1016
/* Add global environment variables */
1017
for(char **e = g->environ; *e != NULL; e++){
1018
if(not add_environment(p, *e, false)){
1019
error(0, errno, "add_environment");
1024
/* If this plugin has any environment variables, we need to
1025
duplicate the environment from this process, too. */
1026
if(p->environ[0] != NULL){
1027
for(char **e = environ; *e != NULL; e++){
1028
if(not add_environment(p, *e, false)){
1029
error(0, errno, "add_environment");
1036
ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
1037
#else /* O_CLOEXEC */
1038
ret = (int)TEMP_FAILURE_RETRY(pipe2(pipefd, O_CLOEXEC));
1039
#endif /* O_CLOEXEC */
1041
error(0, errno, "pipe");
1042
exitstatus = EX_OSERR;
1043
free(direntries[i]);
1046
if(pipefd[0] >= FD_SETSIZE){
1047
fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
1051
exitstatus = EX_OSERR;
1052
free(direntries[i]);
1056
/* Ask OS to automatic close the pipe on exec */
547
1057
ret = set_cloexec_flag(pipefd[0]);
549
perror("set_cloexec_flag");
550
exitstatus = EXIT_FAILURE;
1059
error(0, errno, "set_cloexec_flag");
1062
exitstatus = EX_OSERR;
1063
free(direntries[i]);
553
1066
ret = set_cloexec_flag(pipefd[1]);
555
perror("set_cloexec_flag");
556
exitstatus = EXIT_FAILURE;
1068
error(0, errno, "set_cloexec_flag");
1071
exitstatus = EX_OSERR;
1072
free(direntries[i]);
1075
#endif /* not O_CLOEXEC */
559
1076
/* Block SIGCHLD until process is safely in process list */
560
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
1077
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
1078
&sigchld_action.sa_mask,
562
perror("sigprocmask");
563
exitstatus = EXIT_FAILURE;
1081
error(0, errno, "sigprocmask");
1082
exitstatus = EX_OSERR;
1083
free(direntries[i]);
566
// Starting a new process to be watched
1086
/* Starting a new process to be watched */
1090
} while(pid == -1 and errno == EINTR);
570
exitstatus = EXIT_FAILURE;
1092
error(0, errno, "fork");
1093
TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1094
&sigchld_action.sa_mask, NULL));
1097
exitstatus = EX_OSERR;
1098
free(direntries[i]);
574
1102
/* this is the child process */
575
1103
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1105
error(0, errno, "sigaction");
580
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1108
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
582
perror("sigprocmask");
1110
error(0, errno, "sigprocmask");
586
1114
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
1116
error(0, errno, "dup2");
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){
1120
if(fexecve(plugin_fd, p->argv,
1121
(p->environ[0] != NULL) ? p->environ : environ) < 0){
1122
error(0, errno, "fexecve for %s/%s",
1123
plugindir != NULL ? plugindir : PDIR,
1124
direntries[i]->d_name);
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);
1129
/* Parent process */
1130
close(pipefd[1]); /* Close unused write end of pipe */
1132
plugin *new_plugin = getplugin(direntries[i]->d_name);
1133
if(new_plugin == NULL){
1134
error(0, errno, "getplugin");
1135
ret = (int)(TEMP_FAILURE_RETRY
1136
(sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
611
perror("sigprocmask");
1139
error(0, errno, "sigprocmask");
613
exitstatus = EXIT_FAILURE;
1141
exitstatus = EX_OSERR;
1142
free(direntries[i]);
1145
free(direntries[i]);
617
*new_process = (struct process){ .pid = pid,
619
.next = process_list };
621
process_list = new_process;
1147
new_plugin->pid = pid;
1148
new_plugin->fd = pipefd[0];
1151
fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
1152
new_plugin->name, (intmax_t) (new_plugin->pid));
622
1155
/* Unblock SIGCHLD so signal handler can be run if this process
623
1156
has already completed */
624
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1157
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1158
&sigchld_action.sa_mask,
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"
1161
error(0, errno, "sigprocmask");
1162
exitstatus = EX_OSERR;
1166
FD_SET(new_plugin->fd, &rfds_all);
1168
if(maxfd < new_plugin->fd){
1169
maxfd = new_plugin->fd;
1177
free_plugin(getplugin(NULL));
1179
for(plugin *p = plugin_list; p != NULL; p = p->next){
1183
if(p->next == NULL){
1184
fprintf(stderr, "No plugin processes started. Incorrect plugin"
1190
/* Main loop while running plugins exist */
655
1192
fd_set rfds = rfds_all;
656
1193
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
657
if (select_ret == -1){
659
exitstatus = EXIT_FAILURE;
1194
if(select_ret == -1 and errno != EINTR){
1195
error(0, errno, "select");
1196
exitstatus = EX_OSERR;
662
1199
/* OK, now either a process completed, or something can be read
663
1200
from one of them */
664
for(process *proc = process_list; proc ; proc = proc->next){
1201
for(plugin *proc = plugin_list; proc != NULL;){
665
1202
/* Is this process completely done? */
666
if(proc->eof and proc->completed){
1203
if(proc->completed and proc->eof){
667
1204
/* Only accept the plugin output if it exited cleanly */
668
1205
if(not WIFEXITED(proc->status)
669
1206
or WEXITSTATUS(proc->status) != 0){
670
1207
/* Bad exit by plugin */
672
1210
if(WIFEXITED(proc->status)){
673
fprintf(stderr, "Plugin %u exited with status %d\n",
674
(unsigned int) (proc->pid),
1211
fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
1212
" status %d\n", proc->name,
1213
(intmax_t) (proc->pid),
675
1214
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));
1215
} else if(WIFSIGNALED(proc->status)){
1216
fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
1217
" signal %d: %s\n", proc->name,
1218
(intmax_t) (proc->pid),
1219
WTERMSIG(proc->status),
1220
strsignal(WTERMSIG(proc->status)));
685
1224
/* Remove the plugin */
686
1225
FD_CLR(proc->fd, &rfds_all);
687
1227
/* Block signal while modifying process_list */
688
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
1228
ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1230
&sigchld_action.sa_mask,
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;
1233
error(0, errno, "sigprocmask");
1234
exitstatus = EX_OSERR;
1238
plugin *next_plugin = proc->next;
707
1242
/* We are done modifying process list, so unblock signal */
708
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
1243
ret = (int)(TEMP_FAILURE_RETRY
1244
(sigprocmask(SIG_UNBLOCK,
1245
&sigchld_action.sa_mask, NULL)));
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
1247
error(0, errno, "sigprocmask");
1248
exitstatus = EX_OSERR;
1252
if(plugin_list == NULL){
720
1259
/* This process exited nicely, so print its buffer */
722
bool bret = print_out_password(proc->buffer, proc->buffer_length);
1261
bool bret = print_out_password(proc->buffer,
1262
proc->buffer_length);
724
perror("print_out_password");
725
exitstatus = EXIT_FAILURE;
1264
error(0, errno, "print_out_password");
1265
exitstatus = EX_IOERR;
729
1270
/* This process has not completed. Does it have any output? */
730
1271
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
731
1272
/* This process had nothing to say at this time */
734
1276
/* Before reading, make the process' data buffer large enough */
735
1277
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;
1278
char *new_buffer = realloc(proc->buffer, proc->buffer_size
1279
+ (size_t) BUFFER_SIZE);
1280
if(new_buffer == NULL){
1281
error(0, errno, "malloc");
1282
exitstatus = EX_OSERR;
1285
proc->buffer = new_buffer;
743
1286
proc->buffer_size += BUFFER_SIZE;
745
1288
/* Read from the process */
746
ret = read(proc->fd, proc->buffer + proc->buffer_length,
1289
sret = TEMP_FAILURE_RETRY(read(proc->fd,
1291
+ proc->buffer_length,
749
1294
/* Read error from this process; ignore the error */
754
1300
proc->eof = true;
756
proc->buffer_length += (size_t) ret;
1302
proc->buffer_length += (size_t) sret;
764
if(process_list == NULL or exitstatus != EXIT_SUCCESS){
765
/* Fallback if all plugins failed, none are found or an error occured */
1310
if(plugin_list == NULL or (exitstatus != EXIT_SUCCESS
1311
and exitstatus != EX_OK)){
1312
/* Fallback if all plugins failed, none are found or an error
767
1315
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
768
1316
char *passwordbuffer = getpass("Password: ");
769
bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1317
size_t len = strlen(passwordbuffer);
1318
/* Strip trailing newline */
1319
if(len > 0 and passwordbuffer[len-1] == '\n'){
1320
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1323
bret = print_out_password(passwordbuffer, len);
771
perror("print_out_password");
772
exitstatus = EXIT_FAILURE;
1325
error(0, errno, "print_out_password");
1326
exitstatus = EX_IOERR;
777
1330
/* 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);
1331
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1333
error(0, errno, "sigaction");
1334
exitstatus = EX_OSERR;
1337
if(custom_argv != NULL){
1338
for(char **arg = custom_argv+1; *arg != NULL; arg++){
1350
/* Kill the processes */
1351
for(plugin *p = plugin_list; p != NULL; p = p->next){
1354
ret = kill(p->pid, SIGTERM);
1355
if(ret == -1 and errno != ESRCH){
1356
/* Set-uid proccesses might not get closed */
1357
error(0, errno, "kill");
806
1362
/* Wait for any remaining child processes to terminate */
808
1364
ret = wait(NULL);
809
1365
} while(ret >= 0);
810
1366
if(errno != ECHILD){
1367
error(0, errno, "wait");
1373
free(pluginhelperdir);
814
1376
return exitstatus;