/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-02-09 02:01:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090209020113-726hq380zvp8zt97
Four new interrelated features:

1. Support using a different network interface via both initramfs.conf
   (the DEVICE setting) and the kernel command line (sixth field of
   the "ip=" option as in Linux' Documentation/nfsroot.txt).

2. Support connecting to a specified Mandos server directly using a
   kernel command line option ("mandos=connect:<ADDRESS>:<PORT>").

3. Support connecting directly to an IPv4 address (and port) using the
   "--connect" option of mandos-client.

4. Support an empty string to the --interface option to mandos-client.

* Makefile (WARN): Increase strictness by changing to
                   "-Wstrict-aliasing=1".

* debian/mandos-client.README.Debian (Use the Correct Network
  Interface): Changed to refer to initramfs.conf and nfsroot.txt.
  (Test the Server): Improve wording.
  (Non-local Connection): New section.
* initramfs-tools-script: Obey DEVICE environment variable and setting
                          from "/conf/initramfs.conf".  Also let any
                          "ip=" kernel command line option override
                          it.  Support new "mandos=connect" option.
                          Call "configure_networking" to set up IP
                          address on interface if necessary.
* plugin-runner.conf: Change example.
* plugins.d/mandos-client.c: Some whitespace and comment changes.
  (start_mandos_communication): Take an additional argument for
                                address family, all callers changed.
                                Connect to an IPv4 address if address
                                family is AF_INET.  Only set IPv6
                                scope_id for link-local addresses.
  (main): Accept empty interface name; this will not bring up any
         interface and leave the interface as unspecified.  Also do
         not restore kernel log level if lowering it failed.
* plugins.d/mandos-client.xml (OPTIONS): Document that the
                                         "--interface" option accepts
                                         an empty string.
  (EXAMPLE): Change example IPv6 address to a link-local address.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
88
89
  size_t buffer_size;
89
90
  size_t buffer_length;
90
91
  bool eof;
91
 
  volatile bool completed;
92
 
  volatile int status;
 
92
  volatile sig_atomic_t completed;
 
93
  int status;
93
94
  struct plugin *next;
94
95
} plugin;
95
96
 
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
  }
120
122
  
121
 
  *new_plugin = (plugin) { .name = copy_name,
122
 
                           .argc = 1,
123
 
                           .disabled = false,
124
 
                           .next = plugin_list };
 
123
  *new_plugin = (plugin){ .name = copy_name,
 
124
                          .argc = 1,
 
125
                          .disabled = false,
 
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;
221
223
/* Mark processes as completed when they exit, and save their exit
222
224
   status. */
223
225
static void handle_sigchld(__attribute__((unused)) int sig){
 
226
  int old_errno = errno;
224
227
  while(true){
225
228
    plugin *proc = plugin_list;
226
229
    int status;
230
233
      break;
231
234
    }
232
235
    if(pid == -1){
233
 
      if (errno != ECHILD){
234
 
        perror("waitpid");
 
236
      if(errno == ECHILD){
 
237
        /* No child processes */
 
238
        break;
235
239
      }
236
 
      /* No child processes */
237
 
      break;
 
240
      perror("waitpid");
238
241
    }
239
242
    
240
243
    /* A child exited, find it in process_list */
246
249
      continue;
247
250
    }
248
251
    proc->status = status;
249
 
    proc->completed = true;
 
252
    proc->completed = 1;
250
253
  }
 
254
  errno = old_errno;
251
255
}
252
256
 
253
257
/* Prints out a password to stdout */
308
312
  struct dirent *dirst;
309
313
  struct stat st;
310
314
  fd_set rfds_all;
311
 
  int ret, maxfd = 0;
 
315
  int ret, numchars, maxfd = 0;
 
316
  ssize_t sret;
 
317
  intmax_t tmpmax;
312
318
  uid_t uid = 65534;
313
319
  gid_t gid = 65534;
314
320
  bool debug = false;
371
377
    { .name = NULL }
372
378
  };
373
379
  
