--- name: "nss-ldapd.conf" section: "5" platform: "linux" package: "libnss-ldapd" version: "0.6.7.2" release: "Debian 5.0 (Lenny)" platforms: ["linux"] url: "https://new.carta.tech/nss-ldapd.conf" --- # nss-ldapd.conf(5) configuration file for LDAP nameservice provider ## NAME nss-ldapd.conf - configuration file for LDAP nameservice provider ## DESCRIPTION The *nss-ldapd* module allows LDAP directory servers to be used as a primary source of name service information. (Name service information typically includes users, hosts, groups, and other such data historically stored in flat files or NIS.) The file FC*nss-ldapd.conf*F\[0\] contains the configuration information for running **nslcd** (see [**nslcd**(8)](/nslcd/8.md)). The file contains options, one on each line, defining the way NSS lookups are mapped onto LDAP lookups. ## OPTIONS ### RUNTIME OPTIONS - FC**threads**F\[0\] *NUM* Specifies the number of threads to start that can handle requests and perform LDAP queries. The default is to start 5 threads. - FC**uid**F\[0\] *UID* This specifies which user id with which the daemon should be run. This can be a numerical id or a symbolic value. If no uid is specified no attempt to change the user will be made. Note that you should use values that don't need LDAP to resolve. - FC**gid**F\[0\] *GID* This specifies which group id with which the daemon should be run. This can be a numerical id or a symbolic value. If no gid is specified no attempt to change the group will be made. Note that you should use values that don't need LDAP to resolve. ### GENERAL CONNECTION OPTIONS - FC**uri**F\[0\] *URI* Specifies the LDAP URI of the server to connect to. The URI scheme may be *ldap*, *ldapi* or *ldaps*, specifying LDAP over TCP, ICP or SSL respectively (if supported by the LDAP library). Alternatively, the value *DNS* may be used to try to lookup the server using DNS SRV records. When using the ldapi scheme, %2f should be used to escape slashes (e.g. ldapi://%2fvar%2frun%2fslapd%2fldapi/), although most of the time this should not be needed. This option may be specified multiple times. Normally, only the first server will be used with the following servers as fall-back (see FC**bind\_timelimit**F\[0\] below). If LDAP lookups are used for host name resolution, any host names should be specified as an IP address or name that can be resolved without using LDAP. - FC**ldap\_version**F\[0\] *VERSION* Specifies the version of the LDAP protocol to use. The default is to use the maximum version supported by the LDAP library. - FC**binddn**F\[0\] *DN* Specifies the distinguished name with which to bind to the directory server for lookups. The default is to bind anonymously. - FC**bindpw**F\[0\] *PASSWORD* Specifies the clear text credentials with which to bind. This option is only applicable when used with FC**binddn**F\[0\] above. ### KERBEROS AUTHENTICATION OPTIONS - FC**krb5\_ccname**F\[0\] *NAME* Set the name for the GSS-API Kerberos credentials cache. ### SEARCH/MAPPING OPTIONS - FC**base**F\[0\] \[*MAP*\] *DN* Specifies the base distinguished name (DN) to use as search base. A global search base may be specified or a MAP-specific one. If no MAP-specific search base is defined the global one is used. If, instead of a DN, the value *DOMAIN* is specified, the host's DNS domain is used to construct a search base. If this value is not defined an attempt is made to look it up in the configured LDAP server. Note that if the LDAP server is unavailable during start-up **nslcd** will not start. - FC**scope**F\[0\] \[*MAP*\] sub\[tree\]\|one\[level\]\|base Specifies the search scope (subtree, one level or base object). The default scope is subtree; base scope is almost never useful for name service lookups. - FC**deref**F\[0\] never\|searching\|finding\|always Specifies the policy for dereferencing aliases. The default policy is to never dereference aliases. - FC**referrals**F\[0\] yes\|no Specifies whether automatic referral chasing should be enabled. The default behaviour is to chase referrals. - FC**filter**F\[0\] *MAP* *FILTER* The *FILTER* is an LDAP search filter to use for a specific map. The default filter is a basic search on the objectClass for the map (e.g. FC(objectClass=posixAccount)F\[0\]). - FC**map**F\[0\] *MAP* *ATTRIBUTE* *NEWATTRIBUTE* This option allows for custom attributes to be looked up instead of the default RFC 2307 attributes. The *MAP* may be one of the supported maps below. The *ATTRIBUTE* is the one as used in RFC 2307 (e.g. FCuserPasswordF\[0\], FCipProtocolNumberF\[0\] or FCmacAddressF\[0\]). The *NEWATTRIBUTE* may be any attribute as it is available in the directory. ### TIMING/RECONNECT OPTIONS - FC**bind\_timelimit**F\[0\] *SECONDS* Specifies the time limit (in seconds) to use when connecting to the directory server. This is distinct from the time limit specified in FC**timelimit**F\[0\] and affects the setup of the connection only. Note that not all LDAP client libraries have support for setting the connection time out. The default FC**bind\_timelimit**F\[0\] is 30 seconds. - FC**timelimit**F\[0\] *SECONDS* Specifies the time limit (in seconds) to wait for a response from the LDAP server. A value of zero (0), which is the default, is to wait indefinitely for searches to be completed. - FC**idle\_timelimit**F\[0\] *SECONDS* Specifies the period if inactivity (in seconds) after which the connection to the LDAP server will be closed. The default is not to time out connections. - FC**reconnect\_sleeptime**F\[0\] *SECONDS* Specifies the number of seconds to sleep when connecting to all LDAP servers fails. By default 1 second is waited between the first failure and the first retry. - FC**reconnect\_maxsleeptime**F\[0\] *SECONDS* Specified the time after the last successful operation from which the LDAP server is considered permanently unavailable. Retries will be done only once in this time period. The default value is 30 seconds. Note that the reconnect logic as described above is the mechanism that is used between **nslcd** and the LDAP server. The mechanism between the NSS client library and **nslcd** is simpler with a fixed compiled-in time out of a 10 seconds for writing to **nslcd** and a time out of 60 seconds for reading answers. **nslcd** itself has a read time out of 0.5 seconds and a write time out of 60 seconds. ### SSL/TLS OPTIONS - FC**ssl**F\[0\] on\|off\|start\_tls Specifies whether to use SSL/TLS or not (the default is not to). If *start\_tls* is specified then StartTLS is used rather than raw LDAP over SSL. Not all LDAP client libraries support both SSL and StartTLS, and all related configuration options. - FC**sslpath**F\[0\] *PATH* For the Netscape and Mozilla LDAP client libraries only, this specifies the path to the X.509 certificate database. - FC**tls\_checkpeer**F\[0\] yes\|no Specifies whether to require and verify the server certificate or not, when using SSL/TLS with the OpenLDAP client library. The default is to use the default behaviour of the client library; for OpenLDAP 2.0 and earlier it is "no", for OpenLDAP 2.1 and later it is "yes". At least one of FC**tls\_cacertdir**F\[0\] and FC**tls\_cacertfile**F\[0\] is required if peer verification is enabled. - FC**tls\_cacertdir**F\[0\] *PATH* Specifies the directory containing X.509 certificates for peer authentication. - FC**tls\_cacertfile**F\[0\] *PATH* Specifies the path to the X.509 certificate for peer authentication. - FC**tls\_randfile**F\[0\] *PATH* Specifies the path to an entropy source. - FC**tls\_ciphers**F\[0\] *CIPHERS* Specifies the ciphers to use for TLS. See your TLS implementation's documentation for further information. - FC**tls\_cert**F\[0\] *PATH* Specifies the path to the file containing the local certificate for client TLS authentication. - FC**tls\_key**F\[0\] *PATH* Specifies the path to the file containing the private key for client TLS authentication. ### OTHER OPTIONS - FC**pagesize**F\[0\] *NUMBER* Set this to a number greater than 0 to request paged results from the LDAP server in accordance with RFC2696. The default (0) is to not request paged results. This is useful for LDAP servers that contain a lot of entries (e.g. more than 500) and limit the number of entries that are returned with one request. For OpenLDAP servers you may need to set FC**sizelimit size.prtotal=unlimited**F\[0\] for allowing more entries to be returned over multiple pages. ## SUPPORTED MAPS The following maps are supported. They are referenced as *MAP* in the options above. - alias\[es\] Mail aliases. Note that most mail servers do not use the NSS interface for requesting mail aliases and parse FC*/etc/aliases*F\[0\] on their own. - ether\[s\] Ethernet numbers (mac addresses). - group Posix groups. - host\[s\] Host names. - netgroup Host and user groups used for access control. - network\[s\] Network numbers. - passwd Posix users. - protocol\[s\] Protocol definitions (like in FC*/etc/protocols*F\[0\]). - rpc Remote procedure call names and numbers. - service\[s\] Network service names and numbers. - shadow Shadow user password information. ## FILES - FC*/etc/nss-ldapd.conf*F\[0\] the main configuration file - FC*/etc/nsswitch.conf*F\[0\] Name Service Switch configuration file ## SEE ALSO [**nslcd**(8)](/nslcd/8.md), [**nsswitch.conf**(5)](/nsswitch.conf/5.md) ## AUTHOR This manual was written by Arthur de Jong \ and is based on the **nss\_ldap**(5) manual developed by PADL Software Pty Ltd. ## KNOWN BUGS This manual page may be outdated and inaccurate and will be improved in upcoming releases. The features of *nss-ldapd* are still under development so these options may change in a future release.