/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-08 18:54:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908185447-dm2ertwxa20qbckf
* INSTALL: Even better text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.c
96
96
 
97
97
static plugin *plugin_list = NULL;
98
98
 
99
 
/* Gets a existing plugin based on name,
 
99
/* Gets an existing plugin based on name,
100
100
   or if none is found, creates a new one */
101
101
static plugin *getplugin(char *name){
102
102
  /* Check for exiting plugin with that name */
118
118
      return NULL;
119
119
    }
120
120
  }
121
 
 
 
121
  
122
122
  *new_plugin = (plugin) { .name = copy_name,
123
123
                           .argc = 1,
124
124
                           .disabled = false,
132
132
  }
133
133
  new_plugin->argv[0] = copy_name;
134
134
  new_plugin->argv[1] = NULL;
135
 
 
 
135
  
136
136
  new_plugin->environ = malloc(sizeof(char *));
137
137
  if(new_plugin->environ == NULL){
138
138
    free(copy_name);
141
141
    return NULL;
142
142
  }
143
143
  new_plugin->environ[0] = NULL;
144
 
 
 
144
  
145
145
  /* Append the new plugin to the list */
146
146
  plugin_list = new_plugin;
147
147
  return new_plugin;
179
179
}
180
180
 
181
181
/* Add to a plugin's environment */
182
 
static bool add_environment(plugin *p, const char *def){
 
182
static bool add_environment(plugin *p, const char *def, bool replace){
183
183
  if(p == NULL){
184
184
    return false;
185
185
  }
 
186
  /* namelen = length of name of environment variable */
 
187
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
 
188
  /* Search for this environment variable */
 
189
  for(char **e = p->environ; *e != NULL; e++){
 
190
    if(strncmp(*e, def, namelen + 1) == 0){
 
191
      /* It already exists */
 
192
      if(replace){
 
193
        char *new = realloc(*e, strlen(def) + 1);
 
194
        if(new == NULL){
 
195
          return false;
 
196
        }
 
197
        *e = new;
 
198
        strcpy(*e, def);
 
199
      }
 
200
      return true;
 
201
    }
 
202
  }
186
203
  return add_to_char_array(def, &(p->environ), &(p->envc));
187
204
}
188
205
 
221
238
      /* No child processes */
222
239
      break;
223
240
    }
224
 
 
 
241
    
225
242
    /* A child exited, find it in process_list */
