/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-03-23 22:12:57 UTC
  • Revision ID: teddy@recompile.se-20140323221257-9lkufevfdn4kwoq6
Use openat() etc. in plugin-runner.  Also one less useless warning.

* plugin-runner.c (main): Only print warning about failure to work
                          around Debian bug #633582 if the plugin
                          directory actually exists.  Use openat(),
                          fstat(), faccessat(), and eliminate
                          asprintf().

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-2015 Teddy Hogeborn
6
 
 * Copyright © 2008-2015 Björn Påhlsson
 
5
 * Copyright © 2008-2013 Teddy Hogeborn
 
6
 * Copyright © 2008-2013 Björn Påhlsson
7
7
 * 
8
8
 * This program is free software: you can redistribute it and/or
9
9
 * modify it under the terms of the GNU General Public License as
23
23
 */
24
24
 
25
25
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY(), getline(),
26
 
                                   O_CLOEXEC, pipe2() */
 
26
                                   O_CLOEXEC */
27
27
#include <stddef.h>             /* size_t, NULL */
28
28
#include <stdlib.h>             /* malloc(), exit(), EXIT_SUCCESS,
29
29
                                   realloc() */
30
30
#include <stdbool.h>            /* bool, true, false */
31
31
#include <stdio.h>              /* fileno(), fprintf(),
32
32
                                   stderr, STDOUT_FILENO, fclose() */
33
 
#include <sys/types.h>          /* fstat(), struct stat, waitpid(),
34
 
                                   WIFEXITED(), WEXITSTATUS(), wait(),
35
 
                                   pid_t, uid_t, gid_t, getuid(),
36
 
                                   getgid() */
 
33
#include <sys/types.h>          /* DIR, fdopendir(), fstat(), struct
 
34
                                   stat, waitpid(), WIFEXITED(),
 
35
                                   WEXITSTATUS(), wait(), pid_t,
 
36
                                   uid_t, gid_t, getuid(), getgid(),
 
37
                                   dirfd() */
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
42
                                   WCOREDUMP() */
42
43
#include <sys/stat.h>           /* struct stat, fstat(), S_ISREG() */
43
44
#include <iso646.h>             /* and, or, not */
44
 
#include <dirent.h>             /* struct dirent, scandirat() */
 
45
#include <dirent.h>             /* DIR, struct dirent, fdopendir(),
 
46
                                   readdir(), closedir(), dirfd() */
45
47
#include <unistd.h>             /* fcntl(), F_GETFD, F_SETFD,
46
48
                                   FD_CLOEXEC, write(), STDOUT_FILENO,
47
49
                                   struct stat, fstat(), close(),
48
50
                                   setgid(), setuid(), S_ISREG(),
49
 
                                   faccessat() pipe2(), fork(),
 
51
                                   faccessat() pipe(), fork(),
50
52
                                   _exit(), dup2(), fexecve(), read()
51
53
                                */
52
54
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
53
 
                                   FD_CLOEXEC, openat(), scandirat(),
54
 
                                   pipe2() */
 
55
                                   FD_CLOEXEC, openat() */
55
56
#include <string.h>             /* strsep, strlen(), strsignal(),
56
57
                                   strcmp(), strncmp() */
57
58
#include <errno.h>              /* errno */
71
72
                                   EX_CONFIG, EX_UNAVAILABLE, EX_OK */
72
73
#include <errno.h>              /* errno */
73
74
#include <error.h>              /* error() */
74
 
#include <fnmatch.h>            /* fnmatch() */
75
75
 
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;
241
240
  return add_to_char_array(def, &(p->environ), &(p->envc));
242
241
}
243
242
 
244
 
#ifndef O_CLOEXEC
245
243
/*
246
244
 * Based on the example in the GNU LibC manual chapter 13.13 "File
247
245
 * Descriptor Flags".
258
256
  return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
259
257
                                       ret | FD_CLOEXEC));
260
258
}
261
 
#endif  /* not O_CLOEXEC */
262
259
 
263
260
 
264
261
/* Mark processes as completed when they exit, and save their exit
348
345
 
349
346
int main(int argc, char *argv[]){
350
347
  char *plugindir = NULL;
351
 
  char *pluginhelperdir = NULL;
352
348
  char *argfile = NULL;
353
349
  FILE *conffp;
354
 
  struct dirent **direntries = NULL;
 
350
  size_t d_name_len;
 
351
  DIR *dir = NULL;
 
352
  struct dirent *dirst;
355
353
  struct stat st;
356
354
  fd_set rfds_all;
357
355
  int ret, maxfd = 0;
365
363
                                      .sa_flags = SA_NOCLDSTOP };
366
364
  char **custom_argv = NULL;
367
365
  int custom_argc = 0;
368
 
  int dir_fd = -1;
 
366
  int dir_fd;
369
367
  
370
368
  /* Establish a signal handler */
