/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-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

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-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
 
  struct dirent **direntries;
 
355
  struct dirent **direntries = NULL;
353
356
  struct stat st;
354
357
  fd_set rfds_all;
355
358
  int ret, maxfd = 0;
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
#if __GNUC__ >= 7
 
590
      __attribute__((fallthrough));
 
591
#else
 
592
          /* FALLTHROUGH */
 
593
#endif
573
594
    default:
574
595
      return ARGP_ERR_UNKNOWN;
575
596
    }
601
622
    case 130:                   /* --userid */
602
623
    case 131:                   /* --groupid */
603
624
    case 132:                   /* --debug */
 
625
    case 133:                   /* --plugin-helper-dir */
604
626
    case '?':                   /* --help */
605
627
    case -3:                    /* --usage */
606
628
    case 'V':                   /* --version */
687
709
        custom_argc += 1;
688
710
        {
689
711
          char **new_argv = realloc(custom_argv, sizeof(char *)
690
 
                                    * ((unsigned int)
691
 
                                       custom_argc + 1));
 
712
                                    * ((size_t)custom_argc + 1));
692
713
          if(new_argv == NULL){
693
714
            error(0, errno, "realloc");
694
715
            exitstatus = EX_OSERR;
761
782
    goto fallback;
762
783
  }
763
784
  
 
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
  
764
803
  if(debug){
765
 
    for(plugin *p = plugin_list; p != NULL; p=p->next){
 
804
    for(plugin *p = plugin_list; p != NULL; p = p->next){
766
805
      fprintf(stderr, "Plugin: %s has %d arguments\n",
767
806
              p->name ? p->name : "Global", p->argc - 1);
768
807
      for(char **a = p->argv; *a != NULL; a++){
777
816
  
778
817
  if(getuid() == 0){
779
818
    /* Work around Debian bug #633582:
780
 
       <http://bugs.debian.org/633582> */
 
819
       <https://bugs.debian.org/633582> */
781
820
    int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
782
821
    if(plugindir_fd == -1){
783
822
      if(errno != ENOENT){
795
834
          }
796
835
        }
797
836
      }
798
 
      TEMP_FAILURE_RETRY(close(plugindir_fd));
 
837
      close(plugindir_fd);
799
838
    }
800
839
  }
801
840
  
829
868
    ret = set_cloexec_flag(dir_fd);
830
869
    if(ret < 0){
831
870
      error(0, errno, "set_cloexec_flag");
832
 
      TEMP_FAILURE_RETRY(close(dir_fd));
833
871
      exitstatus = EX_OSERR;
834
872
      goto fallback;
835
873
    }
861
899
    return 1;
862
900
  }
863
901
  
864
 
#ifdef __GLIBC__
865
 
#if __GLIBC_PREREQ(2, 15)
866
902
  int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
867
903
                             alphasort);
868
 
#else  /* not __GLIBC_PREREQ(2, 15) */
869
 
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
870
 
                           &direntries, good_name, alphasort);
871
 
#endif  /* not __GLIBC_PREREQ(2, 15) */
872
 
#else   /* not __GLIBC__ */
873
 
  int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
874
 
                           &direntries, good_name, alphasort);
875
 
#endif  /* not __GLIBC__ */
876
904
  if(numplugins == -1){
877
905
    error(0, errno, "Could not scan plugin dir");
878
 
    TEMP_FAILURE_RETRY(close(dir_fd));
 
906
    direntries = NULL;
879
907
    exitstatus = EX_OSERR;
880
908
    goto fallback;
881
909
  }
888
916
    int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
889
917
    if(plugin_fd == -1){
890
918
      error(0, errno, "Could not open plugin");
 
919
      free(direntries[i]);
891
920
      continue;
892
921
    }
893
922
    ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
894
923
    if(ret == -1){
895
924
      error(0, errno, "stat");
896
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
925
      close(plugin_fd);
 
926
      free(direntries[i]);
897
927
      continue;
898
928
    }
899
929
    
907
937
                plugindir != NULL ? plugindir : PDIR,
908
938
                direntries[i]->d_name);
909
939
      }
910
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
940
      close(plugin_fd);
 
941
      free(direntries[i]);
911
942
      continue;
912
943
    }
913
944
    
