eCryptfs: A stacked cryptographic filesystem for Linux

Kernel module package


OVERVIEW

eCryptfs consists of both userspace and kernel components. This
package contains the eCryptfs kernel module.

For more information about eCryptfs and to obtain the userspace
package, visit <http://ecryptfs.sf.net>.


PREREQUISITES

 - Mainline vanilla Linux kernel version 2.6.16 or higher, built with:
  - Key retention support
  - Crypto API support
   - A commonly used cipher algorithm, such as aes, 3des, or blowfish
   - MD5 hash algorithm

Note that this package attempts to maintain compatibility with the
following mainline vanilla kernel versions:
 - 2.6.16
 - 2.6.17
 - 2.6.18
 - 2.6.19

The ./configure script will create a symlink from the directory
containing the kernel version to src/.


BUILD AND INSTALL INSTRUCTIONS

Under most circumstances, the usual build and install process applies:

# ./configure && make && sudo make install

This will use ``uname -r'' to identify the current running kernel on
the host; the module will, by default, be built against that, assuming
that your modules are installed to /lib/modules/`uname -r`. If you
wish to specify another kernel version and/or modules directory, you
can pass --with-kernelver and --with-modulesdir parameters to the
./configure script. For instance, if you wish to build against kernel
version 2.6.17 and if your modules are installed to
/lib/modules/2.6.17.9, you would run something like:

# ./configure --with-kernelver=2.6.17 --with-modulesdir=/lib/modules/2.6.17.9

This tells the configure script what the kernel version number is and
where the modules are to be installed. The kernel headers should be
available from the build/ directory under the specified modules
directory.


NOTES

This package has been tested against the mainline vanilla kernel
only. Linux distributions may patch their kernels, breaking
compatibility.

Once you have completed the installation of the kernel module, you
need to build and install the userspace utilities. Grab the latest
userspace package and follow the build/install directions in the
README for that package. Please let me know if you hit a snag and I
will do my best to help out.


Mike Halcrow
mhalcrow@us.ibm.com
