/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-01 16:19:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901161932-ostp7tulh9aijulh
* plugin-runner.c (add_environment): Never insert existing environment
                                     variables.
  (main): Rename "--global-envs" to "--global-env" and "--envs-for" to
          "--env-for".

* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
                                "--global-env" and "--envs-for" to
                                "--env-for".
  (OPTIONS): Added "--global-env" and "--env-for".
  (FALLBACK): Add id attribute.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): New section.
  (FILES): Document configuration file.

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 © 2007-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
28
27
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
29
28
                                   EXIT_SUCCESS, realloc() */
30
29
#include <stdbool.h>            /* bool, true, false */
31
 
#include <stdio.h>              /* perror, fileno(), fprintf(),
32
 
                                   stderr, STDOUT_FILENO */
 
30
#include <stdio.h>              /* perror, popen(), fileno(),
 
31
                                   fprintf(), stderr, STDOUT_FILENO */
33
32
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
34
33
                                   stat, waitpid(), WIFEXITED(),
35
34
                                   WEXITSTATUS(), wait(), pid_t,
47
46
                                   fcntl(), setuid(), setgid(),
48
47
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
49
48
                                   access(), pipe(), fork(), close()
50
 
                                   dup2(), STDOUT_FILENO, _exit(),
 
49
                                   dup2, STDOUT_FILENO, _exit(),
51
50
                                   execv(), write(), read(),
52
51
                                   close() */
53
52
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
70
69
#define PDIR "/lib/mandos/plugins.d"
71
70
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
72
71
 
73
 
const char *argp_program_version = "plugin-runner " VERSION;
 
72
const char *argp_program_version = "plugin-runner 1.0";
74
73
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
75
74
 
 
75
struct plugin;
 
76
 
76
77
typedef struct plugin{
77
78
  char *name;                   /* can be NULL or any plugin name */
78
79
  char **argv;
95
96
 
96
97
static plugin *plugin_list = NULL;
97
98
 
98
 
/* Gets an existing plugin based on name,
 
99
/* Gets a existing plugin based on name,
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 */
117
118
      return NULL;
118
119
    }
119
120
  }
120
 
  
 
121
 
121
122
  *new_plugin = (plugin) { .name = copy_name,
122
123
                           .argc = 1,
123
124
                           .disabled = false,
178
179
}
179
180
 
180
181
/* Add to a plugin's environment */
181
 
