/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: 2008-09-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

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