[linux-block.git] / include / linux / fanotify.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_FANOTIFY_H
#define _LINUX_FANOTIFY_H

#include <linux/sysctl.h>
#include <uapi/linux/fanotify.h>

extern struct ctl_table fanotify_table[]; /* for sysctl */

#define FAN_GROUP_FLAG(group, flag) \
	((group)->fanotify_data.flags & (flag))

/*
 * Flags allowed to be passed from/to userspace.
 *
 * We intentionally do not add new bits to the old FAN_ALL_* constants, because
 * they are uapi exposed constants. If there are programs out there using
 * these constant, the programs may break if re-compiled with new uapi headers
 * and then run on an old kernel.
 */

/* Group classes where permission events are allowed */
#define FANOTIFY_PERM_CLASSES	(FAN_CLASS_CONTENT | \
				 FAN_CLASS_PRE_CONTENT)

#define FANOTIFY_CLASS_BITS	(FAN_CLASS_NOTIF | FANOTIFY_PERM_CLASSES)

#define FANOTIFY_FID_BITS	(FAN_REPORT_FID | FAN_REPORT_DFID_NAME)

/*
 * fanotify_init() flags that require CAP_SYS_ADMIN.
 * We do not allow unprivileged groups to request permission events.
 * We do not allow unprivileged groups to get other process pid in events.
 * We do not allow unprivileged groups to use unlimited resources.
 */
#define FANOTIFY_ADMIN_INIT_FLAGS	(FANOTIFY_PERM_CLASSES | \
					 FAN_REPORT_TID | \
					 FAN_UNLIMITED_QUEUE | \
					 FAN_UNLIMITED_MARKS)

/*
 * fanotify_init() flags that are allowed for user without CAP_SYS_ADMIN.
 * FAN_CLASS_NOTIF is the only class we allow for unprivileged group.
 * We do not allow unprivileged groups to get file descriptors in events,
 * so one of the flags for reporting file handles is required.
 */
#define FANOTIFY_USER_INIT_FLAGS	(FAN_CLASS_NOTIF | \
					 FANOTIFY_FID_BITS | \
					 FAN_CLOEXEC | FAN_NONBLOCK)

#define FANOTIFY_INIT_FLAGS	(FANOTIFY_ADMIN_INIT_FLAGS | \
				 FANOTIFY_USER_INIT_FLAGS)

/* Internal group flags */
#define FANOTIFY_UNPRIV		0x80000000
#define FANOTIFY_INTERNAL_GROUP_FLAGS	(FANOTIFY_UNPRIV)

#define FANOTIFY_MARK_TYPE_BITS	(FAN_MARK_INODE | FAN_MARK_MOUNT | \
				 FAN_MARK_FILESYSTEM)

#define FANOTIFY_MARK_FLAGS	(FANOTIFY_MARK_TYPE_BITS | \
				 FAN_MARK_ADD | \
				 FAN_MARK_REMOVE | \
				 FAN_MARK_DONT_FOLLOW | \
				 FAN_MARK_ONLYDIR | \
				 FAN_MARK_IGNORED_MASK | \
				 FAN_MARK_IGNORED_SURV_MODIFY | \
				 FAN_MARK_FLUSH)

/*
 * Events that can be reported with data type FSNOTIFY_EVENT_PATH.
 * Note that FAN_MODIFY can also be reported with data type
 * FSNOTIFY_EVENT_INODE.
 */
#define FANOTIFY_PATH_EVENTS	(FAN_ACCESS | FAN_MODIFY | \
				 FAN_CLOSE | FAN_OPEN | FAN_OPEN_EXEC)

/*
 * Directory entry modification events - reported only to directory
 * where entry is modified and not to a watching parent.
 */
#define FANOTIFY_DIRENT_EVENTS	(FAN_MOVE | FAN_CREATE | FAN_DELETE)

/* Events that can only be reported with data type FSNOTIFY_EVENT_INODE */
#define FANOTIFY_INODE_EVENTS	(FANOTIFY_DIRENT_EVENTS | \
				 FAN_ATTRIB | FAN_MOVE_SELF | FAN_DELETE_SELF)

