/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugin-runner.c

  • Committer: Teddy Hogeborn
  • Date: 2008-10-04 01:55:56 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081004015556-hp0374bc62khen0z
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
* mandos.xml (FILES): - '' -
  (CLIENTS, SERVER): Changed id attribute to lower case.  All
                     referrers changed.
* plugins.d/mandos-client.xml (FILES): Fixed id to be "files", not
                                       "file".

* plugins.d/password-prompt.xml (DESCRIPTION): Improved 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 © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
5
 * Copyright © 2008 Teddy Hogeborn & Björn Påhlsson
6
6
 * 
7
7
 * This program is free software: you can redistribute it and/or
8
8
 * modify it under the terms of the GNU General Public License as
27
27
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
28
28
                                   EXIT_SUCCESS, realloc() */
29
29
#include <stdbool.h>            /* bool, true, false */
30
 
#include <stdio.h>              /* perror, popen(), fileno(),
31
 
                                   fprintf(), stderr, STDOUT_FILENO */
 
30
#include <stdio.h>              /* perror, fileno(), fprintf(),
 
31
                                   stderr, STDOUT_FILENO */
32
32
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
33
33
                                   stat, waitpid(), WIFEXITED(),
34
34
                                   WEXITSTATUS(), wait(), pid_t,
46
46
                                   fcntl(), setuid(), setgid(),
47
47
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
48
48
                                   access(), pipe(), fork(), close()
49
 
                                   dup2, STDOUT_FILENO, _exit(),
 
49
                                   dup2(), STDOUT_FILENO, _exit(),
50
50
                                   execv(), write(), read(),
51
51
                                   close() */
52
52
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
69
69
#define PDIR "/lib/mandos/plugins.d"
70
70
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
71
71
 
72
 
const char *argp_program_version = "plugin-runner 1.0";
 
72
const char *argp_program_version = "plugin-runner " VERSION;
73
73
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
74
74
 
75
 
struct plugin;
76
 
 
77
75
typedef struct plugin{
78
76
  char *name;                   /* can be NULL or any plugin name */
79
77
  char **argv;
96
94
 
97
95
static plugin *plugin_list = NULL;
98
96
 
99
 
/* Gets a existing plugin based on name,
 
97
/* Gets an existing plugin based on name,
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 */
118
116
      return NULL;
119
117
    }
120
118
  }
121
 
 
 
119
  
122
120
  *new_plugin = (plugin) { .name = copy_name,
123
121
                           .argc = 1,
124
122
                           .disabled = false,
132
130
  }
133
131
  new_plugin->argv[0] = copy_name;
134
132
  new_plugin->argv[1] = NULL;
135
 
 
 
133
  
136
134
  new_plugin->environ = malloc(sizeof(char *));
137
135
  if(new_plugin->environ == NULL){
138
136
    free(copy_name);
141
139
    return NULL;
142
140
  }
143
141
  new_plugin->environ[0] = NULL;
144
 
 
 
142
  
145
143
  /* Append the new plugin to the list */
146
144
  plugin_list = new_plugin;
147
145
  return new_plugin;
179
177
}
180
178
 
181
179
/* Add to a plugin's environment */
182
 
