Linux-Fsdevel Archive on
help / color / mirror / Atom feed
From: Satya Tangirala <>
Cc:, Satya Tangirala <>
Subject: [PATCH v3 6/7] fscrypt: document inline encryption support
Date: Fri, 17 Jul 2020 01:45:39 +0000	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

Update the fscrypt documentation file for inline encryption support.

Signed-off-by: Satya Tangirala <>
 Documentation/filesystems/fscrypt.rst | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/Documentation/filesystems/fscrypt.rst b/Documentation/filesystems/fscrypt.rst
index f5d8b0303ddf..f3d87a1a0a7f 100644
--- a/Documentation/filesystems/fscrypt.rst
+++ b/Documentation/filesystems/fscrypt.rst
@@ -1204,6 +1204,18 @@ buffer.  Some filesystems, such as UBIFS, already use temporary
 buffers regardless of encryption.  Other filesystems, such as ext4 and
 F2FS, have to allocate bounce pages specially for encryption.
+Fscrypt is also able to use inline encryption hardware instead of the
+kernel crypto API for en/decryption of file contents.  When possible, and
+if directed to do so (by specifying the 'inlinecrypt' mount option for
+an ext4/F2FS filesystem), it adds encryption contexts to bios and
+uses blk-crypto to perform the en/decryption instead of making use
+of the above read/write path changes.  Of course, even if directed to make
+use of inline encryption, fscrypt will only be able to do so if either
+hardware inline encryption support is available for the selected encryption
+algorithm or CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK is selected.  If neither
+is the case, fscrypt will fall back to using the above mentioned read/write
+path changes for en/decryption.
 Filename hashing and encoding
@@ -1250,7 +1262,9 @@ Tests
 To test fscrypt, use xfstests, which is Linux's de facto standard
 filesystem test suite.  First, run all the tests in the "encrypt"
-group on the relevant filesystem(s).  For example, to test ext4 and
+group on the relevant filesystem(s).  One can also run the tests
+with the 'inlinecrypt' mount option to test the implementation for
+inline encryption support.  For example, to test ext4 and
 f2fs encryption using `kvm-xfstests

  parent reply	other threads:[~2020-07-17  1:46 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-17  1:45 [PATCH v3 0/7] add support for direct I/O with fscrypt using blk-crypto Satya Tangirala
2020-07-17  1:45 ` [PATCH v3 1/7] fscrypt: Add functions for direct I/O support Satya Tangirala
2020-07-20 20:14   ` Eric Biggers
2020-07-17  1:45 ` [PATCH v3 2/7] direct-io: add support for fscrypt using blk-crypto Satya Tangirala
2020-07-17  1:45 ` [PATCH v3 3/7] iomap: support direct I/O with " Satya Tangirala
2020-07-20 19:29   ` Eric Biggers
2020-07-17  1:45 ` [PATCH v3 4/7] ext4: " Satya Tangirala
2020-07-17  1:45 ` [PATCH v3 5/7] f2fs: " Satya Tangirala
2020-07-17  1:45 ` Satya Tangirala [this message]
2020-07-20 19:34   ` [PATCH v3 6/7] fscrypt: document inline encryption support Eric Biggers
2020-07-17  1:45 ` [PATCH v3 7/7] fscrypt: update documentation for direct I/O support Satya Tangirala
2020-07-20 19:40   ` Eric Biggers

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).