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