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.
6 ldap.conf, .ldaprc \- ldap configuration file
8 ETCDIR/ldap.conf, .ldaprc
10 If the environment variable \fBLDAPNOINIT\fP is defined, all
11 defaulting is disabled.
15 configuration file is used to set system-wide defaults to be applied when
20 Users may create an optional configuration file,
24 in their home directory which will be used to override the system-wide
28 in the current working directory is also used.
31 Additional configuration files can be specified using
32 the \fBLDAPCONF\fP and \fBLDAPRC\fP environment variables.
33 \fBLDAPCONF\fP may be set to the path of a configuration file. This
34 path can be absolute or relative to the current working directory.
35 The \fBLDAPRC\fP, if defined, should be the basename of a file
36 in the current working directory or in the user's home directory.
38 Environmental variables may also be used to augment the file based defaults.
39 The name of the variable is the option name with an added prefix of \fBLDAP\fP.
40 For example, to define \fBBASE\fP via the environment, set the variable
41 \fBLDAPBASE\fP to the desired value.
43 Some options are user\-only. Such options are ignored if present
49 The configuration options are case-insensitive;
50 their value, on a case by case basis, may be case-sensitive.
52 Blank lines and lines beginning with a hash mark (`#')
53 are ignored up to their end.
55 Valid lines are made of an option's name (a sequence of non-blanks,
56 conventionally written in uppercase, although not required),
58 The value starts with the first non-blank character after
59 the option's name, and terminates at the end of the line,
60 or at the last sequence of blanks before the end of the line.
61 The tokenization of the value, if any, is delegated to the handler(s)
62 for that option, if any. Quoting values that contain blanks
63 may be incorrect, as the quotes would become part of the value.
66 URI "ldap:// ldaps://"
72 is correct (note the absence of the double quotes).
74 A line cannot be longer than LINE_MAX, which should be more than 2000 bytes
76 There is no mechanism to split a long line on multiple lines, either for
77 beautification or to overcome the above limit.
79 The different configuration options are:
81 .B URI <ldap[si]://[name[:port]] ...>
82 Specifies the URI(s) of an LDAP server(s) to which the
84 library should connect. The URI scheme may be any of
89 which refer to LDAP over TCP, LDAP over SSL (TLS) and LDAP
90 over IPC (UNIX domain sockets), respectively.
91 Each server's name can be specified as a
92 domain-style name or an IP address literal. Optionally, the
93 server's name can followed by a ':' and the port number the LDAP
94 server is listening on. If no port number is provided, the default
95 port for the scheme is used (389 for ldap://, 636 for ldaps://).
98 is the name of the socket, and no
100 is required, nor allowed; note that directory separators must be
101 URL-encoded, like any other characters that are special to URLs;
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.
122 Specifies how alias dereferencing is done when performing a search. The
124 can be specified as one of the following keywords:
128 Aliases are never dereferenced. This is the default.
131 Aliases are dereferenced in subordinates of the base object, but
132 not in locating the base object of the search.
135 Aliases are only dereferenced when locating the base object of the search.
138 Aliases are dereferenced both in searching and in locating the base object
143 .B HOST <name[:port] ...>
144 Specifies the name(s) of an LDAP server(s) to which the
146 library should connect. Each server's name can be specified as a
147 domain-style name or an IP address and optionally followed by a ':' and
148 the port number the ldap server is listening on. A space separated
149 list of hosts may be provided.
151 is deprecated in favor of
154 .B NETWORK_TIMEOUT <integer>
155 Specifies the timeout (in seconds) after which the poll(2)/select(2)
156 following a connect(2) returns in case of no activity.
159 Specifies the default port used when connecting to LDAP servers(s).
160 The port may be specified as a number.
162 is deprecated in favor of
165 .B REFERRALS <on/true/yes/off/false/no>
166 Specifies if the client should automatically follow referrals returned
169 Note that the command line tools
171 &co always override this option.
172 .\" This should only be allowed via ldap_set_option(3)
174 .\".B RESTART <on/true/yes/off/false/no>
175 .\"Determines whether the library should implicitly restart connections (FIXME).
177 .B SIZELIMIT <integer>
178 Specifies a size limit to use when performing searches. The
179 number should be a non-negative integer. \fISIZELIMIT\fP of zero (0)
180 specifies unlimited search size.
182 .B TIMELIMIT <integer>
183 Specifies a time limit to use when performing searches. The
184 number should be a non-negative integer. \fITIMELIMIT\fP of zero (0)
185 specifies unlimited search time to be used.
187 Specifies what version of the LDAP protocol should be used.
190 Specifies a generic timeout (in seconds). Currently ignored.
192 If OpenLDAP is built with Simple Authentication and Security Layer support,
193 there are more options you can specify.
195 .B SASL_MECH <mechanism>
196 Specifies the SASL mechanism to use.
197 .B This is a user\-only option.
199 .B SASL_REALM <realm>
200 Specifies the SASL realm.
201 .B This is a user\-only option.
203 .B SASL_AUTHCID <authcid>
204 Specifies the authentication identity.
205 .B This is a user\-only option.
207 .B SASL_AUTHZID <authcid>
208 Specifies the proxy authorization identity.
209 .B This is a user\-only option.
211 .B SASL_SECPROPS <properties>
212 Specifies Cyrus SASL security properties. The
214 can be specified as a comma-separated list of the following:
218 (without any other properties) causes the properties
219 defaults ("noanonymous,noplain") to be cleared.
222 disables mechanisms susceptible to simple passive attacks.
225 disables mechanisms susceptible to active attacks.
228 disables mechanisms susceptible to passive dictionary attacks.
231 disables mechanisms which support anonymous login.
234 requires forward secrecy between sessions.
237 requires mechanisms which pass client credentials (and allows
238 mechanisms which can pass credentials to do so).
241 specifies the minimum acceptable
242 .I security strength factor
243 as an integer approximating the effective key length used for
244 encryption. 0 (zero) implies no protection, 1 implies integrity
245 protection only, 56 allows DES or other weak ciphers, 112
246 allows triple DES and other strong ciphers, 128 allows RC4,
247 Blowfish and other modern strong ciphers. The default is 0.
250 specifies the maximum acceptable
251 .I security strength factor
254 description). The default is
257 .B maxbufsize=<factor>
258 specifies the maximum security layer receive buffer
259 size allowed. 0 disables security layers. The default is 65536.
262 If OpenLDAP is built with Transport Layer Security support, there
263 are more options you can specify. These options are used when an
265 is selected (by default or otherwise) or when the application
266 negotiates TLS by issuing the LDAP StartTLS operation.
268 .B TLS_CACERT <filename>
269 Specifies the file that contains certificates for all of the Certificate
270 Authorities the client will recognize.
272 .B TLS_CACERTDIR <path>
273 Specifies the path of a directory that contains Certificate Authority
274 certificates in separate individual files. The
276 is always used before
279 .B TLS_CERT <filename>
280 Specifies the file that contains the client certificate.
281 .B This is a user\-only option.
283 .B TLS_KEY <filename>
284 Specifies the file that contains the private key that matches the certificate
287 file. Currently, the private key must not be protected with a password, so
288 it is of critical importance that the key file is protected carefully.
289 .B This is a user\-only option.
291 .B TLS_CIPHER_SUITE <cipher-suite-spec>
292 Specifies acceptable cipher suite and preference order.
293 <cipher-suite-spec> should be a cipher specification for OpenSSL,
294 e.g., HIGH:MEDIUM:+SSLv2.
296 .B TLS_RANDFILE <filename>
297 Specifies the file to obtain random bits from when /dev/[u]random is
298 not available. Generally set to the name of the EGD/PRNGD socket.
299 The environment variable RANDFILE can also be used to specify the filename.
301 .B TLS_REQCERT <level>
302 Specifies what checks to perform on server certificates in a TLS session,
305 can be specified as one of the following keywords:
309 The client will not request or check any server certificate.
312 The server certificate is requested. If no certificate is provided,
313 the session proceeds normally. If a bad certificate is provided, it will
314 be ignored and the session proceeds normally.
317 The server certificate is requested. If no certificate is provided,
318 the session proceeds normally. If a bad certificate is provided,
319 the session is immediately terminated.
322 These keywords are equivalent. The server certificate is requested. If no
323 certificate is provided, or a bad certificate is provided, the session
324 is immediately terminated. This is the default setting.
327 .B TLS_CRLCHECK <level>
328 Specifies if the Certificate Revocation List (CRL) of the CA should be
329 used to verify if the server certificates have not been revoked. This
334 can be specified as one of the following keywords:
338 No CRL checks are performed
341 Check the CRL of the peer certificate
344 Check the CRL for a whole certificate chain
346 .SH "ENVIRONMENT VARIABLES"
349 disable all defaulting
352 path of a configuration file
355 basename of ldaprc file in $HOME or $CWD
358 Set <option-name> as from ldap.conf
362 system-wide ldap configuration file
364 .I $HOME/ldaprc, $HOME/.ldaprc
365 user ldap configuration file
368 local ldap configuration file
374 Kurt Zeilenga, The OpenLDAP Project
377 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
379 is derived from University of Michigan LDAP 3.3 Release.