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
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_RENAMEAT_SOURCE
82 .Xr acl_valid_fd_np 3 .
85 .Xr acl_delete_fd_np 3 .
97 When not in capabilities mode, permit
106 Note that sockets can also become bound implicitly as a result of
110 and that socket options set with
112 may also affect binding behavior.
116 This right has to be present on the directory descriptor.
117 This right includes the
126 When not in capabilities mode, permit
135 This right is also required for
137 with a non-NULL destination address.
141 This right has to be present on the directory descriptor.
142 This right includes the
157 to be used in monitoring the file descriptor for events.
158 .It Dv CAP_EXTATTR_DELETE
160 .Xr extattr_delete_fd 2 .
161 .It Dv CAP_EXTATTR_GET
163 .Xr extattr_get_fd 2 .
164 .It Dv CAP_EXTATTR_LIST
166 .Xr extattr_list_fd 2 .
167 .It Dv CAP_EXTATTR_SET
169 .Xr extattr_set_fd 2 .
180 right is also present.
188 right is also present.
201 right is also present.
216 commands require this capability right.
217 Also note that the list of permitted commands can be further limited with the
218 .Xr cap_fcntls_limit 2
251 Permit UFS background-fsck operations on the descriptor.
259 right is also present.
299 right is also present.
305 .It Dv CAP_GETPEERNAME
308 .It Dv CAP_GETSOCKNAME
311 .It Dv CAP_GETSOCKOPT
317 Be aware that this system call has enormous scope, including potentially
318 global scope for some objects.
319 The list of permitted ioctl commands can be further limited with the
320 .Xr cap_ioctls_limit 2
324 .Dv CAP_KQUEUE_CHANGE
326 .Dv CAP_KQUEUE_EVENT .
327 .It Dv CAP_KQUEUE_CHANGE
332 descriptor that modifies list of monitored events (the
334 argument is non-NULL).
335 .It Dv CAP_KQUEUE_EVENT
340 descriptor that monitors events (the
342 argument is non-NULL).
344 is also required on file descriptors that will be monitored using
346 .It Dv CAP_LINKAT_SOURCE
349 on the source directory descriptor.
350 This right includes the
355 .Dv CAP_LINKAT_SOURCE
356 makes it possible to link files in a directory for which file
357 descriptors exist that have additional rights.
359 a file stored in a directory that does not allow
361 may be linked in another directory that does allow
363 thereby granting read access to a file that is otherwise unreadable.
364 .It Dv CAP_LINKAT_TARGET
367 on the target directory descriptor.
368 This right includes the
374 not much use (generally) without
377 Permit the file descriptor to be used as a starting directory for calls such as
391 This right includes the
397 This right includes the
403 This right includes the
418 This right includes the
445 This right includes the
461 This right includes the
501 is also required) and related system calls.
505 .It Dv CAP_RENAMEAT_SOURCE
508 on the source directory descriptor.
509 This right includes the
514 .Dv CAP_RENAMEAT_SOURCE
515 makes it possible to move files to a directory for which file
516 descriptors exist that have additional rights.
518 a file stored in a directory that does not allow
520 may be moved to another directory that does allow
522 thereby granting read access to a file that is otherwise unreadable.
523 .It Dv CAP_RENAMEAT_TARGET
526 on the target directory descriptor.
527 This right includes the
531 Permit operations that seek on the file descriptor, such as
533 but also required for I/O system calls that can read or write at any position
538 .It Dv CAP_SEM_GETVALUE
552 .It Dv CAP_SETSOCKOPT
555 this controls various aspects of socket behavior and may affect binding,
556 connecting, and other behaviors with global scope.
560 closing the socket will also generally shut down any connections on it.
564 This right includes the
568 Allow configuration of TTY hooks, such as
570 on the file descriptor.
576 This right is only required for
578 on the destination directory descriptor if the destination object already
579 exists and will be removed by the rename.
580 This right includes the
599 and related system calls.
602 with a non-NULL connection address,
609 flag, but without the
631 .Xr cap_fcntls_limit 2 ,
632 .Xr cap_ioctls_limit 2 ,
633 .Xr cap_rights_limit 2 ,
637 .Xr extattr_delete_fd 2 ,
638 .Xr extattr_get_fd 2 ,
639 .Xr extattr_list_fd 2 ,
640 .Xr extattr_set_fd 2 ,
699 .Xr acl_delete_fd_np 3 ,
701 .Xr acl_get_fd_np 3 ,
703 .Xr acl_set_fd_np 3 ,
704 .Xr acl_valid_fd_np 3 ,
714 Support for capabilities and capabilities mode was developed as part of the
719 This manual page was created by
720 .An Pawel Jakub Dawidek Aq Mt pawel@dawidek.net
721 under sponsorship from the FreeBSD Foundation based on the
724 .An Robert Watson Aq Mt rwatson@FreeBSD.org .