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

ldap[s]://<host>[:port]

For explicit IPv6 addresses, <host> must be enclosed in brackets []

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

To enable service discovery ldap_chpass_dns_service_name must be set.

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

Starting with SSSD 1.7.0, SSSD supports multiple search bases using the syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

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

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

Examples:

ldap_search_base = dc=example,dc=com (which is equivalent to) ldap_search_base = dc=example,dc=com?subtree?

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

Note: It is unsupported to have multiple search bases which reference identically-named objects (for example, groups with the same name in two different search bases). This will lead to unpredictable behavior on client machines.

Default: If not set, the value of the defaultNamingContext or namingContexts attribute from the RootDSE of the LDAP server is used. If defaultNamingContext does not exist or has an empty value namingContexts is used. The namingContexts attribute must have a single value with the DN of the search base of the LDAP server to make this work. Multiple values are are not supported.

Four schema types are currently supported:

The main difference between these schema types is how group memberships are recorded in the server. With rfc2307, group members are listed by name in the memberUid attribute. With rfc2307bis and IPA, group members are listed by DN and stored in the member attribute. The AD schema type sets the attributes to correspond with Active Directory 2008r2 values.

Default: rfc2307

Two modes are currently supported:

Note: First, a new connection is established to verify current password by binding as the user that requested password change. If successful, this connection is used to change the password therefore the user must have write access to userPassword attribute.

Default: exop

The two mechanisms currently supported are:

password

obfuscated_password

Default: password

See the sss_obfuscate(8) manual page for more information.

Default: false

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 300

Setting this option to zero will disable the cache cleanup operation. Please note that if enumeration is enabled, the cleanup task is required in order to detect entries removed from the server and can't be disabled. By default, the cleanup task will run every 3 hours with enumeration enabled.

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 0 (disabled)

Note: This option specifies the guaranteed level of nested groups to be processed for any lookup. However, nested groups beyond this limit may be 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.

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 using “id_provider=ad” it is furthermore required to disable usage of Token-Groups by setting ldap_use_tokengroups to false in order to restrict group nesting.

Default: 2

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: True for AD and IPA otherwise False.

See “ldap_search_base” for information about configuring multiple search bases.

Default: the value of ldap_search_base

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

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.

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 6

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 60

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 6

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 8

If the connection is idle (not actively running an operation) within ldap_opt_timeout seconds of expiration, then it will be closed early to ensure that a new query cannot require the connection to remain open past its expiration. This implies that connections will always be closed immediately and will never be reused if ldap_connection_expire_timeout <= ldap_opt_timout

This timeout can be extended of a random value specified by ldap_connection_expire_offset

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 900 (15 minutes)

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 0

You can disable this timeout by setting the value to 0.

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 900 (15 minutes)

Default: 1000

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.

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.

Default: False

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.

Default: False

Default: Use the system default (usually specified by ldap.conf)

Default: Use the system default (usually specified by ldap.conf)

You can turn off dereference lookups completely by setting the value to 0. Please note that there are some codepaths in SSSD, like the IPA HBAC provider, that are only implemented using the dereference call, so even with dereference explicitly disabled, those parts will still use dereference if the server supports it and advertises the dereference control in the rootDSE object.

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.

Note: If any of the search bases specifies a search filter, then the dereference lookup performance enhancement will be disabled regardless of this setting.

Default: 10

This parameter may be useful when using the AD provider and the computer account that sssd uses to connect to AD does not have access to a particular entry or LDAP sub-tree for security reasons.

Default: False

never = The client will not request or check any server certificate.

allow = 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.

try = 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.

demand = The server certificate is requested. If no certificate is provided, or a bad certificate is provided, the session is immediately terminated.

hard = Same as “demand”

Default: hard

Default: use OpenLDAP defaults, typically in /etc/openldap/ldap.conf

Default: use OpenLDAP defaults, typically in /etc/openldap/ldap.conf

Default: not set

Default: not set

Default: use OpenLDAP defaults, typically in /etc/openldap/ldap.conf

Default: false

Currently this feature supports only ActiveDirectory objectSID mapping.

Default: false

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

If the backend supports sub-domains the value of ldap_sasl_mech is automatically inherited to the sub-domains. If a different value is needed for a sub-domain it can be overwritten by setting ldap_sasl_mech for this sub-domain explicitly. Please see TRUSTED DOMAIN SECTION in sssd.conf(5) for details.

Default: not set

