3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive<?xml version="1.0" encoding="UTF-8"?>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">

db878466c5e95073429dda0bdd001f45e9486e16fielding<reference>

db878466c5e95073429dda0bdd001f45e9486e16fielding<title>SSSD Manual pages</title>

db878466c5e95073429dda0bdd001f45e9486e16fielding<refentry>

db878466c5e95073429dda0bdd001f45e9486e16fielding <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />

db878466c5e95073429dda0bdd001f45e9486e16fielding

db878466c5e95073429dda0bdd001f45e9486e16fielding <refmeta>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end <refentrytitle>sssd-ldap</refentrytitle>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end <manvolnum>5</manvolnum>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end <refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end </refmeta>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end <refnamediv id='name'>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end <refname>sssd-ldap</refname>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end <refpurpose>SSSD LDAP provider</refpurpose>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end </refnamediv>

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refsect1 id='description'>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <title>DESCRIPTION</title>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive This manual page describes the configuration of LDAP

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive domains for

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <citerefentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refentrytitle>sssd</refentrytitle>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <manvolnum>8</manvolnum>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </citerefentry>.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Refer to the <quote>FILE FORMAT</quote> section of the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <citerefentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refentrytitle>sssd.conf</refentrytitle>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <manvolnum>5</manvolnum>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </citerefentry> manual page for detailed syntax information.</para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive You can configure SSSD to use more than one LDAP domain.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive LDAP back end supports id, auth, access and chpass providers. If you want

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive to authenticate against an LDAP server either TLS/SSL or LDAPS

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive is required. <command>sssd</command> <emphasis>does

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive not</emphasis> support authentication over an unencrypted channel.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive If the LDAP server is used only as an identity provider, an encrypted

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive channel is not needed. Please refer to <quote>ldap_access_filter</quote>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive config option for more information about using LDAP as an access provider.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </refsect1>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refsect1 id='configuration-options'>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <title>CONFIGURATION OPTIONS</title>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive All of the common configuration options that apply to SSSD domains also apply

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive to LDAP domains. Refer to the <quote>DOMAIN SECTIONS</quote> section of the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <citerefentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refentrytitle>sssd.conf</refentrytitle>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <manvolnum>5</manvolnum>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </citerefentry> manual page for full details.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <variablelist>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_uri, ldap_backup_uri (string)</term>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Specifies the comma-separated list of URIs of the LDAP servers to which

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive SSSD should connect in the order of preference. Refer to the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <quote>FAILOVER</quote> section for more information on failover and server redundancy.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive If neither option is specified, service discovery is enabled. For more information,

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive refer to the <quote>SERVICE DISCOVERY</quote> section.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd The format of the URI must match the format defined in RFC 2732:

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd ldap[s]://&lt;host&gt;[:port]

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd For explicit IPv6 addresses, &lt;host&gt; must be enclosed in brackets []

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd example: ldap://[fc00::126:25]:389

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <varlistentry>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <term>ldap_chpass_uri, ldap_chpass_backup_uri (string)</term>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

58842e03db54033d15cc224d997f467abc88a97aslive Specifies the comma-separated list of URIs of the LDAP servers to

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive which SSSD should connect in the order of preference

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive to change the password of a user. Refer to the

58842e03db54033d15cc224d997f467abc88a97aslive <quote>FAILOVER</quote> section for more information

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive on failover and server redundancy.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive To enable service discovery

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive ldap_chpass_dns_service_name must be set.

5e9423b4ca454c6416a2dc465dea1b1d34cec7a9slive </para>

5e9423b4ca454c6416a2dc465dea1b1d34cec7a9slive <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd Default: empty, i.e. ldap_uri is used.

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

5e9423b4ca454c6416a2dc465dea1b1d34cec7a9slive </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_search_base (string)</term>

5e9423b4ca454c6416a2dc465dea1b1d34cec7a9slive <listitem>

5e9423b4ca454c6416a2dc465dea1b1d34cec7a9slive <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd The default base DN to use for

97d4d9527b64d7491543a12a3d21134b857cbe4bnd performing LDAP user operations.

5e9423b4ca454c6416a2dc465dea1b1d34cec7a9slive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Starting with SSSD 1.7.0, SSSD supports multiple

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive search bases using the syntax:

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive search_base[?scope?[filter][?search_base?scope?[filter]]*]

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The scope can be one of "base", "onelevel" or "subtree".

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The filter must be a valid LDAP search filter as

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive specified by http://www.ietf.org/rfc/rfc2254.txt

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Examples:

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd ldap_search_base = dc=example,dc=com

97d4d9527b64d7491543a12a3d21134b857cbe4bnd (which is equivalent to)

97d4d9527b64d7491543a12a3d21134b857cbe4bnd ldap_search_base = dc=example,dc=com?subtree?

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive ldap_search_base = cn=host_specific,dc=example,dc=com?subtree?(host=thishost)?dc=example.com?subtree?

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Note: It is unsupported to have multiple search

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive bases which reference identically-named objects

