aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEric Biggers <ebiggers@google.com>2022-10-18 10:12:02 -0700
committerEric Biggers <ebiggers3@gmail.com>2022-10-19 20:47:57 -0700
commit295c503a77f53b87305bba310e37cbdd9b516936 (patch)
treeb9a64df8dc907eb9924062994570b9f8f3118b88 /README.md
parent632d66d6fddfa9fd0a279a1811ced1efc567be29 (diff)
Make pam_fscrypt.so support the unlock_only option
Now that it's been requested by users, bring back the "unlock_only" option, which was originally proposed as part of https://github.com/google/fscrypt/pull/281 but was dropped in the final version of that pull request. Resolves https://github.com/google/fscrypt/issues/357
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index efc953b..5a8b98e 100644
--- a/README.md
+++ b/README.md
@@ -536,8 +536,15 @@ after `pam_unix.so` in `/etc/pam.d/common-session` or similar, but before
which starts processes that access the user's home directory during their
session.
-To make `pam_fscrypt.so` print debugging messages to the system log, add the
-`debug` option. All hook types accept this option.
+`pam_fscrypt.so` accepts several options:
+
+* `debug`: print additional debug messages to the syslog. All hook types accept
+ this option.
+
+* `unlock_only`: only unlock directories (at log-in); don't also lock them (at
+ log-out). This is only relevant for the "session" hook. Note that in
+ `fscrypt` v0.2.9 and earlier, unlock-only was the default behavior, and
+ `lock_policies` needed to be specified to enable locking.
### Allowing `fscrypt` to check your login passphrase