/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 plugbasedclient.c

  • Committer: Teddy Hogeborn
  • Date: 2008-08-01 06:33:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080801063315-4k33q3ek28hjc3tu
* plugins.d/plugbasedclient.c: Update include file comments.
  (struct process.disable): Renamed to "disabled".  All users changed.
  (addarguments): Renamed to "addargument".  All callers changed.
  (doc, args_doc): Removed.
  (main): Changed default "plugindir" to
          "/conf/conf.d/mandos/plugins.d".  Renamed "rfds_orig" to
           "rfds_all"; all users changed.  New "debug" and
           "exitstatus" variables.  New "--debug" option.  Removed
           unnecessary ".flags = 0" from all options.  Changed so that
           "--disable-plugin" only takes one plugin.  Check for
           non-existence of ":" in argument to "--options-for".  Added
           some debugging outputs.  Set the FD_CLOEXEC flag on the
           directory FD.  More capable code for dealing with
           disallowed plugin file name prefixes and suffixes.  Bug
           fix: check for some malloc failures.  Moved allocating the
           "struct process *new_process" to after the fork.  Do
           _exit() instead of exit() in the child.

* plugins.d/mandosclient.c: Updated contact information.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugbasedclient.c
21
21
 * Contact the authors at <mandos@fukt.bsnet.se>.
22
22
 */
23
23
 
24
 
#include <stdio.h>      /* popen, fileno */
25
 
#include <iso646.h>     /* and, or, not */
26
 
#include <sys/types.h>  /* DIR, opendir, stat, struct stat, waitpid,
27
 
                           WIFEXITED, WEXITSTATUS, wait */
28
 
#include <sys/wait.h>   /* wait */
29
 
#include <dirent.h>     /* DIR, opendir */
30
 
#include <sys/stat.h>   /* stat, struct stat */
31
 
#include <unistd.h>     /* stat, struct stat, chdir */
32
 
#include <stdlib.h>     /* EXIT_FAILURE */
33
 
#include <sys/select.h> /* fd_set, select, FD_ZERO, FD_SET,
34
 
                           FD_ISSET */
35
 
#include <string.h>     /* strlen, strcpy, strcat */
36
 
#include <stdbool.h>    /* true */
37
 
#include <sys/wait.h>   /* waitpid, WIFEXITED, WEXITSTATUS */
38
 
#include <errno.h>      /* errno */
39
 
#include <argp.h>       /* argp */
 
24
#include <stdio.h>              /* popen(), fileno(), fprintf(),
 
25
                                   stderr, STDOUT_FILENO */
 
26
#include <iso646.h>             /* and, or, not */
 
27
#include <sys/types.h>         /* DIR, opendir(), stat(), struct stat,
 
28
                                  waitpid(), WIFEXITED(),
 
29
                                  WEXITSTATUS(), wait() */
 
30
#include <sys/wait.h>           /* wait() */
 
31
#include <dirent.h>             /* DIR, struct dirent, opendir(),
 
32
                                   readdir(), closedir() */
 
33
#include <sys/stat.h>           /* struct stat, stat(), S_ISREG() */
 
34
#include <unistd.h>             /* struct stat, stat(), S_ISREG(),
 
35
                                   fcntl() */
 
36
#include <fcntl.h>              /* fcntl() */
 
37
#include <stddef.h>             /* NULL */
 
38
#include <stdlib.h>             /* EXIT_FAILURE */
 
39
#include <sys/select.h>         /* fd_set, select(), FD_ZERO(),
 
40
                                   FD_SET(), FD_ISSET() */
 
41
#include <string.h>             /* strlen(), strcpy(), strcat() */
 
42
#include <stdbool.h>            /* true */
 
43
#include <sys/wait.h>           /* waitpid(), WIFEXITED(),
 
44
                                   WEXITSTATUS() */
 
45
#include <errno.h>              /* errno */
 
46
#include <argp.h>               /* struct argp_option,
 
47
                                   struct argp_state, struct argp,
 
48
                                   argp_parse() */
