19
19
* along with this program. If not, see
20
20
* <http://www.gnu.org/licenses/>.
22
* Contact the authors at <mandos@fukt.bsnet.se>.
22
* Contact the authors at <mandos@recompile.se>.
25
25
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
26
asprintf(), O_CLOEXEC */
27
27
#include <stddef.h> /* size_t, NULL */
28
#include <stdlib.h> /* malloc(), exit(), EXIT_FAILURE,
29
EXIT_SUCCESS, realloc() */
28
#include <stdlib.h> /* malloc(), exit(), EXIT_SUCCESS,
30
30
#include <stdbool.h> /* bool, true, false */
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(),
31
#include <stdio.h> /* fileno(), fprintf(),
32
stderr, STDOUT_FILENO, fclose() */
33
#include <sys/types.h> /* fstat(), struct stat, waitpid(),
34
WIFEXITED(), WEXITSTATUS(), wait(),
35
pid_t, uid_t, gid_t, getuid(),
38
37
#include <sys/select.h> /* fd_set, select(), FD_ZERO(),
39
38
FD_SET(), FD_ISSET(), FD_CLR */
40
39
#include <sys/wait.h> /* wait(), waitpid(), WIFEXITED(),
41
40
WEXITSTATUS(), WTERMSIG(),
43
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
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(),
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()
54
52
#include <fcntl.h> /* fcntl(), F_GETFD, F_SETFD,
56
#include <string.h> /* strsep, strlen(), asprintf(),
53
FD_CLOEXEC, openat(), scandirat(),
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,
394
414
.doc = "Group ID the plugins will run as", .group = 3 },
395
415
{ .name = "debug", .key = 132,
396
416
.doc = "Debug mode", .group = 4 },
418
* These reproduce what we would get without ARGP_NO_HELP
420
{ .name = "help", .key = '?',
421
.doc = "Give this help list", .group = -1 },
422
{ .name = "usage", .key = -3,
423
.doc = "Give a short usage message", .group = -1 },
424
{ .name = "version", .key = 'V',
425
.doc = "Print program version", .group = -1 },
400
error_t parse_opt(int key, char *arg, __attribute__((unused))
401
struct argp_state *state){
429
__attribute__((nonnull(3)))
430
error_t parse_opt(int key, char *arg, struct argp_state *state){
405
435
case 'g': /* --global-options */
407
437
char *plugin_option;
408
438
while((plugin_option = strsep(&arg, ",")) != NULL){
409
if(plugin_option[0] == '\0'){
412
439
if(not add_argument(getplugin(NULL), plugin_option)){
413
perror("add_argument");
414
return ARGP_ERR_UNKNOWN;
419
446
case 'G': /* --global-env */
423
if(not add_environment(getplugin(NULL), arg, true)){
424
perror("add_environment");
447
if(add_environment(getplugin(NULL), arg, true)){
427
451
case 'o': /* --options-for */
429
char *plugin_name = strsep(&arg, ":");
430
if(plugin_name[0] == '\0'){
434
while((plugin_option = strsep(&arg, ",")) != NULL){
435
if(not add_argument(getplugin(plugin_name), plugin_option)){
436
perror("add_argument");
437
return ARGP_ERR_UNKNOWN;
453
char *option_list = strchr(arg, ':');
454
if(option_list == NULL){
455
argp_error(state, "No colon in \"%s\"", arg);
462
argp_error(state, "Empty plugin name");
467
while((option = strsep(&option_list, ",")) != NULL){
468
if(not add_argument(getplugin(arg), option)){
442
475
case 'E': /* --env-for */
447
477
char *envdef = strchr(arg, ':');
448
478
if(envdef == NULL){
479
argp_error(state, "No colon in \"%s\"", arg);
452
if(not add_environment(getplugin(arg), envdef+1, true)){
453
perror("add_environment");
486
argp_error(state, "Empty plugin name");
490
if(add_environment(getplugin(arg), envdef, true)){
457
495
case 'd': /* --disable */
459
497
plugin *p = getplugin(arg);
461
return ARGP_ERR_UNKNOWN;
466
504
case 'e': /* --enable */
468
506
plugin *p = getplugin(arg);
470
return ARGP_ERR_UNKNOWN;
475
513
case 128: /* --plugin-dir */
477
515
plugindir = strdup(arg);
478
if(plugindir == NULL){
516
if(plugindir != NULL){
482
520
case 129: /* --config-file */
483
521
/* This is already done by parse_opt_config_file() */
485
523
case 130: /* --userid */
487
tmpmax = strtoimax(arg, &tmp, 10);
524
tmp_id = strtoimax(arg, &tmp, 10);
488
525
if(errno != 0 or tmp == arg or *tmp != '\0'
489
or tmpmax != (uid_t)tmpmax){
490
fprintf(stderr, "Bad user ID number: \"%s\", using %"
491
PRIdMAX "\n", arg, (intmax_t)uid);
526
or tmp_id != (uid_t)tmp_id){
527
argp_error(state, "Bad user ID number: \"%s\", using %"
528
PRIdMAX, arg, (intmax_t)uid);
496
534
case 131: /* --groupid */
498
tmpmax = strtoimax(arg, &tmp, 10);
535
tmp_id = strtoimax(arg, &tmp, 10);
499
536
if(errno != 0 or tmp == arg or *tmp != '\0'
500
or tmpmax != (gid_t)tmpmax){
501
fprintf(stderr, "Bad group ID number: \"%s\", using %"
502
PRIdMAX "\n", arg, (intmax_t)gid);
537
or tmp_id != (gid_t)tmp_id){
538
argp_error(state, "Bad group ID number: \"%s\", using %"
539
PRIdMAX, arg, (intmax_t)gid);
507
545
case 132: /* --debug */
549
* These reproduce what we would get without ARGP_NO_HELP
551
case '?': /* --help */
552
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
553
argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
554
case -3: /* --usage */
555
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
556
argp_state_help(state, state->out_stream,
557
ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
558
case 'V': /* --version */
559
fprintf(state->out_stream, "%s\n", argp_program_version);
511
563
* When adding more options before this line, remember to also add a
512
564
* "case" to the "parse_opt_config_file" function below.
648
716
/* Check for harmful errors and go to fallback. Other errors might
649
717
not affect opening plugins */
650
718
if(errno == EMFILE or errno == ENFILE or errno == ENOMEM){
652
exitstatus = EXIT_FAILURE;
719
error(0, errno, "fopen");
720
exitstatus = EX_OSERR;
656
/* If there was any arguments from configuration file,
657
pass them to parser as command arguments */
724
/* If there were any arguments from the configuration file, pass
725
them to parser as command line arguments */
658
726
if(custom_argv != NULL){
659
ret = argp_parse(&argp, custom_argc, custom_argv, ARGP_IN_ORDER,
661
if(ret == ARGP_ERR_UNKNOWN){
662
fprintf(stderr, "Unknown error while parsing arguments\n");
663
exitstatus = EXIT_FAILURE;
727
ret = argp_parse(&argp, custom_argc, custom_argv,
728
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
736
error(0, errno, "argp_parse");
737
exitstatus = EX_OSERR;
740
exitstatus = EX_CONFIG;
668
745
/* Parse actual command line arguments, to let them override the
670
ret = argp_parse(&argp, argc, argv, ARGP_IN_ORDER, 0, NULL);
671
if(ret == ARGP_ERR_UNKNOWN){
672
fprintf(stderr, "Unknown error while parsing arguments\n");
673
exitstatus = EXIT_FAILURE;
747
ret = argp_parse(&argp, argc, argv,
748
ARGP_IN_ORDER | ARGP_NO_EXIT | ARGP_NO_HELP,
756
error(0, errno, "argp_parse");
757
exitstatus = EX_OSERR;
760
exitstatus = EX_USAGE;
691
/* Strip permissions down to nobody */
779
/* Work around Debian bug #633582:
780
<http://bugs.debian.org/633582> */
781
int plugindir_fd = open(/* plugindir or */ PDIR, O_RDONLY);
782
if(plugindir_fd == -1){
784
error(0, errno, "open(\"" PDIR "\")");
787
ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
789
error(0, errno, "fstat");
791
if(S_ISDIR(st.st_mode) and st.st_uid == 0 and st.st_gid == 0){
792
ret = fchown(plugindir_fd, uid, gid);
794
error(0, errno, "fchown");
798
TEMP_FAILURE_RETRY(close(plugindir_fd));
802
/* Lower permissions */
805
error(0, errno, "setgid");
696
807
ret = setuid(uid);
809
error(0, errno, "setuid");
701
812
/* Open plugin directory with close_on_exec flag */
704
if(plugindir == NULL){
705
dir_fd = open(PDIR, O_RDONLY |
708
#else /* not O_CLOEXEC */
710
#endif /* not O_CLOEXEC */
713
dir_fd = open(plugindir, O_RDONLY |
716
#else /* not O_CLOEXEC */
718
#endif /* not O_CLOEXEC */
814
dir_fd = open(plugindir != NULL ? plugindir : PDIR, O_RDONLY |
817
#else /* not O_CLOEXEC */
819
#endif /* not O_CLOEXEC */
721
821
if(dir_fd == -1){
722
perror("Could not open plugin dir");
723
exitstatus = EXIT_FAILURE;
822
error(0, errno, "Could not open plugin dir");
823
exitstatus = EX_UNAVAILABLE;
728
828
/* Set the FD_CLOEXEC flag on the directory */
729
829
ret = set_cloexec_flag(dir_fd);
731
perror("set_cloexec_flag");
732
TEMP_FAILURE_RETRY(close(dir_fd));
733
exitstatus = EXIT_FAILURE;
831
error(0, errno, "set_cloexec_flag");
832
exitstatus = EX_OSERR;
736
835
#endif /* O_CLOEXEC */
738
dir = fdopendir(dir_fd);
740
perror("Could not open plugin dir");
741
TEMP_FAILURE_RETRY(close(dir_fd));
742
exitstatus = EXIT_FAILURE;
838
int good_name(const struct dirent * const dirent){
839
const char * const patterns[] = { ".*", "#*#", "*~", "*.dpkg-new",
840
"*.dpkg-old", "*.dpkg-bak",
841
"*.dpkg-divert", NULL };
843
#pragma GCC diagnostic push
844
#pragma GCC diagnostic ignored "-Wcast-qual"
846
for(const char **pat = (const char **)patterns;
847
*pat != NULL; pat++){
849
#pragma GCC diagnostic pop
851
if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
854
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
855
" matching pattern %s\n", dirent->d_name, *pat);
864
#if __GLIBC_PREREQ(2, 15)
865
int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
867
#else /* not __GLIBC_PREREQ(2, 15) */
868
int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
869
&direntries, good_name, alphasort);
870
#endif /* not __GLIBC_PREREQ(2, 15) */
871
#else /* not __GLIBC__ */
872
int numplugins = scandir(plugindir != NULL ? plugindir : PDIR,
873
&direntries, good_name, alphasort);
874
#endif /* not __GLIBC__ */
875
if(numplugins == -1){
876
error(0, errno, "Could not scan plugin dir");
878
exitstatus = EX_OSERR;
747
882
FD_ZERO(&rfds_all);
749
884
/* Read and execute any executable in the plugin directory*/
752
dirst = readdir(dir);
753
} while(dirst == NULL and errno == EINTR);
755
/* All directory entries have been processed */
759
exitstatus = EXIT_FAILURE;
765
d_name_len = strlen(dirst->d_name);
767
/* Ignore dotfiles, backup files and other junk */
769
bool bad_name = false;
771
const char const *bad_prefixes[] = { ".", "#", NULL };
773
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
776
".dpkg-divert", NULL };
777
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
778
size_t pre_len = strlen(*pre);
779
if((d_name_len >= pre_len)
780
and strncmp((dirst->d_name), *pre, pre_len) == 0){
782
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
783
" with bad prefix %s\n", dirst->d_name, *pre);
792
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
793
size_t suf_len = strlen(*suf);
794
if((d_name_len >= suf_len)
795
and (strcmp((dirst->d_name)+d_name_len-suf_len, *suf)
798
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
799
" with bad suffix %s\n", dirst->d_name, *suf);
812
if(plugindir == NULL){
813
ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, PDIR "/%s",
816
ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, "%s/%s",
885
for(int i = 0; i < numplugins; i++){
887
int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
889
error(0, errno, "Could not open plugin");
825
ret = (int)TEMP_FAILURE_RETRY(stat(filename, &st));
893
ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
895
error(0, errno, "stat");
896
TEMP_FAILURE_RETRY(close(plugin_fd));
832
901
/* Ignore non-executable files */
833
902
if(not S_ISREG(st.st_mode)
834
or (TEMP_FAILURE_RETRY(access(filename, X_OK)) != 0)){
903
or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
836
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
837
" with bad type or mode\n", filename);
906
fprintf(stderr, "Ignoring plugin dir entry \"%s/%s\""
907
" with bad type or mode\n",
908
plugindir != NULL ? plugindir : PDIR,
909
direntries[i]->d_name);
911
TEMP_FAILURE_RETRY(close(plugin_fd));
843
plugin *p = getplugin(dirst->d_name);
916
plugin *p = getplugin(direntries[i]->d_name);
918
error(0, errno, "getplugin");
919
TEMP_FAILURE_RETRY(close(plugin_fd));
851
925
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
926
direntries[i]->d_name);
928
TEMP_FAILURE_RETRY(close(plugin_fd));
861
936
for(char **a = g->argv + 1; *a != NULL; a++){
862
937
if(not add_argument(p, *a)){
863
perror("add_argument");
938
error(0, errno, "add_argument");
866
941
/* Add global environment variables */
867
942
for(char **e = g->environ; *e != NULL; e++){
868
943
if(not add_environment(p, *e, false)){
869
perror("add_environment");
944
error(0, errno, "add_environment");
874
/* If this plugin has any environment variables, we will call
875
using execve and need to duplicate the environment from this
949
/* If this plugin has any environment variables, we need to
950
duplicate the environment from this process, too. */
877
951
if(p->environ[0] != NULL){
878
952
for(char **e = environ; *e != NULL; e++){
879
953
if(not add_environment(p, *e, false)){
880
perror("add_environment");
954
error(0, errno, "add_environment");
886
961
ret = (int)TEMP_FAILURE_RETRY(pipe(pipefd));
962
#else /* O_CLOEXEC */
963
ret = (int)TEMP_FAILURE_RETRY(pipe2(pipefd, O_CLOEXEC));
964
#endif /* O_CLOEXEC */
889
exitstatus = EXIT_FAILURE;
966
error(0, errno, "pipe");
967
exitstatus = EX_OSERR;
971
if(pipefd[0] >= FD_SETSIZE){
972
fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
974
TEMP_FAILURE_RETRY(close(pipefd[0]));
975
TEMP_FAILURE_RETRY(close(pipefd[1]));
976
exitstatus = EX_OSERR;
892
981
/* Ask OS to automatic close the pipe on exec */
893
982
ret = set_cloexec_flag(pipefd[0]);
895
perror("set_cloexec_flag");
896
exitstatus = EXIT_FAILURE;
984
error(0, errno, "set_cloexec_flag");
985
TEMP_FAILURE_RETRY(close(pipefd[0]));
986
TEMP_FAILURE_RETRY(close(pipefd[1]));
987
exitstatus = EX_OSERR;
899
991
ret = set_cloexec_flag(pipefd[1]);
901
perror("set_cloexec_flag");
902
exitstatus = EXIT_FAILURE;
993
error(0, errno, "set_cloexec_flag");
994
TEMP_FAILURE_RETRY(close(pipefd[0]));
995
TEMP_FAILURE_RETRY(close(pipefd[1]));
996
exitstatus = EX_OSERR;
1000
#endif /* not O_CLOEXEC */
905
1001
/* Block SIGCHLD until process is safely in process list */
906
1002
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
907
1003
&sigchld_action.sa_mask,
910
perror("sigprocmask");
911
exitstatus = EXIT_FAILURE;
1006
error(0, errno, "sigprocmask");
1007
exitstatus = EX_OSERR;
1008
free(direntries[i]);
914
1011
/* Starting a new process to be watched */
918
1015
} while(pid == -1 and errno == EINTR);
921
exitstatus = EXIT_FAILURE;
1017
error(0, errno, "fork");
1018
TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1019
&sigchld_action.sa_mask, NULL));
1020
TEMP_FAILURE_RETRY(close(pipefd[0]));
1021
TEMP_FAILURE_RETRY(close(pipefd[1]));
1022
exitstatus = EX_OSERR;
1023
free(direntries[i]);
925
1027
/* this is the child process */
926
1028
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1030
error(0, errno, "sigaction");
931
1033
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
933
perror("sigprocmask");
1035
error(0, errno, "sigprocmask");
937
1039
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
1041
error(0, errno, "dup2");
944
/* If dir has no file descriptor, we could not set FD_CLOEXEC
945
above and must now close it manually here. */
948
if(p->environ[0] == NULL){
949
if(execv(filename, p->argv) < 0){
954
if(execve(filename, p->argv, p->environ) < 0){
1045
if(fexecve(plugin_fd, p->argv,
1046
(p->environ[0] != NULL) ? p->environ : environ) < 0){
1047
error(0, errno, "fexecve for %s/%s",
1048
plugindir != NULL ? plugindir : PDIR,
1049
direntries[i]->d_name);
961
1054
/* Parent process */
962
1055
TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
965
plugin *new_plugin = getplugin(dirst->d_name);
1057
TEMP_FAILURE_RETRY(close(plugin_fd));
1058
plugin *new_plugin = getplugin(direntries[i]->d_name);
966
1059
if(new_plugin == NULL){
1060
error(0, errno, "getplugin");
968
1061
ret = (int)(TEMP_FAILURE_RETRY
969
1062
(sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
972
perror("sigprocmask");
1065
error(0, errno, "sigprocmask");
974
exitstatus = EXIT_FAILURE;
1067
exitstatus = EX_OSERR;
1068
free(direntries[i]);
1071
free(direntries[i]);
978
1073
new_plugin->pid = pid;
979
1074
new_plugin->fd = pipefd[0];
1090
1211
bool bret = print_out_password(proc->buffer,
1091
1212
proc->buffer_length);
1093
perror("print_out_password");
1094
exitstatus = EXIT_FAILURE;
1214
error(0, errno, "print_out_password");
1215
exitstatus = EX_IOERR;
1099
1220
/* This process has not completed. Does it have any output? */
1221
#if defined (__GNUC__) and defined (__GLIBC__)
1222
#if not __GLIBC_PREREQ(2, 16)
1223
#pragma GCC diagnostic push
1224
#pragma GCC diagnostic ignored "-Wsign-conversion"
1100
1227
if(proc->eof or not FD_ISSET(proc->fd, &rfds)){ /* Spurious
1233
#if defined (__GNUC__) and defined (__GLIBC__)
1234
#if not __GLIBC_PREREQ(2, 16)
1235
#pragma GCC diagnostic pop
1103
1238
/* This process had nothing to say at this time */
1104
1239
proc = proc->next;
1107
1242
/* Before reading, make the process' data buffer large enough */
1108
1243
if(proc->buffer_length + BUFFER_SIZE > proc->buffer_size){
1109
proc->buffer = realloc(proc->buffer, proc->buffer_size
1110
+ (size_t) BUFFER_SIZE);
1111
if(proc->buffer == NULL){
1113
exitstatus = EXIT_FAILURE;
1244
char *new_buffer = realloc(proc->buffer, proc->buffer_size
1245
+ (size_t) BUFFER_SIZE);
1246
if(new_buffer == NULL){
1247
error(0, errno, "malloc");
1248
exitstatus = EX_OSERR;
1251
proc->buffer = new_buffer;
1116
1252
proc->buffer_size += BUFFER_SIZE;
1118
1254
/* Read from the process */