diff options
Diffstat (limited to 'man/systemd-cryptsetup.xml')
| -rw-r--r-- | man/systemd-cryptsetup.xml | 74 |
1 files changed, 63 insertions, 11 deletions
diff --git a/man/systemd-cryptsetup.xml b/man/systemd-cryptsetup.xml index fb7861c..676a38a 100644 --- a/man/systemd-cryptsetup.xml +++ b/man/systemd-cryptsetup.xml @@ -1,9 +1,9 @@ <?xml version="1.0"?> <!--*-nxml-*--> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-cryptsetup" conditional='HAVE_LIBCRYPTSETUP'> +<refentry id="systemd-cryptsetup" conditional='HAVE_LIBCRYPTSETUP' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>systemd-cryptsetup</title> @@ -51,7 +51,7 @@ <para><filename>systemd-cryptsetup</filename> is used to set up (with <command>attach</command>) and tear down (with <command>detach</command>) access to an encrypted block device. It is primarily used via - <filename>systemd-cryptsetup@.service</filename> during early boot, but may also be be called manually. + <filename>systemd-cryptsetup@.service</filename> during early boot, but may also be called manually. The positional arguments <parameter>VOLUME</parameter>, <parameter>SOURCE-DEVICE</parameter>, <parameter>KEY-FILE</parameter>, and <parameter>CRYPTTAB-OPTIONS</parameter> have the same meaning as the fields in <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. @@ -105,15 +105,67 @@ </refsect1> <refsect1> + <title>Credentials</title> + + <para><command>systemd-cryptsetup</command> supports the service credentials logic as implemented by + <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> + (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details). The following credentials are used by <literal>systemd-crypsetup@root.service</literal> + (generated by <command>systemd-gpt-auto-generator</command>) when passed in:</para> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>cryptsetup.passphrase</varname></term> + + <listitem><para>This credential specifies the passphrase of the LUKS volume.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.tpm2-pin</varname></term> + + <listitem><para>This credential specifies the TPM pin.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.fido2-pin</varname></term> + + <listitem><para>This credential specifies the FIDO2 token pin.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.pkcs11-pin</varname></term> + + <listitem><para>This credential specifies the PKCS11 token pin.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.luks2-pin</varname></term> + + <listitem><para>This credential specifies the PIN requested by generic LUKS2 token modules.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink></member> + </simplelist></para> </refsect1> </refentry> |