]> git.apps.os.sepia.ceph.com Git - fscrypt.git/commitdiff
README: make it clear that pam_fscrypt also handles locking
authorEric Biggers <ebiggers@google.com>
Mon, 8 Mar 2021 23:20:08 +0000 (15:20 -0800)
committerEric Biggers <ebiggers@google.com>
Mon, 8 Mar 2021 23:20:08 +0000 (15:20 -0800)
There are several mentions of pam_fscrypt handling unlocking
directories.  Make sure to mention locking alongside this.

README.md

index 97caed27c1f0c36cbff4a4bb3778c00c85436eac..5cc789f497ae3f0d3f5fd094d565a1f4572ca081 100644 (file)
--- a/README.md
+++ b/README.md
@@ -104,9 +104,10 @@ secret or information used to protect the confidentiality of your data. The
 three currently supported protector types are:
 
 1. Your login passphrase, through [PAM](http://www.linux-pam.org/Linux-PAM-html).
-   The included PAM module (`pam_fscrypt.so`) can automatically unlock login
-   protectors when you log in.  __IMPORTANT:__ before using a login protector,
-   follow [Setting up for login protectors](#setting-up-for-login-protectors).
+   The included PAM module (`pam_fscrypt.so`) can automatically unlock
+   directories protected by your login passphrase when you log in, and lock them
+   when you log out.  __IMPORTANT:__ before using a login protector, follow
+   [Setting up for login protectors](#setting-up-for-login-protectors).
 
 2. A custom passphrase.  This passphrase is hashed with
    [Argon2id](https://en.wikipedia.org/wiki/Argon2), by default calibrated to
@@ -363,9 +364,9 @@ existing passphrase with the new `rounds`.
 
 To enable the PAM module `pam_fscrypt.so`, follow the directions for your Linux
 distro below.  Enabling the PAM module is needed for login passphrase-protected
-directories to be automatically unlocked when you log in, and for login
-passphrase-protected directories to remain accessible when you change your login
-passphrase.
+directories to be automatically unlocked when you log in (and be automatically
+locked when you log out), and for login passphrase-protected directories to
+remain accessible when you change your login passphrase.
 
 #### Enabling the PAM module on Ubuntu
 
@@ -407,8 +408,8 @@ password    optional    pam_fscrypt.so
 after `pam_unix.so` in `/etc/pam.d/common-password` or similar.
 
 The Auth and Session functionality of `pam_fscrypt.so` are used to automatically
-unlock directories when logging in as a user. An easy way to get this working is
-to add the line:
+unlock directories when logging in as a user, and lock them when logging out.
+An easy way to get this working is to add the line:
 ```
 auth        optional    pam_fscrypt.so
 ```