/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: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.c
2
2
/*
3
3
 * Mandos plugin runner - Run Mandos plugins
4
4
 *
5
 
 * Copyright © 2008-2010 Teddy Hogeborn
6
 
 * Copyright © 2008-2010 Björn Påhlsson
7
 
 * 
8
 
 * This program is free software: you can redistribute it and/or
9
 
 * modify it under the terms of the GNU General Public License as
10
 
 * published by the Free Software Foundation, either version 3 of the
11
 
 * License, or (at your option) any later version.
12
 
 * 
13
 
 * This program is distributed in the hope that it will be useful, but
 
5
 * Copyright © 2008-2018 Teddy Hogeborn
 
6
 * Copyright © 2008-2018 Björn Påhlsson
 
7
 * 
 
8
 * This file is part of Mandos.
 
9
 * 
 
10
 * Mandos is free software: you can redistribute it and/or modify it
 
11
 * under the terms of the GNU General Public License as published by
 
12
 * the Free Software Foundation, either version 3 of the License, or
 
13
 * (at your option) any later version.
 
14
 * 
 
15
 * Mandos is distributed in the hope that it will be useful, but
14
16
 * WITHOUT ANY WARRANTY; without even the implied warranty of
15
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16
18
 * General Public License for more details.
17
19
 * 
18
20
 * You should have received a copy of the GNU General Public License
19
 
 * along with this program.  If not, see
20
 
 * <http://www.gnu.org/licenses/>.
 
21
 * along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
21
22
 * 
22
 
 * Contact the authors at <mandos@fukt.bsnet.se>.
 
23
 * Contact the authors at <mandos@recompile.se>.
23
24
 */
24
25
 
25
26
#define _GNU_SOURCE             /* TEMP_FAILURE_RETRY(), getline(),
26
 
                                   asprintf(), O_CLOEXEC */
 
27
                                   O_CLOEXEC, pipe2() */
27
28
#include <stddef.h>             /* size_t, NULL */
28
29
#include <stdlib.h>             /* malloc(), exit(), EXIT_SUCCESS,
29
30
                                   realloc() */
30
31
#include <stdbool.h>            /* bool, true, false */
31
32
#include <stdio.h>              /* fileno(), fprintf(),
32
 
                                   stderr, STDOUT_FILENO */
33
 
#include <sys/types.h>          /* DIR, fdopendir(), stat(), struct
34
 
                                   stat, waitpid(), WIFEXITED(),
35
 
                                   WEXITSTATUS(), wait(), pid_t,
36
 
                                   uid_t, gid_t, getuid(), getgid(),
37
 
                                   dirfd() */
 
33
                                   stderr, STDOUT_FILENO, fclose() */
 
34
#include <sys/types.h>          /* fstat(), struct stat, waitpid(),
 
35
                                   WIFEXITED(), WEXITSTATUS(), wait(),
 
36
                                   pid_t, uid_t, gid_t, getuid(),
 
37
                                   getgid() */
38
38
#include <sys/select.h>         /* fd_set, select(), FD_ZERO(),
39
39
                                   FD_SET(), FD_ISSET(), FD_CLR */
40
40
#include <sys/wait.h>           /* wait(), waitpid(), WIFEXITED(),
41
 
                                   WEXITSTATUS(), WTERMSIG(),
42
 
                                   WCOREDUMP() */
43
 
#include <sys/stat.h>           /* struct stat, stat(), S_ISREG() */
 
41
                                   WEXITSTATUS(), WTERMSIG() */
 
42
#include <sys/stat.h>           /* struct stat, fstat(), S_ISREG() */
44
43
#include <iso646.h>             /* and, or, not */
45
 
#include <dirent.h>             /* DIR, struct dirent, fdopendir(),
46
 
                                   readdir(), closedir(), dirfd() */
47
 
#include <unistd.h>             /* struct stat, stat(), S_ISREG(),
48
 
                                   fcntl(), setuid(), setgid(),
49
 
                                   F_GETFD, F_SETFD, FD_CLOEXEC,
50
 
                                   access(), pipe(), fork(), close()
51
 
                                   dup2(), STDOUT_FILENO, _exit(),
52
 
                                   execv(), write(), read(),
53
 
                                   close() */
 
44
#include <dirent.h>             /* struct dirent, scandirat() */
 
45
#include <unistd.h>             /* fcntl(), F_GETFD, F_SETFD,
 
46
                                   FD_CLOEXEC, write(), STDOUT_FILENO,
 
47
                                   struct stat, fstat(), close(),
 
48
                                   setgid(), setuid(), S_ISREG(),
 
49
                                   faccessat() pipe2(), fork(),
 
50
                                   _exit(), dup2(), fexecve(), read()
 
51
                                */
54
52
#include <fcntl.h>              /* fcntl(), F_GETFD, F_SETFD,
55
 
                                   FD_CLOEXEC */
