Preface
Copyright
-Copyright 1998-2000, The OpenLDAP Foundation, All Rights Reserved.
+Copyright 1998-2002, 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.0 Software on
This document provides a guide for installing OpenLDAP 2.1 Software (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.
| +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 + | +
Example:
++ backend 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 new database instance definition. <type> should be one of ldbm, shell, passwd, or other supported 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 ldbm + database bdb-
This marks the beginning of a new LDBM backend database instance definition.
+This marks the beginning of a new
5.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:
@@ -854,21 +983,28 @@ print entry parsing debuggingThis 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>
-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 the directory. The DN may refer to a SASL identity.
+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@EXAMPLE.COM" + rootdn "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 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 directive is deprecated in favor of SASL based authentication.
+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.
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.
Example:
@@ -887,147 +1023,139 @@ print entry parsing debuggingSASL-based Example:
- updatedn "uid=slurpd@EXAMPLE.COM" + updatedn "uid=slurpd,cn=example.com,cn=digest-md5,cn=auth"-
See the Replication chapter for more information on how to use this directive.
+See the Replication with slurpd chapter for more information on how to use this directive.
5.2.3.9. 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
-5.2.4. LDBM Backend-Specific Directives
-Directives 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.
-5.2.4.1. cachesize <integer>
+5.2.4. BDB Database Directives
+Directives in this category only apply to a
5.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 ++
5.2.5. LDBM Database Directives
+Directives in this category only apply to a
5.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
-5.2.4.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 indexes.
+5.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
-5.2.4.3. dbnolocking
+5.2.5.3. dbnolocking
This option, if present, disables database locking. Enabling this option may improve performance at the expense of data security.
-5.2.4.4. dbnosync
-This option causes on-disk database contents not be immediately synchronized with in memory changes upon change. Enabling this option may improve performance at the expense of data security.
-5.2.4.5. directory <directory>
-This directive specifies the directory where the LDBM files containing the database and associated indexes live.
+5.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.
+5.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-ldbm + directory /usr/local/var/openldap-data-
5.2.4.6. index {<attrlist> | default} [pres,eq,approx,sub,none]
-This directive specifies the indexes to maintain for the given attribute. If only an <attrlist> is given, the default indexes are maintained.
+5.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 objectClass,uid
- index cn,sn eq,sub,approx
+ 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 objectClass and uid attribute types. The third line causes equality, substring, and approximate indices to be maintained for cn and sn attribute types.
-5.2.4.7. mode <integer>
+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 ++
5.2.5.7. mode <integer>
This directive specifies the file protection mode that newly created database index files should have.
Default:
mode 0600
-5.2.5. Other Backend Databases
-slapd(8) supports a number of backend database types besides the default LDBM.
-| -Types - | --Description - | -
| -ldbm - | --Berkeley or GNU DBM compatible backend - | -
| -passwd - | --Provides read-only access to /etc/passwd - | -
| -shell - | --Shell (extern program) backend - | -
| -sql - | --SQL Programmable backend - | -
See slapd.conf(5) for details.
5.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[.<target style>]=<regex>]
+ <what> ::= * |
+ [dn[.<basic-style>]=<regex> | dn.<scope-style>=<DN>]
[filter=<ldapfilter>] [attrs=<attrlist>]
- <target style> ::= regex | base | one | subtree | children
+ <basic-style> ::= regex | exact
+ <scope-style> ::= base | one | subtree | children
<attrlist> ::= <attr> | <attr> , <attrlist>
<attr> ::= <attrname> | entry | children
- <who> ::= [* | anonymous | users | self |
- dn[.<subject style>]=<regex>]
- [dnattr=<attrname> ]
- [group[/<objectclass>[/<attrname>][.<basic style>]]=<regex> ]
- [peername[.<basic style>]=<regex>]
- [sockname[.<basic style>]=<regex>]
- [domain[.<basic style>]=<regex>]
- [sockurl[.<basic style>]=<regex>]
+ <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>]
- <subject style> ::= regex | exact | base | one | subtree | children
- <basic style> ::= regex | exact
<access> ::= [self]{<level>|<priv>}
<level> ::= none | auth | compare | search | read | write
<priv> ::= {=|+|-}{w|r|s|c|x}+
<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.
+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.
5.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 can be selected in two ways: by a regular expression matching the entry's distinguished 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:
- dn=<regular expression> + by * + by dn[.<basic-style>]=<regex> + by dn.<scope-style>=<DN>-
-Note: The DN pattern specified should be "normalized" to the RFC2253 restricted DN form. In particular, there should be no extra spaces and commas should be used to separate components. An example normalized DN is "cn=Babs Jensen,dc=example,dc=com". An example of a non-normalized DN is "cn=Babs Jensen; dc=example; dc=com". -
-
Or, entries may be selected by a filter matching some attribute(s) in the entry:
+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:
- filter=<ldap filter> + 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.base="ou=people,o=suffix" match 2;
+
+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:
++ by filter=<ldap filter> ++
where <ldap filter> is a string representation of an LDAP search filter, as described in RFC2254. For example:
++ by filter=(objectClass=person) ++
Note that entries by be select by both DN and filter by include both qualifiers in the <what> clause.
++ by dn.one="ou=people,o=suffix" filter=(objectClass=person)-
where <ldap filter> is a string representation of an LDAP search filter, as described in RFC2254.
Attributes within an entry are selected by including a comma-separated list of attribute names in the <what> selector:
attrs=<attribute list>
-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 psuedo attributes entry and children. To read (and hence return) an 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=.*"
5.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:
@@ -1075,20 +1203,24 @@ User associated with target entryThe DN specifier takes a regular expression which is used to match against the "normalized" DN of the current entity.
-- dn=<regular expression> --
By "normalized", we mean that all extra spaces have been removed from the entity's DN and commas are used to separate RDN components.
-Other control factors are also supported. For example, a <what> can be restricted by a regular expression matching the client's domain name:
+The DN specifier behaves much like <what> clause DN specifiers.
+Other control factors are also supported. For example, a <who> can be restricted by a regular expression matching the client's domain name:
domain=<regular expression>
@@ -1182,7 +1314,7 @@ needed to modify/rename
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.
5.3.4. 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 <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 <what> selector that matches the entry and/or attribute. The corresponding access directive is the one slapd will use to evaluate access.
+When 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.
@@ -1198,28 +1330,36 @@ needed to modify/rename by anonymous auth by * read -This directive allows users to modify their own entries, allows authenticate, and allows authenticated users to read. Note that only the first by <who> clause which matches applies. Hence, the anonymous users are granted auth, not read. The last clause could just as well have been "by users read".
+This directive allows users to modify their own entries, allows authenticate, and allows all others to read. Note that only the first by <who> clause which matches applies. Hence, the anonymous users are granted auth, not read. The last clause could just as well have been "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 simple authentication and read access when 64 or better security protections have been established.
The following example shows the use of a regular expression to select the entries by DN in two access directives where ordering is significant.
- access to dn=".*,dc=example,dc=com"
+ access to dn.children="dc=example,dc=com"
by * search
- access to dn=".*,dc=com"
+ access to dn.children="dc=com"
by * read
-Read access is granted to entries under the dc=com subtree, except for those entries under the dc=example,dc=com subtree, to which search access is granted. No access is granted to 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 dc=example,dc=com entries are also dc=com entries.
-Also note that if no access to directive matches or no by <who> clause, access is denied. That is, every access to directive ends with an implicit by * none clause and every access list ends with an implicit access to * by * none directive. Only if no access controls are specified is the defaultaccess granted.
-The next example again shows the importance of ordering, both of the access directives and the by <who> clauses. It also shows the use of an attribute selector to grant access to a specific attribute and various <who> selectors.
+Read access is granted to entries under the dc=com subtree, except for those entries under the dc=example,dc=com subtree, to which search access is granted. No access is granted to 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 dc=example,dc=com are also under dc=com entries.
+Also note that if no access to directive matches or no by <who> clause, access is denied. That is, every access to directive ends with an implicit by * none clause and every access list ends with an implicit access to * by * none directive.
+The next example again shows the importance of ordering, both of the access directives and the by <who> clauses. It also shows the use of an attribute selector to grant access to a specific attribute and various <who> selectors.
- access to dn="(.*,)?dc=example,dc=com" attr=homePhone
+ access to dn.subtree="dc=example,dc=com" attr=homePhone
by self write
- by dn="(.*,)?dc=example,dc=com" search
+ by dn.children=dc=example,dc=com" search
by domain=.*\.example\.com read
- access to dn="(.*,)?dc=example,dc=com"
+ access to dn.subtree="dc=example,dc=com"
by self write
- by dn=".*,dc=example,dc=com" search
+ by dn.children="dc=example,dc=com" search
by anonymous auth
-This example applies to entries in the "dc=example,dc=com" subtree. To all attributes except homePhone, the entry itself can write them, other example.com entries can search by them, anybody else has no access ((implicit by * none) excepting for authentication/authorization (which is always done anonymously). The homePhone attribute is writable by the entry, searchable by other example.com entries, readable by clients connecting from somewhere in the example.com domain, and otherwise not readable (implicit by * none). All other access is denied by the implicit access to * by * none.
+This example applies to entries in the "dc=example,dc=com" subtree. To all attributes except homePhone, an entry can write to itself, entries under example.com entries can search by them, anybody else has no access (implicit by * none) excepting for authentication/authorization (which is always done anonymously). The homePhone attribute is writable by the entry, searchable by entries under example.com, readable by clients connecting from somewhere in the example.com domain, and otherwise not readable (implicit by * none). All other access is denied by the implicit 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 to add and remove only their own DN from the member attribute, you could accomplish it with an access directive like this:
access to attr=member,entry
@@ -1227,21 +1367,21 @@ needed to modify/rename
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
-The following is an example configuration file, interspersed with explanatory text. It defines two databases to handle different parts of the
The 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 2. include /usr/local/etc/schema/core.schema 3. referral ldap://root.openldap.org 4. access to * by * read-
Line 1 is a comment. Line 2 includes another config file which containing core schema definitions. The 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 root.openldap.org.
-Line 4 is a global access control. It is used only if no database access controls match or when the target objects are not under the control of any database (such as the Root DSE).
-The next section of the configuration file defines an LDBM backend that will handle queries for things in 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 userPassword attribute is to be protected from unauthorized access.
+Line 1 is a comment. Line 2 includes another config file which contains core schema definitions. The 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 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 a BDB backend that will handle queries for things in 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. Indices are to be maintained for several attributes, and the userPassword attribute is to be protected from unauthorized access.
- 5. # ldbm definition for the example.com - 6. database ldbm + 5. # BDB definition for the example.com + 6. database bdb 7. suffix "dc=example,dc=com" - 8. directory /usr/local/var/openldap + 8. directory /usr/local/var/openldap-data 9. rootdn "cn=Manager,dc=example,dc=com" 10. rootpw secret 11. # replication directives @@ -1256,30 +1396,31 @@ needed to modify/rename 20. index uid pres,eq 21. index cn,sn,uid pres,eq,approx,sub 22. index objectClass eq - 23. # ldbm access control definitions + 23. # database access control definitions 24. access to attr=userPassword 25. by self write 26. by anonymous auth - 27. by dn="cn=Admin,dc=example,dc=com" write + 27. by dn.base="cn=Admin,dc=example,dc=com" write 28. by * none 29. access to * 30. by self write - 31. by dn="cn=Admin,dc=example,dc=com" write - 32. by users read + 31. by dn.base="cn=Admin,dc=example,dc=com" write + 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 11 specifies the replication log file (where changes to the database are logged - this file is written by slapd and read by slurpd). Lines 12 through 14 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 15 through 18 specify a second replication site. See the Replication with slurpd chapter for more information on these directives.
-Lines 20 through 22 indicate the indexes to maintain for various attributes.
-Lines 24 through 32 specify access control for entries in the database. For all entries, the 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 authenticated users.
-The next section of the example configuration file defines another LDBM database. This one handles queries involving the dc=example,dc=net subtree. Note that without line 38, the read access would be allowed due to the global access rule at line 4.
+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 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 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 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.
- 33. # ldbm definition for example.net - 34. database ldbm + 33. # BDB definition for example.net + 34. database bdb 35. suffix "dc=example,dc=net" - 36. directory /usr/local/var/ldbm-example-net + 36. directory /usr/local/var/openldap-data-net 37. rootdn "cn=Manager,dc=example,dc=com" - 38. access to * by users read + 38. index objectClass eq + 39. access to * by users read
@@ -1441,7 +1582,7 @@ print entry parsing debugging
You may enable multiple levels by specifying the debug option once for each desired level. Or, since debugging levels are additive, you can do the math yourself. That is, if you want to trace function calls and watch the config file being processed, you could set level to the sum of those two levels (in this case, -d 65). Or, you can let slapd do the math, (e.g. -d 1 -d 64). Consult <ldap.h> for more details.
+You may enable multiple levels by specifying the debug option once for each desired level. Or, since debugging levels are additive, you can do the math yourself. That is, if you want to trace function calls and watch the config file being processed, you could set level to the sum of those two levels (in this case, -d 65). Or, you can let slapd do the math, (e.g. -d 1 -d 64). Consult <ldap_log.h> for more details.
Note: slapd must have been compiled with -DLDAP_DEBUG defined for any debugging information beyond the two stats levels to be available.
@@ -1478,7 +1619,7 @@ print entry parsing debugging
For example:
- directory /usr/local/var/openldap-ldbm + directory /usr/local/var/openldap-data
You need to create this directory with appropriate permissions such that slapd can write to it.
You need to configure slapd so that you can connect to it as a directory user with permission to add entries. You can configure the directory to support a special super-user or root user just for this purpose. This is done through the following two options in the database definition:
@@ -1498,10 +1639,11 @@ print entry parsing debuggingFor example, to index the cn, sn, uid and objectclass attributes, the following index directives could be used:
- index cn,sn,uid - index objectClass pres,eq + index cn,sn,uid pres,eq,approx,sub + index objectClass eq-
See The slapd Configuration File section for more details on this option. Once you have configured things to your liking, start up slapd, connect with your LDAP client, and start adding entries. For example, to add an organization entry and an organizational role entry using the ldapadd tool, you could create an
This would create presence, equality, approximate, and substring indices for the cn, sn, and uid attributes and an equality index for the objectClass attribute. Note that not all index types are available with all attribute types. See The slapd Configuration File section for more information on this option.
+Once you have configured things to your liking, start up slapd, connect with your LDAP client, and start adding entries. For example, to add an organization entry and an organizational role entry using the ldapadd tool, you could create an
# Organization for Example Corporation
dn: dc=example,dc=com
@@ -1537,20 +1679,20 @@ print entry parsing debugging
For example:
- directory /usr/local/var/openldap-ldbm + directory /usr/local/var/openldap-data-
Finally, you need to specify which indexes you want to build. This is done by one or more index options.
+Finally, you need to specify which indices you want to build. This is done by one or more index options.
index {<attrlist> | default} [pres,eq,approx,sub,none]
For example:
- index cn,sn,uid pres,eq,approx
+ index cn,sn,uid pres,eq,approx,sub
index objectClass eq
-This would create presence, equality and approximate indexes for the cn, sn, and uid attributes and an equality index for the objectClass attribute. See the configuration file section for more information on this option.
+This would create presence, equality, approximate, and substring indices for the cn, sn, and uid attributes and an equality index for the objectClass attribute. Note that not all index types are available with all attribute types. See The slapd Configuration File section for more information on this option.
7.2.1. The slapadd program
-Once you've configured things to your liking, you create the primary database and associated indexes by running the slapadd(8) program:
+Once you've configured things to your liking, you create the primary database and associated indices by running the slapadd(8) program:
slapadd -l <inputfile> -f <slapdconfigfile>
[-d <debuglevel>] [-n <integer>|-b <suffix>]
@@ -1559,11 +1701,11 @@ print entry parsing debugging
-l <inputfile>
-Specifies the LDIF input file containing the entries to add in text form (described below in the The LDIF text entry format section).
+Specifies the LDIF input file containing the entries to add in text form (described below in the The LDIF text entry format section).
-f <slapdconfigfile>
-Specifies the slapd configuration file that tells where to create the indexes, what indexes to create, etc.
+Specifies the slapd configuration file that tells where to create the indices, what indices to create, etc.
-d <debuglevel>
@@ -1571,7 +1713,7 @@ print entry parsing debugging
-n <databasenumber>
-An optional argument that specifies which database to modify. The first database listed in the configuration file is 1, the second 2, etc. By default, the first ldbm database in the configuration file is used. Should not be used in conjunction with -b.
+An optional argument that specifies which database to modify. The first database listed in the configuration file is 1, the second 2, etc. By default, the first database in the configuration file is used. Should not be used in conjunction with -b.
-b <suffix>
@@ -1589,7 +1731,7 @@ print entry parsing debugging
slapcat -l <filename> -f <slapdconfigfile>
[-d <debuglevel>] [-n <databasenumber>|-b <suffix>]
-where -n or -b is used to select the database in the slapd.conf(5) specified using -f. The corresponding LDIF output is written to standard output or to the file specified using the -l option.
+where -n or -b is used to select the database in the slapd.conf(5) specified using -f. The corresponding
7.3. The LDIF text entry format
The
The basic form of an entry is:
@@ -1663,11 +1805,12 @@ print entry parsing debugging8. Schema Specification
-This chapter describes how to extend the schema used by slapd(8). The first section, Distributed Schema Files details optional schema definitions provided in the distribution and where to obtain other definitions. The second section, Extending Schema, details how to define new schema items.
+This chapter describes how to extend the user schema used by slapd(8). The first section, Distributed Schema Files details optional schema definitions provided in the distribution and where to obtain other definitions. The second section, Extending Schema, details how to define new schema items.
+This chapter does not discuss how to extend system schema used by slapd(8) as this requires source code modification. System schema includes all operational attribute types or any object class which allows or requires an operational attribute (directly or indirectly).
8.1. Distributed Schema Files
OpenLDAP is distributed with a set of schema specifications for your use. Each set is defined in a file suitable for inclusion (using the include directive) in your slapd.conf(5) file. These schema files are normally installed in the /usr/local/etc/openldap/schema directory.
| File @@ -1710,14 +1853,6 @@ Assorted (experimental) | |
| -nadf.schema - | --North American Directory Forum (FYI) - | -
| nis.schema | @@ -1734,7 +1869,7 @@ OpenLDAP Project (experimental) |
To use any of these schema files, you only need to include the the desired file in the global definitions portion of your slapd.conf(5) file. For example:
+To use any of these schema files, you only need to include the desired file in the global definitions portion of your slapd.conf(5) file. For example:
# include schema
include /usr/local/etc/openldap/schema/core.schema
@@ -1746,7 +1881,7 @@ OpenLDAP Project (experimental)
Note: You should not modify any of the schema items defined in provided files.
8.2. Extending Schema
-Schema used by slapd(8) may be extended to support additional syntaxes, matching rules, attribute types, and object classes. This chapter details how to add attribute types and object classes using the syntaxes and matching rules already supported by slapd. slapd can also be extended to support additional syntaxes and matching rules, but this requires some programming and hence is not discussed here.
+Schema used by slapd(8) may be extended to support additional syntaxes, matching rules, attribute types, and object classes. This chapter details how to add user application attribute types and object classes using the syntaxes and matching rules already supported by slapd. slapd can also be extended to support additional syntaxes, matching rules and system schema, but this requires some programming and hence is not discussed here.
There are five steps to defining new schema:
- obtain Object Identifer
@@ -1757,7 +1892,7 @@ OpenLDAP Project (experimental)
8.2.1. Object Identifiers
Each schema element is identified by a globally unique Object Identifier (OID). OIDs are also used to identify other objects. They are commonly found in protocols described by ASN.1 . In particular, they are heavily used by the Simple Network Management Protocol (SNMP). As OIDs are hierarchical, your organization can obtain one OID and branch it as needed. For example, if your organization were assigned OID 1.1, you could branch the tree as follows:
-Table 6.2: Example OID hierarchy
+Table 8.2: Example OID hierarchy
OID
@@ -1824,18 +1959,20 @@ myObjectClass
-You are, of course, free to design a hierarchy suitable to your organizational needs under your organization's OID. No matter what hierarchy you choose, you should maintain a registry of assignments you make. This can be a simple flat file or a something more sophisticated such as the OpenLDAP OID Registry (http://www.openldap.org/faq/index.cgi?file=197).
+You are, of course, free to design a hierarchy suitable to your organizational needs under your organization's OID. No matter what hierarchy you choose, you should maintain a registry of assignments you make. This can be a simple flat file or something more sophisticated such as the OpenLDAP OID Registry (http://www.openldap.org/faq/index.cgi?file=197).
For more information about Object Identifers (and a listing service) see http://www.alvestrand.no/harald/objectid/.
-Under no circumstances should you use a fictious OID!
-To obtain a fully registered OID at no cost, apply for an OID under Internet Assigned Numbers Authority (IANA) maintained Private Enterprise arch. Any private enterprise (organization) may request an OID to be assigned under this arch. Just fill out the IANA form at http://www.iana.org/cgi-bin/enterprise.pl and your official OID will be sent to you usually within a few days. Your base OID will be something like 1.3.6.1.4.1.X were X is an integer.
+Under no circumstances should you hijack OID namespace!
+To obtain a registered OID at no cost, apply for an OID under the Internet Assigned Numbers Authority (IANA) maintained Private Enterprise arc. Any private enterprise (organization) may request an OID to be assigned under this arc. Just fill out the IANA form at http://www.iana.org/cgi-bin/enterprise.pl and your official OID will be sent to you usually within a few days. Your base OID will be something like 1.3.6.1.4.1.X where X is an integer.
-Note: Don't let the "MIB/SNMP" statement on the IANA page confuse you. OIDs obtained using this form may be used for any purpose including identifying LDAP schema elements.
+Note: Don't let the "MIB/SNMP" statement on the IANA page confuse you. OIDs obtained using this form may be used for any purpose including identifying LDAP schema elements.
+Alternatively, OID name space may be available from a national authority (e.g., ANSI, BSI).
+For private experiments, OIDs under 1.1 may be used. The OID 1.1 arc is regarded as dead name space.
8.2.2. Name Prefix
In addition to assigning a unique object identifier to each schema element, you should provide a least one textual name for each element. The name should be both descriptive and not likely to clash with names of other schema elements. In particular, any name you choose should not clash with present or future Standard Track names.
-To reduce (but not eliminate) the potential for name clashes, the convention is to prefix names of non-Standard Track with a few letters to localize the changes to your organization. The smaller the organization, the longer your prefix should be.
-In the examples below, we have choosen a short prefix 'my' (to save space). Such a short prefix would only be suitable for a very large, global organization. For a small, local organization, we recommend something like 'deFirm' (German company) or 'comExample' (elements associated with organization associated with example.com).
+To reduce (but not eliminate) the potential for name clashes, the convention is to prefix names of non-Standard Track with a few letters to localize the changes to your organization. The smaller the organization, the longer your prefix should be.
+In the examples below, we have chosen a short prefix 'my' (to save space). Such a short prefix would only be suitable for a very large, global organization. In general, we recommend something like 'deFirm' (German company) or 'comExample' (elements associated with organization associated with example.com).
8.2.3. Local schema file
The objectclass and attributeTypes configuration file directives can be used to define schema rules on entries in the directory. It is customary to create a file to contain definitions of your custom schema items. We recommend you create a file local.schema in /usr/local/etc/openldap/schema/local.schema and then include this file in your slapd.conf(5) file immediately after other schema include directives.
@@ -1863,7 +2000,7 @@ myObjectClass
[ "EQUALITY" woid ; Matching Rule name
[ "ORDERING" woid ; Matching Rule name
[ "SUBSTR" woid ] ; Matching Rule name
- [ "SYNTAX" whsp noidlen whsp ] ; see section 4.3
+ [ "SYNTAX" whsp noidlen whsp ] ; Syntax OID
[ "SINGLE-VALUE" whsp ] ; default multi-valued
[ "COLLECTIVE" whsp ] ; default not collective
[ "NO-USER-MODIFICATION" whsp ]; default user modifiable
@@ -1877,20 +2014,22 @@ myObjectClass
"dSAOperation" ; DSA-specific, value depends on server
-where whsp is a space (' '), numericoid is a globally unique OID in numeric form (e.g. 1.2.3), qdescrs is one or more names, woid is either the name or OID, and noidlen is an optional length specifier (e.g {10}).
+where whsp is a space (' '), numericoid is a globally unique OID in dotted-decimal form (e.g. 1.1.0), qdescrs is one or more names, woid is either the name or OID optionally followed by a length specifier (e.g {10}).
For example, the attribute types name and cn are defined in core.schema as:
attributeType ( 2.5.4.41 NAME 'name'
+ DESC 'name(s) associated with the object'
EQUALITY caseIgnoreMatch
SUBSTR caseIgnoreSubstringsMatch
SYNTAX 1.3.6.1.4.1.1466.115.121.1.15{32768} )
- attributeType ( 2.5.4.3 NAME
- ( 'cn' $ 'commonName' ) SUP name )
+ attributeType ( 2.5.4.3 NAME ( 'cn' 'commonName' )
+ DESC 'common name(s) assciated with the object'
+ SUP name )
-Notice that each defines the attribute's OID and descriptive names. Each name is an alias for the OID. slapd(8) returns the first listed name when returning results.
-The first attribute, name, has a syntax of directoryString (a UTF-8 encoded Unicode string) with a recommend maximun length. Note that syntaxes are specified by OID. In addition, the equality and substring matching uses case ignore rules. Below are tables listing commonly used supported syntax and matching rules.
+Notice that each defines the attribute's OID, provides a short name, and a brief description. Each name is an alias for the OID. slapd(8) returns the first listed name when returning results.
+The first attribute, name, holds values of directoryString (UTF-8 encoded Unicode) syntax. The syntax is specified by OID (1.3.6.1.4.1.1466.115.121.1.15 identifies the directoryString syntax). A length recommendation of 32768 is specified. Servers should support values of this length, but may support longer values The field does NOT specify a size constraint, so is ignored on servers (such as slapd) which don't impose such size limits. In addition, the equality and substring matching uses case ignore rules. Below are tables listing commonly used syntax and matching rules (OpenLDAP supports these and many more).
-Table 6.3: Supported Syntaxes
+Table 8.3: Commonly Used Syntaxes
Name
@@ -1904,17 +2043,6 @@ myObjectClass
-binary
-
-
-1.3.6.1.4.1.1466.115.121.1.5
-
-
-BER/DER data
-
-
-
-
boolean
@@ -2029,7 +2157,7 @@ printable string
-Table 6.4: Supported Matching Rules
+Table 8.4: Commonly Used Matching Rules
Name
@@ -2054,6 +2182,17 @@ boolean
+octetStringMatch
+
+
+equality
+
+
+octet string
+
+
+
+
objectIdentiferMatch
@@ -2082,7 +2221,7 @@ DN
equality
-DN with optional UID
+Name with optional UID
@@ -2253,7 +2392,7 @@ case sensitive, space insensitive
The second attribute, cn, is a subtype of name hence it inherits the syntax, matching rules, and usage of name. commonName is an alternative name.
-Neither attribute is restricted to a single value and both are meant for usage by user applications. You likely won't need to specify other parameters such as OBSOLETE.
+Neither attribute is restricted to a single value. Both are meant for usage by user applications. Neither is obsolete nor collective.
The following subsections provide a couple of examples.
8.2.4.1. myUniqueName
Many organizations maintain a single unique name for each user. Though one could use displayName (RFC2798), this attribute is really meant to be controlled by the user, not the organization. We could just copy the definition of displayName from inetorgperson.schema and replace the OID, name, and description, e.g:
@@ -2279,9 +2418,14 @@ case sensitive, space insensitive
SYNTAX 1.3.6.1.4.1.1466.115.121.1.40
SINGLE-VALUE )
-As noted in the description, LDAP has no knowledge of the format of the photo. It's assumed that all applications accessing this attribute agree on the handling of values.
+In this case, the syntax doesn't specify the format of the photo. It's assumed (maybe incorrectly) that all applications accessing this attribute agree on the handling of values.
If you wanted to support multiple photo formats, you could define a separate attribute type for each format, prefix the photo with some typing information, or describe the value using ASN.1 and use the ;binary transfer option.
-Another alternative is for the attribute to hold a URI pointing to the photo. You can model such an attribute after labeledURI (RFC2079).
+Another alternative is for the attribute to hold a URI pointing to the photo. You can model such an attribute after labeledURI (RFC2079) or simply create a subtype, e.g.:
+
+ attributetype ( 1.1.2.1.3 NAME 'myPhotoURI'
+ DESC 'URI and optional label referring to a photo'
+ SUP labeledURI )
+
8.2.5. Object Class Specification
The objectclasses directive is used to define a new object class. The directive uses the same Object Class Description (as defined in RFC2252) used by the objectClasses attribute found in the subschema subentry, e.g.:
@@ -2301,7 +2445,7 @@ case sensitive, space insensitive
[ "MAY" oids ] ; AttributeTypes
whsp ")"
-where whsp is a space (' '), numericoid is a globally unique OID in numeric form (e.g. 1.2.3), qdescrs is one or more names, and oids is one or more names and/or OIDs.
+where whsp is a space (' '), numericoid is a globally unique OID in numeric form (e.g. 1.1.0), qdescrs is one or more names, and oids is one or more names and/or OIDs.
8.2.5.1. myPhotoObject
To define an auxiliary object class which allows myPhoto to be added to any existing entry.
@@ -2316,17 +2460,386 @@ case sensitive, space insensitive
objectclass ( 1.1.2.2.2 NAME 'myPerson'
DESC 'my person'
SUP inetOrgPerson
- MUST ( 'myUniqueName' $ 'givenName' )
- MAY 'myPhoto' )
+ MUST ( myUniqueName $ givenName )
+ MAY myPhoto )
The object class inherits the required/allowed attribute types of inetOrgPerson but requires myUniqueName and givenName and allows myPhoto.
+8.2.6. OID Macros
+To ease the management and use of OIDs, slapd(8) supports Object Identifier macros. The objectIdentifier directive is used to equate a macro (name) with a OID. The OID may possibly be derived from a previously defined OID macro. The slapd.conf(5) syntax is:
+
+ objectIdentifier <name> { <oid> | <name>[:<suffix>] }
+
+The following demonstrates definition of a set of OID macros and their use in defining schema elements:
+
+ objectIdentifier myOID 1.1
+ objectIdentifier mySNMP myOID:1
+ objectIdentifier myLDAP myOID:2
+ objectIdentifier myAttributeType myLDAP:1
+ objectIdentifier myObjectClass myLDAP:2
+ attributetype ( myAttributeType:3 NAME 'myPhotoURI'
+ DESC 'URI and optional label referring to a photo'
+ SUP labeledURI )
+ objectclass ( myObjectClass:1 NAME 'myPhotoObject'
+ DESC 'mixin myPhoto'
+ AUXILIARY
+ MAY myPhoto )
+
-9. Constructing a Distributed Directory Service
+9. Security Considerations
+OpenLDAP Software is designed to run in a wide variety of computing environments from tightly-controlled closed networks to the global Internet. Hence, OpenLDAP Software provides many different security mechanisms. This chapter describes these mechanisms and discusses security considerations for using OpenLDAP Software.
+9.1. Network Security
+9.1.1. Selective Listening
+By default, slapd(8) will listen on both the IPv4 and IPv6 "any" addresses. It is often desirable to have slapd listen on select address/port pairs. For example, listening only on the IPv4 address 127.0.0.1 will disallow remote access to the directory server. E.g.:
+
+ slapd -h ldap://127.0.0.1
+
+While the server can be configured to listen on a particular interface address, this doesn't necessarily restrict access to the server to only those networks accessible via that interface. To selective restrict remote access, it is recommend that an IP Firewall be used to restrict access.
+See Command-line Options and slapd(8) for more information.
+9.1.2. IP Firewall
+IP firewall capabilities of the server system can be used to restrict access based upon the client's IP address and/or network interface used to communicate with the client.
+Generally, slapd(8) listens on port 389/tcp for LDAP over TCP (e.g. ldap://) and port 636/tcp for LDAP over SSL (e.g. ldaps://). Note that LDAP over TCP sessions can be protected by TLS through the use of StartTLS. StartTLS is the Standard Track mechanism for protecting LDAP sessions with TLS.
+As specifics of how to configure IP firewall are dependent on the particular kind of IP firewall used, no examples are provided here. See the document associated with your IP firewall.
+9.1.3. TCP Wrappers
+OpenLDAP supports TCP Wrappers. TCP Wrappers provide a rule-based access control system for controlling TCP/IP access to the server. For example, the host_options(5) rule:
+
+ slapd: 10.0.0.0/255.0.0.0 127.0.0.1 : ALLOW
+ slapd: ALL : DENY
+
+allows only incoming connections from the private network 10.0.0.0 and localhost (127.0.0.1) to access the directory service. Note that IP addresses are used as slapd(8) is not normally configured to perform reverse lookups.
+It is noted that TCP wrappers require the connection to be accepted. As significant processing is required just to deny a connection, it is generally advised that IP firewall protection be used instead of TCP wrappers.
+See hosts_access(5) for more information on TCP wrapper rules.
+9.2. Integrity and Confidentiality Protection
+Transport Layer Security (TLS) can be used to provide integrity and confidentiality protection. OpenLDAP supports both StartTLS and ldaps://. See the Using TLS chapter for more information.
+A number of Simple Authentication and Security Layer (SASL) mechanisms, such as DIGEST-MD5 and GSSAPI , also provide integrity and confidentiality protection. See the Using SASL chapter for more information.
+9.2.1. Security Strength Factors
+The server uses Security Strength Factor s (SSF) to indicate the relative strength of protection. A SSF of zero (0) indicates no protections are in place. A SSF of one (1) indicates integrity protection are in place. A SSF greater than one (>1) roughly correlates to the effective encryption key length. For example, DES is 56, 3DES is 112, and AES 128, 192, or 256.
+A number of administrative controls rely on SSFs associated with TLS and SASL protection in place on an LDAP session.
+security controls disallow operations when appropriate protections are not in place. For example:
+
+ security ssf=1 update_ssf=112
+
+requires integrity protection for all operations and encryption protection, 3DES equivalent, for update operations (e.g. add, delete, modify, etc.). See slapd.conf(5) for details.
+For fine-grained control, SSFs may be used in access controls. See Access Control section of the The slapd Configuration File for more information.
+9.3. Authentication Methods
+9.3.1. "simple" method
+The LDAP "simple" method has three modes of operation:
+
+- anonymous,
+
- unauthenticated, and
+
- user/password authenticated.
+Anonymous access is obtained by providing no name and no password to the "simple" bind operation. Unauthenticated access is obtained by providing a name but no password. Authenticated access is obtain by providing a valid name and password.
+An anonymous bind results in an anonymous authorization. Anonymous bind mechanism is enabled by default, but can be disabled by specifying "disallow bind_anon" in slapd.conf(5).
+An unauthenticated bind results in an anonymous authorization. Unauthenticated bind mechanism is disabled by default, but can be enabled by specifying "allow bind_anon_cred" in slapd.conf(5). As a number of LDAP applications mistakenly generate unauthenticated bind request when authenticated access was intended (that is, they do not ensure a password was provided), this mechanism should generally not be enabled.
+A successful user/password authenticated bind results in a user authorization identity, the provided name, being associated with the session. User/password authenticated bind is enabled by default. However, as this mechanism offers no evesdropping protection (e.g., the password is set in the clear), it is recommended that it be used only in tightly controlled systems or when the LDAP session is protected by other means (e.g., TLS, IPSEC ). Where the administrator relies on TLS to protect the password, it is recommended that unprotected authentication be disabled. This is done by setting "disallow bind_simple_unprotected" in slapd.conf(5). The security directive's simple_bind option provides fine grain control over the level of confidential protection to require for simple user/password authentication.
+The user/password authenticated bind mechanism can be completely disabled by setting "disallow bind_simple".
+
+Note: An unsuccessful bind always results in the session having an anonymous authorization state.
+
+9.3.2. SASL method
+The LDAP SASL method allows use of any SASL authentication mechanism. The Using SASL discusses use of SASL.
+
+
+10. Using SASL
+OpenLDAP clients and servers are capable of authenticating via the Simple Authentication and Security Layer (SASL ) framework, which is detailed in RFC2222. This chapter describes how to make use of SASL in OpenLDAP.
+There are several industry standard authentication mechanisms that can be used with SASL, including Kerberos V4, GSSAPI , and DIGEST-MD. The standard client tools provided with OpenLDAP, such as ldapsearch(1) and ldapmodify(1), will by default attempt to authenticate the user to the slapd(8) server using SASL. Basic authentication service can be set up by the LDAP administrator with a few steps, allowing users to be authenticated to the slapd server as their LDAP entry. With a few extra steps, some users and services can be allowed to exploit SASL's proxy authorization feature, allowing them to authenticate themselves and then switch their identity to that of another user or service.
+This chapter assumes you have read Cyrus SASL for System Administrators, provided with the Cyrus SASL package (in doc/sysadmin.html) and have a working Cyrus SASL installation. You should use the Cyrus SASL sample_client and sample_server to test your SASL installation before attempting to make use of it in OpenLDAP.
+Note that in the following text the term user is used to describe a person or application entity who is connecting to the LDAP server via an LDAP client, such as ldapsearch(1). That is, the term user not only applies to both an individual using an LDAP client, but to an application entity which issues LDAP client operations without direct user control. For example, an e-mail server which uses LDAP operations to access information held in an LDAP server is an application entity.
+10.1. SASL Security Considerations
+SASL offers many different authentication mechanisms. This section briefly outlines security considerations.
+Some mechanisms, such as PLAIN and LOGIN, offer no greater security over LDAP "simple" authentication. Like "simple" authentication, such mechanisms should not be used unless you have adequate security protections in place. It is recommended that these mechanisms be used only in conjunction with Transport Layer Security (TLS). Use of PLAIN and LOGIN are not discussed further in this document.
+The DIGEST-MD5 mechanism is the mandatory-to-implement authentication mechanism for LDAPv3. Though DIGEST-MD5 is not a strong authentication mechanism in comparison with trusted third party authentication systems (such as Kerberos or public key systems), yet it does offer significant protections against a number of attacks. Unlike the CRAM-MD5 mechanism, it prevents chosen plaintext attacks. DIGEST-MD5 is favored over the weaker and even more dangerous use of plaintext password mechanisms. The CRAM-MD5 mechanism is deprecated in favor of DIGEST-MD5. Use of DIGEST-MD5 is discussed below.
+The KERBEROS_V4 mechanism utilizes Kerberos IV to provide secure authentication services. There is also a GSSAPI based mechanism which is generally used in conjunction with Kerberos V. Kerberos is viewed as a secure, distributed authentication system suitable for both small and large enterprises. Use of KERBEROS_V4 and GSSAPI are discussed below.
+The EXTERNAL mechanism utilizes authentication services provided by lower level network services such as TLS (TLS). When used in conjunction with TLS X.509 -based public key technology, EXTERNAL offers strong authentication. Use of EXTERNAL is discussed in the Using TLS chapter.
+There are other strong authentication mechanisms to choose from, including OTP (one time passwords) and SRP (secure remote passwords). These mechanisms are not discussed in this document.
+10.2. SASL Authentication
+Getting basic SASL authentication running involves a few steps. The first step configures your slapd server environment so that it can communicate with client programs using the security system in place at your site. This usually involves setting up a service key, a public key, or other form of secret. The second step concerns mapping authentication identities to LDAP DN's, which depends on how entries are laid out in your directory. An explanation of the first step will be given in the next section using Kerberos V4 as an example mechanism. The steps necessary for your site's authentication mechanism will be similar, but a guide to every mechanism available under SASL is beyond the scope of this chapter. The second step is described in the section Mapping Authentication identities to LDAP entries.
+10.2.1. KERBEROS_V4
+This section describes the use of the SASL KERBEROS_V4 mechanism with OpenLDAP. It will be assumed that you are familiar with the workings of the Kerberos IV security system, and that your site has Kerberos IV deployed. Your users should be familiar with authentication policy, how to receive credentials in a Kerberos ticket cache, and how to refresh expired credentials.
+Client programs will need to be able to obtain a session key for use when connecting to your LDAP server. This allows the LDAP server to know the identity of the user, and allows the client to know it is connecting to a legitimate server. If encryption layers are to be used, the session key can also be used to help negotiate that option.
+The slapd server runs the service called "ldap", and the server will require a srvtab file with a service key. SASL aware client programs will be obtaining an "ldap" service ticket with the user's ticket granting ticket (TGT), with the instance of the ticket matching the hostname of the OpenLDAP server. For example, if your realm is named EXAMPLE.COM and the slapd server is running on the host named directory.example.com, the /etc/srvtab file on the server will have a service key
+
+ ldap.directory@EXAMPLE.COM
+
+When an LDAP client is authenticating a user to the directory using the KERBEROS_IV mechanism, it will request a session key for that same principal, either from the ticket cache or by obtaining a new one from the Kerberos server. This will require the TGT to be available and valid in the cache as well. If it is not present or has expired, SASL will print out the message
+
+ ldap_sasl_interactive_bind_s: Local error
+
+When the service ticket is obtained, it will be passed to the LDAP server as proof of the user's identity. The server will extract the identity and realm out of the service ticket using SASL library calls, and convert them into an authentication request DN of the form
+
+ uid=<username>,cn=<realm>,cn=<mechanism>,cn=auth
+
+So in our above example, if the user's name were "adamson", the authentication request DN would be:
+
+ uid=adamsom,cn=example.com,cn=kerberos_v4,cn=auth
+
+This authentication request DN by itself could be placed into ACL's and groupOfNames "member" attributes, since it is of legitimate LDAP DN format. The section Mapping Authentication identities to LDAP entries, however, tells how to map that DN into the DN of a person's own LDAP entry.
+Also note that this example, being for Kerberos, shows the <realm> portion of the DN being filled in with the Kerberos realm of the company. Several other authentication mechanisms do not employ the concept of a realm, so the ",cn=<realm>" portion of the authentication request DN would not appear.
+10.2.2. GSSAPI
+This section describes the use of the SASL GSSAPI mechanism and Kerberos V with OpenLDAP. Since Kerberos V is being used, the information is very similar to the previous section. It will be assumed that you have Kerberos V deployed, you are familiar with the operation of the system, and that your users are trained in its use. This section also assumes you have familiarized yourself with the use of the GSSAPI mechanism by reading Configuring GSSAPI and Cyrus SASL (provided with Cyrus SASL in the doc/gssapi file) and successfully experimented with the Cyrus provided sample_server and sample_client applications. General information about Kerberos is available at http://web.mit.edu/kerberos/www/.
+To use the GSSAPI mechanism with slapd(8) one must create a service key with a principal for ldap service within the realm for the host on which the service runs. For example, if you run slapd on directory.example.com and your realm is EXAMPLE.COM, you need to create a service key with the principal:
+
+ ldap/directory.example.com@EXAMPLE.COM
+
+When slapd(8) runs, it must have access to this key. This is generally done by placing the key into a keytab, such as /etc/krb5.keytab.
+To use the GSSAPI mechanism to authenticate to the directory, the user obtains a Ticket Granting Ticket (TGT) prior to running the LDAP client. When using OpenLDAP client tools, the user may mandate use of the GSSAPI mechanism by specifying -Y GSSAPI as a command option.
+For the purposes of authentication and authorization, slapd(8) associates a non-mapped authentication request DN of the form:
+
+ uid=<principal>,cn=<realm>,cn=gssapi,cn=auth
+
+Continuing our example, a user with the Kerberos principal kurt@EXAMPLE.COM would have the associated DN:
+
+ uid=kurt,cn=example.com,cn=gssapi,cn=auth
+
+and the principal ursula@FOREIGN.REALM would have the associated DN:
+
+ uid=ursula,cn=foreign.realm,cn=gssapi,cn=auth
+
+10.2.3. DIGEST-MD5
+This section describes the use of the SASL DIGEST-MD5 mechanism using secrets stored either in the directory itself or in Cyrus SASL's own database. DIGEST-MD5 relies on the client and the server sharing a "secret", usually a password. The server generates a challenge and the client a response proving that it knows the shared secret. This is much more secure than simply sending the secret over the wire.
+Cyrus SASL supports several shared-secret mechanisms. To do this, it needs access to the plaintext password (unlike mechanisms which pass plaintext passwords over the wire, where the server can store a hashed version of the password).
+Secret passwords are normally stored in Cyrus SASL's own sasldb database, but if OpenLDAP has been compiled with Cyrus SASL 2.1 it is possible to store the secrets in the LDAP database itself. With Cyrus SASL 1.5, secrets may only be stored in the sasldb. In either case it is very important to apply file access controls and LDAP access controls to prevent exposure of the passwords.
+The configuration and commands discussed in this section assume the use of Cyrus SASL 2.1. If you are using version 1.5 then certain features will not be available, and the command names will not have the trailing digit "2".
+To use secrets stored in sasldb, simply add users with the saslpasswd2 command:
+
+ saslpasswd2 -c <username>
+
+The passwords for such users must be managed with the saslpasswd2 command.
+To use secrets stored in the LDAP directory, place plaintext passwords in the userPassword attribute. It will be necessary to add an option to slapd.conf to make sure that passwords changed through LDAP are stored in plaintext:
+
+ password-hash {CLEARTEXT}
+
+Passwords stored in this way can be managed either with ldappasswd or by simply modifying the userPassword attribute.
+Wherever the passwords are stored, a mapping will be needed from SASL authentication IDs to regular DNs. The DIGEST-MD5 mechanism produces authentication IDs of the form:
+
+ uid=<username>,cn=<realm>,cn=digest-md5,cn=auth
+
+NOTE that if the default realm is used, the realm name is omitted from the ID, giving:
+
+ uid=<username>,cn=digest-md5,cn=auth
+
+See Mapping Authentication identities to LDAP entries below for information on mapping such IDs to DNs.
+With suitable mappings in place, users can specify SASL IDs when performing LDAP operations, and the password stored in sasldb or in the directory itself will be used to verify the authentication. For example, the user identified by the directory entry:
+
+ dn: cn=Andrew Findlay+uid=u000997,dc=example,dc=com
+ objectclass: inetOrgPerson
+ objectclass: person
+ sn: Findlay
+ uid: u000997
+ userPassword: secret
+
+can issue commands of the form:
+
+ ldapsearch -U u000997 -b dc=example,dc=com 'cn=andrew*'
+
+or can specify the realm explicitly:
+
+ ldapsearch -U u000997@myrealm -b dc=example,dc=com 'cn=andrew*'
+
+If several SASL mechanisms are supported at your site, it may be necessary to specify which one to use, e.g.:
+
+ ldapsearch -Y DIGEST-MD5 -U u000997 -b dc=example,dc=com 'cn=andrew*'
+
+
+Note: in each of the above cases, no authorization identity (e.g. -X) was provided. Unless you are attempting SASL Proxy Authorization, no authorization identity should be specified. The server will infer an authorization identity from authentication identity (as described below).
+
+10.2.4. Mapping Authentication identities to LDAP entries
+The authentication mechanism in the slapd server will use SASL library calls to obtain the authenticated user's "username", based on whatever underlying authentication mechanism was used. This username is in the namespace of the authentication mechanism, and not in the LDAP namespace. As stated in the sections above, that username is reformatted into an authentication request DN of the form
+
+ uid=<username>,cn=<realm>,cn=<mechanism>,cn=auth
+
+or
+
+ uid=<username>,cn=<mechanism>,cn=auth
+
+depending on whether or not <mechanism> employs the concept of "realms". Note also that the realm part will be omitted if the default realm was used in the authentication.
+It is not intended that you should add LDAP entries of the above form to your LDAP database. Chances are you have an LDAP entry for each of the people that will be authenticating to LDAP, laid out in your directory tree, and the tree does not start at cn=auth. But if your site has a clear mapping between the "username" and an LDAP entry for the person, you will be able to configure your LDAP server to automatically map a authentication request DN to the user's authentication DN.
+
+Note: it is not required that the authentication request DN nor the user's authentication DN resulting from the mapping refer to an entry held in the directory. However, additional capabilities become available (see below).
+
+The LDAP administrator will need to tell the slapd server how to map an authentication request DN to a user's authentication DN. This is done by adding one or more sasl-regexp directives to the slapd.conf(5) file. This directive takes two arguments:
+
+ sasl-regexp <search pattern> <replacement pattern>
+
+The authentication request DN is compared to the search pattern using the regular expression functions regcomp() and regexec(), and if it matches, it is rewritten as the replacement pattern. If there are multiple sasl-regexp directives, only the first whose search pattern matches the authentication identity is used. The string that is output from the replacement pattern should be the authentication DN of the user, in a legitimate LDAP DN format. It can also be an LDAP URL, which is discussed below.
+The search pattern can contain any of the regular expression characters listed in regexec(3C). The main characters of note are dot ".", asterisk "*", and the open and close parenthesis "(" and ")". Essentially, the dot matches any character, the asterisk allows zero or more repeats of the immediately preceding character or pattern, and terms in parenthesis are remembered for the replacement pattern.
+The replacement pattern will produce the final authentication DN of the user. Anything from the authentication request DN that matched a string in parenthesis in the search pattern is stored in the variable "$1". That variable "$1" can appear in the replacement pattern, and will be replaced by the string from the authentication request DN. If there were multiple sets of parentheses in the search pattern, the variables $2, $3, etc are used.
+For example, suppose the user's authentication identity is written as the DN string
+
+ uid=adamson,cn=example.com,cn=kerberos_v4,cn=auth
+
+and the user's actual LDAP entry is
+
+ uid=adamson,ou=person,dc=example,dc=com
+
+The sasl-regexp directive in slapd.conf(5) could be written
+
+ sasl-regexp
+ uid=(.*),cn=example.com,cn=kerberos_v4,cn=auth
+ uid=$1,ou=person,dc=example,dc=com
+
+An even more lenient rule could be written as
+
+ sasl-regexp
+ uid=(.*),cn=.*,cn=auth
+ uid=$1,ou=person,dc=example,dc=com
+
+Be careful about setting the search pattern too leniently, however, since it may mistakenly allow people to become authenticated as a DN to which they should not have access. It is better to write several strict directives than one lenient directive which has security holes. If there is only one authentication mechanism in place at your site, and zero or one realms in use, you might be able to map between authentication identities and LDAP DN's with a single sasl-regexp directive.
+Don't forget to allow for the case where the realm is omitted as well as the case with an explicitly specified realm. This may well require a separate sasl-regexp directive for each case, with the explicit-realm entry being listed first.
+Some sites may have people's DN's spread to multiple areas of the LDAP tree, such as if there were an ou=accounting tree and an ou=engineering tree, with people interspersed between them. Or there may not be enough information in the authentication identity to isolate the DN, such as if the above person's LDAP entry looked like
+
+ dn: cn=mark adamson,ou=person,dc=example,dc=com
+ objectclass: Person
+ cn: mark adamson
+ uid: adamson
+
+In this case, the information in the authentication identity can only be used to search for the user's DN, not derive it directly. For both of these situations, and others, the replacement pattern in the sasl-regexp directives will need to produce an LDAP URL, described in the next section.
+10.2.5. Performing searches for a person's DN
+When there is not enough information in the authentication identity to derive a person's authentication DN directly, the sasl-regexp directives in the slapd.conf(5) file will need to produce an LDAP URL. This URL will then be used to perform an internal search of the LDAP database to find the person's authentication DN.
+An LDAP URL, similar to other URL's, is of the form
+
+ ldap://<host>/<base>?<attrs>?<scope>?<filter>
+
+This contains all of the elements necessary to perform an LDAP search: the name of the server <host>, the LDAP DN search base <base>, the LDAP attributes to retrieve <attrs>, the search scope <scope> which is one of the three options "base", "one", or "sub", and lastly an LDAP search filter <filter>. Since the search is for an LDAP DN within the current server, the <host> portion should be empty. The <attrs> field is also ignored since only the DN is of concern. These two elements are left in the format of the URL to maintain the clarity of what information goes where in the string.
+Suppose that the person in the example from above did in fact have an authentication username of "adamson" and that information was kept in the attribute "uid" in their LDAP entry. The sasl-regexp directive might be written as
+
+ sasl-regexp
+ uid=(.*),cn=example.com,cn=kerberos_v4,cn=auth
+ ldap:///ou=person,dc=example,dc=com??sub?(uid=$1)
+
+This will initiate an internal search of the LDAP database inside the slapd server. If the search returns exactly one entry, it is accepted as being the DN of the user. If there are more than one entries returned, or if there are zero entries returned, the authentication fails and the user's connection is left bound as the authentication request DN.
+Note that if the search scope <scope> in the URL is "base", then the only LDAP entry that will be returned is the searchbase DN <base>, so the actual search of the database is skipped. This is equivalent to setting the replacement pattern in the directive to a DN directly, as in the section above.
+The attributes that are used in the search filter <filter> in the URL should be indexed to allow faster searching. If they are not, the authentication step alone can take uncomfortably long periods, and users may assume the server is down.
+A more complex site might have several realms in use, each mapping to a different sub-tree in the directory. These can be handled with statements of the form:
+
+ # Match Engineering realm
+ sasl-regexp
+ uid=(.*),cn=engineering.example.com,cn=digest-md5,cn=auth
+ ldap:///dc=eng,dc=example,dc=com??sub?(&(uid=$1)(objectClass=person))
+
+ # Match Accounting realm
+ sasl-regexp
+ uid=(.*),cn=accounting.example.com,cn=digest-md5,cn=auth
+ ldap:///dc=accounting,dc=example,dc=com??sub?(&(uid=$1)(objectClass=person))
+
+ # Default realm is customers.example.com
+ sasl-regexp
+ uid=(.*),cn=digest-md5,cn=auth
+ ldap:///dc=customers,dc=example,dc=com??sub?(&(uid=$1)(objectClass=person))
+
+Note that the explicitly-named realms are handled first, to avoid the realm name becoming part of the UID. Note also the limitation of matches to those entries with (objectClass=person) to avoid matching other entries that happen to refer to the UID.
+See slapd.conf(5) for more detailed information.
+10.3. SASL Proxy Authorization
+The SASL offers a feature known as proxy authorization, which allows an authenticated user to request that they act on the behalf of another user. This step occurs after the user has obtained an authentication DN, and involves sending an authorization identity to the server. The server will then make a decision on whether or not to allow the authorization to occur. If it is allowed, the user's LDAP connection is switched to have a binding DN derived from the authorization identity, and the LDAP session proceeds with the access of the new authorization DN.
+The decision to allow an authorization to proceed depends on the rules and policies of the site where LDAP is running, and thus cannot be made by SASL alone. The SASL library leaves it up to the server to make the decision. The LDAP administrator sets the guidelines of who can authorize to what identity by adding information into the LDAP database entries. By default, the authorization features are disabled, and must be explicitly configured by the LDAP administrator before use.
+10.3.1. Uses of Proxy Authorization
+This sort of service is useful when one entity needs to act on the behalf of many other users. For example, users may be directed to a web page to make changes to their personal information in their LDAP entry. The users authenticate to the web server to establish their identity, but the web server CGI cannot authenticate to the LDAP server as that user to make changes for them. Instead, the web server authenticates itself to the LDAP server as a service identity, say,
+
+ cn=WebUpdate,dc=example,dc=com
+
+and then it will SASL authorize to the DN of the user. Once so authorized, the CGI makes changes to the LDAP entry of the user, and as far as the slapd server can tell for its ACLs, it is the user themself on the other end of the connection. The user could have connected to the LDAP server directly and authenticated as themself, but that would require the user to have more knowledge of LDAP clients, knowledge which the web page provides in an easier format.
+Proxy authorization can also be used to limit access to an account that has greater access to the database. Such an account, perhaps even the root DN specified in slapd.conf(5), can have a strict list of people who can authorize to that DN. Changes to the LDAP database could then be only allowed by that DN, and in order to become that DN, users must first authenticate as one of the persons on the list. This allows for better auditing of who made changes to the LDAP database. If people were allowed to authenticate directly to the priviliged account, possibly through the rootpw slapd.conf(5) directive or through a userPassword attribute, then auditing becomes more difficult.
+Note that after a successful proxy authorization, the original authentication DN of the LDAP connection is overwritten by the new DN from the authorization request. If a service program is able to authenticate itself as its own authentication DN and then authorize to other DN's, and it is planning on switching to several different identities during one LDAP session, it will need to authenticate itself each time before authorizing to another DN (or use a different proxy authorization mechanism). The slapd server does not keep record of the service program's ability to switch to other DN's. On authentication mechanisms like Kerberos this will not require multiple connections being made to the Kerberos server, since the user's TGT and "ldap" session key are valid for multiple uses for the several hours of the ticket lifetime.
+10.3.2. SASL Authorization Identities
+The SASL authorization identity is sent to the LDAP server via the -X switch for ldapsearch(1) and other tools, or in the *authzid parameter to the lutil_sasl_defaults() call. The identity can be in one of two forms, either
+
+ u:<username>
+
+or
+
+ dn:<dn>
+
+In the first form, the <username> is from the same namespace as the authentication identities above. It is the user's username as it is refered to by the underlying authentication mechanism. Authorization identities of this form are converted into a DN format by the same function that the authentication process used, producing an authorization request DN of the form
+
+ uid=<username>,cn=<realm>,cn=<mechanism>,cn=auth
+
+That authorization request DN is then run through the same sasl-regexp process to convert it into a legitimate authorization DN from the database. If it cannot be converted due to a failed search from an LDAP URL, the authorization request fails with "inappropriate access". Otherwise, the DN string is now a legitimate authorization DN ready to undergo approval.
+If the authorization identity was provided in the second form, with a "dn:" prefix, the string after the prefix is already in authorization DN form, ready to undergo approval.
+10.3.3. Proxy Authorization Rules
+Once slapd has the authorization DN, the actual approval process begins. There are two attributes that the LDAP administrator can put into LDAP entries to allow authorization:
+
+ saslAuthzTo
+ saslAuthzFrom
+
+Both can be multivalued. The saslAuthzTo attribute is a source rule, and it is placed into the entry associated with the authentication DN to tell what authorization DNs the authenticated DN is allowed to assume. The second attribute is a destination rule, and it is placed into the entry associated with the requested authorization DN to tell which authenticated DNs may assume it.
+The choice of which authorization policy attribute to use is up to the administrator. Source rules are checked first in the person's authentication DN entry, and if none of the saslAuthzTo rules specify the authorization is permitted, the saslAuthzFrom rules in the authorization DN entry are then checked. If neither case specifies that the request be honored, the request is denied. Since the default behaviour is to deny authorization requests, rules only specify that a request be allowed; there are no negative rules telling what authorizations to deny.
+The value(s) in the two attributes are of the same form as the output of the replacement pattern of a sasl-regexp directive: either a DN or an LDAP URL. For example, if a saslAuthzTo value is a DN, that DN is one the authenticated user can authorize to. On the other hand, if the saslAuthzTo value is an LDAP URL, the URL is used as an internal search of the LDAP database, and the authenticated user can become ANY DN returned by the search. If an LDAP entry looked like:
+
+ dn: cn=WebUpdate,dc=example,dc=com
+ saslAuthzTo: ldap:///dc=example,dc=com??sub?(objectclass=Person)
+
+then any user who authenticated as cn=WebUpdate,dc=example,dc=com could authorize to any other LDAP entry under the search base "dc=example,dc=com" which has an objectClass of "Person".
+10.3.3.1. Notes on Proxy Authorization Rules
+An LDAP URL in a saslAuthzTo or saslAuthzFrom attribute will return a set of DNs. Each DN returned will be checked. Searches which return a large set can cause the authorization process to take an uncomfortably long time. Also, searches should be performed on attributes that have been indexed by slapd.
+To help produce more sweeping rules for saslAuthzFrom and saslAuthzTo, the values of these attributes are allowed to be DNs with regular expression characters in them. This means a source rule like
+
+ saslAuthzTo: uid=.*,dc=example,dc=com
+
+would allow that authenticated user to authorize to any DN that matches the regular expression pattern given. This regular expression comparison can be evaluated much faster than an LDAP search for (uid=*).
+Also note that the values in an authorization rule must be one of the two forms: an LDAP URL or a DN (with or without regular expression characters). Anything that does not begin with "ldap://" is taken as a DN. It is not permissable to enter another authorization identity of the form "u:<username>" as an authorization rule.
+10.3.3.2. Policy Configuration
+The decision of which type of rules to use, saslAuthzFrom or saslAuthzTo, will depend on the site's situation. For example, if the set of people who may become a given identity can easily be written as a search filter, then a single destination rule could be written. If the set of people is not easily defined by a search filter, and the set of people is small, it may be better to write a source rule in the entries of each of those people who should be allowed to perform the proxy authorization.
+By default, processing of proxy authorization rules is disabled. The sasl-authz-policy directive must be set in the slapd.conf(5) file to enable authorization. This directive can be set to none for no rules (the default), from for source rules, to for destination rules, or both for both source and destination rules.
+Destination rules are extremely powerful. If ordinary users have access to write the saslAuthzTo attribute in their own entries, then they can write rules that would allow them to authorize as anyone else. As such, when using destination rules, the saslAuthzTo attribute should be protected with an ACL that only allows privileged users to set its values.
+
+
+11. Using TLS
+OpenLDAP clients and servers are capable of using the Transport Layer Security (TLS ) framework to provide integrity and confidentiality protections and to support LDAP authentication using the SASL EXTERNAL mechanism.
+11.1. TLS Certificates
+TLS uses X.509 certificates to carry client and server identities. All servers are required to have valid certificates, whereas client certificates are optional. Clients must have a valid certificate in order to authenticate via SASL EXTERNAL. For more information on creating and managing certificates, see the OpenSSL documentation.
+11.1.1. Server Certificates
+The DN of a server certificate must use the CN attribute to name the server, and the CN must carry the server's fully qualified domain name. Additional alias names and wildcards may be present in the subjectAltName certificate extension. More details on server certificate names are in RFC2830.
+11.1.2. Client Certificates
+The DN of a client certificate can be used directly as an authentication DN. Since X.509 is a part of the X.500 standard and LDAP is also based on X.500, both use the same DN formats and generally the DN in a user's X.509 certificate should be identical to the DN of their LDAP entry. However, sometimes the DNs may not be exactly the same, and so the mapping facility described in Mapping Authentication identities to LDAP entries can be applied to these DNs as well.
+11.2. TLS Configuration
+After obtaining the required certificates, a number of options must be configured on both the client and the server to enable TLS and make use of the certificates. At a minimum, the clients must be configured with the filename containing all of the Certificate Authority (CA) certificates it will trust. The server must be configured with the CA certificates and also its own server certificate and private key.
+Typically a single CA will have issued the server certificate and all of the trusted client certificates, so the server only needs to trust that one signing CA. However, a client may wish to connect to a variety of secure servers managed by different organizations, with server certificates generated by many different CAs. As such, a client is likely to need a list of many different trusted CAs in its configuration.
+11.2.1. Server Configuration
+The configuration directives for slapd belong in the global directives section of slapd.conf(5).
+11.2.1.1. TLSCACertificateFile <filename>
+This directive specifies the PEM -format file containing certificates for the CA's that slapd will trust. The certificate for the CA that signed the server certificate must be included among these certificates. If the signing CA was not a top-level (root) CA, certificates for the entire sequence of CA's from the signing CA to the top-level CA should be present. Multiple certificates are simply appended to the file; the order is not significant.
+11.2.1.2. TLSCACertificatePath <path>
+This directive specifies the path of a directory that contains individual CA certificates in separate files. In addition, this directory must be specially managed using the OpenSSL c_rehash utility. When using this feature, the OpenSSL library will attempt to locate certificate files based on a hash of their name and serial number. The c_rehash utility is used to generate symbolic links with the hashed names that point to the actual certificate files. As such, this option can only be used with a filesystem that actually supports symbolic links. In general, it is simpler to use the TLSCACertificateFile directive instead.
+11.2.1.3. TLSCertificateFile <filename>
+This directive specifies the file that contains the slapd server certificate. Certificates are generally public information and require no special protection.
+11.2.1.4. TLSCertificateKeyFile <filename>
+This directive specifies the file that contains the private key that matches the certificate stored in the TLSCertificateFile file. Private keys themselves are sensitive data and are usually password encrypted for protection. However, the current implementation doesn't support encrypted keys so the key must not be encrypted and the file itself must be protected carefully.
+11.2.1.5. TLSCipherSuite <cipher-suite-spec>
+This directive configures what ciphers will be accepted and the preference order. <cipher-suite-spec> should be a cipher specification for OpenSSL. You can use the command
+
+ openssl ciphers -v ALL
+
+to obtain a verbose list of available cipher specifications. Besides the individual cipher names, the specifiers HIGH, MEDIUM, LOW, EXPORT, and EXPORT40 may be helpful, along with TLSv1, SSLv3, and SSLv2.
+11.2.1.6. TLSRandFile <filename>
+This directive specifies the file to obtain random bits from when /dev/urandom is not available. If the system provides /dev/urandom then this option is not needed, otherwise a source of random data must be configured. Some systems (e.g. Linux) provide /dev/urandom by default, while others (e.g. Solaris) require the installation of a patch to provide it, and others may not support it at all. In the latter case, EGD or PRNGD should be installed, and this directive should specify the name of the EGD/PRNGD socket. The environment variable RANDFILE can also be used to specify the filename. Also, in the absence of these options, the .rnd file in the slapd user's home directory may be used if it exists. To use the .rnd file, just create the file and copy a few hundred bytes of arbitrary data into the file. The file is only used to provide a seed for the pseudo-random number generator, and it doesn't need very much data to work.
+11.2.1.7. TLSVerifyClient { never | allow | try | demand }
+This directive specifies what checks to perform on client certificates in an incoming TLS session, if any. This option is set to never by default, in which case the server never asks the client for a certificate. With a setting of allow the server will ask for a client certificate; if none is provided the session proceeds normally. If a certificate is provided but the server is unable to verify it, the certificate is ignored and the session proceeds normally, as if no certificate had been provided. With a setting of try the certificate is requested, and if none is provided, the session proceeds normally. If a certificate is provided and it cannot be verified, the session is immediately terminated. With a setting of demand the certificate is requested and a valid certificate must be provided, otherwise the session is immediately terminated.
+
+Note: The server must request a client certificate in order to use the SASL EXTERNAL authentication mechanism with a TLS session. As such, a non-default TLSVerifyClient setting must be configured before SASL EXTERNAL authentication may be attempted, and the SASL EXTERNAL mechanism will only be offered to the client if a valid client certificate was received.
+
+11.2.2. Client Configuration
+Most of the client configuration directives parallel the server directives. The names of the directives are different, and they go into ldap.conf(5) instead of slapd.conf(5), but their functionality is mostly the same. Also, while most of these options may be configured on a system-wide basis, they may all be overridden by individual users in their .ldaprc files.
+11.2.2.1. TLS_CACERT <filename>
+This is equivalent to the server's TLSCACertificateFile option. As noted in the TLS Configuration section, a client typically may need to know about more CAs than a server, but otherwise the same considerations apply.
+11.2.2.2. TLS_CACERTDIR <path>
+This is equivalent to the server's TLSCACertificatePath option. The specified directory must be managed with the OpenSSL c_rehash utility as well.
+11.2.2.3. TLS_CERT <filename>
+This directive specifies the file that contains the client certificate. This is a user-only directive and can only be specified in a user's .ldaprc file.
+11.2.2.4. TLS_KEY <filename>
+This directive specifies the file that contains the private key that matches the certificate stored in the TLS_CERT file. The same constraints mentioned for TLSCertificateKeyFile apply here. This is also a user-only directive.
+11.2.2.5. TLS_RANDFILE <filename>
+This directive is the same as the server's TLSRandFile option.
+11.2.2.6. TLS_REQCERT { never | allow | try | demand }
+This directive is equivalent to the server's TLSVerifyClient option. However, for clients the default value is demand and there generally is no good reason to change this setting.
+11.2.2.7. TLS { never | hard }
+This directive specifies whether client connections should use TLS by default. The default setting is never which specifies that connections will be opened in the clear unless TLS is explicitly specified using an "ldaps://" URL. When set to hard all connections will be established with TLS, as if an "ldaps://" URL was specified. Note that the use of ldaps is a holdover from LDAPv2 and this setting is incompatible with the LDAPv3 StartTLS request. As such, it's best not to use this option.
+
+
+12. Constructing a Distributed Directory Service
For many sites, running one or more slapd(8) that hold an entire subtree of data is sufficient. But often it is desirable to have one slapd refer to other directory services for a certain part of the tree (which may or may not be running slapd).
-slapd supports subordinate and superior knowledge information.
-9.1. Subordinate Knowledge Information
-Subordinate knowledge information may be provided to delegate a subtree. Subordinate knowledge information is maintained in the directory as a special referral object at the delegate point. The referral object acts as a delegation point, gluing two services together. This mechanism allows for hierarchical directory services to to be constructed.
+slapd supports subordinate and superior knowledge information. Subordinate knowledge information is held in referral objects (RFC3296).
+12.1. Subordinate Knowledge Information
+Subordinate knowledge information may be provided to delegate a subtree. Subordinate knowledge information is maintained in the directory as a special referral object at the delegate point. The referral object acts as a delegation point, gluing two services together. This mechanism allows for hierarchical directory services to be constructed.
A referral object has a structural object class of referral and has the same Distinguished Name as the delegated subtree. Generally, the referral object will also provide the auxiliary object class extensibleObject. This allows the entry to contain appropriate Relative Distinguished Name values. This is best demonstrated by example.
If the server a.example.net holds dc=example,dc=net and wished to delegate the subtree ou=subtree,dc=example,dc=net to another server b.example.net, the following named referral object would be added to a.example.net:
@@ -2338,8 +2851,8 @@ case sensitive, space insensitive
The server uses this information to generate referrals and search continuations to subordinate servers.
For those familiar with X.500, a named referral object is similar to an X.500 knowledge reference held in a subr DSE .
-9.2. Superior Knowledge Information
-Superior knowledge information may be specified using the referral directive. The value is a list of URI s referring to superior directory services. For servers without immediate superiors, such as for a.example.net in the example above, the server can be configured to use directory service with global knowledge, such as the OpenLDAP Root Service (http://www.openldap.org/faq/index.cgi?file=393).
+12.2. Superior Knowledge Information
+Superior knowledge information may be specified using the referral directive. The value is a list of URI s referring to superior directory services. For servers without immediate superiors, such as for a.example.net in the example above, the server can be configured to use a directory service with global knowledge, such as the OpenLDAP Root Service (http://www.openldap.org/faq/index.cgi?file=393).
referral ldap://root.openldap.org/
@@ -2347,10 +2860,12 @@ case sensitive, space insensitive
referral ldap://a.example.net/
-The server uses this information to generate referrals to operations acting upon operations not within or subordinate to any of the naming contexts held by the server.
+The server uses this information to generate referrals for operations acting upon entries not within or subordinate to any of the naming contexts held by the server.
For those familiar with X.500, this use of the ref attribute is similar to an X.500 knowledge reference held in a Supr DSE .
-9.3. The ManageDsaIT Control
-Adding, modifying, and deleting referral objects is generally done using ldapmodify(1) or similar tools which support the ManageDsaIT control. The ManageDsaIT control informs the server that you intend to manage the referral object as a regular entry. This keeps the server from sending a referral result for requests which interrogate or update referral objects. The -M option of ldapmodify(1) (and other tools) enables ManageDsaIT. For example:
+12.3. The ManageDsaIT Control
+Adding, modifying, and deleting referral objects is generally done using ldapmodify(1) or similar tools which support the ManageDsaIT control. The ManageDsaIT control informs the server that you intend to manage the referral object as a regular entry. This keeps the server from sending a referral result for requests which interrogate or update referral objects.
+The ManageDsaIT control should not be specified when managing regular entries.
+The -M option of ldapmodify(1) (and other tools) enables ManageDsaIT. For example:
ldapmodify -M -f referral.ldif -x -D "cn=Manager,dc=example,dc=net" -W
@@ -2363,10 +2878,10 @@ case sensitive, space insensitive
-10. Replication with slurpd
+13. Replication with slurpd
In certain configurations, a single slapd(8) instance may be insufficient to handle the number of clients requiring directory service via LDAP. It may become necessary to run more than one slapd instance. At many sites, for instance, there are multiple slapd servers: one master and one or more slaves. DNS can be setup such that a lookup of ldap.example.com returns the IP addresses of these servers, distributing the load among them (or just the slaves). This master/slave arrangement provides a simple and effective way to increase capacity, availability and reliability.
slurpd(8) provides the capability for a master slapd to propagate changes to slave slapd instances, implementing the master/slave replication scheme described above. slurpd runs on the same host as the master slapd instance.
-10.1. Overview
+13.1. Overview
slurpd(8) provides replication services "in band". That is, it uses the LDAP protocol to update a slave database from the master. Perhaps the easiest way to illustrate this is with an example. In this example, we trace the propagation of an LDAP modify operation from its initiation by the LDAP client to its distribution to the slave slapd instance.
Sample replication scenario:
@@ -2376,8 +2891,11 @@ case sensitive, space insensitive
- The master slapd performs the modify operation, writes out the change to its replication log file and returns a success code to the client.
- The slurpd process notices that a new entry has been appended to the replication log file, reads the replication log entry, and sends the change to the slave slapd via LDAP.
- The slave slapd performs the modify operation and returns a success code to the slurpd process.
-10.2. Replication Logs
-When slapd is configured to generate a replication logfile, it writes out a file containing LDIF change records. The replication log gives the replication site(s), a timestamp, the DN of the entry being modified, and a series of lines which specify the changes to make. In the example below, Barbara (uid=bjensen) has replaced the description value. The change is to be propagated to the slapd instance running on slave.example.net Changes to various operational attributes, such as modifiersName and modifyTimestamp, are included in the change record and will be propagated to the slave slapd.
+
+Note: ldapmodify(1) and other tools distributed as part of OpenLDAP Software do not support automatic referral chasing.
+
+13.2. Replication Logs
+When slapd is configured to generate a replication logfile, it writes out a file containing LDIF change records. The replication log gives the replication site(s), a timestamp, the DN of the entry being modified, and a series of lines which specify the changes to make. In the example below, Barbara (uid=bjensen) has replaced the description value. The change is to be propagated to the slapd instance running on slave.example.net Changes to various operational attributes, such as modifiersName and modifyTimestamp, are included in the change record and will be propagated to the slave slapd.
replica: slave.example.com:389
time: 809618633
@@ -2394,14 +2912,14 @@ case sensitive, space insensitive
-
The modifications to modifiersName and modifyTimestamp operational attributes were added by the master slapd.
-10.3. Command-Line Options
+13.3. Command-Line Options
This section details commonly used slurpd(8) command-line options.
-d <level> | ?
-This option sets the slurpd debug level to <level>. When level is a `?' character, the various debugging levels are printed and slapd exits, regardless of any other options you give it. Current debugging levels (a subset of slapd's debugging levels) are
+This option sets the slurpd debug level to <level>. When level is a `?' character, the various debugging levels are printed and slurpd exits, regardless of any other options you give it. Current debugging levels (a subset of slapd's debugging levels) are
-Table 10.1: Debugging Levels
+Table 13.1: Debugging Levels
Level
@@ -2440,7 +2958,7 @@ enable all debugging
-f <filename>
-This option specifies an alternate slapd configuration file. Slurpd does not have its own configuration file. Instead, all configuration information is read from the slapd configuration file.
+This option specifies an alternate slapd configuration file. Slurpd does not have its own configuration file. Instead, all configuration information is read from the slapd configuration file.
-r <filename>
@@ -2448,19 +2966,19 @@ enable all debugging
-o
-Operate in "one-shot" mode. Under normal circumstances, when slurpd finishes processing a replication log, it remains active and periodically checks to see if new entries have been added to the replication log. In one-shot mode, by comparison, slurpd processes a replication log and exits immediately. If the -o option is given, the replication log file must be explicitly specified with the -r option. See the One-shot mode and reject files section for a discussion of this mode.
+Operate in "one-shot" mode. Under normal circumstances, when slurpd finishes processing a replication log, it remains active and periodically checks to see if new entries have been added to the replication log. In one-shot mode, by comparison, slurpd processes a replication log and exits immediately. If the -o option is given, the replication log file must be explicitly specified with the -r option. See the One-shot mode and reject files section for a discussion of this mode.
-t <directory>
-Specify an alternate directory for slurpd's temporary copies of replication logs. The default location is /usr/tmp.
-10.4. Configuring slurpd and a slave slapd instance
+Specify an alternate directory for slurpd's temporary copies of replication logs. The default location is /usr/tmp.
+13.4. Configuring slurpd and a slave slapd instance
To bring up a replica slapd instance, you must configure the master and slave slapd instances for replication, then shut down the master slapd so you can copy the database. Finally, you bring up the master slapd instance, the slave slapd instance, and the slurpd instance. These steps are detailed in the following sections. You can set up as many slave slapd instances as you wish.
-10.4.1. Set up the master slapd
+13.4.1. Set up the master slapd
The following section assumes you have a properly working slapd(8) instance. To configure your working slapd(8) server as a replication master, you need to make the following changes to your slapd.conf(5).
- Add a replica directive for each replica. The binddn= parameter should match the updatedn option in the corresponding slave slapd configuration file, and should name an entry with write permission to the slave database (e.g., an entry listed as rootdn, or allowed access via access directives in the slave slapd configuration file).
- Add a replogfile directive, which tells slapd where to log changes. This file will be read by slurpd.
-10.4.2. Set up the slave slapd
+13.4.2. Set up the slave slapd
Install the slapd software on the host which is to be the slave slapd server. The configuration of the slave server should be identical to that of the master, with the following exceptions:
- Do not include a replica directive. While it is possible to create "chains" of replicas, in most cases this is inappropriate.
@@ -2468,52 +2986,15 @@ enable all debugging
- Do include an updatedn line. The DN given should match the DN given in the binddn= parameter of the corresponding replica= directive in the master slapd config file.
- Make sure the DN given in the updatedn directive has permission to write the database (e.g., it is listed as rootdn or is allowed access by one or more access directives).
- Use the updateref directive to define the URL the slave should return if an update request is received.
-10.4.3. Shut down the master slapd
+13.4.3. Shut down the master server
In order to ensure that the slave starts with an exact copy of the master's data, you must shut down the master slapd. Do this by sending the master slapd process an interrupt signal with kill -INT <pid>, where <pid> is the process-id of the master slapd process.
If you like, you may restart the master slapd in read-only mode while you are replicating the database. During this time, the master slapd will return an "unwilling to perform" error to clients that attempt to modify data.
-10.4.4. Copy the master slapd's database to the slave
-Copy the master's database(s) to the slave. For an LDBM -based database, you must copy all database files located in the database directory specified in slapd.conf(5). Database files will have a different suffix depending on the underlying database package used. The current possibilities are
-
-Table 10.2: Database File Suffixes
-
-
-Suffix
-
-
-Database
-
-
-
-
-dbb
-
-
-Berkeley DB B-tree backend
-
-
-
-
-dbh
-
-
-Berkeley DB hash backend
-
-
-
-
-gdbm
-
-
-GNU DBM backend
-
-
-
-
-In general, you should copy each file found in the database directory unless you know it is not used by slapd(8).
+13.4.4. Copy the master slapd's database to the slave
+Copy the master's database(s) to the slave. For an BDB and LDBM databases, you must copy all database files located in the database directory specified in slapd.conf(5). In general, you should copy each file found in the database directory unless you know it is not used by slapd(8).
-Note: The copy process assumes homogeneous servers with identically configured OpenLDAP installations.
+Note: This copy process assumes homogeneous servers with identically configured OpenLDAP installations. Alternatively, you may use slapcat to output the master's database in LDIF format and use the LDIF with slapadd to populate the slave. Using LDIF avoids any potential incompatibilities due to differing server architectures or software configurations. See the Database Creation and Maintenance Tools chapter for details on these tools.
-10.4.5. Configure the master slapd for replication
+13.4.5. Configure the master slapd for replication
To configure slapd to generate a replication logfile, you add a " replica" configuration option to the master slapd's config file. For example, if we wish to propagate changes to the slapd instance running on host slave.example.com:
replica host=slave.example.com:389
@@ -2524,15 +3005,15 @@ GNU DBM backend
Note: The use of strong authentication and transport security is highly recommended.
-10.4.6. Restart the master slapd and start the slave slapd
+13.4.6. Restart the master slapd and start the slave slapd
Restart the master slapd process. To check that it is generating replication logs, perform a modification of any entry in the database, and check that data has been written to the log file.
-10.4.7. Start slurpd
+13.4.7. Start slurpd
Start the slurpd process. Slurpd should immediately send the test modification you made to the slave slapd. Watch the slave slapd's logfile to be sure that the modification was sent.
slurpd -f <masterslapdconfigfile>
-10.5. Advanced slurpd Operation
-10.5.1. Replication errors
+13.5. Advanced slurpd Operation
+13.5.1. Replication errors
When slurpd propagates a change to a slave slapd and receives an error return code, it writes the reason for the error and the replication record to a reject file. The reject file is located in the same directory as the per-replica replication logfile, and has the same name, but with the string ".rej" appended. For example, for a replica running on host slave.example.com, port 389, the reject file, if it exists, will be named
/usr/local/var/openldap/replog.slave.example.com:389.rej
@@ -2555,7 +3036,7 @@ GNU DBM backend
-
Note that this is precisely the same format as the original replication log entry, but with an ERROR line prepended to the entry.
-10.5.2. One-shot mode and reject files
+13.5.2. One-shot mode and reject files
It is possible to use slurpd to process a rejection log with its "one-shot mode." In normal operation, slurpd watches for more replication records to be appended to the replication log file. In one-shot mode, by contrast, slurpd processes a single log file and exits. Slurpd ignores ERROR lines at the beginning of replication log entries, so it's not necessary to edit them out before feeding it the rejection log.
To use one-shot mode, specify the name of the rejection log on the command line as the argument to the -r flag, and specify one-shot mode with the -o flag. For example, to process the rejection log file /usr/local/var/openldap/replog.slave.example.com:389 and exit, use the command
@@ -2753,73 +3234,67 @@ operates.
B. OpenLDAP Software Copyright Notices
B.1. OpenLDAP Copyright Notice
-Copyright 1998-2000 The OpenLDAP Foundation, Redwood City, California, USA All rights reserved.
-Redistribution and use in source and binary forms are permitted only as authorized by the OpenLDAP Public License. A copy of this license is available at http://www.OpenLDAP.org/license.html or in file LICENSE in the top-level directory of the distribution.
+Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA All rights reserved.
+Redistribution and use in source and binary forms are permitted only as authorized by the OpenLDAP Public License. A copy of this license is available at http://www.OpenLDAP.org/license.html or in file LICENSE in the top-level directory of the distribution.
+OpenLDAP is a registered trademark of the OpenLDAP Foundation.
Individual files and/or contributed packages may be copyright by other parties and their use subject to additional restrictions.
-This work is derived from the University of Michigan LDAP v3.3 distribution. Information concerning this software is available at:
-
+This work is derived from the University of Michigan LDAP v3.3 distribution. Information concerning this software is available at <http://www.umich.edu/~dirsvcs/ldap/>.
This work also contains materials derived from public sources.
-Additional Information about OpenLDAP can be obtained at:
-
-or by sending e-mail to:
-
+Additional information about OpenLDAP software can be obtained at <http://www.OpenLDAP.org/>.
B.2. University of Michigan Copyright Notice
Portions Copyright 1992-1996 Regents of the University of Michigan. All rights reserved.
Redistribution and use in source and binary forms are permitted provided that this notice is preserved and that due credit is given to the University of Michigan at Ann Arbor. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. This software is provided ``as is'' without express or implied warranty.
-C. The OpenLDAP Public License
+C. OpenLDAP Public License
The OpenLDAP Public License
- Version 2.4, 8 December 2000
+ Version 2.7, 7 September 2001
Redistribution and use of this software and associated documentation
("Software"), with or without modification, are permitted provided
that the following conditions are met:
1. Redistributions of source code must retain copyright statements
-and notices.
+ and notices,
2. Redistributions in binary form must reproduce applicable copyright
-statements and notices, this list of conditions, and the following
-disclaimer in the documentation and/or other materials provided
-with the distribution.
+ statements and notices, this list of conditions, and the following
+ disclaimer in the documentation and/or other materials provided
+ with the distribution, and
3. Redistributions must contain a verbatim copy of this document.
-4. The names and trademarks of the authors and copyright holders
-must not be used in advertising or otherwise to promote the sale,
-use or other dealing in this Software without specific, written
-prior permission.
+The OpenLDAP Foundation may revise this license from time to time.
+Each revision is distinguished by a version number. You may use
+this Software under terms of this license revision or under the
+terms of any subsequent revision of the license.
-5. Due credit should be given to the OpenLDAP Project.
+THIS SOFTWARE IS PROVIDED BY THE OPENLDAP FOUNDATION AND ITS
+CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE OPENLDAP FOUNDATION, ITS CONTRIBUTORS, OR THE AUTHOR(S)
+OR OWNER(S) OF THE SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
-6. The OpenLDAP Foundation may revise this license from time to
-time. Each revision is distinguished by a version number. You
-may use the Software under terms of this license revision or under
-the terms of any subsequent revision of the license.
+The names of the authors and copyright holders must not be used in
+advertising or otherwise to promote the sale, use or other dealing
+in this Software without specific, written prior permission. Title
+to copyright in this Software shall at all times remain with
+copyright holders.
-THIS SOFTWARE IS PROVIDED BY THE OPENLDAP FOUNDATION AND CONTRIBUTORS
-``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
-NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
-THE OPENLDAP FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
-OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
-IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OpenLDAP is a registered trademark of the OpenLDAP Foundation.
-OpenLDAP is a trademark of the OpenLDAP Foundation.
-
-Copyright 1999-2000 The OpenLDAP Foundation, Redwood City,
+Copyright 1999-2001 The OpenLDAP Foundation, Redwood City,
California, USA. All Rights Reserved. Permission to copy and
-distributed verbatim copies of this document is granted.
+distribute verbatim copies of this document is granted.
-______________
-© Copyright 2000, OpenLDAP Foundation, info@OpenLDAP.org
+________________
+© Copyright 2003, OpenLDAP Foundation, info@OpenLDAP.org
diff --git a/ldap.init b/ldap.init
index b57f27c..c42e839 100644
--- a/ldap.init
+++ b/ldap.init
@@ -37,10 +37,10 @@ function start() {
prog=`basename ${slapd}`
echo -n $"Starting $prog: "
if grep -q ^TLS /etc/openldap/slapd.conf ; then
- daemon ${slapd} -u ldap -h '"ldap:/// ldaps:///"' $OPTIONS $SLAPD_OPTIONS
+ daemon ${slapd} -u ldap -h '"ldap:/// ldaps:///"' -l daemon $OPTIONS $SLAPD_OPTIONS
RETVAL=$?
else
- daemon ${slapd} -u ldap $OPTIONS $SLAPD_OPTIONS
+ daemon ${slapd} -u ldap -h "ldap:///" -l daemon $OPTIONS $SLAPD_OPTIONS
RETVAL=$?
fi
echo
diff --git a/nptl-abi-note.S b/nptl-abi-note.S
new file mode 100644
index 0000000..e8de1d9
--- /dev/null
+++ b/nptl-abi-note.S
@@ -0,0 +1,21 @@
+/* Gleaned from glibc, though I suppose it's documented in the specs, too.
+ NPTL requires support that isn't in kernels prior to 2.4.20 (or 2.5.36 if
+ you're not using a backported TLS implementation in your kernel), but ld.so
+ will try to use this library on an insufficiently-new system unless we make
+ a note of the required kernel version here.
+ We also add in a section which marks the library as not needing an
+ executable stack to avoid unintentionally disabling exec-shield and the
+ like (thanks Arjan!). */
+ .section ".note.ABI-tag", "a"
+ .p2align 2
+ .long 1f - 0f
+ .long 3f - 2f
+ .long 1
+0: .asciz "GNU"
+1: .p2align 2
+2: .long 0
+ .long 2,4,20
+3: .p2align 2
+
+.section .note.GNU-stack, "", @progbits
+.previous
diff --git a/openldap.spec b/openldap.spec
index a643687..4ae73b8 100644
--- a/openldap.spec
+++ b/openldap.spec
@@ -1,44 +1,46 @@
-%define migtools_ver 44
-%define db_version 4.0.14
-%define ldbm_backend gdbm
-#%define ldbm_backend berkeley
+%define migtools_version 45
+%define db_version 4.1.25
+%define db_version_40 4.0.14
+%define ldbm_backend berkeley
+%define version_20 2.0.27
+%define nptl_arches %{ix86} ia64 ppc ppc64 s390 s390x sparcv9 x86_64
Summary: The configuration files, libraries, and documentation for OpenLDAP.
Name: openldap
-Version: 2.0.27
+Version: 2.1.22
Release: 8
License: OpenLDAP
Group: System Environment/Daemons
Source0: ftp://ftp.OpenLDAP.org/pub/OpenLDAP/openldap-release/openldap-%{version}.tgz
-Source1: http://www.sleepycat.com/update/%{db_version}/db-%{db_version}.tar.gz
-Source2: ldap.init
-Source3: ftp://ftp.padl.com/pub/MigrationTools-%{migtools_ver}.tar.gz
-Source4: migration-tools.txt
-Source5: rfc822-MailMember.schema
-Source6: autofs.schema
-Source7: kerberosobject.schema
-Source8: README.upgrading
-Source9: README.sendbuf
-Source10: http://www.OpenLDAP.org/doc/admin/guide.html
-Patch0: openldap-2.0.16-config.patch
-Patch1: openldap-2.0.12-redhat.patch
+Source1: ftp://ftp.OpenLDAP.org/pub/OpenLDAP/openldap-release/openldap-%{version_20}.tgz
+Source2: ftp://ftp.OpenLDAP.org/pub/tools/autoconf-2.13.1.tar.gz
+Source3: ftp://ftp.OpenLDAP.org/pub/tools/automake-1.4a.tar.gz
+Source4: http://www.sleepycat.com/update/snapshot/db-%{db_version}.tar.gz
+Source5: http://www.sleepycat.com/update/snapshot/db-%{db_version_40}.tar.gz
+Source6: ldap.init
+Source7: ftp://ftp.padl.com/pub/MigrationTools-%{migtools_version}.tar.gz
+Source8: migration-tools.txt
+Source10: autofs.schema
+Source11: README.upgrading
+Source12: http://www.OpenLDAP.org/doc/admin/guide.html
+Source13: nptl-abi-note.S
+Patch0: openldap-2.1.17-config.patch
+Patch1: openldap-2.1.17-string.patch
Patch2: openldap-1.2.11-cldap.patch
-Patch3: openldap-2.0.3-syslog.patch
-Patch6: openldap-2.0.23-sendbuf.patch
-Patch7: openldap-2.0.11-ldaprc.patch
-Patch8: openldap-2.0.11-debug.patch
-Patch9: openldap-2.0.11-libtool.patch
-Patch10: openldap-2.0.11-linkage.patch
+Patch3: openldap-2.1.17-syslog.patch
+Patch4: openldap-2.0.11-ldaprc.patch
+Patch5: openldap-2.1.17-susesec.patch
+Patch11: http://www.sleepycat.com/update/4.1.25/patch.4.1.25.1
+Patch12: db-4.0.14-disable-mutex.patch
+Patch13: db-4.0.14-libobjs.patch
Patch21: MigrationTools-38-instdir.patch
Patch22: MigrationTools-36-mktemp.patch
Patch23: MigrationTools-27-simple.patch
Patch24: MigrationTools-26-suffix.patch
Patch25: MigrationTools-44-schema.patch
-Patch26: openldap-2.0.27-susesec.patch
URL: http://www.openldap.org/
BuildRoot: %{_tmppath}/%{name}-%{version}-root
-BuildPreReq: cyrus-sasl-devel, gdbm-devel, krb5-devel, openssl-devel
-BuildPreReq: pam-devel, perl, pkgconfig >= 0.14.0-3, tcp_wrappers
-BuildPreReq: libtool >= 1.4
+BuildPreReq: cyrus-sasl-devel >= 2.1, gdbm-devel, libtool >= 1.5, krb5-devel
+BuildPreReq: openssl-devel, pam-devel, perl, pkgconfig, tcp_wrappers
Requires: cyrus-sasl, cyrus-sasl-md5, mktemp
%description
@@ -53,7 +55,7 @@ libraries, and documentation for OpenLDAP.
%package devel
Summary: OpenLDAP development libraries and header files.
Group: Development/Libraries
-Requires: openldap = %{version}-%{release}
+Requires: openldap = %{version}-%{release}, cyrus-sasl-devel >= 2.1
%description devel
The openldap-devel package includes the development libraries and
@@ -92,57 +94,185 @@ over the Internet. The openldap-clients package contains the client
programs needed for accessing and modifying OpenLDAP directories.
%prep
-%setup -q -a 1 -a 3
+%setup -q -a 1 -a 2 -a 3 -a 4 -a 5 -a 7
+
%patch0 -p1 -b .config
%patch1 -p1 -b .redhat
%patch2 -p1 -b .cldap
%patch3 -p1 -b .syslog
-%patch6 -p1 -b .sendbuf
-%patch7 -p1 -b .ldaprc
-%patch8 -p1 -b .debug
-%patch9 -p1 -b .libtool
-%patch10 -p1 -b .linkage
-pushd MigrationTools-%{migtools_ver}
+%patch4 -p1 -b .ldaprc
+%patch5 -p1 -b .susesec
+
+pushd db-%{db_version}
+%patch11 -p0 -b .bdb
+popd
+pushd db-%{db_version_40}
+%patch12 -p1 -b .disable-mutex
+%patch13 -p1 -b .libobj
+cd dist
+./s_config
+popd
+
+pushd MigrationTools-%{migtools_version}
%patch21 -p1 -b .instdir
%patch22 -p1 -b .mktemp
%patch23 -p1 -b .simple
%patch24 -p1 -b .suffix
%patch25 -p1 -b .schema
popd
-%patch26 -p0 -b .susesec
-mkdir build-gdbm
-ln -s ../configure build-gdbm
-mkdir build-berkeley
-ln -s ../configure build-berkeley
-mkdir build-krb5
-ln -s ../configure build-krb5
-mkdir build-clients
-ln -s ../configure build-clients
+pushd openldap-%{version_20}
+ for subdir in build-gdbm build-db ; do
+ mkdir $subdir
+ ln -s ../configure $subdir
+ done
+popd
+
+for subdir in build-servers build-clients ; do
+ mkdir $subdir
+ ln -s ../configure $subdir
+done
cp %{_datadir}/libtool/config.{sub,guess} build/
+autodir=`pwd`/auto-instroot
+pushd autoconf-2.13.1
+./configure --prefix=$autodir
+make all install
+popd
+pushd automake-1.4a
+./configure --prefix=$autodir
+make all install
+popd
+
%build
+autodir=`pwd`/auto-instroot
dbdir=`pwd`/db-instroot
+dbdir40=`pwd`/db-instroot-4.0
+libtool='%{_bindir}/libtool'
+tagname=CC; export tagname
+
+PATH=${autodir}/bin:${PATH}
+
%ifarch ia64
RPM_OPT_FLAGS="$RPM_OPT_FLAGS -O0"
%endif
+
+# Set CFLAGS to incorporate RPM_OPT_FLAGS.
+CFLAGS="$RPM_OPT_FLAGS -D_REENTRANT -fPIC"; export CFLAGS
+
+# Build the 2.0 server tools for dumping out old on-disk databases. This
+# requires Berkeley DB 4.0.x (which we must build) and gdbm.
+pushd db-%{db_version_40}/dist
+./configure -C \
+ --with-pic \
+ --disable-shared \
+ --with-uniquename=_openldap_rhl_40 \
+ --prefix=${dbdir40} \
+ --libdir=${dbdir40}/%{_lib}
+make %{_smp_mflags}
+make install
+popd
+
+CPPFLAGS="-I${dbdir40}/include" ; export CPPFLAGS
+LDFLAGS="-L${dbdir40}/%{_lib}" ; export LDFLAGS
+
+pushd openldap-%{version_20}
+ pushd build-gdbm
+ ./configure \
+ --prefix=%{_prefix} \
+ --disable-shared \
+ --without-cyrus-sasl \
+ --without-kerberos \
+ --without-threads \
+ --without-tls \
+ --enable-ldbm \
+ --with-ldbm-api=gdbm \
+ --program-suffix=-slapd-2.0-gdbm
+ make %{_smp_mflags}
+ popd
+
+ pushd build-db
+ LIBS=-lpthread \
+ ./configure \
+ --prefix=%{_prefix} \
+ --disable-shared \
+ --without-cyrus-sasl \
+ --without-kerberos \
+ --without-threads \
+ --without-tls \
+ --enable-ldbm \
+ --with-ldbm-api=berkeley \
+ --program-suffix=-slapd-2.0-dbb
+ make %{_smp_mflags}
+ popd
+popd
+
+# Build Berkeley DB and install it into a temporary area, isolating OpenLDAP
+# from any future changes to the system-wide Berkeley DB library.
+buildbdb() {
+ subdir=$1
+ shift
+ install -d db-%{db_version}/build-rpm${subdir:+-${subdir}}
+ pushd db-%{db_version}/build-rpm${subdir:+-${subdir}}
+ echo "${1:+db_cv_mutex=$1}" > config.cache
+ shift
+ ../dist/configure -C \
+ --with-pic \
+ --disable-static \
+ --enable-shared \
+ --with-uniquename=_openldap_slapd_rhl \
+ --prefix=${dbdir} \
+ --libdir=${dbdir}/%{_lib}${subdir:+/${subdir}}
+ # XXX hack out O_DIRECT support in db4 for now.
+ perl -pi -e 's/#define HAVE_O_DIRECT 1/#undef HAVE_O_DIRECT/' db_config.h
+ if test -n "$nptl_lo" ; then
+ ./libtool --mode=compile %{__cc} -o $nptl_lo -c $nptl_s
+ fi
+ make %{_smp_mflags} libso_base=libslapd_db LIBSO_LIBS="$nptl_lo"
+ make install libso_base=libslapd_db LIBSO_LIBS="$nptl_lo"
+ ln -sf libslapd_db.so ${dbdir}/%{_lib}/${subdir}/libdb.so
+ popd
+}
+
+# Build an NPTL libdb if we're on a Linux arch with NPTL. NPTL gives us the
+# ability to share mutexes between threads in different processes, and to have
+# threads in both honor those locks. We have to do this because if you build
+# libdb with support for intra-process locks, it dies if you don't have it and
+# the application has specified to libdb that it's multi-threaded (as slapd
+# does).
+%ifarch %{nptl_arches}
+unset nptl_s nptl_lo
+case %{_os} in
+linux|Linux)
+ nptl_s=$RPM_SOURCE_DIR/nptl-abi-note.S
+ nptl_lo=nptl-abi-note.lo
+ ;;
+esac
+buildbdb tls POSIX/pthreads/library
+unset nptl_s nptl_lo
+%endif
+
+# Build a non-NPTL libdb and tools, able to only use intra-process thread
+# locks. Useless for bdb's purposes (bdb requires shared env support), but
+# acceptable for ldbm.
+buildbdb "" POSIX/pthreads/library/private
+
+# Find OpenSSL's header and library dependencies.
if pkg-config openssl ; then
- OPENSSL_CPPFLAGS=`pkg-config --cflags openssl`
+ OPENSSL_CPPFLAGS=`pkg-config --cflags-only-I openssl`
CPPFLAGS="$OPENSSL_CPPFLAGS" ; export CPPFLAGS
OPENSSL_LDFLAGS=`pkg-config --libs-only-L openssl`
LDFLAGS="$OPENSSL_LDFLAGS" ; export LDFLAGS
fi
-CFLAGS="$CPPFLAGS $RPM_OPT_FLAGS -D_REENTRANT -fPIC"; export CFLAGS
-TARGET_PLATFORM=%{_target_platform}
-%define _target_platform --target=${TARGET_PLATFORM}
+
build() {
-cat << _EOF | sed -e 's,--host=[^ ]*,,g' -e 's,--build=[^ ]*,,g' -e 's,--target=[^ ]*,,g' -e 's,%{_target_platform},,g' > run-build
+CFLAGS="$CPPFLAGS $RPM_OPT_FLAGS -D_REENTRANT -fPIC"; export CFLAGS
%configure \
--with-slapd --with-slurpd --without-ldapd \
- --with-threads=posix --enable-static \
+ --with-threads=posix --enable-static --enable-dynamic \
\
- --enable-local --enable-cldap --disable-rlookups \
+ --enable-local --enable-cldap --enable-rlookups \
\
--with-tls \
--with-cyrus-sasl \
@@ -150,7 +280,7 @@ cat << _EOF | sed -e 's,--host=[^ ]*,,g' -e 's,--build=[^ ]*,,g' -e 's,--target=
--enable-wrappers \
\
--enable-passwd \
- --enable-shell \
+ \
--enable-cleartext \
--enable-crypt \
--enable-spasswd \
@@ -159,116 +289,109 @@ cat << _EOF | sed -e 's,--host=[^ ]*,,g' -e 's,--build=[^ ]*,,g' -e 's,--target=
\
--libexecdir=%{_sbindir} \
--localstatedir=/%{_var}/run \
- $@ \$@
-_EOF
-sh -x ./run-build %{_target_platform}
-make depend %{_smp_mflags}
-make %{_smp_mflags} LIBTOOL=libtool
+ $@
+make %{_smp_mflags} LIBTOOL="$libtool"
}
-# Build Berkeley DB and install it into a temporary area, isolating OpenLDAP
-# from any future changes to the system-wide Berkeley DB library.
-pushd db-%{db_version}/dist
-./configure --with-pic --disable-shared --with-uniquename=_openldap_rhl --prefix=${dbdir} --libdir=${dbdir}/%{_lib}
-make %{_smp_mflags}
-make install
-popd
-# Build one for tools which use gdbm.
-CPPFLAGS="$OPENSSL_CPPFLAGS" ; export CPPFLAGS
-LDFLAGS="$OPENSSL_LDFLAGS" ; export LDFLAGS
-pushd build-gdbm
-build --enable-ldbm --with-ldbm-api=gdbm --disable-shared --without-kerberos
-popd
-# Build one for tools which use db.
-CPPFLAGS="$OPENSSL_CPPFLAGS" ; export CPPFLAGS
-LDFLAGS="$OPENSSL_LDFLAGS" ; export LDFLAGS
-LIBS="-lpthread"; export LIBS
-CPPFLAGS="$CPPFLAGS -I${dbdir}/include"
-LDFLAGS="$LDFLAGS -L${dbdir}/%{_lib}"
-pushd build-berkeley
-build --enable-ldbm --with-ldbm-api=berkeley --disable-shared --without-kerberos
-popd
-# Build the servers with Kerberos support and whichever backend we want. Even
-# enable the bdb backend, which doesn't exist yet.
-CPPFLAGS="$OPENSSL_CPPFLAGS" ; export CPPFLAGS
-LDFLAGS="$OPENSSL_LDFLAGS" ; export LDFLAGS
-LIBS="-lpthread"; export LIBS
-pushd build-krb5
-CPPFLAGS="$CPPFLAGS -I${dbdir}/include -I%{_prefix}/kerberos/include -DHAVE_KERBEROS_V"
-LDFLAGS="$LDFLAGS -L${dbdir}/%{_lib} -L%{_prefix}/kerberos/%{_lib}"
-build --enable-ldbm --with-ldbm-api=%{ldbm_backend} --enable-bdb --disable-shared --with-kerberos=k5only --enable-kpasswd
+
+# Build the servers with Kerberos support (for password checking, mainly).
+CPPFLAGS="$OPENSSL_CPPFLAGS -I${dbdir}/include" ; export CPPFLAGS
+LDFLAGS="$OPENSSL_LDFLAGS -L${dbdir}/%{_lib}" ; export LDFLAGS
+pushd build-servers
+build \
+ --enable-ldbm \
+ --with-ldbm-api=%{ldbm_backend} \
+ --enable-bdb \
+ --enable-ldap \
+ --enable-meta \
+ --enable-monitor \
+ --enable-null \
+ --enable-rewrite \
+ --disable-shared \
+ --with-kerberos=k5only \
+ --with-cyrus-sasl \
+ --enable-kpasswd
popd
+
# Build clients without Kerberos password-checking support, which is only
-# useful in the server anyway.
+# useful in the server anyway, to avoid stray dependencies.
CPPFLAGS="$OPENSSL_CPPFLAGS" ; export CPPFLAGS
LDFLAGS="$OPENSSL_LDFLAGS" ; export LDFLAGS
unset LIBS
pushd build-clients
-build --disable-ldbm --enable-shared --without-kerberos
+build \
+ --disable-slapd \
+ --disable-slurpd \
+ --enable-shared \
+ --enable-static \
+ --without-kerberos \
+ --with-cyrus-sasl \
+ --with-pic
popd
%install
[ "$RPM_BUILD_ROOT" != "/" ] && rm -rf $RPM_BUILD_ROOT
-mkdir $RPM_BUILD_ROOT
-makeinstall() {
-# libtool loves relinking shared libraries
-# rm -f libraries/*/*.la
-make LIBTOOL=libtool
-%makeinstall \
- LIBTOOL=libtool \
- datadir=$RPM_BUILD_ROOT%{_datadir}/openldap \
- libexecdir=$RPM_BUILD_ROOT%{_sbindir} \
- localstatedir=/%{_var}/run \
- sysconfdir=$RPM_BUILD_ROOT%{_sysconfdir}/openldap $@
-}
-
-# Install compatibility binaries.
-pushd build-gdbm
-makeinstall -C servers/slapd/tools
-mv $RPM_BUILD_ROOT%{_sbindir}/slapadd $RPM_BUILD_ROOT%{_sbindir}/slapadd-gdbm
-mv $RPM_BUILD_ROOT%{_sbindir}/slapcat $RPM_BUILD_ROOT%{_sbindir}/slapcat-gdbm
-popd
-if [ %{ldbm_backend} != gdbm ] ; then
- pushd build-berkeley
- makeinstall -C servers/slapd/tools
- mv $RPM_BUILD_ROOT%{_sbindir}/slapadd $RPM_BUILD_ROOT%{_sbindir}/slapadd-berkeley
- mv $RPM_BUILD_ROOT%{_sbindir}/slapcat $RPM_BUILD_ROOT%{_sbindir}/slapcat-berkeley
+libtool='%{_bindir}/libtool'
+tagname=CC; export tagname
+# Install the 2.0 server tools for dumping out old on-disk databases.
+mkdir -p $RPM_BUILD_ROOT/%{_sbindir}/
+pushd openldap-%{version_20}
+ pushd build-gdbm/servers/slapd/tools
+ for bin in slapadd slapcat ; do
+ $libtool --mode=install install -m755 $bin $RPM_BUILD_ROOT/%{_sbindir}/$bin-slapd-2.0-gdbm
+ done
popd
-fi
-# Install clients and libraries.
+ pushd build-db/servers/slapd/tools
+ for bin in slapadd slapcat ; do
+ $libtool --mode=install install -m755 $bin $RPM_BUILD_ROOT/%{_sbindir}/$bin-slapd-2.0-dbb
+ done
+ popd
+popd
+
+# Install servers.
+%ifarch %{nptl_arches}
+pushd db-instroot/%{_lib}/tls/
+install -d $RPM_BUILD_ROOT/%{_libdir}/tls/
+install -m755 libslapd_db-*.*.so $RPM_BUILD_ROOT/%{_libdir}/tls/
+popd
+%endif
+
+pushd db-instroot/%{_lib}/
+install -d $RPM_BUILD_ROOT/%{_libdir}/
+install -m755 libslapd_db-*.*.so $RPM_BUILD_ROOT/%{_libdir}/
+popd
+
+pushd build-servers
+make install DESTDIR=$RPM_BUILD_ROOT libdir=%{_libdir} LIBTOOL="$libtool"
+popd
+
+# Install the bdb maintenance tools.
+pushd db-instroot/bin
+for binary in db_* ; do
+ install -m755 ${binary} $RPM_BUILD_ROOT/%{_sbindir}/slapd_${binary}
+done
+popd
+
+# Install clients and shared libraries.
pushd build-clients
-makeinstall
+make install DESTDIR=$RPM_BUILD_ROOT libdir=%{_libdir} LIBTOOL="$libtool"
popd
-# Install servers with Kerberos support.
-pushd build-krb5
-makeinstall -C servers
-popd
-
-# Set the right set of slap... tools for the server.
-ln -f $RPM_BUILD_ROOT%{_sbindir}/slapadd-%{ldbm_backend} $RPM_BUILD_ROOT%{_sbindir}/slapadd
-ln -f $RPM_BUILD_ROOT%{_sbindir}/slapcat-%{ldbm_backend} $RPM_BUILD_ROOT%{_sbindir}/slapcat
-
# Install the padl.com migration tools.
mkdir -p $RPM_BUILD_ROOT%{_datadir}/openldap/migration
-install -m 755 MigrationTools-%{migtools_ver}/migrate_* \
- $RPM_BUILD_ROOT%{_datadir}/openldap/migration
-install -m 644 MigrationTools-%{migtools_ver}/README %{SOURCE4} \
- $RPM_BUILD_ROOT%{_datadir}/openldap/migration
-cp MigrationTools-%{migtools_ver}/README README.migration
-cp %{SOURCE4} TOOLS.migration
-
-# try to build saucer, but don't fret if we can't
-if make -C contrib/saucer ; then
- ./libtool install -m755 contrib/saucer/saucer $RPM_BUILD_ROOT%{_bindir}/
- ./libtool install -m644 contrib/saucer/saucer.1 $RPM_BUILD_ROOT%{_mandir}/man1/
-fi
+install -m 755 MigrationTools-%{migtools_version}/migrate_* \
+ $RPM_BUILD_ROOT%{_datadir}/openldap/migration/
+install -m 644 MigrationTools-%{migtools_version}/README \
+ $RPM_SOURCE_DIR/migration-tools.txt \
+ $RPM_BUILD_ROOT%{_datadir}/openldap/migration/
+cp MigrationTools-%{migtools_version}/README README.migration
+cp $RPM_SOURCE_DIR/migration-tools.txt TOOLS.migration
# Create the data directory.
mkdir -p $RPM_BUILD_ROOT/var/lib/ldap
# Hack the build root out of the default config files.
-perl -pi -e "s|$RPM_BUILD_ROOT||g" $RPM_BUILD_ROOT/%{_sysconfdir}/openldap/slapd.conf
+perl -pi -e "s|$RPM_BUILD_ROOT||g" $RPM_BUILD_ROOT/%{_sysconfdir}/openldap/*.conf
# Get the buildroot out of the man pages.
perl -pi -e "s|$RPM_BUILD_ROOT||g" $RPM_BUILD_ROOT%{_mandir}/*/*.*
@@ -278,7 +401,7 @@ rm -f $RPM_BUILD_ROOT/%{_sysconfdir}/openldap/*.default
# Install an init script for the server.
mkdir -p $RPM_BUILD_ROOT/etc/rc.d/init.d
-install -m 755 %{SOURCE2} $RPM_BUILD_ROOT/etc/rc.d/init.d/ldap
+install -m 755 $RPM_SOURCE_DIR/ldap.init $RPM_BUILD_ROOT/etc/rc.d/init.d/ldap
# If ldapadd and ldapmodify are the same binary, make them a hard link
if cmp $RPM_BUILD_ROOT%{_bindir}/ldapadd $RPM_BUILD_ROOT%{_bindir}/ldapmodify ; then
@@ -287,13 +410,15 @@ fi
# Add some more schema for the sake of migration scripts.
install -d -m755 $RPM_BUILD_ROOT%{_sysconfdir}/openldap/schema/redhat
-install -m644 %{SOURCE5} %{SOURCE6} %{SOURCE7} $RPM_BUILD_ROOT%{_sysconfdir}/openldap/schema/redhat/
+install -m644 \
+ $RPM_SOURCE_DIR/autofs.schema \
+ $RPM_BUILD_ROOT%{_sysconfdir}/openldap/schema/redhat/
# Tweak permissions on the libraries to make sure they're correct.
chmod 755 $RPM_BUILD_ROOT/%{_libdir}/lib*.so*
chmod 644 $RPM_BUILD_ROOT/%{_libdir}/lib*.*a
-# Remove files we don't want packaged.
+# Remove files which we don't want packaged.
rm -f $RPM_BUILD_ROOT/%{_datadir}/openldap/migration/*.{instdir,simple,schema,mktemp,suffix}
rm -f $RPM_BUILD_ROOT/%{_libdir}/*.la
@@ -318,6 +443,7 @@ if /usr/sbin/useradd -c "LDAP User" -u 55 \
fi
%post servers
+/sbin/ldconfig
/sbin/chkconfig --add ldap
exec > /dev/null 2> /dev/null
if [ ! -f %{_datadir}/ssl/certs/slapd.pem ] ; then
@@ -355,24 +481,25 @@ fi
%doc ANNOUNCEMENT CHANGES COPYRIGHT LICENSE README doc/rfc
%attr(0755,root,root) %dir /etc/openldap
%attr(0644,root,root) %config(noreplace) /etc/openldap/ldap*.conf
-%attr(0755,root,root) %{_libdir}/lib*.so.*
+%attr(0755,root,root) %{_libdir}/libl*.so.*
%attr(0644,root,root) %{_mandir}/man5/*
%attr(0755,root,root) %dir %{_datadir}/openldap
-%attr(0644,root,root) %{_datadir}/openldap/ldapfriendly
+%attr(0755,root,root) %dir %{_datadir}/openldap/ucdata
+%attr(0644,root,root) %dir %{_datadir}/openldap/ucdata/*
%files servers
%defattr(-,root,root)
%doc README.migration TOOLS.migration
-%doc $RPM_SOURCE_DIR/README.upgrading $RPM_SOURCE_DIR/README.sendbuf $RPM_SOURCE_DIR/guide.html
+%doc $RPM_SOURCE_DIR/README.upgrading $RPM_SOURCE_DIR/guide.html
%attr(0755,root,root) %config /etc/rc.d/init.d/ldap
%attr(0640,root,ldap) %config(noreplace) /etc/openldap/slapd.conf
%attr(0755,root,root) %dir /etc/openldap/schema
+%attr(0644,root,root) %dir /etc/openldap/schema/README*
%attr(0644,root,root) %config(noreplace) /etc/openldap/schema/*.schema*
%attr(0755,root,root) %dir /etc/openldap/schema/redhat
%attr(0644,root,root) %config(noreplace) /etc/openldap/schema/redhat/*.schema*
%attr(0755,root,root) %{_sbindir}/*
%attr(0644,root,root) %{_mandir}/man8/*
-%attr(0644,root,root) %{_datadir}/openldap/*.help
%attr(0755,root,root) %dir %{_datadir}/openldap/migration
%attr(0644,root,root) %{_datadir}/openldap/migration/README
%attr(0644,root,root) %config(noreplace) %{_datadir}/openldap/migration/*.ph
@@ -380,6 +507,10 @@ fi
%attr(0755,root,root) %{_datadir}/openldap/migration/*.sh
%attr(0644,root,root) %{_datadir}/openldap/migration/*.txt
%attr(0700,ldap,ldap) %dir /var/lib/ldap
+%attr(0755,root,root) %{_libdir}/libslapd_db-*.*.so
+%ifarch %{nptl_arches}
+%attr(0755,root,root) %{_libdir}/tls/libslapd_db-*.*.so
+%endif
%files clients
%defattr(-,root,root)
@@ -389,16 +520,88 @@ fi
%files devel
%defattr(-,root,root)
%doc doc/drafts
-%attr(0755,root,root) %{_libdir}/lib*.so
-%attr(0644,root,root) %{_libdir}/lib*.a
+%attr(0755,root,root) %{_libdir}/libl*.so
+%attr(0644,root,root) %{_libdir}/libl*.a
%attr(0644,root,root) %{_includedir}/*
%attr(0644,root,root) %{_mandir}/man3/*
%changelog
+* Thu Oct 23 2003 Nalin Dahyabhai 2.1.22-8
+- add another section to the ABI note for the TLS libdb so that it's marked as
+ not needing an executable stack (from Arjan Van de Ven)
+
+* Thu Oct 16 2003 Nalin Dahyabhai 2.1.22-7
+- force bundled libdb to not use O_DIRECT by making it forget that we have it
+
+* Wed Oct 15 2003 Nalin Dahyabhai
+- build bundled libdb for slapd dynamically to make the package smaller,
+ among other things
+- on tls-capable arches, build libdb both with and without shared posix
+ mutexes, otherwise just without
+- disable posix mutexes unconditionally for db 4.0, which shouldn't need
+ them for the migration cases where it's used
+- update to MigrationTools 45
+
+* Fri Sep 12 2003 Nalin Dahyabhai 2.1.22-6
+- drop rfc822-MailMember.schema, merged into upstream misc.schema at some point
+
+* Wed Aug 27 2003 Nalin Dahyabhai
+- actually require newer libtool, as was intended back in 2.1.22-0, noted as
+ missed by Jim Richardson
+
+* Fri Jul 25 2003 Nalin Dahyabhai 2.1.22-5
+- enable rlookups, they don't cost anything unless also enabled in slapd's
+ configuration file
+
+* Tue Jul 22 2003 Nalin Dahyabhai 2.1.22-4
+- rebuild
+
+* Thu Jul 17 2003 Nalin Dahyabhai 2.1.22-3
+- rebuild
+
+* Wed Jul 16 2003 Nalin Dahyabhai 2.1.22-2
+- rebuild
+
+* Tue Jul 15 2003 Nalin Dahyabhai 2.1.22-1
+- build
+
+* Mon Jul 14 2003 Nalin Dahyabhai 2.1.22-0
+- 2.1.22 now badged stable
+- be more aggressive in what we index by default
+- use/require libtool 1.5
+
+* Mon Jun 30 2003 Nalin Dahyabhai
+- update to 2.1.22
+
+* Wed Jun 04 2003 Elliot Lee
+- rebuilt
+
+* Tue Jun 3 2003 Nalin Dahyabhai 2.1.21-1
+- update to 2.1.21
+- enable ldap, meta, monitor, null, rewrite in slapd
+
+* Mon May 19 2003 Nalin Dahyabhai 2.1.20-1
+- update to 2.1.20
+
+* Thu May 8 2003 Nalin Dahyabhai 2.1.19-1
+- update to 2.1.19
+
+* Mon May 5 2003 Nalin Dahyabhai 2.1.17-1
+- switch to db with crypto
+
+* Fri May 2 2003 Nalin Dahyabhai
+- install the db utils for the bundled libdb as %%{_sbindir}/slapd_db_*
+- install slapcat/slapadd from 2.0.x for migration purposes
+
+* Wed Apr 30 2003 Nalin Dahyabhai
+- update to 2.1.17
+- disable the shell backend, not expected to work well with threads
+- drop the kerberosSecurityObject schema, the krbName attribute it
+ contains is only used if slapd is built with v2 kbind support
+
* Mon Feb 10 2003 Nalin Dahyabhai 2.0.27-8
- back down to db 4.0.x, which 2.0.x can compile with in ldbm-over-db setups
- tweak SuSE patch to fix a few copy-paste errors and a NULL dereference
-- temporarily require an exact version of pkg-config (or pkgconfig, if you prefer)
* Wed Jan 22 2003 Tim Powers
- rebuilt
diff --git a/sources b/sources
index fbfc1d1..7a45cfa 100644
--- a/sources
+++ b/sources
@@ -1,3 +1,7 @@
-2cc51cbf0276c161724626c70b59f0b1 MigrationTools-44.tar.gz
+2355e54f17a1fdc87b0d56ed9ea3e115 MigrationTools-45.tar.gz
+5a9e617c1d5339d3c90c545c93e30949 autoconf-2.13.1.tar.gz
+0faee50993f7e4fe00f4b921b640b84d automake-1.4a.tar.gz
12262c64fcd64b772e7cffad8e4d0ebc db-4.0.14.tar.gz
+df71961002b552c0e72c6e4e358f27e1 db-4.1.25.tar.gz
a1e6508c471dd47205a3492cf57110a6 openldap-2.0.27.tgz
+391512053eded93e73ffa0d377ce272a openldap-2.1.22.tgz