From ArchWiki
Revision as of 18:31, 30 August 2013 by NorthAntrim (talk | contribs)
Jump to navigation Jump to search

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary end

This article describes basic usage of eCryptfs. It guides you through the process of creating a private and secure encrypted directory within your $HOME directory, where you can store all your sensitive files and private data.

In implementation eCryptfs differs from dm-crypt, which provides a block device encryption layer, while eCryptfs is an actual file-system – a stacked cryptographic file system to be exact. For comparison of the two you can refer to this table .

The summary is that it doesn't require special on-disk storage allocation effort, such as separate partitions, you can mount eCryptfs on top of any single directory to protect it. That includes e.g. your entire $HOME and network file systems (i.e. having encrypted NFS shares). All cryptographic metadata is stored in the headers of files, so encrypted data can be easily moved, stored for backup and recovered. There are other advantages, but there are also drawbacks, for instance eCryptfs is not suitable for encrypting complete partitions which also means you can't protect your swap space with it (instead you can combine it with dm-crypt).

For more details on how eCryptfs compares to other disk encryption solutions, see Disk Encryption#Comparison table.


eCyptfs does not handle sparse files well; this should be considered before encrypting large portions of the directory structure ($HOME, for example). For most intents and purposes this deficiency does not pose a problem. Using eCryptfs to encrypt sparse files, however, currently encrypts the entire allocated space of the sparse file, which, in the case of big files, can starve the system of resources. (This bug may be tracked on Launchpad). One popular and inadvisable application of eCryptfs is to encrypt a BitTorrent download location; this often requires eCryptfs to handle sparse files of 10 GB or more and may lead to intense disk starvation. A simple workaround is to place sparse files in an unencrypted .Public directory (as opposed to the standard eCryptfs .Private directory, explained below).

Login password

Note: With shadow sha512 is the default for new passwords (see bug 13591 and corresponding commit).

If you are encrypting your whole home, with auto-mounting you should use a strong password and consider changing the hash algorithm for /etc/shadow from md5 to stronger ones like sha512/bcrypt that helps to protect your password against rainbow-table attacks. See for more information.


eCryptfs is a part of Linux since version 2.6.19. But to work with it you will need the userspace tools provided by the package ecryptfs-utils available in the Official Repositories.

Once you have installed that package you can load the ecryptfs module and continue with the setup:

# modprobe ecryptfs

The ecryptfs-utils package is distributed with a few helper scripts which will help you with key management and similar tasks. Some were written to automate this whole process of setting up encrypted directories (ecryptfs-setup-private) or help you combine eCryptfs with dm-crypt to protect swap space (ecryptfs-setup-swap). Despite those scripts we will go trough the process manually so you get a better understanding of what is really being done.

Before we say anything else it's advised that you check the eCryptfs documentation. It is distributed with a very good and complete set of manual pages.

Setup (simple)

As a user run


and follow the instructions.

Setup (migrating)

If a user's home directory wasn't setup beforehand, you can migrate it.

Ensure that the user you want to migrate owns no processes and is logged out. You also need to ensure that you have rsync installed. Once the prerequisites have been met run as root:

ecryptfs-migrate-home -u archey

(replacing "archey" with your user) and follow the instructions. It is imperative that the user logs in before the next reboot.

Setup (in detail)

First create your private directories, in this example we will call them exactly that: Private

$ su -
# mkdir -m 700 /home/username/.Private
# mkdir -m 500 /home/username/Private
# chown username:username /home/username/{.Private,Private}

Let's summarize

  • Actual encrypted data will be stored in ~/.Private directory (so-called lower directory)
  • While mounted, decrypted data will be available in ~/Private directory (so-called upper directory)
    • While not mounted nothing can be written to this directory
    • While mounted it has the same permissions as the lower directory

eCryptfs can now be mounted on top of ~/Private.

# mount -t ecryptfs /home/username/.Private /home/username/Private

You will need to answer a few questions and provide a passphrase which should be used to mount this directory in the future. However you can also have different keys encrypting different data (more about this below). For convenience we will limit this guide to only one key and passphrase. Let's see an example:

Key type: passphrase
Passphrase: ThisIsAVeryWeakPassphrase
Cipher: aes
Key byte: 16
Plaintext passtrough: no
Filename encryption: no
Add signature to cache: yes 

