sssd_krb5_locator_plugin.8.xml revision 7b58d637c20f87e1e49ffc1d49a4de8b25ef06bb
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
<reference>
<title>SSSD Manual pages</title>
<refentry>
<refmeta>
<refentrytitle>sssd_krb5_locator_plugin</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv id='name'>
<refname>sssd_krb5_locator_plugin</refname>
<refpurpose>Kerberos locator plugin</refpurpose>
</refnamediv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
The Kerberos locator plugin
<command>sssd_krb5_locator_plugin</command> is used by the Kerberos
provider of
<citerefentry>
<refentrytitle>sssd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
to tell the Kerberos libraries what Realm and which KDC to use.
Typically this is done in
<citerefentry>
<manvolnum>5</manvolnum>
</citerefentry>
which is always read by the Kerberos libraries. To simplify the
configuration the Realm and the KDC can be defined in
<citerefentry>
<manvolnum>5</manvolnum>
</citerefentry>
as described in
<citerefentry>
<refentrytitle>sssd-krb5</refentrytitle>
<manvolnum>5</manvolnum>
</citerefentry>
</para>
<para>
<citerefentry>
<refentrytitle>sssd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>
puts the Realm and the name or IP address of the KDC into the
environment variables SSSD_KRB5_REALM and SSSD_KRB5_KDC respectively.
When <command>sssd_krb5_locator_plugin</command> is called by the
kerberos libraries it reads and evaluates these variables and returns
them to the libraries.
</para>
</refsect1>
<refsect1 id='notes'>
<title>NOTES</title>
<para>
Not all Kerberos implementations support the use of plugins. If
<command>sssd_krb5_locator_plugin</command> is not available on
Kerberos setup.
</para>
<para>
If the environment variable SSSD_KRB5_LOCATOR_DEBUG is set to any
value debug messages will be sent to stderr.
</para>
</refsect1>
</refentry>
</reference>