2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2008-2010, 2015 Robert N. M. Watson
5 * Copyright (c) 2012 FreeBSD Foundation
8 * This software was developed at the University of Cambridge Computer
9 * Laboratory with support from a grant from Google, Inc.
11 * Portions of this software were developed by Pawel Jakub Dawidek under
12 * sponsorship from the FreeBSD Foundation.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 * Definitions for FreeBSD capabilities facility.
41 #ifndef _SYS_CAPSICUM_H_
42 #define _SYS_CAPSICUM_H_
44 #include <sys/cdefs.h>
45 #include <sys/param.h>
47 #include <sys/caprights.h>
49 #include <sys/fcntl.h>
55 #define CAPRIGHT(idx, bit) ((1ULL << (57 + (idx))) | (bit))
58 * Possible rights on capabilities.
61 * Some system calls don't require a capability in order to perform an
62 * operation on an fd. These include: close, dup, dup2.
64 * sendfile is authorized using CAP_READ on the file and CAP_WRITE on the
67 * mmap() and aio*() system calls will need special attention as they may
68 * involve reads or writes depending a great deal on context.
76 /* Allows for openat(O_RDONLY), read(2), readv(2). */
77 #define CAP_READ CAPRIGHT(0, 0x0000000000000001ULL)
78 /* Allows for openat(O_WRONLY | O_APPEND), write(2), writev(2). */
79 #define CAP_WRITE CAPRIGHT(0, 0x0000000000000002ULL)
80 /* Allows for lseek(fd, 0, SEEK_CUR). */
81 #define CAP_SEEK_TELL CAPRIGHT(0, 0x0000000000000004ULL)
82 /* Allows for lseek(2). */
83 #define CAP_SEEK (CAP_SEEK_TELL | 0x0000000000000008ULL)
84 /* Allows for aio_read(2), pread(2), preadv(2). */
85 #define CAP_PREAD (CAP_SEEK | CAP_READ)
87 * Allows for aio_write(2), openat(O_WRONLY) (without O_APPEND), pwrite(2),
90 #define CAP_PWRITE (CAP_SEEK | CAP_WRITE)
91 /* Allows for mmap(PROT_NONE). */
92 #define CAP_MMAP CAPRIGHT(0, 0x0000000000000010ULL)
93 /* Allows for mmap(PROT_READ). */
94 #define CAP_MMAP_R (CAP_MMAP | CAP_SEEK | CAP_READ)
95 /* Allows for mmap(PROT_WRITE). */
96 #define CAP_MMAP_W (CAP_MMAP | CAP_SEEK | CAP_WRITE)
97 /* Allows for mmap(PROT_EXEC). */
98 #define CAP_MMAP_X (CAP_MMAP | CAP_SEEK | 0x0000000000000020ULL)
99 /* Allows for mmap(PROT_READ | PROT_WRITE). */
100 #define CAP_MMAP_RW (CAP_MMAP_R | CAP_MMAP_W)
101 /* Allows for mmap(PROT_READ | PROT_EXEC). */
102 #define CAP_MMAP_RX (CAP_MMAP_R | CAP_MMAP_X)
103 /* Allows for mmap(PROT_WRITE | PROT_EXEC). */
104 #define CAP_MMAP_WX (CAP_MMAP_W | CAP_MMAP_X)
105 /* Allows for mmap(PROT_READ | PROT_WRITE | PROT_EXEC). */
106 #define CAP_MMAP_RWX (CAP_MMAP_R | CAP_MMAP_W | CAP_MMAP_X)
107 /* Allows for openat(O_CREAT). */
108 #define CAP_CREATE CAPRIGHT(0, 0x0000000000000040ULL)
109 /* Allows for openat(O_EXEC) and fexecve(2) in turn. */
110 #define CAP_FEXECVE CAPRIGHT(0, 0x0000000000000080ULL)
111 /* Allows for openat(O_SYNC), openat(O_FSYNC), fsync(2), aio_fsync(2). */
112 #define CAP_FSYNC CAPRIGHT(0, 0x0000000000000100ULL)
113 /* Allows for openat(O_TRUNC), ftruncate(2). */
114 #define CAP_FTRUNCATE CAPRIGHT(0, 0x0000000000000200ULL)
116 /* Lookups - used to constrain *at() calls. */
117 #define CAP_LOOKUP CAPRIGHT(0, 0x0000000000000400ULL)
120 /* Allows for fchdir(2). */
121 #define CAP_FCHDIR CAPRIGHT(0, 0x0000000000000800ULL)
122 /* Allows for fchflags(2). */
123 #define CAP_FCHFLAGS CAPRIGHT(0, 0x0000000000001000ULL)
124 /* Allows for fchflags(2) and chflagsat(2). */
125 #define CAP_CHFLAGSAT (CAP_FCHFLAGS | CAP_LOOKUP)
126 /* Allows for fchmod(2). */
127 #define CAP_FCHMOD CAPRIGHT(0, 0x0000000000002000ULL)
128 /* Allows for fchmod(2) and fchmodat(2). */
129 #define CAP_FCHMODAT (CAP_FCHMOD | CAP_LOOKUP)
130 /* Allows for fchown(2). */
131 #define CAP_FCHOWN CAPRIGHT(0, 0x0000000000004000ULL)
132 /* Allows for fchown(2) and fchownat(2). */
133 #define CAP_FCHOWNAT (CAP_FCHOWN | CAP_LOOKUP)
134 /* Allows for fcntl(2). */
135 #define CAP_FCNTL CAPRIGHT(0, 0x0000000000008000ULL)
137 * Allows for flock(2), openat(O_SHLOCK), openat(O_EXLOCK),
138 * fcntl(F_SETLK_REMOTE), fcntl(F_SETLKW), fcntl(F_SETLK), fcntl(F_GETLK).
140 #define CAP_FLOCK CAPRIGHT(0, 0x0000000000010000ULL)
141 /* Allows for fpathconf(2). */
142 #define CAP_FPATHCONF CAPRIGHT(0, 0x0000000000020000ULL)
143 /* Allows for UFS background-fsck operations. */
144 #define CAP_FSCK CAPRIGHT(0, 0x0000000000040000ULL)
145 /* Allows for fstat(2). */
146 #define CAP_FSTAT CAPRIGHT(0, 0x0000000000080000ULL)
147 /* Allows for fstat(2), fstatat(2) and faccessat(2). */
148 #define CAP_FSTATAT (CAP_FSTAT | CAP_LOOKUP)
149 /* Allows for fstatfs(2). */
150 #define CAP_FSTATFS CAPRIGHT(0, 0x0000000000100000ULL)
151 /* Allows for futimens(2) and futimes(2). */
152 #define CAP_FUTIMES CAPRIGHT(0, 0x0000000000200000ULL)
153 /* Allows for futimens(2), futimes(2), futimesat(2) and utimensat(2). */
154 #define CAP_FUTIMESAT (CAP_FUTIMES | CAP_LOOKUP)
155 /* Allows for linkat(2) (target directory descriptor). */
156 #define CAP_LINKAT_TARGET (CAP_LOOKUP | 0x0000000000400000ULL)
157 /* Allows for mkdirat(2). */
158 #define CAP_MKDIRAT (CAP_LOOKUP | 0x0000000000800000ULL)
159 /* Allows for mkfifoat(2). */
160 #define CAP_MKFIFOAT (CAP_LOOKUP | 0x0000000001000000ULL)
161 /* Allows for mknodat(2). */
162 #define CAP_MKNODAT (CAP_LOOKUP | 0x0000000002000000ULL)
163 /* Allows for renameat(2) (source directory descriptor). */
164 #define CAP_RENAMEAT_SOURCE (CAP_LOOKUP | 0x0000000004000000ULL)
165 /* Allows for symlinkat(2). */
166 #define CAP_SYMLINKAT (CAP_LOOKUP | 0x0000000008000000ULL)
168 * Allows for unlinkat(2) and renameat(2) if destination object exists and
171 #define CAP_UNLINKAT (CAP_LOOKUP | 0x0000000010000000ULL)
173 /* Socket operations. */
174 /* Allows for accept(2) and accept4(2). */
175 #define CAP_ACCEPT CAPRIGHT(0, 0x0000000020000000ULL)
176 /* Allows for bind(2). */
177 #define CAP_BIND CAPRIGHT(0, 0x0000000040000000ULL)
178 /* Allows for connect(2). */
179 #define CAP_CONNECT CAPRIGHT(0, 0x0000000080000000ULL)
180 /* Allows for getpeername(2). */
181 #define CAP_GETPEERNAME CAPRIGHT(0, 0x0000000100000000ULL)
182 /* Allows for getsockname(2). */
183 #define CAP_GETSOCKNAME CAPRIGHT(0, 0x0000000200000000ULL)
184 /* Allows for getsockopt(2). */
185 #define CAP_GETSOCKOPT CAPRIGHT(0, 0x0000000400000000ULL)
186 /* Allows for listen(2). */
187 #define CAP_LISTEN CAPRIGHT(0, 0x0000000800000000ULL)
188 /* Allows for sctp_peeloff(2). */
189 #define CAP_PEELOFF CAPRIGHT(0, 0x0000001000000000ULL)
190 #define CAP_RECV CAP_READ
191 #define CAP_SEND CAP_WRITE
192 /* Allows for setsockopt(2). */
193 #define CAP_SETSOCKOPT CAPRIGHT(0, 0x0000002000000000ULL)
194 /* Allows for shutdown(2). */
195 #define CAP_SHUTDOWN CAPRIGHT(0, 0x0000004000000000ULL)
197 /* Allows for bindat(2) on a directory descriptor. */
198 #define CAP_BINDAT (CAP_LOOKUP | 0x0000008000000000ULL)
199 /* Allows for connectat(2) on a directory descriptor. */
200 #define CAP_CONNECTAT (CAP_LOOKUP | 0x0000010000000000ULL)
202 /* Allows for linkat(2) (source directory descriptor). */
203 #define CAP_LINKAT_SOURCE (CAP_LOOKUP | 0x0000020000000000ULL)
204 /* Allows for renameat(2) (target directory descriptor). */
205 #define CAP_RENAMEAT_TARGET (CAP_LOOKUP | 0x0000040000000000ULL)
207 #define CAP_SOCK_CLIENT \
208 (CAP_CONNECT | CAP_GETPEERNAME | CAP_GETSOCKNAME | CAP_GETSOCKOPT | \
209 CAP_PEELOFF | CAP_RECV | CAP_SEND | CAP_SETSOCKOPT | CAP_SHUTDOWN)
210 #define CAP_SOCK_SERVER \
211 (CAP_ACCEPT | CAP_BIND | CAP_GETPEERNAME | CAP_GETSOCKNAME | \
212 CAP_GETSOCKOPT | CAP_LISTEN | CAP_PEELOFF | CAP_RECV | CAP_SEND | \
213 CAP_SETSOCKOPT | CAP_SHUTDOWN)
215 /* All used bits for index 0. */
216 #define CAP_ALL0 CAPRIGHT(0, 0x000007FFFFFFFFFFULL)
218 /* Available bits for index 0. */
219 #define CAP_UNUSED0_44 CAPRIGHT(0, 0x0000080000000000ULL)
221 #define CAP_UNUSED0_57 CAPRIGHT(0, 0x0100000000000000ULL)
225 /* Mandatory Access Control. */
226 /* Allows for mac_get_fd(3). */
227 #define CAP_MAC_GET CAPRIGHT(1, 0x0000000000000001ULL)
228 /* Allows for mac_set_fd(3). */
229 #define CAP_MAC_SET CAPRIGHT(1, 0x0000000000000002ULL)
231 /* Methods on semaphores. */
232 #define CAP_SEM_GETVALUE CAPRIGHT(1, 0x0000000000000004ULL)
233 #define CAP_SEM_POST CAPRIGHT(1, 0x0000000000000008ULL)
234 #define CAP_SEM_WAIT CAPRIGHT(1, 0x0000000000000010ULL)
236 /* Allows select(2) and poll(2) on descriptor. */
237 #define CAP_EVENT CAPRIGHT(1, 0x0000000000000020ULL)
238 /* Allows for kevent(2) on kqueue descriptor with eventlist != NULL. */
239 #define CAP_KQUEUE_EVENT CAPRIGHT(1, 0x0000000000000040ULL)
241 /* Strange and powerful rights that should not be given lightly. */
242 /* Allows for ioctl(2). */
243 #define CAP_IOCTL CAPRIGHT(1, 0x0000000000000080ULL)
244 #define CAP_TTYHOOK CAPRIGHT(1, 0x0000000000000100ULL)
246 /* Process management via process descriptors. */
247 /* Allows for pdgetpid(2). */
248 #define CAP_PDGETPID CAPRIGHT(1, 0x0000000000000200ULL)
250 * Allows for pdwait4(2).
252 * XXX: this constant was imported unused, but is targeted to be implemented
253 * in the future (bug 235871).
255 #define CAP_PDWAIT CAPRIGHT(1, 0x0000000000000400ULL)
256 /* Allows for pdkill(2). */
257 #define CAP_PDKILL CAPRIGHT(1, 0x0000000000000800ULL)
259 /* Extended attributes. */
260 /* Allows for extattr_delete_fd(2). */
261 #define CAP_EXTATTR_DELETE CAPRIGHT(1, 0x0000000000001000ULL)
262 /* Allows for extattr_get_fd(2). */
263 #define CAP_EXTATTR_GET CAPRIGHT(1, 0x0000000000002000ULL)
264 /* Allows for extattr_list_fd(2). */
265 #define CAP_EXTATTR_LIST CAPRIGHT(1, 0x0000000000004000ULL)
266 /* Allows for extattr_set_fd(2). */
267 #define CAP_EXTATTR_SET CAPRIGHT(1, 0x0000000000008000ULL)
269 /* Access Control Lists. */
270 /* Allows for acl_valid_fd_np(3). */
271 #define CAP_ACL_CHECK CAPRIGHT(1, 0x0000000000010000ULL)
272 /* Allows for acl_delete_fd_np(3). */
273 #define CAP_ACL_DELETE CAPRIGHT(1, 0x0000000000020000ULL)
274 /* Allows for acl_get_fd(3) and acl_get_fd_np(3). */
275 #define CAP_ACL_GET CAPRIGHT(1, 0x0000000000040000ULL)
276 /* Allows for acl_set_fd(3) and acl_set_fd_np(3). */
277 #define CAP_ACL_SET CAPRIGHT(1, 0x0000000000080000ULL)
279 /* Allows for kevent(2) on kqueue descriptor with changelist != NULL. */
280 #define CAP_KQUEUE_CHANGE CAPRIGHT(1, 0x0000000000100000ULL)
282 #define CAP_KQUEUE (CAP_KQUEUE_EVENT | CAP_KQUEUE_CHANGE)
284 /* All used bits for index 1. */
285 #define CAP_ALL1 CAPRIGHT(1, 0x00000000001FFFFFULL)
287 /* Available bits for index 1. */
288 #define CAP_UNUSED1_22 CAPRIGHT(1, 0x0000000000200000ULL)
290 #define CAP_UNUSED1_57 CAPRIGHT(1, 0x0100000000000000ULL)
292 /* Backward compatibility. */
293 #define CAP_POLL_EVENT CAP_EVENT
295 #define CAP_ALL(rights) do { \
296 (rights)->cr_rights[0] = \
297 ((uint64_t)CAP_RIGHTS_VERSION << 62) | CAP_ALL0; \
298 (rights)->cr_rights[1] = CAP_ALL1; \
301 #define CAP_NONE(rights) do { \
302 (rights)->cr_rights[0] = \
303 ((uint64_t)CAP_RIGHTS_VERSION << 62) | CAPRIGHT(0, 0ULL); \
304 (rights)->cr_rights[1] = CAPRIGHT(1, 0ULL); \
307 #define CAPRVER(right) ((int)((right) >> 62))
308 #define CAPVER(rights) CAPRVER((rights)->cr_rights[0])
309 #define CAPARSIZE(rights) (CAPVER(rights) + 2)
310 #define CAPIDXBIT(right) ((int)(((right) >> 57) & 0x1F))
313 * Allowed fcntl(2) commands.
315 #define CAP_FCNTL_GETFL (1 << F_GETFL)
316 #define CAP_FCNTL_SETFL (1 << F_SETFL)
317 #define CAP_FCNTL_GETOWN (1 << F_GETOWN)
318 #define CAP_FCNTL_SETOWN (1 << F_SETOWN)
319 #define CAP_FCNTL_ALL (CAP_FCNTL_GETFL | CAP_FCNTL_SETFL | \
320 CAP_FCNTL_GETOWN | CAP_FCNTL_SETOWN)
322 #define CAP_IOCTLS_ALL SSIZE_MAX
326 #define cap_rights_init(...) \
327 __cap_rights_init(CAP_RIGHTS_VERSION, __VA_ARGS__, 0ULL)
328 cap_rights_t *__cap_rights_init(int version, cap_rights_t *rights, ...);
330 #define cap_rights_set(...) \
331 __cap_rights_set(__VA_ARGS__, 0ULL)
332 cap_rights_t *__cap_rights_set(cap_rights_t *rights, ...);
334 #define cap_rights_clear(...) \
335 __cap_rights_clear(__VA_ARGS__, 0ULL)
336 cap_rights_t *__cap_rights_clear(cap_rights_t *rights, ...);
338 #define cap_rights_is_set(...) \
339 __cap_rights_is_set(__VA_ARGS__, 0ULL)
340 bool __cap_rights_is_set(const cap_rights_t *rights, ...);
342 bool cap_rights_is_valid(const cap_rights_t *rights);
343 cap_rights_t *cap_rights_merge(cap_rights_t *dst, const cap_rights_t *src);
344 cap_rights_t *cap_rights_remove(cap_rights_t *dst, const cap_rights_t *src);
348 * We only support one size to reduce branching.
350 _Static_assert(CAP_RIGHTS_VERSION == CAP_RIGHTS_VERSION_00,
351 "unsupported version of capsicum rights");
353 #define cap_rights_init_zero(r) ({ \
354 cap_rights_t *_r = (r); \
359 #define cap_rights_init_one(r, right) ({ \
360 CTASSERT(CAPRVER(right) == CAP_RIGHTS_VERSION); \
361 cap_rights_t *_r = (r); \
363 _r->cr_rights[CAPIDXBIT(right) - 1] |= right; \
367 #define cap_rights_set_one(r, right) ({ \
368 CTASSERT(CAPRVER(right) == CAP_RIGHTS_VERSION); \
369 cap_rights_t *_r = (r); \
370 _r->cr_rights[CAPIDXBIT(right) - 1] |= right; \
375 * Allow checking caps which are possibly getting modified at the same time.
376 * The caller is expected to determine whether the result is legitimate via
377 * other means, see fget_unlocked for an example.
381 cap_rights_contains_transient(const cap_rights_t *big, const cap_rights_t *little)
385 (big->cr_rights[0] & little->cr_rights[0]) == little->cr_rights[0] &&
386 (big->cr_rights[1] & little->cr_rights[1]) == little->cr_rights[1]))
391 #define cap_rights_contains cap_rights_contains_transient
393 int cap_check_failed_notcapable(const cap_rights_t *havep,
394 const cap_rights_t *needp);
397 cap_check_inline(const cap_rights_t *havep, const cap_rights_t *needp)
400 if (__predict_false(!cap_rights_contains(havep, needp)))
401 return (cap_check_failed_notcapable(havep, needp));
406 cap_check_inline_transient(const cap_rights_t *havep, const cap_rights_t *needp)
409 if (__predict_false(!cap_rights_contains(havep, needp)))
414 bool cap_rights_contains(const cap_rights_t *big, const cap_rights_t *little);
421 #include <sys/systm.h>
423 #define IN_CAPABILITY_MODE(td) (((td)->td_ucred->cr_flags & CRED_FLAG_CAPMODE) != 0)
429 * Test whether a capability grants the requested rights.
431 int cap_check(const cap_rights_t *havep, const cap_rights_t *needp);
433 * Convert capability rights into VM access flags.
435 vm_prot_t cap_rights_to_vmprot(const cap_rights_t *havep);
438 * For the purposes of procstat(1) and similar tools, allow kern_descrip.c to
439 * extract the rights from a capability.
441 * Dereferencing fdep requires filedesc.h, but including it would cause
442 * significant pollution. Instead add a macro for consumers which want it,
443 * most notably kern_descrip.c.
445 #define cap_rights_fde_inline(fdep) (&(fdep)->fde_rights)
447 const cap_rights_t *cap_rights_fde(const struct filedescent *fde);
448 const cap_rights_t *cap_rights(struct filedesc *fdp, int fd);
450 int cap_ioctl_check(struct filedesc *fdp, int fd, u_long cmd);
451 int cap_fcntl_check_fde(struct filedescent *fde, int cmd);
452 int cap_fcntl_check(struct filedesc *fdp, int fd, int cmd);
454 extern bool trap_enotcap;
460 * cap_enter(): Cause the process to enter capability mode, which will
461 * prevent it from directly accessing global namespaces. System calls will
462 * be limited to process-local, process-inherited, or file descriptor
463 * operations. If already in capability mode, a no-op.
468 * Are we sandboxed (in capability mode)?
469 * This is a libc wrapper around the cap_getmode(2) system call.
471 bool cap_sandboxed(void);
474 * cap_getmode(): Are we in capability mode?
476 int cap_getmode(u_int *modep);
479 * Limits capability rights for the given descriptor (CAP_*).
481 int cap_rights_limit(int fd, const cap_rights_t *rights);
483 * Returns capability rights for the given descriptor.
485 #define cap_rights_get(fd, rights) \
486 __cap_rights_get(CAP_RIGHTS_VERSION, (fd), (rights))
487 int __cap_rights_get(int version, int fd, cap_rights_t *rights);
489 * Limits allowed ioctls for the given descriptor.
491 int cap_ioctls_limit(int fd, const cap_ioctl_t *cmds, size_t ncmds);
493 * Returns array of allowed ioctls for the given descriptor.
494 * If all ioctls are allowed, the cmds array is not populated and
495 * the function returns CAP_IOCTLS_ALL.
497 ssize_t cap_ioctls_get(int fd, cap_ioctl_t *cmds, size_t maxcmds);
499 * Limits allowed fcntls for the given descriptor (CAP_FCNTL_*).
501 int cap_fcntls_limit(int fd, uint32_t fcntlrights);
503 * Returns bitmask of allowed fcntls for the given descriptor.
505 int cap_fcntls_get(int fd, uint32_t *fcntlrightsp);
509 #endif /* !_KERNEL */
511 #endif /* !_SYS_CAPSICUM_H_ */