2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2016 Google, Inc. All Rights Reserved.
5 # FS QA Test generic/398
7 # Filesystem encryption is designed to enforce that a consistent encryption
8 # policy is used within a given encrypted directory tree and that an encrypted
9 # directory tree does not contain any unencrypted files. This test verifies
10 # that filesystem operations that would violate this constraint fail. This does
11 # not test enforcement of this constraint on lookup, which is still needed to
12 # detect offline changes.
15 seqres=$RESULT_DIR/$seq
16 echo "QA output created by $seq"
20 status=1 # failure is the default!
21 trap "_cleanup; exit \$status" 0 1 2 3 15
29 # The error code for incompatible rename or link into an encrypted directory was
30 # changed from EPERM to EXDEV in Linux v5.1, to allow tools like 'mv' to work.
31 # See kernel commit f5e55e777cc9 ("fscrypt: return -EXDEV for incompatible
32 # rename or link into encrypted dir"). Accept both errors for now.
33 filter_eperm_to_exdev()
35 sed -e 's/Operation not permitted/Invalid cross-device link/'
38 # The error code for incompatible cross-rename without the key has been ENOKEY
39 # on all filesystems since Linux v4.16. Previously it was EPERM on some
40 # filesystems. Accept both errors for now.
41 filter_eperm_to_enokey()
43 sed -e 's/Operation not permitted/Required key not available/'
46 # get standard environment, filters and checks
52 # remove previous $seqres.full before test
55 # real QA test starts here
57 _require_scratch_encryption
58 _require_renameat2 exchange
61 _scratch_mkfs_encrypted &>> $seqres.full
64 # Set up two encrypted directories, with different encryption policies,
65 # and one unencrypted directory.
66 edir1=$SCRATCH_MNT/edir1
67 edir2=$SCRATCH_MNT/edir2
68 udir=$SCRATCH_MNT/udir
69 mkdir $edir1 $edir2 $udir
70 keydesc1=$(_generate_session_encryption_key)
71 keydesc2=$(_generate_session_encryption_key)
72 _set_encpolicy $edir1 $keydesc1
73 _set_encpolicy $edir2 $keydesc2
79 # Test linking and renaming an encrypted file into an encrypted directory with a
80 # different encryption policy. Should fail with EXDEV.
82 echo -e "\n*** Link encrypted <= encrypted ***"
83 ln $edir1/efile1 $edir2/efile1 |& _filter_scratch | filter_eperm_to_exdev
85 echo -e "\n*** Rename encrypted => encrypted ***"
86 $here/src/renameat2 $edir1/efile1 $edir2/efile1 |& filter_eperm_to_exdev
89 # Test linking and renaming an unencrypted file into an encrypted directory.
90 # Should fail with EXDEV.
92 echo -e "\n\n*** Link unencrypted <= encrypted ***"
93 ln $udir/ufile $edir1/ufile |& _filter_scratch | filter_eperm_to_exdev
95 echo -e "\n*** Rename unencrypted => encrypted ***"
96 $here/src/renameat2 $udir/ufile $edir1/ufile |& filter_eperm_to_exdev
99 # Test linking and renaming an encrypted file into an unencrypted directory.
102 echo -e "\n\n*** Link encrypted <= unencrypted ***"
103 ln -v $edir1/efile1 $udir/efile1 |& _filter_scratch
104 rm $udir/efile1 # undo
106 echo -e "\n*** Rename encrypted => unencrypted ***"
107 $here/src/renameat2 $edir1/efile1 $udir/efile1
108 $here/src/renameat2 $udir/efile1 $edir1/efile1 # undo
111 # Test renaming a forbidden (unencrypted, or encrypted with a different
112 # encryption policy) file into an encrypted directory via an exchange (cross
113 # rename) operation. Should fail with EXDEV.
115 echo -e "\n\n*** Exchange encrypted <=> encrypted ***"
116 $here/src/renameat2 -x $edir1/efile1 $edir2/efile2 |& filter_eperm_to_exdev
118 echo -e "\n*** Exchange unencrypted <=> encrypted ***"
119 $here/src/renameat2 -x $udir/ufile $edir1/efile1 |& filter_eperm_to_exdev
121 echo -e "\n*** Exchange encrypted <=> unencrypted ***"
122 $here/src/renameat2 -x $edir1/efile1 $udir/ufile |& filter_eperm_to_exdev
125 # Test a file with a special type, i.e. not regular, directory, or symlink.
126 # Since such files are not subject to encryption, there should be no
127 # restrictions on linking or renaming them into encrypted directories.
129 echo -e "\n\n*** Special file tests ***"
131 $here/src/renameat2 $edir1/fifo $edir2/fifo
132 $here/src/renameat2 $edir2/fifo $udir/fifo
133 $here/src/renameat2 $udir/fifo $edir1/fifo
135 $here/src/renameat2 -x $udir/fifo $edir1/fifo
136 ln -v $edir1/fifo $edir2/fifo | _filter_scratch
137 rm $edir1/fifo $edir2/fifo $udir/fifo
140 # Now test that *without* access to the encrypted key, we cannot use an exchange
141 # (cross rename) operation to move a forbidden file into an encrypted directory.
143 _unlink_session_encryption_key $keydesc1
144 _unlink_session_encryption_key $keydesc2
146 efile1=$(find $edir1 -type f)
147 efile2=$(find $edir2 -type f)
149 echo -e "\n\n*** Exchange encrypted <=> encrypted without key ***"
150 $here/src/renameat2 -x $efile1 $efile2 |& filter_eperm_to_enokey
151 echo -e "\n*** Exchange encrypted <=> unencrypted without key ***"
152 $here/src/renameat2 -x $efile1 $udir/ufile |& filter_eperm_to_enokey