56
 
#include <string.h>             /* strsep, strlen(), asprintf(),
57
 
                                   strsignal(), strcmp(), strncmp() */
 
53
                                   FD_CLOEXEC, openat(), scandirat(),
 
54
                                   pipe2() */
 
55
#include <string.h>             /* strsep, strlen(), strsignal(),
 
56
                                   strcmp(), strncmp() */
58
57
#include <errno.h>              /* errno */
59
58
#include <argp.h>               /* struct argp_option, struct
60
59
                                   argp_state, struct argp,
72
71
                                   EX_CONFIG, EX_UNAVAILABLE, EX_OK */
73
72
#include <errno.h>              /* errno */
74
73
#include <error.h>              /* error() */
 
74
#include <fnmatch.h>            /* fnmatch() */
75
75
 
76
76
#define BUFFER_SIZE 256
77
77
 
78
78
#define PDIR "/lib/mandos/plugins.d"
 
79
#define PHDIR "/lib/mandos/plugin-helpers"
79
80
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
80
81
 
81
82
const char *argp_program_version = "plugin-runner " VERSION;
82
 
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
 
83
const char *argp_program_bug_address = "<mandos@recompile.se>";
83
84
 
84
85
typedef struct plugin{
85
86
  char *name;                   /* can be NULL or any plugin name */
105
106
 
106
107
/* Gets an existing plugin based on name,
107
108
   or if none is found, creates a new one */
 
109
__attribute__((warn_unused_result))
108
110
static plugin *getplugin(char *name){
109
111
  /* Check for existing plugin with that name */
110
112
  for(plugin *p = plugin_list; p != NULL; p = p->next){
171
173
}
172
174
 
173
175
/* Helper function for add_argument and add_environment */
 
176
__attribute__((nonnull, warn_unused_result))
174
177
static bool add_to_char_array(const char *new, char ***array,
175
178
                              int *len){
176
179
  /* Resize the pointed-to array to hold one more pointer */
 
180
  char **new_array = NULL;
177
181
  do {
178
 
    *array = realloc(*array, sizeof(char *)
179
 
                     * (size_t) ((*len) + 2));
180
 
  } while(*array == NULL and errno == EINTR);
 
182
    new_array = realloc(*array, sizeof(char *)
 
183
                        * (size_t) ((*len) + 2));
 
184
  } while(new_array == NULL and errno == EINTR);
181
185
  /* Malloc check */
182
 
  if(*array == NULL){
 
186
  if(new_array == NULL){
183
187
    return false;
184
188
  }
 
189
  *array = new_array;
185
190
  /* Make a copy of the new string */
186
191
  char *copy;
187
192
  do {
199
204
}
200
205
 
201
206
/* Add to a plugin's argument vector */
 
207
__attribute__((nonnull(2), warn_unused_result))
202
208
static bool add_argument(plugin *p, const char *arg){
203
209
  if(p == NULL){
204
210
    return false;
207
213
}
208
214
 
209
215
/* Add to a plugin's environment */
 
216
__attribute__((nonnull(2), warn_unused_result))
210
217
static bool add_environment(plugin *p, const char *def, bool replace){
211
218
  if(p == NULL){
212
219
    return false;
214
221
  /* namelen = length of name of environment variable */
215
222
  size_t namelen = (size_t)(strchrnul(def, '=') - def);
216
223
  /* Search for this environment variable */
217
 
  for(char **e = p->environ; *e != NULL; e++){
218
 
    if(strncmp(*e, def, namelen + 1) == 0){
 
224
  for(char **envdef = p->environ; *envdef != NULL; envdef++){
 
225
    if(strncmp(*envdef, def, namelen + 1) == 0){
219
226
      /* It already exists */
220
227
      if(replace){
221
 
        char *new;
 
228
        char *new_envdef;
222
229
        do {
223
 
          new = realloc(*e, strlen(def) + 1);
224
 
        } while(new == NULL and errno == EINTR);
225
 
        if(new == NULL){
 
230
          new_envdef = realloc(*envdef, strlen(def) + 1);
 
231
        } while(new_envdef == NULL and errno == EINTR);
 
232
        if(new_envdef == NULL){
226
233
          return false;
227
234
        }
228
 
        *e = new;
229
 
        strcpy(*e, def);
 
235
        *envdef = new_envdef;
 
236
        strcpy(*envdef, def);
230
237
      }
231
238
      return true;
232
239
    }
234
241
  return add_to_char_array(def, &(p->environ), &(p->envc));
235
242
}
236
243
 
 
244
#ifndef O_CLOEXEC
237
245
/*
238
246
 * Based on the example in the GNU LibC manual chapter 13.13 "File
239
247
 * Descriptor Flags".
240
248
 | [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
241
249
 */
 
250
__attribute__((warn_unused_result))
242
251
static int set_cloexec_flag(int fd){
243
252
  int ret = (int)TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD, 0));
244
253
  /* If reading the flags failed, return error indication now. */
249
258
  return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
250
259
                                       ret | FD_CLOEXEC));
251
260
}
 
261
#endif  /* not O_CLOEXEC */
252
262
 
253
263
 
254
264
/* Mark processes as completed when they exit, and save their exit
286
296
}
287
297
 
288
298
/* Prints out a password to stdout */
 
299
__attribute__((nonnull, warn_unused_result))
289
300
static bool print_out_password(const char *buffer, size_t length){
290
301
  ssize_t ret;
291
302
  for(size_t written = 0; written < length; written += (size_t)ret){
299
310
}
300
311
 
301
312
/* Removes and free a plugin from the plugin list */
 
313
__attribute__((nonnull))
302
314
static void free_plugin(plugin *plugin_node){
303
315
  
304
 
  for(char **arg = plugin_node->argv; *arg != NULL; arg++){
 
316
  for(char **arg = (plugin_node->argv)+1; *arg != NULL; arg++){
305
317
    free(*arg);
306
318
  }
 
319
  free(plugin_node->name);
307
320
  free(plugin_node->argv);
308
321
  for(char **env = plugin_node->environ; *env != NULL; env++){
309
322
    free(*env);
336
349
 
337
350
int main(int argc, char *argv[]){
338
351
  char *plugindir = NULL;
 
352
  char *pluginhelperdir = NULL;
339
353
  char *argfile = NULL;
340
354
  FILE *conffp;
341
 
  size_t d_name_len;
342
 
  DIR *dir = NULL;
343
 
  struct dirent *dirst;
 
355
  struct dirent **direntries = NULL;
344
356
  struct stat st;
345
357
  fd_set rfds_all;
346
358
  int ret, maxfd = 0;
354
366
                                      .sa_flags = SA_NOCLDSTOP };
355
367
  char **custom_argv = NULL;
356
368
  int custom_argc = 0;
 
369
  int dir_fd = -1;
357
370
  
358
371
  /* Establish a signal handler */
359
372
  sigemptyset(&sigchld_action.sa_mask);
404
417
      .doc = "Group ID the plugins will run as", .group = 3 },
405
418
    { .name = "debug", .key = 132,
406
419
      .doc = "Debug mode", .group = 4 },
 
420
    { .name = "plugin-helper-dir", .key = 133,
 
421
      .arg = "DIRECTORY",
 
422
      .doc = "Specify a different plugin helper directory",
 
423
      .group = 2 },
407
424
    /*
408
425
     * These reproduce what we would get without ARGP_NO_HELP
409
426
     */
416
433
    { .name = NULL }
417
434
  };
418
435
  
 
436
  __attribute__((nonnull(3)))
419
437
  error_t parse_opt(int key, char *arg, struct argp_state *state){
420
438
    errno = 0;
421
439
    switch(key){
422
440
      char *tmp;
423
 
      intmax_t tmpmax;
 
441
      intmax_t tmp_id;
424
442
    case 'g':                   /* --global-options */
425
443
      {
426
444
        char *plugin_option;
429
447
            break;
430
448
          }
431
449
        }
 
450
        errno = 0;
432
451
      }
433
452
      break;
434
453
    case 'G':                   /* --global-env */
435
 
      add_environment(getplugin(NULL), arg, true);
 
454
      if(add_environment(getplugin(NULL), arg, true)){
 
455
        errno = 0;
 
456
      }
436
457
      break;
437
458
    case 'o':                   /* --options-for */
438
459
      {
455
476
            break;
456
477
          }
457
478
        }
 
479
        errno = 0;
458
480
      }
459
481
      break;
460
482
    case 'E':                   /* --env-for */
472
494
          errno = EINVAL;
473
495
          break;
474
496
        }
475
 
        add_environment(getplugin(arg), envdef, true);
 
497
        if(add_environment(getplugin(arg), envdef, true)){
 
498
          errno = 0;
 
499
        }
476
500
      }
477
501
      break;
478
502
    case 'd':                   /* --disable */
480
504
        plugin *p = getplugin(arg);
481
505
        if(p != NULL){
482
506
          p->disabled = true;
 
507
          errno = 0;
483
508
        }
484
509
      }
485
510
      break;
488
513
        plugin *p = getplugin(arg);
489
514
        if(p != NULL){
490
515
          p->disabled = false;
 
516
          errno = 0;
491
517
        }
492
518
      }
