1 .. SPDX-License-Identifier: GPL-2.0
2
3 ==============================================
4 eCryptfs: A stacked cryptographic filesystem f
5 ==============================================
6
7 eCryptfs is free software. Please see the file
8 For documentation, please see the files in the
9 building and installation instructions please
10
11 :Maintainer: Phillip Hellewell
12 :Lead developer: Michael A. Halcrow <mhalcrow@u
13 :Developers: Michael C. Thompson
14 Kent Yoder
15 :Web Site: http://ecryptfs.sf.net
16
17 This software is currently undergoing developm
18 maintain a backup copy of any data you write i
19
20 eCryptfs requires the userspace tools download
21 SourceForge site:
22
23 http://sourceforge.net/projects/ecryptfs/
24
25 Userspace requirements include:
26
27 - David Howells' userspace keyring headers and
28 1.0 or higher), obtainable from
29 http://people.redhat.com/~dhowells/keyutils/
30 - Libgcrypt
31
32
33 .. note::
34
35 In the beta/experimental releases of eCrypt
36 eCryptfs, you should copy the files to an u
37 then copy the files back into the new eCryp
38 files.
39
40
41 Mount-wide Passphrase
42 =====================
43
44 Create a new directory into which eCryptfs wil
45 files (i.e., /root/crypt). Then, create the m
46 (i.e., /mnt/crypt). Now it's time to mount eC
47
48 mount -t ecryptfs /root/crypt /mnt/crypt
49
50 You should be prompted for a passphrase and a
51 blank).
52
53 Try writing a new file::
54
55 echo "Hello, World" > /mnt/crypt/hello.txt
56
57 The operation will complete. Notice that ther
58 /root/crypt that is at least 12288 bytes in si
59 host page size). This is the encrypted underl
60 just wrote. To test reading, from start to fi
61 the user session keyring:
62
63 keyctl clear @u
64
65 Then umount /mnt/crypt and mount again per the
66 above.
67
68 ::
69
70 cat /mnt/crypt/hello.txt
71
72
73 Notes
74 =====
75
76 eCryptfs version 0.1 should only be mounted on
77 or (2) directories containing files only creat
78 mount a directory that has pre-existing files
79 then behavior is undefined. Do not run eCryptf
80 levels unless you are doing so for the sole pu
81 development, since secret values will be writt
82 in that case.
83
84
85 Mike Halcrow
86 mhalcrow@us.ibm.com
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.