2 .\" Copyright (c) 2008-2010 Robert N. M. Watson
3 .\" Copyright (c) 2012-2013 The FreeBSD Foundation
4 .\" All rights reserved.
6 .\" This software was developed at the University of Cambridge Computer
7 .\" Laboratory with support from a grant from Google, Inc.
9 .\" Portions of this documentation were written by Pawel Jakub Dawidek
10 .\" under sponsorship from the FreeBSD Foundation.
12 .\" Redistribution and use in source and binary forms, with or without
13 .\" modification, are permitted provided that the following conditions
15 .\" 1. Redistributions of source code must retain the above copyright
16 .\" notice, this list of conditions and the following disclaimer.
17 .\" 2. Redistributions in binary form must reproduce the above copyright
18 .\" notice, this list of conditions and the following disclaimer in the
19 .\" documentation and/or other materials provided with the distribution.
21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Dd September 23, 2013
40 .Nd Capsicum capability rights for file descriptors
42 When a file descriptor is created by a function such as
56 it is assigned all capability rights.
57 Those rights can be reduced (but never expanded) by using the
58 .Xr cap_rights_limit 2 ,
59 .Xr cap_fcntls_limit 2 and
60 .Xr cap_ioctls_limit 2
62 Once capability rights are reduced, operations on the file descriptor will be
63 limited to those permitted by rights.
65 The complete list of capability rights is provided below.
68 type is used to store list of capability rights.
71 family of functions should be used to manage the structure.
73 The following rights may be specified in a rights mask:
74 .Bl -tag -width CAP_EXTATTR_DELETE
82 .Xr acl_valid_fd_np 3 .
85 .Xr acl_delete_fd_np 3 .
99 Note that sockets can also become bound implicitly as a result of
103 and that socket options set with
105 may also affect binding behavior.
109 This right has to be present on the directory descriptor.
110 This right includes the
123 with a non-NULL destination address.
127 This right has to be present on the directory descriptor.
128 This right includes the
143 to be used in monitoring the file descriptor for events.
144 .It Dv CAP_EXTATTR_DELETE
146 .Xr extattr_delete_fd 2 .
147 .It Dv CAP_EXTATTR_GET
149 .Xr extattr_get_fd 2 .
150 .It Dv CAP_EXTATTR_LIST
152 .Xr extattr_list_fd 2 .
153 .It Dv CAP_EXTATTR_SET
155 .Xr extattr_set_fd 2 .
166 right is also present.
174 right is also present.
187 right is also present.
202 commands require this capability right.
203 Also note that the list of permitted commands can be further limited with the
204 .Xr cap_fcntls_limit 2
237 Permit UFS background-fsck operations on the descriptor.
245 right is also present.
280 right is also present.
286 .It Dv CAP_GETPEERNAME
289 .It Dv CAP_GETSOCKNAME
292 .It Dv CAP_GETSOCKOPT
298 Be aware that this system call has enormous scope, including potentially
299 global scope for some objects.
300 The list of permitted ioctl commands can be further limited with the
301 .Xr cap_ioctls_limit 2
305 .Dv CAP_KQUEUE_CHANGE
307 .Dv CAP_KQUEUE_EVENT .
308 .It Dv CAP_KQUEUE_CHANGE
313 descriptor that modifies list of monitored events (the
315 argument is non-NULL).
316 .It Dv CAP_KQUEUE_EVENT
321 descriptor that monitors events (the
323 argument is non-NULL).
325 is also required on file descriptors that will be monitored using
332 on the destination directory descriptor.
333 This right includes the
339 not much use (generally) without
342 Permit the file descriptor to be used as a starting directory for calls such as
356 This right includes the
362 This right includes the
368 This right includes the
383 This right includes the
410 This right includes the
426 This right includes the
469 is also required) and related system calls.
476 This right is required on the source directory descriptor.
477 This right includes the
481 Permit operations that seek on the file descriptor, such as
483 but also required for I/O system calls that can read or write at any position
488 .It Dv CAP_SEM_GETVALUE
502 .It Dv CAP_SETSOCKOPT
505 this controls various aspects of socket behavior and may affect binding,
506 connecting, and other behaviors with global scope.
510 closing the socket will also generally shut down any connections on it.
514 This right includes the
518 Allow configuration of TTY hooks, such as
520 on the file descriptor.
526 This right is only required for
528 on the destination directory descriptor if the destination object already
529 exists and will be removed by the rename.
530 This right includes the
549 and related system calls.
552 with a non-NULL connection address,
559 flag, but without the
581 .Xr cap_fcntls_limit 2 ,
582 .Xr cap_ioctls_limit 2 ,
583 .Xr cap_rights_limit 2 ,
587 .Xr extattr_delete_fd 2 ,
588 .Xr extattr_get_fd 2 ,
589 .Xr extattr_list_fd 2 ,
590 .Xr extattr_set_fd 2 ,
649 .Xr acl_delete_fd_np 3 ,
651 .Xr acl_get_fd_np 3 ,
653 .Xr acl_set_fd_np 3 ,
654 .Xr acl_valid_fd_np 3 ,
664 Support for capabilities and capabilities mode was developed as part of the
669 This manual page was created by
670 .An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net
671 under sponsorship from the FreeBSD Foundation based on the
674 .An Robert Watson Aq Mt rwatson@FreeBSD.org .