/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugin-runner.c

  • Committer: Teddy Hogeborn
  • Date: 2008-09-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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){
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
 
183
186
  return add_to_char_array(def, &(p->environ), &(p->envc));
184
187
}
185
188
 
186
 
 
187
189
/*
188
190
 * Based on the example in the GNU LibC manual chapter 13.13 "File
189
191
 * Descriptor Flags".
200
202
  return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
201
203
}
202
204
 
203
 
process *process_list = NULL;
204
205
 
205
206
/* Mark processes as completed when they exit, and save their exit
206
207
   status. */
207
208
void handle_sigchld(__attribute__((unused)) int sig){
208
209
  while(true){
209
 
    process *proc = process_list;
 
210
    plugin *proc = plugin_list;
210
211
    int status;
211
212
    pid_t pid = waitpid(-1, &status, WNOHANG);
212
213
    if(pid == 0){
234
235
  }
235
236
}
236
237
 
 
238
/* Prints out a password to stdout */
237
239
bool print_out_password(const char *buffer, size_t length){
238
240
  ssize_t ret;
239
241
  if(length>0 and buffer[length-1] == '\n'){
249
251
  return true;
250
252
}
251
253
 
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);
 
254
/* Removes and free a plugin from the plugin list */
 
255
static void free_plugin(plugin *plugin_node){
 
256
  
 
257
  for(char **arg = plugin_node->argv; *arg != NULL; arg++){
 
258
    free(*arg);
 
259
  }
 
260
  free(plugin_node->argv);
 
261
  for(char **env = plugin_node->environ; *env != NULL; env++){
 
262
    free(*env);
 
263
  }
 
264
  free(plugin_node->environ);
 
265
  free(plugin_node->buffer);
 
266
 
 
267
  /* Removes the plugin from the singly-linked list */
 
268
  if(plugin_node == plugin_list){
 
269
    /* First one - simple */
 
270
    plugin_list = plugin_list->next;
 
271
  } else {
 
272
    /* Second one or later */
 
273
    for(plugin *p = plugin_list; p != NULL; p = p->next){
 
274
      if(p->next == plugin_node){
 
275
        p->next = plugin_node->next;
 
276
        break;
 
277
      }
 
278
    }
 
279
  }
 
280
  
 
281
  free(plugin_node);
 
282
}
 
283
 
 
284
static void free_plugin_list(void){
 
285
  while(plugin_list != NULL){
 
286
    free_plugin(plugin_list);
264
287
  }
265
288
}
266
289
 
333
356
    { .name = NULL }
334
357
  };
335
358
  
