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