sssd-ldap.5.xml revision 173f557c915aeee80a0c3dc8ae4d3f44dd5bc7c9
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive<?xml version="1.0" encoding="UTF-8"?>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive<reference>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive<title>SSSD Manual pages</title>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive<refentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refmeta>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refentrytitle>sssd-ldap</refentrytitle>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <manvolnum>5</manvolnum>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </refmeta>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refnamediv id='name'>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refname>sssd-ldap</refname>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <refpurpose>the configuration file for SSSD</refpurpose>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </refnamediv>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
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='file-format'>
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 (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 not specified, service discovery is enabled. For more information, refer
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive to the <quote>SERVICE DISCOVERY</quote> section.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The format of the URI must match the format defined in RFC 2732:
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive ldap[s]://&lt;host&gt;[:port]
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive For explicit IPv6 addresses, &lt;host&gt; must be enclosed in brackets []
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive example: ldap://[fc00::126:25]:389
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_chpass_uri (string)</term>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive 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
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <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.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Default: empty, i.e. ldap_uri is used.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_search_base (string)</term>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The default base DN to use for
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive performing LDAP user operations.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </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>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive The scope can be one of "base", "onelevel" or "subtree".
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive </para>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The filter must be a valid LDAP search filter as
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive specified by http://www.ietf.org/rfc/rfc2254.txt
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Examples:
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive ldap_search_base = dc=example,dc=com
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive (which is equivalent to)
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive ldap_search_base = dc=example,dc=com?subtree?
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive </para>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <para>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive ldap_search_base = cn=host_specific,dc=example,dc=com?subtree?(host=thishost)?dc=example.com?subtree?
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive </para>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <para>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive Note: It is unsupported to have multiple search
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive bases which reference identically-named objects
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive (for example, groups with the same name in two
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive different search bases). This will lead to
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive unpredictable behavior on client machines.
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive </para>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive <para>
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive Default: If not set, the value of the
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive defaultNamingContext or namingContexts attribute
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive from the RootDSE of the LDAP server is
04ff03c2d7e0ff45ee181eb1fa5bf7649ffcf6bfslive used. If defaultNamingContext does not exists or
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive has an empty value namingContexts is used.
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive The namingContexts attribute must have a
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive single value with the DN of the search base of the
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive LDAP server to make this work. Multiple values are
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive are not supported.
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </para>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </listitem>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive </varlistentry>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <varlistentry>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <term>ldap_schema (string)</term>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <listitem>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <para>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive Specifies the Schema Type in use on the target LDAP
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive server.
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive Depending on the selected schema, the default
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive attribute names retrieved from the servers may vary.
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive The way that some attributes are handled may also differ.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Three schema types are currently supported:
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive rfc2307
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive rfc2307bis
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive IPA
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The main difference between these schema types is
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive how group memberships are recorded in the server.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive With rfc2307, group members are listed by name in the
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <emphasis>memberUid</emphasis> attribute.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive With rfc2307bis and IPA, group members are listed by DN
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive and stored in the <emphasis>member</emphasis> attribute.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Default: rfc2307
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <varlistentry>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <term>ldap_default_bind_dn (string)</term>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The default bind DN to use for
46d1ef8cb385aa2f519ce7d355afc51f144bd938slive performing LDAP operations.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_default_authtok_type (string)</term>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The type of the authentication token of the
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive default bind DN.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The two mechanisms currently supported are:
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive password
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive obfuscated_password
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Default: password
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_default_authtok (string)</term>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The authentication token of the default bind DN.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Only clear text passwords are currently supported.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <varlistentry>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <term>ldap_user_object_class (string)</term>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <listitem>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive The object class of a user entry in LDAP.
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive <para>
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive Default: posixAccount
3fa58e00171aebf3b2cfa90035ed530f5b1f651dslive </para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_name (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
user's login name.
</para>
<para>
Default: uid
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_uid_number (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
user's id.
</para>
<para>
Default: uidNumber
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_gid_number (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
user's primary group id.
</para>
<para>
Default: gidNumber
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_gecos (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
user's gecos field.
</para>
<para>
Default: gecos
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_home_directory (string)</term>
<listitem>
<para>
The LDAP attribute that contains the name of the user's
home directory.
</para>
<para>
Default: homeDirectory
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_shell (string)</term>
<listitem>
<para>
The LDAP attribute that contains the path to the
user's default shell.
</para>
<para>
Default: loginShell
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_uuid (string)</term>
<listitem>
<para>
The LDAP attribute that contains the UUID/GUID of
an LDAP user object.
</para>
<para>
Default: nsUniqueId
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_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_user_shadow_last_change (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 (date of the last
password change).
</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_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>
The LDAP attribute that contains 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</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>
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>
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_uuid (string)</term>
<listitem>
<para>
The LDAP attribute that contains the UUID/GUID of
an LDAP group object.
</para>
<para>
Default: nsUniqueId
</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_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>
Default: 2
</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_uuid (string)</term>
<listitem>
<para>
The LDAP attribute that contains the UUID/GUID of
an LDAP netgroup object.
</para>
<para>
In IPA provider, ipa_netgroup_uuid should
be used instead.
</para>
<para>
Default: nsUniqueId
</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_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</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>
</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_sasl_mech (string)</term>
<listitem>
<para>
Specify the SASL mechanism to use.
Currently only GSSAPI is tested and supported.
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sasl_authid (string)</term>
<listitem>
<para>
Specify the SASL authorization id to use.
When GSSAPI is used, this represents the Kerberos
principal used for authentication to the directory.
</para>
<para>
Default: host/machine.fqdn@REALM
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_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 (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>
</varlistentry>
<varlistentry>
<term>ldap_pwd_policy (string)</term>
<listitem>
<para>
Select the policy to evaluate the password
expiration on the client side. The following values
are allowed:
</para>
<para>
<emphasis>none</emphasis> - No evaluation on the
client side. This option cannot disable server-side
password policies.
</para>
<para>
<emphasis>shadow</emphasis> - Use
<citerefentry><refentrytitle>shadow</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> style
attributes to evaluate if the password has expired.
Note that the current version of sssd cannot
update this attribute during a password change.
</para>
<para>
<emphasis>mit_kerberos</emphasis> - 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.
</para>
<para>
Default: none
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_referrals (boolean)</term>
<listitem>
<para>
Specifies whether automatic referral chasing should
be enabled.
</para>
<para>
Please note that sssd only supports referral chasing
when it is compiled with OpenLDAP version 2.4.13 or
higher.
</para>
<para>
Default: true
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_dns_service_name (string)</term>
<listitem>
<para>
Specifies the service name to use when service
discovery is enabled.
</para>
<para>
Default: ldap
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_chpass_dns_service_name (string)</term>
<listitem>
<para>
Specifies the service name to use to find an LDAP
server which allows password changes when service
discovery is enabled.
</para>
<para>
Default: not set, i.e. service discovery is disabled
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_access_filter (string)</term>
<listitem>
<para>
If using access_provider = ldap, this option is
mandatory. It specifies an LDAP search filter
criteria that must be met for the user to be
granted access on this host. If
access_provider = ldap and this option is
not set, it will result in all users being
denied access. Use access_provider = allow to
change this default behavior.
</para>
<para>
Example:
</para>
<programlisting>
access_provider = ldap
ldap_access_filter = memberOf=cn=allowedusers,ou=Groups,dc=example,dc=com
</programlisting>
<para>
This example means that access to this host is
restricted to members of the "allowedusers" group
in ldap.
</para>
<para>
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.
</para>
<para>
Default: Empty
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_account_expire_policy (string)</term>
<listitem>
<para>
With this option a client side evaluation of
access control attributes can be enabled.
</para>
<para>
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.
</para>
<para>
The following values are allowed:
</para>
<para>
<emphasis>shadow</emphasis>: use the value of
ldap_user_shadow_expire to determine if the account
is expired.
</para>
<para>
<emphasis>ad</emphasis>: 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.
</para>
<para>
<emphasis>rhds</emphasis>, <emphasis>ipa</emphasis>,
<emphasis>389ds</emphasis>:
use the value of ldap_ns_account_lock to check if
access is allowed or not.
</para>
<para>
<emphasis>nds</emphasis>: 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.
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/experimental.xml" />
</para>
<para>
Default: Empty
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_access_order (string)</term>
<listitem>
<para>
Comma separated list of access control options.
Allowed values are:
</para>
<para>
<emphasis>filter</emphasis>: use ldap_access_filter
</para>
<para>
<emphasis>expire</emphasis>: use
ldap_account_expire_policy
</para>
<para>
<emphasis>authorized_service</emphasis>: use
the authorizedService attribute to determine
access
</para>
<para>
<emphasis>host</emphasis>: use the host attribute
to determine access
</para>
<para>
Default: filter
</para>
<para>
Please note that it is a configuration error if a
value is used more than once.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_deref (string)</term>
<listitem>
<para>
Specifies how alias dereferencing is done when
performing a search. The following options are
allowed:
</para>
<para>
<emphasis>never</emphasis>: Aliases are never
dereferenced.
</para>
<para>
<emphasis>searching</emphasis>: Aliases are
dereferenced in subordinates of the base object,
but not in locating the base object of the search.
</para>
<para>
<emphasis>finding</emphasis>: Aliases are only
dereferenced when locating the base object of the
search.
</para>
<para>
<emphasis>always</emphasis>: Aliases are
dereferenced both in searching and in locating the
base object of the search.
</para>
<para>
Default: Empty (this is handled as
<emphasis>never</emphasis> by the LDAP client
libraries)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_object_class (string)</term>
<listitem>
<para>
The object class of a sudo rule entry in LDAP.
</para>
<para>
Default: sudoRole
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_name (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to
the sudo rule name.
</para>
<para>
Default: cn
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_command (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
command name.
</para>
<para>
Default: sudoCommand
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_host (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
host name.
</para>
<para>
Default: sudoHost
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_user (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
user name.
</para>
<para>
Default: sudoUser
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_option (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
sudo options.
</para>
<para>
Default: sudoOption
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_runasuser (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
user name that commands may be run as.
</para>
<para>
Default: sudoRunAsUser
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_runasgroup (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
group name that commands may be run as.
</para>
<para>
Default: sudoRunAsGroup
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_notbefore (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
start date/time for when the sudo rule is valid.
</para>
<para>
Default: sudoNotBefore
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_notafter (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
expiration date/time, after which the sudo rule
will no longer be valid.
</para>
<para>
Default: sudoNotAfter
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudorule_order (string)</term>
<listitem>
<para>
The LDAP attribute that corresponds to the
ordering index of the rule.
</para>
<para>
Default: sudoOrder
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudo_refresh_enabled (boolean)</term>
<listitem>
<para>
Enables periodical download of all sudo rules.
The cache is purged before each update.
</para>
<para>
Default: false
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudo_refresh_timeout (integer)</term>
<listitem>
<para>
How many seconds SSSD has to wait before refreshing
its cache of sudo rules.
</para>
<para>
Default: 300
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id='advanced-options'>
<title>ADVANCED OPTIONS</title>
<para>
These options are supported by LDAP domains, but they should be used
with caution. Please include them in your configuration only if you
know what you are doing.
<variablelist>
<varlistentry>
<term>ldap_netgroup_search_base (string)</term>
<listitem>
<para>
An optional base DN to restrict netgroup searches
to a specific subtree.
</para>
<para>
See <quote>ldap_search_base</quote> for
information about configuring multiple search
bases.
</para>
<para>
Default: the value of
<emphasis>ldap_search_base</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_search_base (string)</term>
<listitem>
<para>
An optional base DN to restrict user searches
to a specific subtree.
</para>
<para>
See <quote>ldap_search_base</quote> for
information about configuring multiple search
bases.
</para>
<para>
Default: the value of
<emphasis>ldap_search_base</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_search_base (string)</term>
<listitem>
<para>
An optional base DN to restrict group searches
to a specific subtree.
</para>
<para>
See <quote>ldap_search_base</quote> for
information about configuring multiple search
bases.
</para>
<para>
Default: the value of
<emphasis>ldap_search_base</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_user_search_filter (string)</term>
<listitem>
<para>
This option specifies an additional LDAP search
filter criteria that restrict user searches.
</para>
<para>
This option is <emphasis>deprecated</emphasis> in
favor of the syntax used by ldap_user_search_base.
</para>
<para>
Default: not set
</para>
<para>
Example:
</para>
<programlisting>
ldap_user_search_filter = (loginShell=/bin/tcsh)
</programlisting>
<para>
This filter would restrict user searches to users
that have their shell set to /bin/tcsh.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_group_search_filter (string)</term>
<listitem>
<para>
This option specifies an additional LDAP search
filter criteria that restrict group searches.
</para>
<para>
This option is <emphasis>deprecated</emphasis> in
favor of the syntax used by ldap_group_search_base.
</para>
<para>
Default: not set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ldap_sudo_search_base (string)</term>
<listitem>
<para>
An optional base DN to restrict sudo rules searches
to a specific subtree.
</para>
<para>
See <quote>ldap_search_base</quote> for
information about configuring multiple search
bases.
</para>
<para>
Default: the value of
<emphasis>ldap_search_base</emphasis>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/failover.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/service_discovery.xml" />
<refsect1 id='example'>
<title>EXAMPLE</title>
<para>
The following example assumes that SSSD is correctly
configured and LDAP is set to one of the domains in the
<replaceable>[domains]</replaceable> section.
</para>
<para>
<programlisting>
[domain/LDAP]
id_provider = ldap
auth_provider = ldap
ldap_uri = ldap://ldap.mydomain.org
ldap_search_base = dc=mydomain,dc=org
ldap_tls_reqcert = demand
cache_credentials = true
enumerate = true
</programlisting>
</para>
</refsect1>
<refsect1 id='notes'>
<title>NOTES</title>
<para>
The descriptions of some of the configuration options in this manual
page are based on the <citerefentry>
<refentrytitle>ldap.conf</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry> manual page from the OpenLDAP 2.4 distribution.
</para>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>sssd.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sssd-krb5</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>sssd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
</refentry>
</reference>