[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 " ">
|
---|
[b5dc1cf] | 9 | <!ENTITY cryptsetup-md5sum "48be3bd7c557d051f638047d280e93ee">
|
---|
| 10 | <!ENTITY cryptsetup-size "11 MB">
|
---|
| 11 | <!ENTITY cryptsetup-buildsize "29 MB (add 12 MB for tests)">
|
---|
| 12 | <!ENTITY cryptsetup-time "0.2 SBU (add 15 SBU for tests)">
|
---|
[6dcb9e77] | 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 |
|
---|
[90c883f] | 37 | &lfs91_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">
|
---|
[6cc2f9a8] | 77 | <xref linkend="json-c"/>,
|
---|
[82e1be5] | 78 | <xref linkend="libgcrypt"/>,
|
---|
[6cc2f9a8] | 79 | <xref linkend="lvm2"/>, and
|
---|
[4509c956] | 80 | <xref linkend="popt"/>
|
---|
[6dcb9e77] | 81 | </para>
|
---|
| 82 |
|
---|
| 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
| 85 | <xref linkend="libpwquality"/>,
|
---|
| 86 | <xref linkend="python2"/>, and
|
---|
| 87 | <ulink url="http://www.openwall.com/passwdqc/">passwdqc</ulink>
|
---|
| 88 | </para>
|
---|
| 89 |
|
---|
| 90 |
|
---|
| 91 | <para condition="html" role="usernotes">User Notes:
|
---|
| 92 | <ulink url="&blfs-wiki;/cryptsetup"/>
|
---|
| 93 | </para>
|
---|
| 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="kernel" id="cryptsetup-kernel">
|
---|
| 97 | <title>Kernel Configuration</title>
|
---|
| 98 |
|
---|
| 99 | <para>
|
---|
[416617d6] | 100 | Encrypted block devices require kernel support. To use it, the
|
---|
[6dcb9e77] | 101 | appropriate kernel configuration parameters need to be set:
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
| 104 | <screen><literal>Device Drivers --->
|
---|
| 105 | [*] Multiple devices driver support (RAID and LVM) ---> [CONFIG_MD]
|
---|
| 106 | <*/M> Device mapper support [CONFIG_BLK_DEV_DM]
|
---|
| 107 | <*/M> Crypt target support [CONFIG_DM_CRYPT]
|
---|
| 108 |
|
---|
| 109 | Cryptographic API --->
|
---|
| 110 | <*/M> XTS support [CONFIG_CRYPTO_XTS]
|
---|
| 111 | <*/M> SHA224 and SHA256 digest algorithm [CONFIG_CRYPTO_SHA256]
|
---|
| 112 | <*/M> AES cipher algorithms [CONFIG_CRYPTO_AES]
|
---|
| 113 | <*/M> AES cipher algorithms (x86_64) [CONFIG_CRYPTO_AES_X86_64]
|
---|
| 114 | <*/M> User-space interface for symmetric key cipher algorithms
|
---|
| 115 | [CONFIG_CRYPTO_USER_API_SKCIPHER]
|
---|
| 116 | For tests:
|
---|
| 117 | <*/M> Twofish cipher algorithm [CONFIG_CRYPTO_TWOFISH]</literal></screen>
|
---|
| 118 |
|
---|
| 119 | <indexterm zone="cryptsetup cryptsetup-kernel">
|
---|
| 120 | <primary sortas="d-cryptsetup">cryptsetup</primary>
|
---|
| 121 | </indexterm>
|
---|
| 122 |
|
---|
| 123 | </sect2>
|
---|
| 124 |
|
---|
| 125 | <sect2 role="installation">
|
---|
| 126 | <title>Installation of cryptsetup</title>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
| 129 | Install <application>cryptsetup</application> by running the following
|
---|
| 130 | commands:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
[4509c956] | 133 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 134 | --with-crypto_backend=openssl &&
|
---|
[6dcb9e77] | 135 | make</userinput></screen>
|
---|
| 136 |
|
---|
| 137 | <para>
|
---|
| 138 | To test the result, issue as the <systemitem
|
---|
[9f5dcb97] | 139 | class="username">root</systemitem> user: <command>make check</command>.
|
---|
| 140 | Some tests may fail if the kernel configuration parameters above are not
|
---|
[b5dc1cf] | 141 | set. Three (of 21) tests are known to fail.
|
---|
[6dcb9e77] | 142 | </para>
|
---|
| 143 |
|
---|
| 144 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 145 |
|
---|
| 146 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 147 |
|
---|
| 148 | </sect2>
|
---|
| 149 |
|
---|
[4509c956] | 150 | <sect2 role="commands">
|
---|
| 151 | <title>Command Explanations</title>
|
---|
| 152 |
|
---|
| 153 | <para><parameter>--with-crypto_backend=openssl</parameter>:
|
---|
| 154 | This parameter selects the cryptographic libraries to use
|
---|
| 155 | with the application. <application>gcrypt</application>
|
---|
| 156 | is the default.</para>
|
---|
| 157 |
|
---|
| 158 | </sect2>
|
---|
[6dcb9e77] | 159 |
|
---|
| 160 | <sect2 role="configuration">
|
---|
| 161 | <title>Configuring cryptsetup</title>
|
---|
| 162 |
|
---|
| 163 | <para>
|
---|
[effdf5be] | 164 | Because of the number of possible configurations, setup of encrypted
|
---|
| 165 | volumes is beyond the scope of the BLFS book. Please see the
|
---|
| 166 | configuration guide in the cryptsetup <ulink
|
---|
| 167 | url="https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions#2-setup">
|
---|
| 168 | FAQ</ulink>.
|
---|
[6dcb9e77] | 169 | </para>
|
---|
| 170 |
|
---|
| 171 | </sect2>
|
---|
| 172 |
|
---|
| 173 | <sect2 role="content">
|
---|
| 174 | <title>Contents</title>
|
---|
| 175 |
|
---|
| 176 | <segmentedlist>
|
---|
| 177 | <segtitle>Installed Programs</segtitle>
|
---|
| 178 | <segtitle>Installed Libraries</segtitle>
|
---|
| 179 | <segtitle>Installed Directories</segtitle>
|
---|
| 180 |
|
---|
| 181 | <seglistitem>
|
---|
| 182 | <seg>
|
---|
[9f5dcb97] | 183 | cryptsetup,
|
---|
| 184 | cryptsetup-reencrypt,
|
---|
| 185 | integritysetup, and
|
---|
[6dcb9e77] | 186 | veritysetup
|
---|
| 187 | </seg>
|
---|
| 188 | <seg>
|
---|
| 189 | libcryptsetup.so
|
---|
| 190 | </seg>
|
---|
| 191 | <seg>
|
---|
| 192 | None
|
---|
| 193 | </seg>
|
---|
| 194 | </seglistitem>
|
---|
| 195 | </segmentedlist>
|
---|
| 196 |
|
---|
| 197 | <variablelist>
|
---|
| 198 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 199 | <?dbfo list-presentation="list"?>
|
---|
| 200 | <?dbhtml list-presentation="table"?>
|
---|
| 201 |
|
---|
| 202 | <varlistentry id="cryptsetup-prog">
|
---|
| 203 | <term><command>cryptsetup</command></term>
|
---|
| 204 | <listitem>
|
---|
| 205 | <para>
|
---|
| 206 | is used to setup dm-crypt managed device-mapper mappings.
|
---|
| 207 | </para>
|
---|
| 208 | <indexterm zone="cryptsetup cryptsetup-prog">
|
---|
| 209 | <primary sortas="b-cryptsetup">cryptsetup</primary>
|
---|
| 210 | </indexterm>
|
---|
| 211 | </listitem>
|
---|
| 212 | </varlistentry>
|
---|
| 213 |
|
---|
[9f5dcb97] | 214 | <varlistentry id="cryptsetup-reencrypt">
|
---|
| 215 | <term><command>cryptsetup-reencrypt</command></term>
|
---|
| 216 | <listitem>
|
---|
| 217 | <para>
|
---|
| 218 | is a for offline LUKS device re-encryption.
|
---|
| 219 | </para>
|
---|
| 220 | <indexterm zone="cryptsetup cryptsetup-reencrypt">
|
---|
| 221 | <primary sortas="b-cryptsetup-reencrypt">cryptsetup-reencrypt</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
| 225 |
|
---|
| 226 | <varlistentry id="integritysetup">
|
---|
| 227 | <term><command>integritysetup</command></term>
|
---|
| 228 | <listitem>
|
---|
| 229 | <para>
|
---|
| 230 | is a tool to manage dm-integrity (block level integrity) volumes.
|
---|
| 231 | </para>
|
---|
| 232 | <indexterm zone="cryptsetup integritysetup">
|
---|
| 233 | <primary sortas="b-integritysetup">integritysetup</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 |
|
---|
[6dcb9e77] | 238 | <varlistentry id="veritysetup">
|
---|
| 239 | <term><command>veritysetup</command></term>
|
---|
| 240 | <listitem>
|
---|
| 241 | <para>
|
---|
| 242 | is used to configure dm-verity managed device-mapper mappings.
|
---|
| 243 | Device-mapper verity target provides read-only transparent integrity
|
---|
| 244 | checking of block devices using kernel crypto API.
|
---|
| 245 | </para>
|
---|
| 246 | <indexterm zone="cryptsetup veritysetup">
|
---|
| 247 | <primary sortas="b-veritysetup">veritysetup</primary>
|
---|
| 248 | </indexterm>
|
---|
| 249 | </listitem>
|
---|
| 250 | </varlistentry>
|
---|
| 251 |
|
---|
| 252 | </variablelist>
|
---|
| 253 |
|
---|
| 254 | </sect2>
|
---|
| 255 |
|
---|
| 256 | </sect1>
|
---|