/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugin-runner.c

  • Committer: Teddy Hogeborn
  • Date: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
/*
3
3
 * Mandos plugin runner - Run Mandos plugins
4
4
 *
5
 
 * Copyright © 2008-2020 Teddy Hogeborn
6
 
 * Copyright © 2008-2020 Björn Påhlsson
7
 
 * 
8
 
 * This file is part of Mandos.
9
 
 * 
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.
14
 
 * 
15
 
 * Mandos is distributed in the hope that it will be useful, but
 
5
 * Copyright © 2008-2014 Teddy Hogeborn
 
6
 * Copyright © 2008-2014 Björn Påhlsson
 
7
 * 
 
8
 * This program is free software: you can redistribute it and/or
 
9
 * modify it under the terms of the GNU General Public License as
 
10
 * published by the Free Software Foundation, either version 3 of the
 
11
 * License, or (at your option) any later version.
 
12
 * 
 
13
 * This program is distributed in the hope that it will be useful, but
16
14
 * WITHOUT ANY WARRANTY; without even the implied warranty of
17
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18
16
 * General Public License for more details.
19
17
 * 
20
18
 * You should have received a copy of the GNU General Public License
21
 
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
19
 * along with this program.  If not, see
 
20
 * <http://www.gnu.org/licenses/>.
22
21
 * 
23
22
 * Contact the authors at <mandos@recompile.se>.
24
23
 */
26
25
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY(), getline(),
27
26
                                   O_CLOEXEC, pipe2() */
28
27
#include <stddef.h>             /* size_t, NULL */
29
 
#include <stdlib.h>             /* malloc(), reallocarray(), realloc(),
30
 
                                   EXIT_SUCCESS, exit() */
 
28
#include <stdlib.h>             /* malloc(), exit(), EXIT_SUCCESS,
 
29
                                   realloc() */
31
30
#include <stdbool.h>            /* bool, true, false */
32
31
#include <stdio.h>              /* fileno(), fprintf(),
33
32
                                   stderr, STDOUT_FILENO, fclose() */
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() */
 
40
                                   WEXITSTATUS(), WTERMSIG(),
 
41
                                   WCOREDUMP() */
42
42
#include <sys/stat.h>           /* struct stat, fstat(), S_ISREG() */
43
43
#include <iso646.h>             /* and, or, not */
44
44
#include <dirent.h>             /* struct dirent, scandirat() */
76
76
#define BUFFER_SIZE 256
77
77
 
78
78
#define PDIR "/lib/mandos/plugins.d"
79
 
#define PHDIR "/lib/mandos/plugin-helpers"
80
79
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
81
80
 
82
81
const char *argp_program_version = "plugin-runner " VERSION;
179
178
  /* Resize the pointed-to array to hold one more pointer */
180
179
  char **new_array = NULL;
181
180
  do {
182
 
#if defined(__GLIBC_PREREQ) and __GLIBC_PREREQ(2, 26)
183
 
    new_array = reallocarray(*array, (size_t)((*len) + 2),
184
 
                             sizeof(char *));
185
 
#else
186
 
    if(((size_t)((*len) + 2)) > (SIZE_MAX / sizeof(char *))){
187
 
      /* overflow */
188
 
      new_array = NULL;
189
 
      errno = ENOMEM;
190
 
    } else {
191
 
      new_array = realloc(*array, (size_t)((*len) + 2)
192
 
                          * sizeof(char *));
193
 
    }
194
 
#endif
 
181
    new_array = realloc(*array, sizeof(char *)
 
182
                        * (size_t) ((*len) + 2));
195
183
  } while(new_array == NULL and errno == EINTR);
196
184
  /* Malloc check */
