]> asedeno.scripts.mit.edu Git - linux.git/commit
fscrypt: add a documentation file for filesystem-level encryption
authorEric Biggers <ebiggers@google.com>
Sun, 29 Oct 2017 10:30:14 +0000 (06:30 -0400)
committerTheodore Ts'o <tytso@mit.edu>
Tue, 31 Oct 2017 17:49:24 +0000 (13:49 -0400)
commitf4f864c1219cd88c01fd6359ffc870da9b4acf92
treefc3f708bac54667f0771202968b36025000d92cd
parent3ce2b8ddd84d507c2be8eb687c38fee64fa02fdc
fscrypt: add a documentation file for filesystem-level encryption

Perhaps long overdue, add a documentation file for filesystem-level
encryption, a.k.a. fscrypt or fs/crypto/, to the Documentation
directory.  The new file is based loosely on the latest version of the
"EXT4 Encryption Design Document (public version)" Google Doc, but with
many improvements made, including:

- Reflect the reality that it is not specific to ext4 anymore.
- More thoroughly document the design and user-visible API/behavior.
- Replace outdated information, such as the outdated explanation of how
  encrypted filenames are hashed for indexed directories and how
  encrypted filenames are presented to userspace without the key.
  (This was changed just before release.)

For now the focus is on the design and user-visible API/behavior, not on
how to add encryption support to a filesystem --- since the internal API
is still pretty messy and any standalone documentation for it would
become outdated as things get refactored over time.

Reviewed-by: Michael Halcrow <mhalcrow@google.com>
Signed-off-by: Eric Biggers <ebiggers@google.com>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
Documentation/filesystems/fscrypt.rst [new file with mode: 0644]
Documentation/filesystems/index.rst
MAINTAINERS