3
3
 * Mandos plugin runner - Run Mandos plugins
 
5
 
 * Copyright © 2008,2009 Teddy Hogeborn
 
6
 
 * Copyright © 2008,2009 Björn Påhlsson
 
 
5
 * Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
8
7
 * This program is free software: you can redistribute it and/or
 
9
8
 * modify it under the terms of the GNU General Public License as
 
 
28
27
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
 
29
28
                                   EXIT_SUCCESS, realloc() */
 
30
29
#include <stdbool.h>            /* bool, true, false */
 
31
 
#include <stdio.h>              /* perror, fileno(), fprintf(),
 
32
 
                                   stderr, STDOUT_FILENO */
 
 
30
#include <stdio.h>              /* perror, popen(), fileno(),
 
 
31
                                   fprintf(), stderr, STDOUT_FILENO */
 
33
32
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
 
34
33
                                   stat, waitpid(), WIFEXITED(),
 
35
34
                                   WEXITSTATUS(), wait(), pid_t,
 
 
47
46
                                   fcntl(), setuid(), setgid(),
 
48
47
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
 
49
48
                                   access(), pipe(), fork(), close()
 
50
 
                                   dup2(), STDOUT_FILENO, _exit(),
 
 
49
                                   dup2, STDOUT_FILENO, _exit(),
 
51
50
                                   execv(), write(), read(),
 
53
52
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
 
 
62
61
#include <signal.h>             /* struct sigaction, sigemptyset(),
 
63
62
                                   sigaddset(), sigaction(),
 
64
63
                                   sigprocmask(), SIG_BLOCK, SIGCHLD,
 
65
 
                                   SIG_UNBLOCK, kill(), sig_atomic_t
 
 
64
                                   SIG_UNBLOCK, kill() */
 
67
65
#include <errno.h>              /* errno, EBADF */
 
68
 
#include <inttypes.h>           /* intmax_t, PRIdMAX, strtoimax() */
 
70
67
#define BUFFER_SIZE 256
 
72
69
#define PDIR "/lib/mandos/plugins.d"
 
73
70
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
 
75
 
const char *argp_program_version = "plugin-runner " VERSION;
 
 
72
const char *argp_program_version = "plugin-runner 1.0";
 
76
73
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
 
