MAN page from Fedora 5 openldap-2.3.19-4.x86_64.rpm
Section: File Formats (5)
ldap.conf, .ldaprc - ldap configuration file
If the environment variable LDAPNOINIT
is defined, alldefaulting is disabled.
Theldap.confconfiguration file is used to set system-wide defaults to be applied whenrunningldapclients.
Users may create an optional configuration file,ldaprcor.ldaprc,in their home directory which will be used to override the system-widedefaults file.The fileldaprcin the current working directory is also used.
Additional configuration files can be specified usingthe LDAPCONF and LDAPRC environment variables.LDAPCONF may be set to the path of a configuration file. Thispath can be absolute or relative to the current working directory.The LDAPRC, if defined, should be the basename of a filein the current working directory or in the user's home directory.
Environmental variables may also be used to augment the file based defaults.The name of the variable is the option name with an added prefix of LDAP.For example, to define BASE via the environment, set the variableLDAPBASE to the desired value.
Some options are user-only. Such options are ignored if presentin theldap.conf(or file specified byLDAPCONF).
The configuration options are case-insensitive;their value, on a case by case basis, may be case-sensitive.The different configuration options are:
- URI <ldap[s]://[name[:port]] ...>
- Specifies the URI(s) of an LDAP server(s) to which theLDAP library should connect. The URI scheme may be eitherldaporldaps which refer to LDAP over TCP and LDAP over SSL (TLS) respectively.Each server's name can be specified as adomain-style name or an IP address literal. Optionally, theserver's name can followed by a ':' and the port number the LDAPserver is listening on. If no port number is provided, the defaultport for the scheme is used (389 for ldap://, 636 for ldaps://).A space separated list of URIs may be provided.
- BASE <base>
- Specifies the default base DN to use when performing ldap operations.The base must be specified as a Distinguished Name in LDAP format.
- BINDDN <dn>
- Specifies the default bind DN to use when performing ldap operations.The bind DN must be specified as a Distinguished Name in LDAP format.This is a user-only option.
- HOST <name[:port] ...>
- Specifies the name(s) of an LDAP server(s) to which theLDAP library should connect. Each server's name can be specified as adomain-style name or an IP address and optionally followed by a ':' andthe port number the ldap server is listening on. A space separatedlist of hosts may be provided.HOSTis deprecated in favor ofURI.
- PORT <port>
- Specifies the default port used when connecting to LDAP servers(s).The port may be specified as a number.PORTis deprecated in favor ofURI.
- REFERRALS <on/true/yes/off/false/no>
- Specifies if the client should automatically follow referrals returnedby LDAP servers.The default is on.Note that the command line toolsldapsearch(1)&co always override this option.
- SIZELIMIT <integer>
- Specifies a size limit to use when performing searches. Thenumber should be a non-negative integer. SIZELIMIT of zero (0)specifies unlimited search size.
- TIMELIMIT <integer>
- Specifies a time limit to use when performing searches. Thenumber should be a non-negative integer. TIMELIMIT of zero (0)specifies unlimited search time to be used.
- DEREF <when>
- Specifies how alias dereferencing is done when performing a search. The<when>can be specified as one of the following keywords:
- Aliases are never dereferenced. This is the default.
- Aliases are dereferenced in subordinates of the base object, butnot in locating the base object of the search.
- Aliases are only dereferenced when locating the base object of the search.
- Aliases are dereferenced both in searching and in locating the base objectof the search.
If OpenLDAP is built with Simple Authentication and Security Layer support,there are more options you can specify.
- SASL_MECH <mechanism>
- Specifies the SASL mechanism to use.This is a user-only option.
- SASL_REALM <realm>
- Specifies the SASL realm.This is a user-only option.
- SASL_AUTHCID <authcid>
- Specifies the authentication identity.This is a user-only option.
- SASL_AUTHZID <authcid>
- Specifies the proxy authorization identity.This is a user-only option.
- SASL_SECPROPS <properties>
- Specifies Cyrus SASL security properties. The <properties>can be specified as a comma-separated list of the following:
- (without any other properties) causes the propertiesdefaults ("noanonymous,noplain") to be cleared.
- disables mechanisms susceptible to simple passive attacks.
- disables mechanisms susceptible to active attacks.
- disables mechanisms susceptible to passive dictionary attacks.
- disables mechanisms which support anonymous login.
- requires forward secrecy between sessions.
- requires mechanisms which pass client credentials (and allowsmechanisms which can pass credentials to do so).
- specifies the minimum acceptablesecurity strength factoras an integer approximating the effective key length used forencryption. 0 (zero) implies no protection, 1 implies integrityprotection only, 56 allows DES or other weak ciphers, 112allows triple DES and other strong ciphers, 128 allows RC4,Blowfish and other modern strong ciphers. The default is 0.
- specifies the maximum acceptablesecurity strength factoras an integer (seeminssfdescription). The default isINT_MAX.
- specifies the maximum security layer receive buffersize allowed. 0 disables security layers. The default is 65536.
If OpenLDAP is built with Transport Layer Security support, thereare more options you can specify. These options are used when anldaps:// URI
is selected (by default or otherwise) or when the applicationnegotiates TLS by issuing the LDAP Start TLS operation.
- TLS_CACERT <filename>
- Specifies the file that contains certificates for all of the CertificateAuthorities the client will recognize.
- TLS_CACERTDIR <path>
- Specifies the path of a directory that contains Certificate Authoritycertificates in separate individual files. TheTLS_CACERTis always used beforeTLS_CACERTDIR.
- TLS_CERT <filename>
- Specifies the file that contains the client certificate.This is a user-only option.
- TLS_KEY <filename>
- Specifies the file that contains the private key that matches the certificatestored in theTLS_CERTfile. Currently, the private key must not be protected with a password, soit is of critical importance that the key file is protected carefully. Thisis a user-only option.
- TLS_CIPHER_SUITE <cipher-suite-spec>
- Specifies acceptable cipher suite and preference order.<cipher-suite-spec> should be a cipher specification for OpenSSL,e.g., HIGH:MEDIUM:+SSLv2.
- TLS_RANDFILE <filename>
- Specifies the file to obtain random bits from when /dev/[u]random isnot available. Generally set to the name of the EGD/PRNGD socket.The environment variable RANDFILE can also be used to specify the filename.
- TLS_REQCERT <level>
- Specifies what checks to perform on server certificates in a TLS session,if any. The<level>can be specified as one of the following keywords:
- The client will not request or check any server certificate.
- The server certificate is requested. If no certificate is provided,the session proceeds normally. If a bad certificate is provided, it willbe ignored and the session proceeds normally.
- The server certificate is requested. If no certificate is provided,the session proceeds normally. If a bad certificate is provided,the session is immediately terminated.
- demand | hard
- These keywords are equivalent. The server certificate is requested. If nocertificate is provided, or a bad certificate is provided, the sessionis immediately terminated. This is the default setting.
- TLS_CRLCHECK <level>
- Specifies if the Certificate Revocation List (CRL) of the CA should be used to verify if the server certificates have not been revoked. ThisrequiresTLS_CACERTDIRparameter to be set.<level>can be specified as one of the following keywords:
- No CRL checks are performed
- Check the CRL of the peer certificate
- Check the CRL for a whole certificate chain
- disable all defaulting
- path of a configuration file
- basename of ldaprc file in $HOME or $CWD
- Set <option-name> as from ldap.conf
- system-wide ldap configuration file
- $HOME/ldaprc, $HOME/.ldaprc
- user ldap configuration file
- local ldap configuration file
Kurt Zeilenga, The OpenLDAP Project
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.
- SASL OPTIONS
- TLS OPTIONS
- ENVIRONMENT VARIABLES
- SEE ALSO
This document was created byman2html,using the manual pages.