2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1999 Poul-Henning Kamp.
5 * Copyright (c) 2009-2012 James Gritton
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/types.h>
35 #include <sys/socket.h>
36 #include <sys/sysctl.h>
38 #include <arpa/inet.h>
39 #include <netinet/in.h>
51 #define JP_RDTUN(jp) (((jp)->jp_ctltype & CTLFLAG_RDTUN) == CTLFLAG_RDTUN)
63 const char *separator = "\t";
65 static void clear_persist(struct cfjail *j);
66 static int update_jail(struct cfjail *j);
67 static int rdtun_params(struct cfjail *j, int dofail);
68 static void running_jid(struct cfjail *j, int dflag);
69 static void jail_quoted_warnx(const struct cfjail *j, const char *name_msg,
70 const char *noname_msg);
71 static int jailparam_set_note(const struct cfjail *j, struct jailparam *jp,
72 unsigned njp, int flags);
73 static void print_jail(FILE *fp, struct cfjail *j, int oldcl, int running);
74 static void print_param(FILE *fp, const struct cfparam *p, int sep, int doname);
75 static void show_jails(void);
76 static void quoted_print(FILE *fp, char *str);
77 static void usage(void);
79 static struct permspec perm_sysctl[] = {
80 { "security.jail.set_hostname_allowed", KP_ALLOW_SET_HOSTNAME, 0 },
81 { "security.jail.sysvipc_allowed", KP_ALLOW_SYSVIPC, 0 },
82 { "security.jail.allow_raw_sockets", KP_ALLOW_RAW_SOCKETS, 0 },
83 { "security.jail.chflags_allowed", KP_ALLOW_CHFLAGS, 0 },
84 { "security.jail.mount_allowed", KP_ALLOW_MOUNT, 0 },
85 { "security.jail.socket_unixiproute_only", KP_ALLOW_SOCKET_AF, 1 },
88 static const enum intparam startcommands[] = {
112 static const enum intparam stopcommands[] = {
122 IP__MOUNT_FROM_FSTAB,
135 main(int argc, char **argv)
143 int ch, docf, error, i, oldcl, sysval;
145 #if defined(INET) || defined(INET6)
148 #if defined(INET) && defined(INET6)
149 struct in6_addr addr6;
158 while ((ch = getopt(argc, argv, "cde:f:hiJ:lmn:p:qrRs:u:U:v")) != -1) {
174 #if defined(INET) || defined(INET6)
175 add_param(NULL, NULL, IP_IP_HOSTNAME, NULL);
187 add_param(NULL, NULL, IP_EXEC_CLEAN, NULL);
194 add_param(NULL, NULL, KP_NAME, optarg);
198 paralimit = strtol(optarg, NULL, 10);
213 add_param(NULL, NULL, KP_SECURELEVEL, optarg);
217 add_param(NULL, NULL, IP_EXEC_JAIL_USER, optarg);
218 add_param(NULL, NULL, IP_EXEC_SYSTEM_JAIL_USER, NULL);
222 add_param(NULL, NULL, IP_EXEC_JAIL_USER, optarg);
223 add_param(NULL, NULL, IP_EXEC_SYSTEM_JAIL_USER,
237 /* Find out which of the four command line styles this is. */
240 /* Old-style command line with four fixed parameters */
241 if (argc < 4 || argv[0][0] != '/')
246 add_param(NULL, NULL, KP_PATH, argv[0]);
247 add_param(NULL, NULL, KP_HOST_HOSTNAME, argv[1]);
248 #if defined(INET) || defined(INET6)
249 if (argv[2][0] != '\0') {
250 for (cs = argv[2];; cs = ncs + 1) {
251 ncs = strchr(cs, ',');
254 add_param(NULL, NULL,
255 #if defined(INET) && defined(INET6)
256 inet_pton(AF_INET6, cs, &addr6) == 1
257 ? KP_IP6_ADDR : KP_IP4_ADDR,
269 for (i = 3; i < argc; i++)
270 add_param(NULL, NULL, IP_COMMAND, argv[i]);
271 /* Emulate the defaults from security.jail.* sysctls. */
272 sysvallen = sizeof(sysval);
273 if (sysctlbyname("security.jail.jailed", &sysval, &sysvallen,
274 NULL, 0) == 0 && sysval == 0) {
275 for (pi = 0; pi < sizeof(perm_sysctl) /
276 sizeof(perm_sysctl[0]); pi++) {
277 sysvallen = sizeof(sysval);
278 if (sysctlbyname(perm_sysctl[pi].name,
279 &sysval, &sysvallen, NULL, 0) == 0)
280 add_param(NULL, NULL,
281 perm_sysctl[pi].ipnum,
287 } else if (op == JF_STOP || op == JF_SHOW) {
288 /* Just print list of all configured non-wildcard jails */
294 /* Jail remove, perhaps using the config file */
295 if (!docf || argc == 0)
298 for (i = 0; i < argc; i++)
299 if (strchr(argv[i], '='))
301 if ((docf = !Rflag &&
302 (!strcmp(cfname, "-") || stat(cfname, &st) == 0)))
304 note_remove = docf || argc > 1 || wild_jail_name(argv[0]);
305 } else if (argc > 1 || (argc == 1 && strchr(argv[0], '='))) {
306 /* Single jail specified on the command line */
310 for (i = 0; i < argc; i++) {
311 if (!strncmp(argv[i], "command", 7) &&
312 (argv[i][7] == '\0' || argv[i][7] == '=')) {
313 if (argv[i][7] == '=')
314 add_param(NULL, NULL, IP_COMMAND,
316 for (i++; i < argc; i++)
317 add_param(NULL, NULL, IP_COMMAND,
321 else if (!strncmp(argv[i], "ip4.addr=", 9)) {
322 for (cs = argv[i] + 9;; cs = ncs + 1) {
323 ncs = strchr(cs, ',');
326 add_param(NULL, NULL, KP_IP4_ADDR, cs);
333 else if (!strncmp(argv[i], "ip6.addr=", 9)) {
334 for (cs = argv[i] + 9;; cs = ncs + 1) {
335 ncs = strchr(cs, ',');
338 add_param(NULL, NULL, KP_IP6_ADDR, cs);
345 add_param(NULL, NULL, 0, argv[i]);
348 /* From the config file, perhaps with a specified jail */
354 /* Find out which jails will be run. */
358 for (i = 0; i < argc; i++)
359 if (start_state(argv[i], docf, op, Rflag) < 0)
362 if (start_state(argv[0], docf, op, 0) < 0)
367 if (JidFile != NULL) {
368 jfp = fopen(JidFile, "w");
370 err(1, "open %s", JidFile);
376 * The main loop: Get an available jail and perform the required
377 * operation on it. When that is done, the jail may be finished,
378 * or it may go back for the next step.
380 while ((j = next_jail()))
382 if (j->flags & JF_FAILED) {
384 if (j->comparam == NULL) {
389 if (!(j->flags & JF_PARAMS))
391 j->flags |= JF_PARAMS;
393 add_param(j, NULL, IP_ALLOW_DYING, NULL);
394 if (check_intparams(j) < 0)
396 if ((j->flags & (JF_START | JF_SET)) &&
397 import_params(j) < 0)
402 (j->flags & (JF_SET | JF_DEPEND)) == JF_SET
403 ? dflag || bool_param(j->intparams[IP_ALLOW_DYING])
405 if (finish_command(j))
408 switch (j->flags & JF_OP_MASK) {
410 * These operations just turn into a different op
411 * depending on the jail's current status.
414 j->flags = j->jid < 0 ? JF_START : JF_SET;
418 jail_quoted_warnx(j, "not found",
419 "no jail specified");
423 j->flags = rdtun_params(j, 0) ? JF_RESTART : JF_SET;
424 if (j->flags == JF_RESTART)
427 case JF_START_SET_RESTART:
428 j->flags = j->jid < 0 ? JF_START
429 : rdtun_params(j, 0) ? JF_RESTART : JF_SET;
430 if (j->flags == JF_RESTART)
434 switch (j->flags & JF_OP_MASK) {
436 if (j->comparam == NULL) {
438 !(j->flags & (JF_DEPEND | JF_WILD))) {
439 jail_quoted_warnx(j, "already exists",
447 goto jail_create_done;
448 j->comparam = startcommands;
456 print_jail(jfp, j, oldcl, 1);
461 if (j->jid < 0 && !(j->flags & JF_DEPEND)) {
462 jail_quoted_warnx(j, "not found",
463 "no jail specified");
469 if (!(j->flags & JF_DEPEND)) {
470 if (rdtun_params(j, 1) < 0 ||
473 if (verbose >= 0 && (j->name || verbose > 0))
474 jail_note(j, "updated\n");
481 if (j->comparam == NULL) {
485 if (!(j->flags & (JF_DEPEND|JF_WILD))) {
491 goto jail_remove_done;
493 j->comparam = stopcommands;
495 } else if ((j->flags & JF_FAILED) && j->jid > 0)
496 goto jail_remove_done;
501 if ((j->flags & (JF_START | JF_FAILED)) == JF_START) {
503 j->flags &= ~JF_STOP;
505 requeue(j, j->ndeps ? &depend : &ready);
517 * Mark a jail's failure for future handling.
520 failed(struct cfjail *j)
522 j->flags |= JF_FAILED;
523 TAILQ_REMOVE(j->queue, j, tq);
524 TAILQ_INSERT_HEAD(&ready, j, tq);
529 * Exit slightly more gracefully when out of memory.
543 erealloc(void *ptr, size_t size)
547 p = realloc(ptr, size);
554 estrdup(const char *str)
565 * Print a message including an optional jail name.
568 jail_note(const struct cfjail *j, const char *fmt, ...)
576 len = vsnprintf(NULL, 0, fmt, tap);
578 cs = alloca(len + 1);
579 (void)vsnprintf(cs, len + 1, fmt, ap);
582 printf("%s: %s", j->name, cs);
588 * Print a warning message including an optional jail name.
591 jail_warnx(const struct cfjail *j, const char *fmt, ...)
599 len = vsnprintf(NULL, 0, fmt, tap);
601 cs = alloca(len + 1);
602 (void)vsnprintf(cs, len + 1, fmt, ap);
605 warnx("%s: %s", j->name, cs);
614 create_jail(struct cfjail *j)
616 struct iovec jiov[4];
618 struct jailparam *jp, *setparams, *setparams2, *sjp;
620 int dopersist, ns, jid, dying, didfail;
623 * Check the jail's path, with a better error message than jail_set
626 if ((path = string_param(j->intparams[KP_PATH]))) {
627 if (j->name != NULL && path[0] != '/') {
628 jail_warnx(j, "path %s: not an absolute pathname",
632 if (stat(path, &st) < 0) {
633 jail_warnx(j, "path %s: %s", path, strerror(errno));
636 if (!S_ISDIR(st.st_mode)) {
637 jail_warnx(j, "path %s: %s", path, strerror(ENOTDIR));
643 * Copy all the parameters, except that "persist" is always set when
644 * there are commands to run later.
646 dopersist = !bool_param(j->intparams[KP_PERSIST]) &&
647 (j->intparams[IP_EXEC_START] || j->intparams[IP_COMMAND] ||
648 j->intparams[IP_EXEC_POSTSTART]);
650 alloca((j->njp + dopersist) * sizeof(struct jailparam));
651 if (dopersist && jailparam_init(sjp++, "persist") < 0) {
652 jail_warnx(j, "%s", jail_errmsg);
655 for (jp = j->jp; jp < j->jp + j->njp; jp++)
656 if (!dopersist || !equalopts(jp->jp_name, "persist"))
658 ns = sjp - setparams;
661 j->jid = jailparam_set_note(j, setparams, ns, JAIL_CREATE);
662 if (j->jid < 0 && errno == EEXIST &&
663 bool_param(j->intparams[IP_ALLOW_DYING]) &&
664 int_param(j->intparams[KP_JID], &jid) && jid != 0) {
666 * The jail already exists, but may be dying.
667 * Make sure it is, in which case an update is appropriate.
669 jiov[0].iov_base = __DECONST(char *, "jid");
670 jiov[0].iov_len = sizeof("jid");
671 jiov[1].iov_base = &jid;
672 jiov[1].iov_len = sizeof(jid);
673 jiov[2].iov_base = __DECONST(char *, "dying");
674 jiov[2].iov_len = sizeof("dying");
675 jiov[3].iov_base = &dying;
676 jiov[3].iov_len = sizeof(dying);
677 if (jail_get(jiov, 4, JAIL_DYING) < 0) {
679 * It could be that the jail just barely finished
680 * dying, or it could be that the jid never existed
681 * but the name does. In either case, another try
682 * at creating the jail should do the right thing.
685 j->jid = jailparam_set_note(j, setparams, ns,
689 if (rdtun_params(j, 1) < 0) {
693 sjp = setparams2 = alloca((j->njp + dopersist) *
694 sizeof(struct jailparam));
695 for (jp = setparams; jp < setparams + ns; jp++)
697 !strcmp(jp->jp_name, "jid"))
699 j->jid = jailparam_set_note(j, setparams2,
700 sjp - setparams2, JAIL_UPDATE | JAIL_DYING);
702 * Again, perhaps the jail just finished dying.
704 if (j->jid < 0 && errno == ENOENT)
705 j->jid = jailparam_set_note(j,
706 setparams, ns, JAIL_CREATE);
710 if (j->jid < 0 && !didfail) {
711 jail_warnx(j, "%s", jail_errmsg);
715 jailparam_free(setparams, 1);
717 j->flags |= JF_PERSIST;
723 * Remove a temporarily set "persist" parameter.
726 clear_persist(struct cfjail *j)
728 struct iovec jiov[4];
731 if (!(j->flags & JF_PERSIST))
733 j->flags &= ~JF_PERSIST;
734 jiov[0].iov_base = __DECONST(char *, "jid");
735 jiov[0].iov_len = sizeof("jid");
736 jiov[1].iov_base = &j->jid;
737 jiov[1].iov_len = sizeof(j->jid);
738 jiov[2].iov_base = __DECONST(char *, "nopersist");
739 jiov[2].iov_len = sizeof("nopersist");
740 jiov[3].iov_base = NULL;
742 jid = jail_set(jiov, 4, JAIL_UPDATE);
744 jail_note(j, "jail_set(JAIL_UPDATE) jid=%d nopersist%s%s\n",
745 j->jid, jid < 0 ? ": " : "",
746 jid < 0 ? strerror(errno) : "");
750 * Set a jail's parameters.
753 update_jail(struct cfjail *j)
755 struct jailparam *jp, *setparams, *sjp;
759 for (jp = j->jp; jp < j->jp + j->njp; jp++)
764 sjp = setparams = alloca(++ns * sizeof(struct jailparam));
765 if (jailparam_init(sjp, "jid") < 0 ||
766 jailparam_import_raw(sjp, &j->jid, sizeof j->jid) < 0) {
767 jail_warnx(j, "%s", jail_errmsg);
771 for (jp = j->jp; jp < j->jp + j->njp; jp++)
775 jid = jailparam_set_note(j, setparams, ns,
776 bool_param(j->intparams[IP_ALLOW_DYING])
777 ? JAIL_UPDATE | JAIL_DYING : JAIL_UPDATE);
779 jail_warnx(j, "%s", jail_errmsg);
782 jailparam_free(setparams, 1);
787 * Return if a jail set would change any create-only parameters.
790 rdtun_params(struct cfjail *j, int dofail)
792 struct jailparam *jp, *rtparams, *rtjp;
795 if (j->flags & JF_RDTUN)
797 j->flags |= JF_RDTUN;
799 for (jp = j->jp; jp < j->jp + j->njp; jp++)
800 if (JP_RDTUN(jp) && strcmp(jp->jp_name, "jid"))
804 rtjp = rtparams = alloca(++nrt * sizeof(struct jailparam));
805 if (jailparam_init(rtjp, "jid") < 0 ||
806 jailparam_import_raw(rtjp, &j->jid, sizeof j->jid) < 0) {
807 jail_warnx(j, "%s", jail_errmsg);
810 for (jp = j->jp; jp < j->jp + j->njp; jp++)
811 if (JP_RDTUN(jp) && strcmp(jp->jp_name, "jid")) {
813 rtjp->jp_value = NULL;
816 if (jailparam_get(rtparams, nrt,
817 bool_param(j->intparams[IP_ALLOW_DYING]) ? JAIL_DYING : 0) > 0) {
819 for (jp = j->jp; rtjp < rtparams + nrt; jp++) {
820 if (JP_RDTUN(jp) && strcmp(jp->jp_name, "jid")) {
821 if (!((jp->jp_flags & (JP_BOOL | JP_NOBOOL)) &&
822 jp->jp_valuelen == 0 &&
823 *(int *)jp->jp_value) &&
824 !(rtjp->jp_valuelen == jp->jp_valuelen &&
825 !((jp->jp_ctltype & CTLTYPE) ==
826 CTLTYPE_STRING ? strncmp(rtjp->jp_value,
827 jp->jp_value, jp->jp_valuelen) :
828 memcmp(rtjp->jp_value, jp->jp_value,
829 jp->jp_valuelen)))) {
831 jail_warnx(j, "%s cannot be "
832 "changed after creation",
844 for (rtjp = rtparams + 1; rtjp < rtparams + nrt; rtjp++)
845 rtjp->jp_name = NULL;
846 jailparam_free(rtparams, nrt);
851 * Get the jail's jid if it is running.
854 running_jid(struct cfjail *j, int dflag)
856 struct iovec jiov[2];
861 if ((pval = string_param(j->intparams[KP_JID]))) {
862 if (!(jid = strtol(pval, &ep, 10)) || *ep) {
866 jiov[0].iov_base = __DECONST(char *, "jid");
867 jiov[0].iov_len = sizeof("jid");
868 jiov[1].iov_base = &jid;
869 jiov[1].iov_len = sizeof(jid);
870 } else if ((pval = string_param(j->intparams[KP_NAME]))) {
871 jiov[0].iov_base = __DECONST(char *, "name");
872 jiov[0].iov_len = sizeof("name");
873 jiov[1].iov_len = strlen(pval) + 1;
874 jiov[1].iov_base = alloca(jiov[1].iov_len);
875 strcpy(jiov[1].iov_base, pval);
880 j->jid = jail_get(jiov, 2, dflag ? JAIL_DYING : 0);
884 jail_quoted_warnx(const struct cfjail *j, const char *name_msg,
885 const char *noname_msg)
889 if ((pval = j->name) || (pval = string_param(j->intparams[KP_JID])) ||
890 (pval = string_param(j->intparams[KP_NAME])))
891 warnx("\"%s\" %s", pval, name_msg);
893 warnx("%s", noname_msg);
897 * Set jail parameters and possibly print them out.
900 jailparam_set_note(const struct cfjail *j, struct jailparam *jp, unsigned njp,
907 jid = jailparam_set(jp, njp, flags);
909 jail_note(j, "jail_set(%s%s)",
910 (flags & (JAIL_CREATE | JAIL_UPDATE)) == JAIL_CREATE
911 ? "JAIL_CREATE" : "JAIL_UPDATE",
912 (flags & JAIL_DYING) ? " | JAIL_DYING" : "");
913 for (i = 0; i < njp; i++) {
914 printf(" %s", jp[i].jp_name);
915 if (jp[i].jp_value == NULL)
918 value = jailparam_export(jp + i);
920 err(1, "jailparam_export");
921 quoted_print(stdout, value);
925 printf(": %s", strerror(errno));
932 * Print a jail record.
935 print_jail(FILE *fp, struct cfjail *j, int oldcl, int running)
942 fprintf(fp, "%d%s", j->jid, separator);
943 print_param(fp, j->intparams[KP_PATH], ',', 0);
944 fputs(separator, fp);
945 print_param(fp, j->intparams[KP_HOST_HOSTNAME], ',', 0);
946 fputs(separator, fp);
948 print_param(fp, j->intparams[KP_IP4_ADDR], ',', 0);
950 if (j->intparams[KP_IP4_ADDR] &&
951 !TAILQ_EMPTY(&j->intparams[KP_IP4_ADDR]->val) &&
952 j->intparams[KP_IP6_ADDR] &&
953 !TAILQ_EMPTY(&j->intparams[KP_IP6_ADDR]->val))
958 print_param(fp, j->intparams[KP_IP6_ADDR], ',', 0);
960 fputs(separator, fp);
961 print_param(fp, j->intparams[IP_COMMAND], ' ', 0);
965 fprintf(fp, "jid=%d", j->jid);
968 TAILQ_FOREACH(p, &j->params, tq)
969 if (strcmp(p->name, "jid")) {
971 fputs(separator, fp);
974 print_param(fp, p, ',', 1);
981 * Exhibit list of all configured non-wildcard jails
988 TAILQ_FOREACH(j, &cfjails, tq)
989 print_jail(stdout, j, 0, 0);
993 * Print a parameter value, or a name=value pair.
996 print_param(FILE *fp, const struct cfparam *p, int sep, int doname)
998 const struct cfstring *s, *ts;
1002 if (p == NULL || TAILQ_EMPTY(&p->val))
1006 TAILQ_FOREACH_SAFE(s, &p->val, tq, ts) {
1007 quoted_print(fp, s->s);
1014 * Print a string with quotes around spaces.
1017 quoted_print(FILE *fp, char *str)
1023 : strchr(p, '\'') ? '"'
1024 : strchr(p, '"') ? '\''
1025 : strchr(p, ' ') || strchr(p, '\t') ? '"'
1029 while ((c = *p++)) {
1030 if (c == '\\' || c == qc)
1042 (void)fprintf(stderr,
1043 "usage: jail [-dhilqv] [-J jid_file] [-u username] [-U username]\n"
1044 " -[cmr] param=value ... [command=command ...]\n"
1045 " jail [-dqv] [-f file] -[cmr] [jail]\n"
1046 " jail [-qv] [-f file] -[rR] ['*' | jail ...]\n"
1047 " jail [-dhilqv] [-J jid_file] [-u username] [-U username]\n"
1048 " [-n jailname] [-s securelevel]\n"
1049 " path hostname [ip[,...]] command ...\n"
1050 " jail [-f file] -e separator\n");