summaryrefslogtreecommitdiff
path: root/src/man/sssd-ipa.5.xml
blob: 9b8a140ce539b929b5d2af056e3bff78f28d2214 (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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
<?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>
                            NOTE: On older systems (such as RHEL 5), for this
                            behavior to work reliably, the default Kerberos
                            realm must be set properly in /etc/krb5.conf
                        </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>ipa_host_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            host objects.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            If filter is given in any of search bases and
                            <emphasis>ipa_hbac_support_srchost</emphasis>
                            is set to False, the filter will be ignored.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>ldap_search_base</emphasis>
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_selinux_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            SELinux user maps.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>ldap_search_base</emphasis>
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry>
                    <term>ipa_subdomains_search_base (string)</term>
                    <listitem>
                        <para>
                            Optional. Use the given string as search base for
                            trusted domains.
                        </para>
                        <para>
                            See <quote>ldap_search_base</quote> for
                            information about configuring multiple search
                            bases.
                        </para>
                        <para>
                            Default: the value of
                            <emphasis>cn=trusts,%basedn</emphasis>
                        </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_hbac_support_srchost (boolean)</term>
                    <listitem>
                        <para>
                            If this is set to false, then srchost as given
                            to SSSD by PAM will be ignored.
                        </para>
                        <para>
                            Note that if set to <emphasis>False</emphasis>,
                            this option casuses filters given in
                            <emphasis>ipa_host_search_base</emphasis> to be ignored;
                        </para>
                        <para>
                            Default: false
                        </para>
                    </listitem>
                </varlistentry>

                <varlistentry condition="with_autofs">
                    <term>ipa_automount_location (string)</term>
                    <listitem>
                        <para>
                            The automounter location this IPA client will be using
                        </para>
                        <para>
                            Default: The location named "default"
                        </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>

                <varlistentry>
                    <term>ipa_selinux_usermap_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_selinux_usermap_name (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains the name
                            of SELinux usermap.
                        </para>
                        <para>
                            Default: cn
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_member_user (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains all users / groups
                            this rule match against.
                        </para>
                        <para>
                            Default: memberUser
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_member_host (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains all hosts / hostgroups
                            this rule match against.
                        </para>
                        <para>
                            Default: memberHost
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_see_also (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains DN of HBAC
                            rule which can be used for matching instead
                            of memberUser and memberHost
                        </para>
                        <para>
                            Default: seeAlso
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_selinux_user (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains SELinux user
                            string itself.
                        </para>
                        <para>
                            Default: ipaSELinuxUser
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_enabled (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains whether
                            or not is user map enabled for usage.
                        </para>
                        <para>
                            Default: ipaEnabledFlag
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_user_category (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains user category
                            such as 'all'.
                        </para>
                        <para>
                            Default: userCategory
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_host_category (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains host category
                            such as 'all'.
                        </para>
                        <para>
                            Default: hostCategory
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry>
                    <term>ipa_selinux_usermap_uuid (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains unique ID
                            of the user map.
                        </para>
                        <para>
                            Default: ipaUniqueID
                        </para>
                    </listitem>
                </varlistentry>
                <varlistentry condition="with_ssh">
                    <term>ipa_host_ssh_public_key (string)</term>
                    <listitem>
                        <para>
                            The LDAP attribute that contains the host's SSH
                            public keys.
                        </para>
                        <para>
                            Default: ipaSshPubKey
                        </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>