# eCryptfs

### FAQ

Main Page

### Index

- What is novel about eCryptfs?
- What versions of the kernel have eCryptfs support?
- Will eCryptfs by itself protect all my data?
- Can I access the lower files while eCryptfs is mounted?
- What kernel options do I need to enable to build eCryptfs?
- On what filesystems can I expect eCryptfs to function?
- Why is the kernel stack such an issue with eCryptfs?
- What is `ecryptfsd`?
- What is `ecryptfs-manager`?
- Do I have to be root to mount eCryptfs?
- How do I store the metadata in the extended attribute region of the lower file?
- I am using the `-o xattr` option, but my backup tools do not preserve extended attributes. How can I back up the lower files?
- What about sparse files?
- How should I select my passphrase?
- How can I protect my key?
- I forgot my password/lost my key! What can I do to recover my data?
- How does eCryptfs compare with other Linux disk encryption solutions?
- Once one user can access an eCryptfs file, any users with permission can also access the file. Should not eCryptfs require all users to have the key in order to access the files?
- "`Unable to allocate crypto cipher with name [---]; rc = [-2]`"
- "`Error mounting eCryptfs; rc = [-2]; strerr = [No such file or directory]`"
- "`Error mounting eCryptfs; rc = [-22]; strerr = [Invalid argument]`"
- "`ecryptfs_parse_options: Could not find key with description: [deadbeaf...]"`
- "`ecryptfs_parse_packet_set: Expected signature of size [8]; read size [7]"`
- My question isn't answered here.

### Q. What is novel about eCryptfs?

Well, nothing, to be honest. All of the techniques used in eCryptfs are directly based on cryptographic technology that was widely known and in practical use in the 1970's.

Security problems often arise when software tries to ``invent its own crypto'' by deviating from what has been in common practical use for a lengthy period of time. eCryptfs sticks to tried-and-true encryption technology.

In terms of per-file key management, eCryptfs simply uses the methods of PGP (created by Philip Zimmermann in 1991 and formally specified as a public standard in RFC2440 in 1998) and takes the obvious and conceptually trivial step of applying those methods within a filesystem service in the kernel. eCryptfs employs the well-weathered encryption techniques that have been in common use in the community for over two decades. Other cryptographic filesystems published and widely used in the 1990's use the same basic approach to encrypting files. eCryptfs just happens to be the first such filesystem to make it upstream in the Linux kernel.

### Q. What versions of the kernel have eCryptfs support?

Linux kernel versions 2.6.19 and later have eCryptfs support. The official mainline kernel is supported and is in active development.

### Q. Will eCryptfs by itself protect all my data?

eCryptfs is just one component in a comprehensive set of mechanisms to protect the confidentiality of your data. Simply mounting eCryptfs over a directory in your home directory will probably not provide sufficient coverage for everything your applications will write to disk. For instance, applications that produce and store thumbnails of your images may write the thumbnails to an unprotected location.

Sensitive application data will typically wind up in the following locations, although some applications will write data to other locations not listed here:

- Anywhere in your home directory
- The /tmp directory
- The /var directory
- The swap device

The /tmp directory and the swap device can be easily protected with dm-crypt using a key randomly generated when the system is booted, since the information in those locations does not need to persist between reboots. eCryptfs must mount the /var directory prior to any daemons or other system applications reading from or writing to that location (including the syslog utility). eCryptfs must also mount over the user's home directory prior to the user logging into the system.

You will need to consider other applications that diverge from traditional paths for storing data on a case-by-case basis. Analyzing application behavior with the kernel auditing system is one way to profile the behavior of an application, and explicit SE Linux rules that only allow applications to write to encrypted mountpoints helps prevent inadvertent information leakage. We recommend always using eCryptfs together with appropriate Mandatory Access Control (MAC) mechanisms to ensure that your sensitive data is always encrypted.

Proper deployment of a comprehensive per-file encryption mechanism is a task best tackled by the entire Linux distribution. The eCryptfs team is working closely with various major Linux distributions to help ensure that eCryptfs is properly used as one component of a comprehensive data protection strategy.

### Q. Can I access the lower files while eCryptfs is mounted?

Accessing the lower files during an active eCryptfs mount is somewhat like accessing a block device on which ext3 is mounted. The kernel allows it, and it may work (depending on what you do with the data), but it is not a good idea.

### Q. What kernel options do I need to enable to build eCryptfs?

