3
3
* Mandos plugin runner - Run Mandos plugins
5
* Copyright © 2008,2009 Teddy Hogeborn
6
* Copyright © 2008,2009 Björn Påhlsson
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.
13
* This program is distributed in the hope that it will be useful, but
5
* Copyright © 2008-2020 Teddy Hogeborn
6
* Copyright © 2008-2020 Björn Påhlsson
8
* This file is part of Mandos.
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.
15
* Mandos is distributed in the hope that it will be useful, but
14
16
* WITHOUT ANY WARRANTY; without even the implied warranty of
15
17
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
18
* General Public License for more details.
18
20
* You should have received a copy of the GNU General Public License
19
* along with this program. If not, see
20
* <http://www.gnu.org/licenses/>.
21
* along with Mandos. If not, see <http://www.gnu.org/licenses/>.
22
* Contact the authors at <mandos@fukt.bsnet.se>.
23
* Contact the authors at <mandos@recompile.se>.
25
26
#define _GNU_SOURCE /* TEMP_FAILURE_RETRY(), getline(),
26
asprintf(), O_CLOEXEC */
27
28
#include <stddef.h> /* size_t, NULL */
28
#include <stdlib.h> /* malloc(), exit(), EXIT_SUCCESS,
29
#include <stdlib.h> /* malloc(), reallocarray(), realloc(),
30
EXIT_SUCCESS, exit() */
30
31
#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(),
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(),
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(),
43
#include <sys/stat.h> /* struct stat, stat(), S_ISREG() */
41
WEXITSTATUS(), WTERMSIG() */
42
#include <sys/stat.h> /* struct stat, fstat(), S_ISREG() */
44
43
#include <iso646.h> /* and, or, not */
45
#include <dirent.h> /* DIR, struct dirent, fdopendir(),
46
readdir(), closedir(), dirfd() */
47
#include <unistd.h> /* struct stat, stat(), S_ISREG(),
48
fcntl(), setuid(), setgid(),
49
F_GETFD, F_SETFD, FD_CLOEXEC,
50
access(), pipe(), fork(), close()
51
dup2(), STDOUT_FILENO, _exit(),
52
execv(), write(), read(),
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(),
57
strsignal(), strcmp(), strncmp() */
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,
486
524
plugin *p = getplugin(arg);
488
526
p->disabled = false;
492
531
case 128: /* --plugin-dir */
494
533
plugindir = strdup(arg);
534
if(plugindir != NULL){
496
538
case 129: /* --config-file */
497
539
/* This is already done by parse_opt_config_file() */
499
541
case 130: /* --userid */
500
tmpmax = strtoimax(arg, &tmp, 10);
542
tmp_id = strtoimax(arg, &tmp, 10);
501
543
if(errno != 0 or tmp == arg or *tmp != '\0'
502
or tmpmax != (uid_t)tmpmax){
544
or tmp_id != (uid_t)tmp_id){
503
545
argp_error(state, "Bad user ID number: \"%s\", using %"
504
546
PRIdMAX, arg, (intmax_t)uid);
509
552
case 131: /* --groupid */
510
tmpmax = strtoimax(arg, &tmp, 10);
553
tmp_id = strtoimax(arg, &tmp, 10);
511
554
if(errno != 0 or tmp == arg or *tmp != '\0'
512
or tmpmax != (gid_t)tmpmax){
555
or tmp_id != (gid_t)tmp_id){
513
556
argp_error(state, "Bad group ID number: \"%s\", using %"
514
557
PRIdMAX, arg, (intmax_t)gid);
519
563
case 132: /* --debug */
566
case 133: /* --plugin-helper-dir */
567
free(pluginhelperdir);
568
pluginhelperdir = strdup(arg);
569
if(pluginhelperdir != NULL){
523
574
* These reproduce what we would get without ARGP_NO_HELP
525
576
case '?': /* --help */
526
577
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
527
578
argp_state_help(state, state->out_stream, ARGP_HELP_STD_HELP);
579
__builtin_unreachable();
528
580
case -3: /* --usage */
529
581
state->flags &= ~(unsigned int)ARGP_NO_EXIT; /* force exit */
530
582
argp_state_help(state, state->out_stream,
531
583
ARGP_HELP_USAGE | ARGP_HELP_EXIT_OK);
584
__builtin_unreachable();
532
585
case 'V': /* --version */
533
586
fprintf(state->out_stream, "%s\n", argp_program_version);
534
587
exit(EXIT_SUCCESS);
743
/* Strip permissions down to nobody */
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){
845
error(0, errno, "open(\"" PDIR "\")");
848
ret = (int)TEMP_FAILURE_RETRY(fstat(plugindir_fd, &st));
850
error(0, errno, "fstat");
852
if(S_ISDIR(st.st_mode) and st.st_uid == 0 and st.st_gid == 0){
853
ret = fchown(plugindir_fd, uid, gid);
855
error(0, errno, "fchown");
863
/* Lower permissions */
866
error(0, errno, "setgid");
748
868
ret = setuid(uid);
870
error(0, errno, "setuid");
753
873
/* Open plugin directory with close_on_exec flag */
756
if(plugindir == NULL){
757
dir_fd = open(PDIR, O_RDONLY |
760
#else /* not O_CLOEXEC */
762
#endif /* not O_CLOEXEC */
765
dir_fd = open(plugindir, O_RDONLY |
768
#else /* not O_CLOEXEC */
770
#endif /* not O_CLOEXEC */
875
dir_fd = open(plugindir != NULL ? plugindir : PDIR, O_RDONLY |
878
#else /* not O_CLOEXEC */
880
#endif /* not O_CLOEXEC */
773
882
if(dir_fd == -1){
774
perror("Could not open plugin dir");
883
error(0, errno, "Could not open plugin dir");
775
884
exitstatus = EX_UNAVAILABLE;
780
889
/* Set the FD_CLOEXEC flag on the directory */
781
890
ret = set_cloexec_flag(dir_fd);
783
perror("set_cloexec_flag");
784
TEMP_FAILURE_RETRY(close(dir_fd));
892
error(0, errno, "set_cloexec_flag");
785
893
exitstatus = EX_OSERR;
788
896
#endif /* O_CLOEXEC */
790
dir = fdopendir(dir_fd);
792
perror("Could not open plugin dir");
793
TEMP_FAILURE_RETRY(close(dir_fd));
794
exitstatus = EX_OSERR;
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 };
904
#pragma GCC diagnostic push
905
#pragma GCC diagnostic ignored "-Wcast-qual"
907
for(const char **pat = (const char **)patterns;
908
*pat != NULL; pat++){
910
#pragma GCC diagnostic pop
912
if(fnmatch(*pat, dirent->d_name, FNM_FILE_NAME | FNM_PERIOD)
915
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
916
" matching pattern %s\n", dirent->d_name, *pat);
924
int numplugins = scandirat(dir_fd, ".", &direntries, good_name,
926
if(numplugins == -1){
927
error(0, errno, "Could not scan plugin dir");
929
exitstatus = EX_OSERR;
799
933
FD_ZERO(&rfds_all);
801
935
/* Read and execute any executable in the plugin directory*/
804
dirst = readdir(dir);
805
} while(dirst == NULL and errno == EINTR);
807
/* All directory entries have been processed */
811
exitstatus = EX_IOERR;
817
d_name_len = strlen(dirst->d_name);
819
/* Ignore dotfiles, backup files and other junk */
821
bool bad_name = false;
823
const char const *bad_prefixes[] = { ".", "#", NULL };
825
const char const *bad_suffixes[] = { "~", "#", ".dpkg-new",
828
".dpkg-divert", NULL };
829
for(const char **pre = bad_prefixes; *pre != NULL; pre++){
830
size_t pre_len = strlen(*pre);
831
if((d_name_len >= pre_len)
832
and strncmp((dirst->d_name), *pre, pre_len) == 0){
834
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
835
" with bad prefix %s\n", dirst->d_name, *pre);
844
for(const char **suf = bad_suffixes; *suf != NULL; suf++){
845
size_t suf_len = strlen(*suf);
846
if((d_name_len >= suf_len)
847
and (strcmp((dirst->d_name) + d_name_len-suf_len, *suf)
850
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
851
" with bad suffix %s\n", dirst->d_name, *suf);
864
if(plugindir == NULL){
865
ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, PDIR "/%s",
868
ret = (int)TEMP_FAILURE_RETRY(asprintf(&filename, "%s/%s",
936
for(int i = 0; i < numplugins; i++){
938
int plugin_fd = openat(dir_fd, direntries[i]->d_name, O_RDONLY);
940
error(0, errno, "Could not open plugin");
877
ret = (int)TEMP_FAILURE_RETRY(stat(filename, &st));
944
ret = (int)TEMP_FAILURE_RETRY(fstat(plugin_fd, &st));
946
error(0, errno, "stat");
884
952
/* Ignore non-executable files */
885
953
if(not S_ISREG(st.st_mode)
886
or (TEMP_FAILURE_RETRY(access(filename, X_OK)) != 0)){
954
or (TEMP_FAILURE_RETRY(faccessat(dir_fd, direntries[i]->d_name,
888
fprintf(stderr, "Ignoring plugin dir entry \"%s\""
889
" with bad type or mode\n", filename);
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);
895
plugin *p = getplugin(dirst->d_name);
967
plugin *p = getplugin(direntries[i]->d_name);
969
error(0, errno, "getplugin");
903
976
fprintf(stderr, "Ignoring disabled plugin \"%s\"\n",
977
direntries[i]->d_name);
913
987
for(char **a = g->argv + 1; *a != NULL; a++){
914
988
if(not add_argument(p, *a)){
915
perror("add_argument");
989
error(0, errno, "add_argument");
918
992
/* Add global environment variables */
919
993
for(char **e = g->environ; *e != NULL; e++){
920
994
if(not add_environment(p, *e, false)){
921
perror("add_environment");
995
error(0, errno, "add_environment");
926
/* If this plugin has any environment variables, we will call
927
using execve and need to duplicate the environment from this
1000
/* If this plugin has any environment variables, we need to
1001
duplicate the environment from this process, too. */
929
1002
if(p->environ[0] != NULL){
930
1003
for(char **e = environ; *e != NULL; e++){
931
1004
if(not add_environment(p, *e, false)){
932
perror("add_environment");
1005
error(0, errno, "add_environment");
938
1012
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 */
941
exitstatus = EX_OSERR;
1017
error(0, errno, "pipe");
1018
exitstatus = EX_OSERR;
1019
free(direntries[i]);
1022
if(pipefd[0] >= FD_SETSIZE){
1023
fprintf(stderr, "pipe()[0] (%d) >= FD_SETSIZE (%d)", pipefd[0],
1027
exitstatus = EX_OSERR;
1028
free(direntries[i]);
944
1032
/* Ask OS to automatic close the pipe on exec */
945
1033
ret = set_cloexec_flag(pipefd[0]);
947
perror("set_cloexec_flag");
1035
error(0, errno, "set_cloexec_flag");
948
1038
exitstatus = EX_OSERR;
1039
free(direntries[i]);
951
1042
ret = set_cloexec_flag(pipefd[1]);
953
perror("set_cloexec_flag");
1044
error(0, errno, "set_cloexec_flag");
954
1047
exitstatus = EX_OSERR;
1048
free(direntries[i]);
1051
#endif /* not O_CLOEXEC */
957
1052
/* Block SIGCHLD until process is safely in process list */
958
1053
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_BLOCK,
959
1054
&sigchld_action.sa_mask,
962
perror("sigprocmask");
1057
error(0, errno, "sigprocmask");
963
1058
exitstatus = EX_OSERR;
1059
free(direntries[i]);
966
1062
/* Starting a new process to be watched */
970
1066
} while(pid == -1 and errno == EINTR);
1068
error(0, errno, "fork");
1069
TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1070
&sigchld_action.sa_mask, NULL));
973
1073
exitstatus = EX_OSERR;
1074
free(direntries[i]);
977
1078
/* this is the child process */
978
1079
ret = sigaction(SIGCHLD, &old_sigchld_action, NULL);
1081
error(0, errno, "sigaction");
981
1082
_exit(EX_OSERR);
983
1084
ret = sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask, NULL);
985
perror("sigprocmask");
1086
error(0, errno, "sigprocmask");
986
1087
_exit(EX_OSERR);
989
1090
ret = dup2(pipefd[1], STDOUT_FILENO); /* replace our stdout */
1092
error(0, errno, "dup2");
992
1093
_exit(EX_OSERR);
996
/* If dir has no file descriptor, we could not set FD_CLOEXEC
997
above and must now close it manually here. */
1000
if(p->environ[0] == NULL){
1001
if(execv(filename, p->argv) < 0){
1006
if(execve(filename, p->argv, p->environ) < 0){
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);
1011
1103
/* no return */
1013
1105
/* Parent process */
1014
TEMP_FAILURE_RETRY(close(pipefd[1])); /* Close unused write end of
1017
plugin *new_plugin = getplugin(dirst->d_name);
1106
close(pipefd[1]); /* Close unused write end of pipe */
1108
plugin *new_plugin = getplugin(direntries[i]->d_name);
1018
1109
if(new_plugin == NULL){
1019
perror("getplugin");
1110
error(0, errno, "getplugin");
1020
1111
ret = (int)(TEMP_FAILURE_RETRY
1021
1112
(sigprocmask(SIG_UNBLOCK, &sigchld_action.sa_mask,
1024
perror("sigprocmask");
1115
error(0, errno, "sigprocmask");
1026
1117
exitstatus = EX_OSERR;
1118
free(direntries[i]);
1121
free(direntries[i]);
1030
1123
new_plugin->pid = pid;
1031
1124
new_plugin->fd = pipefd[0];
1127
fprintf(stderr, "Plugin %s started (PID %" PRIdMAX ")\n",
1128
new_plugin->name, (intmax_t) (new_plugin->pid));
1033
1131
/* Unblock SIGCHLD so signal handler can be run if this process
1034
1132
has already completed */
1035
1133
ret = (int)TEMP_FAILURE_RETRY(sigprocmask(SIG_UNBLOCK,
1036
1134
&sigchld_action.sa_mask,
1039
perror("sigprocmask");
1137
error(0, errno, "sigprocmask");
1040
1138
exitstatus = EX_OSERR;
1044
FD_SET(new_plugin->fd, &rfds_all); /* Spurious warning from
1142
FD_SET(new_plugin->fd, &rfds_all);
1047
1144
if(maxfd < new_plugin->fd){
1048
1145
maxfd = new_plugin->fd;
1052
TEMP_FAILURE_RETRY(closedir(dir));
1054
1153
free_plugin(getplugin(NULL));
1056
1155
for(plugin *p = plugin_list; p != NULL; p = p->next){