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
- browse files at revision 137
- compare with another revision
- download diff
- download tarball
- view history from revision 137
- Committer: Teddy Hogeborn
- Date: 2008-09-02 06:03:08 UTC
- Revision ID: teddy@fukt.bsnet.se-20080902060308-8uhgsfjiwixuvz6j
* plugin-runner.c (main/parse_opt): Removed code for "--config-file".
(main/parse_opt_config_file): New function only for "--config-file".
(main): Parse options first using "parse_opt_config_file", then from
the config file, and lastly from the command line.
(main/parse_opt_config_file): New function only for "--config-file".
(main): Parse options first using "parse_opt_config_file", then from
the config file, and lastly from the command line.
- files added:
- .bzrignore
- files modified:
- Makefile
added
removed
plugin-runner.c
72
72
const char *argp_program_version = "plugin-runner 1.0";
73
73
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
74
74
75
struct process;
76
77
typedef struct process{
75
struct plugin;
76
77
typedef struct plugin{
78
char *name; /* can be NULL or any plugin name */
79
char **argv;
80
int argc;
81
char **environ;
82
int envc;
83
bool disabled;
84
85
/* Variables used for running processes*/
78
86
pid_t pid;
79
87
int fd;
80
88
char *buffer;
83
91
bool eof;
84
92
volatile bool completed;
85
93
volatile int status;
86
struct process *next;
87
} process;
88
89
typedef struct plugin{
90
char *name; /* can be NULL or any plugin name */
91
char **argv;
92
int argc;
93
char **environ;
94
int envc;
95
bool disabled;
96
94
struct plugin *next;
97
95
} plugin;
98
96
99
static plugin *getplugin(char *name, plugin **plugin_list){
100
for (plugin *p = *plugin_list; p != NULL; p = p->next){
97
static plugin *plugin_list = NULL;
98
99
/* Gets a existing plugin based on name,
100
or if none is found, creates a new one */
101
static plugin *getplugin(char *name){
102
/* Check for exiting plugin with that name */
103
for (plugin *p = plugin_list; p != NULL; p = p->next){
101
104
if ((p->name == name)
102
105
or (p->name and name and (strcmp(p->name, name) == 0))){
103
106
return p;
115
118
return NULL;
116
119
}
117
120
}
118
121
119
122
*new_plugin = (plugin) { .name = copy_name,
120
123
.argc = 1,
121
.envc = 0,
122
124
.disabled = false,
123
.next = *plugin_list };
125
.next = plugin_list };
124
126
125
127
new_plugin->argv = malloc(sizeof(char *) * 2);
126
128
if (new_plugin->argv == NULL){
130
132
}
131
133
new_plugin->argv[0] = copy_name;
132
134
new_plugin->argv[1] = NULL;
133
135
134
136
new_plugin->environ = malloc(sizeof(char *));
135
137
if(new_plugin->environ == NULL){
136
138
free(copy_name);
139
141
return NULL;
140
142
}
141
143
new_plugin->environ[0] = NULL;
144
142
145
/* Append the new plugin to the list */
143
*plugin_list = new_plugin;
146
plugin_list = new_plugin;
144
147
return new_plugin;
145
148
}
146
149
176
179
}
177
180
178
181
/* Add to a plugin's environment */
179
static bool add_environment(plugin *p, const char *def){
182
static bool add_environment(plugin *p, const char *def, bool replace){
180
183
if(p == NULL){
181
184
return false;
182
185
}
186
/* namelen = length of name of environment variable */
187
size_t namelen = (size_t)(strchrnul(def, '=') - def);
188
/* Search for this environment variable */
189
for(char **e = p->environ; *e != NULL; e++){
190
if(strncmp(*e, def, namelen+1) == 0){
191
/* It already exists */
192
if(replace){
193
char *new = realloc(*e, strlen(def));
194
if(new == NULL){
195
return false;
196
}
197
*e = new;
198
strcpy(*e, def);
199
}
200
return true;
201
}
202
}
183
203
return add_to_char_array(def, &(p->environ), &(p->envc));
184
204
}
185
205
186
187
206
/*
188
207
* Based on the example in the GNU LibC manual chapter 13.13 "File
189
208
* Descriptor Flags".
200
219
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
201
220
}
202
221
203
process *process_list = NULL;
204
222
205
223
/* Mark processes as completed when they exit, and save their exit
206
224
status. */
207
225
void handle_sigchld(__attribute__((unused)) int sig){
208
226
while(true){
209
process *proc = process_list;
227
plugin *proc = plugin_list;
210
228
int status;
211
229
pid_t pid = waitpid(-1, &status, WNOHANG);
212
230
if(pid == 0){
234
252
}
235
253
}
236
254
255
/* Prints out a password to stdout */
237
256
bool print_out_password(const char *buffer, size_t length){
238
257
ssize_t ret;
239
258
if(length>0 and buffer[length-1] == '\n'){
249
268
return true;
250
269
}
251
270
252
static void free_plugin_list(plugin *plugin_list){
253
for(plugin *next; plugin_list != NULL; plugin_list = next){
254
next = plugin_list->next;
255
for(char **arg = plugin_list->argv; *arg != NULL; arg++){
256
free(*arg);
257
}
258
free(plugin_list->argv);
259
for(char **env = plugin_list->environ; *env != NULL; env++){
260
free(*env);
261
}
262
free(plugin_list->environ);
263
free(plugin_list);
271
/* Removes and free a plugin from the plugin list */
272
static void free_plugin(plugin *plugin_node){
273
274
for(char **arg = plugin_node->argv; *arg != NULL; arg++){
275
free(*arg);
276
}
277
free(plugin_node->argv);
278
for(char **env = plugin_node->environ; *env != NULL; env++){
279
free(*env);
280
}
281
free(plugin_node->environ);
282
free(plugin_node->buffer);
283
284
/* Removes the plugin from the singly-linked list */
285
if(plugin_node == plugin_list){
286
/* First one - simple */
287
plugin_list = plugin_list->next;
288
} else {
289
/* Second one or later */
290
for(plugin *p = plugin_list; p != NULL; p = p->next){
291
if(p->next == plugin_node){
292
p->next = plugin_node->next;
293
break;
294
}
295
}
296
}
297
298
free(plugin_node);
299
}
300
301
static void free_plugin_list(void){
302
while(plugin_list != NULL){
303
free_plugin(plugin_list);
264
304
}
265
305
}
266
306
304
344
{ .name = "global-options", .key = 'g',
305
345
.arg = "OPTION[,OPTION[,...]]",
306
346
.doc = "Options passed to all plugins" },
307
{ .name = "global-envs", .key = 'e',
347
{ .name = "global-env", .key = 'e',
308
348
.arg = "VAR=value",
309
349
.doc = "Environment variable passed to all plugins" },
310
350
{ .name = "options-for", .key = 'o',
311
351
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
312
352
.doc = "Options passed only to specified plugin" },
313
{ .name = "envs-for", .key = 'f',
353
{ .name = "env-for", .key = 'f',
314
354
.arg = "PLUGIN:ENV=value",
315
355
.doc = "Environment variable passed to specified plugin" },
316
356
{ .name = "disable", .key = 'd',
333
373
{ .name = NULL }
334
374
};
335
375
336
error_t parse_opt (int key, char *arg, struct argp_state *state) {
337
/* Get the INPUT argument from `argp_parse', which we know is a
338
pointer to our plugin list pointer. */
339
plugin **plugins = state->input;
376
error_t parse_opt (int key, char *arg, __attribute__((unused))
377
struct argp_state *state) {
340
378
switch (key) {
341
case 'g':
379
case 'g': /* --global-options */
342
380
if (arg != NULL){
343
381
char *p;
344
382
while((p = strsep(&arg, ",")) != NULL){
345
383
if(p[0] == '\0'){
346
384
continue;
347
385
}
348
if(not add_argument(getplugin(NULL, plugins), p)){
386
if(not add_argument(getplugin(NULL), p)){
349
387
perror("add_argument");
350
388
return ARGP_ERR_UNKNOWN;
351
389
}
352
390
}
353
391
}
354
392
break;
355
case 'e':
393
case 'e': /* --global-env */
356
394
if(arg == NULL){
357
395
break;
358
396
}
361
399
if(envdef == NULL){
362
400
break;
363
401
}
364
if(not add_environment(getplugin(NULL, plugins), envdef)){
402
if(not add_environment(getplugin(NULL), envdef, true)){
365
403
perror("add_environment");
366
404
}
367
405
}
368
406
break;
369
case 'o':
407
case 'o': /* --options-for */
370
408
if (arg != NULL){
371
409
char *p_name = strsep(&arg, ":");
372
410
if(p_name[0] == '\0'){
382
420
if(p[0] == '\0'){
383
421
continue;
384
422
}
385
if(not add_argument(getplugin(p_name, plugins), p)){
423
if(not add_argument(getplugin(p_name), p)){
386
424
perror("add_argument");
387
425
return ARGP_ERR_UNKNOWN;
388
426
}
390
428
}
391
429
}
392
430
break;
393
case 'f':
431
case 'f': /* --env-for */
394
432
if(arg == NULL){
395
433
break;
396
434
}
404
442
break;
405
443
}
406
444
envdef++;
407
if(not add_environment(getplugin(p_name, plugins), envdef)){
445
if(not add_environment(getplugin(p_name), envdef, true)){
408
446
perror("add_environment");
409
447
}
410
448
}
411
449
break;
412
case 'd':
450
case 'd': /* --disable */
413
451
if (arg != NULL){
414
plugin *p = getplugin(arg, plugins);
452
plugin *p = getplugin(arg);
415
453
if(p == NULL){
416
454
return ARGP_ERR_UNKNOWN;
417
455
}
418
456
p->disabled = true;
419
457
}
420
458
break;
421
case 128:
459
case 128: /* --plugin-dir */
422
460
plugindir = strdup(arg);
423
461
if(plugindir == NULL){
424
462
perror("strdup");
425
463
}
426
464
break;
427
case 129:
428
argfile = strdup(arg);
429
if(argfile == NULL){
430
perror("strdup");
431
}
432
break;
433
case 130:
465
case 129: /* --config-file */
466
/* This is already done by parse_opt_config_file() */
467
break;
468
case 130: /* --userid */
434
469
uid = (uid_t)strtol(arg, NULL, 10);
435
470
break;
436
case 131:
471
case 131: /* --groupid */
437
472
gid = (gid_t)strtol(arg, NULL, 10);
438
473
break;
439
case 132:
474
case 132: /* --debug */
440
475
debug = true;
441
476
break;
442
477
case ARGP_KEY_ARG:
450
485
return 0;
451
486
}
452
487
453
plugin *plugin_list = NULL;
488
/* This option parser is the same as parse_opt() above, except it
489
ignores everything but the --config-file option. */
490
error_t parse_opt_config_file (int key, char *arg,
491
__attribute__((unused))
492
struct argp_state *state) {
493
switch (key) {
494
case 'g': /* --global-options */
495
case 'e': /* --global-env */
496
case 'o': /* --options-for */
497
case 'f': /* --env-for */
498
case 'd': /* --disable */
499
case 128: /* --plugin-dir */
500
break;
501
case 129: /* --config-file */
502
argfile = strdup(arg);
503
if(argfile == NULL){
504
perror("strdup");
505
}
506
break;
507
case 130: /* --userid */
508
case 131: /* --groupid */
509
case 132: /* --debug */
510
case ARGP_KEY_ARG:
511
case ARGP_KEY_END:
512
break;
513
default:
514
return ARGP_ERR_UNKNOWN;
515
}
516
return 0;
517
}
454
518
455
struct argp argp = { .options = options, .parser = parse_opt,
456
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
519
struct argp argp = { .options = options,
520
.parser = parse_opt_config_file,
521
.args_doc = "",
457
522
.doc = "Mandos plugin runner -- Run plugins" };
458
523
459
ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
524
/* Parse using the parse_opt_config_file in order to get the custom
525
config file location, if any. */
526
ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
460
527
if (ret == ARGP_ERR_UNKNOWN){
461
528
fprintf(stderr, "Unknown error while parsing arguments\n");
462
529
exitstatus = EXIT_FAILURE;
463
530
goto fallback;
464
531
}
465
532
533
/* Reset to the normal argument parser */
534
argp.parser = parse_opt;
535
536
/* Open the configfile if available */
466
537
if (argfile == NULL){
467
538
conffp = fopen(AFILE, "r");
468
539
} else {
469
540
conffp = fopen(argfile, "r");
470
}
471
541
}
472
542
if(conffp != NULL){
473
543
char *org_line = NULL;
474
544
char *p, *arg, *new_arg, *line;
486
556
}
487
557
custom_argv[0] = argv[0];
488
558
custom_argv[1] = NULL;
489
559
560
/* for each line in the config file, strip whitespace and ignore
561
commented text */
490
562
while(true){
491
563
sret = getline(&org_line, &size, conffp);
492
564
if(sret == -1){
521
593
}
522
594
}
523
595
free(org_line);
524
} else{
596
} else {
525
597
/* Check for harmful errors and go to fallback. Other errors might
526
598
not affect opening plugins */
527
599
if (errno == EMFILE or errno == ENFILE or errno == ENOMEM){
530
602
goto fallback;
531
603
}
532
604
}
533
605
/* If there was any arguments from configuration file,
606
pass them to parser as command arguments */
534
607
if(custom_argv != NULL){
535
ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, &plugin_list);
608
ret = argp_parse (&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
609
0, NULL);
536
610
if (ret == ARGP_ERR_UNKNOWN){
537
611
fprintf(stderr, "Unknown error while parsing arguments\n");
538
612
exitstatus = EXIT_FAILURE;
540
614
}
541
615
}
542
616
617
/* Parse actual command line arguments, to let them override the
618
config file */
619
ret = argp_parse (&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
620
if (ret == ARGP_ERR_UNKNOWN){
621
fprintf(stderr, "Unknown error while parsing arguments\n");
622
exitstatus = EXIT_FAILURE;
623
goto fallback;
624
}
625
543
626
if(debug){
544
627
for(plugin *p = plugin_list; p != NULL; p=p->next){
545
628
fprintf(stderr, "Plugin: %s has %d arguments\n",
554
637
}
555
638
}
556
639
640
/* Strip permissions down to nobody */
557
641
ret = setuid(uid);
558
642
if (ret == -1){
559
643
perror("setuid");
560
}
561
644
}
562
645
setgid(gid);
563
646
if (ret == -1){
564
647
perror("setgid");
565
648
}
566
649
567
650
if (plugindir == NULL){
568
651
dir = opendir(PDIR);
569
652
} else {
591
674
592
675
FD_ZERO(&rfds_all);
593
676
677
/* Read and execute any executable in the plugin directory*/
594
678
while(true){
595
679
dirst = readdir(dir);
596
680
597
// All directory entries have been processed
681
/* All directory entries have been processed */
598
682
if(dirst == NULL){
599
683
if (errno == EBADF){
600
684
perror("readdir");
606
690
607
691
d_name_len = strlen(dirst->d_name);
608
692
609
// Ignore dotfiles, backup files and other junk
693
/* Ignore dotfiles, backup files and other junk */
610
694
{
611
695
bool bad_name = false;
612
696
627
711
break;
628
712
}
629
713
}
630
631
714
if(bad_name){
632
715
continue;
633
716
}
634
635
717
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
636
718
size_t suf_len = strlen(*suf);
637
719
if((d_name_len >= suf_len)
664
746
free(filename);
665
747
continue;
666
748
}
667
749
750
/* Ignore non-executable files */
668
751
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
669
752
if(debug){
670
753
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
673
756
free(filename);
674
757
continue;
675
758
}
676
plugin *p = getplugin(dirst->d_name, &plugin_list);
759
760
plugin *p = getplugin(dirst->d_name);
677
761
if(p == NULL){
678
762
perror("getplugin");
679
763
free(filename);
689
773
}
690
774
{
691
775
/* Add global arguments to argument list for this plugin */
692
plugin *g = getplugin(NULL, &plugin_list);
776
plugin *g = getplugin(NULL);
693
777
if(g != NULL){
694
778
for(char **a = g->argv + 1; *a != NULL; a++){
695
779
if(not add_argument(p, *a)){
698
782
}
699
783
/* Add global environment variables */
700
784
for(char **e = g->environ; *e != NULL; e++){
701
if(not add_environment(p, *e)){
785
if(not add_environment(p, *e, false)){
702
786
perror("add_environment");
703
787
}
704
788
}
709
793
process, too. */
710
794
if(p->environ[0] != NULL){
711
795
for(char **e = environ; *e != NULL; e++){
712
char *copy = strdup(*e);
713
if(copy == NULL){
714
perror("strdup");
715
continue;
716
}
717
if(not add_environment(p, copy)){
796
if(not add_environment(p, *e, false)){
718
797
perror("add_environment");
719
798
}
720
799
}
727
806
exitstatus = EXIT_FAILURE;
728
807
goto fallback;
729
808
}
809
/* Ask OS to automatic close the pipe on exec */
730
810
ret = set_cloexec_flag(pipefd[0]);
731
811
if(ret < 0){
732
812
perror("set_cloexec_flag");
746
826
exitstatus = EXIT_FAILURE;
747
827
goto fallback;
748
828
}
749
// Starting a new process to be watched
829
/* Starting a new process to be watched */
750
830
pid_t pid = fork();
751
831
if(pid == -1){
752
832
perror("fork");
790
870
}
791
871
/* no return */
792
872
}
793
/* parent process */
873
/* Parent process */
874
close(pipefd[1]); /* Close unused write end of pipe */
794
875
free(filename);
795
close(pipefd[1]); /* close unused write end of pipe */
796
process *new_process = malloc(sizeof(process));
797
if (new_process == NULL){
798
perror("malloc");
876
plugin *new_plugin = getplugin(dirst->d_name);
877
if (new_plugin == NULL){
878
perror("getplugin");
799
879
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
800
880
if(ret < 0){
801
perror("sigprocmask");
881
perror("sigprocmask");
802
882
}
803
883
exitstatus = EXIT_FAILURE;
804
884
goto fallback;
805
885
}
806
886
807
*new_process = (struct process){ .pid = pid,
808
.fd = pipefd[0],
809
.next = process_list };
810
// List handling
811
process_list = new_process;
887
new_plugin->pid = pid;
888
new_plugin->fd = pipefd[0];
889
812
890
/* Unblock SIGCHLD so signal handler can be run if this process
813
891
has already completed */
814
892
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
818
896
goto fallback;
819
897
}
820
898
821
FD_SET(new_process->fd, &rfds_all);
899
FD_SET(new_plugin->fd, &rfds_all);
822
900
823
if (maxfd < new_process->fd){
824
maxfd = new_process->fd;
901
if (maxfd < new_plugin->fd){
902
maxfd = new_plugin->fd;
825
903
}
826
904
827
905
}
828
829
free_plugin_list(plugin_list);
830
plugin_list = NULL;
831
906
832
907
closedir(dir);
833
908
dir = NULL;
834
835
if (process_list == NULL){
836
fprintf(stderr, "No plugin processes started. Incorrect plugin"
837
" directory?\n");
838
process_list = NULL;
909
910
for(plugin *p = plugin_list; p != NULL; p = p->next){
911
if(p->pid != 0){
912
break;
913
}
914
if(p->next == NULL){
915
fprintf(stderr, "No plugin processes started. Incorrect plugin"
916
" directory?\n");
917
free_plugin_list();
918
}
839
919
}
840
while(process_list){
920
921
/* Main loop while running plugins exist */
922
while(plugin_list){
841
923
fd_set rfds = rfds_all;
842
924
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
843
925
if (select_ret == -1){
847
929
}
848
930
/* OK, now either a process completed, or something can be read
849
931
from one of them */
850
for(process *proc = process_list; proc ; proc = proc->next){
932
for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
851
933
/* Is this process completely done? */
852
934
if(proc->eof and proc->completed){
853
935
/* Only accept the plugin output if it exited cleanly */
854
936
if(not WIFEXITED(proc->status)
855
937
or WEXITSTATUS(proc->status) != 0){
856
938
/* Bad exit by plugin */
939
857
940
if(debug){
858
941
if(WIFEXITED(proc->status)){
859
942
fprintf(stderr, "Plugin %u exited with status %d\n",
868
951
(unsigned int) (proc->pid));
869
952
}
870
953
}
954
871
955
/* Remove the plugin */
872
956
FD_CLR(proc->fd, &rfds_all);
957
873
958
/* Block signal while modifying process_list */
874
959
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
875
960
if(ret < 0){
877
962
exitstatus = EXIT_FAILURE;
878
963
goto fallback;
879
964
}
880
/* Delete this process entry from the list */
881
if(process_list == proc){
882
/* First one - simple */
883
process_list = proc->next;
884
} else {
885
/* Second one or later */
886
for(process *p = process_list; p != NULL; p = p->next){
887
if(p->next == proc){
888
p->next = proc->next;
889
break;
890
}
891
}
892
}
965
free_plugin(proc);
893
966
/* We are done modifying process list, so unblock signal */
894
967
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
895
968
NULL);
896
969
if(ret < 0){
897
970
perror("sigprocmask");
898
}
899
free(proc->buffer);
900
free(proc);
901
/* We deleted this process from the list, so we can't go
902
proc->next. Therefore, start over from the beginning of
903
the process list */
904
break;
971
exitstatus = EXIT_FAILURE;
972
goto fallback;
973
}
974
975
if(plugin_list == NULL){
976
break;
977
}
978
continue;
905
979
}
980
906
981
/* This process exited nicely, so print its buffer */
907
982
908
983
bool bret = print_out_password(proc->buffer,
913
988
}
914
989
goto fallback;
915
990
}
991
916
992
/* This process has not completed. Does it have any output? */
917
993
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
918
994
/* This process had nothing to say at this time */
948
1024
949
1025
fallback:
950
1026
951
if(process_list == NULL or exitstatus != EXIT_SUCCESS){
1027
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
952
1028
/* Fallback if all plugins failed, none are found or an error
953
1029
occured */
954
1030
bool bret;
974
1050
}
975
1051
free(custom_argv);
976
1052
}
977
free_plugin_list(plugin_list);
978
1053
979
1054
if(dir != NULL){
980
1055
closedir(dir);
981
1056
}
982
1057
983
1058
/* Free the process list and kill the processes */
984
for(process *next; process_list != NULL; process_list = next){
985
next = process_list->next;
986
close(process_list->fd);
987
ret = kill(process_list->pid, SIGTERM);
988
if(ret == -1 and errno != ESRCH){
989
/* set-uid proccesses migth not get closed */
990
perror("kill");
1059
for(plugin *p = plugin_list; p != NULL; p = p->next){
1060
if(p->pid != 0){
1061
close(p->fd);
1062
ret = kill(p->pid, SIGTERM);
1063
if(ret == -1 and errno != ESRCH){
1064
/* Set-uid proccesses might not get closed */
1065
perror("kill");
1066
}
991
1067
}
992
free(process_list->buffer);
993
free(process_list);
994
1068
}
995
1069
996
1070
/* Wait for any remaining child processes to terminate */
1001
1075
perror("wait");
1002
1076
}
1003
1077
1078
free_plugin_list();
1079
1004
1080
free(plugindir);
1005
1081
free(argfile);
1006
1082
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0