97d4d9527b64d7491543a12a3d21134b857cbe4bnd (for example, groups with the same name in two

97d4d9527b64d7491543a12a3d21134b857cbe4bnd different search bases). This will lead to

97d4d9527b64d7491543a12a3d21134b857cbe4bnd unpredictable behavior on client machines.

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd Default: If not set, the value of the

97d4d9527b64d7491543a12a3d21134b857cbe4bnd defaultNamingContext or namingContexts attribute

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive from the RootDSE of the LDAP server is

97d4d9527b64d7491543a12a3d21134b857cbe4bnd used. If defaultNamingContext does not exist or

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive has an empty value namingContexts is used.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The namingContexts attribute must have a

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive single value with the DN of the search base of the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive LDAP server to make this work. Multiple values are

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive are not supported.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_schema (string)</term>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Specifies the Schema Type in use on the target LDAP

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive server.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Depending on the selected schema, the default

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive attribute names retrieved from the servers may vary.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The way that some attributes are handled may also differ.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Four schema types are currently supported:

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <itemizedlist>

39926890ef5576499f1bd78a1412b43e79f2f694slive <listitem>

39926890ef5576499f1bd78a1412b43e79f2f694slive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive rfc2307

368bcafaedaee463f769c1b5f3547b9970df90d0slive </para>

368bcafaedaee463f769c1b5f3547b9970df90d0slive </listitem>

368bcafaedaee463f769c1b5f3547b9970df90d0slive <listitem>

368bcafaedaee463f769c1b5f3547b9970df90d0slive <para>

368bcafaedaee463f769c1b5f3547b9970df90d0slive rfc2307bis

368bcafaedaee463f769c1b5f3547b9970df90d0slive </para>

368bcafaedaee463f769c1b5f3547b9970df90d0slive </listitem>

368bcafaedaee463f769c1b5f3547b9970df90d0slive <listitem>

368bcafaedaee463f769c1b5f3547b9970df90d0slive <para>

39926890ef5576499f1bd78a1412b43e79f2f694slive IPA

39926890ef5576499f1bd78a1412b43e79f2f694slive </para>

39926890ef5576499f1bd78a1412b43e79f2f694slive </listitem>

39926890ef5576499f1bd78a1412b43e79f2f694slive <listitem>

87ea898bcffe2ef490e833dc246a1cc0465d783fslive <para>

87ea898bcffe2ef490e833dc246a1cc0465d783fslive AD

87ea898bcffe2ef490e833dc246a1cc0465d783fslive </para>

39926890ef5576499f1bd78a1412b43e79f2f694slive </listitem>

39926890ef5576499f1bd78a1412b43e79f2f694slive </itemizedlist>

39926890ef5576499f1bd78a1412b43e79f2f694slive </para>

39926890ef5576499f1bd78a1412b43e79f2f694slive <para>

39926890ef5576499f1bd78a1412b43e79f2f694slive The main difference between these schema types is

87ea898bcffe2ef490e833dc246a1cc0465d783fslive how group memberships are recorded in the server.

87ea898bcffe2ef490e833dc246a1cc0465d783fslive With rfc2307, group members are listed by name in the

87ea898bcffe2ef490e833dc246a1cc0465d783fslive <emphasis>memberUid</emphasis> attribute.

39926890ef5576499f1bd78a1412b43e79f2f694slive With rfc2307bis and IPA, group members are listed by DN

39926890ef5576499f1bd78a1412b43e79f2f694slive and stored in the <emphasis>member</emphasis> attribute.

39926890ef5576499f1bd78a1412b43e79f2f694slive The AD schema type sets the attributes to correspond with

368bcafaedaee463f769c1b5f3547b9970df90d0slive Active Directory 2008r2 values.

368bcafaedaee463f769c1b5f3547b9970df90d0slive </para>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <para>

368bcafaedaee463f769c1b5f3547b9970df90d0slive Default: rfc2307

368bcafaedaee463f769c1b5f3547b9970df90d0slive </para>

368bcafaedaee463f769c1b5f3547b9970df90d0slive </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <term>ldap_default_bind_dn (string)</term>

87ea898bcffe2ef490e833dc246a1cc0465d783fslive <listitem>

87ea898bcffe2ef490e833dc246a1cc0465d783fslive <para>

87ea898bcffe2ef490e833dc246a1cc0465d783fslive The default bind DN to use for

87ea898bcffe2ef490e833dc246a1cc0465d783fslive performing LDAP operations.

87ea898bcffe2ef490e833dc246a1cc0465d783fslive </para>

87ea898bcffe2ef490e833dc246a1cc0465d783fslive </listitem>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive </varlistentry>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <varlistentry>

58842e03db54033d15cc224d997f467abc88a97aslive <term>ldap_default_authtok_type (string)</term>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <listitem>

39926890ef5576499f1bd78a1412b43e79f2f694slive <para>

39926890ef5576499f1bd78a1412b43e79f2f694slive The type of the authentication token of the

