87 lines · plain
1.. SPDX-License-Identifier: GPL-2.02 3======================================================4eCryptfs: A stacked cryptographic filesystem for Linux5======================================================6 7eCryptfs is free software. Please see the file COPYING for details.8For documentation, please see the files in the doc/ subdirectory. For9building and installation instructions please see the INSTALL file.10 11:Maintainer: Phillip Hellewell12:Lead developer: Michael A. Halcrow <mhalcrow@us.ibm.com>13:Developers: Michael C. Thompson14 Kent Yoder15:Web Site: http://ecryptfs.sf.net16 17This software is currently undergoing development. Make sure to18maintain a backup copy of any data you write into eCryptfs.19 20eCryptfs requires the userspace tools downloadable from the21SourceForge site:22 23http://sourceforge.net/projects/ecryptfs/24 25Userspace requirements include:26 27- David Howells' userspace keyring headers and libraries (version28 1.0 or higher), obtainable from29 http://people.redhat.com/~dhowells/keyutils/30- Libgcrypt31 32 33.. note::34 35 In the beta/experimental releases of eCryptfs, when you upgrade36 eCryptfs, you should copy the files to an unencrypted location and37 then copy the files back into the new eCryptfs mount to migrate the38 files.39 40 41Mount-wide Passphrase42=====================43 44Create a new directory into which eCryptfs will write its encrypted45files (i.e., /root/crypt). Then, create the mount point directory46(i.e., /mnt/crypt). Now it's time to mount eCryptfs::47 48 mount -t ecryptfs /root/crypt /mnt/crypt49 50You should be prompted for a passphrase and a salt (the salt may be51blank).52 53Try writing a new file::54 55 echo "Hello, World" > /mnt/crypt/hello.txt56 57The operation will complete. Notice that there is a new file in58/root/crypt that is at least 12288 bytes in size (depending on your59host page size). This is the encrypted underlying file for what you60just wrote. To test reading, from start to finish, you need to clear61the user session keyring:62 63keyctl clear @u64 65Then umount /mnt/crypt and mount again per the instructions given66above.67 68::69 70 cat /mnt/crypt/hello.txt71 72 73Notes74=====75 76eCryptfs version 0.1 should only be mounted on (1) empty directories77or (2) directories containing files only created by eCryptfs. If you78mount a directory that has pre-existing files not created by eCryptfs,79then behavior is undefined. Do not run eCryptfs in higher verbosity80levels unless you are doing so for the sole purpose of debugging or81development, since secret values will be written out to the system log82in that case.83 84 85Mike Halcrow86mhalcrow@us.ibm.com87