/* Events that user can request to be notified on */
#define FANOTIFY_EVENTS		(FANOTIFY_PATH_EVENTS | \
				 FANOTIFY_INODE_EVENTS)

/* Events that require a permission response from user */
#define FANOTIFY_PERM_EVENTS	(FAN_OPEN_PERM | FAN_ACCESS_PERM | \
				 FAN_OPEN_EXEC_PERM)

/* Extra flags that may be reported with event or control handling of events */
#define FANOTIFY_EVENT_FLAGS	(FAN_EVENT_ON_CHILD | FAN_ONDIR)

/* Events that may be reported to user */
#define FANOTIFY_OUTGOING_EVENTS	(FANOTIFY_EVENTS | \
					 FANOTIFY_PERM_EVENTS | \
					 FAN_Q_OVERFLOW | FAN_ONDIR)

#define ALL_FANOTIFY_EVENT_BITS		(FANOTIFY_OUTGOING_EVENTS | \
					 FANOTIFY_EVENT_FLAGS)

/* Do not use these old uapi constants internally */
#undef FAN_ALL_CLASS_BITS
#undef FAN_ALL_INIT_FLAGS
#undef FAN_ALL_MARK_FLAGS
#undef FAN_ALL_EVENTS
#undef FAN_ALL_PERM_EVENTS
#undef FAN_ALL_OUTGOING_EVENTS

#endif /* _LINUX_FANOTIFY_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
ff0b16a9 EP	2	#ifndef _LINUX_FANOTIFY_H
	3	#define _LINUX_FANOTIFY_H
	4
5b8fea65	5	#include <linux/sysctl.h>
607ca46e	6	#include <uapi/linux/fanotify.h>
ff0b16a9	7
5b8fea65 AG	8	extern struct ctl_table fanotify_table[]; /* for sysctl */
5b8fea65 AG	9
96a71f21 AG	10	#define FAN_GROUP_FLAG(group, flag) \
	11	((group)->fanotify_data.flags & (flag))
	12
23c9deeb AG	13	/*
	14	* Flags allowed to be passed from/to userspace.
	15	*
	16	* We intentionally do not add new bits to the old FAN_ALL_* constants, because
	17	* they are uapi exposed constants. If there are programs out there using
	18	* these constant, the programs may break if re-compiled with new uapi headers
	19	* and then run on an old kernel.
	20	*/
7cea2a3c AG	21
	22	/* Group classes where permission events are allowed */
	23	#define FANOTIFY_PERM_CLASSES (FAN_CLASS_CONTENT \| \
23c9deeb AG	24	FAN_CLASS_PRE_CONTENT)
23c9deeb AG	25
7cea2a3c AG	26	#define FANOTIFY_CLASS_BITS (FAN_CLASS_NOTIF \| FANOTIFY_PERM_CLASSES)
7cea2a3c AG	27
929943b3	28	#define FANOTIFY_FID_BITS (FAN_REPORT_FID \| FAN_REPORT_DFID_NAME)
d809daf1	29
7cea2a3c AG	30	/*
	31	* fanotify_init() flags that require CAP_SYS_ADMIN.
	32	* We do not allow unprivileged groups to request permission events.
	33	* We do not allow unprivileged groups to get other process pid in events.
	34	* We do not allow unprivileged groups to use unlimited resources.
	35	*/
	36	#define FANOTIFY_ADMIN_INIT_FLAGS (FANOTIFY_PERM_CLASSES \| \
	37	FAN_REPORT_TID \| \
	38	FAN_UNLIMITED_QUEUE \| \
	39	FAN_UNLIMITED_MARKS)
	40
	41	/*
	42	* fanotify_init() flags that are allowed for user without CAP_SYS_ADMIN.
	43	* FAN_CLASS_NOTIF is the only class we allow for unprivileged group.
	44	* We do not allow unprivileged groups to get file descriptors in events,
	45	* so one of the flags for reporting file handles is required.
	46	*/
	47	#define FANOTIFY_USER_INIT_FLAGS (FAN_CLASS_NOTIF \| \
	48	FANOTIFY_FID_BITS \| \
	49	FAN_CLOEXEC \| FAN_NONBLOCK)
	50
	51	#define FANOTIFY_INIT_FLAGS (FANOTIFY_ADMIN_INIT_FLAGS \| \
	52	FANOTIFY_USER_INIT_FLAGS)
