2 * Copyright (c) 2008-2011 Robert N. M. Watson
3 * Copyright (c) 2010-2011 Jonathan Anderson
4 * Copyright (c) 2012 FreeBSD Foundation
7 * This software was developed at the University of Cambridge Computer
8 * Laboratory with support from a grant from Google, Inc.
10 * Portions of this software were developed by Pawel Jakub Dawidek under
11 * sponsorship from the FreeBSD Foundation.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * FreeBSD kernel capability facility.
38 * Two kernel features are implemented here: capability mode, a sandboxed mode
39 * of execution for processes, and capabilities, a refinement on file
40 * descriptors that allows fine-grained control over operations on the file
41 * descriptor. Collectively, these allow processes to run in the style of a
42 * historic "capability system" in which they can use only resources
43 * explicitly delegated to them. This model is enforced by restricting access
44 * to global namespaces in capability mode.
46 * Capabilities wrap other file descriptor types, binding them to a constant
47 * rights mask set when the capability is created. New capabilities may be
48 * derived from existing capabilities, but only if they have the same or a
49 * strict subset of the rights on the original capability.
51 * System calls permitted in capability mode are defined in capabilities.conf;
52 * calls must be carefully audited for safety to ensure that they don't allow
53 * escape from a sandbox. Some calls permit only a subset of operations in
54 * capability mode -- for example, shm_open(2) is limited to creating
55 * anonymous, rather than named, POSIX shared memory objects.
58 #include <sys/cdefs.h>
59 __FBSDID("$FreeBSD$");
61 #include "opt_capsicum.h"
62 #include "opt_ktrace.h"
64 #include <sys/param.h>
65 #include <sys/capability.h>
67 #include <sys/filedesc.h>
68 #include <sys/kernel.h>
69 #include <sys/limits.h>
71 #include <sys/mutex.h>
73 #include <sys/syscallsubr.h>
74 #include <sys/sysproto.h>
75 #include <sys/sysctl.h>
76 #include <sys/systm.h>
77 #include <sys/ucred.h>
79 #include <sys/ktrace.h>
81 #include <security/audit/audit.h>
86 #ifdef CAPABILITY_MODE
88 FEATURE(security_capability_mode, "Capsicum Capability Mode");
91 * System call to enter capability mode for the process.
94 sys_cap_enter(struct thread *td, struct cap_enter_args *uap)
96 struct ucred *newcred, *oldcred;
99 if (IN_CAPABILITY_MODE(td))
105 oldcred = p->p_ucred;
106 crcopy(newcred, oldcred);
107 newcred->cr_flags |= CRED_FLAG_CAPMODE;
108 p->p_ucred = newcred;
115 * System call to query whether the process is in capability mode.
118 sys_cap_getmode(struct thread *td, struct cap_getmode_args *uap)
122 i = IN_CAPABILITY_MODE(td) ? 1 : 0;
123 return (copyout(&i, uap->modep, sizeof(i)));
126 #else /* !CAPABILITY_MODE */
129 sys_cap_enter(struct thread *td, struct cap_enter_args *uap)
136 sys_cap_getmode(struct thread *td, struct cap_getmode_args *uap)
142 #endif /* CAPABILITY_MODE */
146 FEATURE(security_capabilities, "Capsicum Capabilities");
148 MALLOC_DECLARE(M_FILECAPS);
151 _cap_check(const cap_rights_t *havep, const cap_rights_t *needp,
152 enum ktr_cap_fail_type type)
156 for (i = 0; i < nitems(havep->cr_rights); i++) {
157 if (!cap_rights_contains(havep, needp)) {
159 if (KTRPOINT(curthread, KTR_CAPFAIL))
160 ktrcapfail(type, needp, havep);
162 return (ENOTCAPABLE);
169 * Test whether a capability grants the requested rights.
172 cap_check(const cap_rights_t *havep, const cap_rights_t *needp)
175 return (_cap_check(havep, needp, CAPFAIL_NOTCAPABLE));
179 * Convert capability rights into VM access flags.
182 cap_rights_to_vmprot(cap_rights_t *havep)
186 maxprot = VM_PROT_NONE;
187 if (cap_rights_is_set(havep, CAP_MMAP_R))
188 maxprot |= VM_PROT_READ;
189 if (cap_rights_is_set(havep, CAP_MMAP_W))
190 maxprot |= VM_PROT_WRITE;
191 if (cap_rights_is_set(havep, CAP_MMAP_X))
192 maxprot |= VM_PROT_EXECUTE;
198 * Extract rights from a capability for monitoring purposes -- not for use in
199 * any other way, as we want to keep all capability permission evaluation in
203 cap_rights(struct filedesc *fdp, int fd)
206 return (&fdp->fd_ofiles[fd].fde_rights);
210 * System call to limit rights of the given capability.
213 sys_cap_rights_limit(struct thread *td, struct cap_rights_limit_args *uap)
215 struct filedesc *fdp;
217 int error, fd, version;
219 cap_rights_init(&rights);
221 error = copyin(uap->rightsp, &rights, sizeof(rights.cr_rights[0]));
224 version = CAPVER(&rights);
225 if (version != CAP_RIGHTS_VERSION_00)
228 error = copyin(uap->rightsp, &rights,
229 sizeof(rights.cr_rights[0]) * CAPARSIZE(&rights));
232 /* Check for race. */
233 if (CAPVER(&rights) != version)
236 if (!cap_rights_is_valid(&rights))
239 if (version != CAP_RIGHTS_VERSION) {
240 rights.cr_rights[0] &= ~(0x3ULL << 62);
241 rights.cr_rights[0] |= ((uint64_t)CAP_RIGHTS_VERSION << 62);
244 if (KTRPOINT(td, KTR_STRUCT))
245 ktrcaprights(&rights);
251 AUDIT_ARG_RIGHTS(&rights);
253 fdp = td->td_proc->p_fd;
255 if (fget_locked(fdp, fd) == NULL) {
256 FILEDESC_XUNLOCK(fdp);
259 error = _cap_check(cap_rights(fdp, fd), &rights, CAPFAIL_INCREASE);
261 fdp->fd_ofiles[fd].fde_rights = rights;
262 if (!cap_rights_is_set(&rights, CAP_IOCTL)) {
263 free(fdp->fd_ofiles[fd].fde_ioctls, M_FILECAPS);
264 fdp->fd_ofiles[fd].fde_ioctls = NULL;
265 fdp->fd_ofiles[fd].fde_nioctls = 0;
267 if (!cap_rights_is_set(&rights, CAP_FCNTL))
268 fdp->fd_ofiles[fd].fde_fcntls = 0;
270 FILEDESC_XUNLOCK(fdp);
275 * System call to query the rights mask associated with a capability.
278 sys___cap_rights_get(struct thread *td, struct __cap_rights_get_args *uap)
280 struct filedesc *fdp;
284 if (uap->version != CAP_RIGHTS_VERSION_00)
291 fdp = td->td_proc->p_fd;
293 if (fget_locked(fdp, fd) == NULL) {
294 FILEDESC_SUNLOCK(fdp);
297 rights = *cap_rights(fdp, fd);
298 FILEDESC_SUNLOCK(fdp);
299 n = uap->version + 2;
300 if (uap->version != CAPVER(&rights)) {
302 * For older versions we need to check if the descriptor
303 * doesn't contain rights not understood by the caller.
304 * If it does, we have to return an error.
306 for (i = n; i < CAPARSIZE(&rights); i++) {
307 if ((rights.cr_rights[i] & ~(0x7FULL << 57)) != 0)
311 error = copyout(&rights, uap->rightsp, sizeof(rights.cr_rights[0]) * n);
313 if (error == 0 && KTRPOINT(td, KTR_STRUCT))
314 ktrcaprights(&rights);
320 * Test whether a capability grants the given ioctl command.
321 * If descriptor doesn't have CAP_IOCTL, then ioctls list is empty and
322 * ENOTCAPABLE will be returned.
325 cap_ioctl_check(struct filedesc *fdp, int fd, u_long cmd)
331 FILEDESC_LOCK_ASSERT(fdp);
332 KASSERT(fd >= 0 && fd < fdp->fd_nfiles,
333 ("%s: invalid fd=%d", __func__, fd));
335 ncmds = fdp->fd_ofiles[fd].fde_nioctls;
339 cmds = fdp->fd_ofiles[fd].fde_ioctls;
340 for (i = 0; i < ncmds; i++) {
345 return (ENOTCAPABLE);
349 * Check if the current ioctls list can be replaced by the new one.
352 cap_ioctl_limit_check(struct filedesc *fdp, int fd, const u_long *cmds,
360 oncmds = fdp->fd_ofiles[fd].fde_nioctls;
363 if (oncmds < (ssize_t)ncmds)
364 return (ENOTCAPABLE);
366 ocmds = fdp->fd_ofiles[fd].fde_ioctls;
367 for (i = 0; i < ncmds; i++) {
368 for (j = 0; j < oncmds; j++) {
369 if (cmds[i] == ocmds[j])
373 return (ENOTCAPABLE);
380 kern_cap_ioctls_limit(struct thread *td, int fd, u_long *cmds, size_t ncmds)
382 struct filedesc *fdp;
388 fdp = td->td_proc->p_fd;
391 if (fget_locked(fdp, fd) == NULL) {
396 error = cap_ioctl_limit_check(fdp, fd, cmds, ncmds);
400 ocmds = fdp->fd_ofiles[fd].fde_ioctls;
401 fdp->fd_ofiles[fd].fde_ioctls = cmds;
402 fdp->fd_ofiles[fd].fde_nioctls = ncmds;
407 FILEDESC_XUNLOCK(fdp);
408 free(cmds, M_FILECAPS);
413 sys_cap_ioctls_limit(struct thread *td, struct cap_ioctls_limit_args *uap)
421 if (ncmds > 256) /* XXX: Is 256 sane? */
427 cmds = malloc(sizeof(cmds[0]) * ncmds, M_FILECAPS, M_WAITOK);
428 error = copyin(uap->cmds, cmds, sizeof(cmds[0]) * ncmds);
430 free(cmds, M_FILECAPS);
435 return (kern_cap_ioctls_limit(td, uap->fd, cmds, ncmds));
439 sys_cap_ioctls_get(struct thread *td, struct cap_ioctls_get_args *uap)
441 struct filedesc *fdp;
442 struct filedescent *fdep;
449 maxcmds = uap->maxcmds;
453 fdp = td->td_proc->p_fd;
456 if (fget_locked(fdp, fd) == NULL) {
462 * If all ioctls are allowed (fde_nioctls == -1 && fde_ioctls == NULL)
463 * the only sane thing we can do is to not populate the given array and
464 * return CAP_IOCTLS_ALL.
467 fdep = &fdp->fd_ofiles[fd];
468 if (cmds != NULL && fdep->fde_ioctls != NULL) {
469 error = copyout(fdep->fde_ioctls, cmds,
470 sizeof(cmds[0]) * MIN(fdep->fde_nioctls, maxcmds));
474 if (fdep->fde_nioctls == -1)
475 td->td_retval[0] = CAP_IOCTLS_ALL;
477 td->td_retval[0] = fdep->fde_nioctls;
481 FILEDESC_SUNLOCK(fdp);
486 * Test whether a capability grants the given fcntl command.
489 cap_fcntl_check(struct filedesc *fdp, int fd, int cmd)
493 KASSERT(fd >= 0 && fd < fdp->fd_nfiles,
494 ("%s: invalid fd=%d", __func__, fd));
496 fcntlcap = (1 << cmd);
497 KASSERT((CAP_FCNTL_ALL & fcntlcap) != 0,
498 ("Unsupported fcntl=%d.", cmd));
500 if ((fdp->fd_ofiles[fd].fde_fcntls & fcntlcap) != 0)
503 return (ENOTCAPABLE);
507 sys_cap_fcntls_limit(struct thread *td, struct cap_fcntls_limit_args *uap)
509 struct filedesc *fdp;
510 uint32_t fcntlrights;
514 fcntlrights = uap->fcntlrights;
517 AUDIT_ARG_FCNTL_RIGHTS(fcntlrights);
519 if ((fcntlrights & ~CAP_FCNTL_ALL) != 0)
522 fdp = td->td_proc->p_fd;
525 if (fget_locked(fdp, fd) == NULL) {
526 FILEDESC_XUNLOCK(fdp);
530 if ((fcntlrights & ~fdp->fd_ofiles[fd].fde_fcntls) != 0) {
531 FILEDESC_XUNLOCK(fdp);
532 return (ENOTCAPABLE);
535 fdp->fd_ofiles[fd].fde_fcntls = fcntlrights;
536 FILEDESC_XUNLOCK(fdp);
542 sys_cap_fcntls_get(struct thread *td, struct cap_fcntls_get_args *uap)
544 struct filedesc *fdp;
552 fdp = td->td_proc->p_fd;
554 if (fget_locked(fdp, fd) == NULL) {
555 FILEDESC_SUNLOCK(fdp);
558 rights = fdp->fd_ofiles[fd].fde_fcntls;
559 FILEDESC_SUNLOCK(fdp);
561 return (copyout(&rights, uap->fcntlrightsp, sizeof(rights)));
564 #else /* !CAPABILITIES */
567 * Stub Capability functions for when options CAPABILITIES isn't compiled
572 sys_cap_rights_limit(struct thread *td, struct cap_rights_limit_args *uap)
579 sys___cap_rights_get(struct thread *td, struct __cap_rights_get_args *uap)
586 sys_cap_ioctls_limit(struct thread *td, struct cap_ioctls_limit_args *uap)
593 sys_cap_ioctls_get(struct thread *td, struct cap_ioctls_get_args *uap)
600 sys_cap_fcntls_limit(struct thread *td, struct cap_fcntls_limit_args *uap)
607 sys_cap_fcntls_get(struct thread *td, struct cap_fcntls_get_args *uap)
613 #endif /* CAPABILITIES */