generic: add basic test for fscrypt API additions

Add a basic test of the fscrypt filesystem-level encryption keyring and
v2 encryption policies.

Signed-off-by: Eric Biggers <ebiggers@google.com>
Reviewed-by: Eryu Guan <guaneryu@gmail.com>
Signed-off-by: Eryu Guan <guaneryu@gmail.com>

diff --git a/tests/generic/580 b/tests/generic/580
new file mode 100755 (executable)
index 0000000..d0b0e9b
--- /dev/null
+++ b/tests/generic/580
@@ -0,0 +1,127 @@
+#! /bin/bash
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2019 Google LLC
+#
+# FS QA Test generic/580
+#
+# Basic test of the fscrypt filesystem-level encryption keyring
+# and v2 encryption policies.
+#
+
+seq=`basename $0`
+seqres=$RESULT_DIR/$seq
+echo "QA output created by $seq"
+echo
+
+here=`pwd`
+tmp=/tmp/$$
+status=1       # failure is the default!
+trap "_cleanup; exit \$status" 0 1 2 3 15
+
+_cleanup()
+{
+       cd /
+       rm -f $tmp.*
+}
+
+# get standard environment, filters and checks
+. ./common/rc
+. ./common/filter
+. ./common/encrypt
+
+# remove previous $seqres.full before test
+rm -f $seqres.full
+
+# real QA test starts here
+_supported_fs generic
+_supported_os Linux
+_require_scratch_encryption -v 2
+
+_scratch_mkfs_encrypted &>> $seqres.full
+_scratch_mount
+
+test_with_policy_version()
+{
+       local vers=$1
+       local raw_key=""
+       local i
+
+       for i in {1..64}; do
+               raw_key+="\\x$(printf "%02x" $i)"
+       done
+
+       if (( vers == 1 )); then
+               # Key descriptor: arbitrary value
+               local keyspec="0000111122223333"
+               local add_enckey_args="-d $keyspec"
+       else
+               # Key identifier:
+               # HKDF-SHA512(key=raw_key, salt="", info="fscrypt\0\x01")
+               local keyspec="69b2f6edeee720cce0577937eb8a6751"
+               local add_enckey_args=""
+       fi
+
+       mkdir $dir
+       echo "# Setting v$vers encryption policy"
+       _set_encpolicy $dir $keyspec
+       echo "# Getting v$vers encryption policy"
+       _get_encpolicy $dir | _filter_scratch
+       if (( vers == 1 )); then
+               echo "# Getting v1 encryption policy using old ioctl"
+               _get_encpolicy $dir -1 | _filter_scratch
+       fi
+       echo "# Trying to create file without key added yet"
+       $XFS_IO_PROG -f $dir/file |& _filter_scratch
+       echo "# Getting encryption key status"
+       _enckey_status $SCRATCH_MNT $keyspec
+       echo "# Adding encryption key"
+       _add_enckey $SCRATCH_MNT "$raw_key" $add_enckey_args
+       echo "# Creating encrypted file"
+       echo contents > $dir/file
+       echo "# Getting encryption key status"
+       _enckey_status $SCRATCH_MNT $keyspec
+       echo "# Removing encryption key"
+       _rm_enckey $SCRATCH_MNT $keyspec
+       echo "# Getting encryption key status"
+       _enckey_status $SCRATCH_MNT $keyspec
+       echo "# Verifying that the encrypted directory was \"locked\""
+       cat $dir/file |& _filter_scratch
+       cat "$(find $dir -type f)" |& _filter_scratch | cut -d ' ' -f3-
+
+       # Test removing key with a file open.
+       echo "# Re-adding encryption key"
+       _add_enckey $SCRATCH_MNT "$raw_key" $add_enckey_args
+       echo "# Creating another encrypted file"
+       echo foo > $dir/file2
+       echo "# Removing key while an encrypted file is open"
+       exec 3< $dir/file
+       _rm_enckey $SCRATCH_MNT $keyspec
+       echo "# Non-open file should have been evicted"
+       cat $dir/file2 |& _filter_scratch
+       echo "# Open file shouldn't have been evicted"
+       cat $dir/file
+       echo "# Key should be in \"incompletely removed\" state"
+       _enckey_status $SCRATCH_MNT $keyspec
+       echo "# Closing file and removing key for real now"
+       exec 3<&-
+       _rm_enckey $SCRATCH_MNT $keyspec
+       cat $dir/file |& _filter_scratch
+
+       echo "# Cleaning up"
+       rm -rf $dir
+       _scratch_cycle_mount    # Clear all keys
+       echo
+}
+
+dir=$SCRATCH_MNT/dir
+
+test_with_policy_version 1
+
+test_with_policy_version 2
+
+echo "# Trying to remove absent key"
+_rm_enckey $SCRATCH_MNT abcdabcdabcdabcd
+
+# success, all done
+status=0
+exit