371
369
  sigemptyset(&sigchld_action.sa_mask);
416
414
      .doc = "Group ID the plugins will run as", .group = 3 },
417
415
    { .name = "debug", .key = 132,
418
416
      .doc = "Debug mode", .group = 4 },
419
 
    { .name = "plugin-helper-dir", .key = 133,
420
 
      .arg = "DIRECTORY",
421
 
      .doc = "Specify a different plugin helper directory",
422
 
      .group = 2 },
423
417
    /*
424
418
     * These reproduce what we would get without ARGP_NO_HELP
425
419
     */
551
545
    case 132:                   /* --debug */
552
546
      debug = true;
553
547
      break;
554
 
    case 133:                   /* --plugin-helper-dir */
555
 
      free(pluginhelperdir);
556
 
      pluginhelperdir = strdup(arg);
557
 
      if(pluginhelperdir != NULL){
558
 
        errno = 0;
559
 
      }
560
 
      break;
561
548
      /*
562
549
       * These reproduce what we would get without ARGP_NO_HELP
563
550
       */
614
601
    case 130:                   /* --userid */
615
602
    case 131:                   /* --groupid */
616
603
    case 132:                   /* --debug */
617
 
    case 133:                   /* --plugin-helper-dir */
618
604
    case '?':                   /* --help */
619
605
    case -3:                    /* --usage */
620
606
    case 'V':                   /* --version */
701
687
        custom_argc += 1;
702
688
        {
703
689
          char **new_argv = realloc(custom_argv, sizeof(char *)
704
 
                                    * ((size_t)custom_argc + 1));
 
690
                                    * ((unsigned int)
 
691
                                       custom_argc + 1));
705
692
          if(new_argv == NULL){
706
693
            error(0, errno, "realloc");
707
694
            exitstatus = EX_OSERR;
774
761
    goto fallback;
775
762
  }
776
763
  
777
 
  {
778
 
    char *pluginhelperenv;
779
 
    bool bret = true;
780
 
    ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
781
 
                   pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
782
 
    if(ret != -1){
783
 
      bret = add_environment(getplugin(NULL), pluginhelperenv, true);
784
 
    }
785
 
    if(ret == -1 or not bret){
786
 
      error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
787
 
            " environment variable to \"%s\" for all plugins\n",
788
 
            pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
789
 
    }
790
 
    if(ret != -1){
791
 
      free(pluginhelperenv);
792
 
    }
793
 
  }
794
 
  
795
764
  if(debug){
796
765
    for(plugin *p = plugin_list; p != NULL; p=p->next){
797
766
      fprintf(stderr, "Plugin: %s has %d arguments\n",
826
795
          }
827
796
        }
828
797
      }
829
 
      close(plugindir_fd);
 
798
      TEMP_FAILURE_RETRY(close(plugindir_fd));
830
799
    }
831
800
  }
832
801
  
860
829
    ret = set_cloexec_flag(dir_fd);
861
830
    if(ret < 0){
862
831
      error(0, errno, "set_cloexec_flag");
 
832
      TEMP_FAILURE_RETRY(close(dir_fd));
863
833
      exitstatus = EX_OSERR;
864
834
      goto fallback;
865
835
    }
866
836
#endif  /* O_CLOEXEC */
867
 
  }
868
 
  
869
 
  int good_name(const struct dirent * const dirent){
870
 
    const char * const patterns[] = { ".*", "#*#", "*~", "*.dpkg-new",
871
 
                                      "*.dpkg-old", "*.dpkg-bak",
872
 
                                      "*.dpkg-divert", NULL };
873
 
#ifdef __GNUC__
874
 
#pragma GCC diagnostic push
875
 
#pragma GCC diagnostic ignored "-Wcast-qual"
876
 
#endif
877
 
    for(const char **pat = (const char **)patterns;
878
 
        *pat != NULL; pat++){
879
 
#ifdef __GNUC__
880
 
#pragma GCC diagnostic pop
881
 
#endif
882
 
      if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
883
 
         != FNM_NOMATCH){
884
 
        if(debug){
885
 
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
886
 
                    " matching pattern %s\n", dirent->d_name, *pat);
887
 
        }
888
 
        return 0;
889
 
      }
 
