/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: 2009-01-15 03:35:34 UTC
  • mfrom: (24.1.122 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090115033534-wcldj74x0jgvv9o0
Merged newer version of mandos-list (now renamed mandos-ctl) from
Björn.

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 © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
5
 * Copyright © 2008,2009 Teddy Hogeborn
 
6
 * Copyright © 2008,2009 Björn Påhlsson
6
7
 * 
7
8
 * This program is free software: you can redistribute it and/or
8
9
 * modify it under the terms of the GNU General Public License as
27
28
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
28
29
                                   EXIT_SUCCESS, realloc() */
29
30
#include <stdbool.h>            /* bool, true, false */
30
 
#include <stdio.h>              /* perror, popen(), fileno(),
31
 
                                   fprintf(), stderr, STDOUT_FILENO */
 
31
#include <stdio.h>              /* perror, fileno(), fprintf(),
 
32
                                   stderr, STDOUT_FILENO */
32
33
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
33
34
                                   stat, waitpid(), WIFEXITED(),
34
35
                                   WEXITSTATUS(), wait(), pid_t,
46
47
                                   fcntl(), setuid(), setgid(),
47
48
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
48
49
                                   access(), pipe(), fork(), close()
49
 
                                   dup2, STDOUT_FILENO, _exit(),
 
50
                                   dup2(), STDOUT_FILENO, _exit(),
50
51
                                   execv(), write(), read(),
51
52
                                   close() */
52
53
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
63
64
                                   sigprocmask(), SIG_BLOCK, SIGCHLD,
64
65
                                   SIG_UNBLOCK, kill() */
65
66
#include <errno.h>              /* errno, EBADF */
 
67
#include <inttypes.h>           /* intmax_t, SCNdMAX, PRIdMAX,  */
66
68
 
67
69
#define BUFFER_SIZE 256
68
70
 
69
71
#define PDIR "/lib/mandos/plugins.d"
70
72
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
71
73
 
72
 
const char *argp_program_version = "plugin-runner 1.0";
 
74
const char *argp_program_version = "plugin-runner " VERSION;
73
75
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
74
76
 
75
 
struct plugin;
76
 
 
77
77
typedef struct plugin{
78
78
  char *name;                   /* can be NULL or any plugin name */
79
79
  char **argv;
100
100
   or if none is found, creates a new one */
101
101
static plugin *getplugin(char *name){
102
102
  /* Check for exiting plugin with that name */
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))){
 
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))){
106
106
      return p;
107
107
    }
108
108
  }
109
109
  /* Create a new plugin */
110
110
  plugin *new_plugin = malloc(sizeof(plugin));
111
 
  if (new_plugin == NULL){
 
111
  if(new_plugin == NULL){
112
112
    return NULL;
113
113
  }
114
114
  char *copy_name = NULL;
125
125
                           .next = plugin_list };
126
126
  
127
127
  new_plugin->argv = malloc(sizeof(char *) * 2);