914
945
    plugin *p = getplugin(direntries[i]->d_name);
915
946
    if(p == NULL){
916
947
      error(0, errno, "getplugin");
917
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
948
      close(plugin_fd);
 
949
      free(direntries[i]);
918
950
      continue;
919
951
    }
920
952
    if(p->disabled){
922
954
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
923
955
                direntries[i]->d_name);
924
956
      }
925
 
      TEMP_FAILURE_RETRY(close(plugin_fd));
 
957
      close(plugin_fd);
 
958
      free(direntries[i]);
926
959
      continue;
927
960
    }
928
961
    {
961
994
    if(ret == -1){
962
995
      error(0, errno, "pipe");
963
996
      exitstatus = EX_OSERR;
 
997
      free(direntries[i]);
964
998
      goto fallback;
965
999
    }
966
1000
    if(pipefd[0] >= FD_SETSIZE){
967
1001
      fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
968
1002
              FD_SETSIZE);
969
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
970
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
1003
      close(pipefd[0]);
 
1004
      close(pipefd[1]);
971
1005
      exitstatus = EX_OSERR;
 
1006
      free(direntries[i]);
972
1007
      goto fallback;
973
1008
    }
974
1009
#ifndef O_CLOEXEC
976
1011
    ret = set_cloexec_flag(pipefd[0]);
977
1012
    if(ret < 0){
978
1013
      error(0, errno, "set_cloexec_flag");
979
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
980
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
1014
      close(pipefd[0]);
 
1015
      close(pipefd[1]);
981
1016
      exitstatus = EX_OSERR;
 
1017
      free(direntries[i]);
982
1018
      goto fallback;
983
1019
    }
984
1020
    ret = set_cloexec_flag(pipefd[1]);
985
1021
    if(ret < 0){
986
1022
      error(0, errno, "set_cloexec_flag");
987
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
988
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
1023
      close(pipefd[0]);
 
1024
      close(pipefd[1]);
989
1025
      exitstatus = EX_OSERR;
 
1026
      free(direntries[i]);
990
1027
      goto fallback;
991
1028
    }
992
1029
#endif  /* not O_CLOEXEC */
997
1034
    if(ret < 0){
998
1035
      error(0, errno, "sigprocmask");
999
1036
      exitstatus = EX_OSERR;
 
1037
      free(direntries[i]);
1000
1038
      goto fallback;
1001
1039
    }
1002
1040
    /* Starting a new process to be watched */
1008
1046
      error(0, errno, "fork");
1009
1047
      TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1010
1048
                                     &sigchld_action.sa_mask, NULL));
1011
 
      TEMP_FAILURE_RETRY(close(pipefd[0]));
1012
 
      TEMP_FAILURE_RETRY(close(pipefd[1]));
 
1049
      close(pipefd[0]);
 
1050
      close(pipefd[1]);
1013
1051
      exitstatus = EX_OSERR;
 
1052
      free(direntries[i]);
1014
1053
      goto fallback;
1015
1054
    }
1016
1055
    if(pid == 0){
1042
1081
      /* no return */
1043
1082
    }
1044
1083
    /* Parent process */
1045
 
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
1046
 
                                             pipe */
1047
 
    TEMP_FAILURE_RETRY(close(plugin_fd));
 
1084
    close(pipefd[1]);           /* Close unused write end of pipe */
 
1085
    close(plugin_fd);
1048
1086
    plugin *new_plugin = getplugin(direntries[i]->d_name);
1049
1087
    if(new_plugin == NULL){
1050
1088
      error(0, errno, "getplugin");
1055
1093
        error(0, errno, "sigprocmask");
1056
1094
      }
1057
1095
      exitstatus = EX_OSERR;
 
1096
      free(direntries[i]);
1058
1097
      goto fallback;
1059
1098
    }
 
1099
    free(direntries[i]);
1060
1100
    
1061
1101
    new_plugin->pid = pid;
1062
1102
    new_plugin->fd = pipefd[0];
1063
 
    
 
1103
 
 
1104
    if(debug){
 
1105
      fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
 
1106
              new_plugin->name, (intmax_t) (new_plugin->pid));
 
1107
    }
 
1108
 
1064
1109
    /* Unblock SIGCHLD so signal handler can be run if this process
1065
1110
       has already completed */