39926890ef5576499f1bd78a1412b43e79f2f694slive default bind DN.

39926890ef5576499f1bd78a1412b43e79f2f694slive </para>

39926890ef5576499f1bd78a1412b43e79f2f694slive <para>

39926890ef5576499f1bd78a1412b43e79f2f694slive The two mechanisms currently supported are:

58842e03db54033d15cc224d997f467abc88a97aslive </para>

39926890ef5576499f1bd78a1412b43e79f2f694slive <para>

39926890ef5576499f1bd78a1412b43e79f2f694slive password

1cb160a981947e75a8353da3fe40a653aa87100eslive </para>

58842e03db54033d15cc224d997f467abc88a97aslive <para>

58842e03db54033d15cc224d997f467abc88a97aslive obfuscated_password

58842e03db54033d15cc224d997f467abc88a97aslive </para>

58842e03db54033d15cc224d997f467abc88a97aslive <para>

58842e03db54033d15cc224d997f467abc88a97aslive Default: password

58842e03db54033d15cc224d997f467abc88a97aslive </para>

58842e03db54033d15cc224d997f467abc88a97aslive </listitem>

58842e03db54033d15cc224d997f467abc88a97aslive </varlistentry>

58842e03db54033d15cc224d997f467abc88a97aslive

58842e03db54033d15cc224d997f467abc88a97aslive <varlistentry>

58842e03db54033d15cc224d997f467abc88a97aslive <term>ldap_default_authtok (string)</term>

58842e03db54033d15cc224d997f467abc88a97aslive <listitem>

58842e03db54033d15cc224d997f467abc88a97aslive <para>

58842e03db54033d15cc224d997f467abc88a97aslive The authentication token of the default bind DN.

58842e03db54033d15cc224d997f467abc88a97aslive Only clear text passwords are currently supported.

58842e03db54033d15cc224d997f467abc88a97aslive </para>

58842e03db54033d15cc224d997f467abc88a97aslive </listitem>

58842e03db54033d15cc224d997f467abc88a97aslive </varlistentry>

1cb160a981947e75a8353da3fe40a653aa87100eslive

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <varlistentry>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <term>ldap_user_object_class (string)</term>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <listitem>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <para>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive The object class of a user entry in LDAP.

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive </para>

04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <para>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive Default: posixAccount

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </para>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </listitem>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </varlistentry>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <varlistentry>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <term>ldap_user_name (string)</term>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <listitem>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <para>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive The LDAP attribute that corresponds to the

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive user's login name.

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </para>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <para>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive Default: uid

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </para>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </listitem>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </varlistentry>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <varlistentry>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <term>ldap_user_uid_number (string)</term>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <listitem>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd The LDAP attribute that corresponds to the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive user's id.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd Default: uidNumber

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_user_gid_number (string)</term>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The LDAP attribute that corresponds to the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive user's primary group id.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Default: gidNumber

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

39926890ef5576499f1bd78a1412b43e79f2f694slive

9effaa6977a494fc6477fed772df0377b65db169nd <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_user_gecos (string)</term>

39926890ef5576499f1bd78a1412b43e79f2f694slive <listitem>

39926890ef5576499f1bd78a1412b43e79f2f694slive <para>

58842e03db54033d15cc224d997f467abc88a97aslive The LDAP attribute that corresponds to the

9effaa6977a494fc6477fed772df0377b65db169nd user's gecos field.

9effaa6977a494fc6477fed772df0377b65db169nd </para>

9effaa6977a494fc6477fed772df0377b65db169nd <para>

9effaa6977a494fc6477fed772df0377b65db169nd Default: gecos

9effaa6977a494fc6477fed772df0377b65db169nd </para>

9effaa6977a494fc6477fed772df0377b65db169nd </listitem>

9effaa6977a494fc6477fed772df0377b65db169nd </varlistentry>

9effaa6977a494fc6477fed772df0377b65db169nd

9effaa6977a494fc6477fed772df0377b65db169nd <varlistentry>

9effaa6977a494fc6477fed772df0377b65db169nd <term>ldap_user_home_directory (string)</term>

9effaa6977a494fc6477fed772df0377b65db169nd <listitem>

9effaa6977a494fc6477fed772df0377b65db169nd <para>

9effaa6977a494fc6477fed772df0377b65db169nd The LDAP attribute that contains the name of the user's

9effaa6977a494fc6477fed772df0377b65db169nd home directory.

9effaa6977a494fc6477fed772df0377b65db169nd </para>

58842e03db54033d15cc224d997f467abc88a97aslive <para>

39926890ef5576499f1bd78a1412b43e79f2f694slive Default: homeDirectory

87ea898bcffe2ef490e833dc246a1cc0465d783fslive </para>

39926890ef5576499f1bd78a1412b43e79f2f694slive </listitem>

39926890ef5576499f1bd78a1412b43e79f2f694slive </varlistentry>