197
185
  if(new_array == NULL){
324
312
__attribute__((nonnull))
325
313
static void free_plugin(plugin *plugin_node){
326
314
  
327
 
  for(char **arg = (plugin_node->argv)+1; *arg != NULL; arg++){
 
315
  for(char **arg = plugin_node->argv; *arg != NULL; arg++){
328
316
    free(*arg);
329
317
  }
330
 
  free(plugin_node->name);
331
318
  free(plugin_node->argv);
332
319
  for(char **env = plugin_node->environ; *env != NULL; env++){
333
320
    free(*env);
360
347
 
361
348
int main(int argc, char *argv[]){
362
349
  char *plugindir = NULL;
363
 
  char *pluginhelperdir = NULL;
364
350
  char *argfile = NULL;
365
351
  FILE *conffp;
366
352
  struct dirent **direntries = NULL;
428
414
      .doc = "Group ID the plugins will run as", .group = 3 },
429
415
    { .name = "debug", .key = 132,
430
416
      .doc = "Debug mode", .group = 4 },
431
 
    { .name = "plugin-helper-dir", .key = 133,
432
 
      .arg = "DIRECTORY",
433
 
      .doc = "Specify a different plugin helper directory",
434
 
      .group = 2 },
435
417
    /*
436
418
     * These reproduce what we would get without ARGP_NO_HELP
437
419
     */
563
545
    case 132:                   /* --debug */
564
546
      debug = true;
565
547
      break;
566
 
    case 133:                   /* --plugin-helper-dir */
567
 
      free(pluginhelperdir);
568
 
      pluginhelperdir = strdup(arg);
569
 
      if(pluginhelperdir != NULL){
570
 
        errno = 0;
571
 
      }
572
 
      break;
573
548
      /*
574
549
       * These reproduce what we would get without ARGP_NO_HELP
575
550
       */
576
551
    case '?':                   /* --help */
577
552
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
578
553
      argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
579
 
      __builtin_unreachable();
580
554
    case -3:                    /* --usage */
581
555
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
582
556
      argp_state_help(state, state->out_stream,
583
557
                      ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
584
 
      __builtin_unreachable();
585
558
    case 'V':                   /* --version */
586
559
      fprintf(state->out_stream, "%s\n", argp_program_version);
587
560
      exit(EXIT_SUCCESS);
597
570
      if(arg[0] == '\0'){
598
571
        break;
599
572
      }
600
 
#if __GNUC__ >= 7
601
 
      __attribute__((fallthrough));
602
 
#else
603
 
          /* FALLTHROUGH */
604
 
#endif
605
573
    default:
606
574
      return ARGP_ERR_UNKNOWN;
607
575
    }
633
601
    case 130:                   /* --userid */
634
602
    case 131:                   /* --groupid */
635
603
    case 132:                   /* --debug */
636
 
    case 133:                   /* --plugin-helper-dir */
637
604
    case '?':                   /* --help */
638
605
    case -3:                    /* --usage */
639
606
    case 'V':                   /* --version */
719
686
        
720
687
        custom_argc += 1;
721
688
        {
722
 
#if defined(__GLIBC_PREREQ) and __GLIBC_PREREQ(2, 26)
723
 
          char **new_argv = reallocarray(custom_argv, (size_t)custom_argc + 1,
724
 
                                         sizeof(char *));
725
 
#else
726
 
          char **new_argv = NULL;
727
 
          if(((size_t)custom_argc + 1) > (SIZE_MAX / sizeof(char *))){
728
 
            /* overflow */
729
 
            errno = ENOMEM;
730
 
          } else {
731
 
            new_argv = realloc(custom_argv, ((size_t)custom_argc + 1)
732
 
                               * sizeof(char *));
733
 
          }
734
 
#endif
 
689
          char **new_argv = realloc(custom_argv, sizeof(char *)
 
690
                                    * ((unsigned int)
 
691
                                       custom_argc + 1));
735
692
          if(new_argv == NULL){
736
 
            error(0, errno, "reallocarray");
 
693
            error(0, errno, "realloc");
737
694
            exitstatus = EX_OSERR;
738
695
            free(new_arg);
739
696
            free(org_line);
804
761
    goto fallback;
805
762
  }
806
763
  
807
 
  {
808
 
    char *pluginhelperenv;
809
 
    bool bret = true;
810
 
    ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
811
 
                   pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
812
 
    if(ret != -1){
813
 
      bret = add_environment(getplugin(NULL), pluginhelperenv, true);
814
 
    }
815
 
    if(ret == -1 or not bret){
816
 
      error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
817
 
            " environment variable to \"%s\" for all plugins\n",
818
 
            pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
819
 
    }
820
 
    if(ret != -1){
821
 
      free(pluginhelperenv);
822
 
    }
823
 
  }
824
 
  
825
764
  if(debug){
826
 
    for(plugin *p = plugin_list; p != NULL; p = p->next){
 
765
    for(plugin *p = plugin_list; p != NULL; p=p->next){
827
766
      fprintf(stderr, "Plugin: %s has %d arguments\n",
828
767
              p->name ? p->name : "Global", p->argc - 1);
829
768
      for(char **a = p->argv; *a != NULL; a++){
838
777
  
839
778
  if(getuid() == 0){
840
779
    /* Work around Debian bug #633582:
841
 
       <https://bugs.debian.org/633582> */
 
780
       <http://bugs.debian.org/633582> */
842
781
    int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
843
782
    if(plugindir_fd == -1){
844
783
      if(errno != ENOENT){
856
795
          }
857
796
        }
858
797
      }
859
 
      close(plugindir_fd);
 
798
      TEMP_FAILURE_RETRY(close(plugindir_fd));
860
799
    }
861
800
  }
862
801
  
921
860
    return 1;
922
861
  }
923
862
  
 
863
#ifdef __GLIBC__
 
864
#if __GLIBC_PREREQ(2, 15)
924
865
  int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
925
866
                             alphasort);
 
867
#else  /* not __GLIBC_PREREQ(2, 15) */
 
868
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
 
869
                           &direntries, good_name, alphasort);
 
870
#endif  /* not __GLIBC_PREREQ(2, 15) */
 
871
#else   /* not __GLIBC__ */
 
872
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
 
873
                           &direntries, good_name, alphasort);
 
874
#endif  /* not __GLIBC__ */
926
875
  if(numplugins == -1){
927
876
    error(0, errno, "Could not scan plugin dir");
928
877
    direntries = NULL;
938
887
    int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
939
888
    if(plugin_fd == -1){
940
889
      error(0, errno, "Could not open plugin");
941
 
      free(direntries[i]);
942
890
      continue;
943
891
    }
944
892
    ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
945
893
    if(ret == -1){
946
894
      error(0, errno, "stat");
947
 
      close(plugin_fd);
948
 
      free(direntries[i]);
 
895
      TEMP_FAILURE_RETRY(close(plugin_fd));
949
896
      continue;
950
897
    }
951
898
    
959
906
                plugindir != NULL ? plugindir : PDIR,
960
907
                direntries[i]->d_name);
961
908
      }
962
 
      close(plugin_fd);
963
 
      free(direntries[i]);
 
909
      TEMP_FAILURE_RETRY(close(plugin_fd));
964
910
      continue;
965
911
    }
966
912
    
967
913
    plugin *p = getplugin(direntries[i]->d_name);
968
914
    if(p == NULL){
969
915
      error(0, errno, "getplugin");
970
 
      close(plugin_fd);
971
 
      free(direntries[i]);
 
916
      TEMP_FAILURE_RETRY(close(plugin_fd));
972
917
      continue;
973
918
    }
974
919
    if(p->disabled){
976
921
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
977
922
                direntries[i]->d_name);
978
923
      }
