/mandos/release

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

« back to all changes in this revision

Viewing changes to plugin-runner.c

  • Committer: Teddy Hogeborn
  • Date: 2015-06-28 16:35:27 UTC
  • mto: (237.7.307 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

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-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
 
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
 */
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() */
313
313
__attribute__((nonnull))
314
314
static void free_plugin(plugin *plugin_node){
315
315
  
316
 
  for(char **arg = (plugin_node->argv)+1; *arg != NULL; arg++){
 
316
  for(char **arg = plugin_node->argv; *arg != NULL; arg++){
317
317
    free(*arg);
318
318
  }
319
 
  free(plugin_node->name);
320
319
  free(plugin_node->argv);
321
320
  for(char **env = plugin_node->environ; *env != NULL; env++){
322
321
    free(*env);
565
564
    case '?':                   /* --help */
566
565
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
567
566
      argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
568
 
      __builtin_unreachable();
569
567
    case -3:                    /* --usage */
570
568
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
571
569
      argp_state_help(state, state->out_stream,
572
570
                      ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
573
 
      __builtin_unreachable();
574
571
    case 'V':                   /* --version */
575
572
      fprintf(state->out_stream, "%s\n", argp_program_version);
576
573
      exit(EXIT_SUCCESS);
586
583
      if(arg[0] == '\0'){
587
584
        break;
588
585
      }
589
 
      /* FALLTHROUGH */
590
586
    default:
591
587
      return ARGP_ERR_UNKNOWN;
592
588
    }
705
701
        custom_argc += 1;
706
702
        {
707
703
          char **new_argv = realloc(custom_argv, sizeof(char *)
708
 
                                    * ((size_t)custom_argc + 1));
 
704
                                    * ((unsigned int)
 
705
                                       custom_argc + 1));
709
706
          if(new_argv == NULL){
710
707
            error(0, errno, "realloc");
711
708
            exitstatus = EX_OSERR;
797
794
  }
798
795
  
799
796
  if(debug){
800
 
    for(plugin *p = plugin_list; p != NULL; p = p->next){
 
797
    for(plugin *p = plugin_list; p != NULL; p=p->next){
801
798
      fprintf(stderr, "Plugin: %s has %d arguments\n",
802
799
              p->name ? p->name : "Global", p->argc - 1);
803
800
      for(char **a = p->argv; *a != NULL; a++){
812
809
  
813
810
  if(getuid() == 0){
814
811
    /* Work around Debian bug #633582:
815
 
       <https://bugs.debian.org/633582> */
 
812
       <http://bugs.debian.org/633582> */
816
813
    int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
817
814
    if(plugindir_fd == -1){
818
815
      if(errno != ENOENT){
830
827
          }
831
828
        }
832
829
      }
833
 
      close(plugindir_fd);
 
830
      TEMP_FAILURE_RETRY(close(plugindir_fd));
834
831
    }
835
832
  }
836
833
  
895
892
    return 1;
896
893
  }
897
894
  
 
895
#ifdef __GLIBC__
 
896
#if __GLIBC_PREREQ(2, 15)
898
897
  int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
899
898
                             alphasort);
 
899
#else  /* not __GLIBC_PREREQ(2, 15) */
 
900
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
 
901
                           &direntries, good_name, alphasort);
 
902
#endif  /* not __GLIBC_PREREQ(2, 15) */
 
903
#else   /* not __GLIBC__ */
 
904
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
 
905
                           &direntries, good_name, alphasort);
 
906
#endif  /* not __GLIBC__ */
900
907
  if(numplugins == -1){
901
908
    error(0, errno, "Could not scan plugin dir");
902
909
    direntries = NULL;
918
925
    ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
919
926
    if(ret == -1){
920
927
      error(0, errno, "stat");
921
 
      close(plugin_fd);
 
928
      TEMP_FAILURE_RETRY(close(plugin_fd));
922
929
      free(direntries[i]);
923
930
      continue;
924
931
    }
933
940
                plugindir != NULL ? plugindir : PDIR,
934
941
                direntries[i]->d_name);
935
942
      }
936
 
      close(plugin_fd);
 
943
      TEMP_FAILURE_RETRY(close(plugin_fd));
937
944
      free(direntries[i]);
938
945
      continue;
939
946
    }
941
948
    plugin *p = getplugin(direntries[i]->d_name);
942
949
    if(p == NULL){
943
950
      error(0, errno, "getplugin");
944
 
      close(plugin_fd);
 
951
      TEMP_FAILURE_RETRY(close(plugin_fd));
945
952
      free(direntries[i]);
946
953
      continue;
947
954
    }
950
957
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
951
958
                direntries[i]->d_name);
952
959
      }
953
 
      close(plugin_fd);
 
960
      TEMP_FAILURE_RETRY(close(plugin_fd));
954
961
      free(direntries[i]);
955
962
      continue;
956
963
    }
996
1003
    if(pipefd[0] >= FD_SETSIZE){
997
1004
      fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
998
1005
              FD_SETSIZE);
999
 
      close(pipefd[0]);
1000
 
      close(pipefd[1]);
 
1006
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
1007
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1001
1008
      exitstatus = EX_OSERR;
1002
1009
      free(direntries[i]);
1003
1010
      goto fallback;
1007
1014
    ret = set_cloexec_flag(pipefd[0]);
