]> git.sur5r.net Git - openldap/blobdiff - doc/man/man5/slapd.conf.5
Import "disable bind_anon" clarifications from HEAD
[openldap] / doc / man / man5 / slapd.conf.5
index 924b00a43167a93bff1b16c0d197485219593204..3c8dc530edc9b266fed669c3c5206330c54d0beb 100644 (file)
@@ -1,5 +1,5 @@
 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
-.\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
+.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
 .\" $OpenLDAP$
 .SH NAME
@@ -100,7 +100,7 @@ when DN is empty).
 .B bind_anon_dn
 allows unauthenticated (anonymous) bind when DN is not empty.
 .B update_anon
-allow unauthenticated (anonymous) update operations to be processed
+allows unauthenticated (anonymous) update operations to be processed
 (subject to access controls and other administrative limits).
 .TP
 .B argsfile <filename>
@@ -401,19 +401,21 @@ The default is 1000.
 .B defaultsearchbase <dn>
 Specify a default search base to use when client submits a
 non-base search request with an empty base DN.
+Base scoped search requests with an empty base DN are not affected.
 .TP
 .B disallow <features>
 Specify a set of features (separated by white space) to
 disallow (default none).
 .B bind_anon
-disables acceptance of anonymous bind requests.
+disables acceptance of anonymous bind requests.  Note that this setting
+does not prohibit anonymous directory access (See "require authc").
 .B bind_simple
 disables simple (bind) authentication.
 .B tls_2_anon
-disables Start TLS from forcing session to anonymous status (see also
-.BR tls_authc ).
+disables forcing session to anonymous status (see also
+.BR tls_authc ) upon StartTLS operation receipt.
 .B tls_authc
-disables StartTLS if authenticated (see also
+dissallow the StartTLS operation if authenticated (see also
 .BR tls_2_anon ).
 .HP
 .hy 0
@@ -506,68 +508,92 @@ option description.  The default is 71.
 Specify the level at which debugging statements and operation 
 statistics should be syslogged (currently logged to the
 .BR syslogd (8) 
-LOG_LOCAL4 facility).  Log levels are additive, and available levels
-are:
+LOG_LOCAL4 facility).
+They must be considered subsystems rather than increasingly verbose 
+log levels.
+Some messages with higher priority are logged regardless 
+of the configured loglevel as soon as some logging is configured,
+otherwise anything is logged at all.
+Log levels are additive, and available levels are:
 .RS
 .RS
 .PD 0
 .TP
 .B 1
-.B (trace)
+.B (0x1 trace)
 trace function calls
 .TP
 .B 2
-.B (packet)
+.B (0x2 packet)
 debug packet handling
 .TP
 .B 4
-.B (args)
-heavy trace debugging
+.B (0x4 args)
+heavy trace debugging (function args)
 .TP
 .B 8
-.B (conns)
+.B (0x8 conns)
 connection management
 .TP
 .B 16
-.B (BER)
+.B (0x10 BER)
 print out packets sent and received
 .TP
 .B 32
-.B (filter)
+.B (0x20 filter)
 search filter processing
 .TP
 .B 64
-.B (config)
+.B (0x40 config)
 configuration file processing
 .TP
 .B 128
-.B (ACL)
+.B (0x80 ACL)
 access control list processing
 .TP
 .B 256
-.B (stats)
+.B (0x100 stats)
 stats log connections/operations/results
 .TP
 .B 512
-.B (stats2)
+.B (0x200 stats2)
 stats log entries sent
 .TP
 .B 1024
-.B (shell)
+.B (0x400 shell)
 print communication with shell backends
 .TP
 .B 2048
-.B (parse)
+.B (0x800 parse)
 entry parsing
