/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: 2008-08-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.c
21
21
 * Contact the authors at <mandos@fukt.bsnet.se>.
22
22
 */
23
23
 
24
 
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY() */
25
 
 
 
24
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY(), getline(),
 
25
                                   asprintf() */
26
26
#include <stddef.h>             /* size_t, NULL */
27
27
#include <stdlib.h>             /* malloc(), exit(), EXIT_FAILURE,
28
28
                                   EXIT_SUCCESS, realloc() */
51
51
                                   close() */
52
52
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
53
53
                                   FD_CLOEXEC */
54
 
#include <string.h>             /* strsep, strlen(), strcpy(),
55
 
                                   strcat() */
 
54
#include <string.h>             /* strsep, strlen(), asprintf() */
56
55
#include <errno.h>              /* errno */
57
56
#include <argp.h>               /* struct argp_option, struct
58
57
                                   argp_state, struct argp,
65
64
#include <errno.h>              /* errno, EBADF */
66
65
 
67
66
#define BUFFER_SIZE 256
68
 
#define CONFFILE "/conf/conf.d/mandos/client.conf"
 
67
#define ARGFILE "/conf/conf.d/mandos/plugin-runner.conf"
69
68
 
70
 
const char *argp_program_version = "mandos-client 1.0";
 
69
const char *argp_program_version = "plugin-runner 1.0";
71
70
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
72
71
 
73
72
struct process;
88
87
  char *name;                   /* can be NULL or any plugin name */
89
88
  char **argv;
90
89
  int argc;
 
90
  char **environ;
 
91
  int envc;
91
92
  bool disabled;
92
93
  struct plugin *next;
93
94
} plugin;
102
103
  /* Create a new plugin */
103
104
  plugin *new_plugin = malloc(sizeof(plugin));
104
105
  if (new_plugin == NULL){
105
 
    perror("malloc");
106
 
    exit(EXIT_FAILURE);
107
 
  }
108
 
  new_plugin->name = name;
 
106
    return NULL;
 
107
  }
 
108
  char *copy_name = strdup(name);
 
109
  if(copy_name == NULL){
 
110
    return NULL;
 
111
  }
 
112
  
 
113
  *new_plugin = (plugin) { .name = copy_name,
 
114
                           .argc = 1,
 
115
                           .envc = 0,
 
116
                           .disabled = false,
 
117
                           .next = *plugin_list };
 
118
  
109
119
  new_plugin->argv = malloc(sizeof(char *) * 2);
110
120
  if (new_plugin->argv == NULL){
111
 
    perror("malloc");
112
 
    exit(EXIT_FAILURE);
 
121
    free(new_plugin);
 
122
    return NULL;
113
123
  }
114
 
  new_plugin->argv[0] = name;
 
124
  new_plugin->argv[0] = copy_name;
115
125
  new_plugin->argv[1] = NULL;
116
 
  new_plugin->argc = 1;
117
 
  new_plugin->disabled = false;
118
 
  new_plugin->next = *plugin_list;
 
126
 
 
127
  new_plugin->environ = malloc(sizeof(char *));
 
128
  if(new_plugin->environ == NULL){
 
129
    free(new_plugin->argv);
 
130
    free(new_plugin);
 
131
    return NULL;
 
132
  }
 
133
  new_plugin->environ[0] = NULL;
119
134
  /* Append the new plugin to the list */
120
135
  *plugin_list = new_plugin;
121
136
  return new_plugin;
122
137
}
123
138
 
124
 
static void addargument(plugin *p, char *arg){
125
 
  p->argv[p->argc] = arg;
126
 
  p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
127
 
  if (p->argv == NULL){
128
 
    perror("malloc");
129
 
    exit(EXIT_FAILURE);
130
 
  }
131
 
  p->argc++;
132
 
  p->argv[p->argc] = NULL;
133
 
}
 
139
/* Helper function for add_argument and add_environment */
 
140
static bool add_to_char_array(const char *new, char ***array,
 
141
                              int *len){
 
142
  /* Resize the pointed-to array to hold one more pointer */
 
143
  *array = realloc(*array, sizeof(char *)
 
144
                   * (size_t) ((*len) + 2));
 
145
  /* Malloc check */
 
146
  if(*array == NULL){
 
147
    return false;
 
148
  }
 
149
  /* Make a copy of the new string */
 
150
  char *copy = strdup(new);
 
151
  if(copy == NULL){
 
152
    return false;
 
153
  }
 
154
  /* Insert the copy */
 
155
  (*array)[*len] = copy;
 
156
  (*len)++;
 
157
  /* Add a new terminating NULL pointer to the last element */
 
158
  (*array)[*len] = NULL;
 
159
  return true;
 
160
}
 
