source: general/genlib/keyutils.xml@ 2929f2c

11.0 lazarus qt5new trunk
Last change on this file since 2929f2c was 2929f2c, checked in by Douglas R. Reno <renodr@…>, 4 months ago

keyutils: Remove unnecessary test adaptation now that /bin and /usr/bin
are the same.

  • Property mode set to 100644
File size: 7.1 KB
Line 
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 "https://people.redhat.com/~dhowells/keyutils/keyutils-&keyutils-version;.tar.bz2">
8 <!ENTITY keyutils-download-ftp " ">
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)">
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
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>
37
38 &lfs101_checked;
39
40 <bridgehead renderas="sect3">Package Information</bridgehead>
41 <itemizedlist spacing="compact">
42 <listitem>
43 <para>
44 Download (HTTP): <ulink url="&keyutils-download-http;"/>
45 </para>
46 </listitem>
47 <listitem>
48 <para>
49 Download (FTP): <ulink url="&keyutils-download-ftp;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download MD5 sum: &keyutils-md5sum;
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download size: &keyutils-size;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Estimated disk space required: &keyutils-buildsize;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated build time: &keyutils-time;
70 </para>
71 </listitem>
72 </itemizedlist>
73
74 <bridgehead renderas="sect3">keyutils Dependencies</bridgehead>
75
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
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
91 <para>
92 Install <application>keyutils</application> by running the following
93 commands:
94 </para>
95
96<screen><userinput>sed -i 's:$(LIBDIR)/$(PKGCONFIG_DIR):/usr/lib/pkgconfig:' Makefile &amp;&amp;
97make</userinput></screen>
98
99 <para>
100 To test the results, issue, as the
101 <systemitem class="username">root</systemitem> user:
102 </para>
103
104<screen role="root" remap="test"><userinput>make -k test</userinput></screen>
105
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>
111
112 <para>
113 Now, as the <systemitem class="username">root</systemitem> user:
114 </para>
115
116<screen role="root"><userinput>make NO_ARLIB=1 install</userinput></screen>
117
118 </sect2>
119
120 <sect2 role="commands">
121 <title>Command Explanations</title>
122
123 <para>
124 <command>sed ... Makefile</command>: This command ensures the pkgconfig
125 file is placed in the correct directory.
126 </para>
127
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>
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>
168 <seg>libkeyutils.so</seg>
169 <seg>/etc/request-key.d and /usr/share/keyutils</seg>
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>
181 <para>
182 controls the key management facility with a variety of subcommands
183 </para>
184 <indexterm zone="keyutils keyctl">
185 <primary sortas="b-keyctl">keyctl</primary>
186 </indexterm>
187 </listitem>
188 </varlistentry>
189
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
197 cached. It is not ordinarily intended to be called directly
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
212 not intended to be called directly
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
220 <varlistentry id="libkeyutils">
221 <term><filename class="libraryfile">libkeyutils.so</filename></term>
222 <listitem>
223 <para>
224 contains the keyutils library API instantiation
225 </para>
226 <indexterm zone="keyutils libkeyutils">
227 <primary sortas="c-libkeyutils">libkeyutils.so</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 </variablelist>
233
234 </sect2>
235
236</sect1>
Note: See TracBrowser for help on using the repository browser.