46d1ef8cb385aa2f519ce7d355afc51f144bd938slive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_user_shell (string)</term>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The LDAP attribute that contains the path to the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive user's default shell.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Default: loginShell

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_user_objectsid (string)</term>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The LDAP attribute that contains the objectSID of

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive an LDAP user object. This is usually only

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive necessary for ActiveDirectory servers.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Default: objectSid for ActiveDirectory, not set

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive for other servers.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_user_modify_timestamp (string)</term>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The LDAP attribute that contains timestamp of the

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive last modification of the parent object.

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd Default: modifyTimestamp

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </para>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </listitem>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd </varlistentry>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <varlistentry>

97d4d9527b64d7491543a12a3d21134b857cbe4bnd <term>ldap_user_shadow_last_change (string)</term>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>

0097a4f3e468c0192a2ce52ffee7bc8cea0a620bslive When using ldap_pwd_policy=shadow, this parameter

0097a4f3e468c0192a2ce52ffee7bc8cea0a620bslive contains the name of an LDAP attribute corresponding

0097a4f3e468c0192a2ce52ffee7bc8cea0a620bslive to its

0097a4f3e468c0192a2ce52ffee7bc8cea0a620bslive <citerefentry>

0097a4f3e468c0192a2ce52ffee7bc8cea0a620bslive <refentrytitle>shadow</refentrytitle>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <manvolnum>5</manvolnum>

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </citerefentry> counterpart (date of the last

3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive password change).

a7835c7a8cf86045fdaee65dc2839bfe6314fb1end </para>

<para>

Default: shadowLastChange

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_shadow_min (string)</term>

<listitem>

<para>

When using ldap_pwd_policy=shadow, this parameter

contains the name of an LDAP attribute corresponding

to its

<citerefentry>

<refentrytitle>shadow</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> counterpart (minimum password age).

</para>

<para>

Default: shadowMin

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_shadow_max (string)</term>

<listitem>

<para>

When using ldap_pwd_policy=shadow, this parameter

contains the name of an LDAP attribute corresponding

to its

<citerefentry>

<refentrytitle>shadow</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> counterpart (maximum password age).

</para>

<para>

Default: shadowMax

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_shadow_warning (string)</term>

<listitem>

<para>

When using ldap_pwd_policy=shadow, this parameter

contains the name of an LDAP attribute corresponding

to its

<citerefentry>

<refentrytitle>shadow</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> counterpart (password warning

period).

</para>

<para>

Default: shadowWarning

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_shadow_inactive (string)</term>

<listitem>

<para>

When using ldap_pwd_policy=shadow, this parameter

contains the name of an LDAP attribute corresponding

to its

<citerefentry>

<refentrytitle>shadow</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> counterpart (password inactivity

period).

</para>

<para>

Default: shadowInactive

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_shadow_expire (string)</term>

<listitem>

<para>

When using ldap_pwd_policy=shadow or

ldap_account_expire_policy=shadow, this parameter

contains the name of an LDAP attribute corresponding

to its

<citerefentry>

<refentrytitle>shadow</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> counterpart (account expiration date).

</para>

<para>

Default: shadowExpire

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_krb_last_pwd_change (string)</term>

<listitem>

<para>

When using ldap_pwd_policy=mit_kerberos, this

parameter contains the name of an LDAP attribute

storing the date and time of last password change

in kerberos.

</para>

<para>

Default: krbLastPwdChange

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_krb_password_expiration (string)</term>

<listitem>

<para>

When using ldap_pwd_policy=mit_kerberos, this

parameter contains the name of an LDAP attribute

storing the date and time when current password

expires.

</para>

<para>

Default: krbPasswordExpiration

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_ad_account_expires (string)</term>

<listitem>

<para>

When using ldap_account_expire_policy=ad, this

parameter contains the name of an LDAP attribute

storing the expiration time of the account.

</para>

<para>

Default: accountExpires

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_ad_user_account_control (string)</term>

<listitem>

<para>

When using ldap_account_expire_policy=ad, this

parameter contains the name of an LDAP attribute

storing the user account control bit field.

</para>

<para>

Default: userAccountControl

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_ns_account_lock (string)</term>

<listitem>

<para>

When using ldap_account_expire_policy=rhds or

equivalent, this parameter determines if access is

allowed or not.

</para>

<para>

Default: nsAccountLock

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_nds_login_disabled (string)</term>

<listitem>

<para>

When using ldap_account_expire_policy=nds, this

attribute determines if access is allowed or not.

</para>

<para>

Default: loginDisabled

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_nds_login_expiration_time (string)</term>

<listitem>

<para>

When using ldap_account_expire_policy=nds, this

attribute determines until which date access is

granted.

</para>

<para>

Default: loginDisabled

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_nds_login_allowed_time_map (string)</term>

<listitem>

<para>

When using ldap_account_expire_policy=nds, this

attribute determines the hours of a day in a week

when access is granted.

</para>

<para>

Default: loginAllowedTimeMap

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_principal (string)</term>

<listitem>

<para>

The LDAP attribute that contains the user's Kerberos

User Principal Name (UPN).

</para>

<para>

Default: krbPrincipalName

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_extra_attrs (string)</term>