`Code maturity level options --->
[*] Prompt for development and/or incomplete code/drivers
Security options --->
<M> Enable access key retention support
Cryptographic options --->
<M> MD5 digest algorithm
<M> AES cipher algorithms
File systems --->
Miscellaneous filesystems --->
<M> eCrypt filesystem layer support (EXPERIMENTAL)
Recommended .config options (some options not available in older kernels):
CONFIG_EXPERIMENTAL=y
CONFIG_KEYS=y
CONFIG_CRYPTO=y
CONFIG_CRYPTO_ALGAPI=y
CONFIG_CRYPTO_BLKCIPHER=y
CONFIG_CRYPTO_HASH=y
CONFIG_CRYPTO_MANAGER=y
CONFIG_CRYPTO_MD5=y
CONFIG_CRYPTO_ECB=y
CONFIG_CRYPTO_CBC=y
CONFIG_CRYPTO_AES=y
CONFIG_ECRYPT_FS=m`

Newer versions of the Linux kernel now have a ``Layered filesystems'' submenu under the ``File systems'' menu, where eCryptfs and Unionfs reside.

Make certain that you have loaded all of the crypto modules that you need to run eCryptfs. This includes `ecb`, `cbc`, `md5`, and at least one popular symmetric cipher, like `aes`.

### Q. On what filesystems can I expect eCryptfs to function?

eCryptfs has been well tested on EXT3, EXT4, XFS and it should work well on other popular local filesystems such as JFS, ReiserFS, and so forth. Changes in the 2.6.24 kernel make eCryptfs more functional on NFS and CIFS, although there is still a little more work to do in order to make eCryptfs function as well on networked filesystems as it currently works on local filesystems. This bug tracks the issues around making eCryptfs work on top of NFS, CIFS, Samba and WebDAV.

### Q. Why is the kernel stack such an issue with eCryptfs?

eCryptfs is a stacked filesystem. This implies that eCryptfs adds on top of whatever call stack exists with current filesystems. Each process in the Linux kernel has a fixed maximum stack size (4k+4k or 8k). Some filesystems (such as XFS) push the limit of the stack by themselves; adding eCryptfs on top may cause a stack overflow on these filesystems. If you wish to use eCryptfs on XFS, I recommend that you first perform stress tests to help determine whether your specific configuration will lead to a kernel process stack overflow.

### Q. Do I have to be root to mount eCryptfs?

eCryptfs mounts can be set up to be done by non-root users, using the `ecryptfs-setup-private` utility. The root user can also setup mount points in `/etc/fstab`, but the non-root users will need to manually load their keys into the kernel keyring.

### Q. How do I store the metadata in the extended attribute region of the lower file?

If your kernel has support for it, mount with the `-o xattr` option. Be sure to preserve the extended attributes in the lower files, or you will lose your data. Bear in mind that many userspace utilities such as `tar` lack extended attribute support, and so you need to use utilities like `star` with the proper options instead.

### Q. I am using the `-o xattr` option, but my backup tools do not preserve extended attributes. How can I back up the lower files?

Mount with the `-o encrypted_view` flag and read the files from under the eCryptfs mount point. The files read will be encrypted, and the cryptographic metadata will be in the headers of the encrypted files that are passed through, even if this metadata is actually stored in the extended attribute regions of the lower files.

### Q. What about sparse files?

eCryptfs does not currently support sparse files. Sequences of encrypted extents with all 0's could be interpreted as sparse regions in eCryptfs without too much implementation complexity. However, this would open up a possible attack vector, since the fact that certain segments of data are all 0's could betray strategic information that the user does not necessarily want to reveal to an attacker. For instance, if the attacker knows that a certain database file with patient medical data keeps information about viral infections in one region of the file and information about diabetes in another section of the file, then the very fact that the segment for viral infection data is populated with data at all would reveal that the patient has a viral infection.

### Q. How should I select my passphrase?

There are plenty of good guides out there to help you choose a strong passphrase. Here is one, for instance: http://www.iusmentis.com/security/passphrasefaq/.

### Q. How can I protect my key?

Make a copy and store it in a physically secure location. For instance, copy your public/private keypair to a USB flash drive or write your passphrase onto a sheet of paper. Then, lock the drive and paper in your desk drawer or put them in a safe deposit box (depending on the sensitivity of the data that the keys protect). Future versions of eCryptfs userspace utilities may implement key splitting functions to provide even more paranoid levels of key protection.

Do not store your keys under the same physical security context in which you are storing your media. It should be much harder for an attacker to get to your keys than it is for him to get to your media.