837
    
 
838
    dir = fdopendir(dir_fd);
 
839
    if(dir == NULL){
 
840
      error(0, errno, "Could not open plugin dir");
 
841
      TEMP_FAILURE_RETRY(close(dir_fd));
 
842
      exitstatus = EX_OSERR;
 
843
      goto fallback;
890
844
    }
891
 
    return 1;
892
 
  }
893
 
  
894
 
#ifdef __GLIBC__
895
 
#if __GLIBC_PREREQ(2, 15)
896
 
  int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
897
 
                             alphasort);
898
 
#else  /* not __GLIBC_PREREQ(2, 15) */
899
 
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
900
 
                           &direntries, good_name, alphasort);
901
 
#endif  /* not __GLIBC_PREREQ(2, 15) */
902
 
#else   /* not __GLIBC__ */
903
 
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
904
 
                           &direntries, good_name, alphasort);
905
 
#endif  /* not __GLIBC__ */
906
 
  if(numplugins == -1){
907
 
    error(0, errno, "Could not scan plugin dir");
908
 
    direntries = NULL;
909
 
    exitstatus = EX_OSERR;
910
 
    goto fallback;
911
845
  }
912
846
  
913
847
  FD_ZERO(&rfds_all);
914
848
  
915
849
  /* Read and execute any executable in the plugin directory*/
916
 
  for(int i = 0; i < numplugins; i++){
917
 
    
918
 
    int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
 
850
  while(true){
 
851
    do {
 
852
      dirst = readdir(dir);
 
853
    } while(dirst == NULL and errno == EINTR);
 
854
    
 
855
    /* All directory entries have been processed */
 
856
    if(dirst == NULL){
 
857
      if(errno == EBADF){
 
858
        error(0, errno, "readdir");
 
859
        exitstatus = EX_IOERR;
 
860
        goto fallback;
 
861
      }
 
862
      break;
 
863
    }
 
864
    
 
865
    d_name_len = strlen(dirst->d_name);
 
866
    
 
867
    /* Ignore dotfiles, backup files and other junk */
 
868
    {
 
869
      bool bad_name = false;
 
870
      
 
871
      const char * const bad_prefixes[] = { ".", "#", NULL };
 
872
      
 
873
      const char * const bad_suffixes[] = { "~", "#", ".dpkg-new",
 
874
                                           ".dpkg-old",
 
875
                                           ".dpkg-bak",
 
876
                                           ".dpkg-divert", NULL };
 
877
#ifdef __GNUC__
 
878
#pragma GCC diagnostic push
 
879
#pragma GCC diagnostic ignored "-Wcast-qual"
 
880
#endif
 
881
      for(const char **pre = (const char **)bad_prefixes;
 
882
          *pre != NULL; pre++){
 
883
#ifdef __GNUC__
 
884
#pragma GCC diagnostic pop
 
885
#endif
 
886
        size_t pre_len = strlen(*pre);
 
887
        if((d_name_len >= pre_len)
 
888
           and strncmp((dirst->d_name), *pre, pre_len) == 0){
 
889
          if(debug){
 
890
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
891
                    " with bad prefix %s\n", dirst->d_name, *pre);
 
892
          }
 
893
          bad_name = true;
 
894
          break;
 
895
        }
 
896
      }
 
897
      if(bad_name){
 
898
        continue;
 
899
      }
 
900
#ifdef __GNUC__
 
901
#pragma GCC diagnostic push
 
902
#pragma GCC diagnostic ignored "-Wcast-qual"
 
903
#endif
 
904
      for(const char **suf = (const char **)bad_suffixes;
 
905
          *suf != NULL; suf++){
 
906
#ifdef __GNUC__
 
907
#pragma GCC diagnostic pop
 
908
#endif
 
909
        size_t suf_len = strlen(*suf);
 
910
        if((d_name_len >= suf_len)
 
911
           and (strcmp((dirst->d_name) + d_name_len-suf_len, *suf)
 
912
                == 0)){
 
913
          if(debug){
 
914
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
915
                    " with bad suffix %s\n", dirst->d_name, *suf);
 
916
          }
 
917
          bad_name = true;
 
918
          break;
 
919
        }
 
920
      }
 
921
      
 
922
      if(bad_name){
 
923
        continue;
 
924
      }
 
925
    }
 