493
519
      break;
494
520
    case 128:                   /* --plugin-dir */
495
521
      free(plugindir);
496
522
      plugindir = strdup(arg);
 
523
      if(plugindir != NULL){
 
524
        errno = 0;
 
525
      }
497
526
      break;
498
527
    case 129:                   /* --config-file */
499
528
      /* This is already done by parse_opt_config_file() */
500
529
      break;
501
530
    case 130:                   /* --userid */
502
 
      tmpmax = strtoimax(arg, &tmp, 10);
 
531
      tmp_id = strtoimax(arg, &tmp, 10);
503
532
      if(errno != 0 or tmp == arg or *tmp != '\0'
504
 
         or tmpmax != (uid_t)tmpmax){
 
533
         or tmp_id != (uid_t)tmp_id){
505
534
        argp_error(state, "Bad user ID number: \"%s\", using %"
506
535
                   PRIdMAX, arg, (intmax_t)uid);
507
536
        break;
508
537
      }
509
 
      uid = (uid_t)tmpmax;
 
538
      uid = (uid_t)tmp_id;
 
539
      errno = 0;
510
540
      break;
511
541
    case 131:                   /* --groupid */
512
 
      tmpmax = strtoimax(arg, &tmp, 10);
 
542
      tmp_id = strtoimax(arg, &tmp, 10);