336
 
  error_t parse_opt (int key, char *arg, struct argp_state *state) {
 
359
  error_t parse_opt (int key, char *arg, __attribute__((unused))
 
360
                     struct argp_state *state) {
337
361
    /* Get the INPUT argument from `argp_parse', which we know is a
338
362
       pointer to our plugin list pointer. */
339
 
    plugin **plugins = state->input;
340
363
    switch (key) {
341
 
    case 'g':
 
364
    case 'g':                   /* --global-options */
342
365
      if (arg != NULL){
343
366
        char *p;
344
367
        while((p = strsep(&arg, ",")) != NULL){
345
368
          if(p[0] == '\0'){
346
369
            continue;
347
370
          }
348
 
          if(not add_argument(getplugin(NULL, plugins), p)){
 
371
          if(not add_argument(getplugin(NULL), p)){
349
372
            perror("add_argument");
350
373
            return ARGP_ERR_UNKNOWN;
351
374
          }
352
375
        }
353
376
      }
354
377
      break;
355
 
    case 'e':
 
378
    case 'e':                   /* --global-envs */
356
379
      if(arg == NULL){
357
380
        break;
358
381
      }
361
384
        if(envdef == NULL){
362
385
          break;
363
386
        }
364
 
        if(not add_environment(getplugin(NULL, plugins), envdef)){
 
387
        if(not add_environment(getplugin(NULL), envdef)){
365
388
          perror("add_environment");
366
389
        }
367
390
      }
368
391
      break;
369
 
    case 'o':
 
392
    case 'o':                   /* --options-for */
370
393
      if (arg != NULL){
371
394
        char *p_name = strsep(&arg, ":");
372
395
        if(p_name[0] == '\0'){
382
405
            if(p[0] == '\0'){
383
406
              continue;
384
407
            }
385
 
            if(not add_argument(getplugin(p_name, plugins), p)){
 
408
            if(not add_argument(getplugin(p_name), p)){
386
409
              perror("add_argument");
387
410
              return ARGP_ERR_UNKNOWN;
388
411
            }
390
413
        }
391
414
      }
392
415
      break;
393
 
    case 'f':
 
416
    case 'f':                   /* --envs-for */
394
417
      if(arg == NULL){
395
418
        break;
396
419
      }
404
427
          break;
405
428
        }
406
429
        envdef++;
407
 
        if(not add_environment(getplugin(p_name, plugins), envdef)){
 
430
        if(not add_environment(getplugin(p_name), envdef)){
408
431
          perror("add_environment");
409
432
        }
410
433
      }
411
434
      break;
412
 
    case 'd':
 
435
    case 'd':                   /* --disable */
413
436
      if (arg != NULL){
414
 
        plugin *p = getplugin(arg, plugins);
 
437
        plugin *p = getplugin(arg);
415
438
        if(p == NULL){
416
439
          return ARGP_ERR_UNKNOWN;
417
440
        }
418
441
        p->disabled = true;
419
442
      }
420
443
      break;
421
 
    case 128:
 
444
    case 128:                   /* --plugin-dir */
422
445
      plugindir = strdup(arg);
423
446
      if(plugindir == NULL){
424
447
        perror("strdup");
425
448
      }      
426
449
      break;
427
 
    case 129:
 
450
    case 129:                   /* --config-file */
428
451
      argfile = strdup(arg);
429
452
      if(argfile == NULL){
430
453
        perror("strdup");
431
454
      }
432
455
      break;      
433
 
    case 130:
 
456
    case 130:                   /* --userid */
434
457
      uid = (uid_t)strtol(arg, NULL, 10);
435
458
      break;
436
 
    case 131:
 
459
    case 131:                   /* --groupid */
437
460
      gid = (gid_t)strtol(arg, NULL, 10);
438
461
      break;
439
 
    case 132:
 
462
    case 132:                   /* --debug */
440
463
      debug = true;
441
464
      break;
442
465
    case ARGP_KEY_ARG:
450
473
    return 0;
451
474
  }
452
475
  
453
 
  plugin *plugin_list = NULL;
454
 
  
455
476
  struct argp argp = { .options = options, .parser = parse_opt,
456
477
                       .args_doc = "[+PLUS_SEPARATED_OPTIONS]",
457
478
                       .doc = "Mandos plugin runner -- Run plugins" };
458
479
  
459
 
  ret = argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
 
480
  ret = argp_parse (&argp, argc, argv, 0, 0, NULL);
460
481
  if (ret == ARGP_ERR_UNKNOWN){
461
482
    fprintf(stderr, "Unknown error while parsing arguments\n");
462
483
    exitstatus = EXIT_FAILURE;
463
484
    goto fallback;
464
485
  }
465
486
 
 
487
  /* Opens the configfile if aviable */
466
488
  if (argfile == NULL){
467
489
    conffp = fopen(AFILE, "r");
468
490
  } else {
469
491
    conffp = fopen(argfile, "r");
470
 
  }
471
 
  
 
492
  }  
472
493
  if(conffp != NULL){
473
494
    char *org_line = NULL;
474
495
    char *p, *arg, *new_arg, *line;
486
507
    }
487
508
    custom_argv[0] = argv[0];
488
509
    custom_argv[1] = NULL;
489
 
    
 
510
 
 
511
    /* for each line in the config file, strip whitespace and ignore
 
512
       commented text */
490
513
    while(true){
491
514
      sret = getline(&org_line, &size, conffp);
492
515
      if(sret == -1){
530
553
      goto fallback;
531
554
    }
532
555
  }
533
 
 
 
556
  /* If there was any arguments from configuration file,
 
557
     pass them to parser as command arguments */
534
558
  if(custom_argv != NULL){
535
 
    ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, &plugin_list);
 
559
    ret = argp_parse (&argp, custom_argc, custom_argv, 0, 0, NULL);
536
560
    if (ret == ARGP_ERR_UNKNOWN){
537
561
      fprintf(stderr, "Unknown error while parsing arguments\n");
538
562
      exitstatus = EXIT_FAILURE;
553
577
      }
554
578
    }
555
579
  }
