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