source: general/genlib/keyutils.xml@ 8e266c6

perl-modules
Last change on this file since 8e266c6 was 8e266c6, checked in by Pierre Labastie <pieere@…>, 3 years ago

Merge r20475 to r20480 from trunk

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/perl-modules@20481 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 6.4 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 "http://people.redhat.com/~dhowells/keyutils/keyutils-&keyutils-version;.tar.bz2">
8 <!ENTITY keyutils-download-ftp " ">
9 <!ENTITY keyutils-md5sum "bcc0984181572461850a37c39f8b167a">
10 <!ENTITY keyutils-size "88 KB">
11 <!ENTITY keyutils-buildsize "1.5 MB">
12 <!ENTITY keyutils-time "less than 0.1 SBU">
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>
36
37 &lfs83_checked;
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>To test the results, issue, as the
75 <systemitem class="username">root</systemitem> user: </para>
76
77<screen role="root"><userinput>sed -i '/find/s:/usr/bin/::' tests/Makefile &amp;&amp;
78make -k test </userinput></screen>
79
80 <para>Note that several tests will fail if certain uncommon kernel options
81 were not used when the kernel was built. These include CONFIG_BIG_KEYS,
82 CONFIG_KEY_DH_OPERATIONS, and CONFIG_CRYPTO_DH.</para>
83
84 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
85
86<screen role="root"><userinput>make NO_ARLIB=1 install</userinput></screen>
87
88 </sect2>
89
90 <sect2 role="commands">
91 <title>Command Explanations</title>
92
93 <para>
94 <parameter>NO_ARLIB=1</parameter>: This make flag disables installing the
95 static library.
96 </para>
97
98 </sect2>
99
100 <sect2 role="configuration">
101 <title>Configuring keyutils</title>
102
103 <sect3 id="keyutils-config">
104 <title>Config Files</title>
105
106 <para>
107 <filename>/etc/request-key.conf</filename> and
108 <filename>/etc/request-key.d/*</filename>
109 </para>
110
111 <indexterm zone="keyutils keyutils-config">
112 <primary sortas="e-etc-request-key.conf">/etc/request-key.conf</primary>
113 </indexterm>
114
115 <indexterm zone="keyutils keyutils-config">
116 <primary sortas="e-etc-request-key.d">/etc/request-key.d/*</primary>
117 </indexterm>
118
119 </sect3>
120
121 </sect2>
122
123 <sect2 role="content">
124 <title>Contents</title>
125
126 <segmentedlist>
127 <segtitle>Installed Programs</segtitle>
128 <segtitle>Installed Library</segtitle>
129 <segtitle>Installed Directory</segtitle>
130
131 <seglistitem>
132 <seg>keyctl, key.dns_resolver, and request-key</seg>
133 <seg>libkeyutils.so</seg>
134 <seg>/etc/request-key.d and /usr/share/keyutils</seg>
135 </seglistitem>
136 </segmentedlist>
137
138 <variablelist>
139 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
140 <?dbfo list-presentation="list"?>
141 <?dbhtml list-presentation="table"?>
142
143 <varlistentry id="keyctl">
144 <term><command>keyctl</command></term>
145 <listitem>
146 <para>is to control the key management facility in various ways
147 using a variety of subcommands.</para>
148 <indexterm zone="keyutils keyctl">
149 <primary sortas="b-keyctl">keyctl</primary>
150 </indexterm>
151 </listitem>
152 </varlistentry>
153
154 <varlistentry id="key.dns_resolver">
155 <term><command>key.dns_resolver</command></term>
156 <listitem>
157 <para>
158 is invoked by <command>request-key</command> on behalf of the
159 kernel when kernel services (such as NFS, CIFS and AFS) need to
160 perform a hostname lookup and the kernel does not have the key
161 cached. It is not ordinarily intended to be called directly.
162 </para>
163 <indexterm zone="keyutils key.dns_resolver">
164 <primary sortas="b-key.dns_resolver">key.dns_resolver</primary>
165 </indexterm>
166 </listitem>
167 </varlistentry>
168
169 <varlistentry id="request-key">
170 <term><command>request-key</command></term>
171 <listitem>
172 <para>
173 is invoked by the kernel when the kernel is asked for a key that it
174 doesn't have immediately available. The kernel creates a temporary
175 key and then calls out to this program to instantiate it. It is
176 not intended to be called directly.
177 </para>
178 <indexterm zone="keyutils request-key">
179 <primary sortas="b-request-keyt-key">request-key</primary>
180 </indexterm>
181 </listitem>
182 </varlistentry>
183
184 <varlistentry id="libkeyutils">
185 <term><filename class='libraryfile'>libkeyutils.so</filename></term>
186 <listitem>
187 <para>
188 contains the keyutils library API instantiation.
189 </para>
190 <indexterm zone="keyutils libkeyutils">
191 <primary sortas="c-libkeyutils">libkeyutils.so</primary>
192 </indexterm>
193 </listitem>
194 </varlistentry>
195
196 </variablelist>
197
198 </sect2>
199
200</sect1>
Note: See TracBrowser for help on using the repository browser.