git.sur5r.net Git - openldap/blob - doc/man/man5/ldap.conf.5

   1 .TH LDAP.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .UC 6
   6 .SH NAME
   7 ldap.conf, .ldaprc \- ldap configuration file
   8 .SH SYNOPSIS
   9 ETCDIR/ldap.conf, .ldaprc
  10 .SH DESCRIPTION
  11 If the environment variable \fBLDAPNOINIT\fP is defined, all
  12 defaulting is disabled.
  13 .LP
  14 The
  15 .I ldap.conf
  16 configuration file is used to set system-wide defaults to be applied when
  17 running
  18 .I ldap
  19 clients.
  20 .LP
  21 Users may create an optional configuration file,
  22 .I ldaprc
  23 or
  24 .IR .ldaprc ,
  25 in their home directory which will be used to override the system-wide
  26 defaults file.
  27 The file
  28 .I ldaprc
  29 in the current working directory is also used.
  30 .LP
  31 .LP
  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.
  38 .LP
  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.
  43 .LP
  44 Some options are user\-only.  Such options are ignored if present
  45 in the
  46 .I ldap.conf
  47 (or file specified by
  48 .BR LDAPCONF ).
  49 .SH OPTIONS
  50 The configuration options are case-insensitive;
  51 their value, on a case by case basis, may be case-sensitive.
  52 .LP
  53 Blank lines and lines beginning with a hash mark (`#')
  54 are ignored up to their end.
  55 .LP
  56 Valid lines are made of an option's name (a sequence of non-blanks,
  57 conventionally written in uppercase, although not required),
  58 followed by a value.
  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.
  65 For example,
  66
  67         URI     "ldap:// ldaps://"
  68
  69 is incorrect, while
  70
  71         URI     ldap:// ldaps://
  72
  73 is correct (note the absence of the double quotes).
  74 .LP
  75 A line cannot be longer than LINE_MAX, which should be more than 2000 bytes
  76 on all platforms.
  77 There is no mechanism to split a long line on multiple lines, either for
  78 beautification or to overcome the above limit.
  79 .LP
  80 The different configuration options are:
  81 .TP
  82 .B URI <ldap[si]://[name[:port]] ...>
  83 Specifies the URI(s) of an LDAP server(s) to which the
  84 .I LDAP
  85 library should connect.  The URI scheme may be any of
  86 .BR ldap ,
  87 .B ldaps
  88 or
  89 .BR ldapi ,
  90 which refer to LDAP over TCP, LDAP over SSL (TLS) and LDAP
  91 over IPC (UNIX domain 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 IPC,
  98 .B name
  99 is the name of the socket, and no
 100 .B port
 101 is required, nor allowed; note that directory separators must be
 102 URL-encoded, like any other characters that are special to URLs;
 103 so the socket
 104
 105         /usr/local/var/ldapi
 106
 107 must be specified as
 108
 109         ldapi://%2Fusr%2Flocal%2Fvar%2Fldapi
 110
 111 A space separated list of URIs may be provided.
 112 .TP
 113 .B BASE <base>
 114 Specifies the default base DN to use when performing ldap operations.
 115 The base must be specified as a Distinguished Name in LDAP format.
 116 .TP
 117 .B BINDDN <dn>
 118 Specifies the default bind DN to use when performing ldap operations.
 119 The bind DN must be specified as a Distinguished Name in LDAP format.
 120 .B This is a user\-only option.
 121 .TP
 122 .B HOST <name[:port] ...>
 123 Specifies the name(s) of an LDAP server(s) to which the
 124 .I LDAP
 125 library should connect.  Each server's name can be specified as a
 126 domain-style name or an IP address and optionally followed by a ':' and
 127 the port number the ldap server is listening on.  A space separated
 128 list of hosts may be provided.
 129 .B HOST
 130 is deprecated in favor of
 131 .BR URI .
 132 .TP
 133 .B PORT <port>
 134 Specifies the default port used when connecting to LDAP servers(s).
 135 The port may be specified as a number.
 136 .B PORT
 137 is deprecated in favor of
 138 .BR URI.
 139 .TP
 140 .B REFERRALS <on/true/yes/off/false/no>
 141 Specifies if the client should automatically follow referrals returned
 142 by LDAP servers.
 143 The default is on.
 144 Note that the command line tools
 145 .BR ldapsearch (1)
 146 &co always override this option.
 147 .TP
 148 .B SIZELIMIT <integer>
 149 Specifies a size limit to use when performing searches.  The
 150 number should be a non-negative integer.  \fISIZELIMIT\fP of zero (0)
 151 specifies unlimited search size.
 152 .TP
 153 .B TIMELIMIT <integer>
 154 Specifies a time limit to use when performing searches.  The
 155 number should be a non-negative integer.  \fITIMELIMIT\fP of zero (0)
 156 specifies unlimited search time to be used.
 157 .TP
 158 .B DEREF <when>
 159 Specifies how alias dereferencing is done when performing a search. The
 160 .B <when>
 161 can be specified as one of the following keywords:
 162 .RS
 163 .TP
 164 .B never
 165 Aliases are never dereferenced. This is the default.
 166 .TP
 167 .B searching
 168 Aliases are dereferenced in subordinates of the base object, but
 169 not in locating the base object of the search.
 170 .TP
 171 .B finding
 172 Aliases are only dereferenced when locating the base object of the search.
 173 .TP
 174 .B always
 175 Aliases are dereferenced both in searching and in locating the base object
 176 of the search.
 177 .RE
 178 .TP
 179 .B VERSION {2|3}
 180 Specifies what version of the LDAP protocol should be used.
 181 .TP
 182 .B TIMEOUT <integer>
 183 Specifies a generic timeout (in seconds).  Currently ignored.
 184 .TP
 185 .B NETWORK_TIMEOUT <integer>
 186 Specifies the timeout (in seconds) after which the poll(2)/select(2)
 187 following a connect(2) returns in case of no activity.
 188 .SH SASL OPTIONS
 189 If OpenLDAP is built with Simple Authentication and Security Layer support,
 190 there are more options you can specify.
 191 .TP
 192 .B SASL_MECH <mechanism>
 193 Specifies the SASL mechanism to use.
 194 .B This is a user\-only option.
 195 .TP
 196 .B SASL_REALM <realm>
 197 Specifies the SASL realm.
 198 .B This is a user\-only option.
 199 .TP
 200 .B SASL_AUTHCID <authcid>
 201 Specifies the authentication identity.
 202 .B This is a user\-only option.
 203 .TP
 204 .B SASL_AUTHZID <authcid>
 205 Specifies the proxy authorization identity.
 206 .B This is a user\-only option.
 207 .TP
 208 .B SASL_SECPROPS <properties>
 209 Specifies Cyrus SASL security properties. The
 210 .B <properties>
 211 can be specified as a comma-separated list of the following:
 212 .RS
 213 .TP
 214 .B none
 215 (without any other properties) causes the properties
 216 defaults ("noanonymous,noplain") to be cleared.
 217 .TP
 218 .B noplain
 219 disables mechanisms susceptible to simple passive attacks.
 220 .TP
 221 .B noactive
 222 disables mechanisms susceptible to active attacks.
 223 .TP
 224 .B nodict
 225 disables mechanisms susceptible to passive dictionary attacks.
 226 .TP
 227 .B noanonymous
 228 disables mechanisms which support anonymous login.
 229 .TP
 230 .B forwardsec
 231 requires forward secrecy between sessions.
 232 .TP
 233 .B passcred
 234 requires mechanisms which pass client credentials (and allows
 235 mechanisms which can pass credentials to do so).
 236 .TP
 237 .B minssf=<factor>
 238 specifies the minimum acceptable
 239 .I security strength factor
 240 as an integer approximating the effective key length used for
 241 encryption.  0 (zero) implies no protection, 1 implies integrity
 242 protection only, 56 allows DES or other weak ciphers, 112
 243 allows triple DES and other strong ciphers, 128 allows RC4,
 244 Blowfish and other modern strong ciphers.  The default is 0.
 245 .TP
 246 .B maxssf=<factor>
 247 specifies the maximum acceptable
 248 .I security strength factor
 249 as an integer (see
 250 .B minssf
 251 description).  The default is
 252 .BR INT_MAX .
 253 .TP
 254 .B maxbufsize=<factor>
 255 specifies the maximum security layer receive buffer
 256 size allowed.  0 disables security layers.  The default is 65536.
 257 .RE
 258 .SH TLS OPTIONS
 259 If OpenLDAP is built with Transport Layer Security support, there
 260 are more options you can specify.  These options are used when an
 261 .B ldaps:// URI
 262 is selected (by default or otherwise) or when the application
 263 negotiates TLS by issuing the LDAP StartTLS operation.
 264 .TP
 265 .B TLS_CACERT <filename>
 266 Specifies the file that contains certificates for all of the Certificate
 267 Authorities the client will recognize.
 268 .TP
 269 .B TLS_CACERTDIR <path>
 270 Specifies the path of a directory that contains Certificate Authority
 271 certificates in separate individual files. The
 272 .B TLS_CACERT
 273 is always used before
 274 .B TLS_CACERTDIR.
 275 .TP
 276 .B TLS_CERT <filename>
 277 Specifies the file that contains the client certificate.
 278 .B This is a user\-only option.
 279 .TP
 280 .B TLS_KEY <filename>
 281 Specifies the file that contains the private key that matches the certificate
 282 stored in the
 283 .B TLS_CERT
 284 file. Currently, the private key must not be protected with a password, so
 285 it is of critical importance that the key file is protected carefully.
 286 .B This is a user\-only option.
 287 .TP
 288 .B TLS_CIPHER_SUITE <cipher-suite-spec>
 289 Specifies acceptable cipher suite and preference order.
 290 <cipher-suite-spec> should be a cipher specification for OpenSSL,
 291 e.g., HIGH:MEDIUM:+SSLv2.
 292 .TP
 293 .B TLS_RANDFILE <filename>
 294 Specifies the file to obtain random bits from when /dev/[u]random is
 295 not available. Generally set to the name of the EGD/PRNGD socket.
 296 The environment variable RANDFILE can also be used to specify the filename.
 297 .TP
 298 .B TLS_REQCERT <level>
 299 Specifies what checks to perform on server certificates in a TLS session,
 300 if any. The
 301 .B <level>
 302 can be specified as one of the following keywords:
 303 .RS
 304 .TP
 305 .B never
 306 The client will not request or check any server certificate.
 307 .TP
 308 .B allow
 309 The server certificate is requested. If no certificate is provided,
 310 the session proceeds normally. If a bad certificate is provided, it will
 311 be ignored and the session proceeds normally.
 312 .TP
 313 .B try
 314 The server certificate is requested. If no certificate is provided,
 315 the session proceeds normally. If a bad certificate is provided,
 316 the session is immediately terminated.
 317 .TP
 318 .B demand | hard
 319 These keywords are equivalent. The server certificate is requested. If no
 320 certificate is provided, or a bad certificate is provided, the session
 321 is immediately terminated. This is the default setting.
 322 .RE
 323 .TP
 324 .B TLS_CRLCHECK <level>
 325 Specifies if the Certificate Revocation List (CRL) of the CA should be
 326 used to verify if the server certificates have not been revoked. This
 327 requires
 328 .B TLS_CACERTDIR
 329 parameter to be set.
 330 .B <level>
 331 can be specified as one of the following keywords:
 332 .RS
 333 .TP
 334 .B none
 335 No CRL checks are performed
 336 .TP
 337 .B peer
 338 Check the CRL of the peer certificate
 339 .TP
 340 .B all
 341 Check the CRL for a whole certificate chain
 342 .RE
 343 .SH "ENVIRONMENT VARIABLES"
 344 .TP
 345 LDAPNOINIT
 346 disable all defaulting
 347 .TP
 348 LDAPCONF
 349 path of a configuration file
 350 .TP
 351 LDAPRC
 352 basename of ldaprc file in $HOME or $CWD
 353 .TP
 354 LDAP<option-name>
 355 Set <option-name> as from ldap.conf
 356 .SH FILES
 357 .TP
 358 .I  ETCDIR/ldap.conf
 359 system-wide ldap configuration file
 360 .TP
 361 .I  $HOME/ldaprc, $HOME/.ldaprc
 362 user ldap configuration file
 363 .TP
 364 .I  $CWD/ldaprc
 365 local ldap configuration file
 366 .SH "SEE ALSO"
 367 .BR ldap (3),
 368 .BR openssl (1),
 369 .BR sasl (3)
 370 .SH AUTHOR
 371 Kurt Zeilenga, The OpenLDAP Project
 372 .SH ACKNOWLEDGEMENTS
 373 .B OpenLDAP
 374 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 375 .B OpenLDAP
 376 is derived from University of Michigan LDAP 3.3 Release.