linux/Documentation/filesystems
Eric Biggers f4f864c121 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>
2017-10-31 13:49:24 -04:00
..
caching fscache: remove unused ->now_uncached callback 2017-09-06 17:27:26 -07:00
cifs CIFS/SMB3: Update documentation to reflect SMB3 and various changes 2017-09-17 10:48:00 -05:00
configfs
nfs
pohmelfs
00-INDEX
9p.txt
adfs.txt
affs.txt
afs.txt
autofs4-mount-control.txt
autofs4.txt Fix up over-eager 'wait_queue_t' renaming 2017-07-10 11:40:19 -07:00
automount-support.txt
befs.txt
bfs.txt
btrfs.txt
ceph.txt
coda.txt
conf.py
cramfs.txt
dax.txt dax: use common 4k zero page for dax mmap reads 2017-09-06 17:27:24 -07:00
debugfs.txt
devpts.txt
directory-locking
dlmfs.txt
dnotify.txt
ecryptfs.txt
efivarfs.txt
exofs.txt
ext2.txt
ext3.txt
ext4.txt
f2fs.txt f2fs: support journalled quota 2017-08-21 15:54:48 -07:00
fiemap.txt
files.txt
fscrypt.rst fscrypt: add a documentation file for filesystem-level encryption 2017-10-31 13:49:24 -04:00
fuse.txt
gfs2-glocks.txt
gfs2-uevents.txt
gfs2.txt
hfs.txt
hfsplus.txt
hpfs.txt
index.rst fscrypt: add a documentation file for filesystem-level encryption 2017-10-31 13:49:24 -04:00
inotify.txt
isofs.txt
jfs.txt
Locking vfs: add flags to d_real() 2017-09-04 21:42:22 +02:00
locks.txt
mandatory-locking.txt
ncpfs.txt
nilfs2.txt
ntfs.txt
ocfs2-online-filecheck.txt
ocfs2.txt
omfs.txt
orangefs.txt orangefs: documentation clean up 2017-09-14 14:54:39 -04:00
overlayfs.txt
path-lookup.md
path-lookup.txt
porting VFS: Differentiate mount flags (MS_*) from internal superblock flags 2017-07-17 08:45:35 +01:00
proc.txt procfs: fdinfo: extend information about epoll target files 2017-07-12 16:26:01 -07:00
qnx6.txt
quota.txt
ramfs-rootfs-initramfs.txt
relay.txt
romfs.txt
seq_file.txt
sharedsubtree.txt
spufs.txt
squashfs.txt
sysfs-pci.txt
sysfs-tagging.txt
sysfs.txt
sysv-fs.txt
tmpfs.txt
ubifs.txt
udf.txt
ufs.txt
vfat.txt
vfs.txt Merge branch 'overlayfs-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mszeredi/vfs 2017-09-13 09:11:44 -07:00
xfs-delayed-logging-design.txt
xfs-self-describing-metadata.txt
xfs.txt