static bool add_environment(plugin *p, const char *def, bool replace){
 
182
static bool add_environment(plugin *p, const char *def){
182
183
  if(p == NULL){
183
184
    return false;
184
185
  }
186
187
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
187
188
  /* Search for this environment variable */
188
189
  for(char **e = p->environ; *e != NULL; e++){
189
 
    if(strncmp(*e, def, namelen + 1) == 0){
190
 
      /* It already exists */
191
 
      if(replace){
192
 
        char *new = realloc(*e, strlen(def) + 1);
193
 
        if(new == NULL){
194
 
          return false;
195
 
        }
196
 
        *e = new;
197
 
        strcpy(*e, def);
198
 
      }
 
190
    if(strncmp(*e, def, namelen+1) == 0){
 
191
      /* Refuse to add an existing variable */
199
192
      return true;
200
193
    }
201
194
  }
207
200
 * Descriptor Flags".
208
201
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
209
202
 */
210
 
static int set_cloexec_flag(int fd){
 
203
static int set_cloexec_flag(int fd)
 
204
{
211
205
  int ret = fcntl(fd, F_GETFD, 0);
212
206
  /* If reading the flags failed, return error indication now. */
213
207
  if(ret < 0){
220
214
 
221
215
/* Mark processes as completed when they exit, and save their exit
222
216
   status. */
223
 
static void handle_sigchld(__attribute__((unused)) int sig){
 
217
void handle_sigchld(__attribute__((unused)) int sig){
224
218
  while(true){
225
219
    plugin *proc = plugin_list;
226
220
    int status;
236
230
      /* No child processes */
237
231
      break;
238
232
    }
239
 
    
 
233
 
240
234
    /* A child exited, find it in process_list */
241
235
    while(proc != NULL and proc->pid != pid){
242
236
      proc = proc->next;
251
245
}
252
246
 
253
247
/* Prints out a password to stdout */
254
 
static bool print_out_password(const char *buffer, size_t length){
 
248
bool print_out_password(const char *buffer, size_t length){
255
249
  ssize_t ret;
 
250
  if(length>0 and buffer[length-1] == '\n'){
 
251
    length--;
 
252
  }
256
253
  for(size_t written = 0; written < length; written += (size_t)ret){
257
254
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
258
255
                                   length - written));
339
336
    { .name = "global-options", .key = 'g',
340
337
      .arg = "OPTION[,OPTION[,...]]",
341
338
      .doc = "Options passed to all plugins" },
342
 
    { .name = "global-env", .key = 'G',
 
339
    { .name = "global-env", .key = 'e',
343
340
      .arg = "VAR=value",
344
341
      .doc = "Environment variable passed to all plugins" },
345
342
    { .name = "options-for", .key = 'o',
346
343
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
347
344
      .doc = "Options passed only to specified plugin" },
348
 
    { .name = "env-for", .key = 'E',
 
345
    { .name = "env-for", .key = 'f',
349
346
      .arg = "PLUGIN:ENV=value",
350
347
      .doc = "Environment variable passed to specified plugin" },
351
348
    { .name = "disable", .key = 'd',
352
349
      .arg = "PLUGIN",
353
350
      .doc = "Disable a specific plugin", .group = 1 },
354
 
    { .name = "enable", .key = 'e',
355
 
      .arg = "PLUGIN",
356
 
      .doc = "Enable a specific plugin", .group = 1 },
357
351
    { .name = "plugin-dir", .key = 128,
358
352
      .arg = "DIRECTORY",
359
353
      .doc = "Specify a different plugin directory", .group = 2 },
373
367
  
374
368
  error_t parse_opt (int key, char *arg, __attribute__((unused))
375
369
                     struct argp_state *state) {
 
370
    /* Get the INPUT argument from `argp_parse', which we know is a
 
371
       pointer to our plugin list pointer. */
376
372
    switch (key) {
377
373
    case 'g':                   /* --global-options */
378
374
      if (arg != NULL){
388
384
        }
389
385
      }
390
386
      break;
391
 
    case 'G':                   /* --global-env */
 
387
    case 'e':                   /* --global-env */
392
388
      if(arg == NULL){
393
389
        break;
394
390
      }
395
 
      if(not add_environment(getplugin(NULL), arg, true)){
396
 
        perror("add_environment");
 
391
      {
 
392
        char *envdef = strdup(arg);
 
393
        if(envdef == NULL){
 
394
          break;
 
395
        }
 
396
        if(not add_environment(getplugin(NULL), envdef)){
 
397
          perror("add_environment");
 
398
        }
397
399
      }
398
400
      break;
399
401
    case 'o':                   /* --options-for */
400
402
      if (arg != NULL){
401
403
        char *p_name = strsep(&arg, ":");
402
 
        if(p_name[0] == '\0' or arg == NULL){
 
404
        if(p_name[0] == '\0'){
403
405
          break;
404
406
        }
405
407
        char *opt = strsep(&arg, ":");
406
 
        if(opt[0] == '\0' or opt == NULL){
 
408
        if(opt[0] == '\0'){
407
409
          break;
408
410
        }
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)){
415
 
            perror("add_argument");
416
 
            return ARGP_ERR_UNKNOWN;
 
411
        if(opt != NULL){
 
412
          char *p;
 
413
          while((p = strsep(&opt, ",")) != NULL){
 
414
            if(p[0] == '\0'){
 
415
              continue;
 
416
            }
 
417
            if(not add_argument(getplugin(p_name), p)){
 
418
              perror("add_argument");
 
419
              return ARGP_ERR_UNKNOWN;
 
420
            }
417
421
          }
418
422
        }
419
423
      }
420
424
      break;
421
 
    case 'E':                   /* --env-for */
 
425
    case 'f':                   /* --env-for */
422
426
      if(arg == NULL){
423
427
        break;
424
428
      }
427
431
        if(envdef == NULL){
428
432
          break;
429
433
        }
430
 
        *envdef = '\0';
431
 
        if(not add_environment(getplugin(arg), envdef+1, true)){
 
434
        char *p_name = strndup(arg, (size_t) (envdef-arg));
 
435
        if(p_name == NULL){
 
436
          break;
 
437
        }
 
438
        envdef++;
 
439
        if(not add_environment(getplugin(p_name), envdef)){
432
440
          perror("add_environment");
433
441
        }
434
442
      }
442
450
        p->disabled = true;
443
451
      }
444
452
      break;
445
 
    case 'e':                   /* --enable */
446
 
      if (arg != NULL){
447
 
        plugin *p = getplugin(arg);
448
 
        if(p == NULL){
449
 
          return ARGP_ERR_UNKNOWN;
450
 
        }
451
 
        p->disabled = false;
452
 
      }
453
 
      break;
454
453
    case 128:                   /* --plugin-dir */
455
 
      free(plugindir);
456
454
      plugindir = strdup(arg);
457
455
      if(plugindir == NULL){
458
456
        perror("strdup");
459
457
      }      
460
458
      break;
461
459
    case 129:                   /* --config-file */
462
 
      /* This is already done by parse_opt_config_file() */
463
 
      break;
 
460
      argfile = strdup(arg);
 
461
      if(argfile == NULL){
 
462
        perror("strdup");
 
463
      }
 
464
      break;      
464
465
    case 130:                   /* --userid */
465
466
      uid = (uid_t)strtol(arg, NULL, 10);
466
467
      break;
471
472
      debug = true;
472
473
      break;
473
474
    case ARGP_KEY_ARG:
474
 
      /* Cryptsetup always passes an argument, which is an empty
475
 
         string if "none" was specified in /etc/crypttab.  So if
476
 
         argument was empty, we ignore it silently. */
477
 
      if(arg[0] != '\0'){
478
 
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
479
 
      }
480
 
      break;
481
 
    case ARGP_KEY_END:
482
 
      break;
483
 
    default:
484
 
      return ARGP_ERR_UNKNOWN;
485
 
    }
486
 
    return 0;
487
 
  }
488
 
  
489
 
  /* This option parser is the same as parse_opt() above, except it
490
 
     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) {
495
 
    case 'g':                   /* --global-options */
496
 
    case 'G':                   /* --global-env */
497
 
    case 'o':                   /* --options-for */
498
 
    case 'E':                   /* --env-for */
499
 
    case 'd':                   /* --disable */
500
 
    case 'e':                   /* --enable */
501
 
    case 128:                   /* --plugin-dir */
502
 
      break;
503
 
    case 129:                   /* --config-file */
504
 
      free(argfile);
505
 
      argfile = strdup(arg);
506
 
      if(argfile == NULL){
507
 
        perror("strdup");
508
 
      }
509
 
      break;      
510
 
    case 130:                   /* --userid */
511
 
    case 131:                   /* --groupid */
512
 
    case 132:                   /* --debug */
513
 
    case ARGP_KEY_ARG:
514
 
    case ARGP_KEY_END:
515
 
      break;
516
 
    default:
517
 
      return ARGP_ERR_UNKNOWN;
518
 
    }
519
 
    return 0;
520
 
  }
521
 
  
522
 
  struct argp argp = { .options = options,
523
 
                       .parser = parse_opt_config_file,
524
 
                       .args_doc = "",
 
475
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
476
      break;
 
477
    case ARGP_KEY_END:
 
478
      break;
 
479
    default:
 
480
      return ARGP_ERR_UNKNOWN;
 
481
    }
 
482
    return 0;
 
483
  }
 
484
  
 
485
  struct argp argp = { .options = options, .parser = parse_opt,
 
486
                       .args_doc = "[+PLUS_SEPARATED_OPTIONS]",
525
487
                       .doc = "Mandos plugin runner -- Run plugins" };
526
488
  
527
 
  /* Parse using the parse_opt_config_file in order to get the custom
528
 
     config file location, if any. */
529
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
489
  ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
530
490
  if (ret == ARGP_ERR_UNKNOWN){
531
491
    fprintf(stderr, "Unknown error while parsing arguments\n");
532
492
    exitstatus = EXIT_FAILURE;
533
493
    goto fallback;
534
494
  }
535
 
  
536
 
  /* Reset to the normal argument parser */
537
 
  argp.parser = parse_opt;
538
 
  
539
 
  /* Open the configfile if available */
 
495
 
 
496
  /* Opens the configfile if aviable */
540
497
  if (argfile == NULL){
541
498
    conffp = fopen(AFILE, "r");
542
499
  } else {
596
553
      }
597
554
    }
598
555
    free(org_line);
599
 
  } else {
 
556
  } else{
600
557
    /* Check for harmful errors and go to fallback. Other errors might
601
558
       not affect opening plugins */
602
559
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
608
565
  /* If there was any arguments from configuration file,
609
566
     pass them to parser as command arguments */
610
567
  if(custom_argv != NULL){
611
 
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
612
 
                      0, NULL);
 
568
    ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
613
569
    if (ret == ARGP_ERR_UNKNOWN){
614
570
      fprintf(stderr, "Unknown error while parsing arguments\n");
615
571
      exitstatus = EXIT_FAILURE;
617
573
    }
618
574
  }
619
575
  
620
 
  /* Parse actual command line arguments, to let them override the
621
 
     config file */
622
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
623
 
  if (ret == ARGP_ERR_UNKNOWN){
624
 
    fprintf(stderr, "Unknown error while parsing arguments\n");
625
 
    exitstatus = EXIT_FAILURE;
626
 
    goto fallback;
627
 
  }
628
 
  
629
576
  if(debug){
630
577
    for(plugin *p = plugin_list; p != NULL; p=p->next){
631
578
      fprintf(stderr, "Plugin: %s has %d arguments\n",
639
586
      }
640
587
    }
641
588
  }
642
 
  
 
589
 
643
590
  /* Strip permissions down to nobody */
644
591
  ret = setuid(uid);
645
592
  if (ret == -1){
649
596
  if (ret == -1){
650
597
    perror("setgid");
651
598
  }
652
 
  
 
599
 
653
600
  if (plugindir == NULL){
654
601
    dir = opendir(PDIR);
655
602
  } else {
676
623
  }
677
624
  
678
625
  FD_ZERO(&rfds_all);
679
 
  
 
626
 
680
627
  /* Read and execute any executable in the plugin directory*/
681
628
  while(true){
682
629
    dirst = readdir(dir);
683
630
    
684
 
    /* All directory entries have been processed */
 
631
    // All directory entries have been processed
685
632
    if(dirst == NULL){
686
633
      if (errno == EBADF){
687
634
        perror("readdir");
693
640
    
694
641
    d_name_len = strlen(dirst->d_name);
695
642
    
696
 
    /* Ignore dotfiles, backup files and other junk */
 
643
    // Ignore dotfiles, backup files and other junk
697
644
    {
698
645
      bool bad_name = false;
699
646
      
701
648
      
702
649
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
703
650
                                           ".dpkg-old",
704
 
                                           ".dpkg-bak",
705
651
                                           ".dpkg-divert", NULL };
706
652
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
707
653
        size_t pre_len = strlen(*pre);
738
684
    }
739
685
 
740
686
    char *filename;
741
 
    if(plugindir == NULL){
742
 
      ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
743
 
    } else {
744
 
      ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
745
 
    }
 
687
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
746
688
    if(ret < 0){
747
689
      perror("asprintf");
748
690
      continue;
790
732
        }
791
733
        /* Add global environment variables */
792
734
        for(char **e = g->environ; *e != NULL; e++){
793
 
          if(not add_environment(p, *e, false)){
 
735
          if(not add_environment(p, *e)){
794
736
            perror("add_environment");
795
737
          }
796
738
        }
801
743
       process, too. */
802
744
    if(p->environ[0] != NULL){
803
745
      for(char **e = environ; *e != NULL; e++){
804
 
        if(not add_environment(p, *e, false)){
 
746
        char *copy = strdup(*e);
 
747
        if(copy == NULL){
 
748
          perror("strdup");
 
749
          continue;
 
750
        }
 
751
        if(not add_environment(p, copy)){
805
752
          perror("add_environment");
806
753
        }
807
754
      }
834
781
      exitstatus = EXIT_FAILURE;
835
782
      goto fallback;
836
783
    }
837
 
    /* Starting a new process to be watched */
 
784
    // Starting a new process to be watched
838
785
    pid_t pid = fork();
839
786
    if(pid == -1){
840
787
      perror("fork");
848
795
        perror("sigaction");
849
796
        _exit(EXIT_FAILURE);
850
797
      }
851
 
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
798
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
852
799
      if(ret < 0){
853
800
        perror("sigprocmask");
854
801
        _exit(EXIT_FAILURE);
855
802
      }
856
 
      
 
803
 
857
804
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
858
805
      if(ret == -1){
859
806
        perror("dup2");
909
856
    if (maxfd < new_plugin->fd){
910
857
      maxfd = new_plugin->fd;
911
858
    }
 
859
    
912
860
  }
913
861
  
914
862
  closedir(dir);
915
863
  dir = NULL;
916
 
  
 
864
 
917
865
  for(plugin *p = plugin_list; p != NULL; p = p->next){
918
866
    if(p->pid != 0){
919
867
      break;
924
872
      free_plugin_list();
925
873
    }
926
874
  }
927
 
  
 
875
 
928
876
  /* Main loop while running plugins exist */
929
877
  while(plugin_list){
930
878
    fd_set rfds = rfds_all;
936
884
    }
937
885
    /* OK, now either a process completed, or something can be read
938
886
       from one of them */
939
 
    for(plugin *proc = plugin_list; proc != NULL;){
 
887
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
940
888
      /* Is this process completely done? */
941
889
      if(proc->eof and proc->completed){
942
890
        /* Only accept the plugin output if it exited cleanly */
969
917
            exitstatus = EXIT_FAILURE;
970
918
            goto fallback;
971
919
          }
972
 
          
973
 
          plugin *next_plugin = proc->next;
974
920
          free_plugin(proc);
975
 
          proc = next_plugin;
976
 
          
977
921
          /* We are done modifying process list, so unblock signal */
978
922
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
979
923
                             NULL);
986
930
          if(plugin_list == NULL){
987
931
            break;
988
932
          }
989
 
          
990
933
          continue;
991
934
        }
992
935
        
993
936
        /* This process exited nicely, so print its buffer */
994
 
        
 
937
 
995
938
        bool bret = print_out_password(proc->buffer,
996
939
                                       proc->buffer_length);
997
940
        if(not bret){
1004
947
      /* This process has not completed.  Does it have any output? */
1005
948
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1006
949
        /* This process had nothing to say at this time */
1007
 
        proc = proc->next;
1008
950
        continue;
1009
951
      }
1010
952
      /* Before reading, make the process' data buffer large enough */
1023
965
                 BUFFER_SIZE);
1024
966
      if(ret < 0){
1025
967
        /* Read error from this process; ignore the error */
1026
 
        proc = proc->next;
1027
968
        continue;
1028
969
      }
1029
970
      if(ret == 0){
1044
985
    bool bret;
1045
986
    fprintf(stderr, "Going to fallback mode using getpass(3)\n");
1046
987
    char *passwordbuffer = getpass("Password: ");
1047
 
    size_t len = strlen(passwordbuffer);
1048
 
    /* Strip trailing newline */
1049
 
    if(len > 0 and passwordbuffer[len-1] == '\n'){
1050
 
      passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1051
 
      len--;
1052
 
    }
1053
 
    bret = print_out_password(passwordbuffer, len);
 
988
    bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1054
989
    if(not bret){
1055
990
      perror("print_out_password");
1056
991
      exitstatus = EXIT_FAILURE;
1063
998
    perror("sigaction");
1064
999
    exitstatus = EXIT_FAILURE;
1065
1000
  }
1066
 
  
 
1001
 
1067
1002
  if(custom_argv != NULL){
1068
1003
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1069
1004
      free(*arg);
1075
1010
    closedir(dir);
1076
1011
  }
1077
1012
  
1078
 
  /* Kill the processes */
 
1013
  /* Free the process list and kill the processes */
1079
1014
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1080
1015
    if(p->pid != 0){
1081
1016
      close(p->fd);
1094
1029
  if(errno != ECHILD){
1095
1030
    perror("wait");
1096
1031
  }
1097
 
  
 
1032
 
1098
1033
  free_plugin_list();
1099
1034
  
1100
1035
  free(plugindir);