513
543
      if(errno != 0 or tmp == arg or *tmp != '\0'
514
 
         or tmpmax != (gid_t)tmpmax){
 
544
         or tmp_id != (gid_t)tmp_id){
515
545
        argp_error(state, "Bad group ID number: \"%s\", using %"
516
546
                   PRIdMAX, arg, (intmax_t)gid);
517
547
        break;
518
548
      }
519
 
      gid = (gid_t)tmpmax;
 
549
      gid = (gid_t)tmp_id;
 
550
      errno = 0;
520
551
      break;
521
552
    case 132:                   /* --debug */
522
553
      debug = true;
523
554
      break;
 
555
    case 133:                   /* --plugin-helper-dir */
 
556
      free(pluginhelperdir);
 
557
      pluginhelperdir = strdup(arg);
 
558
      if(pluginhelperdir != NULL){
 
559
        errno = 0;
 
560
      }
 
561
      break;
524
562
      /*
525
563
       * These reproduce what we would get without ARGP_NO_HELP
526
564
       */
527
565
    case '?':                   /* --help */
528
566
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
529
567
      argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
 
568
      __builtin_unreachable();
530
569
    case -3:                    /* --usage */
531
570
      state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
532
571
      argp_state_help(state, state->out_stream,
533
572
                      ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
 
573
      __builtin_unreachable();
534
574
    case 'V':                   /* --version */
535
575
      fprintf(state->out_stream, "%s\n", argp_program_version);
536
576
      exit(EXIT_SUCCESS);
546
586
      if(arg[0] == '\0'){
547
587
        break;
548
588
      }
 
589
#if __GNUC__ >= 7
 
590
      __attribute__((fallthrough));
 
591
#else
 
592
          /* FALLTHROUGH */
 
593
#endif
549
594
    default:
550
595
      return ARGP_ERR_UNKNOWN;
551
596
    }
570
615
    case 129:                   /* --config-file */
571
616
      free(argfile);
572
617
      argfile = strdup(arg);
 
618
      if(argfile != NULL){
 
619
        errno = 0;
 
620
      }
573
621
      break;
574
622
    case 130:                   /* --userid */
575
623
    case 131:                   /* --groupid */
576
624
    case 132:                   /* --debug */
 
625
    case 133:                   /* --plugin-helper-dir */
577
626
    case '?':                   /* --help */
578
627
    case -3:                    /* --usage */
579
628
    case 'V':                   /* --version */
658
707
        }
659
708
        
660
709
        custom_argc += 1;
661
 
        custom_argv = realloc(custom_argv, sizeof(char *)
662
 
                              * ((unsigned int) custom_argc + 1));
663
 
        if(custom_argv == NULL){
664
 
          error(0, errno, "realloc");
665
 
          exitstatus = EX_OSERR;
666
 
          free(org_line);
667
 
          goto fallback;
 
710
        {
 
711
          char **new_argv = realloc(custom_argv, sizeof(char *)
 
712
                                    * ((size_t)custom_argc + 1));
 
713
          if(new_argv == NULL){
 
714
            error(0, errno, "realloc");
 
715
            exitstatus = EX_OSERR;
 
716
            free(new_arg);
 
717
            free(org_line);
 
718
            goto fallback;
 
719
          } else {
 
720
            custom_argv = new_argv;
 
721
          }
668
722
        }
669
723
        custom_argv[custom_argc-1] = new_arg;
670
724
        custom_argv[custom_argc] = NULL;
728
782
    goto fallback;
729
783
  }
730
784
  
 
785
  {
 
786
    char *pluginhelperenv;
 
787
    bool bret = true;
 
788
    ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
 
789
                   pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
 
790
    if(ret != -1){
 
791
      bret = add_environment(getplugin(NULL), pluginhelperenv, true);
 
792
    }
 
793
    if(ret == -1 or not bret){
 
794
      error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
 
795
            " environment variable to \"%s\" for all plugins\n",
 
796
            pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
 
797
    }
 
798
    if(ret != -1){
 
799
      free(pluginhelperenv);
 
800
    }
 
801
  }
 