When you use public key mode and generate a new key using `ecryptfs-manager`, the generated key file is the one that you must back up in order to access your files.

When mounting with a new key, I recommend performing a full mount, creating a new file, unmounting, clearing the user session keyring (`keyctl clear @u`), mounting again, and then trying to access the newly created file. This minimizes the likelihood that you will mistype a passphrase and create files that you will not be able to later recover. When mounting in passphrase mode, make sure that the ecryptfs_sig value matches between mounts. To help avoid the pitfall of mistyping a passphrase on mount, eCryptfs stores a cache of previous ecryptfs_sig values and warns the user if a mount passphrase does not match any passphrases used for previous mounts.

### Q. I forgot my password/lost my key! What can I do to recover my data?

Nothing; you're screwed. (Apologies to Bruce Schneier).

If you have forgotten your passphrase, your only hope is that you chose a weak passphrase in the first place. There is an outside chance that you might be able to perform a successful dictionary attack to recover your passphrase. If you manage to recover your passphrase that way, then you may as well have not been bothering to encrypt your data in the first place, since a malicious attacker could have done the exact same thing to recover your passphrase.

If you selected a strong passphrase or lost your key file, you are completely out of luck. Nobody can help you recover your data.

### Q. How does eCryptfs compare with other Linux disk encryption solutions?

eCryptfs is an actual filesystem. Some other popular disk encryption technologies are not filesystems; they are block device encryption layers (they provide what appears to be a physical block device to some actual filesystem). There is no filesystem logic in these layers. A few of the more well-known block device encryption layers include dm-crypt, Truecrypt, and Loop-AES. Perhaps the best thing about block device-layer encryption is that it is an order of magnitude simpler to implement than filesystem-layer encryption. Another advantage of block device-layer encryption is that it will encrypt the entire filesystem, including all of the filesystem metadata. However, for many use cases, this can turn out to be more of a disadvantage than an advantage.

While eCryptfs uses a powerful and flexible approach to protecting filesystem content, block device-layer encryption technology is still required to protect swap space and certain databases that use their own block device partition. The table below provides a compare-and-constrast of the two technologies. I anticipate that block device encryption will be the best solution for some people, while stacked filesystem encryption will be the best solution for others. Sometimes it even makes sense to use them both together, to combine the comprehensive full-disk encryption of a block device layer encryption technology with the transparent per-file encryption provided by eCryptfs (this will result in double-encryption of the file contents).

Block Device Encryption | Stacked Filesystem Encryption
Simple in concept and implementation; just transform blocks as they pass through. | High level of design complexity; meticulous handling of internal filesystem primitives required.
Must allocate a block device to dedicate for the entire filesystem. | Stacks on top of existing mounted filesystems; requires no special on-disk storage allocation effort.
Everything in the filesystem incurs the cost of encryption and decryption, regardless of the confidentiality requirements for the data. | Selective encryption of the contents of only the sensitive files.
Fully protects the confidentiality of the directory structures, superblocks, file sizes, file permissions, and so forth. | Cannot keep all filesystem metadata confidential. Since stacked filesystems encrypt on a per-file basis, attackers will know the approximate file sizes, for instance.
Coarse granularity; only fixed per-mountpoint encryption policies are possible. | Fine granularity; flexible per-file encryption policies are possible.
No notion of ``encrypted files.'' Individual files must be re-encrypted via a userspace application before written to backups, sent via email, etc. | Individual encrypted files can be accessed transparently by applications; no additional work needed on the part of applications before moving the files to another location.
Clients cannot use directly on networked filesystems; encryption must be set up and managed on the server, or the client must encase all of his files in a loopback mount, losing the per-file granularity from the perspective of other clients. | Clients can stack on locally mounted networked filesystems; individual files are sent to the server and stored in encrypted form.
Can protect databases that use their own dedicated block device. | Can only protect databases that write their tables to regular files in an existing filesystem.
Used to protect swap space. | Not designed to protect swap space; we recommend using block device encryption to protect swap space while using eCryptfs on the filesystem.
Possible to hide the fact that the partition is encrypted. | The fact that encrypted data exists on the device is obvious to an observer.
Filesystem-agnostic; any filesystem will work on an encrypted block device. | Can only be expected to work with existing filesystems that are upstream in the official Linux kernel.

