aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorebiggers <ebiggers@google.com>2020-01-23 13:46:18 -0800
committerJoseph Richey <joerichey@google.com>2020-01-23 13:46:18 -0800
commit45c27d59ee40f3945837ea827f29f6896414157f (patch)
tree45352179e5b9aea44f1111e99556fd96727e3bd4
parent6e4e557ca6f879627d877a4fc3815203a103e4ff (diff)
Document how to check for kernel config options (#183)
Resolves https://github.com/google/fscrypt/issues/181
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index b815807..64d8028 100644
--- a/README.md
+++ b/README.md
@@ -168,6 +168,11 @@ enabled in the on-disk filesystem superblock:
must have either `CONFIG_FS_ENCRYPTION=y` (for kernels v5.1+) or
`CONFIG_UBIFS_FS_ENCRYPTION=y` (for older kernels).
+To check whether the needed option is enabled in your kernel, run:
+```shell
+zgrep -h ENCRYPTION /proc/config.gz /boot/config-$(uname -r) | sort | uniq
+```
+
Be careful when using encryption on removable media, since filesystems with the
`encrypt` feature cannot be mounted on systems with kernel versions older than
the minimums listed above -- even to access unencrypted files!