1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 1999 Poul-Henning Kamp.
5 * Copyright (c) 2009 James Gritton.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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.
16 *
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
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: stable/12/sys/sys/jail.h 370357 2021-08-20 21:37:46Z kbowling $
30 */
31
32 #ifndef _SYS_JAIL_H_
33 #define _SYS_JAIL_H_
34
35 #ifdef _KERNEL
36 struct jail_v0 {
37 u_int32_t version;
38 char *path;
39 char *hostname;
40 u_int32_t ip_number;
41 };
42 #endif
43
44 struct jail {
45 uint32_t version;
46 char *path;
47 char *hostname;
48 char *jailname;
49 uint32_t ip4s;
50 uint32_t ip6s;
51 struct in_addr *ip4;
52 struct in6_addr *ip6;
53 };
54 #define JAIL_API_VERSION 2
55
56 /*
57 * For all xprison structs, always keep the pr_version an int and
58 * the first variable so userspace can easily distinguish them.
59 */
60 #ifndef _KERNEL
61 struct xprison_v1 {
62 int pr_version;
63 int pr_id;
64 char pr_path[MAXPATHLEN];
65 char pr_host[MAXHOSTNAMELEN];
66 u_int32_t pr_ip;
67 };
68 #endif
69
70 struct xprison {
71 int pr_version;
72 int pr_id;
73 int pr_state;
74 cpusetid_t pr_cpusetid;
75 char pr_path[MAXPATHLEN];
76 char pr_host[MAXHOSTNAMELEN];
77 char pr_name[MAXHOSTNAMELEN];
78 uint32_t pr_ip4s;
79 uint32_t pr_ip6s;
80 #if 0
81 /*
82 * sizeof(xprison) will be malloced + size needed for all
83 * IPv4 and IPv6 addesses. Offsets are based numbers of addresses.
84 */
85 struct in_addr pr_ip4[];
86 struct in6_addr pr_ip6[];
87 #endif
88 };
89 #define XPRISON_VERSION 3
90
91 #define PRISON_STATE_INVALID 0
92 #define PRISON_STATE_ALIVE 1
93 #define PRISON_STATE_DYING 2
94
95 /*
96 * Flags for jail_set and jail_get.
97 */
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
104
105 #define JAIL_SYS_DISABLE 0
106 #define JAIL_SYS_NEW 1
107 #define JAIL_SYS_INHERIT 2
108
109 #ifndef _KERNEL
110
111 struct iovec;
112
113 __BEGIN_DECLS
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);
119 __END_DECLS
120
121 #else /* _KERNEL */
122
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>
128
129 #define JAIL_MAX 999999
130
131 #ifdef MALLOC_DECLARE
132 MALLOC_DECLARE(M_PRISON);
133 #endif
134 #endif /* _KERNEL */
135
136 #if defined(_KERNEL) || defined(_WANT_PRISON)
137
138 #include <sys/osd.h>
139
140 #define HOSTUUIDLEN 64
141 #define DEFAULT_HOSTUUID "00000000-0000-0000-0000-000000000000"
142 #define OSRELEASELEN 32
143
144 struct racct;
145 struct prison_racct;
146
147 /*
148 * This structure describes a prison. It is pointed to by all struct
149 * ucreds's of the inmates. pr_ref keeps track of them and is used to
150 * delete the structure when the last inmate is dead.
151 *
152 * Lock key:
153 * (a) allprison_lock
154 * (p) locked by pr_mtx
155 * (c) set only during creation before the structure is shared, no mutex
156 * required to read
157 */
158 struct prison {
159 TAILQ_ENTRY(prison) pr_list; /* (a) all prisons */
160 int pr_id; /* (c) prison id */
161 int pr_ref; /* (p) refcount */
162 int pr_uref; /* (p) user (alive) refcount */
163 unsigned pr_flags; /* (p) PR_* flags */
164 LIST_HEAD(, prison) pr_children; /* (a) list of child jails */
165 LIST_ENTRY(prison) pr_sibling; /* (a) next in parent's list */
166 struct prison *pr_parent; /* (c) containing jail */
167 struct mtx pr_mtx;
168 struct task pr_task; /* (c) destroy task */
169 struct osd pr_osd; /* (p) additional data */
170 struct cpuset *pr_cpuset; /* (p) cpuset */
171 struct vnet *pr_vnet; /* (c) network stack */
172 struct vnode *pr_root; /* (c) vnode to rdir */
173 int pr_ip4s; /* (p) number of v4 IPs */
174 int pr_ip6s; /* (p) number of v6 IPs */
175 struct in_addr *pr_ip4; /* (p) v4 IPs of jail */
176 struct in6_addr *pr_ip6; /* (p) v6 IPs of jail */
177 struct prison_racct *pr_prison_racct; /* (c) racct jail proxy */
178 void *pr_sparep[3];
179 int pr_childcount; /* (a) number of child jails */
180 int pr_childmax; /* (p) maximum child jails */
181 unsigned pr_allow; /* (p) PR_ALLOW_* flags */
182 int pr_securelevel; /* (p) securelevel */
183 int pr_enforce_statfs; /* (p) statfs permission */
184 int pr_devfs_rsnum; /* (p) devfs ruleset */
185 int pr_spare[3];
186 int pr_osreldate; /* (c) kern.osreldate value */
187 unsigned long pr_hostid; /* (p) jail hostid */
188 char pr_name[MAXHOSTNAMELEN]; /* (p) admin jail name */
189 char pr_path[MAXPATHLEN]; /* (c) chroot path */
190 char pr_hostname[MAXHOSTNAMELEN]; /* (p) jail hostname */
191 char pr_domainname[MAXHOSTNAMELEN]; /* (p) jail domainname */
192 char pr_hostuuid[HOSTUUIDLEN]; /* (p) jail hostuuid */
193 char pr_osrelease[OSRELEASELEN]; /* (c) kern.osrelease value */
194 };
195
196 struct prison_racct {
197 LIST_ENTRY(prison_racct) prr_next;
198 char prr_name[MAXHOSTNAMELEN];
199 u_int prr_refcount;
200 struct racct *prr_racct;
201 };
202 #endif /* _KERNEL || _WANT_PRISON */
203
204 #ifdef _KERNEL
205 /* Flag bits set via options */
206 #define PR_PERSIST 0x00000001 /* Can exist without processes */
207 #define PR_HOST 0x00000002 /* Virtualize hostname et al */
208 #define PR_IP4_USER 0x00000004 /* Restrict IPv4 addresses */
209 #define PR_IP6_USER 0x00000008 /* Restrict IPv6 addresses */
210 #define PR_VNET 0x00000010 /* Virtual network stack */
211 #define PR_IP4_SADDRSEL 0x00000080 /* Do IPv4 src addr sel. or use the */
212 /* primary jail address. */
213 #define PR_IP6_SADDRSEL 0x00000100 /* Do IPv6 src addr sel. or use the */
214 /* primary jail address. */
215
216 /* Internal flag bits */
217 #define PR_REMOVE 0x01000000 /* In process of being removed */
218 #define PR_IP4 0x02000000 /* IPv4 restricted or disabled */
219 /* by this jail or an ancestor */
220 #define PR_IP6 0x04000000 /* IPv6 restricted or disabled */
221 /* by this jail or an ancestor */
222
223 /*
224 * Flags for pr_allow
225 * Bits not noted here may be used for dynamic allow.mount.xxxfs.
226 */
227 #define PR_ALLOW_SET_HOSTNAME 0x00000001
228 #define PR_ALLOW_SYSVIPC 0x00000002
229 #define PR_ALLOW_RAW_SOCKETS 0x00000004
230 #define PR_ALLOW_CHFLAGS 0x00000008
231 #define PR_ALLOW_MOUNT 0x00000010
232 #define PR_ALLOW_QUOTAS 0x00000020
233 #define PR_ALLOW_SOCKET_AF 0x00000040
234 #define PR_ALLOW_MLOCK 0x00000080
235 #define PR_ALLOW_READ_MSGBUF 0x00000100
236 #define PR_ALLOW_RESERVED_PORTS 0x00008000
237 #define PR_ALLOW_KMEM_ACCESS 0x00010000 /* reserved, not used yet */
238 #define PR_ALLOW_ALL_STATIC 0x000181ff
239
240 /*
241 * OSD methods
242 */
243 #define PR_METHOD_CREATE 0
244 #define PR_METHOD_GET 1
245 #define PR_METHOD_SET 2
246 #define PR_METHOD_CHECK 3
247 #define PR_METHOD_ATTACH 4
248 #define PR_METHOD_REMOVE 5
249 #define PR_MAXMETHOD 6
250
251 /*
252 * Lock/unlock a prison.
253 * XXX These exist not so much for general convenience, but to be useable in
254 * the FOREACH_PRISON_DESCENDANT_LOCKED macro which can't handle them in
255 * non-function form as currently defined.
256 */
257 static __inline void
prison_lock(struct prison * pr)258 prison_lock(struct prison *pr)
259 {
260
261 mtx_lock(&pr->pr_mtx);
262 }
263
264 static __inline void
prison_unlock(struct prison * pr)265 prison_unlock(struct prison *pr)
266 {
267
268 mtx_unlock(&pr->pr_mtx);
269 }
270
271 /* Traverse a prison's immediate children. */
272 #define FOREACH_PRISON_CHILD(ppr, cpr) \
273 LIST_FOREACH(cpr, &(ppr)->pr_children, pr_sibling)
274
275 /*
276 * Preorder traversal of all of a prison's descendants.
277 * This ugly loop allows the macro to be followed by a single block
278 * as expected in a looping primitive.
279 */
280 #define FOREACH_PRISON_DESCENDANT(ppr, cpr, descend) \
281 for ((cpr) = (ppr), (descend) = 1; \
282 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
283 ? LIST_FIRST(&(cpr)->pr_children) \
284 : ((cpr) == (ppr) \
285 ? NULL \
286 : (((descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
287 ? LIST_NEXT(cpr, pr_sibling) \
288 : (cpr)->pr_parent))));) \
289 if (!(descend)) \
290 ; \
291 else
292
293 /*
294 * As above, but lock descendants on the way down and unlock on the way up.
295 */
296 #define FOREACH_PRISON_DESCENDANT_LOCKED(ppr, cpr, descend) \
297 for ((cpr) = (ppr), (descend) = 1; \
298 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
299 ? LIST_FIRST(&(cpr)->pr_children) \
300 : ((cpr) == (ppr) \
301 ? NULL \
302 : ((prison_unlock(cpr), \
303 (descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
304 ? LIST_NEXT(cpr, pr_sibling) \
305 : (cpr)->pr_parent))));) \
306 if ((descend) ? (prison_lock(cpr), 0) : 1) \
307 ; \
308 else
309
310 /*
311 * As above, but also keep track of the level descended to.
312 */
313 #define FOREACH_PRISON_DESCENDANT_LOCKED_LEVEL(ppr, cpr, descend, level)\
314 for ((cpr) = (ppr), (descend) = 1, (level) = 0; \
315 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
316 ? (level++, LIST_FIRST(&(cpr)->pr_children)) \
317 : ((cpr) == (ppr) \
318 ? NULL \
319 : ((prison_unlock(cpr), \
320 (descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
321 ? LIST_NEXT(cpr, pr_sibling) \
322 : (level--, (cpr)->pr_parent)))));) \
323 if ((descend) ? (prison_lock(cpr), 0) : 1) \
324 ; \
325 else
326
327 /*
328 * Attributes of the physical system, and the root of the jail tree.
329 */
330 extern struct prison prison0;
331
332 TAILQ_HEAD(prisonlist, prison);
333 extern struct prisonlist allprison;
334 extern struct sx allprison_lock;
335
336 /*
337 * Sysctls to describe jail parameters.
338 */
339 SYSCTL_DECL(_security_jail_param);
340
341 #define SYSCTL_JAIL_PARAM(module, param, type, fmt, descr) \
342 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
343 (type) | CTLFLAG_MPSAFE, NULL, 0, sysctl_jail_param, fmt, descr)
344 #define SYSCTL_JAIL_PARAM_STRING(module, param, access, len, descr) \
345 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
346 CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), NULL, len, \
347 sysctl_jail_param, "A", descr)
348 #define SYSCTL_JAIL_PARAM_STRUCT(module, param, access, len, fmt, descr)\
349 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
350 CTLTYPE_STRUCT | CTLFLAG_MPSAFE | (access), NULL, len, \
351 sysctl_jail_param, fmt, descr)
352 #define SYSCTL_JAIL_PARAM_NODE(module, descr) \
353 SYSCTL_NODE(_security_jail_param, OID_AUTO, module, 0, 0, descr)
354 #define SYSCTL_JAIL_PARAM_SUBNODE(parent, module, descr) \
355 SYSCTL_NODE(_security_jail_param_##parent, OID_AUTO, module, 0, 0, descr)
356 #define SYSCTL_JAIL_PARAM_SYS_NODE(module, access, descr) \
357 SYSCTL_JAIL_PARAM_NODE(module, descr); \
358 SYSCTL_JAIL_PARAM(_##module, , CTLTYPE_INT | (access), "E,jailsys", \
359 descr)
360
361 /*
362 * Kernel support functions for jail().
363 */
364 struct ucred;
365 struct mount;
366 struct sockaddr;
367 struct statfs;
368 struct vfsconf;
369 int jailed(struct ucred *cred);
370 int jailed_without_vnet(struct ucred *);
371 void getcredhostname(struct ucred *, char *, size_t);
372 void getcreddomainname(struct ucred *, char *, size_t);
373 void getcredhostuuid(struct ucred *, char *, size_t);
374 void getcredhostid(struct ucred *, unsigned long *);
375 void getjailname(struct ucred *cred, char *name, size_t len);
376 void prison0_init(void);
377 int prison_allow(struct ucred *, unsigned);
378 int prison_check(struct ucred *cred1, struct ucred *cred2);
379 int prison_owns_vnet(struct ucred *);
380 int prison_canseemount(struct ucred *cred, struct mount *mp);
381 void prison_enforce_statfs(struct ucred *cred, struct mount *mp,
382 struct statfs *sp);
383 struct prison *prison_find(int prid);
384 struct prison *prison_find_child(struct prison *, int);
385 struct prison *prison_find_name(struct prison *, const char *);
386 int prison_flag(struct ucred *, unsigned);
387 void prison_free(struct prison *pr);
388 void prison_free_locked(struct prison *pr);
389 void prison_hold(struct prison *pr);
390 void prison_hold_locked(struct prison *pr);
391 void prison_proc_hold(struct prison *);
392 void prison_proc_free(struct prison *);
393 int prison_ischild(struct prison *, struct prison *);
394 int prison_equal_ip4(struct prison *, struct prison *);
395 int prison_get_ip4(struct ucred *cred, struct in_addr *ia);
396 int prison_local_ip4(struct ucred *cred, struct in_addr *ia);
397 int prison_remote_ip4(struct ucred *cred, struct in_addr *ia);
398 int prison_check_ip4(const struct ucred *, const struct in_addr *);
399 int prison_check_ip4_locked(const struct prison *, const struct in_addr *);
400 int prison_saddrsel_ip4(struct ucred *, struct in_addr *);
401 int prison_restrict_ip4(struct prison *, struct in_addr *);
402 int prison_qcmp_v4(const void *, const void *);
403 #ifdef INET6
404 int prison_equal_ip6(struct prison *, struct prison *);
405 int prison_get_ip6(struct ucred *, struct in6_addr *);
406 int prison_local_ip6(struct ucred *, struct in6_addr *, int);
407 int prison_remote_ip6(struct ucred *, struct in6_addr *);
408 int prison_check_ip6(const struct ucred *, const struct in6_addr *);
409 int prison_check_ip6_locked(const struct prison *, const struct in6_addr *);
410 int prison_saddrsel_ip6(struct ucred *, struct in6_addr *);
411 int prison_restrict_ip6(struct prison *, struct in6_addr *);
412 int prison_qcmp_v6(const void *, const void *);
413 #endif
414 int prison_check_af(struct ucred *cred, int af);
415 int prison_if(struct ucred *cred, struct sockaddr *sa);
416 char *prison_name(struct prison *, struct prison *);
417 int prison_priv_check(struct ucred *cred, int priv);
418 int sysctl_jail_param(SYSCTL_HANDLER_ARGS);
419 unsigned prison_add_allow(const char *prefix, const char *name,
420 const char *prefix_descr, const char *descr);
421 void prison_add_vfs(struct vfsconf *vfsp);
422 void prison_racct_foreach(void (*callback)(struct racct *racct,
423 void *arg2, void *arg3), void (*pre)(void), void (*post)(void),
424 void *arg2, void *arg3);
425 struct prison_racct *prison_racct_find(const char *name);
426 void prison_racct_hold(struct prison_racct *prr);
427 void prison_racct_free(struct prison_racct *prr);
428
429 #endif /* _KERNEL */
430 #endif /* !_SYS_JAIL_H_ */
431