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