1 /*-
2 * Copyright (c) 1999 Poul-Henning Kamp.
3 * Copyright (c) 2009 James Gritton.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 *
27 * $FreeBSD$
28 */
29
30 #ifndef _SYS_JAIL_H_
31 #define _SYS_JAIL_H_
32
33 #ifdef _KERNEL
34 struct jail_v0 {
35 u_int32_t version;
36 char *path;
37 char *hostname;
38 u_int32_t ip_number;
39 };
40 #endif
41
42 struct jail {
43 uint32_t version;
44 char *path;
45 char *hostname;
46 char *jailname;
47 uint32_t ip4s;
48 uint32_t ip6s;
49 struct in_addr *ip4;
50 struct in6_addr *ip6;
51 };
52 #define JAIL_API_VERSION 2
53
54 /*
55 * For all xprison structs, always keep the pr_version an int and
56 * the first variable so userspace can easily distinguish them.
57 */
58 #ifndef _KERNEL
59 struct xprison_v1 {
60 int pr_version;
61 int pr_id;
62 char pr_path[MAXPATHLEN];
63 char pr_host[MAXHOSTNAMELEN];
64 u_int32_t pr_ip;
65 };
66 #endif
67
68 struct xprison {
69 int pr_version;
70 int pr_id;
71 int pr_state;
72 cpusetid_t pr_cpusetid;
73 char pr_path[MAXPATHLEN];
74 char pr_host[MAXHOSTNAMELEN];
75 char pr_name[MAXHOSTNAMELEN];
76 uint32_t pr_ip4s;
77 uint32_t pr_ip6s;
78 #if 0
79 /*
80 * sizeof(xprison) will be malloced + size needed for all
81 * IPv4 and IPv6 addesses. Offsets are based numbers of addresses.
82 */
83 struct in_addr pr_ip4[];
84 struct in6_addr pr_ip6[];
85 #endif
86 };
87 #define XPRISON_VERSION 3
88
89 #define PRISON_STATE_INVALID 0
90 #define PRISON_STATE_ALIVE 1
91 #define PRISON_STATE_DYING 2
92
93 /*
94 * Flags for jail_set and jail_get.
95 */
96 #define JAIL_CREATE 0x01 /* Create jail if it doesn't exist */
97 #define JAIL_UPDATE 0x02 /* Update parameters of existing jail */
98 #define JAIL_ATTACH 0x04 /* Attach to jail upon creation */
99 #define JAIL_DYING 0x08 /* Allow getting a dying jail */
100 #define JAIL_SET_MASK 0x0f
101 #define JAIL_GET_MASK 0x08
102
103 #define JAIL_SYS_DISABLE 0
104 #define JAIL_SYS_NEW 1
105 #define JAIL_SYS_INHERIT 2
106
107 #ifndef _KERNEL
108
109 struct iovec;
110
111 int jail(struct jail *);
112 int jail_set(struct iovec *, unsigned int, int);
113 int jail_get(struct iovec *, unsigned int, int);
114 int jail_attach(int);
115 int jail_remove(int);
116
117 #else /* _KERNEL */
118
119 #include <sys/queue.h>
120 #include <sys/sysctl.h>
121 #include <sys/lock.h>
122 #include <sys/mutex.h>
123 #include <sys/_task.h>
124
125 #define JAIL_MAX 999999
126
127 #ifdef MALLOC_DECLARE
128 MALLOC_DECLARE(M_PRISON);
129 #endif
130 #endif /* _KERNEL */
131
132 #if defined(_KERNEL) || defined(_WANT_PRISON)
133
134 #include <sys/osd.h>
135
136 #define HOSTUUIDLEN 64
137 #define OSRELEASELEN 32
138
139 struct racct;
140 struct prison_racct;
141
142 /*
143 * This structure describes a prison. It is pointed to by all struct
144 * ucreds's of the inmates. pr_ref keeps track of them and is used to
145 * delete the struture when the last inmate is dead.
146 *
147 * Lock key:
148 * (a) allprison_lock
149 * (p) locked by pr_mtx
150 * (c) set only during creation before the structure is shared, no mutex
151 * required to read
152 * (d) set only during destruction of jail, no mutex needed
153 */
154 struct prison {
155 TAILQ_ENTRY(prison) pr_list; /* (a) all prisons */
156 int pr_id; /* (c) prison id */
157 int pr_ref; /* (p) refcount */
158 int pr_uref; /* (p) user (alive) refcount */
159 unsigned pr_flags; /* (p) PR_* flags */
160 LIST_HEAD(, prison) pr_children; /* (a) list of child jails */
161 LIST_ENTRY(prison) pr_sibling; /* (a) next in parent's list */
162 struct prison *pr_parent; /* (c) containing jail */
163 struct mtx pr_mtx;
164 struct task pr_task; /* (d) destroy task */
165 struct osd pr_osd; /* (p) additional data */
166 struct cpuset *pr_cpuset; /* (p) cpuset */
167 struct vnet *pr_vnet; /* (c) network stack */
168 struct vnode *pr_root; /* (c) vnode to rdir */
169 int pr_ip4s; /* (p) number of v4 IPs */
170 int pr_ip6s; /* (p) number of v6 IPs */
171 struct in_addr *pr_ip4; /* (p) v4 IPs of jail */
172 struct in6_addr *pr_ip6; /* (p) v6 IPs of jail */
173 struct prison_racct *pr_prison_racct; /* (c) racct jail proxy */
174 void *pr_sparep[3];
175 int pr_childcount; /* (a) number of child jails */
176 int pr_childmax; /* (p) maximum child jails */
177 unsigned pr_allow; /* (p) PR_ALLOW_* flags */
178 int pr_securelevel; /* (p) securelevel */
179 int pr_enforce_statfs; /* (p) statfs permission */
180 int pr_devfs_rsnum; /* (p) devfs ruleset */
181 int pr_spare[3];
182 int pr_osreldate; /* (c) kern.osreldate value */
183 unsigned long pr_hostid; /* (p) jail hostid */
184 char pr_name[MAXHOSTNAMELEN]; /* (p) admin jail name */
185 char pr_path[MAXPATHLEN]; /* (c) chroot path */
186 char pr_hostname[MAXHOSTNAMELEN]; /* (p) jail hostname */
187 char pr_domainname[MAXHOSTNAMELEN]; /* (p) jail domainname */
188 char pr_hostuuid[HOSTUUIDLEN]; /* (p) jail hostuuid */
189 char pr_osrelease[OSRELEASELEN]; /* (c) kern.osrelease value */
190 };
191
192 struct prison_racct {
193 LIST_ENTRY(prison_racct) prr_next;
194 char prr_name[MAXHOSTNAMELEN];
195 u_int prr_refcount;
196 struct racct *prr_racct;
197 };
198 #endif /* _KERNEL || _WANT_PRISON */
199
200 #ifdef _KERNEL
201 /* Flag bits set via options */
202 #define PR_PERSIST 0x00000001 /* Can exist without processes */
203 #define PR_HOST 0x00000002 /* Virtualize hostname et al */
204 #define PR_IP4_USER 0x00000004 /* Restrict IPv4 addresses */
205 #define PR_IP6_USER 0x00000008 /* Restrict IPv6 addresses */
206 #define PR_VNET 0x00000010 /* Virtual network stack */
207 #define PR_IP4_SADDRSEL 0x00000080 /* Do IPv4 src addr sel. or use the */
208 /* primary jail address. */
209 #define PR_IP6_SADDRSEL 0x00000100 /* Do IPv6 src addr sel. or use the */
210 /* primary jail address. */
211
212 /* Internal flag bits */
213 #define PR_REMOVE 0x01000000 /* In process of being removed */
214 #define PR_IP4 0x02000000 /* IPv4 restricted or disabled */
215 /* by this jail or an ancestor */
216 #define PR_IP6 0x04000000 /* IPv6 restricted or disabled */
217 /* by this jail or an ancestor */
218
219 /* Flags for pr_allow */
220 #define PR_ALLOW_SET_HOSTNAME 0x0001
221 #define PR_ALLOW_SYSVIPC 0x0002
222 #define PR_ALLOW_RAW_SOCKETS 0x0004
223 #define PR_ALLOW_CHFLAGS 0x0008
224 #define PR_ALLOW_MOUNT 0x0010
225 #define PR_ALLOW_QUOTAS 0x0020
226 #define PR_ALLOW_SOCKET_AF 0x0040
227 #define PR_ALLOW_MOUNT_DEVFS 0x0080
228 #define PR_ALLOW_MOUNT_NULLFS 0x0100
229 #define PR_ALLOW_MOUNT_ZFS 0x0200
230 #define PR_ALLOW_MOUNT_PROCFS 0x0400
231 #define PR_ALLOW_MOUNT_TMPFS 0x0800
232 #define PR_ALLOW_MOUNT_FDESCFS 0x1000
233 #define PR_ALLOW_MOUNT_LINPROCFS 0x2000
234 #define PR_ALLOW_MOUNT_LINSYSFS 0x4000
235 #define PR_ALLOW_ALL 0x7fff
236
237 /*
238 * OSD methods
239 */
240 #define PR_METHOD_CREATE 0
241 #define PR_METHOD_GET 1
242 #define PR_METHOD_SET 2
243 #define PR_METHOD_CHECK 3
244 #define PR_METHOD_ATTACH 4
245 #define PR_MAXMETHOD 5
246
247 /*
248 * Lock/unlock a prison.
249 * XXX These exist not so much for general convenience, but to be useable in
250 * the FOREACH_PRISON_DESCENDANT_LOCKED macro which can't handle them in
251 * non-function form as currently defined.
252 */
253 static __inline void
prison_lock(struct prison * pr)254 prison_lock(struct prison *pr)
255 {
256
257 mtx_lock(&pr->pr_mtx);
258 }
259
260 static __inline void
prison_unlock(struct prison * pr)261 prison_unlock(struct prison *pr)
262 {
263
264 mtx_unlock(&pr->pr_mtx);
265 }
266
267 /* Traverse a prison's immediate children. */
268 #define FOREACH_PRISON_CHILD(ppr, cpr) \
269 LIST_FOREACH(cpr, &(ppr)->pr_children, pr_sibling)
270
271 /*
272 * Preorder traversal of all of a prison's descendants.
273 * This ugly loop allows the macro to be followed by a single block
274 * as expected in a looping primitive.
275 */
276 #define FOREACH_PRISON_DESCENDANT(ppr, cpr, descend) \
277 for ((cpr) = (ppr), (descend) = 1; \
278 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
279 ? LIST_FIRST(&(cpr)->pr_children) \
280 : ((cpr) == (ppr) \
281 ? NULL \
282 : (((descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
283 ? LIST_NEXT(cpr, pr_sibling) \
284 : (cpr)->pr_parent))));) \
285 if (!(descend)) \
286 ; \
287 else
288
289 /*
290 * As above, but lock descendants on the way down and unlock on the way up.
291 */
292 #define FOREACH_PRISON_DESCENDANT_LOCKED(ppr, cpr, descend) \
293 for ((cpr) = (ppr), (descend) = 1; \
294 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
295 ? LIST_FIRST(&(cpr)->pr_children) \
296 : ((cpr) == (ppr) \
297 ? NULL \
298 : ((prison_unlock(cpr), \
299 (descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
300 ? LIST_NEXT(cpr, pr_sibling) \
301 : (cpr)->pr_parent))));) \
302 if ((descend) ? (prison_lock(cpr), 0) : 1) \
303 ; \
304 else
305
306 /*
307 * As above, but also keep track of the level descended to.
308 */
309 #define FOREACH_PRISON_DESCENDANT_LOCKED_LEVEL(ppr, cpr, descend, level)\
310 for ((cpr) = (ppr), (descend) = 1, (level) = 0; \
311 ((cpr) = (((descend) && !LIST_EMPTY(&(cpr)->pr_children)) \
312 ? (level++, LIST_FIRST(&(cpr)->pr_children)) \
313 : ((cpr) == (ppr) \
314 ? NULL \
315 : ((prison_unlock(cpr), \
316 (descend) = LIST_NEXT(cpr, pr_sibling) != NULL) \
317 ? LIST_NEXT(cpr, pr_sibling) \
318 : (level--, (cpr)->pr_parent)))));) \
319 if ((descend) ? (prison_lock(cpr), 0) : 1) \
320 ; \
321 else
322
323 /*
324 * Attributes of the physical system, and the root of the jail tree.
325 */
326 extern struct prison prison0;
327
328 TAILQ_HEAD(prisonlist, prison);
329 extern struct prisonlist allprison;
330 extern struct sx allprison_lock;
331
332 /*
333 * Sysctls to describe jail parameters.
334 */
335 SYSCTL_DECL(_security_jail_param);
336
337 #define SYSCTL_JAIL_PARAM(module, param, type, fmt, descr) \
338 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
339 (type) | CTLFLAG_MPSAFE, NULL, 0, sysctl_jail_param, fmt, descr)
340 #define SYSCTL_JAIL_PARAM_STRING(module, param, access, len, descr) \
341 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
342 CTLTYPE_STRING | CTLFLAG_MPSAFE | (access), NULL, len, \
343 sysctl_jail_param, "A", descr)
344 #define SYSCTL_JAIL_PARAM_STRUCT(module, param, access, len, fmt, descr)\
345 SYSCTL_PROC(_security_jail_param ## module, OID_AUTO, param, \
346 CTLTYPE_STRUCT | CTLFLAG_MPSAFE | (access), NULL, len, \
347 sysctl_jail_param, fmt, descr)
348 #define SYSCTL_JAIL_PARAM_NODE(module, descr) \
349 SYSCTL_NODE(_security_jail_param, OID_AUTO, module, 0, 0, descr)
350 #define SYSCTL_JAIL_PARAM_SUBNODE(parent, module, descr) \
351 SYSCTL_NODE(_security_jail_param_##parent, OID_AUTO, module, 0, 0, descr)
352 #define SYSCTL_JAIL_PARAM_SYS_NODE(module, access, descr) \
353 SYSCTL_JAIL_PARAM_NODE(module, descr); \
354 SYSCTL_JAIL_PARAM(_##module, , CTLTYPE_INT | (access), "E,jailsys", \
355 descr)
356
357 /*
358 * Kernel support functions for jail().
359 */
360 struct ucred;
361 struct mount;
362 struct sockaddr;
363 struct statfs;
364 int jailed(struct ucred *cred);
365 int jailed_without_vnet(struct ucred *);
366 void getcredhostname(struct ucred *, char *, size_t);
367 void getcreddomainname(struct ucred *, char *, size_t);
368 void getcredhostuuid(struct ucred *, char *, size_t);
369 void getcredhostid(struct ucred *, unsigned long *);
370 void prison0_init(void);
371 int prison_allow(struct ucred *, unsigned);
372 int prison_check(struct ucred *cred1, struct ucred *cred2);
373 int prison_owns_vnet(struct ucred *);
374 int prison_canseemount(struct ucred *cred, struct mount *mp);
375 void prison_enforce_statfs(struct ucred *cred, struct mount *mp,
376 struct statfs *sp);
377 struct prison *prison_find(int prid);
378 struct prison *prison_find_child(struct prison *, int);
379 struct prison *prison_find_name(struct prison *, const char *);
380 int prison_flag(struct ucred *, unsigned);
381 void prison_free(struct prison *pr);
382 void prison_free_locked(struct prison *pr);
383 void prison_hold(struct prison *pr);
384 void prison_hold_locked(struct prison *pr);
385 void prison_proc_hold(struct prison *);
386 void prison_proc_free(struct prison *);
387 int prison_ischild(struct prison *, struct prison *);
388 int prison_equal_ip4(struct prison *, struct prison *);
389 int prison_get_ip4(struct ucred *cred, struct in_addr *ia);
390 int prison_local_ip4(struct ucred *cred, struct in_addr *ia);
391 int prison_remote_ip4(struct ucred *cred, struct in_addr *ia);
392 int prison_check_ip4(const struct ucred *, const struct in_addr *);
393 int prison_saddrsel_ip4(struct ucred *, struct in_addr *);
394 #ifdef INET6
395 int prison_equal_ip6(struct prison *, struct prison *);
396 int prison_get_ip6(struct ucred *, struct in6_addr *);
397 int prison_local_ip6(struct ucred *, struct in6_addr *, int);
398 int prison_remote_ip6(struct ucred *, struct in6_addr *);
399 int prison_check_ip6(struct ucred *, struct in6_addr *);
400 int prison_saddrsel_ip6(struct ucred *, struct in6_addr *);
401 #endif
402 int prison_check_af(struct ucred *cred, int af);
403 int prison_if(struct ucred *cred, struct sockaddr *sa);
404 char *prison_name(struct prison *, struct prison *);
405 int prison_priv_check(struct ucred *cred, int priv);
406 int sysctl_jail_param(SYSCTL_HANDLER_ARGS);
407 void prison_racct_foreach(void (*callback)(struct racct *racct,
408 void *arg2, void *arg3), void (*pre)(void), void (*post)(void),
409 void *arg2, void *arg3);
410 struct prison_racct *prison_racct_find(const char *name);
411 void prison_racct_hold(struct prison_racct *prr);
412 void prison_racct_free(struct prison_racct *prr);
413
414 #endif /* _KERNEL */
415 #endif /* !_SYS_JAIL_H_ */
416