979
 
      close(plugin_fd);
980
 
      free(direntries[i]);
 
924
      TEMP_FAILURE_RETRY(close(plugin_fd));
981
925
      continue;
982
926
    }
983
927
    {
1016
960
    if(ret == -1){
1017
961
      error(0, errno, "pipe");
1018
962
      exitstatus = EX_OSERR;
1019
 
      free(direntries[i]);
1020
963
      goto fallback;
1021
964
    }
1022
965
    if(pipefd[0] >= FD_SETSIZE){
1023
966
      fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
1024
967
              FD_SETSIZE);
1025
 
      close(pipefd[0]);
1026
 
      close(pipefd[1]);
 
968
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
969
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1027
970
      exitstatus = EX_OSERR;
1028
 
      free(direntries[i]);
1029
971
      goto fallback;
1030
972
    }
1031
973
#ifndef O_CLOEXEC
1033
975
    ret = set_cloexec_flag(pipefd[0]);
1034
976
    if(ret < 0){
1035
977
      error(0, errno, "set_cloexec_flag");
1036
 
      close(pipefd[0]);
1037
 
      close(pipefd[1]);
 
978
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
979
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1038
980
      exitstatus = EX_OSERR;
1039
 
      free(direntries[i]);
1040
981
      goto fallback;
1041
982
    }
