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

   1 .TH LDAP.CONF 5 "6 May 2002" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2002 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
  10 \fP.ldaprc\fP
  11 .SH DESCRIPTION
  12 The
  13 .I ldap.conf
  14 configuration file is used to set system-wide defaults to be applied when
  15 running
  16 .I ldap
  17 clients.  If the environment variable \fBLDAPNOINIT\fP is defined, all
  18 defaulting is disabled.
  19 .LP
  20 Each user may specify an optional configuration file,
  21 .IR ldaprc
  22 or
  23 .IR .ldaprc ,
  24 in his/her home directory which will be used to override the system-wide
  25 defaults file.
  26 The file
  27 .IR ldaprc
  28 in the current working directory is also used.
  29 .LP
  30 Additional configuration files can be specified using
  31 the \fBLDAPCONF\fP and \fBLDAPRC\fP environment variables.
  32 \fBLDAPCONF\fP may be set the path of a configuration file.  This
  33 path can be absolute or relative to current working directory.
  34 The \fBLDAPRC\fP, if defined, should be a basename of a file
  35 in the current working directory or in the user's home directory.
  36 .LP
  37 Environmental variables may also be used to augment the file based defaults.
  38 The name of the option is the as listed but with a prefix of \fBLDAP\fP.
  39 For example, to define \fBBASE\fP via the environment, define the variable
  40 \fBLDAPBASE\fP to desired value.
  41 .LP
  42 Some options are user\-only.  Such options are ignored if present
  43 in the
  44 .IR ldap.conf
  45 (or file specified by
  46 .BR LDAPCONF ).
  47 .SH OPTIONS
  48 The different configuration options are:
  49 .TP 1i
  50 \fBBASE <base>\fP
  51 Used to specify the default base DN to use when performing ldap operations.
  52 The base must be specified as a Distinguished Name in LDAP format.
  53 .TP 1i
  54 \fBBINDDN <dn>\fP
  55 Used to specify the default bind DN to use when performing ldap operations.
  56 The bind DN must be specified as a Distinguished Name in LDAP format.
  57 This is a user\-only option.
  58 .TP 1i
  59 \fBHOST <name[:port] ...>\fP
  60 Used to specify the name(s) of an LDAP server(s) to which
  61 .I ldap
  62 library should connect to.  Each server's name can be specified as a
  63 domain-style name or an IP address and optionally followed a ':' and
  64 the port number the ldap server is listening on.  A space separated
  65 listed of host may be provided.
  66 .TP 1i
  67 \fBPORT <port>\fP
  68 Used to specify the port used with connecting to LDAP servers(s).
  69 The port may be specified as a number.
  70 .TP 1i
  71 \fBSASL_SECPROPS <properties>\fP
  72 Used to specify Cyrus SASL security properties.
  73 The
  74 .B none
  75 flag (without any other properities) causes the flag properites
  76 defaults ("noanonymous,noplain") to be cleared.
  77 The
  78 .B noplain
  79 flag disables mechanisms susceptible to simple passive attacks.
  80 The
  81 .B noactive
  82 flag disables mechanisms susceptible to active attacks.
  83 The
  84 .B nodict
  85 flag disables mechanisms susceptible to passive dictionary attacks.
  86 The
  87 .B noanonyous
  88 flag disables mechanisms which support anonymous login.
  89 The
  90 .B forwardsec
  91 flag require forward secrecy between sessions.
  92 The
  93 .B passcred
  94 require mechanisms which pass client credentials (and allow
  95 mechanisms which can pass credentials to do so).
  96 The
  97 .B minssf=<factor>
  98 property specifies the minimum acceptable
  99 .I security strength factor
 100 as an integer approximate to effective key length used for
 101 encryption.  0 (zero) implies no protection, 1 implies integrity
 102 protection only, 56 allows DES or other weak ciphers, 112
 103 allows triple DES and other strong ciphers, 128 allows RC4,
 104 Blowfish and other modern strong ciphers.  The default is 0.
 105 The
 106 .B maxssf=<factor>
 107 property specifies the maximum acceptable
 108 .I security strength factor
 109 as an integer (see minssf description).  The default is INT_MAX.
 110 The
 111 .B maxbufsize=<factor>
 112 property specifies the maximum security layer receive buffer
 113 size allowed.  0 disables security layers.  The default is 65536.
 114 .TP 1i
 115 \fBSIZELIMIT <integer>\fP
 116 Used to specify a size limit to use when performing searches.  The
 117 number should be an non-negative integer.  \fISIZELIMIT\fP of zero (0)
 118 specifies unlimited search size.
 119 .TP 1i
 120 \fBTIMELIMIT <integer>\fP
 121 Used to specify a time limit to use when performing searches.  The
 122 number should be an non-negative integer.  \fITIMELIMIT\fP of zero (0)
 123 specifies unlimited search time to be used.
 124 .TP 1i
 125 \fBDEREF <never|searching|finding|always>\fP
 126 Specify how aliases dereferencing is done.  \fIDEREF\fP should
 127 be set to one of
 128 .B never,
 129 .B always,
 130 .B search,
 131 or
 132 .B find
 133 to specify that aliases are never dereferenced, always dereferenced,
 134 dereferenced when searching, or dereferenced only when locating the
 135 base object for the search.  The default is to never dereference aliases.
 136 .SH "ENVIRONMENT VARIABLES"
 137 .TP
 138 LDAPNOINIT
 139 disable all defaulting
 140 .TP
 141 LDAPCONF
 142 path of a configuration file
 143 .TP
 144 LDAPRC
 145 basename of ldaprc file in $HOME or $CWD
 146 .TP
 147 LDAP<option-name>
 148 Set <option-name> as from ldap.conf
 149 .SH FILES
 150 .TP
 151 .I  ETCDIR/ldap.conf
 152 system-wide ldap configuration file
 153 .TP
 154 .I  $HOME/ldaprc, $HOME/.ldaprc
 155 user ldap configuration file
 156 .TP
 157 .I  $CWD/ldaprc
 158 local ldap configuration file
 159 .SH "SEE ALSO"
 160 .BR ldap (3)
 161 .SH AUTHOR
 162 Kurt Zeilenga, The OpenLDAP Project
 163 .SH ACKNOWLEDGEMENTS
 164 .B      OpenLDAP
 165 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 166 .B      OpenLDAP
 167 is derived from University of Michigan LDAP 3.3 Release.