Skip to content

Commit 62d51eb

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

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
@@ -235,6 +235,30 @@
235235
limitation does not apply to PKCS#11 tokens.</para>
236236
</refsect1>
237237

238+
<refsect1>
239+
<title>Compatibility</title>
240+
241+
<para>Security technology both in systemd and in the general industry constantly evolves. In order to
242+
provide best security guarantees, the way TPM2, FIDO2, PKCS#11 devices are enrolled is regularly updated
243+
in newer versions of systemd. Whenever this happens the following compatibility guarantees are given:</para>
244+
245+
<itemizedlist>
246+
<listitem><para>Old enrollments continue to be supported and may be unlocked with newer versions of
247+
<citerefentry><refentrytitle>[email protected]</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
248+
249+
<listitem><para>The opposite is not guaranteed however: it might not be possible to unlock volumes with
250+
enrollments done with a newer version of <command>systemd-cryptenroll</command> with an older version
251+
of <command>systemd-cryptsetup</command>.</para></listitem>
252+
</itemizedlist>
253+
254+
<para>That said, it is generally recommended to use matching versions of
255+
<command>systemd-cryptenroll</command> and <command>systemd-cryptsetup</command>, since this is best
256+
tested and supported.</para>
257+
258+
<para>It might be advisable to re-enroll existing enrollments to take benefit of newer security features,
259+
as they are added to systemd.</para>
260+
</refsect1>
261+
238262
<refsect1>
239263
<title>Options</title>
240264

0 commit comments

Comments
 (0)