1
/*  -*- coding: utf-8 -*- */
 
 
3
 * Mandos plugin runner - Run Mandos plugins
 
 
5
 * Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
 
 
7
 * This program is free software: you can redistribute it and/or
 
 
8
 * modify it under the terms of the GNU General Public License as
 
 
9
 * published by the Free Software Foundation, either version 3 of the
 
 
10
 * License, or (at your option) any later version.
 
 
12
 * This program is distributed in the hope that it will be useful, but
 
 
13
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
 
15
 * General Public License for more details.
 
 
17
 * You should have received a copy of the GNU General Public License
 
 
18
 * along with this program.  If not, see
 
 
19
 * <http://www.gnu.org/licenses/>.
 
 
21
 * Contact the authors at <mandos@fukt.bsnet.se>.
 
 
24
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY() */
 
 
26
#include <stddef.h>             /* size_t, NULL */
 
 
27
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
 
 
28
                                   EXIT_SUCCESS, realloc() */
 
 
29
#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
 
 
33
                                   stat, waitpid(), WIFEXITED(),
 
 
34
                                   WEXITSTATUS(), wait(), pid_t,
 
 
35
                                   uid_t, gid_t, getuid(), getgid(),
 
 
37
#include <sys/select.h>         /* fd_set, select(), FD_ZERO(),
 
 
38
                                   FD_SET(), FD_ISSET(), FD_CLR */
 
 
39
#include <sys/wait.h>           /* wait(), waitpid(), WIFEXITED(),
 
 
41
#include <sys/stat.h>           /* struct stat, stat(), S_ISREG() */
 
 
42
#include <iso646.h>             /* and, or, not */
 
 
43
#include <dirent.h>             /* DIR, struct dirent, opendir(),
 
 
44
                                   readdir(), closedir(), dirfd() */
 
 
45
#include <unistd.h>             /* struct stat, stat(), S_ISREG(),
 
 
46
                                   fcntl(), setuid(), setgid(),
 
 
47
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
 
 
48
                                   access(), pipe(), fork(), close()
 
 
49
                                   dup2, STDOUT_FILENO, _exit(),
 
 
50
                                   execv(), write(), read(),
 
 
52
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
 
 
54
#include <string.h>             /* strtok, strlen(), strcpy(),
 
 
56
#include <errno.h>              /* errno */
 
 
57
#include <argp.h>               /* struct argp_option, struct
 
 
58
                                   argp_state, struct argp,
 
 
59
                                   argp_parse(), ARGP_ERR_UNKNOWN,
 
 
60
                                   ARGP_KEY_END, ARGP_KEY_ARG, error_t */
 
 
61
#include <signal.h>             /* struct sigaction, sigemptyset(),
 
 
62
                                   sigaddset(), sigaction(),
 
 
63
                                   sigprocmask(), SIG_BLOCK, SIGCHLD,
 
 
64
                                   SIG_UNBLOCK, kill() */
 
 