1042
983
    ret = set_cloexec_flag(pipefd[1]);
1043
984
    if(ret < 0){
1044
985
      error(0, errno, "set_cloexec_flag");
1045
 
      close(pipefd[0]);
1046
 
      close(pipefd[1]);
 
986
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
987
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1047
988
      exitstatus = EX_OSERR;
1048
 
      free(direntries[i]);
1049
989
      goto fallback;
1050
990
    }
1051
991
#endif  /* not O_CLOEXEC */
1056
996
    if(ret < 0){
1057
997
      error(0, errno, "sigprocmask");
1058
998
      exitstatus = EX_OSERR;
1059
 
      free(direntries[i]);
1060
999
      goto fallback;
1061
1000
    }
1062
1001
    /* Starting a new process to be watched */
1068
1007
      error(0, errno, "fork");
1069
1008
      TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1070
1009
                                     &sigchld_action.sa_mask, NULL));
1071
 
      close(pipefd[0]);
1072
 
      close(pipefd[1]);
 
1010
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
1011
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1073
1012
      exitstatus = EX_OSERR;
1074
 
      free(direntries[i]);
1075
1013
      goto fallback;
1076
1014
    }
1077
1015
    if(pid == 0){
1103
1041
      /* no return */
1104
1042
    }
1105
1043
    /* Parent process */
1106
 
    close(pipefd[1]);           /* Close unused write end of pipe */
1107
 
    close(plugin_fd);
 
1044
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
 
1045
                                             pipe */
 
1046
    TEMP_FAILURE_RETRY(close(plugin_fd));
1108
1047
    plugin *new_plugin = getplugin(direntries[i]->d_name);
1109
1048
    if(new_plugin == NULL){
1110
1049
      error(0, errno, "getplugin");
1115
1054
        error(0, errno, "sigprocmask");
1116
1055
      }
1117
1056
      exitstatus = EX_OSERR;
1118
 
      free(direntries[i]);
1119
1057
      goto fallback;
1120
1058
    }
1121
 
    free(direntries[i]);
1122
1059
    
1123
1060
    new_plugin->pid = pid;
1124
1061
    new_plugin->fd = pipefd[0];
1125
 
 
1126
 
    if(debug){
1127
 
      fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
1128
 
              new_plugin->name, (intmax_t) (new_plugin->pid));
1129
 
    }
1130
 
 
 
1062
    
1131
1063
    /* Unblock SIGCHLD so signal handler can be run if this process
1132
1064
       has already completed */
1133
1065
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1139
1071
      goto fallback;
1140
1072
    }
1141
1073
    
1142
 
    FD_SET(new_plugin->fd, &rfds_all);
 
1074
#if defined (__GNUC__) and defined (__GLIBC__)
 
