-# Copyright 1999, The OpenLDAP Foundation, All Rights Reserved.
+# $OpenLDAP$
+# Copyright 1999-2005, The OpenLDAP Foundation, All Rights Reserved.
# COPYING RESTRICTIONS APPLY, see COPYRIGHT.
-H1: The {{I: slapd}} Configuration File
-Once the software has been built and installed, you are ready to configure it
-for use at your site. All slapd runtime configuration is accomplished through
-the {{EX: slapd.conf}} file, installed in the {{EX: ETCDIR}}
-directory you specified in the {{EX: Make-common}} file.
+H1: The slapd Configuration File
-An alternate configuration file can be specified via a
-command-line option to slapd or slurpd (see Sections 5 and 8,
-respectively). This section describes the general format of the config file,
-followed by a detailed description of each config file option.
+Once the software has been built and installed, you are ready
+to configure {{slapd}}(8) for use at your site. The slapd
+runtime configuration is primarily accomplished through the
+{{slapd.conf}}(5) file, normally installed in the
+{{EX:/usr/local/etc/openldap}} directory.
+An alternate configuration file can be specified via a
+command-line option to {{slapd}}(8) or {{slurpd}}(8). This chapter
+describes the general format of the config file, followed by a
+detailed description of commonly used config file directives.
H2: Configuration File Format
-The {{EX: slapd.conf}} file consists of a series of global configuration options
-that apply to slapd as a whole (including all backends), followed by
-zero or more database backend definitions that contain information
-specific to a backend instance.
-
-Global options can be overridden in a backend (for options that
-appear more than once, the last appearance in the slapd.conf file is
-used). Blank lines and comment lines beginning with a `#' character
-are ignored. If a line begins with white space, it is considered a
-continuation of the previous line. The general format of slapd.conf is
-as follows:
-
-E: # comment - these options apply to every database
-E: <global config options>
-E: # first database definition & config options
-E: database <backend 1 type>
-E: <config options specific to backend 1>
-E: # second database definition & config options
-E: database <backend 2 type>
-E: <config options specific to backend 2>
-E: # subsequent database definitions & config options
-E: ...
-
-Configuration line arguments are separated by white space. If
-an argument contains white space, the argument should be
-enclosed in double quotes "like this". If an argument contains
-a double quote or a backslash character `\', the character
-should be preceded by a backslash character `\'.
+The {{slapd.conf}}(5) file consists of three types of configuration
+information: global, backend specific, and database specific. Global
+information is specified first, followed by information associated
+with a particular backend type, which is then followed by information
+associated with a particular database instance. Global directives can
+be overridden in backend and/or database directives, and backend directives
+can be overridden by database directives.
+
+Blank lines and comment lines beginning with a '{{EX:#}}' character
+are ignored. If a line begins with white space, it is considered a
+continuation of the previous line (even if the previous line is a
+comment).
+
+The general format of slapd.conf is as follows:
+
+> # global configuration directives
+> <global config directives>
+>
+> # backend definition
+> backend <typeA>
+> <backend-specific directives>
+>
+> # first database definition & config directives
+> database <typeA>
+> <database-specific directives>
+>
+> # second database definition & config directives
+> database <typeB>
+> <database-specific directives>
+>
+> # second database definition & config directives
+> database <typeA>
+> <database-specific directives>
+>
+> # subsequent backend & database definitions & config directives
+> ...
+
+A configuration directive may take arguments. If so, they are
+separated by white space. If an argument contains white space,
+the argument should be enclosed in double quotes {{EX:"like this"}}. If
+an argument contains a double quote or a backslash character `{{EX:\}}',
+the character should be preceded by a backslash character `{{EX:\}}'.
The distribution contains an example configuration file that will
-be installed in the {{EX: ETCDIR}} directory. Also provided are
-{{EX: slapd.at.conf}}, which contains many commonly used attribute
-definitions, and {{EX: slapd.oc.conf}}, which contains many commonly
-used object class definitions. These files can be included from
-the slapd configuration file (see below).
-
+be installed in the {{F: /usr/local/etc/openldap}} directory.
+A number of files containing schema definitions (attribute types
+and object classes) are also provided in the
+{{F: /usr/local/etc/openldap/schema}} directory.
-H2: Configuration File Options
+H2: Configuration File Directives
-This section separates the configuration file options into
-global and backend-specific categories, describing each
-option and its default value (if any), and giving an example of
+This section details commonly used configuration directives. For
+a complete list, see the {{slapd.conf}}(5) manual page. This section
+separates the configuration file directives into global,
+backend-specific and data-specific categories, describing each
+directive and its default value (if any), and giving an example of
its use.
-H3: Global Options
+H3: Global Directives
-Options described in this section apply to all backends,
-unless specifically overridden in a backend definition. Option
-arguments that should be replaced by actual text are shown
-in brackets <>.
+Directives described in this section apply to all backends
+and databases unless specifically overridden in a backend or
+database definition. Arguments that should be replaced
+by actual text are shown in brackets {{EX:<>}}.
-H4: access to <what> [ by <who> <accesslevel> ]+
+H4: access to <what> [ by <who> <accesslevel> <control> ]+
-This
option grants access (specified by <accesslevel>) to a
+This
directive grants access (specified by <accesslevel>) to a
set of entries and/or attributes (specified by <what>) by one or
-more requesters (specified by <who>). See Section 5.3 on
-access control for more details and examples.
+more requesters (specified by <who>).
+See the {{SECT:Access Control}} section of this chapter for a
+summary of basic usage.
+!if 0
+More details discussion of this directive can be found in the
+{{SECT:Advanced Access Control}} chapter.
+!endif
-H4: attribute <name> [<name2>] { bin | ces | cis | tel | dn }
+Note: If no {{EX:access}} directives are specified, the default
+access control policy, {{EX:access to * by * read}}, allows all
+both authenticated and anonymous users read access.
-This option associates a syntax with an attribute name. By
-default, an attribute is assumed to have syntax cis. An
-optional alternate name can be given for an attribute. The
-possible syntaxes and their meanings are
-* {{EX: bin}} binary
-* {{EX: ces}} case exact string (case must match during comparisons)
-* {{EX: cis}} case ignore string (case is ignored during comparisons)
-* {{EX: tel}} telephone number string (like cis but blanks and dashes ` '
-are ignored during comparisons)
-* {{EX: dn}} distinguished name
+H4: attributetype <{{REF:RFC2252}} Attribute Type Description>
+This directive defines an attribute type.
+Please see the {{SECT:Schema Specification}} chapter
+for information regarding how to use this directive.
-H4: defaultaccess { none | compare | search | read | write }
+H4: idletimeout <integer>
-This option specifies the default access to grant requesters
-not matched by any other access line (see Section 5.3). Note
-that an access level implies all lesser access levels (e.g.,
-write access implies read, search and compare).
-
-\Default:
+Specify the number of seconds to wait before forcibly closing
+an idle client connection. An idletimeout of 0, the default,
+disables this feature.
-E: defaultaccess read
H4: include <filename>
-This option specifies that slapd should read additional
+This directive specifies that slapd should read additional
configuration information from the given file before continuing
with the next line of the current file. The included file should
-follow the normal slapd config file format.
+follow the normal slapd config file format. The file is commonly
+used to include files containing schema specifications.
-Note: You should be careful when using this option - there is
-no small limit on the number of nested include options, and no
+Note: You should be careful when using this directive - there is
+no small limit on the number of nested include directives, and no
loop detection is done.
H4: loglevel <integer>
-This option specifies the level at which debugging statements
-and operation statistics should be syslogged (currently
-logged to the syslogd(8) LOG_LOCAL4 facility). You must
-have compiled slapd with DLDAP_DEBUG for this to work
-(except for the two stats levels, which are always enabled).
-Log levels are additive. To display what numbers correspond
-to what kind of debugging, invoke slapd with the ? flag or
-consult the table below. The possible values for <integer> are:
-
-*1 trace function calls
-*2 debug packet handling
-*4 heavy trace debugging
-*8 connection management
-*16 print out packets sent and received
-*32 search filter processing
-*64 configuration file processing
-*128 access control list processing
-*256 stats log connections/operations/results
-*512 stats log entries sent
-*1024 print communication with shell backends
-*2048 print entry parsing debugging
+This directive specifies the level at which debugging statements
+and operation statistics should be syslogged (currently logged to
+the {{syslogd}}(8) {{EX:LOG_LOCAL4}} facility). You must have
+configured OpenLDAP {{EX:--enable-debug}} (the default) for this
+to work (except for the two statistics levels, which are always
+enabled). Log levels are additive. To display what numbers
+correspond to what kind of debugging, invoke slapd with {{EX:-?}}
+or consult the table below. The possible values for <integer> are:
+
+!block table; colaligns="RL"; align=Center; \
+ title="Table 5.1: Debugging Levels"
+Level Description
+-1 enable all debugging
+0 no debugging
+1 trace function calls
+2 debug packet handling
+4 heavy trace debugging
+8 connection management
+16 print out packets sent and received
+32 search filter processing
+64 configuration file processing
+128 access control list processing
+256 stats log connections/operations/results
+512 stats log entries sent
+1024 print communication with shell backends
+2048 print entry parsing debugging
+!endblock
\Example:
-E: loglevel 255
+E: loglevel -1
This will cause lots and lots of debugging information to be
-syslogged.
+logged.
\Default:
E: loglevel 256
-H4: objectclass <name> [ requires <attrs> ] [ allows <attrs> ]
-This option defines the schema rules for the given object
-class. Used in conjunction with the schemacheck option. See
-Section 5.4 for more details.
+H4: objectclass <{{REF:RFC2252}} Object Class Description>
-H4: referral <url>
+This directive defines an object class.
+Please see the {{SECT:Schema Specification}} chapter for
+information regarding how to use this directive.
-This option specifies the referral to pass back when slapd
+
+H4: referral <URI>
+
+This directive specifies the referral to pass back when slapd
cannot find a local database to handle a request.
\Example:
-E: referral ldap://ldap.openldap.org
+> referral ldap://root.openldap.org
-This will refer non-local queries to the LDAP server at the
-OpenLDAP Project. Smart LDAP clients can re-ask their
+This will refer non-local queries to the global root LDAP server
+at the OpenLDAP Project. Smart LDAP clients can re-ask their
query at that server, but note that most of these clients are
only going to know how to handle simple LDAP URLs that
contain a host part and optionally a distinguished name part.
-H4: schemacheck { on | off }
-
-This option turns schema checking on or off. If schema
-checking is on, entries added or modified through LDAP operations
-will be checked to ensure they obey the schema rules implied
-by their object class(es) as defined by the corresponding objectclass
-option(s). If schema checking is off this check is not done.
-
-\Default:
-
-E: schemacheck on
H4: sizelimit <integer>
-This option specifies the maximum number of entries to return
+This directive specifies the maximum number of entries to return
from a search operation.
\Default:
-E: sizelimit 500
-
-
-H4: srvtab <filename>
+> sizelimit 500
-This option specifies the srvtab file in which slapd can find the
-kerberos keys necessary for authenticating clients using
-kerberos. This option is only meaningful if you are using
-kerberos authentication, which must be enabled at compile
-time by including the appropriate definitions in the
-{{EX: Make-common}} file.
-
-\Default:
-
-E: srvtab /etc/srvtab
H4: timelimit <integer>
-This option specifies the maximum number of seconds (in real
+This directive specifies the maximum number of seconds (in real
time) slapd will spend answering a search request. If a
request is not finished in this time, a result indicating an
exceeded timelimit will be returned.
\Default:
-E: timelimit 3600
+> timelimit 3600
+H3: General Backend Directives
-H3: General Backend Options
+Directives in this section apply only to the backend in which
+they are defined. They are supported by every type of backend.
+Backend directives apply to all databases instances of the
+same type and, depending on the directive, may be overridden
+by database directives.
-Options in this section only apply to the backend in which
-they are defined. They are supported by every type of
-backend.
+H4: backend <type>
-H4: database <databasetype>
+This directive marks the beginning of a backend declaration.
+{{EX:<type>}} should be one of the
+supported backend types listed in Table 5.2.
-This option marks the beginning of a new database instance
-definition. <databasetype> should be one of ldbm, shell, or
-passwd, depending on which backend will serve the
-database.
+!block table; align=Center; coltags="EX,N"; \
+ title="Table 5.2: Database Backends"
+Types Description
+bdb Berkeley DB transactional backend
+dnssrv DNS SRV backend
+ldap Lightweight Directory Access Protocol (Proxy) backend
+ldbm Lightweight DBM backend
+meta Meta Directory backend
+monitor Monitor backend
+passwd Provides read-only access to {{passwd}}(5)
+perl Perl Programmable backend
+shell Shell (extern program) backend
+sql SQL Programmable backend
+!endblock
\Example:
-E: database ldbm
+> backend bdb
-This marks the beginning of a new LDBM backend database
-instance definition.
+This marks the beginning of a new {{TERM:BDB}} backend
+definition.
-H4: lastmod { on | off }
-This option controls whether slapd will automatically maintain
-the modifiersName, modifyTimestamp, creatorsName, and
-createTimestamp attributes for entries.
+H3: General Database Directives
-\Default:
+Directives in this section apply only to the database in which
+they are defined. They are supported by every type of database.
+
+H4: database <type>
+
+This directive marks the beginning of a database instance
+declaration.
+{{EX:<type>}} should be one of the
+supported backend types listed in Table 5.2.
+
+\Example:
+
+> database bdb
+
+This marks the beginning of a new {{TERM:BDB}} database instance
+declaration.
-E: lastmod off
H4: readonly { on | off }
-This option puts the database into "read-only" mode. Any
+This directive puts the database into "read-only" mode. Any
attempts to modify the database will return an "unwilling to
perform" error.
\Default:
-E: readonly off
+> readonly off
H4: replica
-E: replica host=<hostname>[:<port>]
-E: "binddn=<DN>"
-E: bindmethod={ simple | kerberos }
-E: \[credentials=<password>]
-E: \[srvtab=<filename>]
-
-This option specifies a replication site for this database. The
-{{EX: host=}} parameter specifies a host and optionally a port where
+
+> replica uri=ldap[s]://<hostname>[:<port>] | host=<hostname>[:<port>]
+> [bindmethod={simple|sasl}]
+> ["binddn=<DN>"]
+> [saslmech=<mech>]
+> [authcid=<identity>]
+> [authzid=<identity>]
+> [credentials=<password>]
+
+This directive specifies a replication site for this database. The
+{{EX:uri=}} parameter specifies a scheme, a host and optionally a port where
the slave slapd instance can be found. Either a domain name
or IP address may be used for <hostname>. If <port> is not
-given, the standard LDAP port number (389) is used.
+given, the standard LDAP port number (389 or 636) is used.
+
+{{EX:host}} is deprecated in favor of the {{EX:uri}} parameter.
+
+{{EX:uri}} allows the replica LDAP server to be specified as an LDAP
+URI such as {{EX:ldap://slave.example.com:389}} or
+{{EX:ldaps://slave.example.com:636}}.
+
+The {{EX:binddn=}} parameter gives the DN to bind as for updates
+to the slave slapd. It should be a DN which has read/write access
+to the slave slapd's database. It must also match the {{EX:updatedn}}
+directive in the slave slapd's config file. Generally, this DN
+{{should not}} be the same as the {{EX:rootdn}} of the master
+database. Since DNs are likely to contain embedded spaces, the
+entire {{EX:"binddn=<DN>"}} string should be enclosed in double
+quotes.
-The {{EX: binddn=}} parameter gives the DN to bind as for updates to
-the slave slapd. It should be a DN which has read/write
-access to the slave slapd's database, typically given as a
-"rootdn" in the slave's config file. It must also match the
-updatedn option in the slave slapd's config file. Since DNs are
-likely to contain embedded spaces, the entire "{{EX: binddn=<DN>}}"
-string should be enclosed in quotes.
+The {{EX:bindmethod}} is {{EX:simple}} or {{EX:sasl}}, depending
+on whether simple password-based authentication or {{TERM:SASL}}
+authentication is to be used when connecting to the slave slapd.
-{{EX: bindmethod}} is either simple or kerberos, depending on
-whether simple password-based authentication or kerberos
-authentication is to be used when connecting to the slave
-slapd. Simple authentication requires a valid password be
-given. Kerberos authentication requires a valid srvtab file.
+Simple authentication should not be used unless adequate data
+integrity and confidentiality protections are in place (e.g. TLS
+or IPSEC). Simple authentication requires specification of
+{{EX:binddn}} and {{EX:credentials}} parameters.
-The {{EX: credentials=}} parameter, which is only required if using
-simple authentication, gives the password for binddn on the
-slave slapd.
+SASL authentication is generally recommended. SASL authentication
+requires specification of a mechanism using the {{EX:saslmech}} parameter.
+Depending on the mechanism, an authentication identity and/or
+credentials can be specified using {{EX:authcid}} and {{EX:credentials}}
+respectively. The {{EX:authzid}} parameter may be used to specify
+an authorization identity.
-The {{EX: srvtab=}} parameter, which is only required if using
-kerberos, specifies the filename which holds the kerberos key
-for the slave slapd. If omitted, {{EX: /etc/srvtab}} is used.
+See the chapter entitled {{SECT:Replication with slurpd}} for more
+information on how to use this directive.
-See Section 10 for more details on replication.
H4: replogfile <filename>
-This option specifies the name of the replication log file to
+This directive specifies the name of the replication log file to
which slapd will log changes. The replication log is typically
-written by slapd and read by slurpd. Normally, this option is
+written by slapd and read by slurpd. Normally, this directive is
only used if slurpd is being used to replicate the database.
However, you can also use it to generate a transaction log, if
slurpd is not running. In this case, you will need to periodically
truncate the file, since it will grow indefinitely otherwise.
-See Section 10 for more details on replication.
+See the chapter entitled {{SECT:Replication with slurpd}} for more
+information on how to use this directive.
-H4: rootdn <dn>
-This option specifies the DN of an entry that is not subject to
+H4: rootdn <DN>
+
+This directive specifies the DN that is not subject to
access control or administrative limit restrictions for
-operations on this database.
+operations on this database. The DN need not refer to
+an entry in this database or even in the directory. The
+DN may refer to a SASL identity.
-\Example:
+Entry-based Example:
-E: rootdn "cn=Manager, o=OpenLDAP Project, c=US"
+> rootdn "cn=Manager,dc=example,dc=com"
-H4: rootkrbname <kerberosname>
+SASL-based Example:
-This option specifies a kerberos name for the DN given above
-that will always work, regardless of whether an entry with the
-given DN exists or has a {{EX: krbName}} attribute. This option is
-useful when creating a database and also when using slurpd
-to provide replication service (see Section 10).
+> rootdn "uid=root,cn=example.com,cn=digest-md5,cn=auth"
-\Example:
+See the {{SECT:SASL Authentication}} section for information on
+SASL authentication identities.
-E: rootkrbname admin@openldap.org
H4: rootpw <password>
-This option specifies a password for the DN given above that
-will always work, regardless of whether an entry with the given
-DN exists or has a password. This option is useful when
-creating a database and also when using slurpd to provide
-replication service (see Section 10).
+This directive can be used to specifies a password for the DN for
+the rootdn (when the rootdn is set to a DN within the database).
+
+\Example:
+
+> rootpw secret
+
+It is also permissible to provide hash of the password in RFC 2307
+form. {{slappasswd}}(8) may be used to generate the password hash.
\Example:
-E: rootpw secret
+> rootpw {SSHA}ZKKuqbEKJfKSXhUbHG3fG8MDn9j1v4QN
+
+The hash was generated using the command {{EX:slappasswd -s secret}}.
+
H4: suffix <dn suffix>
-This option specifies the DN suffix of queries that will be
+This directive specifies the DN suffix of queries that will be
passed to this backend database. Multiple suffix lines can be
given, and at least one is required for each database
definition.
\Example:
-E: suffix "o=OpenLDAP Project, c=US"
+> suffix "dc=example,dc=com"
-Queries with a DN ending in "o=OpenLDAP Project, c=US"
+Queries with a DN ending in "dc=example,dc=com"
will be passed to this backend.
-Note: when the backend to pass a query to is selected, slapd
+Note: When the backend to pass a query to is selected, slapd
looks at the suffix line(s) in each database definition in the
order they appear in the file. Thus, if one database suffix is a
prefix of another, it must appear after it in the config file.
-H4: updatedn <dn>
-
-This option is only applicable in a slave slapd. It specifies the
-DN allowed to make changes to the replica (typically, this is
-the DN slurpd binds as when making changes to the replica).
-
-
-
-H3: LDBM Backend-Specific Options
-Options in this category only apply to the LDBM backend
-database. That is, they must follow a "database ldbm" line and
-come before any other "database" line.
+H4: syncrepl
+
+> syncrepl rid=<replica ID>
+> provider=ldap[s]://<hostname>[:port]
+> [type=refreshOnly|refreshAndPersist]
+> [interval=dd:hh:mm:ss]
+> [retry=[<retry interval> <# of retries>]+]
+> [searchbase=<base DN>]
+> [filter=<filter str>]
+> [scope=sub|one|base]
+> [attrs=<attr list>]
+> [attrsonly]
+> [sizelimit=<limit>]
+> [timelimit=<limit>]
+> [schemachecking=on|off]
+> [bindmethod=simple|sasl]
+> [binddn=<DN>]
+> [saslmech=<mech>]
+> [authcid=<identity>]
+> [authzid=<identity>]
+> [credentials=<passwd>]
+> [realm=<realm>]
+> [secprops=<properties>]
+
+
+This directive specifies the current database as a replica of the
+master content by establishing the current {{slapd}}(8) as a
+replication consumer site running a syncrepl replication engine.
+The master database is located at the replication provider site
+specified by the {{EX:provider}} parameter. The replica database is
+kept up-to-date with the master content using the LDAP Content
+Synchronization protocol. See {{EX:draft-zeilenga-ldup-sync-xx.txt}}
+({{a work in progress}}) for more information on the protocol.
+
+The {{EX:rid}} parameter is used for identification of the current
+{{EX:syncrepl}} directive within the replication consumer server,
+where {{EX:<replica ID>}} uniquely identifies the syncrepl specification
+described by the current {{EX:syncrepl}} directive. {{EX:<replica ID>}}
+is non-negative and is no more than three decimal digits in length.
+
+The {{EX:provider}} parameter specifies the replication provider site
+containing the master content as an LDAP URI. The {{EX:provider}}
+parameter specifies a scheme, a host and optionally a port where the
+provider slapd instance can be found. Either a domain name or IP
+address may be used for <hostname>. Examples are
+{{EX:ldap://provider.example.com:389}} or {{EX:ldaps://192.168.1.1:636}}.
+If <port> is not given, the standard LDAP port number (389 or 636) is used.
+Note that the syncrepl uses a consumer-initiated protocol, and hence its
+specification is located at the consumer site, whereas the {{EX:replica}}
+specification is located at the provider site. {{EX:syncrepl}} and
+{{EX:replica}} directives define two independent replication
+mechanisms. They do not represent the replication peers of each other.
+
+The content of the syncrepl replica is defined using a search
+specification as its result set. The consumer slapd will
+send search requests to the provider slapd according to the search
+specification. The search specification includes {{EX:searchbase}},
+{{EX:scope}}, {{EX:filter}}, {{EX:attrs}}, {{EX:attrsonly}},
+{{EX:sizelimit}}, and {{EX:timelimit}} parameters as in the normal
+search specification. The syncrepl search specification has
+the same value syntax and the same default values as in the
+{{ldapsearch}}(1) client search tool.
+
+The LDAP Content Synchronization protocol has two operation
+types: {{EX:refreshOnly}} and {{EX:refreshAndPersist}}.
+The operation type is specified by the {{EX:type}} parameter.
+In the {{EX:refreshOnly}} operation, the next synchronization search operation
+is periodically rescheduled at an interval time after each
+synchronization operation finishes. The interval is specified
+by the {{EX:interval}} parameter. It is set to one day by default.
+In the {{EX:refreshAndPersist}} operation, a synchronization search
+remains persistent in the provider slapd. Further updates to the
+master replica will generate {{EX:searchResultEntry}} to the consumer slapd
+as the search responses to the persistent synchronization search.
+
+If an error occurs during replication, the consumer will attempt to reconnect
+according to the retry parameter which is a list of the <retry interval>
+and <# of retries> pairs. For example, retry="60 5 300 3" lets the consumer
+retry every 60 seconds for the first 10 times and then retry every 300 seconds
+for the next three times before stop retrying. + in <# of retries> means
+indefinite number of retries until success.
+
+The schema checking can be enforced at the LDAP Sync consumer site
+by turning on the {{EX:schemachecking}} parameter.
+If it is turned on, every replicated entry will be checked for its
+schema as the entry is stored into the replica content.
+Every entry in the replica should contain those attributes
+required by the schema definition.
+If it is turned off, entries will be stored without checking
+schema conformance. The default is off.
+
+The {{EX:binddn}} parameter gives the DN to bind as for the
+syncrepl searches to the provider slapd. It should be a DN
+which has read access to the replication content in the
+master database.
+
+The {{EX:bindmethod}} is {{EX:simple}} or {{EX:sasl}},
+depending on whether simple password-based authentication or
+{{TERM:SASL}} authentication is to be used when connecting
+to the provider slapd.
+
+Simple authentication should not be used unless adequate data
+integrity and confidentiality protections are in place (e.g. TLS
+or IPSEC). Simple authentication requires specification of {{EX:binddn}}
+and {{EX:credentials}} parameters.
+
+SASL authentication is generally recommended. SASL authentication
+requires specification of a mechanism using the {{EX:saslmech}} parameter.
+Depending on the mechanism, an authentication identity and/or
+credentials can be specified using {{EX:authcid}} and {{EX:credentials}},
+respectively. The {{EX:authzid}} parameter may be used to specify
+an authorization identity.
+
+The {{EX:realm}} parameter specifies a realm which a certain
+mechanisms authenticate the identity within. The {{EX:secprops}}
+parameter specifies Cyrus SASL security properties.
+
+The syncrepl replication mechanism is supported by the
+three native backends: back-bdb, back-hdb, and back-ldbm.
+
+See the {{SECT:LDAP Sync Replication}} chapter of the admin guide
+for more information on how to use this directive.
+
+
+H4: updatedn <DN>
+
+This directive is only applicable in a slave slapd. It specifies
+the DN allowed to make changes to the replica. This may be the DN
+{{slurpd}}(8) binds as when making changes to the replica or the DN
+associated with a SASL identity.
+
+Entry-based Example:
+
+> updatedn "cn=Update Daemon,dc=example,dc=com"
+
+SASL-based Example:
+
+> updatedn "uid=slurpd,cn=example.com,cn=digest-md5,cn=auth"
+
+See the {{SECT:Replication with slurpd}} chapter for more information
+on how to use this directive.
+
+H4: updateref <URL>
+
+This directive is only applicable in a slave slapd. It
+specifies the URL to return to clients which submit update
+requests upon the replica.
+If specified multiple times, each {{TERM:URL}} is provided.
-H4: cachesize <integer>
+\Example:
-This option specifies the size in entries of the in-memory
-cache maintained by the LDBM backend database instance.
+> updateref ldap://master.example.net
-\Default:
-E: cachesize 1000
+H3: BDB Database Directives
-
-H4: dbcachesize <integer>
-
-This option specifies the size in bytes of the in-memory cache
-associated with each open index file. If not supported by the
-underlying database method, this option is ignored without
-comment. Increasing this number uses more memory but can
-cause a dramatic performance increase, especially during
-modifies or when building indexes.
-
-\Default:
-
-E: dbcachesize 100000
+Directives in this category only apply to a {{TERM:BDB}} database.
+That is, they must follow a "database bdb" line and come before any
+subsequent "backend" or "database" line. For a complete reference
+of BDB configuration directives, see {{slapd-bdb}}(5).
H4: directory <directory>
-This option specifies the directory where the LDBM files
-containing the database and associated indexes live.
+This directive specifies the directory where the BDB files
+containing the database and associated indices live.
\Default:
-E: directory /usr/tmp
-
+> directory /usr/local/var/openldap-data
-H4: index {<attrlist> | default} [pres,eq,approx,sub,none]
-This option specifies the indexes to maintain for the given
-attribute. If only an <attrlist> is given, all possible indexes are
-maintained.
+H3: LDBM Database Directives
-\Example:
+Directives in this category only apply to a {{TERM:LDBM}} database.
+That is, they must follow a "database ldbm" line and come before
+any subsequent "backend" or "database" line. For a complete reference
+of LDBM configuration directives, see {{slapd-ldbm}}(5).
-E: index cn
+H4: cachesize <integer>
-E: index sn,uid eq,sub,approx
+This directive specifies the size in entries of the in-memory
+cache maintained by the LDBM backend database instance.
-E: index default none
+\Default:
-This example causes all indexes to be maintained for the cn
-attribute; equality, substring, and approximate indexes for the
-sn and uid attributes; and no indexes for all other attributes.
+> cachesize 1000
-H4: mode <integer>
+H4: dbcachesize <integer>
-This option specifies the file protection mode that newly
-created database index files should have.
+This directive specifies the size in bytes of the in-memory cache
+associated with each open index file. If not supported by the
+underlying database method, this directive is ignored without
+comment. Increasing this number uses more memory but can
+cause a dramatic performance increase, especially during
+modifies or when building indices.
\Default:
-E: mode 0600
+> dbcachesize 100000
+H4: dbnolocking
-H3: Shell Backend-Specific Options
+This option, if present, disables database locking.
+Enabling this option may improve performance at the expense
+of data security.
-E: bind <pathname>
-E: unbind <pathname>
+H4: dbnosync
-E: search <pathname>
+This option causes on-disk database contents to not be immediately
+synchronized with in memory changes upon change. Enabling this option
+may improve performance at the expense of data integrity.
-E: compare <pathname>
-E: modify <pathname>
+H4: directory <directory>
-E: modrdn <pathname>
+This directive specifies the directory where the LDBM files
+containing the database and associated indices live.
-E: add <pathname>
+\Default:
-E: delete <pathname>
+> directory /usr/local/var/openldap-data
-E: abandon <pathname>
-These options specify the pathname of the command to
-execute in response to the given LDAP operation. The
-command given should understand and follow the input/output
-conventions described in Appendix B.
+H4: index {<attrlist> | default} [pres,eq,approx,sub,none]
+
+This directive specifies the indices to maintain for the given
+attribute. If only an {{EX:<attrlist>}} is given, the default
+indices are maintained.
\Example:
-E: search /usr/local/bin/search.sh
+> index default pres,eq
+> index uid
+> index cn,sn pres,eq,sub
+> index objectClass eq
-Note that you need only supply those commands you want the
-backend to handle. Operations for which a command is not
-supplied will be refused with an "unwilling to perform" error.
+The first line sets the default set of indices to maintain to
+present and equality. The second line causes the default (pres,eq)
+set of indices to be maintained for the {{EX:uid}} attribute type.
+The third line causes present, equality, and substring indices to
+be maintained for {{EX:cn}} and {{EX:sn}} attribute types. The
+fourth line causes an equality index for the {{EX:objectClass}}
+attribute type.
+By default, no indices are maintained. It is generally advised
+that minimally an equality index upon objectClass be maintained.
+> index objectClass eq
-H3: Password Backend-Specific Options
-Options in this category only apply to the PASSWD backend
-database. That is, they must follow a "database passwd" line
-and come before any other "database" line.
-H4: file <filename>
+H4: mode <integer>
-This option specifies an alternate passwd file to use.
+This directive specifies the file protection mode that newly
+created database index files should have.
\Default:
-E: file /etc/passwd
-
-
-
-H3: Tcl Backend-Specific Options
-
-H4: scriptpath <pathname>
-
-This is the full path to a file containing the tcl command(s) to handle
-the LDAP operations.
-
-H4: Proc specifiers
-
-E: bind <proc>
-
-E: unbind <proc>
-
-E: search <proc>
-
-E: compare <proc>
+> mode 0600
-E: modify <proc>
-E: modrdn <proc>
-
-E: add <proc>
-
-E: delete <proc>
-
-E: abandon <proc>
+H2: Access Control
-These options specify the name of the proc (function) in the tcl script
-specified in 'scriptpath' to execute in response to the given LDAP
-operation.
+Access to slapd entries and attributes is controlled by the
+access configuration file directive. The general form of an
+access line is:
-\Example:
+> <access directive> ::= access to <what>
+> [by <who> <access> <control>]+
+> <what> ::= * |
+> [dn[.<basic-style>]=<regex> | dn.<scope-style>=<DN>]
+> [filter=<ldapfilter>] [attrs=<attrlist>]
+> <basic-style> ::= regex | exact
+> <scope-style> ::= base | one | subtree | children
+> <attrlist> ::= <attr> [val[.<basic-style>]=<regex>] | <attr> , <attrlist>
+> <attr> ::= <attrname> | entry | children
+> <who> ::= * | [anonymous | users | self
+> | dn[.<basic-style>]=<regex> | dn.<scope-style>=<DN>]
+> [dnattr=<attrname>]
+> [group[/<objectclass>[/<attrname>][.<basic-style>]]=<regex>]
+> [peername[.<basic-style>]=<regex>]
+> [sockname[.<basic-style>]=<regex>]
+> [domain[.<basic-style>]=<regex>]
+> [sockurl[.<basic-style>]=<regex>]
+> [set=<setspec>]
+> [aci=<attrname>]
+> <access> ::= [self]{<level>|<priv>}
+> <level> ::= none | auth | compare | search | read | write
+> <priv> ::= {=|+|-}{w|r|s|c|x|0}+
+> <control> ::= [stop | continue | break]
+
+where the <what> part selects the entries and/or attributes to which
+the access applies, the {{EX:<who>}} part specifies which entities
+are granted access, and the {{EX:<access>}} part specifies the
+access granted. Multiple {{EX:<who> <access> <control>}} triplets
+are supported, allowing many entities to be granted different access
+to the same set of entries and attributes. Not all of these access
+control options are described here; for more details see the
+{{slapd.access}}(5) man page.
-E: search proc_search
-Note that you need only supply those commands you want the
-tcl backend to handle. Operations for which a command is not
-supplied will be refused with an "unwilling to perform" error.
+H3: What to control access to
-H4: tclrealm <name>
+The <what> part of an access specification determines the entries
+and attributes to which the access control applies. Entries are
+commonly selected in two ways: by DN and by filter. The following
+qualifiers select entries by DN:
-This is one of the biggest pluses of using the tcl backend.
-The realm let's you group several databases to the same interpretor.
-This basically means they share the same global variables and proc
-space. So global variables, as well as all the procs are callable
-between databases. If no tclrealm is specified, it is put into the
-"default" realm.
+> to *
+> to dn[.<basic-style>]=<regex>
+> to dn.<scope-style>=<DN>
+The first form is used to select all entries. The second form may
+be used to select entries by matching a regular expression against
+the target entry's {{normalized DN}}. (The second form is not
+discussed further in this document.) The third form is used to
+select entries which are within the requested scope of DN. The
+<DN> is a string representation of the Distinguished Name, as
+described in {{REF:RFC2253}}.
+The scope can be either {{EX:base}}, {{EX:one}}, {{EX:subtree}},
+or {{EX:children}}. Where {{EX:base}} matches only the entry with
+provided DN, {{EX:one}} matches the entries whose parent is the
+provided DN, {{EX:subtree}} matches all entries in the subtree whose
+root is the provided DN, and {{EX:children}} matches all entries
+under the DN (but not the entry named by the DN).
-H2: Access Control
+For example, if the directory contained entries named:
-Access to slapd entries and attributes is controlled by the
-access configuration file directive. The general form of an
-access line is:
+> 0: o=suffix
+> 1: cn=Manager,o=suffix
+> 2: ou=people,o=suffix
+> 3: uid=kdz,ou=people,o=suffix
+> 4: cn=addresses,uid=kdz,ou=people,o=suffix
+> 5: uid=hyc,ou=people,o=suffix
-E: <access directive> ::= access to <what>
-E: [ by <who> <access> ]+
-E: <what> ::= * | [ dn=<regex> ] [ filter=<ldapfilter> ]
-E: [ attrs=<attrlist> ]
-E: <who> ::= * | self | dn=<regex> | addr=<regex> |
-E: domain=<regex> | dnattr=<dn attribute>
-E: <access> ::= [self]none | [self]compare | [self]search
-E: | [self]read | [self]write
+\Then:
+. {{EX:dn.base="ou=people,o=suffix"}} match 2;
+. {{EX:dn.one="ou=people,o=suffix"}} match 3, and 5;
+. {{EX:dn.subtree="ou=people,o=suffix"}} match 2, 3, 4, and 5; and
+. {{EX:dn.children="ou=people,o=suffix"}} match 3, 4, and 5.
-where the <what> part selects the entries and/or attributes to
-which the access applies, the <who> part specifies which
-entities are granted access, and the <access> part specifies
-the access granted. Multiple <who> <access> pairs are
-supported, allowing many entities to be granted different
-access to the same set of entries and attributes.
+Entries may also be selected using a filter:
-H3: What to control access to
+> to filter=<ldap filter>
-The <what> part of an access specification determines the
-entries and attributes to which the access control applies.
-Entries can be selected in two ways: by a regular expression
-matching the entry's distinguished name:
+where <ldap filter> is a string representation of an LDAP
+search filter, as described in {{REF:RFC2254}}. For example:
-E: dn=<regular expression>
+> to filter=(objectClass=person)
-Note: The DN pattern specified should be "normalized",
-meaning that there should be no extra spaces, and commas
-should be used to separate components. An example
-normalized DN is "cn=Babs Jensen,o=OpenLDAP Project,c=US".
-An example of a non-normalized DN is
-"cn=Babs Jensen; o=OpenLDAP Project, c=US".
+Note that entries may be selected by both DN and filter by
+including both qualifiers in the <what> clause.
-Or, entries may be selected by a filter matching some
-attribute(s) in the entry:
+> to dn.one="ou=people,o=suffix" filter=(objectClass=person)
-E: filter=<ldap filter>
+Attributes within an entry are selected by including a comma-separated
+list of attribute names in the <what> selector:
-where <ldap filter> is a string representation of an LDAP
-search filter, as described in RFC 1588. The special entry
-selector "*" is used to select any entry, and is a convenient
-shorthand for the equivalent "dn=.*" selector.
+> attrs=<attribute list>
-Attributes within an entry are selected by including a
-comma-separated list of attribute names in the <what>
-selector:
+A specific value of an attribute is selected by using a single
+attribute name and also using a value selector:
-E: attrs=<attribute list>
+> attrs=<attribute> val[.<style>]=<regex>
-Access to the entry itself must be granted or denied using the
-special attribute name "entry". Note that giving access to an
-attribute is not enough; access to the entry itself through the
-"entry" attribute is also required. The complete examples at
-the end of this section should help clear things up.
+There are two special {{pseudo}} attributes {{EX:entry}} and
+{{EX:children}}. To read (and hence return) a target entry, the
+subject must have {{EX:read}} access to the target's {{entry}}
+attribute. To add or delete an entry, the subject must have
+{{EX:write}} access to the entry's {{EX:entry}} attribute AND must
+have {{EX:write}} access to the entry's parent's {{EX:children}}
+attribute. To rename an entry, the subject must have {{EX:write}}
+access to entry's {{EX:entry}} attribute AND have {{EX:write}}
+access to both the old parent's and new parent's {{EX:children}}
+attributes. The complete examples at the end of this section should
+help clear things up.
+Lastly, there is a special entry selector {{EX:"*"}} that is used to
+select any entry. It is used when no other {{EX:<what>}}
+selector has been provided. It's equivalent to "{{EX:dn=.*}}"
-H2: Who to grant access to
+H3: Who to grant access to
The <who> part identifies the entity or entities being granted
access. Note that access is granted to "entities" not "entries."
-Entities can be specified by the special "*" identifier, matching
-any entry, the keyword "self" matching the entry protected by
-the access, or by a regular expression matching an entry's
-distinguished name:
+The following table summarizes entity specifiers:
-E: dn=<regular expression>
+!block table; align=Center; coltags="EX,N"; \
+ title="Table 5.3: Access Entity Specifiers"
+Specifier|Entities
+*|All, including anonymous and authenticated users
+anonymous|Anonymous (non-authenticated) users
+users|Authenticated users
+self|User associated with target entry
+dn[.<basic-style>]=<regex>|Users matching a regular expression
+dn.<scope-style>=<DN>|Users within scope of a DN
+!endblock
-Note: The DN pattern specified should be "normalized",
-meaning that there should be no extra spaces, and commas
-should be used to separate components.
+The DN specifier behaves much like <what> clause DN specifiers.
-Or entities can be specified by a regular expression matching
-the client's IP address or domain name:
+Other control factors are also supported. For example, a {{EX:<who>}}
+can be restricted by an entry listed in a DN-valued attribute in
+the entry to which the access applies:
-E: addr=<regular expression>
-E: domain=<regular expression>
-
-or by an entry listed in a DN-valued attribute in the entry to
-which the access applies:
-
-E: dnattr=<dn-valued attribute name>
+> dnattr=<dn-valued attribute name>
The dnattr specification is used to give access to an entry
whose DN is listed in an attribute of the entry (e.g., give
access to a group entry to whoever is listed as the owner of
the group entry).
+Some factors may not be appropriate in all environments (or any).
+For example, the domain factor relies on IP to domain name lookups.
+As these can easily spoofed, the domain factor should not be avoided.
H3: The access to grant
The kind of <access> granted can be one of the following:
-E: none | compare | search | read | write
-Note that each level implies all lower levels of access. So, for
-example, granting someone write access to an entry also
-grants them read, search, and compare access.
+!block table; colaligns="LRL"; coltags="EX,EX,N"; align=Center; \
+ title="Table 5.4: Access Levels"
+Level Privileges Description
+none =0 no access
+auth =x needed to bind
+compare =cx needed to compare
+search =scx needed to apply search filters
+read =rscx needed to read search results
+write =wrscx needed to modify/rename
+!endblock
+Each level implies all lower levels of access. So, for
+example, granting someone {{EX:write}} access to an entry also
+grants them {{EX:read}}, {{EX:search}}, {{EX:compare}}, and
+{{EX:auth}} access. However, one may use the privileges specifier
+to grant specific permissions.
H3: Access Control Evaluation
-When evaluating whether some requester should be given
-access to an entry and/or attribute, slapd compares the entry
-and/or attribute to the {{EX: <what>}} selectors given in the
-configuration file. Access directives local to the current
-database are examined first, followed by global access
-directives. Within this priority, access directives are
-examined in the order in which they appear in the config file.
-Slapd stops with the first {{EX: <what>}} selector that matches the
-entry and/or attribute. The corresponding access directive is
-the one slapd will use to evaluate access.
-
-Next, slapd compares the entity requesting access to the
-{{EX: <who>}} selectors within the access directive selected above,
-in the order in which they appear. It stops with the first {{EX: <who>}}
-selector that matches the requester. This determines the
-access the entity requesting access has to the entry and/or
-attribute.
+When evaluating whether some requester should be given access to
+an entry and/or attribute, slapd compares the entry and/or attribute
+to the {{EX:<what>}} selectors given in the configuration file.
+For each entry, access controls provided in the database which holds
+the entry (or the first database if not held in any database) apply
+first, followed by the global access directives. Within this
+priority, access directives are examined in the order in which they
+appear in the config file. Slapd stops with the first {{EX:<what>}}
+selector that matches the entry and/or attribute. The corresponding
+access directive is the one slapd will use to evaluate access.
+
+Next, slapd compares the entity requesting access to the {{EX:<who>}}
+selectors within the access directive selected above in the order
+in which they appear. It stops with the first {{EX:<who>}} selector
+that matches the requester. This determines the access the entity
+requesting access has to the entry and/or attribute.
Finally, slapd compares the access granted in the selected
-{{EX: <access>}} clause to the access requested by the client. If it
-allows greater or equal access, access is granted. Otherwise,
+{{EX:<access>}} clause to the access requested by the client. If
+it allows greater or equal access, access is granted. Otherwise,
access is denied.
-The order of evaluation of access directives makes their
-placement in the configuration file important. If one access
-directive is more specific than another in terms of the entries
-it selects, it should appear first in the config file. Similarly, if
-one {{EX: <who>}} selector is more specific than another it should
-come first in the access directive. The access control
-examples given below should help make this clear.
+The order of evaluation of access directives makes their placement
+in the configuration file important. If one access directive is
+more specific than another in terms of the entries it selects, it
+should appear first in the config file. Similarly, if one {{EX:<who>}}
+selector is more specific than another it should come first in the
+access directive. The access control examples given below should
+help make this clear.
H3: Access Control Examples
-
-
-The access control facility described above is quite powerful.
-This section shows some examples of its use. First, some
-simple examples:
-
-E: access to * by * read
-
-This access directive grants read access to everyone. If it
-appears alone it is the same as the following defaultaccess
-line.
-
-E: defaultaccess read
-
-The following example shows the use of a regular expression
-to select the entries by DN in two access directives where
-ordering is significant.
-
-E: access to dn=".*, o=OpenLDAP Project, c=US"
-E: by * search
-E: access to dn=".*, c=US"
-E: by * read
-
-Read access is granted to entries under the c=US subtree,
-except for those entries under the "o=OpenLDAP Project,
-c=US" subtree, to which search access is granted. If the
-order of these access directives was reversed, the
-OpenLDAP-specific directive would never be matched, since all
-OpenLDAP entries are also c=US entries.
-
-The next example again shows the importance of ordering,
-both of the access directives and the "by" clauses. It also
-shows the use of an attribute selector to grant access to a
-specific attribute and various <who> selectors.
-
-E:access to dn=".*, o=OpenLDAP Project, c=US" attr=homePhone
-E: by self write
-E: by dn=".*, o=OpenLDAP Project, c=US" search
-E: by domain=.*\.openldap\.org read
-E: by * compare
-E:access to dn=".*, o=OpenLDAP Project, c=US"
-E: by self write
-E: by dn=".*, o=OpenLDAP Project, c=US" search
-E: by * none
-
-This example applies to entries in the "o=OpenLDAP Project, c=US"
-subtree. To all attributes except homePhone, the entry itself
-can write them, other OpenLDAP entries can search by them,
-anybody else has no access. The homePhone attribute is
-writable by the entry, searchable by other OpenLDAP entries,
-readable by clients connecting from somewhere in the
-OpenLDAP.org domain, and comparable by everybody else.
+The access control facility described above is quite powerful. This
+section shows some examples of its use for descriptive purposes.
+
+A simple example:
+
+> access to * by * read
+
+This access directive grants read access to everyone.
+
+> access to *
+> by self write
+> by anonymous auth
+> by * read
+
+This directive allows the user to modify their entry, allows anonymous
+to authentication against these entries, and allows all others to
+read these entries. Note that only the first {{EX:by <who>}} clause
+which matches applies. Hence, the anonymous users are granted
+{{EX:auth}}, not {{EX:read}}. The last clause could just as well
+have been "{{EX:by users read}}".
+
+It is often desirable to restrict operations based upon the level
+of protection in place. The following shows how security strength
+factors (SSF) can be used.
+
+> access to *
+> by ssf=128 self write
+> by ssf=64 anonymous auth
+> by ssf=64 users read
+
+This directive allows users to modify their own entries if security
+protections have of strength 128 or better have been established,
+allows authentication access to anonymous users, and read access
+when 64 or better security protections have been established. If
+client has not establish sufficient security protections, the
+implicit {{EX:by * none}} clause would be applied.
+
+The following example shows the use of a style specifiers to select
+the entries by DN in two access directives where ordering is
+significant.
+
+> access to dn.children="dc=example,dc=com"
+> by * search
+> access to dn.children="dc=com"
+> by * read
+
+Read access is granted to entries under the {{EX:dc=com}} subtree,
+except for those entries under the {{EX:dc=example,dc=com}} subtree,
+to which search access is granted. No access is granted to
+{{EX:dc=com}} as neither access directive matches this DN. If the
+order of these access directives was reversed, the trailing directive
+would never be reached, since all entries under {{EX:dc=example,dc=com}}
+are also under {{EX:dc=com}} entries.
+
+Also note that if no {{EX:access to}} directive matches or no {{EX:by
+<who>}} clause, {{B:access is denied}}. That is, every {{EX:access
+to}} directive ends with an implicit {{EX:by * none}} clause and
+every access list ends with an implicit {{EX:access to * by * none}}
+directive.
+
+The next example again shows the importance of ordering, both of
+the access directives and the {{EX:by <who>}} clauses. It also
+shows the use of an attribute selector to grant access to a specific
+attribute and various {{EX:<who>}} selectors.
+
+> access to dn.subtree="dc=example,dc=com" attr=homePhone
+> by self write
+> by dn.children=dc=example,dc=com" search
+> by peername.regex=IP:10\..+ read
+> access to dn.subtree="dc=example,dc=com"
+> by self write
+> by dn.children="dc=example,dc=com" search
+> by anonymous auth
+
+This example applies to entries in the "{{EX:dc=example,dc=com}}"
+subtree. To all attributes except {{EX:homePhone}}, an entry can
+write to itself, entries under {{EX:example.com}} entries can search
+by them, anybody else has no access (implicit {{EX:by * none}})
+excepting for authentication/authorization (which is always done
+anonymously). The {{EX:homePhone}} attribute is writable by the
+entry, searchable by entries under {{EX:example.com}}, readable by
+clients connecting from network 10, and otherwise not readable
+(implicit {{EX:by * none}}). All other access is denied by the
+implicit {{EX:access to * by * none}}.
Sometimes it is useful to permit a particular DN to add or
remove itself from an attribute. For example, if you would like to
-create a group and allow people too add and remove only
+create a group and allow people to add and remove only
their own DN from the member attribute, you could accomplish
it with an access directive like this:
-E: access to attr=member,entry
-E: by dnattr=member selfwrite
+> access to attr=member,entry
+> by dnattr=member selfwrite
-The dnattr {{EX: <who>}} selector says that the access applies to
-entries listed in the member attribute. The selfwrite access
+The dnattr {{EX:<who>}} selector says that the access applies to
+entries listed in the {{EX:member}} attribute. The {{EX:selfwrite}} access
selector says that such members can only add or delete their
own DN from the attribute, not other values. The addition of
the entry attribute is required because access to the entry is
required to access any of the entry's attributes.
-Note that the attr=member construct in the {{EX: <what>}} clause is a
-shorthand for the clause "dn=* attr=member" (i.e., it matches
-the member attribute in all entries).
-
-
-
-H2: Schema Enforcement
-
-
-
-The {{EX: objectclass}} and schemacheck configuration file options
-can be used to enforce schema rules on entries in the
-directory. The schema rules are defined by one or more
-objectclass lines, and enforcement is turned on or off via the
-schemacheck option. The format of an {{EX: objectclass}} line is:
-
-E: objectclass <name>
-E: [ requires <attrs> ]
-E: [ allows <attrs> ]
-
-This option defines the schema rules for the object class
-given by {{EX: <name>}}. Schema rules consist of the attributes the
-entry is required to have (given by the requires {{EX: <attrs>}}
-clause) and those attributes that it may optionally have (given
-by the allows {{EX: <attrs>}} clause). In both clauses, {{EX: <attrs>}} is a
-comma-separated list of attribute names.
-
-Note that object class inheritance (that is, defining one object
-class in terms of another) is not supported directly. All of an
-object class's required and allowed attributes must be listed
-in the objectclass definition.
-
-For example, to define an objectclass called myPerson, you
-might include a definition like this:
-
-E: objectclass myperson
-E: requires cn, sn, objectclass
-E: allows mail, phone, fax
-
-To then enforce this rule (i.e., to make sure an entry with an
-objectclass of myperson contains the cn, sn and objectclass
-attributes, and that it contains no other attributes besides
-mail, phone, and fax), turn on schema checking with a line like
-this:
-
-E: schemacheck on
-
+!if 0
+For more details on how to use the {{EX:access}} directive,
+consult the {{Advanced Access Control}} chapter.
+!endif
H2: Configuration File Example
-
-
The following is an example configuration file, interspersed
with explanatory text. It defines two databases to handle
-different parts of the X.500 tree; both are LDBM database
-instances. The line numbers shown are provided for
+different parts of the {{TERM:X.500}} tree; both are {{TERM:BDB}}
+database instances. The line numbers shown are provided for
reference only and are not included in the actual file. First, the
global configuration section:
-E: 1. # example config file - global configuration section
-E: 2. include /usr/local/etc/slapd.at.conf
-E: 3. include /usr/local/etc/slapd.oc.conf
-E: 4. schemacheck on
-E: 5. referral ldap://ldap.openldap.org
-
-Line 1 is a comment. Lines 2 and 3 include other config files
-containing attribute and object class definitions, respectively.
-Line 4 turns on schema checking. The {{EX: referral}} option on line 5
+E: 1. # example config file - global configuration section
+E: 2. include /usr/local/etc/schema/core.schema
+E: 3. referral ldap://root.openldap.org
+E: 4. access to * by * read
+
+Line 1 is a comment. Line 2 includes another config file
+which contains {{core}} schema definitions.
+The {{EX:referral}} directive on line 3
means that queries not local to one of the databases defined
below will be referred to the LDAP server running on the
-standard port (389) at the host {{EX: ldap.openldap.org}}.
+standard port (389) at the host {{EX:root.openldap.org}}.
+
+Line 4 is a global access control. It applies to all
+entries (after any applicable database-specific access
+controls).
-The next section of the configuration file defines an LDBM
+The next section of the configuration file defines a BDB
backend that will handle queries for things in the
-"o=OpenLDAP Project, c=US" portion of the tree. The
+"dc=example,dc=com" portion of the tree. The
database is to be replicated to two slave slapds, one on
-truelies, the other on judgmentday. Indexes are to be
-maintained for several attributes, and the {{EX: userPassword}}
+truelies, the other on judgmentday. Indices are to be
+maintained for several attributes, and the {{EX:userPassword}}
attribute is to be protected from unauthorized access.
-E: 1. # ldbm definition for the U-M database
-E: 2. database ldbm
-E: 3. suffix "o=OpenLDAP Project, c=US"
-E: 4. directory /usr/local/var/openldap
-E: 6. rootdn "cn=Manager, o=OpenLDAP Project, c=US"
-E: 7. rootpw secret
-E: 8. replogfile /usr/local/var/openldap/slapd.replog
-E: 9. replica host=slave1.openldap.org:389
-E: 10. binddn="cn=Replicator, o=OpenLDAP Project, c=US"
-E: 11. bindmethod=simple credentials=secret
-E: 12.replica host=slave2.openldap.org
-E: 13. binddn="cn=Replicator, o=OpenLDAP Project, c=US"
-E: 14. bindmethod=kerberos
-E: 15. srvtab=/etc/srvtab.slave2
-E: 16.# ldbm indexed attribute definitions
-E: 17.index cn,sn,uid pres,eq,approx,sub
-E: 18.index objectclass pres,eq
-E: 19.index default none
-E: 20.# ldbm access control definitions
-E: 21.defaultaccess read
-E: 22.access to attr=userpassword
-E: 23. by self write
-E: 24. by dn="cn=Admin, o=OpenLDAP Project, c=US" write
-E: 25. by * compare
-
-Line 1 is a comment. The start of the database definition is
-marked by the database keyword on line 2. Line 3 specifies
-the DN suffix for queries to pass to this database. Line 4
-specifies the directory in which the database files will live
-
-Lines 6 and 7 identify the database "super user" entry and
-associated password. This entry is not subject to access
-control or size or time limit restrictions.
-
-Lines 8 through 15 are for replication. Line 8 specifies the
-replication log file (where changes to the database are logged
-\- this file is written by slapd and read by slurpd). Lines 9
-through 11 specify the hostname and port for a replicated
-host, the DN to bind as when performing updates, the bind
-method (simple) and the credentials (password) for the
-binddn. Lines 12 through 15 specify a second replication site,
-using kerberos instead of simple authentication. See Section
-10 on slurpd for more information on these options.
-
-Lines 16 through 19 indicate the indexes to maintain for
-various attributes. The default is not to maintain any indexes
-(line 19).
-
-Lines 20 through 25 specify access control for entries in the
-database. For all entries, the {{EX: userPassword}} attribute is
-writable by the entry and the "admin" entry, comparable by
-everyone else. All other attributes allow read access by
-default (line 21). Note that the special "entry" attribute is not
-required in the access directive beginning on line 22. This is
-because the default access is read.
-
-The next section of the example configuration file defines
-another LDBM database. This one handles queries involving
-the "o="Babs, Inc.", c=US" subtree.
-
-E: 1. # ldbm definition for Babs, Inc. database
-E: 2. database ldbm
-E: 3. suffix "o=\"Babs, Inc.\", c=US"
-E: 4. directory /usr/local/ldbm-babs
-E: 5. rootdn "cn=Babs, o=\"Babs, Inc.\", c=US"
-E: 6. index default
-
-Note the use of `\' to escape the quotes necessary in the
-distinguished names given on lines 3 and 5. By default, all
-indexes are maintained for every attribute in an entry.
-
-
-PB:
-
-
+E: 5. # BDB definition for the example.com
+E: 6. database bdb
+E: 7. suffix "dc=example,dc=com"
+E: 8. directory /usr/local/var/openldap-data
+E: 9. rootdn "cn=Manager,dc=example,dc=com"
+E: 10. rootpw secret
+E: 11. # replication directives
+E: 12. replogfile /usr/local/var/openldap/slapd.replog
+E: 13. replica uri=ldap://slave1.example.com:389
+E: 14. binddn="cn=Replicator,dc=example,dc=com"
+E: 15. bindmethod=simple credentials=secret
+E: 16. replica uri=ldaps://slave2.example.com:636
+E: 17. binddn="cn=Replicator,dc=example,dc=com"
+E: 18. bindmethod=simple credentials=secret
+E: 19. # indexed attribute definitions
+E: 20. index uid pres,eq
+E: 21. index cn,sn,uid pres,eq,approx,sub
+E: 22. index objectClass eq
+E: 23. # database access control definitions
+E: 24. access to attr=userPassword
+E: 25. by self write
+E: 26. by anonymous auth
+E: 27. by dn.base="cn=Admin,dc=example,dc=com" write
+E: 28. by * none
+E: 29. access to *
+E: 30. by self write
+E: 31. by dn.base="cn=Admin,dc=example,dc=com" write
+E: 32. by * read
+
+Line 5 is a comment. The start of the database definition is marked
+by the database keyword on line 6. Line 7 specifies the DN suffix
+for queries to pass to this database. Line 8 specifies the directory
+in which the database files will live.
+
+Lines 9 and 10 identify the database {{super-user}} entry and associated
+password. This entry is not subject to access control or size or
+time limit restrictions.
+
+Lines 11 through 18 are for replication. Line 12 specifies the
+replication log file (where changes to the database are logged -
+this file is written by slapd and read by slurpd). Lines 13 through
+15 specify the hostname and port for a replicated host, the DN to
+bind as when performing updates, the bind method (simple) and the
+credentials (password) for the binddn. Lines 16 through 18 specify
+a second replication site. See the {{SECT:Replication with slurpd}}
+chapter for more information on these directives.
+
+Lines 20 through 22 indicate the indices to maintain for various
+attributes.
+
+Lines 24 through 32 specify access control for entries in this
+database. As this is the first database, the controls also apply
+to entries not held in any database (such as the Root DSE). For
+all applicable entries, the {{EX:userPassword}} attribute is writable
+by the entry itself and by the "admin" entry. It may be used for
+authentication/authorization purposes, but is otherwise not readable.
+All other attributes are writable by the entry and the "admin"
+entry, but may be read by all users (authenticated or not).
+
+The next section of the example configuration file defines another
+BDB database. This one handles queries involving the
+{{EX:dc=example,dc=net}} subtree but is managed by the same entity
+as the first database. Note that without line 39, the read access
+would be allowed due to the global access rule at line 4.
+
+E: 33. # BDB definition for example.net
+E: 34. database bdb
+E: 35. suffix "dc=example,dc=net"
+E: 36. directory /usr/local/var/openldap-data-net
+E: 37. rootdn "cn=Manager,dc=example,dc=com"
+E: 38. index objectClass eq
+E: 39. access to * by users read
projects / openldap / blobdiff