/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: 2019-04-10 20:33:13 UTC
  • Revision ID: teddy@recompile.se-20190410203313-d3ufer20hfws7i3h
Improve language in intro(8mandos) manual page

* intro.xml (INTRODUCTION): Replace "it" with "the data" to fix bad
                            reference, and clarify that it is the
                            client which continues booting.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.c
2
2
/*
3
3
 * Mandos plugin runner - Run Mandos plugins
4
4
 *
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
 
5
 * Copyright © 2008-2018 Teddy Hogeborn
 
6
 * Copyright © 2008-2018 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
14
16
 * WITHOUT ANY WARRANTY; without even the implied warranty of
15
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
18
 * General Public License for more details.
17
19
 * 
18
20
 * You should have received a copy of the GNU General Public License
19
 
 * along with this program.  If not, see
20
 
 * <http://www.gnu.org/licenses/>.
 
21
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
21
22
 * 
22
23
 * Contact the authors at <mandos@recompile.se>.
23
24
 */
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(),
40
 
                                   WEXITSTATUS(), WTERMSIG(),
41
 
                                   WCOREDUMP() */
 
41
                                   WEXITSTATUS(), WTERMSIG() */
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"
79
80
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
80
81
 
81
82
const char *argp_program_version = "plugin-runner " VERSION;
312
313
__attribute__((nonnull))
313
314
static void free_plugin(plugin *plugin_node){
314
315
  
315
 
  for(char **arg = plugin_node->argv; *arg != NULL; arg++){
 
316
  for(char **arg = (plugin_node->argv)+1; *arg != NULL; arg++){
316
317
    free(*arg);
317
318
  }
 
319
  free(plugin_node->name);
318
320
  free(plugin_node->argv);
319
321
  for(char **env = plugin_node->environ; *env != NULL; env++){
320
322
    free(*env);
347
349
 
348
350
int main(int argc, char *argv[]){
349
351
  char *plugindir = NULL;
 
352
  char *pluginhelperdir = NULL;
350
353
  char *argfile = NULL;
351
354
  FILE *conffp;
352
355
  struct dirent **direntries = NULL;
414
417
      .doc = "Group ID the plugins will run as", .group = 3 },
415
418
    { .name = "debug", .key = 132,
416
419
      .doc = "Debug mode", .group = 4 },
 
420
    { .name = "plugin-helper-dir", .key = 133,
 
421
      .arg = "DIRECTORY",
 
422
      .doc = "Specify a different plugin helper directory",
 
423
      .group = 2 },
417
424
    /*
418
425
     * These reproduce what we would get without ARGP_NO_HELP
419
426
     */
545
552
    case 132:                   /* --debug */
546
553
      debug = true;
547
554
      break;
 
555
    case 133:                   /* --plugin-helper-dir */
 
556
      free(pluginhelperdir);
 
557
      pluginhelperdir = strdup(arg);
 
558
      if(pluginhelperdir != NULL){
 
559
        errno = 0;
 
560
      }
 
561
      break;
548
562
      /*
549
563
       * These reproduce what we would get without ARGP_NO_HELP
550
564
       */
551
565
    case '?':                   /* --help */
552
566
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
553
567
      argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
 
568
      __builtin_unreachable();
554
569
    case -3:                    /* --usage */
555
570
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
556
571
      argp_state_help(state, state->out_stream,
557
572
                      ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
 
573
      __builtin_unreachable();
558
574
    case 'V':                   /* --version */
559
575
      fprintf(state->out_stream, "%s\n", argp_program_version);
560
576
      exit(EXIT_SUCCESS);
570
586
      if(arg[0] == '\0'){
571
587
        break;
572
588
      }
 
589
      /* FALLTHROUGH */
573
590
    default:
574
591
      return ARGP_ERR_UNKNOWN;
575
592
    }
601
618
    case 130:                   /* --userid */
602
619
    case 131:                   /* --groupid */
603
620
    case 132:                   /* --debug */
 
621
    case 133:                   /* --plugin-helper-dir */
604
622
    case '?':                   /* --help */
605
623
    case -3:                    /* --usage */
606
624
    case 'V':                   /* --version */
687
705
        custom_argc += 1;
688
706
        {
689
707
          char **new_argv = realloc(custom_argv, sizeof(char *)
690
 
                                    * ((unsigned int)
691
 
                                       custom_argc + 1));
 
708
                                    * ((size_t)custom_argc + 1));
692
709
          if(new_argv == NULL){
693
710
            error(0, errno, "realloc");
694
711
            exitstatus = EX_OSERR;
761
778
    goto fallback;
762
779
  }
763
780
  
 
781
  {
 
782
    char *pluginhelperenv;
 
783
    bool bret = true;
 
784
    ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
 
785
                   pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
 
786
    if(ret != -1){
 
787
      bret = add_environment(getplugin(NULL), pluginhelperenv, true);
 
788
    }
 
789
    if(ret == -1 or not bret){
 
790
      error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
 
791
            " environment variable to \"%s\" for all plugins\n",
 
792
            pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
 
793
    }
 
794
    if(ret != -1){
 
795
      free(pluginhelperenv);
 
796
    }
 
797
  }
 
798
  
764
799
  if(debug){
765
 
    for(plugin *p = plugin_list; p != NULL; p=p->next){
 
800
    for(plugin *p = plugin_list; p != NULL; p = p->next){
766
801
      fprintf(stderr, "Plugin: %s has %d arguments\n",
767
802
              p->name ? p->name : "Global", p->argc - 1);
768
803
      for(char **a = p->argv; *a != NULL; a++){
777
812
  
778
813
  if(getuid() == 0){
779
814
    /* Work around Debian bug #633582:
780
 
       <http://bugs.debian.org/633582> */
 
815
       <https://bugs.debian.org/633582> */
781
816
    int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
782
817
    if(plugindir_fd == -1){
783
818
      if(errno != ENOENT){
795
830
          }
796
831
        }
797
832
      }
798
 
      TEMP_FAILURE_RETRY(close(plugindir_fd));
 
833
      close(plugindir_fd);
799
834
    }
800
835
  }
801
836
  
860
895
    return 1;
861
896
  }
862
897
  
863
 
#ifdef __GLIBC__
864
 
#if __GLIBC_PREREQ(2, 15)
865
898
  int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
866
899
                             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__ */
875
900
  if(numplugins == -1){
876
901
    error(0, errno, "Could not scan plugin dir");
877
902
    direntries = NULL;
887
912
    int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
888
913
    if(plugin_fd == -1){
889
914
      error(0, errno, "Could not open plugin");
 
915
      free(direntries[i]);
890
916
      continue;
891
917
    }
892
918
    ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
893
919
    if(ret == -1){
894
920
      error(0, errno, "stat");
895
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
921
      close(plugin_fd);
 
922
      free(direntries[i]);
896
923
      continue;
897
924
    }
898
925
    
906
933
                plugindir != NULL ? plugindir : PDIR,
907
934
                direntries[i]->d_name);
908
935
      }
909
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
936
      close(plugin_fd);
 
937
      free(direntries[i]);
910
938
      continue;
911
939
    }
912
940
    
913
941
    plugin *p = getplugin(direntries[i]->d_name);
914
942
    if(p == NULL){
915
943
      error(0, errno, "getplugin");
916
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
944
      close(plugin_fd);
 
945
      free(direntries[i]);
917
946
      continue;
918
947
    }
919
948
    if(p->disabled){
921
950
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
922
951
                direntries[i]->d_name);
923
952
      }
924
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
953
      close(plugin_fd);
 
954
      free(direntries[i]);
925
955
      continue;
926
956
    }
