1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<refentry id="pam_keyinit">
<refmeta>
<refentrytitle>pam_keyinit</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
</refmeta>
<refnamediv id="pam_keyinit-name">
<refname>pam_keyinit</refname>
<refpurpose>Kernel session keyring initialiser module</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="pam_keyinit-cmdsynopsis">
<command>pam_keyinit.so</command>
<arg choice="opt">
debug
</arg>
<arg choice="opt">
force
</arg>
<arg choice="opt">
revoke
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="pam_keyinit-description">
<title>DESCRIPTION</title>
<para>
The pam_keyinit PAM module ensures that the invoking process has a
session keyring other than the user default session keyring.
</para>
<para>
The module checks to see if the process's session keyring is the
<citerefentry>
<refentrytitle>user-session-keyring</refentrytitle><manvolnum>7</manvolnum>
</citerefentry>,
and, if it is, creates a new
<citerefentry>
<refentrytitle>session-keyring</refentrytitle><manvolnum>7</manvolnum>
</citerefentry>
with which to replace it. If a new session keyring is created, it will
install a link to the
<citerefentry>
<refentrytitle>user-keyring</refentrytitle><manvolnum>7</manvolnum>
</citerefentry>
in the session keyring so that keys common to the user will be
automatically accessible through it. The session keyring of the invoking
process will thenceforth be inherited by all its children unless they override it.
</para>
<para>
In order to allow other PAM modules to attach tokens to the keyring, this module
provides both an <emphasis>auth</emphasis> (limited to
<citerefentry>
<refentrytitle>pam_setcred</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>
and a <emphasis>session</emphasis> component. The session keyring is created
in the module called. Moreover this module should be included as early as
possible in a PAM configuration.
</para>
<para>
This module is intended primarily for use by login processes. Be aware
that after the session keyring has been replaced, the old session keyring
and the keys it contains will no longer be accessible.
</para>
<para>
This module should not, generally, be invoked by programs like
<emphasis remap='B'>su</emphasis>, since it is usually desirable for the
key set to percolate through to the alternate context. The keys have
their own permissions system to manage this.
</para>
<para>
The keyutils package is used to manipulate keys more directly. This
can be obtained from:
</para>
<para>
<ulink url="http://people.redhat.com/~dhowells/keyutils/">
Keyutils
</ulink>
</para>
</refsect1>
<refsect1 id="pam_keyinit-options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
<option>debug</option>
</term>
<listitem>
<para>
Log debug information with <citerefentry>
<refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>force</option>
</term>
<listitem>
<para>
Causes the session keyring of the invoking process to be replaced
unconditionally.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>revoke</option>
</term>
<listitem>
<para>
Causes the session keyring of the invoking process to be revoked
when the invoking process exits if the session keyring was created
for this process in the first place.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="pam_keyinit-types">
<title>MODULE TYPES PROVIDED</title>
<para>
Only the <option>session</option> module type is provided.
</para>
</refsect1>
<refsect1 id='pam_keyinit-return_values'>
<title>RETURN VALUES</title>
<variablelist>
<varlistentry>
<term>PAM_SUCCESS</term>
<listitem>
<para>
This module will usually return this value
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_AUTH_ERR</term>
<listitem>
<para>
Authentication failure.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_BUF_ERR</term>
<listitem>
<para>
Memory buffer error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_IGNORE</term>
<listitem>
<para>
The return value should be ignored by PAM dispatch.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SERVICE_ERR</term>
<listitem>
<para>
Cannot determine the user name.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SESSION_ERR</term>
<listitem>
<para>
This module will return this value if its arguments are invalid or
if a system error such as ENOMEM occurs.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_USER_UNKNOWN</term>
<listitem>
<para>
User not known.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='pam_keyinit-examples'>
<title>EXAMPLES</title>
<para>
Add this line to your login entries to start each login session with its
own session keyring:
<programlisting>
session required pam_keyinit.so
</programlisting>
</para>
<para>
This will prevent keys from one session leaking into another session for
the same user.
</para>
</refsect1>
<refsect1 id='pam_keyinit-see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>keyctl</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1 id='pam_keyinit-author'>
<title>AUTHOR</title>
<para>
pam_keyinit was written by David Howells, <dhowells@redhat.com>.
</para>
</refsect1>
</refentry>
|