23c9deeb	53
a8b98c80 AG	54	/* Internal group flags */
	55	#define FANOTIFY_UNPRIV 0x80000000
	56	#define FANOTIFY_INTERNAL_GROUP_FLAGS (FANOTIFY_UNPRIV)
	57
23c9deeb AG	58	#define FANOTIFY_MARK_TYPE_BITS (FAN_MARK_INODE \| FAN_MARK_MOUNT \| \
	59	FAN_MARK_FILESYSTEM)
	60
	61	#define FANOTIFY_MARK_FLAGS (FANOTIFY_MARK_TYPE_BITS \| \
	62	FAN_MARK_ADD \| \
	63	FAN_MARK_REMOVE \| \
	64	FAN_MARK_DONT_FOLLOW \| \
	65	FAN_MARK_ONLYDIR \| \
	66	FAN_MARK_IGNORED_MASK \| \
	67	FAN_MARK_IGNORED_SURV_MODIFY \| \
	68	FAN_MARK_FLUSH)
	69
235328d1 AG	70	/*
	71	* Events that can be reported with data type FSNOTIFY_EVENT_PATH.
	72	* Note that FAN_MODIFY can also be reported with data type
	73	* FSNOTIFY_EVENT_INODE.
	74	*/
	75	#define FANOTIFY_PATH_EVENTS (FAN_ACCESS \| FAN_MODIFY \| \
9b076f1c	76	FAN_CLOSE \| FAN_OPEN \| FAN_OPEN_EXEC)
23c9deeb	77
235328d1 AG	78	/*
	79	* Directory entry modification events - reported only to directory
	80	* where entry is modified and not to a watching parent.
	81	*/
f1793699	82	#define FANOTIFY_DIRENT_EVENTS (FAN_MOVE \| FAN_CREATE \| FAN_DELETE)
235328d1 AG	83
	84	/* Events that can only be reported with data type FSNOTIFY_EVENT_INODE */
	85	#define FANOTIFY_INODE_EVENTS (FANOTIFY_DIRENT_EVENTS \| \
	86	FAN_ATTRIB \| FAN_MOVE_SELF \| FAN_DELETE_SELF)
	87
	88	/* Events that user can request to be notified on */
	89	#define FANOTIFY_EVENTS (FANOTIFY_PATH_EVENTS \| \
	90	FANOTIFY_INODE_EVENTS)
	91
23c9deeb	92	/* Events that require a permission response from user */
66917a31 MB	93	#define FANOTIFY_PERM_EVENTS (FAN_OPEN_PERM \| FAN_ACCESS_PERM \| \
66917a31 MB	94	FAN_OPEN_EXEC_PERM)
23c9deeb	95
bdd5a46f AG	96	/* Extra flags that may be reported with event or control handling of events */
	97	#define FANOTIFY_EVENT_FLAGS (FAN_EVENT_ON_CHILD \| FAN_ONDIR)
	98
23c9deeb AG	99	/* Events that may be reported to user */
	100	#define FANOTIFY_OUTGOING_EVENTS (FANOTIFY_EVENTS \| \
	101	FANOTIFY_PERM_EVENTS \| \
e7fce6d9	102	FAN_Q_OVERFLOW \| FAN_ONDIR)
23c9deeb	103
bdd5a46f AG	104	#define ALL_FANOTIFY_EVENT_BITS (FANOTIFY_OUTGOING_EVENTS \| \
	105	FANOTIFY_EVENT_FLAGS)
	106
23c9deeb AG	107	/* Do not use these old uapi constants internally */
	108	#undef FAN_ALL_CLASS_BITS
	109	#undef FAN_ALL_INIT_FLAGS
	110	#undef FAN_ALL_MARK_FLAGS
	111	#undef FAN_ALL_EVENTS
	112	#undef FAN_ALL_PERM_EVENTS
	113	#undef FAN_ALL_OUTGOING_EVENTS
	114
ff0b16a9	115	#endif /* _LINUX_FANOTIFY_H */