/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
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
64
64
                                   sigprocmask(), SIG_BLOCK, SIGCHLD,
65
65
                                   SIG_UNBLOCK, kill() */
66
66
#include <errno.h>              /* errno, EBADF */
 
67
#include <inttypes.h>           /* intmax_t, SCNdMAX, PRIdMAX,  */
67
68
 
68
69
#define BUFFER_SIZE 256
69
70
 
99
100
   or if none is found, creates a new one */
100
101
static plugin *getplugin(char *name){
101
102
  /* 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))){
 
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))){
105
106
      return p;
106
107
    }
107
108
  }
108
109
  /* Create a new plugin */
109
110
  plugin *new_plugin = malloc(sizeof(plugin));
110
 
  if (new_plugin == NULL){
 
111
  if(new_plugin == NULL){
111
112
    return NULL;
112
113
  }
113
114
  char *copy_name = NULL;
114
115
  if(name != NULL){
115
116
    copy_name = strdup(name);
116
117
    if(copy_name == NULL){
 
118
      free(new_plugin);
117
119
      return NULL;
118
120
    }
119
121
  }
124
126
                           .next = plugin_list };
125
127
  
126
128
  new_plugin->argv = malloc(sizeof(char *) * 2);
127
 
  if (new_plugin->argv == NULL){
 
129
  if(new_plugin->argv == NULL){
128
130
    free(copy_name);
129
131
    free(new_plugin);
130
132
    return NULL;
230
232
      break;
231
233
    }
232
234
    if(pid == -1){
233
 
      if (errno != ECHILD){
 
235
      if(errno != ECHILD){
234
236
        perror("waitpid");
235
237
      }
236
238
      /* No child processes */
308
310
  struct dirent *dirst;
309
311
  struct stat st;
310
312
  fd_set rfds_all;
311
 
  int ret, maxfd = 0;
 
313
  int ret, numchars, maxfd = 0;
 
314
  ssize_t sret;
 
315
  intmax_t tmpmax;
312
316
  uid_t uid = 65534;
313
317
  gid_t gid = 65534;
314
318
  bool debug = false;
371
375
    { .name = NULL }
372
376
  };
373
377
  
374
 
  error_t parse_opt (int key, char *arg, __attribute__((unused))
375
 
                     struct argp_state *state) {
376
 
    switch (key) {
 
378
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
379
                    struct argp_state *state) {
 
380
    switch(key) {
377
381
    case 'g':                   /* --global-options */
378
 
      if (arg != NULL){
 
382
      if(arg != NULL){
379
383
        char *p;
380
384
        while((p = strsep(&arg, ",")) != NULL){
381
385
          if(p[0] == '\0'){
397
401
      }
398
402
      break;
399
403
    case 'o':                   /* --options-for */
400
 
      if (arg != NULL){
 
404
      if(arg != NULL){
401
405
        char *p_name = strsep(&arg, ":");
402
406
        if(p_name[0] == '\0' or arg == NULL){
403
407
          break;
434
438
      }
435
439
      break;
436
440
    case 'd':                   /* --disable */
437
 
      if (arg != NULL){
 
441
      if(arg != NULL){
438
442
        plugin *p = getplugin(arg);
439
443
        if(p == NULL){
440
444
          return ARGP_ERR_UNKNOWN;
443
447
      }
444
448
      break;
445
449
    case 'e':                   /* --enable */
446
 
      if (arg != NULL){
 
450
      if(arg != NULL){
447
451
        plugin *p = getplugin(arg);
448
452
        if(p == NULL){
449
453
          return ARGP_ERR_UNKNOWN;
462
466
      /* This is already done by parse_opt_config_file() */
463
467
      break;
464
468
    case 130:                   /* --userid */
465
 
      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
      }
466
477
      break;
467
478
    case 131:                   /* --groupid */
468
 
      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
      }
469
487
      break;
470
488
    case 132:                   /* --debug */
471
489
      debug = true;
472
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
 */
473
495
    case ARGP_KEY_ARG:
474
496
      /* Cryptsetup always passes an argument, which is an empty
475
497
         string if "none" was specified in /etc/crypttab.  So if
488
510
  
489
511
  /* This option parser is the same as parse_opt() above, except it
490
512
     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) {
 
513
  error_t parse_opt_config_file(int key, char *arg,
 
514
                                __attribute__((unused))
 
515
                                struct argp_state *state) {
 
516
    switch(key) {
495
517
    case 'g':                   /* --global-options */
496
518
    case 'G':                   /* --global-env */
497
519
    case 'o':                   /* --options-for */
524
546
                       .args_doc = "",
525
547
                       .doc = "Mandos plugin runner -- Run plugins" };
526
548
  
527
 
  /* 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
528
550
     config file location, if any. */
529
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
530
 
  if (ret == ARGP_ERR_UNKNOWN){
 
551
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
552
  if(ret == ARGP_ERR_UNKNOWN){
531
553
    fprintf(stderr, "Unknown error while parsing arguments\n");
532
554
    exitstatus = EXIT_FAILURE;
533
555
    goto fallback;
537
559
  argp.parser = parse_opt;
538
560
  
539
561
  /* Open the configfile if available */
540
 
  if (argfile == NULL){
 
562
  if(argfile == NULL){
541
563
    conffp = fopen(AFILE, "r");
542
564
  } else {
543
565
    conffp = fopen(argfile, "r");
546
568
    char *org_line = NULL;
547
569
    char *p, *arg, *new_arg, *line;
548
570
    size_t size = 0;
549
 
    ssize_t sret;
550
571
    const char whitespace_delims[] = " \r\t\f\v\n";
551
572
    const char comment_delim[] = "#";
552
573
 
599
620
  } else {
600
621
    /* Check for harmful errors and go to fallback. Other errors might
601
622
       not affect opening plugins */
602
 
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
623
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
603
624
      perror("fopen");
604
625
      exitstatus = EXIT_FAILURE;
605
626
      goto fallback;
608
629
  /* If there was any arguments from configuration file,
609
630
     pass them to parser as command arguments */
610
631
  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){
 
632
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
633
                     0, NULL);
 
634
    if(ret == ARGP_ERR_UNKNOWN){
614
635
      fprintf(stderr, "Unknown error while parsing arguments\n");
615
636
      exitstatus = EXIT_FAILURE;
616
637
      goto fallback;
619
640
  
620
641
  /* Parse actual command line arguments, to let them override the
621
642
     config file */
622
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
623
 
  if (ret == ARGP_ERR_UNKNOWN){
 
643
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
644
  if(ret == ARGP_ERR_UNKNOWN){
624
645
    fprintf(stderr, "Unknown error while parsing arguments\n");
625
646
    exitstatus = EXIT_FAILURE;
626
647
    goto fallback;
633
654
      for(char **a = p->argv; *a != NULL; a++){
634
655
        fprintf(stderr, "\tArg: %s\n", *a);
635
656
      }
636
 
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
657
      fprintf(stderr, "...and %d environment variables\n", p->envc);
637
658
      for(char **a = p->environ; *a != NULL; a++){
638
659
        fprintf(stderr, "\t%s\n", *a);
639
660
      }
642
663
  
643
664
  /* Strip permissions down to nobody */
644
665
  ret = setuid(uid);
645
 
  if (ret == -1){
 
666
  if(ret == -1){
646
667
    perror("setuid");
647
668
  }  
648
669
  setgid(gid);
649
 
  if (ret == -1){
 
670
  if(ret == -1){
650
671
    perror("setgid");
651
672
  }
652
673
  
653
 
  if (plugindir == NULL){
 
674
  if(plugindir == NULL){
654
675
    dir = opendir(PDIR);
655
676
  } else {
656
677
    dir = opendir(plugindir);
683
704
    
684
705
    /* All directory entries have been processed */
685
706
    if(dirst == NULL){
686
 
      if (errno == EBADF){
 
707
      if(errno == EBADF){
687
708
        perror("readdir");
688
709
        exitstatus = EXIT_FAILURE;
689
710
        goto fallback;
749
770
    }
750
771
    
751
772
    ret = stat(filename, &st);
752
 
    if (ret == -1){
 
773
    if(ret == -1){
753
774
      perror("stat");
754
775
      free(filename);
755
776
      continue;
756
777
    }
757
778
 
758
779
    /* Ignore non-executable files */
759
 
    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)){
760
781
      if(debug){
761
782
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
762
783
                " with bad type or mode\n", filename);
809
830
    
810
831
    int pipefd[2];
811
832
    ret = pipe(pipefd);
812
 
    if (ret == -1){
 
833
    if(ret == -1){
813
834
      perror("pipe");
814
835
      exitstatus = EXIT_FAILURE;
815
836
      goto fallback;
828
849
      goto fallback;
829
850
    }
830
851
    /* Block SIGCHLD until process is safely in process list */
831
 
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
852
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
832
853
    if(ret < 0){
833
854
      perror("sigprocmask");
834
855
      exitstatus = EXIT_FAILURE;
882
903
    close(pipefd[1]);           /* Close unused write end of pipe */
883
904
    free(filename);
884
905
    plugin *new_plugin = getplugin(dirst->d_name);
885
 
    if (new_plugin == NULL){
 
906
    if(new_plugin == NULL){
886
907
      perror("getplugin");
887
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
908
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
888
909
      if(ret < 0){
889
910
        perror("sigprocmask");
890
911
      }
897
918
    
898
919
    /* Unblock SIGCHLD so signal handler can be run if this process
899
920
       has already completed */
900
 
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
921
    ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
901
922
    if(ret < 0){
902
923
      perror("sigprocmask");
903
924
      exitstatus = EXIT_FAILURE;
906
927
    
907
928
    FD_SET(new_plugin->fd, &rfds_all);
908
929
    
909
 
    if (maxfd < new_plugin->fd){
 
930
    if(maxfd < new_plugin->fd){
910
931
      maxfd = new_plugin->fd;
911
932
    }
912
933
  }
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;
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 %" PRIdMAX " exited with status"
 
971
                      " %d\n", (intmax_t) (proc->pid),
951
972
                      WEXITSTATUS(proc->status));
952
973
            } else if(WIFSIGNALED(proc->status)) {
953
 
              fprintf(stderr, "Plugin %u killed by signal %d\n",
954
 
                      (unsigned int) (proc->pid),
 
974
              fprintf(stderr, "Plugin %" PRIdMAX " killed by signal"
 
975
                      " %d\n", (intmax_t) (proc->pid),
955
976
                      WTERMSIG(proc->status));
956
977
            } else if(WCOREDUMP(proc->status)){
957
 
              fprintf(stderr, "Plugin %d dumped core\n",
958
 
                      (unsigned int) (proc->pid));
 
978
              fprintf(stderr, "Plugin %" PRIdMAX " dumped core\n",
 
979
                      (intmax_t) (proc->pid));
959
980
            }
960
981
          }
961
982
          
975
996
          proc = next_plugin;
976
997
          
977
998
          /* We are done modifying process list, so unblock signal */
978
 
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
979
 
                             NULL);
 
999
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
1000
                            NULL);
980
1001
          if(ret < 0){
981
1002
            perror("sigprocmask");
982
1003
            exitstatus = EXIT_FAILURE;
1011
1032
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1012
1033
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1013
1034
                               + (size_t) BUFFER_SIZE);
1014
 
        if (proc->buffer == NULL){
 
1035
        if(proc->buffer == NULL){
1015
1036
          perror("malloc");
1016
1037
          exitstatus = EXIT_FAILURE;
1017
1038
          goto fallback;
1019
1040
        proc->buffer_size += BUFFER_SIZE;
1020
1041
      }
1021
1042
      /* Read from the process */
1022
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1023
 
                 BUFFER_SIZE);
1024
 
      if(ret < 0){
 
1043
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1044
                  BUFFER_SIZE);
 
1045
      if(sret < 0){
1025
1046
        /* Read error from this process; ignore the error */
1026
1047
        proc = proc->next;
1027
1048
        continue;
1028
1049
      }
1029
 
      if(ret == 0){
 
1050
      if(sret == 0){
1030
1051
        /* got EOF */
1031
1052
        proc->eof = true;
1032
1053
      } else {
1033
 
        proc->buffer_length += (size_t) ret;
 
1054
        proc->buffer_length += (size_t) sret;
1034
1055
      }
1035
1056
    }
1036
1057
  }