1 .TH LDAP.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2004 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
60 which refer to LDAP over TCP and LDAP over SSL (TLS) respectively.
61 Each server's name can be specified as a
62 domain-style name or an IP address literal. Optionally, the
63 server's name can followed by a ':' and the port number the LDAP
64 server is listening on. If no port number is provided, the default
65 port for the scheme is used (389 for ldap://, 636 for ldaps://).
66 A space separated list of URIs may be provided.
69 Specifies the default base DN to use when performing ldap operations.
70 The base must be specified as a Distinguished Name in LDAP format.
73 Specifies the default bind DN to use when performing ldap operations.
74 The bind DN must be specified as a Distinguished Name in LDAP format.
75 This is a user\-only option.
77 .B HOST <name[:port] ...>
78 Specifies the name(s) of an LDAP server(s) to which the
80 library should connect. Each server's name can be specified as a
81 domain-style name or an IP address and optionally followed by a ':' and
82 the port number the ldap server is listening on. A space separated
83 list of hosts may be provided.
85 is deprecated in favor of
89 Specifies the default port used when connecting to LDAP servers(s).
90 The port may be specified as a number.
92 is deprecated in favor of
95 .B SIZELIMIT <integer>
96 Specifies a size limit to use when performing searches. The
97 number should be a non-negative integer. \fISIZELIMIT\fP of zero (0)
98 specifies unlimited search size.
100 .B TIMELIMIT <integer>
101 Specifies a time limit to use when performing searches. The
102 number should be a non-negative integer. \fITIMELIMIT\fP of zero (0)
103 specifies unlimited search time to be used.
106 Specifies how alias dereferencing is done when performing a search. The
108 can be specified as one of the following keywords:
112 Aliases are never dereferenced. This is the default.
115 Aliases are dereferenced in subordinates of the base object, but
116 not in locating the base object of the search.
119 Aliases are only dereferenced when locating the base object of the search.
122 Aliases are dereferenced both in searching and in locating the base object
126 If OpenLDAP is built with Simple Authentication and Security Layer support,
127 there are more options you can specify.
129 .B SASL_MECH <mechanism>
130 Specifies the SASL mechanism to use.
131 This is a user\-only option.
133 .B SASL_REALM <realm>
134 Specifies the SASL realm.
135 This is a user\-only option.
137 .B SASL_AUTHCID <authcid>
138 Specifies the authentication identity.
139 This is a user\-only option.
141 .B SASL_AUTHZID <authcid>
142 Specifies the proxy authorization identity.
143 This is a user\-only option.
145 .B SASL_SECPROPS <properties>
146 Specifies Cyrus SASL security properties. The
148 can be specified as a comma-separated list of the following:
152 (without any other properties) causes the properties
153 defaults ("noanonymous,noplain") to be cleared.
156 disables mechanisms susceptible to simple passive attacks.
159 disables mechanisms susceptible to active attacks.
162 disables mechanisms susceptible to passive dictionary attacks.
165 disables mechanisms which support anonymous login.
168 requires forward secrecy between sessions.
171 requires mechanisms which pass client credentials (and allows
172 mechanisms which can pass credentials to do so).
175 specifies the minimum acceptable
176 .I security strength factor
177 as an integer approximating the effective key length used for
178 encryption. 0 (zero) implies no protection, 1 implies integrity
179 protection only, 56 allows DES or other weak ciphers, 112
180 allows triple DES and other strong ciphers, 128 allows RC4,
181 Blowfish and other modern strong ciphers. The default is 0.
184 specifies the maximum acceptable
185 .I security strength factor
188 description). The default is
191 .B maxbufsize=<factor>
192 specifies the maximum security layer receive buffer
193 size allowed. 0 disables security layers. The default is 65536.
196 If OpenLDAP is built with Transport Layer Security support, there
197 are more options you can specify. These options are used when an
199 is selected (by default or otherwise) or when the application
200 negotiates TLS by issuing the LDAP Start TLS operation.
202 .B TLS_CACERT <filename>
203 Specifies the file that contains certificates for all of the Certificate
204 Authorities the client will recognize.
206 .B TLS_CACERTDIR <path>
207 Specifies the path of a directory that contains Certificate Authority
208 certificates in separate individual files. The
210 is always used before
213 .B TLS_CERT <filename>
214 Specifies the file that contains the client certificate.
215 This is a user\-only option.
217 .B TLS_KEY <filename>
218 Specifies the file that contains the private key that matches the certificate
221 file. Currently, the private key must not be protected with a password, so
222 it is of critical importance that the key file is protected carefully. This
223 is a user\-only option.
225 .B TLS_CIPHER_SUITE <cipher-suite-spec>
226 Specifies acceptable cipher suite and preference order.
227 <cipher-suite-spec> should be a cipher specification for OpenSSL,
228 e.g., HIGH:MEDIUM:+SSLv2.
230 .B TLS_RANDFILE <filename>
231 Specifies the file to obtain random bits from when /dev/[u]random is
232 not available. Generally set to the name of the EGD/PRNGD socket.
233 The environment variable RANDFILE can also be used to specify the filename.
235 .B TLS_REQCERT <level>
236 Specifies what checks to perform on server certificates in a TLS session,
239 can be specified as one of the following keywords:
243 The client will not request or check any server certificate.
246 The server certificate is requested. If no certificate is provided,
247 the session proceeds normally. If a bad certificate is provided, it will
248 be ignored and the session proceeds normally.
251 The server certificate is requested. If no certificate is provided,
252 the session proceeds normally. If a bad certificate is provided,
253 the session is immediately terminated.
256 These keywords are equivalent. The server certificate is requested. If no
257 certificate is provided, or a bad certificate is provided, the session
258 is immediately terminated. This is the default setting.
260 .SH "ENVIRONMENT VARIABLES"
263 disable all defaulting
266 path of a configuration file
269 basename of ldaprc file in $HOME or $CWD
272 Set <option-name> as from ldap.conf
276 system-wide ldap configuration file
278 .I $HOME/ldaprc, $HOME/.ldaprc
279 user ldap configuration file
282 local ldap configuration file
286 Kurt Zeilenga, The OpenLDAP Project
289 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
291 is derived from University of Michigan LDAP 3.3 Release.