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
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
|
<?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"
[
<!ENTITY sssd_user_name SYSTEM "sssd_user_name.include">
]>
<reference>
<title>SSSD Manual pages</title>
<refentry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
<refmeta>
<refentrytitle>sssd.conf</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>sssd.conf</refname>
<refpurpose>the configuration file for SSSD</refpurpose>
</refnamediv>
<refsect1 id='file-format'>
<title>FILE FORMAT</title>
<para>
The file has an ini-style syntax and consists of sections and
parameters. A section begins with the name of the section in
square brackets and continues until the next section begins. An
example of section with single and multi-valued parameters:
<programlisting>
<replaceable>[section]</replaceable>
<replaceable>key</replaceable> = <replaceable>value</replaceable>
<replaceable>key2</replaceable> = <replaceable>value2,value3</replaceable>
</programlisting>
</para>
<para>
The data types used are string (no quotes needed), integer
and bool (with values of <quote>TRUE/FALSE</quote>).
</para>
<para>
A comment line starts with a hash sign (<quote>#</quote>) or a
semicolon (<quote>;</quote>).
Inline comments are not supported.
</para>
<para>
All sections can have an optional
<replaceable>description</replaceable> parameter. Its function
is only as a label for the section.
</para>
<para>
<filename>sssd.conf</filename> must be a regular file, owned by
root and only root may read from or write to the file.
</para>
</refsect1>
<refsect1 id='config-snippets'>
<title>CONFIGURATION SNIPPETS FROM INCLUDE DIRECTORY</title>
<para>
The configuration file <filename>sssd.conf</filename> will
include configuration snippets using the include directory
<filename>conf.d</filename>. This feature is available if
SSSD was compiled with libini version 1.3.0 or later.
</para>
<para>
Any file placed in <filename>conf.d</filename>
that ends in <quote><filename>.conf</filename></quote>
and does not begin with a dot (<quote>.</quote>) will
be used together with <filename>sssd.conf</filename>
to configure SSSD.
</para>
<para>
The configuration snippets from <filename>conf.d</filename>
have higher priority than <filename>sssd.conf</filename>
and will override <filename>sssd.conf</filename> when
conflicts occur. If several snippets are present in
<filename>conf.d</filename>, then they are included in
alphabetical order (based on locale).
Files included later have higher priority. Numerical
prefixes (<filename>01_snippet.conf</filename>,
<filename>02_snippet.conf</filename> etc.) can help
visualize the priority (higher number means higher
priority).
</para>
<para>
The snippet files require the same owner and permissions
as <filename>sssd.conf</filename>. Which are by default
root:root and 0600.
</para>
</refsect1>
<refsect1 id='general-options'>
<title>GENERAL OPTIONS</title>
<para>
Following options are usable in more than one configuration
sections.
</para>
<refsect2 id='all-section-options'>
<title>Options usable in all sections</title>
<para>
<variablelist>
<varlistentry>
<term>debug_level (integer)</term>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/debug_levels.xml" />
</varlistentry>
<varlistentry>
<term>debug (integer)</term>
<listitem>
<para>
SSSD 1.14 and later also includes the
<replaceable>debug</replaceable> alias for
<replaceable>debug_level</replaceable> as a
convenience feature. If both are specified, the
value of <replaceable>debug_level</replaceable>
will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>debug_timestamps (bool)</term>
<listitem>
<para>
Add a timestamp to the debug messages.
If journald is enabled for SSSD debug logging this
option is ignored.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>debug_microseconds (bool)</term>
<listitem>
<para>
Add microseconds to the timestamp in debug messages.
If journald is enabled for SSSD debug logging this
option is ignored.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>debug_backtrace_enabled (bool)</term>
<listitem>
<para>
Enable debug backtrace.
</para>
<para>
In case SSSD is run with debug_level less than 9,
everything is logged to a ring buffer in memory and
flushed to a log file on any error up to
and including `min(0x0040, debug_level)`
(i.e. if debug_level is explicitly set to 0 or 1 then
only those error levels will trigger backtrace,
otherwise up to 2).
</para>
<para>
Feature is only supported for `logger == files` (i.e.
setting doesn't have effect for other logger types).
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id='services-and-domains-section-options'>
<title>Options usable in SERVICE and DOMAIN sections</title>
<para>
<variablelist>
<varlistentry>
<term>timeout (integer)</term>
<listitem>
<para>
Timeout in seconds between heartbeats for this
service. This is used to ensure that the process
is alive and capable of answering requests. Note
that after three missed heartbeats the process
will terminate itself.
</para>
<para>
Default: 10
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1 id='special-sections'>
<title>SPECIAL SECTIONS</title>
<refsect2 id='services'>
<title>The [sssd] section</title>
<para>
Individual pieces of SSSD functionality are provided by special
SSSD services that are started and stopped together with SSSD.
The services are managed by a special service frequently called
<quote>monitor</quote>. The <quote>[sssd]</quote> section is used
to configure the monitor as well as some other important options
like the identity domains.
<variablelist>
<title>Section parameters</title>
<varlistentry>
<term>config_file_version (integer)</term>
<listitem>
<para>
Indicates what is the syntax of the config
file. SSSD 0.6.0 and later use version 2.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>services</term>
<listitem>
<para>
Comma separated list of services that are
started when sssd itself starts.
<phrase condition="have_systemd">
The services' list is optional on platforms
where systemd is supported, as they will either
be socket or D-Bus activated when needed.
</phrase>
</para>
<para>
Supported services: nss, pam
<phrase condition="with_sudo">, sudo</phrase>
<phrase condition="with_autofs">, autofs</phrase>
<phrase condition="with_ssh">, ssh</phrase>
<phrase condition="with_pac_responder">, pac</phrase>
<phrase condition="with_ifp">, ifp</phrase>
</para>
<para>
<phrase condition="have_systemd">
By default, all services are disabled and the administrator
must enable the ones allowed to be used by executing:
"systemctl enable sssd-@service@.socket".
</phrase>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>reconnection_retries (integer)</term>
<listitem>
<para>
Number of times services should attempt to
reconnect in the event of a Data Provider
crash or restart before they give up
</para>
<para>
Default: 3
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>domains</term>
<listitem>
<para>
A domain is a database containing user
information. SSSD can use more domains
at the same time, but at least one
must be configured or SSSD won't start.
This parameter describes the list of domains
in the order you want them to be queried.
A domain name is recommended to contain only
alphanumeric ASCII characters, dashes, dots
and underscores. '/' character is forbidden.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>re_expression (string)</term>
<listitem>
<para>
Default regular expression that describes how to
parse the string containing user name and domain
into these components.
</para>
<para>
Each domain can have an individual regular
expression configured. For some ID providers
there are also default regular expressions. See
DOMAIN SECTIONS for more info on these regular
expressions.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>full_name_format (string)</term>
<listitem>
<para>
A <citerefentry>
<refentrytitle>printf</refentrytitle>
<manvolnum>3</manvolnum>
</citerefentry>-compatible format that describes how to
compose a fully qualified name from user name
and domain name components.
</para>
<para>
The following expansions are supported:
<variablelist>
<varlistentry>
<term>%1$s</term>
<listitem><para>user name</para></listitem>
</varlistentry>
<varlistentry>
<term>%2$s</term>
<listitem>
<para>
domain name as specified in the
SSSD config file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%3$s</term>
<listitem>
<para>
domain flat name. Mostly usable
for Active Directory domains, both
directly configured or discovered
via IPA trusts.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Each domain can have an individual format string configured.
See DOMAIN SECTIONS for more info on this option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>monitor_resolv_conf (boolean)</term>
<listitem>
<para>
Controls if SSSD should monitor the state of
resolv.conf to identify when it needs to
update its internal DNS resolver.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>try_inotify (boolean)</term>
<listitem>
<para condition="have_inotify">
By default, SSSD will attempt to use inotify
to monitor configuration files changes and
will fall back to polling every five seconds
if inotify cannot be used.
</para>
<para condition="have_inotify">
There are some limited situations where it is
preferred that we should skip even trying to
use inotify. In these rare cases, this option
should be set to 'false'
</para>
<para condition="have_inotify">
Default: true on platforms where inotify is
supported. False on other platforms.
</para>
<para>
Note: this option will have no effect on
platforms where inotify is unavailable. On
these platforms, polling will always be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>krb5_rcache_dir (string)</term>
<listitem>
<para>
Directory on the filesystem where SSSD should
store Kerberos replay cache files.
</para>
<para>
This option accepts a special value
__LIBKRB5_DEFAULTS__ that will instruct SSSD
to let libkrb5 decide the appropriate
location for the replay cache.
</para>
<para>
Default: Distribution-specific and specified
at build-time. (__LIBKRB5_DEFAULTS__ if not
configured)
</para>
</listitem>
</varlistentry>
<varlistentry condition="with_non_root_user_support">
<term>user (string)</term>
<listitem>
<para>
The user to drop the privileges to where
appropriate to avoid running as the
root user.
Currently the only supported value is '&sssd_user_name;'.
</para>
<para condition="have_systemd">
This option does not work when running socket-activated
services, as the user set up to run the processes is
set up during compilation time.
The way to override the systemd unit files is by creating
the appropriate files in /etc/systemd/system/.
Keep in mind that any change in the socket user, group or
permissions may result in a non-usable SSSD. The same may
occur in case of changes of the user running the NSS
responder.
</para>
<para>
Default: not set, process will run as root
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>default_domain_suffix (string)</term>
<listitem>
<para>
This string will be used as a default domain
name for all names without a domain name
component. The main use case is environments
where the primary domain is intended for managing host
policies and all users are located in a trusted domain.
The option allows those users
to log in just with their user name without
giving a domain name as well.
</para>
<para>
Please note that if this option is set all
users from the primary domain have to use their
fully qualified name, e.g. user@domain.name,
to log in. Setting this option changes default
of use_fully_qualified_names to True. It is not
allowed to use this option together with
use_fully_qualified_names set to False.
<phrase condition="with_files_provider">
One exception from this rule are domains with
<quote>id_provider=files</quote> that always try
to match the behaviour of nss_files
and therefore their output is not
qualified even when the default_domain_suffix
option is used.
</phrase>
</para>
<para>
Default: not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>override_space (string)</term>
<listitem>
<para>
This parameter will replace spaces (space bar)
with the given character for user and group names.
e.g. (_). User name "john doe" will
be "john_doe" This feature was added to
help compatibility with shell scripts that have
difficulty handling spaces, due to the
default field separator in the shell.
</para>
<para>
Please note it is a configuration error to use
a replacement character that might be used in
user or group names. If a name contains the
replacement character SSSD tries to return the
unmodified name but in general the result of a
lookup is undefined.
</para>
<para>
Default: not set (spaces will not be replaced)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>certificate_verification (string)</term>
<listitem>
<para>
With this parameter the certificate verification
can be tuned with a comma separated list of
options. Supported options are:
<variablelist>
<varlistentry>
<term>no_ocsp</term>
<listitem>
<para>Disables Online Certificate Status
Protocol (OCSP) checks. This might be
needed if the OCSP servers defined in
the certificate are not reachable from
the client.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>soft_ocsp</term>
<listitem>
<para> If a connection
cannot be established to an OCSP
responder the OCSP check is skipped.
This option should be used to allow
authentication when the system is
offline and the OCSP responder cannot be
reached.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ocsp_dgst</term>
<listitem>
<para>Digest (hash) function used to
create the certificate ID for the OCSP
request. Allowed values are:
<itemizedlist>
<listitem><para>sha1</para></listitem>
<listitem><para>sha256</para></listitem>
<listitem><para>sha384</para></listitem>
<listitem><para>sha512</para></listitem>
</itemizedlist></para>
<para>
Default: sha1 (to allow compatibility with
RFC5019-compliant responder)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>no_verification</term>
<listitem>
<para>Disables verification completely.
This option should only be used for
testing.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>partial_chain</term>
<listitem>
<para>Allow verification to succeed even
if a <replaceable>complete</replaceable>
chain cannot be built to a self-signed
trust-anchor, provided it is possible to
construct a chain to a trusted certificate
that might not be self-signed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ocsp_default_responder=URL</term>
<listitem>
<para>Sets the OCSP default responder
which should be used instead of the one
mentioned in the certificate. URL must
be replaced with the URL of the OCSP
default responder e.g.
http://example.com:80/ocsp.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
ocsp_default_responder_signing_cert=NAME</term>
<listitem>
<para>This option is
currently ignored. All needed
certificates must be available in the
PEM file given by
pam_cert_db_path.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>crl_file=/PATH/TO/CRL/FILE</term>
<listitem>
<para>Use the
Certificate Revocation List (CRL) from
the given file during the verification
of the certificate. The CRL must be
given in PEM format, see
<citerefentry>
<refentrytitle>crl</refentrytitle>
<manvolnum>1ssl</manvolnum>
</citerefentry>
for details.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>soft_crl</term>
<listitem>
<para>
If a Certificate Revocation List (CRL)
is expired ignore the CRL checks for the
related certificates. This option should
be used to allow authentication when the
system is offline and the CRL cannot be
renewed.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Unknown options are reported but ignored.
</para>
<para>
Default: not set, i.e. do not restrict
certificate verification
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>disable_netlink (boolean)</term>
<listitem>
<para>
SSSD hooks into the netlink interface to
monitor changes to routes, addresses, links
and trigger certain actions.
</para>
<para>
The SSSD state changes caused by netlink
events may be undesirable and can be disabled
by setting this option to 'true'
</para>
<para>
Default: false (netlink changes are detected)
</para>
</listitem>
</varlistentry>
<varlistentry condition="with_files_provider">
<term>enable_files_domain (boolean)</term>
<listitem>
<para>
When this option is enabled, SSSD
prepends an implicit domain with
<quote>id_provider=files</quote> before
any explicitly configured domains.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>domain_resolution_order</term>
<listitem>
<para>
Comma separated list of domains and subdomains
representing the lookup order that will be
followed.
The list doesn't have to include all possible
domains as the missing domains will be looked
up based on the order they're presented in the
<quote>domains</quote> configuration option.
The subdomains which are not listed as part of
<quote>lookup_order</quote> will be looked up
in a random order for each parent domain.
</para>
<para>
Please, note that when this option is set the
output format of all commands is always
fully-qualified even when using short names
for input
<phrase condition="with_files_provider">
, for all users but the ones managed
by the files provider
</phrase>.
In case the administrator wants the output not
fully-qualified, the full_name_format option
can be used as shown below:
<quote>full_name_format=%1$s</quote>
However, keep in mind that during login, login
applications often canonicalize the username by
calling
<citerefentry>
<refentrytitle>getpwnam</refentrytitle>
<manvolnum>3</manvolnum>
</citerefentry>
which, if a shortname is returned for a
qualified input (while trying to reach a user
which exists in multiple domains) might
re-route the login attempt into the domain
which uses shortnames, making this workaround
totally not recommended in cases where
usernames may overlap between domains.
</para>
<para>
Default: Not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>implicit_pac_responder (boolean)</term>
<listitem>
<para>
The PAC responder is enabled automatically for
the IPA and AD provider to evaluate and check
the PAC. If it has to be disabled
set this option to 'false'.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>core_dumpable (boolean)</term>
<listitem>
<para>
This option can be used for general system
hardening: setting it to 'false' forbids core
dumps for all SSSD processes to avoid
leaking plain text passwords. See man page
prctl:PR_SET_DUMPABLE for details.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry condition="build_passkey">
<term>passkey_verification (string)</term>
<listitem>
<para>
With this parameter the passkey verification
can be tuned with a comma separated list of
options. Supported options are:
<variablelist>
<varlistentry>
<term>user_verification (boolean)</term>
<listitem>
<para> Enable or disable the user
verification (i.e. PIN, fingerprint)
during authentication. If enabled, the
PIN will always be requested.
</para>
<para>
The default is that the key settings
decide what to do. In the IPA or
kerberos pre-authentication case,
this value will be overwritten by the
server.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>
<refsect1 id='services-sections'>
<title>SERVICES SECTIONS</title>
<para>
Settings that can be used to configure different services
are described in this section. They should reside in the
[<replaceable>$NAME</replaceable>] section, for example,
for NSS service, the section would be <quote>[nss]</quote>
</para>
<refsect2 id='general'>
<title>General service configuration options</title>
<para>
These options can be used to configure any service.
</para>
<variablelist>
<varlistentry>
<term>reconnection_retries (integer)</term>
<listitem>
<para>
Number of times services should attempt to
reconnect in the event of a Data Provider
crash or restart before they give up
</para>
<para>
Default: 3
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>fd_limit</term>
<listitem>
<para>
This option specifies the maximum number of file
descriptors that may be opened at one time by this
SSSD process. On systems where SSSD is granted the
CAP_SYS_RESOURCE capability, this will be an
absolute setting. On systems without this
capability, the resulting value will be the lower
value of this or the limits.conf "hard" limit.
</para>
<para>
Default: 8192 (or limits.conf "hard" limit)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>client_idle_timeout</term>
<listitem>
<para>
This option specifies the number of seconds that
a client of an SSSD process can hold onto a file
descriptor without communicating on it. This value
is limited in order to avoid resource exhaustion
on the system. The timeout can't be shorter than
10 seconds. If a lower value is configured, it
will be adjusted to 10 seconds.
</para>
<para>
Default: 60, KCM: 300
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>offline_timeout (integer)</term>
<listitem>
<para>
When SSSD switches to offline mode the amount of
time before it tries to go back online will
increase based upon the time spent disconnected.
By default SSSD uses incremental behaviour to
calculate delay in between retries.
So, the wait time for a given retry will be longer
than the wait time for the previous ones.
After each unsuccessful attempt to go online,
the new interval is recalculated by the following:
</para>
<para>
new_delay = Minimum(old_delay * 2, offline_timeout_max) + random[0...offline_timeout_random_offset]
</para>
<para>
The offline_timeout default value is 60.
The offline_timeout_max default value is 3600.
The offline_timeout_random_offset default value is 30.
The end result is amount of seconds before next retry.
</para>
<para>
Note that the maximum length of each interval
is defined by offline_timeout_max (apart of random part).
</para>
<para>
Default: 60
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>offline_timeout_max (integer)</term>
<listitem>
<para>
Controls by how much the time between attempts to go
online can be incremented following unsuccessful
attempts to go online.
</para>
<para>
A value of 0 disables the incrementing behaviour.
</para>
<para>
The value of this parameter should be set in correlation
to offline_timeout parameter value.
</para>
<para>
With offline_timeout set to 60 (default value) there is no point
in setting offlinet_timeout_max to less than 120 as it will
saturate instantly. General rule here should be to set
offline_timeout_max to at least 4 times offline_timeout.
</para>
<para>
Although a value between 0 and offline_timeout may be
specified, it has the effect of overriding the
offline_timeout value so is of little use.
</para>
<para>
Default: 3600
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>offline_timeout_random_offset (integer)</term>
<listitem>
<para>
When SSSD is in offline mode it keeps probing
backend servers in specified time intervals:
</para>
<para>
new_delay = Minimum(old_delay * 2, offline_timeout_max) + random[0...offline_timeout_random_offset]
</para>
<para>
This parameter controls the value of the random offset
used for the above equation. Final random_offset value
will be random number in range:
</para>
<para>
[0 - offline_timeout_random_offset]
</para>
<para>
A value of 0 disables the random offset addition.
</para>
<para>
Default: 30
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>responder_idle_timeout</term>
<listitem>
<para>
This option specifies the number of seconds that
an SSSD responder process can be up without being
used. This value is limited in order to avoid
resource exhaustion on the system.
The minimum acceptable value for this option is 60
seconds.
Setting this option to 0 (zero) means that no
timeout will be set up to the responder.
This option only has effect when SSSD is built with
systemd support and when services are either socket
or D-Bus activated.
</para>
<para>
Default: 300
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cache_first</term>
<listitem>
<para>
This option specifies whether the responder should
query all caches before querying the Data Providers.
</para>
<para condition="with_files_provider">
Default: false
</para>
<para condition="without_files_provider">
Default: true
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id='NSS'>
<title>NSS configuration options</title>
<para>
These options can be used to configure the
Name Service Switch (NSS) service.
</para>
<variablelist>
<varlistentry>
<term>enum_cache_timeout (integer)</term>
<listitem>
<para>
How many seconds should nss_sss cache enumerations
(requests for info about all users)
</para>
<para>
Default: 120
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_nowait_percentage (integer)</term>
<listitem>
<para>
The entry cache can be set to automatically update
entries in the background if they are requested
beyond a percentage of the entry_cache_timeout
value for the domain.
</para>
<para>
For example, if the domain's entry_cache_timeout
is set to 30s and entry_cache_nowait_percentage is
set to 50 (percent), entries that come in after 15
seconds past the last cache update will be
returned immediately, but the SSSD will go and
update the cache on its own, so that future
requests will not need to block waiting for a
cache update.
</para>
<para>
Valid values for this option are 0-99 and
represent a percentage of the entry_cache_timeout
for each domain. For performance reasons, this
percentage will never reduce the nowait timeout to
less than 10 seconds.
(0 disables this feature)
</para>
<para>
Default: 50
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_negative_timeout (integer)</term>
<listitem>
<para>
Specifies for how many seconds nss_sss should cache
negative cache hits (that is, queries for
invalid database entries, like nonexistent ones)
before asking the back end again.
</para>
<para>
Default: 15
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>local_negative_timeout (integer)</term>
<listitem>
<para>
Specifies for how many seconds nss_sss should keep
local users and groups in negative cache before
trying to look it up in the back end again. Setting
the option to 0 disables this feature.
</para>
<para>
Default: 14400 (4 hours)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>filter_users, filter_groups (string)</term>
<listitem>
<para>
Exclude certain users or groups from being fetched
from the sss NSS database. This is particularly
useful for system accounts. This option can also
be set per-domain or include fully-qualified names
to filter only users from the particular domain or
by a user principal name (UPN).
</para>
<para>
NOTE: The filter_groups option doesn't affect
inheritance of nested group members, since
filtering happens after they are propagated for
returning via NSS. E.g. a group having a member
group filtered out will still have the member
users of the latter listed.
</para>
<para>
Default: root
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>filter_users_in_groups (bool)</term>
<listitem>
<para>
If you want filtered user still be group members
set this option to false.
</para>
<para>
Default: true
</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>fallback_homedir (string)</term>
<listitem>
<para>
Set a default template for a user's home directory
if one is not specified explicitly by the domain's
data provider.
</para>
<para>
The available values for this option are the same
as for override_homedir.
</para>
<para>
example:
<programlisting>
fallback_homedir = /home/%u
</programlisting>
</para>
<para>
Default: not set (no substitution for unset home
directories)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>override_shell (string)</term>
<listitem>
<para>
Override the login shell for all users. This
option supersedes any other shell options if
it takes effect and can be set either in the
[nss] section or per-domain.
</para>
<para>
Default: not set (SSSD will use the value
retrieved from LDAP)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>allowed_shells (string)</term>
<listitem>
<para>
Restrict user shell to one of the listed values. The order of evaluation is:
</para>
<para>
1. If the shell is present in
<quote>/etc/shells</quote>, it is used.
</para>
<para>
2. If the shell is in the allowed_shells list but
not in <quote>/etc/shells</quote>, use the
value of the shell_fallback parameter.
</para>
<para>
3. If the shell is not in the allowed_shells list and
not in <quote>/etc/shells</quote>, a nologin shell
is used.
</para>
<para>
The wildcard (*) can be used to allow any shell.
</para>
<para>
The (*) is useful if you want to use
shell_fallback in case that user's shell is not
in <quote>/etc/shells</quote> and maintaining list
of all allowed shells in allowed_shells would be
to much overhead.
</para>
<para>
An empty string for shell is passed as-is to libc.
</para>
<para>
The <quote>/etc/shells</quote> is only read on SSSD start up, which means that
a restart of the SSSD is required in case a new shell is installed.
</para>
<para>
Default: Not set. The user shell is automatically used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>vetoed_shells (string)</term>
<listitem>
<para>
Replace any instance of these shells with the shell_fallback
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>shell_fallback (string)</term>
<listitem>
<para>
The default shell to use if an allowed shell is not
installed on the machine.
</para>
<para>
Default: /bin/sh
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>default_shell</term>
<listitem>
<para>
The default shell to use if the provider does
not return one during lookup. This option can
be specified globally in the [nss] section
or per-domain.
</para>
<para>
Default: not set (Return NULL if no shell is
specified and rely on libc to substitute something
sensible when necessary, usually /bin/sh)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>get_domains_timeout (int)</term>
<listitem>
<para>
Specifies time in seconds for which the list of
subdomains will be considered valid.
</para>
<para>
Default: 60
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>memcache_timeout (integer)</term>
<listitem>
<para>
Specifies time in seconds for which records
in the in-memory cache will be valid. Setting this
option to zero will disable the in-memory cache.
</para>
<para>
Default: 300
</para>
<para>
WARNING: Disabling the in-memory cache will
have significant negative impact on SSSD's
performance and should only be used for
testing.
</para>
<para>
NOTE: If the environment variable
SSS_NSS_USE_MEMCACHE is set to "NO", client
applications will not use the fast in-memory
cache.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>memcache_size_passwd (integer)</term>
<listitem>
<para>
Size (in megabytes) of the data table allocated inside
fast in-memory cache for passwd requests.
Setting the size to 0 will disable the passwd
in-memory cache.
</para>
<para>
Default: 8
</para>
<para>
WARNING: Disabled or too small in-memory cache can
have significant negative impact on SSSD's
performance.
</para>
<para>
NOTE: If the environment variable
SSS_NSS_USE_MEMCACHE is set to "NO", client
applications will not use the fast in-memory
cache.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>memcache_size_group (integer)</term>
<listitem>
<para>
Size (in megabytes) of the data table allocated inside
fast in-memory cache for group requests.
Setting the size to 0 will disable the group
in-memory cache.
</para>
<para>
Default: 6
</para>
<para>
WARNING: Disabled or too small in-memory cache can
have significant negative impact on SSSD's
performance.
</para>
<para>
NOTE: If the environment variable
SSS_NSS_USE_MEMCACHE is set to "NO", client
applications will not use the fast in-memory
cache.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>memcache_size_initgroups (integer)</term>
<listitem>
<para>
Size (in megabytes) of the data table allocated inside
fast in-memory cache for initgroups requests.
Setting the size to 0 will disable the initgroups
in-memory cache.
</para>
<para>
Default: 10
</para>
<para>
WARNING: Disabled or too small in-memory cache can
have significant negative impact on SSSD's
performance.
</para>
<para>
NOTE: If the environment variable
SSS_NSS_USE_MEMCACHE is set to "NO", client
applications will not use the fast in-memory
cache.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>memcache_size_sid (integer)</term>
<listitem>
<para>
Size (in megabytes) of the data table allocated inside
fast in-memory cache for SID related requests.
Only SID-by-ID and ID-by-SID requests are currently
cached in fast in-memory cache.
Setting the size to 0 will disable the SID
in-memory cache.
</para>
<para>
Default: 6
</para>
<para>
WARNING: Disabled or too small in-memory cache can
have significant negative impact on SSSD's
performance.
</para>
<para>
NOTE: If the environment variable
SSS_NSS_USE_MEMCACHE is set to "NO", client
applications will not use the fast in-memory
cache.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>user_attributes (string)</term>
<listitem>
<para>
Some of the additional NSS responder requests can
return more attributes than just the POSIX ones
defined by the NSS interface. The list of attributes
is controlled by this option. It is handled the same
way as the <quote>user_attributes</quote> option of
the InfoPipe responder (see
<citerefentry>
<refentrytitle>sssd-ifp</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
for details) but with no default values.
</para>
<para>
To make configuration more easy the NSS responder
will check the InfoPipe option if it is not set for
the NSS responder.
</para>
<para>
Default: not set, fallback to InfoPipe option
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pwfield (string)</term>
<listitem>
<para>
The value that NSS operations that return
users or groups will return for the
<quote>password</quote> field.
</para>
<para>
Default: <quote>*</quote>
</para>
<para>
Note: This option can also be set per-domain which
overwrites the value in [nss] section.
</para>
<para>
Default: <quote>not set</quote> (remote domains),
<phrase condition="with_files_provider">
<quote>x</quote> (the files domain),
</phrase>
<quote>x</quote> (proxy domain with nss_files
and sssd-shadowutils target)
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id='PAM'>
<title>PAM configuration options</title>
<para>
These options can be used to configure the
Pluggable Authentication Module (PAM) service.
</para>
<variablelist>
<varlistentry>
<term>offline_credentials_expiration (integer)</term>
<listitem>
<para>
If the authentication provider is offline, how
long should we allow cached logins (in days since
the last successful online login).
</para>
<para>
Default: 0 (No limit)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>offline_failed_login_attempts (integer)</term>
<listitem>
<para>
If the authentication provider is offline, how
many failed login attempts are allowed.
</para>
<para>
Default: 0 (No limit)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>offline_failed_login_delay (integer)</term>
<listitem>
<para>
The time in minutes which has to pass after
offline_failed_login_attempts has been reached
before a new login attempt is possible.
</para>
<para>
If set to 0 the user cannot authenticate offline if
offline_failed_login_attempts has been reached. Only
a successful online authentication can enable
offline authentication again.
</para>
<para>
Default: 5
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_verbosity (integer)</term>
<listitem>
<para>
Controls what kind of messages are shown to the user
during authentication. The higher the number to more
messages are displayed.
</para>
<para>
Currently sssd supports the following values:
</para>
<para>
<emphasis>0</emphasis>: do not show any message
</para>
<para>
<emphasis>1</emphasis>: show only important
messages
</para>
<para>
<emphasis>2</emphasis>: show informational messages
</para>
<para>
<emphasis>3</emphasis>: show all messages and debug
information
</para>
<para>
Default: 1
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_response_filter (string)</term>
<listitem>
<para>
A comma separated list of strings which allows to
remove (filter) data sent by the PAM responder to
pam_sss PAM module. There are different kind of
responses sent to pam_sss e.g. messages displayed to
the user or environment variables which should be
set by pam_sss.
</para>
<para>
While messages already can be controlled with the
help of the pam_verbosity option this option allows
to filter out other kind of responses as well.
</para>
<para>
Currently the following filters are supported:
<variablelist>
<varlistentry><term>ENV</term>
<listitem><para>Do not send any environment
variables to any service.</para></listitem>
</varlistentry>
<varlistentry><term>ENV:var_name</term>
<listitem><para>Do not send environment
variable var_name to any
service.</para></listitem>
</varlistentry>
<varlistentry><term>ENV:var_name:service</term>
<listitem><para>Do not send environment
variable var_name to
service.</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>
The list of strings can either be the list of
filters which would set this list of filters and
overwrite the defaults. Or each element of the list
can be prefixed by a '+' or '-' character which
would add the filter to the existing default or
remove it from the defaults, respectively. Please
note that either all list elements must have a '+'
or '-' prefix or none. It is considered as an error
to mix both styles.
</para>
<para>
Default: ENV:KRB5CCNAME:sudo, ENV:KRB5CCNAME:sudo-i
</para>
<para>
Example: -ENV:KRB5CCNAME:sudo-i will remove the
filter from the default list
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_id_timeout (integer)</term>
<listitem>
<para>
For any PAM request while SSSD is online, the SSSD will
attempt to immediately update the cached identity
information for the user in order to ensure that
authentication takes place with the latest information.
</para>
<para>
A complete PAM conversation may perform multiple PAM
requests, such as account management and session
opening. This option controls (on a
per-client-application basis) how long (in seconds) we
can cache the identity information to avoid excessive
round-trips to the identity provider.
</para>
<para>
Default: 5
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_pwd_expiration_warning (integer)</term>
<listitem>
<para>
Display a warning N days before the password expires.
</para>
<para>
Please note that the backend server has to provide
information about the expiration time of the password.
If this information is missing, sssd cannot display a
warning.
</para>
<para>
If zero is set, then this filter is not applied,
i.e. if the expiration warning was received from
backend server, it will automatically be displayed.
</para>
<para>
This setting can be overridden by setting
<emphasis>pwd_expiration_warning</emphasis>
for a particular domain.
</para>
<para>
Default: 0
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>get_domains_timeout (int)</term>
<listitem>
<para>
Specifies time in seconds for which the list of
subdomains will be considered valid.
</para>
<para>
Default: 60
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_trusted_users (string)</term>
<listitem>
<para>
Specifies the comma-separated list of UID
values or user names that are allowed to run
PAM conversations against trusted domains.
Users not included in this list can only access
domains marked as public with
<quote>pam_public_domains</quote>.
User names are resolved to UIDs at
startup.
</para>
<para>
Default: All users are considered trusted
by default
</para>
<para>
Please note that UID 0 is always allowed to access
the PAM responder even in case it is not in the
pam_trusted_users list.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_public_domains (string)</term>
<listitem>
<para>
Specifies the comma-separated list of domain names
that are accessible even to untrusted users.
</para>
<para>
Two special values for pam_public_domains option
are defined:
</para>
<para>
all (Untrusted users are allowed to access
all domains in PAM responder.)
</para>
<para>
none (Untrusted users are not allowed to access
any domains PAM in responder.)
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_account_expired_message (string)</term>
<listitem>
<para>
Allows a custom expiration message to be set,
replacing the default 'Permission denied'
message.
</para>
<para>
Note: Please be aware that message is only
printed for the SSH service unless pam_verbosity
is set to 3 (show all messages and debug
information).
</para>
<para>
example:
<programlisting>
pam_account_expired_message = Account expired, please contact help desk.
</programlisting>
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_account_locked_message (string)</term>
<listitem>
<para>
Allows a custom lockout message to be set,
replacing the default 'Permission denied'
message.
</para>
<para>
example:
<programlisting>
pam_account_locked_message = Account locked, please contact help desk.
</programlisting>
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry condition="build_passkey">
<term>pam_passkey_auth (bool)</term>
<listitem>
<para>
Enable passkey device based authentication.
</para>
<para>
Default: False
</para>
</listitem>
</varlistentry>
<varlistentry condition="build_passkey">
<term>passkey_debug_libfido2 (bool)</term>
<listitem>
<para>
Enable libfido2 library debug messages.
</para>
<para>
Default: False
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_cert_auth (bool)</term>
<listitem>
<para>
Enable certificate based Smartcard authentication.
Since this requires additional communication with
the Smartcard which will delay the authentication
process this option is disabled by default.
</para>
<para>
Default: False
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_cert_db_path (string)</term>
<listitem>
<para>
The path to the certificate database.
</para>
<para>
Default:
<itemizedlist>
<listitem><para>/etc/sssd/pki/sssd_auth_ca_db.pem
(path to a file with trusted CA
certificates in PEM format)
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_cert_verification (string)</term>
<listitem>
<para>
With this parameter the PAM certificate verification
can be tuned with a comma separated list of
options that override the
<quote>certificate_verification</quote> value in
<quote>[sssd]</quote> section.
Supported options are the same of
<quote>certificate_verification</quote>.
</para>
<para>
example:
<programlisting>
pam_cert_verification = partial_chain
</programlisting>
</para>
<para>
Default: not set, i.e. use default
<quote>certificate_verification</quote> option defined
in <quote>[sssd]</quote> section.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>p11_child_timeout (integer)</term>
<listitem>
<para>
How many seconds will pam_sss wait for
p11_child to finish.
</para>
<para>
Default: 10
</para>
</listitem>
</varlistentry>
<varlistentry condition="build_passkey">
<term>passkey_child_timeout (integer)</term>
<listitem>
<para>
How many seconds will the PAM responder
wait for passkey_child to finish.
</para>
<para>
Default: 15
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_app_services (string)</term>
<listitem>
<para>
Which PAM services are permitted to contact
domains of type <quote>application</quote>
</para>
<para>
Default: Not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_p11_allowed_services (integer)</term>
<listitem>
<para>
A comma-separated list of PAM service names for
which it will be allowed to use Smartcards.
</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
authentication with Smartcards
(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>
pam_p11_allowed_services = +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-smartcard
</para>
</listitem>
<listitem>
<para>
gdm-password
</para>
</listitem>
<listitem>
<para>
kdm
</para>
</listitem>
<listitem>
<para>
sudo
</para>
</listitem>
<listitem>
<para>
sudo-i
</para>
</listitem>
<listitem>
<para>
gnome-screensaver
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>p11_wait_for_card_timeout (integer)</term>
<listitem>
<para>
If Smartcard authentication is required how many
extra seconds in addition to p11_child_timeout
should the PAM responder wait until a Smartcard is
inserted.
</para>
<para>
Default: 60
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>p11_uri (string)</term>
<listitem>
<para>
PKCS#11 URI (see RFC-7512 for details) which can be
used to restrict the selection of devices used for
Smartcard authentication. By default SSSD's
p11_child will search for a PKCS#11 slot (reader)
where the 'removable' flags is set and read the
certificates from the inserted token from the first
slot found. If multiple readers are connected
p11_uri can be used to tell p11_child to use a
specific reader.
</para>
<para>
Example:
<programlisting>
p11_uri = pkcs11:slot-description=My%20Smartcard%20Reader
</programlisting>
or
<programlisting>
p11_uri = pkcs11:library-description=OpenSC%20smartcard%20framework;slot-id=2
</programlisting>
To find suitable URI please check the debug output
of p11_child. As an alternative the GnuTLS utility
'p11tool' with e.g. the '--list-all' will show
PKCS#11 URIs as well.
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_initgroups_scheme</term>
<listitem>
<para>
The PAM responder can force an online lookup to get
the current group memberships of the user trying to
log in. This option controls when this should be
done and the following values are allowed:
<variablelist>
<varlistentry><term>always</term>
<listitem><para>Always do an online lookup,
please note that pam_id_timeout still
applies</para></listitem>
</varlistentry>
<varlistentry><term>no_session</term>
<listitem><para>Only do an online
lookup if there is no active session of the
user, i.e. if the user is currently not logged
in</para></listitem>
</varlistentry>
<varlistentry><term>never</term>
<listitem><para>Never force an online lookup,
use the data from the cache as long as they are
not expired</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>
Default: no_session
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_gssapi_services</term>
<listitem>
<para>
Comma separated list of PAM services that are
allowed to try GSSAPI authentication using
pam_sss_gss.so module.
</para>
<para>
To disable GSSAPI authentication, set this option
to <quote>-</quote> (dash).
</para>
<para>
Note: This option can also be set per-domain which
overwrites the value in [pam] section. It can also
be set for trusted domain which overwrites the value
in the domain section.
</para>
<para>
Example:
<programlisting>
pam_gssapi_services = sudo, sudo-i
</programlisting>
</para>
<para>
Default: - (GSSAPI authentication is disabled)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_gssapi_check_upn</term>
<listitem>
<para>
If True, SSSD will require that the Kerberos user
principal that successfully authenticated through
GSSAPI can be associated with the user who is being
authenticated. Authentication will fail if the check
fails.
</para>
<para>
If False, every user that is able to obtained
required service ticket will be authenticated.
</para>
<para>
Note: This option can also be set per-domain which
overwrites the value in [pam] section. It can also
be set for trusted domain which overwrites the value
in the domain section.
</para>
<para>
Default: True
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pam_gssapi_indicators_map</term>
<listitem>
<para>
Comma separated list of authentication indicators required
to be present in a Kerberos ticket to access a PAM service
that is allowed to try GSSAPI authentication using
pam_sss_gss.so module.
</para>
<para>
Each element of the list can be either an authentication indicator
name or a pair <quote>service:indicator</quote>. Indicators not
prefixed with the PAM service name will be required to access any
PAM service configured to be used with
<option>pam_gssapi_services</option>. A resulting list of indicators
per PAM service is then checked against indicators in the Kerberos
ticket during authentication by pam_sss_gss.so. Any indicator from the
ticket that matches the resulting list of indicators for the PAM service
would grant access. If none of the indicators in the list match, access
will be denied. If the resulting list of indicators for the PAM service
is empty, the check will not prevent the access.
</para>
<para>
To disable GSSAPI authentication indicator check, set this option
to <quote>-</quote> (dash). To disable the check for a specific PAM
service, add <quote>service:-</quote>.
</para>
<para>
Note: This option can also be set per-domain which
overwrites the value in [pam] section. It can also
be set for trusted domain which overwrites the value
in the domain section.
</para>
<para>
Following authentication indicators are supported by IPA Kerberos deployments:
<itemizedlist>
<listitem>
<para>pkinit -- pre-authentication using X.509 certificates -- whether stored in files or on smart cards.</para>
</listitem>
<listitem>
<para>hardened -- SPAKE pre-authentication or any pre-authentication wrapped in a FAST channel.</para>
</listitem>
<listitem>
<para>radius -- pre-authentication with the help of a RADIUS server.</para>
</listitem>
<listitem>
<para>otp -- pre-authentication using integrated two-factor authentication (2FA or one-time password, OTP) in IPA.</para>
</listitem>
<listitem>
<para>idp -- pre-authentication using external identity provider.</para>
</listitem>
</itemizedlist>
</para>
<para>
Example: to require access to SUDO services only
for users which obtained their Kerberos tickets
with a X.509 certificate pre-authentication
(PKINIT), set
<programlisting>
pam_gssapi_indicators_map = sudo:pkinit, sudo-i:pkinit
</programlisting>
</para>
<para>
Default: not set (use of authentication indicators is not required)
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id='SUDO' condition="with_sudo">
<title>SUDO configuration options</title>
<para>
These options can be used to configure the sudo service.
The detailed instructions for configuration of
<citerefentry>
<refentrytitle>sudo</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> to work with
<citerefentry>
<refentrytitle>sssd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry> are in the manual page
<citerefentry>
<refentrytitle>sssd-sudo</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
</para>
<variablelist>
<varlistentry>
<term>sudo_timed (bool)</term>
<listitem>
<para>
Whether or not to evaluate the sudoNotBefore
and sudoNotAfter attributes that implement
time-dependent sudoers entries.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>sudo_threshold (integer)</term>
<listitem>
<para>
Maximum number of expired rules that can be
refreshed at once. If number of expired rules
is below threshold, those rules are refreshed
with <quote>rules refresh</quote> mechanism. If
the threshold is exceeded a
<quote>full refresh</quote> of sudo rules is
triggered instead. This threshold number also
applies to IPA sudo command and command group
searches.
</para>
<para>
Default: 50
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id='AUTOFS' condition="with_autofs">
<title>AUTOFS configuration options</title>
<para>
These options can be used to configure the autofs service.
</para>
<variablelist>
<varlistentry>
<term>autofs_negative_timeout (integer)</term>
<listitem>
<para>
Specifies for how many seconds should the
autofs responder negative cache hits
(that is, queries for invalid map entries,
like nonexistent ones) before asking the back
end again.
</para>
<para>
Default: 15
</para>
</listitem>
</varlistentry>
</variablelist>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/autofs_restart.xml" />
</refsect2>
<refsect2 id='SSH' condition="with_ssh">
<title>SSH configuration options</title>
<para>
These options can be used to configure the SSH service.
</para>
<variablelist>
<varlistentry>
<term>ssh_hash_known_hosts (bool)</term>
<listitem>
<para>
Whether or not to hash host names and addresses in
the managed known_hosts file.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ssh_known_hosts_timeout (integer)</term>
<listitem>
<para>
How many seconds to keep a host in the managed
known_hosts file after its host keys were requested.
</para>
<para>
Default: 180
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ssh_use_certificate_keys (bool)</term>
<listitem>
<para>
If set to true the
<command>sss_ssh_authorizedkeys</command> will
return ssh keys derived from the public key of X.509
certificates stored in the user entry as well. See
<citerefentry>
<refentrytitle>sss_ssh_authorizedkeys</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> for details.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ssh_use_certificate_matching_rules (string)</term>
<listitem>
<para>
By default the ssh responder will use all available
certificate matching rules to filter the
certificates so that ssh keys are only derived from
the matching ones. With this option the used rules
can be restricted with a comma separated list of
mapping and matching rule names. All other rules
will be ignored.
</para>
<para>
There are two special key words 'all_rules' and
'no_rules' which will enable all or no rules,
respectively. The latter means that no certificates
will be filtered out and ssh keys will be generated
from all valid certificates.
</para>
<para>
If no rules are configured using 'all_rules' will
enable a default rule which enables all
certificates suitable for client authentication.
This is the same behavior as for the PAM responder
if certificate authentication is enabled.
</para>
<para>
A non-existing rule name is considered an error.
If as a result no rule is selected all certificates
will be ignored.
</para>
<para>
Default: not set, equivalent to 'all_rules',
all found rules or the default rule are used
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ca_db (string)</term>
<listitem>
<para>
Path to a storage of trusted CA certificates. The
option is used to validate user certificates before
deriving public ssh keys from them.
</para>
<para>
Default:
<itemizedlist>
<listitem><para>/etc/sssd/pki/sssd_auth_ca_db.pem
(path to a file with trusted CA
certificates in PEM format)
</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id='PAC_RESPONDER' condition="with_pac_responder">
<title>PAC responder configuration options</title>
<para>
The PAC responder works together with the authorization data
plugin for MIT Kerberos sssd_pac_plugin.so and a sub-domain
provider. The plugin sends the PAC data during a GSSAPI
authentication to the PAC responder. The sub-domain provider
collects domain SID and ID ranges of the domain the client is
joined to and of remote trusted domains from the local domain
controller. If the PAC is decoded and evaluated some of the
following operations are done:
<itemizedlist>
<listitem><para>If the remote user does not exist in the
cache, it is created. The UID is determined with the help
of the SID, trusted domains will have UPGs and the GID
will have the same value as the UID. The home directory is
set based on the subdomain_homedir parameter. The shell will
be empty by default, i.e. the system defaults are used, but
can be overwritten with the default_shell parameter.</para>
</listitem>
<listitem><para>If there are SIDs of groups from domains
sssd knows about, the user will be added to those groups.
</para></listitem>
</itemizedlist>
</para>
<para>
These options can be used to configure the PAC responder.
</para>
<variablelist>
<varlistentry>
<term>allowed_uids (string)</term>
<listitem>
<para>
Specifies the comma-separated list of UID values or
user names that are allowed to access the PAC
responder. User names are resolved to UIDs at
startup.
</para>
<para>
Default: 0 (only the root user is allowed to access
the PAC responder)
</para>
<para>
Please note that although the UID 0 is used as the
default it will be overwritten with this option. If
you still want to allow the root user to access the
PAC responder, which would be the typical case, you
have to add 0 to the list of allowed UIDs as well.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pac_lifetime (integer)</term>
<listitem>
<para>
Lifetime of the PAC entry in seconds. As long as the
PAC is valid the PAC data can be used to determine
the group memberships of a user.
</para>
<para>
Default: 300
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pac_check (string)</term>
<listitem>
<para>
Apply additional checks on the PAC of the Kerberos
ticket which is available in Active Directory and
FreeIPA domains, if configured. Please note that
Kerberos ticket validation must be enabled to be
able to check the PAC, i.e. the krb5_validate option
must be set to 'True' which is the default for the
IPA and AD provider. If krb5_validate is set to
'False' the PAC checks will be skipped.
</para>
<para>
The following options can be used alone or in a
comma-separated list:
<variablelist>
<varlistentry>
<term>no_check</term>
<listitem>
<para>The PAC must not be present and even
if it is present no additional checks will be
done.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pac_present</term>
<listitem>
<para>The PAC must be present in the
service ticket which SSSD will request with
the help of the user's TGT. If the PAC is
not available the authentication will fail.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>check_upn</term>
<listitem>
<para>If the PAC is present check if the
user principal name (UPN) information is
consistent.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>check_upn_allow_missing</term>
<listitem>
<para>This option should be used together
with 'check_upn' and handles the case where
a UPN is set on the server-side but is not
read by SSSD. The typical example is a
FreeIPA domain where 'ldap_user_principal'
is set to a not existing attribute name.
This was typically done to work-around
issues in the handling of enterprise
principals. But this is fixed since quite
some time and FreeIPA can handle enterprise
principals just fine and there is no need
anymore to set 'ldap_user_principal'.</para>
<para>Currently this option is set by
default to avoid regressions in such
environments. A log message will be added
to the system log and SSSD's debug log in
case a UPN is found in the PAC but not in
SSSD's cache. To avoid this log message it
would be best to evaluate if the
'ldap_user_principal' option can be removed.
If this is not possible, removing
'check_upn' will skip the test and avoid the
log message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>upn_dns_info_present</term>
<listitem>
<para>The PAC must contain the UPN-DNS-INFO
buffer, implies 'check_upn'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>check_upn_dns_info_ex</term>
<listitem>
<para>If the PAC is present and the
extension to the UPN-DNS-INFO buffer is
available check if the information in the
extension is consistent.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>upn_dns_info_ex_present</term>
<listitem>
<para>The PAC must contain the extension of
the UPN-DNS-INFO buffer, implies
'check_upn_dns_info_ex',
'upn_dns_info_present' and 'check_upn'.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Default: no_check (AD and IPA provider
'check_upn, check_upn_allow_missing, check_upn_dns_info_ex')
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2 id='SESSION_RECORDING'>
<title>Session recording configuration options</title>
<para>
Session recording works in conjunction with
<citerefentry>
<refentrytitle>tlog-rec-session</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>, a part of tlog package, to log what users see
and type when they log in on a text terminal.
See also
<citerefentry>
<refentrytitle>sssd-session-recording</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
</para>
<para>
These options can be used to configure session recording.
</para>
<variablelist>
<varlistentry>
<term>scope (string)</term>
<listitem>
<para>
One of the following strings specifying the scope
of session recording:
<variablelist>
<varlistentry>
<term>"none"</term>
<listitem>
<para>
No users are recorded.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"some"</term>
<listitem>
<para>
Users/groups specified by
<replaceable>users</replaceable>
and
<replaceable>groups</replaceable>
options are recorded.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>"all"</term>
<listitem>
<para>
All users are recorded.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Default: "none"
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>users (string)</term>
<listitem>
<para>
A comma-separated list of users which should have
session recording enabled. Matches user names as
returned by NSS. I.e. after the possible space
replacement, case changes, etc.
</para>
<para>
Default: Empty. Matches no users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>groups (string)</term>
<listitem>
<para>
A comma-separated list of groups, members of which
should have session recording enabled. Matches
group names as returned by NSS. I.e. after the
possible space replacement, case changes, etc.
</para>
<para>
NOTE: using this option (having it set to
anything) has a considerable performance cost,
because each uncached request for a user requires
retrieving and matching the groups the user is
member of.
</para>
<para>
Default: Empty. Matches no groups.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>exclude_users (string)</term>
<listitem>
<para>
A comma-separated list of users to be excluded from
recording, only applicable with 'scope=all'.
</para>
<para>
Default: Empty. No users excluded.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>exclude_groups (string)</term>
<listitem>
<para>
A comma-separated list of groups, members of which
should be excluded from recording. Only applicable
with 'scope=all'.
</para>
<para>
NOTE: using this option (having it set to
anything) has a considerable performance cost,
because each uncached request for a user requires
retrieving and matching the groups the user is
member of.
</para>
<para>
Default: Empty. No groups excluded.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1 id='domain-sections'>
<title>DOMAIN SECTIONS</title>
<para>
These configuration options can be present in a domain
configuration section, that is, in a section called
<quote>[domain/<replaceable>NAME</replaceable>]</quote>
<variablelist>
<varlistentry>
<term>enabled</term>
<listitem>
<para>
Explicitly enable or disable the domain. If
<quote>true</quote>, the domain is always
<quote>enabled</quote>. If <quote>false</quote>,
the domain is always <quote>disabled</quote>. If
this option is not set, the domain is enabled only
if it is listed in the domains option in the
<quote>[sssd]</quote> section.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>domain_type (string)</term>
<listitem>
<para>
Specifies whether the domain is meant to be used
by POSIX-aware clients such as the Name Service Switch
or by applications that do not need POSIX data to be
present or generated. Only objects from POSIX domains
are available to the operating system interfaces and
utilities.
</para>
<para>
Allowed values for this option are <quote>posix</quote>
and <quote>application</quote>.
</para>
<para>
POSIX domains are reachable by all services. Application
domains are only reachable from the InfoPipe responder (see
<citerefentry>
<refentrytitle>sssd-ifp</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>) and the PAM responder.
</para>
<para>
NOTE: The application domains are currently well tested with
<quote>id_provider=ldap</quote> only.
</para>
<para>
For an easy way to configure a non-POSIX domains, please
see the <quote>Application domains</quote> section.
</para>
<para>
Default: posix
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>min_id,max_id (integer)</term>
<listitem>
<para>
UID and GID limits for the domain. If a domain
contains an entry that is outside these limits, it
is ignored.
</para>
<para>
For users, this affects the primary GID limit. The
user will not be returned to NSS if either the
UID or the primary GID is outside the range. For
non-primary group memberships, those that are in
range will be reported as expected.
</para>
<para>
These ID limits affect even saving entries to
cache, not only returning them by name or ID.
</para>
<para>
Default: 1 for min_id, 0 (no limit) for max_id
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>enumerate (bool)</term>
<listitem>
<para>
Determines if a domain can be enumerated,
that is, whether the domain can list all the
users and group it contains. Note that it is
not required to enable enumeration in order
for secondary groups to be displayed. This
parameter can have one of the following values:
</para>
<para>
TRUE = Users and groups are enumerated
</para>
<para>
FALSE = No enumerations for this domain
</para>
<para>
Default: FALSE
</para>
<para>
Enumerating a domain requires SSSD to download
and store ALL user and group entries from the
remote server.
</para>
<para>
Note: Enabling enumeration has a moderate
performance impact on SSSD while enumeration
is running. It may take up to several minutes
after SSSD startup to fully complete enumerations.
During this time, individual requests for
information will go directly to LDAP, though it
may be slow, due to the heavy enumeration
processing. Saving a large number of entries
to cache after the enumeration completes might
also be CPU intensive as the memberships have
to be recomputed. This can lead to the
<quote>sssd_be</quote> process becoming unresponsive
or even restarted by the internal watchdog.
</para>
<para>
While the first enumeration is running, requests
for the complete user or group lists may return
no results until it completes.
</para>
<para>
Further, enabling enumeration may increase the time
necessary to detect network disconnection, as
longer timeouts are required to ensure that
enumeration lookups are completed successfully.
For more information, refer to the man pages for
the specific id_provider in use.
</para>
<para>
For the reasons cited above, enabling enumeration
is not recommended, especially in large
environments.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>subdomain_enumerate (string)</term>
<listitem>
<para>
Whether any of autodetected trusted domains should
be enumerated. The supported values are:
<variablelist>
<varlistentry>
<term>all</term>
<listitem><para>All discovered trusted domains will be enumerated</para></listitem>
</varlistentry>
<varlistentry>
<term>none</term>
<listitem><para>No discovered trusted domains will be enumerated</para></listitem>
</varlistentry>
</variablelist>
Optionally, a list of one or more domain
names can enable enumeration just for these
trusted domains.
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_timeout (integer)</term>
<listitem>
<para>
How many seconds should nss_sss consider
entries valid before asking the backend again
</para>
<para>
The cache expiration timestamps are stored
as attributes of individual objects in the
cache. Therefore, changing the cache timeout only
has effect for newly added or expired entries.
You should run the
<citerefentry>
<refentrytitle>sss_cache</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
tool in order to force refresh of entries that
have already been cached.
</para>
<para>
Default: 5400
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_user_timeout (integer)</term>
<listitem>
<para>
How many seconds should nss_sss consider
user entries valid before asking the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_group_timeout (integer)</term>
<listitem>
<para>
How many seconds should nss_sss consider
group entries valid before asking the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_netgroup_timeout (integer)</term>
<listitem>
<para>
How many seconds should nss_sss consider
netgroup entries valid before asking the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_service_timeout (integer)</term>
<listitem>
<para>
How many seconds should nss_sss consider
service entries valid before asking the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_resolver_timeout (integer)</term>
<listitem>
<para>
How many seconds should nss_sss consider
hosts and networks entries valid before asking
the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry condition="with_sudo">
<term>entry_cache_sudo_timeout (integer)</term>
<listitem>
<para>
How many seconds should sudo consider
rules valid before asking the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry condition="with_autofs">
<term>entry_cache_autofs_timeout (integer)</term>
<listitem>
<para>
How many seconds should the autofs service
consider automounter maps valid before asking
the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry condition="with_ssh">
<term>entry_cache_ssh_host_timeout (integer)</term>
<listitem>
<para>
How many seconds to keep a host ssh key after
refresh. IE how long to cache the host key
for.
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>entry_cache_computer_timeout (integer)</term>
<listitem>
<para>
How many seconds to keep the local computer
entry before asking the backend again
</para>
<para>
Default: entry_cache_timeout
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>refresh_expired_interval (integer)</term>
<listitem>
<para>
Specifies how many seconds SSSD has to wait before
triggering a background refresh task which will
refresh all expired or nearly expired records.
</para>
<para>
The background refresh will process users,
groups and netgroups in the cache. For users
who have performed the initgroups (get group
membership for user, typically ran at login)
operation in the past, both the user entry
and the group membership are updated.
</para>
<para>
This option is automatically inherited for all
trusted domains.
</para>
<para>
You can consider setting this value to
3/4 * entry_cache_timeout.
</para>
<para>
Cache entry will be refreshed by background task
when 2/3 of cache timeout has already passed.
If there are existing cached entries, the background
task will refer to their original cache timeout
values instead of current configuration value.
This may lead to a situation in which background refresh
task appears to not be working. This is done
by design to improve offline mode operation and
reuse of existing valid cache entries.
To make this change instant the user may want to
manually invalidate existing cache.
</para>
<para>
Default: 0 (disabled)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cache_credentials (bool)</term>
<listitem>
<para>
Determines if user credentials are also cached
in the local LDB cache. The cached credentials
refer to passwords, which includes the first (long
term) factor of two-factor authentication, not
other authentication mechanisms. Passkey and
Smartcard authentications are expected to work
offline as long as a successful online
authentication is recorded in the cache without
additional configuration.
</para>
<para>
Take a note that while credentials are stored as
a salted SHA512 hash, this still potentially poses
some security risk in case an attacker manages to
get access to a cache file (normally requires
privileged access) and to break a password using
brute force attack.
</para>
<para>
Default: FALSE
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cache_credentials_minimal_first_factor_length (int)</term>
<listitem>
<para>
If 2-Factor-Authentication (2FA) is used and
credentials should be saved this value determines
the minimal length the first authentication factor
(long term password) must have to be saved as SHA512
hash into the cache.
</para>
<para>
This should avoid that the short PINs of a PIN based
2FA scheme are saved in the cache which would make
them easy targets for brute-force attacks.
</para>
<para>
Default: 8
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>account_cache_expiration (integer)</term>
<listitem>
<para>
Number of days entries are left in cache after
last successful login before being removed during
a cleanup of the cache. 0 means keep forever.
The value of this parameter must be greater than or
equal to offline_credentials_expiration.
</para>
<para>
Default: 0 (unlimited)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>pwd_expiration_warning (integer)</term>
<listitem>
<para>
Display a warning N days before the password expires.
</para>
<para>
If zero is set, then this filter is not applied,
i.e. if the expiration warning was received from
backend server, it will automatically be displayed.
</para>
<para>
Please note that the backend server has to provide
information about the expiration time of the password.
If this information is missing, sssd cannot display a
warning. Also an auth provider has to be configured for
the backend.
</para>
<para>
Default: 7 (Kerberos), 0 (LDAP)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>id_provider (string)</term>
<listitem>
<para>
The identification provider used for the domain.
Supported ID providers are:
</para>
<para>
<quote>proxy</quote>: Support a legacy NSS provider.
</para>
<para condition="with_files_provider">
<quote>files</quote>: FILES provider. See
<citerefentry>
<refentrytitle>sssd-files</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
how to mirror local users and groups into SSSD.
</para>
<para>
<quote>ldap</quote>: LDAP provider. See
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring LDAP.
</para>
<para>
<quote>ipa</quote>: FreeIPA and Red Hat
Identity Management provider. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring FreeIPA.
</para>
<para>
<quote>ad</quote>: Active Directory provider. See
<citerefentry>
<refentrytitle>sssd-ad</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring Active Directory.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>use_fully_qualified_names (bool)</term>
<listitem>
<para>
Use the full name and domain (as formatted by
the domain's full_name_format) as the user's login
name reported to NSS.
</para>
<para>
If set to TRUE, all requests to this domain
must use fully qualified names. For example,
if used in LOCAL domain that contains a "test"
user, <command>getent passwd test</command>
wouldn't find the user while <command>getent
passwd test@LOCAL</command> would.
</para>
<para>
NOTE: This option has no effect on netgroup
lookups due to their tendency to include nested
netgroups without qualified names. For netgroups,
all domains will be searched when an unqualified
name is requested.
</para>
<para>
Default: FALSE (TRUE for trusted
domain/sub-domains or if default_domain_suffix
is used)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ignore_group_members (bool)</term>
<listitem>
<para>
Do not return group members for group lookups.
</para>
<para>
If set to TRUE, the group membership attribute
is not requested from the ldap server, and
group members are not returned when processing
group lookup calls, such as
<citerefentry>
<refentrytitle>getgrnam</refentrytitle>
<manvolnum>3</manvolnum>
</citerefentry>
or
<citerefentry>
<refentrytitle>getgrgid</refentrytitle>
<manvolnum>3</manvolnum>
</citerefentry>.
As an effect, <quote>getent group
$groupname</quote> would return the requested
group as if it was empty.
</para>
<para>
Enabling this option can also make access
provider checks for group membership
significantly faster, especially for groups
containing many members.
</para>
<para>
This option can be also set per subdomain or
inherited via
<emphasis>subdomain_inherit</emphasis>.
</para>
<para>
Default: FALSE
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>auth_provider (string)</term>
<listitem>
<para>
The authentication provider used for the domain.
Supported auth providers are:
</para>
<para>
<quote>ldap</quote> for native LDAP authentication. See
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring LDAP.
</para>
<para>
<quote>krb5</quote> for Kerberos authentication. See
<citerefentry>
<refentrytitle>sssd-krb5</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring Kerberos.
</para>
<para>
<quote>ipa</quote>: FreeIPA and Red Hat
Identity Management provider. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring FreeIPA.
</para>
<para>
<quote>ad</quote>: Active Directory provider. See
<citerefentry>
<refentrytitle>sssd-ad</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring Active Directory.
</para>
<para>
<quote>proxy</quote> for relaying authentication to some other PAM target.
</para>
<para>
<quote>none</quote> disables authentication explicitly.
</para>
<para>
Default: <quote>id_provider</quote> is used if it
is set and can handle authentication requests.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access_provider (string)</term>
<listitem>
<para>
The access control provider used for the domain.
There are two built-in access providers (in
addition to any included in installed backends)
Internal special providers are:
</para>
<para>
<quote>permit</quote> always allow access. It's the only permitted access provider for a local domain.
</para>
<para>
<quote>deny</quote> always deny access.
</para>
<para>
<quote>ldap</quote> for native LDAP authentication. See
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring LDAP.
</para>
<para>
<quote>ipa</quote>: FreeIPA and Red Hat
Identity Management provider. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring FreeIPA.
</para>
<para>
<quote>ad</quote>: Active Directory provider. See
<citerefentry>
<refentrytitle>sssd-ad</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring Active Directory.
</para>
<para>
<quote>simple</quote> access control based on access
or deny lists. See <citerefentry>
<refentrytitle>sssd-simple</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for more
information on configuring the simple access module.
</para>
<para>
<quote>krb5</quote>: .k5login based access control.
See <citerefentry>
<refentrytitle>sssd-krb5</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for more
information on configuring Kerberos.
</para>
<para>
<quote>proxy</quote> for relaying access control to another PAM module.
</para>
<para>
Default: <quote>permit</quote>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>chpass_provider (string)</term>
<listitem>
<para>
The provider which should handle change password
operations for the domain.
Supported change password providers are:
</para>
<para>
<quote>ldap</quote> to change a password stored
in a LDAP server. See
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring LDAP.
</para>
<para>
<quote>krb5</quote> to change the Kerberos
password. See
<citerefentry>
<refentrytitle>sssd-krb5</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring Kerberos.
</para>
<para>
<quote>ipa</quote>: FreeIPA and Red Hat
Identity Management provider. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring FreeIPA.
</para>
<para>
<quote>ad</quote>: Active Directory provider. See
<citerefentry>
<refentrytitle>sssd-ad</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on
configuring Active Directory.
</para>
<para>
<quote>proxy</quote> for relaying password changes
to some other PAM target.
</para>
<para>
<quote>none</quote> disallows password changes explicitly.
</para>
<para>
Default: <quote>auth_provider</quote> is used if it
is set and can handle change password requests.
</para>
</listitem>
</varlistentry>
<varlistentry condition="with_sudo">
<term>sudo_provider (string)</term>
<listitem>
<para>
The SUDO provider used for the domain.
Supported SUDO providers are:
</para>
<para>
<quote>ldap</quote> for rules stored in LDAP. See
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring
LDAP.
</para>
<para>
<quote>ipa</quote> the same as <quote>ldap</quote>
but with IPA default settings.
</para>
<para>
<quote>ad</quote> the same as <quote>ldap</quote>
but with AD default settings.
</para>
<para>
<quote>none</quote> disables SUDO explicitly.
</para>
<para>
Default: The value of <quote>id_provider</quote> is
used if it is set.
</para>
<para>
The detailed instructions for configuration of
sudo_provider are in the manual page
<citerefentry>
<refentrytitle>sssd-sudo</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
There are many configuration options that can be
used to adjust the behavior. Please refer to
"ldap_sudo_*" in
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>.
</para>
<para>
<emphasis>NOTE:</emphasis> Sudo rules are
periodically downloaded in the background unless
the sudo provider is explicitly disabled. Set
<emphasis>sudo_provider = None</emphasis> to
disable all sudo-related activity in SSSD if you do
not want to use sudo with SSSD at all.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>selinux_provider (string)</term>
<listitem>
<para>
The provider which should handle loading of selinux
settings. Note that this provider will be called right
after access provider ends.
Supported selinux providers are:
</para>
<para>
<quote>ipa</quote> to load selinux settings
from an IPA server. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring IPA.
</para>
<para>
<quote>none</quote> disallows fetching selinux settings explicitly.
</para>
<para>
Default: <quote>id_provider</quote> is used if it
is set and can handle selinux loading requests.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>subdomains_provider (string)</term>
<listitem>
<para>
The provider which should handle fetching of
subdomains. This value should be always the same as
id_provider.
Supported subdomain providers are:
</para>
<para>
<quote>ipa</quote> to load a list of subdomains
from an IPA server. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring
IPA.
</para>
<para>
<quote>ad</quote> to load a list of subdomains
from an Active Directory server. See
<citerefentry>
<refentrytitle>sssd-ad</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring
the AD provider.
</para>
<para>
<quote>none</quote> disallows fetching subdomains
explicitly.
</para>
<para>
Default: The value of <quote>id_provider</quote> is
used if it is set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>session_provider (string)</term>
<listitem>
<para>
The provider which configures and manages user session
related tasks. The only user session task currently
provided is the integration with Fleet Commander, which
works only with IPA.
Supported session providers are:
</para>
<para>
<quote>ipa</quote> to allow performing user session
related tasks.
</para>
<para>
<quote>none</quote> does not perform any kind of user
session related tasks.
</para>
<para>
Default: <quote>id_provider</quote> is used if it
is set and can perform session related tasks.
</para>
<para>
<emphasis>NOTE:</emphasis> In order to have this feature
working as expected SSSD must be running as "root" and
not as the unprivileged user.
</para>
</listitem>
</varlistentry>
<varlistentry condition="with_autofs">
<term>autofs_provider (string)</term>
<listitem>
<para>
The autofs provider used for the domain.
Supported autofs providers are:
</para>
<para>
<quote>ldap</quote> to load maps stored in LDAP. See
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring LDAP.
</para>
<para>
<quote>ipa</quote> to load maps stored in an IPA
server. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring IPA.
</para>
<para>
<quote>ad</quote> to load maps stored in an AD
server. See
<citerefentry>
<refentrytitle>sssd-ad</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring
the AD provider.
</para>
<para>
<quote>none</quote> disables autofs explicitly.
</para>
<para>
Default: The value of <quote>id_provider</quote> is used if it
is set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>hostid_provider (string)</term>
<listitem>
<para>
The provider used for retrieving host identity information.
Supported hostid providers are:
</para>
<para>
<quote>ipa</quote> to load host identity stored in an IPA
server. See
<citerefentry>
<refentrytitle>sssd-ipa</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring IPA.
</para>
<para>
<quote>none</quote> disables hostid explicitly.
</para>
<para>
Default: The value of <quote>id_provider</quote> is used if it
is set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>resolver_provider (string)</term>
<listitem>
<para>
The provider which should handle hosts and networks
lookups. Supported resolver providers are:
</para>
<para>
<quote>proxy</quote> to forward lookups to another
NSS library. See <quote>proxy_resolver_lib_name</quote>
</para>
<para>
<quote>ldap</quote> to fetch hosts and networks stored in LDAP. See
<citerefentry>
<refentrytitle>sssd-ldap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring LDAP.
</para>
<para>
<quote>ad</quote> to fetch hosts and networks stored in AD. See
<citerefentry>
<refentrytitle>sssd-ad</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> for more information on configuring
the AD provider.
</para>
<para>
<quote>none</quote> disallows fetching hosts and networks explicitly.
</para>
<para>
Default: The value of <quote>id_provider</quote> is used if it
is set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>re_expression (string)</term>
<listitem>
<para>
Regular expression for this domain that describes
how to parse the string containing user name and
domain into these components.
The "domain" can match either the SSSD
configuration domain name, or, in the case
of IPA trust subdomains and Active Directory
domains, the flat (NetBIOS) name of the domain.
</para>
<para>
Default: <quote>^((?P<name>.+)@(?P<domain>[^@]*)|(?P<name>[^@]+))$</quote>
which allows two different styles for user names:
<itemizedlist>
<listitem>
<para>username</para>
</listitem>
<listitem>
<para>username@domain.name</para>
</listitem>
</itemizedlist>
</para>
<para>
Default for the AD and IPA provider:
<quote>^(((?P<domain>[^\\]+)\\(?P<name>.+))|((?P<name>.+)@(?P<domain>[^@]+))|((?P<name>[^@\\]+)))$</quote>
which allows three different styles for user names:
<itemizedlist>
<listitem>
<para>username</para>
</listitem>
<listitem>
<para>username@domain.name</para>
</listitem>
<listitem>
<para>domain\username</para>
</listitem>
</itemizedlist>
While the first two correspond to the general
default the third one is introduced to allow easy
integration of users from Windows domains.
</para>
<para>
The default re_expression uses the <quote>@</quote>
character as a separator between the name and the
domain. As a result of this setting the default
does not accept the <quote>@</quote> character in
short names (as it is allowed in Windows group
names). If a user wishes to use short names with
<quote>@</quote> they must create their own
re_expression.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>full_name_format (string)</term>
<listitem>
<para>
A <citerefentry>
<refentrytitle>printf</refentrytitle>
<manvolnum>3</manvolnum>
</citerefentry>-compatible format that describes how to
compose a fully qualified name from user name
and domain name components.
</para>
<para>
The following expansions are supported:
<variablelist>
<varlistentry>
<term>%1$s</term>
<listitem><para>user name</para></listitem>
</varlistentry>
<varlistentry>
<term>%2$s</term>
<listitem>
<para>
domain name as specified in the
SSSD config file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>%3$s</term>
<listitem>
<para>
domain flat name. Mostly usable
for Active Directory domains, both
directly configured or discovered
via IPA trusts.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Default: <quote>%1$s@%2$s</quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>lookup_family_order (string)</term>
<listitem>
<para>
Provides the ability to select preferred address family
to use when performing DNS lookups.
</para>
<para>
Supported values:
</para>
<para>
ipv4_first: Try looking up IPv4 address, if that fails, try IPv6
</para>
<para>
ipv4_only: Only attempt to resolve hostnames to IPv4 addresses.
</para>
<para>
ipv6_first: Try looking up IPv6 address, if that fails, try IPv4
</para>
<para>
ipv6_only: Only attempt to resolve hostnames to IPv6 addresses.
</para>
<para>
Default: ipv4_first
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dns_resolver_server_timeout (integer)</term>
<listitem>
<para>
Defines the amount of time (in milliseconds)
SSSD would try to talk to DNS server before
trying next DNS server.
</para>
<para>
The AD provider will use this option for the
CLDAP ping timeouts as well.
</para>
<para>
Please see the section <quote>FAILOVER</quote>
for more information about the service
resolution.
</para>
<para>
Default: 1000
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dns_resolver_op_timeout (integer)</term>
<listitem>
<para>
Defines the amount of time (in seconds) to
wait to resolve single DNS query
(e.g. resolution of a hostname or an SRV record)
before trying the next hostname or DNS discovery.
</para>
<para>
Please see the section <quote>FAILOVER</quote>
for more information about the service
resolution.
</para>
<para>
Default: 3
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dns_resolver_timeout (integer)</term>
<listitem>
<para>
Defines the amount of time (in seconds) to
wait for a reply from the internal fail over
service before assuming that the service is
unreachable. If this timeout is reached, the
domain will continue to operate in offline mode.
</para>
<para>
Please see the section <quote>FAILOVER</quote>
for more information about the service
resolution.
</para>
<para>
Default: 6
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dns_resolver_use_search_list (bool)</term>
<listitem>
<para>
Normally, the DNS resolver searches the domain
list defined in the "search" directive from the
resolv.conf file. This can lead to delays in
environments with improperly configured DNS.
</para>
<para>
If fully qualified domain names (or _srv_) are used
in the SSSD configuration, setting this option
to FALSE can prevent unnecessary DNS lookups in such
environments.
</para>
<para>
Default: TRUE
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>dns_discovery_domain (string)</term>
<listitem>
<para>
If service discovery is used in the back end, specifies
the domain part of the service discovery DNS query.
</para>
<para>
Default: Use the domain part of machine's hostname
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>override_gid (integer)</term>
<listitem>
<para>
Override the primary GID value with the one specified.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>case_sensitive (string)</term>
<listitem>
<para>
Treat user and group names as case sensitive.
Possible option values are:
<variablelist>
<varlistentry>
<term>True</term>
<listitem>
<para>
Case sensitive. This value is invalid
for AD provider.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>False</term>
<listitem>
<para>Case insensitive.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Preserving</term>
<listitem>
<para>
Same as False (case insensitive), but
does not lowercase names in the result
of NSS operations. Note that name
aliases (and in case of services also
protocol names) are still lowercased in
the output.
</para>
<para>
If you want to set this value for
trusted domain with IPA provider, you
need to set it on both the client and
SSSD on the server.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
This option can be also set per subdomain or
inherited via
<emphasis>subdomain_inherit</emphasis>.
</para>
<para>
Default: True (False for AD provider)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>subdomain_inherit (string)</term>
<listitem>
<para>
Specifies a list of configuration parameters that
should be inherited by a subdomain. Please note
that only selected parameters can be inherited.
Currently the following options can be inherited:
</para>
<para>
ldap_search_timeout
</para>
<para>
ldap_network_timeout
</para>
<para>
ldap_opt_timeout
</para>
<para>
ldap_offline_timeout
</para>
<para>
ldap_enumeration_refresh_timeout
</para>
<para>
ldap_enumeration_refresh_offset
</para>
<para>
ldap_purge_cache_timeout
</para>
<para>
ldap_purge_cache_offset
</para>
<para>
ldap_krb5_keytab (the value of krb5_keytab will be
used if ldap_krb5_keytab is not set explicitly)
</para>
<para>
ldap_krb5_ticket_lifetime
</para>
<para>
ldap_enumeration_search_timeout
</para>
<para>
ldap_connection_expire_timeout
</para>
<para>
ldap_connection_expire_offset
</para>
<para>
ldap_connection_idle_timeout
</para>
<para>
ldap_use_tokengroups
</para>
<para>
ldap_user_principal
</para>
<para>
ignore_group_members
</para>
<para>
auto_private_groups
</para>
<para>
case_sensitive
</para>
<para>
Example:
<programlisting>
subdomain_inherit = ldap_purge_cache_timeout
</programlisting>
</para>
<para>
Default: none
</para>
<para>
Note: This option only works with the IPA and
AD provider.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>subdomain_homedir (string)</term>
<listitem>
<para>
Use this homedir as default value for all subdomains
within this domain in IPA AD trust.
See <emphasis>override_homedir</emphasis>
for info about possible values. In addition to those, the
expansion below can only be used with
<emphasis>subdomain_homedir</emphasis>.
<variablelist>
<varlistentry>
<term>%F</term>
<listitem><para>flat (NetBIOS) name of a subdomain.</para></listitem>
</varlistentry>
</variablelist>
</para>
<para>
The value can be overridden by
<emphasis>override_homedir</emphasis> option.
</para>
<para>
Default: <filename>/home/%d/%u</filename>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>realmd_tags (string)</term>
<listitem>
<para>
Various tags stored by the realmd configuration service
for this domain.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cached_auth_timeout (int)</term>
<listitem>
<para>
Specifies time in seconds since last successful
online authentication for which user will be
authenticated using cached credentials while
SSSD is in the online mode. If the credentials
are incorrect, SSSD falls back to online
authentication.
</para>
<para>
This option's value is inherited by all trusted
domains. At the moment it is not possible to set
a different value per trusted domain.
</para>
<para>
Special value 0 implies that this feature is
disabled.
</para>
<para>
Please note that if <quote>cached_auth_timeout</quote>
is longer than <quote>pam_id_timeout</quote> then the
back end could be called to handle
<quote>initgroups.</quote>
</para>
<para>
Default: 0
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>local_auth_policy (string)</term>
<listitem>
<para>
Local authentication methods policy. Some backends
(i.e. LDAP, proxy provider) only support a password
based authentication, while others can handle PKINIT
based Smartcard authentication (AD, IPA),
two-factor authentication (IPA), or other methods
against a central instance. By default in such cases
authentication is only performed with the methods
supported by the backend.
</para>
<para>
There are three possible values for this option:
match, only, enable. <quote>match</quote> is
used to match offline and online states for Kerberos
methods. <quote>only</quote> ignores the online methods
and only offer the local ones. enable allows explicitly
defining the methods for local authentication. As an
example, <quote>enable:passkey</quote>, only enables
passkey for local authentication. Multiple enable values
should be comma-separated, such as
<quote>enable:passkey, enable:smartcard</quote>
</para>
<para>
Please note that if local Smartcard authentication
is enabled and a Smartcard is present, Smartcard
authentication will be preferred over the
authentication methods supported by the backend.
I.e. there will be a PIN prompt instead of e.g. a
password prompt.
</para>
<para>
The following configuration example allows local users
to authenticate locally using any enabled method
(i.e. smartcard, passkey).
<programlisting>
[domain/shadowutils]
id_provider = proxy
proxy_lib_name = files
auth_provider = none
local_auth_policy = only
</programlisting>
</para>
<para condition="with_files_provider">
It is expected that the <quote>files</quote>
provider ignores the local_auth_policy option and
supports Smartcard authentication by default.
</para>
<para>
Default: match
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>auto_private_groups (string)</term>
<listitem>
<para>
This option takes any of three available values:
<variablelist>
<varlistentry>
<term>true</term>
<listitem>
<para>
Create user's private group unconditionally from user's UID number.
The GID number is ignored in this case.
</para>
<para>
NOTE: Because the GID number and the user private group
are inferred from the UID number, it is not supported
to have multiple entries with the same UID or GID number
with this option. In other words, enabling this option
enforces uniqueness across the ID space.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>false</term>
<listitem>
<para>
Always use the user's primary GID number. The GID number must refer
to a group object in the LDAP database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>hybrid</term>
<listitem>
<para>
A primary group is autogenerated
for user entries whose UID
and GID numbers have the same
value and at the same time the
GID number does not correspond
to a real group object in LDAP.
If the values are the same, but
the primary GID in the user entry
is also used by a group object,
the primary GID of the user resolves
to that group object.
</para>
<para>
If the UID and GID of a user
are different, then the GID
must correspond to a group
entry, otherwise the GID is
simply not resolvable.
</para>
<para>
This feature is useful for
environments that wish to stop
maintaining a separate group
objects for the user private
groups, but also wish to retain
the existing user private groups.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
For subdomains, the default value is False for
subdomains that use assigned POSIX IDs and True
for subdomains that use automatic ID-mapping.
</para>
<para>
The value of auto_private_groups can either be set per subdomains
in a subsection, for example:
<programlisting>
[domain/forest.domain/sub.domain]
auto_private_groups = false
</programlisting>
or globally for all subdomains in the main domain section
using the subdomain_inherit option:
<programlisting>
[domain/forest.domain]
subdomain_inherit = auto_private_groups
auto_private_groups = false
</programlisting>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Options valid for proxy domains.
<variablelist>
<varlistentry>
<term>proxy_pam_target (string)</term>
<listitem>
<para>
The proxy target PAM proxies to.
</para>
<para>
Default: not set by default, you have to take an
existing pam configuration or create a new one and
add the service name here. As an alternative you
can enable local authentication with the
local_auth_policy option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>proxy_lib_name (string)</term>
<listitem>
<para>
The name of the NSS library to use in proxy
domains. The NSS functions searched for in the
library are in the form of
_nss_$(libName)_$(function), for example
_nss_files_getpwent.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>proxy_resolver_lib_name (string)</term>
<listitem>
<para>
The name of the NSS library to use for hosts and
networks lookups in proxy domains. The NSS
functions searched for in the
library are in the form of
_nss_$(libName)_$(function), for example
_nss_dns_gethostbyname2_r.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>proxy_fast_alias (boolean)</term>
<listitem>
<para>
When a user or group is looked up by name in
the proxy provider, a second lookup by ID is
performed to "canonicalize" the name in case
the requested name was an alias. Setting this
option to true would cause the SSSD to perform
the ID lookup from cache for performance reasons.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>proxy_max_children (integer)</term>
<listitem>
<para>
This option specifies the number of pre-forked
proxy children. It is useful for high-load SSSD
environments where sssd may run out of available
child slots, which would cause some issues due to
the requests being queued.
</para>
<para>
Default: 10
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<refsect2 id='app_domains'>
<title>Application domains</title>
<para>
SSSD, with its D-Bus interface (see
<citerefentry>
<refentrytitle>sssd-ifp</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>) is appealing to applications
as a gateway to an LDAP directory where users and groups
are stored. However, contrary to the traditional SSSD
deployment where all users and groups either have POSIX
attributes or those attributes can be inferred from the
Windows SIDs, in many cases the users and groups in the
application support scenario have no POSIX attributes.
Instead of setting a
<quote>[domain/<replaceable>NAME</replaceable>]</quote>
section, the administrator can set up an
<quote>[application/<replaceable>NAME</replaceable>]</quote>
section that internally represents a domain with type
<quote>application</quote> optionally inherits settings
from a tradition SSSD domain.
</para>
<para>
Please note that the application domain must still be
explicitly enabled in the <quote>domains</quote> parameter
so that the lookup order between the application domain
and its POSIX sibling domain is set correctly.
</para>
<variablelist>
<title>Application domain parameters</title>
<varlistentry>
<term>inherit_from (string)</term>
<listitem>
<para>
The SSSD POSIX-type domain the application
domain inherits all settings from. The
application domain can moreover add its own
settings to the application settings that augment
or override the <quote>sibling</quote>
domain settings.
</para>
<para>
Default: Not set
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The following example illustrates the use of an application
domain. In this setup, the POSIX domain is connected to an LDAP
server and is used by the OS through the NSS responder. In addition,
the application domain also requests the telephoneNumber attribute,
stores it as the phone attribute in the cache and makes the phone
attribute reachable through the D-Bus interface.
</para>
<programlisting>
[sssd]
domains = appdom, posixdom
[ifp]
user_attributes = +phone
[domain/posixdom]
id_provider = ldap
ldap_uri = ldap://ldap.example.com
ldap_search_base = dc=example,dc=com
[application/appdom]
inherit_from = posixdom
ldap_user_extra_attrs = phone:telephoneNumber
</programlisting>
</refsect2>
</refsect1>
<refsect1 id='trusted-domains'>
<title>TRUSTED DOMAIN SECTION</title>
<para>
Some options used in the domain section can also be used in the
trusted domain section, that is, in a section called
<quote>[domain/<replaceable>DOMAIN_NAME</replaceable>/<replaceable>TRUSTED_DOMAIN_NAME</replaceable>]</quote>.
Where DOMAIN_NAME is the actual joined-to base domain. Please refer
to examples below for explanation.
Currently supported options in the trusted domain section are:
</para>
<para>ldap_search_base,</para>
<para>ldap_user_search_base,</para>
<para>ldap_group_search_base,</para>
<para>ldap_netgroup_search_base,</para>
<para>ldap_service_search_base,</para>
<para>ldap_sasl_mech,</para>
<para>ad_server,</para>
<para>ad_backup_server,</para>
<para>ad_site,</para>
<para>use_fully_qualified_names</para>
<para>pam_gssapi_services</para>
<para>pam_gssapi_check_upn</para>
<para>
For more details about these options see their individual description
in the manual page.
</para>
</refsect1>
<refsect1 id='certmap'>
<title>CERTIFICATE MAPPING SECTION</title>
<para>
To allow authentication with Smartcards and certificates SSSD must
be able to map certificates to users. This can be done by adding the
full certificate to the LDAP object of the user or to a local
override. While using the full certificate is required to use the
Smartcard authentication feature of SSH (see
<citerefentry>
<refentrytitle>sss_ssh_authorizedkeys</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
for details) it might be cumbersome or not even possible to do this
for the general case where local services use PAM for
authentication.
</para>
<para>
To make the mapping more flexible mapping and matching rules were
added to SSSD (see
<citerefentry>
<refentrytitle>sss-certmap</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
for details).
</para>
<para>
A mapping and matching rule can be added to the SSSD configuration
in a section on its own with a name like
<quote>[certmap/<replaceable>DOMAIN_NAME</replaceable>/<replaceable>RULE_NAME</replaceable>]</quote>.
In this section the following options are allowed:
</para>
<variablelist>
<varlistentry>
<term>matchrule (string)</term>
<listitem>
<para>
Only certificates from the Smartcard which matches this
rule will be processed, all others are ignored.
</para>
<para>
Default: KRB5:<EKU>clientAuth, i.e. only
certificates which have the Extended Key Usage
<quote>clientAuth</quote>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>maprule (string)</term>
<listitem>
<para>
Defines how the user is found for a given certificate.
</para>
<para>
Default:
<itemizedlist>
<listitem>
<para>LDAP:(userCertificate;binary={cert!bin})
for LDAP based providers like
<quote>ldap</quote>, <quote>AD</quote> or
<quote>ipa</quote>.</para>
</listitem>
<listitem condition="with_files_provider">
<para>The RULE_NAME for the <quote>files</quote>
provider which tries to find a user with the
same name.</para>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>domains (string)</term>
<listitem>
<para>
Comma separated list of domain names the rule should be
applied. By default a rule is only valid in the domain
configured in sssd.conf. If the provider supports
subdomains this option can be used to add the rule to
subdomains as well.
</para>
<para>
Default: the configured domain in sssd.conf
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>priority (integer)</term>
<listitem>
<para>
Unsigned integer value defining the priority of the
rule. The higher the number the lower the priority.
<quote>0</quote> stands for the highest priority while
<quote>4294967295</quote> is the lowest.
</para>
<para>
Default: the lowest priority
</para>
</listitem>
</varlistentry>
</variablelist>
<para condition="with_files_provider">
To make the configuration simple and reduce the amount of
configuration options the <quote>files</quote> provider has some
special properties:
<itemizedlist>
<listitem>
<para>
if maprule is not set the RULE_NAME name is assumed to
be the name of the matching user
</para>
</listitem>
<listitem>
<para>
if a maprule is used both a single user name or a
template like
<quote>{subject_rfc822_name.short_name}</quote> must
be in braces like e.g. <quote>(username)</quote> or
<quote>({subject_rfc822_name.short_name})</quote>
</para>
</listitem>
<listitem>
<para>
the <quote>domains</quote> option is ignored
</para>
</listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1 id='prompting_configuration'>
<title>PROMPTING CONFIGURATION SECTION</title>
<para>
If a special file
(<filename>/var/lib/sss/pubconf/pam_preauth_available</filename>)
exists SSSD's PAM module pam_sss will ask SSSD to figure out which
authentication methods are available for the user trying to log in.
Based on the results pam_sss will prompt the user for appropriate
credentials.
</para>
<para>
With the growing number of authentication methods and the
possibility that there are multiple ones for a single user the
heuristic used by pam_sss to select the prompting might not be
suitable for all use cases. The following options should provide a
better flexibility here.
</para>
<para>
Each supported authentication method has its own configuration
subsection under <quote>[prompting/...]</quote>. Currently there
are:
<variablelist>
<varlistentry>
<term>[prompting/password]</term>
<listitem>
<para>to configure password prompting, allowed options are:
<variablelist><varlistentry><term>password_prompt</term>
<listitem><para>to change the string of the password
prompt</para></listitem></varlistentry></variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>[prompting/2fa]</term>
<listitem>
<para>to configure two-factor authentication prompting,
allowed options are:
<variablelist><varlistentry><term>first_prompt</term>
<listitem><para>to change the string of the prompt for
the first factor </para></listitem>
</varlistentry>
<varlistentry><term>second_prompt</term>
<listitem><para>to change the string of the prompt for
the second factor </para></listitem>
</varlistentry>
<varlistentry><term>single_prompt</term>
<listitem><para>boolean value, if True there will be
only a single prompt using the value of first_prompt
where it is expected that both factors are entered as a
single string. Please note that both factors have to be
entered here, even if the second factor is
optional.</para></listitem>
</varlistentry>
</variablelist>
If the second factor is optional and it should be possible
to log in either only with the password or with both factors
two-step prompting has to be used.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry condition="build_passkey">
<term>[prompting/passkey]</term>
<listitem>
<para>to configure passkey authentication prompting,
allowed options are:
<variablelist>
<varlistentry>
<term>interactive</term>
<listitem>
<para>boolean value, if True prompt a message and wait
before testing the presence of a passkey device.
Recommended if your device doesn’t have a
tactile trigger.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>interactive_prompt</term>
<listitem>
<para>to change the message of the interactive prompt.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>touch</term>
<listitem>
<para>boolean value, if True prompt a message to
remind the user to touch the device.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>touch_prompt</term>
<listitem>
<para>to change the message of the touch prompt.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
It is possible to add a subsection for specific PAM services,
e.g. <quote>[prompting/password/sshd]</quote> to individual change
the prompting for this service.
</para>
</refsect1>
<refsect1 id='example'>
<title>EXAMPLES</title>
<para>
1. The following example shows a typical SSSD config. It does
not describe configuration of the domains themselves - refer to
documentation on configuring domains for more details.
<programlisting>
[sssd]
domains = LDAP
services = nss, pam
config_file_version = 2
[nss]
filter_groups = root
filter_users = root
[pam]
[domain/LDAP]
id_provider = ldap
ldap_uri = ldap://ldap.example.com
ldap_search_base = dc=example,dc=com
auth_provider = krb5
krb5_server = kerberos.example.com
krb5_realm = EXAMPLE.COM
cache_credentials = true
min_id = 10000
max_id = 20000
enumerate = False
</programlisting>
</para>
<para>
2. The following example shows configuration of IPA AD trust where
the AD forest consists of two domains in a parent-child structure.
Suppose IPA domain (ipa.com) has trust with AD domain(ad.com).
ad.com has child domain (child.ad.com). To enable shortnames in
the child domain the following configuration should be used.
<programlisting>
[domain/ipa.com/child.ad.com]
use_fully_qualified_names = false
</programlisting>
</para>
<para>
3. The following example shows the configuration of a certificate
mapping rule. It is valid for the configured domain
<quote>my.domain</quote> and additionally for the subdomains
<quote>your.domain</quote> and uses the full certificate in the
search filter.
<programlisting>
[certmap/my.domain/rule_name]
matchrule = <ISSUER>^CN=My-CA,DC=MY,DC=DOMAIN$
maprule = (userCertificate;binary={cert!bin})
domains = my.domain, your.domain
priority = 10
</programlisting>
</para>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/seealso.xml" />
</refentry>
</reference>
|