<listitem>

<para>

Comma-separated list of LDAP attributes that SSSD

would fetch along with the usual set of user

attributes.

</para>

<para>

The list can either contain LDAP attribute names

only, or colon-separated tuples of SSSD cache

attribute name and LDAP attribute name. In

case only LDAP attribute name is specified,

the attribute is saved to the cache verbatim.

Using a custom SSSD attribute name might be

required by environments that configure several

SSSD domains with different LDAP schemas.

</para>

<para>

Please note that several attribute names are

reserved by SSSD, notably the <quote>name</quote>

attribute. SSSD would report an error if any of

the reserved attribute names is used as an extra

attribute name.

</para>

<para>

Examples:

</para>

<para>

ldap_user_extra_attrs = telephoneNumber

</para>

<para>

Save the <quote>telephoneNumber</quote> attribute from LDAP

as <quote>telephoneNumber</quote> to the cache.

</para>

<para>

ldap_user_extra_attrs = phone:telephoneNumber

</para>

<para>

Save the <quote>telephoneNumber</quote> attribute from LDAP

as <quote>phone</quote> to the cache.

</para>

<para>

Default: not set

</para>

</listitem>

</varlistentry>

<varlistentry condition="with_ssh">

<term>ldap_user_ssh_public_key (string)</term>

<listitem>

<para>

The LDAP attribute that contains the user's SSH

public keys.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_force_upper_case_realm (boolean)</term>

<listitem>

<para>

Some directory servers, for example Active Directory,

might deliver the realm part of the UPN in lower case,

which might cause the authentication to fail. Set this

option to a non-zero value if you want to use an

upper-case realm.

</para>

<para>

Default: false

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_enumeration_refresh_timeout (integer)</term>

<listitem>

<para>

Specifies how many seconds SSSD has to wait

before refreshing its cache of enumerated

records.

</para>

<para>

Default: 300

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_purge_cache_timeout (integer)</term>

<listitem>

<para>

Determine how often to check the cache for

inactive entries (such as groups with no

members and users who have never logged in) and

remove them to save space.

</para>

<para>

Setting this option to zero will disable the

cache cleanup operation.

</para>

<para>

Default: 10800 (12 hours)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_fullname (string)</term>

<listitem>

<para>

The LDAP attribute that corresponds to the

user's full name.

</para>

<para>

Default: cn

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_member_of (string)</term>

<listitem>

<para>

The LDAP attribute that lists the user's

group memberships.

</para>

<para>

Default: memberOf

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_authorized_service (string)</term>

<listitem>

<para>

If access_provider=ldap and

ldap_access_order=authorized_service, SSSD will

use the presence of the authorizedService

attribute in the user's LDAP entry to determine

access privilege.

</para>

<para>

An explicit deny (!svc) is resolved first. Second,

SSSD searches for explicit allow (svc) and finally

for allow_all (*).

</para>

<para>

Please note that the ldap_access_order

configuration option <emphasis>must</emphasis> include

<quote>authorized_service</quote> in order for the

ldap_user_authorized_service option

to work.

</para>

<para>

Default: authorizedService

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_user_authorized_host (string)</term>

<listitem>

<para>

If access_provider=ldap and

ldap_access_order=host, SSSD will use the presence

of the host attribute in the user's LDAP entry to

determine access privilege.

</para>

<para>

An explicit deny (!host) is resolved first. Second,

SSSD searches for explicit allow (host) and finally

for allow_all (*).

</para>

<para>

Please note that the ldap_access_order

configuration option <emphasis>must</emphasis>

include <quote>host</quote> in order for the

ldap_user_authorized_host option

to work.

</para>

<para>

Default: host

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_object_class (string)</term>

<listitem>

<para>

The object class of a group entry in LDAP.

</para>

<para>

Default: posixGroup

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_name (string)</term>

<listitem>

<para>

The LDAP attribute that corresponds to

the group name.

</para>

<para>

Default: cn

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_gid_number (string)</term>

<listitem>

<para>

The LDAP attribute that corresponds to the

group's id.

</para>

<para>

Default: gidNumber

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_member (string)</term>

<listitem>

<para>

The LDAP attribute that contains the names of

the group's members.

</para>

<para>

Default: memberuid (rfc2307) / member (rfc2307bis)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_objectsid (string)</term>

<listitem>

<para>

The LDAP attribute that contains the objectSID of

an LDAP group object. This is usually only

necessary for ActiveDirectory servers.

</para>

<para>

Default: objectSid for ActiveDirectory, not set

for other servers.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_modify_timestamp (string)</term>

<listitem>

<para>

The LDAP attribute that contains timestamp of the

last modification of the parent object.

</para>

<para>

Default: modifyTimestamp

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_type (integer)</term>

<listitem>

<para>

The LDAP attribute that contains an integer value

indicating the type of the group and maybe other

flags.

</para>

<para>

This attribute is currently only used by the AD

provider to determine if a group is a domain local

groups and has to be filtered out for trusted

domains.

</para>

<para>

