/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 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

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,
131
132
  }
132
133
  new_plugin->argv[0] = copy_name;
133
134
  new_plugin->argv[1] = NULL;
134
 
  
 
135
 
135
136
  new_plugin->environ = malloc(sizeof(char *));
136
137
  if(new_plugin->environ == NULL){
137
138
    free(copy_name);
140
141
    return NULL;
141
142
  }
142
143
  new_plugin->environ[0] = NULL;
143
 
  
 
144
 
144
145
  /* Append the new plugin to the list */
145
146
  plugin_list = new_plugin;
146
147
  return new_plugin;
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
  }
185
 
  /* namelen = length of name of environment variable */
186
 
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
187
 
  /* Search for this environment variable */
188
 
  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
 
      }
199
 
      return true;
200
 
    }
201
 
  }
202
186
  return add_to_char_array(def, &(p->environ), &(p->envc));
203
187
}
204
188
 
207
191
 * Descriptor Flags".
208
192
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
209
193
 */
210
 
static int set_cloexec_flag(int fd){
 
194
static int set_cloexec_flag(int fd)
 
195
{
211
196
  int ret = fcntl(fd, F_GETFD, 0);
212
197
  /* If reading the flags failed, return error indication now. */
213
198
  if(ret < 0){
220
205
 
221
206
/* Mark processes as completed when they exit, and save their exit
222
207
   status. */
223
 
static void handle_sigchld(__attribute__((unused)) int sig){
 
208
void handle_sigchld(__attribute__((unused)) int sig){
224
209
  while(true){
225
210
    plugin *proc = plugin_list;
226
211
    int status;
236
221
      /* No child processes */
237
222
      break;
238
223
    }
239
 
    
 
224
 
240
225
    /* A child exited, find it in process_list */
241
226
    while(proc != NULL and proc->pid != pid){
242
227
      proc = proc->next;
251
236
}
252
237
 
253
238
/* Prints out a password to stdout */
254
 
static bool print_out_password(const char *buffer, size_t length){
 
239
bool print_out_password(const char *buffer, size_t length){
255
240
  ssize_t ret;
 
241
  if(length>0 and buffer[length-1] == '\n'){
 
242
    length--;
 
243
  }
256
244
  for(size_t written = 0; written < length; written += (size_t)ret){
257
245
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
258
246
                                   length - written));
339
327
    { .name = "global-options", .key = 'g',
340
328
      .arg = "OPTION[,OPTION[,...]]",
341
329
      .doc = "Options passed to all plugins" },
342
 
    { .name = "global-env", .key = 'G',
 
330
    { .name = "global-envs", .key = 'e',
343
331
      .arg = "VAR=value",
344
332
      .doc = "Environment variable passed to all plugins" },
345
333
    { .name = "options-for", .key = 'o',
346
334
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
347
335
      .doc = "Options passed only to specified plugin" },
348
 
    { .name = "env-for", .key = 'E',
 
336
    { .name = "envs-for", .key = 'f',
349
337
      .arg = "PLUGIN:ENV=value",
350
338
      .doc = "Environment variable passed to specified plugin" },
351
339
    { .name = "disable", .key = 'd',
352
340
      .arg = "PLUGIN",
353
341
      .doc = "Disable a specific plugin", .group = 1 },
354
 
    { .name = "enable", .key = 'e',
355
 
      .arg = "PLUGIN",
356
 
      .doc = "Enable a specific plugin", .group = 1 },
357
342
    { .name = "plugin-dir", .key = 128,
358
343
      .arg = "DIRECTORY",
359
344
      .doc = "Specify a different plugin directory", .group = 2 },
373
358
  
374
359
  error_t parse_opt (int key, char *arg, __attribute__((unused))
375
360
                     struct argp_state *state) {
 
361
    /* Get the INPUT argument from `argp_parse', which we know is a
 
362
       pointer to our plugin list pointer. */
376
363
    switch (key) {
377
364
    case 'g':                   /* --global-options */
378
365
      if (arg != NULL){
388
375
        }
389
376
      }
390
377
      break;
391
 
    case 'G':                   /* --global-env */
 
378
    case 'e':                   /* --global-envs */
392
379
      if(arg == NULL){
393
380
        break;
394
381
      }
395
 
      if(not add_environment(getplugin(NULL), arg, true)){
396
 
        perror("add_environment");
 
382
      {
 
383
        char *envdef = strdup(arg);
 
384
        if(envdef == NULL){
 
385
          break;
 
386
        }
 
387
        if(not add_environment(getplugin(NULL), envdef)){
 
388
          perror("add_environment");
 
389
        }
397
390
      }
398
391
      break;
399
392
    case 'o':                   /* --options-for */
400
393
      if (arg != NULL){
401
394
        char *p_name = strsep(&arg, ":");
402
 
        if(p_name[0] == '\0' or arg == NULL){
 
395
        if(p_name[0] == '\0'){
403
396
          break;
404
397
        }
405
398
        char *opt = strsep(&arg, ":");
406
 
        if(opt[0] == '\0' or opt == NULL){
 
399
        if(opt[0] == '\0'){
407
400
          break;
408
401
        }
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;
 
402
        if(opt != NULL){
 
403
          char *p;
 
404
          while((p = strsep(&opt, ",")) != NULL){
 
405
            if(p[0] == '\0'){
 
406
              continue;
 
407
            }
 
408
            if(not add_argument(getplugin(p_name), p)){
 
409
              perror("add_argument");
 
410
              return ARGP_ERR_UNKNOWN;
 
411
            }
417
412
          }
418
413
        }
419
414
      }
420
415
      break;
421
 
    case 'E':                   /* --env-for */
 
416
    case 'f':                   /* --envs-for */
422
417
      if(arg == NULL){
423
418
        break;
424
419
      }
427
422
        if(envdef == NULL){
428
423
          break;
429
424
        }
430
 
        *envdef = '\0';
431
 
        if(not add_environment(getplugin(arg), envdef+1, true)){
 
425
        char *p_name = strndup(arg, (size_t) (envdef-arg));
 
426
        if(p_name == NULL){
 
427
          break;
 
428
        }
 
429
        envdef++;
 
430
        if(not add_environment(getplugin(p_name), envdef)){
432
431
          perror("add_environment");
433
432
        }
434
433
      }
442
441
        p->disabled = true;
443
442
      }
444
443
      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
444
    case 128:                   /* --plugin-dir */
455
 
      free(plugindir);
456
445
      plugindir = strdup(arg);
457
446
      if(plugindir == NULL){
458
447
        perror("strdup");
459
448
      }      
460
449
      break;
461
450
    case 129:                   /* --config-file */
462
 
      /* This is already done by parse_opt_config_file() */
463
 
      break;
 
451
      argfile = strdup(arg);
 
452
      if(argfile == NULL){
 
453
        perror("strdup");
 
454
      }
 
455
      break;      
464
456
    case 130:                   /* --userid */
465
457
      uid = (uid_t)strtol(arg, NULL, 10);
466
458
      break;
471
463
      debug = true;
472
464
      break;
473
465
    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 = "",
 
466
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
467
      break;
 
468
    case ARGP_KEY_END:
 
469
      break;
 
470
    default:
 
471
      return ARGP_ERR_UNKNOWN;
 
472
    }
 
473
    return 0;
 
474
  }
 
475
  
 
476
  struct argp argp = { .options = options, .parser = parse_opt,
 
477
                       .args_doc = "[+PLUS_SEPARATED_OPTIONS]",
525
478
                       .doc = "Mandos plugin runner -- Run plugins" };
526
479
  
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);
 
480
  ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
530
481
  if (ret == ARGP_ERR_UNKNOWN){
531
482
    fprintf(stderr, "Unknown error while parsing arguments\n");
532
483
    exitstatus = EXIT_FAILURE;
533
484
    goto fallback;
534
485
  }
535
 
  
536
 
  /* Reset to the normal argument parser */
537
 
  argp.parser = parse_opt;
538
 
  
539
 
  /* Open the configfile if available */
 
486
 
 
487
  /* Opens the configfile if aviable */
540
488
  if (argfile == NULL){
541
489
    conffp = fopen(AFILE, "r");
542
490
  } else {
596
544
      }
597
545
    }
598
546
    free(org_line);
599
 
  } else {
 
547
  } else{
600
548
    /* Check for harmful errors and go to fallback. Other errors might
601
549
       not affect opening plugins */
602
550
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
608
556
  /* If there was any arguments from configuration file,
609
557
     pass them to parser as command arguments */
610
558
  if(custom_argv != NULL){
611
 
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
612
 
                      0, NULL);
 
559
    ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
613
560
    if (ret == ARGP_ERR_UNKNOWN){
614
561
      fprintf(stderr, "Unknown error while parsing arguments\n");
615
562
      exitstatus = EXIT_FAILURE;
617
564
    }
618
565
  }
619
566
  
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
567
  if(debug){
630
568
    for(plugin *p = plugin_list; p != NULL; p=p->next){
631
569
      fprintf(stderr, "Plugin: %s has %d arguments\n",
639
577
      }
640
578
    }
641
579
  }
642
 
  
 
580
 
643
581
  /* Strip permissions down to nobody */
644
582
  ret = setuid(uid);
645
583
  if (ret == -1){
649
587
  if (ret == -1){
650
588
    perror("setgid");
651
589
  }
652
 
  
 
590
 
653
591
  if (plugindir == NULL){
654
592
    dir = opendir(PDIR);
655
593
  } else {
676
614
  }
677
615
  
678
616
  FD_ZERO(&rfds_all);
679
 
  
 
617
 
680
618
  /* Read and execute any executable in the plugin directory*/
681
619
  while(true){
682
620
    dirst = readdir(dir);
683
621
    
684
 
    /* All directory entries have been processed */
 
622
    // All directory entries have been processed
685
623
    if(dirst == NULL){
686
624
      if (errno == EBADF){
687
625
        perror("readdir");
693
631
    
694
632
    d_name_len = strlen(dirst->d_name);
695
633
    
696
 
    /* Ignore dotfiles, backup files and other junk */
 
634
    // Ignore dotfiles, backup files and other junk
697
635
    {
698
636
      bool bad_name = false;
699
637
      
701
639
      
702
640
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
703
641
                                           ".dpkg-old",
704
 
                                           ".dpkg-bak",
705
642
                                           ".dpkg-divert", NULL };
706
643
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
707
644
        size_t pre_len = strlen(*pre);
738
675
    }
739
676
 
740
677
    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
 
    }
 
678
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
746
679
    if(ret < 0){
747
680
      perror("asprintf");
748
681
      continue;
790
723
        }
791
724
        /* Add global environment variables */
792
725
        for(char **e = g->environ; *e != NULL; e++){
793
 
          if(not add_environment(p, *e, false)){
 
726
          if(not add_environment(p, *e)){
794
727
            perror("add_environment");
795
728
          }
796
729
        }
801
734
       process, too. */
802
735
    if(p->environ[0] != NULL){
803
736
      for(char **e = environ; *e != NULL; e++){
804
 
        if(not add_environment(p, *e, false)){
 
737
        char *copy = strdup(*e);
 
738
        if(copy == NULL){
 
739
          perror("strdup");
 
740
          continue;
 
741
        }
 
742
        if(not add_environment(p, copy)){
805
743
          perror("add_environment");
806
744
        }
807
745
      }
834
772
      exitstatus = EXIT_FAILURE;
835
773
      goto fallback;
836
774
    }
837
 
    /* Starting a new process to be watched */
 
775
    // Starting a new process to be watched
838
776
    pid_t pid = fork();
839
777
    if(pid == -1){
840
778
      perror("fork");
848
786
        perror("sigaction");
849
787
        _exit(EXIT_FAILURE);
850
788
      }
851
 
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
789
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
852
790
      if(ret < 0){
853
791
        perror("sigprocmask");
854
792
        _exit(EXIT_FAILURE);
855
793
      }
856
 
      
 
794
 
857
795
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
858
796
      if(ret == -1){
859
797
        perror("dup2");
909
847
    if (maxfd < new_plugin->fd){
910
848
      maxfd = new_plugin->fd;
911
849
    }
 
850
    
912
851
  }
913
852
  
914
853
  closedir(dir);
915
854
  dir = NULL;
916
 
  
 
855
 
917
856
  for(plugin *p = plugin_list; p != NULL; p = p->next){
918
857
    if(p->pid != 0){
919
858
      break;
924
863
      free_plugin_list();
925
864
    }
926
865
  }
927
 
  
 
866
 
928
867
  /* Main loop while running plugins exist */
929
868
  while(plugin_list){
930
869
    fd_set rfds = rfds_all;
936
875
    }
937
876
    /* OK, now either a process completed, or something can be read
938
877
       from one of them */
939
 
    for(plugin *proc = plugin_list; proc != NULL;){
 
878
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
940
879
      /* Is this process completely done? */
941
880
      if(proc->eof and proc->completed){
942
881
        /* Only accept the plugin output if it exited cleanly */
969
908
            exitstatus = EXIT_FAILURE;
970
909
            goto fallback;
971
910
          }
972
 
          
973
 
          plugin *next_plugin = proc->next;
974
911
          free_plugin(proc);
975
 
          proc = next_plugin;
976
 
          
977
912
          /* We are done modifying process list, so unblock signal */
978
913
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
979
914
                             NULL);
986
921
          if(plugin_list == NULL){
987
922
            break;
988
923
          }
989
 
          
990
924
          continue;
991
925
        }
992
926
        
993
927
        /* This process exited nicely, so print its buffer */
994
 
        
 
928
 
995
929
        bool bret = print_out_password(proc->buffer,
996
930
                                       proc->buffer_length);
997
931
        if(not bret){
1004
938
      /* This process has not completed.  Does it have any output? */
1005
939
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1006
940
        /* This process had nothing to say at this time */
1007
 
        proc = proc->next;
1008
941
        continue;
1009
942
      }
1010
943
      /* Before reading, make the process' data buffer large enough */
1023
956
                 BUFFER_SIZE);
1024
957
      if(ret < 0){
1025
958
        /* Read error from this process; ignore the error */
1026
 
        proc = proc->next;
1027
959
        continue;
1028
960
      }
1029
961
      if(ret == 0){
1044
976
    bool bret;
1045
977
    fprintf(stderr, "Going to fallback mode using getpass(3)\n");
1046
978
    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);
 
979
    bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
1054
980
    if(not bret){
1055
981
      perror("print_out_password");
1056
982
      exitstatus = EXIT_FAILURE;
1063
989
    perror("sigaction");
1064
990
    exitstatus = EXIT_FAILURE;
1065
991
  }
1066
 
  
 
992
 
1067
993
  if(custom_argv != NULL){
1068
994
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1069
995
      free(*arg);
1075
1001
    closedir(dir);
1076
1002
  }
1077
1003
  
1078
 
  /* Kill the processes */
 
1004
  /* Free the process list and kill the processes */
1079
1005
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1080
1006
    if(p->pid != 0){
1081
1007
      close(p->fd);
1094
1020
  if(errno != ECHILD){
1095
1021
    perror("wait");
1096
1022
  }
1097
 
  
 
1023
 
1098
1024
  free_plugin_list();
1099
1025
  
1100
1026
  free(plugindir);