594167
From ae4da9f80eb84469b0fbb3e02bfe95751d4513dd Mon Sep 17 00:00:00 2001
594167
From: Grigori Goronzy <greg@chown.ath.cx>
594167
Date: Fri, 18 Feb 2022 12:51:00 +0100
594167
Subject: [PATCH] cryptenroll: add TPM2 PIN documentation
594167
594167
(cherry picked from commit caeb5604f9fd8e7aa43c7a1c853f8a7597240b17)
594167
594167
Related: #2087652
594167
---
594167
 man/systemd-cryptenroll.xml | 18 ++++++++++++++++++
594167
 1 file changed, 18 insertions(+)
594167
594167
diff --git a/man/systemd-cryptenroll.xml b/man/systemd-cryptenroll.xml
594167
index d5fdb54cdd..58a4626768 100644
594167
--- a/man/systemd-cryptenroll.xml
594167
+++ b/man/systemd-cryptenroll.xml
594167
@@ -299,6 +299,24 @@
594167
         signatures likely will validate against pre-existing certificates.</para></listitem>
594167
       </varlistentry>
594167
 
594167
+      <varlistentry>
594167
+        <term><option>--tpm2-with-pin=</option><replaceable>BOOL</replaceable></term>
594167
+
594167
+        <listitem><para>When enrolling a TPM2 device, controls whether to require the user to enter a PIN
594167
+        when unlocking the volume in addition to PCR binding, based on TPM2 policy authentication. Defaults
594167
+        to <literal>no</literal>. Despite being called PIN, any character can be used, not just numbers.
594167
+        </para>
594167
+
594167
+        <para>Note that incorrect PIN entry when unlocking increments the
594167
+        TPM dictionary attack lockout mechanism, and may lock out users for a prolonged time, depending on
594167
+        its configuration. The lockout mechanism is a global property of the TPM,
594167
+        <command>systemd-cryptenroll</command> does not control or configure the lockout mechanism. You may
594167
+        use tpm2-tss tools to inspect or configure the dictionary attack lockout, with
594167
+        <citerefentry><refentrytitle>tpm2_getcap</refentrytitle><manvolnum>1</manvolnum></citerefentry> and
594167
+        <citerefentry><refentrytitle>tpm2_dictionarylockout</refentrytitle><manvolnum>1</manvolnum></citerefentry>
594167
+        commands, respectively.</para></listitem>
594167
+      </varlistentry>
594167
+
594167
       <varlistentry>
594167
         <term><option>--wipe-slot=</option><arg rep="repeat">SLOT</arg></term>
594167