19
19
* along with this program. If not, see
20
20
* <http://www.gnu.org/licenses/>.
22
* Contact the authors at <mandos@fukt.bsnet.se>.
22
* Contact the authors at <mandos@recompile.se>.
25
25
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
27
27
#include <stddef.h> /* size_t, NULL */
28
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
29
EXIT_SUCCESS, realloc() */
28
#include <stdlib.h> /* malloc(), exit(), EXIT_SUCCESS,
30
30
#include <stdbool.h> /* bool, true, false */
31
#include <stdio.h> /* perror, fileno(), fprintf(),
32
stderr, STDOUT_FILENO */
33
#include <sys/types.h> /* DIR, opendir(), stat(), struct
34
stat, waitpid(), WIFEXITED(),
35
WEXITSTATUS(), wait(), pid_t,
36
uid_t, gid_t, getuid(), getgid(),
31
#include <stdio.h> /* fileno(), fprintf(),
32
stderr, STDOUT_FILENO, fclose() */
33
#include <sys/types.h> /* fstat(), struct stat, waitpid(),
34
WIFEXITED(), WEXITSTATUS(), wait(),
35
pid_t, uid_t, gid_t, getuid(),
38
37
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
39
38
FD_SET(), FD_ISSET(), FD_CLR */
40
39
#include <sys/wait.h> /* wait(), waitpid(), WIFEXITED(),
41
WEXITSTATUS(), WTERMSIG(),
43
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
40
WEXITSTATUS(), WTERMSIG() */
41
#include <sys/stat.h> /* struct stat, fstat(), S_ISREG() */
44
42
#include <iso646.h> /* and, or, not */
45
#include <dirent.h> /* DIR, struct dirent, opendir(),
46
readdir(), closedir(), dirfd() */
47
#include <unistd.h> /* struct stat, stat(), S_ISREG(),
48
fcntl(), setuid(), setgid(),
49
F_GETFD, F_SETFD, FD_CLOEXEC,
50
access(), pipe(), fork(), close()
51
dup2(), STDOUT_FILENO, _exit(),
52
execv(), write(), read(),
43
#include <dirent.h> /* struct dirent, scandirat() */
44
#include <unistd.h> /* fcntl(), F_GETFD, F_SETFD,
45
FD_CLOEXEC, write(), STDOUT_FILENO,
46
struct stat, fstat(), close(),
47
setgid(), setuid(), S_ISREG(),
48
faccessat() pipe2(), fork(),
49
_exit(), dup2(), fexecve(), read()
54
51
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
56
#include <string.h> /* strsep, strlen(), asprintf(),
52
FD_CLOEXEC, openat(), scandirat(),
54
#include <string.h> /* strsep, strlen(), strsignal(),
55
strcmp(), strncmp() */
58
56
#include <errno.h> /* errno */
59
57
#include <argp.h> /* struct argp_option, struct
60
58
argp_state, struct argp,
207
240
return add_to_char_array(def, &(p->environ), &(p->envc));
211
245
* Based on the example in the GNU LibC manual chapter 13.13 "File
212
246
* Descriptor Flags".
213
* *Note File Descriptor Flags:(libc)Descriptor Flags.
247
| [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
249
__attribute__((warn_unused_result))
215
250
static int set_cloexec_flag(int fd){
216
int ret = fcntl(fd, F_GETFD, 0);
251
int ret = (int)TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD, 0));
217
252
/* If reading the flags failed, return error indication now. */
221
256
/* Store modified flag word in the descriptor. */
222
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
257
return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
260
#endif /* not O_CLOEXEC */
226
263
/* Mark processes as completed when they exit, and save their exit
377
415
.doc = "Group ID the plugins will run as", .group = 3 },
378
416
{ .name = "debug", .key = 132,
379
417
.doc = "Debug mode", .group = 4 },
418
{ .name = "plugin-helper-dir", .key = 133,
420
.doc = "Specify a different plugin helper directory",
423
* These reproduce what we would get without ARGP_NO_HELP
425
{ .name = "help", .key = '?',
426
.doc = "Give this help list", .group = -1 },
427
{ .name = "usage", .key = -3,
428
.doc = "Give a short usage message", .group = -1 },
429
{ .name = "version", .key = 'V',
430
.doc = "Print program version", .group = -1 },
383
error_t parse_opt(int key, char *arg, __attribute__((unused))
384
struct argp_state *state){
434
__attribute__((nonnull(3)))
435
error_t parse_opt(int key, char *arg, struct argp_state *state){
387
440
case 'g': /* --global-options */
389
442
char *plugin_option;
390
443
while((plugin_option = strsep(&arg, ",")) != NULL){
391
if(plugin_option[0] == '\0'){
394
444
if(not add_argument(getplugin(NULL), plugin_option)){
395
perror("add_argument");
396
return ARGP_ERR_UNKNOWN;
401
451
case 'G': /* --global-env */
405
if(not add_environment(getplugin(NULL), arg, true)){
406
perror("add_environment");
452
if(add_environment(getplugin(NULL), arg, true)){
409
456
case 'o': /* --options-for */
411
char *plugin_name = strsep(&arg, ":");
412
if(plugin_name[0] == '\0'){
416
while((plugin_option = strsep(&arg, ",")) != NULL){
417
if(not add_argument(getplugin(plugin_name), plugin_option)){
418
perror("add_argument");
419
return ARGP_ERR_UNKNOWN;
458
char *option_list = strchr(arg, ':');
459
if(option_list == NULL){
460
argp_error(state, "No colon in \"%s\"", arg);
467
argp_error(state, "Empty plugin name");
472
while((option = strsep(&option_list, ",")) != NULL){
473
if(not add_argument(getplugin(arg), option)){
424
480
case 'E': /* --env-for */
429
482
char *envdef = strchr(arg, ':');
430
483
if(envdef == NULL){
484
argp_error(state, "No colon in \"%s\"", arg);
434
if(not add_environment(getplugin(arg), envdef+1, true)){
435
perror("add_environment");
491
argp_error(state, "Empty plugin name");
495
if(add_environment(getplugin(arg), envdef, true)){
439
500
case 'd': /* --disable */
441
502
plugin *p = getplugin(arg);
443
return ARGP_ERR_UNKNOWN;
448
509
case 'e': /* --enable */
450
511
plugin *p = getplugin(arg);
452
return ARGP_ERR_UNKNOWN;
457
518
case 128: /* --plugin-dir */
459
520
plugindir = strdup(arg);
460
if(plugindir == NULL){
521
if(plugindir != NULL){
464
525
case 129: /* --config-file */
465
526
/* This is already done by parse_opt_config_file() */
467
528
case 130: /* --userid */
469
tmpmax = strtoimax(arg, &tmp, 10);
529
tmp_id = strtoimax(arg, &tmp, 10);
470
530
if(errno != 0 or tmp == arg or *tmp != '\0'
471
or tmpmax != (uid_t)tmpmax){
472
fprintf(stderr, "Bad user ID number: \"%s\", using %"
473
PRIdMAX "\n", arg, (intmax_t)uid);
531
or tmp_id != (uid_t)tmp_id){
532
argp_error(state, "Bad user ID number: \"%s\", using %"
533
PRIdMAX, arg, (intmax_t)uid);
478
539
case 131: /* --groupid */
480
tmpmax = strtoimax(arg, &tmp, 10);
540
tmp_id = strtoimax(arg, &tmp, 10);
481
541
if(errno != 0 or tmp == arg or *tmp != '\0'
482
or tmpmax != (gid_t)tmpmax){
483
fprintf(stderr, "Bad group ID number: \"%s\", using %"
484
PRIdMAX "\n", arg, (intmax_t)gid);
542
or tmp_id != (gid_t)tmp_id){
543
argp_error(state, "Bad group ID number: \"%s\", using %"
544
PRIdMAX, arg, (intmax_t)gid);
489
550
case 132: /* --debug */
553
case 133: /* --plugin-helper-dir */
554
free(pluginhelperdir);
555
pluginhelperdir = strdup(arg);
556
if(pluginhelperdir != NULL){
561
* These reproduce what we would get without ARGP_NO_HELP
563
case '?': /* --help */
564
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
565
argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
566
case -3: /* --usage */
567
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
568
argp_state_help(state, state->out_stream,
569
ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
570
case 'V': /* --version */
571
fprintf(state->out_stream, "%s\n", argp_program_version);
493
575
* When adding more options before this line, remember to also add a
494
576
* "case" to the "parse_opt_config_file" function below.
599
692
new_arg = strdup(p);
600
693
if(new_arg == NULL){
602
exitstatus = EXIT_FAILURE;
694
error(0, errno, "strdup");
695
exitstatus = EX_OSERR;
607
700
custom_argc += 1;
608
custom_argv = realloc(custom_argv, sizeof(char *)
609
* ((unsigned int) custom_argc + 1));
610
if(custom_argv == NULL){
612
exitstatus = EXIT_FAILURE;
702
char **new_argv = realloc(custom_argv, sizeof(char *)
703
* ((size_t)custom_argc + 1));
704
if(new_argv == NULL){
705
error(0, errno, "realloc");
706
exitstatus = EX_OSERR;
711
custom_argv = new_argv;
616
714
custom_argv[custom_argc-1] = new_arg;
617
715
custom_argv[custom_argc] = NULL;
719
ret = fclose(conffp);
720
} while(ret == EOF and errno == EINTR);
722
error(0, errno, "fclose");
723
exitstatus = EX_IOERR;
622
728
/* Check for harmful errors and go to fallback. Other errors might
623
729
not affect opening plugins */
624
730
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
626
exitstatus = EXIT_FAILURE;
731
error(0, errno, "fopen");
732
exitstatus = EX_OSERR;
630
/* If there was any arguments from configuration file,
631
pass them to parser as command arguments */
736
/* If there were any arguments from the configuration file, pass
737
them to parser as command line arguments */
632
738
if(custom_argv != NULL){
633
ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
635
if(ret == ARGP_ERR_UNKNOWN){
636
fprintf(stderr, "Unknown error while parsing arguments\n");
637
exitstatus = EXIT_FAILURE;
739
ret = argp_parse(&argp, custom_argc, custom_argv,
740
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
748
error(0, errno, "argp_parse");
749
exitstatus = EX_OSERR;
752
exitstatus = EX_CONFIG;
642
757
/* Parse actual command line arguments, to let them override the
644
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
645
if(ret == ARGP_ERR_UNKNOWN){
646
fprintf(stderr, "Unknown error while parsing arguments\n");
647
exitstatus = EXIT_FAILURE;
759
ret = argp_parse(&argp, argc, argv,
760
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
768
error(0, errno, "argp_parse");
769
exitstatus = EX_OSERR;
772
exitstatus = EX_USAGE;
777
char *pluginhelperenv;
779
ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
780
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
782
bret = add_environment(getplugin(NULL), pluginhelperenv, true);
784
if(ret == -1 or not bret){
785
error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
786
" environment variable to \"%s\" for all plugins\n",
787
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
790
free(pluginhelperenv);
652
for(plugin *p = plugin_list; p != NULL; p=p->next){
795
for(plugin *p = plugin_list; p != NULL; p = p->next){
653
796
fprintf(stderr, "Plugin: %s has %d arguments\n",
654
797
p->name ? p->name : "Global", p->argc - 1);
655
798
for(char **a = p->argv; *a != NULL; a++){
665
/* Strip permissions down to nobody */
809
/* Work around Debian bug #633582:
810
<https://bugs.debian.org/633582> */
811
int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
812
if(plugindir_fd == -1){
814
error(0, errno, "open(\"" PDIR "\")");
817
ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
819
error(0, errno, "fstat");
821
if(S_ISDIR(st.st_mode) and st.st_uid == 0 and st.st_gid == 0){
822
ret = fchown(plugindir_fd, uid, gid);
824
error(0, errno, "fchown");
832
/* Lower permissions */
835
error(0, errno, "setgid");
670
837
ret = setuid(uid);
675
if(plugindir == NULL){
678
dir = opendir(plugindir);
682
perror("Could not open plugin dir");
683
exitstatus = EXIT_FAILURE;
687
/* Set the FD_CLOEXEC flag on the directory, if possible */
839
error(0, errno, "setuid");
842
/* Open plugin directory with close_on_exec flag */
689
int dir_fd = dirfd(dir);
691
ret = set_cloexec_flag(dir_fd);
693
perror("set_cloexec_flag");
694
exitstatus = EXIT_FAILURE;
844
dir_fd = open(plugindir != NULL ? plugindir : PDIR, O_RDONLY |
847
#else /* not O_CLOEXEC */
849
#endif /* not O_CLOEXEC */
852
error(0, errno, "Could not open plugin dir");
853
exitstatus = EX_UNAVAILABLE;
858
/* Set the FD_CLOEXEC flag on the directory */
859
ret = set_cloexec_flag(dir_fd);
861
error(0, errno, "set_cloexec_flag");
862
exitstatus = EX_OSERR;
865
#endif /* O_CLOEXEC */
868
int good_name(const struct dirent * const dirent){
869
const char * const patterns[] = { ".*", "#*#", "*~", "*.dpkg-new",
870
"*.dpkg-old", "*.dpkg-bak",
871
"*.dpkg-divert", NULL };
873
#pragma GCC diagnostic push
874
#pragma GCC diagnostic ignored "-Wcast-qual"
876
for(const char **pat = (const char **)patterns;
877
*pat != NULL; pat++){
879
#pragma GCC diagnostic pop
881
if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
884
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
885
" matching pattern %s\n", dirent->d_name, *pat);
893
int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
895
if(numplugins == -1){
896
error(0, errno, "Could not scan plugin dir");
898
exitstatus = EX_OSERR;
700
902
FD_ZERO(&rfds_all);
702
904
/* Read and execute any executable in the plugin directory*/
704
dirst = readdir(dir);
706
/* All directory entries have been processed */
710
exitstatus = EXIT_FAILURE;
716
d_name_len = strlen(dirst->d_name);
718
/* Ignore dotfiles, backup files and other junk */
720
bool bad_name = false;
722
const char const *bad_prefixes[] = { ".", "#", NULL };
724
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
727
".dpkg-divert", NULL };
728
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
729
size_t pre_len = strlen(*pre);
730
if((d_name_len >= pre_len)
731
and strncmp((dirst->d_name), *pre, pre_len) == 0){
733
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
734
" with bad prefix %s\n", dirst->d_name, *pre);
743
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
744
size_t suf_len = strlen(*suf);
745
if((d_name_len >= suf_len)
746
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
749
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
750
" with bad suffix %s\n", dirst->d_name, *suf);
763
if(plugindir == NULL){
764
ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
766
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
905
for(int i = 0; i < numplugins; i++){
907
int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
909
error(0, errno, "Could not open plugin");
773
ret = stat(filename, &st);
913
ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
915
error(0, errno, "stat");
780
921
/* Ignore non-executable files */
781
if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
922
if(not S_ISREG(st.st_mode)
923
or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
783
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
784
" with bad type or mode\n", filename);
926
fprintf(stderr, "Ignoring plugin dir entry \"%s/%s\""
927
" with bad type or mode\n",
928
plugindir != NULL ? plugindir : PDIR,
929
direntries[i]->d_name);
790
plugin *p = getplugin(dirst->d_name);
936
plugin *p = getplugin(direntries[i]->d_name);
938
error(0, errno, "getplugin");
798
945
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
946
direntries[i]->d_name);
808
956
for(char **a = g->argv + 1; *a != NULL; a++){
809
957
if(not add_argument(p, *a)){
810
perror("add_argument");
958
error(0, errno, "add_argument");
813
961
/* Add global environment variables */
814
962
for(char **e = g->environ; *e != NULL; e++){
815
963
if(not add_environment(p, *e, false)){
816
perror("add_environment");
964
error(0, errno, "add_environment");
821
/* If this plugin has any environment variables, we will call
822
using execve and need to duplicate the environment from this
969
/* If this plugin has any environment variables, we need to
970
duplicate the environment from this process, too. */
824
971
if(p->environ[0] != NULL){
825
972
for(char **e = environ; *e != NULL; e++){
826
973
if(not add_environment(p, *e, false)){
827
perror("add_environment");
974
error(0, errno, "add_environment");
981
ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
982
#else /* O_CLOEXEC */
983
ret = (int)TEMP_FAILURE_RETRY(pipe2(pipefd, O_CLOEXEC));
984
#endif /* O_CLOEXEC */
836
exitstatus = EXIT_FAILURE;
986
error(0, errno, "pipe");
987
exitstatus = EX_OSERR;
991
if(pipefd[0] >= FD_SETSIZE){
992
fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
996
exitstatus = EX_OSERR;
839
1001
/* Ask OS to automatic close the pipe on exec */
840
1002
ret = set_cloexec_flag(pipefd[0]);
842
perror("set_cloexec_flag");
843
exitstatus = EXIT_FAILURE;
1004
error(0, errno, "set_cloexec_flag");
1007
exitstatus = EX_OSERR;
1008
free(direntries[i]);
846
1011
ret = set_cloexec_flag(pipefd[1]);
848
perror("set_cloexec_flag");
849
exitstatus = EXIT_FAILURE;
1013
error(0, errno, "set_cloexec_flag");
1016
exitstatus = EX_OSERR;
1017
free(direntries[i]);
1020
#endif /* not O_CLOEXEC */
852
1021
/* Block SIGCHLD until process is safely in process list */
853
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
1022
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
1023
&sigchld_action.sa_mask,
855
perror("sigprocmask");
856
exitstatus = EXIT_FAILURE;
1026
error(0, errno, "sigprocmask");
1027
exitstatus = EX_OSERR;
1028
free(direntries[i]);
859
1031
/* Starting a new process to be watched */
1035
} while(pid == -1 and errno == EINTR);
863
exitstatus = EXIT_FAILURE;
1037
error(0, errno, "fork");
1038
TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1039
&sigchld_action.sa_mask, NULL));
1042
exitstatus = EX_OSERR;
1043
free(direntries[i]);
867
1047
/* this is the child process */
868
1048
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1050
error(0, errno, "sigaction");
873
1053
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
875
perror("sigprocmask");
1055
error(0, errno, "sigprocmask");
879
1059
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
1061
error(0, errno, "dup2");
886
/* If dir has no file descriptor, we could not set FD_CLOEXEC
887
above and must now close it manually here. */
890
if(p->environ[0] == NULL){
891
if(execv(filename, p->argv) < 0){
896
if(execve(filename, p->argv, p->environ) < 0){
1065
if(fexecve(plugin_fd, p->argv,
1066
(p->environ[0] != NULL) ? p->environ : environ) < 0){
1067
error(0, errno, "fexecve for %s/%s",
1068
plugindir != NULL ? plugindir : PDIR,
1069
direntries[i]->d_name);
903
1074
/* Parent process */
904
1075
close(pipefd[1]); /* Close unused write end of pipe */
906
plugin *new_plugin = getplugin(dirst->d_name);
1077
plugin *new_plugin = getplugin(direntries[i]->d_name);
907
1078
if(new_plugin == NULL){
909
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1079
error(0, errno, "getplugin");
1080
ret = (int)(TEMP_FAILURE_RETRY
1081
(sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
911
perror("sigprocmask");
1084
error(0, errno, "sigprocmask");
913
exitstatus = EXIT_FAILURE;
1086
exitstatus = EX_OSERR;
1087
free(direntries[i]);
1090
free(direntries[i]);
917
1092
new_plugin->pid = pid;
918
1093
new_plugin->fd = pipefd[0];
920
1095
/* Unblock SIGCHLD so signal handler can be run if this process
921
1096
has already completed */
922
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1097
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1098
&sigchld_action.sa_mask,
924
perror("sigprocmask");
925
exitstatus = EXIT_FAILURE;
1101
error(0, errno, "sigprocmask");
1102
exitstatus = EX_OSERR;