Let's summarize

  • The passphrase is your mount passphrase which will be salted, hashed and loaded into the kernel keyring.
    • In eCryptfs terms, this salted, hashed passphrase is your "file encryption key, encryption key", or fekek.
  • eCryptfs supports a few different ciphers (AES, blowfish, twofish...). You can read about them on Wikipedia.
  • Plaintext passtrough enables you to store and work with un-encrypted files stored in the lower directory.
  • Filename encryption is available since Linux 2.6.29
    • In eCryptfs terms the key used to protect filenames is known as "filename encryption key", or fnek.
  • The signature of the key(s) will be stored in /root/.ecryptfs/sig-cache.txt.

Since our later goal is to be able to mount without root privileges, we will now move the eCryptfs configuration directory to your own home and transfer the ownership to you:

# mv /root/.ecryptfs /home/username
# chown username:username /home/username/.ecryptfs

Your setup is now complete and directory is mounted. You can place any file in the ~/Private directory and it will get encrypted in ~/.Private.

Now copy a few files to your new private directory, and then un-mount it. If you inspect the files you will see that they are unreadable – encrypted. That was cool you say, but how do I get them back... and that brings us to:

Extra Notes

Above is detailed the simplest way to setup the mount point, but ecryptfs-setup-private runs through some extra steps.

  • The above mount passphrase is derived from the passphrase you type in. This is not considered very secure, so the setup script grabs some characters from /dev/random for safety:
od -x -N $bytes --width=$bytes /dev/urandom | head -n 1 | sed "s/^0000000//" | sed "s/\s*//g"
  • ecryptfs-setup-private also takes the resulting mount passphrase and wraps it with your login passphrase (pasword) and stores this in ~/.ecryptfs/wrapped-passphrase. You can replicate this with:
$ ecryptfs-wrap-passphrase ~/.ecryptfs/wrapped-passphrase 
  Passphrase to wrap: 
  Wrapping passphrase:

Mounting (the hard way)

Whenever you need your files available you can repeat the above mount procedure, using the same passphrase and options if you want to access your previously encrypted files or using a different passphrase (and possibly options) if for some reason you want to have different keys protecting different data (imagine having a publicly shared directory where different data is encrypted by different users, and their keys).

In any case going trough those questions every time could be a bit tedious.

One solution would be to create an entry in the /etc/fstab file for this mount point:

