2 * Copyright (c) 2011 James Gritton
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/types.h>
31 #include <sys/event.h>
32 #include <sys/mount.h>
34 #include <sys/sysctl.h>
42 #include <login_cap.h>
54 #define DEFAULT_STOP_TIMEOUT 10
55 #define PHASH_SIZE 256
57 LIST_HEAD(phhead, phash);
67 extern char **environ;
69 static int run_command(struct cfjail *j);
70 static int add_proc(struct cfjail *j, pid_t pid);
71 static void clear_procs(struct cfjail *j);
72 static struct cfjail *find_proc(pid_t pid);
73 static int term_procs(struct cfjail *j);
74 static int get_user_info(struct cfjail *j, const char *username,
75 const struct passwd **pwdp, login_cap_t **lcapp);
76 static int check_path(struct cfjail *j, const char *pname, const char *path,
77 int isfile, const char *umount_type);
79 static struct cfjails sleeping = TAILQ_HEAD_INITIALIZER(sleeping);
80 static struct cfjails runnable = TAILQ_HEAD_INITIALIZER(runnable);
81 static struct cfstring dummystring = { .len = 1 };
82 static struct phhead phash[PHASH_SIZE];
86 * Run the next command associated with a jail.
89 next_command(struct cfjail *j)
91 enum intparam comparam;
92 int create_failed, stopping;
95 requeue(j, &runnable);
98 create_failed = (j->flags & (JF_STOP | JF_FAILED)) == JF_FAILED;
99 stopping = (j->flags & JF_STOP) != 0;
100 comparam = *j->comparam;
102 if (j->comstring == NULL) {
103 j->comparam += create_failed ? -1 : 1;
104 switch ((comparam = *j->comparam)) {
108 if (!bool_param(j->intparams[IP_MOUNT_DEVFS]))
110 j->comstring = &dummystring;
112 case IP_MOUNT_FDESCFS:
113 if (!bool_param(j->intparams[IP_MOUNT_FDESCFS]))
115 j->comstring = &dummystring;
117 case IP_MOUNT_PROCFS:
118 if (!bool_param(j->intparams[IP_MOUNT_PROCFS]))
120 j->comstring = &dummystring;
123 case IP_STOP_TIMEOUT:
124 j->comstring = &dummystring;
127 if (j->intparams[comparam] == NULL)
129 j->comstring = create_failed || (stopping &&
130 (j->intparams[comparam]->flags & PF_REV))
131 ? TAILQ_LAST(&j->intparams[comparam]->val,
133 : TAILQ_FIRST(&j->intparams[comparam]->val);
136 j->comstring = j->comstring == &dummystring ? NULL :
137 create_failed || (stopping &&
138 (j->intparams[comparam]->flags & PF_REV))
139 ? TAILQ_PREV(j->comstring, cfstrings, tq)
140 : TAILQ_NEXT(j->comstring, tq);
142 if (j->comstring == NULL || j->comstring->len == 0 ||
143 (create_failed && (comparam == IP_EXEC_PRESTART ||
144 comparam == IP_EXEC_START || comparam == IP_COMMAND ||
145 comparam == IP_EXEC_POSTSTART)))
147 switch (run_command(j)) {
158 * Check command exit status
161 finish_command(struct cfjail *j)
165 if (!(j->flags & JF_SLEEPQ))
167 j->flags &= ~JF_SLEEPQ;
168 if (*j->comparam == IP_STOP_TIMEOUT)
170 j->flags &= ~JF_TIMEOUT;
175 if (!TAILQ_EMPTY(&runnable))
176 requeue(TAILQ_FIRST(&runnable), &ready);
178 if (j->flags & JF_TIMEOUT) {
179 j->flags &= ~JF_TIMEOUT;
180 if (*j->comparam != IP_STOP_TIMEOUT) {
181 jail_warnx(j, "%s: timed out", j->comline);
184 } else if (verbose > 0)
185 jail_note(j, "timed out\n");
186 } else if (j->pstatus != 0) {
187 if (WIFSIGNALED(j->pstatus))
188 jail_warnx(j, "%s: exited on signal %d",
189 j->comline, WTERMSIG(j->pstatus));
191 jail_warnx(j, "%s: failed", j->comline);
202 * Check for finished processes or timeouts.
205 next_proc(int nonblock)
209 struct timespec *tsp;
212 if (!TAILQ_EMPTY(&sleeping)) {
215 if ((j = TAILQ_FIRST(&sleeping)) && j->timeout.tv_sec) {
216 clock_gettime(CLOCK_REALTIME, &ts);
217 ts.tv_sec = j->timeout.tv_sec - ts.tv_sec;
218 ts.tv_nsec = j->timeout.tv_nsec - ts.tv_nsec;
219 if (ts.tv_nsec < 0) {
221 ts.tv_nsec += 1000000000;
224 (ts.tv_sec == 0 && ts.tv_nsec == 0)) {
225 j->flags |= JF_TIMEOUT;
236 switch (kevent(kq, NULL, 0, &ke, 1, tsp)) {
243 j = TAILQ_FIRST(&sleeping);
244 j->flags |= JF_TIMEOUT;
250 (void)waitpid(ke.ident, NULL, WNOHANG);
251 if ((j = find_proc(ke.ident))) {
252 j->pstatus = ke.data;
262 * Run a single command for a jail, possible inside the jail.
265 run_command(struct cfjail *j)
267 const struct passwd *pwd;
268 const struct cfstring *comstring, *s;
271 char *acs, *cs, *comcs, *devpath;
272 const char *jidstr, *conslog, *path, *ruleset, *term, *username;
273 enum intparam comparam;
276 int argc, bg, clean, consfd, down, fib, i, injail, sjuser, timeout;
277 #if defined(INET) || defined(INET6)
278 char *addr, *extrap, *p, *val;
281 static char *cleanenv;
283 /* Perform some operations that aren't actually commands */
284 comparam = *j->comparam;
285 down = j->flags & (JF_STOP | JF_FAILED);
287 case IP_STOP_TIMEOUT:
288 return term_procs(j);
292 if (jail_remove(j->jid) < 0 && errno == EPERM) {
293 jail_warnx(j, "jail_remove: %s",
297 if (verbose > 0 || (verbose == 0 && (j->flags & JF_STOP
298 ? note_remove : j->name != NULL)))
299 jail_note(j, "removed\n");
301 if (j->flags & JF_STOP)
302 dep_done(j, DF_LIGHT);
304 j->flags &= ~JF_PERSIST;
306 if (create_jail(j) < 0)
309 printf("%d\n", j->jid);
310 if (verbose >= 0 && (j->name || verbose > 0))
311 jail_note(j, "created\n");
312 dep_done(j, DF_LIGHT);
319 * Collect exec arguments. Internal commands for network and
320 * mounting build their own argument lists.
322 comstring = j->comstring;
328 val = alloca(strlen(comstring->s) + 1);
329 strcpy(val, comstring->s);
332 while ((p = strchr(cs, ' ')) != NULL && strlen(p) > 1) {
333 if (extrap == NULL) {
341 argv = alloca((8 + argc) * sizeof(char *));
342 argv[0] = _PATH_IFCONFIG;
343 if ((cs = strchr(val, '|'))) {
344 argv[1] = acs = alloca(cs - val + 1);
345 strlcpy(acs, val, cs - val + 1);
348 argv[1] = string_param(j->intparams[IP_INTERFACE]);
352 if (!(cs = strchr(addr, '/'))) {
355 argv[5] = "255.255.255.255";
357 } else if (strchr(cs + 1, '.')) {
358 argv[3] = acs = alloca(cs - addr + 1);
359 strlcpy(acs, addr, cs - addr + 1);
369 for (cs = strtok(extrap, " "); cs;
370 cs = strtok(NULL, " ")) {
371 size_t len = strlen(cs) + 1;
372 argv[argc++] = acs = alloca(len);
373 strlcpy(acs, cs, len);
377 argv[argc] = down ? "-alias" : "alias";
378 argv[argc + 1] = NULL;
385 val = alloca(strlen(comstring->s) + 1);
386 strcpy(val, comstring->s);
389 while ((p = strchr(cs, ' ')) != NULL && strlen(p) > 1) {
390 if (extrap == NULL) {
398 argv = alloca((8 + argc) * sizeof(char *));
399 argv[0] = _PATH_IFCONFIG;
400 if ((cs = strchr(val, '|'))) {
401 argv[1] = acs = alloca(cs - val + 1);
402 strlcpy(acs, val, cs - val + 1);
405 argv[1] = string_param(j->intparams[IP_INTERFACE]);
410 if (!(cs = strchr(addr, '/'))) {
411 argv[4] = "prefixlen";
418 for (cs = strtok(extrap, " "); cs;
419 cs = strtok(NULL, " ")) {
420 size_t len = strlen(cs) + 1;
421 argv[argc++] = acs = alloca(len);
422 strlcpy(acs, cs, len);
426 argv[argc] = down ? "-alias" : "alias";
427 argv[argc + 1] = NULL;
431 case IP_VNET_INTERFACE:
432 argv = alloca(5 * sizeof(char *));
433 argv[0] = _PATH_IFCONFIG;
434 argv[1] = comstring->s;
435 argv[2] = down ? "-vnet" : "vnet";
436 jidstr = string_param(j->intparams[KP_JID]);
437 argv[3] = jidstr ? jidstr : string_param(j->intparams[KP_NAME]);
442 case IP__MOUNT_FROM_FSTAB:
443 argv = alloca(8 * sizeof(char *));
444 comcs = alloca(comstring->len + 1);
445 strcpy(comcs, comstring->s);
447 for (cs = strtok(comcs, " \t\f\v\r\n"); cs && argc < 4;
448 cs = strtok(NULL, " \t\f\v\r\n")) {
449 if (argc <= 1 && strunvis(cs, cs) < 0) {
450 jail_warnx(j, "%s: %s: fstab parse error",
451 j->intparams[comparam]->name, comstring->s);
459 jail_warnx(j, "%s: %s: missing information",
460 j->intparams[comparam]->name, comstring->s);
463 if (check_path(j, j->intparams[comparam]->name, argv[1], 0,
464 down ? argv[2] : NULL) < 0)
469 argv[0] = "/sbin/umount";
482 argv[0] = _PATH_MOUNT;
488 argv = alloca(7 * sizeof(char *));
489 path = string_param(j->intparams[KP_PATH]);
491 jail_warnx(j, "mount.devfs: no path");
494 devpath = alloca(strlen(path) + 5);
495 sprintf(devpath, "%s/dev", path);
496 if (check_path(j, "mount.devfs", devpath, 0,
497 down ? "devfs" : NULL) < 0)
500 argv[0] = "/sbin/umount";
504 argv[0] = _PATH_MOUNT;
507 ruleset = string_param(j->intparams[KP_DEVFS_RULESET]);
509 ruleset = "4"; /* devfsrules_jail */
510 argv[3] = acs = alloca(11 + strlen(ruleset));
511 sprintf(acs, "-oruleset=%s", ruleset);
518 case IP_MOUNT_FDESCFS:
519 argv = alloca(7 * sizeof(char *));
520 path = string_param(j->intparams[KP_PATH]);
522 jail_warnx(j, "mount.fdescfs: no path");
525 devpath = alloca(strlen(path) + 8);
526 sprintf(devpath, "%s/dev/fd", path);
527 if (check_path(j, "mount.fdescfs", devpath, 0,
528 down ? "fdescfs" : NULL) < 0)
531 argv[0] = "/sbin/umount";
535 argv[0] = _PATH_MOUNT;
544 case IP_MOUNT_PROCFS:
545 argv = alloca(7 * sizeof(char *));
546 path = string_param(j->intparams[KP_PATH]);
548 jail_warnx(j, "mount.procfs: no path");
551 devpath = alloca(strlen(path) + 6);
552 sprintf(devpath, "%s/proc", path);
553 if (check_path(j, "mount.procfs", devpath, 0,
554 down ? "procfs" : NULL) < 0)
557 argv[0] = "/sbin/umount";
561 argv[0] = _PATH_MOUNT;
572 goto default_command;
574 TAILQ_FOREACH(s, &j->intparams[IP_COMMAND]->val, tq)
576 argv = alloca((argc + 1) * sizeof(char *));
578 TAILQ_FOREACH(s, &j->intparams[IP_COMMAND]->val, tq)
581 j->comstring = &dummystring;
586 if ((cs = strpbrk(comstring->s, "!\"$&'()*;<>?[\\]`{|}~")) &&
587 !(cs[0] == '&' && cs[1] == '\0')) {
588 argv = alloca(4 * sizeof(char *));
589 argv[0] = _PATH_BSHELL;
591 argv[2] = comstring->s;
598 comcs = alloca(comstring->len + 1);
599 strcpy(comcs, comstring->s);
601 for (cs = strtok(comcs, " \t\f\v\r\n"); cs;
602 cs = strtok(NULL, " \t\f\v\r\n"))
604 argv = alloca((argc + 1) * sizeof(char *));
605 strcpy(comcs, comstring->s);
607 for (cs = strtok(comcs, " \t\f\v\r\n"); cs;
608 cs = strtok(NULL, " \t\f\v\r\n"))
616 if (int_param(j->intparams[IP_EXEC_TIMEOUT], &timeout) &&
618 clock_gettime(CLOCK_REALTIME, &j->timeout);
619 j->timeout.tv_sec += timeout;
621 j->timeout.tv_sec = 0;
623 injail = comparam == IP_EXEC_START || comparam == IP_COMMAND ||
624 comparam == IP_EXEC_STOP;
625 clean = bool_param(j->intparams[IP_EXEC_CLEAN]);
626 username = string_param(j->intparams[injail
627 ? IP_EXEC_JAIL_USER : IP_EXEC_SYSTEM_USER]);
628 sjuser = bool_param(j->intparams[IP_EXEC_SYSTEM_JAIL_USER]);
632 (conslog = string_param(j->intparams[IP_EXEC_CONSOLELOG]))) {
633 if (check_path(j, "exec.consolelog", conslog, 1, NULL) < 0)
636 open(conslog, O_WRONLY | O_CREAT | O_APPEND, DEFFILEMODE);
638 jail_warnx(j, "open %s: %s", conslog, strerror(errno));
644 for (i = 0; argv[i]; i++)
645 comlen += strlen(argv[i]) + 1;
646 j->comline = cs = emalloc(comlen);
647 for (i = 0; argv[i]; i++) {
650 cs += strlen(argv[i]) + 1;
655 jail_note(j, "run command%s%s%s: %s\n",
656 injail ? " in jail" : "", username ? " as " : "",
657 username ? username : "", j->comline);
663 if (bg || !add_proc(j, pid)) {
675 /* Set up the environment and run the command */
678 if ((clean || username) && injail && sjuser &&
679 get_user_info(j, username, &pwd, &lcap) < 0)
682 /* jail_attach won't chdir along with its chroot. */
683 path = string_param(j->intparams[KP_PATH]);
684 if (path && chdir(path) < 0) {
685 jail_warnx(j, "chdir %s: %s", path, strerror(errno));
688 if (int_param(j->intparams[IP_EXEC_FIB], &fib) &&
690 jail_warnx(j, "setfib: %s", strerror(errno));
693 if (jail_attach(j->jid) < 0) {
694 jail_warnx(j, "jail_attach: %s", strerror(errno));
698 if (clean || username) {
699 if (!(injail && sjuser) &&
700 get_user_info(j, username, &pwd, &lcap) < 0)
703 term = getenv("TERM");
705 setenv("PATH", "/bin:/usr/bin", 0);
707 setenv("TERM", term, 1);
709 if (setgid(pwd->pw_gid) < 0) {
710 jail_warnx(j, "setgid %d: %s", pwd->pw_gid,
714 if (setusercontext(lcap, pwd, pwd->pw_uid, username
715 ? LOGIN_SETALL & ~LOGIN_SETGROUP & ~LOGIN_SETLOGIN
716 : LOGIN_SETPATH | LOGIN_SETENV) < 0) {
717 jail_warnx(j, "setusercontext %s: %s", pwd->pw_name,
722 setenv("USER", pwd->pw_name, 1);
723 setenv("HOME", pwd->pw_dir, 1);
725 *pwd->pw_shell ? pwd->pw_shell : _PATH_BSHELL, 1);
726 if (clean && chdir(pwd->pw_dir) < 0) {
727 jail_warnx(j, "chdir %s: %s",
728 pwd->pw_dir, strerror(errno));
734 if (consfd != 0 && (dup2(consfd, 1) < 0 || dup2(consfd, 2) < 0)) {
735 jail_warnx(j, "exec.consolelog: %s", strerror(errno));
739 execvp(argv[0], __DECONST(char *const*, argv));
740 jail_warnx(j, "exec %s: %s", argv[0], strerror(errno));
745 * Add a process to the hash, tied to a jail.
748 add_proc(struct cfjail *j, pid_t pid)
754 if (!kq && (kq = kqueue()) < 0)
756 EV_SET(&ke, pid, EVFILT_PROC, EV_ADD, NOTE_EXIT, 0, NULL);
757 if (kevent(kq, &ke, 1, NULL, 0, NULL) < 0) {
762 ph = emalloc(sizeof(struct phash));
765 LIST_INSERT_HEAD(&phash[pid % PHASH_SIZE], ph, le);
767 j->flags |= JF_SLEEPQ;
768 if (j->timeout.tv_sec == 0)
769 requeue(j, &sleeping);
771 /* File the jail in the sleep queue according to its timeout. */
772 TAILQ_REMOVE(j->queue, j, tq);
773 TAILQ_FOREACH(tj, &sleeping, tq) {
774 if (!tj->timeout.tv_sec ||
775 j->timeout.tv_sec < tj->timeout.tv_sec ||
776 (j->timeout.tv_sec == tj->timeout.tv_sec &&
777 j->timeout.tv_nsec <= tj->timeout.tv_nsec)) {
778 TAILQ_INSERT_BEFORE(tj, j, tq);
783 TAILQ_INSERT_TAIL(&sleeping, j, tq);
784 j->queue = &sleeping;
790 * Remove any processes from the hash that correspond to a jail.
793 clear_procs(struct cfjail *j)
796 struct phash *ph, *tph;
800 for (i = 0; i < PHASH_SIZE; i++)
801 LIST_FOREACH_SAFE(ph, &phash[i], le, tph)
803 EV_SET(&ke, ph->pid, EVFILT_PROC, EV_DELETE,
805 (void)kevent(kq, &ke, 1, NULL, 0, NULL);
812 * Find the jail that corresponds to an exited process.
814 static struct cfjail *
820 LIST_FOREACH(ph, &phash[pid % PHASH_SIZE], le)
821 if (ph->pid == pid) {
825 return --j->nprocs ? NULL : j;
831 * Send SIGTERM to all processes in a jail and wait for them to die.
834 term_procs(struct cfjail *j)
836 struct kinfo_proc *ki;
837 int i, noted, pcnt, timeout;
841 if (!int_param(j->intparams[IP_STOP_TIMEOUT], &timeout))
842 timeout = DEFAULT_STOP_TIMEOUT;
843 else if (timeout == 0)
847 kd = kvm_open(NULL, NULL, NULL, O_RDONLY, NULL);
852 ki = kvm_getprocs(kd, KERN_PROC_PROC, 0, &pcnt);
856 for (i = 0; i < pcnt; i++)
857 if (ki[i].ki_jid == j->jid &&
858 kill(ki[i].ki_pid, SIGTERM) == 0) {
859 (void)add_proc(j, ki[i].ki_pid);
863 jail_note(j, "sent SIGTERM to:");
865 printf(" %d", ki[i].ki_pid);
871 clock_gettime(CLOCK_REALTIME, &j->timeout);
872 j->timeout.tv_sec += timeout;
879 * Look up a user in the passwd and login.conf files.
882 get_user_info(struct cfjail *j, const char *username,
883 const struct passwd **pwdp, login_cap_t **lcapp)
885 const struct passwd *pwd;
888 *pwdp = pwd = username ? getpwnam(username) : getpwuid(getuid());
891 jail_warnx(j, "getpwnam%s%s: %s", username ? " " : "",
892 username ? username : "", strerror(errno));
894 jail_warnx(j, "%s: no such user", username);
896 jail_warnx(j, "unknown uid %d", getuid());
899 *lcapp = login_getpwclass(pwd);
900 if (*lcapp == NULL) {
901 jail_warnx(j, "getpwclass %s: %s", pwd->pw_name,
905 /* Set the groups while the group file is still available */
906 if (initgroups(pwd->pw_name, pwd->pw_gid) < 0) {
907 jail_warnx(j, "initgroups %s: %s", pwd->pw_name,
915 * Make sure a mount or consolelog path is a valid absolute pathname
919 check_path(struct cfjail *j, const char *pname, const char *path, int isfile,
920 const char *umount_type)
922 struct stat st, mpst;
925 const char *jailpath;
928 if (path[0] != '/') {
929 jail_warnx(j, "%s: %s: not an absolute pathname",
934 * Only check for symlinks in components below the jail's path,
935 * since that's where the security risk lies.
937 jailpath = string_param(j->intparams[KP_PATH]);
938 if (jailpath == NULL)
940 jplen = strlen(jailpath);
941 if (!strncmp(path, jailpath, jplen) && path[jplen] == '/') {
942 tpath = alloca(strlen(path) + 1);
944 for (p = tpath + jplen; p != NULL; ) {
945 p = strchr(p + 1, '/');
948 if (lstat(tpath, &st) < 0) {
949 if (errno == ENOENT && isfile && !p)
951 jail_warnx(j, "%s: %s: %s", pname, tpath,
955 if (S_ISLNK(st.st_mode)) {
956 jail_warnx(j, "%s: %s is a symbolic link",
964 if (umount_type != NULL) {
965 if (stat(path, &st) < 0 || statfs(path, &stfs) < 0) {
966 jail_warnx(j, "%s: %s: %s", pname, path,
970 if (stat(stfs.f_mntonname, &mpst) < 0) {
971 jail_warnx(j, "%s: %s: %s", pname, stfs.f_mntonname,
975 if (st.st_ino != mpst.st_ino) {
976 jail_warnx(j, "%s: %s: not a mount point",
980 if (strcmp(stfs.f_fstypename, umount_type)) {
981 jail_warnx(j, "%s: %s: not a %s mount",
982 pname, path, umount_type);