Default: groupType in the AD provider, othewise not

set

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_group_nesting_level (integer)</term>

<listitem>

<para>

If ldap_schema is set to a schema format that

supports nested groups (e.g. RFC2307bis), then

this option controls how many levels of nesting

SSSD will follow. This option has no effect on the

RFC2307 schema.

</para>

<para>

Note: This option specifies the guaranteed level of

nested groups to be processed for any lookup. However,

nested groups beyond this limit

<emphasis>may be</emphasis> returned if previous

lookups already resolved the deeper nesting levels.

Also, subsequent lookups for other groups may enlarge

the result set for original lookup if re-queried.

</para>

<para>

If ldap_group_nesting_level is set to 0 then no

nested groups are processed at all. However, when

connected to Active-Directory Server 2008 and later

it is furthermore required to disable usage of

Token-Groups by setting ldap_use_tokengroups to false.

</para>

<para>

Default: 2

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_groups_use_matching_rule_in_chain</term>

<listitem>

<para>

This option tells SSSD to take advantage of an

Active Directory-specific feature which may speed

up group lookup operations on deployments with

complex or deep nested groups.

</para>

<para>

In most common cases, it is best to leave this

option disabled. It generally only provides a

performance increase on very complex nestings.

</para>

<para>

If this option is enabled, SSSD will use it if it

detects that the server supports it during initial

connection. So "True" here essentially means

"auto-detect".

</para>

<para>

Note: This feature is currently known to work only

with Active Directory 2008 R1 and later. See

<ulink url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa746475%28v=vs.85%29.aspx">

MSDN(TM) documentation</ulink> for more details.

</para>

<para>

Default: False

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_initgroups_use_matching_rule_in_chain</term>

<listitem>

<para>

This option tells SSSD to take advantage of an

Active Directory-specific feature which might speed

up initgroups operations (most notably when

dealing with complex or deep nested groups).

</para>

<para>

If this option is enabled, SSSD will use it if it

detects that the server supports it during initial

connection. So "True" here essentially means

"auto-detect".

</para>

<para>

Note: This feature is currently known to work only

with Active Directory 2008 R1 and later. See

<ulink url="http://msdn.microsoft.com/en-us/library/windows/desktop/aa746475%28v=vs.85%29.aspx">

MSDN(TM) documentation</ulink> for more details.

</para>

<para>

Default: False

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_use_tokengroups</term>

<listitem>

<para>

This options enables or disables use of Token-Groups

attribute when performing initgroup for users from

Active Directory Server 2008 and later.

</para>

<para>

Default: True

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_netgroup_object_class (string)</term>

<listitem>

<para>

The object class of a netgroup entry in LDAP.

</para>

<para>

In IPA provider, ipa_netgroup_object_class should

be used instead.

</para>

<para>

Default: nisNetgroup

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_netgroup_name (string)</term>

<listitem>

<para>

The LDAP attribute that corresponds to

the netgroup name.

</para>

<para>

In IPA provider, ipa_netgroup_name should

be used instead.

</para>

<para>

Default: cn

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_netgroup_member (string)</term>

<listitem>

<para>

The LDAP attribute that contains the names of

the netgroup's members.

</para>

<para>

In IPA provider, ipa_netgroup_member should

be used instead.

</para>

<para>

Default: memberNisNetgroup

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_netgroup_triple (string)</term>

<listitem>

<para>

The LDAP attribute that contains the (host, user,

domain) netgroup triples.

</para>

<para>

This option is not available in IPA provider.

</para>

<para>

Default: nisNetgroupTriple

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_netgroup_modify_timestamp (string)</term>

<listitem>

<para>

The LDAP attribute that contains timestamp of the

last modification of the parent object.

</para>

<para>

This option is not available in IPA provider.

</para>

<para>

Default: modifyTimestamp

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_service_object_class (string)</term>

<listitem>

<para>

The object class of a service entry in LDAP.

</para>

<para>

Default: ipService

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_service_name (string)</term>

<listitem>

<para>

The LDAP attribute that contains the name of

service attributes and their aliases.

</para>

<para>

Default: cn

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_service_port (string)</term>

<listitem>

<para>

The LDAP attribute that contains the port managed

by this service.

</para>

<para>

Default: ipServicePort

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_service_proto (string)</term>

<listitem>

<para>

The LDAP attribute that contains the protocols

understood by this service.

</para>

<para>

Default: ipServiceProtocol

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_service_search_base (string)</term>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/ldap_search_bases.xml" />

</varlistentry>

<varlistentry>

<term>ldap_search_timeout (integer)</term>

<listitem>

<para>

Specifies the timeout (in seconds) that ldap

searches are allowed to run before they are

cancelled and cached results are returned (and

offline mode is entered)

</para>

<para>

Note: this option is subject to change in future

versions of the SSSD. It will likely be replaced at

some point by a series of timeouts for specific

lookup types.

</para>

<para>

Default: 6

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_enumeration_search_timeout (integer)</term>

<listitem>

<para>

Specifies the timeout (in seconds) that ldap

searches for user and group enumerations