/home/user/.Private /home/user/Private ecryptfs [... user ... ecryptfs_sig=XY,ecryptfs_cipher=aes,ecryptfs_key_bytes=16,ecryptfs_unlink_sigs 0 0
  • You will notice that we defined the user option, it enables you to mount the directory as a user (if it does not works as a normal user, you may need to setuid mount.ecryptfs by running as root: chmod +s /sbin/mount.ecryptfs)
  • Notice the ecryptfs_sig option, replace XY with your own key signature (as seen in the mtab line earlier and in sig-cache.txt)
  • If you enabled filename encryption then pass an additional mount option: ecryptfs_fnek_sig=XY, where XY is the same signature you provide with the ecryptfs_sig option.
  • Last option ecrypfs_unlink_sigs ensures that your keyring is cleared every time the directory is un-mounted

Since your key was deleted from the kernel keyring when you un-mounted, in order to mount you need to insert it into the keyring again. You can use the ecryptfs-add-passphrase utility or the ecryptfs-manager to do it:

When the key is inserted you can mount the directory:

$ ecryptfs-add-passphrase
  Passphrase: ThisIsAVeryWeakPassphrase

$ mount -i /home/username/Private

You will notice that we used the -i option this time. It disables invoking the mount helper. Speaking of which, using -i by default mounts with: nosuid, noexec and nodev. If you want to have at least executable files in your private directory you can add the exec option to the fstab line.

This would be a good place to mention the keyctl utility from the (earlier installed) keyutils package. It can be used for any advanced key management tasks. Following examples show how to list your keyring contents and how to clear them:

$ keyctl list @u
$ keyctl clear @u
Note: However, one should remember that /etc/fstab is for system-wide partitions only and should not be used for user-specific mounts

Auto-mounting (the easy way)

A better way is to use PAM directly, see 'PAM MODULE' in:


1. Check if ~/.ecryptfs/auto-mount and ~/.ecryptfs/wrapped-passphrase (these are automatically created by ecryptfs-setup-private) exist.

2. Add ecryptfs to the pam-stack exactly as following to allow transparent unwrapping of the passphrase on login.

Open /etc/pam.d/system-auth and add this after the line containing auth required [...]:

auth	required unwrap

, then add this above the line containing password required [...]:

password	optional

, and this after the line session required

session	optional unwrap

3. Relogin (you need to type the user's password for obvious reason ;) and check output of mount which should now contain a mountpoint, e.g.:

/home/$USER/.Private on /home/$USER/Private type ecryptfs (...)

Your user's encrypted directory should be perfectly readable, e.g. $HOME/Private/

Note that the latter will be automatically unmounted and made unavailable when the user log off.


Besides using your private directory as storage for sensitive files, and private data, you can also use it to protect application data. Take Firefox for an example, not only does it have an internal password manager but the browsing history and cache can also be sensitive. Protecting it is easy:

 $ mv ~/.mozilla ~/Private/mozilla
 $ ln -s ~/Private/mozilla ~/.mozilla


If you want to move a file out of the private directory just move it to it's new destination while ~/Private is mounted. Also note that there are no special steps involved if you want to remove your private directory. Make sure it is un-mounted and delete ~/.Private, along with all the files.


Setup explained here separates the directory with encrypted data from the mount point, so the encrypted data is available for backup at any time. With an overlay mount (i.e. ~/Secret mounted over ~/Secret) the lower, encrypted, data is harder to get to. Today when cronjobs and other automation software do automatic backups the risk of leaking your sensitive data is higher.

We explained earlier that all cryptographic metadata is stored in the headers of files. You can easily do backups, or incremental backups, of your ~/.Private directory, treating it like any other directory.


This wiki article covers only the basic setup of a private encrypted directory. There is however another article about eCryptfs on Arch Linux, which covers encryption of your entire $HOME and encrypting swap space without breaking hibernation (suspend to disk).

That article includes many more steps (i.e. using PAM modules and automatic mounting) and the author was opposed to replicating it here, because there is just no single "right" way to do it. The author proposes some solutions and discusses the security implications, but they are his solutions and as such might not be the best nor are they endorsed by the eCryptfs project in any way.

Article: eCryptfs and $HOME by Adrian C. (anrxc).

Consider that Chromium OS, as released by Google, is using eCryptfs to protect devices that are, and will be, powered by it. Some implementation details are available and they make excellent reading. You can read them here, they could help a lot as you're coming up with your own strategy.

PAM Mount

The above "eCryptfs and $HOME" article uses a shell init file to mount the home directory. The same can be done using pam_mount with the added benefit that home is un-mounted when all sessions are logged out. Add the following lines to /etc/security/pam_mount.conf.xml:

<luserconf name=".pam_mount.conf.xml" />
<mntoptions require="" /> 
<lclmount>mount -i %(VOLUME) "%(before=\"-o\" OPTIONS)"</lclmount> 

Please prefer writing manually these lines instead of simply copy/pasting them (especially the lclmount line), otherwise you might get some corrupted characters. Explanation:

  • the first line indicates where the user-based configuration file is located (here ~/.pam_mount.conf.xml) ;
  • the second line overwrites the default required mount options which are unnecessary ("nosuid,nodev") ;
  • the last line indicates which mount command to run (eCryptfs needs the -i switch).

Then set the volume definition, preferably to ~/.pam_mount.conf.xml:

    <volume noroot="1" fstype="ecryptfs" path="/home/.ecryptfs/user/.Private/" mountpoint="/home/user/"/>

"noroot" is needed because the encryption key will be added to the user's keyring

Finally, edit /etc/pam.d/login as described in pam_mount's article.

Optional step

To avoid wasting time needlessly unwrapping the passphrase you can create a script that will check pmvarrun to see the number of open sessions:

#    /usr/local/bin/doecryptfs

exit $(/usr/sbin/pmvarrun -u$PAM_USER -o0)

With the following line added before the eCryptfs unwrap module in your PAM stack:

auth    [success=ignore default=1]     quiet /usr/local/bin/doecryptfs
auth    required             unwrap

The article suggests adding these to /etc/pam.d/login, but the changes will need to be added to all other places you login, such as /etc/pam.d/kde.

PAM mount by eCryptfs module

To use the eCryptfs PAM module it self for mounting you should know it depends on some hard-coded Ubuntu defaults. Like using AES cipher with a 16 byte key. As described in this BBS post [1] you have to do the following steps:

1) For your understanding and preparation, read the guide mentioned above. [2]

2) Install keyutils and ecryptfs-utils from the official Repos.

