/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: 2009-01-13 04:35:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090113043519-0yr39snphoegq8l1
* plugin-runner.c: Only space changes.
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -

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,
69
70
#define PDIR "/lib/mandos/plugins.d"
70
71
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
71
72
 
72
 
const char *argp_program_version = "plugin-runner 1.0";
 
73
const char *argp_program_version = "plugin-runner " VERSION;
73
74
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
74
75
 
75
 
struct plugin;
76
 
 
77
76
typedef struct plugin{
78
77
  char *name;                   /* can be NULL or any plugin name */
79
78
  char **argv;
100
99
   or if none is found, creates a new one */
101
100
static plugin *getplugin(char *name){
102
101
  /* 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))){
 
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))){
106
105
      return p;
107
106
    }
108
107
  }
109
108
  /* Create a new plugin */
110
109
  plugin *new_plugin = malloc(sizeof(plugin));
111
 
  if (new_plugin == NULL){
 
110
  if(new_plugin == NULL){
112
111
    return NULL;
113
112
  }
114
113
  char *copy_name = NULL;
125
124
                           .next = plugin_list };
126
125
  
127
126
  new_plugin->argv = malloc(sizeof(char *) * 2);
128
 
  if (new_plugin->argv == NULL){
 
127
  if(new_plugin->argv == NULL){
129
128
    free(copy_name);
130
129
    free(new_plugin);
131
130
    return NULL;
208
207
 * Descriptor Flags".
209
208
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
210
209
 */
211
 
static int set_cloexec_flag(int fd)
212
 
{
 
210
static int set_cloexec_flag(int fd){
213
211
  int ret = fcntl(fd, F_GETFD, 0);
214
212
  /* If reading the flags failed, return error indication now. */
215
213
  if(ret < 0){
222
220
 
223
221
/* Mark processes as completed when they exit, and save their exit
224
222
   status. */
225
 
void handle_sigchld(__attribute__((unused)) int sig){
 
223
static void handle_sigchld(__attribute__((unused)) int sig){
226
224
  while(true){
227
225
    plugin *proc = plugin_list;
228
226
    int status;
232
230
      break;
233
231
    }
234
232
    if(pid == -1){
235
 
      if (errno != ECHILD){
 
233
      if(errno != ECHILD){
236
234
        perror("waitpid");
237
235
      }
238
236
      /* No child processes */
253
251
}
254
252
 
255
253
/* Prints out a password to stdout */
256
 
bool print_out_password(const char *buffer, size_t length){
 
254
static bool print_out_password(const char *buffer, size_t length){
257
255
  ssize_t ret;
258
256
  for(size_t written = 0; written < length; written += (size_t)ret){
259
257
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
311
309
  struct stat st;
312
310
  fd_set rfds_all;
313
311
  int ret, maxfd = 0;
 
312
  ssize_t sret;
314
313
  uid_t uid = 65534;
315
314
  gid_t gid = 65534;
316
315
  bool debug = false;
373
372
    { .name = NULL }
374
373
  };
375
374
  
376
 
  error_t parse_opt (int key, char *arg, __attribute__((unused))
377
 
                     struct argp_state *state) {
378
 
    switch (key) {
 
375
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
376
                    struct argp_state *state) {
 
377
    switch(key) {
379
378
    case 'g':                   /* --global-options */
380
 
      if (arg != NULL){
 
379
      if(arg != NULL){
381
380
        char *p;
382
381
        while((p = strsep(&arg, ",")) != NULL){
383
382
          if(p[0] == '\0'){
394
393
      if(arg == NULL){
395
394
        break;
396
395
      }
397
 
      {
398
 
        char *envdef = strdup(arg);
399
 
        if(envdef == NULL){
400
 
          break;
401
 
        }
402
 
        if(not add_environment(getplugin(NULL), envdef, true)){
403
 
          perror("add_environment");
404
 
        }
 
396
      if(not add_environment(getplugin(NULL), arg, true)){
 
397
        perror("add_environment");
405
398
      }
406
399
      break;
407
400
    case 'o':                   /* --options-for */
408
 
      if (arg != NULL){
 
401
      if(arg != NULL){
409
402
        char *p_name = strsep(&arg, ":");
410
403
        if(p_name[0] == '\0' or arg == NULL){
411
404
          break;
435
428
        if(envdef == NULL){
436
429
          break;
437
430
        }
438
 
        char *p_name = strndup(arg, (size_t) (envdef-arg));
439
 
        if(p_name == NULL){
440
 
          break;
441
 
        }
442
 
        envdef++;
443
 
        if(not add_environment(getplugin(p_name), envdef, true)){
 
431
        *envdef = '\0';
 
432
        if(not add_environment(getplugin(arg), envdef+1, true)){
444
433
          perror("add_environment");
445
434
        }
446
435
      }
447
436
      break;
448
437
    case 'd':                   /* --disable */
449
 
      if (arg != NULL){
 
438
      if(arg != NULL){
450
439
        plugin *p = getplugin(arg);
451
440
        if(p == NULL){
452
441
          return ARGP_ERR_UNKNOWN;
455
444
      }
456
445
      break;
457
446
    case 'e':                   /* --enable */
458
 
      if (arg != NULL){
 
447
      if(arg != NULL){
459
448
        plugin *p = getplugin(arg);
460
449
        if(p == NULL){
461
450
          return ARGP_ERR_UNKNOWN;
464
453
      }
465
454
      break;
466
455
    case 128:                   /* --plugin-dir */
 
456
      free(plugindir);
467
457
      plugindir = strdup(arg);
468
458
      if(plugindir == NULL){
469
459
        perror("strdup");
473
463
      /* This is already done by parse_opt_config_file() */
474
464
      break;
475
465
    case 130:                   /* --userid */
476
 
      uid = (uid_t)strtol(arg, NULL, 10);
 
466
      /* In the GNU C library, uid_t is always unsigned int */
 
467
      ret = sscanf(arg, "%u", &uid);
 
468
      if(ret != 1){
 
469
        fprintf(stderr, "Bad user ID number: \"%s\", using %u\n", arg,
 
470
                uid);
 
471
      }
477
472
      break;
478
473
    case 131:                   /* --groupid */
479
 
      gid = (gid_t)strtol(arg, NULL, 10);
 
474
      /* In the GNU C library, gid_t is always unsigned int */
 
475
      ret = sscanf(arg, "%u", &gid);
 
476
      if(ret != 1){
 
477
        fprintf(stderr, "Bad group ID number: \"%s\", using %u\n",
 
478
                arg, gid);
 
479
      }
480
480
      break;
481
481
    case 132:                   /* --debug */
482
482
      debug = true;
483
483
      break;
 
484
/*
 
485
 * When adding more options before this line, remember to also add a
 
486
 * "case" to the "parse_opt_config_file" function below.
 
487
 */
484
488
    case ARGP_KEY_ARG:
485
 
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
489
      /* Cryptsetup always passes an argument, which is an empty
 
490
         string if "none" was specified in /etc/crypttab.  So if
 
491
         argument was empty, we ignore it silently. */
 
492
      if(arg[0] != '\0'){
 
493
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
494
      }
486
495
      break;
487
496
    case ARGP_KEY_END:
488
497
      break;
494
503
  
495
504
  /* This option parser is the same as parse_opt() above, except it
496
505
     ignores everything but the --config-file option. */
497
 
  error_t parse_opt_config_file (int key, char *arg,
498
 
                                 __attribute__((unused))
499
 
                                 struct argp_state *state) {
500
 
    switch (key) {
 
506
  error_t parse_opt_config_file(int key, char *arg,
 
507
                                __attribute__((unused))
 
508
                                struct argp_state *state) {
 
509
    switch(key) {
501
510
    case 'g':                   /* --global-options */
502
511
    case 'G':                   /* --global-env */
503
512
    case 'o':                   /* --options-for */
507
516
    case 128:                   /* --plugin-dir */
508
517
      break;
509
518
    case 129:                   /* --config-file */
 
519
      free(argfile);
510
520
      argfile = strdup(arg);
511
521
      if(argfile == NULL){
512
522
        perror("strdup");
529
539
                       .args_doc = "",
530
540
                       .doc = "Mandos plugin runner -- Run plugins" };
531
541
  
532
 
  /* Parse using the parse_opt_config_file in order to get the custom
 
542
  /* Parse using parse_opt_config_file() in order to get the custom
533
543
     config file location, if any. */
534
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
535
 
  if (ret == ARGP_ERR_UNKNOWN){
 
544
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
545
  if(ret == ARGP_ERR_UNKNOWN){
536
546
    fprintf(stderr, "Unknown error while parsing arguments\n");
537
547
    exitstatus = EXIT_FAILURE;
538
548
    goto fallback;
542
552
  argp.parser = parse_opt;
543
553
  
544
554
  /* Open the configfile if available */
545
 
  if (argfile == NULL){
 
555
  if(argfile == NULL){
546
556
    conffp = fopen(AFILE, "r");
547
557
  } else {
548
558
    conffp = fopen(argfile, "r");
551
561
    char *org_line = NULL;
552
562
    char *p, *arg, *new_arg, *line;
553
563
    size_t size = 0;
554
 
    ssize_t sret;
555
564
    const char whitespace_delims[] = " \r\t\f\v\n";
556
565
    const char comment_delim[] = "#";
557
566
 
604
613
  } else {
605
614
    /* Check for harmful errors and go to fallback. Other errors might
606
615
       not affect opening plugins */
607
 
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
616
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
608
617
      perror("fopen");
609
618
      exitstatus = EXIT_FAILURE;
610
619
      goto fallback;
613
622
  /* If there was any arguments from configuration file,
614
623
     pass them to parser as command arguments */
615
624
  if(custom_argv != NULL){
616
 
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
617
 
                      0, NULL);
618
 
    if (ret == ARGP_ERR_UNKNOWN){
 
625
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
626
                     0, NULL);
 
627
    if(ret == ARGP_ERR_UNKNOWN){
619
628
      fprintf(stderr, "Unknown error while parsing arguments\n");
620
629
      exitstatus = EXIT_FAILURE;
621
630
      goto fallback;
624
633
  
625
634
  /* Parse actual command line arguments, to let them override the
626
635
     config file */
627
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
628
 
  if (ret == ARGP_ERR_UNKNOWN){
 
636
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
637
  if(ret == ARGP_ERR_UNKNOWN){
629
638
    fprintf(stderr, "Unknown error while parsing arguments\n");
630
639
    exitstatus = EXIT_FAILURE;
631
640
    goto fallback;
647
656
  
648
657
  /* Strip permissions down to nobody */
649
658
  ret = setuid(uid);
650
 
  if (ret == -1){
 
659
  if(ret == -1){
651
660
    perror("setuid");
652
661
  }  
653
662
  setgid(gid);
654
 
  if (ret == -1){
 
663
  if(ret == -1){
655
664
    perror("setgid");
656
665
  }
657
666
  
658
 
  if (plugindir == NULL){
 
667
  if(plugindir == NULL){
659
668
    dir = opendir(PDIR);
660
669
  } else {
661
670
    dir = opendir(plugindir);
688
697
    
689
698
    /* All directory entries have been processed */
690
699
    if(dirst == NULL){
691
 
      if (errno == EBADF){
 
700
      if(errno == EBADF){
692
701
        perror("readdir");
693
702
        exitstatus = EXIT_FAILURE;
694
703
        goto fallback;
706
715
      
707
716
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
708
717
                                           ".dpkg-old",
 
718
                                           ".dpkg-bak",
709
719
                                           ".dpkg-divert", NULL };
710
720
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
711
721
        size_t pre_len = strlen(*pre);
753
763
    }
754
764
    
755
765
    ret = stat(filename, &st);
756
 
    if (ret == -1){
 
766
    if(ret == -1){
757
767
      perror("stat");
758
768
      free(filename);
759
769
      continue;
760
770
    }
761
771
 
762
772
    /* Ignore non-executable files */
763
 
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
773
    if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
764
774
      if(debug){
765
775
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
766
776
                " with bad type or mode\n", filename);
813
823
    
814
824
    int pipefd[2];
815
825
    ret = pipe(pipefd);
816
 
    if (ret == -1){
 
826
    if(ret == -1){
817
827
      perror("pipe");
818
828
      exitstatus = EXIT_FAILURE;
819
829
      goto fallback;
832
842
      goto fallback;
833
843
    }
834
844
    /* Block SIGCHLD until process is safely in process list */
835
 
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
845
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
836
846
    if(ret < 0){
837
847
      perror("sigprocmask");
838
848
      exitstatus = EXIT_FAILURE;
852
862
        perror("sigaction");
853
863
        _exit(EXIT_FAILURE);
854
864
      }
855
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
865
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
856
866
      if(ret < 0){
857
867
        perror("sigprocmask");
858
868
        _exit(EXIT_FAILURE);
859
869
      }
860
 
 
 
870
      
861
871
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
862
872
      if(ret == -1){
863
873
        perror("dup2");
886
896
    close(pipefd[1]);           /* Close unused write end of pipe */
887
897
    free(filename);
888
898
    plugin *new_plugin = getplugin(dirst->d_name);
889
 
    if (new_plugin == NULL){
 
899
    if(new_plugin == NULL){
890
900
      perror("getplugin");
891
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
901
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
892
902
      if(ret < 0){
893
903
        perror("sigprocmask");
894
904
      }
901
911
    
902
912
    /* Unblock SIGCHLD so signal handler can be run if this process
903
913
       has already completed */
904
 
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
914
    ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
905
915
    if(ret < 0){
906
916
      perror("sigprocmask");
907
917
      exitstatus = EXIT_FAILURE;
910
920
    
911
921
    FD_SET(new_plugin->fd, &rfds_all);
912
922
    
913
 
    if (maxfd < new_plugin->fd){
 
923
    if(maxfd < new_plugin->fd){
914
924
      maxfd = new_plugin->fd;
915
925
    }
916
 
    
917
926
  }
918
927
  
919
928
  closedir(dir);
920
929
  dir = NULL;
921
 
 
 
930
  
922
931
  for(plugin *p = plugin_list; p != NULL; p = p->next){
923
932
    if(p->pid != 0){
924
933
      break;
929
938
      free_plugin_list();
930
939
    }
931
940
  }
932
 
 
 
941
  
933
942
  /* Main loop while running plugins exist */
934
943
  while(plugin_list){
935
944
    fd_set rfds = rfds_all;
936
945
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
937
 
    if (select_ret == -1){
 
946
    if(select_ret == -1){
938
947
      perror("select");
939
948
      exitstatus = EXIT_FAILURE;
940
949
      goto fallback;
941
950
    }
942
951
    /* OK, now either a process completed, or something can be read
943
952
       from one of them */
944
 
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
953
    for(plugin *proc = plugin_list; proc != NULL;){
945
954
      /* Is this process completely done? */
946
955
      if(proc->eof and proc->completed){
947
956
        /* Only accept the plugin output if it exited cleanly */
959
968
                      (unsigned int) (proc->pid),
960
969
                      WTERMSIG(proc->status));
961
970
            } else if(WCOREDUMP(proc->status)){
962
 
              fprintf(stderr, "Plugin %d dumped core\n",
 
971
              fprintf(stderr, "Plugin %u dumped core\n",
963
972
                      (unsigned int) (proc->pid));
964
973
            }
965
974
          }
974
983
            exitstatus = EXIT_FAILURE;
975
984
            goto fallback;
976
985
          }
 
986
          
 
987
          plugin *next_plugin = proc->next;
977
988
          free_plugin(proc);
 
989
          proc = next_plugin;
 
990
          
978
991
          /* We are done modifying process list, so unblock signal */
979
 
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
980
 
                             NULL);
 
992
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
993
                            NULL);
981
994
          if(ret < 0){
982
995
            perror("sigprocmask");
983
996
            exitstatus = EXIT_FAILURE;
987
1000
          if(plugin_list == NULL){
988
1001
            break;
989
1002
          }
 
1003
          
990
1004
          continue;
991
1005
        }
992
1006
        
993
1007
        /* This process exited nicely, so print its buffer */
994
 
 
 
1008
        
995
1009
        bool bret = print_out_password(proc->buffer,
996
1010
                                       proc->buffer_length);
997
1011
        if(not bret){
1004
1018
      /* This process has not completed.  Does it have any output? */
1005
1019
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1006
1020
        /* This process had nothing to say at this time */
 
1021
        proc = proc->next;
1007
1022
        continue;
1008
1023
      }
1009
1024
      /* Before reading, make the process' data buffer large enough */
1010
1025
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1011
1026
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1012
1027
                               + (size_t) BUFFER_SIZE);
1013
 
        if (proc->buffer == NULL){
 
1028
        if(proc->buffer == NULL){
1014
1029
          perror("malloc");
1015
1030
          exitstatus = EXIT_FAILURE;
1016
1031
          goto fallback;
1018
1033
        proc->buffer_size += BUFFER_SIZE;
1019
1034
      }
1020
1035
      /* Read from the process */
1021
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1022
 
                 BUFFER_SIZE);
1023
 
      if(ret < 0){
 
1036
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1037
                  BUFFER_SIZE);
 
1038
      if(sret < 0){
1024
1039
        /* Read error from this process; ignore the error */
 
1040
        proc = proc->next;
1025
1041
        continue;
1026
1042
      }
1027
 
      if(ret == 0){
 
1043
      if(sret == 0){
1028
1044
        /* got EOF */
1029
1045
        proc->eof = true;
1030
1046
      } else {
1031
 
        proc->buffer_length += (size_t) ret;
 
1047
        proc->buffer_length += (size_t) sret;
1032
1048
      }
1033
1049
    }
1034
1050
  }
1061
1077
    perror("sigaction");
1062
1078
    exitstatus = EXIT_FAILURE;
1063
1079
  }
1064
 
 
 
1080
  
1065
1081
  if(custom_argv != NULL){
1066
1082
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1067
1083
      free(*arg);
1073
1089
    closedir(dir);
1074
1090
  }
1075
1091
  
1076
 
  /* Free the process list and kill the processes */
 
1092
  /* Kill the processes */
1077
1093
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1078
1094
    if(p->pid != 0){
1079
1095
      close(p->fd);
1092
1108
  if(errno != ECHILD){
1093
1109
    perror("wait");
1094
1110
  }
1095
 
 
 
1111
  
1096
1112
  free_plugin_list();
1097
1113
  
1098
1114
  free(plugindir);