1 .TH LDAP.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
7 ldap.conf, .ldaprc \- ldap configuration file
9 ETCDIR/ldap.conf, .ldaprc
11 If the environment variable \fBLDAPNOINIT\fP is defined, all
12 defaulting is disabled.
16 configuration file is used to set system-wide defaults to be applied when
21 Users may create an optional configuration file,
25 in their home directory which will be used to override the system-wide
29 in the current working directory is also used.
32 Additional configuration files can be specified using
33 the \fBLDAPCONF\fP and \fBLDAPRC\fP environment variables.
34 \fBLDAPCONF\fP may be set to the path of a configuration file. This
35 path can be absolute or relative to the current working directory.
36 The \fBLDAPRC\fP, if defined, should be the basename of a file
37 in the current working directory or in the user's home directory.
39 Environmental variables may also be used to augment the file based defaults.
40 The name of the variable is the option name with an added prefix of \fBLDAP\fP.
41 For example, to define \fBBASE\fP via the environment, set the variable
42 \fBLDAPBASE\fP to the desired value.
44 Some options are user\-only. Such options are ignored if present
50 The configuration options are case-insensitive;
51 their value, on a case by case basis, may be case-sensitive.
52 The different configuration options are:
54 .B URI <ldap[s]://[name[:port]] ...>
55 Specifies the URI(s) of an LDAP server(s) to which the
57 library should connect. The URI scheme may be either
61 which refer to LDAP over TCP and LDAP over SSL (TLS) respectively.
62 Each server's name can be specified as a
63 domain-style name or an IP address literal. Optionally, the
64 server's name can followed by a ':' and the port number the LDAP
65 server is listening on. If no port number is provided, the default
66 port for the scheme is used (389 for ldap://, 636 for ldaps://).
67 A space separated list of URIs may be provided.
70 Specifies the default base DN to use when performing ldap operations.
71 The base must be specified as a Distinguished Name in LDAP format.
74 Specifies the default bind DN to use when performing ldap operations.
75 The bind DN must be specified as a Distinguished Name in LDAP format.
76 This is a user\-only option.
78 .B HOST <name[:port] ...>
79 Specifies the name(s) of an LDAP server(s) to which the
81 library should connect. Each server's name can be specified as a
82 domain-style name or an IP address and optionally followed by a ':' and
83 the port number the ldap server is listening on. A space separated
84 list of hosts may be provided.
86 is deprecated in favor of
90 Specifies the default port used when connecting to LDAP servers(s).
91 The port may be specified as a number.
93 is deprecated in favor of
96 .B REFERRALS <on/true/yes/off/false/no>
97 Specifies if the client should automatically follow referrals returned
100 Note that the command line tools
102 &co always override this option.
104 .B SIZELIMIT <integer>
105 Specifies a size limit to use when performing searches. The
106 number should be a non-negative integer. \fISIZELIMIT\fP of zero (0)
107 specifies unlimited search size.
109 .B TIMELIMIT <integer>
110 Specifies a time limit to use when performing searches. The
111 number should be a non-negative integer. \fITIMELIMIT\fP of zero (0)
112 specifies unlimited search time to be used.
115 Specifies how alias dereferencing is done when performing a search. The
117 can be specified as one of the following keywords:
121 Aliases are never dereferenced. This is the default.
124 Aliases are dereferenced in subordinates of the base object, but
125 not in locating the base object of the search.
128 Aliases are only dereferenced when locating the base object of the search.
131 Aliases are dereferenced both in searching and in locating the base object
135 If OpenLDAP is built with Simple Authentication and Security Layer support,
136 there are more options you can specify.
138 .B SASL_MECH <mechanism>
139 Specifies the SASL mechanism to use.
140 This is a user\-only option.
142 .B SASL_REALM <realm>
143 Specifies the SASL realm.
144 This is a user\-only option.
146 .B SASL_AUTHCID <authcid>
147 Specifies the authentication identity.
148 This is a user\-only option.
150 .B SASL_AUTHZID <authcid>
151 Specifies the proxy authorization identity.
152 This is a user\-only option.
154 .B SASL_SECPROPS <properties>
155 Specifies Cyrus SASL security properties. The
157 can be specified as a comma-separated list of the following:
161 (without any other properties) causes the properties
162 defaults ("noanonymous,noplain") to be cleared.
165 disables mechanisms susceptible to simple passive attacks.
168 disables mechanisms susceptible to active attacks.
171 disables mechanisms susceptible to passive dictionary attacks.
174 disables mechanisms which support anonymous login.
177 requires forward secrecy between sessions.
180 requires mechanisms which pass client credentials (and allows
181 mechanisms which can pass credentials to do so).
184 specifies the minimum acceptable
185 .I security strength factor
186 as an integer approximating the effective key length used for
187 encryption. 0 (zero) implies no protection, 1 implies integrity
188 protection only, 56 allows DES or other weak ciphers, 112
189 allows triple DES and other strong ciphers, 128 allows RC4,
190 Blowfish and other modern strong ciphers. The default is 0.
193 specifies the maximum acceptable
194 .I security strength factor
197 description). The default is
200 .B maxbufsize=<factor>
201 specifies the maximum security layer receive buffer
202 size allowed. 0 disables security layers. The default is 65536.
205 If OpenLDAP is built with Transport Layer Security support, there
206 are more options you can specify. These options are used when an
208 is selected (by default or otherwise) or when the application
209 negotiates TLS by issuing the LDAP StartTLS operation.
211 .B TLS_CACERT <filename>
212 Specifies the file that contains certificates for all of the Certificate
213 Authorities the client will recognize.
215 .B TLS_CACERTDIR <path>
216 Specifies the path of a directory that contains Certificate Authority
217 certificates in separate individual files. The
219 is always used before
222 .B TLS_CERT <filename>
223 Specifies the file that contains the client certificate.
224 This is a user\-only option.
226 .B TLS_KEY <filename>
227 Specifies the file that contains the private key that matches the certificate
230 file. Currently, the private key must not be protected with a password, so
231 it is of critical importance that the key file is protected carefully. This
232 is a user\-only option.
234 .B TLS_CIPHER_SUITE <cipher-suite-spec>
235 Specifies acceptable cipher suite and preference order.
236 <cipher-suite-spec> should be a cipher specification for OpenSSL,
237 e.g., HIGH:MEDIUM:+SSLv2.
239 .B TLS_RANDFILE <filename>
240 Specifies the file to obtain random bits from when /dev/[u]random is
241 not available. Generally set to the name of the EGD/PRNGD socket.
242 The environment variable RANDFILE can also be used to specify the filename.
244 .B TLS_REQCERT <level>
245 Specifies what checks to perform on server certificates in a TLS session,
248 can be specified as one of the following keywords:
252 The client will not request or check any server certificate.
255 The server certificate is requested. If no certificate is provided,
256 the session proceeds normally. If a bad certificate is provided, it will
257 be ignored and the session proceeds normally.
260 The server certificate is requested. If no certificate is provided,
261 the session proceeds normally. If a bad certificate is provided,
262 the session is immediately terminated.
265 These keywords are equivalent. The server certificate is requested. If no
266 certificate is provided, or a bad certificate is provided, the session
267 is immediately terminated. This is the default setting.
270 .B TLS_CRLCHECK <level>
271 Specifies if the Certificate Revocation List (CRL) of the CA should be
272 used to verify if the server certificates have not been revoked. This
277 can be specified as one of the following keywords:
281 No CRL checks are performed
284 Check the CRL of the peer certificate
287 Check the CRL for a whole certificate chain
289 .SH "ENVIRONMENT VARIABLES"
292 disable all defaulting
295 path of a configuration file
298 basename of ldaprc file in $HOME or $CWD
301 Set <option-name> as from ldap.conf
305 system-wide ldap configuration file
307 .I $HOME/ldaprc, $HOME/.ldaprc
308 user ldap configuration file
311 local ldap configuration file
317 Kurt Zeilenga, The OpenLDAP Project
320 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
322 is derived from University of Michigan LDAP 3.3 Release.