374
 
  error_t parse_opt (int key, char *arg, __attribute__((unused))
375
 
                     struct argp_state *state) {
376
 
    switch (key) {
 
380
  error_t parse_opt(int key, char *arg, __attribute__((unused))
 
381
                    struct argp_state *state){
 
382
    switch(key){
377
383
    case 'g':                   /* --global-options */
378
 
      if (arg != NULL){
 
384
      if(arg != NULL){
379
385
        char *p;
380
386
        while((p = strsep(&arg, ",")) != NULL){
381
387
          if(p[0] == '\0'){
397
403
      }
398
404
      break;
399
405
    case 'o':                   /* --options-for */
400
 
      if (arg != NULL){
 
406
      if(arg != NULL){
401
407
        char *p_name = strsep(&arg, ":");
402
408
        if(p_name[0] == '\0' or arg == NULL){
403
409
          break;
434
440
      }
435
441
      break;
436
442
    case 'd':                   /* --disable */
437
 
      if (arg != NULL){
 
443
      if(arg != NULL){
438
444
        plugin *p = getplugin(arg);
439
445
        if(p == NULL){
440
446
          return ARGP_ERR_UNKNOWN;
443
449
      }
444
450
      break;
445
451
    case 'e':                   /* --enable */
446
 
      if (arg != NULL){
 
452
      if(arg != NULL){
447
453
        plugin *p = getplugin(arg);
448
454
        if(p == NULL){
449
455
          return ARGP_ERR_UNKNOWN;
462
468
      /* This is already done by parse_opt_config_file() */
463
469
      break;
464
470
    case 130:                   /* --userid */
465
 
      uid = (uid_t)strtol(arg, NULL, 10);
 
471
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
472
      if(ret < 1 or tmpmax != (uid_t)tmpmax
 
473
         or arg[numchars] != '\0'){
 
474
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
 
475
                PRIdMAX "\n", arg, (intmax_t)uid);
 
476
      } else {
 
477
        uid = (uid_t)tmpmax;
 
478
      }
466
479
      break;
467
480
    case 131:                   /* --groupid */
468
 
      gid = (gid_t)strtol(arg, NULL, 10);
 
481
      ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
 
482
      if(ret < 1 or tmpmax != (gid_t)tmpmax
 
483
         or arg[numchars] != '\0'){
 
484
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
 
485
                PRIdMAX "\n", arg, (intmax_t)gid);
 
486
      } else {
 
487
        gid = (gid_t)tmpmax;
 
488
      }
469
489
      break;
470
490
    case 132:                   /* --debug */
471
491
      debug = true;
472
492
      break;
 
493
/*
 
494
 * When adding more options before this line, remember to also add a
 
495
 * "case" to the "parse_opt_config_file" function below.
 
496
 */
473
497
    case ARGP_KEY_ARG:
474
498
      /* Cryptsetup always passes an argument, which is an empty
475
499
         string if "none" was specified in /etc/crypttab.  So if
488
512
  
489
513
  /* This option parser is the same as parse_opt() above, except it
490
514
     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) {
 
515
  error_t parse_opt_config_file(int key, char *arg,
 
516
                                __attribute__((unused))
 
517
                                struct argp_state *state){
 
518
    switch(key){
495
519
    case 'g':                   /* --global-options */
496
520
    case 'G':                   /* --global-env */
497
521
    case 'o':                   /* --options-for */
524
548
                       .args_doc = "",
525
549
                       .doc = "Mandos plugin runner -- Run plugins" };
526
550
  
527
 
  /* Parse using the parse_opt_config_file in order to get the custom
 
551
  /* Parse using parse_opt_config_file() in order to get the custom
528
552
     config file location, if any. */
529
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
530
 
  if (ret == ARGP_ERR_UNKNOWN){
 
553
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
554
  if(ret == ARGP_ERR_UNKNOWN){
531
555
    fprintf(stderr, "Unknown error while parsing arguments\n");
532
556
    exitstatus = EXIT_FAILURE;
533
557
    goto fallback;
537
561
  argp.parser = parse_opt;
538
562
  
539
563
  /* Open the configfile if available */
540
 
  if (argfile == NULL){
 
564
  if(argfile == NULL){
541
565
    conffp = fopen(AFILE, "r");
542
566
  } else {
543
567
    conffp = fopen(argfile, "r");
546
570
    char *org_line = NULL;
547
571
    char *p, *arg, *new_arg, *line;
548
572
    size_t size = 0;
549
 
    ssize_t sret;
550
573
    const char whitespace_delims[] = " \r\t\f\v\n";
551
574
    const char comment_delim[] = "#";
552
575
 
599
622
  } else {
600
623
    /* Check for harmful errors and go to fallback. Other errors might
601
624
       not affect opening plugins */
602
 
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
625
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
603
626
      perror("fopen");
604
627
      exitstatus = EXIT_FAILURE;
605
628
      goto fallback;
608
631
  /* If there was any arguments from configuration file,
609
632
     pass them to parser as command arguments */
610
633
  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){
 
634
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
635
                     0, NULL);
 
636
    if(ret == ARGP_ERR_UNKNOWN){
614
637
      fprintf(stderr, "Unknown error while parsing arguments\n");
615
638
      exitstatus = EXIT_FAILURE;
616
639
      goto fallback;
619
642
  
620
643
  /* Parse actual command line arguments, to let them override the
621
644
     config file */
622
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
623
 
  if (ret == ARGP_ERR_UNKNOWN){
 
645
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
646
  if(ret == ARGP_ERR_UNKNOWN){
624
647
    fprintf(stderr, "Unknown error while parsing arguments\n");
625
648
    exitstatus = EXIT_FAILURE;
626
649
    goto fallback;
633
656
      for(char **a = p->argv; *a != NULL; a++){
634
657
        fprintf(stderr, "\tArg: %s\n", *a);
635
658
      }
636
 
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
659
      fprintf(stderr, "...and %d environment variables\n", p->envc);
637
660
      for(char **a = p->environ; *a != NULL; a++){
638
661
        fprintf(stderr, "\t%s\n", *a);
639
662
      }
641
664
  }
642
665
  
643
666
  /* Strip permissions down to nobody */
 
667
  setgid(gid);
 
668
  if(ret == -1){
 
669
    perror("setgid");
 
670
  }
644
671
  ret = setuid(uid);
645
 
  if (ret == -1){
 
672
  if(ret == -1){
646
673
    perror("setuid");
647
 
  }  
648
 
  setgid(gid);
649
 
  if (ret == -1){
650
 
    perror("setgid");
651
674
  }
652
675
  
653
 
  if (plugindir == NULL){
 
676
  if(plugindir == NULL){
654
677
    dir = opendir(PDIR);
655
678
  } else {
656
679
    dir = opendir(plugindir);
683
706
    
684
707
    /* All directory entries have been processed */
685
708
    if(dirst == NULL){
686
 
      if (errno == EBADF){
 
709
      if(errno == EBADF){
687
710
        perror("readdir");
688
711
        exitstatus = EXIT_FAILURE;
689
712
        goto fallback;
749
772
    }
750
773
    
751
774
    ret = stat(filename, &st);
752
 
    if (ret == -1){
 
775
    if(ret == -1){
753
776
      perror("stat");
754
777
      free(filename);
755
778
      continue;
756
779
    }
757
780
 
758
781
    /* Ignore non-executable files */
759
 
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
782
    if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
760
783
      if(debug){
761
784
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
762
785
                " with bad type or mode\n", filename);
809
832
    
810
833
    int pipefd[2];
811
834
    ret = pipe(pipefd);
812
 
    if (ret == -1){
 
835
    if(ret == -1){
813
836
      perror("pipe");
814
837
      exitstatus = EXIT_FAILURE;
815
838
      goto fallback;
828
851
      goto fallback;
829
852
    }
830
853
    /* Block SIGCHLD until process is safely in process list */
831
 
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
854
    ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
832
855
    if(ret < 0){
833
856
      perror("sigprocmask");
834
857
      exitstatus = EXIT_FAILURE;
882
905
    close(pipefd[1]);           /* Close unused write end of pipe */
883
906
    free(filename);
884
907
    plugin *new_plugin = getplugin(dirst->d_name);
885
 
    if (new_plugin == NULL){
 
908
    if(new_plugin == NULL){
886
909
      perror("getplugin");
887
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
910
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
888
911
      if(ret < 0){
889
912
        perror("sigprocmask");
890
913
      }
897
920
    
898
921
    /* Unblock SIGCHLD so signal handler can be run if this process
899
922
       has already completed */
900
 
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
923
    ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
901
924
    if(ret < 0){
902
925
      perror("sigprocmask");
903
926
      exitstatus = EXIT_FAILURE;
906
929
    
907
930
    FD_SET(new_plugin->fd, &rfds_all);
908
931
    
909
 
    if (maxfd < new_plugin->fd){
 
932
    if(maxfd < new_plugin->fd){
910
933
      maxfd = new_plugin->fd;
911
934
    }
912
935
  }
929
952
  while(plugin_list){
930
953
    fd_set rfds = rfds_all;
931
954
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
932
 
    if (select_ret == -1){
 
955
    if(select_ret == -1){
933
956
      perror("select");
934
957
      exitstatus = EXIT_FAILURE;
935
958
      goto fallback;
938
961
       from one of them */
939
962
    for(plugin *proc = plugin_list; proc != NULL;){
940
963
      /* Is this process completely done? */
941
 
      if(proc->eof and proc->completed){
 
964
      if(proc->completed and proc->eof){
942
965
        /* Only accept the plugin output if it exited cleanly */
943
966
        if(not WIFEXITED(proc->status)
944
967
           or WEXITSTATUS(proc->status) != 0){
946
969
 
947
970
          if(debug){
948
971
            if(WIFEXITED(proc->status)){
949
 
              fprintf(stderr, "Plugin %u exited with status %d\n",
950
 
                      (unsigned int) (proc->pid),
 
972
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
 
973
                      " status %d\n", proc->name,
 
974
                      (intmax_t) (proc->pid),
951
975
                      WEXITSTATUS(proc->status));
952
 
            } else if(WIFSIGNALED(proc->status)) {
953
 
              fprintf(stderr, "Plugin %u killed by signal %d\n",
954
 
                      (unsigned int) (proc->pid),
 
976
            } else if(WIFSIGNALED(proc->status)){
 
977
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
 
978
                      " signal %d\n", proc->name,
 
979
                      (intmax_t) (proc->pid),
955
980
                      WTERMSIG(proc->status));
956
981
            } else if(WCOREDUMP(proc->status)){
957
 
              fprintf(stderr, "Plugin %d dumped core\n",
958
 
                      (unsigned int) (proc->pid));
 
982
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
983
                      " core\n", proc->name, (intmax_t) (proc->pid));
959
984
            }
960
985
          }
961
986
          
975
1000
          proc = next_plugin;
976
1001
          
977
1002
          /* We are done modifying process list, so unblock signal */
978
 
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
979
 
                             NULL);
 
1003
          ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
1004
                            NULL);
980
1005
          if(ret < 0){
981
1006
            perror("sigprocmask");
982
1007
            exitstatus = EXIT_FAILURE;
1011
1036
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1012
1037
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1013
1038
                               + (size_t) BUFFER_SIZE);
1014
 
        if (proc->buffer == NULL){
 
1039
        if(proc->buffer == NULL){
1015
1040
          perror("malloc");
1016
1041
          exitstatus = EXIT_FAILURE;
1017
1042
          goto fallback;
1019
1044
        proc->buffer_size += BUFFER_SIZE;
1020
1045
      }
1021
1046
      /* Read from the process */
1022
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1023
 
                 BUFFER_SIZE);
1024
 
      if(ret < 0){
 
1047
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1048
                  BUFFER_SIZE);
 
1049
      if(sret < 0){
1025
1050
        /* Read error from this process; ignore the error */
1026
1051
        proc = proc->next;
1027
1052
        continue;
1028
1053
      }
1029
 
      if(ret == 0){
 
1054
      if(sret == 0){
1030
1055
        /* got EOF */
1031
1056
        proc->eof = true;
1032
1057
      } else {
1033
 
        proc->buffer_length += (size_t) ret;
 
1058
        proc->buffer_length += (size_t) sret;
1034
1059
      }
1035
1060
    }
1036
1061
  }