• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2 /*
3  * This is <linux/capability.h>
4  *
5  * Andrew G. Morgan <morgan@kernel.org>
6  * Alexander Kjeldaas <astor@guardian.no>
7  * with help from Aleph1, Roland Buresund and Andrew Main.
8  *
9  * See here for the libcap library ("POSIX draft" compliance):
10  *
11  * ftp://www.kernel.org/pub/linux/libs/security/linux-privs/kernel-2.6/
12  */
13 
14 #ifndef _UAPI_LINUX_CAPABILITY_H
15 #define _UAPI_LINUX_CAPABILITY_H
16 
17 #include <linux/types.h>
18 
19 /* User-level do most of the mapping between kernel and user
20    capabilities based on the version tag given by the kernel. The
21    kernel might be somewhat backwards compatible, but don't bet on
22    it. */
23 
24 /* Note, cap_t, is defined by POSIX (draft) to be an "opaque" pointer to
25    a set of three capability sets.  The transposition of 3*the
26    following structure to such a composite is better handled in a user
27    library since the draft standard requires the use of malloc/free
28    etc.. */
29 
30 #define _LINUX_CAPABILITY_VERSION_1  0x19980330
31 #define _LINUX_CAPABILITY_U32S_1     1
32 
33 #define _LINUX_CAPABILITY_VERSION_2  0x20071026  /* deprecated - use v3 */
34 #define _LINUX_CAPABILITY_U32S_2     2
35 
36 #define _LINUX_CAPABILITY_VERSION_3  0x20080522
37 #define _LINUX_CAPABILITY_U32S_3     2
38 
39 typedef struct __user_cap_header_struct {
40 	__u32 version;
41 	int pid;
42 } __user *cap_user_header_t;
43 
44 typedef struct __user_cap_data_struct {
45         __u32 effective;
46         __u32 permitted;
47         __u32 inheritable;
48 } __user *cap_user_data_t;
49 
50 
51 #define VFS_CAP_REVISION_MASK	0xFF000000
52 #define VFS_CAP_REVISION_SHIFT	24
53 #define VFS_CAP_FLAGS_MASK	~VFS_CAP_REVISION_MASK
54 #define VFS_CAP_FLAGS_EFFECTIVE	0x000001
55 
56 #define VFS_CAP_REVISION_1	0x01000000
57 #define VFS_CAP_U32_1           1
58 #define XATTR_CAPS_SZ_1         (sizeof(__le32)*(1 + 2*VFS_CAP_U32_1))
59 
60 #define VFS_CAP_REVISION_2	0x02000000
61 #define VFS_CAP_U32_2           2
62 #define XATTR_CAPS_SZ_2         (sizeof(__le32)*(1 + 2*VFS_CAP_U32_2))
63 
64 #define VFS_CAP_REVISION_3	0x03000000
65 #define VFS_CAP_U32_3           2
66 #define XATTR_CAPS_SZ_3         (sizeof(__le32)*(2 + 2*VFS_CAP_U32_3))
67 
68 #define XATTR_CAPS_SZ           XATTR_CAPS_SZ_3
69 #define VFS_CAP_U32             VFS_CAP_U32_3
70 #define VFS_CAP_REVISION	VFS_CAP_REVISION_3
71 
72 struct vfs_cap_data {
73 	__le32 magic_etc;            /* Little endian */
74 	struct {
75 		__le32 permitted;    /* Little endian */
76 		__le32 inheritable;  /* Little endian */
77 	} data[VFS_CAP_U32];
78 };
79 
80 /*
81  * same as vfs_cap_data but with a rootid at the end
82  */
83 struct vfs_ns_cap_data {
84 	__le32 magic_etc;
85 	struct {
86 		__le32 permitted;    /* Little endian */
87 		__le32 inheritable;  /* Little endian */
88 	} data[VFS_CAP_U32];
89 	__le32 rootid;
90 };
91 
92 #ifndef __KERNEL__
93 
94 /*
95  * Backwardly compatible definition for source code - trapped in a
96  * 32-bit world. If you find you need this, please consider using
97  * libcap to untrap yourself...
98  */
99 #define _LINUX_CAPABILITY_VERSION  _LINUX_CAPABILITY_VERSION_1
100 #define _LINUX_CAPABILITY_U32S     _LINUX_CAPABILITY_U32S_1
101 
102 #endif
103 
104 
105 /**
106  ** POSIX-draft defined capabilities.
107  **/
108 
109 /* In a system with the [_POSIX_CHOWN_RESTRICTED] option defined, this
110    overrides the restriction of changing file ownership and group
111    ownership. */
112 
113 #define CAP_CHOWN            0
114 
115 /* Override all DAC access, including ACL execute access if
116    [_POSIX_ACL] is defined. Excluding DAC access covered by
117    CAP_LINUX_IMMUTABLE. */
118 
119 #define CAP_DAC_OVERRIDE     1
120 
121 /* Overrides all DAC restrictions regarding read and search on files
122    and directories, including ACL restrictions if [_POSIX_ACL] is
123    defined. Excluding DAC access covered by CAP_LINUX_IMMUTABLE. */
124 
125 #define CAP_DAC_READ_SEARCH  2
126 
127 /* Overrides all restrictions about allowed operations on files, where
128    file owner ID must be equal to the user ID, except where CAP_FSETID
129    is applicable. It doesn't override MAC and DAC restrictions. */
130 
131 #define CAP_FOWNER           3
132 
133 /* Overrides the following restrictions that the effective user ID
134    shall match the file owner ID when setting the S_ISUID and S_ISGID
135    bits on that file; that the effective group ID (or one of the
136    supplementary group IDs) shall match the file owner ID when setting
137    the S_ISGID bit on that file; that the S_ISUID and S_ISGID bits are
138    cleared on successful return from chown(2) (not implemented). */
139 
140 #define CAP_FSETID           4
141 
142 /* Overrides the restriction that the real or effective user ID of a
143    process sending a signal must match the real or effective user ID
144    of the process receiving the signal. */
145 
146 #define CAP_KILL             5
147 
148 /* Allows setgid(2) manipulation */
149 /* Allows setgroups(2) */
150 /* Allows forged gids on socket credentials passing. */
151 
152 #define CAP_SETGID           6
153 
154 /* Allows set*uid(2) manipulation (including fsuid). */
155 /* Allows forged pids on socket credentials passing. */
156 
157 #define CAP_SETUID           7
158 
159 
160 /**
161  ** Linux-specific capabilities
162  **/
163 
164 /* Without VFS support for capabilities:
165  *   Transfer any capability in your permitted set to any pid,
166  *   remove any capability in your permitted set from any pid
167  * With VFS support for capabilities (neither of above, but)
168  *   Add any capability from current's capability bounding set
169  *       to the current process' inheritable set
170  *   Allow taking bits out of capability bounding set
171  *   Allow modification of the securebits for a process
172  */
173 
174 #define CAP_SETPCAP          8
175 
176 /* Allow modification of S_IMMUTABLE and S_APPEND file attributes */
177 
178 #define CAP_LINUX_IMMUTABLE  9
179 
180 /* Allows binding to TCP/UDP sockets below 1024 */
181 /* Allows binding to ATM VCIs below 32 */
182 
183 #define CAP_NET_BIND_SERVICE 10
184 
185 /* Allow broadcasting, listen to multicast */
186 
187 #define CAP_NET_BROADCAST    11
188 
189 /* Allow interface configuration */
190 /* Allow administration of IP firewall, masquerading and accounting */
191 /* Allow setting debug option on sockets */
192 /* Allow modification of routing tables */
193 /* Allow setting arbitrary process / process group ownership on
194    sockets */
195 /* Allow binding to any address for transparent proxying (also via NET_RAW) */
196 /* Allow setting TOS (type of service) */
197 /* Allow setting promiscuous mode */
198 /* Allow clearing driver statistics */
199 /* Allow multicasting */
200 /* Allow read/write of device-specific registers */
201 /* Allow activation of ATM control sockets */
202 
203 #define CAP_NET_ADMIN        12
204 
205 /* Allow use of RAW sockets */
206 /* Allow use of PACKET sockets */
207 /* Allow binding to any address for transparent proxying (also via NET_ADMIN) */
208 
209 #define CAP_NET_RAW          13
210 
211 /* Allow locking of shared memory segments */
212 /* Allow mlock and mlockall (which doesn't really have anything to do
213    with IPC) */
214 
215 #define CAP_IPC_LOCK         14
216 
217 /* Override IPC ownership checks */
218 
219 #define CAP_IPC_OWNER        15
220 
221 /* Insert and remove kernel modules - modify kernel without limit */
222 #define CAP_SYS_MODULE       16
223 
224 /* Allow ioperm/iopl access */
225 /* Allow sending USB messages to any device via /dev/bus/usb */
226 
227 #define CAP_SYS_RAWIO        17
228 
229 /* Allow use of chroot() */
230 
231 #define CAP_SYS_CHROOT       18
232 
233 /* Allow ptrace() of any process */
234 
235 #define CAP_SYS_PTRACE       19
236 
237 /* Allow configuration of process accounting */
238 
239 #define CAP_SYS_PACCT        20
240 
241 /* Allow configuration of the secure attention key */
242 /* Allow administration of the random device */
243 /* Allow examination and configuration of disk quotas */
244 /* Allow setting the domainname */
245 /* Allow setting the hostname */
246 /* Allow calling bdflush() */
247 /* Allow mount() and umount(), setting up new smb connection */
248 /* Allow some autofs root ioctls */
249 /* Allow nfsservctl */
250 /* Allow VM86_REQUEST_IRQ */
251 /* Allow to read/write pci config on alpha */
252 /* Allow irix_prctl on mips (setstacksize) */
253 /* Allow flushing all cache on m68k (sys_cacheflush) */
254 /* Allow removing semaphores */
255 /* Used instead of CAP_CHOWN to "chown" IPC message queues, semaphores
256    and shared memory */
257 /* Allow locking/unlocking of shared memory segment */
258 /* Allow turning swap on/off */
259 /* Allow forged pids on socket credentials passing */
260 /* Allow setting readahead and flushing buffers on block devices */
261 /* Allow setting geometry in floppy driver */
262 /* Allow turning DMA on/off in xd driver */
263 /* Allow administration of md devices (mostly the above, but some
264    extra ioctls) */
265 /* Allow tuning the ide driver */
266 /* Allow access to the nvram device */
267 /* Allow administration of apm_bios, serial and bttv (TV) device */
268 /* Allow manufacturer commands in isdn CAPI support driver */
269 /* Allow reading non-standardized portions of pci configuration space */
270 /* Allow DDI debug ioctl on sbpcd driver */
271 /* Allow setting up serial ports */
272 /* Allow sending raw qic-117 commands */
273 /* Allow enabling/disabling tagged queuing on SCSI controllers and sending
274    arbitrary SCSI commands */
275 /* Allow setting encryption key on loopback filesystem */
276 /* Allow setting zone reclaim policy */
277 /* Allow everything under CAP_BPF and CAP_PERFMON for backward compatibility */
278 
279 #define CAP_SYS_ADMIN        21
280 
281 /* Allow use of reboot() */
282 
283 #define CAP_SYS_BOOT         22
284 
285 /* Allow raising priority and setting priority on other (different
286    UID) processes */
287 /* Allow use of FIFO and round-robin (realtime) scheduling on own
288    processes and setting the scheduling algorithm used by another
289    process. */
290 /* Allow setting cpu affinity on other processes */
291 
292 #define CAP_SYS_NICE         23
293 
294 /* Override resource limits. Set resource limits. */
295 /* Override quota limits. */
296 /* Override reserved space on ext2 filesystem */
297 /* Modify data journaling mode on ext3 filesystem (uses journaling
298    resources) */
299 /* NOTE: ext2 honors fsuid when checking for resource overrides, so
300    you can override using fsuid too */
301 /* Override size restrictions on IPC message queues */
302 /* Allow more than 64hz interrupts from the real-time clock */
303 /* Override max number of consoles on console allocation */
304 /* Override max number of keymaps */
305 /* Control memory reclaim behavior */
306 
307 #define CAP_SYS_RESOURCE     24
308 
309 /* Allow manipulation of system clock */
310 /* Allow irix_stime on mips */
311 /* Allow setting the real-time clock */
312 
313 #define CAP_SYS_TIME         25
314 
315 /* Allow configuration of tty devices */
316 /* Allow vhangup() of tty */
317 
318 #define CAP_SYS_TTY_CONFIG   26
319 
320 /* Allow the privileged aspects of mknod() */
321 
322 #define CAP_MKNOD            27
323 
324 /* Allow taking of leases on files */
325 
326 #define CAP_LEASE            28
327 
328 /* Allow writing the audit log via unicast netlink socket */
329 
330 #define CAP_AUDIT_WRITE      29
331 
332 /* Allow configuration of audit via unicast netlink socket */
333 
334 #define CAP_AUDIT_CONTROL    30
335 
336 /* Set or remove capabilities on files.
337    Map uid=0 into a child user namespace. */
338 
339 #define CAP_SETFCAP	     31
340 
341 /* Override MAC access.
342    The base kernel enforces no MAC policy.
343    An LSM may enforce a MAC policy, and if it does and it chooses
344    to implement capability based overrides of that policy, this is
345    the capability it should use to do so. */
346 
347 #define CAP_MAC_OVERRIDE     32
348 
349 /* Allow MAC configuration or state changes.
350    The base kernel requires no MAC configuration.
351    An LSM may enforce a MAC policy, and if it does and it chooses
352    to implement capability based checks on modifications to that
353    policy or the data required to maintain it, this is the
354    capability it should use to do so. */
355 
356 #define CAP_MAC_ADMIN        33
357 
358 /* Allow configuring the kernel's syslog (printk behaviour) */
359 
360 #define CAP_SYSLOG           34
361 
362 /* Allow triggering something that will wake the system */
363 
364 #define CAP_WAKE_ALARM            35
365 
366 /* Allow preventing system suspends */
367 
368 #define CAP_BLOCK_SUSPEND    36
369 
370 /* Allow reading the audit log via multicast netlink socket */
371 
372 #define CAP_AUDIT_READ		37
373 
374 /*
375  * Allow system performance and observability privileged operations
376  * using perf_events, i915_perf and other kernel subsystems
377  */
378 
379 #define CAP_PERFMON		38
380 
381 /*
382  * CAP_BPF allows the following BPF operations:
383  * - Creating all types of BPF maps
384  * - Advanced verifier features
385  *   - Indirect variable access
386  *   - Bounded loops
387  *   - BPF to BPF function calls
388  *   - Scalar precision tracking
389  *   - Larger complexity limits
390  *   - Dead code elimination
391  *   - And potentially other features
392  * - Loading BPF Type Format (BTF) data
393  * - Retrieve xlated and JITed code of BPF programs
394  * - Use bpf_spin_lock() helper
395  *
396  * CAP_PERFMON relaxes the verifier checks further:
397  * - BPF progs can use of pointer-to-integer conversions
398  * - speculation attack hardening measures are bypassed
399  * - bpf_probe_read to read arbitrary kernel memory is allowed
400  * - bpf_trace_printk to print kernel memory is allowed
401  *
402  * CAP_SYS_ADMIN is required to use bpf_probe_write_user.
403  *
404  * CAP_SYS_ADMIN is required to iterate system wide loaded
405  * programs, maps, links, BTFs and convert their IDs to file descriptors.
406  *
407  * CAP_PERFMON and CAP_BPF are required to load tracing programs.
408  * CAP_NET_ADMIN and CAP_BPF are required to load networking programs.
409  */
410 #define CAP_BPF			39
411 
412 
413 /* Allow checkpoint/restore related operations */
414 /* Allow PID selection during clone3() */
415 /* Allow writing to ns_last_pid */
416 
417 #define CAP_CHECKPOINT_RESTORE	40
418 
419 #define CAP_LAST_CAP         CAP_CHECKPOINT_RESTORE
420 
421 #define cap_valid(x) ((x) >= 0 && (x) <= CAP_LAST_CAP)
422 
423 /*
424  * Bit location of each capability (used by user-space library and kernel)
425  */
426 
427 #define CAP_TO_INDEX(x)     ((x) >> 5)        /* 1 << 5 == bits in __u32 */
428 #define CAP_TO_MASK(x)      (1U << ((x) & 31)) /* mask for indexed __u32 */
429 
430 
431 #endif /* _UAPI_LINUX_CAPABILITY_H */
432