78
77
typedef struct plugin{
 
79
78
  char *name;                   /* can be NULL or any plugin name */
 
 
90
89
  size_t buffer_size;
 
91
90
  size_t buffer_length;
 
93
 
  volatile sig_atomic_t completed;
 
 
92
  volatile bool completed;
 
95
94
  struct plugin *next;
 
98
97
static plugin *plugin_list = NULL;
 
100
 
/* Gets an existing plugin based on name,
 
 
99
/* Gets a existing plugin based on name,
 
101
100
   or if none is found, creates a new one */
 
102
101
static plugin *getplugin(char *name){
 
103
102
  /* Check for exiting plugin with that name */
 
104
 
  for(plugin *p = plugin_list; p != NULL; p = p->next){
 
106
 
       or (p->name and name and (strcmp(p->name, name) == 0))){
 
 
103
  for (plugin *p = plugin_list; p != NULL; p = p->next){
 
 
104
    if ((p->name == name)
 
 
105
        or (p->name and name and (strcmp(p->name, name) == 0))){
 
110
109
  /* Create a new plugin */
 
111
110
  plugin *new_plugin = malloc(sizeof(plugin));
 
112
 
  if(new_plugin == NULL){
 
 
111
  if (new_plugin == NULL){
 
115
114
  char *copy_name = NULL;
 
116
115
  if(name != NULL){
 
117
116
    copy_name = strdup(name);
 
118
117
    if(copy_name == NULL){
 
124
 
  *new_plugin = (plugin){ .name = copy_name,
 
127
 
                          .next = plugin_list };
 
 
122
  *new_plugin = (plugin) { .name = copy_name,
 
 
125
                           .next = plugin_list };
 
129
127
  new_plugin->argv = malloc(sizeof(char *) * 2);
 
130
 
  if(new_plugin->argv == NULL){
 
 
128
  if (new_plugin->argv == NULL){
 
132
130
    free(new_plugin);
 
135
133
  new_plugin->argv[0] = copy_name;
 
136
134
  new_plugin->argv[1] = NULL;
 
138
136
  new_plugin->environ = malloc(sizeof(char *));
 
139
137
  if(new_plugin->environ == NULL){
 
 
183
181
/* Add to a plugin's environment */
 
184
 
static bool add_environment(plugin *p, const char *def, bool replace){
 
 
182
static bool add_environment(plugin *p, const char *def){
 
188
 
  /* namelen = length of name of environment variable */
 
189
 
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
 
190
 
  /* Search for this environment variable */
 
191
 
  for(char **e = p->environ; *e != NULL; e++){
 
192
 
    if(strncmp(*e, def, namelen + 1) == 0){
 
193
 
      /* It already exists */
 
195
 
        char *new = realloc(*e, strlen(def) + 1);
 
205
186
  return add_to_char_array(def, &(p->environ), &(p->envc));
 
 
210
191
 * Descriptor Flags".
 
211
192
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
 
213
 
static int set_cloexec_flag(int fd){
 
 
194
static int set_cloexec_flag(int fd)
 
214
196
  int ret = fcntl(fd, F_GETFD, 0);
 
215
197
  /* If reading the flags failed, return error indication now. */
 
 
252
233
    proc->status = status;
 
 
234
    proc->completed = true;
 
258
238
/* Prints out a password to stdout */
 
259
 
static bool print_out_password(const char *buffer, size_t length){
 
 
239
bool print_out_password(const char *buffer, size_t length){
 
 
241
  if(length>0 and buffer[length-1] == '\n'){
 
261
244
  for(size_t written = 0; written < length; written += (size_t)ret){
 
262
245
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
 
263
246
                                   length - written));
 
 
346
327
    { .name = "global-options", .key = 'g',
 
347
328
      .arg = "OPTION[,OPTION[,...]]",
 
348
329
      .doc = "Options passed to all plugins" },
 
349
 
    { .name = "global-env", .key = 'G',
 
 
330
    { .name = "global-envs", .key = 'e',
 
350
331
      .arg = "VAR=value",
 
351
332
      .doc = "Environment variable passed to all plugins" },
 
352
333
    { .name = "options-for", .key = 'o',
 
353
334
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
 
354
335
      .doc = "Options passed only to specified plugin" },
 
355
 
    { .name = "env-for", .key = 'E',
 
 
336
    { .name = "envs-for", .key = 'f',
 
356
337
      .arg = "PLUGIN:ENV=value",
 
357
338
      .doc = "Environment variable passed to specified plugin" },
 
358
339
    { .name = "disable", .key = 'd',
 
360
341
      .doc = "Disable a specific plugin", .group = 1 },
 
361
 
    { .name = "enable", .key = 'e',
 
363
 
      .doc = "Enable a specific plugin", .group = 1 },
 
364
342
    { .name = "plugin-dir", .key = 128,
 
365
343
      .arg = "DIRECTORY",
 
366
344
      .doc = "Specify a different plugin directory", .group = 2 },
 
 
381
 
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
382
 
                    struct argp_state *state){
 
 
359
  error_t parse_opt (int key, char *arg, __attribute__((unused))
 
 
360
                     struct argp_state *state) {
 
 
361
    /* Get the INPUT argument from `argp_parse', which we know is a
 
 
362
       pointer to our plugin list pointer. */
 
385
364
    case 'g':                   /* --global-options */
 
388
 
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
389
 
          if(plugin_option[0] == '\0'){
 
 
367
        while((p = strsep(&arg, ",")) != NULL){
 
392
 
          if(not add_argument(getplugin(NULL), plugin_option)){
 
 
371
          if(not add_argument(getplugin(NULL), p)){
 
393
372
            perror("add_argument");
 
394
373
            return ARGP_ERR_UNKNOWN;
 
399
 
    case 'G':                   /* --global-env */
 
 
378
    case 'e':                   /* --global-envs */
 
403
 
      if(not add_environment(getplugin(NULL), arg, true)){
 
404
 
        perror("add_environment");
 
 
383
        char *envdef = strdup(arg);
 
 
387
        if(not add_environment(getplugin(NULL), envdef)){
 
 
388
          perror("add_environment");
 
407
392
    case 'o':                   /* --options-for */
 
409
 
        char *plugin_name = strsep(&arg, ":");
 
410
 
        if(plugin_name[0] == '\0'){
 
414
 
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
415
 
          if(not add_argument(getplugin(plugin_name), plugin_option)){
 
416
 
            perror("add_argument");
 
417
 
            return ARGP_ERR_UNKNOWN;
 
 
394
        char *p_name = strsep(&arg, ":");
 
 
395
        if(p_name[0] == '\0'){
 
 
398
        char *opt = strsep(&arg, ":");
 
 
404
          while((p = strsep(&opt, ",")) != NULL){
 
 
408
            if(not add_argument(getplugin(p_name), p)){
 
 
409
              perror("add_argument");
 
 
410
              return ARGP_ERR_UNKNOWN;
 
422
 
    case 'E':                   /* --env-for */
 
 
416
    case 'f':                   /* --envs-for */
 
 
428
422
        if(envdef == NULL){
 
432
 
        if(not add_environment(getplugin(arg), envdef+1, true)){
 
 
425
        char *p_name = strndup(arg, (size_t) (envdef-arg));
 
 
430
        if(not add_environment(getplugin(p_name), envdef)){
 
433
431
          perror("add_environment");
 
437
435
    case 'd':                   /* --disable */
 
439
437
        plugin *p = getplugin(arg);
 
441
439
          return ARGP_ERR_UNKNOWN;
 
 
443
441
        p->disabled = true;
 
446
 
    case 'e':                   /* --enable */
 
448
 
        plugin *p = getplugin(arg);
 
450
 
          return ARGP_ERR_UNKNOWN;
 
455
444
    case 128:                   /* --plugin-dir */
 
457
445
      plugindir = strdup(arg);
 
458
446
      if(plugindir == NULL){
 
459
447
        perror("strdup");
 
462
450
    case 129:                   /* --config-file */
 
463
 
      /* This is already done by parse_opt_config_file() */
 
465
 
    case 130:                   /* --userid */
 
467
 
      tmpmax = strtoimax(arg, &tmp, 10);
 
468
 
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
469
 
         or tmpmax != (uid_t)tmpmax){
 
470
 
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
 
471
 
                PRIdMAX "\n", arg, (intmax_t)uid);
 
476
 
    case 131:                   /* --groupid */
 
478
 
      tmpmax = strtoimax(arg, &tmp, 10);
 
479
 
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
480
 
         or tmpmax != (gid_t)tmpmax){
 
481
 
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
 
482
 
                PRIdMAX "\n", arg, (intmax_t)gid);
 
487
 
    case 132:                   /* --debug */
 
491
 
 * When adding more options before this line, remember to also add a
 
492
 
 * "case" to the "parse_opt_config_file" function below.
 
495
 
      /* Cryptsetup always passes an argument, which is an empty
 
496
 
         string if "none" was specified in /etc/crypttab.  So if
 
497
 
         argument was empty, we ignore it silently. */
 
499
 
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
505
 
      return ARGP_ERR_UNKNOWN;
 
510
 
  /* This option parser is the same as parse_opt() above, except it
 
511
 
     ignores everything but the --config-file option. */
 
512
 
  error_t parse_opt_config_file(int key, char *arg,
 
513
 
                                __attribute__((unused))
 
514
 
                                struct argp_state *state){
 
516
 
    case 'g':                   /* --global-options */
 
517
 
    case 'G':                   /* --global-env */
 
518
 
    case 'o':                   /* --options-for */
 
519
 
    case 'E':                   /* --env-for */
 
520
 
    case 'd':                   /* --disable */
 
521
 
    case 'e':                   /* --enable */
 
522
 
    case 128:                   /* --plugin-dir */
 
524
 
    case 129:                   /* --config-file */
 
526
451
      argfile = strdup(arg);
 
527
452
      if(argfile == NULL){
 
528
453
        perror("strdup");
 
531
456
    case 130:                   /* --userid */
 
 
457
      uid = (uid_t)strtol(arg, NULL, 10);
 
532
459
    case 131:                   /* --groupid */
 
 
460
      gid = (gid_t)strtol(arg, NULL, 10);
 
533
462
    case 132:                   /* --debug */
 
534
465
    case ARGP_KEY_ARG:
 
 
466
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
535
468
    case ARGP_KEY_END:
 
 
543
 
  struct argp argp = { .options = options,
 
544
 
                       .parser = parse_opt_config_file,
 
 
476
  struct argp argp = { .options = options, .parser = parse_opt,
 
 
477
                       .args_doc = "[+PLUS_SEPARATED_OPTIONS]",
 
546
478
                       .doc = "Mandos plugin runner -- Run plugins" };
 
548
 
  /* Parse using parse_opt_config_file() in order to get the custom
 
549
 
     config file location, if any. */
 
550
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
551
 
  if(ret == ARGP_ERR_UNKNOWN){
 
 
480
  ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
 
 
481
  if (ret == ARGP_ERR_UNKNOWN){
 
552
482
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
553
483
    exitstatus = EXIT_FAILURE;
 
557
 
  /* Reset to the normal argument parser */
 
558
 
  argp.parser = parse_opt;
 
560
 
  /* Open the configfile if available */
 
 
487
  /* Opens the configfile if aviable */
 
 
488
  if (argfile == NULL){
 
562
489
    conffp = fopen(AFILE, "r");
 
564
491
    conffp = fopen(argfile, "r");
 
 
628
556
  /* If there was any arguments from configuration file,
 
629
557
     pass them to parser as command arguments */
 
630
558
  if(custom_argv != NULL){
 
631
 
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
633
 
    if(ret == ARGP_ERR_UNKNOWN){
 
 
559
    ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
 
 
560
    if (ret == ARGP_ERR_UNKNOWN){
 
634
561
      fprintf(stderr, "Unknown error while parsing arguments\n");
 
635
562
      exitstatus = EXIT_FAILURE;
 
640
 
  /* Parse actual command line arguments, to let them override the
 
642
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
643
 
  if(ret == ARGP_ERR_UNKNOWN){
 
644
 
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
645
 
    exitstatus = EXIT_FAILURE;
 
650
568
    for(plugin *p = plugin_list; p != NULL; p=p->next){
 
651
569
      fprintf(stderr, "Plugin: %s has %d arguments\n",
 
 
653
571
      for(char **a = p->argv; *a != NULL; a++){
 
654
572
        fprintf(stderr, "\tArg: %s\n", *a);
 
656
 
      fprintf(stderr, "...and %d environment variables\n", p->envc);
 
 
574
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
657
575
      for(char **a = p->environ; *a != NULL; a++){
 
658
576
        fprintf(stderr, "\t%s\n", *a);
 
663
581
  /* Strip permissions down to nobody */
 
666
588
    perror("setgid");
 
673
 
  if(plugindir == NULL){
 
 
591
  if (plugindir == NULL){
 
674
592
    dir = opendir(PDIR);
 
676
594
    dir = opendir(plugindir);
 
 
761
 
    if(plugindir == NULL){
 
762
 
      ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
 
764
 
      ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
 
678
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
767
680
      perror("asprintf");
 
771
684
    ret = stat(filename, &st);
 
778
691
    /* Ignore non-executable files */
 
779
 
    if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
 
692
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
781
694
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
782
695
                " with bad type or mode\n", filename);
 
 
811
724
        /* Add global environment variables */
 
812
725
        for(char **e = g->environ; *e != NULL; e++){
 
813
 
          if(not add_environment(p, *e, false)){
 
 
726
          if(not add_environment(p, *e)){
 
814
727
            perror("add_environment");
 
 
822
735
    if(p->environ[0] != NULL){
 
823
736
      for(char **e = environ; *e != NULL; e++){
 
824
 
        if(not add_environment(p, *e, false)){
 
 
737
        char *copy = strdup(*e);
 
 
742
        if(not add_environment(p, copy)){
 
825
743
          perror("add_environment");
 
 
850
768
    /* Block SIGCHLD until process is safely in process list */
 
851
 
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
 
769
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
853
771
      perror("sigprocmask");
 
854
772
      exitstatus = EXIT_FAILURE;
 
857
 
    /* Starting a new process to be watched */
 
 
775
    // Starting a new process to be watched
 
858
776
    pid_t pid = fork();
 
 
945
863
      free_plugin_list();
 
949
867
  /* Main loop while running plugins exist */
 
950
868
  while(plugin_list){
 
951
869
    fd_set rfds = rfds_all;
 
952
870
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
 
953
 
    if(select_ret == -1){
 
 
871
    if (select_ret == -1){
 
954
872
      perror("select");
 
955
873
      exitstatus = EXIT_FAILURE;
 
958
876
    /* OK, now either a process completed, or something can be read
 
959
877
       from one of them */
 
960
 
    for(plugin *proc = plugin_list; proc != NULL;){
 
 
878
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
961
879
      /* Is this process completely done? */
 
962
 
      if(proc->completed and proc->eof){
 
 
880
      if(proc->eof and proc->completed){
 
963
881
        /* Only accept the plugin output if it exited cleanly */
 
964
882
        if(not WIFEXITED(proc->status)
 
965
883
           or WEXITSTATUS(proc->status) != 0){
 
966
884
          /* Bad exit by plugin */
 
969
887
            if(WIFEXITED(proc->status)){
 
970
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
 
971
 
                      " status %d\n", proc->name,
 
972
 
                      (intmax_t) (proc->pid),
 
 
888
              fprintf(stderr, "Plugin %u exited with status %d\n",
 
 
889
                      (unsigned int) (proc->pid),
 
973
890
                      WEXITSTATUS(proc->status));
 
974
 
            } else if(WIFSIGNALED(proc->status)){
 
975
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
 
976
 
                      " signal %d\n", proc->name,
 
977
 
                      (intmax_t) (proc->pid),
 
 
891
            } else if(WIFSIGNALED(proc->status)) {
 
 
892
              fprintf(stderr, "Plugin %u killed by signal %d\n",
 
 
893
                      (unsigned int) (proc->pid),
 
978
894
                      WTERMSIG(proc->status));
 
979
895
            } else if(WCOREDUMP(proc->status)){
 
980
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
981
 
                      " core\n", proc->name, (intmax_t) (proc->pid));
 
 
896
              fprintf(stderr, "Plugin %d dumped core\n",
 
 
897
                      (unsigned int) (proc->pid));
 
985
901
          /* Remove the plugin */
 
986
902
          FD_CLR(proc->fd, &rfds_all);
 
988
904
          /* Block signal while modifying process_list */
 
989
905
          ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
 
992
908
            exitstatus = EXIT_FAILURE;
 
996
 
          plugin *next_plugin = proc->next;
 
997
911
          free_plugin(proc);
 
1000
912
          /* We are done modifying process list, so unblock signal */
 
1001
 
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
 
913
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
 
1004
916
            perror("sigprocmask");
 
1005
917
            exitstatus = EXIT_FAILURE;
 
 
1027
938
      /* This process has not completed.  Does it have any output? */
 
1028
939
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
 
1029
940
        /* This process had nothing to say at this time */
 
1033
943
      /* Before reading, make the process' data buffer large enough */
 
1034
944
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
 
1035
945
        proc->buffer = realloc(proc->buffer, proc->buffer_size
 
1036
946
                               + (size_t) BUFFER_SIZE);
 
1037
 
        if(proc->buffer == NULL){
 
 
947
        if (proc->buffer == NULL){
 
1038
948
          perror("malloc");
 
1039
949
          exitstatus = EXIT_FAILURE;
 
 
1042
952
        proc->buffer_size += BUFFER_SIZE;
 
1044
954
      /* Read from the process */
 
1045
 
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
 
955
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1048
958
        /* Read error from this process; ignore the error */
 
1054
963
        proc->eof = true;
 
1056
 
        proc->buffer_length += (size_t) sret;
 
 
965
        proc->buffer_length += (size_t) ret;
 
1064
973
  if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
 
 
1068
977
    fprintf(stderr, "Going to fallback mode using getpass(3)\n");
 
1069
978
    char *passwordbuffer = getpass("Password: ");
 
1070
 
    size_t len = strlen(passwordbuffer);
 
1071
 
    /* Strip trailing newline */
 
1072
 
    if(len > 0 and passwordbuffer[len-1] == '\n'){
 
1073
 
      passwordbuffer[len-1] = '\0'; /* not strictly necessary */
 
1076
 
    bret = print_out_password(passwordbuffer, len);
 
 
979
    bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
 
1078
981
      perror("print_out_password");
 
1079
982
      exitstatus = EXIT_FAILURE;