Cross Reference: /sssd-io/src/man/sssd-ad.5.xml
sssd-ad.5.xml revision ba2fb2c7b74a5247737da051b38e7889b7b44d5d
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
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
<?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-ad</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>sssd-ad</refname>
<refpurpose>SSSD Active Directory provider</refpurpose>
</refnamediv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
This manual page describes the configuration of the AD 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 AD provider is a back end used to connect to an Active
Directory server. This provider requires that the machine be
joined to the AD domain and a keytab is available. Back end
communication occurs over a GSSAPI-encrypted channel, SSL/TLS
options should not be used with the AD provider and will be
superceded by Kerberos usage.
</para>
<para>
The AD provider supports connecting to Active Directory 2008 R2
or later. Earlier versions may work, but are unsupported.
</para>
<para>
The AD provider can be used to get user information
and authenticate users from trusted domains. Currently
only trusted domains in the same forest are recognized. In
addition servers from trusted domains are always auto-discovered.
</para>
<para>
The AD provider enables SSSD to use 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 optimizations for
Active Directory environments. The AD provider accepts the same
options used by the sssd-ldap and sssd-krb5 providers with some
exceptions. However, it is neither necessary nor recommended to
set these options.
</para>
<para>
The AD provider primarily copies the traditional ldap and krb5
provider default options with some exceptions, the differences
are listed in the <quote>MODIFIED DEFAULT OPTIONS</quote> section.
</para>
<para>
The AD provider can also be used as an access, chpass,
sudo and autofs provider. No configuration of the access provider
is required on the client side.
</para>
<para>
By default, the AD provider will map UID and GID values from the
objectSID parameter in Active Directory. For details on this, see
the <quote>ID MAPPING</quote> section below. If you want to
disable ID mapping and instead rely on POSIX attributes defined in
Active Directory, you should set
<programlisting>
ldap_id_mapping = False
</programlisting>
In order to retrieve users and groups using POSIX attributes from trusted
domains, the AD administrator must make sure that the POSIX attributes
are replicated to the Global Catalog.
</para>
<para>
Users, groups and other entities served by SSSD are always treated as
case-insensitive in the AD provider for compatibility with Active
Directory's LDAP implementation.
</para>
</refsect1>
<refsect1 id='configuration-options'>
<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>ad_domain (string)</term>
<listitem>
<para>
Specifies the name of the Active Directory domain.
This is optional. If not provided, the
configuration domain name is used.
</para>
<para>
For proper operation, this option should be
specified as the lower-case version of the long
version of the Active Directory domain.
</para>
<para>
The short domain name (also known as the NetBIOS
or the flat name) is autodetected by the SSSD.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_enabled_domains (string)</term>
<listitem>
<para>
A comma-separated list of enabled Active Directory domains.
If provided, SSSD will ignore any domains not listed in this
option. If left unset, all domains from the AD forest will
be available.
</para>
<para>
For proper operation, this option must be specified in all
lower-case and as the fully qualified domain name of the
Active Directory domain. For example:
<programlisting>
ad_enabled_domains = sales.example.com, eng.example.com
</programlisting>
</para>
<para>
The short domain name (also known as the NetBIOS or the flat
name) will be autodetected by SSSD.
</para>
<para>
Default: Not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_server, ad_backup_server (string)</term>
<listitem>
<para>
The comma-separated list of
hostnames of the AD servers to which SSSD should
connect in order of preference. For more
information on failover and server redundancy, see
the <quote>FAILOVER</quote> section.
</para>
<para>
This is optional if autodiscovery is enabled.
For more information on service discovery, refer
to the <quote>SERVICE DISCOVERY</quote> section.
</para>
<para>
Note: Trusted domains will always auto-discover
servers even if the primary server is explicitly
defined in the ad_server option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_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 Active Directory domain to
identify this host.
</para>
<para>
This field is used to determine the host principal
in use in the keytab. It must match the hostname
for which the keytab was issued.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_enable_dns_sites (boolean)</term>
<listitem>
<para>
Enables DNS sites - location based
service discovery.
</para>
<para>
If true and service discovery (see Service
Discovery paragraph at the bottom of the man page)
is enabled, the SSSD will first attempt to discover
the Active Directory server to connect to using the
Active Directory Site Discovery and fall back to
the DNS SRV records if no AD site is found. The
DNS SRV configuration, including the discovery
domain, is used during site discovery as well.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_access_filter (string)</term>
<listitem>
<para>
This option specifies LDAP access control
filter that the user must match in order
to be allowed access. Please note that the
<quote>access_provider</quote> option must be
explicitly set to <quote>ad</quote> in order
for this option to have an effect.
</para>
<para>
The option also supports specifying different
filters per domain or forest. This
extended filter would consist of:
<quote>KEYWORD:NAME:FILTER</quote>.
The keyword can be either <quote>DOM</quote>,
<quote>FOREST</quote> or missing.
</para>
<para>
If the keyword equals to <quote>DOM</quote>
or is missing, then <quote>NAME</quote> specifies
the domain or subdomain the filter applies to.
If the keyword equals to <quote>FOREST</quote>,
then the filter equals to all domains from the
forest specified by <quote>NAME</quote>.
</para>
<para>
Multiple filters can be separated with the
<quote>?</quote> character, similarly to how
search bases work.
</para>
<para>
Nested group membership must be searched for using
a special OID <quote>:1.2.840.113556.1.4.1941:</quote>
in addition to the full DOM:domain.example.org: syntax
to ensure the parser does not attempt to interpret the
colon characters associated with the OID. If you do not
use this OID then nested group membership will not be
resolved. See usage example below and refer here
for further information about the OID:
<ulink
url="https://msdn.microsoft.com/en-us/library/cc223367.aspx">
[MS-ADTS] section LDAP extensions</ulink>
</para>
<para>
The most specific match is always used. For
example, if the option specified filter
for a domain the user is a member of and a
global filter, the per-domain filter would
be applied. If there are more matches with
the same specification, the first one is used.
</para>
<para>
Examples:
</para>
<programlisting>
# apply filter on domain called dom1 only:
dom1:(memberOf=cn=admins,ou=groups,dc=dom1,dc=com)
# apply filter on domain called dom2 only:
DOM:dom2:(memberOf=cn=admins,ou=groups,dc=dom2,dc=com)
# apply filter on forest called EXAMPLE.COM only:
FOREST:EXAMPLE.COM:(memberOf=cn=admins,ou=groups,dc=example,dc=com)
# apply filter for a member of a nested group in dom1:
DOM:dom1:(memberOf:1.2.840.113556.1.4.1941:=cn=nestedgroup,ou=groups,dc=example,dc=com)
</programlisting>
<para>
Default: Not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_site (string)</term>
<listitem>
<para>
Specify AD site to which client should try to connect.
If this option is not provided, the AD site will be
auto-discovered.
</para>
<para>
Default: Not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_enable_gc (boolean)</term>
<listitem>
<para>
By default, the SSSD connects to the Global
Catalog first to retrieve users from trusted
domains and uses the LDAP port to retrieve
group memberships or as a fallback. Disabling
this option makes the SSSD only connect to
the LDAP port of the current AD server.
</para>
<para>
Please note that disabling Global Catalog support
does not disable retrieving users from trusted
domains. The SSSD would connect to the LDAP port
of trusted domains instead. However, Global
Catalog must be used in order to resolve
cross-domain group memberships.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_access_control (string)</term>
<listitem>
<para>
This option specifies the operation mode for
GPO-based access control functionality:
whether it operates in disabled mode, enforcing
mode, or permissive mode. Please note that the
<quote>access_provider</quote> option must be
explicitly set to <quote>ad</quote> in order for
this option to have an effect.
</para>
<para>
GPO-based access control functionality uses GPO
policy settings to determine whether or not a
particular user is allowed to logon to a particular
host.
</para>
<para>
NOTE: If the operation mode is set to enforcing, it
is possible that users that were previously allowed
logon access will now be denied logon access (as
dictated by the GPO policy settings). In order to
facilitate a smooth transition for administrators,
a permissive mode is available that will not enforce
the access control rules, but will evaluate them and
will output a syslog message if access would have
been denied. By examining the logs, administrators
can then make the necessary changes before setting
the mode to enforcing.
</para>
<para>
There are three supported values for this option:
<itemizedlist>
<listitem>
<para>
disabled: GPO-based access control rules
are neither evaluated nor enforced.
</para>
</listitem>
<listitem>
<para>
enforcing: GPO-based access control
rules are evaluated and enforced.
</para>
</listitem>
<listitem>
<para>
permissive: GPO-based access control
rules are evaluated, but not enforced.
Instead, a syslog message will be
emitted indicating that the user would
have been denied access if this option's
value were set to enforcing.
</para>
</listitem>
</itemizedlist>
</para>
<para condition="gpo_default_permissive">
Default: permissive
</para>
<para condition="gpo_default_enforcing">
Default: enforcing
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_cache_timeout (integer)</term>
<listitem>
<para>
The amount of time between lookups of GPO policy
files against the AD server. This will reduce the
latency and load on the AD server if there are
many access-control requests made in a short
period.
</para>
<para>
Default: 5 (seconds)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_map_interactive (string)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which GPO-based access control is evaluated based on
the InteractiveLogonRight and
DenyInteractiveLogonRight policy settings.
</para>
<para>
Note: Using the Group Policy Management Editor
this value is called "Allow log on locally"
and "Deny log on locally".
</para>
<para>
It is possible to add another PAM service name
to the default set by using <quote>+service_name</quote>
or to explicitly remove a PAM service name from
the default set by using <quote>-service_name</quote>.
For example, in order to replace a default PAM service
name for this logon right (e.g. <quote>login</quote>)
with a custom pam service name (e.g. <quote>my_pam_service</quote>),
you would use the following configuration:
<programlisting>
ad_gpo_map_interactive = +my_pam_service, -login
</programlisting>
</para>
<para>
Default: the default set of PAM service names includes:
<itemizedlist>
<listitem>
<para>
login
</para>
</listitem>
<listitem>
<para>
su
</para>
</listitem>
<listitem>
<para>
su-l
</para>
</listitem>
<listitem>
<para>
gdm-fingerprint
</para>
</listitem>
<listitem>
<para>
gdm-password
</para>
</listitem>
<listitem>
<para>
gdm-smartcard
</para>
</listitem>
<listitem>
<para>
kdm
</para>
</listitem>
<listitem>
<para>
lightdm
</para>
</listitem>
<listitem>
<para>
lxdm
</para>
</listitem>
<listitem>
<para>
sddm
</para>
</listitem>
<listitem>
<para>
unity
</para>
</listitem>
<listitem>
<para>
xdm
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_map_remote_interactive (string)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which GPO-based access control is evaluated based on
the RemoteInteractiveLogonRight and
DenyRemoteInteractiveLogonRight policy settings.
</para>
<para>
Note: Using the Group Policy Management Editor this
value is called "Allow log on through Remote Desktop
Services" and "Deny log on through Remote Desktop
Services".
</para>
<para>
It is possible to add another PAM service name
to the default set by using <quote>+service_name</quote>
or to explicitly remove a PAM service name from
the default set by using <quote>-service_name</quote>.
For example, in order to replace a default PAM service
name for this logon right (e.g. <quote>sshd</quote>)
with a custom pam service name (e.g. <quote>my_pam_service</quote>),
you would use the following configuration:
<programlisting>
ad_gpo_map_remote_interactive = +my_pam_service, -sshd
</programlisting>
</para>
<para>
Default: the default set of PAM service names includes:
<itemizedlist>
<listitem>
<para>
sshd
</para>
</listitem>
<listitem>
<para>
cockpit
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_map_network (string)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which GPO-based access control is evaluated based on
the NetworkLogonRight and DenyNetworkLogonRight
policy settings.
</para>
<para>
Note: Using the Group Policy Management Editor
this value is called "Access this computer
from the network" and "Deny access to this
computer from the network".
</para>
<para>
It is possible to add another PAM service name
to the default set by using <quote>+service_name</quote>
or to explicitly remove a PAM service name from
the default set by using <quote>-service_name</quote>.
For example, in order to replace a default PAM service
name for this logon right (e.g. <quote>ftp</quote>)
with a custom pam service name (e.g. <quote>my_pam_service</quote>),
you would use the following configuration:
<programlisting>
ad_gpo_map_network = +my_pam_service, -ftp
</programlisting>
</para>
<para>
Default: the default set of PAM service names includes:
<itemizedlist>
<listitem>
<para>
ftp
</para>
</listitem>
<listitem>
<para>
samba
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_map_batch (string)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which GPO-based access control is evaluated based on
the BatchLogonRight and DenyBatchLogonRight
policy settings.
</para>
<para>
Note: Using the Group Policy Management Editor
this value is called "Allow log on as a batch
job" and "Deny log on as a batch job".
</para>
<para>
It is possible to add another PAM service name
to the default set by using <quote>+service_name</quote>
or to explicitly remove a PAM service name from
the default set by using <quote>-service_name</quote>.
For example, in order to replace a default PAM service
name for this logon right (e.g. <quote>crond</quote>)
with a custom pam service name (e.g. <quote>my_pam_service</quote>),
you would use the following configuration:
<programlisting>
ad_gpo_map_batch = +my_pam_service, -crond
</programlisting>
</para>
<para>
Default: the default set of PAM service names includes:
<itemizedlist>
<listitem>
<para>
crond
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_map_service (string)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which GPO-based access control is evaluated based on
the ServiceLogonRight and DenyServiceLogonRight
policy settings.
</para>
<para>
Note: Using the Group Policy Management Editor
this value is called "Allow log on as a service"
and "Deny log on as a service".
</para>
<para>
It is possible to add a PAM service name to the
default set by using <quote>+service_name</quote>.
Since the default set is empty, it is not possible
to remove a PAM service name from the default set.
For example, in order to add a custom pam service
name (e.g. <quote>my_pam_service</quote>), you
would use the following configuration:
<programlisting>
ad_gpo_map_service = +my_pam_service
</programlisting>
</para>
<para>
Default: not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_map_permit (string)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which GPO-based access is always granted, regardless
of any GPO Logon Rights.
</para>
<para>
It is possible to add another PAM service name
to the default set by using <quote>+service_name</quote>
or to explicitly remove a PAM service name from
the default set by using <quote>-service_name</quote>.
For example, in order to replace a default PAM service
name for unconditionally permitted access (e.g. <quote>sudo</quote>)
with a custom pam service name (e.g. <quote>my_pam_service</quote>),
you would use the following configuration:
<programlisting>
ad_gpo_map_permit = +my_pam_service, -sudo
</programlisting>
</para>
<para>
Default: the default set of PAM service names includes:
<itemizedlist>
<listitem>
<para>
polkit-1
</para>
</listitem>
<listitem>
<para>
sudo
</para>
</listitem>
<listitem>
<para>
sudo-i
</para>
</listitem>
<listitem>
<para>
systemd-user
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_map_deny (string)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which GPO-based access is always denied, regardless
of any GPO Logon Rights.
</para>
<para>
It is possible to add a PAM service name to the
default set by using <quote>+service_name</quote>.
Since the default set is empty, it is not possible
to remove a PAM service name from the default set.
For example, in order to add a custom pam service
name (e.g. <quote>my_pam_service</quote>), you
would use the following configuration:
<programlisting>
ad_gpo_map_deny = +my_pam_service
</programlisting>
</para>
<para>
Default: not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_gpo_default_right (string)</term>
<listitem>
<para>
This option defines how access control is evaluated
for PAM service names that are not explicitly listed
in one of the ad_gpo_map_* options. This option can be
set in two different manners. First, this option can
be set to use a default logon right. For example, if
this option is set to 'interactive', it means that
unmapped PAM service names will be processed based on
the InteractiveLogonRight and DenyInteractiveLogonRight
policy settings. Alternatively, this option can be set
to either always permit or always deny access for
unmapped PAM service names.
</para>
<para>
Supported values for this option include:
<itemizedlist>
<listitem>
<para>
interactive
</para>
</listitem>
<listitem>
<para>
remote_interactive
</para>
</listitem>
<listitem>
<para>
network
</para>
</listitem>
<listitem>
<para>
batch
</para>
</listitem>
<listitem>
<para>
service
</para>
</listitem>
<listitem>
<para>
permit
</para>
</listitem>
<listitem>
<para>
deny
</para>
</listitem>
</itemizedlist>
</para>
<para>
Default: deny
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_maximum_machine_account_password_age (integer)</term>
<listitem>
<para>
SSSD will check once a day if the machine account
password is older than the given age in days and try
to renew it. A value of 0 will disable the renewal
attempt.
</para>
<para>
Default: 30 days
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ad_machine_account_password_renewal_opts (string)</term>
<listitem>
<para>
This option should only be used to test the machine
account renewal task. The option expects 2 integers
separated by a colon (':'). The first integer
defines the interval in seconds how often the task
is run. The second specifies the initial timeout in
seconds before the task is run for the first time
after startup.
</para>
<para>
Default: 86400:750 (24h and 15m)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_update (boolean)</term>
<listitem>
<para>
Optional. This option tells SSSD to automatically
update the Active Directory DNS server with
the IP address of this client. The update is
secured using GSS-TSIG. As a consequence, the
Active Directory administrator only needs to
allow secure updates for the DNS zone. The IP
address of the AD LDAP connection is used for
the updates, if it is not otherwise specified
by using the <quote>dyndns_iface</quote> option.
</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: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_ttl (integer)</term>
<listitem>
<para>
The TTL to apply to the client DNS record when updating it.
If dyndns_update is false this has no effect. This will
override the TTL serverside if set by an administrator.
</para>
<para>
Default: 3600 (seconds)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_iface (string)</term>
<listitem>
<para>
Optional. Applicable only when dyndns_update
is true. Choose the interface or a list of interfaces
whose IP addresses should be used for dynamic DNS
updates. Special value <quote>*</quote> implies that
IPs from all interfaces should be used.
</para>
<para>
Default: Use the IP addresses of the interface which
is used for AD LDAP connection
</para>
<para>
Example: dyndns_iface = em1, vnet1, vnet2
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_refresh_interval (integer)</term>
<listitem>
<para>
How often should the back end perform periodic DNS update in
addition to the automatic update performed when the back end
goes online.
This option is optional and applicable only when dyndns_update
is true. Note that the lowest possible value is 60 seconds in-case
if value is provided less than 60, parameter will assume lowest
value only.
</para>
<para>
Default: 86400 (24 hours)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_update_ptr (bool)</term>
<listitem>
<para>
Whether the PTR record should also be explicitly
updated when updating the client's DNS records.
Applicable only when dyndns_update is true.
</para>
<para>
Default: True
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_force_tcp (bool)</term>
<listitem>
<para>
Whether the nsupdate utility should default to using
TCP for communicating with the DNS server.
</para>
<para>
Default: False (let nsupdate choose the protocol)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_auth (string)</term>
<listitem>
<para>
Whether the nsupdate utility should use GSS-TSIG
authentication for secure updates with the DNS
server, insecure updates can be sent by setting
this option to 'none'.
</para>
<para>
Default: GSS-TSIG
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dyndns_server (string)</term>
<listitem>
<para>
The DNS server to use when performing a DNS
update. In most setups, it's recommended to leave
this option unset.
</para>
<para>
Setting this option makes sense for environments
where the DNS server is different from the identity
server.
</para>
<para>
Please note that this option will be only used in
fallback attempt when previous attempt using
autodetected settings failed.
</para>
<para>
Default: None (let nsupdate choose the server)
</para>
</listitem>
</varlistentry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/override_homedir.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/homedir_substring.xml" />
<varlistentry>
<term>krb5_confd_path (string)</term>
<listitem>
<para>
Absolute path of a directory where SSSD should place
Kerberos configuration snippets.
</para>
<para>
To disable the creation of the configuration
snippets set the parameter to 'none'.
</para>
<para>
Default: not set (krb5.include.d subdirectory of
SSSD's pubconf directory)
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ad_modified_defaults.xml" />
<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" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_id_mapping.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 example shows only
the AD provider-specific options.
</para>
<para>
<programlisting>
[domain/EXAMPLE]
id_provider = ad
auth_provider = ad
access_provider = ad
chpass_provider = ad
ad_server = dc1.example.com
ad_hostname = client.example.com
ad_domain = example.com
</programlisting>
</para>
</refsect1>
<refsect1 id='notes'>
<title>NOTES</title>
<para>
The AD access control provider checks if the account is expired.
It has the same effect as the following configuration of the LDAP
provider:
<programlisting>
access_provider = ldap
ldap_access_order = expire
ldap_account_expire_policy = ad
</programlisting>
</para>
<para>
However, unless the <quote>ad</quote> access control provider
is explicitly configured, the default access provider is
<quote>permit</quote>. Please note that if you configure an
access provider other than <quote>ad</quote>, you need to set
all the connection parameters (such as LDAP URIs and encryption
details) manually.
</para>
<para>
When the autofs provider is set to <quote>ad</quote>, the RFC2307
schema attribute mapping (nisMap, nisObject, ...) is used,
because these attributes are included in the default Active
Directory schema.
</para>
<para>
</para>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
</refentry>
</reference>