tests/generic/575

#! /bin/bash
# SPDX-License-Identifier: GPL-2.0
# Copyright 2018 Google LLC
#
# FS QA Test generic/575
#
# Test that fs-verity is using the correct file digest values.  This test
# verifies that fs-verity is doing its Merkle tree-based hashing correctly,
# i.e. that it hasn't been broken by a change.
#
. ./common/preamble
_begin_fstest auto quick verity

# Override the default cleanup function.
_cleanup()
{
	cd /
	_restore_fsverity_signatures
	rm -f $tmp.*
}

# Import common functions.
. ./common/filter
. ./common/verity

_require_scratch_verity
_disable_fsverity_signatures

_scratch_mkfs_verity &>> $seqres.full
_scratch_mount
fsv_orig_file=$SCRATCH_MNT/file
fsv_file=$SCRATCH_MNT/file.fsv

# Try multiple hash algorithms.
algs=(sha256 sha512)

# Try multiple Merkle tree block sizes.
block_sizes=(1024 4096)

# Try files with 0, 1, and multiple Merkle tree levels.
file_sizes=(0 4096 65536 65536 100000000)

# Try both unsalted and salted, and check that empty salt is the same as no salt
salts=('' '' '' '--salt=' '--salt=f3c93fa6fb828c0e1587e5714ecf6f56')

# The expected file digests are here rather than in the expected output file
# because the kernel might not support all hash algorithms and block sizes.
sha256_vals_bsize1024=(
sha256:f2cca36b9b1b7f07814e4284b10121809133e7cb9c4528c8f6846e85fc624ffa
sha256:ea08590a4fe9c3d6c9dafe0eedacd9dffff8f24e24f1865ee3af132a495ab087
sha256:527496288d703686e31092f5cca7e1306b2467f00b247ad01056ee5ec35a4bb9
sha256:527496288d703686e31092f5cca7e1306b2467f00b247ad01056ee5ec35a4bb9
sha256:087818b23312acb15dff9ff6e2b4f601406d08bb36013542444cc15248f47016
)
sha256_vals_bsize4096=(
sha256:3d248ca542a24fc62d1c43b916eae5016878e2533c88238480b26128a1f1af95
sha256:babc284ee4ffe7f449377fbf6692715b43aec7bc39c094a95878904d34bac97e
sha256:011e3f2b1dc89b75d78cddcc2a1b85cd8a64b2883e5f20f277ae4c0617e0404f
sha256:011e3f2b1dc89b75d78cddcc2a1b85cd8a64b2883e5f20f277ae4c0617e0404f
sha256:9d33cab743468fcbe4edab91a275b30dd543c12dd5e6ce6f2f737f66a1558f06
)
sha512_vals_bsize1024=(
sha512:8451664f25b2ad3f24391280e0c5681cb843389c180baa719f8fdfb063f5ddfa2d1c4433e55e2b6fbb3ba6aa2df8a4f41bf56cb7e0a3b617b6919a42c80f034c
sha512:ab3c6444ab377bbe54c604c26cad241b146d85dc29727703a0d8134f70a8172fb3fa67d171355106b69cc0a9e7e9debb335f9461b3aba44093914867f7c73233
sha512:e6a11353c24dd7b4603cb8ffa50a7041dbea7382d4698474ccbc2d8b34f3a83d8bf16df25c64ed31ee27213a8a3cbd001fb1ccde46384c23b81305c2393c1046
sha512:e6a11353c24dd7b4603cb8ffa50a7041dbea7382d4698474ccbc2d8b34f3a83d8bf16df25c64ed31ee27213a8a3cbd001fb1ccde46384c23b81305c2393c1046
sha512:517d573bd50d5f3787f5766c2ac60c7af854b0901b69757b4ef8dd70aa6b30fcc10d81629ce923bdd062a01c20fad0f063a081a2f3b0814ac06547b26bedc0d9
)
sha512_vals_bsize4096=(
sha512:ccf9e5aea1c2a64efa2f2354a6024b90dffde6bbc017825045dce374474e13d10adb9dadcc6ca8e17a3c075fbd31336e8f266ae6fa93a6c3bed66f9e784e5abf
sha512:928922686c4caf32175f5236a7f964e9925d10a74dc6d8344a8bd08b23c228ff5792573987d7895f628f39c4f4ebe39a7367d7aeb16aaa0cd324ac1d53664e61
sha512:eab7224ce374a0a4babcb2db25e24836247f38b87806ad9be9e5ba4daac2f5b814fc0cbdfd9f1f8499b3c9a6c1b38fe08974cce49883ab4ccd04462fd2f9507f
sha512:eab7224ce374a0a4babcb2db25e24836247f38b87806ad9be9e5ba4daac2f5b814fc0cbdfd9f1f8499b3c9a6c1b38fe08974cce49883ab4ccd04462fd2f9507f
sha512:f7083a38644880d25539488313e9e5b41a4d431a0e383945129ad2c36e3c1d0f28928a424641bb1363c12b6e770578102566acea73baf1ce8ee15336f5ba2446
)

test_alg_with_block_size()
{
	local alg=$1
	local block_size=$2
	local -n vals=${alg}_vals_bsize${block_size}
	local i
	local file_size
	local expected actual salt_arg

	_fsv_scratch_begin_subtest "Testing alg=$alg, block_size=$block_size if supported"

	if ! _fsv_can_enable $fsv_file --hash-alg=$alg --block-size=$block_size
	then
		# Since this is after _require_scratch_verity, sha256 with
		# FSV_BLOCK_SIZE must be supported.
		if [ "$alg" = "sha256" -a "$block_size" = "$FSV_BLOCK_SIZE" ]
		then
			_fail "Failed to enable verity with default params"
		fi
		# This combination of parameters is unsupported; skip it.
		echo "alg=$alg, block_size=$block_size is unsupported" >> $seqres.full
		return 0
	fi

	for i in ${!file_sizes[@]}; do
		file_size=${file_sizes[$i]}
		expected=${vals[$i]}
		salt_arg=${salts[$i]}

		head -c $file_size /dev/zero > $fsv_orig_file
		cp $fsv_orig_file $fsv_file
		_fsv_enable $fsv_file --hash-alg=$alg --block-size=$block_size \
			$salt_arg
		actual=$(_fsv_measure $fsv_file)
		if [ "$actual" != "$expected" ]; then
			echo "Mismatch: expected $expected, kernel calculated $actual (file_size=$file_size)"
		fi
		cmp $fsv_orig_file $fsv_file
		rm -f $fsv_file
	done
}

for alg in ${algs[@]}; do
	for block_size in ${block_sizes[@]}; do
		test_alg_with_block_size $alg $block_size
	done
done

# success, all done
status=0
exit