blob: 32d691d704bba0ce7d1156b9e7ea8729f0d303a2 (
plain)
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<reference>
<title>SSSD Manual pages</title>
<refentry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
<refmeta>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>sssd-ipa</refname>
<refpurpose>the configuration file for SSSD</refpurpose>
</refnamediv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
This manual page describes the configuration of the IPA provider
for
<citerefentry>
<refentrytitle>sssd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>.
For a detailed syntax reference, refer to the <quote>FILE FORMAT</quote> section of the
<citerefentry>
<refentrytitle>sssd.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> manual page.
</para>
<para>
The IPA provider is a back end used to connect to an IPA server.
(Refer to the freeipa.org web site for information about IPA servers.)
This provider requires that the machine be joined to the IPA domain;
configuration is almost entirely self-discovered and obtained
directly from the server.
</para>
<para>
The IPA provider accepts the same options used by the
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> identity provider and the
<citerefentry>
<refentrytitle>sssd-krb5</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> authentication provider with some exceptions described
below.
</para>
<para>
However, it is neither necessary nor recommended to set these options.
IPA provider can also be used as an access and chpass provider. As an
access provider it uses HBAC (host-based access control) rules. Please
refer to freeipa.org for more information about HBAC. No configuration
of access provider is required on the client side.
</para>
</refsect1>
<refsect1 id='file-format'>
<title>CONFIGURATION OPTIONS</title>
<para>Refer to the section <quote>DOMAIN SECTIONS</quote> of the
<citerefentry>
<refentrytitle>sssd.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> manual page for details on the configuration of an SSSD domain.
<variablelist>
<varlistentry>
<term>ipa_domain (string)</term>
<listitem>
<para>
Specifies the name of the IPA domain.
This is optional. If not provided, the configuration
domain name is used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_server (string)</term>
<listitem>
<para>
The comma-separated list of IP addresses or hostnames of the
IPA servers to which SSSD should connect in
the order of preference. For more information
on failover and server redundancy, see the
<quote>FAILOVER</quote> section.
This is optional if autodiscovery is enabled.
For more information on service discovery, refer
to the the <quote>SERVICE DISCOVERY</quote> section.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_hostname (string)</term>
<listitem>
<para>
Optional. May be set on machines where the
hostname(5) does not reflect the fully qualified
name used in the IPA domain to identify this host.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_dyndns_update (boolean)</term>
<listitem>
<para>
Optional. This option tells SSSD to automatically
update the DNS server built into FreeIPA v2 with
the IP address of this client.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_dyndns_iface (string)</term>
<listitem>
<para>
Optional. Applicable only when ipa_dyndns_update
is true. Choose the interface whose IP address
should be used for dynamic DNS updates.
</para>
<para>
Default: Use the IP address of the IPA LDAP connection
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_hbac_search_base (string)</term>
<listitem>
<para>
Optional. Use the given string as search base for
HBAC related objects.
</para>
<para>
Default: Use base DN
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>krb5_validate (boolean)</term>
<listitem>
<para>
Verify with the help of krb5_keytab that the TGT
obtained has not been spoofed.
</para>
<para>
Default: true
</para>
<para>
Note that this default differs from the
traditional Kerberos provider back end.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>krb5_realm (string)</term>
<listitem>
<para>
The name of the Kerberos realm. This is optional and
defaults to the value of <quote>ipa_domain</quote>.
</para>
<para>
The name of the Kerberos realm has a special
meaning in IPA - it is converted into the base
DN to use for performing LDAP operations.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>krb5_canonicalize (boolean)</term>
<listitem>
<para>
Specifies if the host and user principal should be
canonicalized when connecting to IPA LDAP and also for AS
requests. This feature is available with MIT
Kerberos >= 1.7
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_hbac_refresh (integer)</term>
<listitem>
<para>
The amount of time between lookups of the HBAC
rules against the IPA server. This will reduce the
latency and load on the IPA server if there are
many access-control requests made in a short
period.
</para>
<para>
Default: 5 (seconds)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_hbac_treat_deny_as (string)</term>
<listitem>
<para>
This option specifies how to treat the deprecated
DENY-type HBAC rules. As of FreeIPA v2.1, DENY
rules are no longer supported on the server. All
users of FreeIPA will need to migrate their rules
to use only the ALLOW rules. The client will
support two modes of operation during this
transition period:
</para>
<para>
<emphasis>DENY_ALL</emphasis>: If any HBAC DENY
rules are detected, all users will be denied
access.
</para>
<para>
<emphasis>IGNORE</emphasis>: SSSD will ignore any
DENY rules. Be very careful with this option, as
it may result in opening unintended access.
</para>
<para>
Default: DENY_ALL
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_netgroup_member_of (string)</term>
<listitem>
<para>
The LDAP attribute that lists netgroup's
memberships.
</para>
<para>
Default: memberOf
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_netgroup_member_user (string)</term>
<listitem>
<para>
The LDAP attribute that lists system users
and groups that are direct members of the
netgroup.
</para>
<para>
Default: memberUser
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_netgroup_member_host (string)</term>
<listitem>
<para>
The LDAP attribute that lists hosts and host groups
that are direct members of the netgroup.
</para>
<para>
Default: memberHost
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_netgroup_member_ext_host (string)</term>
<listitem>
<para>
The LDAP attribute that lists FQDNs of hosts
and host groups that are members of the netgroup.
</para>
<para>
Default: externalHost
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_netgroup_domain (string)</term>
<listitem>
<para>
The LDAP attribute that contains NIS domain
name of the netgroup.
</para>
<para>
Default: nisDomainName
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_host_object_class (string)</term>
<listitem>
<para>
The object class of a host entry in LDAP.
</para>
<para>
Default: ipaHost
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ipa_host_fqdn (string)</term>
<listitem>
<para>
The LDAP attribute that contains FQDN of the host.
</para>
<para>
Default: fqdn
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/failover.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/service_discovery.xml" />
<refsect1 id='example'>
<title>EXAMPLE</title>
<para>
The following example assumes that SSSD is correctly
configured and example.com is one of the domains in the
<replaceable>[sssd]</replaceable> section. This examples shows only
the ipa provider-specific options.
</para>
<para>
<programlisting>
[domain/example.com]
id_provider = ipa
ipa_server = ipaserver.example.com
ipa_hostname = myhost.example.com
</programlisting>
</para>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>sssd.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sssd-krb5</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sssd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
</reference>
|
