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           xmlns:xi="http://www.w3.org/2001/XInclude">
   8
   9   <refentryinfo>
  10     <title>systemd-integritysetup@.service</title>
  11     <productname>systemd</productname>
  12   </refentryinfo>
  13
  14   <refmeta>
  15     <refentrytitle>systemd-integritysetup@.service</refentrytitle>
  16     <manvolnum>8</manvolnum>
  17   </refmeta>
  18
  19   <refnamediv>
  20     <refname>systemd-integritysetup@.service</refname>
  21     <refname>systemd-integritysetup</refname>
  22     <refpurpose>Disk integrity protection logic</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <para><filename>systemd-integritysetup@.service</filename></para>
  27     <para><filename>/usr/lib/systemd/systemd-integritysetup</filename></para>
  28   </refsynopsisdiv>
  29
  30   <refsect1>
  31     <title>Description</title>
  32
  33     <para><filename>systemd-integritysetup@.service</filename> is a service responsible for setting up integrity
  34     protected block devices. It should be instantiated for each device that requires integrity
  35     protection.</para>
  36
  37     <para>At early boot and when the system manager configuration is reloaded, entries from
  38     <citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry> are
  39     converted into <filename>systemd-integritysetup@.service</filename> units by
  40     <citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  41
  42     <para><filename>systemd-integritysetup@.service</filename> calls <command>systemd-integritysetup</command>.</para>
  43   </refsect1>
  44
  45   <refsect1>
  46     <title>Commands</title>
  47
  48     <para>The following commands are understood by <command>systemd-integritysetup</command>:</para>
  49
  50     <variablelist>
  51       <varlistentry>
  52         <term>
  53           <option>attach</option>
  54           <replaceable>volume</replaceable>
  55           <replaceable>device</replaceable>
  56           [<replaceable>key-file|-</replaceable>]
  57           [<replaceable>option(s)|-</replaceable>]
  58         </term>
  59
  60         <listitem><para>Create a block device <replaceable>volume</replaceable> using
  61         <replaceable>device</replaceable>. See
  62         <citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  63         and
  64         <ulink url="https://docs.kernel.org/admin-guide/device-mapper/dm-integrity.html">
  65           Kernel dm-integrity</ulink> documentation for details.
  66         </para>
  67
  68         <xi:include href="version-info.xml" xpointer="v250"/></listitem>
  69       </varlistentry>
  70
  71       <varlistentry>
  72         <term>
  73           <option>detach</option>
  74           <replaceable>volume</replaceable>
  75         </term>
  76
  77         <listitem><para>Detach (destroy) the block device
  78         <replaceable>volume</replaceable>.</para>
  79
  80         <xi:include href="version-info.xml" xpointer="v250"/></listitem>
  81       </varlistentry>
  82
  83       <varlistentry>
  84         <term>
  85           <option>help</option>
  86         </term>
  87
  88         <listitem><para>Print short information about command syntax.</para>
  89
  90         <xi:include href="version-info.xml" xpointer="v250"/></listitem>
  91       </varlistentry>
  92     </variablelist>
  93   </refsect1>
  94
  95   <refsect1>
  96     <title>See Also</title>
  97     <para>
  98       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  99       <citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 100       <citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 101       <citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 102      </para>
 103   </refsect1>
 104
 105 </refentry>