From: Satya Tangirala <satyat@google.com> To: linux-fscrypt@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-f2fs-devel@lists.sourceforge.net, linux-ext4@vger.kernel.org Cc: linux-xfs@vger.kernel.org, Satya Tangirala <satyat@google.com>, Eric Biggers <ebiggers@google.com>, Jaegeuk Kim <jaegeuk@kernel.org> Subject: [PATCH v5 6/7] fscrypt: document inline encryption support Date: Fri, 24 Jul 2020 12:11:42 +0000 [thread overview] Message-ID: <20200724121143.1589121-7-satyat@google.com> (raw) In-Reply-To: <20200724121143.1589121-1-satyat@google.com> Update the fscrypt documentation file for inline encryption support. Signed-off-by: Satya Tangirala <satyat@google.com> Reviewed-by: Eric Biggers <ebiggers@google.com> Reviewed-by: Jaegeuk Kim <jaegeuk@kernel.org> --- 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..ec81598477fc 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 <https://github.com/tytso/xfstests-bld/blob/master/Documentation/kvm-quickstart.md>`_:: -- 2.28.0.rc0.142.g3c755180ce-goog
WARNING: multiple messages have this Message-ID (diff)
From: Satya Tangirala via Linux-f2fs-devel <linux-f2fs-devel@lists.sourceforge.net> To: linux-fscrypt@vger.kernel.org, linux-fsdevel@vger.kernel.org, linux-f2fs-devel@lists.sourceforge.net, linux-ext4@vger.kernel.org Cc: linux-xfs@vger.kernel.org, Jaegeuk Kim <jaegeuk@kernel.org>, Eric Biggers <ebiggers@google.com>, Satya Tangirala <satyat@google.com> Subject: [f2fs-dev] [PATCH v5 6/7] fscrypt: document inline encryption support Date: Fri, 24 Jul 2020 12:11:42 +0000 [thread overview] Message-ID: <20200724121143.1589121-7-satyat@google.com> (raw) In-Reply-To: <20200724121143.1589121-1-satyat@google.com> Update the fscrypt documentation file for inline encryption support. Signed-off-by: Satya Tangirala <satyat@google.com> Reviewed-by: Eric Biggers <ebiggers@google.com> Reviewed-by: Jaegeuk Kim <jaegeuk@kernel.org> --- 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..ec81598477fc 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 <https://github.com/tytso/xfstests-bld/blob/master/Documentation/kvm-quickstart.md>`_:: -- 2.28.0.rc0.142.g3c755180ce-goog _______________________________________________ Linux-f2fs-devel mailing list Linux-f2fs-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
next prev parent reply other threads:[~2020-07-24 12:12 UTC|newest] Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top 2020-07-24 12:11 [PATCH v5 0/7] add support for direct I/O with fscrypt using blk-crypto Satya Tangirala 2020-07-24 12:11 ` [f2fs-dev] " Satya Tangirala via Linux-f2fs-devel 2020-07-24 12:11 ` [PATCH v5 1/7] fscrypt: Add functions for direct I/O support Satya Tangirala 2020-07-24 12:11 ` [f2fs-dev] " Satya Tangirala via Linux-f2fs-devel 2020-07-24 16:46 ` Eric Biggers 2020-07-24 16:46 ` [f2fs-dev] " Eric Biggers 2020-07-24 12:11 ` [PATCH v5 2/7] direct-io: add support for fscrypt using blk-crypto Satya Tangirala 2020-07-24 12:11 ` [f2fs-dev] " Satya Tangirala via Linux-f2fs-devel 2020-07-24 12:11 ` [PATCH v5 3/7] iomap: support direct I/O with " Satya Tangirala 2020-07-24 12:11 ` [f2fs-dev] " Satya Tangirala via Linux-f2fs-devel 2020-07-24 12:11 ` [PATCH v5 4/7] ext4: " Satya Tangirala 2020-07-24 12:11 ` [f2fs-dev] " Satya Tangirala via Linux-f2fs-devel 2020-07-24 12:11 ` [PATCH v5 5/7] f2fs: " Satya Tangirala 2020-07-24 12:11 ` [f2fs-dev] " Satya Tangirala via Linux-f2fs-devel 2020-07-24 12:11 ` Satya Tangirala [this message] 2020-07-24 12:11 ` [f2fs-dev] [PATCH v5 6/7] fscrypt: document inline encryption support Satya Tangirala via Linux-f2fs-devel 2020-07-24 12:11 ` [PATCH v5 7/7] fscrypt: update documentation for direct I/O support Satya Tangirala 2020-07-24 12:11 ` [f2fs-dev] " Satya Tangirala via Linux-f2fs-devel
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: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200724121143.1589121-7-satyat@google.com \ --to=satyat@google.com \ --cc=ebiggers@google.com \ --cc=jaegeuk@kernel.org \ --cc=linux-ext4@vger.kernel.org \ --cc=linux-f2fs-devel@lists.sourceforge.net \ --cc=linux-fscrypt@vger.kernel.org \ --cc=linux-fsdevel@vger.kernel.org \ --cc=linux-xfs@vger.kernel.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.