128
 
  if (new_plugin->argv == NULL){
 
128
  if(new_plugin->argv == NULL){
129
129
    free(copy_name);
130
130
    free(new_plugin);
131
131
    return NULL;
208
208
 * Descriptor Flags".
209
209
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
210
210
 */
211
 
static int set_cloexec_flag(int fd)
212
 
{
 
211
static int set_cloexec_flag(int fd){
213
212
  int ret = fcntl(fd, F_GETFD, 0);
214
213
  /* If reading the flags failed, return error indication now. */
215
214
  if(ret < 0){
222
221
 
223
222
/* Mark processes as completed when they exit, and save their exit
224
223
   status. */
225
 
void handle_sigchld(__attribute__((unused)) int sig){
 
224
static void handle_sigchld(__attribute__((unused)) int sig){
226
225
  while(true){
227
226
    plugin *proc = plugin_list;
228
227
    int status;
232
231
      break;
233
232
    }
234
233
    if(pid == -1){
235
 
      if (errno != ECHILD){
 
234
      if(errno != ECHILD){
236
235
        perror("waitpid");
237
236
      }
238
237
      /* No child processes */
253
252
}
254
253
 
255
254
/* Prints out a password to stdout */
256
 
bool print_out_password(const char *buffer, size_t length){
 
255
static bool print_out_password(const char *buffer, size_t length){
257
256
  ssize_t ret;
258
257
  for(size_t written = 0; written < length; written += (size_t)ret){
259
258
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
310
309
  struct dirent *dirst;
311
310
  struct stat st;
312
311
  fd_set rfds_all;
313
 
  int ret, maxfd = 0;
 
312
  int ret, numchars, maxfd = 0;
 
313
  ssize_t sret;
 
314
  intmax_t tmpmax;
314
315
  uid_t uid = 65534;
315
316
  gid_t gid = 65534;
316
317
  bool debug = false;
373
374
    { .name = NULL }
374
375
  };
375
376
  
376
 
  error_t parse_opt (int key, char *arg, __attribute__((unused))
377
 
                     struct argp_state *state) {
378
 
    switch (key) {
 
377
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
378
                    struct argp_state *state) {
 
379
    switch(key) {
379
380
    case 'g':                   /* --global-options */
380
 
      if (arg != NULL){
 
381
      if(arg != NULL){
381
382
        char *p;
382
383
        while((p = strsep(&arg, ",")) != NULL){
383
384
          if(p[0] == '\0'){
399
400
      }
400
401
      break;
401
402
    case 'o':                   /* --options-for */
402
 
      if (arg != NULL){
 
403
      if(arg != NULL){
403
404
        char *p_name = strsep(&arg, ":");
404
405
        if(p_name[0] == '\0' or arg == NULL){
405
406
          break;
436
437
      }
437
438
      break;
438
439
    case 'd':                   /* --disable */
439
 
      if (arg != NULL){
 
440
      if(arg != NULL){
440
441
        plugin *p = getplugin(arg);
441
442
        if(p == NULL){
442
443
          return ARGP_ERR_UNKNOWN;
445
446
      }
446
447
      break;
447
448
    case 'e':                   /* --enable */
448
 
      if (arg != NULL){
 
449
      if(arg != NULL){
449
450
        plugin *p = getplugin(arg);
450
451
        if(p == NULL){
451
452
          return ARGP_ERR_UNKNOWN;
464
465
      /* This is already done by parse_opt_config_file() */
465
466
      break;
466
467
    case 130:                   /* --userid */
467
 
      uid = (uid_t)strtol(arg, NULL, 10);
 
468
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
469
      if(ret < 1 or tmpmax != (uid_t)tmpmax
 
470
         or arg[numchars] != '\0'){
 
471
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
 
472
                PRIdMAX "\n", arg, (intmax_t)uid);
 
473
      } else {
 
474
        uid = (uid_t)tmpmax;
 
475
      }
468
476
      break;
469
477
    case 131:                   /* --groupid */
470
 
      gid = (gid_t)strtol(arg, NULL, 10);
 
478
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
479
      if(ret < 1 or tmpmax != (gid_t)tmpmax
 
480
         or arg[numchars] != '\0'){
 
481
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
 
482
                PRIdMAX "\n", arg, (intmax_t)gid);
 
483
      } else {
 
484
        gid = (gid_t)tmpmax;
 
485
      }
471
486
      break;
472
487
    case 132:                   /* --debug */
473
488
      debug = true;
474
489
      break;
 
490
/*
 
491
 * When adding more options before this line, remember to also add a
 
492
 * "case" to the "parse_opt_config_file" function below.
 
493
 */
475
494
    case ARGP_KEY_ARG:
476
495
      /* Cryptsetup always passes an argument, which is an empty
477
496
         string if "none" was specified in /etc/crypttab.  So if
490
509
  
491
510
  /* This option parser is the same as parse_opt() above, except it
492
511
     ignores everything but the --config-file option. */
493
 
  error_t parse_opt_config_file (int key, char *arg,
494
 
                                 __attribute__((unused))
495
 
                                 struct argp_state *state) {
496
 
    switch (key) {
 
512
  error_t parse_opt_config_file(int key, char *arg,
 
513
                                __attribute__((unused))
 
514
                                struct argp_state *state) {
 
515
    switch(key) {
497
516
    case 'g':                   /* --global-options */
498
517
    case 'G':                   /* --global-env */
499
518
    case 'o':                   /* --options-for */
526
545
                       .args_doc = "",
527
546
                       .doc = "Mandos plugin runner -- Run plugins" };
528
547
  
529
 
  /* Parse using the parse_opt_config_file in order to get the custom
 
548
  /* Parse using parse_opt_config_file() in order to get the custom
530
549
     config file location, if any. */
531
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
532
 
  if (ret == ARGP_ERR_UNKNOWN){
 
550
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
551
  if(ret == ARGP_ERR_UNKNOWN){
533
552
    fprintf(stderr, "Unknown error while parsing arguments\n");
534
553
    exitstatus = EXIT_FAILURE;
535
554
    goto fallback;
539
558
  argp.parser = parse_opt;
540
559
  
541
560
  /* Open the configfile if available */
542
 
  if (argfile == NULL){
 
561
  if(argfile == NULL){
543
562
    conffp = fopen(AFILE, "r");
544
563
  } else {
545
564
    conffp = fopen(argfile, "r");
548
567
    char *org_line = NULL;
549
568
    char *p, *arg, *new_arg, *line;
550
569
    size_t size = 0;
551
 
    ssize_t sret;
552
570
    const char whitespace_delims[] = " \r\t\f\v\n";
553
571
    const char comment_delim[] = "#";
554
572
 
601
619
  } else {
602
620
    /* Check for harmful errors and go to fallback. Other errors might
603
621
       not affect opening plugins */
604
 
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
622
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
605
623
      perror("fopen");
606
624
      exitstatus = EXIT_FAILURE;
607
625
      goto fallback;
610
628
  /* If there was any arguments from configuration file,
611
629
     pass them to parser as command arguments */
612
630
  if(custom_argv != NULL){
613
 
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
614
 
                      0, NULL);
615
 
    if (ret == ARGP_ERR_UNKNOWN){
 
631
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
632
                     0, NULL);
 
633
    if(ret == ARGP_ERR_UNKNOWN){
616
634
      fprintf(stderr, "Unknown error while parsing arguments\n");
617
635
      exitstatus = EXIT_FAILURE;
618
636
      goto fallback;
621
639
  
622
640
  /* Parse actual command line arguments, to let them override the
623
641
     config file */
624
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
625
 
  if (ret == ARGP_ERR_UNKNOWN){
 
642
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
643
  if(ret == ARGP_ERR_UNKNOWN){
626
644
    fprintf(stderr, "Unknown error while parsing arguments\n");
627
645
    exitstatus = EXIT_FAILURE;
628
646
    goto fallback;
635
653
      for(char **a = p->argv; *a != NULL; a++){
636
654
        fprintf(stderr, "\tArg: %s\n", *a);
637
655
      }
638
 
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
656
      fprintf(stderr, "...and %d environment variables\n", p->envc);
639
657
      for(char **a = p->environ; *a != NULL; a++){
640
658
        fprintf(stderr, "\t%s\n", *a);
641
659
      }
644
662
  
645
663
  /* Strip permissions down to nobody */
646
664
  ret = setuid(uid);
647
 
  if (ret == -1){
 
665
  if(ret == -1){
648
666
    perror("setuid");
649
667
  }  
650
668
  setgid(gid);
651
 
  if (ret == -1){
 
669
  if(ret == -1){
652
670
    perror("setgid");
653
671
  }
654
672
  
655
 
  if (plugindir == NULL){
 
673
  if(plugindir == NULL){
656
674
    dir = opendir(PDIR);
657
675
  } else {
658
676
    dir = opendir(plugindir);
685
703
    
686
704
    /* All directory entries have been processed */
687
705
    if(dirst == NULL){
688
 
      if (errno == EBADF){
 
706
      if(errno == EBADF){
689
707
        perror("readdir");
690
708
        exitstatus = EXIT_FAILURE;
691
709
        goto fallback;
703
721
      
704
722
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
705
723
                                           ".dpkg-old",
 
724
                                           ".dpkg-bak",
706
725
                                           ".dpkg-divert", NULL };
707
726
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
708
727
        size_t pre_len = strlen(*pre);
750
769
    }
751
770
    
752
771
    ret = stat(filename, &st);
753
 
    if (ret == -1){
 
772
    if(ret == -1){
754
773
      perror("stat");
755
774
      free(filename);
756
775
      continue;
757
776
    }
758
777
 
759
778
    /* Ignore non-executable files */
760
 
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
779
    if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
761
780
      if(debug){
762
781
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
763
782
                " with bad type or mode\n", filename);
810
829
    
811
830
    int pipefd[2];
812
831
    ret = pipe(pipefd);
813
 
    if (ret == -1){
 
832
    if(ret == -1){
814
833
      perror("pipe");
815
834
      exitstatus = EXIT_FAILURE;
816
835
      goto fallback;
829
848
      goto fallback;
830
849
    }
831
850
    /* Block SIGCHLD until process is safely in process list */
832
 
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
851
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
833
852
    if(ret < 0){
834
853
      perror("sigprocmask");
835
854
      exitstatus = EXIT_FAILURE;
849
868
        perror("sigaction");
850
869
        _exit(EXIT_FAILURE);
851
870
      }
852
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
871
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
853
872
      if(ret < 0){
854
873
        perror("sigprocmask");
855
874
        _exit(EXIT_FAILURE);
856
875
      }
857
 
 
 
876
      
858
877
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
859
878
      if(ret == -1){
860
879
        perror("dup2");
883
902
    close(pipefd[1]);           /* Close unused write end of pipe */
884
903
    free(filename);
885
904
    plugin *new_plugin = getplugin(dirst->d_name);
886
 
    if (new_plugin == NULL){
 
905
    if(new_plugin == NULL){
887
906
      perror("getplugin");
888
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
907
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
889
908
      if(ret < 0){
890
909
        perror("sigprocmask");
891
910
      }
898
917
    
899
918
    /* Unblock SIGCHLD so signal handler can be run if this process
900
919
       has already completed */
901
 
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
920
    ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
902
921
    if(ret < 0){
903
922
      perror("sigprocmask");
904
923
      exitstatus = EXIT_FAILURE;
907
926
    
908
927
    FD_SET(new_plugin->fd, &rfds_all);
909
928
    
910
 
    if (maxfd < new_plugin->fd){
 
929
    if(maxfd < new_plugin->fd){
911
930
      maxfd = new_plugin->fd;
912
931
    }
913
 
    
914
932
  }
915
933
  
916
934
  closedir(dir);
917
935
  dir = NULL;
918
 
 
 
936
  
919
937
  for(plugin *p = plugin_list; p != NULL; p = p->next){
920
938
    if(p->pid != 0){
921
939
      break;
926
944
      free_plugin_list();
927
945
    }
928
946
  }
929
 
 
 
947
  
930
948
  /* Main loop while running plugins exist */
931
949
  while(plugin_list){
932
950
    fd_set rfds = rfds_all;
933
951
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
934
 
    if (select_ret == -1){
 
952
    if(select_ret == -1){
935
953
      perror("select");
936
954
      exitstatus = EXIT_FAILURE;
937
955
      goto fallback;
948
966
 
949
967
          if(debug){
950
968
            if(WIFEXITED(proc->status)){
951
 
              fprintf(stderr, "Plugin %u exited with status %d\n",
952
 
                      (unsigned int) (proc->pid),
 
969
              fprintf(stderr, "Plugin %" PRIdMAX " exited with status"
 
970
                      " %d\n", (intmax_t) (proc->pid),
953
971
                      WEXITSTATUS(proc->status));
954
972
            } else if(WIFSIGNALED(proc->status)) {
955
 
              fprintf(stderr, "Plugin %u killed by signal %d\n",
956
 
                      (unsigned int) (proc->pid),
 
973
              fprintf(stderr, "Plugin %" PRIdMAX " killed by signal"
 
974
                      " %d\n", (intmax_t) (proc->pid),
957
975
                      WTERMSIG(proc->status));
958
976
            } else if(WCOREDUMP(proc->status)){
959
 
              fprintf(stderr, "Plugin %d dumped core\n",
960
 
                      (unsigned int) (proc->pid));
 
977
              fprintf(stderr, "Plugin %" PRIdMAX " dumped core\n",
 
978
                      (intmax_t) (proc->pid));
961
979
            }
962
980
          }
963
981
          
972
990
            goto fallback;
973
991
          }
974
992
          
 
993
          plugin *next_plugin = proc->next;
 
994
          free_plugin(proc);
 
995
          proc = next_plugin;
 
996
          
975
997
          /* We are done modifying process list, so unblock signal */
976
 
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
977
 
                             NULL);
 
998
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
999
                            NULL);
978
1000
          if(ret < 0){
979
1001
            perror("sigprocmask");
980
1002
            exitstatus = EXIT_FAILURE;
985
1007
            break;
986
1008
          }
987
1009
          
988
 
          plugin *next_plugin = proc->next;
989
 
          free_plugin(proc);
990
 
          proc = next_plugin;
991
1010
          continue;
992
1011
        }
993
1012
        
994
1013
        /* This process exited nicely, so print its buffer */
995
 
 
 
1014
        
996
1015
        bool bret = print_out_password(proc->buffer,
997
1016
                                       proc->buffer_length);
998
1017
        if(not bret){
1012
1031
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1013
1032
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1014
1033
                               + (size_t) BUFFER_SIZE);
1015
 
        if (proc->buffer == NULL){
 
1034
        if(proc->buffer == NULL){
1016
1035
          perror("malloc");
1017
1036
          exitstatus = EXIT_FAILURE;
1018
1037
          goto fallback;
1020
1039
        proc->buffer_size += BUFFER_SIZE;
1021
1040
      }
1022
1041
      /* Read from the process */
1023
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1024
 
                 BUFFER_SIZE);
1025
 
      if(ret < 0){
 
1042
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1043
                  BUFFER_SIZE);
 
1044
      if(sret < 0){
1026
1045
        /* Read error from this process; ignore the error */
1027
1046
        proc = proc->next;
1028
1047
        continue;
1029
1048
      }
1030
 
      if(ret == 0){
 
1049
      if(sret == 0){
1031
1050
        /* got EOF */
1032
1051
        proc->eof = true;
1033
1052
      } else {
1034
 
        proc->buffer_length += (size_t) ret;
 
1053
        proc->buffer_length += (size_t) sret;
1035
1054
      }
1036
1055
    }
1037
1056
  }
1064
1083
    perror("sigaction");
1065
1084
    exitstatus = EXIT_FAILURE;
1066
1085
  }
1067
 
 
 
1086
  
1068
1087
  if(custom_argv != NULL){
1069
1088
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1070
1089
      free(*arg);
1076
1095
    closedir(dir);
1077
1096
  }
1078
1097
  
1079
 
  /* Free the process list and kill the processes */
 
1098
  /* Kill the processes */
1080
1099
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1081
1100
    if(p->pid != 0){
1082
1101
      close(p->fd);
1095
1114
  if(errno != ECHILD){
1096
1115
    perror("wait");
1097
1116
  }
1098
 
 
 
1117
  
1099
1118
  free_plugin_list();
1100
1119
  
1101
1120
  free(plugindir);