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[s]://[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 either
  86 .B ldap
  87 or
  88 .B ldaps
  89 which refer to LDAP over TCP and LDAP over SSL (TLS) respectively.
  90 Each server's name can be specified as a
  91 domain-style name or an IP address literal.  Optionally, the
  92 server's name can followed by a ':' and the port number the LDAP
  93 server is listening on.  If no port number is provided, the default
  94 port for the scheme is used (389 for ldap://, 636 for ldaps://).
  95 A space separated list of URIs may be provided.
  96 .TP
  97 .B BASE <base>
  98 Specifies the default base DN to use when performing ldap operations.
  99 The base must be specified as a Distinguished Name in LDAP format.
 100 .TP
 101 .B BINDDN <dn>
 102 Specifies the default bind DN to use when performing ldap operations.
 103 The bind DN must be specified as a Distinguished Name in LDAP format.
 104 .B This is a user\-only option.
 105 .TP
 106 .B HOST <name[:port] ...>
 107 Specifies the name(s) of an LDAP server(s) to which the
 108 .I LDAP
 109 library should connect.  Each server's name can be specified as a
 110 domain-style name or an IP address and optionally followed by a ':' and
 111 the port number the ldap server is listening on.  A space separated
 112 list of hosts may be provided.
 113 .B HOST
 114 is deprecated in favor of
 115 .BR URI .
 116 .TP
 117 .B PORT <port>
 118 Specifies the default port used when connecting to LDAP servers(s).
 119 The port may be specified as a number.
 120 .B PORT
 121 is deprecated in favor of
 122 .BR URI.
 123 .TP
 124 .B REFERRALS <on/true/yes/off/false/no>
 125 Specifies if the client should automatically follow referrals returned
 126 by LDAP servers.
 127 The default is on.
 128 Note that the command line tools
 129 .BR ldapsearch (1)
 130 &co always override this option.
 131 .TP
 132 .B SIZELIMIT <integer>
 133 Specifies a size limit to use when performing searches.  The
 134 number should be a non-negative integer.  \fISIZELIMIT\fP of zero (0)
 135 specifies unlimited search size.
 136 .TP
 137 .B TIMELIMIT <integer>
 138 Specifies a time limit to use when performing searches.  The
 139 number should be a non-negative integer.  \fITIMELIMIT\fP of zero (0)
 140 specifies unlimited search time to be used.
 141 .TP
 142 .B DEREF <when>
 143 Specifies how alias dereferencing is done when performing a search. The
 144 .B <when>
 145 can be specified as one of the following keywords:
 146 .RS
 147 .TP
 148 .B never
 149 Aliases are never dereferenced. This is the default.
 150 .TP
 151 .B searching
 152 Aliases are dereferenced in subordinates of the base object, but
 153 not in locating the base object of the search.
 154 .TP
 155 .B finding
 156 Aliases are only dereferenced when locating the base object of the search.
 157 .TP
 158 .B always
 159 Aliases are dereferenced both in searching and in locating the base object
 160 of the search.
 161 .RE
 162 .TP
 163 .B VERSION {2|3}
 164 Specifies what version of the LDAP protocol should be used.
 165 .TP
 166 .B TIMEOUT <integer>
 167 Specifies a generic timeout (in seconds).  Currently ignored.
 168 .TP
 169 .B NETWORK_TIMEOUT <integer>
 170 Specifies the timeout (in seconds) after which the poll(2)/select(2)
 171 following a connect(2) returns in case of no activity.
 172 .SH SASL OPTIONS
 173 If OpenLDAP is built with Simple Authentication and Security Layer support,
 174 there are more options you can specify.
 175 .TP
 176 .B SASL_MECH <mechanism>
 177 Specifies the SASL mechanism to use.
 178 .B This is a user\-only option.
 179 .TP
 180 .B SASL_REALM <realm>
 181 Specifies the SASL realm.
 182 .B This is a user\-only option.
 183 .TP
 184 .B SASL_AUTHCID <authcid>
 185 Specifies the authentication identity.
 186 .B This is a user\-only option.
 187 .TP
 188 .B SASL_AUTHZID <authcid>
 189 Specifies the proxy authorization identity.
 190 .B This is a user\-only option.
 191 .TP
 192 .B SASL_SECPROPS <properties>
 193 Specifies Cyrus SASL security properties. The
 194 .B <properties>
 195 can be specified as a comma-separated list of the following:
 196 .RS
 197 .TP
 198 .B none
 199 (without any other properties) causes the properties
 200 defaults ("noanonymous,noplain") to be cleared.
 201 .TP
 202 .B noplain
 203 disables mechanisms susceptible to simple passive attacks.
 204 .TP
 205 .B noactive
 206 disables mechanisms susceptible to active attacks.
 207 .TP
 208 .B nodict
 209 disables mechanisms susceptible to passive dictionary attacks.
 210 .TP
 211 .B noanonymous
 212 disables mechanisms which support anonymous login.
 213 .TP
 214 .B forwardsec
 215 requires forward secrecy between sessions.
 216 .TP
 217 .B passcred
 218 requires mechanisms which pass client credentials (and allows
 219 mechanisms which can pass credentials to do so).
 220 .TP
 221 .B minssf=<factor>
 222 specifies the minimum acceptable
 223 .I security strength factor
 224 as an integer approximating the effective key length used for
 225 encryption.  0 (zero) implies no protection, 1 implies integrity
 226 protection only, 56 allows DES or other weak ciphers, 112
 227 allows triple DES and other strong ciphers, 128 allows RC4,
 228 Blowfish and other modern strong ciphers.  The default is 0.
 229 .TP
 230 .B maxssf=<factor>
 231 specifies the maximum acceptable
 232 .I security strength factor
 233 as an integer (see
 234 .B minssf
 235 description).  The default is
 236 .BR INT_MAX .
 237 .TP
 238 .B maxbufsize=<factor>
 239 specifies the maximum security layer receive buffer
 240 size allowed.  0 disables security layers.  The default is 65536.
 241 .RE
 242 .SH TLS OPTIONS
 243 If OpenLDAP is built with Transport Layer Security support, there
 244 are more options you can specify.  These options are used when an
 245 .B ldaps:// URI
 246 is selected (by default or otherwise) or when the application
 247 negotiates TLS by issuing the LDAP StartTLS operation.
 248 .TP
 249 .B TLS_CACERT <filename>
 250 Specifies the file that contains certificates for all of the Certificate
 251 Authorities the client will recognize.
 252 .TP
 253 .B TLS_CACERTDIR <path>
 254 Specifies the path of a directory that contains Certificate Authority
 255 certificates in separate individual files. The
 256 .B TLS_CACERT
 257 is always used before
 258 .B TLS_CACERTDIR.
 259 .TP
 260 .B TLS_CERT <filename>
 261 Specifies the file that contains the client certificate.
 262 .B This is a user\-only option.
 263 .TP
 264 .B TLS_KEY <filename>
 265 Specifies the file that contains the private key that matches the certificate
 266 stored in the
 267 .B TLS_CERT
 268 file. Currently, the private key must not be protected with a password, so
 269 it is of critical importance that the key file is protected carefully.
 270 .B This is a user\-only option.
 271 .TP
 272 .B TLS_CIPHER_SUITE <cipher-suite-spec>
 273 Specifies acceptable cipher suite and preference order.
 274 <cipher-suite-spec> should be a cipher specification for OpenSSL,
 275 e.g., HIGH:MEDIUM:+SSLv2.
 276 .TP
 277 .B TLS_RANDFILE <filename>
 278 Specifies the file to obtain random bits from when /dev/[u]random is
 279 not available. Generally set to the name of the EGD/PRNGD socket.
 280 The environment variable RANDFILE can also be used to specify the filename.
 281 .TP
 282 .B TLS_REQCERT <level>
 283 Specifies what checks to perform on server certificates in a TLS session,
 284 if any. The
 285 .B <level>
 286 can be specified as one of the following keywords:
 287 .RS
 288 .TP
 289 .B never
 290 The client will not request or check any server certificate.
 291 .TP
 292 .B allow
 293 The server certificate is requested. If no certificate is provided,
 294 the session proceeds normally. If a bad certificate is provided, it will
 295 be ignored and the session proceeds normally.
 296 .TP
 297 .B try
 298 The server certificate is requested. If no certificate is provided,
 299 the session proceeds normally. If a bad certificate is provided,
 300 the session is immediately terminated.
 301 .TP
 302 .B demand | hard
 303 These keywords are equivalent. The server certificate is requested. If no
 304 certificate is provided, or a bad certificate is provided, the session
 305 is immediately terminated. This is the default setting.
 306 .RE
 307 .TP
 308 .B TLS_CRLCHECK <level>
 309 Specifies if the Certificate Revocation List (CRL) of the CA should be
 310 used to verify if the server certificates have not been revoked. This
 311 requires
 312 .B TLS_CACERTDIR
 313 parameter to be set.
 314 .B <level>
 315 can be specified as one of the following keywords:
 316 .RS
 317 .TP
 318 .B none
 319 No CRL checks are performed
 320 .TP
 321 .B peer
 322 Check the CRL of the peer certificate
 323 .TP
 324 .B all
 325 Check the CRL for a whole certificate chain
 326 .RE
 327 .SH "ENVIRONMENT VARIABLES"
 328 .TP
 329 LDAPNOINIT
 330 disable all defaulting
 331 .TP
 332 LDAPCONF
 333 path of a configuration file
 334 .TP
 335 LDAPRC
 336 basename of ldaprc file in $HOME or $CWD
 337 .TP
 338 LDAP<option-name>
 339 Set <option-name> as from ldap.conf
 340 .SH FILES
 341 .TP
 342 .I  ETCDIR/ldap.conf
 343 system-wide ldap configuration file
 344 .TP
 345 .I  $HOME/ldaprc, $HOME/.ldaprc
 346 user ldap configuration file
 347 .TP
 348 .I  $CWD/ldaprc
 349 local ldap configuration file
 350 .SH "SEE ALSO"
 351 .BR ldap (3),
 352 .BR openssl (1),
 353 .BR sasl (3)
 354 .SH AUTHOR
 355 Kurt Zeilenga, The OpenLDAP Project
 356 .SH ACKNOWLEDGEMENTS
 357 .B OpenLDAP
 358 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 359 .B OpenLDAP
 360 is derived from University of Michigan LDAP 3.3 Release.