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 |
|
---|
7 | <!ENTITY volume_key-download-http "https://releases.pagure.org/volume_key/volume_key-&volume_key-version;.tar.xz">
|
---|
8 | <!ENTITY volume_key-download-ftp " ">
|
---|
9 | <!ENTITY volume_key-md5sum "a2d14931177c660e1f3ebbcf5f47d8e2">
|
---|
10 | <!ENTITY volume_key-size "436 KB">
|
---|
11 | <!ENTITY volume_key-buildsize "7.9 MB">
|
---|
12 | <!ENTITY volume_key-time "0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="volume_key" xreflabel="volume_key-&volume_key-version;">
|
---|
16 | <?dbhtml filename="volume_key.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy: fernando $</othername>
|
---|
20 | <date>$Date: 2015-09-25 08:48:24 -0500 (Fri, 25 Sep 2015) $</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>volume_key-&volume_key-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="volume_key">
|
---|
26 | <primary sortas="a-volume_key">volume_key</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to volume_key</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | The <application>volume_key</application> package provides
|
---|
34 | a library for manipulating storage volume encryption keys and storing
|
---|
35 | them separately from volumes to handle forgotten passphrases.
|
---|
36 | </para>
|
---|
37 |
|
---|
38 | &lfs82_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>
|
---|
44 | Download (HTTP): <ulink url="&volume_key-download-http;"/>
|
---|
45 | </para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>
|
---|
49 | Download (FTP): <ulink url="&volume_key-download-ftp;"/>
|
---|
50 | </para>
|
---|
51 | </listitem>
|
---|
52 | <listitem>
|
---|
53 | <para>
|
---|
54 | Download MD5 sum: &volume_key-md5sum;
|
---|
55 | </para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>
|
---|
59 | Download size: &volume_key-size;
|
---|
60 | </para>
|
---|
61 | </listitem>
|
---|
62 | <listitem>
|
---|
63 | <para>
|
---|
64 | Estimated disk space required: &volume_key-buildsize;
|
---|
65 | </para>
|
---|
66 | </listitem>
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Estimated build time: &volume_key-time;
|
---|
70 | </para>
|
---|
71 | </listitem>
|
---|
72 | </itemizedlist>
|
---|
73 |
|
---|
74 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
75 | <itemizedlist spacing="compact">
|
---|
76 | <listitem>
|
---|
77 | <para>
|
---|
78 | Required patch:
|
---|
79 | <ulink url="&patch-root;/volume_key-&volume_key-version;-cryptsetup2-1.patch"/>
|
---|
80 | </para>
|
---|
81 | </listitem>
|
---|
82 | </itemizedlist>
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect3">volume_key Dependencies</bridgehead>
|
---|
85 |
|
---|
86 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
87 | <para role="required">
|
---|
88 | <xref linkend="cryptsetup"/>,
|
---|
89 | <xref linkend="glib2"/>,
|
---|
90 | <xref linkend="gpgme"/>, and
|
---|
91 | <xref linkend="python2"/>
|
---|
92 | </para>
|
---|
93 |
|
---|
94 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
95 | <para role="optional">
|
---|
96 | <xref linkend="swig"/>
|
---|
97 | </para>
|
---|
98 | <!--
|
---|
99 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
100 | <para role="optional">
|
---|
101 | <xref linkend="python3"/>
|
---|
102 | </para>
|
---|
103 | -->
|
---|
104 | <para condition="html" role="usernotes">User Notes:
|
---|
105 | <ulink url="&blfs-wiki;/volume_key"/>
|
---|
106 | </para>
|
---|
107 | </sect2>
|
---|
108 |
|
---|
109 | <sect2 role="installation">
|
---|
110 | <title>Installation of volume_key</title>
|
---|
111 |
|
---|
112 | <para>
|
---|
113 | Install <application>volume_key</application> by running the following
|
---|
114 | commands:
|
---|
115 | </para>
|
---|
116 |
|
---|
117 | <screen><userinput>patch -Np1 -i ../volume_key-&volume_key-version;-cryptsetup2-1.patch &&
|
---|
118 |
|
---|
119 | ./configure --prefix=/usr &&
|
---|
120 | make</userinput></screen>
|
---|
121 |
|
---|
122 | <para>
|
---|
123 | This package does not come with a functioning test suite.
|
---|
124 | </para>
|
---|
125 |
|
---|
126 | <para>
|
---|
127 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | <screen role="root"><userinput>make install &&
|
---|
131 | sed -i '/config.h/d' /usr/include/volume_key/libvolume_key.h</userinput></screen>
|
---|
132 |
|
---|
133 | </sect2>
|
---|
134 |
|
---|
135 | <sect2 role="commands">
|
---|
136 | <title>Command Explanations</title>
|
---|
137 |
|
---|
138 | <para>
|
---|
139 | <command>sed -i '/config.h/d' /usr/include/volume_key/libvolume_key.h</command>:
|
---|
140 | Removes a reference to config.h, which is not installed.
|
---|
141 | </para>
|
---|
142 |
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="content">
|
---|
146 | <title>Contents</title>
|
---|
147 |
|
---|
148 | <segmentedlist>
|
---|
149 | <segtitle>Installed Program</segtitle>
|
---|
150 | <segtitle>Installed Library</segtitle>
|
---|
151 | <segtitle>Installed Directory</segtitle>
|
---|
152 |
|
---|
153 | <seglistitem>
|
---|
154 | <seg>
|
---|
155 | volume_key
|
---|
156 | </seg>
|
---|
157 | <seg>
|
---|
158 | libvolume_key.so
|
---|
159 | </seg>
|
---|
160 | <seg>
|
---|
161 | /usr/include/volume_key
|
---|
162 | </seg>
|
---|
163 | </seglistitem>
|
---|
164 | </segmentedlist>
|
---|
165 |
|
---|
166 | <variablelist>
|
---|
167 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
168 | <?dbfo list-presentation="list"?>
|
---|
169 | <?dbhtml list-presentation="table"?>
|
---|
170 |
|
---|
171 | <varlistentry id="volume_key-prog">
|
---|
172 | <term><command>volume_key</command></term>
|
---|
173 | <listitem>
|
---|
174 | <para>
|
---|
175 | manages encrypted volume keys and passphrases.
|
---|
176 | </para>
|
---|
177 | <indexterm zone="volume_key volume_key-prog">
|
---|
178 | <primary sortas="b-volume_key">volume_key</primary>
|
---|
179 | </indexterm>
|
---|
180 | </listitem>
|
---|
181 | </varlistentry>
|
---|
182 |
|
---|
183 | <varlistentry id="volume_key-lib">
|
---|
184 | <term><filename class="libraryfile">volume_key.so</filename></term>
|
---|
185 | <listitem>
|
---|
186 | <para>
|
---|
187 | contains API functions for managing encrypted volume keys.
|
---|
188 | </para>
|
---|
189 | <indexterm zone="volume_key volume_key-lib">
|
---|
190 | <primary sortas="c-volume_key">volume_key.so</primary>
|
---|
191 | </indexterm>
|
---|
192 | </listitem>
|
---|
193 | </varlistentry>
|
---|
194 |
|
---|
195 | </variablelist>
|
---|
196 |
|
---|
197 | </sect2>
|
---|
198 |
|
---|
199 | </sect1>
|
---|