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