40
49
 
41
50
struct process;
42
51
 
50
59
} process;
51
60
 
52
61
typedef struct plugin{
53
 
  char *name;           /* can be "global" and any plugin name */
 
62
  char *name;                   /* can be NULL or any plugin name */
54
63
  char **argv;
55
64
  int argc;
56
 
  bool disable;
 
65
  bool disabled;
57
66
  struct plugin *next;
58
67
} plugin;
59
68
 
79
88
  new_plugin->argv[0] = name;
80
89
  new_plugin->argv[1] = NULL;
81
90
  new_plugin->argc = 1;
82
 
  new_plugin->disable = false;
 
91
  new_plugin->disabled = false;
83
92
  new_plugin->next = *plugin_list;
84
93
  /* Append the new plugin to the list */
85
94
  *plugin_list = new_plugin;
86
95
  return new_plugin;
87
96
}
88
97
 
89
 
void addarguments(plugin *p, char *arg){
 
98
void addargument(plugin *p, char *arg){
90
99
  p->argv[p->argc] = arg;
91
100
  p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
92
101
  if (p->argv == NULL){
96
105
  p->argc++;
97
106
  p->argv[p->argc] = NULL;
98
107
}
99
 
        
 
108
 
100
109
#define BUFFER_SIZE 256
101
110
 
102
111
const char *argp_program_version =
103
112
  "plugbasedclient 0.9";
104
113
const char *argp_program_bug_address =
105
114
  "<mandos@fukt.bsnet.se>";
106
 
static char doc[] =
107
 
  "Mandos plugin runner -- Run Mandos plugins";
108
 
/* A description of the arguments we accept. */
109
 
static char args_doc[] = "";
110
115
 
111
116
int main(int argc, char *argv[]){
112
 
  const char *plugindir = "plugins.d";
 
117
  const char *plugindir = "/conf/conf.d/mandos/plugins.d";
113
118
  size_t d_name_len;
114
119
  DIR *dir;
115
120
  struct dirent *dirst;
116
121
  struct stat st;
117
 
  fd_set rfds_orig;
 
122
  fd_set rfds_all;
118
123
  int ret, maxfd = 0;
119
124
  process *process_list = NULL;
120
 
 
 
125
  bool debug = false;
 
126
  int exitstatus = EXIT_SUCCESS;
 
127
  
121
128
  /* The options we understand. */
122
129
  struct argp_option options[] = {
123
130
    { .name = "global-options", .key = 'g',
124
 
      .arg = "option[,option[,...]]", .flags = 0,
125
 
      .doc = "Options effecting all plugins" },
 
131
      .arg = "OPTION[,OPTION[,...]]",
 
132
      .doc = "Options passed to all plugins" },
126
133
    { .name = "options-for", .key = 'o',
127
 
      .arg = "plugin:option[,option[,...]]", .flags = 0,
128
 
      .doc = "Options effecting only specified plugins" },
129
 
    { .name = "disable-plugin", .key = 'd',
130
 
      .arg = "Plugin[,Plugin[,...]]", .flags = 0,
131
 
      .doc = "Option to disable specififed plugins" },
 
134
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
 
135
      .doc = "Options passed only to specified plugin" },
 
136
    { .name = "disable", .key = 'd',
 
137
      .arg = "PLUGIN",
 
138
      .doc = "Disable a specific plugin", .group = 1 },
132
139
    { .name = "plugin-dir", .key = 128,
133
 
      .arg = "Directory", .flags = 0,
134
 
      .doc = "Option to change directory to search for plugins" },
 
140
      .arg = "DIRECTORY",
 
141
      .doc = "Specify a different plugin directory", .group = 2 },
 
142
    { .name = "debug", .key = 129,
 
143
      .doc = "Debug mode", .group = 3 },
135
144
    { .name = NULL }
136
145
  };
137
146
  
