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