161
 
 
162
/* Add to a plugin's argument vector */
 
163
static bool add_argument(plugin *p, const char *arg){
 
164
  if(p == NULL){
 
165
    return false;
 
166
  }
 
167
  return add_to_char_array(arg, &(p->argv), &(p->argc));
 
168
}
 
169
 
 
170
/* Add to a plugin's environment */
 
171
static bool add_environment(plugin *p, const char *def){
 
172
  if(p == NULL){
 
173
    return false;
 
174
  }
 
175
  return add_to_char_array(def, &(p->environ), &(p->envc));
 
176
}
 
177
 
134
178
 
135
179
/*
136
180
 * Based on the example in the GNU LibC manual chapter 13.13 "File
186
230
  return true;
187
231
}
188
232
 
189
 
char ** addcustomargument(char **argv, int *argc, char *arg){
190
 
 
 
233
char **add_to_argv(char **argv, int *argc, char *arg){
191
234
  if (argv == NULL){
192
235
    *argc = 1;
193
236
    argv = malloc(sizeof(char*) * 2);
208
251
  return argv;
209
252
}
210
253
 
 
254
static void free_plugin_list(plugin *plugin_list){
 
255
  for(plugin *next = plugin_list; plugin_list != NULL; plugin_list = next){
 
256
    next = plugin_list->next;
 
257
    free(plugin_list->name);
 
258
    for(char **arg = plugin_list->argv; *arg != NULL; arg++){
 
259
      free(*arg);
 
260
    }    
 
261
    free(plugin_list->argv);
 
262
    for(char **env = plugin_list->environ; *env != NULL; env++){
 
263
      free(*env);
 
264
    }
 
265
    free(plugin_list->environ);
 
266
    free(plugin_list);
 
267
  }  
 
268
}
 
269
 
211
270
int main(int argc, char *argv[]){
212
 
  const char *plugindir = "/conf/conf.d/mandos/plugins.d";
213
 
  const char *conffile = CONFFILE;
 
271
  const char *plugindir = "/lib/mandos/plugins.d";
 
272
  const char *argfile = ARGFILE;
214
273
  FILE *conffp;
215
274
  size_t d_name_len;
216
275
  DIR *dir = NULL;
231
290
  /* Establish a signal handler */
232
291
  sigemptyset(&sigchld_action.sa_mask);
233
292
  ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
234
 
  if(ret < 0){
 
293
  if(ret == -1){
235
294
    perror("sigaddset");
236
 
    exit(EXIT_FAILURE);
 
295
    exitstatus = EXIT_FAILURE;
 
296
    goto fallback;
237
297
  }
238
298
  ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
239
 
  if(ret < 0){
 
299
  if(ret == -1){
240
300
    perror("sigaction");
241
 
    exit(EXIT_FAILURE);
 
301
    exitstatus = EXIT_FAILURE;    
 
302
    goto fallback;
242
303
  }
243
304
  
244
305
  /* The options we understand. */
246
307
    { .name = "global-options", .key = 'g',
247
308
      .arg = "OPTION[,OPTION[,...]]",
248
309
      .doc = "Options passed to all plugins" },
 
310
    { .name = "global-envs", .key = 'e',
 
311
      .arg = "VAR=value",
 
312
      .doc = "Environment variable passed to all plugins" },
249
313
    { .name = "options-for", .key = 'o',
250
314
      .arg = "PLUGIN:OPTION[,OPTION[,...]]",
251
315
      .doc = "Options passed only to specified plugin" },
 
316
    { .name = "envs-for", .key = 'f',
 
317
      .arg = "PLUGIN:ENV=value",
 
318
      .doc = "Environment variable passed to specified plugin" },
252
319
    { .name = "disable", .key = 'd',
253
320
      .arg = "PLUGIN",
254
321
      .doc = "Disable a specific plugin", .group = 1 },
278
345
          if(p[0] == '\0'){
279
346
            continue;
280
347
          }
281
 
          addargument(getplugin(NULL, plugins), p);
 
348
          if(not add_argument(getplugin(NULL, plugins), p)){
 
349
            perror("add_argument");
 
350
            return ARGP_ERR_UNKNOWN;
 
351
          }
 
352
        }
 
353
      }
 
354
      break;
 
355
    case 'e':
 
356
      if(arg == NULL){
 
357
        break;
 
358
      }
 
359
      {
 
360
        char *envdef = strdup(arg);
 
361
        if(envdef == NULL){
 
362
          break;
 
363
        }
 
364
        if(not add_environment(getplugin(NULL, plugins), envdef)){
 
365
          perror("add_environment");
282
366
        }
283
367
      }
