[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 |
|
---|
| 7 | <!ENTITY keyutils-download-http "http://people.redhat.com/~dhowells/keyutils/keyutils-&keyutils-version;.tar.bz2">
|
---|
| 8 | <!ENTITY keyutils-download-ftp " ">
|
---|
[d8377ddb] | 9 | <!ENTITY keyutils-md5sum "7f8ac985c45086b5fbcd12cecd23cf07">
|
---|
| 10 | <!ENTITY keyutils-size "76 KB">
|
---|
[3b9423ac] | 11 | <!ENTITY keyutils-buildsize "1.7 MB">
|
---|
[d8377ddb] | 12 | <!ENTITY keyutils-time "less than 0.1 SBU">
|
---|
[fcc6d60] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="keyutils" xreflabel="keyutils-&keyutils-version;">
|
---|
| 16 | <?dbhtml filename="keyutils.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>keyutils-&keyutils-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="keyutils">
|
---|
| 26 | <primary sortas="a-keyutils">keyutils</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to keyutils</title>
|
---|
| 31 |
|
---|
| 32 | <para>Keyutils is a set of utilities for managing the key retention
|
---|
| 33 | facility in the kernel, which can be used by filesystems, block devices and
|
---|
| 34 | more to gain and retain the authorization and encryption keys required to
|
---|
| 35 | perform secure operations.</para>
|
---|
[0d7900a] | 36 |
|
---|
[dfa7724] | 37 | &lfs77_checked;
|
---|
[fcc6d60] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (HTTP): <ulink url="&keyutils-download-http;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download (FTP): <ulink url="&keyutils-download-ftp;"/></para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download MD5 sum: &keyutils-md5sum;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download size: &keyutils-size;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated disk space required: &keyutils-buildsize;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Estimated build time: &keyutils-time;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | </itemizedlist>
|
---|
| 60 |
|
---|
| 61 | <para condition="html" role="usernotes">User Notes:
|
---|
| 62 | <ulink url="&blfs-wiki;/keyutils"/></para>
|
---|
| 63 |
|
---|
| 64 | </sect2>
|
---|
| 65 |
|
---|
| 66 | <sect2 role="installation">
|
---|
| 67 | <title>Installation of keyutils</title>
|
---|
| 68 |
|
---|
| 69 | <para>Install <application>keyutils</application> by running the following
|
---|
| 70 | commands:</para>
|
---|
| 71 |
|
---|
| 72 | <screen><userinput>make</userinput></screen>
|
---|
| 73 |
|
---|
| 74 | <para>This package does not come with a test suite.</para>
|
---|
| 75 |
|
---|
| 76 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 77 |
|
---|
[27d214c3] | 78 | <screen role="root"><userinput>make NO_ARLIB=1 install</userinput></screen>
|
---|
| 79 |
|
---|
| 80 | </sect2>
|
---|
| 81 |
|
---|
| 82 | <sect2 role="commands">
|
---|
| 83 | <title>Command Explanations</title>
|
---|
| 84 |
|
---|
| 85 | <para>
|
---|
| 86 | <parameter>NO_ARLIB=1</parameter>: This make flag disables installing the
|
---|
| 87 | static library.
|
---|
| 88 | </para>
|
---|
| 89 |
|
---|
| 90 | </sect2>
|
---|
| 91 |
|
---|
| 92 | <sect2 role="configuration">
|
---|
| 93 | <title>Configuring keyutils</title>
|
---|
| 94 |
|
---|
| 95 | <sect3 id="keyutils-config">
|
---|
| 96 | <title>Config Files</title>
|
---|
| 97 |
|
---|
| 98 | <para>
|
---|
| 99 | <filename>/etc/request-key.conf</filename> and
|
---|
| 100 | <filename>/etc/request-key.d/*</filename>
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <indexterm zone="keyutils keyutils-config">
|
---|
| 104 | <primary sortas="e-etc-request-key.conf">/etc/request-key.conf</primary>
|
---|
| 105 | </indexterm>
|
---|
| 106 |
|
---|
| 107 | <indexterm zone="keyutils keyutils-config">
|
---|
| 108 | <primary sortas="e-etc-request-key.d">/etc/request-key.d/*</primary>
|
---|
| 109 | </indexterm>
|
---|
| 110 |
|
---|
| 111 | </sect3>
|
---|
[fcc6d60] | 112 |
|
---|
| 113 | </sect2>
|
---|
| 114 |
|
---|
| 115 | <sect2 role="content">
|
---|
| 116 | <title>Contents</title>
|
---|
| 117 |
|
---|
| 118 | <segmentedlist>
|
---|
| 119 | <segtitle>Installed Programs</segtitle>
|
---|
| 120 | <segtitle>Installed Library</segtitle>
|
---|
| 121 | <segtitle>Installed Directory</segtitle>
|
---|
| 122 |
|
---|
| 123 | <seglistitem>
|
---|
| 124 | <seg>keyctl, key.dns_resolver, and request-key</seg>
|
---|
[27d214c3] | 125 | <seg>libkeyutils.so</seg>
|
---|
[d8377ddb] | 126 | <seg>/etc/request-key.d and /usr/share/keyutils</seg>
|
---|
[fcc6d60] | 127 | </seglistitem>
|
---|
| 128 | </segmentedlist>
|
---|
| 129 |
|
---|
| 130 | <variablelist>
|
---|
| 131 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 132 | <?dbfo list-presentation="list"?>
|
---|
| 133 | <?dbhtml list-presentation="table"?>
|
---|
| 134 |
|
---|
| 135 | <varlistentry id="keyctl">
|
---|
| 136 | <term><command>keyctl</command></term>
|
---|
| 137 | <listitem>
|
---|
| 138 | <para>is to control the key management facility in various ways
|
---|
| 139 | using a variety of subcommands.</para>
|
---|
| 140 | <indexterm zone="keyutils keyctl">
|
---|
| 141 | <primary sortas="b-keyctl">keyctl</primary>
|
---|
| 142 | </indexterm>
|
---|
| 143 | </listitem>
|
---|
| 144 | </varlistentry>
|
---|
| 145 |
|
---|
[7e2908c] | 146 | <varlistentry id="key.dns_resolver">
|
---|
| 147 | <term><command>key.dns_resolver</command></term>
|
---|
| 148 | <listitem>
|
---|
| 149 | <para>
|
---|
| 150 | is invoked by <command>request-key</command> on behalf of the
|
---|
| 151 | kernel when kernel services (such as NFS, CIFS and AFS) need to
|
---|
| 152 | perform a hostname lookup and the kernel does not have the key
|
---|
| 153 | cached. It is not ordinarily intended to be called directly.
|
---|
| 154 | </para>
|
---|
| 155 | <indexterm zone="keyutils key.dns_resolver">
|
---|
| 156 | <primary sortas="b-key.dns_resolver">key.dns_resolver</primary>
|
---|
| 157 | </indexterm>
|
---|
| 158 | </listitem>
|
---|
| 159 | </varlistentry>
|
---|
| 160 |
|
---|
| 161 | <varlistentry id="request-key">
|
---|
| 162 | <term><command>request-key</command></term>
|
---|
| 163 | <listitem>
|
---|
| 164 | <para>
|
---|
| 165 | is invoked by the kernel when the kernel is asked for a key that it
|
---|
| 166 | doesn't have immediately available. The kernel creates a temporary
|
---|
| 167 | key and then calls out to this program to instantiate it. It is
|
---|
| 168 | not intended to be called directly.
|
---|
| 169 | </para>
|
---|
| 170 | <indexterm zone="keyutils request-key">
|
---|
| 171 | <primary sortas="b-request-keyt-key">request-key</primary>
|
---|
| 172 | </indexterm>
|
---|
| 173 | </listitem>
|
---|
| 174 | </varlistentry>
|
---|
| 175 |
|
---|
[fcc6d60] | 176 | <varlistentry id="libkeyutils">
|
---|
[27d214c3] | 177 | <term><filename class='libraryfile'>libkeyutils.so</filename></term>
|
---|
[fcc6d60] | 178 | <listitem>
|
---|
[7e2908c] | 179 | <para>
|
---|
| 180 | contains the keyutils library API instantiation.
|
---|
| 181 | </para>
|
---|
[fcc6d60] | 182 | <indexterm zone="keyutils libkeyutils">
|
---|
[27d214c3] | 183 | <primary sortas="c-libkeyutils">libkeyutils.so</primary>
|
---|
[fcc6d60] | 184 | </indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | </variablelist>
|
---|
| 189 |
|
---|
| 190 | </sect2>
|
---|
| 191 |
|
---|
| 192 | </sect1>
|
---|