/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-06-14 23:43:07 UTC
  • Revision ID: teddy@recompile.se-20140614234307-i0mh9r2n4orkqtki
plugin-runner: Release memory and close FD's correctly in all cases.

* plugins.d/mandos-client.c (main): Init "direntries" to NULL.  Close
                                    "dir_fd" at fallback label.  Do
                                    not free "direntries" if
                                    scandirat() or scandir() failed.
                                    Do free(direntries) at fallback
                                    label.

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-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() */
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;
313
312
__attribute__((nonnull))
314
313
static void free_plugin(plugin *plugin_node){
315
314
  
316
 
  for(char **arg = (plugin_node->argv)+1; *arg != NULL; arg++){
 
315
  for(char **arg = plugin_node->argv; *arg != NULL; arg++){
317
316
    free(*arg);
318
317
  }
319
 
  free(plugin_node->name);
320
318
  free(plugin_node->argv);
321
319
  for(char **env = plugin_node->environ; *env != NULL; env++){
322
320
    free(*env);
349
347
 
350
348
int main(int argc, char *argv[]){
351
349
  char *plugindir = NULL;
352
 
  char *pluginhelperdir = NULL;
353
350
  char *argfile = NULL;
354
351
  FILE *conffp;
355
352
  struct dirent **direntries = NULL;
417
414
      .doc = "Group ID the plugins will run as", .group = 3 },
418
415
    { .name = "debug", .key = 132,
419
416
      .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 },
424
417
    /*
425
418
     * These reproduce what we would get without ARGP_NO_HELP
426
419
     */
552
545
    case 132:                   /* --debug */
553
546
      debug = true;
554
547
      break;
555
 
    case 133:                   /* --plugin-helper-dir */
556
 
      free(pluginhelperdir);
557
 
      pluginhelperdir = strdup(arg);
558
 
      if(pluginhelperdir != NULL){
559
 
        errno = 0;
560
 
      }
561
 
      break;
562
548
      /*
563
549
       * These reproduce what we would get without ARGP_NO_HELP
564
550
       */
565
551
    case '?':                   /* --help */
566
552
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
567
553
      argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
568
 
      __builtin_unreachable();
569
554
    case -3:                    /* --usage */
570
555
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
571
556
      argp_state_help(state, state->out_stream,
572
557
                      ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
573
 
      __builtin_unreachable();
574
558
    case 'V':                   /* --version */
575
559
      fprintf(state->out_stream, "%s\n", argp_program_version);
576
560
      exit(EXIT_SUCCESS);
586
570
      if(arg[0] == '\0'){
587
571
        break;
588
572
      }
589
 
#if __GNUC__ >= 7
590
 
      __attribute__((fallthrough));
591
 
#else
592
 
          /* FALLTHROUGH */
593
 
#endif
594
573
    default:
595
574
      return ARGP_ERR_UNKNOWN;
596
575
    }
622
601
    case 130:                   /* --userid */
623
602
    case 131:                   /* --groupid */
624
603
    case 132:                   /* --debug */
625
 
    case 133:                   /* --plugin-helper-dir */
626
604
    case '?':                   /* --help */
627
605
    case -3:                    /* --usage */
628
606
    case 'V':                   /* --version */
709
687
        custom_argc += 1;
710
688
        {
711
689
          char **new_argv = realloc(custom_argv, sizeof(char *)
712
 
                                    * ((size_t)custom_argc + 1));
 
690
                                    * ((unsigned int)
 
691
                                       custom_argc + 1));
713
692
          if(new_argv == NULL){
714
693
            error(0, errno, "realloc");
715
694
            exitstatus = EX_OSERR;
782
761
    goto fallback;
783
762
  }
784
763
  
785
 
  {
786
 
    char *pluginhelperenv;
787
 
    bool bret = true;
788
 
    ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
789
 
                   pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
790
 
    if(ret != -1){
791
 
      bret = add_environment(getplugin(NULL), pluginhelperenv, true);
792
 
    }
793
 
    if(ret == -1 or not bret){
794
 
      error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
795
 
            " environment variable to \"%s\" for all plugins\n",
796
 
            pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
797
 
    }
798
 
    if(ret != -1){
799
 
      free(pluginhelperenv);
800
 
    }
801
 
  }
802
 
  
803
764
  if(debug){
804
 
    for(plugin *p = plugin_list; p != NULL; p = p->next){
 
765
    for(plugin *p = plugin_list; p != NULL; p=p->next){
805
766
      fprintf(stderr, "Plugin: %s has %d arguments\n",
806
767
              p->name ? p->name : "Global", p->argc - 1);
807
768
      for(char **a = p->argv; *a != NULL; a++){
816
777
  
817
778
  if(getuid() == 0){
818
779
    /* Work around Debian bug #633582:
819
 
       <https://bugs.debian.org/633582> */
 
780
       <http://bugs.debian.org/633582> */
820
781
    int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
821
782
    if(plugindir_fd == -1){
822
783
      if(errno != ENOENT){
834
795
          }
835
796
        }
836
797
      }
837
 
      close(plugindir_fd);
 
798
      TEMP_FAILURE_RETRY(close(plugindir_fd));
838
799
    }
839
800
  }
840
801
  
899
860
    return 1;
900
861
  }
901
862
  
 
863
#ifdef __GLIBC__
 
864
#if __GLIBC_PREREQ(2, 15)
902
865
  int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
903
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__ */
904
875
  if(numplugins == -1){
905
876
    error(0, errno, "Could not scan plugin dir");
906
877
    direntries = NULL;
916
887
    int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
917
888
    if(plugin_fd == -1){
918
889
      error(0, errno, "Could not open plugin");
919
 
      free(direntries[i]);
920
890
      continue;
921
891
    }
922
892
    ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
923
893
    if(ret == -1){
924
894
      error(0, errno, "stat");
925
 
      close(plugin_fd);
926
 
      free(direntries[i]);
 
895
      TEMP_FAILURE_RETRY(close(plugin_fd));
927
896
      continue;
928
897
    }
929
898
    
937
906
                plugindir != NULL ? plugindir : PDIR,
938
907
                direntries[i]->d_name);
939
908
      }
940
 
      close(plugin_fd);
941
 
      free(direntries[i]);
 
909
      TEMP_FAILURE_RETRY(close(plugin_fd));
942
910
      continue;
943
911
    }
944
912
    
945
913
    plugin *p = getplugin(direntries[i]->d_name);
946
914
    if(p == NULL){
947
915
      error(0, errno, "getplugin");
948
 
      close(plugin_fd);
949
 
      free(direntries[i]);
 
916
      TEMP_FAILURE_RETRY(close(plugin_fd));
950
917
      continue;
951
918
    }
952
919
    if(p->disabled){
954
921
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
955
922
                direntries[i]->d_name);
956
923
      }
957
 
      close(plugin_fd);
958
 
      free(direntries[i]);
 
924
      TEMP_FAILURE_RETRY(close(plugin_fd));
959
925
      continue;
960
926
    }