926
    
 
927
    int plugin_fd = openat(dir_fd, dirst->d_name, O_RDONLY |
 
928
#ifdef O_CLOEXEC
 
929
                            O_CLOEXEC
 
930
#else  /* not O_CLOEXEC */
 
931
                            0
 
932
#endif  /* not O_CLOEXEC */
 
933
                            );
919
934
    if(plugin_fd == -1){
920
935
      error(0, errno, "Could not open plugin");
921
 
      free(direntries[i]);
922
 
      continue;
923
 
    }
 
936
      continue;
 
937
    }
 
938
#ifndef O_CLOEXEC
 
939
  /* Set the FD_CLOEXEC flag on the plugin FD */
 
940
    ret = set_cloexec_flag(plugin_fd);
 
941
    if(ret < 0){
 
942
      error(0, errno, "set_cloexec_flag");
 
943
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
944
      continue;
 
945
    }
 
946
#endif  /* O_CLOEXEC */
924
947
    ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
925
948
    if(ret == -1){
926
949
      error(0, errno, "stat");
927
 
      close(plugin_fd);
928
 
      free(direntries[i]);
 
950
      TEMP_FAILURE_RETRY(close(plugin_fd));
929
951
      continue;
930
952
    }
931
953
    
932
954
    /* Ignore non-executable files */
933
955
    if(not S_ISREG(st.st_mode)
934
 
       or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
935
 
                                        X_OK, 0)) != 0)){
 
956
       or (TEMP_FAILURE_RETRY(faccessat(dir_fd, dirst->d_name, X_OK,
 
957
                                        0)) != 0)){
936
958
      if(debug){
937
959
        fprintf(stderr, "Ignoring plugin dir entry \"%s/%s\""
938
960
                " with bad type or mode\n",
939
 
                plugindir != NULL ? plugindir : PDIR,
940
 
                direntries[i]->d_name);
 
961
                plugindir != NULL ? plugindir : PDIR, dirst->d_name);
941
962
      }
942
 
      close(plugin_fd);
943
 
      free(direntries[i]);
 
963
      TEMP_FAILURE_RETRY(close(plugin_fd));
944
964
      continue;
945
965
    }
946
966
    
947
 
    plugin *p = getplugin(direntries[i]->d_name);
 
967
    plugin *p = getplugin(dirst->d_name);
948
968
    if(p == NULL){
949
969
      error(0, errno, "getplugin");
950
 
      close(plugin_fd);
951
 
      free(direntries[i]);
 
970
      TEMP_FAILURE_RETRY(close(plugin_fd));
952
971
      continue;
953
972
    }
954
973
    if(p->disabled){
955
974
      if(debug){
956
975
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
957
 
                direntries[i]->d_name);
 
976
                dirst->d_name);
958
977
      }
959
 
      close(plugin_fd);
960
 
      free(direntries[i]);
 
978
      TEMP_FAILURE_RETRY(close(plugin_fd));
961
979
      continue;
962
980
    }
963
981
    {
988
1006
    }
989
1007
    
990
1008
    int pipefd[2];
991
 
#ifndef O_CLOEXEC
992
1009
    ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
993
 
#else  /* O_CLOEXEC */
994
 
    ret = (int)TEMP_FAILURE_RETRY(pipe2(pipefd, O_CLOEXEC));
995
 
#endif  /* O_CLOEXEC */
996
1010
    if(ret == -1){
997
1011
      error(0, errno, "pipe");
998
1012
      exitstatus = EX_OSERR;
999
 
      free(direntries[i]);
1000
 
      goto fallback;
1001
 
    }
1002
 
    if(pipefd[0] >= FD_SETSIZE){
1003
 
      fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
1004
 
              FD_SETSIZE);
1005
 
      close(pipefd[0]);
1006
 
      close(pipefd[1]);
1007
 
      exitstatus = EX_OSERR;
1008
 
      free(direntries[i]);
1009
 
      goto fallback;
1010
 
    }
1011
 
#ifndef O_CLOEXEC
 
1013
      goto fallback;
 
1014
    }
1012
1015
    /* Ask OS to automatic close the pipe on exec */
1013
1016
    ret = set_cloexec_flag(pipefd[0]);
1014
1017
    if(ret < 0){
1015
1018
      error(0, errno, "set_cloexec_flag");
1016
 
      close(pipefd[0]);
1017
 
      close(pipefd[1]);
1018
1019
      exitstatus = EX_OSERR;
1019
 
      free(direntries[i]);
1020
1020
      goto fallback;
1021
1021
    }