138
147
  error_t parse_opt (int key, char *arg, struct argp_state *state) {
139
148
       /* Get the INPUT argument from `argp_parse', which we
140
 
          know is a pointer to our arguments structure. */
 
149
          know is a pointer to our plugin list pointer. */
141
150
    plugin **plugins = state->input;
142
151
    switch (key) {
143
152
    case 'g':
144
153
      if (arg != NULL){
145
154
        char *p = strtok(arg, ",");
146
155
        do{
147
 
          addarguments(getplugin(NULL, plugins), p);
 
156
          addargument(getplugin(NULL, plugins), p);
148
157
          p = strtok(NULL, ",");
149
158
        } while (p);
150
159
      }
153
162
      if (arg != NULL){
154
163
        char *name = strtok(arg, ":");
155
164
        char *p = strtok(NULL, ":");
156
 
        p = strtok(p, ",");
157
 
        do{
158
 
          addarguments(getplugin(name, plugins), p);
159
 
          p = strtok(NULL, ",");
160
 
        } while (p);
 
165
        if(p){
 
166
          p = strtok(p, ",");
 
167
          do{
 
168
            addargument(getplugin(name, plugins), p);
 
169
            p = strtok(NULL, ",");
 
170
          } while (p);
 
171
        }
161
172
      }
162
173
      break;
163
174
    case 'd':
164
175
      if (arg != NULL){
165
 
        char *p = strtok(arg, ",");
166
 
        do{
167
 
          getplugin(p, plugins)->disable = true;
168
 
          p = strtok(NULL, ",");
169
 
        } while (p);
 
176
        getplugin(arg, plugins)->disabled = true;
170
177
      }
171
178
      break;
172
179
    case 128:
173
180
      plugindir = arg;
174
181
      break;
 
182
    case 129:
 
183
      debug = true;
 
184
      break;
175
185
    case ARGP_KEY_ARG:
176
186
      argp_usage (state);
177
187
      break;
182
192
    }
183
193
    return 0;
184
194
  }
185
 
 
 
195
  
186
196
  plugin *plugin_list = NULL;
187
197
  
188
198
  struct argp argp = { .options = options, .parser = parse_opt,
189
 
                       .args_doc = args_doc, .doc = doc };
190
 
 
 
199
                       .args_doc = "",
 
200
                       .doc = "Mandos plugin runner -- Run plugins" };
 
201
  
191
202
  argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
192
 
 
193
 
/*   for(plugin *p = plugin_list; p != NULL; p=p->next){ */
194
 
/*     fprintf(stderr, "Plugin: %s has %d arguments\n", p->name ? p->name : "Global", p->argc); */
195
 
/*     for(char **a = p->argv + 1; *a != NULL; a++){ */
196
 
/*       fprintf(stderr, "\tArg: %s\n", *a); */
197
 
/*     } */
198
 
/*   } */
199
 
  
200
 
/*   return 0; */
201
 
 
 
203
  
 
204
  if(debug){
 
205
    for(plugin *p = plugin_list; p != NULL; p=p->next){
 
206
      fprintf(stderr, "Plugin: %s has %d arguments\n",
 
207
              p->name ? p->name : "Global", p->argc);
 
208
      for(char **a = p->argv; *a != NULL; a++){
 
209
        fprintf(stderr, "\tArg: %s\n", *a);
 
210
      }
 
211
    }
 
212
  }
 
213
  
202
214
  dir = opendir(plugindir);
 
215
  {
 
216
    /* Set the FD_CLOEXEC flag on the directory */
 
217
    int fd = dirfd(dir);
 
218
    ret = fcntl (fd, F_GETFD, 0);
 
219
    if(ret < 0){
 
220
      perror("fcntl F_GETFD");
 
221
      goto end;
 
222
    }
 
223
    ret = fcntl(fd, F_SETFD, FD_CLOEXEC | ret);
 
224
    if(ret < 0){
 
225
      perror("fcntl F_SETFD");
 
226
      goto end;
 
227
    }
 
228
  }
203
229
  
204
230
  if(dir == NULL){
205
231
    fprintf(stderr, "Can not open directory\n");
206
232
    return EXIT_FAILURE;
207
233
  }
