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(),
 
 
26
                                   asprintf(), O_CLOEXEC */
 
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(),
 
 
31
#include <stdio.h>              /* fileno(), fprintf(),
 
32
32
                                   stderr, STDOUT_FILENO */
 
33
 
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
 
 
33
#include <sys/types.h>          /* DIR, fdopendir(), stat(), struct
 
34
34
                                   stat, waitpid(), WIFEXITED(),
 
35
35
                                   WEXITSTATUS(), wait(), pid_t,
 
36
36
                                   uid_t, gid_t, getuid(), getgid(),
 
 
38
38
#include <sys/select.h>         /* fd_set, select(), FD_ZERO(),
 
39
39
                                   FD_SET(), FD_ISSET(), FD_CLR */
 
40
40
#include <sys/wait.h>           /* wait(), waitpid(), WIFEXITED(),
 
 
41
                                   WEXITSTATUS(), WTERMSIG(),
 
42
43
#include <sys/stat.h>           /* struct stat, stat(), S_ISREG() */
 
43
44
#include <iso646.h>             /* and, or, not */
 
44
 
#include <dirent.h>             /* DIR, struct dirent, opendir(),
 
 
45
#include <dirent.h>             /* DIR, struct dirent, fdopendir(),
 
45
46
                                   readdir(), closedir(), dirfd() */
 
46
47
#include <unistd.h>             /* struct stat, stat(), S_ISREG(),
 
47
48
                                   fcntl(), setuid(), setgid(),
 
 
109
116
  /* Create a new plugin */
 
110
 
  plugin *new_plugin = malloc(sizeof(plugin));
 
 
117
  plugin *new_plugin = NULL;
 
 
119
    new_plugin = malloc(sizeof(plugin));
 
 
120
  } while(new_plugin == NULL and errno == EINTR);
 
