OpenLDAP 2.2 Administrator's Guide
+OpenLDAP Software 2.3 Administrator's Guide
The OpenLDAP Project <http://www.openldap.org/> -25 February 2004 +9 August 20054.6. Installing the Software
-5. The slapd Configuration File
-
-5.1. Configuration File Format
+5. Configuring slapd
-
+5.1. Configuration Layout
-5.2. Configuration File Directives +5.2. Configuration Directives
5.3. Access Control
-5.4. Configuration File Example
-6. Running slapd
-
-6.1. Command-Line Options
+6. The slapd Configuration File
-
+6.1. Configuration File Format
-6.2. Starting slapd +6.2. Configuration File Directives
-6.3. Stopping slapd
-7. Database Creation and Maintenance Tools
-7.2. Creating a database off-line +7. Running slapd +7.2. Starting slapd
-8. Schema Specification
-8.2. Extending Schema
-
+8.1. Creating a database over LDAP
-9. Security Considerations
-
-9.1. Network Security
+8.2. Creating a database off-line
-9.2. Integrity and Confidentiality Protection +8.3. The LDIF text entry format
-9.3. Authentication Methods
-
+9.1. Distributed Schema Files
-10. Using SASL
-10.2. SASL Authentication +10. Security Considerations +10.2. Data Integrity and Confidentiality Protection
-11. Using TLS
-11.2. TLS Configuration
-
+11.1. SASL Security Considerations
-12. Constructing a Distributed Directory Service
-
-12.1. Subordinate Knowledge Information
+11.2. SASL Authentication
-12.2. Superior Knowledge Information +11.3. SASL Proxy Authorization
-12.3. The ManageDsaIT Control
-
+12.1. TLS Certificates
-13. Replication with slurpd
-13.2. Replication Logs +13. Constructing a Distributed Directory Service
-
+13.1. Subordinate Knowledge Information
-13.3. Command-Line Options +13.2. Superior Knowledge Information
-13.4. Configuring slurpd and a slave slapd instance +13.3. The ManageDsaIT Control
-13.5. Advanced slurpd Operation
-
+14.1. Overview
-14. LDAP Sync Replication
-
-14.1. The LDAP Content Synchronization Protocol
+14.2. Replication Logs
-14.2. Syncrepl Details +14.3. Command-Line Options
-14.3. Configuring Syncrepl
-15. The Proxy Cache Engine
-15.2. Proxy Cache Configuration
-
+15.1. The LDAP Content Synchronization Protocol
+
+15.2. Syncrepl Details +
+15.3. Configuring Syncrepl
+16. The Proxy Cache Engine
A. Generic configure Instructions
@@ -164,11 +173,11 @@
Preface
Copyright
-Copyright 1998-2002, The OpenLDAP Foundation, All Rights Reserved.
+Copyright 1998-2005, The OpenLDAP Foundation, All Rights Reserved.
Copyright 1992-1996, Regents of the University of Michigan, All Rights Reserved.
This document is considered a part of OpenLDAP Software. This document is subject to terms of conditions set forth in OpenLDAP Software Copyright Notices and the OpenLDAP Public License. Complete copies of the notices and associated license can be found in Appendix B and C, respectively.
Scope of this Document
-This document provides a guide for installing OpenLDAP 2.1 Software (http://www.openldap.org/software/) on
This document provides a guide for installing OpenLDAP Software 2.3 (http://www.openldap.org/software/) on
This document is meant to be used in conjunction with other OpenLDAP information resources provided with the software package and on the project's extensive site (http://www.OpenLDAP.org/) on the World Wide Web. The site makes available a number of resources.
| +Keyword + | +Description | +Any + | +enable all debugging | @@ -730,6 +771,9 @@ enable all debugging 0+ + | +no debugging | @@ -738,6 +782,9 @@ no debugging 1+Trace + | +trace function calls | @@ -746,6 +793,9 @@ trace function calls 2+Packets + | +debug packet handling | @@ -754,6 +804,9 @@ debug packet handling 4+Args + | +heavy trace debugging | @@ -762,6 +815,9 @@ heavy trace debugging 8+Conns + | +connection management | @@ -770,6 +826,9 @@ connection management 16+BER + | +print out packets sent and received | @@ -778,6 +837,9 @@ print out packets sent and received 32+Filter + | +search filter processing | @@ -786,7 +848,10 @@ search filter processing 64-configuration file processing +Config + | ++configuration processing |
| +ACL + | +access control list processing | +Stats + | +stats log connections/operations/results | @@ -810,6 +881,9 @@ stats log connections/operations/results 512+Stats2 + | +stats log entries sent | @@ -818,6 +892,9 @@ stats log entries sent 1024+Shell + | +print communication with shell backends | @@ -826,45 +903,143 @@ print communication with shell backends 2048+Parse + | +print entry parsing debugging | +
| +4096 + | ++Cache + | ++database cache processing + | +
| +8192 + | ++Index + | ++database indexing + | +
| +16384 + | ++Sync + | ++syncrepl consumer processing + | +
Example:
- loglevel -1 + olcLogLevel: -1
This will cause lots and lots of debugging information to be logged.
++ olcLogLevel: Conns Filter ++
Just log the connection and search filter processing.
Default:
- loglevel 256 + olcLogLevel: Stats-
5.2.1.6. objectclass <RFC2252 Object Class Description>
-This directive defines an object class. Please see the Schema Specification chapter for information regarding how to use this directive.
-5.2.1.7. referral <URI>
+5.2.1.3. olcReferral <URI>
This directive specifies the referral to pass back when slapd cannot find a local database to handle a request.
Example:
- referral ldap://root.openldap.org + olcReferral: ldap://root.openldap.org
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.
-5.2.1.8. sizelimit <integer>
-This directive specifies the maximum number of entries to return from a search operation.
-Default:
+5.2.1.4. Sample Entry
- sizelimit 500 +dn: cn=config +objectClass: olcGlobal +cn: config +olcIdleTimeout: 30 +olcLogLevel: Stats +olcReferral: ldap://root.openldap.org-
5.2.1.9. timelimit <integer>
-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:
+5.2.2. cn=include
+An include entry holds the pathname of one include file. Include files are part of the old style slapd.conf configuration system and must be in slapd.conf format. Include files were commonly used to load schema specifications. While they are still supported, their use is deprecated. Include entries must have the olcIncludeFile objectClass.
+5.2.2.1. olcInclude: <filename>
+This directive specifies that slapd should read additional configuration information from the given file.
++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. +
+
5.2.2.2. Sample Entries
- timelimit 3600
+dn: cn=include{0},cn=config
+objectClass: olcIncludeFile
+cn: include{0}
+olcInclude: ./schema/core.schema
+
+dn: cn=include{1},cn=config
+objectClass: olcIncludeFile
+cn: include{1}
+olcInclude: ./schema/cosine.schema
-5.2.2. General Backend Directives
-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.
-5.2.2.1. backend <type>
-This directive marks the beginning of a backend declaration. <type> should be one of the supported backend types listed in Table 5.2.
+5.2.3. cn=module
+If support for dynamically loaded modules was enabled when configuring slapd, cn=module entries may be used to specify sets of modules to load. Module entries must have the olcModuleList objectClass.
+5.2.3.1. olcModuleLoad: <filename>
+Specify the name of a dynamically loadable module to load. The filename may be an absolute path name or a simple filename. Non-absolute names are searched for in the directories specified by the olcModulePath directive.
+5.2.3.2. olcModulePath: <pathspec>
+Specify a list of directories to search for loadable modules. Typically the path is colon-separated but this depends on the operating system.
+5.2.3.3. Sample Entries
+
+dn: cn=module{0},cn=config
+objectClass: olcModuleList
+cn: module{0}
+olcModuleLoad: /usr/local/lib/smbk5pwd.la
+
+dn: cn=module{1},cn=config
+objectClass: olcModuleList
+cn: module{1}
+olcModulePath: /usr/local/lib:/usr/local/lib/slapd
+olcModuleLoad: accesslog.la
+olcModuleLoad: pcache.la
+
+5.2.4. cn=schema
+The cn=schema entry holds all of the schema definitions that are hard-coded in slapd. As such, the values in this entry are generated by slapd so no schema values need to be provided in the config file. The entry must still be defined though, to serve as a base for the user-defined schema to add in underneath. Schema entries must have the olcSchemaConfig objectClass.
+5.2.4.1. olcAttributeTypes: <RFC2252 Attribute Type Description>
+This directive defines an attribute type. Please see the Schema Specification chapter for information regarding how to use this directive.
+5.2.4.2. olcObjectClasses: <RFC2252 Object Class Description>
+This directive defines an object class. Please see the Schema Specification chapter for information regarding how to use this directive.
+5.2.4.3. Sample Entries
++dn: cn=schema,cn=config +objectClass: olcSchemaConfig +cn: schema + +dn: cn=test,cn=schema,cn=config +objectClass: olcSchemaConfig +cn: test +olcAttributeTypes: ( 1.1.1 + NAME 'testAttr' + EQUALITY integerMatch + SYNTAX 1.3.6.1.4.1.1466.115.121.1.27 ) +olcAttributeTypes: ( 1.1.2 NAME 'testTwo' EQUALITY caseIgnoreMatch + SUBSTR caseIgnoreSubstringsMatch SYNTAX 1.3.6.1.4.1.1466.115.121.1.44 ) +olcObjectClasses: ( 1.1.3 NAME 'testObject' + MAY ( testAttr $ testTwo ) AUXILIARY ) ++
5.2.5. Backend-specific Directives
+Backend directives apply to all database instances of the same type and, depending on the directive, may be overridden by database directives. Backend entries must have the olcBackendConfig objectClass.
+5.2.5.1. olcBackend: <type>
+This directive names a backend-specific configuration entry. <type> should be one of the supported backend types listed in Table 5.2.
| +config + | ++Slapd configuration backend + | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| dnssrv | @@ -893,6 +1076,14 @@ DNS SRV backend | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| +hdb + | ++Hierarchical variant of bdb backend + | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ldap | @@ -909,6 +1100,14 @@ Lightweight DBM backend | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| +ldif + | ++Lightweight Data Interchange Format backend + | +|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| meta |
@@ -959,86 +1158,107 @@ SQL Programmable backend
Example: - backend bdb + olcBackend: bdb- This marks the beginning of a new 5.2.3. General Database Directives-Directives in this section apply only to the database in which they are defined. They are supported by every type of database. -5.2.3.1. database <type>-This directive marks the beginning of a database instance declaration. <type> should be one of the supported backend types listed in Table 5.2. +There are no other directives defined for this entry. Specific backend types may define additional attributes for their particular use but so far none have ever been defined. As such, these directives usually do not appear in any actual configurations. +5.2.5.2. Sample Entry++ dn: olcBackend=bdb,cn=config + objectClass: olcBackendConfig + olcBackend: bdb ++ 5.2.6. Database-specific Directives+Directives in this section are supported by every type of database. Database entries must have the olcDatabaseConfig objectClass. +5.2.6.1. olcDatabase: [{<index>}]<type>+This directive names a specific database instance. The numeric {<index>} may be provided to distinguish multiple databases of the same type. Usually the index can be omitted, and slapd will generate it automatically. <type> should be one of the supported backend types listed in Table 5.2 or the frontend type. +The frontend is a special database that is used to hold database-level options that should be applied to all the other databases. Subsequent database definitions may also override some frontend settings. +The config database is also special; both the config and the frontend databases are always created implicitly even if they are not explicitly configured, and they are created before any other databases. Example: - database bdb + olcDatabase: bdb- This marks the beginning of a new 5.2.3.2. readonly { on | off }+This marks the beginning of a new 5.2.6.2. olcAccess: to <what> [ by <who> <accesslevel> <control> ]++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 the Access Control section of this chapter for a summary of basic usage. ++Note: If no olcAccess directives are specified, the default access control policy, to * by * read, allows all users (both authenticated and anonymous) read access. + + +Note: Access controls defined in the frontend are appended to all other databases' controls. + + 5.2.6.3. olcReadonly { TRUE | FALSE }This directive puts the database into "read-only" mode. Any attempts to modify the database will return an "unwilling to perform" error. Default: - readonly off + olcReadonly: FALSE- 5.2.3.3. replica+5.2.6.4. olcReplica
- replica uri=ldap[s]://<hostname>[:<port>] | host=<hostname>[:<port>]
- [bindmethod={simple|kerberos|sasl}]
+ olcReplica: uri=ldap[s]://<hostname>[:<port>] | host=<hostname>[:<port>]
+ [bindmethod={simple|sasl}]
["binddn=<DN>"]
[saslmech=<mech>]
[authcid=<identity>]
[authzid=<identity>]
[credentials=<password>]
- [srvtab=<filename>]
-This directive specifies a replication site for this database. The 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 or 636) is used. +This directive specifies a replication site for this database for use with slurpd. The 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 or 636) is used. host is deprecated in favor of the uri parameter. uri allows the replica LDAP server to be specified as an LDAP URI such as ldap://slave.example.com:389 or ldaps://slave.example.com:636. The 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 updatedn directive in the slave slapd's config file. Generally, this DN should not be the same as the rootdn of the master database. Since DNs are likely to contain embedded spaces, the entire "binddn=<DN>" string should be enclosed in double quotes. -The bindmethod is simple or kerberos or sasl, depending on whether simple password-based authentication or Kerberos authentication or Simple authentication should not be used unless adequate integrity and privacy protections are in place (e.g. TLS or IPSEC). Simple authentication requires specification of binddn and credentials parameters. -Kerberos authentication is deprecated in favor of SASL authentication mechanisms, in particular the KERBEROS_V4 and GSSAPI mechanisms. Kerberos authentication requires binddn and srvtab parameters. +The bindmethod is simple or sasl, depending on whether simple password-based authentication or 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 binddn and credentials parameters. SASL authentication is generally recommended. SASL authentication requires specification of a mechanism using the saslmech parameter. Depending on the mechanism, an authentication identity and/or credentials can be specified using authcid and credentials respectively. The authzid parameter may be used to specify an authorization identity. See the chapter entitled Replication with slurpd for more information on how to use this directive. -5.2.3.4. replogfile <filename>+5.2.6.5. olcReplogfile: <filename>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 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 the chapter entitled Replication with slurpd for more information on how to use this directive. -5.2.3.5. rootdn <DN>+5.2.6.6. olcRootDN: <DN>This directive specifies the DN that is not subject to access control or administrative limit restrictions for 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. Entry-based Example: - rootdn "cn=Manager,dc=example,dc=com" + olcRootDN: "cn=Manager,dc=example,dc=com" SASL-based Example: - rootdn "uid=root,cn=example.com,cn=digest-md5,cn=auth" + olcRootDN: "uid=root,cn=example.com,cn=digest-md5,cn=auth" See the SASL Authentication section for information on SASL authentication identities. -5.2.3.6. rootpw <password>-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). +5.2.6.7. olcRootPW: <password>+This directive can be used to specify a password for the DN for the rootdn (when the rootdn is set to a DN within the database). Example: - rootpw secret + olcRootPW: 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. +It is also permissible to provide a hash of the password in RFC 2307 form. slappasswd(8) may be used to generate the password hash. Example:
- rootpw {SSHA}ZKKuqbEKJfKSXhUbHG3fG8MDn9j1v4QN
+ olcRootPW: {SSHA}ZKKuqbEKJfKSXhUbHG3fG8MDn9j1v4QN
The hash was generated using the command slappasswd -s secret. -5.2.3.7. suffix <dn suffix>-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. +5.2.6.8. olcSizeLimit: <integer>+This directive specifies the maximum number of entries to return from a search operation. +Default: ++ olcSizeLimit: 500 ++ 5.2.6.9. olcSuffix: <dn suffix>+This directive specifies the DN suffix of queries that will be passed to this backend database. Multiple suffix lines can be given, and usually at least one is required for each database definition. (Some backend types, such as frontend and monitor use a hard-coded suffix which may not be overridden in the configuration.) Example: - suffix "dc=example,dc=com" + olcSuffix: "dc=example,dc=com" 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 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. +Note: When the backend to pass a query to is selected, slapd looks at the suffix value(s) in each database definition in the order in which they were configured. Thus, if one database suffix is a prefix of another, it must appear after it in the configuration. - 5.2.3.8. syncrepl+5.2.6.10. olcSyncrepl
- syncrepl rid=<replica ID>
+ olcSyncrepl: 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]
@@ -1047,7 +1267,6 @@ SQL Programmable backend
[sizelimit=<limit>]
[timelimit=<limit>]
[schemachecking=on|off]
- [updatedn=<DN>]
[bindmethod=simple|sasl]
[binddn=<DN>]
[saslmech=<mech>]
@@ -1062,91 +1281,150 @@ SQL Programmable backend
Example: ++ loglevel -1 ++ This will cause lots and lots of debugging information to be logged. +Default: ++ loglevel 256 ++ 6.2.1.6. objectclass <RFC2252 Object Class Description>+This directive defines an object class. Please see the Schema Specification chapter for information regarding how to use this directive. +6.2.1.7. referral <URI>+This directive specifies the referral to pass back when slapd cannot find a local database to handle a request. +Example: ++ referral ldap://root.openldap.org ++ 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. +6.2.1.8. sizelimit <integer>+This directive specifies the maximum number of entries to return from a search operation. +Default: ++ sizelimit 500 ++ 6.2.1.9. timelimit <integer>+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: ++ timelimit 3600 ++ 6.2.2. General Backend Directives+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. +6.2.2.1. backend <type>+This directive marks the beginning of a backend declaration. <type> should be one of the supported backend types listed in Table 5.2. +
Example: ++ backend bdb ++ This marks the beginning of a new 6.2.3. General Database Directives+Directives in this section apply only to the database in which they are defined. They are supported by every type of database. +6.2.3.1. database <type>+This directive marks the beginning of a database instance declaration. <type> should be one of the supported backend types listed in Table 5.2. +Example: ++ database bdb ++ This marks the beginning of a new 6.2.3.2. readonly { on | off }+This directive puts the database into "read-only" mode. Any attempts to modify the database will return an "unwilling to perform" error. +Default: ++ readonly off ++ 6.2.3.3. replica+
+ 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 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 or 636) is used. +host is deprecated in favor of the uri parameter. +uri allows the replica LDAP server to be specified as an LDAP URI such as ldap://slave.example.com:389 or ldaps://slave.example.com:636. +The 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 updatedn directive in the slave slapd's config file. Generally, this DN should not be the same as the rootdn of the master database. Since DNs are likely to contain embedded spaces, the entire "binddn=<DN>" string should be enclosed in double quotes. +The bindmethod is simple or sasl, depending on whether simple password-based authentication or 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 binddn and credentials parameters. +SASL authentication is generally recommended. SASL authentication requires specification of a mechanism using the saslmech parameter. Depending on the mechanism, an authentication identity and/or credentials can be specified using authcid and credentials respectively. The authzid parameter may be used to specify an authorization identity. +See the chapter entitled Replication with slurpd for more information on how to use this directive. +6.2.3.4. replogfile <filename>+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 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 the chapter entitled Replication with slurpd for more information on how to use this directive. +6.2.3.5. rootdn <DN>+This directive specifies the DN that is not subject to access control or administrative limit restrictions for 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. +Entry-based Example: ++ rootdn "cn=Manager,dc=example,dc=com" ++ SASL-based Example: ++ rootdn "uid=root,cn=example.com,cn=digest-md5,cn=auth" ++ See the SASL Authentication section for information on SASL authentication identities. +6.2.3.6. rootpw <password>+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: +
+ rootpw {SSHA}ZKKuqbEKJfKSXhUbHG3fG8MDn9j1v4QN
+
+The hash was generated using the command slappasswd -s secret. +6.2.3.7. suffix <dn suffix>+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: ++ suffix "dc=example,dc=com" ++ 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 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. + + 6.2.3.8. 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 provider parameter. The replica database is kept up-to-date with the master content using the LDAP Content Synchronization protocol. See draft-zeilenga-ldup-sync-xx.txt (a work in progress) for more information on the protocol. +The rid parameter is used for identification of the current syncrepl directive within the replication consumer server, where <replica ID> uniquely identifies the syncrepl specification described by the current syncrepl directive. <replica ID> is non-negative and is no more than three decimal digits in length. +The provider parameter specifies the replication provider site containing the master content as an LDAP URI. The 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 ldap://provider.example.com:389 or 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 replica specification is located at the provider site. syncrepl and 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 searchbase, scope, filter, attrs, attrsonly, sizelimit, and 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: refreshOnly and refreshAndPersist. The operation type is specified by the type parameter. In the 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 interval parameter. It is set to one day by default. In the refreshAndPersist operation, a synchronization search remains persistent in the provider slapd. Further updates to the master replica will generate 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 10 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 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 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 bindmethod is simple or sasl, depending on whether simple password-based authentication or 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 binddn and credentials parameters. +SASL authentication is generally recommended. SASL authentication requires specification of a mechanism using the saslmech parameter. Depending on the mechanism, an authentication identity and/or credentials can be specified using authcid and credentials, respectively. The authzid parameter may be used to specify an authorization identity. +The realm parameter specifies a realm which a certain mechanisms authenticate the identity within. The 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 LDAP Sync Replication chapter of the admin guide for more information on how to use this directive. +6.2.3.9. 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 Replication with slurpd chapter for more information on how to use this directive. +6.2.3.10. 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 Example: ++ updateref ldap://master.example.net ++ 6.2.4. BDB and HDB Database Directives+Directives in this category only apply to both the 6.2.4.1. directory <directory>+This directive specifies the directory where the BDB files containing the database and associated indices live. +Default: ++ directory /usr/local/var/openldap-data ++ 6.2.5. LDBM Database Directives+Directives in this category only apply to a 6.2.5.1. cachesize <integer>+This directive specifies the size in entries of the in-memory cache maintained by the LDBM backend database instance. +Default: ++ cachesize 1000 ++ 6.2.5.2. dbcachesize <integer>+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: ++ dbcachesize 100000 ++ 6.2.5.3. dbnolocking+This option, if present, disables database locking. Enabling this option may improve performance at the expense of data security. +6.2.5.4. dbnosync+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. +6.2.5.5. directory <directory>+This directive specifies the directory where the LDBM files containing the database and associated indices live. +Default: ++ directory /usr/local/var/openldap-data ++ 6.2.5.6. index {<attrlist> | default} [pres,eq,approx,sub,none]+This directive specifies the indices to maintain for the given attribute. If only an <attrlist> is given, the default indices are maintained. +Example: ++ index default pres,eq + index uid + index cn,sn pres,eq,sub + index objectClass eq ++ 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 uid attribute type. The third line causes present, equality, and substring indices to be maintained for cn and sn attribute types. The fourth line causes an equality index for the 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 ++ 6.2.5.7. mode <integer>+This directive specifies the file protection mode that newly created database index files should have. +Default: ++ mode 0600 ++ 6.3. Access Control+Access to slapd entries and attributes is controlled by the access configuration file directive. The general form of an access line is: +
+ <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 <who> part specifies which entities are granted access, and the <access> part specifies the access granted. Multiple <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. +6.3.1. What to control access to+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: ++ 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 RFC2253. +The scope can be either base, one, subtree, or children. Where base matches only the entry with provided DN, one matches the entries whose parent is the provided DN, subtree matches all entries in the subtree whose root is the provided DN, and children matches all entries under the DN (but not the entry named by the DN). +For example, if the directory contained entries named: ++ 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 ++ Then: +
+dn.one="ou=people,o=suffix" match 3, and 5; + +dn.subtree="ou=people,o=suffix" match 2, 3, 4, and 5; and + +dn.children="ou=people,o=suffix" match 3, 4, and 5. Entries may also be selected using a filter: ++ to filter=<ldap filter> ++ where <ldap filter> is a string representation of an LDAP search filter, as described in RFC2254. For example: ++ to filter=(objectClass=person) ++ Note that entries may be selected by both DN and filter by including both qualifiers in the <what> clause. ++ to dn.one="ou=people,o=suffix" filter=(objectClass=person) ++ Attributes within an entry are selected by including a comma-separated list of attribute names in the <what> selector: ++ attrs=<attribute list> ++ A specific value of an attribute is selected by using a single attribute name and also using a value selector: ++ attrs=<attribute> val[.<style>]=<regex> ++ There are two special pseudo attributes entry and children. To read (and hence return) a target entry, the subject must have read access to the target's entry attribute. To add or delete an entry, the subject must have write access to the entry's entry attribute AND must have write access to the entry's parent's children attribute. To rename an entry, the subject must have write access to entry's entry attribute AND have write access to both the old parent's and new parent's children attributes. The complete examples at the end of this section should help clear things up. +Lastly, there is a special entry selector "*" that is used to select any entry. It is used when no other <what> selector has been provided. It's equivalent to "dn=.*" +6.3.2. 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." The following table summarizes entity specifiers: +
The DN specifier behaves much like <what> clause DN specifiers. +Other control factors are also supported. For example, a <who> can be restricted by an entry listed in a DN-valued attribute in the entry to which the access applies: ++ 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. +6.3.3. The access to grant+The kind of <access> granted can be one of the following: +
Each level implies all lower levels of access. So, for example, granting someone write access to an entry also grants them read, search, compare, and auth access. However, one may use the privileges specifier to grant specific permissions. +6.3.4. Access Control EvaluationWhen evaluating whether some requester should be given access to an entry and/or attribute, slapd compares the entry and/or attribute to the <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 <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 <who> selectors within the access directive selected above in the order in which they appear. It stops with the first <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 <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 <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. -5.3.5. Access Control Examples-The access control facility described above is quite powerful. This section shows some examples of its use. First, some simple examples: +6.3.5. Access Control Examples+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
@@ -1412,8 +2596,8 @@ needed to modify/rename
access to dn.subtree="dc=example,dc=com" attr=homePhone
by self write
- by dn.children=dc=example,dc=com" search
- by peername=IP:10\..+ read
+ 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
@@ -1426,7 +2610,7 @@ needed to modify/rename
by dnattr=member selfwrite
The dnattr <who> selector says that the access applies to entries listed in the member attribute. The 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. -5.4. Configuration File Example+6.4. Configuration File ExampleThe following is an example configuration file, interspersed with explanatory text. It defines two databases to handle different parts of the 1. # example config file - global configuration section @@ -1484,9 +2668,9 @@ needed to modify/rename - 6. Running slapd+7. Running slapdslapd(8) is designed to be run as a stand-alone server. This allows the server to take advantage of caching, manage concurrency issues with underlying databases, and conserve system resources. Running from inetd(8) is NOT an option. -6.1. Command-Line Options+7.1. Command-Line Optionsslapd(8) supports a number of command-line options as detailed in the manual page. This section details a few commonly used options.
-f <filename>
@@ -1646,13 +2830,13 @@ print entry parsing debugging
|