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