/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:
1
 
/*  -*- coding: utf-8 -*- */
 
1
/*  -*- coding: utf-8; mode: c; mode: orgtbl -*- */
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
22
23
 */
23
24
 
24
25
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY(), getline(),
25
 
                                   asprintf() */
 
26
                                   asprintf(), O_CLOEXEC */
26
27
#include <stddef.h>             /* size_t, NULL */
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 */
32
 
#include <sys/types.h>          /* DIR, opendir(), stat(), struct
 
31
#include <stdio.h>              /* perror, fileno(), fprintf(),
 
32
                                   stderr, STDOUT_FILENO */
 
33
#include <sys/types.h>          /* DIR, fdopendir(), stat(), struct
33
34
                                   stat, waitpid(), WIFEXITED(),
34
35
                                   WEXITSTATUS(), wait(), pid_t,
35
36
                                   uid_t, gid_t, getuid(), getgid(),
37
38
#include <sys/select.h>         /* fd_set, select(), FD_ZERO(),
38
39
                                   FD_SET(), FD_ISSET(), FD_CLR */
39
40
#include <sys/wait.h>           /* wait(), waitpid(), WIFEXITED(),
40
 
                                   WEXITSTATUS() */
 
41
                                   WEXITSTATUS(), WTERMSIG(),
 
42
                                   WCOREDUMP() */
41
43
#include <sys/stat.h>           /* struct stat, stat(), S_ISREG() */
42
44
#include <iso646.h>             /* and, or, not */
43
 
#include <dirent.h>             /* DIR, struct dirent, opendir(),
 
45
#include <dirent.h>             /* DIR, struct dirent, fdopendir(),
44
46
                                   readdir(), closedir(), dirfd() */
45
47
#include <unistd.h>             /* struct stat, stat(), S_ISREG(),
46
48
                                   fcntl(), setuid(), setgid(),
47
49
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
48
50
                                   access(), pipe(), fork(), close()
49
 
                                   dup2, STDOUT_FILENO, _exit(),
 
51
                                   dup2(), STDOUT_FILENO, _exit(),
50
52
                                   execv(), write(), read(),
51
53
                                   close() */
52
54
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
53
55
                                   FD_CLOEXEC */
54
 
#include <string.h>             /* strsep, strlen(), asprintf() */
 
56
#include <string.h>             /* strsep, strlen(), asprintf(),
 
57
                                   strsignal() */
55
58
#include <errno.h>              /* errno */
56
59
#include <argp.h>               /* struct argp_option, struct
57
60
                                   argp_state, struct argp,
61
64
#include <signal.h>             /* struct sigaction, sigemptyset(),
62
65
                                   sigaddset(), sigaction(),
63
66
                                   sigprocmask(), SIG_BLOCK, SIGCHLD,
64
 
                                   SIG_UNBLOCK, kill() */
 
67
                                   SIG_UNBLOCK, kill(), sig_atomic_t
 
68
                                */
65
69
#include <errno.h>              /* errno, EBADF */
 
70
#include <inttypes.h>           /* intmax_t, PRIdMAX, strtoimax() */
 
71
#include <sysexits.h>           /* EX_OSERR, EX_USAGE */
66
72
 
67
73
#define BUFFER_SIZE 256
68
74
 
69
75
#define PDIR "/lib/mandos/plugins.d"
70
76
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
71
77
 
72
 
const char *argp_program_version = "plugin-runner 1.0";
 
78
const char *argp_program_version = "plugin-runner " VERSION;
73
79
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
74
80
 
75
 
struct plugin;
76
 
 
77
81
typedef struct plugin{
78
82
  char *name;                   /* can be NULL or any plugin name */
79
83
  char **argv;
81
85
  char **environ;
82
86
  int envc;
83
87
  bool disabled;
84
 
 
 
88
  
85
89
  /* Variables used for running processes*/
86
90
  pid_t pid;
87
91
  int fd;
89
93
  size_t buffer_size;
90
94
  size_t buffer_length;
91
95
  bool eof;
92
 
  volatile bool completed;
93
 
  volatile int status;
 
96
  volatile sig_atomic_t completed;
 
97
  int status;
94
98
  struct plugin *next;
95
99
} plugin;
96
100
 
99
103
/* Gets an existing plugin based on name,
100
104
   or if none is found, creates a new one */
