fstests: move test group info to test files
[xfstests-dev.git] / tests / generic / 429
1 #! /bin/bash
2 # SPDX-License-Identifier: GPL-2.0
3 # Copyright (c) 2017 Google, Inc.  All Rights Reserved.
4 #
5 # FS QA Test No. 429
6 #
7 # Test that encrypted dentries are revalidated after adding a key.
8 # Regression test for:
9 #       28b4c263961c ("ext4 crypto: revalidate dentry after adding or removing the key")
10 #
11 # Furthermore, test that encrypted directories are *not* revalidated after
12 # "revoking" a key.  This used to be done, but it was broken and was removed by:
13 #       1b53cf9815bb ("fscrypt: remove broken support for detecting keyring key revocation")
14 #
15 # Also test for a race condition bug in 28b4c263961c, fixed by:
16 #       03a8bb0e53d9 ("ext4/fscrypto: avoid RCU lookup in d_revalidate")
17 #
18 # Note: the following fix for another race in 28b4c263961c should be applied as
19 # well, though we don't test for it because it's very difficult to reproduce:
20 #       3d43bcfef5f0 ("ext4 crypto: use dget_parent() in ext4_d_revalidate()")
21 #
22 . ./common/preamble
23 _begin_fstest auto encrypt
24
25 # Import common functions.
26 . ./common/filter
27 . ./common/encrypt
28
29 # real QA test starts here
30 _supported_fs generic
31 _require_scratch_encryption
32 _require_command "$KEYCTL_PROG" keyctl
33 _require_test_program "t_encrypted_d_revalidate"
34
35 # Set up an encrypted directory
36 _scratch_mkfs_encrypted &>> $seqres.full
37 _scratch_mount
38 _new_session_keyring
39 keydesc=$(_generate_key_descriptor)
40 raw_key=$(_generate_raw_encryption_key)
41 mkdir $SCRATCH_MNT/edir
42 _add_session_encryption_key $keydesc $raw_key
43 _set_encpolicy $SCRATCH_MNT/edir $keydesc
44
45 # Create two files in the directory: one whose name is valid in the base64
46 # format used for encoding ciphertext filenames, and one whose name is not.  The
47 # exact filenames *should* be irrelevant, but due to yet another bug, ->lookup()
48 # in an encrypted directory without the key returned ERR_PTR(-ENOENT) rather
49 # than NULL if the name was not valid ciphertext, causing a negative dentry to
50 # not be created.  For the purpose of this test, we want at least one negative
51 # dentry to be created, so just create both types of name.
52 echo contents_@@@ > $SCRATCH_MNT/edir/@@@ # not valid base64
53 echo contents_abcd > $SCRATCH_MNT/edir/abcd # valid base64
54
55 filter_ciphertext_filenames()
56 {
57         _filter_scratch | sed 's|edir/[a-zA-Z0-9+,_]\+|edir/ENCRYPTED_NAME|g'
58 }
59
60 show_file_contents()
61 {
62         echo "--- Contents of files using plaintext names:"
63         cat $SCRATCH_MNT/edir/@@@ |& _filter_scratch
64         cat $SCRATCH_MNT/edir/abcd |& _filter_scratch
65         echo "--- Contents of files using ciphertext names:"
66         cat ${ciphertext_names[@]} |& filter_ciphertext_filenames
67 }
68
69 show_directory_with_key()
70 {
71         echo "--- Directory listing:"
72         find $SCRATCH_MNT/edir -mindepth 1 | sort | _filter_scratch
73         show_file_contents
74 }
75
76 # View the directory without the encryption key.  The plaintext names shouldn't
77 # exist, but 'cat' each to verify this, which also should create negative
78 # dentries.  The ciphertext names are unpredictable by design, but verify that
79 # the correct number of them are listed by readdir, and save them for later.
80 echo
81 echo "***** Without encryption key *****"
82 _unlink_session_encryption_key $keydesc
83 _scratch_cycle_mount
84 echo "--- Directory listing:"
85 ciphertext_names=( $(find $SCRATCH_MNT/edir -mindepth 1 | sort) )
86 printf '%s\n' "${ciphertext_names[@]}" | filter_ciphertext_filenames
87 show_file_contents
88
89 # Without remounting or dropping caches, add the encryption key and view the
90 # directory again.  Now the plaintext names should all be there, and the
91 # ciphertext names should be gone.  Make sure to 'cat' all the names to test for
92 # stale dentries.
93 echo
94 echo "***** With encryption key *****"
95 _add_session_encryption_key $keydesc $raw_key
96 show_directory_with_key
97
98 # Test for ->d_revalidate() race conditions.
99 echo
100 echo "***** Race conditions *****"
101 $here/src/t_encrypted_d_revalidate $SCRATCH_MNT/edir
102 rm -rf $SCRATCH_MNT/edir/dir
103
104 # Now open the files to pin them in the inode cache (needed to make the test
105 # reliable), then revoke the encryption key.  This should no longer cause the
106 # files to be presented in ciphertext form immediately.
107 echo
108 echo "***** After key revocation *****"
109 (
110         exec 3<$SCRATCH_MNT/edir
111         exec 4<$SCRATCH_MNT/edir/@@@
112         exec 5<$SCRATCH_MNT/edir/abcd
113         _revoke_session_encryption_key $keydesc
114         show_directory_with_key
115 )
116
117 # success, all done
118 status=0
119 exit