802
  
731
803
  if(debug){
732
 
    for(plugin *p = plugin_list; p != NULL; p=p->next){
 
804
    for(plugin *p = plugin_list; p != NULL; p = p->next){
733
805
      fprintf(stderr, "Plugin: %s has %d arguments\n",
734
806
              p->name ? p->name : "Global", p->argc - 1);
735
807
      for(char **a = p->argv; *a != NULL; a++){
742
814
    }
743
815
  }
744
816
  
745
 
  {
 
817
  if(getuid() == 0){
746
818
    /* Work around Debian bug #633582:
747
 
       <http://bugs.debian.org/633582> */
 
819
       <https://bugs.debian.org/633582> */
748
820
    int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
749
821
    if(plugindir_fd == -1){
750
 
      error(0, errno, "open");
 
822
      if(errno != ENOENT){
 
823
        error(0, errno, "open(\"" PDIR "\")");
 
824
      }
751
825
    } else {
752
826
      ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
753
827
      if(ret == -1){
760
834
          }
761
835
        }
762
836
      }
763
 
      TEMP_FAILURE_RETRY(close(plugindir_fd));
 
837
      close(plugindir_fd);
764
838
    }
765
839
  }
766
840
  
767
841
  /* Lower permissions */
768
 
  setgid(gid);
 
842
  ret = setgid(gid);
769
843
  if(ret == -1){
770
844
    error(0, errno, "setgid");
771
845
  }
776
850
  
777
851
  /* Open plugin directory with close_on_exec flag */
778
852
  {
779
 
    int dir_fd = -1;
780
 
    if(plugindir == NULL){
781
 
      dir_fd = open(PDIR, O_RDONLY |
782
 
#ifdef O_CLOEXEC
783
 
                    O_CLOEXEC
784
 
#else  /* not O_CLOEXEC */
785
 
                    0
786
 
#endif  /* not O_CLOEXEC */
787
 
                    );
788
 
    } else {
789
 
      dir_fd = open(plugindir, O_RDONLY |
790
 
#ifdef O_CLOEXEC
791
 
                    O_CLOEXEC
792
 
#else  /* not O_CLOEXEC */
793
 
                    0
794
 
#endif  /* not O_CLOEXEC */
795
 
                    );
796
 
    }
 
853
    dir_fd = open(plugindir != NULL ? plugindir : PDIR, O_RDONLY |
 
854
#ifdef O_CLOEXEC
 
855
                  O_CLOEXEC
 
856
#else  /* not O_CLOEXEC */
 
857
                  0
 
858
#endif  /* not O_CLOEXEC */
 
859
                  );
797
860
    if(dir_fd == -1){
798
861
      error(0, errno, "Could not open plugin dir");
799
862
      exitstatus = EX_UNAVAILABLE;
805
868
    ret = set_cloexec_flag(dir_fd);
806
869
    if(ret < 0){
807
870
      error(0, errno, "set_cloexec_flag");
808
 
      TEMP_FAILURE_RETRY(close(dir_fd));
809
871
      exitstatus = EX_OSERR;
810
872
      goto fallback;
811
873
    }
812
874
#endif  /* O_CLOEXEC */
813
 
    
814
 
    dir = fdopendir(dir_fd);
815
 
    if(dir == NULL){
816
 
      error(0, errno, "Could not open plugin dir");
817
 
      TEMP_FAILURE_RETRY(close(dir_fd));
818
 
      exitstatus = EX_OSERR;
819
 
      goto fallback;
 
875
  }
 
876
  
 
877
  int good_name(const struct dirent * const dirent){
 
878
    const char * const patterns[] = { ".*", "#*#", "*~", "*.dpkg-new",
 
879
                                      "*.dpkg-old", "*.dpkg-bak",
 
880
                                      "*.dpkg-divert", NULL };
 
881
#ifdef __GNUC__
 
882
#pragma GCC diagnostic push
 
883
#pragma GCC diagnostic ignored "-Wcast-qual"
 
884
#endif
 
885
    for(const char **pat = (const char **)patterns;
 
886
        *pat != NULL; pat++){
 
887
#ifdef __GNUC__
 
888
#pragma GCC diagnostic pop
 
889
#endif
 
890
      if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
 
891
         != FNM_NOMATCH){
 
892
        if(debug){
 
893
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
 
894
                    " matching pattern %s\n", dirent->d_name, *pat);
 
895
        }
 
896
        return 0;
 
897
      }
820
898
    }
 
899
    return 1;
 
900
  }
 
901
  
 
902
  int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
 
903
                             alphasort);
 
