sssd-krb5.5.xml revision 6b45f632759293fc9f2a28317fae2e224ac53020
55c79512242fd281202cd57ca18defac696440f5kess<!DOCTYPE reference PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
55c79512242fd281202cd57ca18defac696440f5kess"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
55c79512242fd281202cd57ca18defac696440f5kess<reference>
726b11c595edf0b0b71d0d39a2bc9d912c0ee4b5nd <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="include/upstream.xml" />
726b11c595edf0b0b71d0d39a2bc9d912c0ee4b5nd <refmiscinfo class="manual">File Formats and Conventions</refmiscinfo>
726b11c595edf0b0b71d0d39a2bc9d912c0ee4b5nd </refmeta>
726b11c595edf0b0b71d0d39a2bc9d912c0ee4b5nd </refnamediv>
b05ab3ff5ab54aa22610b13d56eaba6ddfc3db60nd This manual page describes the configuration of the Kerberos
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd 5 authentication backend for
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end <citerefentry>
726b11c595edf0b0b71d0d39a2bc9d912c0ee4b5nd </citerefentry>.
55c79512242fd281202cd57ca18defac696440f5kess For a detailed syntax reference, please refer to the <quote>FILE FORMAT</quote> section of the
55c79512242fd281202cd57ca18defac696440f5kess <citerefentry>
55c79512242fd281202cd57ca18defac696440f5kess </citerefentry> manual page.
8f057347a12e831fdf567da83de2fa581580298dnd The Kerberos 5 authentication backend contains auth and chpass
5b10fd3977e6dfff19afe770e612e276962f7950nd providers. It must be paired with an identity provider in
5b10fd3977e6dfff19afe770e612e276962f7950nd order to function properly (for example, id_provider = ldap). Some
8f057347a12e831fdf567da83de2fa581580298dnd information required by the Kerberos 5 authentication backend must
8f057347a12e831fdf567da83de2fa581580298dnd be provided by the identity provider, such as the user's Kerberos
8f057347a12e831fdf567da83de2fa581580298dnd Principal Name (UPN). The configuration of the identity provider
8f057347a12e831fdf567da83de2fa581580298dnd should have an entry to specify the UPN. Please refer to the man
8f057347a12e831fdf567da83de2fa581580298dnd page for the applicable identity provider for details on how to
8f057347a12e831fdf567da83de2fa581580298dnd configure this.
5b10fd3977e6dfff19afe770e612e276962f7950nd This backend also provides access control based on the .k5login
1ce7f356a70d1d9961ec315c212e2f83a1452456nd file in the home directory of the user. See <citerefentry>
2fc082b48b1bfb1182d6b93f5837e74b0c0af3eckess <refentrytitle>.k5login</refentrytitle><manvolnum>5</manvolnum>
2fc082b48b1bfb1182d6b93f5837e74b0c0af3eckess </citerefentry> for more details. Please note that an empty .k5login
74086452b5093fa1a58446034c6ddfd67dab5651kess file will deny all access to this user. To activate this feature,
74086452b5093fa1a58446034c6ddfd67dab5651kess use 'access_provider = krb5' in your SSSD configuration.
b3c7a2279fa7a45f5807d9a404760b9b3760df50nd In the case where the UPN is not available in the identity backend,
b3c7a2279fa7a45f5807d9a404760b9b3760df50nd <command>sssd</command> will construct a UPN using the format
8ba890719035fe67c295c9124693138f9c5aa933kess <replaceable>username</replaceable>@<replaceable>krb5_realm</replaceable>.
55c79512242fd281202cd57ca18defac696440f5kess </refsect1>
62664c6703ed9e8d8f4f8e4c5f5e893559ecefecnd If the auth-module krb5 is used in an SSSD domain, the following
8f057347a12e831fdf567da83de2fa581580298dnd options must be used. See the
8f057347a12e831fdf567da83de2fa581580298dnd <citerefentry>
b8670d4ea3a3efcd12c3e1eddf68ef6fabef49fend </citerefentry> manual page, section <quote>DOMAIN SECTIONS</quote>,
b8670d4ea3a3efcd12c3e1eddf68ef6fabef49fend for details on the configuration of an SSSD domain.
1ce7f356a70d1d9961ec315c212e2f83a1452456nd <variablelist>
1ce7f356a70d1d9961ec315c212e2f83a1452456nd <varlistentry>
db99fa79ac42b9cc42b63386eb289aecb0f3cb9cnd <listitem>
22d5d84393d960a2027f472036f3fee15d7dbce9nd Specifies the comma-separated list of IP addresses or hostnames
22d5d84393d960a2027f472036f3fee15d7dbce9nd of the Kerberos servers to which SSSD should
5a98f1b67de38575f3903a03fc5120062b814371kess connect, in the order of preference. For more
55c79512242fd281202cd57ca18defac696440f5kess information on failover and server redundancy,
55c79512242fd281202cd57ca18defac696440f5kess port number (preceded by a colon) may be appended to
55c79512242fd281202cd57ca18defac696440f5kess the addresses or hostnames.
55c79512242fd281202cd57ca18defac696440f5kess If empty, service discovery is enabled;
55c79512242fd281202cd57ca18defac696440f5kess for more information, refer to the
55c79512242fd281202cd57ca18defac696440f5kess When using service discovery for KDC or kpasswd servers,
ffb88a4885747797937e30a5ac8b1606da3cb4adnd SSSD first searches for DNS entries that specify _udp as
909ce17e2bd0faef7b1c294f2307f009793fd493nd the protocol and falls back to _tcp if none are found.
42af92a661a06b3cebc88d585aad75064a309d51nd earlier releases of SSSD. While the legacy name is recognized
42af92a661a06b3cebc88d585aad75064a309d51nd for the time being, users are advised to migrate their config
55c79512242fd281202cd57ca18defac696440f5kess </listitem>
312d4192f2e32167a1e750034664f1e3c2105c65nd </varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <varlistentry>
0203b896e484dfb877111aceffb812401d0f216and <listitem>
55c79512242fd281202cd57ca18defac696440f5kess The name of the Kerberos realm. This option is required
55c79512242fd281202cd57ca18defac696440f5kess and must be specified.
1ce7f356a70d1d9961ec315c212e2f83a1452456nd </listitem>
55c79512242fd281202cd57ca18defac696440f5kess </varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <term>krb5_kpasswd, krb5_backup_kpasswd (string)</term>
55c79512242fd281202cd57ca18defac696440f5kess <listitem>
55c79512242fd281202cd57ca18defac696440f5kess If the change password service is not running on the
55c79512242fd281202cd57ca18defac696440f5kess KDC, alternative servers can be defined here. An
05ede5110427cb9dc071cc671d5aaba5d3b88c79nd optional port number (preceded by a colon) may be
e8b603fa9ccf7b17b11b42df6d8916fd97c2331dnd appended to the addresses or hostnames.
55c79512242fd281202cd57ca18defac696440f5kess For more information on failover and server
55c79512242fd281202cd57ca18defac696440f5kess NOTE: Even if there are no more kpasswd
611049e38bfbaeb173d2d7fab2e44a48753436a1nd servers to try, the backend is not switched to operate offline
1ce7f356a70d1d9961ec315c212e2f83a1452456nd if authentication against the KDC is still possible.
55c79512242fd281202cd57ca18defac696440f5kess Default: Use the KDC
d8b761beec42bbe2847bb14e3b706642c6eed47cnd </listitem>
d8b761beec42bbe2847bb14e3b706642c6eed47cnd </varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <varlistentry>
1ce7f356a70d1d9961ec315c212e2f83a1452456nd <listitem>
1ce7f356a70d1d9961ec315c212e2f83a1452456nd Directory to store credential caches. All the
55c79512242fd281202cd57ca18defac696440f5kess substitution sequences of krb5_ccname_template can
0203b896e484dfb877111aceffb812401d0f216and be used here, too, except %d and %P. If the
6329991d5f023c1c4ae02cfbbda636c66e6392aand directory does not exist, it will be created. If %u,
55c79512242fd281202cd57ca18defac696440f5kess %U, %p or %h are used, a private directory belonging
55c79512242fd281202cd57ca18defac696440f5kess to the user is created. Otherwise, a public directory
55c79512242fd281202cd57ca18defac696440f5kess with restricted deletion flag (aka sticky bit, as
55c79512242fd281202cd57ca18defac696440f5kess described in
1ce7f356a70d1d9961ec315c212e2f83a1452456nd <citerefentry>
d2b809e5d72658bff23819d8b77f20e4939af541nd </citerefentry> for details) is created.
55c79512242fd281202cd57ca18defac696440f5kess Default: /tmp
55c79512242fd281202cd57ca18defac696440f5kess </listitem>
55c79512242fd281202cd57ca18defac696440f5kess </varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <varlistentry>
c023f60e35022146373e40249f0c8c8d623b6fcfnd <listitem>
a43bfa789f4e52dde53ae8e53fa0427b5c1cf977nd Location of the user's credential cache. Two credential
28c9d384aa958b321280b4ac886941dcad25396bnd and <quote>DIR</quote>. The cache can be specified either
240e1b440b19476ecaa4aa9ff8d79afef74cb14and as <replaceable>TYPE:RESIDUAL</replaceable>, or as an absolute
1d980e5489836e977ba59b419e27b0ec875c4bd3takashi template, the following sequences are substituted:
e5ce3ac0e9b720c0fa23782e29168a0810697fdetakashi <variablelist>
240e1b440b19476ecaa4aa9ff8d79afef74cb14and <varlistentry>
240e1b440b19476ecaa4aa9ff8d79afef74cb14and </varlistentry>
ecc5150d35c0dc5ee5119c2717e6660fa331abbftakashi <varlistentry>
f772e8f448c223e5ea306f1bf92d97d968f972d5jim </varlistentry>
f772e8f448c223e5ea306f1bf92d97d968f972d5jim <varlistentry>
f772e8f448c223e5ea306f1bf92d97d968f972d5jim </listitem>
55c79512242fd281202cd57ca18defac696440f5kess </varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess </varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess </listitem>
55c79512242fd281202cd57ca18defac696440f5kess </varlistentry>
898711b68797304101de0882fa576c8908acfae6nd <varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess </listitem>
55c79512242fd281202cd57ca18defac696440f5kess </varlistentry>
55c79512242fd281202cd57ca18defac696440f5kess <varlistentry>
03c25fb6f628ac81f2ecb637d1e7502dcee783f3nd client</para>
03c25fb6f628ac81f2ecb637d1e7502dcee783f3nd </listitem>
55c79512242fd281202cd57ca18defac696440f5kess </varlistentry>
8f057347a12e831fdf567da83de2fa581580298dnd <varlistentry>
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd </listitem>
b05ab3ff5ab54aa22610b13d56eaba6ddfc3db60nd </varlistentry>
ad74a0524a06bfe11b7de9e3b4ce7233ab3bd3f7nd </variablelist>
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end If the template ends with 'XXXXXX' mkstemp(3) is
63f06dce77bb2d9b1c5aa5deeb47a1069987fd1end used to create a unique filename in a safe way.
Default: not set, i.e. the TGT is not renewable
Default: not set, i.e. the default ticket lifetime
Default: not set, i.e. FAST is not used.
krb5_realm = EXAMPLE.COM