/mandos/release

/*  -*- coding: utf-8 -*- */

/*

 * Mandos plugin runner - Run Mandos plugins

 *

 * Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson

 * 

 * This program is free software: you can redistribute it and/or

 * modify it under the terms of the GNU General Public License as

 * published by the Free Software Foundation, either version 3 of the

 * License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful, but

 * WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program.  If not, see

 * <http://www.gnu.org/licenses/>.

 * 

 * Contact the authors at <mandos@fukt.bsnet.se>.

 */

#define _GNU_SOURCE		/* TEMP_FAILURE_RETRY() */

#include <stdio.h>		/* popen(), fileno(), fprintf(),

				   stderr, STDOUT_FILENO */

#include <iso646.h>		/* and, or, not */

#include <sys/types.h>	        /* DIR, opendir(), stat(),

				   struct stat, waitpid(),

				   WIFEXITED(), WEXITSTATUS(),

				   wait() */

#include <sys/wait.h>		/* wait() */

#include <dirent.h>		/* DIR, struct dirent, opendir(),

				   readdir(), closedir() */

#include <sys/stat.h>		/* struct stat, stat(), S_ISREG() */

#include <unistd.h>		/* struct stat, stat(), S_ISREG(),

				   fcntl() */

#include <fcntl.h>		/* fcntl() */

#include <stddef.h>		/* NULL */

#include <stdlib.h>		/* EXIT_FAILURE */

#include <sys/select.h>		/* fd_set, select(), FD_ZERO(),

				   FD_SET(), FD_ISSET() */

#include <string.h>		/* strlen(), strcpy(), strcat() */

#include <stdbool.h>		/* true */

#include <sys/wait.h>		/* waitpid(), WIFEXITED(),

				   WEXITSTATUS() */

#include <errno.h>		/* errno */

#include <argp.h>		/* struct argp_option,

				   struct argp_state, struct argp,

				   argp_parse() */

#define BUFFER_SIZE 256

struct process;

typedef struct process{

  pid_t pid;

  int fd;

  char *buffer;

  size_t buffer_size;

  size_t buffer_length;

  bool eof;

  bool completed;

  int status;

  struct process *next;

} process;

typedef struct plugin{

  char *name;			/* can be NULL or any plugin name */

  char **argv;

  int argc;

  bool disabled;

  struct plugin *next;

} plugin;

static plugin *getplugin(char *name, plugin **plugin_list){

  for (plugin *p = *plugin_list; p != NULL; p = p->next){

    if ((p->name == name)

	or (p->name and name and (strcmp(p->name, name) == 0))){

      return p;

    }

  }

  /* Create a new plugin */

  plugin *new_plugin = malloc(sizeof(plugin));

  if (new_plugin == NULL){

    perror("malloc");

    exit(EXIT_FAILURE);

  }

  new_plugin->name = name;

  new_plugin->argv = malloc(sizeof(char *) * 2);

  if (new_plugin->argv == NULL){

    perror("malloc");

    exit(EXIT_FAILURE);

  }

  new_plugin->argv[0] = name;

  new_plugin->argv[1] = NULL;

  new_plugin->argc = 1;

  new_plugin->disabled = false;

  new_plugin->next = *plugin_list;

  /* Append the new plugin to the list */

  *plugin_list = new_plugin;

  return new_plugin;

}

static void addargument(plugin *p, char *arg){

  p->argv[p->argc] = arg;

  p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));

  if (p->argv == NULL){

    perror("malloc");

    exit(EXIT_FAILURE);

  }

  p->argc++;

  p->argv[p->argc] = NULL;

}

/*

 * Based on the example in the GNU LibC manual chapter 13.13 "File

 * Descriptor Flags".

 * *Note File Descriptor Flags:(libc)Descriptor Flags.

 */

static int set_cloexec_flag(int fd)

{

  int ret = fcntl(fd, F_GETFD, 0);

  /* If reading the flags failed, return error indication now. */

  if(ret < 0){

    return ret;

  }

  /* Store modified flag word in the descriptor. */

  return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);

}

