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
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
|
<?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-ldap</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>sssd-ldap</refname>
<refpurpose>the configuration file for SSSD</refpurpose>
</refnamediv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
This manual page describes the configuration of LDAP
domains for
<citerefentry>
<refentrytitle>sssd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>.
For detailed syntax reference, please refer to
<citerefentry>
<refentrytitle>sssd.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> manual page, section <quote>FILE FORMAT</quote>
</para>
<para>
There can be more than one LDAP domain configured with SSSD.
</para>
<para>
If you want to authenticate against an LDAP server TLS/SSL is
required. <command>sssd</command> <emphasis>does not</emphasis>
support authentication over an unencrypted channel. If the LDAP
server is used only as an identify provider, an encrypted channel
is not needed.
</para>
</refsect1>
<refsect1 id='file-format'>
<title>CONFIGURATION OPTIONS</title>
<para>
All the common configuration options for SSSD domains apply
for LDAP domains, too. See the
<citerefentry>
<refentrytitle>sssd.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> manual page, section <quote>DOMAIN SECTIONS</quote>
<variablelist>
<varlistentry>
<term>ldap_uri (string)</term>
<listitem>
<para>
Specifies the URI of the LDAP server to which
SSSD should connect.
</para>
<para>
Default: ldap://localhost
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_schema (string)</term>
<listitem>
<para>
Specifies the Schema Type in use on the target LDAP
server.
Depending on the selected schema the default
attribute names retrieved from the servers may vary.
Also the way some attributes are handled may differ.
There are currently 2 schema types supported:
rfc2307
rfc2307bis
The main difference between these 2 schema types is
how group memberships are recorder in the server.
With rfc2307 group members are listed by name in an
attribute called <emphasis>memberUid</emphasis>.
With rfc2307bis grpoup members are listed by DN and
stored in an attribute called
<emphasis>member</emphasis>.
</para>
<para>
Default: rfc2307
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_default_bind_dn (string)</term>
<listitem>
<para>
The default bind DN to use for
performing LDAP operations.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_default_authtok_type (string)</term>
<listitem>
<para>
The type of the authentication token of the
default bind DN. So far "password" is the only
supported value.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_default_authtok (string)</term>
<listitem>
<para>
The authentication token of the default bind DN.
So far only a clear text password is supported.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_search_base (string)</term>
<listitem>
<para>
The default base DN to use for
performing LDAP user operations.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_object_class (string)</term>
<listitem>
<para>
The object class of a user entry in LDAP.
</para>
<para>
Default: posixAccount
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_name (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
user's login name.
</para>
<para>
Default: uid
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_uid_number (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
user's id.
</para>
<para>
Default: uidNumber
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_gid_number (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
user's primary group id.
</para>
<para>
Default: gidNumber
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_gecos (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
user's gecos field.
</para>
<para>
Default: gecos
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_home_directory (string)</term>
<listitem>
<para>
The LDAP attribute that contains the name of the
home directory of a user.
</para>
<para>
Default: homeDirectory
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_shell (string)</term>
<listitem>
<para>
The LDAP attribute that contains the path of the
user's default shell.
</para>
<para>
Default: loginShell
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_uuid (string)</term>
<listitem>
<para>
The LDAP attribute that contains the UUID/GUID of
a LDAP user object.
</para>
<para>
Default: nsUniqueId
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_principal (string)</term>
<listitem>
<para>
The LDAP attribute that contains the Kerberos
User Principle Name (UPN) of the user.
</para>
<para>
Default: krbPrincipalName
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_force_upper_case_realm (boolean)</term>
<listitem>
<para>
Some directory servers, for example Active Directory,
might deliver the realm part of the UPN lower case
which may cause the authentication to fail. Set this
option to a non-zero value, if you want to use an
upper case realm.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_fullname (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
full name of the user.
</para>
<para>
Default: cn
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_member_of (string)</term>
<listitem>
<para>
The LDAP attribute that list the user's
group memberships.
</para>
<para>
Default: memberOf
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_search_base (string)</term>
<listitem>
<para>
The default base DN to use for
performing LDAP group operations.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_object_class (string)</term>
<listitem>
<para>
The object class of a group entry in LDAP.
</para>
<para>
Default: posixGroup
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_name (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
the group name.
</para>
<para>
Default: cn
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_gid_number (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
group's id.
</para>
<para>
Default: gidNumber
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_member (string)</term>
<listitem>
<para>
The LDAP attribute that contains the names of
the members of the group.
</para>
<para>
Default: memberuid (rfc2307) / member (rfc2307bis)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_uuid (string)</term>
<listitem>
<para>
The LDAP attribute that contains the UUID/GUID of
a LDAP group object.
</para>
<para>
Default: nsUniqueId
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_network_timeout (integer)</term>
<listitem>
<para>
Specifies the timeout (in seconds) after which
the
<citerefentry>
<refentrytitle>poll</refentrytitle>
<manvolnum>2</manvolnum>
</citerefentry>/<citerefentry>
<refentrytitle>select</refentrytitle>
<manvolnum>2</manvolnum>
</citerefentry>
following a
<citerefentry>
<refentrytitle>connect</refentrytitle>
<manvolnum>2</manvolnum>
</citerefentry>
returns in case of no activity.
</para>
<para>
Default: 5
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_opt_timeout (integer)</term>
<listitem>
<para>
Specifies a timeout (in seconds) after which
calls to synchronous LDAP APIs will abort if no
response is received.
</para>
<para>
Default: 5
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_tls_reqcert (string)</term>
<listitem>
<para>
Specifies what checks to perform on server
certificates in a TLS session, if any. It
can be specified as one of the following
values:
</para>
<para>
<emphasis>never</emphasis> = The client will
not request or check any server certificate.
</para>
<para>
<emphasis>allow</emphasis> = The server
certificate is requested. If no certificate is
provided, the session proceeds normally. If a
bad certificate is provided, it will be ignored
and the session proceeds normally.
</para>
<para>
<emphasis>try</emphasis> = The server certificate
is requested. If no certificate is provided, the
session proceeds normally. If a bad certificate
is provided, the session is immediately terminated.
</para>
<para>
<emphasis>demand</emphasis> = The server
certificate is requested. If no certificate
is provided, or a bad certificate is provided,
the session is immediately terminated.
</para>
<para>
<emphasis>hard</emphasis> = Same as
<quote>demand</quote>
</para>
<para>
Default: hard
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_tls_cacert (string)</term>
<listitem>
<para>
Specifies the file that contains certificates for
all of the Certificate Authorities
<command>sssd</command> will recognize.
</para>
<para>
Default: use OpenLDAP defaults, typically in
/etc/openldap/ldap.conf
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_tls_cacertdir (string)</term>
<listitem>
<para>
Specifies the path of a directory that contains
Certificate Authority certificates in separate
individual files. Typically the file names need to
be the hash of the certificate followed by '.0'.
If available <command>cacertdir_rehash</command>
can be used to create the correct names.
</para>
<para>
Default: use OpenLDAP defaults, typically in
/etc/openldap/ldap.conf
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_id_use_start_tls (boolean)</term>
<listitem>
<para>
Specifies that the id_provider connection must also
use tls to protect the channel.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sasl_mech (string)</term>
<listitem>
<para>
Specify the sasl mechanism to use.
Currently only GSSAPI is tested and supported.
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sasl_authid (string)</term>
<listitem>
<para>
Specify the sasl authorization id to use.
When GSSAPI is used, this represents the kerberos
principal used for authentication to the directory.
</para>
<para>
Default: host/machine.fqdn@REALM
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_krb5_keytab (string)</term>
<listitem>
<para>
Specify keytab to use when using SASL/GSSAPI.
</para>
<para>
Default: System keytab, normally /etc/krb5.keytab
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_krb5_init_creds (boolean)</term>
<listitem>
<para>
Specifies that the id_provider should init
kerberos credentials (TGT).
This action is perfromed only if SASL is used and
the mechanism selected is GSSAPI.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>krb5_realm (string)</term>
<listitem>
<para>
Specify the kerberos REALM (for SASL/GSSAPI auth).
</para>
<para>
Default: System defaults, see /etc/krb5.conf
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id='example'>
<title>EXAMPLE</title>
<para>
The following example assumes that SSSD is correctly
configured and LDAP is set set one of the domains in the
<replaceable>[domains]</replaceable> section.
</para>
<para>
<programlisting>
[domain/LDAP]
id_provider = ldap
auth_provider = ldap
ldap_uri = ldap://ldap.mydomain.org
ldap_user_search_base = dc=mydomain,dc=org
ldap_tls_reqcert = demand
cache_credentials = true
enumerate = true
</programlisting>
</para>
</refsect1>
<refsect1 id='notes'>
<title>NOTES</title>
<para>
Description of some of the configuration options in this manual
page is based on <citerefentry>
<refentrytitle>ldap.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> manual page from the OpenLDAP 2.4 distribution.
</para>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>sssd.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sssd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
</reference>
|