are allowed to run before they are cancelled and

cached results are returned (and offline mode is

entered)

</para>

<para>

Default: 60

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_network_timeout (integer)</term>

<listitem>

<para>

Specifies the timeout (in seconds) after which

the

<citerefentry>

<refentrytitle>poll</refentrytitle>

<manvolnum>2</manvolnum>

</citerefentry>/<citerefentry>

<refentrytitle>select</refentrytitle>

<manvolnum>2</manvolnum>

</citerefentry>

following a

<citerefentry>

<refentrytitle>connect</refentrytitle>

<manvolnum>2</manvolnum>

</citerefentry>

returns in case of no activity.

</para>

<para>

Default: 6

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_opt_timeout (integer)</term>

<listitem>

<para>

Specifies a timeout (in seconds) after which

calls to synchronous LDAP APIs will abort if no

response is received. Also controls the timeout

when communicating with the KDC in case of SASL bind.

</para>

<para>

Default: 6

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_connection_expire_timeout (integer)</term>

<listitem>

<para>

Specifies a timeout (in seconds) that a connection

to an LDAP server will be maintained. After this

time, the connection will be re-established. If

used in parallel with SASL/GSSAPI, the sooner of

the two values (this value vs. the TGT lifetime)

will be used.

</para>

<para>

Default: 900 (15 minutes)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_page_size (integer)</term>

<listitem>

<para>

Specify the number of records to retrieve from

LDAP in a single request. Some LDAP servers

enforce a maximum limit per-request.

</para>

<para>

Default: 1000

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_disable_paging (boolean)</term>

<listitem>

<para>

Disable the LDAP paging control. This option

should be used if the LDAP server reports that it

supports the LDAP paging control in its RootDSE

but it is not enabled or does not behave properly.

</para>

<para>

Example: OpenLDAP servers with the paging control

module installed on the server but not enabled

will report it in the RootDSE but be unable to use

it.

</para>

<para>

Example: 389 DS has a bug where it can only

support a one paging control at a time on a single

connection. On busy clients, this can result in

some requests being denied.

</para>

<para>

Default: False

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_disable_range_retrieval (boolean)</term>

<listitem>

<para>

Disable Active Directory range retrieval.

</para>

<para>

Active Directory limits the number of members to be

retrieved in a single lookup using the MaxValRange

policy (which defaults to 1500 members). If a group

contains more members, the reply would include an

AD-specific range extension. This option disables

parsing of the range extension, therefore large

groups will appear as having no members.

</para>

<para>

Default: False

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_sasl_minssf (integer)</term>

<listitem>

<para>

When communicating with an LDAP server using SASL,

specify the minimum security level necessary to

establish the connection. The values of this

option are defined by OpenLDAP.

</para>

<para>

Default: Use the system default (usually specified

by ldap.conf)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_deref_threshold (integer)</term>

<listitem>

<para>

Specify the number of group members that must be

missing from the internal cache in order to trigger

a dereference lookup. If less members are missing,

they are looked up individually.

</para>

<para>

You can turn off dereference lookups completely by

setting the value to 0.

</para>

<para>

A dereference lookup is a means of fetching all

group members in a single LDAP call.

Different LDAP servers may implement different

dereference methods. The currently supported

servers are 389/RHDS, OpenLDAP and Active

Directory.

</para>

<para>

<emphasis>Note:</emphasis>

If any of the search bases specifies a search

filter, then the dereference lookup performance

enhancement will be disabled regardless of this

setting.

</para>

<para>

Default: 10

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_tls_reqcert (string)</term>

<listitem>

<para>

Specifies what checks to perform on server

certificates in a TLS session, if any. It

can be specified as one of the following

values:

</para>

<para>

<emphasis>never</emphasis> = The client will

not request or check any server certificate.

</para>

<para>

<emphasis>allow</emphasis> = The server

certificate is requested. If no certificate is

provided, the session proceeds normally. If a

bad certificate is provided, it will be ignored

and the session proceeds normally.

</para>

<para>

<emphasis>try</emphasis> = The server certificate

is requested. If no certificate is provided, the

session proceeds normally. If a bad certificate

is provided, the session is immediately terminated.

</para>

<para>

<emphasis>demand</emphasis> = The server

certificate is requested. If no certificate

is provided, or a bad certificate is provided,

the session is immediately terminated.

</para>

<para>

<emphasis>hard</emphasis> = Same as

<quote>demand</quote>

</para>

<para>

Default: hard

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_tls_cacert (string)</term>

<listitem>

<para>

Specifies the file that contains certificates for

all of the Certificate Authorities that

<command>sssd</command> will recognize.

</para>

<para>

Default: use OpenLDAP defaults, typically in

<filename>/etc/openldap/ldap.conf</filename>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_tls_cacertdir (string)</term>

<listitem>

<para>

Specifies the path of a directory that contains

Certificate Authority certificates in separate

individual files. Typically the file names need to

be the hash of the certificate followed by '.0'.

If available, <command>cacertdir_rehash</command>

can be used to create the correct names.

