/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

* README (The Plugin System): Improve 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 Teddy Hogeborn
6
 
 * Copyright © 2008 Björn Påhlsson
 
5
 * Copyright © 2008,2009 Teddy Hogeborn
 
6
 * Copyright © 2008,2009 Björn Påhlsson
7
7
 * 
8
8
 * This program is free software: you can redistribute it and/or
9
9
 * modify it under the terms of the GNU General Public License as
62
62
#include <signal.h>             /* struct sigaction, sigemptyset(),
63
63
                                   sigaddset(), sigaction(),
64
64
                                   sigprocmask(), SIG_BLOCK, SIGCHLD,
65
 
                                   SIG_UNBLOCK, kill() */
 
65
                                   SIG_UNBLOCK, kill(), sig_atomic_t
 
66
                                */
66
67
#include <errno.h>              /* errno, EBADF */
 
68
#include <inttypes.h>           /* intmax_t, PRIdMAX, strtoimax() */
67
69
 
68
70
#define BUFFER_SIZE 256
69
71
 
80
82
  char **environ;
81
83
  int envc;
82
84
  bool disabled;
83
 
 
 
85
  
84
86
  /* Variables used for running processes*/
85
87
  pid_t pid;
86
88
  int fd;
88
90
  size_t buffer_size;
89
91
  size_t buffer_length;
90
92
  bool eof;
91
 
  volatile bool completed;
92
 
  volatile int status;
 
93
  volatile sig_atomic_t completed;
 
94
  int status;
93
95
  struct plugin *next;
94
96
} plugin;
95
97
 
99
101
   or if none is found, creates a new one */