static bool add_environment(plugin *p, const char *def){
 
180
static bool add_environment(plugin *p, const char *def, bool replace){
183
181
  if(p == NULL){
184
182
    return false;
185
183
  }
 
184
  /* namelen = length of name of environment variable */
 
185
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
 
186
  /* Search for this environment variable */
 
187
  for(char **e = p->environ; *e != NULL; e++){
 
188
    if(strncmp(*e, def, namelen + 1) == 0){
 
189
      /* It already exists */
 
190
      if(replace){
 
191
        char *new = realloc(*e, strlen(def) + 1);
 
192
        if(new == NULL){
 
193
          return false;
 
194
        }
 
195
        *e = new;
 
196
        strcpy(*e, def);
 
197
      }
 
198
      return true;
 
199
    }
 
200
  }
186
201
  return add_to_char_array(def, &(p->environ), &(p->envc));
187
202
}
188
203
 
191
206
 * Descriptor Flags".
192
207
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
193
208
 */
194
 
static int set_cloexec_flag(int fd)
195
 
{
 
209
static int set_cloexec_flag(int fd){
196
210
  int ret = fcntl(fd, F_GETFD, 0);
197
211
  /* If reading the flags failed, return error indication now. */
198
212
  if(ret < 0){
205
219
 
206
220
/* Mark processes as completed when they exit, and save their exit
207
221
   status. */
208
 
void handle_sigchld(__attribute__((unused)) int sig){
 
222
static void handle_sigchld(__attribute__((unused)) int sig){
209
223
  while(true){
210
224
    plugin *proc = plugin_list;
211
225
    int status;
221
235
      /* No child processes */
222
236
      break;
223
237
    }
224
 
 
 
238
    
225
239
    /* A child exited, find it in process_list */
226
240
    while(proc != NULL and proc->pid != pid){
227
241
      proc = proc->next;
236
250
}
237
251
 
238
252
/* Prints out a password to stdout */
239
 
bool print_out_password(const char *buffer, size_t length){
 
253
static bool print_out_password(const char *buffer, size_t length){
240
254
  ssize_t ret;
241
 
  if(length>0 and buffer[length-1] == '\n'){
242
 
    length--;
243
 
  }
244
255
  for(size_t written = 0; written < length; written += (size_t)ret){
245
256
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
246
257
                                   length - written));
327
338
    { .name = "global-options", .key = 'g',
328
339
      .arg = "OPTION[,OPTION[,...]]",
329
340
      .doc = "Options passed to all plugins" },
330
 
    { .name = "global-envs", .key = 'e',
 
341
    { .name = "global-env", .key = 'G',
331
342
      .arg = "VAR=value",
332
343
      .doc = "Environment variable passed to all plugins" },
333
344
    { .name = "options-for", .key = 'o',
334
345
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
335
346
      .doc = "Options passed only to specified plugin" },
336
 
    { .name = "envs-for", .key = 'f',
 
347
    { .name = "env-for", .key = 'E',
337
348
      .arg = "PLUGIN:ENV=value",
338
349
      .doc = "Environment variable passed to specified plugin" },
339
350
    { .name = "disable", .key = 'd',
340
351
      .arg = "PLUGIN",
341
352
      .doc = "Disable a specific plugin", .group = 1 },
 
353
    { .name = "enable", .key = 'e',
 
354
      .arg = "PLUGIN",
 
355
      .doc = "Enable a specific plugin", .group = 1 },
342
356
    { .name = "plugin-dir", .key = 128,
343
357
      .arg = "DIRECTORY",
344
358
      .doc = "Specify a different plugin directory", .group = 2 },
358
372
  
359
373
  error_t parse_opt (int key, char *arg, __attribute__((unused))
360
374
                     struct argp_state *state) {
361
 
    /* Get the INPUT argument from `argp_parse', which we know is a
362
 
       pointer to our plugin list pointer. */
363
375
    switch (key) {
364
376
    case 'g':                   /* --global-options */
365
377
      if (arg != NULL){
375
387
        }
376
388
      }
377
389
      break;
378
 
    case 'e':                   /* --global-envs */
 
390
    case 'G':                   /* --global-env */
379
391
      if(arg == NULL){
380
392
        break;
381
393
      }
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
 
        }
 
394
      if(not add_environment(getplugin(NULL), arg, true)){
 
395
        perror("add_environment");
390
396
      }
391
397
      break;
392
398
    case 'o':                   /* --options-for */
393
399
      if (arg != NULL){
394
400
        char *p_name = strsep(&arg, ":");
395
 
        if(p_name[0] == '\0'){
 
401
        if(p_name[0] == '\0' or arg == NULL){
396
402
          break;
397
403
        }
398
404
        char *opt = strsep(&arg, ":");
399
 
        if(opt[0] == '\0'){
 
405
        if(opt[0] == '\0' or opt == NULL){
400
406
          break;
401
407
        }
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
 
            }
 
408
        char *p;
 
409
        while((p = strsep(&opt, ",")) != NULL){
 
410
          if(p[0] == '\0'){
 
411
            continue;
 
412
          }
 
413
          if(not add_argument(getplugin(p_name), p)){
 
414
            perror("add_argument");
 
415
            return ARGP_ERR_UNKNOWN;
412
416
          }
413
417
        }
414
418
      }
415
419
      break;
416
 
    case 'f':                   /* --envs-for */
 
420
    case 'E':                   /* --env-for */
417
421
      if(arg == NULL){
418
422
        break;
419
423
      }
422
426
        if(envdef == NULL){
423
427
          break;
424
428
        }
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)){
 
429
        *envdef = '\0';
 
430
        if(not add_environment(getplugin(arg), envdef+1, true)){
431
431
          perror("add_environment");
432
432
        }
433
433
      }
441
441
        p->disabled = true;
442
442
      }
443
443
      break;
 
444
    case 'e':                   /* --enable */
 
445
      if (arg != NULL){
 
446
        plugin *p = getplugin(arg);
 
447
        if(p == NULL){
 
448
          return ARGP_ERR_UNKNOWN;
 
449
        }
 
450
        p->disabled = false;
 
451
      }
 
452
      break;
444
453
    case 128:                   /* --plugin-dir */
 
454
      free(plugindir);
445
455
      plugindir = strdup(arg);
446
456
      if(plugindir == NULL){
447
457
        perror("strdup");
448
458
      }      
449
459
      break;
450
460
    case 129:                   /* --config-file */
 
461
      /* This is already done by parse_opt_config_file() */
 
462
      break;
 
463
    case 130:                   /* --userid */
 
464
      uid = (uid_t)strtol(arg, NULL, 10);
 
465
      break;
 
466
    case 131:                   /* --groupid */
 
467
      gid = (gid_t)strtol(arg, NULL, 10);
 
468
      break;
 
469
    case 132:                   /* --debug */
 
470
      debug = true;
 
471
      break;
 
472
    case ARGP_KEY_ARG:
 
473
      /* Cryptsetup always passes an argument, which is an empty
 
474
         string if "none" was specified in /etc/crypttab.  So if
 
475
         argument was empty, we ignore it silently. */
 
476
      if(arg[0] != '\0'){
 
477
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
478
      }
 
479
      break;
 
480
    case ARGP_KEY_END:
 
481
      break;
 
482
    default:
 
483
      return ARGP_ERR_UNKNOWN;
 
484
    }
 
485
    return 0;
 
486
  }
 
487
  
 
488
  /* This option parser is the same as parse_opt() above, except it
 
489
     ignores everything but the --config-file option. */
 
490
  error_t parse_opt_config_file (int key, char *arg,
 
491
                                 __attribute__((unused))
 
492
                                 struct argp_state *state) {
 
493
    switch (key) {
 
494
    case 'g':                   /* --global-options */
 
495
    case 'G':                   /* --global-env */
 
496
    case 'o':                   /* --options-for */
 
497
    case 'E':                   /* --env-for */
 
498
    case 'd':                   /* --disable */
 
499
    case 'e':                   /* --enable */
 
500
    case 128:                   /* --plugin-dir */
 
501
      break;
 
502
    case 129:                   /* --config-file */
 
503
      free(argfile);
451
504
      argfile = strdup(arg);
452
505
      if(argfile == NULL){
453
506
        perror("strdup");
454
507
      }
455
508
      break;      
456
509
    case 130:                   /* --userid */
457
 
      uid = (uid_t)strtol(arg, NULL, 10);
458
 
      break;
459
510
    case 131:                   /* --groupid */
460
 
      gid = (gid_t)strtol(arg, NULL, 10);
461
 
      break;
462
511
    case 132:                   /* --debug */
463
 
      debug = true;
464
 
      break;
465
512
    case ARGP_KEY_ARG:
466
 
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
467
 
      break;
468
513
    case ARGP_KEY_END:
469
514
      break;
470
515
    default:
473
518
    return 0;
474
519
  }
475
520
  
476
 
  struct argp argp = { .options = options, .parser = parse_opt,
477
 
                       .args_doc = "[+PLUS_SEPARATED_OPTIONS]",
 
521
  struct argp argp = { .options = options,
 
522
                       .parser = parse_opt_config_file,
 
523
                       .args_doc = "",
478
524
                       .doc = "Mandos plugin runner -- Run plugins" };
479
525
  
480
 
  ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
 
526
  /* Parse using the parse_opt_config_file in order to get the custom
 
527
     config file location, if any. */
 
528
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
481
529
  if (ret == ARGP_ERR_UNKNOWN){
482
530
    fprintf(stderr, "Unknown error while parsing arguments\n");
483
531
    exitstatus = EXIT_FAILURE;
484
532
    goto fallback;
485
533
  }
486
 
 
487
 
  /* Opens the configfile if aviable */
 
534
  
 
535
  /* Reset to the normal argument parser */
 
536
  argp.parser = parse_opt;
 
537
  
 
538
  /* Open the configfile if available */
488
539
  if (argfile == NULL){
489
540
    conffp = fopen(AFILE, "r");
490
541
  } else {
544
595
      }
545
596
    }
546
597
    free(org_line);
547
 
  } else{
 
598
  } else {
548
599
    /* Check for harmful errors and go to fallback. Other errors might
549
600
       not affect opening plugins */
550
601
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
556
607
  /* If there was any arguments from configuration file,
557
608
     pass them to parser as command arguments */
558
609
  if(custom_argv != NULL){
559
 
    ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
 
610
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
611
                      0, NULL);
560
612
    if (ret == ARGP_ERR_UNKNOWN){
561
613
      fprintf(stderr, "Unknown error while parsing arguments\n");
562
614
      exitstatus = EXIT_FAILURE;
564
616
    }
565
617
  }
566
618
  
 
619
  /* Parse actual command line arguments, to let them override the
 
620
     config file */
 
621
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
622
  if (ret == ARGP_ERR_UNKNOWN){
 
623
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
624
    exitstatus = EXIT_FAILURE;
 
625
    goto fallback;
 
626
  }
 
627
  
567
628
  if(debug){
568
629
    for(plugin *p = plugin_list; p != NULL; p=p->next){
569
630
      fprintf(stderr, "Plugin: %s has %d arguments\n",
577
638
      }
578
639
    }
579
640
  }
580
 
 
 
641
  
581
642
  /* Strip permissions down to nobody */
582
643
  ret = setuid(uid);
583
644
  if (ret == -1){
587
648
  if (ret == -1){
588
649
    perror("setgid");
589
650
  }
590
 
 
 
651
  
591
652
  if (plugindir == NULL){
592
653
    dir = opendir(PDIR);
593
654
  } else {
614
675
  }
615
676
  
616
677
  FD_ZERO(&rfds_all);
617
 
 
 
678
  
618
679
  /* Read and execute any executable in the plugin directory*/
619
680
  while(true){
620
681
    dirst = readdir(dir);
621
682
    
622
 
    // All directory entries have been processed
 
683
    /* All directory entries have been processed */
623
684
    if(dirst == NULL){
624
685
      if (errno == EBADF){
625
686
        perror("readdir");
631
692
    
632
693
    d_name_len = strlen(dirst->d_name);
633
694
    
634
 
    // Ignore dotfiles, backup files and other junk
 
695
    /* Ignore dotfiles, backup files and other junk */
635
696
    {
636
697
      bool bad_name = false;
637
698
      
675
736
    }
676
737
 
677
738
    char *filename;
678
 
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
739
    if(plugindir == NULL){
 
740
      ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
 
741
    } else {
 
742
      ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
743
    }
679
744
    if(ret < 0){
680
745
      perror("asprintf");
681
746
      continue;
723
788
        }
724
789
        /* Add global environment variables */
725
790
        for(char **e = g->environ; *e != NULL; e++){
726
 
          if(not add_environment(p, *e)){
 
791
          if(not add_environment(p, *e, false)){
727
792
            perror("add_environment");
728
793
          }
729
794
        }
734
799
       process, too. */
735
800
    if(p->environ[0] != NULL){
736
801
      for(char **e = environ; *e != NULL; e++){
737
 
        char *copy = strdup(*e);
738
 
        if(copy == NULL){
739
 
          perror("strdup");
740
 
          continue;
741
 
        }
742
 
        if(not add_environment(p, copy)){
 
802
        if(not add_environment(p, *e, false)){
743
803
          perror("add_environment");
744
804
        }
745
805
      }
772
832
      exitstatus = EXIT_FAILURE;
773
833
      goto fallback;
774
834
    }
775
 
    // Starting a new process to be watched
 
835
    /* Starting a new process to be watched */
776
836
    pid_t pid = fork();
777
837
    if(pid == -1){
778
838
      perror("fork");
786
846
        perror("sigaction");
787
847
        _exit(EXIT_FAILURE);
788
848
      }
789
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
849
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
790
850
      if(ret < 0){
791
851
        perror("sigprocmask");
792
852
        _exit(EXIT_FAILURE);
793
853
      }
794
 
 
 
854
      
795
855
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
796
856
      if(ret == -1){
797
857
        perror("dup2");
847
907
    if (maxfd < new_plugin->fd){
848
908
      maxfd = new_plugin->fd;
849
909
    }
850
 
    
851
910
  }
852
911
  
853
912
  closedir(dir);
854
913
  dir = NULL;
855
 
 
 
914
  
856
915
  for(plugin *p = plugin_list; p != NULL; p = p->next){
857
916
    if(p->pid != 0){
858
917
      break;
863
922
      free_plugin_list();
864
923
    }
865
924
  }
866
 
 
 
925
  
867
926
  /* Main loop while running plugins exist */
868
927
  while(plugin_list){
869
928
    fd_set rfds = rfds_all;
875
934
    }
876
935
    /* OK, now either a process completed, or something can be read
877
936
       from one of them */
878
 
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
937
    for(plugin *proc = plugin_list; proc != NULL;){
879
938
      /* Is this process completely done? */
880
939
      if(proc->eof and proc->completed){
881
940
        /* Only accept the plugin output if it exited cleanly */
908
967
            exitstatus = EXIT_FAILURE;
909
968
            goto fallback;
910
969
          }
 
970
          
 
971
          plugin *next_plugin = proc->next;
911
972
          free_plugin(proc);
 
973
          proc = next_plugin;
 
974
          
912
975
          /* We are done modifying process list, so unblock signal */
913
976
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
914
977
                             NULL);
921
984
          if(plugin_list == NULL){
922
985
            break;
923
986
          }
 
987
          
924
988
          continue;
925
989
        }
926
990
        
927
991
        /* This process exited nicely, so print its buffer */
928
 
 
 
992
        
929
993
        bool bret = print_out_password(proc->buffer,
930
994
                                       proc->buffer_length);
931
995
        if(not bret){
938
1002
      /* This process has not completed.  Does it have any output? */
939
1003
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
940
1004
        /* This process had nothing to say at this time */
 
1005
        proc = proc->next;
941
1006
        continue;
942
1007
      }
943
1008
      /* Before reading, make the process' data buffer large enough */
956
1021
                 BUFFER_SIZE);
957
1022
      if(ret < 0){
958
1023
        /* Read error from this process; ignore the error */
 
1024
        proc = proc->next;
959
1025
        continue;
960
1026
      }
961
1027
      if(ret == 0){
976
1042
    bool bret;
977
1043
    fprintf(stderr, "Going to fallback mode using getpass(3)\n");
978
1044
    char *passwordbuffer = getpass("Password: ");
979
 
    bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
 
1045
    size_t len = strlen(passwordbuffer);
 
1046
    /* Strip trailing newline */
 
1047
    if(len > 0 and passwordbuffer[len-1] == '\n'){
 
1048
      passwordbuffer[len-1] = '\0'; /* not strictly necessary */
 
1049
      len--;
 
1050
    }
 
1051
    bret = print_out_password(passwordbuffer, len);
980
1052
    if(not bret){
981
1053
      perror("print_out_password");
982
1054
      exitstatus = EXIT_FAILURE;
989
1061
    perror("sigaction");
990
1062
    exitstatus = EXIT_FAILURE;
991
1063
  }
992
 
 
 
1064
  
993
1065
  if(custom_argv != NULL){
994
1066
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
995
1067
      free(*arg);
1001
1073
    closedir(dir);
1002
1074
  }
1003
1075
  
1004
 
  /* Free the process list and kill the processes */
 
1076
  /* Kill the processes */
1005
1077
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1006
1078
    if(p->pid != 0){
1007
1079
      close(p->fd);
1020
1092
  if(errno != ECHILD){
1021
1093
    perror("wait");
1022
1094
  }
1023
 
 
 
1095
  
1024
1096
  free_plugin_list();
1025
1097
  
1026
1098
  free(plugindir);