1066
1111
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1072
1117
      goto fallback;
1073
1118
    }
1074
1119
    
1075
 
#if defined (__GNUC__) and defined (__GLIBC__)
1076
 
#if not __GLIBC_PREREQ(2, 16)
1077
 
#pragma GCC diagnostic push
1078
 
#pragma GCC diagnostic ignored "-Wsign-conversion"
1079
 
#endif
1080
 
#endif
1081
 
    FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
1082
 
                                          -Wconversion in GNU libc
1083
 
                                          before 2.16 */
1084
 
#if defined (__GNUC__) and defined (__GLIBC__)
1085
 
#if not __GLIBC_PREREQ(2, 16)
1086
 
#pragma GCC diagnostic pop
1087
 
#endif
1088
 
#endif
 
1120
    FD_SET(new_plugin->fd, &rfds_all);
1089
1121
    
1090
1122
    if(maxfd < new_plugin->fd){
1091
1123
      maxfd = new_plugin->fd;
1092
1124
    }
1093
1125
  }
1094
1126
  
1095
 
  TEMP_FAILURE_RETRY(close(dir_fd));
 
1127
  free(direntries);
 
1128
  direntries = NULL;
 
1129
  close(dir_fd);
 
1130
  dir_fd = -1;
1096
1131
  free_plugin(getplugin(NULL));
1097
1132
  
1098
1133
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1137
1172
                      (intmax_t) (proc->pid),
1138
1173
                      WTERMSIG(proc->status),
1139
1174
                      strsignal(WTERMSIG(proc->status)));
1140
 
            } else if(WCOREDUMP(proc->status)){
1141
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
1142
 
                      " core\n", proc->name, (intmax_t) (proc->pid));
1143
1175
            }
1144
1176
          }
1145
1177
          
1146
1178
          /* Remove the plugin */
1147
 
#if defined (__GNUC__) and defined (__GLIBC__)
1148
 
#if not __GLIBC_PREREQ(2, 16)
1149
 
#pragma GCC diagnostic push
1150
 
#pragma GCC diagnostic ignored "-Wsign-conversion"
1151
 
#endif
1152
 
#endif
1153
 
          FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
1154
 
                                          -Wconversion in GNU libc
1155
 
                                          before 2.16 */
1156
 
#if defined (__GNUC__) and defined (__GLIBC__)
1157
 
#if not __GLIBC_PREREQ(2, 16)
1158
 
#pragma GCC diagnostic pop
1159
 
#endif
1160
 
#endif
 
1179
          FD_CLR(proc->fd, &rfds_all);
1161
1180
          
1162
1181
          /* Block signal while modifying process_list */
1163
1182
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1203
1222
      }
1204
1223
      
1205
1224
      /* This process has not completed.  Does it have any output? */
1206
 
#if defined (__GNUC__) and defined (__GLIBC__)
1207
 
#if not __GLIBC_PREREQ(2, 16)
1208
 
#pragma GCC diagnostic push
1209
 
#pragma GCC diagnostic ignored "-Wsign-conversion"
1210
 
#endif
1211
 
#endif
1212
 
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
1213
 
                                                         warning from
1214
 
                                                         -Wconversion
1215
 
                                                         in GNU libc
1216
 
                                                         before
1217
 
                                                         2.16 */
1218
 
#if defined (__GNUC__) and defined (__GLIBC__)
1219
 
#if not __GLIBC_PREREQ(2, 16)
1220
 
#pragma GCC diagnostic pop
1221
 
#endif
1222
 
#endif
 
1225
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1223
1226
        /* This process had nothing to say at this time */
1224
1227
        proc = proc->next;
1225
1228
        continue;
1292
1295
    free(custom_argv);
1293
1296
  }
1294
1297
  
 
1298
  free(direntries);
 
1299
  
1295
1300
  if(dir_fd != -1){
1296
 
    TEMP_FAILURE_RETRY(close(dir_fd));
 
1301
    close(dir_fd);
1297
1302
  }
1298
1303
  
1299
1304
  /* Kill the processes */
1319
1324
  free_plugin_list();
1320
1325
  
1321
1326
  free(plugindir);
 
1327
  free(pluginhelperdir);
1322
1328
  free(argfile);
1323
1329
  
1324
1330
  return exitstatus;