diff options
| author | Gaël PORTAY <gael.portay@collabora.com> | 2020-12-27 08:55:09 -0500 |
|---|---|---|
| committer | Gaël PORTAY <gael.portay@rtone.fr> | 2023-04-13 05:39:49 +0200 |
| commit | 21c60c76e10b23d47b97fdd88a56314fc0b3c66b (patch) | |
| tree | 8e5dea7199a6901173cd55896c62ec2f7c335e9d /man | |
| parent | 0bbf7a842a3feb4952415d82d2b469f5c5d91836 (diff) | |
| download | systemd-21c60c76e10b23d47b97fdd88a56314fc0b3c66b.tar.gz | |
veritysetup: add support for fec options
The verity fec_* parameters allows to use Forward Error Correction to
recover from corruption if hash verification fails.
This adds the options fec_device, fec_offset and fec_roots (sixth
argument) which are the equivalent of the options --fec-device,
--fec-offset and --fec-roots in the veritysetup world.
- fec-device=FILE
- fec-offset=BYTES
- fec-roots=UINT64
See `veritysetup(8)` for more details.
Diffstat (limited to 'man')
| -rw-r--r-- | man/systemd-veritysetup-generator.xml | 3 | ||||
| -rw-r--r-- | man/veritytab.xml | 24 |
2 files changed, 26 insertions, 1 deletions
diff --git a/man/systemd-veritysetup-generator.xml b/man/systemd-veritysetup-generator.xml index c591fcb24f..71bc1fda64 100644 --- a/man/systemd-veritysetup-generator.xml +++ b/man/systemd-veritysetup-generator.xml @@ -94,7 +94,8 @@ <option>salt=<replaceable>HEX</replaceable></option>, <option>uuid=<replaceable>UUID</replaceable></option>, <option>ignore-corruption</option>, <option>restart-on-corruption</option>, <option>ignore-zero-blocks</option>, <option>check-at-most-once</option>, <option>panic-on-corruption</option>, - <option>hash=<replaceable>HASH</replaceable></option> and + <option>hash=<replaceable>HASH</replaceable></option>, <option>fec-device=<replaceable>PATH</replaceable></option>, + <option>fec-offset=<replaceable>BYTES</replaceable></option>, <option>fec-roots=<replaceable>NUM</replaceable></option> and <option>root-hash-signature=<replaceable>PATH</replaceable>|base64:<replaceable>HEX</replaceable></option>. See <citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more details.</para></listitem> diff --git a/man/veritytab.xml b/man/veritytab.xml index b4f2be3e30..557d13e1ed 100644 --- a/man/veritytab.xml +++ b/man/veritytab.xml @@ -158,6 +158,30 @@ This is based on crypttab(5). </varlistentry> <varlistentry> + <term><option>fec-device=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Use forward error correction (FEC) to recover from corruption if hash verification fails. Use + encoding data from the specified device. The fec device argument can be block device or file image. For format, + if fec device path doesn't exist, it will be created as file. Note: block sizes for data and hash devices must + match. Also, if the verity data_device is encrypted the fec_device should be too.</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>fec-offset=<replaceable>BYTES</replaceable></option></term> + + <listitem><para>This is the offset, in bytes, from the start of the FEC device to the beginning of the encoding + data. (Aligned on 512 bytes.)</para></listitem> + </varlistentry> + + <varlistentry> + <term><option>fec-roots=<replaceable>NUM</replaceable></option></term> + + <listitem><para>Number of generator roots. This equals to the number of parity bytes in the encoding data. In + RS(M, N) encoding, the number of roots is M-N. M is 255 and M-N is between 2 and 24 (including).</para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>root-hash-signature=<replaceable>PATH</replaceable>|base64:<replaceable>HEX</replaceable></option></term> <listitem><para>A base64 string encoding the root hash signature prefixed by <literal>base64:</literal> or a |