1
 
/*  -*- coding: utf-8; mode: c; mode: orgtbl -*- */
 
 
1
/*  -*- coding: utf-8 -*- */
 
3
3
 * Mandos plugin runner - Run Mandos plugins
 
5
 
 * Copyright © 2008,2009 Teddy Hogeborn
 
6
 
 * Copyright © 2008,2009 Björn Påhlsson
 
 
5
 * Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
8
7
 * This program is free software: you can redistribute it and/or
 
9
8
 * modify it under the terms of the GNU General Public License as
 
 
28
27
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
 
29
28
                                   EXIT_SUCCESS, realloc() */
 
30
29
#include <stdbool.h>            /* bool, true, false */
 
31
 
#include <stdio.h>              /* perror, fileno(), fprintf(),
 
32
 
                                   stderr, STDOUT_FILENO */
 
 
30
#include <stdio.h>              /* perror, popen(), fileno(),
 
 
31
                                   fprintf(), stderr, STDOUT_FILENO */
 
33
32
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
 
34
33
                                   stat, waitpid(), WIFEXITED(),
 
35
34
                                   WEXITSTATUS(), wait(), pid_t,
 
 
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
41
#include <sys/stat.h>           /* struct stat, stat(), S_ISREG() */
 
44
42
#include <iso646.h>             /* and, or, not */
 
45
43
#include <dirent.h>             /* DIR, struct dirent, opendir(),
 
 
48
46
                                   fcntl(), setuid(), setgid(),
 
49
47
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
 
50
48
                                   access(), pipe(), fork(), close()
 
51
 
                                   dup2(), STDOUT_FILENO, _exit(),
 
 
49
                                   dup2, STDOUT_FILENO, _exit(),
 
52
50
                                   execv(), write(), read(),
 
54
52
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
 
56
 
#include <string.h>             /* strsep, strlen(), asprintf(),
 
 
54
#include <string.h>             /* strsep, strlen(), asprintf() */
 
58
55
#include <errno.h>              /* errno */
 
59
56
#include <argp.h>               /* struct argp_option, struct
 
60
57
                                   argp_state, struct argp,
 
 
64
61
#include <signal.h>             /* struct sigaction, sigemptyset(),
 
65
62
                                   sigaddset(), sigaction(),
 
66
63
                                   sigprocmask(), SIG_BLOCK, SIGCHLD,
 
67
 
                                   SIG_UNBLOCK, kill(), sig_atomic_t
 
 
64
                                   SIG_UNBLOCK, kill() */
 
69
65
#include <errno.h>              /* errno, EBADF */
 
70
 
#include <inttypes.h>           /* intmax_t, PRIdMAX, strtoimax() */
 
72
67
#define BUFFER_SIZE 256
 
74
69
#define PDIR "/lib/mandos/plugins.d"
 
75
70
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
 
77
 
const char *argp_program_version = "plugin-runner " VERSION;
 
 
72
const char *argp_program_version = "plugin-runner 1.0";
 
78
73
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
 