226
243
    while(proc != NULL and proc->pid != pid){
227
244
      proc = proc->next;
238
255
/* Prints out a password to stdout */
239
256
bool print_out_password(const char *buffer, size_t length){
240
257
  ssize_t ret;
241
 
  if(length>0 and buffer[length-1] == '\n'){
242
 
    length--;
243
 
  }
244
258
  for(size_t written = 0; written < length; written += (size_t)ret){
245
259
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
246
260
                                   length - written));
327
341
    { .name = "global-options", .key = 'g',
328
342
      .arg = "OPTION[,OPTION[,...]]",
329
343
      .doc = "Options passed to all plugins" },
330
 
    { .name = "global-envs", .key = 'e',
 
344
    { .name = "global-env", .key = 'G',
331
345
      .arg = "VAR=value",
332
346
      .doc = "Environment variable passed to all plugins" },
333
347
    { .name = "options-for", .key = 'o',
334
348
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
335
349
      .doc = "Options passed only to specified plugin" },
336
 
    { .name = "envs-for", .key = 'f',
 
350
    { .name = "env-for", .key = 'E',
337
351
      .arg = "PLUGIN:ENV=value",
338
352
      .doc = "Environment variable passed to specified plugin" },
339
353
    { .name = "disable", .key = 'd',
340
354
      .arg = "PLUGIN",
341
355
      .doc = "Disable a specific plugin", .group = 1 },
 
356
    { .name = "enable", .key = 'e',
 
357
      .arg = "PLUGIN",
 
358
      .doc = "Enable a specific plugin", .group = 1 },
342
359
    { .name = "plugin-dir", .key = 128,
343
360
      .arg = "DIRECTORY",
344
361
      .doc = "Specify a different plugin directory", .group = 2 },
358
375
  
359
376
  error_t parse_opt (int key, char *arg, __attribute__((unused))
360
377
                     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
378
    switch (key) {
364
379
    case 'g':                   /* --global-options */
365
380
      if (arg != NULL){
375
390
        }
376
391
      }
377
392
      break;
378
 
    case 'e':                   /* --global-envs */
 
393
    case 'G':                   /* --global-env */
379
394
      if(arg == NULL){
380
395
        break;
381
396
      }
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
      if(not add_environment(getplugin(NULL), arg, true)){
 
398
        perror("add_environment");
390
399
      }
391
400
      break;
392
401
    case 'o':                   /* --options-for */
393
402
      if (arg != NULL){
394
403
        char *p_name = strsep(&arg, ":");
395
 
        if(p_name[0] == '\0'){
 
404
        if(p_name[0] == '\0' or arg == NULL){
396
405
          break;
397
406
        }
398
407
        char *opt = strsep(&arg, ":");
399
 
        if(opt[0] == '\0'){
 
408
        if(opt[0] == '\0' or opt == NULL){
400
409
          break;
401
410
        }
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
 
            }
 
411
        char *p;
 
412
        while((p = strsep(&opt, ",")) != NULL){
 
413
          if(p[0] == '\0'){
 
414
            continue;
 
415
          }
 
416
          if(not add_argument(getplugin(p_name), p)){
 
417
            perror("add_argument");
 
418
            return ARGP_ERR_UNKNOWN;
412
419
          }
413
420
        }
414
421
      }
415
422
      break;
416
 
    case 'f':                   /* --envs-for */
 
423
    case 'E':                   /* --env-for */
417
424
      if(arg == NULL){
418
425
        break;
419
426
      }
422
429
        if(envdef == NULL){
423
430
          break;
424
431
        }
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
        *envdef = '\0';
 
433
        if(not add_environment(getplugin(arg), envdef+1, true)){
431
434
          perror("add_environment");
432
435
        }
433
436
      }
441
444
        p->disabled = true;
442
445
      }
443
446
      break;
 
447
    case 'e':                   /* --enable */
 
448
      if (arg != NULL){
 
449
        plugin *p = getplugin(arg);
 
450
        if(p == NULL){
 
451
          return ARGP_ERR_UNKNOWN;
 
452
        }
 
453
        p->disabled = false;
 
454
      }
 
455
      break;
444
456
    case 128:                   /* --plugin-dir */
 
457
      free(plugindir);
445
458
      plugindir = strdup(arg);
446
459
      if(plugindir == NULL){
447
460
        perror("strdup");
448
461
      }      
449
462
      break;
450
463
    case 129:                   /* --config-file */
 
464
      /* This is already done by parse_opt_config_file() */
 
465
      break;
 
466
    case 130:                   /* --userid */
 
467
      uid = (uid_t)strtol(arg, NULL, 10);
 
468
      break;
 
469
    case 131:                   /* --groupid */
 
470
      gid = (gid_t)strtol(arg, NULL, 10);
 
471
      break;
 
472
    case 132:                   /* --debug */
 
473
      debug = true;
 
474
      break;
 
475
    case ARGP_KEY_ARG:
 
476
      /* Cryptsetup always passes an argument, which is an empty
 
477
         string if "none" was specified in /etc/crypttab.  So if
 
478
         argument was empty, we ignore it silently. */
 
479
      if(arg[0] != '\0'){
 
480
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
481
      }
 
482
      break;
 
483
    case ARGP_KEY_END:
 
484
      break;
 
485
    default:
 
486
      return ARGP_ERR_UNKNOWN;
 
487
    }
 
488
    return 0;
 
489
  }
 
490
  
 
491
  /* This option parser is the same as parse_opt() above, except it
 
492
     ignores everything but the --config-file option. */
 
493
  error_t parse_opt_config_file (int key, char *arg,
 
494
                                 __attribute__((unused))
 
495
                                 struct argp_state *state) {
 
496
    switch (key) {
 
497
    case 'g':                   /* --global-options */
 
498
    case 'G':                   /* --global-env */
 
499
    case 'o':                   /* --options-for */
 
500
    case 'E':                   /* --env-for */
 
501
    case 'd':                   /* --disable */
 
502
    case 'e':                   /* --enable */
 
503
    case 128:                   /* --plugin-dir */
 
504
      break;
 
505
    case 129:                   /* --config-file */
 
506
      free(argfile);
451
507
      argfile = strdup(arg);
452
508
      if(argfile == NULL){
453
509
        perror("strdup");
454
510
      }
455
511
      break;      
456
512
    case 130:                   /* --userid */
457
 
      uid = (uid_t)strtol(arg, NULL, 10);
458
 
      break;
459
513
    case 131:                   /* --groupid */
460
 
      gid = (gid_t)strtol(arg, NULL, 10);
461
 
      break;
462
514
    case 132:                   /* --debug */
463
 
      debug = true;
464
 
      break;
465
515
    case ARGP_KEY_ARG:
466
 
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
467
 
      break;
468
516
    case ARGP_KEY_END:
469
517
      break;
470
518
    default:
473
521
    return 0;
474
522
  }
475
523
  
476
 
  struct argp argp = { .options = options, .parser = parse_opt,
477
 
                       .args_doc = "[+PLUS_SEPARATED_OPTIONS]",
 
524
  struct argp argp = { .options = options,
 
525
                       .parser = parse_opt_config_file,
 
526
                       .args_doc = "",
478
527
                       .doc = "Mandos plugin runner -- Run plugins" };
479
528
  
480
 
  ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
 
529
  /* Parse using the parse_opt_config_file in order to get the custom
 
530
     config file location, if any. */
 
531
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
481
532
  if (ret == ARGP_ERR_UNKNOWN){
482
533
    fprintf(stderr, "Unknown error while parsing arguments\n");
483
534
    exitstatus = EXIT_FAILURE;
484
535
    goto fallback;
485
536
  }
486
 
 
487
 
  /* Opens the configfile if aviable */
 
537
  
 
538
  /* Reset to the normal argument parser */
 
539
  argp.parser = parse_opt;
 
540
  
 
541
  /* Open the configfile if available */
488
542
  if (argfile == NULL){
489
543
    conffp = fopen(AFILE, "r");
490
544
  } else {
544
598
      }
545
599
    }
546
600
    free(org_line);
547
 
  } else{
 
601
  } else {
548
602
    /* Check for harmful errors and go to fallback. Other errors might
549
603
       not affect opening plugins */
550
604
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
556
610
  /* If there was any arguments from configuration file,
557
611
     pass them to parser as command arguments */
558
612
  if(custom_argv != NULL){
559
 
    ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
 
613
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
 
614
                      0, NULL);
560
615
    if (ret == ARGP_ERR_UNKNOWN){
561
616
      fprintf(stderr, "Unknown error while parsing arguments\n");
562
617
      exitstatus = EXIT_FAILURE;
564
619
    }
565
620
  }
566
621
  
 
622
  /* Parse actual command line arguments, to let them override the
 
623
     config file */
 
624
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
 
625
  if (ret == ARGP_ERR_UNKNOWN){
 
626
    fprintf(stderr, "Unknown error while parsing arguments\n");
 
627
    exitstatus = EXIT_FAILURE;
 
628
    goto fallback;
 
629
  }
 
630
  
567
631
  if(debug){
568
632
    for(plugin *p = plugin_list; p != NULL; p=p->next){
569
633
      fprintf(stderr, "Plugin: %s has %d arguments\n",
577
641
      }
578
642
    }
579
643
  }
580
 
 
 
644
  
581
645
  /* Strip permissions down to nobody */
582
646
  ret = setuid(uid);
583
647
  if (ret == -1){
587
651
  if (ret == -1){
588
652
    perror("setgid");
589
653
  }
590
 
 
 
654
  
591
655
  if (plugindir == NULL){
592
656
    dir = opendir(PDIR);
593
657
  } else {
614
678
  }
615
679
  
616
680
  FD_ZERO(&rfds_all);
617
 
 
 
681
  
618
682
  /* Read and execute any executable in the plugin directory*/
619
683
  while(true){
620
684
    dirst = readdir(dir);
621
685
    
622
 
    // All directory entries have been processed
 
686
    /* All directory entries have been processed */
623
687
    if(dirst == NULL){
624
688
      if (errno == EBADF){
625
689
        perror("readdir");
631
695
    
632
696
    d_name_len = strlen(dirst->d_name);
633
697
    
634
 
    // Ignore dotfiles, backup files and other junk
 
698
    /* Ignore dotfiles, backup files and other junk */
635
699
    {
636
700
      bool bad_name = false;
637
701
      
675
739
    }
676
740
 
677
741
    char *filename;
678
 
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
742
    if(plugindir == NULL){
 
743
      ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
 
744
    } else {
 
745
      ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
746
    }
679
747
    if(ret < 0){
680
748
      perror("asprintf");
681
749
      continue;
723
791
        }
724
792
        /* Add global environment variables */
725
793
        for(char **e = g->environ; *e != NULL; e++){
726
 
          if(not add_environment(p, *e)){
 
794
          if(not add_environment(p, *e, false)){
727
795
            perror("add_environment");
728
796
          }
729
797
        }
734
802
       process, too. */
735
803
    if(p->environ[0] != NULL){
736
804
      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)){
 
805
        if(not add_environment(p, *e, false)){
743
806
          perror("add_environment");
744
807
        }
745
808
      }
772
835
      exitstatus = EXIT_FAILURE;
773
836
      goto fallback;
774
837
    }
775
 
    // Starting a new process to be watched
 
838
    /* Starting a new process to be watched */
776
839
    pid_t pid = fork();
777
840
    if(pid == -1){
778
841
      perror("fork");
875
938
    }
876
939
    /* OK, now either a process completed, or something can be read
877
940
       from one of them */
878
 
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
941
    for(plugin *proc = plugin_list; proc != NULL;){
879
942
      /* Is this process completely done? */
880
943
      if(proc->eof and proc->completed){
881
944
        /* Only accept the plugin output if it exited cleanly */
908
971
            exitstatus = EXIT_FAILURE;
909
972
            goto fallback;
910
973
          }
911
 
          free_plugin(proc);
 
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
          
 
988
          plugin *next_plugin = proc->next;
 
989
          free_plugin(proc);
 
990
          proc = next_plugin;
924
991
          continue;
925
992
        }
926
993
        
938
1005
      /* This process has not completed.  Does it have any output? */
939
1006
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
940
1007
        /* This process had nothing to say at this time */
 
1008
        proc = proc->next;
941
1009
        continue;
942
1010
      }
943
1011
      /* Before reading, make the process' data buffer large enough */
956
1024
                 BUFFER_SIZE);
957
1025
      if(ret < 0){
958
1026
        /* Read error from this process; ignore the error */
 
1027
        proc = proc->next;
959
1028
        continue;
960
1029
      }
961
1030
      if(ret == 0){
976
1045
    bool bret;
977
1046
    fprintf(stderr, "Going to fallback mode using getpass(3)\n");
978
1047
    char *passwordbuffer = getpass("Password: ");
979
 
    bret = print_out_password(passwordbuffer, strlen(passwordbuffer));
 
1048
    size_t len = strlen(passwordbuffer);
 
1049
    /* Strip trailing newline */
 
1050
    if(len > 0 and passwordbuffer[len-1] == '\n'){
 
1051
      passwordbuffer[len-1] = '\0'; /* not strictly necessary */
 
1052
      len--;
 
1053
    }
 
1054
    bret = print_out_password(passwordbuffer, len);
980
1055
    if(not bret){
981
1056
      perror("print_out_password");
982
1057
      exitstatus = EXIT_FAILURE;