208
234
  
209
 
  FD_ZERO(&rfds_orig);
 
235
  FD_ZERO(&rfds_all);
210
236
  
211
237
  while(true){
212
238
    dirst = readdir(dir);
218
244
    
219
245
    d_name_len = strlen(dirst->d_name);
220
246
    
221
 
    // Ignore dotfiles and backup files
222
 
    if (dirst->d_name[0] == '.'
223
 
        or dirst->d_name[d_name_len - 1] == '~'){
224
 
      continue;
 
247
    // Ignore dotfiles, backup files and other junk
 
248
    {
 
249
      bool bad_name = false;
 
250
      
 
251
      const char const *bad_prefixes[] = { ".", "#", NULL };
 
252
      
 
253
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
 
254
                                           ".dpkg-old",
 
255
                                           ".dpkg-divert", NULL };
 
256
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
 
257
        size_t pre_len = strlen(*pre);
 
258
        if((d_name_len >= pre_len)
 
259
           and strncmp((dirst->d_name), *pre, pre_len) == 0){
 
260
          if(debug){
 
261
            fprintf(stderr, "Ignoring plugin dir entry name \"%s\""
 
262
                    " with bad prefix %s\n", dirst->d_name, *pre);
 
263
          }
 
264
          bad_name = true;
 
265
          break;
 
266
        }
 
267
      }
 
268
      
 
269
      if(bad_name){
 
270
        continue;
 
271
      }
 
272
      
 
273
      for(const char **suf = bad_suffixes; *suf != NULL; suf++){
 
274
        size_t suf_len = strlen(*suf);
 
275
        if((d_name_len >= suf_len)
 
276
           and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
 
277
                == 0)){
 
278
          if(debug){
 
279
            fprintf(stderr, "Ignoring plugin dir entry name \"%s\""
 
280
                    " with bad suffix %s\n", dirst->d_name, *suf);
 
281
          }
 
282
          bad_name = true;
 
283
          break;
 
284
        }
 
285
      }
 
286
      
 
287
      if(bad_name){
 
288
        continue;
 
289
      }
225
290
    }
226
 
 
 
291
    
227
292
    char *filename = malloc(d_name_len + strlen(plugindir) + 2);
 
293
    if (filename == NULL){
 
294
      perror("malloc");
 
295
      exitstatus =EXIT_FAILURE;
 
296
      goto end;
 
297
    }
228
298
    strcpy(filename, plugindir);
229
299
    strcat(filename, "/");
230
300
    strcat(filename, dirst->d_name);    
231
301
 
232
302
    stat(filename, &st);
233
303
 
234
 
    if (S_ISREG(st.st_mode)
235
 
        and (access(filename, X_OK) == 0)
236
 
        and not (getplugin(dirst->d_name, &plugin_list)->disable)){
237
 
      // Starting a new process to be watched
238
 
      process *new_process = malloc(sizeof(process));
239
 
      int pipefd[2]; 
240
 
      ret = pipe(pipefd);
241
 
      if (ret == -1){
242
 
        perror(argv[0]);
243
 
        goto end;
244
 
      }
245
 
      new_process->pid = fork();
246
 
      if(new_process->pid == 0){
247
 
        /* this is the child process */
248
 
        closedir(dir);
249
 
        close(pipefd[0]);       /* close unused read end of pipe */
250
 
        dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
251
 
 
252
 
        plugin *p = getplugin(dirst->d_name, &plugin_list);
253
 
        plugin *g = getplugin(NULL, &plugin_list);
254
 
        for(char **a = g->argv + 1; *a != NULL; a++){
255
 
          addarguments(p, *a);
256
 
        }
257
 
        if(execv(filename, p->argv) < 0){
258
 
          perror(argv[0]);
259
 
          close(pipefd[1]);
260
 
          exit(EXIT_FAILURE);
261
 
        }
262
 
        /* no return */
263
 
      }
264
 
      close(pipefd[1]);         /* close unused write end of pipe */
265
 
      new_process->fd = pipefd[0];
266
 
      new_process->buffer = malloc(BUFFER_SIZE);
267
 
      if (new_process->buffer == NULL){
268
 
        perror(argv[0]);
269
 
        goto end;
270
 
      }
271
 
      new_process->buffer_size = BUFFER_SIZE;
272
 
      new_process->buffer_length = 0;
273
 
      FD_SET(new_process->fd, &rfds_orig);
274
 
      
275
 
      if (maxfd < new_process->fd){
276
 
        maxfd = new_process->fd;
277
 
      }
278
 
      
279
 
      //List handling
280
 
      new_process->next = process_list;
281
 
      process_list = new_process;
282
 
    }
 