[Do the following steps as root!]

3) Make a "ecryptfs" Group:

groupadd ecryptfs

4) Add the user to it:

usermod -aG ecryptfs user

5) Load the ecryptfs module

modprobe ecryptfs

6) Change your /etc/pam.d/system-auth to look something like this (lines to add are bold):


auth      required
auth      required     try_first_pass nullok
auth      required unwrap
auth      optional

account   required
account   optional
account   required

password  required
password  required     try_first_pass nullok sha512 shadow
password  optional

session   required unwrap
session   required
session   required
session   required
session   optional

6a) When using GDM < 3.2 to log in, edit /etc/pam.d/gdm like this:

auth            requisite
auth            required
auth            required
auth            optional unwrap
auth            optional
account         required
session         required
session         required
session         optional unwrap
session         optional auto_start
password        required
password        optional

6b) For GDM >= 3.2, make the following changes to /etc/pam.d/gdm-password (thanks to grawity for this):

auth            requisite
auth            required
auth            requisite nullok
auth            optional unwrap
auth            optional
auth            sufficient uid >= 1000 quiet
auth            required
account         required
password        required
password        optional
session         required
-session        optional
session         optional force revoke
session         required
session         required
session         optional unwrap
session         optional auto_start

6c) For KDM, make the following changes to /etc/pam.d/kde:

auth            required
auth            optional unwrap
auth            required
account         required
password        optional
password        required
session         required
session         optional unwrap
session         required

6d) For LXDM, make the following changes to /etc/pam.d/lxdm:

auth            requisite
auth            required
auth            required
auth            optional unwrap
account         required
session         required
session         required
session         optional unwrap
password        required
password        optional

6e) For LightDM, make the following changes to /etc/pam.d/lightdm

auth      required
auth      required
auth      required
auth      optional unwrap
account   required
password  optional
password  required
session   required
session   optional unwrap

7) To be able to automatically mount your encrypted home directory on login using SSH, edit /etc/pam.d/sshd:

#auth           required        #Disable remote root
auth            required
auth            optional unwrap
auth            required
account         required
account         required
account         required
password        required
password        optional
session         optional unwrap
session         required
session         required
session         optional nox11

8) Using Ubuntu defaults

There's a method to automatically setup your HOME with AES and a 16 byte key. You could execute (it can take some while, it automatically encrypts your home files)

   ecryptfs-migrate-home -u user

...and follow the on screen instructions (Delete backup afterwards (/home/user.XXXXX) / Record the passphrase generated by ecryptfs -> ecryptfs-unwrap-passphrase / ...)

9) Log in and check if everything worked correctly.

This is a working solution and ecryptfs is exactly used as in Ubuntu (10.04/10.10) - and is easy to set up. Besides this, it has the advantage of auto-unmount at log-out, which shell profile files (ie. ~/.bash_logout) could have trouble doing, because there could still be open file-descriptors by the shell at the time of umount. To encrypt swap see: System_Encryption_with_LUKS#Encrypting_the_Swap_partition (some of the tools provided by ecryptfs, such as ecryptfs-setup-swap, only work in ubuntu).


Use ecryptfs-simple if you just want to use eCryptfs to mount arbitrary directories the way you can with EncFS. ecryptfs-simple does not require root privileges or entries in fstab, nor is it limited to hard-coded directories such as ~/.Private. The package is available in the AUR and in Xyne's repos.

As the name implies, usage is simple:

# simple mounting
ecryptfs-simple /path/to/foo /path/to/bar
# automatic mounting: prompts for options on the first mount of a directory then reloads them next time
ecryptfs-simple -a /path/to/foo /path/to/bar
# unmounting by source directory
ecryptfs-simple -u /path/to/foo
# unmounting by mountpoint
ecryptfs-simple -u /path/to/bar