From mboxrd@z Thu Jan 1 00:00:00 1970 From: Phillip Hellewell Subject: [PATCH 2/12: eCryptfs] Documentation Date: Wed, 2 Nov 2005 20:43:08 -0700 Message-ID: <20051103034308.GB3005@sshock.rn.byu.edu> References: <20051103033220.GD2772@sshock.rn.byu.edu> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Cc: phillip@hellewell.homeip.net, mike@halcrow.us, mhalcrow@us.ibm.com, mcthomps@us.ibm.com, yoder1@us.ibm.com Return-path: To: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org Content-Disposition: inline In-Reply-To: <20051103033220.GD2772@sshock.rn.byu.edu> Sender: linux-kernel-owner@vger.kernel.org List-Id: linux-fsdevel.vger.kernel.org This patch provides documentation for using eCryptfs. Signed off by: Phillip Hellewell Signed off by: Michael Halcrow Signed off by: Michael Thompson Signed off by: Kent Yoder ecryptfs.txt | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 55 insertions(+) --- linux-2.6.14-rc5-mm1/Documentation/ecryptfs.txt 1969-12-31 18:00:00.000000000 -0600 +++ linux-2.6.14-rc5-mm1-ecryptfs/Documentation/ecryptfs.txt 2005-11-01 16:47:17.000000000 -0600 @@ -0,0 +1,55 @@ +eCryptfs: A stacked cryptographic filesystem for Linux +Maintainer: Phillip Hellewell +Lead developer: Michael A. Halcrow +Developers: Michael C. Thompson + Kent Yoder +Current Release Version: 0.1 + +This software is currently undergoing development. Make sure to +maintain a backup copy of any data you write into eCryptfs. + +eCryptfs requires the userspace tools downloadable from the +SourceForge site: + +http://sourceforge.net/projects/ecryptfs/ + +Run make and make install from the request-key/ directory. + + +MOUNT-WIDE PASSPHRASE + +Create a new directory into which eCryptfs will write its encrypted +files (i.e., /root/crypt). Then, create the mount point directory +(i.e., /mnt/crypt). Now it's time to mount eCryptfs: + +mount -t ecryptfs /root/crypt /mnt/crypt + +You should be prompted for a passphrase and a salt (the salt may be +blank). + +Try writing a new file: + +echo "Hello, World" > /mnt/crypt/hello.txt + +The operation will complete. Notice that there is a new file in +/root/crypt that is 3 pages (12288 bytes) in size. This is the +encrypted underlying file for what you just wrote. To test reading, +from start to finish, you need to clear the user session keyring: + +keyctl clear @u + +Then umount /mnt/crypt and mount again per the instructions given +above. + +cat /mnt/crypt/hello.txt + + +NOTES + +eCryptfs should only be mounted on (1) empty directories or (2) +directories containing files only created by eCryptfs. If you mount a +directory that has pre-existing files not created by eCryptfs, then +behavior is undefined. + +Mike Halcrow +mhalcrow@us.ibm.com