304
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
 
305
      if(debug){
 
306
        fprintf(stderr, "Ignoring plugin dir entry name \"%s\""
 
307
                " with bad type or mode\n", filename);
 
308
      }
 
309
      continue;
 
310
    }
 
311
    if(getplugin(dirst->d_name, &plugin_list)->disabled){
 
312
      if(debug){
 
313
        fprintf(stderr, "Ignoring disabled plugin \"%s\"",
 
314
                dirst->d_name);
 
315
      }
 
316
      continue;
 
317
    }
 
318
    // Starting a new process to be watched
 
319
    int pipefd[2]; 
 
320
    ret = pipe(pipefd);
 
321
    if (ret == -1){
 
322
      perror(argv[0]);
 
323
      goto end;
 
324
    }
 
325
    pid_t pid = fork();
 
326
    if(pid == 0){
 
327
      /* this is the child process */
 
328
      closedir(dir);
 
329
      close(pipefd[0]); /* close unused read end of pipe */
 
330
      dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
 
331
      
 
332
      plugin *p = getplugin(dirst->d_name, &plugin_list);
 
333
      plugin *g = getplugin(NULL, &plugin_list);
 
334
      for(char **a = g->argv + 1; *a != NULL; a++){
 
335
        addargument(p, *a);
 
336
      }
 
337
      if(execv(filename, p->argv) < 0){
 
338
        perror(argv[0]);
 
339
        close(pipefd[1]);
 
340
        _exit(EXIT_FAILURE);
 
341
      }
 
342
      /* no return */
 
343
    }
 
344
    close(pipefd[1]);           /* close unused write end of pipe */
 
345
    process *new_process = malloc(sizeof(process));
 
346
    if (new_process == NULL){
 
347
      perror("malloc");
 
348
      exitstatus = EXIT_FAILURE;
 
349
      goto end;
 
350
    }
 
351
    
 
352
    new_process->fd = pipefd[0];
 
353
    new_process->buffer = malloc(BUFFER_SIZE);
 
354
    if (new_process->buffer == NULL){
 
355
      perror("malloc");
 
356
      exitstatus = EXIT_FAILURE;
 
357
      goto end;
 
358
    }
 
359
    new_process->buffer_size = BUFFER_SIZE;
 
360
    new_process->buffer_length = 0;
 
361
    FD_SET(new_process->fd, &rfds_all);
 
362
      
 
363
    if (maxfd < new_process->fd){
 
364
      maxfd = new_process->fd;
 
365
    }
 
366
    
 
367
    //List handling
 
368
    new_process->next = process_list;
 
369
    process_list = new_process;
283
370
  }
284
371
  
285
372
  closedir(dir);
286
373
  
287
374
  if (process_list != NULL){
288
375
    while(true){
289
 
      fd_set rfds = rfds_orig;
 
376
      fd_set rfds = rfds_all;
290
377
      int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
291
378
      if (select_ret == -1){
292
379
        perror(argv[0]);
332
419
                }
333
420
                goto end;
334
421
              } else {
335
 
                FD_CLR(process_itr->fd, &rfds_orig);
 
422
                FD_CLR(process_itr->fd, &rfds_all);
336
423
              }
337
424
            }
338
425
          }
359
446
      break;
360
447
    }
361
448
  }  
362
 
  return EXIT_SUCCESS;
 
449
  return exitstatus;
363
450
}