xref: /linux/fs/btrfs/verity.c (revision bb29b957eaaa15be33243550d9ee576c2d601669)
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  * @len:        length in bytes to read
290  *
291  * Helper function to read items from the btree.  This returns the number of
292  * bytes read or < 0 for errors.  We can return short reads if the items don't
293  * exist on disk or aren't big enough to fill the desired length.  Supports
294  * reading into a provided buffer (dest).
295  *
296  * Returns number of bytes read or a negative error code on failure.
297  */
298 static int read_key_bytes(struct btrfs_inode *inode, u8 key_type, u64 offset,
299 			  char *dest, u64 len)
300 {
301 	BTRFS_PATH_AUTO_FREE(path);
302 	struct btrfs_root *root = inode->root;
303 	struct extent_buffer *leaf;
304 	struct btrfs_key key;
305 	u64 item_end;
306 	u64 copy_end;
307 	int copied = 0;
308 	u32 copy_offset;
309 	unsigned long copy_bytes;
310 	unsigned long dest_offset = 0;
311 	void *data;
312 	char *kaddr = dest;
313 	int ret;
314 
315 	path = btrfs_alloc_path();
316 	if (!path)
317 		return -ENOMEM;
318 
319 	/*
320 	 * Merkle items can be large and split across multiple items, so enable
321 	 * readahead for such cases.
322 	 */
323 	if (key_type == BTRFS_VERITY_MERKLE_ITEM_KEY)
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 		/* dest == 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 			data = btrfs_item_ptr(leaf, path->slots[0], void);
381 			read_extent_buffer(leaf, kaddr + dest_offset,
382 					   (unsigned long)data + copy_offset,
383 					   copy_bytes);
384 		}
385 
386 		offset += copy_bytes;
387 		dest_offset += copy_bytes;
388 		len -= copy_bytes;
389 		copied += copy_bytes;
390 
391 		path->slots[0]++;
392 		if (path->slots[0] >= btrfs_header_nritems(path->nodes[0])) {
393 			/*
394 			 * We've reached the last slot in this leaf and we need
395 			 * to go to the next leaf.
396 			 */
397 			ret = btrfs_next_leaf(root, path);
398 			if (ret < 0) {
399 				break;
400 			} else if (ret > 0) {
401 				ret = 0;
402 				break;
403 			}
404 		}
405 	}
406 out:
407 	if (!ret)
408 		ret = copied;
409 	return ret;
410 }
411 
412 /*
413  * Delete an fsverity orphan
414  *
415  * @trans:  transaction to do the delete in
416  * @inode:  inode to orphan
417  *
418  * Capture verity orphan specific logic that is repeated in the couple places
419  * we delete verity orphans. Specifically, handling ENOENT and ignoring inodes
420  * with 0 links.
421  *
422  * Returns zero on success or a negative error code on failure.
423  */
424 static int del_orphan(struct btrfs_trans_handle *trans, struct btrfs_inode *inode)
425 {
426 	struct btrfs_root *root = inode->root;
427 	int ret;
428 
429 	/*
430 	 * If the inode has no links, it is either already unlinked, or was
431 	 * created with O_TMPFILE. In either case, it should have an orphan from
432 	 * that other operation. Rather than reference count the orphans, we
433 	 * simply ignore them here, because we only invoke the verity path in
434 	 * the orphan logic when i_nlink is 1.
435 	 */
436 	if (!inode->vfs_inode.i_nlink)
437 		return 0;
438 
439 	ret = btrfs_del_orphan_item(trans, root, btrfs_ino(inode));
440 	if (ret == -ENOENT)
441 		ret = 0;
442 	return ret;
443 }
444 
445 /*
446  * Rollback in-progress verity if we encounter an error.
447  *
448  * @inode:  inode verity had an error for
449  *
450  * We try to handle recoverable errors while enabling verity by rolling it back
451  * and just failing the operation, rather than having an fs level error no
452  * matter what. However, any error in rollback is unrecoverable.
453  *
454  * Returns 0 on success, negative error code on failure.
455  */
456 static int rollback_verity(struct btrfs_inode *inode)
457 {
458 	struct btrfs_trans_handle *trans = NULL;
459 	struct btrfs_root *root = inode->root;
460 	int ret;
461 
462 	btrfs_assert_inode_locked(inode);
463 	truncate_inode_pages(inode->vfs_inode.i_mapping, inode->vfs_inode.i_size);
464 	clear_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags);
465 	ret = btrfs_drop_verity_items(inode);
466 	if (ret) {
467 		btrfs_handle_fs_error(root->fs_info, ret,
468 				"failed to drop verity items in rollback %llu",
469 				inode->vfs_inode.i_ino);
470 		goto out;
471 	}
472 
473 	/*
474 	 * 1 for updating the inode flag
475 	 * 1 for deleting the orphan
476 	 */
477 	trans = start_verity_cleanup_trans(root, 2);
478 	if (IS_ERR(trans)) {
479 		ret = PTR_ERR(trans);
480 		trans = NULL;
481 		btrfs_handle_fs_error(root->fs_info, ret,
482 			"failed to start transaction in verity rollback %llu",
483 			inode->vfs_inode.i_ino);
484 		goto out;
485 	}
486 	inode->ro_flags &= ~BTRFS_INODE_RO_VERITY;
487 	btrfs_sync_inode_flags_to_i_flags(inode);
488 	ret = btrfs_update_inode(trans, inode);
489 	if (unlikely(ret)) {
490 		btrfs_abort_transaction(trans, ret);
491 		goto out;
492 	}
493 	ret = del_orphan(trans, inode);
494 	if (unlikely(ret)) {
495 		btrfs_abort_transaction(trans, ret);
496 		goto out;
497 	}
498 out:
499 	if (trans)
500 		btrfs_end_transaction(trans);
501 	return ret;
502 }
503 
504 /*
505  * Finalize making the file a valid verity file
506  *
507  * @inode:      inode to be marked as verity
508  * @desc:       contents of the verity descriptor to write (not NULL)
509  * @desc_size:  size of the verity descriptor
510  *
511  * Do the actual work of finalizing verity after successfully writing the Merkle
512  * tree:
513  *
514  * - write out the descriptor items
515  * - mark the inode with the verity flag
516  * - delete the orphan item
517  * - mark the ro compat bit
518  * - clear the in progress bit
519  *
520  * Returns 0 on success, negative error code on failure.
521  */
522 static int finish_verity(struct btrfs_inode *inode, const void *desc,
523 			 size_t desc_size)
524 {
525 	struct btrfs_trans_handle *trans = NULL;
526 	struct btrfs_root *root = inode->root;
527 	struct btrfs_verity_descriptor_item item;
528 	int ret;
529 
530 	/* Write out the descriptor item */
531 	memset(&item, 0, sizeof(item));
532 	btrfs_set_stack_verity_descriptor_size(&item, desc_size);
533 	ret = write_key_bytes(inode, BTRFS_VERITY_DESC_ITEM_KEY, 0,
534 			      (const char *)&item, sizeof(item));
535 	if (ret)
536 		return ret;
537 
538 	/* Write out the descriptor itself */
539 	ret = write_key_bytes(inode, BTRFS_VERITY_DESC_ITEM_KEY, 1,
540 			      desc, desc_size);
541 	if (ret)
542 		return ret;
543 
544 	/*
545 	 * 1 for updating the inode flag
546 	 * 1 for deleting the orphan
547 	 */
548 	trans = btrfs_start_transaction(root, 2);
549 	if (IS_ERR(trans))
550 		return PTR_ERR(trans);
551 	inode->ro_flags |= BTRFS_INODE_RO_VERITY;
552 	btrfs_sync_inode_flags_to_i_flags(inode);
553 	ret = btrfs_update_inode(trans, inode);
554 	if (ret)
555 		goto end_trans;
556 	ret = del_orphan(trans, inode);
557 	if (ret)
558 		goto end_trans;
559 	clear_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags);
560 	btrfs_set_fs_compat_ro(root->fs_info, VERITY);
561 end_trans:
562 	btrfs_end_transaction(trans);
563 	return ret;
564 
565 }
566 
567 /*
568  * fsverity op that begins enabling verity.
569  *
570  * @filp:  file to enable verity on
571  *
572  * Begin enabling fsverity for the file. We drop any existing verity items, add
573  * an orphan and set the in progress bit.
574  *
575  * Returns 0 on success, negative error code on failure.
576  */
577 static int btrfs_begin_enable_verity(struct file *filp)
578 {
579 	struct btrfs_inode *inode = BTRFS_I(file_inode(filp));
580 	struct btrfs_root *root = inode->root;
581 	struct btrfs_trans_handle *trans;
582 	int ret;
583 
584 	btrfs_assert_inode_locked(inode);
585 
586 	if (IS_ENCRYPTED(&inode->vfs_inode))
587 		return -EOPNOTSUPP;
588 
589 	if (test_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags))
590 		return -EBUSY;
591 
592 	/*
593 	 * This should almost never do anything, but theoretically, it's
594 	 * possible that we failed to enable verity on a file, then were
595 	 * interrupted or failed while rolling back, failed to cleanup the
596 	 * orphan, and finally attempt to enable verity again.
597 	 */
598 	ret = btrfs_drop_verity_items(inode);
599 	if (ret)
600 		return ret;
601 
602 	/* 1 for the orphan item */
603 	trans = btrfs_start_transaction(root, 1);
604 	if (IS_ERR(trans))
605 		return PTR_ERR(trans);
606 
607 	ret = btrfs_orphan_add(trans, inode);
608 	if (!ret)
609 		set_bit(BTRFS_INODE_VERITY_IN_PROGRESS, &inode->runtime_flags);
610 	btrfs_end_transaction(trans);
611 
612 	return 0;
613 }
614 
615 /*
616  * fsverity op that ends enabling verity.
617  *
618  * @filp:              file we are finishing enabling verity on
619  * @desc:              verity descriptor to write out (NULL in error conditions)
620  * @desc_size:         size of the verity descriptor (variable with signatures)
621  * @merkle_tree_size:  size of the merkle tree in bytes
622  *
623  * If desc is null, then VFS is signaling an error occurred during verity
624  * enable, and we should try to rollback. Otherwise, attempt to finish verity.
625  *
626  * Returns 0 on success, negative error code on error.
627  */
628 static int btrfs_end_enable_verity(struct file *filp, const void *desc,
629 				   size_t desc_size, u64 merkle_tree_size)
630 {
631 	struct btrfs_inode *inode = BTRFS_I(file_inode(filp));
632 	int ret = 0;
633 	int rollback_ret;
634 
635 	btrfs_assert_inode_locked(inode);
636 
637 	if (desc == NULL)
638 		goto rollback;
639 
640 	ret = finish_verity(inode, desc, desc_size);
641 	if (ret)
642 		goto rollback;
643 	return ret;
644 
645 rollback:
646 	rollback_ret = rollback_verity(inode);
647 	if (rollback_ret)
648 		btrfs_err(inode->root->fs_info,
649 			  "failed to rollback verity items: %pe", ERR_PTR(rollback_ret));
650 	return ret;
651 }
652 
653 /*
654  * fsverity op that gets the struct fsverity_descriptor.
655  *
656  * @inode:     inode to get the descriptor of
657  * @buf:       output buffer for the descriptor contents
658  * @buf_size:  size of the output buffer. 0 to query the size
659  *
660  * fsverity does a two pass setup for reading the descriptor, in the first pass
661  * it calls with buf_size = 0 to query the size of the descriptor, and then in
662  * the second pass it actually reads the descriptor off disk.
663  *
664  * Returns the size on success or a negative error code on failure.
665  */
666 int btrfs_get_verity_descriptor(struct inode *inode, void *buf, size_t buf_size)
667 {
668 	u64 true_size;
669 	int ret = 0;
670 	struct btrfs_verity_descriptor_item item;
671 
672 	memset(&item, 0, sizeof(item));
673 	ret = read_key_bytes(BTRFS_I(inode), BTRFS_VERITY_DESC_ITEM_KEY, 0,
674 			     (char *)&item, sizeof(item));
675 	if (ret < 0)
676 		return ret;
677 
678 	if (unlikely(item.reserved[0] != 0 || item.reserved[1] != 0))
679 		return -EUCLEAN;
680 
681 	true_size = btrfs_stack_verity_descriptor_size(&item);
682 	if (unlikely(true_size > INT_MAX))
683 		return -EUCLEAN;
684 
685 	if (buf_size == 0)
686 		return true_size;
687 	if (buf_size < true_size)
688 		return -ERANGE;
689 
690 	ret = read_key_bytes(BTRFS_I(inode), BTRFS_VERITY_DESC_ITEM_KEY, 1,
691 			     buf, buf_size);
692 	if (ret < 0)
693 		return ret;
694 	if (ret != true_size)
695 		return -EIO;
696 
697 	return true_size;
698 }
699 
700 /*
701  * fsverity op that reads and caches a merkle tree page.
702  *
703  * @inode:         inode to read a merkle tree page for
704  * @index:         page index relative to the start of the merkle tree
705  *
706  * The Merkle tree is stored in the filesystem btree, but its pages are cached
707  * with a logical position past EOF in the inode's mapping.
708  *
709  * Returns the page we read, or an ERR_PTR on error.
710  */
711 static struct page *btrfs_read_merkle_tree_page(struct inode *inode,
712 						pgoff_t index)
713 {
714 	struct folio *folio;
715 	u64 off = (u64)index << PAGE_SHIFT;
716 	loff_t merkle_pos = merkle_file_pos(inode);
717 	void *kaddr;
718 	int ret;
719 
720 	if (merkle_pos < 0)
721 		return ERR_PTR(merkle_pos);
722 	if (merkle_pos > inode->i_sb->s_maxbytes - off - PAGE_SIZE)
723 		return ERR_PTR(-EFBIG);
724 	index += merkle_pos >> PAGE_SHIFT;
725 again:
726 	folio = __filemap_get_folio(inode->i_mapping, index, FGP_ACCESSED, 0);
727 	if (!IS_ERR(folio)) {
728 		if (folio_test_uptodate(folio))
729 			goto out;
730 
731 		folio_lock(folio);
732 		/* Folio was truncated from mapping. */
733 		if (!folio->mapping) {
734 			folio_unlock(folio);
735 			folio_put(folio);
736 			goto again;
737 		}
738 		/* Another reader may have filled the folio while we waited. */
739 		if (folio_test_uptodate(folio)) {
740 			folio_unlock(folio);
741 			goto out;
742 		}
743 		goto read_folio;
744 	}
745 
746 	folio = filemap_alloc_folio(mapping_gfp_constraint(inode->i_mapping, ~__GFP_FS),
747 				    0, NULL);
748 	if (!folio)
749 		return ERR_PTR(-ENOMEM);
750 
751 	ret = filemap_add_folio(inode->i_mapping, folio, index, GFP_NOFS);
752 	if (ret) {
753 		folio_put(folio);
754 		/* Did someone else insert a folio here? */
755 		if (ret == -EEXIST)
756 			goto again;
757 		return ERR_PTR(ret);
758 	}
759 
760 read_folio:
761 	kaddr = kmap_local_folio(folio, 0);
762 	/*
763 	 * Merkle item keys are indexed from byte 0 in the merkle tree.
764 	 * They have the form:
765 	 *
766 	 * [ inode objectid, BTRFS_MERKLE_ITEM_KEY, offset in bytes ]
767 	 */
768 	ret = read_key_bytes(BTRFS_I(inode), BTRFS_VERITY_MERKLE_ITEM_KEY, off,
769 			     kaddr, PAGE_SIZE);
770 	kunmap_local(kaddr);
771 	if (ret < 0) {
772 		folio_unlock(folio);
773 		folio_put(folio);
774 		return ERR_PTR(ret);
775 	}
776 	if (ret < PAGE_SIZE)
777 		folio_zero_segment(folio, ret, PAGE_SIZE);
778 
779 	folio_mark_uptodate(folio);
780 	folio_unlock(folio);
781 
782 out:
783 	return folio_file_page(folio, index);
784 }
785 
786 /*
787  * fsverity op that writes a Merkle tree block into the btree.
788  *
789  * @file:	file to write a Merkle tree block for
790  * @buf:	Merkle tree block to write
791  * @pos:	the position of the block in the Merkle tree (in bytes)
792  * @size:	the Merkle tree block size (in bytes)
793  * @zero_digest:	the hash of the all-zeroes block
794  * @digest_size:	size of zero_digest, in bytes
795  *
796  * Returns 0 on success or negative error code on failure
797  */
798 static int btrfs_write_merkle_tree_block(struct file *file, const void *buf,
799 					 u64 pos, unsigned int size,
800 					 const u8 *zero_digest,
801 					 unsigned int digest_size)
802 {
803 	struct inode *inode = file_inode(file);
804 	loff_t merkle_pos = merkle_file_pos(inode);
805 
806 	if (merkle_pos < 0)
807 		return merkle_pos;
808 	if (merkle_pos > inode->i_sb->s_maxbytes - pos - size)
809 		return -EFBIG;
810 
811 	return write_key_bytes(BTRFS_I(inode), BTRFS_VERITY_MERKLE_ITEM_KEY,
812 			       pos, buf, size);
813 }
814 
815 const struct fsverity_operations btrfs_verityops = {
816 	.begin_enable_verity     = btrfs_begin_enable_verity,
817 	.end_enable_verity       = btrfs_end_enable_verity,
818 	.get_verity_descriptor   = btrfs_get_verity_descriptor,
819 	.read_merkle_tree_page   = btrfs_read_merkle_tree_page,
820 	.write_merkle_tree_block = btrfs_write_merkle_tree_block,
821 };
822