man/systemd-integritysetup@.service.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   4   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   5 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
   6 <refentry id="systemd-integritysetup@.service" conditional='HAVE_LIBCRYPTSETUP'>
   7
   8   <refentryinfo>
   9     <title>systemd-integritysetup@.service</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-integritysetup@.service</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-integritysetup@.service</refname>
  20     <refname>systemd-integritysetup</refname>
  21     <refpurpose>Disk integrity protection logic</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><filename>systemd-integritysetup@.service</filename></para>
  26     <para><filename>/usr/lib/systemd/systemd-integritysetup</filename></para>
  27   </refsynopsisdiv>
  28
  29   <refsect1>
  30     <title>Description</title>
  31
  32     <para><filename>systemd-integritysetup@.service</filename> is a service responsible for setting up integrity
  33     protected block devices. It should be instantiated for each device that requires integrity
  34     protection.</para>
  35
  36     <para>At early boot and when the system manager configuration is reloaded, entries from
  37     <citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry> are
  38     converted into <filename>systemd-integritysetup@.service</filename> units by
  39     <citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  40
  41     <para><filename>systemd-integritysetup@.service</filename> calls <command>systemd-integritysetup</command>.</para>
  42   </refsect1>
  43
  44   <refsect1>
  45     <title>Commands</title>
  46
  47     <para>The following commands are understood by <command>systemd-integritysetup</command>:</para>
  48
  49     <variablelist>
  50       <varlistentry>
  51         <term>
  52           <option>attach</option>
  53           <replaceable>volume</replaceable>
  54           <replaceable>device</replaceable>
  55           [<replaceable>key-file|-</replaceable>]
  56           [<replaceable>option(s)|-</replaceable>]
  57         </term>
  58
  59         <listitem><para>Create a block device <replaceable>volume</replaceable> using
  60         <replaceable>device</replaceable>. See
  61         <citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  62         and
  63         <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/device-mapper/dm-integrity.html">
  64           Kernel dm-integrity</ulink> documentation for details.
  65         </para></listitem>
  66       </varlistentry>
  67
  68       <varlistentry>
  69         <term>
  70           <option>detach</option>
  71           <replaceable>volume</replaceable>
  72         </term>
  73
  74         <listitem><para>Detach (destroy) the block device
  75         <replaceable>volume</replaceable>.</para></listitem>
  76       </varlistentry>
  77
  78       <varlistentry>
  79         <term>
  80           <option>help</option>
  81         </term>
  82
  83         <listitem><para>Print short information about command syntax.</para></listitem>
  84       </varlistentry>
  85     </variablelist>
  86   </refsect1>
  87
  88   <refsect1>
  89     <title>See Also</title>
  90     <para>
  91       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  92       <citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  93       <citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  94       <citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  95      </para>
  96   </refsect1>
  97
  98 </refentry>