2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1999 Poul-Henning Kamp.
5 * Copyright (c) 2009 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
54 #define JAIL_API_VERSION 2
57 * For all xprison structs, always keep the pr_version an int and
58 * the first variable so userspace can easily distinguish them.
64 char pr_path[MAXPATHLEN];
65 char pr_host[MAXHOSTNAMELEN];
74 cpusetid_t pr_cpusetid;
75 char pr_path[MAXPATHLEN];
76 char pr_host[MAXHOSTNAMELEN];
77 char pr_name[MAXHOSTNAMELEN];
82 * sizeof(xprison) will be malloced + size needed for all
83 * IPv4 and IPv6 addesses. Offsets are based numbers of addresses.
85 struct in_addr pr_ip4[];
86 struct in6_addr pr_ip6[];
89 #define XPRISON_VERSION 3
91 #define PRISON_STATE_INVALID 0
92 #define PRISON_STATE_ALIVE 1
93 #define PRISON_STATE_DYING 2
96 * Flags for jail_set and jail_get.
98 #define JAIL_CREATE 0x01 /* Create jail if it doesn't exist */
99 #define JAIL_UPDATE 0x02 /* Update parameters of existing jail */
100 #define JAIL_ATTACH 0x04 /* Attach to jail upon creation */
101 #define JAIL_DYING 0x08 /* Allow getting a dying jail */
102 #define JAIL_SET_MASK 0x0f
103 #define JAIL_GET_MASK 0x08
105 #define JAIL_SYS_DISABLE 0
106 #define JAIL_SYS_NEW 1
107 #define JAIL_SYS_INHERIT 2
114 int jail(struct jail *);
115 int jail_set(struct iovec *, unsigned int, int);
116 int jail_get(struct iovec *, unsigned int, int);
117 int jail_attach(int);
118 int jail_remove(int);
123 #include <sys/queue.h>
124 #include <sys/sysctl.h>
125 #include <sys/lock.h>
126 #include <sys/mutex.h>
127 #include <sys/_task.h>
129 #define JAIL_MAX 999999
131 #ifdef MALLOC_DECLARE
132 MALLOC_DECLARE(M_PRISON);
136 #if defined(_KERNEL) || defined(_WANT_PRISON)
140 #define HOSTUUIDLEN 64
141 #define OSRELEASELEN 32
147 * This structure describes a prison. It is pointed to by all struct
148 * ucreds's of the inmates. pr_ref keeps track of them and is used to
149 * delete the struture when the last inmate is dead.
153 * (p) locked by pr_mtx
154 * (c) set only during creation before the structure is shared, no mutex
158 TAILQ_ENTRY(prison) pr_list; /* (a) all prisons */
159 int pr_id; /* (c) prison id */
160 int pr_ref; /* (p) refcount */
161 int pr_uref; /* (p) user (alive) refcount */
162 unsigned pr_flags; /* (p) PR_* flags */
163 LIST_HEAD(, prison) pr_children; /* (a) list of child jails */
164 LIST_ENTRY(prison) pr_sibling; /* (a) next in parent's list */
165 struct prison *pr_parent; /* (c) containing jail */
167 struct task pr_task; /* (c) destroy task */
168 struct osd pr_osd; /* (p) additional data */
169 struct cpuset *pr_cpuset; /* (p) cpuset */
170 struct vnet *pr_vnet; /* (c) network stack */
171 struct vnode *pr_root; /* (c) vnode to rdir */
172 int pr_ip4s; /* (p) number of v4 IPs */
173 int pr_ip6s; /* (p) number of v6 IPs */
174 struct in_addr *pr_ip4; /* (p) v4 IPs of jail */
175 struct in6_addr *pr_ip6; /* (p) v6 IPs of jail */
176 struct prison_racct *pr_prison_racct; /* (c) racct jail proxy */
178 int pr_childcount; /* (a) number of child jails */
179 int pr_childmax; /* (p) maximum child jails */
180 unsigned pr_allow; /* (p) PR_ALLOW_* flags */
181 int pr_securelevel; /* (p) securelevel */
182 int pr_enforce_statfs; /* (p) statfs permission */
183 int pr_devfs_rsnum; /* (p) devfs ruleset */
185 int pr_osreldate; /* (c) kern.osreldate value */
186 unsigned long pr_hostid; /* (p) jail hostid */
187 char pr_name[MAXHOSTNAMELEN]; /* (p) admin jail name */
188 char pr_path[MAXPATHLEN]; /* (c) chroot path */
189 char pr_hostname[MAXHOSTNAMELEN]; /* (p) jail hostname */
190 char pr_domainname[MAXHOSTNAMELEN]; /* (p) jail domainname */
191 char pr_hostuuid[HOSTUUIDLEN]; /* (p) jail hostuuid */
192 char pr_osrelease[OSRELEASELEN]; /* (c) kern.osrelease value */
195 struct prison_racct {
196 LIST_ENTRY(prison_racct) prr_next;
197 char prr_name[MAXHOSTNAMELEN];
199 struct racct *prr_racct;
201 #endif /* _KERNEL || _WANT_PRISON */
204 /* Flag bits set via options */
205 #define PR_PERSIST 0x00000001 /* Can exist without processes */
206 #define PR_HOST 0x00000002 /* Virtualize hostname et al */
207 #define PR_IP4_USER 0x00000004 /* Restrict IPv4 addresses */
208 #define PR_IP6_USER 0x00000008 /* Restrict IPv6 addresses */
209 #define PR_VNET 0x00000010 /* Virtual network stack */
210 #define PR_IP4_SADDRSEL 0x00000080 /* Do IPv4 src addr sel. or use the */
211 /* primary jail address. */
212 #define PR_IP6_SADDRSEL 0x00000100 /* Do IPv6 src addr sel. or use the */
213 /* primary jail address. */
215 /* Internal flag bits */
216 #define PR_IP4 0x02000000 /* IPv4 restricted or disabled */
217 /* by this jail or an ancestor */
218 #define PR_IP6 0x04000000 /* IPv6 restricted or disabled */
219 /* by this jail or an ancestor */
223 * Bits not noted here may be used for dynamic allow.mount.xxxfs.
225 #define PR_ALLOW_SET_HOSTNAME 0x00000001
226 #define PR_ALLOW_SYSVIPC 0x00000002
227 #define PR_ALLOW_RAW_SOCKETS 0x00000004
228 #define PR_ALLOW_CHFLAGS 0x00000008
229 #define PR_ALLOW_MOUNT 0x00000010
230 #define PR_ALLOW_QUOTAS 0x00000020
231 #define PR_ALLOW_SOCKET_AF 0x00000040
232 #define PR_ALLOW_MLOCK 0x00000080
233 #define PR_ALLOW_READ_MSGBUF 0x00000100
234 #define PR_ALLOW_UNPRIV_DEBUG 0x00000200
235 #define PR_ALLOW_RESERVED_PORTS 0x00008000
236 #define PR_ALLOW_KMEM_ACCESS 0x00010000 /* reserved, not used yet */
237 #define PR_ALLOW_ALL_STATIC 0x000183ff
240 * PR_ALLOW_DIFFERENCES determines which flags are able to be
241 * different between the parent and child jail upon creation.
243 #define PR_ALLOW_DIFFERENCES (PR_ALLOW_UNPRIV_DEBUG)
248 #define PR_METHOD_CREATE 0
249 #define PR_METHOD_GET 1
250 #define PR_METHOD_SET 2
251 #define PR_METHOD_CHECK 3
252 #define PR_METHOD_ATTACH 4
253 #define PR_METHOD_REMOVE 5
254 #define PR_MAXMETHOD 6
257 * Lock/unlock a prison.
258 * XXX These exist not so much for general convenience, but to be useable in
259 * the FOREACH_PRISON_DESCENDANT_LOCKED macro which can't handle them in
260 * non-function form as currently defined.
263 prison_lock(struct prison *pr)
266 mtx_lock(&pr->pr_mtx);
270 prison_unlock(struct prison *pr)
273 mtx_unlock(&pr->pr_mtx);
276 /* Traverse a prison's immediate children. */
277 #define FOREACH_PRISON_CHILD(ppr, cpr) \
278 LIST_FOREACH(cpr, &(ppr)->pr_children, pr_sibling)
281 * Preorder traversal of all of a prison's descendants.
282 * This ugly loop allows the macro to be followed by a single block
283 * as expected in a looping primitive.
285 #define FOREACH_PRISON_DESCENDANT(ppr, cpr, descend) \
286 for ((cpr) = (ppr), (descend) = 1; \
287 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
288 ? LIST_FIRST(&(cpr)->pr_children) \
291 : (((descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
292 ? LIST_NEXT(cpr, pr_sibling) \
293 : (cpr)->pr_parent))));) \
299 * As above, but lock descendants on the way down and unlock on the way up.
301 #define FOREACH_PRISON_DESCENDANT_LOCKED(ppr, cpr, descend) \
302 for ((cpr) = (ppr), (descend) = 1; \
303 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
304 ? LIST_FIRST(&(cpr)->pr_children) \
307 : ((prison_unlock(cpr), \
308 (descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
309 ? LIST_NEXT(cpr, pr_sibling) \
310 : (cpr)->pr_parent))));) \
311 if ((descend) ? (prison_lock(cpr), 0) : 1) \
316 * As above, but also keep track of the level descended to.
318 #define FOREACH_PRISON_DESCENDANT_LOCKED_LEVEL(ppr, cpr, descend, level)\
319 for ((cpr) = (ppr), (descend) = 1, (level) = 0; \
320 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
321 ? (level++, LIST_FIRST(&(cpr)->pr_children)) \
324 : ((prison_unlock(cpr), \
325 (descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
326 ? LIST_NEXT(cpr, pr_sibling) \
327 : (level--, (cpr)->pr_parent)))));) \
328 if ((descend) ? (prison_lock(cpr), 0) : 1) \
333 * Attributes of the physical system, and the root of the jail tree.
335 extern struct prison prison0;
337 TAILQ_HEAD(prisonlist, prison);
338 extern struct prisonlist allprison;
339 extern struct sx allprison_lock;
342 * Sysctls to describe jail parameters.
344 SYSCTL_DECL(_security_jail_param);
346 #define SYSCTL_JAIL_PARAM(module, param, type, fmt, descr) \
347 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
348 (type) | CTLFLAG_MPSAFE, NULL, 0, sysctl_jail_param, fmt, descr)
349 #define SYSCTL_JAIL_PARAM_STRING(module, param, access, len, descr) \
350 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
351 CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), NULL, len, \
352 sysctl_jail_param, "A", descr)
353 #define SYSCTL_JAIL_PARAM_STRUCT(module, param, access, len, fmt, descr)\
354 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
355 CTLTYPE_STRUCT | CTLFLAG_MPSAFE | (access), NULL, len, \
356 sysctl_jail_param, fmt, descr)
357 #define SYSCTL_JAIL_PARAM_NODE(module, descr) \
358 SYSCTL_NODE(_security_jail_param, OID_AUTO, module, CTLFLAG_MPSAFE, \
360 #define SYSCTL_JAIL_PARAM_SUBNODE(parent, module, descr) \
361 SYSCTL_NODE(_security_jail_param_##parent, OID_AUTO, module, \
362 CTLFLAG_MPSAFE, 0, descr)
363 #define SYSCTL_JAIL_PARAM_SYS_NODE(module, access, descr) \
364 SYSCTL_JAIL_PARAM_NODE(module, descr); \
365 SYSCTL_JAIL_PARAM(_##module, , CTLTYPE_INT | (access), "E,jailsys", \
369 * Kernel support functions for jail().
378 * Return 1 if the passed credential is in a jail, otherwise 0.
380 #define jailed(cred) (cred->cr_prison != &prison0)
382 int jailed_without_vnet(struct ucred *);
383 void getcredhostname(struct ucred *, char *, size_t);
384 void getcreddomainname(struct ucred *, char *, size_t);
385 void getcredhostuuid(struct ucred *, char *, size_t);
386 void getcredhostid(struct ucred *, unsigned long *);
387 void getjailname(struct ucred *cred, char *name, size_t len);
388 void prison0_init(void);
389 int prison_allow(struct ucred *, unsigned);
390 int prison_check(struct ucred *cred1, struct ucred *cred2);
391 int prison_owns_vnet(struct ucred *);
392 int prison_canseemount(struct ucred *cred, struct mount *mp);
393 void prison_enforce_statfs(struct ucred *cred, struct mount *mp,
395 struct prison *prison_find(int prid);
396 struct prison *prison_find_child(struct prison *, int);
397 struct prison *prison_find_name(struct prison *, const char *);
398 int prison_flag(struct ucred *, unsigned);
399 void prison_free(struct prison *pr);
400 void prison_free_locked(struct prison *pr);
401 void prison_hold(struct prison *pr);
402 void prison_hold_locked(struct prison *pr);
403 void prison_proc_hold(struct prison *);
404 void prison_proc_free(struct prison *);
405 int prison_ischild(struct prison *, struct prison *);
406 int prison_equal_ip4(struct prison *, struct prison *);
407 int prison_get_ip4(struct ucred *cred, struct in_addr *ia);
408 int prison_local_ip4(struct ucred *cred, struct in_addr *ia);
409 int prison_remote_ip4(struct ucred *cred, struct in_addr *ia);
410 int prison_check_ip4(const struct ucred *, const struct in_addr *);
411 int prison_check_ip4_locked(const struct prison *, const struct in_addr *);
412 int prison_saddrsel_ip4(struct ucred *, struct in_addr *);
413 int prison_restrict_ip4(struct prison *, struct in_addr *);
414 int prison_qcmp_v4(const void *, const void *);
416 int prison_equal_ip6(struct prison *, struct prison *);
417 int prison_get_ip6(struct ucred *, struct in6_addr *);
418 int prison_local_ip6(struct ucred *, struct in6_addr *, int);
419 int prison_remote_ip6(struct ucred *, struct in6_addr *);
420 int prison_check_ip6(const struct ucred *, const struct in6_addr *);
421 int prison_check_ip6_locked(const struct prison *, const struct in6_addr *);
422 int prison_saddrsel_ip6(struct ucred *, struct in6_addr *);
423 int prison_restrict_ip6(struct prison *, struct in6_addr *);
424 int prison_qcmp_v6(const void *, const void *);
426 int prison_check_af(struct ucred *cred, int af);
427 int prison_if(struct ucred *cred, const struct sockaddr *sa);
428 char *prison_name(struct prison *, struct prison *);
429 int prison_priv_check(struct ucred *cred, int priv);
430 int sysctl_jail_param(SYSCTL_HANDLER_ARGS);
431 unsigned prison_add_allow(const char *prefix, const char *name,
432 const char *prefix_descr, const char *descr);
433 void prison_add_vfs(struct vfsconf *vfsp);
434 void prison_racct_foreach(void (*callback)(struct racct *racct,
435 void *arg2, void *arg3), void (*pre)(void), void (*post)(void),
436 void *arg2, void *arg3);
437 struct prison_racct *prison_racct_find(const char *name);
438 void prison_racct_hold(struct prison_racct *prr);
439 void prison_racct_free(struct prison_racct *prr);
442 #endif /* !_SYS_JAIL_H_ */