const char *argp_program_version = "plugbasedclient 0.9";

const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";

process *process_list = NULL;

/* Mark a process as completed when it exits, and save its exit

   status. */

void handle_sigchld(__attribute__((unused)) int sig){

  process *proc = process_list;

  int status;

  pid_t pid = wait(&status);

  while(proc != NULL and proc->pid != pid){

    proc = proc->next;    

  }

  if(proc == NULL){

    /* Process not found in process list */

    return;

  }

  proc->status = status;

  proc->completed = true;

}

int main(int argc, char *argv[]){

  const char *plugindir = "/conf/conf.d/mandos/plugins.d";

  size_t d_name_len;

  DIR *dir = NULL;

  struct dirent *dirst;

  struct stat st;

  fd_set rfds_all;

  int ret, maxfd = 0;

  bool debug = false;

  int exitstatus = EXIT_SUCCESS;

  /* Establish a signal handler */

  struct sigaction old_sigchld_action,

    sigchld_action = { .sa_handler = handle_sigchld,

		       .sa_flags = SA_NOCLDSTOP };

  sigemptyset(&sigchld_action.sa_mask);

  ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);

  if(ret < 0){

    perror("sigaddset");

    exit(EXIT_FAILURE);

  }

  ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);

  if(ret < 0){

    perror("sigaction");

    exit(EXIT_FAILURE);

  }

  /* The options we understand. */

  struct argp_option options[] = {

    { .name = "global-options", .key = 'g',

      .arg = "OPTION[,OPTION[,...]]",

      .doc = "Options passed to all plugins" },

    { .name = "options-for", .key = 'o',

      .arg = "PLUGIN:OPTION[,OPTION[,...]]",

      .doc = "Options passed only to specified plugin" },

    { .name = "disable", .key = 'd',

      .arg = "PLUGIN",

      .doc = "Disable a specific plugin", .group = 1 },

    { .name = "plugin-dir", .key = 128,

      .arg = "DIRECTORY",

      .doc = "Specify a different plugin directory", .group = 2 },

    { .name = "debug", .key = 129,

      .doc = "Debug mode", .group = 3 },

    { .name = NULL }

  };

  error_t parse_opt (int key, char *arg, struct argp_state *state) {

    /* Get the INPUT argument from `argp_parse', which we know is a

       pointer to our plugin list pointer. */

    plugin **plugins = state->input;

    switch (key) {

    case 'g':

      if (arg != NULL){

	char *p = strtok(arg, ",");

	do{

	  addargument(getplugin(NULL, plugins), p);

	  p = strtok(NULL, ",");

	} while (p);

      }

      break;

    case 'o':

      if (arg != NULL){

	char *name = strtok(arg, ":");

	char *p = strtok(NULL, ":");

	if(p){

	  p = strtok(p, ",");

	  do{

	    addargument(getplugin(name, plugins), p);

	    p = strtok(NULL, ",");

	  } while (p);

	}

      }

      break;

    case 'd':

      if (arg != NULL){

	getplugin(arg, plugins)->disabled = true;

      }

      break;

    case 128:

      plugindir = arg;

      break;

    case 129:

      debug = true;

      break;

    case ARGP_KEY_ARG:

      argp_usage (state);

      break;

    case ARGP_KEY_END:

      break;

    default:

      return ARGP_ERR_UNKNOWN;

    }

    return 0;

  }

  plugin *plugin_list = NULL;

  struct argp argp = { .options = options, .parser = parse_opt,

		       .args_doc = "",

		       .doc = "Mandos plugin runner -- Run plugins" };

  argp_parse (&argp, argc, argv, 0, 0, &plugin_list);

  if(debug){

    for(plugin *p = plugin_list; p != NULL; p=p->next){

      fprintf(stderr, "Plugin: %s has %d arguments\n",

	      p->name ? p->name : "Global", p->argc - 1);

      for(char **a = p->argv; *a != NULL; a++){

	fprintf(stderr, "\tArg: %s\n", *a);

      }

    }

  }

  dir = opendir(plugindir);

  if(dir == NULL){

    perror("Could not open plugin dir");

    exitstatus = EXIT_FAILURE;

    goto end;

  }

  /* Set the FD_CLOEXEC flag on the directory, if possible */

  {

    int dir_fd = dirfd(dir);

    if(dir_fd >= 0){

      ret = set_cloexec_flag(dir_fd);

      if(ret < 0){

	perror("set_cloexec_flag");

	exitstatus = EXIT_FAILURE;

	goto end;

      }

    }

  }

  FD_ZERO(&rfds_all);

  while(true){

    dirst = readdir(dir);

    // All directory entries have been processed

    if(dirst == NULL){

      break;

    }

    d_name_len = strlen(dirst->d_name);

    // Ignore dotfiles, backup files and other junk

    {

      bool bad_name = false;

      const char const *bad_prefixes[] = { ".", "#", NULL };

      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",

					   ".dpkg-old",

					   ".dpkg-divert", NULL };

      for(const char **pre = bad_prefixes; *pre != NULL; pre++){

	size_t pre_len = strlen(*pre);

	if((d_name_len >= pre_len)

	   and strncmp((dirst->d_name), *pre, pre_len) == 0){

	  if(debug){

	    fprintf(stderr, "Ignoring plugin dir entry \"%s\""

		    " with bad prefix %s\n", dirst->d_name, *pre);

	  }

	  bad_name = true;

	  break;

	}

      }

      if(bad_name){

	continue;

      }

      for(const char **suf = bad_suffixes; *suf != NULL; suf++){

	size_t suf_len = strlen(*suf);

	if((d_name_len >= suf_len)

	   and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)

		== 0)){

	  if(debug){

	    fprintf(stderr, "Ignoring plugin dir entry \"%s\""

		    " with bad suffix %s\n", dirst->d_name, *suf);

	  }

	  bad_name = true;

	  break;

	}

      }

      if(bad_name){

	continue;

      }

    }

    char *filename = malloc(d_name_len + strlen(plugindir) + 2);

    if (filename == NULL){

      perror("malloc");

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    strcpy(filename, plugindir); /* Spurious warning */

    strcat(filename, "/");	/* Spurious warning */

    strcat(filename, dirst->d_name); /* Spurious warning */

    stat(filename, &st);

    if (not S_ISREG(st.st_mode)	or (access(filename, X_OK) != 0)){

      if(debug){

	fprintf(stderr, "Ignoring plugin dir entry \"%s\""

		" with bad type or mode\n", filename);

      }

      free(filename);

      continue;

    }

    if(getplugin(dirst->d_name, &plugin_list)->disabled){

      if(debug){

	fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",

		dirst->d_name);

      }

      free(filename);

      continue;

    }

    plugin *p = getplugin(dirst->d_name, &plugin_list);

    {

      /* Add global arguments to argument list for this plugin */

      plugin *g = getplugin(NULL, &plugin_list);

      for(char **a = g->argv + 1; *a != NULL; a++){

	addargument(p, *a);

      }

    }

    int pipefd[2]; 

    ret = pipe(pipefd);

    if (ret == -1){

      perror("pipe");

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    ret = set_cloexec_flag(pipefd[0]);

    if(ret < 0){

      perror("set_cloexec_flag");

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    ret = set_cloexec_flag(pipefd[1]);

    if(ret < 0){

      perror("set_cloexec_flag");

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    /* Block SIGCHLD until process is safely in process list */

    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);

    if(ret < 0){

      perror("sigprocmask");

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    // Starting a new process to be watched

    pid_t pid = fork();

    if(pid == 0){

      /* this is the child process */

      ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);

      if(ret < 0){

	perror("sigaction");

	_exit(EXIT_FAILURE);

      }

      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);

      if(ret < 0){

	perror("sigprocmask");

	_exit(EXIT_FAILURE);

      }

      dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */

      if(dirfd(dir) < 0){

	/* If dir has no file descriptor, we could not set FD_CLOEXEC

	   above and must now close it manually here. */

	closedir(dir);

      }

      if(execv(filename, p->argv) < 0){

	perror("execv");

	_exit(EXIT_FAILURE);

      }

      /* no return */

    }

    /* parent process */

    free(filename);

    close(pipefd[1]);		/* close unused write end of pipe */

    process *new_process = malloc(sizeof(process));

    if (new_process == NULL){

      perror("malloc");

      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);

      if(ret < 0){

	perror("sigprocmask");

      }

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    *new_process = (struct process){ .pid = pid,

				     .fd = pipefd[0],

				     .next = process_list };

    // List handling

    process_list = new_process;

    /* Unblock SIGCHLD so signal handler can be run if this process

       has already completed */

    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);

    if(ret < 0){

      perror("sigprocmask");

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    FD_SET(new_process->fd, &rfds_all);

    if (maxfd < new_process->fd){

      maxfd = new_process->fd;

    }

  }

  /* Free the plugin list */

  for(plugin *next; plugin_list != NULL; plugin_list = next){

    next = plugin_list->next;

    free(plugin_list->argv);

    free(plugin_list);

  }

  closedir(dir);

  dir = NULL;

  if (process_list == NULL){

    fprintf(stderr, "No plugin processes started, exiting\n");

    exitstatus = EXIT_FAILURE;

    goto end;

  }

  while(process_list){

    fd_set rfds = rfds_all;

    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);

    if (select_ret == -1){

      perror("select");

      exitstatus = EXIT_FAILURE;

      goto end;

    }

    /* OK, now either a process completed, or something can be read

       from one of them */

    for(process *proc = process_list; proc ; proc = proc->next){

      /* Is this process completely done? */

      if(proc->eof and proc->completed){

	/* Only accept the plugin output if it exited cleanly */

	if(not WIFEXITED(proc->status)

	   or WEXITSTATUS(proc->status) != 0){

	  /* Bad exit by plugin */

	  if(debug){

	    if(WIFEXITED(proc->status)){

	      fprintf(stderr, "Plugin %d exited with status %d\n",

		      proc->pid, WEXITSTATUS(proc->status));

	    } else if(WIFSIGNALED(proc->status)) {

	      fprintf(stderr, "Plugin %d killed by signal %d\n",

		      proc->pid, WTERMSIG(proc->status));

	    } else if(WCOREDUMP(proc->status)){

	      fprintf(stderr, "Plugin %d dumped core\n", proc->pid);

	    }

	  }

	  /* Remove the plugin */

	  FD_CLR(proc->fd, &rfds_all);

	  /* Block signal while modifying process_list */

	  ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);

	  if(ret < 0){

	    perror("sigprocmask");

	    exitstatus = EXIT_FAILURE;

	    goto end;

	  }

	  /* Delete this process entry from the list */

	  if(process_list == proc){

	    /* First one - simple */

	    process_list = proc->next;

	  } else {

	    /* Second one or later */

	    for(process *p = process_list; p != NULL; p = p->next){

	      if(p->next == proc){

		p->next = proc->next;

		break;

	      }

	    }

	  }

	  /* We are done modifying process list, so unblock signal */

	  ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,

			     NULL);

	  if(ret < 0){

	    perror("sigprocmask");

	  }

	  free(proc->buffer);

	  free(proc);

	  /* We deleted this process from the list, so we can't go

	     proc->next.  Therefore, start over from the beginning of

	     the process list */

	  break;

	}

	/* This process exited nicely, so print its buffer */

	for(size_t written = 0; written < proc->buffer_length;

	    written += (size_t)ret){

	  ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO,

					 proc->buffer + written,

					 proc->buffer_length

					 - written));

	  if(ret < 0){

	    perror("write");

	    exitstatus = EXIT_FAILURE;

	    goto end;

	  }

	}

	goto end;

      }

      /* This process has not completed.  Does it have any output? */

      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){

	/* This process had nothing to say at this time */

	continue;

      }

      /* Before reading, make the process' data buffer large enough */

      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){

	proc->buffer = realloc(proc->buffer, proc->buffer_size