2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2013 FreeBSD Foundation
6 * This software was developed by Pawel Jakub Dawidek under sponsorship from
7 * the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
35 * Note that this file is compiled into the kernel and into libc.
38 #include <sys/types.h>
39 #include <sys/capsicum.h>
42 #include <sys/systm.h>
43 #include <sys/kernel.h>
44 #include <machine/stdarg.h>
54 #define assert(exp) KASSERT((exp), ("%s:%u", __func__, __LINE__))
55 __read_mostly cap_rights_t cap_accept_rights;
56 __read_mostly cap_rights_t cap_bind_rights;
57 __read_mostly cap_rights_t cap_chflags_rights;
58 __read_mostly cap_rights_t cap_connect_rights;
59 __read_mostly cap_rights_t cap_event_rights;
60 __read_mostly cap_rights_t cap_fchdir_rights;
61 __read_mostly cap_rights_t cap_fchflags_rights;
62 __read_mostly cap_rights_t cap_fchmod_rights;
63 __read_mostly cap_rights_t cap_fchown_rights;
64 __read_mostly cap_rights_t cap_fcntl_rights;
65 __read_mostly cap_rights_t cap_fexecve_rights;
66 __read_mostly cap_rights_t cap_flock_rights;
67 __read_mostly cap_rights_t cap_fpathconf_rights;
68 __read_mostly cap_rights_t cap_fstat_rights;
69 __read_mostly cap_rights_t cap_fstatfs_rights;
70 __read_mostly cap_rights_t cap_fsync_rights;
71 __read_mostly cap_rights_t cap_ftruncate_rights;
72 __read_mostly cap_rights_t cap_futimes_rights;
73 __read_mostly cap_rights_t cap_getpeername_rights;
74 __read_mostly cap_rights_t cap_getsockopt_rights;
75 __read_mostly cap_rights_t cap_getsockname_rights;
76 __read_mostly cap_rights_t cap_ioctl_rights;
77 __read_mostly cap_rights_t cap_listen_rights;
78 __read_mostly cap_rights_t cap_linkat_source_rights;
79 __read_mostly cap_rights_t cap_linkat_target_rights;
80 __read_mostly cap_rights_t cap_mmap_rights;
81 __read_mostly cap_rights_t cap_mkdirat_rights;
82 __read_mostly cap_rights_t cap_mkfifoat_rights;
83 __read_mostly cap_rights_t cap_mknodat_rights;
84 __read_mostly cap_rights_t cap_pdgetpid_rights;
85 __read_mostly cap_rights_t cap_pdkill_rights;
86 __read_mostly cap_rights_t cap_pread_rights;
87 __read_mostly cap_rights_t cap_pwrite_rights;
88 __read_mostly cap_rights_t cap_read_rights;
89 __read_mostly cap_rights_t cap_recv_rights;
90 __read_mostly cap_rights_t cap_renameat_source_rights;
91 __read_mostly cap_rights_t cap_renameat_target_rights;
92 __read_mostly cap_rights_t cap_seek_rights;
93 __read_mostly cap_rights_t cap_send_rights;
94 __read_mostly cap_rights_t cap_send_connect_rights;
95 __read_mostly cap_rights_t cap_setsockopt_rights;
96 __read_mostly cap_rights_t cap_shutdown_rights;
97 __read_mostly cap_rights_t cap_symlinkat_rights;
98 __read_mostly cap_rights_t cap_unlinkat_rights;
99 __read_mostly cap_rights_t cap_write_rights;
100 __read_mostly cap_rights_t cap_no_rights;
103 cap_rights_sysinit(void *arg)
105 cap_rights_init_one(&cap_accept_rights, CAP_ACCEPT);
106 cap_rights_init_one(&cap_bind_rights, CAP_BIND);
107 cap_rights_init_one(&cap_connect_rights, CAP_CONNECT);
108 cap_rights_init_one(&cap_event_rights, CAP_EVENT);
109 cap_rights_init_one(&cap_fchdir_rights, CAP_FCHDIR);
110 cap_rights_init_one(&cap_fchflags_rights, CAP_FCHFLAGS);
111 cap_rights_init_one(&cap_fchmod_rights, CAP_FCHMOD);
112 cap_rights_init_one(&cap_fchown_rights, CAP_FCHOWN);
113 cap_rights_init_one(&cap_fcntl_rights, CAP_FCNTL);
114 cap_rights_init_one(&cap_fexecve_rights, CAP_FEXECVE);
115 cap_rights_init_one(&cap_flock_rights, CAP_FLOCK);
116 cap_rights_init_one(&cap_fpathconf_rights, CAP_FPATHCONF);
117 cap_rights_init_one(&cap_fstat_rights, CAP_FSTAT);
118 cap_rights_init_one(&cap_fstatfs_rights, CAP_FSTATFS);
119 cap_rights_init_one(&cap_fsync_rights, CAP_FSYNC);
120 cap_rights_init_one(&cap_ftruncate_rights, CAP_FTRUNCATE);
121 cap_rights_init_one(&cap_futimes_rights, CAP_FUTIMES);
122 cap_rights_init_one(&cap_getpeername_rights, CAP_GETPEERNAME);
123 cap_rights_init_one(&cap_getsockname_rights, CAP_GETSOCKNAME);
124 cap_rights_init_one(&cap_getsockopt_rights, CAP_GETSOCKOPT);
125 cap_rights_init_one(&cap_ioctl_rights, CAP_IOCTL);
126 cap_rights_init_one(&cap_linkat_source_rights, CAP_LINKAT_SOURCE);
127 cap_rights_init_one(&cap_linkat_target_rights, CAP_LINKAT_TARGET);
128 cap_rights_init_one(&cap_listen_rights, CAP_LISTEN);
129 cap_rights_init_one(&cap_mkdirat_rights, CAP_MKDIRAT);
130 cap_rights_init_one(&cap_mkfifoat_rights, CAP_MKFIFOAT);
131 cap_rights_init_one(&cap_mknodat_rights, CAP_MKNODAT);
132 cap_rights_init_one(&cap_mmap_rights, CAP_MMAP);
133 cap_rights_init_one(&cap_pdgetpid_rights, CAP_PDGETPID);
134 cap_rights_init_one(&cap_pdkill_rights, CAP_PDKILL);
135 cap_rights_init_one(&cap_pread_rights, CAP_PREAD);
136 cap_rights_init_one(&cap_pwrite_rights, CAP_PWRITE);
137 cap_rights_init_one(&cap_read_rights, CAP_READ);
138 cap_rights_init_one(&cap_recv_rights, CAP_RECV);
139 cap_rights_init_one(&cap_renameat_source_rights, CAP_RENAMEAT_SOURCE);
140 cap_rights_init_one(&cap_renameat_target_rights, CAP_RENAMEAT_TARGET);
141 cap_rights_init_one(&cap_seek_rights, CAP_SEEK);
142 cap_rights_init_one(&cap_send_rights, CAP_SEND);
143 cap_rights_init(&cap_send_connect_rights, CAP_SEND, CAP_CONNECT);
144 cap_rights_init_one(&cap_setsockopt_rights, CAP_SETSOCKOPT);
145 cap_rights_init_one(&cap_shutdown_rights, CAP_SHUTDOWN);
146 cap_rights_init_one(&cap_symlinkat_rights, CAP_SYMLINKAT);
147 cap_rights_init_one(&cap_unlinkat_rights, CAP_UNLINKAT);
148 cap_rights_init_one(&cap_write_rights, CAP_WRITE);
149 cap_rights_init(&cap_no_rights);
151 SYSINIT(cap_rights_sysinit, SI_SUB_COPYRIGHT, SI_ORDER_ANY, cap_rights_sysinit,
156 #define CAPARSIZE_MIN (CAP_RIGHTS_VERSION_00 + 2)
157 #define CAPARSIZE_MAX (CAP_RIGHTS_VERSION + 2)
160 right_to_index(uint64_t right)
162 static const int bit2idx[] = {
163 -1, 0, 1, -1, 2, -1, -1, -1, 3, -1, -1, -1, -1, -1, -1, -1,
164 4, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1
168 idx = CAPIDXBIT(right);
169 assert(idx >= 0 && idx < sizeof(bit2idx) / sizeof(bit2idx[0]));
170 return (bit2idx[idx]);
174 cap_rights_vset(cap_rights_t *rights, va_list ap)
179 assert(CAPVER(rights) == CAP_RIGHTS_VERSION_00);
181 n = CAPARSIZE(rights);
182 assert(n >= CAPARSIZE_MIN && n <= CAPARSIZE_MAX);
185 right = (uint64_t)va_arg(ap, unsigned long long);
188 assert(CAPRVER(right) == 0);
189 i = right_to_index(right);
192 assert(CAPIDXBIT(rights->cr_rights[i]) == CAPIDXBIT(right));
193 rights->cr_rights[i] |= right;
194 assert(CAPIDXBIT(rights->cr_rights[i]) == CAPIDXBIT(right));
199 cap_rights_vclear(cap_rights_t *rights, va_list ap)
204 assert(CAPVER(rights) == CAP_RIGHTS_VERSION_00);
206 n = CAPARSIZE(rights);
207 assert(n >= CAPARSIZE_MIN && n <= CAPARSIZE_MAX);
210 right = (uint64_t)va_arg(ap, unsigned long long);
213 assert(CAPRVER(right) == 0);
214 i = right_to_index(right);
217 assert(CAPIDXBIT(rights->cr_rights[i]) == CAPIDXBIT(right));
218 rights->cr_rights[i] &= ~(right & 0x01FFFFFFFFFFFFFFULL);
219 assert(CAPIDXBIT(rights->cr_rights[i]) == CAPIDXBIT(right));
224 cap_rights_is_vset(const cap_rights_t *rights, va_list ap)
229 assert(CAPVER(rights) == CAP_RIGHTS_VERSION_00);
231 n = CAPARSIZE(rights);
232 assert(n >= CAPARSIZE_MIN && n <= CAPARSIZE_MAX);
235 right = (uint64_t)va_arg(ap, unsigned long long);
238 assert(CAPRVER(right) == 0);
239 i = right_to_index(right);
242 assert(CAPIDXBIT(rights->cr_rights[i]) == CAPIDXBIT(right));
243 if ((rights->cr_rights[i] & right) != right)
251 __cap_rights_init(int version, cap_rights_t *rights, ...)
253 unsigned int n __unused;
256 assert(version == CAP_RIGHTS_VERSION_00);
259 assert(n >= CAPARSIZE_MIN && n <= CAPARSIZE_MAX);
261 va_start(ap, rights);
262 cap_rights_vset(rights, ap);
269 __cap_rights_set(cap_rights_t *rights, ...)
273 assert(CAPVER(rights) == CAP_RIGHTS_VERSION_00);
275 va_start(ap, rights);
276 cap_rights_vset(rights, ap);
283 __cap_rights_clear(cap_rights_t *rights, ...)
287 assert(CAPVER(rights) == CAP_RIGHTS_VERSION_00);
289 va_start(ap, rights);
290 cap_rights_vclear(rights, ap);
297 __cap_rights_is_set(const cap_rights_t *rights, ...)
302 assert(CAPVER(rights) == CAP_RIGHTS_VERSION_00);
304 va_start(ap, rights);
305 ret = cap_rights_is_vset(rights, ap);
312 cap_rights_is_valid(const cap_rights_t *rights)
314 cap_rights_t allrights;
317 if (CAPVER(rights) != CAP_RIGHTS_VERSION_00)
319 if (CAPARSIZE(rights) < CAPARSIZE_MIN ||
320 CAPARSIZE(rights) > CAPARSIZE_MAX) {
324 if (!cap_rights_contains(&allrights, rights))
326 for (i = 0; i < CAPARSIZE(rights); i++) {
327 j = right_to_index(rights->cr_rights[i]);
331 if (CAPRVER(rights->cr_rights[i]) != 0)
340 cap_rights_merge(cap_rights_t *dst, const cap_rights_t *src)
344 assert(CAPVER(dst) == CAP_RIGHTS_VERSION_00);
345 assert(CAPVER(src) == CAP_RIGHTS_VERSION_00);
346 assert(CAPVER(dst) == CAPVER(src));
347 assert(cap_rights_is_valid(src));
348 assert(cap_rights_is_valid(dst));
351 assert(n >= CAPARSIZE_MIN && n <= CAPARSIZE_MAX);
353 for (i = 0; i < n; i++)
354 dst->cr_rights[i] |= src->cr_rights[i];
356 assert(cap_rights_is_valid(src));
357 assert(cap_rights_is_valid(dst));
363 cap_rights_remove(cap_rights_t *dst, const cap_rights_t *src)
367 assert(CAPVER(dst) == CAP_RIGHTS_VERSION_00);
368 assert(CAPVER(src) == CAP_RIGHTS_VERSION_00);
369 assert(CAPVER(dst) == CAPVER(src));
370 assert(cap_rights_is_valid(src));
371 assert(cap_rights_is_valid(dst));
374 assert(n >= CAPARSIZE_MIN && n <= CAPARSIZE_MAX);
376 for (i = 0; i < n; i++) {
378 ~(src->cr_rights[i] & 0x01FFFFFFFFFFFFFFULL);
381 assert(cap_rights_is_valid(src));
382 assert(cap_rights_is_valid(dst));
389 cap_rights_contains(const cap_rights_t *big, const cap_rights_t *little)
393 assert(CAPVER(big) == CAP_RIGHTS_VERSION_00);
394 assert(CAPVER(little) == CAP_RIGHTS_VERSION_00);
395 assert(CAPVER(big) == CAPVER(little));
398 assert(n >= CAPARSIZE_MIN && n <= CAPARSIZE_MAX);
400 for (i = 0; i < n; i++) {
401 if ((big->cr_rights[i] & little->cr_rights[i]) !=
402 little->cr_rights[i]) {