904
  if(numplugins == -1){
 
905
    error(0, errno, "Could not scan plugin dir");
 
906
    direntries = NULL;
 
907
    exitstatus = EX_OSERR;
 
908
    goto fallback;
821
909
  }
822
910
  
823
911
  FD_ZERO(&rfds_all);
824
912
  
825
913
  /* Read and execute any executable in the plugin directory*/
826
 
  while(true){
827
 
    do {
828
 
      dirst = readdir(dir);
829
 
    } while(dirst == NULL and errno == EINTR);
830
 
    
831
 
    /* All directory entries have been processed */
832
 
    if(dirst == NULL){
833
 
      if(errno == EBADF){
834
 
        error(0, errno, "readdir");
835
 
        exitstatus = EX_IOERR;
836
 
        goto fallback;
837
 
      }
838
 
      break;
839
 
    }
840
 
    
841
 
    d_name_len = strlen(dirst->d_name);
842
 
    
843
 
    /* Ignore dotfiles, backup files and other junk */
844
 
    {
845
 
      bool bad_name = false;
846
 
      
847
 
      const char const *bad_prefixes[] = { ".", "#", NULL };
848
 
      
849
 
      const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
850
 
                                           ".dpkg-old",
851
 
                                           ".dpkg-bak",
852
 
                                           ".dpkg-divert", NULL };
853
 
      for(const char **pre = bad_prefixes; *pre != NULL; pre++){
854
 
        size_t pre_len = strlen(*pre);
855
 
        if((d_name_len >= pre_len)
856
 
           and strncmp((dirst->d_name), *pre, pre_len) == 0){
857
 
          if(debug){
858
 
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
859
 
                    " with bad prefix %s\n", dirst->d_name, *pre);
860
 
          }
861
 
          bad_name = true;
862
 
          break;
863
 
        }
864
 
      }
865
 
      if(bad_name){
866
 
        continue;
867
 
      }
868
 
      for(const char **suf = bad_suffixes; *suf != NULL; suf++){
869
 
        size_t suf_len = strlen(*suf);
870
 
        if((d_name_len >= suf_len)
871
 
           and (strcmp((dirst->d_name) + d_name_len-suf_len, *suf)
872
 
                == 0)){
873
 
          if(debug){
874
 
            fprintf(stderr, "Ignoring plugin dir entry \"%s\""
875
 
                    " with bad suffix %s\n", dirst->d_name, *suf);
876
 
          }
877
 
          bad_name = true;
878
 
          break;
879
 
        }
880
 
      }
881
 
      
882
 
      if(bad_name){
883
 
        continue;
884
 
      }
885
 
    }
886
 
    
887
 
    char *filename;
888
 
    if(plugindir == NULL){
889
 
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, PDIR "/%s",
890
 
                                             dirst->d_name));
891
 
    } else {
892
 
      ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, "%s/%s",
893
 
                                             plugindir,
894
 
                                             dirst->d_name));
895
 
    }
896
 
    if(ret < 0){
897
 
      error(0, errno, "asprintf");
 
914
  for(int i = 0; i < numplugins; i++){
 
915
    
 
916
    int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
 
917
    if(plugin_fd == -1){
 
918
      error(0, errno, "Could not open plugin");
 
919
      free(direntries[i]);
898
920
      continue;
899
921
    }
900
 
    
901
 
    ret = (int)TEMP_FAILURE_RETRY(stat(filename, &st));
 
922
    ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
902
923
    if(ret == -1){
903
924
      error(0, errno, "stat");
904
 
      free(filename);
 
925
      close(plugin_fd);
 
926
      free(direntries[i]);
905
927
      continue;
906
928
    }
907
929
    
908
930
    /* Ignore non-executable files */
909
931
    if(not S_ISREG(st.st_mode)
910
 
       or (TEMP_FAILURE_RETRY(access(filename, X_OK)) != 0)){
 
932
       or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
 
933
                                        X_OK, 0)) != 0)){
911
934
      if(debug){
912
 
        fprintf(stderr, "Ignoring plugin dir entry \"%s\""
913
 
                " with bad type or mode\n", filename);
 
935
        fprintf(stderr, "Ignoring plugin dir entry \"%s/%s\""
 
936
                " with bad type or mode\n",
 
937
                plugindir != NULL ? plugindir : PDIR,
 
938
                direntries[i]->d_name);
914
939
      }
915
 
      free(filename);
 
940
      close(plugin_fd);
 
941
      free(direntries[i]);
916
942
      continue;
917
943
    }
918
944
    
919
 
    plugin *p = getplugin(dirst->d_name);
 
945
    plugin *p = getplugin(direntries[i]->d_name);
920
946
    if(p == NULL){
921
947
      error(0, errno, "getplugin");
922
 
      free(filename);
 
948
      close(plugin_fd);
 
949
      free(direntries[i]);
923
950
      continue;
924
951
    }
