To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos-client.c
- browse files at revision 50
- compare with another revision
- download diff
- download tarball
- view history from revision 50
- Committer: Teddy Hogeborn
- Date: 2008-08-08 23:28:55 UTC
- mfrom: (24.1.25 mandos)
- Revision ID: teddy@fukt.bsnet.se-20080808232855-2hcaxr9jwwmvetx4
* Makefile: Do DocBook manual conversion in a better way.
* mandos (main): Write a PID file.
* mandos (main): Write a PID file.
- files added:
- network-protocol.txt
- files removed:
- .bzr-builddeb
- debian
- debian/po
- files renamed:
- plugin-runner.c => mandos-client.c
- plugin-runner.xml => mandos-client.xml
- plugins.d/mandos-client.c => plugins.d/password-request.c
- plugins.d/mandos-client.xml => plugins.d/password-request.xml
- files modified:
- Makefile
added
removed
mandos-client.c
2
2
/*
3
3
* Mandos plugin runner - Run Mandos plugins
4
4
*
5
* Copyright © 2008,2009 Teddy Hogeborn
6
* Copyright © 2008,2009 Björn Påhlsson
5
* Copyright © 2007-2008 Teddy Hogeborn & Björn Påhlsson
7
6
*
8
7
* This program is free software: you can redistribute it and/or
9
8
* modify it under the terms of the GNU General Public License as
22
21
* Contact the authors at <mandos@fukt.bsnet.se>.
23
22
*/
24
23
25
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
26
asprintf() */
27
#include <stddef.h> /* size_t, NULL */
28
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
29
EXIT_SUCCESS, realloc() */
30
#include <stdbool.h> /* bool, true, false */
31
#include <stdio.h> /* perror, fileno(), fprintf(),
24
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY() */
25
26
#include <stdio.h> /* popen(), fileno(), fprintf(),
32
27
stderr, STDOUT_FILENO */
33
#include <sys/types.h> /* DIR, opendir(), stat(), struct
34
stat, waitpid(), WIFEXITED(),
35
WEXITSTATUS(), wait(), pid_t,
36
uid_t, gid_t, getuid(), getgid(),
37
dirfd() */
38
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
39
FD_SET(), FD_ISSET(), FD_CLR */
40
#include <sys/wait.h> /* wait(), waitpid(), WIFEXITED(),
41
WEXITSTATUS() */
42
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
43
28
#include <iso646.h> /* and, or, not */
29
#include <sys/types.h> /* DIR, opendir(), stat(),
30
struct stat, waitpid(),
31
WIFEXITED(), WEXITSTATUS(),
32
wait() */
33
#include <sys/wait.h> /* wait() */
44
34
#include <dirent.h> /* DIR, struct dirent, opendir(),
45
readdir(), closedir(), dirfd() */
35
readdir(), closedir() */
36
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
46
37
#include <unistd.h> /* struct stat, stat(), S_ISREG(),
47
fcntl(), setuid(), setgid(),
48
F_GETFD, F_SETFD, FD_CLOEXEC,
49
access(), pipe(), fork(), close()
50
dup2(), STDOUT_FILENO, _exit(),
51
execv(), write(), read(),
52
close() */
53
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
54
FD_CLOEXEC */
55
#include <string.h> /* strsep, strlen(), asprintf() */
38
fcntl() */
39
#include <fcntl.h> /* fcntl() */
40
#include <stddef.h> /* NULL */
41
#include <stdlib.h> /* EXIT_FAILURE */
42
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
43
FD_SET(), FD_ISSET() */
44
#include <string.h> /* strlen(), strcpy(), strcat() */
45
#include <stdbool.h> /* true */
46
#include <sys/wait.h> /* waitpid(), WIFEXITED(),
47
WEXITSTATUS() */
56
48
#include <errno.h> /* errno */
57
#include <argp.h> /* struct argp_option, struct
58
argp_state, struct argp,
59
argp_parse(), ARGP_ERR_UNKNOWN,
60
ARGP_KEY_END, ARGP_KEY_ARG,
61
error_t */
62
#include <signal.h> /* struct sigaction, sigemptyset(),
63
sigaddset(), sigaction(),
64
sigprocmask(), SIG_BLOCK, SIGCHLD,
65
SIG_UNBLOCK, kill() */
66
#include <errno.h> /* errno, EBADF */
67
#include <inttypes.h> /* intmax_t, SCNdMAX, PRIdMAX, */
49
#include <argp.h> /* struct argp_option,
50
struct argp_state, struct argp,
51
argp_parse() */
68
52
69
53
#define BUFFER_SIZE 256
70
54
71
#define PDIR "/lib/mandos/plugins.d"
72
#define AFILE "/conf/conf.d/mandos/plugin-runner.conf"
73
74
const char *argp_program_version = "plugin-runner " VERSION;
75
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
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*/
55
struct process;
56
57
typedef struct process{
86
58
pid_t pid;
87
59
int fd;
88
60
char *buffer;
89
61
size_t buffer_size;
90
62
size_t buffer_length;
91
63
bool eof;
92
volatile sig_atomic_t completed;
64
bool completed;
93
65
int status;
66
struct process *next;
67
} process;
68
69
typedef struct plugin{
70
char *name; /* can be NULL or any plugin name */
71
char **argv;
72
int argc;
73
bool disabled;
94
74
struct plugin *next;
95
75
} plugin;
96
76
97
static plugin *plugin_list = NULL;
98
99
/* Gets an 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){
104
if((p->name == name)
105
or (p->name and name and (strcmp(p->name, name) == 0))){
77
static plugin *getplugin(char *name, plugin **plugin_list){
78
for (plugin *p = *plugin_list; p != NULL; p = p->next){
79
if ((p->name == name)
80
or (p->name and name and (strcmp(p->name, name) == 0))){
106
81
return p;
107
82
}
108
83
}
109
84
/* Create a new plugin */
110
85
plugin *new_plugin = malloc(sizeof(plugin));
111
if(new_plugin == NULL){
112
return NULL;
113
}
114
char *copy_name = NULL;
115
if(name != NULL){
116
copy_name = strdup(name);
117
if(copy_name == NULL){
118
free(new_plugin);
119
return NULL;
120
}
121
}
122
123
*new_plugin = (plugin){ .name = copy_name,
124
.argc = 1,
125
.disabled = false,
126
.next = plugin_list };
127
86
if (new_plugin == NULL){
87
perror("malloc");
88
exit(EXIT_FAILURE);
89
}
90
new_plugin->name = name;
128
91
new_plugin->argv = malloc(sizeof(char *) * 2);
129
if(new_plugin->argv == NULL){
130
free(copy_name);
131
free(new_plugin);
132
return NULL;
92
if (new_plugin->argv == NULL){
93
perror("malloc");
94
exit(EXIT_FAILURE);
133
95
}
134
new_plugin->argv[0] = copy_name;
96
new_plugin->argv[0] = name;
135
97
new_plugin->argv[1] = NULL;
136
137
new_plugin->environ = malloc(sizeof(char *));
138
if(new_plugin->environ == NULL){
139
free(copy_name);
140
free(new_plugin->argv);
141
free(new_plugin);
142
return NULL;
143
}
144
new_plugin->environ[0] = NULL;
145
98
new_plugin->argc = 1;
99
new_plugin->disabled = false;
100
new_plugin->next = *plugin_list;
146
101
/* Append the new plugin to the list */
147
plugin_list = new_plugin;
102
*plugin_list = new_plugin;
148
103
return new_plugin;
149
104
}
150
105
151
/* Helper function for add_argument and add_environment */
152
static bool add_to_char_array(const char *new, char ***array,
153
int *len){
154
/* Resize the pointed-to array to hold one more pointer */
155
*array = realloc(*array, sizeof(char *)
156
* (size_t) ((*len) + 2));
157
/* Malloc check */
158
if(*array == NULL){
159
return false;
160
}
161
/* Make a copy of the new string */
162
char *copy = strdup(new);
163
if(copy == NULL){
164
return false;
165
}
166
/* Insert the copy */
167
(*array)[*len] = copy;
168
(*len)++;
169
/* Add a new terminating NULL pointer to the last element */
170
(*array)[*len] = NULL;
171
return true;
172
}
173
174
/* Add to a plugin's argument vector */
175
static bool add_argument(plugin *p, const char *arg){
176
if(p == NULL){
177
return false;
178
}
179
return add_to_char_array(arg, &(p->argv), &(p->argc));
180
}
181
182
/* Add to a plugin's environment */
183
static bool add_environment(plugin *p, const char *def, bool replace){
184
if(p == NULL){
185
return false;
186
}
187
/* namelen = length of name of environment variable */
188
size_t namelen = (size_t)(strchrnul(def, '=') - def);
189
/* Search for this environment variable */
190
for(char **e = p->environ; *e != NULL; e++){
191
if(strncmp(*e, def, namelen + 1) == 0){
192
/* It already exists */
193
if(replace){
194
char *new = realloc(*e, strlen(def) + 1);
195
if(new == NULL){
196
return false;
197
}
198
*e = new;
199
strcpy(*e, def);
200
}
201
return true;
202
}
203
}
204
return add_to_char_array(def, &(p->environ), &(p->envc));
106
static void addargument(plugin *p, char *arg){
107
p->argv[p->argc] = arg;
108
p->argv = realloc(p->argv, sizeof(char *) * (size_t)(p->argc + 2));
109
if (p->argv == NULL){
110
perror("malloc");
111
exit(EXIT_FAILURE);
112
}
113
p->argc++;
114
p->argv[p->argc] = NULL;
205
115
}
206
116
207
117
/*
209
119
* Descriptor Flags".
210
120
* *Note File Descriptor Flags:(libc)Descriptor Flags.
211
121
*/
212
static int set_cloexec_flag(int fd){
122
static int set_cloexec_flag(int fd)
123
{
213
124
int ret = fcntl(fd, F_GETFD, 0);
214
125
/* If reading the flags failed, return error indication now. */
215
126
if(ret < 0){
219
130
return fcntl(fd, F_SETFD, ret | FD_CLOEXEC);
220
131
}
221
132
222
223
/* Mark processes as completed when they exit, and save their exit
133
const char *argp_program_version = "plugbasedclient 0.9";
134
const char *argp_program_bug_address = "<mandos@fukt.bsnet.se>";
135
136
process *process_list = NULL;
137
138
/* Mark a process as completed when it exits, and save its exit
224
139
status. */
225
static void handle_sigchld(__attribute__((unused)) int sig){
226
int old_errno = errno;
227
while(true){
228
plugin *proc = plugin_list;
229
int status;
230
pid_t pid = waitpid(-1, &status, WNOHANG);
231
if(pid == 0){
232
/* Only still running child processes */
233
break;
234
}
235
if(pid == -1){
236
if(errno == ECHILD){
237
/* No child processes */
238
break;
239
}
240
perror("waitpid");
241
}
242
243
/* A child exited, find it in process_list */
244
while(proc != NULL and proc->pid != pid){
245
proc = proc->next;
246
}
247
if(proc == NULL){
248
/* Process not found in process list */
249
continue;
250
}
251
proc->status = status;
252
proc->completed = 1;
253
}
254
errno = old_errno;
255
}
256
257
/* Prints out a password to stdout */
258
static bool print_out_password(const char *buffer, size_t length){
259
ssize_t ret;
260
for(size_t written = 0; written < length; written += (size_t)ret){
261
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO, buffer + written,
262
length - written));
263
if(ret < 0){
264
return false;
265
}
266
}
267
return true;
268
}
269
270
/* Removes and free a plugin from the plugin list */
271
static void free_plugin(plugin *plugin_node){
272
273
for(char **arg = plugin_node->argv; *arg != NULL; arg++){
274
free(*arg);
275
}
276
free(plugin_node->argv);
277
for(char **env = plugin_node->environ; *env != NULL; env++){
278
free(*env);
279
}
280
free(plugin_node->environ);
281
free(plugin_node->buffer);
282
283
/* Removes the plugin from the singly-linked list */
284
if(plugin_node == plugin_list){
285
/* First one - simple */
286
plugin_list = plugin_list->next;
287
} else {
288
/* Second one or later */
289
for(plugin *p = plugin_list; p != NULL; p = p->next){
290
if(p->next == plugin_node){
291
p->next = plugin_node->next;
292
break;
293
}
294
}
295
}
296
297
free(plugin_node);
298
}
299
300
static void free_plugin_list(void){
301
while(plugin_list != NULL){
302
free_plugin(plugin_list);
303
}
140
void handle_sigchld(__attribute__((unused)) int sig){
141
process *proc = process_list;
142
int status;
143
pid_t pid = wait(&status);
144
while(proc != NULL and proc->pid != pid){
145
proc = proc->next;
146
}
147
if(proc == NULL){
148
/* Process not found in process list */
149
return;
150
}
151
proc->status = status;
152
proc->completed = true;
304
153
}
305
154
306
155
int main(int argc, char *argv[]){
307
char *plugindir = NULL;
308
char *argfile = NULL;
309
FILE *conffp;
156
const char *plugindir = "/conf/conf.d/mandos/plugins.d";
310
157
size_t d_name_len;
311
158
DIR *dir = NULL;
312
159
struct dirent *dirst;
313
160
struct stat st;
314
161
fd_set rfds_all;
315
int ret, numchars, maxfd = 0;
316
ssize_t sret;
317
intmax_t tmpmax;
162
int ret, maxfd = 0;
318
163
uid_t uid = 65534;
319
164
gid_t gid = 65534;
320
165
bool debug = false;
322
167
struct sigaction old_sigchld_action;
323
168
struct sigaction sigchld_action = { .sa_handler = handle_sigchld,
324
169
.sa_flags = SA_NOCLDSTOP };
325
char **custom_argv = NULL;
326
int custom_argc = 0;
170
char *plus_options = NULL;
171
char **plus_argv = NULL;
327
172
328
173
/* Establish a signal handler */
329
174
sigemptyset(&sigchld_action.sa_mask);
330
175
ret = sigaddset(&sigchld_action.sa_mask, SIGCHLD);
331
if(ret == -1){
176
if(ret < 0){
332
177
perror("sigaddset");
333
exitstatus = EXIT_FAILURE;
334
goto fallback;
178
exit(EXIT_FAILURE);
335
179
}
336
180
ret = sigaction(SIGCHLD, &sigchld_action, &old_sigchld_action);
337
if(ret == -1){
181
if(ret < 0){
338
182
perror("sigaction");
339
exitstatus = EXIT_FAILURE;
340
goto fallback;
183
exit(EXIT_FAILURE);
341
184
}
342
185
343
186
/* The options we understand. */
345
188
{ .name = "global-options", .key = 'g',
346
189
.arg = "OPTION[,OPTION[,...]]",
347
190
.doc = "Options passed to all plugins" },
348
{ .name = "global-env", .key = 'G',
349
.arg = "VAR=value",
350
.doc = "Environment variable passed to all plugins" },
351
191
{ .name = "options-for", .key = 'o',
352
192
.arg = "PLUGIN:OPTION[,OPTION[,...]]",
353
193
.doc = "Options passed only to specified plugin" },
354
{ .name = "env-for", .key = 'E',
355
.arg = "PLUGIN:ENV=value",
356
.doc = "Environment variable passed to specified plugin" },
357
194
{ .name = "disable", .key = 'd',
358
195
.arg = "PLUGIN",
359
196
.doc = "Disable a specific plugin", .group = 1 },
360
{ .name = "enable", .key = 'e',
361
.arg = "PLUGIN",
362
.doc = "Enable a specific plugin", .group = 1 },
363
197
{ .name = "plugin-dir", .key = 128,
364
198
.arg = "DIRECTORY",
365
199
.doc = "Specify a different plugin directory", .group = 2 },
366
{ .name = "config-file", .key = 129,
367
.arg = "FILE",
368
.doc = "Specify a different configuration file", .group = 2 },
369
{ .name = "userid", .key = 130,
370
.arg = "ID", .flags = 0,
371
.doc = "User ID the plugins will run as", .group = 3 },
372
{ .name = "groupid", .key = 131,
373
.arg = "ID", .flags = 0,
374
.doc = "Group ID the plugins will run as", .group = 3 },
375
{ .name = "debug", .key = 132,
376
.doc = "Debug mode", .group = 4 },
200
{ .name = "userid", .key = 129,
201
.arg = "ID", .flags = 0,
202
.doc = "User ID the plugins will run as", .group = 2 },
203
{ .name = "groupid", .key = 130,
204
.arg = "ID", .flags = 0,
205
.doc = "Group ID the plugins will run as", .group = 2 },
206
{ .name = "debug", .key = 131,
207
.doc = "Debug mode", .group = 3 },
377
208
{ .name = NULL }
378
209
};
379
210
380
error_t parse_opt(int key, char *arg, __attribute__((unused))
381
struct argp_state *state){
382
switch(key){
383
case 'g': /* --global-options */
384
if(arg != NULL){
385
char *p;
386
while((p = strsep(&arg, ",")) != NULL){
387
if(p[0] == '\0'){
388
continue;
389
}
390
if(not add_argument(getplugin(NULL), p)){
391
perror("add_argument");
392
return ARGP_ERR_UNKNOWN;
393
}
394
}
395
}
396
break;
397
case 'G': /* --global-env */
398
if(arg == NULL){
399
break;
400
}
401
if(not add_environment(getplugin(NULL), arg, true)){
402
perror("add_environment");
403
}
404
break;
405
case 'o': /* --options-for */
406
if(arg != NULL){
407
char *p_name = strsep(&arg, ":");
408
if(p_name[0] == '\0' or arg == NULL){
409
break;
410
}
411
char *opt = strsep(&arg, ":");
412
if(opt[0] == '\0' or opt == NULL){
413
break;
414
}
415
char *p;
416
while((p = strsep(&opt, ",")) != NULL){
417
if(p[0] == '\0'){
418
continue;
419
}
420
if(not add_argument(getplugin(p_name), p)){
421
perror("add_argument");
422
return ARGP_ERR_UNKNOWN;
423
}
424
}
425
}
426
break;
427
case 'E': /* --env-for */
428
if(arg == NULL){
429
break;
430
}
431
{
432
char *envdef = strchr(arg, ':');
433
if(envdef == NULL){
434
break;
435
}
436
*envdef = '\0';
437
if(not add_environment(getplugin(arg), envdef+1, true)){
438
perror("add_environment");
439
}
440
}
441
break;
442
case 'd': /* --disable */
443
if(arg != NULL){
444
plugin *p = getplugin(arg);
445
if(p == NULL){
446
return ARGP_ERR_UNKNOWN;
447
}
448
p->disabled = true;
449
}
450
break;
451
case 'e': /* --enable */
452
if(arg != NULL){
453
plugin *p = getplugin(arg);
454
if(p == NULL){
455
return ARGP_ERR_UNKNOWN;
456
}
457
p->disabled = false;
458
}
459
break;
460
case 128: /* --plugin-dir */
461
free(plugindir);
462
plugindir = strdup(arg);
463
if(plugindir == NULL){
464
perror("strdup");
465
}
466
break;
467
case 129: /* --config-file */
468
/* This is already done by parse_opt_config_file() */
469
break;
470
case 130: /* --userid */
471
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
472
if(ret < 1 or tmpmax != (uid_t)tmpmax
473
or arg[numchars] != '\0'){
474
fprintf(stderr, "Bad user ID number: \"%s\", using %"
475
PRIdMAX "\n", arg, (intmax_t)uid);
476
} else {
477
uid = (uid_t)tmpmax;
478
}
479
break;
480
case 131: /* --groupid */
481
ret = sscanf(arg, "%" SCNdMAX "%n", &tmpmax, &numchars);
482
if(ret < 1 or tmpmax != (gid_t)tmpmax
483
or arg[numchars] != '\0'){
484
fprintf(stderr, "Bad group ID number: \"%s\", using %"
485
PRIdMAX "\n", arg, (intmax_t)gid);
486
} else {
487
gid = (gid_t)tmpmax;
488
}
489
break;
490
case 132: /* --debug */
211
error_t parse_opt (int key, char *arg, struct argp_state *state) {
212
/* Get the INPUT argument from `argp_parse', which we know is a
213
pointer to our plugin list pointer. */
214
plugin **plugins = state->input;
215
switch (key) {
216
case 'g':
217
if (arg != NULL){
218
char *p = strtok(arg, ",");
219
do{
220
addargument(getplugin(NULL, plugins), p);
221
p = strtok(NULL, ",");
222
} while (p != NULL);
223
}
224
break;
225
case 'o':
226
if (arg != NULL){
227
char *name = strtok(arg, ":");
228
char *p = strtok(NULL, ":");
229
if(p != NULL){
230
p = strtok(p, ",");
231
do{
232
addargument(getplugin(name, plugins), p);
233
p = strtok(NULL, ",");
234
} while (p != NULL);
235
}
236
}
237
break;
238
case 'd':
239
if (arg != NULL){
240
getplugin(arg, plugins)->disabled = true;
241
}
242
break;
243
case 128:
244
plugindir = arg;
245
break;
246
case 129:
247
uid = (uid_t)strtol(arg, NULL, 10);
248
break;
249
case 130:
250
gid = (gid_t)strtol(arg, NULL, 10);
251
break;
252
case 131:
491
253
debug = true;
492
254
break;
493
/*
494
* When adding more options before this line, remember to also add a
495
* "case" to the "parse_opt_config_file" function below.
496
*/
497
case ARGP_KEY_ARG:
498
/* Cryptsetup always passes an argument, which is an empty
499
string if "none" was specified in /etc/crypttab. So if
500
argument was empty, we ignore it silently. */
501
if(arg[0] != '\0'){
502
fprintf(stderr, "Ignoring unknown argument \"%s\"\n", arg);
503
}
504
break;
505
case ARGP_KEY_END:
506
break;
507
default:
508
return ARGP_ERR_UNKNOWN;
509
}
510
return 0;
511
}
512
513
/* This option parser is the same as parse_opt() above, except it
514
ignores everything but the --config-file option. */
515
error_t parse_opt_config_file(int key, char *arg,
516
__attribute__((unused))
517
struct argp_state *state){
518
switch(key){
519
case 'g': /* --global-options */
520
case 'G': /* --global-env */
521
case 'o': /* --options-for */
522
case 'E': /* --env-for */
523
case 'd': /* --disable */
524
case 'e': /* --enable */
525
case 128: /* --plugin-dir */
526
break;
527
case 129: /* --config-file */
528
free(argfile);
529
argfile = strdup(arg);
530
if(argfile == NULL){
531
perror("strdup");
532
}
533
break;
534
case 130: /* --userid */
535
case 131: /* --groupid */
536
case 132: /* --debug */
537
case ARGP_KEY_ARG:
538
case ARGP_KEY_END:
539
break;
540
default:
541
return ARGP_ERR_UNKNOWN;
542
}
543
return 0;
544
}
545
546
struct argp argp = { .options = options,
547
.parser = parse_opt_config_file,
548
.args_doc = "",
255
case ARGP_KEY_ARG:
256
if(plus_options != NULL or arg == NULL or arg[0] != '+'){
257
argp_usage (state);
258
}
259
plus_options = arg;
260
break;
261
case ARGP_KEY_END:
262
break;
263
default:
264
return ARGP_ERR_UNKNOWN;
265
}
266
return 0;
267
}
268
269
plugin *plugin_list = NULL;
270
271
struct argp argp = { .options = options, .parser = parse_opt,
272
.args_doc = "[+PLUS_SEPARATED_OPTIONS]",
549
273
.doc = "Mandos plugin runner -- Run plugins" };
550
274
551
/* Parse using parse_opt_config_file() in order to get the custom
552
config file location, if any. */
553
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
554
if(ret == ARGP_ERR_UNKNOWN){
555
fprintf(stderr, "Unknown error while parsing arguments\n");
556
exitstatus = EXIT_FAILURE;
557
goto fallback;
558
}
559
560
/* Reset to the normal argument parser */
561
argp.parser = parse_opt;
562
563
/* Open the configfile if available */
564
if(argfile == NULL){
565
conffp = fopen(AFILE, "r");
566
} else {
567
conffp = fopen(argfile, "r");
568
}
569
if(conffp != NULL){
570
char *org_line = NULL;
571
char *p, *arg, *new_arg, *line;
572
size_t size = 0;
573
const char whitespace_delims[] = " \r\t\f\v\n";
574
const char comment_delim[] = "#";
575
576
custom_argc = 1;
577
custom_argv = malloc(sizeof(char*) * 2);
578
if(custom_argv == NULL){
275
argp_parse (&argp, argc, argv, 0, 0, &plugin_list);
276
277
if(plus_options){
278
/* This is a mangled argument in the form of
279
"+--option+--other-option=parameter+--yet-another-option", etc */
280
/* Make new argc and argv vars, and call argp_parse() again. */
281
plus_options++; /* skip the first '+' character */
282
const char delims[] = "+";
283
char *arg;
284
int new_argc = 1;
285
plus_argv = malloc(sizeof(char*) * 2);
286
if(plus_argv == NULL){
579
287
perror("malloc");
580
288
exitstatus = EXIT_FAILURE;
581
goto fallback;
582
}
583
custom_argv[0] = argv[0];
584
custom_argv[1] = NULL;
585
586
/* for each line in the config file, strip whitespace and ignore
587
commented text */
588
while(true){
589
sret = getline(&org_line, &size, conffp);
590
if(sret == -1){
591
break;
592
}
593
594
line = org_line;
595
arg = strsep(&line, comment_delim);
596
while((p = strsep(&arg, whitespace_delims)) != NULL){
597
if(p[0] == '\0'){
598
continue;
599
}
600
new_arg = strdup(p);
601
if(new_arg == NULL){
602
perror("strdup");
603
exitstatus = EXIT_FAILURE;
604
free(org_line);
605
goto fallback;
606
}
607
608
custom_argc += 1;
609
custom_argv = realloc(custom_argv, sizeof(char *)
610
* ((unsigned int) custom_argc + 1));
611
if(custom_argv == NULL){
612
perror("realloc");
613
exitstatus = EXIT_FAILURE;
614
free(org_line);
615
goto fallback;
616
}
617
custom_argv[custom_argc-1] = new_arg;
618
custom_argv[custom_argc] = NULL;
619
}
620
}
621
free(org_line);
622
} else {
623
/* Check for harmful errors and go to fallback. Other errors might
624
not affect opening plugins */
625
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
626
perror("fopen");
627
exitstatus = EXIT_FAILURE;
628
goto fallback;
629
}
630
}
631
/* If there was any arguments from configuration file,
632
pass them to parser as command arguments */
633
if(custom_argv != NULL){
634
ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
635
0, NULL);
636
if(ret == ARGP_ERR_UNKNOWN){
637
fprintf(stderr, "Unknown error while parsing arguments\n");
638
exitstatus = EXIT_FAILURE;
639
goto fallback;
640
}
641
}
642
643
/* Parse actual command line arguments, to let them override the
644
config file */
645
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
646
if(ret == ARGP_ERR_UNKNOWN){
647
fprintf(stderr, "Unknown error while parsing arguments\n");
648
exitstatus = EXIT_FAILURE;
649
goto fallback;
289
goto end;
290
}
291
plus_argv[0] = argv[0];
292
plus_argv[1] = NULL;
293
arg = strtok(plus_options, delims); /* Get first argument */
294
while(arg != NULL){
295
new_argc++;
296
plus_argv = realloc(plus_argv, sizeof(char *)
297
* ((unsigned int) new_argc + 1));
298
if(plus_argv == NULL){
299
perror("malloc");
300
exitstatus = EXIT_FAILURE;
301
goto end;
302
}
303
plus_argv[new_argc-1] = arg;
304
plus_argv[new_argc] = NULL;
305
arg = strtok(NULL, delims); /* Get next argument */
306
}
307
argp_parse (&argp, new_argc, plus_argv, 0, 0, &plugin_list);
650
308
}
651
309
652
310
if(debug){
656
314
for(char **a = p->argv; *a != NULL; a++){
657
315
fprintf(stderr, "\tArg: %s\n", *a);
658
316
}
659
fprintf(stderr, "...and %d environment variables\n", p->envc);
660
for(char **a = p->environ; *a != NULL; a++){
661
fprintf(stderr, "\t%s\n", *a);
662
}
663
317
}
664
318
}
665
319
666
/* Strip permissions down to nobody */
320
ret = setuid(uid);
321
if (ret == -1){
322
perror("setuid");
323
}
324
667
325
setgid(gid);
668
if(ret == -1){
326
if (ret == -1){
669
327
perror("setgid");
670
328
}
671
ret = setuid(uid);
672
if(ret == -1){
673
perror("setuid");
674
}
675
676
if(plugindir == NULL){
677
dir = opendir(PDIR);
678
} else {
679
dir = opendir(plugindir);
680
}
681
329
330
dir = opendir(plugindir);
682
331
if(dir == NULL){
683
332
perror("Could not open plugin dir");
684
333
exitstatus = EXIT_FAILURE;
685
goto fallback;
334
goto end;
686
335
}
687
336
688
337
/* Set the FD_CLOEXEC flag on the directory, if possible */
693
342
if(ret < 0){
694
343
perror("set_cloexec_flag");
695
344
exitstatus = EXIT_FAILURE;
696
goto fallback;
345
goto end;
697
346
}
698
347
}
699
348
}
700
349
701
350
FD_ZERO(&rfds_all);
702
351
703
/* Read and execute any executable in the plugin directory*/
704
352
while(true){
705
353
dirst = readdir(dir);
706
354
707
/* All directory entries have been processed */
355
// All directory entries have been processed
708
356
if(dirst == NULL){
709
if(errno == EBADF){
710
perror("readdir");
711
exitstatus = EXIT_FAILURE;
712
goto fallback;
713
}
714
357
break;
715
358
}
716
359
717
360
d_name_len = strlen(dirst->d_name);
718
361
719
/* Ignore dotfiles, backup files and other junk */
362
// Ignore dotfiles, backup files and other junk
720
363
{
721
364
bool bad_name = false;
722
365
724
367
725
368
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
726
369
".dpkg-old",
727
".dpkg-bak",
728
370
".dpkg-divert", NULL };
729
371
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
730
372
size_t pre_len = strlen(*pre);
738
380
break;
739
381
}
740
382
}
383
741
384
if(bad_name){
742
385
continue;
743
386
}
387
744
388
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
745
389
size_t suf_len = strlen(*suf);
746
390
if((d_name_len >= suf_len)
759
403
continue;
760
404
}
761
405
}
762
763
char *filename;
764
if(plugindir == NULL){
765
ret = asprintf(&filename, PDIR "/%s", dirst->d_name);
766
} else {
767
ret = asprintf(&filename, "%s/%s", plugindir, dirst->d_name);
768
}
769
if(ret < 0){
770
perror("asprintf");
771
continue;
772
}
773
774
ret = stat(filename, &st);
775
if(ret == -1){
776
perror("stat");
777
free(filename);
778
continue;
779
}
780
781
/* Ignore non-executable files */
782
if(not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
406
407
char *filename = malloc(d_name_len + strlen(plugindir) + 2);
408
if (filename == NULL){
409
perror("malloc");
410
exitstatus = EXIT_FAILURE;
411
goto end;
412
}
413
strcpy(filename, plugindir); /* Spurious warning */
414
strcat(filename, "/"); /* Spurious warning */
415
strcat(filename, dirst->d_name); /* Spurious warning */
416
417
stat(filename, &st);
418
419
if (not S_ISREG(st.st_mode) or (access(filename, X_OK) != 0)){
783
420
if(debug){
784
421
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
785
422
" with bad type or mode\n", filename);
787
424
free(filename);
788
425
continue;
789
426
}
790
791
plugin *p = getplugin(dirst->d_name);
792
if(p == NULL){
793
perror("getplugin");
794
free(filename);
795
continue;
796
}
797
if(p->disabled){
427
if(getplugin(dirst->d_name, &plugin_list)->disabled){
798
428
if(debug){
799
429
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
800
430
dirst->d_name);
802
432
free(filename);
803
433
continue;
804
434
}
435
plugin *p = getplugin(dirst->d_name, &plugin_list);
805
436
{
806
437
/* Add global arguments to argument list for this plugin */
807
plugin *g = getplugin(NULL);
808
if(g != NULL){
809
for(char **a = g->argv + 1; *a != NULL; a++){
810
if(not add_argument(p, *a)){
811
perror("add_argument");
812
}
813
}
814
/* Add global environment variables */
815
for(char **e = g->environ; *e != NULL; e++){
816
if(not add_environment(p, *e, false)){
817
perror("add_environment");
818
}
819
}
820
}
821
}
822
/* If this plugin has any environment variables, we will call
823
using execve and need to duplicate the environment from this
824
process, too. */
825
if(p->environ[0] != NULL){
826
for(char **e = environ; *e != NULL; e++){
827
if(not add_environment(p, *e, false)){
828
perror("add_environment");
829
}
830
}
831
}
832
833
int pipefd[2];
438
plugin *g = getplugin(NULL, &plugin_list);
439
for(char **a = g->argv + 1; *a != NULL; a++){
440
addargument(p, *a);
441
}
442
}
443
int pipefd[2];
834
444
ret = pipe(pipefd);
835
if(ret == -1){
445
if (ret == -1){
836
446
perror("pipe");
837
447
exitstatus = EXIT_FAILURE;
838
goto fallback;
448
goto end;
839
449
}
840
/* Ask OS to automatic close the pipe on exec */
841
450
ret = set_cloexec_flag(pipefd[0]);
842
451
if(ret < 0){
843
452
perror("set_cloexec_flag");
844
453
exitstatus = EXIT_FAILURE;
845
goto fallback;
454
goto end;
846
455
}
847
456
ret = set_cloexec_flag(pipefd[1]);
848
457
if(ret < 0){
849
458
perror("set_cloexec_flag");
850
459
exitstatus = EXIT_FAILURE;
851
goto fallback;
460
goto end;
852
461
}
853
462
/* Block SIGCHLD until process is safely in process list */
854
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
463
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
855
464
if(ret < 0){
856
465
perror("sigprocmask");
857
466
exitstatus = EXIT_FAILURE;
858
goto fallback;
467
goto end;
859
468
}
860
/* Starting a new process to be watched */
469
// Starting a new process to be watched
861
470
pid_t pid = fork();
862
if(pid == -1){
863
perror("fork");
864
exitstatus = EXIT_FAILURE;
865
goto fallback;
866
}
867
471
if(pid == 0){
868
472
/* this is the child process */
869
473
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
871
475
perror("sigaction");
872
476
_exit(EXIT_FAILURE);
873
477
}
874
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
478
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
875
479
if(ret < 0){
876
480
perror("sigprocmask");
877
481
_exit(EXIT_FAILURE);
878
482
}
879
880
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
881
if(ret == -1){
882
perror("dup2");
883
_exit(EXIT_FAILURE);
884
}
483
dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
885
484
886
485
if(dirfd(dir) < 0){
887
486
/* If dir has no file descriptor, we could not set FD_CLOEXEC
888
487
above and must now close it manually here. */
889
488
closedir(dir);
890
489
}
891
if(p->environ[0] == NULL){
892
if(execv(filename, p->argv) < 0){
893
perror("execv");
894
_exit(EXIT_FAILURE);
895
}
896
} else {
897
if(execve(filename, p->argv, p->environ) < 0){
898
perror("execve");
899
_exit(EXIT_FAILURE);
900
}
490
if(execv(filename, p->argv) < 0){
491
perror("execv");
492
_exit(EXIT_FAILURE);
901
493
}
902
494
/* no return */
903
495
}
904
/* Parent process */
905
close(pipefd[1]); /* Close unused write end of pipe */
496
/* parent process */
906
497
free(filename);
907
plugin *new_plugin = getplugin(dirst->d_name);
908
if(new_plugin == NULL){
909
perror("getplugin");
910
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
498
close(pipefd[1]); /* close unused write end of pipe */
499
process *new_process = malloc(sizeof(process));
500
if (new_process == NULL){
501
perror("malloc");
502
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
911
503
if(ret < 0){
912
perror("sigprocmask");
504
perror("sigprocmask");
913
505
}
914
506
exitstatus = EXIT_FAILURE;
915
goto fallback;
507
goto end;
916
508
}
917
509
918
new_plugin->pid = pid;
919
new_plugin->fd = pipefd[0];
920
510
*new_process = (struct process){ .pid = pid,
511
.fd = pipefd[0],
512
.next = process_list };
513
// List handling
514
process_list = new_process;
921
515
/* Unblock SIGCHLD so signal handler can be run if this process
922
516
has already completed */
923
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
517
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
924
518
if(ret < 0){
925
519
perror("sigprocmask");
926
520
exitstatus = EXIT_FAILURE;
927
goto fallback;
928
}
929
930
FD_SET(new_plugin->fd, &rfds_all);
931
932
if(maxfd < new_plugin->fd){
933
maxfd = new_plugin->fd;
934
}
521
goto end;
522
}
523
524
FD_SET(new_process->fd, &rfds_all);
525
526
if (maxfd < new_process->fd){
527
maxfd = new_process->fd;
528
}
529
530
}
531
532
/* Free the plugin list */
533
for(plugin *next; plugin_list != NULL; plugin_list = next){
534
next = plugin_list->next;
535
free(plugin_list->argv);
536
free(plugin_list);
935
537
}
936
538
937
539
closedir(dir);
938
540
dir = NULL;
939
541
940
for(plugin *p = plugin_list; p != NULL; p = p->next){
941
if(p->pid != 0){
942
break;
943
}
944
if(p->next == NULL){
945
fprintf(stderr, "No plugin processes started. Incorrect plugin"
946
" directory?\n");
947
free_plugin_list();
948
}
542
if (process_list == NULL){
543
fprintf(stderr, "No plugin processes started, exiting\n");
544
exitstatus = EXIT_FAILURE;
545
goto end;
949
546
}
950
951
/* Main loop while running plugins exist */
952
while(plugin_list){
547
while(process_list){
953
548
fd_set rfds = rfds_all;
954
549
int select_ret = select(maxfd+1, &rfds, NULL, NULL, NULL);
955
if(select_ret == -1){
550
if (select_ret == -1){
956
551
perror("select");
957
552
exitstatus = EXIT_FAILURE;
958
goto fallback;
553
goto end;
959
554
}
960
555
/* OK, now either a process completed, or something can be read
961
556
from one of them */
962
for(plugin *proc = plugin_list; proc != NULL;){
557
for(process *proc = process_list; proc ; proc = proc->next){
963
558
/* Is this process completely done? */
964
if(proc->completed and proc->eof){
559
if(proc->eof and proc->completed){
965
560
/* Only accept the plugin output if it exited cleanly */
966
561
if(not WIFEXITED(proc->status)
967
562
or WEXITSTATUS(proc->status) != 0){
968
563
/* Bad exit by plugin */
969
970
564
if(debug){
971
565
if(WIFEXITED(proc->status)){
972
fprintf(stderr, "Plugin %s [%" PRIdMAX "] exited with"
973
" status %d\n", proc->name,
974
(intmax_t) (proc->pid),
975
WEXITSTATUS(proc->status));
976
} else if(WIFSIGNALED(proc->status)){
977
fprintf(stderr, "Plugin %s [%" PRIdMAX "] killed by"
978
" signal %d\n", proc->name,
979
(intmax_t) (proc->pid),
980
WTERMSIG(proc->status));
566
fprintf(stderr, "Plugin %d exited with status %d\n",
567
proc->pid, WEXITSTATUS(proc->status));
568
} else if(WIFSIGNALED(proc->status)) {
569
fprintf(stderr, "Plugin %d killed by signal %d\n",
570
proc->pid, WTERMSIG(proc->status));
981
571
} else if(WCOREDUMP(proc->status)){
982
fprintf(stderr, "Plugin %s [%" PRIdMAX "] dumped"
983
" core\n", proc->name, (intmax_t) (proc->pid));
572
fprintf(stderr, "Plugin %d dumped core\n", proc->pid);
984
573
}
985
574
}
986
987
575
/* Remove the plugin */
988
576
FD_CLR(proc->fd, &rfds_all);
989
990
577
/* Block signal while modifying process_list */
991
ret = sigprocmask(SIG_BLOCK, &sigchld_action.sa_mask, NULL);
578
ret = sigprocmask (SIG_BLOCK, &sigchld_action.sa_mask, NULL);
992
579
if(ret < 0){
993
580
perror("sigprocmask");
994
581
exitstatus = EXIT_FAILURE;
995
goto fallback;
996
}
997
998
plugin *next_plugin = proc->next;
999
free_plugin(proc);
1000
proc = next_plugin;
1001
582
goto end;
583
}
584
/* Delete this process entry from the list */
585
if(process_list == proc){
586
/* First one - simple */
587
process_list = proc->next;
588
} else {
589
/* Second one or later */
590
for(process *p = process_list; p != NULL; p = p->next){
591
if(p->next == proc){
592
p->next = proc->next;
593
break;
594
}
595
}
596
}
1002
597
/* We are done modifying process list, so unblock signal */
1003
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
1004
NULL);
598
ret = sigprocmask (SIG_UNBLOCK, &sigchld_action.sa_mask,
599
NULL);
1005
600
if(ret < 0){
1006
601
perror("sigprocmask");
1007
exitstatus = EXIT_FAILURE;
1008
goto fallback;
1009
}
1010
1011
if(plugin_list == NULL){
1012
break;
1013
}
1014
1015
continue;
602
}
603
free(proc->buffer);
604
free(proc);
605
/* We deleted this process from the list, so we can't go
606
proc->next. Therefore, start over from the beginning of
607
the process list */
608
break;
1016
609
}
1017
1018
610
/* This process exited nicely, so print its buffer */
1019
1020
bool bret = print_out_password(proc->buffer,
1021
proc->buffer_length);
1022
if(not bret){
1023
perror("print_out_password");
1024
exitstatus = EXIT_FAILURE;
611
for(size_t written = 0; written < proc->buffer_length;
612
written += (size_t)ret){
613
ret = TEMP_FAILURE_RETRY(write(STDOUT_FILENO,
614
proc->buffer + written,
615
proc->buffer_length
616
- written));
617
if(ret < 0){
618
perror("write");
619
exitstatus = EXIT_FAILURE;
620
goto end;
621
}
1025
622
}
1026
goto fallback;
623
goto end;
1027
624
}
1028
1029
625
/* This process has not completed. Does it have any output? */
1030
626
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){
1031
627
/* This process had nothing to say at this time */
1032
proc = proc->next;
1033
628
continue;
1034
629
}
1035
630
/* Before reading, make the process' data buffer large enough */
1036
631
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1037
632
proc->buffer = realloc(proc->buffer, proc->buffer_size
1038
633
+ (size_t) BUFFER_SIZE);
1039
if(proc->buffer == NULL){
634
if (proc->buffer == NULL){
1040
635
perror("malloc");
1041
636
exitstatus = EXIT_FAILURE;
1042
goto fallback;
637
goto end;
1043
638
}
1044
639
proc->buffer_size += BUFFER_SIZE;
1045
640
}
1046
641
/* Read from the process */
1047
sret = read(proc->fd, proc->buffer + proc->buffer_length,
1048
BUFFER_SIZE);
1049
if(sret < 0){
642
ret = read(proc->fd, proc->buffer + proc->buffer_length,
643
BUFFER_SIZE);
644
if(ret < 0){
1050
645
/* Read error from this process; ignore the error */
1051
proc = proc->next;
1052
646
continue;
1053
647
}
1054
if(sret == 0){
648
if(ret == 0){
1055
649
/* got EOF */
1056
650
proc->eof = true;
1057
651
} else {
1058
proc->buffer_length += (size_t) sret;
652
proc->buffer_length += (size_t) ret;
1059
653
}
1060
654
}
1061
655
}
1062
1063
1064
fallback:
1065
1066
if(plugin_list == NULL or exitstatus != EXIT_SUCCESS){
1067
/* Fallback if all plugins failed, none are found or an error
1068
occured */
1069
bool bret;
1070
fprintf(stderr, "Going to fallback mode using getpass(3)\n");
1071
char *passwordbuffer = getpass("Password: ");
1072
size_t len = strlen(passwordbuffer);
1073
/* Strip trailing newline */
1074
if(len > 0 and passwordbuffer[len-1] == '\n'){
1075
passwordbuffer[len-1] = '\0'; /* not strictly necessary */
1076
len--;
1077
}
1078
bret = print_out_password(passwordbuffer, len);
1079
if(not bret){
1080
perror("print_out_password");
1081
exitstatus = EXIT_FAILURE;
1082
}
656
if(process_list == NULL){
657
fprintf(stderr, "All plugin processes failed, exiting\n");
658
exitstatus = EXIT_FAILURE;
1083
659
}
1084
660
661
end:
1085
662
/* Restore old signal handler */
1086
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1087
if(ret == -1){
1088
perror("sigaction");
1089
exitstatus = EXIT_FAILURE;
1090
}
1091
1092
if(custom_argv != NULL){
1093
for(char **arg = custom_argv+1; *arg != NULL; arg++){
1094
free(*arg);
1095
}
1096
free(custom_argv);
663
sigaction(SIGCHLD, &old_sigchld_action, NULL);
664
665
free(plus_argv);
666
667
/* Free the plugin list */
668
for(plugin *next; plugin_list != NULL; plugin_list = next){
669
next = plugin_list->next;
670
free(plugin_list->argv);
671
free(plugin_list);
1097
672
}
1098
673
1099
674
if(dir != NULL){
1100
675
closedir(dir);
1101
676
}
1102
677
1103
/* Kill the processes */
1104
for(plugin *p = plugin_list; p != NULL; p = p->next){
1105
if(p->pid != 0){
1106
close(p->fd);
1107
ret = kill(p->pid, SIGTERM);
1108
if(ret == -1 and errno != ESRCH){
1109
/* Set-uid proccesses might not get closed */
1110
perror("kill");
1111
}
1112
}
678
/* Free the process list and kill the processes */
679
for(process *next; process_list != NULL; process_list = next){
680
next = process_list->next;
681
close(process_list->fd);
682
kill(process_list->pid, SIGTERM);
683
free(process_list->buffer);
684
free(process_list);
1113
685
}
1114
686
1115
687
/* Wait for any remaining child processes to terminate */
1120
692
perror("wait");
1121
693
}
1122
694
1123
free_plugin_list();
1124
1125
free(plugindir);
1126
free(argfile);
1127
1128
695
return exitstatus;
1129
696
}
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0