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-2018 Teddy Hogeborn
6
* Copyright © 2008-2018 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
#include <stdio.h> /* popen(), fileno(), fprintf(),
27
stderr, STDOUT_FILENO */
26
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
28
#include <stddef.h> /* size_t, NULL */
29
#include <stdlib.h> /* malloc(), exit(), EXIT_SUCCESS,
31
#include <stdbool.h> /* bool, true, false */
32
#include <stdio.h> /* fileno(), fprintf(),
33
stderr, STDOUT_FILENO, fclose() */
34
#include <sys/types.h> /* fstat(), struct stat, waitpid(),
35
WIFEXITED(), WEXITSTATUS(), wait(),
36
pid_t, uid_t, gid_t, getuid(),
38
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
39
FD_SET(), FD_ISSET(), FD_CLR */
40
#include <sys/wait.h> /* wait(), waitpid(), WIFEXITED(),
41
WEXITSTATUS(), WTERMSIG() */
42
#include <sys/stat.h> /* struct stat, fstat(), S_ISREG() */
28
43
#include <iso646.h> /* and, or, not */
29
#include <sys/types.h> /* DIR, opendir(), stat(),
30
struct stat, waitpid(),
31
WIFEXITED(), WEXITSTATUS(),
33
#include <sys/wait.h> /* wait() */
34
#include <dirent.h> /* DIR, struct dirent, opendir(),
35
readdir(), closedir() */
36
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
37
#include <unistd.h> /* struct stat, stat(), S_ISREG(),
39
#include <fcntl.h> /* fcntl() */
40
#include <stddef.h> /* NULL */
41
#include <stdlib.h> /* EXIT_FAILURE */
42
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
43
FD_SET(), FD_ISSET() */
44
#include <string.h> /* strlen(), strcpy(), strcat() */
45
#include <stdbool.h> /* true */
46
#include <sys/wait.h> /* waitpid(), WIFEXITED(),
44
#include <dirent.h> /* struct dirent, scandirat() */
45
#include <unistd.h> /* fcntl(), F_GETFD, F_SETFD,
46
FD_CLOEXEC, write(), STDOUT_FILENO,
47
struct stat, fstat(), close(),
48
setgid(), setuid(), S_ISREG(),
49
faccessat() pipe2(), fork(),
50
_exit(), dup2(), fexecve(), read()
52
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
53
FD_CLOEXEC, openat(), scandirat(),
55
#include <string.h> /* strsep, strlen(), strsignal(),
56
strcmp(), strncmp() */
48
57
#include <errno.h> /* errno */
49
#include <argp.h> /* struct argp_option,
50
struct argp_state, struct argp,
55
typedef struct process{
58
#include <argp.h> /* struct argp_option, struct
59
argp_state, struct argp,
60
argp_parse(), ARGP_ERR_UNKNOWN,
61
ARGP_KEY_END, ARGP_KEY_ARG,
63
#include <signal.h> /* struct sigaction, sigemptyset(),
64
sigaddset(), sigaction(),
65
sigprocmask(), SIG_BLOCK, SIGCHLD,
66
SIG_UNBLOCK, kill(), sig_atomic_t
68
#include <errno.h> /* errno, EBADF */
69
#include <inttypes.h> /* intmax_t, PRIdMAX, strtoimax() */
70
#include <sysexits.h> /* EX_OSERR, EX_USAGE, EX_IOERR,
71
EX_CONFIG, EX_UNAVAILABLE, EX_OK */
72
#include <errno.h> /* errno */
73
#include <error.h> /* error() */
74
#include <fnmatch.h> /* fnmatch() */
76
#define BUFFER_SIZE 256
78
#define PDIR "/lib/mandos/plugins.d"
79
#define PHDIR "/lib/mandos/plugin-helpers"
80
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
82
const char *argp_program_version = "plugin-runner " VERSION;
83
const char *argp_program_bug_address = "<mandos@recompile.se>";
85
typedef struct plugin{
86
char *name; /* can be NULL or any plugin name */
93
/* Variables used for running processes*/
59
97
size_t buffer_size;
60
98
size_t buffer_length;
100
volatile sig_atomic_t completed;
67
typedef struct plugin{
68
char *name; /* can be NULL or any plugin name */
72
102
struct plugin *next;
75
plugin *getplugin(char *name, plugin **plugin_list){
76
for (plugin *p = *plugin_list; p != NULL; p = p->next){
78
or (p->name and name and (strcmp(p->name, name) == 0))){
105
static plugin *plugin_list = NULL;
107
/* Gets an existing plugin based on name,
108
or if none is found, creates a new one */
109
__attribute__((warn_unused_result))
110
static plugin *getplugin(char *name){
111
/* Check for existing plugin with that name */
112
for(plugin *p = plugin_list; p != NULL; p = p->next){
114
or (p->name and name and (strcmp(p->name, name) == 0))){
82
118
/* Create a new plugin */
83
plugin *new_plugin = malloc(sizeof(plugin));
84
if (new_plugin == NULL){
88
new_plugin->name = name;
89
new_plugin->argv = malloc(sizeof(char *) * 2);
90
if (new_plugin->argv == NULL){
94
new_plugin->argv[0] = name;
119
plugin *new_plugin = NULL;
121
new_plugin = malloc(sizeof(plugin));
122
} while(new_plugin == NULL and errno == EINTR);
123
if(new_plugin == NULL){
126
char *copy_name = NULL;
129
copy_name = strdup(name);
130
} while(copy_name == NULL and errno == EINTR);
131
if(copy_name == NULL){
139
*new_plugin = (plugin){ .name = copy_name,
142
.next = plugin_list };
145
new_plugin->argv = malloc(sizeof(char *) * 2);
146
} while(new_plugin->argv == NULL and errno == EINTR);
147
if(new_plugin->argv == NULL){
154
new_plugin->argv[0] = copy_name;
95
155
new_plugin->argv[1] = NULL;
97
new_plugin->disabled = false;
98
new_plugin->next = *plugin_list;
158
new_plugin->environ = malloc(sizeof(char *));
159
} while(new_plugin->environ == NULL and errno == EINTR);
160
if(new_plugin->environ == NULL){
163
free(new_plugin->argv);
168
new_plugin->environ[0] = NULL;
99
170
/* Append the new plugin to the list */
100
*plugin_list = new_plugin;
171
plugin_list = new_plugin;
101
172
return new_plugin;
104
void addargument(plugin *p, char *arg){
105
p->argv[p->argc] = arg;
106
p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
107
if (p->argv == NULL){
112
p->argv[p->argc] = NULL;
175
/* Helper function for add_argument and add_environment */
176
__attribute__((nonnull, warn_unused_result))
177
static bool add_to_char_array(const char *new, char ***array,
179
/* Resize the pointed-to array to hold one more pointer */
180
char **new_array = NULL;
182
new_array = realloc(*array, sizeof(char *)
183
* (size_t) ((*len) + 2));
184
} while(new_array == NULL and errno == EINTR);
186
if(new_array == NULL){
190
/* Make a copy of the new string */
194
} while(copy == NULL and errno == EINTR);
198
/* Insert the copy */
199
(*array)[*len] = copy;
201
/* Add a new terminating NULL pointer to the last element */
202
(*array)[*len] = NULL;
206
/* Add to a plugin's argument vector */
207
__attribute__((nonnull(2), warn_unused_result))
208
static bool add_argument(plugin *p, const char *arg){
212
return add_to_char_array(arg, &(p->argv), &(p->argc));
215
/* Add to a plugin's environment */
216
__attribute__((nonnull(2), warn_unused_result))
217
static bool add_environment(plugin *p, const char *def, bool replace){
221
/* namelen = length of name of environment variable */
222
size_t namelen = (size_t)(strchrnul(def, '=') - def);
223
/* Search for this environment variable */
224
for(char **envdef = p->environ; *envdef != NULL; envdef++){
225
if(strncmp(*envdef, def, namelen + 1) == 0){
226
/* It already exists */
230
new_envdef = realloc(*envdef, strlen(def) + 1);
231
} while(new_envdef == NULL and errno == EINTR);
232
if(new_envdef == NULL){
235
*envdef = new_envdef;
236
strcpy(*envdef, def);
241
return add_to_char_array(def, &(p->environ), &(p->envc));
116
246
* Based on the example in the GNU LibC manual chapter 13.13 "File
117
247
* Descriptor Flags".
118
* *Note File Descriptor Flags:(libc)Descriptor Flags.
248
| [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
120
int set_cloexec_flag(int fd)
122
int ret = fcntl(fd, F_GETFD, 0);
250
__attribute__((warn_unused_result))
251
static int set_cloexec_flag(int fd){
252
int ret = (int)TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD, 0));
123
253
/* If reading the flags failed, return error indication now. */
127
257
/* Store modified flag word in the descriptor. */
128
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
258
return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
131
#define BUFFER_SIZE 256
133
const char *argp_program_version = "plugbasedclient 0.9";
134
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
136
process *process_list = NULL;
138
/* Mark a process as completed when it exits, and save its exit
261
#endif /* not O_CLOEXEC */
264
/* Mark processes as completed when they exit, and save their exit
140
void handle_sigchld(__attribute__((unused)) int sig){
141
process *proc = process_list;
143
pid_t pid = wait(&status);
144
while(proc != NULL and proc->pid != pid){
148
/* Process not found in process list */
151
proc->status = status;
152
proc->completed = true;
266
static void handle_sigchld(__attribute__((unused)) int sig){
267
int old_errno = errno;
269
plugin *proc = plugin_list;
271
pid_t pid = waitpid(-1, &status, WNOHANG);
273
/* Only still running child processes */
278
/* No child processes */
281
error(0, errno, "waitpid");
284
/* A child exited, find it in process_list */
285
while(proc != NULL and proc->pid != pid){
289
/* Process not found in process list */
292
proc->status = status;
298
/* Prints out a password to stdout */
299
__attribute__((nonnull, warn_unused_result))
300
static bool print_out_password(const char *buffer, size_t length){
302
for(size_t written = 0; written < length; written += (size_t)ret){
303
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
312
/* Removes and free a plugin from the plugin list */
313
__attribute__((nonnull))
314
static void free_plugin(plugin *plugin_node){
316
for(char **arg = (plugin_node->argv)+1; *arg != NULL; arg++){
319
free(plugin_node->name);
320
free(plugin_node->argv);
321
for(char **env = plugin_node->environ; *env != NULL; env++){
324
free(plugin_node->environ);
325
free(plugin_node->buffer);
327
/* Removes the plugin from the singly-linked list */
328
if(plugin_node == plugin_list){
329
/* First one - simple */
330
plugin_list = plugin_list->next;
332
/* Second one or later */
333
for(plugin *p = plugin_list; p != NULL; p = p->next){
334
if(p->next == plugin_node){
335
p->next = plugin_node->next;
344
static void free_plugin_list(void){
345
while(plugin_list != NULL){
346
free_plugin(plugin_list);
155
350
int main(int argc, char *argv[]){
156
const char *plugindir = "/conf/conf.d/mandos/plugins.d";
159
struct dirent *dirst;
351
char *plugindir = NULL;
352
char *pluginhelperdir = NULL;
353
char *argfile = NULL;
355
struct dirent **direntries = NULL;
162
358
int ret, maxfd = 0;
163
362
bool debug = false;
164
363
int exitstatus = EXIT_SUCCESS;
364
struct sigaction old_sigchld_action;
365
struct sigaction sigchld_action = { .sa_handler = handle_sigchld,
366
.sa_flags = SA_NOCLDSTOP };
367
char **custom_argv = NULL;
166
371
/* Establish a signal handler */
167
struct sigaction old_sigchld_action,
168
sigchld_action = { .sa_handler = handle_sigchld,
169
.sa_flags = SA_NOCLDSTOP };
170
372
sigemptyset(&sigchld_action.sa_mask);
171
373
ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
375
error(0, errno, "sigaddset");
376
exitstatus = EX_OSERR;
176
379
ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
381
error(0, errno, "sigaction");
382
exitstatus = EX_OSERR;
182
386
/* The options we understand. */
184
388
{ .name = "global-options", .key = 'g',
185
389
.arg = "OPTION[,OPTION[,...]]",
186
390
.doc = "Options passed to all plugins" },
391
{ .name = "global-env", .key = 'G',
393
.doc = "Environment variable passed to all plugins" },
187
394
{ .name = "options-for", .key = 'o',
188
395
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
189
396
.doc = "Options passed only to specified plugin" },
397
{ .name = "env-for", .key = 'E',
398
.arg = "PLUGIN:ENV=value",
399
.doc = "Environment variable passed to specified plugin" },
190
400
{ .name = "disable", .key = 'd',
192
402
.doc = "Disable a specific plugin", .group = 1 },
403
{ .name = "enable", .key = 'e',
405
.doc = "Enable a specific plugin", .group = 1 },
193
406
{ .name = "plugin-dir", .key = 128,
194
407
.arg = "DIRECTORY",
195
408
.doc = "Specify a different plugin directory", .group = 2 },
196
{ .name = "debug", .key = 129,
197
.doc = "Debug mode", .group = 3 },
409
{ .name = "config-file", .key = 129,
411
.doc = "Specify a different configuration file", .group = 2 },
412
{ .name = "userid", .key = 130,
413
.arg = "ID", .flags = 0,
414
.doc = "User ID the plugins will run as", .group = 3 },
415
{ .name = "groupid", .key = 131,
416
.arg = "ID", .flags = 0,
417
.doc = "Group ID the plugins will run as", .group = 3 },
418
{ .name = "debug", .key = 132,
419
.doc = "Debug mode", .group = 4 },
420
{ .name = "plugin-helper-dir", .key = 133,
422
.doc = "Specify a different plugin helper directory",
425
* These reproduce what we would get without ARGP_NO_HELP
427
{ .name = "help", .key = '?',
428
.doc = "Give this help list", .group = -1 },
429
{ .name = "usage", .key = -3,
430
.doc = "Give a short usage message", .group = -1 },
431
{ .name = "version", .key = 'V',
432
.doc = "Print program version", .group = -1 },
201
error_t parse_opt (int key, char *arg, struct argp_state *state) {
202
/* Get the INPUT argument from `argp_parse', which we know is a
203
pointer to our plugin list pointer. */
204
plugin **plugins = state->input;
208
char *p = strtok(arg, ",");
210
addargument(getplugin(NULL, plugins), p);
211
p = strtok(NULL, ",");
217
char *name = strtok(arg, ":");
218
char *p = strtok(NULL, ":");
222
addargument(getplugin(name, plugins), p);
223
p = strtok(NULL, ",");
230
getplugin(arg, plugins)->disabled = true;
436
__attribute__((nonnull(3)))
437
error_t parse_opt(int key, char *arg, struct argp_state *state){
442
case 'g': /* --global-options */
445
while((plugin_option = strsep(&arg, ",")) != NULL){
446
if(not add_argument(getplugin(NULL), plugin_option)){
453
case 'G': /* --global-env */
454
if(add_environment(getplugin(NULL), arg, true)){
458
case 'o': /* --options-for */
460
char *option_list = strchr(arg, ':');
461
if(option_list == NULL){
462
argp_error(state, "No colon in \"%s\"", arg);
469
argp_error(state, "Empty plugin name");
474
while((option = strsep(&option_list, ",")) != NULL){
475
if(not add_argument(getplugin(arg), option)){
482
case 'E': /* --env-for */
484
char *envdef = strchr(arg, ':');
486
argp_error(state, "No colon in \"%s\"", arg);
493
argp_error(state, "Empty plugin name");
497
if(add_environment(getplugin(arg), envdef, true)){
502
case 'd': /* --disable */
504
plugin *p = getplugin(arg);
511
case 'e': /* --enable */
513
plugin *p = getplugin(arg);
520
case 128: /* --plugin-dir */
522
plugindir = strdup(arg);
523
if(plugindir != NULL){
527
case 129: /* --config-file */
528
/* This is already done by parse_opt_config_file() */
530
case 130: /* --userid */
531
tmp_id = strtoimax(arg, &tmp, 10);
532
if(errno != 0 or tmp == arg or *tmp != '\0'
533
or tmp_id != (uid_t)tmp_id){
534
argp_error(state, "Bad user ID number: \"%s\", using %"
535
PRIdMAX, arg, (intmax_t)uid);
541
case 131: /* --groupid */
542
tmp_id = strtoimax(arg, &tmp, 10);
543
if(errno != 0 or tmp == arg or *tmp != '\0'
544
or tmp_id != (gid_t)tmp_id){
545
argp_error(state, "Bad group ID number: \"%s\", using %"
546
PRIdMAX, arg, (intmax_t)gid);
552
case 132: /* --debug */
245
return ARGP_ERR_UNKNOWN;
250
plugin *plugin_list = NULL;
252
struct argp argp = { .options = options, .parser = parse_opt,
555
case 133: /* --plugin-helper-dir */
556
free(pluginhelperdir);
557
pluginhelperdir = strdup(arg);
558
if(pluginhelperdir != NULL){
563
* These reproduce what we would get without ARGP_NO_HELP
565
case '?': /* --help */
566
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
567
argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
568
__builtin_unreachable();
569
case -3: /* --usage */
570
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
571
argp_state_help(state, state->out_stream,
572
ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
573
__builtin_unreachable();
574
case 'V': /* --version */
575
fprintf(state->out_stream, "%s\n", argp_program_version);
579
* When adding more options before this line, remember to also add a
580
* "case" to the "parse_opt_config_file" function below.
583
/* Cryptsetup always passes an argument, which is an empty
584
string if "none" was specified in /etc/crypttab. So if
585
argument was empty, we ignore it silently. */
591
return ARGP_ERR_UNKNOWN;
593
return errno; /* Set to 0 at start */
596
/* This option parser is the same as parse_opt() above, except it
597
ignores everything but the --config-file option. */
598
error_t parse_opt_config_file(int key, char *arg,
599
__attribute__((unused))
600
struct argp_state *state){
603
case 'g': /* --global-options */
604
case 'G': /* --global-env */
605
case 'o': /* --options-for */
606
case 'E': /* --env-for */
607
case 'd': /* --disable */
608
case 'e': /* --enable */
609
case 128: /* --plugin-dir */
611
case 129: /* --config-file */
613
argfile = strdup(arg);
618
case 130: /* --userid */
619
case 131: /* --groupid */
620
case 132: /* --debug */
621
case 133: /* --plugin-helper-dir */
622
case '?': /* --help */
623
case -3: /* --usage */
624
case 'V': /* --version */
628
return ARGP_ERR_UNKNOWN;
633
struct argp argp = { .options = options,
634
.parser = parse_opt_config_file,
254
636
.doc = "Mandos plugin runner -- Run plugins" };
256
argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
638
/* Parse using parse_opt_config_file() in order to get the custom
639
config file location, if any. */
640
ret = argp_parse(&argp, argc, argv,
641
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
649
error(0, errno, "argp_parse");
650
exitstatus = EX_OSERR;
653
exitstatus = EX_USAGE;
657
/* Reset to the normal argument parser */
658
argp.parser = parse_opt;
660
/* Open the configfile if available */
662
conffp = fopen(AFILE, "r");
664
conffp = fopen(argfile, "r");
667
char *org_line = NULL;
668
char *p, *arg, *new_arg, *line;
670
const char whitespace_delims[] = " \r\t\f\v\n";
671
const char comment_delim[] = "#";
674
custom_argv = malloc(sizeof(char*) * 2);
675
if(custom_argv == NULL){
676
error(0, errno, "malloc");
677
exitstatus = EX_OSERR;
680
custom_argv[0] = argv[0];
681
custom_argv[1] = NULL;
683
/* for each line in the config file, strip whitespace and ignore
686
sret = getline(&org_line, &size, conffp);
692
arg = strsep(&line, comment_delim);
693
while((p = strsep(&arg, whitespace_delims)) != NULL){
699
error(0, errno, "strdup");
700
exitstatus = EX_OSERR;
707
char **new_argv = realloc(custom_argv, sizeof(char *)
708
* ((size_t)custom_argc + 1));
709
if(new_argv == NULL){
710
error(0, errno, "realloc");
711
exitstatus = EX_OSERR;
716
custom_argv = new_argv;
719
custom_argv[custom_argc-1] = new_arg;
720
custom_argv[custom_argc] = NULL;
724
ret = fclose(conffp);
725
} while(ret == EOF and errno == EINTR);
727
error(0, errno, "fclose");
728
exitstatus = EX_IOERR;
733
/* Check for harmful errors and go to fallback. Other errors might
734
not affect opening plugins */
735
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
736
error(0, errno, "fopen");
737
exitstatus = EX_OSERR;
741
/* If there were any arguments from the configuration file, pass
742
them to parser as command line arguments */
743
if(custom_argv != NULL){
744
ret = argp_parse(&argp, custom_argc, custom_argv,
745
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
753
error(0, errno, "argp_parse");
754
exitstatus = EX_OSERR;
757
exitstatus = EX_CONFIG;
762
/* Parse actual command line arguments, to let them override the
764
ret = argp_parse(&argp, argc, argv,
765
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
773
error(0, errno, "argp_parse");
774
exitstatus = EX_OSERR;
777
exitstatus = EX_USAGE;
782
char *pluginhelperenv;
784
ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
785
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
787
bret = add_environment(getplugin(NULL), pluginhelperenv, true);
789
if(ret == -1 or not bret){
790
error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
791
" environment variable to \"%s\" for all plugins\n",
792
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
795
free(pluginhelperenv);
259
for(plugin *p = plugin_list; p != NULL; p=p->next){
800
for(plugin *p = plugin_list; p != NULL; p = p->next){
260
801
fprintf(stderr, "Plugin: %s has %d arguments\n",
261
802
p->name ? p->name : "Global", p->argc - 1);
262
803
for(char **a = p->argv; *a != NULL; a++){
263
804
fprintf(stderr, "\tArg: %s\n", *a);
268
dir = opendir(plugindir);
270
perror("Could not open plugin dir");
271
exitstatus = EXIT_FAILURE;
275
/* Set the FD_CLOEXEC flag on the directory, if possible */
806
fprintf(stderr, "...and %d environment variables\n", p->envc);
807
for(char **a = p->environ; *a != NULL; a++){
808
fprintf(stderr, "\t%s\n", *a);
814
/* Work around Debian bug #633582:
815
<https://bugs.debian.org/633582> */
816
int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
817
if(plugindir_fd == -1){
819
error(0, errno, "open(\"" PDIR "\")");
822
ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
824
error(0, errno, "fstat");
826
if(S_ISDIR(st.st_mode) and st.st_uid == 0 and st.st_gid == 0){
827
ret = fchown(plugindir_fd, uid, gid);
829
error(0, errno, "fchown");
837
/* Lower permissions */
840
error(0, errno, "setgid");
844
error(0, errno, "setuid");
847
/* Open plugin directory with close_on_exec flag */
277
int dir_fd = dirfd(dir);
279
ret = set_cloexec_flag(dir_fd);
281
perror("set_cloexec_flag");
282
exitstatus = EXIT_FAILURE;
849
dir_fd = open(plugindir != NULL ? plugindir : PDIR, O_RDONLY |
852
#else /* not O_CLOEXEC */
854
#endif /* not O_CLOEXEC */
857
error(0, errno, "Could not open plugin dir");
858
exitstatus = EX_UNAVAILABLE;
863
/* Set the FD_CLOEXEC flag on the directory */
864
ret = set_cloexec_flag(dir_fd);
866
error(0, errno, "set_cloexec_flag");
867
exitstatus = EX_OSERR;
870
#endif /* O_CLOEXEC */
873
int good_name(const struct dirent * const dirent){
874
const char * const patterns[] = { ".*", "#*#", "*~", "*.dpkg-new",
875
"*.dpkg-old", "*.dpkg-bak",
876
"*.dpkg-divert", NULL };
878
#pragma GCC diagnostic push
879
#pragma GCC diagnostic ignored "-Wcast-qual"
881
for(const char **pat = (const char **)patterns;
882
*pat != NULL; pat++){
884
#pragma GCC diagnostic pop
886
if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
889
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
890
" matching pattern %s\n", dirent->d_name, *pat);
898
int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
900
if(numplugins == -1){
901
error(0, errno, "Could not scan plugin dir");
903
exitstatus = EX_OSERR;
288
907
FD_ZERO(&rfds_all);
291
dirst = readdir(dir);
293
// All directory entries have been processed
298
d_name_len = strlen(dirst->d_name);
300
// Ignore dotfiles, backup files and other junk
302
bool bad_name = false;
304
const char const *bad_prefixes[] = { ".", "#", NULL };
306
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
308
".dpkg-divert", NULL };
309
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
310
size_t pre_len = strlen(*pre);
311
if((d_name_len >= pre_len)
312
and strncmp((dirst->d_name), *pre, pre_len) == 0){
314
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
315
" with bad prefix %s\n", dirst->d_name, *pre);
326
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
327
size_t suf_len = strlen(*suf);
328
if((d_name_len >= suf_len)
329
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
332
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
333
" with bad suffix %s\n", dirst->d_name, *suf);
345
char *filename = malloc(d_name_len + strlen(plugindir) + 2);
346
if (filename == NULL){
348
exitstatus = EXIT_FAILURE;
351
strcpy(filename, plugindir); /* Spurious warning */
352
strcat(filename, "/"); /* Spurious warning */
353
strcat(filename, dirst->d_name); /* Spurious warning */
357
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
909
/* Read and execute any executable in the plugin directory*/
910
for(int i = 0; i < numplugins; i++){
912
int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
914
error(0, errno, "Could not open plugin");
918
ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
920
error(0, errno, "stat");
926
/* Ignore non-executable files */
927
if(not S_ISREG(st.st_mode)
928
or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
359
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
360
" with bad type or mode\n", filename);
931
fprintf(stderr, "Ignoring plugin dir entry \"%s/%s\""
932
" with bad type or mode\n",
933
plugindir != NULL ? plugindir : PDIR,
934
direntries[i]->d_name);
365
if(getplugin(dirst->d_name, &plugin_list)->disabled){
941
plugin *p = getplugin(direntries[i]->d_name);
943
error(0, errno, "getplugin");
367
950
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
951
direntries[i]->d_name);
373
plugin *p = getplugin(dirst->d_name, &plugin_list);
375
958
/* Add global arguments to argument list for this plugin */
376
plugin *g = getplugin(NULL, &plugin_list);
377
for(char **a = g->argv + 1; *a != NULL; a++){
385
exitstatus = EXIT_FAILURE;
959
plugin *g = getplugin(NULL);
961
for(char **a = g->argv + 1; *a != NULL; a++){
962
if(not add_argument(p, *a)){
963
error(0, errno, "add_argument");
966
/* Add global environment variables */
967
for(char **e = g->environ; *e != NULL; e++){
968
if(not add_environment(p, *e, false)){
969
error(0, errno, "add_environment");
974
/* If this plugin has any environment variables, we need to
975
duplicate the environment from this process, too. */
976
if(p->environ[0] != NULL){
977
for(char **e = environ; *e != NULL; e++){
978
if(not add_environment(p, *e, false)){
979
error(0, errno, "add_environment");
986
ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
987
#else /* O_CLOEXEC */
988
ret = (int)TEMP_FAILURE_RETRY(pipe2(pipefd, O_CLOEXEC));
989
#endif /* O_CLOEXEC */
991
error(0, errno, "pipe");
992
exitstatus = EX_OSERR;
996
if(pipefd[0] >= FD_SETSIZE){
997
fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
1001
exitstatus = EX_OSERR;
1002
free(direntries[i]);
1006
/* Ask OS to automatic close the pipe on exec */
388
1007
ret = set_cloexec_flag(pipefd[0]);
390
perror("set_cloexec_flag");
391
exitstatus = EXIT_FAILURE;
1009
error(0, errno, "set_cloexec_flag");
1012
exitstatus = EX_OSERR;
1013
free(direntries[i]);
394
1016
ret = set_cloexec_flag(pipefd[1]);
396
perror("set_cloexec_flag");
397
exitstatus = EXIT_FAILURE;
1018
error(0, errno, "set_cloexec_flag");
1021
exitstatus = EX_OSERR;
1022
free(direntries[i]);
1025
#endif /* not O_CLOEXEC */
400
1026
/* Block SIGCHLD until process is safely in process list */
401
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
1027
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
1028
&sigchld_action.sa_mask,
403
perror("sigprocmask");
404
exitstatus = EXIT_FAILURE;
407
// Starting a new process to be watched
1031
error(0, errno, "sigprocmask");
1032
exitstatus = EX_OSERR;
1033
free(direntries[i]);
1036
/* Starting a new process to be watched */
1040
} while(pid == -1 and errno == EINTR);
1042
error(0, errno, "fork");
1043
TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1044
&sigchld_action.sa_mask, NULL));
1047
exitstatus = EX_OSERR;
1048
free(direntries[i]);
410
1052
/* this is the child process */
411
1053
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1055
error(0, errno, "sigaction");
416
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1058
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
418
perror("sigprocmask");
421
dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
424
/* If dir has no file descriptor, we could not set FD_CLOEXEC
425
above and must now close it manually here. */
428
if(execv(filename, p->argv) < 0){
1060
error(0, errno, "sigprocmask");
1064
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
1066
error(0, errno, "dup2");
1070
if(fexecve(plugin_fd, p->argv,
1071
(p->environ[0] != NULL) ? p->environ : environ) < 0){
1072
error(0, errno, "fexecve for %s/%s",
1073
plugindir != NULL ? plugindir : PDIR,
1074
direntries[i]->d_name);
436
close(pipefd[1]); /* close unused write end of pipe */
437
process *new_process = malloc(sizeof(process));
438
if (new_process == NULL){
440
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1079
/* Parent process */
1080
close(pipefd[1]); /* Close unused write end of pipe */
1082
plugin *new_plugin = getplugin(direntries[i]->d_name);
1083
if(new_plugin == NULL){
1084
error(0, errno, "getplugin");
1085
ret = (int)(TEMP_FAILURE_RETRY
1086
(sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
442
perror("sigprocmask");
1089
error(0, errno, "sigprocmask");
444
exitstatus = EXIT_FAILURE;
1091
exitstatus = EX_OSERR;
1092
free(direntries[i]);
1095
free(direntries[i]);
448
*new_process = (struct process){ .pid = pid,
450
.next = process_list };
452
process_list = new_process;
1097
new_plugin->pid = pid;
1098
new_plugin->fd = pipefd[0];
1101
fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
1102
new_plugin->name, (intmax_t) (new_plugin->pid));
453
1105
/* Unblock SIGCHLD so signal handler can be run if this process
454
1106
has already completed */
455
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1107
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1108
&sigchld_action.sa_mask,
457
perror("sigprocmask");
458
exitstatus = EXIT_FAILURE;
462
FD_SET(new_process->fd, &rfds_all);
464
if (maxfd < new_process->fd){
465
maxfd = new_process->fd;
470
/* Free the plugin list */
471
for(plugin *next; plugin_list != NULL; plugin_list = next){
472
next = plugin_list->next;
473
free(plugin_list->argv);
480
if (process_list == NULL){
481
fprintf(stderr, "No plugin processes started, exiting\n");
482
exitstatus = EXIT_FAILURE;
1111
error(0, errno, "sigprocmask");
1112
exitstatus = EX_OSERR;
1116
FD_SET(new_plugin->fd, &rfds_all);
1118
if(maxfd < new_plugin->fd){
1119
maxfd = new_plugin->fd;
1127
free_plugin(getplugin(NULL));
1129
for(plugin *p = plugin_list; p != NULL; p = p->next){
1133
if(p->next == NULL){
1134
fprintf(stderr, "No plugin processes started. Incorrect plugin"
1140
/* Main loop while running plugins exist */
486
1142
fd_set rfds = rfds_all;
487
1143
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
488
if (select_ret == -1){
490
exitstatus = EXIT_FAILURE;
1144
if(select_ret == -1 and errno != EINTR){
1145
error(0, errno, "select");
1146
exitstatus = EX_OSERR;
493
1149
/* OK, now either a process completed, or something can be read
494
1150
from one of them */
495
for(process *proc = process_list; proc ; proc = proc->next){
1151
for(plugin *proc = plugin_list; proc != NULL;){
496
1152
/* Is this process completely done? */
497
if(proc->eof and proc->completed){
1153
if(proc->completed and proc->eof){
498
1154
/* Only accept the plugin output if it exited cleanly */
499
1155
if(not WIFEXITED(proc->status)
500
1156
or WEXITSTATUS(proc->status) != 0){
501
1157
/* Bad exit by plugin */
503
1160
if(WIFEXITED(proc->status)){
504
fprintf(stderr, "Plugin %d exited with status %d\n",
505
proc->pid, WEXITSTATUS(proc->status));
506
} else if(WIFSIGNALED(proc->status)) {
507
fprintf(stderr, "Plugin %d killed by signal %d\n",
508
proc->pid, WTERMSIG(proc->status));
509
} else if(WCOREDUMP(proc->status)){
510
fprintf(stderr, "Plugin %d dumped core\n", proc->pid);
1161
fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
1162
" status %d\n", proc->name,
1163
(intmax_t) (proc->pid),
1164
WEXITSTATUS(proc->status));
1165
} else if(WIFSIGNALED(proc->status)){
1166
fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
1167
" signal %d: %s\n", proc->name,
1168
(intmax_t) (proc->pid),
1169
WTERMSIG(proc->status),
1170
strsignal(WTERMSIG(proc->status)));
513
1174
/* Remove the plugin */
514
1175
FD_CLR(proc->fd, &rfds_all);
515
1177
/* Block signal while modifying process_list */
516
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
1178
ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1180
&sigchld_action.sa_mask,
518
perror("sigprocmask");
519
exitstatus = EXIT_FAILURE;
522
/* Delete this process entry from the list */
523
if(process_list == proc){
524
/* First one - simple */
525
process_list = proc->next;
527
/* Second one or later */
528
for(process *p = process_list; p != NULL; p = p->next){
530
p->next = proc->next;
1183
error(0, errno, "sigprocmask");
1184
exitstatus = EX_OSERR;
1188
plugin *next_plugin = proc->next;
535
1192
/* We are done modifying process list, so unblock signal */
536
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
1193
ret = (int)(TEMP_FAILURE_RETRY
1194
(sigprocmask(SIG_UNBLOCK,
1195
&sigchld_action.sa_mask, NULL)));
539
perror("sigprocmask");
543
/* We deleted this process from the list, so we can't go
544
proc->next. Therefore, start over from the beginning of
1197
error(0, errno, "sigprocmask");
1198
exitstatus = EX_OSERR;
1202
if(plugin_list == NULL){
548
1209
/* This process exited nicely, so print its buffer */
549
for(size_t written = 0; written < proc->buffer_length;
550
written += (size_t)ret){
551
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO,
552
proc->buffer + written,
557
exitstatus = EXIT_FAILURE;
1211
bool bret = print_out_password(proc->buffer,
1212
proc->buffer_length);
1214
error(0, errno, "print_out_password");
1215
exitstatus = EX_IOERR;
563
1220
/* This process has not completed. Does it have any output? */
564
1221
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
565
1222
/* This process had nothing to say at this time */
568
1226
/* Before reading, make the process' data buffer large enough */
569
1227
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
570
proc->buffer = realloc(proc->buffer, proc->buffer_size
571
+ (size_t) BUFFER_SIZE);
572
if (proc->buffer == NULL){
574
exitstatus = EXIT_FAILURE;
1228
char *new_buffer = realloc(proc->buffer, proc->buffer_size
1229
+ (size_t) BUFFER_SIZE);
1230
if(new_buffer == NULL){
1231
error(0, errno, "malloc");
1232
exitstatus = EX_OSERR;
1235
proc->buffer = new_buffer;
577
1236
proc->buffer_size += BUFFER_SIZE;
579
1238
/* Read from the process */
580
ret = read(proc->fd, proc->buffer + proc->buffer_length,
1239
sret = TEMP_FAILURE_RETRY(read(proc->fd,
1241
+ proc->buffer_length,
583
1244
/* Read error from this process; ignore the error */
588
1250
proc->eof = true;
590
proc->buffer_length += (size_t) ret;
1252
proc->buffer_length += (size_t) sret;
594
if(process_list == NULL){
595
fprintf(stderr, "All plugin processes failed, exiting\n");
596
exitstatus = EXIT_FAILURE;
1260
if(plugin_list == NULL or (exitstatus != EXIT_SUCCESS
1261
and exitstatus != EX_OK)){
1262
/* Fallback if all plugins failed, none are found or an error
1265
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
1266
char *passwordbuffer = getpass("Password: ");
1267
size_t len = strlen(passwordbuffer);
1268
/* Strip trailing newline */
1269
if(len > 0 and passwordbuffer[len-1] == '\n'){
1270
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1273
bret = print_out_password(passwordbuffer, len);
1275
error(0, errno, "print_out_password");
1276
exitstatus = EX_IOERR;
600
1280
/* Restore old signal handler */
601
sigaction(SIGCHLD, &old_sigchld_action, NULL);
603
/* Free the plugin list */
604
for(plugin *next; plugin_list != NULL; plugin_list = next){
605
next = plugin_list->next;
606
free(plugin_list->argv);
614
/* Free the process list and kill the processes */
615
for(process *next; process_list != NULL; process_list = next){
616
next = process_list->next;
617
close(process_list->fd);
618
kill(process_list->pid, SIGTERM);
619
free(process_list->buffer);
1281
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1283
error(0, errno, "sigaction");
1284
exitstatus = EX_OSERR;
1287
if(custom_argv != NULL){
1288
for(char **arg = custom_argv+1; *arg != NULL; arg++){
1300
/* Kill the processes */
1301
for(plugin *p = plugin_list; p != NULL; p = p->next){
1304
ret = kill(p->pid, SIGTERM);
1305
if(ret == -1 and errno != ESRCH){
1306
/* Set-uid proccesses might not get closed */
1307
error(0, errno, "kill");
623
1312
/* Wait for any remaining child processes to terminate */
625
1314
ret = wait(NULL);
626
1315
} while(ret >= 0);
627
1316
if(errno != ECHILD){
1317
error(0, errno, "wait");
1323
free(pluginhelperdir);
631
1326
return exitstatus;