1022
1022
    ret = set_cloexec_flag(pipefd[1]);
1023
1023
    if(ret < 0){
1024
1024
      error(0, errno, "set_cloexec_flag");
1025
 
      close(pipefd[0]);
1026
 
      close(pipefd[1]);
1027
1025
      exitstatus = EX_OSERR;
1028
 
      free(direntries[i]);
1029
1026
      goto fallback;
1030
1027
    }
1031
 
#endif  /* not O_CLOEXEC */
1032
1028
    /* Block SIGCHLD until process is safely in process list */
1033
1029
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
1034
1030
                                              &sigchld_action.sa_mask,
1036
1032
    if(ret < 0){
1037
1033
      error(0, errno, "sigprocmask");
1038
1034
      exitstatus = EX_OSERR;
1039
 
      free(direntries[i]);
1040
1035
      goto fallback;
1041
1036
    }
1042
1037
    /* Starting a new process to be watched */
1046
1041
    } while(pid == -1 and errno == EINTR);
1047
1042
    if(pid == -1){
1048
1043
      error(0, errno, "fork");
1049
 
      TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1050
 
                                     &sigchld_action.sa_mask, NULL));
1051
 
      close(pipefd[0]);
1052
 
      close(pipefd[1]);
1053
1044
      exitstatus = EX_OSERR;
1054
 
      free(direntries[i]);
1055
1045
      goto fallback;
1056
1046
    }
1057
1047
    if(pid == 0){
1073
1063
        _exit(EX_OSERR);
1074
1064
      }
1075
1065
      
 
1066
      if(dirfd(dir) < 0){
 
1067
        /* If dir has no file descriptor, we could not set FD_CLOEXEC
 
1068
           above and must now close it manually here. */
 
1069
        closedir(dir);
 
1070
      }
1076
1071
      if(fexecve(plugin_fd, p->argv,
1077
1072
                (p->environ[0] != NULL) ? p->environ : environ) < 0){
1078
1073
        error(0, errno, "fexecve for %s/%s",
1079
 
              plugindir != NULL ? plugindir : PDIR,
1080
 
              direntries[i]->d_name);
 
1074
              plugindir != NULL ? plugindir : PDIR, dirst->d_name);
1081
1075
        _exit(EX_OSERR);
1082
1076
      }
1083
1077
      /* no return */
1084
1078
    }
1085
1079
    /* Parent process */
1086
 
    close(pipefd[1]);           /* Close unused write end of pipe */
1087
 
    close(plugin_fd);
1088
 
    plugin *new_plugin = getplugin(direntries[i]->d_name);
 
1080
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
 
1081
                                             pipe */
 
1082
    TEMP_FAILURE_RETRY(close(plugin_fd));
 
1083
    plugin *new_plugin = getplugin(dirst->d_name);
1089
1084
    if(new_plugin == NULL){
1090
1085
      error(0, errno, "getplugin");
1091
1086
      ret = (int)(TEMP_FAILURE_RETRY
1095
1090
        error(0, errno, "sigprocmask");
1096
1091
      }
1097
1092
      exitstatus = EX_OSERR;
1098
 
      free(direntries[i]);
1099
1093
      goto fallback;
1100
1094
    }
1101
 
    free(direntries[i]);
1102
1095
    
1103
1096
    new_plugin->pid = pid;
1104
1097
    new_plugin->fd = pipefd[0];
1134
1127
    }
1135
1128
  }
1136
1129
  
1137
 
  free(direntries);
1138
 
  direntries = NULL;
1139
 
  close(dir_fd);
1140
 
  dir_fd = -1;
 
1130
  TEMP_FAILURE_RETRY(closedir(dir));
 
1131
  dir = NULL;
1141
1132
  free_plugin(getplugin(NULL));
1142
1133
  
1143
1134
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1337
1328
    free(custom_argv);
1338
1329
  }
1339
1330
  
1340
 
  free(direntries);
1341
 
  
1342
 
  if(dir_fd != -1){
1343
 
    close(dir_fd);
 
1331
  if(dir != NULL){
 
1332
    closedir(dir);
1344
1333
  }
1345
1334
  
1346
1335
  /* Kill the processes */
1366
1355
  free_plugin_list();
1367
1356
  
1368
1357
  free(plugindir);
1369
 
  free(pluginhelperdir);
1370
1358
  free(argfile);
1371
1359
  
1372
1360
  return exitstatus;