284
368
      break;
285
369
    case 'o':
286
370
      if (arg != NULL){
287
 
        char *name = strsep(&arg, ":");
288
 
        if(name[0] == '\0'){
 
371
        char *p_name = strsep(&arg, ":");
 
372
        if(p_name[0] == '\0'){
289
373
          break;
290
374
        }
291
375
        char *opt = strsep(&arg, ":");
298
382
            if(p[0] == '\0'){
299
383
              continue;
300
384
            }
301
 
            addargument(getplugin(name, plugins), p);
 
385
            if(not add_argument(getplugin(p_name, plugins), p)){
 
386
              perror("add_argument");
 
387
              return ARGP_ERR_UNKNOWN;
 
388
            }
302
389
          }
303
390
        }
304
391
      }
305
392
      break;
 
393
    case 'f':
 
394
      if(arg == NULL){
 
395
        break;
 
396
      }
 
397
      {
 
398
        char *envdef = strchr(arg, ':');
 
399
        if(envdef == NULL){
 
400
          break;
 
401
        }
 
402
        char *p_name = strndup(arg, (size_t) (envdef-arg));
 
403
        if(p_name == NULL){
 
404
          break;
 
405
        }
 
406
        envdef++;
 
407
        if(not add_environment(getplugin(p_name, plugins), envdef)){
 
408
          perror("add_environment");
 
409
        }
 
410
      }
 
411
      break;
306
412
    case 'd':
307
413
      if (arg != NULL){
308
 
        getplugin(arg, plugins)->disabled = true;
 
414
        plugin *p = getplugin(arg, plugins);
 
415
        if(p == NULL){
 
416
          return ARGP_ERR_UNKNOWN;
 
417
        }
 
418
        p->disabled = true;
309
419
      }
310
420
      break;
311
421
    case 128:
321
431
      debug = true;
322
432
      break;
323
433
    case ARGP_KEY_ARG:
324
 
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg); 
 
434
      fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
325
435
      break;
326
436
    case ARGP_KEY_END:
327
437
      break;
341
451
  if (ret == ARGP_ERR_UNKNOWN){
342
452
    fprintf(stderr, "Unknown error while parsing arguments\n");
343
453
    exitstatus = EXIT_FAILURE;
344
 
    goto end;
 
454
    goto fallback;
345
455
  }
346
456
 
347
 
  conffp = fopen(conffile, "r");
 
457
  conffp = fopen(argfile, "r");
348
458
  if(conffp != NULL){
349
459
    char *org_line = NULL;
 
460
    char *p, *arg, *new_arg, *line;
350
461
    size_t size = 0;
351
462
    ssize_t sret;
352
 
    char *p, *arg, *new_arg, *line;
353
463
    const char whitespace_delims[] = " \r\t\f\v\n";
354
464
    const char comment_delim[] = "#";
355
465
 
366
476
          continue;
367
477
        }
368
478
        new_arg = strdup(p);
369
 
        custom_argv = addcustomargument(custom_argv, &custom_argc, new_arg);
 
479
        custom_argv = add_to_argv(custom_argv, &custom_argc, new_arg);
370
480
        if (custom_argv == NULL){
371
 
          perror("addcustomargument");
 
481
          perror("add_to_argv");
372
482
          exitstatus = EXIT_FAILURE;
373
 
          goto end;
 
483
          goto fallback;
374
484
        }
375
485
      }
376
486
    }
377
487
    free(org_line);
378
488
  } else{
379
 
    /* check for harmfull errors */
 
489
    /* Check for harmful errors and go to fallback. Other errors might
 
490
       not affect opening plugins */
380
491
    if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
381
492
      perror("fopen");
382
493
      exitstatus = EXIT_FAILURE;
383
 
      goto end;
 
494
      goto fallback;
384
495
    }
385
496
  }
386
497
 
390
501
    if (ret == ARGP_ERR_UNKNOWN){
391
502
      fprintf(stderr, "Unknown error while parsing arguments\n");
392
503
      exitstatus = EXIT_FAILURE;
393
 
      goto end;
 
504
      goto fallback;
394
505
    }
395
506
  }
396
507
  
401
512
      for(char **a = p->argv; *a != NULL; a++){
402
513
        fprintf(stderr, "\tArg: %s\n", *a);
403
514
      }
 
515
      fprintf(stderr, "...and %u environment variables\n", p->envc);
 
516
      for(char **a = p->environ; *a != NULL; a++){
 
517
        fprintf(stderr, "\t%s\n", *a);
 
518
      }
404
519
    }
405
520
  }