925
952
    if(p->disabled){
926
953
      if(debug){
927
954
        fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
928
 
                dirst->d_name);
 
955
                direntries[i]->d_name);
929
956
      }
930
 
      free(filename);
 
957
      close(plugin_fd);
 
958
      free(direntries[i]);
931
959
      continue;
932
960
    }
933
961
    {
947
975
        }
948
976
      }
949
977
    }
950
 
    /* If this plugin has any environment variables, we will call
951
 
       using execve and need to duplicate the environment from this
952
 
       process, too. */
 
978
    /* If this plugin has any environment variables, we need to
 
979
       duplicate the environment from this process, too. */
953
980
    if(p->environ[0] != NULL){
954
981
      for(char **e = environ; *e != NULL; e++){
955
982
        if(not add_environment(p, *e, false)){
959
986
    }
960
987
    
961
988
    int pipefd[2];
 
989
#ifndef O_CLOEXEC
962
990
    ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
 
991
#else  /* O_CLOEXEC */
 
992
    ret = (int)TEMP_FAILURE_RETRY(pipe2(pipefd, O_CLOEXEC));
 
993
#endif  /* O_CLOEXEC */
963
994
    if(ret == -1){
964
995
      error(0, errno, "pipe");
965
996
      exitstatus = EX_OSERR;
966
 
      goto fallback;
967
 
    }
 
997
      free(direntries[i]);
 
998
      goto fallback;
 
999
    }
 
1000
    if(pipefd[0] >= FD_SETSIZE){
 
1001
      fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
 
1002
              FD_SETSIZE);
 
1003
      close(pipefd[0]);
 
1004
      close(pipefd[1]);
 
1005
      exitstatus = EX_OSERR;
 
1006
      free(direntries[i]);
 
1007
      goto fallback;
 
1008
    }
 
1009
#ifndef O_CLOEXEC
968
1010
    /* Ask OS to automatic close the pipe on exec */
969
1011
    ret = set_cloexec_flag(pipefd[0]);
970
1012
    if(ret < 0){
971
1013
      error(0, errno, "set_cloexec_flag");
 
1014
      close(pipefd[0]);
 
1015
      close(pipefd[1]);
972
1016
      exitstatus = EX_OSERR;
 
1017
      free(direntries[i]);
973
1018
      goto fallback;
974
1019
    }
975
1020
    ret = set_cloexec_flag(pipefd[1]);
976
1021
    if(ret < 0){
977
1022
      error(0, errno, "set_cloexec_flag");
 
1023
      close(pipefd[0]);
 
1024
      close(pipefd[1]);
978
1025
      exitstatus = EX_OSERR;
 
1026
      free(direntries[i]);
979
1027
      goto fallback;
980
1028
    }
 
1029
#endif  /* not O_CLOEXEC */
981
1030
    /* Block SIGCHLD until process is safely in process list */
982
1031
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
983
1032
                                              &sigchld_action.sa_mask,
985
1034
    if(ret < 0){
986
1035
      error(0, errno, "sigprocmask");
987
1036
      exitstatus = EX_OSERR;
 
1037
      free(direntries[i]);
988
1038
      goto fallback;
989
1039
    }
990
1040
    /* Starting a new process to be watched */
994
1044
    } while(pid == -1 and errno == EINTR);
995
1045
    if(pid == -1){
996
1046
      error(0, errno, "fork");
 
1047
      TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
 
1048
                                     &sigchld_action.sa_mask, NULL));
 
1049
      close(pipefd[0]);
 
1050
      close(pipefd[1]);
997
1051
      exitstatus = EX_OSERR;
 
1052
      free(direntries[i]);
998
1053
      goto fallback;
999
1054
    }
1000
1055
    if(pid == 0){
1016
1071
        _exit(EX_OSERR);
1017
1072
      }
1018
1073
      
1019
 
      if(dirfd(dir) < 0){
1020
 
        /* If dir has no file descriptor, we could not set FD_CLOEXEC
1021
 
           above and must now close it manually here. */
1022
 
        closedir(dir);
1023
 
      }
1024
 
      if(p->environ[0] == NULL){
1025
 
        if(execv(filename, p->argv) < 0){
1026
 
          error(0, errno, "execv for %s", filename);
1027
 
          _exit(EX_OSERR);
1028
 
        }
1029
 
      } else {
1030
 
        if(execve(filename, p->argv, p->environ) < 0){
1031
 
          error(0, errno, "execve for %s", filename);
1032
 
          _exit(EX_OSERR);
1033
 
        }
 
1074
      if(fexecve(plugin_fd, p->argv,
 
1075
                (p->environ[0] != NULL) ? p->environ : environ) < 0){
 
1076
        error(0, errno, "fexecve for %s/%s",
 
1077
              plugindir != NULL ? plugindir : PDIR,
 
1078
              direntries[i]->d_name);
 
1079
        _exit(EX_OSERR);
1034
1080
      }
1035
1081
      /* no return */
1036
1082
    }
