generic: test encrypted file access
authorEric Biggers <>
Thu, 15 Dec 2016 20:26:23 +0000 (12:26 -0800)
committerEryu Guan <>
Sat, 24 Dec 2016 08:47:12 +0000 (16:47 +0800)
Test accessing encrypted files and directories, both with and
without the encryption key.

Signed-off-by: Eric Biggers <>
Reviewed-by: Eryu Guan <>
Signed-off-by: Eryu Guan <>
tests/generic/397 [new file with mode: 0755]
tests/generic/397.out [new file with mode: 0644]

diff --git a/tests/generic/397 b/tests/generic/397
new file mode 100755 (executable)
index 0000000..7077d04
--- /dev/null
@@ -0,0 +1,144 @@
+#! /bin/bash
+# FS QA Test generic/397
+# Test accessing encrypted files and directories, both with and without the
+# encryption key.  Access with the encryption key is more of a sanity check and
+# is not intended to fully test all the encrypted I/O paths; to do that you'd
+# need to run all the xfstests with encryption enabled.  Access without the
+# encryption key, on the other hand, should result in some particular behaviors.
+# Copyright (c) 2016 Google, Inc.  All Rights Reserved.
+# Author: Eric Biggers <>
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as
+# published by the Free Software Foundation.
+# This program is distributed in the hope that it would be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# GNU General Public License for more details.
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write the Free Software Foundation,
+# Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+seq=`basename $0`
+echo "QA output created by $seq"
+status=1       # failure is the default!
+trap "_cleanup; exit \$status" 0 1 2 3 15
+       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_xfs_io_command "set_encpolicy"
+_require_command "$KEYCTL_PROG" keyctl
+_scratch_mkfs_encrypted &>> $seqres.full
+mkdir $SCRATCH_MNT/edir $SCRATCH_MNT/ref_dir
+$XFS_IO_PROG -c "set_encpolicy $keydesc" $SCRATCH_MNT/edir
+for dir in $SCRATCH_MNT/edir $SCRATCH_MNT/ref_dir; do
+       touch $dir/empty > /dev/null
+       $XFS_IO_PROG -t -f -c "pwrite 0 4k" $dir/a > /dev/null
+       $XFS_IO_PROG -t -f -c "pwrite 0 33k" $dir/abcdefghijklmnopqrstuvwxyz > /dev/null
+       maxname=$(yes | head -255 | tr -d '\n') # 255 character filename
+       $XFS_IO_PROG -t -f -c "pwrite 0 1k" $dir/$maxname > /dev/null
+       ln -s a $dir/symlink
+       ln -s abcdefghijklmnopqrstuvwxyz $dir/symlink2
+       ln -s $maxname $dir/symlink3
+       mkdir $dir/subdir
+       mkdir $dir/subdir/subsubdir
+# Diff encrypted directory with unencrypted reference directory
+diff -r $SCRATCH_MNT/edir $SCRATCH_MNT/ref_dir
+# Cycle mount and diff again
+diff -r $SCRATCH_MNT/edir $SCRATCH_MNT/ref_dir
+# Now try accessing the files without the encryption key.  It should still be
+# possible to list the directory and remove files.  But filenames should be
+# encrypted, and it should not be possible to read regular files or to create
+# new files or subdirectories.
+# Note that we cannot simply use ls -R to verify the files because the encrypted
+# filenames are unpredictable.  By design, the key used to encrypt a directory's
+# filenames is derived from the master key (the key in the keyring) and a nonce
+# generated by the kernel.  Hence, the encrypted filenames will be different
+# every time this test is run, even if we were to put a fixed key into the
+# keyring instead of a random one.  The same applies to symlink targets.
+# TODO: there are some inconsistencies in which error codes are returned on
+# different kernel versions and filesystems when trying to create a file or
+# subdirectory without access to the parent directory's encryption key.  It's
+# planned to consistently use ENOKEY, but for now make this test accept multiple
+# error codes...
+       sed -e 's/No such file or directory/Required key not available/' \
+           -e 's/Permission denied/Required key not available/' \
+           -e 's/Operation not permitted/Required key not available/'
+_unlink_encryption_key $keydesc
+# Check that unencrypted names aren't there
+stat $SCRATCH_MNT/edir/empty |& _filter_scratch
+stat $SCRATCH_MNT/edir/symlink |& _filter_scratch
+# Check that the correct numbers of files and subdirectories are there
+ls $SCRATCH_MNT/edir | wc -l
+find $SCRATCH_MNT/edir -mindepth 2 -maxdepth 2 -type d | wc -l
+# Try to read a nondirectory file (should fail with ENOKEY)
+md5sum $(find $SCRATCH_MNT/edir -maxdepth 1 -type f | head -1) |& \
+               cut -d ' ' -f3-
+# Try to create new files, directories, and symlinks in the encrypted directory,
+# both with and without using correctly base-64 encoded filenames.  These should
+# all fail with ENOKEY.
+$XFS_IO_PROG -f $SCRATCH_MNT/edir/newfile |& filter_create_errors | _filter_scratch
+$XFS_IO_PROG -f $SCRATCH_MNT/edir/0123456789abcdef |& filter_create_errors | _filter_scratch
+mkdir $SCRATCH_MNT/edir/newdir |& filter_create_errors | _filter_scratch
+mkdir $SCRATCH_MNT/edir/0123456789abcdef |& filter_create_errors | _filter_scratch
+ln -s foo $SCRATCH_MNT/edir/newlink |& filter_create_errors | _filter_scratch
+ln -s foo $SCRATCH_MNT/edir/0123456789abcdef |& filter_create_errors | _filter_scratch
+# Delete the encrypted directory (should succeed)
+rm -r $SCRATCH_MNT/edir
+stat $SCRATCH_MNT/edir |& _filter_scratch
+# success, all done
diff --git a/tests/generic/397.out b/tests/generic/397.out
new file mode 100644 (file)
index 0000000..2f55c5d
--- /dev/null
@@ -0,0 +1,13 @@
+QA output created by 397
+stat: cannot stat 'SCRATCH_MNT/edir/empty': No such file or directory
+stat: cannot stat 'SCRATCH_MNT/edir/symlink': No such file or directory
+Required key not available
+SCRATCH_MNT/edir/newfile: Required key not available
+SCRATCH_MNT/edir/0123456789abcdef: Required key not available
+mkdir: cannot create directory 'SCRATCH_MNT/edir/newdir': Required key not available
+mkdir: cannot create directory 'SCRATCH_MNT/edir/0123456789abcdef': Required key not available
+ln: failed to create symbolic link 'SCRATCH_MNT/edir/newlink': Required key not available
+ln: failed to create symbolic link 'SCRATCH_MNT/edir/0123456789abcdef': Required key not available
+stat: cannot stat 'SCRATCH_MNT/edir': No such file or directory
index 67a1dc0dbb83e88164088cfa4aeb6568262ba77e..d1eedb60ad9cfbfc2a4e699770f3b2976535f173 100644 (file)
 394 auto quick
 395 auto quick encrypt
 396 auto quick encrypt
+397 auto quick encrypt