xref: /openbmc/linux/fs/notify/fanotify/fanotify.c (revision 2359ccdd)
1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/fanotify.h>
3 #include <linux/fdtable.h>
4 #include <linux/fsnotify_backend.h>
5 #include <linux/init.h>
6 #include <linux/jiffies.h>
7 #include <linux/kernel.h> /* UINT_MAX */
8 #include <linux/mount.h>
9 #include <linux/sched.h>
10 #include <linux/sched/user.h>
11 #include <linux/types.h>
12 #include <linux/wait.h>
13 #include <linux/audit.h>
14 
15 #include "fanotify.h"
16 
17 static bool should_merge(struct fsnotify_event *old_fsn,
18 			 struct fsnotify_event *new_fsn)
19 {
20 	struct fanotify_event_info *old, *new;
21 
22 	pr_debug("%s: old=%p new=%p\n", __func__, old_fsn, new_fsn);
23 	old = FANOTIFY_E(old_fsn);
24 	new = FANOTIFY_E(new_fsn);
25 
26 	if (old_fsn->inode == new_fsn->inode && old->tgid == new->tgid &&
27 	    old->path.mnt == new->path.mnt &&
28 	    old->path.dentry == new->path.dentry)
29 		return true;
30 	return false;
31 }
32 
33 /* and the list better be locked by something too! */
34 static int fanotify_merge(struct list_head *list, struct fsnotify_event *event)
35 {
36 	struct fsnotify_event *test_event;
37 
38 	pr_debug("%s: list=%p event=%p\n", __func__, list, event);
39 
40 	/*
41 	 * Don't merge a permission event with any other event so that we know
42 	 * the event structure we have created in fanotify_handle_event() is the
43 	 * one we should check for permission response.
44 	 */
45 	if (fanotify_is_perm_event(event->mask))
46 		return 0;
47 
48 	list_for_each_entry_reverse(test_event, list, list) {
49 		if (should_merge(test_event, event)) {
50 			test_event->mask |= event->mask;
51 			return 1;
52 		}
53 	}
54 
55 	return 0;
56 }
57 
58 static int fanotify_get_response(struct fsnotify_group *group,
59 				 struct fanotify_perm_event_info *event,
60 				 struct fsnotify_iter_info *iter_info)
61 {
62 	int ret;
63 
64 	pr_debug("%s: group=%p event=%p\n", __func__, group, event);
65 
66 	wait_event(group->fanotify_data.access_waitq, event->response);
67 
68 	/* userspace responded, convert to something usable */
69 	switch (event->response & ~FAN_AUDIT) {
70 	case FAN_ALLOW:
71 		ret = 0;
72 		break;
73 	case FAN_DENY:
74 	default:
75 		ret = -EPERM;
76 	}
77 
78 	/* Check if the response should be audited */
79 	if (event->response & FAN_AUDIT)
80 		audit_fanotify(event->response & ~FAN_AUDIT);
81 
82 	event->response = 0;
83 
84 	pr_debug("%s: group=%p event=%p about to return ret=%d\n", __func__,
85 		 group, event, ret);
86 
87 	return ret;
88 }
89 
90 static bool fanotify_should_send_event(struct fsnotify_mark *inode_mark,
91 				       struct fsnotify_mark *vfsmnt_mark,
92 				       u32 event_mask,
93 				       const void *data, int data_type)
94 {
95 	__u32 marks_mask, marks_ignored_mask;
96 	const struct path *path = data;
97 
98 	pr_debug("%s: inode_mark=%p vfsmnt_mark=%p mask=%x data=%p"
99 		 " data_type=%d\n", __func__, inode_mark, vfsmnt_mark,
100 		 event_mask, data, data_type);
101 
102 	/* if we don't have enough info to send an event to userspace say no */
103 	if (data_type != FSNOTIFY_EVENT_PATH)
104 		return false;
105 
106 	/* sorry, fanotify only gives a damn about files and dirs */
107 	if (!d_is_reg(path->dentry) &&
108 	    !d_can_lookup(path->dentry))
109 		return false;
110 
111 	if (inode_mark && vfsmnt_mark) {
112 		marks_mask = (vfsmnt_mark->mask | inode_mark->mask);
113 		marks_ignored_mask = (vfsmnt_mark->ignored_mask | inode_mark->ignored_mask);
114 	} else if (inode_mark) {
115 		/*
116 		 * if the event is for a child and this inode doesn't care about
117 		 * events on the child, don't send it!
118 		 */
119 		if ((event_mask & FS_EVENT_ON_CHILD) &&
120 		    !(inode_mark->mask & FS_EVENT_ON_CHILD))
121 			return false;
122 		marks_mask = inode_mark->mask;
123 		marks_ignored_mask = inode_mark->ignored_mask;
124 	} else if (vfsmnt_mark) {
125 		marks_mask = vfsmnt_mark->mask;
126 		marks_ignored_mask = vfsmnt_mark->ignored_mask;
127 	} else {
128 		BUG();
129 	}
130 
131 	if (d_is_dir(path->dentry) &&
132 	    !(marks_mask & FS_ISDIR & ~marks_ignored_mask))
133 		return false;
134 
135 	if (event_mask & FAN_ALL_OUTGOING_EVENTS & marks_mask &
136 				 ~marks_ignored_mask)
137 		return true;
138 
139 	return false;
140 }
141 
142 struct fanotify_event_info *fanotify_alloc_event(struct fsnotify_group *group,
143 						 struct inode *inode, u32 mask,
144 						 const struct path *path)
145 {
146 	struct fanotify_event_info *event;
147 	gfp_t gfp = GFP_KERNEL;
148 
149 	/*
150 	 * For queues with unlimited length lost events are not expected and
151 	 * can possibly have security implications. Avoid losing events when
152 	 * memory is short.
153 	 */
154 	if (group->max_events == UINT_MAX)
155 		gfp |= __GFP_NOFAIL;
156 
157 	if (fanotify_is_perm_event(mask)) {
158 		struct fanotify_perm_event_info *pevent;
159 
160 		pevent = kmem_cache_alloc(fanotify_perm_event_cachep, gfp);
161 		if (!pevent)
162 			return NULL;
163 		event = &pevent->fae;
164 		pevent->response = 0;
165 		goto init;
166 	}
167 	event = kmem_cache_alloc(fanotify_event_cachep, gfp);
168 	if (!event)
169 		return NULL;
170 init: __maybe_unused
171 	fsnotify_init_event(&event->fse, inode, mask);
172 	event->tgid = get_pid(task_tgid(current));
173 	if (path) {
174 		event->path = *path;
175 		path_get(&event->path);
176 	} else {
177 		event->path.mnt = NULL;
178 		event->path.dentry = NULL;
179 	}
180 	return event;
181 }
182 
183 static int fanotify_handle_event(struct fsnotify_group *group,
184 				 struct inode *inode,
185 				 struct fsnotify_mark *inode_mark,
186 				 struct fsnotify_mark *fanotify_mark,
187 				 u32 mask, const void *data, int data_type,
188 				 const unsigned char *file_name, u32 cookie,
189 				 struct fsnotify_iter_info *iter_info)
190 {
191 	int ret = 0;
192 	struct fanotify_event_info *event;
193 	struct fsnotify_event *fsn_event;
194 
195 	BUILD_BUG_ON(FAN_ACCESS != FS_ACCESS);
196 	BUILD_BUG_ON(FAN_MODIFY != FS_MODIFY);
197 	BUILD_BUG_ON(FAN_CLOSE_NOWRITE != FS_CLOSE_NOWRITE);
198 	BUILD_BUG_ON(FAN_CLOSE_WRITE != FS_CLOSE_WRITE);
199 	BUILD_BUG_ON(FAN_OPEN != FS_OPEN);
200 	BUILD_BUG_ON(FAN_EVENT_ON_CHILD != FS_EVENT_ON_CHILD);
201 	BUILD_BUG_ON(FAN_Q_OVERFLOW != FS_Q_OVERFLOW);
202 	BUILD_BUG_ON(FAN_OPEN_PERM != FS_OPEN_PERM);
203 	BUILD_BUG_ON(FAN_ACCESS_PERM != FS_ACCESS_PERM);
204 	BUILD_BUG_ON(FAN_ONDIR != FS_ISDIR);
205 
206 	if (!fanotify_should_send_event(inode_mark, fanotify_mark, mask, data,
207 					data_type))
208 		return 0;
209 
210 	pr_debug("%s: group=%p inode=%p mask=%x\n", __func__, group, inode,
211 		 mask);
212 
213 	if (fanotify_is_perm_event(mask)) {
214 		/*
215 		 * fsnotify_prepare_user_wait() fails if we race with mark
216 		 * deletion.  Just let the operation pass in that case.
217 		 */
218 		if (!fsnotify_prepare_user_wait(iter_info))
219 			return 0;
220 	}
221 
222 	event = fanotify_alloc_event(group, inode, mask, data);
223 	ret = -ENOMEM;
224 	if (unlikely(!event)) {
225 		/*
226 		 * We don't queue overflow events for permission events as
227 		 * there the access is denied and so no event is in fact lost.
228 		 */
229 		if (!fanotify_is_perm_event(mask))
230 			fsnotify_queue_overflow(group);
231 		goto finish;
232 	}
233 
234 	fsn_event = &event->fse;
235 	ret = fsnotify_add_event(group, fsn_event, fanotify_merge);
236 	if (ret) {
237 		/* Permission events shouldn't be merged */
238 		BUG_ON(ret == 1 && mask & FAN_ALL_PERM_EVENTS);
239 		/* Our event wasn't used in the end. Free it. */
240 		fsnotify_destroy_event(group, fsn_event);
241 
242 		ret = 0;
243 	} else if (fanotify_is_perm_event(mask)) {
244 		ret = fanotify_get_response(group, FANOTIFY_PE(fsn_event),
245 					    iter_info);
246 		fsnotify_destroy_event(group, fsn_event);
247 	}
248 finish:
249 	if (fanotify_is_perm_event(mask))
250 		fsnotify_finish_user_wait(iter_info);
251 
252 	return ret;
253 }
254 
255 static void fanotify_free_group_priv(struct fsnotify_group *group)
256 {
257 	struct user_struct *user;
258 
259 	user = group->fanotify_data.user;
260 	atomic_dec(&user->fanotify_listeners);
261 	free_uid(user);
262 }
263 
264 static void fanotify_free_event(struct fsnotify_event *fsn_event)
265 {
266 	struct fanotify_event_info *event;
267 
268 	event = FANOTIFY_E(fsn_event);
269 	path_put(&event->path);
270 	put_pid(event->tgid);
271 	if (fanotify_is_perm_event(fsn_event->mask)) {
272 		kmem_cache_free(fanotify_perm_event_cachep,
273 				FANOTIFY_PE(fsn_event));
274 		return;
275 	}
276 	kmem_cache_free(fanotify_event_cachep, event);
277 }
278 
279 static void fanotify_free_mark(struct fsnotify_mark *fsn_mark)
280 {
281 	kmem_cache_free(fanotify_mark_cache, fsn_mark);
282 }
283 
284 const struct fsnotify_ops fanotify_fsnotify_ops = {
285 	.handle_event = fanotify_handle_event,
286 	.free_group_priv = fanotify_free_group_priv,
287 	.free_event = fanotify_free_event,
288 	.free_mark = fanotify_free_mark,
289 };
290