927
957
    {
960
990
    if(ret == -1){
961
991
      error(0, errno, "pipe");
962
992
      exitstatus = EX_OSERR;
 
993
      free(direntries[i]);
963
994
      goto fallback;
964
995
    }
965
996
    if(pipefd[0] >= FD_SETSIZE){
966
997
      fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
967
998
              FD_SETSIZE);
968
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
969
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
999
      close(pipefd[0]);
 
1000
      close(pipefd[1]);
970
1001
      exitstatus = EX_OSERR;
 
1002
      free(direntries[i]);
971
1003
      goto fallback;
972
1004
    }
973
1005
#ifndef O_CLOEXEC
975
1007
    ret = set_cloexec_flag(pipefd[0]);
976
1008
    if(ret < 0){
977
1009
      error(0, errno, "set_cloexec_flag");
978
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
979
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
1010
      close(pipefd[0]);
 
1011
      close(pipefd[1]);
980
1012
      exitstatus = EX_OSERR;
 
1013
      free(direntries[i]);
981
1014
      goto fallback;
982
1015
    }
983
1016
    ret = set_cloexec_flag(pipefd[1]);
984
1017
    if(ret < 0){
985
1018
      error(0, errno, "set_cloexec_flag");
986
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
987
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
1019
      close(pipefd[0]);
 
1020
      close(pipefd[1]);
988
1021
      exitstatus = EX_OSERR;
 
1022
      free(direntries[i]);
989
1023
      goto fallback;
990
1024
    }
