/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-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): 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,2009 Teddy Hogeborn
6
 
 * Copyright © 2008,2009 Björn Påhlsson
 
5
 * Copyright © 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
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
 
77
75
typedef struct plugin{
100
98
   or if none is found, creates a new one */
101
99
static plugin *getplugin(char *name){
102
100
  /* 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))){
 
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))){
106
104
      return p;
107
105
    }
108
106
  }
109
107
  /* Create a new plugin */
110
108
  plugin *new_plugin = malloc(sizeof(plugin));
111
 
  if(new_plugin == NULL){
 
109
  if (new_plugin == NULL){
112
110
    return NULL;
113
111
  }
114
112
  char *copy_name = NULL;
125
123
                           .next = plugin_list };
126
124
  
127
125
  new_plugin->argv = malloc(sizeof(char *) * 2);
128
 
  if(new_plugin->argv == NULL){
 
126
  if (new_plugin->argv == NULL){
129
127
    free(copy_name);
130
128
    free(new_plugin);
131
129
    return NULL;
231
229
      break;
232
230
    }
233
231
    if(pid == -1){
234
 
      if(errno != ECHILD){
 
232
      if (errno != ECHILD){
235
233
        perror("waitpid");
236
234
      }
237
235
      /* No child processes */
309
307
  struct dirent *dirst;
310
308
  struct stat st;
311
309
  fd_set rfds_all;
312
 
  int ret, numchars, maxfd = 0;
313
 
  ssize_t sret;
314
 
  intmax_t tmpmax;
 
310
  int ret, maxfd = 0;
315
311
  uid_t uid = 65534;
316
312
  gid_t gid = 65534;
317
313
  bool debug = false;
374
370
    { .name = NULL }
375
371
  };
376
372
  
377
 
  error_t parse_opt(int key, char *arg, __attribute__((unused))
378
 
                    struct argp_state *state) {
379
 
    switch(key) {
 
373
  error_t parse_opt (int key, char *arg, __attribute__((unused))
 
374
                     struct argp_state *state) {
 
375
    switch (key) {
380
376
    case 'g':                   /* --global-options */
381
 
      if(arg != NULL){
 
377
      if (arg != NULL){
382
378
        char *p;
383
379
        while((p = strsep(&arg, ",")) != NULL){
384
380
          if(p[0] == '\0'){
400
396
      }
401
397
      break;
402
398
    case 'o':                   /* --options-for */
403
 
      if(arg != NULL){
 
399
      if (arg != NULL){
404
400
        char *p_name = strsep(&arg, ":");
405
401
        if(p_name[0] == '\0' or arg == NULL){
406
402
          break;
437
433
      }
438
434
      break;
439
435
    case 'd':                   /* --disable */
440
 
      if(arg != NULL){
 
436
      if (arg != NULL){
441
437
        plugin *p = getplugin(arg);
442
438
        if(p == NULL){
443
439
          return ARGP_ERR_UNKNOWN;
446
442
      }
447
443
      break;
448
444
    case 'e':                   /* --enable */
449
 
      if(arg != NULL){
 
445
      if (arg != NULL){
450
446
        plugin *p = getplugin(arg);
451
447
        if(p == NULL){
452
448
          return ARGP_ERR_UNKNOWN;
465
461
      /* This is already done by parse_opt_config_file() */
466
462
      break;
467
463
    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
 
      }
 
464
      uid = (uid_t)strtol(arg, NULL, 10);
476
465
      break;
477
466
    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
 
      }
 
467
      gid = (gid_t)strtol(arg, NULL, 10);
486
468
      break;
487
469
    case 132:                   /* --debug */
488
470
      debug = true;
489
471
      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
472
    case ARGP_KEY_ARG:
495
473
      /* Cryptsetup always passes an argument, which is an empty
496
474
         string if "none" was specified in /etc/crypttab.  So if
509
487
  
510
488
  /* This option parser is the same as parse_opt() above, except it
511
489
     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) {
 
490
  error_t parse_opt_config_file (int key, char *arg,
 
491
                                 __attribute__((unused))
 
492
                                 struct argp_state *state) {
 
493
    switch (key) {
516
494
    case 'g':                   /* --global-options */
517
495
    case 'G':                   /* --global-env */
518
496
    case 'o':                   /* --options-for */
545
523
                       .args_doc = "",
546
524
                       .doc = "Mandos plugin runner -- Run plugins" };
547
525
  
548
 
  /* Parse using parse_opt_config_file() in order to get the custom
 
526
  /* Parse using the parse_opt_config_file in order to get the custom
549
527
     config file location, if any. */
550
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
551
 
  if(ret == ARGP_ERR_UNKNOWN){
 
528
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
529
  if (ret == ARGP_ERR_UNKNOWN){
552
530
    fprintf(stderr, "Unknown error while parsing arguments\n");
553
531
    exitstatus = EXIT_FAILURE;
554
532
    goto fallback;
558
536
  argp.parser = parse_opt;
559
537
  
560
538
  /* Open the configfile if available */
561
 
  if(argfile == NULL){
 
539
  if (argfile == NULL){
562
540
    conffp = fopen(AFILE, "r");
563
541
  } else {
564
542
    conffp = fopen(argfile, "r");
567
545
    char *org_line = NULL;
568
546
    char *p, *arg, *new_arg, *line;
569
547
    size_t size = 0;
 
548
    ssize_t sret;
570
549
    const char whitespace_delims[] = " \r\t\f\v\n";
571
550
    const char comment_delim[] = "#";
572
551
 
619
598
  } else {
620
599
    /* Check for harmful errors and go to fallback. Other errors might
621
600
       not affect opening plugins */
622
 
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
601
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
623
602
      perror("fopen");
624
603
      exitstatus = EXIT_FAILURE;
625
604
      goto fallback;
628
607
  /* If there was any arguments from configuration file,
629
608
     pass them to parser as command arguments */
630
609
  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){
 
610
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
611
                      0, NULL);
 
612
    if (ret == ARGP_ERR_UNKNOWN){
634
613
      fprintf(stderr, "Unknown error while parsing arguments\n");
635
614
      exitstatus = EXIT_FAILURE;
636
615
      goto fallback;
639
618
  
640
619
  /* Parse actual command line arguments, to let them override the
641
620
     config file */
642
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
643
 
  if(ret == ARGP_ERR_UNKNOWN){
 
621
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
622
  if (ret == ARGP_ERR_UNKNOWN){
644
623
    fprintf(stderr, "Unknown error while parsing arguments\n");
645
624
    exitstatus = EXIT_FAILURE;
646
625
    goto fallback;
653
632
      for(char **a = p->argv; *a != NULL; a++){
654
633
        fprintf(stderr, "\tArg: %s\n", *a);
655
634
      }
656
 
      fprintf(stderr, "...and %d environment variables\n", p->envc);
 
635
      fprintf(stderr, "...and %u environment variables\n", p->envc);
657
636
      for(char **a = p->environ; *a != NULL; a++){
658
637
        fprintf(stderr, "\t%s\n", *a);
659
638
      }
662
641
  
663
642
  /* Strip permissions down to nobody */
664
643
  ret = setuid(uid);
665
 
  if(ret == -1){
 
644
  if (ret == -1){
666
645
    perror("setuid");
667
646
  }  
668
647
  setgid(gid);
669
 
  if(ret == -1){
 
648
  if (ret == -1){
670
649
    perror("setgid");
671
650
  }
672
651
  
673
 
  if(plugindir == NULL){
 
652
  if (plugindir == NULL){
674
653
    dir = opendir(PDIR);
675
654
  } else {
676
655
    dir = opendir(plugindir);
703
682
    
704
683
    /* All directory entries have been processed */
705
684
    if(dirst == NULL){
706
 
      if(errno == EBADF){
 
685
      if (errno == EBADF){
707
686
        perror("readdir");
708
687
        exitstatus = EXIT_FAILURE;
709
688
        goto fallback;
721
700
      
722
701
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
723
702
                                           ".dpkg-old",
724
 
                                           ".dpkg-bak",
725
703
                                           ".dpkg-divert", NULL };
726
704
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
727
705
        size_t pre_len = strlen(*pre);
769
747
    }
770
748
    
771
749
    ret = stat(filename, &st);
772
 
    if(ret == -1){
 
750
    if (ret == -1){
773
751
      perror("stat");
774
752
      free(filename);
775
753
      continue;
776
754
    }
777
755
 
778
756
    /* Ignore non-executable files */
779
 
    if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
757
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
780
758
      if(debug){
781
759
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
782
760
                " with bad type or mode\n", filename);
829
807
    
830
808
    int pipefd[2];
831
809
    ret = pipe(pipefd);
832
 
    if(ret == -1){
 
810
    if (ret == -1){
833
811
      perror("pipe");
834
812
      exitstatus = EXIT_FAILURE;
835
813
      goto fallback;
848
826
      goto fallback;
849
827
    }
850
828
    /* Block SIGCHLD until process is safely in process list */
851
 
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
829
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
852
830
    if(ret < 0){
853
831
      perror("sigprocmask");
854
832
      exitstatus = EXIT_FAILURE;
902
880
    close(pipefd[1]);           /* Close unused write end of pipe */
903
881
    free(filename);
904
882
    plugin *new_plugin = getplugin(dirst->d_name);
905
 
    if(new_plugin == NULL){
 
883
    if (new_plugin == NULL){
906
884
      perror("getplugin");
907
 
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
885
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
908
886
      if(ret < 0){
909
887
        perror("sigprocmask");
910
888
      }
917
895
    
918
896
    /* Unblock SIGCHLD so signal handler can be run if this process
919
897
       has already completed */
920
 
    ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
898
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
921
899
    if(ret < 0){
922
900
      perror("sigprocmask");
923
901
      exitstatus = EXIT_FAILURE;
926
904
    
927
905
    FD_SET(new_plugin->fd, &rfds_all);
928
906
    
929
 
    if(maxfd < new_plugin->fd){
 
907
    if (maxfd < new_plugin->fd){
930
908
      maxfd = new_plugin->fd;
931
909
    }
932
910
  }
949
927
  while(plugin_list){
950
928
    fd_set rfds = rfds_all;
951
929
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
952
 
    if(select_ret == -1){
 
930
    if (select_ret == -1){
953
931
      perror("select");
954
932
      exitstatus = EXIT_FAILURE;
955
933
      goto fallback;
966
944
 
967
945
          if(debug){
968
946
            if(WIFEXITED(proc->status)){
969
 
              fprintf(stderr, "Plugin %" PRIdMAX " exited with status"
970
 
                      " %d\n", (intmax_t) (proc->pid),
 
947
              fprintf(stderr, "Plugin %u exited with status %d\n",
 
948
                      (unsigned int) (proc->pid),
971
949
                      WEXITSTATUS(proc->status));
972
950
            } else if(WIFSIGNALED(proc->status)) {
973
 
              fprintf(stderr, "Plugin %" PRIdMAX " killed by signal"
974
 
                      " %d\n", (intmax_t) (proc->pid),
 
951
              fprintf(stderr, "Plugin %u killed by signal %d\n",
 
952
                      (unsigned int) (proc->pid),
975
953
                      WTERMSIG(proc->status));
976
954
            } else if(WCOREDUMP(proc->status)){
977
 
              fprintf(stderr, "Plugin %" PRIdMAX " dumped core\n",
978
 
                      (intmax_t) (proc->pid));
 
955
              fprintf(stderr, "Plugin %d dumped core\n",
 
956
                      (unsigned int) (proc->pid));
979
957
            }
980
958
          }
981
959
          
995
973
          proc = next_plugin;
996
974
          
997
975
          /* We are done modifying process list, so unblock signal */
998
 
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
999
 
                            NULL);
 
976
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
 
977
                             NULL);
1000
978
          if(ret < 0){
1001
979
            perror("sigprocmask");
1002
980
            exitstatus = EXIT_FAILURE;
1031
1009
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1032
1010
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1033
1011
                               + (size_t) BUFFER_SIZE);
1034
 
        if(proc->buffer == NULL){
 
1012
        if (proc->buffer == NULL){
1035
1013
          perror("malloc");
1036
1014
          exitstatus = EXIT_FAILURE;
1037
1015
          goto fallback;
1039
1017
        proc->buffer_size += BUFFER_SIZE;
1040
1018
      }
1041
1019
      /* Read from the process */
1042
 
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
1043
 
                  BUFFER_SIZE);
1044
 
      if(sret < 0){
 
1020
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1021
                 BUFFER_SIZE);
 
1022
      if(ret < 0){
1045
1023
        /* Read error from this process; ignore the error */
1046
1024
        proc = proc->next;
1047
1025
        continue;
1048
1026
      }
1049
 
      if(sret == 0){
 
1027
      if(ret == 0){
1050
1028
        /* got EOF */
1051
1029
        proc->eof = true;
1052
1030
      } else {
1053
 
        proc->buffer_length += (size_t) sret;
 
1031
        proc->buffer_length += (size_t) ret;
1054
1032
      }
1055
1033
    }
1056
1034
  }