65
#include <errno.h>              /* errno, EBADF */
 
 
67
#define BUFFER_SIZE 256
 
 
69
const char *argp_program_version = "mandos-client 1.0";
 
 
70
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
 
 
74
typedef struct process{
 
 
86
typedef struct plugin{
 
 
87
  char *name;                   /* can be NULL or any plugin name */
 
 
94
static plugin *getplugin(char *name, plugin **plugin_list){
 
 
95
  for (plugin *p = *plugin_list; p != NULL; p = p->next){
 
 
97
        or (p->name and name and (strcmp(p->name, name) == 0))){
 
 
101
  /* Create a new plugin */
 
 
102
  plugin *new_plugin = malloc(sizeof(plugin));
 
 
103
  if (new_plugin == NULL){
 
 
107
  new_plugin->name = name;
 
 
108
  new_plugin->argv = malloc(sizeof(char *) * 2);
 
 
109
  if (new_plugin->argv == NULL){
 
 
113
  new_plugin->argv[0] = name;
 
 
114
  new_plugin->argv[1] = NULL;
 
 
115
  new_plugin->argc = 1;
 
 
116
  new_plugin->disabled = false;
 
 
117
  new_plugin->next = *plugin_list;
 
 
118
  /* Append the new plugin to the list */
 
 
119
  *plugin_list = new_plugin;
 
 
123
static void addargument(plugin *p, char *arg){
 
 
124
  p->argv[p->argc] = arg;
 
 
125
  p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
 
 
126
  if (p->argv == NULL){
 
 
131
  p->argv[p->argc] = NULL;
 
 
135
 * Based on the example in the GNU LibC manual chapter 13.13 "File
 
 
137
 * *Note File Descriptor Flags:(libc)Descriptor Flags.
 
 
139
static int set_cloexec_flag(int fd)
 
 
141
  int ret = fcntl(fd, F_GETFD, 0);
 
 
142
  /* If reading the flags failed, return error indication now. */
 
 
146
  /* Store modified flag word in the descriptor. */
 
 
147
  return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
 
 
150
process *process_list = NULL;
 
 
152
/* Mark a process as completed when it exits, and save its exit
 
 
154
void handle_sigchld(__attribute__((unused)) int sig){
 
 
155
  process *proc = process_list;
 
 
157
  pid_t pid = wait(&status);
 
 
162
  while(proc != NULL and proc->pid != pid){
 
 
166
    /* Process not found in process list */
 
 
169
  proc->status = status;
 
 
170
  proc->completed = true;
 
 
173
int main(int argc, char *argv[]){
 
 
174
  const char *plugindir = "/conf/conf.d/mandos/plugins.d";
 
 
177
  struct dirent *dirst;
 
 
184
  int exitstatus = EXIT_SUCCESS;
 
 
185
  struct sigaction old_sigchld_action;
 
 
186
  struct sigaction sigchld_action = { .sa_handler = handle_sigchld,
 
 
187
                                      .sa_flags = SA_NOCLDSTOP };
 
 
188
  char *plus_options = NULL;
 
 
189
  char **plus_argv = NULL;
 
 
191
  /* Establish a signal handler */
 
 
192
  sigemptyset(&sigchld_action.sa_mask);
 
 
193
  ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
 
 
198
  ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
 
 
204
  /* The options we understand. */
 
 
205
  struct argp_option options[] = {
 
 
206
    { .name = "global-options", .key = 'g',
 
 
207
      .arg = "OPTION[,OPTION[,...]]",
 
 
208
      .doc = "Options passed to all plugins" },
 
 
209
    { .name = "options-for", .key = 'o',
 
 
210
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
 
 
211
      .doc = "Options passed only to specified plugin" },
 
 
212
    { .name = "disable", .key = 'd',
 
 
214
      .doc = "Disable a specific plugin", .group = 1 },
 
 
215
    { .name = "plugin-dir", .key = 128,
 
 
217
      .doc = "Specify a different plugin directory", .group = 2 },
 
 
218
    { .name = "userid", .key = 129,
 
 
219
      .arg = "ID", .flags = 0,
 
 
220
      .doc = "User ID the plugins will run as", .group = 2 },
 
 
221
    { .name = "groupid", .key = 130,
 
 
222
      .arg = "ID", .flags = 0,
 
 
223
      .doc = "Group ID the plugins will run as", .group = 2 },
 
 
224
    { .name = "debug", .key = 131,
 
 
225
      .doc = "Debug mode", .group = 3 },
 
 
229
  error_t parse_opt (int key, char *arg, struct argp_state *state) {
 
 
230
    /* Get the INPUT argument from `argp_parse', which we know is a
 
 
231
       pointer to our plugin list pointer. */
 
 
232
    plugin **plugins = state->input;
 
 
236
        char *p = strtok(arg, ",");
 
 
238
          addargument(getplugin(NULL, plugins), p);
 
 
239
          p = strtok(NULL, ",");
 
 
245
        char *name = strtok(arg, ":");
 
 
246
        char *p = strtok(NULL, ":");
 
 
250
            addargument(getplugin(name, plugins), p);
 
 
251
            p = strtok(NULL, ",");
 
 
258
        getplugin(arg, plugins)->disabled = true;
 
 
265
      uid = (uid_t)strtol(arg, NULL, 10);
 
 
268
      gid = (gid_t)strtol(arg, NULL, 10);
 
 
274
      if(plus_options != NULL or arg == NULL or arg[0] != '+'){
 
 
282
      return ARGP_ERR_UNKNOWN;
 
 
287
  plugin *plugin_list = NULL;
 
 
289
  struct argp argp = { .options = options, .parser = parse_opt,
 
 
290
                       .args_doc = "[+PLUS_SEPARATED_OPTIONS]",
 
 
291
                       .doc = "Mandos plugin runner -- Run plugins" };
 
 
293
  ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
 
 
294
  if (ret == ARGP_ERR_UNKNOWN){
 
 
295
    fprintf(stderr, "Unkown error while parsing arguments\n");
 
 
296
    exitstatus = EXIT_FAILURE;
 
 
301
    /* This is a mangled argument in the form of
 
 
302
     "+--option+--other-option=parameter+--yet-another-option", etc */
 
 
303
    /* Make new argc and argv vars, and call argp_parse() again. */
 
 
304
    plus_options++;             /* skip the first '+' character */
 
 
305
    const char delims[] = "+";
 
 
308
    plus_argv = malloc(sizeof(char*) * 2);
 
 
309
    if(plus_argv == NULL){
 
 
311
      exitstatus = EXIT_FAILURE;
 
 
314
    plus_argv[0] = argv[0];
 
 
316
    arg = strtok(plus_options, delims); /* Get first argument */
 
 
319
      plus_argv = realloc(plus_argv, sizeof(char *)
 
 
320
                         * ((unsigned int) new_argc + 1));
 
 
321
      if(plus_argv == NULL){
 
 
323
        exitstatus = EXIT_FAILURE;
 
 
326
      plus_argv[new_argc-1] = arg;
 
 
327
      plus_argv[new_argc] = NULL;
 
 
328
      arg = strtok(NULL, delims); /* Get next argument */
 
 
330
    ret = argp_parse (&argp, new_argc, plus_argv, 0, 0, &plugin_list);
 
 
331
    if (ret == ARGP_ERR_UNKNOWN){
 
 
332
      fprintf(stderr, "Unkown error while parsing arguments\n");
 
 
333
      exitstatus = EXIT_FAILURE;
 
 
339
    for(plugin *p = plugin_list; p != NULL; p=p->next){
 
 
340
      fprintf(stderr, "Plugin: %s has %d arguments\n",
 
 
341
              p->name ? p->name : "Global", p->argc - 1);
 
 
342
      for(char **a = p->argv; *a != NULL; a++){
 
 
343
        fprintf(stderr, "\tArg: %s\n", *a);
 
 
358
  dir = opendir(plugindir);
 
 
360
    perror("Could not open plugin dir");
 
 
361
    exitstatus = EXIT_FAILURE;
 
 
365
  /* Set the FD_CLOEXEC flag on the directory, if possible */
 
 
367
    int dir_fd = dirfd(dir);
 
 
369
      ret = set_cloexec_flag(dir_fd);
 
 
371
        perror("set_cloexec_flag");
 
 
372
        exitstatus = EXIT_FAILURE;
 
 
381
    dirst = readdir(dir);
 
 
383
    // All directory entries have been processed
 
 
387
        exitstatus = EXIT_FAILURE;
 
 
393
    d_name_len = strlen(dirst->d_name);
 
 
395
    // Ignore dotfiles, backup files and other junk
 
 
397
      bool bad_name = false;
 
 
399
      const char const *bad_prefixes[] = { ".", "#", NULL };
 
 
401
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
 
 
403
                                           ".dpkg-divert", NULL };
 
 
404
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
 
 
405
        size_t pre_len = strlen(*pre);
 
 
406
        if((d_name_len >= pre_len)
 
 
407
           and strncmp((dirst->d_name), *pre, pre_len) == 0){
 
 
409
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
 
410
                    " with bad prefix %s\n", dirst->d_name, *pre);
 
 
421
      for(const char **suf = bad_suffixes; *suf != NULL; suf++){
 
 
422
        size_t suf_len = strlen(*suf);
 
 
423
        if((d_name_len >= suf_len)
 
 
424
           and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
 
 
427
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
 
428
                    " with bad suffix %s\n", dirst->d_name, *suf);
 
 
440
    char *filename = malloc(d_name_len + strlen(plugindir) + 2);
 
 
441
    if (filename == NULL){
 
 
443
      exitstatus = EXIT_FAILURE;
 
 
446
    strcpy(filename, plugindir); /* Spurious warning */
 
 
447
    strcat(filename, "/");      /* Spurious warning */
 
 
448
    strcat(filename, dirst->d_name); /* Spurious warning */
 
 
450
    ret = stat(filename, &st);
 
 
453
      exitstatus = EXIT_FAILURE;
 
 
457
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
 
459
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
 
460
                " with bad type or mode\n", filename);
 
 
465
    if(getplugin(dirst->d_name, &plugin_list)->disabled){
 
 
467
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
 
 
473
    plugin *p = getplugin(dirst->d_name, &plugin_list);
 
 
475
      /* Add global arguments to argument list for this plugin */
 
 
476
      plugin *g = getplugin(NULL, &plugin_list);
 
 
477
      for(char **a = g->argv + 1; *a != NULL; a++){
 
 
485
      exitstatus = EXIT_FAILURE;
 
 
488
    ret = set_cloexec_flag(pipefd[0]);
 
 
490
      perror("set_cloexec_flag");
 
 
491
      exitstatus = EXIT_FAILURE;
 
 
494
    ret = set_cloexec_flag(pipefd[1]);
 
 
496
      perror("set_cloexec_flag");
 
 
497
      exitstatus = EXIT_FAILURE;
 
 
500
    /* Block SIGCHLD until process is safely in process list */
 
 
501
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
 
503
      perror("sigprocmask");
 
 
504
      exitstatus = EXIT_FAILURE;
 
 
507
    // Starting a new process to be watched
 
 
510
      /* this is the child process */
 
 
511
      ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
 
 
516
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
 
518
        perror("sigprocmask");
 
 
522
      ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
 
 
529
        /* If dir has no file descriptor, we could not set FD_CLOEXEC
 
 
530
           above and must now close it manually here. */
 
 
533
      if(execv(filename, p->argv) < 0){
 
 
541
    close(pipefd[1]);           /* close unused write end of pipe */
 
 
542
    process *new_process = malloc(sizeof(process));
 
 
543
    if (new_process == NULL){
 
 
545
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
 
547
        perror("sigprocmask");
 
 
549
      exitstatus = EXIT_FAILURE;
 
 
553
    *new_process = (struct process){ .pid = pid,
 
 
555
                                     .next = process_list };
 
 
557
    process_list = new_process;
 
 
558
    /* Unblock SIGCHLD so signal handler can be run if this process
 
 
559
       has already completed */
 
 
560
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
 
 
562
      perror("sigprocmask");
 
 
563
      exitstatus = EXIT_FAILURE;
 
 
567
    FD_SET(new_process->fd, &rfds_all);
 
 
569
    if (maxfd < new_process->fd){
 
 
570
      maxfd = new_process->fd;
 
 
575
  /* Free the plugin list */
 
 
576
  for(plugin *next; plugin_list != NULL; plugin_list = next){
 
 
577
    next = plugin_list->next;
 
 
578
    free(plugin_list->argv);
 
 
585
  if (process_list == NULL){
 
 
586
    fprintf(stderr, "No plugin processes started, exiting\n");
 
 
587
    exitstatus = EXIT_FAILURE;
 
 
591
    fd_set rfds = rfds_all;
 
 
592
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
 
 
593
    if (select_ret == -1){
 
 
595
      exitstatus = EXIT_FAILURE;
 
 
598
    /* OK, now either a process completed, or something can be read
 
 
600
    for(process *proc = process_list; proc ; proc = proc->next){
 
 
601
      /* Is this process completely done? */
 
 
602
      if(proc->eof and proc->completed){
 
 
603
        /* Only accept the plugin output if it exited cleanly */
 
 
604
        if(not WIFEXITED(proc->status)
 
 
605
           or WEXITSTATUS(proc->status) != 0){
 
 
606
          /* Bad exit by plugin */
 
 
608
            if(WIFEXITED(proc->status)){
 
 
609
              fprintf(stderr, "Plugin %u exited with status %d\n",
 
 
610
                      (unsigned int) (proc->pid),
 
 
611
                      WEXITSTATUS(proc->status));
 
 
612
            } else if(WIFSIGNALED(proc->status)) {
 
 
613
              fprintf(stderr, "Plugin %u killed by signal %d\n",
 
 
614
                      (unsigned int) (proc->pid),
 
 
615
                      WTERMSIG(proc->status));
 
 
616
            } else if(WCOREDUMP(proc->status)){
 
 
617
              fprintf(stderr, "Plugin %d dumped core\n",
 
 
618
                      (unsigned int) (proc->pid));
 
 
621
          /* Remove the plugin */
 
 
622
          FD_CLR(proc->fd, &rfds_all);
 
 
623
          /* Block signal while modifying process_list */
 
 
624
          ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
 
 
626
            perror("sigprocmask");
 
 
627
            exitstatus = EXIT_FAILURE;
 
 
630
          /* Delete this process entry from the list */
 
 
631
          if(process_list == proc){
 
 
632
            /* First one - simple */
 
 
633
            process_list = proc->next;
 
 
635
            /* Second one or later */
 
 
636
            for(process *p = process_list; p != NULL; p = p->next){
 
 
638
                p->next = proc->next;
 
 
643
          /* We are done modifying process list, so unblock signal */
 
 
644
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
 
 
647
            perror("sigprocmask");
 
 
651
          /* We deleted this process from the list, so we can't go
 
 
652
             proc->next.  Therefore, start over from the beginning of
 
 
656
        /* This process exited nicely, so print its buffer */
 
 
657
        for(size_t written = 0; written < proc->buffer_length;
 
 
658
            written += (size_t)ret){
 
 
659
          ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO,
 
 
660
                                         proc->buffer + written,
 
 
665
            exitstatus = EXIT_FAILURE;
 
 
671
      /* This process has not completed.  Does it have any output? */
 
 
672
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
 
 
673
        /* This process had nothing to say at this time */
 
 
676
      /* Before reading, make the process' data buffer large enough */
 
 
677
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
 
 
678
        proc->buffer = realloc(proc->buffer, proc->buffer_size
 
 
679
                               + (size_t) BUFFER_SIZE);
 
 
680
        if (proc->buffer == NULL){
 
 
682
          exitstatus = EXIT_FAILURE;
 
 
685
        proc->buffer_size += BUFFER_SIZE;
 
 
687
      /* Read from the process */
 
 
688
      ret = read(proc->fd, proc->buffer + proc->buffer_length,
 
 
691
        /* Read error from this process; ignore the error */
 
 
698
        proc->buffer_length += (size_t) ret;
 
 
702
  if(process_list == NULL){
 
 
703
    fprintf(stderr, "All plugin processes failed, exiting\n");
 
 
704
    exitstatus = EXIT_FAILURE;
 
 
708
  /* Restore old signal handler */
 
 
709
  sigaction(SIGCHLD, &old_sigchld_action, NULL);
 
 
713
  /* Free the plugin list */
 
 
714
  for(plugin *next; plugin_list != NULL; plugin_list = next){
 
 
715
    next = plugin_list->next;
 
 
716
    free(plugin_list->argv);
 
 
724
  /* Free the process list and kill the processes */
 
 
725
  for(process *next; process_list != NULL; process_list = next){
 
 
726
    next = process_list->next;
 
 
727
    close(process_list->fd);
 
 
728
    ret = kill(process_list->pid, SIGTERM);
 
 
729
    if(ret == -1 and errno != ESRCH){
 
 
730
      /* set-uid proccesses migth not get closed */
 
 
733
    free(process_list->buffer);
 
 
737
  /* Wait for any remaining child processes to terminate */