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