/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugin-runner.c

* debian/mandos-client.lintian-overrides: Remove override for
                                          unbreakable line in
                                          plugin-runner manual page.
* plugin-runner.xml (EXAMPLES): Make long command line more breakable.

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