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

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