/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-01-12 22:02:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090112220233-lawxo4uvyzb38u1f
* README (The Plugin System): Removed redundant text about options and
                              files for the plugins, this is now
                              documented in the manuals for the
                              plugins.

* plugins.d/mandos-client.c (main): Remove comment which was copied
                                    from another program by mistake.
                                    Use "sscanf" instead of "strtol"
                                    to parse numbers; this uses the
                                    correct type instead of casting.
                                    Don't report errors when removing
                                    temporary directory if directory
                                    is already gone.

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,2009 Teddy Hogeborn
 
6
 * Copyright © 2008,2009 Björn Påhlsson
6
7
 * 
7
8
 * This program is free software: you can redistribute it and/or
8
9
 * modify it under the terms of the GNU General Public License as
27
28
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
28
29
                                   EXIT_SUCCESS, realloc() */
29
30
#include <stdbool.h>            /* bool, true, false */
30
 
#include <stdio.h>              /* perror, popen(), fileno(),
31
 
                                   fprintf(), stderr, STDOUT_FILENO */
 
31
#include <stdio.h>              /* perror, fileno(), fprintf(),
 
32
                                   stderr, STDOUT_FILENO */
32
33
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
33
34
                                   stat, waitpid(), WIFEXITED(),
34
35
                                   WEXITSTATUS(), wait(), pid_t,
46
47
                                   fcntl(), setuid(), setgid(),
47
48
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
48
49
                                   access(), pipe(), fork(), close()
49
 
                                   dup2, STDOUT_FILENO, _exit(),
 
50
                                   dup2(), STDOUT_FILENO, _exit(),
50
51
                                   execv(), write(), read(),
51
52
                                   close() */
52
53
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
69
70
#define PDIR "/lib/mandos/plugins.d"
70
71
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
71
72
 
72
 
const char *argp_program_version = "plugin-runner 1.0";
 
73
const char *argp_program_version = "plugin-runner " VERSION;
73
74
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
74
75
 
75
 
struct plugin;
76
 
 
77
76
typedef struct plugin{
78
77
  char *name;                   /* can be NULL or any plugin name */
79
78
  char **argv;
96
95
 
97
96
static plugin *plugin_list = NULL;
98
97
 
99
 
/* Gets a existing plugin based on name,
 
98
/* Gets an existing plugin based on name,
100
99
   or if none is found, creates a new one */
101
100
static plugin *getplugin(char *name){
102
101
  /* Check for exiting plugin with that name */
118
117
      return NULL;
119
118
    }
120
119
  }
121
 
 
 
120
  
