1 .TH LDAP.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2002 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
13 configuration file is used to set system-wide defaults to be applied when
16 clients. If the environment variable \fBLDAPNOINIT\fP is defined, all
17 defaulting is disabled.
19 Users may create an optional configuration file,
23 in their home directory which will be used to override the system-wide
27 in the current working directory is also used.
29 Additional configuration files can be specified using
30 the \fBLDAPCONF\fP and \fBLDAPRC\fP environment variables.
31 \fBLDAPCONF\fP may be set to the path of a configuration file. This
32 path can be absolute or relative to the current working directory.
33 The \fBLDAPRC\fP, if defined, should be the basename of a file
34 in the current working directory or in the user's home directory.
36 Environmental variables may also be used to augment the file based defaults.
37 The name of the variable is the option name with an added prefix of \fBLDAP\fP.
38 For example, to define \fBBASE\fP via the environment, set the variable
39 \fBLDAPBASE\fP to the desired value.
41 Some options are user\-only. Such options are ignored if present
47 The different configuration options are:
50 Specifies the default base DN to use when performing ldap operations.
51 The base must be specified as a Distinguished Name in LDAP format.
54 Specifies the default bind DN to use when performing ldap operations.
55 The bind DN must be specified as a Distinguished Name in LDAP format.
56 This is a user\-only option.
58 .B HOST <name[:port] ...>
59 Specifies the name(s) of an LDAP server(s) to which the
61 library should connect. Each server's name can be specified as a
62 domain-style name or an IP address and optionally followed by a ':' and
63 the port number the ldap server is listening on. A space separated
64 list of hosts may be provided.
67 Specifies the default port used when connecting to LDAP servers(s).
68 The port may be specified as a number.
70 .B SASL_SECPROPS <properties>
71 Specifies Cyrus SASL security properties. The
73 can be specified as a comma-separated list of the following:
77 (without any other properties) causes the properties
78 defaults ("noanonymous,noplain") to be cleared.
81 disables mechanisms susceptible to simple passive attacks.
84 disables mechanisms susceptible to active attacks.
87 disables mechanisms susceptible to passive dictionary attacks.
90 disables mechanisms which support anonymous login.
93 requires forward secrecy between sessions.
96 requires mechanisms which pass client credentials (and allows
97 mechanisms which can pass credentials to do so).
100 specifies the minimum acceptable
101 .I security strength factor
102 as an integer approximating the effective key length used for
103 encryption. 0 (zero) implies no protection, 1 implies integrity
104 protection only, 56 allows DES or other weak ciphers, 112
105 allows triple DES and other strong ciphers, 128 allows RC4,
106 Blowfish and other modern strong ciphers. The default is 0.
109 specifies the maximum acceptable
110 .I security strength factor
113 description). The default is
116 .B maxbufsize=<factor>
117 specifies the maximum security layer receive buffer
118 size allowed. 0 disables security layers. The default is 65536.
121 .B SIZELIMIT <integer>
122 Specifies a size limit to use when performing searches. The
123 number should be a non-negative integer. \fISIZELIMIT\fP of zero (0)
124 specifies unlimited search size.
126 .B TIMELIMIT <integer>
127 Specifies a time limit to use when performing searches. The
128 number should be a non-negative integer. \fITIMELIMIT\fP of zero (0)
129 specifies unlimited search time to be used.
132 Specifies how alias dereferencing is done when performing a search. The
134 can be specified as one of the following keywords:
138 Aliases are never dereferenced. This is the default.
141 Aliases are dereferenced in subordinates of the base object, but
142 not in locating the base object of the search.
145 Aliases are only dereferenced when locating the base object of the search.
148 Aliases are dereferenced both in searching and in locating the base object
151 If OpenLDAP is built with support for Transport Layer Security, there
152 are more options you can specify.
155 Specifies whether client connections should use TLS by default. The
157 can be specified as one of the following keywords:
161 This is the default. Connections will be opened in the clear unless
162 TLS is explicitly specified (e.g. using an "ldaps://" URL.)
165 All connections will be established with TLS.
166 Note that using this option effectively makes the library open every
167 session as an ldaps session and is incompatible with the LDAPv3 StartTLS
171 .B TLS_CACERT <filename>
172 Specifies the file that contains certificates for all of the Certificate
173 Authorities the client will recognize.
175 .B TLS_CACERTDIR <path>
176 Specifies the path of a directory that contains Certificate Authority
177 certificates in separate individual files. The
179 is always used before
182 .B TLS_CERT <filename>
183 Specifies the file that contains the client certificate. This is
186 .B TLS_KEY <filename>
187 Specifies the file that contains the private key that matches the certificate
190 file. Currently, the private key must not be protected with a password, so
191 it is of critical importance that the key file is protected carefully. This
192 is a user\-only option.
194 .B TLS_RANDFILE <filename>
195 Specifies the file to obtain random bits from when /dev/[u]random is
196 not available. Generally set to the name of the EGD/PRNGD socket.
197 The environment variable RANDFILE can also be used to specify the filename.
199 .B TLS_REQCERT <level>
200 Specifies what checks to perform on server certificates in a TLS session,
203 can be specified as one of the following keywords:
207 The client will not request or check any server certificate.
210 The server certificate is requested. If no certificate is provided,
211 the session proceeds normally. If a bad certificate is provided, it will
212 be ignored and the session proceeds normally.
215 The server certificate is requested. If no certificate is provided,
216 the session proceeds normally. If a bad certificate is provided,
217 the session is immediately terminated.
220 These keywords are equivalent. The server certificate is requested. If no
221 certificate is provided, or a bad certificate is provided, the session
222 is immediately terminated. This is the default setting.
223 .SH "ENVIRONMENT VARIABLES"
226 disable all defaulting
229 path of a configuration file
232 basename of ldaprc file in $HOME or $CWD
235 Set <option-name> as from ldap.conf
239 system-wide ldap configuration file
241 .I $HOME/ldaprc, $HOME/.ldaprc
242 user ldap configuration file
245 local ldap configuration file
249 Kurt Zeilenga, The OpenLDAP Project
252 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
254 is derived from University of Michigan LDAP 3.3 Release.