• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2007 Red Hat.  All rights reserved.
4  */
5 
6 #include <linux/init.h>
7 #include <linux/fs.h>
8 #include <linux/slab.h>
9 #include <linux/rwsem.h>
10 #include <linux/xattr.h>
11 #include <linux/security.h>
12 #include <linux/posix_acl_xattr.h>
13 #include <linux/iversion.h>
14 #include <linux/sched/mm.h>
15 #include "ctree.h"
16 #include "btrfs_inode.h"
17 #include "transaction.h"
18 #include "xattr.h"
19 #include "disk-io.h"
20 #include "props.h"
21 #include "locking.h"
22 
btrfs_getxattr(struct inode * inode,const char * name,void * buffer,size_t size)23 int btrfs_getxattr(struct inode *inode, const char *name,
24 				void *buffer, size_t size)
25 {
26 	struct btrfs_dir_item *di;
27 	struct btrfs_root *root = BTRFS_I(inode)->root;
28 	struct btrfs_path *path;
29 	struct extent_buffer *leaf;
30 	int ret = 0;
31 	unsigned long data_ptr;
32 
33 	path = btrfs_alloc_path();
34 	if (!path)
35 		return -ENOMEM;
36 
37 	/* lookup the xattr by name */
38 	di = btrfs_lookup_xattr(NULL, root, path, btrfs_ino(BTRFS_I(inode)),
39 			name, strlen(name), 0);
40 	if (!di) {
41 		ret = -ENODATA;
42 		goto out;
43 	} else if (IS_ERR(di)) {
44 		ret = PTR_ERR(di);
45 		goto out;
46 	}
47 
48 	leaf = path->nodes[0];
49 	/* if size is 0, that means we want the size of the attr */
50 	if (!size) {
51 		ret = btrfs_dir_data_len(leaf, di);
52 		goto out;
53 	}
54 
55 	/* now get the data out of our dir_item */
56 	if (btrfs_dir_data_len(leaf, di) > size) {
57 		ret = -ERANGE;
58 		goto out;
59 	}
60 
61 	/*
62 	 * The way things are packed into the leaf is like this
63 	 * |struct btrfs_dir_item|name|data|
64 	 * where name is the xattr name, so security.foo, and data is the
65 	 * content of the xattr.  data_ptr points to the location in memory
66 	 * where the data starts in the in memory leaf
67 	 */
68 	data_ptr = (unsigned long)((char *)(di + 1) +
69 				   btrfs_dir_name_len(leaf, di));
70 	read_extent_buffer(leaf, buffer, data_ptr,
71 			   btrfs_dir_data_len(leaf, di));
72 	ret = btrfs_dir_data_len(leaf, di);
73 
74 out:
75 	btrfs_free_path(path);
76 	return ret;
77 }
78 
btrfs_setxattr(struct btrfs_trans_handle * trans,struct inode * inode,const char * name,const void * value,size_t size,int flags)79 int btrfs_setxattr(struct btrfs_trans_handle *trans, struct inode *inode,
80 		   const char *name, const void *value, size_t size, int flags)
81 {
82 	struct btrfs_dir_item *di = NULL;
83 	struct btrfs_root *root = BTRFS_I(inode)->root;
84 	struct btrfs_fs_info *fs_info = root->fs_info;
85 	struct btrfs_path *path;
86 	size_t name_len = strlen(name);
87 	int ret = 0;
88 
89 	ASSERT(trans);
90 
91 	if (name_len + size > BTRFS_MAX_XATTR_SIZE(root->fs_info))
92 		return -ENOSPC;
93 
94 	path = btrfs_alloc_path();
95 	if (!path)
96 		return -ENOMEM;
97 	path->skip_release_on_error = 1;
98 
99 	if (!value) {
100 		di = btrfs_lookup_xattr(trans, root, path,
101 				btrfs_ino(BTRFS_I(inode)), name, name_len, -1);
102 		if (!di && (flags & XATTR_REPLACE))
103 			ret = -ENODATA;
104 		else if (IS_ERR(di))
105 			ret = PTR_ERR(di);
106 		else if (di)
107 			ret = btrfs_delete_one_dir_name(trans, root, path, di);
108 		goto out;
109 	}
110 
111 	/*
112 	 * For a replace we can't just do the insert blindly.
113 	 * Do a lookup first (read-only btrfs_search_slot), and return if xattr
114 	 * doesn't exist. If it exists, fall down below to the insert/replace
115 	 * path - we can't race with a concurrent xattr delete, because the VFS
116 	 * locks the inode's i_mutex before calling setxattr or removexattr.
117 	 */
118 	if (flags & XATTR_REPLACE) {
119 		ASSERT(inode_is_locked(inode));
120 		di = btrfs_lookup_xattr(NULL, root, path,
121 				btrfs_ino(BTRFS_I(inode)), name, name_len, 0);
122 		if (!di)
123 			ret = -ENODATA;
124 		else if (IS_ERR(di))
125 			ret = PTR_ERR(di);
126 		if (ret)
127 			goto out;
128 		btrfs_release_path(path);
129 		di = NULL;
130 	}
131 
132 	ret = btrfs_insert_xattr_item(trans, root, path, btrfs_ino(BTRFS_I(inode)),
133 				      name, name_len, value, size);
134 	if (ret == -EOVERFLOW) {
135 		/*
136 		 * We have an existing item in a leaf, split_leaf couldn't
137 		 * expand it. That item might have or not a dir_item that
138 		 * matches our target xattr, so lets check.
139 		 */
140 		ret = 0;
141 		btrfs_assert_tree_locked(path->nodes[0]);
142 		di = btrfs_match_dir_item_name(fs_info, path, name, name_len);
143 		if (!di && !(flags & XATTR_REPLACE)) {
144 			ret = -ENOSPC;
145 			goto out;
146 		}
147 	} else if (ret == -EEXIST) {
148 		ret = 0;
149 		di = btrfs_match_dir_item_name(fs_info, path, name, name_len);
150 		ASSERT(di); /* logic error */
151 	} else if (ret) {
152 		goto out;
153 	}
154 
155 	if (di && (flags & XATTR_CREATE)) {
156 		ret = -EEXIST;
157 		goto out;
158 	}
159 
160 	if (di) {
161 		/*
162 		 * We're doing a replace, and it must be atomic, that is, at
163 		 * any point in time we have either the old or the new xattr
164 		 * value in the tree. We don't want readers (getxattr and
165 		 * listxattrs) to miss a value, this is specially important
166 		 * for ACLs.
167 		 */
168 		const int slot = path->slots[0];
169 		struct extent_buffer *leaf = path->nodes[0];
170 		const u16 old_data_len = btrfs_dir_data_len(leaf, di);
171 		const u32 item_size = btrfs_item_size_nr(leaf, slot);
172 		const u32 data_size = sizeof(*di) + name_len + size;
173 		struct btrfs_item *item;
174 		unsigned long data_ptr;
175 		char *ptr;
176 
177 		if (size > old_data_len) {
178 			if (btrfs_leaf_free_space(leaf) <
179 			    (size - old_data_len)) {
180 				ret = -ENOSPC;
181 				goto out;
182 			}
183 		}
184 
185 		if (old_data_len + name_len + sizeof(*di) == item_size) {
186 			/* No other xattrs packed in the same leaf item. */
187 			if (size > old_data_len)
188 				btrfs_extend_item(path, size - old_data_len);
189 			else if (size < old_data_len)
190 				btrfs_truncate_item(path, data_size, 1);
191 		} else {
192 			/* There are other xattrs packed in the same item. */
193 			ret = btrfs_delete_one_dir_name(trans, root, path, di);
194 			if (ret)
195 				goto out;
196 			btrfs_extend_item(path, data_size);
197 		}
198 
199 		item = btrfs_item_nr(slot);
200 		ptr = btrfs_item_ptr(leaf, slot, char);
201 		ptr += btrfs_item_size(leaf, item) - data_size;
202 		di = (struct btrfs_dir_item *)ptr;
203 		btrfs_set_dir_data_len(leaf, di, size);
204 		data_ptr = ((unsigned long)(di + 1)) + name_len;
205 		write_extent_buffer(leaf, value, data_ptr, size);
206 		btrfs_mark_buffer_dirty(leaf);
207 	} else {
208 		/*
209 		 * Insert, and we had space for the xattr, so path->slots[0] is
210 		 * where our xattr dir_item is and btrfs_insert_xattr_item()
211 		 * filled it.
212 		 */
213 	}
214 out:
215 	btrfs_free_path(path);
216 	if (!ret) {
217 		set_bit(BTRFS_INODE_COPY_EVERYTHING,
218 			&BTRFS_I(inode)->runtime_flags);
219 		clear_bit(BTRFS_INODE_NO_XATTRS, &BTRFS_I(inode)->runtime_flags);
220 	}
221 	return ret;
222 }
223 
224 /*
225  * @value: "" makes the attribute to empty, NULL removes it
226  */
btrfs_setxattr_trans(struct inode * inode,const char * name,const void * value,size_t size,int flags)227 int btrfs_setxattr_trans(struct inode *inode, const char *name,
228 			 const void *value, size_t size, int flags)
229 {
230 	struct btrfs_root *root = BTRFS_I(inode)->root;
231 	struct btrfs_trans_handle *trans;
232 	const bool start_trans = (current->journal_info == NULL);
233 	int ret;
234 
235 	if (start_trans) {
236 		/*
237 		 * 1 unit for inserting/updating/deleting the xattr
238 		 * 1 unit for the inode item update
239 		 */
240 		trans = btrfs_start_transaction(root, 2);
241 		if (IS_ERR(trans))
242 			return PTR_ERR(trans);
243 	} else {
244 		/*
245 		 * This can happen when smack is enabled and a directory is being
246 		 * created. It happens through d_instantiate_new(), which calls
247 		 * smack_d_instantiate(), which in turn calls __vfs_setxattr() to
248 		 * set the transmute xattr (XATTR_NAME_SMACKTRANSMUTE) on the
249 		 * inode. We have already reserved space for the xattr and inode
250 		 * update at btrfs_mkdir(), so just use the transaction handle.
251 		 * We don't join or start a transaction, as that will reset the
252 		 * block_rsv of the handle and trigger a warning for the start
253 		 * case.
254 		 */
255 		ASSERT(strncmp(name, XATTR_SECURITY_PREFIX,
256 			       XATTR_SECURITY_PREFIX_LEN) == 0);
257 		trans = current->journal_info;
258 	}
259 
260 	ret = btrfs_setxattr(trans, inode, name, value, size, flags);
261 	if (ret)
262 		goto out;
263 
264 	inode_inc_iversion(inode);
265 	inode->i_ctime = current_time(inode);
266 	ret = btrfs_update_inode(trans, root, inode);
267 	BUG_ON(ret);
268 out:
269 	if (start_trans)
270 		btrfs_end_transaction(trans);
271 	return ret;
272 }
273 
btrfs_listxattr(struct dentry * dentry,char * buffer,size_t size)274 ssize_t btrfs_listxattr(struct dentry *dentry, char *buffer, size_t size)
275 {
276 	struct btrfs_key key;
277 	struct inode *inode = d_inode(dentry);
278 	struct btrfs_root *root = BTRFS_I(inode)->root;
279 	struct btrfs_path *path;
280 	int ret = 0;
281 	size_t total_size = 0, size_left = size;
282 
283 	/*
284 	 * ok we want all objects associated with this id.
285 	 * NOTE: we set key.offset = 0; because we want to start with the
286 	 * first xattr that we find and walk forward
287 	 */
288 	key.objectid = btrfs_ino(BTRFS_I(inode));
289 	key.type = BTRFS_XATTR_ITEM_KEY;
290 	key.offset = 0;
291 
292 	path = btrfs_alloc_path();
293 	if (!path)
294 		return -ENOMEM;
295 	path->reada = READA_FORWARD;
296 
297 	/* search for our xattrs */
298 	ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
299 	if (ret < 0)
300 		goto err;
301 
302 	while (1) {
303 		struct extent_buffer *leaf;
304 		int slot;
305 		struct btrfs_dir_item *di;
306 		struct btrfs_key found_key;
307 		u32 item_size;
308 		u32 cur;
309 
310 		leaf = path->nodes[0];
311 		slot = path->slots[0];
312 
313 		/* this is where we start walking through the path */
314 		if (slot >= btrfs_header_nritems(leaf)) {
315 			/*
316 			 * if we've reached the last slot in this leaf we need
317 			 * to go to the next leaf and reset everything
318 			 */
319 			ret = btrfs_next_leaf(root, path);
320 			if (ret < 0)
321 				goto err;
322 			else if (ret > 0)
323 				break;
324 			continue;
325 		}
326 
327 		btrfs_item_key_to_cpu(leaf, &found_key, slot);
328 
329 		/* check to make sure this item is what we want */
330 		if (found_key.objectid != key.objectid)
331 			break;
332 		if (found_key.type > BTRFS_XATTR_ITEM_KEY)
333 			break;
334 		if (found_key.type < BTRFS_XATTR_ITEM_KEY)
335 			goto next_item;
336 
337 		di = btrfs_item_ptr(leaf, slot, struct btrfs_dir_item);
338 		item_size = btrfs_item_size_nr(leaf, slot);
339 		cur = 0;
340 		while (cur < item_size) {
341 			u16 name_len = btrfs_dir_name_len(leaf, di);
342 			u16 data_len = btrfs_dir_data_len(leaf, di);
343 			u32 this_len = sizeof(*di) + name_len + data_len;
344 			unsigned long name_ptr = (unsigned long)(di + 1);
345 
346 			total_size += name_len + 1;
347 			/*
348 			 * We are just looking for how big our buffer needs to
349 			 * be.
350 			 */
351 			if (!size)
352 				goto next;
353 
354 			if (!buffer || (name_len + 1) > size_left) {
355 				ret = -ERANGE;
356 				goto err;
357 			}
358 
359 			read_extent_buffer(leaf, buffer, name_ptr, name_len);
360 			buffer[name_len] = '\0';
361 
362 			size_left -= name_len + 1;
363 			buffer += name_len + 1;
364 next:
365 			cur += this_len;
366 			di = (struct btrfs_dir_item *)((char *)di + this_len);
367 		}
368 next_item:
369 		path->slots[0]++;
370 	}
371 	ret = total_size;
372 
373 err:
374 	btrfs_free_path(path);
375 
376 	return ret;
377 }
378 
btrfs_xattr_handler_get(const struct xattr_handler * handler,struct dentry * unused,struct inode * inode,const char * name,void * buffer,size_t size,int flags)379 static int btrfs_xattr_handler_get(const struct xattr_handler *handler,
380 				   struct dentry *unused, struct inode *inode,
381 				   const char *name, void *buffer, size_t size,
382 				   int flags)
383 {
384 	name = xattr_full_name(handler, name);
385 	return btrfs_getxattr(inode, name, buffer, size);
386 }
387 
btrfs_xattr_handler_set(const struct xattr_handler * handler,struct dentry * unused,struct inode * inode,const char * name,const void * buffer,size_t size,int flags)388 static int btrfs_xattr_handler_set(const struct xattr_handler *handler,
389 				   struct dentry *unused, struct inode *inode,
390 				   const char *name, const void *buffer,
391 				   size_t size, int flags)
392 {
393 	if (btrfs_root_readonly(BTRFS_I(inode)->root))
394 		return -EROFS;
395 
396 	name = xattr_full_name(handler, name);
397 	return btrfs_setxattr_trans(inode, name, buffer, size, flags);
398 }
399 
btrfs_xattr_handler_set_prop(const struct xattr_handler * handler,struct dentry * unused,struct inode * inode,const char * name,const void * value,size_t size,int flags)400 static int btrfs_xattr_handler_set_prop(const struct xattr_handler *handler,
401 					struct dentry *unused, struct inode *inode,
402 					const char *name, const void *value,
403 					size_t size, int flags)
404 {
405 	int ret;
406 	struct btrfs_trans_handle *trans;
407 	struct btrfs_root *root = BTRFS_I(inode)->root;
408 
409 	name = xattr_full_name(handler, name);
410 	ret = btrfs_validate_prop(name, value, size);
411 	if (ret)
412 		return ret;
413 
414 	trans = btrfs_start_transaction(root, 2);
415 	if (IS_ERR(trans))
416 		return PTR_ERR(trans);
417 
418 	ret = btrfs_set_prop(trans, inode, name, value, size, flags);
419 	if (!ret) {
420 		inode_inc_iversion(inode);
421 		inode->i_ctime = current_time(inode);
422 		ret = btrfs_update_inode(trans, root, inode);
423 		BUG_ON(ret);
424 	}
425 
426 	btrfs_end_transaction(trans);
427 
428 	return ret;
429 }
430 
431 static const struct xattr_handler btrfs_security_xattr_handler = {
432 	.prefix = XATTR_SECURITY_PREFIX,
433 	.get = btrfs_xattr_handler_get,
434 	.set = btrfs_xattr_handler_set,
435 };
436 
437 static const struct xattr_handler btrfs_trusted_xattr_handler = {
438 	.prefix = XATTR_TRUSTED_PREFIX,
439 	.get = btrfs_xattr_handler_get,
440 	.set = btrfs_xattr_handler_set,
441 };
442 
443 static const struct xattr_handler btrfs_user_xattr_handler = {
444 	.prefix = XATTR_USER_PREFIX,
445 	.get = btrfs_xattr_handler_get,
446 	.set = btrfs_xattr_handler_set,
447 };
448 
449 static const struct xattr_handler btrfs_btrfs_xattr_handler = {
450 	.prefix = XATTR_BTRFS_PREFIX,
451 	.get = btrfs_xattr_handler_get,
452 	.set = btrfs_xattr_handler_set_prop,
453 };
454 
455 const struct xattr_handler *btrfs_xattr_handlers[] = {
456 	&btrfs_security_xattr_handler,
457 #ifdef CONFIG_BTRFS_FS_POSIX_ACL
458 	&posix_acl_access_xattr_handler,
459 	&posix_acl_default_xattr_handler,
460 #endif
461 	&btrfs_trusted_xattr_handler,
462 	&btrfs_user_xattr_handler,
463 	&btrfs_btrfs_xattr_handler,
464 	NULL,
465 };
466 
btrfs_initxattrs(struct inode * inode,const struct xattr * xattr_array,void * fs_private)467 static int btrfs_initxattrs(struct inode *inode,
468 			    const struct xattr *xattr_array, void *fs_private)
469 {
470 	struct btrfs_trans_handle *trans = fs_private;
471 	const struct xattr *xattr;
472 	unsigned int nofs_flag;
473 	char *name;
474 	int err = 0;
475 
476 	/*
477 	 * We're holding a transaction handle, so use a NOFS memory allocation
478 	 * context to avoid deadlock if reclaim happens.
479 	 */
480 	nofs_flag = memalloc_nofs_save();
481 	for (xattr = xattr_array; xattr->name != NULL; xattr++) {
482 		name = kmalloc(XATTR_SECURITY_PREFIX_LEN +
483 			       strlen(xattr->name) + 1, GFP_KERNEL);
484 		if (!name) {
485 			err = -ENOMEM;
486 			break;
487 		}
488 		strcpy(name, XATTR_SECURITY_PREFIX);
489 		strcpy(name + XATTR_SECURITY_PREFIX_LEN, xattr->name);
490 		err = btrfs_setxattr(trans, inode, name, xattr->value,
491 				     xattr->value_len, 0);
492 		kfree(name);
493 		if (err < 0)
494 			break;
495 	}
496 	memalloc_nofs_restore(nofs_flag);
497 	return err;
498 }
499 
btrfs_xattr_security_init(struct btrfs_trans_handle * trans,struct inode * inode,struct inode * dir,const struct qstr * qstr)500 int btrfs_xattr_security_init(struct btrfs_trans_handle *trans,
501 			      struct inode *inode, struct inode *dir,
502 			      const struct qstr *qstr)
503 {
504 	return security_inode_init_security(inode, dir, qstr,
505 					    &btrfs_initxattrs, trans);
506 }
507