80
77
typedef struct plugin{
 
81
78
  char *name;                   /* can be NULL or any plugin name */
 
 
103
100
   or if none is found, creates a new one */
 
104
101
static plugin *getplugin(char *name){
 
105
102
  /* Check for exiting plugin with that name */
 
106
 
  for(plugin *p = plugin_list; p != NULL; p = p->next){
 
108
 
       or (p->name and name and (strcmp(p->name, name) == 0))){
 
 
103
  for (plugin *p = plugin_list; p != NULL; p = p->next){
 
 
104
    if ((p->name == name)
 
 
105
        or (p->name and name and (strcmp(p->name, name) == 0))){
 
112
109
  /* Create a new plugin */
 
113
 
  plugin *new_plugin = NULL;
 
115
 
    new_plugin = malloc(sizeof(plugin));
 
116
 
  } while(new_plugin == NULL and errno == EINTR);
 
117
 
  if(new_plugin == NULL){
 
 
110
  plugin *new_plugin = malloc(sizeof(plugin));
 
 
111
  if (new_plugin == NULL){
 
120
114
  char *copy_name = NULL;
 
121
115
  if(name != NULL){
 
123
 
      copy_name = strdup(name);
 
124
 
    } while(copy_name == NULL and errno == EINTR);
 
 
116
    copy_name = strdup(name);
 
125
117
    if(copy_name == NULL){
 
131
 
  *new_plugin = (plugin){ .name = copy_name,
 
134
 
                          .next = plugin_list };
 
 
122
  *new_plugin = (plugin) { .name = copy_name,
 
 
125
                           .next = plugin_list };
 
137
 
    new_plugin->argv = malloc(sizeof(char *) * 2);
 
138
 
  } while(new_plugin->argv == NULL and errno == EINTR);
 
139
 
  if(new_plugin->argv == NULL){
 
 
127
  new_plugin->argv = malloc(sizeof(char *) * 2);
 
 
128
  if (new_plugin->argv == NULL){
 
141
130
    free(new_plugin);
 
 
164
151
static bool add_to_char_array(const char *new, char ***array,
 
166
153
  /* Resize the pointed-to array to hold one more pointer */
 
168
 
    *array = realloc(*array, sizeof(char *)
 
169
 
                     * (size_t) ((*len) + 2));
 
170
 
  } while(*array == NULL and errno == EINTR);
 
 
154
  *array = realloc(*array, sizeof(char *)
 
 
155
                   * (size_t) ((*len) + 2));
 
171
156
  /* Malloc check */
 
172
157
  if(*array == NULL){
 
175
160
  /* Make a copy of the new string */
 
179
 
  } while(copy == NULL and errno == EINTR);
 
 
161
  char *copy = strdup(new);
 
180
162
  if(copy == NULL){
 
 
228
207
 * Based on the example in the GNU LibC manual chapter 13.13 "File
 
229
208
 * Descriptor Flags".
 
230
 
 | [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
 
 
209
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
 
232
 
static int set_cloexec_flag(int fd){
 
233
 
  int ret = (int)TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD, 0));
 
 
211
static int set_cloexec_flag(int fd)
 
 
213
  int ret = fcntl(fd, F_GETFD, 0);
 
234
214
  /* If reading the flags failed, return error indication now. */
 
238
218
  /* Store modified flag word in the descriptor. */
 
239
 
  return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
 
 
219
  return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
 
244
223
/* Mark processes as completed when they exit, and save their exit
 
246
 
static void handle_sigchld(__attribute__((unused)) int sig){
 
247
 
  int old_errno = errno;
 
 
225
void handle_sigchld(__attribute__((unused)) int sig){
 
249
227
    plugin *proc = plugin_list;
 
 
400
 
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
401
 
                    struct argp_state *state){
 
 
376
  error_t parse_opt (int key, char *arg, __attribute__((unused))
 
 
377
                     struct argp_state *state) {
 
405
379
    case 'g':                   /* --global-options */
 
408
 
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
409
 
          if(plugin_option[0] == '\0'){
 
 
382
        while((p = strsep(&arg, ",")) != NULL){
 
412
 
          if(not add_argument(getplugin(NULL), plugin_option)){
 
 
386
          if(not add_argument(getplugin(NULL), p)){
 
413
387
            perror("add_argument");
 
414
388
            return ARGP_ERR_UNKNOWN;
 
 
423
 
      if(not add_environment(getplugin(NULL), arg, true)){
 
424
 
        perror("add_environment");
 
 
398
        char *envdef = strdup(arg);
 
 
402
        if(not add_environment(getplugin(NULL), envdef, true)){
 
 
403
          perror("add_environment");
 
427
407
    case 'o':                   /* --options-for */
 
429
 
        char *plugin_name = strsep(&arg, ":");
 
430
 
        if(plugin_name[0] == '\0'){
 
434
 
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
435
 
          if(not add_argument(getplugin(plugin_name), plugin_option)){
 
 
409
        char *p_name = strsep(&arg, ":");
 
 
410
        if(p_name[0] == '\0' or arg == NULL){
 
 
413
        char *opt = strsep(&arg, ":");
 
 
414
        if(opt[0] == '\0' or opt == NULL){
 
 
418
        while((p = strsep(&opt, ",")) != NULL){
 
 
422
          if(not add_argument(getplugin(p_name), p)){
 
436
423
            perror("add_argument");
 
437
424
            return ARGP_ERR_UNKNOWN;
 
 
475
466
    case 128:                   /* --plugin-dir */
 
477
467
      plugindir = strdup(arg);
 
478
468
      if(plugindir == NULL){
 
479
469
        perror("strdup");
 
482
472
    case 129:                   /* --config-file */
 
483
473
      /* This is already done by parse_opt_config_file() */
 
485
475
    case 130:                   /* --userid */
 
487
 
      tmpmax = strtoimax(arg, &tmp, 10);
 
488
 
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
489
 
         or tmpmax != (uid_t)tmpmax){
 
490
 
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
 
491
 
                PRIdMAX "\n", arg, (intmax_t)uid);
 
 
476
      uid = (uid_t)strtol(arg, NULL, 10);
 
496
478
    case 131:                   /* --groupid */
 
498
 
      tmpmax = strtoimax(arg, &tmp, 10);
 
499
 
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
500
 
         or tmpmax != (gid_t)tmpmax){
 
501
 
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
 
502
 
                PRIdMAX "\n", arg, (intmax_t)gid);
 
 
479
      gid = (gid_t)strtol(arg, NULL, 10);
 
507
481
    case 132:                   /* --debug */
 
511
 
 * When adding more options before this line, remember to also add a
 
512
 
 * "case" to the "parse_opt_config_file" function below.
 
514
484
    case ARGP_KEY_ARG:
 
515
 
      /* Cryptsetup always passes an argument, which is an empty
 
516
 
         string if "none" was specified in /etc/crypttab.  So if
 
517
 
         argument was empty, we ignore it silently. */
 
519
 
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
 
485
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
522
487
    case ARGP_KEY_END:
 
 
530
495
  /* This option parser is the same as parse_opt() above, except it
 
531
496
     ignores everything but the --config-file option. */
 
532
 
  error_t parse_opt_config_file(int key, char *arg,
 
533
 
                                __attribute__((unused))
 
534
 
                                struct argp_state *state){
 
 
497
  error_t parse_opt_config_file (int key, char *arg,
 
 
498
                                 __attribute__((unused))
 
 
499
                                 struct argp_state *state) {
 
536
501
    case 'g':                   /* --global-options */
 
537
502
    case 'G':                   /* --global-env */
 
538
503
    case 'o':                   /* --options-for */
 
 
566
530
                       .doc = "Mandos plugin runner -- Run plugins" };
 
568
 
  /* Parse using parse_opt_config_file() in order to get the custom
 
 
532
  /* Parse using the parse_opt_config_file in order to get the custom
 
569
533
     config file location, if any. */
 
570
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
571
 
  if(ret == ARGP_ERR_UNKNOWN){
 
 
534
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
 
535
  if (ret == ARGP_ERR_UNKNOWN){
 
572
536
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
573
537
    exitstatus = EXIT_FAILURE;
 
 
578
542
  argp.parser = parse_opt;
 
580
544
  /* Open the configfile if available */
 
 
545
  if (argfile == NULL){
 
582
546
    conffp = fopen(AFILE, "r");
 
584
548
    conffp = fopen(argfile, "r");
 
586
550
  if(conffp != NULL){
 
587
551
    char *org_line = NULL;
 
588
552
    char *p, *arg, *new_arg, *line;
 
590
555
    const char whitespace_delims[] = " \r\t\f\v\n";
 
591
556
    const char comment_delim[] = "#";
 
594
559
    custom_argv = malloc(sizeof(char*) * 2);
 
595
560
    if(custom_argv == NULL){
 
 
634
599
        custom_argv[custom_argc-1] = new_arg;
 
635
 
        custom_argv[custom_argc] = NULL;
 
 
600
        custom_argv[custom_argc] = NULL;        
 
639
 
      ret = fclose(conffp);
 
640
 
    } while(ret == EOF and errno == EINTR);
 
643
 
      exitstatus = EXIT_FAILURE;
 
648
605
    /* Check for harmful errors and go to fallback. Other errors might
 
649
606
       not affect opening plugins */
 
650
 
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
 
607
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
652
609
      exitstatus = EXIT_FAILURE;
 
 
656
613
  /* If there was any arguments from configuration file,
 
657
614
     pass them to parser as command arguments */
 
658
615
  if(custom_argv != NULL){
 
659
 
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
661
 
    if(ret == ARGP_ERR_UNKNOWN){
 
 
616
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
 
618
    if (ret == ARGP_ERR_UNKNOWN){
 
662
619
      fprintf(stderr, "Unknown error while parsing arguments\n");
 
663
620
      exitstatus = EXIT_FAILURE;
 
 
668
625
  /* Parse actual command line arguments, to let them override the
 
670
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
671
 
  if(ret == ARGP_ERR_UNKNOWN){
 
 
627
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
 
628
  if (ret == ARGP_ERR_UNKNOWN){
 
672
629
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
673
630
    exitstatus = EXIT_FAILURE;
 
 
681
638
      for(char **a = p->argv; *a != NULL; a++){
 
682
639
        fprintf(stderr, "\tArg: %s\n", *a);
 
684
 
      fprintf(stderr, "...and %d environment variables\n", p->envc);
 
 
641
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
685
642
      for(char **a = p->environ; *a != NULL; a++){
 
686
643
        fprintf(stderr, "\t%s\n", *a);
 
 
791
745
    if(plugindir == NULL){
 
792
 
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, PDIR "/%s",
 
 
746
      ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
 
795
 
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, "%s/%s",
 
 
748
      ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
800
751
      perror("asprintf");
 
804
 
    ret = (int)TEMP_FAILURE_RETRY(stat(filename, &st));
 
 
755
    ret = stat(filename, &st);
 
811
762
    /* Ignore non-executable files */
 
812
 
    if(not S_ISREG(st.st_mode)
 
813
 
       or (TEMP_FAILURE_RETRY(access(filename, X_OK)) != 0)){
 
 
763
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
815
765
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
816
766
                " with bad type or mode\n", filename);
 
 
884
834
    /* Block SIGCHLD until process is safely in process list */
 
885
 
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
 
886
 
                                              &sigchld_action.sa_mask,
 
 
835
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
889
837
      perror("sigprocmask");
 
890
838
      exitstatus = EXIT_FAILURE;
 
893
841
    /* Starting a new process to be watched */
 
897
 
    } while(pid == -1 and errno == EINTR);
 
900
845
      exitstatus = EXIT_FAILURE;
 
 
960
902
    /* Unblock SIGCHLD so signal handler can be run if this process
 
961
903
       has already completed */
 
962
 
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
 
963
 
                                              &sigchld_action.sa_mask,
 
 
904
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
966
906
      perror("sigprocmask");
 
967
907
      exitstatus = EXIT_FAILURE;
 
971
 
    FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
 
 
911
    FD_SET(new_plugin->fd, &rfds_all);
 
974
 
    if(maxfd < new_plugin->fd){
 
 
913
    if (maxfd < new_plugin->fd){
 
975
914
      maxfd = new_plugin->fd;
 
979
 
  TEMP_FAILURE_RETRY(closedir(dir));
 
981
 
  free_plugin(getplugin(NULL));
 
983
922
  for(plugin *p = plugin_list; p != NULL; p = p->next){
 
 
990
929
      free_plugin_list();
 
994
933
  /* Main loop while running plugins exist */
 
995
934
  while(plugin_list){
 
996
935
    fd_set rfds = rfds_all;
 
997
936
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
 
998
 
    if(select_ret == -1 and errno != EINTR){
 
 
937
    if (select_ret == -1){
 
999
938
      perror("select");
 
1000
939
      exitstatus = EXIT_FAILURE;
 
1003
942
    /* OK, now either a process completed, or something can be read
 
1004
943
       from one of them */
 
1005
 
    for(plugin *proc = plugin_list; proc != NULL;){
 
 
944
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
1006
945
      /* Is this process completely done? */
 
1007
 
      if(proc->completed and proc->eof){
 
 
946
      if(proc->eof and proc->completed){
 
1008
947
        /* Only accept the plugin output if it exited cleanly */
 
1009
948
        if(not WIFEXITED(proc->status)
 
1010
949
           or WEXITSTATUS(proc->status) != 0){
 
1011
950
          /* Bad exit by plugin */
 
1014
953
            if(WIFEXITED(proc->status)){
 
1015
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
 
1016
 
                      " status %d\n", proc->name,
 
1017
 
                      (intmax_t) (proc->pid),
 
 
954
              fprintf(stderr, "Plugin %u exited with status %d\n",
 
 
955
                      (unsigned int) (proc->pid),
 
1018
956
                      WEXITSTATUS(proc->status));
 
1019
 
            } else if(WIFSIGNALED(proc->status)){
 
1020
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
 
1021
 
                      " signal %d: %s\n", proc->name,
 
1022
 
                      (intmax_t) (proc->pid),
 
1023
 
                      WTERMSIG(proc->status),
 
1024
 
                      strsignal(WTERMSIG(proc->status)));
 
 
957
            } else if(WIFSIGNALED(proc->status)) {
 
 
958
              fprintf(stderr, "Plugin %u killed by signal %d\n",
 
 
959
                      (unsigned int) (proc->pid),
 
 
960
                      WTERMSIG(proc->status));
 
1025
961
            } else if(WCOREDUMP(proc->status)){
 
1026
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
1027
 
                      " core\n", proc->name, (intmax_t) (proc->pid));
 
 
962
              fprintf(stderr, "Plugin %d dumped core\n",
 
 
963
                      (unsigned int) (proc->pid));
 
1031
967
          /* Remove the plugin */
 
1032
 
          FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
 
 
968
          FD_CLR(proc->fd, &rfds_all);
 
1035
970
          /* Block signal while modifying process_list */
 
1036
 
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
 
1038
 
                                         &sigchld_action.sa_mask,
 
 
971
          ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
1041
973
            perror("sigprocmask");
 
1042
974
            exitstatus = EXIT_FAILURE;
 
1046
 
          plugin *next_plugin = proc->next;
 
1047
977
          free_plugin(proc);
 
1050
978
          /* We are done modifying process list, so unblock signal */
 
1051
 
          ret = (int)(TEMP_FAILURE_RETRY
 
1052
 
                      (sigprocmask(SIG_UNBLOCK,
 
1053
 
                                   &sigchld_action.sa_mask, NULL)));
 
 
979
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
 
1055
982
            perror("sigprocmask");
 
1056
983
            exitstatus = EXIT_FAILURE;
 
 
1078
1004
      /* This process has not completed.  Does it have any output? */
 
1079
 
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
 
 
1005
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
 
1082
1006
        /* This process had nothing to say at this time */
 
1086
1009
      /* Before reading, make the process' data buffer large enough */
 
1087
1010
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
 
1088
1011
        proc->buffer = realloc(proc->buffer, proc->buffer_size
 
1089
1012
                               + (size_t) BUFFER_SIZE);
 
1090
 
        if(proc->buffer == NULL){
 
 
1013
        if (proc->buffer == NULL){
 
1091
1014
          perror("malloc");
 
1092
1015
          exitstatus = EXIT_FAILURE;
 
 
1095
1018
        proc->buffer_size += BUFFER_SIZE;
 
1097
1020
      /* Read from the process */
 
1098
 
      sret = TEMP_FAILURE_RETRY(read(proc->fd,
 
1100
 
                                     + proc->buffer_length,
 
 
1021
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1103
1024
        /* Read error from this process; ignore the error */
 
1109
1029
        proc->eof = true;
 
1111
 
        proc->buffer_length += (size_t) sret;
 
 
1031
        proc->buffer_length += (size_t) ret;
 
1119
1039
  if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){