</para>

<para>

Default: use OpenLDAP defaults, typically in

<filename>/etc/openldap/ldap.conf</filename>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_tls_cert (string)</term>

<listitem>

<para>

Specifies the file that contains the certificate

for the client's key.

</para>

<para>

Default: not set

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_tls_key (string)</term>

<listitem>

<para>

Specifies the file that contains the client's key.

</para>

<para>

Default: not set

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_tls_cipher_suite (string)</term>

<listitem>

<para>

Specifies acceptable cipher suites. Typically this

is a colon sperated list. See

<citerefentry><refentrytitle>ldap.conf</refentrytitle>

<manvolnum>5</manvolnum></citerefentry> for format.

</para>

<para>

Default: use OpenLDAP defaults, typically in

<filename>/etc/openldap/ldap.conf</filename>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_id_use_start_tls (boolean)</term>

<listitem>

<para>

Specifies that the id_provider connection must also

use <systemitem class="protocol">tls</systemitem> to protect the channel.

</para>

<para>

Default: false

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_id_mapping (boolean)</term>

<listitem>

<para>

Specifies that SSSD should attempt to map user and

group IDs from the ldap_user_objectsid and

ldap_group_objectsid attributes instead of relying

on ldap_user_uid_number and ldap_group_gid_number.

</para>

<para>

Currently this feature supports only

ActiveDirectory objectSID mapping.

</para>

<para>

Default: false

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_min_id, ldap_max_id (interger)</term>

<listitem>

<para>

In contrast to the SID based ID mapping which is

used if ldap_id_mapping is set to true the allowed

ID range for ldap_user_uid_number and

ldap_group_gid_number is unbound. In a setup with

sub/trusted-domains this might lead to ID

collisions. To avoid collisions ldap_min_id and

ldap_max_id can be set to restrict the allowed

range for the IDs which are read directly from the

server. Sub-domains can then pick other ranges to

map IDs.

</para>

<para>

Default: not set (both options are set to 0)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_sasl_mech (string)</term>

<listitem>

<para>

Specify the SASL mechanism to use.

Currently only GSSAPI is tested and supported.

</para>

<para>

Default: not set

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_sasl_authid (string)</term>

<listitem>

<para>

Specify the SASL authorization id to use.

When GSSAPI is used, this represents the Kerberos

principal used for authentication to the directory.

This option can either contain the full principal (for

example host/myhost@EXAMPLE.COM) or just the principal name

(for example host/myhost).

</para>

<para>

Default: host/hostname@REALM

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_sasl_realm (string)</term>

<listitem>

<para>

Specify the SASL realm to use. When not specified,

this option defaults to the value of krb5_realm.

If the ldap_sasl_authid contains the realm as well,

this option is ignored.

</para>

<para>

Default: the value of krb5_realm.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_sasl_canonicalize (boolean)</term>

<listitem>

<para>

If set to true, the LDAP library would perform

a reverse lookup to canonicalize the host name

during a SASL bind.

</para>

<para>

Default: false;

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_krb5_keytab (string)</term>

<listitem>

<para>

Specify the keytab to use when using SASL/GSSAPI.

</para>

<para>

Default: System keytab, normally <filename>/etc/krb5.keytab</filename>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_krb5_init_creds (boolean)</term>

<listitem>

<para>

Specifies that the id_provider should init

Kerberos credentials (TGT).

This action is performed only if SASL is used and

the mechanism selected is GSSAPI.

</para>

<para>

Default: true

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ldap_krb5_ticket_lifetime (integer)</term>

<listitem>

<para>

Specifies the lifetime in seconds of the TGT if

GSSAPI is used.

</para>

<para>

Default: 86400 (24 hours)

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>krb5_server, krb5_backup_server (string)</term>

<listitem>

<para>

Specifies the comma-separated list of IP addresses or hostnames

of the Kerberos servers to which SSSD should

connect in the order of preference. For more

information on failover and server redundancy,

see the <quote>FAILOVER</quote> section. An optional

port number (preceded by a colon) may be appended to

the addresses or hostnames.

If empty, service discovery is enabled -

for more information, refer to the

<quote>SERVICE DISCOVERY</quote> section.

</para>

<para>

When using service discovery for KDC or kpasswd servers,

SSSD first searches for DNS entries that specify _udp as

the protocol and falls back to _tcp if none are found.

</para>

<para>

This option was named <quote>krb5_kdcip</quote> in

earlier releases of SSSD. While the legacy name is recognized

for the time being, users are advised to migrate their config

files to use <quote>krb5_server</quote> instead.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>krb5_realm (string)</term>

<listitem>

<para>

Specify the Kerberos REALM (for SASL/GSSAPI auth).

</para>

<para>

Default: System defaults, see <filename>/etc/krb5.conf</filename>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>krb5_canonicalize (boolean)</term>

<listitem>

<para>

Specifies if the host principal should be canonicalized

when connecting to LDAP server. This feature is

available with MIT Kerberos >= 1.7

</para>

<para>

Default: false

</para>

</listitem>