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 _LINUX_CAPABILITY_H
15#define _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
39typedef struct __user_cap_header_struct {
40 __u32 version;
41 int pid;
42} *cap_user_header_t;
43
44struct __user_cap_data_struct {
45 __u32 effective;
46 __u32 permitted;
47 __u32 inheritable;
48};
49typedef struct __user_cap_data_struct *cap_user_data_t;
50
51
52#define VFS_CAP_REVISION_MASK 0xFF000000
53#define VFS_CAP_REVISION_SHIFT 24
54#define VFS_CAP_FLAGS_MASK ~VFS_CAP_REVISION_MASK
55#define VFS_CAP_FLAGS_EFFECTIVE 0x000001
56
57#define VFS_CAP_REVISION_1 0x01000000
58#define VFS_CAP_U32_1 1
59#define XATTR_CAPS_SZ_1 (sizeof(__le32)*(1 + 2*VFS_CAP_U32_1))
60
61#define VFS_CAP_REVISION_2 0x02000000
62#define VFS_CAP_U32_2 2
63#define XATTR_CAPS_SZ_2 (sizeof(__le32)*(1 + 2*VFS_CAP_U32_2))
64
65#define VFS_CAP_REVISION_3 0x03000000
66#define VFS_CAP_U32_3 2
67#define XATTR_CAPS_SZ_3 (sizeof(__le32)*(2 + 2*VFS_CAP_U32_3))
68
69#define XATTR_CAPS_SZ XATTR_CAPS_SZ_3
70#define VFS_CAP_U32 VFS_CAP_U32_3
71#define VFS_CAP_REVISION VFS_CAP_REVISION_3
72
73struct vfs_cap_data {
74 __le32 magic_etc; /* Little endian */
75 struct {
76 __le32 permitted; /* Little endian */
77 __le32 inheritable; /* Little endian */
78 } data[VFS_CAP_U32];
79};
80
81/*
82 * same as vfs_cap_data but with a rootid at the end
83 */
84struct vfs_ns_cap_data {
85 __le32 magic_etc;
86 struct {
87 __le32 permitted; /* Little endian */
88 __le32 inheritable; /* Little endian */
89 } data[VFS_CAP_U32];
90 __le32 rootid;
91};
92
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
103
104/**
105 ** POSIX-draft defined capabilities.
106 **/
107
108/* In a system with the [_POSIX_CHOWN_RESTRICTED] option defined, this
109 overrides the restriction of changing file ownership and group
110 ownership. */
111
112#define CAP_CHOWN 0
113
114/* Override all DAC access, including ACL execute access if
115 [_POSIX_ACL] is defined. Excluding DAC access covered by
116 CAP_LINUX_IMMUTABLE. */
117
118#define CAP_DAC_OVERRIDE 1
119
120/* Overrides all DAC restrictions regarding read and search on files
121 and directories, including ACL restrictions if [_POSIX_ACL] is
122 defined. Excluding DAC access covered by CAP_LINUX_IMMUTABLE. */
123
124#define CAP_DAC_READ_SEARCH 2
125
126/* Overrides all restrictions about allowed operations on files, where
127 file owner ID must be equal to the user ID, except where CAP_FSETID
128 is applicable. It doesn't override MAC and DAC restrictions. */
129
130#define CAP_FOWNER 3
131
132/* Overrides the following restrictions that the effective user ID
133 shall match the file owner ID when setting the S_ISUID and S_ISGID
134 bits on that file; that the effective group ID (or one of the
135 supplementary group IDs) shall match the file owner ID when setting
136 the S_ISGID bit on that file; that the S_ISUID and S_ISGID bits are
137 cleared on successful return from chown(2) (not implemented). */
138
139#define CAP_FSETID 4
140
141/* Overrides the restriction that the real or effective user ID of a
142 process sending a signal must match the real or effective user ID
143 of the process receiving the signal. */
144
145#define CAP_KILL 5
146
147/* Allows setgid(2) manipulation */
148/* Allows setgroups(2) */
149/* Allows forged gids on socket credentials passing. */
150
151#define CAP_SETGID 6
152
153/* Allows set*uid(2) manipulation (including fsuid). */
154/* Allows forged pids on socket credentials passing. */
155
156#define CAP_SETUID 7
157
158
159/**
160 ** Linux-specific capabilities
161 **/
162
163/* Without VFS support for capabilities:
164 * Transfer any capability in your permitted set to any pid,
165 * remove any capability in your permitted set from any pid
166 * With VFS support for capabilities (neither of above, but)
167 * Add any capability from current's capability bounding set
168 * to the current process' inheritable set
169 * Allow taking bits out of capability bounding set
170 * Allow modification of the securebits for a process
171 */
172
173#define CAP_SETPCAP 8
174
175/* Allow modification of S_IMMUTABLE and S_APPEND file attributes */
176
177#define CAP_LINUX_IMMUTABLE 9
178
179/* Allows binding to TCP/UDP sockets below 1024 */
180/* Allows binding to ATM VCIs below 32 */
181
182#define CAP_NET_BIND_SERVICE 10
183
184/* Allow broadcasting, listen to multicast */
185
186#define CAP_NET_BROADCAST 11
187
188/* Allow interface configuration */
189/* Allow administration of IP firewall, masquerading and accounting */
190/* Allow setting debug option on sockets */
191/* Allow modification of routing tables */
192/* Allow setting arbitrary process / process group ownership on
193 sockets */
194/* Allow binding to any address for transparent proxying (also via NET_RAW) */
195/* Allow setting TOS (type of service) */
196/* Allow setting promiscuous mode */
197/* Allow clearing driver statistics */
198/* Allow multicasting */
199/* Allow read/write of device-specific registers */
200/* Allow activation of ATM control sockets */
201
202#define CAP_NET_ADMIN 12
203
204/* Allow use of RAW sockets */
205/* Allow use of PACKET sockets */
206/* Allow binding to any address for transparent proxying (also via NET_ADMIN) */
207
208#define CAP_NET_RAW 13
209
210/* Allow locking of shared memory segments */
211/* Allow mlock and mlockall (which doesn't really have anything to do
212 with IPC) */
213
214#define CAP_IPC_LOCK 14
215
216/* Override IPC ownership checks */
217
218#define CAP_IPC_OWNER 15
219
220/* Insert and remove kernel modules - modify kernel without limit */
221#define CAP_SYS_MODULE 16
222
223/* Allow ioperm/iopl access */
224/* Allow sending USB messages to any device via /dev/bus/usb */
225
226#define CAP_SYS_RAWIO 17
227
228/* Allow use of chroot() */
229
230#define CAP_SYS_CHROOT 18
231
232/* Allow ptrace() of any process */
233
234#define CAP_SYS_PTRACE 19
235
236/* Allow configuration of process accounting */
237
238#define CAP_SYS_PACCT 20
239
240/* Allow configuration of the secure attention key */
241/* Allow administration of the random device */
242/* Allow examination and configuration of disk quotas */
243/* Allow setting the domainname */
244/* Allow setting the hostname */
245/* Allow mount() and umount(), setting up new smb connection */
246/* Allow some autofs root ioctls */
247/* Allow nfsservctl */
248/* Allow VM86_REQUEST_IRQ */
249/* Allow to read/write pci config on alpha */
250/* Allow irix_prctl on mips (setstacksize) */
251/* Allow flushing all cache on m68k (sys_cacheflush) */
252/* Allow removing semaphores */
253/* Used instead of CAP_CHOWN to "chown" IPC message queues, semaphores
254 and shared memory */
255/* Allow locking/unlocking of shared memory segment */
256/* Allow turning swap on/off */
257/* Allow forged pids on socket credentials passing */
258/* Allow setting readahead and flushing buffers on block devices */
259/* Allow setting geometry in floppy driver */
260/* Allow turning DMA on/off in xd driver */
261/* Allow administration of md devices (mostly the above, but some
262 extra ioctls) */
263/* Allow tuning the ide driver */
264/* Allow access to the nvram device */
265/* Allow administration of apm_bios, serial and bttv (TV) device */
266/* Allow manufacturer commands in isdn CAPI support driver */
267/* Allow reading non-standardized portions of pci configuration space */
268/* Allow DDI debug ioctl on sbpcd driver */
269/* Allow setting up serial ports */
270/* Allow sending raw qic-117 commands */
271/* Allow enabling/disabling tagged queuing on SCSI controllers and sending
272 arbitrary SCSI commands */
273/* Allow setting encryption key on loopback filesystem */
274/* Allow setting zone reclaim policy */
275/* Allow everything under CAP_BPF and CAP_PERFMON for backward compatibility */
276
277#define CAP_SYS_ADMIN 21
278
279/* Allow use of reboot() */
280
281#define CAP_SYS_BOOT 22
282
283/* Allow raising priority and setting priority on other (different
284 UID) processes */
285/* Allow use of FIFO and round-robin (realtime) scheduling on own
286 processes and setting the scheduling algorithm used by another
287 process. */
288/* Allow setting cpu affinity on other processes */
289/* Allow setting realtime ioprio class */
290/* Allow setting ioprio class 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 /* _LINUX_CAPABILITY_H */
432