961
927
    {
994
960
    if(ret == -1){
995
961
      error(0, errno, "pipe");
996
962
      exitstatus = EX_OSERR;
997
 
      free(direntries[i]);
998
963
      goto fallback;
999
964
    }
1000
965
    if(pipefd[0] >= FD_SETSIZE){
1001
966
      fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
1002
967
              FD_SETSIZE);
1003
 
      close(pipefd[0]);
1004
 
      close(pipefd[1]);
 
968
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
969
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1005
970
      exitstatus = EX_OSERR;
1006
 
      free(direntries[i]);
1007
971
      goto fallback;
1008
972
    }
1009
973
#ifndef O_CLOEXEC
1011
975
    ret = set_cloexec_flag(pipefd[0]);
1012
976
    if(ret < 0){
1013
977
      error(0, errno, "set_cloexec_flag");
1014
 
      close(pipefd[0]);
1015
 
      close(pipefd[1]);
 
978
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
979
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1016
980
      exitstatus = EX_OSERR;
1017
 
      free(direntries[i]);
1018
981
      goto fallback;
1019
982
    }
1020
983
    ret = set_cloexec_flag(pipefd[1]);
1021
984
    if(ret < 0){
1022
985
      error(0, errno, "set_cloexec_flag");
1023
 
      close(pipefd[0]);
1024
 
      close(pipefd[1]);
 
986
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
987
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1025
988
      exitstatus = EX_OSERR;
1026
 
      free(direntries[i]);
1027
989
      goto fallback;
1028
990
    }
