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

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

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

<reference>

<title>SSSD Manual pages</title>

<refentry>

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

<refmeta>

<refentrytitle>sssd-ipa</refentrytitle>

<manvolnum>5</manvolnum>

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

</refmeta>

<refnamediv id='name'>

<refname>sssd-ipa</refname>

<refpurpose>the configuration file for SSSD</refpurpose>

</refnamediv>

<refsect1 id='description'>

<title>DESCRIPTION</title>

<para>

This manual page describes the configuration of the IPA provider

for

<citerefentry>

<refentrytitle>sssd</refentrytitle>

<manvolnum>8</manvolnum>

</citerefentry>.

For a detailed syntax reference, refer to the <quote>FILE FORMAT</quote> section of the

<citerefentry>

<refentrytitle>sssd.conf</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> manual page.

</para>

<para>

The IPA provider is a back end used to connect to an IPA server.

(Refer to the freeipa.org web site for information about IPA servers.)

This provider requires that the machine be joined to the IPA domain;

configuration is almost entirely self-discovered and obtained

directly from the server.

</para>

<para>

The IPA provider accepts the same options used by the

<citerefentry>

<refentrytitle>sssd-ldap</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> identity provider and the

<citerefentry>

<refentrytitle>sssd-krb5</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> authentication provider.

However, it is neither necessary nor recommended to set these options.

IPA provider can also be used as an access and chpass provider. As an

access provider it uses HBAC (host-based access control) rules. Please

refer to freeipa.org for more information about HBAC. No configuration

of access provider is required on the client side.

</para>

</refsect1>

<refsect1 id='file-format'>

<title>CONFIGURATION OPTIONS</title>

<para>Refer to the section <quote>DOMAIN SECTIONS</quote> of the

<citerefentry>

<refentrytitle>sssd.conf</refentrytitle>

<manvolnum>5</manvolnum>

</citerefentry> manual page for details on the configuration of an SSSD domain.

<variablelist>

<varlistentry>

<term>ipa_domain (string)</term>

<listitem>

<para>

Specifies the name of the IPA domain.

This is optional. If not provided, the configuration

domain name is used.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ipa_server (string)</term>

<listitem>

<para>

The list of IP addresses or hostnames of the

IPA 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.

This is optional if autodiscovery is enabled.

For more information on service discovery, refer

to the the <quote>SERVICE DISCOVERY</quote> section.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ipa_hostname (string)</term>

<listitem>

<para>

Optional. May be set on machines where the

hostname(5) does not reflect the fully qualified

name used in the IPA domain to identify this host.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ipa_dyndns_update (boolean)</term>

<listitem>

<para>

Optional. This option tells SSSD to automatically

update the DNS server built into FreeIPA v2 with

the IP address of this client.

</para>

<para>

Default: false

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ipa_dyndns_iface (string)</term>

<listitem>

<para>

Optional. Applicable only when ipa_dyndns_update

is true. Choose the interface whose IP address

should be used for dynamic DNS updates.

</para>

<para>

Default: Use the IP address of the IPA LDAP connection

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>ipa_hbac_search_base (string)</term>

<listitem>

<para>

Optional. Use the given string as search base for

HBAC related objects.

</para>

<para>

Default: Use base DN

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>krb5_validate (boolean)</term>

<listitem>

<para>

Verify with the help of krb5_keytab that the TGT

obtained has not been spoofed.

</para>

<para>

Default: true

</para>

<para>

Note that this default differs from the

traditional Kerberos provider back end.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term>krb5_realm (string)</term>

<listitem>

<para>

The name of the Kerberos realm. This is optional and

defaults to the value of <quote>ipa_domain</quote>.

</para>

<para>

The name of the Kerberos realm has a special

meaning in IPA - it is converted into the base

DN to use for performing LDAP operations.

</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 example.com is one of the domains in the

<replaceable>[sssd]</replaceable> section. This examples shows only

the ipa provider-specific options.

</para>

<para>

<programlisting>

[domain/example.com]

id_provider = ipa

ipa_server = ipaserver.example.com

ipa_hostname = myhost.example.com

</programlisting>

</para>

</refsect1>

<refsect1 id='see_also'>

<title>SEE ALSO</title>

<para>

<citerefentry>

<refentrytitle>sssd.conf</refentrytitle><manvolnum>5</manvolnum>

</citerefentry>,

<citerefentry>

<refentrytitle>sssd-ldap</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>