406
521
  
418
533
  if(dir == NULL){
419
534
    perror("Could not open plugin dir");
420
535
    exitstatus = EXIT_FAILURE;
421
 
    goto end;
 
536
    goto fallback;
422
537
  }
423
538
  
424
539
  /* Set the FD_CLOEXEC flag on the directory, if possible */
429
544
      if(ret < 0){
430
545
        perror("set_cloexec_flag");
431
546
        exitstatus = EXIT_FAILURE;
432
 
        goto end;
 
547
        goto fallback;
433
548
      }
434
549
    }
435
550
  }
444
559
      if (errno == EBADF){
445
560
        perror("readdir");
446
561
        exitstatus = EXIT_FAILURE;
447
 
        goto end;
 
562
        goto fallback;
448
563
      }
449
564
      break;
450
565
    }
495
610
        continue;
496
611
      }
497
612
    }
498
 
    
499
 
    char *filename = malloc(d_name_len + strlen(plugindir) + 2);
500
 
    if (filename == NULL){
501
 
      perror("malloc");
 
613
 
 
614
    char *filename;
 
615
    ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
 
616
    if(ret < 0){
 
617
      perror("asprintf");
502
618
      continue;
503
619
    }
504
 
    strcpy(filename, plugindir); /* Spurious warning */
505
 
    strcat(filename, "/");      /* Spurious warning */
506
 
    strcat(filename, dirst->d_name); /* Spurious warning */
507
620
    
508
621
    ret = stat(filename, &st);
509
622
    if (ret == -1){
520
633
      free(filename);
521
634
      continue;
522
635
    }
523
 
    if(getplugin(dirst->d_name, &plugin_list)->disabled){
 
636
    plugin *p = getplugin(dirst->d_name, &plugin_list);
 
637
    if(p == NULL){
 
638
      perror("getplugin");
 
639
      free(filename);
 
640
      continue;
 
641
    }
 
642
    if(p->disabled){
524
643
      if(debug){
525
644
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
526
645
                dirst->d_name);
528
647
      free(filename);
529
648
      continue;
530
649
    }
531
 
    plugin *p = getplugin(dirst->d_name, &plugin_list);
532
650
    {
533
651
      /* Add global arguments to argument list for this plugin */
534
652
      plugin *g = getplugin(NULL, &plugin_list);
535
 
      for(char **a = g->argv + 1; *a != NULL; a++){
536
 
        addargument(p, *a);
537
 
      }
538
 
    }
 
653
      if(g != NULL){
 
654
        for(char **a = g->argv + 1; *a != NULL; a++){
 
655
          if(not add_argument(p, *a)){
 
656
            perror("add_argument");
 
657
          }
 
658
        }
 
659
        /* Add global environment variables */
 
660
        for(char **e = g->environ; *e != NULL; e++){
 
661
          if(not add_environment(p, *e)){
 
662
            perror("add_environment");
 
663
          }
 
664
        }
 
665
      }
 
666
    }
 
667
    /* If this plugin has any environment variables, we will call
 
668
       using execve and need to duplicate the environment from this
 
669
       process, too. */
 
670
    if(p->environ[0] != NULL){
 
671
      for(char **e = environ; *e != NULL; e++){
 
672
        char *copy = strdup(*e);
 
673
        if(copy == NULL){
 
674
          perror("strdup");
 
675
          continue;
 
676
        }
 
677
        if(not add_environment(p, copy)){
 
678
          perror("add_environment");
 
679
        }
 
680
      }
 
681
    }
 
682
    
539
683
    int pipefd[2]; 
540
684
    ret = pipe(pipefd);
541
685
    if (ret == -1){
542
686
      perror("pipe");
543
687
      exitstatus = EXIT_FAILURE;
544
 
      goto end;
 
688
      goto fallback;
545
689
    }
546
690
    ret = set_cloexec_flag(pipefd[0]);
547
691
    if(ret < 0){
548
692
      perror("set_cloexec_flag");
549
693
      exitstatus = EXIT_FAILURE;
550
 
      goto end;
 
694
      goto fallback;
551
695
    }
552
696
    ret = set_cloexec_flag(pipefd[1]);
553
697
    if(ret < 0){
554
698
      perror("set_cloexec_flag");
555
699
      exitstatus = EXIT_FAILURE;
556
 
      goto end;
 
700
      goto fallback;
557
701
    }
558
702
    /* Block SIGCHLD until process is safely in process list */
559
703
    ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
560
704
    if(ret < 0){
561
705
      perror("sigprocmask");
562
706
      exitstatus = EXIT_FAILURE;
563
 
      goto end;
 
707
      goto fallback;
564
708
    }
565
709
    // Starting a new process to be watched
566
710
    pid_t pid = fork();
567
711
    if(pid == -1){
568
712
      perror("fork");
569
713
      exitstatus = EXIT_FAILURE;
570
 
      goto end;
 
714
      goto fallback;
571
715
    }
572
716
    if(pid == 0){
573
717
      /* this is the child process */
593
737
           above and must now close it manually here. */
594
738
        closedir(dir);
595
739
      }
596
 
      if(execv(filename, p->argv) < 0){
597
 
        perror("execv");
598
 
        _exit(EXIT_FAILURE);
 
740
      if(p->environ[0] == NULL){
 
741
        if(execv(filename, p->argv) < 0){
 
742
          perror("execv");
 
743
          _exit(EXIT_FAILURE);
 
744
        }
 
745
      } else {
 
746
        if(execve(filename, p->argv, p->environ) < 0){
 
747
          perror("execve");
 
748
          _exit(EXIT_FAILURE);
 
749
        }
599
750
      }
600
751
      /* no return */
601
752
    }
610
761
        perror("sigprocmask");
611
762
      }
