[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[fcc6d60] | 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 |
|
---|
[6961fefc] | 7 | <!ENTITY keyutils-download-http "https://git.kernel.org/pub/scm/linux/kernel/git/dhowells/keyutils.git/snapshot/keyutils-&keyutils-version;.tar.gz">
|
---|
[fcc6d60] | 8 | <!ENTITY keyutils-download-ftp " ">
|
---|
[6961fefc] | 9 | <!ENTITY keyutils-md5sum "6b70b2b381c1b6d9adfaf66d5d3e7c00">
|
---|
| 10 | <!ENTITY keyutils-size "136 KB">
|
---|
| 11 | <!ENTITY keyutils-buildsize "2.6 MB (with tests)">
|
---|
| 12 | <!ENTITY keyutils-time "less than 0.1 SBU (add 0.4 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 |
|
---|
[808fe3aa] | 71 | <bridgehead renderas="sect3">Keyutils Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 74 | <para role="optional">
|
---|
| 75 | <xref linkend="lsb-tools"/> (referred by the test suite)
|
---|
| 76 | </para>
|
---|
[fcc6d60] | 77 | </sect2>
|
---|
| 78 |
|
---|
[434e3e0] | 79 | <sect2 role="kernel" id="keyutils-test-kernel">
|
---|
| 80 | <title>Kernel Configuration</title>
|
---|
| 81 |
|
---|
| 82 | <para>
|
---|
| 83 | If running the test suite, some tests needs the following kernel
|
---|
| 84 | features enabled:
|
---|
| 85 | </para>
|
---|
| 86 |
|
---|
| 87 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 88 | href="keyutils-test-kernel.xml"/>
|
---|
| 89 |
|
---|
| 90 | <indexterm zone="keyutils keyutils-test-kernel">
|
---|
| 91 | <primary sortas="d-keyutils">keyutils (testing)</primary>
|
---|
| 92 | </indexterm>
|
---|
| 93 | </sect2>
|
---|
[fcc6d60] | 94 | <sect2 role="installation">
|
---|
| 95 | <title>Installation of keyutils</title>
|
---|
| 96 |
|
---|
[d56e7df] | 97 | <para>
|
---|
| 98 | Install <application>keyutils</application> by running the following
|
---|
| 99 | commands:
|
---|
| 100 | </para>
|
---|
[fcc6d60] | 101 |
|
---|
[6961fefc] | 102 | <screen><userinput>make</userinput></screen>
|
---|
[fcc6d60] | 103 |
|
---|
[d56e7df] | 104 | <para>
|
---|
[66f1dbd] | 105 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <screen role="root"><userinput>make NO_ARLIB=1 LIBDIR=/usr/lib BINDIR=/usr/bin SBINDIR=/usr/sbin install</userinput></screen>
|
---|
| 109 |
|
---|
| 110 | <para>
|
---|
| 111 | The test suite can only run after installing this package.
|
---|
[8558044] | 112 | To test the results, issue, as the
|
---|
[d56e7df] | 113 | <systemitem class="username">root</systemitem> user:
|
---|
| 114 | </para>
|
---|
[864abc6] | 115 |
|
---|
[6961fefc] | 116 | <screen role="root" remap="test"><userinput>make -k test</userinput></screen>
|
---|
[f8525af6] | 117 |
|
---|
[d56e7df] | 118 | <para>
|
---|
[808fe3aa] | 119 | If <xref linkend='lsb-tools'/> is not installed, the test suite will
|
---|
| 120 | output some lines complaining the <command>lsb_release</command>
|
---|
[b2787106] | 121 | command not available but it won't affect the test result. One test
|
---|
| 122 | named <literal>TRY ADDING ASYMMETRIC KEYS</literal> is known to fail
|
---|
| 123 | due to the removal of the support for SHA1 with RSA signature
|
---|
| 124 | algorithm from Linux kernel version 6.7 <!-- commit 16ab7cb5825f -->
|
---|
| 125 | or newer.
|
---|
[d56e7df] | 126 | </para>
|
---|
[fcc6d60] | 127 |
|
---|
[27d214c3] | 128 | </sect2>
|
---|
| 129 |
|
---|
| 130 | <sect2 role="commands">
|
---|
| 131 | <title>Command Explanations</title>
|
---|
| 132 |
|
---|
[6961fefc] | 133 | <!--
|
---|
[40fc18f5] | 134 | <para>
|
---|
| 135 | <command>sed ... Makefile</command>: This command ensures the pkgconfig
|
---|
| 136 | file is placed in the correct directory.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
[66f1dbd] | 139 | <para>
|
---|
| 140 | <command>sed ... tests/toolbox.inc.sh</command>: In LFS, GCC has been
|
---|
[6961fefc] | 141 | configured with <option>- -enable-default-pie</option> so
|
---|
[66f1dbd] | 142 | <command>/usr/bin/bash</command> is a PIE, but the test script does
|
---|
| 143 | not anticipate it. Fix this oversight so the test can run on a LFS
|
---|
| 144 | system.
|
---|
| 145 | </para>
|
---|
[6961fefc] | 146 | -->
|
---|
[66f1dbd] | 147 |
|
---|
[27d214c3] | 148 | <para>
|
---|
| 149 | <parameter>NO_ARLIB=1</parameter>: This make flag disables installing the
|
---|
| 150 | static library.
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | </sect2>
|
---|
| 154 |
|
---|
| 155 | <sect2 role="configuration">
|
---|
| 156 | <title>Configuring keyutils</title>
|
---|
| 157 |
|
---|
| 158 | <sect3 id="keyutils-config">
|
---|
| 159 | <title>Config Files</title>
|
---|
| 160 |
|
---|
| 161 | <para>
|
---|
| 162 | <filename>/etc/request-key.conf</filename> and
|
---|
| 163 | <filename>/etc/request-key.d/*</filename>
|
---|
| 164 | </para>
|
---|
| 165 |
|
---|
| 166 | <indexterm zone="keyutils keyutils-config">
|
---|
| 167 | <primary sortas="e-etc-request-key.conf">/etc/request-key.conf</primary>
|
---|
| 168 | </indexterm>
|
---|
| 169 |
|
---|
| 170 | <indexterm zone="keyutils keyutils-config">
|
---|
| 171 | <primary sortas="e-etc-request-key.d">/etc/request-key.d/*</primary>
|
---|
| 172 | </indexterm>
|
---|
| 173 |
|
---|
| 174 | </sect3>
|
---|
[fcc6d60] | 175 |
|
---|
| 176 | </sect2>
|
---|
| 177 |
|
---|
| 178 | <sect2 role="content">
|
---|
| 179 | <title>Contents</title>
|
---|
| 180 |
|
---|
| 181 | <segmentedlist>
|
---|
| 182 | <segtitle>Installed Programs</segtitle>
|
---|
| 183 | <segtitle>Installed Library</segtitle>
|
---|
| 184 | <segtitle>Installed Directory</segtitle>
|
---|
| 185 |
|
---|
| 186 | <seglistitem>
|
---|
| 187 | <seg>keyctl, key.dns_resolver, and request-key</seg>
|
---|
[27d214c3] | 188 | <seg>libkeyutils.so</seg>
|
---|
[6961fefc] | 189 | <seg>/etc/keyutils,
|
---|
| 190 | /etc/request-key.d,
|
---|
| 191 | and /usr/share/keyutils</seg>
|
---|
[fcc6d60] | 192 | </seglistitem>
|
---|
| 193 | </segmentedlist>
|
---|
| 194 |
|
---|
| 195 | <variablelist>
|
---|
| 196 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 197 | <?dbfo list-presentation="list"?>
|
---|
| 198 | <?dbhtml list-presentation="table"?>
|
---|
| 199 |
|
---|
| 200 | <varlistentry id="keyctl">
|
---|
| 201 | <term><command>keyctl</command></term>
|
---|
| 202 | <listitem>
|
---|
[d56e7df] | 203 | <para>
|
---|
[4c24eb0a] | 204 | controls the key management facility with a variety of subcommands
|
---|
[d56e7df] | 205 | </para>
|
---|
[fcc6d60] | 206 | <indexterm zone="keyutils keyctl">
|
---|
| 207 | <primary sortas="b-keyctl">keyctl</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
[7e2908c] | 212 | <varlistentry id="key.dns_resolver">
|
---|
| 213 | <term><command>key.dns_resolver</command></term>
|
---|
| 214 | <listitem>
|
---|
| 215 | <para>
|
---|
| 216 | is invoked by <command>request-key</command> on behalf of the
|
---|
| 217 | kernel when kernel services (such as NFS, CIFS and AFS) need to
|
---|
| 218 | perform a hostname lookup and the kernel does not have the key
|
---|
[4c24eb0a] | 219 | cached. It is not ordinarily intended to be called directly
|
---|
[7e2908c] | 220 | </para>
|
---|
| 221 | <indexterm zone="keyutils key.dns_resolver">
|
---|
| 222 | <primary sortas="b-key.dns_resolver">key.dns_resolver</primary>
|
---|
| 223 | </indexterm>
|
---|
| 224 | </listitem>
|
---|
| 225 | </varlistentry>
|
---|
| 226 |
|
---|
| 227 | <varlistentry id="request-key">
|
---|
| 228 | <term><command>request-key</command></term>
|
---|
| 229 | <listitem>
|
---|
| 230 | <para>
|
---|
| 231 | is invoked by the kernel when the kernel is asked for a key that it
|
---|
| 232 | doesn't have immediately available. The kernel creates a temporary
|
---|
| 233 | key and then calls out to this program to instantiate it. It is
|
---|
[4c24eb0a] | 234 | not intended to be called directly
|
---|
[7e2908c] | 235 | </para>
|
---|
| 236 | <indexterm zone="keyutils request-key">
|
---|
| 237 | <primary sortas="b-request-keyt-key">request-key</primary>
|
---|
| 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
[fcc6d60] | 242 | <varlistentry id="libkeyutils">
|
---|
[4c24eb0a] | 243 | <term><filename class="libraryfile">libkeyutils.so</filename></term>
|
---|
[fcc6d60] | 244 | <listitem>
|
---|
[7e2908c] | 245 | <para>
|
---|
[4c24eb0a] | 246 | contains the keyutils library API instantiation
|
---|
[7e2908c] | 247 | </para>
|
---|
[fcc6d60] | 248 | <indexterm zone="keyutils libkeyutils">
|
---|
[27d214c3] | 249 | <primary sortas="c-libkeyutils">libkeyutils.so</primary>
|
---|
[fcc6d60] | 250 | </indexterm>
|
---|
| 251 | </listitem>
|
---|
| 252 | </varlistentry>
|
---|
| 253 |
|
---|
| 254 | </variablelist>
|
---|
| 255 |
|
---|
| 256 | </sect2>
|
---|
| 257 |
|
---|
| 258 | </sect1>
|
---|