man/systemd-cryptsetup@.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+ -->
   6 <refentry id="systemd-cryptsetup@.service" conditional='HAVE_LIBCRYPTSETUP'>
   7
   8   <refentryinfo>
   9     <title>systemd-cryptsetup@.service</title>
  10     <productname>systemd</productname>
  11   </refentryinfo>
  12
  13   <refmeta>
  14     <refentrytitle>systemd-cryptsetup@.service</refentrytitle>
  15     <manvolnum>8</manvolnum>
  16   </refmeta>
  17
  18   <refnamediv>
  19     <refname>systemd-cryptsetup@.service</refname>
  20     <refname>systemd-cryptsetup</refname>
  21     <refpurpose>Full disk decryption logic</refpurpose>
  22   </refnamediv>
  23
  24   <refsynopsisdiv>
  25     <para><filename>systemd-cryptsetup@.service</filename></para>
  26     <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para>
  27   </refsynopsisdiv>
  28
  29   <refsect1>
  30     <title>Description</title>
  31
  32     <para><filename>systemd-cryptsetup@.service</filename> is a
  33     service responsible for setting up encrypted block devices. It is
  34     instantiated for each device that requires decryption for
  35     access.</para>
  36
  37     <para><filename>systemd-cryptsetup@.service</filename> will ask
  38     for hard disk passwords via the <ulink
  39     url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
  40     password agent logic</ulink>, in order to query the user for the
  41     password using the right mechanism at boot and during
  42     runtime.</para>
  43
  44     <para>At early boot and when the system manager configuration is reloaded, <filename>/etc/crypttab</filename> is
  45     translated into <filename>systemd-cryptsetup@.service</filename> units by
  46     <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  47   </refsect1>
  48
  49   <refsect1>
  50     <title>See Also</title>
  51     <para>
  52       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  53       <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  54       <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  55       <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  56      </para>
  57   </refsect1>
  58
  59 </refentry>