+.TP
+.B 4096
+.B (0x1000 cache)
+caching (unused)
+.TP
+.B 8192
+.B (0x2000 index)
+data indexing (unused)
+.TP
+.B 16384
+.B (0x4000 sync)
+LDAPSync replication
+.TP
+.B 32768
+.B (0x8000 none)
+only messages that get logged whatever log level is set
 .PD
 .RE
 The desired log level can be input as a single integer that combines 
-the (ORed) desired levels, as a list of integers (that are ORed internally),
+the (ORed) desired levels, both in decimal or in hexadecimal notation,
+as a list of integers (that are ORed internally),
 or as a list of the names that are shown between brackets, such that
 .LP
 .nf
     loglevel 129
+    loglevel 0x81
     loglevel 128 1
+    loglevel 0x80 0x1
     loglevel acl trace
 .fi
 .LP
@@ -575,6 +601,14 @@ are equivalent.
 The keyword 
 .B any
 can be used as a shortcut to enable logging at all levels (equivalent to -1).
+The keyword
+.BR none ,
+or the equivalent integer representation, causes those messages
+that are logged regardless of the configured loglevel to be logged.
+In fact, if no loglevel (or a 0 level) is defined, no logging occurs, 
+so at least the 
+.B none
+level is required to have high priority messages logged.
 .RE
 .TP
 .B moduleload <filename>
@@ -593,7 +627,7 @@ the path is colon-separated but this depends on the operating system.
 .hy 0
 .B objectclass "(\ <oid>\
  [NAME\ <name>]\
- [DESC\ <description]\
+ [DESC\ <description>]\
  [OBSOLETE]\
  [SUP\ <oids>]\
  [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
@@ -842,7 +876,7 @@ The default is 4194303.
 .TP
 .B threads <integer>
 Specify the maximum size of the primary thread pool.
-The default is 16.
+The default is 16; the minimum value is 2.
 .TP
 .B timelimit {<integer>|unlimited}
 .TP
@@ -859,9 +893,15 @@ See
 .BR limits
 for an explanation of the different flags.
 .TP
-.B ucdata-path <path>
-Specify the path to the directory containing the Unicode character
-tables. The default path is DATADIR/ucdata.
+.B tool-threads <integer>
+Specify the maximum number of threads to use in tool mode.
+This should not be greater than the number of CPUs in the system.
+The default is 1.
+.\"ucdata-path is obsolete / ignored...
+.\".TP
+.\".B ucdata-path <path>
+.\"Specify the path to the directory containing the Unicode character
+.\"tables. The default path is DATADIR/ucdata.
 .SH TLS OPTIONS
 If
 .B slapd
@@ -902,6 +942,16 @@ server private key that matches the certificate stored in the
 file.  Currently, the private key must not be protected with a password, so
 it is of critical importance that it is protected carefully. 
 .TP
+.B TLSDHParamFile <filename>
+This directive specifies the file that contains parameters for Diffie-Hellman
+ephemeral key exchange.  This is required in order to use a DSA certificate on
+the server. If multiple sets of parameters are present in the file, all of
+them will be processed.  Note that setting this option may also enable
+Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
+You should append "!ADH" to your cipher suites if you have changed them
+from the default, otherwise no certificate exchanges or verification will
+be done.
+.TP
 .B TLSRandFile <filename>
 Specifies the file to obtain random bits from when /dev/[u]random
 is not available.  Generally set to the name of the EGD/PRNGD socket.
@@ -1464,6 +1514,9 @@ in order to work over all of the glued databases. E.g.
 .B [credentials=<passwd>]
 .B [realm=<realm>]
 .B [secprops=<properties>]
+.B [logbase=<base DN>]
+.B [logfilter=<filter str>]
+.B [syncdata=default|accesslog|changelog]
 .RS
 Specify the current database as a replica which is kept up-to-date with the 
 master content by establishing the current
@@ -1498,11 +1551,13 @@ according to the search specification. The search specification includes
 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
 and
 .B timelimit
