Skip to content

Commit b36dc04

Browse files
poetteringbluca
authored andcommitted
man: explicitly document compat guarantees of cryptenroll vs. cryptsetup
Fixes: #29743 (cherry picked from commit 2441018) (cherry picked from commit 62d51eb) (cherry picked from commit c4958af)
1 parent 428571e commit b36dc04

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

man/systemd-cryptenroll.xml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,30 @@
7979
authentication.</para>
8080
</refsect1>
8181

82+
<refsect1>
83+
<title>Compatibility</title>
84+
85+
<para>Security technology both in systemd and in the general industry constantly evolves. In order to
86+
provide best security guarantees, the way TPM2, FIDO2, PKCS#11 devices are enrolled is regularly updated
87+
in newer versions of systemd. Whenever this happens the following compatibility guarantees are given:</para>
88+
89+
<itemizedlist>
90+
<listitem><para>Old enrollments continue to be supported and may be unlocked with newer versions of
91+
<citerefentry><refentrytitle>[email protected]</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
92+
93+
<listitem><para>The opposite is not guaranteed however: it might not be possible to unlock volumes with
94+
enrollments done with a newer version of <command>systemd-cryptenroll</command> with an older version
95+
of <command>systemd-cryptsetup</command>.</para></listitem>
96+
</itemizedlist>
97+
98+
<para>That said, it is generally recommended to use matching versions of
99+
<command>systemd-cryptenroll</command> and <command>systemd-cryptsetup</command>, since this is best
100+
tested and supported.</para>
101+
102+
<para>It might be advisable to re-enroll existing enrollments to take benefit of newer security features,
103+
as they are added to systemd.</para>
104+
</refsect1>
105+
82106
<refsect1>
83107
<title>Options</title>
84108

0 commit comments

Comments
 (0)