OS Manuals

sssd.conf(5)

SSSD.CONF(5) File Formats and Conventions SSSD.CONF(5)


.SH "NAME" sssd.conf - the configuration file for SSSD


.SH "FILE FORMAT"


.PP The file has an ini-style syntax and consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section begins. An example of section with single and multi-valued parameters:

[section]
key = value
key2 = value2,value3


.PP The data types used are string (no quotes needed), integer and bool (with values of “TRUE/FALSE”).


.PP A comment line starts with a hash sign (“#”) or a semicolon (“;”). Inline comments are not supported.


.PP All sections can have an optional description parameter. Its function is only as a label for the section.


.PP sssd.conf must be a regular file that is accessible only by the user used to run SSSD service or root.


.SH "CONFIGURATION SNIPPETS FROM INCLUDE DIRECTORY"


.PP The configuration file sssd.conf will include configuration snippets using the include directory conf.d.


.PP Any file placed in conf.d that ends in “.conf” and does not begin with a dot (“.”) will be used together with sssd.conf to configure SSSD.


.PP The configuration snippets from conf.d have higher priority than sssd.conf and will override sssd.conf when conflicts occur. If several snippets are present in conf.d, then they are included in alphabetical order (based on locale). Files included later have higher priority. Numerical prefixes (01_snippet.conf, 02_snippet.conf etc.) can help visualize the priority (higher number means higher priority).


.PP The snippet files require the same owner and permissions as sssd.conf.


.SH "GENERAL OPTIONS"


.PP Following options are usable in more than one configuration sections.


.SS "Options usable in all sections"


.PP


.PP debug_level (integer)


SSSD supports two representations for specifying the debug level. The simplest is to specify a decimal value from 0-9, which represents enabling that level and all lower-level debug messages. The more comprehensive option is to specify a hexadecimal bitmask to enable or disable specific levels (such as if you wish to suppress a level).


Please note that each SSSD service logs into its own log file. Also please note that enabling “debug_level” in the “[sssd]” section only enables debugging just for the sssd process itself, not for the responder or provider processes. The “debug_level” parameter should be added to all sections that you wish to produce debug logs from.


In addition to changing the log level in the config file using the “debug_level” parameter, which is persistent, but requires SSSD restart, it is also possible to change the debug level on the fly using the sss_debuglevel(8) tool.


Currently supported debug levels:


0, 0x0010: Fatal failures. Anything that would prevent SSSD from starting up or causes it to cease running.


1, 0x0020: Critical failures. An error that doesn't kill SSSD, but one that indicates that at least one major feature is not going to work properly.


2, 0x0040: Serious failures. An error announcing that a particular request or operation has failed.


3, 0x0080: Minor failures. These are the errors that would percolate down to cause the operation failure of 2.


4, 0x0100: Configuration settings.


5, 0x0200: Function data.


6, 0x0400: Trace messages for operation functions.


7, 0x1000: Trace messages for internal control functions.


8, 0x2000: Contents of function-internal variables that may be interesting.


9, 0x4000: Extremely low-level tracing information.


9, 0x20000: Performance and statistical data, please note that due to the way requests are processed internally the logged execution time of a request might be longer than it actually was.


10, 0x10000: Even more low-level libldb tracing information. Almost never really required.


To log required bitmask debug levels, simply add their numbers together as shown in following examples:


Example: To log fatal failures, critical failures, serious failures and function data use 0x0270.


Example: To log fatal failures, configuration settings, function data, trace messages for internal control functions use 0x1310.


Note: The bitmask format of debug levels was introduced in 1.7.0.


Default: 0x0070 (i.e. fatal, critical and serious failures; corresponds to setting 2 in decimal notation)


.RE
.PP debug (integer)


SSSD 1.14 and later also includes the debug alias for debug_level as a convenience feature. If both are specified, the value of debug_level will be used.


.RE
.PP debug_timestamps (bool)


Add a timestamp to the debug messages. If journald is enabled for SSSD debug logging this option is ignored.


Default: true


.RE
.PP debug_microseconds (bool)


Add microseconds to the timestamp in debug messages. If journald is enabled for SSSD debug logging this option is ignored.


Default: false


.RE
.PP debug_backtrace_enabled (bool)


Enable debug backtrace.


In case SSSD is run with debug_level less than 9, everything is logged to a ring buffer in memory and flushed to a log file on any error up to and including `min(0x0040, debug_level)` (i.e. if debug_level is explicitly set to 0 or 1 then only those error levels will trigger backtrace, otherwise up to 2).


Feature is only supported for `logger == files` (i.e. setting doesn't have effect for other logger types).


Default: true


.RE


.SS "Options usable in SERVICE and DOMAIN sections"


.PP


.PP timeout (integer)


Timeout in seconds between heartbeats for this service. This is used to ensure that the process is alive and capable of answering requests. Note that after three missed heartbeats the process will terminate itself.


Default: 10


.RE


.SH "SPECIAL SECTIONS"


.SS "The [sssd] section"


.PP Individual pieces of SSSD functionality are provided by special SSSD services that are started and stopped together with SSSD. The services are managed by a special service frequently called “monitor”. The “[sssd]” section is used to configure the monitor as well as some other important options like the identity domains.

Section parameters


.PP services


Comma separated list of services that are started when sssd itself starts. The services' list is optional on platforms where systemd is supported, as they will either be socket or D-Bus activated when needed.


Supported services: nss, pam, ifp , sudo , autofs , ssh


By default, all services are disabled and the administrator must enable the ones allowed to be used by executing: "systemctl enable sssd-@service@.socket".


.RE
.PP domains


A domain is a database containing user information. SSSD can use more domains at the same time, but at least one must be configured or SSSD won't start. This parameter describes the list of domains in the order you want them to be queried. A domain name is recommended to contain only alphanumeric ASCII characters, dashes, dots and underscores. '/' character is forbidden.


.RE
.PP re_expression (string)


Default regular expression that describes how to parse the string containing user name and domain into these components.


Each domain can have an individual regular expression configured. For some ID providers there are also default regular expressions. See DOMAIN SECTIONS for more info on these regular expressions.


.RE
.PP full_name_format (string)


A printf(3)-compatible format that describes how to compose a fully qualified name from user name and domain name components.


The following expansions are supported:


.PP %1$s


user name


.RE
.PP %2$s


domain name as specified in the SSSD config file.


.RE
.PP %3$s


domain flat name. Mostly usable for Active Directory domains, both directly configured or discovered via IPA trusts.


.RE
.sp


Each domain can have an individual format string configured. See DOMAIN SECTIONS for more info on this option.


.RE
.PP monitor_resolv_conf (boolean)


Controls if SSSD should monitor the state of resolv.conf to identify when it needs to update its internal DNS resolver.


Default: true


.RE
.PP try_inotify (boolean)


By default, SSSD will attempt to use inotify to monitor configuration files changes and will fall back to polling every five seconds if inotify cannot be used.


There are some limited situations where it is preferred that we should skip even trying to use inotify. In these rare cases, this option should be set to 'false'


Default: true on platforms where inotify is supported. False on other platforms.


Note: this option will have no effect on platforms where inotify is unavailable. On these platforms, polling will always be used.


.RE
.PP krb5_rcache_dir (string)


Directory on the filesystem where SSSD should store Kerberos replay cache files.


This option accepts a special value __LIBKRB5_DEFAULTS__ that will instruct SSSD to let libkrb5 decide the appropriate location for the replay cache.


Default: Distribution-specific and specified at build-time. (__LIBKRB5_DEFAULTS__ if not configured)


.RE
.PP default_domain_suffix (string)


Please note that this option is deprecated and domain_resolution_order should be used.


This string will be used as a default domain name for all names without a domain name component. The main use case is environments where the primary domain is intended for managing host policies and all users are located in a trusted domain. The option allows those users to log in just with their user name without giving a domain name as well.


Please note that if this option is set all users from the primary domain have to use their fully qualified name, e.g. user@domain.name, to log in. Setting this option changes default of use_fully_qualified_names to True. It is not allowed to use this option together with use_fully_qualified_names set to False.


Default: not set


.RE
.PP override_space (string)


This parameter will replace spaces (space bar) with the given character for user and group names. e.g. (_). User name "john doe" will be "john_doe" This feature was added to help compatibility with shell scripts that have difficulty handling spaces, due to the default field separator in the shell.


Please note it is a configuration error to use a replacement character that might be used in user or group names. If a name contains the replacement character SSSD tries to return the unmodified name but in general the result of a lookup is undefined.


Default: not set (spaces will not be replaced)


.RE
.PP certificate_verification (string)


With this parameter the certificate verification can be tuned with a comma separated list of options. Supported options are:


.PP no_ocsp


Disables Online Certificate Status Protocol (OCSP) checks. This might be needed if the OCSP servers defined in the certificate are not reachable from the client.


.RE
.PP soft_ocsp


If a connection cannot be established to an OCSP responder the OCSP check is skipped. This option should be used to allow authentication when the system is offline and the OCSP responder cannot be reached.


.RE
.PP ocsp_dgst


Digest (hash) function used to create the certificate ID for the OCSP request. Allowed values are:

•sha1

•sha256

•sha384

•sha512

.sp


Default: sha1 (to allow compatibility with RFC5019-compliant responder)


.RE
.PP no_verification


Disables verification completely. This option should only be used for testing.


.RE
.PP partial_chain


Allow verification to succeed even if a complete chain cannot be built to a self-signed trust-anchor, provided it is possible to construct a chain to a trusted certificate that might not be self-signed.


.RE
.PP ocsp_default_responder=URL


Sets the OCSP default responder which should be used instead of the one mentioned in the certificate. URL must be replaced with the URL of the OCSP default responder e.g. http://example.com:80/ocsp.


.RE
.PP ocsp_default_responder_signing_cert=NAME


This option is currently ignored. All needed certificates must be available in the PEM file given by pam_cert_db_path.


.RE
.PP crl_file=/PATH/TO/CRL/FILE


Use the Certificate Revocation List (CRL) from the given file during the verification of the certificate. The CRL must be given in PEM format, see crl(1ssl) for details.


.RE
.PP soft_crl


If a Certificate Revocation List (CRL) is expired ignore the expiration time of the CRL and check the related certificates with the expired CRL. This option should be used to allow authentication when the system is offline and the CRL cannot be renewed.


.RE
.sp


Unknown options are reported but ignored.


Default: not set, i.e. do not restrict certificate verification


.RE


.PP domain_resolution_order


Comma separated list of domains and subdomains representing the lookup order that will be followed. The list doesn't have to include all possible domains as the missing domains will be looked up based on the order they're presented in the “domains” configuration option. The subdomains which are not listed as part of “lookup_order” will be looked up in a random order for each parent domain.


Please, note that when this option is set the output format of all commands is always fully-qualified even when using short names for input. In case the administrator wants the output not fully-qualified, the full_name_format option can be used as shown below: “full_name_format=%1$s” However, keep in mind that during login, login applications often canonicalize the username by calling getpwnam(3) which, if a shortname is returned for a qualified input (while trying to reach a user which exists in multiple domains) might re-route the login attempt into the domain which uses shortnames, making this workaround totally not recommended in cases where usernames may overlap between domains.


Default: Not set


.RE
.PP implicit_pac_responder (boolean)


The PAC responder is enabled automatically for the IPA and AD provider to evaluate and check the PAC. If it has to be disabled set this option to 'false'.


Default: true


.RE
.PP core_dumpable (boolean)


This option can be used for general system hardening: setting it to 'false' forbids core dumps for all SSSD processes to avoid leaking plain text passwords. See man page prctl:PR_SET_DUMPABLE on Linux or procctl:PROC_TRACE_CTL on FreeBSD for details.


Take a note that this setting has no effect for 'ldap_child', 'krb5_child' and 'sssd_pam' as those privileged binaries can have a copy of a host keytab data in a memory and their behavior in this regards is governed by /proc/sys/fs/suid_dumpable system setting.


Default: true


.RE


.SH "SERVICES SECTIONS"


.PP Settings that can be used to configure different services are described in this section. They should reside in the [$NAME] section, for example, for NSS service, the section would be “[nss]”


.SS "General service configuration options"


.PP These options can be used to configure any service.


.PP fd_limit


This option specifies the maximum number of file descriptors that may be opened at one time by this SSSD process. Note this value will be capped by the init system at the startup of SSSD, see e.g. man systemd.exec for details.


Default: 8192 (or limits.conf "hard" limit)


.RE
.PP client_idle_timeout


This option specifies the number of seconds that a client of an SSSD process can hold onto a file descriptor without communicating on it. This value is limited in order to avoid resource exhaustion on the system. The timeout can't be shorter than 10 seconds. If a lower value is configured, it will be adjusted to 10 seconds.


Default: 60, KCM: 300


.RE
.PP responder_idle_timeout


This option specifies the number of seconds that an SSSD responder process can be up without being used. This value is limited in order to avoid resource exhaustion on the system. The minimum acceptable value for this option is 60 seconds. Setting this option to 0 (zero) means that no timeout will be set up to the responder. This option only has effect when SSSD is built with systemd support and when services are either socket or D-Bus activated.


Default: 300


.RE
.PP cache_first


This option specifies whether the responder should query all caches before querying the Data Providers.


Default: true


.RE


.SS "NSS configuration options"


.PP These options can be used to configure the Name Service Switch (NSS) service.


.PP enum_cache_timeout (integer)


How many seconds should nss_sss cache enumerations (requests for info about all users)


Default: 120


.RE
.PP entry_cache_nowait_percentage (integer)


The entry cache can be set to automatically update entries in the background if they are requested beyond a percentage of the entry_cache_timeout value for the domain.


For example, if the domain's entry_cache_timeout is set to 30s and entry_cache_nowait_percentage is set to 50 (percent), entries that come in after 15 seconds past the last cache update will be returned immediately, but the SSSD will go and update the cache on its own, so that future requests will not need to block waiting for a cache update.


Valid values for this option are 0-99 and represent a percentage of the entry_cache_timeout for each domain. For performance reasons, this percentage will never reduce the nowait timeout to less than 10 seconds. (0 disables this feature)


Default: 50


.RE
.PP entry_negative_timeout (integer)


Specifies for how many seconds nss_sss should cache negative cache hits (that is, queries for invalid database entries, like nonexistent ones) before asking the back end again.


Default: 15


.RE
.PP filter_users, filter_groups (string)


Exclude certain users or groups from being fetched from the sss NSS database. This is particularly useful for system accounts. This option can also be set per-domain or include fully-qualified names to filter only users from the particular domain or by a user principal name (UPN).


NOTE: The filter_groups option doesn't affect inheritance of nested group members, since filtering happens after they are propagated for returning via NSS. E.g. a group having a member group filtered out will still have the member users of the latter listed.


Default: root


.RE
.PP filter_users_in_groups (bool)


If you want filtered user still be group members set this option to false.


Default: true


.RE
.PP override_homedir (string)


Override the user's home directory. You can either provide an absolute value or a template. In the template, the following sequences are substituted:


.PP %u


login name


.RE
.PP %U


UID number


.RE
.PP %d


domain name


.RE
.PP %f


fully qualified user name (user@domain)


.RE
.PP %l


The first letter of the login name.


.RE
.PP %P


UPN - User Principal Name (name@REALM)


.RE
.PP %o


The homedir value that is defined in the directory of the identity provider.


This substitution is designed to be used in an IPA-AD trust scenario. If this substitution is used for the subdomain_homedir option, it propagates the home directory value from the AD domain to the IPA clients. In this scenario, the option must be set in the SSSD configuration on the IPA server where SSSD is running in server mode.


.RE
.PP %h


The path defined for the homedir directory attribute of the identity provider, but in lower case. For details of use, see %o.


.RE
.PP %H


The value of configure option homedir_substring.


.RE
.PP %%


a literal '%'


.RE
.sp


This option can also be set per-domain.


example:

override_homedir = /home/%u


Default: Not set (SSSD will use the value retrieved from LDAP)


Please note, the home directory from a specific override for the user, either locally (see sss_override(8)) or centrally managed IPA id-overrides, has a higher precedence and will be used instead of the value given by override_homedir.


.PP homedir_substring (string)


The value of this option will be used in the expansion of the override_homedir option if the template contains the format string %H. An LDAP directory entry can directly contain this template so that this option can be used to expand the home directory path for each client machine (or operating system). It can be set per-domain or globally in the [nss] section. A value specified in a domain section will override one set in the [nss] section.


Default: /home


.PP fallback_homedir (string)


Set a default template for a user's home directory if one is not specified explicitly by the domain's data provider.


The available values for this option are the same as for override_homedir.


example:

fallback_homedir = /home/%u


Default: not set (no substitution for unset home directories)


.RE
.PP override_shell (string)


Override the login shell for all users. This option supersedes any other shell options if it takes effect and can be set either in the [nss] section or per-domain.


Default: not set (SSSD will use the value retrieved from LDAP)


.RE
.PP allowed_shells (string)


Restrict user shell to one of the listed values. The order of evaluation is:


1. If the shell is present in “/etc/shells”, it is used.


2. If the shell is in the allowed_shells list but not in “/etc/shells”, use the value of the shell_fallback parameter.


3. If the shell is not in the allowed_shells list and not in “/etc/shells”, a nologin shell is used.


The wildcard (*) can be used to allow any shell.


The (*) is useful if you want to use shell_fallback in case that user's shell is not in “/etc/shells” and maintaining list of all allowed shells in allowed_shells would be to much overhead.


An empty string for shell is passed as-is to libc.


The “/etc/shells” is only read on SSSD start up, which means that a restart of the SSSD is required in case a new shell is installed.


Default: Not set. The user shell is automatically used.


.RE
.PP vetoed_shells (string)


Replace any instance of these shells with the shell_fallback


.RE
.PP shell_fallback (string)


The default shell to use if an allowed shell is not installed on the machine.


Default: /bin/sh


.RE
.PP default_shell


The default shell to use if the provider does not return one during lookup. This option can be specified globally in the [nss] section or per-domain.


Default: not set (Return NULL if no shell is specified and rely on libc to substitute something sensible when necessary, usually /bin/sh)


.RE
.PP get_domains_timeout (int)


Specifies time in seconds for which the list of subdomains will be considered valid.


Default: 60


.RE
.PP memcache_timeout (integer)


Specifies time in seconds for which records in the in-memory cache will be valid. Setting this option to zero will disable the in-memory cache.


Default: 300


WARNING: Disabling the in-memory cache will have significant negative impact on SSSD's performance and should only be used for testing.


NOTE: If the environment variable SSS_NSS_USE_MEMCACHE is set to "NO", client applications will not use the fast in-memory cache.


.RE
.PP memcache_size_passwd (integer)


Size (in megabytes) of the data table allocated inside fast in-memory cache for passwd requests. Setting the size to 0 will disable the passwd in-memory cache.


Default: 8


WARNING: Disabled or too small in-memory cache can have significant negative impact on SSSD's performance.


NOTE: If the environment variable SSS_NSS_USE_MEMCACHE is set to "NO", client applications will not use the fast in-memory cache.


.RE
.PP memcache_size_group (integer)


Size (in megabytes) of the data table allocated inside fast in-memory cache for group requests. Setting the size to 0 will disable the group in-memory cache.


Default: 6


WARNING: Disabled or too small in-memory cache can have significant negative impact on SSSD's performance.


NOTE: If the environment variable SSS_NSS_USE_MEMCACHE is set to "NO", client applications will not use the fast in-memory cache.


.RE
.PP memcache_size_initgroups (integer)


Size (in megabytes) of the data table allocated inside fast in-memory cache for initgroups requests. Setting the size to 0 will disable the initgroups in-memory cache.


Default: 10


WARNING: Disabled or too small in-memory cache can have significant negative impact on SSSD's performance.


NOTE: If the environment variable SSS_NSS_USE_MEMCACHE is set to "NO", client applications will not use the fast in-memory cache.


.RE
.PP memcache_size_sid (integer)


Size (in megabytes) of the data table allocated inside fast in-memory cache for SID related requests. Only SID-by-ID and ID-by-SID requests are currently cached in fast in-memory cache. Setting the size to 0 will disable the SID in-memory cache.


Default: 6


WARNING: Disabled or too small in-memory cache can have significant negative impact on SSSD's performance.


NOTE: If the environment variable SSS_NSS_USE_MEMCACHE is set to "NO", client applications will not use the fast in-memory cache.


.RE
.PP user_attributes (string)


Some of the additional NSS responder requests can return more attributes than just the POSIX ones defined by the NSS interface. The list of attributes is controlled by this option. It is handled the same way as the “user_attributes” option of the InfoPipe responder (see sssd-ifp(5) for details) but with no default values.


To make configuration more easy the NSS responder will check the InfoPipe option if it is not set for the NSS responder.


Default: not set, fallback to InfoPipe option


.RE
.PP pwfield (string)


The value that NSS operations that return users or groups will return for the “password” field.


Default: “*”


Note: This option can also be set per-domain which overwrites the value in [nss] section.


Default: “not set” (remote domains), “x” (proxy domain with nss_files and sssd-shadowutils target)


.RE


.SS "PAM configuration options"


.PP These options can be used to configure the Pluggable Authentication Module (PAM) service.


.PP offline_credentials_expiration (integer)


If the authentication provider is offline, how long should we allow cached logins (in days since the last successful online login).


Default: 0 (No limit)


.RE


.PP offline_failed_login_attempts (integer)


If the authentication provider is offline, how many failed login attempts are allowed.


Default: 0 (No limit)


.RE


.PP offline_failed_login_delay (integer)


The time in minutes which has to pass after offline_failed_login_attempts has been reached before a new login attempt is possible.


If set to 0 the user cannot authenticate offline if offline_failed_login_attempts has been reached. Only a successful online authentication can enable offline authentication again.


Default: 5


.RE


.PP pam_verbosity (integer)


Controls what kind of messages are shown to the user during authentication. The higher the number to more messages are displayed.


Currently sssd supports the following values:


0: do not show any message


1: show only important messages


2: show informational messages


3: show all messages and debug information


Default: 1


.RE


.PP pam_response_filter (string)


A comma separated list of strings which allows to remove (filter) data sent by the PAM responder to pam_sss PAM module. There are different kind of responses sent to pam_sss e.g. messages displayed to the user or environment variables which should be set by pam_sss.


While messages already can be controlled with the help of the pam_verbosity option this option allows to filter out other kind of responses as well.


Currently the following filters are supported:


.PP ENV


Do not send any environment variables to any service.


.RE
.PP ENV:var_name


Do not send environment variable var_name to any service.


.RE
.PP ENV:var_name:service


Do not send environment variable var_name to service.


.RE
.sp


The list of strings can either be the list of filters which would set this list of filters and overwrite the defaults. Or each element of the list can be prefixed by a '+' or '-' character which would add the filter to the existing default or remove it from the defaults, respectively. Please note that either all list elements must have a '+' or '-' prefix or none. It is considered as an error to mix both styles.


Default: ENV:KRB5CCNAME:sudo, ENV:KRB5CCNAME:sudo-i


Example: -ENV:KRB5CCNAME:sudo-i will remove the filter from the default list


.RE


.PP pam_id_timeout (integer)


For any PAM request while SSSD is online, the SSSD will attempt to immediately update the cached identity information for the user in order to ensure that authentication takes place with the latest information.


A complete PAM conversation may perform multiple PAM requests, such as account management and session opening. This option controls (on a per-client-application basis) how long (in seconds) we can cache the identity information to avoid excessive round-trips to the identity provider.


Default: 5


.RE


.PP pam_pwd_expiration_warning (integer)


Display a warning N days before the password expires.


Please note that the backend server has to provide information about the expiration time of the password. If this information is missing, sssd cannot display a warning.


If zero is set, then this filter is not applied, i.e. if the expiration warning was received from backend server, it will automatically be displayed.


This setting can be overridden by setting pwd_expiration_warning for a particular domain.


Default: 0


.RE
.PP get_domains_timeout (int)


Specifies time in seconds for which the list of subdomains will be considered valid.


Default: 60


.RE
.PP pam_trusted_users (string)


Specifies the comma-separated list of UID values or user names that are allowed to run PAM conversations against trusted domains. Users not included in this list can only access domains marked as public with “pam_public_domains”. User names are resolved to UIDs at startup.


Default: All users are considered trusted by default


Please note that UID 0 is always allowed to access the PAM responder even in case it is not in the pam_trusted_users list.


.RE
.PP pam_public_domains (string)


Specifies the comma-separated list of domain names that are accessible even to untrusted users.


Two special values for pam_public_domains option are defined:


all (Untrusted users are allowed to access all domains in PAM responder.)


none (Untrusted users are not allowed to access any domains PAM in responder.)


Default: none


.RE
.PP pam_account_expired_message (string)


Allows a custom expiration message to be set, replacing the default 'Permission denied' message.


Note: Please be aware that message is only printed for the SSH service unless pam_verbosity is set to 3 (show all messages and debug information).


example:

pam_account_expired_message = Account expired, please contact help desk.


Default: none


.RE
.PP pam_account_locked_message (string)


Allows a custom lockout message to be set, replacing the default 'Permission denied' message.


example:

pam_account_locked_message = Account locked, please contact help desk.


Default: none


.RE


.PP pam_cert_auth (bool)


Enable certificate based Smartcard authentication. Since this requires additional communication with the Smartcard which will delay the authentication process this option is disabled by default.


Default: False


.RE
.PP pam_cert_db_path (string)


The path to the certificate database.


Default:

•/etc/sssd/pki/sssd_auth_ca_db.pem (path to a file with trusted CA certificates in PEM format)


.RE
.sp


.RE
.PP pam_cert_verification (string)


With this parameter the PAM certificate verification can be tuned with a comma separated list of options that override the “certificate_verification” value in “[sssd]” section. Supported options are the same of “certificate_verification”.


example:

pam_cert_verification = partial_chain


Default: not set, i.e. use default “certificate_verification” option defined in “[sssd]” section.


.RE
.PP p11_child_timeout (integer)


How many seconds will pam_sss wait for p11_child to finish.


Default: 10


.RE


.PP pam_app_services (string)


Which PAM services are permitted to contact domains of type “application”


Default: Not set


.RE
.PP pam_p11_allowed_services (string)


A comma-separated list of PAM service names for which it will be allowed to use Smartcards.


It is possible to add another PAM service name to the default set by using “+service_name” or to explicitly remove a PAM service name from the default set by using “-service_name”. For example, in order to replace a default PAM service name for authentication with Smartcards (e.g. “login”) with a custom PAM service name (e.g. “my_pam_service”), you would use the following configuration:

pam_p11_allowed_services = +my_pam_service, -login


Default: the default set of PAM service names includes:

•
login


.RE

•
su


.RE

•
su-l


.RE

•
gdm-smartcard


.RE

•
gdm-password


.RE

•
gdm-switchable-auth


.RE

•
kdm


.RE

•
plasmalogin


.RE

•
sudo


.RE

•
sudo-i


.RE

•
gnome-screensaver


.RE
.sp


.RE
.PP p11_wait_for_card_timeout (integer)


If Smartcard authentication is required how many extra seconds in addition to p11_child_timeout should the PAM responder wait until a Smartcard is inserted.


Default: 60


.RE
.PP p11_uri (string)


PKCS#11 URI (see RFC-7512 for details) which can be used to restrict the selection of devices used for Smartcard authentication. By default SSSD's p11_child will search for a PKCS#11 slot (reader) where the 'removable' flags is set and read the certificates from the inserted token from the first slot found. If multiple readers are connected p11_uri can be used to tell p11_child to use a specific reader.


Example:

p11_uri = pkcs11:slot-description=My%20Smartcard%20Reader

or

p11_uri = pkcs11:library-description=OpenSC%20smartcard%20framework;slot-id=2

To find suitable URI please check the debug output of p11_child. As an alternative the GnuTLS utility 'p11tool' with e.g. the '--list-all' will show PKCS#11 URIs as well.


Default: none


.RE
.PP pam_initgroups_scheme


The PAM responder can force an online lookup to get the current group memberships of the user trying to log in. This option controls when this should be done and the following values are allowed:


.PP always


Always do an online lookup, please note that pam_id_timeout still applies


.RE
.PP no_session


Only do an online lookup if there is no active session of the user, i.e. if the user is currently not logged in


.RE
.PP never


Never force an online lookup, use the data from the cache as long as they are not expired


.RE
.sp


Default: no_session


.RE
.PP pam_gssapi_services


Comma separated list of PAM services that are allowed to try GSSAPI authentication using pam_sss_gss.so module.


To disable GSSAPI authentication, set this option to “-” (dash).


Note: This option can also be set per-domain which overwrites the value in [pam] section. It can also be set for trusted domain which overwrites the value in the domain section.


Example:

pam_gssapi_services = sudo, sudo-i


Default: - (GSSAPI authentication is disabled)


.RE
.PP pam_gssapi_check_upn


If True, SSSD will require that the Kerberos user principal that successfully authenticated through GSSAPI can be associated with the user who is being authenticated. Authentication will fail if the check fails.


If False, every user that is able to obtained required service ticket will be authenticated.


Note: This option can also be set per-domain which overwrites the value in [pam] section. It can also be set for trusted domain which overwrites the value in the domain section.


Default: True


.RE
.PP pam_gssapi_indicators_map


Comma separated list of authentication indicators required to be present in a Kerberos ticket to access a PAM service that is allowed to try GSSAPI authentication using pam_sss_gss.so module.


Each element of the list can be either an authentication indicator name or a pair “service:indicator”. Indicators not prefixed with the PAM service name will be required to access any PAM service configured to be used with pam_gssapi_services. A resulting list of indicators per PAM service is then checked against indicators in the Kerberos ticket during authentication by pam_sss_gss.so. Any indicator from the ticket that matches the resulting list of indicators for the PAM service would grant access. If none of the indicators in the list match, access will be denied. If the resulting list of indicators for the PAM service is empty, the check will not prevent the access.


To disable GSSAPI authentication indicator check, set this option to “-” (dash). To disable the check for a specific PAM service, add “service:-”.


Note: This option can also be set per-domain which overwrites the value in [pam] section. It can also be set for trusted domain which overwrites the value in the domain section.


Following authentication indicators are supported by IPA Kerberos deployments:

•
pkinit -- pre-authentication using X.509 certificates -- whether stored in files or on smart cards.


.RE

•
hardened -- SPAKE pre-authentication or any pre-authentication wrapped in a FAST channel.


.RE

•
radius -- pre-authentication with the help of a RADIUS server.


.RE

•
otp -- pre-authentication using integrated two-factor authentication (2FA or one-time password, OTP) in IPA.


.RE

•
idp -- pre-authentication using external identity provider.


.RE
.sp


Example: to require access to SUDO services only for users which obtained their Kerberos tickets with a X.509 certificate pre-authentication (PKINIT), set

pam_gssapi_indicators_map = sudo:pkinit, sudo-i:pkinit


Default: not set (use of authentication indicators is not required)


.RE


.SS "SUDO configuration options"


.PP These options can be used to configure the sudo service. The detailed instructions for configuration of sudo(8) to work with sssd(8) are in the manual page sssd-sudo(5).


.PP sudo_timed (bool)


Whether or not to evaluate the sudoNotBefore and sudoNotAfter attributes that implement time-dependent sudoers entries.


Default: false


.RE


.PP sudo_threshold (integer)


Maximum number of expired rules that can be refreshed at once. If number of expired rules is below threshold, those rules are refreshed with “rules refresh” mechanism. If the threshold is exceeded a “full refresh” of sudo rules is triggered instead. This threshold number also applies to IPA sudo command and command group searches.


Default: 50


.RE


.SS "AUTOFS configuration options"


.PP These options can be used to configure the autofs service.


.PP autofs_negative_timeout (integer)


Specifies for how many seconds should the autofs responder negative cache hits (that is, queries for invalid map entries, like nonexistent ones) before asking the back end again.


Default: 15


.RE


.PP Please note that the automounter only reads the master map on startup, so if any autofs-related changes are made to the sssd.conf, you typically also need to restart the automounter daemon after restarting the SSSD.


.SS "SSH configuration options"


.PP These options can be used to configure the SSH service.


.PP ssh_use_certificate_keys (bool)


If set to true the sss_ssh_authorizedkeys will return ssh keys derived from the public key of X.509 certificates stored in the user entry as well. See sss_ssh_authorizedkeys(1) for details.


Default: true


.RE
.PP ssh_use_certificate_matching_rules (string)


By default the ssh responder will use all available certificate matching rules to filter the certificates so that ssh keys are only derived from the matching ones. With this option the used rules can be restricted with a comma separated list of mapping and matching rule names. All other rules will be ignored.


There are two special key words 'all_rules' and 'no_rules' which will enable all or no rules, respectively. The latter means that no certificates will be filtered out and ssh keys will be generated from all valid certificates.


If no rules are configured using 'all_rules' will enable a default rule which enables all certificates suitable for client authentication. This is the same behavior as for the PAM responder if certificate authentication is enabled.


A non-existing rule name is considered an error. If as a result no rule is selected all certificates will be ignored.


Default: not set, equivalent to 'all_rules', all found rules or the default rule are used


.RE
.PP ca_db (string)


Path to a storage of trusted CA certificates. The option is used to validate user certificates before deriving public ssh keys from them.


Default:

•/etc/sssd/pki/sssd_auth_ca_db.pem (path to a file with trusted CA certificates in PEM format)


.RE
.sp


.RE


.SS "Session recording configuration options"


.PP Session recording works in conjunction with tlog-rec-session(8), a part of tlog package, to log what users see and type when they log in on a text terminal. See also sssd-session-recording(5).


.PP These options can be used to configure session recording.


.PP scope (string)


One of the following strings specifying the scope of session recording:


.PP "none"


No users are recorded.


.RE
.PP "some"


Users/groups specified by users and groups options are recorded.


.RE
.PP "all"


All users are recorded.


.RE
.sp


Default: "none"


.RE
.PP users (string)


A comma-separated list of users which should have session recording enabled. Matches user names as returned by NSS. I.e. after the possible space replacement, case changes, etc.


Default: Empty. Matches no users.


.RE
.PP groups (string)


A comma-separated list of groups, members of which should have session recording enabled. Matches group names as returned by NSS. I.e. after the possible space replacement, case changes, etc.


NOTE: using this option (having it set to anything) has a considerable performance cost, because each uncached request for a user requires retrieving and matching the groups the user is member of.


Default: Empty. Matches no groups.


.RE
.PP exclude_users (string)


A comma-separated list of users to be excluded from recording, only applicable with 'scope=all'.


Default: Empty. No users excluded.


.RE
.PP exclude_groups (string)


A comma-separated list of groups, members of which should be excluded from recording. Only applicable with 'scope=all'.


NOTE: using this option (having it set to anything) has a considerable performance cost, because each uncached request for a user requires retrieving and matching the groups the user is member of.


Default: Empty. No groups excluded.


.RE


.SH "DOMAIN SECTIONS"


.PP These configuration options can be present in a domain configuration section, that is, in a section called “[domain/NAME]”


.PP enabled


Explicitly enable or disable the domain. If “true”, the domain is always “enabled”. If “false”, the domain is always “disabled”. If this option is not set, the domain is enabled only if it is listed in the domains option in the “[sssd]” section.


.RE


.PP domain_type (string)


Specifies whether the domain is meant to be used by POSIX-aware clients such as the Name Service Switch or by applications that do not need POSIX data to be present or generated. Only objects from POSIX domains are available to the operating system interfaces and utilities.


Allowed values for this option are “posix” and “application”.


POSIX domains are reachable by all services. Application domains are only reachable from the InfoPipe responder (see sssd-ifp(5)) and the PAM responder.


NOTE: The application domains are currently well tested with “id_provider=ldap” only.


For an easy way to configure a non-POSIX domains, please see the “Application domains” section.


Default: posix


.RE


.PP min_id,max_id (integer)


UID and GID limits for the domain. If a domain contains an entry that is outside these limits, it is ignored.


For users, this affects the primary GID limit. The user will not be returned to NSS if either the UID or the primary GID is outside the range. For non-primary group memberships, those that are in range will be reported as expected.


These ID limits affect even saving entries to cache, not only returning them by name or ID.


Default: 1 for min_id, 0 (no limit) for max_id


.RE


.PP enumerate (bool)


Determines if a domain can be enumerated, that is, whether the domain can list all the users and group it contains. Note that it is not required to enable enumeration in order for secondary groups to be displayed. This parameter can have one of the following values:


TRUE = Users and groups are enumerated


FALSE = No enumerations for this domain


Default: FALSE


Enumerating a domain requires SSSD to download and store ALL user and group entries from the remote server.


Note: Enabling enumeration has a severe performance impact on SSSD while enumeration is running. It may take up to several minutes after SSSD startup to fully complete enumerations. During this time, individual requests for information will go directly to LDAP, though it may be slow, due to the heavy enumeration processing. Saving a large number of entries to cache after the enumeration completes might also be CPU intensive as the memberships have to be recomputed. This can lead to the “sssd_be” process becoming unresponsive or even restarted by the internal watchdog.


While the first enumeration is running, requests for the complete user or group lists may return no results until it completes.


Further, enabling enumeration may increase the time necessary to detect network disconnection, as longer timeouts are required to ensure that enumeration lookups are completed successfully. For more information, refer to the man pages for the specific id_provider in use.


For the reasons cited above, enabling enumeration is not recommended, especially in large environments.


Note: the proxy provider is tested with open source modules like 'libnss_files' and 'libnss_ldap'. 3rd party modules must follow the documented behavior of nss modules to be used in this configuration.


.RE


.PP entry_cache_timeout (integer)


How many seconds should nss_sss consider entries valid before asking the backend again


The cache expiration timestamps are stored as attributes of individual objects in the cache. Therefore, changing the cache timeout only has effect for newly added or expired entries. You should run the sss_cache(8) tool in order to force refresh of entries that have already been cached.


Default: 5400


.RE


.PP entry_cache_user_timeout (integer)


How many seconds should nss_sss consider user entries valid before asking the backend again


Default: entry_cache_timeout


.RE


.PP entry_cache_group_timeout (integer)


How many seconds should nss_sss consider group entries valid before asking the backend again


Default: entry_cache_timeout


.RE


.PP entry_cache_netgroup_timeout (integer)


How many seconds should nss_sss consider netgroup entries valid before asking the backend again


Default: entry_cache_timeout


.RE


.PP entry_cache_service_timeout (integer)


How many seconds should nss_sss consider service entries valid before asking the backend again


Default: entry_cache_timeout


.RE


.PP entry_cache_resolver_timeout (integer)


How many seconds should nss_sss consider hosts and networks entries valid before asking the backend again


Default: entry_cache_timeout


.RE


.PP entry_cache_sudo_timeout (integer)


How many seconds should sudo consider rules valid before asking the backend again


Default: entry_cache_timeout


.RE


.PP entry_cache_autofs_timeout (integer)


How many seconds should the autofs service consider automounter maps valid before asking the backend again


Default: entry_cache_timeout


.RE


.PP entry_cache_ssh_host_timeout (integer)


How many seconds to keep a host ssh key after refresh. IE how long to cache the host key for.


Default: entry_cache_timeout


.RE


.PP entry_cache_computer_timeout (integer)


How many seconds to keep the local computer entry before asking the backend again


Default: entry_cache_timeout


.RE


.PP offline_timeout (integer)


When SSSD switches to offline mode the amount of time before it tries to go back online will increase based upon the time spent disconnected. By default SSSD uses incremental behaviour to calculate delay in between retries. So, the wait time for a given retry will be longer than the wait time for the previous ones. After each unsuccessful attempt to go online, the new interval is recalculated by the following:


new_delay = Minimum(old_delay * 2, offline_timeout_max) + random[0...offline_timeout_random_offset]


The offline_timeout default value is 60. The offline_timeout_max default value is 3600. The offline_timeout_random_offset default value is 30. The end result is the number of seconds before next retry.


Note that the maximum length of each interval is defined by offline_timeout_max (apart from the random part).


Default: 60


.RE


.PP offline_timeout_max (integer)


Controls by how much the time between attempts to go online can be incremented following unsuccessful attempts to go online.


A value of 0 disables the incrementing behaviour.


The value of this parameter should be set in correlation to offline_timeout parameter value.


With offline_timeout set to 60 (default value) there is no point in setting offline_timeout_max to less than 120 as it will saturate instantly. General rule here should be to set offline_timeout_max to at least 4 times offline_timeout.


Although a value between 0 and offline_timeout may be specified, it has the effect of overriding the offline_timeout value so is of little use.


Default: 3600


.RE


.PP offline_timeout_random_offset (integer)


When SSSD is in offline mode it keeps probing backend servers in specified time intervals:


new_delay = Minimum(old_delay * 2, offline_timeout_max) + random[0...offline_timeout_random_offset]


This parameter controls the value of the random offset used for the above equation. Final random_offset value will be random number in range:


[0 - offline_timeout_random_offset]


A value of 0 disables the random offset addition.


Default: 30


.RE


.PP refresh_expired_interval (integer)


Specifies how many seconds SSSD has to wait before triggering a background refresh task which will refresh all expired or nearly expired records.


The background refresh will process users, groups and netgroups in the cache. For users who have performed the initgroups (get group membership for user, typically ran at login) operation in the past, both the user entry and the group membership are updated.


This option is automatically inherited for all trusted domains.


You can consider setting this value to 3/4 * entry_cache_timeout.


Cache entry will be refreshed by background task when 2/3 of cache timeout has already passed. If there are existing cached entries, the background task will refer to their original cache timeout values instead of current configuration value. This may lead to a situation in which background refresh task appears to not be working. This is done by design to improve offline mode operation and reuse of existing valid cache entries. To make this change instant the user may want to manually invalidate existing cache.


Default: 0 (disabled)


.RE


.PP cache_credentials (bool)


Determines if user credentials are also cached in the local LDB cache. The cached credentials refer to passwords, which includes the first (long term) factor of two-factor authentication, not other authentication mechanisms. Passkey and Smartcard authentications are expected to work offline as long as a successful online authentication is recorded in the cache without additional configuration.


Take a note that while credentials are stored as a salted SHA512 hash, this still potentially poses some security risk in case an attacker manages to get access to a cache file (normally requires privileged access) and to break a password using brute force attack.


Default: FALSE


.RE


.PP cache_credentials_minimal_first_factor_length (int)


If 2-Factor-Authentication (2FA) is used and credentials should be saved this value determines the minimal length the first authentication factor (long term password) must have to be saved as SHA512 hash into the cache.


This should avoid that the short PINs of a PIN based 2FA scheme are saved in the cache which would make them easy targets for brute-force attacks.


Default: 8


.RE


.PP account_cache_expiration (integer)


Number of days entries are left in cache after last successful login before being removed during a cleanup of the cache. 0 means keep forever. The value of this parameter must be greater than or equal to offline_credentials_expiration.


Default: 0 (unlimited)


.RE
.PP pwd_expiration_warning (integer)


Display a warning N days before the password expires.


If zero is set, then this filter is not applied, i.e. if the expiration warning was received from backend server, it will automatically be displayed.


Please note that the backend server has to provide information about the expiration time of the password. If this information is missing, sssd cannot display a warning. Also an auth provider has to be configured for the backend.


Default: 7 (Kerberos), 0 (LDAP)


.RE


.PP id_provider (string)


The identification provider used for the domain. Supported ID providers are:


“proxy”: Support a legacy NSS provider.


“ldap”: LDAP provider. See sssd-ldap(5) for more information on configuring LDAP.


“ipa”: FreeIPA and Red Hat Identity Management provider. See sssd-ipa(5) for more information on configuring FreeIPA.


“ad”: Active Directory provider. See sssd-ad(5) for more information on configuring Active Directory.


.RE


.PP use_fully_qualified_names (bool)


Use the full name and domain (as formatted by the domain's full_name_format) as the user's login name reported to NSS.


If set to TRUE, all requests to this domain must use fully qualified names. For example, if used in EXAMPLE domain that contains a "test" user, getent passwd test wouldn't find the user while getent passwd test@EXAMPLE would.


NOTE: This option has no effect on netgroup lookups due to their tendency to include nested netgroups without qualified names. For netgroups, all domains will be searched when an unqualified name is requested.


Default: FALSE (TRUE for trusted domain/sub-domains or if default_domain_suffix is used)


.RE
.PP ignore_group_members (bool)


Do not return group members for group lookups.


If set to TRUE, the group membership attribute is not requested from the ldap server, and group members are not returned when processing group lookup calls, such as getgrnam(3) or getgrgid(3). As an effect, “getent group $groupname” would return the requested group as if it was empty.


Enabling this option can also make access provider checks for group membership significantly faster, especially for groups containing many members.


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


Default: FALSE


.RE
.PP auth_provider (string)


The authentication provider used for the domain. Supported auth providers are:


“ldap” for native LDAP authentication. See sssd-ldap(5) for more information on configuring LDAP.


“krb5” for Kerberos authentication. See sssd-krb5(5) for more information on configuring Kerberos.


“ipa”: FreeIPA and Red Hat Identity Management provider. See sssd-ipa(5) for more information on configuring FreeIPA.


“ad”: Active Directory provider. See sssd-ad(5) for more information on configuring Active Directory.


“proxy” for relaying authentication to some other PAM target.


“none” disables authentication explicitly.


Default: “id_provider” is used if it is set and can handle authentication requests.


.RE
.PP access_provider (string)


The access control provider used for the domain. There are two built-in access providers (in addition to any included in installed backends) Internal special providers are:


“permit” always allow access.


“deny” always deny access.


“ldap” for native LDAP authentication. See sssd-ldap(5) for more information on configuring LDAP.


“ipa”: FreeIPA and Red Hat Identity Management provider. See sssd-ipa(5) for more information on configuring FreeIPA.


“ad”: Active Directory provider. See sssd-ad(5) for more information on configuring Active Directory.


“simple” access control based on access or deny lists. See sssd-simple(5) for more information on configuring the simple access module.


“krb5”: .k5login based access control. See sssd-krb5(5) for more information on configuring Kerberos.


“proxy” for relaying access control to another PAM module.


Default: “permit”


.RE
.PP chpass_provider (string)


The provider which should handle change password operations for the domain. Supported change password providers are:


“ldap” to change a password stored in a LDAP server. See sssd-ldap(5) for more information on configuring LDAP.


“krb5” to change the Kerberos password. See sssd-krb5(5) for more information on configuring Kerberos.


“ipa”: FreeIPA and Red Hat Identity Management provider. See sssd-ipa(5) for more information on configuring FreeIPA.


“ad”: Active Directory provider. See sssd-ad(5) for more information on configuring Active Directory.


“proxy” for relaying password changes to some other PAM target.


“none” disallows password changes explicitly.


Default: “auth_provider” is used if it is set and can handle change password requests.


.RE


.PP sudo_provider (string)


The SUDO provider used for the domain. Supported SUDO providers are:


“ldap” for rules stored in LDAP. See sssd-ldap(5) for more information on configuring LDAP.


“ipa” the same as “ldap” but with IPA default settings.


“ad” the same as “ldap” but with AD default settings.


“none” disables SUDO explicitly.


Default: The value of “id_provider” is used if it is set and can handle sudo requests.


The detailed instructions for configuration of sudo_provider are in the manual page sssd-sudo(5). There are many configuration options that can be used to adjust the behavior. Please refer to "ldap_sudo_*" in sssd-ldap(5).


NOTE: Sudo rules are periodically downloaded in the background unless the sudo provider is explicitly disabled. Set sudo_provider = None to disable all sudo-related activity in SSSD if you do not want to use sudo with SSSD at all.


.RE
.PP selinux_provider (string)


The provider which should handle loading of selinux settings. Note that this provider will be called right after access provider ends. Supported selinux providers are:


“ipa” to load selinux settings from an IPA server. See sssd-ipa(5) for more information on configuring IPA.


“none” disallows fetching selinux settings explicitly.


Default: “id_provider” is used if it is set and can handle selinux loading requests.


.RE
.PP subdomains_provider (string)


The provider which should handle fetching of subdomains. This value should be always the same as id_provider. Supported subdomain providers are:


“ipa” to load a list of subdomains from an IPA server. See sssd-ipa(5) for more information on configuring IPA.


“ad” to load a list of subdomains from an Active Directory server. See sssd-ad(5) for more information on configuring the AD provider.


“none” disallows fetching subdomains explicitly.


Default: The value of “id_provider” is used if it is set and can handle subdomain requests.


.RE
.PP session_provider (string)


The provider which configures and manages user session related tasks. The only user session task currently provided is the integration with Fleet Commander, which works only with IPA. Supported session providers are:


“ipa” to allow performing user session related tasks.


“none” does not perform any kind of user session related tasks.


Default: “none”.


.RE


.PP autofs_provider (string)


The autofs provider used for the domain. Supported autofs providers are:


“ldap” to load maps stored in LDAP. See sssd-ldap(5) for more information on configuring LDAP.


“ipa” to load maps stored in an IPA server. See sssd-ipa(5) for more information on configuring IPA.


“ad” to load maps stored in an AD server. See sssd-ad(5) for more information on configuring the AD provider.


“none” disables autofs explicitly.


Default: The value of “id_provider” is used if it is set and can handle autofs requests.


.RE


.PP hostid_provider (string)


The provider used for retrieving host identity information. Supported hostid providers are:


“ipa” to load host identity stored in an IPA server. See sssd-ipa(5) for more information on configuring IPA.


“none” disables hostid explicitly.


Default: The value of “id_provider” is used if it is set and can handle hostid requests.


.RE


.PP resolver_provider (string)


The provider which should handle hosts and networks lookups. Supported resolver providers are:


“proxy” to forward lookups to another NSS library. See “proxy_resolver_lib_name”


“ldap” to fetch hosts and networks stored in LDAP. See sssd-ldap(5) for more information on configuring LDAP.


“ad” to fetch hosts and networks stored in AD. See sssd-ad(5) for more information on configuring the AD provider.


“none” disallows fetching hosts and networks explicitly.


Default: The value of “id_provider” is used if it is set and can handle resolver requests.


.RE


.PP re_expression (string)


Regular expression for this domain that describes how to parse the string containing user name and domain into these components. The "domain" can match either the SSSD configuration domain name, or, in the case of IPA trust subdomains and Active Directory domains, the flat (NetBIOS) name of the domain.


Default: “^((?P<name>.+)@(?P<domain>[^@]*)|(?P<name>[^@]+))$” which allows two different styles for user names:

•
username


.RE

•
username@domain.name


.RE
.sp


Default for the AD and IPA provider: “^(((?P<domain>[^\\]+)\\(?P<name>.+))|((?P<name>.+)@(?P<domain>[^@]+))|((?P<name>[^@\\]+)))$” which allows three different styles for user names:

•
username


.RE

•
username@domain.name


.RE

•
domain\username


.RE
.sp While the first two correspond to the general default the third one is introduced to allow easy integration of users from Windows domains.


The default re_expression uses the “@” character as a separator between the name and the domain. As a result of this setting the default does not accept the “@” character in short names (as it is allowed in Windows group names). If a user wishes to use short names with “@” they must create their own re_expression.


.RE
.PP full_name_format (string)


A printf(3)-compatible format that describes how to compose a fully qualified name from user name and domain name components.


The following expansions are supported:


.PP %1$s


user name


.RE
.PP %2$s


domain name as specified in the SSSD config file.


.RE
.PP %3$s


domain flat name. Mostly usable for Active Directory domains, both directly configured or discovered via IPA trusts.


.RE
.sp


Default: “%1$s@%2$s”.


.RE


.PP lookup_family_order (string)


Provides the ability to select preferred address family to use when performing DNS lookups.


Supported values:


ipv4_first: Try looking up IPv4 address, if that fails, try IPv6


ipv4_only: Only attempt to resolve hostnames to IPv4 addresses.


ipv6_first: Try looking up IPv6 address, if that fails, try IPv4


ipv6_only: Only attempt to resolve hostnames to IPv6 addresses.


Default: ipv4_first


.RE


.PP dns_resolver_server_timeout (integer)


Defines the amount of time (in milliseconds) SSSD would try to talk to DNS server before trying next DNS server.


The AD provider will use this option for the CLDAP ping timeouts as well.


Please see the section “FAILOVER” for more information about the service resolution.


Default: 1000


.RE


.PP dns_resolver_op_timeout (integer)


Defines the amount of time (in seconds) to wait to resolve single DNS query (e.g. resolution of a hostname or an SRV record) before trying the next hostname or DNS discovery.


Please see the section “FAILOVER” for more information about the service resolution.


Default: 3


.RE


.PP dns_resolver_timeout (integer)


Defines the amount of time (in seconds) to wait for a reply from the internal fail over service before assuming that the service is unreachable. If this timeout is reached, the domain will continue to operate in offline mode.


Please see the section “FAILOVER” for more information about the service resolution.


Default: 6


.RE


.PP dns_resolver_use_search_list (bool)


Normally, the DNS resolver searches the domain list defined in the "search" directive from the resolv.conf file. This can lead to delays in environments with improperly configured DNS.


If fully qualified domain names (or _srv_) are used in the SSSD configuration, setting this option to FALSE can prevent unnecessary DNS lookups in such environments.


Default: TRUE


.RE


.PP dns_discovery_domain (string)


If service discovery is used in the back end, specifies the domain part of the service discovery DNS query.


Default: Use the domain part of machine's hostname


.RE


.PP failover_primary_timeout (integer)


When no primary server is available, SSSD fails over to a backup server. This option defines the number of seconds SSSD waits before attempting to reconnect to the primary server.


Note: The minimum value is 31.


Default: 31


.RE


.PP override_gid (integer)


Override the primary GID value for all users in the domain with specified value.


Default: not set (Use the primary GID value retrieved from the identity provider)


.RE


.PP case_sensitive (string)


Treat user and group names as case sensitive. Possible option values are:


.PP True


Case sensitive. This value is invalid for AD provider.


.RE
.PP False


Case insensitive.


.RE
.PP Preserving


Same as False (case insensitive), but does not lowercase names in the result of NSS operations. Note that name aliases (and in case of services also protocol names) are still lowercased in the output.


If you want to set this value for trusted domain with IPA provider, you need to set it on both the client and SSSD on the server.


.RE
.sp


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


Default: True (False for AD provider)


.RE


.PP avoid_by_id_lookups (boolean)


If this option is set to 'true' SSSD will try to avoid sending lookups by ID to the backend and will switch to a lookup by name if a cached object with a matching ID can be found.


This option can e.g. be used in cases where searches by ID are expensive on the server side because of missing indexes or are not even possible, e.g. due to non-reversible POSIX id-mapping.


Default: False (True for IdP provider)


.RE


.PP subdomain_inherit (string)


Specifies a list of configuration parameters that should be inherited by a subdomain. Please note that only selected parameters can be inherited. Currently the following options can be inherited:


ldap_search_timeout


ldap_network_timeout


ldap_opt_timeout


ldap_offline_timeout


ldap_purge_cache_timeout


ldap_purge_cache_offset


ldap_krb5_keytab (the value of krb5_keytab will be used if ldap_krb5_keytab is not set explicitly)


ldap_krb5_ticket_lifetime


ldap_connection_expire_timeout


ldap_connection_expire_offset


ldap_connection_idle_timeout


ldap_use_tokengroups


ldap_user_principal


ignore_group_members


auto_private_groups


case_sensitive


Example:

subdomain_inherit = ldap_purge_cache_timeout


Default: none


Note: This option only works with the IPA and AD provider.


.RE


.PP subdomain_homedir (string)


Use this homedir as default value for all subdomains within this domain in IPA AD trust. See override_homedir for info about possible values. In addition to those, the expansion below can only be used with subdomain_homedir.


.PP %F


flat (NetBIOS) name of a subdomain.


.RE
.sp


The value can be overridden by override_homedir option.


Default: /home/%d/%u


.RE
.PP realmd_tags (string)


Various tags stored by the realmd configuration service for this domain.


.RE
.PP cached_auth_timeout (int)


Specifies time in seconds since last successful online authentication for which user will be authenticated using cached credentials while SSSD is in the online mode. If the credentials are incorrect, SSSD falls back to online authentication.


This option's value is inherited by all trusted domains. At the moment it is not possible to set a different value per trusted domain.


Special value 0 implies that this feature is disabled.


Please note that if “cached_auth_timeout” is longer than “pam_id_timeout” then the back end could be called to handle “initgroups.”


Default: 0


.RE
.PP local_auth_policy (string)


Local authentication methods policy. Some backends (i.e. LDAP, proxy provider) only support a password based authentication, while others can handle PKINIT based Smartcard authentication (AD, IPA), two-factor authentication (IPA), or other methods against a central instance. By default in such cases authentication is only performed with the methods supported by the backend. With this option additional methods can be enabled which are evaluated and checked locally.


There are three possible values for this option: match, only, enable. “match” is used to match offline and online states for Kerberos methods. “only” ignores the online methods and only offer the local ones. enable allows explicitly defining the methods for local authentication. As an example, “enable:passkey”, only enables passkey for local authentication. Multiple enable values should be comma-separated, such as “enable:passkey, enable:smartcard”


The following table shows which authentication methods, if configured properly, are currently enabled or disabled for each backend, with the default local_auth_policy: “match”


.TS allbox tab(:); cB s s cB cB cB. T{ local_auth_policy = match (default) T} T{   T}:T{ Passkey T}:T{ Smartcard T} c c c c c c c c c. T{ IPA T}:T{ enabled T}:T{ enabled T} T{ AD T}:T{ disabled T}:T{ enabled T} T{ LDAP T}:T{ disabled T}:T{ disabled T}


Please note that if local Smartcard authentication is enabled and a Smartcard is present, Smartcard authentication will be preferred over the authentication methods supported by the backend. I.e. there will be a PIN prompt instead of e.g. a password prompt.


The following configuration example allows local users to authenticate locally using any enabled method (i.e. smartcard, passkey).

[domain/shadowutils]
id_provider = proxy
proxy_lib_name = files
auth_provider = none
local_auth_policy = only


Default: match


.RE
.PP auto_private_groups (string)


This option takes any of three available values:


.PP true


Create user's private group unconditionally from user's UID number. The GID number is ignored in this case.


NOTE: Because the GID number and the user private group are inferred from the UID number, it is not supported to have multiple entries with the same UID or GID number with this option. In other words, enabling this option enforces uniqueness across the ID space.


.RE
.PP false


Always use the user's primary GID number. The GID number must refer to a group object in the LDAP database.


.RE
.PP hybrid


A primary group is autogenerated for user entries whose UID and GID numbers have the same value and at the same time the GID number does not correspond to a real group object in LDAP. If the values are the same, but the primary GID in the user entry is also used by a group object, the primary GID of the user resolves to that group object.


If the UID and GID of a user are different, then the GID must correspond to a group entry, otherwise the GID is simply not resolvable.


This feature is useful for environments that wish to stop maintaining a separate group objects for the user private groups, but also wish to retain the existing user private groups.


.RE
.sp


For the LDAP based id providers (LDAP, IPA and AD) the default for the configured domain is typically False because the sources have the concept of a primary group.


For subdomains, the default value is False for subdomains that use assigned POSIX IDs and True for subdomains that use automatic ID-mapping.


The value of auto_private_groups can either be set per subdomains in a subsection, for example:

[domain/forest.domain/sub.domain]
auto_private_groups = false

or globally for all subdomains in the main domain section using the subdomain_inherit option:

[domain/forest.domain]
subdomain_inherit = auto_private_groups
auto_private_groups = false


.RE


.PP Options valid for proxy domains.


.PP proxy_pam_target (string)


The proxy target PAM proxies to.


Default: not set by default, you have to take an existing pam configuration or create a new one and add the service name here. As an alternative you can enable local authentication with the local_auth_policy option.


.RE


.PP proxy_lib_name (string)


The name of the NSS library to use in proxy domains. The NSS functions searched for in the library are in the form of _nss_$(libName)_$(function), for example _nss_files_getpwent.


.RE


.PP proxy_resolver_lib_name (string)


The name of the NSS library to use for hosts and networks lookups in proxy domains. The NSS functions searched for in the library are in the form of _nss_$(libName)_$(function), for example _nss_dns_gethostbyname2_r.


.RE


.PP proxy_fast_alias (boolean)


When a user or group is looked up by name in the proxy provider, a second lookup by ID is performed to "canonicalize" the name in case the requested name was an alias. Setting this option to true would cause the SSSD to perform the ID lookup from cache for performance reasons.


Default: false


.RE


.PP proxy_max_children (integer)


This option specifies the number of pre-forked proxy children. It is useful for high-load SSSD environments where sssd may run out of available child slots, which would cause some issues due to the requests being queued.


Default: 10


.RE


.SS "Application domains"


.PP SSSD, with its D-Bus interface (see sssd-ifp(5)) is appealing to applications as a gateway to an LDAP directory where users and groups are stored. However, contrary to the traditional SSSD deployment where all users and groups either have POSIX attributes or those attributes can be inferred from the Windows SIDs, in many cases the users and groups in the application support scenario have no POSIX attributes. Instead of setting a “[domain/NAME]” section, the administrator can set up an “[application/NAME]” section that internally represents a domain with type “application” optionally inherits settings from a tradition SSSD domain.


.PP Please note that the application domain must still be explicitly enabled in the “domains” parameter so that the lookup order between the application domain and its POSIX sibling domain is set correctly.

Application domain parameters


.PP inherit_from (string)


The SSSD POSIX-type domain the application domain inherits all settings from. The application domain can moreover add its own settings to the application settings that augment or override the “sibling” domain settings.


Default: Not set


.RE


.PP The following example illustrates the use of an application domain. In this setup, the POSIX domain is connected to an LDAP server and is used by the OS through the NSS responder. In addition, the application domain also requests the telephoneNumber attribute, stores it as the phone attribute in the cache and makes the phone attribute reachable through the D-Bus interface.

[sssd]
domains = appdom, posixdom
[ifp]
user_attributes = +phone
[domain/posixdom]
id_provider = ldap
ldap_uri = ldap://ldap.example.com
ldap_search_base = dc=example,dc=com
[application/appdom]
inherit_from = posixdom
ldap_user_extra_attrs = phone:telephoneNumber


.SH "TRUSTED DOMAIN SECTION"


.PP Some options used in the domain section can also be used in the trusted domain section, that is, in a section called “[domain/DOMAIN_NAME/TRUSTED_DOMAIN_NAME]”. Where DOMAIN_NAME is the actual joined-to base domain. Please refer to examples below for explanation. Currently supported options in the trusted domain section are:


.PP ldap_search_base,


.PP ldap_user_search_base,


.PP ldap_group_search_base,


.PP ldap_netgroup_search_base,


.PP ldap_service_search_base,


.PP ldap_sasl_mech,


.PP ad_server,


.PP ad_backup_server,


.PP ad_site,


.PP use_fully_qualified_names


.PP pam_gssapi_services


.PP pam_gssapi_check_upn


.PP For more details about these options see their individual description in the manual page.


.SH "CERTIFICATE MAPPING SECTION"


.PP To allow authentication with Smartcards and certificates SSSD must be able to map certificates to users. This can be done by adding the full certificate to the LDAP object of the user or to a local override. While using the full certificate is required to use the Smartcard authentication feature of SSH (see sss_ssh_authorizedkeys(8) for details) it might be cumbersome or not even possible to do this for the general case where local services use PAM for authentication.


.PP To make the mapping more flexible mapping and matching rules were added to SSSD (see sss-certmap(5) for details).


.PP A mapping and matching rule can be added to the SSSD configuration in a section on its own with a name like “[certmap/DOMAIN_NAME/RULE_NAME]”. In this section the following options are allowed:


.PP matchrule (string)


Only certificates from the Smartcard which matches this rule will be processed, all others are ignored.


Default: KRB5:<EKU>clientAuth, i.e. only certificates which have the Extended Key Usage “clientAuth”


.RE
.PP maprule (string)


Defines how the user is found for a given certificate.


Default:

•
LDAP:(userCertificate;binary={cert!bin}) for LDAP based providers like “ldap”, “AD” or “ipa”.


.RE

•
If maprule is not set and provider is “proxy”, the RULE_NAME name is assumed to be the name of the matching user.


.RE
.sp


.RE
.PP domains (string)


Comma separated list of domain names the rule should be applied. By default a rule is only valid in the domain configured in sssd.conf. If the provider supports subdomains this option can be used to add the rule to subdomains as well.


Default: the configured domain in sssd.conf


.RE
.PP priority (integer)


Unsigned integer value defining the priority of the rule. The higher the number the lower the priority. “0” stands for the highest priority while “4294967295” is the lowest.


Default: the lowest priority


.RE


.SH "PROMPTING CONFIGURATION SECTION"


.PP If a special file (/var/lib/sss/pubconf/pam_preauth_available) exists SSSD's PAM module pam_sss will ask SSSD to figure out which authentication methods are available for the user trying to log in. Based on the results pam_sss will prompt the user for appropriate credentials.


.PP With the growing number of authentication methods and the possibility that there are multiple ones for a single user the heuristic used by pam_sss to select the prompting might not be suitable for all use cases. The following options should provide a better flexibility here.


.PP Each supported authentication method has its own configuration subsection under “[prompting/...]”. Currently there are:


.PP [prompting/password]


to configure password prompting, allowed options are:

password_prompt


to change the string of the password prompt


.RE


.PP [prompting/2fa]


to configure two-factor authentication prompting, allowed options are:

first_prompt


to change the string of the prompt for the first factor


.RE
.PP second_prompt


to change the string of the prompt for the second factor


.RE
.PP single_prompt


boolean value, if True there will be only a single prompt using the value of first_prompt where it is expected that both factors are entered as a single string. Please note that both factors have to be entered here, even if the second factor is optional.


.RE
.sp If the second factor is optional and it should be possible to log in either only with the password or with both factors two-step prompting has to be used.


Some clients, such as SSH with 'PasswordAuthentication yes', generate their own prompts and do not use prompts provided by SSSD or other PAM modules. Additionally, for SSH with PasswordAuthentication, if two-factor authentication is available, SSSD expects that the credentials entered by the user at the SSH password prompt will always be the two factors in a single string, even if two-factor authentication is optional.


.RE


.PP It is possible to add a subsection for specific PAM services, e.g. “[prompting/password/sshd]” to individual change the prompting for this service.


.SH "EXAMPLES"


.PP 1. The following example shows a typical SSSD config. It does not describe configuration of the domains themselves - refer to documentation on configuring domains for more details.

[sssd]
domains = LDAP
services = nss, pam
[nss]
filter_groups = root
filter_users = root
[pam]
[domain/LDAP]
id_provider = ldap
ldap_uri = ldap://ldap.example.com
ldap_search_base = dc=example,dc=com
auth_provider = krb5
krb5_server = kerberos.example.com
krb5_realm = EXAMPLE.COM
cache_credentials = true
min_id = 10000
max_id = 20000
enumerate = False


.PP 2. The following example shows configuration of IPA AD trust where the AD forest consists of two domains in a parent-child structure. Suppose IPA domain (ipa.com) has trust with AD domain(ad.com). ad.com has child domain (child.ad.com). To enable shortnames in the child domain the following configuration should be used.

[domain/ipa.com/child.ad.com]
use_fully_qualified_names = false


.PP 3. The following example shows the configuration of a certificate mapping rule. It is valid for the configured domain “my.domain” and additionally for the subdomains “your.domain” and uses the full certificate in the search filter.

[certmap/my.domain/rule_name]
matchrule = <ISSUER>^CN=My-CA,DC=MY,DC=DOMAIN$
maprule = (userCertificate;binary={cert!bin})
domains = my.domain, your.domain
priority = 10

.SH "SEE ALSO"


.PP sssd(8), sssd.conf(5), sssd-ldap(5), sssd-ldap-attributes(5), sssd-krb5(5), sssd-simple(5), sssd-ipa(5), sssd-ad(5), sssd-sudo(5), sssd-session-recording(5), sss_cache(8), sss_debuglevel(8), sss_obfuscate(8), sss_seed(8), sssd_krb5_locator_plugin(8), sss_ssh_authorizedkeys(1), sss_ssh_knownhosts(1), sssd-ifp(5), pam_sss(8). sss_rpcidmapd(5)

The SSSD upstream - https://github.com/SSSD/sssd/

09/30/2026 SSSD

sssd-fips 2.13.1-r0 · enterprise-packages · ingested 2026-10-02