Skip to contentSkip to conversation

relax crypto Kconfig dependencies for fsverity/fscrypt

PATCH In review Ard Biesheuvel 3 participants 6 messages Apr 21, 2021 – Apr 22, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v2 cover relax crypto Kconfig dependencies for fsverity/fscrypt

Relax 'select' dependencies to 'imply' for crypto algorithms that are fulfilled only at runtime, and which may be implemented by other drivers than the generic ones implemented in C. This permits, e.g., arm64 builds to omit the generic CRYPTO_SHA256 and CRYPTO_AES drivers, both of which are superseded by optimized scalar versions at the very least,

Changes since v1:
- use Eric's suggested comment text in patch #1
- add Eric's ack to partch #2

Cc "Theodore Y. Ts'o" <[email protected]>
Cc Jaegeuk Kim <[email protected]>
Cc Eric Biggers <[email protected]>

Ard Biesheuvel (2):
fscrypt: relax Kconfig dependencies for crypto API algorithms
fsverity: relax build time dependency on CRYPTO_SHA256

 fs/crypto/Kconfig | 30 ++++++++++++++------
 fs/verity/Kconfig |  8 ++++--
 2 files changed, 28 insertions(+), 10 deletions(-)
Signature · 1 line
2.30.2
#1 lore raw

PATCH v2 1/2 fscrypt: relax Kconfig dependencies for crypto API algorithms

Even if FS encryption has strict functional dependencies on various crypto algorithms and chaining modes. those dependencies could potentially be satisified by other implementations than the generic ones, and no link time dependency exists on the 'depends on' claused defined by CONFIG_FS_ENCRYPTION_ALGS.

So let's relax these clauses to 'imply', so that the default behavior is still to pull in those generic algorithms, but in a way that permits them to be disabled again in Kconfig.

---
 fs/crypto/Kconfig | 30 ++++++++++++++------
 1 file changed, 22 insertions(+), 8 deletions(-)
fs/crypto/Kconfig +22 -8
index a5f5c30368a2..2d0c8922f635 100644
@@ -14,16 +14,30 @@ config FS_ENCRYPTION
 	  F2FS and UBIFS make use of this feature.
 
 # Filesystems supporting encryption must select this if FS_ENCRYPTION.  This
-# allows the algorithms to be built as modules when all the filesystems are.
+# allows the algorithms to be built as modules when all the filesystems are,
+# whereas selecting them from FS_ENCRYPTION would force them to be built-in.
+#
+# Note: this option only pulls in the algorithms that filesystem encryption
+# needs "by default".  If userspace will use "non-default" encryption modes such
+# as Adiantum encryption, then those other modes need to be explicitly enabled
+# in the crypto API; see Documentation/filesystems/fscrypt.rst for details.
+#
+# Also note that this option only pulls in the generic implementations of the
+# algorithms, not any per-architecture optimized implementations.  It is
+# strongly recommended to enable optimized implementations too.  It is safe to
+# disable these generic implementations if corresponding optimized
+# implementations will always be available too; for this reason, these are soft
+# dependencies ('imply' rather than 'select').  Only disable these generic
+# implementations if you're sure they will never be needed, though.
 config FS_ENCRYPTION_ALGS
 	tristate
-	select CRYPTO_AES
-	select CRYPTO_CBC
-	select CRYPTO_CTS
-	select CRYPTO_ECB
-	select CRYPTO_HMAC
-	select CRYPTO_SHA512
-	select CRYPTO_XTS
+	imply CRYPTO_AES
+	imply CRYPTO_CBC
+	imply CRYPTO_CTS
+	imply CRYPTO_ECB
+	imply CRYPTO_HMAC
+	imply CRYPTO_SHA512
+	imply CRYPTO_XTS
 
 config FS_ENCRYPTION_INLINE_CRYPT
 	bool "Enable fscrypt to use inline crypto"
Signature · 1 line
2.30.2
#4 lore raw

PATCH v2 2/2 fsverity: relax build time dependency on CRYPTO_SHA256