diff --git a/tests/generic/580.out b/tests/generic/580.out
new file mode 100644 (file)
index 0000000..989d451
--- /dev/null
+++ b/tests/generic/580.out
@@ -0,0 +1,91 @@
+QA output created by 580
+
+# Setting v1 encryption policy
+# Getting v1 encryption policy
+Encryption policy for SCRATCH_MNT/dir:
+       Policy version: 0
+       Master key descriptor: 0000111122223333
+       Contents encryption mode: 1 (AES-256-XTS)
+       Filenames encryption mode: 4 (AES-256-CTS)
+       Flags: 0x02
+# Getting v1 encryption policy using old ioctl
+Encryption policy for SCRATCH_MNT/dir:
+       Policy version: 0
+       Master key descriptor: 0000111122223333
+       Contents encryption mode: 1 (AES-256-XTS)
+       Filenames encryption mode: 4 (AES-256-CTS)
+       Flags: 0x02
+# Trying to create file without key added yet
+SCRATCH_MNT/dir/file: Required key not available
+# Getting encryption key status
+Absent
+# Adding encryption key
+Added encryption key with descriptor 0000111122223333
+# Creating encrypted file
+# Getting encryption key status
+Present
+# Removing encryption key
+Removed encryption key with descriptor 0000111122223333
+# Getting encryption key status
+Absent
+# Verifying that the encrypted directory was "locked"
+cat: SCRATCH_MNT/dir/file: No such file or directory
+Required key not available
+# Re-adding encryption key
+Added encryption key with descriptor 0000111122223333
+# Creating another encrypted file
+# Removing key while an encrypted file is open
+Removed encryption key with descriptor 0000111122223333, but files still busy
+# Non-open file should have been evicted
+cat: SCRATCH_MNT/dir/file2: Required key not available
+# Open file shouldn't have been evicted
+contents
+# Key should be in "incompletely removed" state
+Incompletely removed
+# Closing file and removing key for real now
+Removed encryption key with descriptor 0000111122223333
+cat: SCRATCH_MNT/dir/file: No such file or directory
+# Cleaning up
+
+# Setting v2 encryption policy
+# Getting v2 encryption policy
+Encryption policy for SCRATCH_MNT/dir:
+       Policy version: 2
+       Master key identifier: 69b2f6edeee720cce0577937eb8a6751
+       Contents encryption mode: 1 (AES-256-XTS)
+       Filenames encryption mode: 4 (AES-256-CTS)
+       Flags: 0x02
+# Trying to create file without key added yet
+SCRATCH_MNT/dir/file: Required key not available
+# Getting encryption key status
+Absent
+# Adding encryption key
+Added encryption key with identifier 69b2f6edeee720cce0577937eb8a6751
+# Creating encrypted file
+# Getting encryption key status
+Present (user_count=1, added_by_self)
+# Removing encryption key
+Removed encryption key with identifier 69b2f6edeee720cce0577937eb8a6751
+# Getting encryption key status
+Absent
+# Verifying that the encrypted directory was "locked"
+cat: SCRATCH_MNT/dir/file: No such file or directory
+Required key not available
+# Re-adding encryption key
+Added encryption key with identifier 69b2f6edeee720cce0577937eb8a6751
+# Creating another encrypted file
+# Removing key while an encrypted file is open
+Removed encryption key with identifier 69b2f6edeee720cce0577937eb8a6751, but files still busy
+# Non-open file should have been evicted
+cat: SCRATCH_MNT/dir/file2: Required key not available
+# Open file shouldn't have been evicted
+contents
+# Key should be in "incompletely removed" state
+Incompletely removed
+# Closing file and removing key for real now
+Removed encryption key with identifier 69b2f6edeee720cce0577937eb8a6751
+cat: SCRATCH_MNT/dir/file: No such file or directory
+# Cleaning up
+
+# Trying to remove absent key
+Error removing encryption key: Required key not available

diff --git a/tests/generic/group b/tests/generic/group
index b6c11600954eaf2bb6d940ca73640ac6e7b41f7a..c9e00f8c32f1598295394640d50f81871b65c159 100644 (file)
--- a/tests/generic/group
+++ b/tests/generic/group
@@ -582,3 +582,4 @@
 577 auto quick verity
 578 auto quick rw clone
 579 auto stress verity
+580 auto quick encrypt