man/systemd-cryptsetup@.service.xml

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