/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-10-24 19:17:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091024191752-7g6xlf6wpp2pdexb
Convert some programs to use the exit codes from <sysexits.h>.  Change
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.

* plugin-runner.c: Use <sysexits.h> exit codes.  Always use fallback,
                   even on option errors, except for "--help", etc.
  (getplugin): Make sure "errno" is set correctly on return.
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not cause the fallback to be invoked.
          In all other options, use fallback on any error.
  (parse_opt, parse_opt_config_file): Reset errno at start and return
                                      errno.  No need to check "arg"
                                      for NULL.  New "--help",
                                      "--usage", and "--version"
                                      options.
  (parse_opt): Accept empty string as global option.  Do not print
               errors which will be detected and reported later.  Do
               "argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes.  Do not
                             return successful exit code on "--help",
                             etc. since this would give the wrong
                             message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not return a successful exit code.
  (parse_opt): Reset errno at start and return errno.  Do
               "argp_error()" on parse errors.  New "--help",
               "--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>.  Do
                               not return successful exit code on
                               "--help", etc. since this would give
                               the wrong message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version" options
          which do not return a successful exit code.  Do
          close(STDOUT_FILENO) after writing to check its return code.
  (parse_opt): Reset errno at start and return errno.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.c
68
68
                                */
69
69
#include <errno.h>              /* errno, EBADF */
70
70
#include <inttypes.h>           /* intmax_t, PRIdMAX, strtoimax() */
 
71
#include <sysexits.h>           /* EX_OSERR, EX_USAGE */
71
72
 
72
73
#define BUFFER_SIZE 256
73
74
 
102
103
/* Gets an existing plugin based on name,
103
104
   or if none is found, creates a new one */
104
105
static plugin *getplugin(char *name){
105
 
  /* Check for exiting plugin with that name */
 
106
  /* Check for existing plugin with that name */
106
107
  for(plugin *p = plugin_list; p != NULL; p = p->next){
107
108
    if((p->name == name)
108
109
       or (p->name and name and (strcmp(p->name, name) == 0))){
123
124
      copy_name = strdup(name);
124
125
    } while(copy_name == NULL and errno == EINTR);
125
126
    if(copy_name == NULL){
 
127
      int e = errno;
126
128
      free(new_plugin);
 
129
      errno = e;
127
130
      return NULL;
128
131
    }
129
132
  }
137
140
    new_plugin->argv = malloc(sizeof(char *) * 2);
138
141
  } while(new_plugin->argv == NULL and errno == EINTR);
139
142
  if(new_plugin->argv == NULL){
 
143
    int e = errno;
140
144
    free(copy_name);
141
145
    free(new_plugin);
 
146
    errno = e;
142
147
    return NULL;
143
148
  }
144
149
  new_plugin->argv[0] = copy_name;
148
153
    new_plugin->environ = malloc(sizeof(char *));
149
154
  } while(new_plugin->environ == NULL and errno == EINTR);
150
155
  if(new_plugin->environ == NULL){
 
156
    int e = errno;
151
157
    free(copy_name);
152
158
    free(new_plugin->argv);
153
159
    free(new_plugin);
 
160
    errno = e;
154
161
    return NULL;
155
162
  }
156
163
  new_plugin->environ[0] = NULL;
394
401
      .doc = "Group ID the plugins will run as", .group = 3 },
395
402
    { .name = "debug", .key = 132,
396
403
      .doc = "Debug mode", .group = 4 },
 
404
    /*
 
405
     * These reproduce what we would get without ARGP_NO_HELP
 
406
     */
 
407
    { .name = "help", .key = '?',
 
408
      .doc = "Give this help list", .group = -1 },
 
409
    { .name = "usage", .key = -3,
 
410
      .doc = "Give a short usage message", .group = -1 },
 
411
    { .name = "version", .key = 'V',
 
412
      .doc = "Print program version", .group = -1 },
397
413
    { .name = NULL }
