xref: /linux/fs/btrfs/verity.c (revision 76bf149cd0298544631e756670b89c399c7acbca)
1 // SPDX-License-Identifier: GPL-2.0
2 
3 #include <linux/init.h>
4 #include <linux/fs.h>
5 #include <linux/slab.h>
6 #include <linux/rwsem.h>
7 #include <linux/xattr.h>
8 #include <linux/security.h>
9 #include <linux/posix_acl_xattr.h>
10 #include <linux/iversion.h>
11 #include <linux/fsverity.h>
12 #include <linux/sched/mm.h>
13 #include "messages.h"
14 #include "ctree.h"
15 #include "btrfs_inode.h"
16 #include "transaction.h"
17 #include "locking.h"
18 #include "fs.h"
19 #include "accessors.h"
20 #include "ioctl.h"
21 #include "verity.h"
22 #include "orphan.h"
23 
24 /*
25  * Implementation of the interface defined in struct fsverity_operations.
26  *
27  * The main question is how and where to store the verity descriptor and the
28  * Merkle tree. We store both in dedicated btree items in the filesystem tree,
29  * together with the rest of the inode metadata. This means we'll need to do
30  * extra work to encrypt them once encryption is supported in btrfs, but btrfs
31  * has a lot of careful code around i_size and it seems better to make a new key
32  * type than try and adjust all of our expectations for i_size.
33  *
34  * Note that this differs from the implementation in ext4 and f2fs, where
35  * this data is stored as if it were in the file, but past EOF. However, btrfs
36  * does not have a widespread mechanism for caching opaque metadata pages, so we
37  * do pretend that the Merkle tree pages themselves are past EOF for the
38  * purposes of caching them (as opposed to creating a virtual inode).
39  *
40  * fs verity items are stored under two different key types on disk.
41  * The descriptor items:
42  * [ inode objectid, BTRFS_VERITY_DESC_ITEM_KEY, offset ]
43  *
44  * At offset 0, we store a btrfs_verity_descriptor_item which tracks the
45  * size of the descriptor item and some extra data for encryption.
46  * Starting at offset 1, these hold the generic fs verity descriptor.
47  * The latter are opaque to btrfs, we just read and write them as a blob for
48  * the higher level verity code.  The most common descriptor size is 256 bytes.
49  *
50  * The merkle tree items:
51  * [ inode objectid, BTRFS_VERITY_MERKLE_ITEM_KEY, offset ]
52  *
53  * These also start at offset 0, and correspond to the merkle tree bytes.
54  * So when fsverity asks for page 0 of the merkle tree, we pull up one page
55  * starting at offset 0 for this key type.  These are also opaque to btrfs,
56  * we're blindly storing whatever fsverity sends down.
57  *
58  * Another important consideration is the fact that the Merkle tree data scales
59  * linearly with the size of the file (with 4K pages/blocks and SHA-256, it's
60  * ~1/127th the size) so for large files, writing the tree can be a lengthy
61  * operation. For that reason, we guard the whole enable verity operation
62  * (between begin_enable_verity and end_enable_verity) with an orphan item.
63  * Again, because the data can be pretty large, it's quite possible that we
64  * could run out of space writing it, so we try our best to handle errors by
65  * stopping and rolling back rather than aborting the victim transaction.
66  */
67 
68 #define MERKLE_START_ALIGN			65536
69 
70 /*
71  * Compute the logical file offset where we cache the Merkle tree.
72  *
73  * @inode:  inode of the verity file
74  *
75  * For the purposes of caching the Merkle tree pages, as required by
76  * fs-verity, it is convenient to do size computations in terms of a file
77  * offset, rather than in terms of page indices.
78  *
79  * Use 64K to be sure it's past the last page in the file, even with 64K pages.
80  * That rounding operation itself can overflow loff_t, so we do it in u64 and
81  * check.
82  *
83  * Returns the file offset on success, negative error code on failure.
84  */
85 static loff_t merkle_file_pos(const struct inode *inode)
86 {
87 	u64 sz = inode->i_size;
88 	u64 rounded = round_up(sz, MERKLE_START_ALIGN);
89 
90 	if (rounded > inode->i_sb->s_maxbytes)
91 		return -EFBIG;
92 
93 	return rounded;
94 }
95 
96 /*
97  * Start a transaction for removing verity items or the verity orphan.
98  *
99  * Like unlink, this only deletes items and frees space in the end, so the
100  * reservation may come from the global reserve when the filesystem is full
101  * (-ENOSPC) and is not subject to the qgroup limit (-EDQUOT). Otherwise a
102  * failed enable could never be cleaned up in either situation.
103  */
104 static struct btrfs_trans_handle *start_verity_cleanup_trans(struct btrfs_root *root,
105 							     unsigned int num_items)
106 {
107 	return btrfs_start_transaction_fallback_global_rsv(root, num_items);
108 }
109 
110 /*
111  * Drop all the items for this inode with this key_type.
112  *
113  * @inode:     inode to drop items for
114  * @key_type:  type of items to drop (BTRFS_VERITY_DESC_ITEM or
115  *             BTRFS_VERITY_MERKLE_ITEM)
116  *
117  * Before doing a verity enable we cleanup any existing verity items.
118  * This is also used to clean up if a verity enable failed half way through.
119  *
120  * Returns number of dropped items on success, negative error code on failure.
121  */
122 static int drop_verity_items(struct btrfs_inode *inode, u8 key_type)
123 {
124 	struct btrfs_trans_handle *trans;
125 	struct btrfs_root *root = inode->root;
126 	BTRFS_PATH_AUTO_FREE(path);
127 	struct btrfs_key key;
128 	int count = 0;
129 	int ret;
130 
131 	path = btrfs_alloc_path();
132 	if (!path)
133 		return -ENOMEM;
134 
135 	while (1) {
136 		/* 1 for the item being dropped */
137 		trans = start_verity_cleanup_trans(root, 1);
138 		if (IS_ERR(trans))
139 			return PTR_ERR(trans);
140 
141 		/*
142 		 * Walk backwards through all the items until we find one that
143 		 * isn't from our key type or objectid
144 		 */
145 		key.objectid = btrfs_ino(inode);
146 		key.type = key_type;
147 		key.offset = (u64)-1;
148 
149 		ret = btrfs_search_slot(trans, root, &key, path, -1, 1);
150 		if (ret > 0) {
151 			ret = 0;
152 			/* No more keys of this type, we're done */
153 			if (path->slots[0] == 0)
154 				break;
155 			path->slots[0]--;
156 		} else if (ret < 0) {
157 			btrfs_end_transaction(trans);
158 			return ret;
159 		}
160 
161 		btrfs_item_key_to_cpu(path->nodes[0], &key, path->slots[0]);
162 
163 		/* No more keys of this type, we're done */
164 		if (key.objectid != btrfs_ino(inode) || key.type != key_type)
165 			break;
166 
167 		/*
168 		 * This shouldn't be a performance sensitive function because
169 		 * it's not used as part of truncate.  If it ever becomes
170 		 * perf sensitive, change this to walk forward and bulk delete
171 		 * items
172 		 */
173 		ret = btrfs_del_items(trans, root, path, path->slots[0], 1);
174 		if (ret) {
175 			btrfs_end_transaction(trans);
176 			return ret;
177 		}
178 		count++;
179 		btrfs_release_path(path);
180 		btrfs_end_transaction(trans);
181 	}
182 	btrfs_end_transaction(trans);
183 	return count;
184 }
185 
186 /*
187  * Drop all verity items
188  *
189  * @inode:  inode to drop verity items for
190  *
191  * In most contexts where we are dropping verity items, we want to do it for all
192  * the types of verity items, not a particular one.
193  *
194  * Returns: 0 on success, negative error code on failure.
195  */
196 int btrfs_drop_verity_items(struct btrfs_inode *inode)
197 {
198 	int ret;
199 
200 	ret = drop_verity_items(inode, BTRFS_VERITY_DESC_ITEM_KEY);
201 	if (ret < 0)
202 		return ret;
203 	ret = drop_verity_items(inode, BTRFS_VERITY_MERKLE_ITEM_KEY);
204 	if (ret < 0)
205 		return ret;
206 
207 	return 0;
208 }
209 
210 /*
211  * Insert and write inode items with a given key type and offset.
212  *
213  * @inode:     inode to insert for
214  * @key_type:  key type to insert
215  * @offset:    item offset to insert at
216  * @src:       source data to write
217  * @len:       length of source data to write
218  *
219  * Write len bytes from src into items of up to 2K length.
220  * The inserted items will have key (ino, key_type, offset + off) where off is
221  * consecutively increasing from 0 up to the last item ending at offset + len.
222  *
223  * Returns 0 on success and a negative error code on failure.
224  */
225 static int write_key_bytes(struct btrfs_inode *inode, u8 key_type, u64 offset,
226 			   const char *src, u64 len)
227 {
228 	struct btrfs_trans_handle *trans;
229 	BTRFS_PATH_AUTO_FREE(path);
230 	struct btrfs_root *root = inode->root;
231 	struct extent_buffer *leaf;
232 	struct btrfs_key key;
233 	unsigned long copy_bytes;
234 	unsigned long src_offset = 0;
235 	void *data;
236 	int ret = 0;
237 
238 	path = btrfs_alloc_path();
239 	if (!path)
240 		return -ENOMEM;
241 
242 	while (len > 0) {
243 		/* 1 for the new item being inserted */
244 		trans = btrfs_start_transaction(root, 1);
245 		if (IS_ERR(trans))
246 			return PTR_ERR(trans);
247 
248 		key.objectid = btrfs_ino(inode);
249 		key.type = key_type;
250 		key.offset = offset;
251 
252 		/*
253 		 * Insert 2K at a time mostly to be friendly for smaller leaf
254 		 * size filesystems
255 		 */
256 		copy_bytes = min_t(u64, len, 2048);
257 
258 		ret = btrfs_insert_empty_item(trans, root, path, &key, copy_bytes);
259 		if (ret) {
260 			btrfs_end_transaction(trans);
261 			break;
262 		}
263 
264 		leaf = path->nodes[0];
265 
266 		data = btrfs_item_ptr(leaf, path->slots[0], void);
267 		write_extent_buffer(leaf, src + src_offset,
268 				    (unsigned long)data, copy_bytes);
269 		offset += copy_bytes;
270 		src_offset += copy_bytes;
271 		len -= copy_bytes;
272 
273 		btrfs_release_path(path);
274 		btrfs_end_transaction(trans);
275 	}
276 
277 	return ret;
278 }
279 
280 /*
281  * Read inode items of the given key type and offset from the btree.
282  *
283  * @inode:      inode to read items of
284  * @key_type:   key type to read
285  * @offset:     item offset to read from
286  * @dest:       Buffer to read into. This parameter has slightly tricky
287  *              semantics.  If it is NULL, the function will not do any copying
288  *              and will just return the size of all the items up to len bytes.
289  *              If dest_page is passed, then the function will kmap_local the
290  *              page and ignore dest, but it must still be non-NULL to avoid the
291  *              counting-only behavior.
292  * @len:        length in bytes to read
293  * @dest_folio: copy into this folio instead of the dest buffer
294  *
295  * Helper function to read items from the btree.  This returns the number of
296  * bytes read or < 0 for errors.  We can return short reads if the items don't
297  * exist on disk or aren't big enough to fill the desired length.  Supports
298  * reading into a provided buffer (dest) or into the page cache
299  *
300  * Returns number of bytes read or a negative error code on failure.
301  */
302 static int read_key_bytes(struct btrfs_inode *inode, u8 key_type, u64 offset,
303 			  char *dest, u64 len, struct folio *dest_folio)
304 {
305 	BTRFS_PATH_AUTO_FREE(path);
306 	struct btrfs_root *root = inode->root;
307 	struct extent_buffer *leaf;
308 	struct btrfs_key key;
309 	u64 item_end;
310 	u64 copy_end;
311 	int copied = 0;
312 	u32 copy_offset;
313 	unsigned long copy_bytes;
314 	unsigned long dest_offset = 0;
315 	void *data;
316 	char *kaddr = dest;
317 	int ret;
318 
319 	path = btrfs_alloc_path();
320 	if (!path)
321 		return -ENOMEM;
322 
323 	if (dest_folio)
324 		path->reada = READA_FORWARD;
325 
326 	key.objectid = btrfs_ino(inode);
327 	key.type = key_type;
328 	key.offset = offset;
329 
330 	ret = btrfs_search_slot(NULL, root, &key, path, 0, 0);
331 	if (ret < 0) {
332 		goto out;
333 	} else if (ret > 0) {
334 		ret = 0;
335 		if (path->slots[0] == 0)
336 			goto out;
337 		path->slots[0]--;
338 	}
339 
340 	while (len > 0) {
341 		leaf = path->nodes[0];
342 		btrfs_item_key_to_cpu(leaf, &key, path->slots[0]);
343 
344 		if (key.objectid != btrfs_ino(inode) || key.type != key_type)
345 			break;
346 
347 		item_end = btrfs_item_size(leaf, path->slots[0]) + key.offset;
348 
349 		if (copied > 0) {
350 			/*
351 			 * Once we've copied something, we want all of the items
352 			 * to be sequential
353 			 */
354 			if (key.offset != offset)
355 				break;
356 		} else {
357 			/*
358 			 * Our initial offset might be in the middle of an
359 			 * item.  Make sure it all makes sense.
360 			 */
361 			if (key.offset > offset)
362 				break;
363 			if (item_end <= offset)
364 				break;
365 		}
366 
367 		/* desc = NULL to just sum all the item lengths */
368 		if (!dest)
369 			copy_end = item_end;
370 		else
371 			copy_end = min(offset + len, item_end);
372 
373 		/* Number of bytes in this item we want to copy */
374 		copy_bytes = copy_end - offset;
375 
376 		/* Offset from the start of item for copying */
377 		copy_offset = offset - key.offset;
378 
379 		if (dest) {
380 			if (dest_folio)
381 				kaddr = kmap_local_folio(dest_folio, 0);
382 
383 			data = btrfs_item_ptr(leaf, path->slots[0], void);
384 			read_extent_buffer(leaf, kaddr + dest_offset,
385 					   (unsigned long)data + copy_offset,
386 					   copy_bytes);
387 
388 			if (dest_folio)
389 				kunmap_local(kaddr);
390 		}
391 
392 		offset += copy_bytes;
393 		dest_offset += copy_bytes;
394 		len -= copy_bytes;
395 		copied += copy_bytes;
396 
397 		path->slots[0]++;
398 		if (path->slots[0] >= btrfs_header_nritems(path->nodes[0])) {
399 			/*
400 			 * We've reached the last slot in this leaf and we need
401 			 * to go to the next leaf.
402 			 */
403 			ret = btrfs_next_leaf(root, path);
404 			if (ret < 0) {
405 				break;
406 			} else if (ret > 0) {
407 				ret = 0;
408 				break;
409 			}
410 		}
411 	}
412 out:
413 	if (!ret)
414 		ret = copied;
415 	return ret;
416 }
417 
418 /*
419  * Delete an fsverity orphan
420  *
421  * @trans:  transaction to do the delete in
422  * @inode:  inode to orphan
423  *
424  * Capture verity orphan specific logic that is repeated in the couple places
425  * we delete verity orphans. Specifically, handling ENOENT and ignoring inodes
426  * with 0 links.
427  *
428  * Returns zero on success or a negative error code on failure.
429  */
430 static int del_orphan(struct btrfs_trans_handle *trans, struct btrfs_inode *inode)
431 {
432 	struct btrfs_root *root = inode->root;
433 	int ret;
434 
435 	/*
436 	 * If the inode has no links, it is either already unlinked, or was
437 	 * created with O_TMPFILE. In either case, it should have an orphan from
438 	 * that other operation. Rather than reference count the orphans, we
439 	 * simply ignore them here, because we only invoke the verity path in
440 	 * the orphan logic when i_nlink is 1.
441 	 */
442 	if (!inode->vfs_inode.i_nlink)
443 		return 0;
444 
445 	ret = btrfs_del_orphan_item(trans, root, btrfs_ino(inode));
446 	if (ret == -ENOENT)
447 		ret = 0;
448 	return ret;
449 }
450 
451 /*
452  * Rollback in-progress verity if we encounter an error.
453  *
454  * @inode:  inode verity had an error for
455  *
456  * We try to handle recoverable errors while enabling verity by rolling it back
457  * and just failing the operation, rather than having an fs level error no
458  * matter what. However, any error in rollback is unrecoverable.
459  *
460  * Returns 0 on success, negative error code on failure.
461  */
462 static int rollback_verity(struct btrfs_inode *inode)
463 {
464 	struct btrfs_trans_handle *trans = NULL;
465 	struct btrfs_root *root = inode->root;
466 	int ret;
467 
468 	btrfs_assert_inode_locked(inode);
469 	truncate_inode_pages(inode->vfs_inode.i_mapping, inode->vfs_inode.i_size);
470 	clear_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags);
471 	ret = btrfs_drop_verity_items(inode);
472 	if (ret) {
473 		btrfs_handle_fs_error(root->fs_info, ret,
474 				"failed to drop verity items in rollback %llu",
475 				inode->vfs_inode.i_ino);
476 		goto out;
477 	}
478 
479 	/*
480 	 * 1 for updating the inode flag
481 	 * 1 for deleting the orphan
482 	 */
483 	trans = start_verity_cleanup_trans(root, 2);
484 	if (IS_ERR(trans)) {
485 		ret = PTR_ERR(trans);
486 		trans = NULL;
487 		btrfs_handle_fs_error(root->fs_info, ret,
488 			"failed to start transaction in verity rollback %llu",
489 			inode->vfs_inode.i_ino);
490 		goto out;
491 	}
492 	inode->ro_flags &= ~BTRFS_INODE_RO_VERITY;
493 	btrfs_sync_inode_flags_to_i_flags(inode);
494 	ret = btrfs_update_inode(trans, inode);
495 	if (unlikely(ret)) {
496 		btrfs_abort_transaction(trans, ret);
497 		goto out;
498 	}
499 	ret = del_orphan(trans, inode);
500 	if (unlikely(ret)) {
501 		btrfs_abort_transaction(trans, ret);
502 		goto out;
503 	}
504 out:
505 	if (trans)
506 		btrfs_end_transaction(trans);
507 	return ret;
508 }
509 
510 /*
511  * Finalize making the file a valid verity file
512  *
513  * @inode:      inode to be marked as verity
514  * @desc:       contents of the verity descriptor to write (not NULL)
515  * @desc_size:  size of the verity descriptor
516  *
517  * Do the actual work of finalizing verity after successfully writing the Merkle
518  * tree:
519  *
520  * - write out the descriptor items
521  * - mark the inode with the verity flag
522  * - delete the orphan item
523  * - mark the ro compat bit
524  * - clear the in progress bit
525  *
526  * Returns 0 on success, negative error code on failure.
527  */
528 static int finish_verity(struct btrfs_inode *inode, const void *desc,
529 			 size_t desc_size)
530 {
531 	struct btrfs_trans_handle *trans = NULL;
532 	struct btrfs_root *root = inode->root;
533 	struct btrfs_verity_descriptor_item item;
534 	int ret;
535 
536 	/* Write out the descriptor item */
537 	memset(&item, 0, sizeof(item));
538 	btrfs_set_stack_verity_descriptor_size(&item, desc_size);
539 	ret = write_key_bytes(inode, BTRFS_VERITY_DESC_ITEM_KEY, 0,
540 			      (const char *)&item, sizeof(item));
541 	if (ret)
542 		return ret;
543 
544 	/* Write out the descriptor itself */
545 	ret = write_key_bytes(inode, BTRFS_VERITY_DESC_ITEM_KEY, 1,
546 			      desc, desc_size);
547 	if (ret)
548 		return ret;
549 
550 	/*
551 	 * 1 for updating the inode flag
552 	 * 1 for deleting the orphan
553 	 */
554 	trans = btrfs_start_transaction(root, 2);
555 	if (IS_ERR(trans))
556 		return PTR_ERR(trans);
557 	inode->ro_flags |= BTRFS_INODE_RO_VERITY;
558 	btrfs_sync_inode_flags_to_i_flags(inode);
559 	ret = btrfs_update_inode(trans, inode);
560 	if (ret)
561 		goto end_trans;
562 	ret = del_orphan(trans, inode);
563 	if (ret)
564 		goto end_trans;
565 	clear_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags);
566 	btrfs_set_fs_compat_ro(root->fs_info, VERITY);
567 end_trans:
568 	btrfs_end_transaction(trans);
569 	return ret;
570 
571 }
572 
573 /*
574  * fsverity op that begins enabling verity.
575  *
576  * @filp:  file to enable verity on
577  *
578  * Begin enabling fsverity for the file. We drop any existing verity items, add
579  * an orphan and set the in progress bit.
580  *
581  * Returns 0 on success, negative error code on failure.
582  */
583 static int btrfs_begin_enable_verity(struct file *filp)
584 {
585 	struct btrfs_inode *inode = BTRFS_I(file_inode(filp));
586 	struct btrfs_root *root = inode->root;
587 	struct btrfs_trans_handle *trans;
588 	int ret;
589 
590 	btrfs_assert_inode_locked(inode);
591 
592 	if (IS_ENCRYPTED(&inode->vfs_inode))
593 		return -EOPNOTSUPP;
594 
595 	if (test_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags))
596 		return -EBUSY;
597 
598 	/*
599 	 * This should almost never do anything, but theoretically, it's
600 	 * possible that we failed to enable verity on a file, then were
601 	 * interrupted or failed while rolling back, failed to cleanup the
602 	 * orphan, and finally attempt to enable verity again.
603 	 */
604 	ret = btrfs_drop_verity_items(inode);
605 	if (ret)
606 		return ret;
607 
608 	/* 1 for the orphan item */
609 	trans = btrfs_start_transaction(root, 1);
610 	if (IS_ERR(trans))
611 		return PTR_ERR(trans);
612 
613 	ret = btrfs_orphan_add(trans, inode);
614 	if (!ret)
615 		set_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags);
616 	btrfs_end_transaction(trans);
617 
618 	return 0;
619 }
620 
621 /*
622  * fsverity op that ends enabling verity.
623  *
624  * @filp:              file we are finishing enabling verity on
625  * @desc:              verity descriptor to write out (NULL in error conditions)
626  * @desc_size:         size of the verity descriptor (variable with signatures)
627  * @merkle_tree_size:  size of the merkle tree in bytes
628  *
629  * If desc is null, then VFS is signaling an error occurred during verity
630  * enable, and we should try to rollback. Otherwise, attempt to finish verity.
631  *
632  * Returns 0 on success, negative error code on error.
633  */
634 static int btrfs_end_enable_verity(struct file *filp, const void *desc,
635 				   size_t desc_size, u64 merkle_tree_size)
636 {
637 	struct btrfs_inode *inode = BTRFS_I(file_inode(filp));
638 	int ret = 0;
639 	int rollback_ret;
640 
641 	btrfs_assert_inode_locked(inode);
642 
643 	if (desc == NULL)
644 		goto rollback;
645 
646 	ret = finish_verity(inode, desc, desc_size);
647 	if (ret)
648 		goto rollback;
649 	return ret;
650 
651 rollback:
652 	rollback_ret = rollback_verity(inode);
653 	if (rollback_ret)
654 		btrfs_err(inode->root->fs_info,
655 			  "failed to rollback verity items: %pe", ERR_PTR(rollback_ret));
656 	return ret;
657 }
658 
659 /*
660  * fsverity op that gets the struct fsverity_descriptor.
661  *
662  * @inode:     inode to get the descriptor of
663  * @buf:       output buffer for the descriptor contents
664  * @buf_size:  size of the output buffer. 0 to query the size
665  *
666  * fsverity does a two pass setup for reading the descriptor, in the first pass
667  * it calls with buf_size = 0 to query the size of the descriptor, and then in
668  * the second pass it actually reads the descriptor off disk.
669  *
670  * Returns the size on success or a negative error code on failure.
671  */
672 int btrfs_get_verity_descriptor(struct inode *inode, void *buf, size_t buf_size)
673 {
674 	u64 true_size;
675 	int ret = 0;
676 	struct btrfs_verity_descriptor_item item;
677 
678 	memset(&item, 0, sizeof(item));
679 	ret = read_key_bytes(BTRFS_I(inode), BTRFS_VERITY_DESC_ITEM_KEY, 0,
680 			     (char *)&item, sizeof(item), NULL);
681 	if (ret < 0)
682 		return ret;
683 
684 	if (unlikely(item.reserved[0] != 0 || item.reserved[1] != 0))
685 		return -EUCLEAN;
686 
687 	true_size = btrfs_stack_verity_descriptor_size(&item);
688 	if (unlikely(true_size > INT_MAX))
689 		return -EUCLEAN;
690 
691 	if (buf_size == 0)
692 		return true_size;
693 	if (buf_size < true_size)
694 		return -ERANGE;
695 
696 	ret = read_key_bytes(BTRFS_I(inode), BTRFS_VERITY_DESC_ITEM_KEY, 1,
697 			     buf, buf_size, NULL);
698 	if (ret < 0)
699 		return ret;
700 	if (ret != true_size)
701 		return -EIO;
702 
703 	return true_size;
704 }
705 
706 /*
707  * fsverity op that reads and caches a merkle tree page.
708  *
709  * @inode:         inode to read a merkle tree page for
710  * @index:         page index relative to the start of the merkle tree
711  *
712  * The Merkle tree is stored in the filesystem btree, but its pages are cached
713  * with a logical position past EOF in the inode's mapping.
714  *
715  * Returns the page we read, or an ERR_PTR on error.
716  */
717 static struct page *btrfs_read_merkle_tree_page(struct inode *inode,
718 						pgoff_t index)
719 {
720 	struct folio *folio;
721 	u64 off = (u64)index << PAGE_SHIFT;
722 	loff_t merkle_pos = merkle_file_pos(inode);
723 	int ret;
724 
725 	if (merkle_pos < 0)
726 		return ERR_PTR(merkle_pos);
727 	if (merkle_pos > inode->i_sb->s_maxbytes - off - PAGE_SIZE)
728 		return ERR_PTR(-EFBIG);
729 	index += merkle_pos >> PAGE_SHIFT;
730 again:
731 	folio = __filemap_get_folio(inode->i_mapping, index, FGP_ACCESSED, 0);
732 	if (!IS_ERR(folio)) {
733 		if (folio_test_uptodate(folio))
734 			goto out;
735 
736 		folio_lock(folio);
737 		/* Folio was truncated from mapping. */
738 		if (!folio->mapping) {
739 			folio_unlock(folio);
740 			folio_put(folio);
741 			goto again;
742 		}
743 		/* Another reader may have filled the folio while we waited. */
744 		if (folio_test_uptodate(folio)) {
745 			folio_unlock(folio);
746 			goto out;
747 		}
748 		goto read_folio;
749 	}
750 
751 	folio = filemap_alloc_folio(mapping_gfp_constraint(inode->i_mapping, ~__GFP_FS),
752 				    0, NULL);
753 	if (!folio)
754 		return ERR_PTR(-ENOMEM);
755 
756 	ret = filemap_add_folio(inode->i_mapping, folio, index, GFP_NOFS);
757 	if (ret) {
758 		folio_put(folio);
759 		/* Did someone else insert a folio here? */
760 		if (ret == -EEXIST)
761 			goto again;
762 		return ERR_PTR(ret);
763 	}
764 
765 read_folio:
766 	/*
767 	 * Merkle item keys are indexed from byte 0 in the merkle tree.
768 	 * They have the form:
769 	 *
770 	 * [ inode objectid, BTRFS_MERKLE_ITEM_KEY, offset in bytes ]
771 	 */
772 	ret = read_key_bytes(BTRFS_I(inode), BTRFS_VERITY_MERKLE_ITEM_KEY, off,
773 			     folio_address(folio), PAGE_SIZE, folio);
774 	if (ret < 0) {
775 		folio_unlock(folio);
776 		folio_put(folio);
777 		return ERR_PTR(ret);
778 	}
779 	if (ret < PAGE_SIZE)
780 		folio_zero_segment(folio, ret, PAGE_SIZE);
781 
782 	folio_mark_uptodate(folio);
783 	folio_unlock(folio);
784 
785 out:
786 	return folio_file_page(folio, index);
787 }
788 
789 /*
790  * fsverity op that writes a Merkle tree block into the btree.
791  *
792  * @file:	file to write a Merkle tree block for
793  * @buf:	Merkle tree block to write
794  * @pos:	the position of the block in the Merkle tree (in bytes)
795  * @size:	the Merkle tree block size (in bytes)
796  *
797  * Returns 0 on success or negative error code on failure
798  */
799 static int btrfs_write_merkle_tree_block(struct file *file, const void *buf,
800 					 u64 pos, unsigned int size)
801 {
802 	struct inode *inode = file_inode(file);
803 	loff_t merkle_pos = merkle_file_pos(inode);
804 
805 	if (merkle_pos < 0)
806 		return merkle_pos;
807 	if (merkle_pos > inode->i_sb->s_maxbytes - pos - size)
808 		return -EFBIG;
809 
810 	return write_key_bytes(BTRFS_I(inode), BTRFS_VERITY_MERKLE_ITEM_KEY,
811 			       pos, buf, size);
812 }
813 
814 const struct fsverity_operations btrfs_verityops = {
815 	.begin_enable_verity     = btrfs_begin_enable_verity,
816 	.end_enable_verity       = btrfs_end_enable_verity,
817 	.get_verity_descriptor   = btrfs_get_verity_descriptor,
818 	.read_merkle_tree_page   = btrfs_read_merkle_tree_page,
819 	.write_merkle_tree_block = btrfs_write_merkle_tree_block,
820 };
821