612
763
      exitstatus = EXIT_FAILURE;
613
 
      goto end;
 
764
      goto fallback;
614
765
    }
615
766
    
616
767
    *new_process = (struct process){ .pid = pid,
624
775
    if(ret < 0){
625
776
      perror("sigprocmask");
626
777
      exitstatus = EXIT_FAILURE;
627
 
      goto end;
 
778
      goto fallback;
628
779
    }
629
780
    
630
781
    FD_SET(new_process->fd, &rfds_all);
635
786
    
636
787
  }
637
788
  
638
 
  /* Free the plugin list */
639
 
  for(plugin *next; plugin_list != NULL; plugin_list = next){
640
 
    next = plugin_list->next;
641
 
    free(plugin_list->argv);
642
 
    free(plugin_list);
643
 
  }
 
789
  free_plugin_list(plugin_list);
644
790
  
645
791
  closedir(dir);
646
792
  dir = NULL;
656
802
    if (select_ret == -1){
657
803
      perror("select");
658
804
      exitstatus = EXIT_FAILURE;
659
 
      goto end;
 
805
      goto fallback;
660
806
    }
661
807
    /* OK, now either a process completed, or something can be read
662
808
       from one of them */
688
834
          if(ret < 0){
689
835
            perror("sigprocmask");
690
836
            exitstatus = EXIT_FAILURE;
691
 
            goto end;
 
837
            goto fallback;
692
838
          }
693
839
          /* Delete this process entry from the list */
694
840
          if(process_list == proc){
723
869
          perror("print_out_password");
724
870
          exitstatus = EXIT_FAILURE;
725
871
        }
726
 
        goto end;
 
872
        goto fallback;
727
873
      }
728
874
      /* This process has not completed.  Does it have any output? */
729
875
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
737
883
        if (proc->buffer == NULL){
738
884
          perror("malloc");
739
885
          exitstatus = EXIT_FAILURE;
740
 
          goto end;
 
886
          goto fallback;
741
887
        }
742
888
        proc->buffer_size += BUFFER_SIZE;
743
889
      }
758
904
  }
759
905
 
760
906
 
761
 
 end:
 
907
 fallback:
762
908
  
763
909
  if(process_list == NULL or exitstatus != EXIT_SUCCESS){
764
910
    /* Fallback if all plugins failed, none are found or an error occured */
769
915
    if(not bret){
770
916
      perror("print_out_password");
771
917
      exitstatus = EXIT_FAILURE;
772
 
      goto end;
773
918
    }
774
919
  }
775
920
  
776
921
  /* Restore old signal handler */
777
 
  sigaction(SIGCHLD, &old_sigchld_action, NULL);
778
 
  
779
 
  free(custom_argv);
780
 
  
781
 
  /* Free the plugin list */
782
 
  for(plugin *next; plugin_list != NULL; plugin_list = next){
783
 
    next = plugin_list->next;
784
 
    free(plugin_list->argv);
785
 
    free(plugin_list);
786
 
  }
 
922
  ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
 
923
  if(ret == -1){
 
924
    perror("sigaction");
 
925
    exitstatus = EXIT_FAILURE;
 
926
  }
 
927
 
 
928
  if(custom_argv != NULL){
 
929
    for(char **arg = custom_argv; *arg != NULL; arg++){
 
930
      free(*arg);
 
931
    }
 
932
    free(custom_argv);
 
933
  }
 
934
  free_plugin_list(plugin_list);
787
935
  
788
936
  if(dir != NULL){
789
937
    closedir(dir);