398
414
  };
399
415
  
400
 
  error_t parse_opt(int key, char *arg, __attribute__((unused))
401
 
                    struct argp_state *state){
 
416
  error_t parse_opt(int key, char *arg, struct argp_state *state){
 
417
    errno = 0;
402
418
    switch(key){
403
419
      char *tmp;
404
420
      intmax_t tmpmax;
405
421
    case 'g':                   /* --global-options */
406
 
      if(arg != NULL){
 
422
      {
407
423
        char *plugin_option;
408
424
        while((plugin_option = strsep(&arg, ",")) != NULL){
409
 
          if(plugin_option[0] == '\0'){
410
 
            continue;
411
 
          }
412
425
          if(not add_argument(getplugin(NULL), plugin_option)){
413
 
            perror("add_argument");
414
 
            return ARGP_ERR_UNKNOWN;
 
426
            break;
415
427
          }
416
428
        }
417
429
      }
418
430
      break;
419
431
    case 'G':                   /* --global-env */
420
 
      if(arg == NULL){
421
 
        break;
422
 
      }
423
 
      if(not add_environment(getplugin(NULL), arg, true)){
424
 
        perror("add_environment");
425
 
      }
 
432
      add_environment(getplugin(NULL), arg, true);
426
433
      break;
427
434
    case 'o':                   /* --options-for */
428
 
      if(arg != NULL){
429
 
        char *plugin_name = strsep(&arg, ":");
430
 
        if(plugin_name[0] == '\0'){
431
 
          break;
432
 
        }
433
 
        char *plugin_option;
434
 
        while((plugin_option = strsep(&arg, ",")) != NULL){
435
 
          if(not add_argument(getplugin(plugin_name), plugin_option)){
436
 
            perror("add_argument");
437
 
            return ARGP_ERR_UNKNOWN;
 
435
      {
 
436
        char *option_list = strchr(arg, ':');
 
437
        if(option_list == NULL){
 
438
          argp_error(state, "No colon in \"%s\"", arg);
 
439
          errno = EINVAL;
 
440
          break;
 
441
        }
 
442
        *option_list = '\0';
 
443
        option_list++;
 
444
        if(arg[0] == '\0'){
 
445
          argp_error(state, "Empty plugin name");
 
446
          errno = EINVAL;
 
447
          break;
 
448
        }
 
449
        char *option;
 
450
        while((option = strsep(&option_list, ",")) != NULL){
 
451
          if(not add_argument(getplugin(arg), option)){
 
452
            break;
438
453
          }
439
454
        }
440
455
      }
441
456
      break;
442
457
    case 'E':                   /* --env-for */
443
 
      if(arg == NULL){
444
 
        break;
445
 
      }
446
458
      {
447
459
        char *envdef = strchr(arg, ':');
448
460
        if(envdef == NULL){
 
461
          argp_error(state, "No colon in \"%s\"", arg);
 
462
          errno = EINVAL;
449
463
          break;
450
464
        }
451
465
        *envdef = '\0';
452
 
        if(not add_environment(getplugin(arg), envdef+1, true)){
453
 
          perror("add_environment");
 
466
        envdef++;
 
467
        if(arg[0] == '\0'){
 
468
          argp_error(state, "Empty plugin name");
 
469
          errno = EINVAL;
 
470
          break;
454
471
        }
 
472
        add_environment(getplugin(arg), envdef, true);
455
473
      }
456
474
      break;
457
475
    case 'd':                   /* --disable */
458
 
      if(arg != NULL){
 
476
      {
459
477
        plugin *p = getplugin(arg);
460
 
        if(p == NULL){
461
 
          return ARGP_ERR_UNKNOWN;
 
478
        if(p != NULL){
 
479
          p->disabled = true;
462
480
        }
463
 
        p->disabled = true;
464
481
      }
465
482
      break;
466
483
    case 'e':                   /* --enable */
467
 
      if(arg != NULL){
 
484
      {
468
485
        plugin *p = getplugin(arg);
469
 
        if(p == NULL){
470
 
          return ARGP_ERR_UNKNOWN;
 
486
        if(p != NULL){
 
487
          p->disabled = false;
471
488
        }
472
 
        p->disabled = false;
473
489
      }
474
490
      break;
475
491
    case 128:                   /* --plugin-dir */
476
492
      free(plugindir);
477
493
      plugindir = strdup(arg);
478
 
      if(plugindir == NULL){
479
 
        perror("strdup");
480
 
      }
481
494
      break;
482
495
    case 129:                   /* --config-file */
483
496
      /* This is already done by parse_opt_config_file() */
484
497
      break;
485
498
    case 130:                   /* --userid */
486
 
      errno = 0;
487
499
      tmpmax = strtoimax(arg, &tmp, 10);
488
500
      if(errno != 0 or tmp == arg or *tmp != '\0'
489
501
         or tmpmax != (uid_t)tmpmax){
490
 
        fprintf(stderr, "Bad user ID number: \"%s\", using %"
491
 
                PRIdMAX "\n", arg, (intmax_t)uid);
492
 
      } else {
493
 
        uid = (uid_t)tmpmax;
 
502
        argp_error(state, "Bad user ID number: \"%s\", using %"
 
503
                   PRIdMAX, arg, (intmax_t)uid);
 
504
        break;
494
505
      }
 
506
      uid = (uid_t)tmpmax;
495
507
      break;
496
508
    case 131:                   /* --groupid */
497
 
      errno = 0;
498
509
      tmpmax = strtoimax(arg, &tmp, 10);
499
510
      if(errno != 0 or tmp == arg or *tmp != '\0'
500
511
         or tmpmax != (gid_t)tmpmax){
501
 
        fprintf(stderr, "Bad group ID number: \"%s\", using %"
502
 
                PRIdMAX "\n", arg, (intmax_t)gid);
503
 
      } else {
504
 
        gid = (gid_t)tmpmax;
 
512
        argp_error(state, "Bad group ID number: \"%s\", using %"
 
513
                   PRIdMAX, arg, (intmax_t)gid);
 
514
        break;
505
515
      }
 
516
      gid = (gid_t)tmpmax;
506
517
      break;
507
518
    case 132:                   /* --debug */
508
519
      debug = true;
509
520
      break;
 
521
      /*
 
522
       * These reproduce what we would get without ARGP_NO_HELP
 
523
       */
 
524
    case '?':                   /* --help */
 
525
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
 
526
      argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
 
527
    case -3:                    /* --usage */
 
528
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
 
529
      argp_state_help(state, state->out_stream,
 
530
                      ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
 
531
    case 'V':                   /* --version */
 
532
      fprintf(state->out_stream, "%s\n", argp_program_version);
 
533
      exit(EXIT_SUCCESS);
 
534
      break;
510
535
/*
511
536
 * When adding more options before this line, remember to also add a
512
537
 * "case" to the "parse_opt_config_file" function below.
515
540
      /* Cryptsetup always passes an argument, which is an empty
516
541
         string if "none" was specified in /etc/crypttab.  So if
517
542
         argument was empty, we ignore it silently. */
518
 
      if(arg[0] != '\0'){
519
 
        fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
 
543
      if(arg[0] == '\0'){
 
544
        break;
520
545
      }
521
 
      break;
522
 
    case ARGP_KEY_END:
523
 
      break;
524
546
    default:
525
547
      return ARGP_ERR_UNKNOWN;
526
548
    }
527
 
    return 0;
 
549
    return errno;               /* Set to 0 at start */
528
550
  }
529
551
  
530
552
  /* This option parser is the same as parse_opt() above, except it
532
554
  error_t parse_opt_config_file(int key, char *arg,
533
555
                                __attribute__((unused))
534
556
                                struct argp_state *state){
 
557
    errno = 0;
535
558
    switch(key){
536
559
    case 'g':                   /* --global-options */
537
560
    case 'G':                   /* --global-env */
544
567
    case 129:                   /* --config-file */
545
568
      free(argfile);
546
569
      argfile = strdup(arg);
547
 
      if(argfile == NULL){
548
 
        perror("strdup");
549
 
      }
550
570
      break;
551
571
    case 130:                   /* --userid */
552
572
    case 131:                   /* --groupid */
553
573
    case 132:                   /* --debug */
 
574
    case '?':                   /* --help */
 
575
    case -3:                    /* --usage */
 
576
    case 'V':                   /* --version */
554
577
    case ARGP_KEY_ARG:
555
 
    case ARGP_KEY_END:
556
578
      break;
557
579
    default:
558
580
      return ARGP_ERR_UNKNOWN;
559
581
    }
560
 
    return 0;
 
582
    return errno;
561
583
  }
562
584
  
563
585
  struct argp argp = { .options = options,
567
589
  
568
590
  /* Parse using parse_opt_config_file() in order to get the custom
569
591
     config file location, if any. */
570
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
571
 
  if(ret == ARGP_ERR_UNKNOWN){
572
 
    fprintf(stderr, "Unknown error while parsing arguments\n");
573
 
    exitstatus = EXIT_FAILURE;
 
592
  ret = argp_parse(&argp, argc, argv,
 
593
                   ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
 
594
                   NULL, NULL);
 
595
  switch(ret){
 
596
  case 0:
 
597
    break;
 
598
  case ENOMEM:
 
599
  default:
 
600
    errno = ret;
 
601
    perror("argp_parse");
 
602
    exitstatus = EX_OSERR;
 
603
    goto fallback;
 
604
  case EINVAL:
 
605
    exitstatus = EX_USAGE;
574
606
    goto fallback;
575
607
  }
576
608
  
653
685
      goto fallback;
654
686
    }
655
687
  }
656
 
  /* If there was any arguments from configuration file,
657
 
     pass them to parser as command arguments */
 
688
  /* If there were any arguments from the configuration file, pass
 
689
     them to parser as command line arguments */
658
690
  if(custom_argv != NULL){
659
 
    ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
660
 
                     0, NULL);
661
 
    if(ret == ARGP_ERR_UNKNOWN){
662
 
      fprintf(stderr, "Unknown error while parsing arguments\n");
663
 
      exitstatus = EXIT_FAILURE;
 
691
    ret = argp_parse(&argp, custom_argc, custom_argv,
 
692
                     ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
 
693
                     NULL, NULL);
 
694
    switch(ret){
 
695
    case 0:
 
696
      break;
 
697
    case ENOMEM:
 
698
    default:
 
699
      errno = ret;
 
700
      perror("argp_parse");
 
701
      exitstatus = EX_OSERR;
 
702
      goto fallback;
 
703
    case EINVAL:
 
704
      exitstatus = EX_CONFIG;
664
705
      goto fallback;
665
706
    }
666
707
  }
667
708
  
668
709
  /* Parse actual command line arguments, to let them override the
669
710
     config file */
670
 
  ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
671
 
  if(ret == ARGP_ERR_UNKNOWN){
672
 
    fprintf(stderr, "Unknown error while parsing arguments\n");
673
 
    exitstatus = EXIT_FAILURE;
 
711
  ret = argp_parse(&argp, argc, argv,
 
712
                   ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
 
713
                   NULL, NULL);
 
714
  switch(ret){
 
715
  case 0:
 
716
    break;
 
717
  case ENOMEM:
 
718
  default:
 
719
    errno = ret;
 
720
    perror("argp_parse");
 
721
    exitstatus = EX_OSERR;
 
722
    goto fallback;
 
723
  case EINVAL:
 
724
    exitstatus = EX_USAGE;
674
725
    goto fallback;
675
726
  }
676
727