1075
#if not __GLIBC_PREREQ(2, 16)
 
1076
#pragma GCC diagnostic push
 
1077
#pragma GCC diagnostic ignored "-Wsign-conversion"
 
1078
#endif
 
1079
#endif
 
1080
    FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
 
1081
                                          -Wconversion in GNU libc
 
1082
                                          before 2.16 */
 
1083
#if defined (__GNUC__) and defined (__GLIBC__)
 
1084
#if not __GLIBC_PREREQ(2, 16)
 
1085
#pragma GCC diagnostic pop
 
1086
#endif
 
1087
#endif
1143
1088
    
1144
1089
    if(maxfd < new_plugin->fd){
1145
1090
      maxfd = new_plugin->fd;
1148
1093
  
1149
1094
  free(direntries);
1150
1095
  direntries = NULL;
1151
 
  close(dir_fd);
 
1096
  TEMP_FAILURE_RETRY(close(dir_fd));
1152
1097
  dir_fd = -1;
1153
1098
  free_plugin(getplugin(NULL));
1154
1099
  
1194
1139
                      (intmax_t) (proc->pid),
1195
1140
                      WTERMSIG(proc->status),
1196
1141
                      strsignal(WTERMSIG(proc->status)));
 
1142
            } else if(WCOREDUMP(proc->status)){
 
1143
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
1144
                      " core\n", proc->name, (intmax_t) (proc->pid));
1197
1145
            }
1198
1146
          }
1199
1147
          
1200
1148
          /* Remove the plugin */
1201
 
          FD_CLR(proc->fd, &rfds_all);
 
1149
#if defined (__GNUC__) and defined (__GLIBC__)
 
1150
#if not __GLIBC_PREREQ(2, 16)
 
1151
#pragma GCC diagnostic push
 
1152
#pragma GCC diagnostic ignored "-Wsign-conversion"
 
1153
#endif
 
1154
#endif
 
1155
          FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
 
1156
                                          -Wconversion in GNU libc
 
1157
                                          before 2.16 */
 
1158
#if defined (__GNUC__) and defined (__GLIBC__)
 
1159
#if not __GLIBC_PREREQ(2, 16)
 
1160
#pragma GCC diagnostic pop
 
1161
#endif
 
1162
#endif
1202
1163
          
1203
1164
          /* Block signal while modifying process_list */
1204
1165
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1244
1205
      }
1245
1206
      
1246
1207
      /* This process has not completed.  Does it have any output? */
1247
 
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
 
1208
#if defined (__GNUC__) and defined (__GLIBC__)
 
1209
#if not __GLIBC_PREREQ(2, 16)
 
1210
#pragma GCC diagnostic push
 
1211
#pragma GCC diagnostic ignored "-Wsign-conversion"
 
1212
#endif
 
1213
#endif
 
1214
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
 
1215
                                                         warning from
 
1216
                                                         -Wconversion
 
1217
                                                         in GNU libc
 
1218
                                                         before
 
1219
                                                         2.16 */
 
1220
#if defined (__GNUC__) and defined (__GLIBC__)
 
1221
#if not __GLIBC_PREREQ(2, 16)
 
1222
#pragma GCC diagnostic pop
 
1223
#endif
 
1224
#endif
1248
1225
        /* This process had nothing to say at this time */
1249
1226
        proc = proc->next;
1250
1227
        continue;
1320
1297
  free(direntries);
1321
1298
  
1322
1299
  if(dir_fd != -1){
1323
 
    close(dir_fd);
 
1300
    TEMP_FAILURE_RETRY(close(dir_fd));
1324
1301
  }
1325
1302
  
1326
1303
  /* Kill the processes */
1346
1323
  free_plugin_list();
1347
1324
  
1348
1325
  free(plugindir);
1349
 
  free(pluginhelperdir);
1350
1326
  free(argfile);
1351
1327
  
1352
1328
  return exitstatus;