100
102
static plugin *getplugin(char *name){
101
103
  /* Check for exiting plugin with that name */
102
 
  for (plugin *p = plugin_list; p != NULL; p = p->next){
103
 
    if ((p->name == name)
104
 
        or (p->name and name and (strcmp(p->name, name) == 0))){
 
104
  for(plugin *p = plugin_list; p != NULL; p = p->next){
 
105
    if((p->name == name)
 
106
       or (p->name and name and (strcmp(p->name, name) == 0))){
105
107
      return p;
106
108
    }
107
109
  }
108
110
  /* Create a new plugin */
109
111
  plugin *new_plugin = malloc(sizeof(plugin));
110
 
  if (new_plugin == NULL){
 
112
  if(new_plugin == NULL){
111
113
    return NULL;
112
114
  }
113
115
  char *copy_name = NULL;
114
116
  if(name != NULL){
115
117
    copy_name = strdup(name);
116
118
    if(copy_name == NULL){
 
119
      free(new_plugin);
117
120
      return NULL;
118
121
    }
119
122
  }
120
123
  
121
 
  *new_plugin = (plugin) { .name = copy_name,
122
 
                           .argc = 1,
123
 
                           .disabled = false,
124
 
                           .next = plugin_list };
 
124
  *new_plugin = (plugin){ .name = copy_name,
 
125
                          .argc = 1,
 
126
                          .disabled = false,
 
127
                          .next = plugin_list };
125
128
  
126
129
  new_plugin->argv = malloc(sizeof(char *) * 2);
127
 
  if (new_plugin->argv == NULL){
 
130
  if(new_plugin->argv == NULL){
128
131
    free(copy_name);
129
132
    free(new_plugin);
130
133
    return NULL;
221
224
/* Mark processes as completed when they exit, and save their exit
222
225
   status. */
223
226
static void handle_sigchld(__attribute__((unused)) int sig){
 
227
  int old_errno = errno;
224
228
  while(true){
225
229
    plugin *proc = plugin_list;
226
230
    int status;
230
234
      break;
231
235
    }
232
236
    if(pid == -1){
233
 
      if (errno != ECHILD){
234
 
        perror("waitpid");
 
237
      if(errno == ECHILD){
 
238
        /* No child processes */
 
239
        break;
235
240
      }
236
 
      /* No child processes */
237
 
      break;
 
241
      perror("waitpid");
238
242
    }
239
243
    
240
244
    /* A child exited, find it in process_list */
246
250
      continue;
247
251
    }
248
252
    proc->status = status;
249
 
    proc->completed = true;
 
253
    proc->completed = 1;
250
254
  }
 
255
  errno = old_errno;
251
256
}
252
257
 
253
258
/* Prints out a password to stdout */
275
280
  }
276
281
  free(plugin_node->environ);
277
282
  free(plugin_node->buffer);
278
 
 
 
283
  
279
284
  /* Removes the plugin from the singly-linked list */
280
285
  if(plugin_node == plugin_list){
281
286
    /* First one - simple */
309
314
  struct stat st;
310
315
  fd_set rfds_all;
311
316
  int ret, maxfd = 0;
 
317
  ssize_t sret;
 
318
  intmax_t tmpmax;
312
319
  uid_t uid = 65534;
313
320
  gid_t gid = 65534;
314
321
  bool debug = false;
371
378
    { .name = NULL }
372
379
  };
373
380
  
374
 
  error_t parse_opt (int key, char *arg, __attribute__((unused))
375
 
                     struct argp_state *state) {
376
 
    switch (key) {
 
381
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
382
                    struct argp_state *state){
 
383
    char *tmp;
 
384
    switch(key){
377
385
    case 'g':                   /* --global-options */
378
 
      if (arg != NULL){
379
 
        char *p;
380
 
        while((p = strsep(&arg, ",")) != NULL){
381
 
          if(p[0] == '\0'){
 
386
      if(arg != NULL){
 
387
        char *plugin_option;
 
388
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
389
          if(plugin_option[0] == '\0'){
382
390
            continue;
383
391
          }
384
 
          if(not add_argument(getplugin(NULL), p)){
 
392
          if(not add_argument(getplugin(NULL), plugin_option)){
385
393
            perror("add_argument");
386
394
            return ARGP_ERR_UNKNOWN;
387
395
          }
397
405
      }
398
406
      break;
399
407
    case 'o':                   /* --options-for */
400
 
      if (arg != NULL){
401
 
        char *p_name = strsep(&arg, ":");
402
 
        if(p_name[0] == '\0' or arg == NULL){
403
 
          break;
404
 
        }
405
 
        char *opt = strsep(&arg, ":");
406
 
        if(opt[0] == '\0' or opt == NULL){
407
 
          break;
408
 
        }
409
 
        char *p;
410
 
        while((p = strsep(&opt, ",")) != NULL){
411
 
          if(p[0] == '\0'){
412
 
            continue;
413
 
          }
414
 
          if(not add_argument(getplugin(p_name), p)){
 
408
      if(arg != NULL){
 
409
        char *plugin_name = strsep(&arg, ":");
 
410
        if(plugin_name[0] == '\0'){
 
411
          break;
 
412
        }
 
413
        char *plugin_option;
 
414
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
415
          if(not add_argument(getplugin(plugin_name), plugin_option)){
415
416
            perror("add_argument");
416
417
            return ARGP_ERR_UNKNOWN;
417
418
          }
434
435
      }
435
436
      break;
436
437
    case 'd':                   /* --disable */
437
 
      if (arg != NULL){
 
438
      if(arg != NULL){
438
439
        plugin *p = getplugin(arg);
439
440
        if(p == NULL){
440
441
          return ARGP_ERR_UNKNOWN;
443
444
      }
444
445
      break;
445
446
    case 'e':                   /* --enable */
446
 
      if (arg != NULL){
 
447
      if(arg != NULL){
447
448
        plugin *p = getplugin(arg);
448
449
        if(p == NULL){
449
450
          return ARGP_ERR_UNKNOWN;
462
463
      /* This is already done by parse_opt_config_file() */
463
464
      break;
464
465
    case 130:                   /* --userid */
465
 
      uid = (uid_t)strtol(arg, NULL, 10);
 
466
      errno = 0;
 
467
      tmpmax = strtoimax(arg, &tmp, 10);
 
468
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
469
         or tmpmax != (uid_t)tmpmax){
 
470
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
 
471
                PRIdMAX "\n", arg, (intmax_t)uid);
 
472
      } else {
 
473
        uid = (uid_t)tmpmax;
 
474
      }
466
475
      break;
467
476
    case 131:                   /* --groupid */
468
 
      gid = (gid_t)strtol(arg, NULL, 10);
 
477
      errno = 0;
 
478
      tmpmax = strtoimax(arg, &tmp, 10);
 
479
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
480
         or tmpmax != (gid_t)tmpmax){
 
481
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
 
482
                PRIdMAX "\n", arg, (intmax_t)gid);
 
483
      } else {
 
484
        gid = (gid_t)tmpmax;
 
485
      }
469
486
      break;
470
487
    case 132:                   /* --debug */
471
488
      debug = true;
472
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
 */
473
494
    case ARGP_KEY_ARG:
474
495
      /* Cryptsetup always passes an argument, which is an empty
475
496
         string if "none" was specified in /etc/crypttab.  So if
488
509
  
489
510
  /* This option parser is the same as parse_opt() above, except it
490
511
     ignores everything but the --config-file option. */
491
 
  error_t parse_opt_config_file (int key, char *arg,
492
 
                                 __attribute__((unused))
493
 
                                 struct argp_state *state) {
494
 
    switch (key) {
 
512
  error_t parse_opt_config_file(int key, char *arg,
 
513
                                __attribute__((unused))
 
514
                                struct argp_state *state){
 
515
    switch(key){
495
516
    case 'g':                   /* --global-options */
496
517
    case 'G':                   /* --global-env */
497
518
    case 'o':                   /* --options-for */
524
545
                       .args_doc = "",
525
546
                       .doc = "Mandos plugin runner -- Run plugins" };
526
547
  
527
 
  /* 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
528
549
     config file location, if any. */
529
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
530
 
  if (ret == ARGP_ERR_UNKNOWN){
 
550
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
551
  if(ret == ARGP_ERR_UNKNOWN){
531
552
    fprintf(stderr, "Unknown error while parsing arguments\n");
532
553
    exitstatus = EXIT_FAILURE;
533
554
    goto fallback;
537
558
  argp.parser = parse_opt;
538
559
  
539
560
  /* Open the configfile if available */
540
 
  if (argfile == NULL){
 
561
  if(argfile == NULL){
541
562
    conffp = fopen(AFILE, "r");
542
563
  } else {
543
564
    conffp = fopen(argfile, "r");
546
567
    char *org_line = NULL;
547
568
    char *p, *arg, *new_arg, *line;
548
569
    size_t size = 0;
549
 
    ssize_t sret;
550
570
    const char whitespace_delims[] = " \r\t\f\v\n";
551
571
    const char comment_delim[] = "#";
552
 
 
 
572
    
553
573
    custom_argc = 1;
554
574
    custom_argv = malloc(sizeof(char*) * 2);
555
575
    if(custom_argv == NULL){
559
579
    }
560
580
    custom_argv[0] = argv[0];
561
581
    custom_argv[1] = NULL;
562
 
 
 
582
    
563
583
    /* for each line in the config file, strip whitespace and ignore
564
584
       commented text */
565
585
    while(true){
567
587
      if(sret == -1){
568
588
        break;
569
589
      }
570
 
 
 
590
      
571
591
      line = org_line;
572
592
      arg = strsep(&line, comment_delim);
573
593
      while((p = strsep(&arg, whitespace_delims)) != NULL){
599
619
  } else {
600
620
    /* Check for harmful errors and go to fallback. Other errors might
601
621
       not affect opening plugins */
602
 
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
622
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
603
623
      perror("fopen");
604
624
      exitstatus = EXIT_FAILURE;
605
625
      goto fallback;
608
628
  /* If there was any arguments from configuration file,
609
629
     pass them to parser as command arguments */
610
630
  if(custom_argv != NULL){
611
 
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
612
 
                      0, NULL);
613
 
    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){
614
634
      fprintf(stderr, "Unknown error while parsing arguments\n");
615
635
      exitstatus = EXIT_FAILURE;
616
636
      goto fallback;
619
639
  
620
640
  /* Parse actual command line arguments, to let them override the
621
641
     config file */
622
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
623
 
  if (ret == ARGP_ERR_UNKNOWN){
 
642
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
643
  if(ret == ARGP_ERR_UNKNOWN){
624
644
    fprintf(stderr, "Unknown error while parsing arguments\n");
625
645
    exitstatus = EXIT_FAILURE;
626
646
    goto fallback;
633
653
      for(char **a = p->argv; *a != NULL; a++){
634
654
        fprintf(stderr, "\tArg: %s\n", *a);
635
655
      }
636
 
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
656
      fprintf(stderr, "...and %d environment variables\n", p->envc);
637
657
      for(char **a = p->environ; *a != NULL; a++){
638
658
        fprintf(stderr, "\t%s\n", *a);
639
659
      }
641
661
  }
642
662
  
643
663
  /* Strip permissions down to nobody */
 
664
  setgid(gid);
 
665
  if(ret == -1){
 
666
    perror("setgid");
 
667
  }
644
668
  ret = setuid(uid);
645
 
  if (ret == -1){
 
669
  if(ret == -1){
646
670
    perror("setuid");
647
 
  }  
648
 
  setgid(gid);
649
 
  if (ret == -1){
650
 
    perror("setgid");
651
671
  }
652
672
  
653
 
  if (plugindir == NULL){
 
673
  if(plugindir == NULL){
654
674
    dir = opendir(PDIR);
655
675
  } else {
656
676
    dir = opendir(plugindir);
683
703
    
684
704
    /* All directory entries have been processed */
685
705
    if(dirst == NULL){
686
 
      if (errno == EBADF){
 
706
      if(errno == EBADF){
687
707
        perror("readdir");
688
708
        exitstatus = EXIT_FAILURE;
689
709
        goto fallback;
736
756
        continue;
737
757
      }
738
758
    }
739
 
 
 
759
    
740
760
    char *filename;
741
761
    if(plugindir == NULL){
742
762
      ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
749
769
    }
750
770
    
751
771
    ret = stat(filename, &st);
752
 
    if (ret == -1){
 
772
    if(ret == -1){
753
773
      perror("stat");
754
774
      free(filename);
755
775
      continue;
756
776
    }
757
 
 
 
777
    
758
778
    /* Ignore non-executable files */
759
 
    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)){
760
780
      if(debug){
761
781
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
762
782
                " with bad type or mode\n", filename);
809
829
    
810
830
    int pipefd[2];
811
831
    ret = pipe(pipefd);
812
 
    if (ret == -1){
 
832
    if(ret == -1){
813
833
      perror("pipe");
814
834
      exitstatus = EXIT_FAILURE;
815
835
      goto fallback;
828
848
      goto fallback;
829
849
    }
830
850
    /* Block SIGCHLD until process is safely in process list */
831
 
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
851
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
832
852
    if(ret < 0){
833
853
      perror("sigprocmask");
834
854
      exitstatus = EXIT_FAILURE;
882
902
    close(pipefd[1]);           /* Close unused write end of pipe */
883
903
    free(filename);
884
904
    plugin *new_plugin = getplugin(dirst->d_name);
885
 
    if (new_plugin == NULL){
 
905
    if(new_plugin == NULL){
886
906
      perror("getplugin");
887
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
907
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
888
908
      if(ret < 0){
889
909
        perror("sigprocmask");
890
910
      }
897
917
    
898
918
    /* Unblock SIGCHLD so signal handler can be run if this process
899
919
       has already completed */
900
 
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
920
    ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
901
921
    if(ret < 0){
902
922
      perror("sigprocmask");
903
923
      exitstatus = EXIT_FAILURE;
906
926
    
907
927
    FD_SET(new_plugin->fd, &rfds_all);
908
928
    
909
 
    if (maxfd < new_plugin->fd){
 
929
    if(maxfd < new_plugin->fd){
910
930
      maxfd = new_plugin->fd;
911
931
    }
912
932
  }
913
933
  
914
934
  closedir(dir);
915
935
  dir = NULL;
 
936
  free_plugin(getplugin(NULL));
916
937
  
917
938
  for(plugin *p = plugin_list; p != NULL; p = p->next){
918
939
    if(p->pid != 0){
929
950
  while(plugin_list){
930
951
    fd_set rfds = rfds_all;
931
952
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
932
 
    if (select_ret == -1){
 
953
    if(select_ret == -1){
933
954
      perror("select");
934
955
      exitstatus = EXIT_FAILURE;
935
956
      goto fallback;
938
959
       from one of them */
939
960
    for(plugin *proc = plugin_list; proc != NULL;){
940
961
      /* Is this process completely done? */
941
 
      if(proc->eof and proc->completed){
 
962
      if(proc->completed and proc->eof){
942
963
        /* Only accept the plugin output if it exited cleanly */
943
964
        if(not WIFEXITED(proc->status)
944
965
           or WEXITSTATUS(proc->status) != 0){
945
966
          /* Bad exit by plugin */
946
 
 
 
967
          
947
968
          if(debug){
948
969
            if(WIFEXITED(proc->status)){
949
 
              fprintf(stderr, "Plugin %u exited with status %d\n",
950
 
                      (unsigned int) (proc->pid),
 
970
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
 
971
                      " status %d\n", proc->name,
 
972
                      (intmax_t) (proc->pid),
951
973
                      WEXITSTATUS(proc->status));
952
 
            } else if(WIFSIGNALED(proc->status)) {
953
 
              fprintf(stderr, "Plugin %u killed by signal %d\n",
954
 
                      (unsigned int) (proc->pid),
 
974
            } else if(WIFSIGNALED(proc->status)){
 
975
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
 
976
                      " signal %d\n", proc->name,
 
977
                      (intmax_t) (proc->pid),
955
978
                      WTERMSIG(proc->status));
956
979
            } else if(WCOREDUMP(proc->status)){
957
 
              fprintf(stderr, "Plugin %d dumped core\n",
958
 
                      (unsigned int) (proc->pid));
 
980
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
981
                      " core\n", proc->name, (intmax_t) (proc->pid));
959
982
            }
960
983
          }
961
984
          
962
985
          /* Remove the plugin */
963
986
          FD_CLR(proc->fd, &rfds_all);
964
 
 
 
987
          
965
988
          /* Block signal while modifying process_list */
966
989
          ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
967
990
          if(ret < 0){
975
998
          proc = next_plugin;
976
999
          
977
1000
          /* We are done modifying process list, so unblock signal */
978
 
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
979
 
                             NULL);
 
1001
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
1002
                            NULL);
980
1003
          if(ret < 0){
981
1004
            perror("sigprocmask");
982
1005
            exitstatus = EXIT_FAILURE;
1011
1034
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1012
1035
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1013
1036
                               + (size_t) BUFFER_SIZE);
1014
 
        if (proc->buffer == NULL){
 
1037
        if(proc->buffer == NULL){
1015
1038
          perror("malloc");
1016
1039
          exitstatus = EXIT_FAILURE;
1017
1040
          goto fallback;
1019
1042
        proc->buffer_size += BUFFER_SIZE;
1020
1043
      }
1021
1044
      /* Read from the process */
1022
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1023
 
                 BUFFER_SIZE);
1024
 
      if(ret < 0){
 
1045
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1046
                  BUFFER_SIZE);
 
1047
      if(sret < 0){
1025
1048
        /* Read error from this process; ignore the error */
1026
1049
        proc = proc->next;
1027
1050
        continue;
1028
1051
      }
1029
 
      if(ret == 0){
 
1052
      if(sret == 0){
1030
1053
        /* got EOF */
1031
1054
        proc->eof = true;
1032
1055
      } else {
1033
 
        proc->buffer_length += (size_t) ret;
 
1056
        proc->buffer_length += (size_t) sret;
1034
1057
      }
1035
1058
    }
1036
1059
  }
1037
 
 
1038
 
 
 
1060
  
 
1061
  
1039
1062
 fallback:
1040
1063
  
1041
1064
  if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){