xref: /freebsd/sys/sys/caprights.h (revision 95ee2897)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2013 FreeBSD Foundation
5  *
6  * This software was developed by Pawel Jakub Dawidek under sponsorship from
7  * the FreeBSD Foundation.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
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.
17  *
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
28  * SUCH DAMAGE.
29  */
30 
31 #ifndef _SYS_CAPRIGHTS_H_
32 #define	_SYS_CAPRIGHTS_H_
33 
34 /*
35  * The top two bits in the first element of the cr_rights[] array contain
36  * total number of elements in the array - 2. This means if those two bits are
37  * equal to 0, we have 2 array elements.
38  * The top two bits in all remaining array elements should be 0.
39  * The next five bits contain array index. Only one bit is used and bit position
40  * in this five-bits range defines array index. This means there can be at most
41  * five array elements.
42  */
43 #define	CAP_RIGHTS_VERSION_00	0
44 /*
45 #define	CAP_RIGHTS_VERSION_01	1
46 #define	CAP_RIGHTS_VERSION_02	2
47 #define	CAP_RIGHTS_VERSION_03	3
48 */
49 #define	CAP_RIGHTS_VERSION	CAP_RIGHTS_VERSION_00
50 
51 struct cap_rights {
52 	uint64_t	cr_rights[CAP_RIGHTS_VERSION + 2];
53 };
54 
55 #ifndef	_CAP_RIGHTS_T_DECLARED
56 #define	_CAP_RIGHTS_T_DECLARED
57 typedef	struct cap_rights	cap_rights_t;
58 #endif
59 
60 #ifdef _KERNEL
61 extern cap_rights_t cap_accept_rights;
62 extern cap_rights_t cap_bind_rights;
63 extern cap_rights_t cap_connect_rights;
64 extern cap_rights_t cap_event_rights;
65 extern cap_rights_t cap_fchdir_rights;
66 extern cap_rights_t cap_fchflags_rights;
67 extern cap_rights_t cap_fchmod_rights;
68 extern cap_rights_t cap_fchown_rights;
69 extern cap_rights_t cap_fcntl_rights;
70 extern cap_rights_t cap_fexecve_rights;
71 extern cap_rights_t cap_flock_rights;
72 extern cap_rights_t cap_fpathconf_rights;
73 extern cap_rights_t cap_fstat_rights;
74 extern cap_rights_t cap_fstatfs_rights;
75 extern cap_rights_t cap_fsync_rights;
76 extern cap_rights_t cap_ftruncate_rights;
77 extern cap_rights_t cap_futimes_rights;
78 extern cap_rights_t cap_getpeername_rights;
79 extern cap_rights_t cap_getsockopt_rights;
80 extern cap_rights_t cap_getsockname_rights;
81 extern cap_rights_t cap_ioctl_rights;
82 extern cap_rights_t cap_linkat_source_rights;
83 extern cap_rights_t cap_linkat_target_rights;
84 extern cap_rights_t cap_listen_rights;
85 extern cap_rights_t cap_mkdirat_rights;
86 extern cap_rights_t cap_mkfifoat_rights;
87 extern cap_rights_t cap_mknodat_rights;
88 extern cap_rights_t cap_mmap_rights;
89 extern cap_rights_t cap_no_rights;
90 extern cap_rights_t cap_pdgetpid_rights;
91 extern cap_rights_t cap_pdkill_rights;
92 extern cap_rights_t cap_pread_rights;
93 extern cap_rights_t cap_pwrite_rights;
94 extern cap_rights_t cap_read_rights;
95 extern cap_rights_t cap_recv_rights;
96 extern cap_rights_t cap_renameat_source_rights;
97 extern cap_rights_t cap_renameat_target_rights;
98 extern cap_rights_t cap_seek_rights;
99 extern cap_rights_t cap_send_rights;
100 extern cap_rights_t cap_send_connect_rights;
101 extern cap_rights_t cap_setsockopt_rights;
102 extern cap_rights_t cap_shutdown_rights;
103 extern cap_rights_t cap_symlinkat_rights;
104 extern cap_rights_t cap_unlinkat_rights;
105 extern cap_rights_t cap_write_rights;
106 #endif
107 
108 #endif /* !_SYS_CAPRIGHTS_H_ */
109