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