1029
991
#endif  /* not O_CLOEXEC */
1034
996
    if(ret < 0){
1035
997
      error(0, errno, "sigprocmask");
1036
998
      exitstatus = EX_OSERR;
1037
 
      free(direntries[i]);
1038
999
      goto fallback;
1039
1000
    }
1040
1001
    /* Starting a new process to be watched */
1046
1007
      error(0, errno, "fork");
1047
1008
      TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1048
1009
                                     &sigchld_action.sa_mask, NULL));
1049
 
      close(pipefd[0]);
1050
 
      close(pipefd[1]);
 
1010
      TEMP_FAILURE_RETRY(close(pipefd[0]));
 
1011
      TEMP_FAILURE_RETRY(close(pipefd[1]));
1051
1012
      exitstatus = EX_OSERR;
1052
 
      free(direntries[i]);
1053
1013
      goto fallback;
1054
1014
    }
1055
1015
    if(pid == 0){
1081
1041
      /* no return */
1082
1042
    }
1083
1043
    /* Parent process */
1084
 
    close(pipefd[1]);           /* Close unused write end of pipe */
1085
 
    close(plugin_fd);
 
1044
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
 
1045
                                             pipe */
 
1046
    TEMP_FAILURE_RETRY(close(plugin_fd));
1086
1047
    plugin *new_plugin = getplugin(direntries[i]->d_name);
1087
1048
    if(new_plugin == NULL){
1088
1049
      error(0, errno, "getplugin");
1093
1054
        error(0, errno, "sigprocmask");
1094
1055
      }
1095
1056
      exitstatus = EX_OSERR;
1096
 
      free(direntries[i]);
1097
1057
      goto fallback;
1098
1058
    }
1099
 
    free(direntries[i]);
1100
1059
    
1101
1060
    new_plugin->pid = pid;
1102
1061
    new_plugin->fd = pipefd[0];
1103
 
 
1104
 
    if(debug){
1105
 
      fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
1106
 
              new_plugin->name, (intmax_t) (new_plugin->pid));
1107
 
    }
1108
 
 
 
1062
    
1109
1063
    /* Unblock SIGCHLD so signal handler can be run if this process
1110
1064
       has already completed */
1111
1065
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1117
1071
      goto fallback;
1118
1072
    }
1119
1073
    
1120
 
    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
1121
1088
    
1122
1089
    if(maxfd < new_plugin->fd){
1123
1090
      maxfd = new_plugin->fd;
1126
1093
  
1127
1094
  free(direntries);
1128
1095
  direntries = NULL;
1129
 
  close(dir_fd);
 
1096
  TEMP_FAILURE_RETRY(close(dir_fd));
1130
1097
  dir_fd = -1;
1131
1098
  free_plugin(getplugin(NULL));
1132
1099
  
1172
1139
                      (intmax_t) (proc->pid),
1173
1140
                      WTERMSIG(proc->status),
1174
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));
1175
1145
            }
1176
1146
          }
1177
1147
          
1178
1148
          /* Remove the plugin */
1179
 
          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
1180
1163
          
1181
1164
          /* Block signal while modifying process_list */
1182
1165
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1222
1205
      }
1223
1206
      
1224
1207
      /* This process has not completed.  Does it have any output? */
1225
 
      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
1226
1225
        /* This process had nothing to say at this time */
1227
1226
        proc = proc->next;
1228
1227
        continue;
1298
1297
  free(direntries);
1299
1298
  
1300
1299
  if(dir_fd != -1){
1301
 
    close(dir_fd);
 
1300
    TEMP_FAILURE_RETRY(close(dir_fd));
1302
1301
  }
1303
1302
  
1304
1303
  /* Kill the processes */
1324
1323
  free_plugin_list();
1325
1324
  
1326
1325
  free(plugindir);
1327
 
  free(pluginhelperdir);
1328
1326
  free(argfile);
1329
1327
  
1330
1328
  return exitstatus;