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
fs: configfs: don't return anything from drop_link
2016-12-01 10:50:49 +01:00
nfs
doc: ReSTify keys-request-key.txt
2017-05-18 10:33:51 -06:00
pohmelfs
Documentation: fix common spelling mistakes
2016-04-28 07:51:59 -06:00
00-INDEX
logfs: remove from tree
2016-12-14 23:48:11 -05:00
9p.txt
9p: update documentation
2014-01-24 10:55:21 -06:00
adfs.txt
adfs: add hexadecimal filetype suffix option
2011-03-22 17:44:17 -07:00
affs.txt
affs: add mount option to avoid filename truncates
2014-04-07 16:36:08 -07:00
afs.txt
rxrpc: Change module filename to rxrpc.ko
2017-02-17 15:09:19 -05:00
autofs4-mount-control.txt
autofs: update ioctl documentation regarding struct autofs_dev_ioctl
2017-02-27 18:43:45 -08:00
autofs4.txt
Fix up over-eager 'wait_queue_t' renaming
2017-07-10 11:40:19 -07:00
automount-support.txt
Documentation: remove outdated information from automount-support.txt
2015-05-15 01:10:38 -04:00
befs.txt
Documentation: befs.txt: no maintainer, orphaned
2011-08-13 18:34:03 -07:00
bfs.txt
Tigran has moved
2017-05-12 15:57:15 -07:00
btrfs.txt
Documentation: btrfs: remove usage specific information
2016-03-11 17:02:09 +01:00
ceph.txt
ceph: set io_pages bdi hint
2017-02-20 12:16:05 +01:00
coda.txt
conf.py
docs-rst: convert filesystems book to ReST
2017-05-16 08:44:08 -03:00
cramfs.txt
mm, fs: remove remaining PAGE_CACHE_* and page_cache_{get,release} usage
2016-04-04 10:41:08 -07:00
dax.txt
dax: use common 4k zero page for dax mmap reads
2017-09-06 17:27:24 -07:00
debugfs.txt
debugfs: Pass bool pointer to debugfs_create_bool()
2015-10-04 11:36:07 +01:00
devpts.txt
devpts: Make each mount of devpts an independent filesystem.
2016-06-05 10:36:01 -07:00
directory-locking
vfs: remove unused i_op->rename
2016-09-27 11:03:58 +02:00
dlmfs.txt
ocfs2: update web page + git tree in documentation
2015-02-28 09:57:50 -08:00
dnotify.txt
Documentation/fs/: split txt and source files
2010-03-12 15:52:35 -08:00
ecryptfs.txt
efivarfs.txt
efi: Make efivarfs entries immutable by default
2016-02-10 16:25:52 +00:00
exofs.txt
exofs: Add option to mount by osdname
2011-03-15 15:02:51 +02:00
ext2.txt
fs: Remove ext3 filesystem driver
2015-07-23 20:59:40 +02:00
ext3.txt
fs: Remove ext3 filesystem driver
2015-07-23 20:59:40 +02:00
ext4.txt
Documentation: Fix dead URLs to ftp.kernel.org
2017-03-29 15:46:06 -06:00
f2fs.txt
f2fs: support journalled quota
2017-08-21 15:54:48 -07:00
fiemap.txt
fsioctl.c: make generic_block_fiemap() signal-tolerant
2015-02-10 14:30:30 -08:00
files.txt
Wrap accesses to the fd_sets in struct fdtable
2012-02-19 10:30:52 -08:00
fscrypt.rst
fscrypt: add a documentation file for filesystem-level encryption
2017-10-31 13:49:24 -04:00
fuse.txt
Documentation/: it's -> its where appropriate
2010-04-23 02:09:52 +02:00
gfs2-glocks.txt
gfs2: Remove gl_spin define
2015-10-29 12:57:48 -05:00
gfs2-uevents.txt
Documentation: Fix multiple typo in Documentation
2012-03-07 16:08:24 +01:00
gfs2.txt
GFS2: Update main gfs2 doc
2012-05-10 11:45:31 +01:00
hfs.txt
Documentation: HFS is orphaned
2011-11-04 12:01:48 -07:00
hfsplus.txt
Documentation: update URL to hfsplus Technote 1150
2014-02-20 14:48:51 +01:00
hpfs.txt
Documentation/: it's -> its where appropriate
2010-04-23 02:09:52 +02:00
index.rst
fscrypt: add a documentation file for filesystem-level encryption
2017-10-31 13:49:24 -04:00
inotify.txt
inotify: update documentation to reflect code changes
2015-02-10 14:30:28 -08:00
isofs.txt
Documentation: update broken web addresses.
2010-08-04 15:21:40 +02:00
jfs.txt
doc: fix misspellings with 'codespell' tool
2013-05-28 12:02:12 +02:00
Locking
vfs: add flags to d_real()
2017-09-04 21:42:22 +02:00
locks.txt
docs: fix locations of several documents that got moved
2016-10-24 08:12:35 -02:00
mandatory-locking.txt
ncpfs.txt
ncpfs: remove dead URL from documentation
2009-09-23 07:39:42 -07:00
nilfs2.txt
nilfs2: move ioctl interface and disk layout to uapi separately
2016-08-02 19:35:21 -04:00
ntfs.txt
NTFS: Remove changelog from Documentation/filesystems/ntfs.txt.
2014-10-16 12:43:57 +01:00
ocfs2-online-filecheck.txt
Doc: ocfs: Fix typo in filesystems/ocfs2-online-filecheck.txt
2016-07-01 16:17:15 -06:00
ocfs2.txt
ocfs2: update web page + git tree in documentation
2015-02-28 09:57:50 -08:00
omfs.txt
omfs: add filesystem documentation
2008-07-26 12:00:05 -07:00
orangefs.txt
orangefs: documentation clean up
2017-09-14 14:54:39 -04:00
overlayfs.txt
ovl: document copying layers restrictions with inodes index
2017-07-04 22:03:19 +02:00
path-lookup.md
Documentation: add new description of path-name lookup.
2015-11-02 18:18:25 -07:00
path-lookup.txt
Documentation: add new description of path-name lookup.
2015-11-02 18:18:25 -07:00
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
Documentation: fix common spelling mistakes
2016-04-28 07:51:59 -06:00
quota.txt
scripts/spelling.txt: add "an user" pattern and fix typo instances
2017-02-27 18:43:46 -08:00
ramfs-rootfs-initramfs.txt
initmpfs: use initramfs if rootfstype= or root= specified
2013-09-11 15:59:38 -07:00
relay.txt
doc: Fix typo in doucmentations
2013-07-25 12:34:15 +02:00
romfs.txt
Documentation/filesystems/romfs.txt: fixing link to genromfs
2011-02-17 22:04:46 +01:00
seq_file.txt
Documentation: update seq_file
2014-12-29 15:40:18 -07:00
sharedsubtree.txt
doc: fix grammar
2016-03-09 15:33:06 -07:00
spufs.txt
squashfs.txt
Squashfs: Add LZ4 compression configuration option
2014-11-27 18:48:44 +00:00
sysfs-pci.txt
PCI: Add pci_mmap_resource_range() and use it for ARM64
2017-04-20 08:47:47 -05:00
sysfs-tagging.txt
sysfs-tagging.txt: fix pre-kernfs references
2015-09-13 14:38:51 -06:00
sysfs.txt
sysfs.txt: mention that store method buffers are null-terminated
2015-09-13 14:38:51 -06:00
sysv-fs.txt
tmpfs.txt
Documenation: update cgroup's document path
2016-08-03 15:43:58 -06:00
ubifs.txt
UBIFS: switch self-check knobs to debugfs
2011-07-04 10:54:28 +03:00
udf.txt
udf: implement mode and dmode mounting options
2009-04-02 12:29:50 +02:00
ufs.txt
vfat.txt
fat: add config option to set UTF-8 mount option by default
2016-03-22 15:36:02 -07:00
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
Fix common misspellings
2011-03-31 11:26:23 -03:00
xfs-self-describing-metadata.txt
xfs: add metadata CRC documentation
2013-04-27 13:27:43 -05:00
xfs.txt
xfs: deprecate barrier/nobarrier mount option
2016-12-09 16:49:54 +11:00