556
 
  
 
580
 
 
581
  /* Strip permissions down to nobody */
557
582
  ret = setuid(uid);
558
583
  if (ret == -1){
559
584
    perror("setuid");
560
 
  }
561
 
  
 
585
  }  
562
586
  setgid(gid);
563
587
  if (ret == -1){
564
588
    perror("setgid");
590
614
  }
591
615
  
592
616
  FD_ZERO(&rfds_all);
593
 
  
 
617
 
 
618
  /* Read and execute any executable in the plugin directory*/
594
619
  while(true){
595
620
    dirst = readdir(dir);
596
621
    
627
652
          break;
628
653
        }
629
654
      }
630
 
      
631
655
      if(bad_name){
632
656
        continue;
633
657
      }
634
 
      
635
658
      for(const char **suf = bad_suffixes; *suf != NULL; suf++){
636
659
        size_t suf_len = strlen(*suf);
637
660
        if((d_name_len >= suf_len)
664
687
      free(filename);
665
688
      continue;
666
689
    }
667
 
    
 
690
 
 
691
    /* Ignore non-executable files */
668
692
    if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
669
693
      if(debug){
670
694
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
673
697
      free(filename);
674
698
      continue;
675
699
    }
676
 
    plugin *p = getplugin(dirst->d_name, &plugin_list);
 
700
    
 
701
    plugin *p = getplugin(dirst->d_name);
677
702
    if(p == NULL){
678
703
      perror("getplugin");
679
704
      free(filename);
689
714
    }
690
715
    {
691
716
      /* Add global arguments to argument list for this plugin */
692
 
      plugin *g = getplugin(NULL, &plugin_list);
 
717
      plugin *g = getplugin(NULL);
693
718
      if(g != NULL){
694
719
        for(char **a = g->argv + 1; *a != NULL; a++){
695
720
          if(not add_argument(p, *a)){
727
752
      exitstatus = EXIT_FAILURE;
728
753
      goto fallback;
729
754
    }
 
755
    /* Ask OS to automatic close the pipe on exec */
730
756
    ret = set_cloexec_flag(pipefd[0]);
731
757
    if(ret < 0){
732
758
      perror("set_cloexec_flag");
790
816
      }
791
817
      /* no return */
792
818
    }
793
 
    /* parent process */
 
819
    /* Parent process */
 
820
    close(pipefd[1]);           /* Close unused write end of pipe */
794
821
    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");
 
822
    plugin *new_plugin = getplugin(dirst->d_name);
 
823
    if (new_plugin == NULL){
 
824
      perror("getplugin");
799
825
      ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
800
826
      if(ret < 0){
801
 
        perror("sigprocmask");
 
827
        perror("sigprocmask");
802
828
      }
803
829
      exitstatus = EXIT_FAILURE;
804
830
      goto fallback;
805
831
    }
806
832
    
807
 
    *new_process = (struct process){ .pid = pid,
808
 
                                     .fd = pipefd[0],
809
 
                                     .next = process_list };
810
 
    // List handling
811
 
    process_list = new_process;
 
833
    new_plugin->pid = pid;
 
834
    new_plugin->fd = pipefd[0];
 
835
    
812
836
    /* Unblock SIGCHLD so signal handler can be run if this process
813
837
       has already completed */
814
838
    ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
818
842
      goto fallback;
819
843
    }
820
844
    
821
 
    FD_SET(new_process->fd, &rfds_all);
 
845
    FD_SET(new_plugin->fd, &rfds_all);
822
846
    
823
 
    if (maxfd < new_process->fd){
824
 
      maxfd = new_process->fd;
 
847
    if (maxfd < new_plugin->fd){
 
848
      maxfd = new_plugin->fd;
825
849
    }
826
850
    
827
851
  }
828
 
 
829
 
  free_plugin_list(plugin_list);
830
 
  plugin_list = NULL;
831
852
  
832
853
  closedir(dir);
833
854
  dir = NULL;
834
 
    
835
 
  if (process_list == NULL){
836
 
    fprintf(stderr, "No plugin processes started. Incorrect plugin"
837
 
            " directory?\n");
838
 
    process_list = NULL;
 
855
 
 
856
  for(plugin *p = plugin_list; p != NULL; p = p->next){
 
857
    if(p->pid != 0){
 
858
      break;
 
859
    }
 
860
    if(p->next == NULL){
 
861
      fprintf(stderr, "No plugin processes started. Incorrect plugin"
 
862
              " directory?\n");
 
863
      free_plugin_list();
 
864
    }
839
865
  }
840
 
  while(process_list){
 
866
 
 
867
  /* Main loop while running plugins exist */
 
868
  while(plugin_list){
841
869
    fd_set rfds = rfds_all;
842
870
    int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
843
871
    if (select_ret == -1){
847
875
    }
848
876
    /* OK, now either a process completed, or something can be read
849
877
       from one of them */
850
 
    for(process *proc = process_list; proc ; proc = proc->next){
 
878
    for(plugin *proc = plugin_list; proc != NULL; proc = proc->next){
851
879
      /* Is this process completely done? */
852
880
      if(proc->eof and proc->completed){
853
881
        /* Only accept the plugin output if it exited cleanly */
854
882
        if(not WIFEXITED(proc->status)
855
883
           or WEXITSTATUS(proc->status) != 0){
856
884
          /* Bad exit by plugin */
 
885
 
857
886
          if(debug){
858
887
            if(WIFEXITED(proc->status)){
859
888
              fprintf(stderr, "Plugin %u exited with status %d\n",
868
897
                      (unsigned int) (proc->pid));
869
898
            }
870
899
          }
 
900
          
871
901
          /* Remove the plugin */
872
902
          FD_CLR(proc->fd, &rfds_all);
 
903
 
873
904
          /* Block signal while modifying process_list */
874
905
          ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
875
906
          if(ret < 0){
877
908
            exitstatus = EXIT_FAILURE;
878
909
            goto fallback;
879
910
          }
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
 
          }
 
911
          free_plugin(proc);
893
912
          /* We are done modifying process list, so unblock signal */
894
913
          ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
895
914
                             NULL);
896
915
          if(ret < 0){
897
916
            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;
 
917
            exitstatus = EXIT_FAILURE;
 
918
            goto fallback;
 
919
          }
 
920
          
 
921
          if(plugin_list == NULL){
 
922
            break;
 
923
          }
 
924
          continue;
905
925
        }
 
926
        
906
927
        /* This process exited nicely, so print its buffer */
907
928
 
908
929
        bool bret = print_out_password(proc->buffer,
913
934
        }
914
935
        goto fallback;
915
936
      }
 
937
      
916
938
      /* This process has not completed.  Does it have any output? */
917
939
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
918
940
        /* This process had nothing to say at this time */
948
970
 
949
971
 fallback:
950
972
  
951
 
  if(process_list == NULL or exitstatus != EXIT_SUCCESS){
 
973
  if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
952
974
    /* Fallback if all plugins failed, none are found or an error
953
975
       occured */
954
976
    bool bret;
974
996
    }
975
997
    free(custom_argv);
976
998
  }
977
 
  free_plugin_list(plugin_list);
978
999
  
979
1000
  if(dir != NULL){
980
1001
    closedir(dir);
981
1002
  }
982
1003
  
983
1004
  /* 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");
 
1005
  for(plugin *p = plugin_list; p != NULL; p = p->next){
 
1006
    if(p->pid != 0){
 
1007
      close(p->fd);
 
1008
      ret = kill(p->pid, SIGTERM);
 
1009
      if(ret == -1 and errno != ESRCH){
 
1010
        /* Set-uid proccesses might not get closed */
 
1011
        perror("kill");
 
1012
      }
991
1013
    }
992
 
    free(process_list->buffer);
993
 
    free(process_list);
994
1014
  }
995
1015
  
996
1016
  /* Wait for any remaining child processes to terminate */
1001
1021
    perror("wait");
1002
1022
  }
1003
1023
 
 
1024
  free_plugin_list();
 
1025
  
1004
1026
  free(plugindir);
1005
1027
  free(argfile);
1006
1028