common/encrypt: introduce helpers for set_encpolicy and get_encpolicy
[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 seq=`basename $0`
23 seqres=$RESULT_DIR/$seq
24 echo "QA output created by $seq"
25
26 here=`pwd`
27 tmp=/tmp/$$
28 status=1        # failure is the default!
29 trap "_cleanup; exit \$status" 0 1 2 3 15
30
31 _cleanup()
32 {
33         cd /
34         rm -f $tmp.*
35 }
36
37 # get standard environment, filters and checks
38 . ./common/rc
39 . ./common/filter
40 . ./common/encrypt
41
42 # remove previous $seqres.full before test
43 rm -f $seqres.full
44
45 # real QA test starts here
46 _supported_fs generic
47 _supported_os Linux
48 _require_scratch_encryption
49 _require_command "$KEYCTL_PROG" keyctl
50 _require_test_program "t_encrypted_d_revalidate"
51
52 # Set up an encrypted directory
53 _scratch_mkfs_encrypted &>> $seqres.full
54 _scratch_mount
55 _new_session_keyring
56 keydesc=$(_generate_key_descriptor)
57 raw_key=$(_generate_raw_encryption_key)
58 mkdir $SCRATCH_MNT/edir
59 _add_encryption_key $keydesc $raw_key
60 _set_encpolicy $SCRATCH_MNT/edir $keydesc
61
62 # Create two files in the directory: one whose name is valid in the base64
63 # format used for encoding ciphertext filenames, and one whose name is not.  The
64 # exact filenames *should* be irrelevant, but due to yet another bug, ->lookup()
65 # in an encrypted directory without the key returned ERR_PTR(-ENOENT) rather
66 # than NULL if the name was not valid ciphertext, causing a negative dentry to
67 # not be created.  For the purpose of this test, we want at least one negative
68 # dentry to be created, so just create both types of name.
69 echo contents_@@@ > $SCRATCH_MNT/edir/@@@ # not valid base64
70 echo contents_abcd > $SCRATCH_MNT/edir/abcd # valid base64
71
72 filter_ciphertext_filenames()
73 {
74         _filter_scratch | sed 's|edir/[a-zA-Z0-9+,_]\+|edir/ENCRYPTED_NAME|g'
75 }
76
77 show_file_contents()
78 {
79         echo "--- Contents of files using plaintext names:"
80         cat $SCRATCH_MNT/edir/@@@ |& _filter_scratch
81         cat $SCRATCH_MNT/edir/abcd |& _filter_scratch
82         echo "--- Contents of files using ciphertext names:"
83         cat ${ciphertext_names[@]} |& filter_ciphertext_filenames
84 }
85
86 show_directory_with_key()
87 {
88         echo "--- Directory listing:"
89         find $SCRATCH_MNT/edir -mindepth 1 | sort | _filter_scratch
90         show_file_contents
91 }
92
93 # View the directory without the encryption key.  The plaintext names shouldn't
94 # exist, but 'cat' each to verify this, which also should create negative
95 # dentries.  The ciphertext names are unpredictable by design, but verify that
96 # the correct number of them are listed by readdir, and save them for later.
97 echo
98 echo "***** Without encryption key *****"
99 _unlink_encryption_key $keydesc
100 _scratch_cycle_mount
101 echo "--- Directory listing:"
102 ciphertext_names=( $(find $SCRATCH_MNT/edir -mindepth 1 | sort) )
103 printf '%s\n' "${ciphertext_names[@]}" | filter_ciphertext_filenames
104 show_file_contents
105
106 # Without remounting or dropping caches, add the encryption key and view the
107 # directory again.  Now the plaintext names should all be there, and the
108 # ciphertext names should be gone.  Make sure to 'cat' all the names to test for
109 # stale dentries.
110 echo
111 echo "***** With encryption key *****"
112 _add_encryption_key $keydesc $raw_key
113 show_directory_with_key
114
115 # Test for ->d_revalidate() race conditions.
116 echo
117 echo "***** Race conditions *****"
118 $here/src/t_encrypted_d_revalidate $SCRATCH_MNT/edir
119 rm -rf $SCRATCH_MNT/edir/dir
120
121 # Now open the files to pin them in the inode cache (needed to make the test
122 # reliable), then revoke the encryption key.  This should no longer cause the
123 # files to be presented in ciphertext form immediately.
124 echo
125 echo "***** After key revocation *****"
126 (
127         exec 3<$SCRATCH_MNT/edir
128         exec 4<$SCRATCH_MNT/edir/@@@
129         exec 5<$SCRATCH_MNT/edir/abcd
130         _revoke_encryption_key $keydesc
131         show_directory_with_key
132 )
133
134 # success, all done
135 status=0
136 exit