1008
1015
    if(ret < 0){
1009
1016
      error(0, errno, "set_cloexec_flag");
1010
 
      close(pipefd[0]);
1011
 
      close(pipefd[1]);
 
1017
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
1018
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1012
1019
      exitstatus = EX_OSERR;
1013
1020
      free(direntries[i]);
1014
1021
      goto fallback;
1016
1023
    ret = set_cloexec_flag(pipefd[1]);
1017
1024
    if(ret < 0){
1018
1025
      error(0, errno, "set_cloexec_flag");
1019
 
      close(pipefd[0]);
1020
 
      close(pipefd[1]);
 
1026
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
1027
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1021
1028
      exitstatus = EX_OSERR;
1022
1029
      free(direntries[i]);
1023
1030
      goto fallback;
1042
1049
      error(0, errno, "fork");
1043
1050
      TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1044
1051
                                     &sigchld_action.sa_mask, NULL));
1045
 
      close(pipefd[0]);
1046
 
      close(pipefd[1]);
 
1052
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
1053
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1047
1054
      exitstatus = EX_OSERR;
1048
1055
      free(direntries[i]);
1049
1056
      goto fallback;
1077
1084
      /* no return */
1078
1085
    }
1079
1086
    /* Parent process */
1080
 
    close(pipefd[1]);           /* Close unused write end of pipe */
1081
 
    close(plugin_fd);
 
1087
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
 
1088
                                             pipe */
 
1089
    TEMP_FAILURE_RETRY(close(plugin_fd));
1082
1090
    plugin *new_plugin = getplugin(direntries[i]->d_name);
1083
1091
    if(new_plugin == NULL){
1084
1092
      error(0, errno, "getplugin");
1096
1104
    
1097
1105
    new_plugin->pid = pid;
1098
1106
    new_plugin->fd = pipefd[0];
1099
 
 
1100
 
    if(debug){
1101
 
      fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
1102
 
              new_plugin->name, (intmax_t) (new_plugin->pid));
1103
 
    }
1104
 
 
 
1107
    
1105
1108
    /* Unblock SIGCHLD so signal handler can be run if this process
1106
1109
       has already completed */
1107
1110
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1113
1116
      goto fallback;
1114
1117
    }
1115
1118
    
1116
 
    FD_SET(new_plugin->fd, &rfds_all);
 
1119
#if defined (__GNUC__) and defined (__GLIBC__)
 
1120
#if not __GLIBC_PREREQ(2, 16)
 
1121
#pragma GCC diagnostic push
 
1122
#pragma GCC diagnostic ignored "-Wsign-conversion"
 
1123
#endif
 
1124
#endif
 
1125
    FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
 
1126
                                          -Wconversion in GNU libc
 
1127
                                          before 2.16 */
 
1128
#if defined (__GNUC__) and defined (__GLIBC__)
 
1129
#if not __GLIBC_PREREQ(2, 16)
 
1130
#pragma GCC diagnostic pop
 
1131
#endif
 
1132
#endif
1117
1133
    
1118
1134
    if(maxfd < new_plugin->fd){
1119
1135
      maxfd = new_plugin->fd;
1122
1138
  
1123
1139
  free(direntries);
1124
1140
  direntries = NULL;
1125
 
  close(dir_fd);
 
1141
  TEMP_FAILURE_RETRY(close(dir_fd));
1126
1142
  dir_fd = -1;
1127
1143
  free_plugin(getplugin(NULL));
1128
1144
  
1168
1184
                      (intmax_t) (proc->pid),
1169
1185
                      WTERMSIG(proc->status),
1170
1186
                      strsignal(WTERMSIG(proc->status)));
 
1187
            } else if(WCOREDUMP(proc->status)){
 
1188
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
1189
                      " core\n", proc->name, (intmax_t) (proc->pid));
1171
1190
            }
1172
1191
          }
1173
1192
          
1174
1193
          /* Remove the plugin */
1175
 
          FD_CLR(proc->fd, &rfds_all);
 
1194
#if defined (__GNUC__) and defined (__GLIBC__)
 
1195
#if not __GLIBC_PREREQ(2, 16)
 
1196
#pragma GCC diagnostic push
 
1197
#pragma GCC diagnostic ignored "-Wsign-conversion"
 
1198
#endif
 
1199
#endif
 
1200
          FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
 
1201
                                          -Wconversion in GNU libc
 
1202
                                          before 2.16 */
 
1203
#if defined (__GNUC__) and defined (__GLIBC__)
 
1204
#if not __GLIBC_PREREQ(2, 16)
 
1205
#pragma GCC diagnostic pop
 
1206
#endif
 
1207
#endif
1176
1208
          
1177
1209
          /* Block signal while modifying process_list */
1178
1210
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1218
1250
      }
1219
1251
      
1220
1252
      /* This process has not completed.  Does it have any output? */
1221
 
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
 
1253
#if defined (__GNUC__) and defined (__GLIBC__)
 
1254
#if not __GLIBC_PREREQ(2, 16)
 
1255
#pragma GCC diagnostic push
 
1256
#pragma GCC diagnostic ignored "-Wsign-conversion"
 
1257
#endif
 
1258
#endif
 
1259
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
 
1260
                                                         warning from
 
1261
                                                         -Wconversion
 
1262
                                                         in GNU libc
 
1263
                                                         before
 
1264
                                                         2.16 */
 
1265
#if defined (__GNUC__) and defined (__GLIBC__)
 
1266
#if not __GLIBC_PREREQ(2, 16)
 
1267
#pragma GCC diagnostic pop
 
1268
#endif
 
1269
#endif
1222
1270
        /* This process had nothing to say at this time */
1223
1271
        proc = proc->next;
1224
1272
        continue;
1294
1342
  free(direntries);
1295
1343
  
1296
1344
  if(dir_fd != -1){
1297
 
    close(dir_fd);
 
1345
    TEMP_FAILURE_RETRY(close(dir_fd));
1298
1346
  }
1299
1347
  
1300
1348
  /* Kill the processes */