1037
1083
    /* Parent process */
1038
 
    TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
1039
 
                                             pipe */
1040
 
    free(filename);
1041
 
    plugin *new_plugin = getplugin(dirst->d_name);
 
1084
    close(pipefd[1]);           /* Close unused write end of pipe */
 
1085
    close(plugin_fd);
 
1086
    plugin *new_plugin = getplugin(direntries[i]->d_name);
1042
1087
    if(new_plugin == NULL){
1043
1088
      error(0, errno, "getplugin");
1044
1089
      ret = (int)(TEMP_FAILURE_RETRY
1048
1093
        error(0, errno, "sigprocmask");
1049
1094
      }
1050
1095
      exitstatus = EX_OSERR;
 
1096
      free(direntries[i]);
1051
1097
      goto fallback;
1052
1098
    }
 
1099
    free(direntries[i]);
1053
1100
    
1054
1101
    new_plugin->pid = pid;
1055
1102
    new_plugin->fd = pipefd[0];
1056
 
    
 
1103
 
 
1104
    if(debug){
 
1105
      fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
 
1106
              new_plugin->name, (intmax_t) (new_plugin->pid));
 
1107
    }
 
1108
 
1057
1109
    /* Unblock SIGCHLD so signal handler can be run if this process
1058
1110
       has already completed */
1059
1111
    ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1065
1117
      goto fallback;
1066
1118
    }
1067
1119
    
1068
 
    FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
1069
 
                                          -Wconversion */
 
1120
    FD_SET(new_plugin->fd, &rfds_all);
1070
1121
    
1071
1122
    if(maxfd < new_plugin->fd){
1072
1123
      maxfd = new_plugin->fd;
1073
1124
    }
1074
1125
  }
1075
1126
  
1076
 
  TEMP_FAILURE_RETRY(closedir(dir));
1077
 
  dir = NULL;
 
1127
  free(direntries);
 
1128
  direntries = NULL;
 
1129
  close(dir_fd);
 
1130
  dir_fd = -1;
1078
1131
  free_plugin(getplugin(NULL));
1079
1132
  
1080
1133
  for(plugin *p = plugin_list; p != NULL; p = p->next){
1119
1172
                      (intmax_t) (proc->pid),
1120
1173
                      WTERMSIG(proc->status),
1121
1174
                      strsignal(WTERMSIG(proc->status)));
1122
 
            } else if(WCOREDUMP(proc->status)){
1123
 
              fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
1124
 
                      " core\n", proc->name, (intmax_t) (proc->pid));
1125
1175
            }
1126
1176
          }
1127
1177
          
1128
1178
          /* Remove the plugin */
1129
 
          FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
1130
 
                                          -Wconversion */
 
1179
          FD_CLR(proc->fd, &rfds_all);
1131
1180
          
1132
1181
          /* Block signal while modifying process_list */
1133
1182
          ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1173
1222
      }
1174
1223
      
1175
1224
      /* This process has not completed.  Does it have any output? */
1176
 
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
1177
 
                                                         warning from
1178
 
                                                         -Wconversion */
 
1225
      if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1179
1226
        /* This process had nothing to say at this time */
1180
1227
        proc = proc->next;
1181
1228
        continue;
1182
1229
      }
1183
1230
      /* Before reading, make the process' data buffer large enough */
1184
1231
      if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1185
 
        proc->buffer = realloc(proc->buffer, proc->buffer_size
1186
 
                               + (size_t) BUFFER_SIZE);
1187
 
        if(proc->buffer == NULL){
 
1232
        char *new_buffer = realloc(proc->buffer, proc->buffer_size
 
1233
                                   + (size_t) BUFFER_SIZE);
 
1234
        if(new_buffer == NULL){
1188
1235
          error(0, errno, "malloc");
1189
1236
          exitstatus = EX_OSERR;
1190
1237
          goto fallback;
1191
1238
        }
 
1239
        proc->buffer = new_buffer;
1192
1240
        proc->buffer_size += BUFFER_SIZE;
1193
1241
      }
1194
1242
      /* Read from the process */
1247
1295
    free(custom_argv);
1248
1296
  }
1249
1297
  
1250
 
  if(dir != NULL){
1251
 
    closedir(dir);
 
1298
  free(direntries);
 
1299
  
 
1300
  if(dir_fd != -1){
 
1301
    close(dir_fd);
1252
1302
  }
1253
1303
  
1254
1304
  /* Kill the processes */
1274
1324
  free_plugin_list();
1275
1325
  
1276
1326
  free(plugindir);
 
1327
  free(pluginhelperdir);
1277
1328
  free(argfile);
1278
1329
  
1279
1330
  return exitstatus;