ecryptfs.rst 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. .. SPDX-License-Identifier: GPL-2.0
  2. ======================================================
  3. eCryptfs: A stacked cryptographic filesystem for Linux
  4. ======================================================
  5. eCryptfs is free software. Please see the file COPYING for details.
  6. For documentation, please see the files in the doc/ subdirectory. For
  7. building and installation instructions please see the INSTALL file.
  8. :Maintainer: Phillip Hellewell
  9. :Lead developer: Michael A. Halcrow <mhalcrow@us.ibm.com>
  10. :Developers: Michael C. Thompson
  11. Kent Yoder
  12. :Web Site: http://ecryptfs.sf.net
  13. This software is currently undergoing development. Make sure to
  14. maintain a backup copy of any data you write into eCryptfs.
  15. eCryptfs requires the userspace tools downloadable from the
  16. SourceForge site:
  17. http://sourceforge.net/projects/ecryptfs/
  18. Userspace requirements include:
  19. - David Howells' userspace keyring headers and libraries (version
  20. 1.0 or higher), obtainable from
  21. http://people.redhat.com/~dhowells/keyutils/
  22. - Libgcrypt
  23. .. note::
  24. In the beta/experimental releases of eCryptfs, when you upgrade
  25. eCryptfs, you should copy the files to an unencrypted location and
  26. then copy the files back into the new eCryptfs mount to migrate the
  27. files.
  28. Mount-wide Passphrase
  29. =====================
  30. Create a new directory into which eCryptfs will write its encrypted
  31. files (i.e., /root/crypt). Then, create the mount point directory
  32. (i.e., /mnt/crypt). Now it's time to mount eCryptfs::
  33. mount -t ecryptfs /root/crypt /mnt/crypt
  34. You should be prompted for a passphrase and a salt (the salt may be
  35. blank).
  36. Try writing a new file::
  37. echo "Hello, World" > /mnt/crypt/hello.txt
  38. The operation will complete. Notice that there is a new file in
  39. /root/crypt that is at least 12288 bytes in size (depending on your
  40. host page size). This is the encrypted underlying file for what you
  41. just wrote. To test reading, from start to finish, you need to clear
  42. the user session keyring:
  43. keyctl clear @u
  44. Then umount /mnt/crypt and mount again per the instructions given
  45. above.
  46. ::
  47. cat /mnt/crypt/hello.txt
  48. Notes
  49. =====
  50. eCryptfs version 0.1 should only be mounted on (1) empty directories
  51. or (2) directories containing files only created by eCryptfs. If you
  52. mount a directory that has pre-existing files not created by eCryptfs,
  53. then behavior is undefined. Do not run eCryptfs in higher verbosity
  54. levels unless you are doing so for the sole purpose of debugging or
  55. development, since secret values will be written out to the system log
  56. in that case.
  57. Mike Halcrow
  58. mhalcrow@us.ibm.com