xref: /aosp_15_r20/external/kernel-headers/original/uapi/linux/seccomp.h (revision f80ad8b4341604f5951dab671d41019a6d7087ce)
1*f80ad8b4SAndroid Build Coastguard Worker /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2*f80ad8b4SAndroid Build Coastguard Worker #ifndef _UAPI_LINUX_SECCOMP_H
3*f80ad8b4SAndroid Build Coastguard Worker #define _UAPI_LINUX_SECCOMP_H
4*f80ad8b4SAndroid Build Coastguard Worker 
5*f80ad8b4SAndroid Build Coastguard Worker #include <linux/compiler.h>
6*f80ad8b4SAndroid Build Coastguard Worker #include <linux/types.h>
7*f80ad8b4SAndroid Build Coastguard Worker 
8*f80ad8b4SAndroid Build Coastguard Worker 
9*f80ad8b4SAndroid Build Coastguard Worker /* Valid values for seccomp.mode and prctl(PR_SET_SECCOMP, <mode>) */
10*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_MODE_DISABLED	0 /* seccomp is not in use. */
11*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_MODE_STRICT	1 /* uses hard-coded filter. */
12*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_MODE_FILTER	2 /* uses user-supplied filter. */
13*f80ad8b4SAndroid Build Coastguard Worker 
14*f80ad8b4SAndroid Build Coastguard Worker /* Valid operations for seccomp syscall. */
15*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_SET_MODE_STRICT		0
16*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_SET_MODE_FILTER		1
17*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_GET_ACTION_AVAIL	2
18*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_GET_NOTIF_SIZES		3
19*f80ad8b4SAndroid Build Coastguard Worker 
20*f80ad8b4SAndroid Build Coastguard Worker /* Valid flags for SECCOMP_SET_MODE_FILTER */
21*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_FILTER_FLAG_TSYNC		(1UL << 0)
22*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_FILTER_FLAG_LOG			(1UL << 1)
23*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_FILTER_FLAG_SPEC_ALLOW		(1UL << 2)
24*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_FILTER_FLAG_NEW_LISTENER	(1UL << 3)
25*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_FILTER_FLAG_TSYNC_ESRCH		(1UL << 4)
26*f80ad8b4SAndroid Build Coastguard Worker /* Received notifications wait in killable state (only respond to fatal signals) */
27*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_FILTER_FLAG_WAIT_KILLABLE_RECV	(1UL << 5)
28*f80ad8b4SAndroid Build Coastguard Worker 
29*f80ad8b4SAndroid Build Coastguard Worker /*
30*f80ad8b4SAndroid Build Coastguard Worker  * All BPF programs must return a 32-bit value.
31*f80ad8b4SAndroid Build Coastguard Worker  * The bottom 16-bits are for optional return data.
32*f80ad8b4SAndroid Build Coastguard Worker  * The upper 16-bits are ordered from least permissive values to most,
33*f80ad8b4SAndroid Build Coastguard Worker  * as a signed value (so 0x8000000 is negative).
34*f80ad8b4SAndroid Build Coastguard Worker  *
35*f80ad8b4SAndroid Build Coastguard Worker  * The ordering ensures that a min_t() over composed return values always
36*f80ad8b4SAndroid Build Coastguard Worker  * selects the least permissive choice.
37*f80ad8b4SAndroid Build Coastguard Worker  */
38*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_KILL_PROCESS 0x80000000U /* kill the process */
39*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_KILL_THREAD	 0x00000000U /* kill the thread */
40*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_KILL	 SECCOMP_RET_KILL_THREAD
41*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_TRAP	 0x00030000U /* disallow and force a SIGSYS */
42*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_ERRNO	 0x00050000U /* returns an errno */
43*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_USER_NOTIF	 0x7fc00000U /* notifies userspace */
44*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_TRACE	 0x7ff00000U /* pass to a tracer or disallow */
45*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_LOG		 0x7ffc0000U /* allow after logging */
46*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_ALLOW	 0x7fff0000U /* allow */
47*f80ad8b4SAndroid Build Coastguard Worker 
48*f80ad8b4SAndroid Build Coastguard Worker /* Masks for the return value sections. */
49*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_ACTION_FULL	0xffff0000U
50*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_ACTION	0x7fff0000U
51*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_RET_DATA	0x0000ffffU
52*f80ad8b4SAndroid Build Coastguard Worker 
53*f80ad8b4SAndroid Build Coastguard Worker /**
54*f80ad8b4SAndroid Build Coastguard Worker  * struct seccomp_data - the format the BPF program executes over.
55*f80ad8b4SAndroid Build Coastguard Worker  * @nr: the system call number
56*f80ad8b4SAndroid Build Coastguard Worker  * @arch: indicates system call convention as an AUDIT_ARCH_* value
57*f80ad8b4SAndroid Build Coastguard Worker  *        as defined in <linux/audit.h>.
58*f80ad8b4SAndroid Build Coastguard Worker  * @instruction_pointer: at the time of the system call.
59*f80ad8b4SAndroid Build Coastguard Worker  * @args: up to 6 system call arguments always stored as 64-bit values
60*f80ad8b4SAndroid Build Coastguard Worker  *        regardless of the architecture.
61*f80ad8b4SAndroid Build Coastguard Worker  */
62*f80ad8b4SAndroid Build Coastguard Worker struct seccomp_data {
63*f80ad8b4SAndroid Build Coastguard Worker 	int nr;
64*f80ad8b4SAndroid Build Coastguard Worker 	__u32 arch;
65*f80ad8b4SAndroid Build Coastguard Worker 	__u64 instruction_pointer;
66*f80ad8b4SAndroid Build Coastguard Worker 	__u64 args[6];
67*f80ad8b4SAndroid Build Coastguard Worker };
68*f80ad8b4SAndroid Build Coastguard Worker 
69*f80ad8b4SAndroid Build Coastguard Worker struct seccomp_notif_sizes {
70*f80ad8b4SAndroid Build Coastguard Worker 	__u16 seccomp_notif;
71*f80ad8b4SAndroid Build Coastguard Worker 	__u16 seccomp_notif_resp;
72*f80ad8b4SAndroid Build Coastguard Worker 	__u16 seccomp_data;
73*f80ad8b4SAndroid Build Coastguard Worker };
74*f80ad8b4SAndroid Build Coastguard Worker 
75*f80ad8b4SAndroid Build Coastguard Worker struct seccomp_notif {
76*f80ad8b4SAndroid Build Coastguard Worker 	__u64 id;
77*f80ad8b4SAndroid Build Coastguard Worker 	__u32 pid;
78*f80ad8b4SAndroid Build Coastguard Worker 	__u32 flags;
79*f80ad8b4SAndroid Build Coastguard Worker 	struct seccomp_data data;
80*f80ad8b4SAndroid Build Coastguard Worker };
81*f80ad8b4SAndroid Build Coastguard Worker 
82*f80ad8b4SAndroid Build Coastguard Worker /*
83*f80ad8b4SAndroid Build Coastguard Worker  * Valid flags for struct seccomp_notif_resp
84*f80ad8b4SAndroid Build Coastguard Worker  *
85*f80ad8b4SAndroid Build Coastguard Worker  * Note, the SECCOMP_USER_NOTIF_FLAG_CONTINUE flag must be used with caution!
86*f80ad8b4SAndroid Build Coastguard Worker  * If set by the process supervising the syscalls of another process the
87*f80ad8b4SAndroid Build Coastguard Worker  * syscall will continue. This is problematic because of an inherent TOCTOU.
88*f80ad8b4SAndroid Build Coastguard Worker  * An attacker can exploit the time while the supervised process is waiting on
89*f80ad8b4SAndroid Build Coastguard Worker  * a response from the supervising process to rewrite syscall arguments which
90*f80ad8b4SAndroid Build Coastguard Worker  * are passed as pointers of the intercepted syscall.
91*f80ad8b4SAndroid Build Coastguard Worker  * It should be absolutely clear that this means that the seccomp notifier
92*f80ad8b4SAndroid Build Coastguard Worker  * _cannot_ be used to implement a security policy! It should only ever be used
93*f80ad8b4SAndroid Build Coastguard Worker  * in scenarios where a more privileged process supervises the syscalls of a
94*f80ad8b4SAndroid Build Coastguard Worker  * lesser privileged process to get around kernel-enforced security
95*f80ad8b4SAndroid Build Coastguard Worker  * restrictions when the privileged process deems this safe. In other words,
96*f80ad8b4SAndroid Build Coastguard Worker  * in order to continue a syscall the supervising process should be sure that
97*f80ad8b4SAndroid Build Coastguard Worker  * another security mechanism or the kernel itself will sufficiently block
98*f80ad8b4SAndroid Build Coastguard Worker  * syscalls if arguments are rewritten to something unsafe.
99*f80ad8b4SAndroid Build Coastguard Worker  *
100*f80ad8b4SAndroid Build Coastguard Worker  * Similar precautions should be applied when stacking SECCOMP_RET_USER_NOTIF
101*f80ad8b4SAndroid Build Coastguard Worker  * or SECCOMP_RET_TRACE. For SECCOMP_RET_USER_NOTIF filters acting on the
102*f80ad8b4SAndroid Build Coastguard Worker  * same syscall, the most recently added filter takes precedence. This means
103*f80ad8b4SAndroid Build Coastguard Worker  * that the new SECCOMP_RET_USER_NOTIF filter can override any
104*f80ad8b4SAndroid Build Coastguard Worker  * SECCOMP_IOCTL_NOTIF_SEND from earlier filters, essentially allowing all
105*f80ad8b4SAndroid Build Coastguard Worker  * such filtered syscalls to be executed by sending the response
106*f80ad8b4SAndroid Build Coastguard Worker  * SECCOMP_USER_NOTIF_FLAG_CONTINUE. Note that SECCOMP_RET_TRACE can equally
107*f80ad8b4SAndroid Build Coastguard Worker  * be overriden by SECCOMP_USER_NOTIF_FLAG_CONTINUE.
108*f80ad8b4SAndroid Build Coastguard Worker  */
109*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_USER_NOTIF_FLAG_CONTINUE (1UL << 0)
110*f80ad8b4SAndroid Build Coastguard Worker 
111*f80ad8b4SAndroid Build Coastguard Worker struct seccomp_notif_resp {
112*f80ad8b4SAndroid Build Coastguard Worker 	__u64 id;
113*f80ad8b4SAndroid Build Coastguard Worker 	__s64 val;
114*f80ad8b4SAndroid Build Coastguard Worker 	__s32 error;
115*f80ad8b4SAndroid Build Coastguard Worker 	__u32 flags;
116*f80ad8b4SAndroid Build Coastguard Worker };
117*f80ad8b4SAndroid Build Coastguard Worker 
118*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_USER_NOTIF_FD_SYNC_WAKE_UP (1UL << 0)
119*f80ad8b4SAndroid Build Coastguard Worker 
120*f80ad8b4SAndroid Build Coastguard Worker /* valid flags for seccomp_notif_addfd */
121*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_ADDFD_FLAG_SETFD	(1UL << 0) /* Specify remote fd */
122*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_ADDFD_FLAG_SEND		(1UL << 1) /* Addfd and return it, atomically */
123*f80ad8b4SAndroid Build Coastguard Worker 
124*f80ad8b4SAndroid Build Coastguard Worker /**
125*f80ad8b4SAndroid Build Coastguard Worker  * struct seccomp_notif_addfd
126*f80ad8b4SAndroid Build Coastguard Worker  * @id: The ID of the seccomp notification
127*f80ad8b4SAndroid Build Coastguard Worker  * @flags: SECCOMP_ADDFD_FLAG_*
128*f80ad8b4SAndroid Build Coastguard Worker  * @srcfd: The local fd number
129*f80ad8b4SAndroid Build Coastguard Worker  * @newfd: Optional remote FD number if SETFD option is set, otherwise 0.
130*f80ad8b4SAndroid Build Coastguard Worker  * @newfd_flags: The O_* flags the remote FD should have applied
131*f80ad8b4SAndroid Build Coastguard Worker  */
132*f80ad8b4SAndroid Build Coastguard Worker struct seccomp_notif_addfd {
133*f80ad8b4SAndroid Build Coastguard Worker 	__u64 id;
134*f80ad8b4SAndroid Build Coastguard Worker 	__u32 flags;
135*f80ad8b4SAndroid Build Coastguard Worker 	__u32 srcfd;
136*f80ad8b4SAndroid Build Coastguard Worker 	__u32 newfd;
137*f80ad8b4SAndroid Build Coastguard Worker 	__u32 newfd_flags;
138*f80ad8b4SAndroid Build Coastguard Worker };
139*f80ad8b4SAndroid Build Coastguard Worker 
140*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOC_MAGIC		'!'
141*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IO(nr)			_IO(SECCOMP_IOC_MAGIC, nr)
142*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOR(nr, type)		_IOR(SECCOMP_IOC_MAGIC, nr, type)
143*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOW(nr, type)		_IOW(SECCOMP_IOC_MAGIC, nr, type)
144*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOWR(nr, type)		_IOWR(SECCOMP_IOC_MAGIC, nr, type)
145*f80ad8b4SAndroid Build Coastguard Worker 
146*f80ad8b4SAndroid Build Coastguard Worker /* Flags for seccomp notification fd ioctl. */
147*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOCTL_NOTIF_RECV	SECCOMP_IOWR(0, struct seccomp_notif)
148*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOCTL_NOTIF_SEND	SECCOMP_IOWR(1,	\
149*f80ad8b4SAndroid Build Coastguard Worker 						struct seccomp_notif_resp)
150*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOCTL_NOTIF_ID_VALID	SECCOMP_IOW(2, __u64)
151*f80ad8b4SAndroid Build Coastguard Worker /* On success, the return value is the remote process's added fd number */
152*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOCTL_NOTIF_ADDFD	SECCOMP_IOW(3, \
153*f80ad8b4SAndroid Build Coastguard Worker 						struct seccomp_notif_addfd)
154*f80ad8b4SAndroid Build Coastguard Worker 
155*f80ad8b4SAndroid Build Coastguard Worker #define SECCOMP_IOCTL_NOTIF_SET_FLAGS	SECCOMP_IOW(4, __u64)
156*f80ad8b4SAndroid Build Coastguard Worker 
157*f80ad8b4SAndroid Build Coastguard Worker #endif /* _UAPI_LINUX_SECCOMP_H */
158