In reply to Ard Biesheuvel

CONFIG_CRYPTO_SHA256 denotes the generic C implementation of the SHA-256 shash algorithm, which is selected as the default crypto shash provider for fsverity. However, fsverity has no strict link time dependency, and the same shash could be exposed by an optimized implementation, and arm64 has a number of those (scalar, NEON-based and one based on special crypto instructions). In such cases, it makes little sense to require that the generic C implementation is incorporated as well, given that it will never be called.

To address this, relax the 'select' clause to 'imply' so that the generic driver can be omitted from the build if desired.

---
 fs/verity/Kconfig | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)
fs/verity/Kconfig +6 -2
index 88fb25119899..24d1b54de807 100644
@@ -3,9 +3,13 @@
 config FS_VERITY
 	bool "FS Verity (read-only file-based authenticity protection)"
 	select CRYPTO
-	# SHA-256 is selected as it's intended to be the default hash algorithm.
+	# SHA-256 is implied as it's intended to be the default hash algorithm.
 	# To avoid bloat, other wanted algorithms must be selected explicitly.
-	select CRYPTO_SHA256
+	# Note that CRYPTO_SHA256 denotes the generic C implementation, but
+	# some architectures provided optimized implementations of the same
+	# algorithm that may be used instead. In this case, CRYPTO_SHA256 may
+	# be omitted even if SHA-256 is being used.
+	imply CRYPTO_SHA256
 	help
 	  This option enables fs-verity.  fs-verity is the dm-verity
 	  mechanism implemented at the file level.  On supported
Signature · 1 line
2.30.2
maintainer Acked-by on v2 1/2
#2 lore raw

Re: [PATCH v2 1/2] fscrypt: relax Kconfig dependencies for crypto API algorithms

In reply to Ard Biesheuvel
Quoted 6 lines · Ard Biesheuvel

Even if FS encryption has strict functional dependencies on various crypto algorithms and chaining modes. those dependencies could potentially be satisified by other implementations than the generic ones, and no link time dependency exists on the 'depends on' claused defined by CONFIG_FS_ENCRYPTION_ALGS.

Quoted 6 lines

So let's relax these clauses to 'imply', so that the default behavior is still to pull in those generic algorithms, but in a way that permits them to be disabled again in Kconfig.

---

Herbert, is there still time for you to take these two patches through the crypto tree for 5.13? There aren't any other fscrypt or fsverity patches for 5.13, so that would be easiest for me.

- Eric

maintainer
#3 lore raw

Re: [PATCH v2 1/2] fscrypt: relax Kconfig dependencies for crypto API algorithms

Quoted 4 lines · Eric Biggers

Herbert, is there still time for you to take these two patches through the crypto tree for 5.13? There aren't any other fscrypt or fsverity patches for 5.13, so that would be easiest for me.

Sure, I can take these patches.

Cheers,

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt
maintainer
#5 lore raw
In reply to Ard Biesheuvel
Quoted 14 lines · Ard Biesheuvel

Relax 'select' dependencies to 'imply' for crypto algorithms that are fulfilled only at runtime, and which may be implemented by other drivers than the generic ones implemented in C. This permits, e.g., arm64 builds to omit the generic CRYPTO_SHA256 and CRYPTO_AES drivers, both of which are superseded by optimized scalar versions at the very least,

Changes since v1:
- use Eric's suggested comment text in patch #1
- add Eric's ack to partch #2

Cc "Theodore Y. Ts'o" <[email protected]>
Cc Jaegeuk Kim <[email protected]>
Cc Eric Biggers <[email protected]>
Quoted 7 lines

Ard Biesheuvel (2):
fscrypt: relax Kconfig dependencies for crypto API algorithms
fsverity: relax build time dependency on CRYPTO_SHA256

fs/crypto/Kconfig | 30 ++++++++++++++------
fs/verity/Kconfig | 8 ++++--

2 files changed, 28 insertions(+), 10 deletions(-)

All applied. Thanks.

Signature · 3 lines
Email: Herbert Xu <[email protected]>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt