/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-09-26 05:04:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080926050415-20l2y561cgyaq97i
* .bzrignore: Added "plugins/splashy", "plugins/usplash", and a couple
              of intermediate files in "debian/po".

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,
72
72
const char *argp_program_version = "plugin-runner 1.0";
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,
187
185
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
188
186
  /* Search for this environment variable */
189
187
  for(char **e = p->environ; *e != NULL; e++){
190
 
    if(strncmp(*e, def, namelen+1) == 0){
 
188
    if(strncmp(*e, def, namelen + 1) == 0){
191
189
      /* It already exists */
192
190
      if(replace){
193
 
        char *new = realloc(*e, strlen(def));
 
191
        char *new = realloc(*e, strlen(def) + 1);
194
192
        if(new == NULL){
195
193
          return false;
196
194
        }
208
206
 * Descriptor Flags".
209
207
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
210
208
 */
211
 
static int set_cloexec_flag(int fd)
212
 
{
 
209
static int set_cloexec_flag(int fd){
213
210
  int ret = fcntl(fd, F_GETFD, 0);
214
211
  /* If reading the flags failed, return error indication now. */
215
212
  if(ret < 0){
222
219
 
223
220
/* Mark processes as completed when they exit, and save their exit
224
221
   status. */
225
 
void handle_sigchld(__attribute__((unused)) int sig){
 
222
static void handle_sigchld(__attribute__((unused)) int sig){
226
223
  while(true){
227
224
    plugin *proc = plugin_list;
228
225
    int status;
238
235
      /* No child processes */
239
236
      break;
240
237
    }
241
 
 
 
238
    
242
239
    /* A child exited, find it in process_list */
243
240
    while(proc != NULL and proc->pid != pid){
244
241
      proc = proc->next;
253
250
}
254
251
 
255
252
/* Prints out a password to stdout */
256
 
bool print_out_password(const char *buffer, size_t length){
 
253
static bool print_out_password(const char *buffer, size_t length){
257
254
  ssize_t ret;
258
 
  if(length>0 and buffer[length-1] == '\n'){
259
 
    length--;
260
 
  }
261
255
  for(size_t written = 0; written < length; written += (size_t)ret){
262
256
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
263
257
                                   length - written));
344
338
    { .name = "global-options", .key = 'g',
345
339
      .arg = "OPTION[,OPTION[,...]]",
346
340
      .doc = "Options passed to all plugins" },
347
 
    { .name = "global-env", .key = 'e',
 
341
    { .name = "global-env", .key = 'G',
348
342
      .arg = "VAR=value",
349
343
      .doc = "Environment variable passed to all plugins" },
350
344
    { .name = "options-for", .key = 'o',
351
345
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
352
346
      .doc = "Options passed only to specified plugin" },
353
 
    { .name = "env-for", .key = 'f',
 
347
    { .name = "env-for", .key = 'E',
354
348
      .arg = "PLUGIN:ENV=value",
355
349
      .doc = "Environment variable passed to specified plugin" },
356
350
    { .name = "disable", .key = 'd',
357
351
      .arg = "PLUGIN",
358
352
      .doc = "Disable a specific plugin", .group = 1 },
 
353
    { .name = "enable", .key = 'e',
 
354
      .arg = "PLUGIN",
 
355
      .doc = "Enable a specific plugin", .group = 1 },
359
356
    { .name = "plugin-dir", .key = 128,
360
357
      .arg = "DIRECTORY",
361
358
      .doc = "Specify a different plugin directory", .group = 2 },
375
372
  
376
373
  error_t parse_opt (int key, char *arg, __attribute__((unused))
377
374
                     struct argp_state *state) {
378
 
    /* Get the INPUT argument from `argp_parse', which we know is a
379
 
       pointer to our plugin list pointer. */
380
375
    switch (key) {
381
376
    case 'g':                   /* --global-options */
382
377
      if (arg != NULL){
392
387
        }
393
388
      }
394
389
      break;
395
 
    case 'e':                   /* --global-env */
 
390
    case 'G':                   /* --global-env */
396
391
      if(arg == NULL){
397
392
        break;
398
393
      }
399
 
      {
400
 
        char *envdef = strdup(arg);
401
 
        if(envdef == NULL){
402
 
          break;
403
 
        }
404
 
        if(not add_environment(getplugin(NULL), envdef, true)){
405
 
          perror("add_environment");
406
 
        }
 
394
      if(not add_environment(getplugin(NULL), arg, true)){
 
395
        perror("add_environment");
407
396
      }
408
397
      break;
409
398
    case 'o':                   /* --options-for */
410
399
      if (arg != NULL){
411
400
        char *p_name = strsep(&arg, ":");
412
 
        if(p_name[0] == '\0'){
 
401
        if(p_name[0] == '\0' or arg == NULL){
413
402
          break;
414
403
        }
415
404
        char *opt = strsep(&arg, ":");
416
 
        if(opt[0] == '\0'){
 
405
        if(opt[0] == '\0' or opt == NULL){
417
406
          break;
418
407
        }
419
 
        if(opt != NULL){
420
 
          char *p;
421
 
          while((p = strsep(&opt, ",")) != NULL){
422
 
            if(p[0] == '\0'){
423
 
              continue;
424
 
            }
425
 
            if(not add_argument(getplugin(p_name), p)){
426
 
              perror("add_argument");
427
 
              return ARGP_ERR_UNKNOWN;
428
 
            }
 
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;
429
416
          }
430
417
        }
431
418
      }
432
419
      break;
433
 
    case 'f':                   /* --env-for */
 
420
    case 'E':                   /* --env-for */
434
421
      if(arg == NULL){
435
422
        break;
436
423
      }
439
426
        if(envdef == NULL){
440
427
          break;
441
428
        }
442
 
        char *p_name = strndup(arg, (size_t) (envdef-arg));
443
 
        if(p_name == NULL){
444
 
          break;
445
 
        }
446
 
        envdef++;
447
 
        if(not add_environment(getplugin(p_name), envdef, true)){
 
429
        *envdef = '\0';
 
430
        if(not add_environment(getplugin(arg), envdef+1, true)){
448
431
          perror("add_environment");
449
432
        }
450
433
      }
458
441
        p->disabled = true;
459
442
      }
460
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;
461
453
    case 128:                   /* --plugin-dir */
 
454
      free(plugindir);
462
455
      plugindir = strdup(arg);
463
456
      if(plugindir == NULL){
464
457
        perror("strdup");
465
458
      }      
466
459
      break;
467
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);
468
504
      argfile = strdup(arg);
469
505
      if(argfile == NULL){
470
506
        perror("strdup");
471
507
      }
472
508
      break;      
473
509
    case 130:                   /* --userid */
474
 
      uid = (uid_t)strtol(arg, NULL, 10);
475
 
      break;
476
510
    case 131:                   /* --groupid */
477
 
      gid = (gid_t)strtol(arg, NULL, 10);
478
 
      break;
479
511
    case 132:                   /* --debug */
480
 
      debug = true;
481
 
      break;
482
512
    case ARGP_KEY_ARG:
483
 
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
484
 
      break;
485
513
    case ARGP_KEY_END:
486
514
      break;
487
515
    default:
490
518
    return 0;
491
519
  }
492
520
  
493
 
  struct argp argp = { .options = options, .parser = parse_opt,
 
521
  struct argp argp = { .options = options,
 
522
                       .parser = parse_opt_config_file,
494
523
                       .args_doc = "",
495
524
                       .doc = "Mandos plugin runner -- Run plugins" };
496
525
  
 
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);
 
529
  if (ret == ARGP_ERR_UNKNOWN){
 
530
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
531
    exitstatus = EXIT_FAILURE;
 
532
    goto fallback;
 
533
  }
 
534
  
 
535
  /* Reset to the normal argument parser */
 
536
  argp.parser = parse_opt;
 
537
  
497
538
  /* Open the configfile if available */
498
539
  if (argfile == NULL){
499
540
    conffp = fopen(AFILE, "r");
695
736
    }
696
737
 
697
738
    char *filename;
698
 
    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
    }
699
744
    if(ret < 0){
700
745
      perror("asprintf");
701
746
      continue;
801
846
        perror("sigaction");
802
847
        _exit(EXIT_FAILURE);
803
848
      }
804
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
849
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
805
850
      if(ret < 0){
806
851
        perror("sigprocmask");
807
852
        _exit(EXIT_FAILURE);
808
853
      }
809
 
 
 
854
      
810
855
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
811
856
      if(ret == -1){
812
857
        perror("dup2");
862
907
    if (maxfd < new_plugin->fd){
863
908
      maxfd = new_plugin->fd;
864
909
    }
865
 
    
866
910
  }
867
911
  
868
912
  closedir(dir);
869
913
  dir = NULL;
870
 
 
 
914
  
871
915
  for(plugin *p = plugin_list; p != NULL; p = p->next){
872
916
    if(p->pid != 0){
873
917
      break;
878
922
      free_plugin_list();
879
923
    }
880
924
  }
881
 
 
 
925
  
882
926
  /* Main loop while running plugins exist */
883
927
  while(plugin_list){
884
928
    fd_set rfds = rfds_all;
890
934
    }
891
935
    /* OK, now either a process completed, or something can be read
892
936
       from one of them */
893
 
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
937
    for(plugin *proc = plugin_list; proc != NULL;){
894
938
      /* Is this process completely done? */
895
939
      if(proc->eof and proc->completed){
896
940
        /* Only accept the plugin output if it exited cleanly */
923
967
            exitstatus = EXIT_FAILURE;
924
968
            goto fallback;
925
969
          }
 
970
          
 
971
          plugin *next_plugin = proc->next;
926
972
          free_plugin(proc);
 
973
          proc = next_plugin;
 
974
          
927
975
          /* We are done modifying process list, so unblock signal */
928
976
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
929
977
                             NULL);
936
984
          if(plugin_list == NULL){
937
985
            break;
938
986
          }
 
987
          
939
988
          continue;
940
989
        }
941
990
        
942
991
        /* This process exited nicely, so print its buffer */
943
 
 
 
992
        
944
993
        bool bret = print_out_password(proc->buffer,
945
994
                                       proc->buffer_length);
946
995
        if(not bret){
953
1002
      /* This process has not completed.  Does it have any output? */
954
1003
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
955
1004
        /* This process had nothing to say at this time */
 
1005
        proc = proc->next;
956
1006
        continue;
957
1007
      }
958
1008
      /* Before reading, make the process' data buffer large enough */
971
1021
                 BUFFER_SIZE);
972
1022
      if(ret < 0){
973
1023
        /* Read error from this process; ignore the error */
 
1024
        proc = proc->next;
974
1025
        continue;
975
1026
      }
976
1027
      if(ret == 0){
991
1042
    bool bret;
992
1043
    fprintf(stderr, "Going to fallback mode using getpass(3)\n");
993
1044
    char *passwordbuffer = getpass("Password: ");
994
 
    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);
995
1052
    if(not bret){
996
1053
      perror("print_out_password");
997
1054
      exitstatus = EXIT_FAILURE;
1004
1061
    perror("sigaction");
1005
1062
    exitstatus = EXIT_FAILURE;
1006
1063
  }
1007
 
 
 
1064
  
1008
1065
  if(custom_argv != NULL){
1009
1066
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1010
1067
      free(*arg);
1016
1073
    closedir(dir);
1017
1074
  }
1018
1075
  
1019
 
  /* Free the process list and kill the processes */
 
1076
  /* Kill the processes */
1020
1077
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1021
1078
    if(p->pid != 0){
1022
1079
      close(p->fd);
1035
1092
  if(errno != ECHILD){
1036
1093
    perror("wait");
1037
1094
  }
1038
 
 
 
1095
  
1039
1096
  free_plugin_list();
1040
1097
  
1041
1098
  free(plugindir);