[fcc6d60] | 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 |
|
---|
[c6b192c] | 7 | <!ENTITY keyutils-download-http "https://people.redhat.com/~dhowells/keyutils/keyutils-&keyutils-version;.tar.bz2">
|
---|
[fcc6d60] | 8 | <!ENTITY keyutils-download-ftp " ">
|
---|
[6be9bbb] | 9 | <!ENTITY keyutils-md5sum "919af7f33576816b423d537f8a8692e8">
|
---|
| 10 | <!ENTITY keyutils-size "96 KB">
|
---|
| 11 | <!ENTITY keyutils-buildsize "1.9 MB (with tests)">
|
---|
| 12 | <!ENTITY keyutils-time "less than 0.1 SBU (add 0.6 SBU for tests)">
|
---|
[fcc6d60] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="keyutils" xreflabel="keyutils-&keyutils-version;">
|
---|
| 16 | <?dbhtml filename="keyutils.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>keyutils-&keyutils-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="keyutils">
|
---|
| 22 | <primary sortas="a-keyutils">keyutils</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to keyutils</title>
|
---|
| 27 |
|
---|
[d56e7df] | 28 | <para>
|
---|
| 29 | <application>Keyutils</application> is a set of utilities for managing
|
---|
| 30 | the key retention facility in the kernel, which can be used by
|
---|
| 31 | filesystems, block devices and more to gain and retain the authorization
|
---|
| 32 | and encryption keys required to perform secure operations.
|
---|
| 33 | </para>
|
---|
[0d7900a] | 34 |
|
---|
[a73fc762] | 35 | &lfs120_checked;
|
---|
[fcc6d60] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
[d56e7df] | 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&keyutils-download-http;"/>
|
---|
| 42 | </para>
|
---|
[fcc6d60] | 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
[d56e7df] | 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&keyutils-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
[fcc6d60] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[d56e7df] | 50 | <para>
|
---|
| 51 | Download MD5 sum: &keyutils-md5sum;
|
---|
| 52 | </para>
|
---|
[fcc6d60] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[d56e7df] | 55 | <para>
|
---|
| 56 | Download size: &keyutils-size;
|
---|
| 57 | </para>
|
---|
[fcc6d60] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[d56e7df] | 60 | <para>
|
---|
| 61 | Estimated disk space required: &keyutils-buildsize;
|
---|
| 62 | </para>
|
---|
[fcc6d60] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[d56e7df] | 65 | <para>
|
---|
| 66 | Estimated build time: &keyutils-time;
|
---|
| 67 | </para>
|
---|
[fcc6d60] | 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
[0d38b000] | 71 | <bridgehead renderas="sect3">keyutils Dependencies</bridgehead>
|
---|
[8558044] | 72 |
|
---|
[0d38b000] | 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
| 75 | <xref linkend="mitkrb"/>
|
---|
| 76 | <!-- Without krb5 installed, a FTBFS occurs while trying to compile dns.afsdb.c.
|
---|
| 77 | It looks for profile.h, which is installed by krb5. -->
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
[fcc6d60] | 80 |
|
---|
| 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of keyutils</title>
|
---|
| 85 |
|
---|
[d56e7df] | 86 | <para>
|
---|
| 87 | Install <application>keyutils</application> by running the following
|
---|
| 88 | commands:
|
---|
| 89 | </para>
|
---|
[fcc6d60] | 90 |
|
---|
[c6510a9f] | 91 | <screen><userinput>sed -i 's:$(LIBDIR)/$(PKGCONFIG_DIR):/usr/lib/pkgconfig:' Makefile &&
|
---|
[40fc18f5] | 92 | make</userinput></screen>
|
---|
[fcc6d60] | 93 |
|
---|
[d56e7df] | 94 | <para>
|
---|
[66f1dbd] | 95 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
| 98 | <screen role="root"><userinput>make NO_ARLIB=1 LIBDIR=/usr/lib BINDIR=/usr/bin SBINDIR=/usr/sbin install</userinput></screen>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | The test suite can only run after installing this package.
|
---|
[8558044] | 102 | To test the results, issue, as the
|
---|
[d56e7df] | 103 | <systemitem class="username">root</systemitem> user:
|
---|
| 104 | </para>
|
---|
[864abc6] | 105 |
|
---|
[66f1dbd] | 106 | <screen role="root" remap="test"><userinput>sed -e 's/executable/\\(pie \\)?/' \
|
---|
| 107 | -i tests/toolbox.inc.sh &&
|
---|
| 108 | make -k test</userinput></screen>
|
---|
[f8525af6] | 109 |
|
---|
[d56e7df] | 110 | <para>
|
---|
| 111 | Note that several tests will fail if certain uncommon kernel options
|
---|
| 112 | were not used when the kernel was built. These include CONFIG_BIG_KEYS,
|
---|
| 113 | CONFIG_KEY_DH_OPERATIONS, and CONFIG_CRYPTO_DH.
|
---|
| 114 | </para>
|
---|
[fcc6d60] | 115 |
|
---|
[27d214c3] | 116 | </sect2>
|
---|
| 117 |
|
---|
| 118 | <sect2 role="commands">
|
---|
| 119 | <title>Command Explanations</title>
|
---|
| 120 |
|
---|
[40fc18f5] | 121 | <para>
|
---|
| 122 | <command>sed ... Makefile</command>: This command ensures the pkgconfig
|
---|
| 123 | file is placed in the correct directory.
|
---|
| 124 | </para>
|
---|
| 125 |
|
---|
[66f1dbd] | 126 | <para>
|
---|
| 127 | <command>sed ... tests/toolbox.inc.sh</command>: In LFS, GCC has been
|
---|
| 128 | configured with <option>--enable-default-pie</option> so
|
---|
| 129 | <command>/usr/bin/bash</command> is a PIE, but the test script does
|
---|
| 130 | not anticipate it. Fix this oversight so the test can run on a LFS
|
---|
| 131 | system.
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
[27d214c3] | 134 | <para>
|
---|
| 135 | <parameter>NO_ARLIB=1</parameter>: This make flag disables installing the
|
---|
| 136 | static library.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | </sect2>
|
---|
| 140 |
|
---|
| 141 | <sect2 role="configuration">
|
---|
| 142 | <title>Configuring keyutils</title>
|
---|
| 143 |
|
---|
| 144 | <sect3 id="keyutils-config">
|
---|
| 145 | <title>Config Files</title>
|
---|
| 146 |
|
---|
| 147 | <para>
|
---|
| 148 | <filename>/etc/request-key.conf</filename> and
|
---|
| 149 | <filename>/etc/request-key.d/*</filename>
|
---|
| 150 | </para>
|
---|
| 151 |
|
---|
| 152 | <indexterm zone="keyutils keyutils-config">
|
---|
| 153 | <primary sortas="e-etc-request-key.conf">/etc/request-key.conf</primary>
|
---|
| 154 | </indexterm>
|
---|
| 155 |
|
---|
| 156 | <indexterm zone="keyutils keyutils-config">
|
---|
| 157 | <primary sortas="e-etc-request-key.d">/etc/request-key.d/*</primary>
|
---|
| 158 | </indexterm>
|
---|
| 159 |
|
---|
| 160 | </sect3>
|
---|
[fcc6d60] | 161 |
|
---|
| 162 | </sect2>
|
---|
| 163 |
|
---|
| 164 | <sect2 role="content">
|
---|
| 165 | <title>Contents</title>
|
---|
| 166 |
|
---|
| 167 | <segmentedlist>
|
---|
| 168 | <segtitle>Installed Programs</segtitle>
|
---|
| 169 | <segtitle>Installed Library</segtitle>
|
---|
| 170 | <segtitle>Installed Directory</segtitle>
|
---|
| 171 |
|
---|
| 172 | <seglistitem>
|
---|
| 173 | <seg>keyctl, key.dns_resolver, and request-key</seg>
|
---|
[27d214c3] | 174 | <seg>libkeyutils.so</seg>
|
---|
[d8377ddb] | 175 | <seg>/etc/request-key.d and /usr/share/keyutils</seg>
|
---|
[fcc6d60] | 176 | </seglistitem>
|
---|
| 177 | </segmentedlist>
|
---|
| 178 |
|
---|
| 179 | <variablelist>
|
---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 181 | <?dbfo list-presentation="list"?>
|
---|
| 182 | <?dbhtml list-presentation="table"?>
|
---|
| 183 |
|
---|
| 184 | <varlistentry id="keyctl">
|
---|
| 185 | <term><command>keyctl</command></term>
|
---|
| 186 | <listitem>
|
---|
[d56e7df] | 187 | <para>
|
---|
[4c24eb0a] | 188 | controls the key management facility with a variety of subcommands
|
---|
[d56e7df] | 189 | </para>
|
---|
[fcc6d60] | 190 | <indexterm zone="keyutils keyctl">
|
---|
| 191 | <primary sortas="b-keyctl">keyctl</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
[7e2908c] | 196 | <varlistentry id="key.dns_resolver">
|
---|
| 197 | <term><command>key.dns_resolver</command></term>
|
---|
| 198 | <listitem>
|
---|
| 199 | <para>
|
---|
| 200 | is invoked by <command>request-key</command> on behalf of the
|
---|
| 201 | kernel when kernel services (such as NFS, CIFS and AFS) need to
|
---|
| 202 | perform a hostname lookup and the kernel does not have the key
|
---|
[4c24eb0a] | 203 | cached. It is not ordinarily intended to be called directly
|
---|
[7e2908c] | 204 | </para>
|
---|
| 205 | <indexterm zone="keyutils key.dns_resolver">
|
---|
| 206 | <primary sortas="b-key.dns_resolver">key.dns_resolver</primary>
|
---|
| 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
| 210 |
|
---|
| 211 | <varlistentry id="request-key">
|
---|
| 212 | <term><command>request-key</command></term>
|
---|
| 213 | <listitem>
|
---|
| 214 | <para>
|
---|
| 215 | is invoked by the kernel when the kernel is asked for a key that it
|
---|
| 216 | doesn't have immediately available. The kernel creates a temporary
|
---|
| 217 | key and then calls out to this program to instantiate it. It is
|
---|
[4c24eb0a] | 218 | not intended to be called directly
|
---|
[7e2908c] | 219 | </para>
|
---|
| 220 | <indexterm zone="keyutils request-key">
|
---|
| 221 | <primary sortas="b-request-keyt-key">request-key</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
| 225 |
|
---|
[fcc6d60] | 226 | <varlistentry id="libkeyutils">
|
---|
[4c24eb0a] | 227 | <term><filename class="libraryfile">libkeyutils.so</filename></term>
|
---|
[fcc6d60] | 228 | <listitem>
|
---|
[7e2908c] | 229 | <para>
|
---|
[4c24eb0a] | 230 | contains the keyutils library API instantiation
|
---|
[7e2908c] | 231 | </para>
|
---|
[fcc6d60] | 232 | <indexterm zone="keyutils libkeyutils">
|
---|
[27d214c3] | 233 | <primary sortas="c-libkeyutils">libkeyutils.so</primary>
|
---|
[fcc6d60] | 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 |
|
---|
| 238 | </variablelist>
|
---|
| 239 |
|
---|
| 240 | </sect2>
|
---|
| 241 |
|
---|
| 242 | </sect1>
|
---|