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   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24 <refentry id="systemd-cryptsetup@.service" conditional='HAVE_LIBCRYPTSETUP'>
  25
  26   <refentryinfo>
  27     <title>systemd-cryptsetup@.service</title>
  28     <productname>systemd</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>systemd-cryptsetup@.service</refentrytitle>
  42     <manvolnum>8</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>systemd-cryptsetup@.service</refname>
  47     <refname>systemd-cryptsetup</refname>
  48     <refpurpose>Full disk decryption logic</refpurpose>
  49   </refnamediv>
  50
  51   <refsynopsisdiv>
  52     <para><filename>systemd-cryptsetup@.service</filename></para>
  53     <para><filename>/usr/lib/systemd/systemd-cryptsetup</filename></para>
  54   </refsynopsisdiv>
  55
  56   <refsect1>
  57     <title>Description</title>
  58
  59     <para><filename>systemd-cryptsetup@.service</filename> is a
  60     service responsible for setting up encrypted block devices. It is
  61     instantiated for each device that requires decryption for
  62     access.</para>
  63
  64     <para><filename>systemd-cryptsetup@.service</filename> will ask
  65     for hard disk passwords via the <ulink
  66     url="https://www.freedesktop.org/wiki/Software/systemd/PasswordAgents">
  67     password agent logic</ulink>, in order to query the user for the
  68     password using the right mechanism at boot and during
  69     runtime.</para>
  70
  71     <para>At early boot and when the system manager configuration is reloaded, <filename>/etc/crypttab</filename> is
  72     translated into <filename>systemd-cryptsetup@.service</filename> units by
  73     <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
  74   </refsect1>
  75
  76   <refsect1>
  77     <title>See Also</title>
  78     <para>
  79       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  80       <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  81       <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  82       <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  83      </para>
  84   </refsect1>
  85
  86 </refentry>