-parameters as in the normal search specification.
-The search specification for the LDAP Content Synchronization operation
-has the same value syntax and the same default values as in the
-.BR ldapsearch (1)
-client search tool.
+parameters as in the normal search specification. 
+The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
+\fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
+\fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
+attributes, and \fBattrsonly\fP is unset by default.
+The \fBsizelimit\fP and \fBtimelimit\fP only
+accept "unlimited" and positive integers, and both default to "unlimited".
 The LDAP Content Synchronization protocol has two operation types.
 In the
 .B refreshOnly
@@ -1568,6 +1623,22 @@ keyword above) for a SASL bind can be set with the
 option. A non default SASL realm can be set with the
 .B realm 
 option.
+
+Rather than replicating whole entries, the consumer can query logs of
+data modifications. This mode of operation is referred to as \fIdelta
+syncrepl\fP. In addition to the above parameters, the
+.B logbase
+and
+.B logfilter
+parameters must be set appropriately for the log that will be used. The
+.B syncdata
+parameter must be set to either "accesslog" if the log conforms to the
+.BR slapo-accesslog (5)
+log format, or "changelog" if the log conforms
+to the obsolete \fIchangelog\fP format. If the
+.B syncdata
+parameter is omitted or set to "default" then the log parameters are
+ignored.
 .RE
 .TP
 .B updatedn <dn>
@@ -1599,10 +1670,10 @@ They are documented in the
 manual pages.
 .TP
 .B bdb
-This is the recommended backend for a normal slapd database.
-However, it takes more care than with the LDBM backend to configure
-it properly.
-It uses the Sleepycat Berkeley DB (BDB) package to store data.
+This is the recommended primary backend for a normal slapd database.
+It takes care to configure it properly.
+It uses the transactional database interface of the Sleepycat Berkeley
+DB (BDB) package to store data.
 .TP
 .B config
 This backend is used to manage the configuration of slapd run-time.
@@ -1621,22 +1692,21 @@ This backend acts as a proxy to forward incoming requests to another
 LDAP server.
 .TP
 .B ldbm
-This is the database backend which is easiest to configure.
-However, it does not offer the data durability features of the BDB
-backend.
-It uses Berkeley DB or GDBM to store data.
+This is an easy-to-configure but obsolete database backend. It
+does not offer the data durability features of the BDB and HDB
+backends and hence is deprecated in favor of these robust backends.
+LDBM uses lightweight non-transactional DB interfaces,
+such as those providing by GDBM or Berkeley DB, to store data.
 .TP
 .B ldif
 This database uses the filesystem to build the tree structure
 of the database, using plain ascii files to store data.
-Its usage should be limited to very simple databases, where performances
-are not a requirement.
+Its usage should be limited to very simple databases, where performance
+is not a requirement.
 .TP
 .B meta
 This backend performs basic LDAP proxying with respect to a set of
-remote LDAP servers. It is an enhancement of the ldap backend. The
-proxy cache extension of meta backend provides answering of search
-requests from the proxy using results of previously cached requests.
+remote LDAP servers. It is an enhancement of the ldap backend.
 .TP
 .B monitor
 This backend provides information about the running status of the slapd
@@ -1666,7 +1736,7 @@ Its use requires the
 overlay (see
 .BR slapo-rwm (5)
 for details) to rewrite the naming context of the request.
-It is is primarily intended to implement virtual views on databases
+It is primarily intended to implement virtual views on databases
 that actually store data.
 .TP
 .B shell
@@ -1696,7 +1766,8 @@ By default it is not built.
 .B chain
 Chaining.
 This overlay allows automatic referral chasing when a referral would
-have been returned.
+have been returned, either when configured by the server or when 
+requested by the client.
 .TP
 .B denyop
 Deny Operation.
@@ -1722,6 +1793,7 @@ operation performed on that database.
 .B pcache
 Proxycache.
 This overlay allows caching of LDAP search requests in a local database.
+It is most often used with the ldap or meta backends.
 .TP
 .B ppolicy
 Password Policy.