/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

merge

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
77
typedef struct plugin{
87
89
  size_t buffer_size;
88
90
  size_t buffer_length;
89
91
  bool eof;
90
 
  volatile bool completed;
91
 
  volatile int status;
 
92
  volatile sig_atomic_t completed;
 
93
  int status;
92
94
  struct plugin *next;
93
95
} plugin;
94
96
 
98
100
   or if none is found, creates a new one */
99
101
static plugin *getplugin(char *name){
100
102
  /* Check for exiting plugin with that name */
101
 
  for (plugin *p = plugin_list; p != NULL; p = p->next){
102
 
    if ((p->name == name)
103
 
        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))){
104
106
      return p;
105
107
    }
106
108
  }
107
109
  /* Create a new plugin */
108
110
  plugin *new_plugin = malloc(sizeof(plugin));
109
 
  if (new_plugin == NULL){
 
111
  if(new_plugin == NULL){
110
112
    return NULL;
111
113
  }
112
114
  char *copy_name = NULL;
113
115
  if(name != NULL){
114
116
    copy_name = strdup(name);
115
117
    if(copy_name == NULL){
 
118
      free(new_plugin);
116
119
      return NULL;
117
120
    }
118
121
  }
119
122
  
120
 
  *new_plugin = (plugin) { .name = copy_name,
121
 
                           .argc = 1,
122
 
                           .disabled = false,
123
 
                           .next = plugin_list };
 
123
  *new_plugin = (plugin){ .name = copy_name,
 
124
                          .argc = 1,
 
125
                          .disabled = false,
 
126
                          .next = plugin_list };
124
127
  
125
128
  new_plugin->argv = malloc(sizeof(char *) * 2);
126
 
  if (new_plugin->argv == NULL){
 
129
  if(new_plugin->argv == NULL){
127
130
    free(copy_name);
128
131
    free(new_plugin);
129
132
    return NULL;
220
223
/* Mark processes as completed when they exit, and save their exit
221
224
   status. */
222
225
static void handle_sigchld(__attribute__((unused)) int sig){
 
226
  int old_errno = errno;
223
227
  while(true){
224
228
    plugin *proc = plugin_list;
225
229
    int status;
229
233
      break;
230
234
    }
231
235
    if(pid == -1){
232
 
      if (errno != ECHILD){
233
 
        perror("waitpid");
 
236
      if(errno == ECHILD){
 
237
        /* No child processes */
 
238
        break;
234
239
      }
235
 
      /* No child processes */
236
 
      break;
 
240
      perror("waitpid");
237
241
    }
238
242
    
239
243
    /* A child exited, find it in process_list */
245
249
      continue;
246
250
    }
247
251
    proc->status = status;
248
 
    proc->completed = true;
 
252
    proc->completed = 1;
249
253
  }
 
254
  errno = old_errno;
250
255
}
251
256
 
252
257
/* Prints out a password to stdout */
307
312
  struct dirent *dirst;
308
313
  struct stat st;
309
314
  fd_set rfds_all;
310
 
  int ret, maxfd = 0;
 
315
  int ret, numchars, maxfd = 0;
 
316
  ssize_t sret;
 
317
  intmax_t tmpmax;
311
318
  uid_t uid = 65534;
312
319
  gid_t gid = 65534;
313
320
  bool debug = false;
370
377
    { .name = NULL }
371
378
  };
372
379
  
373
 
  error_t parse_opt (int key, char *arg, __attribute__((unused))
374
 
                     struct argp_state *state) {
375
 
    switch (key) {
 
380
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
381
                    struct argp_state *state){
 
382
    switch(key){
376
383
    case 'g':                   /* --global-options */
377
 
      if (arg != NULL){
 
384
      if(arg != NULL){
378
385
        char *p;
379
386
        while((p = strsep(&arg, ",")) != NULL){
380
387
          if(p[0] == '\0'){
396
403
      }
397
404
      break;
398
405
    case 'o':                   /* --options-for */
399
 
      if (arg != NULL){
 
406
      if(arg != NULL){
400
407
        char *p_name = strsep(&arg, ":");
401
408
        if(p_name[0] == '\0' or arg == NULL){
402
409
          break;
433
440
      }
434
441
      break;
435
442
    case 'd':                   /* --disable */
436
 
      if (arg != NULL){
 
443
      if(arg != NULL){
437
444
        plugin *p = getplugin(arg);
438
445
        if(p == NULL){
439
446
          return ARGP_ERR_UNKNOWN;
442
449
      }
443
450
      break;
444
451
    case 'e':                   /* --enable */
445
 
      if (arg != NULL){
 
452
      if(arg != NULL){
446
453
        plugin *p = getplugin(arg);
447
454
        if(p == NULL){
448
455
          return ARGP_ERR_UNKNOWN;
461
468
      /* This is already done by parse_opt_config_file() */
462
469
      break;
463
470
    case 130:                   /* --userid */
464
 
      uid = (uid_t)strtol(arg, NULL, 10);
 
471
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
472
      if(ret < 1 or tmpmax != (uid_t)tmpmax
 
473
         or arg[numchars] != '\0'){
 
474
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
 
475
                PRIdMAX "\n", arg, (intmax_t)uid);
 
476
      } else {
 
477
        uid = (uid_t)tmpmax;
 
478
      }
465
479
      break;
466
480
    case 131:                   /* --groupid */
467
 
      gid = (gid_t)strtol(arg, NULL, 10);
 
481
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
482
      if(ret < 1 or tmpmax != (gid_t)tmpmax
 
483
         or arg[numchars] != '\0'){
 
484
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
 
485
                PRIdMAX "\n", arg, (intmax_t)gid);
 
486
      } else {
 
487
        gid = (gid_t)tmpmax;
 
488
      }
468
489
      break;
469
490
    case 132:                   /* --debug */
470
491
      debug = true;
471
492
      break;
 
493
/*
 
494
 * When adding more options before this line, remember to also add a
 
495
 * "case" to the "parse_opt_config_file" function below.
 
496
 */
472
497
    case ARGP_KEY_ARG:
473
498
      /* Cryptsetup always passes an argument, which is an empty
474
499
         string if "none" was specified in /etc/crypttab.  So if
487
512
  
488
513
  /* This option parser is the same as parse_opt() above, except it
489
514
     ignores everything but the --config-file option. */
490
 
  error_t parse_opt_config_file (int key, char *arg,
491
 
                                 __attribute__((unused))
492
 
                                 struct argp_state *state) {
493
 
    switch (key) {
 
515
  error_t parse_opt_config_file(int key, char *arg,
 
516
                                __attribute__((unused))
 
517
                                struct argp_state *state){
 
518
    switch(key){
494
519
    case 'g':                   /* --global-options */
495
520
    case 'G':                   /* --global-env */
496
521
    case 'o':                   /* --options-for */
523
548
                       .args_doc = "",
524
549
                       .doc = "Mandos plugin runner -- Run plugins" };
525
550
  
526
 
  /* Parse using the parse_opt_config_file in order to get the custom
 
551
  /* Parse using parse_opt_config_file() in order to get the custom
527
552
     config file location, if any. */
528
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
529
 
  if (ret == ARGP_ERR_UNKNOWN){
 
553
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
554
  if(ret == ARGP_ERR_UNKNOWN){
530
555
    fprintf(stderr, "Unknown error while parsing arguments\n");
531
556
    exitstatus = EXIT_FAILURE;
532
557
    goto fallback;
536
561
  argp.parser = parse_opt;
537
562
  
538
563
  /* Open the configfile if available */
539
 
  if (argfile == NULL){
 
564
  if(argfile == NULL){
540
565
    conffp = fopen(AFILE, "r");
541
566
  } else {
542
567
    conffp = fopen(argfile, "r");
545
570
    char *org_line = NULL;
546
571
    char *p, *arg, *new_arg, *line;
547
572
    size_t size = 0;
548
 
    ssize_t sret;
549
573
    const char whitespace_delims[] = " \r\t\f\v\n";
550
574
    const char comment_delim[] = "#";
551
575
 
598
622
  } else {
599
623
    /* Check for harmful errors and go to fallback. Other errors might
600
624
       not affect opening plugins */
601
 
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
625
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
602
626
      perror("fopen");
603
627
      exitstatus = EXIT_FAILURE;
604
628
      goto fallback;
607
631
  /* If there was any arguments from configuration file,
608
632
     pass them to parser as command arguments */
609
633
  if(custom_argv != NULL){
610
 
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
611
 
                      0, NULL);
612
 
    if (ret == ARGP_ERR_UNKNOWN){
 
634
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
635
                     0, NULL);
 
636
    if(ret == ARGP_ERR_UNKNOWN){
613
637
      fprintf(stderr, "Unknown error while parsing arguments\n");
614
638
      exitstatus = EXIT_FAILURE;
615
639
      goto fallback;
618
642
  
619
643
  /* Parse actual command line arguments, to let them override the
620
644
     config file */
621
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
622
 
  if (ret == ARGP_ERR_UNKNOWN){
 
645
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
646
  if(ret == ARGP_ERR_UNKNOWN){
623
647
    fprintf(stderr, "Unknown error while parsing arguments\n");
624
648
    exitstatus = EXIT_FAILURE;
625
649
    goto fallback;
632
656
      for(char **a = p->argv; *a != NULL; a++){
633
657
        fprintf(stderr, "\tArg: %s\n", *a);
634
658
      }
635
 
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
659
      fprintf(stderr, "...and %d environment variables\n", p->envc);
636
660
      for(char **a = p->environ; *a != NULL; a++){
637
661
        fprintf(stderr, "\t%s\n", *a);
638
662
      }
640
664
  }
641
665
  
642
666
  /* Strip permissions down to nobody */
 
667
  setgid(gid);
 
668
  if(ret == -1){
 
669
    perror("setgid");
 
670
  }
643
671
  ret = setuid(uid);
644
 
  if (ret == -1){
 
672
  if(ret == -1){
645
673
    perror("setuid");
646
 
  }  
647
 
  setgid(gid);
648
 
  if (ret == -1){
649
 
    perror("setgid");
650
674
  }
651
675
  
652
 
  if (plugindir == NULL){
 
676
  if(plugindir == NULL){
653
677
    dir = opendir(PDIR);
654
678
  } else {
655
679
    dir = opendir(plugindir);
682
706
    
683
707
    /* All directory entries have been processed */
684
708
    if(dirst == NULL){
685
 
      if (errno == EBADF){
 
709
      if(errno == EBADF){
686
710
        perror("readdir");
687
711
        exitstatus = EXIT_FAILURE;
688
712
        goto fallback;
700
724
      
701
725
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
702
726
                                           ".dpkg-old",
 
727
                                           ".dpkg-bak",
703
728
                                           ".dpkg-divert", NULL };
704
729
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
705
730
        size_t pre_len = strlen(*pre);
747
772
    }
748
773
    
749
774
    ret = stat(filename, &st);
750
 
    if (ret == -1){
 
775
    if(ret == -1){
751
776
      perror("stat");
752
777
      free(filename);
753
778
      continue;
754
779
    }
755
780
 
756
781
    /* Ignore non-executable files */
757
 
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
782
    if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
758
783
      if(debug){
759
784
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
760
785
                " with bad type or mode\n", filename);
807
832
    
808
833
    int pipefd[2];
809
834
    ret = pipe(pipefd);
810
 
    if (ret == -1){
 
835
    if(ret == -1){
811
836
      perror("pipe");
812
837
      exitstatus = EXIT_FAILURE;
813
838
      goto fallback;
826
851
      goto fallback;
827
852
    }
828
853
    /* Block SIGCHLD until process is safely in process list */
829
 
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
854
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
830
855
    if(ret < 0){
831
856
      perror("sigprocmask");
832
857
      exitstatus = EXIT_FAILURE;
846
871
        perror("sigaction");
847
872
        _exit(EXIT_FAILURE);
848
873
      }
849
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
874
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
850
875
      if(ret < 0){
851
876
        perror("sigprocmask");
852
877
        _exit(EXIT_FAILURE);
853
878
      }
854
 
 
 
879
      
855
880
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
856
881
      if(ret == -1){
857
882
        perror("dup2");
880
905
    close(pipefd[1]);           /* Close unused write end of pipe */
881
906
    free(filename);
882
907
    plugin *new_plugin = getplugin(dirst->d_name);
883
 
    if (new_plugin == NULL){
 
908
    if(new_plugin == NULL){
884
909
      perror("getplugin");
885
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
910
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
886
911
      if(ret < 0){
887
912
        perror("sigprocmask");
888
913
      }
895
920
    
896
921
    /* Unblock SIGCHLD so signal handler can be run if this process
897
922
       has already completed */
898
 
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
923
    ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
899
924
    if(ret < 0){
900
925
      perror("sigprocmask");
901
926
      exitstatus = EXIT_FAILURE;
904
929
    
905
930
    FD_SET(new_plugin->fd, &rfds_all);
906
931
    
907
 
    if (maxfd < new_plugin->fd){
 
932
    if(maxfd < new_plugin->fd){
908
933
      maxfd = new_plugin->fd;
909
934
    }
910
 
    
911
935
  }
912
936
  
913
937
  closedir(dir);
914
938
  dir = NULL;
915
 
 
 
939
  free_plugin(getplugin(NULL));
 
940
  
916
941
  for(plugin *p = plugin_list; p != NULL; p = p->next){
917
942
    if(p->pid != 0){
918
943
      break;
923
948
      free_plugin_list();
924
949
    }
925
950
  }
926
 
 
 
951
  
927
952
  /* Main loop while running plugins exist */
928
953
  while(plugin_list){
929
954
    fd_set rfds = rfds_all;
930
955
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
931
 
    if (select_ret == -1){
 
956
    if(select_ret == -1){
932
957
      perror("select");
933
958
      exitstatus = EXIT_FAILURE;
934
959
      goto fallback;
937
962
       from one of them */
938
963
    for(plugin *proc = plugin_list; proc != NULL;){
939
964
      /* Is this process completely done? */
940
 
      if(proc->eof and proc->completed){
 
965
      if(proc->completed and proc->eof){
941
966
        /* Only accept the plugin output if it exited cleanly */
942
967
        if(not WIFEXITED(proc->status)
943
968
           or WEXITSTATUS(proc->status) != 0){
945
970
 
946
971
          if(debug){
947
972
            if(WIFEXITED(proc->status)){
948
 
              fprintf(stderr, "Plugin %u exited with status %d\n",
949
 
                      (unsigned int) (proc->pid),
 
973
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
 
974
                      " status %d\n", proc->name,
 
975
                      (intmax_t) (proc->pid),
950
976
                      WEXITSTATUS(proc->status));
951
 
            } else if(WIFSIGNALED(proc->status)) {
952
 
              fprintf(stderr, "Plugin %u killed by signal %d\n",
953
 
                      (unsigned int) (proc->pid),
 
977
            } else if(WIFSIGNALED(proc->status)){
 
978
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
 
979
                      " signal %d\n", proc->name,
 
980
                      (intmax_t) (proc->pid),
954
981
                      WTERMSIG(proc->status));
955
982
            } else if(WCOREDUMP(proc->status)){
956
 
              fprintf(stderr, "Plugin %d dumped core\n",
957
 
                      (unsigned int) (proc->pid));
 
983
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
984
                      " core\n", proc->name, (intmax_t) (proc->pid));
958
985
            }
959
986
          }
960
987
          
969
996
            goto fallback;
970
997
          }
971
998
          
 
999
          plugin *next_plugin = proc->next;
 
1000
          free_plugin(proc);
 
1001
          proc = next_plugin;
 
1002
          
972
1003
          /* We are done modifying process list, so unblock signal */
973
 
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
974
 
                             NULL);
 
1004
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
1005
                            NULL);
975
1006
          if(ret < 0){
976
1007
            perror("sigprocmask");
977
1008
            exitstatus = EXIT_FAILURE;
982
1013
            break;
983
1014
          }
984
1015
          
985
 
          plugin *next_plugin = proc->next;
986
 
          free_plugin(proc);
987
 
          proc = next_plugin;
988
1016
          continue;
989
1017
        }
990
1018
        
991
1019
        /* This process exited nicely, so print its buffer */
992
 
 
 
1020
        
993
1021
        bool bret = print_out_password(proc->buffer,
994
1022
                                       proc->buffer_length);
995
1023
        if(not bret){
1009
1037
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1010
1038
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1011
1039
                               + (size_t) BUFFER_SIZE);
1012
 
        if (proc->buffer == NULL){
 
1040
        if(proc->buffer == NULL){
1013
1041
          perror("malloc");
1014
1042
          exitstatus = EXIT_FAILURE;
1015
1043
          goto fallback;
1017
1045
        proc->buffer_size += BUFFER_SIZE;
1018
1046
      }
1019
1047
      /* Read from the process */
1020
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1021
 
                 BUFFER_SIZE);
1022
 
      if(ret < 0){
 
1048
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1049
                  BUFFER_SIZE);
 
1050
      if(sret < 0){
1023
1051
        /* Read error from this process; ignore the error */
1024
1052
        proc = proc->next;
1025
1053
        continue;
1026
1054
      }
1027
 
      if(ret == 0){
 
1055
      if(sret == 0){
1028
1056
        /* got EOF */
1029
1057
        proc->eof = true;
1030
1058
      } else {
1031
 
        proc->buffer_length += (size_t) ret;
 
1059
        proc->buffer_length += (size_t) sret;
1032
1060
      }
1033
1061
    }
1034
1062
  }
1061
1089
    perror("sigaction");
1062
1090
    exitstatus = EXIT_FAILURE;
1063
1091
  }
1064
 
 
 
1092
  
1065
1093
  if(custom_argv != NULL){
1066
1094
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1067
1095
      free(*arg);
1073
1101
    closedir(dir);
1074
1102
  }
1075
1103
  
1076
 
  /* Free the process list and kill the processes */
 
1104
  /* Kill the processes */
1077
1105
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1078
1106
    if(p->pid != 0){
1079
1107
      close(p->fd);
1092
1120
  if(errno != ECHILD){
1093
1121
    perror("wait");
1094
1122
  }
1095
 
 
 
1123
  
1096
1124
  free_plugin_list();
1097
1125
  
1098
1126
  free(plugindir);