1 .TH LDAP.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2006 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.
53 Blank lines and lines beginning with a hash mark (`#')
54 are ignored up to their end.
56 Valid lines are made of an option's name (a sequence of non-blanks,
57 conventionally written in uppercase, although not required),
59 The value starts with the first non-blank character after
60 the option's name, and terminates at the end of the line,
61 or at the last sequence of blanks before the end of the line.
62 The tokenization of the value, if any, is delegated to the handler(s)
63 for that option, if any. Quoting values that contain blanks
64 may be incorrect, as the quotes would become part of the value.
67 URI "ldap:// ldaps://"
73 is correct (note the absence of the double quotes).
75 A line cannot be longer than LINE_MAX, which should be more than 2000 bytes
77 There is no mechanism to split a long line on multiple lines, either for
78 beautification or to overcome the above limit.
80 The different configuration options are:
82 .B URI <ldap[si]://[name[:port]] ...>
83 Specifies the URI(s) of an LDAP server(s) to which the
85 library should connect. The URI scheme may be any of
90 which refer to LDAP over TCP, LDAP over SSL (TLS) and LDAP
91 over local sockets, respectively.
92 Each server's name can be specified as a
93 domain-style name or an IP address literal. Optionally, the
94 server's name can followed by a ':' and the port number the LDAP
95 server is listening on. If no port number is provided, the default
96 port for the scheme is used (389 for ldap://, 636 for ldaps://).
97 For LDAP over local sockets,
99 is the name of the socket, and no
101 is allowed; note that directory separators must be URL-encoded,
102 like any other characters that are special to URLs; so the socket
108 ldapi://%2Fusr%2Flocal%2Fvar%2Fldapi
110 A space separated list of URIs may be provided.
113 Specifies the default base DN to use when performing ldap operations.
114 The base must be specified as a Distinguished Name in LDAP format.
117 Specifies the default bind DN to use when performing ldap operations.
118 The bind DN must be specified as a Distinguished Name in LDAP format.
119 .B This is a user\-only option.
121 .B HOST <name[:port] ...>
122 Specifies the name(s) of an LDAP server(s) to which the
124 library should connect. Each server's name can be specified as a
125 domain-style name or an IP address and optionally followed by a ':' and
126 the port number the ldap server is listening on. A space separated
127 list of hosts may be provided.
129 is deprecated in favor of
133 Specifies the default port used when connecting to LDAP servers(s).
134 The port may be specified as a number.
136 is deprecated in favor of
139 .B REFERRALS <on/true/yes/off/false/no>
140 Specifies if the client should automatically follow referrals returned
143 Note that the command line tools
145 &co always override this option.
147 .B SIZELIMIT <integer>
148 Specifies a size limit to use when performing searches. The
149 number should be a non-negative integer. \fISIZELIMIT\fP of zero (0)
150 specifies unlimited search size.
152 .B TIMELIMIT <integer>
153 Specifies a time limit to use when performing searches. The
154 number should be a non-negative integer. \fITIMELIMIT\fP of zero (0)
155 specifies unlimited search time to be used.
158 Specifies how alias dereferencing is done when performing a search. The
160 can be specified as one of the following keywords:
164 Aliases are never dereferenced. This is the default.
167 Aliases are dereferenced in subordinates of the base object, but
168 not in locating the base object of the search.
171 Aliases are only dereferenced when locating the base object of the search.
174 Aliases are dereferenced both in searching and in locating the base object
179 Specifies what version of the LDAP protocol should be used.
182 Specifies a generic timeout (in seconds). Currently ignored.
184 .B NETWORK_TIMEOUT <integer>
185 Specifies the timeout (in seconds) after which the poll(2)/select(2)
186 following a connect(2) returns in case of no activity.
188 If OpenLDAP is built with Simple Authentication and Security Layer support,
189 there are more options you can specify.
191 .B SASL_MECH <mechanism>
192 Specifies the SASL mechanism to use.
193 .B This is a user\-only option.
195 .B SASL_REALM <realm>
196 Specifies the SASL realm.
197 .B This is a user\-only option.
199 .B SASL_AUTHCID <authcid>
200 Specifies the authentication identity.
201 .B This is a user\-only option.
203 .B SASL_AUTHZID <authcid>
204 Specifies the proxy authorization identity.
205 .B This is a user\-only option.
207 .B SASL_SECPROPS <properties>
208 Specifies Cyrus SASL security properties. The
210 can be specified as a comma-separated list of the following:
214 (without any other properties) causes the properties
215 defaults ("noanonymous,noplain") to be cleared.
218 disables mechanisms susceptible to simple passive attacks.
221 disables mechanisms susceptible to active attacks.
224 disables mechanisms susceptible to passive dictionary attacks.
227 disables mechanisms which support anonymous login.
230 requires forward secrecy between sessions.
233 requires mechanisms which pass client credentials (and allows
234 mechanisms which can pass credentials to do so).
237 specifies the minimum acceptable
238 .I security strength factor
239 as an integer approximating the effective key length used for
240 encryption. 0 (zero) implies no protection, 1 implies integrity
241 protection only, 56 allows DES or other weak ciphers, 112
242 allows triple DES and other strong ciphers, 128 allows RC4,
243 Blowfish and other modern strong ciphers. The default is 0.
246 specifies the maximum acceptable
247 .I security strength factor
250 description). The default is
253 .B maxbufsize=<factor>
254 specifies the maximum security layer receive buffer
255 size allowed. 0 disables security layers. The default is 65536.
258 If OpenLDAP is built with Transport Layer Security support, there
259 are more options you can specify. These options are used when an
261 is selected (by default or otherwise) or when the application
262 negotiates TLS by issuing the LDAP StartTLS operation.
264 .B TLS_CACERT <filename>
265 Specifies the file that contains certificates for all of the Certificate
266 Authorities the client will recognize.
268 .B TLS_CACERTDIR <path>
269 Specifies the path of a directory that contains Certificate Authority
270 certificates in separate individual files. The
272 is always used before
275 .B TLS_CERT <filename>
276 Specifies the file that contains the client certificate.
277 .B This is a user\-only option.
279 .B TLS_KEY <filename>
280 Specifies the file that contains the private key that matches the certificate
283 file. Currently, the private key must not be protected with a password, so
284 it is of critical importance that the key file is protected carefully.
285 .B This is a user\-only option.
287 .B TLS_CIPHER_SUITE <cipher-suite-spec>
288 Specifies acceptable cipher suite and preference order.
289 <cipher-suite-spec> should be a cipher specification for OpenSSL,
290 e.g., HIGH:MEDIUM:+SSLv2.
292 .B TLS_RANDFILE <filename>
293 Specifies the file to obtain random bits from when /dev/[u]random is
294 not available. Generally set to the name of the EGD/PRNGD socket.
295 The environment variable RANDFILE can also be used to specify the filename.
297 .B TLS_REQCERT <level>
298 Specifies what checks to perform on server certificates in a TLS session,
301 can be specified as one of the following keywords:
305 The client will not request or check any server certificate.
308 The server certificate is requested. If no certificate is provided,
309 the session proceeds normally. If a bad certificate is provided, it will
310 be ignored and the session proceeds normally.
313 The server certificate is requested. If no certificate is provided,
314 the session proceeds normally. If a bad certificate is provided,
315 the session is immediately terminated.
318 These keywords are equivalent. The server certificate is requested. If no
319 certificate is provided, or a bad certificate is provided, the session
320 is immediately terminated. This is the default setting.
323 .B TLS_CRLCHECK <level>
324 Specifies if the Certificate Revocation List (CRL) of the CA should be
325 used to verify if the server certificates have not been revoked. This
330 can be specified as one of the following keywords:
334 No CRL checks are performed
337 Check the CRL of the peer certificate
340 Check the CRL for a whole certificate chain
342 .SH "ENVIRONMENT VARIABLES"
345 disable all defaulting
348 path of a configuration file
351 basename of ldaprc file in $HOME or $CWD
354 Set <option-name> as from ldap.conf
358 system-wide ldap configuration file
360 .I $HOME/ldaprc, $HOME/.ldaprc
361 user ldap configuration file
364 local ldap configuration file
370 Kurt Zeilenga, The OpenLDAP Project
373 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
375 is derived from University of Michigan LDAP 3.3 Release.