FreeBSD/Linux Kernel Cross Reference
sys/sys/capsicum.h
1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2008-2010, 2015 Robert N. M. Watson
5 * Copyright (c) 2012 FreeBSD Foundation
6 * All rights reserved.
7 *
8 * This software was developed at the University of Cambridge Computer
9 * Laboratory with support from a grant from Google, Inc.
10 *
11 * Portions of this software were developed by Pawel Jakub Dawidek under
12 * sponsorship from the FreeBSD Foundation.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
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.
22 *
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
33 * SUCH DAMAGE.
34 *
35 * $FreeBSD: releng/12.0/sys/sys/capsicum.h 339341 2018-10-12 23:48:10Z mjg $
36 */
37
38 /*
39 * Definitions for FreeBSD capabilities facility.
40 */
41 #ifndef _SYS_CAPSICUM_H_
42 #define _SYS_CAPSICUM_H_
43
44 #include <sys/cdefs.h>
45 #include <sys/param.h>
46
47 #include <sys/caprights.h>
48 #include <sys/file.h>
49 #include <sys/fcntl.h>
50
51 #ifndef _KERNEL
52 #include <stdbool.h>
53 #endif
54
55 #define CAPRIGHT(idx, bit) ((1ULL << (57 + (idx))) | (bit))
56
57 /*
58 * Possible rights on capabilities.
59 *
60 * Notes:
61 * Some system calls don't require a capability in order to perform an
62 * operation on an fd. These include: close, dup, dup2.
63 *
64 * sendfile is authorized using CAP_READ on the file and CAP_WRITE on the
65 * socket.
66 *
67 * mmap() and aio*() system calls will need special attention as they may
68 * involve reads or writes depending a great deal on context.
69 */
70
71 /* INDEX 0 */
72
73 /*
74 * General file I/O.
75 */
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)
86 /*
87 * Allows for aio_write(2), openat(O_WRONLY) (without O_APPEND), pwrite(2),
88 * pwritev(2).
89 */
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)
115
116 /* Lookups - used to constrain *at() calls. */
117 #define CAP_LOOKUP CAPRIGHT(0, 0x0000000000000400ULL)
118
119 /* VFS methods. */
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)
136 /*
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).
139 */
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)
167 /*
168 * Allows for unlinkat(2) and renameat(2) if destination object exists and
169 * will be removed.
170 */
171 #define CAP_UNLINKAT (CAP_LOOKUP | 0x0000000010000000ULL)
172
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)
196
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)
201
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)
206
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)
214
215 /* All used bits for index 0. */
216 #define CAP_ALL0 CAPRIGHT(0, 0x000007FFFFFFFFFFULL)
217
218 /* Available bits for index 0. */
219 #define CAP_UNUSED0_44 CAPRIGHT(0, 0x0000080000000000ULL)
220 /* ... */
221 #define CAP_UNUSED0_57 CAPRIGHT(0, 0x0100000000000000ULL)
222
223 /* INDEX 1 */
224
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)
230
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)
235
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)
240
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)
245
246 /* Process management via process descriptors. */
247 /* Allows for pdgetpid(2). */
248 #define CAP_PDGETPID CAPRIGHT(1, 0x0000000000000200ULL)
249 /* Allows for pdwait4(2). */
250 #define CAP_PDWAIT CAPRIGHT(1, 0x0000000000000400ULL)
251 /* Allows for pdkill(2). */
252 #define CAP_PDKILL CAPRIGHT(1, 0x0000000000000800ULL)
253
254 /* Extended attributes. */
255 /* Allows for extattr_delete_fd(2). */
256 #define CAP_EXTATTR_DELETE CAPRIGHT(1, 0x0000000000001000ULL)
257 /* Allows for extattr_get_fd(2). */
258 #define CAP_EXTATTR_GET CAPRIGHT(1, 0x0000000000002000ULL)
259 /* Allows for extattr_list_fd(2). */
260 #define CAP_EXTATTR_LIST CAPRIGHT(1, 0x0000000000004000ULL)
261 /* Allows for extattr_set_fd(2). */
262 #define CAP_EXTATTR_SET CAPRIGHT(1, 0x0000000000008000ULL)
263
264 /* Access Control Lists. */
265 /* Allows for acl_valid_fd_np(3). */
266 #define CAP_ACL_CHECK CAPRIGHT(1, 0x0000000000010000ULL)
267 /* Allows for acl_delete_fd_np(3). */
268 #define CAP_ACL_DELETE CAPRIGHT(1, 0x0000000000020000ULL)
269 /* Allows for acl_get_fd(3) and acl_get_fd_np(3). */
270 #define CAP_ACL_GET CAPRIGHT(1, 0x0000000000040000ULL)
271 /* Allows for acl_set_fd(3) and acl_set_fd_np(3). */
272 #define CAP_ACL_SET CAPRIGHT(1, 0x0000000000080000ULL)
273
274 /* Allows for kevent(2) on kqueue descriptor with changelist != NULL. */
275 #define CAP_KQUEUE_CHANGE CAPRIGHT(1, 0x0000000000100000ULL)
276
277 #define CAP_KQUEUE (CAP_KQUEUE_EVENT | CAP_KQUEUE_CHANGE)
278
279 /* All used bits for index 1. */
280 #define CAP_ALL1 CAPRIGHT(1, 0x00000000001FFFFFULL)
281
282 /* Available bits for index 1. */
283 #define CAP_UNUSED1_22 CAPRIGHT(1, 0x0000000000200000ULL)
284 /* ... */
285 #define CAP_UNUSED1_57 CAPRIGHT(1, 0x0100000000000000ULL)
286
287 /* Backward compatibility. */
288 #define CAP_POLL_EVENT CAP_EVENT
289
290 #define CAP_ALL(rights) do { \
291 (rights)->cr_rights[0] = \
292 ((uint64_t)CAP_RIGHTS_VERSION << 62) | CAP_ALL0; \
293 (rights)->cr_rights[1] = CAP_ALL1; \
294 } while (0)
295
296 #define CAP_NONE(rights) do { \
297 (rights)->cr_rights[0] = \
298 ((uint64_t)CAP_RIGHTS_VERSION << 62) | CAPRIGHT(0, 0ULL); \
299 (rights)->cr_rights[1] = CAPRIGHT(1, 0ULL); \
300 } while (0)
301
302 #define CAPRVER(right) ((int)((right) >> 62))
303 #define CAPVER(rights) CAPRVER((rights)->cr_rights[0])
304 #define CAPARSIZE(rights) (CAPVER(rights) + 2)
305 #define CAPIDXBIT(right) ((int)(((right) >> 57) & 0x1F))
306
307 /*
308 * Allowed fcntl(2) commands.
309 */
310 #define CAP_FCNTL_GETFL (1 << F_GETFL)
311 #define CAP_FCNTL_SETFL (1 << F_SETFL)
312 #define CAP_FCNTL_GETOWN (1 << F_GETOWN)
313 #define CAP_FCNTL_SETOWN (1 << F_SETOWN)
314 #define CAP_FCNTL_ALL (CAP_FCNTL_GETFL | CAP_FCNTL_SETFL | \
315 CAP_FCNTL_GETOWN | CAP_FCNTL_SETOWN)
316
317 #define CAP_IOCTLS_ALL SSIZE_MAX
318
319 __BEGIN_DECLS
320
321 #define cap_rights_init(...) \
322 __cap_rights_init(CAP_RIGHTS_VERSION, __VA_ARGS__, 0ULL)
323 cap_rights_t *__cap_rights_init(int version, cap_rights_t *rights, ...);
324
325 #define cap_rights_set(...) \
326 __cap_rights_set(__VA_ARGS__, 0ULL)
327 cap_rights_t *__cap_rights_set(cap_rights_t *rights, ...);
328
329 #define cap_rights_clear(...) \
330 __cap_rights_clear(__VA_ARGS__, 0ULL)
331 cap_rights_t *__cap_rights_clear(cap_rights_t *rights, ...);
332
333 #define cap_rights_is_set(...) \
334 __cap_rights_is_set(__VA_ARGS__, 0ULL)
335 bool __cap_rights_is_set(const cap_rights_t *rights, ...);
336
337 bool cap_rights_is_valid(const cap_rights_t *rights);
338 cap_rights_t *cap_rights_merge(cap_rights_t *dst, const cap_rights_t *src);
339 cap_rights_t *cap_rights_remove(cap_rights_t *dst, const cap_rights_t *src);
340 bool cap_rights_contains(const cap_rights_t *big, const cap_rights_t *little);
341 void __cap_rights_sysinit(void *arg);
342
343 __END_DECLS
344 struct cap_rights_init_args {
345 cap_rights_t *cria_rights;
346 uint64_t cria_value1;
347 uint64_t cria_value2;
348 uint64_t cria_value3;
349 uint64_t cria_value4;
350 uint64_t cria_value5;
351 };
352
353 #define CAP_RIGHTS_SYSINIT0(name, rights) \
354 static struct cap_rights_init_args name##_args = { \
355 &(rights) \
356 }; \
357 SYSINIT(name##_cap_rights_sysinit, SI_SUB_COPYRIGHT+1, SI_ORDER_ANY, \
358 __cap_rights_sysinit, &name##_args);
359
360 #define CAP_RIGHTS_SYSINIT1(name, rights, value1) \
361 static struct cap_rights_init_args name##_args = { \
362 &(rights), \
363 (value1) \
364 }; \
365 SYSINIT(name##_cap_rights_sysinit, SI_SUB_COPYRIGHT+1, SI_ORDER_ANY, \
366 __cap_rights_sysinit, &name##_args);
367
368 #define CAP_RIGHTS_SYSINIT2(name, rights, value1, value2) \
369 static struct cap_rights_init_args name##_args = { \
370 &(rights), \
371 (value1), \
372 (value2) \
373 }; \
374 SYSINIT(name##_cap_rights_sysinit, SI_SUB_COPYRIGHT, SI_ORDER_ANY, \
375 __cap_rights_sysinit, &name##_args);
376
377 #define CAP_RIGHTS_SYSINIT3(name, rights, value1, value2, value3) \
378 static struct cap_rights_init_args name##_args = { \
379 &(rights), \
380 (value1), \
381 (value2), \
382 (value3) \
383 }; \
384 SYSINIT(name##_cap_rights_sysinit, SI_SUB_COPYRIGHT, SI_ORDER_ANY, \
385 __cap_rights_sysinit, &name##_args);
386
387 #define CAP_RIGHTS_SYSINIT4(name, rights, value1, value2, value3, value4) \
388 static struct cap_rights_init_args name##_args = { \
389 &(rights), \
390 (value1), \
391 (value2), \
392 (value3), \
393 (value4) \
394 }; \
395 SYSINIT(name##_cap_rights_sysinit, SI_SUB_COPYRIGHT, SI_ORDER_ANY, \
396 __cap_rights_sysinit, &name##_args);
397
398 #define CAP_RIGHTS_DEFINE1(name, value) \
399 __read_mostly cap_rights_t name; \
400 CAP_RIGHTS_SYSINIT1(name, name, value);
401
402 #ifdef _KERNEL
403
404 #include <sys/systm.h>
405 extern cap_rights_t cap_accept_rights;
406 extern cap_rights_t cap_bind_rights;
407 extern cap_rights_t cap_connect_rights;
408 extern cap_rights_t cap_event_rights;
409 extern cap_rights_t cap_fchdir_rights;
410 extern cap_rights_t cap_fchflags_rights;
411 extern cap_rights_t cap_fchmod_rights;
412 extern cap_rights_t cap_fchown_rights;
413 extern cap_rights_t cap_fcntl_rights;
414 extern cap_rights_t cap_fexecve_rights;
415 extern cap_rights_t cap_flock_rights;
416 extern cap_rights_t cap_fpathconf_rights;
417 extern cap_rights_t cap_fstat_rights;
418 extern cap_rights_t cap_fstatfs_rights;
419 extern cap_rights_t cap_fsync_rights;
420 extern cap_rights_t cap_ftruncate_rights;
421 extern cap_rights_t cap_futimes_rights;
422 extern cap_rights_t cap_getpeername_rights;
423 extern cap_rights_t cap_getsockopt_rights;
424 extern cap_rights_t cap_getsockname_rights;
425 extern cap_rights_t cap_ioctl_rights;
426 extern cap_rights_t cap_linkat_source_rights;
427 extern cap_rights_t cap_linkat_target_rights;
428 extern cap_rights_t cap_listen_rights;
429 extern cap_rights_t cap_mkdirat_rights;
430 extern cap_rights_t cap_mkfifoat_rights;
431 extern cap_rights_t cap_mknodat_rights;
432 extern cap_rights_t cap_mmap_rights;
433 extern cap_rights_t cap_no_rights;
434 extern cap_rights_t cap_pdgetpid_rights;
435 extern cap_rights_t cap_pdkill_rights;
436 extern cap_rights_t cap_pread_rights;
437 extern cap_rights_t cap_pwrite_rights;
438 extern cap_rights_t cap_read_rights;
439 extern cap_rights_t cap_recv_rights;
440 extern cap_rights_t cap_renameat_source_rights;
441 extern cap_rights_t cap_renameat_target_rights;
442 extern cap_rights_t cap_seek_rights;
443 extern cap_rights_t cap_send_rights;
444 extern cap_rights_t cap_send_connect_rights;
445 extern cap_rights_t cap_setsockopt_rights;
446 extern cap_rights_t cap_shutdown_rights;
447 extern cap_rights_t cap_symlinkat_rights;
448 extern cap_rights_t cap_unlinkat_rights;
449 extern cap_rights_t cap_write_rights;
450
451 #define IN_CAPABILITY_MODE(td) (((td)->td_ucred->cr_flags & CRED_FLAG_CAPMODE) != 0)
452
453 struct filedesc;
454 struct filedescent;
455
456 /*
457 * Test whether a capability grants the requested rights.
458 */
459 int cap_check(const cap_rights_t *havep, const cap_rights_t *needp);
460 /*
461 * Convert capability rights into VM access flags.
462 */
463 u_char cap_rights_to_vmprot(const cap_rights_t *havep);
464
465 /*
466 * For the purposes of procstat(1) and similar tools, allow kern_descrip.c to
467 * extract the rights from a capability.
468 *
469 * Dereferencing fdep requires filedesc.h, but including it would cause
470 * significant pollution. Instead add a macro for consumers which want it,
471 * most notably kern_descrip.c.
472 */
473 #define cap_rights_fde_inline(fdep) (&(fdep)->fde_rights)
474
475 const cap_rights_t *cap_rights_fde(const struct filedescent *fde);
476 const cap_rights_t *cap_rights(struct filedesc *fdp, int fd);
477
478 int cap_ioctl_check(struct filedesc *fdp, int fd, u_long cmd);
479 int cap_fcntl_check_fde(struct filedescent *fde, int cmd);
480 int cap_fcntl_check(struct filedesc *fdp, int fd, int cmd);
481
482 extern bool trap_enotcap;
483
484 #else /* !_KERNEL */
485
486 __BEGIN_DECLS
487 /*
488 * cap_enter(): Cause the process to enter capability mode, which will
489 * prevent it from directly accessing global namespaces. System calls will
490 * be limited to process-local, process-inherited, or file descriptor
491 * operations. If already in capability mode, a no-op.
492 */
493 int cap_enter(void);
494
495 /*
496 * Are we sandboxed (in capability mode)?
497 * This is a libc wrapper around the cap_getmode(2) system call.
498 */
499 bool cap_sandboxed(void);
500
501 /*
502 * cap_getmode(): Are we in capability mode?
503 */
504 int cap_getmode(u_int *modep);
505
506 /*
507 * Limits capability rights for the given descriptor (CAP_*).
508 */
509 int cap_rights_limit(int fd, const cap_rights_t *rights);
510 /*
511 * Returns capability rights for the given descriptor.
512 */
513 #define cap_rights_get(fd, rights) \
514 __cap_rights_get(CAP_RIGHTS_VERSION, (fd), (rights))
515 int __cap_rights_get(int version, int fd, cap_rights_t *rights);
516 /*
517 * Limits allowed ioctls for the given descriptor.
518 */
519 int cap_ioctls_limit(int fd, const cap_ioctl_t *cmds, size_t ncmds);
520 /*
521 * Returns array of allowed ioctls for the given descriptor.
522 * If all ioctls are allowed, the cmds array is not populated and
523 * the function returns CAP_IOCTLS_ALL.
524 */
525 ssize_t cap_ioctls_get(int fd, cap_ioctl_t *cmds, size_t maxcmds);
526 /*
527 * Limits allowed fcntls for the given descriptor (CAP_FCNTL_*).
528 */
529 int cap_fcntls_limit(int fd, uint32_t fcntlrights);
530 /*
531 * Returns bitmask of allowed fcntls for the given descriptor.
532 */
533 int cap_fcntls_get(int fd, uint32_t *fcntlrightsp);
534
535 __END_DECLS
536
537 #endif /* !_KERNEL */
538
539 #endif /* !_SYS_CAPSICUM_H_ */
Cache object: 194b506b8874f4d20cb4a50db0a743c3
|