[6dcb9e77] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY cryptsetup-download-http "&kernel-dl;/linux/utils/cryptsetup/v&cryptsetup-minor;/cryptsetup-&cryptsetup-version;.tar.xz">
|
---|
[6dcb9e77] | 8 | <!ENTITY cryptsetup-download-ftp " ">
|
---|
| 9 | <!ENTITY cryptsetup-md5sum "d2d668223e795dcf750da44dc3e7076b">
|
---|
| 10 | <!ENTITY cryptsetup-size "1.2 MB">
|
---|
| 11 | <!ENTITY cryptsetup-buildsize "12 MB">
|
---|
| 12 | <!ENTITY cryptsetup-time "0.1 SBU (add 7.4 SBU for tests)">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="cryptsetup" xreflabel="cryptsetup-&cryptsetup-version;">
|
---|
| 16 | <?dbhtml filename="cryptsetup.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>cryptsetup-&cryptsetup-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="cryptsetup">
|
---|
| 26 | <primary sortas="a-cryptsetup">cryptsetup</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to cryptsetup</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | cryptsetup is used to set up transparent encryption of block devices
|
---|
| 34 | using the kernel crypto API.
|
---|
| 35 | </para>
|
---|
| 36 |
|
---|
[89d6c9a] | 37 | &lfs82_checked;
|
---|
[6dcb9e77] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&cryptsetup-download-http;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&cryptsetup-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download MD5 sum: &cryptsetup-md5sum;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download size: &cryptsetup-size;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated disk space required: &cryptsetup-buildsize;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated build time: &cryptsetup-time;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect3">cryptsetup Dependencies</bridgehead>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 76 | <para role="required">
|
---|
[416617d6] | 77 | <xref linkend="lvm2"/>,
|
---|
| 78 | <xref linkend="popt"/>, and one of
|
---|
[6dcb9e77] | 79 | <xref linkend="libgcrypt"/>,
|
---|
[94b42903] | 80 | <xref linkend="nettle"/>, or
|
---|
| 81 | <xref linkend="nss"/> (libgcrypt is the default)
|
---|
[6dcb9e77] | 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
| 86 | <xref linkend="libpwquality"/>,
|
---|
| 87 | <xref linkend="python2"/>, and
|
---|
| 88 | <ulink url="http://www.openwall.com/passwdqc/">passwdqc</ulink>
|
---|
| 89 | </para>
|
---|
| 90 |
|
---|
| 91 |
|
---|
| 92 | <para condition="html" role="usernotes">User Notes:
|
---|
| 93 | <ulink url="&blfs-wiki;/cryptsetup"/>
|
---|
| 94 | </para>
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="kernel" id="cryptsetup-kernel">
|
---|
| 98 | <title>Kernel Configuration</title>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
[416617d6] | 101 | Encrypted block devices require kernel support. To use it, the
|
---|
[6dcb9e77] | 102 | appropriate kernel configuration parameters need to be set:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <screen><literal>Device Drivers --->
|
---|
| 106 | [*] Multiple devices driver support (RAID and LVM) ---> [CONFIG_MD]
|
---|
| 107 | <*/M> Device mapper support [CONFIG_BLK_DEV_DM]
|
---|
| 108 | <*/M> Crypt target support [CONFIG_DM_CRYPT]
|
---|
| 109 |
|
---|
| 110 | Cryptographic API --->
|
---|
| 111 | <*/M> XTS support [CONFIG_CRYPTO_XTS]
|
---|
| 112 | <*/M> SHA224 and SHA256 digest algorithm [CONFIG_CRYPTO_SHA256]
|
---|
| 113 | <*/M> AES cipher algorithms [CONFIG_CRYPTO_AES]
|
---|
| 114 | <*/M> AES cipher algorithms (x86_64) [CONFIG_CRYPTO_AES_X86_64]
|
---|
| 115 | <*/M> User-space interface for symmetric key cipher algorithms
|
---|
| 116 | [CONFIG_CRYPTO_USER_API_SKCIPHER]
|
---|
| 117 | For tests:
|
---|
| 118 | <*/M> Twofish cipher algorithm [CONFIG_CRYPTO_TWOFISH]</literal></screen>
|
---|
| 119 |
|
---|
| 120 | <indexterm zone="cryptsetup cryptsetup-kernel">
|
---|
| 121 | <primary sortas="d-cryptsetup">cryptsetup</primary>
|
---|
| 122 | </indexterm>
|
---|
| 123 |
|
---|
| 124 | </sect2>
|
---|
| 125 |
|
---|
| 126 | <sect2 role="installation">
|
---|
| 127 | <title>Installation of cryptsetup</title>
|
---|
| 128 |
|
---|
| 129 | <para>
|
---|
| 130 | Install <application>cryptsetup</application> by running the following
|
---|
| 131 | commands:
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
| 134 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 135 | make</userinput></screen>
|
---|
| 136 |
|
---|
| 137 | <para>
|
---|
| 138 | To test the result, issue as the <systemitem
|
---|
| 139 | class="username">root</systemitem> user: <command>make check</command>
|
---|
| 140 | </para>
|
---|
| 141 |
|
---|
| 142 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 143 |
|
---|
| 144 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 145 |
|
---|
| 146 | </sect2>
|
---|
| 147 |
|
---|
| 148 |
|
---|
| 149 | <sect2 role="configuration">
|
---|
| 150 | <title>Configuring cryptsetup</title>
|
---|
| 151 |
|
---|
| 152 | <para>
|
---|
[effdf5be] | 153 | Because of the number of possible configurations, setup of encrypted
|
---|
| 154 | volumes is beyond the scope of the BLFS book. Please see the
|
---|
| 155 | configuration guide in the cryptsetup <ulink
|
---|
| 156 | url="https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions#2-setup">
|
---|
| 157 | FAQ</ulink>.
|
---|
[6dcb9e77] | 158 | </para>
|
---|
| 159 |
|
---|
| 160 | </sect2>
|
---|
| 161 |
|
---|
| 162 | <sect2 role="content">
|
---|
| 163 | <title>Contents</title>
|
---|
| 164 |
|
---|
| 165 | <segmentedlist>
|
---|
| 166 | <segtitle>Installed Programs</segtitle>
|
---|
| 167 | <segtitle>Installed Libraries</segtitle>
|
---|
| 168 | <segtitle>Installed Directories</segtitle>
|
---|
| 169 |
|
---|
| 170 | <seglistitem>
|
---|
| 171 | <seg>
|
---|
| 172 | cryptsetup and
|
---|
| 173 | veritysetup
|
---|
| 174 | </seg>
|
---|
| 175 | <seg>
|
---|
| 176 | libcryptsetup.so
|
---|
| 177 | </seg>
|
---|
| 178 | <seg>
|
---|
| 179 | None
|
---|
| 180 | </seg>
|
---|
| 181 | </seglistitem>
|
---|
| 182 | </segmentedlist>
|
---|
| 183 |
|
---|
| 184 | <variablelist>
|
---|
| 185 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 186 | <?dbfo list-presentation="list"?>
|
---|
| 187 | <?dbhtml list-presentation="table"?>
|
---|
| 188 |
|
---|
| 189 | <varlistentry id="cryptsetup-prog">
|
---|
| 190 | <term><command>cryptsetup</command></term>
|
---|
| 191 | <listitem>
|
---|
| 192 | <para>
|
---|
| 193 | is used to setup dm-crypt managed device-mapper mappings.
|
---|
| 194 | </para>
|
---|
| 195 | <indexterm zone="cryptsetup cryptsetup-prog">
|
---|
| 196 | <primary sortas="b-cryptsetup">cryptsetup</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
| 200 |
|
---|
| 201 | <varlistentry id="veritysetup">
|
---|
| 202 | <term><command>veritysetup</command></term>
|
---|
| 203 | <listitem>
|
---|
| 204 | <para>
|
---|
| 205 | is used to configure dm-verity managed device-mapper mappings.
|
---|
| 206 | Device-mapper verity target provides read-only transparent integrity
|
---|
| 207 | checking of block devices using kernel crypto API.
|
---|
| 208 | </para>
|
---|
| 209 | <indexterm zone="cryptsetup veritysetup">
|
---|
| 210 | <primary sortas="b-veritysetup">veritysetup</primary>
|
---|
| 211 | </indexterm>
|
---|
| 212 | </listitem>
|
---|
| 213 | </varlistentry>
|
---|
| 214 |
|
---|
| 215 | </variablelist>
|
---|
| 216 |
|
---|
| 217 | </sect2>
|
---|
| 218 |
|
---|
| 219 | </sect1>
|
---|