101
105
static plugin *getplugin(char *name){
102
 
  /* Check for exiting plugin with that name */
103
 
  for (plugin *p = plugin_list; p != NULL; p = p->next){
104
 
    if ((p->name == name)
105
 
        or (p->name and name and (strcmp(p->name, name) == 0))){
 
106
  /* Check for existing plugin with that name */
 
107
  for(plugin *p = plugin_list; p != NULL; p = p->next){
 
108
    if((p->name == name)
 
109
       or (p->name and name and (strcmp(p->name, name) == 0))){
106
110
      return p;
107
111
    }
108
112
  }
109
113
  /* Create a new plugin */
110
 
  plugin *new_plugin = malloc(sizeof(plugin));
111
 
  if (new_plugin == NULL){
 
114
  plugin *new_plugin = NULL;
 
115
  do {
 
116
    new_plugin = malloc(sizeof(plugin));
 
117
  } while(new_plugin == NULL and errno == EINTR);
 
118
  if(new_plugin == NULL){
112
119
    return NULL;
113
120
  }
114
121
  char *copy_name = NULL;
115
122
  if(name != NULL){
116
 
    copy_name = strdup(name);
 
123
    do {
 
124
      copy_name = strdup(name);
 
125
    } while(copy_name == NULL and errno == EINTR);
117
126
    if(copy_name == NULL){
 
127
      int e = errno;
 
128
      free(new_plugin);
 
129
      errno = e;
118
130
      return NULL;
119
131
    }
120
132
  }
121
133
  
122
 
  *new_plugin = (plugin) { .name = copy_name,
123
 
                           .argc = 1,
124
 
                           .disabled = false,
125
 
                           .next = plugin_list };
 
134
  *new_plugin = (plugin){ .name = copy_name,
 
135
                          .argc = 1,
 
136
                          .disabled = false,
 
137
                          .next = plugin_list };
126
138
  
127
 
  new_plugin->argv = malloc(sizeof(char *) * 2);
128
 
  if (new_plugin->argv == NULL){
 
139
  do {
 
140
    new_plugin->argv = malloc(sizeof(char *) * 2);
 
141
  } while(new_plugin->argv == NULL and errno == EINTR);
 
142
  if(new_plugin->argv == NULL){
 
143
    int e = errno;
129
144
    free(copy_name);
130
145
    free(new_plugin);
 
146
    errno = e;
131
147
    return NULL;
132
148
  }
133
149
  new_plugin->argv[0] = copy_name;
134
150
  new_plugin->argv[1] = NULL;
135
151
  
136
 
  new_plugin->environ = malloc(sizeof(char *));
 
152
  do {
 
153
    new_plugin->environ = malloc(sizeof(char *));
 
154
  } while(new_plugin->environ == NULL and errno == EINTR);
137
155
  if(new_plugin->environ == NULL){
 
156
    int e = errno;
138
157
    free(copy_name);
139
158
    free(new_plugin->argv);
140
159
    free(new_plugin);
 
160
    errno = e;
141
161
    return NULL;
142
162
  }
143
163
  new_plugin->environ[0] = NULL;
151
171
static bool add_to_char_array(const char *new, char ***array,
152
172
                              int *len){
153
173
  /* Resize the pointed-to array to hold one more pointer */
154
 
  *array = realloc(*array, sizeof(char *)
155
 
                   * (size_t) ((*len) + 2));
 
174
  do {
 
175
    *array = realloc(*array, sizeof(char *)
 
176
                     * (size_t) ((*len) + 2));
 
177
  } while(*array == NULL and errno == EINTR);
156
178
  /* Malloc check */
157
179
  if(*array == NULL){
158
180
    return false;
159
181
  }
160
182
  /* Make a copy of the new string */
161
 
  char *copy = strdup(new);
 
183
  char *copy;
 
184
  do {
 
185
    copy = strdup(new);
 
186
  } while(copy == NULL and errno == EINTR);
162
187
  if(copy == NULL){
163
188
    return false;
164
189
  }
190
215
    if(strncmp(*e, def, namelen + 1) == 0){
191
216
      /* It already exists */
192
217
      if(replace){
193
 
        char *new = realloc(*e, strlen(def) + 1);
 
218
        char *new;
 
219
        do {
 
220
          new = realloc(*e, strlen(def) + 1);
 
221
        } while(new == NULL and errno == EINTR);
194
222
        if(new == NULL){
195
223
          return false;
196
224
        }
206
234
/*
207
235
 * Based on the example in the GNU LibC manual chapter 13.13 "File
208
236
 * Descriptor Flags".
209
 
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
 
237
 | [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
210
238
 */
211
 
static int set_cloexec_flag(int fd)
212
 
{
213
 
  int ret = fcntl(fd, F_GETFD, 0);
 
239
static int set_cloexec_flag(int fd){
 
240
  int ret = (int)TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD, 0));
214
241
  /* If reading the flags failed, return error indication now. */
215
242
  if(ret < 0){
216
243
    return ret;
217
244
  }
218
245
  /* Store modified flag word in the descriptor. */
219
 
  return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
 
246
  return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
 
247
                                       ret | FD_CLOEXEC));
220
248
}
221
249
 
222
250
 
223
251
/* Mark processes as completed when they exit, and save their exit
224
252
   status. */
225
 
void handle_sigchld(__attribute__((unused)) int sig){
 
253
static void handle_sigchld(__attribute__((unused)) int sig){
 
254
  int old_errno = errno;
226
255
  while(true){
227
256
    plugin *proc = plugin_list;
228
257
    int status;
232
261
      break;
233
262
    }
234
263
    if(pid == -1){
235
 
      if (errno != ECHILD){
236
 
        perror("waitpid");
 
264
      if(errno == ECHILD){
 
265
        /* No child processes */
 
266
        break;
237
267
      }
238
 
      /* No child processes */
239
 
      break;
 
268
      perror("waitpid");
240
269
    }
241
270
    
242
271
    /* A child exited, find it in process_list */
248
277
      continue;
249
278
    }
250
279
    proc->status = status;
251
 
    proc->completed = true;
 
280
    proc->completed = 1;
252
281
  }
 
282
  errno = old_errno;
253
283
}
254
284
 
255
285
/* Prints out a password to stdout */
256
 
bool print_out_password(const char *buffer, size_t length){
 
286
static bool print_out_password(const char *buffer, size_t length){
257
287
  ssize_t ret;
258
288
  for(size_t written = 0; written < length; written += (size_t)ret){
259
289
    ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
277
307
  }
278
308
  free(plugin_node->environ);
279
309
  free(plugin_node->buffer);
280
 
 
 
310
  
281
311
  /* Removes the plugin from the singly-linked list */
282
312
  if(plugin_node == plugin_list){
283
313
    /* First one - simple */
311
341
  struct stat st;
312
342
  fd_set rfds_all;
313
343
  int ret, maxfd = 0;
 
344
  ssize_t sret;
314
345
  uid_t uid = 65534;
315
346
  gid_t gid = 65534;
316
347
  bool debug = false;
370
401
      .doc = "Group ID the plugins will run as", .group = 3 },
371
402
    { .name = "debug", .key = 132,
372
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 },
373
413
    { .name = NULL }
374
414
  };
375
415
  
376
 
  error_t parse_opt (int key, char *arg, __attribute__((unused))
377
 
                     struct argp_state *state) {
378
 
    switch (key) {
 
416
  error_t parse_opt(int key, char *arg, struct argp_state *state){
 
417
    errno = 0;
 
418
    switch(key){
 
419
      char *tmp;
 
420
      intmax_t tmpmax;
379
421
    case 'g':                   /* --global-options */
380
 
      if (arg != NULL){
381
 
        char *p;
382
 
        while((p = strsep(&arg, ",")) != NULL){
383
 
          if(p[0] == '\0'){
384
 
            continue;
385
 
          }
386
 
          if(not add_argument(getplugin(NULL), p)){
387
 
            perror("add_argument");
388
 
            return ARGP_ERR_UNKNOWN;
 
422
      {
 
423
        char *plugin_option;
 
424
        while((plugin_option = strsep(&arg, ",")) != NULL){
 
425
          if(not add_argument(getplugin(NULL), plugin_option)){
 
426
            break;
389
427
          }
390
428
        }
391
429
      }
392
430
      break;
393
431
    case 'G':                   /* --global-env */
394
 
      if(arg == NULL){
395
 
        break;
396
 
      }
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
 
        }
405
 
      }
 
432
      add_environment(getplugin(NULL), arg, true);
406
433
      break;
407
434
    case 'o':                   /* --options-for */
408
 
      if (arg != NULL){
409
 
        char *p_name = strsep(&arg, ":");
410
 
        if(p_name[0] == '\0' or arg == NULL){
411
 
          break;
412
 
        }
413
 
        char *opt = strsep(&arg, ":");
414
 
        if(opt[0] == '\0' or opt == NULL){
415
 
          break;
416
 
        }
417
 
        char *p;
418
 
        while((p = strsep(&opt, ",")) != NULL){
419
 
          if(p[0] == '\0'){
420
 
            continue;
421
 
          }
422
 
          if(not add_argument(getplugin(p_name), p)){
423
 
            perror("add_argument");
424
 
            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;
425
453
          }
426
454
        }
427
455
      }
428
456
      break;
429
457
    case 'E':                   /* --env-for */
430
 
      if(arg == NULL){
431
 
        break;
432
 
      }
433
458
      {
434
459
        char *envdef = strchr(arg, ':');
435
460
        if(envdef == NULL){
436
 
          break;
437
 
        }
438
 
        char *p_name = strndup(arg, (size_t) (envdef-arg));
439
 
        if(p_name == NULL){
440
 
          break;
441
 
        }
 
461
          argp_error(state, "No colon in \"%s\"", arg);
 
462
          errno = EINVAL;
 
463
          break;
 
464
        }
 
465
        *envdef = '\0';
442
466
        envdef++;
443
 
        if(not add_environment(getplugin(p_name), envdef, true)){
444
 
          perror("add_environment");
 
467
        if(arg[0] == '\0'){
 
468
          argp_error(state, "Empty plugin name");
 
469
          errno = EINVAL;
 
470
          break;
445
471
        }
 
472
        add_environment(getplugin(arg), envdef, true);
446
473
      }
447
474
      break;
448
475
    case 'd':                   /* --disable */
449
 
      if (arg != NULL){
 
476
      {
450
477
        plugin *p = getplugin(arg);
451
 
        if(p == NULL){
452
 
          return ARGP_ERR_UNKNOWN;
 
478
        if(p != NULL){
 
479
          p->disabled = true;
453
480
        }
454
 
        p->disabled = true;
455
481
      }
456
482
      break;
457
483
    case 'e':                   /* --enable */
458
 
      if (arg != NULL){
 
484
      {
459
485
        plugin *p = getplugin(arg);
460
 
        if(p == NULL){
461
 
          return ARGP_ERR_UNKNOWN;
 
486
        if(p != NULL){
 
487
          p->disabled = false;
462
488
        }
463
 
        p->disabled = false;
464
489
      }
465
490
      break;
466
491
    case 128:                   /* --plugin-dir */
 
492
      free(plugindir);
467
493
      plugindir = strdup(arg);
468
 
      if(plugindir == NULL){
469
 
        perror("strdup");
470
 
      }      
471
494
      break;
472
495
    case 129:                   /* --config-file */
473
496
      /* This is already done by parse_opt_config_file() */
474
497
      break;
475
498
    case 130:                   /* --userid */
476
 
      uid = (uid_t)strtol(arg, NULL, 10);
 
499
      tmpmax = strtoimax(arg, &tmp, 10);
 
500
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
501
         or tmpmax != (uid_t)tmpmax){
 
502
        argp_error(state, "Bad user ID number: \"%s\", using %"
 
503
                   PRIdMAX, arg, (intmax_t)uid);
 
504
        break;
 
505
      }
 
506
      uid = (uid_t)tmpmax;
477
507
      break;
478
508
    case 131:                   /* --groupid */
479
 
      gid = (gid_t)strtol(arg, NULL, 10);
 
509
      tmpmax = strtoimax(arg, &tmp, 10);
 
510
      if(errno != 0 or tmp == arg or *tmp != '\0'
 
511
         or tmpmax != (gid_t)tmpmax){
 
512
        argp_error(state, "Bad group ID number: \"%s\", using %"
 
513
                   PRIdMAX, arg, (intmax_t)gid);
 
514
        break;
 
515
      }
 
516
      gid = (gid_t)tmpmax;
480
517
      break;
481
518
    case 132:                   /* --debug */
482
519
      debug = true;
483
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;
 
535
/*
 
536
 * When adding more options before this line, remember to also add a
 
537
 * "case" to the "parse_opt_config_file" function below.
 
538
 */
484
539
    case ARGP_KEY_ARG:
485
 
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
486
 
      break;
487
 
    case ARGP_KEY_END:
488
 
      break;
 
540
      /* Cryptsetup always passes an argument, which is an empty
 
541
         string if "none" was specified in /etc/crypttab.  So if
 
542
         argument was empty, we ignore it silently. */
 
543
      if(arg[0] == '\0'){
 
544
        break;
 
545
      }
489
546
    default:
490
547
      return ARGP_ERR_UNKNOWN;
491
548
    }
492
 
    return 0;
 
549
    return errno;               /* Set to 0 at start */
493
550
  }
494
551
  
495
552
  /* This option parser is the same as parse_opt() above, except it
496
553
     ignores everything but the --config-file option. */
497
 
  error_t parse_opt_config_file (int key, char *arg,
498
 
                                 __attribute__((unused))
499
 
                                 struct argp_state *state) {
500
 
    switch (key) {
 
554
  error_t parse_opt_config_file(int key, char *arg,
 
555
                                __attribute__((unused))
 
556
                                struct argp_state *state){
 
557
    errno = 0;
 
558
    switch(key){
501
559
    case 'g':                   /* --global-options */
502
560
    case 'G':                   /* --global-env */
503
561
    case 'o':                   /* --options-for */
507
565
    case 128:                   /* --plugin-dir */
508
566
      break;
509
567
    case 129:                   /* --config-file */
 
568
      free(argfile);
510
569
      argfile = strdup(arg);
511
 
      if(argfile == NULL){
512
 
        perror("strdup");
513
 
      }
514
 
      break;      
 
570
      break;
515
571
    case 130:                   /* --userid */
516
572
    case 131:                   /* --groupid */
517
573
    case 132:                   /* --debug */
 
574
    case '?':                   /* --help */
 
575
    case -3:                    /* --usage */
 
576
    case 'V':                   /* --version */
518
577
    case ARGP_KEY_ARG:
519
 
    case ARGP_KEY_END:
520
578
      break;
521
579
    default:
522
580
      return ARGP_ERR_UNKNOWN;
523
581
    }
524
 
    return 0;
 
582
    return errno;
525
583
  }
526
584
  
527
585
  struct argp argp = { .options = options,
529
587
                       .args_doc = "",
530
588
                       .doc = "Mandos plugin runner -- Run plugins" };
531
589
  
532
 
  /* Parse using the parse_opt_config_file in order to get the custom
 
590
  /* Parse using parse_opt_config_file() in order to get the custom
533
591
     config file location, if any. */
534
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
535
 
  if (ret == ARGP_ERR_UNKNOWN){
536
 
    fprintf(stderr, "Unknown error while parsing arguments\n");
537
 
    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;
538
606
    goto fallback;
539
607
  }
540
608
  
542
610
  argp.parser = parse_opt;
543
611
  
544
612
  /* Open the configfile if available */
545
 
  if (argfile == NULL){
 
613
  if(argfile == NULL){
546
614
    conffp = fopen(AFILE, "r");
547
615
  } else {
548
616
    conffp = fopen(argfile, "r");
549
 
  }  
 
617
  }
550
618
  if(conffp != NULL){
551
619
    char *org_line = NULL;
552
620
    char *p, *arg, *new_arg, *line;
553
621
    size_t size = 0;
554
 
    ssize_t sret;
555
622
    const char whitespace_delims[] = " \r\t\f\v\n";
556
623
    const char comment_delim[] = "#";
557
 
 
 
624
    
558
625
    custom_argc = 1;
559
626
    custom_argv = malloc(sizeof(char*) * 2);
560
627
    if(custom_argv == NULL){
564
631
    }
565
632
    custom_argv[0] = argv[0];
566
633
    custom_argv[1] = NULL;
567
 
 
 
634
    
568
635
    /* for each line in the config file, strip whitespace and ignore
569
636
       commented text */
570
637
    while(true){
572
639
      if(sret == -1){
573
640
        break;
574
641
      }
575
 
 
 
642
      
576
643
      line = org_line;
577
644
      arg = strsep(&line, comment_delim);
578
645
      while((p = strsep(&arg, whitespace_delims)) != NULL){
597
664
          goto fallback;
598
665
        }
599
666
        custom_argv[custom_argc-1] = new_arg;
600
 
        custom_argv[custom_argc] = NULL;        
 
667
        custom_argv[custom_argc] = NULL;
601
668
      }
602
669
    }
 
670
    do {
 
671
      ret = fclose(conffp);
 
672
    } while(ret == EOF and errno == EINTR);
 
673
    if(ret == EOF){
 
674
      perror("fclose");
 
675
      exitstatus = EXIT_FAILURE;
 
676
      goto fallback;
 
677
    }
603
678
    free(org_line);
604
679
  } else {
605
680
    /* Check for harmful errors and go to fallback. Other errors might
606
681
       not affect opening plugins */
607
 
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
 
682
    if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
608
683
      perror("fopen");
609
684
      exitstatus = EXIT_FAILURE;
610
685
      goto fallback;
611
686
    }
612
687
  }
613
 
  /* If there was any arguments from configuration file,
614
 
     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 */
615
690
  if(custom_argv != NULL){
616
 
    ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
617
 
                      0, NULL);
618
 
    if (ret == ARGP_ERR_UNKNOWN){
619
 
      fprintf(stderr, "Unknown error while parsing arguments\n");
620
 
      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;
621
705
      goto fallback;
622
706
    }
623
707
  }
624
708
  
625
709
  /* Parse actual command line arguments, to let them override the
626
710
     config file */
627
 
  ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
628
 
  if (ret == ARGP_ERR_UNKNOWN){
629
 
    fprintf(stderr, "Unknown error while parsing arguments\n");
630
 
    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;
631
725
    goto fallback;
632
726
  }
633
727
  
638
732
      for(char **a = p->argv; *a != NULL; a++){
639
733
        fprintf(stderr, "\tArg: %s\n", *a);
640
734
      }
641
 
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
735
      fprintf(stderr, "...and %d environment variables\n", p->envc);
642
736
      for(char **a = p->environ; *a != NULL; a++){
643
737
        fprintf(stderr, "\t%s\n", *a);
644
738
      }
646
740
  }
647
741
  
648
742
  /* Strip permissions down to nobody */
 
743
  setgid(gid);
 
744
  if(ret == -1){
 
745
    perror("setgid");
 
746
  }
649
747
  ret = setuid(uid);
650
 
  if (ret == -1){
 
748
  if(ret == -1){
651
749
    perror("setuid");
652
 
  }  
653
 
  setgid(gid);
654
 
  if (ret == -1){
655
 
    perror("setgid");
656
 
  }
657
 
  
658
 
  if (plugindir == NULL){
659
 
    dir = opendir(PDIR);
660
 
  } else {
661
 
    dir = opendir(plugindir);
662
 
  }
663
 
  
664
 
  if(dir == NULL){
665
 
    perror("Could not open plugin dir");
666
 
    exitstatus = EXIT_FAILURE;
667
 
    goto fallback;
668
 
  }
669
 
  
670
 
  /* Set the FD_CLOEXEC flag on the directory, if possible */
 
750
  }
 
751
  
 
752
  /* Open plugin directory with close_on_exec flag */
671
753
  {
672
 
    int dir_fd = dirfd(dir);
673
 
    if(dir_fd >= 0){
674
 
      ret = set_cloexec_flag(dir_fd);
675
 
      if(ret < 0){
676
 
        perror("set_cloexec_flag");
677
 
        exitstatus = EXIT_FAILURE;
678
 
        goto fallback;
679
 
      }
 
754
    int dir_fd = -1;
 
755
    if(plugindir == NULL){
 
756
      dir_fd = open(PDIR, O_RDONLY |
 
757
#ifdef O_CLOEXEC
 
758
                    O_CLOEXEC
 
759
#else  /* not O_CLOEXEC */
 
760
                    0
 
761
#endif  /* not O_CLOEXEC */
 
762
                    );
 
763
    } else {
 
764
      dir_fd = open(plugindir, O_RDONLY |
 
765
#ifdef O_CLOEXEC
 
766
                    O_CLOEXEC
 
767
#else  /* not O_CLOEXEC */
 
768
                    0
 
769
#endif  /* not O_CLOEXEC */
 
770
                    );
 
771
    }
 
772
    if(dir_fd == -1){
 
773
      perror("Could not open plugin dir");
 
774
      exitstatus = EXIT_FAILURE;
 
775
      goto fallback;
 
776
    }
 
777
    
 
778
#ifndef O_CLOEXEC
 
779
  /* Set the FD_CLOEXEC flag on the directory */
 
780
    ret = set_cloexec_flag(dir_fd);
 
781
    if(ret < 0){
 
782
      perror("set_cloexec_flag");
 
783
      TEMP_FAILURE_RETRY(close(dir_fd));
 
784
      exitstatus = EXIT_FAILURE;
 
785
      goto fallback;
 
786
    }
 
787
#endif  /* O_CLOEXEC */
 
788
    
 
789
    dir = fdopendir(dir_fd);
 
790
    if(dir == NULL){
 
791
      perror("Could not open plugin dir");
 
792
      TEMP_FAILURE_RETRY(close(dir_fd));
 
793
      exitstatus = EXIT_FAILURE;
 
794
      goto fallback;
680
795
    }
681
796
  }
682
797
  
684
799
  
685
800
  /* Read and execute any executable in the plugin directory*/
686
801
  while(true){
687
 
    dirst = readdir(dir);
 
802
    do {
 
803
      dirst = readdir(dir);
 
804
    } while(dirst == NULL and errno == EINTR);
688
805
    
689
806
    /* All directory entries have been processed */
690
807
    if(dirst == NULL){
691
 
      if (errno == EBADF){
 
808
      if(errno == EBADF){
692
809
        perror("readdir");
693
810
        exitstatus = EXIT_FAILURE;
694
811
        goto fallback;
706
823
      
707
824
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
708
825
                                           ".dpkg-old",
 
826
                                           ".dpkg-bak",
709
827
                                           ".dpkg-divert", NULL };
710
828
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
711
829
        size_t pre_len = strlen(*pre);
740
858
        continue;
741
859
      }
742
860
    }
743
 
 
 
861
    
744
862
    char *filename;
745
 
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
863
    if(plugindir == NULL){
 
864
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, PDIR "/%s",
 
865
                                             dirst->d_name));
 
866
    } else {
 
867
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, "%s/%s",
 
868
                                             plugindir,
 
869
                                             dirst->d_name));
 
870
    }
746
871
    if(ret < 0){
747
872
      perror("asprintf");
748
873
      continue;
749
874
    }
750
875
    
751
 
    ret = stat(filename, &st);
752
 
    if (ret == -1){
 
876
    ret = (int)TEMP_FAILURE_RETRY(stat(filename, &st));
 
877
    if(ret == -1){
753
878
      perror("stat");
754
879
      free(filename);
755
880
      continue;
756
881
    }
757
 
 
 
882
    
758
883
    /* Ignore non-executable files */
759
 
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
884
    if(not S_ISREG(st.st_mode)
 
885
       or (TEMP_FAILURE_RETRY(access(filename, X_OK)) != 0)){
760
886
      if(debug){
761
887
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
762
888
                " with bad type or mode\n", filename);
808
934
    }
809
935
    
810
936
    int pipefd[2];
811
 
    ret = pipe(pipefd);
812
 
    if (ret == -1){
 
937
    ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
 
938
    if(ret == -1){
813
939
      perror("pipe");
814
940
      exitstatus = EXIT_FAILURE;
815
941
      goto fallback;
828
954
      goto fallback;
829
955
    }
830
956
    /* Block SIGCHLD until process is safely in process list */
831
 
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
957
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
 
958
                                              &sigchld_action.sa_mask,
 
959
                                              NULL));
832
960
    if(ret < 0){
833
961
      perror("sigprocmask");
834
962
      exitstatus = EXIT_FAILURE;
835
963
      goto fallback;
836
964
    }
837
965
    /* Starting a new process to be watched */
838
 
    pid_t pid = fork();
 
966
    pid_t pid;
 
967
    do {
 
968
      pid = fork();
 
969
    } while(pid == -1 and errno == EINTR);
839
970
    if(pid == -1){
840
971
      perror("fork");
841
972
      exitstatus = EXIT_FAILURE;
848
979
        perror("sigaction");
849
980
        _exit(EXIT_FAILURE);
850
981
      }
851
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
982
      ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
852
983
      if(ret < 0){
853
984
        perror("sigprocmask");
854
985
        _exit(EXIT_FAILURE);
855
986
      }
856
 
 
 
987
      
857
988
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
858
989
      if(ret == -1){
859
990
        perror("dup2");
879
1010
      /* no return */
880
1011
    }
881
1012
    /* Parent process */
882
 
    close(pipefd[1]);           /* Close unused write end of pipe */
 
1013
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
 
1014
                                             pipe */
883
1015
    free(filename);
884
1016
    plugin *new_plugin = getplugin(dirst->d_name);
885
 
    if (new_plugin == NULL){
 
1017
    if(new_plugin == NULL){
886
1018
      perror("getplugin");
887
 
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
1019
      ret = (int)(TEMP_FAILURE_RETRY
 
1020
                  (sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
 
1021
                               NULL)));
888
1022
      if(ret < 0){
889
1023
        perror("sigprocmask");
890
1024
      }
897
1031
    
898
1032
    /* Unblock SIGCHLD so signal handler can be run if this process
899
1033
       has already completed */
900
 
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
1034
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
 
1035
                                              &sigchld_action.sa_mask,
 
1036
                                              NULL));
901
1037
    if(ret < 0){
902
1038
      perror("sigprocmask");
903
1039
      exitstatus = EXIT_FAILURE;
904
1040
      goto fallback;
905
1041
    }
906
1042
    
907
 
    FD_SET(new_plugin->fd, &rfds_all);
 
1043
    FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
 
1044
                                          -Wconversion */
908
1045
    
909
 
    if (maxfd < new_plugin->fd){
 
1046
    if(maxfd < new_plugin->fd){
910
1047
      maxfd = new_plugin->fd;
911
1048
    }
912
 
    
913
1049
  }
914
1050
  
915
 
  closedir(dir);
 
1051
  TEMP_FAILURE_RETRY(closedir(dir));
916
1052
  dir = NULL;
917
 
 
 
1053
  free_plugin(getplugin(NULL));
 
1054
  
918
1055
  for(plugin *p = plugin_list; p != NULL; p = p->next){
919
1056
    if(p->pid != 0){
920
1057
      break;
925
1062
      free_plugin_list();
926
1063
    }
927
1064
  }
928
 
 
 
1065
  
929
1066
  /* Main loop while running plugins exist */
930
1067
  while(plugin_list){
931
1068
    fd_set rfds = rfds_all;
932
1069
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
933
 
    if (select_ret == -1){
 
1070
    if(select_ret == -1 and errno != EINTR){
934
1071
      perror("select");
935
1072
      exitstatus = EXIT_FAILURE;
936
1073
      goto fallback;
937
1074
    }
938
1075
    /* OK, now either a process completed, or something can be read
939
1076
       from one of them */
940
 
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
 
1077
    for(plugin *proc = plugin_list; proc != NULL;){
941
1078
      /* Is this process completely done? */
942
 
      if(proc->eof and proc->completed){
 
1079
      if(proc->completed and proc->eof){
943
1080
        /* Only accept the plugin output if it exited cleanly */
944
1081
        if(not WIFEXITED(proc->status)
945
1082
           or WEXITSTATUS(proc->status) != 0){
946
1083
          /* Bad exit by plugin */
947
 
 
 
1084
          
948
1085
          if(debug){
949
1086
            if(WIFEXITED(proc->status)){
950
 
              fprintf(stderr, "Plugin %u exited with status %d\n",
951
 
                      (unsigned int) (proc->pid),
 
1087
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
 
1088
                      " status %d\n", proc->name,
 
1089
                      (intmax_t) (proc->pid),
952
1090
                      WEXITSTATUS(proc->status));
953
 
            } else if(WIFSIGNALED(proc->status)) {
954
 
              fprintf(stderr, "Plugin %u killed by signal %d\n",
955
 
                      (unsigned int) (proc->pid),
956
 
                      WTERMSIG(proc->status));
 
1091
            } else if(WIFSIGNALED(proc->status)){
 
1092
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
 
1093
                      " signal %d: %s\n", proc->name,
 
1094
                      (intmax_t) (proc->pid),
 
1095
                      WTERMSIG(proc->status),
 
1096
                      strsignal(WTERMSIG(proc->status)));
957
1097
            } else if(WCOREDUMP(proc->status)){
958
 
              fprintf(stderr, "Plugin %d dumped core\n",
959
 
                      (unsigned int) (proc->pid));
 
1098
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
 
1099
                      " core\n", proc->name, (intmax_t) (proc->pid));
960
1100
            }
961
1101
          }
962
1102
          
963
1103
          /* Remove the plugin */
964
 
          FD_CLR(proc->fd, &rfds_all);
965
 
 
 
1104
          FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
 
1105
                                          -Wconversion */
 
1106
          
966
1107
          /* Block signal while modifying process_list */
967
 
          ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
1108
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
 
1109
                                        (SIG_BLOCK,
 
1110
                                         &sigchld_action.sa_mask,
 
1111
                                         NULL));
968
1112
          if(ret < 0){
969
1113
            perror("sigprocmask");
970
1114
            exitstatus = EXIT_FAILURE;
971
1115
            goto fallback;
972
1116
          }
 
1117
          
 
1118
          plugin *next_plugin = proc->next;
973
1119
          free_plugin(proc);
 
1120
          proc = next_plugin;
 
1121
          
974
1122
          /* We are done modifying process list, so unblock signal */
975
 
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
976
 
                             NULL);
 
1123
          ret = (int)(TEMP_FAILURE_RETRY
 
1124
                      (sigprocmask(SIG_UNBLOCK,
 
1125
                                   &sigchld_action.sa_mask, NULL)));
977
1126
          if(ret < 0){
978
1127
            perror("sigprocmask");
979
1128
            exitstatus = EXIT_FAILURE;
983
1132
          if(plugin_list == NULL){
984
1133
            break;
985
1134
          }
 
1135
          
986
1136
          continue;
987
1137
        }
988
1138
        
989
1139
        /* This process exited nicely, so print its buffer */
990
 
 
 
1140
        
991
1141
        bool bret = print_out_password(proc->buffer,
992
1142
                                       proc->buffer_length);
993
1143
        if(not bret){
998
1148
      }
999
1149
      
1000
1150
      /* This process has not completed.  Does it have any output? */
1001
 
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
 
1151
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
 
1152
                                                         warning from
 
1153
                                                         -Wconversion */
1002
1154
        /* This process had nothing to say at this time */
 
1155
        proc = proc->next;
1003
1156
        continue;
1004
1157
      }
1005
1158
      /* Before reading, make the process' data buffer large enough */
1006
1159
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1007
1160
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1008
1161
                               + (size_t) BUFFER_SIZE);
1009
 
        if (proc->buffer == NULL){
 
1162
        if(proc->buffer == NULL){
1010
1163
          perror("malloc");
1011
1164
          exitstatus = EXIT_FAILURE;
1012
1165
          goto fallback;
1014
1167
        proc->buffer_size += BUFFER_SIZE;
1015
1168
      }
1016
1169
      /* Read from the process */
1017
 
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
1018
 
                 BUFFER_SIZE);
1019
 
      if(ret < 0){
 
1170
      sret = TEMP_FAILURE_RETRY(read(proc->fd,
 
1171
                                     proc->buffer
 
1172
                                     + proc->buffer_length,
 
1173
                                     BUFFER_SIZE));
 
1174
      if(sret < 0){
1020
1175
        /* Read error from this process; ignore the error */
 
1176
        proc = proc->next;
1021
1177
        continue;
1022
1178
      }
1023
 
      if(ret == 0){
 
1179
      if(sret == 0){
1024
1180
        /* got EOF */
1025
1181
        proc->eof = true;
1026
1182
      } else {
1027
 
        proc->buffer_length += (size_t) ret;
 
1183
        proc->buffer_length += (size_t) sret;
1028
1184
      }
1029
1185
    }
1030
1186
  }
1031
 
 
1032
 
 
 
1187
  
 
1188
  
1033
1189
 fallback:
1034
1190
  
1035
1191
  if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
1057
1213
    perror("sigaction");
1058
1214
    exitstatus = EXIT_FAILURE;
1059
1215
  }
1060
 
 
 
1216
  
1061
1217
  if(custom_argv != NULL){
1062
1218
    for(char **arg = custom_argv+1; *arg != NULL; arg++){
1063
1219
      free(*arg);
1069
1225
    closedir(dir);
1070
1226
  }
1071
1227
  
1072
 
  /* Free the process list and kill the processes */
 
1228
  /* Kill the processes */
1073
1229
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1074
1230
    if(p->pid != 0){
1075
1231
      close(p->fd);
1082
1238
  }
1083
1239
  
1084
1240
  /* Wait for any remaining child processes to terminate */
1085
 
  do{
 
1241
  do {
1086
1242
    ret = wait(NULL);
1087
1243
  } while(ret >= 0);
1088
1244
  if(errno != ECHILD){
1089
1245
    perror("wait");
1090
1246
  }
1091
 
 
 
1247
  
1092
1248
  free_plugin_list();
1093
1249
  
1094
1250
  free(plugindir);