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 394
- compare with another revision
- download diff
- download tarball
- view history from revision 394
- Committer: Teddy Hogeborn
- Date: 2009-10-24 19:17:52 UTC
- Revision ID: teddy@fukt.bsnet.se-20091024191752-7g6xlf6wpp2pdexb
Convert some programs to use the exit codes from <sysexits.h>. Change
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.
* plugin-runner.c: Use <sysexits.h> exit codes. Always use fallback,
even on option errors, except for "--help", etc.
(getplugin): Make sure "errno" is set correctly on return.
(main): Declare our own "--help", "--usage", and "--version"
options which do not cause the fallback to be invoked.
In all other options, use fallback on any error.
(parse_opt, parse_opt_config_file): Reset errno at start and return
errno. No need to check "arg"
for NULL. New "--help",
"--usage", and "--version"
options.
(parse_opt): Accept empty string as global option. Do not print
errors which will be detected and reported later. Do
"argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes. Do not
return successful exit code on "--help",
etc. since this would give the wrong
message to "plugin-runner".
(main): Declare our own "--help", "--usage", and "--version"
options which do not return a successful exit code.
(parse_opt): Reset errno at start and return errno. Do
"argp_error()" on parse errors. New "--help",
"--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>. Do
not return successful exit code on
"--help", etc. since this would give
the wrong message to "plugin-runner".
(main): Declare our own "--help", "--usage", and "--version" options
which do not return a successful exit code. Do
close(STDOUT_FILENO) after writing to check its return code.
(parse_opt): Reset errno at start and return errno.
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.
* plugin-runner.c: Use <sysexits.h> exit codes. Always use fallback,
even on option errors, except for "--help", etc.
(getplugin): Make sure "errno" is set correctly on return.
(main): Declare our own "--help", "--usage", and "--version"
options which do not cause the fallback to be invoked.
In all other options, use fallback on any error.
(parse_opt, parse_opt_config_file): Reset errno at start and return
errno. No need to check "arg"
for NULL. New "--help",
"--usage", and "--version"
options.
(parse_opt): Accept empty string as global option. Do not print
errors which will be detected and reported later. Do
"argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes. Do not
return successful exit code on "--help",
etc. since this would give the wrong
message to "plugin-runner".
(main): Declare our own "--help", "--usage", and "--version"
options which do not return a successful exit code.
(parse_opt): Reset errno at start and return errno. Do
"argp_error()" on parse errors. New "--help",
"--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>. Do
not return successful exit code on
"--help", etc. since this would give
the wrong message to "plugin-runner".
(main): Declare our own "--help", "--usage", and "--version" options
which do not return a successful exit code. Do
close(STDOUT_FILENO) after writing to check its return code.
(parse_opt): Reset errno at start and return errno.
- files added:
- initramfs-tools-hook-conf
- files removed:
- DBUS-API
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files modified:
- .bzrignore
added
removed
plugin-runner.c
2
2
/*
3
3
* Mandos plugin runner - Run Mandos plugins
4
4
*
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
5
* Copyright © 2008,2009 Teddy Hogeborn
6
* Copyright © 2008,2009 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
16
14
* WITHOUT ANY WARRANTY; without even the implied warranty of
17
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18
16
* General Public License for more details.
19
17
*
20
18
* You should have received a copy of the GNU General Public License
21
* along with Mandos. If not, see <http://www.gnu.org/licenses/>.
19
* along with this program. If not, see
20
* <http://www.gnu.org/licenses/>.
22
21
*
23
* Contact the authors at <mandos@recompile.se>.
22
* Contact the authors at <mandos@fukt.bsnet.se>.
24
23
*/
25
24
26
25
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
27
O_CLOEXEC, pipe2() */
26
asprintf(), O_CLOEXEC */
28
27
#include <stddef.h> /* size_t, NULL */
29
#include <stdlib.h> /* malloc(), reallocarray(), realloc(),
30
EXIT_SUCCESS, exit() */
28
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
29
EXIT_SUCCESS, realloc() */
31
30
#include <stdbool.h> /* bool, true, false */
32
#include <stdio.h> /* fileno(), fprintf(),
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() */
31
#include <stdio.h> /* perror, 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() */
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
#include <sys/stat.h> /* struct stat, fstat(), S_ISREG() */
41
WEXITSTATUS(), WTERMSIG(),
42
WCOREDUMP() */
43
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
43
44
#include <iso646.h> /* and, or, not */
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
*/
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() */
52
54
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
53
FD_CLOEXEC, openat(), scandirat(),
54
pipe2() */
55
#include <string.h> /* strsep, strlen(), strsignal(),
56
strcmp(), strncmp() */
55
FD_CLOEXEC */
56
#include <string.h> /* strsep, strlen(), asprintf(),
57
strsignal() */
57
58
#include <errno.h> /* errno */
58
59
#include <argp.h> /* struct argp_option, struct
59
60
argp_state, struct argp,
67
68
*/
68
69
#include <errno.h> /* errno, EBADF */
69
70
#include <inttypes.h> /* intmax_t, PRIdMAX, strtoimax() */
70
#include <sysexits.h> /* EX_OSERR, EX_USAGE, EX_IOERR,
71
EX_CONFIG, EX_UNAVAILABLE, EX_OK */
72
#include <errno.h> /* errno */
73
#include <error.h> /* error() */
74
#include <fnmatch.h> /* fnmatch() */
71
#include <sysexits.h> /* EX_OSERR, EX_USAGE */
75
72
76
73
#define BUFFER_SIZE 256
77
74
78
75
#define PDIR "/lib/mandos/plugins.d"
79
#define PHDIR "/lib/mandos/plugin-helpers"
80
76
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
81
77
82
78
const char *argp_program_version = "plugin-runner " VERSION;
83
const char *argp_program_bug_address = "<mandos@recompile.se>";
79
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
84
80
85
81
typedef struct plugin{
86
82
char *name; /* can be NULL or any plugin name */
106
102
107
103
/* Gets an existing plugin based on name,
108
104
or if none is found, creates a new one */
109
__attribute__((warn_unused_result))
110
105
static plugin *getplugin(char *name){
111
106
/* Check for existing plugin with that name */
112
107
for(plugin *p = plugin_list; p != NULL; p = p->next){
173
168
}
174
169
175
170
/* Helper function for add_argument and add_environment */
176
__attribute__((nonnull, warn_unused_result))
177
171
static bool add_to_char_array(const char *new, char ***array,
178
172
int *len){
179
173
/* Resize the pointed-to array to hold one more pointer */
180
char **new_array = NULL;
181
174
do {
182
#if defined(__GLIBC_PREREQ) and __GLIBC_PREREQ(2, 26)
183
new_array = reallocarray(*array, (size_t)((*len) + 2),
184
sizeof(char *));
185
#else
186
if(((size_t)((*len) + 2)) > (SIZE_MAX / sizeof(char *))){
187
/* overflow */
188
new_array = NULL;
189
errno = ENOMEM;
190
} else {
191
new_array = realloc(*array, (size_t)((*len) + 2)
192
* sizeof(char *));
193
}
194
#endif
195
} while(new_array == NULL and errno == EINTR);
175
*array = realloc(*array, sizeof(char *)
176
* (size_t) ((*len) + 2));
177
} while(*array == NULL and errno == EINTR);
196
178
/* Malloc check */
197
if(new_array == NULL){
179
if(*array == NULL){
198
180
return false;
199
181
}
200
*array = new_array;
201
182
/* Make a copy of the new string */
202
183
char *copy;
203
184
do {
215
196
}
216
197
217
198
/* Add to a plugin's argument vector */
218
__attribute__((nonnull(2), warn_unused_result))
219
199
static bool add_argument(plugin *p, const char *arg){
220
200
if(p == NULL){
221
201
return false;
224
204
}
225
205
226
206
/* Add to a plugin's environment */
227
__attribute__((nonnull(2), warn_unused_result))
228
207
static bool add_environment(plugin *p, const char *def, bool replace){
229
208
if(p == NULL){
230
209
return false;
232
211
/* namelen = length of name of environment variable */
233
212
size_t namelen = (size_t)(strchrnul(def, '=') - def);
234
213
/* Search for this environment variable */
235
for(char **envdef = p->environ; *envdef != NULL; envdef++){
236
if(strncmp(*envdef, def, namelen + 1) == 0){
214
for(char **e = p->environ; *e != NULL; e++){
215
if(strncmp(*e, def, namelen + 1) == 0){
237
216
/* It already exists */
238
217
if(replace){
239
char *new_envdef;
218
char *new;
240
219
do {
241
new_envdef = realloc(*envdef, strlen(def) + 1);
242
} while(new_envdef == NULL and errno == EINTR);
243
if(new_envdef == NULL){
220
new = realloc(*e, strlen(def) + 1);
221
} while(new == NULL and errno == EINTR);
222
if(new == NULL){
244
223
return false;
245
224
}
246
*envdef = new_envdef;
247
strcpy(*envdef, def);
225
*e = new;
226
strcpy(*e, def);
248
227
}
249
228
return true;
250
229
}
252
231
return add_to_char_array(def, &(p->environ), &(p->envc));
253
232
}
254
233
255
#ifndef O_CLOEXEC
256
234
/*
257
235
* Based on the example in the GNU LibC manual chapter 13.13 "File
258
236
* Descriptor Flags".
259
237
| [[info:libc:Descriptor%20Flags][File Descriptor Flags]] |
260
238
*/
261
__attribute__((warn_unused_result))
262
239
static int set_cloexec_flag(int fd){
263
240
int ret = (int)TEMP_FAILURE_RETRY(fcntl(fd, F_GETFD, 0));
264
241
/* If reading the flags failed, return error indication now. */
269
246
return (int)TEMP_FAILURE_RETRY(fcntl(fd, F_SETFD,
270
247
ret | FD_CLOEXEC));
271
248
}
272
#endif /* not O_CLOEXEC */
273
249
274
250
275
251
/* Mark processes as completed when they exit, and save their exit
289
265
/* No child processes */
290
266
break;
291
267
}
292
error(0, errno, "waitpid");
268
perror("waitpid");
293
269
}
294
270
295
271
/* A child exited, find it in process_list */
307
283
}
308
284
309
285
/* Prints out a password to stdout */
310
__attribute__((nonnull, warn_unused_result))
311
286
static bool print_out_password(const char *buffer, size_t length){
312
287
ssize_t ret;
313
288
for(size_t written = 0; written < length; written += (size_t)ret){
321
296
}
322
297
323
298
/* Removes and free a plugin from the plugin list */
324
__attribute__((nonnull))
325
299
static void free_plugin(plugin *plugin_node){
326
300
327
for(char **arg = (plugin_node->argv)+1; *arg != NULL; arg++){
301
for(char **arg = plugin_node->argv; *arg != NULL; arg++){
328
302
free(*arg);
329
303
}
330
free(plugin_node->name);
331
304
free(plugin_node->argv);
332
305
for(char **env = plugin_node->environ; *env != NULL; env++){
333
306
free(*env);
360
333
361
334
int main(int argc, char *argv[]){
362
335
char *plugindir = NULL;
363
char *pluginhelperdir = NULL;
364
336
char *argfile = NULL;
365
337
FILE *conffp;
366
struct dirent **direntries = NULL;
338
size_t d_name_len;
339
DIR *dir = NULL;
340
struct dirent *dirst;
367
341
struct stat st;
368
342
fd_set rfds_all;
369
343
int ret, maxfd = 0;
377
351
.sa_flags = SA_NOCLDSTOP };
378
352
char **custom_argv = NULL;
379
353
int custom_argc = 0;
380
int dir_fd = -1;
381
354
382
355
/* Establish a signal handler */
383
356
sigemptyset(&sigchld_action.sa_mask);
384
357
ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
385
358
if(ret == -1){
386
error(0, errno, "sigaddset");
387
exitstatus = EX_OSERR;
359
perror("sigaddset");
360
exitstatus = EXIT_FAILURE;
388
361
goto fallback;
389
362
}
390
363
ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
391
364
if(ret == -1){
392
error(0, errno, "sigaction");
393
exitstatus = EX_OSERR;
365
perror("sigaction");
366
exitstatus = EXIT_FAILURE;
394
367
goto fallback;
395
368
}
396
369
428
401
.doc = "Group ID the plugins will run as", .group = 3 },
429
402
{ .name = "debug", .key = 132,
430
403
.doc = "Debug mode", .group = 4 },
431
{ .name = "plugin-helper-dir", .key = 133,
432
.arg = "DIRECTORY",
433
.doc = "Specify a different plugin helper directory",
434
.group = 2 },
435
404
/*
436
405
* These reproduce what we would get without ARGP_NO_HELP
437
406
*/
444
413
{ .name = NULL }
445
414
};
446
415
447
__attribute__((nonnull(3)))
448
416
error_t parse_opt(int key, char *arg, struct argp_state *state){
449
417
errno = 0;
450
418
switch(key){
451
419
char *tmp;
452
intmax_t tmp_id;
420
intmax_t tmpmax;
453
421
case 'g': /* --global-options */
454
422
{
455
423
char *plugin_option;
458
426
break;
459
427
}
460
428
}
461
errno = 0;
462
429
}
463
430
break;
464
431
case 'G': /* --global-env */
465
if(add_environment(getplugin(NULL), arg, true)){
466
errno = 0;
467
}
432
add_environment(getplugin(NULL), arg, true);
468
433
break;
469
434
case 'o': /* --options-for */
470
435
{
487
452
break;
488
453
}
489
454
}
490
errno = 0;
491
455
}
492
456
break;
493
457
case 'E': /* --env-for */
505
469
errno = EINVAL;
506
470
break;
507
471
}
508
if(add_environment(getplugin(arg), envdef, true)){
509
errno = 0;
510
}
472
add_environment(getplugin(arg), envdef, true);
511
473
}
512
474
break;
513
475
case 'd': /* --disable */
515
477
plugin *p = getplugin(arg);
516
478
if(p != NULL){
517
479
p->disabled = true;
518
errno = 0;
519
480
}
520
481
}
521
482
break;
524
485
plugin *p = getplugin(arg);
525
486
if(p != NULL){
526
487
p->disabled = false;
527
errno = 0;
528
488
}
529
489
}
530
490
break;
531
491
case 128: /* --plugin-dir */
532
492
free(plugindir);
533
493
plugindir = strdup(arg);
534
if(plugindir != NULL){
535
errno = 0;
536
}
537
494
break;
538
495
case 129: /* --config-file */
539
496
/* This is already done by parse_opt_config_file() */
540
497
break;
541
498
case 130: /* --userid */
542
tmp_id = strtoimax(arg, &tmp, 10);
499
tmpmax = strtoimax(arg, &tmp, 10);
543
500
if(errno != 0 or tmp == arg or *tmp != '\0'
544
or tmp_id != (uid_t)tmp_id){
501
or tmpmax != (uid_t)tmpmax){
545
502
argp_error(state, "Bad user ID number: \"%s\", using %"
546
503
PRIdMAX, arg, (intmax_t)uid);
547
504
break;
548
505
}
549
uid = (uid_t)tmp_id;
550
errno = 0;
506
uid = (uid_t)tmpmax;
551
507
break;
552
508
case 131: /* --groupid */
553
tmp_id = strtoimax(arg, &tmp, 10);
509
tmpmax = strtoimax(arg, &tmp, 10);
554
510
if(errno != 0 or tmp == arg or *tmp != '\0'
555
or tmp_id != (gid_t)tmp_id){
511
or tmpmax != (gid_t)tmpmax){
556
512
argp_error(state, "Bad group ID number: \"%s\", using %"
557
513
PRIdMAX, arg, (intmax_t)gid);
558
514
break;
559
515
}
560
gid = (gid_t)tmp_id;
561
errno = 0;
516
gid = (gid_t)tmpmax;
562
517
break;
563
518
case 132: /* --debug */
564
519
debug = true;
565
520
break;
566
case 133: /* --plugin-helper-dir */
567
free(pluginhelperdir);
568
pluginhelperdir = strdup(arg);
569
if(pluginhelperdir != NULL){
570
errno = 0;
571
}
572
break;
573
521
/*
574
522
* These reproduce what we would get without ARGP_NO_HELP
575
523
*/
576
524
case '?': /* --help */
577
525
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
578
526
argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
579
__builtin_unreachable();
580
527
case -3: /* --usage */
581
528
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
582
529
argp_state_help(state, state->out_stream,
583
530
ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
584
__builtin_unreachable();
585
531
case 'V': /* --version */
586
532
fprintf(state->out_stream, "%s\n", argp_program_version);
587
533
exit(EXIT_SUCCESS);
597
543
if(arg[0] == '\0'){
598
544
break;
599
545
}
600
#if __GNUC__ >= 7
601
__attribute__((fallthrough));
602
#else
603
/* FALLTHROUGH */
604
#endif
605
546
default:
606
547
return ARGP_ERR_UNKNOWN;
607
548
}
626
567
case 129: /* --config-file */
627
568
free(argfile);
628
569
argfile = strdup(arg);
629
if(argfile != NULL){
630
errno = 0;
631
}
632
570
break;
633
571
case 130: /* --userid */
634
572
case 131: /* --groupid */
635
573
case 132: /* --debug */
636
case 133: /* --plugin-helper-dir */
637
574
case '?': /* --help */
638
575
case -3: /* --usage */
639
576
case 'V': /* --version */
661
598
case ENOMEM:
662
599
default:
663
600
errno = ret;
664
error(0, errno, "argp_parse");
601
perror("argp_parse");
665
602
exitstatus = EX_OSERR;
666
603
goto fallback;
667
604
case EINVAL:
688
625
custom_argc = 1;
689
626
custom_argv = malloc(sizeof(char*) * 2);
690
627
if(custom_argv == NULL){
691
error(0, errno, "malloc");
692
exitstatus = EX_OSERR;
628
perror("malloc");
629
exitstatus = EXIT_FAILURE;
693
630
goto fallback;
694
631
}
695
632
custom_argv[0] = argv[0];
711
648
}
712
649
new_arg = strdup(p);
713
650
if(new_arg == NULL){
714
error(0, errno, "strdup");
715
exitstatus = EX_OSERR;
651
perror("strdup");
652
exitstatus = EXIT_FAILURE;
716
653
free(org_line);
717
654
goto fallback;
718
655
}
719
656
720
657
custom_argc += 1;
721
{
722
#if defined(__GLIBC_PREREQ) and __GLIBC_PREREQ(2, 26)
723
char **new_argv = reallocarray(custom_argv, (size_t)custom_argc + 1,
724
sizeof(char *));
725
#else
726
char **new_argv = NULL;
727
if(((size_t)custom_argc + 1) > (SIZE_MAX / sizeof(char *))){
728
/* overflow */
729
errno = ENOMEM;
730
} else {
731
new_argv = realloc(custom_argv, ((size_t)custom_argc + 1)
732
* sizeof(char *));
733
}
734
#endif
735
if(new_argv == NULL){
736
error(0, errno, "reallocarray");
737
exitstatus = EX_OSERR;
738
free(new_arg);
739
free(org_line);
740
goto fallback;
741
} else {
742
custom_argv = new_argv;
743
}
658
custom_argv = realloc(custom_argv, sizeof(char *)
659
* ((unsigned int) custom_argc + 1));
660
if(custom_argv == NULL){
661
perror("realloc");
662
exitstatus = EXIT_FAILURE;
663
free(org_line);
664
goto fallback;
744
665
}
745
666
custom_argv[custom_argc-1] = new_arg;
746
667
custom_argv[custom_argc] = NULL;
750
671
ret = fclose(conffp);
751
672
} while(ret == EOF and errno == EINTR);
752
673
if(ret == EOF){
753
error(0, errno, "fclose");
754
exitstatus = EX_IOERR;
674
perror("fclose");
675
exitstatus = EXIT_FAILURE;
755
676
goto fallback;
756
677
}
757
678
free(org_line);
759
680
/* Check for harmful errors and go to fallback. Other errors might
760
681
not affect opening plugins */
761
682
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
762
error(0, errno, "fopen");
763
exitstatus = EX_OSERR;
683
perror("fopen");
684
exitstatus = EXIT_FAILURE;
764
685
goto fallback;
765
686
}
766
687
}
776
697
case ENOMEM:
777
698
default:
778
699
errno = ret;
779
error(0, errno, "argp_parse");
700
perror("argp_parse");
780
701
exitstatus = EX_OSERR;
781
702
goto fallback;
782
703
case EINVAL:
796
717
case ENOMEM:
797
718
default:
798
719
errno = ret;
799
error(0, errno, "argp_parse");
720
perror("argp_parse");
800
721
exitstatus = EX_OSERR;
801
722
goto fallback;
802
723
case EINVAL:
804
725
goto fallback;
805
726
}
806
727
807
{
808
char *pluginhelperenv;
809
bool bret = true;
810
ret = asprintf(&pluginhelperenv, "MANDOSPLUGINHELPERDIR=%s",
811
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
812
if(ret != -1){
813
bret = add_environment(getplugin(NULL), pluginhelperenv, true);
814
}
815
if(ret == -1 or not bret){
816
error(0, errno, "Failed to set MANDOSPLUGINHELPERDIR"
817
" environment variable to \"%s\" for all plugins\n",
818
pluginhelperdir != NULL ? pluginhelperdir : PHDIR);
819
}
820
if(ret != -1){
821
free(pluginhelperenv);
822
}
823
}
824
825
728
if(debug){
826
for(plugin *p = plugin_list; p != NULL; p = p->next){
729
for(plugin *p = plugin_list; p != NULL; p=p->next){
827
730
fprintf(stderr, "Plugin: %s has %d arguments\n",
828
731
p->name ? p->name : "Global", p->argc - 1);
829
732
for(char **a = p->argv; *a != NULL; a++){
836
739
}
837
740
}
838
741
839
if(getuid() == 0){
840
/* Work around Debian bug #633582:
841
<https://bugs.debian.org/633582> */
842
int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
843
if(plugindir_fd == -1){
844
if(errno != ENOENT){
845
error(0, errno, "open(\"" PDIR "\")");
846
}
847
} else {
848
ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
849
if(ret == -1){
850
error(0, errno, "fstat");
851
} else {
852
if(S_ISDIR(st.st_mode) and st.st_uid == 0 and st.st_gid == 0){
853
ret = fchown(plugindir_fd, uid, gid);
854
if(ret == -1){
855
error(0, errno, "fchown");
856
}
857
}
858
}
859
close(plugindir_fd);
860
}
861
}
862
863
/* Lower permissions */
864
ret = setgid(gid);
742
/* Strip permissions down to nobody */
743
setgid(gid);
865
744
if(ret == -1){
866
error(0, errno, "setgid");
745
perror("setgid");
867
746
}
868
747
ret = setuid(uid);
869
748
if(ret == -1){
870
error(0, errno, "setuid");
749
perror("setuid");
871
750
}
872
751
873
752
/* Open plugin directory with close_on_exec flag */
874
753
{
875
dir_fd = open(plugindir != NULL ? plugindir : PDIR, O_RDONLY |
876
#ifdef O_CLOEXEC
877
O_CLOEXEC
878
#else /* not O_CLOEXEC */
879
0
880
#endif /* not O_CLOEXEC */
881
);
754
int dir_fd = -1;
755
if(plugindir == NULL){
756
dir_fd = open(PDIR, O_RDONLY |
757
#ifdef O_CLOEXEC
758
O_CLOEXEC
759
#else /* not O_CLOEXEC */
760
0
761
#endif /* not O_CLOEXEC */
762
);
763
} else {
764
dir_fd = open(plugindir, O_RDONLY |
765
#ifdef O_CLOEXEC
766
O_CLOEXEC
767
#else /* not O_CLOEXEC */
768
0
769
#endif /* not O_CLOEXEC */
770
);
771
}
882
772
if(dir_fd == -1){
883
error(0, errno, "Could not open plugin dir");
884
exitstatus = EX_UNAVAILABLE;
773
perror("Could not open plugin dir");
774
exitstatus = EXIT_FAILURE;
885
775
goto fallback;
886
776
}
887
777
889
779
/* Set the FD_CLOEXEC flag on the directory */
890
780
ret = set_cloexec_flag(dir_fd);
891
781
if(ret < 0){
892
error(0, errno, "set_cloexec_flag");
893
exitstatus = EX_OSERR;
782
perror("set_cloexec_flag");
783
TEMP_FAILURE_RETRY(close(dir_fd));
784
exitstatus = EXIT_FAILURE;
894
785
goto fallback;
895
786
}
896
787
#endif /* O_CLOEXEC */
897
}
898
899
int good_name(const struct dirent * const dirent){
900
const char * const patterns[] = { ".*", "#*#", "*~", "*.dpkg-new",
901
"*.dpkg-old", "*.dpkg-bak",
902
"*.dpkg-divert", NULL };
903
#ifdef __GNUC__
904
#pragma GCC diagnostic push
905
#pragma GCC diagnostic ignored "-Wcast-qual"
906
#endif
907
for(const char **pat = (const char **)patterns;
908
*pat != NULL; pat++){
909
#ifdef __GNUC__
910
#pragma GCC diagnostic pop
911
#endif
912
if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
913
!= FNM_NOMATCH){
914
if(debug){
915
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
916
" matching pattern %s\n", dirent->d_name, *pat);
917
}
918
return 0;
919
}
788
789
dir = fdopendir(dir_fd);
790
if(dir == NULL){
791
perror("Could not open plugin dir");
792
TEMP_FAILURE_RETRY(close(dir_fd));
793
exitstatus = EXIT_FAILURE;
794
goto fallback;
920
795
}
921
return 1;
922
}
923
924
int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
925
alphasort);
926
if(numplugins == -1){
927
error(0, errno, "Could not scan plugin dir");
928
direntries = NULL;
929
exitstatus = EX_OSERR;
930
goto fallback;
931
796
}
932
797
933
798
FD_ZERO(&rfds_all);
934
799
935
800
/* Read and execute any executable in the plugin directory*/
936
for(int i = 0; i < numplugins; i++){
937
938
int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
939
if(plugin_fd == -1){
940
error(0, errno, "Could not open plugin");
941
free(direntries[i]);
801
while(true){
802
do {
803
dirst = readdir(dir);
804
} while(dirst == NULL and errno == EINTR);
805
806
/* All directory entries have been processed */
807
if(dirst == NULL){
808
if(errno == EBADF){
809
perror("readdir");
810
exitstatus = EXIT_FAILURE;
811
goto fallback;
812
}
813
break;
814
}
815
816
d_name_len = strlen(dirst->d_name);
817
818
/* Ignore dotfiles, backup files and other junk */
819
{
820
bool bad_name = false;
821
822
const char const *bad_prefixes[] = { ".", "#", NULL };
823
824
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
825
".dpkg-old",
826
".dpkg-bak",
827
".dpkg-divert", NULL };
828
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
829
size_t pre_len = strlen(*pre);
830
if((d_name_len >= pre_len)
831
and strncmp((dirst->d_name), *pre, pre_len) == 0){
832
if(debug){
833
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
834
" with bad prefix %s\n", dirst->d_name, *pre);
835
}
836
bad_name = true;
837
break;
838
}
839
}
840
if(bad_name){
841
continue;
842
}
843
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
844
size_t suf_len = strlen(*suf);
845
if((d_name_len >= suf_len)
846
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
847
== 0)){
848
if(debug){
849
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
850
" with bad suffix %s\n", dirst->d_name, *suf);
851
}
852
bad_name = true;
853
break;
854
}
855
}
856
857
if(bad_name){
858
continue;
859
}
860
}
861
862
char *filename;
863
if(plugindir == NULL){
864
ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, PDIR "/%s",
865
dirst->d_name));
866
} else {
867
ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, "%s/%s",
868
plugindir,
869
dirst->d_name));
870
}
871
if(ret < 0){
872
perror("asprintf");
942
873
continue;
943
874
}
944
ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
875
876
ret = (int)TEMP_FAILURE_RETRY(stat(filename, &st));
945
877
if(ret == -1){
946
error(0, errno, "stat");
947
close(plugin_fd);
948
free(direntries[i]);
878
perror("stat");
879
free(filename);
949
880
continue;
950
881
}
951
882
952
883
/* Ignore non-executable files */
953
884
if(not S_ISREG(st.st_mode)
954
or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
955
X_OK, 0)) != 0)){
885
or (TEMP_FAILURE_RETRY(access(filename, X_OK)) != 0)){
956
886
if(debug){
957
fprintf(stderr, "Ignoring plugin dir entry \"%s/%s\""
958
" with bad type or mode\n",
959
plugindir != NULL ? plugindir : PDIR,
960
direntries[i]->d_name);
887
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
888
" with bad type or mode\n", filename);
961
889
}
962
close(plugin_fd);
963
free(direntries[i]);
890
free(filename);
964
891
continue;
965
892
}
966
893
967
plugin *p = getplugin(direntries[i]->d_name);
894
plugin *p = getplugin(dirst->d_name);
968
895
if(p == NULL){
969
error(0, errno, "getplugin");
970
close(plugin_fd);
971
free(direntries[i]);
896
perror("getplugin");
897
free(filename);
972
898
continue;
973
899
}
974
900
if(p->disabled){
975
901
if(debug){
976
902
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
977
direntries[i]->d_name);
903
dirst->d_name);
978
904
}
979
close(plugin_fd);
980
free(direntries[i]);
905
free(filename);
981
906
continue;
982
907
}
983
908
{
986
911
if(g != NULL){
987
912
for(char **a = g->argv + 1; *a != NULL; a++){
988
913
if(not add_argument(p, *a)){
989
error(0, errno, "add_argument");
914
perror("add_argument");
990
915
}
991
916
}
992
917
/* Add global environment variables */
993
918
for(char **e = g->environ; *e != NULL; e++){
994
919
if(not add_environment(p, *e, false)){
995
error(0, errno, "add_environment");
920
perror("add_environment");
996
921
}
997
922
}
998
923
}
999
924
}
1000
/* If this plugin has any environment variables, we need to
1001
duplicate the environment from this process, too. */
925
/* If this plugin has any environment variables, we will call
926
using execve and need to duplicate the environment from this
927
process, too. */
1002
928
if(p->environ[0] != NULL){
1003
929
for(char **e = environ; *e != NULL; e++){
1004
930
if(not add_environment(p, *e, false)){
1005
error(0, errno, "add_environment");
931
perror("add_environment");
1006
932
}
1007
933
}
1008
934
}
1009
935
1010
936
int pipefd[2];
1011
#ifndef O_CLOEXEC
1012
937
ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
1013
#else /* O_CLOEXEC */
1014
ret = (int)TEMP_FAILURE_RETRY(pipe2(pipefd, O_CLOEXEC));
1015
#endif /* O_CLOEXEC */
1016
938
if(ret == -1){
1017
error(0, errno, "pipe");
1018
exitstatus = EX_OSERR;
1019
free(direntries[i]);
1020
goto fallback;
1021
}
1022
if(pipefd[0] >= FD_SETSIZE){
1023
fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
1024
FD_SETSIZE);
1025
close(pipefd[0]);
1026
close(pipefd[1]);
1027
exitstatus = EX_OSERR;
1028
free(direntries[i]);
1029
goto fallback;
1030
}
1031
#ifndef O_CLOEXEC
939
perror("pipe");
940
exitstatus = EXIT_FAILURE;
941
goto fallback;
942
}
1032
943
/* Ask OS to automatic close the pipe on exec */
1033
944
ret = set_cloexec_flag(pipefd[0]);
1034
945
if(ret < 0){
1035
error(0, errno, "set_cloexec_flag");
1036
close(pipefd[0]);
1037
close(pipefd[1]);
1038
exitstatus = EX_OSERR;
1039
free(direntries[i]);
946
perror("set_cloexec_flag");
947
exitstatus = EXIT_FAILURE;
1040
948
goto fallback;
1041
949
}
1042
950
ret = set_cloexec_flag(pipefd[1]);
1043
951
if(ret < 0){
1044
error(0, errno, "set_cloexec_flag");
1045
close(pipefd[0]);
1046
close(pipefd[1]);
1047
exitstatus = EX_OSERR;
1048
free(direntries[i]);
952
perror("set_cloexec_flag");
953
exitstatus = EXIT_FAILURE;
1049
954
goto fallback;
1050
955
}
1051
#endif /* not O_CLOEXEC */
1052
956
/* Block SIGCHLD until process is safely in process list */
1053
957
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
1054
958
&sigchld_action.sa_mask,
1055
959
NULL));
1056
960
if(ret < 0){
1057
error(0, errno, "sigprocmask");
1058
exitstatus = EX_OSERR;
1059
free(direntries[i]);
961
perror("sigprocmask");
962
exitstatus = EXIT_FAILURE;
1060
963
goto fallback;
1061
964
}
1062
965
/* Starting a new process to be watched */
1065
968
pid = fork();
1066
969
} while(pid == -1 and errno == EINTR);
1067
970
if(pid == -1){
1068
error(0, errno, "fork");
1069
TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1070
&sigchld_action.sa_mask, NULL));
1071
close(pipefd[0]);
1072
close(pipefd[1]);
1073
exitstatus = EX_OSERR;
1074
free(direntries[i]);
971
perror("fork");
972
exitstatus = EXIT_FAILURE;
1075
973
goto fallback;
1076
974
}
1077
975
if(pid == 0){
1078
976
/* this is the child process */
1079
977
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1080
978
if(ret < 0){
1081
error(0, errno, "sigaction");
1082
_exit(EX_OSERR);
979
perror("sigaction");
980
_exit(EXIT_FAILURE);
1083
981
}
1084
982
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
1085
983
if(ret < 0){
1086
error(0, errno, "sigprocmask");
1087
_exit(EX_OSERR);
984
perror("sigprocmask");
985
_exit(EXIT_FAILURE);
1088
986
}
1089
987
1090
988
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
1091
989
if(ret == -1){
1092
error(0, errno, "dup2");
1093
_exit(EX_OSERR);
990
perror("dup2");
991
_exit(EXIT_FAILURE);
1094
992
}
1095
993
1096
if(fexecve(plugin_fd, p->argv,
1097
(p->environ[0] != NULL) ? p->environ : environ) < 0){
1098
error(0, errno, "fexecve for %s/%s",
1099
plugindir != NULL ? plugindir : PDIR,
1100
direntries[i]->d_name);
1101
_exit(EX_OSERR);
994
if(dirfd(dir) < 0){
995
/* If dir has no file descriptor, we could not set FD_CLOEXEC
996
above and must now close it manually here. */
997
closedir(dir);
998
}
999
if(p->environ[0] == NULL){
1000
if(execv(filename, p->argv) < 0){
1001
perror("execv");
1002
_exit(EXIT_FAILURE);
1003
}
1004
} else {
1005
if(execve(filename, p->argv, p->environ) < 0){
1006
perror("execve");
1007
_exit(EXIT_FAILURE);
1008
}
1102
1009
}
1103
1010
/* no return */
1104
1011
}
1105
1012
/* Parent process */
1106
close(pipefd[1]); /* Close unused write end of pipe */
1107
close(plugin_fd);
1108
plugin *new_plugin = getplugin(direntries[i]->d_name);
1013
TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
1014
pipe */
1015
free(filename);
1016
plugin *new_plugin = getplugin(dirst->d_name);
1109
1017
if(new_plugin == NULL){
1110
error(0, errno, "getplugin");
1018
perror("getplugin");
1111
1019
ret = (int)(TEMP_FAILURE_RETRY
1112
1020
(sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
1113
1021
NULL)));
1114
1022
if(ret < 0){
1115
error(0, errno, "sigprocmask");
1023
perror("sigprocmask");
1116
1024
}
1117
exitstatus = EX_OSERR;
1118
free(direntries[i]);
1025
exitstatus = EXIT_FAILURE;
1119
1026
goto fallback;
1120
1027
}
1121
free(direntries[i]);
1122
1028
1123
1029
new_plugin->pid = pid;
1124
1030
new_plugin->fd = pipefd[0];
1125
1126
if(debug){
1127
fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
1128
new_plugin->name, (intmax_t) (new_plugin->pid));
1129
}
1130
1031
1131
1032
/* Unblock SIGCHLD so signal handler can be run if this process
1132
1033
has already completed */
1133
1034
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1134
1035
&sigchld_action.sa_mask,
1135
1036
NULL));
1136
1037
if(ret < 0){
1137
error(0, errno, "sigprocmask");
1138
exitstatus = EX_OSERR;
1038
perror("sigprocmask");
1039
exitstatus = EXIT_FAILURE;
1139
1040
goto fallback;
1140
1041
}
1141
1042
1142
FD_SET(new_plugin->fd, &rfds_all);
1043
FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
1044
-Wconversion */
1143
1045
1144
1046
if(maxfd < new_plugin->fd){
1145
1047
maxfd = new_plugin->fd;
1146
1048
}
1147
1049
}
1148
1050
1149
free(direntries);
1150
direntries = NULL;
1151
close(dir_fd);
1152
dir_fd = -1;
1051
TEMP_FAILURE_RETRY(closedir(dir));
1052
dir = NULL;
1153
1053
free_plugin(getplugin(NULL));
1154
1054
1155
1055
for(plugin *p = plugin_list; p != NULL; p = p->next){
1168
1068
fd_set rfds = rfds_all;
1169
1069
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
1170
1070
if(select_ret == -1 and errno != EINTR){
1171
error(0, errno, "select");
1172
exitstatus = EX_OSERR;
1071
perror("select");
1072
exitstatus = EXIT_FAILURE;
1173
1073
goto fallback;
1174
1074
}
1175
1075
/* OK, now either a process completed, or something can be read
1194
1094
(intmax_t) (proc->pid),
1195
1095
WTERMSIG(proc->status),
1196
1096
strsignal(WTERMSIG(proc->status)));
1097
} else if(WCOREDUMP(proc->status)){
1098
fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
1099
" core\n", proc->name, (intmax_t) (proc->pid));
1197
1100
}
1198
1101
}
1199
1102
1200
1103
/* Remove the plugin */
1201
FD_CLR(proc->fd, &rfds_all);
1104
FD_CLR(proc->fd, &rfds_all); /* Spurious warning from
1105
-Wconversion */
1202
1106
1203
1107
/* Block signal while modifying process_list */
1204
1108
ret = (int)TEMP_FAILURE_RETRY(sigprocmask
1206
1110
&sigchld_action.sa_mask,
1207
1111
NULL));
1208
1112
if(ret < 0){
1209
error(0, errno, "sigprocmask");
1210
exitstatus = EX_OSERR;
1113
perror("sigprocmask");
1114
exitstatus = EXIT_FAILURE;
1211
1115
goto fallback;
1212
1116
}
1213
1117
1220
1124
(sigprocmask(SIG_UNBLOCK,
1221
1125
&sigchld_action.sa_mask, NULL)));
1222
1126
if(ret < 0){
1223
error(0, errno, "sigprocmask");
1224
exitstatus = EX_OSERR;
1127
perror("sigprocmask");
1128
exitstatus = EXIT_FAILURE;
1225
1129
goto fallback;
1226
1130
}
1227
1131
1237
1141
bool bret = print_out_password(proc->buffer,
1238
1142
proc->buffer_length);
1239
1143
if(not bret){
1240
error(0, errno, "print_out_password");
1241
exitstatus = EX_IOERR;
1144
perror("print_out_password");
1145
exitstatus = EXIT_FAILURE;
1242
1146
}
1243
1147
goto fallback;
1244
1148
}
1245
1149
1246
1150
/* This process has not completed. Does it have any output? */
1247
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1151
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
1152
warning from
1153
-Wconversion */
1248
1154
/* This process had nothing to say at this time */
1249
1155
proc = proc->next;
1250
1156
continue;
1251
1157
}
1252
1158
/* Before reading, make the process' data buffer large enough */
1253
1159
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1254
char *new_buffer = realloc(proc->buffer, proc->buffer_size
1255
+ (size_t) BUFFER_SIZE);
1256
if(new_buffer == NULL){
1257
error(0, errno, "malloc");
1258
exitstatus = EX_OSERR;
1160
proc->buffer = realloc(proc->buffer, proc->buffer_size
1161
+ (size_t) BUFFER_SIZE);
1162
if(proc->buffer == NULL){
1163
perror("malloc");
1164
exitstatus = EXIT_FAILURE;
1259
1165
goto fallback;
1260
1166
}
1261
proc->buffer = new_buffer;
1262
1167
proc->buffer_size += BUFFER_SIZE;
1263
1168
}
1264
1169
/* Read from the process */
1283
1188
1284
1189
fallback:
1285
1190
1286
if(plugin_list == NULL or (exitstatus != EXIT_SUCCESS
1287
and exitstatus != EX_OK)){
1191
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
1288
1192
/* Fallback if all plugins failed, none are found or an error
1289
1193
occured */
1290
1194
bool bret;
1298
1202
}
1299
1203
bret = print_out_password(passwordbuffer, len);
1300
1204
if(not bret){
1301
error(0, errno, "print_out_password");
1302
exitstatus = EX_IOERR;
1205
perror("print_out_password");
1206
exitstatus = EXIT_FAILURE;
1303
1207
}
1304
1208
}
1305
1209
1306
1210
/* Restore old signal handler */
1307
1211
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1308
1212
if(ret == -1){
1309
error(0, errno, "sigaction");
1310
exitstatus = EX_OSERR;
1213
perror("sigaction");
1214
exitstatus = EXIT_FAILURE;
1311
1215
}
1312
1216
1313
1217
if(custom_argv != NULL){
1317
1221
free(custom_argv);
1318
1222
}
1319
1223
1320
free(direntries);
1321
1322
if(dir_fd != -1){
1323
close(dir_fd);
1224
if(dir != NULL){
1225
closedir(dir);
1324
1226
}
1325
1227
1326
1228
/* Kill the processes */
1330
1232
ret = kill(p->pid, SIGTERM);
1331
1233
if(ret == -1 and errno != ESRCH){
1332
1234
/* Set-uid proccesses might not get closed */
1333
error(0, errno, "kill");
1235
perror("kill");
1334
1236
}
1335
1237
}
1336
1238
}
1340
1242
ret = wait(NULL);
1341
1243
} while(ret >= 0);
1342
1244
if(errno != ECHILD){
1343
error(0, errno, "wait");
1245
perror("wait");
1344
1246
}
1345
1247
1346
1248
free_plugin_list();
1347
1249
1348
1250
free(plugindir);
1349
free(pluginhelperdir);
1350
1251
free(argfile);
1351
1252
1352
1253
return exitstatus;
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0