2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2011 James Gritton
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/types.h>
33 #include <sys/event.h>
34 #include <sys/mount.h>
36 #include <sys/sysctl.h>
44 #include <login_cap.h>
56 #define DEFAULT_STOP_TIMEOUT 10
57 #define PHASH_SIZE 256
59 LIST_HEAD(phhead, phash);
69 extern char **environ;
71 static int run_command(struct cfjail *j);
72 static int add_proc(struct cfjail *j, pid_t pid);
73 static void clear_procs(struct cfjail *j);
74 static struct cfjail *find_proc(pid_t pid);
75 static int term_procs(struct cfjail *j);
76 static int get_user_info(struct cfjail *j, const char *username,
77 const struct passwd **pwdp, login_cap_t **lcapp);
78 static int check_path(struct cfjail *j, const char *pname, const char *path,
79 int isfile, const char *umount_type);
81 static struct cfjails sleeping = TAILQ_HEAD_INITIALIZER(sleeping);
82 static struct cfjails runnable = TAILQ_HEAD_INITIALIZER(runnable);
83 static struct cfstring dummystring = { .len = 1 };
84 static struct phhead phash[PHASH_SIZE];
88 * Run the next command associated with a jail.
91 next_command(struct cfjail *j)
93 enum intparam comparam;
94 int create_failed, stopping;
97 if (j->flags & JF_FROM_RUNQ)
98 requeue_head(j, &runnable);
100 requeue(j, &runnable);
103 j->flags &= ~JF_FROM_RUNQ;
104 create_failed = (j->flags & (JF_STOP | JF_FAILED)) == JF_FAILED;
105 stopping = (j->flags & JF_STOP) != 0;
106 comparam = *j->comparam;
108 if (j->comstring == NULL) {
109 j->comparam += create_failed ? -1 : 1;
110 switch ((comparam = *j->comparam)) {
114 if (!bool_param(j->intparams[IP_MOUNT_DEVFS]))
116 j->comstring = &dummystring;
118 case IP_MOUNT_FDESCFS:
119 if (!bool_param(j->intparams[IP_MOUNT_FDESCFS]))
121 j->comstring = &dummystring;
123 case IP_MOUNT_PROCFS:
124 if (!bool_param(j->intparams[IP_MOUNT_PROCFS]))
126 j->comstring = &dummystring;
129 case IP_STOP_TIMEOUT:
130 j->comstring = &dummystring;
133 if (j->intparams[comparam] == NULL)
135 j->comstring = create_failed || (stopping &&
136 (j->intparams[comparam]->flags & PF_REV))
137 ? TAILQ_LAST(&j->intparams[comparam]->val,
139 : TAILQ_FIRST(&j->intparams[comparam]->val);
142 j->comstring = j->comstring == &dummystring ? NULL :
143 create_failed || (stopping &&
144 (j->intparams[comparam]->flags & PF_REV))
145 ? TAILQ_PREV(j->comstring, cfstrings, tq)
146 : TAILQ_NEXT(j->comstring, tq);
148 if (j->comstring == NULL || j->comstring->len == 0 ||
149 (create_failed && (comparam == IP_EXEC_PRESTART ||
150 comparam == IP_EXEC_CREATED || comparam == IP_EXEC_START ||
151 comparam == IP_COMMAND || comparam == IP_EXEC_POSTSTART ||
152 comparam == IP_EXEC_PREPARE)))
154 switch (run_command(j)) {
165 * Check command exit status
168 finish_command(struct cfjail *j)
173 if (!(j->flags & JF_SLEEPQ))
175 j->flags &= ~JF_SLEEPQ;
176 if (*j->comparam == IP_STOP_TIMEOUT) {
177 j->flags &= ~JF_TIMEOUT;
182 if (!TAILQ_EMPTY(&runnable)) {
183 rj = TAILQ_FIRST(&runnable);
184 rj->flags |= JF_FROM_RUNQ;
188 if (j->flags & JF_TIMEOUT) {
189 j->flags &= ~JF_TIMEOUT;
190 if (*j->comparam != IP_STOP_TIMEOUT) {
191 jail_warnx(j, "%s: timed out", j->comline);
194 } else if (verbose > 0)
195 jail_note(j, "timed out\n");
196 } else if (j->pstatus != 0) {
197 if (WIFSIGNALED(j->pstatus))
198 jail_warnx(j, "%s: exited on signal %d",
199 j->comline, WTERMSIG(j->pstatus));
201 jail_warnx(j, "%s: failed", j->comline);
212 * Check for finished processes or timeouts.
215 next_proc(int nonblock)
219 struct timespec *tsp;
222 if (!TAILQ_EMPTY(&sleeping)) {
225 if ((j = TAILQ_FIRST(&sleeping)) && j->timeout.tv_sec) {
226 clock_gettime(CLOCK_REALTIME, &ts);
227 ts.tv_sec = j->timeout.tv_sec - ts.tv_sec;
228 ts.tv_nsec = j->timeout.tv_nsec - ts.tv_nsec;
229 if (ts.tv_nsec < 0) {
231 ts.tv_nsec += 1000000000;
234 (ts.tv_sec == 0 && ts.tv_nsec == 0)) {
235 j->flags |= JF_TIMEOUT;
246 switch (kevent(kq, NULL, 0, &ke, 1, tsp)) {
253 j = TAILQ_FIRST(&sleeping);
254 j->flags |= JF_TIMEOUT;
260 (void)waitpid(ke.ident, NULL, WNOHANG);
261 if ((j = find_proc(ke.ident))) {
262 j->pstatus = ke.data;
272 * Run a single command for a jail, possibly inside the jail.
275 run_command(struct cfjail *j)
277 const struct passwd *pwd;
278 const struct cfstring *comstring, *s;
281 char *acs, *cs, *comcs, *devpath;
282 const char *jidstr, *conslog, *path, *ruleset, *term, *username;
283 enum intparam comparam;
286 int argc, bg, clean, consfd, down, fib, i, injail, sjuser, timeout;
287 #if defined(INET) || defined(INET6)
288 char *addr, *extrap, *p, *val;
291 static char *cleanenv;
293 /* Perform some operations that aren't actually commands */
294 comparam = *j->comparam;
295 down = j->flags & (JF_STOP | JF_FAILED);
297 case IP_STOP_TIMEOUT:
298 return term_procs(j);
302 if (jail_remove(j->jid) < 0 && errno == EPERM) {
303 jail_warnx(j, "jail_remove: %s",
307 if (verbose > 0 || (verbose == 0 && (j->flags & JF_STOP
308 ? note_remove : j->name != NULL)))
309 jail_note(j, "removed\n");
311 if (j->flags & JF_STOP)
312 dep_done(j, DF_LIGHT);
314 j->flags &= ~JF_PERSIST;
316 if (create_jail(j) < 0)
319 printf("%d\n", j->jid);
320 if (verbose >= 0 && (j->name || verbose > 0))
321 jail_note(j, "created\n");
322 dep_done(j, DF_LIGHT);
329 * Collect exec arguments. Internal commands for network and
330 * mounting build their own argument lists.
332 comstring = j->comstring;
338 val = alloca(strlen(comstring->s) + 1);
339 strcpy(val, comstring->s);
342 while ((p = strchr(cs, ' ')) != NULL && strlen(p) > 1) {
343 if (extrap == NULL) {
351 argv = alloca((8 + argc) * sizeof(char *));
352 argv[0] = _PATH_IFCONFIG;
353 if ((cs = strchr(val, '|'))) {
354 argv[1] = acs = alloca(cs - val + 1);
355 strlcpy(acs, val, cs - val + 1);
358 argv[1] = string_param(j->intparams[IP_INTERFACE]);
362 if (!(cs = strchr(addr, '/'))) {
365 argv[5] = "255.255.255.255";
367 } else if (strchr(cs + 1, '.')) {
368 argv[3] = acs = alloca(cs - addr + 1);
369 strlcpy(acs, addr, cs - addr + 1);
378 if (!down && extrap != NULL) {
379 for (cs = strtok(extrap, " "); cs;
380 cs = strtok(NULL, " ")) {
381 size_t len = strlen(cs) + 1;
382 argv[argc++] = acs = alloca(len);
383 strlcpy(acs, cs, len);
387 argv[argc] = down ? "-alias" : "alias";
388 argv[argc + 1] = NULL;
395 val = alloca(strlen(comstring->s) + 1);
396 strcpy(val, comstring->s);
399 while ((p = strchr(cs, ' ')) != NULL && strlen(p) > 1) {
400 if (extrap == NULL) {
408 argv = alloca((8 + argc) * sizeof(char *));
409 argv[0] = _PATH_IFCONFIG;
410 if ((cs = strchr(val, '|'))) {
411 argv[1] = acs = alloca(cs - val + 1);
412 strlcpy(acs, val, cs - val + 1);
415 argv[1] = string_param(j->intparams[IP_INTERFACE]);
420 if (!(cs = strchr(addr, '/'))) {
421 argv[4] = "prefixlen";
428 for (cs = strtok(extrap, " "); cs;
429 cs = strtok(NULL, " ")) {
430 size_t len = strlen(cs) + 1;
431 argv[argc++] = acs = alloca(len);
432 strlcpy(acs, cs, len);
436 argv[argc] = down ? "-alias" : "alias";
437 argv[argc + 1] = NULL;
441 case IP_VNET_INTERFACE:
442 argv = alloca(5 * sizeof(char *));
443 argv[0] = _PATH_IFCONFIG;
444 argv[1] = comstring->s;
445 argv[2] = down ? "-vnet" : "vnet";
446 jidstr = string_param(j->intparams[KP_JID]);
447 argv[3] = jidstr ? jidstr : string_param(j->intparams[KP_NAME]);
452 case IP__MOUNT_FROM_FSTAB:
453 argv = alloca(8 * sizeof(char *));
454 comcs = alloca(comstring->len + 1);
455 strcpy(comcs, comstring->s);
457 for (cs = strtok(comcs, " \t\f\v\r\n"); cs && argc < 4;
458 cs = strtok(NULL, " \t\f\v\r\n")) {
459 if (argc <= 1 && strunvis(cs, cs) < 0) {
460 jail_warnx(j, "%s: %s: fstab parse error",
461 j->intparams[comparam]->name, comstring->s);
469 jail_warnx(j, "%s: %s: missing information",
470 j->intparams[comparam]->name, comstring->s);
473 if (check_path(j, j->intparams[comparam]->name, argv[1], 0,
474 down ? argv[2] : NULL) < 0)
479 argv[0] = "/sbin/umount";
492 argv[0] = _PATH_MOUNT;
498 argv = alloca(7 * sizeof(char *));
499 path = string_param(j->intparams[KP_PATH]);
501 jail_warnx(j, "mount.devfs: no jail root path defined");
504 devpath = alloca(strlen(path) + 5);
505 sprintf(devpath, "%s/dev", path);
506 if (check_path(j, "mount.devfs", devpath, 0,
507 down ? "devfs" : NULL) < 0)
510 argv[0] = "/sbin/umount";
514 argv[0] = _PATH_MOUNT;
517 ruleset = string_param(j->intparams[KP_DEVFS_RULESET]);
519 ruleset = "4"; /* devfsrules_jail */
520 argv[3] = acs = alloca(11 + strlen(ruleset));
521 sprintf(acs, "-oruleset=%s", ruleset);
528 case IP_MOUNT_FDESCFS:
529 argv = alloca(7 * sizeof(char *));
530 path = string_param(j->intparams[KP_PATH]);
532 jail_warnx(j, "mount.fdescfs: no jail root path defined");
535 devpath = alloca(strlen(path) + 8);
536 sprintf(devpath, "%s/dev/fd", path);
537 if (check_path(j, "mount.fdescfs", devpath, 0,
538 down ? "fdescfs" : NULL) < 0)
541 argv[0] = "/sbin/umount";
545 argv[0] = _PATH_MOUNT;
554 case IP_MOUNT_PROCFS:
555 argv = alloca(7 * sizeof(char *));
556 path = string_param(j->intparams[KP_PATH]);
558 jail_warnx(j, "mount.procfs: no jail root path defined");
561 devpath = alloca(strlen(path) + 6);
562 sprintf(devpath, "%s/proc", path);
563 if (check_path(j, "mount.procfs", devpath, 0,
564 down ? "procfs" : NULL) < 0)
567 argv[0] = "/sbin/umount";
571 argv[0] = _PATH_MOUNT;
582 goto default_command;
584 TAILQ_FOREACH(s, &j->intparams[IP_COMMAND]->val, tq)
586 argv = alloca((argc + 1) * sizeof(char *));
588 TAILQ_FOREACH(s, &j->intparams[IP_COMMAND]->val, tq)
591 j->comstring = &dummystring;
596 if ((cs = strpbrk(comstring->s, "!\"$&'()*;<>?[\\]`{|}~")) &&
597 !(cs[0] == '&' && cs[1] == '\0')) {
598 argv = alloca(4 * sizeof(char *));
599 argv[0] = _PATH_BSHELL;
601 argv[2] = comstring->s;
608 comcs = alloca(comstring->len + 1);
609 strcpy(comcs, comstring->s);
611 for (cs = strtok(comcs, " \t\f\v\r\n"); cs;
612 cs = strtok(NULL, " \t\f\v\r\n"))
614 argv = alloca((argc + 1) * sizeof(char *));
615 strcpy(comcs, comstring->s);
617 for (cs = strtok(comcs, " \t\f\v\r\n"); cs;
618 cs = strtok(NULL, " \t\f\v\r\n"))
626 if (int_param(j->intparams[IP_EXEC_TIMEOUT], &timeout) &&
628 clock_gettime(CLOCK_REALTIME, &j->timeout);
629 j->timeout.tv_sec += timeout;
631 j->timeout.tv_sec = 0;
633 injail = comparam == IP_EXEC_START || comparam == IP_COMMAND ||
634 comparam == IP_EXEC_STOP;
635 clean = bool_param(j->intparams[IP_EXEC_CLEAN]);
636 username = string_param(j->intparams[injail
637 ? IP_EXEC_JAIL_USER : IP_EXEC_SYSTEM_USER]);
638 sjuser = bool_param(j->intparams[IP_EXEC_SYSTEM_JAIL_USER]);
642 (conslog = string_param(j->intparams[IP_EXEC_CONSOLELOG]))) {
643 if (check_path(j, "exec.consolelog", conslog, 1, NULL) < 0)
646 open(conslog, O_WRONLY | O_CREAT | O_APPEND, DEFFILEMODE);
648 jail_warnx(j, "open %s: %s", conslog, strerror(errno));
654 for (i = 0; argv[i]; i++)
655 comlen += strlen(argv[i]) + 1;
656 j->comline = cs = emalloc(comlen);
657 for (i = 0; argv[i]; i++) {
660 cs += strlen(argv[i]) + 1;
665 jail_note(j, "run command%s%s%s: %s\n",
666 injail ? " in jail" : "", username ? " as " : "",
667 username ? username : "", j->comline);
673 if (bg || !add_proc(j, pid)) {
685 /* Set up the environment and run the command */
688 if ((clean || username) && injail && sjuser &&
689 get_user_info(j, username, &pwd, &lcap) < 0)
692 /* jail_attach won't chdir along with its chroot. */
693 path = string_param(j->intparams[KP_PATH]);
694 if (path && chdir(path) < 0) {
695 jail_warnx(j, "chdir %s: %s", path, strerror(errno));
698 if (int_param(j->intparams[IP_EXEC_FIB], &fib) &&
700 jail_warnx(j, "setfib: %s", strerror(errno));
703 if (jail_attach(j->jid) < 0) {
704 jail_warnx(j, "jail_attach: %s", strerror(errno));
708 if (clean || username) {
709 if (!(injail && sjuser) &&
710 get_user_info(j, username, &pwd, &lcap) < 0)
713 term = getenv("TERM");
715 setenv("PATH", "/bin:/usr/bin", 0);
717 setenv("TERM", term, 1);
719 if (setgid(pwd->pw_gid) < 0) {
720 jail_warnx(j, "setgid %d: %s", pwd->pw_gid,
724 if (setusercontext(lcap, pwd, pwd->pw_uid, username
725 ? LOGIN_SETALL & ~LOGIN_SETGROUP & ~LOGIN_SETLOGIN
726 : LOGIN_SETPATH | LOGIN_SETENV) < 0) {
727 jail_warnx(j, "setusercontext %s: %s", pwd->pw_name,
732 setenv("USER", pwd->pw_name, 1);
733 setenv("HOME", pwd->pw_dir, 1);
735 *pwd->pw_shell ? pwd->pw_shell : _PATH_BSHELL, 1);
736 if (clean && chdir(pwd->pw_dir) < 0) {
737 jail_warnx(j, "chdir %s: %s",
738 pwd->pw_dir, strerror(errno));
744 if (consfd != 0 && (dup2(consfd, 1) < 0 || dup2(consfd, 2) < 0)) {
745 jail_warnx(j, "exec.consolelog: %s", strerror(errno));
749 execvp(argv[0], __DECONST(char *const*, argv));
750 jail_warnx(j, "exec %s: %s", argv[0], strerror(errno));
755 * Add a process to the hash, tied to a jail.
758 add_proc(struct cfjail *j, pid_t pid)
764 if (!kq && (kq = kqueue()) < 0)
766 EV_SET(&ke, pid, EVFILT_PROC, EV_ADD, NOTE_EXIT, 0, NULL);
767 if (kevent(kq, &ke, 1, NULL, 0, NULL) < 0) {
772 ph = emalloc(sizeof(struct phash));
775 LIST_INSERT_HEAD(&phash[pid % PHASH_SIZE], ph, le);
777 j->flags |= JF_SLEEPQ;
778 if (j->timeout.tv_sec == 0)
779 requeue(j, &sleeping);
781 /* File the jail in the sleep queue according to its timeout. */
782 TAILQ_REMOVE(j->queue, j, tq);
783 TAILQ_FOREACH(tj, &sleeping, tq) {
784 if (!tj->timeout.tv_sec ||
785 j->timeout.tv_sec < tj->timeout.tv_sec ||
786 (j->timeout.tv_sec == tj->timeout.tv_sec &&
787 j->timeout.tv_nsec <= tj->timeout.tv_nsec)) {
788 TAILQ_INSERT_BEFORE(tj, j, tq);
793 TAILQ_INSERT_TAIL(&sleeping, j, tq);
794 j->queue = &sleeping;
800 * Remove any processes from the hash that correspond to a jail.
803 clear_procs(struct cfjail *j)
806 struct phash *ph, *tph;
810 for (i = 0; i < PHASH_SIZE; i++)
811 LIST_FOREACH_SAFE(ph, &phash[i], le, tph)
813 EV_SET(&ke, ph->pid, EVFILT_PROC, EV_DELETE,
815 (void)kevent(kq, &ke, 1, NULL, 0, NULL);
822 * Find the jail that corresponds to an exited process.
824 static struct cfjail *
830 LIST_FOREACH(ph, &phash[pid % PHASH_SIZE], le)
831 if (ph->pid == pid) {
835 return --j->nprocs ? NULL : j;
841 * Send SIGTERM to all processes in a jail and wait for them to die.
844 term_procs(struct cfjail *j)
846 struct kinfo_proc *ki;
847 int i, noted, pcnt, timeout;
851 if (!int_param(j->intparams[IP_STOP_TIMEOUT], &timeout))
852 timeout = DEFAULT_STOP_TIMEOUT;
853 else if (timeout == 0)
857 kd = kvm_open(NULL, NULL, NULL, O_RDONLY, NULL);
862 ki = kvm_getprocs(kd, KERN_PROC_PROC, 0, &pcnt);
866 for (i = 0; i < pcnt; i++)
867 if (ki[i].ki_jid == j->jid &&
868 kill(ki[i].ki_pid, SIGTERM) == 0) {
869 (void)add_proc(j, ki[i].ki_pid);
873 jail_note(j, "sent SIGTERM to:");
875 printf(" %d", ki[i].ki_pid);
881 clock_gettime(CLOCK_REALTIME, &j->timeout);
882 j->timeout.tv_sec += timeout;
889 * Look up a user in the passwd and login.conf files.
892 get_user_info(struct cfjail *j, const char *username,
893 const struct passwd **pwdp, login_cap_t **lcapp)
895 const struct passwd *pwd;
898 *pwdp = pwd = username ? getpwnam(username) : getpwuid(getuid());
901 jail_warnx(j, "getpwnam%s%s: %s", username ? " " : "",
902 username ? username : "", strerror(errno));
904 jail_warnx(j, "%s: no such user", username);
906 jail_warnx(j, "unknown uid %d", getuid());
909 *lcapp = login_getpwclass(pwd);
910 if (*lcapp == NULL) {
911 jail_warnx(j, "getpwclass %s: %s", pwd->pw_name,
915 /* Set the groups while the group file is still available */
916 if (initgroups(pwd->pw_name, pwd->pw_gid) < 0) {
917 jail_warnx(j, "initgroups %s: %s", pwd->pw_name,
925 * Make sure a mount or consolelog path is a valid absolute pathname
929 check_path(struct cfjail *j, const char *pname, const char *path, int isfile,
930 const char *umount_type)
932 struct stat st, mpst;
935 const char *jailpath;
938 if (path[0] != '/') {
939 jail_warnx(j, "%s: %s: not an absolute pathname",
944 * Only check for symlinks in components below the jail's path,
945 * since that's where the security risk lies.
947 jailpath = string_param(j->intparams[KP_PATH]);
948 if (jailpath == NULL)
950 jplen = strlen(jailpath);
951 if (!strncmp(path, jailpath, jplen) && path[jplen] == '/') {
952 tpath = alloca(strlen(path) + 1);
954 for (p = tpath + jplen; p != NULL; ) {
955 p = strchr(p + 1, '/');
958 if (lstat(tpath, &st) < 0) {
959 if (errno == ENOENT && isfile && !p)
961 jail_warnx(j, "%s: %s: %s", pname, tpath,
965 if (S_ISLNK(st.st_mode)) {
966 jail_warnx(j, "%s: %s is a symbolic link",
974 if (umount_type != NULL) {
975 if (stat(path, &st) < 0 || statfs(path, &stfs) < 0) {
976 jail_warnx(j, "%s: %s: %s", pname, path,
980 if (stat(stfs.f_mntonname, &mpst) < 0) {
981 jail_warnx(j, "%s: %s: %s", pname, stfs.f_mntonname,
985 if (st.st_ino != mpst.st_ino) {
986 jail_warnx(j, "%s: %s: not a mount point",
990 if (strcmp(stfs.f_fstypename, umount_type)) {
991 jail_warnx(j, "%s: %s: not a %s mount",
992 pname, path, umount_type);