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[] = {
111 static const enum intparam stopcommands[] = {
121 IP__MOUNT_FROM_FSTAB,
133 main(int argc, char **argv)
141 int ch, docf, error, i, oldcl, sysval;
143 #if defined(INET) || defined(INET6)
146 #if defined(INET) && defined(INET6)
147 struct in6_addr addr6;
156 while ((ch = getopt(argc, argv, "cde:f:hiJ:lmn:p:qrRs:u:U:v")) != -1) {
172 #if defined(INET) || defined(INET6)
173 add_param(NULL, NULL, IP_IP_HOSTNAME, NULL);
185 add_param(NULL, NULL, IP_EXEC_CLEAN, NULL);
192 add_param(NULL, NULL, KP_NAME, optarg);
196 paralimit = strtol(optarg, NULL, 10);
211 add_param(NULL, NULL, KP_SECURELEVEL, optarg);
215 add_param(NULL, NULL, IP_EXEC_JAIL_USER, optarg);
216 add_param(NULL, NULL, IP_EXEC_SYSTEM_JAIL_USER, NULL);
220 add_param(NULL, NULL, IP_EXEC_JAIL_USER, optarg);
221 add_param(NULL, NULL, IP_EXEC_SYSTEM_JAIL_USER,
235 /* Find out which of the four command line styles this is. */
238 /* Old-style command line with four fixed parameters */
239 if (argc < 4 || argv[0][0] != '/')
244 add_param(NULL, NULL, KP_PATH, argv[0]);
245 add_param(NULL, NULL, KP_HOST_HOSTNAME, argv[1]);
246 #if defined(INET) || defined(INET6)
247 if (argv[2][0] != '\0') {
248 for (cs = argv[2];; cs = ncs + 1) {
249 ncs = strchr(cs, ',');
252 add_param(NULL, NULL,
253 #if defined(INET) && defined(INET6)
254 inet_pton(AF_INET6, cs, &addr6) == 1
255 ? KP_IP6_ADDR : KP_IP4_ADDR,
267 for (i = 3; i < argc; i++)
268 add_param(NULL, NULL, IP_COMMAND, argv[i]);
269 /* Emulate the defaults from security.jail.* sysctls. */
270 sysvallen = sizeof(sysval);
271 if (sysctlbyname("security.jail.jailed", &sysval, &sysvallen,
272 NULL, 0) == 0 && sysval == 0) {
273 for (pi = 0; pi < sizeof(perm_sysctl) /
274 sizeof(perm_sysctl[0]); pi++) {
275 sysvallen = sizeof(sysval);
276 if (sysctlbyname(perm_sysctl[pi].name,
277 &sysval, &sysvallen, NULL, 0) == 0)
278 add_param(NULL, NULL,
279 perm_sysctl[pi].ipnum,
285 } else if (op == JF_STOP || op == JF_SHOW) {
286 /* Just print list of all configured non-wildcard jails */
292 /* Jail remove, perhaps using the config file */
293 if (!docf || argc == 0)
296 for (i = 0; i < argc; i++)
297 if (strchr(argv[i], '='))
299 if ((docf = !Rflag &&
300 (!strcmp(cfname, "-") || stat(cfname, &st) == 0)))
302 note_remove = docf || argc > 1 || wild_jail_name(argv[0]);
303 } else if (argc > 1 || (argc == 1 && strchr(argv[0], '='))) {
304 /* Single jail specified on the command line */
308 for (i = 0; i < argc; i++) {
309 if (!strncmp(argv[i], "command", 7) &&
310 (argv[i][7] == '\0' || argv[i][7] == '=')) {
311 if (argv[i][7] == '=')
312 add_param(NULL, NULL, IP_COMMAND,
314 for (i++; i < argc; i++)
315 add_param(NULL, NULL, IP_COMMAND,
319 else if (!strncmp(argv[i], "ip4.addr=", 9)) {
320 for (cs = argv[i] + 9;; cs = ncs + 1) {
321 ncs = strchr(cs, ',');
324 add_param(NULL, NULL, KP_IP4_ADDR, cs);
331 else if (!strncmp(argv[i], "ip6.addr=", 9)) {
332 for (cs = argv[i] + 9;; cs = ncs + 1) {
333 ncs = strchr(cs, ',');
336 add_param(NULL, NULL, KP_IP6_ADDR, cs);
343 add_param(NULL, NULL, 0, argv[i]);
346 /* From the config file, perhaps with a specified jail */
352 /* Find out which jails will be run. */
356 for (i = 0; i < argc; i++)
357 if (start_state(argv[i], docf, op, Rflag) < 0)
360 if (start_state(argv[0], docf, op, 0) < 0)
365 if (JidFile != NULL) {
366 jfp = fopen(JidFile, "w");
368 err(1, "open %s", JidFile);
374 * The main loop: Get an available jail and perform the required
375 * operation on it. When that is done, the jail may be finished,
376 * or it may go back for the next step.
378 while ((j = next_jail()))
380 if (j->flags & JF_FAILED) {
382 if (j->comparam == NULL) {
387 if (!(j->flags & JF_PARAMS))
389 j->flags |= JF_PARAMS;
391 add_param(j, NULL, IP_ALLOW_DYING, NULL);
392 if (check_intparams(j) < 0)
394 if ((j->flags & (JF_START | JF_SET)) &&
395 import_params(j) < 0)
400 (j->flags & (JF_SET | JF_DEPEND)) == JF_SET
401 ? dflag || bool_param(j->intparams[IP_ALLOW_DYING])
403 if (finish_command(j))
406 switch (j->flags & JF_OP_MASK) {
408 * These operations just turn into a different op
409 * depending on the jail's current status.
412 j->flags = j->jid < 0 ? JF_START : JF_SET;
416 jail_quoted_warnx(j, "not found",
417 "no jail specified");
421 j->flags = rdtun_params(j, 0) ? JF_RESTART : JF_SET;
422 if (j->flags == JF_RESTART)
425 case JF_START_SET_RESTART:
426 j->flags = j->jid < 0 ? JF_START
427 : rdtun_params(j, 0) ? JF_RESTART : JF_SET;
428 if (j->flags == JF_RESTART)
432 switch (j->flags & JF_OP_MASK) {
434 if (j->comparam == NULL) {
436 !(j->flags & (JF_DEPEND | JF_WILD))) {
437 jail_quoted_warnx(j, "already exists",
445 goto jail_create_done;
446 j->comparam = startcommands;
454 print_jail(jfp, j, oldcl, 1);
459 if (j->jid < 0 && !(j->flags & JF_DEPEND)) {
460 jail_quoted_warnx(j, "not found",
461 "no jail specified");
467 if (!(j->flags & JF_DEPEND)) {
468 if (rdtun_params(j, 1) < 0 ||
471 if (verbose >= 0 && (j->name || verbose > 0))
472 jail_note(j, "updated\n");
479 if (j->comparam == NULL) {
483 if (!(j->flags & (JF_DEPEND|JF_WILD))) {
489 goto jail_remove_done;
491 j->comparam = stopcommands;
493 } else if ((j->flags & JF_FAILED) && j->jid > 0)
494 goto jail_remove_done;
499 if ((j->flags & (JF_START | JF_FAILED)) == JF_START) {
501 j->flags &= ~JF_STOP;
503 requeue(j, j->ndeps ? &depend : &ready);
515 * Mark a jail's failure for future handling.
518 failed(struct cfjail *j)
520 j->flags |= JF_FAILED;
521 TAILQ_REMOVE(j->queue, j, tq);
522 TAILQ_INSERT_HEAD(&ready, j, tq);
527 * Exit slightly more gracefully when out of memory.
541 erealloc(void *ptr, size_t size)
545 p = realloc(ptr, size);
552 estrdup(const char *str)
563 * Print a message including an optional jail name.
566 jail_note(const struct cfjail *j, const char *fmt, ...)
574 len = vsnprintf(NULL, 0, fmt, tap);
576 cs = alloca(len + 1);
577 (void)vsnprintf(cs, len + 1, fmt, ap);
580 printf("%s: %s", j->name, cs);
586 * Print a warning message including an optional jail name.
589 jail_warnx(const struct cfjail *j, const char *fmt, ...)
597 len = vsnprintf(NULL, 0, fmt, tap);
599 cs = alloca(len + 1);
600 (void)vsnprintf(cs, len + 1, fmt, ap);
603 warnx("%s: %s", j->name, cs);
612 create_jail(struct cfjail *j)
614 struct iovec jiov[4];
616 struct jailparam *jp, *setparams, *setparams2, *sjp;
618 int dopersist, ns, jid, dying, didfail;
621 * Check the jail's path, with a better error message than jail_set
624 if ((path = string_param(j->intparams[KP_PATH]))) {
625 if (j->name != NULL && path[0] != '/') {
626 jail_warnx(j, "path %s: not an absolute pathname",
630 if (stat(path, &st) < 0) {
631 jail_warnx(j, "path %s: %s", path, strerror(errno));
634 if (!S_ISDIR(st.st_mode)) {
635 jail_warnx(j, "path %s: %s", path, strerror(ENOTDIR));
641 * Copy all the parameters, except that "persist" is always set when
642 * there are commands to run later.
644 dopersist = !bool_param(j->intparams[KP_PERSIST]) &&
645 (j->intparams[IP_EXEC_START] || j->intparams[IP_COMMAND] ||
646 j->intparams[IP_EXEC_POSTSTART]);
648 alloca((j->njp + dopersist) * sizeof(struct jailparam));
649 if (dopersist && jailparam_init(sjp++, "persist") < 0) {
650 jail_warnx(j, "%s", jail_errmsg);
653 for (jp = j->jp; jp < j->jp + j->njp; jp++)
654 if (!dopersist || !equalopts(jp->jp_name, "persist"))
656 ns = sjp - setparams;
659 j->jid = jailparam_set_note(j, setparams, ns, JAIL_CREATE);
660 if (j->jid < 0 && errno == EEXIST &&
661 bool_param(j->intparams[IP_ALLOW_DYING]) &&
662 int_param(j->intparams[KP_JID], &jid) && jid != 0) {
664 * The jail already exists, but may be dying.
665 * Make sure it is, in which case an update is appropriate.
667 jiov[0].iov_base = __DECONST(char *, "jid");
668 jiov[0].iov_len = sizeof("jid");
669 jiov[1].iov_base = &jid;
670 jiov[1].iov_len = sizeof(jid);
671 jiov[2].iov_base = __DECONST(char *, "dying");
672 jiov[2].iov_len = sizeof("dying");
673 jiov[3].iov_base = &dying;
674 jiov[3].iov_len = sizeof(dying);
675 if (jail_get(jiov, 4, JAIL_DYING) < 0) {
677 * It could be that the jail just barely finished
678 * dying, or it could be that the jid never existed
679 * but the name does. In either case, another try
680 * at creating the jail should do the right thing.
683 j->jid = jailparam_set_note(j, setparams, ns,
687 if (rdtun_params(j, 1) < 0) {
691 sjp = setparams2 = alloca((j->njp + dopersist) *
692 sizeof(struct jailparam));
693 for (jp = setparams; jp < setparams + ns; jp++)
695 !strcmp(jp->jp_name, "jid"))
697 j->jid = jailparam_set_note(j, setparams2,
698 sjp - setparams2, JAIL_UPDATE | JAIL_DYING);
700 * Again, perhaps the jail just finished dying.
702 if (j->jid < 0 && errno == ENOENT)
703 j->jid = jailparam_set_note(j,
704 setparams, ns, JAIL_CREATE);
708 if (j->jid < 0 && !didfail) {
709 jail_warnx(j, "%s", jail_errmsg);
713 jailparam_free(setparams, 1);
715 j->flags |= JF_PERSIST;
721 * Remove a temporarily set "persist" parameter.
724 clear_persist(struct cfjail *j)
726 struct iovec jiov[4];
729 if (!(j->flags & JF_PERSIST))
731 j->flags &= ~JF_PERSIST;
732 jiov[0].iov_base = __DECONST(char *, "jid");
733 jiov[0].iov_len = sizeof("jid");
734 jiov[1].iov_base = &j->jid;
735 jiov[1].iov_len = sizeof(j->jid);
736 jiov[2].iov_base = __DECONST(char *, "nopersist");
737 jiov[2].iov_len = sizeof("nopersist");
738 jiov[3].iov_base = NULL;
740 jid = jail_set(jiov, 4, JAIL_UPDATE);
742 jail_note(j, "jail_set(JAIL_UPDATE) jid=%d nopersist%s%s\n",
743 j->jid, jid < 0 ? ": " : "",
744 jid < 0 ? strerror(errno) : "");
748 * Set a jail's parameters.
751 update_jail(struct cfjail *j)
753 struct jailparam *jp, *setparams, *sjp;
757 for (jp = j->jp; jp < j->jp + j->njp; jp++)
762 sjp = setparams = alloca(++ns * sizeof(struct jailparam));
763 if (jailparam_init(sjp, "jid") < 0 ||
764 jailparam_import_raw(sjp, &j->jid, sizeof j->jid) < 0) {
765 jail_warnx(j, "%s", jail_errmsg);
769 for (jp = j->jp; jp < j->jp + j->njp; jp++)
773 jid = jailparam_set_note(j, setparams, ns,
774 bool_param(j->intparams[IP_ALLOW_DYING])
775 ? JAIL_UPDATE | JAIL_DYING : JAIL_UPDATE);
777 jail_warnx(j, "%s", jail_errmsg);
780 jailparam_free(setparams, 1);
785 * Return if a jail set would change any create-only parameters.
788 rdtun_params(struct cfjail *j, int dofail)
790 struct jailparam *jp, *rtparams, *rtjp;
793 if (j->flags & JF_RDTUN)
795 j->flags |= JF_RDTUN;
797 for (jp = j->jp; jp < j->jp + j->njp; jp++)
798 if (JP_RDTUN(jp) && strcmp(jp->jp_name, "jid"))
802 rtjp = rtparams = alloca(++nrt * sizeof(struct jailparam));
803 if (jailparam_init(rtjp, "jid") < 0 ||
804 jailparam_import_raw(rtjp, &j->jid, sizeof j->jid) < 0) {
805 jail_warnx(j, "%s", jail_errmsg);
808 for (jp = j->jp; jp < j->jp + j->njp; jp++)
809 if (JP_RDTUN(jp) && strcmp(jp->jp_name, "jid")) {
811 rtjp->jp_value = NULL;
814 if (jailparam_get(rtparams, nrt,
815 bool_param(j->intparams[IP_ALLOW_DYING]) ? JAIL_DYING : 0) > 0) {
817 for (jp = j->jp; rtjp < rtparams + nrt; jp++) {
818 if (JP_RDTUN(jp) && strcmp(jp->jp_name, "jid")) {
819 if (!((jp->jp_flags & (JP_BOOL | JP_NOBOOL)) &&
820 jp->jp_valuelen == 0 &&
821 *(int *)jp->jp_value) &&
822 !(rtjp->jp_valuelen == jp->jp_valuelen &&
823 !((jp->jp_ctltype & CTLTYPE) ==
824 CTLTYPE_STRING ? strncmp(rtjp->jp_value,
825 jp->jp_value, jp->jp_valuelen) :
826 memcmp(rtjp->jp_value, jp->jp_value,
827 jp->jp_valuelen)))) {
829 jail_warnx(j, "%s cannot be "
830 "changed after creation",
842 for (rtjp = rtparams + 1; rtjp < rtparams + nrt; rtjp++)
843 rtjp->jp_name = NULL;
844 jailparam_free(rtparams, nrt);
849 * Get the jail's jid if it is running.
852 running_jid(struct cfjail *j, int dflag)
854 struct iovec jiov[2];
859 if ((pval = string_param(j->intparams[KP_JID]))) {
860 if (!(jid = strtol(pval, &ep, 10)) || *ep) {
864 jiov[0].iov_base = __DECONST(char *, "jid");
865 jiov[0].iov_len = sizeof("jid");
866 jiov[1].iov_base = &jid;
867 jiov[1].iov_len = sizeof(jid);
868 } else if ((pval = string_param(j->intparams[KP_NAME]))) {
869 jiov[0].iov_base = __DECONST(char *, "name");
870 jiov[0].iov_len = sizeof("name");
871 jiov[1].iov_len = strlen(pval) + 1;
872 jiov[1].iov_base = alloca(jiov[1].iov_len);
873 strcpy(jiov[1].iov_base, pval);
878 j->jid = jail_get(jiov, 2, dflag ? JAIL_DYING : 0);
882 jail_quoted_warnx(const struct cfjail *j, const char *name_msg,
883 const char *noname_msg)
887 if ((pval = j->name) || (pval = string_param(j->intparams[KP_JID])) ||
888 (pval = string_param(j->intparams[KP_NAME])))
889 warnx("\"%s\" %s", pval, name_msg);
891 warnx("%s", noname_msg);
895 * Set jail parameters and possibly print them out.
898 jailparam_set_note(const struct cfjail *j, struct jailparam *jp, unsigned njp,
905 jid = jailparam_set(jp, njp, flags);
907 jail_note(j, "jail_set(%s%s)",
908 (flags & (JAIL_CREATE | JAIL_UPDATE)) == JAIL_CREATE
909 ? "JAIL_CREATE" : "JAIL_UPDATE",
910 (flags & JAIL_DYING) ? " | JAIL_DYING" : "");
911 for (i = 0; i < njp; i++) {
912 printf(" %s", jp[i].jp_name);
913 if (jp[i].jp_value == NULL)
916 value = jailparam_export(jp + i);
918 err(1, "jailparam_export");
919 quoted_print(stdout, value);
923 printf(": %s", strerror(errno));
930 * Print a jail record.
933 print_jail(FILE *fp, struct cfjail *j, int oldcl, int running)
940 fprintf(fp, "%d%s", j->jid, separator);
941 print_param(fp, j->intparams[KP_PATH], ',', 0);
942 fputs(separator, fp);
943 print_param(fp, j->intparams[KP_HOST_HOSTNAME], ',', 0);
944 fputs(separator, fp);
946 print_param(fp, j->intparams[KP_IP4_ADDR], ',', 0);
948 if (j->intparams[KP_IP4_ADDR] &&
949 !TAILQ_EMPTY(&j->intparams[KP_IP4_ADDR]->val) &&
950 j->intparams[KP_IP6_ADDR] &&
951 !TAILQ_EMPTY(&j->intparams[KP_IP6_ADDR]->val))
956 print_param(fp, j->intparams[KP_IP6_ADDR], ',', 0);
958 fputs(separator, fp);
959 print_param(fp, j->intparams[IP_COMMAND], ' ', 0);
963 fprintf(fp, "jid=%d", j->jid);
966 TAILQ_FOREACH(p, &j->params, tq)
967 if (strcmp(p->name, "jid")) {
969 fputs(separator, fp);
972 print_param(fp, p, ',', 1);
979 * Exhibit list of all configured non-wildcard jails
986 TAILQ_FOREACH(j, &cfjails, tq)
987 print_jail(stdout, j, 0, 0);
991 * Print a parameter value, or a name=value pair.
994 print_param(FILE *fp, const struct cfparam *p, int sep, int doname)
996 const struct cfstring *s, *ts;
1000 if (p == NULL || TAILQ_EMPTY(&p->val))
1004 TAILQ_FOREACH_SAFE(s, &p->val, tq, ts) {
1005 quoted_print(fp, s->s);
1012 * Print a string with quotes around spaces.
1015 quoted_print(FILE *fp, char *str)
1021 : strchr(p, '\'') ? '"'
1022 : strchr(p, '"') ? '\''
1023 : strchr(p, ' ') || strchr(p, '\t') ? '"'
1027 while ((c = *p++)) {
1028 if (c == '\\' || c == qc)
1040 (void)fprintf(stderr,
1041 "usage: jail [-dhilqv] [-J jid_file] [-u username] [-U username]\n"
1042 " -[cmr] param=value ... [command=command ...]\n"
1043 " jail [-dqv] [-f file] [-e separator] -[cmr] [jail]\n"
1044 " jail [-qv] [-f file] -[rR] ['*' | jail ...]\n"
1045 " jail [-dhilqv] [-J jid_file] [-u username] [-U username]\n"
1046 " [-n jailname] [-s securelevel]\n"
1047 " path hostname [ip[,...]] command ...\n");