111
121
  if(new_plugin == NULL){
 
114
124
  char *copy_name = NULL;
 
115
125
  if(name != NULL){
 
116
 
    copy_name = strdup(name);
 
 
127
      copy_name = strdup(name);
 
 
128
    } while(copy_name == NULL and errno == EINTR);
 
117
129
    if(copy_name == NULL){
 
122
 
  *new_plugin = (plugin) { .name = copy_name,
 
125
 
                           .next = plugin_list };
 
 
137
  *new_plugin = (plugin){ .name = copy_name,
 
 
140
                          .next = plugin_list };
 
127
 
  new_plugin->argv = malloc(sizeof(char *) * 2);
 
 
143
    new_plugin->argv = malloc(sizeof(char *) * 2);
 
 
144
  } while(new_plugin->argv == NULL and errno == EINTR);
 
128
145
  if(new_plugin->argv == NULL){
 
130
148
    free(new_plugin);
 
133
152
  new_plugin->argv[0] = copy_name;
 
134
153
  new_plugin->argv[1] = NULL;
 
136
 
  new_plugin->environ = malloc(sizeof(char *));
 
 
156
    new_plugin->environ = malloc(sizeof(char *));
 
 
157
  } while(new_plugin->environ == NULL and errno == EINTR);
 
137
158
  if(new_plugin->environ == NULL){
 
139
161
    free(new_plugin->argv);
 
140
162
    free(new_plugin);
 
143
166
  new_plugin->environ[0] = NULL;
 
 
371
409
      .doc = "Group ID the plugins will run as", .group = 3 },
 
372
410
    { .name = "debug", .key = 132,
 
373
411
      .doc = "Debug mode", .group = 4 },
 
 
413
     * These reproduce what we would get without ARGP_NO_HELP
 
 
415
    { .name = "help", .key = '?',
 
 
416
      .doc = "Give this help list", .group = -1 },
 
 
417
    { .name = "usage", .key = -3,
 
 
418
      .doc = "Give a short usage message", .group = -1 },
 
 
419
    { .name = "version", .key = 'V',
 
 
420
      .doc = "Print program version", .group = -1 },
 
377
 
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
378
 
                    struct argp_state *state) {
 
 
424
  __attribute__((nonnull(3)))
 
 
425
  error_t parse_opt(int key, char *arg, struct argp_state *state){
 
380
430
    case 'g':                   /* --global-options */
 
383
 
        while((p = strsep(&arg, ",")) != NULL){
 
387
 
          if(not add_argument(getplugin(NULL), p)){
 
388
 
            perror("add_argument");
 
389
 
            return ARGP_ERR_UNKNOWN;
 
 
433
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
 
434
          if(not add_argument(getplugin(NULL), plugin_option)){
 
394
440
    case 'G':                   /* --global-env */
 
398
 
      if(not add_environment(getplugin(NULL), arg, true)){
 
399
 
        perror("add_environment");
 
 
441
      add_environment(getplugin(NULL), arg, true);
 
402
443
    case 'o':                   /* --options-for */
 
404
 
        char *p_name = strsep(&arg, ":");
 
405
 
        if(p_name[0] == '\0' or arg == NULL){
 
408
 
        char *opt = strsep(&arg, ":");
 
409
 
        if(opt[0] == '\0' or opt == NULL){
 
413
 
        while((p = strsep(&opt, ",")) != NULL){
 
417
 
          if(not add_argument(getplugin(p_name), p)){
 
418
 
            perror("add_argument");
 
419
 
            return ARGP_ERR_UNKNOWN;
 
 
445
        char *option_list = strchr(arg, ':');
 
 
446
        if(option_list == NULL){
 
 
447
          argp_error(state, "No colon in \"%s\"", arg);
 
 
454
          argp_error(state, "Empty plugin name");
 
 
459
        while((option = strsep(&option_list, ",")) != NULL){
 
 
460
          if(not add_argument(getplugin(arg), option)){
 
424
466
    case 'E':                   /* --env-for */
 
429
468
        char *envdef = strchr(arg, ':');
 
430
469
        if(envdef == NULL){
 
 
470
          argp_error(state, "No colon in \"%s\"", arg);
 
434
 
        if(not add_environment(getplugin(arg), envdef+1, true)){
 
435
 
          perror("add_environment");
 
 
477
          argp_error(state, "Empty plugin name");
 
 
481
        add_environment(getplugin(arg), envdef, true);
 
439
484
    case 'd':                   /* --disable */
 
441
486
        plugin *p = getplugin(arg);
 
443
 
          return ARGP_ERR_UNKNOWN;
 
448
492
    case 'e':                   /* --enable */
 
450
494
        plugin *p = getplugin(arg);
 
452
 
          return ARGP_ERR_UNKNOWN;
 
457
500
    case 128:                   /* --plugin-dir */
 
459
502
      plugindir = strdup(arg);
 
460
 
      if(plugindir == NULL){
 
464
504
    case 129:                   /* --config-file */
 
465
505
      /* This is already done by parse_opt_config_file() */
 
467
507
    case 130:                   /* --userid */
 
468
 
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
469
 
      if(ret < 1 or tmpmax != (uid_t)tmpmax
 
470
 
         or arg[numchars] != '\0'){
 
471
 
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
 
472
 
                PRIdMAX "\n", arg, (intmax_t)uid);
 
 
508
      tmp_id = strtoimax(arg, &tmp, 10);
 
 
509
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
 
510
         or tmp_id != (uid_t)tmp_id){
 
 
511
        argp_error(state, "Bad user ID number: \"%s\", using %"
 
 
512
                   PRIdMAX, arg, (intmax_t)uid);
 
477
517
    case 131:                   /* --groupid */
 
478
 
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
479
 
      if(ret < 1 or tmpmax != (gid_t)tmpmax
 
480
 
         or arg[numchars] != '\0'){
 
481
 
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
 
482
 
                PRIdMAX "\n", arg, (intmax_t)gid);
 
 
518
      tmp_id = strtoimax(arg, &tmp, 10);
 
 
519
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
 
520
         or tmp_id != (gid_t)tmp_id){
 
 
521
        argp_error(state, "Bad group ID number: \"%s\", using %"
 
 
522
                   PRIdMAX, arg, (intmax_t)gid);
 
487
527
    case 132:                   /* --debug */
 
 
531
       * These reproduce what we would get without ARGP_NO_HELP
 
 
533
    case '?':                   /* --help */
 
 
534
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
 
 
535
      argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
 
 
536
    case -3:                    /* --usage */
 
 
537
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
 
 
538
      argp_state_help(state, state->out_stream,
 
 
539
                      ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
 
 
540
    case 'V':                   /* --version */
 
 
541
      fprintf(state->out_stream, "%s\n", argp_program_version);
 
491
545
 * When adding more options before this line, remember to also add a
 
492
546
 * "case" to the "parse_opt_config_file" function below.
 
 
606
667
        custom_argv = realloc(custom_argv, sizeof(char *)
 
607
668
                              * ((unsigned int) custom_argc + 1));
 
608
669
        if(custom_argv == NULL){
 
610
 
          exitstatus = EXIT_FAILURE;
 
 
670
          error(0, errno, "realloc");
 
 
671
          exitstatus = EX_OSERR;
 
614
675
        custom_argv[custom_argc-1] = new_arg;
 
615
 
        custom_argv[custom_argc] = NULL;        
 
 
676
        custom_argv[custom_argc] = NULL;
 
 
680
      ret = fclose(conffp);
 
 
681
    } while(ret == EOF and errno == EINTR);
 
 
683
      error(0, errno, "fclose");
 
 
684
      exitstatus = EX_IOERR;
 
620
689
    /* Check for harmful errors and go to fallback. Other errors might
 
621
690
       not affect opening plugins */
 
622
691
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
624
 
      exitstatus = EXIT_FAILURE;
 
 
692
      error(0, errno, "fopen");
 
 
693
      exitstatus = EX_OSERR;
 
628
 
  /* If there was any arguments from configuration file,
 
629
 
     pass them to parser as command arguments */
 
 
697
  /* If there were any arguments from the configuration file, pass
 
 
698
     them to parser as command line arguments */
 
630
699
  if(custom_argv != NULL){
 
631
 
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
633
 
    if(ret == ARGP_ERR_UNKNOWN){
 
634
 
      fprintf(stderr, "Unknown error while parsing arguments\n");
 
635
 
      exitstatus = EXIT_FAILURE;
 
 
700
    ret = argp_parse(&argp, custom_argc, custom_argv,
 
 
701
                     ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
 
 
709
      error(0, errno, "argp_parse");
 
 
710
      exitstatus = EX_OSERR;
 
 
713
      exitstatus = EX_CONFIG;
 
640
718
  /* Parse actual command line arguments, to let them override the
 
642
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
643
 
  if(ret == ARGP_ERR_UNKNOWN){
 
644
 
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
645
 
    exitstatus = EXIT_FAILURE;
 
 
720
  ret = argp_parse(&argp, argc, argv,
 
 
721
                   ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
 
 
729
    error(0, errno, "argp_parse");
 
 
730
    exitstatus = EX_OSERR;
 
 
733
    exitstatus = EX_USAGE;
 
 
663
 
  /* Strip permissions down to nobody */
 
 
752
    /* Work around Debian bug #633582:
 
 
753
       <http://bugs.debian.org/633582> */
 
 
754
    int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
 
 
755
    if(plugindir_fd == -1){
 
 
756
      error(0, errno, "open");
 
 
758
      ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
 
 
760
        error(0, errno, "fstat");
 
 
762
        if(S_ISDIR(st.st_mode) and st.st_uid == 0 and st.st_gid == 0){
 
 
763
          ret = fchown(plugindir_fd, uid, gid);
 
 
765
            error(0, errno, "fchown");
 
 
769
      TEMP_FAILURE_RETRY(close(plugindir_fd));
 
 
773
  /* Lower permissions */
 
 
776
    error(0, errno, "setgid");
 
664
778
  ret = setuid(uid);
 
673
 
  if(plugindir == NULL){
 
676
 
    dir = opendir(plugindir);
 
680
 
    perror("Could not open plugin dir");
 
681
 
    exitstatus = EXIT_FAILURE;
 
685
 
  /* Set the FD_CLOEXEC flag on the directory, if possible */
 
 
780
    error(0, errno, "setuid");
 
 
783
  /* Open plugin directory with close_on_exec flag */
 
687
 
    int dir_fd = dirfd(dir);
 
689
 
      ret = set_cloexec_flag(dir_fd);
 
691
 
        perror("set_cloexec_flag");
 
692
 
        exitstatus = EXIT_FAILURE;
 
 
786
    if(plugindir == NULL){
 
 
787
      dir_fd = open(PDIR, O_RDONLY |
 
 
790
#else  /* not O_CLOEXEC */
 
 
792
#endif  /* not O_CLOEXEC */
 
 
795
      dir_fd = open(plugindir, O_RDONLY |
 
 
798
#else  /* not O_CLOEXEC */
 
 
800
#endif  /* not O_CLOEXEC */
 
 
804
      error(0, errno, "Could not open plugin dir");
 
 
805
      exitstatus = EX_UNAVAILABLE;
 
 
810
  /* Set the FD_CLOEXEC flag on the directory */
 
 
811
    ret = set_cloexec_flag(dir_fd);
 
 
813
      error(0, errno, "set_cloexec_flag");
 
 
814
      TEMP_FAILURE_RETRY(close(dir_fd));
 
 
815
      exitstatus = EX_OSERR;
 
 
818
#endif  /* O_CLOEXEC */
 
 
820
    dir = fdopendir(dir_fd);
 
 
822
      error(0, errno, "Could not open plugin dir");
 
 
823
      TEMP_FAILURE_RETRY(close(dir_fd));
 
 
824
      exitstatus = EX_OSERR;
 
 
761
894
    if(plugindir == NULL){
 
762
 
      ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
 
 
895
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, PDIR "/%s",
 
764
 
      ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
 
898
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, "%s/%s",
 
 
903
      error(0, errno, "asprintf");
 
771
 
    ret = stat(filename, &st);
 
 
907
    ret = (int)TEMP_FAILURE_RETRY(stat(filename, &st));
 
 
909
      error(0, errno, "stat");
 
778
914
    /* Ignore non-executable files */
 
779
 
    if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
 
915
    if(not S_ISREG(st.st_mode)
 
 
916
       or (TEMP_FAILURE_RETRY(access(filename, X_OK)) != 0)){
 
781
918
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
782
919
                " with bad type or mode\n", filename);
 
 
822
959
    if(p->environ[0] != NULL){
 
823
960
      for(char **e = environ; *e != NULL; e++){
 
824
961
        if(not add_environment(p, *e, false)){
 
825
 
          perror("add_environment");
 
 
962
          error(0, errno, "add_environment");
 
 
968
    ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
 
834
 
      exitstatus = EXIT_FAILURE;
 
 
970
      error(0, errno, "pipe");
 
 
971
      exitstatus = EX_OSERR;
 
837
974
    /* Ask OS to automatic close the pipe on exec */
 
838
975
    ret = set_cloexec_flag(pipefd[0]);
 
840
 
      perror("set_cloexec_flag");
 
841
 
      exitstatus = EXIT_FAILURE;
 
 
977
      error(0, errno, "set_cloexec_flag");
 
 
978
      exitstatus = EX_OSERR;
 
844
981
    ret = set_cloexec_flag(pipefd[1]);
 
846
 
      perror("set_cloexec_flag");
 
847
 
      exitstatus = EXIT_FAILURE;
 
 
983
      error(0, errno, "set_cloexec_flag");
 
 
984
      exitstatus = EX_OSERR;
 
850
987
    /* Block SIGCHLD until process is safely in process list */
 
851
 
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
 
988
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
 
 
989
                                              &sigchld_action.sa_mask,
 
853
 
      perror("sigprocmask");
 
854
 
      exitstatus = EXIT_FAILURE;
 
 
992
      error(0, errno, "sigprocmask");
 
 
993
      exitstatus = EX_OSERR;
 
857
996
    /* Starting a new process to be watched */
 
 
1000
    } while(pid == -1 and errno == EINTR);
 
861
 
      exitstatus = EXIT_FAILURE;
 
 
1002
      error(0, errno, "fork");
 
 
1003
      exitstatus = EX_OSERR;
 
865
1007
      /* this is the child process */
 
866
1008
      ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
 
 
1010
        error(0, errno, "sigaction");
 
871
1013
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
873
 
        perror("sigprocmask");
 
 
1015
        error(0, errno, "sigprocmask");
 
877
1019
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
 
 
1021
        error(0, errno, "dup2");
 
883
1025
      if(dirfd(dir) < 0){
 
 
888
1030
      if(p->environ[0] == NULL){
 
889
1031
        if(execv(filename, p->argv) < 0){
 
 
1032
          error(0, errno, "execv for %s", filename);
 
894
1036
        if(execve(filename, p->argv, p->environ) < 0){
 
 
1037
          error(0, errno, "execve for %s", filename);
 
901
1043
    /* Parent process */
 
902
 
    close(pipefd[1]);           /* Close unused write end of pipe */
 
 
1044
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
 
904
1047
    plugin *new_plugin = getplugin(dirst->d_name);
 
905
1048
    if(new_plugin == NULL){
 
907
 
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
 
1049
      error(0, errno, "getplugin");
 
 
1050
      ret = (int)(TEMP_FAILURE_RETRY
 
 
1051
                  (sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
909
 
        perror("sigprocmask");
 
 
1054
        error(0, errno, "sigprocmask");
 
911
 
      exitstatus = EXIT_FAILURE;
 
 
1056
      exitstatus = EX_OSERR;
 
 
949
1098
  while(plugin_list){
 
950
1099
    fd_set rfds = rfds_all;
 
951
1100
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
 
952
 
    if(select_ret == -1){
 
954
 
      exitstatus = EXIT_FAILURE;
 
 
1101
    if(select_ret == -1 and errno != EINTR){
 
 
1102
      error(0, errno, "select");
 
 
1103
      exitstatus = EX_OSERR;
 
957
1106
    /* OK, now either a process completed, or something can be read
 
958
1107
       from one of them */
 
959
1108
    for(plugin *proc = plugin_list; proc != NULL;){
 
960
1109
      /* Is this process completely done? */
 
961
 
      if(proc->eof and proc->completed){
 
 
1110
      if(proc->completed and proc->eof){
 
962
1111
        /* Only accept the plugin output if it exited cleanly */
 
963
1112
        if(not WIFEXITED(proc->status)
 
964
1113
           or WEXITSTATUS(proc->status) != 0){
 
965
1114
          /* Bad exit by plugin */
 
968
1117
            if(WIFEXITED(proc->status)){
 
969
 
              fprintf(stderr, "Plugin %" PRIdMAX " exited with status"
 
970
 
                      " %d\n", (intmax_t) (proc->pid),
 
 
1118
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
 
 
1119
                      " status %d\n", proc->name,
 
 
1120
                      (intmax_t) (proc->pid),
 
971
1121
                      WEXITSTATUS(proc->status));
 
972
 
            } else if(WIFSIGNALED(proc->status)) {
 
973
 
              fprintf(stderr, "Plugin %" PRIdMAX " killed by signal"
 
974
 
                      " %d\n", (intmax_t) (proc->pid),
 
975
 
                      WTERMSIG(proc->status));
 
 
1122
            } else if(WIFSIGNALED(proc->status)){
 
 
1123
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
 
 
1124
                      " signal %d: %s\n", proc->name,
 
 
1125
                      (intmax_t) (proc->pid),
 
 
1126
                      WTERMSIG(proc->status),
 
 
1127
                      strsignal(WTERMSIG(proc->status)));
 
976
1128
            } else if(WCOREDUMP(proc->status)){
 
977
 
              fprintf(stderr, "Plugin %" PRIdMAX " dumped core\n",
 
978
 
                      (intmax_t) (proc->pid));
 
 
1129
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
 
1130
                      " core\n", proc->name, (intmax_t) (proc->pid));
 
982
1134
          /* Remove the plugin */
 
983
 
          FD_CLR(proc->fd, &rfds_all);
 
 
1135
          FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
 
985
1138
          /* Block signal while modifying process_list */
 
986
 
          ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
 
1139
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
 
 
1141
                                         &sigchld_action.sa_mask,
 
988
 
            perror("sigprocmask");
 
989
 
            exitstatus = EXIT_FAILURE;
 
 
1144
            error(0, errno, "sigprocmask");
 
 
1145
            exitstatus = EX_OSERR;