991
1025
#endif  /* not O_CLOEXEC */
996
1030
    if(ret < 0){
997
1031
      error(0, errno, "sigprocmask");
998
1032
      exitstatus = EX_OSERR;
 
1033
      free(direntries[i]);
999
1034
      goto fallback;
1000
1035
    }
1001
1036
    /* Starting a new process to be watched */
1007
1042
      error(0, errno, "fork");
1008
1043
      TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1009
1044
                                     &sigchld_action.sa_mask, NULL));
1010
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
1011
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
1045
      close(pipefd[0]);
 
1046
      close(pipefd[1]);
1012
1047
      exitstatus = EX_OSERR;
 
1048
      free(direntries[i]);
1013
1049
      goto fallback;
1014
1050
    }
1015
1051
    if(pid == 0){
1041
1077
      /* no return */
1042
1078
    }
1043
1079
    /* Parent process */
1044
 
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
1045
 
                                             pipe */
1046
 
    TEMP_FAILURE_RETRY(close(plugin_fd));
 
1080
    close(pipefd[1]);           /* Close unused write end of pipe */
 
1081
    close(plugin_fd);
1047
1082
    plugin *new_plugin = getplugin(direntries[i]->d_name);
1048
1083
    if(new_plugin == NULL){
1049
1084
      error(0, errno, "getplugin");
1054
1089
        error(0, errno, "sigprocmask");
1055
1090
      }
1056
1091
      exitstatus = EX_OSERR;
 
1092
      free(direntries[i]);
1057
1093
      goto fallback;
1058
1094
    }
 
1095
    free(direntries[i]);
1059
1096
    
1060
1097
    new_plugin->pid = pid;
1061
1098
    new_plugin->fd = pipefd[0];
1062
 
    
 
1099
 
 
1100
    if(debug){
 
1101
      fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
 
1102
              new_plugin->name, (intmax_t) (new_plugin->pid));
 
1103
    }
 
1104
 
1063
1105
    /* Unblock SIGCHLD so signal handler can be run if this process
1064
1106
       has already completed */
1065
1107
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1071
1113
      goto fallback;
1072
1114
    }
1073
1115
    
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
 
1116
    FD_SET(new_plugin->fd, &rfds_all);
1088
1117
    
1089
1118
    if(maxfd < new_plugin->fd){
1090
1119
      maxfd = new_plugin->fd;
1093
1122
  
1094
1123
  free(direntries);
1095
1124
  direntries = NULL;
1096
 
  TEMP_FAILURE_RETRY(close(dir_fd));
 
1125
  close(dir_fd);
1097
1126
  dir_fd = -1;
1098
1127
  free_plugin(getplugin(NULL));
1099
1128
  
1139
1168
                      (intmax_t) (proc->pid),
1140
1169
                      WTERMSIG(proc->status),
1141
1170
                      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));
1145
1171
            }
1146
1172
          }
1147
1173
          
1148
1174
          /* Remove the plugin */
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
 
1175
          FD_CLR(proc->fd, &rfds_all);
1163
1176
          
1164
1177
          /* Block signal while modifying process_list */
1165
1178
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1205
1218
      }
1206
1219
      
1207
1220
      /* This process has not completed.  Does it have any output? */
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
 
1221
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1225
1222
        /* This process had nothing to say at this time */
1226
1223
        proc = proc->next;
1227
1224
        continue;
1297
1294
  free(direntries);
1298
1295
  
1299
1296
  if(dir_fd != -1){
1300
 
    TEMP_FAILURE_RETRY(close(dir_fd));
 
1297
    close(dir_fd);
1301
1298
  }
1302
1299
  
1303
1300
  /* Kill the processes */
1323
1320
  free_plugin_list();
1324
1321
  
1325
1322
  free(plugindir);
 
1323
  free(pluginhelperdir);
1326
1324
  free(argfile);
1327
1325
  
1328
1326
  return exitstatus;