hostname@REALM
netbiosname$@REALM
host/hostname@REALM
*$@REALM
host/*@REALM
host/*


                            

If none of them are found, the first principal in keytab is returned.

Default: host/hostname@REALM

Default: the value of krb5_realm.

Default: false;

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: System keytab, normally /etc/krb5.keytab

Default: true

This option can be also set per subdomain or inherited via subdomain_inherit.

Default: 86400 (24 hours)

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.

This option was named “krb5_kdcip” 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 “krb5_server” instead.

Default: System defaults, see /etc/krb5.conf

Default: false

See the sssd_krb5_locator_plugin(8) manual page for more information on the locator plugin.

Default: true

none - No evaluation on the client side. This option cannot disable server-side password policies.

shadow - Use shadow(5) style attributes to evaluate if the password has expired. Please see option "ldap_chpass_update_last_change" as well.

mit_kerberos - Use the attributes used by MIT Kerberos to determine if the password has expired. Use chpass_provider=krb5 to update these attributes when the password is changed.

Default: none

Note: if a password policy is configured on server side, it always takes precedence over policy set with this option.

Please note that sssd only supports referral chasing when it is compiled with OpenLDAP version 2.4.13 or higher.

Chasing referrals may incur a performance penalty in environments that use them heavily, a notable example is Microsoft Active Directory. If your setup does not in fact require the use of referrals, setting this option to false might bring a noticeable performance improvement. Setting this option to false is therefore recommended in case the SSSD LDAP provider is used together with Microsoft Active Directory as a backend. Even if SSSD would be able to follow the referral to a different AD DC no additional data would be available.

Default: true

Default: ldap

Default: not set, i.e. service discovery is disabled

It is recommend to set this option explicitly if "ldap_pwd_policy = shadow" is used to let SSSD know if the LDAP server will update shadowLastChange LDAP attribute automatically after a password change or if SSSD has to update it.

Default: False

Example:

access_provider = ldap
ldap_access_filter = (employeeType=admin)


                        

This example means that access to this host is restricted to users whose employeeType attribute is set to "admin".

Offline caching for this feature is limited to determining whether the user's last online login was granted access permission. If they were granted access during their last login, they will continue to be granted access while offline and vice versa.

Default: Empty

Please note that it is always recommended to use server side access control, i.e. the LDAP server should deny the bind request with a suitable error code even if the password is correct.

The following values are allowed:

shadow: use the value of ldap_user_shadow_expire to determine if the account is expired.

ad: use the value of the 32bit field ldap_user_ad_user_account_control and allow access if the second bit is not set. If the attribute is missing access is granted. Also the expiration time of the account is checked.

rhds, ipa, 389ds: use the value of ldap_ns_account_lock to check if access is allowed or not.

nds: the values of ldap_user_nds_login_allowed_time_map, ldap_user_nds_login_disabled and ldap_user_nds_login_expiration_time are used to check if access is allowed. If both attributes are missing access is granted.

Please note that the ldap_access_order configuration option must include “expire” in order for the ldap_account_expire_policy option to work.

Default: Empty

filter: use ldap_access_filter

lockout: use account locking. If set, this option denies access in case that ldap attribute 'pwdAccountLockedTime' is present and has value of '000001010000Z'. Please see the option ldap_pwdlockout_dn. Please note that 'access_provider = ldap' must be set for this feature to work.

Please note that this option is superseded by the “ppolicy” option and might be removed in a future release.

ppolicy: use account locking. If set, this option denies access in case that ldap attribute 'pwdAccountLockedTime' is present and has value of '000001010000Z' or represents any time in the past. The value of the 'pwdAccountLockedTime' attribute must end with 'Z', which denotes the UTC time zone. Other time zones are not currently supported and will result in "access-denied" when users attempt to log in. Please see the option ldap_pwdlockout_dn. Please note that 'access_provider = ldap' must be set for this feature to work.

expire: use ldap_account_expire_policy

pwd_expire_policy_reject, pwd_expire_policy_warn, pwd_expire_policy_renew: These options are useful if users are interested in being warned that password is about to expire and authentication is based on using a different method than passwords - for example SSH keys.

The difference between these options is the action taken if user password is expired:

Please note that 'access_provider = ldap' must be set for this feature to work. Also 'ldap_pwd_policy' must be set to an appropriate password policy.

authorized_service: use the authorizedService attribute to determine access

host: use the host attribute to determine access

rhost: use the rhost attribute to determine whether remote host can access

Please note, rhost field in pam is set by application, it is better to check what the application sends to pam, before enabling this access control option

Default: filter

Please note that it is a configuration error if a value is used more than once.

Example: cn=ppolicy,ou=policies,dc=example,dc=com

Default: cn=ppolicy,ou=policies,$ldap_search_base

never: Aliases are never dereferenced.

searching: Aliases are dereferenced in subordinates of the base object, but not in locating the base object of the search.

finding: Aliases are only dereferenced when locating the base object of the search.

always: Aliases are dereferenced both in searching and in locating the base object of the search.

Default: Empty (this is handled as never by the LDAP client libraries)

In some environments where the RFC2307 schema is used, local users are made members of LDAP groups by adding their names to the memberUid attribute. The self-consistency of the domain is compromised when this is done, so SSSD would normally remove the "missing" users from the cached group memberships as soon as nsswitch tries to fetch information about the user via getpw*() or initgroups() calls.

This option falls back to checking if local users are referenced, and caches them so that later initgroups() calls will augment the local users with the additional LDAP groups.

Default: false

At the moment, only the InfoPipe responder supports wildcard lookups.

Default: 1000 (often the size of one page)

OpenLDAP uses a bitmap to enable debugging for specific components, -1 will enable full debug output.

Default: 0 (libldap debugging disabled)

The value must be greater than ldap_sudo_smart_refresh_interval

You can disable full refresh by setting this option to 0. However, either smart or full refresh must be enabled.

Default: 21600 (6 hours)

If USN attributes are not supported by the server, the modifyTimestamp attribute is used instead.

Note: the highest USN value can be updated by three tasks: 1) By sudo full and smart refresh (if updated rules are found), 2) by enumeration of users and groups (if enabled and updated users or groups are found) and 3) by reconnecting to the server (by default every 15 minutes, see ldap_connection_expire_timeout).

You can disable smart refresh by setting this option to 0. However, either smart or full refresh must be enabled.

Default: 900 (15 minutes)

Note that this random offset is also applied on the first SSSD start which delays the first sudo rules refresh. This prolongs the time when the sudo rules are not available for use.

You can disable this offset by setting the value to 0.

Default: 0 (disabled)

Default: true

If this option is empty, SSSD will try to discover the hostname and the fully qualified domain name automatically.

If ldap_sudo_use_host_filter is false then this option has no effect.

Default: not specified

If this option is empty, SSSD will try to discover the addresses automatically.

If ldap_sudo_use_host_filter is false then this option has no effect.

Default: not specified

If ldap_sudo_use_host_filter is false then this option has no effect.

Default: true

If ldap_sudo_use_host_filter is false then this option has no effect.

Default: auto.master

Default: nisMap (rfc2307, autofs_provider=ad), otherwise automountMap

Default: nisMapName (rfc2307, autofs_provider=ad), otherwise automountMapName

Default: nisObject (rfc2307, autofs_provider=ad), otherwise automount

Default: cn (rfc2307, autofs_provider=ad), otherwise automountKey

Default: nisMapEntry (rfc2307, autofs_provider=ad), otherwise automountInformation

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

If the option “ldap_use_tokengroups” is enabled, the searches against Active Directory will not be restricted and return all groups memberships, even with no GID mapping. It is recommended to disable this feature, if group names are not being displayed correctly.

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

syntax:

search_base[?scope?[filter][?search_base?scope?[filter]]*]

The scope can be one of "base", "onelevel" or "subtree". The scope functions as specified in section 4.5.1.2 of http://tools.ietf.org/html/rfc4511

The filter must be a valid LDAP search filter as specified by http://www.ietf.org/rfc/rfc2254.txt

For examples of this syntax, please refer to the “ldap_search_base” examples section.

Default: the value of ldap_search_base

Please note that specifying scope or filter is not supported for searches against an Active Directory Server that might yield a large number of results and trigger the Range Retrieval extension in the response.

[domain/LDAP]
id_provider = ldap
auth_provider = ldap
ldap_uri = ldap://ldap.mydomain.org
ldap_search_base = dc=mydomain,dc=org
ldap_tls_reqcert = demand
cache_credentials = true

[domain/LDAP]
id_provider = ldap
auth_provider = ldap
access_provider = ldap
ldap_access_order = lockout
ldap_pwdlockout_dn = cn=ppolicy,ou=policies,dc=mydomain,dc=org
ldap_uri = ldap://ldap.mydomain.org
ldap_search_base = dc=mydomain,dc=org
ldap_tls_reqcert = demand
cache_credentials = true