diff options
author | Lennart Poettering <lennart@poettering.net> | 2024-11-22 10:10:11 +0100 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2024-11-22 10:42:37 +0100 |
commit | 3ae48d071cc7d039e1bd58d073bf4cba8724849b (patch) | |
tree | b790bf33f147d04e399fa68824468c2455b53316 /man/systemd-cryptenroll.xml | |
parent | cgroup-util: fix memory leak on error (diff) | |
download | systemd-3ae48d071cc7d039e1bd58d073bf4cba8724849b.tar.xz systemd-3ae48d071cc7d039e1bd58d073bf4cba8724849b.zip |
man: add enrollment type sections to cryptenroll man page
We have the same sections in the --help text, hence we even more so
should have them in the man page.
Diffstat (limited to 'man/systemd-cryptenroll.xml')
-rw-r--r-- | man/systemd-cryptenroll.xml | 87 |
1 files changed, 64 insertions, 23 deletions
diff --git a/man/systemd-cryptenroll.xml b/man/systemd-cryptenroll.xml index 63d378fbc6..8ac98a6cf7 100644 --- a/man/systemd-cryptenroll.xml +++ b/man/systemd-cryptenroll.xml @@ -265,33 +265,12 @@ </refsect1> <refsect1> - <title>Options</title> + <title>Unlocking</title> - <para>The following options are understood:</para> + <para>The following options are understood that may be used to unlock the device in preparation of the enrollment operations:</para> <variablelist> <varlistentry> - <term><option>--password</option></term> - - <listitem><para>Enroll a regular password/passphrase. This command is mostly equivalent to - <command>cryptsetup luksAddKey</command>, however may be combined with - <option>--wipe-slot=</option> in one call, see below.</para> - - <xi:include href="version-info.xml" xpointer="v248"/></listitem> - </varlistentry> - - <varlistentry> - <term><option>--recovery-key</option></term> - - <listitem><para>Enroll a recovery key. Recovery keys are mostly identical to passphrases, but are - computer-generated instead of being chosen by a human, and thus have a guaranteed high entropy. The - key uses a character set that is easy to type in, and may be scanned off screen via a QR code. - </para> - - <xi:include href="version-info.xml" xpointer="v248"/></listitem> - </varlistentry> - - <varlistentry> <term><option>--unlock-key-file=<replaceable>PATH</replaceable></option></term> <listitem><para>Use a file instead of a password/passphrase read from stdin to unlock the volume. @@ -328,7 +307,45 @@ <xi:include href="version-info.xml" xpointer="v256"/></listitem> </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Simple Enrollment</title> + + <para>The following options are understood that may be used to enroll simple user input based + unlocking:</para> + + <variablelist> + <varlistentry> + <term><option>--password</option></term> + + <listitem><para>Enroll a regular password/passphrase. This command is mostly equivalent to + <command>cryptsetup luksAddKey</command>, however may be combined with + <option>--wipe-slot=</option> in one call, see below.</para> + + <xi:include href="version-info.xml" xpointer="v248"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--recovery-key</option></term> + + <listitem><para>Enroll a recovery key. Recovery keys are mostly identical to passphrases, but are + computer-generated instead of being chosen by a human, and thus have a guaranteed high entropy. The + key uses a character set that is easy to type in, and may be scanned off screen via a QR code. + </para> + + <xi:include href="version-info.xml" xpointer="v248"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>PKCS#11 Enrollment</title> + + <para>The following option is understood that may be used to enroll PKCS#11 tokens:</para> + + <variablelist> <varlistentry> <term><option>--pkcs11-token-uri=<replaceable>URI</replaceable></option></term> @@ -361,7 +378,15 @@ <xi:include href="version-info.xml" xpointer="v248"/></listitem> </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>FIDO2 Enrollment</title> + + <para>The following options are understood that may be used to enroll PKCS#11 tokens:</para> + <variablelist> <varlistentry> <term><option>--fido2-credential-algorithm=<replaceable>STRING</replaceable></option></term> <listitem><para>Specify COSE algorithm used in credential generation. The default value is @@ -461,7 +486,15 @@ <xi:include href="version-info.xml" xpointer="v249"/></listitem> </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>TPM2 Enrollment</title> + + <para>The following options are understood that may be used to enroll TPM2 devices:</para> + <variablelist> <varlistentry> <term><option>--tpm2-device=<replaceable>PATH</replaceable></option></term> @@ -636,7 +669,15 @@ <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> + </variablelist> + </refsect1> + <refsect1> + <title>Other Options</title> + + <para>The following additional options are understood:</para> + + <variablelist> <varlistentry> <term><option>--wipe-slot=<replaceable>SLOT<optional>,SLOT...</optional></replaceable></option></term> |