122
121
  *new_plugin = (plugin) { .name = copy_name,
123
122
                           .argc = 1,
124
123
                           .disabled = false,
187
186
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
188
187
  /* Search for this environment variable */
189
188
  for(char **e = p->environ; *e != NULL; e++){
190
 
    if(strncmp(*e, def, namelen+1) == 0){
 
189
    if(strncmp(*e, def, namelen + 1) == 0){
191
190
      /* It already exists */
192
191
      if(replace){
193
 
        char *new = realloc(*e, strlen(def));
 
192
        char *new = realloc(*e, strlen(def) + 1);
194
193
        if(new == NULL){
195
194
          return false;
196
195
        }
208
207
 * Descriptor Flags".
209
208
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
210
209
 */
211
 
static int set_cloexec_flag(int fd)
212
 
{
 
210
static int set_cloexec_flag(int fd){
213
211
  int ret = fcntl(fd, F_GETFD, 0);
214
212
  /* If reading the flags failed, return error indication now. */
215
213
  if(ret < 0){
222
220
 
223
221
/* Mark processes as completed when they exit, and save their exit
224
222
   status. */
225
 
void handle_sigchld(__attribute__((unused)) int sig){
 
223
static void handle_sigchld(__attribute__((unused)) int sig){
226
224
  while(true){
227
225
    plugin *proc = plugin_list;
228
226
    int status;
238
236
      /* No child processes */
239
237
      break;
240
238
    }
241
 
 
 
239
    
242
240
    /* A child exited, find it in process_list */
243
241
    while(proc != NULL and proc->pid != pid){
244
242
      proc = proc->next;
253
251
}
254
252
 
255
253
/* Prints out a password to stdout */
256
 
bool print_out_password(const char *buffer, size_t length){
 
254
static bool print_out_password(const char *buffer, size_t length){
257
255
  ssize_t ret;
258
 
  if(length>0 and buffer[length-1] == '\n'){
259
 
    length--;
260
 
  }
261
256
  for(size_t written = 0; written < length; written += (size_t)ret){
262
257
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
263
258
                                   length - written));
314
309
  struct stat st;
315
310
  fd_set rfds_all;
316
311
  int ret, maxfd = 0;
 
312
  ssize_t sret;
317
313
  uid_t uid = 65534;
318
314
  gid_t gid = 65534;
319
315
  bool debug = false;
344
340
    { .name = "global-options", .key = 'g',
345
341
      .arg = "OPTION[,OPTION[,...]]",
346
342
      .doc = "Options passed to all plugins" },
347
 
    { .name = "global-env", .key = 'e',
 
343
    { .name = "global-env", .key = 'G',
348
344
      .arg = "VAR=value",
349
345
      .doc = "Environment variable passed to all plugins" },
350
346
    { .name = "options-for", .key = 'o',
351
347
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
352
348
      .doc = "Options passed only to specified plugin" },
353
 
    { .name = "env-for", .key = 'f',
 
349
    { .name = "env-for", .key = 'E',
354
350
      .arg = "PLUGIN:ENV=value",
355
351
      .doc = "Environment variable passed to specified plugin" },
356
352
    { .name = "disable", .key = 'd',
357
353
      .arg = "PLUGIN",
358
354
      .doc = "Disable a specific plugin", .group = 1 },
 
355
    { .name = "enable", .key = 'e',
 
356
      .arg = "PLUGIN",
 
357
      .doc = "Enable a specific plugin", .group = 1 },
359
358
    { .name = "plugin-dir", .key = 128,
360
359
      .arg = "DIRECTORY",
361
360
      .doc = "Specify a different plugin directory", .group = 2 },
390
389
        }
391
390
      }
392
391
      break;
393
 
    case 'e':                   /* --global-env */
 
392
    case 'G':                   /* --global-env */
394
393
      if(arg == NULL){
395
394
        break;
396
395
      }
397
 
      {
398
 
        char *envdef = strdup(arg);
399
 
        if(envdef == NULL){
400
 
          break;
401
 
        }
402
 
        if(not add_environment(getplugin(NULL), envdef, true)){
403
 
          perror("add_environment");
404
 
        }
 
396
      if(not add_environment(getplugin(NULL), arg, true)){
 
397
        perror("add_environment");
405
398
      }
406
399
      break;
407
400
    case 'o':                   /* --options-for */
408
401
      if (arg != NULL){
409
402
        char *p_name = strsep(&arg, ":");
410
 
        if(p_name[0] == '\0'){
 
403
        if(p_name[0] == '\0' or arg == NULL){
411
404
          break;
412
405
        }
413
406
        char *opt = strsep(&arg, ":");
414
 
        if(opt[0] == '\0'){
 
407
        if(opt[0] == '\0' or opt == NULL){
415
408
          break;
416
409
        }
417
 
        if(opt != NULL){
418
 
          char *p;
419
 
          while((p = strsep(&opt, ",")) != NULL){
420
 
            if(p[0] == '\0'){
421
 
              continue;
422
 
            }
423
 
            if(not add_argument(getplugin(p_name), p)){
424
 
              perror("add_argument");
425
 
              return ARGP_ERR_UNKNOWN;
426
 
            }
 
410
        char *p;
 
411
        while((p = strsep(&opt, ",")) != NULL){
 
412
          if(p[0] == '\0'){
 
413
            continue;
 
414
          }
 
415
          if(not add_argument(getplugin(p_name), p)){
 
416
            perror("add_argument");
 
417
            return ARGP_ERR_UNKNOWN;
427
418
          }
428
419
        }
429
420
      }
430
421
      break;
431
 
    case 'f':                   /* --env-for */
 
422
    case 'E':                   /* --env-for */
432
423
      if(arg == NULL){
433
424
        break;
434
425
      }
437
428
        if(envdef == NULL){
438
429
          break;
439
430
        }
440
 
        char *p_name = strndup(arg, (size_t) (envdef-arg));
441
 
        if(p_name == NULL){
442
 
          break;
443
 
        }
444
 
        envdef++;
445
 
        if(not add_environment(getplugin(p_name), envdef, true)){
 
431
        *envdef = '\0';
 
432
        if(not add_environment(getplugin(arg), envdef+1, true)){
446
433
          perror("add_environment");
447
434
        }
448
435
      }
456
443
        p->disabled = true;
457
444
      }
458
445
      break;
 
446
    case 'e':                   /* --enable */
 
447
      if (arg != NULL){
 
448
        plugin *p = getplugin(arg);
 
449
        if(p == NULL){
 
450
          return ARGP_ERR_UNKNOWN;
 
451
        }
 
452
        p->disabled = false;
 
453
      }
 
454
      break;
459
455
    case 128:                   /* --plugin-dir */
 
456
      free(plugindir);
460
457
      plugindir = strdup(arg);
461
458
      if(plugindir == NULL){
462
459
        perror("strdup");
475
472
      debug = true;
476
473
      break;
477
474
    case ARGP_KEY_ARG:
478
 
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
475
      /* Cryptsetup always passes an argument, which is an empty
 
476
         string if "none" was specified in /etc/crypttab.  So if
 
477
         argument was empty, we ignore it silently. */
 
478
      if(arg[0] != '\0'){
 
479
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
480
      }
479
481
      break;
480
482
    case ARGP_KEY_END:
481
483
      break;
492
494
                                 struct argp_state *state) {
493
495
    switch (key) {
494
496
    case 'g':                   /* --global-options */
495
 
    case 'e':                   /* --global-env */
 
497
    case 'G':                   /* --global-env */
496
498
    case 'o':                   /* --options-for */
497
 
    case 'f':                   /* --env-for */
 
499
    case 'E':                   /* --env-for */
498
500
    case 'd':                   /* --disable */
 
501
    case 'e':                   /* --enable */
499
502
    case 128:                   /* --plugin-dir */
500
503
      break;
501
504
    case 129:                   /* --config-file */
 
505
      free(argfile);
502
506
      argfile = strdup(arg);
503
507
      if(argfile == NULL){
504
508
        perror("strdup");
543
547
    char *org_line = NULL;
544
548
    char *p, *arg, *new_arg, *line;
545
549
    size_t size = 0;
546
 
    ssize_t sret;
547
550
    const char whitespace_delims[] = " \r\t\f\v\n";
548
551
    const char comment_delim[] = "#";
549
552
 
698
701
      
699
702
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
700
703
                                           ".dpkg-old",
 
704
                                           ".dpkg-bak",
701
705
                                           ".dpkg-divert", NULL };
702
706
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
703
707
        size_t pre_len = strlen(*pre);
734
738
    }
735
739
 
736
740
    char *filename;
737
 
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
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
    }
738
746
    if(ret < 0){
739
747
      perror("asprintf");
740
748
      continue;
840
848
        perror("sigaction");
841
849
        _exit(EXIT_FAILURE);
842
850
      }
843
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
851
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
844
852
      if(ret < 0){
845
853
        perror("sigprocmask");
846
854
        _exit(EXIT_FAILURE);
847
855
      }
848
 
 
 
856
      
849
857
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
850
858
      if(ret == -1){
851
859
        perror("dup2");
901
909
    if (maxfd < new_plugin->fd){
902
910
      maxfd = new_plugin->fd;
903
911
    }
904
 
    
905
912
  }
906
913
  
907
914
  closedir(dir);
908
915
  dir = NULL;
909
 
 
 
916
  
910
917
  for(plugin *p = plugin_list; p != NULL; p = p->next){
911
918
    if(p->pid != 0){
912
919
      break;
917
924
      free_plugin_list();
918
925
    }
919
926
  }
920
 
 
 
927
  
921
928
  /* Main loop while running plugins exist */
922
929
  while(plugin_list){
923
930
    fd_set rfds = rfds_all;
929
936
    }
930
937
    /* OK, now either a process completed, or something can be read
931
938
       from one of them */
932
 
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
939
    for(plugin *proc = plugin_list; proc != NULL;){
933
940
      /* Is this process completely done? */
934
941
      if(proc->eof and proc->completed){
935
942
        /* Only accept the plugin output if it exited cleanly */
962
969
            exitstatus = EXIT_FAILURE;
963
970
            goto fallback;
964
971
          }
 
972
          
 
973
          plugin *next_plugin = proc->next;
965
974
          free_plugin(proc);
 
975
          proc = next_plugin;
 
976
          
966
977
          /* We are done modifying process list, so unblock signal */
967
978
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
968
979
                             NULL);
975
986
          if(plugin_list == NULL){
976
987
            break;
977
988
          }
 
989
          
978
990
          continue;
979
991
        }
980
992
        
981
993
        /* This process exited nicely, so print its buffer */
982
 
 
 
994
        
983
995
        bool bret = print_out_password(proc->buffer,
984
996
                                       proc->buffer_length);
985
997
        if(not bret){
992
1004
      /* This process has not completed.  Does it have any output? */
993
1005
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
994
1006
        /* This process had nothing to say at this time */
 
1007
        proc = proc->next;
995
1008
        continue;
996
1009
      }
997
1010
      /* Before reading, make the process' data buffer large enough */
1006
1019
        proc->buffer_size += BUFFER_SIZE;
1007
1020
      }
1008
1021
      /* Read from the process */
1009
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1010
 
                 BUFFER_SIZE);
1011
 
      if(ret < 0){
 
1022
      sret = read(proc->fd, proc->buffer + proc->buffer_length,
 
1023
                  BUFFER_SIZE);
 
1024
      if(sret < 0){
1012
1025
        /* Read error from this process; ignore the error */
 
1026
        proc = proc->next;
1013
1027
        continue;
1014
1028
      }
1015
 
      if(ret == 0){
 
1029
      if(sret == 0){
1016
1030
        /* got EOF */
1017
1031
        proc->eof = true;
1018
1032
      } else {
1019
 
        proc->buffer_length += (size_t) ret;
 
1033
        proc->buffer_length += (size_t) sret;
1020
1034
      }
1021
1035
    }
1022
1036
  }
1030
1044
    bool bret;
1031
1045
    fprintf(stderr, "Going to fallback mode using getpass(3)\n");
1032
1046
    char *passwordbuffer = getpass("Password: ");
1033
 
    bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
 
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);
1034
1054
    if(not bret){
1035
1055
      perror("print_out_password");
1036
1056
      exitstatus = EXIT_FAILURE;
1043
1063
    perror("sigaction");
1044
1064
    exitstatus = EXIT_FAILURE;
1045
1065
  }
1046
 
 
 
1066
  
1047
1067
  if(custom_argv != NULL){
1048
1068
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1049
1069
      free(*arg);
1055
1075
    closedir(dir);
1056
1076
  }
1057
1077
  
1058
 
  /* Free the process list and kill the processes */
 
1078
  /* Kill the processes */
1059
1079
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1060
1080
    if(p->pid != 0){
1061
1081
      close(p->fd);
1074
1094
  if(errno != ECHILD){
1075
1095
    perror("wait");
1076
1096
  }
1077
 
 
 
1097
  
1078
1098
  free_plugin_list();
1079
1099
  
1080
1100
  free(plugindir);