EncFS is another popular cryptographic filesystem that behaves much like a stacked filesystem. EncFS is a userspace filesystem, and so individual page reads and writes require additional context switches between kernel and userspace. One advantage a userspace cryptographic filesystem is that it is possible to use symmetric ciphers implemented in userspace libraries, but the frequent context switching impacts performance.

### Once one user can access an eCryptfs file, any users with permission can also access the file. Should not eCryptfs require all users to have the key in order to access the files?

eCryptfs deliberately makes no attempt to re-implement the discretionary and mandatory access control mechanisms already present in the Linux kernel. eCryptfs will simply require that a File Encryption Key (FEK) be associated with any given inode in order to decrypt the contents of the file on disk. This prevents an attacker from accessing the file contents outside the context of the trusted host environment; for instance, by removing the storage device or by booting a live CD. This is the only type of unauthorized access that eCryptfs is intended to prevent.

Once eCryptfs has associated that FEK with the inode, it does not impose any additional restrictions on who or what can access the files, deferring to the standard user/group/other permissions, capabilities, SE Linux type enforcement, and so forth to regulate access to the files. eCryptfs maintains no pedigree regarding how the FEK found its way to the inode, so it has no way of knowing that any particular UID should or should not be able to open the file, nor should eCryptfs do such a thing.

Having eCryptfs impose additional access control onto the decrypted file contents in a trusted host environment would provide no additional security while introducing unintended usability issues. For instance, a user may wish to share his decrypted files with certain other users on the system without having to share his key with them or add their keys to a set of keys wrapping the inode's FEK. Users expect to be able to accomplish such a task via users, groups, capabilities, and types, and eCryptfs defers access control decisions on trusted host environments to these existing access control mechanisms.

### Q. "`Unable to allocate crypto cipher with name [---]; rc = [-2]`"

Make sure that you have enabled the kernel crypto API and that you have built the ciphers, hashes, and chaining modes that you wish to use. This will usually be md5, aes, cbc, and ecb. Also, make sure that the requested key size is valid for your cipher.

### Q. "`Error mounting eCryptfs; rc = [-2]; strerr = [No such file or directory]`"

Make sure that both the source and destination directories that you provide to the mount command exist.

### Q. "`Error mounting eCryptfs; rc = [-22]; strerr = [Invalid argument]`"

Check your system log for the real problem.

### Q. "`ecryptfs_parse_options: Could not find key with description: [deadbeaf...]"`

If the mount fails and the message "`ecryptfs_parse_options: Could not find key with description: [deadbeaf...]"` is in your system logs, then there was a problem inserting your mount key into your kernel user session keyring.

After a mount attempt, run `keyctl_show`. You should see something like this:

    # keyctl show
    Session Keyring
           -3 lswrv----------     0     0  keyring: _uid_ses.0
            2 lswrv----------     0     0   \_ keyring: _uid.0
    892244932 lswrv----------     0     0       \_ user: deadbeef...

Where `deadbeef` is the signature that corresponds with your key. If you don't see this, then there is a problem with your keyring setup.

If you su to root, be sure to initiate the session by using the - flag.

Finally, try linking your user keyring into your active session keyring:

    # keyctl link @u @s

### Q. "`ecryptfs_parse_packet_set: Expected signature of size [8]; read size [7]`"

Older versions of eCryptfs shipping in older kernels had a minor bug where eCryptfs would only write out and read in 7 of the 8 key signature characters to the metadata of the lower file. This violates the eCryptfs spec, so newer versions of eCryptfs correct this bug and refuse to read files that do not conform to the spec.

The current correctly implemented version of eCryptfs cannot read files created with the early nonconformant and buggy release. If you have any files created with the earlier version, you will need to boot with the earlier version of eCryptfs and copy the decrypted files to secure location (e.g., a loopback mount image protected with dm-crypt). You will then need to copy the data from the secure location into an eCryptfs mount using the most recent kernel release.

Note that the Versions of eCryptfs from 2.6.24 and on will be able to read files created by earlier versions, back through to 2.6.24, as indicated in the ecryptfs-utils package README file:

eCryptfs is still in a developmental stage. When you upgrade the eCryptfs kernel module, it is possible that the eCryptfs file format has been updated. For this reason you should copy your files to an unencrypted location and then copy the files back into the new eCryptfs mount point to migrate the files. File format version 3 and beyond (in kernel version 2.6.24) is expected to remain readable, however.

### Q. My question isn't answered here.

Ask a question on StackExchange. File a bug on Launchpad. Discuss an issue on the mailing list.